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>
70 #include "xhci-trace.h"
73 * Returns zero if the TRB isn't in this segment, otherwise it returns the DMA
76 dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg,
79 unsigned long segment_offset;
81 if (!seg || !trb || trb < seg->trbs)
84 segment_offset = trb - seg->trbs;
85 if (segment_offset > TRBS_PER_SEGMENT)
87 return seg->dma + (segment_offset * sizeof(*trb));
90 /* Does this link TRB point to the first segment in a ring,
91 * or was the previous TRB the last TRB on the last segment in the ERST?
93 static bool last_trb_on_last_seg(struct xhci_hcd *xhci, struct xhci_ring *ring,
94 struct xhci_segment *seg, union xhci_trb *trb)
96 if (ring == xhci->event_ring)
97 return (trb == &seg->trbs[TRBS_PER_SEGMENT]) &&
98 (seg->next == xhci->event_ring->first_seg);
100 return le32_to_cpu(trb->link.control) & LINK_TOGGLE;
103 /* Is this TRB a link TRB or was the last TRB the last TRB in this event ring
104 * segment? I.e. would the updated event TRB pointer step off the end of the
107 static int last_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
108 struct xhci_segment *seg, union xhci_trb *trb)
110 if (ring == xhci->event_ring)
111 return trb == &seg->trbs[TRBS_PER_SEGMENT];
113 return TRB_TYPE_LINK_LE32(trb->link.control);
116 static int enqueue_is_link_trb(struct xhci_ring *ring)
118 struct xhci_link_trb *link = &ring->enqueue->link;
119 return TRB_TYPE_LINK_LE32(link->control);
122 /* Updates trb to point to the next TRB in the ring, and updates seg if the next
123 * TRB is in a new segment. This does not skip over link TRBs, and it does not
124 * effect the ring dequeue or enqueue pointers.
126 static void next_trb(struct xhci_hcd *xhci,
127 struct xhci_ring *ring,
128 struct xhci_segment **seg,
129 union xhci_trb **trb)
131 if (last_trb(xhci, ring, *seg, *trb)) {
133 *trb = ((*seg)->trbs);
140 * See Cycle bit rules. SW is the consumer for the event ring only.
141 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
143 static void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring)
148 * If this is not event ring, and the dequeue pointer
149 * is not on a link TRB, there is one more usable TRB
151 if (ring->type != TYPE_EVENT &&
152 !last_trb(xhci, ring, ring->deq_seg, ring->dequeue))
153 ring->num_trbs_free++;
157 * Update the dequeue pointer further if that was a link TRB or
158 * we're at the end of an event ring segment (which doesn't have
161 if (last_trb(xhci, ring, ring->deq_seg, ring->dequeue)) {
162 if (ring->type == TYPE_EVENT &&
163 last_trb_on_last_seg(xhci, ring,
164 ring->deq_seg, ring->dequeue)) {
165 ring->cycle_state ^= 1;
167 ring->deq_seg = ring->deq_seg->next;
168 ring->dequeue = ring->deq_seg->trbs;
172 } while (last_trb(xhci, ring, ring->deq_seg, ring->dequeue));
176 * See Cycle bit rules. SW is the consumer for the event ring only.
177 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
179 * If we've just enqueued a TRB that is in the middle of a TD (meaning the
180 * chain bit is set), then set the chain bit in all the following link TRBs.
181 * If we've enqueued the last TRB in a TD, make sure the following link TRBs
182 * have their chain bit cleared (so that each Link TRB is a separate TD).
184 * Section 6.4.4.1 of the 0.95 spec says link TRBs cannot have the chain bit
185 * set, but other sections talk about dealing with the chain bit set. This was
186 * fixed in the 0.96 specification errata, but we have to assume that all 0.95
187 * xHCI hardware can't handle the chain bit being cleared on a link TRB.
189 * @more_trbs_coming: Will you enqueue more TRBs before calling
190 * prepare_transfer()?
192 static void inc_enq(struct xhci_hcd *xhci, struct xhci_ring *ring,
193 bool more_trbs_coming)
196 union xhci_trb *next;
198 chain = le32_to_cpu(ring->enqueue->generic.field[3]) & TRB_CHAIN;
199 /* If this is not event ring, there is one less usable TRB */
200 if (ring->type != TYPE_EVENT &&
201 !last_trb(xhci, ring, ring->enq_seg, ring->enqueue))
202 ring->num_trbs_free--;
203 next = ++(ring->enqueue);
206 /* Update the dequeue pointer further if that was a link TRB or we're at
207 * the end of an event ring segment (which doesn't have link TRBS)
209 while (last_trb(xhci, ring, ring->enq_seg, next)) {
210 if (ring->type != TYPE_EVENT) {
212 * If the caller doesn't plan on enqueueing more
213 * TDs before ringing the doorbell, then we
214 * don't want to give the link TRB to the
215 * hardware just yet. We'll give the link TRB
216 * back in prepare_ring() just before we enqueue
217 * the TD at the top of the ring.
219 if (!chain && !more_trbs_coming)
222 /* If we're not dealing with 0.95 hardware or
223 * isoc rings on AMD 0.96 host,
224 * carry over the chain bit of the previous TRB
225 * (which may mean the chain bit is cleared).
227 if (!(ring->type == TYPE_ISOC &&
228 (xhci->quirks & XHCI_AMD_0x96_HOST))
229 && !xhci_link_trb_quirk(xhci)) {
230 next->link.control &=
231 cpu_to_le32(~TRB_CHAIN);
232 next->link.control |=
235 /* Give this link TRB to the hardware */
237 next->link.control ^= cpu_to_le32(TRB_CYCLE);
239 /* Toggle the cycle bit after the last ring segment. */
240 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
241 ring->cycle_state = (ring->cycle_state ? 0 : 1);
244 ring->enq_seg = ring->enq_seg->next;
245 ring->enqueue = ring->enq_seg->trbs;
246 next = ring->enqueue;
251 * Check to see if there's room to enqueue num_trbs on the ring and make sure
252 * enqueue pointer will not advance into dequeue segment. See rules above.
254 static inline int room_on_ring(struct xhci_hcd *xhci, struct xhci_ring *ring,
255 unsigned int num_trbs)
257 int num_trbs_in_deq_seg;
259 if (ring->num_trbs_free < num_trbs)
262 if (ring->type != TYPE_COMMAND && ring->type != TYPE_EVENT) {
263 num_trbs_in_deq_seg = ring->dequeue - ring->deq_seg->trbs;
264 if (ring->num_trbs_free < num_trbs + num_trbs_in_deq_seg)
271 /* Ring the host controller doorbell after placing a command on the ring */
272 void xhci_ring_cmd_db(struct xhci_hcd *xhci)
274 if (!(xhci->cmd_ring_state & CMD_RING_STATE_RUNNING))
277 xhci_dbg(xhci, "// Ding dong!\n");
278 writel(DB_VALUE_HOST, &xhci->dba->doorbell[0]);
279 /* Flush PCI posted writes */
280 readl(&xhci->dba->doorbell[0]);
283 static int xhci_abort_cmd_ring(struct xhci_hcd *xhci)
288 xhci_dbg(xhci, "Abort command ring\n");
290 temp_64 = xhci_read_64(xhci, &xhci->op_regs->cmd_ring);
291 xhci->cmd_ring_state = CMD_RING_STATE_ABORTED;
292 xhci_write_64(xhci, temp_64 | CMD_RING_ABORT,
293 &xhci->op_regs->cmd_ring);
295 /* Section 4.6.1.2 of xHCI 1.0 spec says software should
296 * time the completion od all xHCI commands, including
297 * the Command Abort operation. If software doesn't see
298 * CRR negated in a timely manner (e.g. longer than 5
299 * seconds), then it should assume that the there are
300 * larger problems with the xHC and assert HCRST.
302 ret = xhci_handshake(xhci, &xhci->op_regs->cmd_ring,
303 CMD_RING_RUNNING, 0, 5 * 1000 * 1000);
305 xhci_err(xhci, "Stopped the command ring failed, "
306 "maybe the host is dead\n");
307 xhci->xhc_state |= XHCI_STATE_DYING;
316 void xhci_ring_ep_doorbell(struct xhci_hcd *xhci,
317 unsigned int slot_id,
318 unsigned int ep_index,
319 unsigned int stream_id)
321 __le32 __iomem *db_addr = &xhci->dba->doorbell[slot_id];
322 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
323 unsigned int ep_state = ep->ep_state;
325 /* Don't ring the doorbell for this endpoint if there are pending
326 * cancellations because we don't want to interrupt processing.
327 * We don't want to restart any stream rings if there's a set dequeue
328 * pointer command pending because the device can choose to start any
329 * stream once the endpoint is on the HW schedule.
331 if ((ep_state & EP_HALT_PENDING) || (ep_state & SET_DEQ_PENDING) ||
332 (ep_state & EP_HALTED))
334 writel(DB_VALUE(ep_index, stream_id), db_addr);
335 /* The CPU has better things to do at this point than wait for a
336 * write-posting flush. It'll get there soon enough.
340 /* Ring the doorbell for any rings with pending URBs */
341 static void ring_doorbell_for_active_rings(struct xhci_hcd *xhci,
342 unsigned int slot_id,
343 unsigned int ep_index)
345 unsigned int stream_id;
346 struct xhci_virt_ep *ep;
348 ep = &xhci->devs[slot_id]->eps[ep_index];
350 /* A ring has pending URBs if its TD list is not empty */
351 if (!(ep->ep_state & EP_HAS_STREAMS)) {
352 if (ep->ring && !(list_empty(&ep->ring->td_list)))
353 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, 0);
357 for (stream_id = 1; stream_id < ep->stream_info->num_streams;
359 struct xhci_stream_info *stream_info = ep->stream_info;
360 if (!list_empty(&stream_info->stream_rings[stream_id]->td_list))
361 xhci_ring_ep_doorbell(xhci, slot_id, ep_index,
366 static struct xhci_ring *xhci_triad_to_transfer_ring(struct xhci_hcd *xhci,
367 unsigned int slot_id, unsigned int ep_index,
368 unsigned int stream_id)
370 struct xhci_virt_ep *ep;
372 ep = &xhci->devs[slot_id]->eps[ep_index];
373 /* Common case: no streams */
374 if (!(ep->ep_state & EP_HAS_STREAMS))
377 if (stream_id == 0) {
379 "WARN: Slot ID %u, ep index %u has streams, "
380 "but URB has no stream ID.\n",
385 if (stream_id < ep->stream_info->num_streams)
386 return ep->stream_info->stream_rings[stream_id];
389 "WARN: Slot ID %u, ep index %u has "
390 "stream IDs 1 to %u allocated, "
391 "but stream ID %u is requested.\n",
393 ep->stream_info->num_streams - 1,
398 /* Get the right ring for the given URB.
399 * If the endpoint supports streams, boundary check the URB's stream ID.
400 * If the endpoint doesn't support streams, return the singular endpoint ring.
402 static struct xhci_ring *xhci_urb_to_transfer_ring(struct xhci_hcd *xhci,
405 return xhci_triad_to_transfer_ring(xhci, urb->dev->slot_id,
406 xhci_get_endpoint_index(&urb->ep->desc), urb->stream_id);
410 * Move the xHC's endpoint ring dequeue pointer past cur_td.
411 * Record the new state of the xHC's endpoint ring dequeue segment,
412 * dequeue pointer, and new consumer cycle state in state.
413 * Update our internal representation of the ring's dequeue pointer.
415 * We do this in three jumps:
416 * - First we update our new ring state to be the same as when the xHC stopped.
417 * - Then we traverse the ring to find the segment that contains
418 * the last TRB in the TD. We toggle the xHC's new cycle state when we pass
419 * any link TRBs with the toggle cycle bit set.
420 * - Finally we move the dequeue state one TRB further, toggling the cycle bit
421 * if we've moved it past a link TRB with the toggle cycle bit set.
423 * Some of the uses of xhci_generic_trb are grotty, but if they're done
424 * with correct __le32 accesses they should work fine. Only users of this are
427 void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
428 unsigned int slot_id, unsigned int ep_index,
429 unsigned int stream_id, struct xhci_td *cur_td,
430 struct xhci_dequeue_state *state)
432 struct xhci_virt_device *dev = xhci->devs[slot_id];
433 struct xhci_virt_ep *ep = &dev->eps[ep_index];
434 struct xhci_ring *ep_ring;
435 struct xhci_segment *new_seg;
436 union xhci_trb *new_deq;
439 bool cycle_found = false;
440 bool td_last_trb_found = false;
442 ep_ring = xhci_triad_to_transfer_ring(xhci, slot_id,
443 ep_index, stream_id);
445 xhci_warn(xhci, "WARN can't find new dequeue state "
446 "for invalid stream ID %u.\n",
451 /* Dig out the cycle state saved by the xHC during the stop ep cmd */
452 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
453 "Finding endpoint context");
454 /* 4.6.9 the css flag is written to the stream context for streams */
455 if (ep->ep_state & EP_HAS_STREAMS) {
456 struct xhci_stream_ctx *ctx =
457 &ep->stream_info->stream_ctx_array[stream_id];
458 hw_dequeue = le64_to_cpu(ctx->stream_ring);
460 struct xhci_ep_ctx *ep_ctx
461 = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
462 hw_dequeue = le64_to_cpu(ep_ctx->deq);
465 new_seg = ep_ring->deq_seg;
466 new_deq = ep_ring->dequeue;
467 state->new_cycle_state = hw_dequeue & 0x1;
470 * We want to find the pointer, segment and cycle state of the new trb
471 * (the one after current TD's last_trb). We know the cycle state at
472 * hw_dequeue, so walk the ring until both hw_dequeue and last_trb are
476 if (!cycle_found && xhci_trb_virt_to_dma(new_seg, new_deq)
477 == (dma_addr_t)(hw_dequeue & ~0xf)) {
479 if (td_last_trb_found)
482 if (new_deq == cur_td->last_trb)
483 td_last_trb_found = true;
486 TRB_TYPE_LINK_LE32(new_deq->generic.field[3]) &&
487 new_deq->generic.field[3] & cpu_to_le32(LINK_TOGGLE))
488 state->new_cycle_state ^= 0x1;
490 next_trb(xhci, ep_ring, &new_seg, &new_deq);
492 /* Search wrapped around, bail out */
493 if (new_deq == ep->ring->dequeue) {
494 xhci_err(xhci, "Error: Failed finding new dequeue state\n");
495 state->new_deq_seg = NULL;
496 state->new_deq_ptr = NULL;
500 } while (!cycle_found || !td_last_trb_found);
502 state->new_deq_seg = new_seg;
503 state->new_deq_ptr = new_deq;
505 /* Don't update the ring cycle state for the producer (us). */
506 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
507 "Cycle state = 0x%x", state->new_cycle_state);
509 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
510 "New dequeue segment = %p (virtual)",
512 addr = xhci_trb_virt_to_dma(state->new_deq_seg, state->new_deq_ptr);
513 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
514 "New dequeue pointer = 0x%llx (DMA)",
515 (unsigned long long) addr);
518 /* flip_cycle means flip the cycle bit of all but the first and last TRB.
519 * (The last TRB actually points to the ring enqueue pointer, which is not part
520 * of this TD.) This is used to remove partially enqueued isoc TDs from a ring.
522 static void td_to_noop(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
523 struct xhci_td *cur_td, bool flip_cycle)
525 struct xhci_segment *cur_seg;
526 union xhci_trb *cur_trb;
528 for (cur_seg = cur_td->start_seg, cur_trb = cur_td->first_trb;
530 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
531 if (TRB_TYPE_LINK_LE32(cur_trb->generic.field[3])) {
532 /* Unchain any chained Link TRBs, but
533 * leave the pointers intact.
535 cur_trb->generic.field[3] &= cpu_to_le32(~TRB_CHAIN);
536 /* Flip the cycle bit (link TRBs can't be the first
540 cur_trb->generic.field[3] ^=
541 cpu_to_le32(TRB_CYCLE);
542 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
543 "Cancel (unchain) link TRB");
544 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
545 "Address = %p (0x%llx dma); "
546 "in seg %p (0x%llx dma)",
548 (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
550 (unsigned long long)cur_seg->dma);
552 cur_trb->generic.field[0] = 0;
553 cur_trb->generic.field[1] = 0;
554 cur_trb->generic.field[2] = 0;
555 /* Preserve only the cycle bit of this TRB */
556 cur_trb->generic.field[3] &= cpu_to_le32(TRB_CYCLE);
557 /* Flip the cycle bit except on the first or last TRB */
558 if (flip_cycle && cur_trb != cur_td->first_trb &&
559 cur_trb != cur_td->last_trb)
560 cur_trb->generic.field[3] ^=
561 cpu_to_le32(TRB_CYCLE);
562 cur_trb->generic.field[3] |= cpu_to_le32(
563 TRB_TYPE(TRB_TR_NOOP));
564 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
565 "TRB to noop at offset 0x%llx",
567 xhci_trb_virt_to_dma(cur_seg, cur_trb));
569 if (cur_trb == cur_td->last_trb)
574 static void xhci_stop_watchdog_timer_in_irq(struct xhci_hcd *xhci,
575 struct xhci_virt_ep *ep)
577 ep->ep_state &= ~EP_HALT_PENDING;
578 /* Can't del_timer_sync in interrupt, so we attempt to cancel. If the
579 * timer is running on another CPU, we don't decrement stop_cmds_pending
580 * (since we didn't successfully stop the watchdog timer).
582 if (del_timer(&ep->stop_cmd_timer))
583 ep->stop_cmds_pending--;
586 /* Must be called with xhci->lock held in interrupt context */
587 static void xhci_giveback_urb_in_irq(struct xhci_hcd *xhci,
588 struct xhci_td *cur_td, int status)
592 struct urb_priv *urb_priv;
595 urb_priv = urb->hcpriv;
597 hcd = bus_to_hcd(urb->dev->bus);
599 /* Only giveback urb when this is the last td in urb */
600 if (urb_priv->td_cnt == urb_priv->length) {
601 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
602 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs--;
603 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs == 0) {
604 if (xhci->quirks & XHCI_AMD_PLL_FIX)
605 usb_amd_quirk_pll_enable();
608 usb_hcd_unlink_urb_from_ep(hcd, urb);
610 spin_unlock(&xhci->lock);
611 usb_hcd_giveback_urb(hcd, urb, status);
612 xhci_urb_free_priv(xhci, urb_priv);
613 spin_lock(&xhci->lock);
618 * When we get a command completion for a Stop Endpoint Command, we need to
619 * unlink any cancelled TDs from the ring. There are two ways to do that:
621 * 1. If the HW was in the middle of processing the TD that needs to be
622 * cancelled, then we must move the ring's dequeue pointer past the last TRB
623 * in the TD with a Set Dequeue Pointer Command.
624 * 2. Otherwise, we turn all the TRBs in the TD into No-op TRBs (with the chain
625 * bit cleared) so that the HW will skip over them.
627 static void xhci_handle_cmd_stop_ep(struct xhci_hcd *xhci, int slot_id,
628 union xhci_trb *trb, struct xhci_event_cmd *event)
630 unsigned int ep_index;
631 struct xhci_ring *ep_ring;
632 struct xhci_virt_ep *ep;
633 struct list_head *entry;
634 struct xhci_td *cur_td = NULL;
635 struct xhci_td *last_unlinked_td;
637 struct xhci_dequeue_state deq_state;
639 if (unlikely(TRB_TO_SUSPEND_PORT(le32_to_cpu(trb->generic.field[3])))) {
640 if (!xhci->devs[slot_id])
641 xhci_warn(xhci, "Stop endpoint command "
642 "completion for disabled slot %u\n",
647 memset(&deq_state, 0, sizeof(deq_state));
648 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
649 ep = &xhci->devs[slot_id]->eps[ep_index];
651 if (list_empty(&ep->cancelled_td_list)) {
652 xhci_stop_watchdog_timer_in_irq(xhci, ep);
653 ep->stopped_td = NULL;
654 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
658 /* Fix up the ep ring first, so HW stops executing cancelled TDs.
659 * We have the xHCI lock, so nothing can modify this list until we drop
660 * it. We're also in the event handler, so we can't get re-interrupted
661 * if another Stop Endpoint command completes
663 list_for_each(entry, &ep->cancelled_td_list) {
664 cur_td = list_entry(entry, struct xhci_td, cancelled_td_list);
665 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
666 "Removing canceled TD starting at 0x%llx (dma).",
667 (unsigned long long)xhci_trb_virt_to_dma(
668 cur_td->start_seg, cur_td->first_trb));
669 ep_ring = xhci_urb_to_transfer_ring(xhci, cur_td->urb);
671 /* This shouldn't happen unless a driver is mucking
672 * with the stream ID after submission. This will
673 * leave the TD on the hardware ring, and the hardware
674 * will try to execute it, and may access a buffer
675 * that has already been freed. In the best case, the
676 * hardware will execute it, and the event handler will
677 * ignore the completion event for that TD, since it was
678 * removed from the td_list for that endpoint. In
679 * short, don't muck with the stream ID after
682 xhci_warn(xhci, "WARN Cancelled URB %p "
683 "has invalid stream ID %u.\n",
685 cur_td->urb->stream_id);
686 goto remove_finished_td;
689 * If we stopped on the TD we need to cancel, then we have to
690 * move the xHC endpoint ring dequeue pointer past this TD.
692 if (cur_td == ep->stopped_td)
693 xhci_find_new_dequeue_state(xhci, slot_id, ep_index,
694 cur_td->urb->stream_id,
697 td_to_noop(xhci, ep_ring, cur_td, false);
700 * The event handler won't see a completion for this TD anymore,
701 * so remove it from the endpoint ring's TD list. Keep it in
702 * the cancelled TD list for URB completion later.
704 list_del_init(&cur_td->td_list);
706 last_unlinked_td = cur_td;
707 xhci_stop_watchdog_timer_in_irq(xhci, ep);
709 /* If necessary, queue a Set Transfer Ring Dequeue Pointer command */
710 if (deq_state.new_deq_ptr && deq_state.new_deq_seg) {
711 xhci_queue_new_dequeue_state(xhci, slot_id, ep_index,
712 ep->stopped_td->urb->stream_id, &deq_state);
713 xhci_ring_cmd_db(xhci);
715 /* Otherwise ring the doorbell(s) to restart queued transfers */
716 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
719 /* Clear stopped_td if endpoint is not halted */
720 if (!(ep->ep_state & EP_HALTED))
721 ep->stopped_td = NULL;
724 * Drop the lock and complete the URBs in the cancelled TD list.
725 * New TDs to be cancelled might be added to the end of the list before
726 * we can complete all the URBs for the TDs we already unlinked.
727 * So stop when we've completed the URB for the last TD we unlinked.
730 cur_td = list_entry(ep->cancelled_td_list.next,
731 struct xhci_td, cancelled_td_list);
732 list_del_init(&cur_td->cancelled_td_list);
734 /* Clean up the cancelled URB */
735 /* Doesn't matter what we pass for status, since the core will
736 * just overwrite it (because the URB has been unlinked).
738 xhci_giveback_urb_in_irq(xhci, cur_td, 0);
740 /* Stop processing the cancelled list if the watchdog timer is
743 if (xhci->xhc_state & XHCI_STATE_DYING)
745 } while (cur_td != last_unlinked_td);
747 /* Return to the event handler with xhci->lock re-acquired */
750 static void xhci_kill_ring_urbs(struct xhci_hcd *xhci, struct xhci_ring *ring)
752 struct xhci_td *cur_td;
754 while (!list_empty(&ring->td_list)) {
755 cur_td = list_first_entry(&ring->td_list,
756 struct xhci_td, td_list);
757 list_del_init(&cur_td->td_list);
758 if (!list_empty(&cur_td->cancelled_td_list))
759 list_del_init(&cur_td->cancelled_td_list);
760 xhci_giveback_urb_in_irq(xhci, cur_td, -ESHUTDOWN);
764 static void xhci_kill_endpoint_urbs(struct xhci_hcd *xhci,
765 int slot_id, int ep_index)
767 struct xhci_td *cur_td;
768 struct xhci_virt_ep *ep;
769 struct xhci_ring *ring;
771 ep = &xhci->devs[slot_id]->eps[ep_index];
772 if ((ep->ep_state & EP_HAS_STREAMS) ||
773 (ep->ep_state & EP_GETTING_NO_STREAMS)) {
776 for (stream_id = 0; stream_id < ep->stream_info->num_streams;
778 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
779 "Killing URBs for slot ID %u, ep index %u, stream %u",
780 slot_id, ep_index, stream_id + 1);
781 xhci_kill_ring_urbs(xhci,
782 ep->stream_info->stream_rings[stream_id]);
788 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
789 "Killing URBs for slot ID %u, ep index %u",
791 xhci_kill_ring_urbs(xhci, ring);
793 while (!list_empty(&ep->cancelled_td_list)) {
794 cur_td = list_first_entry(&ep->cancelled_td_list,
795 struct xhci_td, cancelled_td_list);
796 list_del_init(&cur_td->cancelled_td_list);
797 xhci_giveback_urb_in_irq(xhci, cur_td, -ESHUTDOWN);
801 /* Watchdog timer function for when a stop endpoint command fails to complete.
802 * In this case, we assume the host controller is broken or dying or dead. The
803 * host may still be completing some other events, so we have to be careful to
804 * let the event ring handler and the URB dequeueing/enqueueing functions know
805 * through xhci->state.
807 * The timer may also fire if the host takes a very long time to respond to the
808 * command, and the stop endpoint command completion handler cannot delete the
809 * timer before the timer function is called. Another endpoint cancellation may
810 * sneak in before the timer function can grab the lock, and that may queue
811 * another stop endpoint command and add the timer back. So we cannot use a
812 * simple flag to say whether there is a pending stop endpoint command for a
813 * particular endpoint.
815 * Instead we use a combination of that flag and a counter for the number of
816 * pending stop endpoint commands. If the timer is the tail end of the last
817 * stop endpoint command, and the endpoint's command is still pending, we assume
820 void xhci_stop_endpoint_command_watchdog(unsigned long arg)
822 struct xhci_hcd *xhci;
823 struct xhci_virt_ep *ep;
827 ep = (struct xhci_virt_ep *) arg;
830 spin_lock_irqsave(&xhci->lock, flags);
832 ep->stop_cmds_pending--;
833 if (xhci->xhc_state & XHCI_STATE_DYING) {
834 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
835 "Stop EP timer ran, but another timer marked "
836 "xHCI as DYING, exiting.");
837 spin_unlock_irqrestore(&xhci->lock, flags);
840 if (!(ep->stop_cmds_pending == 0 && (ep->ep_state & EP_HALT_PENDING))) {
841 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
842 "Stop EP timer ran, but no command pending, "
844 spin_unlock_irqrestore(&xhci->lock, flags);
848 xhci_warn(xhci, "xHCI host not responding to stop endpoint command.\n");
849 xhci_warn(xhci, "Assuming host is dying, halting host.\n");
850 /* Oops, HC is dead or dying or at least not responding to the stop
853 xhci->xhc_state |= XHCI_STATE_DYING;
854 /* Disable interrupts from the host controller and start halting it */
856 spin_unlock_irqrestore(&xhci->lock, flags);
858 ret = xhci_halt(xhci);
860 spin_lock_irqsave(&xhci->lock, flags);
862 /* This is bad; the host is not responding to commands and it's
863 * not allowing itself to be halted. At least interrupts are
864 * disabled. If we call usb_hc_died(), it will attempt to
865 * disconnect all device drivers under this host. Those
866 * disconnect() methods will wait for all URBs to be unlinked,
867 * so we must complete them.
869 xhci_warn(xhci, "Non-responsive xHCI host is not halting.\n");
870 xhci_warn(xhci, "Completing active URBs anyway.\n");
871 /* We could turn all TDs on the rings to no-ops. This won't
872 * help if the host has cached part of the ring, and is slow if
873 * we want to preserve the cycle bit. Skip it and hope the host
874 * doesn't touch the memory.
877 for (i = 0; i < MAX_HC_SLOTS; i++) {
880 for (j = 0; j < 31; j++)
881 xhci_kill_endpoint_urbs(xhci, i, j);
883 spin_unlock_irqrestore(&xhci->lock, flags);
884 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
885 "Calling usb_hc_died()");
886 usb_hc_died(xhci_to_hcd(xhci)->primary_hcd);
887 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
888 "xHCI host controller is dead.");
892 static void update_ring_for_set_deq_completion(struct xhci_hcd *xhci,
893 struct xhci_virt_device *dev,
894 struct xhci_ring *ep_ring,
895 unsigned int ep_index)
897 union xhci_trb *dequeue_temp;
898 int num_trbs_free_temp;
901 num_trbs_free_temp = ep_ring->num_trbs_free;
902 dequeue_temp = ep_ring->dequeue;
904 /* If we get two back-to-back stalls, and the first stalled transfer
905 * ends just before a link TRB, the dequeue pointer will be left on
906 * the link TRB by the code in the while loop. So we have to update
907 * the dequeue pointer one segment further, or we'll jump off
908 * the segment into la-la-land.
910 if (last_trb(xhci, ep_ring, ep_ring->deq_seg, ep_ring->dequeue)) {
911 ep_ring->deq_seg = ep_ring->deq_seg->next;
912 ep_ring->dequeue = ep_ring->deq_seg->trbs;
915 while (ep_ring->dequeue != dev->eps[ep_index].queued_deq_ptr) {
916 /* We have more usable TRBs */
917 ep_ring->num_trbs_free++;
919 if (last_trb(xhci, ep_ring, ep_ring->deq_seg,
921 if (ep_ring->dequeue ==
922 dev->eps[ep_index].queued_deq_ptr)
924 ep_ring->deq_seg = ep_ring->deq_seg->next;
925 ep_ring->dequeue = ep_ring->deq_seg->trbs;
927 if (ep_ring->dequeue == dequeue_temp) {
934 xhci_dbg(xhci, "Unable to find new dequeue pointer\n");
935 ep_ring->num_trbs_free = num_trbs_free_temp;
940 * When we get a completion for a Set Transfer Ring Dequeue Pointer command,
941 * we need to clear the set deq pending flag in the endpoint ring state, so that
942 * the TD queueing code can ring the doorbell again. We also need to ring the
943 * endpoint doorbell to restart the ring, but only if there aren't more
944 * cancellations pending.
946 static void xhci_handle_cmd_set_deq(struct xhci_hcd *xhci, int slot_id,
947 union xhci_trb *trb, u32 cmd_comp_code)
949 unsigned int ep_index;
950 unsigned int stream_id;
951 struct xhci_ring *ep_ring;
952 struct xhci_virt_device *dev;
953 struct xhci_virt_ep *ep;
954 struct xhci_ep_ctx *ep_ctx;
955 struct xhci_slot_ctx *slot_ctx;
957 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
958 stream_id = TRB_TO_STREAM_ID(le32_to_cpu(trb->generic.field[2]));
959 dev = xhci->devs[slot_id];
960 ep = &dev->eps[ep_index];
962 ep_ring = xhci_stream_id_to_ring(dev, ep_index, stream_id);
964 xhci_warn(xhci, "WARN Set TR deq ptr command for freed stream ID %u\n",
966 /* XXX: Harmless??? */
970 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
971 slot_ctx = xhci_get_slot_ctx(xhci, dev->out_ctx);
973 if (cmd_comp_code != COMP_SUCCESS) {
974 unsigned int ep_state;
975 unsigned int slot_state;
977 switch (cmd_comp_code) {
979 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd invalid because of stream ID configuration\n");
982 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed due to incorrect slot or ep state.\n");
983 ep_state = le32_to_cpu(ep_ctx->ep_info);
984 ep_state &= EP_STATE_MASK;
985 slot_state = le32_to_cpu(slot_ctx->dev_state);
986 slot_state = GET_SLOT_STATE(slot_state);
987 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
988 "Slot state = %u, EP state = %u",
989 slot_state, ep_state);
992 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed because slot %u was not enabled.\n",
996 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd with unknown completion code of %u.\n",
1000 /* OK what do we do now? The endpoint state is hosed, and we
1001 * should never get to this point if the synchronization between
1002 * queueing, and endpoint state are correct. This might happen
1003 * if the device gets disconnected after we've finished
1004 * cancelling URBs, which might not be an error...
1008 /* 4.6.10 deq ptr is written to the stream ctx for streams */
1009 if (ep->ep_state & EP_HAS_STREAMS) {
1010 struct xhci_stream_ctx *ctx =
1011 &ep->stream_info->stream_ctx_array[stream_id];
1012 deq = le64_to_cpu(ctx->stream_ring) & SCTX_DEQ_MASK;
1014 deq = le64_to_cpu(ep_ctx->deq) & ~EP_CTX_CYCLE_MASK;
1016 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
1017 "Successful Set TR Deq Ptr cmd, deq = @%08llx", deq);
1018 if (xhci_trb_virt_to_dma(ep->queued_deq_seg,
1019 ep->queued_deq_ptr) == deq) {
1020 /* Update the ring's dequeue segment and dequeue pointer
1021 * to reflect the new position.
1023 update_ring_for_set_deq_completion(xhci, dev,
1026 xhci_warn(xhci, "Mismatch between completed Set TR Deq Ptr command & xHCI internal state.\n");
1027 xhci_warn(xhci, "ep deq seg = %p, deq ptr = %p\n",
1028 ep->queued_deq_seg, ep->queued_deq_ptr);
1033 dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
1034 dev->eps[ep_index].queued_deq_seg = NULL;
1035 dev->eps[ep_index].queued_deq_ptr = NULL;
1036 /* Restart any rings with pending URBs */
1037 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1040 static void xhci_handle_cmd_reset_ep(struct xhci_hcd *xhci, int slot_id,
1041 union xhci_trb *trb, u32 cmd_comp_code)
1043 unsigned int ep_index;
1045 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
1046 /* This command will only fail if the endpoint wasn't halted,
1047 * but we don't care.
1049 xhci_dbg_trace(xhci, trace_xhci_dbg_reset_ep,
1050 "Ignoring reset ep completion code of %u", cmd_comp_code);
1052 /* HW with the reset endpoint quirk needs to have a configure endpoint
1053 * command complete before the endpoint can be used. Queue that here
1054 * because the HW can't handle two commands being queued in a row.
1056 if (xhci->quirks & XHCI_RESET_EP_QUIRK) {
1057 struct xhci_command *command;
1058 command = xhci_alloc_command(xhci, false, false, GFP_ATOMIC);
1060 xhci_warn(xhci, "WARN Cannot submit cfg ep: ENOMEM\n");
1063 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
1064 "Queueing configure endpoint command");
1065 xhci_queue_configure_endpoint(xhci, command,
1066 xhci->devs[slot_id]->in_ctx->dma, slot_id,
1068 xhci_ring_cmd_db(xhci);
1070 /* Clear our internal halted state */
1071 xhci->devs[slot_id]->eps[ep_index].ep_state &= ~EP_HALTED;
1075 static void xhci_handle_cmd_enable_slot(struct xhci_hcd *xhci, int slot_id,
1078 if (cmd_comp_code == COMP_SUCCESS)
1079 xhci->slot_id = slot_id;
1084 static void xhci_handle_cmd_disable_slot(struct xhci_hcd *xhci, int slot_id)
1086 struct xhci_virt_device *virt_dev;
1088 virt_dev = xhci->devs[slot_id];
1091 if (xhci->quirks & XHCI_EP_LIMIT_QUIRK)
1092 /* Delete default control endpoint resources */
1093 xhci_free_device_endpoint_resources(xhci, virt_dev, true);
1094 xhci_free_virt_device(xhci, slot_id);
1097 static void xhci_handle_cmd_config_ep(struct xhci_hcd *xhci, int slot_id,
1098 struct xhci_event_cmd *event, u32 cmd_comp_code)
1100 struct xhci_virt_device *virt_dev;
1101 struct xhci_input_control_ctx *ctrl_ctx;
1102 unsigned int ep_index;
1103 unsigned int ep_state;
1104 u32 add_flags, drop_flags;
1107 * Configure endpoint commands can come from the USB core
1108 * configuration or alt setting changes, or because the HW
1109 * needed an extra configure endpoint command after a reset
1110 * endpoint command or streams were being configured.
1111 * If the command was for a halted endpoint, the xHCI driver
1112 * is not waiting on the configure endpoint command.
1114 virt_dev = xhci->devs[slot_id];
1115 ctrl_ctx = xhci_get_input_control_ctx(xhci, virt_dev->in_ctx);
1117 xhci_warn(xhci, "Could not get input context, bad type.\n");
1121 add_flags = le32_to_cpu(ctrl_ctx->add_flags);
1122 drop_flags = le32_to_cpu(ctrl_ctx->drop_flags);
1123 /* Input ctx add_flags are the endpoint index plus one */
1124 ep_index = xhci_last_valid_endpoint(add_flags) - 1;
1126 /* A usb_set_interface() call directly after clearing a halted
1127 * condition may race on this quirky hardware. Not worth
1128 * worrying about, since this is prototype hardware. Not sure
1129 * if this will work for streams, but streams support was
1130 * untested on this prototype.
1132 if (xhci->quirks & XHCI_RESET_EP_QUIRK &&
1133 ep_index != (unsigned int) -1 &&
1134 add_flags - SLOT_FLAG == drop_flags) {
1135 ep_state = virt_dev->eps[ep_index].ep_state;
1136 if (!(ep_state & EP_HALTED))
1138 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
1139 "Completed config ep cmd - "
1140 "last ep index = %d, state = %d",
1141 ep_index, ep_state);
1142 /* Clear internal halted state and restart ring(s) */
1143 virt_dev->eps[ep_index].ep_state &= ~EP_HALTED;
1144 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1150 static void xhci_handle_cmd_reset_dev(struct xhci_hcd *xhci, int slot_id,
1151 struct xhci_event_cmd *event)
1153 xhci_dbg(xhci, "Completed reset device command.\n");
1154 if (!xhci->devs[slot_id])
1155 xhci_warn(xhci, "Reset device command completion "
1156 "for disabled slot %u\n", slot_id);
1159 static void xhci_handle_cmd_nec_get_fw(struct xhci_hcd *xhci,
1160 struct xhci_event_cmd *event)
1162 if (!(xhci->quirks & XHCI_NEC_HOST)) {
1163 xhci->error_bitmask |= 1 << 6;
1166 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
1167 "NEC firmware version %2x.%02x",
1168 NEC_FW_MAJOR(le32_to_cpu(event->status)),
1169 NEC_FW_MINOR(le32_to_cpu(event->status)));
1172 static void xhci_complete_del_and_free_cmd(struct xhci_command *cmd, u32 status)
1174 list_del(&cmd->cmd_list);
1176 if (cmd->completion) {
1177 cmd->status = status;
1178 complete(cmd->completion);
1184 void xhci_cleanup_command_queue(struct xhci_hcd *xhci)
1186 struct xhci_command *cur_cmd, *tmp_cmd;
1187 list_for_each_entry_safe(cur_cmd, tmp_cmd, &xhci->cmd_list, cmd_list)
1188 xhci_complete_del_and_free_cmd(cur_cmd, COMP_CMD_ABORT);
1192 * Turn all commands on command ring with status set to "aborted" to no-op trbs.
1193 * If there are other commands waiting then restart the ring and kick the timer.
1194 * This must be called with command ring stopped and xhci->lock held.
1196 static void xhci_handle_stopped_cmd_ring(struct xhci_hcd *xhci,
1197 struct xhci_command *cur_cmd)
1199 struct xhci_command *i_cmd, *tmp_cmd;
1202 /* Turn all aborted commands in list to no-ops, then restart */
1203 list_for_each_entry_safe(i_cmd, tmp_cmd, &xhci->cmd_list,
1206 if (i_cmd->status != COMP_CMD_ABORT)
1209 i_cmd->status = COMP_CMD_STOP;
1211 xhci_dbg(xhci, "Turn aborted command %p to no-op\n",
1212 i_cmd->command_trb);
1213 /* get cycle state from the original cmd trb */
1214 cycle_state = le32_to_cpu(
1215 i_cmd->command_trb->generic.field[3]) & TRB_CYCLE;
1216 /* modify the command trb to no-op command */
1217 i_cmd->command_trb->generic.field[0] = 0;
1218 i_cmd->command_trb->generic.field[1] = 0;
1219 i_cmd->command_trb->generic.field[2] = 0;
1220 i_cmd->command_trb->generic.field[3] = cpu_to_le32(
1221 TRB_TYPE(TRB_CMD_NOOP) | cycle_state);
1224 * caller waiting for completion is called when command
1225 * completion event is received for these no-op commands
1229 xhci->cmd_ring_state = CMD_RING_STATE_RUNNING;
1231 /* ring command ring doorbell to restart the command ring */
1232 if ((xhci->cmd_ring->dequeue != xhci->cmd_ring->enqueue) &&
1233 !(xhci->xhc_state & XHCI_STATE_DYING)) {
1234 xhci->current_cmd = cur_cmd;
1235 mod_timer(&xhci->cmd_timer, jiffies + XHCI_CMD_DEFAULT_TIMEOUT);
1236 xhci_ring_cmd_db(xhci);
1242 void xhci_handle_command_timeout(unsigned long data)
1244 struct xhci_hcd *xhci;
1246 unsigned long flags;
1248 struct xhci_command *cur_cmd = NULL;
1249 xhci = (struct xhci_hcd *) data;
1251 /* mark this command to be cancelled */
1252 spin_lock_irqsave(&xhci->lock, flags);
1253 if (xhci->current_cmd) {
1254 cur_cmd = xhci->current_cmd;
1255 cur_cmd->status = COMP_CMD_ABORT;
1259 /* Make sure command ring is running before aborting it */
1260 hw_ring_state = xhci_read_64(xhci, &xhci->op_regs->cmd_ring);
1261 if ((xhci->cmd_ring_state & CMD_RING_STATE_RUNNING) &&
1262 (hw_ring_state & CMD_RING_RUNNING)) {
1264 spin_unlock_irqrestore(&xhci->lock, flags);
1265 xhci_dbg(xhci, "Command timeout\n");
1266 ret = xhci_abort_cmd_ring(xhci);
1267 if (unlikely(ret == -ESHUTDOWN)) {
1268 xhci_err(xhci, "Abort command ring failed\n");
1269 xhci_cleanup_command_queue(xhci);
1270 usb_hc_died(xhci_to_hcd(xhci)->primary_hcd);
1271 xhci_dbg(xhci, "xHCI host controller is dead.\n");
1275 /* command timeout on stopped ring, ring can't be aborted */
1276 xhci_dbg(xhci, "Command timeout on stopped ring\n");
1277 xhci_handle_stopped_cmd_ring(xhci, xhci->current_cmd);
1278 spin_unlock_irqrestore(&xhci->lock, flags);
1282 static void handle_cmd_completion(struct xhci_hcd *xhci,
1283 struct xhci_event_cmd *event)
1285 int slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1287 dma_addr_t cmd_dequeue_dma;
1289 union xhci_trb *cmd_trb;
1290 struct xhci_command *cmd;
1293 cmd_dma = le64_to_cpu(event->cmd_trb);
1294 cmd_trb = xhci->cmd_ring->dequeue;
1295 cmd_dequeue_dma = xhci_trb_virt_to_dma(xhci->cmd_ring->deq_seg,
1297 /* Is the command ring deq ptr out of sync with the deq seg ptr? */
1298 if (cmd_dequeue_dma == 0) {
1299 xhci->error_bitmask |= 1 << 4;
1302 /* Does the DMA address match our internal dequeue pointer address? */
1303 if (cmd_dma != (u64) cmd_dequeue_dma) {
1304 xhci->error_bitmask |= 1 << 5;
1308 cmd = list_entry(xhci->cmd_list.next, struct xhci_command, cmd_list);
1310 if (cmd->command_trb != xhci->cmd_ring->dequeue) {
1312 "Command completion event does not match command\n");
1316 del_timer(&xhci->cmd_timer);
1318 trace_xhci_cmd_completion(cmd_trb, (struct xhci_generic_trb *) event);
1320 cmd_comp_code = GET_COMP_CODE(le32_to_cpu(event->status));
1322 /* If CMD ring stopped we own the trbs between enqueue and dequeue */
1323 if (cmd_comp_code == COMP_CMD_STOP) {
1324 xhci_handle_stopped_cmd_ring(xhci, cmd);
1328 * Host aborted the command ring, check if the current command was
1329 * supposed to be aborted, otherwise continue normally.
1330 * The command ring is stopped now, but the xHC will issue a Command
1331 * Ring Stopped event which will cause us to restart it.
1333 if (cmd_comp_code == COMP_CMD_ABORT) {
1334 xhci->cmd_ring_state = CMD_RING_STATE_STOPPED;
1335 if (cmd->status == COMP_CMD_ABORT)
1339 cmd_type = TRB_FIELD_TO_TYPE(le32_to_cpu(cmd_trb->generic.field[3]));
1341 case TRB_ENABLE_SLOT:
1342 xhci_handle_cmd_enable_slot(xhci, slot_id, cmd_comp_code);
1344 case TRB_DISABLE_SLOT:
1345 xhci_handle_cmd_disable_slot(xhci, slot_id);
1348 if (!cmd->completion)
1349 xhci_handle_cmd_config_ep(xhci, slot_id, event,
1352 case TRB_EVAL_CONTEXT:
1357 WARN_ON(slot_id != TRB_TO_SLOT_ID(
1358 le32_to_cpu(cmd_trb->generic.field[3])));
1359 xhci_handle_cmd_stop_ep(xhci, slot_id, cmd_trb, event);
1362 WARN_ON(slot_id != TRB_TO_SLOT_ID(
1363 le32_to_cpu(cmd_trb->generic.field[3])));
1364 xhci_handle_cmd_set_deq(xhci, slot_id, cmd_trb, cmd_comp_code);
1367 /* Is this an aborted command turned to NO-OP? */
1368 if (cmd->status == COMP_CMD_STOP)
1369 cmd_comp_code = COMP_CMD_STOP;
1372 WARN_ON(slot_id != TRB_TO_SLOT_ID(
1373 le32_to_cpu(cmd_trb->generic.field[3])));
1374 xhci_handle_cmd_reset_ep(xhci, slot_id, cmd_trb, cmd_comp_code);
1377 /* SLOT_ID field in reset device cmd completion event TRB is 0.
1378 * Use the SLOT_ID from the command TRB instead (xhci 4.6.11)
1380 slot_id = TRB_TO_SLOT_ID(
1381 le32_to_cpu(cmd_trb->generic.field[3]));
1382 xhci_handle_cmd_reset_dev(xhci, slot_id, event);
1384 case TRB_NEC_GET_FW:
1385 xhci_handle_cmd_nec_get_fw(xhci, event);
1388 /* Skip over unknown commands on the event ring */
1389 xhci->error_bitmask |= 1 << 6;
1393 /* restart timer if this wasn't the last command */
1394 if (cmd->cmd_list.next != &xhci->cmd_list) {
1395 xhci->current_cmd = list_entry(cmd->cmd_list.next,
1396 struct xhci_command, cmd_list);
1397 mod_timer(&xhci->cmd_timer, jiffies + XHCI_CMD_DEFAULT_TIMEOUT);
1401 xhci_complete_del_and_free_cmd(cmd, cmd_comp_code);
1403 inc_deq(xhci, xhci->cmd_ring);
1406 static void handle_vendor_event(struct xhci_hcd *xhci,
1407 union xhci_trb *event)
1411 trb_type = TRB_FIELD_TO_TYPE(le32_to_cpu(event->generic.field[3]));
1412 xhci_dbg(xhci, "Vendor specific event TRB type = %u\n", trb_type);
1413 if (trb_type == TRB_NEC_CMD_COMP && (xhci->quirks & XHCI_NEC_HOST))
1414 handle_cmd_completion(xhci, &event->event_cmd);
1417 /* @port_id: the one-based port ID from the hardware (indexed from array of all
1418 * port registers -- USB 3.0 and USB 2.0).
1420 * Returns a zero-based port number, which is suitable for indexing into each of
1421 * the split roothubs' port arrays and bus state arrays.
1422 * Add one to it in order to call xhci_find_slot_id_by_port.
1424 static unsigned int find_faked_portnum_from_hw_portnum(struct usb_hcd *hcd,
1425 struct xhci_hcd *xhci, u32 port_id)
1428 unsigned int num_similar_speed_ports = 0;
1430 /* port_id from the hardware is 1-based, but port_array[], usb3_ports[],
1431 * and usb2_ports are 0-based indexes. Count the number of similar
1432 * speed ports, up to 1 port before this port.
1434 for (i = 0; i < (port_id - 1); i++) {
1435 u8 port_speed = xhci->port_array[i];
1438 * Skip ports that don't have known speeds, or have duplicate
1439 * Extended Capabilities port speed entries.
1441 if (port_speed == 0 || port_speed == DUPLICATE_ENTRY)
1445 * USB 3.0 ports are always under a USB 3.0 hub. USB 2.0 and
1446 * 1.1 ports are under the USB 2.0 hub. If the port speed
1447 * matches the device speed, it's a similar speed port.
1449 if ((port_speed == 0x03) == (hcd->speed == HCD_USB3))
1450 num_similar_speed_ports++;
1452 return num_similar_speed_ports;
1455 static void handle_device_notification(struct xhci_hcd *xhci,
1456 union xhci_trb *event)
1459 struct usb_device *udev;
1461 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->generic.field[3]));
1462 if (!xhci->devs[slot_id]) {
1463 xhci_warn(xhci, "Device Notification event for "
1464 "unused slot %u\n", slot_id);
1468 xhci_dbg(xhci, "Device Wake Notification event for slot ID %u\n",
1470 udev = xhci->devs[slot_id]->udev;
1471 if (udev && udev->parent)
1472 usb_wakeup_notification(udev->parent, udev->portnum);
1475 static void handle_port_status(struct xhci_hcd *xhci,
1476 union xhci_trb *event)
1478 struct usb_hcd *hcd;
1483 unsigned int faked_port_index;
1485 struct xhci_bus_state *bus_state;
1486 __le32 __iomem **port_array;
1487 bool bogus_port_status = false;
1489 /* Port status change events always have a successful completion code */
1490 if (GET_COMP_CODE(le32_to_cpu(event->generic.field[2])) != COMP_SUCCESS) {
1491 xhci_warn(xhci, "WARN: xHC returned failed port status event\n");
1492 xhci->error_bitmask |= 1 << 8;
1494 port_id = GET_PORT_ID(le32_to_cpu(event->generic.field[0]));
1495 xhci_dbg(xhci, "Port Status Change Event for port %d\n", port_id);
1497 max_ports = HCS_MAX_PORTS(xhci->hcs_params1);
1498 if ((port_id <= 0) || (port_id > max_ports)) {
1499 xhci_warn(xhci, "Invalid port id %d\n", port_id);
1500 inc_deq(xhci, xhci->event_ring);
1504 /* Figure out which usb_hcd this port is attached to:
1505 * is it a USB 3.0 port or a USB 2.0/1.1 port?
1507 major_revision = xhci->port_array[port_id - 1];
1509 /* Find the right roothub. */
1510 hcd = xhci_to_hcd(xhci);
1511 if ((major_revision == 0x03) != (hcd->speed == HCD_USB3))
1512 hcd = xhci->shared_hcd;
1514 if (major_revision == 0) {
1515 xhci_warn(xhci, "Event for port %u not in "
1516 "Extended Capabilities, ignoring.\n",
1518 bogus_port_status = true;
1521 if (major_revision == DUPLICATE_ENTRY) {
1522 xhci_warn(xhci, "Event for port %u duplicated in"
1523 "Extended Capabilities, ignoring.\n",
1525 bogus_port_status = true;
1530 * Hardware port IDs reported by a Port Status Change Event include USB
1531 * 3.0 and USB 2.0 ports. We want to check if the port has reported a
1532 * resume event, but we first need to translate the hardware port ID
1533 * into the index into the ports on the correct split roothub, and the
1534 * correct bus_state structure.
1536 bus_state = &xhci->bus_state[hcd_index(hcd)];
1537 if (hcd->speed == HCD_USB3)
1538 port_array = xhci->usb3_ports;
1540 port_array = xhci->usb2_ports;
1541 /* Find the faked port hub number */
1542 faked_port_index = find_faked_portnum_from_hw_portnum(hcd, xhci,
1545 temp = readl(port_array[faked_port_index]);
1546 if (hcd->state == HC_STATE_SUSPENDED) {
1547 xhci_dbg(xhci, "resume root hub\n");
1548 usb_hcd_resume_root_hub(hcd);
1551 if ((temp & PORT_PLC) && (temp & PORT_PLS_MASK) == XDEV_RESUME) {
1552 xhci_dbg(xhci, "port resume event for port %d\n", port_id);
1554 temp1 = readl(&xhci->op_regs->command);
1555 if (!(temp1 & CMD_RUN)) {
1556 xhci_warn(xhci, "xHC is not running.\n");
1560 if (DEV_SUPERSPEED(temp)) {
1561 xhci_dbg(xhci, "remote wake SS port %d\n", port_id);
1562 /* Set a flag to say the port signaled remote wakeup,
1563 * so we can tell the difference between the end of
1564 * device and host initiated resume.
1566 bus_state->port_remote_wakeup |= 1 << faked_port_index;
1567 xhci_test_and_clear_bit(xhci, port_array,
1568 faked_port_index, PORT_PLC);
1569 xhci_set_link_state(xhci, port_array, faked_port_index,
1571 /* Need to wait until the next link state change
1572 * indicates the device is actually in U0.
1574 bogus_port_status = true;
1577 xhci_dbg(xhci, "resume HS port %d\n", port_id);
1578 bus_state->resume_done[faked_port_index] = jiffies +
1579 msecs_to_jiffies(20);
1580 set_bit(faked_port_index, &bus_state->resuming_ports);
1581 mod_timer(&hcd->rh_timer,
1582 bus_state->resume_done[faked_port_index]);
1583 /* Do the rest in GetPortStatus */
1587 if ((temp & PORT_PLC) && (temp & PORT_PLS_MASK) == XDEV_U0 &&
1588 DEV_SUPERSPEED(temp)) {
1589 xhci_dbg(xhci, "resume SS port %d finished\n", port_id);
1590 /* We've just brought the device into U0 through either the
1591 * Resume state after a device remote wakeup, or through the
1592 * U3Exit state after a host-initiated resume. If it's a device
1593 * initiated remote wake, don't pass up the link state change,
1594 * so the roothub behavior is consistent with external
1595 * USB 3.0 hub behavior.
1597 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1598 faked_port_index + 1);
1599 if (slot_id && xhci->devs[slot_id])
1600 xhci_ring_device(xhci, slot_id);
1601 if (bus_state->port_remote_wakeup & (1 << faked_port_index)) {
1602 bus_state->port_remote_wakeup &=
1603 ~(1 << faked_port_index);
1604 xhci_test_and_clear_bit(xhci, port_array,
1605 faked_port_index, PORT_PLC);
1606 usb_wakeup_notification(hcd->self.root_hub,
1607 faked_port_index + 1);
1608 bogus_port_status = true;
1614 * Check to see if xhci-hub.c is waiting on RExit to U0 transition (or
1615 * RExit to a disconnect state). If so, let the the driver know it's
1616 * out of the RExit state.
1618 if (!DEV_SUPERSPEED(temp) &&
1619 test_and_clear_bit(faked_port_index,
1620 &bus_state->rexit_ports)) {
1621 complete(&bus_state->rexit_done[faked_port_index]);
1622 bogus_port_status = true;
1626 if (hcd->speed != HCD_USB3)
1627 xhci_test_and_clear_bit(xhci, port_array, faked_port_index,
1631 /* Update event ring dequeue pointer before dropping the lock */
1632 inc_deq(xhci, xhci->event_ring);
1634 /* Don't make the USB core poll the roothub if we got a bad port status
1635 * change event. Besides, at that point we can't tell which roothub
1636 * (USB 2.0 or USB 3.0) to kick.
1638 if (bogus_port_status)
1642 * xHCI port-status-change events occur when the "or" of all the
1643 * status-change bits in the portsc register changes from 0 to 1.
1644 * New status changes won't cause an event if any other change
1645 * bits are still set. When an event occurs, switch over to
1646 * polling to avoid losing status changes.
1648 xhci_dbg(xhci, "%s: starting port polling.\n", __func__);
1649 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1650 spin_unlock(&xhci->lock);
1651 /* Pass this up to the core */
1652 usb_hcd_poll_rh_status(hcd);
1653 spin_lock(&xhci->lock);
1657 * This TD is defined by the TRBs starting at start_trb in start_seg and ending
1658 * at end_trb, which may be in another segment. If the suspect DMA address is a
1659 * TRB in this TD, this function returns that TRB's segment. Otherwise it
1662 struct xhci_segment *trb_in_td(struct xhci_hcd *xhci,
1663 struct xhci_segment *start_seg,
1664 union xhci_trb *start_trb,
1665 union xhci_trb *end_trb,
1666 dma_addr_t suspect_dma,
1669 dma_addr_t start_dma;
1670 dma_addr_t end_seg_dma;
1671 dma_addr_t end_trb_dma;
1672 struct xhci_segment *cur_seg;
1674 start_dma = xhci_trb_virt_to_dma(start_seg, start_trb);
1675 cur_seg = start_seg;
1680 /* We may get an event for a Link TRB in the middle of a TD */
1681 end_seg_dma = xhci_trb_virt_to_dma(cur_seg,
1682 &cur_seg->trbs[TRBS_PER_SEGMENT - 1]);
1683 /* If the end TRB isn't in this segment, this is set to 0 */
1684 end_trb_dma = xhci_trb_virt_to_dma(cur_seg, end_trb);
1688 "Looking for event-dma %016llx trb-start %016llx trb-end %016llx seg-start %016llx seg-end %016llx\n",
1689 (unsigned long long)suspect_dma,
1690 (unsigned long long)start_dma,
1691 (unsigned long long)end_trb_dma,
1692 (unsigned long long)cur_seg->dma,
1693 (unsigned long long)end_seg_dma);
1695 if (end_trb_dma > 0) {
1696 /* The end TRB is in this segment, so suspect should be here */
1697 if (start_dma <= end_trb_dma) {
1698 if (suspect_dma >= start_dma && suspect_dma <= end_trb_dma)
1701 /* Case for one segment with
1702 * a TD wrapped around to the top
1704 if ((suspect_dma >= start_dma &&
1705 suspect_dma <= end_seg_dma) ||
1706 (suspect_dma >= cur_seg->dma &&
1707 suspect_dma <= end_trb_dma))
1712 /* Might still be somewhere in this segment */
1713 if (suspect_dma >= start_dma && suspect_dma <= end_seg_dma)
1716 cur_seg = cur_seg->next;
1717 start_dma = xhci_trb_virt_to_dma(cur_seg, &cur_seg->trbs[0]);
1718 } while (cur_seg != start_seg);
1723 static void xhci_cleanup_halted_endpoint(struct xhci_hcd *xhci,
1724 unsigned int slot_id, unsigned int ep_index,
1725 unsigned int stream_id,
1726 struct xhci_td *td, union xhci_trb *event_trb)
1728 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
1729 struct xhci_command *command;
1730 command = xhci_alloc_command(xhci, false, false, GFP_ATOMIC);
1734 ep->ep_state |= EP_HALTED;
1735 ep->stopped_td = td;
1736 ep->stopped_stream = stream_id;
1738 xhci_queue_reset_ep(xhci, command, slot_id, ep_index);
1739 xhci_cleanup_stalled_ring(xhci, td->urb->dev, ep_index);
1741 ep->stopped_td = NULL;
1742 ep->stopped_stream = 0;
1744 xhci_ring_cmd_db(xhci);
1747 /* Check if an error has halted the endpoint ring. The class driver will
1748 * cleanup the halt for a non-default control endpoint if we indicate a stall.
1749 * However, a babble and other errors also halt the endpoint ring, and the class
1750 * driver won't clear the halt in that case, so we need to issue a Set Transfer
1751 * Ring Dequeue Pointer command manually.
1753 static int xhci_requires_manual_halt_cleanup(struct xhci_hcd *xhci,
1754 struct xhci_ep_ctx *ep_ctx,
1755 unsigned int trb_comp_code)
1757 /* TRB completion codes that may require a manual halt cleanup */
1758 if (trb_comp_code == COMP_TX_ERR ||
1759 trb_comp_code == COMP_BABBLE ||
1760 trb_comp_code == COMP_SPLIT_ERR)
1761 /* The 0.96 spec says a babbling control endpoint
1762 * is not halted. The 0.96 spec says it is. Some HW
1763 * claims to be 0.95 compliant, but it halts the control
1764 * endpoint anyway. Check if a babble halted the
1767 if ((ep_ctx->ep_info & cpu_to_le32(EP_STATE_MASK)) ==
1768 cpu_to_le32(EP_STATE_HALTED))
1774 int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code)
1776 if (trb_comp_code >= 224 && trb_comp_code <= 255) {
1777 /* Vendor defined "informational" completion code,
1778 * treat as not-an-error.
1780 xhci_dbg(xhci, "Vendor defined info completion code %u\n",
1782 xhci_dbg(xhci, "Treating code as success.\n");
1789 * Finish the td processing, remove the td from td list;
1790 * Return 1 if the urb can be given back.
1792 static int finish_td(struct xhci_hcd *xhci, struct xhci_td *td,
1793 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1794 struct xhci_virt_ep *ep, int *status, bool skip)
1796 struct xhci_virt_device *xdev;
1797 struct xhci_ring *ep_ring;
1798 unsigned int slot_id;
1800 struct urb *urb = NULL;
1801 struct xhci_ep_ctx *ep_ctx;
1803 struct urb_priv *urb_priv;
1806 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1807 xdev = xhci->devs[slot_id];
1808 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
1809 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
1810 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1811 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
1816 if (trb_comp_code == COMP_STOP_INVAL ||
1817 trb_comp_code == COMP_STOP) {
1818 /* The Endpoint Stop Command completion will take care of any
1819 * stopped TDs. A stopped TD may be restarted, so don't update
1820 * the ring dequeue pointer or take this TD off any lists yet.
1822 ep->stopped_td = td;
1825 if (trb_comp_code == COMP_STALL) {
1826 /* The transfer is completed from the driver's
1827 * perspective, but we need to issue a set dequeue
1828 * command for this stalled endpoint to move the dequeue
1829 * pointer past the TD. We can't do that here because
1830 * the halt condition must be cleared first. Let the
1831 * USB class driver clear the stall later.
1833 ep->stopped_td = td;
1834 ep->stopped_stream = ep_ring->stream_id;
1835 } else if (xhci_requires_manual_halt_cleanup(xhci,
1836 ep_ctx, trb_comp_code)) {
1837 /* Other types of errors halt the endpoint, but the
1838 * class driver doesn't call usb_reset_endpoint() unless
1839 * the error is -EPIPE. Clear the halted status in the
1840 * xHCI hardware manually.
1842 xhci_cleanup_halted_endpoint(xhci,
1843 slot_id, ep_index, ep_ring->stream_id,
1846 /* Update ring dequeue pointer */
1847 while (ep_ring->dequeue != td->last_trb)
1848 inc_deq(xhci, ep_ring);
1849 inc_deq(xhci, ep_ring);
1853 /* Clean up the endpoint's TD list */
1855 urb_priv = urb->hcpriv;
1857 /* Do one last check of the actual transfer length.
1858 * If the host controller said we transferred more data than
1859 * the buffer length, urb->actual_length will be a very big
1860 * number (since it's unsigned). Play it safe and say we didn't
1861 * transfer anything.
1863 if (urb->actual_length > urb->transfer_buffer_length) {
1864 xhci_warn(xhci, "URB transfer length is wrong, "
1865 "xHC issue? req. len = %u, "
1867 urb->transfer_buffer_length,
1868 urb->actual_length);
1869 urb->actual_length = 0;
1870 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1871 *status = -EREMOTEIO;
1875 list_del_init(&td->td_list);
1876 /* Was this TD slated to be cancelled but completed anyway? */
1877 if (!list_empty(&td->cancelled_td_list))
1878 list_del_init(&td->cancelled_td_list);
1881 /* Giveback the urb when all the tds are completed */
1882 if (urb_priv->td_cnt == urb_priv->length) {
1884 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
1885 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs--;
1886 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs
1888 if (xhci->quirks & XHCI_AMD_PLL_FIX)
1889 usb_amd_quirk_pll_enable();
1899 * Process control tds, update urb status and actual_length.
1901 static int process_ctrl_td(struct xhci_hcd *xhci, struct xhci_td *td,
1902 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1903 struct xhci_virt_ep *ep, int *status)
1905 struct xhci_virt_device *xdev;
1906 struct xhci_ring *ep_ring;
1907 unsigned int slot_id;
1909 struct xhci_ep_ctx *ep_ctx;
1912 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1913 xdev = xhci->devs[slot_id];
1914 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
1915 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
1916 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1917 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
1919 switch (trb_comp_code) {
1921 if (event_trb == ep_ring->dequeue) {
1922 xhci_warn(xhci, "WARN: Success on ctrl setup TRB "
1923 "without IOC set??\n");
1924 *status = -ESHUTDOWN;
1925 } else if (event_trb != td->last_trb) {
1926 xhci_warn(xhci, "WARN: Success on ctrl data TRB "
1927 "without IOC set??\n");
1928 *status = -ESHUTDOWN;
1934 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1935 *status = -EREMOTEIO;
1939 case COMP_STOP_INVAL:
1941 return finish_td(xhci, td, event_trb, event, ep, status, false);
1943 if (!xhci_requires_manual_halt_cleanup(xhci,
1944 ep_ctx, trb_comp_code))
1946 xhci_dbg(xhci, "TRB error code %u, "
1947 "halted endpoint index = %u\n",
1948 trb_comp_code, ep_index);
1949 /* else fall through */
1951 /* Did we transfer part of the data (middle) phase? */
1952 if (event_trb != ep_ring->dequeue &&
1953 event_trb != td->last_trb)
1954 td->urb->actual_length =
1955 td->urb->transfer_buffer_length -
1956 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
1958 td->urb->actual_length = 0;
1960 xhci_cleanup_halted_endpoint(xhci,
1961 slot_id, ep_index, 0, td, event_trb);
1962 return finish_td(xhci, td, event_trb, event, ep, status, true);
1965 * Did we transfer any data, despite the errors that might have
1966 * happened? I.e. did we get past the setup stage?
1968 if (event_trb != ep_ring->dequeue) {
1969 /* The event was for the status stage */
1970 if (event_trb == td->last_trb) {
1971 if (td->urb->actual_length != 0) {
1972 /* Don't overwrite a previously set error code
1974 if ((*status == -EINPROGRESS || *status == 0) &&
1975 (td->urb->transfer_flags
1976 & URB_SHORT_NOT_OK))
1977 /* Did we already see a short data
1979 *status = -EREMOTEIO;
1981 td->urb->actual_length =
1982 td->urb->transfer_buffer_length;
1985 /* Maybe the event was for the data stage? */
1986 td->urb->actual_length =
1987 td->urb->transfer_buffer_length -
1988 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
1989 xhci_dbg(xhci, "Waiting for status "
1995 return finish_td(xhci, td, event_trb, event, ep, status, false);
1999 * Process isochronous tds, update urb packet status and actual_length.
2001 static int process_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
2002 union xhci_trb *event_trb, struct xhci_transfer_event *event,
2003 struct xhci_virt_ep *ep, int *status)
2005 struct xhci_ring *ep_ring;
2006 struct urb_priv *urb_priv;
2009 union xhci_trb *cur_trb;
2010 struct xhci_segment *cur_seg;
2011 struct usb_iso_packet_descriptor *frame;
2013 bool skip_td = false;
2015 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2016 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2017 urb_priv = td->urb->hcpriv;
2018 idx = urb_priv->td_cnt;
2019 frame = &td->urb->iso_frame_desc[idx];
2021 /* handle completion code */
2022 switch (trb_comp_code) {
2024 if (EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) == 0) {
2028 if ((xhci->quirks & XHCI_TRUST_TX_LENGTH))
2029 trb_comp_code = COMP_SHORT_TX;
2031 frame->status = td->urb->transfer_flags & URB_SHORT_NOT_OK ?
2035 frame->status = -ECOMM;
2038 case COMP_BUFF_OVER:
2040 frame->status = -EOVERFLOW;
2046 frame->status = -EPROTO;
2050 case COMP_STOP_INVAL:
2057 if (trb_comp_code == COMP_SUCCESS || skip_td) {
2058 frame->actual_length = frame->length;
2059 td->urb->actual_length += frame->length;
2061 for (cur_trb = ep_ring->dequeue,
2062 cur_seg = ep_ring->deq_seg; cur_trb != event_trb;
2063 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
2064 if (!TRB_TYPE_NOOP_LE32(cur_trb->generic.field[3]) &&
2065 !TRB_TYPE_LINK_LE32(cur_trb->generic.field[3]))
2066 len += TRB_LEN(le32_to_cpu(cur_trb->generic.field[2]));
2068 len += TRB_LEN(le32_to_cpu(cur_trb->generic.field[2])) -
2069 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
2071 if (trb_comp_code != COMP_STOP_INVAL) {
2072 frame->actual_length = len;
2073 td->urb->actual_length += len;
2077 return finish_td(xhci, td, event_trb, event, ep, status, false);
2080 static int skip_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
2081 struct xhci_transfer_event *event,
2082 struct xhci_virt_ep *ep, int *status)
2084 struct xhci_ring *ep_ring;
2085 struct urb_priv *urb_priv;
2086 struct usb_iso_packet_descriptor *frame;
2089 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2090 urb_priv = td->urb->hcpriv;
2091 idx = urb_priv->td_cnt;
2092 frame = &td->urb->iso_frame_desc[idx];
2094 /* The transfer is partly done. */
2095 frame->status = -EXDEV;
2097 /* calc actual length */
2098 frame->actual_length = 0;
2100 /* Update ring dequeue pointer */
2101 while (ep_ring->dequeue != td->last_trb)
2102 inc_deq(xhci, ep_ring);
2103 inc_deq(xhci, ep_ring);
2105 return finish_td(xhci, td, NULL, event, ep, status, true);
2109 * Process bulk and interrupt tds, update urb status and actual_length.
2111 static int process_bulk_intr_td(struct xhci_hcd *xhci, struct xhci_td *td,
2112 union xhci_trb *event_trb, struct xhci_transfer_event *event,
2113 struct xhci_virt_ep *ep, int *status)
2115 struct xhci_ring *ep_ring;
2116 union xhci_trb *cur_trb;
2117 struct xhci_segment *cur_seg;
2120 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2121 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2123 switch (trb_comp_code) {
2125 /* Double check that the HW transferred everything. */
2126 if (event_trb != td->last_trb ||
2127 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) != 0) {
2128 xhci_warn(xhci, "WARN Successful completion "
2130 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2131 *status = -EREMOTEIO;
2134 if ((xhci->quirks & XHCI_TRUST_TX_LENGTH))
2135 trb_comp_code = COMP_SHORT_TX;
2141 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2142 *status = -EREMOTEIO;
2147 /* Others already handled above */
2150 if (trb_comp_code == COMP_SHORT_TX)
2151 xhci_dbg(xhci, "ep %#x - asked for %d bytes, "
2152 "%d bytes untransferred\n",
2153 td->urb->ep->desc.bEndpointAddress,
2154 td->urb->transfer_buffer_length,
2155 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)));
2156 /* Fast path - was this the last TRB in the TD for this URB? */
2157 if (event_trb == td->last_trb) {
2158 if (EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) != 0) {
2159 td->urb->actual_length =
2160 td->urb->transfer_buffer_length -
2161 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
2162 if (td->urb->transfer_buffer_length <
2163 td->urb->actual_length) {
2164 xhci_warn(xhci, "HC gave bad length "
2165 "of %d bytes left\n",
2166 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)));
2167 td->urb->actual_length = 0;
2168 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2169 *status = -EREMOTEIO;
2173 /* Don't overwrite a previously set error code */
2174 if (*status == -EINPROGRESS) {
2175 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2176 *status = -EREMOTEIO;
2181 td->urb->actual_length =
2182 td->urb->transfer_buffer_length;
2183 /* Ignore a short packet completion if the
2184 * untransferred length was zero.
2186 if (*status == -EREMOTEIO)
2190 /* Slow path - walk the list, starting from the dequeue
2191 * pointer, to get the actual length transferred.
2193 td->urb->actual_length = 0;
2194 for (cur_trb = ep_ring->dequeue, cur_seg = ep_ring->deq_seg;
2195 cur_trb != event_trb;
2196 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
2197 if (!TRB_TYPE_NOOP_LE32(cur_trb->generic.field[3]) &&
2198 !TRB_TYPE_LINK_LE32(cur_trb->generic.field[3]))
2199 td->urb->actual_length +=
2200 TRB_LEN(le32_to_cpu(cur_trb->generic.field[2]));
2202 /* If the ring didn't stop on a Link or No-op TRB, add
2203 * in the actual bytes transferred from the Normal TRB
2205 if (trb_comp_code != COMP_STOP_INVAL)
2206 td->urb->actual_length +=
2207 TRB_LEN(le32_to_cpu(cur_trb->generic.field[2])) -
2208 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
2211 return finish_td(xhci, td, event_trb, event, ep, status, false);
2215 * If this function returns an error condition, it means it got a Transfer
2216 * event with a corrupted Slot ID, Endpoint ID, or TRB DMA address.
2217 * At this point, the host controller is probably hosed and should be reset.
2219 static int handle_tx_event(struct xhci_hcd *xhci,
2220 struct xhci_transfer_event *event)
2221 __releases(&xhci->lock)
2222 __acquires(&xhci->lock)
2224 struct xhci_virt_device *xdev;
2225 struct xhci_virt_ep *ep;
2226 struct xhci_ring *ep_ring;
2227 unsigned int slot_id;
2229 struct xhci_td *td = NULL;
2230 dma_addr_t event_dma;
2231 struct xhci_segment *event_seg;
2232 union xhci_trb *event_trb;
2233 struct urb *urb = NULL;
2234 int status = -EINPROGRESS;
2235 struct urb_priv *urb_priv;
2236 struct xhci_ep_ctx *ep_ctx;
2237 struct list_head *tmp;
2242 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
2243 xdev = xhci->devs[slot_id];
2245 xhci_err(xhci, "ERROR Transfer event pointed to bad slot\n");
2246 xhci_err(xhci, "@%016llx %08x %08x %08x %08x\n",
2247 (unsigned long long) xhci_trb_virt_to_dma(
2248 xhci->event_ring->deq_seg,
2249 xhci->event_ring->dequeue),
2250 lower_32_bits(le64_to_cpu(event->buffer)),
2251 upper_32_bits(le64_to_cpu(event->buffer)),
2252 le32_to_cpu(event->transfer_len),
2253 le32_to_cpu(event->flags));
2254 xhci_dbg(xhci, "Event ring:\n");
2255 xhci_debug_segment(xhci, xhci->event_ring->deq_seg);
2259 /* Endpoint ID is 1 based, our index is zero based */
2260 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
2261 ep = &xdev->eps[ep_index];
2262 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2263 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
2265 (le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK) ==
2266 EP_STATE_DISABLED) {
2267 xhci_err(xhci, "ERROR Transfer event for disabled endpoint "
2268 "or incorrect stream ring\n");
2269 xhci_err(xhci, "@%016llx %08x %08x %08x %08x\n",
2270 (unsigned long long) xhci_trb_virt_to_dma(
2271 xhci->event_ring->deq_seg,
2272 xhci->event_ring->dequeue),
2273 lower_32_bits(le64_to_cpu(event->buffer)),
2274 upper_32_bits(le64_to_cpu(event->buffer)),
2275 le32_to_cpu(event->transfer_len),
2276 le32_to_cpu(event->flags));
2277 xhci_dbg(xhci, "Event ring:\n");
2278 xhci_debug_segment(xhci, xhci->event_ring->deq_seg);
2282 /* Count current td numbers if ep->skip is set */
2284 list_for_each(tmp, &ep_ring->td_list)
2288 event_dma = le64_to_cpu(event->buffer);
2289 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2290 /* Look for common error cases */
2291 switch (trb_comp_code) {
2292 /* Skip codes that require special handling depending on
2296 if (EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) == 0)
2298 if (xhci->quirks & XHCI_TRUST_TX_LENGTH)
2299 trb_comp_code = COMP_SHORT_TX;
2301 xhci_warn_ratelimited(xhci,
2302 "WARN Successful completion on short TX: needs XHCI_TRUST_TX_LENGTH quirk?\n");
2306 xhci_dbg(xhci, "Stopped on Transfer TRB\n");
2308 case COMP_STOP_INVAL:
2309 xhci_dbg(xhci, "Stopped on No-op or Link TRB\n");
2312 xhci_dbg(xhci, "Stalled endpoint\n");
2313 ep->ep_state |= EP_HALTED;
2317 xhci_warn(xhci, "WARN: TRB error on endpoint\n");
2320 case COMP_SPLIT_ERR:
2322 xhci_dbg(xhci, "Transfer error on endpoint\n");
2326 xhci_dbg(xhci, "Babble error on endpoint\n");
2327 status = -EOVERFLOW;
2330 xhci_warn(xhci, "WARN: HC couldn't access mem fast enough\n");
2334 xhci_warn(xhci, "WARN: bandwidth overrun event on endpoint\n");
2336 case COMP_BUFF_OVER:
2337 xhci_warn(xhci, "WARN: buffer overrun event on endpoint\n");
2341 * When the Isoch ring is empty, the xHC will generate
2342 * a Ring Overrun Event for IN Isoch endpoint or Ring
2343 * Underrun Event for OUT Isoch endpoint.
2345 xhci_dbg(xhci, "underrun event on endpoint\n");
2346 if (!list_empty(&ep_ring->td_list))
2347 xhci_dbg(xhci, "Underrun Event for slot %d ep %d "
2348 "still with TDs queued?\n",
2349 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2353 xhci_dbg(xhci, "overrun event on endpoint\n");
2354 if (!list_empty(&ep_ring->td_list))
2355 xhci_dbg(xhci, "Overrun Event for slot %d ep %d "
2356 "still with TDs queued?\n",
2357 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2361 xhci_warn(xhci, "WARN: detect an incompatible device");
2364 case COMP_MISSED_INT:
2366 * When encounter missed service error, one or more isoc tds
2367 * may be missed by xHC.
2368 * Set skip flag of the ep_ring; Complete the missed tds as
2369 * short transfer when process the ep_ring next time.
2372 xhci_dbg(xhci, "Miss service interval error, set skip flag\n");
2375 if (xhci_is_vendor_info_code(xhci, trb_comp_code)) {
2379 xhci_warn(xhci, "ERROR Unknown event condition, HC probably "
2385 /* This TRB should be in the TD at the head of this ring's
2388 if (list_empty(&ep_ring->td_list)) {
2390 * A stopped endpoint may generate an extra completion
2391 * event if the device was suspended. Don't print
2394 if (!(trb_comp_code == COMP_STOP ||
2395 trb_comp_code == COMP_STOP_INVAL)) {
2396 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d with no TDs queued?\n",
2397 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2399 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n",
2400 (le32_to_cpu(event->flags) &
2401 TRB_TYPE_BITMASK)>>10);
2402 xhci_print_trb_offsets(xhci, (union xhci_trb *) event);
2406 xhci_dbg(xhci, "td_list is empty while skip "
2407 "flag set. Clear skip flag.\n");
2413 /* We've skipped all the TDs on the ep ring when ep->skip set */
2414 if (ep->skip && td_num == 0) {
2416 xhci_dbg(xhci, "All tds on the ep_ring skipped. "
2417 "Clear skip flag.\n");
2422 td = list_entry(ep_ring->td_list.next, struct xhci_td, td_list);
2426 /* Is this a TRB in the currently executing TD? */
2427 event_seg = trb_in_td(xhci, ep_ring->deq_seg, ep_ring->dequeue,
2428 td->last_trb, event_dma, false);
2431 * Skip the Force Stopped Event. The event_trb(event_dma) of FSE
2432 * is not in the current TD pointed by ep_ring->dequeue because
2433 * that the hardware dequeue pointer still at the previous TRB
2434 * of the current TD. The previous TRB maybe a Link TD or the
2435 * last TRB of the previous TD. The command completion handle
2436 * will take care the rest.
2438 if (!event_seg && (trb_comp_code == COMP_STOP ||
2439 trb_comp_code == COMP_STOP_INVAL)) {
2446 !usb_endpoint_xfer_isoc(&td->urb->ep->desc)) {
2447 /* Some host controllers give a spurious
2448 * successful event after a short transfer.
2451 if ((xhci->quirks & XHCI_SPURIOUS_SUCCESS) &&
2452 ep_ring->last_td_was_short) {
2453 ep_ring->last_td_was_short = false;
2457 /* HC is busted, give up! */
2459 "ERROR Transfer event TRB DMA ptr not "
2460 "part of current TD ep_index %d "
2461 "comp_code %u\n", ep_index,
2463 trb_in_td(xhci, ep_ring->deq_seg,
2464 ep_ring->dequeue, td->last_trb,
2469 ret = skip_isoc_td(xhci, td, event, ep, &status);
2472 if (trb_comp_code == COMP_SHORT_TX)
2473 ep_ring->last_td_was_short = true;
2475 ep_ring->last_td_was_short = false;
2478 xhci_dbg(xhci, "Found td. Clear skip flag.\n");
2482 event_trb = &event_seg->trbs[(event_dma - event_seg->dma) /
2483 sizeof(*event_trb)];
2485 * No-op TRB should not trigger interrupts.
2486 * If event_trb is a no-op TRB, it means the
2487 * corresponding TD has been cancelled. Just ignore
2490 if (TRB_TYPE_NOOP_LE32(event_trb->generic.field[3])) {
2492 "event_trb is a no-op TRB. Skip it\n");
2496 /* Now update the urb's actual_length and give back to
2499 if (usb_endpoint_xfer_control(&td->urb->ep->desc))
2500 ret = process_ctrl_td(xhci, td, event_trb, event, ep,
2502 else if (usb_endpoint_xfer_isoc(&td->urb->ep->desc))
2503 ret = process_isoc_td(xhci, td, event_trb, event, ep,
2506 ret = process_bulk_intr_td(xhci, td, event_trb, event,
2511 * Do not update event ring dequeue pointer if ep->skip is set.
2512 * Will roll back to continue process missed tds.
2514 if (trb_comp_code == COMP_MISSED_INT || !ep->skip) {
2515 inc_deq(xhci, xhci->event_ring);
2520 urb_priv = urb->hcpriv;
2521 /* Leave the TD around for the reset endpoint function
2522 * to use(but only if it's not a control endpoint,
2523 * since we already queued the Set TR dequeue pointer
2524 * command for stalled control endpoints).
2526 if (usb_endpoint_xfer_control(&urb->ep->desc) ||
2527 (trb_comp_code != COMP_STALL &&
2528 trb_comp_code != COMP_BABBLE))
2529 xhci_urb_free_priv(xhci, urb_priv);
2533 usb_hcd_unlink_urb_from_ep(bus_to_hcd(urb->dev->bus), urb);
2534 if ((urb->actual_length != urb->transfer_buffer_length &&
2535 (urb->transfer_flags &
2536 URB_SHORT_NOT_OK)) ||
2538 !usb_endpoint_xfer_isoc(&urb->ep->desc)))
2539 xhci_dbg(xhci, "Giveback URB %p, len = %d, "
2540 "expected = %d, status = %d\n",
2541 urb, urb->actual_length,
2542 urb->transfer_buffer_length,
2544 spin_unlock(&xhci->lock);
2545 /* EHCI, UHCI, and OHCI always unconditionally set the
2546 * urb->status of an isochronous endpoint to 0.
2548 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS)
2550 usb_hcd_giveback_urb(bus_to_hcd(urb->dev->bus), urb, status);
2551 spin_lock(&xhci->lock);
2555 * If ep->skip is set, it means there are missed tds on the
2556 * endpoint ring need to take care of.
2557 * Process them as short transfer until reach the td pointed by
2560 } while (ep->skip && trb_comp_code != COMP_MISSED_INT);
2566 * This function handles all OS-owned events on the event ring. It may drop
2567 * xhci->lock between event processing (e.g. to pass up port status changes).
2568 * Returns >0 for "possibly more events to process" (caller should call again),
2569 * otherwise 0 if done. In future, <0 returns should indicate error code.
2571 static int xhci_handle_event(struct xhci_hcd *xhci)
2573 union xhci_trb *event;
2574 int update_ptrs = 1;
2577 if (!xhci->event_ring || !xhci->event_ring->dequeue) {
2578 xhci->error_bitmask |= 1 << 1;
2582 event = xhci->event_ring->dequeue;
2583 /* Does the HC or OS own the TRB? */
2584 if ((le32_to_cpu(event->event_cmd.flags) & TRB_CYCLE) !=
2585 xhci->event_ring->cycle_state) {
2586 xhci->error_bitmask |= 1 << 2;
2591 * Barrier between reading the TRB_CYCLE (valid) flag above and any
2592 * speculative reads of the event's flags/data below.
2595 /* FIXME: Handle more event types. */
2596 switch ((le32_to_cpu(event->event_cmd.flags) & TRB_TYPE_BITMASK)) {
2597 case TRB_TYPE(TRB_COMPLETION):
2598 handle_cmd_completion(xhci, &event->event_cmd);
2600 case TRB_TYPE(TRB_PORT_STATUS):
2601 handle_port_status(xhci, event);
2604 case TRB_TYPE(TRB_TRANSFER):
2605 ret = handle_tx_event(xhci, &event->trans_event);
2607 xhci->error_bitmask |= 1 << 9;
2611 case TRB_TYPE(TRB_DEV_NOTE):
2612 handle_device_notification(xhci, event);
2615 if ((le32_to_cpu(event->event_cmd.flags) & TRB_TYPE_BITMASK) >=
2617 handle_vendor_event(xhci, event);
2619 xhci->error_bitmask |= 1 << 3;
2621 /* Any of the above functions may drop and re-acquire the lock, so check
2622 * to make sure a watchdog timer didn't mark the host as non-responsive.
2624 if (xhci->xhc_state & XHCI_STATE_DYING) {
2625 xhci_dbg(xhci, "xHCI host dying, returning from "
2626 "event handler.\n");
2631 /* Update SW event ring dequeue pointer */
2632 inc_deq(xhci, xhci->event_ring);
2634 /* Are there more items on the event ring? Caller will call us again to
2641 * xHCI spec says we can get an interrupt, and if the HC has an error condition,
2642 * we might get bad data out of the event ring. Section 4.10.2.7 has a list of
2643 * indicators of an event TRB error, but we check the status *first* to be safe.
2645 irqreturn_t xhci_irq(struct usb_hcd *hcd)
2647 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
2650 union xhci_trb *event_ring_deq;
2653 spin_lock(&xhci->lock);
2654 /* Check if the xHC generated the interrupt, or the irq is shared */
2655 status = readl(&xhci->op_regs->status);
2656 if (status == 0xffffffff)
2659 if (!(status & STS_EINT)) {
2660 spin_unlock(&xhci->lock);
2663 if (status & STS_FATAL) {
2664 xhci_warn(xhci, "WARNING: Host System Error\n");
2667 spin_unlock(&xhci->lock);
2672 * Clear the op reg interrupt status first,
2673 * so we can receive interrupts from other MSI-X interrupters.
2674 * Write 1 to clear the interrupt status.
2677 writel(status, &xhci->op_regs->status);
2678 /* FIXME when MSI-X is supported and there are multiple vectors */
2679 /* Clear the MSI-X event interrupt status */
2683 /* Acknowledge the PCI interrupt */
2684 irq_pending = readl(&xhci->ir_set->irq_pending);
2685 irq_pending |= IMAN_IP;
2686 writel(irq_pending, &xhci->ir_set->irq_pending);
2689 if (xhci->xhc_state & XHCI_STATE_DYING) {
2690 xhci_dbg(xhci, "xHCI dying, ignoring interrupt. "
2691 "Shouldn't IRQs be disabled?\n");
2692 /* Clear the event handler busy flag (RW1C);
2693 * the event ring should be empty.
2695 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
2696 xhci_write_64(xhci, temp_64 | ERST_EHB,
2697 &xhci->ir_set->erst_dequeue);
2698 spin_unlock(&xhci->lock);
2703 event_ring_deq = xhci->event_ring->dequeue;
2704 /* FIXME this should be a delayed service routine
2705 * that clears the EHB.
2707 while (xhci_handle_event(xhci) > 0) {}
2709 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
2710 /* If necessary, update the HW's version of the event ring deq ptr. */
2711 if (event_ring_deq != xhci->event_ring->dequeue) {
2712 deq = xhci_trb_virt_to_dma(xhci->event_ring->deq_seg,
2713 xhci->event_ring->dequeue);
2715 xhci_warn(xhci, "WARN something wrong with SW event "
2716 "ring dequeue ptr.\n");
2717 /* Update HC event ring dequeue pointer */
2718 temp_64 &= ERST_PTR_MASK;
2719 temp_64 |= ((u64) deq & (u64) ~ERST_PTR_MASK);
2722 /* Clear the event handler busy flag (RW1C); event ring is empty. */
2723 temp_64 |= ERST_EHB;
2724 xhci_write_64(xhci, temp_64, &xhci->ir_set->erst_dequeue);
2726 spin_unlock(&xhci->lock);
2731 irqreturn_t xhci_msi_irq(int irq, void *hcd)
2733 return xhci_irq(hcd);
2736 /**** Endpoint Ring Operations ****/
2739 * Generic function for queueing a TRB on a ring.
2740 * The caller must have checked to make sure there's room on the ring.
2742 * @more_trbs_coming: Will you enqueue more TRBs before calling
2743 * prepare_transfer()?
2745 static void queue_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
2746 bool more_trbs_coming,
2747 u32 field1, u32 field2, u32 field3, u32 field4)
2749 struct xhci_generic_trb *trb;
2751 trb = &ring->enqueue->generic;
2752 trb->field[0] = cpu_to_le32(field1);
2753 trb->field[1] = cpu_to_le32(field2);
2754 trb->field[2] = cpu_to_le32(field3);
2755 trb->field[3] = cpu_to_le32(field4);
2756 inc_enq(xhci, ring, more_trbs_coming);
2760 * Does various checks on the endpoint ring, and makes it ready to queue num_trbs.
2761 * FIXME allocate segments if the ring is full.
2763 static int prepare_ring(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
2764 u32 ep_state, unsigned int num_trbs, gfp_t mem_flags)
2766 unsigned int num_trbs_needed;
2768 /* Make sure the endpoint has been added to xHC schedule */
2770 case EP_STATE_DISABLED:
2772 * USB core changed config/interfaces without notifying us,
2773 * or hardware is reporting the wrong state.
2775 xhci_warn(xhci, "WARN urb submitted to disabled ep\n");
2777 case EP_STATE_ERROR:
2778 xhci_warn(xhci, "WARN waiting for error on ep to be cleared\n");
2779 /* FIXME event handling code for error needs to clear it */
2780 /* XXX not sure if this should be -ENOENT or not */
2782 case EP_STATE_HALTED:
2783 xhci_dbg(xhci, "WARN halted endpoint, queueing URB anyway.\n");
2784 case EP_STATE_STOPPED:
2785 case EP_STATE_RUNNING:
2788 xhci_err(xhci, "ERROR unknown endpoint state for ep\n");
2790 * FIXME issue Configure Endpoint command to try to get the HC
2791 * back into a known state.
2797 if (room_on_ring(xhci, ep_ring, num_trbs))
2800 if (ep_ring == xhci->cmd_ring) {
2801 xhci_err(xhci, "Do not support expand command ring\n");
2805 xhci_dbg_trace(xhci, trace_xhci_dbg_ring_expansion,
2806 "ERROR no room on ep ring, try ring expansion");
2807 num_trbs_needed = num_trbs - ep_ring->num_trbs_free;
2808 if (xhci_ring_expansion(xhci, ep_ring, num_trbs_needed,
2810 xhci_err(xhci, "Ring expansion failed\n");
2815 if (enqueue_is_link_trb(ep_ring)) {
2816 struct xhci_ring *ring = ep_ring;
2817 union xhci_trb *next;
2819 next = ring->enqueue;
2821 while (last_trb(xhci, ring, ring->enq_seg, next)) {
2822 /* If we're not dealing with 0.95 hardware or isoc rings
2823 * on AMD 0.96 host, clear the chain bit.
2825 if (!xhci_link_trb_quirk(xhci) &&
2826 !(ring->type == TYPE_ISOC &&
2827 (xhci->quirks & XHCI_AMD_0x96_HOST)))
2828 next->link.control &= cpu_to_le32(~TRB_CHAIN);
2830 next->link.control |= cpu_to_le32(TRB_CHAIN);
2833 next->link.control ^= cpu_to_le32(TRB_CYCLE);
2835 /* Toggle the cycle bit after the last ring segment. */
2836 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
2837 ring->cycle_state = (ring->cycle_state ? 0 : 1);
2839 ring->enq_seg = ring->enq_seg->next;
2840 ring->enqueue = ring->enq_seg->trbs;
2841 next = ring->enqueue;
2848 static int prepare_transfer(struct xhci_hcd *xhci,
2849 struct xhci_virt_device *xdev,
2850 unsigned int ep_index,
2851 unsigned int stream_id,
2852 unsigned int num_trbs,
2854 unsigned int td_index,
2858 struct urb_priv *urb_priv;
2860 struct xhci_ring *ep_ring;
2861 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
2863 ep_ring = xhci_stream_id_to_ring(xdev, ep_index, stream_id);
2865 xhci_dbg(xhci, "Can't prepare ring for bad stream ID %u\n",
2870 ret = prepare_ring(xhci, ep_ring,
2871 le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK,
2872 num_trbs, mem_flags);
2876 urb_priv = urb->hcpriv;
2877 td = urb_priv->td[td_index];
2879 INIT_LIST_HEAD(&td->td_list);
2880 INIT_LIST_HEAD(&td->cancelled_td_list);
2882 if (td_index == 0) {
2883 ret = usb_hcd_link_urb_to_ep(bus_to_hcd(urb->dev->bus), urb);
2889 /* Add this TD to the tail of the endpoint ring's TD list */
2890 list_add_tail(&td->td_list, &ep_ring->td_list);
2891 td->start_seg = ep_ring->enq_seg;
2892 td->first_trb = ep_ring->enqueue;
2894 urb_priv->td[td_index] = td;
2899 static unsigned int count_sg_trbs_needed(struct xhci_hcd *xhci, struct urb *urb)
2901 int num_sgs, num_trbs, running_total, temp, i;
2902 struct scatterlist *sg;
2905 num_sgs = urb->num_mapped_sgs;
2906 temp = urb->transfer_buffer_length;
2909 for_each_sg(urb->sg, sg, num_sgs, i) {
2910 unsigned int len = sg_dma_len(sg);
2912 /* Scatter gather list entries may cross 64KB boundaries */
2913 running_total = TRB_MAX_BUFF_SIZE -
2914 (sg_dma_address(sg) & (TRB_MAX_BUFF_SIZE - 1));
2915 running_total &= TRB_MAX_BUFF_SIZE - 1;
2916 if (running_total != 0)
2919 /* How many more 64KB chunks to transfer, how many more TRBs? */
2920 while (running_total < sg_dma_len(sg) && running_total < temp) {
2922 running_total += TRB_MAX_BUFF_SIZE;
2924 len = min_t(int, len, temp);
2932 static void check_trb_math(struct urb *urb, int num_trbs, int running_total)
2935 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated number of "
2936 "TRBs, %d left\n", __func__,
2937 urb->ep->desc.bEndpointAddress, num_trbs);
2938 if (running_total != urb->transfer_buffer_length)
2939 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated tx length, "
2940 "queued %#x (%d), asked for %#x (%d)\n",
2942 urb->ep->desc.bEndpointAddress,
2943 running_total, running_total,
2944 urb->transfer_buffer_length,
2945 urb->transfer_buffer_length);
2948 static void giveback_first_trb(struct xhci_hcd *xhci, int slot_id,
2949 unsigned int ep_index, unsigned int stream_id, int start_cycle,
2950 struct xhci_generic_trb *start_trb)
2953 * Pass all the TRBs to the hardware at once and make sure this write
2958 start_trb->field[3] |= cpu_to_le32(start_cycle);
2960 start_trb->field[3] &= cpu_to_le32(~TRB_CYCLE);
2961 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, stream_id);
2965 * xHCI uses normal TRBs for both bulk and interrupt. When the interrupt
2966 * endpoint is to be serviced, the xHC will consume (at most) one TD. A TD
2967 * (comprised of sg list entries) can take several service intervals to
2970 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
2971 struct urb *urb, int slot_id, unsigned int ep_index)
2973 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci,
2974 xhci->devs[slot_id]->out_ctx, ep_index);
2978 xhci_interval = EP_INTERVAL_TO_UFRAMES(le32_to_cpu(ep_ctx->ep_info));
2979 ep_interval = urb->interval;
2980 /* Convert to microframes */
2981 if (urb->dev->speed == USB_SPEED_LOW ||
2982 urb->dev->speed == USB_SPEED_FULL)
2984 /* FIXME change this to a warning and a suggestion to use the new API
2985 * to set the polling interval (once the API is added).
2987 if (xhci_interval != ep_interval) {
2988 dev_dbg_ratelimited(&urb->dev->dev,
2989 "Driver uses different interval (%d microframe%s) than xHCI (%d microframe%s)\n",
2990 ep_interval, ep_interval == 1 ? "" : "s",
2991 xhci_interval, xhci_interval == 1 ? "" : "s");
2992 urb->interval = xhci_interval;
2993 /* Convert back to frames for LS/FS devices */
2994 if (urb->dev->speed == USB_SPEED_LOW ||
2995 urb->dev->speed == USB_SPEED_FULL)
2998 return xhci_queue_bulk_tx(xhci, mem_flags, urb, slot_id, ep_index);
3002 * The TD size is the number of bytes remaining in the TD (including this TRB),
3003 * right shifted by 10.
3004 * It must fit in bits 21:17, so it can't be bigger than 31.
3006 static u32 xhci_td_remainder(unsigned int remainder)
3008 u32 max = (1 << (21 - 17 + 1)) - 1;
3010 if ((remainder >> 10) >= max)
3013 return (remainder >> 10) << 17;
3017 * For xHCI 1.0 host controllers, TD size is the number of max packet sized
3018 * packets remaining in the TD (*not* including this TRB).
3020 * Total TD packet count = total_packet_count =
3021 * DIV_ROUND_UP(TD size in bytes / wMaxPacketSize)
3023 * Packets transferred up to and including this TRB = packets_transferred =
3024 * rounddown(total bytes transferred including this TRB / wMaxPacketSize)
3026 * TD size = total_packet_count - packets_transferred
3028 * It must fit in bits 21:17, so it can't be bigger than 31.
3029 * The last TRB in a TD must have the TD size set to zero.
3031 static u32 xhci_v1_0_td_remainder(int running_total, int trb_buff_len,
3032 unsigned int total_packet_count, struct urb *urb,
3033 unsigned int num_trbs_left)
3035 int packets_transferred;
3037 /* One TRB with a zero-length data packet. */
3038 if (num_trbs_left == 0 || (running_total == 0 && trb_buff_len == 0))
3041 /* All the TRB queueing functions don't count the current TRB in
3044 packets_transferred = (running_total + trb_buff_len) /
3045 GET_MAX_PACKET(usb_endpoint_maxp(&urb->ep->desc));
3047 if ((total_packet_count - packets_transferred) > 31)
3049 return (total_packet_count - packets_transferred) << 17;
3052 static int queue_bulk_sg_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3053 struct urb *urb, int slot_id, unsigned int ep_index)
3055 struct xhci_ring *ep_ring;
3056 unsigned int num_trbs;
3057 struct urb_priv *urb_priv;
3059 struct scatterlist *sg;
3061 int trb_buff_len, this_sg_len, running_total;
3062 unsigned int total_packet_count;
3065 bool more_trbs_coming;
3067 struct xhci_generic_trb *start_trb;
3070 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3074 num_trbs = count_sg_trbs_needed(xhci, urb);
3075 num_sgs = urb->num_mapped_sgs;
3076 total_packet_count = DIV_ROUND_UP(urb->transfer_buffer_length,
3077 usb_endpoint_maxp(&urb->ep->desc));
3079 trb_buff_len = prepare_transfer(xhci, xhci->devs[slot_id],
3080 ep_index, urb->stream_id,
3081 num_trbs, urb, 0, mem_flags);
3082 if (trb_buff_len < 0)
3083 return trb_buff_len;
3085 urb_priv = urb->hcpriv;
3086 td = urb_priv->td[0];
3089 * Don't give the first TRB to the hardware (by toggling the cycle bit)
3090 * until we've finished creating all the other TRBs. The ring's cycle
3091 * state may change as we enqueue the other TRBs, so save it too.
3093 start_trb = &ep_ring->enqueue->generic;
3094 start_cycle = ep_ring->cycle_state;
3098 * How much data is in the first TRB?
3100 * There are three forces at work for TRB buffer pointers and lengths:
3101 * 1. We don't want to walk off the end of this sg-list entry buffer.
3102 * 2. The transfer length that the driver requested may be smaller than
3103 * the amount of memory allocated for this scatter-gather list.
3104 * 3. TRBs buffers can't cross 64KB boundaries.
3107 addr = (u64) sg_dma_address(sg);
3108 this_sg_len = sg_dma_len(sg);
3109 trb_buff_len = TRB_MAX_BUFF_SIZE - (addr & (TRB_MAX_BUFF_SIZE - 1));
3110 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
3111 if (trb_buff_len > urb->transfer_buffer_length)
3112 trb_buff_len = urb->transfer_buffer_length;
3115 /* Queue the first TRB, even if it's zero-length */
3118 u32 length_field = 0;
3121 /* Don't change the cycle bit of the first TRB until later */
3124 if (start_cycle == 0)
3127 field |= ep_ring->cycle_state;
3129 /* Chain all the TRBs together; clear the chain bit in the last
3130 * TRB to indicate it's the last TRB in the chain.
3135 /* FIXME - add check for ZERO_PACKET flag before this */
3136 td->last_trb = ep_ring->enqueue;
3140 /* Only set interrupt on short packet for IN endpoints */
3141 if (usb_urb_dir_in(urb))
3144 if (TRB_MAX_BUFF_SIZE -
3145 (addr & (TRB_MAX_BUFF_SIZE - 1)) < trb_buff_len) {
3146 xhci_warn(xhci, "WARN: sg dma xfer crosses 64KB boundaries!\n");
3147 xhci_dbg(xhci, "Next boundary at %#x, end dma = %#x\n",
3148 (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
3149 (unsigned int) addr + trb_buff_len);
3152 /* Set the TRB length, TD size, and interrupter fields. */
3153 if (xhci->hci_version < 0x100) {
3154 remainder = xhci_td_remainder(
3155 urb->transfer_buffer_length -
3158 remainder = xhci_v1_0_td_remainder(running_total,
3159 trb_buff_len, total_packet_count, urb,
3162 length_field = TRB_LEN(trb_buff_len) |
3167 more_trbs_coming = true;
3169 more_trbs_coming = false;
3170 queue_trb(xhci, ep_ring, more_trbs_coming,
3171 lower_32_bits(addr),
3172 upper_32_bits(addr),
3174 field | TRB_TYPE(TRB_NORMAL));
3176 running_total += trb_buff_len;
3178 /* Calculate length for next transfer --
3179 * Are we done queueing all the TRBs for this sg entry?
3181 this_sg_len -= trb_buff_len;
3182 if (this_sg_len == 0) {
3187 addr = (u64) sg_dma_address(sg);
3188 this_sg_len = sg_dma_len(sg);
3190 addr += trb_buff_len;
3193 trb_buff_len = TRB_MAX_BUFF_SIZE -
3194 (addr & (TRB_MAX_BUFF_SIZE - 1));
3195 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
3196 if (running_total + trb_buff_len > urb->transfer_buffer_length)
3198 urb->transfer_buffer_length - running_total;
3199 } while (running_total < urb->transfer_buffer_length);
3201 check_trb_math(urb, num_trbs, running_total);
3202 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3203 start_cycle, start_trb);
3207 /* This is very similar to what ehci-q.c qtd_fill() does */
3208 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3209 struct urb *urb, int slot_id, unsigned int ep_index)
3211 struct xhci_ring *ep_ring;
3212 struct urb_priv *urb_priv;
3215 struct xhci_generic_trb *start_trb;
3217 bool more_trbs_coming;
3219 u32 field, length_field;
3221 int running_total, trb_buff_len, ret;
3222 unsigned int total_packet_count;
3226 return queue_bulk_sg_tx(xhci, mem_flags, urb, slot_id, ep_index);
3228 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3233 /* How much data is (potentially) left before the 64KB boundary? */
3234 running_total = TRB_MAX_BUFF_SIZE -
3235 (urb->transfer_dma & (TRB_MAX_BUFF_SIZE - 1));
3236 running_total &= TRB_MAX_BUFF_SIZE - 1;
3238 /* If there's some data on this 64KB chunk, or we have to send a
3239 * zero-length transfer, we need at least one TRB
3241 if (running_total != 0 || urb->transfer_buffer_length == 0)
3243 /* How many more 64KB chunks to transfer, how many more TRBs? */
3244 while (running_total < urb->transfer_buffer_length) {
3246 running_total += TRB_MAX_BUFF_SIZE;
3248 /* FIXME: this doesn't deal with URB_ZERO_PACKET - need one more */
3250 ret = prepare_transfer(xhci, xhci->devs[slot_id],
3251 ep_index, urb->stream_id,
3252 num_trbs, urb, 0, mem_flags);
3256 urb_priv = urb->hcpriv;
3257 td = urb_priv->td[0];
3260 * Don't give the first TRB to the hardware (by toggling the cycle bit)
3261 * until we've finished creating all the other TRBs. The ring's cycle
3262 * state may change as we enqueue the other TRBs, so save it too.
3264 start_trb = &ep_ring->enqueue->generic;
3265 start_cycle = ep_ring->cycle_state;
3268 total_packet_count = DIV_ROUND_UP(urb->transfer_buffer_length,
3269 usb_endpoint_maxp(&urb->ep->desc));
3270 /* How much data is in the first TRB? */
3271 addr = (u64) urb->transfer_dma;
3272 trb_buff_len = TRB_MAX_BUFF_SIZE -
3273 (urb->transfer_dma & (TRB_MAX_BUFF_SIZE - 1));
3274 if (trb_buff_len > urb->transfer_buffer_length)
3275 trb_buff_len = urb->transfer_buffer_length;
3279 /* Queue the first TRB, even if it's zero-length */
3284 /* Don't change the cycle bit of the first TRB until later */
3287 if (start_cycle == 0)
3290 field |= ep_ring->cycle_state;
3292 /* Chain all the TRBs together; clear the chain bit in the last
3293 * TRB to indicate it's the last TRB in the chain.
3298 /* FIXME - add check for ZERO_PACKET flag before this */
3299 td->last_trb = ep_ring->enqueue;
3303 /* Only set interrupt on short packet for IN endpoints */
3304 if (usb_urb_dir_in(urb))
3307 /* Set the TRB length, TD size, and interrupter fields. */
3308 if (xhci->hci_version < 0x100) {
3309 remainder = xhci_td_remainder(
3310 urb->transfer_buffer_length -
3313 remainder = xhci_v1_0_td_remainder(running_total,
3314 trb_buff_len, total_packet_count, urb,
3317 length_field = TRB_LEN(trb_buff_len) |
3322 more_trbs_coming = true;
3324 more_trbs_coming = false;
3325 queue_trb(xhci, ep_ring, more_trbs_coming,
3326 lower_32_bits(addr),
3327 upper_32_bits(addr),
3329 field | TRB_TYPE(TRB_NORMAL));
3331 running_total += trb_buff_len;
3333 /* Calculate length for next transfer */
3334 addr += trb_buff_len;
3335 trb_buff_len = urb->transfer_buffer_length - running_total;
3336 if (trb_buff_len > TRB_MAX_BUFF_SIZE)
3337 trb_buff_len = TRB_MAX_BUFF_SIZE;
3338 } while (running_total < urb->transfer_buffer_length);
3340 check_trb_math(urb, num_trbs, running_total);
3341 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3342 start_cycle, start_trb);
3346 /* Caller must have locked xhci->lock */
3347 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3348 struct urb *urb, int slot_id, unsigned int ep_index)
3350 struct xhci_ring *ep_ring;
3353 struct usb_ctrlrequest *setup;
3354 struct xhci_generic_trb *start_trb;
3356 u32 field, length_field;
3357 struct urb_priv *urb_priv;
3360 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3365 * Need to copy setup packet into setup TRB, so we can't use the setup
3368 if (!urb->setup_packet)
3371 /* 1 TRB for setup, 1 for status */
3374 * Don't need to check if we need additional event data and normal TRBs,
3375 * since data in control transfers will never get bigger than 16MB
3376 * XXX: can we get a buffer that crosses 64KB boundaries?
3378 if (urb->transfer_buffer_length > 0)
3380 ret = prepare_transfer(xhci, xhci->devs[slot_id],
3381 ep_index, urb->stream_id,
3382 num_trbs, urb, 0, mem_flags);
3386 urb_priv = urb->hcpriv;
3387 td = urb_priv->td[0];
3390 * Don't give the first TRB to the hardware (by toggling the cycle bit)
3391 * until we've finished creating all the other TRBs. The ring's cycle
3392 * state may change as we enqueue the other TRBs, so save it too.
3394 start_trb = &ep_ring->enqueue->generic;
3395 start_cycle = ep_ring->cycle_state;
3397 /* Queue setup TRB - see section 6.4.1.2.1 */
3398 /* FIXME better way to translate setup_packet into two u32 fields? */
3399 setup = (struct usb_ctrlrequest *) urb->setup_packet;
3401 field |= TRB_IDT | TRB_TYPE(TRB_SETUP);
3402 if (start_cycle == 0)
3405 /* xHCI 1.0 6.4.1.2.1: Transfer Type field */
3406 if (xhci->hci_version == 0x100) {
3407 if (urb->transfer_buffer_length > 0) {
3408 if (setup->bRequestType & USB_DIR_IN)
3409 field |= TRB_TX_TYPE(TRB_DATA_IN);
3411 field |= TRB_TX_TYPE(TRB_DATA_OUT);
3415 queue_trb(xhci, ep_ring, true,
3416 setup->bRequestType | setup->bRequest << 8 | le16_to_cpu(setup->wValue) << 16,
3417 le16_to_cpu(setup->wIndex) | le16_to_cpu(setup->wLength) << 16,
3418 TRB_LEN(8) | TRB_INTR_TARGET(0),
3419 /* Immediate data in pointer */
3422 /* If there's data, queue data TRBs */
3423 /* Only set interrupt on short packet for IN endpoints */
3424 if (usb_urb_dir_in(urb))
3425 field = TRB_ISP | TRB_TYPE(TRB_DATA);
3427 field = TRB_TYPE(TRB_DATA);
3429 length_field = TRB_LEN(urb->transfer_buffer_length) |
3430 xhci_td_remainder(urb->transfer_buffer_length) |
3432 if (urb->transfer_buffer_length > 0) {
3433 if (setup->bRequestType & USB_DIR_IN)
3434 field |= TRB_DIR_IN;
3435 queue_trb(xhci, ep_ring, true,
3436 lower_32_bits(urb->transfer_dma),
3437 upper_32_bits(urb->transfer_dma),
3439 field | ep_ring->cycle_state);
3442 /* Save the DMA address of the last TRB in the TD */
3443 td->last_trb = ep_ring->enqueue;
3445 /* Queue status TRB - see Table 7 and sections 4.11.2.2 and 6.4.1.2.3 */
3446 /* If the device sent data, the status stage is an OUT transfer */
3447 if (urb->transfer_buffer_length > 0 && setup->bRequestType & USB_DIR_IN)
3451 queue_trb(xhci, ep_ring, false,
3455 /* Event on completion */
3456 field | TRB_IOC | TRB_TYPE(TRB_STATUS) | ep_ring->cycle_state);
3458 giveback_first_trb(xhci, slot_id, ep_index, 0,
3459 start_cycle, start_trb);
3463 static int count_isoc_trbs_needed(struct xhci_hcd *xhci,
3464 struct urb *urb, int i)
3469 addr = (u64) (urb->transfer_dma + urb->iso_frame_desc[i].offset);
3470 td_len = urb->iso_frame_desc[i].length;
3472 num_trbs = DIV_ROUND_UP(td_len + (addr & (TRB_MAX_BUFF_SIZE - 1)),
3481 * The transfer burst count field of the isochronous TRB defines the number of
3482 * bursts that are required to move all packets in this TD. Only SuperSpeed
3483 * devices can burst up to bMaxBurst number of packets per service interval.
3484 * This field is zero based, meaning a value of zero in the field means one
3485 * burst. Basically, for everything but SuperSpeed devices, this field will be
3486 * zero. Only xHCI 1.0 host controllers support this field.
3488 static unsigned int xhci_get_burst_count(struct xhci_hcd *xhci,
3489 struct usb_device *udev,
3490 struct urb *urb, unsigned int total_packet_count)
3492 unsigned int max_burst;
3494 if (xhci->hci_version < 0x100 || udev->speed != USB_SPEED_SUPER)
3497 max_burst = urb->ep->ss_ep_comp.bMaxBurst;
3498 return DIV_ROUND_UP(total_packet_count, max_burst + 1) - 1;
3502 * Returns the number of packets in the last "burst" of packets. This field is
3503 * valid for all speeds of devices. USB 2.0 devices can only do one "burst", so
3504 * the last burst packet count is equal to the total number of packets in the
3505 * TD. SuperSpeed endpoints can have up to 3 bursts. All but the last burst
3506 * must contain (bMaxBurst + 1) number of packets, but the last burst can
3507 * contain 1 to (bMaxBurst + 1) packets.
3509 static unsigned int xhci_get_last_burst_packet_count(struct xhci_hcd *xhci,
3510 struct usb_device *udev,
3511 struct urb *urb, unsigned int total_packet_count)
3513 unsigned int max_burst;
3514 unsigned int residue;
3516 if (xhci->hci_version < 0x100)
3519 switch (udev->speed) {
3520 case USB_SPEED_SUPER:
3521 /* bMaxBurst is zero based: 0 means 1 packet per burst */
3522 max_burst = urb->ep->ss_ep_comp.bMaxBurst;
3523 residue = total_packet_count % (max_burst + 1);
3524 /* If residue is zero, the last burst contains (max_burst + 1)
3525 * number of packets, but the TLBPC field is zero-based.
3531 if (total_packet_count == 0)
3533 return total_packet_count - 1;
3537 /* This is for isoc transfer */
3538 static int xhci_queue_isoc_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3539 struct urb *urb, int slot_id, unsigned int ep_index)
3541 struct xhci_ring *ep_ring;
3542 struct urb_priv *urb_priv;
3544 int num_tds, trbs_per_td;
3545 struct xhci_generic_trb *start_trb;
3548 u32 field, length_field;
3549 int running_total, trb_buff_len, td_len, td_remain_len, ret;
3550 u64 start_addr, addr;
3552 bool more_trbs_coming;
3554 ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
3556 num_tds = urb->number_of_packets;
3558 xhci_dbg(xhci, "Isoc URB with zero packets?\n");
3562 start_addr = (u64) urb->transfer_dma;
3563 start_trb = &ep_ring->enqueue->generic;
3564 start_cycle = ep_ring->cycle_state;
3566 urb_priv = urb->hcpriv;
3567 /* Queue the first TRB, even if it's zero-length */
3568 for (i = 0; i < num_tds; i++) {
3569 unsigned int total_packet_count;
3570 unsigned int burst_count;
3571 unsigned int residue;
3575 addr = start_addr + urb->iso_frame_desc[i].offset;
3576 td_len = urb->iso_frame_desc[i].length;
3577 td_remain_len = td_len;
3578 total_packet_count = DIV_ROUND_UP(td_len,
3580 usb_endpoint_maxp(&urb->ep->desc)));
3581 /* A zero-length transfer still involves at least one packet. */
3582 if (total_packet_count == 0)
3583 total_packet_count++;
3584 burst_count = xhci_get_burst_count(xhci, urb->dev, urb,
3585 total_packet_count);
3586 residue = xhci_get_last_burst_packet_count(xhci,
3587 urb->dev, urb, total_packet_count);
3589 trbs_per_td = count_isoc_trbs_needed(xhci, urb, i);
3591 ret = prepare_transfer(xhci, xhci->devs[slot_id], ep_index,
3592 urb->stream_id, trbs_per_td, urb, i, mem_flags);
3599 td = urb_priv->td[i];
3600 for (j = 0; j < trbs_per_td; j++) {
3605 field = TRB_TBC(burst_count) |
3607 /* Queue the isoc TRB */
3608 field |= TRB_TYPE(TRB_ISOC);
3609 /* Assume URB_ISO_ASAP is set */
3612 if (start_cycle == 0)
3615 field |= ep_ring->cycle_state;
3618 /* Queue other normal TRBs */
3619 field |= TRB_TYPE(TRB_NORMAL);
3620 field |= ep_ring->cycle_state;
3623 /* Only set interrupt on short packet for IN EPs */
3624 if (usb_urb_dir_in(urb))
3627 /* Chain all the TRBs together; clear the chain bit in
3628 * the last TRB to indicate it's the last TRB in the
3631 if (j < trbs_per_td - 1) {
3633 more_trbs_coming = true;
3635 td->last_trb = ep_ring->enqueue;
3637 if (xhci->hci_version == 0x100 &&
3640 /* Set BEI bit except for the last td */
3641 if (i < num_tds - 1)
3644 more_trbs_coming = false;
3647 /* Calculate TRB length */
3648 trb_buff_len = TRB_MAX_BUFF_SIZE -
3649 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
3650 if (trb_buff_len > td_remain_len)
3651 trb_buff_len = td_remain_len;
3653 /* Set the TRB length, TD size, & interrupter fields. */
3654 if (xhci->hci_version < 0x100) {
3655 remainder = xhci_td_remainder(
3656 td_len - running_total);
3658 remainder = xhci_v1_0_td_remainder(
3659 running_total, trb_buff_len,
3660 total_packet_count, urb,
3661 (trbs_per_td - j - 1));
3663 length_field = TRB_LEN(trb_buff_len) |
3667 queue_trb(xhci, ep_ring, more_trbs_coming,
3668 lower_32_bits(addr),
3669 upper_32_bits(addr),
3672 running_total += trb_buff_len;
3674 addr += trb_buff_len;
3675 td_remain_len -= trb_buff_len;
3678 /* Check TD length */
3679 if (running_total != td_len) {
3680 xhci_err(xhci, "ISOC TD length unmatch\n");
3686 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs == 0) {
3687 if (xhci->quirks & XHCI_AMD_PLL_FIX)
3688 usb_amd_quirk_pll_disable();
3690 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs++;
3692 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3693 start_cycle, start_trb);
3696 /* Clean up a partially enqueued isoc transfer. */
3698 for (i--; i >= 0; i--)
3699 list_del_init(&urb_priv->td[i]->td_list);
3701 /* Use the first TD as a temporary variable to turn the TDs we've queued
3702 * into No-ops with a software-owned cycle bit. That way the hardware
3703 * won't accidentally start executing bogus TDs when we partially
3704 * overwrite them. td->first_trb and td->start_seg are already set.
3706 urb_priv->td[0]->last_trb = ep_ring->enqueue;
3707 /* Every TRB except the first & last will have its cycle bit flipped. */
3708 td_to_noop(xhci, ep_ring, urb_priv->td[0], true);
3710 /* Reset the ring enqueue back to the first TRB and its cycle bit. */
3711 ep_ring->enqueue = urb_priv->td[0]->first_trb;
3712 ep_ring->enq_seg = urb_priv->td[0]->start_seg;
3713 ep_ring->cycle_state = start_cycle;
3714 ep_ring->num_trbs_free = ep_ring->num_trbs_free_temp;
3715 usb_hcd_unlink_urb_from_ep(bus_to_hcd(urb->dev->bus), urb);
3720 * Check transfer ring to guarantee there is enough room for the urb.
3721 * Update ISO URB start_frame and interval.
3722 * Update interval as xhci_queue_intr_tx does. Just use xhci frame_index to
3723 * update the urb->start_frame by now.
3724 * Always assume URB_ISO_ASAP set, and NEVER use urb->start_frame as input.
3726 int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
3727 struct urb *urb, int slot_id, unsigned int ep_index)
3729 struct xhci_virt_device *xdev;
3730 struct xhci_ring *ep_ring;
3731 struct xhci_ep_ctx *ep_ctx;
3735 int num_tds, num_trbs, i;
3738 xdev = xhci->devs[slot_id];
3739 ep_ring = xdev->eps[ep_index].ring;
3740 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
3743 num_tds = urb->number_of_packets;
3744 for (i = 0; i < num_tds; i++)
3745 num_trbs += count_isoc_trbs_needed(xhci, urb, i);
3747 /* Check the ring to guarantee there is enough room for the whole urb.
3748 * Do not insert any td of the urb to the ring if the check failed.
3750 ret = prepare_ring(xhci, ep_ring, le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK,
3751 num_trbs, mem_flags);
3755 start_frame = readl(&xhci->run_regs->microframe_index);
3756 start_frame &= 0x3fff;
3758 urb->start_frame = start_frame;
3759 if (urb->dev->speed == USB_SPEED_LOW ||
3760 urb->dev->speed == USB_SPEED_FULL)
3761 urb->start_frame >>= 3;
3763 xhci_interval = EP_INTERVAL_TO_UFRAMES(le32_to_cpu(ep_ctx->ep_info));
3764 ep_interval = urb->interval;
3765 /* Convert to microframes */
3766 if (urb->dev->speed == USB_SPEED_LOW ||
3767 urb->dev->speed == USB_SPEED_FULL)
3769 /* FIXME change this to a warning and a suggestion to use the new API
3770 * to set the polling interval (once the API is added).
3772 if (xhci_interval != ep_interval) {
3773 dev_dbg_ratelimited(&urb->dev->dev,
3774 "Driver uses different interval (%d microframe%s) than xHCI (%d microframe%s)\n",
3775 ep_interval, ep_interval == 1 ? "" : "s",
3776 xhci_interval, xhci_interval == 1 ? "" : "s");
3777 urb->interval = xhci_interval;
3778 /* Convert back to frames for LS/FS devices */
3779 if (urb->dev->speed == USB_SPEED_LOW ||
3780 urb->dev->speed == USB_SPEED_FULL)
3783 ep_ring->num_trbs_free_temp = ep_ring->num_trbs_free;
3785 return xhci_queue_isoc_tx(xhci, mem_flags, urb, slot_id, ep_index);
3788 /**** Command Ring Operations ****/
3790 /* Generic function for queueing a command TRB on the command ring.
3791 * Check to make sure there's room on the command ring for one command TRB.
3792 * Also check that there's room reserved for commands that must not fail.
3793 * If this is a command that must not fail, meaning command_must_succeed = TRUE,
3794 * then only check for the number of reserved spots.
3795 * Don't decrement xhci->cmd_ring_reserved_trbs after we've queued the TRB
3796 * because the command event handler may want to resubmit a failed command.
3798 static int queue_command(struct xhci_hcd *xhci, struct xhci_command *cmd,
3799 u32 field1, u32 field2,
3800 u32 field3, u32 field4, bool command_must_succeed)
3802 int reserved_trbs = xhci->cmd_ring_reserved_trbs;
3804 if (xhci->xhc_state & XHCI_STATE_DYING)
3807 if (!command_must_succeed)
3810 ret = prepare_ring(xhci, xhci->cmd_ring, EP_STATE_RUNNING,
3811 reserved_trbs, GFP_ATOMIC);
3813 xhci_err(xhci, "ERR: No room for command on command ring\n");
3814 if (command_must_succeed)
3815 xhci_err(xhci, "ERR: Reserved TRB counting for "
3816 "unfailable commands failed.\n");
3820 cmd->command_trb = xhci->cmd_ring->enqueue;
3821 list_add_tail(&cmd->cmd_list, &xhci->cmd_list);
3823 /* if there are no other commands queued we start the timeout timer */
3824 if (xhci->cmd_list.next == &cmd->cmd_list &&
3825 !timer_pending(&xhci->cmd_timer)) {
3826 xhci->current_cmd = cmd;
3827 mod_timer(&xhci->cmd_timer, jiffies + XHCI_CMD_DEFAULT_TIMEOUT);
3830 queue_trb(xhci, xhci->cmd_ring, false, field1, field2, field3,
3831 field4 | xhci->cmd_ring->cycle_state);
3835 /* Queue a slot enable or disable request on the command ring */
3836 int xhci_queue_slot_control(struct xhci_hcd *xhci, struct xhci_command *cmd,
3837 u32 trb_type, u32 slot_id)
3839 return queue_command(xhci, cmd, 0, 0, 0,
3840 TRB_TYPE(trb_type) | SLOT_ID_FOR_TRB(slot_id), false);
3843 /* Queue an address device command TRB */
3844 int xhci_queue_address_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
3845 dma_addr_t in_ctx_ptr, u32 slot_id, enum xhci_setup_dev setup)
3847 return queue_command(xhci, cmd, lower_32_bits(in_ctx_ptr),
3848 upper_32_bits(in_ctx_ptr), 0,
3849 TRB_TYPE(TRB_ADDR_DEV) | SLOT_ID_FOR_TRB(slot_id)
3850 | (setup == SETUP_CONTEXT_ONLY ? TRB_BSR : 0), false);
3853 int xhci_queue_vendor_command(struct xhci_hcd *xhci, struct xhci_command *cmd,
3854 u32 field1, u32 field2, u32 field3, u32 field4)
3856 return queue_command(xhci, cmd, field1, field2, field3, field4, false);
3859 /* Queue a reset device command TRB */
3860 int xhci_queue_reset_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
3863 return queue_command(xhci, cmd, 0, 0, 0,
3864 TRB_TYPE(TRB_RESET_DEV) | SLOT_ID_FOR_TRB(slot_id),
3868 /* Queue a configure endpoint command TRB */
3869 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci,
3870 struct xhci_command *cmd, dma_addr_t in_ctx_ptr,
3871 u32 slot_id, bool command_must_succeed)
3873 return queue_command(xhci, cmd, lower_32_bits(in_ctx_ptr),
3874 upper_32_bits(in_ctx_ptr), 0,
3875 TRB_TYPE(TRB_CONFIG_EP) | SLOT_ID_FOR_TRB(slot_id),
3876 command_must_succeed);
3879 /* Queue an evaluate context command TRB */
3880 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, struct xhci_command *cmd,
3881 dma_addr_t in_ctx_ptr, u32 slot_id, bool command_must_succeed)
3883 return queue_command(xhci, cmd, lower_32_bits(in_ctx_ptr),
3884 upper_32_bits(in_ctx_ptr), 0,
3885 TRB_TYPE(TRB_EVAL_CONTEXT) | SLOT_ID_FOR_TRB(slot_id),
3886 command_must_succeed);
3890 * Suspend is set to indicate "Stop Endpoint Command" is being issued to stop
3891 * activity on an endpoint that is about to be suspended.
3893 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, struct xhci_command *cmd,
3894 int slot_id, unsigned int ep_index, int suspend)
3896 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3897 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3898 u32 type = TRB_TYPE(TRB_STOP_RING);
3899 u32 trb_suspend = SUSPEND_PORT_FOR_TRB(suspend);
3901 return queue_command(xhci, cmd, 0, 0, 0,
3902 trb_slot_id | trb_ep_index | type | trb_suspend, false);
3905 /* Set Transfer Ring Dequeue Pointer command */
3906 void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
3907 unsigned int slot_id, unsigned int ep_index,
3908 unsigned int stream_id,
3909 struct xhci_dequeue_state *deq_state)
3912 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3913 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3914 u32 trb_stream_id = STREAM_ID_FOR_TRB(stream_id);
3916 u32 type = TRB_TYPE(TRB_SET_DEQ);
3917 struct xhci_virt_ep *ep;
3918 struct xhci_command *cmd;
3921 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
3922 "Set TR Deq Ptr cmd, new deq seg = %p (0x%llx dma), new deq ptr = %p (0x%llx dma), new cycle = %u",
3923 deq_state->new_deq_seg,
3924 (unsigned long long)deq_state->new_deq_seg->dma,
3925 deq_state->new_deq_ptr,
3926 (unsigned long long)xhci_trb_virt_to_dma(
3927 deq_state->new_deq_seg, deq_state->new_deq_ptr),
3928 deq_state->new_cycle_state);
3930 addr = xhci_trb_virt_to_dma(deq_state->new_deq_seg,
3931 deq_state->new_deq_ptr);
3933 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
3934 xhci_warn(xhci, "WARN deq seg = %p, deq pt = %p\n",
3935 deq_state->new_deq_seg, deq_state->new_deq_ptr);
3938 ep = &xhci->devs[slot_id]->eps[ep_index];
3939 if ((ep->ep_state & SET_DEQ_PENDING)) {
3940 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
3941 xhci_warn(xhci, "A Set TR Deq Ptr command is pending.\n");
3945 /* This function gets called from contexts where it cannot sleep */
3946 cmd = xhci_alloc_command(xhci, false, false, GFP_ATOMIC);
3948 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr: ENOMEM\n");
3952 ep->queued_deq_seg = deq_state->new_deq_seg;
3953 ep->queued_deq_ptr = deq_state->new_deq_ptr;
3955 trb_sct = SCT_FOR_TRB(SCT_PRI_TR);
3956 ret = queue_command(xhci, cmd,
3957 lower_32_bits(addr) | trb_sct | deq_state->new_cycle_state,
3958 upper_32_bits(addr), trb_stream_id,
3959 trb_slot_id | trb_ep_index | type, false);
3961 xhci_free_command(xhci, cmd);
3965 /* Stop the TD queueing code from ringing the doorbell until
3966 * this command completes. The HC won't set the dequeue pointer
3967 * if the ring is running, and ringing the doorbell starts the
3970 ep->ep_state |= SET_DEQ_PENDING;
3973 int xhci_queue_reset_ep(struct xhci_hcd *xhci, struct xhci_command *cmd,
3974 int slot_id, unsigned int ep_index)
3976 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3977 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3978 u32 type = TRB_TYPE(TRB_RESET_EP);
3980 return queue_command(xhci, cmd, 0, 0, 0,
3981 trb_slot_id | trb_ep_index | type, false);