drivers/usb/host/xhci.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2
   3 /*
   4  * xHCI host controller driver
   5  *
   6  * Copyright (C) 2008 Intel Corp.
   7  *
   8  * Author: Sarah Sharp
   9  * Some code borrowed from the Linux EHCI driver.
  10  */
  11
  12 #ifndef __LINUX_XHCI_HCD_H
  13 #define __LINUX_XHCI_HCD_H
  14
  15 #include <linux/usb.h>
  16 #include <linux/timer.h>
  17 #include <linux/kernel.h>
  18 #include <linux/usb/hcd.h>
  19 #include <linux/io-64-nonatomic-lo-hi.h>
  20
  21 /* Code sharing between pci-quirks and xhci hcd */
  22 #include        "xhci-ext-caps.h"
  23 #include "pci-quirks.h"
  24
  25 /* xHCI PCI Configuration Registers */
  26 #define XHCI_SBRN_OFFSET        (0x60)
  27
  28 /* Max number of USB devices for any host controller - limit in section 6.1 */
  29 #define MAX_HC_SLOTS            256
  30 /* Section 5.3.3 - MaxPorts */
  31 #define MAX_HC_PORTS            127
  32
  33 /*
  34  * xHCI register interface.
  35  * This corresponds to the eXtensible Host Controller Interface (xHCI)
  36  * Revision 0.95 specification
  37  */
  38
  39 /**
  40  * struct xhci_cap_regs - xHCI Host Controller Capability Registers.
  41  * @hc_capbase:         length of the capabilities register and HC version number
  42  * @hcs_params1:        HCSPARAMS1 - Structural Parameters 1
  43  * @hcs_params2:        HCSPARAMS2 - Structural Parameters 2
  44  * @hcs_params3:        HCSPARAMS3 - Structural Parameters 3
  45  * @hcc_params:         HCCPARAMS - Capability Parameters
  46  * @db_off:             DBOFF - Doorbell array offset
  47  * @run_regs_off:       RTSOFF - Runtime register space offset
  48  * @hcc_params2:        HCCPARAMS2 Capability Parameters 2, xhci 1.1 only
  49  */
  50 struct xhci_cap_regs {
  51         __le32  hc_capbase;
  52         __le32  hcs_params1;
  53         __le32  hcs_params2;
  54         __le32  hcs_params3;
  55         __le32  hcc_params;
  56         __le32  db_off;
  57         __le32  run_regs_off;
  58         __le32  hcc_params2; /* xhci 1.1 */
  59         /* Reserved up to (CAPLENGTH - 0x1C) */
  60 };
  61
  62 /* hc_capbase bitmasks */
  63 /* bits 7:0 - how long is the Capabilities register */
  64 #define HC_LENGTH(p)            XHCI_HC_LENGTH(p)
  65 /* bits 31:16   */
  66 #define HC_VERSION(p)           (((p) >> 16) & 0xffff)
  67
  68 /* HCSPARAMS1 - hcs_params1 - bitmasks */
  69 /* bits 0:7, Max Device Slots */
  70 #define HCS_MAX_SLOTS(p)        (((p) >> 0) & 0xff)
  71 #define HCS_SLOTS_MASK          0xff
  72 /* bits 8:18, Max Interrupters */
  73 #define HCS_MAX_INTRS(p)        (((p) >> 8) & 0x7ff)
  74 /* bits 24:31, Max Ports - max value is 0x7F = 127 ports */
  75 #define HCS_MAX_PORTS(p)        (((p) >> 24) & 0x7f)
  76
  77 /* HCSPARAMS2 - hcs_params2 - bitmasks */
  78 /* bits 0:3, frames or uframes that SW needs to queue transactions
  79  * ahead of the HW to meet periodic deadlines */
  80 #define HCS_IST(p)              (((p) >> 0) & 0xf)
  81 /* bits 4:7, max number of Event Ring segments */
  82 #define HCS_ERST_MAX(p)         (((p) >> 4) & 0xf)
  83 /* bits 21:25 Hi 5 bits of Scratchpad buffers SW must allocate for the HW */
  84 /* bit 26 Scratchpad restore - for save/restore HW state - not used yet */
  85 /* bits 27:31 Lo 5 bits of Scratchpad buffers SW must allocate for the HW */
  86 #define HCS_MAX_SCRATCHPAD(p)   ((((p) >> 16) & 0x3e0) | (((p) >> 27) & 0x1f))
  87
  88 /* HCSPARAMS3 - hcs_params3 - bitmasks */
  89 /* bits 0:7, Max U1 to U0 latency for the roothub ports */
  90 #define HCS_U1_LATENCY(p)       (((p) >> 0) & 0xff)
  91 /* bits 16:31, Max U2 to U0 latency for the roothub ports */
  92 #define HCS_U2_LATENCY(p)       (((p) >> 16) & 0xffff)
  93
  94 /* HCCPARAMS - hcc_params - bitmasks */
  95 /* true: HC can use 64-bit address pointers */
  96 #define HCC_64BIT_ADDR(p)       ((p) & (1 << 0))
  97 /* true: HC can do bandwidth negotiation */
  98 #define HCC_BANDWIDTH_NEG(p)    ((p) & (1 << 1))
  99 /* true: HC uses 64-byte Device Context structures
 100  * FIXME 64-byte context structures aren't supported yet.
 101  */
 102 #define HCC_64BYTE_CONTEXT(p)   ((p) & (1 << 2))
 103 /* true: HC has port power switches */
 104 #define HCC_PPC(p)              ((p) & (1 << 3))
 105 /* true: HC has port indicators */
 106 #define HCS_INDICATOR(p)        ((p) & (1 << 4))
 107 /* true: HC has Light HC Reset Capability */
 108 #define HCC_LIGHT_RESET(p)      ((p) & (1 << 5))
 109 /* true: HC supports latency tolerance messaging */
 110 #define HCC_LTC(p)              ((p) & (1 << 6))
 111 /* true: no secondary Stream ID Support */
 112 #define HCC_NSS(p)              ((p) & (1 << 7))
 113 /* true: HC supports Stopped - Short Packet */
 114 #define HCC_SPC(p)              ((p) & (1 << 9))
 115 /* true: HC has Contiguous Frame ID Capability */
 116 #define HCC_CFC(p)              ((p) & (1 << 11))
 117 /* Max size for Primary Stream Arrays - 2^(n+1), where n is bits 12:15 */
 118 #define HCC_MAX_PSA(p)          (1 << ((((p) >> 12) & 0xf) + 1))
 119 /* Extended Capabilities pointer from PCI base - section 5.3.6 */
 120 #define HCC_EXT_CAPS(p)         XHCI_HCC_EXT_CAPS(p)
 121
 122 #define CTX_SIZE(_hcc)          (HCC_64BYTE_CONTEXT(_hcc) ? 64 : 32)
 123
 124 /* db_off bitmask - bits 0:1 reserved */
 125 #define DBOFF_MASK      (~0x3)
 126
 127 /* run_regs_off bitmask - bits 0:4 reserved */
 128 #define RTSOFF_MASK     (~0x1f)
 129
 130 /* HCCPARAMS2 - hcc_params2 - bitmasks */
 131 /* true: HC supports U3 entry Capability */
 132 #define HCC2_U3C(p)             ((p) & (1 << 0))
 133 /* true: HC supports Configure endpoint command Max exit latency too large */
 134 #define HCC2_CMC(p)             ((p) & (1 << 1))
 135 /* true: HC supports Force Save context Capability */
 136 #define HCC2_FSC(p)             ((p) & (1 << 2))
 137 /* true: HC supports Compliance Transition Capability */
 138 #define HCC2_CTC(p)             ((p) & (1 << 3))
 139 /* true: HC support Large ESIT payload Capability > 48k */
 140 #define HCC2_LEC(p)             ((p) & (1 << 4))
 141 /* true: HC support Configuration Information Capability */
 142 #define HCC2_CIC(p)             ((p) & (1 << 5))
 143 /* true: HC support Extended TBC Capability, Isoc burst count > 65535 */
 144 #define HCC2_ETC(p)             ((p) & (1 << 6))
 145
 146 /* Number of registers per port */
 147 #define NUM_PORT_REGS   4
 148
 149 #define PORTSC          0
 150 #define PORTPMSC        1
 151 #define PORTLI          2
 152 #define PORTHLPMC       3
 153
 154 /**
 155  * struct xhci_op_regs - xHCI Host Controller Operational Registers.
 156  * @command:            USBCMD - xHC command register
 157  * @status:             USBSTS - xHC status register
 158  * @page_size:          This indicates the page size that the host controller
 159  *                      supports.  If bit n is set, the HC supports a page size
 160  *                      of 2^(n+12), up to a 128MB page size.
 161  *                      4K is the minimum page size.
 162  * @cmd_ring:           CRP - 64-bit Command Ring Pointer
 163  * @dcbaa_ptr:          DCBAAP - 64-bit Device Context Base Address Array Pointer
 164  * @config_reg:         CONFIG - Configure Register
 165  * @port_status_base:   PORTSCn - base address for Port Status and Control
 166  *                      Each port has a Port Status and Control register,
 167  *                      followed by a Port Power Management Status and Control
 168  *                      register, a Port Link Info register, and a reserved
 169  *                      register.
 170  * @port_power_base:    PORTPMSCn - base address for
 171  *                      Port Power Management Status and Control
 172  * @port_link_base:     PORTLIn - base address for Port Link Info (current
 173  *                      Link PM state and control) for USB 2.1 and USB 3.0
 174  *                      devices.
 175  */
 176 struct xhci_op_regs {
 177         __le32  command;
 178         __le32  status;
 179         __le32  page_size;
 180         __le32  reserved1;
 181         __le32  reserved2;
 182         __le32  dev_notification;
 183         __le64  cmd_ring;
 184         /* rsvd: offset 0x20-2F */
 185         __le32  reserved3[4];
 186         __le64  dcbaa_ptr;
 187         __le32  config_reg;
 188         /* rsvd: offset 0x3C-3FF */
 189         __le32  reserved4[241];
 190         /* port 1 registers, which serve as a base address for other ports */
 191         __le32  port_status_base;
 192         __le32  port_power_base;
 193         __le32  port_link_base;
 194         __le32  reserved5;
 195         /* registers for ports 2-255 */
 196         __le32  reserved6[NUM_PORT_REGS*254];
 197 };
 198
 199 /* USBCMD - USB command - command bitmasks */
 200 /* start/stop HC execution - do not write unless HC is halted*/
 201 #define CMD_RUN         XHCI_CMD_RUN
 202 /* Reset HC - resets internal HC state machine and all registers (except
 203  * PCI config regs).  HC does NOT drive a USB reset on the downstream ports.
 204  * The xHCI driver must reinitialize the xHC after setting this bit.
 205  */
 206 #define CMD_RESET       (1 << 1)
 207 /* Event Interrupt Enable - a '1' allows interrupts from the host controller */
 208 #define CMD_EIE         XHCI_CMD_EIE
 209 /* Host System Error Interrupt Enable - get out-of-band signal for HC errors */
 210 #define CMD_HSEIE       XHCI_CMD_HSEIE
 211 /* bits 4:6 are reserved (and should be preserved on writes). */
 212 /* light reset (port status stays unchanged) - reset completed when this is 0 */
 213 #define CMD_LRESET      (1 << 7)
 214 /* host controller save/restore state. */
 215 #define CMD_CSS         (1 << 8)
 216 #define CMD_CRS         (1 << 9)
 217 /* Enable Wrap Event - '1' means xHC generates an event when MFINDEX wraps. */
 218 #define CMD_EWE         XHCI_CMD_EWE
 219 /* MFINDEX power management - '1' means xHC can stop MFINDEX counter if all root
 220  * hubs are in U3 (selective suspend), disconnect, disabled, or powered-off.
 221  * '0' means the xHC can power it off if all ports are in the disconnect,
 222  * disabled, or powered-off state.
 223  */
 224 #define CMD_PM_INDEX    (1 << 11)
 225 /* bit 14 Extended TBC Enable, changes Isoc TRB fields to support larger TBC */
 226 #define CMD_ETE         (1 << 14)
 227 /* bits 15:31 are reserved (and should be preserved on writes). */
 228
 229 /* IMAN - Interrupt Management Register */
 230 #define IMAN_IE         (1 << 1)
 231 #define IMAN_IP         (1 << 0)
 232
 233 /* USBSTS - USB status - status bitmasks */
 234 /* HC not running - set to 1 when run/stop bit is cleared. */
 235 #define STS_HALT        XHCI_STS_HALT
 236 /* serious error, e.g. PCI parity error.  The HC will clear the run/stop bit. */
 237 #define STS_FATAL       (1 << 2)
 238 /* event interrupt - clear this prior to clearing any IP flags in IR set*/
 239 #define STS_EINT        (1 << 3)
 240 /* port change detect */
 241 #define STS_PORT        (1 << 4)
 242 /* bits 5:7 reserved and zeroed */
 243 /* save state status - '1' means xHC is saving state */
 244 #define STS_SAVE        (1 << 8)
 245 /* restore state status - '1' means xHC is restoring state */
 246 #define STS_RESTORE     (1 << 9)
 247 /* true: save or restore error */
 248 #define STS_SRE         (1 << 10)
 249 /* true: Controller Not Ready to accept doorbell or op reg writes after reset */
 250 #define STS_CNR         XHCI_STS_CNR
 251 /* true: internal Host Controller Error - SW needs to reset and reinitialize */
 252 #define STS_HCE         (1 << 12)
 253 /* bits 13:31 reserved and should be preserved */
 254
 255 /*
 256  * DNCTRL - Device Notification Control Register - dev_notification bitmasks
 257  * Generate a device notification event when the HC sees a transaction with a
 258  * notification type that matches a bit set in this bit field.
 259  */
 260 #define DEV_NOTE_MASK           (0xffff)
 261 #define ENABLE_DEV_NOTE(x)      (1 << (x))
 262 /* Most of the device notification types should only be used for debug.
 263  * SW does need to pay attention to function wake notifications.
 264  */
 265 #define DEV_NOTE_FWAKE          ENABLE_DEV_NOTE(1)
 266
 267 /* CRCR - Command Ring Control Register - cmd_ring bitmasks */
 268 /* bit 0 is the command ring cycle state */
 269 /* stop ring operation after completion of the currently executing command */
 270 #define CMD_RING_PAUSE          (1 << 1)
 271 /* stop ring immediately - abort the currently executing command */
 272 #define CMD_RING_ABORT          (1 << 2)
 273 /* true: command ring is running */
 274 #define CMD_RING_RUNNING        (1 << 3)
 275 /* bits 4:5 reserved and should be preserved */
 276 /* Command Ring pointer - bit mask for the lower 32 bits. */
 277 #define CMD_RING_RSVD_BITS      (0x3f)
 278
 279 /* CONFIG - Configure Register - config_reg bitmasks */
 280 /* bits 0:7 - maximum number of device slots enabled (NumSlotsEn) */
 281 #define MAX_DEVS(p)     ((p) & 0xff)
 282 /* bit 8: U3 Entry Enabled, assert PLC when root port enters U3, xhci 1.1 */
 283 #define CONFIG_U3E              (1 << 8)
 284 /* bit 9: Configuration Information Enable, xhci 1.1 */
 285 #define CONFIG_CIE              (1 << 9)
 286 /* bits 10:31 - reserved and should be preserved */
 287
 288 /* PORTSC - Port Status and Control Register - port_status_base bitmasks */
 289 /* true: device connected */
 290 #define PORT_CONNECT    (1 << 0)
 291 /* true: port enabled */
 292 #define PORT_PE         (1 << 1)
 293 /* bit 2 reserved and zeroed */
 294 /* true: port has an over-current condition */
 295 #define PORT_OC         (1 << 3)
 296 /* true: port reset signaling asserted */
 297 #define PORT_RESET      (1 << 4)
 298 /* Port Link State - bits 5:8
 299  * A read gives the current link PM state of the port,
 300  * a write with Link State Write Strobe set sets the link state.
 301  */
 302 #define PORT_PLS_MASK   (0xf << 5)
 303 #define XDEV_U0         (0x0 << 5)
 304 #define XDEV_U1         (0x1 << 5)
 305 #define XDEV_U2         (0x2 << 5)
 306 #define XDEV_U3         (0x3 << 5)
 307 #define XDEV_DISABLED   (0x4 << 5)
 308 #define XDEV_RXDETECT   (0x5 << 5)
 309 #define XDEV_INACTIVE   (0x6 << 5)
 310 #define XDEV_POLLING    (0x7 << 5)
 311 #define XDEV_RECOVERY   (0x8 << 5)
 312 #define XDEV_HOT_RESET  (0x9 << 5)
 313 #define XDEV_COMP_MODE  (0xa << 5)
 314 #define XDEV_TEST_MODE  (0xb << 5)
 315 #define XDEV_RESUME     (0xf << 5)
 316
 317 /* true: port has power (see HCC_PPC) */
 318 #define PORT_POWER      (1 << 9)
 319 /* bits 10:13 indicate device speed:
 320  * 0 - undefined speed - port hasn't be initialized by a reset yet
 321  * 1 - full speed
 322  * 2 - low speed
 323  * 3 - high speed
 324  * 4 - super speed
 325  * 5-15 reserved
 326  */
 327 #define DEV_SPEED_MASK          (0xf << 10)
 328 #define XDEV_FS                 (0x1 << 10)
 329 #define XDEV_LS                 (0x2 << 10)
 330 #define XDEV_HS                 (0x3 << 10)
 331 #define XDEV_SS                 (0x4 << 10)
 332 #define XDEV_SSP                (0x5 << 10)
 333 #define DEV_UNDEFSPEED(p)       (((p) & DEV_SPEED_MASK) == (0x0<<10))
 334 #define DEV_FULLSPEED(p)        (((p) & DEV_SPEED_MASK) == XDEV_FS)
 335 #define DEV_LOWSPEED(p)         (((p) & DEV_SPEED_MASK) == XDEV_LS)
 336 #define DEV_HIGHSPEED(p)        (((p) & DEV_SPEED_MASK) == XDEV_HS)
 337 #define DEV_SUPERSPEED(p)       (((p) & DEV_SPEED_MASK) == XDEV_SS)
 338 #define DEV_SUPERSPEEDPLUS(p)   (((p) & DEV_SPEED_MASK) == XDEV_SSP)
 339 #define DEV_SUPERSPEED_ANY(p)   (((p) & DEV_SPEED_MASK) >= XDEV_SS)
 340 #define DEV_PORT_SPEED(p)       (((p) >> 10) & 0x0f)
 341
 342 /* Bits 20:23 in the Slot Context are the speed for the device */
 343 #define SLOT_SPEED_FS           (XDEV_FS << 10)
 344 #define SLOT_SPEED_LS           (XDEV_LS << 10)
 345 #define SLOT_SPEED_HS           (XDEV_HS << 10)
 346 #define SLOT_SPEED_SS           (XDEV_SS << 10)
 347 #define SLOT_SPEED_SSP          (XDEV_SSP << 10)
 348 /* Port Indicator Control */
 349 #define PORT_LED_OFF    (0 << 14)
 350 #define PORT_LED_AMBER  (1 << 14)
 351 #define PORT_LED_GREEN  (2 << 14)
 352 #define PORT_LED_MASK   (3 << 14)
 353 /* Port Link State Write Strobe - set this when changing link state */
 354 #define PORT_LINK_STROBE        (1 << 16)
 355 /* true: connect status change */
 356 #define PORT_CSC        (1 << 17)
 357 /* true: port enable change */
 358 #define PORT_PEC        (1 << 18)
 359 /* true: warm reset for a USB 3.0 device is done.  A "hot" reset puts the port
 360  * into an enabled state, and the device into the default state.  A "warm" reset
 361  * also resets the link, forcing the device through the link training sequence.
 362  * SW can also look at the Port Reset register to see when warm reset is done.
 363  */
 364 #define PORT_WRC        (1 << 19)
 365 /* true: over-current change */
 366 #define PORT_OCC        (1 << 20)
 367 /* true: reset change - 1 to 0 transition of PORT_RESET */
 368 #define PORT_RC         (1 << 21)
 369 /* port link status change - set on some port link state transitions:
 370  *  Transition                          Reason
 371  *  ------------------------------------------------------------------------------
 372  *  - U3 to Resume                      Wakeup signaling from a device
 373  *  - Resume to Recovery to U0          USB 3.0 device resume
 374  *  - Resume to U0                      USB 2.0 device resume
 375  *  - U3 to Recovery to U0              Software resume of USB 3.0 device complete
 376  *  - U3 to U0                          Software resume of USB 2.0 device complete
 377  *  - U2 to U0                          L1 resume of USB 2.1 device complete
 378  *  - U0 to U0 (???)                    L1 entry rejection by USB 2.1 device
 379  *  - U0 to disabled                    L1 entry error with USB 2.1 device
 380  *  - Any state to inactive             Error on USB 3.0 port
 381  */
 382 #define PORT_PLC        (1 << 22)
 383 /* port configure error change - port failed to configure its link partner */
 384 #define PORT_CEC        (1 << 23)
 385 #define PORT_CHANGE_MASK        (PORT_CSC | PORT_PEC | PORT_WRC | PORT_OCC | \
 386                                  PORT_RC | PORT_PLC | PORT_CEC)
 387
 388
 389 /* Cold Attach Status - xHC can set this bit to report device attached during
 390  * Sx state. Warm port reset should be perfomed to clear this bit and move port
 391  * to connected state.
 392  */
 393 #define PORT_CAS        (1 << 24)
 394 /* wake on connect (enable) */
 395 #define PORT_WKCONN_E   (1 << 25)
 396 /* wake on disconnect (enable) */
 397 #define PORT_WKDISC_E   (1 << 26)
 398 /* wake on over-current (enable) */
 399 #define PORT_WKOC_E     (1 << 27)
 400 /* bits 28:29 reserved */
 401 /* true: device is non-removable - for USB 3.0 roothub emulation */
 402 #define PORT_DEV_REMOVE (1 << 30)
 403 /* Initiate a warm port reset - complete when PORT_WRC is '1' */
 404 #define PORT_WR         (1 << 31)
 405
 406 /* We mark duplicate entries with -1 */
 407 #define DUPLICATE_ENTRY ((u8)(-1))
 408
 409 /* Port Power Management Status and Control - port_power_base bitmasks */
 410 /* Inactivity timer value for transitions into U1, in microseconds.
 411  * Timeout can be up to 127us.  0xFF means an infinite timeout.
 412  */
 413 #define PORT_U1_TIMEOUT(p)      ((p) & 0xff)
 414 #define PORT_U1_TIMEOUT_MASK    0xff
 415 /* Inactivity timer value for transitions into U2 */
 416 #define PORT_U2_TIMEOUT(p)      (((p) & 0xff) << 8)
 417 #define PORT_U2_TIMEOUT_MASK    (0xff << 8)
 418 /* Bits 24:31 for port testing */
 419
 420 /* USB2 Protocol PORTSPMSC */
 421 #define PORT_L1S_MASK           7
 422 #define PORT_L1S_SUCCESS        1
 423 #define PORT_RWE                (1 << 3)
 424 #define PORT_HIRD(p)            (((p) & 0xf) << 4)
 425 #define PORT_HIRD_MASK          (0xf << 4)
 426 #define PORT_L1DS_MASK          (0xff << 8)
 427 #define PORT_L1DS(p)            (((p) & 0xff) << 8)
 428 #define PORT_HLE                (1 << 16)
 429 #define PORT_TEST_MODE_SHIFT    28
 430
 431 /* USB3 Protocol PORTLI  Port Link Information */
 432 #define PORT_RX_LANES(p)        (((p) >> 16) & 0xf)
 433 #define PORT_TX_LANES(p)        (((p) >> 20) & 0xf)
 434
 435 /* USB2 Protocol PORTHLPMC */
 436 #define PORT_HIRDM(p)((p) & 3)
 437 #define PORT_L1_TIMEOUT(p)(((p) & 0xff) << 2)
 438 #define PORT_BESLD(p)(((p) & 0xf) << 10)
 439
 440 /* use 512 microseconds as USB2 LPM L1 default timeout. */
 441 #define XHCI_L1_TIMEOUT         512
 442
 443 /* Set default HIRD/BESL value to 4 (350/400us) for USB2 L1 LPM resume latency.
 444  * Safe to use with mixed HIRD and BESL systems (host and device) and is used
 445  * by other operating systems.
 446  *
 447  * XHCI 1.0 errata 8/14/12 Table 13 notes:
 448  * "Software should choose xHC BESL/BESLD field values that do not violate a
 449  * device's resume latency requirements,
 450  * e.g. not program values > '4' if BLC = '1' and a HIRD device is attached,
 451  * or not program values < '4' if BLC = '0' and a BESL device is attached.
 452  */
 453 #define XHCI_DEFAULT_BESL       4
 454
 455 /*
 456  * USB3 specification define a 360ms tPollingLFPSTiemout for USB3 ports
 457  * to complete link training. usually link trainig completes much faster
 458  * so check status 10 times with 36ms sleep in places we need to wait for
 459  * polling to complete.
 460  */
 461 #define XHCI_PORT_POLLING_LFPS_TIME  36
 462
 463 /**
 464  * struct xhci_intr_reg - Interrupt Register Set
 465  * @irq_pending:        IMAN - Interrupt Management Register.  Used to enable
 466  *                      interrupts and check for pending interrupts.
 467  * @irq_control:        IMOD - Interrupt Moderation Register.
 468  *                      Used to throttle interrupts.
 469  * @erst_size:          Number of segments in the Event Ring Segment Table (ERST).
 470  * @erst_base:          ERST base address.
 471  * @erst_dequeue:       Event ring dequeue pointer.
 472  *
 473  * Each interrupter (defined by a MSI-X vector) has an event ring and an Event
 474  * Ring Segment Table (ERST) associated with it.  The event ring is comprised of
 475  * multiple segments of the same size.  The HC places events on the ring and
 476  * "updates the Cycle bit in the TRBs to indicate to software the current
 477  * position of the Enqueue Pointer." The HCD (Linux) processes those events and
 478  * updates the dequeue pointer.
 479  */
 480 struct xhci_intr_reg {
 481         __le32  irq_pending;
 482         __le32  irq_control;
 483         __le32  erst_size;
 484         __le32  rsvd;
 485         __le64  erst_base;
 486         __le64  erst_dequeue;
 487 };
 488
 489 /* irq_pending bitmasks */
 490 #define ER_IRQ_PENDING(p)       ((p) & 0x1)
 491 /* bits 2:31 need to be preserved */
 492 /* THIS IS BUGGY - FIXME - IP IS WRITE 1 TO CLEAR */
 493 #define ER_IRQ_CLEAR(p)         ((p) & 0xfffffffe)
 494 #define ER_IRQ_ENABLE(p)        ((ER_IRQ_CLEAR(p)) | 0x2)
 495 #define ER_IRQ_DISABLE(p)       ((ER_IRQ_CLEAR(p)) & ~(0x2))
 496
 497 /* irq_control bitmasks */
 498 /* Minimum interval between interrupts (in 250ns intervals).  The interval
 499  * between interrupts will be longer if there are no events on the event ring.
 500  * Default is 4000 (1 ms).
 501  */
 502 #define ER_IRQ_INTERVAL_MASK    (0xffff)
 503 /* Counter used to count down the time to the next interrupt - HW use only */
 504 #define ER_IRQ_COUNTER_MASK     (0xffff << 16)
 505
 506 /* erst_size bitmasks */
 507 /* Preserve bits 16:31 of erst_size */
 508 #define ERST_SIZE_MASK          (0xffff << 16)
 509
 510 /* erst_dequeue bitmasks */
 511 /* Dequeue ERST Segment Index (DESI) - Segment number (or alias)
 512  * where the current dequeue pointer lies.  This is an optional HW hint.
 513  */
 514 #define ERST_DESI_MASK          (0x7)
 515 /* Event Handler Busy (EHB) - is the event ring scheduled to be serviced by
 516  * a work queue (or delayed service routine)?
 517  */
 518 #define ERST_EHB                (1 << 3)
 519 #define ERST_PTR_MASK           (0xf)
 520
 521 /**
 522  * struct xhci_run_regs
 523  * @microframe_index:
 524  *              MFINDEX - current microframe number
 525  *
 526  * Section 5.5 Host Controller Runtime Registers:
 527  * "Software should read and write these registers using only Dword (32 bit)
 528  * or larger accesses"
 529  */
 530 struct xhci_run_regs {
 531         __le32                  microframe_index;
 532         __le32                  rsvd[7];
 533         struct xhci_intr_reg    ir_set[128];
 534 };
 535
 536 /**
 537  * struct doorbell_array
 538  *
 539  * Bits  0 -  7: Endpoint target
 540  * Bits  8 - 15: RsvdZ
 541  * Bits 16 - 31: Stream ID
 542  *
 543  * Section 5.6
 544  */
 545 struct xhci_doorbell_array {
 546         __le32  doorbell[256];
 547 };
 548
 549 #define DB_VALUE(ep, stream)    ((((ep) + 1) & 0xff) | ((stream) << 16))
 550 #define DB_VALUE_HOST           0x00000000
 551
 552 /**
 553  * struct xhci_protocol_caps
 554  * @revision:           major revision, minor revision, capability ID,
 555  *                      and next capability pointer.
 556  * @name_string:        Four ASCII characters to say which spec this xHC
 557  *                      follows, typically "USB ".
 558  * @port_info:          Port offset, count, and protocol-defined information.
 559  */
 560 struct xhci_protocol_caps {
 561         u32     revision;
 562         u32     name_string;
 563         u32     port_info;
 564 };
 565
 566 #define XHCI_EXT_PORT_MAJOR(x)  (((x) >> 24) & 0xff)
 567 #define XHCI_EXT_PORT_MINOR(x)  (((x) >> 16) & 0xff)
 568 #define XHCI_EXT_PORT_PSIC(x)   (((x) >> 28) & 0x0f)
 569 #define XHCI_EXT_PORT_OFF(x)    ((x) & 0xff)
 570 #define XHCI_EXT_PORT_COUNT(x)  (((x) >> 8) & 0xff)
 571
 572 #define XHCI_EXT_PORT_PSIV(x)   (((x) >> 0) & 0x0f)
 573 #define XHCI_EXT_PORT_PSIE(x)   (((x) >> 4) & 0x03)
 574 #define XHCI_EXT_PORT_PLT(x)    (((x) >> 6) & 0x03)
 575 #define XHCI_EXT_PORT_PFD(x)    (((x) >> 8) & 0x01)
 576 #define XHCI_EXT_PORT_LP(x)     (((x) >> 14) & 0x03)
 577 #define XHCI_EXT_PORT_PSIM(x)   (((x) >> 16) & 0xffff)
 578
 579 #define PLT_MASK        (0x03 << 6)
 580 #define PLT_SYM         (0x00 << 6)
 581 #define PLT_ASYM_RX     (0x02 << 6)
 582 #define PLT_ASYM_TX     (0x03 << 6)
 583
 584 /**
 585  * struct xhci_container_ctx
 586  * @type: Type of context.  Used to calculated offsets to contained contexts.
 587  * @size: Size of the context data
 588  * @bytes: The raw context data given to HW
 589  * @dma: dma address of the bytes
 590  *
 591  * Represents either a Device or Input context.  Holds a pointer to the raw
 592  * memory used for the context (bytes) and dma address of it (dma).
 593  */
 594 struct xhci_container_ctx {
 595         unsigned type;
 596 #define XHCI_CTX_TYPE_DEVICE  0x1
 597 #define XHCI_CTX_TYPE_INPUT   0x2
 598
 599         int size;
 600
 601         u8 *bytes;
 602         dma_addr_t dma;
 603 };
 604
 605 /**
 606  * struct xhci_slot_ctx
 607  * @dev_info:   Route string, device speed, hub info, and last valid endpoint
 608  * @dev_info2:  Max exit latency for device number, root hub port number
 609  * @tt_info:    tt_info is used to construct split transaction tokens
 610  * @dev_state:  slot state and device address
 611  *
 612  * Slot Context - section 6.2.1.1.  This assumes the HC uses 32-byte context
 613  * structures.  If the HC uses 64-byte contexts, there is an additional 32 bytes
 614  * reserved at the end of the slot context for HC internal use.
 615  */
 616 struct xhci_slot_ctx {
 617         __le32  dev_info;
 618         __le32  dev_info2;
 619         __le32  tt_info;
 620         __le32  dev_state;
 621         /* offset 0x10 to 0x1f reserved for HC internal use */
 622         __le32  reserved[4];
 623 };
 624
 625 /* dev_info bitmasks */
 626 /* Route String - 0:19 */
 627 #define ROUTE_STRING_MASK       (0xfffff)
 628 /* Device speed - values defined by PORTSC Device Speed field - 20:23 */
 629 #define DEV_SPEED       (0xf << 20)
 630 #define GET_DEV_SPEED(n) (((n) & DEV_SPEED) >> 20)
 631 /* bit 24 reserved */
 632 /* Is this LS/FS device connected through a HS hub? - bit 25 */
 633 #define DEV_MTT         (0x1 << 25)
 634 /* Set if the device is a hub - bit 26 */
 635 #define DEV_HUB         (0x1 << 26)
 636 /* Index of the last valid endpoint context in this device context - 27:31 */
 637 #define LAST_CTX_MASK   (0x1f << 27)
 638 #define LAST_CTX(p)     ((p) << 27)
 639 #define LAST_CTX_TO_EP_NUM(p)   (((p) >> 27) - 1)
 640 #define SLOT_FLAG       (1 << 0)
 641 #define EP0_FLAG        (1 << 1)
 642
 643 /* dev_info2 bitmasks */
 644 /* Max Exit Latency (ms) - worst case time to wake up all links in dev path */
 645 #define MAX_EXIT        (0xffff)
 646 /* Root hub port number that is needed to access the USB device */
 647 #define ROOT_HUB_PORT(p)        (((p) & 0xff) << 16)
 648 #define DEVINFO_TO_ROOT_HUB_PORT(p)     (((p) >> 16) & 0xff)
 649 /* Maximum number of ports under a hub device */
 650 #define XHCI_MAX_PORTS(p)       (((p) & 0xff) << 24)
 651 #define DEVINFO_TO_MAX_PORTS(p) (((p) & (0xff << 24)) >> 24)
 652
 653 /* tt_info bitmasks */
 654 /*
 655  * TT Hub Slot ID - for low or full speed devices attached to a high-speed hub
 656  * The Slot ID of the hub that isolates the high speed signaling from
 657  * this low or full-speed device.  '0' if attached to root hub port.
 658  */
 659 #define TT_SLOT         (0xff)
 660 /*
 661  * The number of the downstream facing port of the high-speed hub
 662  * '0' if the device is not low or full speed.
 663  */
 664 #define TT_PORT         (0xff << 8)
 665 #define TT_THINK_TIME(p)        (((p) & 0x3) << 16)
 666 #define GET_TT_THINK_TIME(p)    (((p) & (0x3 << 16)) >> 16)
 667
 668 /* dev_state bitmasks */
 669 /* USB device address - assigned by the HC */
 670 #define DEV_ADDR_MASK   (0xff)
 671 /* bits 8:26 reserved */
 672 /* Slot state */
 673 #define SLOT_STATE      (0x1f << 27)
 674 #define GET_SLOT_STATE(p)       (((p) & (0x1f << 27)) >> 27)
 675
 676 #define SLOT_STATE_DISABLED     0
 677 #define SLOT_STATE_ENABLED      SLOT_STATE_DISABLED
 678 #define SLOT_STATE_DEFAULT      1
 679 #define SLOT_STATE_ADDRESSED    2
 680 #define SLOT_STATE_CONFIGURED   3
 681
 682 /**
 683  * struct xhci_ep_ctx
 684  * @ep_info:    endpoint state, streams, mult, and interval information.
 685  * @ep_info2:   information on endpoint type, max packet size, max burst size,
 686  *              error count, and whether the HC will force an event for all
 687  *              transactions.
 688  * @deq:        64-bit ring dequeue pointer address.  If the endpoint only
 689  *              defines one stream, this points to the endpoint transfer ring.
 690  *              Otherwise, it points to a stream context array, which has a
 691  *              ring pointer for each flow.
 692  * @tx_info:
 693  *              Average TRB lengths for the endpoint ring and
 694  *              max payload within an Endpoint Service Interval Time (ESIT).
 695  *
 696  * Endpoint Context - section 6.2.1.2.  This assumes the HC uses 32-byte context
 697  * structures.  If the HC uses 64-byte contexts, there is an additional 32 bytes
 698  * reserved at the end of the endpoint context for HC internal use.
 699  */
 700 struct xhci_ep_ctx {
 701         __le32  ep_info;
 702         __le32  ep_info2;
 703         __le64  deq;
 704         __le32  tx_info;
 705         /* offset 0x14 - 0x1f reserved for HC internal use */
 706         __le32  reserved[3];
 707 };
 708
 709 /* ep_info bitmasks */
 710 /*
 711  * Endpoint State - bits 0:2
 712  * 0 - disabled
 713  * 1 - running
 714  * 2 - halted due to halt condition - ok to manipulate endpoint ring
 715  * 3 - stopped
 716  * 4 - TRB error
 717  * 5-7 - reserved
 718  */
 719 #define EP_STATE_MASK           (0x7)
 720 #define EP_STATE_DISABLED       0
 721 #define EP_STATE_RUNNING        1
 722 #define EP_STATE_HALTED         2
 723 #define EP_STATE_STOPPED        3
 724 #define EP_STATE_ERROR          4
 725 #define GET_EP_CTX_STATE(ctx)   (le32_to_cpu((ctx)->ep_info) & EP_STATE_MASK)
 726
 727 /* Mult - Max number of burtst within an interval, in EP companion desc. */
 728 #define EP_MULT(p)              (((p) & 0x3) << 8)
 729 #define CTX_TO_EP_MULT(p)       (((p) >> 8) & 0x3)
 730 /* bits 10:14 are Max Primary Streams */
 731 /* bit 15 is Linear Stream Array */
 732 /* Interval - period between requests to an endpoint - 125u increments. */
 733 #define EP_INTERVAL(p)                  (((p) & 0xff) << 16)
 734 #define EP_INTERVAL_TO_UFRAMES(p)       (1 << (((p) >> 16) & 0xff))
 735 #define CTX_TO_EP_INTERVAL(p)           (((p) >> 16) & 0xff)
 736 #define EP_MAXPSTREAMS_MASK             (0x1f << 10)
 737 #define EP_MAXPSTREAMS(p)               (((p) << 10) & EP_MAXPSTREAMS_MASK)
 738 #define CTX_TO_EP_MAXPSTREAMS(p)        (((p) & EP_MAXPSTREAMS_MASK) >> 10)
 739 /* Endpoint is set up with a Linear Stream Array (vs. Secondary Stream Array) */
 740 #define EP_HAS_LSA              (1 << 15)
 741 /* hosts with LEC=1 use bits 31:24 as ESIT high bits. */
 742 #define CTX_TO_MAX_ESIT_PAYLOAD_HI(p)   (((p) >> 24) & 0xff)
 743
 744 /* ep_info2 bitmasks */
 745 /*
 746  * Force Event - generate transfer events for all TRBs for this endpoint
 747  * This will tell the HC to ignore the IOC and ISP flags (for debugging only).
 748  */
 749 #define FORCE_EVENT     (0x1)
 750 #define ERROR_COUNT(p)  (((p) & 0x3) << 1)
 751 #define CTX_TO_EP_TYPE(p)       (((p) >> 3) & 0x7)
 752 #define EP_TYPE(p)      ((p) << 3)
 753 #define ISOC_OUT_EP     1
 754 #define BULK_OUT_EP     2
 755 #define INT_OUT_EP      3
 756 #define CTRL_EP         4
 757 #define ISOC_IN_EP      5
 758 #define BULK_IN_EP      6
 759 #define INT_IN_EP       7
 760 /* bit 6 reserved */
 761 /* bit 7 is Host Initiate Disable - for disabling stream selection */
 762 #define MAX_BURST(p)    (((p)&0xff) << 8)
 763 #define CTX_TO_MAX_BURST(p)     (((p) >> 8) & 0xff)
 764 #define MAX_PACKET(p)   (((p)&0xffff) << 16)
 765 #define MAX_PACKET_MASK         (0xffff << 16)
 766 #define MAX_PACKET_DECODED(p)   (((p) >> 16) & 0xffff)
 767
 768 /* tx_info bitmasks */
 769 #define EP_AVG_TRB_LENGTH(p)            ((p) & 0xffff)
 770 #define EP_MAX_ESIT_PAYLOAD_LO(p)       (((p) & 0xffff) << 16)
 771 #define EP_MAX_ESIT_PAYLOAD_HI(p)       ((((p) >> 16) & 0xff) << 24)
 772 #define CTX_TO_MAX_ESIT_PAYLOAD(p)      (((p) >> 16) & 0xffff)
 773
 774 /* deq bitmasks */
 775 #define EP_CTX_CYCLE_MASK               (1 << 0)
 776 #define SCTX_DEQ_MASK                   (~0xfL)
 777
 778
 779 /**
 780  * struct xhci_input_control_context
 781  * Input control context; see section 6.2.5.
 782  *
 783  * @drop_context:       set the bit of the endpoint context you want to disable
 784  * @add_context:        set the bit of the endpoint context you want to enable
 785  */
 786 struct xhci_input_control_ctx {
 787         __le32  drop_flags;
 788         __le32  add_flags;
 789         __le32  rsvd2[6];
 790 };
 791
 792 #define EP_IS_ADDED(ctrl_ctx, i) \
 793         (le32_to_cpu(ctrl_ctx->add_flags) & (1 << (i + 1)))
 794 #define EP_IS_DROPPED(ctrl_ctx, i)       \
 795         (le32_to_cpu(ctrl_ctx->drop_flags) & (1 << (i + 1)))
 796
 797 /* Represents everything that is needed to issue a command on the command ring.
 798  * It's useful to pre-allocate these for commands that cannot fail due to
 799  * out-of-memory errors, like freeing streams.
 800  */
 801 struct xhci_command {
 802         /* Input context for changing device state */
 803         struct xhci_container_ctx       *in_ctx;
 804         u32                             status;
 805         int                             slot_id;
 806         /* If completion is null, no one is waiting on this command
 807          * and the structure can be freed after the command completes.
 808          */
 809         struct completion               *completion;
 810         union xhci_trb                  *command_trb;
 811         struct list_head                cmd_list;
 812 };
 813
 814 /* drop context bitmasks */
 815 #define DROP_EP(x)      (0x1 << x)
 816 /* add context bitmasks */
 817 #define ADD_EP(x)       (0x1 << x)
 818
 819 struct xhci_stream_ctx {
 820         /* 64-bit stream ring address, cycle state, and stream type */
 821         __le64  stream_ring;
 822         /* offset 0x14 - 0x1f reserved for HC internal use */
 823         __le32  reserved[2];
 824 };
 825
 826 /* Stream Context Types (section 6.4.1) - bits 3:1 of stream ctx deq ptr */
 827 #define SCT_FOR_CTX(p)          (((p) & 0x7) << 1)
 828 /* Secondary stream array type, dequeue pointer is to a transfer ring */
 829 #define SCT_SEC_TR              0
 830 /* Primary stream array type, dequeue pointer is to a transfer ring */
 831 #define SCT_PRI_TR              1
 832 /* Dequeue pointer is for a secondary stream array (SSA) with 8 entries */
 833 #define SCT_SSA_8               2
 834 #define SCT_SSA_16              3
 835 #define SCT_SSA_32              4
 836 #define SCT_SSA_64              5
 837 #define SCT_SSA_128             6
 838 #define SCT_SSA_256             7
 839
 840 /* Assume no secondary streams for now */
 841 struct xhci_stream_info {
 842         struct xhci_ring                **stream_rings;
 843         /* Number of streams, including stream 0 (which drivers can't use) */
 844         unsigned int                    num_streams;
 845         /* The stream context array may be bigger than
 846          * the number of streams the driver asked for
 847          */
 848         struct xhci_stream_ctx          *stream_ctx_array;
 849         unsigned int                    num_stream_ctxs;
 850         dma_addr_t                      ctx_array_dma;
 851         /* For mapping physical TRB addresses to segments in stream rings */
 852         struct radix_tree_root          trb_address_map;
 853         struct xhci_command             *free_streams_command;
 854 };
 855
 856 #define SMALL_STREAM_ARRAY_SIZE         256
 857 #define MEDIUM_STREAM_ARRAY_SIZE        1024
 858
 859 /* Some Intel xHCI host controllers need software to keep track of the bus
 860  * bandwidth.  Keep track of endpoint info here.  Each root port is allocated
 861  * the full bus bandwidth.  We must also treat TTs (including each port under a
 862  * multi-TT hub) as a separate bandwidth domain.  The direct memory interface
 863  * (DMI) also limits the total bandwidth (across all domains) that can be used.
 864  */
 865 struct xhci_bw_info {
 866         /* ep_interval is zero-based */
 867         unsigned int            ep_interval;
 868         /* mult and num_packets are one-based */
 869         unsigned int            mult;
 870         unsigned int            num_packets;
 871         unsigned int            max_packet_size;
 872         unsigned int            max_esit_payload;
 873         unsigned int            type;
 874 };
 875
 876 /* "Block" sizes in bytes the hardware uses for different device speeds.
 877  * The logic in this part of the hardware limits the number of bits the hardware
 878  * can use, so must represent bandwidth in a less precise manner to mimic what
 879  * the scheduler hardware computes.
 880  */
 881 #define FS_BLOCK        1
 882 #define HS_BLOCK        4
 883 #define SS_BLOCK        16
 884 #define DMI_BLOCK       32
 885
 886 /* Each device speed has a protocol overhead (CRC, bit stuffing, etc) associated
 887  * with each byte transferred.  SuperSpeed devices have an initial overhead to
 888  * set up bursts.  These are in blocks, see above.  LS overhead has already been
 889  * translated into FS blocks.
 890  */
 891 #define DMI_OVERHEAD 8
 892 #define DMI_OVERHEAD_BURST 4
 893 #define SS_OVERHEAD 8
 894 #define SS_OVERHEAD_BURST 32
 895 #define HS_OVERHEAD 26
 896 #define FS_OVERHEAD 20
 897 #define LS_OVERHEAD 128
 898 /* The TTs need to claim roughly twice as much bandwidth (94 bytes per
 899  * microframe ~= 24Mbps) of the HS bus as the devices can actually use because
 900  * of overhead associated with split transfers crossing microframe boundaries.
 901  * 31 blocks is pure protocol overhead.
 902  */
 903 #define TT_HS_OVERHEAD (31 + 94)
 904 #define TT_DMI_OVERHEAD (25 + 12)
 905
 906 /* Bandwidth limits in blocks */
 907 #define FS_BW_LIMIT             1285
 908 #define TT_BW_LIMIT             1320
 909 #define HS_BW_LIMIT             1607
 910 #define SS_BW_LIMIT_IN          3906
 911 #define DMI_BW_LIMIT_IN         3906
 912 #define SS_BW_LIMIT_OUT         3906
 913 #define DMI_BW_LIMIT_OUT        3906
 914
 915 /* Percentage of bus bandwidth reserved for non-periodic transfers */
 916 #define FS_BW_RESERVED          10
 917 #define HS_BW_RESERVED          20
 918 #define SS_BW_RESERVED          10
 919
 920 struct xhci_virt_ep {
 921         struct xhci_virt_device         *vdev;  /* parent */
 922         unsigned int                    ep_index;
 923         struct xhci_ring                *ring;
 924         /* Related to endpoints that are configured to use stream IDs only */
 925         struct xhci_stream_info         *stream_info;
 926         /* Temporary storage in case the configure endpoint command fails and we
 927          * have to restore the device state to the previous state
 928          */
 929         struct xhci_ring                *new_ring;
 930         unsigned int                    ep_state;
 931 #define SET_DEQ_PENDING         (1 << 0)
 932 #define EP_HALTED               (1 << 1)        /* For stall handling */
 933 #define EP_STOP_CMD_PENDING     (1 << 2)        /* For URB cancellation */
 934 /* Transitioning the endpoint to using streams, don't enqueue URBs */
 935 #define EP_GETTING_STREAMS      (1 << 3)
 936 #define EP_HAS_STREAMS          (1 << 4)
 937 /* Transitioning the endpoint to not using streams, don't enqueue URBs */
 938 #define EP_GETTING_NO_STREAMS   (1 << 5)
 939 #define EP_HARD_CLEAR_TOGGLE    (1 << 6)
 940 #define EP_SOFT_CLEAR_TOGGLE    (1 << 7)
 941 /* usb_hub_clear_tt_buffer is in progress */
 942 #define EP_CLEARING_TT          (1 << 8)
 943         /* ----  Related to URB cancellation ---- */
 944         struct list_head        cancelled_td_list;
 945         /* Watchdog timer for stop endpoint command to cancel URBs */
 946         struct timer_list       stop_cmd_timer;
 947         struct xhci_hcd         *xhci;
 948         /* Dequeue pointer and dequeue segment for a submitted Set TR Dequeue
 949          * command.  We'll need to update the ring's dequeue segment and dequeue
 950          * pointer after the command completes.
 951          */
 952         struct xhci_segment     *queued_deq_seg;
 953         union xhci_trb          *queued_deq_ptr;
 954         /*
 955          * Sometimes the xHC can not process isochronous endpoint ring quickly
 956          * enough, and it will miss some isoc tds on the ring and generate
 957          * a Missed Service Error Event.
 958          * Set skip flag when receive a Missed Service Error Event and
 959          * process the missed tds on the endpoint ring.
 960          */
 961         bool                    skip;
 962         /* Bandwidth checking storage */
 963         struct xhci_bw_info     bw_info;
 964         struct list_head        bw_endpoint_list;
 965         /* Isoch Frame ID checking storage */
 966         int                     next_frame_id;
 967         /* Use new Isoch TRB layout needed for extended TBC support */
 968         bool                    use_extended_tbc;
 969 };
 970
 971 enum xhci_overhead_type {
 972         LS_OVERHEAD_TYPE = 0,
 973         FS_OVERHEAD_TYPE,
 974         HS_OVERHEAD_TYPE,
 975 };
 976
 977 struct xhci_interval_bw {
 978         unsigned int            num_packets;
 979         /* Sorted by max packet size.
 980          * Head of the list is the greatest max packet size.
 981          */
 982         struct list_head        endpoints;
 983         /* How many endpoints of each speed are present. */
 984         unsigned int            overhead[3];
 985 };
 986
 987 #define XHCI_MAX_INTERVAL       16
 988
 989 struct xhci_interval_bw_table {
 990         unsigned int            interval0_esit_payload;
 991         struct xhci_interval_bw interval_bw[XHCI_MAX_INTERVAL];
 992         /* Includes reserved bandwidth for async endpoints */
 993         unsigned int            bw_used;
 994         unsigned int            ss_bw_in;
 995         unsigned int            ss_bw_out;
 996 };
 997
 998 #define EP_CTX_PER_DEV          31
 999
1000 struct xhci_virt_device {
1001         int                             slot_id;
1002         struct usb_device               *udev;
1003         /*
1004          * Commands to the hardware are passed an "input context" that
1005          * tells the hardware what to change in its data structures.
1006          * The hardware will return changes in an "output context" that
1007          * software must allocate for the hardware.  We need to keep
1008          * track of input and output contexts separately because
1009          * these commands might fail and we don't trust the hardware.
1010          */
1011         struct xhci_container_ctx       *out_ctx;
1012         /* Used for addressing devices and configuration changes */
1013         struct xhci_container_ctx       *in_ctx;
1014         struct xhci_virt_ep             eps[EP_CTX_PER_DEV];
1015         u8                              fake_port;
1016         u8                              real_port;
1017         struct xhci_interval_bw_table   *bw_table;
1018         struct xhci_tt_bw_info          *tt_info;
1019         /*
1020          * flags for state tracking based on events and issued commands.
1021          * Software can not rely on states from output contexts because of
1022          * latency between events and xHC updating output context values.
1023          * See xhci 1.1 section 4.8.3 for more details
1024          */
1025         unsigned long                   flags;
1026 #define VDEV_PORT_ERROR                 BIT(0) /* Port error, link inactive */
1027
1028         /* The current max exit latency for the enabled USB3 link states. */
1029         u16                             current_mel;
1030         /* Used for the debugfs interfaces. */
1031         void                            *debugfs_private;
1032 };
1033
1034 /*
1035  * For each roothub, keep track of the bandwidth information for each periodic
1036  * interval.
1037  *
1038  * If a high speed hub is attached to the roothub, each TT associated with that
1039  * hub is a separate bandwidth domain.  The interval information for the
1040  * endpoints on the devices under that TT will appear in the TT structure.
1041  */
1042 struct xhci_root_port_bw_info {
1043         struct list_head                tts;
1044         unsigned int                    num_active_tts;
1045         struct xhci_interval_bw_table   bw_table;
1046 };
1047
1048 struct xhci_tt_bw_info {
1049         struct list_head                tt_list;
1050         int                             slot_id;
1051         int                             ttport;
1052         struct xhci_interval_bw_table   bw_table;
1053         int                             active_eps;
1054 };
1055
1056
1057 /**
1058  * struct xhci_device_context_array
1059  * @dev_context_ptr     array of 64-bit DMA addresses for device contexts
1060  */
1061 struct xhci_device_context_array {
1062         /* 64-bit device addresses; we only write 32-bit addresses */
1063         __le64                  dev_context_ptrs[MAX_HC_SLOTS];
1064         /* private xHCD pointers */
1065         dma_addr_t      dma;
1066 };
1067 /* TODO: write function to set the 64-bit device DMA address */
1068 /*
1069  * TODO: change this to be dynamically sized at HC mem init time since the HC
1070  * might not be able to handle the maximum number of devices possible.
1071  */
1072
1073
1074 struct xhci_transfer_event {
1075         /* 64-bit buffer address, or immediate data */
1076         __le64  buffer;
1077         __le32  transfer_len;
1078         /* This field is interpreted differently based on the type of TRB */
1079         __le32  flags;
1080 };
1081
1082 /* Transfer event TRB length bit mask */
1083 /* bits 0:23 */
1084 #define EVENT_TRB_LEN(p)                ((p) & 0xffffff)
1085
1086 /** Transfer Event bit fields **/
1087 #define TRB_TO_EP_ID(p) (((p) >> 16) & 0x1f)
1088
1089 /* Completion Code - only applicable for some types of TRBs */
1090 #define COMP_CODE_MASK          (0xff << 24)
1091 #define GET_COMP_CODE(p)        (((p) & COMP_CODE_MASK) >> 24)
1092 #define COMP_INVALID                            0
1093 #define COMP_SUCCESS                            1
1094 #define COMP_DATA_BUFFER_ERROR                  2
1095 #define COMP_BABBLE_DETECTED_ERROR              3
1096 #define COMP_USB_TRANSACTION_ERROR              4
1097 #define COMP_TRB_ERROR                          5
1098 #define COMP_STALL_ERROR                        6
1099 #define COMP_RESOURCE_ERROR                     7
1100 #define COMP_BANDWIDTH_ERROR                    8
1101 #define COMP_NO_SLOTS_AVAILABLE_ERROR           9
1102 #define COMP_INVALID_STREAM_TYPE_ERROR          10
1103 #define COMP_SLOT_NOT_ENABLED_ERROR             11
1104 #define COMP_ENDPOINT_NOT_ENABLED_ERROR         12
1105 #define COMP_SHORT_PACKET                       13
1106 #define COMP_RING_UNDERRUN                      14
1107 #define COMP_RING_OVERRUN                       15
1108 #define COMP_VF_EVENT_RING_FULL_ERROR           16
1109 #define COMP_PARAMETER_ERROR                    17
1110 #define COMP_BANDWIDTH_OVERRUN_ERROR            18
1111 #define COMP_CONTEXT_STATE_ERROR                19
1112 #define COMP_NO_PING_RESPONSE_ERROR             20
1113 #define COMP_EVENT_RING_FULL_ERROR              21
1114 #define COMP_INCOMPATIBLE_DEVICE_ERROR          22
1115 #define COMP_MISSED_SERVICE_ERROR               23
1116 #define COMP_COMMAND_RING_STOPPED               24
1117 #define COMP_COMMAND_ABORTED                    25
1118 #define COMP_STOPPED                            26
1119 #define COMP_STOPPED_LENGTH_INVALID             27
1120 #define COMP_STOPPED_SHORT_PACKET               28
1121 #define COMP_MAX_EXIT_LATENCY_TOO_LARGE_ERROR   29
1122 #define COMP_ISOCH_BUFFER_OVERRUN               31
1123 #define COMP_EVENT_LOST_ERROR                   32
1124 #define COMP_UNDEFINED_ERROR                    33
1125 #define COMP_INVALID_STREAM_ID_ERROR            34
1126 #define COMP_SECONDARY_BANDWIDTH_ERROR          35
1127 #define COMP_SPLIT_TRANSACTION_ERROR            36
1128
1129 static inline const char *xhci_trb_comp_code_string(u8 status)
1130 {
1131         switch (status) {
1132         case COMP_INVALID:
1133                 return "Invalid";
1134         case COMP_SUCCESS:
1135                 return "Success";
1136         case COMP_DATA_BUFFER_ERROR:
1137                 return "Data Buffer Error";
1138         case COMP_BABBLE_DETECTED_ERROR:
1139                 return "Babble Detected";
1140         case COMP_USB_TRANSACTION_ERROR:
1141                 return "USB Transaction Error";
1142         case COMP_TRB_ERROR:
1143                 return "TRB Error";
1144         case COMP_STALL_ERROR:
1145                 return "Stall Error";
1146         case COMP_RESOURCE_ERROR:
1147                 return "Resource Error";
1148         case COMP_BANDWIDTH_ERROR:
1149                 return "Bandwidth Error";
1150         case COMP_NO_SLOTS_AVAILABLE_ERROR:
1151                 return "No Slots Available Error";
1152         case COMP_INVALID_STREAM_TYPE_ERROR:
1153                 return "Invalid Stream Type Error";
1154         case COMP_SLOT_NOT_ENABLED_ERROR:
1155                 return "Slot Not Enabled Error";
1156         case COMP_ENDPOINT_NOT_ENABLED_ERROR:
1157                 return "Endpoint Not Enabled Error";
1158         case COMP_SHORT_PACKET:
1159                 return "Short Packet";
1160         case COMP_RING_UNDERRUN:
1161                 return "Ring Underrun";
1162         case COMP_RING_OVERRUN:
1163                 return "Ring Overrun";
1164         case COMP_VF_EVENT_RING_FULL_ERROR:
1165                 return "VF Event Ring Full Error";
1166         case COMP_PARAMETER_ERROR:
1167                 return "Parameter Error";
1168         case COMP_BANDWIDTH_OVERRUN_ERROR:
1169                 return "Bandwidth Overrun Error";
1170         case COMP_CONTEXT_STATE_ERROR:
1171                 return "Context State Error";
1172         case COMP_NO_PING_RESPONSE_ERROR:
1173                 return "No Ping Response Error";
1174         case COMP_EVENT_RING_FULL_ERROR:
1175                 return "Event Ring Full Error";
1176         case COMP_INCOMPATIBLE_DEVICE_ERROR:
1177                 return "Incompatible Device Error";
1178         case COMP_MISSED_SERVICE_ERROR:
1179                 return "Missed Service Error";
1180         case COMP_COMMAND_RING_STOPPED:
1181                 return "Command Ring Stopped";
1182         case COMP_COMMAND_ABORTED:
1183                 return "Command Aborted";
1184         case COMP_STOPPED:
1185                 return "Stopped";
1186         case COMP_STOPPED_LENGTH_INVALID:
1187                 return "Stopped - Length Invalid";
1188         case COMP_STOPPED_SHORT_PACKET:
1189                 return "Stopped - Short Packet";
1190         case COMP_MAX_EXIT_LATENCY_TOO_LARGE_ERROR:
1191                 return "Max Exit Latency Too Large Error";
1192         case COMP_ISOCH_BUFFER_OVERRUN:
1193                 return "Isoch Buffer Overrun";
1194         case COMP_EVENT_LOST_ERROR:
1195                 return "Event Lost Error";
1196         case COMP_UNDEFINED_ERROR:
1197                 return "Undefined Error";
1198         case COMP_INVALID_STREAM_ID_ERROR:
1199                 return "Invalid Stream ID Error";
1200         case COMP_SECONDARY_BANDWIDTH_ERROR:
1201                 return "Secondary Bandwidth Error";
1202         case COMP_SPLIT_TRANSACTION_ERROR:
1203                 return "Split Transaction Error";
1204         default:
1205                 return "Unknown!!";
1206         }
1207 }
1208
1209 struct xhci_link_trb {
1210         /* 64-bit segment pointer*/
1211         __le64 segment_ptr;
1212         __le32 intr_target;
1213         __le32 control;
1214 };
1215
1216 /* control bitfields */
1217 #define LINK_TOGGLE     (0x1<<1)
1218
1219 /* Command completion event TRB */
1220 struct xhci_event_cmd {
1221         /* Pointer to command TRB, or the value passed by the event data trb */
1222         __le64 cmd_trb;
1223         __le32 status;
1224         __le32 flags;
1225 };
1226
1227 /* flags bitmasks */
1228
1229 /* Address device - disable SetAddress */
1230 #define TRB_BSR         (1<<9)
1231
1232 /* Configure Endpoint - Deconfigure */
1233 #define TRB_DC          (1<<9)
1234
1235 /* Stop Ring - Transfer State Preserve */
1236 #define TRB_TSP         (1<<9)
1237
1238 enum xhci_ep_reset_type {
1239         EP_HARD_RESET,
1240         EP_SOFT_RESET,
1241 };
1242
1243 /* Force Event */
1244 #define TRB_TO_VF_INTR_TARGET(p)        (((p) & (0x3ff << 22)) >> 22)
1245 #define TRB_TO_VF_ID(p)                 (((p) & (0xff << 16)) >> 16)
1246
1247 /* Set Latency Tolerance Value */
1248 #define TRB_TO_BELT(p)                  (((p) & (0xfff << 16)) >> 16)
1249
1250 /* Get Port Bandwidth */
1251 #define TRB_TO_DEV_SPEED(p)             (((p) & (0xf << 16)) >> 16)
1252
1253 /* Force Header */
1254 #define TRB_TO_PACKET_TYPE(p)           ((p) & 0x1f)
1255 #define TRB_TO_ROOTHUB_PORT(p)          (((p) & (0xff << 24)) >> 24)
1256
1257 enum xhci_setup_dev {
1258         SETUP_CONTEXT_ONLY,
1259         SETUP_CONTEXT_ADDRESS,
1260 };
1261
1262 /* bits 16:23 are the virtual function ID */
1263 /* bits 24:31 are the slot ID */
1264 #define TRB_TO_SLOT_ID(p)       (((p) & (0xff<<24)) >> 24)
1265 #define SLOT_ID_FOR_TRB(p)      (((p) & 0xff) << 24)
1266
1267 /* Stop Endpoint TRB - ep_index to endpoint ID for this TRB */
1268 #define TRB_TO_EP_INDEX(p)              ((((p) & (0x1f << 16)) >> 16) - 1)
1269 #define EP_ID_FOR_TRB(p)                ((((p) + 1) & 0x1f) << 16)
1270
1271 #define SUSPEND_PORT_FOR_TRB(p)         (((p) & 1) << 23)
1272 #define TRB_TO_SUSPEND_PORT(p)          (((p) & (1 << 23)) >> 23)
1273 #define LAST_EP_INDEX                   30
1274
1275 /* Set TR Dequeue Pointer command TRB fields, 6.4.3.9 */
1276 #define TRB_TO_STREAM_ID(p)             ((((p) & (0xffff << 16)) >> 16))
1277 #define STREAM_ID_FOR_TRB(p)            ((((p)) & 0xffff) << 16)
1278 #define SCT_FOR_TRB(p)                  (((p) << 1) & 0x7)
1279
1280 /* Link TRB specific fields */
1281 #define TRB_TC                  (1<<1)
1282
1283 /* Port Status Change Event TRB fields */
1284 /* Port ID - bits 31:24 */
1285 #define GET_PORT_ID(p)          (((p) & (0xff << 24)) >> 24)
1286
1287 #define EVENT_DATA              (1 << 2)
1288
1289 /* Normal TRB fields */
1290 /* transfer_len bitmasks - bits 0:16 */
1291 #define TRB_LEN(p)              ((p) & 0x1ffff)
1292 /* TD Size, packets remaining in this TD, bits 21:17 (5 bits, so max 31) */
1293 #define TRB_TD_SIZE(p)          (min((p), (u32)31) << 17)
1294 #define GET_TD_SIZE(p)          (((p) & 0x3e0000) >> 17)
1295 /* xhci 1.1 uses the TD_SIZE field for TBC if Extended TBC is enabled (ETE) */
1296 #define TRB_TD_SIZE_TBC(p)      (min((p), (u32)31) << 17)
1297 /* Interrupter Target - which MSI-X vector to target the completion event at */
1298 #define TRB_INTR_TARGET(p)      (((p) & 0x3ff) << 22)
1299 #define GET_INTR_TARGET(p)      (((p) >> 22) & 0x3ff)
1300 /* Total burst count field, Rsvdz on xhci 1.1 with Extended TBC enabled (ETE) */
1301 #define TRB_TBC(p)              (((p) & 0x3) << 7)
1302 #define TRB_TLBPC(p)            (((p) & 0xf) << 16)
1303
1304 /* Cycle bit - indicates TRB ownership by HC or HCD */
1305 #define TRB_CYCLE               (1<<0)
1306 /*
1307  * Force next event data TRB to be evaluated before task switch.
1308  * Used to pass OS data back after a TD completes.
1309  */
1310 #define TRB_ENT                 (1<<1)
1311 /* Interrupt on short packet */
1312 #define TRB_ISP                 (1<<2)
1313 /* Set PCIe no snoop attribute */
1314 #define TRB_NO_SNOOP            (1<<3)
1315 /* Chain multiple TRBs into a TD */
1316 #define TRB_CHAIN               (1<<4)
1317 /* Interrupt on completion */
1318 #define TRB_IOC                 (1<<5)
1319 /* The buffer pointer contains immediate data */
1320 #define TRB_IDT                 (1<<6)
1321 /* TDs smaller than this might use IDT */
1322 #define TRB_IDT_MAX_SIZE        8
1323
1324 /* Block Event Interrupt */
1325 #define TRB_BEI                 (1<<9)
1326
1327 /* Control transfer TRB specific fields */
1328 #define TRB_DIR_IN              (1<<16)
1329 #define TRB_TX_TYPE(p)          ((p) << 16)
1330 #define TRB_DATA_OUT            2
1331 #define TRB_DATA_IN             3
1332
1333 /* Isochronous TRB specific fields */
1334 #define TRB_SIA                 (1<<31)
1335 #define TRB_FRAME_ID(p)         (((p) & 0x7ff) << 20)
1336
1337 /* TRB cache size for xHC with TRB cache */
1338 #define TRB_CACHE_SIZE_HS       8
1339 #define TRB_CACHE_SIZE_SS       16
1340
1341 struct xhci_generic_trb {
1342         __le32 field[4];
1343 };
1344
1345 union xhci_trb {
1346         struct xhci_link_trb            link;
1347         struct xhci_transfer_event      trans_event;
1348         struct xhci_event_cmd           event_cmd;
1349         struct xhci_generic_trb         generic;
1350 };
1351
1352 /* TRB bit mask */
1353 #define TRB_TYPE_BITMASK        (0xfc00)
1354 #define TRB_TYPE(p)             ((p) << 10)
1355 #define TRB_FIELD_TO_TYPE(p)    (((p) & TRB_TYPE_BITMASK) >> 10)
1356 /* TRB type IDs */
1357 /* bulk, interrupt, isoc scatter/gather, and control data stage */
1358 #define TRB_NORMAL              1
1359 /* setup stage for control transfers */
1360 #define TRB_SETUP               2
1361 /* data stage for control transfers */
1362 #define TRB_DATA                3
1363 /* status stage for control transfers */
1364 #define TRB_STATUS              4
1365 /* isoc transfers */
1366 #define TRB_ISOC                5
1367 /* TRB for linking ring segments */
1368 #define TRB_LINK                6
1369 #define TRB_EVENT_DATA          7
1370 /* Transfer Ring No-op (not for the command ring) */
1371 #define TRB_TR_NOOP             8
1372 /* Command TRBs */
1373 /* Enable Slot Command */
1374 #define TRB_ENABLE_SLOT         9
1375 /* Disable Slot Command */
1376 #define TRB_DISABLE_SLOT        10
1377 /* Address Device Command */
1378 #define TRB_ADDR_DEV            11
1379 /* Configure Endpoint Command */
1380 #define TRB_CONFIG_EP           12
1381 /* Evaluate Context Command */
1382 #define TRB_EVAL_CONTEXT        13
1383 /* Reset Endpoint Command */
1384 #define TRB_RESET_EP            14
1385 /* Stop Transfer Ring Command */
1386 #define TRB_STOP_RING           15
1387 /* Set Transfer Ring Dequeue Pointer Command */
1388 #define TRB_SET_DEQ             16
1389 /* Reset Device Command */
1390 #define TRB_RESET_DEV           17
1391 /* Force Event Command (opt) */
1392 #define TRB_FORCE_EVENT         18
1393 /* Negotiate Bandwidth Command (opt) */
1394 #define TRB_NEG_BANDWIDTH       19
1395 /* Set Latency Tolerance Value Command (opt) */
1396 #define TRB_SET_LT              20
1397 /* Get port bandwidth Command */
1398 #define TRB_GET_BW              21
1399 /* Force Header Command - generate a transaction or link management packet */
1400 #define TRB_FORCE_HEADER        22
1401 /* No-op Command - not for transfer rings */
1402 #define TRB_CMD_NOOP            23
1403 /* TRB IDs 24-31 reserved */
1404 /* Event TRBS */
1405 /* Transfer Event */
1406 #define TRB_TRANSFER            32
1407 /* Command Completion Event */
1408 #define TRB_COMPLETION          33
1409 /* Port Status Change Event */
1410 #define TRB_PORT_STATUS         34
1411 /* Bandwidth Request Event (opt) */
1412 #define TRB_BANDWIDTH_EVENT     35
1413 /* Doorbell Event (opt) */
1414 #define TRB_DOORBELL            36
1415 /* Host Controller Event */
1416 #define TRB_HC_EVENT            37
1417 /* Device Notification Event - device sent function wake notification */
1418 #define TRB_DEV_NOTE            38
1419 /* MFINDEX Wrap Event - microframe counter wrapped */
1420 #define TRB_MFINDEX_WRAP        39
1421 /* TRB IDs 40-47 reserved, 48-63 is vendor-defined */
1422 #define TRB_VENDOR_DEFINED_LOW  48
1423 /* Nec vendor-specific command completion event. */
1424 #define TRB_NEC_CMD_COMP        48
1425 /* Get NEC firmware revision. */
1426 #define TRB_NEC_GET_FW          49
1427
1428 static inline const char *xhci_trb_type_string(u8 type)
1429 {
1430         switch (type) {
1431         case TRB_NORMAL:
1432                 return "Normal";
1433         case TRB_SETUP:
1434                 return "Setup Stage";
1435         case TRB_DATA:
1436                 return "Data Stage";
1437         case TRB_STATUS:
1438                 return "Status Stage";
1439         case TRB_ISOC:
1440                 return "Isoch";
1441         case TRB_LINK:
1442                 return "Link";
1443         case TRB_EVENT_DATA:
1444                 return "Event Data";
1445         case TRB_TR_NOOP:
1446                 return "No-Op";
1447         case TRB_ENABLE_SLOT:
1448                 return "Enable Slot Command";
1449         case TRB_DISABLE_SLOT:
1450                 return "Disable Slot Command";
1451         case TRB_ADDR_DEV:
1452                 return "Address Device Command";
1453         case TRB_CONFIG_EP:
1454                 return "Configure Endpoint Command";
1455         case TRB_EVAL_CONTEXT:
1456                 return "Evaluate Context Command";
1457         case TRB_RESET_EP:
1458                 return "Reset Endpoint Command";
1459         case TRB_STOP_RING:
1460                 return "Stop Ring Command";
1461         case TRB_SET_DEQ:
1462                 return "Set TR Dequeue Pointer Command";
1463         case TRB_RESET_DEV:
1464                 return "Reset Device Command";
1465         case TRB_FORCE_EVENT:
1466                 return "Force Event Command";
1467         case TRB_NEG_BANDWIDTH:
1468                 return "Negotiate Bandwidth Command";
1469         case TRB_SET_LT:
1470                 return "Set Latency Tolerance Value Command";
1471         case TRB_GET_BW:
1472                 return "Get Port Bandwidth Command";
1473         case TRB_FORCE_HEADER:
1474                 return "Force Header Command";
1475         case TRB_CMD_NOOP:
1476                 return "No-Op Command";
1477         case TRB_TRANSFER:
1478                 return "Transfer Event";
1479         case TRB_COMPLETION:
1480                 return "Command Completion Event";
1481         case TRB_PORT_STATUS:
1482                 return "Port Status Change Event";
1483         case TRB_BANDWIDTH_EVENT:
1484                 return "Bandwidth Request Event";
1485         case TRB_DOORBELL:
1486                 return "Doorbell Event";
1487         case TRB_HC_EVENT:
1488                 return "Host Controller Event";
1489         case TRB_DEV_NOTE:
1490                 return "Device Notification Event";
1491         case TRB_MFINDEX_WRAP:
1492                 return "MFINDEX Wrap Event";
1493         case TRB_NEC_CMD_COMP:
1494                 return "NEC Command Completion Event";
1495         case TRB_NEC_GET_FW:
1496                 return "NET Get Firmware Revision Command";
1497         default:
1498                 return "UNKNOWN";
1499         }
1500 }
1501
1502 #define TRB_TYPE_LINK(x)        (((x) & TRB_TYPE_BITMASK) == TRB_TYPE(TRB_LINK))
1503 /* Above, but for __le32 types -- can avoid work by swapping constants: */
1504 #define TRB_TYPE_LINK_LE32(x)   (((x) & cpu_to_le32(TRB_TYPE_BITMASK)) == \
1505                                  cpu_to_le32(TRB_TYPE(TRB_LINK)))
1506 #define TRB_TYPE_NOOP_LE32(x)   (((x) & cpu_to_le32(TRB_TYPE_BITMASK)) == \
1507                                  cpu_to_le32(TRB_TYPE(TRB_TR_NOOP)))
1508
1509 #define NEC_FW_MINOR(p)         (((p) >> 0) & 0xff)
1510 #define NEC_FW_MAJOR(p)         (((p) >> 8) & 0xff)
1511
1512 /*
1513  * TRBS_PER_SEGMENT must be a multiple of 4,
1514  * since the command ring is 64-byte aligned.
1515  * It must also be greater than 16.
1516  */
1517 #define TRBS_PER_SEGMENT        256
1518 /* Allow two commands + a link TRB, along with any reserved command TRBs */
1519 #define MAX_RSVD_CMD_TRBS       (TRBS_PER_SEGMENT - 3)
1520 #define TRB_SEGMENT_SIZE        (TRBS_PER_SEGMENT*16)
1521 #define TRB_SEGMENT_SHIFT       (ilog2(TRB_SEGMENT_SIZE))
1522 /* TRB buffer pointers can't cross 64KB boundaries */
1523 #define TRB_MAX_BUFF_SHIFT              16
1524 #define TRB_MAX_BUFF_SIZE       (1 << TRB_MAX_BUFF_SHIFT)
1525 /* How much data is left before the 64KB boundary? */
1526 #define TRB_BUFF_LEN_UP_TO_BOUNDARY(addr)       (TRB_MAX_BUFF_SIZE - \
1527                                         (addr & (TRB_MAX_BUFF_SIZE - 1)))
1528 #define MAX_SOFT_RETRY          3
1529
1530 struct xhci_segment {
1531         union xhci_trb          *trbs;
1532         /* private to HCD */
1533         struct xhci_segment     *next;
1534         dma_addr_t              dma;
1535         /* Max packet sized bounce buffer for td-fragmant alignment */
1536         dma_addr_t              bounce_dma;
1537         void                    *bounce_buf;
1538         unsigned int            bounce_offs;
1539         unsigned int            bounce_len;
1540 };
1541
1542 enum xhci_cancelled_td_status {
1543         TD_DIRTY = 0,
1544         TD_HALTED,
1545         TD_CLEARING_CACHE,
1546         TD_CLEARED,
1547 };
1548
1549 struct xhci_td {
1550         struct list_head        td_list;
1551         struct list_head        cancelled_td_list;
1552         int                     status;
1553         enum xhci_cancelled_td_status   cancel_status;
1554         struct urb              *urb;
1555         struct xhci_segment     *start_seg;
1556         union xhci_trb          *first_trb;
1557         union xhci_trb          *last_trb;
1558         struct xhci_segment     *last_trb_seg;
1559         struct xhci_segment     *bounce_seg;
1560         /* actual_length of the URB has already been set */
1561         bool                    urb_length_set;
1562         unsigned int            num_trbs;
1563 };
1564
1565 /* xHCI command default timeout value */
1566 #define XHCI_CMD_DEFAULT_TIMEOUT        (5 * HZ)
1567
1568 /* command descriptor */
1569 struct xhci_cd {
1570         struct xhci_command     *command;
1571         union xhci_trb          *cmd_trb;
1572 };
1573
1574 enum xhci_ring_type {
1575         TYPE_CTRL = 0,
1576         TYPE_ISOC,
1577         TYPE_BULK,
1578         TYPE_INTR,
1579         TYPE_STREAM,
1580         TYPE_COMMAND,
1581         TYPE_EVENT,
1582 };
1583
1584 static inline const char *xhci_ring_type_string(enum xhci_ring_type type)
1585 {
1586         switch (type) {
1587         case TYPE_CTRL:
1588                 return "CTRL";
1589         case TYPE_ISOC:
1590                 return "ISOC";
1591         case TYPE_BULK:
1592                 return "BULK";
1593         case TYPE_INTR:
1594                 return "INTR";
1595         case TYPE_STREAM:
1596                 return "STREAM";
1597         case TYPE_COMMAND:
1598                 return "CMD";
1599         case TYPE_EVENT:
1600                 return "EVENT";
1601         }
1602
1603         return "UNKNOWN";
1604 }
1605
1606 struct xhci_ring {
1607         struct xhci_segment     *first_seg;
1608         struct xhci_segment     *last_seg;
1609         union  xhci_trb         *enqueue;
1610         struct xhci_segment     *enq_seg;
1611         union  xhci_trb         *dequeue;
1612         struct xhci_segment     *deq_seg;
1613         struct list_head        td_list;
1614         /*
1615          * Write the cycle state into the TRB cycle field to give ownership of
1616          * the TRB to the host controller (if we are the producer), or to check
1617          * if we own the TRB (if we are the consumer).  See section 4.9.1.
1618          */
1619         u32                     cycle_state;
1620         unsigned int            err_count;
1621         unsigned int            stream_id;
1622         unsigned int            num_segs;
1623         unsigned int            num_trbs_free;
1624         unsigned int            num_trbs_free_temp;
1625         unsigned int            bounce_buf_len;
1626         enum xhci_ring_type     type;
1627         bool                    last_td_was_short;
1628         struct radix_tree_root  *trb_address_map;
1629 };
1630
1631 struct xhci_erst_entry {
1632         /* 64-bit event ring segment address */
1633         __le64  seg_addr;
1634         __le32  seg_size;
1635         /* Set to zero */
1636         __le32  rsvd;
1637 };
1638
1639 struct xhci_erst {
1640         struct xhci_erst_entry  *entries;
1641         unsigned int            num_entries;
1642         /* xhci->event_ring keeps track of segment dma addresses */
1643         dma_addr_t              erst_dma_addr;
1644         /* Num entries the ERST can contain */
1645         unsigned int            erst_size;
1646 };
1647
1648 struct xhci_scratchpad {
1649         u64 *sp_array;
1650         dma_addr_t sp_dma;
1651         void **sp_buffers;
1652 };
1653
1654 struct urb_priv {
1655         int     num_tds;
1656         int     num_tds_done;
1657         struct  xhci_td td[];
1658 };
1659
1660 /*
1661  * Each segment table entry is 4*32bits long.  1K seems like an ok size:
1662  * (1K bytes * 8bytes/bit) / (4*32 bits) = 64 segment entries in the table,
1663  * meaning 64 ring segments.
1664  * Initial allocated size of the ERST, in number of entries */
1665 #define ERST_NUM_SEGS   1
1666 /* Initial allocated size of the ERST, in number of entries */
1667 #define ERST_SIZE       64
1668 /* Initial number of event segment rings allocated */
1669 #define ERST_ENTRIES    1
1670 /* Poll every 60 seconds */
1671 #define POLL_TIMEOUT    60
1672 /* Stop endpoint command timeout (secs) for URB cancellation watchdog timer */
1673 #define XHCI_STOP_EP_CMD_TIMEOUT        5
1674 /* XXX: Make these module parameters */
1675
1676 struct s3_save {
1677         u32     command;
1678         u32     dev_nt;
1679         u64     dcbaa_ptr;
1680         u32     config_reg;
1681         u32     irq_pending;
1682         u32     irq_control;
1683         u32     erst_size;
1684         u64     erst_base;
1685         u64     erst_dequeue;
1686 };
1687
1688 /* Use for lpm */
1689 struct dev_info {
1690         u32                     dev_id;
1691         struct  list_head       list;
1692 };
1693
1694 struct xhci_bus_state {
1695         unsigned long           bus_suspended;
1696         unsigned long           next_statechange;
1697
1698         /* Port suspend arrays are indexed by the portnum of the fake roothub */
1699         /* ports suspend status arrays - max 31 ports for USB2, 15 for USB3 */
1700         u32                     port_c_suspend;
1701         u32                     suspended_ports;
1702         u32                     port_remote_wakeup;
1703         unsigned long           resume_done[USB_MAXCHILDREN];
1704         /* which ports have started to resume */
1705         unsigned long           resuming_ports;
1706         /* Which ports are waiting on RExit to U0 transition. */
1707         unsigned long           rexit_ports;
1708         struct completion       rexit_done[USB_MAXCHILDREN];
1709         struct completion       u3exit_done[USB_MAXCHILDREN];
1710 };
1711
1712
1713 /*
1714  * It can take up to 20 ms to transition from RExit to U0 on the
1715  * Intel Lynx Point LP xHCI host.
1716  */
1717 #define XHCI_MAX_REXIT_TIMEOUT_MS       20
1718 struct xhci_port_cap {
1719         u32                     *psi;   /* array of protocol speed ID entries */
1720         u8                      psi_count;
1721         u8                      psi_uid_count;
1722         u8                      maj_rev;
1723         u8                      min_rev;
1724 };
1725
1726 struct xhci_port {
1727         __le32 __iomem          *addr;
1728         int                     hw_portnum;
1729         int                     hcd_portnum;
1730         struct xhci_hub         *rhub;
1731         struct xhci_port_cap    *port_cap;
1732 };
1733
1734 struct xhci_hub {
1735         struct xhci_port        **ports;
1736         unsigned int            num_ports;
1737         struct usb_hcd          *hcd;
1738         /* keep track of bus suspend info */
1739         struct xhci_bus_state   bus_state;
1740         /* supported prococol extended capabiliy values */
1741         u8                      maj_rev;
1742         u8                      min_rev;
1743 };
1744
1745 /* There is one xhci_hcd structure per controller */
1746 struct xhci_hcd {
1747         struct usb_hcd *main_hcd;
1748         struct usb_hcd *shared_hcd;
1749         /* glue to PCI and HCD framework */
1750         struct xhci_cap_regs __iomem *cap_regs;
1751         struct xhci_op_regs __iomem *op_regs;
1752         struct xhci_run_regs __iomem *run_regs;
1753         struct xhci_doorbell_array __iomem *dba;
1754         /* Our HCD's current interrupter register set */
1755         struct  xhci_intr_reg __iomem *ir_set;
1756
1757         /* Cached register copies of read-only HC data */
1758         __u32           hcs_params1;
1759         __u32           hcs_params2;
1760         __u32           hcs_params3;
1761         __u32           hcc_params;
1762         __u32           hcc_params2;
1763
1764         spinlock_t      lock;
1765
1766         /* packed release number */
1767         u8              sbrn;
1768         u16             hci_version;
1769         u8              max_slots;
1770         u8              max_interrupters;
1771         u8              max_ports;
1772         u8              isoc_threshold;
1773         /* imod_interval in ns (I * 250ns) */
1774         u32             imod_interval;
1775         int             event_ring_max;
1776         /* 4KB min, 128MB max */
1777         int             page_size;
1778         /* Valid values are 12 to 20, inclusive */
1779         int             page_shift;
1780         /* msi-x vectors */
1781         int             msix_count;
1782         /* optional clocks */
1783         struct clk              *clk;
1784         struct clk              *reg_clk;
1785         /* optional reset controller */
1786         struct reset_control *reset;
1787         /* data structures */
1788         struct xhci_device_context_array *dcbaa;
1789         struct xhci_ring        *cmd_ring;
1790         unsigned int            cmd_ring_state;
1791 #define CMD_RING_STATE_RUNNING         (1 << 0)
1792 #define CMD_RING_STATE_ABORTED         (1 << 1)
1793 #define CMD_RING_STATE_STOPPED         (1 << 2)
1794         struct list_head        cmd_list;
1795         unsigned int            cmd_ring_reserved_trbs;
1796         struct delayed_work     cmd_timer;
1797         struct completion       cmd_ring_stop_completion;
1798         struct xhci_command     *current_cmd;
1799         struct xhci_ring        *event_ring;
1800         struct xhci_erst        erst;
1801         /* Scratchpad */
1802         struct xhci_scratchpad  *scratchpad;
1803         /* Store LPM test failed devices' information */
1804         struct list_head        lpm_failed_devs;
1805
1806         /* slot enabling and address device helpers */
1807         /* these are not thread safe so use mutex */
1808         struct mutex mutex;
1809         /* For USB 3.0 LPM enable/disable. */
1810         struct xhci_command             *lpm_command;
1811         /* Internal mirror of the HW's dcbaa */
1812         struct xhci_virt_device *devs[MAX_HC_SLOTS];
1813         /* For keeping track of bandwidth domains per roothub. */
1814         struct xhci_root_port_bw_info   *rh_bw;
1815
1816         /* DMA pools */
1817         struct dma_pool *device_pool;
1818         struct dma_pool *segment_pool;
1819         struct dma_pool *small_streams_pool;
1820         struct dma_pool *medium_streams_pool;
1821
1822         /* Host controller watchdog timer structures */
1823         unsigned int            xhc_state;
1824
1825         u32                     command;
1826         struct s3_save          s3;
1827 /* Host controller is dying - not responding to commands. "I'm not dead yet!"
1828  *
1829  * xHC interrupts have been disabled and a watchdog timer will (or has already)
1830  * halt the xHCI host, and complete all URBs with an -ESHUTDOWN code.  Any code
1831  * that sees this status (other than the timer that set it) should stop touching
1832  * hardware immediately.  Interrupt handlers should return immediately when
1833  * they see this status (any time they drop and re-acquire xhci->lock).
1834  * xhci_urb_dequeue() should call usb_hcd_check_unlink_urb() and return without
1835  * putting the TD on the canceled list, etc.
1836  *
1837  * There are no reports of xHCI host controllers that display this issue.
1838  */
1839 #define XHCI_STATE_DYING        (1 << 0)
1840 #define XHCI_STATE_HALTED       (1 << 1)
1841 #define XHCI_STATE_REMOVING     (1 << 2)
1842         unsigned long long      quirks;
1843 #define XHCI_LINK_TRB_QUIRK     BIT_ULL(0)
1844 #define XHCI_RESET_EP_QUIRK     BIT_ULL(1)
1845 #define XHCI_NEC_HOST           BIT_ULL(2)
1846 #define XHCI_AMD_PLL_FIX        BIT_ULL(3)
1847 #define XHCI_SPURIOUS_SUCCESS   BIT_ULL(4)
1848 /*
1849  * Certain Intel host controllers have a limit to the number of endpoint
1850  * contexts they can handle.  Ideally, they would signal that they can't handle
1851  * anymore endpoint contexts by returning a Resource Error for the Configure
1852  * Endpoint command, but they don't.  Instead they expect software to keep track
1853  * of the number of active endpoints for them, across configure endpoint
1854  * commands, reset device commands, disable slot commands, and address device
1855  * commands.
1856  */
1857 #define XHCI_EP_LIMIT_QUIRK     BIT_ULL(5)
1858 #define XHCI_BROKEN_MSI         BIT_ULL(6)
1859 #define XHCI_RESET_ON_RESUME    BIT_ULL(7)
1860 #define XHCI_SW_BW_CHECKING     BIT_ULL(8)
1861 #define XHCI_AMD_0x96_HOST      BIT_ULL(9)
1862 #define XHCI_TRUST_TX_LENGTH    BIT_ULL(10)
1863 #define XHCI_LPM_SUPPORT        BIT_ULL(11)
1864 #define XHCI_INTEL_HOST         BIT_ULL(12)
1865 #define XHCI_SPURIOUS_REBOOT    BIT_ULL(13)
1866 #define XHCI_COMP_MODE_QUIRK    BIT_ULL(14)
1867 #define XHCI_AVOID_BEI          BIT_ULL(15)
1868 #define XHCI_PLAT               BIT_ULL(16)
1869 #define XHCI_SLOW_SUSPEND       BIT_ULL(17)
1870 #define XHCI_SPURIOUS_WAKEUP    BIT_ULL(18)
1871 /* For controllers with a broken beyond repair streams implementation */
1872 #define XHCI_BROKEN_STREAMS     BIT_ULL(19)
1873 #define XHCI_PME_STUCK_QUIRK    BIT_ULL(20)
1874 #define XHCI_MTK_HOST           BIT_ULL(21)
1875 #define XHCI_SSIC_PORT_UNUSED   BIT_ULL(22)
1876 #define XHCI_NO_64BIT_SUPPORT   BIT_ULL(23)
1877 #define XHCI_MISSING_CAS        BIT_ULL(24)
1878 /* For controller with a broken Port Disable implementation */
1879 #define XHCI_BROKEN_PORT_PED    BIT_ULL(25)
1880 #define XHCI_LIMIT_ENDPOINT_INTERVAL_7  BIT_ULL(26)
1881 #define XHCI_U2_DISABLE_WAKE    BIT_ULL(27)
1882 #define XHCI_ASMEDIA_MODIFY_FLOWCONTROL BIT_ULL(28)
1883 #define XHCI_HW_LPM_DISABLE     BIT_ULL(29)
1884 #define XHCI_SUSPEND_DELAY      BIT_ULL(30)
1885 #define XHCI_INTEL_USB_ROLE_SW  BIT_ULL(31)
1886 #define XHCI_ZERO_64B_REGS      BIT_ULL(32)
1887 #define XHCI_DEFAULT_PM_RUNTIME_ALLOW   BIT_ULL(33)
1888 #define XHCI_RESET_PLL_ON_DISCONNECT    BIT_ULL(34)
1889 #define XHCI_SNPS_BROKEN_SUSPEND    BIT_ULL(35)
1890 #define XHCI_RENESAS_FW_QUIRK   BIT_ULL(36)
1891 #define XHCI_SKIP_PHY_INIT      BIT_ULL(37)
1892 #define XHCI_DISABLE_SPARSE     BIT_ULL(38)
1893 #define XHCI_SG_TRB_CACHE_SIZE_QUIRK    BIT_ULL(39)
1894 #define XHCI_NO_SOFT_RETRY      BIT_ULL(40)
1895 #define XHCI_BROKEN_D3COLD      BIT_ULL(41)
1896
1897         unsigned int            num_active_eps;
1898         unsigned int            limit_active_eps;
1899         struct xhci_port        *hw_ports;
1900         struct xhci_hub         usb2_rhub;
1901         struct xhci_hub         usb3_rhub;
1902         /* support xHCI 1.0 spec USB2 hardware LPM */
1903         unsigned                hw_lpm_support:1;
1904         /* Broken Suspend flag for SNPS Suspend resume issue */
1905         unsigned                broken_suspend:1;
1906         /* cached usb2 extened protocol capabilites */
1907         u32                     *ext_caps;
1908         unsigned int            num_ext_caps;
1909         /* cached extended protocol port capabilities */
1910         struct xhci_port_cap    *port_caps;
1911         unsigned int            num_port_caps;
1912         /* Compliance Mode Recovery Data */
1913         struct timer_list       comp_mode_recovery_timer;
1914         u32                     port_status_u0;
1915         u16                     test_mode;
1916 /* Compliance Mode Timer Triggered every 2 seconds */
1917 #define COMP_MODE_RCVRY_MSECS 2000
1918
1919         struct dentry           *debugfs_root;
1920         struct dentry           *debugfs_slots;
1921         struct list_head        regset_list;
1922
1923         void                    *dbc;
1924         /* platform-specific data -- must come last */
1925         unsigned long           priv[] __aligned(sizeof(s64));
1926 };
1927
1928 /* Platform specific overrides to generic XHCI hc_driver ops */
1929 struct xhci_driver_overrides {
1930         size_t extra_priv_size;
1931         int (*reset)(struct usb_hcd *hcd);
1932         int (*start)(struct usb_hcd *hcd);
1933         int (*add_endpoint)(struct usb_hcd *hcd, struct usb_device *udev,
1934                             struct usb_host_endpoint *ep);
1935         int (*drop_endpoint)(struct usb_hcd *hcd, struct usb_device *udev,
1936                              struct usb_host_endpoint *ep);
1937         int (*check_bandwidth)(struct usb_hcd *, struct usb_device *);
1938         void (*reset_bandwidth)(struct usb_hcd *, struct usb_device *);
1939 };
1940
1941 #define XHCI_CFC_DELAY          10
1942
1943 /* convert between an HCD pointer and the corresponding EHCI_HCD */
1944 static inline struct xhci_hcd *hcd_to_xhci(struct usb_hcd *hcd)
1945 {
1946         struct usb_hcd *primary_hcd;
1947
1948         if (usb_hcd_is_primary_hcd(hcd))
1949                 primary_hcd = hcd;
1950         else
1951                 primary_hcd = hcd->primary_hcd;
1952
1953         return (struct xhci_hcd *) (primary_hcd->hcd_priv);
1954 }
1955
1956 static inline struct usb_hcd *xhci_to_hcd(struct xhci_hcd *xhci)
1957 {
1958         return xhci->main_hcd;
1959 }
1960
1961 #define xhci_dbg(xhci, fmt, args...) \
1962         dev_dbg(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1963 #define xhci_err(xhci, fmt, args...) \
1964         dev_err(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1965 #define xhci_warn(xhci, fmt, args...) \
1966         dev_warn(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1967 #define xhci_warn_ratelimited(xhci, fmt, args...) \
1968         dev_warn_ratelimited(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1969 #define xhci_info(xhci, fmt, args...) \
1970         dev_info(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1971
1972 /*
1973  * Registers should always be accessed with double word or quad word accesses.
1974  *
1975  * Some xHCI implementations may support 64-bit address pointers.  Registers
1976  * with 64-bit address pointers should be written to with dword accesses by
1977  * writing the low dword first (ptr[0]), then the high dword (ptr[1]) second.
1978  * xHCI implementations that do not support 64-bit address pointers will ignore
1979  * the high dword, and write order is irrelevant.
1980  */
1981 static inline u64 xhci_read_64(const struct xhci_hcd *xhci,
1982                 __le64 __iomem *regs)
1983 {
1984         return lo_hi_readq(regs);
1985 }
1986 static inline void xhci_write_64(struct xhci_hcd *xhci,
1987                                  const u64 val, __le64 __iomem *regs)
1988 {
1989         lo_hi_writeq(val, regs);
1990 }
1991
1992 static inline int xhci_link_trb_quirk(struct xhci_hcd *xhci)
1993 {
1994         return xhci->quirks & XHCI_LINK_TRB_QUIRK;
1995 }
1996
1997 /* xHCI debugging */
1998 char *xhci_get_slot_state(struct xhci_hcd *xhci,
1999                 struct xhci_container_ctx *ctx);
2000 void xhci_dbg_trace(struct xhci_hcd *xhci, void (*trace)(struct va_format *),
2001                         const char *fmt, ...);
2002
2003 /* xHCI memory management */
2004 void xhci_mem_cleanup(struct xhci_hcd *xhci);
2005 int xhci_mem_init(struct xhci_hcd *xhci, gfp_t flags);
2006 void xhci_free_virt_device(struct xhci_hcd *xhci, int slot_id);
2007 int xhci_alloc_virt_device(struct xhci_hcd *xhci, int slot_id, struct usb_device *udev, gfp_t flags);
2008 int xhci_setup_addressable_virt_dev(struct xhci_hcd *xhci, struct usb_device *udev);
2009 void xhci_copy_ep0_dequeue_into_input_ctx(struct xhci_hcd *xhci,
2010                 struct usb_device *udev);
2011 unsigned int xhci_get_endpoint_index(struct usb_endpoint_descriptor *desc);
2012 unsigned int xhci_get_endpoint_address(unsigned int ep_index);
2013 unsigned int xhci_last_valid_endpoint(u32 added_ctxs);
2014 void xhci_endpoint_zero(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev, struct usb_host_endpoint *ep);
2015 void xhci_update_tt_active_eps(struct xhci_hcd *xhci,
2016                 struct xhci_virt_device *virt_dev,
2017                 int old_active_eps);
2018 void xhci_clear_endpoint_bw_info(struct xhci_bw_info *bw_info);
2019 void xhci_update_bw_info(struct xhci_hcd *xhci,
2020                 struct xhci_container_ctx *in_ctx,
2021                 struct xhci_input_control_ctx *ctrl_ctx,
2022                 struct xhci_virt_device *virt_dev);
2023 void xhci_endpoint_copy(struct xhci_hcd *xhci,
2024                 struct xhci_container_ctx *in_ctx,
2025                 struct xhci_container_ctx *out_ctx,
2026                 unsigned int ep_index);
2027 void xhci_slot_copy(struct xhci_hcd *xhci,
2028                 struct xhci_container_ctx *in_ctx,
2029                 struct xhci_container_ctx *out_ctx);
2030 int xhci_endpoint_init(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev,
2031                 struct usb_device *udev, struct usb_host_endpoint *ep,
2032                 gfp_t mem_flags);
2033 struct xhci_ring *xhci_ring_alloc(struct xhci_hcd *xhci,
2034                 unsigned int num_segs, unsigned int cycle_state,
2035                 enum xhci_ring_type type, unsigned int max_packet, gfp_t flags);
2036 void xhci_ring_free(struct xhci_hcd *xhci, struct xhci_ring *ring);
2037 int xhci_ring_expansion(struct xhci_hcd *xhci, struct xhci_ring *ring,
2038                 unsigned int num_trbs, gfp_t flags);
2039 int xhci_alloc_erst(struct xhci_hcd *xhci,
2040                 struct xhci_ring *evt_ring,
2041                 struct xhci_erst *erst,
2042                 gfp_t flags);
2043 void xhci_initialize_ring_info(struct xhci_ring *ring,
2044                         unsigned int cycle_state);
2045 void xhci_free_erst(struct xhci_hcd *xhci, struct xhci_erst *erst);
2046 void xhci_free_endpoint_ring(struct xhci_hcd *xhci,
2047                 struct xhci_virt_device *virt_dev,
2048                 unsigned int ep_index);
2049 struct xhci_stream_info *xhci_alloc_stream_info(struct xhci_hcd *xhci,
2050                 unsigned int num_stream_ctxs,
2051                 unsigned int num_streams,
2052                 unsigned int max_packet, gfp_t flags);
2053 void xhci_free_stream_info(struct xhci_hcd *xhci,
2054                 struct xhci_stream_info *stream_info);
2055 void xhci_setup_streams_ep_input_ctx(struct xhci_hcd *xhci,
2056                 struct xhci_ep_ctx *ep_ctx,
2057                 struct xhci_stream_info *stream_info);
2058 void xhci_setup_no_streams_ep_input_ctx(struct xhci_ep_ctx *ep_ctx,
2059                 struct xhci_virt_ep *ep);
2060 void xhci_free_device_endpoint_resources(struct xhci_hcd *xhci,
2061         struct xhci_virt_device *virt_dev, bool drop_control_ep);
2062 struct xhci_ring *xhci_dma_to_transfer_ring(
2063                 struct xhci_virt_ep *ep,
2064                 u64 address);
2065 struct xhci_command *xhci_alloc_command(struct xhci_hcd *xhci,
2066                 bool allocate_completion, gfp_t mem_flags);
2067 struct xhci_command *xhci_alloc_command_with_ctx(struct xhci_hcd *xhci,
2068                 bool allocate_completion, gfp_t mem_flags);
2069 void xhci_urb_free_priv(struct urb_priv *urb_priv);
2070 void xhci_free_command(struct xhci_hcd *xhci,
2071                 struct xhci_command *command);
2072 struct xhci_container_ctx *xhci_alloc_container_ctx(struct xhci_hcd *xhci,
2073                 int type, gfp_t flags);
2074 void xhci_free_container_ctx(struct xhci_hcd *xhci,
2075                 struct xhci_container_ctx *ctx);
2076
2077 /* xHCI host controller glue */
2078 typedef void (*xhci_get_quirks_t)(struct device *, struct xhci_hcd *);
2079 int xhci_handshake(void __iomem *ptr, u32 mask, u32 done, int usec);
2080 void xhci_quiesce(struct xhci_hcd *xhci);
2081 int xhci_halt(struct xhci_hcd *xhci);
2082 int xhci_start(struct xhci_hcd *xhci);
2083 int xhci_reset(struct xhci_hcd *xhci);
2084 int xhci_run(struct usb_hcd *hcd);
2085 int xhci_gen_setup(struct usb_hcd *hcd, xhci_get_quirks_t get_quirks);
2086 void xhci_shutdown(struct usb_hcd *hcd);
2087 void xhci_init_driver(struct hc_driver *drv,
2088                       const struct xhci_driver_overrides *over);
2089 int xhci_add_endpoint(struct usb_hcd *hcd, struct usb_device *udev,
2090                       struct usb_host_endpoint *ep);
2091 int xhci_drop_endpoint(struct usb_hcd *hcd, struct usb_device *udev,
2092                        struct usb_host_endpoint *ep);
2093 int xhci_check_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
2094 void xhci_reset_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
2095 int xhci_disable_slot(struct xhci_hcd *xhci, u32 slot_id);
2096 int xhci_ext_cap_init(struct xhci_hcd *xhci);
2097
2098 int xhci_suspend(struct xhci_hcd *xhci, bool do_wakeup);
2099 int xhci_resume(struct xhci_hcd *xhci, bool hibernated);
2100
2101 irqreturn_t xhci_irq(struct usb_hcd *hcd);
2102 irqreturn_t xhci_msi_irq(int irq, void *hcd);
2103 int xhci_alloc_dev(struct usb_hcd *hcd, struct usb_device *udev);
2104 int xhci_alloc_tt_info(struct xhci_hcd *xhci,
2105                 struct xhci_virt_device *virt_dev,
2106                 struct usb_device *hdev,
2107                 struct usb_tt *tt, gfp_t mem_flags);
2108
2109 /* xHCI ring, segment, TRB, and TD functions */
2110 dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg, union xhci_trb *trb);
2111 struct xhci_segment *trb_in_td(struct xhci_hcd *xhci,
2112                 struct xhci_segment *start_seg, union xhci_trb *start_trb,
2113                 union xhci_trb *end_trb, dma_addr_t suspect_dma, bool debug);
2114 int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code);
2115 void xhci_ring_cmd_db(struct xhci_hcd *xhci);
2116 int xhci_queue_slot_control(struct xhci_hcd *xhci, struct xhci_command *cmd,
2117                 u32 trb_type, u32 slot_id);
2118 int xhci_queue_address_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
2119                 dma_addr_t in_ctx_ptr, u32 slot_id, enum xhci_setup_dev);
2120 int xhci_queue_vendor_command(struct xhci_hcd *xhci, struct xhci_command *cmd,
2121                 u32 field1, u32 field2, u32 field3, u32 field4);
2122 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, struct xhci_command *cmd,
2123                 int slot_id, unsigned int ep_index, int suspend);
2124 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
2125                 int slot_id, unsigned int ep_index);
2126 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
2127                 int slot_id, unsigned int ep_index);
2128 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
2129                 int slot_id, unsigned int ep_index);
2130 int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
2131                 struct urb *urb, int slot_id, unsigned int ep_index);
2132 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci,
2133                 struct xhci_command *cmd, dma_addr_t in_ctx_ptr, u32 slot_id,
2134                 bool command_must_succeed);
2135 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, struct xhci_command *cmd,
2136                 dma_addr_t in_ctx_ptr, u32 slot_id, bool command_must_succeed);
2137 int xhci_queue_reset_ep(struct xhci_hcd *xhci, struct xhci_command *cmd,
2138                 int slot_id, unsigned int ep_index,
2139                 enum xhci_ep_reset_type reset_type);
2140 int xhci_queue_reset_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
2141                 u32 slot_id);
2142 void xhci_cleanup_stalled_ring(struct xhci_hcd *xhci, unsigned int slot_id,
2143                                unsigned int ep_index, unsigned int stream_id,
2144                                struct xhci_td *td);
2145 void xhci_stop_endpoint_command_watchdog(struct timer_list *t);
2146 void xhci_handle_command_timeout(struct work_struct *work);
2147
2148 void xhci_ring_ep_doorbell(struct xhci_hcd *xhci, unsigned int slot_id,
2149                 unsigned int ep_index, unsigned int stream_id);
2150 void xhci_ring_doorbell_for_active_rings(struct xhci_hcd *xhci,
2151                 unsigned int slot_id,
2152                 unsigned int ep_index);
2153 void xhci_cleanup_command_queue(struct xhci_hcd *xhci);
2154 void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring);
2155 unsigned int count_trbs(u64 addr, u64 len);
2156
2157 /* xHCI roothub code */
2158 void xhci_set_link_state(struct xhci_hcd *xhci, struct xhci_port *port,
2159                                 u32 link_state);
2160 void xhci_test_and_clear_bit(struct xhci_hcd *xhci, struct xhci_port *port,
2161                                 u32 port_bit);
2162 int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue, u16 wIndex,
2163                 char *buf, u16 wLength);
2164 int xhci_hub_status_data(struct usb_hcd *hcd, char *buf);
2165 int xhci_find_raw_port_number(struct usb_hcd *hcd, int port1);
2166 struct xhci_hub *xhci_get_rhub(struct usb_hcd *hcd);
2167
2168 void xhci_hc_died(struct xhci_hcd *xhci);
2169
2170 #ifdef CONFIG_PM
2171 int xhci_bus_suspend(struct usb_hcd *hcd);
2172 int xhci_bus_resume(struct usb_hcd *hcd);
2173 unsigned long xhci_get_resuming_ports(struct usb_hcd *hcd);
2174 #else
2175 #define xhci_bus_suspend        NULL
2176 #define xhci_bus_resume         NULL
2177 #define xhci_get_resuming_ports NULL
2178 #endif  /* CONFIG_PM */
2179
2180 u32 xhci_port_state_to_neutral(u32 state);
2181 int xhci_find_slot_id_by_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
2182                 u16 port);
2183 void xhci_ring_device(struct xhci_hcd *xhci, int slot_id);
2184
2185 /* xHCI contexts */
2186 struct xhci_input_control_ctx *xhci_get_input_control_ctx(struct xhci_container_ctx *ctx);
2187 struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx);
2188 struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned int ep_index);
2189
2190 struct xhci_ring *xhci_triad_to_transfer_ring(struct xhci_hcd *xhci,
2191                 unsigned int slot_id, unsigned int ep_index,
2192                 unsigned int stream_id);
2193
2194 static inline struct xhci_ring *xhci_urb_to_transfer_ring(struct xhci_hcd *xhci,
2195                                                                 struct urb *urb)
2196 {
2197         return xhci_triad_to_transfer_ring(xhci, urb->dev->slot_id,
2198                                         xhci_get_endpoint_index(&urb->ep->desc),
2199                                         urb->stream_id);
2200 }
2201
2202 /*
2203  * TODO: As per spec Isochronous IDT transmissions are supported. We bypass
2204  * them anyways as we where unable to find a device that matches the
2205  * constraints.
2206  */
2207 static inline bool xhci_urb_suitable_for_idt(struct urb *urb)
2208 {
2209         if (!usb_endpoint_xfer_isoc(&urb->ep->desc) && usb_urb_dir_out(urb) &&
2210             usb_endpoint_maxp(&urb->ep->desc) >= TRB_IDT_MAX_SIZE &&
2211             urb->transfer_buffer_length <= TRB_IDT_MAX_SIZE &&
2212             !(urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP) &&
2213             !urb->num_sgs)
2214                 return true;
2215
2216         return false;
2217 }
2218
2219 static inline char *xhci_slot_state_string(u32 state)
2220 {
2221         switch (state) {
2222         case SLOT_STATE_ENABLED:
2223                 return "enabled/disabled";
2224         case SLOT_STATE_DEFAULT:
2225                 return "default";
2226         case SLOT_STATE_ADDRESSED:
2227                 return "addressed";
2228         case SLOT_STATE_CONFIGURED:
2229                 return "configured";
2230         default:
2231                 return "reserved";
2232         }
2233 }
2234
2235 static inline const char *xhci_decode_trb(u32 field0, u32 field1, u32 field2,
2236                 u32 field3)
2237 {
2238         static char str[256];
2239         int type = TRB_FIELD_TO_TYPE(field3);
2240
2241         switch (type) {
2242         case TRB_LINK:
2243                 sprintf(str,
2244                         "LINK %08x%08x intr %d type '%s' flags %c:%c:%c:%c",
2245                         field1, field0, GET_INTR_TARGET(field2),
2246                         xhci_trb_type_string(type),
2247                         field3 & TRB_IOC ? 'I' : 'i',
2248                         field3 & TRB_CHAIN ? 'C' : 'c',
2249                         field3 & TRB_TC ? 'T' : 't',
2250                         field3 & TRB_CYCLE ? 'C' : 'c');
2251                 break;
2252         case TRB_TRANSFER:
2253         case TRB_COMPLETION:
2254         case TRB_PORT_STATUS:
2255         case TRB_BANDWIDTH_EVENT:
2256         case TRB_DOORBELL:
2257         case TRB_HC_EVENT:
2258         case TRB_DEV_NOTE:
2259         case TRB_MFINDEX_WRAP:
2260                 sprintf(str,
2261                         "TRB %08x%08x status '%s' len %d slot %d ep %d type '%s' flags %c:%c",
2262                         field1, field0,
2263                         xhci_trb_comp_code_string(GET_COMP_CODE(field2)),
2264                         EVENT_TRB_LEN(field2), TRB_TO_SLOT_ID(field3),
2265                         /* Macro decrements 1, maybe it shouldn't?!? */
2266                         TRB_TO_EP_INDEX(field3) + 1,
2267                         xhci_trb_type_string(type),
2268                         field3 & EVENT_DATA ? 'E' : 'e',
2269                         field3 & TRB_CYCLE ? 'C' : 'c');
2270
2271                 break;
2272         case TRB_SETUP:
2273                 sprintf(str, "bRequestType %02x bRequest %02x wValue %02x%02x wIndex %02x%02x wLength %d length %d TD size %d intr %d type '%s' flags %c:%c:%c",
2274                                 field0 & 0xff,
2275                                 (field0 & 0xff00) >> 8,
2276                                 (field0 & 0xff000000) >> 24,
2277                                 (field0 & 0xff0000) >> 16,
2278                                 (field1 & 0xff00) >> 8,
2279                                 field1 & 0xff,
2280                                 (field1 & 0xff000000) >> 16 |
2281                                 (field1 & 0xff0000) >> 16,
2282                                 TRB_LEN(field2), GET_TD_SIZE(field2),
2283                                 GET_INTR_TARGET(field2),
2284                                 xhci_trb_type_string(type),
2285                                 field3 & TRB_IDT ? 'I' : 'i',
2286                                 field3 & TRB_IOC ? 'I' : 'i',
2287                                 field3 & TRB_CYCLE ? 'C' : 'c');
2288                 break;
2289         case TRB_DATA:
2290                 sprintf(str, "Buffer %08x%08x length %d TD size %d intr %d type '%s' flags %c:%c:%c:%c:%c:%c:%c",
2291                                 field1, field0, TRB_LEN(field2), GET_TD_SIZE(field2),
2292                                 GET_INTR_TARGET(field2),
2293                                 xhci_trb_type_string(type),
2294                                 field3 & TRB_IDT ? 'I' : 'i',
2295                                 field3 & TRB_IOC ? 'I' : 'i',
2296                                 field3 & TRB_CHAIN ? 'C' : 'c',
2297                                 field3 & TRB_NO_SNOOP ? 'S' : 's',
2298                                 field3 & TRB_ISP ? 'I' : 'i',
2299                                 field3 & TRB_ENT ? 'E' : 'e',
2300                                 field3 & TRB_CYCLE ? 'C' : 'c');
2301                 break;
2302         case TRB_STATUS:
2303                 sprintf(str, "Buffer %08x%08x length %d TD size %d intr %d type '%s' flags %c:%c:%c:%c",
2304                                 field1, field0, TRB_LEN(field2), GET_TD_SIZE(field2),
2305                                 GET_INTR_TARGET(field2),
2306                                 xhci_trb_type_string(type),
2307                                 field3 & TRB_IOC ? 'I' : 'i',
2308                                 field3 & TRB_CHAIN ? 'C' : 'c',
2309                                 field3 & TRB_ENT ? 'E' : 'e',
2310                                 field3 & TRB_CYCLE ? 'C' : 'c');
2311                 break;
2312         case TRB_NORMAL:
2313         case TRB_ISOC:
2314         case TRB_EVENT_DATA:
2315         case TRB_TR_NOOP:
2316                 sprintf(str,
2317                         "Buffer %08x%08x length %d TD size %d intr %d type '%s' flags %c:%c:%c:%c:%c:%c:%c:%c",
2318                         field1, field0, TRB_LEN(field2), GET_TD_SIZE(field2),
2319                         GET_INTR_TARGET(field2),
2320                         xhci_trb_type_string(type),
2321                         field3 & TRB_BEI ? 'B' : 'b',
2322                         field3 & TRB_IDT ? 'I' : 'i',
2323                         field3 & TRB_IOC ? 'I' : 'i',
2324                         field3 & TRB_CHAIN ? 'C' : 'c',
2325                         field3 & TRB_NO_SNOOP ? 'S' : 's',
2326                         field3 & TRB_ISP ? 'I' : 'i',
2327                         field3 & TRB_ENT ? 'E' : 'e',
2328                         field3 & TRB_CYCLE ? 'C' : 'c');
2329                 break;
2330
2331         case TRB_CMD_NOOP:
2332         case TRB_ENABLE_SLOT:
2333                 sprintf(str,
2334                         "%s: flags %c",
2335                         xhci_trb_type_string(type),
2336                         field3 & TRB_CYCLE ? 'C' : 'c');
2337                 break;
2338         case TRB_DISABLE_SLOT:
2339         case TRB_NEG_BANDWIDTH:
2340                 sprintf(str,
2341                         "%s: slot %d flags %c",
2342                         xhci_trb_type_string(type),
2343                         TRB_TO_SLOT_ID(field3),
2344                         field3 & TRB_CYCLE ? 'C' : 'c');
2345                 break;
2346         case TRB_ADDR_DEV:
2347                 sprintf(str,
2348                         "%s: ctx %08x%08x slot %d flags %c:%c",
2349                         xhci_trb_type_string(type),
2350                         field1, field0,
2351                         TRB_TO_SLOT_ID(field3),
2352                         field3 & TRB_BSR ? 'B' : 'b',
2353                         field3 & TRB_CYCLE ? 'C' : 'c');
2354                 break;
2355         case TRB_CONFIG_EP:
2356                 sprintf(str,
2357                         "%s: ctx %08x%08x slot %d flags %c:%c",
2358                         xhci_trb_type_string(type),
2359                         field1, field0,
2360                         TRB_TO_SLOT_ID(field3),
2361                         field3 & TRB_DC ? 'D' : 'd',
2362                         field3 & TRB_CYCLE ? 'C' : 'c');
2363                 break;
2364         case TRB_EVAL_CONTEXT:
2365                 sprintf(str,
2366                         "%s: ctx %08x%08x slot %d flags %c",
2367                         xhci_trb_type_string(type),
2368                         field1, field0,
2369                         TRB_TO_SLOT_ID(field3),
2370                         field3 & TRB_CYCLE ? 'C' : 'c');
2371                 break;
2372         case TRB_RESET_EP:
2373                 sprintf(str,
2374                         "%s: ctx %08x%08x slot %d ep %d flags %c:%c",
2375                         xhci_trb_type_string(type),
2376                         field1, field0,
2377                         TRB_TO_SLOT_ID(field3),
2378                         /* Macro decrements 1, maybe it shouldn't?!? */
2379                         TRB_TO_EP_INDEX(field3) + 1,
2380                         field3 & TRB_TSP ? 'T' : 't',
2381                         field3 & TRB_CYCLE ? 'C' : 'c');
2382                 break;
2383         case TRB_STOP_RING:
2384                 sprintf(str,
2385                         "%s: slot %d sp %d ep %d flags %c",
2386                         xhci_trb_type_string(type),
2387                         TRB_TO_SLOT_ID(field3),
2388                         TRB_TO_SUSPEND_PORT(field3),
2389                         /* Macro decrements 1, maybe it shouldn't?!? */
2390                         TRB_TO_EP_INDEX(field3) + 1,
2391                         field3 & TRB_CYCLE ? 'C' : 'c');
2392                 break;
2393         case TRB_SET_DEQ:
2394                 sprintf(str,
2395                         "%s: deq %08x%08x stream %d slot %d ep %d flags %c",
2396                         xhci_trb_type_string(type),
2397                         field1, field0,
2398                         TRB_TO_STREAM_ID(field2),
2399                         TRB_TO_SLOT_ID(field3),
2400                         /* Macro decrements 1, maybe it shouldn't?!? */
2401                         TRB_TO_EP_INDEX(field3) + 1,
2402                         field3 & TRB_CYCLE ? 'C' : 'c');
2403                 break;
2404         case TRB_RESET_DEV:
2405                 sprintf(str,
2406                         "%s: slot %d flags %c",
2407                         xhci_trb_type_string(type),
2408                         TRB_TO_SLOT_ID(field3),
2409                         field3 & TRB_CYCLE ? 'C' : 'c');
2410                 break;
2411         case TRB_FORCE_EVENT:
2412                 sprintf(str,
2413                         "%s: event %08x%08x vf intr %d vf id %d flags %c",
2414                         xhci_trb_type_string(type),
2415                         field1, field0,
2416                         TRB_TO_VF_INTR_TARGET(field2),
2417                         TRB_TO_VF_ID(field3),
2418                         field3 & TRB_CYCLE ? 'C' : 'c');
2419                 break;
2420         case TRB_SET_LT:
2421                 sprintf(str,
2422                         "%s: belt %d flags %c",
2423                         xhci_trb_type_string(type),
2424                         TRB_TO_BELT(field3),
2425                         field3 & TRB_CYCLE ? 'C' : 'c');
2426                 break;
2427         case TRB_GET_BW:
2428                 sprintf(str,
2429                         "%s: ctx %08x%08x slot %d speed %d flags %c",
2430                         xhci_trb_type_string(type),
2431                         field1, field0,
2432                         TRB_TO_SLOT_ID(field3),
2433                         TRB_TO_DEV_SPEED(field3),
2434                         field3 & TRB_CYCLE ? 'C' : 'c');
2435                 break;
2436         case TRB_FORCE_HEADER:
2437                 sprintf(str,
2438                         "%s: info %08x%08x%08x pkt type %d roothub port %d flags %c",
2439                         xhci_trb_type_string(type),
2440                         field2, field1, field0 & 0xffffffe0,
2441                         TRB_TO_PACKET_TYPE(field0),
2442                         TRB_TO_ROOTHUB_PORT(field3),
2443                         field3 & TRB_CYCLE ? 'C' : 'c');
2444                 break;
2445         default:
2446                 sprintf(str,
2447                         "type '%s' -> raw %08x %08x %08x %08x",
2448                         xhci_trb_type_string(type),
2449                         field0, field1, field2, field3);
2450         }
2451
2452         return str;
2453 }
2454
2455 static inline const char *xhci_decode_ctrl_ctx(unsigned long drop,
2456                                                unsigned long add)
2457 {
2458         static char     str[1024];
2459         unsigned int    bit;
2460         int             ret = 0;
2461
2462         if (drop) {
2463                 ret = sprintf(str, "Drop:");
2464                 for_each_set_bit(bit, &drop, 32)
2465                         ret += sprintf(str + ret, " %d%s",
2466                                        bit / 2,
2467                                        bit % 2 ? "in":"out");
2468                 ret += sprintf(str + ret, ", ");
2469         }
2470
2471         if (add) {
2472                 ret += sprintf(str + ret, "Add:%s%s",
2473                                (add & SLOT_FLAG) ? " slot":"",
2474                                (add & EP0_FLAG) ? " ep0":"");
2475                 add &= ~(SLOT_FLAG | EP0_FLAG);
2476                 for_each_set_bit(bit, &add, 32)
2477                         ret += sprintf(str + ret, " %d%s",
2478                                        bit / 2,
2479                                        bit % 2 ? "in":"out");
2480         }
2481         return str;
2482 }
2483
2484 static inline const char *xhci_decode_slot_context(u32 info, u32 info2,
2485                 u32 tt_info, u32 state)
2486 {
2487         static char str[1024];
2488         u32 speed;
2489         u32 hub;
2490         u32 mtt;
2491         int ret = 0;
2492
2493         speed = info & DEV_SPEED;
2494         hub = info & DEV_HUB;
2495         mtt = info & DEV_MTT;
2496
2497         ret = sprintf(str, "RS %05x %s%s%s Ctx Entries %d MEL %d us Port# %d/%d",
2498                         info & ROUTE_STRING_MASK,
2499                         ({ char *s;
2500                         switch (speed) {
2501                         case SLOT_SPEED_FS:
2502                                 s = "full-speed";
2503                                 break;
2504                         case SLOT_SPEED_LS:
2505                                 s = "low-speed";
2506                                 break;
2507                         case SLOT_SPEED_HS:
2508                                 s = "high-speed";
2509                                 break;
2510                         case SLOT_SPEED_SS:
2511                                 s = "super-speed";
2512                                 break;
2513                         case SLOT_SPEED_SSP:
2514                                 s = "super-speed plus";
2515                                 break;
2516                         default:
2517                                 s = "UNKNOWN speed";
2518                         } s; }),
2519                         mtt ? " multi-TT" : "",
2520                         hub ? " Hub" : "",
2521                         (info & LAST_CTX_MASK) >> 27,
2522                         info2 & MAX_EXIT,
2523                         DEVINFO_TO_ROOT_HUB_PORT(info2),
2524                         DEVINFO_TO_MAX_PORTS(info2));
2525
2526         ret += sprintf(str + ret, " [TT Slot %d Port# %d TTT %d Intr %d] Addr %d State %s",
2527                         tt_info & TT_SLOT, (tt_info & TT_PORT) >> 8,
2528                         GET_TT_THINK_TIME(tt_info), GET_INTR_TARGET(tt_info),
2529                         state & DEV_ADDR_MASK,
2530                         xhci_slot_state_string(GET_SLOT_STATE(state)));
2531
2532         return str;
2533 }
2534
2535
2536 static inline const char *xhci_portsc_link_state_string(u32 portsc)
2537 {
2538         switch (portsc & PORT_PLS_MASK) {
2539         case XDEV_U0:
2540                 return "U0";
2541         case XDEV_U1:
2542                 return "U1";
2543         case XDEV_U2:
2544                 return "U2";
2545         case XDEV_U3:
2546                 return "U3";
2547         case XDEV_DISABLED:
2548                 return "Disabled";
2549         case XDEV_RXDETECT:
2550                 return "RxDetect";
2551         case XDEV_INACTIVE:
2552                 return "Inactive";
2553         case XDEV_POLLING:
2554                 return "Polling";
2555         case XDEV_RECOVERY:
2556                 return "Recovery";
2557         case XDEV_HOT_RESET:
2558                 return "Hot Reset";
2559         case XDEV_COMP_MODE:
2560                 return "Compliance mode";
2561         case XDEV_TEST_MODE:
2562                 return "Test mode";
2563         case XDEV_RESUME:
2564                 return "Resume";
2565         default:
2566                 break;
2567         }
2568         return "Unknown";
2569 }
2570
2571 static inline const char *xhci_decode_portsc(u32 portsc)
2572 {
2573         static char str[256];
2574         int ret;
2575
2576         ret = sprintf(str, "%s %s %s Link:%s PortSpeed:%d ",
2577                       portsc & PORT_POWER       ? "Powered" : "Powered-off",
2578                       portsc & PORT_CONNECT     ? "Connected" : "Not-connected",
2579                       portsc & PORT_PE          ? "Enabled" : "Disabled",
2580                       xhci_portsc_link_state_string(portsc),
2581                       DEV_PORT_SPEED(portsc));
2582
2583         if (portsc & PORT_OC)
2584                 ret += sprintf(str + ret, "OverCurrent ");
2585         if (portsc & PORT_RESET)
2586                 ret += sprintf(str + ret, "In-Reset ");
2587
2588         ret += sprintf(str + ret, "Change: ");
2589         if (portsc & PORT_CSC)
2590                 ret += sprintf(str + ret, "CSC ");
2591         if (portsc & PORT_PEC)
2592                 ret += sprintf(str + ret, "PEC ");
2593         if (portsc & PORT_WRC)
2594                 ret += sprintf(str + ret, "WRC ");
2595         if (portsc & PORT_OCC)
2596                 ret += sprintf(str + ret, "OCC ");
2597         if (portsc & PORT_RC)
2598                 ret += sprintf(str + ret, "PRC ");
2599         if (portsc & PORT_PLC)
2600                 ret += sprintf(str + ret, "PLC ");
2601         if (portsc & PORT_CEC)
2602                 ret += sprintf(str + ret, "CEC ");
2603         if (portsc & PORT_CAS)
2604                 ret += sprintf(str + ret, "CAS ");
2605
2606         ret += sprintf(str + ret, "Wake: ");
2607         if (portsc & PORT_WKCONN_E)
2608                 ret += sprintf(str + ret, "WCE ");
2609         if (portsc & PORT_WKDISC_E)
2610                 ret += sprintf(str + ret, "WDE ");
2611         if (portsc & PORT_WKOC_E)
2612                 ret += sprintf(str + ret, "WOE ");
2613
2614         return str;
2615 }
2616
2617 static inline const char *xhci_decode_usbsts(u32 usbsts)
2618 {
2619         static char str[256];
2620         int ret = 0;
2621
2622         if (usbsts == ~(u32)0)
2623                 return " 0xffffffff";
2624         if (usbsts & STS_HALT)
2625                 ret += sprintf(str + ret, " HCHalted");
2626         if (usbsts & STS_FATAL)
2627                 ret += sprintf(str + ret, " HSE");
2628         if (usbsts & STS_EINT)
2629                 ret += sprintf(str + ret, " EINT");
2630         if (usbsts & STS_PORT)
2631                 ret += sprintf(str + ret, " PCD");
2632         if (usbsts & STS_SAVE)
2633                 ret += sprintf(str + ret, " SSS");
2634         if (usbsts & STS_RESTORE)
2635                 ret += sprintf(str + ret, " RSS");
2636         if (usbsts & STS_SRE)
2637                 ret += sprintf(str + ret, " SRE");
2638         if (usbsts & STS_CNR)
2639                 ret += sprintf(str + ret, " CNR");
2640         if (usbsts & STS_HCE)
2641                 ret += sprintf(str + ret, " HCE");
2642
2643         return str;
2644 }
2645
2646 static inline const char *xhci_decode_doorbell(u32 slot, u32 doorbell)
2647 {
2648         static char str[256];
2649         u8 ep;
2650         u16 stream;
2651         int ret;
2652
2653         ep = (doorbell & 0xff);
2654         stream = doorbell >> 16;
2655
2656         if (slot == 0) {
2657                 sprintf(str, "Command Ring %d", doorbell);
2658                 return str;
2659         }
2660         ret = sprintf(str, "Slot %d ", slot);
2661         if (ep > 0 && ep < 32)
2662                 ret = sprintf(str + ret, "ep%d%s",
2663                               ep / 2,
2664                               ep % 2 ? "in" : "out");
2665         else if (ep == 0 || ep < 248)
2666                 ret = sprintf(str + ret, "Reserved %d", ep);
2667         else
2668                 ret = sprintf(str + ret, "Vendor Defined %d", ep);
2669         if (stream)
2670                 ret = sprintf(str + ret, " Stream %d", stream);
2671
2672         return str;
2673 }
2674
2675 static inline const char *xhci_ep_state_string(u8 state)
2676 {
2677         switch (state) {
2678         case EP_STATE_DISABLED:
2679                 return "disabled";
2680         case EP_STATE_RUNNING:
2681                 return "running";
2682         case EP_STATE_HALTED:
2683                 return "halted";
2684         case EP_STATE_STOPPED:
2685                 return "stopped";
2686         case EP_STATE_ERROR:
2687                 return "error";
2688         default:
2689                 return "INVALID";
2690         }
2691 }
2692
2693 static inline const char *xhci_ep_type_string(u8 type)
2694 {
2695         switch (type) {
2696         case ISOC_OUT_EP:
2697                 return "Isoc OUT";
2698         case BULK_OUT_EP:
2699                 return "Bulk OUT";
2700         case INT_OUT_EP:
2701                 return "Int OUT";
2702         case CTRL_EP:
2703                 return "Ctrl";
2704         case ISOC_IN_EP:
2705                 return "Isoc IN";
2706         case BULK_IN_EP:
2707                 return "Bulk IN";
2708         case INT_IN_EP:
2709                 return "Int IN";
2710         default:
2711                 return "INVALID";
2712         }
2713 }
2714
2715 static inline const char *xhci_decode_ep_context(u32 info, u32 info2, u64 deq,
2716                 u32 tx_info)
2717 {
2718         static char str[1024];
2719         int ret;
2720
2721         u32 esit;
2722         u16 maxp;
2723         u16 avg;
2724
2725         u8 max_pstr;
2726         u8 ep_state;
2727         u8 interval;
2728         u8 ep_type;
2729         u8 burst;
2730         u8 cerr;
2731         u8 mult;
2732
2733         bool lsa;
2734         bool hid;
2735
2736         esit = CTX_TO_MAX_ESIT_PAYLOAD_HI(info) << 16 |
2737                 CTX_TO_MAX_ESIT_PAYLOAD(tx_info);
2738
2739         ep_state = info & EP_STATE_MASK;
2740         max_pstr = CTX_TO_EP_MAXPSTREAMS(info);
2741         interval = CTX_TO_EP_INTERVAL(info);
2742         mult = CTX_TO_EP_MULT(info) + 1;
2743         lsa = !!(info & EP_HAS_LSA);
2744
2745         cerr = (info2 & (3 << 1)) >> 1;
2746         ep_type = CTX_TO_EP_TYPE(info2);
2747         hid = !!(info2 & (1 << 7));
2748         burst = CTX_TO_MAX_BURST(info2);
2749         maxp = MAX_PACKET_DECODED(info2);
2750
2751         avg = EP_AVG_TRB_LENGTH(tx_info);
2752
2753         ret = sprintf(str, "State %s mult %d max P. Streams %d %s",
2754                         xhci_ep_state_string(ep_state), mult,
2755                         max_pstr, lsa ? "LSA " : "");
2756
2757         ret += sprintf(str + ret, "interval %d us max ESIT payload %d CErr %d ",
2758                         (1 << interval) * 125, esit, cerr);
2759
2760         ret += sprintf(str + ret, "Type %s %sburst %d maxp %d deq %016llx ",
2761                         xhci_ep_type_string(ep_type), hid ? "HID" : "",
2762                         burst, maxp, deq);
2763
2764         ret += sprintf(str + ret, "avg trb len %d", avg);
2765
2766         return str;
2767 }
2768
2769 #endif /* __LINUX_XHCI_HCD_H */