projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
USB: Disable auto-suspend for USB 3.0 hubs.
[linux-2.6-block.git] / drivers / usb / host / xhci.h
CommitLineData
74c68741
SS		 1/*
2 * xHCI host controller driver
3 *
4 * Copyright (C) 2008 Intel Corp.
5 *
6 * Author: Sarah Sharp
7 * Some code borrowed from the Linux EHCI driver.
8 *
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.
12 *
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
16 * for more details.
17 *
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.
21 */
22
23#ifndef __LINUX_XHCI_HCD_H
24#define __LINUX_XHCI_HCD_H
25
26#include <linux/usb.h>
7f84eef0 27#include <linux/timer.h>
8e595a5d 28#include <linux/kernel.h>
27729aad 29#include <linux/usb/hcd.h>
74c68741 30
74c68741
SS		 31/* Code sharing between pci-quirks and xhci hcd */
32#include "xhci-ext-caps.h"
33
34/* xHCI PCI Configuration Registers */
35#define XHCI_SBRN_OFFSET (0x60)
36
66d4eadd
SS		 37/* Max number of USB devices for any host controller - limit in section 6.1 */
38#define MAX_HC_SLOTS 256
0f2a7930
SS		 39/* Section 5.3.3 - MaxPorts */
40#define MAX_HC_PORTS 127
66d4eadd 41
74c68741
SS		 42/*
43 * xHCI register interface.
44 * This corresponds to the eXtensible Host Controller Interface (xHCI)
45 * Revision 0.95 specification
74c68741
SS		 46 */
47
48/**
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
57 */
58struct xhci_cap_regs {
59 u32 hc_capbase;
60 u32 hcs_params1;
61 u32 hcs_params2;
62 u32 hcs_params3;
63 u32 hcc_params;
64 u32 db_off;
65 u32 run_regs_off;
66 /* Reserved up to (CAPLENGTH - 0x1C) */
98441973 67};
74c68741
SS		 68
69/* hc_capbase bitmasks */
70/* bits 7:0 - how long is the Capabilities register */
71#define HC_LENGTH(p) XHCI_HC_LENGTH(p)
72/* bits 31:16 */
73#define HC_VERSION(p) (((p) >> 16) & 0xffff)
74
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)
83
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 */
254c80a3 92#define HCS_MAX_SCRATCHPAD(p) (((p) >> 27) & 0x1f)
74c68741
SS		 93
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)
99
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.
107 */
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 */
8df75f42 120#define HCC_MAX_PSA(p) (1 << ((((p) >> 12) & 0xf) + 1))
74c68741
SS		 121/* Extended Capabilities pointer from PCI base - section 5.3.6 */
122#define HCC_EXT_CAPS(p) XHCI_HCC_EXT_CAPS(p)
123
124/* db_off bitmask - bits 0:1 reserved */
125#define DBOFF_MASK (~0x3)
126
127/* run_regs_off bitmask - bits 0:4 reserved */
128#define RTSOFF_MASK (~0x1f)
129
130
131/* Number of registers per port */
132#define NUM_PORT_REGS 4
133
134/**
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
149 * register.
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
154 * devices.
155 */
156struct xhci_op_regs {
157 u32 command;
158 u32 status;
159 u32 page_size;
160 u32 reserved1;
161 u32 reserved2;
162 u32 dev_notification;
8e595a5d 163 u64 cmd_ring;
74c68741
SS		 164 /* rsvd: offset 0x20-2F */
165 u32 reserved3[4];
8e595a5d 166 u64 dcbaa_ptr;
74c68741
SS		 167 u32 config_reg;
168 /* rsvd: offset 0x3C-3FF */
169 u32 reserved4[241];
170 /* port 1 registers, which serve as a base address for other ports */
171 u32 port_status_base;
172 u32 port_power_base;
173 u32 port_link_base;
174 u32 reserved5;
175 /* registers for ports 2-255 */
176 u32 reserved6[NUM_PORT_REGS*254];
98441973 177};
74c68741
SS		 178
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.
185 */
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)
5535b1d5 194/* host controller save/restore state. */
74c68741
SS		 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.
203 */
204#define CMD_PM_INDEX (1 << 11)
205/* bits 12:31 are reserved (and should be preserved on writes). */
206
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 */
228
229/*
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.
233 */
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.
238 */
239#define DEV_NOTE_FWAKE ENABLE_DEV_NOTE(1)
240
0ebbab37
SS		 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. */
8e595a5d 251#define CMD_RING_RSVD_BITS (0x3f)
0ebbab37 252
74c68741
SS		 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 */
257
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.
271 */
be88fe4f
AX		 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)
74c68741
SS		 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
280 * 1 - full speed
281 * 2 - low speed
282 * 3 - high speed
283 * 4 - super speed
284 * 5-15 reserved
285 */
3ffbba95
SS		 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)
74c68741 291#define DEV_UNDEFSPEED(p) (((p) & DEV_SPEED_MASK) == (0x0<<10))
3ffbba95
SS		 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)
74c68741
SS		 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.
316 */
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:
323 * Transition Reason
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
334 */
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)
350
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.
354 */
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 */
359
9777e3ce
AX		 360/* USB2 Protocol PORTSPMSC */
361#define PORT_RWE (1 << 0x3)
74c68741
SS		 362
363/**
98441973 364 * struct xhci_intr_reg - Interrupt Register Set
74c68741
SS		 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.
372 *
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.
379 */
98441973 380struct xhci_intr_reg {
74c68741
SS		 381 u32 irq_pending;
382 u32 irq_control;
383 u32 erst_size;
384 u32 rsvd;
8e595a5d
SS		 385 u64 erst_base;
386 u64 erst_dequeue;
98441973 387};
74c68741 388
66d4eadd 389/* irq_pending bitmasks */
74c68741 390#define ER_IRQ_PENDING(p) ((p) & 0x1)
66d4eadd 391/* bits 2:31 need to be preserved */
7f84eef0 392/* THIS IS BUGGY - FIXME - IP IS WRITE 1 TO CLEAR */
66d4eadd
SS		 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))
396
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).
401 */
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)
405
406/* erst_size bitmasks */
74c68741 407/* Preserve bits 16:31 of erst_size */
66d4eadd
SS		 408#define ERST_SIZE_MASK (0xffff << 16)
409
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.
413 */
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)?
417 */
418#define ERST_EHB (1 << 3)
0ebbab37 419#define ERST_PTR_MASK (0xf)
74c68741
SS		 420
421/**
422 * struct xhci_run_regs
423 * @microframe_index:
424 * MFINDEX - current microframe number
425 *
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"
429 */
430struct xhci_run_regs {
98441973
SS		 431 u32 microframe_index;
432 u32 rsvd[7];
433 struct xhci_intr_reg ir_set[128];
434};
74c68741 435
0ebbab37
SS		 436/**
437 * struct doorbell_array
438 *
50d64676
MW		 439 * Bits 0 - 7: Endpoint target
440 * Bits 8 - 15: RsvdZ
441 * Bits 16 - 31: Stream ID
442 *
0ebbab37
SS		 443 * Section 5.6
444 */
445struct xhci_doorbell_array {
446 u32 doorbell[256];
98441973 447};
0ebbab37 448
50d64676
MW		 449#define DB_VALUE(ep, stream) ((((ep) + 1) & 0xff) | ((stream) << 16))
450#define DB_VALUE_HOST 0x00000000
0ebbab37 451
da6699ce
SS		 452/**
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.
459 */
460struct xhci_protocol_caps {
461 u32 revision;
462 u32 name_string;
463 u32 port_info;
464};
465
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)
469
d115b048
JY		 470/**
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
476 *
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).
479 */
480struct xhci_container_ctx {
481 unsigned type;
482#define XHCI_CTX_TYPE_DEVICE 0x1
483#define XHCI_CTX_TYPE_INPUT 0x2
484
485 int size;
486
487 u8 *bytes;
488 dma_addr_t dma;
489};
490
a74588f9
SS		 491/**
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
497 *
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.
501 */
502struct xhci_slot_ctx {
503 u32 dev_info;
504 u32 dev_info2;
505 u32 tt_info;
506 u32 dev_state;
507 /* offset 0x10 to 0x1f reserved for HC internal use */
508 u32 reserved[4];
98441973 509};
a74588f9
SS		 510
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 */
3ffbba95
SS		 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)
3ffbba95
SS		 525#define SLOT_FLAG (1 << 0)
526#define EP0_FLAG (1 << 1)
a74588f9
SS		 527
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 */
3ffbba95 532#define ROOT_HUB_PORT(p) (((p) & 0xff) << 16)
be88fe4f 533#define DEVINFO_TO_ROOT_HUB_PORT(p) (((p) >> 16) & 0xff)
ac1c1b7f
SS		 534/* Maximum number of ports under a hub device */
535#define XHCI_MAX_PORTS(p) (((p) & 0xff) << 24)
a74588f9
SS		 536
537/* tt_info bitmasks */
538/*
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.
542 */
543#define TT_SLOT (0xff)
544/*
545 * The number of the downstream facing port of the high-speed hub
546 * '0' if the device is not low or full speed.
547 */
548#define TT_PORT (0xff << 8)
ac1c1b7f 549#define TT_THINK_TIME(p) (((p) & 0x3) << 16)
a74588f9
SS		 550
551/* dev_state bitmasks */
552/* USB device address - assigned by the HC */
3ffbba95 553#define DEV_ADDR_MASK (0xff)
a74588f9
SS		 554/* bits 8:26 reserved */
555/* Slot state */
556#define SLOT_STATE (0x1f << 27)
ae636747 557#define GET_SLOT_STATE(p) (((p) & (0x1f << 27)) >> 27)
a74588f9
SS		 558
559
560/**
561 * struct xhci_ep_ctx
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
565 * transactions.
3ffbba95
SS		 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.
570 * @tx_info:
571 * Average TRB lengths for the endpoint ring and
572 * max payload within an Endpoint Service Interval Time (ESIT).
a74588f9
SS		 573 *
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.
577 */
578struct xhci_ep_ctx {
579 u32 ep_info;
580 u32 ep_info2;
8e595a5d 581 u64 deq;
3ffbba95 582 u32 tx_info;
a74588f9 583 /* offset 0x14 - 0x1f reserved for HC internal use */
3ffbba95 584 u32 reserved[3];
98441973 585};
a74588f9
SS		 586
587/* ep_info bitmasks */
588/*
589 * Endpoint State - bits 0:2
590 * 0 - disabled
591 * 1 - running
592 * 2 - halted due to halt condition - ok to manipulate endpoint ring
593 * 3 - stopped
594 * 4 - TRB error
595 * 5-7 - reserved
596 */
d0e96f5a
SS		 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
a74588f9
SS		 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. */
f94e0186 608#define EP_INTERVAL(p) ((p & 0xff) << 16)
624defa1 609#define EP_INTERVAL_TO_UFRAMES(p) (1 << (((p) >> 16) & 0xff))
8df75f42
SS		 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)
a74588f9
SS		 614
615/* ep_info2 bitmasks */
616/*
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).
619 */
620#define FORCE_EVENT (0x1)
621#define ERROR_COUNT(p) (((p) & 0x3) << 1)
82d1009f 622#define CTX_TO_EP_TYPE(p) (((p) >> 3) & 0x7)
a74588f9
SS		 623#define EP_TYPE(p) ((p) << 3)
624#define ISOC_OUT_EP 1
625#define BULK_OUT_EP 2
626#define INT_OUT_EP 3
627#define CTRL_EP 4
628#define ISOC_IN_EP 5
629#define BULK_IN_EP 6
630#define INT_IN_EP 7
631/* bit 6 reserved */
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)
2d3f1fac
SS		 635#define MAX_PACKET_MASK (0xffff << 16)
636#define MAX_PACKET_DECODED(p) (((p) >> 16) & 0xffff)
a74588f9 637
dc07c91b
AX		 638/* Get max packet size from ep desc. Bit 10..0 specify the max packet size.
639 * USB2.0 spec 9.6.6.
640 */
641#define GET_MAX_PACKET(p) ((p) & 0x7ff)
642
9238f25d
SS		 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)
646
a74588f9
SS		 647
648/**
d115b048
JY		 649 * struct xhci_input_control_context
650 * Input control context; see section 6.2.5.
a74588f9
SS		 651 *
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
654 */
d115b048 655struct xhci_input_control_ctx {
a74588f9
SS		 656 u32 drop_flags;
657 u32 add_flags;
d115b048 658 u32 rsvd2[6];
98441973 659};
a74588f9 660
913a8a34
SS		 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.
664 */
665struct xhci_command {
666 /* Input context for changing device state */
667 struct xhci_container_ctx *in_ctx;
668 u32 status;
669 /* If completion is null, no one is waiting on this command
670 * and the structure can be freed after the command completes.
671 */
672 struct completion *completion;
673 union xhci_trb *command_trb;
674 struct list_head cmd_list;
675};
676
a74588f9
SS		 677/* drop context bitmasks */
678#define DROP_EP(x) (0x1 << x)
679/* add context bitmasks */
680#define ADD_EP(x) (0x1 << x)
681
8df75f42
SS		 682struct xhci_stream_ctx {
683 /* 64-bit stream ring address, cycle state, and stream type */
684 u64 stream_ring;
685 /* offset 0x14 - 0x1f reserved for HC internal use */
686 u32 reserved[2];
687};
688
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 */
692#define SCT_SEC_TR 0
693/* Primary stream array type, dequeue pointer is to a transfer ring */
694#define SCT_PRI_TR 1
695/* Dequeue pointer is for a secondary stream array (SSA) with 8 entries */
696#define SCT_SSA_8 2
697#define SCT_SSA_16 3
698#define SCT_SSA_32 4
699#define SCT_SSA_64 5
700#define SCT_SSA_128 6
701#define SCT_SSA_256 7
702
703/* Assume no secondary streams for now */
704struct 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
710 */
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;
717};
718
719#define SMALL_STREAM_ARRAY_SIZE 256
720#define MEDIUM_STREAM_ARRAY_SIZE 1024
721
63a0d9ab
SS		 722struct xhci_virt_ep {
723 struct xhci_ring *ring;
8df75f42
SS		 724 /* Related to endpoints that are configured to use stream IDs only */
725 struct xhci_stream_info *stream_info;
63a0d9ab
SS		 726 /* Temporary storage in case the configure endpoint command fails and we
727 * have to restore the device state to the previous state
728 */
729 struct xhci_ring *new_ring;
730 unsigned int ep_state;
731#define SET_DEQ_PENDING (1 << 0)
678539cf
SS		 732#define EP_HALTED (1 << 1) /* For stall handling */
733#define EP_HALT_PENDING (1 << 2) /* For URB cancellation */
8df75f42
SS		 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)
63a0d9ab
SS		 739 /* ---- Related to URB cancellation ---- */
740 struct list_head cancelled_td_list;
63a0d9ab
SS		 741 /* The TRB that was last reported in a stopped endpoint ring */
742 union xhci_trb *stopped_trb;
743 struct xhci_td *stopped_td;
e9df17eb 744 unsigned int stopped_stream;
6f5165cf
SS		 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;
d18240db
AX		 749 /*
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.
755 */
756 bool skip;
63a0d9ab
SS		 757};
758
3ffbba95 759struct xhci_virt_device {
64927730 760 struct usb_device *udev;
3ffbba95
SS		 761 /*
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.
768 */
d115b048 769 struct xhci_container_ctx *out_ctx;
3ffbba95 770 /* Used for addressing devices and configuration changes */
d115b048 771 struct xhci_container_ctx *in_ctx;
74f9fe21
SS		 772 /* Rings saved to ensure old alt settings can be re-instated */
773 struct xhci_ring **ring_cache;
774 int num_rings_cached;
c8d4af8e
AX		 775 /* Store xHC assigned device address */
776 int address;
74f9fe21 777#define XHCI_MAX_RINGS_CACHED 31
63a0d9ab 778 struct xhci_virt_ep eps[31];
f94e0186 779 struct completion cmd_completion;
3ffbba95
SS		 780 /* Status of the last command issued for this device */
781 u32 cmd_status;
913a8a34 782 struct list_head cmd_list;
be88fe4f 783 u8 port;
3ffbba95
SS		 784};
785
786
a74588f9
SS		 787/**
788 * struct xhci_device_context_array
789 * @dev_context_ptr array of 64-bit DMA addresses for device contexts
790 */
791struct xhci_device_context_array {
792 /* 64-bit device addresses; we only write 32-bit addresses */
8e595a5d 793 u64 dev_context_ptrs[MAX_HC_SLOTS];
a74588f9
SS		 794 /* private xHCD pointers */
795 dma_addr_t dma;
98441973 796};
a74588f9
SS		 797/* TODO: write function to set the 64-bit device DMA address */
798/*
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.
801 */
802
803
0ebbab37
SS		 804struct xhci_transfer_event {
805 /* 64-bit buffer address, or immediate data */
8e595a5d 806 u64 buffer;
0ebbab37
SS		 807 u32 transfer_len;
808 /* This field is interpreted differently based on the type of TRB */
809 u32 flags;
98441973 810};
0ebbab37 811
d0e96f5a
SS		 812/** Transfer Event bit fields **/
813#define TRB_TO_EP_ID(p) (((p) >> 16) & 0x1f)
814
0ebbab37
SS		 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 */
828#define COMP_STALL 6
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
841/* Short Packet */
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 */
866#define COMP_STOP 26
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
885
886struct xhci_link_trb {
887 /* 64-bit segment pointer*/
8e595a5d 888 u64 segment_ptr;
0ebbab37
SS		 889 u32 intr_target;
890 u32 control;
98441973 891};
0ebbab37
SS		 892
893/* control bitfields */
894#define LINK_TOGGLE (0x1<<1)
895
7f84eef0
SS		 896/* Command completion event TRB */
897struct xhci_event_cmd {
898 /* Pointer to command TRB, or the value passed by the event data trb */
8e595a5d 899 u64 cmd_trb;
7f84eef0
SS		 900 u32 status;
901 u32 flags;
98441973 902};
0ebbab37 903
3ffbba95
SS		 904/* flags bitmasks */
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)
0ebbab37 909
ae636747
SS		 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)
913
be88fe4f
AX		 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
917
e9df17eb
SS		 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)
921
ae636747 922
0f2a7930
SS		 923/* Port Status Change Event TRB fields */
924/* Port ID - bits 31:24 */
925#define GET_PORT_ID(p) (((p) & (0xff << 24)) >> 24)
926
0ebbab37
SS		 927/* Normal TRB fields */
928/* transfer_len bitmasks - bits 0:16 */
929#define TRB_LEN(p) ((p) & 0x1ffff)
0ebbab37
SS		 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)
933
934/* Cycle bit - indicates TRB ownership by HC or HCD */
935#define TRB_CYCLE (1<<0)
936/*
937 * Force next event data TRB to be evaluated before task switch.
938 * Used to pass OS data back after a TD completes.
939 */
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)
951
952
953/* Control transfer TRB specific fields */
954#define TRB_DIR_IN (1<<16)
955
04e51901
AX		 956/* Isochronous TRB specific fields */
957#define TRB_SIA (1<<31)
958
7f84eef0
SS		 959struct xhci_generic_trb {
960 u32 field[4];
98441973 961};
7f84eef0
SS		 962
963union xhci_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;
968};
969
0ebbab37
SS		 970/* TRB bit mask */
971#define TRB_TYPE_BITMASK (0xfc00)
972#define TRB_TYPE(p) ((p) << 10)
0238634d 973#define TRB_FIELD_TO_TYPE(p) (((p) & TRB_TYPE_BITMASK) >> 10)
0ebbab37
SS		 974/* TRB type IDs */
975/* bulk, interrupt, isoc scatter/gather, and control data stage */
976#define TRB_NORMAL 1
977/* setup stage for control transfers */
978#define TRB_SETUP 2
979/* data stage for control transfers */
980#define TRB_DATA 3
981/* status stage for control transfers */
982#define TRB_STATUS 4
983/* isoc transfers */
984#define TRB_ISOC 5
985/* TRB for linking ring segments */
986#define TRB_LINK 6
987#define TRB_EVENT_DATA 7
988/* Transfer Ring No-op (not for the command ring) */
989#define TRB_TR_NOOP 8
990/* Command TRBs */
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
a1587d97
SS		 1001/* Reset Endpoint Command */
1002#define TRB_RESET_EP 14
0ebbab37
SS		 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 */
1022/* Event TRBS */
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 */
1040
0238634d
SS		 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
1045
1046#define NEC_FW_MINOR(p) (((p) >> 0) & 0xff)
1047#define NEC_FW_MAJOR(p) (((p) >> 8) & 0xff)
1048
0ebbab37
SS		 1049/*
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.
1053 */
1054#define TRBS_PER_SEGMENT 64
913a8a34
SS		 1055/* Allow two commands + a link TRB, along with any reserved command TRBs */
1056#define MAX_RSVD_CMD_TRBS (TRBS_PER_SEGMENT - 3)
0ebbab37 1057#define SEGMENT_SIZE (TRBS_PER_SEGMENT*16)
8df75f42
SS		 1058/* SEGMENT_SHIFT should be log2(SEGMENT_SIZE).
1059 * Change this if you change TRBS_PER_SEGMENT!
1060 */
1061#define SEGMENT_SHIFT 10
b10de142
SS		 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)
0ebbab37
SS		 1065
1066struct xhci_segment {
1067 union xhci_trb *trbs;
1068 /* private to HCD */
1069 struct xhci_segment *next;
1070 dma_addr_t dma;
98441973 1071};
0ebbab37 1072
ae636747
SS		 1073struct xhci_td {
1074 struct list_head td_list;
1075 struct list_head cancelled_td_list;
1076 struct urb *urb;
1077 struct xhci_segment *start_seg;
1078 union xhci_trb *first_trb;
1079 union xhci_trb *last_trb;
1080};
1081
ac9d8fe7
SS		 1082struct xhci_dequeue_state {
1083 struct xhci_segment *new_deq_seg;
1084 union xhci_trb *new_deq_ptr;
1085 int new_cycle_state;
1086};
1087
0ebbab37
SS		 1088struct xhci_ring {
1089 struct xhci_segment *first_seg;
1090 union xhci_trb *enqueue;
7f84eef0
SS		 1091 struct xhci_segment *enq_seg;
1092 unsigned int enq_updates;
0ebbab37 1093 union xhci_trb *dequeue;
7f84eef0
SS		 1094 struct xhci_segment *deq_seg;
1095 unsigned int deq_updates;
d0e96f5a 1096 struct list_head td_list;
0ebbab37
SS		 1097 /*
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.
1101 */
1102 u32 cycle_state;
e9df17eb 1103 unsigned int stream_id;
0ebbab37
SS		 1104};
1105
1106struct xhci_erst_entry {
1107 /* 64-bit event ring segment address */
8e595a5d 1108 u64 seg_addr;
0ebbab37
SS		 1109 u32 seg_size;
1110 /* Set to zero */
1111 u32 rsvd;
98441973 1112};
0ebbab37
SS		 1113
1114struct xhci_erst {
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;
1121};
1122
254c80a3
JY		 1123struct xhci_scratchpad {
1124 u64 *sp_array;
1125 dma_addr_t sp_dma;
1126 void **sp_buffers;
1127 dma_addr_t *sp_dma_buffers;
1128};
1129
8e51adcc
AX		 1130struct urb_priv {
1131 int length;
1132 int td_cnt;
1133 struct xhci_td *td[0];
1134};
1135
0ebbab37
SS		 1136/*
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
7f84eef0
SS		 1146/* Poll every 60 seconds */
1147#define POLL_TIMEOUT 60
6f5165cf
SS		 1148/* Stop endpoint command timeout (secs) for URB cancellation watchdog timer */
1149#define XHCI_STOP_EP_CMD_TIMEOUT 5
0ebbab37
SS		 1150/* XXX: Make these module parameters */
1151
5535b1d5
AX		 1152struct s3_save {
1153 u32 command;
1154 u32 dev_nt;
1155 u64 dcbaa_ptr;
1156 u32 config_reg;
1157 u32 irq_pending;
1158 u32 irq_control;
1159 u32 erst_size;
1160 u64 erst_base;
1161 u64 erst_dequeue;
1162};
74c68741 1163
20b67cf5
SS		 1164struct xhci_bus_state {
1165 unsigned long bus_suspended;
1166 unsigned long next_statechange;
1167
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 */
1170 u32 port_c_suspend;
1171 u32 suspended_ports;
1172 unsigned long resume_done[USB_MAXCHILDREN];
1173};
1174
1175static inline unsigned int hcd_index(struct usb_hcd *hcd)
1176{
f6ff0ac8
SS		 1177 if (hcd->speed == HCD_USB3)
1178 return 0;
1179 else
1180 return 1;
20b67cf5
SS		 1181}
1182
74c68741
SS		 1183/* There is one ehci_hci structure per controller */
1184struct xhci_hcd {
b02d0ed6 1185 struct usb_hcd *main_hcd;
f6ff0ac8 1186 struct usb_hcd *shared_hcd;
74c68741
SS		 1187 /* glue to PCI and HCD framework */
1188 struct xhci_cap_regs __iomem *cap_regs;
1189 struct xhci_op_regs __iomem *op_regs;
1190 struct xhci_run_regs __iomem *run_regs;
0ebbab37 1191 struct xhci_doorbell_array __iomem *dba;
66d4eadd 1192 /* Our HCD's current interrupter register set */
98441973 1193 struct xhci_intr_reg __iomem *ir_set;
74c68741
SS		 1194
1195 /* Cached register copies of read-only HC data */
1196 __u32 hcs_params1;
1197 __u32 hcs_params2;
1198 __u32 hcs_params3;
1199 __u32 hcc_params;
1200
1201 spinlock_t lock;
1202
1203 /* packed release number */
1204 u8 sbrn;
1205 u16 hci_version;
1206 u8 max_slots;
1207 u8 max_interrupters;
1208 u8 max_ports;
1209 u8 isoc_threshold;
1210 int event_ring_max;
1211 int addr_64;
66d4eadd 1212 /* 4KB min, 128MB max */
74c68741 1213 int page_size;
66d4eadd
SS		 1214 /* Valid values are 12 to 20, inclusive */
1215 int page_shift;
43b86af8 1216 /* msi-x vectors */
66d4eadd
SS		 1217 int msix_count;
1218 struct msix_entry *msix_entries;
0ebbab37 1219 /* data structures */
a74588f9 1220 struct xhci_device_context_array *dcbaa;
0ebbab37 1221 struct xhci_ring *cmd_ring;
913a8a34 1222 unsigned int cmd_ring_reserved_trbs;
0ebbab37
SS		 1223 struct xhci_ring *event_ring;
1224 struct xhci_erst erst;
254c80a3
JY		 1225 /* Scratchpad */
1226 struct xhci_scratchpad *scratchpad;
1227
3ffbba95
SS		 1228 /* slot enabling and address device helpers */
1229 struct completion addr_dev;
1230 int slot_id;
1231 /* Internal mirror of the HW's dcbaa */
1232 struct xhci_virt_device *devs[MAX_HC_SLOTS];
0ebbab37
SS		 1233
1234 /* DMA pools */
1235 struct dma_pool *device_pool;
1236 struct dma_pool *segment_pool;
8df75f42
SS		 1237 struct dma_pool *small_streams_pool;
1238 struct dma_pool *medium_streams_pool;
7f84eef0
SS		 1239
1240#ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
1241 /* Poll the rings - for debugging */
1242 struct timer_list event_ring_timer;
1243 int zombie;
1244#endif
6f5165cf
SS		 1245 /* Host controller watchdog timer structures */
1246 unsigned int xhc_state;
9777e3ce 1247
9777e3ce 1248 u32 command;
5535b1d5 1249 struct s3_save s3;
6f5165cf
SS		 1250/* Host controller is dying - not responding to commands. "I'm not dead yet!"
1251 *
1252 * xHC interrupts have been disabled and a watchdog timer will (or has already)
1253 * halt the xHCI host, and complete all URBs with an -ESHUTDOWN code. Any code
1254 * that sees this status (other than the timer that set it) should stop touching
1255 * hardware immediately. Interrupt handlers should return immediately when
1256 * they see this status (any time they drop and re-acquire xhci->lock).
1257 * xhci_urb_dequeue() should call usb_hcd_check_unlink_urb() and return without
1258 * putting the TD on the canceled list, etc.
1259 *
1260 * There are no reports of xHCI host controllers that display this issue.
1261 */
1262#define XHCI_STATE_DYING (1 << 0)
c6cc27c7 1263#define XHCI_STATE_HALTED (1 << 1)
7f84eef0 1264 /* Statistics */
7f84eef0 1265 int error_bitmask;
b0567b3f
SS		 1266 unsigned int quirks;
1267#define XHCI_LINK_TRB_QUIRK (1 << 0)
ac9d8fe7 1268#define XHCI_RESET_EP_QUIRK (1 << 1)
0238634d 1269#define XHCI_NEC_HOST (1 << 2)
f6ff0ac8
SS		 1270 /* There are two roothubs to keep track of bus suspend info for */
1271 struct xhci_bus_state bus_state[2];
da6699ce
SS		 1272 /* Is each xHCI roothub port a USB 3.0, USB 2.0, or USB 1.1 port? */
1273 u8 *port_array;
1274 /* Array of pointers to USB 3.0 PORTSC registers */
1275 u32 __iomem **usb3_ports;
1276 unsigned int num_usb3_ports;
1277 /* Array of pointers to USB 2.0 PORTSC registers */
1278 u32 __iomem **usb2_ports;
1279 unsigned int num_usb2_ports;
74c68741
SS		 1280};
1281
1282/* convert between an HCD pointer and the corresponding EHCI_HCD */
1283static inline struct xhci_hcd *hcd_to_xhci(struct usb_hcd *hcd)
1284{
b02d0ed6 1285 return *((struct xhci_hcd **) (hcd->hcd_priv));
74c68741
SS		 1286}
1287
1288static inline struct usb_hcd *xhci_to_hcd(struct xhci_hcd *xhci)
1289{
b02d0ed6 1290 return xhci->main_hcd;
74c68741
SS		 1291}
1292
1293#ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
1294#define XHCI_DEBUG 1
1295#else
1296#define XHCI_DEBUG 0
1297#endif
1298
1299#define xhci_dbg(xhci, fmt, args...) \
1300 do { if (XHCI_DEBUG) dev_dbg(xhci_to_hcd(xhci)->self.controller , fmt , ## args); } while (0)
1301#define xhci_info(xhci, fmt, args...) \
1302 do { if (XHCI_DEBUG) dev_info(xhci_to_hcd(xhci)->self.controller , fmt , ## args); } while (0)
1303#define xhci_err(xhci, fmt, args...) \
1304 dev_err(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1305#define xhci_warn(xhci, fmt, args...) \
1306 dev_warn(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1307
1308/* TODO: copied from ehci.h - can be refactored? */
1309/* xHCI spec says all registers are little endian */
1310static inline unsigned int xhci_readl(const struct xhci_hcd *xhci,
1311 __u32 __iomem *regs)
1312{
1313 return readl(regs);
1314}
045f123d 1315static inline void xhci_writel(struct xhci_hcd *xhci,
74c68741
SS		 1316 const unsigned int val, __u32 __iomem *regs)
1317{
66e49d87
SS		 1318 xhci_dbg(xhci,
1319 "`MEM_WRITE_DWORD(3'b000, 32'h%p, 32'h%0x, 4'hf);\n",
1320 regs, val);
74c68741
SS		 1321 writel(val, regs);
1322}
1323
8e595a5d
SS		 1324/*
1325 * Registers should always be accessed with double word or quad word accesses.
1326 *
1327 * Some xHCI implementations may support 64-bit address pointers. Registers
1328 * with 64-bit address pointers should be written to with dword accesses by
1329 * writing the low dword first (ptr[0]), then the high dword (ptr[1]) second.
1330 * xHCI implementations that do not support 64-bit address pointers will ignore
1331 * the high dword, and write order is irrelevant.
1332 */
1333static inline u64 xhci_read_64(const struct xhci_hcd *xhci,
1334 __u64 __iomem *regs)
1335{
1336 __u32 __iomem *ptr = (__u32 __iomem *) regs;
1337 u64 val_lo = readl(ptr);
1338 u64 val_hi = readl(ptr + 1);
1339 return val_lo + (val_hi << 32);
1340}
1341static inline void xhci_write_64(struct xhci_hcd *xhci,
1342 const u64 val, __u64 __iomem *regs)
1343{
1344 __u32 __iomem *ptr = (__u32 __iomem *) regs;
1345 u32 val_lo = lower_32_bits(val);
1346 u32 val_hi = upper_32_bits(val);
1347
66e49d87
SS		 1348 xhci_dbg(xhci,
1349 "`MEM_WRITE_DWORD(3'b000, 64'h%p, 64'h%0lx, 4'hf);\n",
1350 regs, (long unsigned int) val);
8e595a5d
SS		 1351 writel(val_lo, ptr);
1352 writel(val_hi, ptr + 1);
1353}
1354
b0567b3f
SS		 1355static inline int xhci_link_trb_quirk(struct xhci_hcd *xhci)
1356{
1357 u32 temp = xhci_readl(xhci, &xhci->cap_regs->hc_capbase);
1358 return ((HC_VERSION(temp) == 0x95) &&
1359 (xhci->quirks & XHCI_LINK_TRB_QUIRK));
1360}
1361
66d4eadd 1362/* xHCI debugging */
98441973 1363void xhci_print_ir_set(struct xhci_hcd *xhci, struct xhci_intr_reg *ir_set, int set_num);
66d4eadd 1364void xhci_print_registers(struct xhci_hcd *xhci);
0ebbab37
SS		 1365void xhci_dbg_regs(struct xhci_hcd *xhci);
1366void xhci_print_run_regs(struct xhci_hcd *xhci);
d0e96f5a
SS		 1367void xhci_print_trb_offsets(struct xhci_hcd *xhci, union xhci_trb *trb);
1368void xhci_debug_trb(struct xhci_hcd *xhci, union xhci_trb *trb);
7f84eef0 1369void xhci_debug_segment(struct xhci_hcd *xhci, struct xhci_segment *seg);
0ebbab37
SS		 1370void xhci_debug_ring(struct xhci_hcd *xhci, struct xhci_ring *ring);
1371void xhci_dbg_erst(struct xhci_hcd *xhci, struct xhci_erst *erst);
1372void xhci_dbg_cmd_ptrs(struct xhci_hcd *xhci);
7f84eef0 1373void xhci_dbg_ring_ptrs(struct xhci_hcd *xhci, struct xhci_ring *ring);
d115b048 1374void xhci_dbg_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned int last_ep);
9c9a7dbf 1375char *xhci_get_slot_state(struct xhci_hcd *xhci,
2a8f82c4 1376 struct xhci_container_ctx *ctx);
e9df17eb
SS		 1377void xhci_dbg_ep_rings(struct xhci_hcd *xhci,
1378 unsigned int slot_id, unsigned int ep_index,
1379 struct xhci_virt_ep *ep);
66d4eadd 1380
3dbda77e 1381/* xHCI memory management */
66d4eadd
SS		 1382void xhci_mem_cleanup(struct xhci_hcd *xhci);
1383int xhci_mem_init(struct xhci_hcd *xhci, gfp_t flags);
3ffbba95
SS		 1384void xhci_free_virt_device(struct xhci_hcd *xhci, int slot_id);
1385int xhci_alloc_virt_device(struct xhci_hcd *xhci, int slot_id, struct usb_device *udev, gfp_t flags);
1386int xhci_setup_addressable_virt_dev(struct xhci_hcd *xhci, struct usb_device *udev);
2d1ee590
SS		 1387void xhci_copy_ep0_dequeue_into_input_ctx(struct xhci_hcd *xhci,
1388 struct usb_device *udev);
d0e96f5a 1389unsigned int xhci_get_endpoint_index(struct usb_endpoint_descriptor *desc);
f94e0186 1390unsigned int xhci_get_endpoint_flag(struct usb_endpoint_descriptor *desc);
ac9d8fe7
SS		 1391unsigned int xhci_get_endpoint_flag_from_index(unsigned int ep_index);
1392unsigned int xhci_last_valid_endpoint(u32 added_ctxs);
f94e0186 1393void xhci_endpoint_zero(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev, struct usb_host_endpoint *ep);
f2217e8e 1394void xhci_endpoint_copy(struct xhci_hcd *xhci,
913a8a34
SS		 1395 struct xhci_container_ctx *in_ctx,
1396 struct xhci_container_ctx *out_ctx,
1397 unsigned int ep_index);
1398void xhci_slot_copy(struct xhci_hcd *xhci,
1399 struct xhci_container_ctx *in_ctx,
1400 struct xhci_container_ctx *out_ctx);
f88ba78d
SS		 1401int xhci_endpoint_init(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev,
1402 struct usb_device *udev, struct usb_host_endpoint *ep,
1403 gfp_t mem_flags);
f94e0186 1404void xhci_ring_free(struct xhci_hcd *xhci, struct xhci_ring *ring);
412566bd
SS		 1405void xhci_free_or_cache_endpoint_ring(struct xhci_hcd *xhci,
1406 struct xhci_virt_device *virt_dev,
1407 unsigned int ep_index);
8df75f42
SS		 1408struct xhci_stream_info *xhci_alloc_stream_info(struct xhci_hcd *xhci,
1409 unsigned int num_stream_ctxs,
1410 unsigned int num_streams, gfp_t flags);
1411void xhci_free_stream_info(struct xhci_hcd *xhci,
1412 struct xhci_stream_info *stream_info);
1413void xhci_setup_streams_ep_input_ctx(struct xhci_hcd *xhci,
1414 struct xhci_ep_ctx *ep_ctx,
1415 struct xhci_stream_info *stream_info);
1416void xhci_setup_no_streams_ep_input_ctx(struct xhci_hcd *xhci,
1417 struct xhci_ep_ctx *ep_ctx,
1418 struct xhci_virt_ep *ep);
e9df17eb
SS		 1419struct xhci_ring *xhci_dma_to_transfer_ring(
1420 struct xhci_virt_ep *ep,
1421 u64 address);
e9df17eb
SS		 1422struct xhci_ring *xhci_stream_id_to_ring(
1423 struct xhci_virt_device *dev,
1424 unsigned int ep_index,
1425 unsigned int stream_id);
913a8a34 1426struct xhci_command *xhci_alloc_command(struct xhci_hcd *xhci,
a1d78c16
SS		 1427 bool allocate_in_ctx, bool allocate_completion,
1428 gfp_t mem_flags);
8e51adcc 1429void xhci_urb_free_priv(struct xhci_hcd *xhci, struct urb_priv *urb_priv);
913a8a34
SS		 1430void xhci_free_command(struct xhci_hcd *xhci,
1431 struct xhci_command *command);
66d4eadd
SS		 1432
1433#ifdef CONFIG_PCI
1434/* xHCI PCI glue */
1435int xhci_register_pci(void);
1436void xhci_unregister_pci(void);
1437#endif
1438
1439/* xHCI host controller glue */
4f0f0bae 1440void xhci_quiesce(struct xhci_hcd *xhci);
66d4eadd
SS		 1441int xhci_halt(struct xhci_hcd *xhci);
1442int xhci_reset(struct xhci_hcd *xhci);
1443int xhci_init(struct usb_hcd *hcd);
1444int xhci_run(struct usb_hcd *hcd);
1445void xhci_stop(struct usb_hcd *hcd);
1446void xhci_shutdown(struct usb_hcd *hcd);
436a3890
SS		 1447
1448#ifdef CONFIG_PM
5535b1d5
AX		 1449int xhci_suspend(struct xhci_hcd *xhci);
1450int xhci_resume(struct xhci_hcd *xhci, bool hibernated);
436a3890
SS		 1451#else
1452#define xhci_suspend NULL
1453#define xhci_resume NULL
1454#endif
1455
66d4eadd 1456int xhci_get_frame(struct usb_hcd *hcd);
7f84eef0 1457irqreturn_t xhci_irq(struct usb_hcd *hcd);
9032cd52 1458irqreturn_t xhci_msi_irq(int irq, struct usb_hcd *hcd);
3ffbba95
SS		 1459int xhci_alloc_dev(struct usb_hcd *hcd, struct usb_device *udev);
1460void xhci_free_dev(struct usb_hcd *hcd, struct usb_device *udev);
8df75f42
SS		 1461int xhci_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
1462 struct usb_host_endpoint **eps, unsigned int num_eps,
1463 unsigned int num_streams, gfp_t mem_flags);
1464int xhci_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
1465 struct usb_host_endpoint **eps, unsigned int num_eps,
1466 gfp_t mem_flags);
3ffbba95 1467int xhci_address_device(struct usb_hcd *hcd, struct usb_device *udev);
ac1c1b7f
SS		 1468int xhci_update_hub_device(struct usb_hcd *hcd, struct usb_device *hdev,
1469 struct usb_tt *tt, gfp_t mem_flags);
d0e96f5a
SS		 1470int xhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb, gfp_t mem_flags);
1471int xhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status);
f94e0186
SS		 1472int xhci_add_endpoint(struct usb_hcd *hcd, struct usb_device *udev, struct usb_host_endpoint *ep);
1473int xhci_drop_endpoint(struct usb_hcd *hcd, struct usb_device *udev, struct usb_host_endpoint *ep);
a1587d97 1474void xhci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep);
f0615c45 1475int xhci_discover_or_reset_device(struct usb_hcd *hcd, struct usb_device *udev);
f94e0186
SS		 1476int xhci_check_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
1477void xhci_reset_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
7f84eef0
SS		 1478
1479/* xHCI ring, segment, TRB, and TD functions */
23e3be11 1480dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg, union xhci_trb *trb);
6648f29d
SS		 1481struct xhci_segment *trb_in_td(struct xhci_segment *start_seg,
1482 union xhci_trb *start_trb, union xhci_trb *end_trb,
1483 dma_addr_t suspect_dma);
b45b5069 1484int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code);
23e3be11 1485void xhci_ring_cmd_db(struct xhci_hcd *xhci);
23e3be11
SS		 1486int xhci_queue_slot_control(struct xhci_hcd *xhci, u32 trb_type, u32 slot_id);
1487int xhci_queue_address_device(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1488 u32 slot_id);
0238634d
SS		 1489int xhci_queue_vendor_command(struct xhci_hcd *xhci,
1490 u32 field1, u32 field2, u32 field3, u32 field4);
23e3be11 1491int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, int slot_id,
be88fe4f 1492 unsigned int ep_index, int suspend);
23e3be11
SS		 1493int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1494 int slot_id, unsigned int ep_index);
1495int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1496 int slot_id, unsigned int ep_index);
624defa1
SS		 1497int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1498 int slot_id, unsigned int ep_index);
04e51901
AX		 1499int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
1500 struct urb *urb, int slot_id, unsigned int ep_index);
23e3be11 1501int xhci_queue_configure_endpoint(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
913a8a34 1502 u32 slot_id, bool command_must_succeed);
f2217e8e 1503int xhci_queue_evaluate_context(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
23e3be11 1504 u32 slot_id);
a1587d97
SS		 1505int xhci_queue_reset_ep(struct xhci_hcd *xhci, int slot_id,
1506 unsigned int ep_index);
2a8f82c4 1507int xhci_queue_reset_device(struct xhci_hcd *xhci, u32 slot_id);
c92bcfa7
SS		 1508void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
1509 unsigned int slot_id, unsigned int ep_index,
e9df17eb
SS		 1510 unsigned int stream_id, struct xhci_td *cur_td,
1511 struct xhci_dequeue_state *state);
c92bcfa7 1512void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
63a0d9ab 1513 unsigned int slot_id, unsigned int ep_index,
e9df17eb 1514 unsigned int stream_id,
63a0d9ab 1515 struct xhci_dequeue_state *deq_state);
82d1009f 1516void xhci_cleanup_stalled_ring(struct xhci_hcd *xhci,
63a0d9ab 1517 struct usb_device *udev, unsigned int ep_index);
ac9d8fe7
SS		 1518void xhci_queue_config_ep_quirk(struct xhci_hcd *xhci,
1519 unsigned int slot_id, unsigned int ep_index,
1520 struct xhci_dequeue_state *deq_state);
6f5165cf 1521void xhci_stop_endpoint_command_watchdog(unsigned long arg);
be88fe4f
AX		 1522void xhci_ring_ep_doorbell(struct xhci_hcd *xhci, unsigned int slot_id,
1523 unsigned int ep_index, unsigned int stream_id);
66d4eadd 1524
0f2a7930
SS		 1525/* xHCI roothub code */
1526int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue, u16 wIndex,
1527 char *buf, u16 wLength);
1528int xhci_hub_status_data(struct usb_hcd *hcd, char *buf);
436a3890
SS		 1529
1530#ifdef CONFIG_PM
9777e3ce
AX		 1531int xhci_bus_suspend(struct usb_hcd *hcd);
1532int xhci_bus_resume(struct usb_hcd *hcd);
436a3890
SS		 1533#else
1534#define xhci_bus_suspend NULL
1535#define xhci_bus_resume NULL
1536#endif /* CONFIG_PM */
1537
56192531 1538u32 xhci_port_state_to_neutral(u32 state);
5233630f
SS		 1539int xhci_find_slot_id_by_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
1540 u16 port);
56192531 1541void xhci_ring_device(struct xhci_hcd *xhci, int slot_id);
0f2a7930 1542
d115b048
JY		 1543/* xHCI contexts */
1544struct xhci_input_control_ctx *xhci_get_input_control_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx);
1545struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx);
1546struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned int ep_index);
1547
74c68741 1548#endif /* __LINUX_XHCI_HCD_H */
Linux 6.x block layer and io_uring tree(s)