File Index
Files and directories
Sign in
FILE

core.h

File preview with syntax highlighting.

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