aboutsummaryrefslogtreecommitdiffstats
path: root/usbh/src/usbproto.rs
blob: 97d1839c2453c62047a33f2a887e0650a996772b (plain)
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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
/// USB Protocol level types and functions.
///
/// Everything in here is defined by the USB specification, and
/// hardware independent.

// TODO: Put protocol section references in for types and
// documentation.

#[derive(Copy, Clone, Debug, Default, PartialEq)]
#[repr(C, packed)]
pub struct USBDeviceDescriptor {
    pub b_length: u8,
    pub b_descriptor_type: USBDescriptor,
    pub bcd_usb: u16,
    pub b_device_class: u8,
    pub b_device_sub_class: u8,
    pub b_device_protocol: u8,
    pub b_max_packet_size: u8,
    pub id_vendor: u16,
    pub id_product: u16,
    pub bcd_device: u16,
    pub i_manufacturer: u8,
    pub i_product: u8,
    pub i_serial_number: u8,
    pub b_num_configurations: u8,
}

#[derive(Copy, Clone, Debug, Default, PartialEq)]
#[repr(C, packed)]
pub struct USBConfigurationDescriptor {
    pub b_length: u8,
    pub b_descriptor_type: USBDescriptor,
    pub w_total_length: u16,
    pub b_num_interfaces: u8,
    pub b_configuration_value: u8,
    pub i_configuration: u8,
    pub bm_attributes: u8,
    pub b_max_power: u8,
}

#[derive(Copy, Clone, Debug, Default, PartialEq)]
#[repr(C, packed)]
pub struct USBInterfaceDescriptor {
    pub b_length: u8,
    pub b_descriptor_type: USBDescriptor,
    pub b_interface_number: u8,
    pub b_alternate_setting: u8,
    pub b_num_endpoints: u8,
    pub b_interface_class: u8,
    pub b_interface_sub_class: u8,
    pub b_interface_protocol: u8,
    pub i_interface: u8,
}

#[derive(Copy, Clone, Debug, Default, PartialEq)]
#[repr(C, packed)]
pub struct USBEndpointDescriptor {
    pub b_length: u8,
    pub b_descriptor_type: USBDescriptor,
    pub b_endpoint_address: u8,
    pub bm_attributes: u8,
    pub w_max_packet_size: u16,
    pub b_interval: u8,
}

#[derive(Copy, Clone, Debug, Default, PartialEq)]
#[repr(C, packed)]
pub struct USBSetupPacket {
    pub bm_request_type: BMRequestType,
    pub b_request: USBRequest,
    pub w_value: WValue,
    pub w_index: u16,
    pub w_length: u16,
}
// TODO: shortcuts for standard device requests §9.4 of USB standard.

#[derive(Copy, Clone, Debug, PartialEq)]
pub enum USBSetupDirection {
    HostToDevice = 0x00,
    DeviceToHost = 0x80,
}
impl<T> From<T> for USBSetupDirection
where
    T: Into<u8>,
{
    fn from(v: T) -> Self {
        match v.into() {
            0x00 => Self::HostToDevice,
            0x80 => Self::DeviceToHost,
            _ => panic!("direction can only be 0x00 or 0x80"),
        }
    }
}

#[derive(Copy, Clone, Debug, PartialEq)]
pub enum USBSetupType {
    Standard = 0x00,
    Class = 0x20,
    Vendor = 0x40,
}
impl<T> From<T> for USBSetupType
where
    T: Into<u8>,
{
    fn from(v: T) -> Self {
        match v.into() {
            0x00 => Self::Standard,
            0x20 => Self::Class,
            0x40 => Self::Vendor,
            _ => panic!("type can only be 0x00, 0x20, or 0x40"),
        }
    }
}

#[derive(Copy, Clone, Debug, PartialEq)]
pub enum USBSetupRecipient {
    Device = 0x00,
    Interface = 0x01,
    Endpoint = 0x02,
    Other = 0x03,
}
impl<T> From<T> for USBSetupRecipient
where
    T: Into<u8>,
{
    fn from(v: T) -> Self {
        match v.into() {
            0x00 => Self::Device,
            0x01 => Self::Interface,
            0x02 => Self::Endpoint,
            0x03 => Self::Other,
            _ => panic!("recipient can only be between 0 and 3"),
        }
    }
}

#[derive(Clone, Copy, Debug, Default, PartialEq)]
#[repr(C)]
pub struct BMRequestType(u8);
impl BMRequestType {
    // Get descriptor request type.
    pub fn get_descr() -> Self {
        Self::from((
            USBSetupDirection::DeviceToHost,
            USBSetupType::Standard,
            USBSetupRecipient::Device,
        ))
    }

    // Set request type for all but 'set feature' and 'set interface'.
    pub fn set() -> Self {
        Self::from((
            USBSetupDirection::HostToDevice,
            USBSetupType::Standard,
            USBSetupRecipient::Device,
        ))
    }

    // Get interface request type.
    pub fn cl_get_intf() -> Self {
        Self::from((
            USBSetupDirection::DeviceToHost,
            USBSetupType::Class,
            USBSetupRecipient::Interface,
        ))
    }

    pub fn recipient(&self) -> USBSetupRecipient {
        const POS: u8 = 0;
        const MASK: u8 = 0x1f;
        (self.0 & (MASK << POS)).into()
    }

    pub fn set_recipient(&mut self, v: USBSetupRecipient) {
        const POS: u8 = 0;
        const MASK: u8 = 0x1f;
        self.0 &= !(MASK << POS);
        self.0 |= v as u8 & MASK;
    }

    pub fn typ(&self) -> USBSetupType {
        const POS: u8 = 5;
        const MASK: u8 = 0x3;
        (self.0 & (MASK << POS)).into()
    }

    pub fn set_typ(&mut self, v: USBSetupType) {
        const POS: u8 = 5;
        const MASK: u8 = 0x3;
        self.0 &= !(MASK << POS);
        self.0 |= v as u8 & MASK;
    }

    pub fn direction(&self) -> USBSetupDirection {
        const POS: u8 = 7;
        const MASK: u8 = 0x1;
        (self.0 & (MASK << POS)).into()
    }

    pub fn set_direction(&mut self, v: USBSetupDirection) {
        const POS: u8 = 7;
        const MASK: u8 = 0x1;
        self.0 &= !(MASK << POS);
        self.0 |= v as u8 & MASK;
    }
}
impl From<u8> for BMRequestType {
    fn from(v: u8) -> Self {
        Self(v)
    }
}
impl From<(USBSetupDirection, USBSetupType, USBSetupRecipient)> for BMRequestType {
    fn from(v: (USBSetupDirection, USBSetupType, USBSetupRecipient)) -> Self {
        Self(v.0 as u8 | v.1 as u8 | v.2 as u8)
    }
}

#[derive(Clone, Copy, Debug, Default, PartialEq)]
#[repr(C)]
pub struct WValue(u16);
impl WValue {
    pub fn w_value_lo(&self) -> u8 {
        const POS: u8 = 0;
        const MASK: u16 = 0xff;
        ((self.0 >> POS) & MASK) as u8
    }

    pub fn set_w_value_lo(&mut self, v: u8) {
        const POS: u8 = 0;
        const MASK: u8 = 0xff;
        self.0 &= !((MASK as u16) << POS);
        self.0 |= ((v & MASK) as u16) << POS;
    }

    pub fn w_value_hi(&self) -> u8 {
        const POS: u8 = 8;
        const MASK: u16 = 0xff;
        ((self.0 >> POS) & MASK) as u8
    }

    pub fn set_w_value_hi(&mut self, v: u8) {
        const POS: u8 = 8;
        const MASK: u8 = 0xff;
        self.0 &= !((MASK as u16) << POS);
        self.0 |= ((v & MASK) as u16) << POS;
    }
}
impl From<(u8, u8)> for WValue {
    fn from(v: (u8, u8)) -> Self {
        let mut rc = Self(0);
        rc.set_w_value_lo(v.0);
        rc.set_w_value_hi(v.1);
        rc
    }
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub enum USBRequest {
    GetStatus = 0,
    ClearFeature = 1,
    SetFeature = 3,
    SetAddress = 5,
    GetDescriptor = 6,
    SetDescriptor = 7,
    GetConfiguration = 8,
    SetConfiguration = 9,
    GetInterface = 10,
    SetInterface = 11,
    SynchFrame = 12,
}
impl<T> From<T> for USBRequest
where
    T: Into<u8>,
{
    fn from(v: T) -> Self {
        match v.into() {
            0 => Self::GetStatus,
            1 => Self::ClearFeature,
            3 => Self::SetFeature,
            5 => Self::SetAddress,
            6 => Self::GetDescriptor,
            7 => Self::SetDescriptor,
            8 => Self::GetConfiguration,
            9 => Self::SetConfiguration,
            10 => Self::GetInterface,
            11 => Self::SetInterface,
            12 => Self::SynchFrame,
            _ => panic!("invalid request value"),
        }
    }
}
impl Default for USBRequest {
    fn default() -> Self {
        Self::GetStatus
    }
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub enum USBFeature {
    EndpointHalt = 0,
    DeviceRemoteWakeup = 1,
    TestMode = 2,
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub enum USBDescriptor {
    Device = 0x01,
    Configuration = 0x02,
    String = 0x03,
    Interface = 0x04,
    Endpoint = 0x05,
    DeviceQualifier = 0x06,
    OtherSpeed = 0x07,
    InterfacePower = 0x08,
    OTG = 0x09,
}
impl Default for USBDescriptor {
    fn default() -> Self {
        Self::Device
    }
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub enum HIDDescriptor {
    HID = 0x21,
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub enum OTGFeature {
    BHNPEnable = 3,
    AHNPSupport = 4,
    AAltHNPSupport = 5,
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub enum USBTransferType {
    Control = 0x00,
    Isochronous = 0x01,
    Bulk = 0x02,
    Interrupt = 0x03,
}

#[cfg(test)]
mod test {
    use super::super::pipe::DataBuf;
    use super::*;

    #[test]
    fn dev_desc_serialize() {
        let mut desc = USBDeviceDescriptor {
            b_length: 18,
            b_descriptor_type: USBDescriptor::Device,
            bcd_usb: 0x0110,
            b_device_class: 0x02,
            b_device_sub_class: 0x03,
            b_device_protocol: 0x04,
            b_max_packet_size: 64,
            id_vendor: 0xdead,
            id_product: 0xbeef,
            bcd_device: 0x5432,
            i_manufacturer: 0xa0,
            i_product: 0xa1,
            i_serial_number: 0xa2,
            b_num_configurations: 1,
        };
        let db = DataBuf::from(&mut desc);
        assert_eq!(db.len, 18);
        let want = [
            0x12, 0x01, 0x10, 0x01, 0x02, 0x03, 0x04, 64, 0xad, 0xde, 0xef, 0xbe, 0x32, 0x54, 0xa0,
            0xa1, 0xa2, 1,
        ];
        let got = unsafe { core::slice::from_raw_parts(db.ptr, db.len) };
        assert_eq!(got, want);
    }

    #[test]
    fn config_desc_serialize() {
        let mut desc = USBConfigurationDescriptor {
            b_length: 18,
            b_descriptor_type: USBDescriptor::Configuration,
            w_total_length: 0x20,
            b_num_interfaces: 5,
            b_configuration_value: 10,
            i_configuration: 1,
            bm_attributes: 0x40,
            b_max_power: 0xfa,
        };
        let db = DataBuf::from(&mut desc);
        assert_eq!(db.len, 9);
        let want = [0x12, 0x02, 0x20, 0x00, 0x05, 0x0a, 0x01, 0x40, 0xfa];
        let got = unsafe { core::slice::from_raw_parts(db.ptr, db.len) };
        assert_eq!(got, want);
    }

    #[test]
    fn interface_desc_serialize() {
        let mut desc = USBInterfaceDescriptor {
            b_length: 18,
            b_descriptor_type: USBDescriptor::Interface,
            b_interface_number: 2,
            b_alternate_setting: 0xaa,
            b_num_endpoints: 5,
            b_interface_class: 0x11,
            b_interface_sub_class: 0x22,
            b_interface_protocol: 0x33,
            i_interface: 10,
        };
        let db = DataBuf::from(&mut desc);
        assert_eq!(db.len, 9);
        let want = [0x12, 0x04, 0x02, 0xaa, 0x05, 0x11, 0x22, 0x33, 0x0a];
        let got = unsafe { core::slice::from_raw_parts(db.ptr, db.len) };
        assert_eq!(got, want);
    }

    #[test]
    fn endpoint_desc_serialize() {
        let mut desc = USBEndpointDescriptor {
            b_length: 18,
            b_descriptor_type: USBDescriptor::Endpoint,
            b_endpoint_address: 1,
            bm_attributes: 0x22,
            w_max_packet_size: 0xdead,
            b_interval: 0x33,
        };
        let db = DataBuf::from(&mut desc);
        assert_eq!(db.len, 7);
        let want = [0x12, 0x05, 0x01, 0x22, 0xad, 0xde, 0x33];
        let got = unsafe { core::slice::from_raw_parts(db.ptr, db.len) };
        assert_eq!(got, want);
    }

    #[test]
    fn setup_packet_serialize() {
        let mut setup_packet = USBSetupPacket {
            bm_request_type: BMRequestType::get_descr(),
            b_request: USBRequest::GetDescriptor,
            w_value: WValue::from((0x00, 0x01)),
            w_index: 0xbeef,
            w_length: 18,
        };
        let db = DataBuf::from(&mut setup_packet);
        assert_eq!(db.len, 8);
        let want = [0x80, 0x06, 0x00, 0x01, 0xef, 0xbe, 0x012, 0x00];
        let got = unsafe { core::slice::from_raw_parts(db.ptr, db.len) };
        assert_eq!(got, want);
    }
}