2 * xHCI host controller driver
4 * Copyright (C) 2008 Intel Corp.
7 * Some code borrowed from the Linux EHCI driver.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 * Ring initialization rules:
25 * 1. Each segment is initialized to zero, except for link TRBs.
26 * 2. Ring cycle state = 0. This represents Producer Cycle State (PCS) or
27 * Consumer Cycle State (CCS), depending on ring function.
28 * 3. Enqueue pointer = dequeue pointer = address of first TRB in the segment.
30 * Ring behavior rules:
31 * 1. A ring is empty if enqueue == dequeue. This means there will always be at
32 * least one free TRB in the ring. This is useful if you want to turn that
33 * into a link TRB and expand the ring.
34 * 2. When incrementing an enqueue or dequeue pointer, if the next TRB is a
35 * link TRB, then load the pointer with the address in the link TRB. If the
36 * link TRB had its toggle bit set, you may need to update the ring cycle
37 * state (see cycle bit rules). You may have to do this multiple times
38 * until you reach a non-link TRB.
39 * 3. A ring is full if enqueue++ (for the definition of increment above)
40 * equals the dequeue pointer.
43 * 1. When a consumer increments a dequeue pointer and encounters a toggle bit
44 * in a link TRB, it must toggle the ring cycle state.
45 * 2. When a producer increments an enqueue pointer and encounters a toggle bit
46 * in a link TRB, it must toggle the ring cycle state.
49 * 1. Check if ring is full before you enqueue.
50 * 2. Write the ring cycle state to the cycle bit in the TRB you're enqueuing.
51 * Update enqueue pointer between each write (which may update the ring
53 * 3. Notify consumer. If SW is producer, it rings the doorbell for command
54 * and endpoint rings. If HC is the producer for the event ring,
55 * and it generates an interrupt according to interrupt modulation rules.
58 * 1. Check if TRB belongs to you. If the cycle bit == your ring cycle state,
59 * the TRB is owned by the consumer.
60 * 2. Update dequeue pointer (which may update the ring cycle state) and
61 * continue processing TRBs until you reach a TRB which is not owned by you.
62 * 3. Notify the producer. SW is the consumer for the event ring, and it
63 * updates event ring dequeue pointer. HC is the consumer for the command and
64 * endpoint rings; it generates events on the event ring for these.
67 #include <linux/scatterlist.h>
68 #include <linux/slab.h>
71 static int handle_cmd_in_cmd_wait_list(struct xhci_hcd *xhci,
72 struct xhci_virt_device *virt_dev,
73 struct xhci_event_cmd *event);
76 * Returns zero if the TRB isn't in this segment, otherwise it returns the DMA
79 dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg,
82 unsigned long segment_offset;
84 if (!seg || !trb || trb < seg->trbs)
87 segment_offset = trb - seg->trbs;
88 if (segment_offset > TRBS_PER_SEGMENT)
90 return seg->dma + (segment_offset * sizeof(*trb));
93 /* Does this link TRB point to the first segment in a ring,
94 * or was the previous TRB the last TRB on the last segment in the ERST?
96 static bool last_trb_on_last_seg(struct xhci_hcd *xhci, struct xhci_ring *ring,
97 struct xhci_segment *seg, union xhci_trb *trb)
99 if (ring == xhci->event_ring)
100 return (trb == &seg->trbs[TRBS_PER_SEGMENT]) &&
101 (seg->next == xhci->event_ring->first_seg);
103 return le32_to_cpu(trb->link.control) & LINK_TOGGLE;
106 /* Is this TRB a link TRB or was the last TRB the last TRB in this event ring
107 * segment? I.e. would the updated event TRB pointer step off the end of the
110 static int last_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
111 struct xhci_segment *seg, union xhci_trb *trb)
113 if (ring == xhci->event_ring)
114 return trb == &seg->trbs[TRBS_PER_SEGMENT];
116 return TRB_TYPE_LINK_LE32(trb->link.control);
119 static int enqueue_is_link_trb(struct xhci_ring *ring)
121 struct xhci_link_trb *link = &ring->enqueue->link;
122 return TRB_TYPE_LINK_LE32(link->control);
125 /* Updates trb to point to the next TRB in the ring, and updates seg if the next
126 * TRB is in a new segment. This does not skip over link TRBs, and it does not
127 * effect the ring dequeue or enqueue pointers.
129 static void next_trb(struct xhci_hcd *xhci,
130 struct xhci_ring *ring,
131 struct xhci_segment **seg,
132 union xhci_trb **trb)
134 if (last_trb(xhci, ring, *seg, *trb)) {
136 *trb = ((*seg)->trbs);
143 * See Cycle bit rules. SW is the consumer for the event ring only.
144 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
146 static void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring, bool consumer)
148 union xhci_trb *next = ++(ring->dequeue);
149 unsigned long long addr;
152 /* Update the dequeue pointer further if that was a link TRB or we're at
153 * the end of an event ring segment (which doesn't have link TRBS)
155 while (last_trb(xhci, ring, ring->deq_seg, next)) {
156 if (consumer && last_trb_on_last_seg(xhci, ring, ring->deq_seg, next)) {
157 ring->cycle_state = (ring->cycle_state ? 0 : 1);
159 ring->deq_seg = ring->deq_seg->next;
160 ring->dequeue = ring->deq_seg->trbs;
161 next = ring->dequeue;
163 addr = (unsigned long long) xhci_trb_virt_to_dma(ring->deq_seg, ring->dequeue);
167 * See Cycle bit rules. SW is the consumer for the event ring only.
168 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
170 * If we've just enqueued a TRB that is in the middle of a TD (meaning the
171 * chain bit is set), then set the chain bit in all the following link TRBs.
172 * If we've enqueued the last TRB in a TD, make sure the following link TRBs
173 * have their chain bit cleared (so that each Link TRB is a separate TD).
175 * Section 6.4.4.1 of the 0.95 spec says link TRBs cannot have the chain bit
176 * set, but other sections talk about dealing with the chain bit set. This was
177 * fixed in the 0.96 specification errata, but we have to assume that all 0.95
178 * xHCI hardware can't handle the chain bit being cleared on a link TRB.
180 * @more_trbs_coming: Will you enqueue more TRBs before calling
181 * prepare_transfer()?
183 static void inc_enq(struct xhci_hcd *xhci, struct xhci_ring *ring,
184 bool consumer, bool more_trbs_coming, bool isoc)
187 union xhci_trb *next;
188 unsigned long long addr;
190 chain = le32_to_cpu(ring->enqueue->generic.field[3]) & TRB_CHAIN;
191 next = ++(ring->enqueue);
194 /* Update the dequeue pointer further if that was a link TRB or we're at
195 * the end of an event ring segment (which doesn't have link TRBS)
197 while (last_trb(xhci, ring, ring->enq_seg, next)) {
199 if (ring != xhci->event_ring) {
201 * If the caller doesn't plan on enqueueing more
202 * TDs before ringing the doorbell, then we
203 * don't want to give the link TRB to the
204 * hardware just yet. We'll give the link TRB
205 * back in prepare_ring() just before we enqueue
206 * the TD at the top of the ring.
208 if (!chain && !more_trbs_coming)
211 /* If we're not dealing with 0.95 hardware or
212 * isoc rings on AMD 0.96 host,
213 * carry over the chain bit of the previous TRB
214 * (which may mean the chain bit is cleared).
216 if (!(isoc && (xhci->quirks & XHCI_AMD_0x96_HOST))
217 && !xhci_link_trb_quirk(xhci)) {
218 next->link.control &=
219 cpu_to_le32(~TRB_CHAIN);
220 next->link.control |=
223 /* Give this link TRB to the hardware */
225 next->link.control ^= cpu_to_le32(TRB_CYCLE);
227 /* Toggle the cycle bit after the last ring segment. */
228 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
229 ring->cycle_state = (ring->cycle_state ? 0 : 1);
232 ring->enq_seg = ring->enq_seg->next;
233 ring->enqueue = ring->enq_seg->trbs;
234 next = ring->enqueue;
236 addr = (unsigned long long) xhci_trb_virt_to_dma(ring->enq_seg, ring->enqueue);
240 * Check to see if there's room to enqueue num_trbs on the ring. See rules
242 * FIXME: this would be simpler and faster if we just kept track of the number
243 * of free TRBs in a ring.
245 static int room_on_ring(struct xhci_hcd *xhci, struct xhci_ring *ring,
246 unsigned int num_trbs)
249 union xhci_trb *enq = ring->enqueue;
250 struct xhci_segment *enq_seg = ring->enq_seg;
251 struct xhci_segment *cur_seg;
252 unsigned int left_on_ring;
254 /* If we are currently pointing to a link TRB, advance the
255 * enqueue pointer before checking for space */
256 while (last_trb(xhci, ring, enq_seg, enq)) {
257 enq_seg = enq_seg->next;
261 /* Check if ring is empty */
262 if (enq == ring->dequeue) {
263 /* Can't use link trbs */
264 left_on_ring = TRBS_PER_SEGMENT - 1;
265 for (cur_seg = enq_seg->next; cur_seg != enq_seg;
266 cur_seg = cur_seg->next)
267 left_on_ring += TRBS_PER_SEGMENT - 1;
269 /* Always need one TRB free in the ring. */
271 if (num_trbs > left_on_ring) {
272 xhci_warn(xhci, "Not enough room on ring; "
273 "need %u TRBs, %u TRBs left\n",
274 num_trbs, left_on_ring);
279 /* Make sure there's an extra empty TRB available */
280 for (i = 0; i <= num_trbs; ++i) {
281 if (enq == ring->dequeue)
284 while (last_trb(xhci, ring, enq_seg, enq)) {
285 enq_seg = enq_seg->next;
292 /* Ring the host controller doorbell after placing a command on the ring */
293 void xhci_ring_cmd_db(struct xhci_hcd *xhci)
295 xhci_dbg(xhci, "// Ding dong!\n");
296 xhci_writel(xhci, DB_VALUE_HOST, &xhci->dba->doorbell[0]);
297 /* Flush PCI posted writes */
298 xhci_readl(xhci, &xhci->dba->doorbell[0]);
301 void xhci_ring_ep_doorbell(struct xhci_hcd *xhci,
302 unsigned int slot_id,
303 unsigned int ep_index,
304 unsigned int stream_id)
306 __le32 __iomem *db_addr = &xhci->dba->doorbell[slot_id];
307 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
308 unsigned int ep_state = ep->ep_state;
310 /* Don't ring the doorbell for this endpoint if there are pending
311 * cancellations because we don't want to interrupt processing.
312 * We don't want to restart any stream rings if there's a set dequeue
313 * pointer command pending because the device can choose to start any
314 * stream once the endpoint is on the HW schedule.
315 * FIXME - check all the stream rings for pending cancellations.
317 if ((ep_state & EP_HALT_PENDING) || (ep_state & SET_DEQ_PENDING) ||
318 (ep_state & EP_HALTED))
320 xhci_writel(xhci, DB_VALUE(ep_index, stream_id), db_addr);
321 /* The CPU has better things to do at this point than wait for a
322 * write-posting flush. It'll get there soon enough.
326 /* Ring the doorbell for any rings with pending URBs */
327 static void ring_doorbell_for_active_rings(struct xhci_hcd *xhci,
328 unsigned int slot_id,
329 unsigned int ep_index)
331 unsigned int stream_id;
332 struct xhci_virt_ep *ep;
334 ep = &xhci->devs[slot_id]->eps[ep_index];
336 /* A ring has pending URBs if its TD list is not empty */
337 if (!(ep->ep_state & EP_HAS_STREAMS)) {
338 if (!(list_empty(&ep->ring->td_list)))
339 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, 0);
343 for (stream_id = 1; stream_id < ep->stream_info->num_streams;
345 struct xhci_stream_info *stream_info = ep->stream_info;
346 if (!list_empty(&stream_info->stream_rings[stream_id]->td_list))
347 xhci_ring_ep_doorbell(xhci, slot_id, ep_index,
353 * Find the segment that trb is in. Start searching in start_seg.
354 * If we must move past a segment that has a link TRB with a toggle cycle state
355 * bit set, then we will toggle the value pointed at by cycle_state.
357 static struct xhci_segment *find_trb_seg(
358 struct xhci_segment *start_seg,
359 union xhci_trb *trb, int *cycle_state)
361 struct xhci_segment *cur_seg = start_seg;
362 struct xhci_generic_trb *generic_trb;
364 while (cur_seg->trbs > trb ||
365 &cur_seg->trbs[TRBS_PER_SEGMENT - 1] < trb) {
366 generic_trb = &cur_seg->trbs[TRBS_PER_SEGMENT - 1].generic;
367 if (generic_trb->field[3] & cpu_to_le32(LINK_TOGGLE))
369 cur_seg = cur_seg->next;
370 if (cur_seg == start_seg)
371 /* Looped over the entire list. Oops! */
378 static struct xhci_ring *xhci_triad_to_transfer_ring(struct xhci_hcd *xhci,
379 unsigned int slot_id, unsigned int ep_index,
380 unsigned int stream_id)
382 struct xhci_virt_ep *ep;
384 ep = &xhci->devs[slot_id]->eps[ep_index];
385 /* Common case: no streams */
386 if (!(ep->ep_state & EP_HAS_STREAMS))
389 if (stream_id == 0) {
391 "WARN: Slot ID %u, ep index %u has streams, "
392 "but URB has no stream ID.\n",
397 if (stream_id < ep->stream_info->num_streams)
398 return ep->stream_info->stream_rings[stream_id];
401 "WARN: Slot ID %u, ep index %u has "
402 "stream IDs 1 to %u allocated, "
403 "but stream ID %u is requested.\n",
405 ep->stream_info->num_streams - 1,
410 /* Get the right ring for the given URB.
411 * If the endpoint supports streams, boundary check the URB's stream ID.
412 * If the endpoint doesn't support streams, return the singular endpoint ring.
414 static struct xhci_ring *xhci_urb_to_transfer_ring(struct xhci_hcd *xhci,
417 return xhci_triad_to_transfer_ring(xhci, urb->dev->slot_id,
418 xhci_get_endpoint_index(&urb->ep->desc), urb->stream_id);
422 * Move the xHC's endpoint ring dequeue pointer past cur_td.
423 * Record the new state of the xHC's endpoint ring dequeue segment,
424 * dequeue pointer, and new consumer cycle state in state.
425 * Update our internal representation of the ring's dequeue pointer.
427 * We do this in three jumps:
428 * - First we update our new ring state to be the same as when the xHC stopped.
429 * - Then we traverse the ring to find the segment that contains
430 * the last TRB in the TD. We toggle the xHC's new cycle state when we pass
431 * any link TRBs with the toggle cycle bit set.
432 * - Finally we move the dequeue state one TRB further, toggling the cycle bit
433 * if we've moved it past a link TRB with the toggle cycle bit set.
435 * Some of the uses of xhci_generic_trb are grotty, but if they're done
436 * with correct __le32 accesses they should work fine. Only users of this are
439 void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
440 unsigned int slot_id, unsigned int ep_index,
441 unsigned int stream_id, struct xhci_td *cur_td,
442 struct xhci_dequeue_state *state)
444 struct xhci_virt_device *dev = xhci->devs[slot_id];
445 struct xhci_ring *ep_ring;
446 struct xhci_generic_trb *trb;
447 struct xhci_ep_ctx *ep_ctx;
450 ep_ring = xhci_triad_to_transfer_ring(xhci, slot_id,
451 ep_index, stream_id);
453 xhci_warn(xhci, "WARN can't find new dequeue state "
454 "for invalid stream ID %u.\n",
458 state->new_cycle_state = 0;
459 xhci_dbg(xhci, "Finding segment containing stopped TRB.\n");
460 state->new_deq_seg = find_trb_seg(cur_td->start_seg,
461 dev->eps[ep_index].stopped_trb,
462 &state->new_cycle_state);
463 if (!state->new_deq_seg) {
468 /* Dig out the cycle state saved by the xHC during the stop ep cmd */
469 xhci_dbg(xhci, "Finding endpoint context\n");
470 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
471 state->new_cycle_state = 0x1 & le64_to_cpu(ep_ctx->deq);
473 state->new_deq_ptr = cur_td->last_trb;
474 xhci_dbg(xhci, "Finding segment containing last TRB in TD.\n");
475 state->new_deq_seg = find_trb_seg(state->new_deq_seg,
477 &state->new_cycle_state);
478 if (!state->new_deq_seg) {
483 trb = &state->new_deq_ptr->generic;
484 if (TRB_TYPE_LINK_LE32(trb->field[3]) &&
485 (trb->field[3] & cpu_to_le32(LINK_TOGGLE)))
486 state->new_cycle_state ^= 0x1;
487 next_trb(xhci, ep_ring, &state->new_deq_seg, &state->new_deq_ptr);
490 * If there is only one segment in a ring, find_trb_seg()'s while loop
491 * will not run, and it will return before it has a chance to see if it
492 * needs to toggle the cycle bit. It can't tell if the stalled transfer
493 * ended just before the link TRB on a one-segment ring, or if the TD
494 * wrapped around the top of the ring, because it doesn't have the TD in
495 * question. Look for the one-segment case where stalled TRB's address
496 * is greater than the new dequeue pointer address.
498 if (ep_ring->first_seg == ep_ring->first_seg->next &&
499 state->new_deq_ptr < dev->eps[ep_index].stopped_trb)
500 state->new_cycle_state ^= 0x1;
501 xhci_dbg(xhci, "Cycle state = 0x%x\n", state->new_cycle_state);
503 /* Don't update the ring cycle state for the producer (us). */
504 xhci_dbg(xhci, "New dequeue segment = %p (virtual)\n",
506 addr = xhci_trb_virt_to_dma(state->new_deq_seg, state->new_deq_ptr);
507 xhci_dbg(xhci, "New dequeue pointer = 0x%llx (DMA)\n",
508 (unsigned long long) addr);
511 /* flip_cycle means flip the cycle bit of all but the first and last TRB.
512 * (The last TRB actually points to the ring enqueue pointer, which is not part
513 * of this TD.) This is used to remove partially enqueued isoc TDs from a ring.
515 static void td_to_noop(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
516 struct xhci_td *cur_td, bool flip_cycle)
518 struct xhci_segment *cur_seg;
519 union xhci_trb *cur_trb;
521 for (cur_seg = cur_td->start_seg, cur_trb = cur_td->first_trb;
523 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
524 if (TRB_TYPE_LINK_LE32(cur_trb->generic.field[3])) {
525 /* Unchain any chained Link TRBs, but
526 * leave the pointers intact.
528 cur_trb->generic.field[3] &= cpu_to_le32(~TRB_CHAIN);
529 /* Flip the cycle bit (link TRBs can't be the first
533 cur_trb->generic.field[3] ^=
534 cpu_to_le32(TRB_CYCLE);
535 xhci_dbg(xhci, "Cancel (unchain) link TRB\n");
536 xhci_dbg(xhci, "Address = %p (0x%llx dma); "
537 "in seg %p (0x%llx dma)\n",
539 (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
541 (unsigned long long)cur_seg->dma);
543 cur_trb->generic.field[0] = 0;
544 cur_trb->generic.field[1] = 0;
545 cur_trb->generic.field[2] = 0;
546 /* Preserve only the cycle bit of this TRB */
547 cur_trb->generic.field[3] &= cpu_to_le32(TRB_CYCLE);
548 /* Flip the cycle bit except on the first or last TRB */
549 if (flip_cycle && cur_trb != cur_td->first_trb &&
550 cur_trb != cur_td->last_trb)
551 cur_trb->generic.field[3] ^=
552 cpu_to_le32(TRB_CYCLE);
553 cur_trb->generic.field[3] |= cpu_to_le32(
554 TRB_TYPE(TRB_TR_NOOP));
555 xhci_dbg(xhci, "TRB to noop at offset 0x%llx\n",
557 xhci_trb_virt_to_dma(cur_seg, cur_trb));
559 if (cur_trb == cur_td->last_trb)
564 static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
565 unsigned int ep_index, unsigned int stream_id,
566 struct xhci_segment *deq_seg,
567 union xhci_trb *deq_ptr, u32 cycle_state);
569 void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
570 unsigned int slot_id, unsigned int ep_index,
571 unsigned int stream_id,
572 struct xhci_dequeue_state *deq_state)
574 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
576 xhci_dbg(xhci, "Set TR Deq Ptr cmd, new deq seg = %p (0x%llx dma), "
577 "new deq ptr = %p (0x%llx dma), new cycle = %u\n",
578 deq_state->new_deq_seg,
579 (unsigned long long)deq_state->new_deq_seg->dma,
580 deq_state->new_deq_ptr,
581 (unsigned long long)xhci_trb_virt_to_dma(deq_state->new_deq_seg, deq_state->new_deq_ptr),
582 deq_state->new_cycle_state);
583 queue_set_tr_deq(xhci, slot_id, ep_index, stream_id,
584 deq_state->new_deq_seg,
585 deq_state->new_deq_ptr,
586 (u32) deq_state->new_cycle_state);
587 /* Stop the TD queueing code from ringing the doorbell until
588 * this command completes. The HC won't set the dequeue pointer
589 * if the ring is running, and ringing the doorbell starts the
592 ep->ep_state |= SET_DEQ_PENDING;
595 static void xhci_stop_watchdog_timer_in_irq(struct xhci_hcd *xhci,
596 struct xhci_virt_ep *ep)
598 ep->ep_state &= ~EP_HALT_PENDING;
599 /* Can't del_timer_sync in interrupt, so we attempt to cancel. If the
600 * timer is running on another CPU, we don't decrement stop_cmds_pending
601 * (since we didn't successfully stop the watchdog timer).
603 if (del_timer(&ep->stop_cmd_timer))
604 ep->stop_cmds_pending--;
607 /* Must be called with xhci->lock held in interrupt context */
608 static void xhci_giveback_urb_in_irq(struct xhci_hcd *xhci,
609 struct xhci_td *cur_td, int status, char *adjective)
613 struct urb_priv *urb_priv;
616 urb_priv = urb->hcpriv;
618 hcd = bus_to_hcd(urb->dev->bus);
620 /* Only giveback urb when this is the last td in urb */
621 if (urb_priv->td_cnt == urb_priv->length) {
622 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
623 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs--;
624 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs == 0) {
625 if (xhci->quirks & XHCI_AMD_PLL_FIX)
626 usb_amd_quirk_pll_enable();
629 usb_hcd_unlink_urb_from_ep(hcd, urb);
631 spin_unlock(&xhci->lock);
632 usb_hcd_giveback_urb(hcd, urb, status);
633 xhci_urb_free_priv(xhci, urb_priv);
634 spin_lock(&xhci->lock);
639 * When we get a command completion for a Stop Endpoint Command, we need to
640 * unlink any cancelled TDs from the ring. There are two ways to do that:
642 * 1. If the HW was in the middle of processing the TD that needs to be
643 * cancelled, then we must move the ring's dequeue pointer past the last TRB
644 * in the TD with a Set Dequeue Pointer Command.
645 * 2. Otherwise, we turn all the TRBs in the TD into No-op TRBs (with the chain
646 * bit cleared) so that the HW will skip over them.
648 static void handle_stopped_endpoint(struct xhci_hcd *xhci,
649 union xhci_trb *trb, struct xhci_event_cmd *event)
651 unsigned int slot_id;
652 unsigned int ep_index;
653 struct xhci_virt_device *virt_dev;
654 struct xhci_ring *ep_ring;
655 struct xhci_virt_ep *ep;
656 struct list_head *entry;
657 struct xhci_td *cur_td = NULL;
658 struct xhci_td *last_unlinked_td;
660 struct xhci_dequeue_state deq_state;
662 if (unlikely(TRB_TO_SUSPEND_PORT(
663 le32_to_cpu(xhci->cmd_ring->dequeue->generic.field[3])))) {
664 slot_id = TRB_TO_SLOT_ID(
665 le32_to_cpu(xhci->cmd_ring->dequeue->generic.field[3]));
666 virt_dev = xhci->devs[slot_id];
668 handle_cmd_in_cmd_wait_list(xhci, virt_dev,
671 xhci_warn(xhci, "Stop endpoint command "
672 "completion for disabled slot %u\n",
677 memset(&deq_state, 0, sizeof(deq_state));
678 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(trb->generic.field[3]));
679 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
680 ep = &xhci->devs[slot_id]->eps[ep_index];
682 if (list_empty(&ep->cancelled_td_list)) {
683 xhci_stop_watchdog_timer_in_irq(xhci, ep);
684 ep->stopped_td = NULL;
685 ep->stopped_trb = NULL;
686 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
690 /* Fix up the ep ring first, so HW stops executing cancelled TDs.
691 * We have the xHCI lock, so nothing can modify this list until we drop
692 * it. We're also in the event handler, so we can't get re-interrupted
693 * if another Stop Endpoint command completes
695 list_for_each(entry, &ep->cancelled_td_list) {
696 cur_td = list_entry(entry, struct xhci_td, cancelled_td_list);
697 xhci_dbg(xhci, "Removing canceled TD starting at 0x%llx (dma).\n",
698 (unsigned long long)xhci_trb_virt_to_dma(
699 cur_td->start_seg, cur_td->first_trb));
700 ep_ring = xhci_urb_to_transfer_ring(xhci, cur_td->urb);
702 /* This shouldn't happen unless a driver is mucking
703 * with the stream ID after submission. This will
704 * leave the TD on the hardware ring, and the hardware
705 * will try to execute it, and may access a buffer
706 * that has already been freed. In the best case, the
707 * hardware will execute it, and the event handler will
708 * ignore the completion event for that TD, since it was
709 * removed from the td_list for that endpoint. In
710 * short, don't muck with the stream ID after
713 xhci_warn(xhci, "WARN Cancelled URB %p "
714 "has invalid stream ID %u.\n",
716 cur_td->urb->stream_id);
717 goto remove_finished_td;
720 * If we stopped on the TD we need to cancel, then we have to
721 * move the xHC endpoint ring dequeue pointer past this TD.
723 if (cur_td == ep->stopped_td)
724 xhci_find_new_dequeue_state(xhci, slot_id, ep_index,
725 cur_td->urb->stream_id,
728 td_to_noop(xhci, ep_ring, cur_td, false);
731 * The event handler won't see a completion for this TD anymore,
732 * so remove it from the endpoint ring's TD list. Keep it in
733 * the cancelled TD list for URB completion later.
735 list_del_init(&cur_td->td_list);
737 last_unlinked_td = cur_td;
738 xhci_stop_watchdog_timer_in_irq(xhci, ep);
740 /* If necessary, queue a Set Transfer Ring Dequeue Pointer command */
741 if (deq_state.new_deq_ptr && deq_state.new_deq_seg) {
742 xhci_queue_new_dequeue_state(xhci,
744 ep->stopped_td->urb->stream_id,
746 xhci_ring_cmd_db(xhci);
748 /* Otherwise ring the doorbell(s) to restart queued transfers */
749 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
751 ep->stopped_td = NULL;
752 ep->stopped_trb = NULL;
755 * Drop the lock and complete the URBs in the cancelled TD list.
756 * New TDs to be cancelled might be added to the end of the list before
757 * we can complete all the URBs for the TDs we already unlinked.
758 * So stop when we've completed the URB for the last TD we unlinked.
761 cur_td = list_entry(ep->cancelled_td_list.next,
762 struct xhci_td, cancelled_td_list);
763 list_del_init(&cur_td->cancelled_td_list);
765 /* Clean up the cancelled URB */
766 /* Doesn't matter what we pass for status, since the core will
767 * just overwrite it (because the URB has been unlinked).
769 xhci_giveback_urb_in_irq(xhci, cur_td, 0, "cancelled");
771 /* Stop processing the cancelled list if the watchdog timer is
774 if (xhci->xhc_state & XHCI_STATE_DYING)
776 } while (cur_td != last_unlinked_td);
778 /* Return to the event handler with xhci->lock re-acquired */
781 /* Watchdog timer function for when a stop endpoint command fails to complete.
782 * In this case, we assume the host controller is broken or dying or dead. The
783 * host may still be completing some other events, so we have to be careful to
784 * let the event ring handler and the URB dequeueing/enqueueing functions know
785 * through xhci->state.
787 * The timer may also fire if the host takes a very long time to respond to the
788 * command, and the stop endpoint command completion handler cannot delete the
789 * timer before the timer function is called. Another endpoint cancellation may
790 * sneak in before the timer function can grab the lock, and that may queue
791 * another stop endpoint command and add the timer back. So we cannot use a
792 * simple flag to say whether there is a pending stop endpoint command for a
793 * particular endpoint.
795 * Instead we use a combination of that flag and a counter for the number of
796 * pending stop endpoint commands. If the timer is the tail end of the last
797 * stop endpoint command, and the endpoint's command is still pending, we assume
800 void xhci_stop_endpoint_command_watchdog(unsigned long arg)
802 struct xhci_hcd *xhci;
803 struct xhci_virt_ep *ep;
804 struct xhci_virt_ep *temp_ep;
805 struct xhci_ring *ring;
806 struct xhci_td *cur_td;
810 ep = (struct xhci_virt_ep *) arg;
813 spin_lock_irqsave(&xhci->lock, flags);
815 ep->stop_cmds_pending--;
816 if (xhci->xhc_state & XHCI_STATE_DYING) {
817 xhci_dbg(xhci, "Stop EP timer ran, but another timer marked "
818 "xHCI as DYING, exiting.\n");
819 spin_unlock_irqrestore(&xhci->lock, flags);
822 if (!(ep->stop_cmds_pending == 0 && (ep->ep_state & EP_HALT_PENDING))) {
823 xhci_dbg(xhci, "Stop EP timer ran, but no command pending, "
825 spin_unlock_irqrestore(&xhci->lock, flags);
829 xhci_warn(xhci, "xHCI host not responding to stop endpoint command.\n");
830 xhci_warn(xhci, "Assuming host is dying, halting host.\n");
831 /* Oops, HC is dead or dying or at least not responding to the stop
834 xhci->xhc_state |= XHCI_STATE_DYING;
835 /* Disable interrupts from the host controller and start halting it */
837 spin_unlock_irqrestore(&xhci->lock, flags);
839 ret = xhci_halt(xhci);
841 spin_lock_irqsave(&xhci->lock, flags);
843 /* This is bad; the host is not responding to commands and it's
844 * not allowing itself to be halted. At least interrupts are
845 * disabled. If we call usb_hc_died(), it will attempt to
846 * disconnect all device drivers under this host. Those
847 * disconnect() methods will wait for all URBs to be unlinked,
848 * so we must complete them.
850 xhci_warn(xhci, "Non-responsive xHCI host is not halting.\n");
851 xhci_warn(xhci, "Completing active URBs anyway.\n");
852 /* We could turn all TDs on the rings to no-ops. This won't
853 * help if the host has cached part of the ring, and is slow if
854 * we want to preserve the cycle bit. Skip it and hope the host
855 * doesn't touch the memory.
858 for (i = 0; i < MAX_HC_SLOTS; i++) {
861 for (j = 0; j < 31; j++) {
862 temp_ep = &xhci->devs[i]->eps[j];
863 ring = temp_ep->ring;
866 xhci_dbg(xhci, "Killing URBs for slot ID %u, "
867 "ep index %u\n", i, j);
868 while (!list_empty(&ring->td_list)) {
869 cur_td = list_first_entry(&ring->td_list,
872 list_del_init(&cur_td->td_list);
873 if (!list_empty(&cur_td->cancelled_td_list))
874 list_del_init(&cur_td->cancelled_td_list);
875 xhci_giveback_urb_in_irq(xhci, cur_td,
876 -ESHUTDOWN, "killed");
878 while (!list_empty(&temp_ep->cancelled_td_list)) {
879 cur_td = list_first_entry(
880 &temp_ep->cancelled_td_list,
883 list_del_init(&cur_td->cancelled_td_list);
884 xhci_giveback_urb_in_irq(xhci, cur_td,
885 -ESHUTDOWN, "killed");
889 spin_unlock_irqrestore(&xhci->lock, flags);
890 xhci_dbg(xhci, "Calling usb_hc_died()\n");
891 usb_hc_died(xhci_to_hcd(xhci)->primary_hcd);
892 xhci_dbg(xhci, "xHCI host controller is dead.\n");
896 * When we get a completion for a Set Transfer Ring Dequeue Pointer command,
897 * we need to clear the set deq pending flag in the endpoint ring state, so that
898 * the TD queueing code can ring the doorbell again. We also need to ring the
899 * endpoint doorbell to restart the ring, but only if there aren't more
900 * cancellations pending.
902 static void handle_set_deq_completion(struct xhci_hcd *xhci,
903 struct xhci_event_cmd *event,
906 unsigned int slot_id;
907 unsigned int ep_index;
908 unsigned int stream_id;
909 struct xhci_ring *ep_ring;
910 struct xhci_virt_device *dev;
911 struct xhci_ep_ctx *ep_ctx;
912 struct xhci_slot_ctx *slot_ctx;
914 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(trb->generic.field[3]));
915 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
916 stream_id = TRB_TO_STREAM_ID(le32_to_cpu(trb->generic.field[2]));
917 dev = xhci->devs[slot_id];
919 ep_ring = xhci_stream_id_to_ring(dev, ep_index, stream_id);
921 xhci_warn(xhci, "WARN Set TR deq ptr command for "
922 "freed stream ID %u\n",
924 /* XXX: Harmless??? */
925 dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
929 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
930 slot_ctx = xhci_get_slot_ctx(xhci, dev->out_ctx);
932 if (GET_COMP_CODE(le32_to_cpu(event->status)) != COMP_SUCCESS) {
933 unsigned int ep_state;
934 unsigned int slot_state;
936 switch (GET_COMP_CODE(le32_to_cpu(event->status))) {
938 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd invalid because "
939 "of stream ID configuration\n");
942 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed due "
943 "to incorrect slot or ep state.\n");
944 ep_state = le32_to_cpu(ep_ctx->ep_info);
945 ep_state &= EP_STATE_MASK;
946 slot_state = le32_to_cpu(slot_ctx->dev_state);
947 slot_state = GET_SLOT_STATE(slot_state);
948 xhci_dbg(xhci, "Slot state = %u, EP state = %u\n",
949 slot_state, ep_state);
952 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed because "
953 "slot %u was not enabled.\n", slot_id);
956 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd with unknown "
957 "completion code of %u.\n",
958 GET_COMP_CODE(le32_to_cpu(event->status)));
961 /* OK what do we do now? The endpoint state is hosed, and we
962 * should never get to this point if the synchronization between
963 * queueing, and endpoint state are correct. This might happen
964 * if the device gets disconnected after we've finished
965 * cancelling URBs, which might not be an error...
968 xhci_dbg(xhci, "Successful Set TR Deq Ptr cmd, deq = @%08llx\n",
969 le64_to_cpu(ep_ctx->deq));
970 if (xhci_trb_virt_to_dma(dev->eps[ep_index].queued_deq_seg,
971 dev->eps[ep_index].queued_deq_ptr) ==
972 (le64_to_cpu(ep_ctx->deq) & ~(EP_CTX_CYCLE_MASK))) {
973 /* Update the ring's dequeue segment and dequeue pointer
974 * to reflect the new position.
976 ep_ring->deq_seg = dev->eps[ep_index].queued_deq_seg;
977 ep_ring->dequeue = dev->eps[ep_index].queued_deq_ptr;
979 xhci_warn(xhci, "Mismatch between completed Set TR Deq "
980 "Ptr command & xHCI internal state.\n");
981 xhci_warn(xhci, "ep deq seg = %p, deq ptr = %p\n",
982 dev->eps[ep_index].queued_deq_seg,
983 dev->eps[ep_index].queued_deq_ptr);
987 dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
988 dev->eps[ep_index].queued_deq_seg = NULL;
989 dev->eps[ep_index].queued_deq_ptr = NULL;
990 /* Restart any rings with pending URBs */
991 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
994 static void handle_reset_ep_completion(struct xhci_hcd *xhci,
995 struct xhci_event_cmd *event,
999 unsigned int ep_index;
1001 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(trb->generic.field[3]));
1002 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
1003 /* This command will only fail if the endpoint wasn't halted,
1004 * but we don't care.
1006 xhci_dbg(xhci, "Ignoring reset ep completion code of %u\n",
1007 GET_COMP_CODE(le32_to_cpu(event->status)));
1009 /* HW with the reset endpoint quirk needs to have a configure endpoint
1010 * command complete before the endpoint can be used. Queue that here
1011 * because the HW can't handle two commands being queued in a row.
1013 if (xhci->quirks & XHCI_RESET_EP_QUIRK) {
1014 xhci_dbg(xhci, "Queueing configure endpoint command\n");
1015 xhci_queue_configure_endpoint(xhci,
1016 xhci->devs[slot_id]->in_ctx->dma, slot_id,
1018 xhci_ring_cmd_db(xhci);
1020 /* Clear our internal halted state and restart the ring(s) */
1021 xhci->devs[slot_id]->eps[ep_index].ep_state &= ~EP_HALTED;
1022 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1026 /* Check to see if a command in the device's command queue matches this one.
1027 * Signal the completion or free the command, and return 1. Return 0 if the
1028 * completed command isn't at the head of the command list.
1030 static int handle_cmd_in_cmd_wait_list(struct xhci_hcd *xhci,
1031 struct xhci_virt_device *virt_dev,
1032 struct xhci_event_cmd *event)
1034 struct xhci_command *command;
1036 if (list_empty(&virt_dev->cmd_list))
1039 command = list_entry(virt_dev->cmd_list.next,
1040 struct xhci_command, cmd_list);
1041 if (xhci->cmd_ring->dequeue != command->command_trb)
1044 command->status = GET_COMP_CODE(le32_to_cpu(event->status));
1045 list_del(&command->cmd_list);
1046 if (command->completion)
1047 complete(command->completion);
1049 xhci_free_command(xhci, command);
1053 static void handle_cmd_completion(struct xhci_hcd *xhci,
1054 struct xhci_event_cmd *event)
1056 int slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1058 dma_addr_t cmd_dequeue_dma;
1059 struct xhci_input_control_ctx *ctrl_ctx;
1060 struct xhci_virt_device *virt_dev;
1061 unsigned int ep_index;
1062 struct xhci_ring *ep_ring;
1063 unsigned int ep_state;
1065 cmd_dma = le64_to_cpu(event->cmd_trb);
1066 cmd_dequeue_dma = xhci_trb_virt_to_dma(xhci->cmd_ring->deq_seg,
1067 xhci->cmd_ring->dequeue);
1068 /* Is the command ring deq ptr out of sync with the deq seg ptr? */
1069 if (cmd_dequeue_dma == 0) {
1070 xhci->error_bitmask |= 1 << 4;
1073 /* Does the DMA address match our internal dequeue pointer address? */
1074 if (cmd_dma != (u64) cmd_dequeue_dma) {
1075 xhci->error_bitmask |= 1 << 5;
1078 switch (le32_to_cpu(xhci->cmd_ring->dequeue->generic.field[3])
1079 & TRB_TYPE_BITMASK) {
1080 case TRB_TYPE(TRB_ENABLE_SLOT):
1081 if (GET_COMP_CODE(le32_to_cpu(event->status)) == COMP_SUCCESS)
1082 xhci->slot_id = slot_id;
1085 complete(&xhci->addr_dev);
1087 case TRB_TYPE(TRB_DISABLE_SLOT):
1088 if (xhci->devs[slot_id]) {
1089 if (xhci->quirks & XHCI_EP_LIMIT_QUIRK)
1090 /* Delete default control endpoint resources */
1091 xhci_free_device_endpoint_resources(xhci,
1092 xhci->devs[slot_id], true);
1093 xhci_free_virt_device(xhci, slot_id);
1096 case TRB_TYPE(TRB_CONFIG_EP):
1097 virt_dev = xhci->devs[slot_id];
1098 if (handle_cmd_in_cmd_wait_list(xhci, virt_dev, event))
1101 * Configure endpoint commands can come from the USB core
1102 * configuration or alt setting changes, or because the HW
1103 * needed an extra configure endpoint command after a reset
1104 * endpoint command or streams were being configured.
1105 * If the command was for a halted endpoint, the xHCI driver
1106 * is not waiting on the configure endpoint command.
1108 ctrl_ctx = xhci_get_input_control_ctx(xhci,
1110 /* Input ctx add_flags are the endpoint index plus one */
1111 ep_index = xhci_last_valid_endpoint(le32_to_cpu(ctrl_ctx->add_flags)) - 1;
1112 /* A usb_set_interface() call directly after clearing a halted
1113 * condition may race on this quirky hardware. Not worth
1114 * worrying about, since this is prototype hardware. Not sure
1115 * if this will work for streams, but streams support was
1116 * untested on this prototype.
1118 if (xhci->quirks & XHCI_RESET_EP_QUIRK &&
1119 ep_index != (unsigned int) -1 &&
1120 le32_to_cpu(ctrl_ctx->add_flags) - SLOT_FLAG ==
1121 le32_to_cpu(ctrl_ctx->drop_flags)) {
1122 ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
1123 ep_state = xhci->devs[slot_id]->eps[ep_index].ep_state;
1124 if (!(ep_state & EP_HALTED))
1125 goto bandwidth_change;
1126 xhci_dbg(xhci, "Completed config ep cmd - "
1127 "last ep index = %d, state = %d\n",
1128 ep_index, ep_state);
1129 /* Clear internal halted state and restart ring(s) */
1130 xhci->devs[slot_id]->eps[ep_index].ep_state &=
1132 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1136 xhci_dbg(xhci, "Completed config ep cmd\n");
1137 xhci->devs[slot_id]->cmd_status =
1138 GET_COMP_CODE(le32_to_cpu(event->status));
1139 complete(&xhci->devs[slot_id]->cmd_completion);
1141 case TRB_TYPE(TRB_EVAL_CONTEXT):
1142 virt_dev = xhci->devs[slot_id];
1143 if (handle_cmd_in_cmd_wait_list(xhci, virt_dev, event))
1145 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(le32_to_cpu(event->status));
1146 complete(&xhci->devs[slot_id]->cmd_completion);
1148 case TRB_TYPE(TRB_ADDR_DEV):
1149 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(le32_to_cpu(event->status));
1150 complete(&xhci->addr_dev);
1152 case TRB_TYPE(TRB_STOP_RING):
1153 handle_stopped_endpoint(xhci, xhci->cmd_ring->dequeue, event);
1155 case TRB_TYPE(TRB_SET_DEQ):
1156 handle_set_deq_completion(xhci, event, xhci->cmd_ring->dequeue);
1158 case TRB_TYPE(TRB_CMD_NOOP):
1160 case TRB_TYPE(TRB_RESET_EP):
1161 handle_reset_ep_completion(xhci, event, xhci->cmd_ring->dequeue);
1163 case TRB_TYPE(TRB_RESET_DEV):
1164 xhci_dbg(xhci, "Completed reset device command.\n");
1165 slot_id = TRB_TO_SLOT_ID(
1166 le32_to_cpu(xhci->cmd_ring->dequeue->generic.field[3]));
1167 virt_dev = xhci->devs[slot_id];
1169 handle_cmd_in_cmd_wait_list(xhci, virt_dev, event);
1171 xhci_warn(xhci, "Reset device command completion "
1172 "for disabled slot %u\n", slot_id);
1174 case TRB_TYPE(TRB_NEC_GET_FW):
1175 if (!(xhci->quirks & XHCI_NEC_HOST)) {
1176 xhci->error_bitmask |= 1 << 6;
1179 xhci_dbg(xhci, "NEC firmware version %2x.%02x\n",
1180 NEC_FW_MAJOR(le32_to_cpu(event->status)),
1181 NEC_FW_MINOR(le32_to_cpu(event->status)));
1184 /* Skip over unknown commands on the event ring */
1185 xhci->error_bitmask |= 1 << 6;
1188 inc_deq(xhci, xhci->cmd_ring, false);
1191 static void handle_vendor_event(struct xhci_hcd *xhci,
1192 union xhci_trb *event)
1196 trb_type = TRB_FIELD_TO_TYPE(le32_to_cpu(event->generic.field[3]));
1197 xhci_dbg(xhci, "Vendor specific event TRB type = %u\n", trb_type);
1198 if (trb_type == TRB_NEC_CMD_COMP && (xhci->quirks & XHCI_NEC_HOST))
1199 handle_cmd_completion(xhci, &event->event_cmd);
1202 /* @port_id: the one-based port ID from the hardware (indexed from array of all
1203 * port registers -- USB 3.0 and USB 2.0).
1205 * Returns a zero-based port number, which is suitable for indexing into each of
1206 * the split roothubs' port arrays and bus state arrays.
1207 * Add one to it in order to call xhci_find_slot_id_by_port.
1209 static unsigned int find_faked_portnum_from_hw_portnum(struct usb_hcd *hcd,
1210 struct xhci_hcd *xhci, u32 port_id)
1213 unsigned int num_similar_speed_ports = 0;
1215 /* port_id from the hardware is 1-based, but port_array[], usb3_ports[],
1216 * and usb2_ports are 0-based indexes. Count the number of similar
1217 * speed ports, up to 1 port before this port.
1219 for (i = 0; i < (port_id - 1); i++) {
1220 u8 port_speed = xhci->port_array[i];
1223 * Skip ports that don't have known speeds, or have duplicate
1224 * Extended Capabilities port speed entries.
1226 if (port_speed == 0 || port_speed == DUPLICATE_ENTRY)
1230 * USB 3.0 ports are always under a USB 3.0 hub. USB 2.0 and
1231 * 1.1 ports are under the USB 2.0 hub. If the port speed
1232 * matches the device speed, it's a similar speed port.
1234 if ((port_speed == 0x03) == (hcd->speed == HCD_USB3))
1235 num_similar_speed_ports++;
1237 return num_similar_speed_ports;
1240 static void handle_device_notification(struct xhci_hcd *xhci,
1241 union xhci_trb *event)
1245 slot_id = TRB_TO_SLOT_ID(event->generic.field[3]);
1246 if (!xhci->devs[slot_id])
1247 xhci_warn(xhci, "Device Notification event for "
1248 "unused slot %u\n", slot_id);
1250 xhci_dbg(xhci, "Device Notification event for slot ID %u\n",
1252 /* XXX should we kick khubd for the parent hub? It should have send an
1253 * interrupt transfer when the port started signaling resume, so there's
1254 * probably no need to do so.
1258 static void handle_port_status(struct xhci_hcd *xhci,
1259 union xhci_trb *event)
1261 struct usb_hcd *hcd;
1266 unsigned int faked_port_index;
1268 struct xhci_bus_state *bus_state;
1269 __le32 __iomem **port_array;
1270 bool bogus_port_status = false;
1272 /* Port status change events always have a successful completion code */
1273 if (GET_COMP_CODE(le32_to_cpu(event->generic.field[2])) != COMP_SUCCESS) {
1274 xhci_warn(xhci, "WARN: xHC returned failed port status event\n");
1275 xhci->error_bitmask |= 1 << 8;
1277 port_id = GET_PORT_ID(le32_to_cpu(event->generic.field[0]));
1278 xhci_dbg(xhci, "Port Status Change Event for port %d\n", port_id);
1280 max_ports = HCS_MAX_PORTS(xhci->hcs_params1);
1281 if ((port_id <= 0) || (port_id > max_ports)) {
1282 xhci_warn(xhci, "Invalid port id %d\n", port_id);
1283 bogus_port_status = true;
1287 /* Figure out which usb_hcd this port is attached to:
1288 * is it a USB 3.0 port or a USB 2.0/1.1 port?
1290 major_revision = xhci->port_array[port_id - 1];
1291 if (major_revision == 0) {
1292 xhci_warn(xhci, "Event for port %u not in "
1293 "Extended Capabilities, ignoring.\n",
1295 bogus_port_status = true;
1298 if (major_revision == DUPLICATE_ENTRY) {
1299 xhci_warn(xhci, "Event for port %u duplicated in"
1300 "Extended Capabilities, ignoring.\n",
1302 bogus_port_status = true;
1307 * Hardware port IDs reported by a Port Status Change Event include USB
1308 * 3.0 and USB 2.0 ports. We want to check if the port has reported a
1309 * resume event, but we first need to translate the hardware port ID
1310 * into the index into the ports on the correct split roothub, and the
1311 * correct bus_state structure.
1313 /* Find the right roothub. */
1314 hcd = xhci_to_hcd(xhci);
1315 if ((major_revision == 0x03) != (hcd->speed == HCD_USB3))
1316 hcd = xhci->shared_hcd;
1317 bus_state = &xhci->bus_state[hcd_index(hcd)];
1318 if (hcd->speed == HCD_USB3)
1319 port_array = xhci->usb3_ports;
1321 port_array = xhci->usb2_ports;
1322 /* Find the faked port hub number */
1323 faked_port_index = find_faked_portnum_from_hw_portnum(hcd, xhci,
1326 temp = xhci_readl(xhci, port_array[faked_port_index]);
1327 if (hcd->state == HC_STATE_SUSPENDED) {
1328 xhci_dbg(xhci, "resume root hub\n");
1329 usb_hcd_resume_root_hub(hcd);
1332 if ((temp & PORT_PLC) && (temp & PORT_PLS_MASK) == XDEV_RESUME) {
1333 xhci_dbg(xhci, "port resume event for port %d\n", port_id);
1335 temp1 = xhci_readl(xhci, &xhci->op_regs->command);
1336 if (!(temp1 & CMD_RUN)) {
1337 xhci_warn(xhci, "xHC is not running.\n");
1341 if (DEV_SUPERSPEED(temp)) {
1342 xhci_dbg(xhci, "remote wake SS port %d\n", port_id);
1343 xhci_test_and_clear_bit(xhci, port_array,
1344 faked_port_index, PORT_PLC);
1345 xhci_set_link_state(xhci, port_array, faked_port_index,
1347 /* Need to wait until the next link state change
1348 * indicates the device is actually in U0.
1350 bogus_port_status = true;
1353 xhci_dbg(xhci, "resume HS port %d\n", port_id);
1354 bus_state->resume_done[faked_port_index] = jiffies +
1355 msecs_to_jiffies(20);
1356 mod_timer(&hcd->rh_timer,
1357 bus_state->resume_done[faked_port_index]);
1358 /* Do the rest in GetPortStatus */
1362 if ((temp & PORT_PLC) && (temp & PORT_PLS_MASK) == XDEV_U0 &&
1363 DEV_SUPERSPEED(temp)) {
1364 xhci_dbg(xhci, "resume SS port %d finished\n", port_id);
1365 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1366 faked_port_index + 1);
1367 if (slot_id && xhci->devs[slot_id])
1368 xhci_ring_device(xhci, slot_id);
1371 if (hcd->speed != HCD_USB3)
1372 xhci_test_and_clear_bit(xhci, port_array, faked_port_index,
1376 /* Update event ring dequeue pointer before dropping the lock */
1377 inc_deq(xhci, xhci->event_ring, true);
1379 /* Don't make the USB core poll the roothub if we got a bad port status
1380 * change event. Besides, at that point we can't tell which roothub
1381 * (USB 2.0 or USB 3.0) to kick.
1383 if (bogus_port_status)
1386 spin_unlock(&xhci->lock);
1387 /* Pass this up to the core */
1388 usb_hcd_poll_rh_status(hcd);
1389 spin_lock(&xhci->lock);
1393 * This TD is defined by the TRBs starting at start_trb in start_seg and ending
1394 * at end_trb, which may be in another segment. If the suspect DMA address is a
1395 * TRB in this TD, this function returns that TRB's segment. Otherwise it
1398 struct xhci_segment *trb_in_td(struct xhci_segment *start_seg,
1399 union xhci_trb *start_trb,
1400 union xhci_trb *end_trb,
1401 dma_addr_t suspect_dma)
1403 dma_addr_t start_dma;
1404 dma_addr_t end_seg_dma;
1405 dma_addr_t end_trb_dma;
1406 struct xhci_segment *cur_seg;
1408 start_dma = xhci_trb_virt_to_dma(start_seg, start_trb);
1409 cur_seg = start_seg;
1414 /* We may get an event for a Link TRB in the middle of a TD */
1415 end_seg_dma = xhci_trb_virt_to_dma(cur_seg,
1416 &cur_seg->trbs[TRBS_PER_SEGMENT - 1]);
1417 /* If the end TRB isn't in this segment, this is set to 0 */
1418 end_trb_dma = xhci_trb_virt_to_dma(cur_seg, end_trb);
1420 if (end_trb_dma > 0) {
1421 /* The end TRB is in this segment, so suspect should be here */
1422 if (start_dma <= end_trb_dma) {
1423 if (suspect_dma >= start_dma && suspect_dma <= end_trb_dma)
1426 /* Case for one segment with
1427 * a TD wrapped around to the top
1429 if ((suspect_dma >= start_dma &&
1430 suspect_dma <= end_seg_dma) ||
1431 (suspect_dma >= cur_seg->dma &&
1432 suspect_dma <= end_trb_dma))
1437 /* Might still be somewhere in this segment */
1438 if (suspect_dma >= start_dma && suspect_dma <= end_seg_dma)
1441 cur_seg = cur_seg->next;
1442 start_dma = xhci_trb_virt_to_dma(cur_seg, &cur_seg->trbs[0]);
1443 } while (cur_seg != start_seg);
1448 static void xhci_cleanup_halted_endpoint(struct xhci_hcd *xhci,
1449 unsigned int slot_id, unsigned int ep_index,
1450 unsigned int stream_id,
1451 struct xhci_td *td, union xhci_trb *event_trb)
1453 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
1454 ep->ep_state |= EP_HALTED;
1455 ep->stopped_td = td;
1456 ep->stopped_trb = event_trb;
1457 ep->stopped_stream = stream_id;
1459 xhci_queue_reset_ep(xhci, slot_id, ep_index);
1460 xhci_cleanup_stalled_ring(xhci, td->urb->dev, ep_index);
1462 ep->stopped_td = NULL;
1463 ep->stopped_trb = NULL;
1464 ep->stopped_stream = 0;
1466 xhci_ring_cmd_db(xhci);
1469 /* Check if an error has halted the endpoint ring. The class driver will
1470 * cleanup the halt for a non-default control endpoint if we indicate a stall.
1471 * However, a babble and other errors also halt the endpoint ring, and the class
1472 * driver won't clear the halt in that case, so we need to issue a Set Transfer
1473 * Ring Dequeue Pointer command manually.
1475 static int xhci_requires_manual_halt_cleanup(struct xhci_hcd *xhci,
1476 struct xhci_ep_ctx *ep_ctx,
1477 unsigned int trb_comp_code)
1479 /* TRB completion codes that may require a manual halt cleanup */
1480 if (trb_comp_code == COMP_TX_ERR ||
1481 trb_comp_code == COMP_BABBLE ||
1482 trb_comp_code == COMP_SPLIT_ERR)
1483 /* The 0.96 spec says a babbling control endpoint
1484 * is not halted. The 0.96 spec says it is. Some HW
1485 * claims to be 0.95 compliant, but it halts the control
1486 * endpoint anyway. Check if a babble halted the
1489 if ((ep_ctx->ep_info & cpu_to_le32(EP_STATE_MASK)) ==
1490 cpu_to_le32(EP_STATE_HALTED))
1496 int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code)
1498 if (trb_comp_code >= 224 && trb_comp_code <= 255) {
1499 /* Vendor defined "informational" completion code,
1500 * treat as not-an-error.
1502 xhci_dbg(xhci, "Vendor defined info completion code %u\n",
1504 xhci_dbg(xhci, "Treating code as success.\n");
1511 * Finish the td processing, remove the td from td list;
1512 * Return 1 if the urb can be given back.
1514 static int finish_td(struct xhci_hcd *xhci, struct xhci_td *td,
1515 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1516 struct xhci_virt_ep *ep, int *status, bool skip)
1518 struct xhci_virt_device *xdev;
1519 struct xhci_ring *ep_ring;
1520 unsigned int slot_id;
1522 struct urb *urb = NULL;
1523 struct xhci_ep_ctx *ep_ctx;
1525 struct urb_priv *urb_priv;
1528 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1529 xdev = xhci->devs[slot_id];
1530 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
1531 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
1532 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1533 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
1538 if (trb_comp_code == COMP_STOP_INVAL ||
1539 trb_comp_code == COMP_STOP) {
1540 /* The Endpoint Stop Command completion will take care of any
1541 * stopped TDs. A stopped TD may be restarted, so don't update
1542 * the ring dequeue pointer or take this TD off any lists yet.
1544 ep->stopped_td = td;
1545 ep->stopped_trb = event_trb;
1548 if (trb_comp_code == COMP_STALL) {
1549 /* The transfer is completed from the driver's
1550 * perspective, but we need to issue a set dequeue
1551 * command for this stalled endpoint to move the dequeue
1552 * pointer past the TD. We can't do that here because
1553 * the halt condition must be cleared first. Let the
1554 * USB class driver clear the stall later.
1556 ep->stopped_td = td;
1557 ep->stopped_trb = event_trb;
1558 ep->stopped_stream = ep_ring->stream_id;
1559 } else if (xhci_requires_manual_halt_cleanup(xhci,
1560 ep_ctx, trb_comp_code)) {
1561 /* Other types of errors halt the endpoint, but the
1562 * class driver doesn't call usb_reset_endpoint() unless
1563 * the error is -EPIPE. Clear the halted status in the
1564 * xHCI hardware manually.
1566 xhci_cleanup_halted_endpoint(xhci,
1567 slot_id, ep_index, ep_ring->stream_id,
1570 /* Update ring dequeue pointer */
1571 while (ep_ring->dequeue != td->last_trb)
1572 inc_deq(xhci, ep_ring, false);
1573 inc_deq(xhci, ep_ring, false);
1577 /* Clean up the endpoint's TD list */
1579 urb_priv = urb->hcpriv;
1581 /* Do one last check of the actual transfer length.
1582 * If the host controller said we transferred more data than
1583 * the buffer length, urb->actual_length will be a very big
1584 * number (since it's unsigned). Play it safe and say we didn't
1585 * transfer anything.
1587 if (urb->actual_length > urb->transfer_buffer_length) {
1588 xhci_warn(xhci, "URB transfer length is wrong, "
1589 "xHC issue? req. len = %u, "
1591 urb->transfer_buffer_length,
1592 urb->actual_length);
1593 urb->actual_length = 0;
1594 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1595 *status = -EREMOTEIO;
1599 list_del_init(&td->td_list);
1600 /* Was this TD slated to be cancelled but completed anyway? */
1601 if (!list_empty(&td->cancelled_td_list))
1602 list_del_init(&td->cancelled_td_list);
1605 /* Giveback the urb when all the tds are completed */
1606 if (urb_priv->td_cnt == urb_priv->length) {
1608 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
1609 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs--;
1610 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs
1612 if (xhci->quirks & XHCI_AMD_PLL_FIX)
1613 usb_amd_quirk_pll_enable();
1623 * Process control tds, update urb status and actual_length.
1625 static int process_ctrl_td(struct xhci_hcd *xhci, struct xhci_td *td,
1626 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1627 struct xhci_virt_ep *ep, int *status)
1629 struct xhci_virt_device *xdev;
1630 struct xhci_ring *ep_ring;
1631 unsigned int slot_id;
1633 struct xhci_ep_ctx *ep_ctx;
1636 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1637 xdev = xhci->devs[slot_id];
1638 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
1639 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
1640 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1641 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
1643 switch (trb_comp_code) {
1645 if (event_trb == ep_ring->dequeue) {
1646 xhci_warn(xhci, "WARN: Success on ctrl setup TRB "
1647 "without IOC set??\n");
1648 *status = -ESHUTDOWN;
1649 } else if (event_trb != td->last_trb) {
1650 xhci_warn(xhci, "WARN: Success on ctrl data TRB "
1651 "without IOC set??\n");
1652 *status = -ESHUTDOWN;
1658 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1659 *status = -EREMOTEIO;
1663 case COMP_STOP_INVAL:
1665 return finish_td(xhci, td, event_trb, event, ep, status, false);
1667 if (!xhci_requires_manual_halt_cleanup(xhci,
1668 ep_ctx, trb_comp_code))
1670 xhci_dbg(xhci, "TRB error code %u, "
1671 "halted endpoint index = %u\n",
1672 trb_comp_code, ep_index);
1673 /* else fall through */
1675 /* Did we transfer part of the data (middle) phase? */
1676 if (event_trb != ep_ring->dequeue &&
1677 event_trb != td->last_trb)
1678 td->urb->actual_length =
1679 td->urb->transfer_buffer_length
1680 - TRB_LEN(le32_to_cpu(event->transfer_len));
1682 td->urb->actual_length = 0;
1684 xhci_cleanup_halted_endpoint(xhci,
1685 slot_id, ep_index, 0, td, event_trb);
1686 return finish_td(xhci, td, event_trb, event, ep, status, true);
1689 * Did we transfer any data, despite the errors that might have
1690 * happened? I.e. did we get past the setup stage?
1692 if (event_trb != ep_ring->dequeue) {
1693 /* The event was for the status stage */
1694 if (event_trb == td->last_trb) {
1695 if (td->urb->actual_length != 0) {
1696 /* Don't overwrite a previously set error code
1698 if ((*status == -EINPROGRESS || *status == 0) &&
1699 (td->urb->transfer_flags
1700 & URB_SHORT_NOT_OK))
1701 /* Did we already see a short data
1703 *status = -EREMOTEIO;
1705 td->urb->actual_length =
1706 td->urb->transfer_buffer_length;
1709 /* Maybe the event was for the data stage? */
1710 td->urb->actual_length =
1711 td->urb->transfer_buffer_length -
1712 TRB_LEN(le32_to_cpu(event->transfer_len));
1713 xhci_dbg(xhci, "Waiting for status "
1719 return finish_td(xhci, td, event_trb, event, ep, status, false);
1723 * Process isochronous tds, update urb packet status and actual_length.
1725 static int process_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
1726 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1727 struct xhci_virt_ep *ep, int *status)
1729 struct xhci_ring *ep_ring;
1730 struct urb_priv *urb_priv;
1733 union xhci_trb *cur_trb;
1734 struct xhci_segment *cur_seg;
1735 struct usb_iso_packet_descriptor *frame;
1737 bool skip_td = false;
1739 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
1740 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
1741 urb_priv = td->urb->hcpriv;
1742 idx = urb_priv->td_cnt;
1743 frame = &td->urb->iso_frame_desc[idx];
1745 /* handle completion code */
1746 switch (trb_comp_code) {
1751 frame->status = td->urb->transfer_flags & URB_SHORT_NOT_OK ?
1755 frame->status = -ECOMM;
1758 case COMP_BUFF_OVER:
1760 frame->status = -EOVERFLOW;
1765 frame->status = -EPROTO;
1769 case COMP_STOP_INVAL:
1776 if (trb_comp_code == COMP_SUCCESS || skip_td) {
1777 frame->actual_length = frame->length;
1778 td->urb->actual_length += frame->length;
1780 for (cur_trb = ep_ring->dequeue,
1781 cur_seg = ep_ring->deq_seg; cur_trb != event_trb;
1782 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
1783 if (!TRB_TYPE_NOOP_LE32(cur_trb->generic.field[3]) &&
1784 !TRB_TYPE_LINK_LE32(cur_trb->generic.field[3]))
1785 len += TRB_LEN(le32_to_cpu(cur_trb->generic.field[2]));
1787 len += TRB_LEN(le32_to_cpu(cur_trb->generic.field[2])) -
1788 TRB_LEN(le32_to_cpu(event->transfer_len));
1790 if (trb_comp_code != COMP_STOP_INVAL) {
1791 frame->actual_length = len;
1792 td->urb->actual_length += len;
1796 return finish_td(xhci, td, event_trb, event, ep, status, false);
1799 static int skip_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
1800 struct xhci_transfer_event *event,
1801 struct xhci_virt_ep *ep, int *status)
1803 struct xhci_ring *ep_ring;
1804 struct urb_priv *urb_priv;
1805 struct usb_iso_packet_descriptor *frame;
1808 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
1809 urb_priv = td->urb->hcpriv;
1810 idx = urb_priv->td_cnt;
1811 frame = &td->urb->iso_frame_desc[idx];
1813 /* The transfer is partly done. */
1814 frame->status = -EXDEV;
1816 /* calc actual length */
1817 frame->actual_length = 0;
1819 /* Update ring dequeue pointer */
1820 while (ep_ring->dequeue != td->last_trb)
1821 inc_deq(xhci, ep_ring, false);
1822 inc_deq(xhci, ep_ring, false);
1824 return finish_td(xhci, td, NULL, event, ep, status, true);
1828 * Process bulk and interrupt tds, update urb status and actual_length.
1830 static int process_bulk_intr_td(struct xhci_hcd *xhci, struct xhci_td *td,
1831 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1832 struct xhci_virt_ep *ep, int *status)
1834 struct xhci_ring *ep_ring;
1835 union xhci_trb *cur_trb;
1836 struct xhci_segment *cur_seg;
1839 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
1840 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
1842 switch (trb_comp_code) {
1844 /* Double check that the HW transferred everything. */
1845 if (event_trb != td->last_trb) {
1846 xhci_warn(xhci, "WARN Successful completion "
1848 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1849 *status = -EREMOTEIO;
1857 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1858 *status = -EREMOTEIO;
1863 /* Others already handled above */
1866 if (trb_comp_code == COMP_SHORT_TX)
1867 xhci_dbg(xhci, "ep %#x - asked for %d bytes, "
1868 "%d bytes untransferred\n",
1869 td->urb->ep->desc.bEndpointAddress,
1870 td->urb->transfer_buffer_length,
1871 TRB_LEN(le32_to_cpu(event->transfer_len)));
1872 /* Fast path - was this the last TRB in the TD for this URB? */
1873 if (event_trb == td->last_trb) {
1874 if (TRB_LEN(le32_to_cpu(event->transfer_len)) != 0) {
1875 td->urb->actual_length =
1876 td->urb->transfer_buffer_length -
1877 TRB_LEN(le32_to_cpu(event->transfer_len));
1878 if (td->urb->transfer_buffer_length <
1879 td->urb->actual_length) {
1880 xhci_warn(xhci, "HC gave bad length "
1881 "of %d bytes left\n",
1882 TRB_LEN(le32_to_cpu(event->transfer_len)));
1883 td->urb->actual_length = 0;
1884 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1885 *status = -EREMOTEIO;
1889 /* Don't overwrite a previously set error code */
1890 if (*status == -EINPROGRESS) {
1891 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1892 *status = -EREMOTEIO;
1897 td->urb->actual_length =
1898 td->urb->transfer_buffer_length;
1899 /* Ignore a short packet completion if the
1900 * untransferred length was zero.
1902 if (*status == -EREMOTEIO)
1906 /* Slow path - walk the list, starting from the dequeue
1907 * pointer, to get the actual length transferred.
1909 td->urb->actual_length = 0;
1910 for (cur_trb = ep_ring->dequeue, cur_seg = ep_ring->deq_seg;
1911 cur_trb != event_trb;
1912 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
1913 if (!TRB_TYPE_NOOP_LE32(cur_trb->generic.field[3]) &&
1914 !TRB_TYPE_LINK_LE32(cur_trb->generic.field[3]))
1915 td->urb->actual_length +=
1916 TRB_LEN(le32_to_cpu(cur_trb->generic.field[2]));
1918 /* If the ring didn't stop on a Link or No-op TRB, add
1919 * in the actual bytes transferred from the Normal TRB
1921 if (trb_comp_code != COMP_STOP_INVAL)
1922 td->urb->actual_length +=
1923 TRB_LEN(le32_to_cpu(cur_trb->generic.field[2])) -
1924 TRB_LEN(le32_to_cpu(event->transfer_len));
1927 return finish_td(xhci, td, event_trb, event, ep, status, false);
1931 * If this function returns an error condition, it means it got a Transfer
1932 * event with a corrupted Slot ID, Endpoint ID, or TRB DMA address.
1933 * At this point, the host controller is probably hosed and should be reset.
1935 static int handle_tx_event(struct xhci_hcd *xhci,
1936 struct xhci_transfer_event *event)
1938 struct xhci_virt_device *xdev;
1939 struct xhci_virt_ep *ep;
1940 struct xhci_ring *ep_ring;
1941 unsigned int slot_id;
1943 struct xhci_td *td = NULL;
1944 dma_addr_t event_dma;
1945 struct xhci_segment *event_seg;
1946 union xhci_trb *event_trb;
1947 struct urb *urb = NULL;
1948 int status = -EINPROGRESS;
1949 struct urb_priv *urb_priv;
1950 struct xhci_ep_ctx *ep_ctx;
1951 struct list_head *tmp;
1956 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1957 xdev = xhci->devs[slot_id];
1959 xhci_err(xhci, "ERROR Transfer event pointed to bad slot\n");
1960 xhci_err(xhci, "@%016llx %08x %08x %08x %08x\n",
1961 (unsigned long long) xhci_trb_virt_to_dma(
1962 xhci->event_ring->deq_seg,
1963 xhci->event_ring->dequeue),
1964 lower_32_bits(le64_to_cpu(event->buffer)),
1965 upper_32_bits(le64_to_cpu(event->buffer)),
1966 le32_to_cpu(event->transfer_len),
1967 le32_to_cpu(event->flags));
1968 xhci_dbg(xhci, "Event ring:\n");
1969 xhci_debug_segment(xhci, xhci->event_ring->deq_seg);
1973 /* Endpoint ID is 1 based, our index is zero based */
1974 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
1975 ep = &xdev->eps[ep_index];
1976 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
1977 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1979 (le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK) ==
1980 EP_STATE_DISABLED) {
1981 xhci_err(xhci, "ERROR Transfer event for disabled endpoint "
1982 "or incorrect stream ring\n");
1983 xhci_err(xhci, "@%016llx %08x %08x %08x %08x\n",
1984 (unsigned long long) xhci_trb_virt_to_dma(
1985 xhci->event_ring->deq_seg,
1986 xhci->event_ring->dequeue),
1987 lower_32_bits(le64_to_cpu(event->buffer)),
1988 upper_32_bits(le64_to_cpu(event->buffer)),
1989 le32_to_cpu(event->transfer_len),
1990 le32_to_cpu(event->flags));
1991 xhci_dbg(xhci, "Event ring:\n");
1992 xhci_debug_segment(xhci, xhci->event_ring->deq_seg);
1996 /* Count current td numbers if ep->skip is set */
1998 list_for_each(tmp, &ep_ring->td_list)
2002 event_dma = le64_to_cpu(event->buffer);
2003 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2004 /* Look for common error cases */
2005 switch (trb_comp_code) {
2006 /* Skip codes that require special handling depending on
2013 xhci_dbg(xhci, "Stopped on Transfer TRB\n");
2015 case COMP_STOP_INVAL:
2016 xhci_dbg(xhci, "Stopped on No-op or Link TRB\n");
2019 xhci_dbg(xhci, "Stalled endpoint\n");
2020 ep->ep_state |= EP_HALTED;
2024 xhci_warn(xhci, "WARN: TRB error on endpoint\n");
2027 case COMP_SPLIT_ERR:
2029 xhci_dbg(xhci, "Transfer error on endpoint\n");
2033 xhci_dbg(xhci, "Babble error on endpoint\n");
2034 status = -EOVERFLOW;
2037 xhci_warn(xhci, "WARN: HC couldn't access mem fast enough\n");
2041 xhci_warn(xhci, "WARN: bandwidth overrun event on endpoint\n");
2043 case COMP_BUFF_OVER:
2044 xhci_warn(xhci, "WARN: buffer overrun event on endpoint\n");
2048 * When the Isoch ring is empty, the xHC will generate
2049 * a Ring Overrun Event for IN Isoch endpoint or Ring
2050 * Underrun Event for OUT Isoch endpoint.
2052 xhci_dbg(xhci, "underrun event on endpoint\n");
2053 if (!list_empty(&ep_ring->td_list))
2054 xhci_dbg(xhci, "Underrun Event for slot %d ep %d "
2055 "still with TDs queued?\n",
2056 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2060 xhci_dbg(xhci, "overrun event on endpoint\n");
2061 if (!list_empty(&ep_ring->td_list))
2062 xhci_dbg(xhci, "Overrun Event for slot %d ep %d "
2063 "still with TDs queued?\n",
2064 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2068 xhci_warn(xhci, "WARN: detect an incompatible device");
2071 case COMP_MISSED_INT:
2073 * When encounter missed service error, one or more isoc tds
2074 * may be missed by xHC.
2075 * Set skip flag of the ep_ring; Complete the missed tds as
2076 * short transfer when process the ep_ring next time.
2079 xhci_dbg(xhci, "Miss service interval error, set skip flag\n");
2082 if (xhci_is_vendor_info_code(xhci, trb_comp_code)) {
2086 xhci_warn(xhci, "ERROR Unknown event condition, HC probably "
2092 /* This TRB should be in the TD at the head of this ring's
2095 if (list_empty(&ep_ring->td_list)) {
2096 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d "
2097 "with no TDs queued?\n",
2098 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2100 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n",
2101 (le32_to_cpu(event->flags) &
2102 TRB_TYPE_BITMASK)>>10);
2103 xhci_print_trb_offsets(xhci, (union xhci_trb *) event);
2106 xhci_dbg(xhci, "td_list is empty while skip "
2107 "flag set. Clear skip flag.\n");
2113 /* We've skipped all the TDs on the ep ring when ep->skip set */
2114 if (ep->skip && td_num == 0) {
2116 xhci_dbg(xhci, "All tds on the ep_ring skipped. "
2117 "Clear skip flag.\n");
2122 td = list_entry(ep_ring->td_list.next, struct xhci_td, td_list);
2126 /* Is this a TRB in the currently executing TD? */
2127 event_seg = trb_in_td(ep_ring->deq_seg, ep_ring->dequeue,
2128 td->last_trb, event_dma);
2131 * Skip the Force Stopped Event. The event_trb(event_dma) of FSE
2132 * is not in the current TD pointed by ep_ring->dequeue because
2133 * that the hardware dequeue pointer still at the previous TRB
2134 * of the current TD. The previous TRB maybe a Link TD or the
2135 * last TRB of the previous TD. The command completion handle
2136 * will take care the rest.
2138 if (!event_seg && trb_comp_code == COMP_STOP_INVAL) {
2145 !usb_endpoint_xfer_isoc(&td->urb->ep->desc)) {
2146 /* Some host controllers give a spurious
2147 * successful event after a short transfer.
2150 if ((xhci->quirks & XHCI_SPURIOUS_SUCCESS) &&
2151 ep_ring->last_td_was_short) {
2152 ep_ring->last_td_was_short = false;
2156 /* HC is busted, give up! */
2158 "ERROR Transfer event TRB DMA ptr not "
2159 "part of current TD\n");
2163 ret = skip_isoc_td(xhci, td, event, ep, &status);
2166 if (trb_comp_code == COMP_SHORT_TX)
2167 ep_ring->last_td_was_short = true;
2169 ep_ring->last_td_was_short = false;
2172 xhci_dbg(xhci, "Found td. Clear skip flag.\n");
2176 event_trb = &event_seg->trbs[(event_dma - event_seg->dma) /
2177 sizeof(*event_trb)];
2179 * No-op TRB should not trigger interrupts.
2180 * If event_trb is a no-op TRB, it means the
2181 * corresponding TD has been cancelled. Just ignore
2184 if (TRB_TYPE_NOOP_LE32(event_trb->generic.field[3])) {
2186 "event_trb is a no-op TRB. Skip it\n");
2190 /* Now update the urb's actual_length and give back to
2193 if (usb_endpoint_xfer_control(&td->urb->ep->desc))
2194 ret = process_ctrl_td(xhci, td, event_trb, event, ep,
2196 else if (usb_endpoint_xfer_isoc(&td->urb->ep->desc))
2197 ret = process_isoc_td(xhci, td, event_trb, event, ep,
2200 ret = process_bulk_intr_td(xhci, td, event_trb, event,
2205 * Do not update event ring dequeue pointer if ep->skip is set.
2206 * Will roll back to continue process missed tds.
2208 if (trb_comp_code == COMP_MISSED_INT || !ep->skip) {
2209 inc_deq(xhci, xhci->event_ring, true);
2214 urb_priv = urb->hcpriv;
2215 /* Leave the TD around for the reset endpoint function
2216 * to use(but only if it's not a control endpoint,
2217 * since we already queued the Set TR dequeue pointer
2218 * command for stalled control endpoints).
2220 if (usb_endpoint_xfer_control(&urb->ep->desc) ||
2221 (trb_comp_code != COMP_STALL &&
2222 trb_comp_code != COMP_BABBLE))
2223 xhci_urb_free_priv(xhci, urb_priv);
2225 usb_hcd_unlink_urb_from_ep(bus_to_hcd(urb->dev->bus), urb);
2226 if ((urb->actual_length != urb->transfer_buffer_length &&
2227 (urb->transfer_flags &
2228 URB_SHORT_NOT_OK)) ||
2230 !usb_endpoint_xfer_isoc(&urb->ep->desc)))
2231 xhci_dbg(xhci, "Giveback URB %p, len = %d, "
2232 "expected = %x, status = %d\n",
2233 urb, urb->actual_length,
2234 urb->transfer_buffer_length,
2236 spin_unlock(&xhci->lock);
2237 /* EHCI, UHCI, and OHCI always unconditionally set the
2238 * urb->status of an isochronous endpoint to 0.
2240 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS)
2242 usb_hcd_giveback_urb(bus_to_hcd(urb->dev->bus), urb, status);
2243 spin_lock(&xhci->lock);
2247 * If ep->skip is set, it means there are missed tds on the
2248 * endpoint ring need to take care of.
2249 * Process them as short transfer until reach the td pointed by
2252 } while (ep->skip && trb_comp_code != COMP_MISSED_INT);
2258 * This function handles all OS-owned events on the event ring. It may drop
2259 * xhci->lock between event processing (e.g. to pass up port status changes).
2260 * Returns >0 for "possibly more events to process" (caller should call again),
2261 * otherwise 0 if done. In future, <0 returns should indicate error code.
2263 static int xhci_handle_event(struct xhci_hcd *xhci)
2265 union xhci_trb *event;
2266 int update_ptrs = 1;
2269 if (!xhci->event_ring || !xhci->event_ring->dequeue) {
2270 xhci->error_bitmask |= 1 << 1;
2274 event = xhci->event_ring->dequeue;
2275 /* Does the HC or OS own the TRB? */
2276 if ((le32_to_cpu(event->event_cmd.flags) & TRB_CYCLE) !=
2277 xhci->event_ring->cycle_state) {
2278 xhci->error_bitmask |= 1 << 2;
2283 * Barrier between reading the TRB_CYCLE (valid) flag above and any
2284 * speculative reads of the event's flags/data below.
2287 /* FIXME: Handle more event types. */
2288 switch ((le32_to_cpu(event->event_cmd.flags) & TRB_TYPE_BITMASK)) {
2289 case TRB_TYPE(TRB_COMPLETION):
2290 handle_cmd_completion(xhci, &event->event_cmd);
2292 case TRB_TYPE(TRB_PORT_STATUS):
2293 handle_port_status(xhci, event);
2296 case TRB_TYPE(TRB_TRANSFER):
2297 ret = handle_tx_event(xhci, &event->trans_event);
2299 xhci->error_bitmask |= 1 << 9;
2303 case TRB_TYPE(TRB_DEV_NOTE):
2304 handle_device_notification(xhci, event);
2307 if ((le32_to_cpu(event->event_cmd.flags) & TRB_TYPE_BITMASK) >=
2309 handle_vendor_event(xhci, event);
2311 xhci->error_bitmask |= 1 << 3;
2313 /* Any of the above functions may drop and re-acquire the lock, so check
2314 * to make sure a watchdog timer didn't mark the host as non-responsive.
2316 if (xhci->xhc_state & XHCI_STATE_DYING) {
2317 xhci_dbg(xhci, "xHCI host dying, returning from "
2318 "event handler.\n");
2323 /* Update SW event ring dequeue pointer */
2324 inc_deq(xhci, xhci->event_ring, true);
2326 /* Are there more items on the event ring? Caller will call us again to
2333 * xHCI spec says we can get an interrupt, and if the HC has an error condition,
2334 * we might get bad data out of the event ring. Section 4.10.2.7 has a list of
2335 * indicators of an event TRB error, but we check the status *first* to be safe.
2337 irqreturn_t xhci_irq(struct usb_hcd *hcd)
2339 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
2341 union xhci_trb *trb;
2343 union xhci_trb *event_ring_deq;
2346 spin_lock(&xhci->lock);
2347 trb = xhci->event_ring->dequeue;
2348 /* Check if the xHC generated the interrupt, or the irq is shared */
2349 status = xhci_readl(xhci, &xhci->op_regs->status);
2350 if (status == 0xffffffff)
2353 if (!(status & STS_EINT)) {
2354 spin_unlock(&xhci->lock);
2357 if (status & STS_FATAL) {
2358 xhci_warn(xhci, "WARNING: Host System Error\n");
2361 spin_unlock(&xhci->lock);
2366 * Clear the op reg interrupt status first,
2367 * so we can receive interrupts from other MSI-X interrupters.
2368 * Write 1 to clear the interrupt status.
2371 xhci_writel(xhci, status, &xhci->op_regs->status);
2372 /* FIXME when MSI-X is supported and there are multiple vectors */
2373 /* Clear the MSI-X event interrupt status */
2375 if (hcd->irq != -1) {
2377 /* Acknowledge the PCI interrupt */
2378 irq_pending = xhci_readl(xhci, &xhci->ir_set->irq_pending);
2380 xhci_writel(xhci, irq_pending, &xhci->ir_set->irq_pending);
2383 if (xhci->xhc_state & XHCI_STATE_DYING) {
2384 xhci_dbg(xhci, "xHCI dying, ignoring interrupt. "
2385 "Shouldn't IRQs be disabled?\n");
2386 /* Clear the event handler busy flag (RW1C);
2387 * the event ring should be empty.
2389 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
2390 xhci_write_64(xhci, temp_64 | ERST_EHB,
2391 &xhci->ir_set->erst_dequeue);
2392 spin_unlock(&xhci->lock);
2397 event_ring_deq = xhci->event_ring->dequeue;
2398 /* FIXME this should be a delayed service routine
2399 * that clears the EHB.
2401 while (xhci_handle_event(xhci) > 0) {}
2403 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
2404 /* If necessary, update the HW's version of the event ring deq ptr. */
2405 if (event_ring_deq != xhci->event_ring->dequeue) {
2406 deq = xhci_trb_virt_to_dma(xhci->event_ring->deq_seg,
2407 xhci->event_ring->dequeue);
2409 xhci_warn(xhci, "WARN something wrong with SW event "
2410 "ring dequeue ptr.\n");
2411 /* Update HC event ring dequeue pointer */
2412 temp_64 &= ERST_PTR_MASK;
2413 temp_64 |= ((u64) deq & (u64) ~ERST_PTR_MASK);
2416 /* Clear the event handler busy flag (RW1C); event ring is empty. */
2417 temp_64 |= ERST_EHB;
2418 xhci_write_64(xhci, temp_64, &xhci->ir_set->erst_dequeue);
2420 spin_unlock(&xhci->lock);
2425 irqreturn_t xhci_msi_irq(int irq, struct usb_hcd *hcd)
2427 return xhci_irq(hcd);
2430 /**** Endpoint Ring Operations ****/
2433 * Generic function for queueing a TRB on a ring.
2434 * The caller must have checked to make sure there's room on the ring.
2436 * @more_trbs_coming: Will you enqueue more TRBs before calling
2437 * prepare_transfer()?
2439 static void queue_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
2440 bool consumer, bool more_trbs_coming, bool isoc,
2441 u32 field1, u32 field2, u32 field3, u32 field4)
2443 struct xhci_generic_trb *trb;
2445 trb = &ring->enqueue->generic;
2446 trb->field[0] = cpu_to_le32(field1);
2447 trb->field[1] = cpu_to_le32(field2);
2448 trb->field[2] = cpu_to_le32(field3);
2449 trb->field[3] = cpu_to_le32(field4);
2450 inc_enq(xhci, ring, consumer, more_trbs_coming, isoc);
2454 * Does various checks on the endpoint ring, and makes it ready to queue num_trbs.
2455 * FIXME allocate segments if the ring is full.
2457 static int prepare_ring(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
2458 u32 ep_state, unsigned int num_trbs, bool isoc, gfp_t mem_flags)
2460 /* Make sure the endpoint has been added to xHC schedule */
2462 case EP_STATE_DISABLED:
2464 * USB core changed config/interfaces without notifying us,
2465 * or hardware is reporting the wrong state.
2467 xhci_warn(xhci, "WARN urb submitted to disabled ep\n");
2469 case EP_STATE_ERROR:
2470 xhci_warn(xhci, "WARN waiting for error on ep to be cleared\n");
2471 /* FIXME event handling code for error needs to clear it */
2472 /* XXX not sure if this should be -ENOENT or not */
2474 case EP_STATE_HALTED:
2475 xhci_dbg(xhci, "WARN halted endpoint, queueing URB anyway.\n");
2476 case EP_STATE_STOPPED:
2477 case EP_STATE_RUNNING:
2480 xhci_err(xhci, "ERROR unknown endpoint state for ep\n");
2482 * FIXME issue Configure Endpoint command to try to get the HC
2483 * back into a known state.
2487 if (!room_on_ring(xhci, ep_ring, num_trbs)) {
2488 /* FIXME allocate more room */
2489 xhci_err(xhci, "ERROR no room on ep ring\n");
2493 if (enqueue_is_link_trb(ep_ring)) {
2494 struct xhci_ring *ring = ep_ring;
2495 union xhci_trb *next;
2497 next = ring->enqueue;
2499 while (last_trb(xhci, ring, ring->enq_seg, next)) {
2500 /* If we're not dealing with 0.95 hardware or isoc rings
2501 * on AMD 0.96 host, clear the chain bit.
2503 if (!xhci_link_trb_quirk(xhci) && !(isoc &&
2504 (xhci->quirks & XHCI_AMD_0x96_HOST)))
2505 next->link.control &= cpu_to_le32(~TRB_CHAIN);
2507 next->link.control |= cpu_to_le32(TRB_CHAIN);
2510 next->link.control ^= cpu_to_le32(TRB_CYCLE);
2512 /* Toggle the cycle bit after the last ring segment. */
2513 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
2514 ring->cycle_state = (ring->cycle_state ? 0 : 1);
2516 ring->enq_seg = ring->enq_seg->next;
2517 ring->enqueue = ring->enq_seg->trbs;
2518 next = ring->enqueue;
2525 static int prepare_transfer(struct xhci_hcd *xhci,
2526 struct xhci_virt_device *xdev,
2527 unsigned int ep_index,
2528 unsigned int stream_id,
2529 unsigned int num_trbs,
2531 unsigned int td_index,
2536 struct urb_priv *urb_priv;
2538 struct xhci_ring *ep_ring;
2539 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
2541 ep_ring = xhci_stream_id_to_ring(xdev, ep_index, stream_id);
2543 xhci_dbg(xhci, "Can't prepare ring for bad stream ID %u\n",
2548 ret = prepare_ring(xhci, ep_ring,
2549 le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK,
2550 num_trbs, isoc, mem_flags);
2554 urb_priv = urb->hcpriv;
2555 td = urb_priv->td[td_index];
2557 INIT_LIST_HEAD(&td->td_list);
2558 INIT_LIST_HEAD(&td->cancelled_td_list);
2560 if (td_index == 0) {
2561 ret = usb_hcd_link_urb_to_ep(bus_to_hcd(urb->dev->bus), urb);
2567 /* Add this TD to the tail of the endpoint ring's TD list */
2568 list_add_tail(&td->td_list, &ep_ring->td_list);
2569 td->start_seg = ep_ring->enq_seg;
2570 td->first_trb = ep_ring->enqueue;
2572 urb_priv->td[td_index] = td;
2577 static unsigned int count_sg_trbs_needed(struct xhci_hcd *xhci, struct urb *urb)
2579 int num_sgs, num_trbs, running_total, temp, i;
2580 struct scatterlist *sg;
2583 num_sgs = urb->num_mapped_sgs;
2584 temp = urb->transfer_buffer_length;
2587 for_each_sg(urb->sg, sg, num_sgs, i) {
2588 unsigned int len = sg_dma_len(sg);
2590 /* Scatter gather list entries may cross 64KB boundaries */
2591 running_total = TRB_MAX_BUFF_SIZE -
2592 (sg_dma_address(sg) & (TRB_MAX_BUFF_SIZE - 1));
2593 running_total &= TRB_MAX_BUFF_SIZE - 1;
2594 if (running_total != 0)
2597 /* How many more 64KB chunks to transfer, how many more TRBs? */
2598 while (running_total < sg_dma_len(sg) && running_total < temp) {
2600 running_total += TRB_MAX_BUFF_SIZE;
2602 len = min_t(int, len, temp);
2610 static void check_trb_math(struct urb *urb, int num_trbs, int running_total)
2613 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated number of "
2614 "TRBs, %d left\n", __func__,
2615 urb->ep->desc.bEndpointAddress, num_trbs);
2616 if (running_total != urb->transfer_buffer_length)
2617 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated tx length, "
2618 "queued %#x (%d), asked for %#x (%d)\n",
2620 urb->ep->desc.bEndpointAddress,
2621 running_total, running_total,
2622 urb->transfer_buffer_length,
2623 urb->transfer_buffer_length);
2626 static void giveback_first_trb(struct xhci_hcd *xhci, int slot_id,
2627 unsigned int ep_index, unsigned int stream_id, int start_cycle,
2628 struct xhci_generic_trb *start_trb)
2631 * Pass all the TRBs to the hardware at once and make sure this write
2636 start_trb->field[3] |= cpu_to_le32(start_cycle);
2638 start_trb->field[3] &= cpu_to_le32(~TRB_CYCLE);
2639 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, stream_id);
2643 * xHCI uses normal TRBs for both bulk and interrupt. When the interrupt
2644 * endpoint is to be serviced, the xHC will consume (at most) one TD. A TD
2645 * (comprised of sg list entries) can take several service intervals to
2648 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
2649 struct urb *urb, int slot_id, unsigned int ep_index)
2651 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci,
2652 xhci->devs[slot_id]->out_ctx, ep_index);
2656 xhci_interval = EP_INTERVAL_TO_UFRAMES(le32_to_cpu(ep_ctx->ep_info));
2657 ep_interval = urb->interval;
2658 /* Convert to microframes */
2659 if (urb->dev->speed == USB_SPEED_LOW ||
2660 urb->dev->speed == USB_SPEED_FULL)
2662 /* FIXME change this to a warning and a suggestion to use the new API
2663 * to set the polling interval (once the API is added).
2665 if (xhci_interval != ep_interval) {
2666 if (printk_ratelimit())
2667 dev_dbg(&urb->dev->dev, "Driver uses different interval"
2668 " (%d microframe%s) than xHCI "
2669 "(%d microframe%s)\n",
2671 ep_interval == 1 ? "" : "s",
2673 xhci_interval == 1 ? "" : "s");
2674 urb->interval = xhci_interval;
2675 /* Convert back to frames for LS/FS devices */
2676 if (urb->dev->speed == USB_SPEED_LOW ||
2677 urb->dev->speed == USB_SPEED_FULL)
2680 return xhci_queue_bulk_tx(xhci, GFP_ATOMIC, urb, slot_id, ep_index);
2684 * The TD size is the number of bytes remaining in the TD (including this TRB),
2685 * right shifted by 10.
2686 * It must fit in bits 21:17, so it can't be bigger than 31.
2688 static u32 xhci_td_remainder(unsigned int remainder)
2690 u32 max = (1 << (21 - 17 + 1)) - 1;
2692 if ((remainder >> 10) >= max)
2695 return (remainder >> 10) << 17;
2699 * For xHCI 1.0 host controllers, TD size is the number of packets remaining in
2700 * the TD (*not* including this TRB).
2702 * Total TD packet count = total_packet_count =
2703 * roundup(TD size in bytes / wMaxPacketSize)
2705 * Packets transferred up to and including this TRB = packets_transferred =
2706 * rounddown(total bytes transferred including this TRB / wMaxPacketSize)
2708 * TD size = total_packet_count - packets_transferred
2710 * It must fit in bits 21:17, so it can't be bigger than 31.
2713 static u32 xhci_v1_0_td_remainder(int running_total, int trb_buff_len,
2714 unsigned int total_packet_count, struct urb *urb)
2716 int packets_transferred;
2718 /* One TRB with a zero-length data packet. */
2719 if (running_total == 0 && trb_buff_len == 0)
2722 /* All the TRB queueing functions don't count the current TRB in
2725 packets_transferred = (running_total + trb_buff_len) /
2726 usb_endpoint_maxp(&urb->ep->desc);
2728 return xhci_td_remainder(total_packet_count - packets_transferred);
2731 static int queue_bulk_sg_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
2732 struct urb *urb, int slot_id, unsigned int ep_index)
2734 struct xhci_ring *ep_ring;
2735 unsigned int num_trbs;
2736 struct urb_priv *urb_priv;
2738 struct scatterlist *sg;
2740 int trb_buff_len, this_sg_len, running_total;
2741 unsigned int total_packet_count;
2744 bool more_trbs_coming;
2746 struct xhci_generic_trb *start_trb;
2749 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
2753 num_trbs = count_sg_trbs_needed(xhci, urb);
2754 num_sgs = urb->num_mapped_sgs;
2755 total_packet_count = roundup(urb->transfer_buffer_length,
2756 usb_endpoint_maxp(&urb->ep->desc));
2758 trb_buff_len = prepare_transfer(xhci, xhci->devs[slot_id],
2759 ep_index, urb->stream_id,
2760 num_trbs, urb, 0, false, mem_flags);
2761 if (trb_buff_len < 0)
2762 return trb_buff_len;
2764 urb_priv = urb->hcpriv;
2765 td = urb_priv->td[0];
2768 * Don't give the first TRB to the hardware (by toggling the cycle bit)
2769 * until we've finished creating all the other TRBs. The ring's cycle
2770 * state may change as we enqueue the other TRBs, so save it too.
2772 start_trb = &ep_ring->enqueue->generic;
2773 start_cycle = ep_ring->cycle_state;
2777 * How much data is in the first TRB?
2779 * There are three forces at work for TRB buffer pointers and lengths:
2780 * 1. We don't want to walk off the end of this sg-list entry buffer.
2781 * 2. The transfer length that the driver requested may be smaller than
2782 * the amount of memory allocated for this scatter-gather list.
2783 * 3. TRBs buffers can't cross 64KB boundaries.
2786 addr = (u64) sg_dma_address(sg);
2787 this_sg_len = sg_dma_len(sg);
2788 trb_buff_len = TRB_MAX_BUFF_SIZE - (addr & (TRB_MAX_BUFF_SIZE - 1));
2789 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
2790 if (trb_buff_len > urb->transfer_buffer_length)
2791 trb_buff_len = urb->transfer_buffer_length;
2794 /* Queue the first TRB, even if it's zero-length */
2797 u32 length_field = 0;
2800 /* Don't change the cycle bit of the first TRB until later */
2803 if (start_cycle == 0)
2806 field |= ep_ring->cycle_state;
2808 /* Chain all the TRBs together; clear the chain bit in the last
2809 * TRB to indicate it's the last TRB in the chain.
2814 /* FIXME - add check for ZERO_PACKET flag before this */
2815 td->last_trb = ep_ring->enqueue;
2819 /* Only set interrupt on short packet for IN endpoints */
2820 if (usb_urb_dir_in(urb))
2823 if (TRB_MAX_BUFF_SIZE -
2824 (addr & (TRB_MAX_BUFF_SIZE - 1)) < trb_buff_len) {
2825 xhci_warn(xhci, "WARN: sg dma xfer crosses 64KB boundaries!\n");
2826 xhci_dbg(xhci, "Next boundary at %#x, end dma = %#x\n",
2827 (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
2828 (unsigned int) addr + trb_buff_len);
2831 /* Set the TRB length, TD size, and interrupter fields. */
2832 if (xhci->hci_version < 0x100) {
2833 remainder = xhci_td_remainder(
2834 urb->transfer_buffer_length -
2837 remainder = xhci_v1_0_td_remainder(running_total,
2838 trb_buff_len, total_packet_count, urb);
2840 length_field = TRB_LEN(trb_buff_len) |
2845 more_trbs_coming = true;
2847 more_trbs_coming = false;
2848 queue_trb(xhci, ep_ring, false, more_trbs_coming, false,
2849 lower_32_bits(addr),
2850 upper_32_bits(addr),
2852 field | TRB_TYPE(TRB_NORMAL));
2854 running_total += trb_buff_len;
2856 /* Calculate length for next transfer --
2857 * Are we done queueing all the TRBs for this sg entry?
2859 this_sg_len -= trb_buff_len;
2860 if (this_sg_len == 0) {
2865 addr = (u64) sg_dma_address(sg);
2866 this_sg_len = sg_dma_len(sg);
2868 addr += trb_buff_len;
2871 trb_buff_len = TRB_MAX_BUFF_SIZE -
2872 (addr & (TRB_MAX_BUFF_SIZE - 1));
2873 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
2874 if (running_total + trb_buff_len > urb->transfer_buffer_length)
2876 urb->transfer_buffer_length - running_total;
2877 } while (running_total < urb->transfer_buffer_length);
2879 check_trb_math(urb, num_trbs, running_total);
2880 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
2881 start_cycle, start_trb);
2885 /* This is very similar to what ehci-q.c qtd_fill() does */
2886 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
2887 struct urb *urb, int slot_id, unsigned int ep_index)
2889 struct xhci_ring *ep_ring;
2890 struct urb_priv *urb_priv;
2893 struct xhci_generic_trb *start_trb;
2895 bool more_trbs_coming;
2897 u32 field, length_field;
2899 int running_total, trb_buff_len, ret;
2900 unsigned int total_packet_count;
2904 return queue_bulk_sg_tx(xhci, mem_flags, urb, slot_id, ep_index);
2906 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
2911 /* How much data is (potentially) left before the 64KB boundary? */
2912 running_total = TRB_MAX_BUFF_SIZE -
2913 (urb->transfer_dma & (TRB_MAX_BUFF_SIZE - 1));
2914 running_total &= TRB_MAX_BUFF_SIZE - 1;
2916 /* If there's some data on this 64KB chunk, or we have to send a
2917 * zero-length transfer, we need at least one TRB
2919 if (running_total != 0 || urb->transfer_buffer_length == 0)
2921 /* How many more 64KB chunks to transfer, how many more TRBs? */
2922 while (running_total < urb->transfer_buffer_length) {
2924 running_total += TRB_MAX_BUFF_SIZE;
2926 /* FIXME: this doesn't deal with URB_ZERO_PACKET - need one more */
2928 ret = prepare_transfer(xhci, xhci->devs[slot_id],
2929 ep_index, urb->stream_id,
2930 num_trbs, urb, 0, false, mem_flags);
2934 urb_priv = urb->hcpriv;
2935 td = urb_priv->td[0];
2938 * Don't give the first TRB to the hardware (by toggling the cycle bit)
2939 * until we've finished creating all the other TRBs. The ring's cycle
2940 * state may change as we enqueue the other TRBs, so save it too.
2942 start_trb = &ep_ring->enqueue->generic;
2943 start_cycle = ep_ring->cycle_state;
2946 total_packet_count = roundup(urb->transfer_buffer_length,
2947 usb_endpoint_maxp(&urb->ep->desc));
2948 /* How much data is in the first TRB? */
2949 addr = (u64) urb->transfer_dma;
2950 trb_buff_len = TRB_MAX_BUFF_SIZE -
2951 (urb->transfer_dma & (TRB_MAX_BUFF_SIZE - 1));
2952 if (trb_buff_len > urb->transfer_buffer_length)
2953 trb_buff_len = urb->transfer_buffer_length;
2957 /* Queue the first TRB, even if it's zero-length */
2962 /* Don't change the cycle bit of the first TRB until later */
2965 if (start_cycle == 0)
2968 field |= ep_ring->cycle_state;
2970 /* Chain all the TRBs together; clear the chain bit in the last
2971 * TRB to indicate it's the last TRB in the chain.
2976 /* FIXME - add check for ZERO_PACKET flag before this */
2977 td->last_trb = ep_ring->enqueue;
2981 /* Only set interrupt on short packet for IN endpoints */
2982 if (usb_urb_dir_in(urb))
2985 /* Set the TRB length, TD size, and interrupter fields. */
2986 if (xhci->hci_version < 0x100) {
2987 remainder = xhci_td_remainder(
2988 urb->transfer_buffer_length -
2991 remainder = xhci_v1_0_td_remainder(running_total,
2992 trb_buff_len, total_packet_count, urb);
2994 length_field = TRB_LEN(trb_buff_len) |
2999 more_trbs_coming = true;
3001 more_trbs_coming = false;
3002 queue_trb(xhci, ep_ring, false, more_trbs_coming, false,
3003 lower_32_bits(addr),
3004 upper_32_bits(addr),
3006 field | TRB_TYPE(TRB_NORMAL));
3008 running_total += trb_buff_len;
3010 /* Calculate length for next transfer */
3011 addr += trb_buff_len;
3012 trb_buff_len = urb->transfer_buffer_length - running_total;
3013 if (trb_buff_len > TRB_MAX_BUFF_SIZE)
3014 trb_buff_len = TRB_MAX_BUFF_SIZE;
3015 } while (running_total < urb->transfer_buffer_length);
3017 check_trb_math(urb, num_trbs, running_total);
3018 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3019 start_cycle, start_trb);
3023 /* Caller must have locked xhci->lock */
3024 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3025 struct urb *urb, int slot_id, unsigned int ep_index)
3027 struct xhci_ring *ep_ring;
3030 struct usb_ctrlrequest *setup;
3031 struct xhci_generic_trb *start_trb;
3033 u32 field, length_field;
3034 struct urb_priv *urb_priv;
3037 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3042 * Need to copy setup packet into setup TRB, so we can't use the setup
3045 if (!urb->setup_packet)
3048 /* 1 TRB for setup, 1 for status */
3051 * Don't need to check if we need additional event data and normal TRBs,
3052 * since data in control transfers will never get bigger than 16MB
3053 * XXX: can we get a buffer that crosses 64KB boundaries?
3055 if (urb->transfer_buffer_length > 0)
3057 ret = prepare_transfer(xhci, xhci->devs[slot_id],
3058 ep_index, urb->stream_id,
3059 num_trbs, urb, 0, false, mem_flags);
3063 urb_priv = urb->hcpriv;
3064 td = urb_priv->td[0];
3067 * Don't give the first TRB to the hardware (by toggling the cycle bit)
3068 * until we've finished creating all the other TRBs. The ring's cycle
3069 * state may change as we enqueue the other TRBs, so save it too.
3071 start_trb = &ep_ring->enqueue->generic;
3072 start_cycle = ep_ring->cycle_state;
3074 /* Queue setup TRB - see section 6.4.1.2.1 */
3075 /* FIXME better way to translate setup_packet into two u32 fields? */
3076 setup = (struct usb_ctrlrequest *) urb->setup_packet;
3078 field |= TRB_IDT | TRB_TYPE(TRB_SETUP);
3079 if (start_cycle == 0)
3082 /* xHCI 1.0 6.4.1.2.1: Transfer Type field */
3083 if (xhci->hci_version == 0x100) {
3084 if (urb->transfer_buffer_length > 0) {
3085 if (setup->bRequestType & USB_DIR_IN)
3086 field |= TRB_TX_TYPE(TRB_DATA_IN);
3088 field |= TRB_TX_TYPE(TRB_DATA_OUT);
3092 queue_trb(xhci, ep_ring, false, true, false,
3093 setup->bRequestType | setup->bRequest << 8 | le16_to_cpu(setup->wValue) << 16,
3094 le16_to_cpu(setup->wIndex) | le16_to_cpu(setup->wLength) << 16,
3095 TRB_LEN(8) | TRB_INTR_TARGET(0),
3096 /* Immediate data in pointer */
3099 /* If there's data, queue data TRBs */
3100 /* Only set interrupt on short packet for IN endpoints */
3101 if (usb_urb_dir_in(urb))
3102 field = TRB_ISP | TRB_TYPE(TRB_DATA);
3104 field = TRB_TYPE(TRB_DATA);
3106 length_field = TRB_LEN(urb->transfer_buffer_length) |
3107 xhci_td_remainder(urb->transfer_buffer_length) |
3109 if (urb->transfer_buffer_length > 0) {
3110 if (setup->bRequestType & USB_DIR_IN)
3111 field |= TRB_DIR_IN;
3112 queue_trb(xhci, ep_ring, false, true, false,
3113 lower_32_bits(urb->transfer_dma),
3114 upper_32_bits(urb->transfer_dma),
3116 field | ep_ring->cycle_state);
3119 /* Save the DMA address of the last TRB in the TD */
3120 td->last_trb = ep_ring->enqueue;
3122 /* Queue status TRB - see Table 7 and sections 4.11.2.2 and 6.4.1.2.3 */
3123 /* If the device sent data, the status stage is an OUT transfer */
3124 if (urb->transfer_buffer_length > 0 && setup->bRequestType & USB_DIR_IN)
3128 queue_trb(xhci, ep_ring, false, false, false,
3132 /* Event on completion */
3133 field | TRB_IOC | TRB_TYPE(TRB_STATUS) | ep_ring->cycle_state);
3135 giveback_first_trb(xhci, slot_id, ep_index, 0,
3136 start_cycle, start_trb);
3140 static int count_isoc_trbs_needed(struct xhci_hcd *xhci,
3141 struct urb *urb, int i)
3146 addr = (u64) (urb->transfer_dma + urb->iso_frame_desc[i].offset);
3147 td_len = urb->iso_frame_desc[i].length;
3149 num_trbs = DIV_ROUND_UP(td_len + (addr & (TRB_MAX_BUFF_SIZE - 1)),
3158 * The transfer burst count field of the isochronous TRB defines the number of
3159 * bursts that are required to move all packets in this TD. Only SuperSpeed
3160 * devices can burst up to bMaxBurst number of packets per service interval.
3161 * This field is zero based, meaning a value of zero in the field means one
3162 * burst. Basically, for everything but SuperSpeed devices, this field will be
3163 * zero. Only xHCI 1.0 host controllers support this field.
3165 static unsigned int xhci_get_burst_count(struct xhci_hcd *xhci,
3166 struct usb_device *udev,
3167 struct urb *urb, unsigned int total_packet_count)
3169 unsigned int max_burst;
3171 if (xhci->hci_version < 0x100 || udev->speed != USB_SPEED_SUPER)
3174 max_burst = urb->ep->ss_ep_comp.bMaxBurst;
3175 return roundup(total_packet_count, max_burst + 1) - 1;
3179 * Returns the number of packets in the last "burst" of packets. This field is
3180 * valid for all speeds of devices. USB 2.0 devices can only do one "burst", so
3181 * the last burst packet count is equal to the total number of packets in the
3182 * TD. SuperSpeed endpoints can have up to 3 bursts. All but the last burst
3183 * must contain (bMaxBurst + 1) number of packets, but the last burst can
3184 * contain 1 to (bMaxBurst + 1) packets.
3186 static unsigned int xhci_get_last_burst_packet_count(struct xhci_hcd *xhci,
3187 struct usb_device *udev,
3188 struct urb *urb, unsigned int total_packet_count)
3190 unsigned int max_burst;
3191 unsigned int residue;
3193 if (xhci->hci_version < 0x100)
3196 switch (udev->speed) {
3197 case USB_SPEED_SUPER:
3198 /* bMaxBurst is zero based: 0 means 1 packet per burst */
3199 max_burst = urb->ep->ss_ep_comp.bMaxBurst;
3200 residue = total_packet_count % (max_burst + 1);
3201 /* If residue is zero, the last burst contains (max_burst + 1)
3202 * number of packets, but the TLBPC field is zero-based.
3208 if (total_packet_count == 0)
3210 return total_packet_count - 1;
3214 /* This is for isoc transfer */
3215 static int xhci_queue_isoc_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3216 struct urb *urb, int slot_id, unsigned int ep_index)
3218 struct xhci_ring *ep_ring;
3219 struct urb_priv *urb_priv;
3221 int num_tds, trbs_per_td;
3222 struct xhci_generic_trb *start_trb;
3225 u32 field, length_field;
3226 int running_total, trb_buff_len, td_len, td_remain_len, ret;
3227 u64 start_addr, addr;
3229 bool more_trbs_coming;
3231 ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
3233 num_tds = urb->number_of_packets;
3235 xhci_dbg(xhci, "Isoc URB with zero packets?\n");
3239 start_addr = (u64) urb->transfer_dma;
3240 start_trb = &ep_ring->enqueue->generic;
3241 start_cycle = ep_ring->cycle_state;
3243 urb_priv = urb->hcpriv;
3244 /* Queue the first TRB, even if it's zero-length */
3245 for (i = 0; i < num_tds; i++) {
3246 unsigned int total_packet_count;
3247 unsigned int burst_count;
3248 unsigned int residue;
3252 addr = start_addr + urb->iso_frame_desc[i].offset;
3253 td_len = urb->iso_frame_desc[i].length;
3254 td_remain_len = td_len;
3255 total_packet_count = roundup(td_len,
3256 usb_endpoint_maxp(&urb->ep->desc));
3257 /* A zero-length transfer still involves at least one packet. */
3258 if (total_packet_count == 0)
3259 total_packet_count++;
3260 burst_count = xhci_get_burst_count(xhci, urb->dev, urb,
3261 total_packet_count);
3262 residue = xhci_get_last_burst_packet_count(xhci,
3263 urb->dev, urb, total_packet_count);
3265 trbs_per_td = count_isoc_trbs_needed(xhci, urb, i);
3267 ret = prepare_transfer(xhci, xhci->devs[slot_id], ep_index,
3268 urb->stream_id, trbs_per_td, urb, i, true,
3276 td = urb_priv->td[i];
3277 for (j = 0; j < trbs_per_td; j++) {
3279 field = TRB_TBC(burst_count) | TRB_TLBPC(residue);
3282 /* Queue the isoc TRB */
3283 field |= TRB_TYPE(TRB_ISOC);
3284 /* Assume URB_ISO_ASAP is set */
3287 if (start_cycle == 0)
3290 field |= ep_ring->cycle_state;
3293 /* Queue other normal TRBs */
3294 field |= TRB_TYPE(TRB_NORMAL);
3295 field |= ep_ring->cycle_state;
3298 /* Only set interrupt on short packet for IN EPs */
3299 if (usb_urb_dir_in(urb))
3302 /* Chain all the TRBs together; clear the chain bit in
3303 * the last TRB to indicate it's the last TRB in the
3306 if (j < trbs_per_td - 1) {
3308 more_trbs_coming = true;
3310 td->last_trb = ep_ring->enqueue;
3312 if (xhci->hci_version == 0x100) {
3313 /* Set BEI bit except for the last td */
3314 if (i < num_tds - 1)
3317 more_trbs_coming = false;
3320 /* Calculate TRB length */
3321 trb_buff_len = TRB_MAX_BUFF_SIZE -
3322 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
3323 if (trb_buff_len > td_remain_len)
3324 trb_buff_len = td_remain_len;
3326 /* Set the TRB length, TD size, & interrupter fields. */
3327 if (xhci->hci_version < 0x100) {
3328 remainder = xhci_td_remainder(
3329 td_len - running_total);
3331 remainder = xhci_v1_0_td_remainder(
3332 running_total, trb_buff_len,
3333 total_packet_count, urb);
3335 length_field = TRB_LEN(trb_buff_len) |
3339 queue_trb(xhci, ep_ring, false, more_trbs_coming, true,
3340 lower_32_bits(addr),
3341 upper_32_bits(addr),
3344 running_total += trb_buff_len;
3346 addr += trb_buff_len;
3347 td_remain_len -= trb_buff_len;
3350 /* Check TD length */
3351 if (running_total != td_len) {
3352 xhci_err(xhci, "ISOC TD length unmatch\n");
3358 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs == 0) {
3359 if (xhci->quirks & XHCI_AMD_PLL_FIX)
3360 usb_amd_quirk_pll_disable();
3362 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs++;
3364 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3365 start_cycle, start_trb);
3368 /* Clean up a partially enqueued isoc transfer. */
3370 for (i--; i >= 0; i--)
3371 list_del_init(&urb_priv->td[i]->td_list);
3373 /* Use the first TD as a temporary variable to turn the TDs we've queued
3374 * into No-ops with a software-owned cycle bit. That way the hardware
3375 * won't accidentally start executing bogus TDs when we partially
3376 * overwrite them. td->first_trb and td->start_seg are already set.
3378 urb_priv->td[0]->last_trb = ep_ring->enqueue;
3379 /* Every TRB except the first & last will have its cycle bit flipped. */
3380 td_to_noop(xhci, ep_ring, urb_priv->td[0], true);
3382 /* Reset the ring enqueue back to the first TRB and its cycle bit. */
3383 ep_ring->enqueue = urb_priv->td[0]->first_trb;
3384 ep_ring->enq_seg = urb_priv->td[0]->start_seg;
3385 ep_ring->cycle_state = start_cycle;
3386 usb_hcd_unlink_urb_from_ep(bus_to_hcd(urb->dev->bus), urb);
3391 * Check transfer ring to guarantee there is enough room for the urb.
3392 * Update ISO URB start_frame and interval.
3393 * Update interval as xhci_queue_intr_tx does. Just use xhci frame_index to
3394 * update the urb->start_frame by now.
3395 * Always assume URB_ISO_ASAP set, and NEVER use urb->start_frame as input.
3397 int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
3398 struct urb *urb, int slot_id, unsigned int ep_index)
3400 struct xhci_virt_device *xdev;
3401 struct xhci_ring *ep_ring;
3402 struct xhci_ep_ctx *ep_ctx;
3406 int num_tds, num_trbs, i;
3409 xdev = xhci->devs[slot_id];
3410 ep_ring = xdev->eps[ep_index].ring;
3411 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
3414 num_tds = urb->number_of_packets;
3415 for (i = 0; i < num_tds; i++)
3416 num_trbs += count_isoc_trbs_needed(xhci, urb, i);
3418 /* Check the ring to guarantee there is enough room for the whole urb.
3419 * Do not insert any td of the urb to the ring if the check failed.
3421 ret = prepare_ring(xhci, ep_ring, le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK,
3422 num_trbs, true, mem_flags);
3426 start_frame = xhci_readl(xhci, &xhci->run_regs->microframe_index);
3427 start_frame &= 0x3fff;
3429 urb->start_frame = start_frame;
3430 if (urb->dev->speed == USB_SPEED_LOW ||
3431 urb->dev->speed == USB_SPEED_FULL)
3432 urb->start_frame >>= 3;
3434 xhci_interval = EP_INTERVAL_TO_UFRAMES(le32_to_cpu(ep_ctx->ep_info));
3435 ep_interval = urb->interval;
3436 /* Convert to microframes */
3437 if (urb->dev->speed == USB_SPEED_LOW ||
3438 urb->dev->speed == USB_SPEED_FULL)
3440 /* FIXME change this to a warning and a suggestion to use the new API
3441 * to set the polling interval (once the API is added).
3443 if (xhci_interval != ep_interval) {
3444 if (printk_ratelimit())
3445 dev_dbg(&urb->dev->dev, "Driver uses different interval"
3446 " (%d microframe%s) than xHCI "
3447 "(%d microframe%s)\n",
3449 ep_interval == 1 ? "" : "s",
3451 xhci_interval == 1 ? "" : "s");
3452 urb->interval = xhci_interval;
3453 /* Convert back to frames for LS/FS devices */
3454 if (urb->dev->speed == USB_SPEED_LOW ||
3455 urb->dev->speed == USB_SPEED_FULL)
3458 return xhci_queue_isoc_tx(xhci, GFP_ATOMIC, urb, slot_id, ep_index);
3461 /**** Command Ring Operations ****/
3463 /* Generic function for queueing a command TRB on the command ring.
3464 * Check to make sure there's room on the command ring for one command TRB.
3465 * Also check that there's room reserved for commands that must not fail.
3466 * If this is a command that must not fail, meaning command_must_succeed = TRUE,
3467 * then only check for the number of reserved spots.
3468 * Don't decrement xhci->cmd_ring_reserved_trbs after we've queued the TRB
3469 * because the command event handler may want to resubmit a failed command.
3471 static int queue_command(struct xhci_hcd *xhci, u32 field1, u32 field2,
3472 u32 field3, u32 field4, bool command_must_succeed)
3474 int reserved_trbs = xhci->cmd_ring_reserved_trbs;
3477 if (!command_must_succeed)
3480 ret = prepare_ring(xhci, xhci->cmd_ring, EP_STATE_RUNNING,
3481 reserved_trbs, false, GFP_ATOMIC);
3483 xhci_err(xhci, "ERR: No room for command on command ring\n");
3484 if (command_must_succeed)
3485 xhci_err(xhci, "ERR: Reserved TRB counting for "
3486 "unfailable commands failed.\n");
3489 queue_trb(xhci, xhci->cmd_ring, false, false, false, field1, field2,
3490 field3, field4 | xhci->cmd_ring->cycle_state);
3494 /* Queue a slot enable or disable request on the command ring */
3495 int xhci_queue_slot_control(struct xhci_hcd *xhci, u32 trb_type, u32 slot_id)
3497 return queue_command(xhci, 0, 0, 0,
3498 TRB_TYPE(trb_type) | SLOT_ID_FOR_TRB(slot_id), false);
3501 /* Queue an address device command TRB */
3502 int xhci_queue_address_device(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
3505 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
3506 upper_32_bits(in_ctx_ptr), 0,
3507 TRB_TYPE(TRB_ADDR_DEV) | SLOT_ID_FOR_TRB(slot_id),
3511 int xhci_queue_vendor_command(struct xhci_hcd *xhci,
3512 u32 field1, u32 field2, u32 field3, u32 field4)
3514 return queue_command(xhci, field1, field2, field3, field4, false);
3517 /* Queue a reset device command TRB */
3518 int xhci_queue_reset_device(struct xhci_hcd *xhci, u32 slot_id)
3520 return queue_command(xhci, 0, 0, 0,
3521 TRB_TYPE(TRB_RESET_DEV) | SLOT_ID_FOR_TRB(slot_id),
3525 /* Queue a configure endpoint command TRB */
3526 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
3527 u32 slot_id, bool command_must_succeed)
3529 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
3530 upper_32_bits(in_ctx_ptr), 0,
3531 TRB_TYPE(TRB_CONFIG_EP) | SLOT_ID_FOR_TRB(slot_id),
3532 command_must_succeed);
3535 /* Queue an evaluate context command TRB */
3536 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
3539 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
3540 upper_32_bits(in_ctx_ptr), 0,
3541 TRB_TYPE(TRB_EVAL_CONTEXT) | SLOT_ID_FOR_TRB(slot_id),
3546 * Suspend is set to indicate "Stop Endpoint Command" is being issued to stop
3547 * activity on an endpoint that is about to be suspended.
3549 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, int slot_id,
3550 unsigned int ep_index, int suspend)
3552 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3553 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3554 u32 type = TRB_TYPE(TRB_STOP_RING);
3555 u32 trb_suspend = SUSPEND_PORT_FOR_TRB(suspend);
3557 return queue_command(xhci, 0, 0, 0,
3558 trb_slot_id | trb_ep_index | type | trb_suspend, false);
3561 /* Set Transfer Ring Dequeue Pointer command.
3562 * This should not be used for endpoints that have streams enabled.
3564 static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
3565 unsigned int ep_index, unsigned int stream_id,
3566 struct xhci_segment *deq_seg,
3567 union xhci_trb *deq_ptr, u32 cycle_state)
3570 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3571 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3572 u32 trb_stream_id = STREAM_ID_FOR_TRB(stream_id);
3573 u32 type = TRB_TYPE(TRB_SET_DEQ);
3574 struct xhci_virt_ep *ep;
3576 addr = xhci_trb_virt_to_dma(deq_seg, deq_ptr);
3578 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
3579 xhci_warn(xhci, "WARN deq seg = %p, deq pt = %p\n",
3583 ep = &xhci->devs[slot_id]->eps[ep_index];
3584 if ((ep->ep_state & SET_DEQ_PENDING)) {
3585 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
3586 xhci_warn(xhci, "A Set TR Deq Ptr command is pending.\n");
3589 ep->queued_deq_seg = deq_seg;
3590 ep->queued_deq_ptr = deq_ptr;
3591 return queue_command(xhci, lower_32_bits(addr) | cycle_state,
3592 upper_32_bits(addr), trb_stream_id,
3593 trb_slot_id | trb_ep_index | type, false);
3596 int xhci_queue_reset_ep(struct xhci_hcd *xhci, int slot_id,
3597 unsigned int ep_index)
3599 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3600 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3601 u32 type = TRB_TYPE(TRB_RESET_EP);
3603 return queue_command(xhci, 0, 0, 0, trb_slot_id | trb_ep_index | type,