usb_defs.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * (C) Copyright 2001
  4. * Denis Peter, MPL AG Switzerland
  5. *
  6. * Note: Part of this code has been derived from linux
  7. */
  8. #ifndef _USB_DEFS_H_
  9. #define _USB_DEFS_H_
  10. /* USB constants */
  11. /* Device and/or Interface Class codes */
  12. #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */
  13. #define USB_CLASS_AUDIO 1
  14. #define USB_CLASS_COMM 2
  15. #define USB_CLASS_HID 3
  16. #define USB_CLASS_PRINTER 7
  17. #define USB_CLASS_MASS_STORAGE 8
  18. #define USB_CLASS_HUB 9
  19. #define USB_CLASS_DATA 10
  20. #define USB_CLASS_VENDOR_SPEC 0xff
  21. /* some HID sub classes */
  22. #define USB_SUB_HID_NONE 0
  23. #define USB_SUB_HID_BOOT 1
  24. /* some UID Protocols */
  25. #define USB_PROT_HID_NONE 0
  26. #define USB_PROT_HID_KEYBOARD 1
  27. #define USB_PROT_HID_MOUSE 2
  28. /* Sub STORAGE Classes */
  29. #define US_SC_RBC 1 /* Typically, flash devices */
  30. #define US_SC_8020 2 /* CD-ROM */
  31. #define US_SC_QIC 3 /* QIC-157 Tapes */
  32. #define US_SC_UFI 4 /* Floppy */
  33. #define US_SC_8070 5 /* Removable media */
  34. #define US_SC_SCSI 6 /* Transparent */
  35. #define US_SC_MIN US_SC_RBC
  36. #define US_SC_MAX US_SC_SCSI
  37. /* STORAGE Protocols */
  38. #define US_PR_CB 1 /* Control/Bulk w/o interrupt */
  39. #define US_PR_CBI 0 /* Control/Bulk/Interrupt */
  40. #define US_PR_BULK 0x50 /* bulk only */
  41. /* USB types */
  42. #define USB_TYPE_STANDARD (0x00 << 5)
  43. #define USB_TYPE_CLASS (0x01 << 5)
  44. #define USB_TYPE_VENDOR (0x02 << 5)
  45. #define USB_TYPE_RESERVED (0x03 << 5)
  46. /* USB recipients */
  47. #define USB_RECIP_DEVICE 0x00
  48. #define USB_RECIP_INTERFACE 0x01
  49. #define USB_RECIP_ENDPOINT 0x02
  50. #define USB_RECIP_OTHER 0x03
  51. /* USB directions */
  52. #define USB_DIR_OUT 0
  53. #define USB_DIR_IN 0x80
  54. /*
  55. * bmRequestType: USB Device Requests, table 9.2 USB 2.0 spec.
  56. * (shifted) direction/type/recipient.
  57. */
  58. #define DeviceRequest \
  59. ((USB_DIR_IN | USB_TYPE_STANDARD | USB_RECIP_DEVICE) << 8)
  60. #define DeviceOutRequest \
  61. ((USB_DIR_OUT | USB_TYPE_STANDARD | USB_RECIP_DEVICE) << 8)
  62. #define InterfaceRequest \
  63. ((USB_DIR_IN | USB_TYPE_STANDARD | USB_RECIP_INTERFACE) << 8)
  64. #define EndpointRequest \
  65. ((USB_DIR_IN | USB_TYPE_STANDARD | USB_RECIP_INTERFACE) << 8)
  66. #define EndpointOutRequest \
  67. ((USB_DIR_OUT | USB_TYPE_STANDARD | USB_RECIP_INTERFACE) << 8)
  68. /* class requests from the USB 2.0 hub spec, table 11-15 */
  69. #define HUB_CLASS_REQ(dir, type, request) ((((dir) | (type)) << 8) | (request))
  70. /* GetBusState and SetHubDescriptor are optional, omitted */
  71. #define ClearHubFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, \
  72. USB_REQ_CLEAR_FEATURE)
  73. #define ClearPortFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, \
  74. USB_REQ_CLEAR_FEATURE)
  75. #define GetHubDescriptor HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, \
  76. USB_REQ_GET_DESCRIPTOR)
  77. #define GetHubStatus HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, \
  78. USB_REQ_GET_STATUS)
  79. #define GetPortStatus HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, \
  80. USB_REQ_GET_STATUS)
  81. #define SetHubFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, \
  82. USB_REQ_SET_FEATURE)
  83. #define SetPortFeature HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, \
  84. USB_REQ_SET_FEATURE)
  85. #define ClearTTBuffer HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, \
  86. HUB_CLEAR_TT_BUFFER)
  87. #define ResetTT HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, \
  88. HUB_RESET_TT)
  89. #define GetTTState HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, \
  90. HUB_GET_TT_STATE)
  91. #define StopTT HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, \
  92. HUB_STOP_TT)
  93. /* Descriptor types */
  94. #define USB_DT_DEVICE 0x01
  95. #define USB_DT_CONFIG 0x02
  96. #define USB_DT_STRING 0x03
  97. #define USB_DT_INTERFACE 0x04
  98. #define USB_DT_ENDPOINT 0x05
  99. #define USB_DT_HID (USB_TYPE_CLASS | 0x01)
  100. #define USB_DT_REPORT (USB_TYPE_CLASS | 0x02)
  101. #define USB_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
  102. #define USB_DT_HUB (USB_TYPE_CLASS | 0x09)
  103. #define USB_DT_SS_HUB (USB_TYPE_CLASS | 0x0a)
  104. /* Descriptor sizes per descriptor type */
  105. #define USB_DT_DEVICE_SIZE 18
  106. #define USB_DT_CONFIG_SIZE 9
  107. #define USB_DT_INTERFACE_SIZE 9
  108. #define USB_DT_ENDPOINT_SIZE 7
  109. #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
  110. #define USB_DT_HUB_NONVAR_SIZE 7
  111. #define USB_DT_HID_SIZE 9
  112. /* Endpoints */
  113. #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
  114. #define USB_ENDPOINT_DIR_MASK 0x80
  115. #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
  116. #define USB_ENDPOINT_XFER_CONTROL 0
  117. #define USB_ENDPOINT_XFER_ISOC 1
  118. #define USB_ENDPOINT_XFER_BULK 2
  119. #define USB_ENDPOINT_XFER_INT 3
  120. /* USB Packet IDs (PIDs) */
  121. #define USB_PID_UNDEF_0 0xf0
  122. #define USB_PID_OUT 0xe1
  123. #define USB_PID_ACK 0xd2
  124. #define USB_PID_DATA0 0xc3
  125. #define USB_PID_UNDEF_4 0xb4
  126. #define USB_PID_SOF 0xa5
  127. #define USB_PID_UNDEF_6 0x96
  128. #define USB_PID_UNDEF_7 0x87
  129. #define USB_PID_UNDEF_8 0x78
  130. #define USB_PID_IN 0x69
  131. #define USB_PID_NAK 0x5a
  132. #define USB_PID_DATA1 0x4b
  133. #define USB_PID_PREAMBLE 0x3c
  134. #define USB_PID_SETUP 0x2d
  135. #define USB_PID_STALL 0x1e
  136. #define USB_PID_UNDEF_F 0x0f
  137. /* Standard requests */
  138. #define USB_REQ_GET_STATUS 0x00
  139. #define USB_REQ_CLEAR_FEATURE 0x01
  140. #define USB_REQ_SET_FEATURE 0x03
  141. #define USB_REQ_SET_ADDRESS 0x05
  142. #define USB_REQ_GET_DESCRIPTOR 0x06
  143. #define USB_REQ_SET_DESCRIPTOR 0x07
  144. #define USB_REQ_GET_CONFIGURATION 0x08
  145. #define USB_REQ_SET_CONFIGURATION 0x09
  146. #define USB_REQ_GET_INTERFACE 0x0A
  147. #define USB_REQ_SET_INTERFACE 0x0B
  148. #define USB_REQ_SYNCH_FRAME 0x0C
  149. /* HID requests */
  150. #define USB_REQ_GET_REPORT 0x01
  151. #define USB_REQ_GET_IDLE 0x02
  152. #define USB_REQ_GET_PROTOCOL 0x03
  153. #define USB_REQ_SET_REPORT 0x09
  154. #define USB_REQ_SET_IDLE 0x0A
  155. #define USB_REQ_SET_PROTOCOL 0x0B
  156. /* Device features */
  157. #define USB_FEAT_HALT 0x00
  158. #define USB_FEAT_WAKEUP 0x01
  159. #define USB_FEAT_TEST 0x02
  160. /* Test modes */
  161. #define USB_TEST_MODE_J 0x01
  162. #define USB_TEST_MODE_K 0x02
  163. #define USB_TEST_MODE_SE0_NAK 0x03
  164. #define USB_TEST_MODE_PACKET 0x04
  165. #define USB_TEST_MODE_FORCE_ENABLE 0x05
  166. /*
  167. * "pipe" definitions, use unsigned so we can compare reliably, since this
  168. * value is shifted up to bits 30/31.
  169. */
  170. #define PIPE_ISOCHRONOUS 0U
  171. #define PIPE_INTERRUPT 1U
  172. #define PIPE_CONTROL 2U
  173. #define PIPE_BULK 3U
  174. #define PIPE_DEVEP_MASK 0x0007ff00
  175. #define USB_ISOCHRONOUS 0
  176. #define USB_INTERRUPT 1
  177. #define USB_CONTROL 2
  178. #define USB_BULK 3
  179. #define USB_PIPE_TYPE_SHIFT 30
  180. #define USB_PIPE_TYPE_MASK (3 << USB_PIPE_TYPE_SHIFT)
  181. #define USB_PIPE_DEV_SHIFT 8
  182. #define USB_PIPE_DEV_MASK (0x7f << USB_PIPE_DEV_SHIFT)
  183. #define USB_PIPE_EP_SHIFT 15
  184. #define USB_PIPE_EP_MASK (0xf << USB_PIPE_EP_SHIFT)
  185. /* USB-status codes: */
  186. #define USB_ST_ACTIVE 0x1 /* TD is active */
  187. #define USB_ST_STALLED 0x2 /* TD is stalled */
  188. #define USB_ST_BUF_ERR 0x4 /* buffer error */
  189. #define USB_ST_BABBLE_DET 0x8 /* Babble detected */
  190. #define USB_ST_NAK_REC 0x10 /* NAK Received*/
  191. #define USB_ST_CRC_ERR 0x20 /* CRC/timeout Error */
  192. #define USB_ST_BIT_ERR 0x40 /* Bitstuff error */
  193. #define USB_ST_NOT_PROC 0x80000000L /* Not yet processed */
  194. /*************************************************************************
  195. * Hub defines
  196. */
  197. /*
  198. * Hub request types
  199. */
  200. #define USB_RT_HUB (USB_TYPE_CLASS | USB_RECIP_DEVICE)
  201. #define USB_RT_PORT (USB_TYPE_CLASS | USB_RECIP_OTHER)
  202. /*
  203. * Hub Class feature numbers
  204. */
  205. #define C_HUB_LOCAL_POWER 0
  206. #define C_HUB_OVER_CURRENT 1
  207. /*
  208. * Port feature numbers
  209. */
  210. #define USB_PORT_FEAT_CONNECTION 0
  211. #define USB_PORT_FEAT_ENABLE 1
  212. #define USB_PORT_FEAT_SUSPEND 2
  213. #define USB_PORT_FEAT_OVER_CURRENT 3
  214. #define USB_PORT_FEAT_RESET 4
  215. #define USB_PORT_FEAT_POWER 8
  216. #define USB_PORT_FEAT_LOWSPEED 9
  217. #define USB_PORT_FEAT_HIGHSPEED 10
  218. #define USB_PORT_FEAT_C_CONNECTION 16
  219. #define USB_PORT_FEAT_C_ENABLE 17
  220. #define USB_PORT_FEAT_C_SUSPEND 18
  221. #define USB_PORT_FEAT_C_OVER_CURRENT 19
  222. #define USB_PORT_FEAT_C_RESET 20
  223. #define USB_PORT_FEAT_TEST 21
  224. /*
  225. * Changes to Port feature numbers for Super speed,
  226. * from USB 3.0 spec Table 10-8
  227. */
  228. #define USB_SS_PORT_FEAT_U1_TIMEOUT 23
  229. #define USB_SS_PORT_FEAT_U2_TIMEOUT 24
  230. #define USB_SS_PORT_FEAT_C_LINK_STATE 25
  231. #define USB_SS_PORT_FEAT_C_CONFIG_ERROR 26
  232. #define USB_SS_PORT_FEAT_BH_RESET 28
  233. #define USB_SS_PORT_FEAT_C_BH_RESET 29
  234. /* wPortStatus bits */
  235. #define USB_PORT_STAT_CONNECTION 0x0001
  236. #define USB_PORT_STAT_ENABLE 0x0002
  237. #define USB_PORT_STAT_SUSPEND 0x0004
  238. #define USB_PORT_STAT_OVERCURRENT 0x0008
  239. #define USB_PORT_STAT_RESET 0x0010
  240. #define USB_PORT_STAT_POWER 0x0100
  241. #define USB_PORT_STAT_LOW_SPEED 0x0200
  242. #define USB_PORT_STAT_HIGH_SPEED 0x0400 /* support for EHCI */
  243. #define USB_PORT_STAT_SUPER_SPEED 0x0600 /* faking support to XHCI */
  244. #define USB_PORT_STAT_SPEED_MASK \
  245. (USB_PORT_STAT_LOW_SPEED | USB_PORT_STAT_HIGH_SPEED)
  246. /*
  247. * Changes to wPortStatus bit field in USB 3.0
  248. * See USB 3.0 spec Table 10-10
  249. */
  250. #define USB_SS_PORT_STAT_LINK_STATE 0x01e0
  251. #define USB_SS_PORT_STAT_POWER 0x0200
  252. #define USB_SS_PORT_STAT_SPEED 0x1c00
  253. #define USB_SS_PORT_STAT_SPEED_5GBPS 0x0000
  254. /* Bits that are the same from USB 2.0 */
  255. #define USB_SS_PORT_STAT_MASK (USB_PORT_STAT_CONNECTION | \
  256. USB_PORT_STAT_ENABLE | \
  257. USB_PORT_STAT_OVERCURRENT | \
  258. USB_PORT_STAT_RESET)
  259. /* wPortChange bits */
  260. #define USB_PORT_STAT_C_CONNECTION 0x0001
  261. #define USB_PORT_STAT_C_ENABLE 0x0002
  262. #define USB_PORT_STAT_C_SUSPEND 0x0004
  263. #define USB_PORT_STAT_C_OVERCURRENT 0x0008
  264. #define USB_PORT_STAT_C_RESET 0x0010
  265. /*
  266. * Changes to wPortChange bit fields in USB 3.0
  267. * See USB 3.0 spec Table 10-12
  268. */
  269. #define USB_SS_PORT_STAT_C_BH_RESET 0x0020
  270. #define USB_SS_PORT_STAT_C_LINK_STATE 0x0040
  271. #define USB_SS_PORT_STAT_C_CONFIG_ERROR 0x0080
  272. /* wHubCharacteristics (masks) */
  273. #define HUB_CHAR_COMMON_OCPM 0x0000 /* All ports Over-Current reporting */
  274. #define HUB_CHAR_INDV_PORT_LPSM 0x0001 /* per-port power control */
  275. #define HUB_CHAR_NO_LPSM 0x0002 /* no power switching */
  276. #define HUB_CHAR_LPSM 0x0003
  277. #define HUB_CHAR_COMPOUND 0x0004
  278. #define HUB_CHAR_INDV_PORT_OCPM 0x0008 /* per-port Over-current reporting */
  279. #define HUB_CHAR_NO_OCPM 0x0010 /* No Over-current Protection support */
  280. #define HUB_CHAR_OCPM 0x0018
  281. #define HUB_CHAR_TTTT 0x0060 /* TT Think Time mask */
  282. #define HUB_CHAR_PORTIND 0x0080 /* per-port indicators (LEDs) */
  283. /*
  284. * Hub Status & Hub Change bit masks
  285. */
  286. #define HUB_STATUS_LOCAL_POWER 0x0001
  287. #define HUB_STATUS_OVERCURRENT 0x0002
  288. #define HUB_CHANGE_LOCAL_POWER 0x0001
  289. #define HUB_CHANGE_OVERCURRENT 0x0002
  290. /* Mask for wIndex in get/set port feature */
  291. #define USB_HUB_PORT_MASK 0xf
  292. /* Hub class request codes */
  293. #define USB_REQ_SET_HUB_DEPTH 0x0c
  294. /*
  295. * As of USB 2.0, full/low speed devices are segregated into trees.
  296. * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
  297. * The other type grows from high speed hubs when they connect to
  298. * full/low speed devices using "Transaction Translators" (TTs).
  299. */
  300. struct usb_tt {
  301. bool multi; /* true means one TT per port */
  302. unsigned think_time; /* think time in ns */
  303. };
  304. /*
  305. * CBI style
  306. */
  307. #define US_CBI_ADSC 0
  308. /* Command Block Wrapper */
  309. struct umass_bbb_cbw {
  310. __u32 dCBWSignature;
  311. # define CBWSIGNATURE 0x43425355
  312. __u32 dCBWTag;
  313. __u32 dCBWDataTransferLength;
  314. __u8 bCBWFlags;
  315. # define CBWFLAGS_OUT 0x00
  316. # define CBWFLAGS_IN 0x80
  317. # define CBWFLAGS_SBZ 0x7f
  318. __u8 bCBWLUN;
  319. __u8 bCDBLength;
  320. # define CBWCDBLENGTH 16
  321. __u8 CBWCDB[CBWCDBLENGTH];
  322. };
  323. #define UMASS_BBB_CBW_SIZE 31
  324. /* Command Status Wrapper */
  325. struct umass_bbb_csw {
  326. __u32 dCSWSignature;
  327. # define CSWSIGNATURE 0x53425355
  328. __u32 dCSWTag;
  329. __u32 dCSWDataResidue;
  330. __u8 bCSWStatus;
  331. # define CSWSTATUS_GOOD 0x0
  332. # define CSWSTATUS_FAILED 0x1
  333. # define CSWSTATUS_PHASE 0x2
  334. };
  335. #define UMASS_BBB_CSW_SIZE 13
  336. /*
  337. * BULK only
  338. */
  339. #define US_BBB_RESET 0xff
  340. #define US_BBB_GET_MAX_LUN 0xfe
  341. #endif /*_USB_DEFS_H_ */