core.h 48.9 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
F
Felipe Balbi 已提交
2
/*
3 4
 * core.h - DesignWare USB3 DRD Core Header
 *
5
 * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com
6 7 8 9 10 11 12 13 14 15
 *
 * Authors: Felipe Balbi <balbi@ti.com>,
 *	    Sebastian Andrzej Siewior <bigeasy@linutronix.de>
 */

#ifndef __DRIVERS_USB_DWC3_CORE_H
#define __DRIVERS_USB_DWC3_CORE_H

#include <linux/device.h>
#include <linux/spinlock.h>
F
Felipe Balbi 已提交
16
#include <linux/ioport.h>
17
#include <linux/list.h>
18
#include <linux/bitops.h>
19 20 21
#include <linux/dma-mapping.h>
#include <linux/mm.h>
#include <linux/debugfs.h>
22
#include <linux/wait.h>
23
#include <linux/workqueue.h>
24 25 26

#include <linux/usb/ch9.h>
#include <linux/usb/gadget.h>
27
#include <linux/usb/otg.h>
28
#include <linux/usb/role.h>
29
#include <linux/ulpi/interface.h>
30

31 32
#include <linux/phy/phy.h>

33 34
#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
42

43
#define DWC3_SCRATCHBUF_SIZE	4096	/* each buffer is assumed to be 4KiB */
44
#define DWC3_EVENT_BUFFERS_SIZE	4096
45 46 47 48 49 50 51 52 53 54 55
#define DWC3_EVENT_TYPE_MASK	0xfe

#define DWC3_EVENT_TYPE_DEV	0
#define DWC3_EVENT_TYPE_CARKIT	3
#define DWC3_EVENT_TYPE_I2C	4

#define DWC3_DEVICE_EVENT_DISCONNECT		0
#define DWC3_DEVICE_EVENT_RESET			1
#define DWC3_DEVICE_EVENT_CONNECT_DONE		2
#define DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE	3
#define DWC3_DEVICE_EVENT_WAKEUP		4
56
#define DWC3_DEVICE_EVENT_HIBER_REQ		5
57 58 59 60 61 62
#define DWC3_DEVICE_EVENT_EOPF			6
#define DWC3_DEVICE_EVENT_SOF			7
#define DWC3_DEVICE_EVENT_ERRATIC_ERROR		9
#define DWC3_DEVICE_EVENT_CMD_CMPL		10
#define DWC3_DEVICE_EVENT_OVERFLOW		11

63 64 65 66 67
/* Controller's role while using the OTG block */
#define DWC3_OTG_ROLE_IDLE	0
#define DWC3_OTG_ROLE_HOST	1
#define DWC3_OTG_ROLE_DEVICE	2

68
#define DWC3_GEVNTCOUNT_MASK	0xfffc
69
#define DWC3_GEVNTCOUNT_EHB	BIT(31)
70 71
#define DWC3_GSNPSID_MASK	0xffff0000
#define DWC3_GSNPSREV_MASK	0xffff
72
#define DWC3_GSNPS_ID(p)	(((p) & DWC3_GSNPSID_MASK) >> 16)
73

74 75 76 77 78 79 80 81 82 83
/* DWC3 registers memory space boundries */
#define DWC3_XHCI_REGS_START		0x0
#define DWC3_XHCI_REGS_END		0x7fff
#define DWC3_GLOBALS_REGS_START		0xc100
#define DWC3_GLOBALS_REGS_END		0xc6ff
#define DWC3_DEVICE_REGS_START		0xc700
#define DWC3_DEVICE_REGS_END		0xcbff
#define DWC3_OTG_REGS_START		0xcc00
#define DWC3_OTG_REGS_END		0xccff

84 85 86 87 88 89 90 91
/* Global Registers */
#define DWC3_GSBUSCFG0		0xc100
#define DWC3_GSBUSCFG1		0xc104
#define DWC3_GTXTHRCFG		0xc108
#define DWC3_GRXTHRCFG		0xc10c
#define DWC3_GCTL		0xc110
#define DWC3_GEVTEN		0xc114
#define DWC3_GSTS		0xc118
92
#define DWC3_GUCTL1		0xc11c
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
#define DWC3_GSNPSID		0xc120
#define DWC3_GGPIO		0xc124
#define DWC3_GUID		0xc128
#define DWC3_GUCTL		0xc12c
#define DWC3_GBUSERRADDR0	0xc130
#define DWC3_GBUSERRADDR1	0xc134
#define DWC3_GPRTBIMAP0		0xc138
#define DWC3_GPRTBIMAP1		0xc13c
#define DWC3_GHWPARAMS0		0xc140
#define DWC3_GHWPARAMS1		0xc144
#define DWC3_GHWPARAMS2		0xc148
#define DWC3_GHWPARAMS3		0xc14c
#define DWC3_GHWPARAMS4		0xc150
#define DWC3_GHWPARAMS5		0xc154
#define DWC3_GHWPARAMS6		0xc158
#define DWC3_GHWPARAMS7		0xc15c
#define DWC3_GDBGFIFOSPACE	0xc160
#define DWC3_GDBGLTSSM		0xc164
111 112 113 114 115
#define DWC3_GDBGBMU		0xc16c
#define DWC3_GDBGLSPMUX		0xc170
#define DWC3_GDBGLSP		0xc174
#define DWC3_GDBGEPINFO0	0xc178
#define DWC3_GDBGEPINFO1	0xc17c
116 117 118 119
#define DWC3_GPRTBIMAP_HS0	0xc180
#define DWC3_GPRTBIMAP_HS1	0xc184
#define DWC3_GPRTBIMAP_FS0	0xc188
#define DWC3_GPRTBIMAP_FS1	0xc18c
120
#define DWC3_GUCTL2		0xc19c
121

J
John Youn 已提交
122 123 124
#define DWC3_VER_NUMBER		0xc1a0
#define DWC3_VER_TYPE		0xc1a4

125 126
#define DWC3_GUSB2PHYCFG(n)	(0xc200 + ((n) * 0x04))
#define DWC3_GUSB2I2CCTL(n)	(0xc240 + ((n) * 0x04))
127

128
#define DWC3_GUSB2PHYACC(n)	(0xc280 + ((n) * 0x04))
129

130
#define DWC3_GUSB3PIPECTL(n)	(0xc2c0 + ((n) * 0x04))
131

132 133
#define DWC3_GTXFIFOSIZ(n)	(0xc300 + ((n) * 0x04))
#define DWC3_GRXFIFOSIZ(n)	(0xc380 + ((n) * 0x04))
134

135 136 137 138
#define DWC3_GEVNTADRLO(n)	(0xc400 + ((n) * 0x10))
#define DWC3_GEVNTADRHI(n)	(0xc404 + ((n) * 0x10))
#define DWC3_GEVNTSIZ(n)	(0xc408 + ((n) * 0x10))
#define DWC3_GEVNTCOUNT(n)	(0xc40c + ((n) * 0x10))
139 140

#define DWC3_GHWPARAMS8		0xc600
141
#define DWC3_GUCTL3		0xc60c
142
#define DWC3_GFLADJ		0xc630
143 144 145 146 147 148 149 150 151

/* Device Registers */
#define DWC3_DCFG		0xc700
#define DWC3_DCTL		0xc704
#define DWC3_DEVTEN		0xc708
#define DWC3_DSTS		0xc70c
#define DWC3_DGCMDPAR		0xc710
#define DWC3_DGCMD		0xc714
#define DWC3_DALEPENA		0xc720
152

153
#define DWC3_DEP_BASE(n)	(0xc800 + ((n) * 0x10))
154 155 156 157
#define DWC3_DEPCMDPAR2		0x00
#define DWC3_DEPCMDPAR1		0x04
#define DWC3_DEPCMDPAR0		0x08
#define DWC3_DEPCMD		0x0c
158

159
#define DWC3_DEV_IMOD(n)	(0xca00 + ((n) * 0x4))
160

161 162 163
/* OTG Registers */
#define DWC3_OCFG		0xcc00
#define DWC3_OCTL		0xcc04
164 165 166
#define DWC3_OEVT		0xcc08
#define DWC3_OEVTEN		0xcc0C
#define DWC3_OSTS		0xcc10
167 168 169

/* Bit fields */

170 171 172 173 174 175 176 177 178 179 180
/* Global SoC Bus Configuration INCRx Register 0 */
#define DWC3_GSBUSCFG0_INCR256BRSTENA	(1 << 7) /* INCR256 burst */
#define DWC3_GSBUSCFG0_INCR128BRSTENA	(1 << 6) /* INCR128 burst */
#define DWC3_GSBUSCFG0_INCR64BRSTENA	(1 << 5) /* INCR64 burst */
#define DWC3_GSBUSCFG0_INCR32BRSTENA	(1 << 4) /* INCR32 burst */
#define DWC3_GSBUSCFG0_INCR16BRSTENA	(1 << 3) /* INCR16 burst */
#define DWC3_GSBUSCFG0_INCR8BRSTENA	(1 << 2) /* INCR8 burst */
#define DWC3_GSBUSCFG0_INCR4BRSTENA	(1 << 1) /* INCR4 burst */
#define DWC3_GSBUSCFG0_INCRBRSTENA	(1 << 0) /* undefined length enable */
#define DWC3_GSBUSCFG0_INCRBRST_MASK	0xff

181 182 183 184 185 186
/* Global Debug LSP MUX Select */
#define DWC3_GDBGLSPMUX_ENDBC		BIT(15)	/* Host only */
#define DWC3_GDBGLSPMUX_HOSTSELECT(n)	((n) & 0x3fff)
#define DWC3_GDBGLSPMUX_DEVSELECT(n)	(((n) & 0xf) << 4)
#define DWC3_GDBGLSPMUX_EPSELECT(n)	((n) & 0xf)

187 188 189 190 191
/* Global Debug Queue/FIFO Space Available Register */
#define DWC3_GDBGFIFOSPACE_NUM(n)	((n) & 0x1f)
#define DWC3_GDBGFIFOSPACE_TYPE(n)	(((n) << 5) & 0x1e0)
#define DWC3_GDBGFIFOSPACE_SPACE_AVAILABLE(n) (((n) >> 16) & 0xffff)

192 193
#define DWC3_TXFIFO		0
#define DWC3_RXFIFO		1
194 195 196 197 198 199 200
#define DWC3_TXREQQ		2
#define DWC3_RXREQQ		3
#define DWC3_RXINFOQ		4
#define DWC3_PSTATQ		5
#define DWC3_DESCFETCHQ		6
#define DWC3_EVENTQ		7
#define DWC3_AUXEVENTQ		8
201

202 203 204
/* Global RX Threshold Configuration Register */
#define DWC3_GRXTHRCFG_MAXRXBURSTSIZE(n) (((n) & 0x1f) << 19)
#define DWC3_GRXTHRCFG_RXPKTCNT(n) (((n) & 0xf) << 24)
205
#define DWC3_GRXTHRCFG_PKTCNTSEL BIT(29)
206

207 208 209 210 211 212 213 214 215 216
/* Global RX Threshold Configuration Register for DWC_usb31 only */
#define DWC31_GRXTHRCFG_MAXRXBURSTSIZE(n)	(((n) & 0x1f) << 16)
#define DWC31_GRXTHRCFG_RXPKTCNT(n)		(((n) & 0x1f) << 21)
#define DWC31_GRXTHRCFG_PKTCNTSEL		BIT(26)
#define DWC31_RXTHRNUMPKTSEL_HS_PRD		BIT(15)
#define DWC31_RXTHRNUMPKT_HS_PRD(n)		(((n) & 0x3) << 13)
#define DWC31_RXTHRNUMPKTSEL_PRD		BIT(10)
#define DWC31_RXTHRNUMPKT_PRD(n)		(((n) & 0x1f) << 5)
#define DWC31_MAXRXBURSTSIZE_PRD(n)		((n) & 0x1f)

217 218 219 220 221 222 223 224 225 226
/* Global TX Threshold Configuration Register for DWC_usb31 only */
#define DWC31_GTXTHRCFG_MAXTXBURSTSIZE(n)	(((n) & 0x1f) << 16)
#define DWC31_GTXTHRCFG_TXPKTCNT(n)		(((n) & 0x1f) << 21)
#define DWC31_GTXTHRCFG_PKTCNTSEL		BIT(26)
#define DWC31_TXTHRNUMPKTSEL_HS_PRD		BIT(15)
#define DWC31_TXTHRNUMPKT_HS_PRD(n)		(((n) & 0x3) << 13)
#define DWC31_TXTHRNUMPKTSEL_PRD		BIT(10)
#define DWC31_TXTHRNUMPKT_PRD(n)		(((n) & 0x1f) << 5)
#define DWC31_MAXTXBURSTSIZE_PRD(n)		((n) & 0x1f)

227
/* Global Configuration Register */
228
#define DWC3_GCTL_PWRDNSCALE(n)	((n) << 19)
229
#define DWC3_GCTL_U2RSTECN	BIT(16)
230
#define DWC3_GCTL_RAMCLKSEL(x)	(((x) & DWC3_GCTL_CLK_MASK) << 6)
231 232 233 234 235
#define DWC3_GCTL_CLK_BUS	(0)
#define DWC3_GCTL_CLK_PIPE	(1)
#define DWC3_GCTL_CLK_PIPEHALF	(2)
#define DWC3_GCTL_CLK_MASK	(3)

236
#define DWC3_GCTL_PRTCAP(n)	(((n) & (3 << 12)) >> 12)
237
#define DWC3_GCTL_PRTCAPDIR(n)	((n) << 12)
238 239 240 241
#define DWC3_GCTL_PRTCAP_HOST	1
#define DWC3_GCTL_PRTCAP_DEVICE	2
#define DWC3_GCTL_PRTCAP_OTG	3

242 243
#define DWC3_GCTL_CORESOFTRESET		BIT(11)
#define DWC3_GCTL_SOFITPSYNC		BIT(10)
244 245
#define DWC3_GCTL_SCALEDOWN(n)		((n) << 4)
#define DWC3_GCTL_SCALEDOWN_MASK	DWC3_GCTL_SCALEDOWN(3)
246 247 248 249
#define DWC3_GCTL_DISSCRAMBLE		BIT(3)
#define DWC3_GCTL_U2EXIT_LFPS		BIT(2)
#define DWC3_GCTL_GBLHIBERNATIONEN	BIT(1)
#define DWC3_GCTL_DSBLCLKGTNG		BIT(0)
250

251 252 253
/* Global User Control Register */
#define DWC3_GUCTL_HSTINAUTORETRY	BIT(14)

254
/* Global User Control 1 Register */
255
#define DWC3_GUCTL1_PARKMODE_DISABLE_SS	BIT(17)
256
#define DWC3_GUCTL1_TX_IPGAP_LINECHECK_DIS	BIT(28)
257
#define DWC3_GUCTL1_DEV_L1_EXIT_BY_HW	BIT(24)
258

259 260 261 262 263 264 265 266
/* Global Status Register */
#define DWC3_GSTS_OTG_IP	BIT(10)
#define DWC3_GSTS_BC_IP		BIT(9)
#define DWC3_GSTS_ADP_IP	BIT(8)
#define DWC3_GSTS_HOST_IP	BIT(7)
#define DWC3_GSTS_DEVICE_IP	BIT(6)
#define DWC3_GSTS_CSR_TIMEOUT	BIT(5)
#define DWC3_GSTS_BUS_ERR_ADDR_VLD	BIT(4)
267 268 269
#define DWC3_GSTS_CURMOD(n)	((n) & 0x3)
#define DWC3_GSTS_CURMOD_DEVICE	0
#define DWC3_GSTS_CURMOD_HOST	1
270

271
/* Global USB2 PHY Configuration Register */
272 273 274 275 276
#define DWC3_GUSB2PHYCFG_PHYSOFTRST	BIT(31)
#define DWC3_GUSB2PHYCFG_U2_FREECLK_EXISTS	BIT(30)
#define DWC3_GUSB2PHYCFG_SUSPHY		BIT(6)
#define DWC3_GUSB2PHYCFG_ULPI_UTMI	BIT(4)
#define DWC3_GUSB2PHYCFG_ENBLSLPM	BIT(8)
277 278 279 280 281 282 283 284
#define DWC3_GUSB2PHYCFG_PHYIF(n)	(n << 3)
#define DWC3_GUSB2PHYCFG_PHYIF_MASK	DWC3_GUSB2PHYCFG_PHYIF(1)
#define DWC3_GUSB2PHYCFG_USBTRDTIM(n)	(n << 10)
#define DWC3_GUSB2PHYCFG_USBTRDTIM_MASK	DWC3_GUSB2PHYCFG_USBTRDTIM(0xf)
#define USBTRDTIM_UTMI_8_BIT		9
#define USBTRDTIM_UTMI_16_BIT		5
#define UTMI_PHYIF_16_BIT		1
#define UTMI_PHYIF_8_BIT		0
285

286
/* Global USB2 PHY Vendor Control Register */
287
#define DWC3_GUSB2PHYACC_NEWREGREQ	BIT(25)
288
#define DWC3_GUSB2PHYACC_DONE		BIT(24)
289 290
#define DWC3_GUSB2PHYACC_BUSY		BIT(23)
#define DWC3_GUSB2PHYACC_WRITE		BIT(22)
291 292 293 294
#define DWC3_GUSB2PHYACC_ADDR(n)	(n << 16)
#define DWC3_GUSB2PHYACC_EXTEND_ADDR(n)	(n << 8)
#define DWC3_GUSB2PHYACC_DATA(n)	(n & 0xff)

295
/* Global USB3 PIPE Control Register */
296 297 298 299 300
#define DWC3_GUSB3PIPECTL_PHYSOFTRST	BIT(31)
#define DWC3_GUSB3PIPECTL_U2SSINP3OK	BIT(29)
#define DWC3_GUSB3PIPECTL_DISRXDETINP3	BIT(28)
#define DWC3_GUSB3PIPECTL_UX_EXIT_PX	BIT(27)
#define DWC3_GUSB3PIPECTL_REQP1P2P3	BIT(24)
H
Huang Rui 已提交
301 302 303
#define DWC3_GUSB3PIPECTL_DEP1P2P3(n)	((n) << 19)
#define DWC3_GUSB3PIPECTL_DEP1P2P3_MASK	DWC3_GUSB3PIPECTL_DEP1P2P3(7)
#define DWC3_GUSB3PIPECTL_DEP1P2P3_EN	DWC3_GUSB3PIPECTL_DEP1P2P3(1)
304 305 306 307
#define DWC3_GUSB3PIPECTL_DEPOCHANGE	BIT(18)
#define DWC3_GUSB3PIPECTL_SUSPHY	BIT(17)
#define DWC3_GUSB3PIPECTL_LFPSFILT	BIT(9)
#define DWC3_GUSB3PIPECTL_RX_DETOPOLL	BIT(8)
H
Huang Rui 已提交
308 309
#define DWC3_GUSB3PIPECTL_TX_DEEPH_MASK	DWC3_GUSB3PIPECTL_TX_DEEPH(3)
#define DWC3_GUSB3PIPECTL_TX_DEEPH(n)	((n) << 1)
310

311
/* Global TX Fifo Size Register */
312
#define DWC31_GTXFIFOSIZ_TXFRAMNUM	BIT(15)		/* DWC_usb31 only */
313 314
#define DWC31_GTXFIFOSIZ_TXFDEP(n)	((n) & 0x7fff)	/* DWC_usb31 only */
#define DWC3_GTXFIFOSIZ_TXFDEP(n)	((n) & 0xffff)
315
#define DWC3_GTXFIFOSIZ_TXFSTADDR(n)	((n) & 0xffff0000)
316

317 318 319 320
/* Global RX Fifo Size Register */
#define DWC31_GRXFIFOSIZ_RXFDEP(n)	((n) & 0x7fff)	/* DWC_usb31 only */
#define DWC3_GRXFIFOSIZ_RXFDEP(n)	((n) & 0xffff)

321
/* Global Event Size Registers */
322
#define DWC3_GEVNTSIZ_INTMASK		BIT(31)
323 324
#define DWC3_GEVNTSIZ_SIZE(n)		((n) & 0xffff)

325
/* Global HWPARAMS0 Register */
T
Thinh Nguyen 已提交
326 327 328 329
#define DWC3_GHWPARAMS0_MODE(n)		((n) & 0x3)
#define DWC3_GHWPARAMS0_MODE_GADGET	0
#define DWC3_GHWPARAMS0_MODE_HOST	1
#define DWC3_GHWPARAMS0_MODE_DRD	2
330 331 332 333 334 335
#define DWC3_GHWPARAMS0_MBUS_TYPE(n)	(((n) >> 3) & 0x7)
#define DWC3_GHWPARAMS0_SBUS_TYPE(n)	(((n) >> 6) & 0x3)
#define DWC3_GHWPARAMS0_MDWIDTH(n)	(((n) >> 8) & 0xff)
#define DWC3_GHWPARAMS0_SDWIDTH(n)	(((n) >> 16) & 0xff)
#define DWC3_GHWPARAMS0_AWIDTH(n)	(((n) >> 24) & 0xff)

336
/* Global HWPARAMS1 Register */
337
#define DWC3_GHWPARAMS1_EN_PWROPT(n)	(((n) & (3 << 24)) >> 24)
338 339
#define DWC3_GHWPARAMS1_EN_PWROPT_NO	0
#define DWC3_GHWPARAMS1_EN_PWROPT_CLK	1
340 341 342
#define DWC3_GHWPARAMS1_EN_PWROPT_HIB	2
#define DWC3_GHWPARAMS1_PWROPT(n)	((n) << 24)
#define DWC3_GHWPARAMS1_PWROPT_MASK	DWC3_GHWPARAMS1_PWROPT(3)
343
#define DWC3_GHWPARAMS1_ENDBC		BIT(31)
344

345 346 347
/* Global HWPARAMS3 Register */
#define DWC3_GHWPARAMS3_SSPHY_IFC(n)		((n) & 3)
#define DWC3_GHWPARAMS3_SSPHY_IFC_DIS		0
348 349
#define DWC3_GHWPARAMS3_SSPHY_IFC_GEN1		1
#define DWC3_GHWPARAMS3_SSPHY_IFC_GEN2		2 /* DWC_usb31 only */
350 351 352 353 354 355 356 357 358
#define DWC3_GHWPARAMS3_HSPHY_IFC(n)		(((n) & (3 << 2)) >> 2)
#define DWC3_GHWPARAMS3_HSPHY_IFC_DIS		0
#define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI		1
#define DWC3_GHWPARAMS3_HSPHY_IFC_ULPI		2
#define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI_ULPI	3
#define DWC3_GHWPARAMS3_FSPHY_IFC(n)		(((n) & (3 << 4)) >> 4)
#define DWC3_GHWPARAMS3_FSPHY_IFC_DIS		0
#define DWC3_GHWPARAMS3_FSPHY_IFC_ENA		1

359 360 361
/* Global HWPARAMS4 Register */
#define DWC3_GHWPARAMS4_HIBER_SCRATCHBUFS(n)	(((n) & (0x0f << 13)) >> 13)
#define DWC3_MAX_HIBER_SCRATCHBUFS		15
362

363
/* Global HWPARAMS6 Register */
364 365 366 367 368
#define DWC3_GHWPARAMS6_BCSUPPORT		BIT(14)
#define DWC3_GHWPARAMS6_OTG3SUPPORT		BIT(13)
#define DWC3_GHWPARAMS6_ADPSUPPORT		BIT(12)
#define DWC3_GHWPARAMS6_HNPSUPPORT		BIT(11)
#define DWC3_GHWPARAMS6_SRPSUPPORT		BIT(10)
369
#define DWC3_GHWPARAMS6_EN_FPGA			BIT(7)
370

371 372 373
/* DWC_usb32 only */
#define DWC3_GHWPARAMS6_MDWIDTH(n)		((n) & (0x3 << 8))

374 375 376 377
/* Global HWPARAMS7 Register */
#define DWC3_GHWPARAMS7_RAM1_DEPTH(n)	((n) & 0xffff)
#define DWC3_GHWPARAMS7_RAM2_DEPTH(n)	(((n) >> 16) & 0xffff)

378
/* Global Frame Length Adjustment Register */
379
#define DWC3_GFLADJ_30MHZ_SDBND_SEL		BIT(7)
380 381
#define DWC3_GFLADJ_30MHZ_MASK			0x3f

382
/* Global User Control Register 2 */
383
#define DWC3_GUCTL2_RST_ACTBITLATER		BIT(14)
384

385 386 387
/* Global User Control Register 3 */
#define DWC3_GUCTL3_SPLITDISABLE		BIT(14)

388 389 390 391 392
/* Device Configuration Register */
#define DWC3_DCFG_DEVADDR(addr)	((addr) << 3)
#define DWC3_DCFG_DEVADDR_MASK	DWC3_DCFG_DEVADDR(0x7f)

#define DWC3_DCFG_SPEED_MASK	(7 << 0)
393
#define DWC3_DCFG_SUPERSPEED_PLUS (5 << 0)  /* DWC_usb31 only */
394 395
#define DWC3_DCFG_SUPERSPEED	(4 << 0)
#define DWC3_DCFG_HIGHSPEED	(0 << 0)
396
#define DWC3_DCFG_FULLSPEED	BIT(0)
397 398
#define DWC3_DCFG_LOWSPEED	(2 << 0)

399
#define DWC3_DCFG_NUMP_SHIFT	17
400
#define DWC3_DCFG_NUMP(n)	(((n) >> DWC3_DCFG_NUMP_SHIFT) & 0x1f)
401
#define DWC3_DCFG_NUMP_MASK	(0x1f << DWC3_DCFG_NUMP_SHIFT)
402
#define DWC3_DCFG_LPM_CAP	BIT(22)
403

404
/* Device Control Register */
405 406 407
#define DWC3_DCTL_RUN_STOP	BIT(31)
#define DWC3_DCTL_CSFTRST	BIT(30)
#define DWC3_DCTL_LSFTRST	BIT(29)
408 409

#define DWC3_DCTL_HIRD_THRES_MASK	(0x1f << 24)
410
#define DWC3_DCTL_HIRD_THRES(n)	((n) << 24)
411

412
#define DWC3_DCTL_APPL1RES	BIT(23)
413

414 415 416 417 418 419 420 421 422 423
/* These apply for core versions 1.87a and earlier */
#define DWC3_DCTL_TRGTULST_MASK		(0x0f << 17)
#define DWC3_DCTL_TRGTULST(n)		((n) << 17)
#define DWC3_DCTL_TRGTULST_U2		(DWC3_DCTL_TRGTULST(2))
#define DWC3_DCTL_TRGTULST_U3		(DWC3_DCTL_TRGTULST(3))
#define DWC3_DCTL_TRGTULST_SS_DIS	(DWC3_DCTL_TRGTULST(4))
#define DWC3_DCTL_TRGTULST_RX_DET	(DWC3_DCTL_TRGTULST(5))
#define DWC3_DCTL_TRGTULST_SS_INACT	(DWC3_DCTL_TRGTULST(6))

/* These apply for core versions 1.94a and later */
424
#define DWC3_DCTL_NYET_THRES(n)		(((n) & 0xf) << 20)
425

426 427 428 429
#define DWC3_DCTL_KEEP_CONNECT		BIT(19)
#define DWC3_DCTL_L1_HIBER_EN		BIT(18)
#define DWC3_DCTL_CRS			BIT(17)
#define DWC3_DCTL_CSS			BIT(16)
H
Huang Rui 已提交
430

431 432 433 434
#define DWC3_DCTL_INITU2ENA		BIT(12)
#define DWC3_DCTL_ACCEPTU2ENA		BIT(11)
#define DWC3_DCTL_INITU1ENA		BIT(10)
#define DWC3_DCTL_ACCEPTU1ENA		BIT(9)
H
Huang Rui 已提交
435
#define DWC3_DCTL_TSTCTRL_MASK		(0xf << 1)
436 437 438 439 440 441 442 443 444 445 446 447 448

#define DWC3_DCTL_ULSTCHNGREQ_MASK	(0x0f << 5)
#define DWC3_DCTL_ULSTCHNGREQ(n) (((n) << 5) & DWC3_DCTL_ULSTCHNGREQ_MASK)

#define DWC3_DCTL_ULSTCHNG_NO_ACTION	(DWC3_DCTL_ULSTCHNGREQ(0))
#define DWC3_DCTL_ULSTCHNG_SS_DISABLED	(DWC3_DCTL_ULSTCHNGREQ(4))
#define DWC3_DCTL_ULSTCHNG_RX_DETECT	(DWC3_DCTL_ULSTCHNGREQ(5))
#define DWC3_DCTL_ULSTCHNG_SS_INACTIVE	(DWC3_DCTL_ULSTCHNGREQ(6))
#define DWC3_DCTL_ULSTCHNG_RECOVERY	(DWC3_DCTL_ULSTCHNGREQ(8))
#define DWC3_DCTL_ULSTCHNG_COMPLIANCE	(DWC3_DCTL_ULSTCHNGREQ(10))
#define DWC3_DCTL_ULSTCHNG_LOOPBACK	(DWC3_DCTL_ULSTCHNGREQ(11))

/* Device Event Enable Register */
449 450 451 452 453 454 455 456 457 458 459 460
#define DWC3_DEVTEN_VNDRDEVTSTRCVEDEN	BIT(12)
#define DWC3_DEVTEN_EVNTOVERFLOWEN	BIT(11)
#define DWC3_DEVTEN_CMDCMPLTEN		BIT(10)
#define DWC3_DEVTEN_ERRTICERREN		BIT(9)
#define DWC3_DEVTEN_SOFEN		BIT(7)
#define DWC3_DEVTEN_EOPFEN		BIT(6)
#define DWC3_DEVTEN_HIBERNATIONREQEVTEN	BIT(5)
#define DWC3_DEVTEN_WKUPEVTEN		BIT(4)
#define DWC3_DEVTEN_ULSTCNGEN		BIT(3)
#define DWC3_DEVTEN_CONNECTDONEEN	BIT(2)
#define DWC3_DEVTEN_USBRSTEN		BIT(1)
#define DWC3_DEVTEN_DISCONNEVTEN	BIT(0)
461 462

/* Device Status Register */
463
#define DWC3_DSTS_DCNRD			BIT(29)
464 465

/* This applies for core versions 1.87a and earlier */
466
#define DWC3_DSTS_PWRUPREQ		BIT(24)
467 468

/* These apply for core versions 1.94a and later */
469 470
#define DWC3_DSTS_RSS			BIT(25)
#define DWC3_DSTS_SSS			BIT(24)
471

472 473
#define DWC3_DSTS_COREIDLE		BIT(23)
#define DWC3_DSTS_DEVCTRLHLT		BIT(22)
474 475 476 477

#define DWC3_DSTS_USBLNKST_MASK		(0x0f << 18)
#define DWC3_DSTS_USBLNKST(n)		(((n) & DWC3_DSTS_USBLNKST_MASK) >> 18)

478
#define DWC3_DSTS_RXFIFOEMPTY		BIT(17)
479

480
#define DWC3_DSTS_SOFFN_MASK		(0x3fff << 3)
481 482 483 484
#define DWC3_DSTS_SOFFN(n)		(((n) & DWC3_DSTS_SOFFN_MASK) >> 3)

#define DWC3_DSTS_CONNECTSPD		(7 << 0)

485
#define DWC3_DSTS_SUPERSPEED_PLUS	(5 << 0) /* DWC_usb31 only */
486 487
#define DWC3_DSTS_SUPERSPEED		(4 << 0)
#define DWC3_DSTS_HIGHSPEED		(0 << 0)
488
#define DWC3_DSTS_FULLSPEED		BIT(0)
489 490 491 492 493 494
#define DWC3_DSTS_LOWSPEED		(2 << 0)

/* Device Generic Command Register */
#define DWC3_DGCMD_SET_LMP		0x01
#define DWC3_DGCMD_SET_PERIODIC_PAR	0x02
#define DWC3_DGCMD_XMIT_FUNCTION	0x03
495 496 497 498 499

/* These apply for core versions 1.94a and later */
#define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO	0x04
#define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI	0x05

500 501 502
#define DWC3_DGCMD_SELECTED_FIFO_FLUSH	0x09
#define DWC3_DGCMD_ALL_FIFO_FLUSH	0x0a
#define DWC3_DGCMD_SET_ENDPOINT_NRDY	0x0c
503
#define DWC3_DGCMD_SET_ENDPOINT_PRIME	0x0d
504 505
#define DWC3_DGCMD_RUN_SOC_BUS_LOOPBACK	0x10

506
#define DWC3_DGCMD_STATUS(n)		(((n) >> 12) & 0x0F)
507 508
#define DWC3_DGCMD_CMDACT		BIT(10)
#define DWC3_DGCMD_CMDIOC		BIT(8)
509 510

/* Device Generic Command Parameter Register */
511
#define DWC3_DGCMDPAR_FORCE_LINKPM_ACCEPT	BIT(0)
512 513
#define DWC3_DGCMDPAR_FIFO_NUM(n)		((n) << 0)
#define DWC3_DGCMDPAR_RX_FIFO			(0 << 5)
514
#define DWC3_DGCMDPAR_TX_FIFO			BIT(5)
515
#define DWC3_DGCMDPAR_LOOPBACK_DIS		(0 << 0)
516
#define DWC3_DGCMDPAR_LOOPBACK_ENA		BIT(0)
517

518 519
/* Device Endpoint Command Register */
#define DWC3_DEPCMD_PARAM_SHIFT		16
520
#define DWC3_DEPCMD_PARAM(x)		((x) << DWC3_DEPCMD_PARAM_SHIFT)
F
Felipe Balbi 已提交
521
#define DWC3_DEPCMD_GET_RSC_IDX(x)	(((x) >> DWC3_DEPCMD_PARAM_SHIFT) & 0x7f)
522
#define DWC3_DEPCMD_STATUS(x)		(((x) >> 12) & 0x0F)
523 524 525 526
#define DWC3_DEPCMD_HIPRI_FORCERM	BIT(11)
#define DWC3_DEPCMD_CLEARPENDIN		BIT(11)
#define DWC3_DEPCMD_CMDACT		BIT(10)
#define DWC3_DEPCMD_CMDIOC		BIT(8)
527 528 529 530 531 532 533

#define DWC3_DEPCMD_DEPSTARTCFG		(0x09 << 0)
#define DWC3_DEPCMD_ENDTRANSFER		(0x08 << 0)
#define DWC3_DEPCMD_UPDATETRANSFER	(0x07 << 0)
#define DWC3_DEPCMD_STARTTRANSFER	(0x06 << 0)
#define DWC3_DEPCMD_CLEARSTALL		(0x05 << 0)
#define DWC3_DEPCMD_SETSTALL		(0x04 << 0)
534
/* This applies for core versions 1.90a and earlier */
535
#define DWC3_DEPCMD_GETSEQNUMBER	(0x03 << 0)
536 537
/* This applies for core versions 1.94a and later */
#define DWC3_DEPCMD_GETEPSTATE		(0x03 << 0)
538 539 540
#define DWC3_DEPCMD_SETTRANSFRESOURCE	(0x02 << 0)
#define DWC3_DEPCMD_SETEPCONFIG		(0x01 << 0)

541 542
#define DWC3_DEPCMD_CMD(x)		((x) & 0xf)

543
/* The EP number goes 0..31 so ep0 is always out and ep1 is always in */
544
#define DWC3_DALEPENA_EP(n)		BIT(n)
545 546 547 548 549 550

#define DWC3_DEPCMD_TYPE_CONTROL	0
#define DWC3_DEPCMD_TYPE_ISOC		1
#define DWC3_DEPCMD_TYPE_BULK		2
#define DWC3_DEPCMD_TYPE_INTR		3

551 552 553 554 555
#define DWC3_DEV_IMOD_COUNT_SHIFT	16
#define DWC3_DEV_IMOD_COUNT_MASK	(0xffff << 16)
#define DWC3_DEV_IMOD_INTERVAL_SHIFT	0
#define DWC3_DEV_IMOD_INTERVAL_MASK	(0xffff << 0)

556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
/* OTG Configuration Register */
#define DWC3_OCFG_DISPWRCUTTOFF		BIT(5)
#define DWC3_OCFG_HIBDISMASK		BIT(4)
#define DWC3_OCFG_SFTRSTMASK		BIT(3)
#define DWC3_OCFG_OTGVERSION		BIT(2)
#define DWC3_OCFG_HNPCAP		BIT(1)
#define DWC3_OCFG_SRPCAP		BIT(0)

/* OTG CTL Register */
#define DWC3_OCTL_OTG3GOERR		BIT(7)
#define DWC3_OCTL_PERIMODE		BIT(6)
#define DWC3_OCTL_PRTPWRCTL		BIT(5)
#define DWC3_OCTL_HNPREQ		BIT(4)
#define DWC3_OCTL_SESREQ		BIT(3)
#define DWC3_OCTL_TERMSELIDPULSE	BIT(2)
#define DWC3_OCTL_DEVSETHNPEN		BIT(1)
#define DWC3_OCTL_HSTSETHNPEN		BIT(0)

/* OTG Event Register */
#define DWC3_OEVT_DEVICEMODE		BIT(31)
#define DWC3_OEVT_XHCIRUNSTPSET		BIT(27)
#define DWC3_OEVT_DEVRUNSTPSET		BIT(26)
#define DWC3_OEVT_HIBENTRY		BIT(25)
#define DWC3_OEVT_CONIDSTSCHNG		BIT(24)
#define DWC3_OEVT_HRRCONFNOTIF		BIT(23)
#define DWC3_OEVT_HRRINITNOTIF		BIT(22)
#define DWC3_OEVT_ADEVIDLE		BIT(21)
#define DWC3_OEVT_ADEVBHOSTEND		BIT(20)
#define DWC3_OEVT_ADEVHOST		BIT(19)
#define DWC3_OEVT_ADEVHNPCHNG		BIT(18)
#define DWC3_OEVT_ADEVSRPDET		BIT(17)
#define DWC3_OEVT_ADEVSESSENDDET	BIT(16)
#define DWC3_OEVT_BDEVBHOSTEND		BIT(11)
#define DWC3_OEVT_BDEVHNPCHNG		BIT(10)
#define DWC3_OEVT_BDEVSESSVLDDET	BIT(9)
#define DWC3_OEVT_BDEVVBUSCHNG		BIT(8)
#define DWC3_OEVT_BSESSVLD		BIT(3)
#define DWC3_OEVT_HSTNEGSTS		BIT(2)
#define DWC3_OEVT_SESREQSTS		BIT(1)
#define DWC3_OEVT_ERROR			BIT(0)

/* OTG Event Enable Register */
#define DWC3_OEVTEN_XHCIRUNSTPSETEN	BIT(27)
#define DWC3_OEVTEN_DEVRUNSTPSETEN	BIT(26)
#define DWC3_OEVTEN_HIBENTRYEN		BIT(25)
#define DWC3_OEVTEN_CONIDSTSCHNGEN	BIT(24)
#define DWC3_OEVTEN_HRRCONFNOTIFEN	BIT(23)
#define DWC3_OEVTEN_HRRINITNOTIFEN	BIT(22)
#define DWC3_OEVTEN_ADEVIDLEEN		BIT(21)
#define DWC3_OEVTEN_ADEVBHOSTENDEN	BIT(20)
#define DWC3_OEVTEN_ADEVHOSTEN		BIT(19)
#define DWC3_OEVTEN_ADEVHNPCHNGEN	BIT(18)
#define DWC3_OEVTEN_ADEVSRPDETEN	BIT(17)
#define DWC3_OEVTEN_ADEVSESSENDDETEN	BIT(16)
#define DWC3_OEVTEN_BDEVBHOSTENDEN	BIT(11)
#define DWC3_OEVTEN_BDEVHNPCHNGEN	BIT(10)
#define DWC3_OEVTEN_BDEVSESSVLDDETEN	BIT(9)
#define DWC3_OEVTEN_BDEVVBUSCHNGEN	BIT(8)

/* OTG Status Register */
#define DWC3_OSTS_DEVRUNSTP		BIT(13)
#define DWC3_OSTS_XHCIRUNSTP		BIT(12)
#define DWC3_OSTS_PERIPHERALSTATE	BIT(4)
#define DWC3_OSTS_XHCIPRTPOWER		BIT(3)
#define DWC3_OSTS_BSESVLD		BIT(2)
#define DWC3_OSTS_VBUSVLD		BIT(1)
#define DWC3_OSTS_CONIDSTS		BIT(0)

624 625
/* Structures */

626
struct dwc3_trb;
627 628 629 630

/**
 * struct dwc3_event_buffer - Software event buffer representation
 * @buf: _THE_ buffer
631
 * @cache: The buffer cache used in the threaded interrupt
632
 * @length: size of this buffer
633
 * @lpos: event offset
634
 * @count: cache of last read event count register
635
 * @flags: flags related to this event buffer
636 637 638 639 640
 * @dma: dma_addr_t
 * @dwc: pointer to DWC controller
 */
struct dwc3_event_buffer {
	void			*buf;
641
	void			*cache;
642
	unsigned int		length;
643
	unsigned int		lpos;
644
	unsigned int		count;
645 646 647
	unsigned int		flags;

#define DWC3_EVENT_PENDING	BIT(0)
648 649 650 651 652 653

	dma_addr_t		dma;

	struct dwc3		*dwc;
};

654 655
#define DWC3_EP_FLAG_STALLED	BIT(0)
#define DWC3_EP_FLAG_WEDGED	BIT(1)
656 657 658 659

#define DWC3_EP_DIRECTION_TX	true
#define DWC3_EP_DIRECTION_RX	false

660
#define DWC3_TRB_NUM		256
661 662 663 664

/**
 * struct dwc3_ep - device side endpoint representation
 * @endpoint: usb endpoint
665
 * @cancelled_list: list of cancelled requests for this endpoint
666 667
 * @pending_list: list of pending requests for this endpoint
 * @started_list: list of started requests on this endpoint
668
 * @regs: pointer to first endpoint register
669 670
 * @trb_pool: array of transaction buffers
 * @trb_pool_dma: dma address of @trb_pool
671 672
 * @trb_enqueue: enqueue 'pointer' into TRB array
 * @trb_dequeue: dequeue 'pointer' into TRB array
673
 * @dwc: pointer to DWC controller
674
 * @saved_state: ep state saved during hibernation
675 676 677
 * @flags: endpoint flags (wedged, stalled, ...)
 * @number: endpoint number (1 - 15)
 * @type: set to bmAttributes & USB_ENDPOINT_XFERTYPE_MASK
678
 * @resource_index: Resource transfer index
679
 * @frame_number: set to the frame number we want this transfer to start (ISOC)
680
 * @interval: the interval on which the ISOC transfer is started
681 682
 * @name: a human readable name e.g. ep1out-bulk
 * @direction: true for TX, false for RX
683
 * @stream_capable: true when streams are enabled
684 685 686 687
 * @combo_num: the test combination BIT[15:14] of the frame number to test
 *		isochronous START TRANSFER command failure workaround
 * @start_cmd_status: the status of testing START TRANSFER command with
 *		combo_num = 'b00
688 689 690
 */
struct dwc3_ep {
	struct usb_ep		endpoint;
691
	struct list_head	cancelled_list;
692 693
	struct list_head	pending_list;
	struct list_head	started_list;
694

695 696
	void __iomem		*regs;

697
	struct dwc3_trb		*trb_pool;
698 699 700
	dma_addr_t		trb_pool_dma;
	struct dwc3		*dwc;

701
	u32			saved_state;
702
	unsigned int		flags;
703 704 705
#define DWC3_EP_ENABLED		BIT(0)
#define DWC3_EP_STALL		BIT(1)
#define DWC3_EP_WEDGE		BIT(2)
706
#define DWC3_EP_TRANSFER_STARTED BIT(3)
707
#define DWC3_EP_END_TRANSFER_PENDING BIT(4)
708
#define DWC3_EP_PENDING_REQUEST	BIT(5)
709
#define DWC3_EP_DELAY_START	BIT(6)
710
#define DWC3_EP_WAIT_TRANSFER_COMPLETE	BIT(7)
711 712 713
#define DWC3_EP_IGNORE_NEXT_NOSTREAM	BIT(8)
#define DWC3_EP_FORCE_RESTART_STREAM	BIT(9)
#define DWC3_EP_FIRST_STREAM_PRIMED	BIT(10)
714
#define DWC3_EP_PENDING_CLEAR_STALL	BIT(11)
715

716
	/* This last one is specific to EP0 */
717
#define DWC3_EP0_DIR_IN		BIT(31)
718

719 720 721 722 723 724 725 726 727 728 729 730
	/*
	 * IMPORTANT: we *know* we have 256 TRBs in our @trb_pool, so we will
	 * use a u8 type here. If anybody decides to increase number of TRBs to
	 * anything larger than 256 - I can't see why people would want to do
	 * this though - then this type needs to be changed.
	 *
	 * By using u8 types we ensure that our % operator when incrementing
	 * enqueue and dequeue get optimized away by the compiler.
	 */
	u8			trb_enqueue;
	u8			trb_dequeue;

731 732
	u8			number;
	u8			type;
733
	u8			resource_index;
734
	u32			frame_number;
735 736 737 738 739
	u32			interval;

	char			name[20];

	unsigned		direction:1;
740
	unsigned		stream_capable:1;
741 742 743 744

	/* For isochronous START TRANSFER workaround only */
	u8			combo_num;
	int			start_cmd_status;
745 746 747 748 749 750 751 752
};

enum dwc3_phy {
	DWC3_PHY_UNKNOWN = 0,
	DWC3_PHY_USB3,
	DWC3_PHY_USB2,
};

753 754 755 756 757 758 759
enum dwc3_ep0_next {
	DWC3_EP0_UNKNOWN = 0,
	DWC3_EP0_COMPLETE,
	DWC3_EP0_NRDY_DATA,
	DWC3_EP0_NRDY_STATUS,
};

760 761
enum dwc3_ep0_state {
	EP0_UNCONNECTED		= 0,
762 763 764
	EP0_SETUP_PHASE,
	EP0_DATA_PHASE,
	EP0_STATUS_PHASE,
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
};

enum dwc3_link_state {
	/* In SuperSpeed */
	DWC3_LINK_STATE_U0		= 0x00, /* in HS, means ON */
	DWC3_LINK_STATE_U1		= 0x01,
	DWC3_LINK_STATE_U2		= 0x02, /* in HS, means SLEEP */
	DWC3_LINK_STATE_U3		= 0x03, /* in HS, means SUSPEND */
	DWC3_LINK_STATE_SS_DIS		= 0x04,
	DWC3_LINK_STATE_RX_DET		= 0x05, /* in HS, means Early Suspend */
	DWC3_LINK_STATE_SS_INACT	= 0x06,
	DWC3_LINK_STATE_POLL		= 0x07,
	DWC3_LINK_STATE_RECOV		= 0x08,
	DWC3_LINK_STATE_HRESET		= 0x09,
	DWC3_LINK_STATE_CMPLY		= 0x0a,
	DWC3_LINK_STATE_LPBK		= 0x0b,
781 782
	DWC3_LINK_STATE_RESET		= 0x0e,
	DWC3_LINK_STATE_RESUME		= 0x0f,
783 784 785
	DWC3_LINK_STATE_MASK		= 0x0f,
};

786 787 788 789
/* TRB Length, PCM and Status */
#define DWC3_TRB_SIZE_MASK	(0x00ffffff)
#define DWC3_TRB_SIZE_LENGTH(n)	((n) & DWC3_TRB_SIZE_MASK)
#define DWC3_TRB_SIZE_PCM1(n)	(((n) & 0x03) << 24)
790
#define DWC3_TRB_SIZE_TRBSTS(n)	(((n) & (0x0f << 28)) >> 28)
791 792 793 794

#define DWC3_TRBSTS_OK			0
#define DWC3_TRBSTS_MISSED_ISOC		1
#define DWC3_TRBSTS_SETUP_PENDING	2
795
#define DWC3_TRB_STS_XFER_IN_PROG	4
796 797

/* TRB Control */
798 799 800 801
#define DWC3_TRB_CTRL_HWO		BIT(0)
#define DWC3_TRB_CTRL_LST		BIT(1)
#define DWC3_TRB_CTRL_CHN		BIT(2)
#define DWC3_TRB_CTRL_CSP		BIT(3)
802
#define DWC3_TRB_CTRL_TRBCTL(n)		(((n) & 0x3f) << 4)
803 804
#define DWC3_TRB_CTRL_ISP_IMI		BIT(10)
#define DWC3_TRB_CTRL_IOC		BIT(11)
805
#define DWC3_TRB_CTRL_SID_SOFN(n)	(((n) & 0xffff) << 14)
806
#define DWC3_TRB_CTRL_GET_SID_SOFN(n)	(((n) & (0xffff << 14)) >> 14)
807

808
#define DWC3_TRBCTL_TYPE(n)		((n) & (0x3f << 4))
809 810 811 812 813 814 815 816
#define DWC3_TRBCTL_NORMAL		DWC3_TRB_CTRL_TRBCTL(1)
#define DWC3_TRBCTL_CONTROL_SETUP	DWC3_TRB_CTRL_TRBCTL(2)
#define DWC3_TRBCTL_CONTROL_STATUS2	DWC3_TRB_CTRL_TRBCTL(3)
#define DWC3_TRBCTL_CONTROL_STATUS3	DWC3_TRB_CTRL_TRBCTL(4)
#define DWC3_TRBCTL_CONTROL_DATA	DWC3_TRB_CTRL_TRBCTL(5)
#define DWC3_TRBCTL_ISOCHRONOUS_FIRST	DWC3_TRB_CTRL_TRBCTL(6)
#define DWC3_TRBCTL_ISOCHRONOUS		DWC3_TRB_CTRL_TRBCTL(7)
#define DWC3_TRBCTL_LINK_TRB		DWC3_TRB_CTRL_TRBCTL(8)
817 818

/**
819
 * struct dwc3_trb - transfer request block (hw format)
820 821 822
 * @bpl: DW0-3
 * @bph: DW4-7
 * @size: DW8-B
F
Felipe Balbi 已提交
823
 * @ctrl: DWC-F
824
 */
825 826 827 828 829
struct dwc3_trb {
	u32		bpl;
	u32		bph;
	u32		size;
	u32		ctrl;
830 831
} __packed;

F
Felipe Balbi 已提交
832
/**
F
Felipe Balbi 已提交
833 834 835 836 837 838 839 840 841 842
 * struct dwc3_hwparams - copy of HWPARAMS registers
 * @hwparams0: GHWPARAMS0
 * @hwparams1: GHWPARAMS1
 * @hwparams2: GHWPARAMS2
 * @hwparams3: GHWPARAMS3
 * @hwparams4: GHWPARAMS4
 * @hwparams5: GHWPARAMS5
 * @hwparams6: GHWPARAMS6
 * @hwparams7: GHWPARAMS7
 * @hwparams8: GHWPARAMS8
F
Felipe Balbi 已提交
843 844 845 846 847 848 849 850 851 852 853 854 855
 */
struct dwc3_hwparams {
	u32	hwparams0;
	u32	hwparams1;
	u32	hwparams2;
	u32	hwparams3;
	u32	hwparams4;
	u32	hwparams5;
	u32	hwparams6;
	u32	hwparams7;
	u32	hwparams8;
};

856 857 858
/* HWPARAMS0 */
#define DWC3_MODE(n)		((n) & 0x7)

859 860
#define DWC3_MDWIDTH(n)		(((n) & 0xff00) >> 8)

861
/* HWPARAMS1 */
862 863
#define DWC3_NUM_INT(n)		(((n) & (0x3f << 15)) >> 15)

864 865 866 867 868 869 870 871
/* HWPARAMS3 */
#define DWC3_NUM_IN_EPS_MASK	(0x1f << 18)
#define DWC3_NUM_EPS_MASK	(0x3f << 12)
#define DWC3_NUM_EPS(p)		(((p)->hwparams3 &		\
			(DWC3_NUM_EPS_MASK)) >> 12)
#define DWC3_NUM_IN_EPS(p)	(((p)->hwparams3 &		\
			(DWC3_NUM_IN_EPS_MASK)) >> 18)

872 873
/* HWPARAMS7 */
#define DWC3_RAM1_DEPTH(n)	((n) & 0xffff)
874

875 876 877 878 879
/**
 * struct dwc3_request - representation of a transfer request
 * @request: struct usb_request to be transferred
 * @list: a list_head used for request queueing
 * @dep: struct dwc3_ep owning this request
880
 * @sg: pointer to first incomplete sg
881
 * @start_sg: pointer to the sg which should be queued next
882
 * @num_pending_sgs: counter to pending sgs
883
 * @num_queued_sgs: counter to the number of sgs which already got queued
884
 * @remaining: amount of data remaining
885
 * @status: internal dwc3 request status tracking
886 887 888
 * @epnum: endpoint number to which this request refers
 * @trb: pointer to struct dwc3_trb
 * @trb_dma: DMA address of @trb
889
 * @num_trbs: number of TRBs used by this request
890 891
 * @needs_extra_trb: true when request needs one extra TRB (either due to ZLP
 *	or unaligned OUT)
892 893 894
 * @direction: IN or OUT direction flag
 * @mapped: true when request has been dma-mapped
 */
895 896 897 898
struct dwc3_request {
	struct usb_request	request;
	struct list_head	list;
	struct dwc3_ep		*dep;
899
	struct scatterlist	*sg;
900
	struct scatterlist	*start_sg;
901

902
	unsigned int		num_pending_sgs;
903
	unsigned int		num_queued_sgs;
904
	unsigned int		remaining;
905 906 907 908 909 910 911 912

	unsigned int		status;
#define DWC3_REQUEST_STATUS_QUEUED	0
#define DWC3_REQUEST_STATUS_STARTED	1
#define DWC3_REQUEST_STATUS_CANCELLED	2
#define DWC3_REQUEST_STATUS_COMPLETED	3
#define DWC3_REQUEST_STATUS_UNKNOWN	-1

913
	u8			epnum;
914
	struct dwc3_trb		*trb;
915 916
	dma_addr_t		trb_dma;

917
	unsigned int		num_trbs;
918

919 920 921
	unsigned int		needs_extra_trb:1;
	unsigned int		direction:1;
	unsigned int		mapped:1;
922 923
};

924 925 926 927 928 929 930 931
/*
 * struct dwc3_scratchpad_array - hibernation scratchpad array
 * (format defined by hw)
 */
struct dwc3_scratchpad_array {
	__le64	dma_adr[DWC3_MAX_HIBER_SCRATCHBUFS];
};

932 933
/**
 * struct dwc3 - representation of our controller
F
Felipe Balbi 已提交
934
 * @drd_work: workqueue used for role swapping
935
 * @ep0_trb: trb which is used for the ctrl_req
F
Felipe Balbi 已提交
936 937
 * @bounce: address of bounce buffer
 * @scratchbuf: address of scratch buffer
938
 * @setup_buf: used while precessing STD USB requests
F
Felipe Balbi 已提交
939 940
 * @ep0_trb_addr: dma address of @ep0_trb
 * @bounce_addr: dma address of @bounce
941
 * @ep0_usb_req: dummy req used while handling STD USB requests
942
 * @scratch_addr: dma address of scratchbuf
943
 * @ep0_in_setup: one control transfer is completed and enter setup phase
944 945
 * @lock: for synchronizing
 * @dev: pointer to our struct device
F
Felipe Balbi 已提交
946
 * @sysdev: pointer to the DMA-capable device
F
Felipe Balbi 已提交
947
 * @xhci: pointer to our xHCI child
F
Felipe Balbi 已提交
948 949 950
 * @xhci_resources: struct resources for our @xhci child
 * @ev_buf: struct dwc3_event_buffer pointer
 * @eps: endpoint array
951 952
 * @gadget: device side representation of the peripheral controller
 * @gadget_driver: pointer to the gadget driver
953 954 955
 * @clks: array of clocks
 * @num_clks: number of clocks
 * @reset: reset control
956 957
 * @regs: base address for our registers
 * @regs_size: address space size
958
 * @fladj: frame length adjustment
959
 * @irq_gadget: peripheral controller's IRQ number
960 961 962 963
 * @otg_irq: IRQ number for OTG IRQs
 * @current_otg_role: current role of operation while using the OTG block
 * @desired_otg_role: desired role of operation while using the OTG block
 * @otg_restart_host: flag that OTG controller needs to restart host
964
 * @nr_scratch: number of scratch buffers
965
 * @u1u2: only used on revisions <1.83a for workaround
966
 * @maximum_speed: maximum speed requested (mainly for testing purposes)
967
 * @gadget_max_speed: maximum gadget speed requested
968 969
 * @ip: controller's ID
 * @revision: controller's version of an IP
970
 * @version_type: VERSIONTYPE register contents, a sub release of a revision
971
 * @dr_mode: requested mode of operation
972
 * @current_dr_role: current role of operation when in dual-role mode
973
 * @desired_dr_role: desired role of operation when in dual-role mode
R
Roger Quadros 已提交
974 975
 * @edev: extcon handle
 * @edev_nb: extcon notifier
976 977 978
 * @hsphy_mode: UTMI phy mode, one of following:
 *		- USBPHY_INTERFACE_MODE_UTMI
 *		- USBPHY_INTERFACE_MODE_UTMIW
979
 * @role_sw: usb_role_switch handle
980 981
 * @role_switch_default_mode: default operation mode of controller while
 *			usb role is USB_ROLE_NONE.
F
Felipe Balbi 已提交
982 983
 * @usb2_phy: pointer to USB2 PHY
 * @usb3_phy: pointer to USB3 PHY
984 985
 * @usb2_generic_phy: pointer to USB2 PHY
 * @usb3_generic_phy: pointer to USB3 PHY
986
 * @phys_ready: flag to indicate that PHYs are ready
987
 * @ulpi: pointer to ulpi interface
988
 * @ulpi_ready: flag to indicate that ULPI is initialized
989 990 991 992
 * @u2sel: parameter from Set SEL request.
 * @u2pel: parameter from Set SEL request.
 * @u1sel: parameter from Set SEL request.
 * @u1pel: parameter from Set SEL request.
993
 * @num_eps: number of endpoints
994
 * @ep0_next_event: hold the next expected event
995 996 997
 * @ep0state: state of endpoint zero
 * @link_state: link state
 * @speed: device speed (super, high, full, low)
F
Felipe Balbi 已提交
998
 * @hwparams: copy of hwparams registers
999
 * @root: debugfs root folder pointer
F
Felipe Balbi 已提交
1000
 * @regset: debugfs pointer to regdump file
1001
 * @dbg_lsp_select: current debug lsp mux register selection
F
Felipe Balbi 已提交
1002 1003
 * @test_mode: true when we're entering a USB test mode
 * @test_mode_nr: test feature selector
H
Huang Rui 已提交
1004
 * @lpm_nyet_threshold: LPM NYET response threshold
1005
 * @hird_threshold: HIRD threshold
1006 1007 1008 1009
 * @rx_thr_num_pkt_prd: periodic ESS receive packet count
 * @rx_max_burst_prd: max periodic ESS receive burst size
 * @tx_thr_num_pkt_prd: periodic ESS transmit packet count
 * @tx_max_burst_prd: max periodic ESS transmit burst size
1010
 * @hsphy_interface: "utmi" or "ulpi"
F
Felipe Balbi 已提交
1011
 * @connected: true when we're connected to a host, false otherwise
F
Felipe Balbi 已提交
1012 1013 1014
 * @delayed_status: true when gadget driver asks for delayed status
 * @ep0_bounced: true when we used bounce buffer
 * @ep0_expect_in: true when we expect a DATA IN transfer
1015
 * @has_hibernation: true when dwc3 was configured with Hibernation
1016
 * @sysdev_is_parent: true when dwc3 device has a parent driver
H
Huang Rui 已提交
1017 1018
 * @has_lpm_erratum: true when core was configured with LPM Erratum. Note that
 *			there's now way for software to detect this in runtime.
1019
 * @is_utmi_l1_suspend: the core asserts output signal
1020 1021
 *	0	- utmi_sleep_n
 *	1	- utmi_l1_suspend_n
1022
 * @is_fpga: true when we are using the FPGA board
F
Felipe Balbi 已提交
1023
 * @pending_events: true when we have pending IRQs to be handled
F
Felipe Balbi 已提交
1024 1025 1026
 * @pullups_connected: true when Run/Stop bit is set
 * @setup_packet_pending: true when there's a Setup Packet in FIFO. Workaround
 * @three_stage_setup: set if we perform a three phase setup
1027 1028
 * @dis_start_transfer_quirk: set if start_transfer failure SW workaround is
 *			not needed for DWC_usb31 version 1.70a-ea06 and below
1029
 * @usb3_lpm_capable: set if hadrware supports Link Power Management
1030
 * @usb2_lpm_disable: set to disable usb2 lpm
H
Huang Rui 已提交
1031
 * @disable_scramble_quirk: set if we enable the disable scramble quirk
H
Huang Rui 已提交
1032
 * @u2exit_lfps_quirk: set if we enable u2exit lfps quirk
1033
 * @u2ss_inp3_quirk: set if we enable P3 OK for U2/SS Inactive quirk
H
Huang Rui 已提交
1034
 * @req_p1p2p3_quirk: set if we enable request p1p2p3 quirk
H
Huang Rui 已提交
1035
 * @del_p1p2p3_quirk: set if we enable delay p1p2p3 quirk
1036
 * @del_phy_power_chg_quirk: set if we enable delay phy power change quirk
H
Huang Rui 已提交
1037
 * @lfps_filter_quirk: set if we enable LFPS filter quirk
1038
 * @rx_detect_poll_quirk: set if we enable rx_detect to polling lfps quirk
1039
 * @dis_u3_susphy_quirk: set if we disable usb3 suspend phy
1040
 * @dis_u2_susphy_quirk: set if we disable usb2 suspend phy
J
John Youn 已提交
1041 1042
 * @dis_enblslpm_quirk: set if we clear enblslpm in GUSB2PHYCFG,
 *                      disabling the suspend signal to the PHY.
1043 1044
 * @dis_u1_entry_quirk: set if link entering into U1 state needs to be disabled.
 * @dis_u2_entry_quirk: set if link entering into U2 state needs to be disabled.
F
Felipe Balbi 已提交
1045
 * @dis_rxdet_inp3_quirk: set if we disable Rx.Detect in P3
1046 1047 1048
 * @dis_u2_freeclk_exists_quirk : set if we clear u2_freeclk_exists
 *			in GUSB2PHYCFG, specify that USB2 PHY doesn't
 *			provide a free-running PHY clock.
1049 1050
 * @dis_del_phy_power_chg_quirk: set if we disable delay phy power
 *			change quirk.
1051 1052
 * @dis_tx_ipgap_linecheck_quirk: set if we disable u2mac linestate
 *			check during HS transmit.
1053 1054
 * @parkmode_disable_ss_quirk: set if we need to disable all SuperSpeed
 *			instances in park mode.
H
Huang Rui 已提交
1055 1056
 * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
 * @tx_de_emphasis: Tx de-emphasis value
1057 1058 1059 1060
 *	0	- -6dB de-emphasis
 *	1	- -3.5dB de-emphasis
 *	2	- No de-emphasis
 *	3	- Reserved
1061
 * @dis_metastability_quirk: set to disable metastability quirk.
1062
 * @dis_split_quirk: set to disable split boundary.
1063
 * @imod_interval: set the interrupt moderation interval in 250ns
1064
 *			increments or 0 to disable.
1065 1066
 */
struct dwc3 {
1067
	struct work_struct	drd_work;
1068
	struct dwc3_trb		*ep0_trb;
1069
	void			*bounce;
1070
	void			*scratchbuf;
1071 1072
	u8			*setup_buf;
	dma_addr_t		ep0_trb_addr;
1073
	dma_addr_t		bounce_addr;
1074
	dma_addr_t		scratch_addr;
1075
	struct dwc3_request	ep0_usb_req;
1076
	struct completion	ep0_in_setup;
1077

1078 1079
	/* device lock */
	spinlock_t		lock;
1080

1081
	struct device		*dev;
1082
	struct device		*sysdev;
1083

F
Felipe Balbi 已提交
1084
	struct platform_device	*xhci;
1085
	struct resource		xhci_resources[DWC3_XHCI_RESOURCES_NUM];
F
Felipe Balbi 已提交
1086

F
Felipe Balbi 已提交
1087
	struct dwc3_event_buffer *ev_buf;
1088 1089
	struct dwc3_ep		*eps[DWC3_ENDPOINTS_NUM];

1090
	struct usb_gadget	*gadget;
1091 1092
	struct usb_gadget_driver *gadget_driver;

1093 1094 1095 1096 1097
	struct clk_bulk_data	*clks;
	int			num_clks;

	struct reset_control	*reset;

F
Felipe Balbi 已提交
1098 1099 1100
	struct usb_phy		*usb2_phy;
	struct usb_phy		*usb3_phy;

1101 1102 1103
	struct phy		*usb2_generic_phy;
	struct phy		*usb3_generic_phy;

1104 1105
	bool			phys_ready;

1106
	struct ulpi		*ulpi;
1107
	bool			ulpi_ready;
1108

1109 1110 1111
	void __iomem		*regs;
	size_t			regs_size;

1112
	enum usb_dr_mode	dr_mode;
1113
	u32			current_dr_role;
1114
	u32			desired_dr_role;
R
Roger Quadros 已提交
1115 1116
	struct extcon_dev	*edev;
	struct notifier_block	edev_nb;
1117
	enum usb_phy_interface	hsphy_mode;
1118
	struct usb_role_switch	*role_sw;
1119
	enum usb_dr_mode	role_switch_default_mode;
1120

1121
	u32			fladj;
1122
	u32			irq_gadget;
1123 1124 1125 1126
	u32			otg_irq;
	u32			current_otg_role;
	u32			desired_otg_role;
	bool			otg_restart_host;
1127
	u32			nr_scratch;
1128
	u32			u1u2;
1129
	u32			maximum_speed;
1130
	u32			gadget_max_speed;
J
John Youn 已提交
1131

1132 1133 1134 1135 1136 1137
	u32			ip;

#define DWC3_IP			0x5533
#define DWC31_IP		0x3331
#define DWC32_IP		0x3332

1138 1139
	u32			revision;

1140
#define DWC3_REVISION_ANY	0x0
1141 1142 1143 1144 1145
#define DWC3_REVISION_173A	0x5533173a
#define DWC3_REVISION_175A	0x5533175a
#define DWC3_REVISION_180A	0x5533180a
#define DWC3_REVISION_183A	0x5533183a
#define DWC3_REVISION_185A	0x5533185a
1146
#define DWC3_REVISION_187A	0x5533187a
1147 1148
#define DWC3_REVISION_188A	0x5533188a
#define DWC3_REVISION_190A	0x5533190a
1149
#define DWC3_REVISION_194A	0x5533194a
1150 1151 1152 1153
#define DWC3_REVISION_200A	0x5533200a
#define DWC3_REVISION_202A	0x5533202a
#define DWC3_REVISION_210A	0x5533210a
#define DWC3_REVISION_220A	0x5533220a
1154 1155 1156
#define DWC3_REVISION_230A	0x5533230a
#define DWC3_REVISION_240A	0x5533240a
#define DWC3_REVISION_250A	0x5533250a
F
Felipe Balbi 已提交
1157 1158 1159
#define DWC3_REVISION_260A	0x5533260a
#define DWC3_REVISION_270A	0x5533270a
#define DWC3_REVISION_280A	0x5533280a
1160
#define DWC3_REVISION_290A	0x5533290a
1161 1162
#define DWC3_REVISION_300A	0x5533300a
#define DWC3_REVISION_310A	0x5533310a
1163
#define DWC3_REVISION_330A	0x5533330a
1164

1165 1166 1167 1168 1169 1170 1171
#define DWC31_REVISION_ANY	0x0
#define DWC31_REVISION_110A	0x3131302a
#define DWC31_REVISION_120A	0x3132302a
#define DWC31_REVISION_160A	0x3136302a
#define DWC31_REVISION_170A	0x3137302a
#define DWC31_REVISION_180A	0x3138302a
#define DWC31_REVISION_190A	0x3139302a
J
John Youn 已提交
1172

1173 1174 1175
#define DWC32_REVISION_ANY	0x0
#define DWC32_REVISION_100A	0x3130302a

1176 1177
	u32			version_type;

1178
#define DWC31_VERSIONTYPE_ANY		0x0
1179 1180 1181 1182 1183 1184 1185
#define DWC31_VERSIONTYPE_EA01		0x65613031
#define DWC31_VERSIONTYPE_EA02		0x65613032
#define DWC31_VERSIONTYPE_EA03		0x65613033
#define DWC31_VERSIONTYPE_EA04		0x65613034
#define DWC31_VERSIONTYPE_EA05		0x65613035
#define DWC31_VERSIONTYPE_EA06		0x65613036

1186
	enum dwc3_ep0_next	ep0_next_event;
1187 1188 1189
	enum dwc3_ep0_state	ep0state;
	enum dwc3_link_state	link_state;

1190 1191 1192 1193 1194
	u16			u2sel;
	u16			u2pel;
	u8			u1sel;
	u8			u1pel;

1195
	u8			speed;
1196

1197
	u8			num_eps;
1198

F
Felipe Balbi 已提交
1199
	struct dwc3_hwparams	hwparams;
1200
	struct dentry		*root;
1201
	struct debugfs_regset32	*regset;
1202

1203 1204
	u32			dbg_lsp_select;

1205 1206
	u8			test_mode;
	u8			test_mode_nr;
H
Huang Rui 已提交
1207
	u8			lpm_nyet_threshold;
1208
	u8			hird_threshold;
1209 1210 1211 1212
	u8			rx_thr_num_pkt_prd;
	u8			rx_max_burst_prd;
	u8			tx_thr_num_pkt_prd;
	u8			tx_max_burst_prd;
F
Felipe Balbi 已提交
1213

1214 1215
	const char		*hsphy_interface;

F
Felipe Balbi 已提交
1216
	unsigned		connected:1;
F
Felipe Balbi 已提交
1217 1218 1219
	unsigned		delayed_status:1;
	unsigned		ep0_bounced:1;
	unsigned		ep0_expect_in:1;
1220
	unsigned		has_hibernation:1;
1221
	unsigned		sysdev_is_parent:1;
H
Huang Rui 已提交
1222
	unsigned		has_lpm_erratum:1;
1223
	unsigned		is_utmi_l1_suspend:1;
1224
	unsigned		is_fpga:1;
F
Felipe Balbi 已提交
1225
	unsigned		pending_events:1;
F
Felipe Balbi 已提交
1226 1227 1228
	unsigned		pullups_connected:1;
	unsigned		setup_packet_pending:1;
	unsigned		three_stage_setup:1;
1229
	unsigned		dis_start_transfer_quirk:1;
1230
	unsigned		usb3_lpm_capable:1;
1231
	unsigned		usb2_lpm_disable:1;
H
Huang Rui 已提交
1232 1233

	unsigned		disable_scramble_quirk:1;
H
Huang Rui 已提交
1234
	unsigned		u2exit_lfps_quirk:1;
1235
	unsigned		u2ss_inp3_quirk:1;
H
Huang Rui 已提交
1236
	unsigned		req_p1p2p3_quirk:1;
H
Huang Rui 已提交
1237
	unsigned                del_p1p2p3_quirk:1;
1238
	unsigned		del_phy_power_chg_quirk:1;
H
Huang Rui 已提交
1239
	unsigned		lfps_filter_quirk:1;
1240
	unsigned		rx_detect_poll_quirk:1;
1241
	unsigned		dis_u3_susphy_quirk:1;
1242
	unsigned		dis_u2_susphy_quirk:1;
J
John Youn 已提交
1243
	unsigned		dis_enblslpm_quirk:1;
1244 1245
	unsigned		dis_u1_entry_quirk:1;
	unsigned		dis_u2_entry_quirk:1;
1246
	unsigned		dis_rxdet_inp3_quirk:1;
1247
	unsigned		dis_u2_freeclk_exists_quirk:1;
1248
	unsigned		dis_del_phy_power_chg_quirk:1;
1249
	unsigned		dis_tx_ipgap_linecheck_quirk:1;
1250
	unsigned		parkmode_disable_ss_quirk:1;
H
Huang Rui 已提交
1251 1252 1253

	unsigned		tx_de_emphasis_quirk:1;
	unsigned		tx_de_emphasis:2;
1254

1255 1256
	unsigned		dis_metastability_quirk:1;

1257 1258
	unsigned		dis_split_quirk:1;

1259
	u16			imod_interval;
1260 1261
};

1262 1263 1264
#define INCRX_BURST_MODE 0
#define INCRX_UNDEF_LENGTH_BURST_MODE 1

1265
#define work_to_dwc(w)		(container_of((w), struct dwc3, drd_work))
1266 1267 1268 1269 1270

/* -------------------------------------------------------------------------- */

struct dwc3_event_type {
	u32	is_devspec:1;
1271 1272
	u32	type:7;
	u32	reserved8_31:24;
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
} __packed;

#define DWC3_DEPEVT_XFERCOMPLETE	0x01
#define DWC3_DEPEVT_XFERINPROGRESS	0x02
#define DWC3_DEPEVT_XFERNOTREADY	0x03
#define DWC3_DEPEVT_RXTXFIFOEVT		0x04
#define DWC3_DEPEVT_STREAMEVT		0x06
#define DWC3_DEPEVT_EPCMDCMPLT		0x07

/**
1283
 * struct dwc3_event_depevt - Device Endpoint Events
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
 * @one_bit: indicates this is an endpoint event (not used)
 * @endpoint_number: number of the endpoint
 * @endpoint_event: The event we have:
 *	0x00	- Reserved
 *	0x01	- XferComplete
 *	0x02	- XferInProgress
 *	0x03	- XferNotReady
 *	0x04	- RxTxFifoEvt (IN->Underrun, OUT->Overrun)
 *	0x05	- Reserved
 *	0x06	- StreamEvt
 *	0x07	- EPCmdCmplt
 * @reserved11_10: Reserved, don't use.
 * @status: Indicates the status of the event. Refer to databook for
 *	more information.
 * @parameters: Parameters of the current event. Refer to databook for
 *	more information.
 */
struct dwc3_event_depevt {
	u32	one_bit:1;
	u32	endpoint_number:5;
	u32	endpoint_event:4;
	u32	reserved11_10:2;
	u32	status:4;
1307 1308

/* Within XferNotReady */
1309
#define DEPEVT_STATUS_TRANSFER_ACTIVE	BIT(3)
1310

1311
/* Within XferComplete or XferInProgress */
1312 1313 1314
#define DEPEVT_STATUS_BUSERR	BIT(0)
#define DEPEVT_STATUS_SHORT	BIT(1)
#define DEPEVT_STATUS_IOC	BIT(2)
1315 1316
#define DEPEVT_STATUS_LST	BIT(3) /* XferComplete */
#define DEPEVT_STATUS_MISSED_ISOC BIT(3) /* XferInProgress */
1317

1318 1319 1320 1321
/* Stream event only */
#define DEPEVT_STREAMEVT_FOUND		1
#define DEPEVT_STREAMEVT_NOTFOUND	2

1322 1323 1324 1325
/* Stream event parameter */
#define DEPEVT_STREAM_PRIME		0xfffe
#define DEPEVT_STREAM_NOSTREAM		0x0

1326 1327 1328
/* Control-only Status */
#define DEPEVT_STATUS_CONTROL_DATA	1
#define DEPEVT_STATUS_CONTROL_STATUS	2
1329
#define DEPEVT_STATUS_CONTROL_PHASE(n)	((n) & 3)
1330

1331 1332 1333 1334
/* In response to Start Transfer */
#define DEPEVT_TRANSFER_NO_RESOURCE	1
#define DEPEVT_TRANSFER_BUS_EXPIRY	2

1335
	u32	parameters:16;
1336 1337 1338

/* For Command Complete Events */
#define DEPEVT_PARAMETER_CMD(n)	(((n) & (0xf << 8)) >> 8)
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
} __packed;

/**
 * struct dwc3_event_devt - Device Events
 * @one_bit: indicates this is a non-endpoint event (not used)
 * @device_event: indicates it's a device event. Should read as 0x00
 * @type: indicates the type of device event.
 *	0	- DisconnEvt
 *	1	- USBRst
 *	2	- ConnectDone
 *	3	- ULStChng
 *	4	- WkUpEvt
 *	5	- Reserved
 *	6	- EOPF
 *	7	- SOF
 *	8	- Reserved
 *	9	- ErrticErr
 *	10	- CmdCmplt
 *	11	- EvntOverflow
 *	12	- VndrDevTstRcved
 * @reserved15_12: Reserved, not used
 * @event_info: Information about this event
1361
 * @reserved31_25: Reserved, not used
1362 1363 1364 1365 1366 1367
 */
struct dwc3_event_devt {
	u32	one_bit:1;
	u32	device_event:7;
	u32	type:4;
	u32	reserved15_12:4;
1368 1369
	u32	event_info:9;
	u32	reserved31_25:7;
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
} __packed;

/**
 * struct dwc3_event_gevt - Other Core Events
 * @one_bit: indicates this is a non-endpoint event (not used)
 * @device_event: indicates it's (0x03) Carkit or (0x04) I2C event.
 * @phy_port_number: self-explanatory
 * @reserved31_12: Reserved, not used.
 */
struct dwc3_event_gevt {
	u32	one_bit:1;
	u32	device_event:7;
	u32	phy_port_number:4;
	u32	reserved31_12:20;
} __packed;

/**
 * union dwc3_event - representation of Event Buffer contents
 * @raw: raw 32-bit event
 * @type: the type of the event
 * @depevt: Device Endpoint Event
 * @devt: Device Event
 * @gevt: Global Event
 */
union dwc3_event {
	u32				raw;
	struct dwc3_event_type		type;
	struct dwc3_event_depevt	depevt;
	struct dwc3_event_devt		devt;
	struct dwc3_event_gevt		gevt;
};

1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414
/**
 * struct dwc3_gadget_ep_cmd_params - representation of endpoint command
 * parameters
 * @param2: third parameter
 * @param1: second parameter
 * @param0: first parameter
 */
struct dwc3_gadget_ep_cmd_params {
	u32	param2;
	u32	param1;
	u32	param0;
};

1415 1416 1417 1418 1419 1420 1421 1422
/*
 * DWC3 Features to be used as Driver Data
 */

#define DWC3_HAS_PERIPHERAL		BIT(0)
#define DWC3_HAS_XHCI			BIT(1)
#define DWC3_HAS_OTG			BIT(3)

F
Felipe Balbi 已提交
1423
/* prototypes */
1424
void dwc3_set_prtcap(struct dwc3 *dwc, u32 mode);
1425
void dwc3_set_mode(struct dwc3 *dwc, u32 mode);
1426
u32 dwc3_core_fifo_space(struct dwc3_ep *dep, u8 type);
1427

1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447
#define DWC3_IP_IS(_ip)							\
	(dwc->ip == _ip##_IP)

#define DWC3_VER_IS(_ip, _ver)						\
	(DWC3_IP_IS(_ip) && dwc->revision == _ip##_REVISION_##_ver)

#define DWC3_VER_IS_PRIOR(_ip, _ver)					\
	(DWC3_IP_IS(_ip) && dwc->revision < _ip##_REVISION_##_ver)

#define DWC3_VER_IS_WITHIN(_ip, _from, _to)				\
	(DWC3_IP_IS(_ip) &&						\
	 dwc->revision >= _ip##_REVISION_##_from &&			\
	 (!(_ip##_REVISION_##_to) ||					\
	  dwc->revision <= _ip##_REVISION_##_to))

#define DWC3_VER_TYPE_IS_WITHIN(_ip, _ver, _from, _to)			\
	(DWC3_VER_IS(_ip, _ver) &&					\
	 dwc->version_type >= _ip##_VERSIONTYPE_##_from &&		\
	 (!(_ip##_VERSIONTYPE_##_to) ||					\
	  dwc->version_type <= _ip##_VERSIONTYPE_##_to))
1448

1449 1450
bool dwc3_has_imod(struct dwc3 *dwc);

1451 1452 1453
int dwc3_event_buffers_setup(struct dwc3 *dwc);
void dwc3_event_buffers_cleanup(struct dwc3 *dwc);

1454
#if IS_ENABLED(CONFIG_USB_DWC3_HOST) || IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
F
Felipe Balbi 已提交
1455 1456
int dwc3_host_init(struct dwc3 *dwc);
void dwc3_host_exit(struct dwc3 *dwc);
1457 1458 1459 1460 1461 1462 1463 1464
#else
static inline int dwc3_host_init(struct dwc3 *dwc)
{ return 0; }
static inline void dwc3_host_exit(struct dwc3 *dwc)
{ }
#endif

#if IS_ENABLED(CONFIG_USB_DWC3_GADGET) || IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
1465 1466
int dwc3_gadget_init(struct dwc3 *dwc);
void dwc3_gadget_exit(struct dwc3 *dwc);
1467 1468 1469
int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode);
int dwc3_gadget_get_link_state(struct dwc3 *dwc);
int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state);
1470
int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned int cmd,
1471
		struct dwc3_gadget_ep_cmd_params *params);
1472 1473
int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned int cmd,
		u32 param);
1474 1475 1476 1477 1478
#else
static inline int dwc3_gadget_init(struct dwc3 *dwc)
{ return 0; }
static inline void dwc3_gadget_exit(struct dwc3 *dwc)
{ }
1479 1480 1481 1482 1483 1484 1485 1486
static inline int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
{ return 0; }
static inline int dwc3_gadget_get_link_state(struct dwc3 *dwc)
{ return 0; }
static inline int dwc3_gadget_set_link_state(struct dwc3 *dwc,
		enum dwc3_link_state state)
{ return 0; }

1487
static inline int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned int cmd,
1488
		struct dwc3_gadget_ep_cmd_params *params)
1489 1490 1491 1492
{ return 0; }
static inline int dwc3_send_gadget_generic_command(struct dwc3 *dwc,
		int cmd, u32 param)
{ return 0; }
1493
#endif
1494

R
Roger Quadros 已提交
1495 1496 1497
#if IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
int dwc3_drd_init(struct dwc3 *dwc);
void dwc3_drd_exit(struct dwc3 *dwc);
1498 1499 1500 1501
void dwc3_otg_init(struct dwc3 *dwc);
void dwc3_otg_exit(struct dwc3 *dwc);
void dwc3_otg_update(struct dwc3 *dwc, bool ignore_idstatus);
void dwc3_otg_host_init(struct dwc3 *dwc);
R
Roger Quadros 已提交
1502 1503 1504 1505 1506
#else
static inline int dwc3_drd_init(struct dwc3 *dwc)
{ return 0; }
static inline void dwc3_drd_exit(struct dwc3 *dwc)
{ }
1507 1508 1509 1510 1511 1512 1513 1514
static inline void dwc3_otg_init(struct dwc3 *dwc)
{ }
static inline void dwc3_otg_exit(struct dwc3 *dwc)
{ }
static inline void dwc3_otg_update(struct dwc3 *dwc, bool ignore_idstatus)
{ }
static inline void dwc3_otg_host_init(struct dwc3 *dwc)
{ }
R
Roger Quadros 已提交
1515 1516
#endif

1517 1518 1519 1520
/* power management interface */
#if !IS_ENABLED(CONFIG_USB_DWC3_HOST)
int dwc3_gadget_suspend(struct dwc3 *dwc);
int dwc3_gadget_resume(struct dwc3 *dwc);
F
Felipe Balbi 已提交
1521
void dwc3_gadget_process_pending_events(struct dwc3 *dwc);
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531
#else
static inline int dwc3_gadget_suspend(struct dwc3 *dwc)
{
	return 0;
}

static inline int dwc3_gadget_resume(struct dwc3 *dwc)
{
	return 0;
}
F
Felipe Balbi 已提交
1532 1533 1534 1535

static inline void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
{
}
1536 1537
#endif /* !IS_ENABLED(CONFIG_USB_DWC3_HOST) */

1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
#if IS_ENABLED(CONFIG_USB_DWC3_ULPI)
int dwc3_ulpi_init(struct dwc3 *dwc);
void dwc3_ulpi_exit(struct dwc3 *dwc);
#else
static inline int dwc3_ulpi_init(struct dwc3 *dwc)
{ return 0; }
static inline void dwc3_ulpi_exit(struct dwc3 *dwc)
{ }
#endif

1548
#endif /* __DRIVERS_USB_DWC3_CORE_H */