xhci: xhci_ring_device: Ring stream ring bells for endpoints with streams
[linux-2.6-block.git] / drivers / usb / host / xhci-ring.c
CommitLineData
7f84eef0
SS
1/*
2 * xHCI host controller driver
3 *
4 * Copyright (C) 2008 Intel Corp.
5 *
6 * Author: Sarah Sharp
7 * Some code borrowed from the Linux EHCI driver.
8 *
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.
12 *
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.
17 *
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.
21 */
22
23/*
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.
29 *
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.
41 *
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.
47 *
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.
56 *
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.
65 */
66
8a96c052 67#include <linux/scatterlist.h>
5a0e3ad6 68#include <linux/slab.h>
7f84eef0 69#include "xhci.h"
3a7fa5be 70#include "xhci-trace.h"
7f84eef0
SS
71
72/*
73 * Returns zero if the TRB isn't in this segment, otherwise it returns the DMA
74 * address of the TRB.
75 */
23e3be11 76dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg,
7f84eef0
SS
77 union xhci_trb *trb)
78{
6071d836 79 unsigned long segment_offset;
7f84eef0 80
6071d836 81 if (!seg || !trb || trb < seg->trbs)
7f84eef0 82 return 0;
6071d836
SS
83 /* offset in TRBs */
84 segment_offset = trb - seg->trbs;
85 if (segment_offset > TRBS_PER_SEGMENT)
7f84eef0 86 return 0;
6071d836 87 return seg->dma + (segment_offset * sizeof(*trb));
7f84eef0
SS
88}
89
90/* Does this link TRB point to the first segment in a ring,
91 * or was the previous TRB the last TRB on the last segment in the ERST?
92 */
575688e1 93static bool last_trb_on_last_seg(struct xhci_hcd *xhci, struct xhci_ring *ring,
7f84eef0
SS
94 struct xhci_segment *seg, union xhci_trb *trb)
95{
96 if (ring == xhci->event_ring)
97 return (trb == &seg->trbs[TRBS_PER_SEGMENT]) &&
98 (seg->next == xhci->event_ring->first_seg);
99 else
28ccd296 100 return le32_to_cpu(trb->link.control) & LINK_TOGGLE;
7f84eef0
SS
101}
102
103/* Is this TRB a link TRB or was the last TRB the last TRB in this event ring
104 * segment? I.e. would the updated event TRB pointer step off the end of the
105 * event seg?
106 */
575688e1 107static int last_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
7f84eef0
SS
108 struct xhci_segment *seg, union xhci_trb *trb)
109{
110 if (ring == xhci->event_ring)
111 return trb == &seg->trbs[TRBS_PER_SEGMENT];
112 else
f5960b69 113 return TRB_TYPE_LINK_LE32(trb->link.control);
7f84eef0
SS
114}
115
575688e1 116static int enqueue_is_link_trb(struct xhci_ring *ring)
6c12db90
JY
117{
118 struct xhci_link_trb *link = &ring->enqueue->link;
f5960b69 119 return TRB_TYPE_LINK_LE32(link->control);
6c12db90
JY
120}
121
ae636747
SS
122/* Updates trb to point to the next TRB in the ring, and updates seg if the next
123 * TRB is in a new segment. This does not skip over link TRBs, and it does not
124 * effect the ring dequeue or enqueue pointers.
125 */
126static void next_trb(struct xhci_hcd *xhci,
127 struct xhci_ring *ring,
128 struct xhci_segment **seg,
129 union xhci_trb **trb)
130{
131 if (last_trb(xhci, ring, *seg, *trb)) {
132 *seg = (*seg)->next;
133 *trb = ((*seg)->trbs);
134 } else {
a1669b2c 135 (*trb)++;
ae636747
SS
136 }
137}
138
7f84eef0
SS
139/*
140 * See Cycle bit rules. SW is the consumer for the event ring only.
141 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
142 */
3b72fca0 143static void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring)
7f84eef0 144{
7f84eef0 145 ring->deq_updates++;
b008df60 146
50d0206f
SS
147 /*
148 * If this is not event ring, and the dequeue pointer
149 * is not on a link TRB, there is one more usable TRB
150 */
b008df60
AX
151 if (ring->type != TYPE_EVENT &&
152 !last_trb(xhci, ring, ring->deq_seg, ring->dequeue))
153 ring->num_trbs_free++;
b008df60 154
50d0206f
SS
155 do {
156 /*
157 * Update the dequeue pointer further if that was a link TRB or
158 * we're at the end of an event ring segment (which doesn't have
159 * link TRBS)
160 */
161 if (last_trb(xhci, ring, ring->deq_seg, ring->dequeue)) {
162 if (ring->type == TYPE_EVENT &&
163 last_trb_on_last_seg(xhci, ring,
164 ring->deq_seg, ring->dequeue)) {
4e341818 165 ring->cycle_state ^= 1;
50d0206f
SS
166 }
167 ring->deq_seg = ring->deq_seg->next;
168 ring->dequeue = ring->deq_seg->trbs;
169 } else {
170 ring->dequeue++;
7f84eef0 171 }
50d0206f 172 } while (last_trb(xhci, ring, ring->deq_seg, ring->dequeue));
7f84eef0
SS
173}
174
175/*
176 * See Cycle bit rules. SW is the consumer for the event ring only.
177 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
178 *
179 * If we've just enqueued a TRB that is in the middle of a TD (meaning the
180 * chain bit is set), then set the chain bit in all the following link TRBs.
181 * If we've enqueued the last TRB in a TD, make sure the following link TRBs
182 * have their chain bit cleared (so that each Link TRB is a separate TD).
183 *
184 * Section 6.4.4.1 of the 0.95 spec says link TRBs cannot have the chain bit
b0567b3f
SS
185 * set, but other sections talk about dealing with the chain bit set. This was
186 * fixed in the 0.96 specification errata, but we have to assume that all 0.95
187 * xHCI hardware can't handle the chain bit being cleared on a link TRB.
6cc30d85
SS
188 *
189 * @more_trbs_coming: Will you enqueue more TRBs before calling
190 * prepare_transfer()?
7f84eef0 191 */
6cc30d85 192static void inc_enq(struct xhci_hcd *xhci, struct xhci_ring *ring,
3b72fca0 193 bool more_trbs_coming)
7f84eef0
SS
194{
195 u32 chain;
196 union xhci_trb *next;
197
28ccd296 198 chain = le32_to_cpu(ring->enqueue->generic.field[3]) & TRB_CHAIN;
b008df60
AX
199 /* If this is not event ring, there is one less usable TRB */
200 if (ring->type != TYPE_EVENT &&
201 !last_trb(xhci, ring, ring->enq_seg, ring->enqueue))
202 ring->num_trbs_free--;
7f84eef0
SS
203 next = ++(ring->enqueue);
204
205 ring->enq_updates++;
206 /* Update the dequeue pointer further if that was a link TRB or we're at
207 * the end of an event ring segment (which doesn't have link TRBS)
208 */
209 while (last_trb(xhci, ring, ring->enq_seg, next)) {
3b72fca0
AX
210 if (ring->type != TYPE_EVENT) {
211 /*
212 * If the caller doesn't plan on enqueueing more
213 * TDs before ringing the doorbell, then we
214 * don't want to give the link TRB to the
215 * hardware just yet. We'll give the link TRB
216 * back in prepare_ring() just before we enqueue
217 * the TD at the top of the ring.
218 */
219 if (!chain && !more_trbs_coming)
220 break;
6cc30d85 221
3b72fca0
AX
222 /* If we're not dealing with 0.95 hardware or
223 * isoc rings on AMD 0.96 host,
224 * carry over the chain bit of the previous TRB
225 * (which may mean the chain bit is cleared).
226 */
227 if (!(ring->type == TYPE_ISOC &&
228 (xhci->quirks & XHCI_AMD_0x96_HOST))
7e393a83 229 && !xhci_link_trb_quirk(xhci)) {
3b72fca0
AX
230 next->link.control &=
231 cpu_to_le32(~TRB_CHAIN);
232 next->link.control |=
233 cpu_to_le32(chain);
7f84eef0 234 }
3b72fca0
AX
235 /* Give this link TRB to the hardware */
236 wmb();
237 next->link.control ^= cpu_to_le32(TRB_CYCLE);
238
7f84eef0
SS
239 /* Toggle the cycle bit after the last ring segment. */
240 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
241 ring->cycle_state = (ring->cycle_state ? 0 : 1);
7f84eef0
SS
242 }
243 }
244 ring->enq_seg = ring->enq_seg->next;
245 ring->enqueue = ring->enq_seg->trbs;
246 next = ring->enqueue;
247 }
248}
249
250/*
085deb16
AX
251 * Check to see if there's room to enqueue num_trbs on the ring and make sure
252 * enqueue pointer will not advance into dequeue segment. See rules above.
7f84eef0 253 */
b008df60 254static inline int room_on_ring(struct xhci_hcd *xhci, struct xhci_ring *ring,
7f84eef0
SS
255 unsigned int num_trbs)
256{
085deb16 257 int num_trbs_in_deq_seg;
b008df60 258
085deb16
AX
259 if (ring->num_trbs_free < num_trbs)
260 return 0;
261
262 if (ring->type != TYPE_COMMAND && ring->type != TYPE_EVENT) {
263 num_trbs_in_deq_seg = ring->dequeue - ring->deq_seg->trbs;
264 if (ring->num_trbs_free < num_trbs + num_trbs_in_deq_seg)
265 return 0;
266 }
267
268 return 1;
7f84eef0
SS
269}
270
7f84eef0 271/* Ring the host controller doorbell after placing a command on the ring */
23e3be11 272void xhci_ring_cmd_db(struct xhci_hcd *xhci)
7f84eef0 273{
c181bc5b
EF
274 if (!(xhci->cmd_ring_state & CMD_RING_STATE_RUNNING))
275 return;
276
7f84eef0 277 xhci_dbg(xhci, "// Ding dong!\n");
204b7793 278 writel(DB_VALUE_HOST, &xhci->dba->doorbell[0]);
7f84eef0 279 /* Flush PCI posted writes */
b0ba9720 280 readl(&xhci->dba->doorbell[0]);
7f84eef0
SS
281}
282
b92cc66c
EF
283static int xhci_abort_cmd_ring(struct xhci_hcd *xhci)
284{
285 u64 temp_64;
286 int ret;
287
288 xhci_dbg(xhci, "Abort command ring\n");
289
f7b2e403 290 temp_64 = xhci_read_64(xhci, &xhci->op_regs->cmd_ring);
b92cc66c 291 xhci->cmd_ring_state = CMD_RING_STATE_ABORTED;
477632df
SS
292 xhci_write_64(xhci, temp_64 | CMD_RING_ABORT,
293 &xhci->op_regs->cmd_ring);
b92cc66c
EF
294
295 /* Section 4.6.1.2 of xHCI 1.0 spec says software should
296 * time the completion od all xHCI commands, including
297 * the Command Abort operation. If software doesn't see
298 * CRR negated in a timely manner (e.g. longer than 5
299 * seconds), then it should assume that the there are
300 * larger problems with the xHC and assert HCRST.
301 */
2611bd18 302 ret = xhci_handshake(xhci, &xhci->op_regs->cmd_ring,
b92cc66c
EF
303 CMD_RING_RUNNING, 0, 5 * 1000 * 1000);
304 if (ret < 0) {
305 xhci_err(xhci, "Stopped the command ring failed, "
306 "maybe the host is dead\n");
307 xhci->xhc_state |= XHCI_STATE_DYING;
308 xhci_quiesce(xhci);
309 xhci_halt(xhci);
310 return -ESHUTDOWN;
311 }
312
313 return 0;
314}
315
be88fe4f 316void xhci_ring_ep_doorbell(struct xhci_hcd *xhci,
ae636747 317 unsigned int slot_id,
e9df17eb
SS
318 unsigned int ep_index,
319 unsigned int stream_id)
ae636747 320{
28ccd296 321 __le32 __iomem *db_addr = &xhci->dba->doorbell[slot_id];
50d64676
MW
322 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
323 unsigned int ep_state = ep->ep_state;
ae636747 324
ae636747 325 /* Don't ring the doorbell for this endpoint if there are pending
50d64676 326 * cancellations because we don't want to interrupt processing.
8df75f42
SS
327 * We don't want to restart any stream rings if there's a set dequeue
328 * pointer command pending because the device can choose to start any
329 * stream once the endpoint is on the HW schedule.
330 * FIXME - check all the stream rings for pending cancellations.
ae636747 331 */
50d64676
MW
332 if ((ep_state & EP_HALT_PENDING) || (ep_state & SET_DEQ_PENDING) ||
333 (ep_state & EP_HALTED))
334 return;
204b7793 335 writel(DB_VALUE(ep_index, stream_id), db_addr);
50d64676
MW
336 /* The CPU has better things to do at this point than wait for a
337 * write-posting flush. It'll get there soon enough.
338 */
ae636747
SS
339}
340
e9df17eb
SS
341/* Ring the doorbell for any rings with pending URBs */
342static void ring_doorbell_for_active_rings(struct xhci_hcd *xhci,
343 unsigned int slot_id,
344 unsigned int ep_index)
345{
346 unsigned int stream_id;
347 struct xhci_virt_ep *ep;
348
349 ep = &xhci->devs[slot_id]->eps[ep_index];
350
351 /* A ring has pending URBs if its TD list is not empty */
352 if (!(ep->ep_state & EP_HAS_STREAMS)) {
d66eaf9f 353 if (ep->ring && !(list_empty(&ep->ring->td_list)))
be88fe4f 354 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, 0);
e9df17eb
SS
355 return;
356 }
357
358 for (stream_id = 1; stream_id < ep->stream_info->num_streams;
359 stream_id++) {
360 struct xhci_stream_info *stream_info = ep->stream_info;
361 if (!list_empty(&stream_info->stream_rings[stream_id]->td_list))
be88fe4f
AX
362 xhci_ring_ep_doorbell(xhci, slot_id, ep_index,
363 stream_id);
e9df17eb
SS
364 }
365}
366
021bff91
SS
367static struct xhci_ring *xhci_triad_to_transfer_ring(struct xhci_hcd *xhci,
368 unsigned int slot_id, unsigned int ep_index,
369 unsigned int stream_id)
370{
371 struct xhci_virt_ep *ep;
372
373 ep = &xhci->devs[slot_id]->eps[ep_index];
374 /* Common case: no streams */
375 if (!(ep->ep_state & EP_HAS_STREAMS))
376 return ep->ring;
377
378 if (stream_id == 0) {
379 xhci_warn(xhci,
380 "WARN: Slot ID %u, ep index %u has streams, "
381 "but URB has no stream ID.\n",
382 slot_id, ep_index);
383 return NULL;
384 }
385
386 if (stream_id < ep->stream_info->num_streams)
387 return ep->stream_info->stream_rings[stream_id];
388
389 xhci_warn(xhci,
390 "WARN: Slot ID %u, ep index %u has "
391 "stream IDs 1 to %u allocated, "
392 "but stream ID %u is requested.\n",
393 slot_id, ep_index,
394 ep->stream_info->num_streams - 1,
395 stream_id);
396 return NULL;
397}
398
399/* Get the right ring for the given URB.
400 * If the endpoint supports streams, boundary check the URB's stream ID.
401 * If the endpoint doesn't support streams, return the singular endpoint ring.
402 */
403static struct xhci_ring *xhci_urb_to_transfer_ring(struct xhci_hcd *xhci,
404 struct urb *urb)
405{
406 return xhci_triad_to_transfer_ring(xhci, urb->dev->slot_id,
407 xhci_get_endpoint_index(&urb->ep->desc), urb->stream_id);
408}
409
ae636747
SS
410/*
411 * Move the xHC's endpoint ring dequeue pointer past cur_td.
412 * Record the new state of the xHC's endpoint ring dequeue segment,
413 * dequeue pointer, and new consumer cycle state in state.
414 * Update our internal representation of the ring's dequeue pointer.
415 *
416 * We do this in three jumps:
417 * - First we update our new ring state to be the same as when the xHC stopped.
418 * - Then we traverse the ring to find the segment that contains
419 * the last TRB in the TD. We toggle the xHC's new cycle state when we pass
420 * any link TRBs with the toggle cycle bit set.
421 * - Finally we move the dequeue state one TRB further, toggling the cycle bit
422 * if we've moved it past a link TRB with the toggle cycle bit set.
28ccd296
ME
423 *
424 * Some of the uses of xhci_generic_trb are grotty, but if they're done
425 * with correct __le32 accesses they should work fine. Only users of this are
426 * in here.
ae636747 427 */
c92bcfa7 428void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
ae636747 429 unsigned int slot_id, unsigned int ep_index,
e9df17eb
SS
430 unsigned int stream_id, struct xhci_td *cur_td,
431 struct xhci_dequeue_state *state)
ae636747
SS
432{
433 struct xhci_virt_device *dev = xhci->devs[slot_id];
c4bedb77 434 struct xhci_virt_ep *ep = &dev->eps[ep_index];
e9df17eb 435 struct xhci_ring *ep_ring;
365038d8
MN
436 struct xhci_segment *new_seg;
437 union xhci_trb *new_deq;
c92bcfa7 438 dma_addr_t addr;
1f81b6d2 439 u64 hw_dequeue;
365038d8
MN
440 bool cycle_found = false;
441 bool td_last_trb_found = false;
ae636747 442
e9df17eb
SS
443 ep_ring = xhci_triad_to_transfer_ring(xhci, slot_id,
444 ep_index, stream_id);
445 if (!ep_ring) {
446 xhci_warn(xhci, "WARN can't find new dequeue state "
447 "for invalid stream ID %u.\n",
448 stream_id);
449 return;
450 }
68e41c5d 451
ae636747 452 /* Dig out the cycle state saved by the xHC during the stop ep cmd */
aa50b290
XR
453 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
454 "Finding endpoint context");
c4bedb77
HG
455 /* 4.6.9 the css flag is written to the stream context for streams */
456 if (ep->ep_state & EP_HAS_STREAMS) {
457 struct xhci_stream_ctx *ctx =
458 &ep->stream_info->stream_ctx_array[stream_id];
1f81b6d2 459 hw_dequeue = le64_to_cpu(ctx->stream_ring);
c4bedb77
HG
460 } else {
461 struct xhci_ep_ctx *ep_ctx
462 = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
1f81b6d2 463 hw_dequeue = le64_to_cpu(ep_ctx->deq);
c4bedb77 464 }
ae636747 465
365038d8
MN
466 new_seg = ep_ring->deq_seg;
467 new_deq = ep_ring->dequeue;
468 state->new_cycle_state = hw_dequeue & 0x1;
469
1f81b6d2 470 /*
365038d8
MN
471 * We want to find the pointer, segment and cycle state of the new trb
472 * (the one after current TD's last_trb). We know the cycle state at
473 * hw_dequeue, so walk the ring until both hw_dequeue and last_trb are
474 * found.
1f81b6d2 475 */
365038d8
MN
476 do {
477 if (!cycle_found && xhci_trb_virt_to_dma(new_seg, new_deq)
478 == (dma_addr_t)(hw_dequeue & ~0xf)) {
479 cycle_found = true;
480 if (td_last_trb_found)
481 break;
482 }
483 if (new_deq == cur_td->last_trb)
484 td_last_trb_found = true;
1f81b6d2 485
365038d8
MN
486 if (cycle_found &&
487 TRB_TYPE_LINK_LE32(new_deq->generic.field[3]) &&
488 new_deq->generic.field[3] & cpu_to_le32(LINK_TOGGLE))
489 state->new_cycle_state ^= 0x1;
490
491 next_trb(xhci, ep_ring, &new_seg, &new_deq);
492
493 /* Search wrapped around, bail out */
494 if (new_deq == ep->ring->dequeue) {
495 xhci_err(xhci, "Error: Failed finding new dequeue state\n");
496 state->new_deq_seg = NULL;
497 state->new_deq_ptr = NULL;
498 return;
499 }
500
501 } while (!cycle_found || !td_last_trb_found);
ae636747 502
365038d8
MN
503 state->new_deq_seg = new_seg;
504 state->new_deq_ptr = new_deq;
ae636747 505
1f81b6d2 506 /* Don't update the ring cycle state for the producer (us). */
aa50b290
XR
507 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
508 "Cycle state = 0x%x", state->new_cycle_state);
01a1fdb9 509
aa50b290
XR
510 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
511 "New dequeue segment = %p (virtual)",
c92bcfa7
SS
512 state->new_deq_seg);
513 addr = xhci_trb_virt_to_dma(state->new_deq_seg, state->new_deq_ptr);
aa50b290
XR
514 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
515 "New dequeue pointer = 0x%llx (DMA)",
c92bcfa7 516 (unsigned long long) addr);
ae636747
SS
517}
518
522989a2
SS
519/* flip_cycle means flip the cycle bit of all but the first and last TRB.
520 * (The last TRB actually points to the ring enqueue pointer, which is not part
521 * of this TD.) This is used to remove partially enqueued isoc TDs from a ring.
522 */
23e3be11 523static void td_to_noop(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
522989a2 524 struct xhci_td *cur_td, bool flip_cycle)
ae636747
SS
525{
526 struct xhci_segment *cur_seg;
527 union xhci_trb *cur_trb;
528
529 for (cur_seg = cur_td->start_seg, cur_trb = cur_td->first_trb;
530 true;
531 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
f5960b69 532 if (TRB_TYPE_LINK_LE32(cur_trb->generic.field[3])) {
ae636747
SS
533 /* Unchain any chained Link TRBs, but
534 * leave the pointers intact.
535 */
28ccd296 536 cur_trb->generic.field[3] &= cpu_to_le32(~TRB_CHAIN);
522989a2
SS
537 /* Flip the cycle bit (link TRBs can't be the first
538 * or last TRB).
539 */
540 if (flip_cycle)
541 cur_trb->generic.field[3] ^=
542 cpu_to_le32(TRB_CYCLE);
aa50b290
XR
543 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
544 "Cancel (unchain) link TRB");
545 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
546 "Address = %p (0x%llx dma); "
547 "in seg %p (0x%llx dma)",
700e2052 548 cur_trb,
23e3be11 549 (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
700e2052
GKH
550 cur_seg,
551 (unsigned long long)cur_seg->dma);
ae636747
SS
552 } else {
553 cur_trb->generic.field[0] = 0;
554 cur_trb->generic.field[1] = 0;
555 cur_trb->generic.field[2] = 0;
556 /* Preserve only the cycle bit of this TRB */
28ccd296 557 cur_trb->generic.field[3] &= cpu_to_le32(TRB_CYCLE);
522989a2
SS
558 /* Flip the cycle bit except on the first or last TRB */
559 if (flip_cycle && cur_trb != cur_td->first_trb &&
560 cur_trb != cur_td->last_trb)
561 cur_trb->generic.field[3] ^=
562 cpu_to_le32(TRB_CYCLE);
28ccd296
ME
563 cur_trb->generic.field[3] |= cpu_to_le32(
564 TRB_TYPE(TRB_TR_NOOP));
aa50b290
XR
565 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
566 "TRB to noop at offset 0x%llx",
79688acf
SS
567 (unsigned long long)
568 xhci_trb_virt_to_dma(cur_seg, cur_trb));
ae636747
SS
569 }
570 if (cur_trb == cur_td->last_trb)
571 break;
572 }
573}
574
1e3452e3 575static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
e9df17eb
SS
576 unsigned int ep_index, unsigned int stream_id,
577 struct xhci_segment *deq_seg,
ae636747
SS
578 union xhci_trb *deq_ptr, u32 cycle_state);
579
c92bcfa7 580void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
63a0d9ab 581 unsigned int slot_id, unsigned int ep_index,
e9df17eb 582 unsigned int stream_id,
63a0d9ab 583 struct xhci_dequeue_state *deq_state)
c92bcfa7 584{
63a0d9ab
SS
585 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
586
aa50b290
XR
587 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
588 "Set TR Deq Ptr cmd, new deq seg = %p (0x%llx dma), "
589 "new deq ptr = %p (0x%llx dma), new cycle = %u",
c92bcfa7
SS
590 deq_state->new_deq_seg,
591 (unsigned long long)deq_state->new_deq_seg->dma,
592 deq_state->new_deq_ptr,
593 (unsigned long long)xhci_trb_virt_to_dma(deq_state->new_deq_seg, deq_state->new_deq_ptr),
594 deq_state->new_cycle_state);
1e3452e3 595 queue_set_tr_deq(xhci, slot_id, ep_index, stream_id,
c92bcfa7
SS
596 deq_state->new_deq_seg,
597 deq_state->new_deq_ptr,
598 (u32) deq_state->new_cycle_state);
599 /* Stop the TD queueing code from ringing the doorbell until
600 * this command completes. The HC won't set the dequeue pointer
601 * if the ring is running, and ringing the doorbell starts the
602 * ring running.
603 */
63a0d9ab 604 ep->ep_state |= SET_DEQ_PENDING;
c92bcfa7
SS
605}
606
575688e1 607static void xhci_stop_watchdog_timer_in_irq(struct xhci_hcd *xhci,
6f5165cf
SS
608 struct xhci_virt_ep *ep)
609{
610 ep->ep_state &= ~EP_HALT_PENDING;
611 /* Can't del_timer_sync in interrupt, so we attempt to cancel. If the
612 * timer is running on another CPU, we don't decrement stop_cmds_pending
613 * (since we didn't successfully stop the watchdog timer).
614 */
615 if (del_timer(&ep->stop_cmd_timer))
616 ep->stop_cmds_pending--;
617}
618
619/* Must be called with xhci->lock held in interrupt context */
620static void xhci_giveback_urb_in_irq(struct xhci_hcd *xhci,
07a37e9e 621 struct xhci_td *cur_td, int status)
6f5165cf 622{
214f76f7 623 struct usb_hcd *hcd;
8e51adcc
AX
624 struct urb *urb;
625 struct urb_priv *urb_priv;
6f5165cf 626
8e51adcc
AX
627 urb = cur_td->urb;
628 urb_priv = urb->hcpriv;
629 urb_priv->td_cnt++;
214f76f7 630 hcd = bus_to_hcd(urb->dev->bus);
6f5165cf 631
8e51adcc
AX
632 /* Only giveback urb when this is the last td in urb */
633 if (urb_priv->td_cnt == urb_priv->length) {
c41136b0
AX
634 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
635 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs--;
636 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs == 0) {
637 if (xhci->quirks & XHCI_AMD_PLL_FIX)
638 usb_amd_quirk_pll_enable();
639 }
640 }
8e51adcc 641 usb_hcd_unlink_urb_from_ep(hcd, urb);
8e51adcc
AX
642
643 spin_unlock(&xhci->lock);
644 usb_hcd_giveback_urb(hcd, urb, status);
645 xhci_urb_free_priv(xhci, urb_priv);
646 spin_lock(&xhci->lock);
8e51adcc 647 }
6f5165cf
SS
648}
649
ae636747
SS
650/*
651 * When we get a command completion for a Stop Endpoint Command, we need to
652 * unlink any cancelled TDs from the ring. There are two ways to do that:
653 *
654 * 1. If the HW was in the middle of processing the TD that needs to be
655 * cancelled, then we must move the ring's dequeue pointer past the last TRB
656 * in the TD with a Set Dequeue Pointer Command.
657 * 2. Otherwise, we turn all the TRBs in the TD into No-op TRBs (with the chain
658 * bit cleared) so that the HW will skip over them.
659 */
b8200c94 660static void xhci_handle_cmd_stop_ep(struct xhci_hcd *xhci, int slot_id,
be88fe4f 661 union xhci_trb *trb, struct xhci_event_cmd *event)
ae636747 662{
ae636747
SS
663 unsigned int ep_index;
664 struct xhci_ring *ep_ring;
63a0d9ab 665 struct xhci_virt_ep *ep;
ae636747 666 struct list_head *entry;
326b4810 667 struct xhci_td *cur_td = NULL;
ae636747
SS
668 struct xhci_td *last_unlinked_td;
669
c92bcfa7 670 struct xhci_dequeue_state deq_state;
ae636747 671
bc752bde 672 if (unlikely(TRB_TO_SUSPEND_PORT(le32_to_cpu(trb->generic.field[3])))) {
9ea1833e 673 if (!xhci->devs[slot_id])
be88fe4f
AX
674 xhci_warn(xhci, "Stop endpoint command "
675 "completion for disabled slot %u\n",
676 slot_id);
677 return;
678 }
679
ae636747 680 memset(&deq_state, 0, sizeof(deq_state));
28ccd296 681 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
63a0d9ab 682 ep = &xhci->devs[slot_id]->eps[ep_index];
ae636747 683
678539cf 684 if (list_empty(&ep->cancelled_td_list)) {
6f5165cf 685 xhci_stop_watchdog_timer_in_irq(xhci, ep);
0714a57c 686 ep->stopped_td = NULL;
e9df17eb 687 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
ae636747 688 return;
678539cf 689 }
ae636747
SS
690
691 /* Fix up the ep ring first, so HW stops executing cancelled TDs.
692 * We have the xHCI lock, so nothing can modify this list until we drop
693 * it. We're also in the event handler, so we can't get re-interrupted
694 * if another Stop Endpoint command completes
695 */
63a0d9ab 696 list_for_each(entry, &ep->cancelled_td_list) {
ae636747 697 cur_td = list_entry(entry, struct xhci_td, cancelled_td_list);
aa50b290
XR
698 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
699 "Removing canceled TD starting at 0x%llx (dma).",
79688acf
SS
700 (unsigned long long)xhci_trb_virt_to_dma(
701 cur_td->start_seg, cur_td->first_trb));
e9df17eb
SS
702 ep_ring = xhci_urb_to_transfer_ring(xhci, cur_td->urb);
703 if (!ep_ring) {
704 /* This shouldn't happen unless a driver is mucking
705 * with the stream ID after submission. This will
706 * leave the TD on the hardware ring, and the hardware
707 * will try to execute it, and may access a buffer
708 * that has already been freed. In the best case, the
709 * hardware will execute it, and the event handler will
710 * ignore the completion event for that TD, since it was
711 * removed from the td_list for that endpoint. In
712 * short, don't muck with the stream ID after
713 * submission.
714 */
715 xhci_warn(xhci, "WARN Cancelled URB %p "
716 "has invalid stream ID %u.\n",
717 cur_td->urb,
718 cur_td->urb->stream_id);
719 goto remove_finished_td;
720 }
ae636747
SS
721 /*
722 * If we stopped on the TD we need to cancel, then we have to
723 * move the xHC endpoint ring dequeue pointer past this TD.
724 */
63a0d9ab 725 if (cur_td == ep->stopped_td)
e9df17eb
SS
726 xhci_find_new_dequeue_state(xhci, slot_id, ep_index,
727 cur_td->urb->stream_id,
728 cur_td, &deq_state);
ae636747 729 else
522989a2 730 td_to_noop(xhci, ep_ring, cur_td, false);
e9df17eb 731remove_finished_td:
ae636747
SS
732 /*
733 * The event handler won't see a completion for this TD anymore,
734 * so remove it from the endpoint ring's TD list. Keep it in
735 * the cancelled TD list for URB completion later.
736 */
585df1d9 737 list_del_init(&cur_td->td_list);
ae636747
SS
738 }
739 last_unlinked_td = cur_td;
6f5165cf 740 xhci_stop_watchdog_timer_in_irq(xhci, ep);
ae636747
SS
741
742 /* If necessary, queue a Set Transfer Ring Dequeue Pointer command */
743 if (deq_state.new_deq_ptr && deq_state.new_deq_seg) {
1e3452e3
HG
744 xhci_queue_new_dequeue_state(xhci, slot_id, ep_index,
745 ep->stopped_td->urb->stream_id, &deq_state);
ac9d8fe7 746 xhci_ring_cmd_db(xhci);
ae636747 747 } else {
e9df17eb
SS
748 /* Otherwise ring the doorbell(s) to restart queued transfers */
749 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
ae636747 750 }
526867c3 751
1f81b6d2
JW
752 /* Clear stopped_td if endpoint is not halted */
753 if (!(ep->ep_state & EP_HALTED))
526867c3 754 ep->stopped_td = NULL;
ae636747
SS
755
756 /*
757 * Drop the lock and complete the URBs in the cancelled TD list.
758 * New TDs to be cancelled might be added to the end of the list before
759 * we can complete all the URBs for the TDs we already unlinked.
760 * So stop when we've completed the URB for the last TD we unlinked.
761 */
762 do {
63a0d9ab 763 cur_td = list_entry(ep->cancelled_td_list.next,
ae636747 764 struct xhci_td, cancelled_td_list);
585df1d9 765 list_del_init(&cur_td->cancelled_td_list);
ae636747
SS
766
767 /* Clean up the cancelled URB */
ae636747
SS
768 /* Doesn't matter what we pass for status, since the core will
769 * just overwrite it (because the URB has been unlinked).
770 */
07a37e9e 771 xhci_giveback_urb_in_irq(xhci, cur_td, 0);
ae636747 772
6f5165cf
SS
773 /* Stop processing the cancelled list if the watchdog timer is
774 * running.
775 */
776 if (xhci->xhc_state & XHCI_STATE_DYING)
777 return;
ae636747
SS
778 } while (cur_td != last_unlinked_td);
779
780 /* Return to the event handler with xhci->lock re-acquired */
781}
782
50e8725e
SS
783static void xhci_kill_ring_urbs(struct xhci_hcd *xhci, struct xhci_ring *ring)
784{
785 struct xhci_td *cur_td;
786
787 while (!list_empty(&ring->td_list)) {
788 cur_td = list_first_entry(&ring->td_list,
789 struct xhci_td, td_list);
790 list_del_init(&cur_td->td_list);
791 if (!list_empty(&cur_td->cancelled_td_list))
792 list_del_init(&cur_td->cancelled_td_list);
793 xhci_giveback_urb_in_irq(xhci, cur_td, -ESHUTDOWN);
794 }
795}
796
797static void xhci_kill_endpoint_urbs(struct xhci_hcd *xhci,
798 int slot_id, int ep_index)
799{
800 struct xhci_td *cur_td;
801 struct xhci_virt_ep *ep;
802 struct xhci_ring *ring;
803
804 ep = &xhci->devs[slot_id]->eps[ep_index];
21d0e51b
SS
805 if ((ep->ep_state & EP_HAS_STREAMS) ||
806 (ep->ep_state & EP_GETTING_NO_STREAMS)) {
807 int stream_id;
808
809 for (stream_id = 0; stream_id < ep->stream_info->num_streams;
810 stream_id++) {
811 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
812 "Killing URBs for slot ID %u, ep index %u, stream %u",
813 slot_id, ep_index, stream_id + 1);
814 xhci_kill_ring_urbs(xhci,
815 ep->stream_info->stream_rings[stream_id]);
816 }
817 } else {
818 ring = ep->ring;
819 if (!ring)
820 return;
821 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
822 "Killing URBs for slot ID %u, ep index %u",
823 slot_id, ep_index);
824 xhci_kill_ring_urbs(xhci, ring);
825 }
50e8725e
SS
826 while (!list_empty(&ep->cancelled_td_list)) {
827 cur_td = list_first_entry(&ep->cancelled_td_list,
828 struct xhci_td, cancelled_td_list);
829 list_del_init(&cur_td->cancelled_td_list);
830 xhci_giveback_urb_in_irq(xhci, cur_td, -ESHUTDOWN);
831 }
832}
833
6f5165cf
SS
834/* Watchdog timer function for when a stop endpoint command fails to complete.
835 * In this case, we assume the host controller is broken or dying or dead. The
836 * host may still be completing some other events, so we have to be careful to
837 * let the event ring handler and the URB dequeueing/enqueueing functions know
838 * through xhci->state.
839 *
840 * The timer may also fire if the host takes a very long time to respond to the
841 * command, and the stop endpoint command completion handler cannot delete the
842 * timer before the timer function is called. Another endpoint cancellation may
843 * sneak in before the timer function can grab the lock, and that may queue
844 * another stop endpoint command and add the timer back. So we cannot use a
845 * simple flag to say whether there is a pending stop endpoint command for a
846 * particular endpoint.
847 *
848 * Instead we use a combination of that flag and a counter for the number of
849 * pending stop endpoint commands. If the timer is the tail end of the last
850 * stop endpoint command, and the endpoint's command is still pending, we assume
851 * the host is dying.
852 */
853void xhci_stop_endpoint_command_watchdog(unsigned long arg)
854{
855 struct xhci_hcd *xhci;
856 struct xhci_virt_ep *ep;
6f5165cf 857 int ret, i, j;
f43d6231 858 unsigned long flags;
6f5165cf
SS
859
860 ep = (struct xhci_virt_ep *) arg;
861 xhci = ep->xhci;
862
f43d6231 863 spin_lock_irqsave(&xhci->lock, flags);
6f5165cf
SS
864
865 ep->stop_cmds_pending--;
866 if (xhci->xhc_state & XHCI_STATE_DYING) {
aa50b290
XR
867 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
868 "Stop EP timer ran, but another timer marked "
869 "xHCI as DYING, exiting.");
f43d6231 870 spin_unlock_irqrestore(&xhci->lock, flags);
6f5165cf
SS
871 return;
872 }
873 if (!(ep->stop_cmds_pending == 0 && (ep->ep_state & EP_HALT_PENDING))) {
aa50b290
XR
874 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
875 "Stop EP timer ran, but no command pending, "
876 "exiting.");
f43d6231 877 spin_unlock_irqrestore(&xhci->lock, flags);
6f5165cf
SS
878 return;
879 }
880
881 xhci_warn(xhci, "xHCI host not responding to stop endpoint command.\n");
882 xhci_warn(xhci, "Assuming host is dying, halting host.\n");
883 /* Oops, HC is dead or dying or at least not responding to the stop
884 * endpoint command.
885 */
886 xhci->xhc_state |= XHCI_STATE_DYING;
887 /* Disable interrupts from the host controller and start halting it */
888 xhci_quiesce(xhci);
f43d6231 889 spin_unlock_irqrestore(&xhci->lock, flags);
6f5165cf
SS
890
891 ret = xhci_halt(xhci);
892
f43d6231 893 spin_lock_irqsave(&xhci->lock, flags);
6f5165cf
SS
894 if (ret < 0) {
895 /* This is bad; the host is not responding to commands and it's
896 * not allowing itself to be halted. At least interrupts are
ac04e6ff 897 * disabled. If we call usb_hc_died(), it will attempt to
6f5165cf
SS
898 * disconnect all device drivers under this host. Those
899 * disconnect() methods will wait for all URBs to be unlinked,
900 * so we must complete them.
901 */
902 xhci_warn(xhci, "Non-responsive xHCI host is not halting.\n");
903 xhci_warn(xhci, "Completing active URBs anyway.\n");
904 /* We could turn all TDs on the rings to no-ops. This won't
905 * help if the host has cached part of the ring, and is slow if
906 * we want to preserve the cycle bit. Skip it and hope the host
907 * doesn't touch the memory.
908 */
909 }
910 for (i = 0; i < MAX_HC_SLOTS; i++) {
911 if (!xhci->devs[i])
912 continue;
50e8725e
SS
913 for (j = 0; j < 31; j++)
914 xhci_kill_endpoint_urbs(xhci, i, j);
6f5165cf 915 }
f43d6231 916 spin_unlock_irqrestore(&xhci->lock, flags);
aa50b290
XR
917 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
918 "Calling usb_hc_died()");
f6ff0ac8 919 usb_hc_died(xhci_to_hcd(xhci)->primary_hcd);
aa50b290
XR
920 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
921 "xHCI host controller is dead.");
6f5165cf
SS
922}
923
b008df60
AX
924
925static void update_ring_for_set_deq_completion(struct xhci_hcd *xhci,
926 struct xhci_virt_device *dev,
927 struct xhci_ring *ep_ring,
928 unsigned int ep_index)
929{
930 union xhci_trb *dequeue_temp;
931 int num_trbs_free_temp;
932 bool revert = false;
933
934 num_trbs_free_temp = ep_ring->num_trbs_free;
935 dequeue_temp = ep_ring->dequeue;
936
0d9f78a9
SS
937 /* If we get two back-to-back stalls, and the first stalled transfer
938 * ends just before a link TRB, the dequeue pointer will be left on
939 * the link TRB by the code in the while loop. So we have to update
940 * the dequeue pointer one segment further, or we'll jump off
941 * the segment into la-la-land.
942 */
943 if (last_trb(xhci, ep_ring, ep_ring->deq_seg, ep_ring->dequeue)) {
944 ep_ring->deq_seg = ep_ring->deq_seg->next;
945 ep_ring->dequeue = ep_ring->deq_seg->trbs;
946 }
947
b008df60
AX
948 while (ep_ring->dequeue != dev->eps[ep_index].queued_deq_ptr) {
949 /* We have more usable TRBs */
950 ep_ring->num_trbs_free++;
951 ep_ring->dequeue++;
952 if (last_trb(xhci, ep_ring, ep_ring->deq_seg,
953 ep_ring->dequeue)) {
954 if (ep_ring->dequeue ==
955 dev->eps[ep_index].queued_deq_ptr)
956 break;
957 ep_ring->deq_seg = ep_ring->deq_seg->next;
958 ep_ring->dequeue = ep_ring->deq_seg->trbs;
959 }
960 if (ep_ring->dequeue == dequeue_temp) {
961 revert = true;
962 break;
963 }
964 }
965
966 if (revert) {
967 xhci_dbg(xhci, "Unable to find new dequeue pointer\n");
968 ep_ring->num_trbs_free = num_trbs_free_temp;
969 }
970}
971
ae636747
SS
972/*
973 * When we get a completion for a Set Transfer Ring Dequeue Pointer command,
974 * we need to clear the set deq pending flag in the endpoint ring state, so that
975 * the TD queueing code can ring the doorbell again. We also need to ring the
976 * endpoint doorbell to restart the ring, but only if there aren't more
977 * cancellations pending.
978 */
b8200c94 979static void xhci_handle_cmd_set_deq(struct xhci_hcd *xhci, int slot_id,
c69a0597 980 union xhci_trb *trb, u32 cmd_comp_code)
ae636747 981{
ae636747 982 unsigned int ep_index;
e9df17eb 983 unsigned int stream_id;
ae636747
SS
984 struct xhci_ring *ep_ring;
985 struct xhci_virt_device *dev;
9aad95e2 986 struct xhci_virt_ep *ep;
d115b048
JY
987 struct xhci_ep_ctx *ep_ctx;
988 struct xhci_slot_ctx *slot_ctx;
ae636747 989
28ccd296
ME
990 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
991 stream_id = TRB_TO_STREAM_ID(le32_to_cpu(trb->generic.field[2]));
ae636747 992 dev = xhci->devs[slot_id];
9aad95e2 993 ep = &dev->eps[ep_index];
e9df17eb
SS
994
995 ep_ring = xhci_stream_id_to_ring(dev, ep_index, stream_id);
996 if (!ep_ring) {
e587b8b2 997 xhci_warn(xhci, "WARN Set TR deq ptr command for freed stream ID %u\n",
e9df17eb
SS
998 stream_id);
999 /* XXX: Harmless??? */
1000 dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
1001 return;
1002 }
1003
d115b048
JY
1004 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
1005 slot_ctx = xhci_get_slot_ctx(xhci, dev->out_ctx);
ae636747 1006
c69a0597 1007 if (cmd_comp_code != COMP_SUCCESS) {
ae636747
SS
1008 unsigned int ep_state;
1009 unsigned int slot_state;
1010
c69a0597 1011 switch (cmd_comp_code) {
ae636747 1012 case COMP_TRB_ERR:
e587b8b2 1013 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd invalid because of stream ID configuration\n");
ae636747
SS
1014 break;
1015 case COMP_CTX_STATE:
e587b8b2 1016 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed due to incorrect slot or ep state.\n");
28ccd296 1017 ep_state = le32_to_cpu(ep_ctx->ep_info);
ae636747 1018 ep_state &= EP_STATE_MASK;
28ccd296 1019 slot_state = le32_to_cpu(slot_ctx->dev_state);
ae636747 1020 slot_state = GET_SLOT_STATE(slot_state);
aa50b290
XR
1021 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
1022 "Slot state = %u, EP state = %u",
ae636747
SS
1023 slot_state, ep_state);
1024 break;
1025 case COMP_EBADSLT:
e587b8b2
ON
1026 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed because slot %u was not enabled.\n",
1027 slot_id);
ae636747
SS
1028 break;
1029 default:
e587b8b2
ON
1030 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd with unknown completion code of %u.\n",
1031 cmd_comp_code);
ae636747
SS
1032 break;
1033 }
1034 /* OK what do we do now? The endpoint state is hosed, and we
1035 * should never get to this point if the synchronization between
1036 * queueing, and endpoint state are correct. This might happen
1037 * if the device gets disconnected after we've finished
1038 * cancelling URBs, which might not be an error...
1039 */
1040 } else {
9aad95e2
HG
1041 u64 deq;
1042 /* 4.6.10 deq ptr is written to the stream ctx for streams */
1043 if (ep->ep_state & EP_HAS_STREAMS) {
1044 struct xhci_stream_ctx *ctx =
1045 &ep->stream_info->stream_ctx_array[stream_id];
1046 deq = le64_to_cpu(ctx->stream_ring) & SCTX_DEQ_MASK;
1047 } else {
1048 deq = le64_to_cpu(ep_ctx->deq) & ~EP_CTX_CYCLE_MASK;
1049 }
aa50b290 1050 xhci_dbg_trace(xhci, trace_xhci_dbg_cancel_urb,
9aad95e2
HG
1051 "Successful Set TR Deq Ptr cmd, deq = @%08llx", deq);
1052 if (xhci_trb_virt_to_dma(ep->queued_deq_seg,
1053 ep->queued_deq_ptr) == deq) {
bf161e85
SS
1054 /* Update the ring's dequeue segment and dequeue pointer
1055 * to reflect the new position.
1056 */
b008df60
AX
1057 update_ring_for_set_deq_completion(xhci, dev,
1058 ep_ring, ep_index);
bf161e85 1059 } else {
e587b8b2 1060 xhci_warn(xhci, "Mismatch between completed Set TR Deq Ptr command & xHCI internal state.\n");
bf161e85 1061 xhci_warn(xhci, "ep deq seg = %p, deq ptr = %p\n",
9aad95e2 1062 ep->queued_deq_seg, ep->queued_deq_ptr);
bf161e85 1063 }
ae636747
SS
1064 }
1065
63a0d9ab 1066 dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
bf161e85
SS
1067 dev->eps[ep_index].queued_deq_seg = NULL;
1068 dev->eps[ep_index].queued_deq_ptr = NULL;
e9df17eb
SS
1069 /* Restart any rings with pending URBs */
1070 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
ae636747
SS
1071}
1072
b8200c94 1073static void xhci_handle_cmd_reset_ep(struct xhci_hcd *xhci, int slot_id,
c69a0597 1074 union xhci_trb *trb, u32 cmd_comp_code)
a1587d97 1075{
a1587d97
SS
1076 unsigned int ep_index;
1077
28ccd296 1078 ep_index = TRB_TO_EP_INDEX(le32_to_cpu(trb->generic.field[3]));
a1587d97
SS
1079 /* This command will only fail if the endpoint wasn't halted,
1080 * but we don't care.
1081 */
a0254324 1082 xhci_dbg_trace(xhci, trace_xhci_dbg_reset_ep,
c69a0597 1083 "Ignoring reset ep completion code of %u", cmd_comp_code);
a1587d97 1084
ac9d8fe7
SS
1085 /* HW with the reset endpoint quirk needs to have a configure endpoint
1086 * command complete before the endpoint can be used. Queue that here
1087 * because the HW can't handle two commands being queued in a row.
1088 */
1089 if (xhci->quirks & XHCI_RESET_EP_QUIRK) {
ddba5cd0
MN
1090 struct xhci_command *command;
1091 command = xhci_alloc_command(xhci, false, false, GFP_ATOMIC);
a0ee619f
HG
1092 if (!command) {
1093 xhci_warn(xhci, "WARN Cannot submit cfg ep: ENOMEM\n");
1094 return;
1095 }
4bdfe4c3
XR
1096 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
1097 "Queueing configure endpoint command");
ddba5cd0 1098 xhci_queue_configure_endpoint(xhci, command,
913a8a34
SS
1099 xhci->devs[slot_id]->in_ctx->dma, slot_id,
1100 false);
ac9d8fe7
SS
1101 xhci_ring_cmd_db(xhci);
1102 } else {
e9df17eb 1103 /* Clear our internal halted state and restart the ring(s) */
63a0d9ab 1104 xhci->devs[slot_id]->eps[ep_index].ep_state &= ~EP_HALTED;
e9df17eb 1105 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
ac9d8fe7 1106 }
a1587d97 1107}
ae636747 1108
b244b431
XR
1109static void xhci_handle_cmd_enable_slot(struct xhci_hcd *xhci, int slot_id,
1110 u32 cmd_comp_code)
1111{
1112 if (cmd_comp_code == COMP_SUCCESS)
1113 xhci->slot_id = slot_id;
1114 else
1115 xhci->slot_id = 0;
b244b431
XR
1116}
1117
6c02dd14
XR
1118static void xhci_handle_cmd_disable_slot(struct xhci_hcd *xhci, int slot_id)
1119{
1120 struct xhci_virt_device *virt_dev;
1121
1122 virt_dev = xhci->devs[slot_id];
1123 if (!virt_dev)
1124 return;
1125 if (xhci->quirks & XHCI_EP_LIMIT_QUIRK)
1126 /* Delete default control endpoint resources */
1127 xhci_free_device_endpoint_resources(xhci, virt_dev, true);
1128 xhci_free_virt_device(xhci, slot_id);
1129}
1130
6ed46d33
XR
1131static void xhci_handle_cmd_config_ep(struct xhci_hcd *xhci, int slot_id,
1132 struct xhci_event_cmd *event, u32 cmd_comp_code)
1133{
1134 struct xhci_virt_device *virt_dev;
1135 struct xhci_input_control_ctx *ctrl_ctx;
1136 unsigned int ep_index;
1137 unsigned int ep_state;
1138 u32 add_flags, drop_flags;
1139
6ed46d33
XR
1140 /*
1141 * Configure endpoint commands can come from the USB core
1142 * configuration or alt setting changes, or because the HW
1143 * needed an extra configure endpoint command after a reset
1144 * endpoint command or streams were being configured.
1145 * If the command was for a halted endpoint, the xHCI driver
1146 * is not waiting on the configure endpoint command.
1147 */
9ea1833e 1148 virt_dev = xhci->devs[slot_id];
6ed46d33
XR
1149 ctrl_ctx = xhci_get_input_control_ctx(xhci, virt_dev->in_ctx);
1150 if (!ctrl_ctx) {
1151 xhci_warn(xhci, "Could not get input context, bad type.\n");
1152 return;
1153 }
1154
1155 add_flags = le32_to_cpu(ctrl_ctx->add_flags);
1156 drop_flags = le32_to_cpu(ctrl_ctx->drop_flags);
1157 /* Input ctx add_flags are the endpoint index plus one */
1158 ep_index = xhci_last_valid_endpoint(add_flags) - 1;
1159
1160 /* A usb_set_interface() call directly after clearing a halted
1161 * condition may race on this quirky hardware. Not worth
1162 * worrying about, since this is prototype hardware. Not sure
1163 * if this will work for streams, but streams support was
1164 * untested on this prototype.
1165 */
1166 if (xhci->quirks & XHCI_RESET_EP_QUIRK &&
1167 ep_index != (unsigned int) -1 &&
1168 add_flags - SLOT_FLAG == drop_flags) {
1169 ep_state = virt_dev->eps[ep_index].ep_state;
1170 if (!(ep_state & EP_HALTED))
ddba5cd0 1171 return;
6ed46d33
XR
1172 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
1173 "Completed config ep cmd - "
1174 "last ep index = %d, state = %d",
1175 ep_index, ep_state);
1176 /* Clear internal halted state and restart ring(s) */
1177 virt_dev->eps[ep_index].ep_state &= ~EP_HALTED;
1178 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
1179 return;
1180 }
6ed46d33
XR
1181 return;
1182}
1183
f681321b
XR
1184static void xhci_handle_cmd_reset_dev(struct xhci_hcd *xhci, int slot_id,
1185 struct xhci_event_cmd *event)
1186{
f681321b 1187 xhci_dbg(xhci, "Completed reset device command.\n");
9ea1833e 1188 if (!xhci->devs[slot_id])
f681321b
XR
1189 xhci_warn(xhci, "Reset device command completion "
1190 "for disabled slot %u\n", slot_id);
1191}
1192
2c070821
XR
1193static void xhci_handle_cmd_nec_get_fw(struct xhci_hcd *xhci,
1194 struct xhci_event_cmd *event)
1195{
1196 if (!(xhci->quirks & XHCI_NEC_HOST)) {
1197 xhci->error_bitmask |= 1 << 6;
1198 return;
1199 }
1200 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
1201 "NEC firmware version %2x.%02x",
1202 NEC_FW_MAJOR(le32_to_cpu(event->status)),
1203 NEC_FW_MINOR(le32_to_cpu(event->status)));
1204}
1205
9ea1833e 1206static void xhci_complete_del_and_free_cmd(struct xhci_command *cmd, u32 status)
c9aa1a2d
MN
1207{
1208 list_del(&cmd->cmd_list);
9ea1833e
MN
1209
1210 if (cmd->completion) {
1211 cmd->status = status;
1212 complete(cmd->completion);
1213 } else {
c9aa1a2d 1214 kfree(cmd);
9ea1833e 1215 }
c9aa1a2d
MN
1216}
1217
1218void xhci_cleanup_command_queue(struct xhci_hcd *xhci)
1219{
1220 struct xhci_command *cur_cmd, *tmp_cmd;
1221 list_for_each_entry_safe(cur_cmd, tmp_cmd, &xhci->cmd_list, cmd_list)
9ea1833e 1222 xhci_complete_del_and_free_cmd(cur_cmd, COMP_CMD_ABORT);
c9aa1a2d
MN
1223}
1224
c311e391
MN
1225/*
1226 * Turn all commands on command ring with status set to "aborted" to no-op trbs.
1227 * If there are other commands waiting then restart the ring and kick the timer.
1228 * This must be called with command ring stopped and xhci->lock held.
1229 */
1230static void xhci_handle_stopped_cmd_ring(struct xhci_hcd *xhci,
1231 struct xhci_command *cur_cmd)
1232{
1233 struct xhci_command *i_cmd, *tmp_cmd;
1234 u32 cycle_state;
1235
1236 /* Turn all aborted commands in list to no-ops, then restart */
1237 list_for_each_entry_safe(i_cmd, tmp_cmd, &xhci->cmd_list,
1238 cmd_list) {
1239
1240 if (i_cmd->status != COMP_CMD_ABORT)
1241 continue;
1242
1243 i_cmd->status = COMP_CMD_STOP;
1244
1245 xhci_dbg(xhci, "Turn aborted command %p to no-op\n",
1246 i_cmd->command_trb);
1247 /* get cycle state from the original cmd trb */
1248 cycle_state = le32_to_cpu(
1249 i_cmd->command_trb->generic.field[3]) & TRB_CYCLE;
1250 /* modify the command trb to no-op command */
1251 i_cmd->command_trb->generic.field[0] = 0;
1252 i_cmd->command_trb->generic.field[1] = 0;
1253 i_cmd->command_trb->generic.field[2] = 0;
1254 i_cmd->command_trb->generic.field[3] = cpu_to_le32(
1255 TRB_TYPE(TRB_CMD_NOOP) | cycle_state);
1256
1257 /*
1258 * caller waiting for completion is called when command
1259 * completion event is received for these no-op commands
1260 */
1261 }
1262
1263 xhci->cmd_ring_state = CMD_RING_STATE_RUNNING;
1264
1265 /* ring command ring doorbell to restart the command ring */
1266 if ((xhci->cmd_ring->dequeue != xhci->cmd_ring->enqueue) &&
1267 !(xhci->xhc_state & XHCI_STATE_DYING)) {
1268 xhci->current_cmd = cur_cmd;
1269 mod_timer(&xhci->cmd_timer, jiffies + XHCI_CMD_DEFAULT_TIMEOUT);
1270 xhci_ring_cmd_db(xhci);
1271 }
1272 return;
1273}
1274
1275
1276void xhci_handle_command_timeout(unsigned long data)
1277{
1278 struct xhci_hcd *xhci;
1279 int ret;
1280 unsigned long flags;
1281 u64 hw_ring_state;
1282 struct xhci_command *cur_cmd = NULL;
1283 xhci = (struct xhci_hcd *) data;
1284
1285 /* mark this command to be cancelled */
1286 spin_lock_irqsave(&xhci->lock, flags);
1287 if (xhci->current_cmd) {
1288 cur_cmd = xhci->current_cmd;
1289 cur_cmd->status = COMP_CMD_ABORT;
1290 }
1291
1292
1293 /* Make sure command ring is running before aborting it */
1294 hw_ring_state = xhci_read_64(xhci, &xhci->op_regs->cmd_ring);
1295 if ((xhci->cmd_ring_state & CMD_RING_STATE_RUNNING) &&
1296 (hw_ring_state & CMD_RING_RUNNING)) {
1297
1298 spin_unlock_irqrestore(&xhci->lock, flags);
1299 xhci_dbg(xhci, "Command timeout\n");
1300 ret = xhci_abort_cmd_ring(xhci);
1301 if (unlikely(ret == -ESHUTDOWN)) {
1302 xhci_err(xhci, "Abort command ring failed\n");
1303 xhci_cleanup_command_queue(xhci);
1304 usb_hc_died(xhci_to_hcd(xhci)->primary_hcd);
1305 xhci_dbg(xhci, "xHCI host controller is dead.\n");
1306 }
1307 return;
1308 }
1309 /* command timeout on stopped ring, ring can't be aborted */
1310 xhci_dbg(xhci, "Command timeout on stopped ring\n");
1311 xhci_handle_stopped_cmd_ring(xhci, xhci->current_cmd);
1312 spin_unlock_irqrestore(&xhci->lock, flags);
1313 return;
1314}
1315
7f84eef0
SS
1316static void handle_cmd_completion(struct xhci_hcd *xhci,
1317 struct xhci_event_cmd *event)
1318{
28ccd296 1319 int slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
7f84eef0
SS
1320 u64 cmd_dma;
1321 dma_addr_t cmd_dequeue_dma;
e7a79a1d 1322 u32 cmd_comp_code;
9124b121 1323 union xhci_trb *cmd_trb;
c9aa1a2d 1324 struct xhci_command *cmd;
b54fc46d 1325 u32 cmd_type;
7f84eef0 1326
28ccd296 1327 cmd_dma = le64_to_cpu(event->cmd_trb);
9124b121 1328 cmd_trb = xhci->cmd_ring->dequeue;
23e3be11 1329 cmd_dequeue_dma = xhci_trb_virt_to_dma(xhci->cmd_ring->deq_seg,
9124b121 1330 cmd_trb);
7f84eef0
SS
1331 /* Is the command ring deq ptr out of sync with the deq seg ptr? */
1332 if (cmd_dequeue_dma == 0) {
1333 xhci->error_bitmask |= 1 << 4;
1334 return;
1335 }
1336 /* Does the DMA address match our internal dequeue pointer address? */
1337 if (cmd_dma != (u64) cmd_dequeue_dma) {
1338 xhci->error_bitmask |= 1 << 5;
1339 return;
1340 }
b63f4053 1341
c9aa1a2d
MN
1342 cmd = list_entry(xhci->cmd_list.next, struct xhci_command, cmd_list);
1343
1344 if (cmd->command_trb != xhci->cmd_ring->dequeue) {
1345 xhci_err(xhci,
1346 "Command completion event does not match command\n");
1347 return;
1348 }
c311e391
MN
1349
1350 del_timer(&xhci->cmd_timer);
1351
9124b121 1352 trace_xhci_cmd_completion(cmd_trb, (struct xhci_generic_trb *) event);
63a23b9a 1353
e7a79a1d 1354 cmd_comp_code = GET_COMP_CODE(le32_to_cpu(event->status));
c311e391
MN
1355
1356 /* If CMD ring stopped we own the trbs between enqueue and dequeue */
1357 if (cmd_comp_code == COMP_CMD_STOP) {
1358 xhci_handle_stopped_cmd_ring(xhci, cmd);
1359 return;
1360 }
1361 /*
1362 * Host aborted the command ring, check if the current command was
1363 * supposed to be aborted, otherwise continue normally.
1364 * The command ring is stopped now, but the xHC will issue a Command
1365 * Ring Stopped event which will cause us to restart it.
1366 */
1367 if (cmd_comp_code == COMP_CMD_ABORT) {
1368 xhci->cmd_ring_state = CMD_RING_STATE_STOPPED;
1369 if (cmd->status == COMP_CMD_ABORT)
1370 goto event_handled;
b63f4053
EF
1371 }
1372
b54fc46d
XR
1373 cmd_type = TRB_FIELD_TO_TYPE(le32_to_cpu(cmd_trb->generic.field[3]));
1374 switch (cmd_type) {
1375 case TRB_ENABLE_SLOT:
e7a79a1d 1376 xhci_handle_cmd_enable_slot(xhci, slot_id, cmd_comp_code);
3ffbba95 1377 break;
b54fc46d 1378 case TRB_DISABLE_SLOT:
6c02dd14 1379 xhci_handle_cmd_disable_slot(xhci, slot_id);
3ffbba95 1380 break;
b54fc46d 1381 case TRB_CONFIG_EP:
9ea1833e
MN
1382 if (!cmd->completion)
1383 xhci_handle_cmd_config_ep(xhci, slot_id, event,
1384 cmd_comp_code);
f94e0186 1385 break;
b54fc46d 1386 case TRB_EVAL_CONTEXT:
2d3f1fac 1387 break;
b54fc46d 1388 case TRB_ADDR_DEV:
3ffbba95 1389 break;
b54fc46d 1390 case TRB_STOP_RING:
b8200c94
XR
1391 WARN_ON(slot_id != TRB_TO_SLOT_ID(
1392 le32_to_cpu(cmd_trb->generic.field[3])));
1393 xhci_handle_cmd_stop_ep(xhci, slot_id, cmd_trb, event);
ae636747 1394 break;
b54fc46d 1395 case TRB_SET_DEQ:
b8200c94
XR
1396 WARN_ON(slot_id != TRB_TO_SLOT_ID(
1397 le32_to_cpu(cmd_trb->generic.field[3])));
c69a0597 1398 xhci_handle_cmd_set_deq(xhci, slot_id, cmd_trb, cmd_comp_code);
ae636747 1399 break;
b54fc46d 1400 case TRB_CMD_NOOP:
c311e391
MN
1401 /* Is this an aborted command turned to NO-OP? */
1402 if (cmd->status == COMP_CMD_STOP)
1403 cmd_comp_code = COMP_CMD_STOP;
7f84eef0 1404 break;
b54fc46d 1405 case TRB_RESET_EP:
b8200c94
XR
1406 WARN_ON(slot_id != TRB_TO_SLOT_ID(
1407 le32_to_cpu(cmd_trb->generic.field[3])));
c69a0597 1408 xhci_handle_cmd_reset_ep(xhci, slot_id, cmd_trb, cmd_comp_code);
a1587d97 1409 break;
b54fc46d 1410 case TRB_RESET_DEV:
6fcfb0d6
MN
1411 /* SLOT_ID field in reset device cmd completion event TRB is 0.
1412 * Use the SLOT_ID from the command TRB instead (xhci 4.6.11)
1413 */
1414 slot_id = TRB_TO_SLOT_ID(
1415 le32_to_cpu(cmd_trb->generic.field[3]));
f681321b 1416 xhci_handle_cmd_reset_dev(xhci, slot_id, event);
2a8f82c4 1417 break;
b54fc46d 1418 case TRB_NEC_GET_FW:
2c070821 1419 xhci_handle_cmd_nec_get_fw(xhci, event);
0238634d 1420 break;
7f84eef0
SS
1421 default:
1422 /* Skip over unknown commands on the event ring */
1423 xhci->error_bitmask |= 1 << 6;
1424 break;
1425 }
c9aa1a2d 1426
c311e391
MN
1427 /* restart timer if this wasn't the last command */
1428 if (cmd->cmd_list.next != &xhci->cmd_list) {
1429 xhci->current_cmd = list_entry(cmd->cmd_list.next,
1430 struct xhci_command, cmd_list);
1431 mod_timer(&xhci->cmd_timer, jiffies + XHCI_CMD_DEFAULT_TIMEOUT);
1432 }
1433
1434event_handled:
9ea1833e 1435 xhci_complete_del_and_free_cmd(cmd, cmd_comp_code);
c9aa1a2d 1436
3b72fca0 1437 inc_deq(xhci, xhci->cmd_ring);
7f84eef0
SS
1438}
1439
0238634d
SS
1440static void handle_vendor_event(struct xhci_hcd *xhci,
1441 union xhci_trb *event)
1442{
1443 u32 trb_type;
1444
28ccd296 1445 trb_type = TRB_FIELD_TO_TYPE(le32_to_cpu(event->generic.field[3]));
0238634d
SS
1446 xhci_dbg(xhci, "Vendor specific event TRB type = %u\n", trb_type);
1447 if (trb_type == TRB_NEC_CMD_COMP && (xhci->quirks & XHCI_NEC_HOST))
1448 handle_cmd_completion(xhci, &event->event_cmd);
1449}
1450
f6ff0ac8
SS
1451/* @port_id: the one-based port ID from the hardware (indexed from array of all
1452 * port registers -- USB 3.0 and USB 2.0).
1453 *
1454 * Returns a zero-based port number, which is suitable for indexing into each of
1455 * the split roothubs' port arrays and bus state arrays.
d0cd5d48 1456 * Add one to it in order to call xhci_find_slot_id_by_port.
f6ff0ac8
SS
1457 */
1458static unsigned int find_faked_portnum_from_hw_portnum(struct usb_hcd *hcd,
1459 struct xhci_hcd *xhci, u32 port_id)
1460{
1461 unsigned int i;
1462 unsigned int num_similar_speed_ports = 0;
1463
1464 /* port_id from the hardware is 1-based, but port_array[], usb3_ports[],
1465 * and usb2_ports are 0-based indexes. Count the number of similar
1466 * speed ports, up to 1 port before this port.
1467 */
1468 for (i = 0; i < (port_id - 1); i++) {
1469 u8 port_speed = xhci->port_array[i];
1470
1471 /*
1472 * Skip ports that don't have known speeds, or have duplicate
1473 * Extended Capabilities port speed entries.
1474 */
22e04870 1475 if (port_speed == 0 || port_speed == DUPLICATE_ENTRY)
f6ff0ac8
SS
1476 continue;
1477
1478 /*
1479 * USB 3.0 ports are always under a USB 3.0 hub. USB 2.0 and
1480 * 1.1 ports are under the USB 2.0 hub. If the port speed
1481 * matches the device speed, it's a similar speed port.
1482 */
1483 if ((port_speed == 0x03) == (hcd->speed == HCD_USB3))
1484 num_similar_speed_ports++;
1485 }
1486 return num_similar_speed_ports;
1487}
1488
623bef9e
SS
1489static void handle_device_notification(struct xhci_hcd *xhci,
1490 union xhci_trb *event)
1491{
1492 u32 slot_id;
4ee823b8 1493 struct usb_device *udev;
623bef9e 1494
7e76ad43 1495 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->generic.field[3]));
4ee823b8 1496 if (!xhci->devs[slot_id]) {
623bef9e
SS
1497 xhci_warn(xhci, "Device Notification event for "
1498 "unused slot %u\n", slot_id);
4ee823b8
SS
1499 return;
1500 }
1501
1502 xhci_dbg(xhci, "Device Wake Notification event for slot ID %u\n",
1503 slot_id);
1504 udev = xhci->devs[slot_id]->udev;
1505 if (udev && udev->parent)
1506 usb_wakeup_notification(udev->parent, udev->portnum);
623bef9e
SS
1507}
1508
0f2a7930
SS
1509static void handle_port_status(struct xhci_hcd *xhci,
1510 union xhci_trb *event)
1511{
f6ff0ac8 1512 struct usb_hcd *hcd;
0f2a7930 1513 u32 port_id;
56192531 1514 u32 temp, temp1;
518e848e 1515 int max_ports;
56192531 1516 int slot_id;
5308a91b 1517 unsigned int faked_port_index;
f6ff0ac8 1518 u8 major_revision;
20b67cf5 1519 struct xhci_bus_state *bus_state;
28ccd296 1520 __le32 __iomem **port_array;
386139d7 1521 bool bogus_port_status = false;
0f2a7930
SS
1522
1523 /* Port status change events always have a successful completion code */
28ccd296 1524 if (GET_COMP_CODE(le32_to_cpu(event->generic.field[2])) != COMP_SUCCESS) {
0f2a7930
SS
1525 xhci_warn(xhci, "WARN: xHC returned failed port status event\n");
1526 xhci->error_bitmask |= 1 << 8;
1527 }
28ccd296 1528 port_id = GET_PORT_ID(le32_to_cpu(event->generic.field[0]));
0f2a7930
SS
1529 xhci_dbg(xhci, "Port Status Change Event for port %d\n", port_id);
1530
518e848e
SS
1531 max_ports = HCS_MAX_PORTS(xhci->hcs_params1);
1532 if ((port_id <= 0) || (port_id > max_ports)) {
56192531 1533 xhci_warn(xhci, "Invalid port id %d\n", port_id);
09ce0c0c
PC
1534 inc_deq(xhci, xhci->event_ring);
1535 return;
56192531
AX
1536 }
1537
f6ff0ac8
SS
1538 /* Figure out which usb_hcd this port is attached to:
1539 * is it a USB 3.0 port or a USB 2.0/1.1 port?
1540 */
1541 major_revision = xhci->port_array[port_id - 1];
09ce0c0c
PC
1542
1543 /* Find the right roothub. */
1544 hcd = xhci_to_hcd(xhci);
1545 if ((major_revision == 0x03) != (hcd->speed == HCD_USB3))
1546 hcd = xhci->shared_hcd;
1547
f6ff0ac8
SS
1548 if (major_revision == 0) {
1549 xhci_warn(xhci, "Event for port %u not in "
1550 "Extended Capabilities, ignoring.\n",
1551 port_id);
386139d7 1552 bogus_port_status = true;
f6ff0ac8 1553 goto cleanup;
5308a91b 1554 }
22e04870 1555 if (major_revision == DUPLICATE_ENTRY) {
f6ff0ac8
SS
1556 xhci_warn(xhci, "Event for port %u duplicated in"
1557 "Extended Capabilities, ignoring.\n",
1558 port_id);
386139d7 1559 bogus_port_status = true;
f6ff0ac8
SS
1560 goto cleanup;
1561 }
1562
1563 /*
1564 * Hardware port IDs reported by a Port Status Change Event include USB
1565 * 3.0 and USB 2.0 ports. We want to check if the port has reported a
1566 * resume event, but we first need to translate the hardware port ID
1567 * into the index into the ports on the correct split roothub, and the
1568 * correct bus_state structure.
1569 */
f6ff0ac8
SS
1570 bus_state = &xhci->bus_state[hcd_index(hcd)];
1571 if (hcd->speed == HCD_USB3)
1572 port_array = xhci->usb3_ports;
1573 else
1574 port_array = xhci->usb2_ports;
1575 /* Find the faked port hub number */
1576 faked_port_index = find_faked_portnum_from_hw_portnum(hcd, xhci,
1577 port_id);
5308a91b 1578
b0ba9720 1579 temp = readl(port_array[faked_port_index]);
7111ebc9 1580 if (hcd->state == HC_STATE_SUSPENDED) {
56192531
AX
1581 xhci_dbg(xhci, "resume root hub\n");
1582 usb_hcd_resume_root_hub(hcd);
1583 }
1584
1585 if ((temp & PORT_PLC) && (temp & PORT_PLS_MASK) == XDEV_RESUME) {
1586 xhci_dbg(xhci, "port resume event for port %d\n", port_id);
1587
b0ba9720 1588 temp1 = readl(&xhci->op_regs->command);
56192531
AX
1589 if (!(temp1 & CMD_RUN)) {
1590 xhci_warn(xhci, "xHC is not running.\n");
1591 goto cleanup;
1592 }
1593
1594 if (DEV_SUPERSPEED(temp)) {
d93814cf 1595 xhci_dbg(xhci, "remote wake SS port %d\n", port_id);
4ee823b8
SS
1596 /* Set a flag to say the port signaled remote wakeup,
1597 * so we can tell the difference between the end of
1598 * device and host initiated resume.
1599 */
1600 bus_state->port_remote_wakeup |= 1 << faked_port_index;
d93814cf
SS
1601 xhci_test_and_clear_bit(xhci, port_array,
1602 faked_port_index, PORT_PLC);
c9682dff
AX
1603 xhci_set_link_state(xhci, port_array, faked_port_index,
1604 XDEV_U0);
d93814cf
SS
1605 /* Need to wait until the next link state change
1606 * indicates the device is actually in U0.
1607 */
1608 bogus_port_status = true;
1609 goto cleanup;
56192531
AX
1610 } else {
1611 xhci_dbg(xhci, "resume HS port %d\n", port_id);
f6ff0ac8 1612 bus_state->resume_done[faked_port_index] = jiffies +
56192531 1613 msecs_to_jiffies(20);
f370b996 1614 set_bit(faked_port_index, &bus_state->resuming_ports);
56192531 1615 mod_timer(&hcd->rh_timer,
f6ff0ac8 1616 bus_state->resume_done[faked_port_index]);
56192531
AX
1617 /* Do the rest in GetPortStatus */
1618 }
1619 }
d93814cf
SS
1620
1621 if ((temp & PORT_PLC) && (temp & PORT_PLS_MASK) == XDEV_U0 &&
1622 DEV_SUPERSPEED(temp)) {
1623 xhci_dbg(xhci, "resume SS port %d finished\n", port_id);
4ee823b8
SS
1624 /* We've just brought the device into U0 through either the
1625 * Resume state after a device remote wakeup, or through the
1626 * U3Exit state after a host-initiated resume. If it's a device
1627 * initiated remote wake, don't pass up the link state change,
1628 * so the roothub behavior is consistent with external
1629 * USB 3.0 hub behavior.
1630 */
d93814cf
SS
1631 slot_id = xhci_find_slot_id_by_port(hcd, xhci,
1632 faked_port_index + 1);
1633 if (slot_id && xhci->devs[slot_id])
1634 xhci_ring_device(xhci, slot_id);
ba7b5c22 1635 if (bus_state->port_remote_wakeup & (1 << faked_port_index)) {
4ee823b8
SS
1636 bus_state->port_remote_wakeup &=
1637 ~(1 << faked_port_index);
1638 xhci_test_and_clear_bit(xhci, port_array,
1639 faked_port_index, PORT_PLC);
1640 usb_wakeup_notification(hcd->self.root_hub,
1641 faked_port_index + 1);
1642 bogus_port_status = true;
1643 goto cleanup;
1644 }
d93814cf 1645 }
56192531 1646
8b3d4570
SS
1647 /*
1648 * Check to see if xhci-hub.c is waiting on RExit to U0 transition (or
1649 * RExit to a disconnect state). If so, let the the driver know it's
1650 * out of the RExit state.
1651 */
1652 if (!DEV_SUPERSPEED(temp) &&
1653 test_and_clear_bit(faked_port_index,
1654 &bus_state->rexit_ports)) {
1655 complete(&bus_state->rexit_done[faked_port_index]);
1656 bogus_port_status = true;
1657 goto cleanup;
1658 }
1659
6fd45621
AX
1660 if (hcd->speed != HCD_USB3)
1661 xhci_test_and_clear_bit(xhci, port_array, faked_port_index,
1662 PORT_PLC);
1663
56192531 1664cleanup:
0f2a7930 1665 /* Update event ring dequeue pointer before dropping the lock */
3b72fca0 1666 inc_deq(xhci, xhci->event_ring);
0f2a7930 1667
386139d7
SS
1668 /* Don't make the USB core poll the roothub if we got a bad port status
1669 * change event. Besides, at that point we can't tell which roothub
1670 * (USB 2.0 or USB 3.0) to kick.
1671 */
1672 if (bogus_port_status)
1673 return;
1674
c52804a4
SS
1675 /*
1676 * xHCI port-status-change events occur when the "or" of all the
1677 * status-change bits in the portsc register changes from 0 to 1.
1678 * New status changes won't cause an event if any other change
1679 * bits are still set. When an event occurs, switch over to
1680 * polling to avoid losing status changes.
1681 */
1682 xhci_dbg(xhci, "%s: starting port polling.\n", __func__);
1683 set_bit(HCD_FLAG_POLL_RH, &hcd->flags);
0f2a7930
SS
1684 spin_unlock(&xhci->lock);
1685 /* Pass this up to the core */
f6ff0ac8 1686 usb_hcd_poll_rh_status(hcd);
0f2a7930
SS
1687 spin_lock(&xhci->lock);
1688}
1689
d0e96f5a
SS
1690/*
1691 * This TD is defined by the TRBs starting at start_trb in start_seg and ending
1692 * at end_trb, which may be in another segment. If the suspect DMA address is a
1693 * TRB in this TD, this function returns that TRB's segment. Otherwise it
1694 * returns 0.
1695 */
6648f29d 1696struct xhci_segment *trb_in_td(struct xhci_segment *start_seg,
d0e96f5a
SS
1697 union xhci_trb *start_trb,
1698 union xhci_trb *end_trb,
1699 dma_addr_t suspect_dma)
1700{
1701 dma_addr_t start_dma;
1702 dma_addr_t end_seg_dma;
1703 dma_addr_t end_trb_dma;
1704 struct xhci_segment *cur_seg;
1705
23e3be11 1706 start_dma = xhci_trb_virt_to_dma(start_seg, start_trb);
d0e96f5a
SS
1707 cur_seg = start_seg;
1708
1709 do {
2fa88daa 1710 if (start_dma == 0)
326b4810 1711 return NULL;
ae636747 1712 /* We may get an event for a Link TRB in the middle of a TD */
23e3be11 1713 end_seg_dma = xhci_trb_virt_to_dma(cur_seg,
2fa88daa 1714 &cur_seg->trbs[TRBS_PER_SEGMENT - 1]);
d0e96f5a 1715 /* If the end TRB isn't in this segment, this is set to 0 */
23e3be11 1716 end_trb_dma = xhci_trb_virt_to_dma(cur_seg, end_trb);
d0e96f5a
SS
1717
1718 if (end_trb_dma > 0) {
1719 /* The end TRB is in this segment, so suspect should be here */
1720 if (start_dma <= end_trb_dma) {
1721 if (suspect_dma >= start_dma && suspect_dma <= end_trb_dma)
1722 return cur_seg;
1723 } else {
1724 /* Case for one segment with
1725 * a TD wrapped around to the top
1726 */
1727 if ((suspect_dma >= start_dma &&
1728 suspect_dma <= end_seg_dma) ||
1729 (suspect_dma >= cur_seg->dma &&
1730 suspect_dma <= end_trb_dma))
1731 return cur_seg;
1732 }
326b4810 1733 return NULL;
d0e96f5a
SS
1734 } else {
1735 /* Might still be somewhere in this segment */
1736 if (suspect_dma >= start_dma && suspect_dma <= end_seg_dma)
1737 return cur_seg;
1738 }
1739 cur_seg = cur_seg->next;
23e3be11 1740 start_dma = xhci_trb_virt_to_dma(cur_seg, &cur_seg->trbs[0]);
2fa88daa 1741 } while (cur_seg != start_seg);
d0e96f5a 1742
326b4810 1743 return NULL;
d0e96f5a
SS
1744}
1745
bcef3fd5
SS
1746static void xhci_cleanup_halted_endpoint(struct xhci_hcd *xhci,
1747 unsigned int slot_id, unsigned int ep_index,
e9df17eb 1748 unsigned int stream_id,
bcef3fd5
SS
1749 struct xhci_td *td, union xhci_trb *event_trb)
1750{
1751 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
ddba5cd0
MN
1752 struct xhci_command *command;
1753 command = xhci_alloc_command(xhci, false, false, GFP_ATOMIC);
1754 if (!command)
1755 return;
1756
bcef3fd5
SS
1757 ep->ep_state |= EP_HALTED;
1758 ep->stopped_td = td;
e9df17eb 1759 ep->stopped_stream = stream_id;
1624ae1c 1760
ddba5cd0 1761 xhci_queue_reset_ep(xhci, command, slot_id, ep_index);
bcef3fd5 1762 xhci_cleanup_stalled_ring(xhci, td->urb->dev, ep_index);
1624ae1c
SS
1763
1764 ep->stopped_td = NULL;
5e5cf6fc 1765 ep->stopped_stream = 0;
1624ae1c 1766
bcef3fd5
SS
1767 xhci_ring_cmd_db(xhci);
1768}
1769
1770/* Check if an error has halted the endpoint ring. The class driver will
1771 * cleanup the halt for a non-default control endpoint if we indicate a stall.
1772 * However, a babble and other errors also halt the endpoint ring, and the class
1773 * driver won't clear the halt in that case, so we need to issue a Set Transfer
1774 * Ring Dequeue Pointer command manually.
1775 */
1776static int xhci_requires_manual_halt_cleanup(struct xhci_hcd *xhci,
1777 struct xhci_ep_ctx *ep_ctx,
1778 unsigned int trb_comp_code)
1779{
1780 /* TRB completion codes that may require a manual halt cleanup */
1781 if (trb_comp_code == COMP_TX_ERR ||
1782 trb_comp_code == COMP_BABBLE ||
1783 trb_comp_code == COMP_SPLIT_ERR)
1784 /* The 0.96 spec says a babbling control endpoint
1785 * is not halted. The 0.96 spec says it is. Some HW
1786 * claims to be 0.95 compliant, but it halts the control
1787 * endpoint anyway. Check if a babble halted the
1788 * endpoint.
1789 */
f5960b69
ME
1790 if ((ep_ctx->ep_info & cpu_to_le32(EP_STATE_MASK)) ==
1791 cpu_to_le32(EP_STATE_HALTED))
bcef3fd5
SS
1792 return 1;
1793
1794 return 0;
1795}
1796
b45b5069
SS
1797int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code)
1798{
1799 if (trb_comp_code >= 224 && trb_comp_code <= 255) {
1800 /* Vendor defined "informational" completion code,
1801 * treat as not-an-error.
1802 */
1803 xhci_dbg(xhci, "Vendor defined info completion code %u\n",
1804 trb_comp_code);
1805 xhci_dbg(xhci, "Treating code as success.\n");
1806 return 1;
1807 }
1808 return 0;
1809}
1810
4422da61
AX
1811/*
1812 * Finish the td processing, remove the td from td list;
1813 * Return 1 if the urb can be given back.
1814 */
1815static int finish_td(struct xhci_hcd *xhci, struct xhci_td *td,
1816 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1817 struct xhci_virt_ep *ep, int *status, bool skip)
1818{
1819 struct xhci_virt_device *xdev;
1820 struct xhci_ring *ep_ring;
1821 unsigned int slot_id;
1822 int ep_index;
1823 struct urb *urb = NULL;
1824 struct xhci_ep_ctx *ep_ctx;
1825 int ret = 0;
8e51adcc 1826 struct urb_priv *urb_priv;
4422da61
AX
1827 u32 trb_comp_code;
1828
28ccd296 1829 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
4422da61 1830 xdev = xhci->devs[slot_id];
28ccd296
ME
1831 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
1832 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
4422da61 1833 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
28ccd296 1834 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
4422da61
AX
1835
1836 if (skip)
1837 goto td_cleanup;
1838
1839 if (trb_comp_code == COMP_STOP_INVAL ||
1840 trb_comp_code == COMP_STOP) {
1841 /* The Endpoint Stop Command completion will take care of any
1842 * stopped TDs. A stopped TD may be restarted, so don't update
1843 * the ring dequeue pointer or take this TD off any lists yet.
1844 */
1845 ep->stopped_td = td;
4422da61
AX
1846 return 0;
1847 } else {
1848 if (trb_comp_code == COMP_STALL) {
1849 /* The transfer is completed from the driver's
1850 * perspective, but we need to issue a set dequeue
1851 * command for this stalled endpoint to move the dequeue
1852 * pointer past the TD. We can't do that here because
1853 * the halt condition must be cleared first. Let the
1854 * USB class driver clear the stall later.
1855 */
1856 ep->stopped_td = td;
4422da61
AX
1857 ep->stopped_stream = ep_ring->stream_id;
1858 } else if (xhci_requires_manual_halt_cleanup(xhci,
1859 ep_ctx, trb_comp_code)) {
1860 /* Other types of errors halt the endpoint, but the
1861 * class driver doesn't call usb_reset_endpoint() unless
1862 * the error is -EPIPE. Clear the halted status in the
1863 * xHCI hardware manually.
1864 */
1865 xhci_cleanup_halted_endpoint(xhci,
1866 slot_id, ep_index, ep_ring->stream_id,
1867 td, event_trb);
1868 } else {
1869 /* Update ring dequeue pointer */
1870 while (ep_ring->dequeue != td->last_trb)
3b72fca0
AX
1871 inc_deq(xhci, ep_ring);
1872 inc_deq(xhci, ep_ring);
4422da61
AX
1873 }
1874
1875td_cleanup:
1876 /* Clean up the endpoint's TD list */
1877 urb = td->urb;
8e51adcc 1878 urb_priv = urb->hcpriv;
4422da61
AX
1879
1880 /* Do one last check of the actual transfer length.
1881 * If the host controller said we transferred more data than
1882 * the buffer length, urb->actual_length will be a very big
1883 * number (since it's unsigned). Play it safe and say we didn't
1884 * transfer anything.
1885 */
1886 if (urb->actual_length > urb->transfer_buffer_length) {
1887 xhci_warn(xhci, "URB transfer length is wrong, "
1888 "xHC issue? req. len = %u, "
1889 "act. len = %u\n",
1890 urb->transfer_buffer_length,
1891 urb->actual_length);
1892 urb->actual_length = 0;
1893 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1894 *status = -EREMOTEIO;
1895 else
1896 *status = 0;
1897 }
585df1d9 1898 list_del_init(&td->td_list);
4422da61
AX
1899 /* Was this TD slated to be cancelled but completed anyway? */
1900 if (!list_empty(&td->cancelled_td_list))
585df1d9 1901 list_del_init(&td->cancelled_td_list);
4422da61 1902
8e51adcc
AX
1903 urb_priv->td_cnt++;
1904 /* Giveback the urb when all the tds are completed */
c41136b0 1905 if (urb_priv->td_cnt == urb_priv->length) {
8e51adcc 1906 ret = 1;
c41136b0
AX
1907 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS) {
1908 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs--;
1909 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs
1910 == 0) {
1911 if (xhci->quirks & XHCI_AMD_PLL_FIX)
1912 usb_amd_quirk_pll_enable();
1913 }
1914 }
1915 }
4422da61
AX
1916 }
1917
1918 return ret;
1919}
1920
8af56be1
AX
1921/*
1922 * Process control tds, update urb status and actual_length.
1923 */
1924static int process_ctrl_td(struct xhci_hcd *xhci, struct xhci_td *td,
1925 union xhci_trb *event_trb, struct xhci_transfer_event *event,
1926 struct xhci_virt_ep *ep, int *status)
1927{
1928 struct xhci_virt_device *xdev;
1929 struct xhci_ring *ep_ring;
1930 unsigned int slot_id;
1931 int ep_index;
1932 struct xhci_ep_ctx *ep_ctx;
1933 u32 trb_comp_code;
1934
28ccd296 1935 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
8af56be1 1936 xdev = xhci->devs[slot_id];
28ccd296
ME
1937 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
1938 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
8af56be1 1939 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
28ccd296 1940 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
8af56be1 1941
8af56be1
AX
1942 switch (trb_comp_code) {
1943 case COMP_SUCCESS:
1944 if (event_trb == ep_ring->dequeue) {
1945 xhci_warn(xhci, "WARN: Success on ctrl setup TRB "
1946 "without IOC set??\n");
1947 *status = -ESHUTDOWN;
1948 } else if (event_trb != td->last_trb) {
1949 xhci_warn(xhci, "WARN: Success on ctrl data TRB "
1950 "without IOC set??\n");
1951 *status = -ESHUTDOWN;
1952 } else {
8af56be1
AX
1953 *status = 0;
1954 }
1955 break;
1956 case COMP_SHORT_TX:
8af56be1
AX
1957 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1958 *status = -EREMOTEIO;
1959 else
1960 *status = 0;
1961 break;
3abeca99
SS
1962 case COMP_STOP_INVAL:
1963 case COMP_STOP:
1964 return finish_td(xhci, td, event_trb, event, ep, status, false);
8af56be1
AX
1965 default:
1966 if (!xhci_requires_manual_halt_cleanup(xhci,
1967 ep_ctx, trb_comp_code))
1968 break;
1969 xhci_dbg(xhci, "TRB error code %u, "
1970 "halted endpoint index = %u\n",
1971 trb_comp_code, ep_index);
1972 /* else fall through */
1973 case COMP_STALL:
1974 /* Did we transfer part of the data (middle) phase? */
1975 if (event_trb != ep_ring->dequeue &&
1976 event_trb != td->last_trb)
1977 td->urb->actual_length =
1c11a172
VG
1978 td->urb->transfer_buffer_length -
1979 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
8af56be1
AX
1980 else
1981 td->urb->actual_length = 0;
1982
1983 xhci_cleanup_halted_endpoint(xhci,
1984 slot_id, ep_index, 0, td, event_trb);
1985 return finish_td(xhci, td, event_trb, event, ep, status, true);
1986 }
1987 /*
1988 * Did we transfer any data, despite the errors that might have
1989 * happened? I.e. did we get past the setup stage?
1990 */
1991 if (event_trb != ep_ring->dequeue) {
1992 /* The event was for the status stage */
1993 if (event_trb == td->last_trb) {
1994 if (td->urb->actual_length != 0) {
1995 /* Don't overwrite a previously set error code
1996 */
1997 if ((*status == -EINPROGRESS || *status == 0) &&
1998 (td->urb->transfer_flags
1999 & URB_SHORT_NOT_OK))
2000 /* Did we already see a short data
2001 * stage? */
2002 *status = -EREMOTEIO;
2003 } else {
2004 td->urb->actual_length =
2005 td->urb->transfer_buffer_length;
2006 }
2007 } else {
2008 /* Maybe the event was for the data stage? */
3abeca99
SS
2009 td->urb->actual_length =
2010 td->urb->transfer_buffer_length -
1c11a172 2011 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
3abeca99
SS
2012 xhci_dbg(xhci, "Waiting for status "
2013 "stage event\n");
2014 return 0;
8af56be1
AX
2015 }
2016 }
2017
2018 return finish_td(xhci, td, event_trb, event, ep, status, false);
2019}
2020
04e51901
AX
2021/*
2022 * Process isochronous tds, update urb packet status and actual_length.
2023 */
2024static int process_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
2025 union xhci_trb *event_trb, struct xhci_transfer_event *event,
2026 struct xhci_virt_ep *ep, int *status)
2027{
2028 struct xhci_ring *ep_ring;
2029 struct urb_priv *urb_priv;
2030 int idx;
2031 int len = 0;
04e51901
AX
2032 union xhci_trb *cur_trb;
2033 struct xhci_segment *cur_seg;
926008c9 2034 struct usb_iso_packet_descriptor *frame;
04e51901 2035 u32 trb_comp_code;
926008c9 2036 bool skip_td = false;
04e51901 2037
28ccd296
ME
2038 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2039 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
04e51901
AX
2040 urb_priv = td->urb->hcpriv;
2041 idx = urb_priv->td_cnt;
926008c9 2042 frame = &td->urb->iso_frame_desc[idx];
04e51901 2043
926008c9
DT
2044 /* handle completion code */
2045 switch (trb_comp_code) {
2046 case COMP_SUCCESS:
1c11a172 2047 if (EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) == 0) {
1530bbc6
SS
2048 frame->status = 0;
2049 break;
2050 }
2051 if ((xhci->quirks & XHCI_TRUST_TX_LENGTH))
2052 trb_comp_code = COMP_SHORT_TX;
926008c9
DT
2053 case COMP_SHORT_TX:
2054 frame->status = td->urb->transfer_flags & URB_SHORT_NOT_OK ?
2055 -EREMOTEIO : 0;
2056 break;
2057 case COMP_BW_OVER:
2058 frame->status = -ECOMM;
2059 skip_td = true;
2060 break;
2061 case COMP_BUFF_OVER:
2062 case COMP_BABBLE:
2063 frame->status = -EOVERFLOW;
2064 skip_td = true;
2065 break;
f6ba6fe2 2066 case COMP_DEV_ERR:
926008c9 2067 case COMP_STALL:
9c745995 2068 case COMP_TX_ERR:
926008c9
DT
2069 frame->status = -EPROTO;
2070 skip_td = true;
2071 break;
2072 case COMP_STOP:
2073 case COMP_STOP_INVAL:
2074 break;
2075 default:
2076 frame->status = -1;
2077 break;
04e51901
AX
2078 }
2079
926008c9
DT
2080 if (trb_comp_code == COMP_SUCCESS || skip_td) {
2081 frame->actual_length = frame->length;
2082 td->urb->actual_length += frame->length;
04e51901
AX
2083 } else {
2084 for (cur_trb = ep_ring->dequeue,
2085 cur_seg = ep_ring->deq_seg; cur_trb != event_trb;
2086 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
f5960b69
ME
2087 if (!TRB_TYPE_NOOP_LE32(cur_trb->generic.field[3]) &&
2088 !TRB_TYPE_LINK_LE32(cur_trb->generic.field[3]))
28ccd296 2089 len += TRB_LEN(le32_to_cpu(cur_trb->generic.field[2]));
04e51901 2090 }
28ccd296 2091 len += TRB_LEN(le32_to_cpu(cur_trb->generic.field[2])) -
1c11a172 2092 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
04e51901
AX
2093
2094 if (trb_comp_code != COMP_STOP_INVAL) {
926008c9 2095 frame->actual_length = len;
04e51901
AX
2096 td->urb->actual_length += len;
2097 }
2098 }
2099
04e51901
AX
2100 return finish_td(xhci, td, event_trb, event, ep, status, false);
2101}
2102
926008c9
DT
2103static int skip_isoc_td(struct xhci_hcd *xhci, struct xhci_td *td,
2104 struct xhci_transfer_event *event,
2105 struct xhci_virt_ep *ep, int *status)
2106{
2107 struct xhci_ring *ep_ring;
2108 struct urb_priv *urb_priv;
2109 struct usb_iso_packet_descriptor *frame;
2110 int idx;
2111
f6975314 2112 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
926008c9
DT
2113 urb_priv = td->urb->hcpriv;
2114 idx = urb_priv->td_cnt;
2115 frame = &td->urb->iso_frame_desc[idx];
2116
b3df3f9c 2117 /* The transfer is partly done. */
926008c9
DT
2118 frame->status = -EXDEV;
2119
2120 /* calc actual length */
2121 frame->actual_length = 0;
2122
2123 /* Update ring dequeue pointer */
2124 while (ep_ring->dequeue != td->last_trb)
3b72fca0
AX
2125 inc_deq(xhci, ep_ring);
2126 inc_deq(xhci, ep_ring);
926008c9
DT
2127
2128 return finish_td(xhci, td, NULL, event, ep, status, true);
2129}
2130
22405ed2
AX
2131/*
2132 * Process bulk and interrupt tds, update urb status and actual_length.
2133 */
2134static int process_bulk_intr_td(struct xhci_hcd *xhci, struct xhci_td *td,
2135 union xhci_trb *event_trb, struct xhci_transfer_event *event,
2136 struct xhci_virt_ep *ep, int *status)
2137{
2138 struct xhci_ring *ep_ring;
2139 union xhci_trb *cur_trb;
2140 struct xhci_segment *cur_seg;
2141 u32 trb_comp_code;
2142
28ccd296
ME
2143 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
2144 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
22405ed2
AX
2145
2146 switch (trb_comp_code) {
2147 case COMP_SUCCESS:
2148 /* Double check that the HW transferred everything. */
1530bbc6 2149 if (event_trb != td->last_trb ||
1c11a172 2150 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) != 0) {
22405ed2
AX
2151 xhci_warn(xhci, "WARN Successful completion "
2152 "on short TX\n");
2153 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2154 *status = -EREMOTEIO;
2155 else
2156 *status = 0;
1530bbc6
SS
2157 if ((xhci->quirks & XHCI_TRUST_TX_LENGTH))
2158 trb_comp_code = COMP_SHORT_TX;
22405ed2 2159 } else {
22405ed2
AX
2160 *status = 0;
2161 }
2162 break;
2163 case COMP_SHORT_TX:
2164 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2165 *status = -EREMOTEIO;
2166 else
2167 *status = 0;
2168 break;
2169 default:
2170 /* Others already handled above */
2171 break;
2172 }
f444ff27
SS
2173 if (trb_comp_code == COMP_SHORT_TX)
2174 xhci_dbg(xhci, "ep %#x - asked for %d bytes, "
2175 "%d bytes untransferred\n",
2176 td->urb->ep->desc.bEndpointAddress,
2177 td->urb->transfer_buffer_length,
1c11a172 2178 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)));
22405ed2
AX
2179 /* Fast path - was this the last TRB in the TD for this URB? */
2180 if (event_trb == td->last_trb) {
1c11a172 2181 if (EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) != 0) {
22405ed2
AX
2182 td->urb->actual_length =
2183 td->urb->transfer_buffer_length -
1c11a172 2184 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
22405ed2
AX
2185 if (td->urb->transfer_buffer_length <
2186 td->urb->actual_length) {
2187 xhci_warn(xhci, "HC gave bad length "
2188 "of %d bytes left\n",
1c11a172 2189 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)));
22405ed2
AX
2190 td->urb->actual_length = 0;
2191 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2192 *status = -EREMOTEIO;
2193 else
2194 *status = 0;
2195 }
2196 /* Don't overwrite a previously set error code */
2197 if (*status == -EINPROGRESS) {
2198 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
2199 *status = -EREMOTEIO;
2200 else
2201 *status = 0;
2202 }
2203 } else {
2204 td->urb->actual_length =
2205 td->urb->transfer_buffer_length;
2206 /* Ignore a short packet completion if the
2207 * untransferred length was zero.
2208 */
2209 if (*status == -EREMOTEIO)
2210 *status = 0;
2211 }
2212 } else {
2213 /* Slow path - walk the list, starting from the dequeue
2214 * pointer, to get the actual length transferred.
2215 */
2216 td->urb->actual_length = 0;
2217 for (cur_trb = ep_ring->dequeue, cur_seg = ep_ring->deq_seg;
2218 cur_trb != event_trb;
2219 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
f5960b69
ME
2220 if (!TRB_TYPE_NOOP_LE32(cur_trb->generic.field[3]) &&
2221 !TRB_TYPE_LINK_LE32(cur_trb->generic.field[3]))
22405ed2 2222 td->urb->actual_length +=
28ccd296 2223 TRB_LEN(le32_to_cpu(cur_trb->generic.field[2]));
22405ed2
AX
2224 }
2225 /* If the ring didn't stop on a Link or No-op TRB, add
2226 * in the actual bytes transferred from the Normal TRB
2227 */
2228 if (trb_comp_code != COMP_STOP_INVAL)
2229 td->urb->actual_length +=
28ccd296 2230 TRB_LEN(le32_to_cpu(cur_trb->generic.field[2])) -
1c11a172 2231 EVENT_TRB_LEN(le32_to_cpu(event->transfer_len));
22405ed2
AX
2232 }
2233
2234 return finish_td(xhci, td, event_trb, event, ep, status, false);
2235}
2236
d0e96f5a
SS
2237/*
2238 * If this function returns an error condition, it means it got a Transfer
2239 * event with a corrupted Slot ID, Endpoint ID, or TRB DMA address.
2240 * At this point, the host controller is probably hosed and should be reset.
2241 */
2242static int handle_tx_event(struct xhci_hcd *xhci,
2243 struct xhci_transfer_event *event)
ed384bd3
FB
2244 __releases(&xhci->lock)
2245 __acquires(&xhci->lock)
d0e96f5a
SS
2246{
2247 struct xhci_virt_device *xdev;
63a0d9ab 2248 struct xhci_virt_ep *ep;
d0e96f5a 2249 struct xhci_ring *ep_ring;
82d1009f 2250 unsigned int slot_id;
d0e96f5a 2251 int ep_index;
326b4810 2252 struct xhci_td *td = NULL;
d0e96f5a
SS
2253 dma_addr_t event_dma;
2254 struct xhci_segment *event_seg;
2255 union xhci_trb *event_trb;
326b4810 2256 struct urb *urb = NULL;
d0e96f5a 2257 int status = -EINPROGRESS;
8e51adcc 2258 struct urb_priv *urb_priv;
d115b048 2259 struct xhci_ep_ctx *ep_ctx;
c2d7b49f 2260 struct list_head *tmp;
66d1eebc 2261 u32 trb_comp_code;
4422da61 2262 int ret = 0;
c2d7b49f 2263 int td_num = 0;
d0e96f5a 2264
28ccd296 2265 slot_id = TRB_TO_SLOT_ID(le32_to_cpu(event->flags));
82d1009f 2266 xdev = xhci->devs[slot_id];
d0e96f5a
SS
2267 if (!xdev) {
2268 xhci_err(xhci, "ERROR Transfer event pointed to bad slot\n");
9258c0b2 2269 xhci_err(xhci, "@%016llx %08x %08x %08x %08x\n",
e910b440
SS
2270 (unsigned long long) xhci_trb_virt_to_dma(
2271 xhci->event_ring->deq_seg,
9258c0b2
SS
2272 xhci->event_ring->dequeue),
2273 lower_32_bits(le64_to_cpu(event->buffer)),
2274 upper_32_bits(le64_to_cpu(event->buffer)),
2275 le32_to_cpu(event->transfer_len),
2276 le32_to_cpu(event->flags));
2277 xhci_dbg(xhci, "Event ring:\n");
2278 xhci_debug_segment(xhci, xhci->event_ring->deq_seg);
d0e96f5a
SS
2279 return -ENODEV;
2280 }
2281
2282 /* Endpoint ID is 1 based, our index is zero based */
28ccd296 2283 ep_index = TRB_TO_EP_ID(le32_to_cpu(event->flags)) - 1;
63a0d9ab 2284 ep = &xdev->eps[ep_index];
28ccd296 2285 ep_ring = xhci_dma_to_transfer_ring(ep, le64_to_cpu(event->buffer));
d115b048 2286 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
986a92d4 2287 if (!ep_ring ||
28ccd296
ME
2288 (le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK) ==
2289 EP_STATE_DISABLED) {
e9df17eb
SS
2290 xhci_err(xhci, "ERROR Transfer event for disabled endpoint "
2291 "or incorrect stream ring\n");
9258c0b2 2292 xhci_err(xhci, "@%016llx %08x %08x %08x %08x\n",
e910b440
SS
2293 (unsigned long long) xhci_trb_virt_to_dma(
2294 xhci->event_ring->deq_seg,
9258c0b2
SS
2295 xhci->event_ring->dequeue),
2296 lower_32_bits(le64_to_cpu(event->buffer)),
2297 upper_32_bits(le64_to_cpu(event->buffer)),
2298 le32_to_cpu(event->transfer_len),
2299 le32_to_cpu(event->flags));
2300 xhci_dbg(xhci, "Event ring:\n");
2301 xhci_debug_segment(xhci, xhci->event_ring->deq_seg);
d0e96f5a
SS
2302 return -ENODEV;
2303 }
2304
c2d7b49f
AX
2305 /* Count current td numbers if ep->skip is set */
2306 if (ep->skip) {
2307 list_for_each(tmp, &ep_ring->td_list)
2308 td_num++;
2309 }
2310
28ccd296
ME
2311 event_dma = le64_to_cpu(event->buffer);
2312 trb_comp_code = GET_COMP_CODE(le32_to_cpu(event->transfer_len));
986a92d4 2313 /* Look for common error cases */
66d1eebc 2314 switch (trb_comp_code) {
b10de142
SS
2315 /* Skip codes that require special handling depending on
2316 * transfer type
2317 */
2318 case COMP_SUCCESS:
1c11a172 2319 if (EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) == 0)
1530bbc6
SS
2320 break;
2321 if (xhci->quirks & XHCI_TRUST_TX_LENGTH)
2322 trb_comp_code = COMP_SHORT_TX;
2323 else
8202ce2e
SS
2324 xhci_warn_ratelimited(xhci,
2325 "WARN Successful completion on short TX: needs XHCI_TRUST_TX_LENGTH quirk?\n");
b10de142
SS
2326 case COMP_SHORT_TX:
2327 break;
ae636747
SS
2328 case COMP_STOP:
2329 xhci_dbg(xhci, "Stopped on Transfer TRB\n");
2330 break;
2331 case COMP_STOP_INVAL:
2332 xhci_dbg(xhci, "Stopped on No-op or Link TRB\n");
2333 break;
b10de142 2334 case COMP_STALL:
2a9227a5 2335 xhci_dbg(xhci, "Stalled endpoint\n");
63a0d9ab 2336 ep->ep_state |= EP_HALTED;
b10de142
SS
2337 status = -EPIPE;
2338 break;
2339 case COMP_TRB_ERR:
2340 xhci_warn(xhci, "WARN: TRB error on endpoint\n");
2341 status = -EILSEQ;
2342 break;
ec74e403 2343 case COMP_SPLIT_ERR:
b10de142 2344 case COMP_TX_ERR:
2a9227a5 2345 xhci_dbg(xhci, "Transfer error on endpoint\n");
b10de142
SS
2346 status = -EPROTO;
2347 break;
4a73143c 2348 case COMP_BABBLE:
2a9227a5 2349 xhci_dbg(xhci, "Babble error on endpoint\n");
4a73143c
SS
2350 status = -EOVERFLOW;
2351 break;
b10de142
SS
2352 case COMP_DB_ERR:
2353 xhci_warn(xhci, "WARN: HC couldn't access mem fast enough\n");
2354 status = -ENOSR;
2355 break;
986a92d4
AX
2356 case COMP_BW_OVER:
2357 xhci_warn(xhci, "WARN: bandwidth overrun event on endpoint\n");
2358 break;
2359 case COMP_BUFF_OVER:
2360 xhci_warn(xhci, "WARN: buffer overrun event on endpoint\n");
2361 break;
2362 case COMP_UNDERRUN:
2363 /*
2364 * When the Isoch ring is empty, the xHC will generate
2365 * a Ring Overrun Event for IN Isoch endpoint or Ring
2366 * Underrun Event for OUT Isoch endpoint.
2367 */
2368 xhci_dbg(xhci, "underrun event on endpoint\n");
2369 if (!list_empty(&ep_ring->td_list))
2370 xhci_dbg(xhci, "Underrun Event for slot %d ep %d "
2371 "still with TDs queued?\n",
28ccd296
ME
2372 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2373 ep_index);
986a92d4
AX
2374 goto cleanup;
2375 case COMP_OVERRUN:
2376 xhci_dbg(xhci, "overrun event on endpoint\n");
2377 if (!list_empty(&ep_ring->td_list))
2378 xhci_dbg(xhci, "Overrun Event for slot %d ep %d "
2379 "still with TDs queued?\n",
28ccd296
ME
2380 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2381 ep_index);
986a92d4 2382 goto cleanup;
f6ba6fe2
AH
2383 case COMP_DEV_ERR:
2384 xhci_warn(xhci, "WARN: detect an incompatible device");
2385 status = -EPROTO;
2386 break;
d18240db
AX
2387 case COMP_MISSED_INT:
2388 /*
2389 * When encounter missed service error, one or more isoc tds
2390 * may be missed by xHC.
2391 * Set skip flag of the ep_ring; Complete the missed tds as
2392 * short transfer when process the ep_ring next time.
2393 */
2394 ep->skip = true;
2395 xhci_dbg(xhci, "Miss service interval error, set skip flag\n");
2396 goto cleanup;
b10de142 2397 default:
b45b5069 2398 if (xhci_is_vendor_info_code(xhci, trb_comp_code)) {
5ad6a529
SS
2399 status = 0;
2400 break;
2401 }
986a92d4
AX
2402 xhci_warn(xhci, "ERROR Unknown event condition, HC probably "
2403 "busted\n");
2404 goto cleanup;
2405 }
2406
d18240db
AX
2407 do {
2408 /* This TRB should be in the TD at the head of this ring's
2409 * TD list.
2410 */
2411 if (list_empty(&ep_ring->td_list)) {
a83d6755
SS
2412 /*
2413 * A stopped endpoint may generate an extra completion
2414 * event if the device was suspended. Don't print
2415 * warnings.
2416 */
2417 if (!(trb_comp_code == COMP_STOP ||
2418 trb_comp_code == COMP_STOP_INVAL)) {
2419 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d with no TDs queued?\n",
2420 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)),
2421 ep_index);
2422 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n",
2423 (le32_to_cpu(event->flags) &
2424 TRB_TYPE_BITMASK)>>10);
2425 xhci_print_trb_offsets(xhci, (union xhci_trb *) event);
2426 }
d18240db
AX
2427 if (ep->skip) {
2428 ep->skip = false;
2429 xhci_dbg(xhci, "td_list is empty while skip "
2430 "flag set. Clear skip flag.\n");
2431 }
2432 ret = 0;
2433 goto cleanup;
2434 }
986a92d4 2435
c2d7b49f
AX
2436 /* We've skipped all the TDs on the ep ring when ep->skip set */
2437 if (ep->skip && td_num == 0) {
2438 ep->skip = false;
2439 xhci_dbg(xhci, "All tds on the ep_ring skipped. "
2440 "Clear skip flag.\n");
2441 ret = 0;
2442 goto cleanup;
2443 }
2444
d18240db 2445 td = list_entry(ep_ring->td_list.next, struct xhci_td, td_list);
c2d7b49f
AX
2446 if (ep->skip)
2447 td_num--;
926008c9 2448
d18240db
AX
2449 /* Is this a TRB in the currently executing TD? */
2450 event_seg = trb_in_td(ep_ring->deq_seg, ep_ring->dequeue,
2451 td->last_trb, event_dma);
e1cf486d
AH
2452
2453 /*
2454 * Skip the Force Stopped Event. The event_trb(event_dma) of FSE
2455 * is not in the current TD pointed by ep_ring->dequeue because
2456 * that the hardware dequeue pointer still at the previous TRB
2457 * of the current TD. The previous TRB maybe a Link TD or the
2458 * last TRB of the previous TD. The command completion handle
2459 * will take care the rest.
2460 */
9a548863
HG
2461 if (!event_seg && (trb_comp_code == COMP_STOP ||
2462 trb_comp_code == COMP_STOP_INVAL)) {
e1cf486d
AH
2463 ret = 0;
2464 goto cleanup;
2465 }
2466
926008c9
DT
2467 if (!event_seg) {
2468 if (!ep->skip ||
2469 !usb_endpoint_xfer_isoc(&td->urb->ep->desc)) {
ad808333
SS
2470 /* Some host controllers give a spurious
2471 * successful event after a short transfer.
2472 * Ignore it.
2473 */
ddba5cd0 2474 if ((xhci->quirks & XHCI_SPURIOUS_SUCCESS) &&
ad808333
SS
2475 ep_ring->last_td_was_short) {
2476 ep_ring->last_td_was_short = false;
2477 ret = 0;
2478 goto cleanup;
2479 }
926008c9
DT
2480 /* HC is busted, give up! */
2481 xhci_err(xhci,
2482 "ERROR Transfer event TRB DMA ptr not "
2483 "part of current TD\n");
2484 return -ESHUTDOWN;
2485 }
2486
2487 ret = skip_isoc_td(xhci, td, event, ep, &status);
2488 goto cleanup;
2489 }
ad808333
SS
2490 if (trb_comp_code == COMP_SHORT_TX)
2491 ep_ring->last_td_was_short = true;
2492 else
2493 ep_ring->last_td_was_short = false;
926008c9
DT
2494
2495 if (ep->skip) {
d18240db
AX
2496 xhci_dbg(xhci, "Found td. Clear skip flag.\n");
2497 ep->skip = false;
2498 }
678539cf 2499
926008c9
DT
2500 event_trb = &event_seg->trbs[(event_dma - event_seg->dma) /
2501 sizeof(*event_trb)];
2502 /*
2503 * No-op TRB should not trigger interrupts.
2504 * If event_trb is a no-op TRB, it means the
2505 * corresponding TD has been cancelled. Just ignore
2506 * the TD.
2507 */
f5960b69 2508 if (TRB_TYPE_NOOP_LE32(event_trb->generic.field[3])) {
926008c9
DT
2509 xhci_dbg(xhci,
2510 "event_trb is a no-op TRB. Skip it\n");
2511 goto cleanup;
d18240db 2512 }
4422da61 2513
d18240db
AX
2514 /* Now update the urb's actual_length and give back to
2515 * the core
82d1009f 2516 */
d18240db
AX
2517 if (usb_endpoint_xfer_control(&td->urb->ep->desc))
2518 ret = process_ctrl_td(xhci, td, event_trb, event, ep,
2519 &status);
04e51901
AX
2520 else if (usb_endpoint_xfer_isoc(&td->urb->ep->desc))
2521 ret = process_isoc_td(xhci, td, event_trb, event, ep,
2522 &status);
d18240db
AX
2523 else
2524 ret = process_bulk_intr_td(xhci, td, event_trb, event,
2525 ep, &status);
2526
2527cleanup:
2528 /*
2529 * Do not update event ring dequeue pointer if ep->skip is set.
2530 * Will roll back to continue process missed tds.
2531 */
2532 if (trb_comp_code == COMP_MISSED_INT || !ep->skip) {
3b72fca0 2533 inc_deq(xhci, xhci->event_ring);
d18240db
AX
2534 }
2535
2536 if (ret) {
2537 urb = td->urb;
8e51adcc 2538 urb_priv = urb->hcpriv;
d18240db
AX
2539 /* Leave the TD around for the reset endpoint function
2540 * to use(but only if it's not a control endpoint,
2541 * since we already queued the Set TR dequeue pointer
2542 * command for stalled control endpoints).
2543 */
2544 if (usb_endpoint_xfer_control(&urb->ep->desc) ||
2545 (trb_comp_code != COMP_STALL &&
2546 trb_comp_code != COMP_BABBLE))
8e51adcc 2547 xhci_urb_free_priv(xhci, urb_priv);
48c3375c
AS
2548 else
2549 kfree(urb_priv);
d18240db 2550
214f76f7 2551 usb_hcd_unlink_urb_from_ep(bus_to_hcd(urb->dev->bus), urb);
f444ff27
SS
2552 if ((urb->actual_length != urb->transfer_buffer_length &&
2553 (urb->transfer_flags &
2554 URB_SHORT_NOT_OK)) ||
fd984d24
SS
2555 (status != 0 &&
2556 !usb_endpoint_xfer_isoc(&urb->ep->desc)))
f444ff27 2557 xhci_dbg(xhci, "Giveback URB %p, len = %d, "
1949f9e2 2558 "expected = %d, status = %d\n",
f444ff27
SS
2559 urb, urb->actual_length,
2560 urb->transfer_buffer_length,
2561 status);
d18240db 2562 spin_unlock(&xhci->lock);
b3df3f9c
SS
2563 /* EHCI, UHCI, and OHCI always unconditionally set the
2564 * urb->status of an isochronous endpoint to 0.
2565 */
2566 if (usb_pipetype(urb->pipe) == PIPE_ISOCHRONOUS)
2567 status = 0;
214f76f7 2568 usb_hcd_giveback_urb(bus_to_hcd(urb->dev->bus), urb, status);
d18240db
AX
2569 spin_lock(&xhci->lock);
2570 }
2571
2572 /*
2573 * If ep->skip is set, it means there are missed tds on the
2574 * endpoint ring need to take care of.
2575 * Process them as short transfer until reach the td pointed by
2576 * the event.
2577 */
2578 } while (ep->skip && trb_comp_code != COMP_MISSED_INT);
2579
d0e96f5a
SS
2580 return 0;
2581}
2582
0f2a7930
SS
2583/*
2584 * This function handles all OS-owned events on the event ring. It may drop
2585 * xhci->lock between event processing (e.g. to pass up port status changes).
9dee9a21
ME
2586 * Returns >0 for "possibly more events to process" (caller should call again),
2587 * otherwise 0 if done. In future, <0 returns should indicate error code.
0f2a7930 2588 */
9dee9a21 2589static int xhci_handle_event(struct xhci_hcd *xhci)
7f84eef0
SS
2590{
2591 union xhci_trb *event;
0f2a7930 2592 int update_ptrs = 1;
d0e96f5a 2593 int ret;
7f84eef0
SS
2594
2595 if (!xhci->event_ring || !xhci->event_ring->dequeue) {
2596 xhci->error_bitmask |= 1 << 1;
9dee9a21 2597 return 0;
7f84eef0
SS
2598 }
2599
2600 event = xhci->event_ring->dequeue;
2601 /* Does the HC or OS own the TRB? */
28ccd296
ME
2602 if ((le32_to_cpu(event->event_cmd.flags) & TRB_CYCLE) !=
2603 xhci->event_ring->cycle_state) {
7f84eef0 2604 xhci->error_bitmask |= 1 << 2;
9dee9a21 2605 return 0;
7f84eef0
SS
2606 }
2607
92a3da41
ME
2608 /*
2609 * Barrier between reading the TRB_CYCLE (valid) flag above and any
2610 * speculative reads of the event's flags/data below.
2611 */
2612 rmb();
0f2a7930 2613 /* FIXME: Handle more event types. */
28ccd296 2614 switch ((le32_to_cpu(event->event_cmd.flags) & TRB_TYPE_BITMASK)) {
7f84eef0
SS
2615 case TRB_TYPE(TRB_COMPLETION):
2616 handle_cmd_completion(xhci, &event->event_cmd);
2617 break;
0f2a7930
SS
2618 case TRB_TYPE(TRB_PORT_STATUS):
2619 handle_port_status(xhci, event);
2620 update_ptrs = 0;
2621 break;
d0e96f5a
SS
2622 case TRB_TYPE(TRB_TRANSFER):
2623 ret = handle_tx_event(xhci, &event->trans_event);
2624 if (ret < 0)
2625 xhci->error_bitmask |= 1 << 9;
2626 else
2627 update_ptrs = 0;
2628 break;
623bef9e
SS
2629 case TRB_TYPE(TRB_DEV_NOTE):
2630 handle_device_notification(xhci, event);
2631 break;
7f84eef0 2632 default:
28ccd296
ME
2633 if ((le32_to_cpu(event->event_cmd.flags) & TRB_TYPE_BITMASK) >=
2634 TRB_TYPE(48))
0238634d
SS
2635 handle_vendor_event(xhci, event);
2636 else
2637 xhci->error_bitmask |= 1 << 3;
7f84eef0 2638 }
6f5165cf
SS
2639 /* Any of the above functions may drop and re-acquire the lock, so check
2640 * to make sure a watchdog timer didn't mark the host as non-responsive.
2641 */
2642 if (xhci->xhc_state & XHCI_STATE_DYING) {
2643 xhci_dbg(xhci, "xHCI host dying, returning from "
2644 "event handler.\n");
9dee9a21 2645 return 0;
6f5165cf 2646 }
7f84eef0 2647
c06d68b8
SS
2648 if (update_ptrs)
2649 /* Update SW event ring dequeue pointer */
3b72fca0 2650 inc_deq(xhci, xhci->event_ring);
c06d68b8 2651
9dee9a21
ME
2652 /* Are there more items on the event ring? Caller will call us again to
2653 * check.
2654 */
2655 return 1;
7f84eef0 2656}
9032cd52
SS
2657
2658/*
2659 * xHCI spec says we can get an interrupt, and if the HC has an error condition,
2660 * we might get bad data out of the event ring. Section 4.10.2.7 has a list of
2661 * indicators of an event TRB error, but we check the status *first* to be safe.
2662 */
2663irqreturn_t xhci_irq(struct usb_hcd *hcd)
2664{
2665 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
c21599a3 2666 u32 status;
bda53145 2667 u64 temp_64;
c06d68b8
SS
2668 union xhci_trb *event_ring_deq;
2669 dma_addr_t deq;
9032cd52
SS
2670
2671 spin_lock(&xhci->lock);
9032cd52 2672 /* Check if the xHC generated the interrupt, or the irq is shared */
b0ba9720 2673 status = readl(&xhci->op_regs->status);
c21599a3 2674 if (status == 0xffffffff)
9032cd52
SS
2675 goto hw_died;
2676
c21599a3 2677 if (!(status & STS_EINT)) {
9032cd52 2678 spin_unlock(&xhci->lock);
9032cd52
SS
2679 return IRQ_NONE;
2680 }
27e0dd4d 2681 if (status & STS_FATAL) {
9032cd52
SS
2682 xhci_warn(xhci, "WARNING: Host System Error\n");
2683 xhci_halt(xhci);
2684hw_died:
9032cd52
SS
2685 spin_unlock(&xhci->lock);
2686 return -ESHUTDOWN;
2687 }
2688
bda53145
SS
2689 /*
2690 * Clear the op reg interrupt status first,
2691 * so we can receive interrupts from other MSI-X interrupters.
2692 * Write 1 to clear the interrupt status.
2693 */
27e0dd4d 2694 status |= STS_EINT;
204b7793 2695 writel(status, &xhci->op_regs->status);
bda53145
SS
2696 /* FIXME when MSI-X is supported and there are multiple vectors */
2697 /* Clear the MSI-X event interrupt status */
2698
cd70469d 2699 if (hcd->irq) {
c21599a3
SS
2700 u32 irq_pending;
2701 /* Acknowledge the PCI interrupt */
b0ba9720 2702 irq_pending = readl(&xhci->ir_set->irq_pending);
4e833c0b 2703 irq_pending |= IMAN_IP;
204b7793 2704 writel(irq_pending, &xhci->ir_set->irq_pending);
c21599a3 2705 }
bda53145 2706
c06d68b8 2707 if (xhci->xhc_state & XHCI_STATE_DYING) {
bda53145
SS
2708 xhci_dbg(xhci, "xHCI dying, ignoring interrupt. "
2709 "Shouldn't IRQs be disabled?\n");
c06d68b8
SS
2710 /* Clear the event handler busy flag (RW1C);
2711 * the event ring should be empty.
bda53145 2712 */
f7b2e403 2713 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
477632df
SS
2714 xhci_write_64(xhci, temp_64 | ERST_EHB,
2715 &xhci->ir_set->erst_dequeue);
c06d68b8
SS
2716 spin_unlock(&xhci->lock);
2717
2718 return IRQ_HANDLED;
2719 }
2720
2721 event_ring_deq = xhci->event_ring->dequeue;
2722 /* FIXME this should be a delayed service routine
2723 * that clears the EHB.
2724 */
9dee9a21 2725 while (xhci_handle_event(xhci) > 0) {}
bda53145 2726
f7b2e403 2727 temp_64 = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
c06d68b8
SS
2728 /* If necessary, update the HW's version of the event ring deq ptr. */
2729 if (event_ring_deq != xhci->event_ring->dequeue) {
2730 deq = xhci_trb_virt_to_dma(xhci->event_ring->deq_seg,
2731 xhci->event_ring->dequeue);
2732 if (deq == 0)
2733 xhci_warn(xhci, "WARN something wrong with SW event "
2734 "ring dequeue ptr.\n");
2735 /* Update HC event ring dequeue pointer */
2736 temp_64 &= ERST_PTR_MASK;
2737 temp_64 |= ((u64) deq & (u64) ~ERST_PTR_MASK);
2738 }
2739
2740 /* Clear the event handler busy flag (RW1C); event ring is empty. */
2741 temp_64 |= ERST_EHB;
477632df 2742 xhci_write_64(xhci, temp_64, &xhci->ir_set->erst_dequeue);
c06d68b8 2743
9032cd52
SS
2744 spin_unlock(&xhci->lock);
2745
2746 return IRQ_HANDLED;
2747}
2748
851ec164 2749irqreturn_t xhci_msi_irq(int irq, void *hcd)
9032cd52 2750{
968b822c 2751 return xhci_irq(hcd);
9032cd52 2752}
7f84eef0 2753
d0e96f5a
SS
2754/**** Endpoint Ring Operations ****/
2755
7f84eef0
SS
2756/*
2757 * Generic function for queueing a TRB on a ring.
2758 * The caller must have checked to make sure there's room on the ring.
6cc30d85
SS
2759 *
2760 * @more_trbs_coming: Will you enqueue more TRBs before calling
2761 * prepare_transfer()?
7f84eef0
SS
2762 */
2763static void queue_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
3b72fca0 2764 bool more_trbs_coming,
7f84eef0
SS
2765 u32 field1, u32 field2, u32 field3, u32 field4)
2766{
2767 struct xhci_generic_trb *trb;
2768
2769 trb = &ring->enqueue->generic;
28ccd296
ME
2770 trb->field[0] = cpu_to_le32(field1);
2771 trb->field[1] = cpu_to_le32(field2);
2772 trb->field[2] = cpu_to_le32(field3);
2773 trb->field[3] = cpu_to_le32(field4);
3b72fca0 2774 inc_enq(xhci, ring, more_trbs_coming);
7f84eef0
SS
2775}
2776
d0e96f5a
SS
2777/*
2778 * Does various checks on the endpoint ring, and makes it ready to queue num_trbs.
2779 * FIXME allocate segments if the ring is full.
2780 */
2781static int prepare_ring(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
3b72fca0 2782 u32 ep_state, unsigned int num_trbs, gfp_t mem_flags)
d0e96f5a 2783{
8dfec614
AX
2784 unsigned int num_trbs_needed;
2785
d0e96f5a 2786 /* Make sure the endpoint has been added to xHC schedule */
d0e96f5a
SS
2787 switch (ep_state) {
2788 case EP_STATE_DISABLED:
2789 /*
2790 * USB core changed config/interfaces without notifying us,
2791 * or hardware is reporting the wrong state.
2792 */
2793 xhci_warn(xhci, "WARN urb submitted to disabled ep\n");
2794 return -ENOENT;
d0e96f5a 2795 case EP_STATE_ERROR:
c92bcfa7 2796 xhci_warn(xhci, "WARN waiting for error on ep to be cleared\n");
d0e96f5a
SS
2797 /* FIXME event handling code for error needs to clear it */
2798 /* XXX not sure if this should be -ENOENT or not */
2799 return -EINVAL;
c92bcfa7
SS
2800 case EP_STATE_HALTED:
2801 xhci_dbg(xhci, "WARN halted endpoint, queueing URB anyway.\n");
d0e96f5a
SS
2802 case EP_STATE_STOPPED:
2803 case EP_STATE_RUNNING:
2804 break;
2805 default:
2806 xhci_err(xhci, "ERROR unknown endpoint state for ep\n");
2807 /*
2808 * FIXME issue Configure Endpoint command to try to get the HC
2809 * back into a known state.
2810 */
2811 return -EINVAL;
2812 }
8dfec614
AX
2813
2814 while (1) {
3d4b81ed
SS
2815 if (room_on_ring(xhci, ep_ring, num_trbs))
2816 break;
8dfec614
AX
2817
2818 if (ep_ring == xhci->cmd_ring) {
2819 xhci_err(xhci, "Do not support expand command ring\n");
2820 return -ENOMEM;
2821 }
2822
68ffb011
XR
2823 xhci_dbg_trace(xhci, trace_xhci_dbg_ring_expansion,
2824 "ERROR no room on ep ring, try ring expansion");
8dfec614
AX
2825 num_trbs_needed = num_trbs - ep_ring->num_trbs_free;
2826 if (xhci_ring_expansion(xhci, ep_ring, num_trbs_needed,
2827 mem_flags)) {
2828 xhci_err(xhci, "Ring expansion failed\n");
2829 return -ENOMEM;
2830 }
261fa12b 2831 }
6c12db90
JY
2832
2833 if (enqueue_is_link_trb(ep_ring)) {
2834 struct xhci_ring *ring = ep_ring;
2835 union xhci_trb *next;
6c12db90 2836
6c12db90
JY
2837 next = ring->enqueue;
2838
2839 while (last_trb(xhci, ring, ring->enq_seg, next)) {
7e393a83
AX
2840 /* If we're not dealing with 0.95 hardware or isoc rings
2841 * on AMD 0.96 host, clear the chain bit.
6c12db90 2842 */
3b72fca0
AX
2843 if (!xhci_link_trb_quirk(xhci) &&
2844 !(ring->type == TYPE_ISOC &&
2845 (xhci->quirks & XHCI_AMD_0x96_HOST)))
28ccd296 2846 next->link.control &= cpu_to_le32(~TRB_CHAIN);
6c12db90 2847 else
28ccd296 2848 next->link.control |= cpu_to_le32(TRB_CHAIN);
6c12db90
JY
2849
2850 wmb();
f5960b69 2851 next->link.control ^= cpu_to_le32(TRB_CYCLE);
6c12db90
JY
2852
2853 /* Toggle the cycle bit after the last ring segment. */
2854 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
2855 ring->cycle_state = (ring->cycle_state ? 0 : 1);
6c12db90
JY
2856 }
2857 ring->enq_seg = ring->enq_seg->next;
2858 ring->enqueue = ring->enq_seg->trbs;
2859 next = ring->enqueue;
2860 }
2861 }
2862
d0e96f5a
SS
2863 return 0;
2864}
2865
23e3be11 2866static int prepare_transfer(struct xhci_hcd *xhci,
d0e96f5a
SS
2867 struct xhci_virt_device *xdev,
2868 unsigned int ep_index,
e9df17eb 2869 unsigned int stream_id,
d0e96f5a
SS
2870 unsigned int num_trbs,
2871 struct urb *urb,
8e51adcc 2872 unsigned int td_index,
d0e96f5a
SS
2873 gfp_t mem_flags)
2874{
2875 int ret;
8e51adcc
AX
2876 struct urb_priv *urb_priv;
2877 struct xhci_td *td;
e9df17eb 2878 struct xhci_ring *ep_ring;
d115b048 2879 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
e9df17eb
SS
2880
2881 ep_ring = xhci_stream_id_to_ring(xdev, ep_index, stream_id);
2882 if (!ep_ring) {
2883 xhci_dbg(xhci, "Can't prepare ring for bad stream ID %u\n",
2884 stream_id);
2885 return -EINVAL;
2886 }
2887
2888 ret = prepare_ring(xhci, ep_ring,
28ccd296 2889 le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK,
3b72fca0 2890 num_trbs, mem_flags);
d0e96f5a
SS
2891 if (ret)
2892 return ret;
d0e96f5a 2893
8e51adcc
AX
2894 urb_priv = urb->hcpriv;
2895 td = urb_priv->td[td_index];
2896
2897 INIT_LIST_HEAD(&td->td_list);
2898 INIT_LIST_HEAD(&td->cancelled_td_list);
2899
2900 if (td_index == 0) {
214f76f7 2901 ret = usb_hcd_link_urb_to_ep(bus_to_hcd(urb->dev->bus), urb);
d13565c1 2902 if (unlikely(ret))
8e51adcc 2903 return ret;
d0e96f5a
SS
2904 }
2905
8e51adcc 2906 td->urb = urb;
d0e96f5a 2907 /* Add this TD to the tail of the endpoint ring's TD list */
8e51adcc
AX
2908 list_add_tail(&td->td_list, &ep_ring->td_list);
2909 td->start_seg = ep_ring->enq_seg;
2910 td->first_trb = ep_ring->enqueue;
2911
2912 urb_priv->td[td_index] = td;
d0e96f5a
SS
2913
2914 return 0;
2915}
2916
23e3be11 2917static unsigned int count_sg_trbs_needed(struct xhci_hcd *xhci, struct urb *urb)
8a96c052
SS
2918{
2919 int num_sgs, num_trbs, running_total, temp, i;
2920 struct scatterlist *sg;
2921
2922 sg = NULL;
bc677d5b 2923 num_sgs = urb->num_mapped_sgs;
8a96c052
SS
2924 temp = urb->transfer_buffer_length;
2925
8a96c052 2926 num_trbs = 0;
910f8d0c 2927 for_each_sg(urb->sg, sg, num_sgs, i) {
8a96c052
SS
2928 unsigned int len = sg_dma_len(sg);
2929
2930 /* Scatter gather list entries may cross 64KB boundaries */
2931 running_total = TRB_MAX_BUFF_SIZE -
a2490187 2932 (sg_dma_address(sg) & (TRB_MAX_BUFF_SIZE - 1));
5807795b 2933 running_total &= TRB_MAX_BUFF_SIZE - 1;
8a96c052
SS
2934 if (running_total != 0)
2935 num_trbs++;
2936
2937 /* How many more 64KB chunks to transfer, how many more TRBs? */
bcd2fde0 2938 while (running_total < sg_dma_len(sg) && running_total < temp) {
8a96c052
SS
2939 num_trbs++;
2940 running_total += TRB_MAX_BUFF_SIZE;
2941 }
8a96c052
SS
2942 len = min_t(int, len, temp);
2943 temp -= len;
2944 if (temp == 0)
2945 break;
2946 }
8a96c052
SS
2947 return num_trbs;
2948}
2949
23e3be11 2950static void check_trb_math(struct urb *urb, int num_trbs, int running_total)
8a96c052
SS
2951{
2952 if (num_trbs != 0)
a2490187 2953 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated number of "
8a96c052
SS
2954 "TRBs, %d left\n", __func__,
2955 urb->ep->desc.bEndpointAddress, num_trbs);
2956 if (running_total != urb->transfer_buffer_length)
a2490187 2957 dev_err(&urb->dev->dev, "%s - ep %#x - Miscalculated tx length, "
8a96c052
SS
2958 "queued %#x (%d), asked for %#x (%d)\n",
2959 __func__,
2960 urb->ep->desc.bEndpointAddress,
2961 running_total, running_total,
2962 urb->transfer_buffer_length,
2963 urb->transfer_buffer_length);
2964}
2965
23e3be11 2966static void giveback_first_trb(struct xhci_hcd *xhci, int slot_id,
e9df17eb 2967 unsigned int ep_index, unsigned int stream_id, int start_cycle,
e1eab2e0 2968 struct xhci_generic_trb *start_trb)
8a96c052 2969{
8a96c052
SS
2970 /*
2971 * Pass all the TRBs to the hardware at once and make sure this write
2972 * isn't reordered.
2973 */
2974 wmb();
50f7b52a 2975 if (start_cycle)
28ccd296 2976 start_trb->field[3] |= cpu_to_le32(start_cycle);
50f7b52a 2977 else
28ccd296 2978 start_trb->field[3] &= cpu_to_le32(~TRB_CYCLE);
be88fe4f 2979 xhci_ring_ep_doorbell(xhci, slot_id, ep_index, stream_id);
8a96c052
SS
2980}
2981
624defa1
SS
2982/*
2983 * xHCI uses normal TRBs for both bulk and interrupt. When the interrupt
2984 * endpoint is to be serviced, the xHC will consume (at most) one TD. A TD
2985 * (comprised of sg list entries) can take several service intervals to
2986 * transmit.
2987 */
2988int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
2989 struct urb *urb, int slot_id, unsigned int ep_index)
2990{
2991 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci,
2992 xhci->devs[slot_id]->out_ctx, ep_index);
2993 int xhci_interval;
2994 int ep_interval;
2995
28ccd296 2996 xhci_interval = EP_INTERVAL_TO_UFRAMES(le32_to_cpu(ep_ctx->ep_info));
624defa1
SS
2997 ep_interval = urb->interval;
2998 /* Convert to microframes */
2999 if (urb->dev->speed == USB_SPEED_LOW ||
3000 urb->dev->speed == USB_SPEED_FULL)
3001 ep_interval *= 8;
3002 /* FIXME change this to a warning and a suggestion to use the new API
3003 * to set the polling interval (once the API is added).
3004 */
3005 if (xhci_interval != ep_interval) {
0730d52a
DK
3006 dev_dbg_ratelimited(&urb->dev->dev,
3007 "Driver uses different interval (%d microframe%s) than xHCI (%d microframe%s)\n",
3008 ep_interval, ep_interval == 1 ? "" : "s",
3009 xhci_interval, xhci_interval == 1 ? "" : "s");
624defa1
SS
3010 urb->interval = xhci_interval;
3011 /* Convert back to frames for LS/FS devices */
3012 if (urb->dev->speed == USB_SPEED_LOW ||
3013 urb->dev->speed == USB_SPEED_FULL)
3014 urb->interval /= 8;
3015 }
3fc8206d 3016 return xhci_queue_bulk_tx(xhci, mem_flags, urb, slot_id, ep_index);
624defa1
SS
3017}
3018
04dd950d
SS
3019/*
3020 * The TD size is the number of bytes remaining in the TD (including this TRB),
3021 * right shifted by 10.
3022 * It must fit in bits 21:17, so it can't be bigger than 31.
3023 */
3024static u32 xhci_td_remainder(unsigned int remainder)
3025{
3026 u32 max = (1 << (21 - 17 + 1)) - 1;
3027
3028 if ((remainder >> 10) >= max)
3029 return max << 17;
3030 else
3031 return (remainder >> 10) << 17;
3032}
3033
4da6e6f2 3034/*
4525c0a1
SS
3035 * For xHCI 1.0 host controllers, TD size is the number of max packet sized
3036 * packets remaining in the TD (*not* including this TRB).
4da6e6f2
SS
3037 *
3038 * Total TD packet count = total_packet_count =
4525c0a1 3039 * DIV_ROUND_UP(TD size in bytes / wMaxPacketSize)
4da6e6f2
SS
3040 *
3041 * Packets transferred up to and including this TRB = packets_transferred =
3042 * rounddown(total bytes transferred including this TRB / wMaxPacketSize)
3043 *
3044 * TD size = total_packet_count - packets_transferred
3045 *
3046 * It must fit in bits 21:17, so it can't be bigger than 31.
4525c0a1 3047 * The last TRB in a TD must have the TD size set to zero.
4da6e6f2 3048 */
4da6e6f2 3049static u32 xhci_v1_0_td_remainder(int running_total, int trb_buff_len,
4525c0a1
SS
3050 unsigned int total_packet_count, struct urb *urb,
3051 unsigned int num_trbs_left)
4da6e6f2
SS
3052{
3053 int packets_transferred;
3054
48df4a6f 3055 /* One TRB with a zero-length data packet. */
4525c0a1 3056 if (num_trbs_left == 0 || (running_total == 0 && trb_buff_len == 0))
48df4a6f
SS
3057 return 0;
3058
4da6e6f2
SS
3059 /* All the TRB queueing functions don't count the current TRB in
3060 * running_total.
3061 */
3062 packets_transferred = (running_total + trb_buff_len) /
f18f8ed2 3063 GET_MAX_PACKET(usb_endpoint_maxp(&urb->ep->desc));
4da6e6f2 3064
4525c0a1
SS
3065 if ((total_packet_count - packets_transferred) > 31)
3066 return 31 << 17;
3067 return (total_packet_count - packets_transferred) << 17;
4da6e6f2
SS
3068}
3069
23e3be11 3070static int queue_bulk_sg_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
8a96c052
SS
3071 struct urb *urb, int slot_id, unsigned int ep_index)
3072{
3073 struct xhci_ring *ep_ring;
3074 unsigned int num_trbs;
8e51adcc 3075 struct urb_priv *urb_priv;
8a96c052
SS
3076 struct xhci_td *td;
3077 struct scatterlist *sg;
3078 int num_sgs;
3079 int trb_buff_len, this_sg_len, running_total;
4da6e6f2 3080 unsigned int total_packet_count;
8a96c052
SS
3081 bool first_trb;
3082 u64 addr;
6cc30d85 3083 bool more_trbs_coming;
8a96c052
SS
3084
3085 struct xhci_generic_trb *start_trb;
3086 int start_cycle;
3087
e9df17eb
SS
3088 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3089 if (!ep_ring)
3090 return -EINVAL;
3091
8a96c052 3092 num_trbs = count_sg_trbs_needed(xhci, urb);
bc677d5b 3093 num_sgs = urb->num_mapped_sgs;
4525c0a1 3094 total_packet_count = DIV_ROUND_UP(urb->transfer_buffer_length,
29cc8897 3095 usb_endpoint_maxp(&urb->ep->desc));
8a96c052 3096
23e3be11 3097 trb_buff_len = prepare_transfer(xhci, xhci->devs[slot_id],
e9df17eb 3098 ep_index, urb->stream_id,
3b72fca0 3099 num_trbs, urb, 0, mem_flags);
8a96c052
SS
3100 if (trb_buff_len < 0)
3101 return trb_buff_len;
8e51adcc
AX
3102
3103 urb_priv = urb->hcpriv;
3104 td = urb_priv->td[0];
3105
8a96c052
SS
3106 /*
3107 * Don't give the first TRB to the hardware (by toggling the cycle bit)
3108 * until we've finished creating all the other TRBs. The ring's cycle
3109 * state may change as we enqueue the other TRBs, so save it too.
3110 */
3111 start_trb = &ep_ring->enqueue->generic;
3112 start_cycle = ep_ring->cycle_state;
3113
3114 running_total = 0;
3115 /*
3116 * How much data is in the first TRB?
3117 *
3118 * There are three forces at work for TRB buffer pointers and lengths:
3119 * 1. We don't want to walk off the end of this sg-list entry buffer.
3120 * 2. The transfer length that the driver requested may be smaller than
3121 * the amount of memory allocated for this scatter-gather list.
3122 * 3. TRBs buffers can't cross 64KB boundaries.
3123 */
910f8d0c 3124 sg = urb->sg;
8a96c052
SS
3125 addr = (u64) sg_dma_address(sg);
3126 this_sg_len = sg_dma_len(sg);
a2490187 3127 trb_buff_len = TRB_MAX_BUFF_SIZE - (addr & (TRB_MAX_BUFF_SIZE - 1));
8a96c052
SS
3128 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
3129 if (trb_buff_len > urb->transfer_buffer_length)
3130 trb_buff_len = urb->transfer_buffer_length;
8a96c052
SS
3131
3132 first_trb = true;
3133 /* Queue the first TRB, even if it's zero-length */
3134 do {
3135 u32 field = 0;
f9dc68fe 3136 u32 length_field = 0;
04dd950d 3137 u32 remainder = 0;
8a96c052
SS
3138
3139 /* Don't change the cycle bit of the first TRB until later */
50f7b52a 3140 if (first_trb) {
8a96c052 3141 first_trb = false;
50f7b52a
AX
3142 if (start_cycle == 0)
3143 field |= 0x1;
3144 } else
8a96c052
SS
3145 field |= ep_ring->cycle_state;
3146
3147 /* Chain all the TRBs together; clear the chain bit in the last
3148 * TRB to indicate it's the last TRB in the chain.
3149 */
3150 if (num_trbs > 1) {
3151 field |= TRB_CHAIN;
3152 } else {
3153 /* FIXME - add check for ZERO_PACKET flag before this */
3154 td->last_trb = ep_ring->enqueue;
3155 field |= TRB_IOC;
3156 }
af8b9e63
SS
3157
3158 /* Only set interrupt on short packet for IN endpoints */
3159 if (usb_urb_dir_in(urb))
3160 field |= TRB_ISP;
3161
8a96c052 3162 if (TRB_MAX_BUFF_SIZE -
a2490187 3163 (addr & (TRB_MAX_BUFF_SIZE - 1)) < trb_buff_len) {
8a96c052
SS
3164 xhci_warn(xhci, "WARN: sg dma xfer crosses 64KB boundaries!\n");
3165 xhci_dbg(xhci, "Next boundary at %#x, end dma = %#x\n",
3166 (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
3167 (unsigned int) addr + trb_buff_len);
3168 }
4da6e6f2
SS
3169
3170 /* Set the TRB length, TD size, and interrupter fields. */
3171 if (xhci->hci_version < 0x100) {
3172 remainder = xhci_td_remainder(
3173 urb->transfer_buffer_length -
3174 running_total);
3175 } else {
3176 remainder = xhci_v1_0_td_remainder(running_total,
4525c0a1
SS
3177 trb_buff_len, total_packet_count, urb,
3178 num_trbs - 1);
4da6e6f2 3179 }
f9dc68fe 3180 length_field = TRB_LEN(trb_buff_len) |
04dd950d 3181 remainder |
f9dc68fe 3182 TRB_INTR_TARGET(0);
4da6e6f2 3183
6cc30d85
SS
3184 if (num_trbs > 1)
3185 more_trbs_coming = true;
3186 else
3187 more_trbs_coming = false;
3b72fca0 3188 queue_trb(xhci, ep_ring, more_trbs_coming,
8e595a5d
SS
3189 lower_32_bits(addr),
3190 upper_32_bits(addr),
f9dc68fe 3191 length_field,
af8b9e63 3192 field | TRB_TYPE(TRB_NORMAL));
8a96c052
SS
3193 --num_trbs;
3194 running_total += trb_buff_len;
3195
3196 /* Calculate length for next transfer --
3197 * Are we done queueing all the TRBs for this sg entry?
3198 */
3199 this_sg_len -= trb_buff_len;
3200 if (this_sg_len == 0) {
3201 --num_sgs;
3202 if (num_sgs == 0)
3203 break;
3204 sg = sg_next(sg);
3205 addr = (u64) sg_dma_address(sg);
3206 this_sg_len = sg_dma_len(sg);
3207 } else {
3208 addr += trb_buff_len;
3209 }
3210
3211 trb_buff_len = TRB_MAX_BUFF_SIZE -
a2490187 3212 (addr & (TRB_MAX_BUFF_SIZE - 1));
8a96c052
SS
3213 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
3214 if (running_total + trb_buff_len > urb->transfer_buffer_length)
3215 trb_buff_len =
3216 urb->transfer_buffer_length - running_total;
3217 } while (running_total < urb->transfer_buffer_length);
3218
3219 check_trb_math(urb, num_trbs, running_total);
e9df17eb 3220 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
e1eab2e0 3221 start_cycle, start_trb);
8a96c052
SS
3222 return 0;
3223}
3224
b10de142 3225/* This is very similar to what ehci-q.c qtd_fill() does */
23e3be11 3226int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
b10de142
SS
3227 struct urb *urb, int slot_id, unsigned int ep_index)
3228{
3229 struct xhci_ring *ep_ring;
8e51adcc 3230 struct urb_priv *urb_priv;
b10de142
SS
3231 struct xhci_td *td;
3232 int num_trbs;
3233 struct xhci_generic_trb *start_trb;
3234 bool first_trb;
6cc30d85 3235 bool more_trbs_coming;
b10de142 3236 int start_cycle;
f9dc68fe 3237 u32 field, length_field;
b10de142
SS
3238
3239 int running_total, trb_buff_len, ret;
4da6e6f2 3240 unsigned int total_packet_count;
b10de142
SS
3241 u64 addr;
3242
ff9c895f 3243 if (urb->num_sgs)
8a96c052
SS
3244 return queue_bulk_sg_tx(xhci, mem_flags, urb, slot_id, ep_index);
3245
e9df17eb
SS
3246 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3247 if (!ep_ring)
3248 return -EINVAL;
b10de142
SS
3249
3250 num_trbs = 0;
3251 /* How much data is (potentially) left before the 64KB boundary? */
3252 running_total = TRB_MAX_BUFF_SIZE -
a2490187 3253 (urb->transfer_dma & (TRB_MAX_BUFF_SIZE - 1));
5807795b 3254 running_total &= TRB_MAX_BUFF_SIZE - 1;
b10de142
SS
3255
3256 /* If there's some data on this 64KB chunk, or we have to send a
3257 * zero-length transfer, we need at least one TRB
3258 */
3259 if (running_total != 0 || urb->transfer_buffer_length == 0)
3260 num_trbs++;
3261 /* How many more 64KB chunks to transfer, how many more TRBs? */
3262 while (running_total < urb->transfer_buffer_length) {
3263 num_trbs++;
3264 running_total += TRB_MAX_BUFF_SIZE;
3265 }
3266 /* FIXME: this doesn't deal with URB_ZERO_PACKET - need one more */
3267
e9df17eb
SS
3268 ret = prepare_transfer(xhci, xhci->devs[slot_id],
3269 ep_index, urb->stream_id,
3b72fca0 3270 num_trbs, urb, 0, mem_flags);
b10de142
SS
3271 if (ret < 0)
3272 return ret;
3273
8e51adcc
AX
3274 urb_priv = urb->hcpriv;
3275 td = urb_priv->td[0];
3276
b10de142
SS
3277 /*
3278 * Don't give the first TRB to the hardware (by toggling the cycle bit)
3279 * until we've finished creating all the other TRBs. The ring's cycle
3280 * state may change as we enqueue the other TRBs, so save it too.
3281 */
3282 start_trb = &ep_ring->enqueue->generic;
3283 start_cycle = ep_ring->cycle_state;
3284
3285 running_total = 0;
4525c0a1 3286 total_packet_count = DIV_ROUND_UP(urb->transfer_buffer_length,
29cc8897 3287 usb_endpoint_maxp(&urb->ep->desc));
b10de142
SS
3288 /* How much data is in the first TRB? */
3289 addr = (u64) urb->transfer_dma;
3290 trb_buff_len = TRB_MAX_BUFF_SIZE -
a2490187
PZ
3291 (urb->transfer_dma & (TRB_MAX_BUFF_SIZE - 1));
3292 if (trb_buff_len > urb->transfer_buffer_length)
b10de142
SS
3293 trb_buff_len = urb->transfer_buffer_length;
3294
3295 first_trb = true;
3296
3297 /* Queue the first TRB, even if it's zero-length */
3298 do {
04dd950d 3299 u32 remainder = 0;
b10de142
SS
3300 field = 0;
3301
3302 /* Don't change the cycle bit of the first TRB until later */
50f7b52a 3303 if (first_trb) {
b10de142 3304 first_trb = false;
50f7b52a
AX
3305 if (start_cycle == 0)
3306 field |= 0x1;
3307 } else
b10de142
SS
3308 field |= ep_ring->cycle_state;
3309
3310 /* Chain all the TRBs together; clear the chain bit in the last
3311 * TRB to indicate it's the last TRB in the chain.
3312 */
3313 if (num_trbs > 1) {
3314 field |= TRB_CHAIN;
3315 } else {
3316 /* FIXME - add check for ZERO_PACKET flag before this */
3317 td->last_trb = ep_ring->enqueue;
3318 field |= TRB_IOC;
3319 }
af8b9e63
SS
3320
3321 /* Only set interrupt on short packet for IN endpoints */
3322 if (usb_urb_dir_in(urb))
3323 field |= TRB_ISP;
3324
4da6e6f2
SS
3325 /* Set the TRB length, TD size, and interrupter fields. */
3326 if (xhci->hci_version < 0x100) {
3327 remainder = xhci_td_remainder(
3328 urb->transfer_buffer_length -
3329 running_total);
3330 } else {
3331 remainder = xhci_v1_0_td_remainder(running_total,
4525c0a1
SS
3332 trb_buff_len, total_packet_count, urb,
3333 num_trbs - 1);
4da6e6f2 3334 }
f9dc68fe 3335 length_field = TRB_LEN(trb_buff_len) |
04dd950d 3336 remainder |
f9dc68fe 3337 TRB_INTR_TARGET(0);
4da6e6f2 3338
6cc30d85
SS
3339 if (num_trbs > 1)
3340 more_trbs_coming = true;
3341 else
3342 more_trbs_coming = false;
3b72fca0 3343 queue_trb(xhci, ep_ring, more_trbs_coming,
8e595a5d
SS
3344 lower_32_bits(addr),
3345 upper_32_bits(addr),
f9dc68fe 3346 length_field,
af8b9e63 3347 field | TRB_TYPE(TRB_NORMAL));
b10de142
SS
3348 --num_trbs;
3349 running_total += trb_buff_len;
3350
3351 /* Calculate length for next transfer */
3352 addr += trb_buff_len;
3353 trb_buff_len = urb->transfer_buffer_length - running_total;
3354 if (trb_buff_len > TRB_MAX_BUFF_SIZE)
3355 trb_buff_len = TRB_MAX_BUFF_SIZE;
3356 } while (running_total < urb->transfer_buffer_length);
3357
8a96c052 3358 check_trb_math(urb, num_trbs, running_total);
e9df17eb 3359 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
e1eab2e0 3360 start_cycle, start_trb);
b10de142
SS
3361 return 0;
3362}
3363
d0e96f5a 3364/* Caller must have locked xhci->lock */
23e3be11 3365int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
d0e96f5a
SS
3366 struct urb *urb, int slot_id, unsigned int ep_index)
3367{
3368 struct xhci_ring *ep_ring;
3369 int num_trbs;
3370 int ret;
3371 struct usb_ctrlrequest *setup;
3372 struct xhci_generic_trb *start_trb;
3373 int start_cycle;
f9dc68fe 3374 u32 field, length_field;
8e51adcc 3375 struct urb_priv *urb_priv;
d0e96f5a
SS
3376 struct xhci_td *td;
3377
e9df17eb
SS
3378 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
3379 if (!ep_ring)
3380 return -EINVAL;
d0e96f5a
SS
3381
3382 /*
3383 * Need to copy setup packet into setup TRB, so we can't use the setup
3384 * DMA address.
3385 */
3386 if (!urb->setup_packet)
3387 return -EINVAL;
3388
d0e96f5a
SS
3389 /* 1 TRB for setup, 1 for status */
3390 num_trbs = 2;
3391 /*
3392 * Don't need to check if we need additional event data and normal TRBs,
3393 * since data in control transfers will never get bigger than 16MB
3394 * XXX: can we get a buffer that crosses 64KB boundaries?
3395 */
3396 if (urb->transfer_buffer_length > 0)
3397 num_trbs++;
e9df17eb
SS
3398 ret = prepare_transfer(xhci, xhci->devs[slot_id],
3399 ep_index, urb->stream_id,
3b72fca0 3400 num_trbs, urb, 0, mem_flags);
d0e96f5a
SS
3401 if (ret < 0)
3402 return ret;
3403
8e51adcc
AX
3404 urb_priv = urb->hcpriv;
3405 td = urb_priv->td[0];
3406
d0e96f5a
SS
3407 /*
3408 * Don't give the first TRB to the hardware (by toggling the cycle bit)
3409 * until we've finished creating all the other TRBs. The ring's cycle
3410 * state may change as we enqueue the other TRBs, so save it too.
3411 */
3412 start_trb = &ep_ring->enqueue->generic;
3413 start_cycle = ep_ring->cycle_state;
3414
3415 /* Queue setup TRB - see section 6.4.1.2.1 */
3416 /* FIXME better way to translate setup_packet into two u32 fields? */
3417 setup = (struct usb_ctrlrequest *) urb->setup_packet;
50f7b52a
AX
3418 field = 0;
3419 field |= TRB_IDT | TRB_TYPE(TRB_SETUP);
3420 if (start_cycle == 0)
3421 field |= 0x1;
b83cdc8f
AX
3422
3423 /* xHCI 1.0 6.4.1.2.1: Transfer Type field */
3424 if (xhci->hci_version == 0x100) {
3425 if (urb->transfer_buffer_length > 0) {
3426 if (setup->bRequestType & USB_DIR_IN)
3427 field |= TRB_TX_TYPE(TRB_DATA_IN);
3428 else
3429 field |= TRB_TX_TYPE(TRB_DATA_OUT);
3430 }
3431 }
3432
3b72fca0 3433 queue_trb(xhci, ep_ring, true,
28ccd296
ME
3434 setup->bRequestType | setup->bRequest << 8 | le16_to_cpu(setup->wValue) << 16,
3435 le16_to_cpu(setup->wIndex) | le16_to_cpu(setup->wLength) << 16,
3436 TRB_LEN(8) | TRB_INTR_TARGET(0),
3437 /* Immediate data in pointer */
3438 field);
d0e96f5a
SS
3439
3440 /* If there's data, queue data TRBs */
af8b9e63
SS
3441 /* Only set interrupt on short packet for IN endpoints */
3442 if (usb_urb_dir_in(urb))
3443 field = TRB_ISP | TRB_TYPE(TRB_DATA);
3444 else
3445 field = TRB_TYPE(TRB_DATA);
3446
f9dc68fe 3447 length_field = TRB_LEN(urb->transfer_buffer_length) |
04dd950d 3448 xhci_td_remainder(urb->transfer_buffer_length) |
f9dc68fe 3449 TRB_INTR_TARGET(0);
d0e96f5a
SS
3450 if (urb->transfer_buffer_length > 0) {
3451 if (setup->bRequestType & USB_DIR_IN)
3452 field |= TRB_DIR_IN;
3b72fca0 3453 queue_trb(xhci, ep_ring, true,
d0e96f5a
SS
3454 lower_32_bits(urb->transfer_dma),
3455 upper_32_bits(urb->transfer_dma),
f9dc68fe 3456 length_field,
af8b9e63 3457 field | ep_ring->cycle_state);
d0e96f5a
SS
3458 }
3459
3460 /* Save the DMA address of the last TRB in the TD */
3461 td->last_trb = ep_ring->enqueue;
3462
3463 /* Queue status TRB - see Table 7 and sections 4.11.2.2 and 6.4.1.2.3 */
3464 /* If the device sent data, the status stage is an OUT transfer */
3465 if (urb->transfer_buffer_length > 0 && setup->bRequestType & USB_DIR_IN)
3466 field = 0;
3467 else
3468 field = TRB_DIR_IN;
3b72fca0 3469 queue_trb(xhci, ep_ring, false,
d0e96f5a
SS
3470 0,
3471 0,
3472 TRB_INTR_TARGET(0),
3473 /* Event on completion */
3474 field | TRB_IOC | TRB_TYPE(TRB_STATUS) | ep_ring->cycle_state);
3475
e9df17eb 3476 giveback_first_trb(xhci, slot_id, ep_index, 0,
e1eab2e0 3477 start_cycle, start_trb);
d0e96f5a
SS
3478 return 0;
3479}
3480
04e51901
AX
3481static int count_isoc_trbs_needed(struct xhci_hcd *xhci,
3482 struct urb *urb, int i)
3483{
3484 int num_trbs = 0;
48df4a6f 3485 u64 addr, td_len;
04e51901
AX
3486
3487 addr = (u64) (urb->transfer_dma + urb->iso_frame_desc[i].offset);
3488 td_len = urb->iso_frame_desc[i].length;
3489
48df4a6f
SS
3490 num_trbs = DIV_ROUND_UP(td_len + (addr & (TRB_MAX_BUFF_SIZE - 1)),
3491 TRB_MAX_BUFF_SIZE);
3492 if (num_trbs == 0)
04e51901 3493 num_trbs++;
04e51901
AX
3494
3495 return num_trbs;
3496}
3497
5cd43e33
SS
3498/*
3499 * The transfer burst count field of the isochronous TRB defines the number of
3500 * bursts that are required to move all packets in this TD. Only SuperSpeed
3501 * devices can burst up to bMaxBurst number of packets per service interval.
3502 * This field is zero based, meaning a value of zero in the field means one
3503 * burst. Basically, for everything but SuperSpeed devices, this field will be
3504 * zero. Only xHCI 1.0 host controllers support this field.
3505 */
3506static unsigned int xhci_get_burst_count(struct xhci_hcd *xhci,
3507 struct usb_device *udev,
3508 struct urb *urb, unsigned int total_packet_count)
3509{
3510 unsigned int max_burst;
3511
3512 if (xhci->hci_version < 0x100 || udev->speed != USB_SPEED_SUPER)
3513 return 0;
3514
3515 max_burst = urb->ep->ss_ep_comp.bMaxBurst;
3213b151 3516 return DIV_ROUND_UP(total_packet_count, max_burst + 1) - 1;
5cd43e33
SS
3517}
3518
b61d378f
SS
3519/*
3520 * Returns the number of packets in the last "burst" of packets. This field is
3521 * valid for all speeds of devices. USB 2.0 devices can only do one "burst", so
3522 * the last burst packet count is equal to the total number of packets in the
3523 * TD. SuperSpeed endpoints can have up to 3 bursts. All but the last burst
3524 * must contain (bMaxBurst + 1) number of packets, but the last burst can
3525 * contain 1 to (bMaxBurst + 1) packets.
3526 */
3527static unsigned int xhci_get_last_burst_packet_count(struct xhci_hcd *xhci,
3528 struct usb_device *udev,
3529 struct urb *urb, unsigned int total_packet_count)
3530{
3531 unsigned int max_burst;
3532 unsigned int residue;
3533
3534 if (xhci->hci_version < 0x100)
3535 return 0;
3536
3537 switch (udev->speed) {
3538 case USB_SPEED_SUPER:
3539 /* bMaxBurst is zero based: 0 means 1 packet per burst */
3540 max_burst = urb->ep->ss_ep_comp.bMaxBurst;
3541 residue = total_packet_count % (max_burst + 1);
3542 /* If residue is zero, the last burst contains (max_burst + 1)
3543 * number of packets, but the TLBPC field is zero-based.
3544 */
3545 if (residue == 0)
3546 return max_burst;
3547 return residue - 1;
3548 default:
3549 if (total_packet_count == 0)
3550 return 0;
3551 return total_packet_count - 1;
3552 }
3553}
3554
04e51901
AX
3555/* This is for isoc transfer */
3556static int xhci_queue_isoc_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
3557 struct urb *urb, int slot_id, unsigned int ep_index)
3558{
3559 struct xhci_ring *ep_ring;
3560 struct urb_priv *urb_priv;
3561 struct xhci_td *td;
3562 int num_tds, trbs_per_td;
3563 struct xhci_generic_trb *start_trb;
3564 bool first_trb;
3565 int start_cycle;
3566 u32 field, length_field;
3567 int running_total, trb_buff_len, td_len, td_remain_len, ret;
3568 u64 start_addr, addr;
3569 int i, j;
47cbf692 3570 bool more_trbs_coming;
04e51901
AX
3571
3572 ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
3573
3574 num_tds = urb->number_of_packets;
3575 if (num_tds < 1) {
3576 xhci_dbg(xhci, "Isoc URB with zero packets?\n");
3577 return -EINVAL;
3578 }
3579
04e51901
AX
3580 start_addr = (u64) urb->transfer_dma;
3581 start_trb = &ep_ring->enqueue->generic;
3582 start_cycle = ep_ring->cycle_state;
3583
522989a2 3584 urb_priv = urb->hcpriv;
04e51901
AX
3585 /* Queue the first TRB, even if it's zero-length */
3586 for (i = 0; i < num_tds; i++) {
4da6e6f2 3587 unsigned int total_packet_count;
5cd43e33 3588 unsigned int burst_count;
b61d378f 3589 unsigned int residue;
04e51901 3590
4da6e6f2 3591 first_trb = true;
04e51901
AX
3592 running_total = 0;
3593 addr = start_addr + urb->iso_frame_desc[i].offset;
3594 td_len = urb->iso_frame_desc[i].length;
3595 td_remain_len = td_len;
4525c0a1 3596 total_packet_count = DIV_ROUND_UP(td_len,
f18f8ed2
SS
3597 GET_MAX_PACKET(
3598 usb_endpoint_maxp(&urb->ep->desc)));
48df4a6f
SS
3599 /* A zero-length transfer still involves at least one packet. */
3600 if (total_packet_count == 0)
3601 total_packet_count++;
5cd43e33
SS
3602 burst_count = xhci_get_burst_count(xhci, urb->dev, urb,
3603 total_packet_count);
b61d378f
SS
3604 residue = xhci_get_last_burst_packet_count(xhci,
3605 urb->dev, urb, total_packet_count);
04e51901
AX
3606
3607 trbs_per_td = count_isoc_trbs_needed(xhci, urb, i);
3608
3609 ret = prepare_transfer(xhci, xhci->devs[slot_id], ep_index,
3b72fca0 3610 urb->stream_id, trbs_per_td, urb, i, mem_flags);
522989a2
SS
3611 if (ret < 0) {
3612 if (i == 0)
3613 return ret;
3614 goto cleanup;
3615 }
04e51901 3616
04e51901 3617 td = urb_priv->td[i];
04e51901
AX
3618 for (j = 0; j < trbs_per_td; j++) {
3619 u32 remainder = 0;
760973d2 3620 field = 0;
04e51901
AX
3621
3622 if (first_trb) {
760973d2
SS
3623 field = TRB_TBC(burst_count) |
3624 TRB_TLBPC(residue);
04e51901
AX
3625 /* Queue the isoc TRB */
3626 field |= TRB_TYPE(TRB_ISOC);
3627 /* Assume URB_ISO_ASAP is set */
3628 field |= TRB_SIA;
50f7b52a
AX
3629 if (i == 0) {
3630 if (start_cycle == 0)
3631 field |= 0x1;
3632 } else
04e51901
AX
3633 field |= ep_ring->cycle_state;
3634 first_trb = false;
3635 } else {
3636 /* Queue other normal TRBs */
3637 field |= TRB_TYPE(TRB_NORMAL);
3638 field |= ep_ring->cycle_state;
3639 }
3640
af8b9e63
SS
3641 /* Only set interrupt on short packet for IN EPs */
3642 if (usb_urb_dir_in(urb))
3643 field |= TRB_ISP;
3644
04e51901
AX
3645 /* Chain all the TRBs together; clear the chain bit in
3646 * the last TRB to indicate it's the last TRB in the
3647 * chain.
3648 */
3649 if (j < trbs_per_td - 1) {
3650 field |= TRB_CHAIN;
47cbf692 3651 more_trbs_coming = true;
04e51901
AX
3652 } else {
3653 td->last_trb = ep_ring->enqueue;
3654 field |= TRB_IOC;
80fab3b2
SS
3655 if (xhci->hci_version == 0x100 &&
3656 !(xhci->quirks &
3657 XHCI_AVOID_BEI)) {
ad106f29
AX
3658 /* Set BEI bit except for the last td */
3659 if (i < num_tds - 1)
3660 field |= TRB_BEI;
3661 }
47cbf692 3662 more_trbs_coming = false;
04e51901
AX
3663 }
3664
3665 /* Calculate TRB length */
3666 trb_buff_len = TRB_MAX_BUFF_SIZE -
3667 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
3668 if (trb_buff_len > td_remain_len)
3669 trb_buff_len = td_remain_len;
3670
4da6e6f2
SS
3671 /* Set the TRB length, TD size, & interrupter fields. */
3672 if (xhci->hci_version < 0x100) {
3673 remainder = xhci_td_remainder(
3674 td_len - running_total);
3675 } else {
3676 remainder = xhci_v1_0_td_remainder(
3677 running_total, trb_buff_len,
4525c0a1
SS
3678 total_packet_count, urb,
3679 (trbs_per_td - j - 1));
4da6e6f2 3680 }
04e51901
AX
3681 length_field = TRB_LEN(trb_buff_len) |
3682 remainder |
3683 TRB_INTR_TARGET(0);
4da6e6f2 3684
3b72fca0 3685 queue_trb(xhci, ep_ring, more_trbs_coming,
04e51901
AX
3686 lower_32_bits(addr),
3687 upper_32_bits(addr),
3688 length_field,
af8b9e63 3689 field);
04e51901
AX
3690 running_total += trb_buff_len;
3691
3692 addr += trb_buff_len;
3693 td_remain_len -= trb_buff_len;
3694 }
3695
3696 /* Check TD length */
3697 if (running_total != td_len) {
3698 xhci_err(xhci, "ISOC TD length unmatch\n");
cf840551
AX
3699 ret = -EINVAL;
3700 goto cleanup;
04e51901
AX
3701 }
3702 }
3703
c41136b0
AX
3704 if (xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs == 0) {
3705 if (xhci->quirks & XHCI_AMD_PLL_FIX)
3706 usb_amd_quirk_pll_disable();
3707 }
3708 xhci_to_hcd(xhci)->self.bandwidth_isoc_reqs++;
3709
e1eab2e0
AX
3710 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
3711 start_cycle, start_trb);
04e51901 3712 return 0;
522989a2
SS
3713cleanup:
3714 /* Clean up a partially enqueued isoc transfer. */
3715
3716 for (i--; i >= 0; i--)
585df1d9 3717 list_del_init(&urb_priv->td[i]->td_list);
522989a2
SS
3718
3719 /* Use the first TD as a temporary variable to turn the TDs we've queued
3720 * into No-ops with a software-owned cycle bit. That way the hardware
3721 * won't accidentally start executing bogus TDs when we partially
3722 * overwrite them. td->first_trb and td->start_seg are already set.
3723 */
3724 urb_priv->td[0]->last_trb = ep_ring->enqueue;
3725 /* Every TRB except the first & last will have its cycle bit flipped. */
3726 td_to_noop(xhci, ep_ring, urb_priv->td[0], true);
3727
3728 /* Reset the ring enqueue back to the first TRB and its cycle bit. */
3729 ep_ring->enqueue = urb_priv->td[0]->first_trb;
3730 ep_ring->enq_seg = urb_priv->td[0]->start_seg;
3731 ep_ring->cycle_state = start_cycle;
b008df60 3732 ep_ring->num_trbs_free = ep_ring->num_trbs_free_temp;
522989a2
SS
3733 usb_hcd_unlink_urb_from_ep(bus_to_hcd(urb->dev->bus), urb);
3734 return ret;
04e51901
AX
3735}
3736
3737/*
3738 * Check transfer ring to guarantee there is enough room for the urb.
3739 * Update ISO URB start_frame and interval.
3740 * Update interval as xhci_queue_intr_tx does. Just use xhci frame_index to
3741 * update the urb->start_frame by now.
3742 * Always assume URB_ISO_ASAP set, and NEVER use urb->start_frame as input.
3743 */
3744int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
3745 struct urb *urb, int slot_id, unsigned int ep_index)
3746{
3747 struct xhci_virt_device *xdev;
3748 struct xhci_ring *ep_ring;
3749 struct xhci_ep_ctx *ep_ctx;
3750 int start_frame;
3751 int xhci_interval;
3752 int ep_interval;
3753 int num_tds, num_trbs, i;
3754 int ret;
3755
3756 xdev = xhci->devs[slot_id];
3757 ep_ring = xdev->eps[ep_index].ring;
3758 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
3759
3760 num_trbs = 0;
3761 num_tds = urb->number_of_packets;
3762 for (i = 0; i < num_tds; i++)
3763 num_trbs += count_isoc_trbs_needed(xhci, urb, i);
3764
3765 /* Check the ring to guarantee there is enough room for the whole urb.
3766 * Do not insert any td of the urb to the ring if the check failed.
3767 */
28ccd296 3768 ret = prepare_ring(xhci, ep_ring, le32_to_cpu(ep_ctx->ep_info) & EP_STATE_MASK,
3b72fca0 3769 num_trbs, mem_flags);
04e51901
AX
3770 if (ret)
3771 return ret;
3772
b0ba9720 3773 start_frame = readl(&xhci->run_regs->microframe_index);
04e51901
AX
3774 start_frame &= 0x3fff;
3775
3776 urb->start_frame = start_frame;
3777 if (urb->dev->speed == USB_SPEED_LOW ||
3778 urb->dev->speed == USB_SPEED_FULL)
3779 urb->start_frame >>= 3;
3780
28ccd296 3781 xhci_interval = EP_INTERVAL_TO_UFRAMES(le32_to_cpu(ep_ctx->ep_info));
04e51901
AX
3782 ep_interval = urb->interval;
3783 /* Convert to microframes */
3784 if (urb->dev->speed == USB_SPEED_LOW ||
3785 urb->dev->speed == USB_SPEED_FULL)
3786 ep_interval *= 8;
3787 /* FIXME change this to a warning and a suggestion to use the new API
3788 * to set the polling interval (once the API is added).
3789 */
3790 if (xhci_interval != ep_interval) {
0730d52a
DK
3791 dev_dbg_ratelimited(&urb->dev->dev,
3792 "Driver uses different interval (%d microframe%s) than xHCI (%d microframe%s)\n",
3793 ep_interval, ep_interval == 1 ? "" : "s",
3794 xhci_interval, xhci_interval == 1 ? "" : "s");
04e51901
AX
3795 urb->interval = xhci_interval;
3796 /* Convert back to frames for LS/FS devices */
3797 if (urb->dev->speed == USB_SPEED_LOW ||
3798 urb->dev->speed == USB_SPEED_FULL)
3799 urb->interval /= 8;
3800 }
b008df60
AX
3801 ep_ring->num_trbs_free_temp = ep_ring->num_trbs_free;
3802
3fc8206d 3803 return xhci_queue_isoc_tx(xhci, mem_flags, urb, slot_id, ep_index);
04e51901
AX
3804}
3805
d0e96f5a
SS
3806/**** Command Ring Operations ****/
3807
913a8a34
SS
3808/* Generic function for queueing a command TRB on the command ring.
3809 * Check to make sure there's room on the command ring for one command TRB.
3810 * Also check that there's room reserved for commands that must not fail.
3811 * If this is a command that must not fail, meaning command_must_succeed = TRUE,
3812 * then only check for the number of reserved spots.
3813 * Don't decrement xhci->cmd_ring_reserved_trbs after we've queued the TRB
3814 * because the command event handler may want to resubmit a failed command.
3815 */
ddba5cd0
MN
3816static int queue_command(struct xhci_hcd *xhci, struct xhci_command *cmd,
3817 u32 field1, u32 field2,
3818 u32 field3, u32 field4, bool command_must_succeed)
7f84eef0 3819{
913a8a34 3820 int reserved_trbs = xhci->cmd_ring_reserved_trbs;
d1dc908a 3821 int ret;
c9aa1a2d
MN
3822 if (xhci->xhc_state & XHCI_STATE_DYING)
3823 return -ESHUTDOWN;
d1dc908a 3824
913a8a34
SS
3825 if (!command_must_succeed)
3826 reserved_trbs++;
3827
d1dc908a 3828 ret = prepare_ring(xhci, xhci->cmd_ring, EP_STATE_RUNNING,
3b72fca0 3829 reserved_trbs, GFP_ATOMIC);
d1dc908a
SS
3830 if (ret < 0) {
3831 xhci_err(xhci, "ERR: No room for command on command ring\n");
913a8a34
SS
3832 if (command_must_succeed)
3833 xhci_err(xhci, "ERR: Reserved TRB counting for "
3834 "unfailable commands failed.\n");
d1dc908a 3835 return ret;
7f84eef0 3836 }
c9aa1a2d
MN
3837
3838 cmd->command_trb = xhci->cmd_ring->enqueue;
3839 list_add_tail(&cmd->cmd_list, &xhci->cmd_list);
ddba5cd0 3840
c311e391
MN
3841 /* if there are no other commands queued we start the timeout timer */
3842 if (xhci->cmd_list.next == &cmd->cmd_list &&
3843 !timer_pending(&xhci->cmd_timer)) {
3844 xhci->current_cmd = cmd;
3845 mod_timer(&xhci->cmd_timer, jiffies + XHCI_CMD_DEFAULT_TIMEOUT);
3846 }
3847
3b72fca0
AX
3848 queue_trb(xhci, xhci->cmd_ring, false, field1, field2, field3,
3849 field4 | xhci->cmd_ring->cycle_state);
7f84eef0
SS
3850 return 0;
3851}
3852
3ffbba95 3853/* Queue a slot enable or disable request on the command ring */
ddba5cd0
MN
3854int xhci_queue_slot_control(struct xhci_hcd *xhci, struct xhci_command *cmd,
3855 u32 trb_type, u32 slot_id)
3ffbba95 3856{
ddba5cd0 3857 return queue_command(xhci, cmd, 0, 0, 0,
913a8a34 3858 TRB_TYPE(trb_type) | SLOT_ID_FOR_TRB(slot_id), false);
3ffbba95
SS
3859}
3860
3861/* Queue an address device command TRB */
ddba5cd0
MN
3862int xhci_queue_address_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
3863 dma_addr_t in_ctx_ptr, u32 slot_id, enum xhci_setup_dev setup)
3ffbba95 3864{
ddba5cd0 3865 return queue_command(xhci, cmd, lower_32_bits(in_ctx_ptr),
8e595a5d 3866 upper_32_bits(in_ctx_ptr), 0,
48fc7dbd
DW
3867 TRB_TYPE(TRB_ADDR_DEV) | SLOT_ID_FOR_TRB(slot_id)
3868 | (setup == SETUP_CONTEXT_ONLY ? TRB_BSR : 0), false);
2a8f82c4
SS
3869}
3870
ddba5cd0 3871int xhci_queue_vendor_command(struct xhci_hcd *xhci, struct xhci_command *cmd,
0238634d
SS
3872 u32 field1, u32 field2, u32 field3, u32 field4)
3873{
ddba5cd0 3874 return queue_command(xhci, cmd, field1, field2, field3, field4, false);
0238634d
SS
3875}
3876
2a8f82c4 3877/* Queue a reset device command TRB */
ddba5cd0
MN
3878int xhci_queue_reset_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
3879 u32 slot_id)
2a8f82c4 3880{
ddba5cd0 3881 return queue_command(xhci, cmd, 0, 0, 0,
2a8f82c4 3882 TRB_TYPE(TRB_RESET_DEV) | SLOT_ID_FOR_TRB(slot_id),
913a8a34 3883 false);
3ffbba95 3884}
f94e0186
SS
3885
3886/* Queue a configure endpoint command TRB */
ddba5cd0
MN
3887int xhci_queue_configure_endpoint(struct xhci_hcd *xhci,
3888 struct xhci_command *cmd, dma_addr_t in_ctx_ptr,
913a8a34 3889 u32 slot_id, bool command_must_succeed)
f94e0186 3890{
ddba5cd0 3891 return queue_command(xhci, cmd, lower_32_bits(in_ctx_ptr),
8e595a5d 3892 upper_32_bits(in_ctx_ptr), 0,
913a8a34
SS
3893 TRB_TYPE(TRB_CONFIG_EP) | SLOT_ID_FOR_TRB(slot_id),
3894 command_must_succeed);
f94e0186 3895}
ae636747 3896
f2217e8e 3897/* Queue an evaluate context command TRB */
ddba5cd0
MN
3898int xhci_queue_evaluate_context(struct xhci_hcd *xhci, struct xhci_command *cmd,
3899 dma_addr_t in_ctx_ptr, u32 slot_id, bool command_must_succeed)
f2217e8e 3900{
ddba5cd0 3901 return queue_command(xhci, cmd, lower_32_bits(in_ctx_ptr),
f2217e8e 3902 upper_32_bits(in_ctx_ptr), 0,
913a8a34 3903 TRB_TYPE(TRB_EVAL_CONTEXT) | SLOT_ID_FOR_TRB(slot_id),
4b266541 3904 command_must_succeed);
f2217e8e
SS
3905}
3906
be88fe4f
AX
3907/*
3908 * Suspend is set to indicate "Stop Endpoint Command" is being issued to stop
3909 * activity on an endpoint that is about to be suspended.
3910 */
ddba5cd0
MN
3911int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, struct xhci_command *cmd,
3912 int slot_id, unsigned int ep_index, int suspend)
ae636747
SS
3913{
3914 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3915 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3916 u32 type = TRB_TYPE(TRB_STOP_RING);
be88fe4f 3917 u32 trb_suspend = SUSPEND_PORT_FOR_TRB(suspend);
ae636747 3918
ddba5cd0 3919 return queue_command(xhci, cmd, 0, 0, 0,
be88fe4f 3920 trb_slot_id | trb_ep_index | type | trb_suspend, false);
ae636747
SS
3921}
3922
3923/* Set Transfer Ring Dequeue Pointer command.
3924 * This should not be used for endpoints that have streams enabled.
3925 */
1e3452e3 3926static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
ddba5cd0
MN
3927 unsigned int ep_index, unsigned int stream_id,
3928 struct xhci_segment *deq_seg,
3929 union xhci_trb *deq_ptr, u32 cycle_state)
ae636747
SS
3930{
3931 dma_addr_t addr;
3932 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3933 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
e9df17eb 3934 u32 trb_stream_id = STREAM_ID_FOR_TRB(stream_id);
95241dbd 3935 u32 trb_sct = 0;
ae636747 3936 u32 type = TRB_TYPE(TRB_SET_DEQ);
bf161e85 3937 struct xhci_virt_ep *ep;
1e3452e3
HG
3938 struct xhci_command *cmd;
3939 int ret;
ae636747 3940
23e3be11 3941 addr = xhci_trb_virt_to_dma(deq_seg, deq_ptr);
c92bcfa7 3942 if (addr == 0) {
ae636747 3943 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
700e2052
GKH
3944 xhci_warn(xhci, "WARN deq seg = %p, deq pt = %p\n",
3945 deq_seg, deq_ptr);
c92bcfa7
SS
3946 return 0;
3947 }
bf161e85
SS
3948 ep = &xhci->devs[slot_id]->eps[ep_index];
3949 if ((ep->ep_state & SET_DEQ_PENDING)) {
3950 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
3951 xhci_warn(xhci, "A Set TR Deq Ptr command is pending.\n");
3952 return 0;
3953 }
1e3452e3
HG
3954
3955 /* This function gets called from contexts where it cannot sleep */
3956 cmd = xhci_alloc_command(xhci, false, false, GFP_ATOMIC);
3957 if (!cmd) {
3958 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr: ENOMEM\n");
3959 return 0;
3960 }
3961
bf161e85
SS
3962 ep->queued_deq_seg = deq_seg;
3963 ep->queued_deq_ptr = deq_ptr;
95241dbd
HG
3964 if (stream_id)
3965 trb_sct = SCT_FOR_TRB(SCT_PRI_TR);
1e3452e3 3966 ret = queue_command(xhci, cmd,
ddba5cd0 3967 lower_32_bits(addr) | trb_sct | cycle_state,
e9df17eb 3968 upper_32_bits(addr), trb_stream_id,
913a8a34 3969 trb_slot_id | trb_ep_index | type, false);
1e3452e3
HG
3970 if (ret < 0) {
3971 xhci_free_command(xhci, cmd);
3972 return ret;
3973 }
3974
3975 return 0;
ae636747 3976}
a1587d97 3977
ddba5cd0
MN
3978int xhci_queue_reset_ep(struct xhci_hcd *xhci, struct xhci_command *cmd,
3979 int slot_id, unsigned int ep_index)
a1587d97
SS
3980{
3981 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
3982 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
3983 u32 type = TRB_TYPE(TRB_RESET_EP);
3984
ddba5cd0
MN
3985 return queue_command(xhci, cmd, 0, 0, 0,
3986 trb_slot_id | trb_ep_index | type, false);
a1587d97 3987}