projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
xHCI: test USB2 software LPM
[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"
c41136b0 33#include "pci-quirks.h"
74c68741
SS		 34
35/* xHCI PCI Configuration Registers */
36#define XHCI_SBRN_OFFSET (0x60)
37
66d4eadd
SS		 38/* Max number of USB devices for any host controller - limit in section 6.1 */
39#define MAX_HC_SLOTS 256
0f2a7930
SS		 40/* Section 5.3.3 - MaxPorts */
41#define MAX_HC_PORTS 127
66d4eadd 42
74c68741
SS		 43/*
44 * xHCI register interface.
45 * This corresponds to the eXtensible Host Controller Interface (xHCI)
46 * Revision 0.95 specification
74c68741
SS		 47 */
48
49/**
50 * struct xhci_cap_regs - xHCI Host Controller Capability Registers.
51 * @hc_capbase: length of the capabilities register and HC version number
52 * @hcs_params1: HCSPARAMS1 - Structural Parameters 1
53 * @hcs_params2: HCSPARAMS2 - Structural Parameters 2
54 * @hcs_params3: HCSPARAMS3 - Structural Parameters 3
55 * @hcc_params: HCCPARAMS - Capability Parameters
56 * @db_off: DBOFF - Doorbell array offset
57 * @run_regs_off: RTSOFF - Runtime register space offset
58 */
59struct xhci_cap_regs {
28ccd296
ME		 60 __le32 hc_capbase;
61 __le32 hcs_params1;
62 __le32 hcs_params2;
63 __le32 hcs_params3;
64 __le32 hcc_params;
65 __le32 db_off;
66 __le32 run_regs_off;
74c68741 67 /* Reserved up to (CAPLENGTH - 0x1C) */
98441973 68};
74c68741
SS		 69
70/* hc_capbase bitmasks */
71/* bits 7:0 - how long is the Capabilities register */
72#define HC_LENGTH(p) XHCI_HC_LENGTH(p)
73/* bits 31:16 */
74#define HC_VERSION(p) (((p) >> 16) & 0xffff)
75
76/* HCSPARAMS1 - hcs_params1 - bitmasks */
77/* bits 0:7, Max Device Slots */
78#define HCS_MAX_SLOTS(p) (((p) >> 0) & 0xff)
79#define HCS_SLOTS_MASK 0xff
80/* bits 8:18, Max Interrupters */
81#define HCS_MAX_INTRS(p) (((p) >> 8) & 0x7ff)
82/* bits 24:31, Max Ports - max value is 0x7F = 127 ports */
83#define HCS_MAX_PORTS(p) (((p) >> 24) & 0x7f)
84
85/* HCSPARAMS2 - hcs_params2 - bitmasks */
86/* bits 0:3, frames or uframes that SW needs to queue transactions
87 * ahead of the HW to meet periodic deadlines */
88#define HCS_IST(p) (((p) >> 0) & 0xf)
89/* bits 4:7, max number of Event Ring segments */
90#define HCS_ERST_MAX(p) (((p) >> 4) & 0xf)
91/* bit 26 Scratchpad restore - for save/restore HW state - not used yet */
92/* bits 27:31 number of Scratchpad buffers SW must allocate for the HW */
254c80a3 93#define HCS_MAX_SCRATCHPAD(p) (((p) >> 27) & 0x1f)
74c68741
SS		 94
95/* HCSPARAMS3 - hcs_params3 - bitmasks */
96/* bits 0:7, Max U1 to U0 latency for the roothub ports */
97#define HCS_U1_LATENCY(p) (((p) >> 0) & 0xff)
98/* bits 16:31, Max U2 to U0 latency for the roothub ports */
99#define HCS_U2_LATENCY(p) (((p) >> 16) & 0xffff)
100
101/* HCCPARAMS - hcc_params - bitmasks */
102/* true: HC can use 64-bit address pointers */
103#define HCC_64BIT_ADDR(p) ((p) & (1 << 0))
104/* true: HC can do bandwidth negotiation */
105#define HCC_BANDWIDTH_NEG(p) ((p) & (1 << 1))
106/* true: HC uses 64-byte Device Context structures
107 * FIXME 64-byte context structures aren't supported yet.
108 */
109#define HCC_64BYTE_CONTEXT(p) ((p) & (1 << 2))
110/* true: HC has port power switches */
111#define HCC_PPC(p) ((p) & (1 << 3))
112/* true: HC has port indicators */
113#define HCS_INDICATOR(p) ((p) & (1 << 4))
114/* true: HC has Light HC Reset Capability */
115#define HCC_LIGHT_RESET(p) ((p) & (1 << 5))
116/* true: HC supports latency tolerance messaging */
117#define HCC_LTC(p) ((p) & (1 << 6))
118/* true: no secondary Stream ID Support */
119#define HCC_NSS(p) ((p) & (1 << 7))
120/* Max size for Primary Stream Arrays - 2^(n+1), where n is bits 12:15 */
8df75f42 121#define HCC_MAX_PSA(p) (1 << ((((p) >> 12) & 0xf) + 1))
74c68741
SS		 122/* Extended Capabilities pointer from PCI base - section 5.3.6 */
123#define HCC_EXT_CAPS(p) XHCI_HCC_EXT_CAPS(p)
124
125/* db_off bitmask - bits 0:1 reserved */
126#define DBOFF_MASK (~0x3)
127
128/* run_regs_off bitmask - bits 0:4 reserved */
129#define RTSOFF_MASK (~0x1f)
130
131
132/* Number of registers per port */
133#define NUM_PORT_REGS 4
134
135/**
136 * struct xhci_op_regs - xHCI Host Controller Operational Registers.
137 * @command: USBCMD - xHC command register
138 * @status: USBSTS - xHC status register
139 * @page_size: This indicates the page size that the host controller
140 * supports. If bit n is set, the HC supports a page size
141 * of 2^(n+12), up to a 128MB page size.
142 * 4K is the minimum page size.
143 * @cmd_ring: CRP - 64-bit Command Ring Pointer
144 * @dcbaa_ptr: DCBAAP - 64-bit Device Context Base Address Array Pointer
145 * @config_reg: CONFIG - Configure Register
146 * @port_status_base: PORTSCn - base address for Port Status and Control
147 * Each port has a Port Status and Control register,
148 * followed by a Port Power Management Status and Control
149 * register, a Port Link Info register, and a reserved
150 * register.
151 * @port_power_base: PORTPMSCn - base address for
152 * Port Power Management Status and Control
153 * @port_link_base: PORTLIn - base address for Port Link Info (current
154 * Link PM state and control) for USB 2.1 and USB 3.0
155 * devices.
156 */
157struct xhci_op_regs {
28ccd296
ME		 158 __le32 command;
159 __le32 status;
160 __le32 page_size;
161 __le32 reserved1;
162 __le32 reserved2;
163 __le32 dev_notification;
164 __le64 cmd_ring;
74c68741 165 /* rsvd: offset 0x20-2F */
28ccd296
ME		 166 __le32 reserved3[4];
167 __le64 dcbaa_ptr;
168 __le32 config_reg;
74c68741 169 /* rsvd: offset 0x3C-3FF */
28ccd296 170 __le32 reserved4[241];
74c68741 171 /* port 1 registers, which serve as a base address for other ports */
28ccd296
ME		 172 __le32 port_status_base;
173 __le32 port_power_base;
174 __le32 port_link_base;
175 __le32 reserved5;
74c68741 176 /* registers for ports 2-255 */
28ccd296 177 __le32 reserved6[NUM_PORT_REGS*254];
98441973 178};
74c68741
SS		 179
180/* USBCMD - USB command - command bitmasks */
181/* start/stop HC execution - do not write unless HC is halted*/
182#define CMD_RUN XHCI_CMD_RUN
183/* Reset HC - resets internal HC state machine and all registers (except
184 * PCI config regs). HC does NOT drive a USB reset on the downstream ports.
185 * The xHCI driver must reinitialize the xHC after setting this bit.
186 */
187#define CMD_RESET (1 << 1)
188/* Event Interrupt Enable - a '1' allows interrupts from the host controller */
189#define CMD_EIE XHCI_CMD_EIE
190/* Host System Error Interrupt Enable - get out-of-band signal for HC errors */
191#define CMD_HSEIE XHCI_CMD_HSEIE
192/* bits 4:6 are reserved (and should be preserved on writes). */
193/* light reset (port status stays unchanged) - reset completed when this is 0 */
194#define CMD_LRESET (1 << 7)
5535b1d5 195/* host controller save/restore state. */
74c68741
SS		 196#define CMD_CSS (1 << 8)
197#define CMD_CRS (1 << 9)
198/* Enable Wrap Event - '1' means xHC generates an event when MFINDEX wraps. */
199#define CMD_EWE XHCI_CMD_EWE
200/* MFINDEX power management - '1' means xHC can stop MFINDEX counter if all root
201 * hubs are in U3 (selective suspend), disconnect, disabled, or powered-off.
202 * '0' means the xHC can power it off if all ports are in the disconnect,
203 * disabled, or powered-off state.
204 */
205#define CMD_PM_INDEX (1 << 11)
206/* bits 12:31 are reserved (and should be preserved on writes). */
207
208/* USBSTS - USB status - status bitmasks */
209/* HC not running - set to 1 when run/stop bit is cleared. */
210#define STS_HALT XHCI_STS_HALT
211/* serious error, e.g. PCI parity error. The HC will clear the run/stop bit. */
212#define STS_FATAL (1 << 2)
213/* event interrupt - clear this prior to clearing any IP flags in IR set*/
214#define STS_EINT (1 << 3)
215/* port change detect */
216#define STS_PORT (1 << 4)
217/* bits 5:7 reserved and zeroed */
218/* save state status - '1' means xHC is saving state */
219#define STS_SAVE (1 << 8)
220/* restore state status - '1' means xHC is restoring state */
221#define STS_RESTORE (1 << 9)
222/* true: save or restore error */
223#define STS_SRE (1 << 10)
224/* true: Controller Not Ready to accept doorbell or op reg writes after reset */
225#define STS_CNR XHCI_STS_CNR
226/* true: internal Host Controller Error - SW needs to reset and reinitialize */
227#define STS_HCE (1 << 12)
228/* bits 13:31 reserved and should be preserved */
229
230/*
231 * DNCTRL - Device Notification Control Register - dev_notification bitmasks
232 * Generate a device notification event when the HC sees a transaction with a
233 * notification type that matches a bit set in this bit field.
234 */
235#define DEV_NOTE_MASK (0xffff)
5a6c2f3f 236#define ENABLE_DEV_NOTE(x) (1 << (x))
74c68741
SS		 237/* Most of the device notification types should only be used for debug.
238 * SW does need to pay attention to function wake notifications.
239 */
240#define DEV_NOTE_FWAKE ENABLE_DEV_NOTE(1)
241
0ebbab37
SS		 242/* CRCR - Command Ring Control Register - cmd_ring bitmasks */
243/* bit 0 is the command ring cycle state */
244/* stop ring operation after completion of the currently executing command */
245#define CMD_RING_PAUSE (1 << 1)
246/* stop ring immediately - abort the currently executing command */
247#define CMD_RING_ABORT (1 << 2)
248/* true: command ring is running */
249#define CMD_RING_RUNNING (1 << 3)
250/* bits 4:5 reserved and should be preserved */
251/* Command Ring pointer - bit mask for the lower 32 bits. */
8e595a5d 252#define CMD_RING_RSVD_BITS (0x3f)
0ebbab37 253
74c68741
SS		 254/* CONFIG - Configure Register - config_reg bitmasks */
255/* bits 0:7 - maximum number of device slots enabled (NumSlotsEn) */
256#define MAX_DEVS(p) ((p) & 0xff)
257/* bits 8:31 - reserved and should be preserved */
258
259/* PORTSC - Port Status and Control Register - port_status_base bitmasks */
260/* true: device connected */
261#define PORT_CONNECT (1 << 0)
262/* true: port enabled */
263#define PORT_PE (1 << 1)
264/* bit 2 reserved and zeroed */
265/* true: port has an over-current condition */
266#define PORT_OC (1 << 3)
267/* true: port reset signaling asserted */
268#define PORT_RESET (1 << 4)
269/* Port Link State - bits 5:8
270 * A read gives the current link PM state of the port,
271 * a write with Link State Write Strobe set sets the link state.
272 */
be88fe4f
AX		 273#define PORT_PLS_MASK (0xf << 5)
274#define XDEV_U0 (0x0 << 5)
9574323c 275#define XDEV_U2 (0x2 << 5)
be88fe4f
AX		 276#define XDEV_U3 (0x3 << 5)
277#define XDEV_RESUME (0xf << 5)
74c68741
SS		 278/* true: port has power (see HCC_PPC) */
279#define PORT_POWER (1 << 9)
280/* bits 10:13 indicate device speed:
281 * 0 - undefined speed - port hasn't be initialized by a reset yet
282 * 1 - full speed
283 * 2 - low speed
284 * 3 - high speed
285 * 4 - super speed
286 * 5-15 reserved
287 */
3ffbba95
SS		 288#define DEV_SPEED_MASK (0xf << 10)
289#define XDEV_FS (0x1 << 10)
290#define XDEV_LS (0x2 << 10)
291#define XDEV_HS (0x3 << 10)
292#define XDEV_SS (0x4 << 10)
74c68741 293#define DEV_UNDEFSPEED(p) (((p) & DEV_SPEED_MASK) == (0x0<<10))
3ffbba95
SS		 294#define DEV_FULLSPEED(p) (((p) & DEV_SPEED_MASK) == XDEV_FS)
295#define DEV_LOWSPEED(p) (((p) & DEV_SPEED_MASK) == XDEV_LS)
296#define DEV_HIGHSPEED(p) (((p) & DEV_SPEED_MASK) == XDEV_HS)
297#define DEV_SUPERSPEED(p) (((p) & DEV_SPEED_MASK) == XDEV_SS)
298/* Bits 20:23 in the Slot Context are the speed for the device */
299#define SLOT_SPEED_FS (XDEV_FS << 10)
300#define SLOT_SPEED_LS (XDEV_LS << 10)
301#define SLOT_SPEED_HS (XDEV_HS << 10)
302#define SLOT_SPEED_SS (XDEV_SS << 10)
74c68741
SS		 303/* Port Indicator Control */
304#define PORT_LED_OFF (0 << 14)
305#define PORT_LED_AMBER (1 << 14)
306#define PORT_LED_GREEN (2 << 14)
307#define PORT_LED_MASK (3 << 14)
308/* Port Link State Write Strobe - set this when changing link state */
309#define PORT_LINK_STROBE (1 << 16)
310/* true: connect status change */
311#define PORT_CSC (1 << 17)
312/* true: port enable change */
313#define PORT_PEC (1 << 18)
314/* true: warm reset for a USB 3.0 device is done. A "hot" reset puts the port
315 * into an enabled state, and the device into the default state. A "warm" reset
316 * also resets the link, forcing the device through the link training sequence.
317 * SW can also look at the Port Reset register to see when warm reset is done.
318 */
319#define PORT_WRC (1 << 19)
320/* true: over-current change */
321#define PORT_OCC (1 << 20)
322/* true: reset change - 1 to 0 transition of PORT_RESET */
323#define PORT_RC (1 << 21)
324/* port link status change - set on some port link state transitions:
325 * Transition Reason
326 * ------------------------------------------------------------------------------
327 * - U3 to Resume Wakeup signaling from a device
328 * - Resume to Recovery to U0 USB 3.0 device resume
329 * - Resume to U0 USB 2.0 device resume
330 * - U3 to Recovery to U0 Software resume of USB 3.0 device complete
331 * - U3 to U0 Software resume of USB 2.0 device complete
332 * - U2 to U0 L1 resume of USB 2.1 device complete
333 * - U0 to U0 (???) L1 entry rejection by USB 2.1 device
334 * - U0 to disabled L1 entry error with USB 2.1 device
335 * - Any state to inactive Error on USB 3.0 port
336 */
337#define PORT_PLC (1 << 22)
338/* port configure error change - port failed to configure its link partner */
339#define PORT_CEC (1 << 23)
340/* bit 24 reserved */
341/* wake on connect (enable) */
342#define PORT_WKCONN_E (1 << 25)
343/* wake on disconnect (enable) */
344#define PORT_WKDISC_E (1 << 26)
345/* wake on over-current (enable) */
346#define PORT_WKOC_E (1 << 27)
347/* bits 28:29 reserved */
348/* true: device is removable - for USB 3.0 roothub emulation */
349#define PORT_DEV_REMOVE (1 << 30)
350/* Initiate a warm port reset - complete when PORT_WRC is '1' */
351#define PORT_WR (1 << 31)
352
22e04870
DC		 353/* We mark duplicate entries with -1 */
354#define DUPLICATE_ENTRY ((u8)(-1))
355
74c68741
SS		 356/* Port Power Management Status and Control - port_power_base bitmasks */
357/* Inactivity timer value for transitions into U1, in microseconds.
358 * Timeout can be up to 127us. 0xFF means an infinite timeout.
359 */
360#define PORT_U1_TIMEOUT(p) ((p) & 0xff)
361/* Inactivity timer value for transitions into U2 */
362#define PORT_U2_TIMEOUT(p) (((p) & 0xff) << 8)
363/* Bits 24:31 for port testing */
364
9777e3ce 365/* USB2 Protocol PORTSPMSC */
9574323c
AX		 366#define PORT_L1S_MASK 7
367#define PORT_L1S_SUCCESS 1
368#define PORT_RWE (1 << 3)
369#define PORT_HIRD(p) (((p) & 0xf) << 4)
370#define PORT_L1DS(p) (((p) & 0xff) << 8)
74c68741
SS		 371
372/**
98441973 373 * struct xhci_intr_reg - Interrupt Register Set
74c68741
SS		 374 * @irq_pending: IMAN - Interrupt Management Register. Used to enable
375 * interrupts and check for pending interrupts.
376 * @irq_control: IMOD - Interrupt Moderation Register.
377 * Used to throttle interrupts.
378 * @erst_size: Number of segments in the Event Ring Segment Table (ERST).
379 * @erst_base: ERST base address.
380 * @erst_dequeue: Event ring dequeue pointer.
381 *
382 * Each interrupter (defined by a MSI-X vector) has an event ring and an Event
383 * Ring Segment Table (ERST) associated with it. The event ring is comprised of
384 * multiple segments of the same size. The HC places events on the ring and
385 * "updates the Cycle bit in the TRBs to indicate to software the current
386 * position of the Enqueue Pointer." The HCD (Linux) processes those events and
387 * updates the dequeue pointer.
388 */
98441973 389struct xhci_intr_reg {
28ccd296
ME		 390 __le32 irq_pending;
391 __le32 irq_control;
392 __le32 erst_size;
393 __le32 rsvd;
394 __le64 erst_base;
395 __le64 erst_dequeue;
98441973 396};
74c68741 397
66d4eadd 398/* irq_pending bitmasks */
74c68741 399#define ER_IRQ_PENDING(p) ((p) & 0x1)
66d4eadd 400/* bits 2:31 need to be preserved */
7f84eef0 401/* THIS IS BUGGY - FIXME - IP IS WRITE 1 TO CLEAR */
66d4eadd
SS		 402#define ER_IRQ_CLEAR(p) ((p) & 0xfffffffe)
403#define ER_IRQ_ENABLE(p) ((ER_IRQ_CLEAR(p)) | 0x2)
404#define ER_IRQ_DISABLE(p) ((ER_IRQ_CLEAR(p)) & ~(0x2))
405
406/* irq_control bitmasks */
407/* Minimum interval between interrupts (in 250ns intervals). The interval
408 * between interrupts will be longer if there are no events on the event ring.
409 * Default is 4000 (1 ms).
410 */
411#define ER_IRQ_INTERVAL_MASK (0xffff)
412/* Counter used to count down the time to the next interrupt - HW use only */
413#define ER_IRQ_COUNTER_MASK (0xffff << 16)
414
415/* erst_size bitmasks */
74c68741 416/* Preserve bits 16:31 of erst_size */
66d4eadd
SS		 417#define ERST_SIZE_MASK (0xffff << 16)
418
419/* erst_dequeue bitmasks */
420/* Dequeue ERST Segment Index (DESI) - Segment number (or alias)
421 * where the current dequeue pointer lies. This is an optional HW hint.
422 */
423#define ERST_DESI_MASK (0x7)
424/* Event Handler Busy (EHB) - is the event ring scheduled to be serviced by
425 * a work queue (or delayed service routine)?
426 */
427#define ERST_EHB (1 << 3)
0ebbab37 428#define ERST_PTR_MASK (0xf)
74c68741
SS		 429
430/**
431 * struct xhci_run_regs
432 * @microframe_index:
433 * MFINDEX - current microframe number
434 *
435 * Section 5.5 Host Controller Runtime Registers:
436 * "Software should read and write these registers using only Dword (32 bit)
437 * or larger accesses"
438 */
439struct xhci_run_regs {
28ccd296
ME		 440 __le32 microframe_index;
441 __le32 rsvd[7];
98441973
SS		 442 struct xhci_intr_reg ir_set[128];
443};
74c68741 444
0ebbab37
SS		 445/**
446 * struct doorbell_array
447 *
50d64676
MW		 448 * Bits 0 - 7: Endpoint target
449 * Bits 8 - 15: RsvdZ
450 * Bits 16 - 31: Stream ID
451 *
0ebbab37
SS		 452 * Section 5.6
453 */
454struct xhci_doorbell_array {
28ccd296 455 __le32 doorbell[256];
98441973 456};
0ebbab37 457
50d64676
MW		 458#define DB_VALUE(ep, stream) ((((ep) + 1) & 0xff) | ((stream) << 16))
459#define DB_VALUE_HOST 0x00000000
0ebbab37 460
da6699ce
SS		 461/**
462 * struct xhci_protocol_caps
463 * @revision: major revision, minor revision, capability ID,
464 * and next capability pointer.
465 * @name_string: Four ASCII characters to say which spec this xHC
466 * follows, typically "USB ".
467 * @port_info: Port offset, count, and protocol-defined information.
468 */
469struct xhci_protocol_caps {
470 u32 revision;
471 u32 name_string;
472 u32 port_info;
473};
474
475#define XHCI_EXT_PORT_MAJOR(x) (((x) >> 24) & 0xff)
476#define XHCI_EXT_PORT_OFF(x) ((x) & 0xff)
477#define XHCI_EXT_PORT_COUNT(x) (((x) >> 8) & 0xff)
478
d115b048
JY		 479/**
480 * struct xhci_container_ctx
481 * @type: Type of context. Used to calculated offsets to contained contexts.
482 * @size: Size of the context data
483 * @bytes: The raw context data given to HW
484 * @dma: dma address of the bytes
485 *
486 * Represents either a Device or Input context. Holds a pointer to the raw
487 * memory used for the context (bytes) and dma address of it (dma).
488 */
489struct xhci_container_ctx {
490 unsigned type;
491#define XHCI_CTX_TYPE_DEVICE 0x1
492#define XHCI_CTX_TYPE_INPUT 0x2
493
494 int size;
495
496 u8 *bytes;
497 dma_addr_t dma;
498};
499
a74588f9
SS		 500/**
501 * struct xhci_slot_ctx
502 * @dev_info: Route string, device speed, hub info, and last valid endpoint
503 * @dev_info2: Max exit latency for device number, root hub port number
504 * @tt_info: tt_info is used to construct split transaction tokens
505 * @dev_state: slot state and device address
506 *
507 * Slot Context - section 6.2.1.1. This assumes the HC uses 32-byte context
508 * structures. If the HC uses 64-byte contexts, there is an additional 32 bytes
509 * reserved at the end of the slot context for HC internal use.
510 */
511struct xhci_slot_ctx {
28ccd296
ME		 512 __le32 dev_info;
513 __le32 dev_info2;
514 __le32 tt_info;
515 __le32 dev_state;
a74588f9 516 /* offset 0x10 to 0x1f reserved for HC internal use */
28ccd296 517 __le32 reserved[4];
98441973 518};
a74588f9
SS		 519
520/* dev_info bitmasks */
521/* Route String - 0:19 */
522#define ROUTE_STRING_MASK (0xfffff)
523/* Device speed - values defined by PORTSC Device Speed field - 20:23 */
524#define DEV_SPEED (0xf << 20)
525/* bit 24 reserved */
526/* Is this LS/FS device connected through a HS hub? - bit 25 */
527#define DEV_MTT (0x1 << 25)
528/* Set if the device is a hub - bit 26 */
529#define DEV_HUB (0x1 << 26)
530/* Index of the last valid endpoint context in this device context - 27:31 */
3ffbba95
SS		 531#define LAST_CTX_MASK (0x1f << 27)
532#define LAST_CTX(p) ((p) << 27)
533#define LAST_CTX_TO_EP_NUM(p) (((p) >> 27) - 1)
3ffbba95
SS		 534#define SLOT_FLAG (1 << 0)
535#define EP0_FLAG (1 << 1)
a74588f9
SS		 536
537/* dev_info2 bitmasks */
538/* Max Exit Latency (ms) - worst case time to wake up all links in dev path */
539#define MAX_EXIT (0xffff)
540/* Root hub port number that is needed to access the USB device */
3ffbba95 541#define ROOT_HUB_PORT(p) (((p) & 0xff) << 16)
be88fe4f 542#define DEVINFO_TO_ROOT_HUB_PORT(p) (((p) >> 16) & 0xff)
ac1c1b7f
SS		 543/* Maximum number of ports under a hub device */
544#define XHCI_MAX_PORTS(p) (((p) & 0xff) << 24)
a74588f9
SS		 545
546/* tt_info bitmasks */
547/*
548 * TT Hub Slot ID - for low or full speed devices attached to a high-speed hub
549 * The Slot ID of the hub that isolates the high speed signaling from
550 * this low or full-speed device. '0' if attached to root hub port.
551 */
552#define TT_SLOT (0xff)
553/*
554 * The number of the downstream facing port of the high-speed hub
555 * '0' if the device is not low or full speed.
556 */
557#define TT_PORT (0xff << 8)
ac1c1b7f 558#define TT_THINK_TIME(p) (((p) & 0x3) << 16)
a74588f9
SS		 559
560/* dev_state bitmasks */
561/* USB device address - assigned by the HC */
3ffbba95 562#define DEV_ADDR_MASK (0xff)
a74588f9
SS		 563/* bits 8:26 reserved */
564/* Slot state */
565#define SLOT_STATE (0x1f << 27)
ae636747 566#define GET_SLOT_STATE(p) (((p) & (0x1f << 27)) >> 27)
a74588f9 567
e2b02177
ML		 568#define SLOT_STATE_DISABLED 0
569#define SLOT_STATE_ENABLED SLOT_STATE_DISABLED
570#define SLOT_STATE_DEFAULT 1
571#define SLOT_STATE_ADDRESSED 2
572#define SLOT_STATE_CONFIGURED 3
a74588f9
SS		 573
574/**
575 * struct xhci_ep_ctx
576 * @ep_info: endpoint state, streams, mult, and interval information.
577 * @ep_info2: information on endpoint type, max packet size, max burst size,
578 * error count, and whether the HC will force an event for all
579 * transactions.
3ffbba95
SS		 580 * @deq: 64-bit ring dequeue pointer address. If the endpoint only
581 * defines one stream, this points to the endpoint transfer ring.
582 * Otherwise, it points to a stream context array, which has a
583 * ring pointer for each flow.
584 * @tx_info:
585 * Average TRB lengths for the endpoint ring and
586 * max payload within an Endpoint Service Interval Time (ESIT).
a74588f9
SS		 587 *
588 * Endpoint Context - section 6.2.1.2. This assumes the HC uses 32-byte context
589 * structures. If the HC uses 64-byte contexts, there is an additional 32 bytes
590 * reserved at the end of the endpoint context for HC internal use.
591 */
592struct xhci_ep_ctx {
28ccd296
ME		 593 __le32 ep_info;
594 __le32 ep_info2;
595 __le64 deq;
596 __le32 tx_info;
a74588f9 597 /* offset 0x14 - 0x1f reserved for HC internal use */
28ccd296 598 __le32 reserved[3];
98441973 599};
a74588f9
SS		 600
601/* ep_info bitmasks */
602/*
603 * Endpoint State - bits 0:2
604 * 0 - disabled
605 * 1 - running
606 * 2 - halted due to halt condition - ok to manipulate endpoint ring
607 * 3 - stopped
608 * 4 - TRB error
609 * 5-7 - reserved
610 */
d0e96f5a
SS		 611#define EP_STATE_MASK (0xf)
612#define EP_STATE_DISABLED 0
613#define EP_STATE_RUNNING 1
614#define EP_STATE_HALTED 2
615#define EP_STATE_STOPPED 3
616#define EP_STATE_ERROR 4
a74588f9 617/* Mult - Max number of burtst within an interval, in EP companion desc. */
5a6c2f3f 618#define EP_MULT(p) (((p) & 0x3) << 8)
9af5d71d 619#define CTX_TO_EP_MULT(p) (((p) >> 8) & 0x3)
a74588f9
SS		 620/* bits 10:14 are Max Primary Streams */
621/* bit 15 is Linear Stream Array */
622/* Interval - period between requests to an endpoint - 125u increments. */
5a6c2f3f 623#define EP_INTERVAL(p) (((p) & 0xff) << 16)
624defa1 624#define EP_INTERVAL_TO_UFRAMES(p) (1 << (((p) >> 16) & 0xff))
9af5d71d 625#define CTX_TO_EP_INTERVAL(p) (((p) >> 16) & 0xff)
8df75f42
SS		 626#define EP_MAXPSTREAMS_MASK (0x1f << 10)
627#define EP_MAXPSTREAMS(p) (((p) << 10) & EP_MAXPSTREAMS_MASK)
628/* Endpoint is set up with a Linear Stream Array (vs. Secondary Stream Array) */
629#define EP_HAS_LSA (1 << 15)
a74588f9
SS		 630
631/* ep_info2 bitmasks */
632/*
633 * Force Event - generate transfer events for all TRBs for this endpoint
634 * This will tell the HC to ignore the IOC and ISP flags (for debugging only).
635 */
636#define FORCE_EVENT (0x1)
637#define ERROR_COUNT(p) (((p) & 0x3) << 1)
82d1009f 638#define CTX_TO_EP_TYPE(p) (((p) >> 3) & 0x7)
a74588f9
SS		 639#define EP_TYPE(p) ((p) << 3)
640#define ISOC_OUT_EP 1
641#define BULK_OUT_EP 2
642#define INT_OUT_EP 3
643#define CTRL_EP 4
644#define ISOC_IN_EP 5
645#define BULK_IN_EP 6
646#define INT_IN_EP 7
647/* bit 6 reserved */
648/* bit 7 is Host Initiate Disable - for disabling stream selection */
649#define MAX_BURST(p) (((p)&0xff) << 8)
9af5d71d 650#define CTX_TO_MAX_BURST(p) (((p) >> 8) & 0xff)
a74588f9 651#define MAX_PACKET(p) (((p)&0xffff) << 16)
2d3f1fac
SS		 652#define MAX_PACKET_MASK (0xffff << 16)
653#define MAX_PACKET_DECODED(p) (((p) >> 16) & 0xffff)
a74588f9 654
dc07c91b
AX		 655/* Get max packet size from ep desc. Bit 10..0 specify the max packet size.
656 * USB2.0 spec 9.6.6.
657 */
658#define GET_MAX_PACKET(p) ((p) & 0x7ff)
659
9238f25d
SS		 660/* tx_info bitmasks */
661#define AVG_TRB_LENGTH_FOR_EP(p) ((p) & 0xffff)
662#define MAX_ESIT_PAYLOAD_FOR_EP(p) (((p) & 0xffff) << 16)
9af5d71d 663#define CTX_TO_MAX_ESIT_PAYLOAD(p) (((p) >> 16) & 0xffff)
9238f25d 664
bf161e85
SS		 665/* deq bitmasks */
666#define EP_CTX_CYCLE_MASK (1 << 0)
667
a74588f9
SS		 668
669/**
d115b048
JY		 670 * struct xhci_input_control_context
671 * Input control context; see section 6.2.5.
a74588f9
SS		 672 *
673 * @drop_context: set the bit of the endpoint context you want to disable
674 * @add_context: set the bit of the endpoint context you want to enable
675 */
d115b048 676struct xhci_input_control_ctx {
28ccd296
ME		 677 __le32 drop_flags;
678 __le32 add_flags;
679 __le32 rsvd2[6];
98441973 680};
a74588f9 681
9af5d71d
SS		 682#define EP_IS_ADDED(ctrl_ctx, i) \
683 (le32_to_cpu(ctrl_ctx->add_flags) & (1 << (i + 1)))
684#define EP_IS_DROPPED(ctrl_ctx, i) \
685 (le32_to_cpu(ctrl_ctx->drop_flags) & (1 << (i + 1)))
686
913a8a34
SS		 687/* Represents everything that is needed to issue a command on the command ring.
688 * It's useful to pre-allocate these for commands that cannot fail due to
689 * out-of-memory errors, like freeing streams.
690 */
691struct xhci_command {
692 /* Input context for changing device state */
693 struct xhci_container_ctx *in_ctx;
694 u32 status;
695 /* If completion is null, no one is waiting on this command
696 * and the structure can be freed after the command completes.
697 */
698 struct completion *completion;
699 union xhci_trb *command_trb;
700 struct list_head cmd_list;
701};
702
a74588f9
SS		 703/* drop context bitmasks */
704#define DROP_EP(x) (0x1 << x)
705/* add context bitmasks */
706#define ADD_EP(x) (0x1 << x)
707
8df75f42
SS		 708struct xhci_stream_ctx {
709 /* 64-bit stream ring address, cycle state, and stream type */
28ccd296 710 __le64 stream_ring;
8df75f42 711 /* offset 0x14 - 0x1f reserved for HC internal use */
28ccd296 712 __le32 reserved[2];
8df75f42
SS		 713};
714
715/* Stream Context Types (section 6.4.1) - bits 3:1 of stream ctx deq ptr */
716#define SCT_FOR_CTX(p) (((p) << 1) & 0x7)
717/* Secondary stream array type, dequeue pointer is to a transfer ring */
718#define SCT_SEC_TR 0
719/* Primary stream array type, dequeue pointer is to a transfer ring */
720#define SCT_PRI_TR 1
721/* Dequeue pointer is for a secondary stream array (SSA) with 8 entries */
722#define SCT_SSA_8 2
723#define SCT_SSA_16 3
724#define SCT_SSA_32 4
725#define SCT_SSA_64 5
726#define SCT_SSA_128 6
727#define SCT_SSA_256 7
728
729/* Assume no secondary streams for now */
730struct xhci_stream_info {
731 struct xhci_ring **stream_rings;
732 /* Number of streams, including stream 0 (which drivers can't use) */
733 unsigned int num_streams;
734 /* The stream context array may be bigger than
735 * the number of streams the driver asked for
736 */
737 struct xhci_stream_ctx *stream_ctx_array;
738 unsigned int num_stream_ctxs;
739 dma_addr_t ctx_array_dma;
740 /* For mapping physical TRB addresses to segments in stream rings */
741 struct radix_tree_root trb_address_map;
742 struct xhci_command *free_streams_command;
743};
744
745#define SMALL_STREAM_ARRAY_SIZE 256
746#define MEDIUM_STREAM_ARRAY_SIZE 1024
747
9af5d71d
SS		 748/* Some Intel xHCI host controllers need software to keep track of the bus
749 * bandwidth. Keep track of endpoint info here. Each root port is allocated
750 * the full bus bandwidth. We must also treat TTs (including each port under a
751 * multi-TT hub) as a separate bandwidth domain. The direct memory interface
752 * (DMI) also limits the total bandwidth (across all domains) that can be used.
753 */
754struct xhci_bw_info {
170c0263 755 /* ep_interval is zero-based */
9af5d71d 756 unsigned int ep_interval;
170c0263 757 /* mult and num_packets are one-based */
9af5d71d
SS		 758 unsigned int mult;
759 unsigned int num_packets;
760 unsigned int max_packet_size;
761 unsigned int max_esit_payload;
762 unsigned int type;
763};
764
c29eea62
SS		 765/* "Block" sizes in bytes the hardware uses for different device speeds.
766 * The logic in this part of the hardware limits the number of bits the hardware
767 * can use, so must represent bandwidth in a less precise manner to mimic what
768 * the scheduler hardware computes.
769 */
770#define FS_BLOCK 1
771#define HS_BLOCK 4
772#define SS_BLOCK 16
773#define DMI_BLOCK 32
774
775/* Each device speed has a protocol overhead (CRC, bit stuffing, etc) associated
776 * with each byte transferred. SuperSpeed devices have an initial overhead to
777 * set up bursts. These are in blocks, see above. LS overhead has already been
778 * translated into FS blocks.
779 */
780#define DMI_OVERHEAD 8
781#define DMI_OVERHEAD_BURST 4
782#define SS_OVERHEAD 8
783#define SS_OVERHEAD_BURST 32
784#define HS_OVERHEAD 26
785#define FS_OVERHEAD 20
786#define LS_OVERHEAD 128
787/* The TTs need to claim roughly twice as much bandwidth (94 bytes per
788 * microframe ~= 24Mbps) of the HS bus as the devices can actually use because
789 * of overhead associated with split transfers crossing microframe boundaries.
790 * 31 blocks is pure protocol overhead.
791 */
792#define TT_HS_OVERHEAD (31 + 94)
793#define TT_DMI_OVERHEAD (25 + 12)
794
795/* Bandwidth limits in blocks */
796#define FS_BW_LIMIT 1285
797#define TT_BW_LIMIT 1320
798#define HS_BW_LIMIT 1607
799#define SS_BW_LIMIT_IN 3906
800#define DMI_BW_LIMIT_IN 3906
801#define SS_BW_LIMIT_OUT 3906
802#define DMI_BW_LIMIT_OUT 3906
803
804/* Percentage of bus bandwidth reserved for non-periodic transfers */
805#define FS_BW_RESERVED 10
806#define HS_BW_RESERVED 20
2b698999 807#define SS_BW_RESERVED 10
c29eea62 808
63a0d9ab
SS		 809struct xhci_virt_ep {
810 struct xhci_ring *ring;
8df75f42
SS		 811 /* Related to endpoints that are configured to use stream IDs only */
812 struct xhci_stream_info *stream_info;
63a0d9ab
SS		 813 /* Temporary storage in case the configure endpoint command fails and we
814 * have to restore the device state to the previous state
815 */
816 struct xhci_ring *new_ring;
817 unsigned int ep_state;
818#define SET_DEQ_PENDING (1 << 0)
678539cf
SS		 819#define EP_HALTED (1 << 1) /* For stall handling */
820#define EP_HALT_PENDING (1 << 2) /* For URB cancellation */
8df75f42
SS		 821/* Transitioning the endpoint to using streams, don't enqueue URBs */
822#define EP_GETTING_STREAMS (1 << 3)
823#define EP_HAS_STREAMS (1 << 4)
824/* Transitioning the endpoint to not using streams, don't enqueue URBs */
825#define EP_GETTING_NO_STREAMS (1 << 5)
63a0d9ab
SS		 826 /* ---- Related to URB cancellation ---- */
827 struct list_head cancelled_td_list;
63a0d9ab
SS		 828 /* The TRB that was last reported in a stopped endpoint ring */
829 union xhci_trb *stopped_trb;
830 struct xhci_td *stopped_td;
e9df17eb 831 unsigned int stopped_stream;
6f5165cf
SS		 832 /* Watchdog timer for stop endpoint command to cancel URBs */
833 struct timer_list stop_cmd_timer;
834 int stop_cmds_pending;
835 struct xhci_hcd *xhci;
bf161e85
SS		 836 /* Dequeue pointer and dequeue segment for a submitted Set TR Dequeue
837 * command. We'll need to update the ring's dequeue segment and dequeue
838 * pointer after the command completes.
839 */
840 struct xhci_segment *queued_deq_seg;
841 union xhci_trb *queued_deq_ptr;
d18240db
AX		 842 /*
843 * Sometimes the xHC can not process isochronous endpoint ring quickly
844 * enough, and it will miss some isoc tds on the ring and generate
845 * a Missed Service Error Event.
846 * Set skip flag when receive a Missed Service Error Event and
847 * process the missed tds on the endpoint ring.
848 */
849 bool skip;
2e27980e 850 /* Bandwidth checking storage */
9af5d71d 851 struct xhci_bw_info bw_info;
2e27980e 852 struct list_head bw_endpoint_list;
63a0d9ab
SS		 853};
854
839c817c
SS		 855enum xhci_overhead_type {
856 LS_OVERHEAD_TYPE = 0,
857 FS_OVERHEAD_TYPE,
858 HS_OVERHEAD_TYPE,
859};
860
861struct xhci_interval_bw {
862 unsigned int num_packets;
2e27980e
SS		 863 /* Sorted by max packet size.
864 * Head of the list is the greatest max packet size.
865 */
866 struct list_head endpoints;
839c817c
SS		 867 /* How many endpoints of each speed are present. */
868 unsigned int overhead[3];
869};
870
871#define XHCI_MAX_INTERVAL 16
872
873struct xhci_interval_bw_table {
874 unsigned int interval0_esit_payload;
875 struct xhci_interval_bw interval_bw[XHCI_MAX_INTERVAL];
c29eea62
SS		 876 /* Includes reserved bandwidth for async endpoints */
877 unsigned int bw_used;
2b698999
SS		 878 unsigned int ss_bw_in;
879 unsigned int ss_bw_out;
839c817c
SS		 880};
881
882
3ffbba95 883struct xhci_virt_device {
64927730 884 struct usb_device *udev;
3ffbba95
SS		 885 /*
886 * Commands to the hardware are passed an "input context" that
887 * tells the hardware what to change in its data structures.
888 * The hardware will return changes in an "output context" that
889 * software must allocate for the hardware. We need to keep
890 * track of input and output contexts separately because
891 * these commands might fail and we don't trust the hardware.
892 */
d115b048 893 struct xhci_container_ctx *out_ctx;
3ffbba95 894 /* Used for addressing devices and configuration changes */
d115b048 895 struct xhci_container_ctx *in_ctx;
74f9fe21
SS		 896 /* Rings saved to ensure old alt settings can be re-instated */
897 struct xhci_ring **ring_cache;
898 int num_rings_cached;
c8d4af8e
AX		 899 /* Store xHC assigned device address */
900 int address;
74f9fe21 901#define XHCI_MAX_RINGS_CACHED 31
63a0d9ab 902 struct xhci_virt_ep eps[31];
f94e0186 903 struct completion cmd_completion;
3ffbba95
SS		 904 /* Status of the last command issued for this device */
905 u32 cmd_status;
913a8a34 906 struct list_head cmd_list;
fe30182c 907 u8 fake_port;
66381755 908 u8 real_port;
839c817c
SS		 909 struct xhci_interval_bw_table *bw_table;
910 struct xhci_tt_bw_info *tt_info;
911};
912
913/*
914 * For each roothub, keep track of the bandwidth information for each periodic
915 * interval.
916 *
917 * If a high speed hub is attached to the roothub, each TT associated with that
918 * hub is a separate bandwidth domain. The interval information for the
919 * endpoints on the devices under that TT will appear in the TT structure.
920 */
921struct xhci_root_port_bw_info {
922 struct list_head tts;
923 unsigned int num_active_tts;
924 struct xhci_interval_bw_table bw_table;
925};
926
927struct xhci_tt_bw_info {
928 struct list_head tt_list;
929 int slot_id;
930 int ttport;
931 struct xhci_interval_bw_table bw_table;
932 int active_eps;
3ffbba95
SS		 933};
934
935
a74588f9
SS		 936/**
937 * struct xhci_device_context_array
938 * @dev_context_ptr array of 64-bit DMA addresses for device contexts
939 */
940struct xhci_device_context_array {
941 /* 64-bit device addresses; we only write 32-bit addresses */
28ccd296 942 __le64 dev_context_ptrs[MAX_HC_SLOTS];
a74588f9
SS		 943 /* private xHCD pointers */
944 dma_addr_t dma;
98441973 945};
a74588f9
SS		 946/* TODO: write function to set the 64-bit device DMA address */
947/*
948 * TODO: change this to be dynamically sized at HC mem init time since the HC
949 * might not be able to handle the maximum number of devices possible.
950 */
951
952
0ebbab37
SS		 953struct xhci_transfer_event {
954 /* 64-bit buffer address, or immediate data */
28ccd296
ME		 955 __le64 buffer;
956 __le32 transfer_len;
0ebbab37 957 /* This field is interpreted differently based on the type of TRB */
28ccd296 958 __le32 flags;
98441973 959};
0ebbab37 960
d0e96f5a
SS		 961/** Transfer Event bit fields **/
962#define TRB_TO_EP_ID(p) (((p) >> 16) & 0x1f)
963
0ebbab37
SS		 964/* Completion Code - only applicable for some types of TRBs */
965#define COMP_CODE_MASK (0xff << 24)
966#define GET_COMP_CODE(p) (((p) & COMP_CODE_MASK) >> 24)
967#define COMP_SUCCESS 1
968/* Data Buffer Error */
969#define COMP_DB_ERR 2
970/* Babble Detected Error */
971#define COMP_BABBLE 3
972/* USB Transaction Error */
973#define COMP_TX_ERR 4
974/* TRB Error - some TRB field is invalid */
975#define COMP_TRB_ERR 5
976/* Stall Error - USB device is stalled */
977#define COMP_STALL 6
978/* Resource Error - HC doesn't have memory for that device configuration */
979#define COMP_ENOMEM 7
980/* Bandwidth Error - not enough room in schedule for this dev config */
981#define COMP_BW_ERR 8
982/* No Slots Available Error - HC ran out of device slots */
983#define COMP_ENOSLOTS 9
984/* Invalid Stream Type Error */
985#define COMP_STREAM_ERR 10
986/* Slot Not Enabled Error - doorbell rung for disabled device slot */
987#define COMP_EBADSLT 11
988/* Endpoint Not Enabled Error */
989#define COMP_EBADEP 12
990/* Short Packet */
991#define COMP_SHORT_TX 13
992/* Ring Underrun - doorbell rung for an empty isoc OUT ep ring */
993#define COMP_UNDERRUN 14
994/* Ring Overrun - isoc IN ep ring is empty when ep is scheduled to RX */
995#define COMP_OVERRUN 15
996/* Virtual Function Event Ring Full Error */
997#define COMP_VF_FULL 16
998/* Parameter Error - Context parameter is invalid */
999#define COMP_EINVAL 17
1000/* Bandwidth Overrun Error - isoc ep exceeded its allocated bandwidth */
1001#define COMP_BW_OVER 18
1002/* Context State Error - illegal context state transition requested */
1003#define COMP_CTX_STATE 19
1004/* No Ping Response Error - HC didn't get PING_RESPONSE in time to TX */
1005#define COMP_PING_ERR 20
1006/* Event Ring is full */
1007#define COMP_ER_FULL 21
f6ba6fe2
AH		 1008/* Incompatible Device Error */
1009#define COMP_DEV_ERR 22
0ebbab37
SS		 1010/* Missed Service Error - HC couldn't service an isoc ep within interval */
1011#define COMP_MISSED_INT 23
1012/* Successfully stopped command ring */
1013#define COMP_CMD_STOP 24
1014/* Successfully aborted current command and stopped command ring */
1015#define COMP_CMD_ABORT 25
1016/* Stopped - transfer was terminated by a stop endpoint command */
1017#define COMP_STOP 26
25985edc 1018/* Same as COMP_EP_STOPPED, but the transferred length in the event is invalid */
0ebbab37
SS		 1019#define COMP_STOP_INVAL 27
1020/* Control Abort Error - Debug Capability - control pipe aborted */
1021#define COMP_DBG_ABORT 28
1bb73a88
AH		 1022/* Max Exit Latency Too Large Error */
1023#define COMP_MEL_ERR 29
1024/* TRB type 30 reserved */
0ebbab37
SS		 1025/* Isoc Buffer Overrun - an isoc IN ep sent more data than could fit in TD */
1026#define COMP_BUFF_OVER 31
1027/* Event Lost Error - xHC has an "internal event overrun condition" */
1028#define COMP_ISSUES 32
1029/* Undefined Error - reported when other error codes don't apply */
1030#define COMP_UNKNOWN 33
1031/* Invalid Stream ID Error */
1032#define COMP_STRID_ERR 34
1033/* Secondary Bandwidth Error - may be returned by a Configure Endpoint cmd */
1034/* FIXME - check for this */
1035#define COMP_2ND_BW_ERR 35
1036/* Split Transaction Error */
1037#define COMP_SPLIT_ERR 36
1038
1039struct xhci_link_trb {
1040 /* 64-bit segment pointer*/
28ccd296
ME		 1041 __le64 segment_ptr;
1042 __le32 intr_target;
1043 __le32 control;
98441973 1044};
0ebbab37
SS		 1045
1046/* control bitfields */
1047#define LINK_TOGGLE (0x1<<1)
1048
7f84eef0
SS		 1049/* Command completion event TRB */
1050struct xhci_event_cmd {
1051 /* Pointer to command TRB, or the value passed by the event data trb */
28ccd296
ME		 1052 __le64 cmd_trb;
1053 __le32 status;
1054 __le32 flags;
98441973 1055};
0ebbab37 1056
3ffbba95
SS		 1057/* flags bitmasks */
1058/* bits 16:23 are the virtual function ID */
1059/* bits 24:31 are the slot ID */
1060#define TRB_TO_SLOT_ID(p) (((p) & (0xff<<24)) >> 24)
1061#define SLOT_ID_FOR_TRB(p) (((p) & 0xff) << 24)
0ebbab37 1062
ae636747
SS		 1063/* Stop Endpoint TRB - ep_index to endpoint ID for this TRB */
1064#define TRB_TO_EP_INDEX(p) ((((p) & (0x1f << 16)) >> 16) - 1)
1065#define EP_ID_FOR_TRB(p) ((((p) + 1) & 0x1f) << 16)
1066
be88fe4f
AX		 1067#define SUSPEND_PORT_FOR_TRB(p) (((p) & 1) << 23)
1068#define TRB_TO_SUSPEND_PORT(p) (((p) & (1 << 23)) >> 23)
1069#define LAST_EP_INDEX 30
1070
e9df17eb
SS		 1071/* Set TR Dequeue Pointer command TRB fields */
1072#define TRB_TO_STREAM_ID(p) ((((p) & (0xffff << 16)) >> 16))
1073#define STREAM_ID_FOR_TRB(p) ((((p)) & 0xffff) << 16)
1074
ae636747 1075
0f2a7930
SS		 1076/* Port Status Change Event TRB fields */
1077/* Port ID - bits 31:24 */
1078#define GET_PORT_ID(p) (((p) & (0xff << 24)) >> 24)
1079
0ebbab37
SS		 1080/* Normal TRB fields */
1081/* transfer_len bitmasks - bits 0:16 */
1082#define TRB_LEN(p) ((p) & 0x1ffff)
0ebbab37
SS		 1083/* Interrupter Target - which MSI-X vector to target the completion event at */
1084#define TRB_INTR_TARGET(p) (((p) & 0x3ff) << 22)
1085#define GET_INTR_TARGET(p) (((p) >> 22) & 0x3ff)
5cd43e33 1086#define TRB_TBC(p) (((p) & 0x3) << 7)
b61d378f 1087#define TRB_TLBPC(p) (((p) & 0xf) << 16)
0ebbab37
SS		 1088
1089/* Cycle bit - indicates TRB ownership by HC or HCD */
1090#define TRB_CYCLE (1<<0)
1091/*
1092 * Force next event data TRB to be evaluated before task switch.
1093 * Used to pass OS data back after a TD completes.
1094 */
1095#define TRB_ENT (1<<1)
1096/* Interrupt on short packet */
1097#define TRB_ISP (1<<2)
1098/* Set PCIe no snoop attribute */
1099#define TRB_NO_SNOOP (1<<3)
1100/* Chain multiple TRBs into a TD */
1101#define TRB_CHAIN (1<<4)
1102/* Interrupt on completion */
1103#define TRB_IOC (1<<5)
1104/* The buffer pointer contains immediate data */
1105#define TRB_IDT (1<<6)
1106
ad106f29
AX		 1107/* Block Event Interrupt */
1108#define TRB_BEI (1<<9)
0ebbab37
SS		 1109
1110/* Control transfer TRB specific fields */
1111#define TRB_DIR_IN (1<<16)
b83cdc8f
AX		 1112#define TRB_TX_TYPE(p) ((p) << 16)
1113#define TRB_DATA_OUT 2
1114#define TRB_DATA_IN 3
0ebbab37 1115
04e51901
AX		 1116/* Isochronous TRB specific fields */
1117#define TRB_SIA (1<<31)
1118
7f84eef0 1119struct xhci_generic_trb {
28ccd296 1120 __le32 field[4];
98441973 1121};
7f84eef0
SS		 1122
1123union xhci_trb {
1124 struct xhci_link_trb link;
1125 struct xhci_transfer_event trans_event;
1126 struct xhci_event_cmd event_cmd;
1127 struct xhci_generic_trb generic;
1128};
1129
0ebbab37
SS		 1130/* TRB bit mask */
1131#define TRB_TYPE_BITMASK (0xfc00)
1132#define TRB_TYPE(p) ((p) << 10)
0238634d 1133#define TRB_FIELD_TO_TYPE(p) (((p) & TRB_TYPE_BITMASK) >> 10)
0ebbab37
SS		 1134/* TRB type IDs */
1135/* bulk, interrupt, isoc scatter/gather, and control data stage */
1136#define TRB_NORMAL 1
1137/* setup stage for control transfers */
1138#define TRB_SETUP 2
1139/* data stage for control transfers */
1140#define TRB_DATA 3
1141/* status stage for control transfers */
1142#define TRB_STATUS 4
1143/* isoc transfers */
1144#define TRB_ISOC 5
1145/* TRB for linking ring segments */
1146#define TRB_LINK 6
1147#define TRB_EVENT_DATA 7
1148/* Transfer Ring No-op (not for the command ring) */
1149#define TRB_TR_NOOP 8
1150/* Command TRBs */
1151/* Enable Slot Command */
1152#define TRB_ENABLE_SLOT 9
1153/* Disable Slot Command */
1154#define TRB_DISABLE_SLOT 10
1155/* Address Device Command */
1156#define TRB_ADDR_DEV 11
1157/* Configure Endpoint Command */
1158#define TRB_CONFIG_EP 12
1159/* Evaluate Context Command */
1160#define TRB_EVAL_CONTEXT 13
a1587d97
SS		 1161/* Reset Endpoint Command */
1162#define TRB_RESET_EP 14
0ebbab37
SS		 1163/* Stop Transfer Ring Command */
1164#define TRB_STOP_RING 15
1165/* Set Transfer Ring Dequeue Pointer Command */
1166#define TRB_SET_DEQ 16
1167/* Reset Device Command */
1168#define TRB_RESET_DEV 17
1169/* Force Event Command (opt) */
1170#define TRB_FORCE_EVENT 18
1171/* Negotiate Bandwidth Command (opt) */
1172#define TRB_NEG_BANDWIDTH 19
1173/* Set Latency Tolerance Value Command (opt) */
1174#define TRB_SET_LT 20
1175/* Get port bandwidth Command */
1176#define TRB_GET_BW 21
1177/* Force Header Command - generate a transaction or link management packet */
1178#define TRB_FORCE_HEADER 22
1179/* No-op Command - not for transfer rings */
1180#define TRB_CMD_NOOP 23
1181/* TRB IDs 24-31 reserved */
1182/* Event TRBS */
1183/* Transfer Event */
1184#define TRB_TRANSFER 32
1185/* Command Completion Event */
1186#define TRB_COMPLETION 33
1187/* Port Status Change Event */
1188#define TRB_PORT_STATUS 34
1189/* Bandwidth Request Event (opt) */
1190#define TRB_BANDWIDTH_EVENT 35
1191/* Doorbell Event (opt) */
1192#define TRB_DOORBELL 36
1193/* Host Controller Event */
1194#define TRB_HC_EVENT 37
1195/* Device Notification Event - device sent function wake notification */
1196#define TRB_DEV_NOTE 38
1197/* MFINDEX Wrap Event - microframe counter wrapped */
1198#define TRB_MFINDEX_WRAP 39
1199/* TRB IDs 40-47 reserved, 48-63 is vendor-defined */
1200
0238634d
SS		 1201/* Nec vendor-specific command completion event. */
1202#define TRB_NEC_CMD_COMP 48
1203/* Get NEC firmware revision. */
1204#define TRB_NEC_GET_FW 49
1205
f5960b69
ME		 1206#define TRB_TYPE_LINK(x) (((x) & TRB_TYPE_BITMASK) == TRB_TYPE(TRB_LINK))
1207/* Above, but for __le32 types -- can avoid work by swapping constants: */
1208#define TRB_TYPE_LINK_LE32(x) (((x) & cpu_to_le32(TRB_TYPE_BITMASK)) == \
1209 cpu_to_le32(TRB_TYPE(TRB_LINK)))
1210#define TRB_TYPE_NOOP_LE32(x) (((x) & cpu_to_le32(TRB_TYPE_BITMASK)) == \
1211 cpu_to_le32(TRB_TYPE(TRB_TR_NOOP)))
1212
0238634d
SS		 1213#define NEC_FW_MINOR(p) (((p) >> 0) & 0xff)
1214#define NEC_FW_MAJOR(p) (((p) >> 8) & 0xff)
1215
0ebbab37
SS		 1216/*
1217 * TRBS_PER_SEGMENT must be a multiple of 4,
1218 * since the command ring is 64-byte aligned.
1219 * It must also be greater than 16.
1220 */
1221#define TRBS_PER_SEGMENT 64
913a8a34
SS		 1222/* Allow two commands + a link TRB, along with any reserved command TRBs */
1223#define MAX_RSVD_CMD_TRBS (TRBS_PER_SEGMENT - 3)
0ebbab37 1224#define SEGMENT_SIZE (TRBS_PER_SEGMENT*16)
8df75f42
SS		 1225/* SEGMENT_SHIFT should be log2(SEGMENT_SIZE).
1226 * Change this if you change TRBS_PER_SEGMENT!
1227 */
1228#define SEGMENT_SHIFT 10
b10de142
SS		 1229/* TRB buffer pointers can't cross 64KB boundaries */
1230#define TRB_MAX_BUFF_SHIFT 16
1231#define TRB_MAX_BUFF_SIZE (1 << TRB_MAX_BUFF_SHIFT)
0ebbab37
SS		 1232
1233struct xhci_segment {
1234 union xhci_trb *trbs;
1235 /* private to HCD */
1236 struct xhci_segment *next;
1237 dma_addr_t dma;
98441973 1238};
0ebbab37 1239
ae636747
SS		 1240struct xhci_td {
1241 struct list_head td_list;
1242 struct list_head cancelled_td_list;
1243 struct urb *urb;
1244 struct xhci_segment *start_seg;
1245 union xhci_trb *first_trb;
1246 union xhci_trb *last_trb;
1247};
1248
ac9d8fe7
SS		 1249struct xhci_dequeue_state {
1250 struct xhci_segment *new_deq_seg;
1251 union xhci_trb *new_deq_ptr;
1252 int new_cycle_state;
1253};
1254
0ebbab37
SS		 1255struct xhci_ring {
1256 struct xhci_segment *first_seg;
1257 union xhci_trb *enqueue;
7f84eef0
SS		 1258 struct xhci_segment *enq_seg;
1259 unsigned int enq_updates;
0ebbab37 1260 union xhci_trb *dequeue;
7f84eef0
SS		 1261 struct xhci_segment *deq_seg;
1262 unsigned int deq_updates;
d0e96f5a 1263 struct list_head td_list;
0ebbab37
SS		 1264 /*
1265 * Write the cycle state into the TRB cycle field to give ownership of
1266 * the TRB to the host controller (if we are the producer), or to check
1267 * if we own the TRB (if we are the consumer). See section 4.9.1.
1268 */
1269 u32 cycle_state;
e9df17eb 1270 unsigned int stream_id;
ad808333 1271 bool last_td_was_short;
0ebbab37
SS		 1272};
1273
1274struct xhci_erst_entry {
1275 /* 64-bit event ring segment address */
28ccd296
ME		 1276 __le64 seg_addr;
1277 __le32 seg_size;
0ebbab37 1278 /* Set to zero */
28ccd296 1279 __le32 rsvd;
98441973 1280};
0ebbab37
SS		 1281
1282struct xhci_erst {
1283 struct xhci_erst_entry *entries;
1284 unsigned int num_entries;
1285 /* xhci->event_ring keeps track of segment dma addresses */
1286 dma_addr_t erst_dma_addr;
1287 /* Num entries the ERST can contain */
1288 unsigned int erst_size;
1289};
1290
254c80a3
JY		 1291struct xhci_scratchpad {
1292 u64 *sp_array;
1293 dma_addr_t sp_dma;
1294 void **sp_buffers;
1295 dma_addr_t *sp_dma_buffers;
1296};
1297
8e51adcc
AX		 1298struct urb_priv {
1299 int length;
1300 int td_cnt;
1301 struct xhci_td *td[0];
1302};
1303
0ebbab37
SS		 1304/*
1305 * Each segment table entry is 4*32bits long. 1K seems like an ok size:
1306 * (1K bytes * 8bytes/bit) / (4*32 bits) = 64 segment entries in the table,
1307 * meaning 64 ring segments.
1308 * Initial allocated size of the ERST, in number of entries */
1309#define ERST_NUM_SEGS 1
1310/* Initial allocated size of the ERST, in number of entries */
1311#define ERST_SIZE 64
1312/* Initial number of event segment rings allocated */
1313#define ERST_ENTRIES 1
7f84eef0
SS		 1314/* Poll every 60 seconds */
1315#define POLL_TIMEOUT 60
6f5165cf
SS		 1316/* Stop endpoint command timeout (secs) for URB cancellation watchdog timer */
1317#define XHCI_STOP_EP_CMD_TIMEOUT 5
0ebbab37
SS		 1318/* XXX: Make these module parameters */
1319
5535b1d5
AX		 1320struct s3_save {
1321 u32 command;
1322 u32 dev_nt;
1323 u64 dcbaa_ptr;
1324 u32 config_reg;
1325 u32 irq_pending;
1326 u32 irq_control;
1327 u32 erst_size;
1328 u64 erst_base;
1329 u64 erst_dequeue;
1330};
74c68741 1331
9574323c
AX		 1332/* Use for lpm */
1333struct dev_info {
1334 u32 dev_id;
1335 struct list_head list;
1336};
1337
20b67cf5
SS		 1338struct xhci_bus_state {
1339 unsigned long bus_suspended;
1340 unsigned long next_statechange;
1341
1342 /* Port suspend arrays are indexed by the portnum of the fake roothub */
1343 /* ports suspend status arrays - max 31 ports for USB2, 15 for USB3 */
1344 u32 port_c_suspend;
1345 u32 suspended_ports;
1346 unsigned long resume_done[USB_MAXCHILDREN];
1347};
1348
1349static inline unsigned int hcd_index(struct usb_hcd *hcd)
1350{
f6ff0ac8
SS		 1351 if (hcd->speed == HCD_USB3)
1352 return 0;
1353 else
1354 return 1;
20b67cf5
SS		 1355}
1356
74c68741
SS		 1357/* There is one ehci_hci structure per controller */
1358struct xhci_hcd {
b02d0ed6 1359 struct usb_hcd *main_hcd;
f6ff0ac8 1360 struct usb_hcd *shared_hcd;
74c68741
SS		 1361 /* glue to PCI and HCD framework */
1362 struct xhci_cap_regs __iomem *cap_regs;
1363 struct xhci_op_regs __iomem *op_regs;
1364 struct xhci_run_regs __iomem *run_regs;
0ebbab37 1365 struct xhci_doorbell_array __iomem *dba;
66d4eadd 1366 /* Our HCD's current interrupter register set */
98441973 1367 struct xhci_intr_reg __iomem *ir_set;
74c68741
SS		 1368
1369 /* Cached register copies of read-only HC data */
1370 __u32 hcs_params1;
1371 __u32 hcs_params2;
1372 __u32 hcs_params3;
1373 __u32 hcc_params;
1374
1375 spinlock_t lock;
1376
1377 /* packed release number */
1378 u8 sbrn;
1379 u16 hci_version;
1380 u8 max_slots;
1381 u8 max_interrupters;
1382 u8 max_ports;
1383 u8 isoc_threshold;
1384 int event_ring_max;
1385 int addr_64;
66d4eadd 1386 /* 4KB min, 128MB max */
74c68741 1387 int page_size;
66d4eadd
SS		 1388 /* Valid values are 12 to 20, inclusive */
1389 int page_shift;
43b86af8 1390 /* msi-x vectors */
66d4eadd
SS		 1391 int msix_count;
1392 struct msix_entry *msix_entries;
0ebbab37 1393 /* data structures */
a74588f9 1394 struct xhci_device_context_array *dcbaa;
0ebbab37 1395 struct xhci_ring *cmd_ring;
913a8a34 1396 unsigned int cmd_ring_reserved_trbs;
0ebbab37
SS		 1397 struct xhci_ring *event_ring;
1398 struct xhci_erst erst;
254c80a3
JY		 1399 /* Scratchpad */
1400 struct xhci_scratchpad *scratchpad;
9574323c
AX		 1401 /* Store LPM test failed devices' information */
1402 struct list_head lpm_failed_devs;
254c80a3 1403
3ffbba95
SS		 1404 /* slot enabling and address device helpers */
1405 struct completion addr_dev;
1406 int slot_id;
1407 /* Internal mirror of the HW's dcbaa */
1408 struct xhci_virt_device *devs[MAX_HC_SLOTS];
839c817c
SS		 1409 /* For keeping track of bandwidth domains per roothub. */
1410 struct xhci_root_port_bw_info *rh_bw;
0ebbab37
SS		 1411
1412 /* DMA pools */
1413 struct dma_pool *device_pool;
1414 struct dma_pool *segment_pool;
8df75f42
SS		 1415 struct dma_pool *small_streams_pool;
1416 struct dma_pool *medium_streams_pool;
7f84eef0
SS		 1417
1418#ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
1419 /* Poll the rings - for debugging */
1420 struct timer_list event_ring_timer;
1421 int zombie;
1422#endif
6f5165cf
SS		 1423 /* Host controller watchdog timer structures */
1424 unsigned int xhc_state;
9777e3ce 1425
9777e3ce 1426 u32 command;
5535b1d5 1427 struct s3_save s3;
6f5165cf
SS		 1428/* Host controller is dying - not responding to commands. "I'm not dead yet!"
1429 *
1430 * xHC interrupts have been disabled and a watchdog timer will (or has already)
1431 * halt the xHCI host, and complete all URBs with an -ESHUTDOWN code. Any code
1432 * that sees this status (other than the timer that set it) should stop touching
1433 * hardware immediately. Interrupt handlers should return immediately when
1434 * they see this status (any time they drop and re-acquire xhci->lock).
1435 * xhci_urb_dequeue() should call usb_hcd_check_unlink_urb() and return without
1436 * putting the TD on the canceled list, etc.
1437 *
1438 * There are no reports of xHCI host controllers that display this issue.
1439 */
1440#define XHCI_STATE_DYING (1 << 0)
c6cc27c7 1441#define XHCI_STATE_HALTED (1 << 1)
7f84eef0 1442 /* Statistics */
7f84eef0 1443 int error_bitmask;
b0567b3f
SS		 1444 unsigned int quirks;
1445#define XHCI_LINK_TRB_QUIRK (1 << 0)
ac9d8fe7 1446#define XHCI_RESET_EP_QUIRK (1 << 1)
0238634d 1447#define XHCI_NEC_HOST (1 << 2)
c41136b0 1448#define XHCI_AMD_PLL_FIX (1 << 3)
ad808333 1449#define XHCI_SPURIOUS_SUCCESS (1 << 4)
2cf95c18
SS		 1450/*
1451 * Certain Intel host controllers have a limit to the number of endpoint
1452 * contexts they can handle. Ideally, they would signal that they can't handle
1453 * anymore endpoint contexts by returning a Resource Error for the Configure
1454 * Endpoint command, but they don't. Instead they expect software to keep track
1455 * of the number of active endpoints for them, across configure endpoint
1456 * commands, reset device commands, disable slot commands, and address device
1457 * commands.
1458 */
1459#define XHCI_EP_LIMIT_QUIRK (1 << 5)
f5182b41 1460#define XHCI_BROKEN_MSI (1 << 6)
c877b3b2 1461#define XHCI_RESET_ON_RESUME (1 << 7)
c29eea62 1462#define XHCI_SW_BW_CHECKING (1 << 8)
2cf95c18
SS		 1463 unsigned int num_active_eps;
1464 unsigned int limit_active_eps;
f6ff0ac8
SS		 1465 /* There are two roothubs to keep track of bus suspend info for */
1466 struct xhci_bus_state bus_state[2];
da6699ce
SS		 1467 /* Is each xHCI roothub port a USB 3.0, USB 2.0, or USB 1.1 port? */
1468 u8 *port_array;
1469 /* Array of pointers to USB 3.0 PORTSC registers */
28ccd296 1470 __le32 __iomem **usb3_ports;
da6699ce
SS		 1471 unsigned int num_usb3_ports;
1472 /* Array of pointers to USB 2.0 PORTSC registers */
28ccd296 1473 __le32 __iomem **usb2_ports;
da6699ce 1474 unsigned int num_usb2_ports;
fc71ff75
AX		 1475 /* support xHCI 0.96 spec USB2 software LPM */
1476 unsigned sw_lpm_support:1;
1477 /* support xHCI 1.0 spec USB2 hardware LPM */
1478 unsigned hw_lpm_support:1;
74c68741
SS		 1479};
1480
1481/* convert between an HCD pointer and the corresponding EHCI_HCD */
1482static inline struct xhci_hcd *hcd_to_xhci(struct usb_hcd *hcd)
1483{
b02d0ed6 1484 return *((struct xhci_hcd **) (hcd->hcd_priv));
74c68741
SS		 1485}
1486
1487static inline struct usb_hcd *xhci_to_hcd(struct xhci_hcd *xhci)
1488{
b02d0ed6 1489 return xhci->main_hcd;
74c68741
SS		 1490}
1491
1492#ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
1493#define XHCI_DEBUG 1
1494#else
1495#define XHCI_DEBUG 0
1496#endif
1497
1498#define xhci_dbg(xhci, fmt, args...) \
1499 do { if (XHCI_DEBUG) dev_dbg(xhci_to_hcd(xhci)->self.controller , fmt , ## args); } while (0)
1500#define xhci_info(xhci, fmt, args...) \
1501 do { if (XHCI_DEBUG) dev_info(xhci_to_hcd(xhci)->self.controller , fmt , ## args); } while (0)
1502#define xhci_err(xhci, fmt, args...) \
1503 dev_err(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1504#define xhci_warn(xhci, fmt, args...) \
1505 dev_warn(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1506
1507/* TODO: copied from ehci.h - can be refactored? */
1508/* xHCI spec says all registers are little endian */
1509static inline unsigned int xhci_readl(const struct xhci_hcd *xhci,
28ccd296 1510 __le32 __iomem *regs)
74c68741
SS		 1511{
1512 return readl(regs);
1513}
045f123d 1514static inline void xhci_writel(struct xhci_hcd *xhci,
28ccd296 1515 const unsigned int val, __le32 __iomem *regs)
74c68741 1516{
74c68741
SS		 1517 writel(val, regs);
1518}
1519
8e595a5d
SS		 1520/*
1521 * Registers should always be accessed with double word or quad word accesses.
1522 *
1523 * Some xHCI implementations may support 64-bit address pointers. Registers
1524 * with 64-bit address pointers should be written to with dword accesses by
1525 * writing the low dword first (ptr[0]), then the high dword (ptr[1]) second.
1526 * xHCI implementations that do not support 64-bit address pointers will ignore
1527 * the high dword, and write order is irrelevant.
1528 */
1529static inline u64 xhci_read_64(const struct xhci_hcd *xhci,
28ccd296 1530 __le64 __iomem *regs)
8e595a5d
SS		 1531{
1532 __u32 __iomem *ptr = (__u32 __iomem *) regs;
1533 u64 val_lo = readl(ptr);
1534 u64 val_hi = readl(ptr + 1);
1535 return val_lo + (val_hi << 32);
1536}
1537static inline void xhci_write_64(struct xhci_hcd *xhci,
28ccd296 1538 const u64 val, __le64 __iomem *regs)
8e595a5d
SS		 1539{
1540 __u32 __iomem *ptr = (__u32 __iomem *) regs;
1541 u32 val_lo = lower_32_bits(val);
1542 u32 val_hi = upper_32_bits(val);
1543
8e595a5d
SS		 1544 writel(val_lo, ptr);
1545 writel(val_hi, ptr + 1);
1546}
1547
b0567b3f
SS		 1548static inline int xhci_link_trb_quirk(struct xhci_hcd *xhci)
1549{
d7826599 1550 return xhci->quirks & XHCI_LINK_TRB_QUIRK;
b0567b3f
SS		 1551}
1552
66d4eadd 1553/* xHCI debugging */
09ece30e 1554void xhci_print_ir_set(struct xhci_hcd *xhci, int set_num);
66d4eadd 1555void xhci_print_registers(struct xhci_hcd *xhci);
0ebbab37
SS		 1556void xhci_dbg_regs(struct xhci_hcd *xhci);
1557void xhci_print_run_regs(struct xhci_hcd *xhci);
d0e96f5a
SS		 1558void xhci_print_trb_offsets(struct xhci_hcd *xhci, union xhci_trb *trb);
1559void xhci_debug_trb(struct xhci_hcd *xhci, union xhci_trb *trb);
7f84eef0 1560void xhci_debug_segment(struct xhci_hcd *xhci, struct xhci_segment *seg);
0ebbab37
SS		 1561void xhci_debug_ring(struct xhci_hcd *xhci, struct xhci_ring *ring);
1562void xhci_dbg_erst(struct xhci_hcd *xhci, struct xhci_erst *erst);
1563void xhci_dbg_cmd_ptrs(struct xhci_hcd *xhci);
7f84eef0 1564void xhci_dbg_ring_ptrs(struct xhci_hcd *xhci, struct xhci_ring *ring);
d115b048 1565void xhci_dbg_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned int last_ep);
9c9a7dbf 1566char *xhci_get_slot_state(struct xhci_hcd *xhci,
2a8f82c4 1567 struct xhci_container_ctx *ctx);
e9df17eb
SS		 1568void xhci_dbg_ep_rings(struct xhci_hcd *xhci,
1569 unsigned int slot_id, unsigned int ep_index,
1570 struct xhci_virt_ep *ep);
66d4eadd 1571
3dbda77e 1572/* xHCI memory management */
66d4eadd
SS		 1573void xhci_mem_cleanup(struct xhci_hcd *xhci);
1574int xhci_mem_init(struct xhci_hcd *xhci, gfp_t flags);
3ffbba95
SS		 1575void xhci_free_virt_device(struct xhci_hcd *xhci, int slot_id);
1576int xhci_alloc_virt_device(struct xhci_hcd *xhci, int slot_id, struct usb_device *udev, gfp_t flags);
1577int xhci_setup_addressable_virt_dev(struct xhci_hcd *xhci, struct usb_device *udev);
2d1ee590
SS		 1578void xhci_copy_ep0_dequeue_into_input_ctx(struct xhci_hcd *xhci,
1579 struct usb_device *udev);
d0e96f5a 1580unsigned int xhci_get_endpoint_index(struct usb_endpoint_descriptor *desc);
f94e0186 1581unsigned int xhci_get_endpoint_flag(struct usb_endpoint_descriptor *desc);
ac9d8fe7
SS		 1582unsigned int xhci_get_endpoint_flag_from_index(unsigned int ep_index);
1583unsigned int xhci_last_valid_endpoint(u32 added_ctxs);
f94e0186 1584void xhci_endpoint_zero(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev, struct usb_host_endpoint *ep);
2e27980e
SS		 1585void xhci_drop_ep_from_interval_table(struct xhci_hcd *xhci,
1586 struct xhci_bw_info *ep_bw,
1587 struct xhci_interval_bw_table *bw_table,
1588 struct usb_device *udev,
1589 struct xhci_virt_ep *virt_ep,
1590 struct xhci_tt_bw_info *tt_info);
1591void xhci_update_tt_active_eps(struct xhci_hcd *xhci,
1592 struct xhci_virt_device *virt_dev,
1593 int old_active_eps);
9af5d71d
SS		 1594void xhci_clear_endpoint_bw_info(struct xhci_bw_info *bw_info);
1595void xhci_update_bw_info(struct xhci_hcd *xhci,
1596 struct xhci_container_ctx *in_ctx,
1597 struct xhci_input_control_ctx *ctrl_ctx,
1598 struct xhci_virt_device *virt_dev);
f2217e8e 1599void xhci_endpoint_copy(struct xhci_hcd *xhci,
913a8a34
SS		 1600 struct xhci_container_ctx *in_ctx,
1601 struct xhci_container_ctx *out_ctx,
1602 unsigned int ep_index);
1603void xhci_slot_copy(struct xhci_hcd *xhci,
1604 struct xhci_container_ctx *in_ctx,
1605 struct xhci_container_ctx *out_ctx);
f88ba78d
SS		 1606int xhci_endpoint_init(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev,
1607 struct usb_device *udev, struct usb_host_endpoint *ep,
1608 gfp_t mem_flags);
f94e0186 1609void xhci_ring_free(struct xhci_hcd *xhci, struct xhci_ring *ring);
412566bd
SS		 1610void xhci_free_or_cache_endpoint_ring(struct xhci_hcd *xhci,
1611 struct xhci_virt_device *virt_dev,
1612 unsigned int ep_index);
8df75f42
SS		 1613struct xhci_stream_info *xhci_alloc_stream_info(struct xhci_hcd *xhci,
1614 unsigned int num_stream_ctxs,
1615 unsigned int num_streams, gfp_t flags);
1616void xhci_free_stream_info(struct xhci_hcd *xhci,
1617 struct xhci_stream_info *stream_info);
1618void xhci_setup_streams_ep_input_ctx(struct xhci_hcd *xhci,
1619 struct xhci_ep_ctx *ep_ctx,
1620 struct xhci_stream_info *stream_info);
1621void xhci_setup_no_streams_ep_input_ctx(struct xhci_hcd *xhci,
1622 struct xhci_ep_ctx *ep_ctx,
1623 struct xhci_virt_ep *ep);
2cf95c18
SS		 1624void xhci_free_device_endpoint_resources(struct xhci_hcd *xhci,
1625 struct xhci_virt_device *virt_dev, bool drop_control_ep);
e9df17eb
SS		 1626struct xhci_ring *xhci_dma_to_transfer_ring(
1627 struct xhci_virt_ep *ep,
1628 u64 address);
e9df17eb
SS		 1629struct xhci_ring *xhci_stream_id_to_ring(
1630 struct xhci_virt_device *dev,
1631 unsigned int ep_index,
1632 unsigned int stream_id);
913a8a34 1633struct xhci_command *xhci_alloc_command(struct xhci_hcd *xhci,
a1d78c16
SS		 1634 bool allocate_in_ctx, bool allocate_completion,
1635 gfp_t mem_flags);
8e51adcc 1636void xhci_urb_free_priv(struct xhci_hcd *xhci, struct urb_priv *urb_priv);
913a8a34
SS		 1637void xhci_free_command(struct xhci_hcd *xhci,
1638 struct xhci_command *command);
66d4eadd
SS		 1639
1640#ifdef CONFIG_PCI
1641/* xHCI PCI glue */
1642int xhci_register_pci(void);
1643void xhci_unregister_pci(void);
1644#endif
1645
1646/* xHCI host controller glue */
4f0f0bae 1647void xhci_quiesce(struct xhci_hcd *xhci);
66d4eadd
SS		 1648int xhci_halt(struct xhci_hcd *xhci);
1649int xhci_reset(struct xhci_hcd *xhci);
1650int xhci_init(struct usb_hcd *hcd);
1651int xhci_run(struct usb_hcd *hcd);
1652void xhci_stop(struct usb_hcd *hcd);
1653void xhci_shutdown(struct usb_hcd *hcd);
436a3890
SS		 1654
1655#ifdef CONFIG_PM
5535b1d5
AX		 1656int xhci_suspend(struct xhci_hcd *xhci);
1657int xhci_resume(struct xhci_hcd *xhci, bool hibernated);
436a3890
SS		 1658#else
1659#define xhci_suspend NULL
1660#define xhci_resume NULL
1661#endif
1662
66d4eadd 1663int xhci_get_frame(struct usb_hcd *hcd);
7f84eef0 1664irqreturn_t xhci_irq(struct usb_hcd *hcd);
9032cd52 1665irqreturn_t xhci_msi_irq(int irq, struct usb_hcd *hcd);
3ffbba95
SS		 1666int xhci_alloc_dev(struct usb_hcd *hcd, struct usb_device *udev);
1667void xhci_free_dev(struct usb_hcd *hcd, struct usb_device *udev);
839c817c
SS		 1668int xhci_alloc_tt_info(struct xhci_hcd *xhci,
1669 struct xhci_virt_device *virt_dev,
1670 struct usb_device *hdev,
1671 struct usb_tt *tt, gfp_t mem_flags);
8df75f42
SS		 1672int xhci_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
1673 struct usb_host_endpoint **eps, unsigned int num_eps,
1674 unsigned int num_streams, gfp_t mem_flags);
1675int xhci_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
1676 struct usb_host_endpoint **eps, unsigned int num_eps,
1677 gfp_t mem_flags);
3ffbba95 1678int xhci_address_device(struct usb_hcd *hcd, struct usb_device *udev);
9574323c 1679int xhci_update_device(struct usb_hcd *hcd, struct usb_device *udev);
ac1c1b7f
SS		 1680int xhci_update_hub_device(struct usb_hcd *hcd, struct usb_device *hdev,
1681 struct usb_tt *tt, gfp_t mem_flags);
d0e96f5a
SS		 1682int xhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb, gfp_t mem_flags);
1683int xhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status);
f94e0186
SS		 1684int xhci_add_endpoint(struct usb_hcd *hcd, struct usb_device *udev, struct usb_host_endpoint *ep);
1685int xhci_drop_endpoint(struct usb_hcd *hcd, struct usb_device *udev, struct usb_host_endpoint *ep);
a1587d97 1686void xhci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep);
f0615c45 1687int xhci_discover_or_reset_device(struct usb_hcd *hcd, struct usb_device *udev);
f94e0186
SS		 1688int xhci_check_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
1689void xhci_reset_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
7f84eef0
SS		 1690
1691/* xHCI ring, segment, TRB, and TD functions */
23e3be11 1692dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg, union xhci_trb *trb);
6648f29d
SS		 1693struct xhci_segment *trb_in_td(struct xhci_segment *start_seg,
1694 union xhci_trb *start_trb, union xhci_trb *end_trb,
1695 dma_addr_t suspect_dma);
b45b5069 1696int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code);
23e3be11 1697void xhci_ring_cmd_db(struct xhci_hcd *xhci);
23e3be11
SS		 1698int xhci_queue_slot_control(struct xhci_hcd *xhci, u32 trb_type, u32 slot_id);
1699int xhci_queue_address_device(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1700 u32 slot_id);
0238634d
SS		 1701int xhci_queue_vendor_command(struct xhci_hcd *xhci,
1702 u32 field1, u32 field2, u32 field3, u32 field4);
23e3be11 1703int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, int slot_id,
be88fe4f 1704 unsigned int ep_index, int suspend);
23e3be11
SS		 1705int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1706 int slot_id, unsigned int ep_index);
1707int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1708 int slot_id, unsigned int ep_index);
624defa1
SS		 1709int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1710 int slot_id, unsigned int ep_index);
04e51901
AX		 1711int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
1712 struct urb *urb, int slot_id, unsigned int ep_index);
23e3be11 1713int xhci_queue_configure_endpoint(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
913a8a34 1714 u32 slot_id, bool command_must_succeed);
f2217e8e 1715int xhci_queue_evaluate_context(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
23e3be11 1716 u32 slot_id);
a1587d97
SS		 1717int xhci_queue_reset_ep(struct xhci_hcd *xhci, int slot_id,
1718 unsigned int ep_index);
2a8f82c4 1719int xhci_queue_reset_device(struct xhci_hcd *xhci, u32 slot_id);
c92bcfa7
SS		 1720void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
1721 unsigned int slot_id, unsigned int ep_index,
e9df17eb
SS		 1722 unsigned int stream_id, struct xhci_td *cur_td,
1723 struct xhci_dequeue_state *state);
c92bcfa7 1724void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
63a0d9ab 1725 unsigned int slot_id, unsigned int ep_index,
e9df17eb 1726 unsigned int stream_id,
63a0d9ab 1727 struct xhci_dequeue_state *deq_state);
82d1009f 1728void xhci_cleanup_stalled_ring(struct xhci_hcd *xhci,
63a0d9ab 1729 struct usb_device *udev, unsigned int ep_index);
ac9d8fe7
SS		 1730void xhci_queue_config_ep_quirk(struct xhci_hcd *xhci,
1731 unsigned int slot_id, unsigned int ep_index,
1732 struct xhci_dequeue_state *deq_state);
6f5165cf 1733void xhci_stop_endpoint_command_watchdog(unsigned long arg);
be88fe4f
AX		 1734void xhci_ring_ep_doorbell(struct xhci_hcd *xhci, unsigned int slot_id,
1735 unsigned int ep_index, unsigned int stream_id);
66d4eadd 1736
0f2a7930 1737/* xHCI roothub code */
c9682dff
AX		 1738void xhci_set_link_state(struct xhci_hcd *xhci, __le32 __iomem **port_array,
1739 int port_id, u32 link_state);
d2f52c9e
AX		 1740void xhci_test_and_clear_bit(struct xhci_hcd *xhci, __le32 __iomem **port_array,
1741 int port_id, u32 port_bit);
0f2a7930
SS		 1742int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue, u16 wIndex,
1743 char *buf, u16 wLength);
1744int xhci_hub_status_data(struct usb_hcd *hcd, char *buf);
436a3890
SS		 1745
1746#ifdef CONFIG_PM
9777e3ce
AX		 1747int xhci_bus_suspend(struct usb_hcd *hcd);
1748int xhci_bus_resume(struct usb_hcd *hcd);
436a3890
SS		 1749#else
1750#define xhci_bus_suspend NULL
1751#define xhci_bus_resume NULL
1752#endif /* CONFIG_PM */
1753
56192531 1754u32 xhci_port_state_to_neutral(u32 state);
5233630f
SS		 1755int xhci_find_slot_id_by_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
1756 u16 port);
56192531 1757void xhci_ring_device(struct xhci_hcd *xhci, int slot_id);
0f2a7930 1758
d115b048
JY		 1759/* xHCI contexts */
1760struct xhci_input_control_ctx *xhci_get_input_control_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx);
1761struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx);
1762struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned int ep_index);
1763
74c68741 1764#endif /* __LINUX_XHCI_HCD_H */
Linux 6.x block layer and io_uring tree(s)