1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
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
7 * need these:
8 *
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.
12 *
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.
16 *
17 * There's also "Wireless USB", using low power short range radios for
18 * peripheral interconnection but otherwise building on the USB framework.
19 *
20 * Note all descriptors are declared '__attribute__((packed))' so that:
21 *
22 * [a] they never get padded, either internally (USB spec writers
23 * probably handled that) or externally;
24 *
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
28 *
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.
32 */
33
34 #ifndef _UAPI__LINUX_USB_CH9_H
35 #define _UAPI__LINUX_USB_CH9_H
36
37 #include <linux/types.h> /* __u8 etc */
38 #include <asm/byteorder.h> /* le16_to_cpu */
39
40 /*-------------------------------------------------------------------------*/
41
42 /* CONTROL REQUEST SUPPORT */
43
44 /*
45 * USB directions
46 *
47 * This bit flag is used in endpoint descriptors' bEndpointAddress field.
48 * It's also one of three fields in control requests bRequestType.
49 */
50 #define USB_DIR_OUT 0 /* to device */
51 #define USB_DIR_IN 0x80 /* to host */
52
53 /*
54 * USB types, the second of three bRequestType fields
55 */
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)
61
62 /*
63 * USB recipients, the third of three bRequestType fields
64 */
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
73
74 /*
75 * Standard requests, for the bRequest field of a SETUP packet.
76 *
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.
80 */
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
94
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
108
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
115
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 ...
119 */
120
121 /*
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.
126 */
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) */
136
137 /*
138 * Test Mode Selectors
139 * See USB 2.0 spec Table 9-7
140 */
141 #define TEST_J 1
142 #define TEST_K 2
143 #define TEST_SE0_NAK 3
144 #define TEST_PACKET 4
145 #define TEST_FORCE_EN 5
146
147 /* Status Type */
148 #define USB_STATUS_TYPE_STANDARD 0
149 #define USB_STATUS_TYPE_PTM 1
150
151 /*
152 * New Feature Selectors as added by USB 3.0
153 * See USB 3.0 spec Table 9-7
154 */
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 */
159
160 #define USB_INTR_FUNC_SUSPEND_OPT_MASK 0xFF00
161 /*
162 * Suspend Options, Table 9-8 USB 3.0 spec
163 */
164 #define USB_INTRF_FUNC_SUSPEND_LP (1 << (8 + 0))
165 #define USB_INTRF_FUNC_SUSPEND_RW (1 << (8 + 1))
166
167 /*
168 * Interface status, Figure 9-5 USB 3.0 spec
169 */
170 #define USB_INTRF_STAT_FUNC_RW_CAP 1
171 #define USB_INTRF_STAT_FUNC_RW 2
172
173 #define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */
174
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 */
179
180 /*
181 * Feature selectors from Table 9-8 USB Power Delivery spec
182 */
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
195
196 /**
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)
203 *
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
207 * used for.
208 *
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.
212 */
213 struct usb_ctrlrequest {
214 __u8 bRequestType;
215 __u8 bRequest;
216 __le16 wValue;
217 __le16 wIndex;
218 __le16 wLength;
219 } __attribute__ ((packed));
220
221 /*-------------------------------------------------------------------------*/
222
223 /*
224 * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
225 * (rarely) accepted by SET_DESCRIPTOR.
226 *
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.
235 */
236
237 /*
238 * Descriptor types ... USB 2.0 spec table 9.5
239 */
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
268
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.
272 */
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)
278
279 /* All standard descriptors have these 2 fields at the beginning */
280 struct usb_descriptor_header {
281 __u8 bLength;
282 __u8 bDescriptorType;
283 } __attribute__ ((packed));
284
285
286 /*-------------------------------------------------------------------------*/
287
288 /* USB_DT_DEVICE: Device descriptor */
289 struct usb_device_descriptor {
290 __u8 bLength;
291 __u8 bDescriptorType;
292
293 __le16 bcdUSB;
294 __u8 bDeviceClass;
295 __u8 bDeviceSubClass;
296 __u8 bDeviceProtocol;
297 __u8 bMaxPacketSize0;
298 __le16 idVendor;
299 __le16 idProduct;
300 __le16 bcdDevice;
301 __u8 iManufacturer;
302 __u8 iProduct;
303 __u8 iSerialNumber;
304 __u8 bNumConfigurations;
305 } __attribute__ ((packed));
306
307 #define USB_DT_DEVICE_SIZE 18
308
309
310 /*
311 * Device and/or Interface Class codes
312 * as found in bDeviceClass or bInterfaceClass
313 * and defined by www.usb.org documents
314 */
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_MISC 0xef
330 #define USB_CLASS_APP_SPEC 0xfe
331 #define USB_CLASS_VENDOR_SPEC 0xff
332
333 #define USB_SUBCLASS_VENDOR_SPEC 0xff
334
335 /*-------------------------------------------------------------------------*/
336
337 /* USB_DT_CONFIG: Configuration descriptor information.
338 *
339 * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
340 * descriptor type is different. Highspeed-capable devices can look
341 * different depending on what speed they're currently running. Only
342 * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
343 * descriptors.
344 */
345 struct usb_config_descriptor {
346 __u8 bLength;
347 __u8 bDescriptorType;
348
349 __le16 wTotalLength;
350 __u8 bNumInterfaces;
351 __u8 bConfigurationValue;
352 __u8 iConfiguration;
353 __u8 bmAttributes;
354 __u8 bMaxPower;
355 } __attribute__ ((packed));
356
357 #define USB_DT_CONFIG_SIZE 9
358
359 /* from config descriptor bmAttributes */
360 #define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */
361 #define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */
362 #define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */
363 #define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */
364
365 /*-------------------------------------------------------------------------*/
366
367 /* USB String descriptors can contain at most 126 characters. */
368 #define USB_MAX_STRING_LEN 126
369
370 /* USB_DT_STRING: String descriptor */
371 struct usb_string_descriptor {
372 __u8 bLength;
373 __u8 bDescriptorType;
374
375 __le16 wData[1]; /* UTF-16LE encoded */
376 } __attribute__ ((packed));
377
378 /* note that "string" zero is special, it holds language codes that
379 * the device supports, not Unicode characters.
380 */
381
382 /*-------------------------------------------------------------------------*/
383
384 /* USB_DT_INTERFACE: Interface descriptor */
385 struct usb_interface_descriptor {
386 __u8 bLength;
387 __u8 bDescriptorType;
388
389 __u8 bInterfaceNumber;
390 __u8 bAlternateSetting;
391 __u8 bNumEndpoints;
392 __u8 bInterfaceClass;
393 __u8 bInterfaceSubClass;
394 __u8 bInterfaceProtocol;
395 __u8 iInterface;
396 } __attribute__ ((packed));
397
398 #define USB_DT_INTERFACE_SIZE 9
399
400 /*-------------------------------------------------------------------------*/
401
402 /* USB_DT_ENDPOINT: Endpoint descriptor */
403 struct usb_endpoint_descriptor {
404 __u8 bLength;
405 __u8 bDescriptorType;
406
407 __u8 bEndpointAddress;
408 __u8 bmAttributes;
409 __le16 wMaxPacketSize;
410 __u8 bInterval;
411
412 /* NOTE: these two are _only_ in audio endpoints. */
413 /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
414 __u8 bRefresh;
415 __u8 bSynchAddress;
416 } __attribute__ ((packed));
417
418 #define USB_DT_ENDPOINT_SIZE 7
419 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
420
421
422 /*
423 * Endpoints
424 */
425 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
426 #define USB_ENDPOINT_DIR_MASK 0x80
427
428 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
429 #define USB_ENDPOINT_XFER_CONTROL 0
430 #define USB_ENDPOINT_XFER_ISOC 1
431 #define USB_ENDPOINT_XFER_BULK 2
432 #define USB_ENDPOINT_XFER_INT 3
433 #define USB_ENDPOINT_MAX_ADJUSTABLE 0x80
434
435 #define USB_ENDPOINT_MAXP_MASK 0x07ff
436 #define USB_EP_MAXP_MULT_SHIFT 11
437 #define USB_EP_MAXP_MULT_MASK (3 << USB_EP_MAXP_MULT_SHIFT)
438 #define USB_EP_MAXP_MULT(m) \
439 (((m) & USB_EP_MAXP_MULT_MASK) >> USB_EP_MAXP_MULT_SHIFT)
440
441 /* The USB 3.0 spec redefines bits 5:4 of bmAttributes as interrupt ep type. */
442 #define USB_ENDPOINT_INTRTYPE 0x30
443 #define USB_ENDPOINT_INTR_PERIODIC (0 << 4)
444 #define USB_ENDPOINT_INTR_NOTIFICATION (1 << 4)
445
446 #define USB_ENDPOINT_SYNCTYPE 0x0c
447 #define USB_ENDPOINT_SYNC_NONE (0 << 2)
448 #define USB_ENDPOINT_SYNC_ASYNC (1 << 2)
449 #define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2)
450 #define USB_ENDPOINT_SYNC_SYNC (3 << 2)
451
452 #define USB_ENDPOINT_USAGE_MASK 0x30
453 #define USB_ENDPOINT_USAGE_DATA 0x00
454 #define USB_ENDPOINT_USAGE_FEEDBACK 0x10
455 #define USB_ENDPOINT_USAGE_IMPLICIT_FB 0x20 /* Implicit feedback Data endpoint */
456
457 /*-------------------------------------------------------------------------*/
458
459 /**
460 * usb_endpoint_num - get the endpoint's number
461 * @epd: endpoint to be checked
462 *
463 * Returns @epd's number: 0 to 15.
464 */
usb_endpoint_num(const struct usb_endpoint_descriptor * epd)465 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
466 {
467 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
468 }
469
470 /**
471 * usb_endpoint_type - get the endpoint's transfer type
472 * @epd: endpoint to be checked
473 *
474 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
475 * to @epd's transfer type.
476 */
usb_endpoint_type(const struct usb_endpoint_descriptor * epd)477 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
478 {
479 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
480 }
481
482 /**
483 * usb_endpoint_dir_in - check if the endpoint has IN direction
484 * @epd: endpoint to be checked
485 *
486 * Returns true if the endpoint is of type IN, otherwise it returns false.
487 */
usb_endpoint_dir_in(const struct usb_endpoint_descriptor * epd)488 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
489 {
490 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
491 }
492
493 /**
494 * usb_endpoint_dir_out - check if the endpoint has OUT direction
495 * @epd: endpoint to be checked
496 *
497 * Returns true if the endpoint is of type OUT, otherwise it returns false.
498 */
usb_endpoint_dir_out(const struct usb_endpoint_descriptor * epd)499 static inline int usb_endpoint_dir_out(
500 const struct usb_endpoint_descriptor *epd)
501 {
502 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
503 }
504
505 /**
506 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
507 * @epd: endpoint to be checked
508 *
509 * Returns true if the endpoint is of type bulk, otherwise it returns false.
510 */
usb_endpoint_xfer_bulk(const struct usb_endpoint_descriptor * epd)511 static inline int usb_endpoint_xfer_bulk(
512 const struct usb_endpoint_descriptor *epd)
513 {
514 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
515 USB_ENDPOINT_XFER_BULK);
516 }
517
518 /**
519 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
520 * @epd: endpoint to be checked
521 *
522 * Returns true if the endpoint is of type control, otherwise it returns false.
523 */
usb_endpoint_xfer_control(const struct usb_endpoint_descriptor * epd)524 static inline int usb_endpoint_xfer_control(
525 const struct usb_endpoint_descriptor *epd)
526 {
527 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
528 USB_ENDPOINT_XFER_CONTROL);
529 }
530
531 /**
532 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
533 * @epd: endpoint to be checked
534 *
535 * Returns true if the endpoint is of type interrupt, otherwise it returns
536 * false.
537 */
usb_endpoint_xfer_int(const struct usb_endpoint_descriptor * epd)538 static inline int usb_endpoint_xfer_int(
539 const struct usb_endpoint_descriptor *epd)
540 {
541 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
542 USB_ENDPOINT_XFER_INT);
543 }
544
545 /**
546 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
547 * @epd: endpoint to be checked
548 *
549 * Returns true if the endpoint is of type isochronous, otherwise it returns
550 * false.
551 */
usb_endpoint_xfer_isoc(const struct usb_endpoint_descriptor * epd)552 static inline int usb_endpoint_xfer_isoc(
553 const struct usb_endpoint_descriptor *epd)
554 {
555 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
556 USB_ENDPOINT_XFER_ISOC);
557 }
558
559 /**
560 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
561 * @epd: endpoint to be checked
562 *
563 * Returns true if the endpoint has bulk transfer type and IN direction,
564 * otherwise it returns false.
565 */
usb_endpoint_is_bulk_in(const struct usb_endpoint_descriptor * epd)566 static inline int usb_endpoint_is_bulk_in(
567 const struct usb_endpoint_descriptor *epd)
568 {
569 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
570 }
571
572 /**
573 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
574 * @epd: endpoint to be checked
575 *
576 * Returns true if the endpoint has bulk transfer type and OUT direction,
577 * otherwise it returns false.
578 */
usb_endpoint_is_bulk_out(const struct usb_endpoint_descriptor * epd)579 static inline int usb_endpoint_is_bulk_out(
580 const struct usb_endpoint_descriptor *epd)
581 {
582 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
583 }
584
585 /**
586 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
587 * @epd: endpoint to be checked
588 *
589 * Returns true if the endpoint has interrupt transfer type and IN direction,
590 * otherwise it returns false.
591 */
usb_endpoint_is_int_in(const struct usb_endpoint_descriptor * epd)592 static inline int usb_endpoint_is_int_in(
593 const struct usb_endpoint_descriptor *epd)
594 {
595 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
596 }
597
598 /**
599 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
600 * @epd: endpoint to be checked
601 *
602 * Returns true if the endpoint has interrupt transfer type and OUT direction,
603 * otherwise it returns false.
604 */
usb_endpoint_is_int_out(const struct usb_endpoint_descriptor * epd)605 static inline int usb_endpoint_is_int_out(
606 const struct usb_endpoint_descriptor *epd)
607 {
608 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
609 }
610
611 /**
612 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
613 * @epd: endpoint to be checked
614 *
615 * Returns true if the endpoint has isochronous transfer type and IN direction,
616 * otherwise it returns false.
617 */
usb_endpoint_is_isoc_in(const struct usb_endpoint_descriptor * epd)618 static inline int usb_endpoint_is_isoc_in(
619 const struct usb_endpoint_descriptor *epd)
620 {
621 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
622 }
623
624 /**
625 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
626 * @epd: endpoint to be checked
627 *
628 * Returns true if the endpoint has isochronous transfer type and OUT direction,
629 * otherwise it returns false.
630 */
usb_endpoint_is_isoc_out(const struct usb_endpoint_descriptor * epd)631 static inline int usb_endpoint_is_isoc_out(
632 const struct usb_endpoint_descriptor *epd)
633 {
634 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
635 }
636
637 /**
638 * usb_endpoint_maxp - get endpoint's max packet size
639 * @epd: endpoint to be checked
640 *
641 * Returns @epd's max packet bits [10:0]
642 */
usb_endpoint_maxp(const struct usb_endpoint_descriptor * epd)643 static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd)
644 {
645 return __le16_to_cpu(epd->wMaxPacketSize) & USB_ENDPOINT_MAXP_MASK;
646 }
647
648 /**
649 * usb_endpoint_maxp_mult - get endpoint's transactional opportunities
650 * @epd: endpoint to be checked
651 *
652 * Return @epd's wMaxPacketSize[12:11] + 1
653 */
654 static inline int
usb_endpoint_maxp_mult(const struct usb_endpoint_descriptor * epd)655 usb_endpoint_maxp_mult(const struct usb_endpoint_descriptor *epd)
656 {
657 int maxp = __le16_to_cpu(epd->wMaxPacketSize);
658
659 return USB_EP_MAXP_MULT(maxp) + 1;
660 }
661
usb_endpoint_interrupt_type(const struct usb_endpoint_descriptor * epd)662 static inline int usb_endpoint_interrupt_type(
663 const struct usb_endpoint_descriptor *epd)
664 {
665 return epd->bmAttributes & USB_ENDPOINT_INTRTYPE;
666 }
667
668 /*-------------------------------------------------------------------------*/
669
670 /* USB_DT_SSP_ISOC_ENDPOINT_COMP: SuperSpeedPlus Isochronous Endpoint Companion
671 * descriptor
672 */
673 struct usb_ssp_isoc_ep_comp_descriptor {
674 __u8 bLength;
675 __u8 bDescriptorType;
676 __le16 wReseved;
677 __le32 dwBytesPerInterval;
678 } __attribute__ ((packed));
679
680 #define USB_DT_SSP_ISOC_EP_COMP_SIZE 8
681
682 /*-------------------------------------------------------------------------*/
683
684 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
685 struct usb_ss_ep_comp_descriptor {
686 __u8 bLength;
687 __u8 bDescriptorType;
688
689 __u8 bMaxBurst;
690 __u8 bmAttributes;
691 __le16 wBytesPerInterval;
692 } __attribute__ ((packed));
693
694 #define USB_DT_SS_EP_COMP_SIZE 6
695
696 /* Bits 4:0 of bmAttributes if this is a bulk endpoint */
697 static inline int
usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor * comp)698 usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor *comp)
699 {
700 int max_streams;
701
702 if (!comp)
703 return 0;
704
705 max_streams = comp->bmAttributes & 0x1f;
706
707 if (!max_streams)
708 return 0;
709
710 max_streams = 1 << max_streams;
711
712 return max_streams;
713 }
714
715 /* Bits 1:0 of bmAttributes if this is an isoc endpoint */
716 #define USB_SS_MULT(p) (1 + ((p) & 0x3))
717 /* Bit 7 of bmAttributes if a SSP isoc endpoint companion descriptor exists */
718 #define USB_SS_SSP_ISOC_COMP(p) ((p) & (1 << 7))
719
720 /*-------------------------------------------------------------------------*/
721
722 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
723 struct usb_qualifier_descriptor {
724 __u8 bLength;
725 __u8 bDescriptorType;
726
727 __le16 bcdUSB;
728 __u8 bDeviceClass;
729 __u8 bDeviceSubClass;
730 __u8 bDeviceProtocol;
731 __u8 bMaxPacketSize0;
732 __u8 bNumConfigurations;
733 __u8 bRESERVED;
734 } __attribute__ ((packed));
735
736
737 /*-------------------------------------------------------------------------*/
738
739 /* USB_DT_OTG (from OTG 1.0a supplement) */
740 struct usb_otg_descriptor {
741 __u8 bLength;
742 __u8 bDescriptorType;
743
744 __u8 bmAttributes; /* support for HNP, SRP, etc */
745 } __attribute__ ((packed));
746
747 /* USB_DT_OTG (from OTG 2.0 supplement) */
748 struct usb_otg20_descriptor {
749 __u8 bLength;
750 __u8 bDescriptorType;
751
752 __u8 bmAttributes; /* support for HNP, SRP and ADP, etc */
753 __le16 bcdOTG; /* OTG and EH supplement release number
754 * in binary-coded decimal(i.e. 2.0 is 0200H)
755 */
756 } __attribute__ ((packed));
757
758 /* from usb_otg_descriptor.bmAttributes */
759 #define USB_OTG_SRP (1 << 0)
760 #define USB_OTG_HNP (1 << 1) /* swap host/device roles */
761 #define USB_OTG_ADP (1 << 2) /* support ADP */
762
763 #define OTG_STS_SELECTOR 0xF000 /* OTG status selector */
764 /*-------------------------------------------------------------------------*/
765
766 /* USB_DT_DEBUG: for special highspeed devices, replacing serial console */
767 struct usb_debug_descriptor {
768 __u8 bLength;
769 __u8 bDescriptorType;
770
771 /* bulk endpoints with 8 byte maxpacket */
772 __u8 bDebugInEndpoint;
773 __u8 bDebugOutEndpoint;
774 } __attribute__((packed));
775
776 /*-------------------------------------------------------------------------*/
777
778 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
779 struct usb_interface_assoc_descriptor {
780 __u8 bLength;
781 __u8 bDescriptorType;
782
783 __u8 bFirstInterface;
784 __u8 bInterfaceCount;
785 __u8 bFunctionClass;
786 __u8 bFunctionSubClass;
787 __u8 bFunctionProtocol;
788 __u8 iFunction;
789 } __attribute__ ((packed));
790
791 #define USB_DT_INTERFACE_ASSOCIATION_SIZE 8
792
793 /*-------------------------------------------------------------------------*/
794
795 /* USB_DT_SECURITY: group of wireless security descriptors, including
796 * encryption types available for setting up a CC/association.
797 */
798 struct usb_security_descriptor {
799 __u8 bLength;
800 __u8 bDescriptorType;
801
802 __le16 wTotalLength;
803 __u8 bNumEncryptionTypes;
804 } __attribute__((packed));
805
806 /*-------------------------------------------------------------------------*/
807
808 /* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys
809 * may be retrieved.
810 */
811 struct usb_key_descriptor {
812 __u8 bLength;
813 __u8 bDescriptorType;
814
815 __u8 tTKID[3];
816 __u8 bReserved;
817 __u8 bKeyData[0];
818 } __attribute__((packed));
819
820 /*-------------------------------------------------------------------------*/
821
822 /* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */
823 struct usb_encryption_descriptor {
824 __u8 bLength;
825 __u8 bDescriptorType;
826
827 __u8 bEncryptionType;
828 #define USB_ENC_TYPE_UNSECURE 0
829 #define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */
830 #define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */
831 #define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */
832 __u8 bEncryptionValue; /* use in SET_ENCRYPTION */
833 __u8 bAuthKeyIndex;
834 } __attribute__((packed));
835
836
837 /*-------------------------------------------------------------------------*/
838
839 /* USB_DT_BOS: group of device-level capabilities */
840 struct usb_bos_descriptor {
841 __u8 bLength;
842 __u8 bDescriptorType;
843
844 __le16 wTotalLength;
845 __u8 bNumDeviceCaps;
846 } __attribute__((packed));
847
848 #define USB_DT_BOS_SIZE 5
849 /*-------------------------------------------------------------------------*/
850
851 /* USB_DT_DEVICE_CAPABILITY: grouped with BOS */
852 struct usb_dev_cap_header {
853 __u8 bLength;
854 __u8 bDescriptorType;
855 __u8 bDevCapabilityType;
856 } __attribute__((packed));
857
858 #define USB_CAP_TYPE_WIRELESS_USB 1
859
860 struct usb_wireless_cap_descriptor { /* Ultra Wide Band */
861 __u8 bLength;
862 __u8 bDescriptorType;
863 __u8 bDevCapabilityType;
864
865 __u8 bmAttributes;
866 #define USB_WIRELESS_P2P_DRD (1 << 1)
867 #define USB_WIRELESS_BEACON_MASK (3 << 2)
868 #define USB_WIRELESS_BEACON_SELF (1 << 2)
869 #define USB_WIRELESS_BEACON_DIRECTED (2 << 2)
870 #define USB_WIRELESS_BEACON_NONE (3 << 2)
871 __le16 wPHYRates; /* bit rates, Mbps */
872 #define USB_WIRELESS_PHY_53 (1 << 0) /* always set */
873 #define USB_WIRELESS_PHY_80 (1 << 1)
874 #define USB_WIRELESS_PHY_107 (1 << 2) /* always set */
875 #define USB_WIRELESS_PHY_160 (1 << 3)
876 #define USB_WIRELESS_PHY_200 (1 << 4) /* always set */
877 #define USB_WIRELESS_PHY_320 (1 << 5)
878 #define USB_WIRELESS_PHY_400 (1 << 6)
879 #define USB_WIRELESS_PHY_480 (1 << 7)
880 __u8 bmTFITXPowerInfo; /* TFI power levels */
881 __u8 bmFFITXPowerInfo; /* FFI power levels */
882 __le16 bmBandGroup;
883 __u8 bReserved;
884 } __attribute__((packed));
885
886 #define USB_DT_USB_WIRELESS_CAP_SIZE 11
887
888 /* USB 2.0 Extension descriptor */
889 #define USB_CAP_TYPE_EXT 2
890
891 struct usb_ext_cap_descriptor { /* Link Power Management */
892 __u8 bLength;
893 __u8 bDescriptorType;
894 __u8 bDevCapabilityType;
895 __le32 bmAttributes;
896 #define USB_LPM_SUPPORT (1 << 1) /* supports LPM */
897 #define USB_BESL_SUPPORT (1 << 2) /* supports BESL */
898 #define USB_BESL_BASELINE_VALID (1 << 3) /* Baseline BESL valid*/
899 #define USB_BESL_DEEP_VALID (1 << 4) /* Deep BESL valid */
900 #define USB_GET_BESL_BASELINE(p) (((p) & (0xf << 8)) >> 8)
901 #define USB_GET_BESL_DEEP(p) (((p) & (0xf << 12)) >> 12)
902 } __attribute__((packed));
903
904 #define USB_DT_USB_EXT_CAP_SIZE 7
905
906 /*
907 * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
908 * specific device level capabilities
909 */
910 #define USB_SS_CAP_TYPE 3
911 struct usb_ss_cap_descriptor { /* Link Power Management */
912 __u8 bLength;
913 __u8 bDescriptorType;
914 __u8 bDevCapabilityType;
915 __u8 bmAttributes;
916 #define USB_LTM_SUPPORT (1 << 1) /* supports LTM */
917 __le16 wSpeedSupported;
918 #define USB_LOW_SPEED_OPERATION (1) /* Low speed operation */
919 #define USB_FULL_SPEED_OPERATION (1 << 1) /* Full speed operation */
920 #define USB_HIGH_SPEED_OPERATION (1 << 2) /* High speed operation */
921 #define USB_5GBPS_OPERATION (1 << 3) /* Operation at 5Gbps */
922 __u8 bFunctionalitySupport;
923 __u8 bU1devExitLat;
924 __le16 bU2DevExitLat;
925 } __attribute__((packed));
926
927 #define USB_DT_USB_SS_CAP_SIZE 10
928
929 /*
930 * Container ID Capability descriptor: Defines the instance unique ID used to
931 * identify the instance across all operating modes
932 */
933 #define CONTAINER_ID_TYPE 4
934 struct usb_ss_container_id_descriptor {
935 __u8 bLength;
936 __u8 bDescriptorType;
937 __u8 bDevCapabilityType;
938 __u8 bReserved;
939 __u8 ContainerID[16]; /* 128-bit number */
940 } __attribute__((packed));
941
942 #define USB_DT_USB_SS_CONTN_ID_SIZE 20
943
944 /*
945 * SuperSpeed Plus USB Capability descriptor: Defines the set of
946 * SuperSpeed Plus USB specific device level capabilities
947 */
948 #define USB_SSP_CAP_TYPE 0xa
949 struct usb_ssp_cap_descriptor {
950 __u8 bLength;
951 __u8 bDescriptorType;
952 __u8 bDevCapabilityType;
953 __u8 bReserved;
954 __le32 bmAttributes;
955 #define USB_SSP_SUBLINK_SPEED_ATTRIBS (0x1f << 0) /* sublink speed entries */
956 #define USB_SSP_SUBLINK_SPEED_IDS (0xf << 5) /* speed ID entries */
957 __le16 wFunctionalitySupport;
958 #define USB_SSP_MIN_SUBLINK_SPEED_ATTRIBUTE_ID (0xf)
959 #define USB_SSP_MIN_RX_LANE_COUNT (0xf << 8)
960 #define USB_SSP_MIN_TX_LANE_COUNT (0xf << 12)
961 __le16 wReserved;
962 __le32 bmSublinkSpeedAttr[1]; /* list of sublink speed attrib entries */
963 #define USB_SSP_SUBLINK_SPEED_SSID (0xf) /* sublink speed ID */
964 #define USB_SSP_SUBLINK_SPEED_LSE (0x3 << 4) /* Lanespeed exponent */
965 #define USB_SSP_SUBLINK_SPEED_ST (0x3 << 6) /* Sublink type */
966 #define USB_SSP_SUBLINK_SPEED_RSVD (0x3f << 8) /* Reserved */
967 #define USB_SSP_SUBLINK_SPEED_LP (0x3 << 14) /* Link protocol */
968 #define USB_SSP_SUBLINK_SPEED_LSM (0xff << 16) /* Lanespeed mantissa */
969 } __attribute__((packed));
970
971 /*
972 * USB Power Delivery Capability Descriptor:
973 * Defines capabilities for PD
974 */
975 /* Defines the various PD Capabilities of this device */
976 #define USB_PD_POWER_DELIVERY_CAPABILITY 0x06
977 /* Provides information on each battery supported by the device */
978 #define USB_PD_BATTERY_INFO_CAPABILITY 0x07
979 /* The Consumer characteristics of a Port on the device */
980 #define USB_PD_PD_CONSUMER_PORT_CAPABILITY 0x08
981 /* The provider characteristics of a Port on the device */
982 #define USB_PD_PD_PROVIDER_PORT_CAPABILITY 0x09
983
984 struct usb_pd_cap_descriptor {
985 __u8 bLength;
986 __u8 bDescriptorType;
987 __u8 bDevCapabilityType; /* set to USB_PD_POWER_DELIVERY_CAPABILITY */
988 __u8 bReserved;
989 __le32 bmAttributes;
990 #define USB_PD_CAP_BATTERY_CHARGING (1 << 1) /* supports Battery Charging specification */
991 #define USB_PD_CAP_USB_PD (1 << 2) /* supports USB Power Delivery specification */
992 #define USB_PD_CAP_PROVIDER (1 << 3) /* can provide power */
993 #define USB_PD_CAP_CONSUMER (1 << 4) /* can consume power */
994 #define USB_PD_CAP_CHARGING_POLICY (1 << 5) /* supports CHARGING_POLICY feature */
995 #define USB_PD_CAP_TYPE_C_CURRENT (1 << 6) /* supports power capabilities defined in the USB Type-C Specification */
996
997 #define USB_PD_CAP_PWR_AC (1 << 8)
998 #define USB_PD_CAP_PWR_BAT (1 << 9)
999 #define USB_PD_CAP_PWR_USE_V_BUS (1 << 14)
1000
1001 __le16 bmProviderPorts; /* Bit zero refers to the UFP of the device */
1002 __le16 bmConsumerPorts;
1003 __le16 bcdBCVersion;
1004 __le16 bcdPDVersion;
1005 __le16 bcdUSBTypeCVersion;
1006 } __attribute__((packed));
1007
1008 struct usb_pd_cap_battery_info_descriptor {
1009 __u8 bLength;
1010 __u8 bDescriptorType;
1011 __u8 bDevCapabilityType;
1012 /* Index of string descriptor shall contain the user friendly name for this battery */
1013 __u8 iBattery;
1014 /* Index of string descriptor shall contain the Serial Number String for this battery */
1015 __u8 iSerial;
1016 __u8 iManufacturer;
1017 __u8 bBatteryId; /* uniquely identifies this battery in status Messages */
1018 __u8 bReserved;
1019 /*
1020 * Shall contain the Battery Charge value above which this
1021 * battery is considered to be fully charged but not necessarily
1022 * “topped off.”
1023 */
1024 __le32 dwChargedThreshold; /* in mWh */
1025 /*
1026 * Shall contain the minimum charge level of this battery such
1027 * that above this threshold, a device can be assured of being
1028 * able to power up successfully (see Battery Charging 1.2).
1029 */
1030 __le32 dwWeakThreshold; /* in mWh */
1031 __le32 dwBatteryDesignCapacity; /* in mWh */
1032 __le32 dwBatteryLastFullchargeCapacity; /* in mWh */
1033 } __attribute__((packed));
1034
1035 struct usb_pd_cap_consumer_port_descriptor {
1036 __u8 bLength;
1037 __u8 bDescriptorType;
1038 __u8 bDevCapabilityType;
1039 __u8 bReserved;
1040 __u8 bmCapabilities;
1041 /* port will oerate under: */
1042 #define USB_PD_CAP_CONSUMER_BC (1 << 0) /* BC */
1043 #define USB_PD_CAP_CONSUMER_PD (1 << 1) /* PD */
1044 #define USB_PD_CAP_CONSUMER_TYPE_C (1 << 2) /* USB Type-C Current */
1045 __le16 wMinVoltage; /* in 50mV units */
1046 __le16 wMaxVoltage; /* in 50mV units */
1047 __u16 wReserved;
1048 __le32 dwMaxOperatingPower; /* in 10 mW - operating at steady state */
1049 __le32 dwMaxPeakPower; /* in 10mW units - operating at peak power */
1050 __le32 dwMaxPeakPowerTime; /* in 100ms units - duration of peak */
1051 #define USB_PD_CAP_CONSUMER_UNKNOWN_PEAK_POWER_TIME 0xffff
1052 } __attribute__((packed));
1053
1054 struct usb_pd_cap_provider_port_descriptor {
1055 __u8 bLength;
1056 __u8 bDescriptorType;
1057 __u8 bDevCapabilityType;
1058 __u8 bReserved1;
1059 __u8 bmCapabilities;
1060 /* port will oerate under: */
1061 #define USB_PD_CAP_PROVIDER_BC (1 << 0) /* BC */
1062 #define USB_PD_CAP_PROVIDER_PD (1 << 1) /* PD */
1063 #define USB_PD_CAP_PROVIDER_TYPE_C (1 << 2) /* USB Type-C Current */
1064 __u8 bNumOfPDObjects;
1065 __u8 bReserved2;
1066 __le32 wPowerDataObject[];
1067 } __attribute__((packed));
1068
1069 /*
1070 * Precision time measurement capability descriptor: advertised by devices and
1071 * hubs that support PTM
1072 */
1073 #define USB_PTM_CAP_TYPE 0xb
1074 struct usb_ptm_cap_descriptor {
1075 __u8 bLength;
1076 __u8 bDescriptorType;
1077 __u8 bDevCapabilityType;
1078 } __attribute__((packed));
1079
1080 #define USB_DT_USB_PTM_ID_SIZE 3
1081 /*
1082 * The size of the descriptor for the Sublink Speed Attribute Count
1083 * (SSAC) specified in bmAttributes[4:0]. SSAC is zero-based
1084 */
1085 #define USB_DT_USB_SSP_CAP_SIZE(ssac) (12 + (ssac + 1) * 4)
1086
1087 /*-------------------------------------------------------------------------*/
1088
1089 /* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with
1090 * each endpoint descriptor for a wireless device
1091 */
1092 struct usb_wireless_ep_comp_descriptor {
1093 __u8 bLength;
1094 __u8 bDescriptorType;
1095
1096 __u8 bMaxBurst;
1097 __u8 bMaxSequence;
1098 __le16 wMaxStreamDelay;
1099 __le16 wOverTheAirPacketSize;
1100 __u8 bOverTheAirInterval;
1101 __u8 bmCompAttributes;
1102 #define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */
1103 #define USB_ENDPOINT_SWITCH_NO 0
1104 #define USB_ENDPOINT_SWITCH_SWITCH 1
1105 #define USB_ENDPOINT_SWITCH_SCALE 2
1106 } __attribute__((packed));
1107
1108 /*-------------------------------------------------------------------------*/
1109
1110 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
1111 * host and a device for connection set up, mutual authentication, and
1112 * exchanging short lived session keys. The handshake depends on a CC.
1113 */
1114 struct usb_handshake {
1115 __u8 bMessageNumber;
1116 __u8 bStatus;
1117 __u8 tTKID[3];
1118 __u8 bReserved;
1119 __u8 CDID[16];
1120 __u8 nonce[16];
1121 __u8 MIC[8];
1122 } __attribute__((packed));
1123
1124 /*-------------------------------------------------------------------------*/
1125
1126 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
1127 * A CC may also be set up using non-wireless secure channels (including
1128 * wired USB!), and some devices may support CCs with multiple hosts.
1129 */
1130 struct usb_connection_context {
1131 __u8 CHID[16]; /* persistent host id */
1132 __u8 CDID[16]; /* device id (unique w/in host context) */
1133 __u8 CK[16]; /* connection key */
1134 } __attribute__((packed));
1135
1136 /*-------------------------------------------------------------------------*/
1137
1138 /* USB 2.0 defines three speeds, here's how Linux identifies them */
1139
1140 enum usb_device_speed {
1141 USB_SPEED_UNKNOWN = 0, /* enumerating */
1142 USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */
1143 USB_SPEED_HIGH, /* usb 2.0 */
1144 USB_SPEED_WIRELESS, /* wireless (usb 2.5) */
1145 USB_SPEED_SUPER, /* usb 3.0 */
1146 USB_SPEED_SUPER_PLUS, /* usb 3.1 */
1147 };
1148
1149
1150 enum usb_device_state {
1151 /* NOTATTACHED isn't in the USB spec, and this state acts
1152 * the same as ATTACHED ... but it's clearer this way.
1153 */
1154 USB_STATE_NOTATTACHED = 0,
1155
1156 /* chapter 9 and authentication (wireless) device states */
1157 USB_STATE_ATTACHED,
1158 USB_STATE_POWERED, /* wired */
1159 USB_STATE_RECONNECTING, /* auth */
1160 USB_STATE_UNAUTHENTICATED, /* auth */
1161 USB_STATE_DEFAULT, /* limited function */
1162 USB_STATE_ADDRESS,
1163 USB_STATE_CONFIGURED, /* most functions */
1164
1165 USB_STATE_SUSPENDED
1166
1167 /* NOTE: there are actually four different SUSPENDED
1168 * states, returning to POWERED, DEFAULT, ADDRESS, or
1169 * CONFIGURED respectively when SOF tokens flow again.
1170 * At this level there's no difference between L1 and L2
1171 * suspend states. (L2 being original USB 1.1 suspend.)
1172 */
1173 };
1174
1175 enum usb3_link_state {
1176 USB3_LPM_U0 = 0,
1177 USB3_LPM_U1,
1178 USB3_LPM_U2,
1179 USB3_LPM_U3
1180 };
1181
1182 /*
1183 * A U1 timeout of 0x0 means the parent hub will reject any transitions to U1.
1184 * 0xff means the parent hub will accept transitions to U1, but will not
1185 * initiate a transition.
1186 *
1187 * A U1 timeout of 0x1 to 0x7F also causes the hub to initiate a transition to
1188 * U1 after that many microseconds. Timeouts of 0x80 to 0xFE are reserved
1189 * values.
1190 *
1191 * A U2 timeout of 0x0 means the parent hub will reject any transitions to U2.
1192 * 0xff means the parent hub will accept transitions to U2, but will not
1193 * initiate a transition.
1194 *
1195 * A U2 timeout of 0x1 to 0xFE also causes the hub to initiate a transition to
1196 * U2 after N*256 microseconds. Therefore a U2 timeout value of 0x1 means a U2
1197 * idle timer of 256 microseconds, 0x2 means 512 microseconds, 0xFE means
1198 * 65.024ms.
1199 */
1200 #define USB3_LPM_DISABLED 0x0
1201 #define USB3_LPM_U1_MAX_TIMEOUT 0x7F
1202 #define USB3_LPM_U2_MAX_TIMEOUT 0xFE
1203 #define USB3_LPM_DEVICE_INITIATED 0xFF
1204
1205 struct usb_set_sel_req {
1206 __u8 u1_sel;
1207 __u8 u1_pel;
1208 __le16 u2_sel;
1209 __le16 u2_pel;
1210 } __attribute__ ((packed));
1211
1212 /*
1213 * The Set System Exit Latency control transfer provides one byte each for
1214 * U1 SEL and U1 PEL, so the max exit latency is 0xFF. U2 SEL and U2 PEL each
1215 * are two bytes long.
1216 */
1217 #define USB3_LPM_MAX_U1_SEL_PEL 0xFF
1218 #define USB3_LPM_MAX_U2_SEL_PEL 0xFFFF
1219
1220 /*-------------------------------------------------------------------------*/
1221
1222 /*
1223 * As per USB compliance update, a device that is actively drawing
1224 * more than 100mA from USB must report itself as bus-powered in
1225 * the GetStatus(DEVICE) call.
1226 * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34
1227 */
1228 #define USB_SELF_POWER_VBUS_MAX_DRAW 100
1229
1230 #endif /* _UAPI__LINUX_USB_CH9_H */
1231