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#ifndef __LINUX_USB_CH9_H
34#define __LINUX_USB_CH9_H
35
36#include <linux/types.h>
37
38
39
40
41
42
43
44
45
46
47
48#define USB_DIR_OUT 0
49#define USB_DIR_IN 0x80
50
51
52
53
54#define USB_TYPE_MASK (0x03 << 5)
55#define USB_TYPE_STANDARD (0x00 << 5)
56#define USB_TYPE_CLASS (0x01 << 5)
57#define USB_TYPE_VENDOR (0x02 << 5)
58#define USB_TYPE_RESERVED (0x03 << 5)
59
60
61
62
63#define USB_RECIP_MASK 0x1f
64#define USB_RECIP_DEVICE 0x00
65#define USB_RECIP_INTERFACE 0x01
66#define USB_RECIP_ENDPOINT 0x02
67#define USB_RECIP_OTHER 0x03
68
69#define USB_RECIP_PORT 0x04
70#define USB_RECIP_RPIPE 0x05
71
72
73
74
75
76
77
78
79#define USB_REQ_GET_STATUS 0x00
80#define USB_REQ_CLEAR_FEATURE 0x01
81#define USB_REQ_SET_FEATURE 0x03
82#define USB_REQ_SET_ADDRESS 0x05
83#define USB_REQ_GET_DESCRIPTOR 0x06
84#define USB_REQ_SET_DESCRIPTOR 0x07
85#define USB_REQ_GET_CONFIGURATION 0x08
86#define USB_REQ_SET_CONFIGURATION 0x09
87#define USB_REQ_GET_INTERFACE 0x0A
88#define USB_REQ_SET_INTERFACE 0x0B
89#define USB_REQ_SYNCH_FRAME 0x0C
90
91#define USB_REQ_SET_ENCRYPTION 0x0D
92#define USB_REQ_GET_ENCRYPTION 0x0E
93#define USB_REQ_RPIPE_ABORT 0x0E
94#define USB_REQ_SET_HANDSHAKE 0x0F
95#define USB_REQ_RPIPE_RESET 0x0F
96#define USB_REQ_GET_HANDSHAKE 0x10
97#define USB_REQ_SET_CONNECTION 0x11
98#define USB_REQ_SET_SECURITY_DATA 0x12
99#define USB_REQ_GET_SECURITY_DATA 0x13
100#define USB_REQ_SET_WUSB_DATA 0x14
101#define USB_REQ_LOOPBACK_DATA_WRITE 0x15
102#define USB_REQ_LOOPBACK_DATA_READ 0x16
103#define USB_REQ_SET_INTERFACE_DS 0x17
104
105
106
107
108
109
110
111
112
113
114
115
116#define USB_DEVICE_SELF_POWERED 0
117#define USB_DEVICE_REMOTE_WAKEUP 1
118#define USB_DEVICE_TEST_MODE 2
119#define USB_DEVICE_BATTERY 2
120#define USB_DEVICE_B_HNP_ENABLE 3
121#define USB_DEVICE_WUSB_DEVICE 3
122#define USB_DEVICE_A_HNP_SUPPORT 4
123#define USB_DEVICE_A_ALT_HNP_SUPPORT 5
124#define USB_DEVICE_DEBUG_MODE 6
125
126#define USB_ENDPOINT_HALT 0
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146struct usb_ctrlrequest {
147 __u8 bRequestType;
148 __u8 bRequest;
149 __le16 wValue;
150 __le16 wIndex;
151 __le16 wLength;
152} __attribute__ ((packed));
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172#define USB_DT_DEVICE 0x01
173#define USB_DT_CONFIG 0x02
174#define USB_DT_STRING 0x03
175#define USB_DT_INTERFACE 0x04
176#define USB_DT_ENDPOINT 0x05
177#define USB_DT_DEVICE_QUALIFIER 0x06
178#define USB_DT_OTHER_SPEED_CONFIG 0x07
179#define USB_DT_INTERFACE_POWER 0x08
180
181#define USB_DT_OTG 0x09
182#define USB_DT_DEBUG 0x0a
183#define USB_DT_INTERFACE_ASSOCIATION 0x0b
184
185#define USB_DT_SECURITY 0x0c
186#define USB_DT_KEY 0x0d
187#define USB_DT_ENCRYPTION_TYPE 0x0e
188#define USB_DT_BOS 0x0f
189#define USB_DT_DEVICE_CAPABILITY 0x10
190#define USB_DT_WIRELESS_ENDPOINT_COMP 0x11
191#define USB_DT_WIRE_ADAPTER 0x21
192#define USB_DT_RPIPE 0x22
193#define USB_DT_CS_RADIO_CONTROL 0x23
194
195
196
197
198
199#define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE)
200#define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG)
201#define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING)
202#define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE)
203#define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT)
204
205
206struct usb_descriptor_header {
207 __u8 bLength;
208 __u8 bDescriptorType;
209} __attribute__ ((packed));
210
211
212
213
214
215struct usb_device_descriptor {
216 __u8 bLength;
217 __u8 bDescriptorType;
218
219 __le16 bcdUSB;
220 __u8 bDeviceClass;
221 __u8 bDeviceSubClass;
222 __u8 bDeviceProtocol;
223 __u8 bMaxPacketSize0;
224 __le16 idVendor;
225 __le16 idProduct;
226 __le16 bcdDevice;
227 __u8 iManufacturer;
228 __u8 iProduct;
229 __u8 iSerialNumber;
230 __u8 bNumConfigurations;
231} __attribute__ ((packed));
232
233#define USB_DT_DEVICE_SIZE 18
234
235
236
237
238
239
240
241#define USB_CLASS_PER_INTERFACE 0
242#define USB_CLASS_AUDIO 1
243#define USB_CLASS_COMM 2
244#define USB_CLASS_HID 3
245#define USB_CLASS_PHYSICAL 5
246#define USB_CLASS_STILL_IMAGE 6
247#define USB_CLASS_PRINTER 7
248#define USB_CLASS_MASS_STORAGE 8
249#define USB_CLASS_HUB 9
250#define USB_CLASS_CDC_DATA 0x0a
251#define USB_CLASS_CSCID 0x0b
252#define USB_CLASS_CONTENT_SEC 0x0d
253#define USB_CLASS_VIDEO 0x0e
254#define USB_CLASS_WIRELESS_CONTROLLER 0xe0
255#define USB_CLASS_MISC 0xef
256#define USB_CLASS_APP_SPEC 0xfe
257#define USB_CLASS_VENDOR_SPEC 0xff
258
259
260
261
262
263
264
265
266
267
268
269struct usb_config_descriptor {
270 __u8 bLength;
271 __u8 bDescriptorType;
272
273 __le16 wTotalLength;
274 __u8 bNumInterfaces;
275 __u8 bConfigurationValue;
276 __u8 iConfiguration;
277 __u8 bmAttributes;
278 __u8 bMaxPower;
279} __attribute__ ((packed));
280
281#define USB_DT_CONFIG_SIZE 9
282
283
284#define USB_CONFIG_ATT_ONE (1 << 7)
285#define USB_CONFIG_ATT_SELFPOWER (1 << 6)
286#define USB_CONFIG_ATT_WAKEUP (1 << 5)
287#define USB_CONFIG_ATT_BATTERY (1 << 4)
288
289
290
291
292struct usb_string_descriptor {
293 __u8 bLength;
294 __u8 bDescriptorType;
295
296 __le16 wData[1];
297} __attribute__ ((packed));
298
299
300
301
302
303
304
305
306struct usb_interface_descriptor {
307 __u8 bLength;
308 __u8 bDescriptorType;
309
310 __u8 bInterfaceNumber;
311 __u8 bAlternateSetting;
312 __u8 bNumEndpoints;
313 __u8 bInterfaceClass;
314 __u8 bInterfaceSubClass;
315 __u8 bInterfaceProtocol;
316 __u8 iInterface;
317} __attribute__ ((packed));
318
319#define USB_DT_INTERFACE_SIZE 9
320
321
322
323
324struct usb_endpoint_descriptor {
325 __u8 bLength;
326 __u8 bDescriptorType;
327
328 __u8 bEndpointAddress;
329 __u8 bmAttributes;
330 __le16 wMaxPacketSize;
331 __u8 bInterval;
332
333
334
335 __u8 bRefresh;
336 __u8 bSynchAddress;
337} __attribute__ ((packed));
338
339#define USB_DT_ENDPOINT_SIZE 7
340#define USB_DT_ENDPOINT_AUDIO_SIZE 9
341
342
343
344
345
346#define USB_ENDPOINT_NUMBER_MASK 0x0f
347#define USB_ENDPOINT_DIR_MASK 0x80
348
349#define USB_ENDPOINT_XFERTYPE_MASK 0x03
350#define USB_ENDPOINT_XFER_CONTROL 0
351#define USB_ENDPOINT_XFER_ISOC 1
352#define USB_ENDPOINT_XFER_BULK 2
353#define USB_ENDPOINT_XFER_INT 3
354#define USB_ENDPOINT_MAX_ADJUSTABLE 0x80
355
356
357
358
359
360struct usb_qualifier_descriptor {
361 __u8 bLength;
362 __u8 bDescriptorType;
363
364 __le16 bcdUSB;
365 __u8 bDeviceClass;
366 __u8 bDeviceSubClass;
367 __u8 bDeviceProtocol;
368 __u8 bMaxPacketSize0;
369 __u8 bNumConfigurations;
370 __u8 bRESERVED;
371} __attribute__ ((packed));
372
373
374
375
376
377struct usb_otg_descriptor {
378 __u8 bLength;
379 __u8 bDescriptorType;
380
381 __u8 bmAttributes;
382} __attribute__ ((packed));
383
384
385#define USB_OTG_SRP (1 << 0)
386#define USB_OTG_HNP (1 << 1)
387
388
389
390
391struct usb_debug_descriptor {
392 __u8 bLength;
393 __u8 bDescriptorType;
394
395
396 __u8 bDebugInEndpoint;
397 __u8 bDebugOutEndpoint;
398} __attribute__((packed));
399
400
401
402
403struct usb_interface_assoc_descriptor {
404 __u8 bLength;
405 __u8 bDescriptorType;
406
407 __u8 bFirstInterface;
408 __u8 bInterfaceCount;
409 __u8 bFunctionClass;
410 __u8 bFunctionSubClass;
411 __u8 bFunctionProtocol;
412 __u8 iFunction;
413} __attribute__ ((packed));
414
415
416
417
418
419
420
421struct usb_security_descriptor {
422 __u8 bLength;
423 __u8 bDescriptorType;
424
425 __le16 wTotalLength;
426 __u8 bNumEncryptionTypes;
427} __attribute__((packed));
428
429
430
431
432
433
434struct usb_key_descriptor {
435 __u8 bLength;
436 __u8 bDescriptorType;
437
438 __u8 tTKID[3];
439 __u8 bReserved;
440 __u8 bKeyData[0];
441} __attribute__((packed));
442
443
444
445
446struct usb_encryption_descriptor {
447 __u8 bLength;
448 __u8 bDescriptorType;
449
450 __u8 bEncryptionType;
451#define USB_ENC_TYPE_UNSECURE 0
452#define USB_ENC_TYPE_WIRED 1
453#define USB_ENC_TYPE_CCM_1 2
454#define USB_ENC_TYPE_RSA_1 3
455 __u8 bEncryptionValue;
456 __u8 bAuthKeyIndex;
457} __attribute__((packed));
458
459
460
461
462
463struct usb_bos_descriptor {
464 __u8 bLength;
465 __u8 bDescriptorType;
466
467 __le16 wTotalLength;
468 __u8 bNumDeviceCaps;
469} __attribute__((packed));
470
471
472
473
474struct usb_dev_cap_header {
475 __u8 bLength;
476 __u8 bDescriptorType;
477 __u8 bDevCapabilityType;
478} __attribute__((packed));
479
480#define USB_CAP_TYPE_WIRELESS_USB 1
481
482struct usb_wireless_cap_descriptor {
483 __u8 bLength;
484 __u8 bDescriptorType;
485 __u8 bDevCapabilityType;
486
487 __u8 bmAttributes;
488#define USB_WIRELESS_P2P_DRD (1 << 1)
489#define USB_WIRELESS_BEACON_MASK (3 << 2)
490#define USB_WIRELESS_BEACON_SELF (1 << 2)
491#define USB_WIRELESS_BEACON_DIRECTED (2 << 2)
492#define USB_WIRELESS_BEACON_NONE (3 << 2)
493 __le16 wPHYRates;
494#define USB_WIRELESS_PHY_53 (1 << 0)
495#define USB_WIRELESS_PHY_80 (1 << 1)
496#define USB_WIRELESS_PHY_107 (1 << 2)
497#define USB_WIRELESS_PHY_160 (1 << 3)
498#define USB_WIRELESS_PHY_200 (1 << 4)
499#define USB_WIRELESS_PHY_320 (1 << 5)
500#define USB_WIRELESS_PHY_400 (1 << 6)
501#define USB_WIRELESS_PHY_480 (1 << 7)
502 __u8 bmTFITXPowerInfo;
503 __u8 bmFFITXPowerInfo;
504 __le16 bmBandGroup;
505 __u8 bReserved;
506} __attribute__((packed));
507
508#define USB_CAP_TYPE_EXT 2
509
510struct usb_ext_cap_descriptor {
511 __u8 bLength;
512 __u8 bDescriptorType;
513 __u8 bDevCapabilityType;
514 __u8 bmAttributes;
515#define USB_LPM_SUPPORT (1 << 1)
516} __attribute__((packed));
517
518
519
520
521
522
523struct usb_wireless_ep_comp_descriptor {
524 __u8 bLength;
525 __u8 bDescriptorType;
526
527 __u8 bMaxBurst;
528 __u8 bMaxSequence;
529 __le16 wMaxStreamDelay;
530 __le16 wOverTheAirPacketSize;
531 __u8 bOverTheAirInterval;
532 __u8 bmCompAttributes;
533#define USB_ENDPOINT_SWITCH_MASK 0x03
534#define USB_ENDPOINT_SWITCH_NO 0
535#define USB_ENDPOINT_SWITCH_SWITCH 1
536#define USB_ENDPOINT_SWITCH_SCALE 2
537} __attribute__((packed));
538
539
540
541
542
543
544
545struct usb_handshake {
546 __u8 bMessageNumber;
547 __u8 bStatus;
548 __u8 tTKID[3];
549 __u8 bReserved;
550 __u8 CDID[16];
551 __u8 nonce[16];
552 __u8 MIC[8];
553} __attribute__((packed));
554
555
556
557
558
559
560
561struct usb_connection_context {
562 __u8 CHID[16];
563 __u8 CDID[16];
564 __u8 CK[16];
565} __attribute__((packed));
566
567
568
569
570
571enum usb_device_speed {
572 USB_SPEED_UNKNOWN = 0,
573 USB_SPEED_LOW, USB_SPEED_FULL,
574 USB_SPEED_HIGH,
575 USB_SPEED_VARIABLE,
576};
577
578enum usb_device_state {
579
580
581
582 USB_STATE_NOTATTACHED = 0,
583
584
585 USB_STATE_ATTACHED,
586 USB_STATE_POWERED,
587 USB_STATE_UNAUTHENTICATED,
588 USB_STATE_RECONNECTING,
589 USB_STATE_DEFAULT,
590 USB_STATE_ADDRESS,
591 USB_STATE_CONFIGURED,
592
593 USB_STATE_SUSPENDED
594
595
596
597
598
599
600
601};
602
603#endif
604