feat: Add device class (#4)

* feat: Adds defined codes

* chore: baseClass on Linux as well

* chore: class -> baseClass

Author: Dilawar Singh

Cargo.toml

@@ -18,6 +18,7 @@ strict = []
 
 [dependencies]
 crossbeam = "0.8"
+num_enum = "0.7.2"
 [target.'cfg(target_os = "windows")'.dependencies]
 windows-sys = { version = "0.52.0", features = ["Win32_Devices_DeviceAndDriverInstallation", "Win32_Foundation"] }
 [target.'cfg(target_os = "linux")'.dependencies]

src/common.rs

@@ -1,3 +1,4 @@
+use num_enum::TryFromPrimitive;
 use std::error::Error;
 
 /// Discovered USB device
@@ -13,8 +14,53 @@ pub struct UsbDevice {
     pub description: Option<String>,
     /// Optional serial number
     pub serial_number: Option<String>,
-    /// Class of device.
-    pub class: Option<String>,
+    /// Class (bDeviceBaseClass) of device.
+    pub base_class: Option<DeviceBaseClass>,
+}
+
+/// See <https://www.usb.org/defined-class-codes>
+#[repr(u8)]
+#[derive(Hash, Eq, Debug, Clone, PartialEq, TryFromPrimitive)]
+pub enum DeviceBaseClass {
+    UseClassCodeFromInterfaceDescriptors = 0x00,
+    Audio = 0x01,
+    Communication = 0x02,
+    HumanInterfaceDevice = 0x03,
+    Physical = 0x05,
+    Image = 0x06,
+    Printer = 0x07,
+    MassStorage = 0x08,
+    Hub = 0x09,
+    CDCData = 0x0A,
+    SmartCard = 0x0B,
+    ContentSecurity = 0x0D,
+    Video = 0x0E,
+    PersonalHealthCare = 0x0F,
+    AudioVideo = 0x10,
+    Billboard = 0x11,
+    UsbTypeCBridge = 0x12,
+    UsbBulkDisplay = 0x13,
+    MctpOverUsb = 0x14,
+    I3C = 0x3C,
+    Diagnostic = 0xDC,
+    WirelessController = 0xE0,
+    Miscellaneous = 0xEF,
+    ApplicationSpecific = 0xFE,
+    VendorSpecific = 0xFF,
+}
+
+impl From<String> for DeviceBaseClass {
+    fn from(v: String) -> Self {
+        match v.to_lowercase().as_ref() {
+            "usb" => Self::MassStorage,
+            "bluetooth" => Self::Communication,
+            "hidclass" => Self::HumanInterfaceDevice,
+            "camera" => Self::Video,
+            "biometric" => Self::ContentSecurity,
+            "net" => Self::WirelessController,
+            _ => Self::UseClassCodeFromInterfaceDescriptors,
+        }
+    }
 }
 
 #[derive(Copy, Clone, Debug)]

src/linux.rs

@@ -1,4 +1,5 @@
 use crate::common::*;
+use std::convert::TryFrom;
 
 use std::error::Error;
 use udev::Enumerator;
@@ -62,12 +63,17 @@ pub fn enumerate_platform(vid: Option<u16>, pid: Option<u16>) -> Vec<UsbDevice>
                 .and_then(|s| s.to_str())
                 .map(|s| s.to_string());
 
+            let bclass = device
+                .attribute_value("bDeviceClass")
+                .and_then(|x| x.to_str()?.parse::<u8>().ok());
+
             output.push(UsbDevice {
                 id,
                 vendor_id,
                 product_id,
                 description,
                 serial_number,
+                base_class: bclass.and_then(|bc| DeviceBaseClass::try_from(bc).ok()),
             });
 
             Ok(())

src/macos.rs

@@ -3,6 +3,7 @@ use core_foundation::{base::*, dictionary::*, number::*, string::*};
 use io_kit_sys::{types::*, usb::lib::*, *};
 use mach::kern_return::*;
 use std::{error::Error, mem::MaybeUninit};
+use std::convert::TryFrom;
 
 pub fn enumerate_platform(vid: Option<u16>, pid: Option<u16>) -> Vec<UsbDevice> {
     let mut output = Vec::new();
@@ -89,12 +90,21 @@ pub fn enumerate_platform(vid: Option<u16>, pid: Option<u16>) -> Vec<UsbDevice>
                     .and_then(|value_ref| value_ref.downcast::<CFString>())
                     .map(|s| s.to_string());
 
+                let key = CFString::from_static_string("bDeviceClass");
+                let base_class = properties
+                    .find(&key)
+                    .and_then(|value_ref| value_ref.downcast::<CFNumber>())
+                    .ok_or(ParseError)?
+                    .to_i32()
+                    .ok_or(ParseError)? as u8;
+
                 output.push(UsbDevice {
                     id: id.to_string(),
                     vendor_id,
                     product_id,
                     description,
                     serial_number,
+                    base_class: DeviceBaseClass::try_from(base_class).ok(),
                 });
 
                 Ok(())

src/windows.rs

@@ -113,7 +113,7 @@ pub fn enumerate_platform(vid: Option<u16>, pid: Option<u16>) -> Vec<UsbDevice>
                             product_id,
                             description: Some(description),
                             serial_number,
-                            class,
+                            base_class: class.map(|cls| cls.into()),
                         });
                     }
                 }