GNU Linux-libre 5.10.153-gnu1
[releases.git] / drivers / usb / dwc3 / core.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * core.h - DesignWare USB3 DRD Core Header
4  *
5  * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com
6  *
7  * Authors: Felipe Balbi <balbi@ti.com>,
8  *          Sebastian Andrzej Siewior <bigeasy@linutronix.de>
9  */
10
11 #ifndef __DRIVERS_USB_DWC3_CORE_H
12 #define __DRIVERS_USB_DWC3_CORE_H
13
14 #include <linux/device.h>
15 #include <linux/spinlock.h>
16 #include <linux/mutex.h>
17 #include <linux/ioport.h>
18 #include <linux/list.h>
19 #include <linux/bitops.h>
20 #include <linux/dma-mapping.h>
21 #include <linux/mm.h>
22 #include <linux/debugfs.h>
23 #include <linux/wait.h>
24 #include <linux/workqueue.h>
25
26 #include <linux/usb/ch9.h>
27 #include <linux/usb/gadget.h>
28 #include <linux/usb/otg.h>
29 #include <linux/usb/role.h>
30 #include <linux/ulpi/interface.h>
31
32 #include <linux/phy/phy.h>
33
34 #define DWC3_MSG_MAX    500
35
36 /* Global constants */
37 #define DWC3_PULL_UP_TIMEOUT    500     /* ms */
38 #define DWC3_BOUNCE_SIZE        1024    /* size of a superspeed bulk */
39 #define DWC3_EP0_SETUP_SIZE     512
40 #define DWC3_ENDPOINTS_NUM      32
41 #define DWC3_XHCI_RESOURCES_NUM 2
42 #define DWC3_ISOC_MAX_RETRIES   5
43
44 #define DWC3_SCRATCHBUF_SIZE    4096    /* each buffer is assumed to be 4KiB */
45 #define DWC3_EVENT_BUFFERS_SIZE 4096
46 #define DWC3_EVENT_TYPE_MASK    0xfe
47
48 #define DWC3_EVENT_TYPE_DEV     0
49 #define DWC3_EVENT_TYPE_CARKIT  3
50 #define DWC3_EVENT_TYPE_I2C     4
51
52 #define DWC3_DEVICE_EVENT_DISCONNECT            0
53 #define DWC3_DEVICE_EVENT_RESET                 1
54 #define DWC3_DEVICE_EVENT_CONNECT_DONE          2
55 #define DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE    3
56 #define DWC3_DEVICE_EVENT_WAKEUP                4
57 #define DWC3_DEVICE_EVENT_HIBER_REQ             5
58 #define DWC3_DEVICE_EVENT_EOPF                  6
59 #define DWC3_DEVICE_EVENT_SOF                   7
60 #define DWC3_DEVICE_EVENT_ERRATIC_ERROR         9
61 #define DWC3_DEVICE_EVENT_CMD_CMPL              10
62 #define DWC3_DEVICE_EVENT_OVERFLOW              11
63
64 /* Controller's role while using the OTG block */
65 #define DWC3_OTG_ROLE_IDLE      0
66 #define DWC3_OTG_ROLE_HOST      1
67 #define DWC3_OTG_ROLE_DEVICE    2
68
69 #define DWC3_GEVNTCOUNT_MASK    0xfffc
70 #define DWC3_GEVNTCOUNT_EHB     BIT(31)
71 #define DWC3_GSNPSID_MASK       0xffff0000
72 #define DWC3_GSNPSREV_MASK      0xffff
73 #define DWC3_GSNPS_ID(p)        (((p) & DWC3_GSNPSID_MASK) >> 16)
74
75 /* DWC3 registers memory space boundries */
76 #define DWC3_XHCI_REGS_START            0x0
77 #define DWC3_XHCI_REGS_END              0x7fff
78 #define DWC3_GLOBALS_REGS_START         0xc100
79 #define DWC3_GLOBALS_REGS_END           0xc6ff
80 #define DWC3_DEVICE_REGS_START          0xc700
81 #define DWC3_DEVICE_REGS_END            0xcbff
82 #define DWC3_OTG_REGS_START             0xcc00
83 #define DWC3_OTG_REGS_END               0xccff
84
85 /* Global Registers */
86 #define DWC3_GSBUSCFG0          0xc100
87 #define DWC3_GSBUSCFG1          0xc104
88 #define DWC3_GTXTHRCFG          0xc108
89 #define DWC3_GRXTHRCFG          0xc10c
90 #define DWC3_GCTL               0xc110
91 #define DWC3_GEVTEN             0xc114
92 #define DWC3_GSTS               0xc118
93 #define DWC3_GUCTL1             0xc11c
94 #define DWC3_GSNPSID            0xc120
95 #define DWC3_GGPIO              0xc124
96 #define DWC3_GUID               0xc128
97 #define DWC3_GUCTL              0xc12c
98 #define DWC3_GBUSERRADDR0       0xc130
99 #define DWC3_GBUSERRADDR1       0xc134
100 #define DWC3_GPRTBIMAP0         0xc138
101 #define DWC3_GPRTBIMAP1         0xc13c
102 #define DWC3_GHWPARAMS0         0xc140
103 #define DWC3_GHWPARAMS1         0xc144
104 #define DWC3_GHWPARAMS2         0xc148
105 #define DWC3_GHWPARAMS3         0xc14c
106 #define DWC3_GHWPARAMS4         0xc150
107 #define DWC3_GHWPARAMS5         0xc154
108 #define DWC3_GHWPARAMS6         0xc158
109 #define DWC3_GHWPARAMS7         0xc15c
110 #define DWC3_GDBGFIFOSPACE      0xc160
111 #define DWC3_GDBGLTSSM          0xc164
112 #define DWC3_GDBGBMU            0xc16c
113 #define DWC3_GDBGLSPMUX         0xc170
114 #define DWC3_GDBGLSP            0xc174
115 #define DWC3_GDBGEPINFO0        0xc178
116 #define DWC3_GDBGEPINFO1        0xc17c
117 #define DWC3_GPRTBIMAP_HS0      0xc180
118 #define DWC3_GPRTBIMAP_HS1      0xc184
119 #define DWC3_GPRTBIMAP_FS0      0xc188
120 #define DWC3_GPRTBIMAP_FS1      0xc18c
121 #define DWC3_GUCTL2             0xc19c
122
123 #define DWC3_VER_NUMBER         0xc1a0
124 #define DWC3_VER_TYPE           0xc1a4
125
126 #define DWC3_GUSB2PHYCFG(n)     (0xc200 + ((n) * 0x04))
127 #define DWC3_GUSB2I2CCTL(n)     (0xc240 + ((n) * 0x04))
128
129 #define DWC3_GUSB2PHYACC(n)     (0xc280 + ((n) * 0x04))
130
131 #define DWC3_GUSB3PIPECTL(n)    (0xc2c0 + ((n) * 0x04))
132
133 #define DWC3_GTXFIFOSIZ(n)      (0xc300 + ((n) * 0x04))
134 #define DWC3_GRXFIFOSIZ(n)      (0xc380 + ((n) * 0x04))
135
136 #define DWC3_GEVNTADRLO(n)      (0xc400 + ((n) * 0x10))
137 #define DWC3_GEVNTADRHI(n)      (0xc404 + ((n) * 0x10))
138 #define DWC3_GEVNTSIZ(n)        (0xc408 + ((n) * 0x10))
139 #define DWC3_GEVNTCOUNT(n)      (0xc40c + ((n) * 0x10))
140
141 #define DWC3_GHWPARAMS8         0xc600
142 #define DWC3_GUCTL3             0xc60c
143 #define DWC3_GFLADJ             0xc630
144
145 /* Device Registers */
146 #define DWC3_DCFG               0xc700
147 #define DWC3_DCTL               0xc704
148 #define DWC3_DEVTEN             0xc708
149 #define DWC3_DSTS               0xc70c
150 #define DWC3_DGCMDPAR           0xc710
151 #define DWC3_DGCMD              0xc714
152 #define DWC3_DALEPENA           0xc720
153
154 #define DWC3_DEP_BASE(n)        (0xc800 + ((n) * 0x10))
155 #define DWC3_DEPCMDPAR2         0x00
156 #define DWC3_DEPCMDPAR1         0x04
157 #define DWC3_DEPCMDPAR0         0x08
158 #define DWC3_DEPCMD             0x0c
159
160 #define DWC3_DEV_IMOD(n)        (0xca00 + ((n) * 0x4))
161
162 /* OTG Registers */
163 #define DWC3_OCFG               0xcc00
164 #define DWC3_OCTL               0xcc04
165 #define DWC3_OEVT               0xcc08
166 #define DWC3_OEVTEN             0xcc0C
167 #define DWC3_OSTS               0xcc10
168
169 /* Bit fields */
170
171 /* Global SoC Bus Configuration INCRx Register 0 */
172 #define DWC3_GSBUSCFG0_INCR256BRSTENA   (1 << 7) /* INCR256 burst */
173 #define DWC3_GSBUSCFG0_INCR128BRSTENA   (1 << 6) /* INCR128 burst */
174 #define DWC3_GSBUSCFG0_INCR64BRSTENA    (1 << 5) /* INCR64 burst */
175 #define DWC3_GSBUSCFG0_INCR32BRSTENA    (1 << 4) /* INCR32 burst */
176 #define DWC3_GSBUSCFG0_INCR16BRSTENA    (1 << 3) /* INCR16 burst */
177 #define DWC3_GSBUSCFG0_INCR8BRSTENA     (1 << 2) /* INCR8 burst */
178 #define DWC3_GSBUSCFG0_INCR4BRSTENA     (1 << 1) /* INCR4 burst */
179 #define DWC3_GSBUSCFG0_INCRBRSTENA      (1 << 0) /* undefined length enable */
180 #define DWC3_GSBUSCFG0_INCRBRST_MASK    0xff
181
182 /* Global Debug LSP MUX Select */
183 #define DWC3_GDBGLSPMUX_ENDBC           BIT(15) /* Host only */
184 #define DWC3_GDBGLSPMUX_HOSTSELECT(n)   ((n) & 0x3fff)
185 #define DWC3_GDBGLSPMUX_DEVSELECT(n)    (((n) & 0xf) << 4)
186 #define DWC3_GDBGLSPMUX_EPSELECT(n)     ((n) & 0xf)
187
188 /* Global Debug Queue/FIFO Space Available Register */
189 #define DWC3_GDBGFIFOSPACE_NUM(n)       ((n) & 0x1f)
190 #define DWC3_GDBGFIFOSPACE_TYPE(n)      (((n) << 5) & 0x1e0)
191 #define DWC3_GDBGFIFOSPACE_SPACE_AVAILABLE(n) (((n) >> 16) & 0xffff)
192
193 #define DWC3_TXFIFO             0
194 #define DWC3_RXFIFO             1
195 #define DWC3_TXREQQ             2
196 #define DWC3_RXREQQ             3
197 #define DWC3_RXINFOQ            4
198 #define DWC3_PSTATQ             5
199 #define DWC3_DESCFETCHQ         6
200 #define DWC3_EVENTQ             7
201 #define DWC3_AUXEVENTQ          8
202
203 /* Global RX Threshold Configuration Register */
204 #define DWC3_GRXTHRCFG_MAXRXBURSTSIZE(n) (((n) & 0x1f) << 19)
205 #define DWC3_GRXTHRCFG_RXPKTCNT(n) (((n) & 0xf) << 24)
206 #define DWC3_GRXTHRCFG_PKTCNTSEL BIT(29)
207
208 /* Global RX Threshold Configuration Register for DWC_usb31 only */
209 #define DWC31_GRXTHRCFG_MAXRXBURSTSIZE(n)       (((n) & 0x1f) << 16)
210 #define DWC31_GRXTHRCFG_RXPKTCNT(n)             (((n) & 0x1f) << 21)
211 #define DWC31_GRXTHRCFG_PKTCNTSEL               BIT(26)
212 #define DWC31_RXTHRNUMPKTSEL_HS_PRD             BIT(15)
213 #define DWC31_RXTHRNUMPKT_HS_PRD(n)             (((n) & 0x3) << 13)
214 #define DWC31_RXTHRNUMPKTSEL_PRD                BIT(10)
215 #define DWC31_RXTHRNUMPKT_PRD(n)                (((n) & 0x1f) << 5)
216 #define DWC31_MAXRXBURSTSIZE_PRD(n)             ((n) & 0x1f)
217
218 /* Global TX Threshold Configuration Register for DWC_usb31 only */
219 #define DWC31_GTXTHRCFG_MAXTXBURSTSIZE(n)       (((n) & 0x1f) << 16)
220 #define DWC31_GTXTHRCFG_TXPKTCNT(n)             (((n) & 0x1f) << 21)
221 #define DWC31_GTXTHRCFG_PKTCNTSEL               BIT(26)
222 #define DWC31_TXTHRNUMPKTSEL_HS_PRD             BIT(15)
223 #define DWC31_TXTHRNUMPKT_HS_PRD(n)             (((n) & 0x3) << 13)
224 #define DWC31_TXTHRNUMPKTSEL_PRD                BIT(10)
225 #define DWC31_TXTHRNUMPKT_PRD(n)                (((n) & 0x1f) << 5)
226 #define DWC31_MAXTXBURSTSIZE_PRD(n)             ((n) & 0x1f)
227
228 /* Global Configuration Register */
229 #define DWC3_GCTL_PWRDNSCALE(n) ((n) << 19)
230 #define DWC3_GCTL_U2RSTECN      BIT(16)
231 #define DWC3_GCTL_RAMCLKSEL(x)  (((x) & DWC3_GCTL_CLK_MASK) << 6)
232 #define DWC3_GCTL_CLK_BUS       (0)
233 #define DWC3_GCTL_CLK_PIPE      (1)
234 #define DWC3_GCTL_CLK_PIPEHALF  (2)
235 #define DWC3_GCTL_CLK_MASK      (3)
236
237 #define DWC3_GCTL_PRTCAP(n)     (((n) & (3 << 12)) >> 12)
238 #define DWC3_GCTL_PRTCAPDIR(n)  ((n) << 12)
239 #define DWC3_GCTL_PRTCAP_HOST   1
240 #define DWC3_GCTL_PRTCAP_DEVICE 2
241 #define DWC3_GCTL_PRTCAP_OTG    3
242
243 #define DWC3_GCTL_CORESOFTRESET         BIT(11)
244 #define DWC3_GCTL_SOFITPSYNC            BIT(10)
245 #define DWC3_GCTL_SCALEDOWN(n)          ((n) << 4)
246 #define DWC3_GCTL_SCALEDOWN_MASK        DWC3_GCTL_SCALEDOWN(3)
247 #define DWC3_GCTL_DISSCRAMBLE           BIT(3)
248 #define DWC3_GCTL_U2EXIT_LFPS           BIT(2)
249 #define DWC3_GCTL_GBLHIBERNATIONEN      BIT(1)
250 #define DWC3_GCTL_DSBLCLKGTNG           BIT(0)
251
252 /* Global User Control Register */
253 #define DWC3_GUCTL_HSTINAUTORETRY       BIT(14)
254
255 /* Global User Control 1 Register */
256 #define DWC3_GUCTL1_PARKMODE_DISABLE_SS BIT(17)
257 #define DWC3_GUCTL1_TX_IPGAP_LINECHECK_DIS      BIT(28)
258 #define DWC3_GUCTL1_DEV_L1_EXIT_BY_HW   BIT(24)
259
260 /* Global Status Register */
261 #define DWC3_GSTS_OTG_IP        BIT(10)
262 #define DWC3_GSTS_BC_IP         BIT(9)
263 #define DWC3_GSTS_ADP_IP        BIT(8)
264 #define DWC3_GSTS_HOST_IP       BIT(7)
265 #define DWC3_GSTS_DEVICE_IP     BIT(6)
266 #define DWC3_GSTS_CSR_TIMEOUT   BIT(5)
267 #define DWC3_GSTS_BUS_ERR_ADDR_VLD      BIT(4)
268 #define DWC3_GSTS_CURMOD(n)     ((n) & 0x3)
269 #define DWC3_GSTS_CURMOD_DEVICE 0
270 #define DWC3_GSTS_CURMOD_HOST   1
271
272 /* Global USB2 PHY Configuration Register */
273 #define DWC3_GUSB2PHYCFG_PHYSOFTRST     BIT(31)
274 #define DWC3_GUSB2PHYCFG_U2_FREECLK_EXISTS      BIT(30)
275 #define DWC3_GUSB2PHYCFG_SUSPHY         BIT(6)
276 #define DWC3_GUSB2PHYCFG_ULPI_UTMI      BIT(4)
277 #define DWC3_GUSB2PHYCFG_ENBLSLPM       BIT(8)
278 #define DWC3_GUSB2PHYCFG_PHYIF(n)       (n << 3)
279 #define DWC3_GUSB2PHYCFG_PHYIF_MASK     DWC3_GUSB2PHYCFG_PHYIF(1)
280 #define DWC3_GUSB2PHYCFG_USBTRDTIM(n)   (n << 10)
281 #define DWC3_GUSB2PHYCFG_USBTRDTIM_MASK DWC3_GUSB2PHYCFG_USBTRDTIM(0xf)
282 #define USBTRDTIM_UTMI_8_BIT            9
283 #define USBTRDTIM_UTMI_16_BIT           5
284 #define UTMI_PHYIF_16_BIT               1
285 #define UTMI_PHYIF_8_BIT                0
286
287 /* Global USB2 PHY Vendor Control Register */
288 #define DWC3_GUSB2PHYACC_NEWREGREQ      BIT(25)
289 #define DWC3_GUSB2PHYACC_DONE           BIT(24)
290 #define DWC3_GUSB2PHYACC_BUSY           BIT(23)
291 #define DWC3_GUSB2PHYACC_WRITE          BIT(22)
292 #define DWC3_GUSB2PHYACC_ADDR(n)        (n << 16)
293 #define DWC3_GUSB2PHYACC_EXTEND_ADDR(n) (n << 8)
294 #define DWC3_GUSB2PHYACC_DATA(n)        (n & 0xff)
295
296 /* Global USB3 PIPE Control Register */
297 #define DWC3_GUSB3PIPECTL_PHYSOFTRST    BIT(31)
298 #define DWC3_GUSB3PIPECTL_U2SSINP3OK    BIT(29)
299 #define DWC3_GUSB3PIPECTL_DISRXDETINP3  BIT(28)
300 #define DWC3_GUSB3PIPECTL_UX_EXIT_PX    BIT(27)
301 #define DWC3_GUSB3PIPECTL_REQP1P2P3     BIT(24)
302 #define DWC3_GUSB3PIPECTL_DEP1P2P3(n)   ((n) << 19)
303 #define DWC3_GUSB3PIPECTL_DEP1P2P3_MASK DWC3_GUSB3PIPECTL_DEP1P2P3(7)
304 #define DWC3_GUSB3PIPECTL_DEP1P2P3_EN   DWC3_GUSB3PIPECTL_DEP1P2P3(1)
305 #define DWC3_GUSB3PIPECTL_DEPOCHANGE    BIT(18)
306 #define DWC3_GUSB3PIPECTL_SUSPHY        BIT(17)
307 #define DWC3_GUSB3PIPECTL_LFPSFILT      BIT(9)
308 #define DWC3_GUSB3PIPECTL_RX_DETOPOLL   BIT(8)
309 #define DWC3_GUSB3PIPECTL_TX_DEEPH_MASK DWC3_GUSB3PIPECTL_TX_DEEPH(3)
310 #define DWC3_GUSB3PIPECTL_TX_DEEPH(n)   ((n) << 1)
311
312 /* Global TX Fifo Size Register */
313 #define DWC31_GTXFIFOSIZ_TXFRAMNUM      BIT(15)         /* DWC_usb31 only */
314 #define DWC31_GTXFIFOSIZ_TXFDEP(n)      ((n) & 0x7fff)  /* DWC_usb31 only */
315 #define DWC3_GTXFIFOSIZ_TXFDEP(n)       ((n) & 0xffff)
316 #define DWC3_GTXFIFOSIZ_TXFSTADDR(n)    ((n) & 0xffff0000)
317
318 /* Global RX Fifo Size Register */
319 #define DWC31_GRXFIFOSIZ_RXFDEP(n)      ((n) & 0x7fff)  /* DWC_usb31 only */
320 #define DWC3_GRXFIFOSIZ_RXFDEP(n)       ((n) & 0xffff)
321
322 /* Global Event Size Registers */
323 #define DWC3_GEVNTSIZ_INTMASK           BIT(31)
324 #define DWC3_GEVNTSIZ_SIZE(n)           ((n) & 0xffff)
325
326 /* Global HWPARAMS0 Register */
327 #define DWC3_GHWPARAMS0_MODE(n)         ((n) & 0x3)
328 #define DWC3_GHWPARAMS0_MODE_GADGET     0
329 #define DWC3_GHWPARAMS0_MODE_HOST       1
330 #define DWC3_GHWPARAMS0_MODE_DRD        2
331 #define DWC3_GHWPARAMS0_MBUS_TYPE(n)    (((n) >> 3) & 0x7)
332 #define DWC3_GHWPARAMS0_SBUS_TYPE(n)    (((n) >> 6) & 0x3)
333 #define DWC3_GHWPARAMS0_MDWIDTH(n)      (((n) >> 8) & 0xff)
334 #define DWC3_GHWPARAMS0_SDWIDTH(n)      (((n) >> 16) & 0xff)
335 #define DWC3_GHWPARAMS0_AWIDTH(n)       (((n) >> 24) & 0xff)
336
337 /* Global HWPARAMS1 Register */
338 #define DWC3_GHWPARAMS1_EN_PWROPT(n)    (((n) & (3 << 24)) >> 24)
339 #define DWC3_GHWPARAMS1_EN_PWROPT_NO    0
340 #define DWC3_GHWPARAMS1_EN_PWROPT_CLK   1
341 #define DWC3_GHWPARAMS1_EN_PWROPT_HIB   2
342 #define DWC3_GHWPARAMS1_PWROPT(n)       ((n) << 24)
343 #define DWC3_GHWPARAMS1_PWROPT_MASK     DWC3_GHWPARAMS1_PWROPT(3)
344 #define DWC3_GHWPARAMS1_ENDBC           BIT(31)
345
346 /* Global HWPARAMS3 Register */
347 #define DWC3_GHWPARAMS3_SSPHY_IFC(n)            ((n) & 3)
348 #define DWC3_GHWPARAMS3_SSPHY_IFC_DIS           0
349 #define DWC3_GHWPARAMS3_SSPHY_IFC_GEN1          1
350 #define DWC3_GHWPARAMS3_SSPHY_IFC_GEN2          2 /* DWC_usb31 only */
351 #define DWC3_GHWPARAMS3_HSPHY_IFC(n)            (((n) & (3 << 2)) >> 2)
352 #define DWC3_GHWPARAMS3_HSPHY_IFC_DIS           0
353 #define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI          1
354 #define DWC3_GHWPARAMS3_HSPHY_IFC_ULPI          2
355 #define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI_ULPI     3
356 #define DWC3_GHWPARAMS3_FSPHY_IFC(n)            (((n) & (3 << 4)) >> 4)
357 #define DWC3_GHWPARAMS3_FSPHY_IFC_DIS           0
358 #define DWC3_GHWPARAMS3_FSPHY_IFC_ENA           1
359
360 /* Global HWPARAMS4 Register */
361 #define DWC3_GHWPARAMS4_HIBER_SCRATCHBUFS(n)    (((n) & (0x0f << 13)) >> 13)
362 #define DWC3_MAX_HIBER_SCRATCHBUFS              15
363
364 /* Global HWPARAMS6 Register */
365 #define DWC3_GHWPARAMS6_BCSUPPORT               BIT(14)
366 #define DWC3_GHWPARAMS6_OTG3SUPPORT             BIT(13)
367 #define DWC3_GHWPARAMS6_ADPSUPPORT              BIT(12)
368 #define DWC3_GHWPARAMS6_HNPSUPPORT              BIT(11)
369 #define DWC3_GHWPARAMS6_SRPSUPPORT              BIT(10)
370 #define DWC3_GHWPARAMS6_EN_FPGA                 BIT(7)
371
372 /* DWC_usb32 only */
373 #define DWC3_GHWPARAMS6_MDWIDTH(n)              ((n) & (0x3 << 8))
374
375 /* Global HWPARAMS7 Register */
376 #define DWC3_GHWPARAMS7_RAM1_DEPTH(n)   ((n) & 0xffff)
377 #define DWC3_GHWPARAMS7_RAM2_DEPTH(n)   (((n) >> 16) & 0xffff)
378
379 /* Global Frame Length Adjustment Register */
380 #define DWC3_GFLADJ_30MHZ_SDBND_SEL             BIT(7)
381 #define DWC3_GFLADJ_30MHZ_MASK                  0x3f
382
383 /* Global User Control Register 2 */
384 #define DWC3_GUCTL2_RST_ACTBITLATER             BIT(14)
385
386 /* Global User Control Register 3 */
387 #define DWC3_GUCTL3_SPLITDISABLE                BIT(14)
388
389 /* Device Configuration Register */
390 #define DWC3_DCFG_DEVADDR(addr) ((addr) << 3)
391 #define DWC3_DCFG_DEVADDR_MASK  DWC3_DCFG_DEVADDR(0x7f)
392
393 #define DWC3_DCFG_SPEED_MASK    (7 << 0)
394 #define DWC3_DCFG_SUPERSPEED_PLUS (5 << 0)  /* DWC_usb31 only */
395 #define DWC3_DCFG_SUPERSPEED    (4 << 0)
396 #define DWC3_DCFG_HIGHSPEED     (0 << 0)
397 #define DWC3_DCFG_FULLSPEED     BIT(0)
398 #define DWC3_DCFG_LOWSPEED      (2 << 0)
399
400 #define DWC3_DCFG_NUMP_SHIFT    17
401 #define DWC3_DCFG_NUMP(n)       (((n) >> DWC3_DCFG_NUMP_SHIFT) & 0x1f)
402 #define DWC3_DCFG_NUMP_MASK     (0x1f << DWC3_DCFG_NUMP_SHIFT)
403 #define DWC3_DCFG_LPM_CAP       BIT(22)
404
405 /* Device Control Register */
406 #define DWC3_DCTL_RUN_STOP      BIT(31)
407 #define DWC3_DCTL_CSFTRST       BIT(30)
408 #define DWC3_DCTL_LSFTRST       BIT(29)
409
410 #define DWC3_DCTL_HIRD_THRES_MASK       (0x1f << 24)
411 #define DWC3_DCTL_HIRD_THRES(n) ((n) << 24)
412
413 #define DWC3_DCTL_APPL1RES      BIT(23)
414
415 /* These apply for core versions 1.87a and earlier */
416 #define DWC3_DCTL_TRGTULST_MASK         (0x0f << 17)
417 #define DWC3_DCTL_TRGTULST(n)           ((n) << 17)
418 #define DWC3_DCTL_TRGTULST_U2           (DWC3_DCTL_TRGTULST(2))
419 #define DWC3_DCTL_TRGTULST_U3           (DWC3_DCTL_TRGTULST(3))
420 #define DWC3_DCTL_TRGTULST_SS_DIS       (DWC3_DCTL_TRGTULST(4))
421 #define DWC3_DCTL_TRGTULST_RX_DET       (DWC3_DCTL_TRGTULST(5))
422 #define DWC3_DCTL_TRGTULST_SS_INACT     (DWC3_DCTL_TRGTULST(6))
423
424 /* These apply for core versions 1.94a and later */
425 #define DWC3_DCTL_NYET_THRES(n)         (((n) & 0xf) << 20)
426
427 #define DWC3_DCTL_KEEP_CONNECT          BIT(19)
428 #define DWC3_DCTL_L1_HIBER_EN           BIT(18)
429 #define DWC3_DCTL_CRS                   BIT(17)
430 #define DWC3_DCTL_CSS                   BIT(16)
431
432 #define DWC3_DCTL_INITU2ENA             BIT(12)
433 #define DWC3_DCTL_ACCEPTU2ENA           BIT(11)
434 #define DWC3_DCTL_INITU1ENA             BIT(10)
435 #define DWC3_DCTL_ACCEPTU1ENA           BIT(9)
436 #define DWC3_DCTL_TSTCTRL_MASK          (0xf << 1)
437
438 #define DWC3_DCTL_ULSTCHNGREQ_MASK      (0x0f << 5)
439 #define DWC3_DCTL_ULSTCHNGREQ(n) (((n) << 5) & DWC3_DCTL_ULSTCHNGREQ_MASK)
440
441 #define DWC3_DCTL_ULSTCHNG_NO_ACTION    (DWC3_DCTL_ULSTCHNGREQ(0))
442 #define DWC3_DCTL_ULSTCHNG_SS_DISABLED  (DWC3_DCTL_ULSTCHNGREQ(4))
443 #define DWC3_DCTL_ULSTCHNG_RX_DETECT    (DWC3_DCTL_ULSTCHNGREQ(5))
444 #define DWC3_DCTL_ULSTCHNG_SS_INACTIVE  (DWC3_DCTL_ULSTCHNGREQ(6))
445 #define DWC3_DCTL_ULSTCHNG_RECOVERY     (DWC3_DCTL_ULSTCHNGREQ(8))
446 #define DWC3_DCTL_ULSTCHNG_COMPLIANCE   (DWC3_DCTL_ULSTCHNGREQ(10))
447 #define DWC3_DCTL_ULSTCHNG_LOOPBACK     (DWC3_DCTL_ULSTCHNGREQ(11))
448
449 /* Device Event Enable Register */
450 #define DWC3_DEVTEN_VNDRDEVTSTRCVEDEN   BIT(12)
451 #define DWC3_DEVTEN_EVNTOVERFLOWEN      BIT(11)
452 #define DWC3_DEVTEN_CMDCMPLTEN          BIT(10)
453 #define DWC3_DEVTEN_ERRTICERREN         BIT(9)
454 #define DWC3_DEVTEN_SOFEN               BIT(7)
455 #define DWC3_DEVTEN_EOPFEN              BIT(6)
456 #define DWC3_DEVTEN_HIBERNATIONREQEVTEN BIT(5)
457 #define DWC3_DEVTEN_WKUPEVTEN           BIT(4)
458 #define DWC3_DEVTEN_ULSTCNGEN           BIT(3)
459 #define DWC3_DEVTEN_CONNECTDONEEN       BIT(2)
460 #define DWC3_DEVTEN_USBRSTEN            BIT(1)
461 #define DWC3_DEVTEN_DISCONNEVTEN        BIT(0)
462
463 /* Device Status Register */
464 #define DWC3_DSTS_DCNRD                 BIT(29)
465
466 /* This applies for core versions 1.87a and earlier */
467 #define DWC3_DSTS_PWRUPREQ              BIT(24)
468
469 /* These apply for core versions 1.94a and later */
470 #define DWC3_DSTS_RSS                   BIT(25)
471 #define DWC3_DSTS_SSS                   BIT(24)
472
473 #define DWC3_DSTS_COREIDLE              BIT(23)
474 #define DWC3_DSTS_DEVCTRLHLT            BIT(22)
475
476 #define DWC3_DSTS_USBLNKST_MASK         (0x0f << 18)
477 #define DWC3_DSTS_USBLNKST(n)           (((n) & DWC3_DSTS_USBLNKST_MASK) >> 18)
478
479 #define DWC3_DSTS_RXFIFOEMPTY           BIT(17)
480
481 #define DWC3_DSTS_SOFFN_MASK            (0x3fff << 3)
482 #define DWC3_DSTS_SOFFN(n)              (((n) & DWC3_DSTS_SOFFN_MASK) >> 3)
483
484 #define DWC3_DSTS_CONNECTSPD            (7 << 0)
485
486 #define DWC3_DSTS_SUPERSPEED_PLUS       (5 << 0) /* DWC_usb31 only */
487 #define DWC3_DSTS_SUPERSPEED            (4 << 0)
488 #define DWC3_DSTS_HIGHSPEED             (0 << 0)
489 #define DWC3_DSTS_FULLSPEED             BIT(0)
490 #define DWC3_DSTS_LOWSPEED              (2 << 0)
491
492 /* Device Generic Command Register */
493 #define DWC3_DGCMD_SET_LMP              0x01
494 #define DWC3_DGCMD_SET_PERIODIC_PAR     0x02
495 #define DWC3_DGCMD_XMIT_FUNCTION        0x03
496
497 /* These apply for core versions 1.94a and later */
498 #define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO       0x04
499 #define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI       0x05
500
501 #define DWC3_DGCMD_SELECTED_FIFO_FLUSH  0x09
502 #define DWC3_DGCMD_ALL_FIFO_FLUSH       0x0a
503 #define DWC3_DGCMD_SET_ENDPOINT_NRDY    0x0c
504 #define DWC3_DGCMD_SET_ENDPOINT_PRIME   0x0d
505 #define DWC3_DGCMD_RUN_SOC_BUS_LOOPBACK 0x10
506
507 #define DWC3_DGCMD_STATUS(n)            (((n) >> 12) & 0x0F)
508 #define DWC3_DGCMD_CMDACT               BIT(10)
509 #define DWC3_DGCMD_CMDIOC               BIT(8)
510
511 /* Device Generic Command Parameter Register */
512 #define DWC3_DGCMDPAR_FORCE_LINKPM_ACCEPT       BIT(0)
513 #define DWC3_DGCMDPAR_FIFO_NUM(n)               ((n) << 0)
514 #define DWC3_DGCMDPAR_RX_FIFO                   (0 << 5)
515 #define DWC3_DGCMDPAR_TX_FIFO                   BIT(5)
516 #define DWC3_DGCMDPAR_LOOPBACK_DIS              (0 << 0)
517 #define DWC3_DGCMDPAR_LOOPBACK_ENA              BIT(0)
518
519 /* Device Endpoint Command Register */
520 #define DWC3_DEPCMD_PARAM_SHIFT         16
521 #define DWC3_DEPCMD_PARAM(x)            ((x) << DWC3_DEPCMD_PARAM_SHIFT)
522 #define DWC3_DEPCMD_GET_RSC_IDX(x)      (((x) >> DWC3_DEPCMD_PARAM_SHIFT) & 0x7f)
523 #define DWC3_DEPCMD_STATUS(x)           (((x) >> 12) & 0x0F)
524 #define DWC3_DEPCMD_HIPRI_FORCERM       BIT(11)
525 #define DWC3_DEPCMD_CLEARPENDIN         BIT(11)
526 #define DWC3_DEPCMD_CMDACT              BIT(10)
527 #define DWC3_DEPCMD_CMDIOC              BIT(8)
528
529 #define DWC3_DEPCMD_DEPSTARTCFG         (0x09 << 0)
530 #define DWC3_DEPCMD_ENDTRANSFER         (0x08 << 0)
531 #define DWC3_DEPCMD_UPDATETRANSFER      (0x07 << 0)
532 #define DWC3_DEPCMD_STARTTRANSFER       (0x06 << 0)
533 #define DWC3_DEPCMD_CLEARSTALL          (0x05 << 0)
534 #define DWC3_DEPCMD_SETSTALL            (0x04 << 0)
535 /* This applies for core versions 1.90a and earlier */
536 #define DWC3_DEPCMD_GETSEQNUMBER        (0x03 << 0)
537 /* This applies for core versions 1.94a and later */
538 #define DWC3_DEPCMD_GETEPSTATE          (0x03 << 0)
539 #define DWC3_DEPCMD_SETTRANSFRESOURCE   (0x02 << 0)
540 #define DWC3_DEPCMD_SETEPCONFIG         (0x01 << 0)
541
542 #define DWC3_DEPCMD_CMD(x)              ((x) & 0xf)
543
544 /* The EP number goes 0..31 so ep0 is always out and ep1 is always in */
545 #define DWC3_DALEPENA_EP(n)             BIT(n)
546
547 #define DWC3_DEPCMD_TYPE_CONTROL        0
548 #define DWC3_DEPCMD_TYPE_ISOC           1
549 #define DWC3_DEPCMD_TYPE_BULK           2
550 #define DWC3_DEPCMD_TYPE_INTR           3
551
552 #define DWC3_DEV_IMOD_COUNT_SHIFT       16
553 #define DWC3_DEV_IMOD_COUNT_MASK        (0xffff << 16)
554 #define DWC3_DEV_IMOD_INTERVAL_SHIFT    0
555 #define DWC3_DEV_IMOD_INTERVAL_MASK     (0xffff << 0)
556
557 /* OTG Configuration Register */
558 #define DWC3_OCFG_DISPWRCUTTOFF         BIT(5)
559 #define DWC3_OCFG_HIBDISMASK            BIT(4)
560 #define DWC3_OCFG_SFTRSTMASK            BIT(3)
561 #define DWC3_OCFG_OTGVERSION            BIT(2)
562 #define DWC3_OCFG_HNPCAP                BIT(1)
563 #define DWC3_OCFG_SRPCAP                BIT(0)
564
565 /* OTG CTL Register */
566 #define DWC3_OCTL_OTG3GOERR             BIT(7)
567 #define DWC3_OCTL_PERIMODE              BIT(6)
568 #define DWC3_OCTL_PRTPWRCTL             BIT(5)
569 #define DWC3_OCTL_HNPREQ                BIT(4)
570 #define DWC3_OCTL_SESREQ                BIT(3)
571 #define DWC3_OCTL_TERMSELIDPULSE        BIT(2)
572 #define DWC3_OCTL_DEVSETHNPEN           BIT(1)
573 #define DWC3_OCTL_HSTSETHNPEN           BIT(0)
574
575 /* OTG Event Register */
576 #define DWC3_OEVT_DEVICEMODE            BIT(31)
577 #define DWC3_OEVT_XHCIRUNSTPSET         BIT(27)
578 #define DWC3_OEVT_DEVRUNSTPSET          BIT(26)
579 #define DWC3_OEVT_HIBENTRY              BIT(25)
580 #define DWC3_OEVT_CONIDSTSCHNG          BIT(24)
581 #define DWC3_OEVT_HRRCONFNOTIF          BIT(23)
582 #define DWC3_OEVT_HRRINITNOTIF          BIT(22)
583 #define DWC3_OEVT_ADEVIDLE              BIT(21)
584 #define DWC3_OEVT_ADEVBHOSTEND          BIT(20)
585 #define DWC3_OEVT_ADEVHOST              BIT(19)
586 #define DWC3_OEVT_ADEVHNPCHNG           BIT(18)
587 #define DWC3_OEVT_ADEVSRPDET            BIT(17)
588 #define DWC3_OEVT_ADEVSESSENDDET        BIT(16)
589 #define DWC3_OEVT_BDEVBHOSTEND          BIT(11)
590 #define DWC3_OEVT_BDEVHNPCHNG           BIT(10)
591 #define DWC3_OEVT_BDEVSESSVLDDET        BIT(9)
592 #define DWC3_OEVT_BDEVVBUSCHNG          BIT(8)
593 #define DWC3_OEVT_BSESSVLD              BIT(3)
594 #define DWC3_OEVT_HSTNEGSTS             BIT(2)
595 #define DWC3_OEVT_SESREQSTS             BIT(1)
596 #define DWC3_OEVT_ERROR                 BIT(0)
597
598 /* OTG Event Enable Register */
599 #define DWC3_OEVTEN_XHCIRUNSTPSETEN     BIT(27)
600 #define DWC3_OEVTEN_DEVRUNSTPSETEN      BIT(26)
601 #define DWC3_OEVTEN_HIBENTRYEN          BIT(25)
602 #define DWC3_OEVTEN_CONIDSTSCHNGEN      BIT(24)
603 #define DWC3_OEVTEN_HRRCONFNOTIFEN      BIT(23)
604 #define DWC3_OEVTEN_HRRINITNOTIFEN      BIT(22)
605 #define DWC3_OEVTEN_ADEVIDLEEN          BIT(21)
606 #define DWC3_OEVTEN_ADEVBHOSTENDEN      BIT(20)
607 #define DWC3_OEVTEN_ADEVHOSTEN          BIT(19)
608 #define DWC3_OEVTEN_ADEVHNPCHNGEN       BIT(18)
609 #define DWC3_OEVTEN_ADEVSRPDETEN        BIT(17)
610 #define DWC3_OEVTEN_ADEVSESSENDDETEN    BIT(16)
611 #define DWC3_OEVTEN_BDEVBHOSTENDEN      BIT(11)
612 #define DWC3_OEVTEN_BDEVHNPCHNGEN       BIT(10)
613 #define DWC3_OEVTEN_BDEVSESSVLDDETEN    BIT(9)
614 #define DWC3_OEVTEN_BDEVVBUSCHNGEN      BIT(8)
615
616 /* OTG Status Register */
617 #define DWC3_OSTS_DEVRUNSTP             BIT(13)
618 #define DWC3_OSTS_XHCIRUNSTP            BIT(12)
619 #define DWC3_OSTS_PERIPHERALSTATE       BIT(4)
620 #define DWC3_OSTS_XHCIPRTPOWER          BIT(3)
621 #define DWC3_OSTS_BSESVLD               BIT(2)
622 #define DWC3_OSTS_VBUSVLD               BIT(1)
623 #define DWC3_OSTS_CONIDSTS              BIT(0)
624
625 /* Structures */
626
627 struct dwc3_trb;
628
629 /**
630  * struct dwc3_event_buffer - Software event buffer representation
631  * @buf: _THE_ buffer
632  * @cache: The buffer cache used in the threaded interrupt
633  * @length: size of this buffer
634  * @lpos: event offset
635  * @count: cache of last read event count register
636  * @flags: flags related to this event buffer
637  * @dma: dma_addr_t
638  * @dwc: pointer to DWC controller
639  */
640 struct dwc3_event_buffer {
641         void                    *buf;
642         void                    *cache;
643         unsigned int            length;
644         unsigned int            lpos;
645         unsigned int            count;
646         unsigned int            flags;
647
648 #define DWC3_EVENT_PENDING      BIT(0)
649
650         dma_addr_t              dma;
651
652         struct dwc3             *dwc;
653 };
654
655 #define DWC3_EP_FLAG_STALLED    BIT(0)
656 #define DWC3_EP_FLAG_WEDGED     BIT(1)
657
658 #define DWC3_EP_DIRECTION_TX    true
659 #define DWC3_EP_DIRECTION_RX    false
660
661 #define DWC3_TRB_NUM            256
662
663 /**
664  * struct dwc3_ep - device side endpoint representation
665  * @endpoint: usb endpoint
666  * @cancelled_list: list of cancelled requests for this endpoint
667  * @pending_list: list of pending requests for this endpoint
668  * @started_list: list of started requests on this endpoint
669  * @regs: pointer to first endpoint register
670  * @trb_pool: array of transaction buffers
671  * @trb_pool_dma: dma address of @trb_pool
672  * @trb_enqueue: enqueue 'pointer' into TRB array
673  * @trb_dequeue: dequeue 'pointer' into TRB array
674  * @dwc: pointer to DWC controller
675  * @saved_state: ep state saved during hibernation
676  * @flags: endpoint flags (wedged, stalled, ...)
677  * @number: endpoint number (1 - 15)
678  * @type: set to bmAttributes & USB_ENDPOINT_XFERTYPE_MASK
679  * @resource_index: Resource transfer index
680  * @frame_number: set to the frame number we want this transfer to start (ISOC)
681  * @interval: the interval on which the ISOC transfer is started
682  * @name: a human readable name e.g. ep1out-bulk
683  * @direction: true for TX, false for RX
684  * @stream_capable: true when streams are enabled
685  * @combo_num: the test combination BIT[15:14] of the frame number to test
686  *              isochronous START TRANSFER command failure workaround
687  * @start_cmd_status: the status of testing START TRANSFER command with
688  *              combo_num = 'b00
689  */
690 struct dwc3_ep {
691         struct usb_ep           endpoint;
692         struct list_head        cancelled_list;
693         struct list_head        pending_list;
694         struct list_head        started_list;
695
696         void __iomem            *regs;
697
698         struct dwc3_trb         *trb_pool;
699         dma_addr_t              trb_pool_dma;
700         struct dwc3             *dwc;
701
702         u32                     saved_state;
703         unsigned int            flags;
704 #define DWC3_EP_ENABLED         BIT(0)
705 #define DWC3_EP_STALL           BIT(1)
706 #define DWC3_EP_WEDGE           BIT(2)
707 #define DWC3_EP_TRANSFER_STARTED BIT(3)
708 #define DWC3_EP_END_TRANSFER_PENDING BIT(4)
709 #define DWC3_EP_PENDING_REQUEST BIT(5)
710 #define DWC3_EP_DELAY_START     BIT(6)
711 #define DWC3_EP_WAIT_TRANSFER_COMPLETE  BIT(7)
712 #define DWC3_EP_IGNORE_NEXT_NOSTREAM    BIT(8)
713 #define DWC3_EP_FORCE_RESTART_STREAM    BIT(9)
714 #define DWC3_EP_FIRST_STREAM_PRIMED     BIT(10)
715 #define DWC3_EP_PENDING_CLEAR_STALL     BIT(11)
716
717         /* This last one is specific to EP0 */
718 #define DWC3_EP0_DIR_IN         BIT(31)
719
720         /*
721          * IMPORTANT: we *know* we have 256 TRBs in our @trb_pool, so we will
722          * use a u8 type here. If anybody decides to increase number of TRBs to
723          * anything larger than 256 - I can't see why people would want to do
724          * this though - then this type needs to be changed.
725          *
726          * By using u8 types we ensure that our % operator when incrementing
727          * enqueue and dequeue get optimized away by the compiler.
728          */
729         u8                      trb_enqueue;
730         u8                      trb_dequeue;
731
732         u8                      number;
733         u8                      type;
734         u8                      resource_index;
735         u32                     frame_number;
736         u32                     interval;
737
738         char                    name[20];
739
740         unsigned                direction:1;
741         unsigned                stream_capable:1;
742
743         /* For isochronous START TRANSFER workaround only */
744         u8                      combo_num;
745         int                     start_cmd_status;
746 };
747
748 enum dwc3_phy {
749         DWC3_PHY_UNKNOWN = 0,
750         DWC3_PHY_USB3,
751         DWC3_PHY_USB2,
752 };
753
754 enum dwc3_ep0_next {
755         DWC3_EP0_UNKNOWN = 0,
756         DWC3_EP0_COMPLETE,
757         DWC3_EP0_NRDY_DATA,
758         DWC3_EP0_NRDY_STATUS,
759 };
760
761 enum dwc3_ep0_state {
762         EP0_UNCONNECTED         = 0,
763         EP0_SETUP_PHASE,
764         EP0_DATA_PHASE,
765         EP0_STATUS_PHASE,
766 };
767
768 enum dwc3_link_state {
769         /* In SuperSpeed */
770         DWC3_LINK_STATE_U0              = 0x00, /* in HS, means ON */
771         DWC3_LINK_STATE_U1              = 0x01,
772         DWC3_LINK_STATE_U2              = 0x02, /* in HS, means SLEEP */
773         DWC3_LINK_STATE_U3              = 0x03, /* in HS, means SUSPEND */
774         DWC3_LINK_STATE_SS_DIS          = 0x04,
775         DWC3_LINK_STATE_RX_DET          = 0x05, /* in HS, means Early Suspend */
776         DWC3_LINK_STATE_SS_INACT        = 0x06,
777         DWC3_LINK_STATE_POLL            = 0x07,
778         DWC3_LINK_STATE_RECOV           = 0x08,
779         DWC3_LINK_STATE_HRESET          = 0x09,
780         DWC3_LINK_STATE_CMPLY           = 0x0a,
781         DWC3_LINK_STATE_LPBK            = 0x0b,
782         DWC3_LINK_STATE_RESET           = 0x0e,
783         DWC3_LINK_STATE_RESUME          = 0x0f,
784         DWC3_LINK_STATE_MASK            = 0x0f,
785 };
786
787 /* TRB Length, PCM and Status */
788 #define DWC3_TRB_SIZE_MASK      (0x00ffffff)
789 #define DWC3_TRB_SIZE_LENGTH(n) ((n) & DWC3_TRB_SIZE_MASK)
790 #define DWC3_TRB_SIZE_PCM1(n)   (((n) & 0x03) << 24)
791 #define DWC3_TRB_SIZE_TRBSTS(n) (((n) & (0x0f << 28)) >> 28)
792
793 #define DWC3_TRBSTS_OK                  0
794 #define DWC3_TRBSTS_MISSED_ISOC         1
795 #define DWC3_TRBSTS_SETUP_PENDING       2
796 #define DWC3_TRB_STS_XFER_IN_PROG       4
797
798 /* TRB Control */
799 #define DWC3_TRB_CTRL_HWO               BIT(0)
800 #define DWC3_TRB_CTRL_LST               BIT(1)
801 #define DWC3_TRB_CTRL_CHN               BIT(2)
802 #define DWC3_TRB_CTRL_CSP               BIT(3)
803 #define DWC3_TRB_CTRL_TRBCTL(n)         (((n) & 0x3f) << 4)
804 #define DWC3_TRB_CTRL_ISP_IMI           BIT(10)
805 #define DWC3_TRB_CTRL_IOC               BIT(11)
806 #define DWC3_TRB_CTRL_SID_SOFN(n)       (((n) & 0xffff) << 14)
807 #define DWC3_TRB_CTRL_GET_SID_SOFN(n)   (((n) & (0xffff << 14)) >> 14)
808
809 #define DWC3_TRBCTL_TYPE(n)             ((n) & (0x3f << 4))
810 #define DWC3_TRBCTL_NORMAL              DWC3_TRB_CTRL_TRBCTL(1)
811 #define DWC3_TRBCTL_CONTROL_SETUP       DWC3_TRB_CTRL_TRBCTL(2)
812 #define DWC3_TRBCTL_CONTROL_STATUS2     DWC3_TRB_CTRL_TRBCTL(3)
813 #define DWC3_TRBCTL_CONTROL_STATUS3     DWC3_TRB_CTRL_TRBCTL(4)
814 #define DWC3_TRBCTL_CONTROL_DATA        DWC3_TRB_CTRL_TRBCTL(5)
815 #define DWC3_TRBCTL_ISOCHRONOUS_FIRST   DWC3_TRB_CTRL_TRBCTL(6)
816 #define DWC3_TRBCTL_ISOCHRONOUS         DWC3_TRB_CTRL_TRBCTL(7)
817 #define DWC3_TRBCTL_LINK_TRB            DWC3_TRB_CTRL_TRBCTL(8)
818
819 /**
820  * struct dwc3_trb - transfer request block (hw format)
821  * @bpl: DW0-3
822  * @bph: DW4-7
823  * @size: DW8-B
824  * @ctrl: DWC-F
825  */
826 struct dwc3_trb {
827         u32             bpl;
828         u32             bph;
829         u32             size;
830         u32             ctrl;
831 } __packed;
832
833 /**
834  * struct dwc3_hwparams - copy of HWPARAMS registers
835  * @hwparams0: GHWPARAMS0
836  * @hwparams1: GHWPARAMS1
837  * @hwparams2: GHWPARAMS2
838  * @hwparams3: GHWPARAMS3
839  * @hwparams4: GHWPARAMS4
840  * @hwparams5: GHWPARAMS5
841  * @hwparams6: GHWPARAMS6
842  * @hwparams7: GHWPARAMS7
843  * @hwparams8: GHWPARAMS8
844  */
845 struct dwc3_hwparams {
846         u32     hwparams0;
847         u32     hwparams1;
848         u32     hwparams2;
849         u32     hwparams3;
850         u32     hwparams4;
851         u32     hwparams5;
852         u32     hwparams6;
853         u32     hwparams7;
854         u32     hwparams8;
855 };
856
857 /* HWPARAMS0 */
858 #define DWC3_MODE(n)            ((n) & 0x7)
859
860 #define DWC3_MDWIDTH(n)         (((n) & 0xff00) >> 8)
861
862 /* HWPARAMS1 */
863 #define DWC3_NUM_INT(n)         (((n) & (0x3f << 15)) >> 15)
864
865 /* HWPARAMS3 */
866 #define DWC3_NUM_IN_EPS_MASK    (0x1f << 18)
867 #define DWC3_NUM_EPS_MASK       (0x3f << 12)
868 #define DWC3_NUM_EPS(p)         (((p)->hwparams3 &              \
869                         (DWC3_NUM_EPS_MASK)) >> 12)
870 #define DWC3_NUM_IN_EPS(p)      (((p)->hwparams3 &              \
871                         (DWC3_NUM_IN_EPS_MASK)) >> 18)
872
873 /* HWPARAMS7 */
874 #define DWC3_RAM1_DEPTH(n)      ((n) & 0xffff)
875
876 /**
877  * struct dwc3_request - representation of a transfer request
878  * @request: struct usb_request to be transferred
879  * @list: a list_head used for request queueing
880  * @dep: struct dwc3_ep owning this request
881  * @sg: pointer to first incomplete sg
882  * @start_sg: pointer to the sg which should be queued next
883  * @num_pending_sgs: counter to pending sgs
884  * @num_queued_sgs: counter to the number of sgs which already got queued
885  * @remaining: amount of data remaining
886  * @status: internal dwc3 request status tracking
887  * @epnum: endpoint number to which this request refers
888  * @trb: pointer to struct dwc3_trb
889  * @trb_dma: DMA address of @trb
890  * @num_trbs: number of TRBs used by this request
891  * @needs_extra_trb: true when request needs one extra TRB (either due to ZLP
892  *      or unaligned OUT)
893  * @direction: IN or OUT direction flag
894  * @mapped: true when request has been dma-mapped
895  */
896 struct dwc3_request {
897         struct usb_request      request;
898         struct list_head        list;
899         struct dwc3_ep          *dep;
900         struct scatterlist      *sg;
901         struct scatterlist      *start_sg;
902
903         unsigned int            num_pending_sgs;
904         unsigned int            num_queued_sgs;
905         unsigned int            remaining;
906
907         unsigned int            status;
908 #define DWC3_REQUEST_STATUS_QUEUED      0
909 #define DWC3_REQUEST_STATUS_STARTED     1
910 #define DWC3_REQUEST_STATUS_CANCELLED   2
911 #define DWC3_REQUEST_STATUS_COMPLETED   3
912 #define DWC3_REQUEST_STATUS_UNKNOWN     -1
913
914         u8                      epnum;
915         struct dwc3_trb         *trb;
916         dma_addr_t              trb_dma;
917
918         unsigned int            num_trbs;
919
920         unsigned int            needs_extra_trb:1;
921         unsigned int            direction:1;
922         unsigned int            mapped:1;
923 };
924
925 /*
926  * struct dwc3_scratchpad_array - hibernation scratchpad array
927  * (format defined by hw)
928  */
929 struct dwc3_scratchpad_array {
930         __le64  dma_adr[DWC3_MAX_HIBER_SCRATCHBUFS];
931 };
932
933 /**
934  * struct dwc3 - representation of our controller
935  * @drd_work: workqueue used for role swapping
936  * @ep0_trb: trb which is used for the ctrl_req
937  * @bounce: address of bounce buffer
938  * @scratchbuf: address of scratch buffer
939  * @setup_buf: used while precessing STD USB requests
940  * @ep0_trb_addr: dma address of @ep0_trb
941  * @bounce_addr: dma address of @bounce
942  * @ep0_usb_req: dummy req used while handling STD USB requests
943  * @scratch_addr: dma address of scratchbuf
944  * @ep0_in_setup: one control transfer is completed and enter setup phase
945  * @lock: for synchronizing
946  * @mutex: for mode switching
947  * @dev: pointer to our struct device
948  * @sysdev: pointer to the DMA-capable device
949  * @xhci: pointer to our xHCI child
950  * @xhci_resources: struct resources for our @xhci child
951  * @ev_buf: struct dwc3_event_buffer pointer
952  * @eps: endpoint array
953  * @gadget: device side representation of the peripheral controller
954  * @gadget_driver: pointer to the gadget driver
955  * @clks: array of clocks
956  * @num_clks: number of clocks
957  * @reset: reset control
958  * @regs: base address for our registers
959  * @regs_size: address space size
960  * @fladj: frame length adjustment
961  * @irq_gadget: peripheral controller's IRQ number
962  * @otg_irq: IRQ number for OTG IRQs
963  * @current_otg_role: current role of operation while using the OTG block
964  * @desired_otg_role: desired role of operation while using the OTG block
965  * @otg_restart_host: flag that OTG controller needs to restart host
966  * @nr_scratch: number of scratch buffers
967  * @u1u2: only used on revisions <1.83a for workaround
968  * @maximum_speed: maximum speed requested (mainly for testing purposes)
969  * @ip: controller's ID
970  * @revision: controller's version of an IP
971  * @version_type: VERSIONTYPE register contents, a sub release of a revision
972  * @dr_mode: requested mode of operation
973  * @current_dr_role: current role of operation when in dual-role mode
974  * @desired_dr_role: desired role of operation when in dual-role mode
975  * @edev: extcon handle
976  * @edev_nb: extcon notifier
977  * @hsphy_mode: UTMI phy mode, one of following:
978  *              - USBPHY_INTERFACE_MODE_UTMI
979  *              - USBPHY_INTERFACE_MODE_UTMIW
980  * @role_sw: usb_role_switch handle
981  * @role_switch_default_mode: default operation mode of controller while
982  *                      usb role is USB_ROLE_NONE.
983  * @usb2_phy: pointer to USB2 PHY
984  * @usb3_phy: pointer to USB3 PHY
985  * @usb2_generic_phy: pointer to USB2 PHY
986  * @usb3_generic_phy: pointer to USB3 PHY
987  * @phys_ready: flag to indicate that PHYs are ready
988  * @ulpi: pointer to ulpi interface
989  * @ulpi_ready: flag to indicate that ULPI is initialized
990  * @u2sel: parameter from Set SEL request.
991  * @u2pel: parameter from Set SEL request.
992  * @u1sel: parameter from Set SEL request.
993  * @u1pel: parameter from Set SEL request.
994  * @num_eps: number of endpoints
995  * @ep0_next_event: hold the next expected event
996  * @ep0state: state of endpoint zero
997  * @link_state: link state
998  * @speed: device speed (super, high, full, low)
999  * @hwparams: copy of hwparams registers
1000  * @root: debugfs root folder pointer
1001  * @regset: debugfs pointer to regdump file
1002  * @dbg_lsp_select: current debug lsp mux register selection
1003  * @test_mode: true when we're entering a USB test mode
1004  * @test_mode_nr: test feature selector
1005  * @lpm_nyet_threshold: LPM NYET response threshold
1006  * @hird_threshold: HIRD threshold
1007  * @rx_thr_num_pkt_prd: periodic ESS receive packet count
1008  * @rx_max_burst_prd: max periodic ESS receive burst size
1009  * @tx_thr_num_pkt_prd: periodic ESS transmit packet count
1010  * @tx_max_burst_prd: max periodic ESS transmit burst size
1011  * @hsphy_interface: "utmi" or "ulpi"
1012  * @connected: true when we're connected to a host, false otherwise
1013  * @softconnect: true when gadget connect is called, false when disconnect runs
1014  * @delayed_status: true when gadget driver asks for delayed status
1015  * @ep0_bounced: true when we used bounce buffer
1016  * @ep0_expect_in: true when we expect a DATA IN transfer
1017  * @has_hibernation: true when dwc3 was configured with Hibernation
1018  * @sysdev_is_parent: true when dwc3 device has a parent driver
1019  * @has_lpm_erratum: true when core was configured with LPM Erratum. Note that
1020  *                      there's now way for software to detect this in runtime.
1021  * @is_utmi_l1_suspend: the core asserts output signal
1022  *      0       - utmi_sleep_n
1023  *      1       - utmi_l1_suspend_n
1024  * @is_fpga: true when we are using the FPGA board
1025  * @pending_events: true when we have pending IRQs to be handled
1026  * @pullups_connected: true when Run/Stop bit is set
1027  * @setup_packet_pending: true when there's a Setup Packet in FIFO. Workaround
1028  * @three_stage_setup: set if we perform a three phase setup
1029  * @dis_start_transfer_quirk: set if start_transfer failure SW workaround is
1030  *                      not needed for DWC_usb31 version 1.70a-ea06 and below
1031  * @usb3_lpm_capable: set if hadrware supports Link Power Management
1032  * @usb2_lpm_disable: set to disable usb2 lpm for host
1033  * @usb2_gadget_lpm_disable: set to disable usb2 lpm for gadget
1034  * @disable_scramble_quirk: set if we enable the disable scramble quirk
1035  * @u2exit_lfps_quirk: set if we enable u2exit lfps quirk
1036  * @u2ss_inp3_quirk: set if we enable P3 OK for U2/SS Inactive quirk
1037  * @req_p1p2p3_quirk: set if we enable request p1p2p3 quirk
1038  * @del_p1p2p3_quirk: set if we enable delay p1p2p3 quirk
1039  * @del_phy_power_chg_quirk: set if we enable delay phy power change quirk
1040  * @lfps_filter_quirk: set if we enable LFPS filter quirk
1041  * @rx_detect_poll_quirk: set if we enable rx_detect to polling lfps quirk
1042  * @dis_u3_susphy_quirk: set if we disable usb3 suspend phy
1043  * @dis_u2_susphy_quirk: set if we disable usb2 suspend phy
1044  * @dis_enblslpm_quirk: set if we clear enblslpm in GUSB2PHYCFG,
1045  *                      disabling the suspend signal to the PHY.
1046  * @dis_u1_entry_quirk: set if link entering into U1 state needs to be disabled.
1047  * @dis_u2_entry_quirk: set if link entering into U2 state needs to be disabled.
1048  * @dis_rxdet_inp3_quirk: set if we disable Rx.Detect in P3
1049  * @dis_u2_freeclk_exists_quirk : set if we clear u2_freeclk_exists
1050  *                      in GUSB2PHYCFG, specify that USB2 PHY doesn't
1051  *                      provide a free-running PHY clock.
1052  * @dis_del_phy_power_chg_quirk: set if we disable delay phy power
1053  *                      change quirk.
1054  * @dis_tx_ipgap_linecheck_quirk: set if we disable u2mac linestate
1055  *                      check during HS transmit.
1056  * @parkmode_disable_ss_quirk: set if we need to disable all SuperSpeed
1057  *                      instances in park mode.
1058  * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
1059  * @tx_de_emphasis: Tx de-emphasis value
1060  *      0       - -6dB de-emphasis
1061  *      1       - -3.5dB de-emphasis
1062  *      2       - No de-emphasis
1063  *      3       - Reserved
1064  * @dis_metastability_quirk: set to disable metastability quirk.
1065  * @dis_split_quirk: set to disable split boundary.
1066  * @imod_interval: set the interrupt moderation interval in 250ns
1067  *                      increments or 0 to disable.
1068  */
1069 struct dwc3 {
1070         struct work_struct      drd_work;
1071         struct dwc3_trb         *ep0_trb;
1072         void                    *bounce;
1073         void                    *scratchbuf;
1074         u8                      *setup_buf;
1075         dma_addr_t              ep0_trb_addr;
1076         dma_addr_t              bounce_addr;
1077         dma_addr_t              scratch_addr;
1078         struct dwc3_request     ep0_usb_req;
1079         struct completion       ep0_in_setup;
1080
1081         /* device lock */
1082         spinlock_t              lock;
1083
1084         /* mode switching lock */
1085         struct mutex            mutex;
1086
1087         struct device           *dev;
1088         struct device           *sysdev;
1089
1090         struct platform_device  *xhci;
1091         struct resource         xhci_resources[DWC3_XHCI_RESOURCES_NUM];
1092
1093         struct dwc3_event_buffer *ev_buf;
1094         struct dwc3_ep          *eps[DWC3_ENDPOINTS_NUM];
1095
1096         struct usb_gadget       *gadget;
1097         struct usb_gadget_driver *gadget_driver;
1098
1099         struct clk_bulk_data    *clks;
1100         int                     num_clks;
1101
1102         struct reset_control    *reset;
1103
1104         struct usb_phy          *usb2_phy;
1105         struct usb_phy          *usb3_phy;
1106
1107         struct phy              *usb2_generic_phy;
1108         struct phy              *usb3_generic_phy;
1109
1110         bool                    phys_ready;
1111
1112         struct ulpi             *ulpi;
1113         bool                    ulpi_ready;
1114
1115         void __iomem            *regs;
1116         size_t                  regs_size;
1117
1118         enum usb_dr_mode        dr_mode;
1119         u32                     current_dr_role;
1120         u32                     desired_dr_role;
1121         struct extcon_dev       *edev;
1122         struct notifier_block   edev_nb;
1123         enum usb_phy_interface  hsphy_mode;
1124         struct usb_role_switch  *role_sw;
1125         enum usb_dr_mode        role_switch_default_mode;
1126
1127         u32                     fladj;
1128         u32                     irq_gadget;
1129         u32                     otg_irq;
1130         u32                     current_otg_role;
1131         u32                     desired_otg_role;
1132         bool                    otg_restart_host;
1133         u32                     nr_scratch;
1134         u32                     u1u2;
1135         u32                     maximum_speed;
1136
1137         u32                     ip;
1138
1139 #define DWC3_IP                 0x5533
1140 #define DWC31_IP                0x3331
1141 #define DWC32_IP                0x3332
1142
1143         u32                     revision;
1144
1145 #define DWC3_REVISION_ANY       0x0
1146 #define DWC3_REVISION_173A      0x5533173a
1147 #define DWC3_REVISION_175A      0x5533175a
1148 #define DWC3_REVISION_180A      0x5533180a
1149 #define DWC3_REVISION_183A      0x5533183a
1150 #define DWC3_REVISION_185A      0x5533185a
1151 #define DWC3_REVISION_187A      0x5533187a
1152 #define DWC3_REVISION_188A      0x5533188a
1153 #define DWC3_REVISION_190A      0x5533190a
1154 #define DWC3_REVISION_194A      0x5533194a
1155 #define DWC3_REVISION_200A      0x5533200a
1156 #define DWC3_REVISION_202A      0x5533202a
1157 #define DWC3_REVISION_210A      0x5533210a
1158 #define DWC3_REVISION_220A      0x5533220a
1159 #define DWC3_REVISION_230A      0x5533230a
1160 #define DWC3_REVISION_240A      0x5533240a
1161 #define DWC3_REVISION_250A      0x5533250a
1162 #define DWC3_REVISION_260A      0x5533260a
1163 #define DWC3_REVISION_270A      0x5533270a
1164 #define DWC3_REVISION_280A      0x5533280a
1165 #define DWC3_REVISION_290A      0x5533290a
1166 #define DWC3_REVISION_300A      0x5533300a
1167 #define DWC3_REVISION_310A      0x5533310a
1168 #define DWC3_REVISION_330A      0x5533330a
1169
1170 #define DWC31_REVISION_ANY      0x0
1171 #define DWC31_REVISION_110A     0x3131302a
1172 #define DWC31_REVISION_120A     0x3132302a
1173 #define DWC31_REVISION_160A     0x3136302a
1174 #define DWC31_REVISION_170A     0x3137302a
1175 #define DWC31_REVISION_180A     0x3138302a
1176 #define DWC31_REVISION_190A     0x3139302a
1177
1178 #define DWC32_REVISION_ANY      0x0
1179 #define DWC32_REVISION_100A     0x3130302a
1180
1181         u32                     version_type;
1182
1183 #define DWC31_VERSIONTYPE_ANY           0x0
1184 #define DWC31_VERSIONTYPE_EA01          0x65613031
1185 #define DWC31_VERSIONTYPE_EA02          0x65613032
1186 #define DWC31_VERSIONTYPE_EA03          0x65613033
1187 #define DWC31_VERSIONTYPE_EA04          0x65613034
1188 #define DWC31_VERSIONTYPE_EA05          0x65613035
1189 #define DWC31_VERSIONTYPE_EA06          0x65613036
1190
1191         enum dwc3_ep0_next      ep0_next_event;
1192         enum dwc3_ep0_state     ep0state;
1193         enum dwc3_link_state    link_state;
1194
1195         u16                     u2sel;
1196         u16                     u2pel;
1197         u8                      u1sel;
1198         u8                      u1pel;
1199
1200         u8                      speed;
1201
1202         u8                      num_eps;
1203
1204         struct dwc3_hwparams    hwparams;
1205         struct dentry           *root;
1206         struct debugfs_regset32 *regset;
1207
1208         u32                     dbg_lsp_select;
1209
1210         u8                      test_mode;
1211         u8                      test_mode_nr;
1212         u8                      lpm_nyet_threshold;
1213         u8                      hird_threshold;
1214         u8                      rx_thr_num_pkt_prd;
1215         u8                      rx_max_burst_prd;
1216         u8                      tx_thr_num_pkt_prd;
1217         u8                      tx_max_burst_prd;
1218
1219         const char              *hsphy_interface;
1220
1221         unsigned                connected:1;
1222         unsigned                softconnect:1;
1223         unsigned                delayed_status:1;
1224         unsigned                ep0_bounced:1;
1225         unsigned                ep0_expect_in:1;
1226         unsigned                has_hibernation:1;
1227         unsigned                sysdev_is_parent:1;
1228         unsigned                has_lpm_erratum:1;
1229         unsigned                is_utmi_l1_suspend:1;
1230         unsigned                is_fpga:1;
1231         unsigned                pending_events:1;
1232         unsigned                pullups_connected:1;
1233         unsigned                setup_packet_pending:1;
1234         unsigned                three_stage_setup:1;
1235         unsigned                dis_start_transfer_quirk:1;
1236         unsigned                usb3_lpm_capable:1;
1237         unsigned                usb2_lpm_disable:1;
1238         unsigned                usb2_gadget_lpm_disable:1;
1239
1240         unsigned                disable_scramble_quirk:1;
1241         unsigned                u2exit_lfps_quirk:1;
1242         unsigned                u2ss_inp3_quirk:1;
1243         unsigned                req_p1p2p3_quirk:1;
1244         unsigned                del_p1p2p3_quirk:1;
1245         unsigned                del_phy_power_chg_quirk:1;
1246         unsigned                lfps_filter_quirk:1;
1247         unsigned                rx_detect_poll_quirk:1;
1248         unsigned                dis_u3_susphy_quirk:1;
1249         unsigned                dis_u2_susphy_quirk:1;
1250         unsigned                dis_enblslpm_quirk:1;
1251         unsigned                dis_u1_entry_quirk:1;
1252         unsigned                dis_u2_entry_quirk:1;
1253         unsigned                dis_rxdet_inp3_quirk:1;
1254         unsigned                dis_u2_freeclk_exists_quirk:1;
1255         unsigned                dis_del_phy_power_chg_quirk:1;
1256         unsigned                dis_tx_ipgap_linecheck_quirk:1;
1257         unsigned                parkmode_disable_ss_quirk:1;
1258
1259         unsigned                tx_de_emphasis_quirk:1;
1260         unsigned                tx_de_emphasis:2;
1261
1262         unsigned                dis_metastability_quirk:1;
1263
1264         unsigned                dis_split_quirk:1;
1265
1266         u16                     imod_interval;
1267 };
1268
1269 #define INCRX_BURST_MODE 0
1270 #define INCRX_UNDEF_LENGTH_BURST_MODE 1
1271
1272 #define work_to_dwc(w)          (container_of((w), struct dwc3, drd_work))
1273
1274 /* -------------------------------------------------------------------------- */
1275
1276 struct dwc3_event_type {
1277         u32     is_devspec:1;
1278         u32     type:7;
1279         u32     reserved8_31:24;
1280 } __packed;
1281
1282 #define DWC3_DEPEVT_XFERCOMPLETE        0x01
1283 #define DWC3_DEPEVT_XFERINPROGRESS      0x02
1284 #define DWC3_DEPEVT_XFERNOTREADY        0x03
1285 #define DWC3_DEPEVT_RXTXFIFOEVT         0x04
1286 #define DWC3_DEPEVT_STREAMEVT           0x06
1287 #define DWC3_DEPEVT_EPCMDCMPLT          0x07
1288
1289 /**
1290  * struct dwc3_event_depevt - Device Endpoint Events
1291  * @one_bit: indicates this is an endpoint event (not used)
1292  * @endpoint_number: number of the endpoint
1293  * @endpoint_event: The event we have:
1294  *      0x00    - Reserved
1295  *      0x01    - XferComplete
1296  *      0x02    - XferInProgress
1297  *      0x03    - XferNotReady
1298  *      0x04    - RxTxFifoEvt (IN->Underrun, OUT->Overrun)
1299  *      0x05    - Reserved
1300  *      0x06    - StreamEvt
1301  *      0x07    - EPCmdCmplt
1302  * @reserved11_10: Reserved, don't use.
1303  * @status: Indicates the status of the event. Refer to databook for
1304  *      more information.
1305  * @parameters: Parameters of the current event. Refer to databook for
1306  *      more information.
1307  */
1308 struct dwc3_event_depevt {
1309         u32     one_bit:1;
1310         u32     endpoint_number:5;
1311         u32     endpoint_event:4;
1312         u32     reserved11_10:2;
1313         u32     status:4;
1314
1315 /* Within XferNotReady */
1316 #define DEPEVT_STATUS_TRANSFER_ACTIVE   BIT(3)
1317
1318 /* Within XferComplete or XferInProgress */
1319 #define DEPEVT_STATUS_BUSERR    BIT(0)
1320 #define DEPEVT_STATUS_SHORT     BIT(1)
1321 #define DEPEVT_STATUS_IOC       BIT(2)
1322 #define DEPEVT_STATUS_LST       BIT(3) /* XferComplete */
1323 #define DEPEVT_STATUS_MISSED_ISOC BIT(3) /* XferInProgress */
1324
1325 /* Stream event only */
1326 #define DEPEVT_STREAMEVT_FOUND          1
1327 #define DEPEVT_STREAMEVT_NOTFOUND       2
1328
1329 /* Stream event parameter */
1330 #define DEPEVT_STREAM_PRIME             0xfffe
1331 #define DEPEVT_STREAM_NOSTREAM          0x0
1332
1333 /* Control-only Status */
1334 #define DEPEVT_STATUS_CONTROL_DATA      1
1335 #define DEPEVT_STATUS_CONTROL_STATUS    2
1336 #define DEPEVT_STATUS_CONTROL_PHASE(n)  ((n) & 3)
1337
1338 /* In response to Start Transfer */
1339 #define DEPEVT_TRANSFER_NO_RESOURCE     1
1340 #define DEPEVT_TRANSFER_BUS_EXPIRY      2
1341
1342         u32     parameters:16;
1343
1344 /* For Command Complete Events */
1345 #define DEPEVT_PARAMETER_CMD(n) (((n) & (0xf << 8)) >> 8)
1346 } __packed;
1347
1348 /**
1349  * struct dwc3_event_devt - Device Events
1350  * @one_bit: indicates this is a non-endpoint event (not used)
1351  * @device_event: indicates it's a device event. Should read as 0x00
1352  * @type: indicates the type of device event.
1353  *      0       - DisconnEvt
1354  *      1       - USBRst
1355  *      2       - ConnectDone
1356  *      3       - ULStChng
1357  *      4       - WkUpEvt
1358  *      5       - Reserved
1359  *      6       - EOPF
1360  *      7       - SOF
1361  *      8       - Reserved
1362  *      9       - ErrticErr
1363  *      10      - CmdCmplt
1364  *      11      - EvntOverflow
1365  *      12      - VndrDevTstRcved
1366  * @reserved15_12: Reserved, not used
1367  * @event_info: Information about this event
1368  * @reserved31_25: Reserved, not used
1369  */
1370 struct dwc3_event_devt {
1371         u32     one_bit:1;
1372         u32     device_event:7;
1373         u32     type:4;
1374         u32     reserved15_12:4;
1375         u32     event_info:9;
1376         u32     reserved31_25:7;
1377 } __packed;
1378
1379 /**
1380  * struct dwc3_event_gevt - Other Core Events
1381  * @one_bit: indicates this is a non-endpoint event (not used)
1382  * @device_event: indicates it's (0x03) Carkit or (0x04) I2C event.
1383  * @phy_port_number: self-explanatory
1384  * @reserved31_12: Reserved, not used.
1385  */
1386 struct dwc3_event_gevt {
1387         u32     one_bit:1;
1388         u32     device_event:7;
1389         u32     phy_port_number:4;
1390         u32     reserved31_12:20;
1391 } __packed;
1392
1393 /**
1394  * union dwc3_event - representation of Event Buffer contents
1395  * @raw: raw 32-bit event
1396  * @type: the type of the event
1397  * @depevt: Device Endpoint Event
1398  * @devt: Device Event
1399  * @gevt: Global Event
1400  */
1401 union dwc3_event {
1402         u32                             raw;
1403         struct dwc3_event_type          type;
1404         struct dwc3_event_depevt        depevt;
1405         struct dwc3_event_devt          devt;
1406         struct dwc3_event_gevt          gevt;
1407 };
1408
1409 /**
1410  * struct dwc3_gadget_ep_cmd_params - representation of endpoint command
1411  * parameters
1412  * @param2: third parameter
1413  * @param1: second parameter
1414  * @param0: first parameter
1415  */
1416 struct dwc3_gadget_ep_cmd_params {
1417         u32     param2;
1418         u32     param1;
1419         u32     param0;
1420 };
1421
1422 /*
1423  * DWC3 Features to be used as Driver Data
1424  */
1425
1426 #define DWC3_HAS_PERIPHERAL             BIT(0)
1427 #define DWC3_HAS_XHCI                   BIT(1)
1428 #define DWC3_HAS_OTG                    BIT(3)
1429
1430 /* prototypes */
1431 void dwc3_set_prtcap(struct dwc3 *dwc, u32 mode);
1432 void dwc3_set_mode(struct dwc3 *dwc, u32 mode);
1433 u32 dwc3_core_fifo_space(struct dwc3_ep *dep, u8 type);
1434
1435 #define DWC3_IP_IS(_ip)                                                 \
1436         (dwc->ip == _ip##_IP)
1437
1438 #define DWC3_VER_IS(_ip, _ver)                                          \
1439         (DWC3_IP_IS(_ip) && dwc->revision == _ip##_REVISION_##_ver)
1440
1441 #define DWC3_VER_IS_PRIOR(_ip, _ver)                                    \
1442         (DWC3_IP_IS(_ip) && dwc->revision < _ip##_REVISION_##_ver)
1443
1444 #define DWC3_VER_IS_WITHIN(_ip, _from, _to)                             \
1445         (DWC3_IP_IS(_ip) &&                                             \
1446          dwc->revision >= _ip##_REVISION_##_from &&                     \
1447          (!(_ip##_REVISION_##_to) ||                                    \
1448           dwc->revision <= _ip##_REVISION_##_to))
1449
1450 #define DWC3_VER_TYPE_IS_WITHIN(_ip, _ver, _from, _to)                  \
1451         (DWC3_VER_IS(_ip, _ver) &&                                      \
1452          dwc->version_type >= _ip##_VERSIONTYPE_##_from &&              \
1453          (!(_ip##_VERSIONTYPE_##_to) ||                                 \
1454           dwc->version_type <= _ip##_VERSIONTYPE_##_to))
1455
1456 bool dwc3_has_imod(struct dwc3 *dwc);
1457
1458 int dwc3_event_buffers_setup(struct dwc3 *dwc);
1459 void dwc3_event_buffers_cleanup(struct dwc3 *dwc);
1460
1461 int dwc3_core_soft_reset(struct dwc3 *dwc);
1462
1463 #if IS_ENABLED(CONFIG_USB_DWC3_HOST) || IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
1464 int dwc3_host_init(struct dwc3 *dwc);
1465 void dwc3_host_exit(struct dwc3 *dwc);
1466 #else
1467 static inline int dwc3_host_init(struct dwc3 *dwc)
1468 { return 0; }
1469 static inline void dwc3_host_exit(struct dwc3 *dwc)
1470 { }
1471 #endif
1472
1473 #if IS_ENABLED(CONFIG_USB_DWC3_GADGET) || IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
1474 int dwc3_gadget_init(struct dwc3 *dwc);
1475 void dwc3_gadget_exit(struct dwc3 *dwc);
1476 int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode);
1477 int dwc3_gadget_get_link_state(struct dwc3 *dwc);
1478 int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state);
1479 int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned int cmd,
1480                 struct dwc3_gadget_ep_cmd_params *params);
1481 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned int cmd,
1482                 u32 param);
1483 #else
1484 static inline int dwc3_gadget_init(struct dwc3 *dwc)
1485 { return 0; }
1486 static inline void dwc3_gadget_exit(struct dwc3 *dwc)
1487 { }
1488 static inline int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
1489 { return 0; }
1490 static inline int dwc3_gadget_get_link_state(struct dwc3 *dwc)
1491 { return 0; }
1492 static inline int dwc3_gadget_set_link_state(struct dwc3 *dwc,
1493                 enum dwc3_link_state state)
1494 { return 0; }
1495
1496 static inline int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned int cmd,
1497                 struct dwc3_gadget_ep_cmd_params *params)
1498 { return 0; }
1499 static inline int dwc3_send_gadget_generic_command(struct dwc3 *dwc,
1500                 int cmd, u32 param)
1501 { return 0; }
1502 #endif
1503
1504 #if IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
1505 int dwc3_drd_init(struct dwc3 *dwc);
1506 void dwc3_drd_exit(struct dwc3 *dwc);
1507 void dwc3_otg_init(struct dwc3 *dwc);
1508 void dwc3_otg_exit(struct dwc3 *dwc);
1509 void dwc3_otg_update(struct dwc3 *dwc, bool ignore_idstatus);
1510 void dwc3_otg_host_init(struct dwc3 *dwc);
1511 #else
1512 static inline int dwc3_drd_init(struct dwc3 *dwc)
1513 { return 0; }
1514 static inline void dwc3_drd_exit(struct dwc3 *dwc)
1515 { }
1516 static inline void dwc3_otg_init(struct dwc3 *dwc)
1517 { }
1518 static inline void dwc3_otg_exit(struct dwc3 *dwc)
1519 { }
1520 static inline void dwc3_otg_update(struct dwc3 *dwc, bool ignore_idstatus)
1521 { }
1522 static inline void dwc3_otg_host_init(struct dwc3 *dwc)
1523 { }
1524 #endif
1525
1526 /* power management interface */
1527 #if !IS_ENABLED(CONFIG_USB_DWC3_HOST)
1528 int dwc3_gadget_suspend(struct dwc3 *dwc);
1529 int dwc3_gadget_resume(struct dwc3 *dwc);
1530 void dwc3_gadget_process_pending_events(struct dwc3 *dwc);
1531 #else
1532 static inline int dwc3_gadget_suspend(struct dwc3 *dwc)
1533 {
1534         return 0;
1535 }
1536
1537 static inline int dwc3_gadget_resume(struct dwc3 *dwc)
1538 {
1539         return 0;
1540 }
1541
1542 static inline void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
1543 {
1544 }
1545 #endif /* !IS_ENABLED(CONFIG_USB_DWC3_HOST) */
1546
1547 #if IS_ENABLED(CONFIG_USB_DWC3_ULPI)
1548 int dwc3_ulpi_init(struct dwc3 *dwc);
1549 void dwc3_ulpi_exit(struct dwc3 *dwc);
1550 #else
1551 static inline int dwc3_ulpi_init(struct dwc3 *dwc)
1552 { return 0; }
1553 static inline void dwc3_ulpi_exit(struct dwc3 *dwc)
1554 { }
1555 #endif
1556
1557 #endif /* __DRIVERS_USB_DWC3_CORE_H */