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>
28 #define DRIVER_AUTHOR "Sarah Sharp"
29 #define DRIVER_DESC "'eXtensible' Host Controller (xHC) Driver"
31 /* TODO: copied from ehci-hcd.c - can this be refactored? */
33 * handshake - spin reading hc until handshake completes or fails
34 * @ptr: address of hc register to be read
35 * @mask: bits to look at in result of read
36 * @done: value of those bits when handshake succeeds
37 * @usec: timeout in microseconds
39 * Returns negative errno, or zero on success
41 * Success happens when the "mask" bits have the specified value (hardware
42 * handshake done). There are two failure modes: "usec" have passed (major
43 * hardware flakeout), or the register reads as all-ones (hardware removed).
45 static int handshake(struct xhci_hcd
*xhci
, void __iomem
*ptr
,
46 u32 mask
, u32 done
, int usec
)
51 result
= xhci_readl(xhci
, ptr
);
52 if (result
== ~(u32
)0) /* card removed */
64 * Force HC into halt state.
66 * Disable any IRQs and clear the run/stop bit.
67 * HC will complete any current and actively pipelined transactions, and
68 * should halt within 16 microframes of the run/stop bit being cleared.
69 * Read HC Halted bit in the status register to see when the HC is finished.
70 * XXX: shouldn't we set HC_STATE_HALT here somewhere?
72 int xhci_halt(struct xhci_hcd
*xhci
)
78 xhci_dbg(xhci
, "// Halt the HC\n");
79 /* Disable all interrupts from the host controller */
81 halted
= xhci_readl(xhci
, &xhci
->op_regs
->status
) & STS_HALT
;
85 cmd
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
87 xhci_writel(xhci
, cmd
, &xhci
->op_regs
->command
);
89 return handshake(xhci
, &xhci
->op_regs
->status
,
90 STS_HALT
, STS_HALT
, XHCI_MAX_HALT_USEC
);
94 * Reset a halted HC, and set the internal HC state to HC_STATE_HALT.
96 * This resets pipelines, timers, counters, state machines, etc.
97 * Transactions will be terminated immediately, and operational registers
98 * will be set to their defaults.
100 int xhci_reset(struct xhci_hcd
*xhci
)
105 state
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
106 BUG_ON((state
& STS_HALT
) == 0);
108 xhci_dbg(xhci
, "// Reset the HC\n");
109 command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
110 command
|= CMD_RESET
;
111 xhci_writel(xhci
, command
, &xhci
->op_regs
->command
);
112 /* XXX: Why does EHCI set this here? Shouldn't other code do this? */
113 xhci_to_hcd(xhci
)->state
= HC_STATE_HALT
;
115 return handshake(xhci
, &xhci
->op_regs
->command
, CMD_RESET
, 0, 250 * 1000);
119 * Stop the HC from processing the endpoint queues.
121 static void xhci_quiesce(struct xhci_hcd
*xhci
)
124 * Queues are per endpoint, so we need to disable an endpoint or slot.
126 * To disable a slot, we need to insert a disable slot command on the
127 * command ring and ring the doorbell. This will also free any internal
128 * resources associated with the slot (which might not be what we want).
130 * A Release Endpoint command sounds better - doesn't free internal HC
131 * memory, but removes the endpoints from the schedule and releases the
132 * bandwidth, disables the doorbells, and clears the endpoint enable
133 * flag. Usually used prior to a set interface command.
135 * TODO: Implement after command ring code is done.
137 BUG_ON(!HC_IS_RUNNING(xhci_to_hcd(xhci
)->state
));
138 xhci_dbg(xhci
, "Finished quiescing -- code not written yet\n");
142 /* Set up MSI-X table for entry 0 (may claim other entries later) */
143 static int xhci_setup_msix(struct xhci_hcd
*xhci
)
146 struct pci_dev
*pdev
= to_pci_dev(xhci_to_hcd(xhci
)->self
.controller
);
148 xhci
->msix_count
= 0;
149 /* XXX: did I do this right? ixgbe does kcalloc for more than one */
150 xhci
->msix_entries
= kmalloc(sizeof(struct msix_entry
), GFP_KERNEL
);
151 if (!xhci
->msix_entries
) {
152 xhci_err(xhci
, "Failed to allocate MSI-X entries\n");
155 xhci
->msix_entries
[0].entry
= 0;
157 ret
= pci_enable_msix(pdev
, xhci
->msix_entries
, xhci
->msix_count
);
159 xhci_err(xhci
, "Failed to enable MSI-X\n");
164 * Pass the xhci pointer value as the request_irq "cookie".
165 * If more irqs are added, this will need to be unique for each one.
167 ret
= request_irq(xhci
->msix_entries
[0].vector
, &xhci_irq
, 0,
168 "xHCI", xhci_to_hcd(xhci
));
170 xhci_err(xhci
, "Failed to allocate MSI-X interrupt\n");
173 xhci_dbg(xhci
, "Finished setting up MSI-X\n");
177 pci_disable_msix(pdev
);
179 kfree(xhci
->msix_entries
);
180 xhci
->msix_entries
= NULL
;
184 /* XXX: code duplication; can xhci_setup_msix call this? */
185 /* Free any IRQs and disable MSI-X */
186 static void xhci_cleanup_msix(struct xhci_hcd
*xhci
)
188 struct pci_dev
*pdev
= to_pci_dev(xhci_to_hcd(xhci
)->self
.controller
);
189 if (!xhci
->msix_entries
)
192 free_irq(xhci
->msix_entries
[0].vector
, xhci
);
193 pci_disable_msix(pdev
);
194 kfree(xhci
->msix_entries
);
195 xhci
->msix_entries
= NULL
;
196 xhci_dbg(xhci
, "Finished cleaning up MSI-X\n");
201 * Initialize memory for HCD and xHC (one-time init).
203 * Program the PAGESIZE register, initialize the device context array, create
204 * device contexts (?), set up a command ring segment (or two?), create event
205 * ring (one for now).
207 int xhci_init(struct usb_hcd
*hcd
)
209 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
212 xhci_dbg(xhci
, "xhci_init\n");
213 spin_lock_init(&xhci
->lock
);
214 retval
= xhci_mem_init(xhci
, GFP_KERNEL
);
215 xhci_dbg(xhci
, "Finished xhci_init\n");
221 * Called in interrupt context when there might be work
222 * queued on the event ring
224 * xhci->lock must be held by caller.
226 static void xhci_work(struct xhci_hcd
*xhci
)
231 * Clear the op reg interrupt status first,
232 * so we can receive interrupts from other MSI-X interrupters.
233 * Write 1 to clear the interrupt status.
235 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
237 xhci_writel(xhci
, temp
, &xhci
->op_regs
->status
);
238 /* FIXME when MSI-X is supported and there are multiple vectors */
239 /* Clear the MSI-X event interrupt status */
241 /* Acknowledge the interrupt */
242 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
244 xhci_writel(xhci
, temp
, &xhci
->ir_set
->irq_pending
);
245 /* Flush posted writes */
246 xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
248 /* FIXME this should be a delayed service routine that clears the EHB */
249 xhci_handle_event(xhci
);
251 /* Clear the event handler busy flag; the event ring should be empty. */
252 temp
= xhci_readl(xhci
, &xhci
->ir_set
->erst_dequeue
[0]);
253 xhci_writel(xhci
, temp
& ~ERST_EHB
, &xhci
->ir_set
->erst_dequeue
[0]);
254 /* Flush posted writes -- FIXME is this necessary? */
255 xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
258 /*-------------------------------------------------------------------------*/
261 * xHCI spec says we can get an interrupt, and if the HC has an error condition,
262 * we might get bad data out of the event ring. Section 4.10.2.7 has a list of
263 * indicators of an event TRB error, but we check the status *first* to be safe.
265 irqreturn_t
xhci_irq(struct usb_hcd
*hcd
)
267 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
270 spin_lock(&xhci
->lock
);
271 /* Check if the xHC generated the interrupt, or the irq is shared */
272 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
273 temp2
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
274 if (!(temp
& STS_EINT
) && !ER_IRQ_PENDING(temp2
)) {
275 spin_unlock(&xhci
->lock
);
279 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
280 if (temp
& STS_FATAL
) {
281 xhci_warn(xhci
, "WARNING: Host System Error\n");
283 xhci_to_hcd(xhci
)->state
= HC_STATE_HALT
;
288 spin_unlock(&xhci
->lock
);
293 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
294 void event_ring_work(unsigned long arg
)
298 struct xhci_hcd
*xhci
= (struct xhci_hcd
*) arg
;
301 xhci_dbg(xhci
, "Poll event ring: %lu\n", jiffies
);
303 spin_lock_irqsave(&xhci
->lock
, flags
);
304 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
305 xhci_dbg(xhci
, "op reg status = 0x%x\n", temp
);
306 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
307 xhci_dbg(xhci
, "ir_set 0 pending = 0x%x\n", temp
);
308 xhci_dbg(xhci
, "No-op commands handled = %d\n", xhci
->noops_handled
);
309 xhci_dbg(xhci
, "HC error bitmask = 0x%x\n", xhci
->error_bitmask
);
310 xhci
->error_bitmask
= 0;
311 xhci_dbg(xhci
, "Event ring:\n");
312 xhci_debug_segment(xhci
, xhci
->event_ring
->deq_seg
);
313 xhci_dbg_ring_ptrs(xhci
, xhci
->event_ring
);
314 temp
= xhci_readl(xhci
, &xhci
->ir_set
->erst_dequeue
[0]);
315 temp
&= ERST_PTR_MASK
;
316 xhci_dbg(xhci
, "ERST deq = 0x%x\n", temp
);
317 xhci_dbg(xhci
, "Command ring:\n");
318 xhci_debug_segment(xhci
, xhci
->cmd_ring
->deq_seg
);
319 xhci_dbg_ring_ptrs(xhci
, xhci
->cmd_ring
);
320 xhci_dbg_cmd_ptrs(xhci
);
321 for (i
= 0; i
< MAX_HC_SLOTS
; ++i
) {
323 for (j
= 0; j
< 31; ++j
) {
324 if (xhci
->devs
[i
]->ep_rings
[j
]) {
325 xhci_dbg(xhci
, "Dev %d endpoint ring %d:\n", i
, j
);
326 xhci_debug_segment(xhci
, xhci
->devs
[i
]->ep_rings
[j
]->deq_seg
);
332 if (xhci
->noops_submitted
!= NUM_TEST_NOOPS
)
333 if (setup_one_noop(xhci
))
335 spin_unlock_irqrestore(&xhci
->lock
, flags
);
338 mod_timer(&xhci
->event_ring_timer
, jiffies
+ POLL_TIMEOUT
* HZ
);
340 xhci_dbg(xhci
, "Quit polling the event ring.\n");
345 * Start the HC after it was halted.
347 * This function is called by the USB core when the HC driver is added.
348 * Its opposite is xhci_stop().
350 * xhci_init() must be called once before this function can be called.
351 * Reset the HC, enable device slot contexts, program DCBAAP, and
352 * set command ring pointer and event ring pointer.
354 * Setup MSI-X vectors and enable interrupts.
356 int xhci_run(struct usb_hcd
*hcd
)
359 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
360 void (*doorbell
)(struct xhci_hcd
*) = NULL
;
362 hcd
->uses_new_polling
= 1;
365 xhci_dbg(xhci
, "xhci_run\n");
366 #if 0 /* FIXME: MSI not setup yet */
367 /* Do this at the very last minute */
368 ret
= xhci_setup_msix(xhci
);
374 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
375 init_timer(&xhci
->event_ring_timer
);
376 xhci
->event_ring_timer
.data
= (unsigned long) xhci
;
377 xhci
->event_ring_timer
.function
= event_ring_work
;
378 /* Poll the event ring */
379 xhci
->event_ring_timer
.expires
= jiffies
+ POLL_TIMEOUT
* HZ
;
381 xhci_dbg(xhci
, "Setting event ring polling timer\n");
382 add_timer(&xhci
->event_ring_timer
);
385 xhci_dbg(xhci
, "// Set the interrupt modulation register\n");
386 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_control
);
389 xhci_writel(xhci
, temp
, &xhci
->ir_set
->irq_control
);
391 /* Set the HCD state before we enable the irqs */
392 hcd
->state
= HC_STATE_RUNNING
;
393 temp
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
395 xhci_dbg(xhci
, "// Enable interrupts, cmd = 0x%x.\n",
397 xhci_writel(xhci
, temp
, &xhci
->op_regs
->command
);
399 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
400 xhci_dbg(xhci
, "// Enabling event ring interrupter %p by writing 0x%x to irq_pending\n",
401 xhci
->ir_set
, (unsigned int) ER_IRQ_ENABLE(temp
));
402 xhci_writel(xhci
, ER_IRQ_ENABLE(temp
),
403 &xhci
->ir_set
->irq_pending
);
404 xhci_print_ir_set(xhci
, xhci
->ir_set
, 0);
406 if (NUM_TEST_NOOPS
> 0)
407 doorbell
= setup_one_noop(xhci
);
409 xhci_dbg(xhci
, "Command ring memory map follows:\n");
410 xhci_debug_ring(xhci
, xhci
->cmd_ring
);
411 xhci_dbg_ring_ptrs(xhci
, xhci
->cmd_ring
);
412 xhci_dbg_cmd_ptrs(xhci
);
414 xhci_dbg(xhci
, "ERST memory map follows:\n");
415 xhci_dbg_erst(xhci
, &xhci
->erst
);
416 xhci_dbg(xhci
, "Event ring:\n");
417 xhci_debug_ring(xhci
, xhci
->event_ring
);
418 xhci_dbg_ring_ptrs(xhci
, xhci
->event_ring
);
419 temp
= xhci_readl(xhci
, &xhci
->ir_set
->erst_dequeue
[1]);
420 xhci_dbg(xhci
, "ERST deq upper = 0x%x\n", temp
);
421 temp
= xhci_readl(xhci
, &xhci
->ir_set
->erst_dequeue
[0]);
422 temp
&= ERST_PTR_MASK
;
423 xhci_dbg(xhci
, "ERST deq = 0x%x\n", temp
);
425 temp
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
427 xhci_dbg(xhci
, "// Turn on HC, cmd = 0x%x.\n",
429 xhci_writel(xhci
, temp
, &xhci
->op_regs
->command
);
430 /* Flush PCI posted writes */
431 temp
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
432 xhci_dbg(xhci
, "// @%p = 0x%x\n", &xhci
->op_regs
->command
, temp
);
436 xhci_dbg(xhci
, "Finished xhci_run\n");
443 * This function is called by the USB core when the HC driver is removed.
444 * Its opposite is xhci_run().
446 * Disable device contexts, disable IRQs, and quiesce the HC.
447 * Reset the HC, finish any completed transactions, and cleanup memory.
449 void xhci_stop(struct usb_hcd
*hcd
)
452 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
454 spin_lock_irq(&xhci
->lock
);
455 if (HC_IS_RUNNING(hcd
->state
))
459 spin_unlock_irq(&xhci
->lock
);
461 #if 0 /* No MSI yet */
462 xhci_cleanup_msix(xhci
);
464 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
465 /* Tell the event ring poll function not to reschedule */
467 del_timer_sync(&xhci
->event_ring_timer
);
470 xhci_dbg(xhci
, "// Disabling event ring interrupts\n");
471 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
472 xhci_writel(xhci
, temp
& ~STS_EINT
, &xhci
->op_regs
->status
);
473 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
474 xhci_writel(xhci
, ER_IRQ_DISABLE(temp
),
475 &xhci
->ir_set
->irq_pending
);
476 xhci_print_ir_set(xhci
, xhci
->ir_set
, 0);
478 xhci_dbg(xhci
, "cleaning up memory\n");
479 xhci_mem_cleanup(xhci
);
480 xhci_dbg(xhci
, "xhci_stop completed - status = %x\n",
481 xhci_readl(xhci
, &xhci
->op_regs
->status
));
485 * Shutdown HC (not bus-specific)
487 * This is called when the machine is rebooting or halting. We assume that the
488 * machine will be powered off, and the HC's internal state will be reset.
489 * Don't bother to free memory.
491 void xhci_shutdown(struct usb_hcd
*hcd
)
493 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
495 spin_lock_irq(&xhci
->lock
);
497 spin_unlock_irq(&xhci
->lock
);
500 xhci_cleanup_msix(xhci
);
503 xhci_dbg(xhci
, "xhci_shutdown completed - status = %x\n",
504 xhci_readl(xhci
, &xhci
->op_regs
->status
));
507 /*-------------------------------------------------------------------------*/
510 * xhci_get_endpoint_index - Used for passing endpoint bitmasks between the core and
511 * HCDs. Find the index for an endpoint given its descriptor. Use the return
512 * value to right shift 1 for the bitmask.
514 * Index = (epnum * 2) + direction - 1,
515 * where direction = 0 for OUT, 1 for IN.
516 * For control endpoints, the IN index is used (OUT index is unused), so
517 * index = (epnum * 2) + direction - 1 = (epnum * 2) + 1 - 1 = (epnum * 2)
519 unsigned int xhci_get_endpoint_index(struct usb_endpoint_descriptor
*desc
)
522 if (usb_endpoint_xfer_control(desc
))
523 index
= (unsigned int) (usb_endpoint_num(desc
)*2);
525 index
= (unsigned int) (usb_endpoint_num(desc
)*2) +
526 (usb_endpoint_dir_in(desc
) ? 1 : 0) - 1;
530 /* Find the flag for this endpoint (for use in the control context). Use the
531 * endpoint index to create a bitmask. The slot context is bit 0, endpoint 0 is
534 unsigned int xhci_get_endpoint_flag(struct usb_endpoint_descriptor
*desc
)
536 return 1 << (xhci_get_endpoint_index(desc
) + 1);
539 /* Compute the last valid endpoint context index. Basically, this is the
540 * endpoint index plus one. For slot contexts with more than valid endpoint,
541 * we find the most significant bit set in the added contexts flags.
542 * e.g. ep 1 IN (with epnum 0x81) => added_ctxs = 0b1000
543 * fls(0b1000) = 4, but the endpoint context index is 3, so subtract one.
545 static inline unsigned int xhci_last_valid_endpoint(u32 added_ctxs
)
547 return fls(added_ctxs
) - 1;
550 /* Returns 1 if the arguments are OK;
551 * returns 0 this is a root hub; returns -EINVAL for NULL pointers.
553 int xhci_check_args(struct usb_hcd
*hcd
, struct usb_device
*udev
,
554 struct usb_host_endpoint
*ep
, int check_ep
, const char *func
) {
555 if (!hcd
|| (check_ep
&& !ep
) || !udev
) {
556 printk(KERN_DEBUG
"xHCI %s called with invalid args\n",
561 printk(KERN_DEBUG
"xHCI %s called for root hub\n",
565 if (!udev
->slot_id
) {
566 printk(KERN_DEBUG
"xHCI %s called with unaddressed device\n",
574 * non-error returns are a promise to giveback() the urb later
575 * we drop ownership so next owner (or urb unlink) can get it
577 int xhci_urb_enqueue(struct usb_hcd
*hcd
, struct urb
*urb
, gfp_t mem_flags
)
579 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
582 unsigned int slot_id
, ep_index
;
584 if (!urb
|| xhci_check_args(hcd
, urb
->dev
, urb
->ep
, true, __func__
) <= 0)
587 slot_id
= urb
->dev
->slot_id
;
588 ep_index
= xhci_get_endpoint_index(&urb
->ep
->desc
);
590 spin_lock_irqsave(&xhci
->lock
, flags
);
591 if (!xhci
->devs
|| !xhci
->devs
[slot_id
]) {
593 dev_warn(&urb
->dev
->dev
, "WARN: urb submitted for dev with no Slot ID\n");
596 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
)) {
598 xhci_dbg(xhci
, "urb submitted during PCI suspend\n");
602 if (usb_endpoint_xfer_control(&urb
->ep
->desc
))
603 ret
= queue_ctrl_tx(xhci
, mem_flags
, urb
, slot_id
, ep_index
);
604 else if (usb_endpoint_xfer_bulk(&urb
->ep
->desc
))
605 ret
= queue_bulk_tx(xhci
, mem_flags
, urb
, slot_id
, ep_index
);
609 spin_unlock_irqrestore(&xhci
->lock
, flags
);
614 * Remove the URB's TD from the endpoint ring. This may cause the HC to stop
615 * USB transfers, potentially stopping in the middle of a TRB buffer. The HC
616 * should pick up where it left off in the TD, unless a Set Transfer Ring
617 * Dequeue Pointer is issued.
619 * The TRBs that make up the buffers for the canceled URB will be "removed" from
620 * the ring. Since the ring is a contiguous structure, they can't be physically
621 * removed. Instead, there are two options:
623 * 1) If the HC is in the middle of processing the URB to be canceled, we
624 * simply move the ring's dequeue pointer past those TRBs using the Set
625 * Transfer Ring Dequeue Pointer command. This will be the common case,
626 * when drivers timeout on the last submitted URB and attempt to cancel.
628 * 2) If the HC is in the middle of a different TD, we turn the TRBs into a
629 * series of 1-TRB transfer no-op TDs. (No-ops shouldn't be chained.) The
630 * HC will need to invalidate the any TRBs it has cached after the stop
631 * endpoint command, as noted in the xHCI 0.95 errata.
633 * 3) The TD may have completed by the time the Stop Endpoint Command
634 * completes, so software needs to handle that case too.
636 * This function should protect against the TD enqueueing code ringing the
637 * doorbell while this code is waiting for a Stop Endpoint command to complete.
638 * It also needs to account for multiple cancellations on happening at the same
639 * time for the same endpoint.
641 * Note that this function can be called in any context, or so says
642 * usb_hcd_unlink_urb()
644 int xhci_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
648 struct xhci_hcd
*xhci
;
650 unsigned int ep_index
;
651 struct xhci_ring
*ep_ring
;
653 xhci
= hcd_to_xhci(hcd
);
654 spin_lock_irqsave(&xhci
->lock
, flags
);
655 /* Make sure the URB hasn't completed or been unlinked already */
656 ret
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
657 if (ret
|| !urb
->hcpriv
)
660 xhci_dbg(xhci
, "Cancel URB %p\n", urb
);
661 ep_index
= xhci_get_endpoint_index(&urb
->ep
->desc
);
662 ep_ring
= xhci
->devs
[urb
->dev
->slot_id
]->ep_rings
[ep_index
];
663 td
= (struct xhci_td
*) urb
->hcpriv
;
665 ep_ring
->cancels_pending
++;
666 list_add_tail(&td
->cancelled_td_list
, &ep_ring
->cancelled_td_list
);
667 /* Queue a stop endpoint command, but only if this is
668 * the first cancellation to be handled.
670 if (ep_ring
->cancels_pending
== 1) {
671 queue_stop_endpoint(xhci
, urb
->dev
->slot_id
, ep_index
);
675 spin_unlock_irqrestore(&xhci
->lock
, flags
);
679 /* Drop an endpoint from a new bandwidth configuration for this device.
680 * Only one call to this function is allowed per endpoint before
681 * check_bandwidth() or reset_bandwidth() must be called.
682 * A call to xhci_drop_endpoint() followed by a call to xhci_add_endpoint() will
683 * add the endpoint to the schedule with possibly new parameters denoted by a
684 * different endpoint descriptor in usb_host_endpoint.
685 * A call to xhci_add_endpoint() followed by a call to xhci_drop_endpoint() is
688 int xhci_drop_endpoint(struct usb_hcd
*hcd
, struct usb_device
*udev
,
689 struct usb_host_endpoint
*ep
)
692 struct xhci_hcd
*xhci
;
693 struct xhci_device_control
*in_ctx
;
694 unsigned int last_ctx
;
695 unsigned int ep_index
;
696 struct xhci_ep_ctx
*ep_ctx
;
698 u32 new_add_flags
, new_drop_flags
, new_slot_info
;
701 ret
= xhci_check_args(hcd
, udev
, ep
, 1, __func__
);
704 xhci
= hcd_to_xhci(hcd
);
705 xhci_dbg(xhci
, "%s called for udev %p\n", __func__
, udev
);
707 drop_flag
= xhci_get_endpoint_flag(&ep
->desc
);
708 if (drop_flag
== SLOT_FLAG
|| drop_flag
== EP0_FLAG
) {
709 xhci_dbg(xhci
, "xHCI %s - can't drop slot or ep 0 %#x\n",
710 __func__
, drop_flag
);
714 spin_lock_irqsave(&xhci
->lock
, flags
);
715 if (!xhci
->devs
|| !xhci
->devs
[udev
->slot_id
]) {
716 xhci_warn(xhci
, "xHCI %s called with unaddressed device\n",
718 spin_unlock_irqrestore(&xhci
->lock
, flags
);
722 in_ctx
= xhci
->devs
[udev
->slot_id
]->in_ctx
;
723 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
724 ep_ctx
= &xhci
->devs
[udev
->slot_id
]->out_ctx
->ep
[ep_index
];
725 /* If the HC already knows the endpoint is disabled,
726 * or the HCD has noted it is disabled, ignore this request
728 if ((ep_ctx
->ep_info
& EP_STATE_MASK
) == EP_STATE_DISABLED
||
729 in_ctx
->drop_flags
& xhci_get_endpoint_flag(&ep
->desc
)) {
730 xhci_warn(xhci
, "xHCI %s called with disabled ep %p\n",
732 spin_unlock_irqrestore(&xhci
->lock
, flags
);
736 in_ctx
->drop_flags
|= drop_flag
;
737 new_drop_flags
= in_ctx
->drop_flags
;
739 in_ctx
->add_flags
= ~drop_flag
;
740 new_add_flags
= in_ctx
->add_flags
;
742 last_ctx
= xhci_last_valid_endpoint(in_ctx
->add_flags
);
743 /* Update the last valid endpoint context, if we deleted the last one */
744 if ((in_ctx
->slot
.dev_info
& LAST_CTX_MASK
) > LAST_CTX(last_ctx
)) {
745 in_ctx
->slot
.dev_info
&= ~LAST_CTX_MASK
;
746 in_ctx
->slot
.dev_info
|= LAST_CTX(last_ctx
);
748 new_slot_info
= in_ctx
->slot
.dev_info
;
750 xhci_endpoint_zero(xhci
, xhci
->devs
[udev
->slot_id
], ep
);
752 spin_unlock_irqrestore(&xhci
->lock
, flags
);
754 xhci_dbg(xhci
, "drop ep 0x%x, slot id %d, new drop flags = %#x, new add flags = %#x, new slot info = %#x\n",
755 (unsigned int) ep
->desc
.bEndpointAddress
,
757 (unsigned int) new_drop_flags
,
758 (unsigned int) new_add_flags
,
759 (unsigned int) new_slot_info
);
763 /* Add an endpoint to a new possible bandwidth configuration for this device.
764 * Only one call to this function is allowed per endpoint before
765 * check_bandwidth() or reset_bandwidth() must be called.
766 * A call to xhci_drop_endpoint() followed by a call to xhci_add_endpoint() will
767 * add the endpoint to the schedule with possibly new parameters denoted by a
768 * different endpoint descriptor in usb_host_endpoint.
769 * A call to xhci_add_endpoint() followed by a call to xhci_drop_endpoint() is
772 int xhci_add_endpoint(struct usb_hcd
*hcd
, struct usb_device
*udev
,
773 struct usb_host_endpoint
*ep
)
776 struct xhci_hcd
*xhci
;
777 struct xhci_device_control
*in_ctx
;
778 unsigned int ep_index
;
779 struct xhci_ep_ctx
*ep_ctx
;
781 unsigned int last_ctx
;
782 u32 new_add_flags
, new_drop_flags
, new_slot_info
;
785 ret
= xhci_check_args(hcd
, udev
, ep
, 1, __func__
);
788 xhci
= hcd_to_xhci(hcd
);
790 added_ctxs
= xhci_get_endpoint_flag(&ep
->desc
);
791 last_ctx
= xhci_last_valid_endpoint(added_ctxs
);
792 if (added_ctxs
== SLOT_FLAG
|| added_ctxs
== EP0_FLAG
) {
793 /* FIXME when we have to issue an evaluate endpoint command to
794 * deal with ep0 max packet size changing once we get the
797 xhci_dbg(xhci
, "xHCI %s - can't add slot or ep 0 %#x\n",
798 __func__
, added_ctxs
);
802 spin_lock_irqsave(&xhci
->lock
, flags
);
803 if (!xhci
->devs
|| !xhci
->devs
[udev
->slot_id
]) {
804 xhci_warn(xhci
, "xHCI %s called with unaddressed device\n",
806 spin_unlock_irqrestore(&xhci
->lock
, flags
);
810 in_ctx
= xhci
->devs
[udev
->slot_id
]->in_ctx
;
811 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
812 ep_ctx
= &xhci
->devs
[udev
->slot_id
]->out_ctx
->ep
[ep_index
];
813 /* If the HCD has already noted the endpoint is enabled,
814 * ignore this request.
816 if (in_ctx
->add_flags
& xhci_get_endpoint_flag(&ep
->desc
)) {
817 xhci_warn(xhci
, "xHCI %s called with enabled ep %p\n",
819 spin_unlock_irqrestore(&xhci
->lock
, flags
);
823 if (xhci_endpoint_init(xhci
, xhci
->devs
[udev
->slot_id
], udev
, ep
) < 0) {
824 dev_dbg(&udev
->dev
, "%s - could not initialize ep %#x\n",
825 __func__
, ep
->desc
.bEndpointAddress
);
826 spin_unlock_irqrestore(&xhci
->lock
, flags
);
830 in_ctx
->add_flags
|= added_ctxs
;
831 new_add_flags
= in_ctx
->add_flags
;
833 /* If xhci_endpoint_disable() was called for this endpoint, but the
834 * xHC hasn't been notified yet through the check_bandwidth() call,
835 * this re-adds a new state for the endpoint from the new endpoint
836 * descriptors. We must drop and re-add this endpoint, so we leave the
839 new_drop_flags
= in_ctx
->drop_flags
;
841 /* Update the last valid endpoint context, if we just added one past */
842 if ((in_ctx
->slot
.dev_info
& LAST_CTX_MASK
) < LAST_CTX(last_ctx
)) {
843 in_ctx
->slot
.dev_info
&= ~LAST_CTX_MASK
;
844 in_ctx
->slot
.dev_info
|= LAST_CTX(last_ctx
);
846 new_slot_info
= in_ctx
->slot
.dev_info
;
847 spin_unlock_irqrestore(&xhci
->lock
, flags
);
849 xhci_dbg(xhci
, "add ep 0x%x, slot id %d, new drop flags = %#x, new add flags = %#x, new slot info = %#x\n",
850 (unsigned int) ep
->desc
.bEndpointAddress
,
852 (unsigned int) new_drop_flags
,
853 (unsigned int) new_add_flags
,
854 (unsigned int) new_slot_info
);
858 static void xhci_zero_in_ctx(struct xhci_virt_device
*virt_dev
)
860 struct xhci_ep_ctx
*ep_ctx
;
863 /* When a device's add flag and drop flag are zero, any subsequent
864 * configure endpoint command will leave that endpoint's state
865 * untouched. Make sure we don't leave any old state in the input
868 virt_dev
->in_ctx
->drop_flags
= 0;
869 virt_dev
->in_ctx
->add_flags
= 0;
870 virt_dev
->in_ctx
->slot
.dev_info
&= ~LAST_CTX_MASK
;
871 /* Endpoint 0 is always valid */
872 virt_dev
->in_ctx
->slot
.dev_info
|= LAST_CTX(1);
873 for (i
= 1; i
< 31; ++i
) {
874 ep_ctx
= &virt_dev
->in_ctx
->ep
[i
];
876 ep_ctx
->ep_info2
= 0;
883 int xhci_check_bandwidth(struct usb_hcd
*hcd
, struct usb_device
*udev
)
889 struct xhci_hcd
*xhci
;
890 struct xhci_virt_device
*virt_dev
;
892 ret
= xhci_check_args(hcd
, udev
, NULL
, 0, __func__
);
895 xhci
= hcd_to_xhci(hcd
);
897 spin_lock_irqsave(&xhci
->lock
, flags
);
898 if (!udev
->slot_id
|| !xhci
->devs
|| !xhci
->devs
[udev
->slot_id
]) {
899 xhci_warn(xhci
, "xHCI %s called with unaddressed device\n",
901 spin_unlock_irqrestore(&xhci
->lock
, flags
);
904 xhci_dbg(xhci
, "%s called for udev %p\n", __func__
, udev
);
905 virt_dev
= xhci
->devs
[udev
->slot_id
];
907 /* See section 4.6.6 - A0 = 1; A1 = D0 = D1 = 0 */
908 virt_dev
->in_ctx
->add_flags
|= SLOT_FLAG
;
909 virt_dev
->in_ctx
->add_flags
&= ~EP0_FLAG
;
910 virt_dev
->in_ctx
->drop_flags
&= ~SLOT_FLAG
;
911 virt_dev
->in_ctx
->drop_flags
&= ~EP0_FLAG
;
912 xhci_dbg(xhci
, "New Input Control Context:\n");
913 xhci_dbg_ctx(xhci
, virt_dev
->in_ctx
, virt_dev
->in_ctx_dma
,
914 LAST_CTX_TO_EP_NUM(virt_dev
->in_ctx
->slot
.dev_info
));
916 ret
= queue_configure_endpoint(xhci
, virt_dev
->in_ctx_dma
, udev
->slot_id
);
918 xhci_dbg(xhci
, "FIXME allocate a new ring segment\n");
919 spin_unlock_irqrestore(&xhci
->lock
, flags
);
923 spin_unlock_irqrestore(&xhci
->lock
, flags
);
925 /* Wait for the configure endpoint command to complete */
926 timeleft
= wait_for_completion_interruptible_timeout(
927 &virt_dev
->cmd_completion
,
928 USB_CTRL_SET_TIMEOUT
);
930 xhci_warn(xhci
, "%s while waiting for configure endpoint command\n",
931 timeleft
== 0 ? "Timeout" : "Signal");
932 /* FIXME cancel the configure endpoint command */
936 spin_lock_irqsave(&xhci
->lock
, flags
);
937 switch (virt_dev
->cmd_status
) {
939 dev_warn(&udev
->dev
, "Not enough host controller resources "
940 "for new device state.\n");
942 /* FIXME: can we allocate more resources for the HC? */
945 dev_warn(&udev
->dev
, "Not enough bandwidth "
946 "for new device state.\n");
948 /* FIXME: can we go back to the old state? */
951 /* the HCD set up something wrong */
952 dev_warn(&udev
->dev
, "ERROR: Endpoint drop flag = 0, add flag = 1, "
953 "and endpoint is not disabled.\n");
957 dev_dbg(&udev
->dev
, "Successful Endpoint Configure command\n");
960 xhci_err(xhci
, "ERROR: unexpected command completion "
961 "code 0x%x.\n", virt_dev
->cmd_status
);
966 /* Callee should call reset_bandwidth() */
967 spin_unlock_irqrestore(&xhci
->lock
, flags
);
971 xhci_dbg(xhci
, "Output context after successful config ep cmd:\n");
972 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, virt_dev
->out_ctx_dma
,
973 LAST_CTX_TO_EP_NUM(virt_dev
->in_ctx
->slot
.dev_info
));
975 xhci_zero_in_ctx(virt_dev
);
976 /* Free any old rings */
977 for (i
= 1; i
< 31; ++i
) {
978 if (virt_dev
->new_ep_rings
[i
]) {
979 xhci_ring_free(xhci
, virt_dev
->ep_rings
[i
]);
980 virt_dev
->ep_rings
[i
] = virt_dev
->new_ep_rings
[i
];
981 virt_dev
->new_ep_rings
[i
] = NULL
;
985 spin_unlock_irqrestore(&xhci
->lock
, flags
);
990 void xhci_reset_bandwidth(struct usb_hcd
*hcd
, struct usb_device
*udev
)
993 struct xhci_hcd
*xhci
;
994 struct xhci_virt_device
*virt_dev
;
997 ret
= xhci_check_args(hcd
, udev
, NULL
, 0, __func__
);
1000 xhci
= hcd_to_xhci(hcd
);
1002 spin_lock_irqsave(&xhci
->lock
, flags
);
1003 if (!xhci
->devs
|| !xhci
->devs
[udev
->slot_id
]) {
1004 xhci_warn(xhci
, "xHCI %s called with unaddressed device\n",
1006 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1009 xhci_dbg(xhci
, "%s called for udev %p\n", __func__
, udev
);
1010 virt_dev
= xhci
->devs
[udev
->slot_id
];
1011 /* Free any rings allocated for added endpoints */
1012 for (i
= 0; i
< 31; ++i
) {
1013 if (virt_dev
->new_ep_rings
[i
]) {
1014 xhci_ring_free(xhci
, virt_dev
->new_ep_rings
[i
]);
1015 virt_dev
->new_ep_rings
[i
] = NULL
;
1018 xhci_zero_in_ctx(virt_dev
);
1019 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1023 * At this point, the struct usb_device is about to go away, the device has
1024 * disconnected, and all traffic has been stopped and the endpoints have been
1025 * disabled. Free any HC data structures associated with that device.
1027 void xhci_free_dev(struct usb_hcd
*hcd
, struct usb_device
*udev
)
1029 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
1030 unsigned long flags
;
1032 if (udev
->slot_id
== 0)
1035 spin_lock_irqsave(&xhci
->lock
, flags
);
1036 if (queue_slot_control(xhci
, TRB_DISABLE_SLOT
, udev
->slot_id
)) {
1037 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1038 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
1042 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1044 * Event command completion handler will free any data structures
1045 * associated with the slot
1050 * Returns 0 if the xHC ran out of device slots, the Enable Slot command
1051 * timed out, or allocating memory failed. Returns 1 on success.
1053 int xhci_alloc_dev(struct usb_hcd
*hcd
, struct usb_device
*udev
)
1055 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
1056 unsigned long flags
;
1060 spin_lock_irqsave(&xhci
->lock
, flags
);
1061 ret
= queue_slot_control(xhci
, TRB_ENABLE_SLOT
, 0);
1063 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1064 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
1068 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1070 /* XXX: how much time for xHC slot assignment? */
1071 timeleft
= wait_for_completion_interruptible_timeout(&xhci
->addr_dev
,
1072 USB_CTRL_SET_TIMEOUT
);
1073 if (timeleft
<= 0) {
1074 xhci_warn(xhci
, "%s while waiting for a slot\n",
1075 timeleft
== 0 ? "Timeout" : "Signal");
1076 /* FIXME cancel the enable slot request */
1080 spin_lock_irqsave(&xhci
->lock
, flags
);
1081 if (!xhci
->slot_id
) {
1082 xhci_err(xhci
, "Error while assigning device slot ID\n");
1083 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1086 if (!xhci_alloc_virt_device(xhci
, xhci
->slot_id
, udev
, GFP_KERNEL
)) {
1087 /* Disable slot, if we can do it without mem alloc */
1088 xhci_warn(xhci
, "Could not allocate xHCI USB device data structures\n");
1089 if (!queue_slot_control(xhci
, TRB_DISABLE_SLOT
, udev
->slot_id
))
1091 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1094 udev
->slot_id
= xhci
->slot_id
;
1095 /* Is this a LS or FS device under a HS hub? */
1096 /* Hub or peripherial? */
1097 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1102 * Issue an Address Device command (which will issue a SetAddress request to
1104 * We should be protected by the usb_address0_mutex in khubd's hub_port_init, so
1105 * we should only issue and wait on one address command at the same time.
1107 * We add one to the device address issued by the hardware because the USB core
1108 * uses address 1 for the root hubs (even though they're not really devices).
1110 int xhci_address_device(struct usb_hcd
*hcd
, struct usb_device
*udev
)
1112 unsigned long flags
;
1114 struct xhci_virt_device
*virt_dev
;
1116 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
1119 if (!udev
->slot_id
) {
1120 xhci_dbg(xhci
, "Bad Slot ID %d\n", udev
->slot_id
);
1124 spin_lock_irqsave(&xhci
->lock
, flags
);
1125 virt_dev
= xhci
->devs
[udev
->slot_id
];
1127 /* If this is a Set Address to an unconfigured device, setup ep 0 */
1129 xhci_setup_addressable_virt_dev(xhci
, udev
);
1130 /* Otherwise, assume the core has the device configured how it wants */
1132 ret
= queue_address_device(xhci
, virt_dev
->in_ctx_dma
, udev
->slot_id
);
1134 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1135 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
1139 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1141 /* ctrl tx can take up to 5 sec; XXX: need more time for xHC? */
1142 timeleft
= wait_for_completion_interruptible_timeout(&xhci
->addr_dev
,
1143 USB_CTRL_SET_TIMEOUT
);
1144 /* FIXME: From section 4.3.4: "Software shall be responsible for timing
1145 * the SetAddress() "recovery interval" required by USB and aborting the
1146 * command on a timeout.
1148 if (timeleft
<= 0) {
1149 xhci_warn(xhci
, "%s while waiting for a slot\n",
1150 timeleft
== 0 ? "Timeout" : "Signal");
1151 /* FIXME cancel the address device command */
1155 spin_lock_irqsave(&xhci
->lock
, flags
);
1156 switch (virt_dev
->cmd_status
) {
1157 case COMP_CTX_STATE
:
1159 xhci_err(xhci
, "Setup ERROR: address device command for slot %d.\n",
1164 dev_warn(&udev
->dev
, "Device not responding to set address.\n");
1168 xhci_dbg(xhci
, "Successful Address Device command\n");
1171 xhci_err(xhci
, "ERROR: unexpected command completion "
1172 "code 0x%x.\n", virt_dev
->cmd_status
);
1177 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1180 temp
= xhci_readl(xhci
, &xhci
->op_regs
->dcbaa_ptr
[0]);
1181 xhci_dbg(xhci
, "Op regs DCBAA ptr[0] = %#08x\n", temp
);
1182 temp
= xhci_readl(xhci
, &xhci
->op_regs
->dcbaa_ptr
[1]);
1183 xhci_dbg(xhci
, "Op regs DCBAA ptr[1] = %#08x\n", temp
);
1184 xhci_dbg(xhci
, "Slot ID %d dcbaa entry[0] @%p = %#08x\n",
1186 &xhci
->dcbaa
->dev_context_ptrs
[2*udev
->slot_id
],
1187 xhci
->dcbaa
->dev_context_ptrs
[2*udev
->slot_id
]);
1188 xhci_dbg(xhci
, "Slot ID %d dcbaa entry[1] @%p = %#08x\n",
1190 &xhci
->dcbaa
->dev_context_ptrs
[2*udev
->slot_id
+1],
1191 xhci
->dcbaa
->dev_context_ptrs
[2*udev
->slot_id
+1]);
1192 xhci_dbg(xhci
, "Output Context DMA address = %#08llx\n",
1193 (unsigned long long)virt_dev
->out_ctx_dma
);
1194 xhci_dbg(xhci
, "Slot ID %d Input Context:\n", udev
->slot_id
);
1195 xhci_dbg_ctx(xhci
, virt_dev
->in_ctx
, virt_dev
->in_ctx_dma
, 2);
1196 xhci_dbg(xhci
, "Slot ID %d Output Context:\n", udev
->slot_id
);
1197 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, virt_dev
->out_ctx_dma
, 2);
1199 * USB core uses address 1 for the roothubs, so we add one to the
1200 * address given back to us by the HC.
1202 udev
->devnum
= (virt_dev
->out_ctx
->slot
.dev_state
& DEV_ADDR_MASK
) + 1;
1203 /* Zero the input context control for later use */
1204 virt_dev
->in_ctx
->add_flags
= 0;
1205 virt_dev
->in_ctx
->drop_flags
= 0;
1206 /* Mirror flags in the output context for future ep enable/disable */
1207 virt_dev
->out_ctx
->add_flags
= SLOT_FLAG
| EP0_FLAG
;
1208 virt_dev
->out_ctx
->drop_flags
= 0;
1209 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1211 xhci_dbg(xhci
, "Device address = %d\n", udev
->devnum
);
1212 /* XXX Meh, not sure if anyone else but choose_address uses this. */
1213 set_bit(udev
->devnum
, udev
->bus
->devmap
.devicemap
);
1218 int xhci_get_frame(struct usb_hcd
*hcd
)
1220 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
1221 /* EHCI mods by the periodic size. Why? */
1222 return xhci_readl(xhci
, &xhci
->run_regs
->microframe_index
) >> 3;
1225 MODULE_DESCRIPTION(DRIVER_DESC
);
1226 MODULE_AUTHOR(DRIVER_AUTHOR
);
1227 MODULE_LICENSE("GPL");
1229 static int __init
xhci_hcd_init(void)
1234 retval
= xhci_register_pci();
1237 printk(KERN_DEBUG
"Problem registering PCI driver.");
1243 module_init(xhci_hcd_init
);
1245 static void __exit
xhci_hcd_cleanup(void)
1248 xhci_unregister_pci();
1251 module_exit(xhci_hcd_cleanup
);