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 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
#[cfg(target_os = "windows")]
use std::ffi::{OsStr, OsString};
#[cfg(target_os = "linux")]
use crate::platform::SysfsPath;
use crate::{Device, Error};
/// Information about a device that can be obtained without opening it.
///
/// Found in the results of [`crate::list_devices`].
///
/// ### Platform-specific notes
///
/// * Some fields are platform-specific
/// * Linux: `sysfs_path`
/// * Windows: `instance_id`, `parent_instance_id`, `port_number`, `driver`
/// * macOS: `registry_id`, `location_id`
#[derive(Clone)]
pub struct DeviceInfo {
#[cfg(target_os = "linux")]
pub(crate) path: SysfsPath,
#[cfg(target_os = "windows")]
pub(crate) instance_id: OsString,
#[cfg(target_os = "windows")]
pub(crate) parent_instance_id: OsString,
#[cfg(target_os = "windows")]
pub(crate) port_number: u32,
#[cfg(target_os = "windows")]
pub(crate) devinst: crate::platform::DevInst,
#[cfg(target_os = "windows")]
pub(crate) driver: Option<String>,
#[cfg(target_os = "macos")]
pub(crate) registry_id: u64,
#[cfg(target_os = "macos")]
pub(crate) location_id: u32,
pub(crate) bus_number: u8,
pub(crate) device_address: u8,
pub(crate) vendor_id: u16,
pub(crate) product_id: u16,
pub(crate) device_version: u16,
pub(crate) class: u8,
pub(crate) subclass: u8,
pub(crate) protocol: u8,
pub(crate) speed: Option<Speed>,
pub(crate) manufacturer_string: Option<String>,
pub(crate) product_string: Option<String>,
pub(crate) serial_number: Option<String>,
pub(crate) interfaces: Vec<InterfaceInfo>,
}
impl DeviceInfo {
/// *(Linux-only)* Sysfs path for the device.
#[doc(hidden)]
#[deprecated = "use `sysfs_path()` instead"]
#[cfg(target_os = "linux")]
pub fn path(&self) -> &SysfsPath {
&self.path
}
/// *(Linux-only)* Sysfs path for the device.
#[cfg(target_os = "linux")]
pub fn sysfs_path(&self) -> &std::path::Path {
&self.path.0
}
/// *(Windows-only)* Instance ID path of this device
#[cfg(target_os = "windows")]
pub fn instance_id(&self) -> &OsStr {
&self.instance_id
}
/// *(Windows-only)* Instance ID path of the parent hub
#[cfg(target_os = "windows")]
pub fn parent_instance_id(&self) -> &OsStr {
&self.parent_instance_id
}
/// *(Windows-only)* Port number
#[cfg(target_os = "windows")]
pub fn port_number(&self) -> u32 {
self.port_number
}
/// *(Windows-only)* Driver associated with the device as a whole
#[cfg(target_os = "windows")]
pub fn driver(&self) -> Option<&str> {
self.driver.as_deref()
}
/// *(macOS-only)* IOKit Location ID
#[cfg(target_os = "macos")]
pub fn location_id(&self) -> u32 {
self.location_id
}
/// *(macOS-only)* IOKit [Registry Entry ID](https://developer.apple.com/documentation/iokit/1514719-ioregistryentrygetregistryentryi?language=objc)
#[cfg(target_os = "macos")]
pub fn registry_entry_id(&self) -> u64 {
self.registry_id
}
/// Number identifying the bus / host controller where the device is connected.
pub fn bus_number(&self) -> u8 {
self.bus_number
}
/// Number identifying the device within the bus.
pub fn device_address(&self) -> u8 {
self.device_address
}
/// The 16-bit number identifying the device's vendor, from the `idVendor` device descriptor field.
#[doc(alias = "idVendor")]
pub fn vendor_id(&self) -> u16 {
self.vendor_id
}
/// The 16-bit number identifying the product, from the `idProduct` device descriptor field.
#[doc(alias = "idProduct")]
pub fn product_id(&self) -> u16 {
self.product_id
}
/// The device version, normally encoded as BCD, from the `bcdDevice` device descriptor field.
#[doc(alias = "bcdDevice")]
pub fn device_version(&self) -> u16 {
self.device_version
}
/// Code identifying the standard device class, from the `bDeviceClass` device descriptor field.
///
/// `0x00`: specified at the interface level.\
/// `0xFF`: vendor-defined.
#[doc(alias = "bDeviceClass")]
pub fn class(&self) -> u8 {
self.class
}
/// Standard subclass, from the `bDeviceSubClass` device descriptor field.
#[doc(alias = "bDeviceSubClass")]
pub fn subclass(&self) -> u8 {
self.subclass
}
/// Standard protocol, from the `bDeviceProtocol` device descriptor field.
#[doc(alias = "bDeviceProtocol")]
pub fn protocol(&self) -> u8 {
self.protocol
}
/// Connection speed
pub fn speed(&self) -> Option<Speed> {
self.speed
}
/// Manufacturer string, if available without device IO.
///
/// ### Platform-specific notes
/// * Windows: Windows does not cache the manufacturer string, and
/// this will return `None` regardless of whether a descriptor exists.
#[doc(alias = "iManufacturer")]
pub fn manufacturer_string(&self) -> Option<&str> {
self.manufacturer_string.as_deref()
}
/// Product string, if available without device IO.
#[doc(alias = "iProduct")]
pub fn product_string(&self) -> Option<&str> {
self.product_string.as_deref()
}
/// Serial number string, if available without device IO.
///
/// ### Platform-specific notes
/// * On Windows, this comes from a case-insensitive instance ID and may
/// have been converted to upper case from the descriptor string. It is
/// recommended to use a [case-insensitive
/// comparison][str::eq_ignore_ascii_case] when matching a device.
#[doc(alias = "iSerial")]
pub fn serial_number(&self) -> Option<&str> {
self.serial_number.as_deref()
}
/// Iterator over the device's interfaces.
///
/// This returns summary information about the interfaces in the device's
/// active configuration for the purposes of matching devices prior to
/// opening them.
///
/// Additional information about interfaces can be found in the
/// configuration descriptor after opening the device by calling
/// [`Device::active_configuration`].
///
/// ### Platform-specific notes:
/// * Windows: this is only available for composite devices bound to the
/// `usbccgp` driver, and will be empty if the entire device is bound to
/// a specific driver.
/// * Windows: When interfaces are grouped by an interface
/// association descriptor, this returns details from the interface
/// association descriptor and does not include each of the associated
/// interfaces.
pub fn interfaces(&self) -> impl Iterator<Item = &InterfaceInfo> {
self.interfaces.iter()
}
/// Open the device
pub fn open(&self) -> Result<Device, Error> {
Device::open(self)
}
}
// Not derived so that we can format some fields in hex
impl std::fmt::Debug for DeviceInfo {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut s = f.debug_struct("DeviceInfo");
s.field("bus_number", &self.bus_number)
.field("device_address", &self.device_address)
.field("vendor_id", &format_args!("0x{:04X}", self.vendor_id))
.field("product_id", &format_args!("0x{:04X}", self.product_id))
.field(
"device_version",
&format_args!("0x{:04X}", self.device_version),
)
.field("class", &format_args!("0x{:02X}", self.class))
.field("subclass", &format_args!("0x{:02X}", self.subclass))
.field("protocol", &format_args!("0x{:02X}", self.protocol))
.field("speed", &self.speed)
.field("manufacturer_string", &self.manufacturer_string)
.field("product_string", &self.product_string)
.field("serial_number", &self.serial_number);
#[cfg(target_os = "linux")]
{
s.field("sysfs_path", &self.path);
}
#[cfg(target_os = "windows")]
{
s.field("instance_id", &self.instance_id);
s.field("parent_instance_id", &self.parent_instance_id);
s.field("port_number", &self.port_number);
s.field("driver", &self.driver);
}
#[cfg(target_os = "macos")]
{
s.field("location_id", &self.location_id);
s.field("registry_entry_id", &self.registry_id);
}
s.field("interfaces", &self.interfaces);
s.finish()
}
}
/// USB connection speed
#[derive(Copy, Clone, Eq, PartialOrd, Ord, PartialEq, Hash, Debug)]
#[non_exhaustive]
pub enum Speed {
/// Low speed (1.5 Mbit)
Low,
/// Full speed (12 Mbit)
Full,
/// High speed (480 Mbit)
High,
/// Super speed (5000 Mbit)
Super,
/// Super speed (10000 Mbit)
SuperPlus,
}
impl Speed {
#[allow(dead_code)] // not used on all platforms
pub(crate) fn from_str(s: &str) -> Option<Self> {
match s {
"low" | "1.5" => Some(Speed::Low),
"full" | "12" => Some(Speed::Full),
"high" | "480" => Some(Speed::High),
"super" | "5000" => Some(Speed::Super),
"super+" | "10000" => Some(Speed::SuperPlus),
_ => None,
}
}
}
/// Summary information about a device's interface, available before opening a device.
#[derive(Clone)]
pub struct InterfaceInfo {
pub(crate) interface_number: u8,
pub(crate) class: u8,
pub(crate) subclass: u8,
pub(crate) protocol: u8,
pub(crate) interface_string: Option<String>,
}
impl InterfaceInfo {
/// Identifier for the interface from the `bInterfaceNumber` descriptor field.
pub fn interface_number(&self) -> u8 {
self.interface_number
}
/// Code identifying the standard interface class, from the `bInterfaceClass` interface descriptor field.
pub fn class(&self) -> u8 {
self.class
}
/// Standard subclass, from the `bInterfaceSubClass` interface descriptor field.
pub fn subclass(&self) -> u8 {
self.subclass
}
/// Standard protocol, from the `bInterfaceProtocol` interface descriptor field.
pub fn protocol(&self) -> u8 {
self.protocol
}
/// Interface string descriptor value as cached by the OS.
pub fn interface_string(&self) -> Option<&str> {
self.interface_string.as_deref()
}
}
// Not derived so that we can format some fields in hex
impl std::fmt::Debug for InterfaceInfo {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("InterfaceInfo")
.field("interface_number", &self.interface_number)
.field("class", &format_args!("0x{:02X}", self.class))
.field("subclass", &format_args!("0x{:02X}", self.subclass))
.field("protocol", &format_args!("0x{:02X}", self.protocol))
.field("interface_string", &self.interface_string)
.finish()
}
}