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