feat!: expand wdk-sys coverage to include hid-related headers

.vscode/settings.json

@@ -19,5 +19,6 @@
     "./tests/umdf-driver-workspace/Cargo.toml",
     "./tests/wdk-macros-tests/Cargo.toml",
     "./tests/wdk-sys-tests/Cargo.toml",
-  ]
-}
+  ],
+  "rust-analyzer.cargo.features": "all"
+}

Cargo.toml

@@ -37,7 +37,7 @@ wdk-sys = { path = "crates/wdk-sys", version = "0.3.0" }
 
 # External Crates
 anyhow = "1.0.86"
-bindgen = "0.69.4"
+bindgen = "0.69.5"
 camino = "1.1.9"
 cargo_metadata = "0.18.1"
 cc = "1.1.0"

crates/wdk-build/Cargo.toml

@@ -35,6 +35,11 @@ windows = { workspace = true, features = [
 [dev-dependencies]
 windows = { workspace = true, features = ["Win32_UI_Shell"] }
 
+[features]
+default = []
+
+hid = []
+
 [lints.rust.unexpected_cfgs]
 level = "warn"
 check-cfg = ["cfg(wdk_build_unstable)", "cfg(skip_umdf_static_crt_check)"]

crates/wdk-build/src/bindgen.rs

@@ -20,10 +20,7 @@ pub trait BuilderExt {
     ///
     /// Implementation may return `wdk_build::ConfigError` if it fails to create
     /// a builder
-    fn wdk_default(
-        c_header_files: Vec<&str>,
-        config: impl Borrow<Config>,
-    ) -> Result<Builder, ConfigError>;
+    fn wdk_default(config: impl Borrow<Config>) -> Result<Builder, ConfigError>;
 }
 
 #[derive(Debug)]
@@ -39,19 +36,10 @@ impl BuilderExt for Builder {
     ///
     /// Will return `wdk_build::ConfigError` if any of the resolved include or
     /// library paths do not exist
-    fn wdk_default(
-        c_header_files: Vec<&str>,
-        config: impl Borrow<Config>,
-    ) -> Result<Self, ConfigError> {
+    fn wdk_default(config: impl Borrow<Config>) -> Result<Self, ConfigError> {
         let config = config.borrow();
 
-        let mut builder = Self::default();
-
-        for c_header in c_header_files {
-            builder = builder.header(c_header);
-        }
-
-        builder = builder
+        let builder = Self::default()
             .use_core() // Can't use std for kernel code
             .derive_default(true) // allows for default initializing structs
             // CStr types are safer and easier to work with when interacting with string constants

crates/wdk-build/src/lib.rs

@@ -313,6 +313,7 @@ impl Config {
         Ok(())
     }
 
+    // TODO: deprecate in favor of include_paths()
     /// Return header include paths required to build and link based off of the
     /// configuration of `Config`
     ///
@@ -411,6 +412,7 @@ impl Config {
         Ok(include_paths)
     }
 
+    // TODO: deprecate in favor of library_paths()
     /// Return library include paths required to build and link based off of
     /// the configuration of [`Config`].
     ///
@@ -498,6 +500,7 @@ impl Config {
         Ok(library_paths)
     }
 
+    // TODO: Deprecate in favor of preprocessor_definitions_iter
     /// Return an iterator of strings that represent compiler definitions
     /// derived from the `Config`
     pub fn get_preprocessor_definitions_iter(
@@ -541,10 +544,13 @@ impl Config {
         .chain(
             match self.driver_config {
                 DriverConfig::Wdm => {
-                    vec![]
+                    vec![
+                        ("_KERNEL_MODE", None), // Normally defined by msvc via /kernel flag
+                    ]
                 }
                 DriverConfig::Kmdf(kmdf_config) => {
                     let mut kmdf_definitions = vec![
+                        ("_KERNEL_MODE", None), // Normally defined by msvc via /kernel flag
                         ("KMDF_VERSION_MAJOR", Some(kmdf_config.kmdf_version_major)),
                         (
                             "KMDF_VERSION_MINOR",
@@ -623,6 +629,134 @@ impl Config {
         .map(std::string::ToString::to_string)
     }
 
+    pub fn base_headers(&self) -> impl Iterator<Item = String> {
+        match &self.driver_config {
+            DriverConfig::Wdm | DriverConfig::Kmdf(_) => {
+                vec!["ntifs.h", "ntddk.h"]
+            }
+            DriverConfig::Umdf(_) => {
+                vec!["windows.h"]
+            }
+        }
+        .into_iter()
+        .map(std::string::ToString::to_string)
+    }
+
+    pub fn wdf_headers(&self) -> impl Iterator<Item = String> {
+        ["wdf.h"].into_iter().map(std::string::ToString::to_string)
+    }
+
+    #[cfg(feature = "hid")]
+    pub fn hid_headers(&self) -> impl Iterator<Item = String> {
+        // HID Headers list from https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/_hid/
+        {
+            let mut hid_headers = vec!["hidclass.h", "hidsdi.h", "hidpi.h", "vhf.h"];
+            if let DriverConfig::Wdm | DriverConfig::Kmdf(_) = self.driver_config {
+                hid_headers.extend(["hidpddi.h", "hidport.h", "kbdmou.h", "ntdd8042.h"]);
+            }
+            if let DriverConfig::Kmdf(_) = self.driver_config {
+                hid_headers.extend(["HidSpiCx/1.0/hidspicx.h"]);
+            }
+            hid_headers
+        }
+        .into_iter()
+        .map(std::string::ToString::to_string)
+    }
+
+    pub fn bindgen_base_header_contents(&self) -> String {
+        let mut header_contents = self.base_headers().fold(String::new(), |mut acc, header| {
+            acc.push_str(r#"#include ""#);
+            acc.push_str(&header);
+            acc.push_str("\"\n");
+            acc
+        });
+
+        if let DriverConfig::Wdm | DriverConfig::Kmdf(_) = self.driver_config {
+            // TODO: Why is there no definition for this struct? Maybe blocklist this struct
+            // in bindgen.
+            header_contents.push_str(
+                r"
+typedef union _KGDTENTRY64
+{
+  struct
+  {
+    unsigned short LimitLow;
+    unsigned short BaseLow;
+    union
+    {
+      struct
+      {
+        unsigned char BaseMiddle;
+        unsigned char Flags1;
+        unsigned char Flags2;
+        unsigned char BaseHigh;
+      } Bytes;
+      struct
+      {
+        unsigned long BaseMiddle : 8;
+        unsigned long Type : 5;
+        unsigned long Dpl : 2;
+        unsigned long Present : 1;
+        unsigned long LimitHigh : 4;
+        unsigned long System : 1;
+        unsigned long LongMode : 1;
+        unsigned long DefaultBig : 1;
+        unsigned long Granularity : 1;
+        unsigned long BaseHigh : 8;
+      } Bits;
+    };
+    unsigned long BaseUpper;
+    unsigned long MustBeZero;
+  };
+  unsigned __int64 Alignment;
+} KGDTENTRY64, *PKGDTENTRY64;
+
+typedef union _KIDTENTRY64
+{
+  struct
+  {
+    unsigned short OffsetLow;
+    unsigned short Selector;
+    unsigned short IstIndex : 3;
+    unsigned short Reserved0 : 5;
+    unsigned short Type : 5;
+    unsigned short Dpl : 2;
+    unsigned short Present : 1;
+    unsigned short OffsetMiddle;
+    unsigned long OffsetHigh;
+    unsigned long Reserved1;
+  };
+  unsigned __int64 Alignment;
+} KIDTENTRY64, *PKIDTENTRY64;
+",
+            );
+        }
+
+        header_contents
+    }
+
+    pub fn bindgen_wdf_header_contents(&self) -> Option<String> {
+        if let DriverConfig::Kmdf(_) | DriverConfig::Umdf(_) = self.driver_config {
+            return Some(self.wdf_headers().fold(String::new(), |mut acc, header| {
+                acc.push_str(r#"#include ""#);
+                acc.push_str(&header);
+                acc.push_str("\"\n");
+                acc
+            }));
+        }
+        None
+    }
+
+    #[cfg(feature = "hid")]
+    pub fn bindgen_hid_header_contents(&self) -> String {
+        self.hid_headers().fold(String::new(), |mut acc, header| {
+            acc.push_str(r#"#include ""#);
+            acc.push_str(&header);
+            acc.push_str("\"\n");
+            acc
+        })
+    }
+
     /// Configure a Cargo build of a library that depends on the WDK. This
     /// emits specially formatted prints to Cargo based on this [`Config`].
     ///
@@ -839,8 +973,6 @@ impl CpuArchitecture {
     }
 
     /// Converts from a cargo-provided [`std::str`] to a [`CpuArchitecture`].
-    ///
-    /// #
     #[must_use]
     pub fn try_from_cargo_str<S: AsRef<str>>(cargo_str: S) -> Option<Self> {
         // Specifically not using the [`std::convert::TryFrom`] trait to be more

crates/wdk-sys/Cargo.toml

@@ -21,6 +21,7 @@ anyhow.workspace = true
 bindgen.workspace = true
 cargo_metadata.workspace = true
 cc.workspace = true
+cfg-if.workspace = true
 lazy_static.workspace = true
 serde_json.workspace = true
 thiserror.workspace = true
@@ -35,6 +36,9 @@ wdk-macros.workspace = true
 
 [features]
 default = []
+
+hid = ["wdk-build/hid"]
+
 nightly = ["wdk-macros/nightly"]
 test-stubs = []