ch9.h 32 KB

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