hidapi 2.6.5

Rust-y wrapper around hidapi
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

use crate::windows_native::dev_node::DevNode;
use crate::windows_native::error::WinResult;
use crate::windows_native::hid::{get_hid_attributes, PreparsedData};
use crate::windows_native::interfaces::Interface;
use crate::windows_native::string::{U16Str, U16String, U16StringList};
use crate::windows_native::types::{Handle, InternalBusType};
use crate::{BusType, DeviceInfo, WcharString};
use std::ffi::{c_void, CString};
use std::mem::{size_of, zeroed};
use windows_sys::core::GUID;
use windows_sys::Win32::Devices::HumanInterfaceDevice::{
    HidD_GetManufacturerString, HidD_GetProductString, HidD_GetSerialNumberString,
};
use windows_sys::Win32::Devices::Properties::{
    DEVPKEY_Device_CompatibleIds, DEVPKEY_Device_HardwareIds, DEVPKEY_Device_InstanceId,
    DEVPKEY_Device_Manufacturer, DEVPKEY_NAME,
};
use windows_sys::Win32::Foundation::{HANDLE, PROPERTYKEY};

// These constants are only part of the heavyweight `windows` and not `windows-sys`,
// so we manually define them here.
#[allow(nonstandard_style)]
const PKEY_DeviceInterface_Bluetooth_DeviceAddress: PROPERTYKEY = PROPERTYKEY {
    fmtid: GUID::from_u128(0x2bd67d8b_8beb_48d5_87e0_6cda3428040a),
    pid: 1,
};
#[allow(nonstandard_style)]
const PKEY_DeviceInterface_Bluetooth_Manufacturer: PROPERTYKEY = PROPERTYKEY {
    fmtid: GUID::from_u128(0x2bd67d8b_8beb_48d5_87e0_6cda3428040a),
    pid: 4,
};
#[allow(nonstandard_style)]
const PKEY_DeviceInterface_Bluetooth_ModelNumber: PROPERTYKEY = PROPERTYKEY {
    fmtid: GUID::from_u128(0x2bd67d8b_8beb_48d5_87e0_6cda3428040a),
    pid: 5,
};

fn read_string(
    func: unsafe extern "system" fn(HANDLE, *mut c_void, u32) -> bool,
    handle: &Handle,
) -> WcharString {
    // Return empty string on failure to match the c implementation
    let mut string = [0u16; 256];
    if unsafe {
        func(
            handle.as_raw(),
            string.as_mut_ptr() as _,
            (size_of::<u16>() * string.len()) as u32,
        )
    } {
        U16Str::from_slice_list(&string)
            .map(WcharString::from)
            .next()
            .unwrap_or_else(|| WcharString::String(String::new()))
    } else {
        // WcharString::None
        WcharString::String(String::new())
    }
}

pub fn get_device_info(path: &U16Str, handle: &Handle) -> DeviceInfo {
    let attrib = get_hid_attributes(handle);
    let caps = PreparsedData::load(handle)
        .and_then(|data| data.get_caps())
        .unwrap_or(unsafe { zeroed() });
    let mut dev = DeviceInfo {
        path: CString::new(path.to_string()).unwrap(),
        vendor_id: attrib.VendorID,
        product_id: attrib.ProductID,
        serial_number: read_string(HidD_GetSerialNumberString, handle),
        release_number: attrib.VersionNumber,
        manufacturer_string: read_string(HidD_GetManufacturerString, handle),
        product_string: read_string(HidD_GetProductString, handle),
        usage_page: caps.UsagePage,
        usage: caps.Usage,
        interface_number: -1,
        bus_type: BusType::Unknown,
    };

    // If this fails just ignore it. The data might be incomplete but at least there is something
    let _ = get_internal_info(path, &mut dev);
    dev
}

fn get_internal_info(interface_path: &U16Str, dev: &mut DeviceInfo) -> WinResult<()> {
    let device_id: U16String = Interface::get_property(interface_path, DEVPKEY_Device_InstanceId)?;

    let dev_node = DevNode::from_device_id(&device_id)?.parent()?;

    let compatible_ids: U16StringList = dev_node.get_property(DEVPKEY_Device_CompatibleIds)?;

    let bus_type = compatible_ids
        .iter()
        .filter_map(|compatible_id| match compatible_id {
            // The hidapi c library uses `contains` instead of `starts_with`,
            // but as far as I can tell `starts_with` is a better choice
            // USB devices
            // https://docs.microsoft.com/windows-hardware/drivers/hid/plug-and-play-support
            // https://docs.microsoft.com/windows-hardware/drivers/install/standard-usb-identifiers
            id if id.starts_with_ignore_case("USB") => Some(InternalBusType::Usb),
            // Bluetooth devices
            // https://docs.microsoft.com/windows-hardware/drivers/bluetooth/installing-a-bluetooth-device
            id if id.starts_with_ignore_case("BTHENUM") => Some(InternalBusType::Bluetooth),
            id if id.starts_with_ignore_case("BTHLEDEVICE") => Some(InternalBusType::BluetoothLE),
            // I2C devices
            // https://docs.microsoft.com/windows-hardware/drivers/hid/plug-and-play-support-and-power-management
            id if id.starts_with_ignore_case("PNP0C50") => Some(InternalBusType::I2c),
            // SPI devices
            // https://docs.microsoft.com/windows-hardware/drivers/hid/plug-and-play-for-spi
            id if id.starts_with_ignore_case("PNP0C51") => Some(InternalBusType::Spi),
            _ => None,
        })
        .next()
        .unwrap_or(InternalBusType::Unknown);
    dev.bus_type = bus_type.into();
    match bus_type {
        InternalBusType::Usb => get_usb_info(dev, dev_node)?,
        InternalBusType::BluetoothLE => get_ble_info(dev, dev_node)?,
        _ => (),
    };

    Ok(())
}

fn get_usb_info(dev: &mut DeviceInfo, mut dev_node: DevNode) -> WinResult<()> {
    let mut device_id: U16String = dev_node.get_property(DEVPKEY_Device_InstanceId)?;

    device_id.make_uppercase_ascii();
    // Check for Xbox Common Controller class (XUSB) device.
    // https://docs.microsoft.com/windows/win32/xinput/directinput-and-xusb-devices
    // https://docs.microsoft.com/windows/win32/xinput/xinput-and-directinput
    //
    if extract_int_token_value(&device_id, "IG_").is_some() {
        dev_node = dev_node.parent()?;
    }

    let mut hardware_ids: U16StringList = dev_node.get_property(DEVPKEY_Device_HardwareIds)?;

    // Get additional information from USB device's Hardware ID
    // https://docs.microsoft.com/windows-hardware/drivers/install/standard-usb-identifiers
    // https://docs.microsoft.com/windows-hardware/drivers/usbcon/enumeration-of-interfaces-not-grouped-in-collections
    //
    for hardware_id in hardware_ids.iter_mut() {
        hardware_id.make_uppercase_ascii();

        if dev.release_number == 0 {
            if let Some(release_number) = extract_int_token_value(hardware_id, "REV_") {
                dev.release_number = release_number as u16;
            }
        }
        if dev.interface_number == -1 {
            if let Some(interface_number) = extract_int_token_value(hardware_id, "MI_") {
                dev.interface_number = interface_number as i32;
            }
        }
    }

    // Try to get USB device manufacturer string if not provided by HidD_GetManufacturerString.
    if dev.manufacturer_string().map_or(true, str::is_empty) {
        if let Ok(manufacturer_string) =
            dev_node.get_property::<U16String>(DEVPKEY_Device_Manufacturer)
        {
            dev.manufacturer_string = (&*manufacturer_string).into();
        }
    }

    // Try to get USB device serial number if not provided by HidD_GetSerialNumberString.
    if dev.serial_number().map_or(true, str::is_empty) {
        let mut usb_dev_node = dev_node;
        if dev.interface_number != -1 {
            // Get devnode parent to reach out composite parent USB device.
            // https://docs.microsoft.com/windows-hardware/drivers/usbcon/enumeration-of-the-composite-parent-device
            usb_dev_node = dev_node.parent()?;
        }

        let device_id: U16String = usb_dev_node.get_property(DEVPKEY_Device_InstanceId)?;

        // Extract substring after last '\\' of Instance ID.
        // For USB devices it may contain device's serial number.
        // https://docs.microsoft.com/windows-hardware/drivers/install/instance-ids
        //
        if let Some(start) = device_id
            .as_slice()
            .rsplit(|c| *c != b'&' as u16)
            .next()
            .and_then(|s| s.iter().rposition(|c| *c != b'\\' as u16))
        {
            dev.serial_number = U16Str::from_slice(&device_id.as_slice()[(start + 1)..]).into();
        }
    }

    if dev.interface_number == -1 {
        dev.interface_number = 0;
    }

    Ok(())
}

// HidD_GetProductString/HidD_GetManufacturerString/HidD_GetSerialNumberString is not working for BLE HID devices
// Request this info via dev node properties instead.
// https://docs.microsoft.com/answers/questions/401236/hidd-getproductstring-with-ble-hid-device.html
fn get_ble_info(dev: &mut DeviceInfo, dev_node: DevNode) -> WinResult<()> {
    if dev.manufacturer_string().map_or(true, str::is_empty) {
        if let Ok(manufacturer_string) =
            dev_node.get_property::<U16String>(PKEY_DeviceInterface_Bluetooth_Manufacturer)
        {
            dev.manufacturer_string = manufacturer_string.into();
        }
    }

    if dev.serial_number().map_or(true, str::is_empty) {
        if let Ok(serial_number) =
            dev_node.get_property::<U16String>(PKEY_DeviceInterface_Bluetooth_DeviceAddress)
        {
            dev.serial_number = serial_number.into();
        }
    }

    if dev.product_string().map_or(true, str::is_empty) {
        let product_string = dev_node
            .get_property::<U16String>(PKEY_DeviceInterface_Bluetooth_ModelNumber)
            .or_else(|_| {
                // Fallback: Get devnode grandparent to reach out Bluetooth LE device node
                dev_node
                    .parent()
                    .and_then(|parent_dev_node| parent_dev_node.get_property(DEVPKEY_NAME))
            });
        if let Ok(product_string) = product_string {
            dev.product_string = product_string.into();
        }
    }

    Ok(())
}

fn extract_int_token_value(u16str: &U16Str, token: &str) -> Option<u32> {
    let start = u16str.find_index(token)? + token.encode_utf16().count();
    char::decode_utf16(u16str.as_slice()[start..].iter().copied())
        .map_while(|c| c.ok().and_then(|c| c.to_digit(16)))
        .reduce(|l, r| l * 16 + r)
}