blob: ce4ae8832ac73e222557a7af87814b319b6fefbd [file] [log] [blame]
lh9ed821d2023-04-07 01:36:19 -07001/*
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#if 0
37#include <linux/types.h> /* __u8 etc */
38#include <asm/byteorder.h> /* le16_to_cpu */
39#endif
40#include "types.h"
41#include "usbhost_swab.h"
42/*-------------------------------------------------------------------------*/
43
44/* CONTROL REQUEST SUPPORT */
45
46/*
47 * USB directions
48 *
49 * This bit flag is used in endpoint descriptors' bEndpointAddress field.
50 * It's also one of three fields in control requests bRequestType.
51 */
52#define USB_DIR_OUT 0 /* to device */
53#define USB_DIR_IN 0x80 /* to host */
54
55/*
56 * USB types, the second of three bRequestType fields
57 */
58#define USB_TYPE_MASK (0x03 << 5)
59#define USB_TYPE_STANDARD (0x00 << 5)
60#define USB_TYPE_CLASS (0x01 << 5)
61#define USB_TYPE_VENDOR (0x02 << 5)
62#define USB_TYPE_RESERVED (0x03 << 5)
63
64/*
65 * USB recipients, the third of three bRequestType fields
66 */
67#define USB_RECIP_MASK 0x1f
68#define USB_RECIP_DEVICE 0x00
69#define USB_RECIP_INTERFACE 0x01
70#define USB_RECIP_ENDPOINT 0x02
71#define USB_RECIP_OTHER 0x03
72/* From Wireless USB 1.0 */
73#define USB_RECIP_PORT 0x04
74#define USB_RECIP_RPIPE 0x05
75
76/*
77 * Standard requests, for the bRequest field of a SETUP packet.
78 *
79 * These are qualified by the bRequestType field, so that for example
80 * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved
81 * by a GET_STATUS request.
82 */
83#define USB_REQ_GET_STATUS 0x00
84#define USB_REQ_CLEAR_FEATURE 0x01
85#define USB_REQ_SET_FEATURE 0x03
86#define USB_REQ_SET_ADDRESS 0x05
87#define USB_REQ_GET_DESCRIPTOR 0x06
88#define USB_REQ_SET_DESCRIPTOR 0x07
89#define USB_REQ_GET_CONFIGURATION 0x08
90#define USB_REQ_SET_CONFIGURATION 0x09
91#define USB_REQ_GET_INTERFACE 0x0A
92#define USB_REQ_SET_INTERFACE 0x0B
93#define USB_REQ_SYNCH_FRAME 0x0C
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 */
180struct 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
233/* Conventional codes for class-specific descriptors. The convention is
234 * defined in the USB "Common Class" Spec (3.11). Individual class specs
235 * are authoritative for their usage, not the "common class" writeup.
236 */
237#define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE)
238#define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG)
239#define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING)
240#define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE)
241#define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT)
242
243/* All standard descriptors have these 2 fields at the beginning */
244struct usb_descriptor_header {
245 __u8 bLength;
246 __u8 bDescriptorType;
247} __attribute__ ((packed));
248
249
250/*-------------------------------------------------------------------------*/
251
252/* USB_DT_DEVICE: Device descriptor */
253struct usb_device_descriptor {
254 __u8 bLength;
255 __u8 bDescriptorType;
256
257 __le16 bcdUSB;
258 __u8 bDeviceClass;
259 __u8 bDeviceSubClass;
260 __u8 bDeviceProtocol;
261 __u8 bMaxPacketSize0;
262 __le16 idVendor;
263 __le16 idProduct;
264 __le16 bcdDevice;
265 __u8 iManufacturer;
266 __u8 iProduct;
267 __u8 iSerialNumber;
268 __u8 bNumConfigurations;
269} __attribute__ ((packed));
270
271#define USB_DT_DEVICE_SIZE 18
272
273
274/*
275 * Device and/or Interface Class codes
276 * as found in bDeviceClass or bInterfaceClass
277 * and defined by www.usb.org documents
278 */
279#define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
280#define USB_CLASS_AUDIO 1
281#define USB_CLASS_COMM 2
282#define USB_CLASS_HID 3
283#define USB_CLASS_PHYSICAL 5
284#define USB_CLASS_STILL_IMAGE 6
285#define USB_CLASS_PRINTER 7
286#define USB_CLASS_MASS_STORAGE 8
287#define USB_CLASS_HUB 9
288#define USB_CLASS_CDC_DATA 0x0a
289#define USB_CLASS_CSCID 0x0b /* chip+ smart card */
290#define USB_CLASS_CONTENT_SEC 0x0d /* content security */
291#define USB_CLASS_VIDEO 0x0e
292#define USB_CLASS_WIRELESS_CONTROLLER 0xe0
293#define USB_CLASS_MISC 0xef
294#define USB_CLASS_APP_SPEC 0xfe
295#define USB_CLASS_VENDOR_SPEC 0xff
296
297#define USB_SUBCLASS_VENDOR_SPEC 0xff
298
299/*-------------------------------------------------------------------------*/
300
301/* USB_DT_CONFIG: Configuration descriptor information.
302 *
303 * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
304 * descriptor type is different. Highspeed-capable devices can look
305 * different depending on what speed they're currently running. Only
306 * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
307 * descriptors.
308 */
309struct usb_config_descriptor {
310 __u8 bLength;
311 __u8 bDescriptorType;
312
313 __le16 wTotalLength;
314 __u8 bNumInterfaces;
315 __u8 bConfigurationValue;
316 __u8 iConfiguration;
317 __u8 bmAttributes;
318 __u8 bMaxPower;
319} __attribute__ ((packed));
320
321#define USB_DT_CONFIG_SIZE 9
322
323/* from config descriptor bmAttributes */
324#define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */
325#define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */
326#define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */
327#define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */
328
329/*-------------------------------------------------------------------------*/
330
331/* USB_DT_STRING: String descriptor */
332struct usb_string_descriptor {
333 __u8 bLength;
334 __u8 bDescriptorType;
335
336 __le16 wData[1]; /* UTF-16LE encoded */
337} __attribute__ ((packed));
338
339/* note that "string" zero is special, it holds language codes that
340 * the device supports, not Unicode characters.
341 */
342
343/*-------------------------------------------------------------------------*/
344
345/* USB_DT_INTERFACE: Interface descriptor */
346struct usb_interface_descriptor {
347 __u8 bLength;
348 __u8 bDescriptorType;
349
350 __u8 bInterfaceNumber;
351 __u8 bAlternateSetting;
352 __u8 bNumEndpoints;
353 __u8 bInterfaceClass;
354 __u8 bInterfaceSubClass;
355 __u8 bInterfaceProtocol;
356 __u8 iInterface;
357} __attribute__ ((packed));
358
359#define USB_DT_INTERFACE_SIZE 9
360
361/*-------------------------------------------------------------------------*/
362
363/* USB_DT_ENDPOINT: Endpoint descriptor */
364struct usb_endpoint_descriptor {
365 __u8 bLength;
366 __u8 bDescriptorType;
367
368 __u8 bEndpointAddress;
369 __u8 bmAttributes;
370 __le16 wMaxPacketSize;
371 __u8 bInterval;
372
373 /* NOTE: these two are _only_ in audio endpoints. */
374 /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
375 __u8 bRefresh;
376 __u8 bSynchAddress;
377} __attribute__ ((packed));
378
379#define USB_DT_ENDPOINT_SIZE 7
380#define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
381
382
383/*
384 * Endpoints
385 */
386#define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
387#define USB_ENDPOINT_DIR_MASK 0x80
388
389#define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
390#define USB_ENDPOINT_XFER_CONTROL 0
391#define USB_ENDPOINT_XFER_ISOC 1
392#define USB_ENDPOINT_XFER_BULK 2
393#define USB_ENDPOINT_XFER_INT 3
394#define USB_ENDPOINT_MAX_ADJUSTABLE 0x80
395
396#define USB_ENDPOINT_SYNCTYPE 0x0c
397#define USB_ENDPOINT_SYNC_NONE (0 << 2)
398#define USB_ENDPOINT_SYNC_ASYNC (1 << 2)
399#define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2)
400#define USB_ENDPOINT_SYNC_SYNC (3 << 2)
401
402#define USB_ENDPOINT_USAGE_MASK 0x30
403#define USB_ENDPOINT_USAGE_DATA 0x00
404#define USB_ENDPOINT_USAGE_FEEDBACK 0x10
405#define USB_ENDPOINT_USAGE_IMPLICIT_FB 0x20 /* Implicit feedback Data endpoint */
406
407/*-------------------------------------------------------------------------*/
408
409/**
410 * usb_endpoint_num - get the endpoint's number
411 * @epd: endpoint to be checked
412 *
413 * Returns @epd's number: 0 to 15.
414 */
415static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
416{
417 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
418}
419
420/**
421 * usb_endpoint_type - get the endpoint's transfer type
422 * @epd: endpoint to be checked
423 *
424 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
425 * to @epd's transfer type.
426 */
427static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
428{
429 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
430}
431
432/**
433 * usb_endpoint_dir_in - check if the endpoint has IN direction
434 * @epd: endpoint to be checked
435 *
436 * Returns true if the endpoint is of type IN, otherwise it returns false.
437 */
438static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
439{
440 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
441}
442
443/**
444 * usb_endpoint_dir_out - check if the endpoint has OUT direction
445 * @epd: endpoint to be checked
446 *
447 * Returns true if the endpoint is of type OUT, otherwise it returns false.
448 */
449static inline int usb_endpoint_dir_out(
450 const struct usb_endpoint_descriptor *epd)
451{
452 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
453}
454
455/**
456 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
457 * @epd: endpoint to be checked
458 *
459 * Returns true if the endpoint is of type bulk, otherwise it returns false.
460 */
461static inline int usb_endpoint_xfer_bulk(
462 const struct usb_endpoint_descriptor *epd)
463{
464 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
465 USB_ENDPOINT_XFER_BULK);
466}
467
468/**
469 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
470 * @epd: endpoint to be checked
471 *
472 * Returns true if the endpoint is of type control, otherwise it returns false.
473 */
474static inline int usb_endpoint_xfer_control(
475 const struct usb_endpoint_descriptor *epd)
476{
477 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
478 USB_ENDPOINT_XFER_CONTROL);
479}
480
481/**
482 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
483 * @epd: endpoint to be checked
484 *
485 * Returns true if the endpoint is of type interrupt, otherwise it returns
486 * false.
487 */
488static inline int usb_endpoint_xfer_int(
489 const struct usb_endpoint_descriptor *epd)
490{
491 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
492 USB_ENDPOINT_XFER_INT);
493}
494
495/**
496 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
497 * @epd: endpoint to be checked
498 *
499 * Returns true if the endpoint is of type isochronous, otherwise it returns
500 * false.
501 */
502static inline int usb_endpoint_xfer_isoc(
503 const struct usb_endpoint_descriptor *epd)
504{
505 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
506 USB_ENDPOINT_XFER_ISOC);
507}
508
509/**
510 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
511 * @epd: endpoint to be checked
512 *
513 * Returns true if the endpoint has bulk transfer type and IN direction,
514 * otherwise it returns false.
515 */
516static inline int usb_endpoint_is_bulk_in(
517 const struct usb_endpoint_descriptor *epd)
518{
519 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
520}
521
522/**
523 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
524 * @epd: endpoint to be checked
525 *
526 * Returns true if the endpoint has bulk transfer type and OUT direction,
527 * otherwise it returns false.
528 */
529static inline int usb_endpoint_is_bulk_out(
530 const struct usb_endpoint_descriptor *epd)
531{
532 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
533}
534
535/**
536 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
537 * @epd: endpoint to be checked
538 *
539 * Returns true if the endpoint has interrupt transfer type and IN direction,
540 * otherwise it returns false.
541 */
542static inline int usb_endpoint_is_int_in(
543 const struct usb_endpoint_descriptor *epd)
544{
545 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
546}
547
548/**
549 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
550 * @epd: endpoint to be checked
551 *
552 * Returns true if the endpoint has interrupt transfer type and OUT direction,
553 * otherwise it returns false.
554 */
555static inline int usb_endpoint_is_int_out(
556 const struct usb_endpoint_descriptor *epd)
557{
558 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
559}
560
561/**
562 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
563 * @epd: endpoint to be checked
564 *
565 * Returns true if the endpoint has isochronous transfer type and IN direction,
566 * otherwise it returns false.
567 */
568static inline int usb_endpoint_is_isoc_in(
569 const struct usb_endpoint_descriptor *epd)
570{
571 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
572}
573
574/**
575 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
576 * @epd: endpoint to be checked
577 *
578 * Returns true if the endpoint has isochronous transfer type and OUT direction,
579 * otherwise it returns false.
580 */
581static inline int usb_endpoint_is_isoc_out(
582 const struct usb_endpoint_descriptor *epd)
583{
584 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
585}
586
587/**
588 * usb_endpoint_maxp - get endpoint's max packet size
589 * @epd: endpoint to be checked
590 *
591 * Returns @epd's max packet
592 */
593static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd)
594{
595 return __le16_to_cpu(epd->wMaxPacketSize);
596}
597
598/*-------------------------------------------------------------------------*/
599
600/* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
601struct usb_ss_ep_comp_descriptor {
602 __u8 bLength;
603 __u8 bDescriptorType;
604
605 __u8 bMaxBurst;
606 __u8 bmAttributes;
607 __le16 wBytesPerInterval;
608} __attribute__ ((packed));
609
610#define USB_DT_SS_EP_COMP_SIZE 6
611
612/* Bits 4:0 of bmAttributes if this is a bulk endpoint */
613static inline int
614usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor *comp)
615{
616 int max_streams;
617
618 if (!comp)
619 return 0;
620
621 max_streams = comp->bmAttributes & 0x1f;
622
623 if (!max_streams)
624 return 0;
625
626 max_streams = 1 << max_streams;
627
628 return max_streams;
629}
630
631/* Bits 1:0 of bmAttributes if this is an isoc endpoint */
632#define USB_SS_MULT(p) (1 + ((p) & 0x3))
633
634/*-------------------------------------------------------------------------*/
635
636/* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
637struct usb_qualifier_descriptor {
638 __u8 bLength;
639 __u8 bDescriptorType;
640
641 __le16 bcdUSB;
642 __u8 bDeviceClass;
643 __u8 bDeviceSubClass;
644 __u8 bDeviceProtocol;
645 __u8 bMaxPacketSize0;
646 __u8 bNumConfigurations;
647 __u8 bRESERVED;
648} __attribute__ ((packed));
649
650
651/*-------------------------------------------------------------------------*/
652
653/* USB_DT_OTG (from OTG 1.0a supplement) */
654struct usb_otg_descriptor {
655 __u8 bLength;
656 __u8 bDescriptorType;
657
658 __u8 bmAttributes; /* support for HNP, SRP, etc */
659} __attribute__ ((packed));
660
661/* from usb_otg_descriptor.bmAttributes */
662#define USB_OTG_SRP (1 << 0)
663#define USB_OTG_HNP (1 << 1) /* swap host/device roles */
664
665/*-------------------------------------------------------------------------*/
666
667/* USB_DT_DEBUG: for special highspeed devices, replacing serial console */
668struct usb_debug_descriptor {
669 __u8 bLength;
670 __u8 bDescriptorType;
671
672 /* bulk endpoints with 8 byte maxpacket */
673 __u8 bDebugInEndpoint;
674 __u8 bDebugOutEndpoint;
675} __attribute__((packed));
676
677/*-------------------------------------------------------------------------*/
678
679/* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
680struct usb_interface_assoc_descriptor {
681 __u8 bLength;
682 __u8 bDescriptorType;
683
684 __u8 bFirstInterface;
685 __u8 bInterfaceCount;
686 __u8 bFunctionClass;
687 __u8 bFunctionSubClass;
688 __u8 bFunctionProtocol;
689 __u8 iFunction;
690} __attribute__ ((packed));
691
692
693/*-------------------------------------------------------------------------*/
694
695/* USB_DT_SECURITY: group of wireless security descriptors, including
696 * encryption types available for setting up a CC/association.
697 */
698struct usb_security_descriptor {
699 __u8 bLength;
700 __u8 bDescriptorType;
701
702 __le16 wTotalLength;
703 __u8 bNumEncryptionTypes;
704} __attribute__((packed));
705
706/*-------------------------------------------------------------------------*/
707
708/* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys
709 * may be retrieved.
710 */
711struct usb_key_descriptor {
712 __u8 bLength;
713 __u8 bDescriptorType;
714
715 __u8 tTKID[3];
716 __u8 bReserved;
717 __u8 bKeyData[0];
718} __attribute__((packed));
719
720/*-------------------------------------------------------------------------*/
721
722/* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */
723struct usb_encryption_descriptor {
724 __u8 bLength;
725 __u8 bDescriptorType;
726
727 __u8 bEncryptionType;
728#define USB_ENC_TYPE_UNSECURE 0
729#define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */
730#define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */
731#define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */
732 __u8 bEncryptionValue; /* use in SET_ENCRYPTION */
733 __u8 bAuthKeyIndex;
734} __attribute__((packed));
735
736
737/*-------------------------------------------------------------------------*/
738
739/* USB_DT_BOS: group of device-level capabilities */
740struct usb_bos_descriptor {
741 __u8 bLength;
742 __u8 bDescriptorType;
743
744 __le16 wTotalLength;
745 __u8 bNumDeviceCaps;
746} __attribute__((packed));
747
748#define USB_DT_BOS_SIZE 5
749/*-------------------------------------------------------------------------*/
750
751/* USB_DT_DEVICE_CAPABILITY: grouped with BOS */
752struct usb_dev_cap_header {
753 __u8 bLength;
754 __u8 bDescriptorType;
755 __u8 bDevCapabilityType;
756} __attribute__((packed));
757
758#define USB_CAP_TYPE_WIRELESS_USB 1
759
760struct usb_wireless_cap_descriptor { /* Ultra Wide Band */
761 __u8 bLength;
762 __u8 bDescriptorType;
763 __u8 bDevCapabilityType;
764
765 __u8 bmAttributes;
766#define USB_WIRELESS_P2P_DRD (1 << 1)
767#define USB_WIRELESS_BEACON_MASK (3 << 2)
768#define USB_WIRELESS_BEACON_SELF (1 << 2)
769#define USB_WIRELESS_BEACON_DIRECTED (2 << 2)
770#define USB_WIRELESS_BEACON_NONE (3 << 2)
771 __le16 wPHYRates; /* bit rates, Mbps */
772#define USB_WIRELESS_PHY_53 (1 << 0) /* always set */
773#define USB_WIRELESS_PHY_80 (1 << 1)
774#define USB_WIRELESS_PHY_107 (1 << 2) /* always set */
775#define USB_WIRELESS_PHY_160 (1 << 3)
776#define USB_WIRELESS_PHY_200 (1 << 4) /* always set */
777#define USB_WIRELESS_PHY_320 (1 << 5)
778#define USB_WIRELESS_PHY_400 (1 << 6)
779#define USB_WIRELESS_PHY_480 (1 << 7)
780 __u8 bmTFITXPowerInfo; /* TFI power levels */
781 __u8 bmFFITXPowerInfo; /* FFI power levels */
782 __le16 bmBandGroup;
783 __u8 bReserved;
784} __attribute__((packed));
785
786/* USB 2.0 Extension descriptor */
787#define USB_CAP_TYPE_EXT 2
788
789struct usb_ext_cap_descriptor { /* Link Power Management */
790 __u8 bLength;
791 __u8 bDescriptorType;
792 __u8 bDevCapabilityType;
793 __le32 bmAttributes;
794#define USB_LPM_SUPPORT (1 << 1) /* supports LPM */
795#define USB_BESL_SUPPORT (1 << 2) /* supports BESL */
796#define USB_BESL_BASELINE_VALID (1 << 3) /* Baseline BESL valid*/
797#define USB_BESL_DEEP_VALID (1 << 4) /* Deep BESL valid */
798#define USB_GET_BESL_BASELINE(p) (((p) & (0xf << 8)) >> 8)
799#define USB_GET_BESL_DEEP(p) (((p) & (0xf << 12)) >> 12)
800} __attribute__((packed));
801
802#define USB_DT_USB_EXT_CAP_SIZE 7
803
804/*
805 * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
806 * specific device level capabilities
807 */
808#define USB_SS_CAP_TYPE 3
809struct usb_ss_cap_descriptor { /* Link Power Management */
810 __u8 bLength;
811 __u8 bDescriptorType;
812 __u8 bDevCapabilityType;
813 __u8 bmAttributes;
814#define USB_LTM_SUPPORT (1 << 1) /* supports LTM */
815 __le16 wSpeedSupported;
816#define USB_LOW_SPEED_OPERATION (1) /* Low speed operation */
817#define USB_FULL_SPEED_OPERATION (1 << 1) /* Full speed operation */
818#define USB_HIGH_SPEED_OPERATION (1 << 2) /* High speed operation */
819#define USB_5GBPS_OPERATION (1 << 3) /* Operation at 5Gbps */
820 __u8 bFunctionalitySupport;
821 __u8 bU1devExitLat;
822 __le16 bU2DevExitLat;
823} __attribute__((packed));
824
825#define USB_DT_USB_SS_CAP_SIZE 10
826
827/*
828 * Container ID Capability descriptor: Defines the instance unique ID used to
829 * identify the instance across all operating modes
830 */
831#define CONTAINER_ID_TYPE 4
832struct usb_ss_container_id_descriptor {
833 __u8 bLength;
834 __u8 bDescriptorType;
835 __u8 bDevCapabilityType;
836 __u8 bReserved;
837 __u8 ContainerID[16]; /* 128-bit number */
838} __attribute__((packed));
839
840#define USB_DT_USB_SS_CONTN_ID_SIZE 20
841/*-------------------------------------------------------------------------*/
842
843/* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with
844 * each endpoint descriptor for a wireless device
845 */
846struct usb_wireless_ep_comp_descriptor {
847 __u8 bLength;
848 __u8 bDescriptorType;
849
850 __u8 bMaxBurst;
851 __u8 bMaxSequence;
852 __le16 wMaxStreamDelay;
853 __le16 wOverTheAirPacketSize;
854 __u8 bOverTheAirInterval;
855 __u8 bmCompAttributes;
856#define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */
857#define USB_ENDPOINT_SWITCH_NO 0
858#define USB_ENDPOINT_SWITCH_SWITCH 1
859#define USB_ENDPOINT_SWITCH_SCALE 2
860} __attribute__((packed));
861
862/*-------------------------------------------------------------------------*/
863
864/* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
865 * host and a device for connection set up, mutual authentication, and
866 * exchanging short lived session keys. The handshake depends on a CC.
867 */
868struct usb_handshake {
869 __u8 bMessageNumber;
870 __u8 bStatus;
871 __u8 tTKID[3];
872 __u8 bReserved;
873 __u8 CDID[16];
874 __u8 nonce[16];
875 __u8 MIC[8];
876} __attribute__((packed));
877
878/*-------------------------------------------------------------------------*/
879
880/* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
881 * A CC may also be set up using non-wireless secure channels (including
882 * wired USB!), and some devices may support CCs with multiple hosts.
883 */
884struct usb_connection_context {
885 __u8 CHID[16]; /* persistent host id */
886 __u8 CDID[16]; /* device id (unique w/in host context) */
887 __u8 CK[16]; /* connection key */
888} __attribute__((packed));
889
890/*-------------------------------------------------------------------------*/
891
892/* USB 2.0 defines three speeds, here's how Linux identifies them */
893
894enum usb_device_speed {
895 USB_SPEED_UNKNOWN = 0, /* enumerating */
896 USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */
897 USB_SPEED_HIGH, /* usb 2.0 */
898 USB_SPEED_WIRELESS, /* wireless (usb 2.5) */
899 USB_SPEED_SUPER, /* usb 3.0 */
900};
901
902#ifdef __KERNEL__
903
904/**
905 * usb_speed_string() - Returns human readable-name of the speed.
906 * @speed: The speed to return human-readable name for. If it's not
907 * any of the speeds defined in usb_device_speed enum, string for
908 * USB_SPEED_UNKNOWN will be returned.
909 */
910extern const char *usb_speed_string(enum usb_device_speed speed);
911
912#endif
913
914enum usb_device_state {
915 /* NOTATTACHED isn't in the USB spec, and this state acts
916 * the same as ATTACHED ... but it's clearer this way.
917 */
918 USB_STATE_NOTATTACHED = 0,
919
920 /* chapter 9 and authentication (wireless) device states */
921 USB_STATE_ATTACHED,
922 USB_STATE_POWERED, /* wired */
923 USB_STATE_RECONNECTING, /* auth */
924 USB_STATE_UNAUTHENTICATED, /* auth */
925 USB_STATE_DEFAULT, /* limited function */
926 USB_STATE_ADDRESS,
927 USB_STATE_CONFIGURED, /* most functions */
928
929 USB_STATE_SUSPENDED
930
931 /* NOTE: there are actually four different SUSPENDED
932 * states, returning to POWERED, DEFAULT, ADDRESS, or
933 * CONFIGURED respectively when SOF tokens flow again.
934 * At this level there's no difference between L1 and L2
935 * suspend states. (L2 being original USB 1.1 suspend.)
936 */
937};
938
939/*-------------------------------------------------------------------------*/
940
941/*
942 * As per USB compliance update, a device that is actively drawing
943 * more than 100mA from USB must report itself as bus-powered in
944 * the GetStatus(DEVICE) call.
945 * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34
946 */
947#define USB_SELF_POWER_VBUS_MAX_DRAW 100
948
949#endif /* __LINUX_USB_CH9_H */