blob: e58369ff8168b7a81058efa3b060a807284ff73f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Inaky Perez-Gonzalez672027a2007-02-22 16:37:53 -08002 * 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:
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
8 * - the master/host side Linux-USB kernel driver API;
9 * - the "usbfs" user space API; and
David Brownell5da01062005-05-31 10:21:11 -070010 * - the Linux "gadget" slave/device/peripheral side driver API.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 *
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
David Brownell5da01062005-05-31 10:21:11 -070014 * 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.
Inaky Perez-Gonzalez672027a2007-02-22 16:37:53 -080018 *
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 */
32
33#ifndef __LINUX_USB_CH9_H
34#define __LINUX_USB_CH9_H
35
GOTO Masanori4cceb4d2005-06-28 20:45:05 -070036#include <linux/types.h> /* __u8 etc */
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
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
Inaky Perez-Gonzalez5b5daf72006-06-19 18:19:01 -070068/* From Wireless USB 1.0 */
David Brownelldbe0dbb2008-02-10 12:24:00 -080069#define USB_RECIP_PORT 0x04
70#define USB_RECIP_RPIPE 0x05
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
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
David Brownell5da01062005-05-31 10:21:11 -070091#define USB_REQ_SET_ENCRYPTION 0x0D /* Wireless USB */
92#define USB_REQ_GET_ENCRYPTION 0x0E
Inaky Perez-Gonzalez5b5daf72006-06-19 18:19:01 -070093#define USB_REQ_RPIPE_ABORT 0x0E
David Brownell5da01062005-05-31 10:21:11 -070094#define USB_REQ_SET_HANDSHAKE 0x0F
Inaky Perez-Gonzalez5b5daf72006-06-19 18:19:01 -070095#define USB_REQ_RPIPE_RESET 0x0F
David Brownell5da01062005-05-31 10:21:11 -070096#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
D.J. Capelis64a3a252009-03-04 10:27:52 -0800105/* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command,
David Brownelldbe0dbb2008-02-10 12:24:00 -0800106 * used by hubs to put ports into a new L1 suspend state, except that it
107 * forgot to define its number ...
108 */
109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110/*
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
David Brownelldbe0dbb2008-02-10 12:24:00 -0800113 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 */
116#define USB_DEVICE_SELF_POWERED 0 /* (read only) */
117#define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */
David Brownell5da01062005-05-31 10:21:11 -0700118#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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124#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 */
146struct 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
Phil Endecott9a9fafb82008-12-01 10:22:33 -0500161 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 */
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
David Brownell5da01062005-05-31 10:21:11 -0700184/* 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
Inaky Perez-Gonzalez5b5daf72006-06-19 18:19:01 -0700191#define USB_DT_WIRE_ADAPTER 0x21
192#define USB_DT_RPIPE 0x22
Greg Kroah-Hartmanc27a4b72008-04-08 13:24:46 -0700193#define USB_DT_CS_RADIO_CONTROL 0x23
Sarah Sharp663c30d2009-04-27 19:58:14 -0700194/* From the USB 3.0 spec */
195#define USB_DT_SS_ENDPOINT_COMP 0x30
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
David Brownellaa2ce5c2007-04-17 17:51:38 -0700197/* Conventional codes for class-specific descriptors. The convention is
198 * defined in the USB "Common Class" Spec (3.11). Individual class specs
199 * are authoritative for their usage, not the "common class" writeup.
200 */
201#define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE)
202#define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG)
203#define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING)
204#define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE)
205#define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207/* All standard descriptors have these 2 fields at the beginning */
208struct usb_descriptor_header {
209 __u8 bLength;
210 __u8 bDescriptorType;
211} __attribute__ ((packed));
212
213
214/*-------------------------------------------------------------------------*/
215
216/* USB_DT_DEVICE: Device descriptor */
217struct usb_device_descriptor {
218 __u8 bLength;
219 __u8 bDescriptorType;
220
221 __le16 bcdUSB;
222 __u8 bDeviceClass;
223 __u8 bDeviceSubClass;
224 __u8 bDeviceProtocol;
225 __u8 bMaxPacketSize0;
226 __le16 idVendor;
227 __le16 idProduct;
228 __le16 bcdDevice;
229 __u8 iManufacturer;
230 __u8 iProduct;
231 __u8 iSerialNumber;
232 __u8 bNumConfigurations;
233} __attribute__ ((packed));
234
235#define USB_DT_DEVICE_SIZE 18
236
237
238/*
239 * Device and/or Interface Class codes
240 * as found in bDeviceClass or bInterfaceClass
241 * and defined by www.usb.org documents
242 */
243#define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
244#define USB_CLASS_AUDIO 1
245#define USB_CLASS_COMM 2
246#define USB_CLASS_HID 3
247#define USB_CLASS_PHYSICAL 5
248#define USB_CLASS_STILL_IMAGE 6
249#define USB_CLASS_PRINTER 7
250#define USB_CLASS_MASS_STORAGE 8
251#define USB_CLASS_HUB 9
252#define USB_CLASS_CDC_DATA 0x0a
253#define USB_CLASS_CSCID 0x0b /* chip+ smart card */
254#define USB_CLASS_CONTENT_SEC 0x0d /* content security */
255#define USB_CLASS_VIDEO 0x0e
David Brownell5da01062005-05-31 10:21:11 -0700256#define USB_CLASS_WIRELESS_CONTROLLER 0xe0
David Brownelle7d87122006-12-12 15:12:30 -0800257#define USB_CLASS_MISC 0xef
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#define USB_CLASS_APP_SPEC 0xfe
259#define USB_CLASS_VENDOR_SPEC 0xff
260
Laurent Pinchart315ad302009-06-21 23:20:39 +0200261#define USB_SUBCLASS_VENDOR_SPEC 0xff
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263/*-------------------------------------------------------------------------*/
264
265/* USB_DT_CONFIG: Configuration descriptor information.
266 *
267 * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
268 * descriptor type is different. Highspeed-capable devices can look
269 * different depending on what speed they're currently running. Only
270 * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
271 * descriptors.
272 */
273struct usb_config_descriptor {
274 __u8 bLength;
275 __u8 bDescriptorType;
276
277 __le16 wTotalLength;
278 __u8 bNumInterfaces;
279 __u8 bConfigurationValue;
280 __u8 iConfiguration;
281 __u8 bmAttributes;
282 __u8 bMaxPower;
283} __attribute__ ((packed));
284
285#define USB_DT_CONFIG_SIZE 9
286
287/* from config descriptor bmAttributes */
288#define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */
289#define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */
290#define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */
David Brownell5da01062005-05-31 10:21:11 -0700291#define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
293/*-------------------------------------------------------------------------*/
294
295/* USB_DT_STRING: String descriptor */
296struct usb_string_descriptor {
297 __u8 bLength;
298 __u8 bDescriptorType;
299
300 __le16 wData[1]; /* UTF-16LE encoded */
301} __attribute__ ((packed));
302
303/* note that "string" zero is special, it holds language codes that
304 * the device supports, not Unicode characters.
305 */
306
307/*-------------------------------------------------------------------------*/
308
309/* USB_DT_INTERFACE: Interface descriptor */
310struct usb_interface_descriptor {
311 __u8 bLength;
312 __u8 bDescriptorType;
313
314 __u8 bInterfaceNumber;
315 __u8 bAlternateSetting;
316 __u8 bNumEndpoints;
317 __u8 bInterfaceClass;
318 __u8 bInterfaceSubClass;
319 __u8 bInterfaceProtocol;
320 __u8 iInterface;
321} __attribute__ ((packed));
322
323#define USB_DT_INTERFACE_SIZE 9
324
325/*-------------------------------------------------------------------------*/
326
327/* USB_DT_ENDPOINT: Endpoint descriptor */
328struct usb_endpoint_descriptor {
329 __u8 bLength;
330 __u8 bDescriptorType;
331
332 __u8 bEndpointAddress;
333 __u8 bmAttributes;
334 __le16 wMaxPacketSize;
335 __u8 bInterval;
336
GOTO Masanori4cceb4d2005-06-28 20:45:05 -0700337 /* NOTE: these two are _only_ in audio endpoints. */
338 /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 __u8 bRefresh;
340 __u8 bSynchAddress;
341} __attribute__ ((packed));
342
343#define USB_DT_ENDPOINT_SIZE 7
344#define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
345
346
347/*
348 * Endpoints
349 */
350#define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
351#define USB_ENDPOINT_DIR_MASK 0x80
352
Laurent Pinchart85e08ca2009-06-21 23:19:23 +0200353#define USB_ENDPOINT_SYNCTYPE 0x0c
354#define USB_ENDPOINT_SYNC_NONE (0 << 2)
355#define USB_ENDPOINT_SYNC_ASYNC (1 << 2)
356#define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2)
357#define USB_ENDPOINT_SYNC_SYNC (3 << 2)
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359#define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
360#define USB_ENDPOINT_XFER_CONTROL 0
361#define USB_ENDPOINT_XFER_ISOC 1
362#define USB_ENDPOINT_XFER_BULK 2
363#define USB_ENDPOINT_XFER_INT 3
David Brownell5da01062005-05-31 10:21:11 -0700364#define USB_ENDPOINT_MAX_ADJUSTABLE 0x80
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
Julia Lawall4d6914b2008-12-29 22:48:19 +0100366/*-------------------------------------------------------------------------*/
367
368/**
369 * usb_endpoint_num - get the endpoint's number
370 * @epd: endpoint to be checked
371 *
372 * Returns @epd's number: 0 to 15.
373 */
374static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
375{
376 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
377}
378
379/**
380 * usb_endpoint_type - get the endpoint's transfer type
381 * @epd: endpoint to be checked
382 *
383 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
384 * to @epd's transfer type.
385 */
386static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
387{
388 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
389}
390
391/**
392 * usb_endpoint_dir_in - check if the endpoint has IN direction
393 * @epd: endpoint to be checked
394 *
395 * Returns true if the endpoint is of type IN, otherwise it returns false.
396 */
397static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
398{
399 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
400}
401
402/**
403 * usb_endpoint_dir_out - check if the endpoint has OUT direction
404 * @epd: endpoint to be checked
405 *
406 * Returns true if the endpoint is of type OUT, otherwise it returns false.
407 */
408static inline int usb_endpoint_dir_out(
409 const struct usb_endpoint_descriptor *epd)
410{
411 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
412}
413
414/**
415 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
416 * @epd: endpoint to be checked
417 *
418 * Returns true if the endpoint is of type bulk, otherwise it returns false.
419 */
420static inline int usb_endpoint_xfer_bulk(
421 const struct usb_endpoint_descriptor *epd)
422{
423 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
424 USB_ENDPOINT_XFER_BULK);
425}
426
427/**
428 * usb_endpoint_xfer_control - check if the endpoint has control transfer type
429 * @epd: endpoint to be checked
430 *
431 * Returns true if the endpoint is of type control, otherwise it returns false.
432 */
433static inline int usb_endpoint_xfer_control(
434 const struct usb_endpoint_descriptor *epd)
435{
436 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
437 USB_ENDPOINT_XFER_CONTROL);
438}
439
440/**
441 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
442 * @epd: endpoint to be checked
443 *
444 * Returns true if the endpoint is of type interrupt, otherwise it returns
445 * false.
446 */
447static inline int usb_endpoint_xfer_int(
448 const struct usb_endpoint_descriptor *epd)
449{
450 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
451 USB_ENDPOINT_XFER_INT);
452}
453
454/**
455 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
456 * @epd: endpoint to be checked
457 *
458 * Returns true if the endpoint is of type isochronous, otherwise it returns
459 * false.
460 */
461static inline int usb_endpoint_xfer_isoc(
462 const struct usb_endpoint_descriptor *epd)
463{
464 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
465 USB_ENDPOINT_XFER_ISOC);
466}
467
468/**
469 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
470 * @epd: endpoint to be checked
471 *
472 * Returns true if the endpoint has bulk transfer type and IN direction,
473 * otherwise it returns false.
474 */
475static inline int usb_endpoint_is_bulk_in(
476 const struct usb_endpoint_descriptor *epd)
477{
478 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd));
479}
480
481/**
482 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
483 * @epd: endpoint to be checked
484 *
485 * Returns true if the endpoint has bulk transfer type and OUT direction,
486 * otherwise it returns false.
487 */
488static inline int usb_endpoint_is_bulk_out(
489 const struct usb_endpoint_descriptor *epd)
490{
491 return (usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd));
492}
493
494/**
495 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
496 * @epd: endpoint to be checked
497 *
498 * Returns true if the endpoint has interrupt transfer type and IN direction,
499 * otherwise it returns false.
500 */
501static inline int usb_endpoint_is_int_in(
502 const struct usb_endpoint_descriptor *epd)
503{
504 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd));
505}
506
507/**
508 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
509 * @epd: endpoint to be checked
510 *
511 * Returns true if the endpoint has interrupt transfer type and OUT direction,
512 * otherwise it returns false.
513 */
514static inline int usb_endpoint_is_int_out(
515 const struct usb_endpoint_descriptor *epd)
516{
517 return (usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd));
518}
519
520/**
521 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
522 * @epd: endpoint to be checked
523 *
524 * Returns true if the endpoint has isochronous transfer type and IN direction,
525 * otherwise it returns false.
526 */
527static inline int usb_endpoint_is_isoc_in(
528 const struct usb_endpoint_descriptor *epd)
529{
530 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd));
531}
532
533/**
534 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
535 * @epd: endpoint to be checked
536 *
537 * Returns true if the endpoint has isochronous transfer type and OUT direction,
538 * otherwise it returns false.
539 */
540static inline int usb_endpoint_is_isoc_out(
541 const struct usb_endpoint_descriptor *epd)
542{
543 return (usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd));
544}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
546/*-------------------------------------------------------------------------*/
547
Sarah Sharp663c30d2009-04-27 19:58:14 -0700548/* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
Sarah Sharpf0058c62009-04-29 19:06:20 -0700549struct usb_ss_ep_comp_descriptor {
Sarah Sharp663c30d2009-04-27 19:58:14 -0700550 __u8 bLength;
551 __u8 bDescriptorType;
552
553 __u8 bMaxBurst;
554 __u8 bmAttributes;
555 __u16 wBytesPerInterval;
556} __attribute__ ((packed));
557
Sarah Sharpf0058c62009-04-29 19:06:20 -0700558#define USB_DT_SS_EP_COMP_SIZE 6
Sarah Sharp663c30d2009-04-27 19:58:14 -0700559
560/*-------------------------------------------------------------------------*/
561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562/* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
563struct usb_qualifier_descriptor {
564 __u8 bLength;
565 __u8 bDescriptorType;
566
567 __le16 bcdUSB;
568 __u8 bDeviceClass;
569 __u8 bDeviceSubClass;
570 __u8 bDeviceProtocol;
571 __u8 bMaxPacketSize0;
572 __u8 bNumConfigurations;
573 __u8 bRESERVED;
574} __attribute__ ((packed));
575
576
577/*-------------------------------------------------------------------------*/
578
579/* USB_DT_OTG (from OTG 1.0a supplement) */
580struct usb_otg_descriptor {
581 __u8 bLength;
582 __u8 bDescriptorType;
583
584 __u8 bmAttributes; /* support for HNP, SRP, etc */
585} __attribute__ ((packed));
586
587/* from usb_otg_descriptor.bmAttributes */
588#define USB_OTG_SRP (1 << 0)
589#define USB_OTG_HNP (1 << 1) /* swap host/device roles */
590
591/*-------------------------------------------------------------------------*/
592
593/* USB_DT_DEBUG: for special highspeed devices, replacing serial console */
594struct usb_debug_descriptor {
595 __u8 bLength;
596 __u8 bDescriptorType;
597
598 /* bulk endpoints with 8 byte maxpacket */
599 __u8 bDebugInEndpoint;
600 __u8 bDebugOutEndpoint;
Inaky Perez-Gonzalez23004e22007-02-02 17:32:24 -0800601} __attribute__((packed));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
603/*-------------------------------------------------------------------------*/
604
605/* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
606struct usb_interface_assoc_descriptor {
607 __u8 bLength;
608 __u8 bDescriptorType;
609
610 __u8 bFirstInterface;
611 __u8 bInterfaceCount;
612 __u8 bFunctionClass;
613 __u8 bFunctionSubClass;
614 __u8 bFunctionProtocol;
615 __u8 iFunction;
616} __attribute__ ((packed));
617
618
619/*-------------------------------------------------------------------------*/
620
David Brownell5da01062005-05-31 10:21:11 -0700621/* USB_DT_SECURITY: group of wireless security descriptors, including
622 * encryption types available for setting up a CC/association.
623 */
624struct usb_security_descriptor {
625 __u8 bLength;
626 __u8 bDescriptorType;
627
628 __le16 wTotalLength;
629 __u8 bNumEncryptionTypes;
Inaky Perez-Gonzalez23004e22007-02-02 17:32:24 -0800630} __attribute__((packed));
David Brownell5da01062005-05-31 10:21:11 -0700631
632/*-------------------------------------------------------------------------*/
633
634/* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys
635 * may be retrieved.
636 */
637struct usb_key_descriptor {
638 __u8 bLength;
639 __u8 bDescriptorType;
640
641 __u8 tTKID[3];
642 __u8 bReserved;
643 __u8 bKeyData[0];
Inaky Perez-Gonzalez23004e22007-02-02 17:32:24 -0800644} __attribute__((packed));
David Brownell5da01062005-05-31 10:21:11 -0700645
646/*-------------------------------------------------------------------------*/
647
648/* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */
649struct usb_encryption_descriptor {
650 __u8 bLength;
651 __u8 bDescriptorType;
652
653 __u8 bEncryptionType;
654#define USB_ENC_TYPE_UNSECURE 0
655#define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */
656#define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */
657#define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */
658 __u8 bEncryptionValue; /* use in SET_ENCRYPTION */
659 __u8 bAuthKeyIndex;
Inaky Perez-Gonzalez23004e22007-02-02 17:32:24 -0800660} __attribute__((packed));
David Brownell5da01062005-05-31 10:21:11 -0700661
662
663/*-------------------------------------------------------------------------*/
664
Sarah Sharp35e54372008-04-25 16:46:45 -0700665/* USB_DT_BOS: group of device-level capabilities */
David Brownell5da01062005-05-31 10:21:11 -0700666struct usb_bos_descriptor {
667 __u8 bLength;
668 __u8 bDescriptorType;
669
670 __le16 wTotalLength;
671 __u8 bNumDeviceCaps;
Inaky Perez-Gonzalez23004e22007-02-02 17:32:24 -0800672} __attribute__((packed));
David Brownell5da01062005-05-31 10:21:11 -0700673
674/*-------------------------------------------------------------------------*/
675
676/* USB_DT_DEVICE_CAPABILITY: grouped with BOS */
677struct usb_dev_cap_header {
678 __u8 bLength;
679 __u8 bDescriptorType;
680 __u8 bDevCapabilityType;
Inaky Perez-Gonzalez23004e22007-02-02 17:32:24 -0800681} __attribute__((packed));
David Brownell5da01062005-05-31 10:21:11 -0700682
683#define USB_CAP_TYPE_WIRELESS_USB 1
684
685struct usb_wireless_cap_descriptor { /* Ultra Wide Band */
686 __u8 bLength;
687 __u8 bDescriptorType;
688 __u8 bDevCapabilityType;
689
690 __u8 bmAttributes;
691#define USB_WIRELESS_P2P_DRD (1 << 1)
692#define USB_WIRELESS_BEACON_MASK (3 << 2)
693#define USB_WIRELESS_BEACON_SELF (1 << 2)
694#define USB_WIRELESS_BEACON_DIRECTED (2 << 2)
695#define USB_WIRELESS_BEACON_NONE (3 << 2)
696 __le16 wPHYRates; /* bit rates, Mbps */
697#define USB_WIRELESS_PHY_53 (1 << 0) /* always set */
698#define USB_WIRELESS_PHY_80 (1 << 1)
699#define USB_WIRELESS_PHY_107 (1 << 2) /* always set */
700#define USB_WIRELESS_PHY_160 (1 << 3)
701#define USB_WIRELESS_PHY_200 (1 << 4) /* always set */
702#define USB_WIRELESS_PHY_320 (1 << 5)
703#define USB_WIRELESS_PHY_400 (1 << 6)
704#define USB_WIRELESS_PHY_480 (1 << 7)
705 __u8 bmTFITXPowerInfo; /* TFI power levels */
706 __u8 bmFFITXPowerInfo; /* FFI power levels */
707 __le16 bmBandGroup;
708 __u8 bReserved;
Inaky Perez-Gonzalez23004e22007-02-02 17:32:24 -0800709} __attribute__((packed));
David Brownell5da01062005-05-31 10:21:11 -0700710
Sarah Sharp35e54372008-04-25 16:46:45 -0700711#define USB_CAP_TYPE_EXT 2
712
713struct usb_ext_cap_descriptor { /* Link Power Management */
714 __u8 bLength;
715 __u8 bDescriptorType;
716 __u8 bDevCapabilityType;
717 __u8 bmAttributes;
718#define USB_LPM_SUPPORT (1 << 1) /* supports LPM */
719} __attribute__((packed));
720
David Brownell5da01062005-05-31 10:21:11 -0700721/*-------------------------------------------------------------------------*/
722
723/* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with
724 * each endpoint descriptor for a wireless device
725 */
726struct usb_wireless_ep_comp_descriptor {
727 __u8 bLength;
728 __u8 bDescriptorType;
729
730 __u8 bMaxBurst;
731 __u8 bMaxSequence;
732 __le16 wMaxStreamDelay;
733 __le16 wOverTheAirPacketSize;
734 __u8 bOverTheAirInterval;
735 __u8 bmCompAttributes;
736#define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */
737#define USB_ENDPOINT_SWITCH_NO 0
738#define USB_ENDPOINT_SWITCH_SWITCH 1
739#define USB_ENDPOINT_SWITCH_SCALE 2
Inaky Perez-Gonzalez23004e22007-02-02 17:32:24 -0800740} __attribute__((packed));
David Brownell5da01062005-05-31 10:21:11 -0700741
742/*-------------------------------------------------------------------------*/
743
744/* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
745 * host and a device for connection set up, mutual authentication, and
746 * exchanging short lived session keys. The handshake depends on a CC.
747 */
748struct usb_handshake {
749 __u8 bMessageNumber;
750 __u8 bStatus;
751 __u8 tTKID[3];
752 __u8 bReserved;
753 __u8 CDID[16];
754 __u8 nonce[16];
755 __u8 MIC[8];
Inaky Perez-Gonzalez23004e22007-02-02 17:32:24 -0800756} __attribute__((packed));
David Brownell5da01062005-05-31 10:21:11 -0700757
758/*-------------------------------------------------------------------------*/
759
760/* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
761 * A CC may also be set up using non-wireless secure channels (including
762 * wired USB!), and some devices may support CCs with multiple hosts.
763 */
764struct usb_connection_context {
765 __u8 CHID[16]; /* persistent host id */
766 __u8 CDID[16]; /* device id (unique w/in host context) */
767 __u8 CK[16]; /* connection key */
Inaky Perez-Gonzalez23004e22007-02-02 17:32:24 -0800768} __attribute__((packed));
David Brownell5da01062005-05-31 10:21:11 -0700769
770/*-------------------------------------------------------------------------*/
771
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772/* USB 2.0 defines three speeds, here's how Linux identifies them */
773
774enum usb_device_speed {
775 USB_SPEED_UNKNOWN = 0, /* enumerating */
776 USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */
David Brownell5da01062005-05-31 10:21:11 -0700777 USB_SPEED_HIGH, /* usb 2.0 */
Greg Kroah-Hartman551cdbb2010-01-14 11:08:04 -0800778 USB_SPEED_WIRELESS, /* wireless (usb 2.5) */
Sarah Sharp6b403b02009-04-27 19:54:10 -0700779 USB_SPEED_SUPER, /* usb 3.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780};
781
782enum usb_device_state {
783 /* NOTATTACHED isn't in the USB spec, and this state acts
784 * the same as ATTACHED ... but it's clearer this way.
785 */
786 USB_STATE_NOTATTACHED = 0,
787
David Brownellc02c4bb2006-01-20 14:44:12 -0800788 /* chapter 9 and authentication (wireless) device states */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 USB_STATE_ATTACHED,
David Brownellc02c4bb2006-01-20 14:44:12 -0800790 USB_STATE_POWERED, /* wired */
David Brownellc02c4bb2006-01-20 14:44:12 -0800791 USB_STATE_RECONNECTING, /* auth */
David Vrabel6da9c992009-02-18 14:43:47 +0000792 USB_STATE_UNAUTHENTICATED, /* auth */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 USB_STATE_DEFAULT, /* limited function */
794 USB_STATE_ADDRESS,
795 USB_STATE_CONFIGURED, /* most functions */
796
797 USB_STATE_SUSPENDED
798
799 /* NOTE: there are actually four different SUSPENDED
800 * states, returning to POWERED, DEFAULT, ADDRESS, or
801 * CONFIGURED respectively when SOF tokens flow again.
David Brownelldbe0dbb2008-02-10 12:24:00 -0800802 * At this level there's no difference between L1 and L2
803 * suspend states. (L2 being original USB 1.1 suspend.)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 */
805};
806
Robert P. J. Daydda43a02008-03-07 13:45:32 -0500807#endif /* __LINUX_USB_CH9_H */