Firmware for MNT ZZ9000 graphics and ARM coprocessor card for Amiga computers.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

usb_defs.h 11KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365
  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. /* Descriptor types */
  69. #define USB_DT_DEVICE 0x01
  70. #define USB_DT_CONFIG 0x02
  71. #define USB_DT_STRING 0x03
  72. #define USB_DT_INTERFACE 0x04
  73. #define USB_DT_ENDPOINT 0x05
  74. #define USB_DT_HID (USB_TYPE_CLASS | 0x01)
  75. #define USB_DT_REPORT (USB_TYPE_CLASS | 0x02)
  76. #define USB_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
  77. #define USB_DT_HUB (USB_TYPE_CLASS | 0x09)
  78. #define USB_DT_SS_HUB (USB_TYPE_CLASS | 0x0a)
  79. /* Descriptor sizes per descriptor type */
  80. #define USB_DT_DEVICE_SIZE 18
  81. #define USB_DT_CONFIG_SIZE 9
  82. #define USB_DT_INTERFACE_SIZE 9
  83. #define USB_DT_ENDPOINT_SIZE 7
  84. #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
  85. #define USB_DT_HUB_NONVAR_SIZE 7
  86. #define USB_DT_HID_SIZE 9
  87. /* Endpoints */
  88. #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */
  89. #define USB_ENDPOINT_DIR_MASK 0x80
  90. #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
  91. #define USB_ENDPOINT_XFER_CONTROL 0
  92. #define USB_ENDPOINT_XFER_ISOC 1
  93. #define USB_ENDPOINT_XFER_BULK 2
  94. #define USB_ENDPOINT_XFER_INT 3
  95. /* USB Packet IDs (PIDs) */
  96. #define USB_PID_UNDEF_0 0xf0
  97. #define USB_PID_OUT 0xe1
  98. #define USB_PID_ACK 0xd2
  99. #define USB_PID_DATA0 0xc3
  100. #define USB_PID_UNDEF_4 0xb4
  101. #define USB_PID_SOF 0xa5
  102. #define USB_PID_UNDEF_6 0x96
  103. #define USB_PID_UNDEF_7 0x87
  104. #define USB_PID_UNDEF_8 0x78
  105. #define USB_PID_IN 0x69
  106. #define USB_PID_NAK 0x5a
  107. #define USB_PID_DATA1 0x4b
  108. #define USB_PID_PREAMBLE 0x3c
  109. #define USB_PID_SETUP 0x2d
  110. #define USB_PID_STALL 0x1e
  111. #define USB_PID_UNDEF_F 0x0f
  112. /* Standard requests */
  113. #define USB_REQ_GET_STATUS 0x00
  114. #define USB_REQ_CLEAR_FEATURE 0x01
  115. #define USB_REQ_SET_FEATURE 0x03
  116. #define USB_REQ_SET_ADDRESS 0x05
  117. #define USB_REQ_GET_DESCRIPTOR 0x06
  118. #define USB_REQ_SET_DESCRIPTOR 0x07
  119. #define USB_REQ_GET_CONFIGURATION 0x08
  120. #define USB_REQ_SET_CONFIGURATION 0x09
  121. #define USB_REQ_GET_INTERFACE 0x0A
  122. #define USB_REQ_SET_INTERFACE 0x0B
  123. #define USB_REQ_SYNCH_FRAME 0x0C
  124. /* HID requests */
  125. #define USB_REQ_GET_REPORT 0x01
  126. #define USB_REQ_GET_IDLE 0x02
  127. #define USB_REQ_GET_PROTOCOL 0x03
  128. #define USB_REQ_SET_REPORT 0x09
  129. #define USB_REQ_SET_IDLE 0x0A
  130. #define USB_REQ_SET_PROTOCOL 0x0B
  131. /* Device features */
  132. #define USB_FEAT_HALT 0x00
  133. #define USB_FEAT_WAKEUP 0x01
  134. #define USB_FEAT_TEST 0x02
  135. /* Test modes */
  136. #define USB_TEST_MODE_J 0x01
  137. #define USB_TEST_MODE_K 0x02
  138. #define USB_TEST_MODE_SE0_NAK 0x03
  139. #define USB_TEST_MODE_PACKET 0x04
  140. #define USB_TEST_MODE_FORCE_ENABLE 0x05
  141. /*
  142. * "pipe" definitions, use unsigned so we can compare reliably, since this
  143. * value is shifted up to bits 30/31.
  144. */
  145. #define PIPE_ISOCHRONOUS 0U
  146. #define PIPE_INTERRUPT 1U
  147. #define PIPE_CONTROL 2U
  148. #define PIPE_BULK 3U
  149. #define PIPE_DEVEP_MASK 0x0007ff00
  150. #define USB_ISOCHRONOUS 0
  151. #define USB_INTERRUPT 1
  152. #define USB_CONTROL 2
  153. #define USB_BULK 3
  154. #define USB_PIPE_TYPE_SHIFT 30
  155. #define USB_PIPE_TYPE_MASK (3 << USB_PIPE_TYPE_SHIFT)
  156. #define USB_PIPE_DEV_SHIFT 8
  157. #define USB_PIPE_DEV_MASK (0x7f << USB_PIPE_DEV_SHIFT)
  158. #define USB_PIPE_EP_SHIFT 15
  159. #define USB_PIPE_EP_MASK (0xf << USB_PIPE_EP_SHIFT)
  160. /* USB-status codes: */
  161. #define USB_ST_ACTIVE 0x1 /* TD is active */
  162. #define USB_ST_STALLED 0x2 /* TD is stalled */
  163. #define USB_ST_BUF_ERR 0x4 /* buffer error */
  164. #define USB_ST_BABBLE_DET 0x8 /* Babble detected */
  165. #define USB_ST_NAK_REC 0x10 /* NAK Received*/
  166. #define USB_ST_CRC_ERR 0x20 /* CRC/timeout Error */
  167. #define USB_ST_BIT_ERR 0x40 /* Bitstuff error */
  168. #define USB_ST_NOT_PROC 0x80000000L /* Not yet processed */
  169. /*************************************************************************
  170. * Hub defines
  171. */
  172. /*
  173. * Hub request types
  174. */
  175. #define USB_RT_HUB (USB_TYPE_CLASS | USB_RECIP_DEVICE)
  176. #define USB_RT_PORT (USB_TYPE_CLASS | USB_RECIP_OTHER)
  177. /*
  178. * Hub Class feature numbers
  179. */
  180. #define C_HUB_LOCAL_POWER 0
  181. #define C_HUB_OVER_CURRENT 1
  182. /*
  183. * Port feature numbers
  184. */
  185. #define USB_PORT_FEAT_CONNECTION 0
  186. #define USB_PORT_FEAT_ENABLE 1
  187. #define USB_PORT_FEAT_SUSPEND 2
  188. #define USB_PORT_FEAT_OVER_CURRENT 3
  189. #define USB_PORT_FEAT_RESET 4
  190. #define USB_PORT_FEAT_POWER 8
  191. #define USB_PORT_FEAT_LOWSPEED 9
  192. #define USB_PORT_FEAT_HIGHSPEED 10
  193. #define USB_PORT_FEAT_C_CONNECTION 16
  194. #define USB_PORT_FEAT_C_ENABLE 17
  195. #define USB_PORT_FEAT_C_SUSPEND 18
  196. #define USB_PORT_FEAT_C_OVER_CURRENT 19
  197. #define USB_PORT_FEAT_C_RESET 20
  198. #define USB_PORT_FEAT_TEST 21
  199. /*
  200. * Changes to Port feature numbers for Super speed,
  201. * from USB 3.0 spec Table 10-8
  202. */
  203. #define USB_SS_PORT_FEAT_U1_TIMEOUT 23
  204. #define USB_SS_PORT_FEAT_U2_TIMEOUT 24
  205. #define USB_SS_PORT_FEAT_C_LINK_STATE 25
  206. #define USB_SS_PORT_FEAT_C_CONFIG_ERROR 26
  207. #define USB_SS_PORT_FEAT_BH_RESET 28
  208. #define USB_SS_PORT_FEAT_C_BH_RESET 29
  209. /* wPortStatus bits */
  210. #define USB_PORT_STAT_CONNECTION 0x0001
  211. #define USB_PORT_STAT_ENABLE 0x0002
  212. #define USB_PORT_STAT_SUSPEND 0x0004
  213. #define USB_PORT_STAT_OVERCURRENT 0x0008
  214. #define USB_PORT_STAT_RESET 0x0010
  215. #define USB_PORT_STAT_POWER 0x0100
  216. #define USB_PORT_STAT_LOW_SPEED 0x0200
  217. #define USB_PORT_STAT_HIGH_SPEED 0x0400 /* support for EHCI */
  218. #define USB_PORT_STAT_SUPER_SPEED 0x0600 /* faking support to XHCI */
  219. #define USB_PORT_STAT_SPEED_MASK \
  220. (USB_PORT_STAT_LOW_SPEED | USB_PORT_STAT_HIGH_SPEED)
  221. /*
  222. * Changes to wPortStatus bit field in USB 3.0
  223. * See USB 3.0 spec Table 10-10
  224. */
  225. #define USB_SS_PORT_STAT_LINK_STATE 0x01e0
  226. #define USB_SS_PORT_STAT_POWER 0x0200
  227. #define USB_SS_PORT_STAT_SPEED 0x1c00
  228. #define USB_SS_PORT_STAT_SPEED_5GBPS 0x0000
  229. /* Bits that are the same from USB 2.0 */
  230. #define USB_SS_PORT_STAT_MASK (USB_PORT_STAT_CONNECTION | \
  231. USB_PORT_STAT_ENABLE | \
  232. USB_PORT_STAT_OVERCURRENT | \
  233. USB_PORT_STAT_RESET)
  234. /* wPortChange bits */
  235. #define USB_PORT_STAT_C_CONNECTION 0x0001
  236. #define USB_PORT_STAT_C_ENABLE 0x0002
  237. #define USB_PORT_STAT_C_SUSPEND 0x0004
  238. #define USB_PORT_STAT_C_OVERCURRENT 0x0008
  239. #define USB_PORT_STAT_C_RESET 0x0010
  240. /*
  241. * Changes to wPortChange bit fields in USB 3.0
  242. * See USB 3.0 spec Table 10-12
  243. */
  244. #define USB_SS_PORT_STAT_C_BH_RESET 0x0020
  245. #define USB_SS_PORT_STAT_C_LINK_STATE 0x0040
  246. #define USB_SS_PORT_STAT_C_CONFIG_ERROR 0x0080
  247. /* wHubCharacteristics (masks) */
  248. #define HUB_CHAR_LPSM 0x0003
  249. #define HUB_CHAR_COMPOUND 0x0004
  250. #define HUB_CHAR_OCPM 0x0018
  251. #define HUB_CHAR_TTTT 0x0060 /* TT Think Time mask */
  252. /*
  253. * Hub Status & Hub Change bit masks
  254. */
  255. #define HUB_STATUS_LOCAL_POWER 0x0001
  256. #define HUB_STATUS_OVERCURRENT 0x0002
  257. #define HUB_CHANGE_LOCAL_POWER 0x0001
  258. #define HUB_CHANGE_OVERCURRENT 0x0002
  259. /* Mask for wIndex in get/set port feature */
  260. #define USB_HUB_PORT_MASK 0xf
  261. /* Hub class request codes */
  262. #define USB_REQ_SET_HUB_DEPTH 0x0c
  263. /*
  264. * As of USB 2.0, full/low speed devices are segregated into trees.
  265. * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
  266. * The other type grows from high speed hubs when they connect to
  267. * full/low speed devices using "Transaction Translators" (TTs).
  268. */
  269. struct usb_tt {
  270. bool multi; /* true means one TT per port */
  271. unsigned think_time; /* think time in ns */
  272. };
  273. /*
  274. * CBI style
  275. */
  276. #define US_CBI_ADSC 0
  277. /* Command Block Wrapper */
  278. struct umass_bbb_cbw {
  279. u32 dCBWSignature;
  280. # define CBWSIGNATURE 0x43425355
  281. u32 dCBWTag;
  282. u32 dCBWDataTransferLength;
  283. u8 bCBWFlags;
  284. # define CBWFLAGS_OUT 0x00
  285. # define CBWFLAGS_IN 0x80
  286. # define CBWFLAGS_SBZ 0x7f
  287. u8 bCBWLUN;
  288. u8 bCDBLength;
  289. # define CBWCDBLENGTH 16
  290. u8 CBWCDB[CBWCDBLENGTH];
  291. };
  292. #define UMASS_BBB_CBW_SIZE 31
  293. /* Command Status Wrapper */
  294. struct umass_bbb_csw {
  295. u32 dCSWSignature;
  296. # define CSWSIGNATURE 0x53425355
  297. u32 dCSWTag;
  298. u32 dCSWDataResidue;
  299. u8 bCSWStatus;
  300. # define CSWSTATUS_GOOD 0x0
  301. # define CSWSTATUS_FAILED 0x1
  302. # define CSWSTATUS_PHASE 0x2
  303. };
  304. #define UMASS_BBB_CSW_SIZE 13
  305. /*
  306. * BULK only
  307. */
  308. #define US_BBB_RESET 0xff
  309. #define US_BBB_GET_MAX_LUN 0xfe
  310. #endif /*_USB_DEFS_H_ */