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