Skip to main content

hid_types/id/usage/
soc.rs

1//! Well-known Usage ID values from the SOC Usage Page.
2
3use num_enum::{IntoPrimitive, TryFromPrimitive};
4
5use crate::Ident;
6
7/// Well-known Usage ID values from the SOC Usage Page.
8///
9/// See [HID Usage Tables for Universal Serial Bus](https://www.usb.org/document-library/hid-usage-tables-17),
10/// section 20.
11#[expect(missing_docs)]
12#[derive(Clone, Copy, Debug, Eq, PartialEq, TryFromPrimitive, IntoPrimitive)]
13#[repr(u16)]
14pub enum KnownUsage {
15    Undefined = 0,
16    SocControl = 0x01,
17    FirmwareTransfer = 0x02,
18    FirmwareFileId = 0x03,
19    FileOffsetInBytes = 0x04,
20    FileTransferSizeMaxInBytes = 0x05,
21    FilePayload = 0x06,
22    FilePayloadSizeInBytes = 0x07,
23    FilePayloadContainsLastBytes = 0x08,
24    FileTransferStop = 0x09,
25    FileTransferTillEnd = 0x0A,
26    // 0x0B-0xFFFF reserved
27}
28
29/// A __Usage ID__ value.
30pub type Usage = Ident<KnownUsage, u16>;