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.
24 * Ring initialization rules:
25 * 1. Each segment is initialized to zero, except for link TRBs.
26 * 2. Ring cycle state = 0. This represents Producer Cycle State (PCS) or
27 * Consumer Cycle State (CCS), depending on ring function.
28 * 3. Enqueue pointer = dequeue pointer = address of first TRB in the segment.
30 * Ring behavior rules:
31 * 1. A ring is empty if enqueue == dequeue. This means there will always be at
32 * least one free TRB in the ring. This is useful if you want to turn that
33 * into a link TRB and expand the ring.
34 * 2. When incrementing an enqueue or dequeue pointer, if the next TRB is a
35 * link TRB, then load the pointer with the address in the link TRB. If the
36 * link TRB had its toggle bit set, you may need to update the ring cycle
37 * state (see cycle bit rules). You may have to do this multiple times
38 * until you reach a non-link TRB.
39 * 3. A ring is full if enqueue++ (for the definition of increment above)
40 * equals the dequeue pointer.
43 * 1. When a consumer increments a dequeue pointer and encounters a toggle bit
44 * in a link TRB, it must toggle the ring cycle state.
45 * 2. When a producer increments an enqueue pointer and encounters a toggle bit
46 * in a link TRB, it must toggle the ring cycle state.
49 * 1. Check if ring is full before you enqueue.
50 * 2. Write the ring cycle state to the cycle bit in the TRB you're enqueuing.
51 * Update enqueue pointer between each write (which may update the ring
53 * 3. Notify consumer. If SW is producer, it rings the doorbell for command
54 * and endpoint rings. If HC is the producer for the event ring,
55 * and it generates an interrupt according to interrupt modulation rules.
58 * 1. Check if TRB belongs to you. If the cycle bit == your ring cycle state,
59 * the TRB is owned by the consumer.
60 * 2. Update dequeue pointer (which may update the ring cycle state) and
61 * continue processing TRBs until you reach a TRB which is not owned by you.
62 * 3. Notify the producer. SW is the consumer for the event ring, and it
63 * updates event ring dequeue pointer. HC is the consumer for the command and
64 * endpoint rings; it generates events on the event ring for these.
67 #include <linux/scatterlist.h>
68 #include <linux/slab.h>
71 static int handle_cmd_in_cmd_wait_list(struct xhci_hcd *xhci,
72 struct xhci_virt_device *virt_dev,
73 struct xhci_event_cmd *event);
76 * Returns zero if the TRB isn't in this segment, otherwise it returns the DMA
79 dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg,
82 unsigned long segment_offset;
84 if (!seg || !trb || trb < seg->trbs)
87 segment_offset = trb - seg->trbs;
88 if (segment_offset > TRBS_PER_SEGMENT)
90 return seg->dma + (segment_offset * sizeof(*trb));
93 /* Does this link TRB point to the first segment in a ring,
94 * or was the previous TRB the last TRB on the last segment in the ERST?
96 static bool last_trb_on_last_seg(struct xhci_hcd *xhci, struct xhci_ring *ring,
97 struct xhci_segment *seg, union xhci_trb *trb)
99 if (ring == xhci->event_ring)
100 return (trb == &seg->trbs[TRBS_PER_SEGMENT]) &&
101 (seg->next == xhci->event_ring->first_seg);
103 return le32_to_cpu(trb->link.control) & LINK_TOGGLE;
106 /* Is this TRB a link TRB or was the last TRB the last TRB in this event ring
107 * segment? I.e. would the updated event TRB pointer step off the end of the
110 static int last_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
111 struct xhci_segment *seg, union xhci_trb *trb)
113 if (ring == xhci->event_ring)
114 return trb == &seg->trbs[TRBS_PER_SEGMENT];
116 return TRB_TYPE_LINK_LE32(trb->link.control);
119 static int enqueue_is_link_trb(struct xhci_ring *ring)
121 struct xhci_link_trb *link = &ring->enqueue->link;
122 return TRB_TYPE_LINK_LE32(link->control);
125 /* Updates trb to point to the next TRB in the ring, and updates seg if the next
126 * TRB is in a new segment. This does not skip over link TRBs, and it does not
127 * effect the ring dequeue or enqueue pointers.
129 static void next_trb(struct xhci_hcd *xhci,
130 struct xhci_ring *ring,
131 struct xhci_segment **seg,
132 union xhci_trb **trb)
134 if (last_trb(xhci, ring, *seg, *trb)) {
136 *trb = ((*seg)->trbs);
143 * See Cycle bit rules. SW is the consumer for the event ring only.
144 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
146 static void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring)
148 unsigned long long addr;
153 * If this is not event ring, and the dequeue pointer
154 * is not on a link TRB, there is one more usable TRB
156 if (ring->type != TYPE_EVENT &&
157 !last_trb(xhci, ring, ring->deq_seg, ring->dequeue))
158 ring->num_trbs_free++;
162 * Update the dequeue pointer further if that was a link TRB or
163 * we're at the end of an event ring segment (which doesn't have
166 if (last_trb(xhci, ring, ring->deq_seg, ring->dequeue)) {
167 if (ring->type == TYPE_EVENT &&
168 last_trb_on_last_seg(xhci, ring,
169 ring->deq_seg, ring->dequeue)) {
170 ring->cycle_state = (ring->cycle_state ? 0 : 1);
172 ring->deq_seg = ring->deq_seg->next;
173 ring->dequeue = ring->deq_seg->trbs;
177 } while (last_trb(xhci, ring, ring->deq_seg, ring->dequeue));
179 addr = (unsigned long long) xhci_trb_virt_to_dma(ring->deq_seg, ring->dequeue);
183 * See Cycle bit rules. SW is the consumer for the event ring only.
184 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
186 * If we've just enqueued a TRB that is in the middle of a TD (meaning the
187 * chain bit is set), then set the chain bit in all the following link TRBs.
188 * If we've enqueued the last TRB in a TD, make sure the following link TRBs
189 * have their chain bit cleared (so that each Link TRB is a separate TD).
191 * Section 6.4.4.1 of the 0.95 spec says link TRBs cannot have the chain bit
192 * set, but other sections talk about dealing with the chain bit set. This was
193 * fixed in the 0.96 specification errata, but we have to assume that all 0.95
194 * xHCI hardware can't handle the chain bit being cleared on a link TRB.
196 * @more_trbs_coming: Will you enqueue more TRBs before calling
197 * prepare_transfer()?
199 static void inc_enq(struct xhci_hcd *xhci, struct xhci_ring *ring,
200 bool more_trbs_coming)
203 union xhci_trb *next;
204 unsigned long long addr;
206 chain = le32_to_cpu(ring->enqueue->generic.field[3]) & TRB_CHAIN;
207 /* If this is not event ring, there is one less usable TRB */
208 if (ring->type != TYPE_EVENT &&
209 !last_trb(xhci, ring, ring->enq_seg, ring->enqueue))
210 ring->num_trbs_free--;
211 next = ++(ring->enqueue);
214 /* Update the dequeue pointer further if that was a link TRB or we're at
215 * the end of an event ring segment (which doesn't have link TRBS)
217 while (last_trb(xhci, ring, ring->enq_seg, next)) {
218 if (ring->type != TYPE_EVENT) {
220 * If the caller doesn't plan on enqueueing more
221 * TDs before ringing the doorbell, then we
222 * don't want to give the link TRB to the
223 * hardware just yet. We'll give the link TRB
224 * back in prepare_ring() just before we enqueue
225 * the TD at the top of the ring.
227 if (!chain && !more_trbs_coming)
230 /* If we're not dealing with 0.95 hardware or
231 * isoc rings on AMD 0.96 host,
232 * carry over the chain bit of the previous TRB
233 * (which may mean the chain bit is cleared).
235 if (!(ring->type == TYPE_ISOC &&
236 (xhci->quirks & XHCI_AMD_0x96_HOST))
237 && !xhci_link_trb_quirk(xhci)) {
238 next->link.control &=
239 cpu_to_le32(~TRB_CHAIN);
240 next->link.control |=
243 /* Give this link TRB to the hardware */
245 next->link.control ^= cpu_to_le32(TRB_CYCLE);
247 /* Toggle the cycle bit after the last ring segment. */
248 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
249 ring->cycle_state = (ring->cycle_state ? 0 : 1);
252 ring->enq_seg = ring->enq_seg->next;
253 ring->enqueue = ring->enq_seg->trbs;
254 next = ring->enqueue;
256 addr = (unsigned long long) xhci_trb_virt_to_dma(ring->enq_seg, ring->enqueue);
260 * Check to see if there's room to enqueue num_trbs on the ring and make sure
261 * enqueue pointer will not advance into dequeue segment. See rules above.
263 static inline int room_on_ring(struct xhci_hcd *xhci, struct xhci_ring *ring,
264 unsigned int num_trbs)
266 int num_trbs_in_deq_seg;
268 if (ring->num_trbs_free < num_trbs)
271 if (ring->type != TYPE_COMMAND && ring->type != TYPE_EVENT) {
272 num_trbs_in_deq_seg = ring->dequeue - ring->deq_seg->trbs;
273 if (ring->num_trbs_free < num_trbs + num_trbs_in_deq_seg)
280 /* Ring the host controller doorbell after placing a command on the ring */
281 void xhci_ring_cmd_db(struct xhci_hcd *xhci)
283 if (!(xhci->cmd_ring_state & CMD_RING_STATE_RUNNING))
286 xhci_dbg(xhci, "// Ding dong!\n");
287 xhci_writel(xhci, DB_VALUE_HOST, &xhci->dba->doorbell[0]);
288 /* Flush PCI posted writes */
289 xhci_readl(xhci, &xhci->dba->doorbell[0]);
292 static int xhci_abort_cmd_ring(struct xhci_hcd *xhci)
297 xhci_dbg(xhci, "Abort command ring\n");
299 if (!(xhci->cmd_ring_state & CMD_RING_STATE_RUNNING)) {
300 xhci_dbg(xhci, "The command ring isn't running, "
301 "Have the command ring been stopped?\n");
305 temp_64 = xhci_read_64(xhci, &xhci->op_regs->cmd_ring);
306 if (!(temp_64 & CMD_RING_RUNNING)) {
307 xhci_dbg(xhci, "Command ring had been stopped\n");
310 xhci->cmd_ring_state = CMD_RING_STATE_ABORTED;
311 xhci_write_64(xhci, temp_64 | CMD_RING_ABORT,
312 &xhci->op_regs->cmd_ring);
314 /* Section 4.6.1.2 of xHCI 1.0 spec says software should
315 * time the completion od all xHCI commands, including
316 * the Command Abort operation. If software doesn't see
317 * CRR negated in a timely manner (e.g. longer than 5
318 * seconds), then it should assume that the there are
319 * larger problems with the xHC and assert HCRST.
321 ret = xhci_handshake(xhci, &xhci->op_regs->cmd_ring,
322 CMD_RING_RUNNING, 0, 5 * 1000 * 1000);
324 xhci_err(xhci, "Stopped the command ring failed, "
325 "maybe the host is dead\n");
326 xhci->xhc_state |= XHCI_STATE_DYING;
335 static int xhci_queue_cd(struct xhci_hcd *xhci,
336 struct xhci_command *command,
337 union xhci_trb *cmd_trb)
340 cd = kzalloc(sizeof(struct xhci_cd), GFP_ATOMIC);
343 INIT_LIST_HEAD(&cd->cancel_cmd_list);
345 cd->command = command;
346 cd->cmd_trb = cmd_trb;
347 list_add_tail(&cd->cancel_cmd_list, &xhci->cancel_cmd_list);
353 * Cancel the command which has issue.
355 * Some commands may hang due to waiting for acknowledgement from
356 * usb device. It is outside of the xHC's ability to control and
357 * will cause the command ring is blocked. When it occurs software
358 * should intervene to recover the command ring.
359 * See Section 4.6.1.1 and 4.6.1.2
361 int xhci_cancel_cmd(struct xhci_hcd *xhci, struct xhci_command *command,
362 union xhci_trb *cmd_trb)
367 spin_lock_irqsave(&xhci->lock, flags);
369 if (xhci->xhc_state & XHCI_STATE_DYING) {
370 xhci_warn(xhci, "Abort the command ring,"
371 " but the xHCI is dead.\n");
376 /* queue the cmd desriptor to cancel_cmd_list */
377 retval = xhci_queue_cd(xhci, command, cmd_trb);
379 xhci_warn(xhci, "Queuing command descriptor failed.\n");
383 /* abort command ring */
384 retval = xhci_abort_cmd_ring(xhci);
386 xhci_err(xhci, "Abort command ring failed\n");
387 if (unlikely(retval == -ESHUTDOWN)) {
388 spin_unlock_irqrestore(&xhci->lock, flags);
389 usb_hc_died(xhci_to_hcd(xhci)->primary_hcd);
390 xhci_dbg(xhci, "xHCI host controller is dead.\n");
396 spin_unlock_irqrestore(&xhci->lock, flags);
400 void xhci_ring_ep_doorbell(struct xhci_hcd *xhci,
401 unsigned int slot_id,
402 unsigned int ep_index,
403 unsigned int stream_id)
405 __le32 __iomem *db_addr = &xhci->dba->doorbell[slot_id];
406 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
407 unsigned int ep_state = ep->ep_state;
409 /* Don't ring the doorbell for this endpoint if there are pending
410 * cancellations because we don't want to interrupt processing.
411 * We don't want to restart any stream rings if there's a set dequeue
412 * pointer command pending because the device can choose to start any
413 * stream once the endpoint is on the HW schedule.
414 * FIXME - check all the stream rings for pending cancellations.
416 if ((ep_state & EP_HALT_PENDING) || (ep_state & SET_DEQ_PENDING) ||
417 (ep_state & EP_HALTED))
419 xhci_writel(xhci, DB_VALUE(ep_index, stream_id), db_addr);
420 /* The CPU has better things to do at this point than wait for a
421 * write-posting flush. It'll get there soon enough.
425 /* Ring the doorbell for any rings with pending URBs */
426 static void ring_doorbell_for_active_rings(struct xhci_hcd *xhci,
427 unsigned int slot_id,
428 unsigned int ep_index)
430 unsigned int stream_id;
431 struct xhci_virt_ep *ep;
433 ep = &xhci->devs[slot_id]->eps[ep_index];
435 /* A ring has pending URBs if its TD list is not empty */
436 if (!(ep->ep_state & EP_HAS_STREAMS)) {
437 if (!(list_empty(&ep->ring->td_list)))
438 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, 0);
442 for (stream_id = 1; stream_id < ep->stream_info->num_streams;
444 struct xhci_stream_info *stream_info = ep->stream_info;
445 if (!list_empty(&stream_info->stream_rings[stream_id]->td_list))
446 xhci_ring_ep_doorbell(xhci, slot_id, ep_index,
452 * Find the segment that trb is in. Start searching in start_seg.
453 * If we must move past a segment that has a link TRB with a toggle cycle state
454 * bit set, then we will toggle the value pointed at by cycle_state.
456 static struct xhci_segment *find_trb_seg(
457 struct xhci_segment *start_seg,
458 union xhci_trb *trb, int *cycle_state)
460 struct xhci_segment *cur_seg = start_seg;
461 struct xhci_generic_trb *generic_trb;
463 while (cur_seg->trbs > trb ||
464 &cur_seg->trbs[TRBS_PER_SEGMENT - 1] < trb) {
465 generic_trb = &cur_seg->trbs[TRBS_PER_SEGMENT - 1].generic;
466 if (generic_trb->field[3] & cpu_to_le32(LINK_TOGGLE))
468 cur_seg = cur_seg->next;
469 if (cur_seg == start_seg)
470 /* Looped over the entire list. Oops! */
477 static struct xhci_ring *xhci_triad_to_transfer_ring(struct xhci_hcd *xhci,
478 unsigned int slot_id, unsigned int ep_index,
479 unsigned int stream_id)
481 struct xhci_virt_ep *ep;
483 ep = &xhci->devs[slot_id]->eps[ep_index];
484 /* Common case: no streams */
485 if (!(ep->ep_state & EP_HAS_STREAMS))
488 if (stream_id == 0) {
490 "WARN: Slot ID %u, ep index %u has streams, "
491 "but URB has no stream ID.\n",
496 if (stream_id < ep->stream_info->num_streams)
497 return ep->stream_info->stream_rings[stream_id];
500 "WARN: Slot ID %u, ep index %u has "
501 "stream IDs 1 to %u allocated, "
502 "but stream ID %u is requested.\n",
504 ep->stream_info->num_streams - 1,
509 /* Get the right ring for the given URB.
510 * If the endpoint supports streams, boundary check the URB's stream ID.
511 * If the endpoint doesn't support streams, return the singular endpoint ring.
513 static struct xhci_ring *xhci_urb_to_transfer_ring(struct xhci_hcd *xhci,
516 return xhci_triad_to_transfer_ring(xhci, urb->dev->slot_id,
517 xhci_get_endpoint_index(&urb->ep->desc), urb->stream_id);
521 * Move the xHC's endpoint ring dequeue pointer past cur_td.
522 * Record the new state of the xHC's endpoint ring dequeue segment,
523 * dequeue pointer, and new consumer cycle state in state.
524 * Update our internal representation of the ring's dequeue pointer.
526 * We do this in three jumps:
527 * - First we update our new ring state to be the same as when the xHC stopped.
528 * - Then we traverse the ring to find the segment that contains
529 * the last TRB in the TD. We toggle the xHC's new cycle state when we pass
530 * any link TRBs with the toggle cycle bit set.
531 * - Finally we move the dequeue state one TRB further, toggling the cycle bit
532 * if we've moved it past a link TRB with the toggle cycle bit set.
534 * Some of the uses of xhci_generic_trb are grotty, but if they're done
535 * with correct __le32 accesses they should work fine. Only users of this are
538 void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
539 unsigned int slot_id, unsigned int ep_index,
540 unsigned int stream_id, struct xhci_td *cur_td,
541 struct xhci_dequeue_state *state)
543 struct xhci_virt_device *dev = xhci->devs[slot_id];
544 struct xhci_ring *ep_ring;
545 struct xhci_generic_trb *trb;
546 struct xhci_ep_ctx *ep_ctx;
549 ep_ring = xhci_triad_to_transfer_ring(xhci, slot_id,
550 ep_index, stream_id);
552 xhci_warn(xhci, "WARN can't find new dequeue state "
553 "for invalid stream ID %u.\n",
557 state->new_cycle_state = 0;
558 xhci_dbg(xhci, "Finding segment containing stopped TRB.\n");
559 state->new_deq_seg = find_trb_seg(cur_td->start_seg,
560 dev->eps[ep_index].stopped_trb,
561 &state->new_cycle_state);
562 if (!state->new_deq_seg) {
567 /* Dig out the cycle state saved by the xHC during the stop ep cmd */
568 xhci_dbg(xhci, "Finding endpoint context\n");
569 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
570 state->new_cycle_state = 0x1 & le64_to_cpu(ep_ctx->deq);
572 state->new_deq_ptr = cur_td->last_trb;
573 xhci_dbg(xhci, "Finding segment containing last TRB in TD.\n");
574 state->new_deq_seg = find_trb_seg(state->new_deq_seg,
576 &state->new_cycle_state);
577 if (!state->new_deq_seg) {
582 trb = &state->new_deq_ptr->generic;
583 if (TRB_TYPE_LINK_LE32(trb->field[3]) &&
584 (trb->field[3] & cpu_to_le32(LINK_TOGGLE)))
585 state->new_cycle_state ^= 0x1;
586 next_trb(xhci, ep_ring, &state->new_deq_seg, &state->new_deq_ptr);
589 * If there is only one segment in a ring, find_trb_seg()'s while loop
590 * will not run, and it will return before it has a chance to see if it
591 * needs to toggle the cycle bit. It can't tell if the stalled transfer
592 * ended just before the link TRB on a one-segment ring, or if the TD
593 * wrapped around the top of the ring, because it doesn't have the TD in
594 * question. Look for the one-segment case where stalled TRB's address
595 * is greater than the new dequeue pointer address.
597 if (ep_ring->first_seg == ep_ring->first_seg->next &&
598 state->new_deq_ptr < dev->eps[ep_index].stopped_trb)
599 state->new_cycle_state ^= 0x1;
600 xhci_dbg(xhci, "Cycle state = 0x%x\n", state->new_cycle_state);
602 /* Don't update the ring cycle state for the producer (us). */
603 xhci_dbg(xhci, "New dequeue segment = %p (virtual)\n",
605 addr = xhci_trb_virt_to_dma(state->new_deq_seg, state->new_deq_ptr);
606 xhci_dbg(xhci, "New dequeue pointer = 0x%llx (DMA)\n",
607 (unsigned long long) addr);
610 /* flip_cycle means flip the cycle bit of all but the first and last TRB.
611 * (The last TRB actually points to the ring enqueue pointer, which is not part
612 * of this TD.) This is used to remove partially enqueued isoc TDs from a ring.
614 static void td_to_noop(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
615 struct xhci_td *cur_td, bool flip_cycle)
617 struct xhci_segment *cur_seg;
618 union xhci_trb *cur_trb;
620 for (cur_seg = cur_td->start_seg, cur_trb = cur_td->first_trb;
622 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
623 if (TRB_TYPE_LINK_LE32(cur_trb->generic.field[3])) {
624 /* Unchain any chained Link TRBs, but
625 * leave the pointers intact.
627 cur_trb->generic.field[3] &= cpu_to_le32(~TRB_CHAIN);
628 /* Flip the cycle bit (link TRBs can't be the first
632 cur_trb->generic.field[3] ^=
633 cpu_to_le32(TRB_CYCLE);
634 xhci_dbg(xhci, "Cancel (unchain) link TRB\n");
635 xhci_dbg(xhci, "Address = %p (0x%llx dma); "
636 "in seg %p (0x%llx dma)\n",
638 (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
640 (unsigned long long)cur_seg->dma);
642 cur_trb->generic.field[0] = 0;
643 cur_trb->generic.field[1] = 0;
644 cur_trb->generic.field[2] = 0;
645 /* Preserve only the cycle bit of this TRB */
646 cur_trb->generic.field[3] &= cpu_to_le32(TRB_CYCLE);
647 /* Flip the cycle bit except on the first or last TRB */
648 if (flip_cycle && cur_trb != cur_td->first_trb &&
649 cur_trb != cur_td->last_trb)
650 cur_trb->generic.field[3] ^=
651 cpu_to_le32(TRB_CYCLE);
652 cur_trb->generic.field[3] |= cpu_to_le32(
653 TRB_TYPE(TRB_TR_NOOP));
654 xhci_dbg(xhci, "TRB to noop at offset 0x%llx\n",
656 xhci_trb_virt_to_dma(cur_seg, cur_trb));
658 if (cur_trb == cur_td->last_trb)
663 static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
664 unsigned int ep_index, unsigned int stream_id,
665 struct xhci_segment *deq_seg,
666 union xhci_trb *deq_ptr, u32 cycle_state);
668 void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
669 unsigned int slot_id, unsigned int ep_index,
670 unsigned int stream_id,
671 struct xhci_dequeue_state *deq_state)
673 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
675 xhci_dbg(xhci, "Set TR Deq Ptr cmd, new deq seg = %p (0x%llx dma), "
676 "new deq ptr = %p (0x%llx dma), new cycle = %u\n",
677 deq_state->new_deq_seg,
678 (unsigned long long)deq_state->new_deq_seg->dma,
679 deq_state->new_deq_ptr,
680 (unsigned long long)xhci_trb_virt_to_dma(deq_state->new_deq_seg, deq_state->new_deq_ptr),
681 deq_state->new_cycle_state);
682 queue_set_tr_deq(xhci, slot_id, ep_index, stream_id,
683 deq_state->new_deq_seg,
684 deq_state->new_deq_ptr,
685 (u32) deq_state->new_cycle_state);
686 /* Stop the TD queueing code from ringing the doorbell until
687 * this command completes. The HC won't set the dequeue pointer
688 * if the ring is running, and ringing the doorbell starts the
691 ep->ep_state |= SET_DEQ_PENDING;
694 static void xhci_stop_watchdog_timer_in_irq(struct xhci_hcd *xhci,
695 struct xhci_virt_ep *ep)
697 ep->ep_state &= ~EP_HALT_PENDING;
698 /* Can't del_timer_sync in interrupt, so we attempt to cancel. If the
699 * timer is running on another CPU, we don't decrement stop_cmds_pending
700 * (since we didn't successfully stop the watchdog timer).
702 if (del_timer(&ep->stop_cmd_timer))
703 ep->stop_cmds_pending--;
706 /* Must be called with xhci->lock held in interrupt context */
707 static void xhci_giveback_urb_in_irq(struct xhci_hcd *xhci,
708 struct xhci_td *cur_td, int status, char *adjective)
712 struct urb_priv *urb_priv;
715 urb_priv = urb->hcpriv;
717 hcd = bus_to_hcd(urb->dev->bus);
719 /* Only giveback urb when this is the last td in urb */
720 if (urb_priv->td_cnt == urb_priv->length) {
721 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
722 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs--;
723 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs == 0) {
724 if (xhci->quirks & XHCI_AMD_PLL_FIX)
725 usb_amd_quirk_pll_enable();
728 usb_hcd_unlink_urb_from_ep(hcd, urb);
730 spin_unlock(&xhci->lock);
731 usb_hcd_giveback_urb(hcd, urb, status);
732 xhci_urb_free_priv(xhci, urb_priv);
733 spin_lock(&xhci->lock);
738 * When we get a command completion for a Stop Endpoint Command, we need to
739 * unlink any cancelled TDs from the ring. There are two ways to do that:
741 * 1. If the HW was in the middle of processing the TD that needs to be
742 * cancelled, then we must move the ring's dequeue pointer past the last TRB
743 * in the TD with a Set Dequeue Pointer Command.
744 * 2. Otherwise, we turn all the TRBs in the TD into No-op TRBs (with the chain
745 * bit cleared) so that the HW will skip over them.
747 static void handle_stopped_endpoint(struct xhci_hcd *xhci,
748 union xhci_trb *trb, struct xhci_event_cmd *event)
750 unsigned int slot_id;
751 unsigned int ep_index;
752 struct xhci_virt_device *virt_dev;
753 struct xhci_ring *ep_ring;
754 struct xhci_virt_ep *ep;
755 struct list_head *entry;
756 struct xhci_td *cur_td = NULL;
757 struct xhci_td *last_unlinked_td;
759 struct xhci_dequeue_state deq_state;
761 if (unlikely(TRB_TO_SUSPEND_PORT(
762 le32_to_cpu(xhci->cmd_ring->dequeue->generic.field[3])))) {
763 slot_id = TRB_TO_SLOT_ID(
764 le32_to_cpu(xhci->cmd_ring->dequeue->generic.field[3]));
765 virt_dev = xhci->devs[slot_id];
767 handle_cmd_in_cmd_wait_list(xhci, virt_dev,
770 xhci_warn(xhci, "Stop endpoint command "
771 "completion for disabled slot %u\n",
776 memset(&deq_state, 0, sizeof(deq_state));
777 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(trb->generic.field[3]));
778 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
779 ep = &xhci->devs[slot_id]->eps[ep_index];
781 if (list_empty(&ep->cancelled_td_list)) {
782 xhci_stop_watchdog_timer_in_irq(xhci, ep);
783 ep->stopped_td = NULL;
784 ep->stopped_trb = NULL;
785 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
789 /* Fix up the ep ring first, so HW stops executing cancelled TDs.
790 * We have the xHCI lock, so nothing can modify this list until we drop
791 * it. We're also in the event handler, so we can't get re-interrupted
792 * if another Stop Endpoint command completes
794 list_for_each(entry, &ep->cancelled_td_list) {
795 cur_td = list_entry(entry, struct xhci_td, cancelled_td_list);
796 xhci_dbg(xhci, "Removing canceled TD starting at 0x%llx (dma).\n",
797 (unsigned long long)xhci_trb_virt_to_dma(
798 cur_td->start_seg, cur_td->first_trb));
799 ep_ring = xhci_urb_to_transfer_ring(xhci, cur_td->urb);
801 /* This shouldn't happen unless a driver is mucking
802 * with the stream ID after submission. This will
803 * leave the TD on the hardware ring, and the hardware
804 * will try to execute it, and may access a buffer
805 * that has already been freed. In the best case, the
806 * hardware will execute it, and the event handler will
807 * ignore the completion event for that TD, since it was
808 * removed from the td_list for that endpoint. In
809 * short, don't muck with the stream ID after
812 xhci_warn(xhci, "WARN Cancelled URB %p "
813 "has invalid stream ID %u.\n",
815 cur_td->urb->stream_id);
816 goto remove_finished_td;
819 * If we stopped on the TD we need to cancel, then we have to
820 * move the xHC endpoint ring dequeue pointer past this TD.
822 if (cur_td == ep->stopped_td)
823 xhci_find_new_dequeue_state(xhci, slot_id, ep_index,
824 cur_td->urb->stream_id,
827 td_to_noop(xhci, ep_ring, cur_td, false);
830 * The event handler won't see a completion for this TD anymore,
831 * so remove it from the endpoint ring's TD list. Keep it in
832 * the cancelled TD list for URB completion later.
834 list_del_init(&cur_td->td_list);
836 last_unlinked_td = cur_td;
837 xhci_stop_watchdog_timer_in_irq(xhci, ep);
839 /* If necessary, queue a Set Transfer Ring Dequeue Pointer command */
840 if (deq_state.new_deq_ptr && deq_state.new_deq_seg) {
841 xhci_queue_new_dequeue_state(xhci,
843 ep->stopped_td->urb->stream_id,
845 xhci_ring_cmd_db(xhci);
847 /* Otherwise ring the doorbell(s) to restart queued transfers */
848 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
850 ep->stopped_td = NULL;
851 ep->stopped_trb = NULL;
854 * Drop the lock and complete the URBs in the cancelled TD list.
855 * New TDs to be cancelled might be added to the end of the list before
856 * we can complete all the URBs for the TDs we already unlinked.
857 * So stop when we've completed the URB for the last TD we unlinked.
860 cur_td = list_entry(ep->cancelled_td_list.next,
861 struct xhci_td, cancelled_td_list);
862 list_del_init(&cur_td->cancelled_td_list);
864 /* Clean up the cancelled URB */
865 /* Doesn't matter what we pass for status, since the core will
866 * just overwrite it (because the URB has been unlinked).
868 xhci_giveback_urb_in_irq(xhci, cur_td, 0, "cancelled");
870 /* Stop processing the cancelled list if the watchdog timer is
873 if (xhci->xhc_state & XHCI_STATE_DYING)
875 } while (cur_td != last_unlinked_td);
877 /* Return to the event handler with xhci->lock re-acquired */
880 /* Watchdog timer function for when a stop endpoint command fails to complete.
881 * In this case, we assume the host controller is broken or dying or dead. The
882 * host may still be completing some other events, so we have to be careful to
883 * let the event ring handler and the URB dequeueing/enqueueing functions know
884 * through xhci->state.
886 * The timer may also fire if the host takes a very long time to respond to the
887 * command, and the stop endpoint command completion handler cannot delete the
888 * timer before the timer function is called. Another endpoint cancellation may
889 * sneak in before the timer function can grab the lock, and that may queue
890 * another stop endpoint command and add the timer back. So we cannot use a
891 * simple flag to say whether there is a pending stop endpoint command for a
892 * particular endpoint.
894 * Instead we use a combination of that flag and a counter for the number of
895 * pending stop endpoint commands. If the timer is the tail end of the last
896 * stop endpoint command, and the endpoint's command is still pending, we assume
899 void xhci_stop_endpoint_command_watchdog(unsigned long arg)
901 struct xhci_hcd *xhci;
902 struct xhci_virt_ep *ep;
903 struct xhci_virt_ep *temp_ep;
904 struct xhci_ring *ring;
905 struct xhci_td *cur_td;
909 ep = (struct xhci_virt_ep *) arg;
912 spin_lock_irqsave(&xhci->lock, flags);
914 ep->stop_cmds_pending--;
915 if (xhci->xhc_state & XHCI_STATE_DYING) {
916 xhci_dbg(xhci, "Stop EP timer ran, but another timer marked "
917 "xHCI as DYING, exiting.\n");
918 spin_unlock_irqrestore(&xhci->lock, flags);
921 if (!(ep->stop_cmds_pending == 0 && (ep->ep_state & EP_HALT_PENDING))) {
922 xhci_dbg(xhci, "Stop EP timer ran, but no command pending, "
924 spin_unlock_irqrestore(&xhci->lock, flags);
928 xhci_warn(xhci, "xHCI host not responding to stop endpoint command.\n");
929 xhci_warn(xhci, "Assuming host is dying, halting host.\n");
930 /* Oops, HC is dead or dying or at least not responding to the stop
933 xhci->xhc_state |= XHCI_STATE_DYING;
934 /* Disable interrupts from the host controller and start halting it */
936 spin_unlock_irqrestore(&xhci->lock, flags);
938 ret = xhci_halt(xhci);
940 spin_lock_irqsave(&xhci->lock, flags);
942 /* This is bad; the host is not responding to commands and it's
943 * not allowing itself to be halted. At least interrupts are
944 * disabled. If we call usb_hc_died(), it will attempt to
945 * disconnect all device drivers under this host. Those
946 * disconnect() methods will wait for all URBs to be unlinked,
947 * so we must complete them.
949 xhci_warn(xhci, "Non-responsive xHCI host is not halting.\n");
950 xhci_warn(xhci, "Completing active URBs anyway.\n");
951 /* We could turn all TDs on the rings to no-ops. This won't
952 * help if the host has cached part of the ring, and is slow if
953 * we want to preserve the cycle bit. Skip it and hope the host
954 * doesn't touch the memory.
957 for (i = 0; i < MAX_HC_SLOTS; i++) {
960 for (j = 0; j < 31; j++) {
961 temp_ep = &xhci->devs[i]->eps[j];
962 ring = temp_ep->ring;
965 xhci_dbg(xhci, "Killing URBs for slot ID %u, "
966 "ep index %u\n", i, j);
967 while (!list_empty(&ring->td_list)) {
968 cur_td = list_first_entry(&ring->td_list,
971 list_del_init(&cur_td->td_list);
972 if (!list_empty(&cur_td->cancelled_td_list))
973 list_del_init(&cur_td->cancelled_td_list);
974 xhci_giveback_urb_in_irq(xhci, cur_td,
975 -ESHUTDOWN, "killed");
977 while (!list_empty(&temp_ep->cancelled_td_list)) {
978 cur_td = list_first_entry(
979 &temp_ep->cancelled_td_list,
982 list_del_init(&cur_td->cancelled_td_list);
983 xhci_giveback_urb_in_irq(xhci, cur_td,
984 -ESHUTDOWN, "killed");
988 spin_unlock_irqrestore(&xhci->lock, flags);
989 xhci_dbg(xhci, "Calling usb_hc_died()\n");
990 usb_hc_died(xhci_to_hcd(xhci)->primary_hcd);
991 xhci_dbg(xhci, "xHCI host controller is dead.\n");
995 static void update_ring_for_set_deq_completion(struct xhci_hcd *xhci,
996 struct xhci_virt_device *dev,
997 struct xhci_ring *ep_ring,
998 unsigned int ep_index)
1000 union xhci_trb *dequeue_temp;
1001 int num_trbs_free_temp;
1002 bool revert = false;
1004 num_trbs_free_temp = ep_ring->num_trbs_free;
1005 dequeue_temp = ep_ring->dequeue;
1007 /* If we get two back-to-back stalls, and the first stalled transfer
1008 * ends just before a link TRB, the dequeue pointer will be left on
1009 * the link TRB by the code in the while loop. So we have to update
1010 * the dequeue pointer one segment further, or we'll jump off
1011 * the segment into la-la-land.
1013 if (last_trb(xhci, ep_ring, ep_ring->deq_seg, ep_ring->dequeue)) {
1014 ep_ring->deq_seg = ep_ring->deq_seg->next;
1015 ep_ring->dequeue = ep_ring->deq_seg->trbs;
1018 while (ep_ring->dequeue != dev->eps[ep_index].queued_deq_ptr) {
1019 /* We have more usable TRBs */
1020 ep_ring->num_trbs_free++;
1022 if (last_trb(xhci, ep_ring, ep_ring->deq_seg,
1023 ep_ring->dequeue)) {
1024 if (ep_ring->dequeue ==
1025 dev->eps[ep_index].queued_deq_ptr)
1027 ep_ring->deq_seg = ep_ring->deq_seg->next;
1028 ep_ring->dequeue = ep_ring->deq_seg->trbs;
1030 if (ep_ring->dequeue == dequeue_temp) {
1037 xhci_dbg(xhci, "Unable to find new dequeue pointer\n");
1038 ep_ring->num_trbs_free = num_trbs_free_temp;
1043 * When we get a completion for a Set Transfer Ring Dequeue Pointer command,
1044 * we need to clear the set deq pending flag in the endpoint ring state, so that
1045 * the TD queueing code can ring the doorbell again. We also need to ring the
1046 * endpoint doorbell to restart the ring, but only if there aren't more
1047 * cancellations pending.
1049 static void handle_set_deq_completion(struct xhci_hcd *xhci,
1050 struct xhci_event_cmd *event,
1051 union xhci_trb *trb)
1053 unsigned int slot_id;
1054 unsigned int ep_index;
1055 unsigned int stream_id;
1056 struct xhci_ring *ep_ring;
1057 struct xhci_virt_device *dev;
1058 struct xhci_ep_ctx *ep_ctx;
1059 struct xhci_slot_ctx *slot_ctx;
1061 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(trb->generic.field[3]));
1062 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
1063 stream_id = TRB_TO_STREAM_ID(le32_to_cpu(trb->generic.field[2]));
1064 dev = xhci->devs[slot_id];
1066 ep_ring = xhci_stream_id_to_ring(dev, ep_index, stream_id);
1068 xhci_warn(xhci, "WARN Set TR deq ptr command for "
1069 "freed stream ID %u\n",
1071 /* XXX: Harmless??? */
1072 dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
1076 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
1077 slot_ctx = xhci_get_slot_ctx(xhci, dev->out_ctx);
1079 if (GET_COMP_CODE(le32_to_cpu(event->status)) != COMP_SUCCESS) {
1080 unsigned int ep_state;
1081 unsigned int slot_state;
1083 switch (GET_COMP_CODE(le32_to_cpu(event->status))) {
1085 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd invalid because "
1086 "of stream ID configuration\n");
1088 case COMP_CTX_STATE:
1089 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed due "
1090 "to incorrect slot or ep state.\n");
1091 ep_state = le32_to_cpu(ep_ctx->ep_info);
1092 ep_state &= EP_STATE_MASK;
1093 slot_state = le32_to_cpu(slot_ctx->dev_state);
1094 slot_state = GET_SLOT_STATE(slot_state);
1095 xhci_dbg(xhci, "Slot state = %u, EP state = %u\n",
1096 slot_state, ep_state);
1099 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed because "
1100 "slot %u was not enabled.\n", slot_id);
1103 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd with unknown "
1104 "completion code of %u.\n",
1105 GET_COMP_CODE(le32_to_cpu(event->status)));
1108 /* OK what do we do now? The endpoint state is hosed, and we
1109 * should never get to this point if the synchronization between
1110 * queueing, and endpoint state are correct. This might happen
1111 * if the device gets disconnected after we've finished
1112 * cancelling URBs, which might not be an error...
1115 xhci_dbg(xhci, "Successful Set TR Deq Ptr cmd, deq = @%08llx\n",
1116 le64_to_cpu(ep_ctx->deq));
1117 if (xhci_trb_virt_to_dma(dev->eps[ep_index].queued_deq_seg,
1118 dev->eps[ep_index].queued_deq_ptr) ==
1119 (le64_to_cpu(ep_ctx->deq) & ~(EP_CTX_CYCLE_MASK))) {
1120 /* Update the ring's dequeue segment and dequeue pointer
1121 * to reflect the new position.
1123 update_ring_for_set_deq_completion(xhci, dev,
1126 xhci_warn(xhci, "Mismatch between completed Set TR Deq "
1127 "Ptr command & xHCI internal state.\n");
1128 xhci_warn(xhci, "ep deq seg = %p, deq ptr = %p\n",
1129 dev->eps[ep_index].queued_deq_seg,
1130 dev->eps[ep_index].queued_deq_ptr);
1134 dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
1135 dev->eps[ep_index].queued_deq_seg = NULL;
1136 dev->eps[ep_index].queued_deq_ptr = NULL;
1137 /* Restart any rings with pending URBs */
1138 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1141 static void handle_reset_ep_completion(struct xhci_hcd *xhci,
1142 struct xhci_event_cmd *event,
1143 union xhci_trb *trb)
1146 unsigned int ep_index;
1148 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(trb->generic.field[3]));
1149 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
1150 /* This command will only fail if the endpoint wasn't halted,
1151 * but we don't care.
1153 xhci_dbg(xhci, "Ignoring reset ep completion code of %u\n",
1154 GET_COMP_CODE(le32_to_cpu(event->status)));
1156 /* HW with the reset endpoint quirk needs to have a configure endpoint
1157 * command complete before the endpoint can be used. Queue that here
1158 * because the HW can't handle two commands being queued in a row.
1160 if (xhci->quirks & XHCI_RESET_EP_QUIRK) {
1161 xhci_dbg(xhci, "Queueing configure endpoint command\n");
1162 xhci_queue_configure_endpoint(xhci,
1163 xhci->devs[slot_id]->in_ctx->dma, slot_id,
1165 xhci_ring_cmd_db(xhci);
1167 /* Clear our internal halted state and restart the ring(s) */
1168 xhci->devs[slot_id]->eps[ep_index].ep_state &= ~EP_HALTED;
1169 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1173 /* Complete the command and detele it from the devcie's command queue.
1175 static void xhci_complete_cmd_in_cmd_wait_list(struct xhci_hcd *xhci,
1176 struct xhci_command *command, u32 status)
1178 command->status = status;
1179 list_del(&command->cmd_list);
1180 if (command->completion)
1181 complete(command->completion);
1183 xhci_free_command(xhci, command);
1187 /* Check to see if a command in the device's command queue matches this one.
1188 * Signal the completion or free the command, and return 1. Return 0 if the
1189 * completed command isn't at the head of the command list.
1191 static int handle_cmd_in_cmd_wait_list(struct xhci_hcd *xhci,
1192 struct xhci_virt_device *virt_dev,
1193 struct xhci_event_cmd *event)
1195 struct xhci_command *command;
1197 if (list_empty(&virt_dev->cmd_list))
1200 command = list_entry(virt_dev->cmd_list.next,
1201 struct xhci_command, cmd_list);
1202 if (xhci->cmd_ring->dequeue != command->command_trb)
1205 xhci_complete_cmd_in_cmd_wait_list(xhci, command,
1206 GET_COMP_CODE(le32_to_cpu(event->status)));
1211 * Finding the command trb need to be cancelled and modifying it to
1212 * NO OP command. And if the command is in device's command wait
1213 * list, finishing and freeing it.
1215 * If we can't find the command trb, we think it had already been
1218 static void xhci_cmd_to_noop(struct xhci_hcd *xhci, struct xhci_cd *cur_cd)
1220 struct xhci_segment *cur_seg;
1221 union xhci_trb *cmd_trb;
1224 if (xhci->cmd_ring->dequeue == xhci->cmd_ring->enqueue)
1227 /* find the current segment of command ring */
1228 cur_seg = find_trb_seg(xhci->cmd_ring->first_seg,
1229 xhci->cmd_ring->dequeue, &cycle_state);
1232 xhci_warn(xhci, "Command ring mismatch, dequeue = %p %llx (dma)\n",
1233 xhci->cmd_ring->dequeue,
1234 (unsigned long long)
1235 xhci_trb_virt_to_dma(xhci->cmd_ring->deq_seg,
1236 xhci->cmd_ring->dequeue));
1237 xhci_debug_ring(xhci, xhci->cmd_ring);
1238 xhci_dbg_ring_ptrs(xhci, xhci->cmd_ring);
1242 /* find the command trb matched by cd from command ring */
1243 for (cmd_trb = xhci->cmd_ring->dequeue;
1244 cmd_trb != xhci->cmd_ring->enqueue;
1245 next_trb(xhci, xhci->cmd_ring, &cur_seg, &cmd_trb)) {
1246 /* If the trb is link trb, continue */
1247 if (TRB_TYPE_LINK_LE32(cmd_trb->generic.field[3]))
1250 if (cur_cd->cmd_trb == cmd_trb) {
1252 /* If the command in device's command list, we should
1253 * finish it and free the command structure.
1255 if (cur_cd->command)
1256 xhci_complete_cmd_in_cmd_wait_list(xhci,
1257 cur_cd->command, COMP_CMD_STOP);
1259 /* get cycle state from the origin command trb */
1260 cycle_state = le32_to_cpu(cmd_trb->generic.field[3])
1263 /* modify the command trb to NO OP command */
1264 cmd_trb->generic.field[0] = 0;
1265 cmd_trb->generic.field[1] = 0;
1266 cmd_trb->generic.field[2] = 0;
1267 cmd_trb->generic.field[3] = cpu_to_le32(
1268 TRB_TYPE(TRB_CMD_NOOP) | cycle_state);
1274 static void xhci_cancel_cmd_in_cd_list(struct xhci_hcd *xhci)
1276 struct xhci_cd *cur_cd, *next_cd;
1278 if (list_empty(&xhci->cancel_cmd_list))
1281 list_for_each_entry_safe(cur_cd, next_cd,
1282 &xhci->cancel_cmd_list, cancel_cmd_list) {
1283 xhci_cmd_to_noop(xhci, cur_cd);
1284 list_del(&cur_cd->cancel_cmd_list);
1290 * traversing the cancel_cmd_list. If the command descriptor according
1291 * to cmd_trb is found, the function free it and return 1, otherwise
1294 static int xhci_search_cmd_trb_in_cd_list(struct xhci_hcd *xhci,
1295 union xhci_trb *cmd_trb)
1297 struct xhci_cd *cur_cd, *next_cd;
1299 if (list_empty(&xhci->cancel_cmd_list))
1302 list_for_each_entry_safe(cur_cd, next_cd,
1303 &xhci->cancel_cmd_list, cancel_cmd_list) {
1304 if (cur_cd->cmd_trb == cmd_trb) {
1305 if (cur_cd->command)
1306 xhci_complete_cmd_in_cmd_wait_list(xhci,
1307 cur_cd->command, COMP_CMD_STOP);
1308 list_del(&cur_cd->cancel_cmd_list);
1318 * If the cmd_trb_comp_code is COMP_CMD_ABORT, we just check whether the
1319 * trb pointed by the command ring dequeue pointer is the trb we want to
1320 * cancel or not. And if the cmd_trb_comp_code is COMP_CMD_STOP, we will
1321 * traverse the cancel_cmd_list to trun the all of the commands according
1322 * to command descriptor to NO-OP trb.
1324 static int handle_stopped_cmd_ring(struct xhci_hcd *xhci,
1325 int cmd_trb_comp_code)
1327 int cur_trb_is_good = 0;
1329 /* Searching the cmd trb pointed by the command ring dequeue
1330 * pointer in command descriptor list. If it is found, free it.
1332 cur_trb_is_good = xhci_search_cmd_trb_in_cd_list(xhci,
1333 xhci->cmd_ring->dequeue);
1335 if (cmd_trb_comp_code == COMP_CMD_ABORT)
1336 xhci->cmd_ring_state = CMD_RING_STATE_STOPPED;
1337 else if (cmd_trb_comp_code == COMP_CMD_STOP) {
1338 /* traversing the cancel_cmd_list and canceling
1339 * the command according to command descriptor
1341 xhci_cancel_cmd_in_cd_list(xhci);
1343 xhci->cmd_ring_state = CMD_RING_STATE_RUNNING;
1345 * ring command ring doorbell again to restart the
1348 if (xhci->cmd_ring->dequeue != xhci->cmd_ring->enqueue)
1349 xhci_ring_cmd_db(xhci);
1351 return cur_trb_is_good;
1354 static void handle_cmd_completion(struct xhci_hcd *xhci,
1355 struct xhci_event_cmd *event)
1357 int slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1359 dma_addr_t cmd_dequeue_dma;
1360 struct xhci_input_control_ctx *ctrl_ctx;
1361 struct xhci_virt_device *virt_dev;
1362 unsigned int ep_index;
1363 struct xhci_ring *ep_ring;
1364 unsigned int ep_state;
1366 cmd_dma = le64_to_cpu(event->cmd_trb);
1367 cmd_dequeue_dma = xhci_trb_virt_to_dma(xhci->cmd_ring->deq_seg,
1368 xhci->cmd_ring->dequeue);
1369 /* Is the command ring deq ptr out of sync with the deq seg ptr? */
1370 if (cmd_dequeue_dma == 0) {
1371 xhci->error_bitmask |= 1 << 4;
1374 /* Does the DMA address match our internal dequeue pointer address? */
1375 if (cmd_dma != (u64) cmd_dequeue_dma) {
1376 xhci->error_bitmask |= 1 << 5;
1380 if ((GET_COMP_CODE(le32_to_cpu(event->status)) == COMP_CMD_ABORT) ||
1381 (GET_COMP_CODE(le32_to_cpu(event->status)) == COMP_CMD_STOP)) {
1382 /* If the return value is 0, we think the trb pointed by
1383 * command ring dequeue pointer is a good trb. The good
1384 * trb means we don't want to cancel the trb, but it have
1385 * been stopped by host. So we should handle it normally.
1386 * Otherwise, driver should invoke inc_deq() and return.
1388 if (handle_stopped_cmd_ring(xhci,
1389 GET_COMP_CODE(le32_to_cpu(event->status)))) {
1390 inc_deq(xhci, xhci->cmd_ring);
1395 switch (le32_to_cpu(xhci->cmd_ring->dequeue->generic.field[3])
1396 & TRB_TYPE_BITMASK) {
1397 case TRB_TYPE(TRB_ENABLE_SLOT):
1398 if (GET_COMP_CODE(le32_to_cpu(event->status)) == COMP_SUCCESS)
1399 xhci->slot_id = slot_id;
1402 complete(&xhci->addr_dev);
1404 case TRB_TYPE(TRB_DISABLE_SLOT):
1405 if (xhci->devs[slot_id]) {
1406 if (xhci->quirks & XHCI_EP_LIMIT_QUIRK)
1407 /* Delete default control endpoint resources */
1408 xhci_free_device_endpoint_resources(xhci,
1409 xhci->devs[slot_id], true);
1410 xhci_free_virt_device(xhci, slot_id);
1413 case TRB_TYPE(TRB_CONFIG_EP):
1414 virt_dev = xhci->devs[slot_id];
1415 if (handle_cmd_in_cmd_wait_list(xhci, virt_dev, event))
1418 * Configure endpoint commands can come from the USB core
1419 * configuration or alt setting changes, or because the HW
1420 * needed an extra configure endpoint command after a reset
1421 * endpoint command or streams were being configured.
1422 * If the command was for a halted endpoint, the xHCI driver
1423 * is not waiting on the configure endpoint command.
1425 ctrl_ctx = xhci_get_input_control_ctx(xhci,
1427 /* Input ctx add_flags are the endpoint index plus one */
1428 ep_index = xhci_last_valid_endpoint(le32_to_cpu(ctrl_ctx->add_flags)) - 1;
1429 /* A usb_set_interface() call directly after clearing a halted
1430 * condition may race on this quirky hardware. Not worth
1431 * worrying about, since this is prototype hardware. Not sure
1432 * if this will work for streams, but streams support was
1433 * untested on this prototype.
1435 if (xhci->quirks & XHCI_RESET_EP_QUIRK &&
1436 ep_index != (unsigned int) -1 &&
1437 le32_to_cpu(ctrl_ctx->add_flags) - SLOT_FLAG ==
1438 le32_to_cpu(ctrl_ctx->drop_flags)) {
1439 ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
1440 ep_state = xhci->devs[slot_id]->eps[ep_index].ep_state;
1441 if (!(ep_state & EP_HALTED))
1442 goto bandwidth_change;
1443 xhci_dbg(xhci, "Completed config ep cmd - "
1444 "last ep index = %d, state = %d\n",
1445 ep_index, ep_state);
1446 /* Clear internal halted state and restart ring(s) */
1447 xhci->devs[slot_id]->eps[ep_index].ep_state &=
1449 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1453 xhci_dbg(xhci, "Completed config ep cmd\n");
1454 xhci->devs[slot_id]->cmd_status =
1455 GET_COMP_CODE(le32_to_cpu(event->status));
1456 complete(&xhci->devs[slot_id]->cmd_completion);
1458 case TRB_TYPE(TRB_EVAL_CONTEXT):
1459 virt_dev = xhci->devs[slot_id];
1460 if (handle_cmd_in_cmd_wait_list(xhci, virt_dev, event))
1462 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(le32_to_cpu(event->status));
1463 complete(&xhci->devs[slot_id]->cmd_completion);
1465 case TRB_TYPE(TRB_ADDR_DEV):
1466 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(le32_to_cpu(event->status));
1467 complete(&xhci->addr_dev);
1469 case TRB_TYPE(TRB_STOP_RING):
1470 handle_stopped_endpoint(xhci, xhci->cmd_ring->dequeue, event);
1472 case TRB_TYPE(TRB_SET_DEQ):
1473 handle_set_deq_completion(xhci, event, xhci->cmd_ring->dequeue);
1475 case TRB_TYPE(TRB_CMD_NOOP):
1477 case TRB_TYPE(TRB_RESET_EP):
1478 handle_reset_ep_completion(xhci, event, xhci->cmd_ring->dequeue);
1480 case TRB_TYPE(TRB_RESET_DEV):
1481 xhci_dbg(xhci, "Completed reset device command.\n");
1482 slot_id = TRB_TO_SLOT_ID(
1483 le32_to_cpu(xhci->cmd_ring->dequeue->generic.field[3]));
1484 virt_dev = xhci->devs[slot_id];
1486 handle_cmd_in_cmd_wait_list(xhci, virt_dev, event);
1488 xhci_warn(xhci, "Reset device command completion "
1489 "for disabled slot %u\n", slot_id);
1491 case TRB_TYPE(TRB_NEC_GET_FW):
1492 if (!(xhci->quirks & XHCI_NEC_HOST)) {
1493 xhci->error_bitmask |= 1 << 6;
1496 xhci_dbg(xhci, "NEC firmware version %2x.%02x\n",
1497 NEC_FW_MAJOR(le32_to_cpu(event->status)),
1498 NEC_FW_MINOR(le32_to_cpu(event->status)));
1501 /* Skip over unknown commands on the event ring */
1502 xhci->error_bitmask |= 1 << 6;
1505 inc_deq(xhci, xhci->cmd_ring);
1508 static void handle_vendor_event(struct xhci_hcd *xhci,
1509 union xhci_trb *event)
1513 trb_type = TRB_FIELD_TO_TYPE(le32_to_cpu(event->generic.field[3]));
1514 xhci_dbg(xhci, "Vendor specific event TRB type = %u\n", trb_type);
1515 if (trb_type == TRB_NEC_CMD_COMP && (xhci->quirks & XHCI_NEC_HOST))
1516 handle_cmd_completion(xhci, &event->event_cmd);
1519 /* @port_id: the one-based port ID from the hardware (indexed from array of all
1520 * port registers -- USB 3.0 and USB 2.0).
1522 * Returns a zero-based port number, which is suitable for indexing into each of
1523 * the split roothubs' port arrays and bus state arrays.
1524 * Add one to it in order to call xhci_find_slot_id_by_port.
1526 static unsigned int find_faked_portnum_from_hw_portnum(struct usb_hcd *hcd,
1527 struct xhci_hcd *xhci, u32 port_id)
1530 unsigned int num_similar_speed_ports = 0;
1532 /* port_id from the hardware is 1-based, but port_array[], usb3_ports[],
1533 * and usb2_ports are 0-based indexes. Count the number of similar
1534 * speed ports, up to 1 port before this port.
1536 for (i = 0; i < (port_id - 1); i++) {
1537 u8 port_speed = xhci->port_array[i];
1540 * Skip ports that don't have known speeds, or have duplicate
1541 * Extended Capabilities port speed entries.
1543 if (port_speed == 0 || port_speed == DUPLICATE_ENTRY)
1547 * USB 3.0 ports are always under a USB 3.0 hub. USB 2.0 and
1548 * 1.1 ports are under the USB 2.0 hub. If the port speed
1549 * matches the device speed, it's a similar speed port.
1551 if ((port_speed == 0x03) == (hcd->speed == HCD_USB3))
1552 num_similar_speed_ports++;
1554 return num_similar_speed_ports;
1557 static void handle_device_notification(struct xhci_hcd *xhci,
1558 union xhci_trb *event)
1561 struct usb_device *udev;
1563 slot_id = TRB_TO_SLOT_ID(event->generic.field[3]);
1564 if (!xhci->devs[slot_id]) {
1565 xhci_warn(xhci, "Device Notification event for "
1566 "unused slot %u\n", slot_id);
1570 xhci_dbg(xhci, "Device Wake Notification event for slot ID %u\n",
1572 udev = xhci->devs[slot_id]->udev;
1573 if (udev && udev->parent)
1574 usb_wakeup_notification(udev->parent, udev->portnum);
1577 static void handle_port_status(struct xhci_hcd *xhci,
1578 union xhci_trb *event)
1580 struct usb_hcd *hcd;
1585 unsigned int faked_port_index;
1587 struct xhci_bus_state *bus_state;
1588 __le32 __iomem **port_array;
1589 bool bogus_port_status = false;
1591 /* Port status change events always have a successful completion code */
1592 if (GET_COMP_CODE(le32_to_cpu(event->generic.field[2])) != COMP_SUCCESS) {
1593 xhci_warn(xhci, "WARN: xHC returned failed port status event\n");
1594 xhci->error_bitmask |= 1 << 8;
1596 port_id = GET_PORT_ID(le32_to_cpu(event->generic.field[0]));
1597 xhci_dbg(xhci, "Port Status Change Event for port %d\n", port_id);
1599 max_ports = HCS_MAX_PORTS(xhci->hcs_params1);
1600 if ((port_id <= 0) || (port_id > max_ports)) {
1601 xhci_warn(xhci, "Invalid port id %d\n", port_id);
1602 bogus_port_status = true;
1606 /* Figure out which usb_hcd this port is attached to:
1607 * is it a USB 3.0 port or a USB 2.0/1.1 port?
1609 major_revision = xhci->port_array[port_id - 1];
1610 if (major_revision == 0) {
1611 xhci_warn(xhci, "Event for port %u not in "
1612 "Extended Capabilities, ignoring.\n",
1614 bogus_port_status = true;
1617 if (major_revision == DUPLICATE_ENTRY) {
1618 xhci_warn(xhci, "Event for port %u duplicated in"
1619 "Extended Capabilities, ignoring.\n",
1621 bogus_port_status = true;
1626 * Hardware port IDs reported by a Port Status Change Event include USB
1627 * 3.0 and USB 2.0 ports. We want to check if the port has reported a
1628 * resume event, but we first need to translate the hardware port ID
1629 * into the index into the ports on the correct split roothub, and the
1630 * correct bus_state structure.
1632 /* Find the right roothub. */
1633 hcd = xhci_to_hcd(xhci);
1634 if ((major_revision == 0x03) != (hcd->speed == HCD_USB3))
1635 hcd = xhci->shared_hcd;
1636 bus_state = &xhci->bus_state[hcd_index(hcd)];
1637 if (hcd->speed == HCD_USB3)
1638 port_array = xhci->usb3_ports;
1640 port_array = xhci->usb2_ports;
1641 /* Find the faked port hub number */
1642 faked_port_index = find_faked_portnum_from_hw_portnum(hcd, xhci,
1645 temp = xhci_readl(xhci, port_array[faked_port_index]);
1646 if (hcd->state == HC_STATE_SUSPENDED) {
1647 xhci_dbg(xhci, "resume root hub\n");
1648 usb_hcd_resume_root_hub(hcd);
1651 if ((temp & PORT_PLC) && (temp & PORT_PLS_MASK) == XDEV_RESUME) {
1652 xhci_dbg(xhci, "port resume event for port %d\n", port_id);
1654 temp1 = xhci_readl(xhci, &xhci->op_regs->command);
1655 if (!(temp1 & CMD_RUN)) {
1656 xhci_warn(xhci, "xHC is not running.\n");
1660 if (DEV_SUPERSPEED(temp)) {
1661 xhci_dbg(xhci, "remote wake SS port %d\n", port_id);
1662 /* Set a flag to say the port signaled remote wakeup,
1663 * so we can tell the difference between the end of
1664 * device and host initiated resume.
1666 bus_state->port_remote_wakeup |= 1 << faked_port_index;
1667 xhci_test_and_clear_bit(xhci, port_array,
1668 faked_port_index, PORT_PLC);
1669 xhci_set_link_state(xhci, port_array, faked_port_index,
1671 /* Need to wait until the next link state change
1672 * indicates the device is actually in U0.
1674 bogus_port_status = true;
1677 xhci_dbg(xhci, "resume HS port %d\n", port_id);
1678 bus_state->resume_done[faked_port_index] = jiffies +
1679 msecs_to_jiffies(20);
1680 set_bit(faked_port_index, &bus_state->resuming_ports);
1681 mod_timer(&hcd->rh_timer,
1682 bus_state->resume_done[faked_port_index]);
1683 /* Do the rest in GetPortStatus */
1687 if ((temp & PORT_PLC) && (temp & PORT_PLS_MASK) == XDEV_U0 &&
1688 DEV_SUPERSPEED(temp)) {
1689 xhci_dbg(xhci, "resume SS port %d finished\n", port_id);
1690 /* We've just brought the device into U0 through either the
1691 * Resume state after a device remote wakeup, or through the
1692 * U3Exit state after a host-initiated resume. If it's a device
1693 * initiated remote wake, don't pass up the link state change,
1694 * so the roothub behavior is consistent with external
1695 * USB 3.0 hub behavior.
1697 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1698 faked_port_index + 1);
1699 if (slot_id && xhci->devs[slot_id])
1700 xhci_ring_device(xhci, slot_id);
1701 if (bus_state->port_remote_wakeup & (1 << faked_port_index)) {
1702 bus_state->port_remote_wakeup &=
1703 ~(1 << faked_port_index);
1704 xhci_test_and_clear_bit(xhci, port_array,
1705 faked_port_index, PORT_PLC);
1706 usb_wakeup_notification(hcd->self.root_hub,
1707 faked_port_index + 1);
1708 bogus_port_status = true;
1713 if (hcd->speed != HCD_USB3)
1714 xhci_test_and_clear_bit(xhci, port_array, faked_port_index,
1718 /* Update event ring dequeue pointer before dropping the lock */
1719 inc_deq(xhci, xhci->event_ring);
1721 /* Don't make the USB core poll the roothub if we got a bad port status
1722 * change event. Besides, at that point we can't tell which roothub
1723 * (USB 2.0 or USB 3.0) to kick.
1725 if (bogus_port_status)
1729 * xHCI port-status-change events occur when the "or" of all the
1730 * status-change bits in the portsc register changes from 0 to 1.
1731 * New status changes won't cause an event if any other change
1732 * bits are still set. When an event occurs, switch over to
1733 * polling to avoid losing status changes.
1735 xhci_dbg(xhci, "%s: starting port polling.\n", __func__);
1736 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1737 spin_unlock(&xhci->lock);
1738 /* Pass this up to the core */
1739 usb_hcd_poll_rh_status(hcd);
1740 spin_lock(&xhci->lock);
1744 * This TD is defined by the TRBs starting at start_trb in start_seg and ending
1745 * at end_trb, which may be in another segment. If the suspect DMA address is a
1746 * TRB in this TD, this function returns that TRB's segment. Otherwise it
1749 struct xhci_segment *trb_in_td(struct xhci_segment *start_seg,
1750 union xhci_trb *start_trb,
1751 union xhci_trb *end_trb,
1752 dma_addr_t suspect_dma)
1754 dma_addr_t start_dma;
1755 dma_addr_t end_seg_dma;
1756 dma_addr_t end_trb_dma;
1757 struct xhci_segment *cur_seg;
1759 start_dma = xhci_trb_virt_to_dma(start_seg, start_trb);
1760 cur_seg = start_seg;
1765 /* We may get an event for a Link TRB in the middle of a TD */
1766 end_seg_dma = xhci_trb_virt_to_dma(cur_seg,
1767 &cur_seg->trbs[TRBS_PER_SEGMENT - 1]);
1768 /* If the end TRB isn't in this segment, this is set to 0 */
1769 end_trb_dma = xhci_trb_virt_to_dma(cur_seg, end_trb);
1771 if (end_trb_dma > 0) {
1772 /* The end TRB is in this segment, so suspect should be here */
1773 if (start_dma <= end_trb_dma) {
1774 if (suspect_dma >= start_dma && suspect_dma <= end_trb_dma)
1777 /* Case for one segment with
1778 * a TD wrapped around to the top
1780 if ((suspect_dma >= start_dma &&
1781 suspect_dma <= end_seg_dma) ||
1782 (suspect_dma >= cur_seg->dma &&
1783 suspect_dma <= end_trb_dma))
1788 /* Might still be somewhere in this segment */
1789 if (suspect_dma >= start_dma && suspect_dma <= end_seg_dma)
1792 cur_seg = cur_seg->next;
1793 start_dma = xhci_trb_virt_to_dma(cur_seg, &cur_seg->trbs[0]);
1794 } while (cur_seg != start_seg);
1799 static void xhci_cleanup_halted_endpoint(struct xhci_hcd *xhci,
1800 unsigned int slot_id, unsigned int ep_index,
1801 unsigned int stream_id,
1802 struct xhci_td *td, union xhci_trb *event_trb)
1804 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
1805 ep->ep_state |= EP_HALTED;
1806 ep->stopped_td = td;
1807 ep->stopped_trb = event_trb;
1808 ep->stopped_stream = stream_id;
1810 xhci_queue_reset_ep(xhci, slot_id, ep_index);
1811 xhci_cleanup_stalled_ring(xhci, td->urb->dev, ep_index);
1813 ep->stopped_td = NULL;
1814 ep->stopped_trb = NULL;
1815 ep->stopped_stream = 0;
1817 xhci_ring_cmd_db(xhci);
1820 /* Check if an error has halted the endpoint ring. The class driver will
1821 * cleanup the halt for a non-default control endpoint if we indicate a stall.
1822 * However, a babble and other errors also halt the endpoint ring, and the class
1823 * driver won't clear the halt in that case, so we need to issue a Set Transfer
1824 * Ring Dequeue Pointer command manually.
1826 static int xhci_requires_manual_halt_cleanup(struct xhci_hcd *xhci,
1827 struct xhci_ep_ctx *ep_ctx,
1828 unsigned int trb_comp_code)
1830 /* TRB completion codes that may require a manual halt cleanup */
1831 if (trb_comp_code == COMP_TX_ERR ||
1832 trb_comp_code == COMP_BABBLE ||
1833 trb_comp_code == COMP_SPLIT_ERR)
1834 /* The 0.96 spec says a babbling control endpoint
1835 * is not halted. The 0.96 spec says it is. Some HW
1836 * claims to be 0.95 compliant, but it halts the control
1837 * endpoint anyway. Check if a babble halted the
1840 if ((ep_ctx->ep_info & cpu_to_le32(EP_STATE_MASK)) ==
1841 cpu_to_le32(EP_STATE_HALTED))
1847 int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code)
1849 if (trb_comp_code >= 224 && trb_comp_code <= 255) {
1850 /* Vendor defined "informational" completion code,
1851 * treat as not-an-error.
1853 xhci_dbg(xhci, "Vendor defined info completion code %u\n",
1855 xhci_dbg(xhci, "Treating code as success.\n");
1862 * Finish the td processing, remove the td from td list;
1863 * Return 1 if the urb can be given back.
1865 static int finish_td(struct xhci_hcd *xhci, struct xhci_td *td,
1866 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1867 struct xhci_virt_ep *ep, int *status, bool skip)
1869 struct xhci_virt_device *xdev;
1870 struct xhci_ring *ep_ring;
1871 unsigned int slot_id;
1873 struct urb *urb = NULL;
1874 struct xhci_ep_ctx *ep_ctx;
1876 struct urb_priv *urb_priv;
1879 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1880 xdev = xhci->devs[slot_id];
1881 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
1882 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
1883 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1884 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
1889 if (trb_comp_code == COMP_STOP_INVAL ||
1890 trb_comp_code == COMP_STOP) {
1891 /* The Endpoint Stop Command completion will take care of any
1892 * stopped TDs. A stopped TD may be restarted, so don't update
1893 * the ring dequeue pointer or take this TD off any lists yet.
1895 ep->stopped_td = td;
1896 ep->stopped_trb = event_trb;
1899 if (trb_comp_code == COMP_STALL) {
1900 /* The transfer is completed from the driver's
1901 * perspective, but we need to issue a set dequeue
1902 * command for this stalled endpoint to move the dequeue
1903 * pointer past the TD. We can't do that here because
1904 * the halt condition must be cleared first. Let the
1905 * USB class driver clear the stall later.
1907 ep->stopped_td = td;
1908 ep->stopped_trb = event_trb;
1909 ep->stopped_stream = ep_ring->stream_id;
1910 } else if (xhci_requires_manual_halt_cleanup(xhci,
1911 ep_ctx, trb_comp_code)) {
1912 /* Other types of errors halt the endpoint, but the
1913 * class driver doesn't call usb_reset_endpoint() unless
1914 * the error is -EPIPE. Clear the halted status in the
1915 * xHCI hardware manually.
1917 xhci_cleanup_halted_endpoint(xhci,
1918 slot_id, ep_index, ep_ring->stream_id,
1921 /* Update ring dequeue pointer */
1922 while (ep_ring->dequeue != td->last_trb)
1923 inc_deq(xhci, ep_ring);
1924 inc_deq(xhci, ep_ring);
1928 /* Clean up the endpoint's TD list */
1930 urb_priv = urb->hcpriv;
1932 /* Do one last check of the actual transfer length.
1933 * If the host controller said we transferred more data than
1934 * the buffer length, urb->actual_length will be a very big
1935 * number (since it's unsigned). Play it safe and say we didn't
1936 * transfer anything.
1938 if (urb->actual_length > urb->transfer_buffer_length) {
1939 xhci_warn(xhci, "URB transfer length is wrong, "
1940 "xHC issue? req. len = %u, "
1942 urb->transfer_buffer_length,
1943 urb->actual_length);
1944 urb->actual_length = 0;
1945 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1946 *status = -EREMOTEIO;
1950 list_del_init(&td->td_list);
1951 /* Was this TD slated to be cancelled but completed anyway? */
1952 if (!list_empty(&td->cancelled_td_list))
1953 list_del_init(&td->cancelled_td_list);
1956 /* Giveback the urb when all the tds are completed */
1957 if (urb_priv->td_cnt == urb_priv->length) {
1959 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
1960 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs--;
1961 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs
1963 if (xhci->quirks & XHCI_AMD_PLL_FIX)
1964 usb_amd_quirk_pll_enable();
1974 * Process control tds, update urb status and actual_length.
1976 static int process_ctrl_td(struct xhci_hcd *xhci, struct xhci_td *td,
1977 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1978 struct xhci_virt_ep *ep, int *status)
1980 struct xhci_virt_device *xdev;
1981 struct xhci_ring *ep_ring;
1982 unsigned int slot_id;
1984 struct xhci_ep_ctx *ep_ctx;
1987 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1988 xdev = xhci->devs[slot_id];
1989 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
1990 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
1991 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1992 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
1994 switch (trb_comp_code) {
1996 if (event_trb == ep_ring->dequeue) {
1997 xhci_warn(xhci, "WARN: Success on ctrl setup TRB "
1998 "without IOC set??\n");
1999 *status = -ESHUTDOWN;
2000 } else if (event_trb != td->last_trb) {
2001 xhci_warn(xhci, "WARN: Success on ctrl data TRB "
2002 "without IOC set??\n");
2003 *status = -ESHUTDOWN;
2009 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2010 *status = -EREMOTEIO;
2014 case COMP_STOP_INVAL:
2016 return finish_td(xhci, td, event_trb, event, ep, status, false);
2018 if (!xhci_requires_manual_halt_cleanup(xhci,
2019 ep_ctx, trb_comp_code))
2021 xhci_dbg(xhci, "TRB error code %u, "
2022 "halted endpoint index = %u\n",
2023 trb_comp_code, ep_index);
2024 /* else fall through */
2026 /* Did we transfer part of the data (middle) phase? */
2027 if (event_trb != ep_ring->dequeue &&
2028 event_trb != td->last_trb)
2029 td->urb->actual_length =
2030 td->urb->transfer_buffer_length
2031 - TRB_LEN(le32_to_cpu(event->transfer_len));
2033 td->urb->actual_length = 0;
2035 xhci_cleanup_halted_endpoint(xhci,
2036 slot_id, ep_index, 0, td, event_trb);
2037 return finish_td(xhci, td, event_trb, event, ep, status, true);
2040 * Did we transfer any data, despite the errors that might have
2041 * happened? I.e. did we get past the setup stage?
2043 if (event_trb != ep_ring->dequeue) {
2044 /* The event was for the status stage */
2045 if (event_trb == td->last_trb) {
2046 if (td->urb->actual_length != 0) {
2047 /* Don't overwrite a previously set error code
2049 if ((*status == -EINPROGRESS || *status == 0) &&
2050 (td->urb->transfer_flags
2051 & URB_SHORT_NOT_OK))
2052 /* Did we already see a short data
2054 *status = -EREMOTEIO;
2056 td->urb->actual_length =
2057 td->urb->transfer_buffer_length;
2060 /* Maybe the event was for the data stage? */
2061 td->urb->actual_length =
2062 td->urb->transfer_buffer_length -
2063 TRB_LEN(le32_to_cpu(event->transfer_len));
2064 xhci_dbg(xhci, "Waiting for status "
2070 return finish_td(xhci, td, event_trb, event, ep, status, false);
2074 * Process isochronous tds, update urb packet status and actual_length.
2076 static int process_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
2077 union xhci_trb *event_trb, struct xhci_transfer_event *event,
2078 struct xhci_virt_ep *ep, int *status)
2080 struct xhci_ring *ep_ring;
2081 struct urb_priv *urb_priv;
2084 union xhci_trb *cur_trb;
2085 struct xhci_segment *cur_seg;
2086 struct usb_iso_packet_descriptor *frame;
2088 bool skip_td = false;
2090 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2091 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2092 urb_priv = td->urb->hcpriv;
2093 idx = urb_priv->td_cnt;
2094 frame = &td->urb->iso_frame_desc[idx];
2096 /* handle completion code */
2097 switch (trb_comp_code) {
2099 if (TRB_LEN(le32_to_cpu(event->transfer_len)) == 0) {
2103 if ((xhci->quirks & XHCI_TRUST_TX_LENGTH))
2104 trb_comp_code = COMP_SHORT_TX;
2106 frame->status = td->urb->transfer_flags & URB_SHORT_NOT_OK ?
2110 frame->status = -ECOMM;
2113 case COMP_BUFF_OVER:
2115 frame->status = -EOVERFLOW;
2121 frame->status = -EPROTO;
2125 case COMP_STOP_INVAL:
2132 if (trb_comp_code == COMP_SUCCESS || skip_td) {
2133 frame->actual_length = frame->length;
2134 td->urb->actual_length += frame->length;
2136 for (cur_trb = ep_ring->dequeue,
2137 cur_seg = ep_ring->deq_seg; cur_trb != event_trb;
2138 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
2139 if (!TRB_TYPE_NOOP_LE32(cur_trb->generic.field[3]) &&
2140 !TRB_TYPE_LINK_LE32(cur_trb->generic.field[3]))
2141 len += TRB_LEN(le32_to_cpu(cur_trb->generic.field[2]));
2143 len += TRB_LEN(le32_to_cpu(cur_trb->generic.field[2])) -
2144 TRB_LEN(le32_to_cpu(event->transfer_len));
2146 if (trb_comp_code != COMP_STOP_INVAL) {
2147 frame->actual_length = len;
2148 td->urb->actual_length += len;
2152 return finish_td(xhci, td, event_trb, event, ep, status, false);
2155 static int skip_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
2156 struct xhci_transfer_event *event,
2157 struct xhci_virt_ep *ep, int *status)
2159 struct xhci_ring *ep_ring;
2160 struct urb_priv *urb_priv;
2161 struct usb_iso_packet_descriptor *frame;
2164 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2165 urb_priv = td->urb->hcpriv;
2166 idx = urb_priv->td_cnt;
2167 frame = &td->urb->iso_frame_desc[idx];
2169 /* The transfer is partly done. */
2170 frame->status = -EXDEV;
2172 /* calc actual length */
2173 frame->actual_length = 0;
2175 /* Update ring dequeue pointer */
2176 while (ep_ring->dequeue != td->last_trb)
2177 inc_deq(xhci, ep_ring);
2178 inc_deq(xhci, ep_ring);
2180 return finish_td(xhci, td, NULL, event, ep, status, true);
2184 * Process bulk and interrupt tds, update urb status and actual_length.
2186 static int process_bulk_intr_td(struct xhci_hcd *xhci, struct xhci_td *td,
2187 union xhci_trb *event_trb, struct xhci_transfer_event *event,
2188 struct xhci_virt_ep *ep, int *status)
2190 struct xhci_ring *ep_ring;
2191 union xhci_trb *cur_trb;
2192 struct xhci_segment *cur_seg;
2195 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2196 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2198 switch (trb_comp_code) {
2200 /* Double check that the HW transferred everything. */
2201 if (event_trb != td->last_trb ||
2202 TRB_LEN(le32_to_cpu(event->transfer_len)) != 0) {
2203 xhci_warn(xhci, "WARN Successful completion "
2205 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2206 *status = -EREMOTEIO;
2209 if ((xhci->quirks & XHCI_TRUST_TX_LENGTH))
2210 trb_comp_code = COMP_SHORT_TX;
2216 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2217 *status = -EREMOTEIO;
2222 /* Others already handled above */
2225 if (trb_comp_code == COMP_SHORT_TX)
2226 xhci_dbg(xhci, "ep %#x - asked for %d bytes, "
2227 "%d bytes untransferred\n",
2228 td->urb->ep->desc.bEndpointAddress,
2229 td->urb->transfer_buffer_length,
2230 TRB_LEN(le32_to_cpu(event->transfer_len)));
2231 /* Fast path - was this the last TRB in the TD for this URB? */
2232 if (event_trb == td->last_trb) {
2233 if (TRB_LEN(le32_to_cpu(event->transfer_len)) != 0) {
2234 td->urb->actual_length =
2235 td->urb->transfer_buffer_length -
2236 TRB_LEN(le32_to_cpu(event->transfer_len));
2237 if (td->urb->transfer_buffer_length <
2238 td->urb->actual_length) {
2239 xhci_warn(xhci, "HC gave bad length "
2240 "of %d bytes left\n",
2241 TRB_LEN(le32_to_cpu(event->transfer_len)));
2242 td->urb->actual_length = 0;
2243 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2244 *status = -EREMOTEIO;
2248 /* Don't overwrite a previously set error code */
2249 if (*status == -EINPROGRESS) {
2250 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2251 *status = -EREMOTEIO;
2256 td->urb->actual_length =
2257 td->urb->transfer_buffer_length;
2258 /* Ignore a short packet completion if the
2259 * untransferred length was zero.
2261 if (*status == -EREMOTEIO)
2265 /* Slow path - walk the list, starting from the dequeue
2266 * pointer, to get the actual length transferred.
2268 td->urb->actual_length = 0;
2269 for (cur_trb = ep_ring->dequeue, cur_seg = ep_ring->deq_seg;
2270 cur_trb != event_trb;
2271 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
2272 if (!TRB_TYPE_NOOP_LE32(cur_trb->generic.field[3]) &&
2273 !TRB_TYPE_LINK_LE32(cur_trb->generic.field[3]))
2274 td->urb->actual_length +=
2275 TRB_LEN(le32_to_cpu(cur_trb->generic.field[2]));
2277 /* If the ring didn't stop on a Link or No-op TRB, add
2278 * in the actual bytes transferred from the Normal TRB
2280 if (trb_comp_code != COMP_STOP_INVAL)
2281 td->urb->actual_length +=
2282 TRB_LEN(le32_to_cpu(cur_trb->generic.field[2])) -
2283 TRB_LEN(le32_to_cpu(event->transfer_len));
2286 return finish_td(xhci, td, event_trb, event, ep, status, false);
2290 * If this function returns an error condition, it means it got a Transfer
2291 * event with a corrupted Slot ID, Endpoint ID, or TRB DMA address.
2292 * At this point, the host controller is probably hosed and should be reset.
2294 static int handle_tx_event(struct xhci_hcd *xhci,
2295 struct xhci_transfer_event *event)
2296 __releases(&xhci->lock)
2297 __acquires(&xhci->lock)
2299 struct xhci_virt_device *xdev;
2300 struct xhci_virt_ep *ep;
2301 struct xhci_ring *ep_ring;
2302 unsigned int slot_id;
2304 struct xhci_td *td = NULL;
2305 dma_addr_t event_dma;
2306 struct xhci_segment *event_seg;
2307 union xhci_trb *event_trb;
2308 struct urb *urb = NULL;
2309 int status = -EINPROGRESS;
2310 struct urb_priv *urb_priv;
2311 struct xhci_ep_ctx *ep_ctx;
2312 struct list_head *tmp;
2317 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
2318 xdev = xhci->devs[slot_id];
2320 xhci_err(xhci, "ERROR Transfer event pointed to bad slot\n");
2321 xhci_err(xhci, "@%016llx %08x %08x %08x %08x\n",
2322 (unsigned long long) xhci_trb_virt_to_dma(
2323 xhci->event_ring->deq_seg,
2324 xhci->event_ring->dequeue),
2325 lower_32_bits(le64_to_cpu(event->buffer)),
2326 upper_32_bits(le64_to_cpu(event->buffer)),
2327 le32_to_cpu(event->transfer_len),
2328 le32_to_cpu(event->flags));
2329 xhci_dbg(xhci, "Event ring:\n");
2330 xhci_debug_segment(xhci, xhci->event_ring->deq_seg);
2334 /* Endpoint ID is 1 based, our index is zero based */
2335 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
2336 ep = &xdev->eps[ep_index];
2337 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2338 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
2340 (le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK) ==
2341 EP_STATE_DISABLED) {
2342 xhci_err(xhci, "ERROR Transfer event for disabled endpoint "
2343 "or incorrect stream ring\n");
2344 xhci_err(xhci, "@%016llx %08x %08x %08x %08x\n",
2345 (unsigned long long) xhci_trb_virt_to_dma(
2346 xhci->event_ring->deq_seg,
2347 xhci->event_ring->dequeue),
2348 lower_32_bits(le64_to_cpu(event->buffer)),
2349 upper_32_bits(le64_to_cpu(event->buffer)),
2350 le32_to_cpu(event->transfer_len),
2351 le32_to_cpu(event->flags));
2352 xhci_dbg(xhci, "Event ring:\n");
2353 xhci_debug_segment(xhci, xhci->event_ring->deq_seg);
2357 /* Count current td numbers if ep->skip is set */
2359 list_for_each(tmp, &ep_ring->td_list)
2363 event_dma = le64_to_cpu(event->buffer);
2364 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2365 /* Look for common error cases */
2366 switch (trb_comp_code) {
2367 /* Skip codes that require special handling depending on
2371 if (TRB_LEN(le32_to_cpu(event->transfer_len)) == 0)
2373 if (xhci->quirks & XHCI_TRUST_TX_LENGTH)
2374 trb_comp_code = COMP_SHORT_TX;
2376 xhci_warn_ratelimited(xhci,
2377 "WARN Successful completion on short TX: needs XHCI_TRUST_TX_LENGTH quirk?\n");
2381 xhci_dbg(xhci, "Stopped on Transfer TRB\n");
2383 case COMP_STOP_INVAL:
2384 xhci_dbg(xhci, "Stopped on No-op or Link TRB\n");
2387 xhci_dbg(xhci, "Stalled endpoint\n");
2388 ep->ep_state |= EP_HALTED;
2392 xhci_warn(xhci, "WARN: TRB error on endpoint\n");
2395 case COMP_SPLIT_ERR:
2397 xhci_dbg(xhci, "Transfer error on endpoint\n");
2401 xhci_dbg(xhci, "Babble error on endpoint\n");
2402 status = -EOVERFLOW;
2405 xhci_warn(xhci, "WARN: HC couldn't access mem fast enough\n");
2409 xhci_warn(xhci, "WARN: bandwidth overrun event on endpoint\n");
2411 case COMP_BUFF_OVER:
2412 xhci_warn(xhci, "WARN: buffer overrun event on endpoint\n");
2416 * When the Isoch ring is empty, the xHC will generate
2417 * a Ring Overrun Event for IN Isoch endpoint or Ring
2418 * Underrun Event for OUT Isoch endpoint.
2420 xhci_dbg(xhci, "underrun event on endpoint\n");
2421 if (!list_empty(&ep_ring->td_list))
2422 xhci_dbg(xhci, "Underrun Event for slot %d ep %d "
2423 "still with TDs queued?\n",
2424 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2428 xhci_dbg(xhci, "overrun event on endpoint\n");
2429 if (!list_empty(&ep_ring->td_list))
2430 xhci_dbg(xhci, "Overrun Event for slot %d ep %d "
2431 "still with TDs queued?\n",
2432 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2436 xhci_warn(xhci, "WARN: detect an incompatible device");
2439 case COMP_MISSED_INT:
2441 * When encounter missed service error, one or more isoc tds
2442 * may be missed by xHC.
2443 * Set skip flag of the ep_ring; Complete the missed tds as
2444 * short transfer when process the ep_ring next time.
2447 xhci_dbg(xhci, "Miss service interval error, set skip flag\n");
2450 if (xhci_is_vendor_info_code(xhci, trb_comp_code)) {
2454 xhci_warn(xhci, "ERROR Unknown event condition, HC probably "
2460 /* This TRB should be in the TD at the head of this ring's
2463 if (list_empty(&ep_ring->td_list)) {
2464 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d "
2465 "with no TDs queued?\n",
2466 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2468 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n",
2469 (le32_to_cpu(event->flags) &
2470 TRB_TYPE_BITMASK)>>10);
2471 xhci_print_trb_offsets(xhci, (union xhci_trb *) event);
2474 xhci_dbg(xhci, "td_list is empty while skip "
2475 "flag set. Clear skip flag.\n");
2481 /* We've skipped all the TDs on the ep ring when ep->skip set */
2482 if (ep->skip && td_num == 0) {
2484 xhci_dbg(xhci, "All tds on the ep_ring skipped. "
2485 "Clear skip flag.\n");
2490 td = list_entry(ep_ring->td_list.next, struct xhci_td, td_list);
2494 /* Is this a TRB in the currently executing TD? */
2495 event_seg = trb_in_td(ep_ring->deq_seg, ep_ring->dequeue,
2496 td->last_trb, event_dma);
2499 * Skip the Force Stopped Event. The event_trb(event_dma) of FSE
2500 * is not in the current TD pointed by ep_ring->dequeue because
2501 * that the hardware dequeue pointer still at the previous TRB
2502 * of the current TD. The previous TRB maybe a Link TD or the
2503 * last TRB of the previous TD. The command completion handle
2504 * will take care the rest.
2506 if (!event_seg && trb_comp_code == COMP_STOP_INVAL) {
2513 !usb_endpoint_xfer_isoc(&td->urb->ep->desc)) {
2514 /* Some host controllers give a spurious
2515 * successful event after a short transfer.
2518 if ((xhci->quirks & XHCI_SPURIOUS_SUCCESS) &&
2519 ep_ring->last_td_was_short) {
2520 ep_ring->last_td_was_short = false;
2524 /* HC is busted, give up! */
2526 "ERROR Transfer event TRB DMA ptr not "
2527 "part of current TD\n");
2531 ret = skip_isoc_td(xhci, td, event, ep, &status);
2534 if (trb_comp_code == COMP_SHORT_TX)
2535 ep_ring->last_td_was_short = true;
2537 ep_ring->last_td_was_short = false;
2540 xhci_dbg(xhci, "Found td. Clear skip flag.\n");
2544 event_trb = &event_seg->trbs[(event_dma - event_seg->dma) /
2545 sizeof(*event_trb)];
2547 * No-op TRB should not trigger interrupts.
2548 * If event_trb is a no-op TRB, it means the
2549 * corresponding TD has been cancelled. Just ignore
2552 if (TRB_TYPE_NOOP_LE32(event_trb->generic.field[3])) {
2554 "event_trb is a no-op TRB. Skip it\n");
2558 /* Now update the urb's actual_length and give back to
2561 if (usb_endpoint_xfer_control(&td->urb->ep->desc))
2562 ret = process_ctrl_td(xhci, td, event_trb, event, ep,
2564 else if (usb_endpoint_xfer_isoc(&td->urb->ep->desc))
2565 ret = process_isoc_td(xhci, td, event_trb, event, ep,
2568 ret = process_bulk_intr_td(xhci, td, event_trb, event,
2573 * Do not update event ring dequeue pointer if ep->skip is set.
2574 * Will roll back to continue process missed tds.
2576 if (trb_comp_code == COMP_MISSED_INT || !ep->skip) {
2577 inc_deq(xhci, xhci->event_ring);
2582 urb_priv = urb->hcpriv;
2583 /* Leave the TD around for the reset endpoint function
2584 * to use(but only if it's not a control endpoint,
2585 * since we already queued the Set TR dequeue pointer
2586 * command for stalled control endpoints).
2588 if (usb_endpoint_xfer_control(&urb->ep->desc) ||
2589 (trb_comp_code != COMP_STALL &&
2590 trb_comp_code != COMP_BABBLE))
2591 xhci_urb_free_priv(xhci, urb_priv);
2595 usb_hcd_unlink_urb_from_ep(bus_to_hcd(urb->dev->bus), urb);
2596 if ((urb->actual_length != urb->transfer_buffer_length &&
2597 (urb->transfer_flags &
2598 URB_SHORT_NOT_OK)) ||
2600 !usb_endpoint_xfer_isoc(&urb->ep->desc)))
2601 xhci_dbg(xhci, "Giveback URB %p, len = %d, "
2602 "expected = %d, status = %d\n",
2603 urb, urb->actual_length,
2604 urb->transfer_buffer_length,
2606 spin_unlock(&xhci->lock);
2607 /* EHCI, UHCI, and OHCI always unconditionally set the
2608 * urb->status of an isochronous endpoint to 0.
2610 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS)
2612 usb_hcd_giveback_urb(bus_to_hcd(urb->dev->bus), urb, status);
2613 spin_lock(&xhci->lock);
2617 * If ep->skip is set, it means there are missed tds on the
2618 * endpoint ring need to take care of.
2619 * Process them as short transfer until reach the td pointed by
2622 } while (ep->skip && trb_comp_code != COMP_MISSED_INT);
2628 * This function handles all OS-owned events on the event ring. It may drop
2629 * xhci->lock between event processing (e.g. to pass up port status changes).
2630 * Returns >0 for "possibly more events to process" (caller should call again),
2631 * otherwise 0 if done. In future, <0 returns should indicate error code.
2633 static int xhci_handle_event(struct xhci_hcd *xhci)
2635 union xhci_trb *event;
2636 int update_ptrs = 1;
2639 if (!xhci->event_ring || !xhci->event_ring->dequeue) {
2640 xhci->error_bitmask |= 1 << 1;
2644 event = xhci->event_ring->dequeue;
2645 /* Does the HC or OS own the TRB? */
2646 if ((le32_to_cpu(event->event_cmd.flags) & TRB_CYCLE) !=
2647 xhci->event_ring->cycle_state) {
2648 xhci->error_bitmask |= 1 << 2;
2653 * Barrier between reading the TRB_CYCLE (valid) flag above and any
2654 * speculative reads of the event's flags/data below.
2657 /* FIXME: Handle more event types. */
2658 switch ((le32_to_cpu(event->event_cmd.flags) & TRB_TYPE_BITMASK)) {
2659 case TRB_TYPE(TRB_COMPLETION):
2660 handle_cmd_completion(xhci, &event->event_cmd);
2662 case TRB_TYPE(TRB_PORT_STATUS):
2663 handle_port_status(xhci, event);
2666 case TRB_TYPE(TRB_TRANSFER):
2667 ret = handle_tx_event(xhci, &event->trans_event);
2669 xhci->error_bitmask |= 1 << 9;
2673 case TRB_TYPE(TRB_DEV_NOTE):
2674 handle_device_notification(xhci, event);
2677 if ((le32_to_cpu(event->event_cmd.flags) & TRB_TYPE_BITMASK) >=
2679 handle_vendor_event(xhci, event);
2681 xhci->error_bitmask |= 1 << 3;
2683 /* Any of the above functions may drop and re-acquire the lock, so check
2684 * to make sure a watchdog timer didn't mark the host as non-responsive.
2686 if (xhci->xhc_state & XHCI_STATE_DYING) {
2687 xhci_dbg(xhci, "xHCI host dying, returning from "
2688 "event handler.\n");
2693 /* Update SW event ring dequeue pointer */
2694 inc_deq(xhci, xhci->event_ring);
2696 /* Are there more items on the event ring? Caller will call us again to
2703 * xHCI spec says we can get an interrupt, and if the HC has an error condition,
2704 * we might get bad data out of the event ring. Section 4.10.2.7 has a list of
2705 * indicators of an event TRB error, but we check the status *first* to be safe.
2707 irqreturn_t xhci_irq(struct usb_hcd *hcd)
2709 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
2711 union xhci_trb *trb;
2713 union xhci_trb *event_ring_deq;
2716 spin_lock(&xhci->lock);
2717 trb = xhci->event_ring->dequeue;
2718 /* Check if the xHC generated the interrupt, or the irq is shared */
2719 status = xhci_readl(xhci, &xhci->op_regs->status);
2720 if (status == 0xffffffff)
2723 if (!(status & STS_EINT)) {
2724 spin_unlock(&xhci->lock);
2727 if (status & STS_FATAL) {
2728 xhci_warn(xhci, "WARNING: Host System Error\n");
2731 spin_unlock(&xhci->lock);
2736 * Clear the op reg interrupt status first,
2737 * so we can receive interrupts from other MSI-X interrupters.
2738 * Write 1 to clear the interrupt status.
2741 xhci_writel(xhci, status, &xhci->op_regs->status);
2742 /* FIXME when MSI-X is supported and there are multiple vectors */
2743 /* Clear the MSI-X event interrupt status */
2747 /* Acknowledge the PCI interrupt */
2748 irq_pending = xhci_readl(xhci, &xhci->ir_set->irq_pending);
2749 irq_pending |= IMAN_IP;
2750 xhci_writel(xhci, irq_pending, &xhci->ir_set->irq_pending);
2753 if (xhci->xhc_state & XHCI_STATE_DYING) {
2754 xhci_dbg(xhci, "xHCI dying, ignoring interrupt. "
2755 "Shouldn't IRQs be disabled?\n");
2756 /* Clear the event handler busy flag (RW1C);
2757 * the event ring should be empty.
2759 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
2760 xhci_write_64(xhci, temp_64 | ERST_EHB,
2761 &xhci->ir_set->erst_dequeue);
2762 spin_unlock(&xhci->lock);
2767 event_ring_deq = xhci->event_ring->dequeue;
2768 /* FIXME this should be a delayed service routine
2769 * that clears the EHB.
2771 while (xhci_handle_event(xhci) > 0) {}
2773 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
2774 /* If necessary, update the HW's version of the event ring deq ptr. */
2775 if (event_ring_deq != xhci->event_ring->dequeue) {
2776 deq = xhci_trb_virt_to_dma(xhci->event_ring->deq_seg,
2777 xhci->event_ring->dequeue);
2779 xhci_warn(xhci, "WARN something wrong with SW event "
2780 "ring dequeue ptr.\n");
2781 /* Update HC event ring dequeue pointer */
2782 temp_64 &= ERST_PTR_MASK;
2783 temp_64 |= ((u64) deq & (u64) ~ERST_PTR_MASK);
2786 /* Clear the event handler busy flag (RW1C); event ring is empty. */
2787 temp_64 |= ERST_EHB;
2788 xhci_write_64(xhci, temp_64, &xhci->ir_set->erst_dequeue);
2790 spin_unlock(&xhci->lock);
2795 irqreturn_t xhci_msi_irq(int irq, struct usb_hcd *hcd)
2797 return xhci_irq(hcd);
2800 /**** Endpoint Ring Operations ****/
2803 * Generic function for queueing a TRB on a ring.
2804 * The caller must have checked to make sure there's room on the ring.
2806 * @more_trbs_coming: Will you enqueue more TRBs before calling
2807 * prepare_transfer()?
2809 static void queue_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
2810 bool more_trbs_coming,
2811 u32 field1, u32 field2, u32 field3, u32 field4)
2813 struct xhci_generic_trb *trb;
2815 trb = &ring->enqueue->generic;
2816 trb->field[0] = cpu_to_le32(field1);
2817 trb->field[1] = cpu_to_le32(field2);
2818 trb->field[2] = cpu_to_le32(field3);
2819 trb->field[3] = cpu_to_le32(field4);
2820 inc_enq(xhci, ring, more_trbs_coming);
2824 * Does various checks on the endpoint ring, and makes it ready to queue num_trbs.
2825 * FIXME allocate segments if the ring is full.
2827 static int prepare_ring(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
2828 u32 ep_state, unsigned int num_trbs, gfp_t mem_flags)
2830 unsigned int num_trbs_needed;
2832 /* Make sure the endpoint has been added to xHC schedule */
2834 case EP_STATE_DISABLED:
2836 * USB core changed config/interfaces without notifying us,
2837 * or hardware is reporting the wrong state.
2839 xhci_warn(xhci, "WARN urb submitted to disabled ep\n");
2841 case EP_STATE_ERROR:
2842 xhci_warn(xhci, "WARN waiting for error on ep to be cleared\n");
2843 /* FIXME event handling code for error needs to clear it */
2844 /* XXX not sure if this should be -ENOENT or not */
2846 case EP_STATE_HALTED:
2847 xhci_dbg(xhci, "WARN halted endpoint, queueing URB anyway.\n");
2848 case EP_STATE_STOPPED:
2849 case EP_STATE_RUNNING:
2852 xhci_err(xhci, "ERROR unknown endpoint state for ep\n");
2854 * FIXME issue Configure Endpoint command to try to get the HC
2855 * back into a known state.
2861 if (room_on_ring(xhci, ep_ring, num_trbs))
2864 if (ep_ring == xhci->cmd_ring) {
2865 xhci_err(xhci, "Do not support expand command ring\n");
2869 xhci_dbg(xhci, "ERROR no room on ep ring, "
2870 "try ring expansion\n");
2871 num_trbs_needed = num_trbs - ep_ring->num_trbs_free;
2872 if (xhci_ring_expansion(xhci, ep_ring, num_trbs_needed,
2874 xhci_err(xhci, "Ring expansion failed\n");
2879 if (enqueue_is_link_trb(ep_ring)) {
2880 struct xhci_ring *ring = ep_ring;
2881 union xhci_trb *next;
2883 next = ring->enqueue;
2885 while (last_trb(xhci, ring, ring->enq_seg, next)) {
2886 /* If we're not dealing with 0.95 hardware or isoc rings
2887 * on AMD 0.96 host, clear the chain bit.
2889 if (!xhci_link_trb_quirk(xhci) &&
2890 !(ring->type == TYPE_ISOC &&
2891 (xhci->quirks & XHCI_AMD_0x96_HOST)))
2892 next->link.control &= cpu_to_le32(~TRB_CHAIN);
2894 next->link.control |= cpu_to_le32(TRB_CHAIN);
2897 next->link.control ^= cpu_to_le32(TRB_CYCLE);
2899 /* Toggle the cycle bit after the last ring segment. */
2900 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
2901 ring->cycle_state = (ring->cycle_state ? 0 : 1);
2903 ring->enq_seg = ring->enq_seg->next;
2904 ring->enqueue = ring->enq_seg->trbs;
2905 next = ring->enqueue;
2912 static int prepare_transfer(struct xhci_hcd *xhci,
2913 struct xhci_virt_device *xdev,
2914 unsigned int ep_index,
2915 unsigned int stream_id,
2916 unsigned int num_trbs,
2918 unsigned int td_index,
2922 struct urb_priv *urb_priv;
2924 struct xhci_ring *ep_ring;
2925 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
2927 ep_ring = xhci_stream_id_to_ring(xdev, ep_index, stream_id);
2929 xhci_dbg(xhci, "Can't prepare ring for bad stream ID %u\n",
2934 ret = prepare_ring(xhci, ep_ring,
2935 le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK,
2936 num_trbs, mem_flags);
2940 urb_priv = urb->hcpriv;
2941 td = urb_priv->td[td_index];
2943 INIT_LIST_HEAD(&td->td_list);
2944 INIT_LIST_HEAD(&td->cancelled_td_list);
2946 if (td_index == 0) {
2947 ret = usb_hcd_link_urb_to_ep(bus_to_hcd(urb->dev->bus), urb);
2953 /* Add this TD to the tail of the endpoint ring's TD list */
2954 list_add_tail(&td->td_list, &ep_ring->td_list);
2955 td->start_seg = ep_ring->enq_seg;
2956 td->first_trb = ep_ring->enqueue;
2958 urb_priv->td[td_index] = td;
2963 static unsigned int count_sg_trbs_needed(struct xhci_hcd *xhci, struct urb *urb)
2965 int num_sgs, num_trbs, running_total, temp, i;
2966 struct scatterlist *sg;
2969 num_sgs = urb->num_mapped_sgs;
2970 temp = urb->transfer_buffer_length;
2973 for_each_sg(urb->sg, sg, num_sgs, i) {
2974 unsigned int len = sg_dma_len(sg);
2976 /* Scatter gather list entries may cross 64KB boundaries */
2977 running_total = TRB_MAX_BUFF_SIZE -
2978 (sg_dma_address(sg) & (TRB_MAX_BUFF_SIZE - 1));
2979 running_total &= TRB_MAX_BUFF_SIZE - 1;
2980 if (running_total != 0)
2983 /* How many more 64KB chunks to transfer, how many more TRBs? */
2984 while (running_total < sg_dma_len(sg) && running_total < temp) {
2986 running_total += TRB_MAX_BUFF_SIZE;
2988 len = min_t(int, len, temp);
2996 static void check_trb_math(struct urb *urb, int num_trbs, int running_total)
2999 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated number of "
3000 "TRBs, %d left\n", __func__,
3001 urb->ep->desc.bEndpointAddress, num_trbs);
3002 if (running_total != urb->transfer_buffer_length)
3003 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated tx length, "
3004 "queued %#x (%d), asked for %#x (%d)\n",
3006 urb->ep->desc.bEndpointAddress,
3007 running_total, running_total,
3008 urb->transfer_buffer_length,
3009 urb->transfer_buffer_length);
3012 static void giveback_first_trb(struct xhci_hcd *xhci, int slot_id,
3013 unsigned int ep_index, unsigned int stream_id, int start_cycle,
3014 struct xhci_generic_trb *start_trb)
3017 * Pass all the TRBs to the hardware at once and make sure this write
3022 start_trb->field[3] |= cpu_to_le32(start_cycle);
3024 start_trb->field[3] &= cpu_to_le32(~TRB_CYCLE);
3025 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, stream_id);
3029 * xHCI uses normal TRBs for both bulk and interrupt. When the interrupt
3030 * endpoint is to be serviced, the xHC will consume (at most) one TD. A TD
3031 * (comprised of sg list entries) can take several service intervals to
3034 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3035 struct urb *urb, int slot_id, unsigned int ep_index)
3037 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci,
3038 xhci->devs[slot_id]->out_ctx, ep_index);
3042 xhci_interval = EP_INTERVAL_TO_UFRAMES(le32_to_cpu(ep_ctx->ep_info));
3043 ep_interval = urb->interval;
3044 /* Convert to microframes */
3045 if (urb->dev->speed == USB_SPEED_LOW ||
3046 urb->dev->speed == USB_SPEED_FULL)
3048 /* FIXME change this to a warning and a suggestion to use the new API
3049 * to set the polling interval (once the API is added).
3051 if (xhci_interval != ep_interval) {
3052 if (printk_ratelimit())
3053 dev_dbg(&urb->dev->dev, "Driver uses different interval"
3054 " (%d microframe%s) than xHCI "
3055 "(%d microframe%s)\n",
3057 ep_interval == 1 ? "" : "s",
3059 xhci_interval == 1 ? "" : "s");
3060 urb->interval = xhci_interval;
3061 /* Convert back to frames for LS/FS devices */
3062 if (urb->dev->speed == USB_SPEED_LOW ||
3063 urb->dev->speed == USB_SPEED_FULL)
3066 return xhci_queue_bulk_tx(xhci, mem_flags, urb, slot_id, ep_index);
3070 * The TD size is the number of bytes remaining in the TD (including this TRB),
3071 * right shifted by 10.
3072 * It must fit in bits 21:17, so it can't be bigger than 31.
3074 static u32 xhci_td_remainder(unsigned int remainder)
3076 u32 max = (1 << (21 - 17 + 1)) - 1;
3078 if ((remainder >> 10) >= max)
3081 return (remainder >> 10) << 17;
3085 * For xHCI 1.0 host controllers, TD size is the number of max packet sized
3086 * packets remaining in the TD (*not* including this TRB).
3088 * Total TD packet count = total_packet_count =
3089 * DIV_ROUND_UP(TD size in bytes / wMaxPacketSize)
3091 * Packets transferred up to and including this TRB = packets_transferred =
3092 * rounddown(total bytes transferred including this TRB / wMaxPacketSize)
3094 * TD size = total_packet_count - packets_transferred
3096 * It must fit in bits 21:17, so it can't be bigger than 31.
3097 * The last TRB in a TD must have the TD size set to zero.
3099 static u32 xhci_v1_0_td_remainder(int running_total, int trb_buff_len,
3100 unsigned int total_packet_count, struct urb *urb,
3101 unsigned int num_trbs_left)
3103 int packets_transferred;
3105 /* One TRB with a zero-length data packet. */
3106 if (num_trbs_left == 0 || (running_total == 0 && trb_buff_len == 0))
3109 /* All the TRB queueing functions don't count the current TRB in
3112 packets_transferred = (running_total + trb_buff_len) /
3113 GET_MAX_PACKET(usb_endpoint_maxp(&urb->ep->desc));
3115 if ((total_packet_count - packets_transferred) > 31)
3117 return (total_packet_count - packets_transferred) << 17;
3120 static int queue_bulk_sg_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3121 struct urb *urb, int slot_id, unsigned int ep_index)
3123 struct xhci_ring *ep_ring;
3124 unsigned int num_trbs;
3125 struct urb_priv *urb_priv;
3127 struct scatterlist *sg;
3129 int trb_buff_len, this_sg_len, running_total;
3130 unsigned int total_packet_count;
3133 bool more_trbs_coming;
3135 struct xhci_generic_trb *start_trb;
3138 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3142 num_trbs = count_sg_trbs_needed(xhci, urb);
3143 num_sgs = urb->num_mapped_sgs;
3144 total_packet_count = DIV_ROUND_UP(urb->transfer_buffer_length,
3145 usb_endpoint_maxp(&urb->ep->desc));
3147 trb_buff_len = prepare_transfer(xhci, xhci->devs[slot_id],
3148 ep_index, urb->stream_id,
3149 num_trbs, urb, 0, mem_flags);
3150 if (trb_buff_len < 0)
3151 return trb_buff_len;
3153 urb_priv = urb->hcpriv;
3154 td = urb_priv->td[0];
3157 * Don't give the first TRB to the hardware (by toggling the cycle bit)
3158 * until we've finished creating all the other TRBs. The ring's cycle
3159 * state may change as we enqueue the other TRBs, so save it too.
3161 start_trb = &ep_ring->enqueue->generic;
3162 start_cycle = ep_ring->cycle_state;
3166 * How much data is in the first TRB?
3168 * There are three forces at work for TRB buffer pointers and lengths:
3169 * 1. We don't want to walk off the end of this sg-list entry buffer.
3170 * 2. The transfer length that the driver requested may be smaller than
3171 * the amount of memory allocated for this scatter-gather list.
3172 * 3. TRBs buffers can't cross 64KB boundaries.
3175 addr = (u64) sg_dma_address(sg);
3176 this_sg_len = sg_dma_len(sg);
3177 trb_buff_len = TRB_MAX_BUFF_SIZE - (addr & (TRB_MAX_BUFF_SIZE - 1));
3178 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
3179 if (trb_buff_len > urb->transfer_buffer_length)
3180 trb_buff_len = urb->transfer_buffer_length;
3183 /* Queue the first TRB, even if it's zero-length */
3186 u32 length_field = 0;
3189 /* Don't change the cycle bit of the first TRB until later */
3192 if (start_cycle == 0)
3195 field |= ep_ring->cycle_state;
3197 /* Chain all the TRBs together; clear the chain bit in the last
3198 * TRB to indicate it's the last TRB in the chain.
3203 /* FIXME - add check for ZERO_PACKET flag before this */
3204 td->last_trb = ep_ring->enqueue;
3208 /* Only set interrupt on short packet for IN endpoints */
3209 if (usb_urb_dir_in(urb))
3212 if (TRB_MAX_BUFF_SIZE -
3213 (addr & (TRB_MAX_BUFF_SIZE - 1)) < trb_buff_len) {
3214 xhci_warn(xhci, "WARN: sg dma xfer crosses 64KB boundaries!\n");
3215 xhci_dbg(xhci, "Next boundary at %#x, end dma = %#x\n",
3216 (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
3217 (unsigned int) addr + trb_buff_len);
3220 /* Set the TRB length, TD size, and interrupter fields. */
3221 if (xhci->hci_version < 0x100) {
3222 remainder = xhci_td_remainder(
3223 urb->transfer_buffer_length -
3226 remainder = xhci_v1_0_td_remainder(running_total,
3227 trb_buff_len, total_packet_count, urb,
3230 length_field = TRB_LEN(trb_buff_len) |
3235 more_trbs_coming = true;
3237 more_trbs_coming = false;
3238 queue_trb(xhci, ep_ring, more_trbs_coming,
3239 lower_32_bits(addr),
3240 upper_32_bits(addr),
3242 field | TRB_TYPE(TRB_NORMAL));
3244 running_total += trb_buff_len;
3246 /* Calculate length for next transfer --
3247 * Are we done queueing all the TRBs for this sg entry?
3249 this_sg_len -= trb_buff_len;
3250 if (this_sg_len == 0) {
3255 addr = (u64) sg_dma_address(sg);
3256 this_sg_len = sg_dma_len(sg);
3258 addr += trb_buff_len;
3261 trb_buff_len = TRB_MAX_BUFF_SIZE -
3262 (addr & (TRB_MAX_BUFF_SIZE - 1));
3263 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
3264 if (running_total + trb_buff_len > urb->transfer_buffer_length)
3266 urb->transfer_buffer_length - running_total;
3267 } while (running_total < urb->transfer_buffer_length);
3269 check_trb_math(urb, num_trbs, running_total);
3270 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3271 start_cycle, start_trb);
3275 /* This is very similar to what ehci-q.c qtd_fill() does */
3276 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3277 struct urb *urb, int slot_id, unsigned int ep_index)
3279 struct xhci_ring *ep_ring;
3280 struct urb_priv *urb_priv;
3283 struct xhci_generic_trb *start_trb;
3285 bool more_trbs_coming;
3287 u32 field, length_field;
3289 int running_total, trb_buff_len, ret;
3290 unsigned int total_packet_count;
3294 return queue_bulk_sg_tx(xhci, mem_flags, urb, slot_id, ep_index);
3296 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3301 /* How much data is (potentially) left before the 64KB boundary? */
3302 running_total = TRB_MAX_BUFF_SIZE -
3303 (urb->transfer_dma & (TRB_MAX_BUFF_SIZE - 1));
3304 running_total &= TRB_MAX_BUFF_SIZE - 1;
3306 /* If there's some data on this 64KB chunk, or we have to send a
3307 * zero-length transfer, we need at least one TRB
3309 if (running_total != 0 || urb->transfer_buffer_length == 0)
3311 /* How many more 64KB chunks to transfer, how many more TRBs? */
3312 while (running_total < urb->transfer_buffer_length) {
3314 running_total += TRB_MAX_BUFF_SIZE;
3316 /* FIXME: this doesn't deal with URB_ZERO_PACKET - need one more */
3318 ret = prepare_transfer(xhci, xhci->devs[slot_id],
3319 ep_index, urb->stream_id,
3320 num_trbs, urb, 0, mem_flags);
3324 urb_priv = urb->hcpriv;
3325 td = urb_priv->td[0];
3328 * Don't give the first TRB to the hardware (by toggling the cycle bit)
3329 * until we've finished creating all the other TRBs. The ring's cycle
3330 * state may change as we enqueue the other TRBs, so save it too.
3332 start_trb = &ep_ring->enqueue->generic;
3333 start_cycle = ep_ring->cycle_state;
3336 total_packet_count = DIV_ROUND_UP(urb->transfer_buffer_length,
3337 usb_endpoint_maxp(&urb->ep->desc));
3338 /* How much data is in the first TRB? */
3339 addr = (u64) urb->transfer_dma;
3340 trb_buff_len = TRB_MAX_BUFF_SIZE -
3341 (urb->transfer_dma & (TRB_MAX_BUFF_SIZE - 1));
3342 if (trb_buff_len > urb->transfer_buffer_length)
3343 trb_buff_len = urb->transfer_buffer_length;
3347 /* Queue the first TRB, even if it's zero-length */
3352 /* Don't change the cycle bit of the first TRB until later */
3355 if (start_cycle == 0)
3358 field |= ep_ring->cycle_state;
3360 /* Chain all the TRBs together; clear the chain bit in the last
3361 * TRB to indicate it's the last TRB in the chain.
3366 /* FIXME - add check for ZERO_PACKET flag before this */
3367 td->last_trb = ep_ring->enqueue;
3371 /* Only set interrupt on short packet for IN endpoints */
3372 if (usb_urb_dir_in(urb))
3375 /* Set the TRB length, TD size, and interrupter fields. */
3376 if (xhci->hci_version < 0x100) {
3377 remainder = xhci_td_remainder(
3378 urb->transfer_buffer_length -
3381 remainder = xhci_v1_0_td_remainder(running_total,
3382 trb_buff_len, total_packet_count, urb,
3385 length_field = TRB_LEN(trb_buff_len) |
3390 more_trbs_coming = true;
3392 more_trbs_coming = false;
3393 queue_trb(xhci, ep_ring, more_trbs_coming,
3394 lower_32_bits(addr),
3395 upper_32_bits(addr),
3397 field | TRB_TYPE(TRB_NORMAL));
3399 running_total += trb_buff_len;
3401 /* Calculate length for next transfer */
3402 addr += trb_buff_len;
3403 trb_buff_len = urb->transfer_buffer_length - running_total;
3404 if (trb_buff_len > TRB_MAX_BUFF_SIZE)
3405 trb_buff_len = TRB_MAX_BUFF_SIZE;
3406 } while (running_total < urb->transfer_buffer_length);
3408 check_trb_math(urb, num_trbs, running_total);
3409 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3410 start_cycle, start_trb);
3414 /* Caller must have locked xhci->lock */
3415 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3416 struct urb *urb, int slot_id, unsigned int ep_index)
3418 struct xhci_ring *ep_ring;
3421 struct usb_ctrlrequest *setup;
3422 struct xhci_generic_trb *start_trb;
3424 u32 field, length_field;
3425 struct urb_priv *urb_priv;
3428 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3433 * Need to copy setup packet into setup TRB, so we can't use the setup
3436 if (!urb->setup_packet)
3439 /* 1 TRB for setup, 1 for status */
3442 * Don't need to check if we need additional event data and normal TRBs,
3443 * since data in control transfers will never get bigger than 16MB
3444 * XXX: can we get a buffer that crosses 64KB boundaries?
3446 if (urb->transfer_buffer_length > 0)
3448 ret = prepare_transfer(xhci, xhci->devs[slot_id],
3449 ep_index, urb->stream_id,
3450 num_trbs, urb, 0, mem_flags);
3454 urb_priv = urb->hcpriv;
3455 td = urb_priv->td[0];
3458 * Don't give the first TRB to the hardware (by toggling the cycle bit)
3459 * until we've finished creating all the other TRBs. The ring's cycle
3460 * state may change as we enqueue the other TRBs, so save it too.
3462 start_trb = &ep_ring->enqueue->generic;
3463 start_cycle = ep_ring->cycle_state;
3465 /* Queue setup TRB - see section 6.4.1.2.1 */
3466 /* FIXME better way to translate setup_packet into two u32 fields? */
3467 setup = (struct usb_ctrlrequest *) urb->setup_packet;
3469 field |= TRB_IDT | TRB_TYPE(TRB_SETUP);
3470 if (start_cycle == 0)
3473 /* xHCI 1.0 6.4.1.2.1: Transfer Type field */
3474 if (xhci->hci_version == 0x100) {
3475 if (urb->transfer_buffer_length > 0) {
3476 if (setup->bRequestType & USB_DIR_IN)
3477 field |= TRB_TX_TYPE(TRB_DATA_IN);
3479 field |= TRB_TX_TYPE(TRB_DATA_OUT);
3483 queue_trb(xhci, ep_ring, true,
3484 setup->bRequestType | setup->bRequest << 8 | le16_to_cpu(setup->wValue) << 16,
3485 le16_to_cpu(setup->wIndex) | le16_to_cpu(setup->wLength) << 16,
3486 TRB_LEN(8) | TRB_INTR_TARGET(0),
3487 /* Immediate data in pointer */
3490 /* If there's data, queue data TRBs */
3491 /* Only set interrupt on short packet for IN endpoints */
3492 if (usb_urb_dir_in(urb))
3493 field = TRB_ISP | TRB_TYPE(TRB_DATA);
3495 field = TRB_TYPE(TRB_DATA);
3497 length_field = TRB_LEN(urb->transfer_buffer_length) |
3498 xhci_td_remainder(urb->transfer_buffer_length) |
3500 if (urb->transfer_buffer_length > 0) {
3501 if (setup->bRequestType & USB_DIR_IN)
3502 field |= TRB_DIR_IN;
3503 queue_trb(xhci, ep_ring, true,
3504 lower_32_bits(urb->transfer_dma),
3505 upper_32_bits(urb->transfer_dma),
3507 field | ep_ring->cycle_state);
3510 /* Save the DMA address of the last TRB in the TD */
3511 td->last_trb = ep_ring->enqueue;
3513 /* Queue status TRB - see Table 7 and sections 4.11.2.2 and 6.4.1.2.3 */
3514 /* If the device sent data, the status stage is an OUT transfer */
3515 if (urb->transfer_buffer_length > 0 && setup->bRequestType & USB_DIR_IN)
3519 queue_trb(xhci, ep_ring, false,
3523 /* Event on completion */
3524 field | TRB_IOC | TRB_TYPE(TRB_STATUS) | ep_ring->cycle_state);
3526 giveback_first_trb(xhci, slot_id, ep_index, 0,
3527 start_cycle, start_trb);
3531 static int count_isoc_trbs_needed(struct xhci_hcd *xhci,
3532 struct urb *urb, int i)
3537 addr = (u64) (urb->transfer_dma + urb->iso_frame_desc[i].offset);
3538 td_len = urb->iso_frame_desc[i].length;
3540 num_trbs = DIV_ROUND_UP(td_len + (addr & (TRB_MAX_BUFF_SIZE - 1)),
3549 * The transfer burst count field of the isochronous TRB defines the number of
3550 * bursts that are required to move all packets in this TD. Only SuperSpeed
3551 * devices can burst up to bMaxBurst number of packets per service interval.
3552 * This field is zero based, meaning a value of zero in the field means one
3553 * burst. Basically, for everything but SuperSpeed devices, this field will be
3554 * zero. Only xHCI 1.0 host controllers support this field.
3556 static unsigned int xhci_get_burst_count(struct xhci_hcd *xhci,
3557 struct usb_device *udev,
3558 struct urb *urb, unsigned int total_packet_count)
3560 unsigned int max_burst;
3562 if (xhci->hci_version < 0x100 || udev->speed != USB_SPEED_SUPER)
3565 max_burst = urb->ep->ss_ep_comp.bMaxBurst;
3566 return roundup(total_packet_count, max_burst + 1) - 1;
3570 * Returns the number of packets in the last "burst" of packets. This field is
3571 * valid for all speeds of devices. USB 2.0 devices can only do one "burst", so
3572 * the last burst packet count is equal to the total number of packets in the
3573 * TD. SuperSpeed endpoints can have up to 3 bursts. All but the last burst
3574 * must contain (bMaxBurst + 1) number of packets, but the last burst can
3575 * contain 1 to (bMaxBurst + 1) packets.
3577 static unsigned int xhci_get_last_burst_packet_count(struct xhci_hcd *xhci,
3578 struct usb_device *udev,
3579 struct urb *urb, unsigned int total_packet_count)
3581 unsigned int max_burst;
3582 unsigned int residue;
3584 if (xhci->hci_version < 0x100)
3587 switch (udev->speed) {
3588 case USB_SPEED_SUPER:
3589 /* bMaxBurst is zero based: 0 means 1 packet per burst */
3590 max_burst = urb->ep->ss_ep_comp.bMaxBurst;
3591 residue = total_packet_count % (max_burst + 1);
3592 /* If residue is zero, the last burst contains (max_burst + 1)
3593 * number of packets, but the TLBPC field is zero-based.
3599 if (total_packet_count == 0)
3601 return total_packet_count - 1;
3605 /* This is for isoc transfer */
3606 static int xhci_queue_isoc_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3607 struct urb *urb, int slot_id, unsigned int ep_index)
3609 struct xhci_ring *ep_ring;
3610 struct urb_priv *urb_priv;
3612 int num_tds, trbs_per_td;
3613 struct xhci_generic_trb *start_trb;
3616 u32 field, length_field;
3617 int running_total, trb_buff_len, td_len, td_remain_len, ret;
3618 u64 start_addr, addr;
3620 bool more_trbs_coming;
3622 ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
3624 num_tds = urb->number_of_packets;
3626 xhci_dbg(xhci, "Isoc URB with zero packets?\n");
3630 start_addr = (u64) urb->transfer_dma;
3631 start_trb = &ep_ring->enqueue->generic;
3632 start_cycle = ep_ring->cycle_state;
3634 urb_priv = urb->hcpriv;
3635 /* Queue the first TRB, even if it's zero-length */
3636 for (i = 0; i < num_tds; i++) {
3637 unsigned int total_packet_count;
3638 unsigned int burst_count;
3639 unsigned int residue;
3643 addr = start_addr + urb->iso_frame_desc[i].offset;
3644 td_len = urb->iso_frame_desc[i].length;
3645 td_remain_len = td_len;
3646 total_packet_count = DIV_ROUND_UP(td_len,
3648 usb_endpoint_maxp(&urb->ep->desc)));
3649 /* A zero-length transfer still involves at least one packet. */
3650 if (total_packet_count == 0)
3651 total_packet_count++;
3652 burst_count = xhci_get_burst_count(xhci, urb->dev, urb,
3653 total_packet_count);
3654 residue = xhci_get_last_burst_packet_count(xhci,
3655 urb->dev, urb, total_packet_count);
3657 trbs_per_td = count_isoc_trbs_needed(xhci, urb, i);
3659 ret = prepare_transfer(xhci, xhci->devs[slot_id], ep_index,
3660 urb->stream_id, trbs_per_td, urb, i, mem_flags);
3667 td = urb_priv->td[i];
3668 for (j = 0; j < trbs_per_td; j++) {
3673 field = TRB_TBC(burst_count) |
3675 /* Queue the isoc TRB */
3676 field |= TRB_TYPE(TRB_ISOC);
3677 /* Assume URB_ISO_ASAP is set */
3680 if (start_cycle == 0)
3683 field |= ep_ring->cycle_state;
3686 /* Queue other normal TRBs */
3687 field |= TRB_TYPE(TRB_NORMAL);
3688 field |= ep_ring->cycle_state;
3691 /* Only set interrupt on short packet for IN EPs */
3692 if (usb_urb_dir_in(urb))
3695 /* Chain all the TRBs together; clear the chain bit in
3696 * the last TRB to indicate it's the last TRB in the
3699 if (j < trbs_per_td - 1) {
3701 more_trbs_coming = true;
3703 td->last_trb = ep_ring->enqueue;
3705 if (xhci->hci_version == 0x100 &&
3708 /* Set BEI bit except for the last td */
3709 if (i < num_tds - 1)
3712 more_trbs_coming = false;
3715 /* Calculate TRB length */
3716 trb_buff_len = TRB_MAX_BUFF_SIZE -
3717 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
3718 if (trb_buff_len > td_remain_len)
3719 trb_buff_len = td_remain_len;
3721 /* Set the TRB length, TD size, & interrupter fields. */
3722 if (xhci->hci_version < 0x100) {
3723 remainder = xhci_td_remainder(
3724 td_len - running_total);
3726 remainder = xhci_v1_0_td_remainder(
3727 running_total, trb_buff_len,
3728 total_packet_count, urb,
3729 (trbs_per_td - j - 1));
3731 length_field = TRB_LEN(trb_buff_len) |
3735 queue_trb(xhci, ep_ring, more_trbs_coming,
3736 lower_32_bits(addr),
3737 upper_32_bits(addr),
3740 running_total += trb_buff_len;
3742 addr += trb_buff_len;
3743 td_remain_len -= trb_buff_len;
3746 /* Check TD length */
3747 if (running_total != td_len) {
3748 xhci_err(xhci, "ISOC TD length unmatch\n");
3754 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs == 0) {
3755 if (xhci->quirks & XHCI_AMD_PLL_FIX)
3756 usb_amd_quirk_pll_disable();
3758 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs++;
3760 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3761 start_cycle, start_trb);
3764 /* Clean up a partially enqueued isoc transfer. */
3766 for (i--; i >= 0; i--)
3767 list_del_init(&urb_priv->td[i]->td_list);
3769 /* Use the first TD as a temporary variable to turn the TDs we've queued
3770 * into No-ops with a software-owned cycle bit. That way the hardware
3771 * won't accidentally start executing bogus TDs when we partially
3772 * overwrite them. td->first_trb and td->start_seg are already set.
3774 urb_priv->td[0]->last_trb = ep_ring->enqueue;
3775 /* Every TRB except the first & last will have its cycle bit flipped. */
3776 td_to_noop(xhci, ep_ring, urb_priv->td[0], true);
3778 /* Reset the ring enqueue back to the first TRB and its cycle bit. */
3779 ep_ring->enqueue = urb_priv->td[0]->first_trb;
3780 ep_ring->enq_seg = urb_priv->td[0]->start_seg;
3781 ep_ring->cycle_state = start_cycle;
3782 ep_ring->num_trbs_free = ep_ring->num_trbs_free_temp;
3783 usb_hcd_unlink_urb_from_ep(bus_to_hcd(urb->dev->bus), urb);
3788 * Check transfer ring to guarantee there is enough room for the urb.
3789 * Update ISO URB start_frame and interval.
3790 * Update interval as xhci_queue_intr_tx does. Just use xhci frame_index to
3791 * update the urb->start_frame by now.
3792 * Always assume URB_ISO_ASAP set, and NEVER use urb->start_frame as input.
3794 int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
3795 struct urb *urb, int slot_id, unsigned int ep_index)
3797 struct xhci_virt_device *xdev;
3798 struct xhci_ring *ep_ring;
3799 struct xhci_ep_ctx *ep_ctx;
3803 int num_tds, num_trbs, i;
3806 xdev = xhci->devs[slot_id];
3807 ep_ring = xdev->eps[ep_index].ring;
3808 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
3811 num_tds = urb->number_of_packets;
3812 for (i = 0; i < num_tds; i++)
3813 num_trbs += count_isoc_trbs_needed(xhci, urb, i);
3815 /* Check the ring to guarantee there is enough room for the whole urb.
3816 * Do not insert any td of the urb to the ring if the check failed.
3818 ret = prepare_ring(xhci, ep_ring, le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK,
3819 num_trbs, mem_flags);
3823 start_frame = xhci_readl(xhci, &xhci->run_regs->microframe_index);
3824 start_frame &= 0x3fff;
3826 urb->start_frame = start_frame;
3827 if (urb->dev->speed == USB_SPEED_LOW ||
3828 urb->dev->speed == USB_SPEED_FULL)
3829 urb->start_frame >>= 3;
3831 xhci_interval = EP_INTERVAL_TO_UFRAMES(le32_to_cpu(ep_ctx->ep_info));
3832 ep_interval = urb->interval;
3833 /* Convert to microframes */
3834 if (urb->dev->speed == USB_SPEED_LOW ||
3835 urb->dev->speed == USB_SPEED_FULL)
3837 /* FIXME change this to a warning and a suggestion to use the new API
3838 * to set the polling interval (once the API is added).
3840 if (xhci_interval != ep_interval) {
3841 if (printk_ratelimit())
3842 dev_dbg(&urb->dev->dev, "Driver uses different interval"
3843 " (%d microframe%s) than xHCI "
3844 "(%d microframe%s)\n",
3846 ep_interval == 1 ? "" : "s",
3848 xhci_interval == 1 ? "" : "s");
3849 urb->interval = xhci_interval;
3850 /* Convert back to frames for LS/FS devices */
3851 if (urb->dev->speed == USB_SPEED_LOW ||
3852 urb->dev->speed == USB_SPEED_FULL)
3855 ep_ring->num_trbs_free_temp = ep_ring->num_trbs_free;
3857 return xhci_queue_isoc_tx(xhci, mem_flags, urb, slot_id, ep_index);
3860 /**** Command Ring Operations ****/
3862 /* Generic function for queueing a command TRB on the command ring.
3863 * Check to make sure there's room on the command ring for one command TRB.
3864 * Also check that there's room reserved for commands that must not fail.
3865 * If this is a command that must not fail, meaning command_must_succeed = TRUE,
3866 * then only check for the number of reserved spots.
3867 * Don't decrement xhci->cmd_ring_reserved_trbs after we've queued the TRB
3868 * because the command event handler may want to resubmit a failed command.
3870 static int queue_command(struct xhci_hcd *xhci, u32 field1, u32 field2,
3871 u32 field3, u32 field4, bool command_must_succeed)
3873 int reserved_trbs = xhci->cmd_ring_reserved_trbs;
3876 if (!command_must_succeed)
3879 ret = prepare_ring(xhci, xhci->cmd_ring, EP_STATE_RUNNING,
3880 reserved_trbs, GFP_ATOMIC);
3882 xhci_err(xhci, "ERR: No room for command on command ring\n");
3883 if (command_must_succeed)
3884 xhci_err(xhci, "ERR: Reserved TRB counting for "
3885 "unfailable commands failed.\n");
3888 queue_trb(xhci, xhci->cmd_ring, false, field1, field2, field3,
3889 field4 | xhci->cmd_ring->cycle_state);
3893 /* Queue a slot enable or disable request on the command ring */
3894 int xhci_queue_slot_control(struct xhci_hcd *xhci, u32 trb_type, u32 slot_id)
3896 return queue_command(xhci, 0, 0, 0,
3897 TRB_TYPE(trb_type) | SLOT_ID_FOR_TRB(slot_id), false);
3900 /* Queue an address device command TRB */
3901 int xhci_queue_address_device(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
3904 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
3905 upper_32_bits(in_ctx_ptr), 0,
3906 TRB_TYPE(TRB_ADDR_DEV) | SLOT_ID_FOR_TRB(slot_id),
3910 int xhci_queue_vendor_command(struct xhci_hcd *xhci,
3911 u32 field1, u32 field2, u32 field3, u32 field4)
3913 return queue_command(xhci, field1, field2, field3, field4, false);
3916 /* Queue a reset device command TRB */
3917 int xhci_queue_reset_device(struct xhci_hcd *xhci, u32 slot_id)
3919 return queue_command(xhci, 0, 0, 0,
3920 TRB_TYPE(TRB_RESET_DEV) | SLOT_ID_FOR_TRB(slot_id),
3924 /* Queue a configure endpoint command TRB */
3925 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
3926 u32 slot_id, bool command_must_succeed)
3928 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
3929 upper_32_bits(in_ctx_ptr), 0,
3930 TRB_TYPE(TRB_CONFIG_EP) | SLOT_ID_FOR_TRB(slot_id),
3931 command_must_succeed);
3934 /* Queue an evaluate context command TRB */
3935 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
3936 u32 slot_id, bool command_must_succeed)
3938 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
3939 upper_32_bits(in_ctx_ptr), 0,
3940 TRB_TYPE(TRB_EVAL_CONTEXT) | SLOT_ID_FOR_TRB(slot_id),
3941 command_must_succeed);
3945 * Suspend is set to indicate "Stop Endpoint Command" is being issued to stop
3946 * activity on an endpoint that is about to be suspended.
3948 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, int slot_id,
3949 unsigned int ep_index, int suspend)
3951 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3952 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3953 u32 type = TRB_TYPE(TRB_STOP_RING);
3954 u32 trb_suspend = SUSPEND_PORT_FOR_TRB(suspend);
3956 return queue_command(xhci, 0, 0, 0,
3957 trb_slot_id | trb_ep_index | type | trb_suspend, false);
3960 /* Set Transfer Ring Dequeue Pointer command.
3961 * This should not be used for endpoints that have streams enabled.
3963 static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
3964 unsigned int ep_index, unsigned int stream_id,
3965 struct xhci_segment *deq_seg,
3966 union xhci_trb *deq_ptr, u32 cycle_state)
3969 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3970 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3971 u32 trb_stream_id = STREAM_ID_FOR_TRB(stream_id);
3972 u32 type = TRB_TYPE(TRB_SET_DEQ);
3973 struct xhci_virt_ep *ep;
3975 addr = xhci_trb_virt_to_dma(deq_seg, deq_ptr);
3977 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
3978 xhci_warn(xhci, "WARN deq seg = %p, deq pt = %p\n",
3982 ep = &xhci->devs[slot_id]->eps[ep_index];
3983 if ((ep->ep_state & SET_DEQ_PENDING)) {
3984 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
3985 xhci_warn(xhci, "A Set TR Deq Ptr command is pending.\n");
3988 ep->queued_deq_seg = deq_seg;
3989 ep->queued_deq_ptr = deq_ptr;
3990 return queue_command(xhci, lower_32_bits(addr) | cycle_state,
3991 upper_32_bits(addr), trb_stream_id,
3992 trb_slot_id | trb_ep_index | type, false);
3995 int xhci_queue_reset_ep(struct xhci_hcd *xhci, int slot_id,
3996 unsigned int ep_index)
3998 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3999 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
4000 u32 type = TRB_TYPE(TRB_RESET_EP);
4002 return queue_command(xhci, 0, 0, 0, trb_slot_id | trb_ep_index | type,