usb-if 0.8.0

USB Interface definitions for CrabUSB
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

use num_enum::{FromPrimitive, IntoPrimitive};

#[repr(u8)]
/// The direction of the data transfer.
#[derive(Copy, Clone, Debug, Ord, PartialOrd, Eq, PartialEq, Hash)]
pub enum Direction {
    /// Out (Write Data)
    Out = 0,
    /// In (Read Data)
    In  = 1,
}

impl Direction {
    pub fn from_address(addr: u8) -> Direction {
        match addr & Self::MASK {
            0 => Self::Out,
            _ => Self::In,
        }
    }
    const MASK: u8 = 0x80;

    pub fn from_raw(raw: u8) -> Direction {
        match raw {
            0 => Self::Out,
            _ => Self::In,
        }
    }
}

#[repr(C)]
#[derive(Debug, Clone)]
pub struct BmRequestType {
    pub direction: Direction,
    pub request_type: RequestType,
    pub recipient: Recipient,
}

impl BmRequestType {
    pub const fn new(
        direction: Direction,
        transfer_type: RequestType,
        recipient: Recipient,
    ) -> BmRequestType {
        BmRequestType {
            direction,
            request_type: transfer_type,
            recipient,
        }
    }
}

impl From<BmRequestType> for u8 {
    fn from(value: BmRequestType) -> Self {
        ((value.direction as u8) << 7) | ((value.request_type as u8) << 5) | value.recipient as u8
    }
}

#[derive(Copy, Clone, Debug)]
#[repr(u8)]
pub enum RequestType {
    Standard = 0,
    Class    = 1,
    Vendor   = 2,
    Reserved = 3,
}

#[derive(Copy, Clone, Debug)]
#[repr(u8)]
pub enum Recipient {
    Device    = 0,
    Interface = 1,
    Endpoint  = 2,
    Other     = 3,
}

#[derive(Debug, Clone, FromPrimitive, IntoPrimitive, Copy)]
#[repr(u8)]
pub enum Request {
    GetStatus         = 0,
    ClearFeature      = 1,
    SetFeature        = 3,
    SetAddress        = 5,
    GetDescriptor     = 6,
    SetDescriptor     = 7,
    GetConfiguration  = 8,
    SetConfiguration  = 9,
    GetInterface      = 10,
    SetInterface      = 11,
    SynchFrame        = 12,
    SetEncryption     = 13,
    GetEncryption     = 14,
    SetHandshake      = 15,
    GetHandshake      = 16,
    SetConnection     = 17,
    SetSecurityData   = 18,
    GetSecurityData   = 19,
    SetWusbData       = 20,
    LoopbackDataWrite = 21,
    LoopbackDataRead  = 22,
    SetInterfaceDs    = 23,
    GetFwStatus       = 26,
    SetFwStatus       = 27,
    SetSel            = 48,
    SetIsochDelay     = 49,
    #[num_enum(catch_all)]
    Other(u8),
}