2 * xHCI host controller driver
4 * Copyright (C) 2008 Intel Corp.
7 * Some code borrowed from the Linux EHCI driver.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #ifndef __LINUX_XHCI_HCD_H
24 #define __LINUX_XHCI_HCD_H
26 #include <linux/usb.h>
27 #include <linux/timer.h>
28 #include <linux/kernel.h>
29 #include <linux/usb/hcd.h>
31 /* Code sharing between pci-quirks and xhci hcd */
32 #include "xhci-ext-caps.h"
34 /* xHCI PCI Configuration Registers */
35 #define XHCI_SBRN_OFFSET (0x60)
37 /* Max number of USB devices for any host controller - limit in section 6.1 */
38 #define MAX_HC_SLOTS 256
39 /* Section 5.3.3 - MaxPorts */
40 #define MAX_HC_PORTS 127
43 * xHCI register interface.
44 * This corresponds to the eXtensible Host Controller Interface (xHCI)
45 * Revision 0.95 specification
49 * struct xhci_cap_regs - xHCI Host Controller Capability Registers.
50 * @hc_capbase: length of the capabilities register and HC version number
51 * @hcs_params1: HCSPARAMS1 - Structural Parameters 1
52 * @hcs_params2: HCSPARAMS2 - Structural Parameters 2
53 * @hcs_params3: HCSPARAMS3 - Structural Parameters 3
54 * @hcc_params: HCCPARAMS - Capability Parameters
55 * @db_off: DBOFF - Doorbell array offset
56 * @run_regs_off: RTSOFF - Runtime register space offset
58 struct xhci_cap_regs {
66 /* Reserved up to (CAPLENGTH - 0x1C) */
69 /* hc_capbase bitmasks */
70 /* bits 7:0 - how long is the Capabilities register */
71 #define HC_LENGTH(p) XHCI_HC_LENGTH(p)
73 #define HC_VERSION(p) (((p) >> 16) & 0xffff)
75 /* HCSPARAMS1 - hcs_params1 - bitmasks */
76 /* bits 0:7, Max Device Slots */
77 #define HCS_MAX_SLOTS(p) (((p) >> 0) & 0xff)
78 #define HCS_SLOTS_MASK 0xff
79 /* bits 8:18, Max Interrupters */
80 #define HCS_MAX_INTRS(p) (((p) >> 8) & 0x7ff)
81 /* bits 24:31, Max Ports - max value is 0x7F = 127 ports */
82 #define HCS_MAX_PORTS(p) (((p) >> 24) & 0x7f)
84 /* HCSPARAMS2 - hcs_params2 - bitmasks */
85 /* bits 0:3, frames or uframes that SW needs to queue transactions
86 * ahead of the HW to meet periodic deadlines */
87 #define HCS_IST(p) (((p) >> 0) & 0xf)
88 /* bits 4:7, max number of Event Ring segments */
89 #define HCS_ERST_MAX(p) (((p) >> 4) & 0xf)
90 /* bit 26 Scratchpad restore - for save/restore HW state - not used yet */
91 /* bits 27:31 number of Scratchpad buffers SW must allocate for the HW */
92 #define HCS_MAX_SCRATCHPAD(p) (((p) >> 27) & 0x1f)
94 /* HCSPARAMS3 - hcs_params3 - bitmasks */
95 /* bits 0:7, Max U1 to U0 latency for the roothub ports */
96 #define HCS_U1_LATENCY(p) (((p) >> 0) & 0xff)
97 /* bits 16:31, Max U2 to U0 latency for the roothub ports */
98 #define HCS_U2_LATENCY(p) (((p) >> 16) & 0xffff)
100 /* HCCPARAMS - hcc_params - bitmasks */
101 /* true: HC can use 64-bit address pointers */
102 #define HCC_64BIT_ADDR(p) ((p) & (1 << 0))
103 /* true: HC can do bandwidth negotiation */
104 #define HCC_BANDWIDTH_NEG(p) ((p) & (1 << 1))
105 /* true: HC uses 64-byte Device Context structures
106 * FIXME 64-byte context structures aren't supported yet.
108 #define HCC_64BYTE_CONTEXT(p) ((p) & (1 << 2))
109 /* true: HC has port power switches */
110 #define HCC_PPC(p) ((p) & (1 << 3))
111 /* true: HC has port indicators */
112 #define HCS_INDICATOR(p) ((p) & (1 << 4))
113 /* true: HC has Light HC Reset Capability */
114 #define HCC_LIGHT_RESET(p) ((p) & (1 << 5))
115 /* true: HC supports latency tolerance messaging */
116 #define HCC_LTC(p) ((p) & (1 << 6))
117 /* true: no secondary Stream ID Support */
118 #define HCC_NSS(p) ((p) & (1 << 7))
119 /* Max size for Primary Stream Arrays - 2^(n+1), where n is bits 12:15 */
120 #define HCC_MAX_PSA(p) (1 << ((((p) >> 12) & 0xf) + 1))
121 /* Extended Capabilities pointer from PCI base - section 5.3.6 */
122 #define HCC_EXT_CAPS(p) XHCI_HCC_EXT_CAPS(p)
124 /* db_off bitmask - bits 0:1 reserved */
125 #define DBOFF_MASK (~0x3)
127 /* run_regs_off bitmask - bits 0:4 reserved */
128 #define RTSOFF_MASK (~0x1f)
131 /* Number of registers per port */
132 #define NUM_PORT_REGS 4
135 * struct xhci_op_regs - xHCI Host Controller Operational Registers.
136 * @command: USBCMD - xHC command register
137 * @status: USBSTS - xHC status register
138 * @page_size: This indicates the page size that the host controller
139 * supports. If bit n is set, the HC supports a page size
140 * of 2^(n+12), up to a 128MB page size.
141 * 4K is the minimum page size.
142 * @cmd_ring: CRP - 64-bit Command Ring Pointer
143 * @dcbaa_ptr: DCBAAP - 64-bit Device Context Base Address Array Pointer
144 * @config_reg: CONFIG - Configure Register
145 * @port_status_base: PORTSCn - base address for Port Status and Control
146 * Each port has a Port Status and Control register,
147 * followed by a Port Power Management Status and Control
148 * register, a Port Link Info register, and a reserved
150 * @port_power_base: PORTPMSCn - base address for
151 * Port Power Management Status and Control
152 * @port_link_base: PORTLIn - base address for Port Link Info (current
153 * Link PM state and control) for USB 2.1 and USB 3.0
156 struct xhci_op_regs {
162 u32 dev_notification;
164 /* rsvd: offset 0x20-2F */
168 /* rsvd: offset 0x3C-3FF */
170 /* port 1 registers, which serve as a base address for other ports */
171 u32 port_status_base;
175 /* registers for ports 2-255 */
176 u32 reserved6[NUM_PORT_REGS*254];
179 /* USBCMD - USB command - command bitmasks */
180 /* start/stop HC execution - do not write unless HC is halted*/
181 #define CMD_RUN XHCI_CMD_RUN
182 /* Reset HC - resets internal HC state machine and all registers (except
183 * PCI config regs). HC does NOT drive a USB reset on the downstream ports.
184 * The xHCI driver must reinitialize the xHC after setting this bit.
186 #define CMD_RESET (1 << 1)
187 /* Event Interrupt Enable - a '1' allows interrupts from the host controller */
188 #define CMD_EIE XHCI_CMD_EIE
189 /* Host System Error Interrupt Enable - get out-of-band signal for HC errors */
190 #define CMD_HSEIE XHCI_CMD_HSEIE
191 /* bits 4:6 are reserved (and should be preserved on writes). */
192 /* light reset (port status stays unchanged) - reset completed when this is 0 */
193 #define CMD_LRESET (1 << 7)
194 /* host controller save/restore state. */
195 #define CMD_CSS (1 << 8)
196 #define CMD_CRS (1 << 9)
197 /* Enable Wrap Event - '1' means xHC generates an event when MFINDEX wraps. */
198 #define CMD_EWE XHCI_CMD_EWE
199 /* MFINDEX power management - '1' means xHC can stop MFINDEX counter if all root
200 * hubs are in U3 (selective suspend), disconnect, disabled, or powered-off.
201 * '0' means the xHC can power it off if all ports are in the disconnect,
202 * disabled, or powered-off state.
204 #define CMD_PM_INDEX (1 << 11)
205 /* bits 12:31 are reserved (and should be preserved on writes). */
207 /* USBSTS - USB status - status bitmasks */
208 /* HC not running - set to 1 when run/stop bit is cleared. */
209 #define STS_HALT XHCI_STS_HALT
210 /* serious error, e.g. PCI parity error. The HC will clear the run/stop bit. */
211 #define STS_FATAL (1 << 2)
212 /* event interrupt - clear this prior to clearing any IP flags in IR set*/
213 #define STS_EINT (1 << 3)
214 /* port change detect */
215 #define STS_PORT (1 << 4)
216 /* bits 5:7 reserved and zeroed */
217 /* save state status - '1' means xHC is saving state */
218 #define STS_SAVE (1 << 8)
219 /* restore state status - '1' means xHC is restoring state */
220 #define STS_RESTORE (1 << 9)
221 /* true: save or restore error */
222 #define STS_SRE (1 << 10)
223 /* true: Controller Not Ready to accept doorbell or op reg writes after reset */
224 #define STS_CNR XHCI_STS_CNR
225 /* true: internal Host Controller Error - SW needs to reset and reinitialize */
226 #define STS_HCE (1 << 12)
227 /* bits 13:31 reserved and should be preserved */
230 * DNCTRL - Device Notification Control Register - dev_notification bitmasks
231 * Generate a device notification event when the HC sees a transaction with a
232 * notification type that matches a bit set in this bit field.
234 #define DEV_NOTE_MASK (0xffff)
235 #define ENABLE_DEV_NOTE(x) (1 << x)
236 /* Most of the device notification types should only be used for debug.
237 * SW does need to pay attention to function wake notifications.
239 #define DEV_NOTE_FWAKE ENABLE_DEV_NOTE(1)
241 /* CRCR - Command Ring Control Register - cmd_ring bitmasks */
242 /* bit 0 is the command ring cycle state */
243 /* stop ring operation after completion of the currently executing command */
244 #define CMD_RING_PAUSE (1 << 1)
245 /* stop ring immediately - abort the currently executing command */
246 #define CMD_RING_ABORT (1 << 2)
247 /* true: command ring is running */
248 #define CMD_RING_RUNNING (1 << 3)
249 /* bits 4:5 reserved and should be preserved */
250 /* Command Ring pointer - bit mask for the lower 32 bits. */
251 #define CMD_RING_RSVD_BITS (0x3f)
253 /* CONFIG - Configure Register - config_reg bitmasks */
254 /* bits 0:7 - maximum number of device slots enabled (NumSlotsEn) */
255 #define MAX_DEVS(p) ((p) & 0xff)
256 /* bits 8:31 - reserved and should be preserved */
258 /* PORTSC - Port Status and Control Register - port_status_base bitmasks */
259 /* true: device connected */
260 #define PORT_CONNECT (1 << 0)
261 /* true: port enabled */
262 #define PORT_PE (1 << 1)
263 /* bit 2 reserved and zeroed */
264 /* true: port has an over-current condition */
265 #define PORT_OC (1 << 3)
266 /* true: port reset signaling asserted */
267 #define PORT_RESET (1 << 4)
268 /* Port Link State - bits 5:8
269 * A read gives the current link PM state of the port,
270 * a write with Link State Write Strobe set sets the link state.
272 #define PORT_PLS_MASK (0xf << 5)
273 #define XDEV_U0 (0x0 << 5)
274 #define XDEV_U3 (0x3 << 5)
275 #define XDEV_RESUME (0xf << 5)
276 /* true: port has power (see HCC_PPC) */
277 #define PORT_POWER (1 << 9)
278 /* bits 10:13 indicate device speed:
279 * 0 - undefined speed - port hasn't be initialized by a reset yet
286 #define DEV_SPEED_MASK (0xf << 10)
287 #define XDEV_FS (0x1 << 10)
288 #define XDEV_LS (0x2 << 10)
289 #define XDEV_HS (0x3 << 10)
290 #define XDEV_SS (0x4 << 10)
291 #define DEV_UNDEFSPEED(p) (((p) & DEV_SPEED_MASK) == (0x0<<10))
292 #define DEV_FULLSPEED(p) (((p) & DEV_SPEED_MASK) == XDEV_FS)
293 #define DEV_LOWSPEED(p) (((p) & DEV_SPEED_MASK) == XDEV_LS)
294 #define DEV_HIGHSPEED(p) (((p) & DEV_SPEED_MASK) == XDEV_HS)
295 #define DEV_SUPERSPEED(p) (((p) & DEV_SPEED_MASK) == XDEV_SS)
296 /* Bits 20:23 in the Slot Context are the speed for the device */
297 #define SLOT_SPEED_FS (XDEV_FS << 10)
298 #define SLOT_SPEED_LS (XDEV_LS << 10)
299 #define SLOT_SPEED_HS (XDEV_HS << 10)
300 #define SLOT_SPEED_SS (XDEV_SS << 10)
301 /* Port Indicator Control */
302 #define PORT_LED_OFF (0 << 14)
303 #define PORT_LED_AMBER (1 << 14)
304 #define PORT_LED_GREEN (2 << 14)
305 #define PORT_LED_MASK (3 << 14)
306 /* Port Link State Write Strobe - set this when changing link state */
307 #define PORT_LINK_STROBE (1 << 16)
308 /* true: connect status change */
309 #define PORT_CSC (1 << 17)
310 /* true: port enable change */
311 #define PORT_PEC (1 << 18)
312 /* true: warm reset for a USB 3.0 device is done. A "hot" reset puts the port
313 * into an enabled state, and the device into the default state. A "warm" reset
314 * also resets the link, forcing the device through the link training sequence.
315 * SW can also look at the Port Reset register to see when warm reset is done.
317 #define PORT_WRC (1 << 19)
318 /* true: over-current change */
319 #define PORT_OCC (1 << 20)
320 /* true: reset change - 1 to 0 transition of PORT_RESET */
321 #define PORT_RC (1 << 21)
322 /* port link status change - set on some port link state transitions:
324 * ------------------------------------------------------------------------------
325 * - U3 to Resume Wakeup signaling from a device
326 * - Resume to Recovery to U0 USB 3.0 device resume
327 * - Resume to U0 USB 2.0 device resume
328 * - U3 to Recovery to U0 Software resume of USB 3.0 device complete
329 * - U3 to U0 Software resume of USB 2.0 device complete
330 * - U2 to U0 L1 resume of USB 2.1 device complete
331 * - U0 to U0 (???) L1 entry rejection by USB 2.1 device
332 * - U0 to disabled L1 entry error with USB 2.1 device
333 * - Any state to inactive Error on USB 3.0 port
335 #define PORT_PLC (1 << 22)
336 /* port configure error change - port failed to configure its link partner */
337 #define PORT_CEC (1 << 23)
338 /* bit 24 reserved */
339 /* wake on connect (enable) */
340 #define PORT_WKCONN_E (1 << 25)
341 /* wake on disconnect (enable) */
342 #define PORT_WKDISC_E (1 << 26)
343 /* wake on over-current (enable) */
344 #define PORT_WKOC_E (1 << 27)
345 /* bits 28:29 reserved */
346 /* true: device is removable - for USB 3.0 roothub emulation */
347 #define PORT_DEV_REMOVE (1 << 30)
348 /* Initiate a warm port reset - complete when PORT_WRC is '1' */
349 #define PORT_WR (1 << 31)
351 /* Port Power Management Status and Control - port_power_base bitmasks */
352 /* Inactivity timer value for transitions into U1, in microseconds.
353 * Timeout can be up to 127us. 0xFF means an infinite timeout.
355 #define PORT_U1_TIMEOUT(p) ((p) & 0xff)
356 /* Inactivity timer value for transitions into U2 */
357 #define PORT_U2_TIMEOUT(p) (((p) & 0xff) << 8)
358 /* Bits 24:31 for port testing */
360 /* USB2 Protocol PORTSPMSC */
361 #define PORT_RWE (1 << 0x3)
364 * struct xhci_intr_reg - Interrupt Register Set
365 * @irq_pending: IMAN - Interrupt Management Register. Used to enable
366 * interrupts and check for pending interrupts.
367 * @irq_control: IMOD - Interrupt Moderation Register.
368 * Used to throttle interrupts.
369 * @erst_size: Number of segments in the Event Ring Segment Table (ERST).
370 * @erst_base: ERST base address.
371 * @erst_dequeue: Event ring dequeue pointer.
373 * Each interrupter (defined by a MSI-X vector) has an event ring and an Event
374 * Ring Segment Table (ERST) associated with it. The event ring is comprised of
375 * multiple segments of the same size. The HC places events on the ring and
376 * "updates the Cycle bit in the TRBs to indicate to software the current
377 * position of the Enqueue Pointer." The HCD (Linux) processes those events and
378 * updates the dequeue pointer.
380 struct xhci_intr_reg {
389 /* irq_pending bitmasks */
390 #define ER_IRQ_PENDING(p) ((p) & 0x1)
391 /* bits 2:31 need to be preserved */
392 /* THIS IS BUGGY - FIXME - IP IS WRITE 1 TO CLEAR */
393 #define ER_IRQ_CLEAR(p) ((p) & 0xfffffffe)
394 #define ER_IRQ_ENABLE(p) ((ER_IRQ_CLEAR(p)) | 0x2)
395 #define ER_IRQ_DISABLE(p) ((ER_IRQ_CLEAR(p)) & ~(0x2))
397 /* irq_control bitmasks */
398 /* Minimum interval between interrupts (in 250ns intervals). The interval
399 * between interrupts will be longer if there are no events on the event ring.
400 * Default is 4000 (1 ms).
402 #define ER_IRQ_INTERVAL_MASK (0xffff)
403 /* Counter used to count down the time to the next interrupt - HW use only */
404 #define ER_IRQ_COUNTER_MASK (0xffff << 16)
406 /* erst_size bitmasks */
407 /* Preserve bits 16:31 of erst_size */
408 #define ERST_SIZE_MASK (0xffff << 16)
410 /* erst_dequeue bitmasks */
411 /* Dequeue ERST Segment Index (DESI) - Segment number (or alias)
412 * where the current dequeue pointer lies. This is an optional HW hint.
414 #define ERST_DESI_MASK (0x7)
415 /* Event Handler Busy (EHB) - is the event ring scheduled to be serviced by
416 * a work queue (or delayed service routine)?
418 #define ERST_EHB (1 << 3)
419 #define ERST_PTR_MASK (0xf)
422 * struct xhci_run_regs
424 * MFINDEX - current microframe number
426 * Section 5.5 Host Controller Runtime Registers:
427 * "Software should read and write these registers using only Dword (32 bit)
428 * or larger accesses"
430 struct xhci_run_regs {
431 u32 microframe_index;
433 struct xhci_intr_reg ir_set[128];
437 * struct doorbell_array
439 * Bits 0 - 7: Endpoint target
441 * Bits 16 - 31: Stream ID
445 struct xhci_doorbell_array {
449 #define DB_VALUE(ep, stream) ((((ep) + 1) & 0xff) | ((stream) << 16))
450 #define DB_VALUE_HOST 0x00000000
453 * struct xhci_protocol_caps
454 * @revision: major revision, minor revision, capability ID,
455 * and next capability pointer.
456 * @name_string: Four ASCII characters to say which spec this xHC
457 * follows, typically "USB ".
458 * @port_info: Port offset, count, and protocol-defined information.
460 struct xhci_protocol_caps {
466 #define XHCI_EXT_PORT_MAJOR(x) (((x) >> 24) & 0xff)
467 #define XHCI_EXT_PORT_OFF(x) ((x) & 0xff)
468 #define XHCI_EXT_PORT_COUNT(x) (((x) >> 8) & 0xff)
471 * struct xhci_container_ctx
472 * @type: Type of context. Used to calculated offsets to contained contexts.
473 * @size: Size of the context data
474 * @bytes: The raw context data given to HW
475 * @dma: dma address of the bytes
477 * Represents either a Device or Input context. Holds a pointer to the raw
478 * memory used for the context (bytes) and dma address of it (dma).
480 struct xhci_container_ctx {
482 #define XHCI_CTX_TYPE_DEVICE 0x1
483 #define XHCI_CTX_TYPE_INPUT 0x2
492 * struct xhci_slot_ctx
493 * @dev_info: Route string, device speed, hub info, and last valid endpoint
494 * @dev_info2: Max exit latency for device number, root hub port number
495 * @tt_info: tt_info is used to construct split transaction tokens
496 * @dev_state: slot state and device address
498 * Slot Context - section 6.2.1.1. This assumes the HC uses 32-byte context
499 * structures. If the HC uses 64-byte contexts, there is an additional 32 bytes
500 * reserved at the end of the slot context for HC internal use.
502 struct xhci_slot_ctx {
507 /* offset 0x10 to 0x1f reserved for HC internal use */
511 /* dev_info bitmasks */
512 /* Route String - 0:19 */
513 #define ROUTE_STRING_MASK (0xfffff)
514 /* Device speed - values defined by PORTSC Device Speed field - 20:23 */
515 #define DEV_SPEED (0xf << 20)
516 /* bit 24 reserved */
517 /* Is this LS/FS device connected through a HS hub? - bit 25 */
518 #define DEV_MTT (0x1 << 25)
519 /* Set if the device is a hub - bit 26 */
520 #define DEV_HUB (0x1 << 26)
521 /* Index of the last valid endpoint context in this device context - 27:31 */
522 #define LAST_CTX_MASK (0x1f << 27)
523 #define LAST_CTX(p) ((p) << 27)
524 #define LAST_CTX_TO_EP_NUM(p) (((p) >> 27) - 1)
525 #define SLOT_FLAG (1 << 0)
526 #define EP0_FLAG (1 << 1)
528 /* dev_info2 bitmasks */
529 /* Max Exit Latency (ms) - worst case time to wake up all links in dev path */
530 #define MAX_EXIT (0xffff)
531 /* Root hub port number that is needed to access the USB device */
532 #define ROOT_HUB_PORT(p) (((p) & 0xff) << 16)
533 #define DEVINFO_TO_ROOT_HUB_PORT(p) (((p) >> 16) & 0xff)
534 /* Maximum number of ports under a hub device */
535 #define XHCI_MAX_PORTS(p) (((p) & 0xff) << 24)
537 /* tt_info bitmasks */
539 * TT Hub Slot ID - for low or full speed devices attached to a high-speed hub
540 * The Slot ID of the hub that isolates the high speed signaling from
541 * this low or full-speed device. '0' if attached to root hub port.
543 #define TT_SLOT (0xff)
545 * The number of the downstream facing port of the high-speed hub
546 * '0' if the device is not low or full speed.
548 #define TT_PORT (0xff << 8)
549 #define TT_THINK_TIME(p) (((p) & 0x3) << 16)
551 /* dev_state bitmasks */
552 /* USB device address - assigned by the HC */
553 #define DEV_ADDR_MASK (0xff)
554 /* bits 8:26 reserved */
556 #define SLOT_STATE (0x1f << 27)
557 #define GET_SLOT_STATE(p) (((p) & (0x1f << 27)) >> 27)
562 * @ep_info: endpoint state, streams, mult, and interval information.
563 * @ep_info2: information on endpoint type, max packet size, max burst size,
564 * error count, and whether the HC will force an event for all
566 * @deq: 64-bit ring dequeue pointer address. If the endpoint only
567 * defines one stream, this points to the endpoint transfer ring.
568 * Otherwise, it points to a stream context array, which has a
569 * ring pointer for each flow.
571 * Average TRB lengths for the endpoint ring and
572 * max payload within an Endpoint Service Interval Time (ESIT).
574 * Endpoint Context - section 6.2.1.2. This assumes the HC uses 32-byte context
575 * structures. If the HC uses 64-byte contexts, there is an additional 32 bytes
576 * reserved at the end of the endpoint context for HC internal use.
583 /* offset 0x14 - 0x1f reserved for HC internal use */
587 /* ep_info bitmasks */
589 * Endpoint State - bits 0:2
592 * 2 - halted due to halt condition - ok to manipulate endpoint ring
597 #define EP_STATE_MASK (0xf)
598 #define EP_STATE_DISABLED 0
599 #define EP_STATE_RUNNING 1
600 #define EP_STATE_HALTED 2
601 #define EP_STATE_STOPPED 3
602 #define EP_STATE_ERROR 4
603 /* Mult - Max number of burtst within an interval, in EP companion desc. */
604 #define EP_MULT(p) ((p & 0x3) << 8)
605 /* bits 10:14 are Max Primary Streams */
606 /* bit 15 is Linear Stream Array */
607 /* Interval - period between requests to an endpoint - 125u increments. */
608 #define EP_INTERVAL(p) ((p & 0xff) << 16)
609 #define EP_INTERVAL_TO_UFRAMES(p) (1 << (((p) >> 16) & 0xff))
610 #define EP_MAXPSTREAMS_MASK (0x1f << 10)
611 #define EP_MAXPSTREAMS(p) (((p) << 10) & EP_MAXPSTREAMS_MASK)
612 /* Endpoint is set up with a Linear Stream Array (vs. Secondary Stream Array) */
613 #define EP_HAS_LSA (1 << 15)
615 /* ep_info2 bitmasks */
617 * Force Event - generate transfer events for all TRBs for this endpoint
618 * This will tell the HC to ignore the IOC and ISP flags (for debugging only).
620 #define FORCE_EVENT (0x1)
621 #define ERROR_COUNT(p) (((p) & 0x3) << 1)
622 #define CTX_TO_EP_TYPE(p) (((p) >> 3) & 0x7)
623 #define EP_TYPE(p) ((p) << 3)
624 #define ISOC_OUT_EP 1
625 #define BULK_OUT_EP 2
632 /* bit 7 is Host Initiate Disable - for disabling stream selection */
633 #define MAX_BURST(p) (((p)&0xff) << 8)
634 #define MAX_PACKET(p) (((p)&0xffff) << 16)
635 #define MAX_PACKET_MASK (0xffff << 16)
636 #define MAX_PACKET_DECODED(p) (((p) >> 16) & 0xffff)
638 /* Get max packet size from ep desc. Bit 10..0 specify the max packet size.
641 #define GET_MAX_PACKET(p) ((p) & 0x7ff)
643 /* tx_info bitmasks */
644 #define AVG_TRB_LENGTH_FOR_EP(p) ((p) & 0xffff)
645 #define MAX_ESIT_PAYLOAD_FOR_EP(p) (((p) & 0xffff) << 16)
649 * struct xhci_input_control_context
650 * Input control context; see section 6.2.5.
652 * @drop_context: set the bit of the endpoint context you want to disable
653 * @add_context: set the bit of the endpoint context you want to enable
655 struct xhci_input_control_ctx {
661 /* Represents everything that is needed to issue a command on the command ring.
662 * It's useful to pre-allocate these for commands that cannot fail due to
663 * out-of-memory errors, like freeing streams.
665 struct xhci_command {
666 /* Input context for changing device state */
667 struct xhci_container_ctx *in_ctx;
669 /* If completion is null, no one is waiting on this command
670 * and the structure can be freed after the command completes.
672 struct completion *completion;
673 union xhci_trb *command_trb;
674 struct list_head cmd_list;
677 /* drop context bitmasks */
678 #define DROP_EP(x) (0x1 << x)
679 /* add context bitmasks */
680 #define ADD_EP(x) (0x1 << x)
682 struct xhci_stream_ctx {
683 /* 64-bit stream ring address, cycle state, and stream type */
685 /* offset 0x14 - 0x1f reserved for HC internal use */
689 /* Stream Context Types (section 6.4.1) - bits 3:1 of stream ctx deq ptr */
690 #define SCT_FOR_CTX(p) (((p) << 1) & 0x7)
691 /* Secondary stream array type, dequeue pointer is to a transfer ring */
693 /* Primary stream array type, dequeue pointer is to a transfer ring */
695 /* Dequeue pointer is for a secondary stream array (SSA) with 8 entries */
700 #define SCT_SSA_128 6
701 #define SCT_SSA_256 7
703 /* Assume no secondary streams for now */
704 struct xhci_stream_info {
705 struct xhci_ring **stream_rings;
706 /* Number of streams, including stream 0 (which drivers can't use) */
707 unsigned int num_streams;
708 /* The stream context array may be bigger than
709 * the number of streams the driver asked for
711 struct xhci_stream_ctx *stream_ctx_array;
712 unsigned int num_stream_ctxs;
713 dma_addr_t ctx_array_dma;
714 /* For mapping physical TRB addresses to segments in stream rings */
715 struct radix_tree_root trb_address_map;
716 struct xhci_command *free_streams_command;
719 #define SMALL_STREAM_ARRAY_SIZE 256
720 #define MEDIUM_STREAM_ARRAY_SIZE 1024
722 struct xhci_virt_ep {
723 struct xhci_ring *ring;
724 /* Related to endpoints that are configured to use stream IDs only */
725 struct xhci_stream_info *stream_info;
726 /* Temporary storage in case the configure endpoint command fails and we
727 * have to restore the device state to the previous state
729 struct xhci_ring *new_ring;
730 unsigned int ep_state;
731 #define SET_DEQ_PENDING (1 << 0)
732 #define EP_HALTED (1 << 1) /* For stall handling */
733 #define EP_HALT_PENDING (1 << 2) /* For URB cancellation */
734 /* Transitioning the endpoint to using streams, don't enqueue URBs */
735 #define EP_GETTING_STREAMS (1 << 3)
736 #define EP_HAS_STREAMS (1 << 4)
737 /* Transitioning the endpoint to not using streams, don't enqueue URBs */
738 #define EP_GETTING_NO_STREAMS (1 << 5)
739 /* ---- Related to URB cancellation ---- */
740 struct list_head cancelled_td_list;
741 /* The TRB that was last reported in a stopped endpoint ring */
742 union xhci_trb *stopped_trb;
743 struct xhci_td *stopped_td;
744 unsigned int stopped_stream;
745 /* Watchdog timer for stop endpoint command to cancel URBs */
746 struct timer_list stop_cmd_timer;
747 int stop_cmds_pending;
748 struct xhci_hcd *xhci;
750 * Sometimes the xHC can not process isochronous endpoint ring quickly
751 * enough, and it will miss some isoc tds on the ring and generate
752 * a Missed Service Error Event.
753 * Set skip flag when receive a Missed Service Error Event and
754 * process the missed tds on the endpoint ring.
759 struct xhci_virt_device {
760 struct usb_device *udev;
762 * Commands to the hardware are passed an "input context" that
763 * tells the hardware what to change in its data structures.
764 * The hardware will return changes in an "output context" that
765 * software must allocate for the hardware. We need to keep
766 * track of input and output contexts separately because
767 * these commands might fail and we don't trust the hardware.
769 struct xhci_container_ctx *out_ctx;
770 /* Used for addressing devices and configuration changes */
771 struct xhci_container_ctx *in_ctx;
772 /* Rings saved to ensure old alt settings can be re-instated */
773 struct xhci_ring **ring_cache;
774 int num_rings_cached;
775 /* Store xHC assigned device address */
777 #define XHCI_MAX_RINGS_CACHED 31
778 struct xhci_virt_ep eps[31];
779 struct completion cmd_completion;
780 /* Status of the last command issued for this device */
782 struct list_head cmd_list;
788 * struct xhci_device_context_array
789 * @dev_context_ptr array of 64-bit DMA addresses for device contexts
791 struct xhci_device_context_array {
792 /* 64-bit device addresses; we only write 32-bit addresses */
793 u64 dev_context_ptrs[MAX_HC_SLOTS];
794 /* private xHCD pointers */
797 /* TODO: write function to set the 64-bit device DMA address */
799 * TODO: change this to be dynamically sized at HC mem init time since the HC
800 * might not be able to handle the maximum number of devices possible.
804 struct xhci_transfer_event {
805 /* 64-bit buffer address, or immediate data */
808 /* This field is interpreted differently based on the type of TRB */
812 /** Transfer Event bit fields **/
813 #define TRB_TO_EP_ID(p) (((p) >> 16) & 0x1f)
815 /* Completion Code - only applicable for some types of TRBs */
816 #define COMP_CODE_MASK (0xff << 24)
817 #define GET_COMP_CODE(p) (((p) & COMP_CODE_MASK) >> 24)
818 #define COMP_SUCCESS 1
819 /* Data Buffer Error */
820 #define COMP_DB_ERR 2
821 /* Babble Detected Error */
822 #define COMP_BABBLE 3
823 /* USB Transaction Error */
824 #define COMP_TX_ERR 4
825 /* TRB Error - some TRB field is invalid */
826 #define COMP_TRB_ERR 5
827 /* Stall Error - USB device is stalled */
829 /* Resource Error - HC doesn't have memory for that device configuration */
830 #define COMP_ENOMEM 7
831 /* Bandwidth Error - not enough room in schedule for this dev config */
832 #define COMP_BW_ERR 8
833 /* No Slots Available Error - HC ran out of device slots */
834 #define COMP_ENOSLOTS 9
835 /* Invalid Stream Type Error */
836 #define COMP_STREAM_ERR 10
837 /* Slot Not Enabled Error - doorbell rung for disabled device slot */
838 #define COMP_EBADSLT 11
839 /* Endpoint Not Enabled Error */
840 #define COMP_EBADEP 12
842 #define COMP_SHORT_TX 13
843 /* Ring Underrun - doorbell rung for an empty isoc OUT ep ring */
844 #define COMP_UNDERRUN 14
845 /* Ring Overrun - isoc IN ep ring is empty when ep is scheduled to RX */
846 #define COMP_OVERRUN 15
847 /* Virtual Function Event Ring Full Error */
848 #define COMP_VF_FULL 16
849 /* Parameter Error - Context parameter is invalid */
850 #define COMP_EINVAL 17
851 /* Bandwidth Overrun Error - isoc ep exceeded its allocated bandwidth */
852 #define COMP_BW_OVER 18
853 /* Context State Error - illegal context state transition requested */
854 #define COMP_CTX_STATE 19
855 /* No Ping Response Error - HC didn't get PING_RESPONSE in time to TX */
856 #define COMP_PING_ERR 20
857 /* Event Ring is full */
858 #define COMP_ER_FULL 21
859 /* Missed Service Error - HC couldn't service an isoc ep within interval */
860 #define COMP_MISSED_INT 23
861 /* Successfully stopped command ring */
862 #define COMP_CMD_STOP 24
863 /* Successfully aborted current command and stopped command ring */
864 #define COMP_CMD_ABORT 25
865 /* Stopped - transfer was terminated by a stop endpoint command */
867 /* Same as COMP_EP_STOPPED, but the transfered length in the event is invalid */
868 #define COMP_STOP_INVAL 27
869 /* Control Abort Error - Debug Capability - control pipe aborted */
870 #define COMP_DBG_ABORT 28
871 /* TRB type 29 and 30 reserved */
872 /* Isoc Buffer Overrun - an isoc IN ep sent more data than could fit in TD */
873 #define COMP_BUFF_OVER 31
874 /* Event Lost Error - xHC has an "internal event overrun condition" */
875 #define COMP_ISSUES 32
876 /* Undefined Error - reported when other error codes don't apply */
877 #define COMP_UNKNOWN 33
878 /* Invalid Stream ID Error */
879 #define COMP_STRID_ERR 34
880 /* Secondary Bandwidth Error - may be returned by a Configure Endpoint cmd */
881 /* FIXME - check for this */
882 #define COMP_2ND_BW_ERR 35
883 /* Split Transaction Error */
884 #define COMP_SPLIT_ERR 36
886 struct xhci_link_trb {
887 /* 64-bit segment pointer*/
893 /* control bitfields */
894 #define LINK_TOGGLE (0x1<<1)
896 /* Command completion event TRB */
897 struct xhci_event_cmd {
898 /* Pointer to command TRB, or the value passed by the event data trb */
905 /* bits 16:23 are the virtual function ID */
906 /* bits 24:31 are the slot ID */
907 #define TRB_TO_SLOT_ID(p) (((p) & (0xff<<24)) >> 24)
908 #define SLOT_ID_FOR_TRB(p) (((p) & 0xff) << 24)
910 /* Stop Endpoint TRB - ep_index to endpoint ID for this TRB */
911 #define TRB_TO_EP_INDEX(p) ((((p) & (0x1f << 16)) >> 16) - 1)
912 #define EP_ID_FOR_TRB(p) ((((p) + 1) & 0x1f) << 16)
914 #define SUSPEND_PORT_FOR_TRB(p) (((p) & 1) << 23)
915 #define TRB_TO_SUSPEND_PORT(p) (((p) & (1 << 23)) >> 23)
916 #define LAST_EP_INDEX 30
918 /* Set TR Dequeue Pointer command TRB fields */
919 #define TRB_TO_STREAM_ID(p) ((((p) & (0xffff << 16)) >> 16))
920 #define STREAM_ID_FOR_TRB(p) ((((p)) & 0xffff) << 16)
923 /* Port Status Change Event TRB fields */
924 /* Port ID - bits 31:24 */
925 #define GET_PORT_ID(p) (((p) & (0xff << 24)) >> 24)
927 /* Normal TRB fields */
928 /* transfer_len bitmasks - bits 0:16 */
929 #define TRB_LEN(p) ((p) & 0x1ffff)
930 /* Interrupter Target - which MSI-X vector to target the completion event at */
931 #define TRB_INTR_TARGET(p) (((p) & 0x3ff) << 22)
932 #define GET_INTR_TARGET(p) (((p) >> 22) & 0x3ff)
934 /* Cycle bit - indicates TRB ownership by HC or HCD */
935 #define TRB_CYCLE (1<<0)
937 * Force next event data TRB to be evaluated before task switch.
938 * Used to pass OS data back after a TD completes.
940 #define TRB_ENT (1<<1)
941 /* Interrupt on short packet */
942 #define TRB_ISP (1<<2)
943 /* Set PCIe no snoop attribute */
944 #define TRB_NO_SNOOP (1<<3)
945 /* Chain multiple TRBs into a TD */
946 #define TRB_CHAIN (1<<4)
947 /* Interrupt on completion */
948 #define TRB_IOC (1<<5)
949 /* The buffer pointer contains immediate data */
950 #define TRB_IDT (1<<6)
953 /* Control transfer TRB specific fields */
954 #define TRB_DIR_IN (1<<16)
956 /* Isochronous TRB specific fields */
957 #define TRB_SIA (1<<31)
959 struct xhci_generic_trb {
964 struct xhci_link_trb link;
965 struct xhci_transfer_event trans_event;
966 struct xhci_event_cmd event_cmd;
967 struct xhci_generic_trb generic;
971 #define TRB_TYPE_BITMASK (0xfc00)
972 #define TRB_TYPE(p) ((p) << 10)
973 #define TRB_FIELD_TO_TYPE(p) (((p) & TRB_TYPE_BITMASK) >> 10)
975 /* bulk, interrupt, isoc scatter/gather, and control data stage */
977 /* setup stage for control transfers */
979 /* data stage for control transfers */
981 /* status stage for control transfers */
985 /* TRB for linking ring segments */
987 #define TRB_EVENT_DATA 7
988 /* Transfer Ring No-op (not for the command ring) */
989 #define TRB_TR_NOOP 8
991 /* Enable Slot Command */
992 #define TRB_ENABLE_SLOT 9
993 /* Disable Slot Command */
994 #define TRB_DISABLE_SLOT 10
995 /* Address Device Command */
996 #define TRB_ADDR_DEV 11
997 /* Configure Endpoint Command */
998 #define TRB_CONFIG_EP 12
999 /* Evaluate Context Command */
1000 #define TRB_EVAL_CONTEXT 13
1001 /* Reset Endpoint Command */
1002 #define TRB_RESET_EP 14
1003 /* Stop Transfer Ring Command */
1004 #define TRB_STOP_RING 15
1005 /* Set Transfer Ring Dequeue Pointer Command */
1006 #define TRB_SET_DEQ 16
1007 /* Reset Device Command */
1008 #define TRB_RESET_DEV 17
1009 /* Force Event Command (opt) */
1010 #define TRB_FORCE_EVENT 18
1011 /* Negotiate Bandwidth Command (opt) */
1012 #define TRB_NEG_BANDWIDTH 19
1013 /* Set Latency Tolerance Value Command (opt) */
1014 #define TRB_SET_LT 20
1015 /* Get port bandwidth Command */
1016 #define TRB_GET_BW 21
1017 /* Force Header Command - generate a transaction or link management packet */
1018 #define TRB_FORCE_HEADER 22
1019 /* No-op Command - not for transfer rings */
1020 #define TRB_CMD_NOOP 23
1021 /* TRB IDs 24-31 reserved */
1023 /* Transfer Event */
1024 #define TRB_TRANSFER 32
1025 /* Command Completion Event */
1026 #define TRB_COMPLETION 33
1027 /* Port Status Change Event */
1028 #define TRB_PORT_STATUS 34
1029 /* Bandwidth Request Event (opt) */
1030 #define TRB_BANDWIDTH_EVENT 35
1031 /* Doorbell Event (opt) */
1032 #define TRB_DOORBELL 36
1033 /* Host Controller Event */
1034 #define TRB_HC_EVENT 37
1035 /* Device Notification Event - device sent function wake notification */
1036 #define TRB_DEV_NOTE 38
1037 /* MFINDEX Wrap Event - microframe counter wrapped */
1038 #define TRB_MFINDEX_WRAP 39
1039 /* TRB IDs 40-47 reserved, 48-63 is vendor-defined */
1041 /* Nec vendor-specific command completion event. */
1042 #define TRB_NEC_CMD_COMP 48
1043 /* Get NEC firmware revision. */
1044 #define TRB_NEC_GET_FW 49
1046 #define NEC_FW_MINOR(p) (((p) >> 0) & 0xff)
1047 #define NEC_FW_MAJOR(p) (((p) >> 8) & 0xff)
1050 * TRBS_PER_SEGMENT must be a multiple of 4,
1051 * since the command ring is 64-byte aligned.
1052 * It must also be greater than 16.
1054 #define TRBS_PER_SEGMENT 64
1055 /* Allow two commands + a link TRB, along with any reserved command TRBs */
1056 #define MAX_RSVD_CMD_TRBS (TRBS_PER_SEGMENT - 3)
1057 #define SEGMENT_SIZE (TRBS_PER_SEGMENT*16)
1058 /* SEGMENT_SHIFT should be log2(SEGMENT_SIZE).
1059 * Change this if you change TRBS_PER_SEGMENT!
1061 #define SEGMENT_SHIFT 10
1062 /* TRB buffer pointers can't cross 64KB boundaries */
1063 #define TRB_MAX_BUFF_SHIFT 16
1064 #define TRB_MAX_BUFF_SIZE (1 << TRB_MAX_BUFF_SHIFT)
1066 struct xhci_segment {
1067 union xhci_trb *trbs;
1068 /* private to HCD */
1069 struct xhci_segment *next;
1074 struct list_head td_list;
1075 struct list_head cancelled_td_list;
1077 struct xhci_segment *start_seg;
1078 union xhci_trb *first_trb;
1079 union xhci_trb *last_trb;
1082 struct xhci_dequeue_state {
1083 struct xhci_segment *new_deq_seg;
1084 union xhci_trb *new_deq_ptr;
1085 int new_cycle_state;
1089 struct xhci_segment *first_seg;
1090 union xhci_trb *enqueue;
1091 struct xhci_segment *enq_seg;
1092 unsigned int enq_updates;
1093 union xhci_trb *dequeue;
1094 struct xhci_segment *deq_seg;
1095 unsigned int deq_updates;
1096 struct list_head td_list;
1098 * Write the cycle state into the TRB cycle field to give ownership of
1099 * the TRB to the host controller (if we are the producer), or to check
1100 * if we own the TRB (if we are the consumer). See section 4.9.1.
1103 unsigned int stream_id;
1106 struct xhci_erst_entry {
1107 /* 64-bit event ring segment address */
1115 struct xhci_erst_entry *entries;
1116 unsigned int num_entries;
1117 /* xhci->event_ring keeps track of segment dma addresses */
1118 dma_addr_t erst_dma_addr;
1119 /* Num entries the ERST can contain */
1120 unsigned int erst_size;
1123 struct xhci_scratchpad {
1127 dma_addr_t *sp_dma_buffers;
1133 struct xhci_td *td[0];
1137 * Each segment table entry is 4*32bits long. 1K seems like an ok size:
1138 * (1K bytes * 8bytes/bit) / (4*32 bits) = 64 segment entries in the table,
1139 * meaning 64 ring segments.
1140 * Initial allocated size of the ERST, in number of entries */
1141 #define ERST_NUM_SEGS 1
1142 /* Initial allocated size of the ERST, in number of entries */
1143 #define ERST_SIZE 64
1144 /* Initial number of event segment rings allocated */
1145 #define ERST_ENTRIES 1
1146 /* Poll every 60 seconds */
1147 #define POLL_TIMEOUT 60
1148 /* Stop endpoint command timeout (secs) for URB cancellation watchdog timer */
1149 #define XHCI_STOP_EP_CMD_TIMEOUT 5
1150 /* XXX: Make these module parameters */
1164 struct xhci_bus_state {
1165 unsigned long bus_suspended;
1166 unsigned long next_statechange;
1168 /* Port suspend arrays are indexed by the portnum of the fake roothub */
1169 /* ports suspend status arrays - max 31 ports for USB2, 15 for USB3 */
1171 u32 suspended_ports;
1172 unsigned long resume_done[USB_MAXCHILDREN];
1175 static inline unsigned int hcd_index(struct usb_hcd *hcd)
1180 /* There is one ehci_hci structure per controller */
1182 struct usb_hcd *main_hcd;
1183 /* glue to PCI and HCD framework */
1184 struct xhci_cap_regs __iomem *cap_regs;
1185 struct xhci_op_regs __iomem *op_regs;
1186 struct xhci_run_regs __iomem *run_regs;
1187 struct xhci_doorbell_array __iomem *dba;
1188 /* Our HCD's current interrupter register set */
1189 struct xhci_intr_reg __iomem *ir_set;
1191 /* Cached register copies of read-only HC data */
1199 /* packed release number */
1203 u8 max_interrupters;
1208 /* 4KB min, 128MB max */
1210 /* Valid values are 12 to 20, inclusive */
1214 struct msix_entry *msix_entries;
1215 /* data structures */
1216 struct xhci_device_context_array *dcbaa;
1217 struct xhci_ring *cmd_ring;
1218 unsigned int cmd_ring_reserved_trbs;
1219 struct xhci_ring *event_ring;
1220 struct xhci_erst erst;
1222 struct xhci_scratchpad *scratchpad;
1224 /* slot enabling and address device helpers */
1225 struct completion addr_dev;
1227 /* Internal mirror of the HW's dcbaa */
1228 struct xhci_virt_device *devs[MAX_HC_SLOTS];
1231 struct dma_pool *device_pool;
1232 struct dma_pool *segment_pool;
1233 struct dma_pool *small_streams_pool;
1234 struct dma_pool *medium_streams_pool;
1236 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
1237 /* Poll the rings - for debugging */
1238 struct timer_list event_ring_timer;
1241 /* Host controller watchdog timer structures */
1242 unsigned int xhc_state;
1246 /* Host controller is dying - not responding to commands. "I'm not dead yet!"
1248 * xHC interrupts have been disabled and a watchdog timer will (or has already)
1249 * halt the xHCI host, and complete all URBs with an -ESHUTDOWN code. Any code
1250 * that sees this status (other than the timer that set it) should stop touching
1251 * hardware immediately. Interrupt handlers should return immediately when
1252 * they see this status (any time they drop and re-acquire xhci->lock).
1253 * xhci_urb_dequeue() should call usb_hcd_check_unlink_urb() and return without
1254 * putting the TD on the canceled list, etc.
1256 * There are no reports of xHCI host controllers that display this issue.
1258 #define XHCI_STATE_DYING (1 << 0)
1261 unsigned int quirks;
1262 #define XHCI_LINK_TRB_QUIRK (1 << 0)
1263 #define XHCI_RESET_EP_QUIRK (1 << 1)
1264 #define XHCI_NEC_HOST (1 << 2)
1265 /* There's only one roothub to keep track of bus suspend info for
1268 struct xhci_bus_state bus_state[1];
1269 /* Is each xHCI roothub port a USB 3.0, USB 2.0, or USB 1.1 port? */
1271 /* Array of pointers to USB 3.0 PORTSC registers */
1272 u32 __iomem **usb3_ports;
1273 unsigned int num_usb3_ports;
1274 /* Array of pointers to USB 2.0 PORTSC registers */
1275 u32 __iomem **usb2_ports;
1276 unsigned int num_usb2_ports;
1279 /* convert between an HCD pointer and the corresponding EHCI_HCD */
1280 static inline struct xhci_hcd *hcd_to_xhci(struct usb_hcd *hcd)
1282 return *((struct xhci_hcd **) (hcd->hcd_priv));
1285 static inline struct usb_hcd *xhci_to_hcd(struct xhci_hcd *xhci)
1287 return xhci->main_hcd;
1290 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
1291 #define XHCI_DEBUG 1
1293 #define XHCI_DEBUG 0
1296 #define xhci_dbg(xhci, fmt, args...) \
1297 do { if (XHCI_DEBUG) dev_dbg(xhci_to_hcd(xhci)->self.controller , fmt , ## args); } while (0)
1298 #define xhci_info(xhci, fmt, args...) \
1299 do { if (XHCI_DEBUG) dev_info(xhci_to_hcd(xhci)->self.controller , fmt , ## args); } while (0)
1300 #define xhci_err(xhci, fmt, args...) \
1301 dev_err(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1302 #define xhci_warn(xhci, fmt, args...) \
1303 dev_warn(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1305 /* TODO: copied from ehci.h - can be refactored? */
1306 /* xHCI spec says all registers are little endian */
1307 static inline unsigned int xhci_readl(const struct xhci_hcd *xhci,
1308 __u32 __iomem *regs)
1312 static inline void xhci_writel(struct xhci_hcd *xhci,
1313 const unsigned int val, __u32 __iomem *regs)
1316 "`MEM_WRITE_DWORD(3'b000, 32'h%p, 32'h%0x, 4'hf);\n",
1322 * Registers should always be accessed with double word or quad word accesses.
1324 * Some xHCI implementations may support 64-bit address pointers. Registers
1325 * with 64-bit address pointers should be written to with dword accesses by
1326 * writing the low dword first (ptr[0]), then the high dword (ptr[1]) second.
1327 * xHCI implementations that do not support 64-bit address pointers will ignore
1328 * the high dword, and write order is irrelevant.
1330 static inline u64 xhci_read_64(const struct xhci_hcd *xhci,
1331 __u64 __iomem *regs)
1333 __u32 __iomem *ptr = (__u32 __iomem *) regs;
1334 u64 val_lo = readl(ptr);
1335 u64 val_hi = readl(ptr + 1);
1336 return val_lo + (val_hi << 32);
1338 static inline void xhci_write_64(struct xhci_hcd *xhci,
1339 const u64 val, __u64 __iomem *regs)
1341 __u32 __iomem *ptr = (__u32 __iomem *) regs;
1342 u32 val_lo = lower_32_bits(val);
1343 u32 val_hi = upper_32_bits(val);
1346 "`MEM_WRITE_DWORD(3'b000, 64'h%p, 64'h%0lx, 4'hf);\n",
1347 regs, (long unsigned int) val);
1348 writel(val_lo, ptr);
1349 writel(val_hi, ptr + 1);
1352 static inline int xhci_link_trb_quirk(struct xhci_hcd *xhci)
1354 u32 temp = xhci_readl(xhci, &xhci->cap_regs->hc_capbase);
1355 return ((HC_VERSION(temp) == 0x95) &&
1356 (xhci->quirks & XHCI_LINK_TRB_QUIRK));
1359 /* xHCI debugging */
1360 void xhci_print_ir_set(struct xhci_hcd *xhci, struct xhci_intr_reg *ir_set, int set_num);
1361 void xhci_print_registers(struct xhci_hcd *xhci);
1362 void xhci_dbg_regs(struct xhci_hcd *xhci);
1363 void xhci_print_run_regs(struct xhci_hcd *xhci);
1364 void xhci_print_trb_offsets(struct xhci_hcd *xhci, union xhci_trb *trb);
1365 void xhci_debug_trb(struct xhci_hcd *xhci, union xhci_trb *trb);
1366 void xhci_debug_segment(struct xhci_hcd *xhci, struct xhci_segment *seg);
1367 void xhci_debug_ring(struct xhci_hcd *xhci, struct xhci_ring *ring);
1368 void xhci_dbg_erst(struct xhci_hcd *xhci, struct xhci_erst *erst);
1369 void xhci_dbg_cmd_ptrs(struct xhci_hcd *xhci);
1370 void xhci_dbg_ring_ptrs(struct xhci_hcd *xhci, struct xhci_ring *ring);
1371 void xhci_dbg_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned int last_ep);
1372 char *xhci_get_slot_state(struct xhci_hcd *xhci,
1373 struct xhci_container_ctx *ctx);
1374 void xhci_dbg_ep_rings(struct xhci_hcd *xhci,
1375 unsigned int slot_id, unsigned int ep_index,
1376 struct xhci_virt_ep *ep);
1378 /* xHCI memory management */
1379 void xhci_mem_cleanup(struct xhci_hcd *xhci);
1380 int xhci_mem_init(struct xhci_hcd *xhci, gfp_t flags);
1381 void xhci_free_virt_device(struct xhci_hcd *xhci, int slot_id);
1382 int xhci_alloc_virt_device(struct xhci_hcd *xhci, int slot_id, struct usb_device *udev, gfp_t flags);
1383 int xhci_setup_addressable_virt_dev(struct xhci_hcd *xhci, struct usb_device *udev);
1384 void xhci_copy_ep0_dequeue_into_input_ctx(struct xhci_hcd *xhci,
1385 struct usb_device *udev);
1386 unsigned int xhci_get_endpoint_index(struct usb_endpoint_descriptor *desc);
1387 unsigned int xhci_get_endpoint_flag(struct usb_endpoint_descriptor *desc);
1388 unsigned int xhci_get_endpoint_flag_from_index(unsigned int ep_index);
1389 unsigned int xhci_last_valid_endpoint(u32 added_ctxs);
1390 void xhci_endpoint_zero(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev, struct usb_host_endpoint *ep);
1391 void xhci_endpoint_copy(struct xhci_hcd *xhci,
1392 struct xhci_container_ctx *in_ctx,
1393 struct xhci_container_ctx *out_ctx,
1394 unsigned int ep_index);
1395 void xhci_slot_copy(struct xhci_hcd *xhci,
1396 struct xhci_container_ctx *in_ctx,
1397 struct xhci_container_ctx *out_ctx);
1398 int xhci_endpoint_init(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev,
1399 struct usb_device *udev, struct usb_host_endpoint *ep,
1401 void xhci_ring_free(struct xhci_hcd *xhci, struct xhci_ring *ring);
1402 void xhci_free_or_cache_endpoint_ring(struct xhci_hcd *xhci,
1403 struct xhci_virt_device *virt_dev,
1404 unsigned int ep_index);
1405 struct xhci_stream_info *xhci_alloc_stream_info(struct xhci_hcd *xhci,
1406 unsigned int num_stream_ctxs,
1407 unsigned int num_streams, gfp_t flags);
1408 void xhci_free_stream_info(struct xhci_hcd *xhci,
1409 struct xhci_stream_info *stream_info);
1410 void xhci_setup_streams_ep_input_ctx(struct xhci_hcd *xhci,
1411 struct xhci_ep_ctx *ep_ctx,
1412 struct xhci_stream_info *stream_info);
1413 void xhci_setup_no_streams_ep_input_ctx(struct xhci_hcd *xhci,
1414 struct xhci_ep_ctx *ep_ctx,
1415 struct xhci_virt_ep *ep);
1416 struct xhci_ring *xhci_dma_to_transfer_ring(
1417 struct xhci_virt_ep *ep,
1419 struct xhci_ring *xhci_stream_id_to_ring(
1420 struct xhci_virt_device *dev,
1421 unsigned int ep_index,
1422 unsigned int stream_id);
1423 struct xhci_command *xhci_alloc_command(struct xhci_hcd *xhci,
1424 bool allocate_in_ctx, bool allocate_completion,
1426 void xhci_urb_free_priv(struct xhci_hcd *xhci, struct urb_priv *urb_priv);
1427 void xhci_free_command(struct xhci_hcd *xhci,
1428 struct xhci_command *command);
1432 int xhci_register_pci(void);
1433 void xhci_unregister_pci(void);
1436 /* xHCI host controller glue */
1437 void xhci_quiesce(struct xhci_hcd *xhci);
1438 int xhci_halt(struct xhci_hcd *xhci);
1439 int xhci_reset(struct xhci_hcd *xhci);
1440 int xhci_init(struct usb_hcd *hcd);
1441 int xhci_run(struct usb_hcd *hcd);
1442 void xhci_stop(struct usb_hcd *hcd);
1443 void xhci_shutdown(struct usb_hcd *hcd);
1446 int xhci_suspend(struct xhci_hcd *xhci);
1447 int xhci_resume(struct xhci_hcd *xhci, bool hibernated);
1449 #define xhci_suspend NULL
1450 #define xhci_resume NULL
1453 int xhci_get_frame(struct usb_hcd *hcd);
1454 irqreturn_t xhci_irq(struct usb_hcd *hcd);
1455 irqreturn_t xhci_msi_irq(int irq, struct usb_hcd *hcd);
1456 int xhci_alloc_dev(struct usb_hcd *hcd, struct usb_device *udev);
1457 void xhci_free_dev(struct usb_hcd *hcd, struct usb_device *udev);
1458 int xhci_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
1459 struct usb_host_endpoint **eps, unsigned int num_eps,
1460 unsigned int num_streams, gfp_t mem_flags);
1461 int xhci_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
1462 struct usb_host_endpoint **eps, unsigned int num_eps,
1464 int xhci_address_device(struct usb_hcd *hcd, struct usb_device *udev);
1465 int xhci_update_hub_device(struct usb_hcd *hcd, struct usb_device *hdev,
1466 struct usb_tt *tt, gfp_t mem_flags);
1467 int xhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb, gfp_t mem_flags);
1468 int xhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status);
1469 int xhci_add_endpoint(struct usb_hcd *hcd, struct usb_device *udev, struct usb_host_endpoint *ep);
1470 int xhci_drop_endpoint(struct usb_hcd *hcd, struct usb_device *udev, struct usb_host_endpoint *ep);
1471 void xhci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep);
1472 int xhci_discover_or_reset_device(struct usb_hcd *hcd, struct usb_device *udev);
1473 int xhci_check_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
1474 void xhci_reset_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
1476 /* xHCI ring, segment, TRB, and TD functions */
1477 dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg, union xhci_trb *trb);
1478 struct xhci_segment *trb_in_td(struct xhci_segment *start_seg,
1479 union xhci_trb *start_trb, union xhci_trb *end_trb,
1480 dma_addr_t suspect_dma);
1481 int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code);
1482 void xhci_ring_cmd_db(struct xhci_hcd *xhci);
1483 int xhci_queue_slot_control(struct xhci_hcd *xhci, u32 trb_type, u32 slot_id);
1484 int xhci_queue_address_device(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1486 int xhci_queue_vendor_command(struct xhci_hcd *xhci,
1487 u32 field1, u32 field2, u32 field3, u32 field4);
1488 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, int slot_id,
1489 unsigned int ep_index, int suspend);
1490 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1491 int slot_id, unsigned int ep_index);
1492 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1493 int slot_id, unsigned int ep_index);
1494 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1495 int slot_id, unsigned int ep_index);
1496 int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
1497 struct urb *urb, int slot_id, unsigned int ep_index);
1498 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1499 u32 slot_id, bool command_must_succeed);
1500 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1502 int xhci_queue_reset_ep(struct xhci_hcd *xhci, int slot_id,
1503 unsigned int ep_index);
1504 int xhci_queue_reset_device(struct xhci_hcd *xhci, u32 slot_id);
1505 void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
1506 unsigned int slot_id, unsigned int ep_index,
1507 unsigned int stream_id, struct xhci_td *cur_td,
1508 struct xhci_dequeue_state *state);
1509 void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
1510 unsigned int slot_id, unsigned int ep_index,
1511 unsigned int stream_id,
1512 struct xhci_dequeue_state *deq_state);
1513 void xhci_cleanup_stalled_ring(struct xhci_hcd *xhci,
1514 struct usb_device *udev, unsigned int ep_index);
1515 void xhci_queue_config_ep_quirk(struct xhci_hcd *xhci,
1516 unsigned int slot_id, unsigned int ep_index,
1517 struct xhci_dequeue_state *deq_state);
1518 void xhci_stop_endpoint_command_watchdog(unsigned long arg);
1519 void xhci_ring_ep_doorbell(struct xhci_hcd *xhci, unsigned int slot_id,
1520 unsigned int ep_index, unsigned int stream_id);
1522 /* xHCI roothub code */
1523 int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue, u16 wIndex,
1524 char *buf, u16 wLength);
1525 int xhci_hub_status_data(struct usb_hcd *hcd, char *buf);
1528 int xhci_bus_suspend(struct usb_hcd *hcd);
1529 int xhci_bus_resume(struct usb_hcd *hcd);
1531 #define xhci_bus_suspend NULL
1532 #define xhci_bus_resume NULL
1533 #endif /* CONFIG_PM */
1535 u32 xhci_port_state_to_neutral(u32 state);
1536 int xhci_find_slot_id_by_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
1538 void xhci_ring_device(struct xhci_hcd *xhci, int slot_id);
1541 struct xhci_input_control_ctx *xhci_get_input_control_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx);
1542 struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx);
1543 struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned int ep_index);
1545 #endif /* __LINUX_XHCI_HCD_H */