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 /* specific requests for USB Power Delivery */
109 #define USB_REQ_GET_PARTNER_PDO 20
110 #define USB_REQ_GET_BATTERY_STATUS 21
111 #define USB_REQ_SET_PDO 22
112 #define USB_REQ_GET_VDM 23
113 #define USB_REQ_SEND_VDM 24
115 /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command,
116 * used by hubs to put ports into a new L1 suspend state, except that it
117 * forgot to define its number ...
121 * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and
122 * are read as a bit array returned by USB_REQ_GET_STATUS. (So there
123 * are at most sixteen features of each type.) Hubs may also support a
124 * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend.
126 #define USB_DEVICE_SELF_POWERED 0 /* (read only) */
127 #define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */
128 #define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */
129 #define USB_DEVICE_BATTERY 2 /* (wireless) */
130 #define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */
131 #define USB_DEVICE_WUSB_DEVICE 3 /* (wireless)*/
132 #define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */
133 #define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */
134 #define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */
137 * Test Mode Selectors
138 * See USB 2.0 spec Table 9-7
142 #define TEST_SE0_NAK 3
143 #define TEST_PACKET 4
144 #define TEST_FORCE_EN 5
147 * New Feature Selectors as added by USB 3.0
148 * See USB 3.0 spec Table 9-7
150 #define USB_DEVICE_U1_ENABLE 48 /* dev may initiate U1 transition */
151 #define USB_DEVICE_U2_ENABLE 49 /* dev may initiate U2 transition */
152 #define USB_DEVICE_LTM_ENABLE 50 /* dev may send LTM */
153 #define USB_INTRF_FUNC_SUSPEND 0 /* function suspend */
155 #define USB_INTR_FUNC_SUSPEND_OPT_MASK 0xFF00
157 * Suspend Options, Table 9-8 USB 3.0 spec
159 #define USB_INTRF_FUNC_SUSPEND_LP (1 << (8 + 0))
160 #define USB_INTRF_FUNC_SUSPEND_RW (1 << (8 + 1))
163 * Interface status, Figure 9-5 USB 3.0 spec
165 #define USB_INTRF_STAT_FUNC_RW_CAP 1
166 #define USB_INTRF_STAT_FUNC_RW 2
168 #define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */
170 /* Bit array elements as returned by the USB_REQ_GET_STATUS request. */
171 #define USB_DEV_STAT_U1_ENABLED 2 /* transition into U1 state */
172 #define USB_DEV_STAT_U2_ENABLED 3 /* transition into U2 state */
173 #define USB_DEV_STAT_LTM_ENABLED 4 /* Latency tolerance messages */
176 * Feature selectors from Table 9-8 USB Power Delivery spec
178 #define USB_DEVICE_BATTERY_WAKE_MASK 40
179 #define USB_DEVICE_OS_IS_PD_AWARE 41
180 #define USB_DEVICE_POLICY_MODE 42
181 #define USB_PORT_PR_SWAP 43
182 #define USB_PORT_GOTO_MIN 44
183 #define USB_PORT_RETURN_POWER 45
184 #define USB_PORT_ACCEPT_PD_REQUEST 46
185 #define USB_PORT_REJECT_PD_REQUEST 47
186 #define USB_PORT_PORT_PD_RESET 48
187 #define USB_PORT_C_PORT_PD_CHANGE 49
188 #define USB_PORT_CABLE_PD_RESET 50
189 #define USB_DEVICE_CHARGING_POLICY 54
192 * struct usb_ctrlrequest - SETUP data for a USB device control request
193 * @bRequestType: matches the USB bmRequestType field
194 * @bRequest: matches the USB bRequest field
195 * @wValue: matches the USB wValue field (le16 byte order)
196 * @wIndex: matches the USB wIndex field (le16 byte order)
197 * @wLength: matches the USB wLength field (le16 byte order)
199 * This structure is used to send control requests to a USB device. It matches
200 * the different fields of the USB 2.0 Spec section 9.3, table 9-2. See the
201 * USB spec for a fuller description of the different fields, and what they are
204 * Note that the driver for any interface can issue control requests.
205 * For most devices, interfaces don't coordinate with each other, so
206 * such requests may be made at any time.
208 struct usb_ctrlrequest {
214 } __attribute__ ((packed));
216 /*-------------------------------------------------------------------------*/
219 * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
220 * (rarely) accepted by SET_DESCRIPTOR.
222 * Note that all multi-byte values here are encoded in little endian
223 * byte order "on the wire". Within the kernel and when exposed
224 * through the Linux-USB APIs, they are not converted to cpu byte
225 * order; it is the responsibility of the client code to do this.
226 * The single exception is when device and configuration descriptors (but
227 * not other descriptors) are read from character devices
228 * (i.e. /dev/bus/usb/BBB/DDD);
229 * in this case the fields are converted to host endianness by the kernel.
233 * Descriptor types ... USB 2.0 spec table 9.5
235 #define USB_DT_DEVICE 0x01
236 #define USB_DT_CONFIG 0x02
237 #define USB_DT_STRING 0x03
238 #define USB_DT_INTERFACE 0x04
239 #define USB_DT_ENDPOINT 0x05
240 #define USB_DT_DEVICE_QUALIFIER 0x06
241 #define USB_DT_OTHER_SPEED_CONFIG 0x07
242 #define USB_DT_INTERFACE_POWER 0x08
243 /* these are from a minor usb 2.0 revision (ECN) */
244 #define USB_DT_OTG 0x09
245 #define USB_DT_DEBUG 0x0a
246 #define USB_DT_INTERFACE_ASSOCIATION 0x0b
247 /* these are from the Wireless USB spec */
248 #define USB_DT_SECURITY 0x0c
249 #define USB_DT_KEY 0x0d
250 #define USB_DT_ENCRYPTION_TYPE 0x0e
251 #define USB_DT_BOS 0x0f
252 #define USB_DT_DEVICE_CAPABILITY 0x10
253 #define USB_DT_WIRELESS_ENDPOINT_COMP 0x11
254 #define USB_DT_WIRE_ADAPTER 0x21
255 #define USB_DT_RPIPE 0x22
256 #define USB_DT_CS_RADIO_CONTROL 0x23
257 /* From the T10 UAS specification */
258 #define USB_DT_PIPE_USAGE 0x24
259 /* From the USB 3.0 spec */
260 #define USB_DT_SS_ENDPOINT_COMP 0x30
261 /* From the USB 3.1 spec */
262 #define USB_DT_SSP_ISOC_ENDPOINT_COMP 0x31
264 /* Conventional codes for class-specific descriptors. The convention is
265 * defined in the USB "Common Class" Spec (3.11). Individual class specs
266 * are authoritative for their usage, not the "common class" writeup.
268 #define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE)
269 #define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG)
270 #define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING)
271 #define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE)
272 #define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT)
274 /* All standard descriptors have these 2 fields at the beginning */
275 struct usb_descriptor_header {
277 __u8 bDescriptorType;
278 } __attribute__ ((packed));
281 /*-------------------------------------------------------------------------*/
283 /* USB_DT_DEVICE: Device descriptor */
284 struct usb_device_descriptor {
286 __u8 bDescriptorType;
290 __u8 bDeviceSubClass;
291 __u8 bDeviceProtocol;
292 __u8 bMaxPacketSize0;
299 __u8 bNumConfigurations;
300 } __attribute__ ((packed));
302 #define USB_DT_DEVICE_SIZE 18
306 * Device and/or Interface Class codes
307 * as found in bDeviceClass or bInterfaceClass
308 * and defined by www.usb.org documents
310 #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
311 #define USB_CLASS_AUDIO 1
312 #define USB_CLASS_COMM 2
313 #define USB_CLASS_HID 3
314 #define USB_CLASS_PHYSICAL 5
315 #define USB_CLASS_STILL_IMAGE 6
316 #define USB_CLASS_PRINTER 7
317 #define USB_CLASS_MASS_STORAGE 8
318 #define USB_CLASS_HUB 9
319 #define USB_CLASS_CDC_DATA 0x0a
320 #define USB_CLASS_CSCID 0x0b /* chip+ smart card */
321 #define USB_CLASS_CONTENT_SEC 0x0d /* content security */
322 #define USB_CLASS_VIDEO 0x0e
323 #define USB_CLASS_WIRELESS_CONTROLLER 0xe0
324 #define USB_CLASS_MISC 0xef
325 #define USB_CLASS_APP_SPEC 0xfe
326 #define USB_CLASS_VENDOR_SPEC 0xff
328 #define USB_SUBCLASS_VENDOR_SPEC 0xff
330 /*-------------------------------------------------------------------------*/
332 /* USB_DT_CONFIG: Configuration descriptor information.
334 * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
335 * descriptor type is different. Highspeed-capable devices can look
336 * different depending on what speed they're currently running. Only
337 * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
340 struct usb_config_descriptor {
342 __u8 bDescriptorType;
346 __u8 bConfigurationValue;
350 } __attribute__ ((packed));
352 #define USB_DT_CONFIG_SIZE 9
354 /* from config descriptor bmAttributes */
355 #define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */
356 #define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */
357 #define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */
358 #define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */
360 /*-------------------------------------------------------------------------*/
362 /* USB_DT_STRING: String descriptor */
363 struct usb_string_descriptor {
365 __u8 bDescriptorType;
367 __le16 wData[1]; /* UTF-16LE encoded */
368 } __attribute__ ((packed));
370 /* note that "string" zero is special, it holds language codes that
371 * the device supports, not Unicode characters.
374 /*-------------------------------------------------------------------------*/
376 /* USB_DT_INTERFACE: Interface descriptor */
377 struct usb_interface_descriptor {
379 __u8 bDescriptorType;
381 __u8 bInterfaceNumber;
382 __u8 bAlternateSetting;
384 __u8 bInterfaceClass;
385 __u8 bInterfaceSubClass;
386 __u8 bInterfaceProtocol;
388 } __attribute__ ((packed));
390 #define USB_DT_INTERFACE_SIZE 9
392 /*-------------------------------------------------------------------------*/
394 /* USB_DT_ENDPOINT: Endpoint descriptor */
395 struct usb_endpoint_descriptor {
397 __u8 bDescriptorType;
399 __u8 bEndpointAddress;
401 __le16 wMaxPacketSize;
404 /* NOTE: these two are _only_ in audio endpoints. */
405 /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
408 } __attribute__ ((packed));
410 #define USB_DT_ENDPOINT_SIZE 7
411 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
417 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
418 #define USB_ENDPOINT_DIR_MASK 0x80
420 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
421 #define USB_ENDPOINT_XFER_CONTROL 0
422 #define USB_ENDPOINT_XFER_ISOC 1
423 #define USB_ENDPOINT_XFER_BULK 2
424 #define USB_ENDPOINT_XFER_INT 3
425 #define USB_ENDPOINT_MAX_ADJUSTABLE 0x80
427 #define USB_ENDPOINT_MAXP_MASK 0x07ff
428 #define USB_EP_MAXP_MULT_SHIFT 11
429 #define USB_EP_MAXP_MULT_MASK (3 << USB_EP_MAXP_MULT_SHIFT)
430 #define USB_EP_MAXP_MULT(m) \
431 (((m) & USB_EP_MAXP_MULT_MASK) >> USB_EP_MAXP_MULT_SHIFT)
433 /* The USB 3.0 spec redefines bits 5:4 of bmAttributes as interrupt ep type. */
434 #define USB_ENDPOINT_INTRTYPE 0x30
435 #define USB_ENDPOINT_INTR_PERIODIC (0 << 4)
436 #define USB_ENDPOINT_INTR_NOTIFICATION (1 << 4)
438 #define USB_ENDPOINT_SYNCTYPE 0x0c
439 #define USB_ENDPOINT_SYNC_NONE (0 << 2)
440 #define USB_ENDPOINT_SYNC_ASYNC (1 << 2)
441 #define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2)
442 #define USB_ENDPOINT_SYNC_SYNC (3 << 2)
444 #define USB_ENDPOINT_USAGE_MASK 0x30
445 #define USB_ENDPOINT_USAGE_DATA 0x00
446 #define USB_ENDPOINT_USAGE_FEEDBACK 0x10
447 #define USB_ENDPOINT_USAGE_IMPLICIT_FB 0x20 /* Implicit feedback Data endpoint */
449 /*-------------------------------------------------------------------------*/
452 * usb_endpoint_num - get the endpoint's number
453 * @epd: endpoint to be checked
455 * Returns @epd's number: 0 to 15.
457 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
459 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
463 * usb_endpoint_type - get the endpoint's transfer type
464 * @epd: endpoint to be checked
466 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
467 * to @epd's transfer type.
469 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
471 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
475 * usb_endpoint_dir_in - check if the endpoint has IN direction
476 * @epd: endpoint to be checked
478 * Returns true if the endpoint is of type IN, otherwise it returns false.
480 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
482 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
486 * usb_endpoint_dir_out - check if the endpoint has OUT direction
487 * @epd: endpoint to be checked
489 * Returns true if the endpoint is of type OUT, otherwise it returns false.
491 static inline int usb_endpoint_dir_out(
492 const struct usb_endpoint_descriptor *epd)
494 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
498 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
499 * @epd: endpoint to be checked
501 * Returns true if the endpoint is of type bulk, otherwise it returns false.
503 static inline int usb_endpoint_xfer_bulk(
504 const struct usb_endpoint_descriptor *epd)
506 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
507 USB_ENDPOINT_XFER_BULK);
511 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
512 * @epd: endpoint to be checked
514 * Returns true if the endpoint is of type control, otherwise it returns false.
516 static inline int usb_endpoint_xfer_control(
517 const struct usb_endpoint_descriptor *epd)
519 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
520 USB_ENDPOINT_XFER_CONTROL);
524 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
525 * @epd: endpoint to be checked
527 * Returns true if the endpoint is of type interrupt, otherwise it returns
530 static inline int usb_endpoint_xfer_int(
531 const struct usb_endpoint_descriptor *epd)
533 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
534 USB_ENDPOINT_XFER_INT);
538 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
539 * @epd: endpoint to be checked
541 * Returns true if the endpoint is of type isochronous, otherwise it returns
544 static inline int usb_endpoint_xfer_isoc(
545 const struct usb_endpoint_descriptor *epd)
547 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
548 USB_ENDPOINT_XFER_ISOC);
552 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
553 * @epd: endpoint to be checked
555 * Returns true if the endpoint has bulk transfer type and IN direction,
556 * otherwise it returns false.
558 static inline int usb_endpoint_is_bulk_in(
559 const struct usb_endpoint_descriptor *epd)
561 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
565 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
566 * @epd: endpoint to be checked
568 * Returns true if the endpoint has bulk transfer type and OUT direction,
569 * otherwise it returns false.
571 static inline int usb_endpoint_is_bulk_out(
572 const struct usb_endpoint_descriptor *epd)
574 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
578 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
579 * @epd: endpoint to be checked
581 * Returns true if the endpoint has interrupt transfer type and IN direction,
582 * otherwise it returns false.
584 static inline int usb_endpoint_is_int_in(
585 const struct usb_endpoint_descriptor *epd)
587 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
591 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
592 * @epd: endpoint to be checked
594 * Returns true if the endpoint has interrupt transfer type and OUT direction,
595 * otherwise it returns false.
597 static inline int usb_endpoint_is_int_out(
598 const struct usb_endpoint_descriptor *epd)
600 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
604 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
605 * @epd: endpoint to be checked
607 * Returns true if the endpoint has isochronous transfer type and IN direction,
608 * otherwise it returns false.
610 static inline int usb_endpoint_is_isoc_in(
611 const struct usb_endpoint_descriptor *epd)
613 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
617 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
618 * @epd: endpoint to be checked
620 * Returns true if the endpoint has isochronous transfer type and OUT direction,
621 * otherwise it returns false.
623 static inline int usb_endpoint_is_isoc_out(
624 const struct usb_endpoint_descriptor *epd)
626 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
630 * usb_endpoint_maxp - get endpoint's max packet size
631 * @epd: endpoint to be checked
633 * Returns @epd's max packet bits [10:0]
635 static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd)
637 return __le16_to_cpu(epd->wMaxPacketSize) & USB_ENDPOINT_MAXP_MASK;
641 * usb_endpoint_maxp_mult - get endpoint's transactional opportunities
642 * @epd: endpoint to be checked
644 * Return @epd's wMaxPacketSize[12:11] + 1
647 usb_endpoint_maxp_mult(const struct usb_endpoint_descriptor *epd)
649 int maxp = __le16_to_cpu(epd->wMaxPacketSize);
651 return USB_EP_MAXP_MULT(maxp) + 1;
654 static inline int usb_endpoint_interrupt_type(
655 const struct usb_endpoint_descriptor *epd)
657 return epd->bmAttributes & USB_ENDPOINT_INTRTYPE;
660 /*-------------------------------------------------------------------------*/
662 /* USB_DT_SSP_ISOC_ENDPOINT_COMP: SuperSpeedPlus Isochronous Endpoint Companion
665 struct usb_ssp_isoc_ep_comp_descriptor {
667 __u8 bDescriptorType;
669 __le32 dwBytesPerInterval;
670 } __attribute__ ((packed));
672 #define USB_DT_SSP_ISOC_EP_COMP_SIZE 8
674 /*-------------------------------------------------------------------------*/
676 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
677 struct usb_ss_ep_comp_descriptor {
679 __u8 bDescriptorType;
683 __le16 wBytesPerInterval;
684 } __attribute__ ((packed));
686 #define USB_DT_SS_EP_COMP_SIZE 6
688 /* Bits 4:0 of bmAttributes if this is a bulk endpoint */
690 usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor *comp)
697 max_streams = comp->bmAttributes & 0x1f;
702 max_streams = 1 << max_streams;
707 /* Bits 1:0 of bmAttributes if this is an isoc endpoint */
708 #define USB_SS_MULT(p) (1 + ((p) & 0x3))
709 /* Bit 7 of bmAttributes if a SSP isoc endpoint companion descriptor exists */
710 #define USB_SS_SSP_ISOC_COMP(p) ((p) & (1 << 7))
712 /*-------------------------------------------------------------------------*/
714 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
715 struct usb_qualifier_descriptor {
717 __u8 bDescriptorType;
721 __u8 bDeviceSubClass;
722 __u8 bDeviceProtocol;
723 __u8 bMaxPacketSize0;
724 __u8 bNumConfigurations;
726 } __attribute__ ((packed));
729 /*-------------------------------------------------------------------------*/
731 /* USB_DT_OTG (from OTG 1.0a supplement) */
732 struct usb_otg_descriptor {
734 __u8 bDescriptorType;
736 __u8 bmAttributes; /* support for HNP, SRP, etc */
737 } __attribute__ ((packed));
739 /* USB_DT_OTG (from OTG 2.0 supplement) */
740 struct usb_otg20_descriptor {
742 __u8 bDescriptorType;
744 __u8 bmAttributes; /* support for HNP, SRP and ADP, etc */
745 __le16 bcdOTG; /* OTG and EH supplement release number
746 * in binary-coded decimal(i.e. 2.0 is 0200H)
748 } __attribute__ ((packed));
750 /* from usb_otg_descriptor.bmAttributes */
751 #define USB_OTG_SRP (1 << 0)
752 #define USB_OTG_HNP (1 << 1) /* swap host/device roles */
753 #define USB_OTG_ADP (1 << 2) /* support ADP */
755 #define OTG_STS_SELECTOR 0xF000 /* OTG status selector */
756 /*-------------------------------------------------------------------------*/
758 /* USB_DT_DEBUG: for special highspeed devices, replacing serial console */
759 struct usb_debug_descriptor {
761 __u8 bDescriptorType;
763 /* bulk endpoints with 8 byte maxpacket */
764 __u8 bDebugInEndpoint;
765 __u8 bDebugOutEndpoint;
766 } __attribute__((packed));
768 /*-------------------------------------------------------------------------*/
770 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
771 struct usb_interface_assoc_descriptor {
773 __u8 bDescriptorType;
775 __u8 bFirstInterface;
776 __u8 bInterfaceCount;
778 __u8 bFunctionSubClass;
779 __u8 bFunctionProtocol;
781 } __attribute__ ((packed));
784 /*-------------------------------------------------------------------------*/
786 /* USB_DT_SECURITY: group of wireless security descriptors, including
787 * encryption types available for setting up a CC/association.
789 struct usb_security_descriptor {
791 __u8 bDescriptorType;
794 __u8 bNumEncryptionTypes;
795 } __attribute__((packed));
797 /*-------------------------------------------------------------------------*/
799 /* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys
802 struct usb_key_descriptor {
804 __u8 bDescriptorType;
809 } __attribute__((packed));
811 /*-------------------------------------------------------------------------*/
813 /* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */
814 struct usb_encryption_descriptor {
816 __u8 bDescriptorType;
818 __u8 bEncryptionType;
819 #define USB_ENC_TYPE_UNSECURE 0
820 #define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */
821 #define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */
822 #define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */
823 __u8 bEncryptionValue; /* use in SET_ENCRYPTION */
825 } __attribute__((packed));
828 /*-------------------------------------------------------------------------*/
830 /* USB_DT_BOS: group of device-level capabilities */
831 struct usb_bos_descriptor {
833 __u8 bDescriptorType;
837 } __attribute__((packed));
839 #define USB_DT_BOS_SIZE 5
840 /*-------------------------------------------------------------------------*/
842 /* USB_DT_DEVICE_CAPABILITY: grouped with BOS */
843 struct usb_dev_cap_header {
845 __u8 bDescriptorType;
846 __u8 bDevCapabilityType;
847 } __attribute__((packed));
849 #define USB_CAP_TYPE_WIRELESS_USB 1
851 struct usb_wireless_cap_descriptor { /* Ultra Wide Band */
853 __u8 bDescriptorType;
854 __u8 bDevCapabilityType;
857 #define USB_WIRELESS_P2P_DRD (1 << 1)
858 #define USB_WIRELESS_BEACON_MASK (3 << 2)
859 #define USB_WIRELESS_BEACON_SELF (1 << 2)
860 #define USB_WIRELESS_BEACON_DIRECTED (2 << 2)
861 #define USB_WIRELESS_BEACON_NONE (3 << 2)
862 __le16 wPHYRates; /* bit rates, Mbps */
863 #define USB_WIRELESS_PHY_53 (1 << 0) /* always set */
864 #define USB_WIRELESS_PHY_80 (1 << 1)
865 #define USB_WIRELESS_PHY_107 (1 << 2) /* always set */
866 #define USB_WIRELESS_PHY_160 (1 << 3)
867 #define USB_WIRELESS_PHY_200 (1 << 4) /* always set */
868 #define USB_WIRELESS_PHY_320 (1 << 5)
869 #define USB_WIRELESS_PHY_400 (1 << 6)
870 #define USB_WIRELESS_PHY_480 (1 << 7)
871 __u8 bmTFITXPowerInfo; /* TFI power levels */
872 __u8 bmFFITXPowerInfo; /* FFI power levels */
875 } __attribute__((packed));
877 /* USB 2.0 Extension descriptor */
878 #define USB_CAP_TYPE_EXT 2
880 struct usb_ext_cap_descriptor { /* Link Power Management */
882 __u8 bDescriptorType;
883 __u8 bDevCapabilityType;
885 #define USB_LPM_SUPPORT (1 << 1) /* supports LPM */
886 #define USB_BESL_SUPPORT (1 << 2) /* supports BESL */
887 #define USB_BESL_BASELINE_VALID (1 << 3) /* Baseline BESL valid*/
888 #define USB_BESL_DEEP_VALID (1 << 4) /* Deep BESL valid */
889 #define USB_GET_BESL_BASELINE(p) (((p) & (0xf << 8)) >> 8)
890 #define USB_GET_BESL_DEEP(p) (((p) & (0xf << 12)) >> 12)
891 } __attribute__((packed));
893 #define USB_DT_USB_EXT_CAP_SIZE 7
896 * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
897 * specific device level capabilities
899 #define USB_SS_CAP_TYPE 3
900 struct usb_ss_cap_descriptor { /* Link Power Management */
902 __u8 bDescriptorType;
903 __u8 bDevCapabilityType;
905 #define USB_LTM_SUPPORT (1 << 1) /* supports LTM */
906 __le16 wSpeedSupported;
907 #define USB_LOW_SPEED_OPERATION (1) /* Low speed operation */
908 #define USB_FULL_SPEED_OPERATION (1 << 1) /* Full speed operation */
909 #define USB_HIGH_SPEED_OPERATION (1 << 2) /* High speed operation */
910 #define USB_5GBPS_OPERATION (1 << 3) /* Operation at 5Gbps */
911 __u8 bFunctionalitySupport;
913 __le16 bU2DevExitLat;
914 } __attribute__((packed));
916 #define USB_DT_USB_SS_CAP_SIZE 10
919 * Container ID Capability descriptor: Defines the instance unique ID used to
920 * identify the instance across all operating modes
922 #define CONTAINER_ID_TYPE 4
923 struct usb_ss_container_id_descriptor {
925 __u8 bDescriptorType;
926 __u8 bDevCapabilityType;
928 __u8 ContainerID[16]; /* 128-bit number */
929 } __attribute__((packed));
931 #define USB_DT_USB_SS_CONTN_ID_SIZE 20
934 * SuperSpeed Plus USB Capability descriptor: Defines the set of
935 * SuperSpeed Plus USB specific device level capabilities
937 #define USB_SSP_CAP_TYPE 0xa
938 struct usb_ssp_cap_descriptor {
940 __u8 bDescriptorType;
941 __u8 bDevCapabilityType;
944 #define USB_SSP_SUBLINK_SPEED_ATTRIBS (0x1f << 0) /* sublink speed entries */
945 #define USB_SSP_SUBLINK_SPEED_IDS (0xf << 5) /* speed ID entries */
946 __le16 wFunctionalitySupport;
947 #define USB_SSP_MIN_SUBLINK_SPEED_ATTRIBUTE_ID (0xf)
948 #define USB_SSP_MIN_RX_LANE_COUNT (0xf << 8)
949 #define USB_SSP_MIN_TX_LANE_COUNT (0xf << 12)
951 __le32 bmSublinkSpeedAttr[1]; /* list of sublink speed attrib entries */
952 #define USB_SSP_SUBLINK_SPEED_SSID (0xf) /* sublink speed ID */
953 #define USB_SSP_SUBLINK_SPEED_LSE (0x3 << 4) /* Lanespeed exponent */
954 #define USB_SSP_SUBLINK_SPEED_ST (0x3 << 6) /* Sublink type */
955 #define USB_SSP_SUBLINK_SPEED_RSVD (0x3f << 8) /* Reserved */
956 #define USB_SSP_SUBLINK_SPEED_LP (0x3 << 14) /* Link protocol */
957 #define USB_SSP_SUBLINK_SPEED_LSM (0xff << 16) /* Lanespeed mantissa */
958 } __attribute__((packed));
961 * USB Power Delivery Capability Descriptor:
962 * Defines capabilities for PD
964 /* Defines the various PD Capabilities of this device */
965 #define USB_PD_POWER_DELIVERY_CAPABILITY 0x06
966 /* Provides information on each battery supported by the device */
967 #define USB_PD_BATTERY_INFO_CAPABILITY 0x07
968 /* The Consumer characteristics of a Port on the device */
969 #define USB_PD_PD_CONSUMER_PORT_CAPABILITY 0x08
970 /* The provider characteristics of a Port on the device */
971 #define USB_PD_PD_PROVIDER_PORT_CAPABILITY 0x09
973 struct usb_pd_cap_descriptor {
975 __u8 bDescriptorType;
976 __u8 bDevCapabilityType; /* set to USB_PD_POWER_DELIVERY_CAPABILITY */
979 #define USB_PD_CAP_BATTERY_CHARGING (1 << 1) /* supports Battery Charging specification */
980 #define USB_PD_CAP_USB_PD (1 << 2) /* supports USB Power Delivery specification */
981 #define USB_PD_CAP_PROVIDER (1 << 3) /* can provide power */
982 #define USB_PD_CAP_CONSUMER (1 << 4) /* can consume power */
983 #define USB_PD_CAP_CHARGING_POLICY (1 << 5) /* supports CHARGING_POLICY feature */
984 #define USB_PD_CAP_TYPE_C_CURRENT (1 << 6) /* supports power capabilities defined in the USB Type-C Specification */
986 #define USB_PD_CAP_PWR_AC (1 << 8)
987 #define USB_PD_CAP_PWR_BAT (1 << 9)
988 #define USB_PD_CAP_PWR_USE_V_BUS (1 << 14)
990 __le16 bmProviderPorts; /* Bit zero refers to the UFP of the device */
991 __le16 bmConsumerPorts;
994 __le16 bcdUSBTypeCVersion;
995 } __attribute__((packed));
997 struct usb_pd_cap_battery_info_descriptor {
999 __u8 bDescriptorType;
1000 __u8 bDevCapabilityType;
1001 /* Index of string descriptor shall contain the user friendly name for this battery */
1003 /* Index of string descriptor shall contain the Serial Number String for this battery */
1006 __u8 bBatteryId; /* uniquely identifies this battery in status Messages */
1009 * Shall contain the Battery Charge value above which this
1010 * battery is considered to be fully charged but not necessarily
1013 __le32 dwChargedThreshold; /* in mWh */
1015 * Shall contain the minimum charge level of this battery such
1016 * that above this threshold, a device can be assured of being
1017 * able to power up successfully (see Battery Charging 1.2).
1019 __le32 dwWeakThreshold; /* in mWh */
1020 __le32 dwBatteryDesignCapacity; /* in mWh */
1021 __le32 dwBatteryLastFullchargeCapacity; /* in mWh */
1022 } __attribute__((packed));
1024 struct usb_pd_cap_consumer_port_descriptor {
1026 __u8 bDescriptorType;
1027 __u8 bDevCapabilityType;
1029 __u8 bmCapabilities;
1030 /* port will oerate under: */
1031 #define USB_PD_CAP_CONSUMER_BC (1 << 0) /* BC */
1032 #define USB_PD_CAP_CONSUMER_PD (1 << 1) /* PD */
1033 #define USB_PD_CAP_CONSUMER_TYPE_C (1 << 2) /* USB Type-C Current */
1034 __le16 wMinVoltage; /* in 50mV units */
1035 __le16 wMaxVoltage; /* in 50mV units */
1037 __le32 dwMaxOperatingPower; /* in 10 mW - operating at steady state */
1038 __le32 dwMaxPeakPower; /* in 10mW units - operating at peak power */
1039 __le32 dwMaxPeakPowerTime; /* in 100ms units - duration of peak */
1040 #define USB_PD_CAP_CONSUMER_UNKNOWN_PEAK_POWER_TIME 0xffff
1041 } __attribute__((packed));
1043 struct usb_pd_cap_provider_port_descriptor {
1045 __u8 bDescriptorType;
1046 __u8 bDevCapabilityType;
1048 __u8 bmCapabilities;
1049 /* port will oerate under: */
1050 #define USB_PD_CAP_PROVIDER_BC (1 << 0) /* BC */
1051 #define USB_PD_CAP_PROVIDER_PD (1 << 1) /* PD */
1052 #define USB_PD_CAP_PROVIDER_TYPE_C (1 << 2) /* USB Type-C Current */
1053 __u8 bNumOfPDObjects;
1055 __le32 wPowerDataObject[];
1056 } __attribute__((packed));
1059 * Precision time measurement capability descriptor: advertised by devices and
1060 * hubs that support PTM
1062 #define USB_PTM_CAP_TYPE 0xb
1063 struct usb_ptm_cap_descriptor {
1065 __u8 bDescriptorType;
1066 __u8 bDevCapabilityType;
1067 } __attribute__((packed));
1070 * The size of the descriptor for the Sublink Speed Attribute Count
1071 * (SSAC) specified in bmAttributes[4:0].
1073 #define USB_DT_USB_SSP_CAP_SIZE(ssac) (16 + ssac * 4)
1075 /*-------------------------------------------------------------------------*/
1077 /* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with
1078 * each endpoint descriptor for a wireless device
1080 struct usb_wireless_ep_comp_descriptor {
1082 __u8 bDescriptorType;
1086 __le16 wMaxStreamDelay;
1087 __le16 wOverTheAirPacketSize;
1088 __u8 bOverTheAirInterval;
1089 __u8 bmCompAttributes;
1090 #define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */
1091 #define USB_ENDPOINT_SWITCH_NO 0
1092 #define USB_ENDPOINT_SWITCH_SWITCH 1
1093 #define USB_ENDPOINT_SWITCH_SCALE 2
1094 } __attribute__((packed));
1096 /*-------------------------------------------------------------------------*/
1098 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
1099 * host and a device for connection set up, mutual authentication, and
1100 * exchanging short lived session keys. The handshake depends on a CC.
1102 struct usb_handshake {
1103 __u8 bMessageNumber;
1110 } __attribute__((packed));
1112 /*-------------------------------------------------------------------------*/
1114 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
1115 * A CC may also be set up using non-wireless secure channels (including
1116 * wired USB!), and some devices may support CCs with multiple hosts.
1118 struct usb_connection_context {
1119 __u8 CHID[16]; /* persistent host id */
1120 __u8 CDID[16]; /* device id (unique w/in host context) */
1121 __u8 CK[16]; /* connection key */
1122 } __attribute__((packed));
1124 /*-------------------------------------------------------------------------*/
1126 /* USB 2.0 defines three speeds, here's how Linux identifies them */
1128 enum usb_device_speed {
1129 USB_SPEED_UNKNOWN = 0, /* enumerating */
1130 USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */
1131 USB_SPEED_HIGH, /* usb 2.0 */
1132 USB_SPEED_WIRELESS, /* wireless (usb 2.5) */
1133 USB_SPEED_SUPER, /* usb 3.0 */
1134 USB_SPEED_SUPER_PLUS, /* usb 3.1 */
1138 enum usb_device_state {
1139 /* NOTATTACHED isn't in the USB spec, and this state acts
1140 * the same as ATTACHED ... but it's clearer this way.
1142 USB_STATE_NOTATTACHED = 0,
1144 /* chapter 9 and authentication (wireless) device states */
1146 USB_STATE_POWERED, /* wired */
1147 USB_STATE_RECONNECTING, /* auth */
1148 USB_STATE_UNAUTHENTICATED, /* auth */
1149 USB_STATE_DEFAULT, /* limited function */
1151 USB_STATE_CONFIGURED, /* most functions */
1155 /* NOTE: there are actually four different SUSPENDED
1156 * states, returning to POWERED, DEFAULT, ADDRESS, or
1157 * CONFIGURED respectively when SOF tokens flow again.
1158 * At this level there's no difference between L1 and L2
1159 * suspend states. (L2 being original USB 1.1 suspend.)
1163 enum usb3_link_state {
1171 * A U1 timeout of 0x0 means the parent hub will reject any transitions to U1.
1172 * 0xff means the parent hub will accept transitions to U1, but will not
1173 * initiate a transition.
1175 * A U1 timeout of 0x1 to 0x7F also causes the hub to initiate a transition to
1176 * U1 after that many microseconds. Timeouts of 0x80 to 0xFE are reserved
1179 * A U2 timeout of 0x0 means the parent hub will reject any transitions to U2.
1180 * 0xff means the parent hub will accept transitions to U2, but will not
1181 * initiate a transition.
1183 * A U2 timeout of 0x1 to 0xFE also causes the hub to initiate a transition to
1184 * U2 after N*256 microseconds. Therefore a U2 timeout value of 0x1 means a U2
1185 * idle timer of 256 microseconds, 0x2 means 512 microseconds, 0xFE means
1188 #define USB3_LPM_DISABLED 0x0
1189 #define USB3_LPM_U1_MAX_TIMEOUT 0x7F
1190 #define USB3_LPM_U2_MAX_TIMEOUT 0xFE
1191 #define USB3_LPM_DEVICE_INITIATED 0xFF
1193 struct usb_set_sel_req {
1198 } __attribute__ ((packed));
1201 * The Set System Exit Latency control transfer provides one byte each for
1202 * U1 SEL and U1 PEL, so the max exit latency is 0xFF. U2 SEL and U2 PEL each
1203 * are two bytes long.
1205 #define USB3_LPM_MAX_U1_SEL_PEL 0xFF
1206 #define USB3_LPM_MAX_U2_SEL_PEL 0xFFFF
1208 /*-------------------------------------------------------------------------*/
1211 * As per USB compliance update, a device that is actively drawing
1212 * more than 100mA from USB must report itself as bus-powered in
1213 * the GetStatus(DEVICE) call.
1214 * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34
1216 #define USB_SELF_POWER_VBUS_MAX_DRAW 100
1218 #endif /* _UAPI__LINUX_USB_CH9_H */