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 __LINUX_USB_CH9_H
34 #define __LINUX_USB_CH9_H
36 #include <linux/types.h> /* __u8 etc */
37 #include <asm/byteorder.h> /* le16_to_cpu */
38 #include <asm/unaligned.h> /* get_unaligned() */
40 /*-------------------------------------------------------------------------*/
42 /* CONTROL REQUEST SUPPORT */
47 * This bit flag is used in endpoint descriptors' bEndpointAddress field.
48 * It's also one of three fields in control requests bRequestType.
50 #define USB_DIR_OUT 0 /* to device */
51 #define USB_DIR_IN 0x80 /* to host */
54 * USB types, the second of three bRequestType fields
56 #define USB_TYPE_MASK (0x03 << 5)
57 #define USB_TYPE_STANDARD (0x00 << 5)
58 #define USB_TYPE_CLASS (0x01 << 5)
59 #define USB_TYPE_VENDOR (0x02 << 5)
60 #define USB_TYPE_RESERVED (0x03 << 5)
63 * USB recipients, the third of three bRequestType fields
65 #define USB_RECIP_MASK 0x1f
66 #define USB_RECIP_DEVICE 0x00
67 #define USB_RECIP_INTERFACE 0x01
68 #define USB_RECIP_ENDPOINT 0x02
69 #define USB_RECIP_OTHER 0x03
70 /* From Wireless USB 1.0 */
71 #define USB_RECIP_PORT 0x04
72 #define USB_RECIP_RPIPE 0x05
75 * Standard requests, for the bRequest field of a SETUP packet.
77 * These are qualified by the bRequestType field, so that for example
78 * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved
79 * by a GET_STATUS request.
81 #define USB_REQ_GET_STATUS 0x00
82 #define USB_REQ_CLEAR_FEATURE 0x01
83 #define USB_REQ_SET_FEATURE 0x03
84 #define USB_REQ_SET_ADDRESS 0x05
85 #define USB_REQ_GET_DESCRIPTOR 0x06
86 #define USB_REQ_SET_DESCRIPTOR 0x07
87 #define USB_REQ_GET_CONFIGURATION 0x08
88 #define USB_REQ_SET_CONFIGURATION 0x09
89 #define USB_REQ_GET_INTERFACE 0x0A
90 #define USB_REQ_SET_INTERFACE 0x0B
91 #define USB_REQ_SYNCH_FRAME 0x0C
92 #define USB_REQ_SET_SEL 0x30
93 #define USB_REQ_SET_ISOCH_DELAY 0x31
95 #define USB_REQ_SET_ENCRYPTION 0x0D /* Wireless USB */
96 #define USB_REQ_GET_ENCRYPTION 0x0E
97 #define USB_REQ_RPIPE_ABORT 0x0E
98 #define USB_REQ_SET_HANDSHAKE 0x0F
99 #define USB_REQ_RPIPE_RESET 0x0F
100 #define USB_REQ_GET_HANDSHAKE 0x10
101 #define USB_REQ_SET_CONNECTION 0x11
102 #define USB_REQ_SET_SECURITY_DATA 0x12
103 #define USB_REQ_GET_SECURITY_DATA 0x13
104 #define USB_REQ_SET_WUSB_DATA 0x14
105 #define USB_REQ_LOOPBACK_DATA_WRITE 0x15
106 #define USB_REQ_LOOPBACK_DATA_READ 0x16
107 #define USB_REQ_SET_INTERFACE_DS 0x17
109 /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command,
110 * used by hubs to put ports into a new L1 suspend state, except that it
111 * forgot to define its number ...
115 * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and
116 * are read as a bit array returned by USB_REQ_GET_STATUS. (So there
117 * are at most sixteen features of each type.) Hubs may also support a
118 * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend.
120 #define USB_DEVICE_SELF_POWERED 0 /* (read only) */
121 #define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */
122 #define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */
123 #define USB_DEVICE_BATTERY 2 /* (wireless) */
124 #define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */
125 #define USB_DEVICE_WUSB_DEVICE 3 /* (wireless)*/
126 #define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */
127 #define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */
128 #define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */
131 * Test Mode Selectors
132 * See USB 2.0 spec Table 9-7
136 #define TEST_SE0_NAK 3
137 #define TEST_PACKET 4
138 #define TEST_FORCE_EN 5
141 * New Feature Selectors as added by USB 3.0
142 * See USB 3.0 spec Table 9-6
144 #define USB_DEVICE_U1_ENABLE 48 /* dev may initiate U1 transition */
145 #define USB_DEVICE_U2_ENABLE 49 /* dev may initiate U2 transition */
146 #define USB_DEVICE_LTM_ENABLE 50 /* dev may send LTM */
147 #define USB_INTRF_FUNC_SUSPEND 0 /* function suspend */
149 #define USB_INTR_FUNC_SUSPEND_OPT_MASK 0xFF00
151 * Suspend Options, Table 9-7 USB 3.0 spec
153 #define USB_INTRF_FUNC_SUSPEND_LP (1 << (8 + 0))
154 #define USB_INTRF_FUNC_SUSPEND_RW (1 << (8 + 1))
156 #define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */
158 /* Bit array elements as returned by the USB_REQ_GET_STATUS request. */
159 #define USB_DEV_STAT_U1_ENABLED 2 /* transition into U1 state */
160 #define USB_DEV_STAT_U2_ENABLED 3 /* transition into U2 state */
161 #define USB_DEV_STAT_LTM_ENABLED 4 /* Latency tolerance messages */
164 * struct usb_ctrlrequest - SETUP data for a USB device control request
165 * @bRequestType: matches the USB bmRequestType field
166 * @bRequest: matches the USB bRequest field
167 * @wValue: matches the USB wValue field (le16 byte order)
168 * @wIndex: matches the USB wIndex field (le16 byte order)
169 * @wLength: matches the USB wLength field (le16 byte order)
171 * This structure is used to send control requests to a USB device. It matches
172 * the different fields of the USB 2.0 Spec section 9.3, table 9-2. See the
173 * USB spec for a fuller description of the different fields, and what they are
176 * Note that the driver for any interface can issue control requests.
177 * For most devices, interfaces don't coordinate with each other, so
178 * such requests may be made at any time.
180 struct usb_ctrlrequest {
186 } __attribute__ ((packed));
188 /*-------------------------------------------------------------------------*/
191 * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
192 * (rarely) accepted by SET_DESCRIPTOR.
194 * Note that all multi-byte values here are encoded in little endian
195 * byte order "on the wire". Within the kernel and when exposed
196 * through the Linux-USB APIs, they are not converted to cpu byte
197 * order; it is the responsibility of the client code to do this.
198 * The single exception is when device and configuration descriptors (but
199 * not other descriptors) are read from usbfs (i.e. /proc/bus/usb/BBB/DDD);
200 * in this case the fields are converted to host endianness by the kernel.
204 * Descriptor types ... USB 2.0 spec table 9.5
206 #define USB_DT_DEVICE 0x01
207 #define USB_DT_CONFIG 0x02
208 #define USB_DT_STRING 0x03
209 #define USB_DT_INTERFACE 0x04
210 #define USB_DT_ENDPOINT 0x05
211 #define USB_DT_DEVICE_QUALIFIER 0x06
212 #define USB_DT_OTHER_SPEED_CONFIG 0x07
213 #define USB_DT_INTERFACE_POWER 0x08
214 /* these are from a minor usb 2.0 revision (ECN) */
215 #define USB_DT_OTG 0x09
216 #define USB_DT_DEBUG 0x0a
217 #define USB_DT_INTERFACE_ASSOCIATION 0x0b
218 /* these are from the Wireless USB spec */
219 #define USB_DT_SECURITY 0x0c
220 #define USB_DT_KEY 0x0d
221 #define USB_DT_ENCRYPTION_TYPE 0x0e
222 #define USB_DT_BOS 0x0f
223 #define USB_DT_DEVICE_CAPABILITY 0x10
224 #define USB_DT_WIRELESS_ENDPOINT_COMP 0x11
225 #define USB_DT_WIRE_ADAPTER 0x21
226 #define USB_DT_RPIPE 0x22
227 #define USB_DT_CS_RADIO_CONTROL 0x23
228 /* From the T10 UAS specification */
229 #define USB_DT_PIPE_USAGE 0x24
230 /* From the USB 3.0 spec */
231 #define USB_DT_SS_ENDPOINT_COMP 0x30
232 /* From HID 1.11 spec */
233 #define USB_DT_HID_REPORT 0x22
235 /* Conventional codes for class-specific descriptors. The convention is
236 * defined in the USB "Common Class" Spec (3.11). Individual class specs
237 * are authoritative for their usage, not the "common class" writeup.
239 #define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE)
240 #define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG)
241 #define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING)
242 #define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE)
243 #define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT)
245 /* All standard descriptors have these 2 fields at the beginning */
246 struct usb_descriptor_header {
248 __u8 bDescriptorType;
249 } __attribute__ ((packed));
252 /*-------------------------------------------------------------------------*/
254 /* USB_DT_DEVICE: Device descriptor */
255 struct usb_device_descriptor {
257 __u8 bDescriptorType;
261 __u8 bDeviceSubClass;
262 __u8 bDeviceProtocol;
263 __u8 bMaxPacketSize0;
270 __u8 bNumConfigurations;
271 } __attribute__ ((packed));
273 #define USB_DT_DEVICE_SIZE 18
277 * Device and/or Interface Class codes
278 * as found in bDeviceClass or bInterfaceClass
279 * and defined by www.usb.org documents
281 #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
282 #define USB_CLASS_AUDIO 1
283 #define USB_CLASS_COMM 2
284 #define USB_CLASS_HID 3
285 #define USB_CLASS_PHYSICAL 5
286 #define USB_CLASS_STILL_IMAGE 6
287 #define USB_CLASS_PRINTER 7
288 #define USB_CLASS_MASS_STORAGE 8
289 #define USB_CLASS_HUB 9
290 #define USB_CLASS_CDC_DATA 0x0a
291 #define USB_CLASS_CSCID 0x0b /* chip+ smart card */
292 #define USB_CLASS_CONTENT_SEC 0x0d /* content security */
293 #define USB_CLASS_VIDEO 0x0e
294 #define USB_CLASS_WIRELESS_CONTROLLER 0xe0
295 #define USB_CLASS_MISC 0xef
296 #define USB_CLASS_APP_SPEC 0xfe
297 #define USB_CLASS_VENDOR_SPEC 0xff
299 #define USB_SUBCLASS_VENDOR_SPEC 0xff
301 /*-------------------------------------------------------------------------*/
303 /* USB_DT_CONFIG: Configuration descriptor information.
305 * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
306 * descriptor type is different. Highspeed-capable devices can look
307 * different depending on what speed they're currently running. Only
308 * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
311 struct usb_config_descriptor {
313 __u8 bDescriptorType;
317 __u8 bConfigurationValue;
321 } __attribute__ ((packed));
323 #define USB_DT_CONFIG_SIZE 9
325 /* from config descriptor bmAttributes */
326 #define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */
327 #define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */
328 #define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */
329 #define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */
331 /*-------------------------------------------------------------------------*/
333 /* USB_DT_STRING: String descriptor */
334 struct usb_string_descriptor {
336 __u8 bDescriptorType;
338 __le16 wData[1]; /* UTF-16LE encoded */
339 } __attribute__ ((packed));
341 /* note that "string" zero is special, it holds language codes that
342 * the device supports, not Unicode characters.
345 /*-------------------------------------------------------------------------*/
347 /* USB_DT_INTERFACE: Interface descriptor */
348 struct usb_interface_descriptor {
350 __u8 bDescriptorType;
352 __u8 bInterfaceNumber;
353 __u8 bAlternateSetting;
355 __u8 bInterfaceClass;
356 __u8 bInterfaceSubClass;
357 __u8 bInterfaceProtocol;
359 } __attribute__ ((packed));
361 #define USB_DT_INTERFACE_SIZE 9
363 /*-------------------------------------------------------------------------*/
365 /* USB_DT_ENDPOINT: Endpoint descriptor */
366 struct usb_endpoint_descriptor {
368 __u8 bDescriptorType;
370 __u8 bEndpointAddress;
372 __le16 wMaxPacketSize;
375 /* NOTE: these two are _only_ in audio endpoints. */
376 /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
379 } __attribute__ ((packed));
381 #define USB_DT_ENDPOINT_SIZE 7
382 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
384 /* Used to access common fields */
385 struct usb_generic_descriptor {
387 __u8 bDescriptorType;
390 struct __packed usb_class_hid_descriptor {
395 u8 bNumDescriptors; /* 0x01 */
397 u16 wDescriptorLength0;
398 /* optional descriptors are not supported. */
401 struct __packed usb_class_report_descriptor {
402 u8 bLength; /* dummy */
411 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
412 #define USB_ENDPOINT_DIR_MASK 0x80
414 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
415 #define USB_ENDPOINT_XFER_CONTROL 0
416 #define USB_ENDPOINT_XFER_ISOC 1
417 #define USB_ENDPOINT_XFER_BULK 2
418 #define USB_ENDPOINT_XFER_INT 3
419 #define USB_ENDPOINT_MAX_ADJUSTABLE 0x80
421 /* The USB 3.0 spec redefines bits 5:4 of bmAttributes as interrupt ep type. */
422 #define USB_ENDPOINT_INTRTYPE 0x30
423 #define USB_ENDPOINT_INTR_PERIODIC (0 << 4)
424 #define USB_ENDPOINT_INTR_NOTIFICATION (1 << 4)
426 #define USB_ENDPOINT_SYNCTYPE 0x0c
427 #define USB_ENDPOINT_SYNC_NONE (0 << 2)
428 #define USB_ENDPOINT_SYNC_ASYNC (1 << 2)
429 #define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2)
430 #define USB_ENDPOINT_SYNC_SYNC (3 << 2)
432 #define USB_ENDPOINT_USAGE_MASK 0x30
433 #define USB_ENDPOINT_USAGE_DATA 0x00
434 #define USB_ENDPOINT_USAGE_FEEDBACK 0x10
435 #define USB_ENDPOINT_USAGE_IMPLICIT_FB 0x20 /* Implicit feedback Data endpoint */
437 /*-------------------------------------------------------------------------*/
440 * usb_endpoint_num - get the endpoint's number
441 * @epd: endpoint to be checked
443 * Returns @epd's number: 0 to 15.
445 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
447 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
451 * usb_endpoint_type - get the endpoint's transfer type
452 * @epd: endpoint to be checked
454 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
455 * to @epd's transfer type.
457 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
459 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
463 * usb_endpoint_dir_in - check if the endpoint has IN direction
464 * @epd: endpoint to be checked
466 * Returns true if the endpoint is of type IN, otherwise it returns false.
468 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
470 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
474 * usb_endpoint_dir_out - check if the endpoint has OUT direction
475 * @epd: endpoint to be checked
477 * Returns true if the endpoint is of type OUT, otherwise it returns false.
479 static inline int usb_endpoint_dir_out(
480 const struct usb_endpoint_descriptor *epd)
482 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
486 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
487 * @epd: endpoint to be checked
489 * Returns true if the endpoint is of type bulk, otherwise it returns false.
491 static inline int usb_endpoint_xfer_bulk(
492 const struct usb_endpoint_descriptor *epd)
494 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
495 USB_ENDPOINT_XFER_BULK);
499 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
500 * @epd: endpoint to be checked
502 * Returns true if the endpoint is of type control, otherwise it returns false.
504 static inline int usb_endpoint_xfer_control(
505 const struct usb_endpoint_descriptor *epd)
507 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
508 USB_ENDPOINT_XFER_CONTROL);
512 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
513 * @epd: endpoint to be checked
515 * Returns true if the endpoint is of type interrupt, otherwise it returns
518 static inline int usb_endpoint_xfer_int(
519 const struct usb_endpoint_descriptor *epd)
521 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
522 USB_ENDPOINT_XFER_INT);
526 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
527 * @epd: endpoint to be checked
529 * Returns true if the endpoint is of type isochronous, otherwise it returns
532 static inline int usb_endpoint_xfer_isoc(
533 const struct usb_endpoint_descriptor *epd)
535 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
536 USB_ENDPOINT_XFER_ISOC);
540 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
541 * @epd: endpoint to be checked
543 * Returns true if the endpoint has bulk transfer type and IN direction,
544 * otherwise it returns false.
546 static inline int usb_endpoint_is_bulk_in(
547 const struct usb_endpoint_descriptor *epd)
549 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
553 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
554 * @epd: endpoint to be checked
556 * Returns true if the endpoint has bulk transfer type and OUT direction,
557 * otherwise it returns false.
559 static inline int usb_endpoint_is_bulk_out(
560 const struct usb_endpoint_descriptor *epd)
562 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
566 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
567 * @epd: endpoint to be checked
569 * Returns true if the endpoint has interrupt transfer type and IN direction,
570 * otherwise it returns false.
572 static inline int usb_endpoint_is_int_in(
573 const struct usb_endpoint_descriptor *epd)
575 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
579 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
580 * @epd: endpoint to be checked
582 * Returns true if the endpoint has interrupt transfer type and OUT direction,
583 * otherwise it returns false.
585 static inline int usb_endpoint_is_int_out(
586 const struct usb_endpoint_descriptor *epd)
588 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
592 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
593 * @epd: endpoint to be checked
595 * Returns true if the endpoint has isochronous transfer type and IN direction,
596 * otherwise it returns false.
598 static inline int usb_endpoint_is_isoc_in(
599 const struct usb_endpoint_descriptor *epd)
601 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
605 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
606 * @epd: endpoint to be checked
608 * Returns true if the endpoint has isochronous transfer type and OUT direction,
609 * otherwise it returns false.
611 static inline int usb_endpoint_is_isoc_out(
612 const struct usb_endpoint_descriptor *epd)
614 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
618 * usb_endpoint_maxp - get endpoint's max packet size
619 * @epd: endpoint to be checked
621 * Returns @epd's max packet
623 static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd)
625 return __le16_to_cpu(get_unaligned(&epd->wMaxPacketSize));
628 static inline int usb_endpoint_interrupt_type(
629 const struct usb_endpoint_descriptor *epd)
631 return epd->bmAttributes & USB_ENDPOINT_INTRTYPE;
634 /*-------------------------------------------------------------------------*/
636 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
637 struct usb_ss_ep_comp_descriptor {
639 __u8 bDescriptorType;
643 __le16 wBytesPerInterval;
644 } __attribute__ ((packed));
646 #define USB_DT_SS_EP_COMP_SIZE 6
648 /* Bits 4:0 of bmAttributes if this is a bulk endpoint */
650 usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor *comp)
657 max_streams = comp->bmAttributes & 0x1f;
662 max_streams = 1 << max_streams;
667 /* Bits 1:0 of bmAttributes if this is an isoc endpoint */
668 #define USB_SS_MULT(p) (1 + ((p) & 0x3))
670 /*-------------------------------------------------------------------------*/
672 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
673 struct usb_qualifier_descriptor {
675 __u8 bDescriptorType;
679 __u8 bDeviceSubClass;
680 __u8 bDeviceProtocol;
681 __u8 bMaxPacketSize0;
682 __u8 bNumConfigurations;
684 } __attribute__ ((packed));
687 /*-------------------------------------------------------------------------*/
689 /* USB_DT_OTG (from OTG 1.0a supplement) */
690 struct usb_otg_descriptor {
692 __u8 bDescriptorType;
694 __u8 bmAttributes; /* support for HNP, SRP, etc */
695 } __attribute__ ((packed));
697 /* from usb_otg_descriptor.bmAttributes */
698 #define USB_OTG_SRP (1 << 0)
699 #define USB_OTG_HNP (1 << 1) /* swap host/device roles */
701 /*-------------------------------------------------------------------------*/
703 /* USB_DT_DEBUG: for special highspeed devices, replacing serial console */
704 struct usb_debug_descriptor {
706 __u8 bDescriptorType;
708 /* bulk endpoints with 8 byte maxpacket */
709 __u8 bDebugInEndpoint;
710 __u8 bDebugOutEndpoint;
711 } __attribute__((packed));
713 /*-------------------------------------------------------------------------*/
715 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
716 struct usb_interface_assoc_descriptor {
718 __u8 bDescriptorType;
720 __u8 bFirstInterface;
721 __u8 bInterfaceCount;
723 __u8 bFunctionSubClass;
724 __u8 bFunctionProtocol;
726 } __attribute__ ((packed));
729 /*-------------------------------------------------------------------------*/
731 /* USB_DT_SECURITY: group of wireless security descriptors, including
732 * encryption types available for setting up a CC/association.
734 struct usb_security_descriptor {
736 __u8 bDescriptorType;
739 __u8 bNumEncryptionTypes;
740 } __attribute__((packed));
742 /*-------------------------------------------------------------------------*/
744 /* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys
747 struct usb_key_descriptor {
749 __u8 bDescriptorType;
754 } __attribute__((packed));
756 /*-------------------------------------------------------------------------*/
758 /* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */
759 struct usb_encryption_descriptor {
761 __u8 bDescriptorType;
763 __u8 bEncryptionType;
764 #define USB_ENC_TYPE_UNSECURE 0
765 #define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */
766 #define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */
767 #define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */
768 __u8 bEncryptionValue; /* use in SET_ENCRYPTION */
770 } __attribute__((packed));
773 /*-------------------------------------------------------------------------*/
775 /* USB_DT_BOS: group of device-level capabilities */
776 struct usb_bos_descriptor {
778 __u8 bDescriptorType;
782 } __attribute__((packed));
784 #define USB_DT_BOS_SIZE 5
785 /*-------------------------------------------------------------------------*/
787 /* USB_DT_DEVICE_CAPABILITY: grouped with BOS */
788 struct usb_dev_cap_header {
790 __u8 bDescriptorType;
791 __u8 bDevCapabilityType;
792 } __attribute__((packed));
794 #define USB_CAP_TYPE_WIRELESS_USB 1
796 struct usb_wireless_cap_descriptor { /* Ultra Wide Band */
798 __u8 bDescriptorType;
799 __u8 bDevCapabilityType;
802 #define USB_WIRELESS_P2P_DRD (1 << 1)
803 #define USB_WIRELESS_BEACON_MASK (3 << 2)
804 #define USB_WIRELESS_BEACON_SELF (1 << 2)
805 #define USB_WIRELESS_BEACON_DIRECTED (2 << 2)
806 #define USB_WIRELESS_BEACON_NONE (3 << 2)
807 __le16 wPHYRates; /* bit rates, Mbps */
808 #define USB_WIRELESS_PHY_53 (1 << 0) /* always set */
809 #define USB_WIRELESS_PHY_80 (1 << 1)
810 #define USB_WIRELESS_PHY_107 (1 << 2) /* always set */
811 #define USB_WIRELESS_PHY_160 (1 << 3)
812 #define USB_WIRELESS_PHY_200 (1 << 4) /* always set */
813 #define USB_WIRELESS_PHY_320 (1 << 5)
814 #define USB_WIRELESS_PHY_400 (1 << 6)
815 #define USB_WIRELESS_PHY_480 (1 << 7)
816 __u8 bmTFITXPowerInfo; /* TFI power levels */
817 __u8 bmFFITXPowerInfo; /* FFI power levels */
820 } __attribute__((packed));
822 /* USB 2.0 Extension descriptor */
823 #define USB_CAP_TYPE_EXT 2
825 struct usb_ext_cap_descriptor { /* Link Power Management */
827 __u8 bDescriptorType;
828 __u8 bDevCapabilityType;
830 #define USB_LPM_SUPPORT (1 << 1) /* supports LPM */
831 #define USB_BESL_SUPPORT (1 << 2) /* supports BESL */
832 #define USB_BESL_BASELINE_VALID (1 << 3) /* Baseline BESL valid*/
833 #define USB_BESL_DEEP_VALID (1 << 4) /* Deep BESL valid */
834 #define USB_GET_BESL_BASELINE(p) (((p) & (0xf << 8)) >> 8)
835 #define USB_GET_BESL_DEEP(p) (((p) & (0xf << 12)) >> 12)
836 } __attribute__((packed));
838 #define USB_DT_USB_EXT_CAP_SIZE 7
841 * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
842 * specific device level capabilities
844 #define USB_SS_CAP_TYPE 3
845 struct usb_ss_cap_descriptor { /* Link Power Management */
847 __u8 bDescriptorType;
848 __u8 bDevCapabilityType;
850 #define USB_LTM_SUPPORT (1 << 1) /* supports LTM */
851 __le16 wSpeedSupported;
852 #define USB_LOW_SPEED_OPERATION (1) /* Low speed operation */
853 #define USB_FULL_SPEED_OPERATION (1 << 1) /* Full speed operation */
854 #define USB_HIGH_SPEED_OPERATION (1 << 2) /* High speed operation */
855 #define USB_5GBPS_OPERATION (1 << 3) /* Operation at 5Gbps */
856 __u8 bFunctionalitySupport;
858 __le16 bU2DevExitLat;
859 } __attribute__((packed));
861 #define USB_DT_USB_SS_CAP_SIZE 10
864 * Container ID Capability descriptor: Defines the instance unique ID used to
865 * identify the instance across all operating modes
867 #define CONTAINER_ID_TYPE 4
868 struct usb_ss_container_id_descriptor {
870 __u8 bDescriptorType;
871 __u8 bDevCapabilityType;
873 __u8 ContainerID[16]; /* 128-bit number */
874 } __attribute__((packed));
876 #define USB_DT_USB_SS_CONTN_ID_SIZE 20
877 /*-------------------------------------------------------------------------*/
879 /* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with
880 * each endpoint descriptor for a wireless device
882 struct usb_wireless_ep_comp_descriptor {
884 __u8 bDescriptorType;
888 __le16 wMaxStreamDelay;
889 __le16 wOverTheAirPacketSize;
890 __u8 bOverTheAirInterval;
891 __u8 bmCompAttributes;
892 #define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */
893 #define USB_ENDPOINT_SWITCH_NO 0
894 #define USB_ENDPOINT_SWITCH_SWITCH 1
895 #define USB_ENDPOINT_SWITCH_SCALE 2
896 } __attribute__((packed));
898 /*-------------------------------------------------------------------------*/
900 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
901 * host and a device for connection set up, mutual authentication, and
902 * exchanging short lived session keys. The handshake depends on a CC.
904 struct usb_handshake {
912 } __attribute__((packed));
914 /*-------------------------------------------------------------------------*/
916 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
917 * A CC may also be set up using non-wireless secure channels (including
918 * wired USB!), and some devices may support CCs with multiple hosts.
920 struct usb_connection_context {
921 __u8 CHID[16]; /* persistent host id */
922 __u8 CDID[16]; /* device id (unique w/in host context) */
923 __u8 CK[16]; /* connection key */
924 } __attribute__((packed));
926 /*-------------------------------------------------------------------------*/
928 /* USB 2.0 defines three speeds, here's how Linux identifies them */
930 enum usb_device_speed {
931 USB_SPEED_UNKNOWN = 0, /* enumerating */
932 USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */
933 USB_SPEED_HIGH, /* usb 2.0 */
934 USB_SPEED_WIRELESS, /* wireless (usb 2.5) */
935 USB_SPEED_SUPER, /* usb 3.0 */
941 * usb_speed_string() - Returns human readable-name of the speed.
942 * @speed: The speed to return human-readable name for. If it's not
943 * any of the speeds defined in usb_device_speed enum, string for
944 * USB_SPEED_UNKNOWN will be returned.
946 extern const char *usb_speed_string(enum usb_device_speed speed);
950 enum usb_device_state {
951 /* NOTATTACHED isn't in the USB spec, and this state acts
952 * the same as ATTACHED ... but it's clearer this way.
954 USB_STATE_NOTATTACHED = 0,
956 /* chapter 9 and authentication (wireless) device states */
958 USB_STATE_POWERED, /* wired */
959 USB_STATE_RECONNECTING, /* auth */
960 USB_STATE_UNAUTHENTICATED, /* auth */
961 USB_STATE_DEFAULT, /* limited function */
963 USB_STATE_CONFIGURED, /* most functions */
967 /* NOTE: there are actually four different SUSPENDED
968 * states, returning to POWERED, DEFAULT, ADDRESS, or
969 * CONFIGURED respectively when SOF tokens flow again.
970 * At this level there's no difference between L1 and L2
971 * suspend states. (L2 being original USB 1.1 suspend.)
975 enum usb3_link_state {
983 * A U1 timeout of 0x0 means the parent hub will reject any transitions to U1.
984 * 0xff means the parent hub will accept transitions to U1, but will not
985 * initiate a transition.
987 * A U1 timeout of 0x1 to 0x7F also causes the hub to initiate a transition to
988 * U1 after that many microseconds. Timeouts of 0x80 to 0xFE are reserved
991 * A U2 timeout of 0x0 means the parent hub will reject any transitions to U2.
992 * 0xff means the parent hub will accept transitions to U2, but will not
993 * initiate a transition.
995 * A U2 timeout of 0x1 to 0xFE also causes the hub to initiate a transition to
996 * U2 after N*256 microseconds. Therefore a U2 timeout value of 0x1 means a U2
997 * idle timer of 256 microseconds, 0x2 means 512 microseconds, 0xFE means
1000 #define USB3_LPM_DISABLED 0x0
1001 #define USB3_LPM_U1_MAX_TIMEOUT 0x7F
1002 #define USB3_LPM_U2_MAX_TIMEOUT 0xFE
1003 #define USB3_LPM_DEVICE_INITIATED 0xFF
1005 struct usb_set_sel_req {
1010 } __attribute__ ((packed));
1013 * The Set System Exit Latency control transfer provides one byte each for
1014 * U1 SEL and U1 PEL, so the max exit latency is 0xFF. U2 SEL and U2 PEL each
1015 * are two bytes long.
1017 #define USB3_LPM_MAX_U1_SEL_PEL 0xFF
1018 #define USB3_LPM_MAX_U2_SEL_PEL 0xFFFF
1020 /*-------------------------------------------------------------------------*/
1023 * As per USB compliance update, a device that is actively drawing
1024 * more than 100mA from USB must report itself as bus-powered in
1025 * the GetStatus(DEVICE) call.
1026 * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34
1028 #define USB_SELF_POWER_VBUS_MAX_DRAW 100
1031 * struct usb_string - wraps a C string and its USB id
1032 * @id:the (nonzero) ID for this string
1033 * @s:the string, in UTF-8 encoding
1035 * If you're using usb_gadget_get_string(), use this to wrap a string
1036 * together with its ID.
1043 #endif /* __LINUX_USB_CH9_H */