1 /*
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
6 * need these:
7 *
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.
11 *
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.
15 *
16 * There's also "Wireless USB", using low power short range radios for
17 * peripheral interconnection but otherwise building on the USB framework.
18 *
19 * Note all descriptors are declared '__attribute__((packed))' so that:
20 *
21 * [a] they never get padded, either internally (USB spec writers
22 * probably handled that) or externally;
23 *
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
27 *
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.
31 */
32
33 #ifndef __LINUX_USB_CH9_H
34 #define __LINUX_USB_CH9_H
35
36 #include <linux/types.h> /* __u8 etc */
37 #include <asm/byteorder.h> /* le16_to_cpu */
38 #include <asm/unaligned.h> /* get_unaligned() */
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 /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command,
110 * used by hubs to put ports into a new L1 suspend state, except that it
111 * forgot to define its number ...
112 */
113
114 /*
115 * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and
116 * are read as a bit array returned by USB_REQ_GET_STATUS. (So there
117 * are at most sixteen features of each type.) Hubs may also support a
118 * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend.
119 */
120 #define USB_DEVICE_SELF_POWERED 0 /* (read only) */
121 #define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */
122 #define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */
123 #define USB_DEVICE_BATTERY 2 /* (wireless) */
124 #define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */
125 #define USB_DEVICE_WUSB_DEVICE 3 /* (wireless)*/
126 #define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */
127 #define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */
128 #define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */
129
130 /*
131 * Test Mode Selectors
132 * See USB 2.0 spec Table 9-7
133 */
134 #define TEST_J 1
135 #define TEST_K 2
136 #define TEST_SE0_NAK 3
137 #define TEST_PACKET 4
138 #define TEST_FORCE_EN 5
139
140 /*
141 * New Feature Selectors as added by USB 3.0
142 * See USB 3.0 spec Table 9-6
143 */
144 #define USB_DEVICE_U1_ENABLE 48 /* dev may initiate U1 transition */
145 #define USB_DEVICE_U2_ENABLE 49 /* dev may initiate U2 transition */
146 #define USB_DEVICE_LTM_ENABLE 50 /* dev may send LTM */
147 #define USB_INTRF_FUNC_SUSPEND 0 /* function suspend */
148
149 #define USB_INTR_FUNC_SUSPEND_OPT_MASK 0xFF00
150 /*
151 * Suspend Options, Table 9-7 USB 3.0 spec
152 */
153 #define USB_INTRF_FUNC_SUSPEND_LP (1 << (8 + 0))
154 #define USB_INTRF_FUNC_SUSPEND_RW (1 << (8 + 1))
155
156 #define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */
157
158 /* Bit array elements as returned by the USB_REQ_GET_STATUS request. */
159 #define USB_DEV_STAT_U1_ENABLED 2 /* transition into U1 state */
160 #define USB_DEV_STAT_U2_ENABLED 3 /* transition into U2 state */
161 #define USB_DEV_STAT_LTM_ENABLED 4 /* Latency tolerance messages */
162
163 /**
164 * struct usb_ctrlrequest - SETUP data for a USB device control request
165 * @bRequestType: matches the USB bmRequestType field
166 * @bRequest: matches the USB bRequest field
167 * @wValue: matches the USB wValue field (le16 byte order)
168 * @wIndex: matches the USB wIndex field (le16 byte order)
169 * @wLength: matches the USB wLength field (le16 byte order)
170 *
171 * This structure is used to send control requests to a USB device. It matches
172 * the different fields of the USB 2.0 Spec section 9.3, table 9-2. See the
173 * USB spec for a fuller description of the different fields, and what they are
174 * used for.
175 *
176 * Note that the driver for any interface can issue control requests.
177 * For most devices, interfaces don't coordinate with each other, so
178 * such requests may be made at any time.
179 */
180 struct usb_ctrlrequest {
181 __u8 bRequestType;
182 __u8 bRequest;
183 __le16 wValue;
184 __le16 wIndex;
185 __le16 wLength;
186 } __attribute__ ((packed));
187
188 /*-------------------------------------------------------------------------*/
189
190 /*
191 * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
192 * (rarely) accepted by SET_DESCRIPTOR.
193 *
194 * Note that all multi-byte values here are encoded in little endian
195 * byte order "on the wire". Within the kernel and when exposed
196 * through the Linux-USB APIs, they are not converted to cpu byte
197 * order; it is the responsibility of the client code to do this.
198 * The single exception is when device and configuration descriptors (but
199 * not other descriptors) are read from usbfs (i.e. /proc/bus/usb/BBB/DDD);
200 * in this case the fields are converted to host endianness by the kernel.
201 */
202
203 /*
204 * Descriptor types ... USB 2.0 spec table 9.5
205 */
206 #define USB_DT_DEVICE 0x01
207 #define USB_DT_CONFIG 0x02
208 #define USB_DT_STRING 0x03
209 #define USB_DT_INTERFACE 0x04
210 #define USB_DT_ENDPOINT 0x05
211 #define USB_DT_DEVICE_QUALIFIER 0x06
212 #define USB_DT_OTHER_SPEED_CONFIG 0x07
213 #define USB_DT_INTERFACE_POWER 0x08
214 /* these are from a minor usb 2.0 revision (ECN) */
215 #define USB_DT_OTG 0x09
216 #define USB_DT_DEBUG 0x0a
217 #define USB_DT_INTERFACE_ASSOCIATION 0x0b
218 /* these are from the Wireless USB spec */
219 #define USB_DT_SECURITY 0x0c
220 #define USB_DT_KEY 0x0d
221 #define USB_DT_ENCRYPTION_TYPE 0x0e
222 #define USB_DT_BOS 0x0f
223 #define USB_DT_DEVICE_CAPABILITY 0x10
224 #define USB_DT_WIRELESS_ENDPOINT_COMP 0x11
225 #define USB_DT_WIRE_ADAPTER 0x21
226 #define USB_DT_RPIPE 0x22
227 #define USB_DT_CS_RADIO_CONTROL 0x23
228 /* From the T10 UAS specification */
229 #define USB_DT_PIPE_USAGE 0x24
230 /* From the USB 3.0 spec */
231 #define USB_DT_SS_ENDPOINT_COMP 0x30
232 /* From HID 1.11 spec */
233 #define USB_DT_HID_REPORT 0x22
234
235 /* Conventional codes for class-specific descriptors. The convention is
236 * defined in the USB "Common Class" Spec (3.11). Individual class specs
237 * are authoritative for their usage, not the "common class" writeup.
238 */
239 #define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE)
240 #define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG)
241 #define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING)
242 #define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE)
243 #define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT)
244
245 /* All standard descriptors have these 2 fields at the beginning */
246 struct usb_descriptor_header {
247 __u8 bLength;
248 __u8 bDescriptorType;
249 } __attribute__ ((packed));
250
251
252 /*-------------------------------------------------------------------------*/
253
254 /* USB_DT_DEVICE: Device descriptor */
255 struct usb_device_descriptor {
256 __u8 bLength;
257 __u8 bDescriptorType;
258
259 __le16 bcdUSB;
260 __u8 bDeviceClass;
261 __u8 bDeviceSubClass;
262 __u8 bDeviceProtocol;
263 __u8 bMaxPacketSize0;
264 __le16 idVendor;
265 __le16 idProduct;
266 __le16 bcdDevice;
267 __u8 iManufacturer;
268 __u8 iProduct;
269 __u8 iSerialNumber;
270 __u8 bNumConfigurations;
271 } __attribute__ ((packed));
272
273 #define USB_DT_DEVICE_SIZE 18
274
275
276 /*
277 * Device and/or Interface Class codes
278 * as found in bDeviceClass or bInterfaceClass
279 * and defined by www.usb.org documents
280 */
281 #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
282 #define USB_CLASS_AUDIO 1
283 #define USB_CLASS_COMM 2
284 #define USB_CLASS_HID 3
285 #define USB_CLASS_PHYSICAL 5
286 #define USB_CLASS_STILL_IMAGE 6
287 #define USB_CLASS_PRINTER 7
288 #define USB_CLASS_MASS_STORAGE 8
289 #define USB_CLASS_HUB 9
290 #define USB_CLASS_CDC_DATA 0x0a
291 #define USB_CLASS_CSCID 0x0b /* chip+ smart card */
292 #define USB_CLASS_CONTENT_SEC 0x0d /* content security */
293 #define USB_CLASS_VIDEO 0x0e
294 #define USB_CLASS_WIRELESS_CONTROLLER 0xe0
295 #define USB_CLASS_MISC 0xef
296 #define USB_CLASS_APP_SPEC 0xfe
297 #define USB_CLASS_VENDOR_SPEC 0xff
298
299 #define USB_SUBCLASS_VENDOR_SPEC 0xff
300
301 /*-------------------------------------------------------------------------*/
302
303 /* USB_DT_CONFIG: Configuration descriptor information.
304 *
305 * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
306 * descriptor type is different. Highspeed-capable devices can look
307 * different depending on what speed they're currently running. Only
308 * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
309 * descriptors.
310 */
311 struct usb_config_descriptor {
312 __u8 bLength;
313 __u8 bDescriptorType;
314
315 __le16 wTotalLength;
316 __u8 bNumInterfaces;
317 __u8 bConfigurationValue;
318 __u8 iConfiguration;
319 __u8 bmAttributes;
320 __u8 bMaxPower;
321 } __attribute__ ((packed));
322
323 #define USB_DT_CONFIG_SIZE 9
324
325 /* from config descriptor bmAttributes */
326 #define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */
327 #define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */
328 #define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */
329 #define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */
330
331 /*-------------------------------------------------------------------------*/
332
333 /* USB_DT_STRING: String descriptor */
334 struct usb_string_descriptor {
335 __u8 bLength;
336 __u8 bDescriptorType;
337
338 __le16 wData[1]; /* UTF-16LE encoded */
339 } __attribute__ ((packed));
340
341 /* note that "string" zero is special, it holds language codes that
342 * the device supports, not Unicode characters.
343 */
344
345 /*-------------------------------------------------------------------------*/
346
347 /* USB_DT_INTERFACE: Interface descriptor */
348 struct usb_interface_descriptor {
349 __u8 bLength;
350 __u8 bDescriptorType;
351
352 __u8 bInterfaceNumber;
353 __u8 bAlternateSetting;
354 __u8 bNumEndpoints;
355 __u8 bInterfaceClass;
356 __u8 bInterfaceSubClass;
357 __u8 bInterfaceProtocol;
358 __u8 iInterface;
359 } __attribute__ ((packed));
360
361 #define USB_DT_INTERFACE_SIZE 9
362
363 /*-------------------------------------------------------------------------*/
364
365 /* USB_DT_ENDPOINT: Endpoint descriptor */
366 struct usb_endpoint_descriptor {
367 __u8 bLength;
368 __u8 bDescriptorType;
369
370 __u8 bEndpointAddress;
371 __u8 bmAttributes;
372 __le16 wMaxPacketSize;
373 __u8 bInterval;
374
375 /* NOTE: these two are _only_ in audio endpoints. */
376 /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
377 __u8 bRefresh;
378 __u8 bSynchAddress;
379 } __attribute__ ((packed));
380
381 #define USB_DT_ENDPOINT_SIZE 7
382 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
383
384 /* Used to access common fields */
385 struct usb_generic_descriptor {
386 __u8 bLength;
387 __u8 bDescriptorType;
388 };
389
390 struct __packed usb_class_hid_descriptor {
391 u8 bLength;
392 u8 bDescriptorType;
393 u16 bcdCDC;
394 u8 bCountryCode;
395 u8 bNumDescriptors; /* 0x01 */
396 u8 bDescriptorType0;
397 u16 wDescriptorLength0;
398 /* optional descriptors are not supported. */
399 };
400
401 struct __packed usb_class_report_descriptor {
402 u8 bLength; /* dummy */
403 u8 bDescriptorType;
404 u16 wLength;
405 u8 bData[0];
406 };
407
408 /*
409 * Endpoints
410 */
411 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
412 #define USB_ENDPOINT_DIR_MASK 0x80
413
414 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
415 #define USB_ENDPOINT_XFER_CONTROL 0
416 #define USB_ENDPOINT_XFER_ISOC 1
417 #define USB_ENDPOINT_XFER_BULK 2
418 #define USB_ENDPOINT_XFER_INT 3
419 #define USB_ENDPOINT_MAX_ADJUSTABLE 0x80
420
421 #define USB_ENDPOINT_MAXP_MASK 0x07ff
422 #define USB_EP_MAXP_MULT_SHIFT 11
423 #define USB_EP_MAXP_MULT_MASK (3 << USB_EP_MAXP_MULT_SHIFT)
424 #define USB_EP_MAXP_MULT(m) \
425 (((m) & USB_EP_MAXP_MULT_MASK) >> USB_EP_MAXP_MULT_SHIFT)
426
427 /* The USB 3.0 spec redefines bits 5:4 of bmAttributes as interrupt ep type. */
428 #define USB_ENDPOINT_INTRTYPE 0x30
429 #define USB_ENDPOINT_INTR_PERIODIC (0 << 4)
430 #define USB_ENDPOINT_INTR_NOTIFICATION (1 << 4)
431
432 #define USB_ENDPOINT_SYNCTYPE 0x0c
433 #define USB_ENDPOINT_SYNC_NONE (0 << 2)
434 #define USB_ENDPOINT_SYNC_ASYNC (1 << 2)
435 #define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2)
436 #define USB_ENDPOINT_SYNC_SYNC (3 << 2)
437
438 #define USB_ENDPOINT_USAGE_MASK 0x30
439 #define USB_ENDPOINT_USAGE_DATA 0x00
440 #define USB_ENDPOINT_USAGE_FEEDBACK 0x10
441 #define USB_ENDPOINT_USAGE_IMPLICIT_FB 0x20 /* Implicit feedback Data endpoint */
442
443 /*-------------------------------------------------------------------------*/
444
445 /**
446 * usb_endpoint_num - get the endpoint's number
447 * @epd: endpoint to be checked
448 *
449 * Returns @epd's number: 0 to 15.
450 */
usb_endpoint_num(const struct usb_endpoint_descriptor * epd)451 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
452 {
453 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
454 }
455
456 /**
457 * usb_endpoint_type - get the endpoint's transfer type
458 * @epd: endpoint to be checked
459 *
460 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
461 * to @epd's transfer type.
462 */
usb_endpoint_type(const struct usb_endpoint_descriptor * epd)463 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
464 {
465 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
466 }
467
468 /**
469 * usb_endpoint_dir_in - check if the endpoint has IN direction
470 * @epd: endpoint to be checked
471 *
472 * Returns true if the endpoint is of type IN, otherwise it returns false.
473 */
usb_endpoint_dir_in(const struct usb_endpoint_descriptor * epd)474 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
475 {
476 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
477 }
478
479 /**
480 * usb_endpoint_dir_out - check if the endpoint has OUT direction
481 * @epd: endpoint to be checked
482 *
483 * Returns true if the endpoint is of type OUT, otherwise it returns false.
484 */
usb_endpoint_dir_out(const struct usb_endpoint_descriptor * epd)485 static inline int usb_endpoint_dir_out(
486 const struct usb_endpoint_descriptor *epd)
487 {
488 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
489 }
490
491 /**
492 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
493 * @epd: endpoint to be checked
494 *
495 * Returns true if the endpoint is of type bulk, otherwise it returns false.
496 */
usb_endpoint_xfer_bulk(const struct usb_endpoint_descriptor * epd)497 static inline int usb_endpoint_xfer_bulk(
498 const struct usb_endpoint_descriptor *epd)
499 {
500 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
501 USB_ENDPOINT_XFER_BULK);
502 }
503
504 /**
505 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
506 * @epd: endpoint to be checked
507 *
508 * Returns true if the endpoint is of type control, otherwise it returns false.
509 */
usb_endpoint_xfer_control(const struct usb_endpoint_descriptor * epd)510 static inline int usb_endpoint_xfer_control(
511 const struct usb_endpoint_descriptor *epd)
512 {
513 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
514 USB_ENDPOINT_XFER_CONTROL);
515 }
516
517 /**
518 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
519 * @epd: endpoint to be checked
520 *
521 * Returns true if the endpoint is of type interrupt, otherwise it returns
522 * false.
523 */
usb_endpoint_xfer_int(const struct usb_endpoint_descriptor * epd)524 static inline int usb_endpoint_xfer_int(
525 const struct usb_endpoint_descriptor *epd)
526 {
527 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
528 USB_ENDPOINT_XFER_INT);
529 }
530
531 /**
532 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
533 * @epd: endpoint to be checked
534 *
535 * Returns true if the endpoint is of type isochronous, otherwise it returns
536 * false.
537 */
usb_endpoint_xfer_isoc(const struct usb_endpoint_descriptor * epd)538 static inline int usb_endpoint_xfer_isoc(
539 const struct usb_endpoint_descriptor *epd)
540 {
541 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
542 USB_ENDPOINT_XFER_ISOC);
543 }
544
545 /**
546 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
547 * @epd: endpoint to be checked
548 *
549 * Returns true if the endpoint has bulk transfer type and IN direction,
550 * otherwise it returns false.
551 */
usb_endpoint_is_bulk_in(const struct usb_endpoint_descriptor * epd)552 static inline int usb_endpoint_is_bulk_in(
553 const struct usb_endpoint_descriptor *epd)
554 {
555 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
556 }
557
558 /**
559 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
560 * @epd: endpoint to be checked
561 *
562 * Returns true if the endpoint has bulk transfer type and OUT direction,
563 * otherwise it returns false.
564 */
usb_endpoint_is_bulk_out(const struct usb_endpoint_descriptor * epd)565 static inline int usb_endpoint_is_bulk_out(
566 const struct usb_endpoint_descriptor *epd)
567 {
568 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
569 }
570
571 /**
572 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
573 * @epd: endpoint to be checked
574 *
575 * Returns true if the endpoint has interrupt transfer type and IN direction,
576 * otherwise it returns false.
577 */
usb_endpoint_is_int_in(const struct usb_endpoint_descriptor * epd)578 static inline int usb_endpoint_is_int_in(
579 const struct usb_endpoint_descriptor *epd)
580 {
581 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
582 }
583
584 /**
585 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
586 * @epd: endpoint to be checked
587 *
588 * Returns true if the endpoint has interrupt transfer type and OUT direction,
589 * otherwise it returns false.
590 */
usb_endpoint_is_int_out(const struct usb_endpoint_descriptor * epd)591 static inline int usb_endpoint_is_int_out(
592 const struct usb_endpoint_descriptor *epd)
593 {
594 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
595 }
596
597 /**
598 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
599 * @epd: endpoint to be checked
600 *
601 * Returns true if the endpoint has isochronous transfer type and IN direction,
602 * otherwise it returns false.
603 */
usb_endpoint_is_isoc_in(const struct usb_endpoint_descriptor * epd)604 static inline int usb_endpoint_is_isoc_in(
605 const struct usb_endpoint_descriptor *epd)
606 {
607 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
608 }
609
610 /**
611 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
612 * @epd: endpoint to be checked
613 *
614 * Returns true if the endpoint has isochronous transfer type and OUT direction,
615 * otherwise it returns false.
616 */
usb_endpoint_is_isoc_out(const struct usb_endpoint_descriptor * epd)617 static inline int usb_endpoint_is_isoc_out(
618 const struct usb_endpoint_descriptor *epd)
619 {
620 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
621 }
622
623 /**
624 * usb_endpoint_maxp - get endpoint's max packet size
625 * @epd: endpoint to be checked
626 *
627 * Returns @epd's max packet
628 */
usb_endpoint_maxp(const struct usb_endpoint_descriptor * epd)629 static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd)
630 {
631 return __le16_to_cpu(get_unaligned(&epd->wMaxPacketSize));
632 }
633
634 /**
635 * usb_endpoint_maxp_mult - get endpoint's transactional opportunities
636 * @epd: endpoint to be checked
637 *
638 * Return @epd's wMaxPacketSize[12:11] + 1
639 */
640 static inline int
usb_endpoint_maxp_mult(const struct usb_endpoint_descriptor * epd)641 usb_endpoint_maxp_mult(const struct usb_endpoint_descriptor *epd)
642 {
643 int maxp = __le16_to_cpu(epd->wMaxPacketSize);
644
645 return USB_EP_MAXP_MULT(maxp) + 1;
646 }
647
usb_endpoint_interrupt_type(const struct usb_endpoint_descriptor * epd)648 static inline int usb_endpoint_interrupt_type(
649 const struct usb_endpoint_descriptor *epd)
650 {
651 return epd->bmAttributes & USB_ENDPOINT_INTRTYPE;
652 }
653
654 /*-------------------------------------------------------------------------*/
655
656 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
657 struct usb_ss_ep_comp_descriptor {
658 __u8 bLength;
659 __u8 bDescriptorType;
660
661 __u8 bMaxBurst;
662 __u8 bmAttributes;
663 __le16 wBytesPerInterval;
664 } __attribute__ ((packed));
665
666 #define USB_DT_SS_EP_COMP_SIZE 6
667
668 /* Bits 4:0 of bmAttributes if this is a bulk endpoint */
669 static inline int
usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor * comp)670 usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor *comp)
671 {
672 int max_streams;
673
674 if (!comp)
675 return 0;
676
677 max_streams = comp->bmAttributes & 0x1f;
678
679 if (!max_streams)
680 return 0;
681
682 max_streams = 1 << max_streams;
683
684 return max_streams;
685 }
686
687 /* Bits 1:0 of bmAttributes if this is an isoc endpoint */
688 #define USB_SS_MULT(p) (1 + ((p) & 0x3))
689
690 /*-------------------------------------------------------------------------*/
691
692 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
693 struct usb_qualifier_descriptor {
694 __u8 bLength;
695 __u8 bDescriptorType;
696
697 __le16 bcdUSB;
698 __u8 bDeviceClass;
699 __u8 bDeviceSubClass;
700 __u8 bDeviceProtocol;
701 __u8 bMaxPacketSize0;
702 __u8 bNumConfigurations;
703 __u8 bRESERVED;
704 } __attribute__ ((packed));
705
706
707 /*-------------------------------------------------------------------------*/
708
709 /* USB_DT_OTG (from OTG 1.0a supplement) */
710 struct usb_otg_descriptor {
711 __u8 bLength;
712 __u8 bDescriptorType;
713
714 __u8 bmAttributes; /* support for HNP, SRP, etc */
715 } __attribute__ ((packed));
716
717 /* from usb_otg_descriptor.bmAttributes */
718 #define USB_OTG_SRP (1 << 0)
719 #define USB_OTG_HNP (1 << 1) /* swap host/device roles */
720
721 /*-------------------------------------------------------------------------*/
722
723 /* USB_DT_DEBUG: for special highspeed devices, replacing serial console */
724 struct usb_debug_descriptor {
725 __u8 bLength;
726 __u8 bDescriptorType;
727
728 /* bulk endpoints with 8 byte maxpacket */
729 __u8 bDebugInEndpoint;
730 __u8 bDebugOutEndpoint;
731 } __attribute__((packed));
732
733 /*-------------------------------------------------------------------------*/
734
735 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
736 struct usb_interface_assoc_descriptor {
737 __u8 bLength;
738 __u8 bDescriptorType;
739
740 __u8 bFirstInterface;
741 __u8 bInterfaceCount;
742 __u8 bFunctionClass;
743 __u8 bFunctionSubClass;
744 __u8 bFunctionProtocol;
745 __u8 iFunction;
746 } __attribute__ ((packed));
747
748
749 /*-------------------------------------------------------------------------*/
750
751 /* USB_DT_SECURITY: group of wireless security descriptors, including
752 * encryption types available for setting up a CC/association.
753 */
754 struct usb_security_descriptor {
755 __u8 bLength;
756 __u8 bDescriptorType;
757
758 __le16 wTotalLength;
759 __u8 bNumEncryptionTypes;
760 } __attribute__((packed));
761
762 /*-------------------------------------------------------------------------*/
763
764 /* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys
765 * may be retrieved.
766 */
767 struct usb_key_descriptor {
768 __u8 bLength;
769 __u8 bDescriptorType;
770
771 __u8 tTKID[3];
772 __u8 bReserved;
773 __u8 bKeyData[0];
774 } __attribute__((packed));
775
776 /*-------------------------------------------------------------------------*/
777
778 /* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */
779 struct usb_encryption_descriptor {
780 __u8 bLength;
781 __u8 bDescriptorType;
782
783 __u8 bEncryptionType;
784 #define USB_ENC_TYPE_UNSECURE 0
785 #define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */
786 #define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */
787 #define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */
788 __u8 bEncryptionValue; /* use in SET_ENCRYPTION */
789 __u8 bAuthKeyIndex;
790 } __attribute__((packed));
791
792
793 /*-------------------------------------------------------------------------*/
794
795 /* USB_DT_BOS: group of device-level capabilities */
796 struct usb_bos_descriptor {
797 __u8 bLength;
798 __u8 bDescriptorType;
799
800 __le16 wTotalLength;
801 __u8 bNumDeviceCaps;
802 } __attribute__((packed));
803
804 #define USB_DT_BOS_SIZE 5
805 /*-------------------------------------------------------------------------*/
806
807 /* USB_DT_DEVICE_CAPABILITY: grouped with BOS */
808 struct usb_dev_cap_header {
809 __u8 bLength;
810 __u8 bDescriptorType;
811 __u8 bDevCapabilityType;
812 } __attribute__((packed));
813
814 #define USB_CAP_TYPE_WIRELESS_USB 1
815
816 struct usb_wireless_cap_descriptor { /* Ultra Wide Band */
817 __u8 bLength;
818 __u8 bDescriptorType;
819 __u8 bDevCapabilityType;
820
821 __u8 bmAttributes;
822 #define USB_WIRELESS_P2P_DRD (1 << 1)
823 #define USB_WIRELESS_BEACON_MASK (3 << 2)
824 #define USB_WIRELESS_BEACON_SELF (1 << 2)
825 #define USB_WIRELESS_BEACON_DIRECTED (2 << 2)
826 #define USB_WIRELESS_BEACON_NONE (3 << 2)
827 __le16 wPHYRates; /* bit rates, Mbps */
828 #define USB_WIRELESS_PHY_53 (1 << 0) /* always set */
829 #define USB_WIRELESS_PHY_80 (1 << 1)
830 #define USB_WIRELESS_PHY_107 (1 << 2) /* always set */
831 #define USB_WIRELESS_PHY_160 (1 << 3)
832 #define USB_WIRELESS_PHY_200 (1 << 4) /* always set */
833 #define USB_WIRELESS_PHY_320 (1 << 5)
834 #define USB_WIRELESS_PHY_400 (1 << 6)
835 #define USB_WIRELESS_PHY_480 (1 << 7)
836 __u8 bmTFITXPowerInfo; /* TFI power levels */
837 __u8 bmFFITXPowerInfo; /* FFI power levels */
838 __le16 bmBandGroup;
839 __u8 bReserved;
840 } __attribute__((packed));
841
842 /* USB 2.0 Extension descriptor */
843 #define USB_CAP_TYPE_EXT 2
844
845 struct usb_ext_cap_descriptor { /* Link Power Management */
846 __u8 bLength;
847 __u8 bDescriptorType;
848 __u8 bDevCapabilityType;
849 __le32 bmAttributes;
850 #define USB_LPM_SUPPORT (1 << 1) /* supports LPM */
851 #define USB_BESL_SUPPORT (1 << 2) /* supports BESL */
852 #define USB_BESL_BASELINE_VALID (1 << 3) /* Baseline BESL valid*/
853 #define USB_BESL_DEEP_VALID (1 << 4) /* Deep BESL valid */
854 #define USB_GET_BESL_BASELINE(p) (((p) & (0xf << 8)) >> 8)
855 #define USB_GET_BESL_DEEP(p) (((p) & (0xf << 12)) >> 12)
856 } __attribute__((packed));
857
858 #define USB_DT_USB_EXT_CAP_SIZE 7
859
860 /*
861 * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
862 * specific device level capabilities
863 */
864 #define USB_SS_CAP_TYPE 3
865 struct usb_ss_cap_descriptor { /* Link Power Management */
866 __u8 bLength;
867 __u8 bDescriptorType;
868 __u8 bDevCapabilityType;
869 __u8 bmAttributes;
870 #define USB_LTM_SUPPORT (1 << 1) /* supports LTM */
871 __le16 wSpeedSupported;
872 #define USB_LOW_SPEED_OPERATION (1) /* Low speed operation */
873 #define USB_FULL_SPEED_OPERATION (1 << 1) /* Full speed operation */
874 #define USB_HIGH_SPEED_OPERATION (1 << 2) /* High speed operation */
875 #define USB_5GBPS_OPERATION (1 << 3) /* Operation at 5Gbps */
876 __u8 bFunctionalitySupport;
877 __u8 bU1devExitLat;
878 __le16 bU2DevExitLat;
879 } __attribute__((packed));
880
881 #define USB_DEFAULT_U1_DEV_EXIT_LAT 0x01 /* Less then 1 microsec */
882 #define USB_DEFAULT_U2_DEV_EXIT_LAT 0x01F4 /* Less then 500 microsec */
883
884 #define USB_DT_USB_SS_CAP_SIZE 10
885
886 /*
887 * Container ID Capability descriptor: Defines the instance unique ID used to
888 * identify the instance across all operating modes
889 */
890 #define CONTAINER_ID_TYPE 4
891 struct usb_ss_container_id_descriptor {
892 __u8 bLength;
893 __u8 bDescriptorType;
894 __u8 bDevCapabilityType;
895 __u8 bReserved;
896 __u8 ContainerID[16]; /* 128-bit number */
897 } __attribute__((packed));
898
899 #define USB_DT_USB_SS_CONTN_ID_SIZE 20
900 /*-------------------------------------------------------------------------*/
901
902 /* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with
903 * each endpoint descriptor for a wireless device
904 */
905 struct usb_wireless_ep_comp_descriptor {
906 __u8 bLength;
907 __u8 bDescriptorType;
908
909 __u8 bMaxBurst;
910 __u8 bMaxSequence;
911 __le16 wMaxStreamDelay;
912 __le16 wOverTheAirPacketSize;
913 __u8 bOverTheAirInterval;
914 __u8 bmCompAttributes;
915 #define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */
916 #define USB_ENDPOINT_SWITCH_NO 0
917 #define USB_ENDPOINT_SWITCH_SWITCH 1
918 #define USB_ENDPOINT_SWITCH_SCALE 2
919 } __attribute__((packed));
920
921 /*-------------------------------------------------------------------------*/
922
923 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
924 * host and a device for connection set up, mutual authentication, and
925 * exchanging short lived session keys. The handshake depends on a CC.
926 */
927 struct usb_handshake {
928 __u8 bMessageNumber;
929 __u8 bStatus;
930 __u8 tTKID[3];
931 __u8 bReserved;
932 __u8 CDID[16];
933 __u8 nonce[16];
934 __u8 MIC[8];
935 } __attribute__((packed));
936
937 /*-------------------------------------------------------------------------*/
938
939 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
940 * A CC may also be set up using non-wireless secure channels (including
941 * wired USB!), and some devices may support CCs with multiple hosts.
942 */
943 struct usb_connection_context {
944 __u8 CHID[16]; /* persistent host id */
945 __u8 CDID[16]; /* device id (unique w/in host context) */
946 __u8 CK[16]; /* connection key */
947 } __attribute__((packed));
948
949 /*-------------------------------------------------------------------------*/
950
951 /* USB 2.0 defines three speeds, here's how Linux identifies them */
952
953 enum usb_device_speed {
954 USB_SPEED_UNKNOWN = 0, /* enumerating */
955 USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */
956 USB_SPEED_HIGH, /* usb 2.0 */
957 USB_SPEED_WIRELESS, /* wireless (usb 2.5) */
958 USB_SPEED_SUPER, /* usb 3.0 */
959 USB_SPEED_SUPER_PLUS, /* usb 3.1 */
960 };
961
962 /**
963 * usb_speed_string() - Returns human readable-name of the speed.
964 * @speed: The speed to return human-readable name for. If it's not
965 * any of the speeds defined in usb_device_speed enum, string for
966 * USB_SPEED_UNKNOWN will be returned.
967 */
968 extern const char *usb_speed_string(enum usb_device_speed speed);
969
970 enum usb_device_state {
971 /* NOTATTACHED isn't in the USB spec, and this state acts
972 * the same as ATTACHED ... but it's clearer this way.
973 */
974 USB_STATE_NOTATTACHED = 0,
975
976 /* chapter 9 and authentication (wireless) device states */
977 USB_STATE_ATTACHED,
978 USB_STATE_POWERED, /* wired */
979 USB_STATE_RECONNECTING, /* auth */
980 USB_STATE_UNAUTHENTICATED, /* auth */
981 USB_STATE_DEFAULT, /* limited function */
982 USB_STATE_ADDRESS,
983 USB_STATE_CONFIGURED, /* most functions */
984
985 USB_STATE_SUSPENDED
986
987 /* NOTE: there are actually four different SUSPENDED
988 * states, returning to POWERED, DEFAULT, ADDRESS, or
989 * CONFIGURED respectively when SOF tokens flow again.
990 * At this level there's no difference between L1 and L2
991 * suspend states. (L2 being original USB 1.1 suspend.)
992 */
993 };
994
995 enum usb3_link_state {
996 USB3_LPM_U0 = 0,
997 USB3_LPM_U1,
998 USB3_LPM_U2,
999 USB3_LPM_U3
1000 };
1001
1002 /*
1003 * A U1 timeout of 0x0 means the parent hub will reject any transitions to U1.
1004 * 0xff means the parent hub will accept transitions to U1, but will not
1005 * initiate a transition.
1006 *
1007 * A U1 timeout of 0x1 to 0x7F also causes the hub to initiate a transition to
1008 * U1 after that many microseconds. Timeouts of 0x80 to 0xFE are reserved
1009 * values.
1010 *
1011 * A U2 timeout of 0x0 means the parent hub will reject any transitions to U2.
1012 * 0xff means the parent hub will accept transitions to U2, but will not
1013 * initiate a transition.
1014 *
1015 * A U2 timeout of 0x1 to 0xFE also causes the hub to initiate a transition to
1016 * U2 after N*256 microseconds. Therefore a U2 timeout value of 0x1 means a U2
1017 * idle timer of 256 microseconds, 0x2 means 512 microseconds, 0xFE means
1018 * 65.024ms.
1019 */
1020 #define USB3_LPM_DISABLED 0x0
1021 #define USB3_LPM_U1_MAX_TIMEOUT 0x7F
1022 #define USB3_LPM_U2_MAX_TIMEOUT 0xFE
1023 #define USB3_LPM_DEVICE_INITIATED 0xFF
1024
1025 struct usb_set_sel_req {
1026 __u8 u1_sel;
1027 __u8 u1_pel;
1028 __le16 u2_sel;
1029 __le16 u2_pel;
1030 } __attribute__ ((packed));
1031
1032 /*
1033 * The Set System Exit Latency control transfer provides one byte each for
1034 * U1 SEL and U1 PEL, so the max exit latency is 0xFF. U2 SEL and U2 PEL each
1035 * are two bytes long.
1036 */
1037 #define USB3_LPM_MAX_U1_SEL_PEL 0xFF
1038 #define USB3_LPM_MAX_U2_SEL_PEL 0xFFFF
1039
1040 /*-------------------------------------------------------------------------*/
1041
1042 /*
1043 * As per USB compliance update, a device that is actively drawing
1044 * more than 100mA from USB must report itself as bus-powered in
1045 * the GetStatus(DEVICE) call.
1046 * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34
1047 */
1048 #define USB_SELF_POWER_VBUS_MAX_DRAW 100
1049
1050 /**
1051 * struct usb_string - wraps a C string and its USB id
1052 * @id:the (nonzero) ID for this string
1053 * @s:the string, in UTF-8 encoding
1054 *
1055 * If you're using usb_gadget_get_string(), use this to wrap a string
1056 * together with its ID.
1057 */
1058 struct usb_string {
1059 u8 id;
1060 const char *s;
1061 };
1062
1063 #endif /* __LINUX_USB_CH9_H */
1064