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