1 // SPDX-License-Identifier: GPL-2.0
3 * core.h - DesignWare USB3 DRD Core Header
5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
7 * Authors: Felipe Balbi <balbi@ti.com>,
8 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
11 #ifndef __DRIVERS_USB_DWC3_CORE_H
12 #define __DRIVERS_USB_DWC3_CORE_H
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>
21 #include <linux/debugfs.h>
22 #include <linux/wait.h>
23 #include <linux/workqueue.h>
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>
31 #include <linux/phy/phy.h>
33 #define DWC3_MSG_MAX 500
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
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
47 #define DWC3_EVENT_TYPE_DEV 0
48 #define DWC3_EVENT_TYPE_CARKIT 3
49 #define DWC3_EVENT_TYPE_I2C 4
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
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
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
73 /* DWC3 registers memory space boundries */
74 #define DWC3_XHCI_REGS_START 0x0
75 #define DWC3_XHCI_REGS_END 0x7fff
76 #define DWC3_GLOBALS_REGS_START 0xc100
77 #define DWC3_GLOBALS_REGS_END 0xc6ff
78 #define DWC3_DEVICE_REGS_START 0xc700
79 #define DWC3_DEVICE_REGS_END 0xcbff
80 #define DWC3_OTG_REGS_START 0xcc00
81 #define DWC3_OTG_REGS_END 0xccff
83 /* Global Registers */
84 #define DWC3_GSBUSCFG0 0xc100
85 #define DWC3_GSBUSCFG1 0xc104
86 #define DWC3_GTXTHRCFG 0xc108
87 #define DWC3_GRXTHRCFG 0xc10c
88 #define DWC3_GCTL 0xc110
89 #define DWC3_GEVTEN 0xc114
90 #define DWC3_GSTS 0xc118
91 #define DWC3_GUCTL1 0xc11c
92 #define DWC3_GSNPSID 0xc120
93 #define DWC3_GGPIO 0xc124
94 #define DWC3_GUID 0xc128
95 #define DWC3_GUCTL 0xc12c
96 #define DWC3_GBUSERRADDR0 0xc130
97 #define DWC3_GBUSERRADDR1 0xc134
98 #define DWC3_GPRTBIMAP0 0xc138
99 #define DWC3_GPRTBIMAP1 0xc13c
100 #define DWC3_GHWPARAMS0 0xc140
101 #define DWC3_GHWPARAMS1 0xc144
102 #define DWC3_GHWPARAMS2 0xc148
103 #define DWC3_GHWPARAMS3 0xc14c
104 #define DWC3_GHWPARAMS4 0xc150
105 #define DWC3_GHWPARAMS5 0xc154
106 #define DWC3_GHWPARAMS6 0xc158
107 #define DWC3_GHWPARAMS7 0xc15c
108 #define DWC3_GDBGFIFOSPACE 0xc160
109 #define DWC3_GDBGLTSSM 0xc164
110 #define DWC3_GDBGBMU 0xc16c
111 #define DWC3_GDBGLSPMUX 0xc170
112 #define DWC3_GDBGLSP 0xc174
113 #define DWC3_GDBGEPINFO0 0xc178
114 #define DWC3_GDBGEPINFO1 0xc17c
115 #define DWC3_GPRTBIMAP_HS0 0xc180
116 #define DWC3_GPRTBIMAP_HS1 0xc184
117 #define DWC3_GPRTBIMAP_FS0 0xc188
118 #define DWC3_GPRTBIMAP_FS1 0xc18c
119 #define DWC3_GUCTL2 0xc19c
121 #define DWC3_VER_NUMBER 0xc1a0
122 #define DWC3_VER_TYPE 0xc1a4
124 #define DWC3_GUSB2PHYCFG(n) (0xc200 + ((n) * 0x04))
125 #define DWC3_GUSB2I2CCTL(n) (0xc240 + ((n) * 0x04))
127 #define DWC3_GUSB2PHYACC(n) (0xc280 + ((n) * 0x04))
129 #define DWC3_GUSB3PIPECTL(n) (0xc2c0 + ((n) * 0x04))
131 #define DWC3_GTXFIFOSIZ(n) (0xc300 + ((n) * 0x04))
132 #define DWC3_GRXFIFOSIZ(n) (0xc380 + ((n) * 0x04))
134 #define DWC3_GEVNTADRLO(n) (0xc400 + ((n) * 0x10))
135 #define DWC3_GEVNTADRHI(n) (0xc404 + ((n) * 0x10))
136 #define DWC3_GEVNTSIZ(n) (0xc408 + ((n) * 0x10))
137 #define DWC3_GEVNTCOUNT(n) (0xc40c + ((n) * 0x10))
139 #define DWC3_GHWPARAMS8 0xc600
140 #define DWC3_GFLADJ 0xc630
142 /* Device Registers */
143 #define DWC3_DCFG 0xc700
144 #define DWC3_DCTL 0xc704
145 #define DWC3_DEVTEN 0xc708
146 #define DWC3_DSTS 0xc70c
147 #define DWC3_DGCMDPAR 0xc710
148 #define DWC3_DGCMD 0xc714
149 #define DWC3_DALEPENA 0xc720
151 #define DWC3_DEP_BASE(n) (0xc800 + ((n) * 0x10))
152 #define DWC3_DEPCMDPAR2 0x00
153 #define DWC3_DEPCMDPAR1 0x04
154 #define DWC3_DEPCMDPAR0 0x08
155 #define DWC3_DEPCMD 0x0c
157 #define DWC3_DEV_IMOD(n) (0xca00 + ((n) * 0x4))
160 #define DWC3_OCFG 0xcc00
161 #define DWC3_OCTL 0xcc04
162 #define DWC3_OEVT 0xcc08
163 #define DWC3_OEVTEN 0xcc0C
164 #define DWC3_OSTS 0xcc10
168 /* Global SoC Bus Configuration INCRx Register 0 */
169 #define DWC3_GSBUSCFG0_INCR256BRSTENA (1 << 7) /* INCR256 burst */
170 #define DWC3_GSBUSCFG0_INCR128BRSTENA (1 << 6) /* INCR128 burst */
171 #define DWC3_GSBUSCFG0_INCR64BRSTENA (1 << 5) /* INCR64 burst */
172 #define DWC3_GSBUSCFG0_INCR32BRSTENA (1 << 4) /* INCR32 burst */
173 #define DWC3_GSBUSCFG0_INCR16BRSTENA (1 << 3) /* INCR16 burst */
174 #define DWC3_GSBUSCFG0_INCR8BRSTENA (1 << 2) /* INCR8 burst */
175 #define DWC3_GSBUSCFG0_INCR4BRSTENA (1 << 1) /* INCR4 burst */
176 #define DWC3_GSBUSCFG0_INCRBRSTENA (1 << 0) /* undefined length enable */
177 #define DWC3_GSBUSCFG0_INCRBRST_MASK 0xff
179 /* Global Debug LSP MUX Select */
180 #define DWC3_GDBGLSPMUX_ENDBC BIT(15) /* Host only */
181 #define DWC3_GDBGLSPMUX_HOSTSELECT(n) ((n) & 0x3fff)
182 #define DWC3_GDBGLSPMUX_DEVSELECT(n) (((n) & 0xf) << 4)
183 #define DWC3_GDBGLSPMUX_EPSELECT(n) ((n) & 0xf)
185 /* Global Debug Queue/FIFO Space Available Register */
186 #define DWC3_GDBGFIFOSPACE_NUM(n) ((n) & 0x1f)
187 #define DWC3_GDBGFIFOSPACE_TYPE(n) (((n) << 5) & 0x1e0)
188 #define DWC3_GDBGFIFOSPACE_SPACE_AVAILABLE(n) (((n) >> 16) & 0xffff)
190 #define DWC3_TXFIFO 0
191 #define DWC3_RXFIFO 1
192 #define DWC3_TXREQQ 2
193 #define DWC3_RXREQQ 3
194 #define DWC3_RXINFOQ 4
195 #define DWC3_PSTATQ 5
196 #define DWC3_DESCFETCHQ 6
197 #define DWC3_EVENTQ 7
198 #define DWC3_AUXEVENTQ 8
200 /* Global RX Threshold Configuration Register */
201 #define DWC3_GRXTHRCFG_MAXRXBURSTSIZE(n) (((n) & 0x1f) << 19)
202 #define DWC3_GRXTHRCFG_RXPKTCNT(n) (((n) & 0xf) << 24)
203 #define DWC3_GRXTHRCFG_PKTCNTSEL BIT(29)
205 /* Global RX Threshold Configuration Register for DWC_usb31 only */
206 #define DWC31_GRXTHRCFG_MAXRXBURSTSIZE(n) (((n) & 0x1f) << 16)
207 #define DWC31_GRXTHRCFG_RXPKTCNT(n) (((n) & 0x1f) << 21)
208 #define DWC31_GRXTHRCFG_PKTCNTSEL BIT(26)
209 #define DWC31_RXTHRNUMPKTSEL_HS_PRD BIT(15)
210 #define DWC31_RXTHRNUMPKT_HS_PRD(n) (((n) & 0x3) << 13)
211 #define DWC31_RXTHRNUMPKTSEL_PRD BIT(10)
212 #define DWC31_RXTHRNUMPKT_PRD(n) (((n) & 0x1f) << 5)
213 #define DWC31_MAXRXBURSTSIZE_PRD(n) ((n) & 0x1f)
215 /* Global TX Threshold Configuration Register for DWC_usb31 only */
216 #define DWC31_GTXTHRCFG_MAXTXBURSTSIZE(n) (((n) & 0x1f) << 16)
217 #define DWC31_GTXTHRCFG_TXPKTCNT(n) (((n) & 0x1f) << 21)
218 #define DWC31_GTXTHRCFG_PKTCNTSEL BIT(26)
219 #define DWC31_TXTHRNUMPKTSEL_HS_PRD BIT(15)
220 #define DWC31_TXTHRNUMPKT_HS_PRD(n) (((n) & 0x3) << 13)
221 #define DWC31_TXTHRNUMPKTSEL_PRD BIT(10)
222 #define DWC31_TXTHRNUMPKT_PRD(n) (((n) & 0x1f) << 5)
223 #define DWC31_MAXTXBURSTSIZE_PRD(n) ((n) & 0x1f)
225 /* Global Configuration Register */
226 #define DWC3_GCTL_PWRDNSCALE(n) ((n) << 19)
227 #define DWC3_GCTL_U2RSTECN BIT(16)
228 #define DWC3_GCTL_RAMCLKSEL(x) (((x) & DWC3_GCTL_CLK_MASK) << 6)
229 #define DWC3_GCTL_CLK_BUS (0)
230 #define DWC3_GCTL_CLK_PIPE (1)
231 #define DWC3_GCTL_CLK_PIPEHALF (2)
232 #define DWC3_GCTL_CLK_MASK (3)
234 #define DWC3_GCTL_PRTCAP(n) (((n) & (3 << 12)) >> 12)
235 #define DWC3_GCTL_PRTCAPDIR(n) ((n) << 12)
236 #define DWC3_GCTL_PRTCAP_HOST 1
237 #define DWC3_GCTL_PRTCAP_DEVICE 2
238 #define DWC3_GCTL_PRTCAP_OTG 3
240 #define DWC3_GCTL_CORESOFTRESET BIT(11)
241 #define DWC3_GCTL_SOFITPSYNC BIT(10)
242 #define DWC3_GCTL_SCALEDOWN(n) ((n) << 4)
243 #define DWC3_GCTL_SCALEDOWN_MASK DWC3_GCTL_SCALEDOWN(3)
244 #define DWC3_GCTL_DISSCRAMBLE BIT(3)
245 #define DWC3_GCTL_U2EXIT_LFPS BIT(2)
246 #define DWC3_GCTL_GBLHIBERNATIONEN BIT(1)
247 #define DWC3_GCTL_DSBLCLKGTNG BIT(0)
249 /* Global User Control Register */
250 #define DWC3_GUCTL_HSTINAUTORETRY BIT(14)
252 /* Global User Control 1 Register */
253 #define DWC3_GUCTL1_PARKMODE_DISABLE_SS BIT(17)
254 #define DWC3_GUCTL1_TX_IPGAP_LINECHECK_DIS BIT(28)
255 #define DWC3_GUCTL1_DEV_L1_EXIT_BY_HW BIT(24)
257 /* Global Status Register */
258 #define DWC3_GSTS_OTG_IP BIT(10)
259 #define DWC3_GSTS_BC_IP BIT(9)
260 #define DWC3_GSTS_ADP_IP BIT(8)
261 #define DWC3_GSTS_HOST_IP BIT(7)
262 #define DWC3_GSTS_DEVICE_IP BIT(6)
263 #define DWC3_GSTS_CSR_TIMEOUT BIT(5)
264 #define DWC3_GSTS_BUS_ERR_ADDR_VLD BIT(4)
265 #define DWC3_GSTS_CURMOD(n) ((n) & 0x3)
266 #define DWC3_GSTS_CURMOD_DEVICE 0
267 #define DWC3_GSTS_CURMOD_HOST 1
269 /* Global USB2 PHY Configuration Register */
270 #define DWC3_GUSB2PHYCFG_PHYSOFTRST BIT(31)
271 #define DWC3_GUSB2PHYCFG_U2_FREECLK_EXISTS BIT(30)
272 #define DWC3_GUSB2PHYCFG_SUSPHY BIT(6)
273 #define DWC3_GUSB2PHYCFG_ULPI_UTMI BIT(4)
274 #define DWC3_GUSB2PHYCFG_ENBLSLPM BIT(8)
275 #define DWC3_GUSB2PHYCFG_PHYIF(n) (n << 3)
276 #define DWC3_GUSB2PHYCFG_PHYIF_MASK DWC3_GUSB2PHYCFG_PHYIF(1)
277 #define DWC3_GUSB2PHYCFG_USBTRDTIM(n) (n << 10)
278 #define DWC3_GUSB2PHYCFG_USBTRDTIM_MASK DWC3_GUSB2PHYCFG_USBTRDTIM(0xf)
279 #define USBTRDTIM_UTMI_8_BIT 9
280 #define USBTRDTIM_UTMI_16_BIT 5
281 #define UTMI_PHYIF_16_BIT 1
282 #define UTMI_PHYIF_8_BIT 0
284 /* Global USB2 PHY Vendor Control Register */
285 #define DWC3_GUSB2PHYACC_NEWREGREQ BIT(25)
286 #define DWC3_GUSB2PHYACC_BUSY BIT(23)
287 #define DWC3_GUSB2PHYACC_WRITE BIT(22)
288 #define DWC3_GUSB2PHYACC_ADDR(n) (n << 16)
289 #define DWC3_GUSB2PHYACC_EXTEND_ADDR(n) (n << 8)
290 #define DWC3_GUSB2PHYACC_DATA(n) (n & 0xff)
292 /* Global USB3 PIPE Control Register */
293 #define DWC3_GUSB3PIPECTL_PHYSOFTRST BIT(31)
294 #define DWC3_GUSB3PIPECTL_U2SSINP3OK BIT(29)
295 #define DWC3_GUSB3PIPECTL_DISRXDETINP3 BIT(28)
296 #define DWC3_GUSB3PIPECTL_UX_EXIT_PX BIT(27)
297 #define DWC3_GUSB3PIPECTL_REQP1P2P3 BIT(24)
298 #define DWC3_GUSB3PIPECTL_DEP1P2P3(n) ((n) << 19)
299 #define DWC3_GUSB3PIPECTL_DEP1P2P3_MASK DWC3_GUSB3PIPECTL_DEP1P2P3(7)
300 #define DWC3_GUSB3PIPECTL_DEP1P2P3_EN DWC3_GUSB3PIPECTL_DEP1P2P3(1)
301 #define DWC3_GUSB3PIPECTL_DEPOCHANGE BIT(18)
302 #define DWC3_GUSB3PIPECTL_SUSPHY BIT(17)
303 #define DWC3_GUSB3PIPECTL_LFPSFILT BIT(9)
304 #define DWC3_GUSB3PIPECTL_RX_DETOPOLL BIT(8)
305 #define DWC3_GUSB3PIPECTL_TX_DEEPH_MASK DWC3_GUSB3PIPECTL_TX_DEEPH(3)
306 #define DWC3_GUSB3PIPECTL_TX_DEEPH(n) ((n) << 1)
308 /* Global TX Fifo Size Register */
309 #define DWC31_GTXFIFOSIZ_TXFRAMNUM BIT(15) /* DWC_usb31 only */
310 #define DWC31_GTXFIFOSIZ_TXFDEF(n) ((n) & 0x7fff) /* DWC_usb31 only */
311 #define DWC3_GTXFIFOSIZ_TXFDEF(n) ((n) & 0xffff)
312 #define DWC3_GTXFIFOSIZ_TXFSTADDR(n) ((n) & 0xffff0000)
314 /* Global Event Size Registers */
315 #define DWC3_GEVNTSIZ_INTMASK BIT(31)
316 #define DWC3_GEVNTSIZ_SIZE(n) ((n) & 0xffff)
318 /* Global HWPARAMS0 Register */
319 #define DWC3_GHWPARAMS0_MODE(n) ((n) & 0x3)
320 #define DWC3_GHWPARAMS0_MODE_GADGET 0
321 #define DWC3_GHWPARAMS0_MODE_HOST 1
322 #define DWC3_GHWPARAMS0_MODE_DRD 2
323 #define DWC3_GHWPARAMS0_MBUS_TYPE(n) (((n) >> 3) & 0x7)
324 #define DWC3_GHWPARAMS0_SBUS_TYPE(n) (((n) >> 6) & 0x3)
325 #define DWC3_GHWPARAMS0_MDWIDTH(n) (((n) >> 8) & 0xff)
326 #define DWC3_GHWPARAMS0_SDWIDTH(n) (((n) >> 16) & 0xff)
327 #define DWC3_GHWPARAMS0_AWIDTH(n) (((n) >> 24) & 0xff)
329 /* Global HWPARAMS1 Register */
330 #define DWC3_GHWPARAMS1_EN_PWROPT(n) (((n) & (3 << 24)) >> 24)
331 #define DWC3_GHWPARAMS1_EN_PWROPT_NO 0
332 #define DWC3_GHWPARAMS1_EN_PWROPT_CLK 1
333 #define DWC3_GHWPARAMS1_EN_PWROPT_HIB 2
334 #define DWC3_GHWPARAMS1_PWROPT(n) ((n) << 24)
335 #define DWC3_GHWPARAMS1_PWROPT_MASK DWC3_GHWPARAMS1_PWROPT(3)
336 #define DWC3_GHWPARAMS1_ENDBC BIT(31)
338 /* Global HWPARAMS3 Register */
339 #define DWC3_GHWPARAMS3_SSPHY_IFC(n) ((n) & 3)
340 #define DWC3_GHWPARAMS3_SSPHY_IFC_DIS 0
341 #define DWC3_GHWPARAMS3_SSPHY_IFC_GEN1 1
342 #define DWC3_GHWPARAMS3_SSPHY_IFC_GEN2 2 /* DWC_usb31 only */
343 #define DWC3_GHWPARAMS3_HSPHY_IFC(n) (((n) & (3 << 2)) >> 2)
344 #define DWC3_GHWPARAMS3_HSPHY_IFC_DIS 0
345 #define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI 1
346 #define DWC3_GHWPARAMS3_HSPHY_IFC_ULPI 2
347 #define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI_ULPI 3
348 #define DWC3_GHWPARAMS3_FSPHY_IFC(n) (((n) & (3 << 4)) >> 4)
349 #define DWC3_GHWPARAMS3_FSPHY_IFC_DIS 0
350 #define DWC3_GHWPARAMS3_FSPHY_IFC_ENA 1
352 /* Global HWPARAMS4 Register */
353 #define DWC3_GHWPARAMS4_HIBER_SCRATCHBUFS(n) (((n) & (0x0f << 13)) >> 13)
354 #define DWC3_MAX_HIBER_SCRATCHBUFS 15
356 /* Global HWPARAMS6 Register */
357 #define DWC3_GHWPARAMS6_BCSUPPORT BIT(14)
358 #define DWC3_GHWPARAMS6_OTG3SUPPORT BIT(13)
359 #define DWC3_GHWPARAMS6_ADPSUPPORT BIT(12)
360 #define DWC3_GHWPARAMS6_HNPSUPPORT BIT(11)
361 #define DWC3_GHWPARAMS6_SRPSUPPORT BIT(10)
362 #define DWC3_GHWPARAMS6_EN_FPGA BIT(7)
364 /* Global HWPARAMS7 Register */
365 #define DWC3_GHWPARAMS7_RAM1_DEPTH(n) ((n) & 0xffff)
366 #define DWC3_GHWPARAMS7_RAM2_DEPTH(n) (((n) >> 16) & 0xffff)
368 /* Global Frame Length Adjustment Register */
369 #define DWC3_GFLADJ_30MHZ_SDBND_SEL BIT(7)
370 #define DWC3_GFLADJ_30MHZ_MASK 0x3f
372 /* Global User Control Register 2 */
373 #define DWC3_GUCTL2_RST_ACTBITLATER BIT(14)
375 /* Device Configuration Register */
376 #define DWC3_DCFG_DEVADDR(addr) ((addr) << 3)
377 #define DWC3_DCFG_DEVADDR_MASK DWC3_DCFG_DEVADDR(0x7f)
379 #define DWC3_DCFG_SPEED_MASK (7 << 0)
380 #define DWC3_DCFG_SUPERSPEED_PLUS (5 << 0) /* DWC_usb31 only */
381 #define DWC3_DCFG_SUPERSPEED (4 << 0)
382 #define DWC3_DCFG_HIGHSPEED (0 << 0)
383 #define DWC3_DCFG_FULLSPEED BIT(0)
384 #define DWC3_DCFG_LOWSPEED (2 << 0)
386 #define DWC3_DCFG_NUMP_SHIFT 17
387 #define DWC3_DCFG_NUMP(n) (((n) >> DWC3_DCFG_NUMP_SHIFT) & 0x1f)
388 #define DWC3_DCFG_NUMP_MASK (0x1f << DWC3_DCFG_NUMP_SHIFT)
389 #define DWC3_DCFG_LPM_CAP BIT(22)
391 /* Device Control Register */
392 #define DWC3_DCTL_RUN_STOP BIT(31)
393 #define DWC3_DCTL_CSFTRST BIT(30)
394 #define DWC3_DCTL_LSFTRST BIT(29)
396 #define DWC3_DCTL_HIRD_THRES_MASK (0x1f << 24)
397 #define DWC3_DCTL_HIRD_THRES(n) ((n) << 24)
399 #define DWC3_DCTL_APPL1RES BIT(23)
401 /* These apply for core versions 1.87a and earlier */
402 #define DWC3_DCTL_TRGTULST_MASK (0x0f << 17)
403 #define DWC3_DCTL_TRGTULST(n) ((n) << 17)
404 #define DWC3_DCTL_TRGTULST_U2 (DWC3_DCTL_TRGTULST(2))
405 #define DWC3_DCTL_TRGTULST_U3 (DWC3_DCTL_TRGTULST(3))
406 #define DWC3_DCTL_TRGTULST_SS_DIS (DWC3_DCTL_TRGTULST(4))
407 #define DWC3_DCTL_TRGTULST_RX_DET (DWC3_DCTL_TRGTULST(5))
408 #define DWC3_DCTL_TRGTULST_SS_INACT (DWC3_DCTL_TRGTULST(6))
410 /* These apply for core versions 1.94a and later */
411 #define DWC3_DCTL_NYET_THRES(n) (((n) & 0xf) << 20)
413 #define DWC3_DCTL_KEEP_CONNECT BIT(19)
414 #define DWC3_DCTL_L1_HIBER_EN BIT(18)
415 #define DWC3_DCTL_CRS BIT(17)
416 #define DWC3_DCTL_CSS BIT(16)
418 #define DWC3_DCTL_INITU2ENA BIT(12)
419 #define DWC3_DCTL_ACCEPTU2ENA BIT(11)
420 #define DWC3_DCTL_INITU1ENA BIT(10)
421 #define DWC3_DCTL_ACCEPTU1ENA BIT(9)
422 #define DWC3_DCTL_TSTCTRL_MASK (0xf << 1)
424 #define DWC3_DCTL_ULSTCHNGREQ_MASK (0x0f << 5)
425 #define DWC3_DCTL_ULSTCHNGREQ(n) (((n) << 5) & DWC3_DCTL_ULSTCHNGREQ_MASK)
427 #define DWC3_DCTL_ULSTCHNG_NO_ACTION (DWC3_DCTL_ULSTCHNGREQ(0))
428 #define DWC3_DCTL_ULSTCHNG_SS_DISABLED (DWC3_DCTL_ULSTCHNGREQ(4))
429 #define DWC3_DCTL_ULSTCHNG_RX_DETECT (DWC3_DCTL_ULSTCHNGREQ(5))
430 #define DWC3_DCTL_ULSTCHNG_SS_INACTIVE (DWC3_DCTL_ULSTCHNGREQ(6))
431 #define DWC3_DCTL_ULSTCHNG_RECOVERY (DWC3_DCTL_ULSTCHNGREQ(8))
432 #define DWC3_DCTL_ULSTCHNG_COMPLIANCE (DWC3_DCTL_ULSTCHNGREQ(10))
433 #define DWC3_DCTL_ULSTCHNG_LOOPBACK (DWC3_DCTL_ULSTCHNGREQ(11))
435 /* Device Event Enable Register */
436 #define DWC3_DEVTEN_VNDRDEVTSTRCVEDEN BIT(12)
437 #define DWC3_DEVTEN_EVNTOVERFLOWEN BIT(11)
438 #define DWC3_DEVTEN_CMDCMPLTEN BIT(10)
439 #define DWC3_DEVTEN_ERRTICERREN BIT(9)
440 #define DWC3_DEVTEN_SOFEN BIT(7)
441 #define DWC3_DEVTEN_EOPFEN BIT(6)
442 #define DWC3_DEVTEN_HIBERNATIONREQEVTEN BIT(5)
443 #define DWC3_DEVTEN_WKUPEVTEN BIT(4)
444 #define DWC3_DEVTEN_ULSTCNGEN BIT(3)
445 #define DWC3_DEVTEN_CONNECTDONEEN BIT(2)
446 #define DWC3_DEVTEN_USBRSTEN BIT(1)
447 #define DWC3_DEVTEN_DISCONNEVTEN BIT(0)
449 /* Device Status Register */
450 #define DWC3_DSTS_DCNRD BIT(29)
452 /* This applies for core versions 1.87a and earlier */
453 #define DWC3_DSTS_PWRUPREQ BIT(24)
455 /* These apply for core versions 1.94a and later */
456 #define DWC3_DSTS_RSS BIT(25)
457 #define DWC3_DSTS_SSS BIT(24)
459 #define DWC3_DSTS_COREIDLE BIT(23)
460 #define DWC3_DSTS_DEVCTRLHLT BIT(22)
462 #define DWC3_DSTS_USBLNKST_MASK (0x0f << 18)
463 #define DWC3_DSTS_USBLNKST(n) (((n) & DWC3_DSTS_USBLNKST_MASK) >> 18)
465 #define DWC3_DSTS_RXFIFOEMPTY BIT(17)
467 #define DWC3_DSTS_SOFFN_MASK (0x3fff << 3)
468 #define DWC3_DSTS_SOFFN(n) (((n) & DWC3_DSTS_SOFFN_MASK) >> 3)
470 #define DWC3_DSTS_CONNECTSPD (7 << 0)
472 #define DWC3_DSTS_SUPERSPEED_PLUS (5 << 0) /* DWC_usb31 only */
473 #define DWC3_DSTS_SUPERSPEED (4 << 0)
474 #define DWC3_DSTS_HIGHSPEED (0 << 0)
475 #define DWC3_DSTS_FULLSPEED BIT(0)
476 #define DWC3_DSTS_LOWSPEED (2 << 0)
478 /* Device Generic Command Register */
479 #define DWC3_DGCMD_SET_LMP 0x01
480 #define DWC3_DGCMD_SET_PERIODIC_PAR 0x02
481 #define DWC3_DGCMD_XMIT_FUNCTION 0x03
483 /* These apply for core versions 1.94a and later */
484 #define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO 0x04
485 #define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI 0x05
487 #define DWC3_DGCMD_SELECTED_FIFO_FLUSH 0x09
488 #define DWC3_DGCMD_ALL_FIFO_FLUSH 0x0a
489 #define DWC3_DGCMD_SET_ENDPOINT_NRDY 0x0c
490 #define DWC3_DGCMD_RUN_SOC_BUS_LOOPBACK 0x10
492 #define DWC3_DGCMD_STATUS(n) (((n) >> 12) & 0x0F)
493 #define DWC3_DGCMD_CMDACT BIT(10)
494 #define DWC3_DGCMD_CMDIOC BIT(8)
496 /* Device Generic Command Parameter Register */
497 #define DWC3_DGCMDPAR_FORCE_LINKPM_ACCEPT BIT(0)
498 #define DWC3_DGCMDPAR_FIFO_NUM(n) ((n) << 0)
499 #define DWC3_DGCMDPAR_RX_FIFO (0 << 5)
500 #define DWC3_DGCMDPAR_TX_FIFO BIT(5)
501 #define DWC3_DGCMDPAR_LOOPBACK_DIS (0 << 0)
502 #define DWC3_DGCMDPAR_LOOPBACK_ENA BIT(0)
504 /* Device Endpoint Command Register */
505 #define DWC3_DEPCMD_PARAM_SHIFT 16
506 #define DWC3_DEPCMD_PARAM(x) ((x) << DWC3_DEPCMD_PARAM_SHIFT)
507 #define DWC3_DEPCMD_GET_RSC_IDX(x) (((x) >> DWC3_DEPCMD_PARAM_SHIFT) & 0x7f)
508 #define DWC3_DEPCMD_STATUS(x) (((x) >> 12) & 0x0F)
509 #define DWC3_DEPCMD_HIPRI_FORCERM BIT(11)
510 #define DWC3_DEPCMD_CLEARPENDIN BIT(11)
511 #define DWC3_DEPCMD_CMDACT BIT(10)
512 #define DWC3_DEPCMD_CMDIOC BIT(8)
514 #define DWC3_DEPCMD_DEPSTARTCFG (0x09 << 0)
515 #define DWC3_DEPCMD_ENDTRANSFER (0x08 << 0)
516 #define DWC3_DEPCMD_UPDATETRANSFER (0x07 << 0)
517 #define DWC3_DEPCMD_STARTTRANSFER (0x06 << 0)
518 #define DWC3_DEPCMD_CLEARSTALL (0x05 << 0)
519 #define DWC3_DEPCMD_SETSTALL (0x04 << 0)
520 /* This applies for core versions 1.90a and earlier */
521 #define DWC3_DEPCMD_GETSEQNUMBER (0x03 << 0)
522 /* This applies for core versions 1.94a and later */
523 #define DWC3_DEPCMD_GETEPSTATE (0x03 << 0)
524 #define DWC3_DEPCMD_SETTRANSFRESOURCE (0x02 << 0)
525 #define DWC3_DEPCMD_SETEPCONFIG (0x01 << 0)
527 #define DWC3_DEPCMD_CMD(x) ((x) & 0xf)
529 /* The EP number goes 0..31 so ep0 is always out and ep1 is always in */
530 #define DWC3_DALEPENA_EP(n) BIT(n)
532 #define DWC3_DEPCMD_TYPE_CONTROL 0
533 #define DWC3_DEPCMD_TYPE_ISOC 1
534 #define DWC3_DEPCMD_TYPE_BULK 2
535 #define DWC3_DEPCMD_TYPE_INTR 3
537 #define DWC3_DEV_IMOD_COUNT_SHIFT 16
538 #define DWC3_DEV_IMOD_COUNT_MASK (0xffff << 16)
539 #define DWC3_DEV_IMOD_INTERVAL_SHIFT 0
540 #define DWC3_DEV_IMOD_INTERVAL_MASK (0xffff << 0)
542 /* OTG Configuration Register */
543 #define DWC3_OCFG_DISPWRCUTTOFF BIT(5)
544 #define DWC3_OCFG_HIBDISMASK BIT(4)
545 #define DWC3_OCFG_SFTRSTMASK BIT(3)
546 #define DWC3_OCFG_OTGVERSION BIT(2)
547 #define DWC3_OCFG_HNPCAP BIT(1)
548 #define DWC3_OCFG_SRPCAP BIT(0)
550 /* OTG CTL Register */
551 #define DWC3_OCTL_OTG3GOERR BIT(7)
552 #define DWC3_OCTL_PERIMODE BIT(6)
553 #define DWC3_OCTL_PRTPWRCTL BIT(5)
554 #define DWC3_OCTL_HNPREQ BIT(4)
555 #define DWC3_OCTL_SESREQ BIT(3)
556 #define DWC3_OCTL_TERMSELIDPULSE BIT(2)
557 #define DWC3_OCTL_DEVSETHNPEN BIT(1)
558 #define DWC3_OCTL_HSTSETHNPEN BIT(0)
560 /* OTG Event Register */
561 #define DWC3_OEVT_DEVICEMODE BIT(31)
562 #define DWC3_OEVT_XHCIRUNSTPSET BIT(27)
563 #define DWC3_OEVT_DEVRUNSTPSET BIT(26)
564 #define DWC3_OEVT_HIBENTRY BIT(25)
565 #define DWC3_OEVT_CONIDSTSCHNG BIT(24)
566 #define DWC3_OEVT_HRRCONFNOTIF BIT(23)
567 #define DWC3_OEVT_HRRINITNOTIF BIT(22)
568 #define DWC3_OEVT_ADEVIDLE BIT(21)
569 #define DWC3_OEVT_ADEVBHOSTEND BIT(20)
570 #define DWC3_OEVT_ADEVHOST BIT(19)
571 #define DWC3_OEVT_ADEVHNPCHNG BIT(18)
572 #define DWC3_OEVT_ADEVSRPDET BIT(17)
573 #define DWC3_OEVT_ADEVSESSENDDET BIT(16)
574 #define DWC3_OEVT_BDEVBHOSTEND BIT(11)
575 #define DWC3_OEVT_BDEVHNPCHNG BIT(10)
576 #define DWC3_OEVT_BDEVSESSVLDDET BIT(9)
577 #define DWC3_OEVT_BDEVVBUSCHNG BIT(8)
578 #define DWC3_OEVT_BSESSVLD BIT(3)
579 #define DWC3_OEVT_HSTNEGSTS BIT(2)
580 #define DWC3_OEVT_SESREQSTS BIT(1)
581 #define DWC3_OEVT_ERROR BIT(0)
583 /* OTG Event Enable Register */
584 #define DWC3_OEVTEN_XHCIRUNSTPSETEN BIT(27)
585 #define DWC3_OEVTEN_DEVRUNSTPSETEN BIT(26)
586 #define DWC3_OEVTEN_HIBENTRYEN BIT(25)
587 #define DWC3_OEVTEN_CONIDSTSCHNGEN BIT(24)
588 #define DWC3_OEVTEN_HRRCONFNOTIFEN BIT(23)
589 #define DWC3_OEVTEN_HRRINITNOTIFEN BIT(22)
590 #define DWC3_OEVTEN_ADEVIDLEEN BIT(21)
591 #define DWC3_OEVTEN_ADEVBHOSTENDEN BIT(20)
592 #define DWC3_OEVTEN_ADEVHOSTEN BIT(19)
593 #define DWC3_OEVTEN_ADEVHNPCHNGEN BIT(18)
594 #define DWC3_OEVTEN_ADEVSRPDETEN BIT(17)
595 #define DWC3_OEVTEN_ADEVSESSENDDETEN BIT(16)
596 #define DWC3_OEVTEN_BDEVBHOSTENDEN BIT(11)
597 #define DWC3_OEVTEN_BDEVHNPCHNGEN BIT(10)
598 #define DWC3_OEVTEN_BDEVSESSVLDDETEN BIT(9)
599 #define DWC3_OEVTEN_BDEVVBUSCHNGEN BIT(8)
601 /* OTG Status Register */
602 #define DWC3_OSTS_DEVRUNSTP BIT(13)
603 #define DWC3_OSTS_XHCIRUNSTP BIT(12)
604 #define DWC3_OSTS_PERIPHERALSTATE BIT(4)
605 #define DWC3_OSTS_XHCIPRTPOWER BIT(3)
606 #define DWC3_OSTS_BSESVLD BIT(2)
607 #define DWC3_OSTS_VBUSVLD BIT(1)
608 #define DWC3_OSTS_CONIDSTS BIT(0)
615 * struct dwc3_event_buffer - Software event buffer representation
617 * @cache: The buffer cache used in the threaded interrupt
618 * @length: size of this buffer
619 * @lpos: event offset
620 * @count: cache of last read event count register
621 * @flags: flags related to this event buffer
623 * @dwc: pointer to DWC controller
625 struct dwc3_event_buffer
{
633 #define DWC3_EVENT_PENDING BIT(0)
640 #define DWC3_EP_FLAG_STALLED BIT(0)
641 #define DWC3_EP_FLAG_WEDGED BIT(1)
643 #define DWC3_EP_DIRECTION_TX true
644 #define DWC3_EP_DIRECTION_RX false
646 #define DWC3_TRB_NUM 256
649 * struct dwc3_ep - device side endpoint representation
650 * @endpoint: usb endpoint
651 * @cancelled_list: list of cancelled requests for this endpoint
652 * @pending_list: list of pending requests for this endpoint
653 * @started_list: list of started requests on this endpoint
654 * @regs: pointer to first endpoint register
655 * @trb_pool: array of transaction buffers
656 * @trb_pool_dma: dma address of @trb_pool
657 * @trb_enqueue: enqueue 'pointer' into TRB array
658 * @trb_dequeue: dequeue 'pointer' into TRB array
659 * @dwc: pointer to DWC controller
660 * @saved_state: ep state saved during hibernation
661 * @flags: endpoint flags (wedged, stalled, ...)
662 * @number: endpoint number (1 - 15)
663 * @type: set to bmAttributes & USB_ENDPOINT_XFERTYPE_MASK
664 * @resource_index: Resource transfer index
665 * @frame_number: set to the frame number we want this transfer to start (ISOC)
666 * @interval: the interval on which the ISOC transfer is started
667 * @name: a human readable name e.g. ep1out-bulk
668 * @direction: true for TX, false for RX
669 * @stream_capable: true when streams are enabled
670 * @combo_num: the test combination BIT[15:14] of the frame number to test
671 * isochronous START TRANSFER command failure workaround
672 * @start_cmd_status: the status of testing START TRANSFER command with
676 struct usb_ep endpoint
;
677 struct list_head cancelled_list
;
678 struct list_head pending_list
;
679 struct list_head started_list
;
683 struct dwc3_trb
*trb_pool
;
684 dma_addr_t trb_pool_dma
;
689 #define DWC3_EP_ENABLED BIT(0)
690 #define DWC3_EP_STALL BIT(1)
691 #define DWC3_EP_WEDGE BIT(2)
692 #define DWC3_EP_TRANSFER_STARTED BIT(3)
693 #define DWC3_EP_END_TRANSFER_PENDING BIT(4)
694 #define DWC3_EP_PENDING_REQUEST BIT(5)
695 #define DWC3_EP_DELAY_START BIT(6)
697 /* This last one is specific to EP0 */
698 #define DWC3_EP0_DIR_IN BIT(31)
701 * IMPORTANT: we *know* we have 256 TRBs in our @trb_pool, so we will
702 * use a u8 type here. If anybody decides to increase number of TRBs to
703 * anything larger than 256 - I can't see why people would want to do
704 * this though - then this type needs to be changed.
706 * By using u8 types we ensure that our % operator when incrementing
707 * enqueue and dequeue get optimized away by the compiler.
720 unsigned direction
:1;
721 unsigned stream_capable
:1;
723 /* For isochronous START TRANSFER workaround only */
725 int start_cmd_status
;
729 DWC3_PHY_UNKNOWN
= 0,
735 DWC3_EP0_UNKNOWN
= 0,
738 DWC3_EP0_NRDY_STATUS
,
741 enum dwc3_ep0_state
{
748 enum dwc3_link_state
{
750 DWC3_LINK_STATE_U0
= 0x00, /* in HS, means ON */
751 DWC3_LINK_STATE_U1
= 0x01,
752 DWC3_LINK_STATE_U2
= 0x02, /* in HS, means SLEEP */
753 DWC3_LINK_STATE_U3
= 0x03, /* in HS, means SUSPEND */
754 DWC3_LINK_STATE_SS_DIS
= 0x04,
755 DWC3_LINK_STATE_RX_DET
= 0x05, /* in HS, means Early Suspend */
756 DWC3_LINK_STATE_SS_INACT
= 0x06,
757 DWC3_LINK_STATE_POLL
= 0x07,
758 DWC3_LINK_STATE_RECOV
= 0x08,
759 DWC3_LINK_STATE_HRESET
= 0x09,
760 DWC3_LINK_STATE_CMPLY
= 0x0a,
761 DWC3_LINK_STATE_LPBK
= 0x0b,
762 DWC3_LINK_STATE_RESET
= 0x0e,
763 DWC3_LINK_STATE_RESUME
= 0x0f,
764 DWC3_LINK_STATE_MASK
= 0x0f,
767 /* TRB Length, PCM and Status */
768 #define DWC3_TRB_SIZE_MASK (0x00ffffff)
769 #define DWC3_TRB_SIZE_LENGTH(n) ((n) & DWC3_TRB_SIZE_MASK)
770 #define DWC3_TRB_SIZE_PCM1(n) (((n) & 0x03) << 24)
771 #define DWC3_TRB_SIZE_TRBSTS(n) (((n) & (0x0f << 28)) >> 28)
773 #define DWC3_TRBSTS_OK 0
774 #define DWC3_TRBSTS_MISSED_ISOC 1
775 #define DWC3_TRBSTS_SETUP_PENDING 2
776 #define DWC3_TRB_STS_XFER_IN_PROG 4
779 #define DWC3_TRB_CTRL_HWO BIT(0)
780 #define DWC3_TRB_CTRL_LST BIT(1)
781 #define DWC3_TRB_CTRL_CHN BIT(2)
782 #define DWC3_TRB_CTRL_CSP BIT(3)
783 #define DWC3_TRB_CTRL_TRBCTL(n) (((n) & 0x3f) << 4)
784 #define DWC3_TRB_CTRL_ISP_IMI BIT(10)
785 #define DWC3_TRB_CTRL_IOC BIT(11)
786 #define DWC3_TRB_CTRL_SID_SOFN(n) (((n) & 0xffff) << 14)
787 #define DWC3_TRB_CTRL_GET_SID_SOFN(n) (((n) & (0xffff << 14)) >> 14)
789 #define DWC3_TRBCTL_TYPE(n) ((n) & (0x3f << 4))
790 #define DWC3_TRBCTL_NORMAL DWC3_TRB_CTRL_TRBCTL(1)
791 #define DWC3_TRBCTL_CONTROL_SETUP DWC3_TRB_CTRL_TRBCTL(2)
792 #define DWC3_TRBCTL_CONTROL_STATUS2 DWC3_TRB_CTRL_TRBCTL(3)
793 #define DWC3_TRBCTL_CONTROL_STATUS3 DWC3_TRB_CTRL_TRBCTL(4)
794 #define DWC3_TRBCTL_CONTROL_DATA DWC3_TRB_CTRL_TRBCTL(5)
795 #define DWC3_TRBCTL_ISOCHRONOUS_FIRST DWC3_TRB_CTRL_TRBCTL(6)
796 #define DWC3_TRBCTL_ISOCHRONOUS DWC3_TRB_CTRL_TRBCTL(7)
797 #define DWC3_TRBCTL_LINK_TRB DWC3_TRB_CTRL_TRBCTL(8)
800 * struct dwc3_trb - transfer request block (hw format)
814 * struct dwc3_hwparams - copy of HWPARAMS registers
815 * @hwparams0: GHWPARAMS0
816 * @hwparams1: GHWPARAMS1
817 * @hwparams2: GHWPARAMS2
818 * @hwparams3: GHWPARAMS3
819 * @hwparams4: GHWPARAMS4
820 * @hwparams5: GHWPARAMS5
821 * @hwparams6: GHWPARAMS6
822 * @hwparams7: GHWPARAMS7
823 * @hwparams8: GHWPARAMS8
825 struct dwc3_hwparams
{
838 #define DWC3_MODE(n) ((n) & 0x7)
840 #define DWC3_MDWIDTH(n) (((n) & 0xff00) >> 8)
843 #define DWC3_NUM_INT(n) (((n) & (0x3f << 15)) >> 15)
846 #define DWC3_NUM_IN_EPS_MASK (0x1f << 18)
847 #define DWC3_NUM_EPS_MASK (0x3f << 12)
848 #define DWC3_NUM_EPS(p) (((p)->hwparams3 & \
849 (DWC3_NUM_EPS_MASK)) >> 12)
850 #define DWC3_NUM_IN_EPS(p) (((p)->hwparams3 & \
851 (DWC3_NUM_IN_EPS_MASK)) >> 18)
854 #define DWC3_RAM1_DEPTH(n) ((n) & 0xffff)
857 * struct dwc3_request - representation of a transfer request
858 * @request: struct usb_request to be transferred
859 * @list: a list_head used for request queueing
860 * @dep: struct dwc3_ep owning this request
861 * @sg: pointer to first incomplete sg
862 * @start_sg: pointer to the sg which should be queued next
863 * @num_pending_sgs: counter to pending sgs
864 * @num_queued_sgs: counter to the number of sgs which already got queued
865 * @remaining: amount of data remaining
866 * @status: internal dwc3 request status tracking
867 * @epnum: endpoint number to which this request refers
868 * @trb: pointer to struct dwc3_trb
869 * @trb_dma: DMA address of @trb
870 * @num_trbs: number of TRBs used by this request
871 * @needs_extra_trb: true when request needs one extra TRB (either due to ZLP
873 * @direction: IN or OUT direction flag
874 * @mapped: true when request has been dma-mapped
876 struct dwc3_request
{
877 struct usb_request request
;
878 struct list_head list
;
880 struct scatterlist
*sg
;
881 struct scatterlist
*start_sg
;
883 unsigned num_pending_sgs
;
884 unsigned int num_queued_sgs
;
888 #define DWC3_REQUEST_STATUS_QUEUED 0
889 #define DWC3_REQUEST_STATUS_STARTED 1
890 #define DWC3_REQUEST_STATUS_CANCELLED 2
891 #define DWC3_REQUEST_STATUS_COMPLETED 3
892 #define DWC3_REQUEST_STATUS_UNKNOWN -1
895 struct dwc3_trb
*trb
;
900 unsigned needs_extra_trb
:1;
901 unsigned direction
:1;
906 * struct dwc3_scratchpad_array - hibernation scratchpad array
907 * (format defined by hw)
909 struct dwc3_scratchpad_array
{
910 __le64 dma_adr
[DWC3_MAX_HIBER_SCRATCHBUFS
];
914 * struct dwc3 - representation of our controller
915 * @drd_work: workqueue used for role swapping
916 * @ep0_trb: trb which is used for the ctrl_req
917 * @bounce: address of bounce buffer
918 * @scratchbuf: address of scratch buffer
919 * @setup_buf: used while precessing STD USB requests
920 * @ep0_trb_addr: dma address of @ep0_trb
921 * @bounce_addr: dma address of @bounce
922 * @ep0_usb_req: dummy req used while handling STD USB requests
923 * @scratch_addr: dma address of scratchbuf
924 * @ep0_in_setup: one control transfer is completed and enter setup phase
925 * @lock: for synchronizing
926 * @dev: pointer to our struct device
927 * @sysdev: pointer to the DMA-capable device
928 * @xhci: pointer to our xHCI child
929 * @xhci_resources: struct resources for our @xhci child
930 * @ev_buf: struct dwc3_event_buffer pointer
931 * @eps: endpoint array
932 * @gadget: device side representation of the peripheral controller
933 * @gadget_driver: pointer to the gadget driver
934 * @clks: array of clocks
935 * @num_clks: number of clocks
936 * @reset: reset control
937 * @regs: base address for our registers
938 * @regs_size: address space size
939 * @fladj: frame length adjustment
940 * @irq_gadget: peripheral controller's IRQ number
941 * @otg_irq: IRQ number for OTG IRQs
942 * @current_otg_role: current role of operation while using the OTG block
943 * @desired_otg_role: desired role of operation while using the OTG block
944 * @otg_restart_host: flag that OTG controller needs to restart host
945 * @nr_scratch: number of scratch buffers
946 * @u1u2: only used on revisions <1.83a for workaround
947 * @maximum_speed: maximum speed requested (mainly for testing purposes)
948 * @revision: revision register contents
949 * @version_type: VERSIONTYPE register contents, a sub release of a revision
950 * @dr_mode: requested mode of operation
951 * @current_dr_role: current role of operation when in dual-role mode
952 * @desired_dr_role: desired role of operation when in dual-role mode
953 * @edev: extcon handle
954 * @edev_nb: extcon notifier
955 * @hsphy_mode: UTMI phy mode, one of following:
956 * - USBPHY_INTERFACE_MODE_UTMI
957 * - USBPHY_INTERFACE_MODE_UTMIW
958 * @role_sw: usb_role_switch handle
959 * @role_switch_default_mode: default operation mode of controller while
960 * usb role is USB_ROLE_NONE.
961 * @usb2_phy: pointer to USB2 PHY
962 * @usb3_phy: pointer to USB3 PHY
963 * @usb2_generic_phy: pointer to USB2 PHY
964 * @usb3_generic_phy: pointer to USB3 PHY
965 * @phys_ready: flag to indicate that PHYs are ready
966 * @ulpi: pointer to ulpi interface
967 * @ulpi_ready: flag to indicate that ULPI is initialized
968 * @u2sel: parameter from Set SEL request.
969 * @u2pel: parameter from Set SEL request.
970 * @u1sel: parameter from Set SEL request.
971 * @u1pel: parameter from Set SEL request.
972 * @num_eps: number of endpoints
973 * @ep0_next_event: hold the next expected event
974 * @ep0state: state of endpoint zero
975 * @link_state: link state
976 * @speed: device speed (super, high, full, low)
977 * @hwparams: copy of hwparams registers
978 * @root: debugfs root folder pointer
979 * @regset: debugfs pointer to regdump file
980 * @dbg_lsp_select: current debug lsp mux register selection
981 * @test_mode: true when we're entering a USB test mode
982 * @test_mode_nr: test feature selector
983 * @lpm_nyet_threshold: LPM NYET response threshold
984 * @hird_threshold: HIRD threshold
985 * @rx_thr_num_pkt_prd: periodic ESS receive packet count
986 * @rx_max_burst_prd: max periodic ESS receive burst size
987 * @tx_thr_num_pkt_prd: periodic ESS transmit packet count
988 * @tx_max_burst_prd: max periodic ESS transmit burst size
989 * @hsphy_interface: "utmi" or "ulpi"
990 * @connected: true when we're connected to a host, false otherwise
991 * @delayed_status: true when gadget driver asks for delayed status
992 * @ep0_bounced: true when we used bounce buffer
993 * @ep0_expect_in: true when we expect a DATA IN transfer
994 * @has_hibernation: true when dwc3 was configured with Hibernation
995 * @sysdev_is_parent: true when dwc3 device has a parent driver
996 * @has_lpm_erratum: true when core was configured with LPM Erratum. Note that
997 * there's now way for software to detect this in runtime.
998 * @is_utmi_l1_suspend: the core asserts output signal
1000 * 1 - utmi_l1_suspend_n
1001 * @is_fpga: true when we are using the FPGA board
1002 * @pending_events: true when we have pending IRQs to be handled
1003 * @pullups_connected: true when Run/Stop bit is set
1004 * @setup_packet_pending: true when there's a Setup Packet in FIFO. Workaround
1005 * @three_stage_setup: set if we perform a three phase setup
1006 * @dis_start_transfer_quirk: set if start_transfer failure SW workaround is
1007 * not needed for DWC_usb31 version 1.70a-ea06 and below
1008 * @usb3_lpm_capable: set if hadrware supports Link Power Management
1009 * @usb2_lpm_disable: set to disable usb2 lpm
1010 * @disable_scramble_quirk: set if we enable the disable scramble quirk
1011 * @u2exit_lfps_quirk: set if we enable u2exit lfps quirk
1012 * @u2ss_inp3_quirk: set if we enable P3 OK for U2/SS Inactive quirk
1013 * @req_p1p2p3_quirk: set if we enable request p1p2p3 quirk
1014 * @del_p1p2p3_quirk: set if we enable delay p1p2p3 quirk
1015 * @del_phy_power_chg_quirk: set if we enable delay phy power change quirk
1016 * @lfps_filter_quirk: set if we enable LFPS filter quirk
1017 * @rx_detect_poll_quirk: set if we enable rx_detect to polling lfps quirk
1018 * @dis_u3_susphy_quirk: set if we disable usb3 suspend phy
1019 * @dis_u2_susphy_quirk: set if we disable usb2 suspend phy
1020 * @dis_enblslpm_quirk: set if we clear enblslpm in GUSB2PHYCFG,
1021 * disabling the suspend signal to the PHY.
1022 * @dis_u1_entry_quirk: set if link entering into U1 state needs to be disabled.
1023 * @dis_u2_entry_quirk: set if link entering into U2 state needs to be disabled.
1024 * @dis_rxdet_inp3_quirk: set if we disable Rx.Detect in P3
1025 * @dis_u2_freeclk_exists_quirk : set if we clear u2_freeclk_exists
1026 * in GUSB2PHYCFG, specify that USB2 PHY doesn't
1027 * provide a free-running PHY clock.
1028 * @dis_del_phy_power_chg_quirk: set if we disable delay phy power
1030 * @dis_tx_ipgap_linecheck_quirk: set if we disable u2mac linestate
1031 * check during HS transmit.
1032 * @parkmode_disable_ss_quirk: set if we need to disable all SuperSpeed
1033 * instances in park mode.
1034 * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
1035 * @tx_de_emphasis: Tx de-emphasis value
1036 * 0 - -6dB de-emphasis
1037 * 1 - -3.5dB de-emphasis
1038 * 2 - No de-emphasis
1040 * @dis_metastability_quirk: set to disable metastability quirk.
1041 * @imod_interval: set the interrupt moderation interval in 250ns
1042 * increments or 0 to disable.
1045 struct work_struct drd_work
;
1046 struct dwc3_trb
*ep0_trb
;
1050 dma_addr_t ep0_trb_addr
;
1051 dma_addr_t bounce_addr
;
1052 dma_addr_t scratch_addr
;
1053 struct dwc3_request ep0_usb_req
;
1054 struct completion ep0_in_setup
;
1060 struct device
*sysdev
;
1062 struct platform_device
*xhci
;
1063 struct resource xhci_resources
[DWC3_XHCI_RESOURCES_NUM
];
1065 struct dwc3_event_buffer
*ev_buf
;
1066 struct dwc3_ep
*eps
[DWC3_ENDPOINTS_NUM
];
1068 struct usb_gadget gadget
;
1069 struct usb_gadget_driver
*gadget_driver
;
1071 struct clk_bulk_data
*clks
;
1074 struct reset_control
*reset
;
1076 struct usb_phy
*usb2_phy
;
1077 struct usb_phy
*usb3_phy
;
1079 struct phy
*usb2_generic_phy
;
1080 struct phy
*usb3_generic_phy
;
1090 enum usb_dr_mode dr_mode
;
1091 u32 current_dr_role
;
1092 u32 desired_dr_role
;
1093 struct extcon_dev
*edev
;
1094 struct notifier_block edev_nb
;
1095 enum usb_phy_interface hsphy_mode
;
1096 struct usb_role_switch
*role_sw
;
1097 enum usb_dr_mode role_switch_default_mode
;
1102 u32 current_otg_role
;
1103 u32 desired_otg_role
;
1104 bool otg_restart_host
;
1110 * All 3.1 IP version constants are greater than the 3.0 IP
1111 * version constants. This works for most version checks in
1112 * dwc3. However, in the future, this may not apply as
1113 * features may be developed on newer versions of the 3.0 IP
1114 * that are not in the 3.1 IP.
1118 #define DWC3_REVISION_173A 0x5533173a
1119 #define DWC3_REVISION_175A 0x5533175a
1120 #define DWC3_REVISION_180A 0x5533180a
1121 #define DWC3_REVISION_183A 0x5533183a
1122 #define DWC3_REVISION_185A 0x5533185a
1123 #define DWC3_REVISION_187A 0x5533187a
1124 #define DWC3_REVISION_188A 0x5533188a
1125 #define DWC3_REVISION_190A 0x5533190a
1126 #define DWC3_REVISION_194A 0x5533194a
1127 #define DWC3_REVISION_200A 0x5533200a
1128 #define DWC3_REVISION_202A 0x5533202a
1129 #define DWC3_REVISION_210A 0x5533210a
1130 #define DWC3_REVISION_220A 0x5533220a
1131 #define DWC3_REVISION_230A 0x5533230a
1132 #define DWC3_REVISION_240A 0x5533240a
1133 #define DWC3_REVISION_250A 0x5533250a
1134 #define DWC3_REVISION_260A 0x5533260a
1135 #define DWC3_REVISION_270A 0x5533270a
1136 #define DWC3_REVISION_280A 0x5533280a
1137 #define DWC3_REVISION_290A 0x5533290a
1138 #define DWC3_REVISION_300A 0x5533300a
1139 #define DWC3_REVISION_310A 0x5533310a
1140 #define DWC3_REVISION_330A 0x5533330a
1143 * NOTICE: we're using bit 31 as a "is usb 3.1" flag. This is really
1144 * just so dwc31 revisions are always larger than dwc3.
1146 #define DWC3_REVISION_IS_DWC31 0x80000000
1147 #define DWC3_USB31_REVISION_110A (0x3131302a | DWC3_REVISION_IS_DWC31)
1148 #define DWC3_USB31_REVISION_120A (0x3132302a | DWC3_REVISION_IS_DWC31)
1149 #define DWC3_USB31_REVISION_160A (0x3136302a | DWC3_REVISION_IS_DWC31)
1150 #define DWC3_USB31_REVISION_170A (0x3137302a | DWC3_REVISION_IS_DWC31)
1151 #define DWC3_USB31_REVISION_180A (0x3138302a | DWC3_REVISION_IS_DWC31)
1152 #define DWC3_USB31_REVISION_190A (0x3139302a | DWC3_REVISION_IS_DWC31)
1156 #define DWC31_VERSIONTYPE_EA01 0x65613031
1157 #define DWC31_VERSIONTYPE_EA02 0x65613032
1158 #define DWC31_VERSIONTYPE_EA03 0x65613033
1159 #define DWC31_VERSIONTYPE_EA04 0x65613034
1160 #define DWC31_VERSIONTYPE_EA05 0x65613035
1161 #define DWC31_VERSIONTYPE_EA06 0x65613036
1163 enum dwc3_ep0_next ep0_next_event
;
1164 enum dwc3_ep0_state ep0state
;
1165 enum dwc3_link_state link_state
;
1176 struct dwc3_hwparams hwparams
;
1177 struct dentry
*root
;
1178 struct debugfs_regset32
*regset
;
1184 u8 lpm_nyet_threshold
;
1186 u8 rx_thr_num_pkt_prd
;
1187 u8 rx_max_burst_prd
;
1188 u8 tx_thr_num_pkt_prd
;
1189 u8 tx_max_burst_prd
;
1191 const char *hsphy_interface
;
1193 unsigned connected
:1;
1194 unsigned delayed_status
:1;
1195 unsigned ep0_bounced
:1;
1196 unsigned ep0_expect_in
:1;
1197 unsigned has_hibernation
:1;
1198 unsigned sysdev_is_parent
:1;
1199 unsigned has_lpm_erratum
:1;
1200 unsigned is_utmi_l1_suspend
:1;
1202 unsigned pending_events
:1;
1203 unsigned pullups_connected
:1;
1204 unsigned setup_packet_pending
:1;
1205 unsigned three_stage_setup
:1;
1206 unsigned dis_start_transfer_quirk
:1;
1207 unsigned usb3_lpm_capable
:1;
1208 unsigned usb2_lpm_disable
:1;
1210 unsigned disable_scramble_quirk
:1;
1211 unsigned u2exit_lfps_quirk
:1;
1212 unsigned u2ss_inp3_quirk
:1;
1213 unsigned req_p1p2p3_quirk
:1;
1214 unsigned del_p1p2p3_quirk
:1;
1215 unsigned del_phy_power_chg_quirk
:1;
1216 unsigned lfps_filter_quirk
:1;
1217 unsigned rx_detect_poll_quirk
:1;
1218 unsigned dis_u3_susphy_quirk
:1;
1219 unsigned dis_u2_susphy_quirk
:1;
1220 unsigned dis_enblslpm_quirk
:1;
1221 unsigned dis_u1_entry_quirk
:1;
1222 unsigned dis_u2_entry_quirk
:1;
1223 unsigned dis_rxdet_inp3_quirk
:1;
1224 unsigned dis_u2_freeclk_exists_quirk
:1;
1225 unsigned dis_del_phy_power_chg_quirk
:1;
1226 unsigned dis_tx_ipgap_linecheck_quirk
:1;
1227 unsigned parkmode_disable_ss_quirk
:1;
1229 unsigned tx_de_emphasis_quirk
:1;
1230 unsigned tx_de_emphasis
:2;
1232 unsigned dis_metastability_quirk
:1;
1237 #define INCRX_BURST_MODE 0
1238 #define INCRX_UNDEF_LENGTH_BURST_MODE 1
1240 #define work_to_dwc(w) (container_of((w), struct dwc3, drd_work))
1242 /* -------------------------------------------------------------------------- */
1244 struct dwc3_event_type
{
1247 u32 reserved8_31
:24;
1250 #define DWC3_DEPEVT_XFERCOMPLETE 0x01
1251 #define DWC3_DEPEVT_XFERINPROGRESS 0x02
1252 #define DWC3_DEPEVT_XFERNOTREADY 0x03
1253 #define DWC3_DEPEVT_RXTXFIFOEVT 0x04
1254 #define DWC3_DEPEVT_STREAMEVT 0x06
1255 #define DWC3_DEPEVT_EPCMDCMPLT 0x07
1258 * struct dwc3_event_depvt - Device Endpoint Events
1259 * @one_bit: indicates this is an endpoint event (not used)
1260 * @endpoint_number: number of the endpoint
1261 * @endpoint_event: The event we have:
1263 * 0x01 - XferComplete
1264 * 0x02 - XferInProgress
1265 * 0x03 - XferNotReady
1266 * 0x04 - RxTxFifoEvt (IN->Underrun, OUT->Overrun)
1270 * @reserved11_10: Reserved, don't use.
1271 * @status: Indicates the status of the event. Refer to databook for
1273 * @parameters: Parameters of the current event. Refer to databook for
1276 struct dwc3_event_depevt
{
1278 u32 endpoint_number
:5;
1279 u32 endpoint_event
:4;
1280 u32 reserved11_10
:2;
1283 /* Within XferNotReady */
1284 #define DEPEVT_STATUS_TRANSFER_ACTIVE BIT(3)
1286 /* Within XferComplete or XferInProgress */
1287 #define DEPEVT_STATUS_BUSERR BIT(0)
1288 #define DEPEVT_STATUS_SHORT BIT(1)
1289 #define DEPEVT_STATUS_IOC BIT(2)
1290 #define DEPEVT_STATUS_LST BIT(3) /* XferComplete */
1291 #define DEPEVT_STATUS_MISSED_ISOC BIT(3) /* XferInProgress */
1293 /* Stream event only */
1294 #define DEPEVT_STREAMEVT_FOUND 1
1295 #define DEPEVT_STREAMEVT_NOTFOUND 2
1297 /* Control-only Status */
1298 #define DEPEVT_STATUS_CONTROL_DATA 1
1299 #define DEPEVT_STATUS_CONTROL_STATUS 2
1300 #define DEPEVT_STATUS_CONTROL_PHASE(n) ((n) & 3)
1302 /* In response to Start Transfer */
1303 #define DEPEVT_TRANSFER_NO_RESOURCE 1
1304 #define DEPEVT_TRANSFER_BUS_EXPIRY 2
1308 /* For Command Complete Events */
1309 #define DEPEVT_PARAMETER_CMD(n) (((n) & (0xf << 8)) >> 8)
1313 * struct dwc3_event_devt - Device Events
1314 * @one_bit: indicates this is a non-endpoint event (not used)
1315 * @device_event: indicates it's a device event. Should read as 0x00
1316 * @type: indicates the type of device event.
1329 * 12 - VndrDevTstRcved
1330 * @reserved15_12: Reserved, not used
1331 * @event_info: Information about this event
1332 * @reserved31_25: Reserved, not used
1334 struct dwc3_event_devt
{
1338 u32 reserved15_12
:4;
1340 u32 reserved31_25
:7;
1344 * struct dwc3_event_gevt - Other Core Events
1345 * @one_bit: indicates this is a non-endpoint event (not used)
1346 * @device_event: indicates it's (0x03) Carkit or (0x04) I2C event.
1347 * @phy_port_number: self-explanatory
1348 * @reserved31_12: Reserved, not used.
1350 struct dwc3_event_gevt
{
1353 u32 phy_port_number
:4;
1354 u32 reserved31_12
:20;
1358 * union dwc3_event - representation of Event Buffer contents
1359 * @raw: raw 32-bit event
1360 * @type: the type of the event
1361 * @depevt: Device Endpoint Event
1362 * @devt: Device Event
1363 * @gevt: Global Event
1367 struct dwc3_event_type type
;
1368 struct dwc3_event_depevt depevt
;
1369 struct dwc3_event_devt devt
;
1370 struct dwc3_event_gevt gevt
;
1374 * struct dwc3_gadget_ep_cmd_params - representation of endpoint command
1376 * @param2: third parameter
1377 * @param1: second parameter
1378 * @param0: first parameter
1380 struct dwc3_gadget_ep_cmd_params
{
1387 * DWC3 Features to be used as Driver Data
1390 #define DWC3_HAS_PERIPHERAL BIT(0)
1391 #define DWC3_HAS_XHCI BIT(1)
1392 #define DWC3_HAS_OTG BIT(3)
1395 void dwc3_set_prtcap(struct dwc3
*dwc
, u32 mode
);
1396 void dwc3_set_mode(struct dwc3
*dwc
, u32 mode
);
1397 u32
dwc3_core_fifo_space(struct dwc3_ep
*dep
, u8 type
);
1399 /* check whether we are on the DWC_usb3 core */
1400 static inline bool dwc3_is_usb3(struct dwc3
*dwc
)
1402 return !(dwc
->revision
& DWC3_REVISION_IS_DWC31
);
1405 /* check whether we are on the DWC_usb31 core */
1406 static inline bool dwc3_is_usb31(struct dwc3
*dwc
)
1408 return !!(dwc
->revision
& DWC3_REVISION_IS_DWC31
);
1411 bool dwc3_has_imod(struct dwc3
*dwc
);
1413 int dwc3_event_buffers_setup(struct dwc3
*dwc
);
1414 void dwc3_event_buffers_cleanup(struct dwc3
*dwc
);
1416 #if IS_ENABLED(CONFIG_USB_DWC3_HOST) || IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
1417 int dwc3_host_init(struct dwc3
*dwc
);
1418 void dwc3_host_exit(struct dwc3
*dwc
);
1420 static inline int dwc3_host_init(struct dwc3
*dwc
)
1422 static inline void dwc3_host_exit(struct dwc3
*dwc
)
1426 #if IS_ENABLED(CONFIG_USB_DWC3_GADGET) || IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
1427 int dwc3_gadget_init(struct dwc3
*dwc
);
1428 void dwc3_gadget_exit(struct dwc3
*dwc
);
1429 int dwc3_gadget_set_test_mode(struct dwc3
*dwc
, int mode
);
1430 int dwc3_gadget_get_link_state(struct dwc3
*dwc
);
1431 int dwc3_gadget_set_link_state(struct dwc3
*dwc
, enum dwc3_link_state state
);
1432 int dwc3_send_gadget_ep_cmd(struct dwc3_ep
*dep
, unsigned cmd
,
1433 struct dwc3_gadget_ep_cmd_params
*params
);
1434 int dwc3_send_gadget_generic_command(struct dwc3
*dwc
, unsigned cmd
, u32 param
);
1436 static inline int dwc3_gadget_init(struct dwc3
*dwc
)
1438 static inline void dwc3_gadget_exit(struct dwc3
*dwc
)
1440 static inline int dwc3_gadget_set_test_mode(struct dwc3
*dwc
, int mode
)
1442 static inline int dwc3_gadget_get_link_state(struct dwc3
*dwc
)
1444 static inline int dwc3_gadget_set_link_state(struct dwc3
*dwc
,
1445 enum dwc3_link_state state
)
1448 static inline int dwc3_send_gadget_ep_cmd(struct dwc3_ep
*dep
, unsigned cmd
,
1449 struct dwc3_gadget_ep_cmd_params
*params
)
1451 static inline int dwc3_send_gadget_generic_command(struct dwc3
*dwc
,
1456 #if IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
1457 int dwc3_drd_init(struct dwc3
*dwc
);
1458 void dwc3_drd_exit(struct dwc3
*dwc
);
1459 void dwc3_otg_init(struct dwc3
*dwc
);
1460 void dwc3_otg_exit(struct dwc3
*dwc
);
1461 void dwc3_otg_update(struct dwc3
*dwc
, bool ignore_idstatus
);
1462 void dwc3_otg_host_init(struct dwc3
*dwc
);
1464 static inline int dwc3_drd_init(struct dwc3
*dwc
)
1466 static inline void dwc3_drd_exit(struct dwc3
*dwc
)
1468 static inline void dwc3_otg_init(struct dwc3
*dwc
)
1470 static inline void dwc3_otg_exit(struct dwc3
*dwc
)
1472 static inline void dwc3_otg_update(struct dwc3
*dwc
, bool ignore_idstatus
)
1474 static inline void dwc3_otg_host_init(struct dwc3
*dwc
)
1478 /* power management interface */
1479 #if !IS_ENABLED(CONFIG_USB_DWC3_HOST)
1480 int dwc3_gadget_suspend(struct dwc3
*dwc
);
1481 int dwc3_gadget_resume(struct dwc3
*dwc
);
1482 void dwc3_gadget_process_pending_events(struct dwc3
*dwc
);
1484 static inline int dwc3_gadget_suspend(struct dwc3
*dwc
)
1489 static inline int dwc3_gadget_resume(struct dwc3
*dwc
)
1494 static inline void dwc3_gadget_process_pending_events(struct dwc3
*dwc
)
1497 #endif /* !IS_ENABLED(CONFIG_USB_DWC3_HOST) */
1499 #if IS_ENABLED(CONFIG_USB_DWC3_ULPI)
1500 int dwc3_ulpi_init(struct dwc3
*dwc
);
1501 void dwc3_ulpi_exit(struct dwc3
*dwc
);
1503 static inline int dwc3_ulpi_init(struct dwc3
*dwc
)
1505 static inline void dwc3_ulpi_exit(struct dwc3
*dwc
)
1509 #endif /* __DRIVERS_USB_DWC3_CORE_H */