2 * xHCI host controller driver
4 * Copyright (C) 2008 Intel Corp.
7 * Some code borrowed from the Linux EHCI driver.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #include <linux/irq.h>
24 #include <linux/module.h>
25 #include <linux/moduleparam.h>
29 #define DRIVER_AUTHOR "Sarah Sharp"
30 #define DRIVER_DESC "'eXtensible' Host Controller (xHC) Driver"
32 /* Some 0.95 hardware can't handle the chain bit on a Link TRB being cleared */
33 static int link_quirk
;
34 module_param(link_quirk
, int, S_IRUGO
| S_IWUSR
);
35 MODULE_PARM_DESC(link_quirk
, "Don't clear the chain bit on a link TRB");
37 /* TODO: copied from ehci-hcd.c - can this be refactored? */
39 * handshake - spin reading hc until handshake completes or fails
40 * @ptr: address of hc register to be read
41 * @mask: bits to look at in result of read
42 * @done: value of those bits when handshake succeeds
43 * @usec: timeout in microseconds
45 * Returns negative errno, or zero on success
47 * Success happens when the "mask" bits have the specified value (hardware
48 * handshake done). There are two failure modes: "usec" have passed (major
49 * hardware flakeout), or the register reads as all-ones (hardware removed).
51 static int handshake(struct xhci_hcd
*xhci
, void __iomem
*ptr
,
52 u32 mask
, u32 done
, int usec
)
57 result
= xhci_readl(xhci
, ptr
);
58 if (result
== ~(u32
)0) /* card removed */
70 * Force HC into halt state.
72 * Disable any IRQs and clear the run/stop bit.
73 * HC will complete any current and actively pipelined transactions, and
74 * should halt within 16 microframes of the run/stop bit being cleared.
75 * Read HC Halted bit in the status register to see when the HC is finished.
76 * XXX: shouldn't we set HC_STATE_HALT here somewhere?
78 int xhci_halt(struct xhci_hcd
*xhci
)
84 xhci_dbg(xhci
, "// Halt the HC\n");
85 /* Disable all interrupts from the host controller */
87 halted
= xhci_readl(xhci
, &xhci
->op_regs
->status
) & STS_HALT
;
91 cmd
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
93 xhci_writel(xhci
, cmd
, &xhci
->op_regs
->command
);
95 return handshake(xhci
, &xhci
->op_regs
->status
,
96 STS_HALT
, STS_HALT
, XHCI_MAX_HALT_USEC
);
100 * Reset a halted HC, and set the internal HC state to HC_STATE_HALT.
102 * This resets pipelines, timers, counters, state machines, etc.
103 * Transactions will be terminated immediately, and operational registers
104 * will be set to their defaults.
106 int xhci_reset(struct xhci_hcd
*xhci
)
111 state
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
112 if ((state
& STS_HALT
) == 0) {
113 xhci_warn(xhci
, "Host controller not halted, aborting reset.\n");
117 xhci_dbg(xhci
, "// Reset the HC\n");
118 command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
119 command
|= CMD_RESET
;
120 xhci_writel(xhci
, command
, &xhci
->op_regs
->command
);
121 /* XXX: Why does EHCI set this here? Shouldn't other code do this? */
122 xhci_to_hcd(xhci
)->state
= HC_STATE_HALT
;
124 return handshake(xhci
, &xhci
->op_regs
->command
, CMD_RESET
, 0, 250 * 1000);
128 * Stop the HC from processing the endpoint queues.
130 static void xhci_quiesce(struct xhci_hcd
*xhci
)
133 * Queues are per endpoint, so we need to disable an endpoint or slot.
135 * To disable a slot, we need to insert a disable slot command on the
136 * command ring and ring the doorbell. This will also free any internal
137 * resources associated with the slot (which might not be what we want).
139 * A Release Endpoint command sounds better - doesn't free internal HC
140 * memory, but removes the endpoints from the schedule and releases the
141 * bandwidth, disables the doorbells, and clears the endpoint enable
142 * flag. Usually used prior to a set interface command.
144 * TODO: Implement after command ring code is done.
146 BUG_ON(!HC_IS_RUNNING(xhci_to_hcd(xhci
)->state
));
147 xhci_dbg(xhci
, "Finished quiescing -- code not written yet\n");
151 /* Set up MSI-X table for entry 0 (may claim other entries later) */
152 static int xhci_setup_msix(struct xhci_hcd
*xhci
)
155 struct pci_dev
*pdev
= to_pci_dev(xhci_to_hcd(xhci
)->self
.controller
);
157 xhci
->msix_count
= 0;
158 /* XXX: did I do this right? ixgbe does kcalloc for more than one */
159 xhci
->msix_entries
= kmalloc(sizeof(struct msix_entry
), GFP_KERNEL
);
160 if (!xhci
->msix_entries
) {
161 xhci_err(xhci
, "Failed to allocate MSI-X entries\n");
164 xhci
->msix_entries
[0].entry
= 0;
166 ret
= pci_enable_msix(pdev
, xhci
->msix_entries
, xhci
->msix_count
);
168 xhci_err(xhci
, "Failed to enable MSI-X\n");
173 * Pass the xhci pointer value as the request_irq "cookie".
174 * If more irqs are added, this will need to be unique for each one.
176 ret
= request_irq(xhci
->msix_entries
[0].vector
, &xhci_irq
, 0,
177 "xHCI", xhci_to_hcd(xhci
));
179 xhci_err(xhci
, "Failed to allocate MSI-X interrupt\n");
182 xhci_dbg(xhci
, "Finished setting up MSI-X\n");
186 pci_disable_msix(pdev
);
188 kfree(xhci
->msix_entries
);
189 xhci
->msix_entries
= NULL
;
193 /* XXX: code duplication; can xhci_setup_msix call this? */
194 /* Free any IRQs and disable MSI-X */
195 static void xhci_cleanup_msix(struct xhci_hcd
*xhci
)
197 struct pci_dev
*pdev
= to_pci_dev(xhci_to_hcd(xhci
)->self
.controller
);
198 if (!xhci
->msix_entries
)
201 free_irq(xhci
->msix_entries
[0].vector
, xhci
);
202 pci_disable_msix(pdev
);
203 kfree(xhci
->msix_entries
);
204 xhci
->msix_entries
= NULL
;
205 xhci_dbg(xhci
, "Finished cleaning up MSI-X\n");
210 * Initialize memory for HCD and xHC (one-time init).
212 * Program the PAGESIZE register, initialize the device context array, create
213 * device contexts (?), set up a command ring segment (or two?), create event
214 * ring (one for now).
216 int xhci_init(struct usb_hcd
*hcd
)
218 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
221 xhci_dbg(xhci
, "xhci_init\n");
222 spin_lock_init(&xhci
->lock
);
224 xhci_dbg(xhci
, "QUIRK: Not clearing Link TRB chain bits.\n");
225 xhci
->quirks
|= XHCI_LINK_TRB_QUIRK
;
227 xhci_dbg(xhci
, "xHCI doesn't need link TRB QUIRK\n");
229 retval
= xhci_mem_init(xhci
, GFP_KERNEL
);
230 xhci_dbg(xhci
, "Finished xhci_init\n");
236 * Called in interrupt context when there might be work
237 * queued on the event ring
239 * xhci->lock must be held by caller.
241 static void xhci_work(struct xhci_hcd
*xhci
)
247 * Clear the op reg interrupt status first,
248 * so we can receive interrupts from other MSI-X interrupters.
249 * Write 1 to clear the interrupt status.
251 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
253 xhci_writel(xhci
, temp
, &xhci
->op_regs
->status
);
254 /* FIXME when MSI-X is supported and there are multiple vectors */
255 /* Clear the MSI-X event interrupt status */
257 /* Acknowledge the interrupt */
258 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
260 xhci_writel(xhci
, temp
, &xhci
->ir_set
->irq_pending
);
261 /* Flush posted writes */
262 xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
264 /* FIXME this should be a delayed service routine that clears the EHB */
265 xhci_handle_event(xhci
);
267 /* Clear the event handler busy flag (RW1C); the event ring should be empty. */
268 temp_64
= xhci_read_64(xhci
, &xhci
->ir_set
->erst_dequeue
);
269 xhci_write_64(xhci
, temp_64
| ERST_EHB
, &xhci
->ir_set
->erst_dequeue
);
270 /* Flush posted writes -- FIXME is this necessary? */
271 xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
274 /*-------------------------------------------------------------------------*/
277 * xHCI spec says we can get an interrupt, and if the HC has an error condition,
278 * we might get bad data out of the event ring. Section 4.10.2.7 has a list of
279 * indicators of an event TRB error, but we check the status *first* to be safe.
281 irqreturn_t
xhci_irq(struct usb_hcd
*hcd
)
283 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
287 spin_lock(&xhci
->lock
);
288 trb
= xhci
->event_ring
->dequeue
;
289 /* Check if the xHC generated the interrupt, or the irq is shared */
290 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
291 temp2
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
292 if (temp
== 0xffffffff && temp2
== 0xffffffff)
295 if (!(temp
& STS_EINT
) && !ER_IRQ_PENDING(temp2
)) {
296 spin_unlock(&xhci
->lock
);
299 xhci_dbg(xhci
, "op reg status = %08x\n", temp
);
300 xhci_dbg(xhci
, "ir set irq_pending = %08x\n", temp2
);
301 xhci_dbg(xhci
, "Event ring dequeue ptr:\n");
302 xhci_dbg(xhci
, "@%llx %08x %08x %08x %08x\n",
303 (unsigned long long)xhci_trb_virt_to_dma(xhci
->event_ring
->deq_seg
, trb
),
304 lower_32_bits(trb
->link
.segment_ptr
),
305 upper_32_bits(trb
->link
.segment_ptr
),
306 (unsigned int) trb
->link
.intr_target
,
307 (unsigned int) trb
->link
.control
);
309 if (temp
& STS_FATAL
) {
310 xhci_warn(xhci
, "WARNING: Host System Error\n");
313 xhci_to_hcd(xhci
)->state
= HC_STATE_HALT
;
314 spin_unlock(&xhci
->lock
);
319 spin_unlock(&xhci
->lock
);
324 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
325 void xhci_event_ring_work(unsigned long arg
)
330 struct xhci_hcd
*xhci
= (struct xhci_hcd
*) arg
;
333 xhci_dbg(xhci
, "Poll event ring: %lu\n", jiffies
);
335 spin_lock_irqsave(&xhci
->lock
, flags
);
336 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
337 xhci_dbg(xhci
, "op reg status = 0x%x\n", temp
);
338 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
339 xhci_dbg(xhci
, "ir_set 0 pending = 0x%x\n", temp
);
340 xhci_dbg(xhci
, "No-op commands handled = %d\n", xhci
->noops_handled
);
341 xhci_dbg(xhci
, "HC error bitmask = 0x%x\n", xhci
->error_bitmask
);
342 xhci
->error_bitmask
= 0;
343 xhci_dbg(xhci
, "Event ring:\n");
344 xhci_debug_segment(xhci
, xhci
->event_ring
->deq_seg
);
345 xhci_dbg_ring_ptrs(xhci
, xhci
->event_ring
);
346 temp_64
= xhci_read_64(xhci
, &xhci
->ir_set
->erst_dequeue
);
347 temp_64
&= ~ERST_PTR_MASK
;
348 xhci_dbg(xhci
, "ERST deq = 64'h%0lx\n", (long unsigned int) temp_64
);
349 xhci_dbg(xhci
, "Command ring:\n");
350 xhci_debug_segment(xhci
, xhci
->cmd_ring
->deq_seg
);
351 xhci_dbg_ring_ptrs(xhci
, xhci
->cmd_ring
);
352 xhci_dbg_cmd_ptrs(xhci
);
353 for (i
= 0; i
< MAX_HC_SLOTS
; ++i
) {
356 for (j
= 0; j
< 31; ++j
) {
357 struct xhci_ring
*ring
= xhci
->devs
[i
]->eps
[j
].ring
;
360 xhci_dbg(xhci
, "Dev %d endpoint ring %d:\n", i
, j
);
361 xhci_debug_segment(xhci
, ring
->deq_seg
);
365 if (xhci
->noops_submitted
!= NUM_TEST_NOOPS
)
366 if (xhci_setup_one_noop(xhci
))
367 xhci_ring_cmd_db(xhci
);
368 spin_unlock_irqrestore(&xhci
->lock
, flags
);
371 mod_timer(&xhci
->event_ring_timer
, jiffies
+ POLL_TIMEOUT
* HZ
);
373 xhci_dbg(xhci
, "Quit polling the event ring.\n");
378 * Start the HC after it was halted.
380 * This function is called by the USB core when the HC driver is added.
381 * Its opposite is xhci_stop().
383 * xhci_init() must be called once before this function can be called.
384 * Reset the HC, enable device slot contexts, program DCBAAP, and
385 * set command ring pointer and event ring pointer.
387 * Setup MSI-X vectors and enable interrupts.
389 int xhci_run(struct usb_hcd
*hcd
)
393 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
394 void (*doorbell
)(struct xhci_hcd
*) = NULL
;
396 hcd
->uses_new_polling
= 1;
399 xhci_dbg(xhci
, "xhci_run\n");
400 #if 0 /* FIXME: MSI not setup yet */
401 /* Do this at the very last minute */
402 ret
= xhci_setup_msix(xhci
);
408 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
409 init_timer(&xhci
->event_ring_timer
);
410 xhci
->event_ring_timer
.data
= (unsigned long) xhci
;
411 xhci
->event_ring_timer
.function
= xhci_event_ring_work
;
412 /* Poll the event ring */
413 xhci
->event_ring_timer
.expires
= jiffies
+ POLL_TIMEOUT
* HZ
;
415 xhci_dbg(xhci
, "Setting event ring polling timer\n");
416 add_timer(&xhci
->event_ring_timer
);
419 xhci_dbg(xhci
, "Command ring memory map follows:\n");
420 xhci_debug_ring(xhci
, xhci
->cmd_ring
);
421 xhci_dbg_ring_ptrs(xhci
, xhci
->cmd_ring
);
422 xhci_dbg_cmd_ptrs(xhci
);
424 xhci_dbg(xhci
, "ERST memory map follows:\n");
425 xhci_dbg_erst(xhci
, &xhci
->erst
);
426 xhci_dbg(xhci
, "Event ring:\n");
427 xhci_debug_ring(xhci
, xhci
->event_ring
);
428 xhci_dbg_ring_ptrs(xhci
, xhci
->event_ring
);
429 temp_64
= xhci_read_64(xhci
, &xhci
->ir_set
->erst_dequeue
);
430 temp_64
&= ~ERST_PTR_MASK
;
431 xhci_dbg(xhci
, "ERST deq = 64'h%0lx\n", (long unsigned int) temp_64
);
433 xhci_dbg(xhci
, "// Set the interrupt modulation register\n");
434 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_control
);
435 temp
&= ~ER_IRQ_INTERVAL_MASK
;
437 xhci_writel(xhci
, temp
, &xhci
->ir_set
->irq_control
);
439 /* Set the HCD state before we enable the irqs */
440 hcd
->state
= HC_STATE_RUNNING
;
441 temp
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
443 xhci_dbg(xhci
, "// Enable interrupts, cmd = 0x%x.\n",
445 xhci_writel(xhci
, temp
, &xhci
->op_regs
->command
);
447 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
448 xhci_dbg(xhci
, "// Enabling event ring interrupter %p by writing 0x%x to irq_pending\n",
449 xhci
->ir_set
, (unsigned int) ER_IRQ_ENABLE(temp
));
450 xhci_writel(xhci
, ER_IRQ_ENABLE(temp
),
451 &xhci
->ir_set
->irq_pending
);
452 xhci_print_ir_set(xhci
, xhci
->ir_set
, 0);
454 if (NUM_TEST_NOOPS
> 0)
455 doorbell
= xhci_setup_one_noop(xhci
);
457 temp
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
459 xhci_dbg(xhci
, "// Turn on HC, cmd = 0x%x.\n",
461 xhci_writel(xhci
, temp
, &xhci
->op_regs
->command
);
462 /* Flush PCI posted writes */
463 temp
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
464 xhci_dbg(xhci
, "// @%p = 0x%x\n", &xhci
->op_regs
->command
, temp
);
468 xhci_dbg(xhci
, "Finished xhci_run\n");
475 * This function is called by the USB core when the HC driver is removed.
476 * Its opposite is xhci_run().
478 * Disable device contexts, disable IRQs, and quiesce the HC.
479 * Reset the HC, finish any completed transactions, and cleanup memory.
481 void xhci_stop(struct usb_hcd
*hcd
)
484 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
486 spin_lock_irq(&xhci
->lock
);
487 if (HC_IS_RUNNING(hcd
->state
))
491 spin_unlock_irq(&xhci
->lock
);
493 #if 0 /* No MSI yet */
494 xhci_cleanup_msix(xhci
);
496 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
497 /* Tell the event ring poll function not to reschedule */
499 del_timer_sync(&xhci
->event_ring_timer
);
502 xhci_dbg(xhci
, "// Disabling event ring interrupts\n");
503 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
504 xhci_writel(xhci
, temp
& ~STS_EINT
, &xhci
->op_regs
->status
);
505 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
506 xhci_writel(xhci
, ER_IRQ_DISABLE(temp
),
507 &xhci
->ir_set
->irq_pending
);
508 xhci_print_ir_set(xhci
, xhci
->ir_set
, 0);
510 xhci_dbg(xhci
, "cleaning up memory\n");
511 xhci_mem_cleanup(xhci
);
512 xhci_dbg(xhci
, "xhci_stop completed - status = %x\n",
513 xhci_readl(xhci
, &xhci
->op_regs
->status
));
517 * Shutdown HC (not bus-specific)
519 * This is called when the machine is rebooting or halting. We assume that the
520 * machine will be powered off, and the HC's internal state will be reset.
521 * Don't bother to free memory.
523 void xhci_shutdown(struct usb_hcd
*hcd
)
525 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
527 spin_lock_irq(&xhci
->lock
);
529 spin_unlock_irq(&xhci
->lock
);
532 xhci_cleanup_msix(xhci
);
535 xhci_dbg(xhci
, "xhci_shutdown completed - status = %x\n",
536 xhci_readl(xhci
, &xhci
->op_regs
->status
));
539 /*-------------------------------------------------------------------------*/
542 * xhci_get_endpoint_index - Used for passing endpoint bitmasks between the core and
543 * HCDs. Find the index for an endpoint given its descriptor. Use the return
544 * value to right shift 1 for the bitmask.
546 * Index = (epnum * 2) + direction - 1,
547 * where direction = 0 for OUT, 1 for IN.
548 * For control endpoints, the IN index is used (OUT index is unused), so
549 * index = (epnum * 2) + direction - 1 = (epnum * 2) + 1 - 1 = (epnum * 2)
551 unsigned int xhci_get_endpoint_index(struct usb_endpoint_descriptor
*desc
)
554 if (usb_endpoint_xfer_control(desc
))
555 index
= (unsigned int) (usb_endpoint_num(desc
)*2);
557 index
= (unsigned int) (usb_endpoint_num(desc
)*2) +
558 (usb_endpoint_dir_in(desc
) ? 1 : 0) - 1;
562 /* Find the flag for this endpoint (for use in the control context). Use the
563 * endpoint index to create a bitmask. The slot context is bit 0, endpoint 0 is
566 unsigned int xhci_get_endpoint_flag(struct usb_endpoint_descriptor
*desc
)
568 return 1 << (xhci_get_endpoint_index(desc
) + 1);
571 /* Find the flag for this endpoint (for use in the control context). Use the
572 * endpoint index to create a bitmask. The slot context is bit 0, endpoint 0 is
575 unsigned int xhci_get_endpoint_flag_from_index(unsigned int ep_index
)
577 return 1 << (ep_index
+ 1);
580 /* Compute the last valid endpoint context index. Basically, this is the
581 * endpoint index plus one. For slot contexts with more than valid endpoint,
582 * we find the most significant bit set in the added contexts flags.
583 * e.g. ep 1 IN (with epnum 0x81) => added_ctxs = 0b1000
584 * fls(0b1000) = 4, but the endpoint context index is 3, so subtract one.
586 unsigned int xhci_last_valid_endpoint(u32 added_ctxs
)
588 return fls(added_ctxs
) - 1;
591 /* Returns 1 if the arguments are OK;
592 * returns 0 this is a root hub; returns -EINVAL for NULL pointers.
594 int xhci_check_args(struct usb_hcd
*hcd
, struct usb_device
*udev
,
595 struct usb_host_endpoint
*ep
, int check_ep
, const char *func
) {
596 if (!hcd
|| (check_ep
&& !ep
) || !udev
) {
597 printk(KERN_DEBUG
"xHCI %s called with invalid args\n",
602 printk(KERN_DEBUG
"xHCI %s called for root hub\n",
606 if (!udev
->slot_id
) {
607 printk(KERN_DEBUG
"xHCI %s called with unaddressed device\n",
614 static int xhci_configure_endpoint(struct xhci_hcd
*xhci
,
615 struct usb_device
*udev
, struct xhci_command
*command
,
616 bool ctx_change
, bool must_succeed
);
619 * Full speed devices may have a max packet size greater than 8 bytes, but the
620 * USB core doesn't know that until it reads the first 8 bytes of the
621 * descriptor. If the usb_device's max packet size changes after that point,
622 * we need to issue an evaluate context command and wait on it.
624 static int xhci_check_maxpacket(struct xhci_hcd
*xhci
, unsigned int slot_id
,
625 unsigned int ep_index
, struct urb
*urb
)
627 struct xhci_container_ctx
*in_ctx
;
628 struct xhci_container_ctx
*out_ctx
;
629 struct xhci_input_control_ctx
*ctrl_ctx
;
630 struct xhci_ep_ctx
*ep_ctx
;
632 int hw_max_packet_size
;
635 out_ctx
= xhci
->devs
[slot_id
]->out_ctx
;
636 ep_ctx
= xhci_get_ep_ctx(xhci
, out_ctx
, ep_index
);
637 hw_max_packet_size
= MAX_PACKET_DECODED(ep_ctx
->ep_info2
);
638 max_packet_size
= urb
->dev
->ep0
.desc
.wMaxPacketSize
;
639 if (hw_max_packet_size
!= max_packet_size
) {
640 xhci_dbg(xhci
, "Max Packet Size for ep 0 changed.\n");
641 xhci_dbg(xhci
, "Max packet size in usb_device = %d\n",
643 xhci_dbg(xhci
, "Max packet size in xHCI HW = %d\n",
645 xhci_dbg(xhci
, "Issuing evaluate context command.\n");
647 /* Set up the modified control endpoint 0 */
648 xhci_endpoint_copy(xhci
, xhci
->devs
[slot_id
]->in_ctx
,
649 xhci
->devs
[slot_id
]->out_ctx
, ep_index
);
650 in_ctx
= xhci
->devs
[slot_id
]->in_ctx
;
651 ep_ctx
= xhci_get_ep_ctx(xhci
, in_ctx
, ep_index
);
652 ep_ctx
->ep_info2
&= ~MAX_PACKET_MASK
;
653 ep_ctx
->ep_info2
|= MAX_PACKET(max_packet_size
);
655 /* Set up the input context flags for the command */
656 /* FIXME: This won't work if a non-default control endpoint
657 * changes max packet sizes.
659 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
660 ctrl_ctx
->add_flags
= EP0_FLAG
;
661 ctrl_ctx
->drop_flags
= 0;
663 xhci_dbg(xhci
, "Slot %d input context\n", slot_id
);
664 xhci_dbg_ctx(xhci
, in_ctx
, ep_index
);
665 xhci_dbg(xhci
, "Slot %d output context\n", slot_id
);
666 xhci_dbg_ctx(xhci
, out_ctx
, ep_index
);
668 ret
= xhci_configure_endpoint(xhci
, urb
->dev
, NULL
,
671 /* Clean up the input context for later use by bandwidth
674 ctrl_ctx
->add_flags
= SLOT_FLAG
;
680 * non-error returns are a promise to giveback() the urb later
681 * we drop ownership so next owner (or urb unlink) can get it
683 int xhci_urb_enqueue(struct usb_hcd
*hcd
, struct urb
*urb
, gfp_t mem_flags
)
685 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
688 unsigned int slot_id
, ep_index
;
691 if (!urb
|| xhci_check_args(hcd
, urb
->dev
, urb
->ep
, true, __func__
) <= 0)
694 slot_id
= urb
->dev
->slot_id
;
695 ep_index
= xhci_get_endpoint_index(&urb
->ep
->desc
);
697 if (!xhci
->devs
|| !xhci
->devs
[slot_id
]) {
699 dev_warn(&urb
->dev
->dev
, "WARN: urb submitted for dev with no Slot ID\n");
703 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
)) {
705 xhci_dbg(xhci
, "urb submitted during PCI suspend\n");
709 if (usb_endpoint_xfer_control(&urb
->ep
->desc
)) {
710 /* Check to see if the max packet size for the default control
711 * endpoint changed during FS device enumeration
713 if (urb
->dev
->speed
== USB_SPEED_FULL
) {
714 ret
= xhci_check_maxpacket(xhci
, slot_id
,
720 /* We have a spinlock and interrupts disabled, so we must pass
721 * atomic context to this function, which may allocate memory.
723 spin_lock_irqsave(&xhci
->lock
, flags
);
724 ret
= xhci_queue_ctrl_tx(xhci
, GFP_ATOMIC
, urb
,
726 spin_unlock_irqrestore(&xhci
->lock
, flags
);
727 } else if (usb_endpoint_xfer_bulk(&urb
->ep
->desc
)) {
728 spin_lock_irqsave(&xhci
->lock
, flags
);
729 ret
= xhci_queue_bulk_tx(xhci
, GFP_ATOMIC
, urb
,
731 spin_unlock_irqrestore(&xhci
->lock
, flags
);
732 } else if (usb_endpoint_xfer_int(&urb
->ep
->desc
)) {
733 spin_lock_irqsave(&xhci
->lock
, flags
);
734 ret
= xhci_queue_intr_tx(xhci
, GFP_ATOMIC
, urb
,
736 spin_unlock_irqrestore(&xhci
->lock
, flags
);
745 * Remove the URB's TD from the endpoint ring. This may cause the HC to stop
746 * USB transfers, potentially stopping in the middle of a TRB buffer. The HC
747 * should pick up where it left off in the TD, unless a Set Transfer Ring
748 * Dequeue Pointer is issued.
750 * The TRBs that make up the buffers for the canceled URB will be "removed" from
751 * the ring. Since the ring is a contiguous structure, they can't be physically
752 * removed. Instead, there are two options:
754 * 1) If the HC is in the middle of processing the URB to be canceled, we
755 * simply move the ring's dequeue pointer past those TRBs using the Set
756 * Transfer Ring Dequeue Pointer command. This will be the common case,
757 * when drivers timeout on the last submitted URB and attempt to cancel.
759 * 2) If the HC is in the middle of a different TD, we turn the TRBs into a
760 * series of 1-TRB transfer no-op TDs. (No-ops shouldn't be chained.) The
761 * HC will need to invalidate the any TRBs it has cached after the stop
762 * endpoint command, as noted in the xHCI 0.95 errata.
764 * 3) The TD may have completed by the time the Stop Endpoint Command
765 * completes, so software needs to handle that case too.
767 * This function should protect against the TD enqueueing code ringing the
768 * doorbell while this code is waiting for a Stop Endpoint command to complete.
769 * It also needs to account for multiple cancellations on happening at the same
770 * time for the same endpoint.
772 * Note that this function can be called in any context, or so says
773 * usb_hcd_unlink_urb()
775 int xhci_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
779 struct xhci_hcd
*xhci
;
781 unsigned int ep_index
;
782 struct xhci_ring
*ep_ring
;
783 struct xhci_virt_ep
*ep
;
785 xhci
= hcd_to_xhci(hcd
);
786 spin_lock_irqsave(&xhci
->lock
, flags
);
787 /* Make sure the URB hasn't completed or been unlinked already */
788 ret
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
789 if (ret
|| !urb
->hcpriv
)
792 xhci_dbg(xhci
, "Cancel URB %p\n", urb
);
793 xhci_dbg(xhci
, "Event ring:\n");
794 xhci_debug_ring(xhci
, xhci
->event_ring
);
795 ep_index
= xhci_get_endpoint_index(&urb
->ep
->desc
);
796 ep
= &xhci
->devs
[urb
->dev
->slot_id
]->eps
[ep_index
];
798 xhci_dbg(xhci
, "Endpoint ring:\n");
799 xhci_debug_ring(xhci
, ep_ring
);
800 td
= (struct xhci_td
*) urb
->hcpriv
;
802 ep
->cancels_pending
++;
803 list_add_tail(&td
->cancelled_td_list
, &ep
->cancelled_td_list
);
804 /* Queue a stop endpoint command, but only if this is
805 * the first cancellation to be handled.
807 if (ep
->cancels_pending
== 1) {
808 xhci_queue_stop_endpoint(xhci
, urb
->dev
->slot_id
, ep_index
);
809 xhci_ring_cmd_db(xhci
);
812 spin_unlock_irqrestore(&xhci
->lock
, flags
);
816 /* Drop an endpoint from a new bandwidth configuration for this device.
817 * Only one call to this function is allowed per endpoint before
818 * check_bandwidth() or reset_bandwidth() must be called.
819 * A call to xhci_drop_endpoint() followed by a call to xhci_add_endpoint() will
820 * add the endpoint to the schedule with possibly new parameters denoted by a
821 * different endpoint descriptor in usb_host_endpoint.
822 * A call to xhci_add_endpoint() followed by a call to xhci_drop_endpoint() is
825 * The USB core will not allow URBs to be queued to an endpoint that is being
826 * disabled, so there's no need for mutual exclusion to protect
827 * the xhci->devs[slot_id] structure.
829 int xhci_drop_endpoint(struct usb_hcd
*hcd
, struct usb_device
*udev
,
830 struct usb_host_endpoint
*ep
)
832 struct xhci_hcd
*xhci
;
833 struct xhci_container_ctx
*in_ctx
, *out_ctx
;
834 struct xhci_input_control_ctx
*ctrl_ctx
;
835 struct xhci_slot_ctx
*slot_ctx
;
836 unsigned int last_ctx
;
837 unsigned int ep_index
;
838 struct xhci_ep_ctx
*ep_ctx
;
840 u32 new_add_flags
, new_drop_flags
, new_slot_info
;
843 ret
= xhci_check_args(hcd
, udev
, ep
, 1, __func__
);
846 xhci
= hcd_to_xhci(hcd
);
847 xhci_dbg(xhci
, "%s called for udev %p\n", __func__
, udev
);
849 drop_flag
= xhci_get_endpoint_flag(&ep
->desc
);
850 if (drop_flag
== SLOT_FLAG
|| drop_flag
== EP0_FLAG
) {
851 xhci_dbg(xhci
, "xHCI %s - can't drop slot or ep 0 %#x\n",
852 __func__
, drop_flag
);
856 if (!xhci
->devs
|| !xhci
->devs
[udev
->slot_id
]) {
857 xhci_warn(xhci
, "xHCI %s called with unaddressed device\n",
862 in_ctx
= xhci
->devs
[udev
->slot_id
]->in_ctx
;
863 out_ctx
= xhci
->devs
[udev
->slot_id
]->out_ctx
;
864 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
865 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
866 ep_ctx
= xhci_get_ep_ctx(xhci
, out_ctx
, ep_index
);
867 /* If the HC already knows the endpoint is disabled,
868 * or the HCD has noted it is disabled, ignore this request
870 if ((ep_ctx
->ep_info
& EP_STATE_MASK
) == EP_STATE_DISABLED
||
871 ctrl_ctx
->drop_flags
& xhci_get_endpoint_flag(&ep
->desc
)) {
872 xhci_warn(xhci
, "xHCI %s called with disabled ep %p\n",
877 ctrl_ctx
->drop_flags
|= drop_flag
;
878 new_drop_flags
= ctrl_ctx
->drop_flags
;
880 ctrl_ctx
->add_flags
= ~drop_flag
;
881 new_add_flags
= ctrl_ctx
->add_flags
;
883 last_ctx
= xhci_last_valid_endpoint(ctrl_ctx
->add_flags
);
884 slot_ctx
= xhci_get_slot_ctx(xhci
, in_ctx
);
885 /* Update the last valid endpoint context, if we deleted the last one */
886 if ((slot_ctx
->dev_info
& LAST_CTX_MASK
) > LAST_CTX(last_ctx
)) {
887 slot_ctx
->dev_info
&= ~LAST_CTX_MASK
;
888 slot_ctx
->dev_info
|= LAST_CTX(last_ctx
);
890 new_slot_info
= slot_ctx
->dev_info
;
892 xhci_endpoint_zero(xhci
, xhci
->devs
[udev
->slot_id
], ep
);
894 xhci_dbg(xhci
, "drop ep 0x%x, slot id %d, new drop flags = %#x, new add flags = %#x, new slot info = %#x\n",
895 (unsigned int) ep
->desc
.bEndpointAddress
,
897 (unsigned int) new_drop_flags
,
898 (unsigned int) new_add_flags
,
899 (unsigned int) new_slot_info
);
903 /* Add an endpoint to a new possible bandwidth configuration for this device.
904 * Only one call to this function is allowed per endpoint before
905 * check_bandwidth() or reset_bandwidth() must be called.
906 * A call to xhci_drop_endpoint() followed by a call to xhci_add_endpoint() will
907 * add the endpoint to the schedule with possibly new parameters denoted by a
908 * different endpoint descriptor in usb_host_endpoint.
909 * A call to xhci_add_endpoint() followed by a call to xhci_drop_endpoint() is
912 * The USB core will not allow URBs to be queued to an endpoint until the
913 * configuration or alt setting is installed in the device, so there's no need
914 * for mutual exclusion to protect the xhci->devs[slot_id] structure.
916 int xhci_add_endpoint(struct usb_hcd
*hcd
, struct usb_device
*udev
,
917 struct usb_host_endpoint
*ep
)
919 struct xhci_hcd
*xhci
;
920 struct xhci_container_ctx
*in_ctx
, *out_ctx
;
921 unsigned int ep_index
;
922 struct xhci_ep_ctx
*ep_ctx
;
923 struct xhci_slot_ctx
*slot_ctx
;
924 struct xhci_input_control_ctx
*ctrl_ctx
;
926 unsigned int last_ctx
;
927 u32 new_add_flags
, new_drop_flags
, new_slot_info
;
930 ret
= xhci_check_args(hcd
, udev
, ep
, 1, __func__
);
932 /* So we won't queue a reset ep command for a root hub */
936 xhci
= hcd_to_xhci(hcd
);
938 added_ctxs
= xhci_get_endpoint_flag(&ep
->desc
);
939 last_ctx
= xhci_last_valid_endpoint(added_ctxs
);
940 if (added_ctxs
== SLOT_FLAG
|| added_ctxs
== EP0_FLAG
) {
941 /* FIXME when we have to issue an evaluate endpoint command to
942 * deal with ep0 max packet size changing once we get the
945 xhci_dbg(xhci
, "xHCI %s - can't add slot or ep 0 %#x\n",
946 __func__
, added_ctxs
);
950 if (!xhci
->devs
|| !xhci
->devs
[udev
->slot_id
]) {
951 xhci_warn(xhci
, "xHCI %s called with unaddressed device\n",
956 in_ctx
= xhci
->devs
[udev
->slot_id
]->in_ctx
;
957 out_ctx
= xhci
->devs
[udev
->slot_id
]->out_ctx
;
958 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
959 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
960 ep_ctx
= xhci_get_ep_ctx(xhci
, out_ctx
, ep_index
);
961 /* If the HCD has already noted the endpoint is enabled,
962 * ignore this request.
964 if (ctrl_ctx
->add_flags
& xhci_get_endpoint_flag(&ep
->desc
)) {
965 xhci_warn(xhci
, "xHCI %s called with enabled ep %p\n",
971 * Configuration and alternate setting changes must be done in
972 * process context, not interrupt context (or so documenation
973 * for usb_set_interface() and usb_set_configuration() claim).
975 if (xhci_endpoint_init(xhci
, xhci
->devs
[udev
->slot_id
],
976 udev
, ep
, GFP_KERNEL
) < 0) {
977 dev_dbg(&udev
->dev
, "%s - could not initialize ep %#x\n",
978 __func__
, ep
->desc
.bEndpointAddress
);
982 ctrl_ctx
->add_flags
|= added_ctxs
;
983 new_add_flags
= ctrl_ctx
->add_flags
;
985 /* If xhci_endpoint_disable() was called for this endpoint, but the
986 * xHC hasn't been notified yet through the check_bandwidth() call,
987 * this re-adds a new state for the endpoint from the new endpoint
988 * descriptors. We must drop and re-add this endpoint, so we leave the
991 new_drop_flags
= ctrl_ctx
->drop_flags
;
993 slot_ctx
= xhci_get_slot_ctx(xhci
, in_ctx
);
994 /* Update the last valid endpoint context, if we just added one past */
995 if ((slot_ctx
->dev_info
& LAST_CTX_MASK
) < LAST_CTX(last_ctx
)) {
996 slot_ctx
->dev_info
&= ~LAST_CTX_MASK
;
997 slot_ctx
->dev_info
|= LAST_CTX(last_ctx
);
999 new_slot_info
= slot_ctx
->dev_info
;
1001 /* Store the usb_device pointer for later use */
1004 xhci_dbg(xhci
, "add ep 0x%x, slot id %d, new drop flags = %#x, new add flags = %#x, new slot info = %#x\n",
1005 (unsigned int) ep
->desc
.bEndpointAddress
,
1007 (unsigned int) new_drop_flags
,
1008 (unsigned int) new_add_flags
,
1009 (unsigned int) new_slot_info
);
1013 static void xhci_zero_in_ctx(struct xhci_hcd
*xhci
, struct xhci_virt_device
*virt_dev
)
1015 struct xhci_input_control_ctx
*ctrl_ctx
;
1016 struct xhci_ep_ctx
*ep_ctx
;
1017 struct xhci_slot_ctx
*slot_ctx
;
1020 /* When a device's add flag and drop flag are zero, any subsequent
1021 * configure endpoint command will leave that endpoint's state
1022 * untouched. Make sure we don't leave any old state in the input
1023 * endpoint contexts.
1025 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, virt_dev
->in_ctx
);
1026 ctrl_ctx
->drop_flags
= 0;
1027 ctrl_ctx
->add_flags
= 0;
1028 slot_ctx
= xhci_get_slot_ctx(xhci
, virt_dev
->in_ctx
);
1029 slot_ctx
->dev_info
&= ~LAST_CTX_MASK
;
1030 /* Endpoint 0 is always valid */
1031 slot_ctx
->dev_info
|= LAST_CTX(1);
1032 for (i
= 1; i
< 31; ++i
) {
1033 ep_ctx
= xhci_get_ep_ctx(xhci
, virt_dev
->in_ctx
, i
);
1034 ep_ctx
->ep_info
= 0;
1035 ep_ctx
->ep_info2
= 0;
1037 ep_ctx
->tx_info
= 0;
1041 static int xhci_configure_endpoint_result(struct xhci_hcd
*xhci
,
1042 struct usb_device
*udev
, int *cmd_status
)
1046 switch (*cmd_status
) {
1048 dev_warn(&udev
->dev
, "Not enough host controller resources "
1049 "for new device state.\n");
1051 /* FIXME: can we allocate more resources for the HC? */
1054 dev_warn(&udev
->dev
, "Not enough bandwidth "
1055 "for new device state.\n");
1057 /* FIXME: can we go back to the old state? */
1060 /* the HCD set up something wrong */
1061 dev_warn(&udev
->dev
, "ERROR: Endpoint drop flag = 0, "
1063 "and endpoint is not disabled.\n");
1067 dev_dbg(&udev
->dev
, "Successful Endpoint Configure command\n");
1071 xhci_err(xhci
, "ERROR: unexpected command completion "
1072 "code 0x%x.\n", *cmd_status
);
1079 static int xhci_evaluate_context_result(struct xhci_hcd
*xhci
,
1080 struct usb_device
*udev
, int *cmd_status
)
1083 struct xhci_virt_device
*virt_dev
= xhci
->devs
[udev
->slot_id
];
1085 switch (*cmd_status
) {
1087 dev_warn(&udev
->dev
, "WARN: xHCI driver setup invalid evaluate "
1088 "context command.\n");
1092 dev_warn(&udev
->dev
, "WARN: slot not enabled for"
1093 "evaluate context command.\n");
1094 case COMP_CTX_STATE
:
1095 dev_warn(&udev
->dev
, "WARN: invalid context state for "
1096 "evaluate context command.\n");
1097 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, 1);
1101 dev_dbg(&udev
->dev
, "Successful evaluate context command\n");
1105 xhci_err(xhci
, "ERROR: unexpected command completion "
1106 "code 0x%x.\n", *cmd_status
);
1113 /* Issue a configure endpoint command or evaluate context command
1114 * and wait for it to finish.
1116 static int xhci_configure_endpoint(struct xhci_hcd
*xhci
,
1117 struct usb_device
*udev
,
1118 struct xhci_command
*command
,
1119 bool ctx_change
, bool must_succeed
)
1123 unsigned long flags
;
1124 struct xhci_container_ctx
*in_ctx
;
1125 struct completion
*cmd_completion
;
1127 struct xhci_virt_device
*virt_dev
;
1129 spin_lock_irqsave(&xhci
->lock
, flags
);
1130 virt_dev
= xhci
->devs
[udev
->slot_id
];
1132 in_ctx
= command
->in_ctx
;
1133 cmd_completion
= command
->completion
;
1134 cmd_status
= &command
->status
;
1135 command
->command_trb
= xhci
->cmd_ring
->enqueue
;
1136 list_add_tail(&command
->cmd_list
, &virt_dev
->cmd_list
);
1138 in_ctx
= virt_dev
->in_ctx
;
1139 cmd_completion
= &virt_dev
->cmd_completion
;
1140 cmd_status
= &virt_dev
->cmd_status
;
1144 ret
= xhci_queue_configure_endpoint(xhci
, in_ctx
->dma
,
1145 udev
->slot_id
, must_succeed
);
1147 ret
= xhci_queue_evaluate_context(xhci
, in_ctx
->dma
,
1150 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1151 xhci_dbg(xhci
, "FIXME allocate a new ring segment\n");
1154 xhci_ring_cmd_db(xhci
);
1155 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1157 /* Wait for the configure endpoint command to complete */
1158 timeleft
= wait_for_completion_interruptible_timeout(
1160 USB_CTRL_SET_TIMEOUT
);
1161 if (timeleft
<= 0) {
1162 xhci_warn(xhci
, "%s while waiting for %s command\n",
1163 timeleft
== 0 ? "Timeout" : "Signal",
1165 "configure endpoint" :
1166 "evaluate context");
1167 /* FIXME cancel the configure endpoint command */
1172 return xhci_configure_endpoint_result(xhci
, udev
, cmd_status
);
1173 return xhci_evaluate_context_result(xhci
, udev
, cmd_status
);
1176 /* Called after one or more calls to xhci_add_endpoint() or
1177 * xhci_drop_endpoint(). If this call fails, the USB core is expected
1178 * to call xhci_reset_bandwidth().
1180 * Since we are in the middle of changing either configuration or
1181 * installing a new alt setting, the USB core won't allow URBs to be
1182 * enqueued for any endpoint on the old config or interface. Nothing
1183 * else should be touching the xhci->devs[slot_id] structure, so we
1184 * don't need to take the xhci->lock for manipulating that.
1186 int xhci_check_bandwidth(struct usb_hcd
*hcd
, struct usb_device
*udev
)
1190 struct xhci_hcd
*xhci
;
1191 struct xhci_virt_device
*virt_dev
;
1192 struct xhci_input_control_ctx
*ctrl_ctx
;
1193 struct xhci_slot_ctx
*slot_ctx
;
1195 ret
= xhci_check_args(hcd
, udev
, NULL
, 0, __func__
);
1198 xhci
= hcd_to_xhci(hcd
);
1200 if (!udev
->slot_id
|| !xhci
->devs
|| !xhci
->devs
[udev
->slot_id
]) {
1201 xhci_warn(xhci
, "xHCI %s called with unaddressed device\n",
1205 xhci_dbg(xhci
, "%s called for udev %p\n", __func__
, udev
);
1206 virt_dev
= xhci
->devs
[udev
->slot_id
];
1208 /* See section 4.6.6 - A0 = 1; A1 = D0 = D1 = 0 */
1209 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, virt_dev
->in_ctx
);
1210 ctrl_ctx
->add_flags
|= SLOT_FLAG
;
1211 ctrl_ctx
->add_flags
&= ~EP0_FLAG
;
1212 ctrl_ctx
->drop_flags
&= ~SLOT_FLAG
;
1213 ctrl_ctx
->drop_flags
&= ~EP0_FLAG
;
1214 xhci_dbg(xhci
, "New Input Control Context:\n");
1215 slot_ctx
= xhci_get_slot_ctx(xhci
, virt_dev
->in_ctx
);
1216 xhci_dbg_ctx(xhci
, virt_dev
->in_ctx
,
1217 LAST_CTX_TO_EP_NUM(slot_ctx
->dev_info
));
1219 ret
= xhci_configure_endpoint(xhci
, udev
, NULL
,
1222 /* Callee should call reset_bandwidth() */
1226 xhci_dbg(xhci
, "Output context after successful config ep cmd:\n");
1227 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
,
1228 LAST_CTX_TO_EP_NUM(slot_ctx
->dev_info
));
1230 xhci_zero_in_ctx(xhci
, virt_dev
);
1231 /* Free any old rings */
1232 for (i
= 1; i
< 31; ++i
) {
1233 if (virt_dev
->eps
[i
].new_ring
) {
1234 xhci_ring_free(xhci
, virt_dev
->eps
[i
].ring
);
1235 virt_dev
->eps
[i
].ring
= virt_dev
->eps
[i
].new_ring
;
1236 virt_dev
->eps
[i
].new_ring
= NULL
;
1243 void xhci_reset_bandwidth(struct usb_hcd
*hcd
, struct usb_device
*udev
)
1245 struct xhci_hcd
*xhci
;
1246 struct xhci_virt_device
*virt_dev
;
1249 ret
= xhci_check_args(hcd
, udev
, NULL
, 0, __func__
);
1252 xhci
= hcd_to_xhci(hcd
);
1254 if (!xhci
->devs
|| !xhci
->devs
[udev
->slot_id
]) {
1255 xhci_warn(xhci
, "xHCI %s called with unaddressed device\n",
1259 xhci_dbg(xhci
, "%s called for udev %p\n", __func__
, udev
);
1260 virt_dev
= xhci
->devs
[udev
->slot_id
];
1261 /* Free any rings allocated for added endpoints */
1262 for (i
= 0; i
< 31; ++i
) {
1263 if (virt_dev
->eps
[i
].new_ring
) {
1264 xhci_ring_free(xhci
, virt_dev
->eps
[i
].new_ring
);
1265 virt_dev
->eps
[i
].new_ring
= NULL
;
1268 xhci_zero_in_ctx(xhci
, virt_dev
);
1271 static void xhci_setup_input_ctx_for_config_ep(struct xhci_hcd
*xhci
,
1272 struct xhci_container_ctx
*in_ctx
,
1273 struct xhci_container_ctx
*out_ctx
,
1274 u32 add_flags
, u32 drop_flags
)
1276 struct xhci_input_control_ctx
*ctrl_ctx
;
1277 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
1278 ctrl_ctx
->add_flags
= add_flags
;
1279 ctrl_ctx
->drop_flags
= drop_flags
;
1280 xhci_slot_copy(xhci
, in_ctx
, out_ctx
);
1281 ctrl_ctx
->add_flags
|= SLOT_FLAG
;
1283 xhci_dbg(xhci
, "Input Context:\n");
1284 xhci_dbg_ctx(xhci
, in_ctx
, xhci_last_valid_endpoint(add_flags
));
1287 void xhci_setup_input_ctx_for_quirk(struct xhci_hcd
*xhci
,
1288 unsigned int slot_id
, unsigned int ep_index
,
1289 struct xhci_dequeue_state
*deq_state
)
1291 struct xhci_container_ctx
*in_ctx
;
1292 struct xhci_ep_ctx
*ep_ctx
;
1296 xhci_endpoint_copy(xhci
, xhci
->devs
[slot_id
]->in_ctx
,
1297 xhci
->devs
[slot_id
]->out_ctx
, ep_index
);
1298 in_ctx
= xhci
->devs
[slot_id
]->in_ctx
;
1299 ep_ctx
= xhci_get_ep_ctx(xhci
, in_ctx
, ep_index
);
1300 addr
= xhci_trb_virt_to_dma(deq_state
->new_deq_seg
,
1301 deq_state
->new_deq_ptr
);
1303 xhci_warn(xhci
, "WARN Cannot submit config ep after "
1304 "reset ep command\n");
1305 xhci_warn(xhci
, "WARN deq seg = %p, deq ptr = %p\n",
1306 deq_state
->new_deq_seg
,
1307 deq_state
->new_deq_ptr
);
1310 ep_ctx
->deq
= addr
| deq_state
->new_cycle_state
;
1312 added_ctxs
= xhci_get_endpoint_flag_from_index(ep_index
);
1313 xhci_setup_input_ctx_for_config_ep(xhci
, xhci
->devs
[slot_id
]->in_ctx
,
1314 xhci
->devs
[slot_id
]->out_ctx
, added_ctxs
, added_ctxs
);
1317 void xhci_cleanup_stalled_ring(struct xhci_hcd
*xhci
,
1318 struct usb_device
*udev
, unsigned int ep_index
)
1320 struct xhci_dequeue_state deq_state
;
1321 struct xhci_virt_ep
*ep
;
1323 xhci_dbg(xhci
, "Cleaning up stalled endpoint ring\n");
1324 ep
= &xhci
->devs
[udev
->slot_id
]->eps
[ep_index
];
1325 /* We need to move the HW's dequeue pointer past this TD,
1326 * or it will attempt to resend it on the next doorbell ring.
1328 xhci_find_new_dequeue_state(xhci
, udev
->slot_id
,
1329 ep_index
, ep
->stopped_td
,
1332 /* HW with the reset endpoint quirk will use the saved dequeue state to
1333 * issue a configure endpoint command later.
1335 if (!(xhci
->quirks
& XHCI_RESET_EP_QUIRK
)) {
1336 xhci_dbg(xhci
, "Queueing new dequeue state\n");
1337 xhci_queue_new_dequeue_state(xhci
, udev
->slot_id
,
1338 ep_index
, &deq_state
);
1340 /* Better hope no one uses the input context between now and the
1341 * reset endpoint completion!
1343 xhci_dbg(xhci
, "Setting up input context for "
1344 "configure endpoint command\n");
1345 xhci_setup_input_ctx_for_quirk(xhci
, udev
->slot_id
,
1346 ep_index
, &deq_state
);
1350 /* Deal with stalled endpoints. The core should have sent the control message
1351 * to clear the halt condition. However, we need to make the xHCI hardware
1352 * reset its sequence number, since a device will expect a sequence number of
1353 * zero after the halt condition is cleared.
1354 * Context: in_interrupt
1356 void xhci_endpoint_reset(struct usb_hcd
*hcd
,
1357 struct usb_host_endpoint
*ep
)
1359 struct xhci_hcd
*xhci
;
1360 struct usb_device
*udev
;
1361 unsigned int ep_index
;
1362 unsigned long flags
;
1364 struct xhci_virt_ep
*virt_ep
;
1366 xhci
= hcd_to_xhci(hcd
);
1367 udev
= (struct usb_device
*) ep
->hcpriv
;
1368 /* Called with a root hub endpoint (or an endpoint that wasn't added
1369 * with xhci_add_endpoint()
1373 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
1374 virt_ep
= &xhci
->devs
[udev
->slot_id
]->eps
[ep_index
];
1375 if (!virt_ep
->stopped_td
) {
1376 xhci_dbg(xhci
, "Endpoint 0x%x not halted, refusing to reset.\n",
1377 ep
->desc
.bEndpointAddress
);
1380 if (usb_endpoint_xfer_control(&ep
->desc
)) {
1381 xhci_dbg(xhci
, "Control endpoint stall already handled.\n");
1385 xhci_dbg(xhci
, "Queueing reset endpoint command\n");
1386 spin_lock_irqsave(&xhci
->lock
, flags
);
1387 ret
= xhci_queue_reset_ep(xhci
, udev
->slot_id
, ep_index
);
1389 * Can't change the ring dequeue pointer until it's transitioned to the
1390 * stopped state, which is only upon a successful reset endpoint
1391 * command. Better hope that last command worked!
1394 xhci_cleanup_stalled_ring(xhci
, udev
, ep_index
);
1395 kfree(virt_ep
->stopped_td
);
1396 xhci_ring_cmd_db(xhci
);
1398 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1401 xhci_warn(xhci
, "FIXME allocate a new ring segment\n");
1405 * At this point, the struct usb_device is about to go away, the device has
1406 * disconnected, and all traffic has been stopped and the endpoints have been
1407 * disabled. Free any HC data structures associated with that device.
1409 void xhci_free_dev(struct usb_hcd
*hcd
, struct usb_device
*udev
)
1411 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
1412 unsigned long flags
;
1414 if (udev
->slot_id
== 0)
1417 spin_lock_irqsave(&xhci
->lock
, flags
);
1418 if (xhci_queue_slot_control(xhci
, TRB_DISABLE_SLOT
, udev
->slot_id
)) {
1419 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1420 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
1423 xhci_ring_cmd_db(xhci
);
1424 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1426 * Event command completion handler will free any data structures
1427 * associated with the slot. XXX Can free sleep?
1432 * Returns 0 if the xHC ran out of device slots, the Enable Slot command
1433 * timed out, or allocating memory failed. Returns 1 on success.
1435 int xhci_alloc_dev(struct usb_hcd
*hcd
, struct usb_device
*udev
)
1437 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
1438 unsigned long flags
;
1442 spin_lock_irqsave(&xhci
->lock
, flags
);
1443 ret
= xhci_queue_slot_control(xhci
, TRB_ENABLE_SLOT
, 0);
1445 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1446 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
1449 xhci_ring_cmd_db(xhci
);
1450 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1452 /* XXX: how much time for xHC slot assignment? */
1453 timeleft
= wait_for_completion_interruptible_timeout(&xhci
->addr_dev
,
1454 USB_CTRL_SET_TIMEOUT
);
1455 if (timeleft
<= 0) {
1456 xhci_warn(xhci
, "%s while waiting for a slot\n",
1457 timeleft
== 0 ? "Timeout" : "Signal");
1458 /* FIXME cancel the enable slot request */
1462 if (!xhci
->slot_id
) {
1463 xhci_err(xhci
, "Error while assigning device slot ID\n");
1466 /* xhci_alloc_virt_device() does not touch rings; no need to lock */
1467 if (!xhci_alloc_virt_device(xhci
, xhci
->slot_id
, udev
, GFP_KERNEL
)) {
1468 /* Disable slot, if we can do it without mem alloc */
1469 xhci_warn(xhci
, "Could not allocate xHCI USB device data structures\n");
1470 spin_lock_irqsave(&xhci
->lock
, flags
);
1471 if (!xhci_queue_slot_control(xhci
, TRB_DISABLE_SLOT
, udev
->slot_id
))
1472 xhci_ring_cmd_db(xhci
);
1473 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1476 udev
->slot_id
= xhci
->slot_id
;
1477 /* Is this a LS or FS device under a HS hub? */
1478 /* Hub or peripherial? */
1483 * Issue an Address Device command (which will issue a SetAddress request to
1485 * We should be protected by the usb_address0_mutex in khubd's hub_port_init, so
1486 * we should only issue and wait on one address command at the same time.
1488 * We add one to the device address issued by the hardware because the USB core
1489 * uses address 1 for the root hubs (even though they're not really devices).
1491 int xhci_address_device(struct usb_hcd
*hcd
, struct usb_device
*udev
)
1493 unsigned long flags
;
1495 struct xhci_virt_device
*virt_dev
;
1497 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
1498 struct xhci_slot_ctx
*slot_ctx
;
1499 struct xhci_input_control_ctx
*ctrl_ctx
;
1502 if (!udev
->slot_id
) {
1503 xhci_dbg(xhci
, "Bad Slot ID %d\n", udev
->slot_id
);
1507 virt_dev
= xhci
->devs
[udev
->slot_id
];
1509 /* If this is a Set Address to an unconfigured device, setup ep 0 */
1511 xhci_setup_addressable_virt_dev(xhci
, udev
);
1512 /* Otherwise, assume the core has the device configured how it wants */
1513 xhci_dbg(xhci
, "Slot ID %d Input Context:\n", udev
->slot_id
);
1514 xhci_dbg_ctx(xhci
, virt_dev
->in_ctx
, 2);
1516 spin_lock_irqsave(&xhci
->lock
, flags
);
1517 ret
= xhci_queue_address_device(xhci
, virt_dev
->in_ctx
->dma
,
1520 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1521 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
1524 xhci_ring_cmd_db(xhci
);
1525 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1527 /* ctrl tx can take up to 5 sec; XXX: need more time for xHC? */
1528 timeleft
= wait_for_completion_interruptible_timeout(&xhci
->addr_dev
,
1529 USB_CTRL_SET_TIMEOUT
);
1530 /* FIXME: From section 4.3.4: "Software shall be responsible for timing
1531 * the SetAddress() "recovery interval" required by USB and aborting the
1532 * command on a timeout.
1534 if (timeleft
<= 0) {
1535 xhci_warn(xhci
, "%s while waiting for a slot\n",
1536 timeleft
== 0 ? "Timeout" : "Signal");
1537 /* FIXME cancel the address device command */
1541 switch (virt_dev
->cmd_status
) {
1542 case COMP_CTX_STATE
:
1544 xhci_err(xhci
, "Setup ERROR: address device command for slot %d.\n",
1549 dev_warn(&udev
->dev
, "Device not responding to set address.\n");
1553 xhci_dbg(xhci
, "Successful Address Device command\n");
1556 xhci_err(xhci
, "ERROR: unexpected command completion "
1557 "code 0x%x.\n", virt_dev
->cmd_status
);
1558 xhci_dbg(xhci
, "Slot ID %d Output Context:\n", udev
->slot_id
);
1559 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, 2);
1566 temp_64
= xhci_read_64(xhci
, &xhci
->op_regs
->dcbaa_ptr
);
1567 xhci_dbg(xhci
, "Op regs DCBAA ptr = %#016llx\n", temp_64
);
1568 xhci_dbg(xhci
, "Slot ID %d dcbaa entry @%p = %#016llx\n",
1570 &xhci
->dcbaa
->dev_context_ptrs
[udev
->slot_id
],
1571 (unsigned long long)
1572 xhci
->dcbaa
->dev_context_ptrs
[udev
->slot_id
]);
1573 xhci_dbg(xhci
, "Output Context DMA address = %#08llx\n",
1574 (unsigned long long)virt_dev
->out_ctx
->dma
);
1575 xhci_dbg(xhci
, "Slot ID %d Input Context:\n", udev
->slot_id
);
1576 xhci_dbg_ctx(xhci
, virt_dev
->in_ctx
, 2);
1577 xhci_dbg(xhci
, "Slot ID %d Output Context:\n", udev
->slot_id
);
1578 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, 2);
1580 * USB core uses address 1 for the roothubs, so we add one to the
1581 * address given back to us by the HC.
1583 slot_ctx
= xhci_get_slot_ctx(xhci
, virt_dev
->out_ctx
);
1584 udev
->devnum
= (slot_ctx
->dev_state
& DEV_ADDR_MASK
) + 1;
1585 /* Zero the input context control for later use */
1586 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, virt_dev
->in_ctx
);
1587 ctrl_ctx
->add_flags
= 0;
1588 ctrl_ctx
->drop_flags
= 0;
1590 xhci_dbg(xhci
, "Device address = %d\n", udev
->devnum
);
1591 /* XXX Meh, not sure if anyone else but choose_address uses this. */
1592 set_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1597 /* Once a hub descriptor is fetched for a device, we need to update the xHC's
1598 * internal data structures for the device.
1600 int xhci_update_hub_device(struct usb_hcd
*hcd
, struct usb_device
*hdev
,
1601 struct usb_tt
*tt
, gfp_t mem_flags
)
1603 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
1604 struct xhci_virt_device
*vdev
;
1605 struct xhci_command
*config_cmd
;
1606 struct xhci_input_control_ctx
*ctrl_ctx
;
1607 struct xhci_slot_ctx
*slot_ctx
;
1608 unsigned long flags
;
1609 unsigned think_time
;
1612 /* Ignore root hubs */
1616 vdev
= xhci
->devs
[hdev
->slot_id
];
1618 xhci_warn(xhci
, "Cannot update hub desc for unknown device.\n");
1621 config_cmd
= xhci_alloc_command(xhci
, true, mem_flags
);
1623 xhci_dbg(xhci
, "Could not allocate xHCI command structure.\n");
1627 spin_lock_irqsave(&xhci
->lock
, flags
);
1628 xhci_slot_copy(xhci
, config_cmd
->in_ctx
, vdev
->out_ctx
);
1629 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, config_cmd
->in_ctx
);
1630 ctrl_ctx
->add_flags
|= SLOT_FLAG
;
1631 slot_ctx
= xhci_get_slot_ctx(xhci
, config_cmd
->in_ctx
);
1632 slot_ctx
->dev_info
|= DEV_HUB
;
1634 slot_ctx
->dev_info
|= DEV_MTT
;
1635 if (xhci
->hci_version
> 0x95) {
1636 xhci_dbg(xhci
, "xHCI version %x needs hub "
1637 "TT think time and number of ports\n",
1638 (unsigned int) xhci
->hci_version
);
1639 slot_ctx
->dev_info2
|= XHCI_MAX_PORTS(hdev
->maxchild
);
1640 /* Set TT think time - convert from ns to FS bit times.
1641 * 0 = 8 FS bit times, 1 = 16 FS bit times,
1642 * 2 = 24 FS bit times, 3 = 32 FS bit times.
1644 think_time
= tt
->think_time
;
1645 if (think_time
!= 0)
1646 think_time
= (think_time
/ 666) - 1;
1647 slot_ctx
->tt_info
|= TT_THINK_TIME(think_time
);
1649 xhci_dbg(xhci
, "xHCI version %x doesn't need hub "
1650 "TT think time or number of ports\n",
1651 (unsigned int) xhci
->hci_version
);
1653 slot_ctx
->dev_state
= 0;
1654 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1656 xhci_dbg(xhci
, "Set up %s for hub device.\n",
1657 (xhci
->hci_version
> 0x95) ?
1658 "configure endpoint" : "evaluate context");
1659 xhci_dbg(xhci
, "Slot %u Input Context:\n", hdev
->slot_id
);
1660 xhci_dbg_ctx(xhci
, config_cmd
->in_ctx
, 0);
1662 /* Issue and wait for the configure endpoint or
1663 * evaluate context command.
1665 if (xhci
->hci_version
> 0x95)
1666 ret
= xhci_configure_endpoint(xhci
, hdev
, config_cmd
,
1669 ret
= xhci_configure_endpoint(xhci
, hdev
, config_cmd
,
1672 xhci_dbg(xhci
, "Slot %u Output Context:\n", hdev
->slot_id
);
1673 xhci_dbg_ctx(xhci
, vdev
->out_ctx
, 0);
1675 xhci_free_command(xhci
, config_cmd
);
1679 int xhci_get_frame(struct usb_hcd
*hcd
)
1681 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
1682 /* EHCI mods by the periodic size. Why? */
1683 return xhci_readl(xhci
, &xhci
->run_regs
->microframe_index
) >> 3;
1686 MODULE_DESCRIPTION(DRIVER_DESC
);
1687 MODULE_AUTHOR(DRIVER_AUTHOR
);
1688 MODULE_LICENSE("GPL");
1690 static int __init
xhci_hcd_init(void)
1695 retval
= xhci_register_pci();
1698 printk(KERN_DEBUG
"Problem registering PCI driver.");
1703 * Check the compiler generated sizes of structures that must be laid
1704 * out in specific ways for hardware access.
1706 BUILD_BUG_ON(sizeof(struct xhci_doorbell_array
) != 256*32/8);
1707 BUILD_BUG_ON(sizeof(struct xhci_slot_ctx
) != 8*32/8);
1708 BUILD_BUG_ON(sizeof(struct xhci_ep_ctx
) != 8*32/8);
1709 /* xhci_device_control has eight fields, and also
1710 * embeds one xhci_slot_ctx and 31 xhci_ep_ctx
1712 BUILD_BUG_ON(sizeof(struct xhci_stream_ctx
) != 4*32/8);
1713 BUILD_BUG_ON(sizeof(union xhci_trb
) != 4*32/8);
1714 BUILD_BUG_ON(sizeof(struct xhci_erst_entry
) != 4*32/8);
1715 BUILD_BUG_ON(sizeof(struct xhci_cap_regs
) != 7*32/8);
1716 BUILD_BUG_ON(sizeof(struct xhci_intr_reg
) != 8*32/8);
1717 /* xhci_run_regs has eight fields and embeds 128 xhci_intr_regs */
1718 BUILD_BUG_ON(sizeof(struct xhci_run_regs
) != (8+8*128)*32/8);
1719 BUILD_BUG_ON(sizeof(struct xhci_doorbell_array
) != 256*32/8);
1722 module_init(xhci_hcd_init
);
1724 static void __exit
xhci_hcd_cleanup(void)
1727 xhci_unregister_pci();
1730 module_exit(xhci_hcd_cleanup
);