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