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