Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
672027a3 IPG |
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: | |
1da177e4 LT |
7 | * |
8 | * - the master/host side Linux-USB kernel driver API; | |
9 | * - the "usbfs" user space API; and | |
5da0106f | 10 | * - the Linux "gadget" slave/device/peripheral side driver API. |
1da177e4 LT |
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 | |
5da0106f DB |
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. | |
672027a3 IPG |
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. | |
1da177e4 LT |
31 | */ |
32 | ||
33 | #ifndef __LINUX_USB_CH9_H | |
34 | #define __LINUX_USB_CH9_H | |
35 | ||
4cceb4d1 | 36 | #include <linux/types.h> /* __u8 etc */ |
939f325f | 37 | #include <asm/byteorder.h> /* le16_to_cpu */ |
1da177e4 LT |
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 | |
5b5daf77 | 69 | /* From Wireless USB 1.0 */ |
dbe0dbb7 DB |
70 | #define USB_RECIP_PORT 0x04 |
71 | #define USB_RECIP_RPIPE 0x05 | |
1da177e4 LT |
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 | ||
5da0106f DB |
92 | #define USB_REQ_SET_ENCRYPTION 0x0D /* Wireless USB */ |
93 | #define USB_REQ_GET_ENCRYPTION 0x0E | |
5b5daf77 | 94 | #define USB_REQ_RPIPE_ABORT 0x0E |
5da0106f | 95 | #define USB_REQ_SET_HANDSHAKE 0x0F |
5b5daf77 | 96 | #define USB_REQ_RPIPE_RESET 0x0F |
5da0106f DB |
97 | #define USB_REQ_GET_HANDSHAKE 0x10 |
98 | #define USB_REQ_SET_CONNECTION 0x11 | |
99 | #define USB_REQ_SET_SECURITY_DATA 0x12 | |
100 | #define USB_REQ_GET_SECURITY_DATA 0x13 | |
101 | #define USB_REQ_SET_WUSB_DATA 0x14 | |
102 | #define USB_REQ_LOOPBACK_DATA_WRITE 0x15 | |
103 | #define USB_REQ_LOOPBACK_DATA_READ 0x16 | |
104 | #define USB_REQ_SET_INTERFACE_DS 0x17 | |
105 | ||
64a3a25f | 106 | /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command, |
dbe0dbb7 DB |
107 | * used by hubs to put ports into a new L1 suspend state, except that it |
108 | * forgot to define its number ... | |
109 | */ | |
110 | ||
1da177e4 LT |
111 | /* |
112 | * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and | |
113 | * are read as a bit array returned by USB_REQ_GET_STATUS. (So there | |
dbe0dbb7 DB |
114 | * are at most sixteen features of each type.) Hubs may also support a |
115 | * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend. | |
1da177e4 LT |
116 | */ |
117 | #define USB_DEVICE_SELF_POWERED 0 /* (read only) */ | |
118 | #define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */ | |
5da0106f DB |
119 | #define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */ |
120 | #define USB_DEVICE_BATTERY 2 /* (wireless) */ | |
121 | #define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */ | |
122 | #define USB_DEVICE_WUSB_DEVICE 3 /* (wireless)*/ | |
123 | #define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */ | |
124 | #define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */ | |
1da177e4 LT |
125 | #define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */ |
126 | ||
7fc56f0d LA |
127 | /* |
128 | * Test Mode Selectors | |
129 | * See USB 2.0 spec Table 9-7 | |
130 | */ | |
131 | #define TEST_J 1 | |
132 | #define TEST_K 2 | |
133 | #define TEST_SE0_NAK 3 | |
134 | #define TEST_PACKET 4 | |
135 | #define TEST_FORCE_EN 5 | |
136 | ||
562e7c71 TB |
137 | /* |
138 | * New Feature Selectors as added by USB 3.0 | |
139 | * See USB 3.0 spec Table 9-6 | |
140 | */ | |
141 | #define USB_DEVICE_U1_ENABLE 48 /* dev may initiate U1 transition */ | |
142 | #define USB_DEVICE_U2_ENABLE 49 /* dev may initiate U2 transition */ | |
143 | #define USB_DEVICE_LTM_ENABLE 50 /* dev may send LTM */ | |
144 | #define USB_INTRF_FUNC_SUSPEND 0 /* function suspend */ | |
145 | ||
146 | #define USB_INTR_FUNC_SUSPEND_OPT_MASK 0xFF00 | |
147 | ||
1da177e4 LT |
148 | #define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */ |
149 | ||
562e7c71 TB |
150 | /* Bit array elements as returned by the USB_REQ_GET_STATUS request. */ |
151 | #define USB_DEV_STAT_U1_ENABLED 2 /* transition into U1 state */ | |
152 | #define USB_DEV_STAT_U2_ENABLED 3 /* transition into U2 state */ | |
153 | #define USB_DEV_STAT_LTM_ENABLED 4 /* Latency tolerance messages */ | |
1da177e4 LT |
154 | |
155 | /** | |
156 | * struct usb_ctrlrequest - SETUP data for a USB device control request | |
157 | * @bRequestType: matches the USB bmRequestType field | |
158 | * @bRequest: matches the USB bRequest field | |
159 | * @wValue: matches the USB wValue field (le16 byte order) | |
160 | * @wIndex: matches the USB wIndex field (le16 byte order) | |
161 | * @wLength: matches the USB wLength field (le16 byte order) | |
162 | * | |
163 | * This structure is used to send control requests to a USB device. It matches | |
164 | * the different fields of the USB 2.0 Spec section 9.3, table 9-2. See the | |
165 | * USB spec for a fuller description of the different fields, and what they are | |
166 | * used for. | |
167 | * | |
168 | * Note that the driver for any interface can issue control requests. | |
169 | * For most devices, interfaces don't coordinate with each other, so | |
170 | * such requests may be made at any time. | |
171 | */ | |
172 | struct usb_ctrlrequest { | |
173 | __u8 bRequestType; | |
174 | __u8 bRequest; | |
175 | __le16 wValue; | |
176 | __le16 wIndex; | |
177 | __le16 wLength; | |
178 | } __attribute__ ((packed)); | |
179 | ||
180 | /*-------------------------------------------------------------------------*/ | |
181 | ||
182 | /* | |
183 | * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or | |
184 | * (rarely) accepted by SET_DESCRIPTOR. | |
185 | * | |
186 | * Note that all multi-byte values here are encoded in little endian | |
9a9fafb8 PE |
187 | * byte order "on the wire". Within the kernel and when exposed |
188 | * through the Linux-USB APIs, they are not converted to cpu byte | |
189 | * order; it is the responsibility of the client code to do this. | |
190 | * The single exception is when device and configuration descriptors (but | |
191 | * not other descriptors) are read from usbfs (i.e. /proc/bus/usb/BBB/DDD); | |
192 | * in this case the fields are converted to host endianness by the kernel. | |
1da177e4 LT |
193 | */ |
194 | ||
195 | /* | |
196 | * Descriptor types ... USB 2.0 spec table 9.5 | |
197 | */ | |
198 | #define USB_DT_DEVICE 0x01 | |
199 | #define USB_DT_CONFIG 0x02 | |
200 | #define USB_DT_STRING 0x03 | |
201 | #define USB_DT_INTERFACE 0x04 | |
202 | #define USB_DT_ENDPOINT 0x05 | |
203 | #define USB_DT_DEVICE_QUALIFIER 0x06 | |
204 | #define USB_DT_OTHER_SPEED_CONFIG 0x07 | |
205 | #define USB_DT_INTERFACE_POWER 0x08 | |
206 | /* these are from a minor usb 2.0 revision (ECN) */ | |
207 | #define USB_DT_OTG 0x09 | |
208 | #define USB_DT_DEBUG 0x0a | |
209 | #define USB_DT_INTERFACE_ASSOCIATION 0x0b | |
5da0106f DB |
210 | /* these are from the Wireless USB spec */ |
211 | #define USB_DT_SECURITY 0x0c | |
212 | #define USB_DT_KEY 0x0d | |
213 | #define USB_DT_ENCRYPTION_TYPE 0x0e | |
214 | #define USB_DT_BOS 0x0f | |
215 | #define USB_DT_DEVICE_CAPABILITY 0x10 | |
216 | #define USB_DT_WIRELESS_ENDPOINT_COMP 0x11 | |
5b5daf77 IPG |
217 | #define USB_DT_WIRE_ADAPTER 0x21 |
218 | #define USB_DT_RPIPE 0x22 | |
c27a4b71 | 219 | #define USB_DT_CS_RADIO_CONTROL 0x23 |
b18a2349 MW |
220 | /* From the T10 UAS specification */ |
221 | #define USB_DT_PIPE_USAGE 0x24 | |
663c30d0 SS |
222 | /* From the USB 3.0 spec */ |
223 | #define USB_DT_SS_ENDPOINT_COMP 0x30 | |
1da177e4 | 224 | |
aa2ce5ca DB |
225 | /* Conventional codes for class-specific descriptors. The convention is |
226 | * defined in the USB "Common Class" Spec (3.11). Individual class specs | |
227 | * are authoritative for their usage, not the "common class" writeup. | |
228 | */ | |
229 | #define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE) | |
230 | #define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG) | |
231 | #define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING) | |
232 | #define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE) | |
233 | #define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT) | |
1da177e4 LT |
234 | |
235 | /* All standard descriptors have these 2 fields at the beginning */ | |
236 | struct usb_descriptor_header { | |
237 | __u8 bLength; | |
238 | __u8 bDescriptorType; | |
239 | } __attribute__ ((packed)); | |
240 | ||
241 | ||
242 | /*-------------------------------------------------------------------------*/ | |
243 | ||
244 | /* USB_DT_DEVICE: Device descriptor */ | |
245 | struct usb_device_descriptor { | |
246 | __u8 bLength; | |
247 | __u8 bDescriptorType; | |
248 | ||
249 | __le16 bcdUSB; | |
250 | __u8 bDeviceClass; | |
251 | __u8 bDeviceSubClass; | |
252 | __u8 bDeviceProtocol; | |
253 | __u8 bMaxPacketSize0; | |
254 | __le16 idVendor; | |
255 | __le16 idProduct; | |
256 | __le16 bcdDevice; | |
257 | __u8 iManufacturer; | |
258 | __u8 iProduct; | |
259 | __u8 iSerialNumber; | |
260 | __u8 bNumConfigurations; | |
261 | } __attribute__ ((packed)); | |
262 | ||
263 | #define USB_DT_DEVICE_SIZE 18 | |
264 | ||
265 | ||
266 | /* | |
267 | * Device and/or Interface Class codes | |
268 | * as found in bDeviceClass or bInterfaceClass | |
269 | * and defined by www.usb.org documents | |
270 | */ | |
271 | #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */ | |
272 | #define USB_CLASS_AUDIO 1 | |
273 | #define USB_CLASS_COMM 2 | |
274 | #define USB_CLASS_HID 3 | |
275 | #define USB_CLASS_PHYSICAL 5 | |
276 | #define USB_CLASS_STILL_IMAGE 6 | |
277 | #define USB_CLASS_PRINTER 7 | |
278 | #define USB_CLASS_MASS_STORAGE 8 | |
279 | #define USB_CLASS_HUB 9 | |
280 | #define USB_CLASS_CDC_DATA 0x0a | |
281 | #define USB_CLASS_CSCID 0x0b /* chip+ smart card */ | |
282 | #define USB_CLASS_CONTENT_SEC 0x0d /* content security */ | |
283 | #define USB_CLASS_VIDEO 0x0e | |
5da0106f | 284 | #define USB_CLASS_WIRELESS_CONTROLLER 0xe0 |
e7d8712c | 285 | #define USB_CLASS_MISC 0xef |
1da177e4 LT |
286 | #define USB_CLASS_APP_SPEC 0xfe |
287 | #define USB_CLASS_VENDOR_SPEC 0xff | |
288 | ||
315ad302 LP |
289 | #define USB_SUBCLASS_VENDOR_SPEC 0xff |
290 | ||
1da177e4 LT |
291 | /*-------------------------------------------------------------------------*/ |
292 | ||
293 | /* USB_DT_CONFIG: Configuration descriptor information. | |
294 | * | |
295 | * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the | |
296 | * descriptor type is different. Highspeed-capable devices can look | |
297 | * different depending on what speed they're currently running. Only | |
298 | * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG | |
299 | * descriptors. | |
300 | */ | |
301 | struct usb_config_descriptor { | |
302 | __u8 bLength; | |
303 | __u8 bDescriptorType; | |
304 | ||
305 | __le16 wTotalLength; | |
306 | __u8 bNumInterfaces; | |
307 | __u8 bConfigurationValue; | |
308 | __u8 iConfiguration; | |
309 | __u8 bmAttributes; | |
310 | __u8 bMaxPower; | |
311 | } __attribute__ ((packed)); | |
312 | ||
313 | #define USB_DT_CONFIG_SIZE 9 | |
314 | ||
315 | /* from config descriptor bmAttributes */ | |
316 | #define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */ | |
317 | #define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */ | |
318 | #define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */ | |
5da0106f | 319 | #define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */ |
1da177e4 LT |
320 | |
321 | /*-------------------------------------------------------------------------*/ | |
322 | ||
323 | /* USB_DT_STRING: String descriptor */ | |
324 | struct usb_string_descriptor { | |
325 | __u8 bLength; | |
326 | __u8 bDescriptorType; | |
327 | ||
328 | __le16 wData[1]; /* UTF-16LE encoded */ | |
329 | } __attribute__ ((packed)); | |
330 | ||
331 | /* note that "string" zero is special, it holds language codes that | |
332 | * the device supports, not Unicode characters. | |
333 | */ | |
334 | ||
335 | /*-------------------------------------------------------------------------*/ | |
336 | ||
337 | /* USB_DT_INTERFACE: Interface descriptor */ | |
338 | struct usb_interface_descriptor { | |
339 | __u8 bLength; | |
340 | __u8 bDescriptorType; | |
341 | ||
342 | __u8 bInterfaceNumber; | |
343 | __u8 bAlternateSetting; | |
344 | __u8 bNumEndpoints; | |
345 | __u8 bInterfaceClass; | |
346 | __u8 bInterfaceSubClass; | |
347 | __u8 bInterfaceProtocol; | |
348 | __u8 iInterface; | |
349 | } __attribute__ ((packed)); | |
350 | ||
351 | #define USB_DT_INTERFACE_SIZE 9 | |
352 | ||
353 | /*-------------------------------------------------------------------------*/ | |
354 | ||
355 | /* USB_DT_ENDPOINT: Endpoint descriptor */ | |
356 | struct usb_endpoint_descriptor { | |
357 | __u8 bLength; | |
358 | __u8 bDescriptorType; | |
359 | ||
360 | __u8 bEndpointAddress; | |
361 | __u8 bmAttributes; | |
362 | __le16 wMaxPacketSize; | |
363 | __u8 bInterval; | |
364 | ||
4cceb4d1 GM |
365 | /* NOTE: these two are _only_ in audio endpoints. */ |
366 | /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */ | |
1da177e4 LT |
367 | __u8 bRefresh; |
368 | __u8 bSynchAddress; | |
369 | } __attribute__ ((packed)); | |
370 | ||
371 | #define USB_DT_ENDPOINT_SIZE 7 | |
372 | #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */ | |
373 | ||
374 | ||
375 | /* | |
376 | * Endpoints | |
377 | */ | |
378 | #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */ | |
379 | #define USB_ENDPOINT_DIR_MASK 0x80 | |
380 | ||
85e08ca5 LP |
381 | #define USB_ENDPOINT_SYNCTYPE 0x0c |
382 | #define USB_ENDPOINT_SYNC_NONE (0 << 2) | |
383 | #define USB_ENDPOINT_SYNC_ASYNC (1 << 2) | |
384 | #define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2) | |
385 | #define USB_ENDPOINT_SYNC_SYNC (3 << 2) | |
386 | ||
1da177e4 LT |
387 | #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */ |
388 | #define USB_ENDPOINT_XFER_CONTROL 0 | |
389 | #define USB_ENDPOINT_XFER_ISOC 1 | |
390 | #define USB_ENDPOINT_XFER_BULK 2 | |
391 | #define USB_ENDPOINT_XFER_INT 3 | |
5da0106f | 392 | #define USB_ENDPOINT_MAX_ADJUSTABLE 0x80 |
1da177e4 | 393 | |
4d6914b7 JL |
394 | /*-------------------------------------------------------------------------*/ |
395 | ||
396 | /** | |
397 | * usb_endpoint_num - get the endpoint's number | |
398 | * @epd: endpoint to be checked | |
399 | * | |
400 | * Returns @epd's number: 0 to 15. | |
401 | */ | |
402 | static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd) | |
403 | { | |
404 | return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK; | |
405 | } | |
406 | ||
407 | /** | |
408 | * usb_endpoint_type - get the endpoint's transfer type | |
409 | * @epd: endpoint to be checked | |
410 | * | |
411 | * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according | |
412 | * to @epd's transfer type. | |
413 | */ | |
414 | static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd) | |
415 | { | |
416 | return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK; | |
417 | } | |
418 | ||
419 | /** | |
420 | * usb_endpoint_dir_in - check if the endpoint has IN direction | |
421 | * @epd: endpoint to be checked | |
422 | * | |
423 | * Returns true if the endpoint is of type IN, otherwise it returns false. | |
424 | */ | |
425 | static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd) | |
426 | { | |
427 | return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN); | |
428 | } | |
429 | ||
430 | /** | |
431 | * usb_endpoint_dir_out - check if the endpoint has OUT direction | |
432 | * @epd: endpoint to be checked | |
433 | * | |
434 | * Returns true if the endpoint is of type OUT, otherwise it returns false. | |
435 | */ | |
436 | static inline int usb_endpoint_dir_out( | |
437 | const struct usb_endpoint_descriptor *epd) | |
438 | { | |
439 | return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT); | |
440 | } | |
441 | ||
442 | /** | |
443 | * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type | |
444 | * @epd: endpoint to be checked | |
445 | * | |
446 | * Returns true if the endpoint is of type bulk, otherwise it returns false. | |
447 | */ | |
448 | static inline int usb_endpoint_xfer_bulk( | |
449 | const struct usb_endpoint_descriptor *epd) | |
450 | { | |
451 | return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == | |
452 | USB_ENDPOINT_XFER_BULK); | |
453 | } | |
454 | ||
455 | /** | |
456 | * usb_endpoint_xfer_control - check if the endpoint has control transfer type | |
457 | * @epd: endpoint to be checked | |
458 | * | |
459 | * Returns true if the endpoint is of type control, otherwise it returns false. | |
460 | */ | |
461 | static inline int usb_endpoint_xfer_control( | |
462 | const struct usb_endpoint_descriptor *epd) | |
463 | { | |
464 | return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == | |
465 | USB_ENDPOINT_XFER_CONTROL); | |
466 | } | |
467 | ||
468 | /** | |
469 | * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type | |
470 | * @epd: endpoint to be checked | |
471 | * | |
472 | * Returns true if the endpoint is of type interrupt, otherwise it returns | |
473 | * false. | |
474 | */ | |
475 | static inline int usb_endpoint_xfer_int( | |
476 | const struct usb_endpoint_descriptor *epd) | |
477 | { | |
478 | return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == | |
479 | USB_ENDPOINT_XFER_INT); | |
480 | } | |
481 | ||
482 | /** | |
483 | * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type | |
484 | * @epd: endpoint to be checked | |
485 | * | |
486 | * Returns true if the endpoint is of type isochronous, otherwise it returns | |
487 | * false. | |
488 | */ | |
489 | static inline int usb_endpoint_xfer_isoc( | |
490 | const struct usb_endpoint_descriptor *epd) | |
491 | { | |
492 | return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == | |
493 | USB_ENDPOINT_XFER_ISOC); | |
494 | } | |
495 | ||
496 | /** | |
497 | * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN | |
498 | * @epd: endpoint to be checked | |
499 | * | |
500 | * Returns true if the endpoint has bulk transfer type and IN direction, | |
501 | * otherwise it returns false. | |
502 | */ | |
503 | static inline int usb_endpoint_is_bulk_in( | |
504 | const struct usb_endpoint_descriptor *epd) | |
505 | { | |
0858a3a5 | 506 | return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd); |
4d6914b7 JL |
507 | } |
508 | ||
509 | /** | |
510 | * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT | |
511 | * @epd: endpoint to be checked | |
512 | * | |
513 | * Returns true if the endpoint has bulk transfer type and OUT direction, | |
514 | * otherwise it returns false. | |
515 | */ | |
516 | static inline int usb_endpoint_is_bulk_out( | |
517 | const struct usb_endpoint_descriptor *epd) | |
518 | { | |
0858a3a5 | 519 | return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd); |
4d6914b7 JL |
520 | } |
521 | ||
522 | /** | |
523 | * usb_endpoint_is_int_in - check if the endpoint is interrupt IN | |
524 | * @epd: endpoint to be checked | |
525 | * | |
526 | * Returns true if the endpoint has interrupt transfer type and IN direction, | |
527 | * otherwise it returns false. | |
528 | */ | |
529 | static inline int usb_endpoint_is_int_in( | |
530 | const struct usb_endpoint_descriptor *epd) | |
531 | { | |
0858a3a5 | 532 | return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd); |
4d6914b7 JL |
533 | } |
534 | ||
535 | /** | |
536 | * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT | |
537 | * @epd: endpoint to be checked | |
538 | * | |
539 | * Returns true if the endpoint has interrupt transfer type and OUT direction, | |
540 | * otherwise it returns false. | |
541 | */ | |
542 | static inline int usb_endpoint_is_int_out( | |
543 | const struct usb_endpoint_descriptor *epd) | |
544 | { | |
0858a3a5 | 545 | return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd); |
4d6914b7 JL |
546 | } |
547 | ||
548 | /** | |
549 | * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN | |
550 | * @epd: endpoint to be checked | |
551 | * | |
552 | * Returns true if the endpoint has isochronous transfer type and IN direction, | |
553 | * otherwise it returns false. | |
554 | */ | |
555 | static inline int usb_endpoint_is_isoc_in( | |
556 | const struct usb_endpoint_descriptor *epd) | |
557 | { | |
0858a3a5 | 558 | return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd); |
4d6914b7 JL |
559 | } |
560 | ||
561 | /** | |
562 | * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT | |
563 | * @epd: endpoint to be checked | |
564 | * | |
565 | * Returns true if the endpoint has isochronous transfer type and OUT direction, | |
566 | * otherwise it returns false. | |
567 | */ | |
568 | static inline int usb_endpoint_is_isoc_out( | |
569 | const struct usb_endpoint_descriptor *epd) | |
570 | { | |
0858a3a5 | 571 | return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd); |
4d6914b7 | 572 | } |
1da177e4 | 573 | |
939f325f | 574 | /** |
575 | * usb_endpoint_maxp - get endpoint's max packet size | |
576 | * @epd: endpoint to be checked | |
577 | * | |
578 | * Returns @epd's max packet | |
579 | */ | |
580 | static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd) | |
581 | { | |
582 | return le16_to_cpu(epd->wMaxPacketSize); | |
583 | } | |
584 | ||
1da177e4 LT |
585 | /*-------------------------------------------------------------------------*/ |
586 | ||
663c30d0 | 587 | /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */ |
f0058c62 | 588 | struct usb_ss_ep_comp_descriptor { |
663c30d0 SS |
589 | __u8 bLength; |
590 | __u8 bDescriptorType; | |
591 | ||
592 | __u8 bMaxBurst; | |
593 | __u8 bmAttributes; | |
64b3c304 | 594 | __le16 wBytesPerInterval; |
663c30d0 SS |
595 | } __attribute__ ((packed)); |
596 | ||
f0058c62 | 597 | #define USB_DT_SS_EP_COMP_SIZE 6 |
22ad1e7f | 598 | /* Bits 4:0 of bmAttributes if this is a bulk endpoint */ |
c9642374 | 599 | #define USB_SS_MAX_STREAMS(p) (1 << ((p) & 0x1f)) |
500132a0 PZ |
600 | /* Bits 1:0 of bmAttributes if this is an isoc endpoint */ |
601 | #define USB_SS_MULT(p) (1 + ((p) & 0x3)) | |
663c30d0 SS |
602 | |
603 | /*-------------------------------------------------------------------------*/ | |
604 | ||
1da177e4 LT |
605 | /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */ |
606 | struct usb_qualifier_descriptor { | |
607 | __u8 bLength; | |
608 | __u8 bDescriptorType; | |
609 | ||
610 | __le16 bcdUSB; | |
611 | __u8 bDeviceClass; | |
612 | __u8 bDeviceSubClass; | |
613 | __u8 bDeviceProtocol; | |
614 | __u8 bMaxPacketSize0; | |
615 | __u8 bNumConfigurations; | |
616 | __u8 bRESERVED; | |
617 | } __attribute__ ((packed)); | |
618 | ||
619 | ||
620 | /*-------------------------------------------------------------------------*/ | |
621 | ||
622 | /* USB_DT_OTG (from OTG 1.0a supplement) */ | |
623 | struct usb_otg_descriptor { | |
624 | __u8 bLength; | |
625 | __u8 bDescriptorType; | |
626 | ||
627 | __u8 bmAttributes; /* support for HNP, SRP, etc */ | |
628 | } __attribute__ ((packed)); | |
629 | ||
630 | /* from usb_otg_descriptor.bmAttributes */ | |
631 | #define USB_OTG_SRP (1 << 0) | |
632 | #define USB_OTG_HNP (1 << 1) /* swap host/device roles */ | |
633 | ||
634 | /*-------------------------------------------------------------------------*/ | |
635 | ||
636 | /* USB_DT_DEBUG: for special highspeed devices, replacing serial console */ | |
637 | struct usb_debug_descriptor { | |
638 | __u8 bLength; | |
639 | __u8 bDescriptorType; | |
640 | ||
641 | /* bulk endpoints with 8 byte maxpacket */ | |
642 | __u8 bDebugInEndpoint; | |
643 | __u8 bDebugOutEndpoint; | |
23004e24 | 644 | } __attribute__((packed)); |
1da177e4 LT |
645 | |
646 | /*-------------------------------------------------------------------------*/ | |
647 | ||
648 | /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */ | |
649 | struct usb_interface_assoc_descriptor { | |
650 | __u8 bLength; | |
651 | __u8 bDescriptorType; | |
652 | ||
653 | __u8 bFirstInterface; | |
654 | __u8 bInterfaceCount; | |
655 | __u8 bFunctionClass; | |
656 | __u8 bFunctionSubClass; | |
657 | __u8 bFunctionProtocol; | |
658 | __u8 iFunction; | |
659 | } __attribute__ ((packed)); | |
660 | ||
661 | ||
5da0106f DB |
662 | /*-------------------------------------------------------------------------*/ |
663 | ||
664 | /* USB_DT_SECURITY: group of wireless security descriptors, including | |
665 | * encryption types available for setting up a CC/association. | |
666 | */ | |
667 | struct usb_security_descriptor { | |
668 | __u8 bLength; | |
669 | __u8 bDescriptorType; | |
670 | ||
671 | __le16 wTotalLength; | |
672 | __u8 bNumEncryptionTypes; | |
23004e24 | 673 | } __attribute__((packed)); |
5da0106f DB |
674 | |
675 | /*-------------------------------------------------------------------------*/ | |
676 | ||
677 | /* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys | |
678 | * may be retrieved. | |
679 | */ | |
680 | struct usb_key_descriptor { | |
681 | __u8 bLength; | |
682 | __u8 bDescriptorType; | |
683 | ||
684 | __u8 tTKID[3]; | |
685 | __u8 bReserved; | |
686 | __u8 bKeyData[0]; | |
23004e24 | 687 | } __attribute__((packed)); |
5da0106f DB |
688 | |
689 | /*-------------------------------------------------------------------------*/ | |
690 | ||
691 | /* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */ | |
692 | struct usb_encryption_descriptor { | |
693 | __u8 bLength; | |
694 | __u8 bDescriptorType; | |
695 | ||
696 | __u8 bEncryptionType; | |
697 | #define USB_ENC_TYPE_UNSECURE 0 | |
698 | #define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */ | |
699 | #define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */ | |
700 | #define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */ | |
701 | __u8 bEncryptionValue; /* use in SET_ENCRYPTION */ | |
702 | __u8 bAuthKeyIndex; | |
23004e24 | 703 | } __attribute__((packed)); |
5da0106f DB |
704 | |
705 | ||
706 | /*-------------------------------------------------------------------------*/ | |
707 | ||
35e5437e | 708 | /* USB_DT_BOS: group of device-level capabilities */ |
5da0106f DB |
709 | struct usb_bos_descriptor { |
710 | __u8 bLength; | |
711 | __u8 bDescriptorType; | |
712 | ||
713 | __le16 wTotalLength; | |
714 | __u8 bNumDeviceCaps; | |
23004e24 | 715 | } __attribute__((packed)); |
5da0106f | 716 | |
562e7c71 | 717 | #define USB_DT_BOS_SIZE 5 |
5da0106f DB |
718 | /*-------------------------------------------------------------------------*/ |
719 | ||
720 | /* USB_DT_DEVICE_CAPABILITY: grouped with BOS */ | |
721 | struct usb_dev_cap_header { | |
722 | __u8 bLength; | |
723 | __u8 bDescriptorType; | |
724 | __u8 bDevCapabilityType; | |
23004e24 | 725 | } __attribute__((packed)); |
5da0106f DB |
726 | |
727 | #define USB_CAP_TYPE_WIRELESS_USB 1 | |
728 | ||
729 | struct usb_wireless_cap_descriptor { /* Ultra Wide Band */ | |
730 | __u8 bLength; | |
731 | __u8 bDescriptorType; | |
732 | __u8 bDevCapabilityType; | |
733 | ||
734 | __u8 bmAttributes; | |
735 | #define USB_WIRELESS_P2P_DRD (1 << 1) | |
736 | #define USB_WIRELESS_BEACON_MASK (3 << 2) | |
737 | #define USB_WIRELESS_BEACON_SELF (1 << 2) | |
738 | #define USB_WIRELESS_BEACON_DIRECTED (2 << 2) | |
739 | #define USB_WIRELESS_BEACON_NONE (3 << 2) | |
740 | __le16 wPHYRates; /* bit rates, Mbps */ | |
741 | #define USB_WIRELESS_PHY_53 (1 << 0) /* always set */ | |
742 | #define USB_WIRELESS_PHY_80 (1 << 1) | |
743 | #define USB_WIRELESS_PHY_107 (1 << 2) /* always set */ | |
744 | #define USB_WIRELESS_PHY_160 (1 << 3) | |
745 | #define USB_WIRELESS_PHY_200 (1 << 4) /* always set */ | |
746 | #define USB_WIRELESS_PHY_320 (1 << 5) | |
747 | #define USB_WIRELESS_PHY_400 (1 << 6) | |
748 | #define USB_WIRELESS_PHY_480 (1 << 7) | |
749 | __u8 bmTFITXPowerInfo; /* TFI power levels */ | |
750 | __u8 bmFFITXPowerInfo; /* FFI power levels */ | |
751 | __le16 bmBandGroup; | |
752 | __u8 bReserved; | |
23004e24 | 753 | } __attribute__((packed)); |
5da0106f | 754 | |
562e7c71 | 755 | /* USB 2.0 Extension descriptor */ |
35e5437e SS |
756 | #define USB_CAP_TYPE_EXT 2 |
757 | ||
758 | struct usb_ext_cap_descriptor { /* Link Power Management */ | |
759 | __u8 bLength; | |
760 | __u8 bDescriptorType; | |
761 | __u8 bDevCapabilityType; | |
562e7c71 | 762 | __le32 bmAttributes; |
35e5437e SS |
763 | #define USB_LPM_SUPPORT (1 << 1) /* supports LPM */ |
764 | } __attribute__((packed)); | |
765 | ||
562e7c71 TB |
766 | #define USB_DT_USB_EXT_CAP_SIZE 7 |
767 | ||
768 | /* | |
769 | * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB | |
770 | * specific device level capabilities | |
771 | */ | |
772 | #define USB_SS_CAP_TYPE 3 | |
773 | struct usb_ss_cap_descriptor { /* Link Power Management */ | |
774 | __u8 bLength; | |
775 | __u8 bDescriptorType; | |
776 | __u8 bDevCapabilityType; | |
777 | __u8 bmAttributes; | |
778 | #define USB_LTM_SUPPORT (1 << 1) /* supports LTM */ | |
779 | __le16 wSpeedSupported; | |
780 | #define USB_LOW_SPEED_OPERATION (1) /* Low speed operation */ | |
781 | #define USB_FULL_SPEED_OPERATION (1 << 1) /* Full speed operation */ | |
782 | #define USB_HIGH_SPEED_OPERATION (1 << 2) /* High speed operation */ | |
783 | #define USB_5GBPS_OPERATION (1 << 3) /* Operation at 5Gbps */ | |
784 | __u8 bFunctionalitySupport; | |
785 | __u8 bU1devExitLat; | |
786 | __le16 bU2DevExitLat; | |
787 | } __attribute__((packed)); | |
788 | ||
789 | #define USB_DT_USB_SS_CAP_SIZE 10 | |
790 | ||
791 | /* | |
792 | * Container ID Capability descriptor: Defines the instance unique ID used to | |
793 | * identify the instance across all operating modes | |
794 | */ | |
795 | #define CONTAINER_ID_TYPE 4 | |
796 | struct usb_ss_container_id_descriptor { | |
797 | __u8 bLength; | |
798 | __u8 bDescriptorType; | |
799 | __u8 bDevCapabilityType; | |
800 | __u8 bReserved; | |
801 | __u8 ContainerID[16]; /* 128-bit number */ | |
802 | } __attribute__((packed)); | |
803 | ||
804 | #define USB_DT_USB_SS_CONTN_ID_SIZE 20 | |
5da0106f DB |
805 | /*-------------------------------------------------------------------------*/ |
806 | ||
807 | /* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with | |
808 | * each endpoint descriptor for a wireless device | |
809 | */ | |
810 | struct usb_wireless_ep_comp_descriptor { | |
811 | __u8 bLength; | |
812 | __u8 bDescriptorType; | |
813 | ||
814 | __u8 bMaxBurst; | |
815 | __u8 bMaxSequence; | |
816 | __le16 wMaxStreamDelay; | |
817 | __le16 wOverTheAirPacketSize; | |
818 | __u8 bOverTheAirInterval; | |
819 | __u8 bmCompAttributes; | |
820 | #define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */ | |
821 | #define USB_ENDPOINT_SWITCH_NO 0 | |
822 | #define USB_ENDPOINT_SWITCH_SWITCH 1 | |
823 | #define USB_ENDPOINT_SWITCH_SCALE 2 | |
23004e24 | 824 | } __attribute__((packed)); |
5da0106f DB |
825 | |
826 | /*-------------------------------------------------------------------------*/ | |
827 | ||
828 | /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless | |
829 | * host and a device for connection set up, mutual authentication, and | |
830 | * exchanging short lived session keys. The handshake depends on a CC. | |
831 | */ | |
832 | struct usb_handshake { | |
833 | __u8 bMessageNumber; | |
834 | __u8 bStatus; | |
835 | __u8 tTKID[3]; | |
836 | __u8 bReserved; | |
837 | __u8 CDID[16]; | |
838 | __u8 nonce[16]; | |
839 | __u8 MIC[8]; | |
23004e24 | 840 | } __attribute__((packed)); |
5da0106f DB |
841 | |
842 | /*-------------------------------------------------------------------------*/ | |
843 | ||
844 | /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC). | |
845 | * A CC may also be set up using non-wireless secure channels (including | |
846 | * wired USB!), and some devices may support CCs with multiple hosts. | |
847 | */ | |
848 | struct usb_connection_context { | |
849 | __u8 CHID[16]; /* persistent host id */ | |
850 | __u8 CDID[16]; /* device id (unique w/in host context) */ | |
851 | __u8 CK[16]; /* connection key */ | |
23004e24 | 852 | } __attribute__((packed)); |
5da0106f | 853 | |
1da177e4 LT |
854 | /*-------------------------------------------------------------------------*/ |
855 | ||
856 | /* USB 2.0 defines three speeds, here's how Linux identifies them */ | |
857 | ||
858 | enum usb_device_speed { | |
859 | USB_SPEED_UNKNOWN = 0, /* enumerating */ | |
860 | USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */ | |
5da0106f | 861 | USB_SPEED_HIGH, /* usb 2.0 */ |
551cdbbe | 862 | USB_SPEED_WIRELESS, /* wireless (usb 2.5) */ |
6b403b02 | 863 | USB_SPEED_SUPER, /* usb 3.0 */ |
1da177e4 LT |
864 | }; |
865 | ||
866 | enum usb_device_state { | |
867 | /* NOTATTACHED isn't in the USB spec, and this state acts | |
868 | * the same as ATTACHED ... but it's clearer this way. | |
869 | */ | |
870 | USB_STATE_NOTATTACHED = 0, | |
871 | ||
c02c4bb2 | 872 | /* chapter 9 and authentication (wireless) device states */ |
1da177e4 | 873 | USB_STATE_ATTACHED, |
c02c4bb2 | 874 | USB_STATE_POWERED, /* wired */ |
c02c4bb2 | 875 | USB_STATE_RECONNECTING, /* auth */ |
6da9c990 | 876 | USB_STATE_UNAUTHENTICATED, /* auth */ |
1da177e4 LT |
877 | USB_STATE_DEFAULT, /* limited function */ |
878 | USB_STATE_ADDRESS, | |
879 | USB_STATE_CONFIGURED, /* most functions */ | |
880 | ||
881 | USB_STATE_SUSPENDED | |
882 | ||
883 | /* NOTE: there are actually four different SUSPENDED | |
884 | * states, returning to POWERED, DEFAULT, ADDRESS, or | |
885 | * CONFIGURED respectively when SOF tokens flow again. | |
dbe0dbb7 DB |
886 | * At this level there's no difference between L1 and L2 |
887 | * suspend states. (L2 being original USB 1.1 suspend.) | |
1da177e4 LT |
888 | */ |
889 | }; | |
890 | ||
37b5801e PM |
891 | /*-------------------------------------------------------------------------*/ |
892 | ||
893 | /* | |
894 | * As per USB compliance update, a device that is actively drawing | |
895 | * more than 100mA from USB must report itself as bus-powered in | |
896 | * the GetStatus(DEVICE) call. | |
897 | * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34 | |
898 | */ | |
899 | #define USB_SELF_POWER_VBUS_MAX_DRAW 100 | |
900 | ||
dda43a0e | 901 | #endif /* __LINUX_USB_CH9_H */ |