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