]>
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 */ |
1da177e4 LT |
37 | |
38 | /*-------------------------------------------------------------------------*/ | |
39 | ||
40 | /* CONTROL REQUEST SUPPORT */ | |
41 | ||
42 | /* | |
43 | * USB directions | |
44 | * | |
45 | * This bit flag is used in endpoint descriptors' bEndpointAddress field. | |
46 | * It's also one of three fields in control requests bRequestType. | |
47 | */ | |
48 | #define USB_DIR_OUT 0 /* to device */ | |
49 | #define USB_DIR_IN 0x80 /* to host */ | |
50 | ||
51 | /* | |
52 | * USB types, the second of three bRequestType fields | |
53 | */ | |
54 | #define USB_TYPE_MASK (0x03 << 5) | |
55 | #define USB_TYPE_STANDARD (0x00 << 5) | |
56 | #define USB_TYPE_CLASS (0x01 << 5) | |
57 | #define USB_TYPE_VENDOR (0x02 << 5) | |
58 | #define USB_TYPE_RESERVED (0x03 << 5) | |
59 | ||
60 | /* | |
61 | * USB recipients, the third of three bRequestType fields | |
62 | */ | |
63 | #define USB_RECIP_MASK 0x1f | |
64 | #define USB_RECIP_DEVICE 0x00 | |
65 | #define USB_RECIP_INTERFACE 0x01 | |
66 | #define USB_RECIP_ENDPOINT 0x02 | |
67 | #define USB_RECIP_OTHER 0x03 | |
5b5daf77 | 68 | /* From Wireless USB 1.0 */ |
dbe0dbb7 DB |
69 | #define USB_RECIP_PORT 0x04 |
70 | #define USB_RECIP_RPIPE 0x05 | |
1da177e4 LT |
71 | |
72 | /* | |
73 | * Standard requests, for the bRequest field of a SETUP packet. | |
74 | * | |
75 | * These are qualified by the bRequestType field, so that for example | |
76 | * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved | |
77 | * by a GET_STATUS request. | |
78 | */ | |
79 | #define USB_REQ_GET_STATUS 0x00 | |
80 | #define USB_REQ_CLEAR_FEATURE 0x01 | |
81 | #define USB_REQ_SET_FEATURE 0x03 | |
82 | #define USB_REQ_SET_ADDRESS 0x05 | |
83 | #define USB_REQ_GET_DESCRIPTOR 0x06 | |
84 | #define USB_REQ_SET_DESCRIPTOR 0x07 | |
85 | #define USB_REQ_GET_CONFIGURATION 0x08 | |
86 | #define USB_REQ_SET_CONFIGURATION 0x09 | |
87 | #define USB_REQ_GET_INTERFACE 0x0A | |
88 | #define USB_REQ_SET_INTERFACE 0x0B | |
89 | #define USB_REQ_SYNCH_FRAME 0x0C | |
90 | ||
5da0106f DB |
91 | #define USB_REQ_SET_ENCRYPTION 0x0D /* Wireless USB */ |
92 | #define USB_REQ_GET_ENCRYPTION 0x0E | |
5b5daf77 | 93 | #define USB_REQ_RPIPE_ABORT 0x0E |
5da0106f | 94 | #define USB_REQ_SET_HANDSHAKE 0x0F |
5b5daf77 | 95 | #define USB_REQ_RPIPE_RESET 0x0F |
5da0106f DB |
96 | #define USB_REQ_GET_HANDSHAKE 0x10 |
97 | #define USB_REQ_SET_CONNECTION 0x11 | |
98 | #define USB_REQ_SET_SECURITY_DATA 0x12 | |
99 | #define USB_REQ_GET_SECURITY_DATA 0x13 | |
100 | #define USB_REQ_SET_WUSB_DATA 0x14 | |
101 | #define USB_REQ_LOOPBACK_DATA_WRITE 0x15 | |
102 | #define USB_REQ_LOOPBACK_DATA_READ 0x16 | |
103 | #define USB_REQ_SET_INTERFACE_DS 0x17 | |
104 | ||
dbe0dbb7 DB |
105 | /* The Link Power Mangement (LPM) ECN defines USB_REQ_TEST_AND_SET command, |
106 | * used by hubs to put ports into a new L1 suspend state, except that it | |
107 | * forgot to define its number ... | |
108 | */ | |
109 | ||
1da177e4 LT |
110 | /* |
111 | * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and | |
112 | * are read as a bit array returned by USB_REQ_GET_STATUS. (So there | |
dbe0dbb7 DB |
113 | * are at most sixteen features of each type.) Hubs may also support a |
114 | * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend. | |
1da177e4 LT |
115 | */ |
116 | #define USB_DEVICE_SELF_POWERED 0 /* (read only) */ | |
117 | #define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */ | |
5da0106f DB |
118 | #define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */ |
119 | #define USB_DEVICE_BATTERY 2 /* (wireless) */ | |
120 | #define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */ | |
121 | #define USB_DEVICE_WUSB_DEVICE 3 /* (wireless)*/ | |
122 | #define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */ | |
123 | #define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */ | |
1da177e4 LT |
124 | #define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */ |
125 | ||
126 | #define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */ | |
127 | ||
128 | ||
129 | /** | |
130 | * struct usb_ctrlrequest - SETUP data for a USB device control request | |
131 | * @bRequestType: matches the USB bmRequestType field | |
132 | * @bRequest: matches the USB bRequest field | |
133 | * @wValue: matches the USB wValue field (le16 byte order) | |
134 | * @wIndex: matches the USB wIndex field (le16 byte order) | |
135 | * @wLength: matches the USB wLength field (le16 byte order) | |
136 | * | |
137 | * This structure is used to send control requests to a USB device. It matches | |
138 | * the different fields of the USB 2.0 Spec section 9.3, table 9-2. See the | |
139 | * USB spec for a fuller description of the different fields, and what they are | |
140 | * used for. | |
141 | * | |
142 | * Note that the driver for any interface can issue control requests. | |
143 | * For most devices, interfaces don't coordinate with each other, so | |
144 | * such requests may be made at any time. | |
145 | */ | |
146 | struct usb_ctrlrequest { | |
147 | __u8 bRequestType; | |
148 | __u8 bRequest; | |
149 | __le16 wValue; | |
150 | __le16 wIndex; | |
151 | __le16 wLength; | |
152 | } __attribute__ ((packed)); | |
153 | ||
154 | /*-------------------------------------------------------------------------*/ | |
155 | ||
156 | /* | |
157 | * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or | |
158 | * (rarely) accepted by SET_DESCRIPTOR. | |
159 | * | |
160 | * Note that all multi-byte values here are encoded in little endian | |
9a9fafb8 PE |
161 | * byte order "on the wire". Within the kernel and when exposed |
162 | * through the Linux-USB APIs, they are not converted to cpu byte | |
163 | * order; it is the responsibility of the client code to do this. | |
164 | * The single exception is when device and configuration descriptors (but | |
165 | * not other descriptors) are read from usbfs (i.e. /proc/bus/usb/BBB/DDD); | |
166 | * in this case the fields are converted to host endianness by the kernel. | |
1da177e4 LT |
167 | */ |
168 | ||
169 | /* | |
170 | * Descriptor types ... USB 2.0 spec table 9.5 | |
171 | */ | |
172 | #define USB_DT_DEVICE 0x01 | |
173 | #define USB_DT_CONFIG 0x02 | |
174 | #define USB_DT_STRING 0x03 | |
175 | #define USB_DT_INTERFACE 0x04 | |
176 | #define USB_DT_ENDPOINT 0x05 | |
177 | #define USB_DT_DEVICE_QUALIFIER 0x06 | |
178 | #define USB_DT_OTHER_SPEED_CONFIG 0x07 | |
179 | #define USB_DT_INTERFACE_POWER 0x08 | |
180 | /* these are from a minor usb 2.0 revision (ECN) */ | |
181 | #define USB_DT_OTG 0x09 | |
182 | #define USB_DT_DEBUG 0x0a | |
183 | #define USB_DT_INTERFACE_ASSOCIATION 0x0b | |
5da0106f DB |
184 | /* these are from the Wireless USB spec */ |
185 | #define USB_DT_SECURITY 0x0c | |
186 | #define USB_DT_KEY 0x0d | |
187 | #define USB_DT_ENCRYPTION_TYPE 0x0e | |
188 | #define USB_DT_BOS 0x0f | |
189 | #define USB_DT_DEVICE_CAPABILITY 0x10 | |
190 | #define USB_DT_WIRELESS_ENDPOINT_COMP 0x11 | |
5b5daf77 IPG |
191 | #define USB_DT_WIRE_ADAPTER 0x21 |
192 | #define USB_DT_RPIPE 0x22 | |
c27a4b71 | 193 | #define USB_DT_CS_RADIO_CONTROL 0x23 |
1da177e4 | 194 | |
aa2ce5ca DB |
195 | /* Conventional codes for class-specific descriptors. The convention is |
196 | * defined in the USB "Common Class" Spec (3.11). Individual class specs | |
197 | * are authoritative for their usage, not the "common class" writeup. | |
198 | */ | |
199 | #define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE) | |
200 | #define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG) | |
201 | #define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING) | |
202 | #define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE) | |
203 | #define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT) | |
1da177e4 LT |
204 | |
205 | /* All standard descriptors have these 2 fields at the beginning */ | |
206 | struct usb_descriptor_header { | |
207 | __u8 bLength; | |
208 | __u8 bDescriptorType; | |
209 | } __attribute__ ((packed)); | |
210 | ||
211 | ||
212 | /*-------------------------------------------------------------------------*/ | |
213 | ||
214 | /* USB_DT_DEVICE: Device descriptor */ | |
215 | struct usb_device_descriptor { | |
216 | __u8 bLength; | |
217 | __u8 bDescriptorType; | |
218 | ||
219 | __le16 bcdUSB; | |
220 | __u8 bDeviceClass; | |
221 | __u8 bDeviceSubClass; | |
222 | __u8 bDeviceProtocol; | |
223 | __u8 bMaxPacketSize0; | |
224 | __le16 idVendor; | |
225 | __le16 idProduct; | |
226 | __le16 bcdDevice; | |
227 | __u8 iManufacturer; | |
228 | __u8 iProduct; | |
229 | __u8 iSerialNumber; | |
230 | __u8 bNumConfigurations; | |
231 | } __attribute__ ((packed)); | |
232 | ||
233 | #define USB_DT_DEVICE_SIZE 18 | |
234 | ||
235 | ||
236 | /* | |
237 | * Device and/or Interface Class codes | |
238 | * as found in bDeviceClass or bInterfaceClass | |
239 | * and defined by www.usb.org documents | |
240 | */ | |
241 | #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */ | |
242 | #define USB_CLASS_AUDIO 1 | |
243 | #define USB_CLASS_COMM 2 | |
244 | #define USB_CLASS_HID 3 | |
245 | #define USB_CLASS_PHYSICAL 5 | |
246 | #define USB_CLASS_STILL_IMAGE 6 | |
247 | #define USB_CLASS_PRINTER 7 | |
248 | #define USB_CLASS_MASS_STORAGE 8 | |
249 | #define USB_CLASS_HUB 9 | |
250 | #define USB_CLASS_CDC_DATA 0x0a | |
251 | #define USB_CLASS_CSCID 0x0b /* chip+ smart card */ | |
252 | #define USB_CLASS_CONTENT_SEC 0x0d /* content security */ | |
253 | #define USB_CLASS_VIDEO 0x0e | |
5da0106f | 254 | #define USB_CLASS_WIRELESS_CONTROLLER 0xe0 |
e7d8712c | 255 | #define USB_CLASS_MISC 0xef |
1da177e4 LT |
256 | #define USB_CLASS_APP_SPEC 0xfe |
257 | #define USB_CLASS_VENDOR_SPEC 0xff | |
258 | ||
259 | /*-------------------------------------------------------------------------*/ | |
260 | ||
261 | /* USB_DT_CONFIG: Configuration descriptor information. | |
262 | * | |
263 | * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the | |
264 | * descriptor type is different. Highspeed-capable devices can look | |
265 | * different depending on what speed they're currently running. Only | |
266 | * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG | |
267 | * descriptors. | |
268 | */ | |
269 | struct usb_config_descriptor { | |
270 | __u8 bLength; | |
271 | __u8 bDescriptorType; | |
272 | ||
273 | __le16 wTotalLength; | |
274 | __u8 bNumInterfaces; | |
275 | __u8 bConfigurationValue; | |
276 | __u8 iConfiguration; | |
277 | __u8 bmAttributes; | |
278 | __u8 bMaxPower; | |
279 | } __attribute__ ((packed)); | |
280 | ||
281 | #define USB_DT_CONFIG_SIZE 9 | |
282 | ||
283 | /* from config descriptor bmAttributes */ | |
284 | #define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */ | |
285 | #define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */ | |
286 | #define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */ | |
5da0106f | 287 | #define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */ |
1da177e4 LT |
288 | |
289 | /*-------------------------------------------------------------------------*/ | |
290 | ||
291 | /* USB_DT_STRING: String descriptor */ | |
292 | struct usb_string_descriptor { | |
293 | __u8 bLength; | |
294 | __u8 bDescriptorType; | |
295 | ||
296 | __le16 wData[1]; /* UTF-16LE encoded */ | |
297 | } __attribute__ ((packed)); | |
298 | ||
299 | /* note that "string" zero is special, it holds language codes that | |
300 | * the device supports, not Unicode characters. | |
301 | */ | |
302 | ||
303 | /*-------------------------------------------------------------------------*/ | |
304 | ||
305 | /* USB_DT_INTERFACE: Interface descriptor */ | |
306 | struct usb_interface_descriptor { | |
307 | __u8 bLength; | |
308 | __u8 bDescriptorType; | |
309 | ||
310 | __u8 bInterfaceNumber; | |
311 | __u8 bAlternateSetting; | |
312 | __u8 bNumEndpoints; | |
313 | __u8 bInterfaceClass; | |
314 | __u8 bInterfaceSubClass; | |
315 | __u8 bInterfaceProtocol; | |
316 | __u8 iInterface; | |
317 | } __attribute__ ((packed)); | |
318 | ||
319 | #define USB_DT_INTERFACE_SIZE 9 | |
320 | ||
321 | /*-------------------------------------------------------------------------*/ | |
322 | ||
323 | /* USB_DT_ENDPOINT: Endpoint descriptor */ | |
324 | struct usb_endpoint_descriptor { | |
325 | __u8 bLength; | |
326 | __u8 bDescriptorType; | |
327 | ||
328 | __u8 bEndpointAddress; | |
329 | __u8 bmAttributes; | |
330 | __le16 wMaxPacketSize; | |
331 | __u8 bInterval; | |
332 | ||
4cceb4d1 GM |
333 | /* NOTE: these two are _only_ in audio endpoints. */ |
334 | /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */ | |
1da177e4 LT |
335 | __u8 bRefresh; |
336 | __u8 bSynchAddress; | |
337 | } __attribute__ ((packed)); | |
338 | ||
339 | #define USB_DT_ENDPOINT_SIZE 7 | |
340 | #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */ | |
341 | ||
342 | ||
343 | /* | |
344 | * Endpoints | |
345 | */ | |
346 | #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */ | |
347 | #define USB_ENDPOINT_DIR_MASK 0x80 | |
348 | ||
349 | #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */ | |
350 | #define USB_ENDPOINT_XFER_CONTROL 0 | |
351 | #define USB_ENDPOINT_XFER_ISOC 1 | |
352 | #define USB_ENDPOINT_XFER_BULK 2 | |
353 | #define USB_ENDPOINT_XFER_INT 3 | |
5da0106f | 354 | #define USB_ENDPOINT_MAX_ADJUSTABLE 0x80 |
1da177e4 | 355 | |
4d6914b7 JL |
356 | /*-------------------------------------------------------------------------*/ |
357 | ||
358 | /** | |
359 | * usb_endpoint_num - get the endpoint's number | |
360 | * @epd: endpoint to be checked | |
361 | * | |
362 | * Returns @epd's number: 0 to 15. | |
363 | */ | |
364 | static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd) | |
365 | { | |
366 | return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK; | |
367 | } | |
368 | ||
369 | /** | |
370 | * usb_endpoint_type - get the endpoint's transfer type | |
371 | * @epd: endpoint to be checked | |
372 | * | |
373 | * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according | |
374 | * to @epd's transfer type. | |
375 | */ | |
376 | static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd) | |
377 | { | |
378 | return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK; | |
379 | } | |
380 | ||
381 | /** | |
382 | * usb_endpoint_dir_in - check if the endpoint has IN direction | |
383 | * @epd: endpoint to be checked | |
384 | * | |
385 | * Returns true if the endpoint is of type IN, otherwise it returns false. | |
386 | */ | |
387 | static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd) | |
388 | { | |
389 | return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN); | |
390 | } | |
391 | ||
392 | /** | |
393 | * usb_endpoint_dir_out - check if the endpoint has OUT direction | |
394 | * @epd: endpoint to be checked | |
395 | * | |
396 | * Returns true if the endpoint is of type OUT, otherwise it returns false. | |
397 | */ | |
398 | static inline int usb_endpoint_dir_out( | |
399 | const struct usb_endpoint_descriptor *epd) | |
400 | { | |
401 | return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT); | |
402 | } | |
403 | ||
404 | /** | |
405 | * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type | |
406 | * @epd: endpoint to be checked | |
407 | * | |
408 | * Returns true if the endpoint is of type bulk, otherwise it returns false. | |
409 | */ | |
410 | static inline int usb_endpoint_xfer_bulk( | |
411 | const struct usb_endpoint_descriptor *epd) | |
412 | { | |
413 | return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == | |
414 | USB_ENDPOINT_XFER_BULK); | |
415 | } | |
416 | ||
417 | /** | |
418 | * usb_endpoint_xfer_control - check if the endpoint has control transfer type | |
419 | * @epd: endpoint to be checked | |
420 | * | |
421 | * Returns true if the endpoint is of type control, otherwise it returns false. | |
422 | */ | |
423 | static inline int usb_endpoint_xfer_control( | |
424 | const struct usb_endpoint_descriptor *epd) | |
425 | { | |
426 | return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == | |
427 | USB_ENDPOINT_XFER_CONTROL); | |
428 | } | |
429 | ||
430 | /** | |
431 | * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type | |
432 | * @epd: endpoint to be checked | |
433 | * | |
434 | * Returns true if the endpoint is of type interrupt, otherwise it returns | |
435 | * false. | |
436 | */ | |
437 | static inline int usb_endpoint_xfer_int( | |
438 | const struct usb_endpoint_descriptor *epd) | |
439 | { | |
440 | return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == | |
441 | USB_ENDPOINT_XFER_INT); | |
442 | } | |
443 | ||
444 | /** | |
445 | * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type | |
446 | * @epd: endpoint to be checked | |
447 | * | |
448 | * Returns true if the endpoint is of type isochronous, otherwise it returns | |
449 | * false. | |
450 | */ | |
451 | static inline int usb_endpoint_xfer_isoc( | |
452 | const struct usb_endpoint_descriptor *epd) | |
453 | { | |
454 | return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == | |
455 | USB_ENDPOINT_XFER_ISOC); | |
456 | } | |
457 | ||
458 | /** | |
459 | * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN | |
460 | * @epd: endpoint to be checked | |
461 | * | |
462 | * Returns true if the endpoint has bulk transfer type and IN direction, | |
463 | * otherwise it returns false. | |
464 | */ | |
465 | static inline int usb_endpoint_is_bulk_in( | |
466 | const struct usb_endpoint_descriptor *epd) | |
467 | { | |
468 | return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd)); | |
469 | } | |
470 | ||
471 | /** | |
472 | * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT | |
473 | * @epd: endpoint to be checked | |
474 | * | |
475 | * Returns true if the endpoint has bulk transfer type and OUT direction, | |
476 | * otherwise it returns false. | |
477 | */ | |
478 | static inline int usb_endpoint_is_bulk_out( | |
479 | const struct usb_endpoint_descriptor *epd) | |
480 | { | |
481 | return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd)); | |
482 | } | |
483 | ||
484 | /** | |
485 | * usb_endpoint_is_int_in - check if the endpoint is interrupt IN | |
486 | * @epd: endpoint to be checked | |
487 | * | |
488 | * Returns true if the endpoint has interrupt transfer type and IN direction, | |
489 | * otherwise it returns false. | |
490 | */ | |
491 | static inline int usb_endpoint_is_int_in( | |
492 | const struct usb_endpoint_descriptor *epd) | |
493 | { | |
494 | return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd)); | |
495 | } | |
496 | ||
497 | /** | |
498 | * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT | |
499 | * @epd: endpoint to be checked | |
500 | * | |
501 | * Returns true if the endpoint has interrupt transfer type and OUT direction, | |
502 | * otherwise it returns false. | |
503 | */ | |
504 | static inline int usb_endpoint_is_int_out( | |
505 | const struct usb_endpoint_descriptor *epd) | |
506 | { | |
507 | return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd)); | |
508 | } | |
509 | ||
510 | /** | |
511 | * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN | |
512 | * @epd: endpoint to be checked | |
513 | * | |
514 | * Returns true if the endpoint has isochronous transfer type and IN direction, | |
515 | * otherwise it returns false. | |
516 | */ | |
517 | static inline int usb_endpoint_is_isoc_in( | |
518 | const struct usb_endpoint_descriptor *epd) | |
519 | { | |
520 | return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd)); | |
521 | } | |
522 | ||
523 | /** | |
524 | * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT | |
525 | * @epd: endpoint to be checked | |
526 | * | |
527 | * Returns true if the endpoint has isochronous transfer type and OUT direction, | |
528 | * otherwise it returns false. | |
529 | */ | |
530 | static inline int usb_endpoint_is_isoc_out( | |
531 | const struct usb_endpoint_descriptor *epd) | |
532 | { | |
533 | return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd)); | |
534 | } | |
1da177e4 LT |
535 | |
536 | /*-------------------------------------------------------------------------*/ | |
537 | ||
538 | /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */ | |
539 | struct usb_qualifier_descriptor { | |
540 | __u8 bLength; | |
541 | __u8 bDescriptorType; | |
542 | ||
543 | __le16 bcdUSB; | |
544 | __u8 bDeviceClass; | |
545 | __u8 bDeviceSubClass; | |
546 | __u8 bDeviceProtocol; | |
547 | __u8 bMaxPacketSize0; | |
548 | __u8 bNumConfigurations; | |
549 | __u8 bRESERVED; | |
550 | } __attribute__ ((packed)); | |
551 | ||
552 | ||
553 | /*-------------------------------------------------------------------------*/ | |
554 | ||
555 | /* USB_DT_OTG (from OTG 1.0a supplement) */ | |
556 | struct usb_otg_descriptor { | |
557 | __u8 bLength; | |
558 | __u8 bDescriptorType; | |
559 | ||
560 | __u8 bmAttributes; /* support for HNP, SRP, etc */ | |
561 | } __attribute__ ((packed)); | |
562 | ||
563 | /* from usb_otg_descriptor.bmAttributes */ | |
564 | #define USB_OTG_SRP (1 << 0) | |
565 | #define USB_OTG_HNP (1 << 1) /* swap host/device roles */ | |
566 | ||
567 | /*-------------------------------------------------------------------------*/ | |
568 | ||
569 | /* USB_DT_DEBUG: for special highspeed devices, replacing serial console */ | |
570 | struct usb_debug_descriptor { | |
571 | __u8 bLength; | |
572 | __u8 bDescriptorType; | |
573 | ||
574 | /* bulk endpoints with 8 byte maxpacket */ | |
575 | __u8 bDebugInEndpoint; | |
576 | __u8 bDebugOutEndpoint; | |
23004e24 | 577 | } __attribute__((packed)); |
1da177e4 LT |
578 | |
579 | /*-------------------------------------------------------------------------*/ | |
580 | ||
581 | /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */ | |
582 | struct usb_interface_assoc_descriptor { | |
583 | __u8 bLength; | |
584 | __u8 bDescriptorType; | |
585 | ||
586 | __u8 bFirstInterface; | |
587 | __u8 bInterfaceCount; | |
588 | __u8 bFunctionClass; | |
589 | __u8 bFunctionSubClass; | |
590 | __u8 bFunctionProtocol; | |
591 | __u8 iFunction; | |
592 | } __attribute__ ((packed)); | |
593 | ||
594 | ||
5da0106f DB |
595 | /*-------------------------------------------------------------------------*/ |
596 | ||
597 | /* USB_DT_SECURITY: group of wireless security descriptors, including | |
598 | * encryption types available for setting up a CC/association. | |
599 | */ | |
600 | struct usb_security_descriptor { | |
601 | __u8 bLength; | |
602 | __u8 bDescriptorType; | |
603 | ||
604 | __le16 wTotalLength; | |
605 | __u8 bNumEncryptionTypes; | |
23004e24 | 606 | } __attribute__((packed)); |
5da0106f DB |
607 | |
608 | /*-------------------------------------------------------------------------*/ | |
609 | ||
610 | /* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys | |
611 | * may be retrieved. | |
612 | */ | |
613 | struct usb_key_descriptor { | |
614 | __u8 bLength; | |
615 | __u8 bDescriptorType; | |
616 | ||
617 | __u8 tTKID[3]; | |
618 | __u8 bReserved; | |
619 | __u8 bKeyData[0]; | |
23004e24 | 620 | } __attribute__((packed)); |
5da0106f DB |
621 | |
622 | /*-------------------------------------------------------------------------*/ | |
623 | ||
624 | /* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */ | |
625 | struct usb_encryption_descriptor { | |
626 | __u8 bLength; | |
627 | __u8 bDescriptorType; | |
628 | ||
629 | __u8 bEncryptionType; | |
630 | #define USB_ENC_TYPE_UNSECURE 0 | |
631 | #define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */ | |
632 | #define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */ | |
633 | #define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */ | |
634 | __u8 bEncryptionValue; /* use in SET_ENCRYPTION */ | |
635 | __u8 bAuthKeyIndex; | |
23004e24 | 636 | } __attribute__((packed)); |
5da0106f DB |
637 | |
638 | ||
639 | /*-------------------------------------------------------------------------*/ | |
640 | ||
35e5437e | 641 | /* USB_DT_BOS: group of device-level capabilities */ |
5da0106f DB |
642 | struct usb_bos_descriptor { |
643 | __u8 bLength; | |
644 | __u8 bDescriptorType; | |
645 | ||
646 | __le16 wTotalLength; | |
647 | __u8 bNumDeviceCaps; | |
23004e24 | 648 | } __attribute__((packed)); |
5da0106f DB |
649 | |
650 | /*-------------------------------------------------------------------------*/ | |
651 | ||
652 | /* USB_DT_DEVICE_CAPABILITY: grouped with BOS */ | |
653 | struct usb_dev_cap_header { | |
654 | __u8 bLength; | |
655 | __u8 bDescriptorType; | |
656 | __u8 bDevCapabilityType; | |
23004e24 | 657 | } __attribute__((packed)); |
5da0106f DB |
658 | |
659 | #define USB_CAP_TYPE_WIRELESS_USB 1 | |
660 | ||
661 | struct usb_wireless_cap_descriptor { /* Ultra Wide Band */ | |
662 | __u8 bLength; | |
663 | __u8 bDescriptorType; | |
664 | __u8 bDevCapabilityType; | |
665 | ||
666 | __u8 bmAttributes; | |
667 | #define USB_WIRELESS_P2P_DRD (1 << 1) | |
668 | #define USB_WIRELESS_BEACON_MASK (3 << 2) | |
669 | #define USB_WIRELESS_BEACON_SELF (1 << 2) | |
670 | #define USB_WIRELESS_BEACON_DIRECTED (2 << 2) | |
671 | #define USB_WIRELESS_BEACON_NONE (3 << 2) | |
672 | __le16 wPHYRates; /* bit rates, Mbps */ | |
673 | #define USB_WIRELESS_PHY_53 (1 << 0) /* always set */ | |
674 | #define USB_WIRELESS_PHY_80 (1 << 1) | |
675 | #define USB_WIRELESS_PHY_107 (1 << 2) /* always set */ | |
676 | #define USB_WIRELESS_PHY_160 (1 << 3) | |
677 | #define USB_WIRELESS_PHY_200 (1 << 4) /* always set */ | |
678 | #define USB_WIRELESS_PHY_320 (1 << 5) | |
679 | #define USB_WIRELESS_PHY_400 (1 << 6) | |
680 | #define USB_WIRELESS_PHY_480 (1 << 7) | |
681 | __u8 bmTFITXPowerInfo; /* TFI power levels */ | |
682 | __u8 bmFFITXPowerInfo; /* FFI power levels */ | |
683 | __le16 bmBandGroup; | |
684 | __u8 bReserved; | |
23004e24 | 685 | } __attribute__((packed)); |
5da0106f | 686 | |
35e5437e SS |
687 | #define USB_CAP_TYPE_EXT 2 |
688 | ||
689 | struct usb_ext_cap_descriptor { /* Link Power Management */ | |
690 | __u8 bLength; | |
691 | __u8 bDescriptorType; | |
692 | __u8 bDevCapabilityType; | |
693 | __u8 bmAttributes; | |
694 | #define USB_LPM_SUPPORT (1 << 1) /* supports LPM */ | |
695 | } __attribute__((packed)); | |
696 | ||
5da0106f DB |
697 | /*-------------------------------------------------------------------------*/ |
698 | ||
699 | /* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with | |
700 | * each endpoint descriptor for a wireless device | |
701 | */ | |
702 | struct usb_wireless_ep_comp_descriptor { | |
703 | __u8 bLength; | |
704 | __u8 bDescriptorType; | |
705 | ||
706 | __u8 bMaxBurst; | |
707 | __u8 bMaxSequence; | |
708 | __le16 wMaxStreamDelay; | |
709 | __le16 wOverTheAirPacketSize; | |
710 | __u8 bOverTheAirInterval; | |
711 | __u8 bmCompAttributes; | |
712 | #define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */ | |
713 | #define USB_ENDPOINT_SWITCH_NO 0 | |
714 | #define USB_ENDPOINT_SWITCH_SWITCH 1 | |
715 | #define USB_ENDPOINT_SWITCH_SCALE 2 | |
23004e24 | 716 | } __attribute__((packed)); |
5da0106f DB |
717 | |
718 | /*-------------------------------------------------------------------------*/ | |
719 | ||
720 | /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless | |
721 | * host and a device for connection set up, mutual authentication, and | |
722 | * exchanging short lived session keys. The handshake depends on a CC. | |
723 | */ | |
724 | struct usb_handshake { | |
725 | __u8 bMessageNumber; | |
726 | __u8 bStatus; | |
727 | __u8 tTKID[3]; | |
728 | __u8 bReserved; | |
729 | __u8 CDID[16]; | |
730 | __u8 nonce[16]; | |
731 | __u8 MIC[8]; | |
23004e24 | 732 | } __attribute__((packed)); |
5da0106f DB |
733 | |
734 | /*-------------------------------------------------------------------------*/ | |
735 | ||
736 | /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC). | |
737 | * A CC may also be set up using non-wireless secure channels (including | |
738 | * wired USB!), and some devices may support CCs with multiple hosts. | |
739 | */ | |
740 | struct usb_connection_context { | |
741 | __u8 CHID[16]; /* persistent host id */ | |
742 | __u8 CDID[16]; /* device id (unique w/in host context) */ | |
743 | __u8 CK[16]; /* connection key */ | |
23004e24 | 744 | } __attribute__((packed)); |
5da0106f | 745 | |
1da177e4 LT |
746 | /*-------------------------------------------------------------------------*/ |
747 | ||
748 | /* USB 2.0 defines three speeds, here's how Linux identifies them */ | |
749 | ||
750 | enum usb_device_speed { | |
751 | USB_SPEED_UNKNOWN = 0, /* enumerating */ | |
752 | USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */ | |
5da0106f DB |
753 | USB_SPEED_HIGH, /* usb 2.0 */ |
754 | USB_SPEED_VARIABLE, /* wireless (usb 2.5) */ | |
1da177e4 LT |
755 | }; |
756 | ||
757 | enum usb_device_state { | |
758 | /* NOTATTACHED isn't in the USB spec, and this state acts | |
759 | * the same as ATTACHED ... but it's clearer this way. | |
760 | */ | |
761 | USB_STATE_NOTATTACHED = 0, | |
762 | ||
c02c4bb2 | 763 | /* chapter 9 and authentication (wireless) device states */ |
1da177e4 | 764 | USB_STATE_ATTACHED, |
c02c4bb2 | 765 | USB_STATE_POWERED, /* wired */ |
c02c4bb2 | 766 | USB_STATE_RECONNECTING, /* auth */ |
6da9c990 | 767 | USB_STATE_UNAUTHENTICATED, /* auth */ |
1da177e4 LT |
768 | USB_STATE_DEFAULT, /* limited function */ |
769 | USB_STATE_ADDRESS, | |
770 | USB_STATE_CONFIGURED, /* most functions */ | |
771 | ||
772 | USB_STATE_SUSPENDED | |
773 | ||
774 | /* NOTE: there are actually four different SUSPENDED | |
775 | * states, returning to POWERED, DEFAULT, ADDRESS, or | |
776 | * CONFIGURED respectively when SOF tokens flow again. | |
dbe0dbb7 DB |
777 | * At this level there's no difference between L1 and L2 |
778 | * suspend states. (L2 being original USB 1.1 suspend.) | |
1da177e4 LT |
779 | */ |
780 | }; | |
781 | ||
dda43a0e | 782 | #endif /* __LINUX_USB_CH9_H */ |