xref: /openbmc/u-boot/include/linux/usb/ch9.h (revision 1e52fea3)
1 /*
2  * This file holds USB constants and structures that are needed for
3  * USB device APIs.  These are used by the USB device model, which is
4  * defined in chapter 9 of the USB 2.0 specification and in the
5  * Wireless USB 1.0 (spread around).  Linux has several APIs in C that
6  * need these:
7  *
8  * - the master/host side Linux-USB kernel driver API;
9  * - the "usbfs" user space API; and
10  * - the Linux "gadget" slave/device/peripheral side driver API.
11  *
12  * USB 2.0 adds an additional "On The Go" (OTG) mode, which lets systems
13  * act either as a USB master/host or as a USB slave/device.  That means
14  * the master and slave side APIs benefit from working well together.
15  *
16  * There's also "Wireless USB", using low power short range radios for
17  * peripheral interconnection but otherwise building on the USB framework.
18  *
19  * Note all descriptors are declared '__attribute__((packed))' so that:
20  *
21  * [a] they never get padded, either internally (USB spec writers
22  *     probably handled that) or externally;
23  *
24  * [b] so that accessing bigger-than-a-bytes fields will never
25  *     generate bus errors on any platform, even when the location of
26  *     its descriptor inside a bundle isn't "naturally aligned", and
27  *
28  * [c] for consistency, removing all doubt even when it appears to
29  *     someone that the two other points are non-issues for that
30  *     particular descriptor type.
31  *
32  * Ported to U-boot by: Thomas Smits <ts.smits@gmail.com> and
33  *                      Remy Bohmer <linux@bohmer.net>
34  */
35 
36 #ifndef __LINUX_USB_CH9_H
37 #define __LINUX_USB_CH9_H
38 
39 #include <linux/types.h>	/* __u8 etc */
40 
41 /*-------------------------------------------------------------------------*/
42 
43 /* CONTROL REQUEST SUPPORT */
44 
45 /*
46  * USB directions
47  *
48  * This bit flag is used in endpoint descriptors' bEndpointAddress field.
49  * It's also one of three fields in control requests bRequestType.
50  */
51 #define USB_DIR_OUT			0		/* to device */
52 #define USB_DIR_IN			0x80		/* to host */
53 
54 /*
55  * USB types, the second of three bRequestType fields
56  */
57 #define USB_TYPE_MASK			(0x03 << 5)
58 #define USB_TYPE_STANDARD		(0x00 << 5)
59 #define USB_TYPE_CLASS			(0x01 << 5)
60 #define USB_TYPE_VENDOR			(0x02 << 5)
61 #define USB_TYPE_RESERVED		(0x03 << 5)
62 
63 /*
64  * USB recipients, the third of three bRequestType fields
65  */
66 #define USB_RECIP_MASK			0x1f
67 #define USB_RECIP_DEVICE		0x00
68 #define USB_RECIP_INTERFACE		0x01
69 #define USB_RECIP_ENDPOINT		0x02
70 #define USB_RECIP_OTHER			0x03
71 /* From Wireless USB 1.0 */
72 #define USB_RECIP_PORT			0x04
73 #define USB_RECIP_RPIPE			0x05
74 
75 /*
76  * Standard requests, for the bRequest field of a SETUP packet.
77  *
78  * These are qualified by the bRequestType field, so that for example
79  * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved
80  * by a GET_STATUS request.
81  */
82 #define USB_REQ_GET_STATUS		0x00
83 #define USB_REQ_CLEAR_FEATURE		0x01
84 #define USB_REQ_SET_FEATURE		0x03
85 #define USB_REQ_SET_ADDRESS		0x05
86 #define USB_REQ_GET_DESCRIPTOR		0x06
87 #define USB_REQ_SET_DESCRIPTOR		0x07
88 #define USB_REQ_GET_CONFIGURATION	0x08
89 #define USB_REQ_SET_CONFIGURATION	0x09
90 #define USB_REQ_GET_INTERFACE		0x0A
91 #define USB_REQ_SET_INTERFACE		0x0B
92 #define USB_REQ_SYNCH_FRAME		0x0C
93 
94 #define USB_REQ_SET_ENCRYPTION		0x0D	/* Wireless USB */
95 #define USB_REQ_GET_ENCRYPTION		0x0E
96 #define USB_REQ_RPIPE_ABORT		0x0E
97 #define USB_REQ_SET_HANDSHAKE		0x0F
98 #define USB_REQ_RPIPE_RESET		0x0F
99 #define USB_REQ_GET_HANDSHAKE		0x10
100 #define USB_REQ_SET_CONNECTION		0x11
101 #define USB_REQ_SET_SECURITY_DATA	0x12
102 #define USB_REQ_GET_SECURITY_DATA	0x13
103 #define USB_REQ_SET_WUSB_DATA		0x14
104 #define USB_REQ_LOOPBACK_DATA_WRITE	0x15
105 #define USB_REQ_LOOPBACK_DATA_READ	0x16
106 #define USB_REQ_SET_INTERFACE_DS	0x17
107 
108 /*
109  * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and
110  * are read as a bit array returned by USB_REQ_GET_STATUS.  (So there
111  * are at most sixteen features of each type.)
112  */
113 #define USB_DEVICE_SELF_POWERED		0	/* (read only) */
114 #define USB_DEVICE_REMOTE_WAKEUP	1	/* dev may initiate wakeup */
115 #define USB_DEVICE_TEST_MODE		2	/* (wired high speed only) */
116 #define USB_DEVICE_BATTERY		2	/* (wireless) */
117 #define USB_DEVICE_B_HNP_ENABLE		3	/* (otg) dev may initiate HNP */
118 #define USB_DEVICE_WUSB_DEVICE		3	/* (wireless)*/
119 #define USB_DEVICE_A_HNP_SUPPORT	4	/* (otg) RH port supports HNP */
120 #define USB_DEVICE_A_ALT_HNP_SUPPORT	5	/* (otg) other RH port does */
121 #define USB_DEVICE_DEBUG_MODE		6	/* (special devices only) */
122 
123 #define USB_ENDPOINT_HALT		0	/* IN/OUT will STALL */
124 
125 
126 /**
127  * struct usb_ctrlrequest - SETUP data for a USB device control request
128  * @bRequestType: matches the USB bmRequestType field
129  * @bRequest: matches the USB bRequest field
130  * @wValue: matches the USB wValue field (le16 byte order)
131  * @wIndex: matches the USB wIndex field (le16 byte order)
132  * @wLength: matches the USB wLength field (le16 byte order)
133  *
134  * This structure is used to send control requests to a USB device.  It matches
135  * the different fields of the USB 2.0 Spec section 9.3, table 9-2.  See the
136  * USB spec for a fuller description of the different fields, and what they are
137  * used for.
138  *
139  * Note that the driver for any interface can issue control requests.
140  * For most devices, interfaces don't coordinate with each other, so
141  * such requests may be made at any time.
142  */
143 #if defined(__BIG_ENDIAN) || defined(__ARMEB__)
144 #error (functionality not verified for big endian targets, todo...)
145 #endif
146 
147 struct usb_ctrlrequest {
148 	__u8 bRequestType;
149 	__u8 bRequest;
150 	__le16 wValue;
151 	__le16 wIndex;
152 	__le16 wLength;
153 } __attribute__ ((packed));
154 
155 /*-------------------------------------------------------------------------*/
156 
157 /*
158  * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
159  * (rarely) accepted by SET_DESCRIPTOR.
160  *
161  * Note that all multi-byte values here are encoded in little endian
162  * byte order "on the wire".  But when exposed through Linux-USB APIs,
163  * they've been converted to cpu byte order.
164  */
165 
166 /*
167  * Descriptor types ... USB 2.0 spec table 9.5
168  */
169 #define USB_DT_DEVICE			0x01
170 #define USB_DT_CONFIG			0x02
171 #define USB_DT_STRING			0x03
172 #define USB_DT_INTERFACE		0x04
173 #define USB_DT_ENDPOINT			0x05
174 #define USB_DT_DEVICE_QUALIFIER		0x06
175 #define USB_DT_OTHER_SPEED_CONFIG	0x07
176 #define USB_DT_INTERFACE_POWER		0x08
177 /* these are from a minor usb 2.0 revision (ECN) */
178 #define USB_DT_OTG			0x09
179 #define USB_DT_DEBUG			0x0a
180 #define USB_DT_INTERFACE_ASSOCIATION	0x0b
181 /* these are from the Wireless USB spec */
182 #define USB_DT_SECURITY			0x0c
183 #define USB_DT_KEY			0x0d
184 #define USB_DT_ENCRYPTION_TYPE		0x0e
185 #define USB_DT_BOS			0x0f
186 #define USB_DT_DEVICE_CAPABILITY	0x10
187 #define USB_DT_WIRELESS_ENDPOINT_COMP	0x11
188 #define USB_DT_WIRE_ADAPTER		0x21
189 #define USB_DT_RPIPE			0x22
190 
191 /* Conventional codes for class-specific descriptors.  The convention is
192  * defined in the USB "Common Class" Spec (3.11).  Individual class specs
193  * are authoritative for their usage, not the "common class" writeup.
194  */
195 #define USB_DT_CS_DEVICE		(USB_TYPE_CLASS | USB_DT_DEVICE)
196 #define USB_DT_CS_CONFIG		(USB_TYPE_CLASS | USB_DT_CONFIG)
197 #define USB_DT_CS_STRING		(USB_TYPE_CLASS | USB_DT_STRING)
198 #define USB_DT_CS_INTERFACE		(USB_TYPE_CLASS | USB_DT_INTERFACE)
199 #define USB_DT_CS_ENDPOINT		(USB_TYPE_CLASS | USB_DT_ENDPOINT)
200 
201 /* All standard descriptors have these 2 fields at the beginning */
202 struct usb_descriptor_header {
203 	__u8  bLength;
204 	__u8  bDescriptorType;
205 } __attribute__ ((packed));
206 
207 
208 /*-------------------------------------------------------------------------*/
209 
210 /* USB_DT_DEVICE: Device descriptor */
211 struct usb_device_descriptor {
212 	__u8  bLength;
213 	__u8  bDescriptorType;
214 
215 	__le16 bcdUSB;
216 	__u8  bDeviceClass;
217 	__u8  bDeviceSubClass;
218 	__u8  bDeviceProtocol;
219 	__u8  bMaxPacketSize0;
220 	__le16 idVendor;
221 	__le16 idProduct;
222 	__le16 bcdDevice;
223 	__u8  iManufacturer;
224 	__u8  iProduct;
225 	__u8  iSerialNumber;
226 	__u8  bNumConfigurations;
227 } __attribute__ ((packed));
228 
229 #define USB_DT_DEVICE_SIZE		18
230 
231 
232 /*
233  * Device and/or Interface Class codes
234  * as found in bDeviceClass or bInterfaceClass
235  * and defined by www.usb.org documents
236  */
237 #define USB_CLASS_PER_INTERFACE		0	/* for DeviceClass */
238 #define USB_CLASS_AUDIO			1
239 #define USB_CLASS_COMM			2
240 #define USB_CLASS_HID			3
241 #define USB_CLASS_PHYSICAL		5
242 #define USB_CLASS_STILL_IMAGE		6
243 #define USB_CLASS_PRINTER		7
244 #define USB_CLASS_MASS_STORAGE		8
245 #define USB_CLASS_HUB			9
246 #define USB_CLASS_CDC_DATA		0x0a
247 #define USB_CLASS_CSCID			0x0b	/* chip+ smart card */
248 #define USB_CLASS_CONTENT_SEC		0x0d	/* content security */
249 #define USB_CLASS_VIDEO			0x0e
250 #define USB_CLASS_WIRELESS_CONTROLLER	0xe0
251 #define USB_CLASS_MISC			0xef
252 #define USB_CLASS_APP_SPEC		0xfe
253 #define USB_CLASS_VENDOR_SPEC		0xff
254 
255 /*-------------------------------------------------------------------------*/
256 
257 /* USB_DT_CONFIG: Configuration descriptor information.
258  *
259  * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
260  * descriptor type is different.  Highspeed-capable devices can look
261  * different depending on what speed they're currently running.  Only
262  * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
263  * descriptors.
264  */
265 struct usb_config_descriptor {
266 	__u8  bLength;
267 	__u8  bDescriptorType;
268 
269 	__le16 wTotalLength;
270 	__u8  bNumInterfaces;
271 	__u8  bConfigurationValue;
272 	__u8  iConfiguration;
273 	__u8  bmAttributes;
274 	__u8  bMaxPower;
275 } __attribute__ ((packed));
276 
277 #define USB_DT_CONFIG_SIZE		9
278 
279 /* from config descriptor bmAttributes */
280 #define USB_CONFIG_ATT_ONE		(1 << 7)	/* must be set */
281 #define USB_CONFIG_ATT_SELFPOWER	(1 << 6)	/* self powered */
282 #define USB_CONFIG_ATT_WAKEUP		(1 << 5)	/* can wakeup */
283 #define USB_CONFIG_ATT_BATTERY		(1 << 4)	/* battery powered */
284 
285 /*-------------------------------------------------------------------------*/
286 
287 /* USB_DT_STRING: String descriptor */
288 struct usb_string_descriptor {
289 	__u8  bLength;
290 	__u8  bDescriptorType;
291 
292 	__le16 wData[1];		/* UTF-16LE encoded */
293 } __attribute__ ((packed));
294 
295 /* note that "string" zero is special, it holds language codes that
296  * the device supports, not Unicode characters.
297  */
298 
299 /*-------------------------------------------------------------------------*/
300 
301 /* USB_DT_INTERFACE: Interface descriptor */
302 struct usb_interface_descriptor {
303 	__u8  bLength;
304 	__u8  bDescriptorType;
305 
306 	__u8  bInterfaceNumber;
307 	__u8  bAlternateSetting;
308 	__u8  bNumEndpoints;
309 	__u8  bInterfaceClass;
310 	__u8  bInterfaceSubClass;
311 	__u8  bInterfaceProtocol;
312 	__u8  iInterface;
313 } __attribute__ ((packed));
314 
315 #define USB_DT_INTERFACE_SIZE		9
316 
317 /*-------------------------------------------------------------------------*/
318 
319 /* USB_DT_ENDPOINT: Endpoint descriptor */
320 struct usb_endpoint_descriptor {
321 	__u8  bLength;
322 	__u8  bDescriptorType;
323 
324 	__u8  bEndpointAddress;
325 	__u8  bmAttributes;
326 	__le16 wMaxPacketSize;
327 	__u8  bInterval;
328 
329 	/* NOTE:  these two are _only_ in audio endpoints. */
330 	/* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
331 	__u8  bRefresh;
332 	__u8  bSynchAddress;
333 } __attribute__ ((packed));
334 
335 #define USB_DT_ENDPOINT_SIZE		7
336 #define USB_DT_ENDPOINT_AUDIO_SIZE	9	/* Audio extension */
337 
338 
339 /*
340  * Endpoints
341  */
342 #define USB_ENDPOINT_NUMBER_MASK	0x0f	/* in bEndpointAddress */
343 #define USB_ENDPOINT_DIR_MASK		0x80
344 
345 #define USB_ENDPOINT_XFERTYPE_MASK	0x03	/* in bmAttributes */
346 #define USB_ENDPOINT_XFER_CONTROL	0
347 #define USB_ENDPOINT_XFER_ISOC		1
348 #define USB_ENDPOINT_XFER_BULK		2
349 #define USB_ENDPOINT_XFER_INT		3
350 #define USB_ENDPOINT_MAX_ADJUSTABLE	0x80
351 
352 
353 /*-------------------------------------------------------------------------*/
354 
355 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
356 struct usb_qualifier_descriptor {
357 	__u8  bLength;
358 	__u8  bDescriptorType;
359 
360 	__le16 bcdUSB;
361 	__u8  bDeviceClass;
362 	__u8  bDeviceSubClass;
363 	__u8  bDeviceProtocol;
364 	__u8  bMaxPacketSize0;
365 	__u8  bNumConfigurations;
366 	__u8  bRESERVED;
367 } __attribute__ ((packed));
368 
369 
370 /*-------------------------------------------------------------------------*/
371 
372 /* USB_DT_OTG (from OTG 1.0a supplement) */
373 struct usb_otg_descriptor {
374 	__u8  bLength;
375 	__u8  bDescriptorType;
376 
377 	__u8  bmAttributes;	/* support for HNP, SRP, etc */
378 } __attribute__ ((packed));
379 
380 /* from usb_otg_descriptor.bmAttributes */
381 #define USB_OTG_SRP		(1 << 0)
382 #define USB_OTG_HNP		(1 << 1)	/* swap host/device roles */
383 
384 /*-------------------------------------------------------------------------*/
385 
386 /* USB_DT_DEBUG:  for special highspeed devices, replacing serial console */
387 struct usb_debug_descriptor {
388 	__u8  bLength;
389 	__u8  bDescriptorType;
390 
391 	/* bulk endpoints with 8 byte maxpacket */
392 	__u8  bDebugInEndpoint;
393 	__u8  bDebugOutEndpoint;
394 } __attribute__((packed));
395 
396 /*-------------------------------------------------------------------------*/
397 
398 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
399 struct usb_interface_assoc_descriptor {
400 	__u8  bLength;
401 	__u8  bDescriptorType;
402 
403 	__u8  bFirstInterface;
404 	__u8  bInterfaceCount;
405 	__u8  bFunctionClass;
406 	__u8  bFunctionSubClass;
407 	__u8  bFunctionProtocol;
408 	__u8  iFunction;
409 } __attribute__ ((packed));
410 
411 
412 /*-------------------------------------------------------------------------*/
413 
414 /* USB_DT_SECURITY:  group of wireless security descriptors, including
415  * encryption types available for setting up a CC/association.
416  */
417 struct usb_security_descriptor {
418 	__u8  bLength;
419 	__u8  bDescriptorType;
420 
421 	__le16 wTotalLength;
422 	__u8  bNumEncryptionTypes;
423 } __attribute__((packed));
424 
425 /*-------------------------------------------------------------------------*/
426 
427 /* USB_DT_KEY:  used with {GET,SET}_SECURITY_DATA; only public keys
428  * may be retrieved.
429  */
430 struct usb_key_descriptor {
431 	__u8  bLength;
432 	__u8  bDescriptorType;
433 
434 	__u8  tTKID[3];
435 	__u8  bReserved;
436 	__u8  bKeyData[0];
437 } __attribute__((packed));
438 
439 /*-------------------------------------------------------------------------*/
440 
441 /* USB_DT_ENCRYPTION_TYPE:  bundled in DT_SECURITY groups */
442 struct usb_encryption_descriptor {
443 	__u8  bLength;
444 	__u8  bDescriptorType;
445 
446 	__u8  bEncryptionType;
447 #define	USB_ENC_TYPE_UNSECURE		0
448 #define	USB_ENC_TYPE_WIRED		1	/* non-wireless mode */
449 #define	USB_ENC_TYPE_CCM_1		2	/* aes128/cbc session */
450 #define	USB_ENC_TYPE_RSA_1		3	/* rsa3072/sha1 auth */
451 	__u8  bEncryptionValue;		/* use in SET_ENCRYPTION */
452 	__u8  bAuthKeyIndex;
453 } __attribute__((packed));
454 
455 
456 /*-------------------------------------------------------------------------*/
457 
458 /* USB_DT_BOS:  group of wireless capabilities */
459 struct usb_bos_descriptor {
460 	__u8  bLength;
461 	__u8  bDescriptorType;
462 
463 	__le16 wTotalLength;
464 	__u8  bNumDeviceCaps;
465 } __attribute__((packed));
466 
467 /*-------------------------------------------------------------------------*/
468 
469 /* USB_DT_DEVICE_CAPABILITY:  grouped with BOS */
470 struct usb_dev_cap_header {
471 	__u8  bLength;
472 	__u8  bDescriptorType;
473 	__u8  bDevCapabilityType;
474 } __attribute__((packed));
475 
476 #define	USB_CAP_TYPE_WIRELESS_USB	1
477 
478 struct usb_wireless_cap_descriptor {	/* Ultra Wide Band */
479 	__u8  bLength;
480 	__u8  bDescriptorType;
481 	__u8  bDevCapabilityType;
482 
483 	__u8  bmAttributes;
484 #define	USB_WIRELESS_P2P_DRD		(1 << 1)
485 #define	USB_WIRELESS_BEACON_MASK	(3 << 2)
486 #define	USB_WIRELESS_BEACON_SELF	(1 << 2)
487 #define	USB_WIRELESS_BEACON_DIRECTED	(2 << 2)
488 #define	USB_WIRELESS_BEACON_NONE	(3 << 2)
489 	__le16 wPHYRates;	/* bit rates, Mbps */
490 #define	USB_WIRELESS_PHY_53		(1 << 0)	/* always set */
491 #define	USB_WIRELESS_PHY_80		(1 << 1)
492 #define	USB_WIRELESS_PHY_107		(1 << 2)	/* always set */
493 #define	USB_WIRELESS_PHY_160		(1 << 3)
494 #define	USB_WIRELESS_PHY_200		(1 << 4)	/* always set */
495 #define	USB_WIRELESS_PHY_320		(1 << 5)
496 #define	USB_WIRELESS_PHY_400		(1 << 6)
497 #define	USB_WIRELESS_PHY_480		(1 << 7)
498 	__u8  bmTFITXPowerInfo;	/* TFI power levels */
499 	__u8  bmFFITXPowerInfo;	/* FFI power levels */
500 	__le16 bmBandGroup;
501 	__u8  bReserved;
502 } __attribute__((packed));
503 
504 /*-------------------------------------------------------------------------*/
505 
506 /* USB_DT_WIRELESS_ENDPOINT_COMP:  companion descriptor associated with
507  * each endpoint descriptor for a wireless device
508  */
509 struct usb_wireless_ep_comp_descriptor {
510 	__u8  bLength;
511 	__u8  bDescriptorType;
512 
513 	__u8  bMaxBurst;
514 	__u8  bMaxSequence;
515 	__le16 wMaxStreamDelay;
516 	__le16 wOverTheAirPacketSize;
517 	__u8  bOverTheAirInterval;
518 	__u8  bmCompAttributes;
519 #define USB_ENDPOINT_SWITCH_MASK	0x03	/* in bmCompAttributes */
520 #define USB_ENDPOINT_SWITCH_NO		0
521 #define USB_ENDPOINT_SWITCH_SWITCH	1
522 #define USB_ENDPOINT_SWITCH_SCALE	2
523 } __attribute__((packed));
524 
525 /*-------------------------------------------------------------------------*/
526 
527 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
528  * host and a device for connection set up, mutual authentication, and
529  * exchanging short lived session keys.  The handshake depends on a CC.
530  */
531 struct usb_handshake {
532 	__u8 bMessageNumber;
533 	__u8 bStatus;
534 	__u8 tTKID[3];
535 	__u8 bReserved;
536 	__u8 CDID[16];
537 	__u8 nonce[16];
538 	__u8 MIC[8];
539 } __attribute__((packed));
540 
541 /*-------------------------------------------------------------------------*/
542 
543 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
544  * A CC may also be set up using non-wireless secure channels (including
545  * wired USB!), and some devices may support CCs with multiple hosts.
546  */
547 struct usb_connection_context {
548 	__u8 CHID[16];		/* persistent host id */
549 	__u8 CDID[16];		/* device id (unique w/in host context) */
550 	__u8 CK[16];		/* connection key */
551 } __attribute__((packed));
552 
553 /*-------------------------------------------------------------------------*/
554 
555 /* USB 2.0 defines three speeds, here's how Linux identifies them */
556 
557 enum usb_device_speed {
558 	USB_SPEED_UNKNOWN = 0,			/* enumerating */
559 	USB_SPEED_LOW, USB_SPEED_FULL,		/* usb 1.1 */
560 	USB_SPEED_HIGH,				/* usb 2.0 */
561 	USB_SPEED_VARIABLE,			/* wireless (usb 2.5) */
562 };
563 
564 enum usb_device_state {
565 	/* NOTATTACHED isn't in the USB spec, and this state acts
566 	 * the same as ATTACHED ... but it's clearer this way.
567 	 */
568 	USB_STATE_NOTATTACHED = 0,
569 
570 	/* chapter 9 and authentication (wireless) device states */
571 	USB_STATE_ATTACHED,
572 	USB_STATE_POWERED,			/* wired */
573 	USB_STATE_UNAUTHENTICATED,		/* auth */
574 	USB_STATE_RECONNECTING,			/* auth */
575 	USB_STATE_DEFAULT,			/* limited function */
576 	USB_STATE_ADDRESS,
577 	USB_STATE_CONFIGURED,			/* most functions */
578 
579 	USB_STATE_SUSPENDED
580 
581 	/* NOTE:  there are actually four different SUSPENDED
582 	 * states, returning to POWERED, DEFAULT, ADDRESS, or
583 	 * CONFIGURED respectively when SOF tokens flow again.
584 	 */
585 };
586 
587 #endif	/* __LINUX_USB_CH9_H */
588