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