1 // SPDX-License-Identifier: GPL-2.0
3 * xHCI host controller driver
5 * Copyright (C) 2008 Intel Corp.
8 * Some code borrowed from the Linux EHCI driver.
12 * Ring initialization rules:
13 * 1. Each segment is initialized to zero, except for link TRBs.
14 * 2. Ring cycle state = 0. This represents Producer Cycle State (PCS) or
15 * Consumer Cycle State (CCS), depending on ring function.
16 * 3. Enqueue pointer = dequeue pointer = address of first TRB in the segment.
18 * Ring behavior rules:
19 * 1. A ring is empty if enqueue == dequeue. This means there will always be at
20 * least one free TRB in the ring. This is useful if you want to turn that
21 * into a link TRB and expand the ring.
22 * 2. When incrementing an enqueue or dequeue pointer, if the next TRB is a
23 * link TRB, then load the pointer with the address in the link TRB. If the
24 * link TRB had its toggle bit set, you may need to update the ring cycle
25 * state (see cycle bit rules). You may have to do this multiple times
26 * until you reach a non-link TRB.
27 * 3. A ring is full if enqueue++ (for the definition of increment above)
28 * equals the dequeue pointer.
31 * 1. When a consumer increments a dequeue pointer and encounters a toggle bit
32 * in a link TRB, it must toggle the ring cycle state.
33 * 2. When a producer increments an enqueue pointer and encounters a toggle bit
34 * in a link TRB, it must toggle the ring cycle state.
37 * 1. Check if ring is full before you enqueue.
38 * 2. Write the ring cycle state to the cycle bit in the TRB you're enqueuing.
39 * Update enqueue pointer between each write (which may update the ring
41 * 3. Notify consumer. If SW is producer, it rings the doorbell for command
42 * and endpoint rings. If HC is the producer for the event ring,
43 * and it generates an interrupt according to interrupt modulation rules.
46 * 1. Check if TRB belongs to you. If the cycle bit == your ring cycle state,
47 * the TRB is owned by the consumer.
48 * 2. Update dequeue pointer (which may update the ring cycle state) and
49 * continue processing TRBs until you reach a TRB which is not owned by you.
50 * 3. Notify the producer. SW is the consumer for the event ring, and it
51 * updates event ring dequeue pointer. HC is the consumer for the command and
52 * endpoint rings; it generates events on the event ring for these.
55 #include <linux/scatterlist.h>
56 #include <linux/slab.h>
57 #include <linux/dma-mapping.h>
59 #include "xhci-trace.h"
63 * Returns zero if the TRB isn't in this segment, otherwise it returns the DMA
66 dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg,
69 unsigned long segment_offset;
71 if (!seg || !trb || trb < seg->trbs)
74 segment_offset = trb - seg->trbs;
75 if (segment_offset >= TRBS_PER_SEGMENT)
77 return seg->dma + (segment_offset * sizeof(*trb));
80 static bool trb_is_noop(union xhci_trb *trb)
82 return TRB_TYPE_NOOP_LE32(trb->generic.field[3]);
85 static bool trb_is_link(union xhci_trb *trb)
87 return TRB_TYPE_LINK_LE32(trb->link.control);
90 static bool last_trb_on_seg(struct xhci_segment *seg, union xhci_trb *trb)
92 return trb == &seg->trbs[TRBS_PER_SEGMENT - 1];
95 static bool last_trb_on_ring(struct xhci_ring *ring,
96 struct xhci_segment *seg, union xhci_trb *trb)
98 return last_trb_on_seg(seg, trb) && (seg->next == ring->first_seg);
101 static bool link_trb_toggles_cycle(union xhci_trb *trb)
103 return le32_to_cpu(trb->link.control) & LINK_TOGGLE;
106 static bool last_td_in_urb(struct xhci_td *td)
108 struct urb_priv *urb_priv = td->urb->hcpriv;
110 return urb_priv->num_tds_done == urb_priv->num_tds;
113 static void inc_td_cnt(struct urb *urb)
115 struct urb_priv *urb_priv = urb->hcpriv;
117 urb_priv->num_tds_done++;
120 static void trb_to_noop(union xhci_trb *trb, u32 noop_type)
122 if (trb_is_link(trb)) {
123 /* unchain chained link TRBs */
124 trb->link.control &= cpu_to_le32(~TRB_CHAIN);
126 trb->generic.field[0] = 0;
127 trb->generic.field[1] = 0;
128 trb->generic.field[2] = 0;
129 /* Preserve only the cycle bit of this TRB */
130 trb->generic.field[3] &= cpu_to_le32(TRB_CYCLE);
131 trb->generic.field[3] |= cpu_to_le32(TRB_TYPE(noop_type));
135 /* Updates trb to point to the next TRB in the ring, and updates seg if the next
136 * TRB is in a new segment. This does not skip over link TRBs, and it does not
137 * effect the ring dequeue or enqueue pointers.
139 static void next_trb(struct xhci_hcd *xhci,
140 struct xhci_ring *ring,
141 struct xhci_segment **seg,
142 union xhci_trb **trb)
144 if (trb_is_link(*trb)) {
146 *trb = ((*seg)->trbs);
153 * See Cycle bit rules. SW is the consumer for the event ring only.
155 void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring)
157 unsigned int link_trb_count = 0;
159 /* event ring doesn't have link trbs, check for last trb */
160 if (ring->type == TYPE_EVENT) {
161 if (!last_trb_on_seg(ring->deq_seg, ring->dequeue)) {
165 if (last_trb_on_ring(ring, ring->deq_seg, ring->dequeue))
166 ring->cycle_state ^= 1;
167 ring->deq_seg = ring->deq_seg->next;
168 ring->dequeue = ring->deq_seg->trbs;
172 /* All other rings have link trbs */
173 if (!trb_is_link(ring->dequeue)) {
174 if (last_trb_on_seg(ring->deq_seg, ring->dequeue)) {
175 xhci_warn(xhci, "Missing link TRB at end of segment\n");
178 ring->num_trbs_free++;
182 while (trb_is_link(ring->dequeue)) {
183 ring->deq_seg = ring->deq_seg->next;
184 ring->dequeue = ring->deq_seg->trbs;
186 if (link_trb_count++ > ring->num_segs) {
187 xhci_warn(xhci, "Ring is an endless link TRB loop\n");
192 trace_xhci_inc_deq(ring);
198 * See Cycle bit rules. SW is the consumer for the event ring only.
200 * If we've just enqueued a TRB that is in the middle of a TD (meaning the
201 * chain bit is set), then set the chain bit in all the following link TRBs.
202 * If we've enqueued the last TRB in a TD, make sure the following link TRBs
203 * have their chain bit cleared (so that each Link TRB is a separate TD).
205 * Section 6.4.4.1 of the 0.95 spec says link TRBs cannot have the chain bit
206 * set, but other sections talk about dealing with the chain bit set. This was
207 * fixed in the 0.96 specification errata, but we have to assume that all 0.95
208 * xHCI hardware can't handle the chain bit being cleared on a link TRB.
210 * @more_trbs_coming: Will you enqueue more TRBs before calling
211 * prepare_transfer()?
213 static void inc_enq(struct xhci_hcd *xhci, struct xhci_ring *ring,
214 bool more_trbs_coming)
217 union xhci_trb *next;
218 unsigned int link_trb_count = 0;
220 chain = le32_to_cpu(ring->enqueue->generic.field[3]) & TRB_CHAIN;
221 /* If this is not event ring, there is one less usable TRB */
222 if (!trb_is_link(ring->enqueue))
223 ring->num_trbs_free--;
225 if (last_trb_on_seg(ring->enq_seg, ring->enqueue)) {
226 xhci_err(xhci, "Tried to move enqueue past ring segment\n");
230 next = ++(ring->enqueue);
232 /* Update the dequeue pointer further if that was a link TRB */
233 while (trb_is_link(next)) {
236 * If the caller doesn't plan on enqueueing more TDs before
237 * ringing the doorbell, then we don't want to give the link TRB
238 * to the hardware just yet. We'll give the link TRB back in
239 * prepare_ring() just before we enqueue the TD at the top of
242 if (!chain && !more_trbs_coming)
245 /* If we're not dealing with 0.95 hardware or isoc rings on
246 * AMD 0.96 host, carry over the chain bit of the previous TRB
247 * (which may mean the chain bit is cleared).
249 if (!(ring->type == TYPE_ISOC &&
250 (xhci->quirks & XHCI_AMD_0x96_HOST)) &&
251 !xhci_link_trb_quirk(xhci)) {
252 next->link.control &= cpu_to_le32(~TRB_CHAIN);
253 next->link.control |= cpu_to_le32(chain);
255 /* Give this link TRB to the hardware */
257 next->link.control ^= cpu_to_le32(TRB_CYCLE);
259 /* Toggle the cycle bit after the last ring segment. */
260 if (link_trb_toggles_cycle(next))
261 ring->cycle_state ^= 1;
263 ring->enq_seg = ring->enq_seg->next;
264 ring->enqueue = ring->enq_seg->trbs;
265 next = ring->enqueue;
267 if (link_trb_count++ > ring->num_segs) {
268 xhci_warn(xhci, "%s: Ring link TRB loop\n", __func__);
273 trace_xhci_inc_enq(ring);
277 * Check to see if there's room to enqueue num_trbs on the ring and make sure
278 * enqueue pointer will not advance into dequeue segment. See rules above.
280 static inline int room_on_ring(struct xhci_hcd *xhci, struct xhci_ring *ring,
281 unsigned int num_trbs)
283 int num_trbs_in_deq_seg;
285 if (ring->num_trbs_free < num_trbs)
288 if (ring->type != TYPE_COMMAND && ring->type != TYPE_EVENT) {
289 num_trbs_in_deq_seg = ring->dequeue - ring->deq_seg->trbs;
290 if (ring->num_trbs_free < num_trbs + num_trbs_in_deq_seg)
297 /* Ring the host controller doorbell after placing a command on the ring */
298 void xhci_ring_cmd_db(struct xhci_hcd *xhci)
300 if (!(xhci->cmd_ring_state & CMD_RING_STATE_RUNNING))
303 xhci_dbg(xhci, "// Ding dong!\n");
305 trace_xhci_ring_host_doorbell(0, DB_VALUE_HOST);
307 writel(DB_VALUE_HOST, &xhci->dba->doorbell[0]);
308 /* Flush PCI posted writes */
309 readl(&xhci->dba->doorbell[0]);
312 static bool xhci_mod_cmd_timer(struct xhci_hcd *xhci, unsigned long delay)
314 return mod_delayed_work(system_wq, &xhci->cmd_timer, delay);
317 static struct xhci_command *xhci_next_queued_cmd(struct xhci_hcd *xhci)
319 return list_first_entry_or_null(&xhci->cmd_list, struct xhci_command,
324 * Turn all commands on command ring with status set to "aborted" to no-op trbs.
325 * If there are other commands waiting then restart the ring and kick the timer.
326 * This must be called with command ring stopped and xhci->lock held.
328 static void xhci_handle_stopped_cmd_ring(struct xhci_hcd *xhci,
329 struct xhci_command *cur_cmd)
331 struct xhci_command *i_cmd;
333 /* Turn all aborted commands in list to no-ops, then restart */
334 list_for_each_entry(i_cmd, &xhci->cmd_list, cmd_list) {
336 if (i_cmd->status != COMP_COMMAND_ABORTED)
339 i_cmd->status = COMP_COMMAND_RING_STOPPED;
341 xhci_dbg(xhci, "Turn aborted command %p to no-op\n",
344 trb_to_noop(i_cmd->command_trb, TRB_CMD_NOOP);
347 * caller waiting for completion is called when command
348 * completion event is received for these no-op commands
352 xhci->cmd_ring_state = CMD_RING_STATE_RUNNING;
354 /* ring command ring doorbell to restart the command ring */
355 if ((xhci->cmd_ring->dequeue != xhci->cmd_ring->enqueue) &&
356 !(xhci->xhc_state & XHCI_STATE_DYING)) {
357 xhci->current_cmd = cur_cmd;
358 xhci_mod_cmd_timer(xhci, XHCI_CMD_DEFAULT_TIMEOUT);
359 xhci_ring_cmd_db(xhci);
363 /* Must be called with xhci->lock held, releases and aquires lock back */
364 static int xhci_abort_cmd_ring(struct xhci_hcd *xhci, unsigned long flags)
369 xhci_dbg(xhci, "Abort command ring\n");
371 reinit_completion(&xhci->cmd_ring_stop_completion);
373 temp_64 = xhci_read_64(xhci, &xhci->op_regs->cmd_ring);
374 xhci_write_64(xhci, temp_64 | CMD_RING_ABORT,
375 &xhci->op_regs->cmd_ring);
377 /* Section 4.6.1.2 of xHCI 1.0 spec says software should also time the
378 * completion of the Command Abort operation. If CRR is not negated in 5
379 * seconds then driver handles it as if host died (-ENODEV).
380 * In the future we should distinguish between -ENODEV and -ETIMEDOUT
381 * and try to recover a -ETIMEDOUT with a host controller reset.
383 ret = xhci_handshake(&xhci->op_regs->cmd_ring,
384 CMD_RING_RUNNING, 0, 5 * 1000 * 1000);
386 xhci_err(xhci, "Abort failed to stop command ring: %d\n", ret);
392 * Writing the CMD_RING_ABORT bit should cause a cmd completion event,
393 * however on some host hw the CMD_RING_RUNNING bit is correctly cleared
394 * but the completion event in never sent. Wait 2 secs (arbitrary
395 * number) to handle those cases after negation of CMD_RING_RUNNING.
397 spin_unlock_irqrestore(&xhci->lock, flags);
398 ret = wait_for_completion_timeout(&xhci->cmd_ring_stop_completion,
399 msecs_to_jiffies(2000));
400 spin_lock_irqsave(&xhci->lock, flags);
402 xhci_dbg(xhci, "No stop event for abort, ring start fail?\n");
403 xhci_cleanup_command_queue(xhci);
405 xhci_handle_stopped_cmd_ring(xhci, xhci_next_queued_cmd(xhci));
410 void xhci_ring_ep_doorbell(struct xhci_hcd *xhci,
411 unsigned int slot_id,
412 unsigned int ep_index,
413 unsigned int stream_id)
415 __le32 __iomem *db_addr = &xhci->dba->doorbell[slot_id];
416 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
417 unsigned int ep_state = ep->ep_state;
419 /* Don't ring the doorbell for this endpoint if there are pending
420 * cancellations because we don't want to interrupt processing.
421 * We don't want to restart any stream rings if there's a set dequeue
422 * pointer command pending because the device can choose to start any
423 * stream once the endpoint is on the HW schedule.
425 if ((ep_state & EP_STOP_CMD_PENDING) || (ep_state & SET_DEQ_PENDING) ||
426 (ep_state & EP_HALTED) || (ep_state & EP_CLEARING_TT))
429 trace_xhci_ring_ep_doorbell(slot_id, DB_VALUE(ep_index, stream_id));
431 writel(DB_VALUE(ep_index, stream_id), db_addr);
432 /* flush the write */
436 /* Ring the doorbell for any rings with pending URBs */
437 static void ring_doorbell_for_active_rings(struct xhci_hcd *xhci,
438 unsigned int slot_id,
439 unsigned int ep_index)
441 unsigned int stream_id;
442 struct xhci_virt_ep *ep;
444 ep = &xhci->devs[slot_id]->eps[ep_index];
446 /* A ring has pending URBs if its TD list is not empty */
447 if (!(ep->ep_state & EP_HAS_STREAMS)) {
448 if (ep->ring && !(list_empty(&ep->ring->td_list)))
449 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, 0);
453 for (stream_id = 1; stream_id < ep->stream_info->num_streams;
455 struct xhci_stream_info *stream_info = ep->stream_info;
456 if (!list_empty(&stream_info->stream_rings[stream_id]->td_list))
457 xhci_ring_ep_doorbell(xhci, slot_id, ep_index,
462 void xhci_ring_doorbell_for_active_rings(struct xhci_hcd *xhci,
463 unsigned int slot_id,
464 unsigned int ep_index)
466 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
469 static struct xhci_virt_ep *xhci_get_virt_ep(struct xhci_hcd *xhci,
470 unsigned int slot_id,
471 unsigned int ep_index)
473 if (slot_id == 0 || slot_id >= MAX_HC_SLOTS) {
474 xhci_warn(xhci, "Invalid slot_id %u\n", slot_id);
477 if (ep_index >= EP_CTX_PER_DEV) {
478 xhci_warn(xhci, "Invalid endpoint index %u\n", ep_index);
481 if (!xhci->devs[slot_id]) {
482 xhci_warn(xhci, "No xhci virt device for slot_id %u\n", slot_id);
486 return &xhci->devs[slot_id]->eps[ep_index];
489 static struct xhci_ring *xhci_virt_ep_to_ring(struct xhci_hcd *xhci,
490 struct xhci_virt_ep *ep,
491 unsigned int stream_id)
493 /* common case, no streams */
494 if (!(ep->ep_state & EP_HAS_STREAMS))
497 if (!ep->stream_info)
500 if (stream_id == 0 || stream_id >= ep->stream_info->num_streams) {
501 xhci_warn(xhci, "Invalid stream_id %u request for slot_id %u ep_index %u\n",
502 stream_id, ep->vdev->slot_id, ep->ep_index);
506 return ep->stream_info->stream_rings[stream_id];
509 /* Get the right ring for the given slot_id, ep_index and stream_id.
510 * If the endpoint supports streams, boundary check the URB's stream ID.
511 * If the endpoint doesn't support streams, return the singular endpoint ring.
513 struct xhci_ring *xhci_triad_to_transfer_ring(struct xhci_hcd *xhci,
514 unsigned int slot_id, unsigned int ep_index,
515 unsigned int stream_id)
517 struct xhci_virt_ep *ep;
519 ep = xhci_get_virt_ep(xhci, slot_id, ep_index);
523 return xhci_virt_ep_to_ring(xhci, ep, stream_id);
528 * Get the hw dequeue pointer xHC stopped on, either directly from the
529 * endpoint context, or if streams are in use from the stream context.
530 * The returned hw_dequeue contains the lowest four bits with cycle state
531 * and possbile stream context type.
533 static u64 xhci_get_hw_deq(struct xhci_hcd *xhci, struct xhci_virt_device *vdev,
534 unsigned int ep_index, unsigned int stream_id)
536 struct xhci_ep_ctx *ep_ctx;
537 struct xhci_stream_ctx *st_ctx;
538 struct xhci_virt_ep *ep;
540 ep = &vdev->eps[ep_index];
542 if (ep->ep_state & EP_HAS_STREAMS) {
543 st_ctx = &ep->stream_info->stream_ctx_array[stream_id];
544 return le64_to_cpu(st_ctx->stream_ring);
546 ep_ctx = xhci_get_ep_ctx(xhci, vdev->out_ctx, ep_index);
547 return le64_to_cpu(ep_ctx->deq);
551 * Move the xHC's endpoint ring dequeue pointer past cur_td.
552 * Record the new state of the xHC's endpoint ring dequeue segment,
553 * dequeue pointer, stream id, and new consumer cycle state in state.
554 * Update our internal representation of the ring's dequeue pointer.
556 * We do this in three jumps:
557 * - First we update our new ring state to be the same as when the xHC stopped.
558 * - Then we traverse the ring to find the segment that contains
559 * the last TRB in the TD. We toggle the xHC's new cycle state when we pass
560 * any link TRBs with the toggle cycle bit set.
561 * - Finally we move the dequeue state one TRB further, toggling the cycle bit
562 * if we've moved it past a link TRB with the toggle cycle bit set.
564 * Some of the uses of xhci_generic_trb are grotty, but if they're done
565 * with correct __le32 accesses they should work fine. Only users of this are
568 void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
569 unsigned int slot_id, unsigned int ep_index,
570 unsigned int stream_id, struct xhci_td *cur_td,
571 struct xhci_dequeue_state *state)
573 struct xhci_virt_device *dev = xhci->devs[slot_id];
574 struct xhci_virt_ep *ep = &dev->eps[ep_index];
575 struct xhci_ring *ep_ring;
576 struct xhci_segment *new_seg;
577 union xhci_trb *new_deq;
580 bool cycle_found = false;
581 bool td_last_trb_found = false;
583 ep_ring = xhci_triad_to_transfer_ring(xhci, slot_id,
584 ep_index, stream_id);
586 xhci_warn(xhci, "WARN can't find new dequeue state "
587 "for invalid stream ID %u.\n",
592 * A cancelled TD can complete with a stall if HW cached the trb.
593 * In this case driver can't find cur_td, but if the ring is empty we
594 * can move the dequeue pointer to the current enqueue position.
597 if (list_empty(&ep_ring->td_list)) {
598 state->new_deq_seg = ep_ring->enq_seg;
599 state->new_deq_ptr = ep_ring->enqueue;
600 state->new_cycle_state = ep_ring->cycle_state;
603 xhci_warn(xhci, "Can't find new dequeue state, missing cur_td\n");
608 /* Dig out the cycle state saved by the xHC during the stop ep cmd */
609 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
610 "Finding endpoint context");
612 hw_dequeue = xhci_get_hw_deq(xhci, dev, ep_index, stream_id);
613 new_seg = ep_ring->deq_seg;
614 new_deq = ep_ring->dequeue;
615 state->new_cycle_state = hw_dequeue & 0x1;
616 state->stream_id = stream_id;
619 * We want to find the pointer, segment and cycle state of the new trb
620 * (the one after current TD's last_trb). We know the cycle state at
621 * hw_dequeue, so walk the ring until both hw_dequeue and last_trb are
625 if (!cycle_found && xhci_trb_virt_to_dma(new_seg, new_deq)
626 == (dma_addr_t)(hw_dequeue & ~0xf)) {
628 if (td_last_trb_found)
631 if (new_deq == cur_td->last_trb)
632 td_last_trb_found = true;
634 if (cycle_found && trb_is_link(new_deq) &&
635 link_trb_toggles_cycle(new_deq))
636 state->new_cycle_state ^= 0x1;
638 next_trb(xhci, ep_ring, &new_seg, &new_deq);
640 /* Search wrapped around, bail out */
641 if (new_deq == ep->ring->dequeue) {
642 xhci_err(xhci, "Error: Failed finding new dequeue state\n");
643 state->new_deq_seg = NULL;
644 state->new_deq_ptr = NULL;
648 } while (!cycle_found || !td_last_trb_found);
650 state->new_deq_seg = new_seg;
651 state->new_deq_ptr = new_deq;
654 /* Don't update the ring cycle state for the producer (us). */
655 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
656 "Cycle state = 0x%x", state->new_cycle_state);
658 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
659 "New dequeue segment = %p (virtual)",
661 addr = xhci_trb_virt_to_dma(state->new_deq_seg, state->new_deq_ptr);
662 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
663 "New dequeue pointer = 0x%llx (DMA)",
664 (unsigned long long) addr);
667 /* flip_cycle means flip the cycle bit of all but the first and last TRB.
668 * (The last TRB actually points to the ring enqueue pointer, which is not part
669 * of this TD.) This is used to remove partially enqueued isoc TDs from a ring.
671 static void td_to_noop(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
672 struct xhci_td *td, bool flip_cycle)
674 struct xhci_segment *seg = td->start_seg;
675 union xhci_trb *trb = td->first_trb;
678 trb_to_noop(trb, TRB_TR_NOOP);
680 /* flip cycle if asked to */
681 if (flip_cycle && trb != td->first_trb && trb != td->last_trb)
682 trb->generic.field[3] ^= cpu_to_le32(TRB_CYCLE);
684 if (trb == td->last_trb)
687 next_trb(xhci, ep_ring, &seg, &trb);
691 static void xhci_stop_watchdog_timer_in_irq(struct xhci_hcd *xhci,
692 struct xhci_virt_ep *ep)
694 ep->ep_state &= ~EP_STOP_CMD_PENDING;
695 /* Can't del_timer_sync in interrupt */
696 del_timer(&ep->stop_cmd_timer);
700 * Must be called with xhci->lock held in interrupt context,
701 * releases and re-acquires xhci->lock
703 static void xhci_giveback_urb_in_irq(struct xhci_hcd *xhci,
704 struct xhci_td *cur_td, int status)
706 struct urb *urb = cur_td->urb;
707 struct urb_priv *urb_priv = urb->hcpriv;
708 struct usb_hcd *hcd = bus_to_hcd(urb->dev->bus);
710 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
711 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs--;
712 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs == 0) {
713 if (xhci->quirks & XHCI_AMD_PLL_FIX)
714 usb_amd_quirk_pll_enable();
717 xhci_urb_free_priv(urb_priv);
718 usb_hcd_unlink_urb_from_ep(hcd, urb);
719 trace_xhci_urb_giveback(urb);
720 usb_hcd_giveback_urb(hcd, urb, status);
723 static void xhci_unmap_td_bounce_buffer(struct xhci_hcd *xhci,
724 struct xhci_ring *ring, struct xhci_td *td)
726 struct device *dev = xhci_to_hcd(xhci)->self.controller;
727 struct xhci_segment *seg = td->bounce_seg;
728 struct urb *urb = td->urb;
731 if (!ring || !seg || !urb)
734 if (usb_urb_dir_out(urb)) {
735 dma_unmap_single(dev, seg->bounce_dma, ring->bounce_buf_len,
740 dma_unmap_single(dev, seg->bounce_dma, ring->bounce_buf_len,
742 /* for in tranfers we need to copy the data from bounce to sg */
743 len = sg_pcopy_from_buffer(urb->sg, urb->num_sgs, seg->bounce_buf,
744 seg->bounce_len, seg->bounce_offs);
745 if (len != seg->bounce_len)
746 xhci_warn(xhci, "WARN Wrong bounce buffer read length: %zu != %d\n",
747 len, seg->bounce_len);
749 seg->bounce_offs = 0;
752 static int xhci_td_cleanup(struct xhci_hcd *xhci, struct xhci_td *td,
753 struct xhci_ring *ep_ring, int status)
755 struct urb *urb = NULL;
757 /* Clean up the endpoint's TD list */
760 /* if a bounce buffer was used to align this td then unmap it */
761 xhci_unmap_td_bounce_buffer(xhci, ep_ring, td);
763 /* Do one last check of the actual transfer length.
764 * If the host controller said we transferred more data than the buffer
765 * length, urb->actual_length will be a very big number (since it's
766 * unsigned). Play it safe and say we didn't transfer anything.
768 if (urb->actual_length > urb->transfer_buffer_length) {
769 xhci_warn(xhci, "URB req %u and actual %u transfer length mismatch\n",
770 urb->transfer_buffer_length, urb->actual_length);
771 urb->actual_length = 0;
774 /* TD might be removed from td_list if we are giving back a cancelled URB */
775 if (!list_empty(&td->td_list))
776 list_del_init(&td->td_list);
777 /* Giving back a cancelled URB, or if a slated TD completed anyway */
778 if (!list_empty(&td->cancelled_td_list))
779 list_del_init(&td->cancelled_td_list);
782 /* Giveback the urb when all the tds are completed */
783 if (last_td_in_urb(td)) {
784 if ((urb->actual_length != urb->transfer_buffer_length &&
785 (urb->transfer_flags & URB_SHORT_NOT_OK)) ||
786 (status != 0 && !usb_endpoint_xfer_isoc(&urb->ep->desc)))
787 xhci_dbg(xhci, "Giveback URB %p, len = %d, expected = %d, status = %d\n",
788 urb, urb->actual_length,
789 urb->transfer_buffer_length, status);
791 /* set isoc urb status to 0 just as EHCI, UHCI, and OHCI */
792 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS)
794 xhci_giveback_urb_in_irq(xhci, td, status);
801 /* Complete the cancelled URBs we unlinked from td_list. */
802 static void xhci_giveback_invalidated_tds(struct xhci_virt_ep *ep)
804 struct xhci_ring *ring;
805 struct xhci_td *td, *tmp_td;
807 list_for_each_entry_safe(td, tmp_td, &ep->cancelled_td_list,
811 * Doesn't matter what we pass for status, since the core will
812 * just overwrite it (because the URB has been unlinked).
814 ring = xhci_urb_to_transfer_ring(ep->xhci, td->urb);
816 if (td->cancel_status == TD_CLEARED)
817 xhci_td_cleanup(ep->xhci, td, ring, 0);
819 if (ep->xhci->xhc_state & XHCI_STATE_DYING)
824 static int xhci_reset_halted_ep(struct xhci_hcd *xhci, unsigned int slot_id,
825 unsigned int ep_index, enum xhci_ep_reset_type reset_type)
827 struct xhci_command *command;
830 command = xhci_alloc_command(xhci, false, GFP_ATOMIC);
836 ret = xhci_queue_reset_ep(xhci, command, slot_id, ep_index, reset_type);
839 xhci_err(xhci, "ERROR queuing reset endpoint for slot %d ep_index %d, %d\n",
840 slot_id, ep_index, ret);
844 static void xhci_handle_halted_endpoint(struct xhci_hcd *xhci,
845 struct xhci_virt_ep *ep, unsigned int stream_id,
847 enum xhci_ep_reset_type reset_type)
849 unsigned int slot_id = ep->vdev->slot_id;
853 * Avoid resetting endpoint if link is inactive. Can cause host hang.
854 * Device will be reset soon to recover the link so don't do anything
856 if (ep->vdev->flags & VDEV_PORT_ERROR)
859 ep->ep_state |= EP_HALTED;
861 /* add td to cancelled list and let reset ep handler take care of it */
862 if (reset_type == EP_HARD_RESET) {
863 ep->ep_state |= EP_HARD_CLEAR_TOGGLE;
864 if (td && list_empty(&td->cancelled_td_list)) {
865 list_add_tail(&td->cancelled_td_list, &ep->cancelled_td_list);
866 td->cancel_status = TD_HALTED;
870 err = xhci_reset_halted_ep(xhci, slot_id, ep->ep_index, reset_type);
874 xhci_ring_cmd_db(xhci);
878 * Fix up the ep ring first, so HW stops executing cancelled TDs.
879 * We have the xHCI lock, so nothing can modify this list until we drop it.
880 * We're also in the event handler, so we can't get re-interrupted if another
881 * Stop Endpoint command completes.
883 * only call this when ring is not in a running state
886 static int xhci_invalidate_cancelled_tds(struct xhci_virt_ep *ep)
888 struct xhci_hcd *xhci;
889 struct xhci_td *td = NULL;
890 struct xhci_td *tmp_td = NULL;
891 struct xhci_td *cached_td = NULL;
892 struct xhci_ring *ring;
893 struct xhci_dequeue_state deq_state;
895 unsigned int slot_id = ep->vdev->slot_id;
899 list_for_each_entry_safe(td, tmp_td, &ep->cancelled_td_list, cancelled_td_list) {
900 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
901 "Removing canceled TD starting at 0x%llx (dma).",
902 (unsigned long long)xhci_trb_virt_to_dma(
903 td->start_seg, td->first_trb));
904 list_del_init(&td->td_list);
905 ring = xhci_urb_to_transfer_ring(xhci, td->urb);
907 xhci_warn(xhci, "WARN Cancelled URB %p has invalid stream ID %u.\n",
908 td->urb, td->urb->stream_id);
912 * If ring stopped on the TD we need to cancel, then we have to
913 * move the xHC endpoint ring dequeue pointer past this TD.
915 hw_deq = xhci_get_hw_deq(xhci, ep->vdev, ep->ep_index,
919 if (trb_in_td(xhci, td->start_seg, td->first_trb,
920 td->last_trb, hw_deq, false)) {
921 switch (td->cancel_status) {
922 case TD_CLEARED: /* TD is already no-op */
923 case TD_CLEARING_CACHE: /* set TR deq command already queued */
925 case TD_DIRTY: /* TD is cached, clear it */
927 /* FIXME stream case, several stopped rings */
932 td_to_noop(xhci, ring, td, false);
933 td->cancel_status = TD_CLEARED;
937 cached_td->cancel_status = TD_CLEARING_CACHE;
938 xhci_find_new_dequeue_state(xhci, slot_id, ep->ep_index,
939 cached_td->urb->stream_id,
940 cached_td, &deq_state);
941 xhci_queue_new_dequeue_state(xhci, slot_id, ep->ep_index,
949 * Returns the TD the endpoint ring halted on.
950 * Only call for non-running rings without streams.
952 static struct xhci_td *find_halted_td(struct xhci_virt_ep *ep)
957 if (!list_empty(&ep->ring->td_list)) { /* Not streams compatible */
958 hw_deq = xhci_get_hw_deq(ep->xhci, ep->vdev, ep->ep_index, 0);
960 td = list_first_entry(&ep->ring->td_list, struct xhci_td, td_list);
961 if (trb_in_td(ep->xhci, td->start_seg, td->first_trb,
962 td->last_trb, hw_deq, false))
969 * When we get a command completion for a Stop Endpoint Command, we need to
970 * unlink any cancelled TDs from the ring. There are two ways to do that:
972 * 1. If the HW was in the middle of processing the TD that needs to be
973 * cancelled, then we must move the ring's dequeue pointer past the last TRB
974 * in the TD with a Set Dequeue Pointer Command.
975 * 2. Otherwise, we turn all the TRBs in the TD into No-op TRBs (with the chain
976 * bit cleared) so that the HW will skip over them.
978 static void xhci_handle_cmd_stop_ep(struct xhci_hcd *xhci, int slot_id,
979 union xhci_trb *trb, u32 comp_code)
981 unsigned int ep_index;
982 struct xhci_virt_ep *ep;
983 struct xhci_ep_ctx *ep_ctx;
984 struct xhci_td *td = NULL;
985 enum xhci_ep_reset_type reset_type;
986 struct xhci_command *command;
988 if (unlikely(TRB_TO_SUSPEND_PORT(le32_to_cpu(trb->generic.field[3])))) {
989 if (!xhci->devs[slot_id])
990 xhci_warn(xhci, "Stop endpoint command completion for disabled slot %u\n",
995 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
996 ep = xhci_get_virt_ep(xhci, slot_id, ep_index);
1000 ep_ctx = xhci_get_ep_ctx(xhci, ep->vdev->out_ctx, ep_index);
1002 trace_xhci_handle_cmd_stop_ep(ep_ctx);
1004 if (comp_code == COMP_CONTEXT_STATE_ERROR) {
1006 * If stop endpoint command raced with a halting endpoint we need to
1007 * reset the host side endpoint first.
1008 * If the TD we halted on isn't cancelled the TD should be given back
1009 * with a proper error code, and the ring dequeue moved past the TD.
1010 * If streams case we can't find hw_deq, or the TD we halted on so do a
1013 * Proper error code is unknown here, it would be -EPIPE if device side
1014 * of enadpoit halted (aka STALL), and -EPROTO if not (transaction error)
1015 * We use -EPROTO, if device is stalled it should return a stall error on
1016 * next transfer, which then will return -EPIPE, and device side stall is
1017 * noted and cleared by class driver.
1019 switch (GET_EP_CTX_STATE(ep_ctx)) {
1020 case EP_STATE_HALTED:
1021 xhci_dbg(xhci, "Stop ep completion raced with stall, reset ep\n");
1022 if (ep->ep_state & EP_HAS_STREAMS) {
1023 reset_type = EP_SOFT_RESET;
1025 reset_type = EP_HARD_RESET;
1026 td = find_halted_td(ep);
1028 td->status = -EPROTO;
1030 /* reset ep, reset handler cleans up cancelled tds */
1031 xhci_handle_halted_endpoint(xhci, ep, 0, td, reset_type);
1032 xhci_stop_watchdog_timer_in_irq(xhci, ep);
1034 case EP_STATE_RUNNING:
1035 /* Race, HW handled stop ep cmd before ep was running */
1036 command = xhci_alloc_command(xhci, false, GFP_ATOMIC);
1038 xhci_stop_watchdog_timer_in_irq(xhci, ep);
1040 mod_timer(&ep->stop_cmd_timer,
1041 jiffies + XHCI_STOP_EP_CMD_TIMEOUT * HZ);
1042 xhci_queue_stop_endpoint(xhci, command, slot_id, ep_index, 0);
1043 xhci_ring_cmd_db(xhci);
1050 /* will queue a set TR deq if stopped on a cancelled, uncleared TD */
1051 xhci_invalidate_cancelled_tds(ep);
1052 xhci_stop_watchdog_timer_in_irq(xhci, ep);
1054 /* Otherwise ring the doorbell(s) to restart queued transfers */
1055 xhci_giveback_invalidated_tds(ep);
1056 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1059 static void xhci_kill_ring_urbs(struct xhci_hcd *xhci, struct xhci_ring *ring)
1061 struct xhci_td *cur_td;
1062 struct xhci_td *tmp;
1064 list_for_each_entry_safe(cur_td, tmp, &ring->td_list, td_list) {
1065 list_del_init(&cur_td->td_list);
1067 if (!list_empty(&cur_td->cancelled_td_list))
1068 list_del_init(&cur_td->cancelled_td_list);
1070 xhci_unmap_td_bounce_buffer(xhci, ring, cur_td);
1072 inc_td_cnt(cur_td->urb);
1073 if (last_td_in_urb(cur_td))
1074 xhci_giveback_urb_in_irq(xhci, cur_td, -ESHUTDOWN);
1078 static void xhci_kill_endpoint_urbs(struct xhci_hcd *xhci,
1079 int slot_id, int ep_index)
1081 struct xhci_td *cur_td;
1082 struct xhci_td *tmp;
1083 struct xhci_virt_ep *ep;
1084 struct xhci_ring *ring;
1086 ep = &xhci->devs[slot_id]->eps[ep_index];
1087 if ((ep->ep_state & EP_HAS_STREAMS) ||
1088 (ep->ep_state & EP_GETTING_NO_STREAMS)) {
1091 for (stream_id = 1; stream_id < ep->stream_info->num_streams;
1093 ring = ep->stream_info->stream_rings[stream_id];
1097 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
1098 "Killing URBs for slot ID %u, ep index %u, stream %u",
1099 slot_id, ep_index, stream_id);
1100 xhci_kill_ring_urbs(xhci, ring);
1106 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
1107 "Killing URBs for slot ID %u, ep index %u",
1109 xhci_kill_ring_urbs(xhci, ring);
1112 list_for_each_entry_safe(cur_td, tmp, &ep->cancelled_td_list,
1113 cancelled_td_list) {
1114 list_del_init(&cur_td->cancelled_td_list);
1115 inc_td_cnt(cur_td->urb);
1117 if (last_td_in_urb(cur_td))
1118 xhci_giveback_urb_in_irq(xhci, cur_td, -ESHUTDOWN);
1123 * host controller died, register read returns 0xffffffff
1124 * Complete pending commands, mark them ABORTED.
1125 * URBs need to be given back as usb core might be waiting with device locks
1126 * held for the URBs to finish during device disconnect, blocking host remove.
1128 * Call with xhci->lock held.
1129 * lock is relased and re-acquired while giving back urb.
1131 void xhci_hc_died(struct xhci_hcd *xhci)
1135 if (xhci->xhc_state & XHCI_STATE_DYING)
1138 xhci_err(xhci, "xHCI host controller not responding, assume dead\n");
1139 xhci->xhc_state |= XHCI_STATE_DYING;
1141 xhci_cleanup_command_queue(xhci);
1143 /* return any pending urbs, remove may be waiting for them */
1144 for (i = 0; i <= HCS_MAX_SLOTS(xhci->hcs_params1); i++) {
1147 for (j = 0; j < 31; j++)
1148 xhci_kill_endpoint_urbs(xhci, i, j);
1151 /* inform usb core hc died if PCI remove isn't already handling it */
1152 if (!(xhci->xhc_state & XHCI_STATE_REMOVING))
1153 usb_hc_died(xhci_to_hcd(xhci));
1156 /* Watchdog timer function for when a stop endpoint command fails to complete.
1157 * In this case, we assume the host controller is broken or dying or dead. The
1158 * host may still be completing some other events, so we have to be careful to
1159 * let the event ring handler and the URB dequeueing/enqueueing functions know
1160 * through xhci->state.
1162 * The timer may also fire if the host takes a very long time to respond to the
1163 * command, and the stop endpoint command completion handler cannot delete the
1164 * timer before the timer function is called. Another endpoint cancellation may
1165 * sneak in before the timer function can grab the lock, and that may queue
1166 * another stop endpoint command and add the timer back. So we cannot use a
1167 * simple flag to say whether there is a pending stop endpoint command for a
1168 * particular endpoint.
1170 * Instead we use a combination of that flag and checking if a new timer is
1173 void xhci_stop_endpoint_command_watchdog(struct timer_list *t)
1175 struct xhci_virt_ep *ep = from_timer(ep, t, stop_cmd_timer);
1176 struct xhci_hcd *xhci = ep->xhci;
1177 unsigned long flags;
1180 spin_lock_irqsave(&xhci->lock, flags);
1182 /* bail out if cmd completed but raced with stop ep watchdog timer.*/
1183 if (!(ep->ep_state & EP_STOP_CMD_PENDING) ||
1184 timer_pending(&ep->stop_cmd_timer)) {
1185 spin_unlock_irqrestore(&xhci->lock, flags);
1186 xhci_dbg(xhci, "Stop EP timer raced with cmd completion, exit");
1189 usbsts = readl(&xhci->op_regs->status);
1191 xhci_warn(xhci, "xHCI host not responding to stop endpoint command.\n");
1192 xhci_warn(xhci, "USBSTS:%s\n", xhci_decode_usbsts(usbsts));
1194 ep->ep_state &= ~EP_STOP_CMD_PENDING;
1199 * handle a stop endpoint cmd timeout as if host died (-ENODEV).
1200 * In the future we could distinguish between -ENODEV and -ETIMEDOUT
1201 * and try to recover a -ETIMEDOUT with a host controller reset
1205 spin_unlock_irqrestore(&xhci->lock, flags);
1206 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
1207 "xHCI host controller is dead.");
1210 static void update_ring_for_set_deq_completion(struct xhci_hcd *xhci,
1211 struct xhci_virt_device *dev,
1212 struct xhci_ring *ep_ring,
1213 unsigned int ep_index)
1215 union xhci_trb *dequeue_temp;
1216 int num_trbs_free_temp;
1217 bool revert = false;
1219 num_trbs_free_temp = ep_ring->num_trbs_free;
1220 dequeue_temp = ep_ring->dequeue;
1222 /* If we get two back-to-back stalls, and the first stalled transfer
1223 * ends just before a link TRB, the dequeue pointer will be left on
1224 * the link TRB by the code in the while loop. So we have to update
1225 * the dequeue pointer one segment further, or we'll jump off
1226 * the segment into la-la-land.
1228 if (trb_is_link(ep_ring->dequeue)) {
1229 ep_ring->deq_seg = ep_ring->deq_seg->next;
1230 ep_ring->dequeue = ep_ring->deq_seg->trbs;
1233 while (ep_ring->dequeue != dev->eps[ep_index].queued_deq_ptr) {
1234 /* We have more usable TRBs */
1235 ep_ring->num_trbs_free++;
1237 if (trb_is_link(ep_ring->dequeue)) {
1238 if (ep_ring->dequeue ==
1239 dev->eps[ep_index].queued_deq_ptr)
1241 ep_ring->deq_seg = ep_ring->deq_seg->next;
1242 ep_ring->dequeue = ep_ring->deq_seg->trbs;
1244 if (ep_ring->dequeue == dequeue_temp) {
1251 xhci_dbg(xhci, "Unable to find new dequeue pointer\n");
1252 ep_ring->num_trbs_free = num_trbs_free_temp;
1257 * When we get a completion for a Set Transfer Ring Dequeue Pointer command,
1258 * we need to clear the set deq pending flag in the endpoint ring state, so that
1259 * the TD queueing code can ring the doorbell again. We also need to ring the
1260 * endpoint doorbell to restart the ring, but only if there aren't more
1261 * cancellations pending.
1263 static void xhci_handle_cmd_set_deq(struct xhci_hcd *xhci, int slot_id,
1264 union xhci_trb *trb, u32 cmd_comp_code)
1266 unsigned int ep_index;
1267 unsigned int stream_id;
1268 struct xhci_ring *ep_ring;
1269 struct xhci_virt_ep *ep;
1270 struct xhci_ep_ctx *ep_ctx;
1271 struct xhci_slot_ctx *slot_ctx;
1272 struct xhci_td *td, *tmp_td;
1274 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
1275 stream_id = TRB_TO_STREAM_ID(le32_to_cpu(trb->generic.field[2]));
1276 ep = xhci_get_virt_ep(xhci, slot_id, ep_index);
1280 ep_ring = xhci_virt_ep_to_ring(xhci, ep, stream_id);
1282 xhci_warn(xhci, "WARN Set TR deq ptr command for freed stream ID %u\n",
1284 /* XXX: Harmless??? */
1288 ep_ctx = xhci_get_ep_ctx(xhci, ep->vdev->out_ctx, ep_index);
1289 slot_ctx = xhci_get_slot_ctx(xhci, ep->vdev->out_ctx);
1290 trace_xhci_handle_cmd_set_deq(slot_ctx);
1291 trace_xhci_handle_cmd_set_deq_ep(ep_ctx);
1293 if (cmd_comp_code != COMP_SUCCESS) {
1294 unsigned int ep_state;
1295 unsigned int slot_state;
1297 switch (cmd_comp_code) {
1298 case COMP_TRB_ERROR:
1299 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd invalid because of stream ID configuration\n");
1301 case COMP_CONTEXT_STATE_ERROR:
1302 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed due to incorrect slot or ep state.\n");
1303 ep_state = GET_EP_CTX_STATE(ep_ctx);
1304 slot_state = le32_to_cpu(slot_ctx->dev_state);
1305 slot_state = GET_SLOT_STATE(slot_state);
1306 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
1307 "Slot state = %u, EP state = %u",
1308 slot_state, ep_state);
1310 case COMP_SLOT_NOT_ENABLED_ERROR:
1311 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed because slot %u was not enabled.\n",
1315 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd with unknown completion code of %u.\n",
1319 /* OK what do we do now? The endpoint state is hosed, and we
1320 * should never get to this point if the synchronization between
1321 * queueing, and endpoint state are correct. This might happen
1322 * if the device gets disconnected after we've finished
1323 * cancelling URBs, which might not be an error...
1327 /* 4.6.10 deq ptr is written to the stream ctx for streams */
1328 if (ep->ep_state & EP_HAS_STREAMS) {
1329 struct xhci_stream_ctx *ctx =
1330 &ep->stream_info->stream_ctx_array[stream_id];
1331 deq = le64_to_cpu(ctx->stream_ring) & SCTX_DEQ_MASK;
1333 deq = le64_to_cpu(ep_ctx->deq) & ~EP_CTX_CYCLE_MASK;
1335 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
1336 "Successful Set TR Deq Ptr cmd, deq = @%08llx", deq);
1337 if (xhci_trb_virt_to_dma(ep->queued_deq_seg,
1338 ep->queued_deq_ptr) == deq) {
1339 /* Update the ring's dequeue segment and dequeue pointer
1340 * to reflect the new position.
1342 update_ring_for_set_deq_completion(xhci, ep->vdev,
1345 xhci_warn(xhci, "Mismatch between completed Set TR Deq Ptr command & xHCI internal state.\n");
1346 xhci_warn(xhci, "ep deq seg = %p, deq ptr = %p\n",
1347 ep->queued_deq_seg, ep->queued_deq_ptr);
1350 /* HW cached TDs cleared from cache, give them back */
1351 list_for_each_entry_safe(td, tmp_td, &ep->cancelled_td_list,
1352 cancelled_td_list) {
1353 ep_ring = xhci_urb_to_transfer_ring(ep->xhci, td->urb);
1354 if (td->cancel_status == TD_CLEARING_CACHE) {
1355 td->cancel_status = TD_CLEARED;
1356 xhci_td_cleanup(ep->xhci, td, ep_ring, td->status);
1360 ep->ep_state &= ~SET_DEQ_PENDING;
1361 ep->queued_deq_seg = NULL;
1362 ep->queued_deq_ptr = NULL;
1363 /* Restart any rings with pending URBs */
1364 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1367 static void xhci_handle_cmd_reset_ep(struct xhci_hcd *xhci, int slot_id,
1368 union xhci_trb *trb, u32 cmd_comp_code)
1370 struct xhci_virt_ep *ep;
1371 struct xhci_ep_ctx *ep_ctx;
1372 unsigned int ep_index;
1374 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
1375 ep = xhci_get_virt_ep(xhci, slot_id, ep_index);
1379 ep_ctx = xhci_get_ep_ctx(xhci, ep->vdev->out_ctx, ep_index);
1380 trace_xhci_handle_cmd_reset_ep(ep_ctx);
1382 /* This command will only fail if the endpoint wasn't halted,
1383 * but we don't care.
1385 xhci_dbg_trace(xhci, trace_xhci_dbg_reset_ep,
1386 "Ignoring reset ep completion code of %u", cmd_comp_code);
1388 /* Cleanup cancelled TDs as ep is stopped. May queue a Set TR Deq cmd */
1389 xhci_invalidate_cancelled_tds(ep);
1391 if (xhci->quirks & XHCI_RESET_EP_QUIRK)
1392 xhci_dbg(xhci, "Note: Removed workaround to queue config ep for this hw");
1393 /* Clear our internal halted state */
1394 ep->ep_state &= ~EP_HALTED;
1396 xhci_giveback_invalidated_tds(ep);
1398 /* if this was a soft reset, then restart */
1399 if ((le32_to_cpu(trb->generic.field[3])) & TRB_TSP)
1400 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1403 static void xhci_handle_cmd_enable_slot(struct xhci_hcd *xhci, int slot_id,
1404 struct xhci_command *command, u32 cmd_comp_code)
1406 if (cmd_comp_code == COMP_SUCCESS)
1407 command->slot_id = slot_id;
1409 command->slot_id = 0;
1412 static void xhci_handle_cmd_disable_slot(struct xhci_hcd *xhci, int slot_id)
1414 struct xhci_virt_device *virt_dev;
1415 struct xhci_slot_ctx *slot_ctx;
1417 virt_dev = xhci->devs[slot_id];
1421 slot_ctx = xhci_get_slot_ctx(xhci, virt_dev->out_ctx);
1422 trace_xhci_handle_cmd_disable_slot(slot_ctx);
1424 if (xhci->quirks & XHCI_EP_LIMIT_QUIRK)
1425 /* Delete default control endpoint resources */
1426 xhci_free_device_endpoint_resources(xhci, virt_dev, true);
1427 xhci_free_virt_device(xhci, slot_id);
1430 static void xhci_handle_cmd_config_ep(struct xhci_hcd *xhci, int slot_id,
1433 struct xhci_virt_device *virt_dev;
1434 struct xhci_input_control_ctx *ctrl_ctx;
1435 struct xhci_ep_ctx *ep_ctx;
1436 unsigned int ep_index;
1437 unsigned int ep_state;
1438 u32 add_flags, drop_flags;
1441 * Configure endpoint commands can come from the USB core
1442 * configuration or alt setting changes, or because the HW
1443 * needed an extra configure endpoint command after a reset
1444 * endpoint command or streams were being configured.
1445 * If the command was for a halted endpoint, the xHCI driver
1446 * is not waiting on the configure endpoint command.
1448 virt_dev = xhci->devs[slot_id];
1451 ctrl_ctx = xhci_get_input_control_ctx(virt_dev->in_ctx);
1453 xhci_warn(xhci, "Could not get input context, bad type.\n");
1457 add_flags = le32_to_cpu(ctrl_ctx->add_flags);
1458 drop_flags = le32_to_cpu(ctrl_ctx->drop_flags);
1459 /* Input ctx add_flags are the endpoint index plus one */
1460 ep_index = xhci_last_valid_endpoint(add_flags) - 1;
1462 ep_ctx = xhci_get_ep_ctx(xhci, virt_dev->out_ctx, ep_index);
1463 trace_xhci_handle_cmd_config_ep(ep_ctx);
1465 /* A usb_set_interface() call directly after clearing a halted
1466 * condition may race on this quirky hardware. Not worth
1467 * worrying about, since this is prototype hardware. Not sure
1468 * if this will work for streams, but streams support was
1469 * untested on this prototype.
1471 if (xhci->quirks & XHCI_RESET_EP_QUIRK &&
1472 ep_index != (unsigned int) -1 &&
1473 add_flags - SLOT_FLAG == drop_flags) {
1474 ep_state = virt_dev->eps[ep_index].ep_state;
1475 if (!(ep_state & EP_HALTED))
1477 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
1478 "Completed config ep cmd - "
1479 "last ep index = %d, state = %d",
1480 ep_index, ep_state);
1481 /* Clear internal halted state and restart ring(s) */
1482 virt_dev->eps[ep_index].ep_state &= ~EP_HALTED;
1483 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1489 static void xhci_handle_cmd_addr_dev(struct xhci_hcd *xhci, int slot_id)
1491 struct xhci_virt_device *vdev;
1492 struct xhci_slot_ctx *slot_ctx;
1494 vdev = xhci->devs[slot_id];
1497 slot_ctx = xhci_get_slot_ctx(xhci, vdev->out_ctx);
1498 trace_xhci_handle_cmd_addr_dev(slot_ctx);
1501 static void xhci_handle_cmd_reset_dev(struct xhci_hcd *xhci, int slot_id)
1503 struct xhci_virt_device *vdev;
1504 struct xhci_slot_ctx *slot_ctx;
1506 vdev = xhci->devs[slot_id];
1508 xhci_warn(xhci, "Reset device command completion for disabled slot %u\n",
1512 slot_ctx = xhci_get_slot_ctx(xhci, vdev->out_ctx);
1513 trace_xhci_handle_cmd_reset_dev(slot_ctx);
1515 xhci_dbg(xhci, "Completed reset device command.\n");
1518 static void xhci_handle_cmd_nec_get_fw(struct xhci_hcd *xhci,
1519 struct xhci_event_cmd *event)
1521 if (!(xhci->quirks & XHCI_NEC_HOST)) {
1522 xhci_warn(xhci, "WARN NEC_GET_FW command on non-NEC host\n");
1525 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
1526 "NEC firmware version %2x.%02x",
1527 NEC_FW_MAJOR(le32_to_cpu(event->status)),
1528 NEC_FW_MINOR(le32_to_cpu(event->status)));
1531 static void xhci_complete_del_and_free_cmd(struct xhci_command *cmd, u32 status)
1533 list_del(&cmd->cmd_list);
1535 if (cmd->completion) {
1536 cmd->status = status;
1537 complete(cmd->completion);
1543 void xhci_cleanup_command_queue(struct xhci_hcd *xhci)
1545 struct xhci_command *cur_cmd, *tmp_cmd;
1546 xhci->current_cmd = NULL;
1547 list_for_each_entry_safe(cur_cmd, tmp_cmd, &xhci->cmd_list, cmd_list)
1548 xhci_complete_del_and_free_cmd(cur_cmd, COMP_COMMAND_ABORTED);
1551 void xhci_handle_command_timeout(struct work_struct *work)
1553 struct xhci_hcd *xhci;
1554 unsigned long flags;
1557 xhci = container_of(to_delayed_work(work), struct xhci_hcd, cmd_timer);
1559 spin_lock_irqsave(&xhci->lock, flags);
1562 * If timeout work is pending, or current_cmd is NULL, it means we
1563 * raced with command completion. Command is handled so just return.
1565 if (!xhci->current_cmd || delayed_work_pending(&xhci->cmd_timer)) {
1566 spin_unlock_irqrestore(&xhci->lock, flags);
1569 /* mark this command to be cancelled */
1570 xhci->current_cmd->status = COMP_COMMAND_ABORTED;
1572 /* Make sure command ring is running before aborting it */
1573 hw_ring_state = xhci_read_64(xhci, &xhci->op_regs->cmd_ring);
1574 if (hw_ring_state == ~(u64)0) {
1576 goto time_out_completed;
1579 if ((xhci->cmd_ring_state & CMD_RING_STATE_RUNNING) &&
1580 (hw_ring_state & CMD_RING_RUNNING)) {
1581 /* Prevent new doorbell, and start command abort */
1582 xhci->cmd_ring_state = CMD_RING_STATE_ABORTED;
1583 xhci_dbg(xhci, "Command timeout\n");
1584 xhci_abort_cmd_ring(xhci, flags);
1585 goto time_out_completed;
1588 /* host removed. Bail out */
1589 if (xhci->xhc_state & XHCI_STATE_REMOVING) {
1590 xhci_dbg(xhci, "host removed, ring start fail?\n");
1591 xhci_cleanup_command_queue(xhci);
1593 goto time_out_completed;
1596 /* command timeout on stopped ring, ring can't be aborted */
1597 xhci_dbg(xhci, "Command timeout on stopped ring\n");
1598 xhci_handle_stopped_cmd_ring(xhci, xhci->current_cmd);
1601 spin_unlock_irqrestore(&xhci->lock, flags);
1605 static void handle_cmd_completion(struct xhci_hcd *xhci,
1606 struct xhci_event_cmd *event)
1608 unsigned int slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
1610 dma_addr_t cmd_dequeue_dma;
1612 union xhci_trb *cmd_trb;
1613 struct xhci_command *cmd;
1616 if (slot_id >= MAX_HC_SLOTS) {
1617 xhci_warn(xhci, "Invalid slot_id %u\n", slot_id);
1621 cmd_dma = le64_to_cpu(event->cmd_trb);
1622 cmd_trb = xhci->cmd_ring->dequeue;
1624 trace_xhci_handle_command(xhci->cmd_ring, &cmd_trb->generic);
1626 cmd_dequeue_dma = xhci_trb_virt_to_dma(xhci->cmd_ring->deq_seg,
1629 * Check whether the completion event is for our internal kept
1632 if (!cmd_dequeue_dma || cmd_dma != (u64)cmd_dequeue_dma) {
1634 "ERROR mismatched command completion event\n");
1638 cmd = list_first_entry(&xhci->cmd_list, struct xhci_command, cmd_list);
1640 cancel_delayed_work(&xhci->cmd_timer);
1642 cmd_comp_code = GET_COMP_CODE(le32_to_cpu(event->status));
1644 /* If CMD ring stopped we own the trbs between enqueue and dequeue */
1645 if (cmd_comp_code == COMP_COMMAND_RING_STOPPED) {
1646 complete_all(&xhci->cmd_ring_stop_completion);
1650 if (cmd->command_trb != xhci->cmd_ring->dequeue) {
1652 "Command completion event does not match command\n");
1657 * Host aborted the command ring, check if the current command was
1658 * supposed to be aborted, otherwise continue normally.
1659 * The command ring is stopped now, but the xHC will issue a Command
1660 * Ring Stopped event which will cause us to restart it.
1662 if (cmd_comp_code == COMP_COMMAND_ABORTED) {
1663 xhci->cmd_ring_state = CMD_RING_STATE_STOPPED;
1664 if (cmd->status == COMP_COMMAND_ABORTED) {
1665 if (xhci->current_cmd == cmd)
1666 xhci->current_cmd = NULL;
1671 cmd_type = TRB_FIELD_TO_TYPE(le32_to_cpu(cmd_trb->generic.field[3]));
1673 case TRB_ENABLE_SLOT:
1674 xhci_handle_cmd_enable_slot(xhci, slot_id, cmd, cmd_comp_code);
1676 case TRB_DISABLE_SLOT:
1677 xhci_handle_cmd_disable_slot(xhci, slot_id);
1680 if (!cmd->completion)
1681 xhci_handle_cmd_config_ep(xhci, slot_id, cmd_comp_code);
1683 case TRB_EVAL_CONTEXT:
1686 xhci_handle_cmd_addr_dev(xhci, slot_id);
1689 WARN_ON(slot_id != TRB_TO_SLOT_ID(
1690 le32_to_cpu(cmd_trb->generic.field[3])));
1691 if (!cmd->completion)
1692 xhci_handle_cmd_stop_ep(xhci, slot_id, cmd_trb,
1696 WARN_ON(slot_id != TRB_TO_SLOT_ID(
1697 le32_to_cpu(cmd_trb->generic.field[3])));
1698 xhci_handle_cmd_set_deq(xhci, slot_id, cmd_trb, cmd_comp_code);
1701 /* Is this an aborted command turned to NO-OP? */
1702 if (cmd->status == COMP_COMMAND_RING_STOPPED)
1703 cmd_comp_code = COMP_COMMAND_RING_STOPPED;
1706 WARN_ON(slot_id != TRB_TO_SLOT_ID(
1707 le32_to_cpu(cmd_trb->generic.field[3])));
1708 xhci_handle_cmd_reset_ep(xhci, slot_id, cmd_trb, cmd_comp_code);
1711 /* SLOT_ID field in reset device cmd completion event TRB is 0.
1712 * Use the SLOT_ID from the command TRB instead (xhci 4.6.11)
1714 slot_id = TRB_TO_SLOT_ID(
1715 le32_to_cpu(cmd_trb->generic.field[3]));
1716 xhci_handle_cmd_reset_dev(xhci, slot_id);
1718 case TRB_NEC_GET_FW:
1719 xhci_handle_cmd_nec_get_fw(xhci, event);
1722 /* Skip over unknown commands on the event ring */
1723 xhci_info(xhci, "INFO unknown command type %d\n", cmd_type);
1727 /* restart timer if this wasn't the last command */
1728 if (!list_is_singular(&xhci->cmd_list)) {
1729 xhci->current_cmd = list_first_entry(&cmd->cmd_list,
1730 struct xhci_command, cmd_list);
1731 xhci_mod_cmd_timer(xhci, XHCI_CMD_DEFAULT_TIMEOUT);
1732 } else if (xhci->current_cmd == cmd) {
1733 xhci->current_cmd = NULL;
1737 xhci_complete_del_and_free_cmd(cmd, cmd_comp_code);
1739 inc_deq(xhci, xhci->cmd_ring);
1742 static void handle_vendor_event(struct xhci_hcd *xhci,
1743 union xhci_trb *event, u32 trb_type)
1745 xhci_dbg(xhci, "Vendor specific event TRB type = %u\n", trb_type);
1746 if (trb_type == TRB_NEC_CMD_COMP && (xhci->quirks & XHCI_NEC_HOST))
1747 handle_cmd_completion(xhci, &event->event_cmd);
1750 static void handle_device_notification(struct xhci_hcd *xhci,
1751 union xhci_trb *event)
1754 struct usb_device *udev;
1756 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->generic.field[3]));
1757 if (!xhci->devs[slot_id]) {
1758 xhci_warn(xhci, "Device Notification event for "
1759 "unused slot %u\n", slot_id);
1763 xhci_dbg(xhci, "Device Wake Notification event for slot ID %u\n",
1765 udev = xhci->devs[slot_id]->udev;
1766 if (udev && udev->parent)
1767 usb_wakeup_notification(udev->parent, udev->portnum);
1771 * Quirk hanlder for errata seen on Cavium ThunderX2 processor XHCI
1773 * As per ThunderX2errata-129 USB 2 device may come up as USB 1
1774 * If a connection to a USB 1 device is followed by another connection
1775 * to a USB 2 device.
1777 * Reset the PHY after the USB device is disconnected if device speed
1778 * is less than HCD_USB3.
1779 * Retry the reset sequence max of 4 times checking the PLL lock status.
1782 static void xhci_cavium_reset_phy_quirk(struct xhci_hcd *xhci)
1784 struct usb_hcd *hcd = xhci_to_hcd(xhci);
1786 u32 retry_count = 4;
1789 /* Assert PHY reset */
1790 writel(0x6F, hcd->regs + 0x1048);
1792 /* De-assert the PHY reset */
1793 writel(0x7F, hcd->regs + 0x1048);
1795 pll_lock_check = readl(hcd->regs + 0x1070);
1796 } while (!(pll_lock_check & 0x1) && --retry_count);
1799 static void handle_port_status(struct xhci_hcd *xhci,
1800 union xhci_trb *event)
1802 struct usb_hcd *hcd;
1804 u32 portsc, cmd_reg;
1807 unsigned int hcd_portnum;
1808 struct xhci_bus_state *bus_state;
1809 bool bogus_port_status = false;
1810 struct xhci_port *port;
1812 /* Port status change events always have a successful completion code */
1813 if (GET_COMP_CODE(le32_to_cpu(event->generic.field[2])) != COMP_SUCCESS)
1815 "WARN: xHC returned failed port status event\n");
1817 port_id = GET_PORT_ID(le32_to_cpu(event->generic.field[0]));
1818 max_ports = HCS_MAX_PORTS(xhci->hcs_params1);
1820 if ((port_id <= 0) || (port_id > max_ports)) {
1821 xhci_warn(xhci, "Port change event with invalid port ID %d\n",
1823 inc_deq(xhci, xhci->event_ring);
1827 port = &xhci->hw_ports[port_id - 1];
1828 if (!port || !port->rhub || port->hcd_portnum == DUPLICATE_ENTRY) {
1829 xhci_warn(xhci, "Port change event, no port for port ID %u\n",
1831 bogus_port_status = true;
1835 /* We might get interrupts after shared_hcd is removed */
1836 if (port->rhub == &xhci->usb3_rhub && xhci->shared_hcd == NULL) {
1837 xhci_dbg(xhci, "ignore port event for removed USB3 hcd\n");
1838 bogus_port_status = true;
1842 hcd = port->rhub->hcd;
1843 bus_state = &port->rhub->bus_state;
1844 hcd_portnum = port->hcd_portnum;
1845 portsc = readl(port->addr);
1847 xhci_dbg(xhci, "Port change event, %d-%d, id %d, portsc: 0x%x\n",
1848 hcd->self.busnum, hcd_portnum + 1, port_id, portsc);
1850 trace_xhci_handle_port_status(hcd_portnum, portsc);
1852 if (hcd->state == HC_STATE_SUSPENDED) {
1853 xhci_dbg(xhci, "resume root hub\n");
1854 usb_hcd_resume_root_hub(hcd);
1857 if (hcd->speed >= HCD_USB3 &&
1858 (portsc & PORT_PLS_MASK) == XDEV_INACTIVE) {
1859 slot_id = xhci_find_slot_id_by_port(hcd, xhci, hcd_portnum + 1);
1860 if (slot_id && xhci->devs[slot_id])
1861 xhci->devs[slot_id]->flags |= VDEV_PORT_ERROR;
1864 if ((portsc & PORT_PLC) && (portsc & PORT_PLS_MASK) == XDEV_RESUME) {
1865 xhci_dbg(xhci, "port resume event for port %d\n", port_id);
1867 cmd_reg = readl(&xhci->op_regs->command);
1868 if (!(cmd_reg & CMD_RUN)) {
1869 xhci_warn(xhci, "xHC is not running.\n");
1873 if (DEV_SUPERSPEED_ANY(portsc)) {
1874 xhci_dbg(xhci, "remote wake SS port %d\n", port_id);
1875 /* Set a flag to say the port signaled remote wakeup,
1876 * so we can tell the difference between the end of
1877 * device and host initiated resume.
1879 bus_state->port_remote_wakeup |= 1 << hcd_portnum;
1880 xhci_test_and_clear_bit(xhci, port, PORT_PLC);
1881 usb_hcd_start_port_resume(&hcd->self, hcd_portnum);
1882 xhci_set_link_state(xhci, port, XDEV_U0);
1883 /* Need to wait until the next link state change
1884 * indicates the device is actually in U0.
1886 bogus_port_status = true;
1888 } else if (!test_bit(hcd_portnum, &bus_state->resuming_ports)) {
1889 xhci_dbg(xhci, "resume HS port %d\n", port_id);
1890 bus_state->resume_done[hcd_portnum] = jiffies +
1891 msecs_to_jiffies(USB_RESUME_TIMEOUT);
1892 set_bit(hcd_portnum, &bus_state->resuming_ports);
1893 /* Do the rest in GetPortStatus after resume time delay.
1894 * Avoid polling roothub status before that so that a
1895 * usb device auto-resume latency around ~40ms.
1897 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1898 mod_timer(&hcd->rh_timer,
1899 bus_state->resume_done[hcd_portnum]);
1900 usb_hcd_start_port_resume(&hcd->self, hcd_portnum);
1901 bogus_port_status = true;
1905 if ((portsc & PORT_PLC) &&
1906 DEV_SUPERSPEED_ANY(portsc) &&
1907 ((portsc & PORT_PLS_MASK) == XDEV_U0 ||
1908 (portsc & PORT_PLS_MASK) == XDEV_U1 ||
1909 (portsc & PORT_PLS_MASK) == XDEV_U2)) {
1910 xhci_dbg(xhci, "resume SS port %d finished\n", port_id);
1911 complete(&bus_state->u3exit_done[hcd_portnum]);
1912 /* We've just brought the device into U0/1/2 through either the
1913 * Resume state after a device remote wakeup, or through the
1914 * U3Exit state after a host-initiated resume. If it's a device
1915 * initiated remote wake, don't pass up the link state change,
1916 * so the roothub behavior is consistent with external
1917 * USB 3.0 hub behavior.
1919 slot_id = xhci_find_slot_id_by_port(hcd, xhci, hcd_portnum + 1);
1920 if (slot_id && xhci->devs[slot_id])
1921 xhci_ring_device(xhci, slot_id);
1922 if (bus_state->port_remote_wakeup & (1 << hcd_portnum)) {
1923 xhci_test_and_clear_bit(xhci, port, PORT_PLC);
1924 usb_wakeup_notification(hcd->self.root_hub,
1926 bogus_port_status = true;
1932 * Check to see if xhci-hub.c is waiting on RExit to U0 transition (or
1933 * RExit to a disconnect state). If so, let the the driver know it's
1934 * out of the RExit state.
1936 if (!DEV_SUPERSPEED_ANY(portsc) && hcd->speed < HCD_USB3 &&
1937 test_and_clear_bit(hcd_portnum,
1938 &bus_state->rexit_ports)) {
1939 complete(&bus_state->rexit_done[hcd_portnum]);
1940 bogus_port_status = true;
1944 if (hcd->speed < HCD_USB3) {
1945 xhci_test_and_clear_bit(xhci, port, PORT_PLC);
1946 if ((xhci->quirks & XHCI_RESET_PLL_ON_DISCONNECT) &&
1947 (portsc & PORT_CSC) && !(portsc & PORT_CONNECT))
1948 xhci_cavium_reset_phy_quirk(xhci);
1952 /* Update event ring dequeue pointer before dropping the lock */
1953 inc_deq(xhci, xhci->event_ring);
1955 /* Don't make the USB core poll the roothub if we got a bad port status
1956 * change event. Besides, at that point we can't tell which roothub
1957 * (USB 2.0 or USB 3.0) to kick.
1959 if (bogus_port_status)
1963 * xHCI port-status-change events occur when the "or" of all the
1964 * status-change bits in the portsc register changes from 0 to 1.
1965 * New status changes won't cause an event if any other change
1966 * bits are still set. When an event occurs, switch over to
1967 * polling to avoid losing status changes.
1969 xhci_dbg(xhci, "%s: starting port polling.\n", __func__);
1970 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
1971 spin_unlock(&xhci->lock);
1972 /* Pass this up to the core */
1973 usb_hcd_poll_rh_status(hcd);
1974 spin_lock(&xhci->lock);
1978 * This TD is defined by the TRBs starting at start_trb in start_seg and ending
1979 * at end_trb, which may be in another segment. If the suspect DMA address is a
1980 * TRB in this TD, this function returns that TRB's segment. Otherwise it
1983 struct xhci_segment *trb_in_td(struct xhci_hcd *xhci,
1984 struct xhci_segment *start_seg,
1985 union xhci_trb *start_trb,
1986 union xhci_trb *end_trb,
1987 dma_addr_t suspect_dma,
1990 dma_addr_t start_dma;
1991 dma_addr_t end_seg_dma;
1992 dma_addr_t end_trb_dma;
1993 struct xhci_segment *cur_seg;
1995 start_dma = xhci_trb_virt_to_dma(start_seg, start_trb);
1996 cur_seg = start_seg;
2001 /* We may get an event for a Link TRB in the middle of a TD */
2002 end_seg_dma = xhci_trb_virt_to_dma(cur_seg,
2003 &cur_seg->trbs[TRBS_PER_SEGMENT - 1]);
2004 /* If the end TRB isn't in this segment, this is set to 0 */
2005 end_trb_dma = xhci_trb_virt_to_dma(cur_seg, end_trb);
2009 "Looking for event-dma %016llx trb-start %016llx trb-end %016llx seg-start %016llx seg-end %016llx\n",
2010 (unsigned long long)suspect_dma,
2011 (unsigned long long)start_dma,
2012 (unsigned long long)end_trb_dma,
2013 (unsigned long long)cur_seg->dma,
2014 (unsigned long long)end_seg_dma);
2016 if (end_trb_dma > 0) {
2017 /* The end TRB is in this segment, so suspect should be here */
2018 if (start_dma <= end_trb_dma) {
2019 if (suspect_dma >= start_dma && suspect_dma <= end_trb_dma)
2022 /* Case for one segment with
2023 * a TD wrapped around to the top
2025 if ((suspect_dma >= start_dma &&
2026 suspect_dma <= end_seg_dma) ||
2027 (suspect_dma >= cur_seg->dma &&
2028 suspect_dma <= end_trb_dma))
2033 /* Might still be somewhere in this segment */
2034 if (suspect_dma >= start_dma && suspect_dma <= end_seg_dma)
2037 cur_seg = cur_seg->next;
2038 start_dma = xhci_trb_virt_to_dma(cur_seg, &cur_seg->trbs[0]);
2039 } while (cur_seg != start_seg);
2044 static void xhci_clear_hub_tt_buffer(struct xhci_hcd *xhci, struct xhci_td *td,
2045 struct xhci_virt_ep *ep)
2048 * As part of low/full-speed endpoint-halt processing
2049 * we must clear the TT buffer (USB 2.0 specification 11.17.5).
2051 if (td->urb->dev->tt && !usb_pipeint(td->urb->pipe) &&
2052 (td->urb->dev->tt->hub != xhci_to_hcd(xhci)->self.root_hub) &&
2053 !(ep->ep_state & EP_CLEARING_TT)) {
2054 ep->ep_state |= EP_CLEARING_TT;
2055 td->urb->ep->hcpriv = td->urb->dev;
2056 if (usb_hub_clear_tt_buffer(td->urb))
2057 ep->ep_state &= ~EP_CLEARING_TT;
2061 /* Check if an error has halted the endpoint ring. The class driver will
2062 * cleanup the halt for a non-default control endpoint if we indicate a stall.
2063 * However, a babble and other errors also halt the endpoint ring, and the class
2064 * driver won't clear the halt in that case, so we need to issue a Set Transfer
2065 * Ring Dequeue Pointer command manually.
2067 static int xhci_requires_manual_halt_cleanup(struct xhci_hcd *xhci,
2068 struct xhci_ep_ctx *ep_ctx,
2069 unsigned int trb_comp_code)
2071 /* TRB completion codes that may require a manual halt cleanup */
2072 if (trb_comp_code == COMP_USB_TRANSACTION_ERROR ||
2073 trb_comp_code == COMP_BABBLE_DETECTED_ERROR ||
2074 trb_comp_code == COMP_SPLIT_TRANSACTION_ERROR)
2075 /* The 0.95 spec says a babbling control endpoint
2076 * is not halted. The 0.96 spec says it is. Some HW
2077 * claims to be 0.95 compliant, but it halts the control
2078 * endpoint anyway. Check if a babble halted the
2081 if (GET_EP_CTX_STATE(ep_ctx) == EP_STATE_HALTED)
2087 int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code)
2089 if (trb_comp_code >= 224 && trb_comp_code <= 255) {
2090 /* Vendor defined "informational" completion code,
2091 * treat as not-an-error.
2093 xhci_dbg(xhci, "Vendor defined info completion code %u\n",
2095 xhci_dbg(xhci, "Treating code as success.\n");
2101 static int finish_td(struct xhci_hcd *xhci, struct xhci_td *td,
2102 struct xhci_transfer_event *event, struct xhci_virt_ep *ep)
2104 struct xhci_ep_ctx *ep_ctx;
2105 struct xhci_ring *ep_ring;
2108 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2109 ep_ctx = xhci_get_ep_ctx(xhci, ep->vdev->out_ctx, ep->ep_index);
2110 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2112 if (trb_comp_code == COMP_STOPPED_LENGTH_INVALID ||
2113 trb_comp_code == COMP_STOPPED ||
2114 trb_comp_code == COMP_STOPPED_SHORT_PACKET) {
2115 /* The Endpoint Stop Command completion will take care of any
2116 * stopped TDs. A stopped TD may be restarted, so don't update
2117 * the ring dequeue pointer or take this TD off any lists yet.
2121 if (trb_comp_code == COMP_STALL_ERROR ||
2122 xhci_requires_manual_halt_cleanup(xhci, ep_ctx,
2125 * xhci internal endpoint state will go to a "halt" state for
2126 * any stall, including default control pipe protocol stall.
2127 * To clear the host side halt we need to issue a reset endpoint
2128 * command, followed by a set dequeue command to move past the
2130 * Class drivers clear the device side halt from a functional
2131 * stall later. Hub TT buffer should only be cleared for FS/LS
2132 * devices behind HS hubs for functional stalls.
2134 if ((ep->ep_index != 0) || (trb_comp_code != COMP_STALL_ERROR))
2135 xhci_clear_hub_tt_buffer(xhci, td, ep);
2137 xhci_handle_halted_endpoint(xhci, ep, ep_ring->stream_id, td,
2140 return 0; /* xhci_handle_halted_endpoint marked td cancelled */
2142 /* Update ring dequeue pointer */
2143 ep_ring->dequeue = td->last_trb;
2144 ep_ring->deq_seg = td->last_trb_seg;
2145 ep_ring->num_trbs_free += td->num_trbs - 1;
2146 inc_deq(xhci, ep_ring);
2149 return xhci_td_cleanup(xhci, td, ep_ring, td->status);
2152 /* sum trb lengths from ring dequeue up to stop_trb, _excluding_ stop_trb */
2153 static int sum_trb_lengths(struct xhci_hcd *xhci, struct xhci_ring *ring,
2154 union xhci_trb *stop_trb)
2157 union xhci_trb *trb = ring->dequeue;
2158 struct xhci_segment *seg = ring->deq_seg;
2160 for (sum = 0; trb != stop_trb; next_trb(xhci, ring, &seg, &trb)) {
2161 if (!trb_is_noop(trb) && !trb_is_link(trb))
2162 sum += TRB_LEN(le32_to_cpu(trb->generic.field[2]));
2168 * Process control tds, update urb status and actual_length.
2170 static int process_ctrl_td(struct xhci_hcd *xhci, struct xhci_td *td,
2171 union xhci_trb *ep_trb, struct xhci_transfer_event *event,
2172 struct xhci_virt_ep *ep)
2174 struct xhci_ep_ctx *ep_ctx;
2176 u32 remaining, requested;
2179 trb_type = TRB_FIELD_TO_TYPE(le32_to_cpu(ep_trb->generic.field[3]));
2180 ep_ctx = xhci_get_ep_ctx(xhci, ep->vdev->out_ctx, ep->ep_index);
2181 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2182 requested = td->urb->transfer_buffer_length;
2183 remaining = EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
2185 switch (trb_comp_code) {
2187 if (trb_type != TRB_STATUS) {
2188 xhci_warn(xhci, "WARN: Success on ctrl %s TRB without IOC set?\n",
2189 (trb_type == TRB_DATA) ? "data" : "setup");
2190 td->status = -ESHUTDOWN;
2195 case COMP_SHORT_PACKET:
2198 case COMP_STOPPED_SHORT_PACKET:
2199 if (trb_type == TRB_DATA || trb_type == TRB_NORMAL)
2200 td->urb->actual_length = remaining;
2202 xhci_warn(xhci, "WARN: Stopped Short Packet on ctrl setup or status TRB\n");
2207 td->urb->actual_length = 0;
2211 td->urb->actual_length = requested - remaining;
2214 td->urb->actual_length = requested;
2217 xhci_warn(xhci, "WARN: unexpected TRB Type %d\n",
2221 case COMP_STOPPED_LENGTH_INVALID:
2224 if (!xhci_requires_manual_halt_cleanup(xhci,
2225 ep_ctx, trb_comp_code))
2227 xhci_dbg(xhci, "TRB error %u, halted endpoint index = %u\n",
2228 trb_comp_code, ep->ep_index);
2230 case COMP_STALL_ERROR:
2231 /* Did we transfer part of the data (middle) phase? */
2232 if (trb_type == TRB_DATA || trb_type == TRB_NORMAL)
2233 td->urb->actual_length = requested - remaining;
2234 else if (!td->urb_length_set)
2235 td->urb->actual_length = 0;
2239 /* stopped at setup stage, no data transferred */
2240 if (trb_type == TRB_SETUP)
2244 * if on data stage then update the actual_length of the URB and flag it
2245 * as set, so it won't be overwritten in the event for the last TRB.
2247 if (trb_type == TRB_DATA ||
2248 trb_type == TRB_NORMAL) {
2249 td->urb_length_set = true;
2250 td->urb->actual_length = requested - remaining;
2251 xhci_dbg(xhci, "Waiting for status stage event\n");
2255 /* at status stage */
2256 if (!td->urb_length_set)
2257 td->urb->actual_length = requested;
2260 return finish_td(xhci, td, event, ep);
2264 * Process isochronous tds, update urb packet status and actual_length.
2266 static int process_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
2267 union xhci_trb *ep_trb, struct xhci_transfer_event *event,
2268 struct xhci_virt_ep *ep)
2270 struct urb_priv *urb_priv;
2272 struct usb_iso_packet_descriptor *frame;
2274 bool sum_trbs_for_length = false;
2275 u32 remaining, requested, ep_trb_len;
2276 int short_framestatus;
2278 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2279 urb_priv = td->urb->hcpriv;
2280 idx = urb_priv->num_tds_done;
2281 frame = &td->urb->iso_frame_desc[idx];
2282 requested = frame->length;
2283 remaining = EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
2284 ep_trb_len = TRB_LEN(le32_to_cpu(ep_trb->generic.field[2]));
2285 short_framestatus = td->urb->transfer_flags & URB_SHORT_NOT_OK ?
2288 /* handle completion code */
2289 switch (trb_comp_code) {
2292 frame->status = short_framestatus;
2293 if (xhci->quirks & XHCI_TRUST_TX_LENGTH)
2294 sum_trbs_for_length = true;
2299 case COMP_SHORT_PACKET:
2300 frame->status = short_framestatus;
2301 sum_trbs_for_length = true;
2303 case COMP_BANDWIDTH_OVERRUN_ERROR:
2304 frame->status = -ECOMM;
2306 case COMP_ISOCH_BUFFER_OVERRUN:
2307 case COMP_BABBLE_DETECTED_ERROR:
2308 frame->status = -EOVERFLOW;
2310 case COMP_INCOMPATIBLE_DEVICE_ERROR:
2311 case COMP_STALL_ERROR:
2312 frame->status = -EPROTO;
2314 case COMP_USB_TRANSACTION_ERROR:
2315 frame->status = -EPROTO;
2316 if (ep_trb != td->last_trb)
2320 sum_trbs_for_length = true;
2322 case COMP_STOPPED_SHORT_PACKET:
2323 /* field normally containing residue now contains tranferred */
2324 frame->status = short_framestatus;
2325 requested = remaining;
2327 case COMP_STOPPED_LENGTH_INVALID:
2332 sum_trbs_for_length = true;
2337 if (sum_trbs_for_length)
2338 frame->actual_length = sum_trb_lengths(xhci, ep->ring, ep_trb) +
2339 ep_trb_len - remaining;
2341 frame->actual_length = requested;
2343 td->urb->actual_length += frame->actual_length;
2345 return finish_td(xhci, td, event, ep);
2348 static int skip_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
2349 struct xhci_virt_ep *ep, int status)
2351 struct urb_priv *urb_priv;
2352 struct usb_iso_packet_descriptor *frame;
2355 urb_priv = td->urb->hcpriv;
2356 idx = urb_priv->num_tds_done;
2357 frame = &td->urb->iso_frame_desc[idx];
2359 /* The transfer is partly done. */
2360 frame->status = -EXDEV;
2362 /* calc actual length */
2363 frame->actual_length = 0;
2365 /* Update ring dequeue pointer */
2366 ep->ring->dequeue = td->last_trb;
2367 ep->ring->deq_seg = td->last_trb_seg;
2368 ep->ring->num_trbs_free += td->num_trbs - 1;
2369 inc_deq(xhci, ep->ring);
2371 return xhci_td_cleanup(xhci, td, ep->ring, status);
2375 * Process bulk and interrupt tds, update urb status and actual_length.
2377 static int process_bulk_intr_td(struct xhci_hcd *xhci, struct xhci_td *td,
2378 union xhci_trb *ep_trb, struct xhci_transfer_event *event,
2379 struct xhci_virt_ep *ep)
2381 struct xhci_slot_ctx *slot_ctx;
2382 struct xhci_ring *ep_ring;
2384 u32 remaining, requested, ep_trb_len;
2386 slot_ctx = xhci_get_slot_ctx(xhci, ep->vdev->out_ctx);
2387 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2388 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2389 remaining = EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
2390 ep_trb_len = TRB_LEN(le32_to_cpu(ep_trb->generic.field[2]));
2391 requested = td->urb->transfer_buffer_length;
2393 switch (trb_comp_code) {
2395 ep_ring->err_count = 0;
2396 /* handle success with untransferred data as short packet */
2397 if (ep_trb != td->last_trb || remaining) {
2398 xhci_warn(xhci, "WARN Successful completion on short TX\n");
2399 xhci_dbg(xhci, "ep %#x - asked for %d bytes, %d bytes untransferred\n",
2400 td->urb->ep->desc.bEndpointAddress,
2401 requested, remaining);
2405 case COMP_SHORT_PACKET:
2406 xhci_dbg(xhci, "ep %#x - asked for %d bytes, %d bytes untransferred\n",
2407 td->urb->ep->desc.bEndpointAddress,
2408 requested, remaining);
2411 case COMP_STOPPED_SHORT_PACKET:
2412 td->urb->actual_length = remaining;
2414 case COMP_STOPPED_LENGTH_INVALID:
2415 /* stopped on ep trb with invalid length, exclude it */
2419 case COMP_USB_TRANSACTION_ERROR:
2420 if ((ep_ring->err_count++ > MAX_SOFT_RETRY) ||
2421 le32_to_cpu(slot_ctx->tt_info) & TT_SLOT)
2426 xhci_handle_halted_endpoint(xhci, ep, ep_ring->stream_id, td,
2434 if (ep_trb == td->last_trb)
2435 td->urb->actual_length = requested - remaining;
2437 td->urb->actual_length =
2438 sum_trb_lengths(xhci, ep_ring, ep_trb) +
2439 ep_trb_len - remaining;
2441 if (remaining > requested) {
2442 xhci_warn(xhci, "bad transfer trb length %d in event trb\n",
2444 td->urb->actual_length = 0;
2446 return finish_td(xhci, td, event, ep);
2450 * If this function returns an error condition, it means it got a Transfer
2451 * event with a corrupted Slot ID, Endpoint ID, or TRB DMA address.
2452 * At this point, the host controller is probably hosed and should be reset.
2454 static int handle_tx_event(struct xhci_hcd *xhci,
2455 struct xhci_transfer_event *event)
2457 struct xhci_virt_ep *ep;
2458 struct xhci_ring *ep_ring;
2459 unsigned int slot_id;
2461 struct xhci_td *td = NULL;
2462 dma_addr_t ep_trb_dma;
2463 struct xhci_segment *ep_seg;
2464 union xhci_trb *ep_trb;
2465 int status = -EINPROGRESS;
2466 struct xhci_ep_ctx *ep_ctx;
2467 struct list_head *tmp;
2470 bool handling_skipped_tds = false;
2472 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
2473 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
2474 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
2475 ep_trb_dma = le64_to_cpu(event->buffer);
2477 ep = xhci_get_virt_ep(xhci, slot_id, ep_index);
2479 xhci_err(xhci, "ERROR Invalid Transfer event\n");
2483 ep_ring = xhci_dma_to_transfer_ring(ep, ep_trb_dma);
2484 ep_ctx = xhci_get_ep_ctx(xhci, ep->vdev->out_ctx, ep_index);
2486 if (GET_EP_CTX_STATE(ep_ctx) == EP_STATE_DISABLED) {
2488 "ERROR Transfer event for disabled endpoint slot %u ep %u\n",
2493 /* Some transfer events don't always point to a trb, see xhci 4.17.4 */
2495 switch (trb_comp_code) {
2496 case COMP_STALL_ERROR:
2497 case COMP_USB_TRANSACTION_ERROR:
2498 case COMP_INVALID_STREAM_TYPE_ERROR:
2499 case COMP_INVALID_STREAM_ID_ERROR:
2500 xhci_handle_halted_endpoint(xhci, ep, 0, NULL,
2503 case COMP_RING_UNDERRUN:
2504 case COMP_RING_OVERRUN:
2505 case COMP_STOPPED_LENGTH_INVALID:
2508 xhci_err(xhci, "ERROR Transfer event for unknown stream ring slot %u ep %u\n",
2514 /* Count current td numbers if ep->skip is set */
2516 list_for_each(tmp, &ep_ring->td_list)
2520 /* Look for common error cases */
2521 switch (trb_comp_code) {
2522 /* Skip codes that require special handling depending on
2526 if (EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) == 0)
2528 if (xhci->quirks & XHCI_TRUST_TX_LENGTH ||
2529 ep_ring->last_td_was_short)
2530 trb_comp_code = COMP_SHORT_PACKET;
2532 xhci_warn_ratelimited(xhci,
2533 "WARN Successful completion on short TX for slot %u ep %u: needs XHCI_TRUST_TX_LENGTH quirk?\n",
2536 case COMP_SHORT_PACKET:
2538 /* Completion codes for endpoint stopped state */
2540 xhci_dbg(xhci, "Stopped on Transfer TRB for slot %u ep %u\n",
2543 case COMP_STOPPED_LENGTH_INVALID:
2545 "Stopped on No-op or Link TRB for slot %u ep %u\n",
2548 case COMP_STOPPED_SHORT_PACKET:
2550 "Stopped with short packet transfer detected for slot %u ep %u\n",
2553 /* Completion codes for endpoint halted state */
2554 case COMP_STALL_ERROR:
2555 xhci_dbg(xhci, "Stalled endpoint for slot %u ep %u\n", slot_id,
2557 ep->ep_state |= EP_HALTED;
2560 case COMP_SPLIT_TRANSACTION_ERROR:
2561 xhci_dbg(xhci, "Split transaction error for slot %u ep %u\n",
2565 case COMP_USB_TRANSACTION_ERROR:
2566 xhci_dbg(xhci, "Transfer error for slot %u ep %u on endpoint\n",
2570 case COMP_BABBLE_DETECTED_ERROR:
2571 xhci_dbg(xhci, "Babble error for slot %u ep %u on endpoint\n",
2573 status = -EOVERFLOW;
2575 /* Completion codes for endpoint error state */
2576 case COMP_TRB_ERROR:
2578 "WARN: TRB error for slot %u ep %u on endpoint\n",
2582 /* completion codes not indicating endpoint state change */
2583 case COMP_DATA_BUFFER_ERROR:
2585 "WARN: HC couldn't access mem fast enough for slot %u ep %u\n",
2589 case COMP_BANDWIDTH_OVERRUN_ERROR:
2591 "WARN: bandwidth overrun event for slot %u ep %u on endpoint\n",
2594 case COMP_ISOCH_BUFFER_OVERRUN:
2596 "WARN: buffer overrun event for slot %u ep %u on endpoint",
2599 case COMP_RING_UNDERRUN:
2601 * When the Isoch ring is empty, the xHC will generate
2602 * a Ring Overrun Event for IN Isoch endpoint or Ring
2603 * Underrun Event for OUT Isoch endpoint.
2605 xhci_dbg(xhci, "underrun event on endpoint\n");
2606 if (!list_empty(&ep_ring->td_list))
2607 xhci_dbg(xhci, "Underrun Event for slot %d ep %d "
2608 "still with TDs queued?\n",
2609 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2612 case COMP_RING_OVERRUN:
2613 xhci_dbg(xhci, "overrun event on endpoint\n");
2614 if (!list_empty(&ep_ring->td_list))
2615 xhci_dbg(xhci, "Overrun Event for slot %d ep %d "
2616 "still with TDs queued?\n",
2617 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2620 case COMP_MISSED_SERVICE_ERROR:
2622 * When encounter missed service error, one or more isoc tds
2623 * may be missed by xHC.
2624 * Set skip flag of the ep_ring; Complete the missed tds as
2625 * short transfer when process the ep_ring next time.
2629 "Miss service interval error for slot %u ep %u, set skip flag\n",
2632 case COMP_NO_PING_RESPONSE_ERROR:
2635 "No Ping response error for slot %u ep %u, Skip one Isoc TD\n",
2639 case COMP_INCOMPATIBLE_DEVICE_ERROR:
2640 /* needs disable slot command to recover */
2642 "WARN: detect an incompatible device for slot %u ep %u",
2647 if (xhci_is_vendor_info_code(xhci, trb_comp_code)) {
2652 "ERROR Unknown event condition %u for slot %u ep %u , HC probably busted\n",
2653 trb_comp_code, slot_id, ep_index);
2658 /* This TRB should be in the TD at the head of this ring's
2661 if (list_empty(&ep_ring->td_list)) {
2663 * Don't print wanings if it's due to a stopped endpoint
2664 * generating an extra completion event if the device
2665 * was suspended. Or, a event for the last TRB of a
2666 * short TD we already got a short event for.
2667 * The short TD is already removed from the TD list.
2670 if (!(trb_comp_code == COMP_STOPPED ||
2671 trb_comp_code == COMP_STOPPED_LENGTH_INVALID ||
2672 ep_ring->last_td_was_short)) {
2673 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d with no TDs queued?\n",
2674 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2679 xhci_dbg(xhci, "td_list is empty while skip flag set. Clear skip flag for slot %u ep %u.\n",
2682 if (trb_comp_code == COMP_STALL_ERROR ||
2683 xhci_requires_manual_halt_cleanup(xhci, ep_ctx,
2685 xhci_handle_halted_endpoint(xhci, ep,
2693 /* We've skipped all the TDs on the ep ring when ep->skip set */
2694 if (ep->skip && td_num == 0) {
2696 xhci_dbg(xhci, "All tds on the ep_ring skipped. Clear skip flag for slot %u ep %u.\n",
2701 td = list_first_entry(&ep_ring->td_list, struct xhci_td,
2706 /* Is this a TRB in the currently executing TD? */
2707 ep_seg = trb_in_td(xhci, ep_ring->deq_seg, ep_ring->dequeue,
2708 td->last_trb, ep_trb_dma, false);
2711 * Skip the Force Stopped Event. The event_trb(event_dma) of FSE
2712 * is not in the current TD pointed by ep_ring->dequeue because
2713 * that the hardware dequeue pointer still at the previous TRB
2714 * of the current TD. The previous TRB maybe a Link TD or the
2715 * last TRB of the previous TD. The command completion handle
2716 * will take care the rest.
2718 if (!ep_seg && (trb_comp_code == COMP_STOPPED ||
2719 trb_comp_code == COMP_STOPPED_LENGTH_INVALID)) {
2725 !usb_endpoint_xfer_isoc(&td->urb->ep->desc)) {
2726 /* Some host controllers give a spurious
2727 * successful event after a short transfer.
2730 if ((xhci->quirks & XHCI_SPURIOUS_SUCCESS) &&
2731 ep_ring->last_td_was_short) {
2732 ep_ring->last_td_was_short = false;
2735 /* HC is busted, give up! */
2737 "ERROR Transfer event TRB DMA ptr not "
2738 "part of current TD ep_index %d "
2739 "comp_code %u\n", ep_index,
2741 trb_in_td(xhci, ep_ring->deq_seg,
2742 ep_ring->dequeue, td->last_trb,
2747 skip_isoc_td(xhci, td, ep, status);
2750 if (trb_comp_code == COMP_SHORT_PACKET)
2751 ep_ring->last_td_was_short = true;
2753 ep_ring->last_td_was_short = false;
2757 "Found td. Clear skip flag for slot %u ep %u.\n",
2762 ep_trb = &ep_seg->trbs[(ep_trb_dma - ep_seg->dma) /
2765 trace_xhci_handle_transfer(ep_ring,
2766 (struct xhci_generic_trb *) ep_trb);
2769 * No-op TRB could trigger interrupts in a case where
2770 * a URB was killed and a STALL_ERROR happens right
2771 * after the endpoint ring stopped. Reset the halted
2772 * endpoint. Otherwise, the endpoint remains stalled
2776 if (trb_is_noop(ep_trb)) {
2777 if (trb_comp_code == COMP_STALL_ERROR ||
2778 xhci_requires_manual_halt_cleanup(xhci, ep_ctx,
2780 xhci_handle_halted_endpoint(xhci, ep,
2786 td->status = status;
2788 /* update the urb's actual_length and give back to the core */
2789 if (usb_endpoint_xfer_control(&td->urb->ep->desc))
2790 process_ctrl_td(xhci, td, ep_trb, event, ep);
2791 else if (usb_endpoint_xfer_isoc(&td->urb->ep->desc))
2792 process_isoc_td(xhci, td, ep_trb, event, ep);
2794 process_bulk_intr_td(xhci, td, ep_trb, event, ep);
2796 handling_skipped_tds = ep->skip &&
2797 trb_comp_code != COMP_MISSED_SERVICE_ERROR &&
2798 trb_comp_code != COMP_NO_PING_RESPONSE_ERROR;
2801 * Do not update event ring dequeue pointer if we're in a loop
2802 * processing missed tds.
2804 if (!handling_skipped_tds)
2805 inc_deq(xhci, xhci->event_ring);
2808 * If ep->skip is set, it means there are missed tds on the
2809 * endpoint ring need to take care of.
2810 * Process them as short transfer until reach the td pointed by
2813 } while (handling_skipped_tds);
2818 xhci_err(xhci, "@%016llx %08x %08x %08x %08x\n",
2819 (unsigned long long) xhci_trb_virt_to_dma(
2820 xhci->event_ring->deq_seg,
2821 xhci->event_ring->dequeue),
2822 lower_32_bits(le64_to_cpu(event->buffer)),
2823 upper_32_bits(le64_to_cpu(event->buffer)),
2824 le32_to_cpu(event->transfer_len),
2825 le32_to_cpu(event->flags));
2830 * This function handles all OS-owned events on the event ring. It may drop
2831 * xhci->lock between event processing (e.g. to pass up port status changes).
2832 * Returns >0 for "possibly more events to process" (caller should call again),
2833 * otherwise 0 if done. In future, <0 returns should indicate error code.
2835 static int xhci_handle_event(struct xhci_hcd *xhci)
2837 union xhci_trb *event;
2838 int update_ptrs = 1;
2842 /* Event ring hasn't been allocated yet. */
2843 if (!xhci->event_ring || !xhci->event_ring->dequeue) {
2844 xhci_err(xhci, "ERROR event ring not ready\n");
2848 event = xhci->event_ring->dequeue;
2849 /* Does the HC or OS own the TRB? */
2850 if ((le32_to_cpu(event->event_cmd.flags) & TRB_CYCLE) !=
2851 xhci->event_ring->cycle_state)
2854 trace_xhci_handle_event(xhci->event_ring, &event->generic);
2857 * Barrier between reading the TRB_CYCLE (valid) flag above and any
2858 * speculative reads of the event's flags/data below.
2861 trb_type = TRB_FIELD_TO_TYPE(le32_to_cpu(event->event_cmd.flags));
2862 /* FIXME: Handle more event types. */
2865 case TRB_COMPLETION:
2866 handle_cmd_completion(xhci, &event->event_cmd);
2868 case TRB_PORT_STATUS:
2869 handle_port_status(xhci, event);
2873 ret = handle_tx_event(xhci, &event->trans_event);
2878 handle_device_notification(xhci, event);
2881 if (trb_type >= TRB_VENDOR_DEFINED_LOW)
2882 handle_vendor_event(xhci, event, trb_type);
2884 xhci_warn(xhci, "ERROR unknown event type %d\n", trb_type);
2886 /* Any of the above functions may drop and re-acquire the lock, so check
2887 * to make sure a watchdog timer didn't mark the host as non-responsive.
2889 if (xhci->xhc_state & XHCI_STATE_DYING) {
2890 xhci_dbg(xhci, "xHCI host dying, returning from "
2891 "event handler.\n");
2896 /* Update SW event ring dequeue pointer */
2897 inc_deq(xhci, xhci->event_ring);
2899 /* Are there more items on the event ring? Caller will call us again to
2906 * Update Event Ring Dequeue Pointer:
2907 * - When all events have finished
2908 * - To avoid "Event Ring Full Error" condition
2910 static void xhci_update_erst_dequeue(struct xhci_hcd *xhci,
2911 union xhci_trb *event_ring_deq)
2916 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
2917 /* If necessary, update the HW's version of the event ring deq ptr. */
2918 if (event_ring_deq != xhci->event_ring->dequeue) {
2919 deq = xhci_trb_virt_to_dma(xhci->event_ring->deq_seg,
2920 xhci->event_ring->dequeue);
2922 xhci_warn(xhci, "WARN something wrong with SW event ring dequeue ptr\n");
2924 * Per 4.9.4, Software writes to the ERDP register shall
2925 * always advance the Event Ring Dequeue Pointer value.
2927 if ((temp_64 & (u64) ~ERST_PTR_MASK) ==
2928 ((u64) deq & (u64) ~ERST_PTR_MASK))
2931 /* Update HC event ring dequeue pointer */
2932 temp_64 &= ERST_PTR_MASK;
2933 temp_64 |= ((u64) deq & (u64) ~ERST_PTR_MASK);
2936 /* Clear the event handler busy flag (RW1C) */
2937 temp_64 |= ERST_EHB;
2938 xhci_write_64(xhci, temp_64, &xhci->ir_set->erst_dequeue);
2942 * xHCI spec says we can get an interrupt, and if the HC has an error condition,
2943 * we might get bad data out of the event ring. Section 4.10.2.7 has a list of
2944 * indicators of an event TRB error, but we check the status *first* to be safe.
2946 irqreturn_t xhci_irq(struct usb_hcd *hcd)
2948 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
2949 union xhci_trb *event_ring_deq;
2950 irqreturn_t ret = IRQ_NONE;
2951 unsigned long flags;
2956 spin_lock_irqsave(&xhci->lock, flags);
2957 /* Check if the xHC generated the interrupt, or the irq is shared */
2958 status = readl(&xhci->op_regs->status);
2959 if (status == ~(u32)0) {
2965 if (!(status & STS_EINT))
2968 if (status & STS_FATAL) {
2969 xhci_warn(xhci, "WARNING: Host System Error\n");
2976 * Clear the op reg interrupt status first,
2977 * so we can receive interrupts from other MSI-X interrupters.
2978 * Write 1 to clear the interrupt status.
2981 writel(status, &xhci->op_regs->status);
2983 if (!hcd->msi_enabled) {
2985 irq_pending = readl(&xhci->ir_set->irq_pending);
2986 irq_pending |= IMAN_IP;
2987 writel(irq_pending, &xhci->ir_set->irq_pending);
2990 if (xhci->xhc_state & XHCI_STATE_DYING ||
2991 xhci->xhc_state & XHCI_STATE_HALTED) {
2992 xhci_dbg(xhci, "xHCI dying, ignoring interrupt. "
2993 "Shouldn't IRQs be disabled?\n");
2994 /* Clear the event handler busy flag (RW1C);
2995 * the event ring should be empty.
2997 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
2998 xhci_write_64(xhci, temp_64 | ERST_EHB,
2999 &xhci->ir_set->erst_dequeue);
3004 event_ring_deq = xhci->event_ring->dequeue;
3005 /* FIXME this should be a delayed service routine
3006 * that clears the EHB.
3008 while (xhci_handle_event(xhci) > 0) {
3009 if (event_loop++ < TRBS_PER_SEGMENT / 2)
3011 xhci_update_erst_dequeue(xhci, event_ring_deq);
3015 xhci_update_erst_dequeue(xhci, event_ring_deq);
3019 spin_unlock_irqrestore(&xhci->lock, flags);
3024 irqreturn_t xhci_msi_irq(int irq, void *hcd)
3026 return xhci_irq(hcd);
3029 /**** Endpoint Ring Operations ****/
3032 * Generic function for queueing a TRB on a ring.
3033 * The caller must have checked to make sure there's room on the ring.
3035 * @more_trbs_coming: Will you enqueue more TRBs before calling
3036 * prepare_transfer()?
3038 static void queue_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
3039 bool more_trbs_coming,
3040 u32 field1, u32 field2, u32 field3, u32 field4)
3042 struct xhci_generic_trb *trb;
3044 trb = &ring->enqueue->generic;
3045 trb->field[0] = cpu_to_le32(field1);
3046 trb->field[1] = cpu_to_le32(field2);
3047 trb->field[2] = cpu_to_le32(field3);
3048 /* make sure TRB is fully written before giving it to the controller */
3050 trb->field[3] = cpu_to_le32(field4);
3052 trace_xhci_queue_trb(ring, trb);
3054 inc_enq(xhci, ring, more_trbs_coming);
3058 * Does various checks on the endpoint ring, and makes it ready to queue num_trbs.
3059 * FIXME allocate segments if the ring is full.
3061 static int prepare_ring(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
3062 u32 ep_state, unsigned int num_trbs, gfp_t mem_flags)
3064 unsigned int num_trbs_needed;
3065 unsigned int link_trb_count = 0;
3067 /* Make sure the endpoint has been added to xHC schedule */
3069 case EP_STATE_DISABLED:
3071 * USB core changed config/interfaces without notifying us,
3072 * or hardware is reporting the wrong state.
3074 xhci_warn(xhci, "WARN urb submitted to disabled ep\n");
3076 case EP_STATE_ERROR:
3077 xhci_warn(xhci, "WARN waiting for error on ep to be cleared\n");
3078 /* FIXME event handling code for error needs to clear it */
3079 /* XXX not sure if this should be -ENOENT or not */
3081 case EP_STATE_HALTED:
3082 xhci_dbg(xhci, "WARN halted endpoint, queueing URB anyway.\n");
3084 case EP_STATE_STOPPED:
3085 case EP_STATE_RUNNING:
3088 xhci_err(xhci, "ERROR unknown endpoint state for ep\n");
3090 * FIXME issue Configure Endpoint command to try to get the HC
3091 * back into a known state.
3097 if (room_on_ring(xhci, ep_ring, num_trbs))
3100 if (ep_ring == xhci->cmd_ring) {
3101 xhci_err(xhci, "Do not support expand command ring\n");
3105 xhci_dbg_trace(xhci, trace_xhci_dbg_ring_expansion,
3106 "ERROR no room on ep ring, try ring expansion");
3107 num_trbs_needed = num_trbs - ep_ring->num_trbs_free;
3108 if (xhci_ring_expansion(xhci, ep_ring, num_trbs_needed,
3110 xhci_err(xhci, "Ring expansion failed\n");
3115 while (trb_is_link(ep_ring->enqueue)) {
3116 /* If we're not dealing with 0.95 hardware or isoc rings
3117 * on AMD 0.96 host, clear the chain bit.
3119 if (!xhci_link_trb_quirk(xhci) &&
3120 !(ep_ring->type == TYPE_ISOC &&
3121 (xhci->quirks & XHCI_AMD_0x96_HOST)))
3122 ep_ring->enqueue->link.control &=
3123 cpu_to_le32(~TRB_CHAIN);
3125 ep_ring->enqueue->link.control |=
3126 cpu_to_le32(TRB_CHAIN);
3129 ep_ring->enqueue->link.control ^= cpu_to_le32(TRB_CYCLE);
3131 /* Toggle the cycle bit after the last ring segment. */
3132 if (link_trb_toggles_cycle(ep_ring->enqueue))
3133 ep_ring->cycle_state ^= 1;
3135 ep_ring->enq_seg = ep_ring->enq_seg->next;
3136 ep_ring->enqueue = ep_ring->enq_seg->trbs;
3138 /* prevent infinite loop if all first trbs are link trbs */
3139 if (link_trb_count++ > ep_ring->num_segs) {
3140 xhci_warn(xhci, "Ring is an endless link TRB loop\n");
3145 if (last_trb_on_seg(ep_ring->enq_seg, ep_ring->enqueue)) {
3146 xhci_warn(xhci, "Missing link TRB at end of ring segment\n");
3153 static int prepare_transfer(struct xhci_hcd *xhci,
3154 struct xhci_virt_device *xdev,
3155 unsigned int ep_index,
3156 unsigned int stream_id,
3157 unsigned int num_trbs,
3159 unsigned int td_index,
3163 struct urb_priv *urb_priv;
3165 struct xhci_ring *ep_ring;
3166 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
3168 ep_ring = xhci_triad_to_transfer_ring(xhci, xdev->slot_id, ep_index,
3171 xhci_dbg(xhci, "Can't prepare ring for bad stream ID %u\n",
3176 ret = prepare_ring(xhci, ep_ring, GET_EP_CTX_STATE(ep_ctx),
3177 num_trbs, mem_flags);
3181 urb_priv = urb->hcpriv;
3182 td = &urb_priv->td[td_index];
3184 INIT_LIST_HEAD(&td->td_list);
3185 INIT_LIST_HEAD(&td->cancelled_td_list);
3187 if (td_index == 0) {
3188 ret = usb_hcd_link_urb_to_ep(bus_to_hcd(urb->dev->bus), urb);
3194 /* Add this TD to the tail of the endpoint ring's TD list */
3195 list_add_tail(&td->td_list, &ep_ring->td_list);
3196 td->start_seg = ep_ring->enq_seg;
3197 td->first_trb = ep_ring->enqueue;
3202 unsigned int count_trbs(u64 addr, u64 len)
3204 unsigned int num_trbs;
3206 num_trbs = DIV_ROUND_UP(len + (addr & (TRB_MAX_BUFF_SIZE - 1)),
3214 static inline unsigned int count_trbs_needed(struct urb *urb)
3216 return count_trbs(urb->transfer_dma, urb->transfer_buffer_length);
3219 static unsigned int count_sg_trbs_needed(struct urb *urb)
3221 struct scatterlist *sg;
3222 unsigned int i, len, full_len, num_trbs = 0;
3224 full_len = urb->transfer_buffer_length;
3226 for_each_sg(urb->sg, sg, urb->num_mapped_sgs, i) {
3227 len = sg_dma_len(sg);
3228 num_trbs += count_trbs(sg_dma_address(sg), len);
3229 len = min_t(unsigned int, len, full_len);
3238 static unsigned int count_isoc_trbs_needed(struct urb *urb, int i)
3242 addr = (u64) (urb->transfer_dma + urb->iso_frame_desc[i].offset);
3243 len = urb->iso_frame_desc[i].length;
3245 return count_trbs(addr, len);
3248 static void check_trb_math(struct urb *urb, int running_total)
3250 if (unlikely(running_total != urb->transfer_buffer_length))
3251 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated tx length, "
3252 "queued %#x (%d), asked for %#x (%d)\n",
3254 urb->ep->desc.bEndpointAddress,
3255 running_total, running_total,
3256 urb->transfer_buffer_length,
3257 urb->transfer_buffer_length);
3260 static void giveback_first_trb(struct xhci_hcd *xhci, int slot_id,
3261 unsigned int ep_index, unsigned int stream_id, int start_cycle,
3262 struct xhci_generic_trb *start_trb)
3265 * Pass all the TRBs to the hardware at once and make sure this write
3270 start_trb->field[3] |= cpu_to_le32(start_cycle);
3272 start_trb->field[3] &= cpu_to_le32(~TRB_CYCLE);
3273 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, stream_id);
3276 static void check_interval(struct xhci_hcd *xhci, struct urb *urb,
3277 struct xhci_ep_ctx *ep_ctx)
3282 xhci_interval = EP_INTERVAL_TO_UFRAMES(le32_to_cpu(ep_ctx->ep_info));
3283 ep_interval = urb->interval;
3285 /* Convert to microframes */
3286 if (urb->dev->speed == USB_SPEED_LOW ||
3287 urb->dev->speed == USB_SPEED_FULL)
3290 /* FIXME change this to a warning and a suggestion to use the new API
3291 * to set the polling interval (once the API is added).
3293 if (xhci_interval != ep_interval) {
3294 dev_dbg_ratelimited(&urb->dev->dev,
3295 "Driver uses different interval (%d microframe%s) than xHCI (%d microframe%s)\n",
3296 ep_interval, ep_interval == 1 ? "" : "s",
3297 xhci_interval, xhci_interval == 1 ? "" : "s");
3298 urb->interval = xhci_interval;
3299 /* Convert back to frames for LS/FS devices */
3300 if (urb->dev->speed == USB_SPEED_LOW ||
3301 urb->dev->speed == USB_SPEED_FULL)
3307 * xHCI uses normal TRBs for both bulk and interrupt. When the interrupt
3308 * endpoint is to be serviced, the xHC will consume (at most) one TD. A TD
3309 * (comprised of sg list entries) can take several service intervals to
3312 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3313 struct urb *urb, int slot_id, unsigned int ep_index)
3315 struct xhci_ep_ctx *ep_ctx;
3317 ep_ctx = xhci_get_ep_ctx(xhci, xhci->devs[slot_id]->out_ctx, ep_index);
3318 check_interval(xhci, urb, ep_ctx);
3320 return xhci_queue_bulk_tx(xhci, mem_flags, urb, slot_id, ep_index);
3324 * For xHCI 1.0 host controllers, TD size is the number of max packet sized
3325 * packets remaining in the TD (*not* including this TRB).
3327 * Total TD packet count = total_packet_count =
3328 * DIV_ROUND_UP(TD size in bytes / wMaxPacketSize)
3330 * Packets transferred up to and including this TRB = packets_transferred =
3331 * rounddown(total bytes transferred including this TRB / wMaxPacketSize)
3333 * TD size = total_packet_count - packets_transferred
3335 * For xHCI 0.96 and older, TD size field should be the remaining bytes
3336 * including this TRB, right shifted by 10
3338 * For all hosts it must fit in bits 21:17, so it can't be bigger than 31.
3339 * This is taken care of in the TRB_TD_SIZE() macro
3341 * The last TRB in a TD must have the TD size set to zero.
3343 static u32 xhci_td_remainder(struct xhci_hcd *xhci, int transferred,
3344 int trb_buff_len, unsigned int td_total_len,
3345 struct urb *urb, bool more_trbs_coming)
3347 u32 maxp, total_packet_count;
3349 /* MTK xHCI 0.96 contains some features from 1.0 */
3350 if (xhci->hci_version < 0x100 && !(xhci->quirks & XHCI_MTK_HOST))
3351 return ((td_total_len - transferred) >> 10);
3353 /* One TRB with a zero-length data packet. */
3354 if (!more_trbs_coming || (transferred == 0 && trb_buff_len == 0) ||
3355 trb_buff_len == td_total_len)
3358 /* for MTK xHCI 0.96, TD size include this TRB, but not in 1.x */
3359 if ((xhci->quirks & XHCI_MTK_HOST) && (xhci->hci_version < 0x100))
3362 maxp = usb_endpoint_maxp(&urb->ep->desc);
3363 total_packet_count = DIV_ROUND_UP(td_total_len, maxp);
3365 /* Queueing functions don't count the current TRB into transferred */
3366 return (total_packet_count - ((transferred + trb_buff_len) / maxp));
3370 static int xhci_align_td(struct xhci_hcd *xhci, struct urb *urb, u32 enqd_len,
3371 u32 *trb_buff_len, struct xhci_segment *seg)
3373 struct device *dev = xhci_to_hcd(xhci)->self.controller;
3374 unsigned int unalign;
3375 unsigned int max_pkt;
3379 max_pkt = usb_endpoint_maxp(&urb->ep->desc);
3380 unalign = (enqd_len + *trb_buff_len) % max_pkt;
3382 /* we got lucky, last normal TRB data on segment is packet aligned */
3386 xhci_dbg(xhci, "Unaligned %d bytes, buff len %d\n",
3387 unalign, *trb_buff_len);
3389 /* is the last nornal TRB alignable by splitting it */
3390 if (*trb_buff_len > unalign) {
3391 *trb_buff_len -= unalign;
3392 xhci_dbg(xhci, "split align, new buff len %d\n", *trb_buff_len);
3397 * We want enqd_len + trb_buff_len to sum up to a number aligned to
3398 * number which is divisible by the endpoint's wMaxPacketSize. IOW:
3399 * (size of currently enqueued TRBs + remainder) % wMaxPacketSize == 0.
3401 new_buff_len = max_pkt - (enqd_len % max_pkt);
3403 if (new_buff_len > (urb->transfer_buffer_length - enqd_len))
3404 new_buff_len = (urb->transfer_buffer_length - enqd_len);
3406 /* create a max max_pkt sized bounce buffer pointed to by last trb */
3407 if (usb_urb_dir_out(urb)) {
3408 len = sg_pcopy_to_buffer(urb->sg, urb->num_sgs,
3409 seg->bounce_buf, new_buff_len, enqd_len);
3410 if (len != new_buff_len)
3412 "WARN Wrong bounce buffer write length: %zu != %d\n",
3414 seg->bounce_dma = dma_map_single(dev, seg->bounce_buf,
3415 max_pkt, DMA_TO_DEVICE);
3417 seg->bounce_dma = dma_map_single(dev, seg->bounce_buf,
3418 max_pkt, DMA_FROM_DEVICE);
3421 if (dma_mapping_error(dev, seg->bounce_dma)) {
3422 /* try without aligning. Some host controllers survive */
3423 xhci_warn(xhci, "Failed mapping bounce buffer, not aligning\n");
3426 *trb_buff_len = new_buff_len;
3427 seg->bounce_len = new_buff_len;
3428 seg->bounce_offs = enqd_len;
3430 xhci_dbg(xhci, "Bounce align, new buff len %d\n", *trb_buff_len);
3435 /* This is very similar to what ehci-q.c qtd_fill() does */
3436 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3437 struct urb *urb, int slot_id, unsigned int ep_index)
3439 struct xhci_ring *ring;
3440 struct urb_priv *urb_priv;
3442 struct xhci_generic_trb *start_trb;
3443 struct scatterlist *sg = NULL;
3444 bool more_trbs_coming = true;
3445 bool need_zero_pkt = false;
3446 bool first_trb = true;
3447 unsigned int num_trbs;
3448 unsigned int start_cycle, num_sgs = 0;
3449 unsigned int enqd_len, block_len, trb_buff_len, full_len;
3451 u32 field, length_field, remainder;
3452 u64 addr, send_addr;
3454 ring = xhci_urb_to_transfer_ring(xhci, urb);
3458 full_len = urb->transfer_buffer_length;
3459 /* If we have scatter/gather list, we use it. */
3460 if (urb->num_sgs && !(urb->transfer_flags & URB_DMA_MAP_SINGLE)) {
3461 num_sgs = urb->num_mapped_sgs;
3463 addr = (u64) sg_dma_address(sg);
3464 block_len = sg_dma_len(sg);
3465 num_trbs = count_sg_trbs_needed(urb);
3467 num_trbs = count_trbs_needed(urb);
3468 addr = (u64) urb->transfer_dma;
3469 block_len = full_len;
3471 ret = prepare_transfer(xhci, xhci->devs[slot_id],
3472 ep_index, urb->stream_id,
3473 num_trbs, urb, 0, mem_flags);
3474 if (unlikely(ret < 0))
3477 urb_priv = urb->hcpriv;
3479 /* Deal with URB_ZERO_PACKET - need one more td/trb */
3480 if (urb->transfer_flags & URB_ZERO_PACKET && urb_priv->num_tds > 1)
3481 need_zero_pkt = true;
3483 td = &urb_priv->td[0];
3486 * Don't give the first TRB to the hardware (by toggling the cycle bit)
3487 * until we've finished creating all the other TRBs. The ring's cycle
3488 * state may change as we enqueue the other TRBs, so save it too.
3490 start_trb = &ring->enqueue->generic;
3491 start_cycle = ring->cycle_state;
3494 /* Queue the TRBs, even if they are zero-length */
3495 for (enqd_len = 0; first_trb || enqd_len < full_len;
3496 enqd_len += trb_buff_len) {
3497 field = TRB_TYPE(TRB_NORMAL);
3499 /* TRB buffer should not cross 64KB boundaries */
3500 trb_buff_len = TRB_BUFF_LEN_UP_TO_BOUNDARY(addr);
3501 trb_buff_len = min_t(unsigned int, trb_buff_len, block_len);
3503 if (enqd_len + trb_buff_len > full_len)
3504 trb_buff_len = full_len - enqd_len;
3506 /* Don't change the cycle bit of the first TRB until later */
3509 if (start_cycle == 0)
3512 field |= ring->cycle_state;
3514 /* Chain all the TRBs together; clear the chain bit in the last
3515 * TRB to indicate it's the last TRB in the chain.
3517 if (enqd_len + trb_buff_len < full_len) {
3519 if (trb_is_link(ring->enqueue + 1)) {
3520 if (xhci_align_td(xhci, urb, enqd_len,
3523 send_addr = ring->enq_seg->bounce_dma;
3524 /* assuming TD won't span 2 segs */
3525 td->bounce_seg = ring->enq_seg;
3529 if (enqd_len + trb_buff_len >= full_len) {
3530 field &= ~TRB_CHAIN;
3532 more_trbs_coming = false;
3533 td->last_trb = ring->enqueue;
3534 td->last_trb_seg = ring->enq_seg;
3535 if (xhci_urb_suitable_for_idt(urb)) {
3536 memcpy(&send_addr, urb->transfer_buffer,
3538 le64_to_cpus(&send_addr);
3543 /* Only set interrupt on short packet for IN endpoints */
3544 if (usb_urb_dir_in(urb))
3547 /* Set the TRB length, TD size, and interrupter fields. */
3548 remainder = xhci_td_remainder(xhci, enqd_len, trb_buff_len,
3549 full_len, urb, more_trbs_coming);
3551 length_field = TRB_LEN(trb_buff_len) |
3552 TRB_TD_SIZE(remainder) |
3555 queue_trb(xhci, ring, more_trbs_coming | need_zero_pkt,
3556 lower_32_bits(send_addr),
3557 upper_32_bits(send_addr),
3561 addr += trb_buff_len;
3562 sent_len = trb_buff_len;
3564 while (sg && sent_len >= block_len) {
3567 sent_len -= block_len;
3569 if (num_sgs != 0 && sg) {
3570 block_len = sg_dma_len(sg);
3571 addr = (u64) sg_dma_address(sg);
3575 block_len -= sent_len;
3579 if (need_zero_pkt) {
3580 ret = prepare_transfer(xhci, xhci->devs[slot_id],
3581 ep_index, urb->stream_id,
3582 1, urb, 1, mem_flags);
3583 urb_priv->td[1].last_trb = ring->enqueue;
3584 urb_priv->td[1].last_trb_seg = ring->enq_seg;
3585 field = TRB_TYPE(TRB_NORMAL) | ring->cycle_state | TRB_IOC;
3586 queue_trb(xhci, ring, 0, 0, 0, TRB_INTR_TARGET(0), field);
3587 urb_priv->td[1].num_trbs++;
3590 check_trb_math(urb, enqd_len);
3591 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3592 start_cycle, start_trb);
3596 /* Caller must have locked xhci->lock */
3597 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3598 struct urb *urb, int slot_id, unsigned int ep_index)
3600 struct xhci_ring *ep_ring;
3603 struct usb_ctrlrequest *setup;
3604 struct xhci_generic_trb *start_trb;
3607 struct urb_priv *urb_priv;
3610 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3615 * Need to copy setup packet into setup TRB, so we can't use the setup
3618 if (!urb->setup_packet)
3621 /* 1 TRB for setup, 1 for status */
3624 * Don't need to check if we need additional event data and normal TRBs,
3625 * since data in control transfers will never get bigger than 16MB
3626 * XXX: can we get a buffer that crosses 64KB boundaries?
3628 if (urb->transfer_buffer_length > 0)
3630 ret = prepare_transfer(xhci, xhci->devs[slot_id],
3631 ep_index, urb->stream_id,
3632 num_trbs, urb, 0, mem_flags);
3636 urb_priv = urb->hcpriv;
3637 td = &urb_priv->td[0];
3638 td->num_trbs = num_trbs;
3641 * Don't give the first TRB to the hardware (by toggling the cycle bit)
3642 * until we've finished creating all the other TRBs. The ring's cycle
3643 * state may change as we enqueue the other TRBs, so save it too.
3645 start_trb = &ep_ring->enqueue->generic;
3646 start_cycle = ep_ring->cycle_state;
3648 /* Queue setup TRB - see section 6.4.1.2.1 */
3649 /* FIXME better way to translate setup_packet into two u32 fields? */
3650 setup = (struct usb_ctrlrequest *) urb->setup_packet;
3652 field |= TRB_IDT | TRB_TYPE(TRB_SETUP);
3653 if (start_cycle == 0)
3656 /* xHCI 1.0/1.1 6.4.1.2.1: Transfer Type field */
3657 if ((xhci->hci_version >= 0x100) || (xhci->quirks & XHCI_MTK_HOST)) {
3658 if (urb->transfer_buffer_length > 0) {
3659 if (setup->bRequestType & USB_DIR_IN)
3660 field |= TRB_TX_TYPE(TRB_DATA_IN);
3662 field |= TRB_TX_TYPE(TRB_DATA_OUT);
3666 queue_trb(xhci, ep_ring, true,
3667 setup->bRequestType | setup->bRequest << 8 | le16_to_cpu(setup->wValue) << 16,
3668 le16_to_cpu(setup->wIndex) | le16_to_cpu(setup->wLength) << 16,
3669 TRB_LEN(8) | TRB_INTR_TARGET(0),
3670 /* Immediate data in pointer */
3673 /* If there's data, queue data TRBs */
3674 /* Only set interrupt on short packet for IN endpoints */
3675 if (usb_urb_dir_in(urb))
3676 field = TRB_ISP | TRB_TYPE(TRB_DATA);
3678 field = TRB_TYPE(TRB_DATA);
3680 if (urb->transfer_buffer_length > 0) {
3681 u32 length_field, remainder;
3684 if (xhci_urb_suitable_for_idt(urb)) {
3685 memcpy(&addr, urb->transfer_buffer,
3686 urb->transfer_buffer_length);
3687 le64_to_cpus(&addr);
3690 addr = (u64) urb->transfer_dma;
3693 remainder = xhci_td_remainder(xhci, 0,
3694 urb->transfer_buffer_length,
3695 urb->transfer_buffer_length,
3697 length_field = TRB_LEN(urb->transfer_buffer_length) |
3698 TRB_TD_SIZE(remainder) |
3700 if (setup->bRequestType & USB_DIR_IN)
3701 field |= TRB_DIR_IN;
3702 queue_trb(xhci, ep_ring, true,
3703 lower_32_bits(addr),
3704 upper_32_bits(addr),
3706 field | ep_ring->cycle_state);
3709 /* Save the DMA address of the last TRB in the TD */
3710 td->last_trb = ep_ring->enqueue;
3711 td->last_trb_seg = ep_ring->enq_seg;
3713 /* Queue status TRB - see Table 7 and sections 4.11.2.2 and 6.4.1.2.3 */
3714 /* If the device sent data, the status stage is an OUT transfer */
3715 if (urb->transfer_buffer_length > 0 && setup->bRequestType & USB_DIR_IN)
3719 queue_trb(xhci, ep_ring, false,
3723 /* Event on completion */
3724 field | TRB_IOC | TRB_TYPE(TRB_STATUS) | ep_ring->cycle_state);
3726 giveback_first_trb(xhci, slot_id, ep_index, 0,
3727 start_cycle, start_trb);
3732 * The transfer burst count field of the isochronous TRB defines the number of
3733 * bursts that are required to move all packets in this TD. Only SuperSpeed
3734 * devices can burst up to bMaxBurst number of packets per service interval.
3735 * This field is zero based, meaning a value of zero in the field means one
3736 * burst. Basically, for everything but SuperSpeed devices, this field will be
3737 * zero. Only xHCI 1.0 host controllers support this field.
3739 static unsigned int xhci_get_burst_count(struct xhci_hcd *xhci,
3740 struct urb *urb, unsigned int total_packet_count)
3742 unsigned int max_burst;
3744 if (xhci->hci_version < 0x100 || urb->dev->speed < USB_SPEED_SUPER)
3747 max_burst = urb->ep->ss_ep_comp.bMaxBurst;
3748 return DIV_ROUND_UP(total_packet_count, max_burst + 1) - 1;
3752 * Returns the number of packets in the last "burst" of packets. This field is
3753 * valid for all speeds of devices. USB 2.0 devices can only do one "burst", so
3754 * the last burst packet count is equal to the total number of packets in the
3755 * TD. SuperSpeed endpoints can have up to 3 bursts. All but the last burst
3756 * must contain (bMaxBurst + 1) number of packets, but the last burst can
3757 * contain 1 to (bMaxBurst + 1) packets.
3759 static unsigned int xhci_get_last_burst_packet_count(struct xhci_hcd *xhci,
3760 struct urb *urb, unsigned int total_packet_count)
3762 unsigned int max_burst;
3763 unsigned int residue;
3765 if (xhci->hci_version < 0x100)
3768 if (urb->dev->speed >= USB_SPEED_SUPER) {
3769 /* bMaxBurst is zero based: 0 means 1 packet per burst */
3770 max_burst = urb->ep->ss_ep_comp.bMaxBurst;
3771 residue = total_packet_count % (max_burst + 1);
3772 /* If residue is zero, the last burst contains (max_burst + 1)
3773 * number of packets, but the TLBPC field is zero-based.
3779 if (total_packet_count == 0)
3781 return total_packet_count - 1;
3785 * Calculates Frame ID field of the isochronous TRB identifies the
3786 * target frame that the Interval associated with this Isochronous
3787 * Transfer Descriptor will start on. Refer to 4.11.2.5 in 1.1 spec.
3789 * Returns actual frame id on success, negative value on error.
3791 static int xhci_get_isoc_frame_id(struct xhci_hcd *xhci,
3792 struct urb *urb, int index)
3794 int start_frame, ist, ret = 0;
3795 int start_frame_id, end_frame_id, current_frame_id;
3797 if (urb->dev->speed == USB_SPEED_LOW ||
3798 urb->dev->speed == USB_SPEED_FULL)
3799 start_frame = urb->start_frame + index * urb->interval;
3801 start_frame = (urb->start_frame + index * urb->interval) >> 3;
3803 /* Isochronous Scheduling Threshold (IST, bits 0~3 in HCSPARAMS2):
3805 * If bit [3] of IST is cleared to '0', software can add a TRB no
3806 * later than IST[2:0] Microframes before that TRB is scheduled to
3808 * If bit [3] of IST is set to '1', software can add a TRB no later
3809 * than IST[2:0] Frames before that TRB is scheduled to be executed.
3811 ist = HCS_IST(xhci->hcs_params2) & 0x7;
3812 if (HCS_IST(xhci->hcs_params2) & (1 << 3))
3815 /* Software shall not schedule an Isoch TD with a Frame ID value that
3816 * is less than the Start Frame ID or greater than the End Frame ID,
3819 * End Frame ID = (Current MFINDEX register value + 895 ms.) MOD 2048
3820 * Start Frame ID = (Current MFINDEX register value + IST + 1) MOD 2048
3822 * Both the End Frame ID and Start Frame ID values are calculated
3823 * in microframes. When software determines the valid Frame ID value;
3824 * The End Frame ID value should be rounded down to the nearest Frame
3825 * boundary, and the Start Frame ID value should be rounded up to the
3826 * nearest Frame boundary.
3828 current_frame_id = readl(&xhci->run_regs->microframe_index);
3829 start_frame_id = roundup(current_frame_id + ist + 1, 8);
3830 end_frame_id = rounddown(current_frame_id + 895 * 8, 8);
3832 start_frame &= 0x7ff;
3833 start_frame_id = (start_frame_id >> 3) & 0x7ff;
3834 end_frame_id = (end_frame_id >> 3) & 0x7ff;
3836 xhci_dbg(xhci, "%s: index %d, reg 0x%x start_frame_id 0x%x, end_frame_id 0x%x, start_frame 0x%x\n",
3837 __func__, index, readl(&xhci->run_regs->microframe_index),
3838 start_frame_id, end_frame_id, start_frame);
3840 if (start_frame_id < end_frame_id) {
3841 if (start_frame > end_frame_id ||
3842 start_frame < start_frame_id)
3844 } else if (start_frame_id > end_frame_id) {
3845 if ((start_frame > end_frame_id &&
3846 start_frame < start_frame_id))
3853 if (ret == -EINVAL || start_frame == start_frame_id) {
3854 start_frame = start_frame_id + 1;
3855 if (urb->dev->speed == USB_SPEED_LOW ||
3856 urb->dev->speed == USB_SPEED_FULL)
3857 urb->start_frame = start_frame;
3859 urb->start_frame = start_frame << 3;
3865 xhci_warn(xhci, "Frame ID %d (reg %d, index %d) beyond range (%d, %d)\n",
3866 start_frame, current_frame_id, index,
3867 start_frame_id, end_frame_id);
3868 xhci_warn(xhci, "Ignore frame ID field, use SIA bit instead\n");
3875 /* Check if we should generate event interrupt for a TD in an isoc URB */
3876 static bool trb_block_event_intr(struct xhci_hcd *xhci, int num_tds, int i)
3878 if (xhci->hci_version < 0x100)
3880 /* always generate an event interrupt for the last TD */
3881 if (i == num_tds - 1)
3884 * If AVOID_BEI is set the host handles full event rings poorly,
3885 * generate an event at least every 8th TD to clear the event ring
3887 if (i && xhci->quirks & XHCI_AVOID_BEI)
3893 /* This is for isoc transfer */
3894 static int xhci_queue_isoc_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3895 struct urb *urb, int slot_id, unsigned int ep_index)
3897 struct xhci_ring *ep_ring;
3898 struct urb_priv *urb_priv;
3900 int num_tds, trbs_per_td;
3901 struct xhci_generic_trb *start_trb;
3904 u32 field, length_field;
3905 int running_total, trb_buff_len, td_len, td_remain_len, ret;
3906 u64 start_addr, addr;
3908 bool more_trbs_coming;
3909 struct xhci_virt_ep *xep;
3912 xep = &xhci->devs[slot_id]->eps[ep_index];
3913 ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
3915 num_tds = urb->number_of_packets;
3917 xhci_dbg(xhci, "Isoc URB with zero packets?\n");
3920 start_addr = (u64) urb->transfer_dma;
3921 start_trb = &ep_ring->enqueue->generic;
3922 start_cycle = ep_ring->cycle_state;
3924 urb_priv = urb->hcpriv;
3925 /* Queue the TRBs for each TD, even if they are zero-length */
3926 for (i = 0; i < num_tds; i++) {
3927 unsigned int total_pkt_count, max_pkt;
3928 unsigned int burst_count, last_burst_pkt_count;
3933 addr = start_addr + urb->iso_frame_desc[i].offset;
3934 td_len = urb->iso_frame_desc[i].length;
3935 td_remain_len = td_len;
3936 max_pkt = usb_endpoint_maxp(&urb->ep->desc);
3937 total_pkt_count = DIV_ROUND_UP(td_len, max_pkt);
3939 /* A zero-length transfer still involves at least one packet. */
3940 if (total_pkt_count == 0)
3942 burst_count = xhci_get_burst_count(xhci, urb, total_pkt_count);
3943 last_burst_pkt_count = xhci_get_last_burst_packet_count(xhci,
3944 urb, total_pkt_count);
3946 trbs_per_td = count_isoc_trbs_needed(urb, i);
3948 ret = prepare_transfer(xhci, xhci->devs[slot_id], ep_index,
3949 urb->stream_id, trbs_per_td, urb, i, mem_flags);
3955 td = &urb_priv->td[i];
3956 td->num_trbs = trbs_per_td;
3957 /* use SIA as default, if frame id is used overwrite it */
3958 sia_frame_id = TRB_SIA;
3959 if (!(urb->transfer_flags & URB_ISO_ASAP) &&
3960 HCC_CFC(xhci->hcc_params)) {
3961 frame_id = xhci_get_isoc_frame_id(xhci, urb, i);
3963 sia_frame_id = TRB_FRAME_ID(frame_id);
3966 * Set isoc specific data for the first TRB in a TD.
3967 * Prevent HW from getting the TRBs by keeping the cycle state
3968 * inverted in the first TDs isoc TRB.
3970 field = TRB_TYPE(TRB_ISOC) |
3971 TRB_TLBPC(last_burst_pkt_count) |
3973 (i ? ep_ring->cycle_state : !start_cycle);
3975 /* xhci 1.1 with ETE uses TD_Size field for TBC, old is Rsvdz */
3976 if (!xep->use_extended_tbc)
3977 field |= TRB_TBC(burst_count);
3979 /* fill the rest of the TRB fields, and remaining normal TRBs */
3980 for (j = 0; j < trbs_per_td; j++) {
3983 /* only first TRB is isoc, overwrite otherwise */
3985 field = TRB_TYPE(TRB_NORMAL) |
3986 ep_ring->cycle_state;
3988 /* Only set interrupt on short packet for IN EPs */
3989 if (usb_urb_dir_in(urb))
3992 /* Set the chain bit for all except the last TRB */
3993 if (j < trbs_per_td - 1) {
3994 more_trbs_coming = true;
3997 more_trbs_coming = false;
3998 td->last_trb = ep_ring->enqueue;
3999 td->last_trb_seg = ep_ring->enq_seg;
4001 if (trb_block_event_intr(xhci, num_tds, i))
4004 /* Calculate TRB length */
4005 trb_buff_len = TRB_BUFF_LEN_UP_TO_BOUNDARY(addr);
4006 if (trb_buff_len > td_remain_len)
4007 trb_buff_len = td_remain_len;
4009 /* Set the TRB length, TD size, & interrupter fields. */
4010 remainder = xhci_td_remainder(xhci, running_total,
4011 trb_buff_len, td_len,
4012 urb, more_trbs_coming);
4014 length_field = TRB_LEN(trb_buff_len) |
4017 /* xhci 1.1 with ETE uses TD Size field for TBC */
4018 if (first_trb && xep->use_extended_tbc)
4019 length_field |= TRB_TD_SIZE_TBC(burst_count);
4021 length_field |= TRB_TD_SIZE(remainder);
4024 queue_trb(xhci, ep_ring, more_trbs_coming,
4025 lower_32_bits(addr),
4026 upper_32_bits(addr),
4029 running_total += trb_buff_len;
4031 addr += trb_buff_len;
4032 td_remain_len -= trb_buff_len;
4035 /* Check TD length */
4036 if (running_total != td_len) {
4037 xhci_err(xhci, "ISOC TD length unmatch\n");
4043 /* store the next frame id */
4044 if (HCC_CFC(xhci->hcc_params))
4045 xep->next_frame_id = urb->start_frame + num_tds * urb->interval;
4047 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs == 0) {
4048 if (xhci->quirks & XHCI_AMD_PLL_FIX)
4049 usb_amd_quirk_pll_disable();
4051 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs++;
4053 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
4054 start_cycle, start_trb);
4057 /* Clean up a partially enqueued isoc transfer. */
4059 for (i--; i >= 0; i--)
4060 list_del_init(&urb_priv->td[i].td_list);
4062 /* Use the first TD as a temporary variable to turn the TDs we've queued
4063 * into No-ops with a software-owned cycle bit. That way the hardware
4064 * won't accidentally start executing bogus TDs when we partially
4065 * overwrite them. td->first_trb and td->start_seg are already set.
4067 urb_priv->td[0].last_trb = ep_ring->enqueue;
4068 /* Every TRB except the first & last will have its cycle bit flipped. */
4069 td_to_noop(xhci, ep_ring, &urb_priv->td[0], true);
4071 /* Reset the ring enqueue back to the first TRB and its cycle bit. */
4072 ep_ring->enqueue = urb_priv->td[0].first_trb;
4073 ep_ring->enq_seg = urb_priv->td[0].start_seg;
4074 ep_ring->cycle_state = start_cycle;
4075 ep_ring->num_trbs_free = ep_ring->num_trbs_free_temp;
4076 usb_hcd_unlink_urb_from_ep(bus_to_hcd(urb->dev->bus), urb);
4081 * Check transfer ring to guarantee there is enough room for the urb.
4082 * Update ISO URB start_frame and interval.
4083 * Update interval as xhci_queue_intr_tx does. Use xhci frame_index to
4084 * update urb->start_frame if URB_ISO_ASAP is set in transfer_flags or
4085 * Contiguous Frame ID is not supported by HC.
4087 int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
4088 struct urb *urb, int slot_id, unsigned int ep_index)
4090 struct xhci_virt_device *xdev;
4091 struct xhci_ring *ep_ring;
4092 struct xhci_ep_ctx *ep_ctx;
4094 int num_tds, num_trbs, i;
4096 struct xhci_virt_ep *xep;
4099 xdev = xhci->devs[slot_id];
4100 xep = &xhci->devs[slot_id]->eps[ep_index];
4101 ep_ring = xdev->eps[ep_index].ring;
4102 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
4105 num_tds = urb->number_of_packets;
4106 for (i = 0; i < num_tds; i++)
4107 num_trbs += count_isoc_trbs_needed(urb, i);
4109 /* Check the ring to guarantee there is enough room for the whole urb.
4110 * Do not insert any td of the urb to the ring if the check failed.
4112 ret = prepare_ring(xhci, ep_ring, GET_EP_CTX_STATE(ep_ctx),
4113 num_trbs, mem_flags);
4118 * Check interval value. This should be done before we start to
4119 * calculate the start frame value.
4121 check_interval(xhci, urb, ep_ctx);
4123 /* Calculate the start frame and put it in urb->start_frame. */
4124 if (HCC_CFC(xhci->hcc_params) && !list_empty(&ep_ring->td_list)) {
4125 if (GET_EP_CTX_STATE(ep_ctx) == EP_STATE_RUNNING) {
4126 urb->start_frame = xep->next_frame_id;
4127 goto skip_start_over;
4131 start_frame = readl(&xhci->run_regs->microframe_index);
4132 start_frame &= 0x3fff;
4134 * Round up to the next frame and consider the time before trb really
4135 * gets scheduled by hardare.
4137 ist = HCS_IST(xhci->hcs_params2) & 0x7;
4138 if (HCS_IST(xhci->hcs_params2) & (1 << 3))
4140 start_frame += ist + XHCI_CFC_DELAY;
4141 start_frame = roundup(start_frame, 8);
4144 * Round up to the next ESIT (Endpoint Service Interval Time) if ESIT
4145 * is greate than 8 microframes.
4147 if (urb->dev->speed == USB_SPEED_LOW ||
4148 urb->dev->speed == USB_SPEED_FULL) {
4149 start_frame = roundup(start_frame, urb->interval << 3);
4150 urb->start_frame = start_frame >> 3;
4152 start_frame = roundup(start_frame, urb->interval);
4153 urb->start_frame = start_frame;
4157 ep_ring->num_trbs_free_temp = ep_ring->num_trbs_free;
4159 return xhci_queue_isoc_tx(xhci, mem_flags, urb, slot_id, ep_index);
4162 /**** Command Ring Operations ****/
4164 /* Generic function for queueing a command TRB on the command ring.
4165 * Check to make sure there's room on the command ring for one command TRB.
4166 * Also check that there's room reserved for commands that must not fail.
4167 * If this is a command that must not fail, meaning command_must_succeed = TRUE,
4168 * then only check for the number of reserved spots.
4169 * Don't decrement xhci->cmd_ring_reserved_trbs after we've queued the TRB
4170 * because the command event handler may want to resubmit a failed command.
4172 static int queue_command(struct xhci_hcd *xhci, struct xhci_command *cmd,
4173 u32 field1, u32 field2,
4174 u32 field3, u32 field4, bool command_must_succeed)
4176 int reserved_trbs = xhci->cmd_ring_reserved_trbs;
4179 if ((xhci->xhc_state & XHCI_STATE_DYING) ||
4180 (xhci->xhc_state & XHCI_STATE_HALTED)) {
4181 xhci_dbg(xhci, "xHCI dying or halted, can't queue_command\n");
4185 if (!command_must_succeed)
4188 ret = prepare_ring(xhci, xhci->cmd_ring, EP_STATE_RUNNING,
4189 reserved_trbs, GFP_ATOMIC);
4191 xhci_err(xhci, "ERR: No room for command on command ring\n");
4192 if (command_must_succeed)
4193 xhci_err(xhci, "ERR: Reserved TRB counting for "
4194 "unfailable commands failed.\n");
4198 cmd->command_trb = xhci->cmd_ring->enqueue;
4200 /* if there are no other commands queued we start the timeout timer */
4201 if (list_empty(&xhci->cmd_list)) {
4202 xhci->current_cmd = cmd;
4203 xhci_mod_cmd_timer(xhci, XHCI_CMD_DEFAULT_TIMEOUT);
4206 list_add_tail(&cmd->cmd_list, &xhci->cmd_list);
4208 queue_trb(xhci, xhci->cmd_ring, false, field1, field2, field3,
4209 field4 | xhci->cmd_ring->cycle_state);
4213 /* Queue a slot enable or disable request on the command ring */
4214 int xhci_queue_slot_control(struct xhci_hcd *xhci, struct xhci_command *cmd,
4215 u32 trb_type, u32 slot_id)
4217 return queue_command(xhci, cmd, 0, 0, 0,
4218 TRB_TYPE(trb_type) | SLOT_ID_FOR_TRB(slot_id), false);
4221 /* Queue an address device command TRB */
4222 int xhci_queue_address_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
4223 dma_addr_t in_ctx_ptr, u32 slot_id, enum xhci_setup_dev setup)
4225 return queue_command(xhci, cmd, lower_32_bits(in_ctx_ptr),
4226 upper_32_bits(in_ctx_ptr), 0,
4227 TRB_TYPE(TRB_ADDR_DEV) | SLOT_ID_FOR_TRB(slot_id)
4228 | (setup == SETUP_CONTEXT_ONLY ? TRB_BSR : 0), false);
4231 int xhci_queue_vendor_command(struct xhci_hcd *xhci, struct xhci_command *cmd,
4232 u32 field1, u32 field2, u32 field3, u32 field4)
4234 return queue_command(xhci, cmd, field1, field2, field3, field4, false);
4237 /* Queue a reset device command TRB */
4238 int xhci_queue_reset_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
4241 return queue_command(xhci, cmd, 0, 0, 0,
4242 TRB_TYPE(TRB_RESET_DEV) | SLOT_ID_FOR_TRB(slot_id),
4246 /* Queue a configure endpoint command TRB */
4247 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci,
4248 struct xhci_command *cmd, dma_addr_t in_ctx_ptr,
4249 u32 slot_id, bool command_must_succeed)
4251 return queue_command(xhci, cmd, lower_32_bits(in_ctx_ptr),
4252 upper_32_bits(in_ctx_ptr), 0,
4253 TRB_TYPE(TRB_CONFIG_EP) | SLOT_ID_FOR_TRB(slot_id),
4254 command_must_succeed);
4257 /* Queue an evaluate context command TRB */
4258 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, struct xhci_command *cmd,
4259 dma_addr_t in_ctx_ptr, u32 slot_id, bool command_must_succeed)
4261 return queue_command(xhci, cmd, lower_32_bits(in_ctx_ptr),
4262 upper_32_bits(in_ctx_ptr), 0,
4263 TRB_TYPE(TRB_EVAL_CONTEXT) | SLOT_ID_FOR_TRB(slot_id),
4264 command_must_succeed);
4268 * Suspend is set to indicate "Stop Endpoint Command" is being issued to stop
4269 * activity on an endpoint that is about to be suspended.
4271 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, struct xhci_command *cmd,
4272 int slot_id, unsigned int ep_index, int suspend)
4274 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
4275 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
4276 u32 type = TRB_TYPE(TRB_STOP_RING);
4277 u32 trb_suspend = SUSPEND_PORT_FOR_TRB(suspend);
4279 return queue_command(xhci, cmd, 0, 0, 0,
4280 trb_slot_id | trb_ep_index | type | trb_suspend, false);
4283 /* Set Transfer Ring Dequeue Pointer command */
4284 void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
4285 unsigned int slot_id, unsigned int ep_index,
4286 struct xhci_dequeue_state *deq_state)
4289 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
4290 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
4291 u32 trb_stream_id = STREAM_ID_FOR_TRB(deq_state->stream_id);
4293 u32 type = TRB_TYPE(TRB_SET_DEQ);
4294 struct xhci_virt_ep *ep;
4295 struct xhci_command *cmd;
4298 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
4299 "Set TR Deq Ptr cmd, new deq seg = %p (0x%llx dma), new deq ptr = %p (0x%llx dma), new cycle = %u",
4300 deq_state->new_deq_seg,
4301 (unsigned long long)deq_state->new_deq_seg->dma,
4302 deq_state->new_deq_ptr,
4303 (unsigned long long)xhci_trb_virt_to_dma(
4304 deq_state->new_deq_seg, deq_state->new_deq_ptr),
4305 deq_state->new_cycle_state);
4307 addr = xhci_trb_virt_to_dma(deq_state->new_deq_seg,
4308 deq_state->new_deq_ptr);
4310 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
4311 xhci_warn(xhci, "WARN deq seg = %p, deq pt = %p\n",
4312 deq_state->new_deq_seg, deq_state->new_deq_ptr);
4315 ep = &xhci->devs[slot_id]->eps[ep_index];
4316 if ((ep->ep_state & SET_DEQ_PENDING)) {
4317 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
4318 xhci_warn(xhci, "A Set TR Deq Ptr command is pending.\n");
4322 /* This function gets called from contexts where it cannot sleep */
4323 cmd = xhci_alloc_command(xhci, false, GFP_ATOMIC);
4327 ep->queued_deq_seg = deq_state->new_deq_seg;
4328 ep->queued_deq_ptr = deq_state->new_deq_ptr;
4329 if (deq_state->stream_id)
4330 trb_sct = SCT_FOR_TRB(SCT_PRI_TR);
4331 ret = queue_command(xhci, cmd,
4332 lower_32_bits(addr) | trb_sct | deq_state->new_cycle_state,
4333 upper_32_bits(addr), trb_stream_id,
4334 trb_slot_id | trb_ep_index | type, false);
4336 xhci_free_command(xhci, cmd);
4340 /* Stop the TD queueing code from ringing the doorbell until
4341 * this command completes. The HC won't set the dequeue pointer
4342 * if the ring is running, and ringing the doorbell starts the
4345 ep->ep_state |= SET_DEQ_PENDING;
4348 int xhci_queue_reset_ep(struct xhci_hcd *xhci, struct xhci_command *cmd,
4349 int slot_id, unsigned int ep_index,
4350 enum xhci_ep_reset_type reset_type)
4352 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
4353 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
4354 u32 type = TRB_TYPE(TRB_RESET_EP);
4356 if (reset_type == EP_SOFT_RESET)
4359 return queue_command(xhci, cmd, 0, 0, 0,
4360 trb_slot_id | trb_ep_index | type, false);