2 * This file holds USB constants and structures that are needed for
3 * USB device APIs. These are used by the USB device model, which is
4 * defined in chapter 9 of the USB 2.0 specification and in the
5 * Wireless USB 1.0 (spread around). Linux has several APIs in C that
8 * - the master/host side Linux-USB kernel driver API;
9 * - the "usbfs" user space API; and
10 * - the Linux "gadget" slave/device/peripheral side driver API.
12 * USB 2.0 adds an additional "On The Go" (OTG) mode, which lets systems
13 * act either as a USB master/host or as a USB slave/device. That means
14 * the master and slave side APIs benefit from working well together.
16 * There's also "Wireless USB", using low power short range radios for
17 * peripheral interconnection but otherwise building on the USB framework.
19 * Note all descriptors are declared '__attribute__((packed))' so that:
21 * [a] they never get padded, either internally (USB spec writers
22 * probably handled that) or externally;
24 * [b] so that accessing bigger-than-a-bytes fields will never
25 * generate bus errors on any platform, even when the location of
26 * its descriptor inside a bundle isn't "naturally aligned", and
28 * [c] for consistency, removing all doubt even when it appears to
29 * someone that the two other points are non-issues for that
30 * particular descriptor type.
33 #ifndef _UAPI__LINUX_USB_CH9_H
34 #define _UAPI__LINUX_USB_CH9_H
36 #include <linux/types.h> /* __u8 etc */
37 #include <asm/byteorder.h> /* le16_to_cpu */
39 /*-------------------------------------------------------------------------*/
41 /* CONTROL REQUEST SUPPORT */
46 * This bit flag is used in endpoint descriptors' bEndpointAddress field.
47 * It's also one of three fields in control requests bRequestType.
49 #define USB_DIR_OUT 0 /* to device */
50 #define USB_DIR_IN 0x80 /* to host */
53 * USB types, the second of three bRequestType fields
55 #define USB_TYPE_MASK (0x03 << 5)
56 #define USB_TYPE_STANDARD (0x00 << 5)
57 #define USB_TYPE_CLASS (0x01 << 5)
58 #define USB_TYPE_VENDOR (0x02 << 5)
59 #define USB_TYPE_RESERVED (0x03 << 5)
62 * USB recipients, the third of three bRequestType fields
64 #define USB_RECIP_MASK 0x1f
65 #define USB_RECIP_DEVICE 0x00
66 #define USB_RECIP_INTERFACE 0x01
67 #define USB_RECIP_ENDPOINT 0x02
68 #define USB_RECIP_OTHER 0x03
69 /* From Wireless USB 1.0 */
70 #define USB_RECIP_PORT 0x04
71 #define USB_RECIP_RPIPE 0x05
74 * Standard requests, for the bRequest field of a SETUP packet.
76 * These are qualified by the bRequestType field, so that for example
77 * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved
78 * by a GET_STATUS request.
80 #define USB_REQ_GET_STATUS 0x00
81 #define USB_REQ_CLEAR_FEATURE 0x01
82 #define USB_REQ_SET_FEATURE 0x03
83 #define USB_REQ_SET_ADDRESS 0x05
84 #define USB_REQ_GET_DESCRIPTOR 0x06
85 #define USB_REQ_SET_DESCRIPTOR 0x07
86 #define USB_REQ_GET_CONFIGURATION 0x08
87 #define USB_REQ_SET_CONFIGURATION 0x09
88 #define USB_REQ_GET_INTERFACE 0x0A
89 #define USB_REQ_SET_INTERFACE 0x0B
90 #define USB_REQ_SYNCH_FRAME 0x0C
91 #define USB_REQ_SET_SEL 0x30
92 #define USB_REQ_SET_ISOCH_DELAY 0x31
94 #define USB_REQ_SET_ENCRYPTION 0x0D /* Wireless USB */
95 #define USB_REQ_GET_ENCRYPTION 0x0E
96 #define USB_REQ_RPIPE_ABORT 0x0E
97 #define USB_REQ_SET_HANDSHAKE 0x0F
98 #define USB_REQ_RPIPE_RESET 0x0F
99 #define USB_REQ_GET_HANDSHAKE 0x10
100 #define USB_REQ_SET_CONNECTION 0x11
101 #define USB_REQ_SET_SECURITY_DATA 0x12
102 #define USB_REQ_GET_SECURITY_DATA 0x13
103 #define USB_REQ_SET_WUSB_DATA 0x14
104 #define USB_REQ_LOOPBACK_DATA_WRITE 0x15
105 #define USB_REQ_LOOPBACK_DATA_READ 0x16
106 #define USB_REQ_SET_INTERFACE_DS 0x17
108 /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command,
109 * used by hubs to put ports into a new L1 suspend state, except that it
110 * forgot to define its number ...
114 * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and
115 * are read as a bit array returned by USB_REQ_GET_STATUS. (So there
116 * are at most sixteen features of each type.) Hubs may also support a
117 * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend.
119 #define USB_DEVICE_SELF_POWERED 0 /* (read only) */
120 #define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */
121 #define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */
122 #define USB_DEVICE_BATTERY 2 /* (wireless) */
123 #define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */
124 #define USB_DEVICE_WUSB_DEVICE 3 /* (wireless)*/
125 #define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */
126 #define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */
127 #define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */
130 * Test Mode Selectors
131 * See USB 2.0 spec Table 9-7
135 #define TEST_SE0_NAK 3
136 #define TEST_PACKET 4
137 #define TEST_FORCE_EN 5
140 * New Feature Selectors as added by USB 3.0
141 * See USB 3.0 spec Table 9-7
143 #define USB_DEVICE_U1_ENABLE 48 /* dev may initiate U1 transition */
144 #define USB_DEVICE_U2_ENABLE 49 /* dev may initiate U2 transition */
145 #define USB_DEVICE_LTM_ENABLE 50 /* dev may send LTM */
146 #define USB_INTRF_FUNC_SUSPEND 0 /* function suspend */
148 #define USB_INTR_FUNC_SUSPEND_OPT_MASK 0xFF00
150 * Suspend Options, Table 9-8 USB 3.0 spec
152 #define USB_INTRF_FUNC_SUSPEND_LP (1 << (8 + 0))
153 #define USB_INTRF_FUNC_SUSPEND_RW (1 << (8 + 1))
156 * Interface status, Figure 9-5 USB 3.0 spec
158 #define USB_INTRF_STAT_FUNC_RW_CAP 1
159 #define USB_INTRF_STAT_FUNC_RW 2
161 #define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */
163 /* Bit array elements as returned by the USB_REQ_GET_STATUS request. */
164 #define USB_DEV_STAT_U1_ENABLED 2 /* transition into U1 state */
165 #define USB_DEV_STAT_U2_ENABLED 3 /* transition into U2 state */
166 #define USB_DEV_STAT_LTM_ENABLED 4 /* Latency tolerance messages */
169 * struct usb_ctrlrequest - SETUP data for a USB device control request
170 * @bRequestType: matches the USB bmRequestType field
171 * @bRequest: matches the USB bRequest field
172 * @wValue: matches the USB wValue field (le16 byte order)
173 * @wIndex: matches the USB wIndex field (le16 byte order)
174 * @wLength: matches the USB wLength field (le16 byte order)
176 * This structure is used to send control requests to a USB device. It matches
177 * the different fields of the USB 2.0 Spec section 9.3, table 9-2. See the
178 * USB spec for a fuller description of the different fields, and what they are
181 * Note that the driver for any interface can issue control requests.
182 * For most devices, interfaces don't coordinate with each other, so
183 * such requests may be made at any time.
185 struct usb_ctrlrequest {
191 } __attribute__ ((packed));
193 /*-------------------------------------------------------------------------*/
196 * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
197 * (rarely) accepted by SET_DESCRIPTOR.
199 * Note that all multi-byte values here are encoded in little endian
200 * byte order "on the wire". Within the kernel and when exposed
201 * through the Linux-USB APIs, they are not converted to cpu byte
202 * order; it is the responsibility of the client code to do this.
203 * The single exception is when device and configuration descriptors (but
204 * not other descriptors) are read from usbfs (i.e. /proc/bus/usb/BBB/DDD);
205 * in this case the fields are converted to host endianness by the kernel.
209 * Descriptor types ... USB 2.0 spec table 9.5
211 #define USB_DT_DEVICE 0x01
212 #define USB_DT_CONFIG 0x02
213 #define USB_DT_STRING 0x03
214 #define USB_DT_INTERFACE 0x04
215 #define USB_DT_ENDPOINT 0x05
216 #define USB_DT_DEVICE_QUALIFIER 0x06
217 #define USB_DT_OTHER_SPEED_CONFIG 0x07
218 #define USB_DT_INTERFACE_POWER 0x08
219 /* these are from a minor usb 2.0 revision (ECN) */
220 #define USB_DT_OTG 0x09
221 #define USB_DT_DEBUG 0x0a
222 #define USB_DT_INTERFACE_ASSOCIATION 0x0b
223 /* these are from the Wireless USB spec */
224 #define USB_DT_SECURITY 0x0c
225 #define USB_DT_KEY 0x0d
226 #define USB_DT_ENCRYPTION_TYPE 0x0e
227 #define USB_DT_BOS 0x0f
228 #define USB_DT_DEVICE_CAPABILITY 0x10
229 #define USB_DT_WIRELESS_ENDPOINT_COMP 0x11
230 #define USB_DT_WIRE_ADAPTER 0x21
231 #define USB_DT_RPIPE 0x22
232 #define USB_DT_CS_RADIO_CONTROL 0x23
233 /* From the T10 UAS specification */
234 #define USB_DT_PIPE_USAGE 0x24
235 /* From the USB 3.0 spec */
236 #define USB_DT_SS_ENDPOINT_COMP 0x30
238 /* Conventional codes for class-specific descriptors. The convention is
239 * defined in the USB "Common Class" Spec (3.11). Individual class specs
240 * are authoritative for their usage, not the "common class" writeup.
242 #define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE)
243 #define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG)
244 #define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING)
245 #define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE)
246 #define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT)
248 /* All standard descriptors have these 2 fields at the beginning */
249 struct usb_descriptor_header {
251 __u8 bDescriptorType;
252 } __attribute__ ((packed));
255 /*-------------------------------------------------------------------------*/
257 /* USB_DT_DEVICE: Device descriptor */
258 struct usb_device_descriptor {
260 __u8 bDescriptorType;
264 __u8 bDeviceSubClass;
265 __u8 bDeviceProtocol;
266 __u8 bMaxPacketSize0;
273 __u8 bNumConfigurations;
274 } __attribute__ ((packed));
276 #define USB_DT_DEVICE_SIZE 18
280 * Device and/or Interface Class codes
281 * as found in bDeviceClass or bInterfaceClass
282 * and defined by www.usb.org documents
284 #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
285 #define USB_CLASS_AUDIO 1
286 #define USB_CLASS_COMM 2
287 #define USB_CLASS_HID 3
288 #define USB_CLASS_PHYSICAL 5
289 #define USB_CLASS_STILL_IMAGE 6
290 #define USB_CLASS_PRINTER 7
291 #define USB_CLASS_MASS_STORAGE 8
292 #define USB_CLASS_HUB 9
293 #define USB_CLASS_CDC_DATA 0x0a
294 #define USB_CLASS_CSCID 0x0b /* chip+ smart card */
295 #define USB_CLASS_CONTENT_SEC 0x0d /* content security */
296 #define USB_CLASS_VIDEO 0x0e
297 #define USB_CLASS_WIRELESS_CONTROLLER 0xe0
298 #define USB_CLASS_MISC 0xef
299 #define USB_CLASS_APP_SPEC 0xfe
300 #define USB_CLASS_VENDOR_SPEC 0xff
302 #define USB_SUBCLASS_VENDOR_SPEC 0xff
304 /*-------------------------------------------------------------------------*/
306 /* USB_DT_CONFIG: Configuration descriptor information.
308 * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
309 * descriptor type is different. Highspeed-capable devices can look
310 * different depending on what speed they're currently running. Only
311 * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
314 struct usb_config_descriptor {
316 __u8 bDescriptorType;
320 __u8 bConfigurationValue;
324 } __attribute__ ((packed));
326 #define USB_DT_CONFIG_SIZE 9
328 /* from config descriptor bmAttributes */
329 #define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */
330 #define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */
331 #define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */
332 #define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */
334 /*-------------------------------------------------------------------------*/
336 /* USB String descriptors can contain at most 126 characters. */
337 #define USB_MAX_STRING_LEN 126
339 /* USB_DT_STRING: String descriptor */
340 struct usb_string_descriptor {
342 __u8 bDescriptorType;
344 __le16 wData[1]; /* UTF-16LE encoded */
345 } __attribute__ ((packed));
347 /* note that "string" zero is special, it holds language codes that
348 * the device supports, not Unicode characters.
351 /*-------------------------------------------------------------------------*/
353 /* USB_DT_INTERFACE: Interface descriptor */
354 struct usb_interface_descriptor {
356 __u8 bDescriptorType;
358 __u8 bInterfaceNumber;
359 __u8 bAlternateSetting;
361 __u8 bInterfaceClass;
362 __u8 bInterfaceSubClass;
363 __u8 bInterfaceProtocol;
365 } __attribute__ ((packed));
367 #define USB_DT_INTERFACE_SIZE 9
369 /*-------------------------------------------------------------------------*/
371 /* USB_DT_ENDPOINT: Endpoint descriptor */
372 struct usb_endpoint_descriptor {
374 __u8 bDescriptorType;
376 __u8 bEndpointAddress;
378 __le16 wMaxPacketSize;
381 /* NOTE: these two are _only_ in audio endpoints. */
382 /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
385 } __attribute__ ((packed));
387 #define USB_DT_ENDPOINT_SIZE 7
388 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
394 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
395 #define USB_ENDPOINT_DIR_MASK 0x80
397 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
398 #define USB_ENDPOINT_XFER_CONTROL 0
399 #define USB_ENDPOINT_XFER_ISOC 1
400 #define USB_ENDPOINT_XFER_BULK 2
401 #define USB_ENDPOINT_XFER_INT 3
402 #define USB_ENDPOINT_MAX_ADJUSTABLE 0x80
404 /* The USB 3.0 spec redefines bits 5:4 of bmAttributes as interrupt ep type. */
405 #define USB_ENDPOINT_INTRTYPE 0x30
406 #define USB_ENDPOINT_INTR_PERIODIC (0 << 4)
407 #define USB_ENDPOINT_INTR_NOTIFICATION (1 << 4)
409 #define USB_ENDPOINT_SYNCTYPE 0x0c
410 #define USB_ENDPOINT_SYNC_NONE (0 << 2)
411 #define USB_ENDPOINT_SYNC_ASYNC (1 << 2)
412 #define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2)
413 #define USB_ENDPOINT_SYNC_SYNC (3 << 2)
415 #define USB_ENDPOINT_USAGE_MASK 0x30
416 #define USB_ENDPOINT_USAGE_DATA 0x00
417 #define USB_ENDPOINT_USAGE_FEEDBACK 0x10
418 #define USB_ENDPOINT_USAGE_IMPLICIT_FB 0x20 /* Implicit feedback Data endpoint */
420 /*-------------------------------------------------------------------------*/
423 * usb_endpoint_num - get the endpoint's number
424 * @epd: endpoint to be checked
426 * Returns @epd's number: 0 to 15.
428 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
430 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
434 * usb_endpoint_type - get the endpoint's transfer type
435 * @epd: endpoint to be checked
437 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
438 * to @epd's transfer type.
440 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
442 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
446 * usb_endpoint_dir_in - check if the endpoint has IN direction
447 * @epd: endpoint to be checked
449 * Returns true if the endpoint is of type IN, otherwise it returns false.
451 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
453 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
457 * usb_endpoint_dir_out - check if the endpoint has OUT direction
458 * @epd: endpoint to be checked
460 * Returns true if the endpoint is of type OUT, otherwise it returns false.
462 static inline int usb_endpoint_dir_out(
463 const struct usb_endpoint_descriptor *epd)
465 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
469 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
470 * @epd: endpoint to be checked
472 * Returns true if the endpoint is of type bulk, otherwise it returns false.
474 static inline int usb_endpoint_xfer_bulk(
475 const struct usb_endpoint_descriptor *epd)
477 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
478 USB_ENDPOINT_XFER_BULK);
482 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
483 * @epd: endpoint to be checked
485 * Returns true if the endpoint is of type control, otherwise it returns false.
487 static inline int usb_endpoint_xfer_control(
488 const struct usb_endpoint_descriptor *epd)
490 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
491 USB_ENDPOINT_XFER_CONTROL);
495 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
496 * @epd: endpoint to be checked
498 * Returns true if the endpoint is of type interrupt, otherwise it returns
501 static inline int usb_endpoint_xfer_int(
502 const struct usb_endpoint_descriptor *epd)
504 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
505 USB_ENDPOINT_XFER_INT);
509 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
510 * @epd: endpoint to be checked
512 * Returns true if the endpoint is of type isochronous, otherwise it returns
515 static inline int usb_endpoint_xfer_isoc(
516 const struct usb_endpoint_descriptor *epd)
518 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
519 USB_ENDPOINT_XFER_ISOC);
523 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
524 * @epd: endpoint to be checked
526 * Returns true if the endpoint has bulk transfer type and IN direction,
527 * otherwise it returns false.
529 static inline int usb_endpoint_is_bulk_in(
530 const struct usb_endpoint_descriptor *epd)
532 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
536 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
537 * @epd: endpoint to be checked
539 * Returns true if the endpoint has bulk transfer type and OUT direction,
540 * otherwise it returns false.
542 static inline int usb_endpoint_is_bulk_out(
543 const struct usb_endpoint_descriptor *epd)
545 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
549 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
550 * @epd: endpoint to be checked
552 * Returns true if the endpoint has interrupt transfer type and IN direction,
553 * otherwise it returns false.
555 static inline int usb_endpoint_is_int_in(
556 const struct usb_endpoint_descriptor *epd)
558 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
562 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
563 * @epd: endpoint to be checked
565 * Returns true if the endpoint has interrupt transfer type and OUT direction,
566 * otherwise it returns false.
568 static inline int usb_endpoint_is_int_out(
569 const struct usb_endpoint_descriptor *epd)
571 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
575 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
576 * @epd: endpoint to be checked
578 * Returns true if the endpoint has isochronous transfer type and IN direction,
579 * otherwise it returns false.
581 static inline int usb_endpoint_is_isoc_in(
582 const struct usb_endpoint_descriptor *epd)
584 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
588 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
589 * @epd: endpoint to be checked
591 * Returns true if the endpoint has isochronous transfer type and OUT direction,
592 * otherwise it returns false.
594 static inline int usb_endpoint_is_isoc_out(
595 const struct usb_endpoint_descriptor *epd)
597 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
601 * usb_endpoint_maxp - get endpoint's max packet size
602 * @epd: endpoint to be checked
604 * Returns @epd's max packet
606 static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd)
608 return __le16_to_cpu(epd->wMaxPacketSize);
611 static inline int usb_endpoint_interrupt_type(
612 const struct usb_endpoint_descriptor *epd)
614 return epd->bmAttributes & USB_ENDPOINT_INTRTYPE;
617 /*-------------------------------------------------------------------------*/
619 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
620 struct usb_ss_ep_comp_descriptor {
622 __u8 bDescriptorType;
626 __le16 wBytesPerInterval;
627 } __attribute__ ((packed));
629 #define USB_DT_SS_EP_COMP_SIZE 6
631 /* Bits 4:0 of bmAttributes if this is a bulk endpoint */
633 usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor *comp)
640 max_streams = comp->bmAttributes & 0x1f;
645 max_streams = 1 << max_streams;
650 /* Bits 1:0 of bmAttributes if this is an isoc endpoint */
651 #define USB_SS_MULT(p) (1 + ((p) & 0x3))
653 /*-------------------------------------------------------------------------*/
655 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
656 struct usb_qualifier_descriptor {
658 __u8 bDescriptorType;
662 __u8 bDeviceSubClass;
663 __u8 bDeviceProtocol;
664 __u8 bMaxPacketSize0;
665 __u8 bNumConfigurations;
667 } __attribute__ ((packed));
670 /*-------------------------------------------------------------------------*/
672 /* USB_DT_OTG (from OTG 1.0a supplement) */
673 struct usb_otg_descriptor {
675 __u8 bDescriptorType;
677 __u8 bmAttributes; /* support for HNP, SRP, etc */
678 } __attribute__ ((packed));
680 /* USB_DT_OTG (from OTG 2.0 supplement) */
681 struct usb_otg20_descriptor {
683 __u8 bDescriptorType;
685 __u8 bmAttributes; /* support for HNP, SRP and ADP, etc */
686 __le16 bcdOTG; /* OTG and EH supplement release number
687 * in binary-coded decimal(i.e. 2.0 is 0200H)
689 } __attribute__ ((packed));
691 /* from usb_otg_descriptor.bmAttributes */
692 #define USB_OTG_SRP (1 << 0)
693 #define USB_OTG_HNP (1 << 1) /* swap host/device roles */
694 #define USB_OTG_ADP (1 << 2) /* support ADP */
696 /*-------------------------------------------------------------------------*/
698 /* USB_DT_DEBUG: for special highspeed devices, replacing serial console */
699 struct usb_debug_descriptor {
701 __u8 bDescriptorType;
703 /* bulk endpoints with 8 byte maxpacket */
704 __u8 bDebugInEndpoint;
705 __u8 bDebugOutEndpoint;
706 } __attribute__((packed));
708 /*-------------------------------------------------------------------------*/
710 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
711 struct usb_interface_assoc_descriptor {
713 __u8 bDescriptorType;
715 __u8 bFirstInterface;
716 __u8 bInterfaceCount;
718 __u8 bFunctionSubClass;
719 __u8 bFunctionProtocol;
721 } __attribute__ ((packed));
723 #define USB_DT_INTERFACE_ASSOCIATION_SIZE 8
725 /*-------------------------------------------------------------------------*/
727 /* USB_DT_SECURITY: group of wireless security descriptors, including
728 * encryption types available for setting up a CC/association.
730 struct usb_security_descriptor {
732 __u8 bDescriptorType;
735 __u8 bNumEncryptionTypes;
736 } __attribute__((packed));
738 /*-------------------------------------------------------------------------*/
740 /* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys
743 struct usb_key_descriptor {
745 __u8 bDescriptorType;
750 } __attribute__((packed));
752 /*-------------------------------------------------------------------------*/
754 /* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */
755 struct usb_encryption_descriptor {
757 __u8 bDescriptorType;
759 __u8 bEncryptionType;
760 #define USB_ENC_TYPE_UNSECURE 0
761 #define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */
762 #define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */
763 #define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */
764 __u8 bEncryptionValue; /* use in SET_ENCRYPTION */
766 } __attribute__((packed));
769 /*-------------------------------------------------------------------------*/
771 /* USB_DT_BOS: group of device-level capabilities */
772 struct usb_bos_descriptor {
774 __u8 bDescriptorType;
778 } __attribute__((packed));
780 #define USB_DT_BOS_SIZE 5
781 /*-------------------------------------------------------------------------*/
783 /* USB_DT_DEVICE_CAPABILITY: grouped with BOS */
784 struct usb_dev_cap_header {
786 __u8 bDescriptorType;
787 __u8 bDevCapabilityType;
788 } __attribute__((packed));
790 #define USB_CAP_TYPE_WIRELESS_USB 1
792 struct usb_wireless_cap_descriptor { /* Ultra Wide Band */
794 __u8 bDescriptorType;
795 __u8 bDevCapabilityType;
798 #define USB_WIRELESS_P2P_DRD (1 << 1)
799 #define USB_WIRELESS_BEACON_MASK (3 << 2)
800 #define USB_WIRELESS_BEACON_SELF (1 << 2)
801 #define USB_WIRELESS_BEACON_DIRECTED (2 << 2)
802 #define USB_WIRELESS_BEACON_NONE (3 << 2)
803 __le16 wPHYRates; /* bit rates, Mbps */
804 #define USB_WIRELESS_PHY_53 (1 << 0) /* always set */
805 #define USB_WIRELESS_PHY_80 (1 << 1)
806 #define USB_WIRELESS_PHY_107 (1 << 2) /* always set */
807 #define USB_WIRELESS_PHY_160 (1 << 3)
808 #define USB_WIRELESS_PHY_200 (1 << 4) /* always set */
809 #define USB_WIRELESS_PHY_320 (1 << 5)
810 #define USB_WIRELESS_PHY_400 (1 << 6)
811 #define USB_WIRELESS_PHY_480 (1 << 7)
812 __u8 bmTFITXPowerInfo; /* TFI power levels */
813 __u8 bmFFITXPowerInfo; /* FFI power levels */
816 } __attribute__((packed));
818 #define USB_DT_USB_WIRELESS_CAP_SIZE 11
820 /* USB 2.0 Extension descriptor */
821 #define USB_CAP_TYPE_EXT 2
823 struct usb_ext_cap_descriptor { /* Link Power Management */
825 __u8 bDescriptorType;
826 __u8 bDevCapabilityType;
828 #define USB_LPM_SUPPORT (1 << 1) /* supports LPM */
829 #define USB_BESL_SUPPORT (1 << 2) /* supports BESL */
830 #define USB_BESL_BASELINE_VALID (1 << 3) /* Baseline BESL valid*/
831 #define USB_BESL_DEEP_VALID (1 << 4) /* Deep BESL valid */
832 #define USB_GET_BESL_BASELINE(p) (((p) & (0xf << 8)) >> 8)
833 #define USB_GET_BESL_DEEP(p) (((p) & (0xf << 12)) >> 12)
834 } __attribute__((packed));
836 #define USB_DT_USB_EXT_CAP_SIZE 7
839 * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
840 * specific device level capabilities
842 #define USB_SS_CAP_TYPE 3
843 struct usb_ss_cap_descriptor { /* Link Power Management */
845 __u8 bDescriptorType;
846 __u8 bDevCapabilityType;
848 #define USB_LTM_SUPPORT (1 << 1) /* supports LTM */
849 __le16 wSpeedSupported;
850 #define USB_LOW_SPEED_OPERATION (1) /* Low speed operation */
851 #define USB_FULL_SPEED_OPERATION (1 << 1) /* Full speed operation */
852 #define USB_HIGH_SPEED_OPERATION (1 << 2) /* High speed operation */
853 #define USB_5GBPS_OPERATION (1 << 3) /* Operation at 5Gbps */
854 __u8 bFunctionalitySupport;
856 __le16 bU2DevExitLat;
857 } __attribute__((packed));
859 #define USB_DT_USB_SS_CAP_SIZE 10
862 * Container ID Capability descriptor: Defines the instance unique ID used to
863 * identify the instance across all operating modes
865 #define CONTAINER_ID_TYPE 4
866 struct usb_ss_container_id_descriptor {
868 __u8 bDescriptorType;
869 __u8 bDevCapabilityType;
871 __u8 ContainerID[16]; /* 128-bit number */
872 } __attribute__((packed));
874 #define USB_DT_USB_SS_CONTN_ID_SIZE 20
877 * SuperSpeed Plus USB Capability descriptor: Defines the set of
878 * SuperSpeed Plus USB specific device level capabilities
880 #define USB_SSP_CAP_TYPE 0xa
881 struct usb_ssp_cap_descriptor {
883 __u8 bDescriptorType;
884 __u8 bDevCapabilityType;
887 #define USB_SSP_SUBLINK_SPEED_ATTRIBS (0x1f << 0) /* sublink speed entries */
888 #define USB_SSP_SUBLINK_SPEED_IDS (0xf << 5) /* speed ID entries */
889 __u16 wFunctionalitySupport;
890 #define USB_SSP_MIN_SUBLINK_SPEED_ATTRIBUTE_ID (0xf)
891 #define USB_SSP_MIN_RX_LANE_COUNT (0xf << 8)
892 #define USB_SSP_MIN_TX_LANE_COUNT (0xf << 12)
894 __le32 bmSublinkSpeedAttr[1]; /* list of sublink speed attrib entries */
895 #define USB_SSP_SUBLINK_SPEED_SSID (0xf) /* sublink speed ID */
896 #define USB_SSP_SUBLINK_SPEED_LSE (0x3 << 4) /* Lanespeed exponent */
897 #define USB_SSP_SUBLINK_SPEED_ST (0x3 << 6) /* Sublink type */
898 #define USB_SSP_SUBLINK_SPEED_RSVD (0x3f << 8) /* Reserved */
899 #define USB_SSP_SUBLINK_SPEED_LP (0x3 << 14) /* Link protocol */
900 #define USB_SSP_SUBLINK_SPEED_LSM (0xff << 16) /* Lanespeed mantissa */
901 } __attribute__((packed));
904 * Precision time measurement capability descriptor: advertised by devices and
905 * hubs that support PTM
907 #define USB_PTM_CAP_TYPE 0xb
908 struct usb_ptm_cap_descriptor {
910 __u8 bDescriptorType;
911 __u8 bDevCapabilityType;
912 } __attribute__((packed));
915 * The size of the descriptor for the Sublink Speed Attribute Count
916 * (SSAC) specified in bmAttributes[4:0].
918 #define USB_DT_USB_SSP_CAP_SIZE(ssac) (16 + ssac * 4)
920 /*-------------------------------------------------------------------------*/
922 /* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with
923 * each endpoint descriptor for a wireless device
925 struct usb_wireless_ep_comp_descriptor {
927 __u8 bDescriptorType;
931 __le16 wMaxStreamDelay;
932 __le16 wOverTheAirPacketSize;
933 __u8 bOverTheAirInterval;
934 __u8 bmCompAttributes;
935 #define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */
936 #define USB_ENDPOINT_SWITCH_NO 0
937 #define USB_ENDPOINT_SWITCH_SWITCH 1
938 #define USB_ENDPOINT_SWITCH_SCALE 2
939 } __attribute__((packed));
941 /*-------------------------------------------------------------------------*/
943 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
944 * host and a device for connection set up, mutual authentication, and
945 * exchanging short lived session keys. The handshake depends on a CC.
947 struct usb_handshake {
955 } __attribute__((packed));
957 /*-------------------------------------------------------------------------*/
959 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
960 * A CC may also be set up using non-wireless secure channels (including
961 * wired USB!), and some devices may support CCs with multiple hosts.
963 struct usb_connection_context {
964 __u8 CHID[16]; /* persistent host id */
965 __u8 CDID[16]; /* device id (unique w/in host context) */
966 __u8 CK[16]; /* connection key */
967 } __attribute__((packed));
969 /*-------------------------------------------------------------------------*/
971 /* USB 2.0 defines three speeds, here's how Linux identifies them */
973 enum usb_device_speed {
974 USB_SPEED_UNKNOWN = 0, /* enumerating */
975 USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */
976 USB_SPEED_HIGH, /* usb 2.0 */
977 USB_SPEED_WIRELESS, /* wireless (usb 2.5) */
978 USB_SPEED_SUPER, /* usb 3.0 */
979 USB_SPEED_SUPER_PLUS, /* usb 3.1 */
983 enum usb_device_state {
984 /* NOTATTACHED isn't in the USB spec, and this state acts
985 * the same as ATTACHED ... but it's clearer this way.
987 USB_STATE_NOTATTACHED = 0,
989 /* chapter 9 and authentication (wireless) device states */
991 USB_STATE_POWERED, /* wired */
992 USB_STATE_RECONNECTING, /* auth */
993 USB_STATE_UNAUTHENTICATED, /* auth */
994 USB_STATE_DEFAULT, /* limited function */
996 USB_STATE_CONFIGURED, /* most functions */
1000 /* NOTE: there are actually four different SUSPENDED
1001 * states, returning to POWERED, DEFAULT, ADDRESS, or
1002 * CONFIGURED respectively when SOF tokens flow again.
1003 * At this level there's no difference between L1 and L2
1004 * suspend states. (L2 being original USB 1.1 suspend.)
1008 enum usb3_link_state {
1015 #define USB_DT_USB_PTM_ID_SIZE 3
1017 * A U1 timeout of 0x0 means the parent hub will reject any transitions to U1.
1018 * 0xff means the parent hub will accept transitions to U1, but will not
1019 * initiate a transition.
1021 * A U1 timeout of 0x1 to 0x7F also causes the hub to initiate a transition to
1022 * U1 after that many microseconds. Timeouts of 0x80 to 0xFE are reserved
1025 * A U2 timeout of 0x0 means the parent hub will reject any transitions to U2.
1026 * 0xff means the parent hub will accept transitions to U2, but will not
1027 * initiate a transition.
1029 * A U2 timeout of 0x1 to 0xFE also causes the hub to initiate a transition to
1030 * U2 after N*256 microseconds. Therefore a U2 timeout value of 0x1 means a U2
1031 * idle timer of 256 microseconds, 0x2 means 512 microseconds, 0xFE means
1034 #define USB3_LPM_DISABLED 0x0
1035 #define USB3_LPM_U1_MAX_TIMEOUT 0x7F
1036 #define USB3_LPM_U2_MAX_TIMEOUT 0xFE
1037 #define USB3_LPM_DEVICE_INITIATED 0xFF
1039 struct usb_set_sel_req {
1044 } __attribute__ ((packed));
1047 * The Set System Exit Latency control transfer provides one byte each for
1048 * U1 SEL and U1 PEL, so the max exit latency is 0xFF. U2 SEL and U2 PEL each
1049 * are two bytes long.
1051 #define USB3_LPM_MAX_U1_SEL_PEL 0xFF
1052 #define USB3_LPM_MAX_U2_SEL_PEL 0xFFFF
1054 /*-------------------------------------------------------------------------*/
1057 * As per USB compliance update, a device that is actively drawing
1058 * more than 100mA from USB must report itself as bus-powered in
1059 * the GetStatus(DEVICE) call.
1060 * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34
1062 #define USB_SELF_POWER_VBUS_MAX_DRAW 100
1064 #endif /* _UAPI__LINUX_USB_CH9_H */