1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
3 * This file holds USB constants and structures that are needed for
4 * USB device APIs. These are used by the USB device model, which is
5 * defined in chapter 9 of the USB 2.0 specification and in the
6 * Wireless USB 1.0 (spread around). Linux has several APIs in C that
9 * - the master/host side Linux-USB kernel driver API;
10 * - the "usbfs" user space API; and
11 * - the Linux "gadget" slave/device/peripheral side driver API.
13 * USB 2.0 adds an additional "On The Go" (OTG) mode, which lets systems
14 * act either as a USB master/host or as a USB slave/device. That means
15 * the master and slave side APIs benefit from working well together.
17 * There's also "Wireless USB", using low power short range radios for
18 * peripheral interconnection but otherwise building on the USB framework.
20 * Note all descriptors are declared '__attribute__((packed))' so that:
22 * [a] they never get padded, either internally (USB spec writers
23 * probably handled that) or externally;
25 * [b] so that accessing bigger-than-a-bytes fields will never
26 * generate bus errors on any platform, even when the location of
27 * its descriptor inside a bundle isn't "naturally aligned", and
29 * [c] for consistency, removing all doubt even when it appears to
30 * someone that the two other points are non-issues for that
31 * particular descriptor type.
34 #ifndef __LINUX_USB_CH9_H
35 #define __LINUX_USB_CH9_H
37 #include <linux/types.h> /* __u8 etc */
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 */
51 #define USB_DIR_MASK 0x80
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 /* specific requests for USB Power Delivery */
110 #define USB_REQ_GET_PARTNER_PDO 20
111 #define USB_REQ_GET_BATTERY_STATUS 21
112 #define USB_REQ_SET_PDO 22
113 #define USB_REQ_GET_VDM 23
114 #define USB_REQ_SEND_VDM 24
116 /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command,
117 * used by hubs to put ports into a new L1 suspend state, except that it
118 * forgot to define its number ...
122 * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and
123 * are read as a bit array returned by USB_REQ_GET_STATUS. (So there
124 * are at most sixteen features of each type.) Hubs may also support a
125 * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend.
127 #define USB_DEVICE_SELF_POWERED 0 /* (read only) */
128 #define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */
129 #define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */
130 #define USB_DEVICE_BATTERY 2 /* (wireless) */
131 #define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */
132 #define USB_DEVICE_WUSB_DEVICE 3 /* (wireless)*/
133 #define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */
134 #define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */
135 #define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */
138 * Test Mode Selectors
139 * See USB 2.0 spec Table 9-7
143 #define USB_TEST_SE0_NAK 3
144 #define USB_TEST_PACKET 4
145 #define USB_TEST_FORCE_ENABLE 5
148 #define USB_STATUS_TYPE_STANDARD 0
149 #define USB_STATUS_TYPE_PTM 1
152 * New Feature Selectors as added by USB 3.0
153 * See USB 3.0 spec Table 9-7
155 #define USB_DEVICE_U1_ENABLE 48 /* dev may initiate U1 transition */
156 #define USB_DEVICE_U2_ENABLE 49 /* dev may initiate U2 transition */
157 #define USB_DEVICE_LTM_ENABLE 50 /* dev may send LTM */
158 #define USB_INTRF_FUNC_SUSPEND 0 /* function suspend */
160 #define USB_INTR_FUNC_SUSPEND_OPT_MASK 0xFF00
162 * Suspend Options, Table 9-8 USB 3.0 spec
164 #define USB_INTRF_FUNC_SUSPEND_LP (1 << (8 + 0))
165 #define USB_INTRF_FUNC_SUSPEND_RW (1 << (8 + 1))
168 * Interface status, Figure 9-5 USB 3.0 spec
170 #define USB_INTRF_STAT_FUNC_RW_CAP 1
171 #define USB_INTRF_STAT_FUNC_RW 2
173 #define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */
175 /* Bit array elements as returned by the USB_REQ_GET_STATUS request. */
176 #define USB_DEV_STAT_U1_ENABLED 2 /* transition into U1 state */
177 #define USB_DEV_STAT_U2_ENABLED 3 /* transition into U2 state */
178 #define USB_DEV_STAT_LTM_ENABLED 4 /* Latency tolerance messages */
181 * Feature selectors from Table 9-8 USB Power Delivery spec
183 #define USB_DEVICE_BATTERY_WAKE_MASK 40
184 #define USB_DEVICE_OS_IS_PD_AWARE 41
185 #define USB_DEVICE_POLICY_MODE 42
186 #define USB_PORT_PR_SWAP 43
187 #define USB_PORT_GOTO_MIN 44
188 #define USB_PORT_RETURN_POWER 45
189 #define USB_PORT_ACCEPT_PD_REQUEST 46
190 #define USB_PORT_REJECT_PD_REQUEST 47
191 #define USB_PORT_PORT_PD_RESET 48
192 #define USB_PORT_C_PORT_PD_CHANGE 49
193 #define USB_PORT_CABLE_PD_RESET 50
194 #define USB_DEVICE_CHARGING_POLICY 54
197 * struct usb_ctrlrequest - SETUP data for a USB device control request
198 * @bRequestType: matches the USB bmRequestType field
199 * @bRequest: matches the USB bRequest field
200 * @wValue: matches the USB wValue field (le16 byte order)
201 * @wIndex: matches the USB wIndex field (le16 byte order)
202 * @wLength: matches the USB wLength field (le16 byte order)
204 * This structure is used to send control requests to a USB device. It matches
205 * the different fields of the USB 2.0 Spec section 9.3, table 9-2. See the
206 * USB spec for a fuller description of the different fields, and what they are
209 * Note that the driver for any interface can issue control requests.
210 * For most devices, interfaces don't coordinate with each other, so
211 * such requests may be made at any time.
213 struct usb_ctrlrequest {
219 } __attribute__ ((packed));
221 /*-------------------------------------------------------------------------*/
224 * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
225 * (rarely) accepted by SET_DESCRIPTOR.
227 * Note that all multi-byte values here are encoded in little endian
228 * byte order "on the wire". Within the kernel and when exposed
229 * through the Linux-USB APIs, they are not converted to cpu byte
230 * order; it is the responsibility of the client code to do this.
231 * The single exception is when device and configuration descriptors (but
232 * not other descriptors) are read from character devices
233 * (i.e. /dev/bus/usb/BBB/DDD);
234 * in this case the fields are converted to host endianness by the kernel.
238 * Descriptor types ... USB 2.0 spec table 9.5
240 #define USB_DT_DEVICE 0x01
241 #define USB_DT_CONFIG 0x02
242 #define USB_DT_STRING 0x03
243 #define USB_DT_INTERFACE 0x04
244 #define USB_DT_ENDPOINT 0x05
245 #define USB_DT_DEVICE_QUALIFIER 0x06
246 #define USB_DT_OTHER_SPEED_CONFIG 0x07
247 #define USB_DT_INTERFACE_POWER 0x08
248 /* these are from a minor usb 2.0 revision (ECN) */
249 #define USB_DT_OTG 0x09
250 #define USB_DT_DEBUG 0x0a
251 #define USB_DT_INTERFACE_ASSOCIATION 0x0b
252 /* these are from the Wireless USB spec */
253 #define USB_DT_SECURITY 0x0c
254 #define USB_DT_KEY 0x0d
255 #define USB_DT_ENCRYPTION_TYPE 0x0e
256 #define USB_DT_BOS 0x0f
257 #define USB_DT_DEVICE_CAPABILITY 0x10
258 #define USB_DT_WIRELESS_ENDPOINT_COMP 0x11
259 #define USB_DT_WIRE_ADAPTER 0x21
260 #define USB_DT_RPIPE 0x22
261 #define USB_DT_CS_RADIO_CONTROL 0x23
262 /* From the T10 UAS specification */
263 #define USB_DT_PIPE_USAGE 0x24
264 /* From the USB 3.0 spec */
265 #define USB_DT_SS_ENDPOINT_COMP 0x30
266 /* From the USB 3.1 spec */
267 #define USB_DT_SSP_ISOC_ENDPOINT_COMP 0x31
269 /* Conventional codes for class-specific descriptors. The convention is
270 * defined in the USB "Common Class" Spec (3.11). Individual class specs
271 * are authoritative for their usage, not the "common class" writeup.
273 #define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE)
274 #define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG)
275 #define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING)
276 #define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE)
277 #define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT)
279 /* All standard descriptors have these 2 fields at the beginning */
280 struct usb_descriptor_header {
282 __u8 bDescriptorType;
283 } __attribute__ ((packed));
286 /*-------------------------------------------------------------------------*/
288 /* USB_DT_DEVICE: Device descriptor */
289 struct usb_device_descriptor {
291 __u8 bDescriptorType;
295 __u8 bDeviceSubClass;
296 __u8 bDeviceProtocol;
297 __u8 bMaxPacketSize0;
304 __u8 bNumConfigurations;
305 } __attribute__ ((packed));
307 #define USB_DT_DEVICE_SIZE 18
311 * Device and/or Interface Class codes
312 * as found in bDeviceClass or bInterfaceClass
313 * and defined by www.usb.org documents
315 #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
316 #define USB_CLASS_AUDIO 1
317 #define USB_CLASS_COMM 2
318 #define USB_CLASS_HID 3
319 #define USB_CLASS_PHYSICAL 5
320 #define USB_CLASS_STILL_IMAGE 6
321 #define USB_CLASS_PRINTER 7
322 #define USB_CLASS_MASS_STORAGE 8
323 #define USB_CLASS_HUB 9
324 #define USB_CLASS_CDC_DATA 0x0a
325 #define USB_CLASS_CSCID 0x0b /* chip+ smart card */
326 #define USB_CLASS_CONTENT_SEC 0x0d /* content security */
327 #define USB_CLASS_VIDEO 0x0e
328 #define USB_CLASS_WIRELESS_CONTROLLER 0xe0
329 #define USB_CLASS_PERSONAL_HEALTHCARE 0x0f
330 #define USB_CLASS_AUDIO_VIDEO 0x10
331 #define USB_CLASS_BILLBOARD 0x11
332 #define USB_CLASS_USB_TYPE_C_BRIDGE 0x12
333 #define USB_CLASS_MISC 0xef
334 #define USB_CLASS_APP_SPEC 0xfe
335 #define USB_CLASS_VENDOR_SPEC 0xff
337 #define USB_SUBCLASS_VENDOR_SPEC 0xff
339 /*-------------------------------------------------------------------------*/
341 /* USB_DT_CONFIG: Configuration descriptor information.
343 * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
344 * descriptor type is different. Highspeed-capable devices can look
345 * different depending on what speed they're currently running. Only
346 * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
349 struct usb_config_descriptor {
351 __u8 bDescriptorType;
355 __u8 bConfigurationValue;
359 } __attribute__ ((packed));
361 #define USB_DT_CONFIG_SIZE 9
363 /* from config descriptor bmAttributes */
364 #define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */
365 #define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */
366 #define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */
367 #define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */
369 /*-------------------------------------------------------------------------*/
371 /* USB String descriptors can contain at most 126 characters. */
372 #define USB_MAX_STRING_LEN 126
374 /* USB_DT_STRING: String descriptor */
375 struct usb_string_descriptor {
377 __u8 bDescriptorType;
379 __le16 wData[1]; /* UTF-16LE encoded */
380 } __attribute__ ((packed));
382 /* note that "string" zero is special, it holds language codes that
383 * the device supports, not Unicode characters.
386 /*-------------------------------------------------------------------------*/
388 /* USB_DT_INTERFACE: Interface descriptor */
389 struct usb_interface_descriptor {
391 __u8 bDescriptorType;
393 __u8 bInterfaceNumber;
394 __u8 bAlternateSetting;
396 __u8 bInterfaceClass;
397 __u8 bInterfaceSubClass;
398 __u8 bInterfaceProtocol;
400 } __attribute__ ((packed));
402 #define USB_DT_INTERFACE_SIZE 9
404 /*-------------------------------------------------------------------------*/
406 /* USB_DT_ENDPOINT: Endpoint descriptor */
407 struct usb_endpoint_descriptor {
409 __u8 bDescriptorType;
411 __u8 bEndpointAddress;
413 __le16 wMaxPacketSize;
415 } __attribute__ ((packed));
417 #define USB_DT_ENDPOINT_SIZE 7
418 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
424 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
425 #define USB_ENDPOINT_DIR_MASK 0x80
427 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
428 #define USB_ENDPOINT_XFER_CONTROL 0
429 #define USB_ENDPOINT_XFER_ISOC 1
430 #define USB_ENDPOINT_XFER_BULK 2
431 #define USB_ENDPOINT_XFER_INT 3
432 #define USB_ENDPOINT_MAX_ADJUSTABLE 0x80
434 #define USB_ENDPOINT_MAXP_MASK 0x07ff
435 #define USB_EP_MAXP_MULT_SHIFT 11
436 #define USB_EP_MAXP_MULT_MASK (3 << USB_EP_MAXP_MULT_SHIFT)
437 #define USB_EP_MAXP_MULT(m) \
438 (((m) & USB_EP_MAXP_MULT_MASK) >> USB_EP_MAXP_MULT_SHIFT)
440 /* The USB 3.0 spec redefines bits 5:4 of bmAttributes as interrupt ep type. */
441 #define USB_ENDPOINT_INTRTYPE 0x30
442 #define USB_ENDPOINT_INTR_PERIODIC (0 << 4)
443 #define USB_ENDPOINT_INTR_NOTIFICATION (1 << 4)
445 #define USB_ENDPOINT_SYNCTYPE 0x0c
446 #define USB_ENDPOINT_SYNC_NONE (0 << 2)
447 #define USB_ENDPOINT_SYNC_ASYNC (1 << 2)
448 #define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2)
449 #define USB_ENDPOINT_SYNC_SYNC (3 << 2)
451 #define USB_ENDPOINT_USAGE_MASK 0x30
452 #define USB_ENDPOINT_USAGE_DATA 0x00
453 #define USB_ENDPOINT_USAGE_FEEDBACK 0x10
454 #define USB_ENDPOINT_USAGE_IMPLICIT_FB 0x20 /* Implicit feedback Data endpoint */
456 /*-------------------------------------------------------------------------*/
459 * usb_endpoint_num - get the endpoint's number
460 * @epd: endpoint to be checked
462 * Returns @epd's number: 0 to 15.
464 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
466 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
470 * usb_endpoint_type - get the endpoint's transfer type
471 * @epd: endpoint to be checked
473 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
474 * to @epd's transfer type.
476 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
478 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
482 * usb_endpoint_dir_in - check if the endpoint has IN direction
483 * @epd: endpoint to be checked
485 * Returns true if the endpoint is of type IN, otherwise it returns false.
487 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
489 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
493 * usb_endpoint_dir_out - check if the endpoint has OUT direction
494 * @epd: endpoint to be checked
496 * Returns true if the endpoint is of type OUT, otherwise it returns false.
498 static inline int usb_endpoint_dir_out(
499 const struct usb_endpoint_descriptor *epd)
501 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
505 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
506 * @epd: endpoint to be checked
508 * Returns true if the endpoint is of type bulk, otherwise it returns false.
510 static inline int usb_endpoint_xfer_bulk(
511 const struct usb_endpoint_descriptor *epd)
513 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
514 USB_ENDPOINT_XFER_BULK);
518 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
519 * @epd: endpoint to be checked
521 * Returns true if the endpoint is of type control, otherwise it returns false.
523 static inline int usb_endpoint_xfer_control(
524 const struct usb_endpoint_descriptor *epd)
526 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
527 USB_ENDPOINT_XFER_CONTROL);
531 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
532 * @epd: endpoint to be checked
534 * Returns true if the endpoint is of type interrupt, otherwise it returns
537 static inline int usb_endpoint_xfer_int(
538 const struct usb_endpoint_descriptor *epd)
540 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
541 USB_ENDPOINT_XFER_INT);
545 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
546 * @epd: endpoint to be checked
548 * Returns true if the endpoint is of type isochronous, otherwise it returns
551 static inline int usb_endpoint_xfer_isoc(
552 const struct usb_endpoint_descriptor *epd)
554 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
555 USB_ENDPOINT_XFER_ISOC);
559 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
560 * @epd: endpoint to be checked
562 * Returns true if the endpoint has bulk transfer type and IN direction,
563 * otherwise it returns false.
565 static inline int usb_endpoint_is_bulk_in(
566 const struct usb_endpoint_descriptor *epd)
568 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
572 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
573 * @epd: endpoint to be checked
575 * Returns true if the endpoint has bulk transfer type and OUT direction,
576 * otherwise it returns false.
578 static inline int usb_endpoint_is_bulk_out(
579 const struct usb_endpoint_descriptor *epd)
581 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
585 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
586 * @epd: endpoint to be checked
588 * Returns true if the endpoint has interrupt transfer type and IN direction,
589 * otherwise it returns false.
591 static inline int usb_endpoint_is_int_in(
592 const struct usb_endpoint_descriptor *epd)
594 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
598 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
599 * @epd: endpoint to be checked
601 * Returns true if the endpoint has interrupt transfer type and OUT direction,
602 * otherwise it returns false.
604 static inline int usb_endpoint_is_int_out(
605 const struct usb_endpoint_descriptor *epd)
607 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
611 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
612 * @epd: endpoint to be checked
614 * Returns true if the endpoint has isochronous transfer type and IN direction,
615 * otherwise it returns false.
617 static inline int usb_endpoint_is_isoc_in(
618 const struct usb_endpoint_descriptor *epd)
620 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
624 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
625 * @epd: endpoint to be checked
627 * Returns true if the endpoint has isochronous transfer type and OUT direction,
628 * otherwise it returns false.
630 static inline int usb_endpoint_is_isoc_out(
631 const struct usb_endpoint_descriptor *epd)
633 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
637 * usb_endpoint_maxp - get endpoint's max packet size
638 * @epd: endpoint to be checked
640 * Returns @epd's max packet bits [10:0]
642 static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd)
644 return le16_to_cpu(epd->wMaxPacketSize) & USB_ENDPOINT_MAXP_MASK;
648 * usb_endpoint_maxp_mult - get endpoint's transactional opportunities
649 * @epd: endpoint to be checked
651 * Return @epd's wMaxPacketSize[12:11] + 1
654 usb_endpoint_maxp_mult(const struct usb_endpoint_descriptor *epd)
656 int maxp = le16_to_cpu(epd->wMaxPacketSize);
658 return USB_EP_MAXP_MULT(maxp) + 1;
661 static inline int usb_endpoint_interrupt_type(
662 const struct usb_endpoint_descriptor *epd)
664 return epd->bmAttributes & USB_ENDPOINT_INTRTYPE;
667 /*-------------------------------------------------------------------------*/
669 /* USB_DT_SSP_ISOC_ENDPOINT_COMP: SuperSpeedPlus Isochronous Endpoint Companion
672 struct usb_ssp_isoc_ep_comp_descriptor {
674 __u8 bDescriptorType;
676 __le32 dwBytesPerInterval;
677 } __attribute__ ((packed));
679 #define USB_DT_SSP_ISOC_EP_COMP_SIZE 8
681 /*-------------------------------------------------------------------------*/
683 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
684 struct usb_ss_ep_comp_descriptor {
686 __u8 bDescriptorType;
690 __le16 wBytesPerInterval;
691 } __attribute__ ((packed));
693 #define USB_DT_SS_EP_COMP_SIZE 6
695 /* Bits 4:0 of bmAttributes if this is a bulk endpoint */
697 usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor *comp)
704 max_streams = comp->bmAttributes & 0x1f;
709 max_streams = 1 << max_streams;
714 /* Bits 1:0 of bmAttributes if this is an isoc endpoint */
715 #define USB_SS_MULT(p) (1 + ((p) & 0x3))
716 /* Bit 7 of bmAttributes if a SSP isoc endpoint companion descriptor exists */
717 #define USB_SS_SSP_ISOC_COMP(p) ((p) & (1 << 7))
719 /*-------------------------------------------------------------------------*/
721 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
722 struct usb_qualifier_descriptor {
724 __u8 bDescriptorType;
728 __u8 bDeviceSubClass;
729 __u8 bDeviceProtocol;
730 __u8 bMaxPacketSize0;
731 __u8 bNumConfigurations;
733 } __attribute__ ((packed));
736 /*-------------------------------------------------------------------------*/
738 /* USB_DT_OTG (from OTG 1.0a supplement) */
739 struct usb_otg_descriptor {
741 __u8 bDescriptorType;
743 __u8 bmAttributes; /* support for HNP, SRP, etc */
744 } __attribute__ ((packed));
746 /* USB_DT_OTG (from OTG 2.0 supplement) */
747 struct usb_otg20_descriptor {
749 __u8 bDescriptorType;
751 __u8 bmAttributes; /* support for HNP, SRP and ADP, etc */
752 __le16 bcdOTG; /* OTG and EH supplement release number
753 * in binary-coded decimal(i.e. 2.0 is 0200H)
755 } __attribute__ ((packed));
757 /* from usb_otg_descriptor.bmAttributes */
758 #define USB_OTG_SRP (1 << 0)
759 #define USB_OTG_HNP (1 << 1) /* swap host/device roles */
760 #define USB_OTG_ADP (1 << 2) /* support ADP */
762 #define OTG_STS_SELECTOR 0xF000 /* OTG status selector */
763 /*-------------------------------------------------------------------------*/
765 /* USB_DT_DEBUG: for special highspeed devices, replacing serial console */
766 struct usb_debug_descriptor {
768 __u8 bDescriptorType;
770 /* bulk endpoints with 8 byte maxpacket */
771 __u8 bDebugInEndpoint;
772 __u8 bDebugOutEndpoint;
773 } __attribute__((packed));
775 /*-------------------------------------------------------------------------*/
777 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
778 struct usb_interface_assoc_descriptor {
780 __u8 bDescriptorType;
782 __u8 bFirstInterface;
783 __u8 bInterfaceCount;
785 __u8 bFunctionSubClass;
786 __u8 bFunctionProtocol;
788 } __attribute__ ((packed));
790 #define USB_DT_INTERFACE_ASSOCIATION_SIZE 8
792 /*-------------------------------------------------------------------------*/
794 /* USB_DT_SECURITY: group of wireless security descriptors, including
795 * encryption types available for setting up a CC/association.
797 struct usb_security_descriptor {
799 __u8 bDescriptorType;
802 __u8 bNumEncryptionTypes;
803 } __attribute__((packed));
805 /*-------------------------------------------------------------------------*/
807 /* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys
810 struct usb_key_descriptor {
812 __u8 bDescriptorType;
817 } __attribute__((packed));
819 /*-------------------------------------------------------------------------*/
821 /* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */
822 struct usb_encryption_descriptor {
824 __u8 bDescriptorType;
826 __u8 bEncryptionType;
827 #define USB_ENC_TYPE_UNSECURE 0
828 #define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */
829 #define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */
830 #define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */
831 __u8 bEncryptionValue; /* use in SET_ENCRYPTION */
833 } __attribute__((packed));
836 /*-------------------------------------------------------------------------*/
838 /* USB_DT_BOS: group of device-level capabilities */
839 struct usb_bos_descriptor {
841 __u8 bDescriptorType;
845 } __attribute__((packed));
847 #define USB_DT_BOS_SIZE 5
848 /*-------------------------------------------------------------------------*/
850 /* USB_DT_DEVICE_CAPABILITY: grouped with BOS */
851 struct usb_dev_cap_header {
853 __u8 bDescriptorType;
854 __u8 bDevCapabilityType;
855 } __attribute__((packed));
857 #define USB_CAP_TYPE_WIRELESS_USB 1
859 struct usb_wireless_cap_descriptor { /* Ultra Wide Band */
861 __u8 bDescriptorType;
862 __u8 bDevCapabilityType;
865 #define USB_WIRELESS_P2P_DRD (1 << 1)
866 #define USB_WIRELESS_BEACON_MASK (3 << 2)
867 #define USB_WIRELESS_BEACON_SELF (1 << 2)
868 #define USB_WIRELESS_BEACON_DIRECTED (2 << 2)
869 #define USB_WIRELESS_BEACON_NONE (3 << 2)
870 __le16 wPHYRates; /* bit rates, Mbps */
871 #define USB_WIRELESS_PHY_53 (1 << 0) /* always set */
872 #define USB_WIRELESS_PHY_80 (1 << 1)
873 #define USB_WIRELESS_PHY_107 (1 << 2) /* always set */
874 #define USB_WIRELESS_PHY_160 (1 << 3)
875 #define USB_WIRELESS_PHY_200 (1 << 4) /* always set */
876 #define USB_WIRELESS_PHY_320 (1 << 5)
877 #define USB_WIRELESS_PHY_400 (1 << 6)
878 #define USB_WIRELESS_PHY_480 (1 << 7)
879 __u8 bmTFITXPowerInfo; /* TFI power levels */
880 __u8 bmFFITXPowerInfo; /* FFI power levels */
883 } __attribute__((packed));
885 #define USB_DT_USB_WIRELESS_CAP_SIZE 11
887 /* USB 2.0 Extension descriptor */
888 #define USB_CAP_TYPE_EXT 2
890 struct usb_ext_cap_descriptor { /* Link Power Management */
892 __u8 bDescriptorType;
893 __u8 bDevCapabilityType;
895 #define USB_LPM_SUPPORT (1 << 1) /* supports LPM */
896 #define USB_BESL_SUPPORT (1 << 2) /* supports BESL */
897 #define USB_BESL_BASELINE_VALID (1 << 3) /* Baseline BESL valid*/
898 #define USB_BESL_DEEP_VALID (1 << 4) /* Deep BESL valid */
899 #define USB_SET_BESL_BASELINE(p) (((p) & 0xf) << 8)
900 #define USB_SET_BESL_DEEP(p) (((p) & 0xf) << 12)
901 #define USB_GET_BESL_BASELINE(p) (((p) & (0xf << 8)) >> 8)
902 #define USB_GET_BESL_DEEP(p) (((p) & (0xf << 12)) >> 12)
903 } __attribute__((packed));
905 #define USB_DT_USB_EXT_CAP_SIZE 7
908 * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
909 * specific device level capabilities
911 #define USB_SS_CAP_TYPE 3
912 struct usb_ss_cap_descriptor { /* Link Power Management */
914 __u8 bDescriptorType;
915 __u8 bDevCapabilityType;
917 #define USB_LTM_SUPPORT (1 << 1) /* supports LTM */
918 __le16 wSpeedSupported;
919 #define USB_LOW_SPEED_OPERATION (1) /* Low speed operation */
920 #define USB_FULL_SPEED_OPERATION (1 << 1) /* Full speed operation */
921 #define USB_HIGH_SPEED_OPERATION (1 << 2) /* High speed operation */
922 #define USB_5GBPS_OPERATION (1 << 3) /* Operation at 5Gbps */
923 __u8 bFunctionalitySupport;
925 __le16 bU2DevExitLat;
926 } __attribute__((packed));
928 #define USB_DT_USB_SS_CAP_SIZE 10
931 * Container ID Capability descriptor: Defines the instance unique ID used to
932 * identify the instance across all operating modes
934 #define CONTAINER_ID_TYPE 4
935 struct usb_ss_container_id_descriptor {
937 __u8 bDescriptorType;
938 __u8 bDevCapabilityType;
940 __u8 ContainerID[16]; /* 128-bit number */
941 } __attribute__((packed));
943 #define USB_DT_USB_SS_CONTN_ID_SIZE 20
946 * SuperSpeed Plus USB Capability descriptor: Defines the set of
947 * SuperSpeed Plus USB specific device level capabilities
949 #define USB_SSP_CAP_TYPE 0xa
950 struct usb_ssp_cap_descriptor {
952 __u8 bDescriptorType;
953 __u8 bDevCapabilityType;
956 #define USB_SSP_SUBLINK_SPEED_ATTRIBS (0x1f << 0) /* sublink speed entries */
957 #define USB_SSP_SUBLINK_SPEED_IDS (0xf << 5) /* speed ID entries */
958 __le16 wFunctionalitySupport;
959 #define USB_SSP_MIN_SUBLINK_SPEED_ATTRIBUTE_ID (0xf)
960 #define USB_SSP_MIN_RX_LANE_COUNT (0xf << 8)
961 #define USB_SSP_MIN_TX_LANE_COUNT (0xf << 12)
963 __le32 bmSublinkSpeedAttr[1]; /* list of sublink speed attrib entries */
964 #define USB_SSP_SUBLINK_SPEED_SSID (0xf) /* sublink speed ID */
965 #define USB_SSP_SUBLINK_SPEED_LSE (0x3 << 4) /* Lanespeed exponent */
966 #define USB_SSP_SUBLINK_SPEED_ST (0x3 << 6) /* Sublink type */
967 #define USB_SSP_SUBLINK_SPEED_RSVD (0x3f << 8) /* Reserved */
968 #define USB_SSP_SUBLINK_SPEED_LP (0x3 << 14) /* Link protocol */
969 #define USB_SSP_SUBLINK_SPEED_LSM (0xff << 16) /* Lanespeed mantissa */
970 } __attribute__((packed));
973 * USB Power Delivery Capability Descriptor:
974 * Defines capabilities for PD
976 /* Defines the various PD Capabilities of this device */
977 #define USB_PD_POWER_DELIVERY_CAPABILITY 0x06
978 /* Provides information on each battery supported by the device */
979 #define USB_PD_BATTERY_INFO_CAPABILITY 0x07
980 /* The Consumer characteristics of a Port on the device */
981 #define USB_PD_PD_CONSUMER_PORT_CAPABILITY 0x08
982 /* The provider characteristics of a Port on the device */
983 #define USB_PD_PD_PROVIDER_PORT_CAPABILITY 0x09
985 struct usb_pd_cap_descriptor {
987 __u8 bDescriptorType;
988 __u8 bDevCapabilityType; /* set to USB_PD_POWER_DELIVERY_CAPABILITY */
991 #define USB_PD_CAP_BATTERY_CHARGING (1 << 1) /* supports Battery Charging specification */
992 #define USB_PD_CAP_USB_PD (1 << 2) /* supports USB Power Delivery specification */
993 #define USB_PD_CAP_PROVIDER (1 << 3) /* can provide power */
994 #define USB_PD_CAP_CONSUMER (1 << 4) /* can consume power */
995 #define USB_PD_CAP_CHARGING_POLICY (1 << 5) /* supports CHARGING_POLICY feature */
996 #define USB_PD_CAP_TYPE_C_CURRENT (1 << 6) /* supports power capabilities defined in the USB Type-C Specification */
998 #define USB_PD_CAP_PWR_AC (1 << 8)
999 #define USB_PD_CAP_PWR_BAT (1 << 9)
1000 #define USB_PD_CAP_PWR_USE_V_BUS (1 << 14)
1002 __le16 bmProviderPorts; /* Bit zero refers to the UFP of the device */
1003 __le16 bmConsumerPorts;
1004 __le16 bcdBCVersion;
1005 __le16 bcdPDVersion;
1006 __le16 bcdUSBTypeCVersion;
1007 } __attribute__((packed));
1009 struct usb_pd_cap_battery_info_descriptor {
1011 __u8 bDescriptorType;
1012 __u8 bDevCapabilityType;
1013 /* Index of string descriptor shall contain the user friendly name for this battery */
1015 /* Index of string descriptor shall contain the Serial Number String for this battery */
1018 __u8 bBatteryId; /* uniquely identifies this battery in status Messages */
1021 * Shall contain the Battery Charge value above which this
1022 * battery is considered to be fully charged but not necessarily
1025 __le32 dwChargedThreshold; /* in mWh */
1027 * Shall contain the minimum charge level of this battery such
1028 * that above this threshold, a device can be assured of being
1029 * able to power up successfully (see Battery Charging 1.2).
1031 __le32 dwWeakThreshold; /* in mWh */
1032 __le32 dwBatteryDesignCapacity; /* in mWh */
1033 __le32 dwBatteryLastFullchargeCapacity; /* in mWh */
1034 } __attribute__((packed));
1036 struct usb_pd_cap_consumer_port_descriptor {
1038 __u8 bDescriptorType;
1039 __u8 bDevCapabilityType;
1041 __u8 bmCapabilities;
1042 /* port will oerate under: */
1043 #define USB_PD_CAP_CONSUMER_BC (1 << 0) /* BC */
1044 #define USB_PD_CAP_CONSUMER_PD (1 << 1) /* PD */
1045 #define USB_PD_CAP_CONSUMER_TYPE_C (1 << 2) /* USB Type-C Current */
1046 __le16 wMinVoltage; /* in 50mV units */
1047 __le16 wMaxVoltage; /* in 50mV units */
1049 __le32 dwMaxOperatingPower; /* in 10 mW - operating at steady state */
1050 __le32 dwMaxPeakPower; /* in 10mW units - operating at peak power */
1051 __le32 dwMaxPeakPowerTime; /* in 100ms units - duration of peak */
1052 #define USB_PD_CAP_CONSUMER_UNKNOWN_PEAK_POWER_TIME 0xffff
1053 } __attribute__((packed));
1055 struct usb_pd_cap_provider_port_descriptor {
1057 __u8 bDescriptorType;
1058 __u8 bDevCapabilityType;
1060 __u8 bmCapabilities;
1061 /* port will oerate under: */
1062 #define USB_PD_CAP_PROVIDER_BC (1 << 0) /* BC */
1063 #define USB_PD_CAP_PROVIDER_PD (1 << 1) /* PD */
1064 #define USB_PD_CAP_PROVIDER_TYPE_C (1 << 2) /* USB Type-C Current */
1065 __u8 bNumOfPDObjects;
1067 __le32 wPowerDataObject[];
1068 } __attribute__((packed));
1071 * Precision time measurement capability descriptor: advertised by devices and
1072 * hubs that support PTM
1074 #define USB_PTM_CAP_TYPE 0xb
1075 struct usb_ptm_cap_descriptor {
1077 __u8 bDescriptorType;
1078 __u8 bDevCapabilityType;
1079 } __attribute__((packed));
1081 #define USB_DT_USB_PTM_ID_SIZE 3
1083 * The size of the descriptor for the Sublink Speed Attribute Count
1084 * (SSAC) specified in bmAttributes[4:0]. SSAC is zero-based
1086 #define USB_DT_USB_SSP_CAP_SIZE(ssac) (12 + (ssac + 1) * 4)
1088 /*-------------------------------------------------------------------------*/
1090 /* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with
1091 * each endpoint descriptor for a wireless device
1093 struct usb_wireless_ep_comp_descriptor {
1095 __u8 bDescriptorType;
1099 __le16 wMaxStreamDelay;
1100 __le16 wOverTheAirPacketSize;
1101 __u8 bOverTheAirInterval;
1102 __u8 bmCompAttributes;
1103 #define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */
1104 #define USB_ENDPOINT_SWITCH_NO 0
1105 #define USB_ENDPOINT_SWITCH_SWITCH 1
1106 #define USB_ENDPOINT_SWITCH_SCALE 2
1107 } __attribute__((packed));
1109 /*-------------------------------------------------------------------------*/
1111 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
1112 * host and a device for connection set up, mutual authentication, and
1113 * exchanging short lived session keys. The handshake depends on a CC.
1115 struct usb_handshake {
1116 __u8 bMessageNumber;
1123 } __attribute__((packed));
1125 /*-------------------------------------------------------------------------*/
1127 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
1128 * A CC may also be set up using non-wireless secure channels (including
1129 * wired USB!), and some devices may support CCs with multiple hosts.
1131 struct usb_connection_context {
1132 __u8 CHID[16]; /* persistent host id */
1133 __u8 CDID[16]; /* device id (unique w/in host context) */
1134 __u8 CK[16]; /* connection key */
1135 } __attribute__((packed));
1137 /*-------------------------------------------------------------------------*/
1139 /* USB 2.0 defines three speeds, here's how Linux identifies them */
1141 enum usb_device_speed {
1142 USB_SPEED_UNKNOWN = 0, /* enumerating */
1143 USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */
1144 USB_SPEED_HIGH, /* usb 2.0 */
1145 USB_SPEED_WIRELESS, /* wireless (usb 2.5) */
1146 USB_SPEED_SUPER, /* usb 3.0 */
1147 USB_SPEED_SUPER_PLUS, /* usb 3.1 */
1151 enum usb_device_state {
1152 /* NOTATTACHED isn't in the USB spec, and this state acts
1153 * the same as ATTACHED ... but it's clearer this way.
1155 USB_STATE_NOTATTACHED = 0,
1157 /* chapter 9 and authentication (wireless) device states */
1159 USB_STATE_POWERED, /* wired */
1160 USB_STATE_RECONNECTING, /* auth */
1161 USB_STATE_UNAUTHENTICATED, /* auth */
1162 USB_STATE_DEFAULT, /* limited function */
1164 USB_STATE_CONFIGURED, /* most functions */
1168 /* NOTE: there are actually four different SUSPENDED
1169 * states, returning to POWERED, DEFAULT, ADDRESS, or
1170 * CONFIGURED respectively when SOF tokens flow again.
1171 * At this level there's no difference between L1 and L2
1172 * suspend states. (L2 being original USB 1.1 suspend.)
1176 enum usb3_link_state {
1184 * A U1 timeout of 0x0 means the parent hub will reject any transitions to U1.
1185 * 0xff means the parent hub will accept transitions to U1, but will not
1186 * initiate a transition.
1188 * A U1 timeout of 0x1 to 0x7F also causes the hub to initiate a transition to
1189 * U1 after that many microseconds. Timeouts of 0x80 to 0xFE are reserved
1192 * A U2 timeout of 0x0 means the parent hub will reject any transitions to U2.
1193 * 0xff means the parent hub will accept transitions to U2, but will not
1194 * initiate a transition.
1196 * A U2 timeout of 0x1 to 0xFE also causes the hub to initiate a transition to
1197 * U2 after N*256 microseconds. Therefore a U2 timeout value of 0x1 means a U2
1198 * idle timer of 256 microseconds, 0x2 means 512 microseconds, 0xFE means
1201 #define USB3_LPM_DISABLED 0x0
1202 #define USB3_LPM_U1_MAX_TIMEOUT 0x7F
1203 #define USB3_LPM_U2_MAX_TIMEOUT 0xFE
1204 #define USB3_LPM_DEVICE_INITIATED 0xFF
1206 struct usb_set_sel_req {
1211 } __attribute__ ((packed));
1214 * The Set System Exit Latency control transfer provides one byte each for
1215 * U1 SEL and U1 PEL, so the max exit latency is 0xFF. U2 SEL and U2 PEL each
1216 * are two bytes long.
1218 #define USB3_LPM_MAX_U1_SEL_PEL 0xFF
1219 #define USB3_LPM_MAX_U2_SEL_PEL 0xFFFF
1221 /*-------------------------------------------------------------------------*/
1224 * As per USB compliance update, a device that is actively drawing
1225 * more than 100mA from USB must report itself as bus-powered in
1226 * the GetStatus(DEVICE) call.
1227 * https://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34
1229 #define USB_SELF_POWER_VBUS_MAX_DRAW 100
1231 #endif /* __LINUX_USB_CH9_H */