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#define USB_DT_SS_ENDPOINT_COMP 0x30
196
197
198
199
200
201#define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE)
202#define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG)
203#define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING)
204#define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE)
205#define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT)
206
207
208struct usb_descriptor_header {
209 __u8 bLength;
210 __u8 bDescriptorType;
211} __attribute__ ((packed));
212
213
214
215
216
217struct usb_device_descriptor {
218 __u8 bLength;
219 __u8 bDescriptorType;
220
221 __le16 bcdUSB;
222 __u8 bDeviceClass;
223 __u8 bDeviceSubClass;
224 __u8 bDeviceProtocol;
225 __u8 bMaxPacketSize0;
226 __le16 idVendor;
227 __le16 idProduct;
228 __le16 bcdDevice;
229 __u8 iManufacturer;
230 __u8 iProduct;
231 __u8 iSerialNumber;
232 __u8 bNumConfigurations;
233} __attribute__ ((packed));
234
235#define USB_DT_DEVICE_SIZE 18
236
237
238
239
240
241
242
243#define USB_CLASS_PER_INTERFACE 0
244#define USB_CLASS_AUDIO 1
245#define USB_CLASS_COMM 2
246#define USB_CLASS_HID 3
247#define USB_CLASS_PHYSICAL 5
248#define USB_CLASS_STILL_IMAGE 6
249#define USB_CLASS_PRINTER 7
250#define USB_CLASS_MASS_STORAGE 8
251#define USB_CLASS_HUB 9
252#define USB_CLASS_CDC_DATA 0x0a
253#define USB_CLASS_CSCID 0x0b
254#define USB_CLASS_CONTENT_SEC 0x0d
255#define USB_CLASS_VIDEO 0x0e
256#define USB_CLASS_WIRELESS_CONTROLLER 0xe0
257#define USB_CLASS_MISC 0xef
258#define USB_CLASS_APP_SPEC 0xfe
259#define USB_CLASS_VENDOR_SPEC 0xff
260
261#define USB_SUBCLASS_VENDOR_SPEC 0xff
262
263
264
265
266
267
268
269
270
271
272
273struct usb_config_descriptor {
274 __u8 bLength;
275 __u8 bDescriptorType;
276
277 __le16 wTotalLength;
278 __u8 bNumInterfaces;
279 __u8 bConfigurationValue;
280 __u8 iConfiguration;
281 __u8 bmAttributes;
282 __u8 bMaxPower;
283} __attribute__ ((packed));
284
285#define USB_DT_CONFIG_SIZE 9
286
287
288#define USB_CONFIG_ATT_ONE (1 << 7)
289#define USB_CONFIG_ATT_SELFPOWER (1 << 6)
290#define USB_CONFIG_ATT_WAKEUP (1 << 5)
291#define USB_CONFIG_ATT_BATTERY (1 << 4)
292
293
294
295
296struct usb_string_descriptor {
297 __u8 bLength;
298 __u8 bDescriptorType;
299
300 __le16 wData[1];
301} __attribute__ ((packed));
302
303
304
305
306
307
308
309
310struct usb_interface_descriptor {
311 __u8 bLength;
312 __u8 bDescriptorType;
313
314 __u8 bInterfaceNumber;
315 __u8 bAlternateSetting;
316 __u8 bNumEndpoints;
317 __u8 bInterfaceClass;
318 __u8 bInterfaceSubClass;
319 __u8 bInterfaceProtocol;
320 __u8 iInterface;
321} __attribute__ ((packed));
322
323#define USB_DT_INTERFACE_SIZE 9
324
325
326
327
328struct usb_endpoint_descriptor {
329 __u8 bLength;
330 __u8 bDescriptorType;
331
332 __u8 bEndpointAddress;
333 __u8 bmAttributes;
334 __le16 wMaxPacketSize;
335 __u8 bInterval;
336
337
338
339 __u8 bRefresh;
340 __u8 bSynchAddress;
341} __attribute__ ((packed));
342
343#define USB_DT_ENDPOINT_SIZE 7
344#define USB_DT_ENDPOINT_AUDIO_SIZE 9
345
346
347
348
349
350#define USB_ENDPOINT_NUMBER_MASK 0x0f
351#define USB_ENDPOINT_DIR_MASK 0x80
352
353#define USB_ENDPOINT_SYNCTYPE 0x0c
354#define USB_ENDPOINT_SYNC_NONE (0 << 2)
355#define USB_ENDPOINT_SYNC_ASYNC (1 << 2)
356#define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2)
357#define USB_ENDPOINT_SYNC_SYNC (3 << 2)
358
359#define USB_ENDPOINT_XFERTYPE_MASK 0x03
360#define USB_ENDPOINT_XFER_CONTROL 0
361#define USB_ENDPOINT_XFER_ISOC 1
362#define USB_ENDPOINT_XFER_BULK 2
363#define USB_ENDPOINT_XFER_INT 3
364#define USB_ENDPOINT_MAX_ADJUSTABLE 0x80
365
366
367
368
369
370
371
372
373
374static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
375{
376 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
377}
378
379
380
381
382
383
384
385
386static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
387{
388 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
389}
390
391
392
393
394
395
396
397static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
398{
399 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
400}
401
402
403
404
405
406
407
408static inline int usb_endpoint_dir_out(
409 const struct usb_endpoint_descriptor *epd)
410{
411 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
412}
413
414
415
416
417
418
419
420static inline int usb_endpoint_xfer_bulk(
421 const struct usb_endpoint_descriptor *epd)
422{
423 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
424 USB_ENDPOINT_XFER_BULK);
425}
426
427
428
429
430
431
432
433static inline int usb_endpoint_xfer_control(
434 const struct usb_endpoint_descriptor *epd)
435{
436 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
437 USB_ENDPOINT_XFER_CONTROL);
438}
439
440
441
442
443
444
445
446
447static inline int usb_endpoint_xfer_int(
448 const struct usb_endpoint_descriptor *epd)
449{
450 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
451 USB_ENDPOINT_XFER_INT);
452}
453
454
455
456
457
458
459
460
461static inline int usb_endpoint_xfer_isoc(
462 const struct usb_endpoint_descriptor *epd)
463{
464 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
465 USB_ENDPOINT_XFER_ISOC);
466}
467
468
469
470
471
472
473
474
475static inline int usb_endpoint_is_bulk_in(
476 const struct usb_endpoint_descriptor *epd)
477{
478 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd));
479}
480
481
482
483
484
485
486
487
488static inline int usb_endpoint_is_bulk_out(
489 const struct usb_endpoint_descriptor *epd)
490{
491 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd));
492}
493
494
495
496
497
498
499
500
501static inline int usb_endpoint_is_int_in(
502 const struct usb_endpoint_descriptor *epd)
503{
504 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd));
505}
506
507
508
509
510
511
512
513
514static inline int usb_endpoint_is_int_out(
515 const struct usb_endpoint_descriptor *epd)
516{
517 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd));
518}
519
520
521
522
523
524
525
526
527static inline int usb_endpoint_is_isoc_in(
528 const struct usb_endpoint_descriptor *epd)
529{
530 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd));
531}
532
533
534
535
536
537
538
539
540static inline int usb_endpoint_is_isoc_out(
541 const struct usb_endpoint_descriptor *epd)
542{
543 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd));
544}
545
546
547
548
549struct usb_ss_ep_comp_descriptor {
550 __u8 bLength;
551 __u8 bDescriptorType;
552
553 __u8 bMaxBurst;
554 __u8 bmAttributes;
555 __u16 wBytesPerInterval;
556} __attribute__ ((packed));
557
558#define USB_DT_SS_EP_COMP_SIZE 6
559
560
561
562
563struct usb_qualifier_descriptor {
564 __u8 bLength;
565 __u8 bDescriptorType;
566
567 __le16 bcdUSB;
568 __u8 bDeviceClass;
569 __u8 bDeviceSubClass;
570 __u8 bDeviceProtocol;
571 __u8 bMaxPacketSize0;
572 __u8 bNumConfigurations;
573 __u8 bRESERVED;
574} __attribute__ ((packed));
575
576
577
578
579
580struct usb_otg_descriptor {
581 __u8 bLength;
582 __u8 bDescriptorType;
583
584 __u8 bmAttributes;
585} __attribute__ ((packed));
586
587
588#define USB_OTG_SRP (1 << 0)
589#define USB_OTG_HNP (1 << 1)
590
591
592
593
594struct usb_debug_descriptor {
595 __u8 bLength;
596 __u8 bDescriptorType;
597
598
599 __u8 bDebugInEndpoint;
600 __u8 bDebugOutEndpoint;
601} __attribute__((packed));
602
603
604
605
606struct usb_interface_assoc_descriptor {
607 __u8 bLength;
608 __u8 bDescriptorType;
609
610 __u8 bFirstInterface;
611 __u8 bInterfaceCount;
612 __u8 bFunctionClass;
613 __u8 bFunctionSubClass;
614 __u8 bFunctionProtocol;
615 __u8 iFunction;
616} __attribute__ ((packed));
617
618
619
620
621
622
623
624struct usb_security_descriptor {
625 __u8 bLength;
626 __u8 bDescriptorType;
627
628 __le16 wTotalLength;
629 __u8 bNumEncryptionTypes;
630} __attribute__((packed));
631
632
633
634
635
636
637struct usb_key_descriptor {
638 __u8 bLength;
639 __u8 bDescriptorType;
640
641 __u8 tTKID[3];
642 __u8 bReserved;
643 __u8 bKeyData[0];
644} __attribute__((packed));
645
646
647
648
649struct usb_encryption_descriptor {
650 __u8 bLength;
651 __u8 bDescriptorType;
652
653 __u8 bEncryptionType;
654#define USB_ENC_TYPE_UNSECURE 0
655#define USB_ENC_TYPE_WIRED 1
656#define USB_ENC_TYPE_CCM_1 2
657#define USB_ENC_TYPE_RSA_1 3
658 __u8 bEncryptionValue;
659 __u8 bAuthKeyIndex;
660} __attribute__((packed));
661
662
663
664
665
666struct usb_bos_descriptor {
667 __u8 bLength;
668 __u8 bDescriptorType;
669
670 __le16 wTotalLength;
671 __u8 bNumDeviceCaps;
672} __attribute__((packed));
673
674
675
676
677struct usb_dev_cap_header {
678 __u8 bLength;
679 __u8 bDescriptorType;
680 __u8 bDevCapabilityType;
681} __attribute__((packed));
682
683#define USB_CAP_TYPE_WIRELESS_USB 1
684
685struct usb_wireless_cap_descriptor {
686 __u8 bLength;
687 __u8 bDescriptorType;
688 __u8 bDevCapabilityType;
689
690 __u8 bmAttributes;
691#define USB_WIRELESS_P2P_DRD (1 << 1)
692#define USB_WIRELESS_BEACON_MASK (3 << 2)
693#define USB_WIRELESS_BEACON_SELF (1 << 2)
694#define USB_WIRELESS_BEACON_DIRECTED (2 << 2)
695#define USB_WIRELESS_BEACON_NONE (3 << 2)
696 __le16 wPHYRates;
697#define USB_WIRELESS_PHY_53 (1 << 0)
698#define USB_WIRELESS_PHY_80 (1 << 1)
699#define USB_WIRELESS_PHY_107 (1 << 2)
700#define USB_WIRELESS_PHY_160 (1 << 3)
701#define USB_WIRELESS_PHY_200 (1 << 4)
702#define USB_WIRELESS_PHY_320 (1 << 5)
703#define USB_WIRELESS_PHY_400 (1 << 6)
704#define USB_WIRELESS_PHY_480 (1 << 7)
705 __u8 bmTFITXPowerInfo;
706 __u8 bmFFITXPowerInfo;
707 __le16 bmBandGroup;
708 __u8 bReserved;
709} __attribute__((packed));
710
711#define USB_CAP_TYPE_EXT 2
712
713struct usb_ext_cap_descriptor {
714 __u8 bLength;
715 __u8 bDescriptorType;
716 __u8 bDevCapabilityType;
717 __u8 bmAttributes;
718#define USB_LPM_SUPPORT (1 << 1)
719} __attribute__((packed));
720
721
722
723
724
725
726struct usb_wireless_ep_comp_descriptor {
727 __u8 bLength;
728 __u8 bDescriptorType;
729
730 __u8 bMaxBurst;
731 __u8 bMaxSequence;
732 __le16 wMaxStreamDelay;
733 __le16 wOverTheAirPacketSize;
734 __u8 bOverTheAirInterval;
735 __u8 bmCompAttributes;
736#define USB_ENDPOINT_SWITCH_MASK 0x03
737#define USB_ENDPOINT_SWITCH_NO 0
738#define USB_ENDPOINT_SWITCH_SWITCH 1
739#define USB_ENDPOINT_SWITCH_SCALE 2
740} __attribute__((packed));
741
742
743
744
745
746
747
748struct usb_handshake {
749 __u8 bMessageNumber;
750 __u8 bStatus;
751 __u8 tTKID[3];
752 __u8 bReserved;
753 __u8 CDID[16];
754 __u8 nonce[16];
755 __u8 MIC[8];
756} __attribute__((packed));
757
758
759
760
761
762
763
764struct usb_connection_context {
765 __u8 CHID[16];
766 __u8 CDID[16];
767 __u8 CK[16];
768} __attribute__((packed));
769
770
771
772
773
774enum usb_device_speed {
775 USB_SPEED_UNKNOWN = 0,
776 USB_SPEED_LOW, USB_SPEED_FULL,
777 USB_SPEED_HIGH,
778 USB_SPEED_VARIABLE,
779 USB_SPEED_SUPER,
780};
781
782enum usb_device_state {
783
784
785
786 USB_STATE_NOTATTACHED = 0,
787
788
789 USB_STATE_ATTACHED,
790 USB_STATE_POWERED,
791 USB_STATE_RECONNECTING,
792 USB_STATE_UNAUTHENTICATED,
793 USB_STATE_DEFAULT,
794 USB_STATE_ADDRESS,
795 USB_STATE_CONFIGURED,
796
797 USB_STATE_SUSPENDED
798
799
800
801
802
803
804
805};
806
807#endif
808