xhci: Fix errors in the running total calculations in the TRB math
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / usb / host / xhci-ring.c
blob11d7999db25cddefff090a295faa6dce6c16dbdf
1 /*
2 * xHCI host controller driver
4 * Copyright (C) 2008 Intel Corp.
6 * Author: Sarah Sharp
7 * Some code borrowed from the Linux EHCI driver.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 * for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 * Ring initialization rules:
25 * 1. Each segment is initialized to zero, except for link TRBs.
26 * 2. Ring cycle state = 0. This represents Producer Cycle State (PCS) or
27 * Consumer Cycle State (CCS), depending on ring function.
28 * 3. Enqueue pointer = dequeue pointer = address of first TRB in the segment.
30 * Ring behavior rules:
31 * 1. A ring is empty if enqueue == dequeue. This means there will always be at
32 * least one free TRB in the ring. This is useful if you want to turn that
33 * into a link TRB and expand the ring.
34 * 2. When incrementing an enqueue or dequeue pointer, if the next TRB is a
35 * link TRB, then load the pointer with the address in the link TRB. If the
36 * link TRB had its toggle bit set, you may need to update the ring cycle
37 * state (see cycle bit rules). You may have to do this multiple times
38 * until you reach a non-link TRB.
39 * 3. A ring is full if enqueue++ (for the definition of increment above)
40 * equals the dequeue pointer.
42 * Cycle bit rules:
43 * 1. When a consumer increments a dequeue pointer and encounters a toggle bit
44 * in a link TRB, it must toggle the ring cycle state.
45 * 2. When a producer increments an enqueue pointer and encounters a toggle bit
46 * in a link TRB, it must toggle the ring cycle state.
48 * Producer rules:
49 * 1. Check if ring is full before you enqueue.
50 * 2. Write the ring cycle state to the cycle bit in the TRB you're enqueuing.
51 * Update enqueue pointer between each write (which may update the ring
52 * cycle state).
53 * 3. Notify consumer. If SW is producer, it rings the doorbell for command
54 * and endpoint rings. If HC is the producer for the event ring,
55 * and it generates an interrupt according to interrupt modulation rules.
57 * Consumer rules:
58 * 1. Check if TRB belongs to you. If the cycle bit == your ring cycle state,
59 * the TRB is owned by the consumer.
60 * 2. Update dequeue pointer (which may update the ring cycle state) and
61 * continue processing TRBs until you reach a TRB which is not owned by you.
62 * 3. Notify the producer. SW is the consumer for the event ring, and it
63 * updates event ring dequeue pointer. HC is the consumer for the command and
64 * endpoint rings; it generates events on the event ring for these.
67 #include <linux/scatterlist.h>
68 #include <linux/slab.h>
69 #include "xhci.h"
71 static int handle_cmd_in_cmd_wait_list(struct xhci_hcd *xhci,
72 struct xhci_virt_device *virt_dev,
73 struct xhci_event_cmd *event);
76 * Returns zero if the TRB isn't in this segment, otherwise it returns the DMA
77 * address of the TRB.
79 dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg,
80 union xhci_trb *trb)
82 unsigned long segment_offset;
84 if (!seg || !trb || trb < seg->trbs)
85 return 0;
86 /* offset in TRBs */
87 segment_offset = trb - seg->trbs;
88 if (segment_offset > TRBS_PER_SEGMENT)
89 return 0;
90 return seg->dma + (segment_offset * sizeof(*trb));
93 /* Does this link TRB point to the first segment in a ring,
94 * or was the previous TRB the last TRB on the last segment in the ERST?
96 static inline bool last_trb_on_last_seg(struct xhci_hcd *xhci, struct xhci_ring *ring,
97 struct xhci_segment *seg, union xhci_trb *trb)
99 if (ring == xhci->event_ring)
100 return (trb == &seg->trbs[TRBS_PER_SEGMENT]) &&
101 (seg->next == xhci->event_ring->first_seg);
102 else
103 return trb->link.control & LINK_TOGGLE;
106 /* Is this TRB a link TRB or was the last TRB the last TRB in this event ring
107 * segment? I.e. would the updated event TRB pointer step off the end of the
108 * event seg?
110 static inline int last_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
111 struct xhci_segment *seg, union xhci_trb *trb)
113 if (ring == xhci->event_ring)
114 return trb == &seg->trbs[TRBS_PER_SEGMENT];
115 else
116 return (trb->link.control & TRB_TYPE_BITMASK) == TRB_TYPE(TRB_LINK);
119 static inline int enqueue_is_link_trb(struct xhci_ring *ring)
121 struct xhci_link_trb *link = &ring->enqueue->link;
122 return ((link->control & TRB_TYPE_BITMASK) == TRB_TYPE(TRB_LINK));
125 /* Updates trb to point to the next TRB in the ring, and updates seg if the next
126 * TRB is in a new segment. This does not skip over link TRBs, and it does not
127 * effect the ring dequeue or enqueue pointers.
129 static void next_trb(struct xhci_hcd *xhci,
130 struct xhci_ring *ring,
131 struct xhci_segment **seg,
132 union xhci_trb **trb)
134 if (last_trb(xhci, ring, *seg, *trb)) {
135 *seg = (*seg)->next;
136 *trb = ((*seg)->trbs);
137 } else {
138 (*trb)++;
143 * See Cycle bit rules. SW is the consumer for the event ring only.
144 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
146 static void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring, bool consumer)
148 union xhci_trb *next = ++(ring->dequeue);
149 unsigned long long addr;
151 ring->deq_updates++;
152 /* Update the dequeue pointer further if that was a link TRB or we're at
153 * the end of an event ring segment (which doesn't have link TRBS)
155 while (last_trb(xhci, ring, ring->deq_seg, next)) {
156 if (consumer && last_trb_on_last_seg(xhci, ring, ring->deq_seg, next)) {
157 ring->cycle_state = (ring->cycle_state ? 0 : 1);
158 if (!in_interrupt())
159 xhci_dbg(xhci, "Toggle cycle state for ring %p = %i\n",
160 ring,
161 (unsigned int) ring->cycle_state);
163 ring->deq_seg = ring->deq_seg->next;
164 ring->dequeue = ring->deq_seg->trbs;
165 next = ring->dequeue;
167 addr = (unsigned long long) xhci_trb_virt_to_dma(ring->deq_seg, ring->dequeue);
168 if (ring == xhci->event_ring)
169 xhci_dbg(xhci, "Event ring deq = 0x%llx (DMA)\n", addr);
170 else if (ring == xhci->cmd_ring)
171 xhci_dbg(xhci, "Command ring deq = 0x%llx (DMA)\n", addr);
172 else
173 xhci_dbg(xhci, "Ring deq = 0x%llx (DMA)\n", addr);
177 * See Cycle bit rules. SW is the consumer for the event ring only.
178 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
180 * If we've just enqueued a TRB that is in the middle of a TD (meaning the
181 * chain bit is set), then set the chain bit in all the following link TRBs.
182 * If we've enqueued the last TRB in a TD, make sure the following link TRBs
183 * have their chain bit cleared (so that each Link TRB is a separate TD).
185 * Section 6.4.4.1 of the 0.95 spec says link TRBs cannot have the chain bit
186 * set, but other sections talk about dealing with the chain bit set. This was
187 * fixed in the 0.96 specification errata, but we have to assume that all 0.95
188 * xHCI hardware can't handle the chain bit being cleared on a link TRB.
190 * @more_trbs_coming: Will you enqueue more TRBs before calling
191 * prepare_transfer()?
193 static void inc_enq(struct xhci_hcd *xhci, struct xhci_ring *ring,
194 bool consumer, bool more_trbs_coming)
196 u32 chain;
197 union xhci_trb *next;
198 unsigned long long addr;
200 chain = ring->enqueue->generic.field[3] & TRB_CHAIN;
201 next = ++(ring->enqueue);
203 ring->enq_updates++;
204 /* Update the dequeue pointer further if that was a link TRB or we're at
205 * the end of an event ring segment (which doesn't have link TRBS)
207 while (last_trb(xhci, ring, ring->enq_seg, next)) {
208 if (!consumer) {
209 if (ring != xhci->event_ring) {
211 * If the caller doesn't plan on enqueueing more
212 * TDs before ringing the doorbell, then we
213 * don't want to give the link TRB to the
214 * hardware just yet. We'll give the link TRB
215 * back in prepare_ring() just before we enqueue
216 * the TD at the top of the ring.
218 if (!chain && !more_trbs_coming)
219 break;
221 /* If we're not dealing with 0.95 hardware,
222 * carry over the chain bit of the previous TRB
223 * (which may mean the chain bit is cleared).
225 if (!xhci_link_trb_quirk(xhci)) {
226 next->link.control &= ~TRB_CHAIN;
227 next->link.control |= chain;
229 /* Give this link TRB to the hardware */
230 wmb();
231 next->link.control ^= TRB_CYCLE;
233 /* Toggle the cycle bit after the last ring segment. */
234 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
235 ring->cycle_state = (ring->cycle_state ? 0 : 1);
236 if (!in_interrupt())
237 xhci_dbg(xhci, "Toggle cycle state for ring %p = %i\n",
238 ring,
239 (unsigned int) ring->cycle_state);
242 ring->enq_seg = ring->enq_seg->next;
243 ring->enqueue = ring->enq_seg->trbs;
244 next = ring->enqueue;
246 addr = (unsigned long long) xhci_trb_virt_to_dma(ring->enq_seg, ring->enqueue);
247 if (ring == xhci->event_ring)
248 xhci_dbg(xhci, "Event ring enq = 0x%llx (DMA)\n", addr);
249 else if (ring == xhci->cmd_ring)
250 xhci_dbg(xhci, "Command ring enq = 0x%llx (DMA)\n", addr);
251 else
252 xhci_dbg(xhci, "Ring enq = 0x%llx (DMA)\n", addr);
256 * Check to see if there's room to enqueue num_trbs on the ring. See rules
257 * above.
258 * FIXME: this would be simpler and faster if we just kept track of the number
259 * of free TRBs in a ring.
261 static int room_on_ring(struct xhci_hcd *xhci, struct xhci_ring *ring,
262 unsigned int num_trbs)
264 int i;
265 union xhci_trb *enq = ring->enqueue;
266 struct xhci_segment *enq_seg = ring->enq_seg;
267 struct xhci_segment *cur_seg;
268 unsigned int left_on_ring;
270 /* If we are currently pointing to a link TRB, advance the
271 * enqueue pointer before checking for space */
272 while (last_trb(xhci, ring, enq_seg, enq)) {
273 enq_seg = enq_seg->next;
274 enq = enq_seg->trbs;
277 /* Check if ring is empty */
278 if (enq == ring->dequeue) {
279 /* Can't use link trbs */
280 left_on_ring = TRBS_PER_SEGMENT - 1;
281 for (cur_seg = enq_seg->next; cur_seg != enq_seg;
282 cur_seg = cur_seg->next)
283 left_on_ring += TRBS_PER_SEGMENT - 1;
285 /* Always need one TRB free in the ring. */
286 left_on_ring -= 1;
287 if (num_trbs > left_on_ring) {
288 xhci_warn(xhci, "Not enough room on ring; "
289 "need %u TRBs, %u TRBs left\n",
290 num_trbs, left_on_ring);
291 return 0;
293 return 1;
295 /* Make sure there's an extra empty TRB available */
296 for (i = 0; i <= num_trbs; ++i) {
297 if (enq == ring->dequeue)
298 return 0;
299 enq++;
300 while (last_trb(xhci, ring, enq_seg, enq)) {
301 enq_seg = enq_seg->next;
302 enq = enq_seg->trbs;
305 return 1;
308 /* Ring the host controller doorbell after placing a command on the ring */
309 void xhci_ring_cmd_db(struct xhci_hcd *xhci)
311 u32 temp;
313 xhci_dbg(xhci, "// Ding dong!\n");
314 temp = xhci_readl(xhci, &xhci->dba->doorbell[0]) & DB_MASK;
315 xhci_writel(xhci, temp | DB_TARGET_HOST, &xhci->dba->doorbell[0]);
316 /* Flush PCI posted writes */
317 xhci_readl(xhci, &xhci->dba->doorbell[0]);
320 void xhci_ring_ep_doorbell(struct xhci_hcd *xhci,
321 unsigned int slot_id,
322 unsigned int ep_index,
323 unsigned int stream_id)
325 struct xhci_virt_ep *ep;
326 unsigned int ep_state;
327 u32 field;
328 __u32 __iomem *db_addr = &xhci->dba->doorbell[slot_id];
330 ep = &xhci->devs[slot_id]->eps[ep_index];
331 ep_state = ep->ep_state;
332 /* Don't ring the doorbell for this endpoint if there are pending
333 * cancellations because the we don't want to interrupt processing.
334 * We don't want to restart any stream rings if there's a set dequeue
335 * pointer command pending because the device can choose to start any
336 * stream once the endpoint is on the HW schedule.
337 * FIXME - check all the stream rings for pending cancellations.
339 if (!(ep_state & EP_HALT_PENDING) && !(ep_state & SET_DEQ_PENDING)
340 && !(ep_state & EP_HALTED)) {
341 field = xhci_readl(xhci, db_addr) & DB_MASK;
342 field |= EPI_TO_DB(ep_index) | STREAM_ID_TO_DB(stream_id);
343 xhci_writel(xhci, field, db_addr);
347 /* Ring the doorbell for any rings with pending URBs */
348 static void ring_doorbell_for_active_rings(struct xhci_hcd *xhci,
349 unsigned int slot_id,
350 unsigned int ep_index)
352 unsigned int stream_id;
353 struct xhci_virt_ep *ep;
355 ep = &xhci->devs[slot_id]->eps[ep_index];
357 /* A ring has pending URBs if its TD list is not empty */
358 if (!(ep->ep_state & EP_HAS_STREAMS)) {
359 if (!(list_empty(&ep->ring->td_list)))
360 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, 0);
361 return;
364 for (stream_id = 1; stream_id < ep->stream_info->num_streams;
365 stream_id++) {
366 struct xhci_stream_info *stream_info = ep->stream_info;
367 if (!list_empty(&stream_info->stream_rings[stream_id]->td_list))
368 xhci_ring_ep_doorbell(xhci, slot_id, ep_index,
369 stream_id);
374 * Find the segment that trb is in. Start searching in start_seg.
375 * If we must move past a segment that has a link TRB with a toggle cycle state
376 * bit set, then we will toggle the value pointed at by cycle_state.
378 static struct xhci_segment *find_trb_seg(
379 struct xhci_segment *start_seg,
380 union xhci_trb *trb, int *cycle_state)
382 struct xhci_segment *cur_seg = start_seg;
383 struct xhci_generic_trb *generic_trb;
385 while (cur_seg->trbs > trb ||
386 &cur_seg->trbs[TRBS_PER_SEGMENT - 1] < trb) {
387 generic_trb = &cur_seg->trbs[TRBS_PER_SEGMENT - 1].generic;
388 if ((generic_trb->field[3] & TRB_TYPE_BITMASK) ==
389 TRB_TYPE(TRB_LINK) &&
390 (generic_trb->field[3] & LINK_TOGGLE))
391 *cycle_state = ~(*cycle_state) & 0x1;
392 cur_seg = cur_seg->next;
393 if (cur_seg == start_seg)
394 /* Looped over the entire list. Oops! */
395 return NULL;
397 return cur_seg;
401 static struct xhci_ring *xhci_triad_to_transfer_ring(struct xhci_hcd *xhci,
402 unsigned int slot_id, unsigned int ep_index,
403 unsigned int stream_id)
405 struct xhci_virt_ep *ep;
407 ep = &xhci->devs[slot_id]->eps[ep_index];
408 /* Common case: no streams */
409 if (!(ep->ep_state & EP_HAS_STREAMS))
410 return ep->ring;
412 if (stream_id == 0) {
413 xhci_warn(xhci,
414 "WARN: Slot ID %u, ep index %u has streams, "
415 "but URB has no stream ID.\n",
416 slot_id, ep_index);
417 return NULL;
420 if (stream_id < ep->stream_info->num_streams)
421 return ep->stream_info->stream_rings[stream_id];
423 xhci_warn(xhci,
424 "WARN: Slot ID %u, ep index %u has "
425 "stream IDs 1 to %u allocated, "
426 "but stream ID %u is requested.\n",
427 slot_id, ep_index,
428 ep->stream_info->num_streams - 1,
429 stream_id);
430 return NULL;
433 /* Get the right ring for the given URB.
434 * If the endpoint supports streams, boundary check the URB's stream ID.
435 * If the endpoint doesn't support streams, return the singular endpoint ring.
437 static struct xhci_ring *xhci_urb_to_transfer_ring(struct xhci_hcd *xhci,
438 struct urb *urb)
440 return xhci_triad_to_transfer_ring(xhci, urb->dev->slot_id,
441 xhci_get_endpoint_index(&urb->ep->desc), urb->stream_id);
445 * Move the xHC's endpoint ring dequeue pointer past cur_td.
446 * Record the new state of the xHC's endpoint ring dequeue segment,
447 * dequeue pointer, and new consumer cycle state in state.
448 * Update our internal representation of the ring's dequeue pointer.
450 * We do this in three jumps:
451 * - First we update our new ring state to be the same as when the xHC stopped.
452 * - Then we traverse the ring to find the segment that contains
453 * the last TRB in the TD. We toggle the xHC's new cycle state when we pass
454 * any link TRBs with the toggle cycle bit set.
455 * - Finally we move the dequeue state one TRB further, toggling the cycle bit
456 * if we've moved it past a link TRB with the toggle cycle bit set.
458 void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
459 unsigned int slot_id, unsigned int ep_index,
460 unsigned int stream_id, struct xhci_td *cur_td,
461 struct xhci_dequeue_state *state)
463 struct xhci_virt_device *dev = xhci->devs[slot_id];
464 struct xhci_ring *ep_ring;
465 struct xhci_generic_trb *trb;
466 struct xhci_ep_ctx *ep_ctx;
467 dma_addr_t addr;
469 ep_ring = xhci_triad_to_transfer_ring(xhci, slot_id,
470 ep_index, stream_id);
471 if (!ep_ring) {
472 xhci_warn(xhci, "WARN can't find new dequeue state "
473 "for invalid stream ID %u.\n",
474 stream_id);
475 return;
477 state->new_cycle_state = 0;
478 xhci_dbg(xhci, "Finding segment containing stopped TRB.\n");
479 state->new_deq_seg = find_trb_seg(cur_td->start_seg,
480 dev->eps[ep_index].stopped_trb,
481 &state->new_cycle_state);
482 if (!state->new_deq_seg) {
483 WARN_ON(1);
484 return;
487 /* Dig out the cycle state saved by the xHC during the stop ep cmd */
488 xhci_dbg(xhci, "Finding endpoint context\n");
489 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
490 state->new_cycle_state = 0x1 & ep_ctx->deq;
492 state->new_deq_ptr = cur_td->last_trb;
493 xhci_dbg(xhci, "Finding segment containing last TRB in TD.\n");
494 state->new_deq_seg = find_trb_seg(state->new_deq_seg,
495 state->new_deq_ptr,
496 &state->new_cycle_state);
497 if (!state->new_deq_seg) {
498 WARN_ON(1);
499 return;
502 trb = &state->new_deq_ptr->generic;
503 if ((trb->field[3] & TRB_TYPE_BITMASK) == TRB_TYPE(TRB_LINK) &&
504 (trb->field[3] & LINK_TOGGLE))
505 state->new_cycle_state = ~(state->new_cycle_state) & 0x1;
506 next_trb(xhci, ep_ring, &state->new_deq_seg, &state->new_deq_ptr);
508 /* Don't update the ring cycle state for the producer (us). */
509 xhci_dbg(xhci, "New dequeue segment = %p (virtual)\n",
510 state->new_deq_seg);
511 addr = xhci_trb_virt_to_dma(state->new_deq_seg, state->new_deq_ptr);
512 xhci_dbg(xhci, "New dequeue pointer = 0x%llx (DMA)\n",
513 (unsigned long long) addr);
514 xhci_dbg(xhci, "Setting dequeue pointer in internal ring state.\n");
515 ep_ring->dequeue = state->new_deq_ptr;
516 ep_ring->deq_seg = state->new_deq_seg;
519 static void td_to_noop(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
520 struct xhci_td *cur_td)
522 struct xhci_segment *cur_seg;
523 union xhci_trb *cur_trb;
525 for (cur_seg = cur_td->start_seg, cur_trb = cur_td->first_trb;
526 true;
527 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
528 if ((cur_trb->generic.field[3] & TRB_TYPE_BITMASK) ==
529 TRB_TYPE(TRB_LINK)) {
530 /* Unchain any chained Link TRBs, but
531 * leave the pointers intact.
533 cur_trb->generic.field[3] &= ~TRB_CHAIN;
534 xhci_dbg(xhci, "Cancel (unchain) link TRB\n");
535 xhci_dbg(xhci, "Address = %p (0x%llx dma); "
536 "in seg %p (0x%llx dma)\n",
537 cur_trb,
538 (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
539 cur_seg,
540 (unsigned long long)cur_seg->dma);
541 } else {
542 cur_trb->generic.field[0] = 0;
543 cur_trb->generic.field[1] = 0;
544 cur_trb->generic.field[2] = 0;
545 /* Preserve only the cycle bit of this TRB */
546 cur_trb->generic.field[3] &= TRB_CYCLE;
547 cur_trb->generic.field[3] |= TRB_TYPE(TRB_TR_NOOP);
548 xhci_dbg(xhci, "Cancel TRB %p (0x%llx dma) "
549 "in seg %p (0x%llx dma)\n",
550 cur_trb,
551 (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
552 cur_seg,
553 (unsigned long long)cur_seg->dma);
555 if (cur_trb == cur_td->last_trb)
556 break;
560 static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
561 unsigned int ep_index, unsigned int stream_id,
562 struct xhci_segment *deq_seg,
563 union xhci_trb *deq_ptr, u32 cycle_state);
565 void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
566 unsigned int slot_id, unsigned int ep_index,
567 unsigned int stream_id,
568 struct xhci_dequeue_state *deq_state)
570 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
572 xhci_dbg(xhci, "Set TR Deq Ptr cmd, new deq seg = %p (0x%llx dma), "
573 "new deq ptr = %p (0x%llx dma), new cycle = %u\n",
574 deq_state->new_deq_seg,
575 (unsigned long long)deq_state->new_deq_seg->dma,
576 deq_state->new_deq_ptr,
577 (unsigned long long)xhci_trb_virt_to_dma(deq_state->new_deq_seg, deq_state->new_deq_ptr),
578 deq_state->new_cycle_state);
579 queue_set_tr_deq(xhci, slot_id, ep_index, stream_id,
580 deq_state->new_deq_seg,
581 deq_state->new_deq_ptr,
582 (u32) deq_state->new_cycle_state);
583 /* Stop the TD queueing code from ringing the doorbell until
584 * this command completes. The HC won't set the dequeue pointer
585 * if the ring is running, and ringing the doorbell starts the
586 * ring running.
588 ep->ep_state |= SET_DEQ_PENDING;
591 static inline void xhci_stop_watchdog_timer_in_irq(struct xhci_hcd *xhci,
592 struct xhci_virt_ep *ep)
594 ep->ep_state &= ~EP_HALT_PENDING;
595 /* Can't del_timer_sync in interrupt, so we attempt to cancel. If the
596 * timer is running on another CPU, we don't decrement stop_cmds_pending
597 * (since we didn't successfully stop the watchdog timer).
599 if (del_timer(&ep->stop_cmd_timer))
600 ep->stop_cmds_pending--;
603 /* Must be called with xhci->lock held in interrupt context */
604 static void xhci_giveback_urb_in_irq(struct xhci_hcd *xhci,
605 struct xhci_td *cur_td, int status, char *adjective)
607 struct usb_hcd *hcd = xhci_to_hcd(xhci);
608 struct urb *urb;
609 struct urb_priv *urb_priv;
611 urb = cur_td->urb;
612 urb_priv = urb->hcpriv;
613 urb_priv->td_cnt++;
615 /* Only giveback urb when this is the last td in urb */
616 if (urb_priv->td_cnt == urb_priv->length) {
617 usb_hcd_unlink_urb_from_ep(hcd, urb);
618 xhci_dbg(xhci, "Giveback %s URB %p\n", adjective, urb);
620 spin_unlock(&xhci->lock);
621 usb_hcd_giveback_urb(hcd, urb, status);
622 xhci_urb_free_priv(xhci, urb_priv);
623 spin_lock(&xhci->lock);
624 xhci_dbg(xhci, "%s URB given back\n", adjective);
629 * When we get a command completion for a Stop Endpoint Command, we need to
630 * unlink any cancelled TDs from the ring. There are two ways to do that:
632 * 1. If the HW was in the middle of processing the TD that needs to be
633 * cancelled, then we must move the ring's dequeue pointer past the last TRB
634 * in the TD with a Set Dequeue Pointer Command.
635 * 2. Otherwise, we turn all the TRBs in the TD into No-op TRBs (with the chain
636 * bit cleared) so that the HW will skip over them.
638 static void handle_stopped_endpoint(struct xhci_hcd *xhci,
639 union xhci_trb *trb, struct xhci_event_cmd *event)
641 unsigned int slot_id;
642 unsigned int ep_index;
643 struct xhci_virt_device *virt_dev;
644 struct xhci_ring *ep_ring;
645 struct xhci_virt_ep *ep;
646 struct list_head *entry;
647 struct xhci_td *cur_td = NULL;
648 struct xhci_td *last_unlinked_td;
650 struct xhci_dequeue_state deq_state;
652 if (unlikely(TRB_TO_SUSPEND_PORT(
653 xhci->cmd_ring->dequeue->generic.field[3]))) {
654 slot_id = TRB_TO_SLOT_ID(
655 xhci->cmd_ring->dequeue->generic.field[3]);
656 virt_dev = xhci->devs[slot_id];
657 if (virt_dev)
658 handle_cmd_in_cmd_wait_list(xhci, virt_dev,
659 event);
660 else
661 xhci_warn(xhci, "Stop endpoint command "
662 "completion for disabled slot %u\n",
663 slot_id);
664 return;
667 memset(&deq_state, 0, sizeof(deq_state));
668 slot_id = TRB_TO_SLOT_ID(trb->generic.field[3]);
669 ep_index = TRB_TO_EP_INDEX(trb->generic.field[3]);
670 ep = &xhci->devs[slot_id]->eps[ep_index];
672 if (list_empty(&ep->cancelled_td_list)) {
673 xhci_stop_watchdog_timer_in_irq(xhci, ep);
674 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
675 return;
678 /* Fix up the ep ring first, so HW stops executing cancelled TDs.
679 * We have the xHCI lock, so nothing can modify this list until we drop
680 * it. We're also in the event handler, so we can't get re-interrupted
681 * if another Stop Endpoint command completes
683 list_for_each(entry, &ep->cancelled_td_list) {
684 cur_td = list_entry(entry, struct xhci_td, cancelled_td_list);
685 xhci_dbg(xhci, "Cancelling TD starting at %p, 0x%llx (dma).\n",
686 cur_td->first_trb,
687 (unsigned long long)xhci_trb_virt_to_dma(cur_td->start_seg, cur_td->first_trb));
688 ep_ring = xhci_urb_to_transfer_ring(xhci, cur_td->urb);
689 if (!ep_ring) {
690 /* This shouldn't happen unless a driver is mucking
691 * with the stream ID after submission. This will
692 * leave the TD on the hardware ring, and the hardware
693 * will try to execute it, and may access a buffer
694 * that has already been freed. In the best case, the
695 * hardware will execute it, and the event handler will
696 * ignore the completion event for that TD, since it was
697 * removed from the td_list for that endpoint. In
698 * short, don't muck with the stream ID after
699 * submission.
701 xhci_warn(xhci, "WARN Cancelled URB %p "
702 "has invalid stream ID %u.\n",
703 cur_td->urb,
704 cur_td->urb->stream_id);
705 goto remove_finished_td;
708 * If we stopped on the TD we need to cancel, then we have to
709 * move the xHC endpoint ring dequeue pointer past this TD.
711 if (cur_td == ep->stopped_td)
712 xhci_find_new_dequeue_state(xhci, slot_id, ep_index,
713 cur_td->urb->stream_id,
714 cur_td, &deq_state);
715 else
716 td_to_noop(xhci, ep_ring, cur_td);
717 remove_finished_td:
719 * The event handler won't see a completion for this TD anymore,
720 * so remove it from the endpoint ring's TD list. Keep it in
721 * the cancelled TD list for URB completion later.
723 list_del(&cur_td->td_list);
725 last_unlinked_td = cur_td;
726 xhci_stop_watchdog_timer_in_irq(xhci, ep);
728 /* If necessary, queue a Set Transfer Ring Dequeue Pointer command */
729 if (deq_state.new_deq_ptr && deq_state.new_deq_seg) {
730 xhci_queue_new_dequeue_state(xhci,
731 slot_id, ep_index,
732 ep->stopped_td->urb->stream_id,
733 &deq_state);
734 xhci_ring_cmd_db(xhci);
735 } else {
736 /* Otherwise ring the doorbell(s) to restart queued transfers */
737 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
739 ep->stopped_td = NULL;
740 ep->stopped_trb = NULL;
743 * Drop the lock and complete the URBs in the cancelled TD list.
744 * New TDs to be cancelled might be added to the end of the list before
745 * we can complete all the URBs for the TDs we already unlinked.
746 * So stop when we've completed the URB for the last TD we unlinked.
748 do {
749 cur_td = list_entry(ep->cancelled_td_list.next,
750 struct xhci_td, cancelled_td_list);
751 list_del(&cur_td->cancelled_td_list);
753 /* Clean up the cancelled URB */
754 /* Doesn't matter what we pass for status, since the core will
755 * just overwrite it (because the URB has been unlinked).
757 xhci_giveback_urb_in_irq(xhci, cur_td, 0, "cancelled");
759 /* Stop processing the cancelled list if the watchdog timer is
760 * running.
762 if (xhci->xhc_state & XHCI_STATE_DYING)
763 return;
764 } while (cur_td != last_unlinked_td);
766 /* Return to the event handler with xhci->lock re-acquired */
769 /* Watchdog timer function for when a stop endpoint command fails to complete.
770 * In this case, we assume the host controller is broken or dying or dead. The
771 * host may still be completing some other events, so we have to be careful to
772 * let the event ring handler and the URB dequeueing/enqueueing functions know
773 * through xhci->state.
775 * The timer may also fire if the host takes a very long time to respond to the
776 * command, and the stop endpoint command completion handler cannot delete the
777 * timer before the timer function is called. Another endpoint cancellation may
778 * sneak in before the timer function can grab the lock, and that may queue
779 * another stop endpoint command and add the timer back. So we cannot use a
780 * simple flag to say whether there is a pending stop endpoint command for a
781 * particular endpoint.
783 * Instead we use a combination of that flag and a counter for the number of
784 * pending stop endpoint commands. If the timer is the tail end of the last
785 * stop endpoint command, and the endpoint's command is still pending, we assume
786 * the host is dying.
788 void xhci_stop_endpoint_command_watchdog(unsigned long arg)
790 struct xhci_hcd *xhci;
791 struct xhci_virt_ep *ep;
792 struct xhci_virt_ep *temp_ep;
793 struct xhci_ring *ring;
794 struct xhci_td *cur_td;
795 int ret, i, j;
797 ep = (struct xhci_virt_ep *) arg;
798 xhci = ep->xhci;
800 spin_lock(&xhci->lock);
802 ep->stop_cmds_pending--;
803 if (xhci->xhc_state & XHCI_STATE_DYING) {
804 xhci_dbg(xhci, "Stop EP timer ran, but another timer marked "
805 "xHCI as DYING, exiting.\n");
806 spin_unlock(&xhci->lock);
807 return;
809 if (!(ep->stop_cmds_pending == 0 && (ep->ep_state & EP_HALT_PENDING))) {
810 xhci_dbg(xhci, "Stop EP timer ran, but no command pending, "
811 "exiting.\n");
812 spin_unlock(&xhci->lock);
813 return;
816 xhci_warn(xhci, "xHCI host not responding to stop endpoint command.\n");
817 xhci_warn(xhci, "Assuming host is dying, halting host.\n");
818 /* Oops, HC is dead or dying or at least not responding to the stop
819 * endpoint command.
821 xhci->xhc_state |= XHCI_STATE_DYING;
822 /* Disable interrupts from the host controller and start halting it */
823 xhci_quiesce(xhci);
824 spin_unlock(&xhci->lock);
826 ret = xhci_halt(xhci);
828 spin_lock(&xhci->lock);
829 if (ret < 0) {
830 /* This is bad; the host is not responding to commands and it's
831 * not allowing itself to be halted. At least interrupts are
832 * disabled, so we can set HC_STATE_HALT and notify the
833 * USB core. But if we call usb_hc_died(), it will attempt to
834 * disconnect all device drivers under this host. Those
835 * disconnect() methods will wait for all URBs to be unlinked,
836 * so we must complete them.
838 xhci_warn(xhci, "Non-responsive xHCI host is not halting.\n");
839 xhci_warn(xhci, "Completing active URBs anyway.\n");
840 /* We could turn all TDs on the rings to no-ops. This won't
841 * help if the host has cached part of the ring, and is slow if
842 * we want to preserve the cycle bit. Skip it and hope the host
843 * doesn't touch the memory.
846 for (i = 0; i < MAX_HC_SLOTS; i++) {
847 if (!xhci->devs[i])
848 continue;
849 for (j = 0; j < 31; j++) {
850 temp_ep = &xhci->devs[i]->eps[j];
851 ring = temp_ep->ring;
852 if (!ring)
853 continue;
854 xhci_dbg(xhci, "Killing URBs for slot ID %u, "
855 "ep index %u\n", i, j);
856 while (!list_empty(&ring->td_list)) {
857 cur_td = list_first_entry(&ring->td_list,
858 struct xhci_td,
859 td_list);
860 list_del(&cur_td->td_list);
861 if (!list_empty(&cur_td->cancelled_td_list))
862 list_del(&cur_td->cancelled_td_list);
863 xhci_giveback_urb_in_irq(xhci, cur_td,
864 -ESHUTDOWN, "killed");
866 while (!list_empty(&temp_ep->cancelled_td_list)) {
867 cur_td = list_first_entry(
868 &temp_ep->cancelled_td_list,
869 struct xhci_td,
870 cancelled_td_list);
871 list_del(&cur_td->cancelled_td_list);
872 xhci_giveback_urb_in_irq(xhci, cur_td,
873 -ESHUTDOWN, "killed");
877 spin_unlock(&xhci->lock);
878 xhci_to_hcd(xhci)->state = HC_STATE_HALT;
879 xhci_dbg(xhci, "Calling usb_hc_died()\n");
880 usb_hc_died(xhci_to_hcd(xhci));
881 xhci_dbg(xhci, "xHCI host controller is dead.\n");
885 * When we get a completion for a Set Transfer Ring Dequeue Pointer command,
886 * we need to clear the set deq pending flag in the endpoint ring state, so that
887 * the TD queueing code can ring the doorbell again. We also need to ring the
888 * endpoint doorbell to restart the ring, but only if there aren't more
889 * cancellations pending.
891 static void handle_set_deq_completion(struct xhci_hcd *xhci,
892 struct xhci_event_cmd *event,
893 union xhci_trb *trb)
895 unsigned int slot_id;
896 unsigned int ep_index;
897 unsigned int stream_id;
898 struct xhci_ring *ep_ring;
899 struct xhci_virt_device *dev;
900 struct xhci_ep_ctx *ep_ctx;
901 struct xhci_slot_ctx *slot_ctx;
903 slot_id = TRB_TO_SLOT_ID(trb->generic.field[3]);
904 ep_index = TRB_TO_EP_INDEX(trb->generic.field[3]);
905 stream_id = TRB_TO_STREAM_ID(trb->generic.field[2]);
906 dev = xhci->devs[slot_id];
908 ep_ring = xhci_stream_id_to_ring(dev, ep_index, stream_id);
909 if (!ep_ring) {
910 xhci_warn(xhci, "WARN Set TR deq ptr command for "
911 "freed stream ID %u\n",
912 stream_id);
913 /* XXX: Harmless??? */
914 dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
915 return;
918 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
919 slot_ctx = xhci_get_slot_ctx(xhci, dev->out_ctx);
921 if (GET_COMP_CODE(event->status) != COMP_SUCCESS) {
922 unsigned int ep_state;
923 unsigned int slot_state;
925 switch (GET_COMP_CODE(event->status)) {
926 case COMP_TRB_ERR:
927 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd invalid because "
928 "of stream ID configuration\n");
929 break;
930 case COMP_CTX_STATE:
931 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed due "
932 "to incorrect slot or ep state.\n");
933 ep_state = ep_ctx->ep_info;
934 ep_state &= EP_STATE_MASK;
935 slot_state = slot_ctx->dev_state;
936 slot_state = GET_SLOT_STATE(slot_state);
937 xhci_dbg(xhci, "Slot state = %u, EP state = %u\n",
938 slot_state, ep_state);
939 break;
940 case COMP_EBADSLT:
941 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed because "
942 "slot %u was not enabled.\n", slot_id);
943 break;
944 default:
945 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd with unknown "
946 "completion code of %u.\n",
947 GET_COMP_CODE(event->status));
948 break;
950 /* OK what do we do now? The endpoint state is hosed, and we
951 * should never get to this point if the synchronization between
952 * queueing, and endpoint state are correct. This might happen
953 * if the device gets disconnected after we've finished
954 * cancelling URBs, which might not be an error...
956 } else {
957 xhci_dbg(xhci, "Successful Set TR Deq Ptr cmd, deq = @%08llx\n",
958 ep_ctx->deq);
961 dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
962 /* Restart any rings with pending URBs */
963 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
966 static void handle_reset_ep_completion(struct xhci_hcd *xhci,
967 struct xhci_event_cmd *event,
968 union xhci_trb *trb)
970 int slot_id;
971 unsigned int ep_index;
973 slot_id = TRB_TO_SLOT_ID(trb->generic.field[3]);
974 ep_index = TRB_TO_EP_INDEX(trb->generic.field[3]);
975 /* This command will only fail if the endpoint wasn't halted,
976 * but we don't care.
978 xhci_dbg(xhci, "Ignoring reset ep completion code of %u\n",
979 (unsigned int) GET_COMP_CODE(event->status));
981 /* HW with the reset endpoint quirk needs to have a configure endpoint
982 * command complete before the endpoint can be used. Queue that here
983 * because the HW can't handle two commands being queued in a row.
985 if (xhci->quirks & XHCI_RESET_EP_QUIRK) {
986 xhci_dbg(xhci, "Queueing configure endpoint command\n");
987 xhci_queue_configure_endpoint(xhci,
988 xhci->devs[slot_id]->in_ctx->dma, slot_id,
989 false);
990 xhci_ring_cmd_db(xhci);
991 } else {
992 /* Clear our internal halted state and restart the ring(s) */
993 xhci->devs[slot_id]->eps[ep_index].ep_state &= ~EP_HALTED;
994 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
998 /* Check to see if a command in the device's command queue matches this one.
999 * Signal the completion or free the command, and return 1. Return 0 if the
1000 * completed command isn't at the head of the command list.
1002 static int handle_cmd_in_cmd_wait_list(struct xhci_hcd *xhci,
1003 struct xhci_virt_device *virt_dev,
1004 struct xhci_event_cmd *event)
1006 struct xhci_command *command;
1008 if (list_empty(&virt_dev->cmd_list))
1009 return 0;
1011 command = list_entry(virt_dev->cmd_list.next,
1012 struct xhci_command, cmd_list);
1013 if (xhci->cmd_ring->dequeue != command->command_trb)
1014 return 0;
1016 command->status =
1017 GET_COMP_CODE(event->status);
1018 list_del(&command->cmd_list);
1019 if (command->completion)
1020 complete(command->completion);
1021 else
1022 xhci_free_command(xhci, command);
1023 return 1;
1026 static void handle_cmd_completion(struct xhci_hcd *xhci,
1027 struct xhci_event_cmd *event)
1029 int slot_id = TRB_TO_SLOT_ID(event->flags);
1030 u64 cmd_dma;
1031 dma_addr_t cmd_dequeue_dma;
1032 struct xhci_input_control_ctx *ctrl_ctx;
1033 struct xhci_virt_device *virt_dev;
1034 unsigned int ep_index;
1035 struct xhci_ring *ep_ring;
1036 unsigned int ep_state;
1038 cmd_dma = event->cmd_trb;
1039 cmd_dequeue_dma = xhci_trb_virt_to_dma(xhci->cmd_ring->deq_seg,
1040 xhci->cmd_ring->dequeue);
1041 /* Is the command ring deq ptr out of sync with the deq seg ptr? */
1042 if (cmd_dequeue_dma == 0) {
1043 xhci->error_bitmask |= 1 << 4;
1044 return;
1046 /* Does the DMA address match our internal dequeue pointer address? */
1047 if (cmd_dma != (u64) cmd_dequeue_dma) {
1048 xhci->error_bitmask |= 1 << 5;
1049 return;
1051 switch (xhci->cmd_ring->dequeue->generic.field[3] & TRB_TYPE_BITMASK) {
1052 case TRB_TYPE(TRB_ENABLE_SLOT):
1053 if (GET_COMP_CODE(event->status) == COMP_SUCCESS)
1054 xhci->slot_id = slot_id;
1055 else
1056 xhci->slot_id = 0;
1057 complete(&xhci->addr_dev);
1058 break;
1059 case TRB_TYPE(TRB_DISABLE_SLOT):
1060 if (xhci->devs[slot_id])
1061 xhci_free_virt_device(xhci, slot_id);
1062 break;
1063 case TRB_TYPE(TRB_CONFIG_EP):
1064 virt_dev = xhci->devs[slot_id];
1065 if (handle_cmd_in_cmd_wait_list(xhci, virt_dev, event))
1066 break;
1068 * Configure endpoint commands can come from the USB core
1069 * configuration or alt setting changes, or because the HW
1070 * needed an extra configure endpoint command after a reset
1071 * endpoint command or streams were being configured.
1072 * If the command was for a halted endpoint, the xHCI driver
1073 * is not waiting on the configure endpoint command.
1075 ctrl_ctx = xhci_get_input_control_ctx(xhci,
1076 virt_dev->in_ctx);
1077 /* Input ctx add_flags are the endpoint index plus one */
1078 ep_index = xhci_last_valid_endpoint(ctrl_ctx->add_flags) - 1;
1079 /* A usb_set_interface() call directly after clearing a halted
1080 * condition may race on this quirky hardware. Not worth
1081 * worrying about, since this is prototype hardware. Not sure
1082 * if this will work for streams, but streams support was
1083 * untested on this prototype.
1085 if (xhci->quirks & XHCI_RESET_EP_QUIRK &&
1086 ep_index != (unsigned int) -1 &&
1087 ctrl_ctx->add_flags - SLOT_FLAG ==
1088 ctrl_ctx->drop_flags) {
1089 ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
1090 ep_state = xhci->devs[slot_id]->eps[ep_index].ep_state;
1091 if (!(ep_state & EP_HALTED))
1092 goto bandwidth_change;
1093 xhci_dbg(xhci, "Completed config ep cmd - "
1094 "last ep index = %d, state = %d\n",
1095 ep_index, ep_state);
1096 /* Clear internal halted state and restart ring(s) */
1097 xhci->devs[slot_id]->eps[ep_index].ep_state &=
1098 ~EP_HALTED;
1099 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1100 break;
1102 bandwidth_change:
1103 xhci_dbg(xhci, "Completed config ep cmd\n");
1104 xhci->devs[slot_id]->cmd_status =
1105 GET_COMP_CODE(event->status);
1106 complete(&xhci->devs[slot_id]->cmd_completion);
1107 break;
1108 case TRB_TYPE(TRB_EVAL_CONTEXT):
1109 virt_dev = xhci->devs[slot_id];
1110 if (handle_cmd_in_cmd_wait_list(xhci, virt_dev, event))
1111 break;
1112 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(event->status);
1113 complete(&xhci->devs[slot_id]->cmd_completion);
1114 break;
1115 case TRB_TYPE(TRB_ADDR_DEV):
1116 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(event->status);
1117 complete(&xhci->addr_dev);
1118 break;
1119 case TRB_TYPE(TRB_STOP_RING):
1120 handle_stopped_endpoint(xhci, xhci->cmd_ring->dequeue, event);
1121 break;
1122 case TRB_TYPE(TRB_SET_DEQ):
1123 handle_set_deq_completion(xhci, event, xhci->cmd_ring->dequeue);
1124 break;
1125 case TRB_TYPE(TRB_CMD_NOOP):
1126 ++xhci->noops_handled;
1127 break;
1128 case TRB_TYPE(TRB_RESET_EP):
1129 handle_reset_ep_completion(xhci, event, xhci->cmd_ring->dequeue);
1130 break;
1131 case TRB_TYPE(TRB_RESET_DEV):
1132 xhci_dbg(xhci, "Completed reset device command.\n");
1133 slot_id = TRB_TO_SLOT_ID(
1134 xhci->cmd_ring->dequeue->generic.field[3]);
1135 virt_dev = xhci->devs[slot_id];
1136 if (virt_dev)
1137 handle_cmd_in_cmd_wait_list(xhci, virt_dev, event);
1138 else
1139 xhci_warn(xhci, "Reset device command completion "
1140 "for disabled slot %u\n", slot_id);
1141 break;
1142 case TRB_TYPE(TRB_NEC_GET_FW):
1143 if (!(xhci->quirks & XHCI_NEC_HOST)) {
1144 xhci->error_bitmask |= 1 << 6;
1145 break;
1147 xhci_dbg(xhci, "NEC firmware version %2x.%02x\n",
1148 NEC_FW_MAJOR(event->status),
1149 NEC_FW_MINOR(event->status));
1150 break;
1151 default:
1152 /* Skip over unknown commands on the event ring */
1153 xhci->error_bitmask |= 1 << 6;
1154 break;
1156 inc_deq(xhci, xhci->cmd_ring, false);
1159 static void handle_vendor_event(struct xhci_hcd *xhci,
1160 union xhci_trb *event)
1162 u32 trb_type;
1164 trb_type = TRB_FIELD_TO_TYPE(event->generic.field[3]);
1165 xhci_dbg(xhci, "Vendor specific event TRB type = %u\n", trb_type);
1166 if (trb_type == TRB_NEC_CMD_COMP && (xhci->quirks & XHCI_NEC_HOST))
1167 handle_cmd_completion(xhci, &event->event_cmd);
1170 static void handle_port_status(struct xhci_hcd *xhci,
1171 union xhci_trb *event)
1173 struct usb_hcd *hcd = xhci_to_hcd(xhci);
1174 u32 port_id;
1175 u32 temp, temp1;
1176 u32 __iomem *addr;
1177 int ports;
1178 int slot_id;
1180 /* Port status change events always have a successful completion code */
1181 if (GET_COMP_CODE(event->generic.field[2]) != COMP_SUCCESS) {
1182 xhci_warn(xhci, "WARN: xHC returned failed port status event\n");
1183 xhci->error_bitmask |= 1 << 8;
1185 port_id = GET_PORT_ID(event->generic.field[0]);
1186 xhci_dbg(xhci, "Port Status Change Event for port %d\n", port_id);
1188 ports = HCS_MAX_PORTS(xhci->hcs_params1);
1189 if ((port_id <= 0) || (port_id > ports)) {
1190 xhci_warn(xhci, "Invalid port id %d\n", port_id);
1191 goto cleanup;
1194 addr = &xhci->op_regs->port_status_base + NUM_PORT_REGS * (port_id - 1);
1195 temp = xhci_readl(xhci, addr);
1196 if (hcd->state == HC_STATE_SUSPENDED) {
1197 xhci_dbg(xhci, "resume root hub\n");
1198 usb_hcd_resume_root_hub(hcd);
1201 if ((temp & PORT_PLC) && (temp & PORT_PLS_MASK) == XDEV_RESUME) {
1202 xhci_dbg(xhci, "port resume event for port %d\n", port_id);
1204 temp1 = xhci_readl(xhci, &xhci->op_regs->command);
1205 if (!(temp1 & CMD_RUN)) {
1206 xhci_warn(xhci, "xHC is not running.\n");
1207 goto cleanup;
1210 if (DEV_SUPERSPEED(temp)) {
1211 xhci_dbg(xhci, "resume SS port %d\n", port_id);
1212 temp = xhci_port_state_to_neutral(temp);
1213 temp &= ~PORT_PLS_MASK;
1214 temp |= PORT_LINK_STROBE | XDEV_U0;
1215 xhci_writel(xhci, temp, addr);
1216 slot_id = xhci_find_slot_id_by_port(xhci, port_id);
1217 if (!slot_id) {
1218 xhci_dbg(xhci, "slot_id is zero\n");
1219 goto cleanup;
1221 xhci_ring_device(xhci, slot_id);
1222 xhci_dbg(xhci, "resume SS port %d finished\n", port_id);
1223 /* Clear PORT_PLC */
1224 temp = xhci_readl(xhci, addr);
1225 temp = xhci_port_state_to_neutral(temp);
1226 temp |= PORT_PLC;
1227 xhci_writel(xhci, temp, addr);
1228 } else {
1229 xhci_dbg(xhci, "resume HS port %d\n", port_id);
1230 xhci->resume_done[port_id - 1] = jiffies +
1231 msecs_to_jiffies(20);
1232 mod_timer(&hcd->rh_timer,
1233 xhci->resume_done[port_id - 1]);
1234 /* Do the rest in GetPortStatus */
1238 cleanup:
1239 /* Update event ring dequeue pointer before dropping the lock */
1240 inc_deq(xhci, xhci->event_ring, true);
1242 spin_unlock(&xhci->lock);
1243 /* Pass this up to the core */
1244 usb_hcd_poll_rh_status(xhci_to_hcd(xhci));
1245 spin_lock(&xhci->lock);
1249 * This TD is defined by the TRBs starting at start_trb in start_seg and ending
1250 * at end_trb, which may be in another segment. If the suspect DMA address is a
1251 * TRB in this TD, this function returns that TRB's segment. Otherwise it
1252 * returns 0.
1254 struct xhci_segment *trb_in_td(struct xhci_segment *start_seg,
1255 union xhci_trb *start_trb,
1256 union xhci_trb *end_trb,
1257 dma_addr_t suspect_dma)
1259 dma_addr_t start_dma;
1260 dma_addr_t end_seg_dma;
1261 dma_addr_t end_trb_dma;
1262 struct xhci_segment *cur_seg;
1264 start_dma = xhci_trb_virt_to_dma(start_seg, start_trb);
1265 cur_seg = start_seg;
1267 do {
1268 if (start_dma == 0)
1269 return NULL;
1270 /* We may get an event for a Link TRB in the middle of a TD */
1271 end_seg_dma = xhci_trb_virt_to_dma(cur_seg,
1272 &cur_seg->trbs[TRBS_PER_SEGMENT - 1]);
1273 /* If the end TRB isn't in this segment, this is set to 0 */
1274 end_trb_dma = xhci_trb_virt_to_dma(cur_seg, end_trb);
1276 if (end_trb_dma > 0) {
1277 /* The end TRB is in this segment, so suspect should be here */
1278 if (start_dma <= end_trb_dma) {
1279 if (suspect_dma >= start_dma && suspect_dma <= end_trb_dma)
1280 return cur_seg;
1281 } else {
1282 /* Case for one segment with
1283 * a TD wrapped around to the top
1285 if ((suspect_dma >= start_dma &&
1286 suspect_dma <= end_seg_dma) ||
1287 (suspect_dma >= cur_seg->dma &&
1288 suspect_dma <= end_trb_dma))
1289 return cur_seg;
1291 return NULL;
1292 } else {
1293 /* Might still be somewhere in this segment */
1294 if (suspect_dma >= start_dma && suspect_dma <= end_seg_dma)
1295 return cur_seg;
1297 cur_seg = cur_seg->next;
1298 start_dma = xhci_trb_virt_to_dma(cur_seg, &cur_seg->trbs[0]);
1299 } while (cur_seg != start_seg);
1301 return NULL;
1304 static void xhci_cleanup_halted_endpoint(struct xhci_hcd *xhci,
1305 unsigned int slot_id, unsigned int ep_index,
1306 unsigned int stream_id,
1307 struct xhci_td *td, union xhci_trb *event_trb)
1309 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
1310 ep->ep_state |= EP_HALTED;
1311 ep->stopped_td = td;
1312 ep->stopped_trb = event_trb;
1313 ep->stopped_stream = stream_id;
1315 xhci_queue_reset_ep(xhci, slot_id, ep_index);
1316 xhci_cleanup_stalled_ring(xhci, td->urb->dev, ep_index);
1318 ep->stopped_td = NULL;
1319 ep->stopped_trb = NULL;
1320 ep->stopped_stream = 0;
1322 xhci_ring_cmd_db(xhci);
1325 /* Check if an error has halted the endpoint ring. The class driver will
1326 * cleanup the halt for a non-default control endpoint if we indicate a stall.
1327 * However, a babble and other errors also halt the endpoint ring, and the class
1328 * driver won't clear the halt in that case, so we need to issue a Set Transfer
1329 * Ring Dequeue Pointer command manually.
1331 static int xhci_requires_manual_halt_cleanup(struct xhci_hcd *xhci,
1332 struct xhci_ep_ctx *ep_ctx,
1333 unsigned int trb_comp_code)
1335 /* TRB completion codes that may require a manual halt cleanup */
1336 if (trb_comp_code == COMP_TX_ERR ||
1337 trb_comp_code == COMP_BABBLE ||
1338 trb_comp_code == COMP_SPLIT_ERR)
1339 /* The 0.96 spec says a babbling control endpoint
1340 * is not halted. The 0.96 spec says it is. Some HW
1341 * claims to be 0.95 compliant, but it halts the control
1342 * endpoint anyway. Check if a babble halted the
1343 * endpoint.
1345 if ((ep_ctx->ep_info & EP_STATE_MASK) == EP_STATE_HALTED)
1346 return 1;
1348 return 0;
1351 int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code)
1353 if (trb_comp_code >= 224 && trb_comp_code <= 255) {
1354 /* Vendor defined "informational" completion code,
1355 * treat as not-an-error.
1357 xhci_dbg(xhci, "Vendor defined info completion code %u\n",
1358 trb_comp_code);
1359 xhci_dbg(xhci, "Treating code as success.\n");
1360 return 1;
1362 return 0;
1366 * Finish the td processing, remove the td from td list;
1367 * Return 1 if the urb can be given back.
1369 static int finish_td(struct xhci_hcd *xhci, struct xhci_td *td,
1370 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1371 struct xhci_virt_ep *ep, int *status, bool skip)
1373 struct xhci_virt_device *xdev;
1374 struct xhci_ring *ep_ring;
1375 unsigned int slot_id;
1376 int ep_index;
1377 struct urb *urb = NULL;
1378 struct xhci_ep_ctx *ep_ctx;
1379 int ret = 0;
1380 struct urb_priv *urb_priv;
1381 u32 trb_comp_code;
1383 slot_id = TRB_TO_SLOT_ID(event->flags);
1384 xdev = xhci->devs[slot_id];
1385 ep_index = TRB_TO_EP_ID(event->flags) - 1;
1386 ep_ring = xhci_dma_to_transfer_ring(ep, event->buffer);
1387 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1388 trb_comp_code = GET_COMP_CODE(event->transfer_len);
1390 if (skip)
1391 goto td_cleanup;
1393 if (trb_comp_code == COMP_STOP_INVAL ||
1394 trb_comp_code == COMP_STOP) {
1395 /* The Endpoint Stop Command completion will take care of any
1396 * stopped TDs. A stopped TD may be restarted, so don't update
1397 * the ring dequeue pointer or take this TD off any lists yet.
1399 ep->stopped_td = td;
1400 ep->stopped_trb = event_trb;
1401 return 0;
1402 } else {
1403 if (trb_comp_code == COMP_STALL) {
1404 /* The transfer is completed from the driver's
1405 * perspective, but we need to issue a set dequeue
1406 * command for this stalled endpoint to move the dequeue
1407 * pointer past the TD. We can't do that here because
1408 * the halt condition must be cleared first. Let the
1409 * USB class driver clear the stall later.
1411 ep->stopped_td = td;
1412 ep->stopped_trb = event_trb;
1413 ep->stopped_stream = ep_ring->stream_id;
1414 } else if (xhci_requires_manual_halt_cleanup(xhci,
1415 ep_ctx, trb_comp_code)) {
1416 /* Other types of errors halt the endpoint, but the
1417 * class driver doesn't call usb_reset_endpoint() unless
1418 * the error is -EPIPE. Clear the halted status in the
1419 * xHCI hardware manually.
1421 xhci_cleanup_halted_endpoint(xhci,
1422 slot_id, ep_index, ep_ring->stream_id,
1423 td, event_trb);
1424 } else {
1425 /* Update ring dequeue pointer */
1426 while (ep_ring->dequeue != td->last_trb)
1427 inc_deq(xhci, ep_ring, false);
1428 inc_deq(xhci, ep_ring, false);
1431 td_cleanup:
1432 /* Clean up the endpoint's TD list */
1433 urb = td->urb;
1434 urb_priv = urb->hcpriv;
1436 /* Do one last check of the actual transfer length.
1437 * If the host controller said we transferred more data than
1438 * the buffer length, urb->actual_length will be a very big
1439 * number (since it's unsigned). Play it safe and say we didn't
1440 * transfer anything.
1442 if (urb->actual_length > urb->transfer_buffer_length) {
1443 xhci_warn(xhci, "URB transfer length is wrong, "
1444 "xHC issue? req. len = %u, "
1445 "act. len = %u\n",
1446 urb->transfer_buffer_length,
1447 urb->actual_length);
1448 urb->actual_length = 0;
1449 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1450 *status = -EREMOTEIO;
1451 else
1452 *status = 0;
1454 list_del(&td->td_list);
1455 /* Was this TD slated to be cancelled but completed anyway? */
1456 if (!list_empty(&td->cancelled_td_list))
1457 list_del(&td->cancelled_td_list);
1459 urb_priv->td_cnt++;
1460 /* Giveback the urb when all the tds are completed */
1461 if (urb_priv->td_cnt == urb_priv->length)
1462 ret = 1;
1465 return ret;
1469 * Process control tds, update urb status and actual_length.
1471 static int process_ctrl_td(struct xhci_hcd *xhci, struct xhci_td *td,
1472 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1473 struct xhci_virt_ep *ep, int *status)
1475 struct xhci_virt_device *xdev;
1476 struct xhci_ring *ep_ring;
1477 unsigned int slot_id;
1478 int ep_index;
1479 struct xhci_ep_ctx *ep_ctx;
1480 u32 trb_comp_code;
1482 slot_id = TRB_TO_SLOT_ID(event->flags);
1483 xdev = xhci->devs[slot_id];
1484 ep_index = TRB_TO_EP_ID(event->flags) - 1;
1485 ep_ring = xhci_dma_to_transfer_ring(ep, event->buffer);
1486 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1487 trb_comp_code = GET_COMP_CODE(event->transfer_len);
1489 xhci_debug_trb(xhci, xhci->event_ring->dequeue);
1490 switch (trb_comp_code) {
1491 case COMP_SUCCESS:
1492 if (event_trb == ep_ring->dequeue) {
1493 xhci_warn(xhci, "WARN: Success on ctrl setup TRB "
1494 "without IOC set??\n");
1495 *status = -ESHUTDOWN;
1496 } else if (event_trb != td->last_trb) {
1497 xhci_warn(xhci, "WARN: Success on ctrl data TRB "
1498 "without IOC set??\n");
1499 *status = -ESHUTDOWN;
1500 } else {
1501 xhci_dbg(xhci, "Successful control transfer!\n");
1502 *status = 0;
1504 break;
1505 case COMP_SHORT_TX:
1506 xhci_warn(xhci, "WARN: short transfer on control ep\n");
1507 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1508 *status = -EREMOTEIO;
1509 else
1510 *status = 0;
1511 break;
1512 default:
1513 if (!xhci_requires_manual_halt_cleanup(xhci,
1514 ep_ctx, trb_comp_code))
1515 break;
1516 xhci_dbg(xhci, "TRB error code %u, "
1517 "halted endpoint index = %u\n",
1518 trb_comp_code, ep_index);
1519 /* else fall through */
1520 case COMP_STALL:
1521 /* Did we transfer part of the data (middle) phase? */
1522 if (event_trb != ep_ring->dequeue &&
1523 event_trb != td->last_trb)
1524 td->urb->actual_length =
1525 td->urb->transfer_buffer_length
1526 - TRB_LEN(event->transfer_len);
1527 else
1528 td->urb->actual_length = 0;
1530 xhci_cleanup_halted_endpoint(xhci,
1531 slot_id, ep_index, 0, td, event_trb);
1532 return finish_td(xhci, td, event_trb, event, ep, status, true);
1535 * Did we transfer any data, despite the errors that might have
1536 * happened? I.e. did we get past the setup stage?
1538 if (event_trb != ep_ring->dequeue) {
1539 /* The event was for the status stage */
1540 if (event_trb == td->last_trb) {
1541 if (td->urb->actual_length != 0) {
1542 /* Don't overwrite a previously set error code
1544 if ((*status == -EINPROGRESS || *status == 0) &&
1545 (td->urb->transfer_flags
1546 & URB_SHORT_NOT_OK))
1547 /* Did we already see a short data
1548 * stage? */
1549 *status = -EREMOTEIO;
1550 } else {
1551 td->urb->actual_length =
1552 td->urb->transfer_buffer_length;
1554 } else {
1555 /* Maybe the event was for the data stage? */
1556 if (trb_comp_code != COMP_STOP_INVAL) {
1557 /* We didn't stop on a link TRB in the middle */
1558 td->urb->actual_length =
1559 td->urb->transfer_buffer_length -
1560 TRB_LEN(event->transfer_len);
1561 xhci_dbg(xhci, "Waiting for status "
1562 "stage event\n");
1563 return 0;
1568 return finish_td(xhci, td, event_trb, event, ep, status, false);
1572 * Process isochronous tds, update urb packet status and actual_length.
1574 static int process_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
1575 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1576 struct xhci_virt_ep *ep, int *status)
1578 struct xhci_ring *ep_ring;
1579 struct urb_priv *urb_priv;
1580 int idx;
1581 int len = 0;
1582 int skip_td = 0;
1583 union xhci_trb *cur_trb;
1584 struct xhci_segment *cur_seg;
1585 u32 trb_comp_code;
1587 ep_ring = xhci_dma_to_transfer_ring(ep, event->buffer);
1588 trb_comp_code = GET_COMP_CODE(event->transfer_len);
1589 urb_priv = td->urb->hcpriv;
1590 idx = urb_priv->td_cnt;
1592 if (ep->skip) {
1593 /* The transfer is partly done */
1594 *status = -EXDEV;
1595 td->urb->iso_frame_desc[idx].status = -EXDEV;
1596 } else {
1597 /* handle completion code */
1598 switch (trb_comp_code) {
1599 case COMP_SUCCESS:
1600 td->urb->iso_frame_desc[idx].status = 0;
1601 xhci_dbg(xhci, "Successful isoc transfer!\n");
1602 break;
1603 case COMP_SHORT_TX:
1604 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1605 td->urb->iso_frame_desc[idx].status =
1606 -EREMOTEIO;
1607 else
1608 td->urb->iso_frame_desc[idx].status = 0;
1609 break;
1610 case COMP_BW_OVER:
1611 td->urb->iso_frame_desc[idx].status = -ECOMM;
1612 skip_td = 1;
1613 break;
1614 case COMP_BUFF_OVER:
1615 case COMP_BABBLE:
1616 td->urb->iso_frame_desc[idx].status = -EOVERFLOW;
1617 skip_td = 1;
1618 break;
1619 case COMP_STALL:
1620 td->urb->iso_frame_desc[idx].status = -EPROTO;
1621 skip_td = 1;
1622 break;
1623 case COMP_STOP:
1624 case COMP_STOP_INVAL:
1625 break;
1626 default:
1627 td->urb->iso_frame_desc[idx].status = -1;
1628 break;
1632 /* calc actual length */
1633 if (ep->skip) {
1634 td->urb->iso_frame_desc[idx].actual_length = 0;
1635 /* Update ring dequeue pointer */
1636 while (ep_ring->dequeue != td->last_trb)
1637 inc_deq(xhci, ep_ring, false);
1638 inc_deq(xhci, ep_ring, false);
1639 return finish_td(xhci, td, event_trb, event, ep, status, true);
1642 if (trb_comp_code == COMP_SUCCESS || skip_td == 1) {
1643 td->urb->iso_frame_desc[idx].actual_length =
1644 td->urb->iso_frame_desc[idx].length;
1645 td->urb->actual_length +=
1646 td->urb->iso_frame_desc[idx].length;
1647 } else {
1648 for (cur_trb = ep_ring->dequeue,
1649 cur_seg = ep_ring->deq_seg; cur_trb != event_trb;
1650 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
1651 if ((cur_trb->generic.field[3] &
1652 TRB_TYPE_BITMASK) != TRB_TYPE(TRB_TR_NOOP) &&
1653 (cur_trb->generic.field[3] &
1654 TRB_TYPE_BITMASK) != TRB_TYPE(TRB_LINK))
1655 len +=
1656 TRB_LEN(cur_trb->generic.field[2]);
1658 len += TRB_LEN(cur_trb->generic.field[2]) -
1659 TRB_LEN(event->transfer_len);
1661 if (trb_comp_code != COMP_STOP_INVAL) {
1662 td->urb->iso_frame_desc[idx].actual_length = len;
1663 td->urb->actual_length += len;
1667 if ((idx == urb_priv->length - 1) && *status == -EINPROGRESS)
1668 *status = 0;
1670 return finish_td(xhci, td, event_trb, event, ep, status, false);
1674 * Process bulk and interrupt tds, update urb status and actual_length.
1676 static int process_bulk_intr_td(struct xhci_hcd *xhci, struct xhci_td *td,
1677 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1678 struct xhci_virt_ep *ep, int *status)
1680 struct xhci_ring *ep_ring;
1681 union xhci_trb *cur_trb;
1682 struct xhci_segment *cur_seg;
1683 u32 trb_comp_code;
1685 ep_ring = xhci_dma_to_transfer_ring(ep, event->buffer);
1686 trb_comp_code = GET_COMP_CODE(event->transfer_len);
1688 switch (trb_comp_code) {
1689 case COMP_SUCCESS:
1690 /* Double check that the HW transferred everything. */
1691 if (event_trb != td->last_trb) {
1692 xhci_warn(xhci, "WARN Successful completion "
1693 "on short TX\n");
1694 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1695 *status = -EREMOTEIO;
1696 else
1697 *status = 0;
1698 } else {
1699 if (usb_endpoint_xfer_bulk(&td->urb->ep->desc))
1700 xhci_dbg(xhci, "Successful bulk "
1701 "transfer!\n");
1702 else
1703 xhci_dbg(xhci, "Successful interrupt "
1704 "transfer!\n");
1705 *status = 0;
1707 break;
1708 case COMP_SHORT_TX:
1709 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1710 *status = -EREMOTEIO;
1711 else
1712 *status = 0;
1713 break;
1714 default:
1715 /* Others already handled above */
1716 break;
1718 dev_dbg(&td->urb->dev->dev,
1719 "ep %#x - asked for %d bytes, "
1720 "%d bytes untransferred\n",
1721 td->urb->ep->desc.bEndpointAddress,
1722 td->urb->transfer_buffer_length,
1723 TRB_LEN(event->transfer_len));
1724 /* Fast path - was this the last TRB in the TD for this URB? */
1725 if (event_trb == td->last_trb) {
1726 if (TRB_LEN(event->transfer_len) != 0) {
1727 td->urb->actual_length =
1728 td->urb->transfer_buffer_length -
1729 TRB_LEN(event->transfer_len);
1730 if (td->urb->transfer_buffer_length <
1731 td->urb->actual_length) {
1732 xhci_warn(xhci, "HC gave bad length "
1733 "of %d bytes left\n",
1734 TRB_LEN(event->transfer_len));
1735 td->urb->actual_length = 0;
1736 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1737 *status = -EREMOTEIO;
1738 else
1739 *status = 0;
1741 /* Don't overwrite a previously set error code */
1742 if (*status == -EINPROGRESS) {
1743 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1744 *status = -EREMOTEIO;
1745 else
1746 *status = 0;
1748 } else {
1749 td->urb->actual_length =
1750 td->urb->transfer_buffer_length;
1751 /* Ignore a short packet completion if the
1752 * untransferred length was zero.
1754 if (*status == -EREMOTEIO)
1755 *status = 0;
1757 } else {
1758 /* Slow path - walk the list, starting from the dequeue
1759 * pointer, to get the actual length transferred.
1761 td->urb->actual_length = 0;
1762 for (cur_trb = ep_ring->dequeue, cur_seg = ep_ring->deq_seg;
1763 cur_trb != event_trb;
1764 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
1765 if ((cur_trb->generic.field[3] &
1766 TRB_TYPE_BITMASK) != TRB_TYPE(TRB_TR_NOOP) &&
1767 (cur_trb->generic.field[3] &
1768 TRB_TYPE_BITMASK) != TRB_TYPE(TRB_LINK))
1769 td->urb->actual_length +=
1770 TRB_LEN(cur_trb->generic.field[2]);
1772 /* If the ring didn't stop on a Link or No-op TRB, add
1773 * in the actual bytes transferred from the Normal TRB
1775 if (trb_comp_code != COMP_STOP_INVAL)
1776 td->urb->actual_length +=
1777 TRB_LEN(cur_trb->generic.field[2]) -
1778 TRB_LEN(event->transfer_len);
1781 return finish_td(xhci, td, event_trb, event, ep, status, false);
1785 * If this function returns an error condition, it means it got a Transfer
1786 * event with a corrupted Slot ID, Endpoint ID, or TRB DMA address.
1787 * At this point, the host controller is probably hosed and should be reset.
1789 static int handle_tx_event(struct xhci_hcd *xhci,
1790 struct xhci_transfer_event *event)
1792 struct xhci_virt_device *xdev;
1793 struct xhci_virt_ep *ep;
1794 struct xhci_ring *ep_ring;
1795 unsigned int slot_id;
1796 int ep_index;
1797 struct xhci_td *td = NULL;
1798 dma_addr_t event_dma;
1799 struct xhci_segment *event_seg;
1800 union xhci_trb *event_trb;
1801 struct urb *urb = NULL;
1802 int status = -EINPROGRESS;
1803 struct urb_priv *urb_priv;
1804 struct xhci_ep_ctx *ep_ctx;
1805 u32 trb_comp_code;
1806 int ret = 0;
1808 slot_id = TRB_TO_SLOT_ID(event->flags);
1809 xdev = xhci->devs[slot_id];
1810 if (!xdev) {
1811 xhci_err(xhci, "ERROR Transfer event pointed to bad slot\n");
1812 return -ENODEV;
1815 /* Endpoint ID is 1 based, our index is zero based */
1816 ep_index = TRB_TO_EP_ID(event->flags) - 1;
1817 xhci_dbg(xhci, "%s - ep index = %d\n", __func__, ep_index);
1818 ep = &xdev->eps[ep_index];
1819 ep_ring = xhci_dma_to_transfer_ring(ep, event->buffer);
1820 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1821 if (!ep_ring ||
1822 (ep_ctx->ep_info & EP_STATE_MASK) == EP_STATE_DISABLED) {
1823 xhci_err(xhci, "ERROR Transfer event for disabled endpoint "
1824 "or incorrect stream ring\n");
1825 return -ENODEV;
1828 event_dma = event->buffer;
1829 trb_comp_code = GET_COMP_CODE(event->transfer_len);
1830 /* Look for common error cases */
1831 switch (trb_comp_code) {
1832 /* Skip codes that require special handling depending on
1833 * transfer type
1835 case COMP_SUCCESS:
1836 case COMP_SHORT_TX:
1837 break;
1838 case COMP_STOP:
1839 xhci_dbg(xhci, "Stopped on Transfer TRB\n");
1840 break;
1841 case COMP_STOP_INVAL:
1842 xhci_dbg(xhci, "Stopped on No-op or Link TRB\n");
1843 break;
1844 case COMP_STALL:
1845 xhci_warn(xhci, "WARN: Stalled endpoint\n");
1846 ep->ep_state |= EP_HALTED;
1847 status = -EPIPE;
1848 break;
1849 case COMP_TRB_ERR:
1850 xhci_warn(xhci, "WARN: TRB error on endpoint\n");
1851 status = -EILSEQ;
1852 break;
1853 case COMP_SPLIT_ERR:
1854 case COMP_TX_ERR:
1855 xhci_warn(xhci, "WARN: transfer error on endpoint\n");
1856 status = -EPROTO;
1857 break;
1858 case COMP_BABBLE:
1859 xhci_warn(xhci, "WARN: babble error on endpoint\n");
1860 status = -EOVERFLOW;
1861 break;
1862 case COMP_DB_ERR:
1863 xhci_warn(xhci, "WARN: HC couldn't access mem fast enough\n");
1864 status = -ENOSR;
1865 break;
1866 case COMP_BW_OVER:
1867 xhci_warn(xhci, "WARN: bandwidth overrun event on endpoint\n");
1868 break;
1869 case COMP_BUFF_OVER:
1870 xhci_warn(xhci, "WARN: buffer overrun event on endpoint\n");
1871 break;
1872 case COMP_UNDERRUN:
1874 * When the Isoch ring is empty, the xHC will generate
1875 * a Ring Overrun Event for IN Isoch endpoint or Ring
1876 * Underrun Event for OUT Isoch endpoint.
1878 xhci_dbg(xhci, "underrun event on endpoint\n");
1879 if (!list_empty(&ep_ring->td_list))
1880 xhci_dbg(xhci, "Underrun Event for slot %d ep %d "
1881 "still with TDs queued?\n",
1882 TRB_TO_SLOT_ID(event->flags), ep_index);
1883 goto cleanup;
1884 case COMP_OVERRUN:
1885 xhci_dbg(xhci, "overrun event on endpoint\n");
1886 if (!list_empty(&ep_ring->td_list))
1887 xhci_dbg(xhci, "Overrun Event for slot %d ep %d "
1888 "still with TDs queued?\n",
1889 TRB_TO_SLOT_ID(event->flags), ep_index);
1890 goto cleanup;
1891 case COMP_MISSED_INT:
1893 * When encounter missed service error, one or more isoc tds
1894 * may be missed by xHC.
1895 * Set skip flag of the ep_ring; Complete the missed tds as
1896 * short transfer when process the ep_ring next time.
1898 ep->skip = true;
1899 xhci_dbg(xhci, "Miss service interval error, set skip flag\n");
1900 goto cleanup;
1901 default:
1902 if (xhci_is_vendor_info_code(xhci, trb_comp_code)) {
1903 status = 0;
1904 break;
1906 xhci_warn(xhci, "ERROR Unknown event condition, HC probably "
1907 "busted\n");
1908 goto cleanup;
1911 do {
1912 /* This TRB should be in the TD at the head of this ring's
1913 * TD list.
1915 if (list_empty(&ep_ring->td_list)) {
1916 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d "
1917 "with no TDs queued?\n",
1918 TRB_TO_SLOT_ID(event->flags), ep_index);
1919 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n",
1920 (unsigned int) (event->flags & TRB_TYPE_BITMASK)>>10);
1921 xhci_print_trb_offsets(xhci, (union xhci_trb *) event);
1922 if (ep->skip) {
1923 ep->skip = false;
1924 xhci_dbg(xhci, "td_list is empty while skip "
1925 "flag set. Clear skip flag.\n");
1927 ret = 0;
1928 goto cleanup;
1931 td = list_entry(ep_ring->td_list.next, struct xhci_td, td_list);
1932 /* Is this a TRB in the currently executing TD? */
1933 event_seg = trb_in_td(ep_ring->deq_seg, ep_ring->dequeue,
1934 td->last_trb, event_dma);
1935 if (event_seg && ep->skip) {
1936 xhci_dbg(xhci, "Found td. Clear skip flag.\n");
1937 ep->skip = false;
1939 if (!event_seg &&
1940 (!ep->skip || !usb_endpoint_xfer_isoc(&td->urb->ep->desc))) {
1941 /* HC is busted, give up! */
1942 xhci_err(xhci, "ERROR Transfer event TRB DMA ptr not "
1943 "part of current TD\n");
1944 return -ESHUTDOWN;
1947 if (event_seg) {
1948 event_trb = &event_seg->trbs[(event_dma -
1949 event_seg->dma) / sizeof(*event_trb)];
1951 * No-op TRB should not trigger interrupts.
1952 * If event_trb is a no-op TRB, it means the
1953 * corresponding TD has been cancelled. Just ignore
1954 * the TD.
1956 if ((event_trb->generic.field[3] & TRB_TYPE_BITMASK)
1957 == TRB_TYPE(TRB_TR_NOOP)) {
1958 xhci_dbg(xhci, "event_trb is a no-op TRB. "
1959 "Skip it\n");
1960 goto cleanup;
1964 /* Now update the urb's actual_length and give back to
1965 * the core
1967 if (usb_endpoint_xfer_control(&td->urb->ep->desc))
1968 ret = process_ctrl_td(xhci, td, event_trb, event, ep,
1969 &status);
1970 else if (usb_endpoint_xfer_isoc(&td->urb->ep->desc))
1971 ret = process_isoc_td(xhci, td, event_trb, event, ep,
1972 &status);
1973 else
1974 ret = process_bulk_intr_td(xhci, td, event_trb, event,
1975 ep, &status);
1977 cleanup:
1979 * Do not update event ring dequeue pointer if ep->skip is set.
1980 * Will roll back to continue process missed tds.
1982 if (trb_comp_code == COMP_MISSED_INT || !ep->skip) {
1983 inc_deq(xhci, xhci->event_ring, true);
1986 if (ret) {
1987 urb = td->urb;
1988 urb_priv = urb->hcpriv;
1989 /* Leave the TD around for the reset endpoint function
1990 * to use(but only if it's not a control endpoint,
1991 * since we already queued the Set TR dequeue pointer
1992 * command for stalled control endpoints).
1994 if (usb_endpoint_xfer_control(&urb->ep->desc) ||
1995 (trb_comp_code != COMP_STALL &&
1996 trb_comp_code != COMP_BABBLE))
1997 xhci_urb_free_priv(xhci, urb_priv);
1999 usb_hcd_unlink_urb_from_ep(xhci_to_hcd(xhci), urb);
2000 xhci_dbg(xhci, "Giveback URB %p, len = %d, "
2001 "status = %d\n",
2002 urb, urb->actual_length, status);
2003 spin_unlock(&xhci->lock);
2004 usb_hcd_giveback_urb(xhci_to_hcd(xhci), urb, status);
2005 spin_lock(&xhci->lock);
2009 * If ep->skip is set, it means there are missed tds on the
2010 * endpoint ring need to take care of.
2011 * Process them as short transfer until reach the td pointed by
2012 * the event.
2014 } while (ep->skip && trb_comp_code != COMP_MISSED_INT);
2016 return 0;
2020 * This function handles all OS-owned events on the event ring. It may drop
2021 * xhci->lock between event processing (e.g. to pass up port status changes).
2023 static void xhci_handle_event(struct xhci_hcd *xhci)
2025 union xhci_trb *event;
2026 int update_ptrs = 1;
2027 int ret;
2029 xhci_dbg(xhci, "In %s\n", __func__);
2030 if (!xhci->event_ring || !xhci->event_ring->dequeue) {
2031 xhci->error_bitmask |= 1 << 1;
2032 return;
2035 event = xhci->event_ring->dequeue;
2036 /* Does the HC or OS own the TRB? */
2037 if ((event->event_cmd.flags & TRB_CYCLE) !=
2038 xhci->event_ring->cycle_state) {
2039 xhci->error_bitmask |= 1 << 2;
2040 return;
2042 xhci_dbg(xhci, "%s - OS owns TRB\n", __func__);
2044 /* FIXME: Handle more event types. */
2045 switch ((event->event_cmd.flags & TRB_TYPE_BITMASK)) {
2046 case TRB_TYPE(TRB_COMPLETION):
2047 xhci_dbg(xhci, "%s - calling handle_cmd_completion\n", __func__);
2048 handle_cmd_completion(xhci, &event->event_cmd);
2049 xhci_dbg(xhci, "%s - returned from handle_cmd_completion\n", __func__);
2050 break;
2051 case TRB_TYPE(TRB_PORT_STATUS):
2052 xhci_dbg(xhci, "%s - calling handle_port_status\n", __func__);
2053 handle_port_status(xhci, event);
2054 xhci_dbg(xhci, "%s - returned from handle_port_status\n", __func__);
2055 update_ptrs = 0;
2056 break;
2057 case TRB_TYPE(TRB_TRANSFER):
2058 xhci_dbg(xhci, "%s - calling handle_tx_event\n", __func__);
2059 ret = handle_tx_event(xhci, &event->trans_event);
2060 xhci_dbg(xhci, "%s - returned from handle_tx_event\n", __func__);
2061 if (ret < 0)
2062 xhci->error_bitmask |= 1 << 9;
2063 else
2064 update_ptrs = 0;
2065 break;
2066 default:
2067 if ((event->event_cmd.flags & TRB_TYPE_BITMASK) >= TRB_TYPE(48))
2068 handle_vendor_event(xhci, event);
2069 else
2070 xhci->error_bitmask |= 1 << 3;
2072 /* Any of the above functions may drop and re-acquire the lock, so check
2073 * to make sure a watchdog timer didn't mark the host as non-responsive.
2075 if (xhci->xhc_state & XHCI_STATE_DYING) {
2076 xhci_dbg(xhci, "xHCI host dying, returning from "
2077 "event handler.\n");
2078 return;
2081 if (update_ptrs)
2082 /* Update SW event ring dequeue pointer */
2083 inc_deq(xhci, xhci->event_ring, true);
2085 /* Are there more items on the event ring? */
2086 xhci_handle_event(xhci);
2090 * xHCI spec says we can get an interrupt, and if the HC has an error condition,
2091 * we might get bad data out of the event ring. Section 4.10.2.7 has a list of
2092 * indicators of an event TRB error, but we check the status *first* to be safe.
2094 irqreturn_t xhci_irq(struct usb_hcd *hcd)
2096 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
2097 u32 status;
2098 union xhci_trb *trb;
2099 u64 temp_64;
2100 union xhci_trb *event_ring_deq;
2101 dma_addr_t deq;
2103 spin_lock(&xhci->lock);
2104 trb = xhci->event_ring->dequeue;
2105 /* Check if the xHC generated the interrupt, or the irq is shared */
2106 status = xhci_readl(xhci, &xhci->op_regs->status);
2107 if (status == 0xffffffff)
2108 goto hw_died;
2110 if (!(status & STS_EINT)) {
2111 spin_unlock(&xhci->lock);
2112 return IRQ_NONE;
2114 xhci_dbg(xhci, "op reg status = %08x\n", status);
2115 xhci_dbg(xhci, "Event ring dequeue ptr:\n");
2116 xhci_dbg(xhci, "@%llx %08x %08x %08x %08x\n",
2117 (unsigned long long)
2118 xhci_trb_virt_to_dma(xhci->event_ring->deq_seg, trb),
2119 lower_32_bits(trb->link.segment_ptr),
2120 upper_32_bits(trb->link.segment_ptr),
2121 (unsigned int) trb->link.intr_target,
2122 (unsigned int) trb->link.control);
2124 if (status & STS_FATAL) {
2125 xhci_warn(xhci, "WARNING: Host System Error\n");
2126 xhci_halt(xhci);
2127 hw_died:
2128 xhci_to_hcd(xhci)->state = HC_STATE_HALT;
2129 spin_unlock(&xhci->lock);
2130 return -ESHUTDOWN;
2134 * Clear the op reg interrupt status first,
2135 * so we can receive interrupts from other MSI-X interrupters.
2136 * Write 1 to clear the interrupt status.
2138 status |= STS_EINT;
2139 xhci_writel(xhci, status, &xhci->op_regs->status);
2140 /* FIXME when MSI-X is supported and there are multiple vectors */
2141 /* Clear the MSI-X event interrupt status */
2143 if (hcd->irq != -1) {
2144 u32 irq_pending;
2145 /* Acknowledge the PCI interrupt */
2146 irq_pending = xhci_readl(xhci, &xhci->ir_set->irq_pending);
2147 irq_pending |= 0x3;
2148 xhci_writel(xhci, irq_pending, &xhci->ir_set->irq_pending);
2151 if (xhci->xhc_state & XHCI_STATE_DYING) {
2152 xhci_dbg(xhci, "xHCI dying, ignoring interrupt. "
2153 "Shouldn't IRQs be disabled?\n");
2154 /* Clear the event handler busy flag (RW1C);
2155 * the event ring should be empty.
2157 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
2158 xhci_write_64(xhci, temp_64 | ERST_EHB,
2159 &xhci->ir_set->erst_dequeue);
2160 spin_unlock(&xhci->lock);
2162 return IRQ_HANDLED;
2165 event_ring_deq = xhci->event_ring->dequeue;
2166 /* FIXME this should be a delayed service routine
2167 * that clears the EHB.
2169 xhci_handle_event(xhci);
2171 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
2172 /* If necessary, update the HW's version of the event ring deq ptr. */
2173 if (event_ring_deq != xhci->event_ring->dequeue) {
2174 deq = xhci_trb_virt_to_dma(xhci->event_ring->deq_seg,
2175 xhci->event_ring->dequeue);
2176 if (deq == 0)
2177 xhci_warn(xhci, "WARN something wrong with SW event "
2178 "ring dequeue ptr.\n");
2179 /* Update HC event ring dequeue pointer */
2180 temp_64 &= ERST_PTR_MASK;
2181 temp_64 |= ((u64) deq & (u64) ~ERST_PTR_MASK);
2184 /* Clear the event handler busy flag (RW1C); event ring is empty. */
2185 temp_64 |= ERST_EHB;
2186 xhci_write_64(xhci, temp_64, &xhci->ir_set->erst_dequeue);
2188 spin_unlock(&xhci->lock);
2190 return IRQ_HANDLED;
2193 irqreturn_t xhci_msi_irq(int irq, struct usb_hcd *hcd)
2195 irqreturn_t ret;
2197 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
2199 ret = xhci_irq(hcd);
2201 return ret;
2204 /**** Endpoint Ring Operations ****/
2207 * Generic function for queueing a TRB on a ring.
2208 * The caller must have checked to make sure there's room on the ring.
2210 * @more_trbs_coming: Will you enqueue more TRBs before calling
2211 * prepare_transfer()?
2213 static void queue_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
2214 bool consumer, bool more_trbs_coming,
2215 u32 field1, u32 field2, u32 field3, u32 field4)
2217 struct xhci_generic_trb *trb;
2219 trb = &ring->enqueue->generic;
2220 trb->field[0] = field1;
2221 trb->field[1] = field2;
2222 trb->field[2] = field3;
2223 trb->field[3] = field4;
2224 inc_enq(xhci, ring, consumer, more_trbs_coming);
2228 * Does various checks on the endpoint ring, and makes it ready to queue num_trbs.
2229 * FIXME allocate segments if the ring is full.
2231 static int prepare_ring(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
2232 u32 ep_state, unsigned int num_trbs, gfp_t mem_flags)
2234 /* Make sure the endpoint has been added to xHC schedule */
2235 xhci_dbg(xhci, "Endpoint state = 0x%x\n", ep_state);
2236 switch (ep_state) {
2237 case EP_STATE_DISABLED:
2239 * USB core changed config/interfaces without notifying us,
2240 * or hardware is reporting the wrong state.
2242 xhci_warn(xhci, "WARN urb submitted to disabled ep\n");
2243 return -ENOENT;
2244 case EP_STATE_ERROR:
2245 xhci_warn(xhci, "WARN waiting for error on ep to be cleared\n");
2246 /* FIXME event handling code for error needs to clear it */
2247 /* XXX not sure if this should be -ENOENT or not */
2248 return -EINVAL;
2249 case EP_STATE_HALTED:
2250 xhci_dbg(xhci, "WARN halted endpoint, queueing URB anyway.\n");
2251 case EP_STATE_STOPPED:
2252 case EP_STATE_RUNNING:
2253 break;
2254 default:
2255 xhci_err(xhci, "ERROR unknown endpoint state for ep\n");
2257 * FIXME issue Configure Endpoint command to try to get the HC
2258 * back into a known state.
2260 return -EINVAL;
2262 if (!room_on_ring(xhci, ep_ring, num_trbs)) {
2263 /* FIXME allocate more room */
2264 xhci_err(xhci, "ERROR no room on ep ring\n");
2265 return -ENOMEM;
2268 if (enqueue_is_link_trb(ep_ring)) {
2269 struct xhci_ring *ring = ep_ring;
2270 union xhci_trb *next;
2272 xhci_dbg(xhci, "prepare_ring: pointing to link trb\n");
2273 next = ring->enqueue;
2275 while (last_trb(xhci, ring, ring->enq_seg, next)) {
2277 /* If we're not dealing with 0.95 hardware,
2278 * clear the chain bit.
2280 if (!xhci_link_trb_quirk(xhci))
2281 next->link.control &= ~TRB_CHAIN;
2282 else
2283 next->link.control |= TRB_CHAIN;
2285 wmb();
2286 next->link.control ^= (u32) TRB_CYCLE;
2288 /* Toggle the cycle bit after the last ring segment. */
2289 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
2290 ring->cycle_state = (ring->cycle_state ? 0 : 1);
2291 if (!in_interrupt()) {
2292 xhci_dbg(xhci, "queue_trb: Toggle cycle "
2293 "state for ring %p = %i\n",
2294 ring, (unsigned int)ring->cycle_state);
2297 ring->enq_seg = ring->enq_seg->next;
2298 ring->enqueue = ring->enq_seg->trbs;
2299 next = ring->enqueue;
2303 return 0;
2306 static int prepare_transfer(struct xhci_hcd *xhci,
2307 struct xhci_virt_device *xdev,
2308 unsigned int ep_index,
2309 unsigned int stream_id,
2310 unsigned int num_trbs,
2311 struct urb *urb,
2312 unsigned int td_index,
2313 gfp_t mem_flags)
2315 int ret;
2316 struct urb_priv *urb_priv;
2317 struct xhci_td *td;
2318 struct xhci_ring *ep_ring;
2319 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
2321 ep_ring = xhci_stream_id_to_ring(xdev, ep_index, stream_id);
2322 if (!ep_ring) {
2323 xhci_dbg(xhci, "Can't prepare ring for bad stream ID %u\n",
2324 stream_id);
2325 return -EINVAL;
2328 ret = prepare_ring(xhci, ep_ring,
2329 ep_ctx->ep_info & EP_STATE_MASK,
2330 num_trbs, mem_flags);
2331 if (ret)
2332 return ret;
2334 urb_priv = urb->hcpriv;
2335 td = urb_priv->td[td_index];
2337 INIT_LIST_HEAD(&td->td_list);
2338 INIT_LIST_HEAD(&td->cancelled_td_list);
2340 if (td_index == 0) {
2341 ret = usb_hcd_link_urb_to_ep(xhci_to_hcd(xhci), urb);
2342 if (unlikely(ret)) {
2343 xhci_urb_free_priv(xhci, urb_priv);
2344 urb->hcpriv = NULL;
2345 return ret;
2349 td->urb = urb;
2350 /* Add this TD to the tail of the endpoint ring's TD list */
2351 list_add_tail(&td->td_list, &ep_ring->td_list);
2352 td->start_seg = ep_ring->enq_seg;
2353 td->first_trb = ep_ring->enqueue;
2355 urb_priv->td[td_index] = td;
2357 return 0;
2360 static unsigned int count_sg_trbs_needed(struct xhci_hcd *xhci, struct urb *urb)
2362 int num_sgs, num_trbs, running_total, temp, i;
2363 struct scatterlist *sg;
2365 sg = NULL;
2366 num_sgs = urb->num_sgs;
2367 temp = urb->transfer_buffer_length;
2369 xhci_dbg(xhci, "count sg list trbs: \n");
2370 num_trbs = 0;
2371 for_each_sg(urb->sg, sg, num_sgs, i) {
2372 unsigned int previous_total_trbs = num_trbs;
2373 unsigned int len = sg_dma_len(sg);
2375 /* Scatter gather list entries may cross 64KB boundaries */
2376 running_total = TRB_MAX_BUFF_SIZE -
2377 (sg_dma_address(sg) & (TRB_MAX_BUFF_SIZE - 1));
2378 running_total &= TRB_MAX_BUFF_SIZE - 1;
2379 if (running_total != 0)
2380 num_trbs++;
2382 /* How many more 64KB chunks to transfer, how many more TRBs? */
2383 while (running_total < sg_dma_len(sg)) {
2384 num_trbs++;
2385 running_total += TRB_MAX_BUFF_SIZE;
2387 xhci_dbg(xhci, " sg #%d: dma = %#llx, len = %#x (%d), num_trbs = %d\n",
2388 i, (unsigned long long)sg_dma_address(sg),
2389 len, len, num_trbs - previous_total_trbs);
2391 len = min_t(int, len, temp);
2392 temp -= len;
2393 if (temp == 0)
2394 break;
2396 xhci_dbg(xhci, "\n");
2397 if (!in_interrupt())
2398 dev_dbg(&urb->dev->dev, "ep %#x - urb len = %d, sglist used, num_trbs = %d\n",
2399 urb->ep->desc.bEndpointAddress,
2400 urb->transfer_buffer_length,
2401 num_trbs);
2402 return num_trbs;
2405 static void check_trb_math(struct urb *urb, int num_trbs, int running_total)
2407 if (num_trbs != 0)
2408 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated number of "
2409 "TRBs, %d left\n", __func__,
2410 urb->ep->desc.bEndpointAddress, num_trbs);
2411 if (running_total != urb->transfer_buffer_length)
2412 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated tx length, "
2413 "queued %#x (%d), asked for %#x (%d)\n",
2414 __func__,
2415 urb->ep->desc.bEndpointAddress,
2416 running_total, running_total,
2417 urb->transfer_buffer_length,
2418 urb->transfer_buffer_length);
2421 static void giveback_first_trb(struct xhci_hcd *xhci, int slot_id,
2422 unsigned int ep_index, unsigned int stream_id, int start_cycle,
2423 struct xhci_generic_trb *start_trb, struct xhci_td *td)
2426 * Pass all the TRBs to the hardware at once and make sure this write
2427 * isn't reordered.
2429 wmb();
2430 start_trb->field[3] |= start_cycle;
2431 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, stream_id);
2435 * xHCI uses normal TRBs for both bulk and interrupt. When the interrupt
2436 * endpoint is to be serviced, the xHC will consume (at most) one TD. A TD
2437 * (comprised of sg list entries) can take several service intervals to
2438 * transmit.
2440 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
2441 struct urb *urb, int slot_id, unsigned int ep_index)
2443 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci,
2444 xhci->devs[slot_id]->out_ctx, ep_index);
2445 int xhci_interval;
2446 int ep_interval;
2448 xhci_interval = EP_INTERVAL_TO_UFRAMES(ep_ctx->ep_info);
2449 ep_interval = urb->interval;
2450 /* Convert to microframes */
2451 if (urb->dev->speed == USB_SPEED_LOW ||
2452 urb->dev->speed == USB_SPEED_FULL)
2453 ep_interval *= 8;
2454 /* FIXME change this to a warning and a suggestion to use the new API
2455 * to set the polling interval (once the API is added).
2457 if (xhci_interval != ep_interval) {
2458 if (!printk_ratelimit())
2459 dev_dbg(&urb->dev->dev, "Driver uses different interval"
2460 " (%d microframe%s) than xHCI "
2461 "(%d microframe%s)\n",
2462 ep_interval,
2463 ep_interval == 1 ? "" : "s",
2464 xhci_interval,
2465 xhci_interval == 1 ? "" : "s");
2466 urb->interval = xhci_interval;
2467 /* Convert back to frames for LS/FS devices */
2468 if (urb->dev->speed == USB_SPEED_LOW ||
2469 urb->dev->speed == USB_SPEED_FULL)
2470 urb->interval /= 8;
2472 return xhci_queue_bulk_tx(xhci, GFP_ATOMIC, urb, slot_id, ep_index);
2476 * The TD size is the number of bytes remaining in the TD (including this TRB),
2477 * right shifted by 10.
2478 * It must fit in bits 21:17, so it can't be bigger than 31.
2480 static u32 xhci_td_remainder(unsigned int remainder)
2482 u32 max = (1 << (21 - 17 + 1)) - 1;
2484 if ((remainder >> 10) >= max)
2485 return max << 17;
2486 else
2487 return (remainder >> 10) << 17;
2490 static int queue_bulk_sg_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
2491 struct urb *urb, int slot_id, unsigned int ep_index)
2493 struct xhci_ring *ep_ring;
2494 unsigned int num_trbs;
2495 struct urb_priv *urb_priv;
2496 struct xhci_td *td;
2497 struct scatterlist *sg;
2498 int num_sgs;
2499 int trb_buff_len, this_sg_len, running_total;
2500 bool first_trb;
2501 u64 addr;
2502 bool more_trbs_coming;
2504 struct xhci_generic_trb *start_trb;
2505 int start_cycle;
2507 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
2508 if (!ep_ring)
2509 return -EINVAL;
2511 num_trbs = count_sg_trbs_needed(xhci, urb);
2512 num_sgs = urb->num_sgs;
2514 trb_buff_len = prepare_transfer(xhci, xhci->devs[slot_id],
2515 ep_index, urb->stream_id,
2516 num_trbs, urb, 0, mem_flags);
2517 if (trb_buff_len < 0)
2518 return trb_buff_len;
2520 urb_priv = urb->hcpriv;
2521 td = urb_priv->td[0];
2524 * Don't give the first TRB to the hardware (by toggling the cycle bit)
2525 * until we've finished creating all the other TRBs. The ring's cycle
2526 * state may change as we enqueue the other TRBs, so save it too.
2528 start_trb = &ep_ring->enqueue->generic;
2529 start_cycle = ep_ring->cycle_state;
2531 running_total = 0;
2533 * How much data is in the first TRB?
2535 * There are three forces at work for TRB buffer pointers and lengths:
2536 * 1. We don't want to walk off the end of this sg-list entry buffer.
2537 * 2. The transfer length that the driver requested may be smaller than
2538 * the amount of memory allocated for this scatter-gather list.
2539 * 3. TRBs buffers can't cross 64KB boundaries.
2541 sg = urb->sg;
2542 addr = (u64) sg_dma_address(sg);
2543 this_sg_len = sg_dma_len(sg);
2544 trb_buff_len = TRB_MAX_BUFF_SIZE - (addr & (TRB_MAX_BUFF_SIZE - 1));
2545 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
2546 if (trb_buff_len > urb->transfer_buffer_length)
2547 trb_buff_len = urb->transfer_buffer_length;
2548 xhci_dbg(xhci, "First length to xfer from 1st sglist entry = %u\n",
2549 trb_buff_len);
2551 first_trb = true;
2552 /* Queue the first TRB, even if it's zero-length */
2553 do {
2554 u32 field = 0;
2555 u32 length_field = 0;
2556 u32 remainder = 0;
2558 /* Don't change the cycle bit of the first TRB until later */
2559 if (first_trb)
2560 first_trb = false;
2561 else
2562 field |= ep_ring->cycle_state;
2564 /* Chain all the TRBs together; clear the chain bit in the last
2565 * TRB to indicate it's the last TRB in the chain.
2567 if (num_trbs > 1) {
2568 field |= TRB_CHAIN;
2569 } else {
2570 /* FIXME - add check for ZERO_PACKET flag before this */
2571 td->last_trb = ep_ring->enqueue;
2572 field |= TRB_IOC;
2574 xhci_dbg(xhci, " sg entry: dma = %#x, len = %#x (%d), "
2575 "64KB boundary at %#x, end dma = %#x\n",
2576 (unsigned int) addr, trb_buff_len, trb_buff_len,
2577 (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
2578 (unsigned int) addr + trb_buff_len);
2579 if (TRB_MAX_BUFF_SIZE -
2580 (addr & (TRB_MAX_BUFF_SIZE - 1)) < trb_buff_len) {
2581 xhci_warn(xhci, "WARN: sg dma xfer crosses 64KB boundaries!\n");
2582 xhci_dbg(xhci, "Next boundary at %#x, end dma = %#x\n",
2583 (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
2584 (unsigned int) addr + trb_buff_len);
2586 remainder = xhci_td_remainder(urb->transfer_buffer_length -
2587 running_total) ;
2588 length_field = TRB_LEN(trb_buff_len) |
2589 remainder |
2590 TRB_INTR_TARGET(0);
2591 if (num_trbs > 1)
2592 more_trbs_coming = true;
2593 else
2594 more_trbs_coming = false;
2595 queue_trb(xhci, ep_ring, false, more_trbs_coming,
2596 lower_32_bits(addr),
2597 upper_32_bits(addr),
2598 length_field,
2599 /* We always want to know if the TRB was short,
2600 * or we won't get an event when it completes.
2601 * (Unless we use event data TRBs, which are a
2602 * waste of space and HC resources.)
2604 field | TRB_ISP | TRB_TYPE(TRB_NORMAL));
2605 --num_trbs;
2606 running_total += trb_buff_len;
2608 /* Calculate length for next transfer --
2609 * Are we done queueing all the TRBs for this sg entry?
2611 this_sg_len -= trb_buff_len;
2612 if (this_sg_len == 0) {
2613 --num_sgs;
2614 if (num_sgs == 0)
2615 break;
2616 sg = sg_next(sg);
2617 addr = (u64) sg_dma_address(sg);
2618 this_sg_len = sg_dma_len(sg);
2619 } else {
2620 addr += trb_buff_len;
2623 trb_buff_len = TRB_MAX_BUFF_SIZE -
2624 (addr & (TRB_MAX_BUFF_SIZE - 1));
2625 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
2626 if (running_total + trb_buff_len > urb->transfer_buffer_length)
2627 trb_buff_len =
2628 urb->transfer_buffer_length - running_total;
2629 } while (running_total < urb->transfer_buffer_length);
2631 check_trb_math(urb, num_trbs, running_total);
2632 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
2633 start_cycle, start_trb, td);
2634 return 0;
2637 /* This is very similar to what ehci-q.c qtd_fill() does */
2638 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
2639 struct urb *urb, int slot_id, unsigned int ep_index)
2641 struct xhci_ring *ep_ring;
2642 struct urb_priv *urb_priv;
2643 struct xhci_td *td;
2644 int num_trbs;
2645 struct xhci_generic_trb *start_trb;
2646 bool first_trb;
2647 bool more_trbs_coming;
2648 int start_cycle;
2649 u32 field, length_field;
2651 int running_total, trb_buff_len, ret;
2652 u64 addr;
2654 if (urb->num_sgs)
2655 return queue_bulk_sg_tx(xhci, mem_flags, urb, slot_id, ep_index);
2657 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
2658 if (!ep_ring)
2659 return -EINVAL;
2661 num_trbs = 0;
2662 /* How much data is (potentially) left before the 64KB boundary? */
2663 running_total = TRB_MAX_BUFF_SIZE -
2664 (urb->transfer_dma & (TRB_MAX_BUFF_SIZE - 1));
2665 running_total &= TRB_MAX_BUFF_SIZE - 1;
2667 /* If there's some data on this 64KB chunk, or we have to send a
2668 * zero-length transfer, we need at least one TRB
2670 if (running_total != 0 || urb->transfer_buffer_length == 0)
2671 num_trbs++;
2672 /* How many more 64KB chunks to transfer, how many more TRBs? */
2673 while (running_total < urb->transfer_buffer_length) {
2674 num_trbs++;
2675 running_total += TRB_MAX_BUFF_SIZE;
2677 /* FIXME: this doesn't deal with URB_ZERO_PACKET - need one more */
2679 if (!in_interrupt())
2680 dev_dbg(&urb->dev->dev, "ep %#x - urb len = %#x (%d), addr = %#llx, num_trbs = %d\n",
2681 urb->ep->desc.bEndpointAddress,
2682 urb->transfer_buffer_length,
2683 urb->transfer_buffer_length,
2684 (unsigned long long)urb->transfer_dma,
2685 num_trbs);
2687 ret = prepare_transfer(xhci, xhci->devs[slot_id],
2688 ep_index, urb->stream_id,
2689 num_trbs, urb, 0, mem_flags);
2690 if (ret < 0)
2691 return ret;
2693 urb_priv = urb->hcpriv;
2694 td = urb_priv->td[0];
2697 * Don't give the first TRB to the hardware (by toggling the cycle bit)
2698 * until we've finished creating all the other TRBs. The ring's cycle
2699 * state may change as we enqueue the other TRBs, so save it too.
2701 start_trb = &ep_ring->enqueue->generic;
2702 start_cycle = ep_ring->cycle_state;
2704 running_total = 0;
2705 /* How much data is in the first TRB? */
2706 addr = (u64) urb->transfer_dma;
2707 trb_buff_len = TRB_MAX_BUFF_SIZE -
2708 (urb->transfer_dma & (TRB_MAX_BUFF_SIZE - 1));
2709 if (trb_buff_len > urb->transfer_buffer_length)
2710 trb_buff_len = urb->transfer_buffer_length;
2712 first_trb = true;
2714 /* Queue the first TRB, even if it's zero-length */
2715 do {
2716 u32 remainder = 0;
2717 field = 0;
2719 /* Don't change the cycle bit of the first TRB until later */
2720 if (first_trb)
2721 first_trb = false;
2722 else
2723 field |= ep_ring->cycle_state;
2725 /* Chain all the TRBs together; clear the chain bit in the last
2726 * TRB to indicate it's the last TRB in the chain.
2728 if (num_trbs > 1) {
2729 field |= TRB_CHAIN;
2730 } else {
2731 /* FIXME - add check for ZERO_PACKET flag before this */
2732 td->last_trb = ep_ring->enqueue;
2733 field |= TRB_IOC;
2735 remainder = xhci_td_remainder(urb->transfer_buffer_length -
2736 running_total);
2737 length_field = TRB_LEN(trb_buff_len) |
2738 remainder |
2739 TRB_INTR_TARGET(0);
2740 if (num_trbs > 1)
2741 more_trbs_coming = true;
2742 else
2743 more_trbs_coming = false;
2744 queue_trb(xhci, ep_ring, false, more_trbs_coming,
2745 lower_32_bits(addr),
2746 upper_32_bits(addr),
2747 length_field,
2748 /* We always want to know if the TRB was short,
2749 * or we won't get an event when it completes.
2750 * (Unless we use event data TRBs, which are a
2751 * waste of space and HC resources.)
2753 field | TRB_ISP | TRB_TYPE(TRB_NORMAL));
2754 --num_trbs;
2755 running_total += trb_buff_len;
2757 /* Calculate length for next transfer */
2758 addr += trb_buff_len;
2759 trb_buff_len = urb->transfer_buffer_length - running_total;
2760 if (trb_buff_len > TRB_MAX_BUFF_SIZE)
2761 trb_buff_len = TRB_MAX_BUFF_SIZE;
2762 } while (running_total < urb->transfer_buffer_length);
2764 check_trb_math(urb, num_trbs, running_total);
2765 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
2766 start_cycle, start_trb, td);
2767 return 0;
2770 /* Caller must have locked xhci->lock */
2771 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
2772 struct urb *urb, int slot_id, unsigned int ep_index)
2774 struct xhci_ring *ep_ring;
2775 int num_trbs;
2776 int ret;
2777 struct usb_ctrlrequest *setup;
2778 struct xhci_generic_trb *start_trb;
2779 int start_cycle;
2780 u32 field, length_field;
2781 struct urb_priv *urb_priv;
2782 struct xhci_td *td;
2784 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
2785 if (!ep_ring)
2786 return -EINVAL;
2789 * Need to copy setup packet into setup TRB, so we can't use the setup
2790 * DMA address.
2792 if (!urb->setup_packet)
2793 return -EINVAL;
2795 if (!in_interrupt())
2796 xhci_dbg(xhci, "Queueing ctrl tx for slot id %d, ep %d\n",
2797 slot_id, ep_index);
2798 /* 1 TRB for setup, 1 for status */
2799 num_trbs = 2;
2801 * Don't need to check if we need additional event data and normal TRBs,
2802 * since data in control transfers will never get bigger than 16MB
2803 * XXX: can we get a buffer that crosses 64KB boundaries?
2805 if (urb->transfer_buffer_length > 0)
2806 num_trbs++;
2807 ret = prepare_transfer(xhci, xhci->devs[slot_id],
2808 ep_index, urb->stream_id,
2809 num_trbs, urb, 0, mem_flags);
2810 if (ret < 0)
2811 return ret;
2813 urb_priv = urb->hcpriv;
2814 td = urb_priv->td[0];
2817 * Don't give the first TRB to the hardware (by toggling the cycle bit)
2818 * until we've finished creating all the other TRBs. The ring's cycle
2819 * state may change as we enqueue the other TRBs, so save it too.
2821 start_trb = &ep_ring->enqueue->generic;
2822 start_cycle = ep_ring->cycle_state;
2824 /* Queue setup TRB - see section 6.4.1.2.1 */
2825 /* FIXME better way to translate setup_packet into two u32 fields? */
2826 setup = (struct usb_ctrlrequest *) urb->setup_packet;
2827 queue_trb(xhci, ep_ring, false, true,
2828 /* FIXME endianness is probably going to bite my ass here. */
2829 setup->bRequestType | setup->bRequest << 8 | setup->wValue << 16,
2830 setup->wIndex | setup->wLength << 16,
2831 TRB_LEN(8) | TRB_INTR_TARGET(0),
2832 /* Immediate data in pointer */
2833 TRB_IDT | TRB_TYPE(TRB_SETUP));
2835 /* If there's data, queue data TRBs */
2836 field = 0;
2837 length_field = TRB_LEN(urb->transfer_buffer_length) |
2838 xhci_td_remainder(urb->transfer_buffer_length) |
2839 TRB_INTR_TARGET(0);
2840 if (urb->transfer_buffer_length > 0) {
2841 if (setup->bRequestType & USB_DIR_IN)
2842 field |= TRB_DIR_IN;
2843 queue_trb(xhci, ep_ring, false, true,
2844 lower_32_bits(urb->transfer_dma),
2845 upper_32_bits(urb->transfer_dma),
2846 length_field,
2847 /* Event on short tx */
2848 field | TRB_ISP | TRB_TYPE(TRB_DATA) | ep_ring->cycle_state);
2851 /* Save the DMA address of the last TRB in the TD */
2852 td->last_trb = ep_ring->enqueue;
2854 /* Queue status TRB - see Table 7 and sections 4.11.2.2 and 6.4.1.2.3 */
2855 /* If the device sent data, the status stage is an OUT transfer */
2856 if (urb->transfer_buffer_length > 0 && setup->bRequestType & USB_DIR_IN)
2857 field = 0;
2858 else
2859 field = TRB_DIR_IN;
2860 queue_trb(xhci, ep_ring, false, false,
2863 TRB_INTR_TARGET(0),
2864 /* Event on completion */
2865 field | TRB_IOC | TRB_TYPE(TRB_STATUS) | ep_ring->cycle_state);
2867 giveback_first_trb(xhci, slot_id, ep_index, 0,
2868 start_cycle, start_trb, td);
2869 return 0;
2872 static int count_isoc_trbs_needed(struct xhci_hcd *xhci,
2873 struct urb *urb, int i)
2875 int num_trbs = 0;
2876 u64 addr, td_len, running_total;
2878 addr = (u64) (urb->transfer_dma + urb->iso_frame_desc[i].offset);
2879 td_len = urb->iso_frame_desc[i].length;
2881 running_total = TRB_MAX_BUFF_SIZE - (addr & (TRB_MAX_BUFF_SIZE - 1));
2882 running_total &= TRB_MAX_BUFF_SIZE - 1;
2883 if (running_total != 0)
2884 num_trbs++;
2886 while (running_total < td_len) {
2887 num_trbs++;
2888 running_total += TRB_MAX_BUFF_SIZE;
2891 return num_trbs;
2894 /* This is for isoc transfer */
2895 static int xhci_queue_isoc_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
2896 struct urb *urb, int slot_id, unsigned int ep_index)
2898 struct xhci_ring *ep_ring;
2899 struct urb_priv *urb_priv;
2900 struct xhci_td *td;
2901 int num_tds, trbs_per_td;
2902 struct xhci_generic_trb *start_trb;
2903 bool first_trb;
2904 int start_cycle;
2905 u32 field, length_field;
2906 int running_total, trb_buff_len, td_len, td_remain_len, ret;
2907 u64 start_addr, addr;
2908 int i, j;
2910 ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
2912 num_tds = urb->number_of_packets;
2913 if (num_tds < 1) {
2914 xhci_dbg(xhci, "Isoc URB with zero packets?\n");
2915 return -EINVAL;
2918 if (!in_interrupt())
2919 dev_dbg(&urb->dev->dev, "ep %#x - urb len = %#x (%d),"
2920 " addr = %#llx, num_tds = %d\n",
2921 urb->ep->desc.bEndpointAddress,
2922 urb->transfer_buffer_length,
2923 urb->transfer_buffer_length,
2924 (unsigned long long)urb->transfer_dma,
2925 num_tds);
2927 start_addr = (u64) urb->transfer_dma;
2928 start_trb = &ep_ring->enqueue->generic;
2929 start_cycle = ep_ring->cycle_state;
2931 /* Queue the first TRB, even if it's zero-length */
2932 for (i = 0; i < num_tds; i++) {
2933 first_trb = true;
2935 running_total = 0;
2936 addr = start_addr + urb->iso_frame_desc[i].offset;
2937 td_len = urb->iso_frame_desc[i].length;
2938 td_remain_len = td_len;
2940 trbs_per_td = count_isoc_trbs_needed(xhci, urb, i);
2942 ret = prepare_transfer(xhci, xhci->devs[slot_id], ep_index,
2943 urb->stream_id, trbs_per_td, urb, i, mem_flags);
2944 if (ret < 0)
2945 return ret;
2947 urb_priv = urb->hcpriv;
2948 td = urb_priv->td[i];
2950 for (j = 0; j < trbs_per_td; j++) {
2951 u32 remainder = 0;
2952 field = 0;
2954 if (first_trb) {
2955 /* Queue the isoc TRB */
2956 field |= TRB_TYPE(TRB_ISOC);
2957 /* Assume URB_ISO_ASAP is set */
2958 field |= TRB_SIA;
2959 if (i > 0)
2960 field |= ep_ring->cycle_state;
2961 first_trb = false;
2962 } else {
2963 /* Queue other normal TRBs */
2964 field |= TRB_TYPE(TRB_NORMAL);
2965 field |= ep_ring->cycle_state;
2968 /* Chain all the TRBs together; clear the chain bit in
2969 * the last TRB to indicate it's the last TRB in the
2970 * chain.
2972 if (j < trbs_per_td - 1) {
2973 field |= TRB_CHAIN;
2974 } else {
2975 td->last_trb = ep_ring->enqueue;
2976 field |= TRB_IOC;
2979 /* Calculate TRB length */
2980 trb_buff_len = TRB_MAX_BUFF_SIZE -
2981 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
2982 if (trb_buff_len > td_remain_len)
2983 trb_buff_len = td_remain_len;
2985 remainder = xhci_td_remainder(td_len - running_total);
2986 length_field = TRB_LEN(trb_buff_len) |
2987 remainder |
2988 TRB_INTR_TARGET(0);
2989 queue_trb(xhci, ep_ring, false, false,
2990 lower_32_bits(addr),
2991 upper_32_bits(addr),
2992 length_field,
2993 /* We always want to know if the TRB was short,
2994 * or we won't get an event when it completes.
2995 * (Unless we use event data TRBs, which are a
2996 * waste of space and HC resources.)
2998 field | TRB_ISP);
2999 running_total += trb_buff_len;
3001 addr += trb_buff_len;
3002 td_remain_len -= trb_buff_len;
3005 /* Check TD length */
3006 if (running_total != td_len) {
3007 xhci_err(xhci, "ISOC TD length unmatch\n");
3008 return -EINVAL;
3012 wmb();
3013 start_trb->field[3] |= start_cycle;
3015 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, urb->stream_id);
3016 return 0;
3020 * Check transfer ring to guarantee there is enough room for the urb.
3021 * Update ISO URB start_frame and interval.
3022 * Update interval as xhci_queue_intr_tx does. Just use xhci frame_index to
3023 * update the urb->start_frame by now.
3024 * Always assume URB_ISO_ASAP set, and NEVER use urb->start_frame as input.
3026 int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
3027 struct urb *urb, int slot_id, unsigned int ep_index)
3029 struct xhci_virt_device *xdev;
3030 struct xhci_ring *ep_ring;
3031 struct xhci_ep_ctx *ep_ctx;
3032 int start_frame;
3033 int xhci_interval;
3034 int ep_interval;
3035 int num_tds, num_trbs, i;
3036 int ret;
3038 xdev = xhci->devs[slot_id];
3039 ep_ring = xdev->eps[ep_index].ring;
3040 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
3042 num_trbs = 0;
3043 num_tds = urb->number_of_packets;
3044 for (i = 0; i < num_tds; i++)
3045 num_trbs += count_isoc_trbs_needed(xhci, urb, i);
3047 /* Check the ring to guarantee there is enough room for the whole urb.
3048 * Do not insert any td of the urb to the ring if the check failed.
3050 ret = prepare_ring(xhci, ep_ring, ep_ctx->ep_info & EP_STATE_MASK,
3051 num_trbs, mem_flags);
3052 if (ret)
3053 return ret;
3055 start_frame = xhci_readl(xhci, &xhci->run_regs->microframe_index);
3056 start_frame &= 0x3fff;
3058 urb->start_frame = start_frame;
3059 if (urb->dev->speed == USB_SPEED_LOW ||
3060 urb->dev->speed == USB_SPEED_FULL)
3061 urb->start_frame >>= 3;
3063 xhci_interval = EP_INTERVAL_TO_UFRAMES(ep_ctx->ep_info);
3064 ep_interval = urb->interval;
3065 /* Convert to microframes */
3066 if (urb->dev->speed == USB_SPEED_LOW ||
3067 urb->dev->speed == USB_SPEED_FULL)
3068 ep_interval *= 8;
3069 /* FIXME change this to a warning and a suggestion to use the new API
3070 * to set the polling interval (once the API is added).
3072 if (xhci_interval != ep_interval) {
3073 if (!printk_ratelimit())
3074 dev_dbg(&urb->dev->dev, "Driver uses different interval"
3075 " (%d microframe%s) than xHCI "
3076 "(%d microframe%s)\n",
3077 ep_interval,
3078 ep_interval == 1 ? "" : "s",
3079 xhci_interval,
3080 xhci_interval == 1 ? "" : "s");
3081 urb->interval = xhci_interval;
3082 /* Convert back to frames for LS/FS devices */
3083 if (urb->dev->speed == USB_SPEED_LOW ||
3084 urb->dev->speed == USB_SPEED_FULL)
3085 urb->interval /= 8;
3087 return xhci_queue_isoc_tx(xhci, GFP_ATOMIC, urb, slot_id, ep_index);
3090 /**** Command Ring Operations ****/
3092 /* Generic function for queueing a command TRB on the command ring.
3093 * Check to make sure there's room on the command ring for one command TRB.
3094 * Also check that there's room reserved for commands that must not fail.
3095 * If this is a command that must not fail, meaning command_must_succeed = TRUE,
3096 * then only check for the number of reserved spots.
3097 * Don't decrement xhci->cmd_ring_reserved_trbs after we've queued the TRB
3098 * because the command event handler may want to resubmit a failed command.
3100 static int queue_command(struct xhci_hcd *xhci, u32 field1, u32 field2,
3101 u32 field3, u32 field4, bool command_must_succeed)
3103 int reserved_trbs = xhci->cmd_ring_reserved_trbs;
3104 int ret;
3106 if (!command_must_succeed)
3107 reserved_trbs++;
3109 ret = prepare_ring(xhci, xhci->cmd_ring, EP_STATE_RUNNING,
3110 reserved_trbs, GFP_ATOMIC);
3111 if (ret < 0) {
3112 xhci_err(xhci, "ERR: No room for command on command ring\n");
3113 if (command_must_succeed)
3114 xhci_err(xhci, "ERR: Reserved TRB counting for "
3115 "unfailable commands failed.\n");
3116 return ret;
3118 queue_trb(xhci, xhci->cmd_ring, false, false, field1, field2, field3,
3119 field4 | xhci->cmd_ring->cycle_state);
3120 return 0;
3123 /* Queue a no-op command on the command ring */
3124 static int queue_cmd_noop(struct xhci_hcd *xhci)
3126 return queue_command(xhci, 0, 0, 0, TRB_TYPE(TRB_CMD_NOOP), false);
3130 * Place a no-op command on the command ring to test the command and
3131 * event ring.
3133 void *xhci_setup_one_noop(struct xhci_hcd *xhci)
3135 if (queue_cmd_noop(xhci) < 0)
3136 return NULL;
3137 xhci->noops_submitted++;
3138 return xhci_ring_cmd_db;
3141 /* Queue a slot enable or disable request on the command ring */
3142 int xhci_queue_slot_control(struct xhci_hcd *xhci, u32 trb_type, u32 slot_id)
3144 return queue_command(xhci, 0, 0, 0,
3145 TRB_TYPE(trb_type) | SLOT_ID_FOR_TRB(slot_id), false);
3148 /* Queue an address device command TRB */
3149 int xhci_queue_address_device(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
3150 u32 slot_id)
3152 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
3153 upper_32_bits(in_ctx_ptr), 0,
3154 TRB_TYPE(TRB_ADDR_DEV) | SLOT_ID_FOR_TRB(slot_id),
3155 false);
3158 int xhci_queue_vendor_command(struct xhci_hcd *xhci,
3159 u32 field1, u32 field2, u32 field3, u32 field4)
3161 return queue_command(xhci, field1, field2, field3, field4, false);
3164 /* Queue a reset device command TRB */
3165 int xhci_queue_reset_device(struct xhci_hcd *xhci, u32 slot_id)
3167 return queue_command(xhci, 0, 0, 0,
3168 TRB_TYPE(TRB_RESET_DEV) | SLOT_ID_FOR_TRB(slot_id),
3169 false);
3172 /* Queue a configure endpoint command TRB */
3173 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
3174 u32 slot_id, bool command_must_succeed)
3176 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
3177 upper_32_bits(in_ctx_ptr), 0,
3178 TRB_TYPE(TRB_CONFIG_EP) | SLOT_ID_FOR_TRB(slot_id),
3179 command_must_succeed);
3182 /* Queue an evaluate context command TRB */
3183 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
3184 u32 slot_id)
3186 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
3187 upper_32_bits(in_ctx_ptr), 0,
3188 TRB_TYPE(TRB_EVAL_CONTEXT) | SLOT_ID_FOR_TRB(slot_id),
3189 false);
3193 * Suspend is set to indicate "Stop Endpoint Command" is being issued to stop
3194 * activity on an endpoint that is about to be suspended.
3196 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, int slot_id,
3197 unsigned int ep_index, int suspend)
3199 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3200 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3201 u32 type = TRB_TYPE(TRB_STOP_RING);
3202 u32 trb_suspend = SUSPEND_PORT_FOR_TRB(suspend);
3204 return queue_command(xhci, 0, 0, 0,
3205 trb_slot_id | trb_ep_index | type | trb_suspend, false);
3208 /* Set Transfer Ring Dequeue Pointer command.
3209 * This should not be used for endpoints that have streams enabled.
3211 static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
3212 unsigned int ep_index, unsigned int stream_id,
3213 struct xhci_segment *deq_seg,
3214 union xhci_trb *deq_ptr, u32 cycle_state)
3216 dma_addr_t addr;
3217 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3218 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3219 u32 trb_stream_id = STREAM_ID_FOR_TRB(stream_id);
3220 u32 type = TRB_TYPE(TRB_SET_DEQ);
3222 addr = xhci_trb_virt_to_dma(deq_seg, deq_ptr);
3223 if (addr == 0) {
3224 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
3225 xhci_warn(xhci, "WARN deq seg = %p, deq pt = %p\n",
3226 deq_seg, deq_ptr);
3227 return 0;
3229 return queue_command(xhci, lower_32_bits(addr) | cycle_state,
3230 upper_32_bits(addr), trb_stream_id,
3231 trb_slot_id | trb_ep_index | type, false);
3234 int xhci_queue_reset_ep(struct xhci_hcd *xhci, int slot_id,
3235 unsigned int ep_index)
3237 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3238 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3239 u32 type = TRB_TYPE(TRB_RESET_EP);
3241 return queue_command(xhci, 0, 0, 0, trb_slot_id | trb_ep_index | type,
3242 false);