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