1 /* SPDX-License-Identifier: GPL-2.0 */
3 * core.h - DesignWare USB3 DRD Core Header
5 * Copyright (C) 2015 Texas Instruments Incorporated - http://www.ti.com
7 * Authors: Felipe Balbi <balbi@ti.com>,
8 * Sebastian Andrzej Siewior <bigeasy@linutronix.de>
10 * Taken from Linux Kernel v3.19-rc1 (drivers/usb/dwc3/core.h) and ported
13 * commit 460d098cb6 : usb: dwc3: make HIRD threshold configurable
17 #ifndef __DRIVERS_USB_DWC3_CORE_H
18 #define __DRIVERS_USB_DWC3_CORE_H
20 #include <linux/bitops.h>
21 #include <linux/ioport.h>
23 #include <linux/usb/ch9.h>
24 #include <linux/usb/otg.h>
26 #define DWC3_MSG_MAX 500
28 /* Global constants */
29 #define DWC3_EP0_BOUNCE_SIZE 512
30 #define DWC3_ENDPOINTS_NUM 32
31 #define DWC3_XHCI_RESOURCES_NUM 2
33 #define DWC3_SCRATCHBUF_SIZE 4096 /* each buffer is assumed to be 4KiB */
34 #define DWC3_EVENT_SIZE 4 /* bytes */
35 #define DWC3_EVENT_MAX_NUM 64 /* 2 events/endpoint */
36 #define DWC3_EVENT_BUFFERS_SIZE (DWC3_EVENT_SIZE * DWC3_EVENT_MAX_NUM)
37 #define DWC3_EVENT_TYPE_MASK 0xfe
39 #define DWC3_EVENT_TYPE_DEV 0
40 #define DWC3_EVENT_TYPE_CARKIT 3
41 #define DWC3_EVENT_TYPE_I2C 4
43 #define DWC3_DEVICE_EVENT_DISCONNECT 0
44 #define DWC3_DEVICE_EVENT_RESET 1
45 #define DWC3_DEVICE_EVENT_CONNECT_DONE 2
46 #define DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE 3
47 #define DWC3_DEVICE_EVENT_WAKEUP 4
48 #define DWC3_DEVICE_EVENT_HIBER_REQ 5
49 #define DWC3_DEVICE_EVENT_EOPF 6
50 #define DWC3_DEVICE_EVENT_SOF 7
51 #define DWC3_DEVICE_EVENT_ERRATIC_ERROR 9
52 #define DWC3_DEVICE_EVENT_CMD_CMPL 10
53 #define DWC3_DEVICE_EVENT_OVERFLOW 11
55 #define DWC3_GEVNTCOUNT_MASK 0xfffc
56 #define DWC3_GSNPSID_MASK 0xffff0000
57 #define DWC3_GSNPSREV_MASK 0xffff
59 /* DWC3 registers memory space boundries */
60 #define DWC3_XHCI_REGS_START 0x0
61 #define DWC3_XHCI_REGS_END 0x7fff
62 #define DWC3_GLOBALS_REGS_START 0xc100
63 #define DWC3_GLOBALS_REGS_END 0xc6ff
64 #define DWC3_DEVICE_REGS_START 0xc700
65 #define DWC3_DEVICE_REGS_END 0xcbff
66 #define DWC3_OTG_REGS_START 0xcc00
67 #define DWC3_OTG_REGS_END 0xccff
69 /* Global Registers */
70 #define DWC3_GSBUSCFG0 0xc100
71 #define DWC3_GSBUSCFG1 0xc104
72 #define DWC3_GTXTHRCFG 0xc108
73 #define DWC3_GRXTHRCFG 0xc10c
74 #define DWC3_GCTL 0xc110
75 #define DWC3_GEVTEN 0xc114
76 #define DWC3_GSTS 0xc118
77 #define DWC3_GSNPSID 0xc120
78 #define DWC3_GGPIO 0xc124
79 #define DWC3_GUID 0xc128
80 #define DWC3_GUCTL 0xc12c
81 #define DWC3_GBUSERRADDR0 0xc130
82 #define DWC3_GBUSERRADDR1 0xc134
83 #define DWC3_GPRTBIMAP0 0xc138
84 #define DWC3_GPRTBIMAP1 0xc13c
85 #define DWC3_GHWPARAMS0 0xc140
86 #define DWC3_GHWPARAMS1 0xc144
87 #define DWC3_GHWPARAMS2 0xc148
88 #define DWC3_GHWPARAMS3 0xc14c
89 #define DWC3_GHWPARAMS4 0xc150
90 #define DWC3_GHWPARAMS5 0xc154
91 #define DWC3_GHWPARAMS6 0xc158
92 #define DWC3_GHWPARAMS7 0xc15c
93 #define DWC3_GDBGFIFOSPACE 0xc160
94 #define DWC3_GDBGLTSSM 0xc164
95 #define DWC3_GPRTBIMAP_HS0 0xc180
96 #define DWC3_GPRTBIMAP_HS1 0xc184
97 #define DWC3_GPRTBIMAP_FS0 0xc188
98 #define DWC3_GPRTBIMAP_FS1 0xc18c
100 #define DWC3_GUSB2PHYCFG(n) (0xc200 + (n * 0x04))
101 #define DWC3_GUSB2I2CCTL(n) (0xc240 + (n * 0x04))
103 #define DWC3_GUSB2PHYACC(n) (0xc280 + (n * 0x04))
105 #define DWC3_GUSB3PIPECTL(n) (0xc2c0 + (n * 0x04))
107 #define DWC3_GTXFIFOSIZ(n) (0xc300 + (n * 0x04))
108 #define DWC3_GRXFIFOSIZ(n) (0xc380 + (n * 0x04))
110 #define DWC3_GEVNTADRLO(n) (0xc400 + (n * 0x10))
111 #define DWC3_GEVNTADRHI(n) (0xc404 + (n * 0x10))
112 #define DWC3_GEVNTSIZ(n) (0xc408 + (n * 0x10))
113 #define DWC3_GEVNTCOUNT(n) (0xc40c + (n * 0x10))
115 #define DWC3_GHWPARAMS8 0xc600
117 /* Device Registers */
118 #define DWC3_DCFG 0xc700
119 #define DWC3_DCTL 0xc704
120 #define DWC3_DEVTEN 0xc708
121 #define DWC3_DSTS 0xc70c
122 #define DWC3_DGCMDPAR 0xc710
123 #define DWC3_DGCMD 0xc714
124 #define DWC3_DALEPENA 0xc720
125 #define DWC3_DEPCMDPAR2(n) (0xc800 + (n * 0x10))
126 #define DWC3_DEPCMDPAR1(n) (0xc804 + (n * 0x10))
127 #define DWC3_DEPCMDPAR0(n) (0xc808 + (n * 0x10))
128 #define DWC3_DEPCMD(n) (0xc80c + (n * 0x10))
131 #define DWC3_OCFG 0xcc00
132 #define DWC3_OCTL 0xcc04
133 #define DWC3_OEVT 0xcc08
134 #define DWC3_OEVTEN 0xcc0C
135 #define DWC3_OSTS 0xcc10
139 /* Global Configuration Register */
140 #define DWC3_GCTL_PWRDNSCALE(n) ((n) << 19)
141 #define DWC3_GCTL_U2RSTECN (1 << 16)
142 #define DWC3_GCTL_RAMCLKSEL(x) (((x) & DWC3_GCTL_CLK_MASK) << 6)
143 #define DWC3_GCTL_CLK_BUS (0)
144 #define DWC3_GCTL_CLK_PIPE (1)
145 #define DWC3_GCTL_CLK_PIPEHALF (2)
146 #define DWC3_GCTL_CLK_MASK (3)
148 #define DWC3_GCTL_PRTCAP(n) (((n) & (3 << 12)) >> 12)
149 #define DWC3_GCTL_PRTCAPDIR(n) ((n) << 12)
150 #define DWC3_GCTL_PRTCAP_HOST 1
151 #define DWC3_GCTL_PRTCAP_DEVICE 2
152 #define DWC3_GCTL_PRTCAP_OTG 3
154 #define DWC3_GCTL_CORESOFTRESET (1 << 11)
155 #define DWC3_GCTL_SOFITPSYNC (1 << 10)
156 #define DWC3_GCTL_SCALEDOWN(n) ((n) << 4)
157 #define DWC3_GCTL_SCALEDOWN_MASK DWC3_GCTL_SCALEDOWN(3)
158 #define DWC3_GCTL_DISSCRAMBLE (1 << 3)
159 #define DWC3_GCTL_U2EXIT_LFPS (1 << 2)
160 #define DWC3_GCTL_GBLHIBERNATIONEN (1 << 1)
161 #define DWC3_GCTL_DSBLCLKGTNG (1 << 0)
163 /* Global USB2 PHY Configuration Register */
164 #define DWC3_GUSB2PHYCFG_PHYSOFTRST (1 << 31)
165 #define DWC3_GUSB2PHYCFG_SUSPHY (1 << 6)
166 #define DWC3_GUSB2PHYCFG_PHYIF(n) ((n) << 3)
167 #define DWC3_GUSB2PHYCFG_PHYIF_MASK DWC3_GUSB2PHYCFG_PHYIF(1)
168 #define DWC3_GUSB2PHYCFG_USBTRDTIM(n) ((n) << 10)
169 #define DWC3_GUSB2PHYCFG_USBTRDTIM_MASK DWC3_GUSB2PHYCFG_USBTRDTIM(0xf)
170 #define USBTRDTIM_UTMI_8_BIT 9
171 #define USBTRDTIM_UTMI_16_BIT 5
172 #define UTMI_PHYIF_16_BIT 1
173 #define UTMI_PHYIF_8_BIT 0
175 /* Global USB3 PIPE Control Register */
176 #define DWC3_GUSB3PIPECTL_PHYSOFTRST (1 << 31)
177 #define DWC3_GUSB3PIPECTL_U2SSINP3OK (1 << 29)
178 #define DWC3_GUSB3PIPECTL_REQP1P2P3 (1 << 24)
179 #define DWC3_GUSB3PIPECTL_DEP1P2P3(n) ((n) << 19)
180 #define DWC3_GUSB3PIPECTL_DEP1P2P3_MASK DWC3_GUSB3PIPECTL_DEP1P2P3(7)
181 #define DWC3_GUSB3PIPECTL_DEP1P2P3_EN DWC3_GUSB3PIPECTL_DEP1P2P3(1)
182 #define DWC3_GUSB3PIPECTL_DEPOCHANGE (1 << 18)
183 #define DWC3_GUSB3PIPECTL_SUSPHY (1 << 17)
184 #define DWC3_GUSB3PIPECTL_LFPSFILT (1 << 9)
185 #define DWC3_GUSB3PIPECTL_RX_DETOPOLL (1 << 8)
186 #define DWC3_GUSB3PIPECTL_TX_DEEPH_MASK DWC3_GUSB3PIPECTL_TX_DEEPH(3)
187 #define DWC3_GUSB3PIPECTL_TX_DEEPH(n) ((n) << 1)
189 /* Global TX Fifo Size Register */
190 #define DWC3_GTXFIFOSIZ_TXFDEF(n) ((n) & 0xffff)
191 #define DWC3_GTXFIFOSIZ_TXFSTADDR(n) ((n) & 0xffff0000)
193 /* Global Event Size Registers */
194 #define DWC3_GEVNTSIZ_INTMASK (1 << 31)
195 #define DWC3_GEVNTSIZ_SIZE(n) ((n) & 0xffff)
197 /* Global HWPARAMS1 Register */
198 #define DWC3_GHWPARAMS1_EN_PWROPT(n) (((n) & (3 << 24)) >> 24)
199 #define DWC3_GHWPARAMS1_EN_PWROPT_NO 0
200 #define DWC3_GHWPARAMS1_EN_PWROPT_CLK 1
201 #define DWC3_GHWPARAMS1_EN_PWROPT_HIB 2
202 #define DWC3_GHWPARAMS1_PWROPT(n) ((n) << 24)
203 #define DWC3_GHWPARAMS1_PWROPT_MASK DWC3_GHWPARAMS1_PWROPT(3)
205 /* Global HWPARAMS3 Register */
206 #define DWC3_GHWPARAMS3_SSPHY_IFC(n) ((n) & 3)
207 #define DWC3_GHWPARAMS3_SSPHY_IFC_DIS 0
208 #define DWC3_GHWPARAMS3_SSPHY_IFC_ENA 1
209 #define DWC3_GHWPARAMS3_HSPHY_IFC(n) (((n) & (3 << 2)) >> 2)
210 #define DWC3_GHWPARAMS3_HSPHY_IFC_DIS 0
211 #define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI 1
212 #define DWC3_GHWPARAMS3_HSPHY_IFC_ULPI 2
213 #define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI_ULPI 3
214 #define DWC3_GHWPARAMS3_FSPHY_IFC(n) (((n) & (3 << 4)) >> 4)
215 #define DWC3_GHWPARAMS3_FSPHY_IFC_DIS 0
216 #define DWC3_GHWPARAMS3_FSPHY_IFC_ENA 1
218 /* Global HWPARAMS4 Register */
219 #define DWC3_GHWPARAMS4_HIBER_SCRATCHBUFS(n) (((n) & (0x0f << 13)) >> 13)
220 #define DWC3_MAX_HIBER_SCRATCHBUFS 15
222 /* Global HWPARAMS6 Register */
223 #define DWC3_GHWPARAMS6_EN_FPGA (1 << 7)
225 /* Device Configuration Register */
226 #define DWC3_DCFG_DEVADDR(addr) ((addr) << 3)
227 #define DWC3_DCFG_DEVADDR_MASK DWC3_DCFG_DEVADDR(0x7f)
229 #define DWC3_DCFG_SPEED_MASK (7 << 0)
230 #define DWC3_DCFG_SUPERSPEED (4 << 0)
231 #define DWC3_DCFG_HIGHSPEED (0 << 0)
232 #define DWC3_DCFG_FULLSPEED2 (1 << 0)
233 #define DWC3_DCFG_LOWSPEED (2 << 0)
234 #define DWC3_DCFG_FULLSPEED1 (3 << 0)
236 #define DWC3_DCFG_LPM_CAP (1 << 22)
238 /* Device Control Register */
239 #define DWC3_DCTL_RUN_STOP (1 << 31)
240 #define DWC3_DCTL_CSFTRST (1 << 30)
241 #define DWC3_DCTL_LSFTRST (1 << 29)
243 #define DWC3_DCTL_HIRD_THRES_MASK (0x1f << 24)
244 #define DWC3_DCTL_HIRD_THRES(n) ((n) << 24)
246 #define DWC3_DCTL_APPL1RES (1 << 23)
248 /* These apply for core versions 1.87a and earlier */
249 #define DWC3_DCTL_TRGTULST_MASK (0x0f << 17)
250 #define DWC3_DCTL_TRGTULST(n) ((n) << 17)
251 #define DWC3_DCTL_TRGTULST_U2 (DWC3_DCTL_TRGTULST(2))
252 #define DWC3_DCTL_TRGTULST_U3 (DWC3_DCTL_TRGTULST(3))
253 #define DWC3_DCTL_TRGTULST_SS_DIS (DWC3_DCTL_TRGTULST(4))
254 #define DWC3_DCTL_TRGTULST_RX_DET (DWC3_DCTL_TRGTULST(5))
255 #define DWC3_DCTL_TRGTULST_SS_INACT (DWC3_DCTL_TRGTULST(6))
257 /* These apply for core versions 1.94a and later */
258 #define DWC3_DCTL_LPM_ERRATA_MASK DWC3_DCTL_LPM_ERRATA(0xf)
259 #define DWC3_DCTL_LPM_ERRATA(n) ((n) << 20)
261 #define DWC3_DCTL_KEEP_CONNECT (1 << 19)
262 #define DWC3_DCTL_L1_HIBER_EN (1 << 18)
263 #define DWC3_DCTL_CRS (1 << 17)
264 #define DWC3_DCTL_CSS (1 << 16)
266 #define DWC3_DCTL_INITU2ENA (1 << 12)
267 #define DWC3_DCTL_ACCEPTU2ENA (1 << 11)
268 #define DWC3_DCTL_INITU1ENA (1 << 10)
269 #define DWC3_DCTL_ACCEPTU1ENA (1 << 9)
270 #define DWC3_DCTL_TSTCTRL_MASK (0xf << 1)
272 #define DWC3_DCTL_ULSTCHNGREQ_MASK (0x0f << 5)
273 #define DWC3_DCTL_ULSTCHNGREQ(n) (((n) << 5) & DWC3_DCTL_ULSTCHNGREQ_MASK)
275 #define DWC3_DCTL_ULSTCHNG_NO_ACTION (DWC3_DCTL_ULSTCHNGREQ(0))
276 #define DWC3_DCTL_ULSTCHNG_SS_DISABLED (DWC3_DCTL_ULSTCHNGREQ(4))
277 #define DWC3_DCTL_ULSTCHNG_RX_DETECT (DWC3_DCTL_ULSTCHNGREQ(5))
278 #define DWC3_DCTL_ULSTCHNG_SS_INACTIVE (DWC3_DCTL_ULSTCHNGREQ(6))
279 #define DWC3_DCTL_ULSTCHNG_RECOVERY (DWC3_DCTL_ULSTCHNGREQ(8))
280 #define DWC3_DCTL_ULSTCHNG_COMPLIANCE (DWC3_DCTL_ULSTCHNGREQ(10))
281 #define DWC3_DCTL_ULSTCHNG_LOOPBACK (DWC3_DCTL_ULSTCHNGREQ(11))
283 /* Device Event Enable Register */
284 #define DWC3_DEVTEN_VNDRDEVTSTRCVEDEN (1 << 12)
285 #define DWC3_DEVTEN_EVNTOVERFLOWEN (1 << 11)
286 #define DWC3_DEVTEN_CMDCMPLTEN (1 << 10)
287 #define DWC3_DEVTEN_ERRTICERREN (1 << 9)
288 #define DWC3_DEVTEN_SOFEN (1 << 7)
289 #define DWC3_DEVTEN_EOPFEN (1 << 6)
290 #define DWC3_DEVTEN_HIBERNATIONREQEVTEN (1 << 5)
291 #define DWC3_DEVTEN_WKUPEVTEN (1 << 4)
292 #define DWC3_DEVTEN_ULSTCNGEN (1 << 3)
293 #define DWC3_DEVTEN_CONNECTDONEEN (1 << 2)
294 #define DWC3_DEVTEN_USBRSTEN (1 << 1)
295 #define DWC3_DEVTEN_DISCONNEVTEN (1 << 0)
297 /* Device Status Register */
298 #define DWC3_DSTS_DCNRD (1 << 29)
300 /* This applies for core versions 1.87a and earlier */
301 #define DWC3_DSTS_PWRUPREQ (1 << 24)
303 /* These apply for core versions 1.94a and later */
304 #define DWC3_DSTS_RSS (1 << 25)
305 #define DWC3_DSTS_SSS (1 << 24)
307 #define DWC3_DSTS_COREIDLE (1 << 23)
308 #define DWC3_DSTS_DEVCTRLHLT (1 << 22)
310 #define DWC3_DSTS_USBLNKST_MASK (0x0f << 18)
311 #define DWC3_DSTS_USBLNKST(n) (((n) & DWC3_DSTS_USBLNKST_MASK) >> 18)
313 #define DWC3_DSTS_RXFIFOEMPTY (1 << 17)
315 #define DWC3_DSTS_SOFFN_MASK (0x3fff << 3)
316 #define DWC3_DSTS_SOFFN(n) (((n) & DWC3_DSTS_SOFFN_MASK) >> 3)
318 #define DWC3_DSTS_CONNECTSPD (7 << 0)
320 #define DWC3_DSTS_SUPERSPEED (4 << 0)
321 #define DWC3_DSTS_HIGHSPEED (0 << 0)
322 #define DWC3_DSTS_FULLSPEED2 (1 << 0)
323 #define DWC3_DSTS_LOWSPEED (2 << 0)
324 #define DWC3_DSTS_FULLSPEED1 (3 << 0)
326 /* Device Generic Command Register */
327 #define DWC3_DGCMD_SET_LMP 0x01
328 #define DWC3_DGCMD_SET_PERIODIC_PAR 0x02
329 #define DWC3_DGCMD_XMIT_FUNCTION 0x03
331 /* These apply for core versions 1.94a and later */
332 #define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO 0x04
333 #define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI 0x05
335 #define DWC3_DGCMD_SELECTED_FIFO_FLUSH 0x09
336 #define DWC3_DGCMD_ALL_FIFO_FLUSH 0x0a
337 #define DWC3_DGCMD_SET_ENDPOINT_NRDY 0x0c
338 #define DWC3_DGCMD_RUN_SOC_BUS_LOOPBACK 0x10
340 #define DWC3_DGCMD_STATUS(n) (((n) >> 15) & 1)
341 #define DWC3_DGCMD_CMDACT (1 << 10)
342 #define DWC3_DGCMD_CMDIOC (1 << 8)
344 /* Device Generic Command Parameter Register */
345 #define DWC3_DGCMDPAR_FORCE_LINKPM_ACCEPT (1 << 0)
346 #define DWC3_DGCMDPAR_FIFO_NUM(n) ((n) << 0)
347 #define DWC3_DGCMDPAR_RX_FIFO (0 << 5)
348 #define DWC3_DGCMDPAR_TX_FIFO (1 << 5)
349 #define DWC3_DGCMDPAR_LOOPBACK_DIS (0 << 0)
350 #define DWC3_DGCMDPAR_LOOPBACK_ENA (1 << 0)
352 /* Device Endpoint Command Register */
353 #define DWC3_DEPCMD_PARAM_SHIFT 16
354 #define DWC3_DEPCMD_PARAM(x) ((x) << DWC3_DEPCMD_PARAM_SHIFT)
355 #define DWC3_DEPCMD_GET_RSC_IDX(x) (((x) >> DWC3_DEPCMD_PARAM_SHIFT) & 0x7f)
356 #define DWC3_DEPCMD_STATUS(x) (((x) >> 15) & 1)
357 #define DWC3_DEPCMD_HIPRI_FORCERM (1 << 11)
358 #define DWC3_DEPCMD_CMDACT (1 << 10)
359 #define DWC3_DEPCMD_CMDIOC (1 << 8)
361 #define DWC3_DEPCMD_DEPSTARTCFG (0x09 << 0)
362 #define DWC3_DEPCMD_ENDTRANSFER (0x08 << 0)
363 #define DWC3_DEPCMD_UPDATETRANSFER (0x07 << 0)
364 #define DWC3_DEPCMD_STARTTRANSFER (0x06 << 0)
365 #define DWC3_DEPCMD_CLEARSTALL (0x05 << 0)
366 #define DWC3_DEPCMD_SETSTALL (0x04 << 0)
367 /* This applies for core versions 1.90a and earlier */
368 #define DWC3_DEPCMD_GETSEQNUMBER (0x03 << 0)
369 /* This applies for core versions 1.94a and later */
370 #define DWC3_DEPCMD_GETEPSTATE (0x03 << 0)
371 #define DWC3_DEPCMD_SETTRANSFRESOURCE (0x02 << 0)
372 #define DWC3_DEPCMD_SETEPCONFIG (0x01 << 0)
374 /* The EP number goes 0..31 so ep0 is always out and ep1 is always in */
375 #define DWC3_DALEPENA_EP(n) (1 << n)
377 #define DWC3_DEPCMD_TYPE_CONTROL 0
378 #define DWC3_DEPCMD_TYPE_ISOC 1
379 #define DWC3_DEPCMD_TYPE_BULK 2
380 #define DWC3_DEPCMD_TYPE_INTR 3
387 * struct dwc3_event_buffer - Software event buffer representation
389 * @length: size of this buffer
390 * @lpos: event offset
391 * @count: cache of last read event count register
392 * @flags: flags related to this event buffer
394 * @dwc: pointer to DWC controller
396 struct dwc3_event_buffer {
403 #define DWC3_EVENT_PENDING (1UL << 0)
410 #define DWC3_EP_FLAG_STALLED (1 << 0)
411 #define DWC3_EP_FLAG_WEDGED (1 << 1)
413 #define DWC3_EP_DIRECTION_TX true
414 #define DWC3_EP_DIRECTION_RX false
416 #define DWC3_TRB_NUM 32
417 #define DWC3_TRB_MASK (DWC3_TRB_NUM - 1)
420 * struct dwc3_ep - device side endpoint representation
421 * @endpoint: usb endpoint
422 * @request_list: list of requests for this endpoint
423 * @req_queued: list of requests on this ep which have TRBs setup
424 * @trb_pool: array of transaction buffers
425 * @trb_pool_dma: dma address of @trb_pool
426 * @free_slot: next slot which is going to be used
427 * @busy_slot: first slot which is owned by HW
428 * @desc: usb_endpoint_descriptor pointer
429 * @dwc: pointer to DWC controller
430 * @saved_state: ep state saved during hibernation
431 * @flags: endpoint flags (wedged, stalled, ...)
432 * @current_trb: index of current used trb
433 * @number: endpoint number (1 - 15)
434 * @type: set to bmAttributes & USB_ENDPOINT_XFERTYPE_MASK
435 * @resource_index: Resource transfer index
436 * @interval: the interval on which the ISOC transfer is started
437 * @name: a human readable name e.g. ep1out-bulk
438 * @direction: true for TX, false for RX
439 * @stream_capable: true when streams are enabled
442 struct usb_ep endpoint;
443 struct list_head request_list;
444 struct list_head req_queued;
446 struct dwc3_trb *trb_pool;
447 dma_addr_t trb_pool_dma;
450 const struct usb_ss_ep_comp_descriptor *comp_desc;
455 #define DWC3_EP_ENABLED (1 << 0)
456 #define DWC3_EP_STALL (1 << 1)
457 #define DWC3_EP_WEDGE (1 << 2)
458 #define DWC3_EP_BUSY (1 << 4)
459 #define DWC3_EP_PENDING_REQUEST (1 << 5)
460 #define DWC3_EP_MISSED_ISOC (1 << 6)
462 /* This last one is specific to EP0 */
463 #define DWC3_EP0_DIR_IN (1 << 31)
465 unsigned current_trb;
474 unsigned direction:1;
475 unsigned stream_capable:1;
479 DWC3_PHY_UNKNOWN = 0,
485 DWC3_EP0_UNKNOWN = 0,
488 DWC3_EP0_NRDY_STATUS,
491 enum dwc3_ep0_state {
498 enum dwc3_link_state {
500 DWC3_LINK_STATE_U0 = 0x00, /* in HS, means ON */
501 DWC3_LINK_STATE_U1 = 0x01,
502 DWC3_LINK_STATE_U2 = 0x02, /* in HS, means SLEEP */
503 DWC3_LINK_STATE_U3 = 0x03, /* in HS, means SUSPEND */
504 DWC3_LINK_STATE_SS_DIS = 0x04,
505 DWC3_LINK_STATE_RX_DET = 0x05, /* in HS, means Early Suspend */
506 DWC3_LINK_STATE_SS_INACT = 0x06,
507 DWC3_LINK_STATE_POLL = 0x07,
508 DWC3_LINK_STATE_RECOV = 0x08,
509 DWC3_LINK_STATE_HRESET = 0x09,
510 DWC3_LINK_STATE_CMPLY = 0x0a,
511 DWC3_LINK_STATE_LPBK = 0x0b,
512 DWC3_LINK_STATE_RESET = 0x0e,
513 DWC3_LINK_STATE_RESUME = 0x0f,
514 DWC3_LINK_STATE_MASK = 0x0f,
517 /* TRB Length, PCM and Status */
518 #define DWC3_TRB_SIZE_MASK (0x00ffffff)
519 #define DWC3_TRB_SIZE_LENGTH(n) ((n) & DWC3_TRB_SIZE_MASK)
520 #define DWC3_TRB_SIZE_PCM1(n) (((n) & 0x03) << 24)
521 #define DWC3_TRB_SIZE_TRBSTS(n) (((n) & (0x0f << 28)) >> 28)
523 #define DWC3_TRBSTS_OK 0
524 #define DWC3_TRBSTS_MISSED_ISOC 1
525 #define DWC3_TRBSTS_SETUP_PENDING 2
526 #define DWC3_TRB_STS_XFER_IN_PROG 4
529 #define DWC3_TRB_CTRL_HWO (1 << 0)
530 #define DWC3_TRB_CTRL_LST (1 << 1)
531 #define DWC3_TRB_CTRL_CHN (1 << 2)
532 #define DWC3_TRB_CTRL_CSP (1 << 3)
533 #define DWC3_TRB_CTRL_TRBCTL(n) (((n) & 0x3f) << 4)
534 #define DWC3_TRB_CTRL_ISP_IMI (1 << 10)
535 #define DWC3_TRB_CTRL_IOC (1 << 11)
536 #define DWC3_TRB_CTRL_SID_SOFN(n) (((n) & 0xffff) << 14)
538 #define DWC3_TRBCTL_NORMAL DWC3_TRB_CTRL_TRBCTL(1)
539 #define DWC3_TRBCTL_CONTROL_SETUP DWC3_TRB_CTRL_TRBCTL(2)
540 #define DWC3_TRBCTL_CONTROL_STATUS2 DWC3_TRB_CTRL_TRBCTL(3)
541 #define DWC3_TRBCTL_CONTROL_STATUS3 DWC3_TRB_CTRL_TRBCTL(4)
542 #define DWC3_TRBCTL_CONTROL_DATA DWC3_TRB_CTRL_TRBCTL(5)
543 #define DWC3_TRBCTL_ISOCHRONOUS_FIRST DWC3_TRB_CTRL_TRBCTL(6)
544 #define DWC3_TRBCTL_ISOCHRONOUS DWC3_TRB_CTRL_TRBCTL(7)
545 #define DWC3_TRBCTL_LINK_TRB DWC3_TRB_CTRL_TRBCTL(8)
548 * struct dwc3_trb - transfer request block (hw format)
562 * dwc3_hwparams - copy of HWPARAMS registers
563 * @hwparams0 - GHWPARAMS0
564 * @hwparams1 - GHWPARAMS1
565 * @hwparams2 - GHWPARAMS2
566 * @hwparams3 - GHWPARAMS3
567 * @hwparams4 - GHWPARAMS4
568 * @hwparams5 - GHWPARAMS5
569 * @hwparams6 - GHWPARAMS6
570 * @hwparams7 - GHWPARAMS7
571 * @hwparams8 - GHWPARAMS8
573 struct dwc3_hwparams {
586 #define DWC3_MODE(n) ((n) & 0x7)
588 #define DWC3_MDWIDTH(n) (((n) & 0xff00) >> 8)
591 #define DWC3_NUM_INT(n) (((n) & (0x3f << 15)) >> 15)
594 #define DWC3_NUM_IN_EPS_MASK (0x1f << 18)
595 #define DWC3_NUM_EPS_MASK (0x3f << 12)
596 #define DWC3_NUM_EPS(p) (((p)->hwparams3 & \
597 (DWC3_NUM_EPS_MASK)) >> 12)
598 #define DWC3_NUM_IN_EPS(p) (((p)->hwparams3 & \
599 (DWC3_NUM_IN_EPS_MASK)) >> 18)
602 #define DWC3_RAM1_DEPTH(n) ((n) & 0xffff)
604 struct dwc3_request {
605 struct usb_request request;
606 struct list_head list;
611 struct dwc3_trb *trb;
614 unsigned direction:1;
620 * struct dwc3_scratchpad_array - hibernation scratchpad array
621 * (format defined by hw)
623 struct dwc3_scratchpad_array {
624 __le64 dma_adr[DWC3_MAX_HIBER_SCRATCHBUFS];
628 * struct dwc3 - representation of our controller
629 * @ctrl_req: usb control request which is used for ep0
630 * @ep0_trb: trb which is used for the ctrl_req
631 * @ep0_bounce: bounce buffer for ep0
632 * @setup_buf: used while precessing STD USB requests
633 * @ctrl_req_addr: dma address of ctrl_req
634 * @ep0_trb: dma address of ep0_trb
635 * @ep0_usb_req: dummy req used while handling STD USB requests
636 * @ep0_bounce_addr: dma address of ep0_bounce
637 * @scratch_addr: dma address of scratchbuf
638 * @lock: for synchronizing
639 * @dev: pointer to our struct device
640 * @xhci: pointer to our xHCI child
641 * @event_buffer_list: a list of event buffers
642 * @gadget: device side representation of the peripheral controller
643 * @gadget_driver: pointer to the gadget driver
644 * @regs: base address for our registers
645 * @regs_size: address space size
646 * @nr_scratch: number of scratch buffers
647 * @num_event_buffers: calculated number of event buffers
648 * @u1u2: only used on revisions <1.83a for workaround
649 * @maximum_speed: maximum speed requested (mainly for testing purposes)
650 * @revision: revision register contents
651 * @dr_mode: requested mode of operation
652 * @dcfg: saved contents of DCFG register
653 * @gctl: saved contents of GCTL register
654 * @isoch_delay: wValue from Set Isochronous Delay request;
655 * @u2sel: parameter from Set SEL request.
656 * @u2pel: parameter from Set SEL request.
657 * @u1sel: parameter from Set SEL request.
658 * @u1pel: parameter from Set SEL request.
659 * @num_out_eps: number of out endpoints
660 * @num_in_eps: number of in endpoints
661 * @ep0_next_event: hold the next expected event
662 * @ep0state: state of endpoint zero
663 * @link_state: link state
664 * @speed: device speed (super, high, full, low)
665 * @mem: points to start of memory which is used for this struct.
666 * @hwparams: copy of hwparams registers
667 * @root: debugfs root folder pointer
668 * @regset: debugfs pointer to regdump file
669 * @test_mode: true when we're entering a USB test mode
670 * @test_mode_nr: test feature selector
671 * @lpm_nyet_threshold: LPM NYET response threshold
672 * @hird_threshold: HIRD threshold
673 * @delayed_status: true when gadget driver asks for delayed status
674 * @ep0_bounced: true when we used bounce buffer
675 * @ep0_expect_in: true when we expect a DATA IN transfer
676 * @has_hibernation: true when dwc3 was configured with Hibernation
677 * @has_lpm_erratum: true when core was configured with LPM Erratum. Note that
678 * there's now way for software to detect this in runtime.
679 * @is_utmi_l1_suspend: the core asserts output signal
681 * 1 - utmi_l1_suspend_n
682 * @is_selfpowered: true when we are selfpowered
683 * @is_fpga: true when we are using the FPGA board
684 * @needs_fifo_resize: not all users might want fifo resizing, flag it
685 * @pullups_connected: true when Run/Stop bit is set
686 * @resize_fifos: tells us it's ok to reconfigure our TxFIFO sizes.
687 * @setup_packet_pending: true when there's a Setup Packet in FIFO. Workaround
688 * @start_config_issued: true when StartConfig command has been issued
689 * @three_stage_setup: set if we perform a three phase setup
690 * @disable_scramble_quirk: set if we enable the disable scramble quirk
691 * @u2exit_lfps_quirk: set if we enable u2exit lfps quirk
692 * @u2ss_inp3_quirk: set if we enable P3 OK for U2/SS Inactive quirk
693 * @req_p1p2p3_quirk: set if we enable request p1p2p3 quirk
694 * @del_p1p2p3_quirk: set if we enable delay p1p2p3 quirk
695 * @del_phy_power_chg_quirk: set if we enable delay phy power change quirk
696 * @lfps_filter_quirk: set if we enable LFPS filter quirk
697 * @rx_detect_poll_quirk: set if we enable rx_detect to polling lfps quirk
698 * @dis_u3_susphy_quirk: set if we disable usb3 suspend phy
699 * @dis_u2_susphy_quirk: set if we disable usb2 suspend phy
700 * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
701 * @tx_de_emphasis: Tx de-emphasis value
702 * 0 - -6dB de-emphasis
703 * 1 - -3.5dB de-emphasis
706 * @index: index of _this_ controller
707 * @list: to maintain the list of dwc3 controllers
710 struct usb_ctrlrequest *ctrl_req;
711 struct dwc3_trb *ep0_trb;
715 dma_addr_t ctrl_req_addr;
716 dma_addr_t ep0_trb_addr;
717 dma_addr_t ep0_bounce_addr;
718 dma_addr_t scratch_addr;
719 struct dwc3_request ep0_usb_req;
724 #if defined(__UBOOT__) && CONFIG_IS_ENABLED(DM_USB)
730 struct platform_device *xhci;
731 struct resource xhci_resources[DWC3_XHCI_RESOURCES_NUM];
733 struct dwc3_event_buffer **ev_buffs;
734 struct dwc3_ep *eps[DWC3_ENDPOINTS_NUM];
736 struct usb_gadget gadget;
737 struct usb_gadget_driver *gadget_driver;
742 enum usb_dr_mode dr_mode;
744 /* used for suspend/resume */
749 u32 num_event_buffers;
754 #define DWC3_REVISION_173A 0x5533173a
755 #define DWC3_REVISION_175A 0x5533175a
756 #define DWC3_REVISION_180A 0x5533180a
757 #define DWC3_REVISION_183A 0x5533183a
758 #define DWC3_REVISION_185A 0x5533185a
759 #define DWC3_REVISION_187A 0x5533187a
760 #define DWC3_REVISION_188A 0x5533188a
761 #define DWC3_REVISION_190A 0x5533190a
762 #define DWC3_REVISION_194A 0x5533194a
763 #define DWC3_REVISION_200A 0x5533200a
764 #define DWC3_REVISION_202A 0x5533202a
765 #define DWC3_REVISION_210A 0x5533210a
766 #define DWC3_REVISION_220A 0x5533220a
767 #define DWC3_REVISION_230A 0x5533230a
768 #define DWC3_REVISION_240A 0x5533240a
769 #define DWC3_REVISION_250A 0x5533250a
770 #define DWC3_REVISION_260A 0x5533260a
771 #define DWC3_REVISION_270A 0x5533270a
772 #define DWC3_REVISION_280A 0x5533280a
774 enum dwc3_ep0_next ep0_next_event;
775 enum dwc3_ep0_state ep0state;
776 enum dwc3_link_state link_state;
791 struct dwc3_hwparams hwparams;
793 struct debugfs_regset32 *regset;
797 u8 lpm_nyet_threshold;
800 unsigned delayed_status:1;
801 unsigned ep0_bounced:1;
802 unsigned ep0_expect_in:1;
803 unsigned has_hibernation:1;
804 unsigned has_lpm_erratum:1;
805 unsigned is_utmi_l1_suspend:1;
806 unsigned is_selfpowered:1;
808 unsigned needs_fifo_resize:1;
809 unsigned pullups_connected:1;
810 unsigned resize_fifos:1;
811 unsigned setup_packet_pending:1;
812 unsigned start_config_issued:1;
813 unsigned three_stage_setup:1;
815 unsigned disable_scramble_quirk:1;
816 unsigned u2exit_lfps_quirk:1;
817 unsigned u2ss_inp3_quirk:1;
818 unsigned req_p1p2p3_quirk:1;
819 unsigned del_p1p2p3_quirk:1;
820 unsigned del_phy_power_chg_quirk:1;
821 unsigned lfps_filter_quirk:1;
822 unsigned rx_detect_poll_quirk:1;
823 unsigned dis_u3_susphy_quirk:1;
824 unsigned dis_u2_susphy_quirk:1;
825 unsigned dis_del_phy_power_chg_quirk:1;
827 unsigned tx_de_emphasis_quirk:1;
828 unsigned tx_de_emphasis:2;
830 struct list_head list;
833 /* -------------------------------------------------------------------------- */
835 /* -------------------------------------------------------------------------- */
837 struct dwc3_event_type {
843 #define DWC3_DEPEVT_XFERCOMPLETE 0x01
844 #define DWC3_DEPEVT_XFERINPROGRESS 0x02
845 #define DWC3_DEPEVT_XFERNOTREADY 0x03
846 #define DWC3_DEPEVT_RXTXFIFOEVT 0x04
847 #define DWC3_DEPEVT_STREAMEVT 0x06
848 #define DWC3_DEPEVT_EPCMDCMPLT 0x07
851 * dwc3_ep_event_string - returns event name
852 * @event: then event code
854 static inline const char *dwc3_ep_event_string(u8 event)
857 case DWC3_DEPEVT_XFERCOMPLETE:
858 return "Transfer Complete";
859 case DWC3_DEPEVT_XFERINPROGRESS:
860 return "Transfer In-Progress";
861 case DWC3_DEPEVT_XFERNOTREADY:
862 return "Transfer Not Ready";
863 case DWC3_DEPEVT_RXTXFIFOEVT:
865 case DWC3_DEPEVT_STREAMEVT:
867 case DWC3_DEPEVT_EPCMDCMPLT:
868 return "Endpoint Command Complete";
875 * struct dwc3_event_depvt - Device Endpoint Events
876 * @one_bit: indicates this is an endpoint event (not used)
877 * @endpoint_number: number of the endpoint
878 * @endpoint_event: The event we have:
880 * 0x01 - XferComplete
881 * 0x02 - XferInProgress
882 * 0x03 - XferNotReady
883 * 0x04 - RxTxFifoEvt (IN->Underrun, OUT->Overrun)
887 * @reserved11_10: Reserved, don't use.
888 * @status: Indicates the status of the event. Refer to databook for
890 * @parameters: Parameters of the current event. Refer to databook for
893 struct dwc3_event_depevt {
895 u32 endpoint_number:5;
896 u32 endpoint_event:4;
900 /* Within XferNotReady */
901 #define DEPEVT_STATUS_TRANSFER_ACTIVE (1 << 3)
903 /* Within XferComplete */
904 #define DEPEVT_STATUS_BUSERR (1 << 0)
905 #define DEPEVT_STATUS_SHORT (1 << 1)
906 #define DEPEVT_STATUS_IOC (1 << 2)
907 #define DEPEVT_STATUS_LST (1 << 3)
909 /* Stream event only */
910 #define DEPEVT_STREAMEVT_FOUND 1
911 #define DEPEVT_STREAMEVT_NOTFOUND 2
913 /* Control-only Status */
914 #define DEPEVT_STATUS_CONTROL_DATA 1
915 #define DEPEVT_STATUS_CONTROL_STATUS 2
921 * struct dwc3_event_devt - Device Events
922 * @one_bit: indicates this is a non-endpoint event (not used)
923 * @device_event: indicates it's a device event. Should read as 0x00
924 * @type: indicates the type of device event.
937 * 12 - VndrDevTstRcved
938 * @reserved15_12: Reserved, not used
939 * @event_info: Information about this event
940 * @reserved31_25: Reserved, not used
942 struct dwc3_event_devt {
952 * struct dwc3_event_gevt - Other Core Events
953 * @one_bit: indicates this is a non-endpoint event (not used)
954 * @device_event: indicates it's (0x03) Carkit or (0x04) I2C event.
955 * @phy_port_number: self-explanatory
956 * @reserved31_12: Reserved, not used.
958 struct dwc3_event_gevt {
961 u32 phy_port_number:4;
962 u32 reserved31_12:20;
966 * union dwc3_event - representation of Event Buffer contents
967 * @raw: raw 32-bit event
968 * @type: the type of the event
969 * @depevt: Device Endpoint Event
970 * @devt: Device Event
971 * @gevt: Global Event
975 struct dwc3_event_type type;
976 struct dwc3_event_depevt depevt;
977 struct dwc3_event_devt devt;
978 struct dwc3_event_gevt gevt;
982 * struct dwc3_gadget_ep_cmd_params - representation of endpoint command
984 * @param2: third parameter
985 * @param1: second parameter
986 * @param0: first parameter
988 struct dwc3_gadget_ep_cmd_params {
995 * DWC3 Features to be used as Driver Data
998 #define DWC3_HAS_PERIPHERAL BIT(0)
999 #define DWC3_HAS_XHCI BIT(1)
1000 #define DWC3_HAS_OTG BIT(3)
1003 int dwc3_gadget_resize_tx_fifos(struct dwc3 *dwc);
1004 void dwc3_of_parse(struct dwc3 *dwc);
1005 int dwc3_init(struct dwc3 *dwc);
1006 void dwc3_remove(struct dwc3 *dwc);
1008 static inline int dwc3_host_init(struct dwc3 *dwc)
1010 static inline void dwc3_host_exit(struct dwc3 *dwc)
1013 #ifdef CONFIG_USB_DWC3_GADGET
1014 int dwc3_gadget_init(struct dwc3 *dwc);
1015 void dwc3_gadget_exit(struct dwc3 *dwc);
1016 int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode);
1017 int dwc3_gadget_get_link_state(struct dwc3 *dwc);
1018 int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state);
1019 int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
1020 unsigned cmd, struct dwc3_gadget_ep_cmd_params *params);
1021 int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param);
1023 static inline int dwc3_gadget_init(struct dwc3 *dwc)
1025 static inline void dwc3_gadget_exit(struct dwc3 *dwc)
1027 static inline int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
1029 static inline int dwc3_gadget_get_link_state(struct dwc3 *dwc)
1031 static inline int dwc3_gadget_set_link_state(struct dwc3 *dwc,
1032 enum dwc3_link_state state)
1035 static inline int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
1036 unsigned cmd, struct dwc3_gadget_ep_cmd_params *params)
1038 static inline int dwc3_send_gadget_generic_command(struct dwc3 *dwc,
1043 #endif /* __DRIVERS_USB_DWC3_CORE_H */