drivers/usb/dwc3/core.h

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