core.h 33 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087
  1. /**
  2. * core.h - DesignWare USB3 DRD Core Header
  3. *
  4. * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
  5. *
  6. * Authors: Felipe Balbi <balbi@ti.com>,
  7. * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
  8. *
  9. * This program is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU General Public License version 2 of
  11. * the License as published by the Free Software Foundation.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. */
  18. #ifndef __DRIVERS_USB_DWC3_CORE_H
  19. #define __DRIVERS_USB_DWC3_CORE_H
  20. #include <linux/device.h>
  21. #include <linux/spinlock.h>
  22. #include <linux/ioport.h>
  23. #include <linux/list.h>
  24. #include <linux/dma-mapping.h>
  25. #include <linux/mm.h>
  26. #include <linux/debugfs.h>
  27. #include <linux/usb/ch9.h>
  28. #include <linux/usb/gadget.h>
  29. #include <linux/usb/otg.h>
  30. #include <linux/ulpi/interface.h>
  31. #include <linux/phy/phy.h>
  32. #define DWC3_MSG_MAX 500
  33. /* Global constants */
  34. #define DWC3_EP0_BOUNCE_SIZE 512
  35. #define DWC3_ENDPOINTS_NUM 32
  36. #define DWC3_XHCI_RESOURCES_NUM 2
  37. #define DWC3_SCRATCHBUF_SIZE 4096 /* each buffer is assumed to be 4KiB */
  38. #define DWC3_EVENT_SIZE 4 /* bytes */
  39. #define DWC3_EVENT_MAX_NUM 64 /* 2 events/endpoint */
  40. #define DWC3_EVENT_BUFFERS_SIZE (DWC3_EVENT_SIZE * DWC3_EVENT_MAX_NUM)
  41. #define DWC3_EVENT_TYPE_MASK 0xfe
  42. #define DWC3_EVENT_TYPE_DEV 0
  43. #define DWC3_EVENT_TYPE_CARKIT 3
  44. #define DWC3_EVENT_TYPE_I2C 4
  45. #define DWC3_DEVICE_EVENT_DISCONNECT 0
  46. #define DWC3_DEVICE_EVENT_RESET 1
  47. #define DWC3_DEVICE_EVENT_CONNECT_DONE 2
  48. #define DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE 3
  49. #define DWC3_DEVICE_EVENT_WAKEUP 4
  50. #define DWC3_DEVICE_EVENT_HIBER_REQ 5
  51. #define DWC3_DEVICE_EVENT_EOPF 6
  52. #define DWC3_DEVICE_EVENT_SOF 7
  53. #define DWC3_DEVICE_EVENT_ERRATIC_ERROR 9
  54. #define DWC3_DEVICE_EVENT_CMD_CMPL 10
  55. #define DWC3_DEVICE_EVENT_OVERFLOW 11
  56. #define DWC3_GEVNTCOUNT_MASK 0xfffc
  57. #define DWC3_GSNPSID_MASK 0xffff0000
  58. #define DWC3_GSNPSREV_MASK 0xffff
  59. /* DWC3 registers memory space boundries */
  60. #define DWC3_XHCI_REGS_START 0x0
  61. #define DWC3_XHCI_REGS_END 0x7fff
  62. #define DWC3_GLOBALS_REGS_START 0xc100
  63. #define DWC3_GLOBALS_REGS_END 0xc6ff
  64. #define DWC3_DEVICE_REGS_START 0xc700
  65. #define DWC3_DEVICE_REGS_END 0xcbff
  66. #define DWC3_OTG_REGS_START 0xcc00
  67. #define DWC3_OTG_REGS_END 0xccff
  68. /* Global Registers */
  69. #define DWC3_GSBUSCFG0 0xc100
  70. #define DWC3_GSBUSCFG1 0xc104
  71. #define DWC3_GTXTHRCFG 0xc108
  72. #define DWC3_GRXTHRCFG 0xc10c
  73. #define DWC3_GCTL 0xc110
  74. #define DWC3_GEVTEN 0xc114
  75. #define DWC3_GSTS 0xc118
  76. #define DWC3_GSNPSID 0xc120
  77. #define DWC3_GGPIO 0xc124
  78. #define DWC3_GUID 0xc128
  79. #define DWC3_GUCTL 0xc12c
  80. #define DWC3_GBUSERRADDR0 0xc130
  81. #define DWC3_GBUSERRADDR1 0xc134
  82. #define DWC3_GPRTBIMAP0 0xc138
  83. #define DWC3_GPRTBIMAP1 0xc13c
  84. #define DWC3_GHWPARAMS0 0xc140
  85. #define DWC3_GHWPARAMS1 0xc144
  86. #define DWC3_GHWPARAMS2 0xc148
  87. #define DWC3_GHWPARAMS3 0xc14c
  88. #define DWC3_GHWPARAMS4 0xc150
  89. #define DWC3_GHWPARAMS5 0xc154
  90. #define DWC3_GHWPARAMS6 0xc158
  91. #define DWC3_GHWPARAMS7 0xc15c
  92. #define DWC3_GDBGFIFOSPACE 0xc160
  93. #define DWC3_GDBGLTSSM 0xc164
  94. #define DWC3_GPRTBIMAP_HS0 0xc180
  95. #define DWC3_GPRTBIMAP_HS1 0xc184
  96. #define DWC3_GPRTBIMAP_FS0 0xc188
  97. #define DWC3_GPRTBIMAP_FS1 0xc18c
  98. #define DWC3_VER_NUMBER 0xc1a0
  99. #define DWC3_VER_TYPE 0xc1a4
  100. #define DWC3_GUSB2PHYCFG(n) (0xc200 + (n * 0x04))
  101. #define DWC3_GUSB2I2CCTL(n) (0xc240 + (n * 0x04))
  102. #define DWC3_GUSB2PHYACC(n) (0xc280 + (n * 0x04))
  103. #define DWC3_GUSB3PIPECTL(n) (0xc2c0 + (n * 0x04))
  104. #define DWC3_GTXFIFOSIZ(n) (0xc300 + (n * 0x04))
  105. #define DWC3_GRXFIFOSIZ(n) (0xc380 + (n * 0x04))
  106. #define DWC3_GEVNTADRLO(n) (0xc400 + (n * 0x10))
  107. #define DWC3_GEVNTADRHI(n) (0xc404 + (n * 0x10))
  108. #define DWC3_GEVNTSIZ(n) (0xc408 + (n * 0x10))
  109. #define DWC3_GEVNTCOUNT(n) (0xc40c + (n * 0x10))
  110. #define DWC3_GHWPARAMS8 0xc600
  111. #define DWC3_GFLADJ 0xc630
  112. /* Device Registers */
  113. #define DWC3_DCFG 0xc700
  114. #define DWC3_DCTL 0xc704
  115. #define DWC3_DEVTEN 0xc708
  116. #define DWC3_DSTS 0xc70c
  117. #define DWC3_DGCMDPAR 0xc710
  118. #define DWC3_DGCMD 0xc714
  119. #define DWC3_DALEPENA 0xc720
  120. #define DWC3_DEPCMDPAR2(n) (0xc800 + (n * 0x10))
  121. #define DWC3_DEPCMDPAR1(n) (0xc804 + (n * 0x10))
  122. #define DWC3_DEPCMDPAR0(n) (0xc808 + (n * 0x10))
  123. #define DWC3_DEPCMD(n) (0xc80c + (n * 0x10))
  124. /* OTG Registers */
  125. #define DWC3_OCFG 0xcc00
  126. #define DWC3_OCTL 0xcc04
  127. #define DWC3_OEVT 0xcc08
  128. #define DWC3_OEVTEN 0xcc0C
  129. #define DWC3_OSTS 0xcc10
  130. /* Bit fields */
  131. /* Global Configuration Register */
  132. #define DWC3_GCTL_PWRDNSCALE(n) ((n) << 19)
  133. #define DWC3_GCTL_U2RSTECN (1 << 16)
  134. #define DWC3_GCTL_RAMCLKSEL(x) (((x) & DWC3_GCTL_CLK_MASK) << 6)
  135. #define DWC3_GCTL_CLK_BUS (0)
  136. #define DWC3_GCTL_CLK_PIPE (1)
  137. #define DWC3_GCTL_CLK_PIPEHALF (2)
  138. #define DWC3_GCTL_CLK_MASK (3)
  139. #define DWC3_GCTL_PRTCAP(n) (((n) & (3 << 12)) >> 12)
  140. #define DWC3_GCTL_PRTCAPDIR(n) ((n) << 12)
  141. #define DWC3_GCTL_PRTCAP_HOST 1
  142. #define DWC3_GCTL_PRTCAP_DEVICE 2
  143. #define DWC3_GCTL_PRTCAP_OTG 3
  144. #define DWC3_GCTL_CORESOFTRESET (1 << 11)
  145. #define DWC3_GCTL_SOFITPSYNC (1 << 10)
  146. #define DWC3_GCTL_SCALEDOWN(n) ((n) << 4)
  147. #define DWC3_GCTL_SCALEDOWN_MASK DWC3_GCTL_SCALEDOWN(3)
  148. #define DWC3_GCTL_DISSCRAMBLE (1 << 3)
  149. #define DWC3_GCTL_U2EXIT_LFPS (1 << 2)
  150. #define DWC3_GCTL_GBLHIBERNATIONEN (1 << 1)
  151. #define DWC3_GCTL_DSBLCLKGTNG (1 << 0)
  152. /* Global USB2 PHY Configuration Register */
  153. #define DWC3_GUSB2PHYCFG_PHYSOFTRST (1 << 31)
  154. #define DWC3_GUSB2PHYCFG_SUSPHY (1 << 6)
  155. #define DWC3_GUSB2PHYCFG_ULPI_UTMI (1 << 4)
  156. /* Global USB2 PHY Vendor Control Register */
  157. #define DWC3_GUSB2PHYACC_NEWREGREQ (1 << 25)
  158. #define DWC3_GUSB2PHYACC_BUSY (1 << 23)
  159. #define DWC3_GUSB2PHYACC_WRITE (1 << 22)
  160. #define DWC3_GUSB2PHYACC_ADDR(n) (n << 16)
  161. #define DWC3_GUSB2PHYACC_EXTEND_ADDR(n) (n << 8)
  162. #define DWC3_GUSB2PHYACC_DATA(n) (n & 0xff)
  163. /* Global USB3 PIPE Control Register */
  164. #define DWC3_GUSB3PIPECTL_PHYSOFTRST (1 << 31)
  165. #define DWC3_GUSB3PIPECTL_U2SSINP3OK (1 << 29)
  166. #define DWC3_GUSB3PIPECTL_REQP1P2P3 (1 << 24)
  167. #define DWC3_GUSB3PIPECTL_DEP1P2P3(n) ((n) << 19)
  168. #define DWC3_GUSB3PIPECTL_DEP1P2P3_MASK DWC3_GUSB3PIPECTL_DEP1P2P3(7)
  169. #define DWC3_GUSB3PIPECTL_DEP1P2P3_EN DWC3_GUSB3PIPECTL_DEP1P2P3(1)
  170. #define DWC3_GUSB3PIPECTL_DEPOCHANGE (1 << 18)
  171. #define DWC3_GUSB3PIPECTL_SUSPHY (1 << 17)
  172. #define DWC3_GUSB3PIPECTL_LFPSFILT (1 << 9)
  173. #define DWC3_GUSB3PIPECTL_RX_DETOPOLL (1 << 8)
  174. #define DWC3_GUSB3PIPECTL_TX_DEEPH_MASK DWC3_GUSB3PIPECTL_TX_DEEPH(3)
  175. #define DWC3_GUSB3PIPECTL_TX_DEEPH(n) ((n) << 1)
  176. /* Global TX Fifo Size Register */
  177. #define DWC3_GTXFIFOSIZ_TXFDEF(n) ((n) & 0xffff)
  178. #define DWC3_GTXFIFOSIZ_TXFSTADDR(n) ((n) & 0xffff0000)
  179. /* Global Event Size Registers */
  180. #define DWC3_GEVNTSIZ_INTMASK (1 << 31)
  181. #define DWC3_GEVNTSIZ_SIZE(n) ((n) & 0xffff)
  182. /* Global HWPARAMS1 Register */
  183. #define DWC3_GHWPARAMS1_EN_PWROPT(n) (((n) & (3 << 24)) >> 24)
  184. #define DWC3_GHWPARAMS1_EN_PWROPT_NO 0
  185. #define DWC3_GHWPARAMS1_EN_PWROPT_CLK 1
  186. #define DWC3_GHWPARAMS1_EN_PWROPT_HIB 2
  187. #define DWC3_GHWPARAMS1_PWROPT(n) ((n) << 24)
  188. #define DWC3_GHWPARAMS1_PWROPT_MASK DWC3_GHWPARAMS1_PWROPT(3)
  189. /* Global HWPARAMS3 Register */
  190. #define DWC3_GHWPARAMS3_SSPHY_IFC(n) ((n) & 3)
  191. #define DWC3_GHWPARAMS3_SSPHY_IFC_DIS 0
  192. #define DWC3_GHWPARAMS3_SSPHY_IFC_ENA 1
  193. #define DWC3_GHWPARAMS3_HSPHY_IFC(n) (((n) & (3 << 2)) >> 2)
  194. #define DWC3_GHWPARAMS3_HSPHY_IFC_DIS 0
  195. #define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI 1
  196. #define DWC3_GHWPARAMS3_HSPHY_IFC_ULPI 2
  197. #define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI_ULPI 3
  198. #define DWC3_GHWPARAMS3_FSPHY_IFC(n) (((n) & (3 << 4)) >> 4)
  199. #define DWC3_GHWPARAMS3_FSPHY_IFC_DIS 0
  200. #define DWC3_GHWPARAMS3_FSPHY_IFC_ENA 1
  201. /* Global HWPARAMS4 Register */
  202. #define DWC3_GHWPARAMS4_HIBER_SCRATCHBUFS(n) (((n) & (0x0f << 13)) >> 13)
  203. #define DWC3_MAX_HIBER_SCRATCHBUFS 15
  204. /* Global HWPARAMS6 Register */
  205. #define DWC3_GHWPARAMS6_EN_FPGA (1 << 7)
  206. /* Global Frame Length Adjustment Register */
  207. #define DWC3_GFLADJ_30MHZ_SDBND_SEL (1 << 7)
  208. #define DWC3_GFLADJ_30MHZ_MASK 0x3f
  209. /* Device Configuration Register */
  210. #define DWC3_DCFG_DEVADDR(addr) ((addr) << 3)
  211. #define DWC3_DCFG_DEVADDR_MASK DWC3_DCFG_DEVADDR(0x7f)
  212. #define DWC3_DCFG_SPEED_MASK (7 << 0)
  213. #define DWC3_DCFG_SUPERSPEED (4 << 0)
  214. #define DWC3_DCFG_HIGHSPEED (0 << 0)
  215. #define DWC3_DCFG_FULLSPEED2 (1 << 0)
  216. #define DWC3_DCFG_LOWSPEED (2 << 0)
  217. #define DWC3_DCFG_FULLSPEED1 (3 << 0)
  218. #define DWC3_DCFG_LPM_CAP (1 << 22)
  219. /* Device Control Register */
  220. #define DWC3_DCTL_RUN_STOP (1 << 31)
  221. #define DWC3_DCTL_CSFTRST (1 << 30)
  222. #define DWC3_DCTL_LSFTRST (1 << 29)
  223. #define DWC3_DCTL_HIRD_THRES_MASK (0x1f << 24)
  224. #define DWC3_DCTL_HIRD_THRES(n) ((n) << 24)
  225. #define DWC3_DCTL_APPL1RES (1 << 23)
  226. /* These apply for core versions 1.87a and earlier */
  227. #define DWC3_DCTL_TRGTULST_MASK (0x0f << 17)
  228. #define DWC3_DCTL_TRGTULST(n) ((n) << 17)
  229. #define DWC3_DCTL_TRGTULST_U2 (DWC3_DCTL_TRGTULST(2))
  230. #define DWC3_DCTL_TRGTULST_U3 (DWC3_DCTL_TRGTULST(3))
  231. #define DWC3_DCTL_TRGTULST_SS_DIS (DWC3_DCTL_TRGTULST(4))
  232. #define DWC3_DCTL_TRGTULST_RX_DET (DWC3_DCTL_TRGTULST(5))
  233. #define DWC3_DCTL_TRGTULST_SS_INACT (DWC3_DCTL_TRGTULST(6))
  234. /* These apply for core versions 1.94a and later */
  235. #define DWC3_DCTL_LPM_ERRATA_MASK DWC3_DCTL_LPM_ERRATA(0xf)
  236. #define DWC3_DCTL_LPM_ERRATA(n) ((n) << 20)
  237. #define DWC3_DCTL_KEEP_CONNECT (1 << 19)
  238. #define DWC3_DCTL_L1_HIBER_EN (1 << 18)
  239. #define DWC3_DCTL_CRS (1 << 17)
  240. #define DWC3_DCTL_CSS (1 << 16)
  241. #define DWC3_DCTL_INITU2ENA (1 << 12)
  242. #define DWC3_DCTL_ACCEPTU2ENA (1 << 11)
  243. #define DWC3_DCTL_INITU1ENA (1 << 10)
  244. #define DWC3_DCTL_ACCEPTU1ENA (1 << 9)
  245. #define DWC3_DCTL_TSTCTRL_MASK (0xf << 1)
  246. #define DWC3_DCTL_ULSTCHNGREQ_MASK (0x0f << 5)
  247. #define DWC3_DCTL_ULSTCHNGREQ(n) (((n) << 5) & DWC3_DCTL_ULSTCHNGREQ_MASK)
  248. #define DWC3_DCTL_ULSTCHNG_NO_ACTION (DWC3_DCTL_ULSTCHNGREQ(0))
  249. #define DWC3_DCTL_ULSTCHNG_SS_DISABLED (DWC3_DCTL_ULSTCHNGREQ(4))
  250. #define DWC3_DCTL_ULSTCHNG_RX_DETECT (DWC3_DCTL_ULSTCHNGREQ(5))
  251. #define DWC3_DCTL_ULSTCHNG_SS_INACTIVE (DWC3_DCTL_ULSTCHNGREQ(6))
  252. #define DWC3_DCTL_ULSTCHNG_RECOVERY (DWC3_DCTL_ULSTCHNGREQ(8))
  253. #define DWC3_DCTL_ULSTCHNG_COMPLIANCE (DWC3_DCTL_ULSTCHNGREQ(10))
  254. #define DWC3_DCTL_ULSTCHNG_LOOPBACK (DWC3_DCTL_ULSTCHNGREQ(11))
  255. /* Device Event Enable Register */
  256. #define DWC3_DEVTEN_VNDRDEVTSTRCVEDEN (1 << 12)
  257. #define DWC3_DEVTEN_EVNTOVERFLOWEN (1 << 11)
  258. #define DWC3_DEVTEN_CMDCMPLTEN (1 << 10)
  259. #define DWC3_DEVTEN_ERRTICERREN (1 << 9)
  260. #define DWC3_DEVTEN_SOFEN (1 << 7)
  261. #define DWC3_DEVTEN_EOPFEN (1 << 6)
  262. #define DWC3_DEVTEN_HIBERNATIONREQEVTEN (1 << 5)
  263. #define DWC3_DEVTEN_WKUPEVTEN (1 << 4)
  264. #define DWC3_DEVTEN_ULSTCNGEN (1 << 3)
  265. #define DWC3_DEVTEN_CONNECTDONEEN (1 << 2)
  266. #define DWC3_DEVTEN_USBRSTEN (1 << 1)
  267. #define DWC3_DEVTEN_DISCONNEVTEN (1 << 0)
  268. /* Device Status Register */
  269. #define DWC3_DSTS_DCNRD (1 << 29)
  270. /* This applies for core versions 1.87a and earlier */
  271. #define DWC3_DSTS_PWRUPREQ (1 << 24)
  272. /* These apply for core versions 1.94a and later */
  273. #define DWC3_DSTS_RSS (1 << 25)
  274. #define DWC3_DSTS_SSS (1 << 24)
  275. #define DWC3_DSTS_COREIDLE (1 << 23)
  276. #define DWC3_DSTS_DEVCTRLHLT (1 << 22)
  277. #define DWC3_DSTS_USBLNKST_MASK (0x0f << 18)
  278. #define DWC3_DSTS_USBLNKST(n) (((n) & DWC3_DSTS_USBLNKST_MASK) >> 18)
  279. #define DWC3_DSTS_RXFIFOEMPTY (1 << 17)
  280. #define DWC3_DSTS_SOFFN_MASK (0x3fff << 3)
  281. #define DWC3_DSTS_SOFFN(n) (((n) & DWC3_DSTS_SOFFN_MASK) >> 3)
  282. #define DWC3_DSTS_CONNECTSPD (7 << 0)
  283. #define DWC3_DSTS_SUPERSPEED (4 << 0)
  284. #define DWC3_DSTS_HIGHSPEED (0 << 0)
  285. #define DWC3_DSTS_FULLSPEED2 (1 << 0)
  286. #define DWC3_DSTS_LOWSPEED (2 << 0)
  287. #define DWC3_DSTS_FULLSPEED1 (3 << 0)
  288. /* Device Generic Command Register */
  289. #define DWC3_DGCMD_SET_LMP 0x01
  290. #define DWC3_DGCMD_SET_PERIODIC_PAR 0x02
  291. #define DWC3_DGCMD_XMIT_FUNCTION 0x03
  292. /* These apply for core versions 1.94a and later */
  293. #define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO 0x04
  294. #define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI 0x05
  295. #define DWC3_DGCMD_SELECTED_FIFO_FLUSH 0x09
  296. #define DWC3_DGCMD_ALL_FIFO_FLUSH 0x0a
  297. #define DWC3_DGCMD_SET_ENDPOINT_NRDY 0x0c
  298. #define DWC3_DGCMD_RUN_SOC_BUS_LOOPBACK 0x10
  299. #define DWC3_DGCMD_STATUS(n) (((n) >> 12) & 0x0F)
  300. #define DWC3_DGCMD_CMDACT (1 << 10)
  301. #define DWC3_DGCMD_CMDIOC (1 << 8)
  302. /* Device Generic Command Parameter Register */
  303. #define DWC3_DGCMDPAR_FORCE_LINKPM_ACCEPT (1 << 0)
  304. #define DWC3_DGCMDPAR_FIFO_NUM(n) ((n) << 0)
  305. #define DWC3_DGCMDPAR_RX_FIFO (0 << 5)
  306. #define DWC3_DGCMDPAR_TX_FIFO (1 << 5)
  307. #define DWC3_DGCMDPAR_LOOPBACK_DIS (0 << 0)
  308. #define DWC3_DGCMDPAR_LOOPBACK_ENA (1 << 0)
  309. /* Device Endpoint Command Register */
  310. #define DWC3_DEPCMD_PARAM_SHIFT 16
  311. #define DWC3_DEPCMD_PARAM(x) ((x) << DWC3_DEPCMD_PARAM_SHIFT)
  312. #define DWC3_DEPCMD_GET_RSC_IDX(x) (((x) >> DWC3_DEPCMD_PARAM_SHIFT) & 0x7f)
  313. #define DWC3_DEPCMD_STATUS(x) (((x) >> 12) & 0x0F)
  314. #define DWC3_DEPCMD_HIPRI_FORCERM (1 << 11)
  315. #define DWC3_DEPCMD_CMDACT (1 << 10)
  316. #define DWC3_DEPCMD_CMDIOC (1 << 8)
  317. #define DWC3_DEPCMD_DEPSTARTCFG (0x09 << 0)
  318. #define DWC3_DEPCMD_ENDTRANSFER (0x08 << 0)
  319. #define DWC3_DEPCMD_UPDATETRANSFER (0x07 << 0)
  320. #define DWC3_DEPCMD_STARTTRANSFER (0x06 << 0)
  321. #define DWC3_DEPCMD_CLEARSTALL (0x05 << 0)
  322. #define DWC3_DEPCMD_SETSTALL (0x04 << 0)
  323. /* This applies for core versions 1.90a and earlier */
  324. #define DWC3_DEPCMD_GETSEQNUMBER (0x03 << 0)
  325. /* This applies for core versions 1.94a and later */
  326. #define DWC3_DEPCMD_GETEPSTATE (0x03 << 0)
  327. #define DWC3_DEPCMD_SETTRANSFRESOURCE (0x02 << 0)
  328. #define DWC3_DEPCMD_SETEPCONFIG (0x01 << 0)
  329. /* The EP number goes 0..31 so ep0 is always out and ep1 is always in */
  330. #define DWC3_DALEPENA_EP(n) (1 << n)
  331. #define DWC3_DEPCMD_TYPE_CONTROL 0
  332. #define DWC3_DEPCMD_TYPE_ISOC 1
  333. #define DWC3_DEPCMD_TYPE_BULK 2
  334. #define DWC3_DEPCMD_TYPE_INTR 3
  335. /* Structures */
  336. struct dwc3_trb;
  337. /**
  338. * struct dwc3_event_buffer - Software event buffer representation
  339. * @buf: _THE_ buffer
  340. * @length: size of this buffer
  341. * @lpos: event offset
  342. * @count: cache of last read event count register
  343. * @flags: flags related to this event buffer
  344. * @dma: dma_addr_t
  345. * @dwc: pointer to DWC controller
  346. */
  347. struct dwc3_event_buffer {
  348. void *buf;
  349. unsigned length;
  350. unsigned int lpos;
  351. unsigned int count;
  352. unsigned int flags;
  353. #define DWC3_EVENT_PENDING BIT(0)
  354. dma_addr_t dma;
  355. struct dwc3 *dwc;
  356. };
  357. #define DWC3_EP_FLAG_STALLED (1 << 0)
  358. #define DWC3_EP_FLAG_WEDGED (1 << 1)
  359. #define DWC3_EP_DIRECTION_TX true
  360. #define DWC3_EP_DIRECTION_RX false
  361. #define DWC3_TRB_NUM 32
  362. #define DWC3_TRB_MASK (DWC3_TRB_NUM - 1)
  363. /**
  364. * struct dwc3_ep - device side endpoint representation
  365. * @endpoint: usb endpoint
  366. * @request_list: list of requests for this endpoint
  367. * @req_queued: list of requests on this ep which have TRBs setup
  368. * @trb_pool: array of transaction buffers
  369. * @trb_pool_dma: dma address of @trb_pool
  370. * @free_slot: next slot which is going to be used
  371. * @busy_slot: first slot which is owned by HW
  372. * @desc: usb_endpoint_descriptor pointer
  373. * @dwc: pointer to DWC controller
  374. * @saved_state: ep state saved during hibernation
  375. * @flags: endpoint flags (wedged, stalled, ...)
  376. * @number: endpoint number (1 - 15)
  377. * @type: set to bmAttributes & USB_ENDPOINT_XFERTYPE_MASK
  378. * @resource_index: Resource transfer index
  379. * @interval: the interval on which the ISOC transfer is started
  380. * @name: a human readable name e.g. ep1out-bulk
  381. * @direction: true for TX, false for RX
  382. * @stream_capable: true when streams are enabled
  383. */
  384. struct dwc3_ep {
  385. struct usb_ep endpoint;
  386. struct list_head request_list;
  387. struct list_head req_queued;
  388. struct dwc3_trb *trb_pool;
  389. dma_addr_t trb_pool_dma;
  390. u32 free_slot;
  391. u32 busy_slot;
  392. const struct usb_ss_ep_comp_descriptor *comp_desc;
  393. struct dwc3 *dwc;
  394. u32 saved_state;
  395. unsigned flags;
  396. #define DWC3_EP_ENABLED (1 << 0)
  397. #define DWC3_EP_STALL (1 << 1)
  398. #define DWC3_EP_WEDGE (1 << 2)
  399. #define DWC3_EP_BUSY (1 << 4)
  400. #define DWC3_EP_PENDING_REQUEST (1 << 5)
  401. #define DWC3_EP_MISSED_ISOC (1 << 6)
  402. /* This last one is specific to EP0 */
  403. #define DWC3_EP0_DIR_IN (1 << 31)
  404. u8 number;
  405. u8 type;
  406. u8 resource_index;
  407. u32 interval;
  408. char name[20];
  409. unsigned direction:1;
  410. unsigned stream_capable:1;
  411. };
  412. enum dwc3_phy {
  413. DWC3_PHY_UNKNOWN = 0,
  414. DWC3_PHY_USB3,
  415. DWC3_PHY_USB2,
  416. };
  417. enum dwc3_ep0_next {
  418. DWC3_EP0_UNKNOWN = 0,
  419. DWC3_EP0_COMPLETE,
  420. DWC3_EP0_NRDY_DATA,
  421. DWC3_EP0_NRDY_STATUS,
  422. };
  423. enum dwc3_ep0_state {
  424. EP0_UNCONNECTED = 0,
  425. EP0_SETUP_PHASE,
  426. EP0_DATA_PHASE,
  427. EP0_STATUS_PHASE,
  428. };
  429. enum dwc3_link_state {
  430. /* In SuperSpeed */
  431. DWC3_LINK_STATE_U0 = 0x00, /* in HS, means ON */
  432. DWC3_LINK_STATE_U1 = 0x01,
  433. DWC3_LINK_STATE_U2 = 0x02, /* in HS, means SLEEP */
  434. DWC3_LINK_STATE_U3 = 0x03, /* in HS, means SUSPEND */
  435. DWC3_LINK_STATE_SS_DIS = 0x04,
  436. DWC3_LINK_STATE_RX_DET = 0x05, /* in HS, means Early Suspend */
  437. DWC3_LINK_STATE_SS_INACT = 0x06,
  438. DWC3_LINK_STATE_POLL = 0x07,
  439. DWC3_LINK_STATE_RECOV = 0x08,
  440. DWC3_LINK_STATE_HRESET = 0x09,
  441. DWC3_LINK_STATE_CMPLY = 0x0a,
  442. DWC3_LINK_STATE_LPBK = 0x0b,
  443. DWC3_LINK_STATE_RESET = 0x0e,
  444. DWC3_LINK_STATE_RESUME = 0x0f,
  445. DWC3_LINK_STATE_MASK = 0x0f,
  446. };
  447. /* TRB Length, PCM and Status */
  448. #define DWC3_TRB_SIZE_MASK (0x00ffffff)
  449. #define DWC3_TRB_SIZE_LENGTH(n) ((n) & DWC3_TRB_SIZE_MASK)
  450. #define DWC3_TRB_SIZE_PCM1(n) (((n) & 0x03) << 24)
  451. #define DWC3_TRB_SIZE_TRBSTS(n) (((n) & (0x0f << 28)) >> 28)
  452. #define DWC3_TRBSTS_OK 0
  453. #define DWC3_TRBSTS_MISSED_ISOC 1
  454. #define DWC3_TRBSTS_SETUP_PENDING 2
  455. #define DWC3_TRB_STS_XFER_IN_PROG 4
  456. /* TRB Control */
  457. #define DWC3_TRB_CTRL_HWO (1 << 0)
  458. #define DWC3_TRB_CTRL_LST (1 << 1)
  459. #define DWC3_TRB_CTRL_CHN (1 << 2)
  460. #define DWC3_TRB_CTRL_CSP (1 << 3)
  461. #define DWC3_TRB_CTRL_TRBCTL(n) (((n) & 0x3f) << 4)
  462. #define DWC3_TRB_CTRL_ISP_IMI (1 << 10)
  463. #define DWC3_TRB_CTRL_IOC (1 << 11)
  464. #define DWC3_TRB_CTRL_SID_SOFN(n) (((n) & 0xffff) << 14)
  465. #define DWC3_TRBCTL_NORMAL DWC3_TRB_CTRL_TRBCTL(1)
  466. #define DWC3_TRBCTL_CONTROL_SETUP DWC3_TRB_CTRL_TRBCTL(2)
  467. #define DWC3_TRBCTL_CONTROL_STATUS2 DWC3_TRB_CTRL_TRBCTL(3)
  468. #define DWC3_TRBCTL_CONTROL_STATUS3 DWC3_TRB_CTRL_TRBCTL(4)
  469. #define DWC3_TRBCTL_CONTROL_DATA DWC3_TRB_CTRL_TRBCTL(5)
  470. #define DWC3_TRBCTL_ISOCHRONOUS_FIRST DWC3_TRB_CTRL_TRBCTL(6)
  471. #define DWC3_TRBCTL_ISOCHRONOUS DWC3_TRB_CTRL_TRBCTL(7)
  472. #define DWC3_TRBCTL_LINK_TRB DWC3_TRB_CTRL_TRBCTL(8)
  473. /**
  474. * struct dwc3_trb - transfer request block (hw format)
  475. * @bpl: DW0-3
  476. * @bph: DW4-7
  477. * @size: DW8-B
  478. * @trl: DWC-F
  479. */
  480. struct dwc3_trb {
  481. u32 bpl;
  482. u32 bph;
  483. u32 size;
  484. u32 ctrl;
  485. } __packed;
  486. /**
  487. * dwc3_hwparams - copy of HWPARAMS registers
  488. * @hwparams0 - GHWPARAMS0
  489. * @hwparams1 - GHWPARAMS1
  490. * @hwparams2 - GHWPARAMS2
  491. * @hwparams3 - GHWPARAMS3
  492. * @hwparams4 - GHWPARAMS4
  493. * @hwparams5 - GHWPARAMS5
  494. * @hwparams6 - GHWPARAMS6
  495. * @hwparams7 - GHWPARAMS7
  496. * @hwparams8 - GHWPARAMS8
  497. */
  498. struct dwc3_hwparams {
  499. u32 hwparams0;
  500. u32 hwparams1;
  501. u32 hwparams2;
  502. u32 hwparams3;
  503. u32 hwparams4;
  504. u32 hwparams5;
  505. u32 hwparams6;
  506. u32 hwparams7;
  507. u32 hwparams8;
  508. };
  509. /* HWPARAMS0 */
  510. #define DWC3_MODE(n) ((n) & 0x7)
  511. #define DWC3_MDWIDTH(n) (((n) & 0xff00) >> 8)
  512. /* HWPARAMS1 */
  513. #define DWC3_NUM_INT(n) (((n) & (0x3f << 15)) >> 15)
  514. /* HWPARAMS3 */
  515. #define DWC3_NUM_IN_EPS_MASK (0x1f << 18)
  516. #define DWC3_NUM_EPS_MASK (0x3f << 12)
  517. #define DWC3_NUM_EPS(p) (((p)->hwparams3 & \
  518. (DWC3_NUM_EPS_MASK)) >> 12)
  519. #define DWC3_NUM_IN_EPS(p) (((p)->hwparams3 & \
  520. (DWC3_NUM_IN_EPS_MASK)) >> 18)
  521. /* HWPARAMS7 */
  522. #define DWC3_RAM1_DEPTH(n) ((n) & 0xffff)
  523. struct dwc3_request {
  524. struct usb_request request;
  525. struct list_head list;
  526. struct dwc3_ep *dep;
  527. u32 start_slot;
  528. u8 epnum;
  529. struct dwc3_trb *trb;
  530. dma_addr_t trb_dma;
  531. unsigned direction:1;
  532. unsigned mapped:1;
  533. unsigned queued:1;
  534. };
  535. /*
  536. * struct dwc3_scratchpad_array - hibernation scratchpad array
  537. * (format defined by hw)
  538. */
  539. struct dwc3_scratchpad_array {
  540. __le64 dma_adr[DWC3_MAX_HIBER_SCRATCHBUFS];
  541. };
  542. /**
  543. * struct dwc3 - representation of our controller
  544. * @ctrl_req: usb control request which is used for ep0
  545. * @ep0_trb: trb which is used for the ctrl_req
  546. * @ep0_bounce: bounce buffer for ep0
  547. * @setup_buf: used while precessing STD USB requests
  548. * @ctrl_req_addr: dma address of ctrl_req
  549. * @ep0_trb: dma address of ep0_trb
  550. * @ep0_usb_req: dummy req used while handling STD USB requests
  551. * @ep0_bounce_addr: dma address of ep0_bounce
  552. * @scratch_addr: dma address of scratchbuf
  553. * @lock: for synchronizing
  554. * @dev: pointer to our struct device
  555. * @xhci: pointer to our xHCI child
  556. * @event_buffer_list: a list of event buffers
  557. * @gadget: device side representation of the peripheral controller
  558. * @gadget_driver: pointer to the gadget driver
  559. * @regs: base address for our registers
  560. * @regs_size: address space size
  561. * @nr_scratch: number of scratch buffers
  562. * @num_event_buffers: calculated number of event buffers
  563. * @u1u2: only used on revisions <1.83a for workaround
  564. * @maximum_speed: maximum speed requested (mainly for testing purposes)
  565. * @revision: revision register contents
  566. * @dr_mode: requested mode of operation
  567. * @usb2_phy: pointer to USB2 PHY
  568. * @usb3_phy: pointer to USB3 PHY
  569. * @usb2_generic_phy: pointer to USB2 PHY
  570. * @usb3_generic_phy: pointer to USB3 PHY
  571. * @ulpi: pointer to ulpi interface
  572. * @dcfg: saved contents of DCFG register
  573. * @gctl: saved contents of GCTL register
  574. * @isoch_delay: wValue from Set Isochronous Delay request;
  575. * @u2sel: parameter from Set SEL request.
  576. * @u2pel: parameter from Set SEL request.
  577. * @u1sel: parameter from Set SEL request.
  578. * @u1pel: parameter from Set SEL request.
  579. * @num_out_eps: number of out endpoints
  580. * @num_in_eps: number of in endpoints
  581. * @ep0_next_event: hold the next expected event
  582. * @ep0state: state of endpoint zero
  583. * @link_state: link state
  584. * @speed: device speed (super, high, full, low)
  585. * @mem: points to start of memory which is used for this struct.
  586. * @hwparams: copy of hwparams registers
  587. * @root: debugfs root folder pointer
  588. * @regset: debugfs pointer to regdump file
  589. * @test_mode: true when we're entering a USB test mode
  590. * @test_mode_nr: test feature selector
  591. * @lpm_nyet_threshold: LPM NYET response threshold
  592. * @hird_threshold: HIRD threshold
  593. * @hsphy_interface: "utmi" or "ulpi"
  594. * @delayed_status: true when gadget driver asks for delayed status
  595. * @ep0_bounced: true when we used bounce buffer
  596. * @ep0_expect_in: true when we expect a DATA IN transfer
  597. * @has_hibernation: true when dwc3 was configured with Hibernation
  598. * @has_lpm_erratum: true when core was configured with LPM Erratum. Note that
  599. * there's now way for software to detect this in runtime.
  600. * @is_utmi_l1_suspend: the core asserts output signal
  601. * 0 - utmi_sleep_n
  602. * 1 - utmi_l1_suspend_n
  603. * @is_fpga: true when we are using the FPGA board
  604. * @needs_fifo_resize: not all users might want fifo resizing, flag it
  605. * @pullups_connected: true when Run/Stop bit is set
  606. * @resize_fifos: tells us it's ok to reconfigure our TxFIFO sizes.
  607. * @setup_packet_pending: true when there's a Setup Packet in FIFO. Workaround
  608. * @start_config_issued: true when StartConfig command has been issued
  609. * @three_stage_setup: set if we perform a three phase setup
  610. * @usb3_lpm_capable: set if hadrware supports Link Power Management
  611. * @disable_scramble_quirk: set if we enable the disable scramble quirk
  612. * @u2exit_lfps_quirk: set if we enable u2exit lfps quirk
  613. * @u2ss_inp3_quirk: set if we enable P3 OK for U2/SS Inactive quirk
  614. * @req_p1p2p3_quirk: set if we enable request p1p2p3 quirk
  615. * @del_p1p2p3_quirk: set if we enable delay p1p2p3 quirk
  616. * @del_phy_power_chg_quirk: set if we enable delay phy power change quirk
  617. * @lfps_filter_quirk: set if we enable LFPS filter quirk
  618. * @rx_detect_poll_quirk: set if we enable rx_detect to polling lfps quirk
  619. * @dis_u3_susphy_quirk: set if we disable usb3 suspend phy
  620. * @dis_u2_susphy_quirk: set if we disable usb2 suspend phy
  621. * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
  622. * @tx_de_emphasis: Tx de-emphasis value
  623. * 0 - -6dB de-emphasis
  624. * 1 - -3.5dB de-emphasis
  625. * 2 - No de-emphasis
  626. * 3 - Reserved
  627. */
  628. struct dwc3 {
  629. struct usb_ctrlrequest *ctrl_req;
  630. struct dwc3_trb *ep0_trb;
  631. void *ep0_bounce;
  632. void *scratchbuf;
  633. u8 *setup_buf;
  634. dma_addr_t ctrl_req_addr;
  635. dma_addr_t ep0_trb_addr;
  636. dma_addr_t ep0_bounce_addr;
  637. dma_addr_t scratch_addr;
  638. struct dwc3_request ep0_usb_req;
  639. /* device lock */
  640. spinlock_t lock;
  641. struct device *dev;
  642. struct platform_device *xhci;
  643. struct resource xhci_resources[DWC3_XHCI_RESOURCES_NUM];
  644. struct dwc3_event_buffer **ev_buffs;
  645. struct dwc3_ep *eps[DWC3_ENDPOINTS_NUM];
  646. struct usb_gadget gadget;
  647. struct usb_gadget_driver *gadget_driver;
  648. struct usb_phy *usb2_phy;
  649. struct usb_phy *usb3_phy;
  650. struct phy *usb2_generic_phy;
  651. struct phy *usb3_generic_phy;
  652. struct ulpi *ulpi;
  653. void __iomem *regs;
  654. size_t regs_size;
  655. enum usb_dr_mode dr_mode;
  656. /* used for suspend/resume */
  657. u32 dcfg;
  658. u32 gctl;
  659. u32 nr_scratch;
  660. u32 num_event_buffers;
  661. u32 u1u2;
  662. u32 maximum_speed;
  663. /*
  664. * All 3.1 IP version constants are greater than the 3.0 IP
  665. * version constants. This works for most version checks in
  666. * dwc3. However, in the future, this may not apply as
  667. * features may be developed on newer versions of the 3.0 IP
  668. * that are not in the 3.1 IP.
  669. */
  670. u32 revision;
  671. #define DWC3_REVISION_173A 0x5533173a
  672. #define DWC3_REVISION_175A 0x5533175a
  673. #define DWC3_REVISION_180A 0x5533180a
  674. #define DWC3_REVISION_183A 0x5533183a
  675. #define DWC3_REVISION_185A 0x5533185a
  676. #define DWC3_REVISION_187A 0x5533187a
  677. #define DWC3_REVISION_188A 0x5533188a
  678. #define DWC3_REVISION_190A 0x5533190a
  679. #define DWC3_REVISION_194A 0x5533194a
  680. #define DWC3_REVISION_200A 0x5533200a
  681. #define DWC3_REVISION_202A 0x5533202a
  682. #define DWC3_REVISION_210A 0x5533210a
  683. #define DWC3_REVISION_220A 0x5533220a
  684. #define DWC3_REVISION_230A 0x5533230a
  685. #define DWC3_REVISION_240A 0x5533240a
  686. #define DWC3_REVISION_250A 0x5533250a
  687. #define DWC3_REVISION_260A 0x5533260a
  688. #define DWC3_REVISION_270A 0x5533270a
  689. #define DWC3_REVISION_280A 0x5533280a
  690. /*
  691. * NOTICE: we're using bit 31 as a "is usb 3.1" flag. This is really
  692. * just so dwc31 revisions are always larger than dwc3.
  693. */
  694. #define DWC3_REVISION_IS_DWC31 0x80000000
  695. #define DWC3_USB31_REVISION_110A (0x3131302a | DWC3_REVISION_IS_USB31)
  696. enum dwc3_ep0_next ep0_next_event;
  697. enum dwc3_ep0_state ep0state;
  698. enum dwc3_link_state link_state;
  699. u16 isoch_delay;
  700. u16 u2sel;
  701. u16 u2pel;
  702. u8 u1sel;
  703. u8 u1pel;
  704. u8 speed;
  705. u8 num_out_eps;
  706. u8 num_in_eps;
  707. void *mem;
  708. struct dwc3_hwparams hwparams;
  709. struct dentry *root;
  710. struct debugfs_regset32 *regset;
  711. u8 test_mode;
  712. u8 test_mode_nr;
  713. u8 lpm_nyet_threshold;
  714. u8 hird_threshold;
  715. const char *hsphy_interface;
  716. unsigned delayed_status:1;
  717. unsigned ep0_bounced:1;
  718. unsigned ep0_expect_in:1;
  719. unsigned has_hibernation:1;
  720. unsigned has_lpm_erratum:1;
  721. unsigned is_utmi_l1_suspend:1;
  722. unsigned is_fpga:1;
  723. unsigned needs_fifo_resize:1;
  724. unsigned pullups_connected:1;
  725. unsigned resize_fifos:1;
  726. unsigned setup_packet_pending:1;
  727. unsigned start_config_issued:1;
  728. unsigned three_stage_setup:1;
  729. unsigned usb3_lpm_capable:1;
  730. unsigned disable_scramble_quirk:1;
  731. unsigned u2exit_lfps_quirk:1;
  732. unsigned u2ss_inp3_quirk:1;
  733. unsigned req_p1p2p3_quirk:1;
  734. unsigned del_p1p2p3_quirk:1;
  735. unsigned del_phy_power_chg_quirk:1;
  736. unsigned lfps_filter_quirk:1;
  737. unsigned rx_detect_poll_quirk:1;
  738. unsigned dis_u3_susphy_quirk:1;
  739. unsigned dis_u2_susphy_quirk:1;
  740. unsigned tx_de_emphasis_quirk:1;
  741. unsigned tx_de_emphasis:2;
  742. };
  743. /* -------------------------------------------------------------------------- */
  744. /* -------------------------------------------------------------------------- */
  745. struct dwc3_event_type {
  746. u32 is_devspec:1;
  747. u32 type:7;
  748. u32 reserved8_31:24;
  749. } __packed;
  750. #define DWC3_DEPEVT_XFERCOMPLETE 0x01
  751. #define DWC3_DEPEVT_XFERINPROGRESS 0x02
  752. #define DWC3_DEPEVT_XFERNOTREADY 0x03
  753. #define DWC3_DEPEVT_RXTXFIFOEVT 0x04
  754. #define DWC3_DEPEVT_STREAMEVT 0x06
  755. #define DWC3_DEPEVT_EPCMDCMPLT 0x07
  756. /**
  757. * struct dwc3_event_depvt - Device Endpoint Events
  758. * @one_bit: indicates this is an endpoint event (not used)
  759. * @endpoint_number: number of the endpoint
  760. * @endpoint_event: The event we have:
  761. * 0x00 - Reserved
  762. * 0x01 - XferComplete
  763. * 0x02 - XferInProgress
  764. * 0x03 - XferNotReady
  765. * 0x04 - RxTxFifoEvt (IN->Underrun, OUT->Overrun)
  766. * 0x05 - Reserved
  767. * 0x06 - StreamEvt
  768. * 0x07 - EPCmdCmplt
  769. * @reserved11_10: Reserved, don't use.
  770. * @status: Indicates the status of the event. Refer to databook for
  771. * more information.
  772. * @parameters: Parameters of the current event. Refer to databook for
  773. * more information.
  774. */
  775. struct dwc3_event_depevt {
  776. u32 one_bit:1;
  777. u32 endpoint_number:5;
  778. u32 endpoint_event:4;
  779. u32 reserved11_10:2;
  780. u32 status:4;
  781. /* Within XferNotReady */
  782. #define DEPEVT_STATUS_TRANSFER_ACTIVE (1 << 3)
  783. /* Within XferComplete */
  784. #define DEPEVT_STATUS_BUSERR (1 << 0)
  785. #define DEPEVT_STATUS_SHORT (1 << 1)
  786. #define DEPEVT_STATUS_IOC (1 << 2)
  787. #define DEPEVT_STATUS_LST (1 << 3)
  788. /* Stream event only */
  789. #define DEPEVT_STREAMEVT_FOUND 1
  790. #define DEPEVT_STREAMEVT_NOTFOUND 2
  791. /* Control-only Status */
  792. #define DEPEVT_STATUS_CONTROL_DATA 1
  793. #define DEPEVT_STATUS_CONTROL_STATUS 2
  794. u32 parameters:16;
  795. } __packed;
  796. /**
  797. * struct dwc3_event_devt - Device Events
  798. * @one_bit: indicates this is a non-endpoint event (not used)
  799. * @device_event: indicates it's a device event. Should read as 0x00
  800. * @type: indicates the type of device event.
  801. * 0 - DisconnEvt
  802. * 1 - USBRst
  803. * 2 - ConnectDone
  804. * 3 - ULStChng
  805. * 4 - WkUpEvt
  806. * 5 - Reserved
  807. * 6 - EOPF
  808. * 7 - SOF
  809. * 8 - Reserved
  810. * 9 - ErrticErr
  811. * 10 - CmdCmplt
  812. * 11 - EvntOverflow
  813. * 12 - VndrDevTstRcved
  814. * @reserved15_12: Reserved, not used
  815. * @event_info: Information about this event
  816. * @reserved31_25: Reserved, not used
  817. */
  818. struct dwc3_event_devt {
  819. u32 one_bit:1;
  820. u32 device_event:7;
  821. u32 type:4;
  822. u32 reserved15_12:4;
  823. u32 event_info:9;
  824. u32 reserved31_25:7;
  825. } __packed;
  826. /**
  827. * struct dwc3_event_gevt - Other Core Events
  828. * @one_bit: indicates this is a non-endpoint event (not used)
  829. * @device_event: indicates it's (0x03) Carkit or (0x04) I2C event.
  830. * @phy_port_number: self-explanatory
  831. * @reserved31_12: Reserved, not used.
  832. */
  833. struct dwc3_event_gevt {
  834. u32 one_bit:1;
  835. u32 device_event:7;
  836. u32 phy_port_number:4;
  837. u32 reserved31_12:20;
  838. } __packed;
  839. /**
  840. * union dwc3_event - representation of Event Buffer contents
  841. * @raw: raw 32-bit event
  842. * @type: the type of the event
  843. * @depevt: Device Endpoint Event
  844. * @devt: Device Event
  845. * @gevt: Global Event
  846. */
  847. union dwc3_event {
  848. u32 raw;
  849. struct dwc3_event_type type;
  850. struct dwc3_event_depevt depevt;
  851. struct dwc3_event_devt devt;
  852. struct dwc3_event_gevt gevt;
  853. };
  854. /**
  855. * struct dwc3_gadget_ep_cmd_params - representation of endpoint command
  856. * parameters
  857. * @param2: third parameter
  858. * @param1: second parameter
  859. * @param0: first parameter
  860. */
  861. struct dwc3_gadget_ep_cmd_params {
  862. u32 param2;
  863. u32 param1;
  864. u32 param0;
  865. };
  866. /*
  867. * DWC3 Features to be used as Driver Data
  868. */
  869. #define DWC3_HAS_PERIPHERAL BIT(0)
  870. #define DWC3_HAS_XHCI BIT(1)
  871. #define DWC3_HAS_OTG BIT(3)
  872. /* prototypes */
  873. void dwc3_set_mode(struct dwc3 *dwc, u32 mode);
  874. int dwc3_gadget_resize_tx_fifos(struct dwc3 *dwc);
  875. #if IS_ENABLED(CONFIG_USB_DWC3_HOST) || IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
  876. int dwc3_host_init(struct dwc3 *dwc);
  877. void dwc3_host_exit(struct dwc3 *dwc);
  878. #else
  879. static inline int dwc3_host_init(struct dwc3 *dwc)
  880. { return 0; }
  881. static inline void dwc3_host_exit(struct dwc3 *dwc)
  882. { }
  883. #endif
  884. #if IS_ENABLED(CONFIG_USB_DWC3_GADGET) || IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
  885. int dwc3_gadget_init(struct dwc3 *dwc);
  886. void dwc3_gadget_exit(struct dwc3 *dwc);
  887. int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode);
  888. int dwc3_gadget_get_link_state(struct dwc3 *dwc);
  889. int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state);
  890. int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
  891. unsigned cmd, struct dwc3_gadget_ep_cmd_params *params);
  892. int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param);
  893. #else
  894. static inline int dwc3_gadget_init(struct dwc3 *dwc)
  895. { return 0; }
  896. static inline void dwc3_gadget_exit(struct dwc3 *dwc)
  897. { }
  898. static inline int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
  899. { return 0; }
  900. static inline int dwc3_gadget_get_link_state(struct dwc3 *dwc)
  901. { return 0; }
  902. static inline int dwc3_gadget_set_link_state(struct dwc3 *dwc,
  903. enum dwc3_link_state state)
  904. { return 0; }
  905. static inline int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
  906. unsigned cmd, struct dwc3_gadget_ep_cmd_params *params)
  907. { return 0; }
  908. static inline int dwc3_send_gadget_generic_command(struct dwc3 *dwc,
  909. int cmd, u32 param)
  910. { return 0; }
  911. #endif
  912. /* power management interface */
  913. #if !IS_ENABLED(CONFIG_USB_DWC3_HOST)
  914. int dwc3_gadget_suspend(struct dwc3 *dwc);
  915. int dwc3_gadget_resume(struct dwc3 *dwc);
  916. #else
  917. static inline int dwc3_gadget_suspend(struct dwc3 *dwc)
  918. {
  919. return 0;
  920. }
  921. static inline int dwc3_gadget_resume(struct dwc3 *dwc)
  922. {
  923. return 0;
  924. }
  925. #endif /* !IS_ENABLED(CONFIG_USB_DWC3_HOST) */
  926. #if IS_ENABLED(CONFIG_USB_DWC3_ULPI)
  927. int dwc3_ulpi_init(struct dwc3 *dwc);
  928. void dwc3_ulpi_exit(struct dwc3 *dwc);
  929. #else
  930. static inline int dwc3_ulpi_init(struct dwc3 *dwc)
  931. { return 0; }
  932. static inline void dwc3_ulpi_exit(struct dwc3 *dwc)
  933. { }
  934. #endif
  935. #endif /* __DRIVERS_USB_DWC3_CORE_H */