]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/usb/host/xhci-ring.c
USB: xhci: Handle stalled control endpoints.
[mirror_ubuntu-artful-kernel.git] / drivers / usb / host / xhci-ring.c
CommitLineData
7f84eef0
SS
1/*
2 * xHCI host controller driver
3 *
4 * Copyright (C) 2008 Intel Corp.
5 *
6 * Author: Sarah Sharp
7 * Some code borrowed from the Linux EHCI driver.
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 * for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23/*
24 * Ring initialization rules:
25 * 1. Each segment is initialized to zero, except for link TRBs.
26 * 2. Ring cycle state = 0. This represents Producer Cycle State (PCS) or
27 * Consumer Cycle State (CCS), depending on ring function.
28 * 3. Enqueue pointer = dequeue pointer = address of first TRB in the segment.
29 *
30 * Ring behavior rules:
31 * 1. A ring is empty if enqueue == dequeue. This means there will always be at
32 * least one free TRB in the ring. This is useful if you want to turn that
33 * into a link TRB and expand the ring.
34 * 2. When incrementing an enqueue or dequeue pointer, if the next TRB is a
35 * link TRB, then load the pointer with the address in the link TRB. If the
36 * link TRB had its toggle bit set, you may need to update the ring cycle
37 * state (see cycle bit rules). You may have to do this multiple times
38 * until you reach a non-link TRB.
39 * 3. A ring is full if enqueue++ (for the definition of increment above)
40 * equals the dequeue pointer.
41 *
42 * Cycle bit rules:
43 * 1. When a consumer increments a dequeue pointer and encounters a toggle bit
44 * in a link TRB, it must toggle the ring cycle state.
45 * 2. When a producer increments an enqueue pointer and encounters a toggle bit
46 * in a link TRB, it must toggle the ring cycle state.
47 *
48 * Producer rules:
49 * 1. Check if ring is full before you enqueue.
50 * 2. Write the ring cycle state to the cycle bit in the TRB you're enqueuing.
51 * Update enqueue pointer between each write (which may update the ring
52 * cycle state).
53 * 3. Notify consumer. If SW is producer, it rings the doorbell for command
54 * and endpoint rings. If HC is the producer for the event ring,
55 * and it generates an interrupt according to interrupt modulation rules.
56 *
57 * Consumer rules:
58 * 1. Check if TRB belongs to you. If the cycle bit == your ring cycle state,
59 * the TRB is owned by the consumer.
60 * 2. Update dequeue pointer (which may update the ring cycle state) and
61 * continue processing TRBs until you reach a TRB which is not owned by you.
62 * 3. Notify the producer. SW is the consumer for the event ring, and it
63 * updates event ring dequeue pointer. HC is the consumer for the command and
64 * endpoint rings; it generates events on the event ring for these.
65 */
66
8a96c052 67#include <linux/scatterlist.h>
7f84eef0
SS
68#include "xhci.h"
69
70/*
71 * Returns zero if the TRB isn't in this segment, otherwise it returns the DMA
72 * address of the TRB.
73 */
23e3be11 74dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg,
7f84eef0
SS
75 union xhci_trb *trb)
76{
6071d836 77 unsigned long segment_offset;
7f84eef0 78
6071d836 79 if (!seg || !trb || trb < seg->trbs)
7f84eef0 80 return 0;
6071d836
SS
81 /* offset in TRBs */
82 segment_offset = trb - seg->trbs;
83 if (segment_offset > TRBS_PER_SEGMENT)
7f84eef0 84 return 0;
6071d836 85 return seg->dma + (segment_offset * sizeof(*trb));
7f84eef0
SS
86}
87
88/* Does this link TRB point to the first segment in a ring,
89 * or was the previous TRB the last TRB on the last segment in the ERST?
90 */
91static inline bool last_trb_on_last_seg(struct xhci_hcd *xhci, struct xhci_ring *ring,
92 struct xhci_segment *seg, union xhci_trb *trb)
93{
94 if (ring == xhci->event_ring)
95 return (trb == &seg->trbs[TRBS_PER_SEGMENT]) &&
96 (seg->next == xhci->event_ring->first_seg);
97 else
98 return trb->link.control & LINK_TOGGLE;
99}
100
101/* Is this TRB a link TRB or was the last TRB the last TRB in this event ring
102 * segment? I.e. would the updated event TRB pointer step off the end of the
103 * event seg?
104 */
105static inline int last_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
106 struct xhci_segment *seg, union xhci_trb *trb)
107{
108 if (ring == xhci->event_ring)
109 return trb == &seg->trbs[TRBS_PER_SEGMENT];
110 else
111 return (trb->link.control & TRB_TYPE_BITMASK) == TRB_TYPE(TRB_LINK);
112}
113
ae636747
SS
114/* Updates trb to point to the next TRB in the ring, and updates seg if the next
115 * TRB is in a new segment. This does not skip over link TRBs, and it does not
116 * effect the ring dequeue or enqueue pointers.
117 */
118static void next_trb(struct xhci_hcd *xhci,
119 struct xhci_ring *ring,
120 struct xhci_segment **seg,
121 union xhci_trb **trb)
122{
123 if (last_trb(xhci, ring, *seg, *trb)) {
124 *seg = (*seg)->next;
125 *trb = ((*seg)->trbs);
126 } else {
127 *trb = (*trb)++;
128 }
129}
130
7f84eef0
SS
131/*
132 * See Cycle bit rules. SW is the consumer for the event ring only.
133 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
134 */
135static void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring, bool consumer)
136{
137 union xhci_trb *next = ++(ring->dequeue);
66e49d87 138 unsigned long long addr;
7f84eef0
SS
139
140 ring->deq_updates++;
141 /* Update the dequeue pointer further if that was a link TRB or we're at
142 * the end of an event ring segment (which doesn't have link TRBS)
143 */
144 while (last_trb(xhci, ring, ring->deq_seg, next)) {
145 if (consumer && last_trb_on_last_seg(xhci, ring, ring->deq_seg, next)) {
146 ring->cycle_state = (ring->cycle_state ? 0 : 1);
147 if (!in_interrupt())
700e2052
GKH
148 xhci_dbg(xhci, "Toggle cycle state for ring %p = %i\n",
149 ring,
7f84eef0
SS
150 (unsigned int) ring->cycle_state);
151 }
152 ring->deq_seg = ring->deq_seg->next;
153 ring->dequeue = ring->deq_seg->trbs;
154 next = ring->dequeue;
155 }
66e49d87
SS
156 addr = (unsigned long long) xhci_trb_virt_to_dma(ring->deq_seg, ring->dequeue);
157 if (ring == xhci->event_ring)
158 xhci_dbg(xhci, "Event ring deq = 0x%llx (DMA)\n", addr);
159 else if (ring == xhci->cmd_ring)
160 xhci_dbg(xhci, "Command ring deq = 0x%llx (DMA)\n", addr);
161 else
162 xhci_dbg(xhci, "Ring deq = 0x%llx (DMA)\n", addr);
7f84eef0
SS
163}
164
165/*
166 * See Cycle bit rules. SW is the consumer for the event ring only.
167 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
168 *
169 * If we've just enqueued a TRB that is in the middle of a TD (meaning the
170 * chain bit is set), then set the chain bit in all the following link TRBs.
171 * If we've enqueued the last TRB in a TD, make sure the following link TRBs
172 * have their chain bit cleared (so that each Link TRB is a separate TD).
173 *
174 * Section 6.4.4.1 of the 0.95 spec says link TRBs cannot have the chain bit
b0567b3f
SS
175 * set, but other sections talk about dealing with the chain bit set. This was
176 * fixed in the 0.96 specification errata, but we have to assume that all 0.95
177 * xHCI hardware can't handle the chain bit being cleared on a link TRB.
7f84eef0
SS
178 */
179static void inc_enq(struct xhci_hcd *xhci, struct xhci_ring *ring, bool consumer)
180{
181 u32 chain;
182 union xhci_trb *next;
66e49d87 183 unsigned long long addr;
7f84eef0
SS
184
185 chain = ring->enqueue->generic.field[3] & TRB_CHAIN;
186 next = ++(ring->enqueue);
187
188 ring->enq_updates++;
189 /* Update the dequeue pointer further if that was a link TRB or we're at
190 * the end of an event ring segment (which doesn't have link TRBS)
191 */
192 while (last_trb(xhci, ring, ring->enq_seg, next)) {
193 if (!consumer) {
194 if (ring != xhci->event_ring) {
b0567b3f
SS
195 /* If we're not dealing with 0.95 hardware,
196 * carry over the chain bit of the previous TRB
197 * (which may mean the chain bit is cleared).
198 */
199 if (!xhci_link_trb_quirk(xhci)) {
200 next->link.control &= ~TRB_CHAIN;
201 next->link.control |= chain;
202 }
7f84eef0 203 /* Give this link TRB to the hardware */
b7116ebc 204 wmb();
7f84eef0
SS
205 if (next->link.control & TRB_CYCLE)
206 next->link.control &= (u32) ~TRB_CYCLE;
207 else
208 next->link.control |= (u32) TRB_CYCLE;
7f84eef0
SS
209 }
210 /* Toggle the cycle bit after the last ring segment. */
211 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
212 ring->cycle_state = (ring->cycle_state ? 0 : 1);
213 if (!in_interrupt())
700e2052
GKH
214 xhci_dbg(xhci, "Toggle cycle state for ring %p = %i\n",
215 ring,
7f84eef0
SS
216 (unsigned int) ring->cycle_state);
217 }
218 }
219 ring->enq_seg = ring->enq_seg->next;
220 ring->enqueue = ring->enq_seg->trbs;
221 next = ring->enqueue;
222 }
66e49d87
SS
223 addr = (unsigned long long) xhci_trb_virt_to_dma(ring->enq_seg, ring->enqueue);
224 if (ring == xhci->event_ring)
225 xhci_dbg(xhci, "Event ring enq = 0x%llx (DMA)\n", addr);
226 else if (ring == xhci->cmd_ring)
227 xhci_dbg(xhci, "Command ring enq = 0x%llx (DMA)\n", addr);
228 else
229 xhci_dbg(xhci, "Ring enq = 0x%llx (DMA)\n", addr);
7f84eef0
SS
230}
231
232/*
233 * Check to see if there's room to enqueue num_trbs on the ring. See rules
234 * above.
235 * FIXME: this would be simpler and faster if we just kept track of the number
236 * of free TRBs in a ring.
237 */
238static int room_on_ring(struct xhci_hcd *xhci, struct xhci_ring *ring,
239 unsigned int num_trbs)
240{
241 int i;
242 union xhci_trb *enq = ring->enqueue;
243 struct xhci_segment *enq_seg = ring->enq_seg;
244
245 /* Check if ring is empty */
246 if (enq == ring->dequeue)
247 return 1;
248 /* Make sure there's an extra empty TRB available */
249 for (i = 0; i <= num_trbs; ++i) {
250 if (enq == ring->dequeue)
251 return 0;
252 enq++;
253 while (last_trb(xhci, ring, enq_seg, enq)) {
254 enq_seg = enq_seg->next;
255 enq = enq_seg->trbs;
256 }
257 }
258 return 1;
259}
260
23e3be11 261void xhci_set_hc_event_deq(struct xhci_hcd *xhci)
7f84eef0 262{
8e595a5d 263 u64 temp;
7f84eef0
SS
264 dma_addr_t deq;
265
23e3be11 266 deq = xhci_trb_virt_to_dma(xhci->event_ring->deq_seg,
7f84eef0
SS
267 xhci->event_ring->dequeue);
268 if (deq == 0 && !in_interrupt())
269 xhci_warn(xhci, "WARN something wrong with SW event ring "
270 "dequeue ptr.\n");
271 /* Update HC event ring dequeue pointer */
8e595a5d 272 temp = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
7f84eef0 273 temp &= ERST_PTR_MASK;
2d83109b
SS
274 /* Don't clear the EHB bit (which is RW1C) because
275 * there might be more events to service.
276 */
277 temp &= ~ERST_EHB;
66e49d87 278 xhci_dbg(xhci, "// Write event ring dequeue pointer, preserving EHB bit\n");
8e595a5d
SS
279 xhci_write_64(xhci, ((u64) deq & (u64) ~ERST_PTR_MASK) | temp,
280 &xhci->ir_set->erst_dequeue);
7f84eef0
SS
281}
282
283/* Ring the host controller doorbell after placing a command on the ring */
23e3be11 284void xhci_ring_cmd_db(struct xhci_hcd *xhci)
7f84eef0
SS
285{
286 u32 temp;
287
288 xhci_dbg(xhci, "// Ding dong!\n");
289 temp = xhci_readl(xhci, &xhci->dba->doorbell[0]) & DB_MASK;
290 xhci_writel(xhci, temp | DB_TARGET_HOST, &xhci->dba->doorbell[0]);
291 /* Flush PCI posted writes */
292 xhci_readl(xhci, &xhci->dba->doorbell[0]);
293}
294
ae636747
SS
295static void ring_ep_doorbell(struct xhci_hcd *xhci,
296 unsigned int slot_id,
297 unsigned int ep_index)
298{
299 struct xhci_ring *ep_ring;
300 u32 field;
301 __u32 __iomem *db_addr = &xhci->dba->doorbell[slot_id];
302
303 ep_ring = xhci->devs[slot_id]->ep_rings[ep_index];
304 /* Don't ring the doorbell for this endpoint if there are pending
305 * cancellations because the we don't want to interrupt processing.
306 */
a1587d97
SS
307 if (!ep_ring->cancels_pending && !(ep_ring->state & SET_DEQ_PENDING)
308 && !(ep_ring->state & EP_HALTED)) {
ae636747
SS
309 field = xhci_readl(xhci, db_addr) & DB_MASK;
310 xhci_writel(xhci, field | EPI_TO_DB(ep_index), db_addr);
311 /* Flush PCI posted writes - FIXME Matthew Wilcox says this
312 * isn't time-critical and we shouldn't make the CPU wait for
313 * the flush.
314 */
315 xhci_readl(xhci, db_addr);
316 }
317}
318
319/*
320 * Find the segment that trb is in. Start searching in start_seg.
321 * If we must move past a segment that has a link TRB with a toggle cycle state
322 * bit set, then we will toggle the value pointed at by cycle_state.
323 */
324static struct xhci_segment *find_trb_seg(
325 struct xhci_segment *start_seg,
326 union xhci_trb *trb, int *cycle_state)
327{
328 struct xhci_segment *cur_seg = start_seg;
329 struct xhci_generic_trb *generic_trb;
330
331 while (cur_seg->trbs > trb ||
332 &cur_seg->trbs[TRBS_PER_SEGMENT - 1] < trb) {
333 generic_trb = &cur_seg->trbs[TRBS_PER_SEGMENT - 1].generic;
334 if (TRB_TYPE(generic_trb->field[3]) == TRB_LINK &&
335 (generic_trb->field[3] & LINK_TOGGLE))
336 *cycle_state = ~(*cycle_state) & 0x1;
337 cur_seg = cur_seg->next;
338 if (cur_seg == start_seg)
339 /* Looped over the entire list. Oops! */
340 return 0;
341 }
342 return cur_seg;
343}
344
ae636747
SS
345/*
346 * Move the xHC's endpoint ring dequeue pointer past cur_td.
347 * Record the new state of the xHC's endpoint ring dequeue segment,
348 * dequeue pointer, and new consumer cycle state in state.
349 * Update our internal representation of the ring's dequeue pointer.
350 *
351 * We do this in three jumps:
352 * - First we update our new ring state to be the same as when the xHC stopped.
353 * - Then we traverse the ring to find the segment that contains
354 * the last TRB in the TD. We toggle the xHC's new cycle state when we pass
355 * any link TRBs with the toggle cycle bit set.
356 * - Finally we move the dequeue state one TRB further, toggling the cycle bit
357 * if we've moved it past a link TRB with the toggle cycle bit set.
358 */
c92bcfa7 359void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
ae636747 360 unsigned int slot_id, unsigned int ep_index,
c92bcfa7 361 struct xhci_td *cur_td, struct xhci_dequeue_state *state)
ae636747
SS
362{
363 struct xhci_virt_device *dev = xhci->devs[slot_id];
364 struct xhci_ring *ep_ring = dev->ep_rings[ep_index];
365 struct xhci_generic_trb *trb;
d115b048 366 struct xhci_ep_ctx *ep_ctx;
c92bcfa7 367 dma_addr_t addr;
ae636747
SS
368
369 state->new_cycle_state = 0;
c92bcfa7 370 xhci_dbg(xhci, "Finding segment containing stopped TRB.\n");
ae636747
SS
371 state->new_deq_seg = find_trb_seg(cur_td->start_seg,
372 ep_ring->stopped_trb,
373 &state->new_cycle_state);
374 if (!state->new_deq_seg)
375 BUG();
376 /* Dig out the cycle state saved by the xHC during the stop ep cmd */
c92bcfa7 377 xhci_dbg(xhci, "Finding endpoint context\n");
d115b048
JY
378 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
379 state->new_cycle_state = 0x1 & ep_ctx->deq;
ae636747
SS
380
381 state->new_deq_ptr = cur_td->last_trb;
c92bcfa7 382 xhci_dbg(xhci, "Finding segment containing last TRB in TD.\n");
ae636747
SS
383 state->new_deq_seg = find_trb_seg(state->new_deq_seg,
384 state->new_deq_ptr,
385 &state->new_cycle_state);
386 if (!state->new_deq_seg)
387 BUG();
388
389 trb = &state->new_deq_ptr->generic;
390 if (TRB_TYPE(trb->field[3]) == TRB_LINK &&
391 (trb->field[3] & LINK_TOGGLE))
392 state->new_cycle_state = ~(state->new_cycle_state) & 0x1;
393 next_trb(xhci, ep_ring, &state->new_deq_seg, &state->new_deq_ptr);
394
395 /* Don't update the ring cycle state for the producer (us). */
c92bcfa7
SS
396 xhci_dbg(xhci, "New dequeue segment = %p (virtual)\n",
397 state->new_deq_seg);
398 addr = xhci_trb_virt_to_dma(state->new_deq_seg, state->new_deq_ptr);
399 xhci_dbg(xhci, "New dequeue pointer = 0x%llx (DMA)\n",
400 (unsigned long long) addr);
401 xhci_dbg(xhci, "Setting dequeue pointer in internal ring state.\n");
ae636747
SS
402 ep_ring->dequeue = state->new_deq_ptr;
403 ep_ring->deq_seg = state->new_deq_seg;
404}
405
23e3be11 406static void td_to_noop(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
ae636747
SS
407 struct xhci_td *cur_td)
408{
409 struct xhci_segment *cur_seg;
410 union xhci_trb *cur_trb;
411
412 for (cur_seg = cur_td->start_seg, cur_trb = cur_td->first_trb;
413 true;
414 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
415 if ((cur_trb->generic.field[3] & TRB_TYPE_BITMASK) ==
416 TRB_TYPE(TRB_LINK)) {
417 /* Unchain any chained Link TRBs, but
418 * leave the pointers intact.
419 */
420 cur_trb->generic.field[3] &= ~TRB_CHAIN;
421 xhci_dbg(xhci, "Cancel (unchain) link TRB\n");
700e2052
GKH
422 xhci_dbg(xhci, "Address = %p (0x%llx dma); "
423 "in seg %p (0x%llx dma)\n",
424 cur_trb,
23e3be11 425 (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
700e2052
GKH
426 cur_seg,
427 (unsigned long long)cur_seg->dma);
ae636747
SS
428 } else {
429 cur_trb->generic.field[0] = 0;
430 cur_trb->generic.field[1] = 0;
431 cur_trb->generic.field[2] = 0;
432 /* Preserve only the cycle bit of this TRB */
433 cur_trb->generic.field[3] &= TRB_CYCLE;
434 cur_trb->generic.field[3] |= TRB_TYPE(TRB_TR_NOOP);
700e2052
GKH
435 xhci_dbg(xhci, "Cancel TRB %p (0x%llx dma) "
436 "in seg %p (0x%llx dma)\n",
437 cur_trb,
23e3be11 438 (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
700e2052
GKH
439 cur_seg,
440 (unsigned long long)cur_seg->dma);
ae636747
SS
441 }
442 if (cur_trb == cur_td->last_trb)
443 break;
444 }
445}
446
447static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
448 unsigned int ep_index, struct xhci_segment *deq_seg,
449 union xhci_trb *deq_ptr, u32 cycle_state);
450
c92bcfa7
SS
451void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
452 struct xhci_ring *ep_ring, unsigned int slot_id,
453 unsigned int ep_index, struct xhci_dequeue_state *deq_state)
454{
455 xhci_dbg(xhci, "Set TR Deq Ptr cmd, new deq seg = %p (0x%llx dma), "
456 "new deq ptr = %p (0x%llx dma), new cycle = %u\n",
457 deq_state->new_deq_seg,
458 (unsigned long long)deq_state->new_deq_seg->dma,
459 deq_state->new_deq_ptr,
460 (unsigned long long)xhci_trb_virt_to_dma(deq_state->new_deq_seg, deq_state->new_deq_ptr),
461 deq_state->new_cycle_state);
462 queue_set_tr_deq(xhci, slot_id, ep_index,
463 deq_state->new_deq_seg,
464 deq_state->new_deq_ptr,
465 (u32) deq_state->new_cycle_state);
466 /* Stop the TD queueing code from ringing the doorbell until
467 * this command completes. The HC won't set the dequeue pointer
468 * if the ring is running, and ringing the doorbell starts the
469 * ring running.
470 */
471 ep_ring->state |= SET_DEQ_PENDING;
472 xhci_ring_cmd_db(xhci);
473}
474
ae636747
SS
475/*
476 * When we get a command completion for a Stop Endpoint Command, we need to
477 * unlink any cancelled TDs from the ring. There are two ways to do that:
478 *
479 * 1. If the HW was in the middle of processing the TD that needs to be
480 * cancelled, then we must move the ring's dequeue pointer past the last TRB
481 * in the TD with a Set Dequeue Pointer Command.
482 * 2. Otherwise, we turn all the TRBs in the TD into No-op TRBs (with the chain
483 * bit cleared) so that the HW will skip over them.
484 */
485static void handle_stopped_endpoint(struct xhci_hcd *xhci,
486 union xhci_trb *trb)
487{
488 unsigned int slot_id;
489 unsigned int ep_index;
490 struct xhci_ring *ep_ring;
491 struct list_head *entry;
492 struct xhci_td *cur_td = 0;
493 struct xhci_td *last_unlinked_td;
494
c92bcfa7 495 struct xhci_dequeue_state deq_state;
ae636747
SS
496#ifdef CONFIG_USB_HCD_STAT
497 ktime_t stop_time = ktime_get();
498#endif
499
500 memset(&deq_state, 0, sizeof(deq_state));
501 slot_id = TRB_TO_SLOT_ID(trb->generic.field[3]);
502 ep_index = TRB_TO_EP_INDEX(trb->generic.field[3]);
503 ep_ring = xhci->devs[slot_id]->ep_rings[ep_index];
504
505 if (list_empty(&ep_ring->cancelled_td_list))
506 return;
507
508 /* Fix up the ep ring first, so HW stops executing cancelled TDs.
509 * We have the xHCI lock, so nothing can modify this list until we drop
510 * it. We're also in the event handler, so we can't get re-interrupted
511 * if another Stop Endpoint command completes
512 */
513 list_for_each(entry, &ep_ring->cancelled_td_list) {
514 cur_td = list_entry(entry, struct xhci_td, cancelled_td_list);
700e2052
GKH
515 xhci_dbg(xhci, "Cancelling TD starting at %p, 0x%llx (dma).\n",
516 cur_td->first_trb,
23e3be11 517 (unsigned long long)xhci_trb_virt_to_dma(cur_td->start_seg, cur_td->first_trb));
ae636747
SS
518 /*
519 * If we stopped on the TD we need to cancel, then we have to
520 * move the xHC endpoint ring dequeue pointer past this TD.
521 */
522 if (cur_td == ep_ring->stopped_td)
c92bcfa7 523 xhci_find_new_dequeue_state(xhci, slot_id, ep_index, cur_td,
ae636747
SS
524 &deq_state);
525 else
526 td_to_noop(xhci, ep_ring, cur_td);
527 /*
528 * The event handler won't see a completion for this TD anymore,
529 * so remove it from the endpoint ring's TD list. Keep it in
530 * the cancelled TD list for URB completion later.
531 */
532 list_del(&cur_td->td_list);
533 ep_ring->cancels_pending--;
534 }
535 last_unlinked_td = cur_td;
536
537 /* If necessary, queue a Set Transfer Ring Dequeue Pointer command */
538 if (deq_state.new_deq_ptr && deq_state.new_deq_seg) {
c92bcfa7
SS
539 xhci_queue_new_dequeue_state(xhci, ep_ring,
540 slot_id, ep_index, &deq_state);
ae636747
SS
541 } else {
542 /* Otherwise just ring the doorbell to restart the ring */
543 ring_ep_doorbell(xhci, slot_id, ep_index);
544 }
545
546 /*
547 * Drop the lock and complete the URBs in the cancelled TD list.
548 * New TDs to be cancelled might be added to the end of the list before
549 * we can complete all the URBs for the TDs we already unlinked.
550 * So stop when we've completed the URB for the last TD we unlinked.
551 */
552 do {
553 cur_td = list_entry(ep_ring->cancelled_td_list.next,
554 struct xhci_td, cancelled_td_list);
555 list_del(&cur_td->cancelled_td_list);
556
557 /* Clean up the cancelled URB */
558#ifdef CONFIG_USB_HCD_STAT
559 hcd_stat_update(xhci->tp_stat, cur_td->urb->actual_length,
560 ktime_sub(stop_time, cur_td->start_time));
561#endif
562 cur_td->urb->hcpriv = NULL;
563 usb_hcd_unlink_urb_from_ep(xhci_to_hcd(xhci), cur_td->urb);
564
700e2052 565 xhci_dbg(xhci, "Giveback cancelled URB %p\n", cur_td->urb);
ae636747
SS
566 spin_unlock(&xhci->lock);
567 /* Doesn't matter what we pass for status, since the core will
568 * just overwrite it (because the URB has been unlinked).
569 */
570 usb_hcd_giveback_urb(xhci_to_hcd(xhci), cur_td->urb, 0);
571 kfree(cur_td);
572
573 spin_lock(&xhci->lock);
574 } while (cur_td != last_unlinked_td);
575
576 /* Return to the event handler with xhci->lock re-acquired */
577}
578
579/*
580 * When we get a completion for a Set Transfer Ring Dequeue Pointer command,
581 * we need to clear the set deq pending flag in the endpoint ring state, so that
582 * the TD queueing code can ring the doorbell again. We also need to ring the
583 * endpoint doorbell to restart the ring, but only if there aren't more
584 * cancellations pending.
585 */
586static void handle_set_deq_completion(struct xhci_hcd *xhci,
587 struct xhci_event_cmd *event,
588 union xhci_trb *trb)
589{
590 unsigned int slot_id;
591 unsigned int ep_index;
592 struct xhci_ring *ep_ring;
593 struct xhci_virt_device *dev;
d115b048
JY
594 struct xhci_ep_ctx *ep_ctx;
595 struct xhci_slot_ctx *slot_ctx;
ae636747
SS
596
597 slot_id = TRB_TO_SLOT_ID(trb->generic.field[3]);
598 ep_index = TRB_TO_EP_INDEX(trb->generic.field[3]);
599 dev = xhci->devs[slot_id];
600 ep_ring = dev->ep_rings[ep_index];
d115b048
JY
601 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
602 slot_ctx = xhci_get_slot_ctx(xhci, dev->out_ctx);
ae636747
SS
603
604 if (GET_COMP_CODE(event->status) != COMP_SUCCESS) {
605 unsigned int ep_state;
606 unsigned int slot_state;
607
608 switch (GET_COMP_CODE(event->status)) {
609 case COMP_TRB_ERR:
610 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd invalid because "
611 "of stream ID configuration\n");
612 break;
613 case COMP_CTX_STATE:
614 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed due "
615 "to incorrect slot or ep state.\n");
d115b048 616 ep_state = ep_ctx->ep_info;
ae636747 617 ep_state &= EP_STATE_MASK;
d115b048 618 slot_state = slot_ctx->dev_state;
ae636747
SS
619 slot_state = GET_SLOT_STATE(slot_state);
620 xhci_dbg(xhci, "Slot state = %u, EP state = %u\n",
621 slot_state, ep_state);
622 break;
623 case COMP_EBADSLT:
624 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed because "
625 "slot %u was not enabled.\n", slot_id);
626 break;
627 default:
628 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd with unknown "
629 "completion code of %u.\n",
630 GET_COMP_CODE(event->status));
631 break;
632 }
633 /* OK what do we do now? The endpoint state is hosed, and we
634 * should never get to this point if the synchronization between
635 * queueing, and endpoint state are correct. This might happen
636 * if the device gets disconnected after we've finished
637 * cancelling URBs, which might not be an error...
638 */
639 } else {
8e595a5d 640 xhci_dbg(xhci, "Successful Set TR Deq Ptr cmd, deq = @%08llx\n",
d115b048 641 ep_ctx->deq);
ae636747
SS
642 }
643
644 ep_ring->state &= ~SET_DEQ_PENDING;
645 ring_ep_doorbell(xhci, slot_id, ep_index);
646}
647
a1587d97
SS
648static void handle_reset_ep_completion(struct xhci_hcd *xhci,
649 struct xhci_event_cmd *event,
650 union xhci_trb *trb)
651{
652 int slot_id;
653 unsigned int ep_index;
654
655 slot_id = TRB_TO_SLOT_ID(trb->generic.field[3]);
656 ep_index = TRB_TO_EP_INDEX(trb->generic.field[3]);
657 /* This command will only fail if the endpoint wasn't halted,
658 * but we don't care.
659 */
660 xhci_dbg(xhci, "Ignoring reset ep completion code of %u\n",
661 (unsigned int) GET_COMP_CODE(event->status));
662
663 /* Clear our internal halted state and restart the ring */
664 xhci->devs[slot_id]->ep_rings[ep_index]->state &= ~EP_HALTED;
665 ring_ep_doorbell(xhci, slot_id, ep_index);
666}
ae636747 667
7f84eef0
SS
668static void handle_cmd_completion(struct xhci_hcd *xhci,
669 struct xhci_event_cmd *event)
670{
3ffbba95 671 int slot_id = TRB_TO_SLOT_ID(event->flags);
7f84eef0
SS
672 u64 cmd_dma;
673 dma_addr_t cmd_dequeue_dma;
674
8e595a5d 675 cmd_dma = event->cmd_trb;
23e3be11 676 cmd_dequeue_dma = xhci_trb_virt_to_dma(xhci->cmd_ring->deq_seg,
7f84eef0
SS
677 xhci->cmd_ring->dequeue);
678 /* Is the command ring deq ptr out of sync with the deq seg ptr? */
679 if (cmd_dequeue_dma == 0) {
680 xhci->error_bitmask |= 1 << 4;
681 return;
682 }
683 /* Does the DMA address match our internal dequeue pointer address? */
684 if (cmd_dma != (u64) cmd_dequeue_dma) {
685 xhci->error_bitmask |= 1 << 5;
686 return;
687 }
688 switch (xhci->cmd_ring->dequeue->generic.field[3] & TRB_TYPE_BITMASK) {
3ffbba95
SS
689 case TRB_TYPE(TRB_ENABLE_SLOT):
690 if (GET_COMP_CODE(event->status) == COMP_SUCCESS)
691 xhci->slot_id = slot_id;
692 else
693 xhci->slot_id = 0;
694 complete(&xhci->addr_dev);
695 break;
696 case TRB_TYPE(TRB_DISABLE_SLOT):
697 if (xhci->devs[slot_id])
698 xhci_free_virt_device(xhci, slot_id);
699 break;
f94e0186
SS
700 case TRB_TYPE(TRB_CONFIG_EP):
701 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(event->status);
702 complete(&xhci->devs[slot_id]->cmd_completion);
703 break;
2d3f1fac
SS
704 case TRB_TYPE(TRB_EVAL_CONTEXT):
705 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(event->status);
706 complete(&xhci->devs[slot_id]->cmd_completion);
707 break;
3ffbba95
SS
708 case TRB_TYPE(TRB_ADDR_DEV):
709 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(event->status);
710 complete(&xhci->addr_dev);
711 break;
ae636747
SS
712 case TRB_TYPE(TRB_STOP_RING):
713 handle_stopped_endpoint(xhci, xhci->cmd_ring->dequeue);
714 break;
715 case TRB_TYPE(TRB_SET_DEQ):
716 handle_set_deq_completion(xhci, event, xhci->cmd_ring->dequeue);
717 break;
7f84eef0
SS
718 case TRB_TYPE(TRB_CMD_NOOP):
719 ++xhci->noops_handled;
720 break;
a1587d97
SS
721 case TRB_TYPE(TRB_RESET_EP):
722 handle_reset_ep_completion(xhci, event, xhci->cmd_ring->dequeue);
723 break;
7f84eef0
SS
724 default:
725 /* Skip over unknown commands on the event ring */
726 xhci->error_bitmask |= 1 << 6;
727 break;
728 }
729 inc_deq(xhci, xhci->cmd_ring, false);
730}
731
0f2a7930
SS
732static void handle_port_status(struct xhci_hcd *xhci,
733 union xhci_trb *event)
734{
735 u32 port_id;
736
737 /* Port status change events always have a successful completion code */
738 if (GET_COMP_CODE(event->generic.field[2]) != COMP_SUCCESS) {
739 xhci_warn(xhci, "WARN: xHC returned failed port status event\n");
740 xhci->error_bitmask |= 1 << 8;
741 }
742 /* FIXME: core doesn't care about all port link state changes yet */
743 port_id = GET_PORT_ID(event->generic.field[0]);
744 xhci_dbg(xhci, "Port Status Change Event for port %d\n", port_id);
745
746 /* Update event ring dequeue pointer before dropping the lock */
747 inc_deq(xhci, xhci->event_ring, true);
23e3be11 748 xhci_set_hc_event_deq(xhci);
0f2a7930
SS
749
750 spin_unlock(&xhci->lock);
751 /* Pass this up to the core */
752 usb_hcd_poll_rh_status(xhci_to_hcd(xhci));
753 spin_lock(&xhci->lock);
754}
755
d0e96f5a
SS
756/*
757 * This TD is defined by the TRBs starting at start_trb in start_seg and ending
758 * at end_trb, which may be in another segment. If the suspect DMA address is a
759 * TRB in this TD, this function returns that TRB's segment. Otherwise it
760 * returns 0.
761 */
762static struct xhci_segment *trb_in_td(
763 struct xhci_segment *start_seg,
764 union xhci_trb *start_trb,
765 union xhci_trb *end_trb,
766 dma_addr_t suspect_dma)
767{
768 dma_addr_t start_dma;
769 dma_addr_t end_seg_dma;
770 dma_addr_t end_trb_dma;
771 struct xhci_segment *cur_seg;
772
23e3be11 773 start_dma = xhci_trb_virt_to_dma(start_seg, start_trb);
d0e96f5a
SS
774 cur_seg = start_seg;
775
776 do {
ae636747 777 /* We may get an event for a Link TRB in the middle of a TD */
23e3be11 778 end_seg_dma = xhci_trb_virt_to_dma(cur_seg,
ae636747 779 &start_seg->trbs[TRBS_PER_SEGMENT - 1]);
d0e96f5a 780 /* If the end TRB isn't in this segment, this is set to 0 */
23e3be11 781 end_trb_dma = xhci_trb_virt_to_dma(cur_seg, end_trb);
d0e96f5a
SS
782
783 if (end_trb_dma > 0) {
784 /* The end TRB is in this segment, so suspect should be here */
785 if (start_dma <= end_trb_dma) {
786 if (suspect_dma >= start_dma && suspect_dma <= end_trb_dma)
787 return cur_seg;
788 } else {
789 /* Case for one segment with
790 * a TD wrapped around to the top
791 */
792 if ((suspect_dma >= start_dma &&
793 suspect_dma <= end_seg_dma) ||
794 (suspect_dma >= cur_seg->dma &&
795 suspect_dma <= end_trb_dma))
796 return cur_seg;
797 }
798 return 0;
799 } else {
800 /* Might still be somewhere in this segment */
801 if (suspect_dma >= start_dma && suspect_dma <= end_seg_dma)
802 return cur_seg;
803 }
804 cur_seg = cur_seg->next;
23e3be11 805 start_dma = xhci_trb_virt_to_dma(cur_seg, &cur_seg->trbs[0]);
d0e96f5a
SS
806 } while (1);
807
808}
809
810/*
811 * If this function returns an error condition, it means it got a Transfer
812 * event with a corrupted Slot ID, Endpoint ID, or TRB DMA address.
813 * At this point, the host controller is probably hosed and should be reset.
814 */
815static int handle_tx_event(struct xhci_hcd *xhci,
816 struct xhci_transfer_event *event)
817{
818 struct xhci_virt_device *xdev;
819 struct xhci_ring *ep_ring;
82d1009f 820 unsigned int slot_id;
d0e96f5a
SS
821 int ep_index;
822 struct xhci_td *td = 0;
823 dma_addr_t event_dma;
824 struct xhci_segment *event_seg;
825 union xhci_trb *event_trb;
ae636747 826 struct urb *urb = 0;
d0e96f5a 827 int status = -EINPROGRESS;
d115b048 828 struct xhci_ep_ctx *ep_ctx;
d0e96f5a 829
66e49d87 830 xhci_dbg(xhci, "In %s\n", __func__);
82d1009f
SS
831 slot_id = TRB_TO_SLOT_ID(event->flags);
832 xdev = xhci->devs[slot_id];
d0e96f5a
SS
833 if (!xdev) {
834 xhci_err(xhci, "ERROR Transfer event pointed to bad slot\n");
835 return -ENODEV;
836 }
837
838 /* Endpoint ID is 1 based, our index is zero based */
839 ep_index = TRB_TO_EP_ID(event->flags) - 1;
66e49d87 840 xhci_dbg(xhci, "%s - ep index = %d\n", __func__, ep_index);
d0e96f5a 841 ep_ring = xdev->ep_rings[ep_index];
d115b048
JY
842 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
843 if (!ep_ring || (ep_ctx->ep_info & EP_STATE_MASK) == EP_STATE_DISABLED) {
d0e96f5a
SS
844 xhci_err(xhci, "ERROR Transfer event pointed to disabled endpoint\n");
845 return -ENODEV;
846 }
847
8e595a5d 848 event_dma = event->buffer;
d0e96f5a 849 /* This TRB should be in the TD at the head of this ring's TD list */
66e49d87 850 xhci_dbg(xhci, "%s - checking for list empty\n", __func__);
d0e96f5a
SS
851 if (list_empty(&ep_ring->td_list)) {
852 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d with no TDs queued?\n",
853 TRB_TO_SLOT_ID(event->flags), ep_index);
854 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n",
855 (unsigned int) (event->flags & TRB_TYPE_BITMASK)>>10);
856 xhci_print_trb_offsets(xhci, (union xhci_trb *) event);
857 urb = NULL;
858 goto cleanup;
859 }
66e49d87 860 xhci_dbg(xhci, "%s - getting list entry\n", __func__);
d0e96f5a
SS
861 td = list_entry(ep_ring->td_list.next, struct xhci_td, td_list);
862
863 /* Is this a TRB in the currently executing TD? */
66e49d87 864 xhci_dbg(xhci, "%s - looking for TD\n", __func__);
d0e96f5a
SS
865 event_seg = trb_in_td(ep_ring->deq_seg, ep_ring->dequeue,
866 td->last_trb, event_dma);
66e49d87 867 xhci_dbg(xhci, "%s - found event_seg = %p\n", __func__, event_seg);
d0e96f5a
SS
868 if (!event_seg) {
869 /* HC is busted, give up! */
870 xhci_err(xhci, "ERROR Transfer event TRB DMA ptr not part of current TD\n");
871 return -ESHUTDOWN;
872 }
873 event_trb = &event_seg->trbs[(event_dma - event_seg->dma) / sizeof(*event_trb)];
b10de142
SS
874 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n",
875 (unsigned int) (event->flags & TRB_TYPE_BITMASK)>>10);
8e595a5d
SS
876 xhci_dbg(xhci, "Offset 0x00 (buffer lo) = 0x%x\n",
877 lower_32_bits(event->buffer));
878 xhci_dbg(xhci, "Offset 0x04 (buffer hi) = 0x%x\n",
879 upper_32_bits(event->buffer));
b10de142
SS
880 xhci_dbg(xhci, "Offset 0x08 (transfer length) = 0x%x\n",
881 (unsigned int) event->transfer_len);
882 xhci_dbg(xhci, "Offset 0x0C (flags) = 0x%x\n",
883 (unsigned int) event->flags);
884
885 /* Look for common error cases */
886 switch (GET_COMP_CODE(event->transfer_len)) {
887 /* Skip codes that require special handling depending on
888 * transfer type
889 */
890 case COMP_SUCCESS:
891 case COMP_SHORT_TX:
892 break;
ae636747
SS
893 case COMP_STOP:
894 xhci_dbg(xhci, "Stopped on Transfer TRB\n");
895 break;
896 case COMP_STOP_INVAL:
897 xhci_dbg(xhci, "Stopped on No-op or Link TRB\n");
898 break;
b10de142
SS
899 case COMP_STALL:
900 xhci_warn(xhci, "WARN: Stalled endpoint\n");
a1587d97 901 ep_ring->state |= EP_HALTED;
b10de142
SS
902 status = -EPIPE;
903 break;
904 case COMP_TRB_ERR:
905 xhci_warn(xhci, "WARN: TRB error on endpoint\n");
906 status = -EILSEQ;
907 break;
908 case COMP_TX_ERR:
909 xhci_warn(xhci, "WARN: transfer error on endpoint\n");
910 status = -EPROTO;
911 break;
4a73143c
SS
912 case COMP_BABBLE:
913 xhci_warn(xhci, "WARN: babble error on endpoint\n");
914 status = -EOVERFLOW;
915 break;
b10de142
SS
916 case COMP_DB_ERR:
917 xhci_warn(xhci, "WARN: HC couldn't access mem fast enough\n");
918 status = -ENOSR;
919 break;
920 default:
921 xhci_warn(xhci, "ERROR Unknown event condition, HC probably busted\n");
922 urb = NULL;
923 goto cleanup;
924 }
d0e96f5a
SS
925 /* Now update the urb's actual_length and give back to the core */
926 /* Was this a control transfer? */
927 if (usb_endpoint_xfer_control(&td->urb->ep->desc)) {
928 xhci_debug_trb(xhci, xhci->event_ring->dequeue);
929 switch (GET_COMP_CODE(event->transfer_len)) {
930 case COMP_SUCCESS:
931 if (event_trb == ep_ring->dequeue) {
932 xhci_warn(xhci, "WARN: Success on ctrl setup TRB without IOC set??\n");
933 status = -ESHUTDOWN;
934 } else if (event_trb != td->last_trb) {
935 xhci_warn(xhci, "WARN: Success on ctrl data TRB without IOC set??\n");
936 status = -ESHUTDOWN;
937 } else {
938 xhci_dbg(xhci, "Successful control transfer!\n");
939 status = 0;
940 }
941 break;
942 case COMP_SHORT_TX:
943 xhci_warn(xhci, "WARN: short transfer on control ep\n");
944 status = -EREMOTEIO;
945 break;
82d1009f
SS
946 case COMP_STALL:
947 /* Did we transfer part of the data (middle) phase? */
948 if (event_trb != ep_ring->dequeue &&
949 event_trb != td->last_trb)
950 td->urb->actual_length =
951 td->urb->transfer_buffer_length
952 - TRB_LEN(event->transfer_len);
953 else
954 td->urb->actual_length = 0;
955
956 ep_ring->stopped_td = td;
957 ep_ring->stopped_trb = event_trb;
958 xhci_queue_reset_ep(xhci, slot_id, ep_index);
959 xhci_cleanup_stalled_ring(xhci,
960 td->urb->dev,
961 td->urb->ep,
962 ep_index, ep_ring);
963 xhci_ring_cmd_db(xhci);
964 goto td_cleanup;
d0e96f5a 965 default:
b10de142
SS
966 /* Others already handled above */
967 break;
d0e96f5a
SS
968 }
969 /*
970 * Did we transfer any data, despite the errors that might have
971 * happened? I.e. did we get past the setup stage?
972 */
973 if (event_trb != ep_ring->dequeue) {
974 /* The event was for the status stage */
975 if (event_trb == td->last_trb) {
c92bcfa7
SS
976 if (td->urb->actual_length != 0) {
977 /* Don't overwrite a previously set error code */
978 if (status == -EINPROGRESS || status == 0)
979 /* Did we already see a short data stage? */
980 status = -EREMOTEIO;
981 } else {
62889610
SS
982 td->urb->actual_length =
983 td->urb->transfer_buffer_length;
c92bcfa7 984 }
d0e96f5a 985 } else {
ae636747 986 /* Maybe the event was for the data stage? */
62889610 987 if (GET_COMP_CODE(event->transfer_len) != COMP_STOP_INVAL) {
ae636747
SS
988 /* We didn't stop on a link TRB in the middle */
989 td->urb->actual_length =
990 td->urb->transfer_buffer_length -
991 TRB_LEN(event->transfer_len);
62889610
SS
992 xhci_dbg(xhci, "Waiting for status stage event\n");
993 urb = NULL;
994 goto cleanup;
995 }
d0e96f5a
SS
996 }
997 }
d0e96f5a 998 } else {
b10de142
SS
999 switch (GET_COMP_CODE(event->transfer_len)) {
1000 case COMP_SUCCESS:
1001 /* Double check that the HW transferred everything. */
1002 if (event_trb != td->last_trb) {
1003 xhci_warn(xhci, "WARN Successful completion "
1004 "on short TX\n");
1005 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1006 status = -EREMOTEIO;
1007 else
1008 status = 0;
1009 } else {
1010 xhci_dbg(xhci, "Successful bulk transfer!\n");
1011 status = 0;
1012 }
1013 break;
1014 case COMP_SHORT_TX:
1015 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1016 status = -EREMOTEIO;
1017 else
1018 status = 0;
1019 break;
1020 default:
1021 /* Others already handled above */
1022 break;
1023 }
1024 dev_dbg(&td->urb->dev->dev,
1025 "ep %#x - asked for %d bytes, "
1026 "%d bytes untransferred\n",
1027 td->urb->ep->desc.bEndpointAddress,
1028 td->urb->transfer_buffer_length,
1029 TRB_LEN(event->transfer_len));
1030 /* Fast path - was this the last TRB in the TD for this URB? */
1031 if (event_trb == td->last_trb) {
1032 if (TRB_LEN(event->transfer_len) != 0) {
1033 td->urb->actual_length =
1034 td->urb->transfer_buffer_length -
1035 TRB_LEN(event->transfer_len);
1036 if (td->urb->actual_length < 0) {
1037 xhci_warn(xhci, "HC gave bad length "
1038 "of %d bytes left\n",
1039 TRB_LEN(event->transfer_len));
1040 td->urb->actual_length = 0;
1041 }
c92bcfa7
SS
1042 /* Don't overwrite a previously set error code */
1043 if (status == -EINPROGRESS) {
1044 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1045 status = -EREMOTEIO;
1046 else
1047 status = 0;
1048 }
b10de142
SS
1049 } else {
1050 td->urb->actual_length = td->urb->transfer_buffer_length;
1051 /* Ignore a short packet completion if the
1052 * untransferred length was zero.
1053 */
c92bcfa7
SS
1054 if (status == -EREMOTEIO)
1055 status = 0;
b10de142
SS
1056 }
1057 } else {
ae636747
SS
1058 /* Slow path - walk the list, starting from the dequeue
1059 * pointer, to get the actual length transferred.
b10de142 1060 */
ae636747
SS
1061 union xhci_trb *cur_trb;
1062 struct xhci_segment *cur_seg;
1063
b10de142 1064 td->urb->actual_length = 0;
ae636747
SS
1065 for (cur_trb = ep_ring->dequeue, cur_seg = ep_ring->deq_seg;
1066 cur_trb != event_trb;
1067 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
1068 if (TRB_TYPE(cur_trb->generic.field[3]) != TRB_TR_NOOP &&
1069 TRB_TYPE(cur_trb->generic.field[3]) != TRB_LINK)
1070 td->urb->actual_length +=
1071 TRB_LEN(cur_trb->generic.field[2]);
b10de142 1072 }
ae636747
SS
1073 /* If the ring didn't stop on a Link or No-op TRB, add
1074 * in the actual bytes transferred from the Normal TRB
1075 */
1076 if (GET_COMP_CODE(event->transfer_len) != COMP_STOP_INVAL)
1077 td->urb->actual_length +=
1078 TRB_LEN(cur_trb->generic.field[2]) -
1079 TRB_LEN(event->transfer_len);
b10de142 1080 }
d0e96f5a 1081 }
ae636747
SS
1082 if (GET_COMP_CODE(event->transfer_len) == COMP_STOP_INVAL ||
1083 GET_COMP_CODE(event->transfer_len) == COMP_STOP) {
c92bcfa7
SS
1084 /* The Endpoint Stop Command completion will take care of any
1085 * stopped TDs. A stopped TD may be restarted, so don't update
1086 * the ring dequeue pointer or take this TD off any lists yet.
1087 */
ae636747
SS
1088 ep_ring->stopped_td = td;
1089 ep_ring->stopped_trb = event_trb;
1090 } else {
c92bcfa7
SS
1091 if (GET_COMP_CODE(event->transfer_len) == COMP_STALL) {
1092 /* The transfer is completed from the driver's
1093 * perspective, but we need to issue a set dequeue
1094 * command for this stalled endpoint to move the dequeue
1095 * pointer past the TD. We can't do that here because
1096 * the halt condition must be cleared first.
1097 */
1098 ep_ring->stopped_td = td;
1099 ep_ring->stopped_trb = event_trb;
1100 } else {
1101 /* Update ring dequeue pointer */
1102 while (ep_ring->dequeue != td->last_trb)
1103 inc_deq(xhci, ep_ring, false);
ae636747 1104 inc_deq(xhci, ep_ring, false);
c92bcfa7 1105 }
b10de142 1106
82d1009f 1107td_cleanup:
ae636747
SS
1108 /* Clean up the endpoint's TD list */
1109 urb = td->urb;
1110 list_del(&td->td_list);
1111 /* Was this TD slated to be cancelled but completed anyway? */
1112 if (!list_empty(&td->cancelled_td_list)) {
1113 list_del(&td->cancelled_td_list);
1114 ep_ring->cancels_pending--;
1115 }
82d1009f
SS
1116 /* Leave the TD around for the reset endpoint function to use
1117 * (but only if it's not a control endpoint, since we already
1118 * queued the Set TR dequeue pointer command for stalled
1119 * control endpoints).
1120 */
1121 if (usb_endpoint_xfer_control(&urb->ep->desc) ||
1122 GET_COMP_CODE(event->transfer_len) != COMP_STALL) {
c92bcfa7
SS
1123 kfree(td);
1124 }
ae636747
SS
1125 urb->hcpriv = NULL;
1126 }
d0e96f5a
SS
1127cleanup:
1128 inc_deq(xhci, xhci->event_ring, true);
23e3be11 1129 xhci_set_hc_event_deq(xhci);
d0e96f5a 1130
b10de142 1131 /* FIXME for multi-TD URBs (who have buffers bigger than 64MB) */
d0e96f5a
SS
1132 if (urb) {
1133 usb_hcd_unlink_urb_from_ep(xhci_to_hcd(xhci), urb);
66e49d87
SS
1134 xhci_dbg(xhci, "Giveback URB %p, len = %d, status = %d\n",
1135 urb, td->urb->actual_length, status);
d0e96f5a
SS
1136 spin_unlock(&xhci->lock);
1137 usb_hcd_giveback_urb(xhci_to_hcd(xhci), urb, status);
1138 spin_lock(&xhci->lock);
1139 }
1140 return 0;
1141}
1142
0f2a7930
SS
1143/*
1144 * This function handles all OS-owned events on the event ring. It may drop
1145 * xhci->lock between event processing (e.g. to pass up port status changes).
1146 */
b7258a4a 1147void xhci_handle_event(struct xhci_hcd *xhci)
7f84eef0
SS
1148{
1149 union xhci_trb *event;
0f2a7930 1150 int update_ptrs = 1;
d0e96f5a 1151 int ret;
7f84eef0 1152
66e49d87 1153 xhci_dbg(xhci, "In %s\n", __func__);
7f84eef0
SS
1154 if (!xhci->event_ring || !xhci->event_ring->dequeue) {
1155 xhci->error_bitmask |= 1 << 1;
1156 return;
1157 }
1158
1159 event = xhci->event_ring->dequeue;
1160 /* Does the HC or OS own the TRB? */
1161 if ((event->event_cmd.flags & TRB_CYCLE) !=
1162 xhci->event_ring->cycle_state) {
1163 xhci->error_bitmask |= 1 << 2;
1164 return;
1165 }
66e49d87 1166 xhci_dbg(xhci, "%s - OS owns TRB\n", __func__);
7f84eef0 1167
0f2a7930 1168 /* FIXME: Handle more event types. */
7f84eef0
SS
1169 switch ((event->event_cmd.flags & TRB_TYPE_BITMASK)) {
1170 case TRB_TYPE(TRB_COMPLETION):
66e49d87 1171 xhci_dbg(xhci, "%s - calling handle_cmd_completion\n", __func__);
7f84eef0 1172 handle_cmd_completion(xhci, &event->event_cmd);
66e49d87 1173 xhci_dbg(xhci, "%s - returned from handle_cmd_completion\n", __func__);
7f84eef0 1174 break;
0f2a7930 1175 case TRB_TYPE(TRB_PORT_STATUS):
66e49d87 1176 xhci_dbg(xhci, "%s - calling handle_port_status\n", __func__);
0f2a7930 1177 handle_port_status(xhci, event);
66e49d87 1178 xhci_dbg(xhci, "%s - returned from handle_port_status\n", __func__);
0f2a7930
SS
1179 update_ptrs = 0;
1180 break;
d0e96f5a 1181 case TRB_TYPE(TRB_TRANSFER):
66e49d87 1182 xhci_dbg(xhci, "%s - calling handle_tx_event\n", __func__);
d0e96f5a 1183 ret = handle_tx_event(xhci, &event->trans_event);
66e49d87 1184 xhci_dbg(xhci, "%s - returned from handle_tx_event\n", __func__);
d0e96f5a
SS
1185 if (ret < 0)
1186 xhci->error_bitmask |= 1 << 9;
1187 else
1188 update_ptrs = 0;
1189 break;
7f84eef0
SS
1190 default:
1191 xhci->error_bitmask |= 1 << 3;
1192 }
1193
0f2a7930
SS
1194 if (update_ptrs) {
1195 /* Update SW and HC event ring dequeue pointer */
1196 inc_deq(xhci, xhci->event_ring, true);
23e3be11 1197 xhci_set_hc_event_deq(xhci);
0f2a7930 1198 }
7f84eef0 1199 /* Are there more items on the event ring? */
b7258a4a 1200 xhci_handle_event(xhci);
7f84eef0
SS
1201}
1202
d0e96f5a
SS
1203/**** Endpoint Ring Operations ****/
1204
7f84eef0
SS
1205/*
1206 * Generic function for queueing a TRB on a ring.
1207 * The caller must have checked to make sure there's room on the ring.
1208 */
1209static void queue_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
1210 bool consumer,
1211 u32 field1, u32 field2, u32 field3, u32 field4)
1212{
1213 struct xhci_generic_trb *trb;
1214
1215 trb = &ring->enqueue->generic;
1216 trb->field[0] = field1;
1217 trb->field[1] = field2;
1218 trb->field[2] = field3;
1219 trb->field[3] = field4;
1220 inc_enq(xhci, ring, consumer);
1221}
1222
d0e96f5a
SS
1223/*
1224 * Does various checks on the endpoint ring, and makes it ready to queue num_trbs.
1225 * FIXME allocate segments if the ring is full.
1226 */
1227static int prepare_ring(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
1228 u32 ep_state, unsigned int num_trbs, gfp_t mem_flags)
1229{
1230 /* Make sure the endpoint has been added to xHC schedule */
1231 xhci_dbg(xhci, "Endpoint state = 0x%x\n", ep_state);
1232 switch (ep_state) {
1233 case EP_STATE_DISABLED:
1234 /*
1235 * USB core changed config/interfaces without notifying us,
1236 * or hardware is reporting the wrong state.
1237 */
1238 xhci_warn(xhci, "WARN urb submitted to disabled ep\n");
1239 return -ENOENT;
d0e96f5a 1240 case EP_STATE_ERROR:
c92bcfa7 1241 xhci_warn(xhci, "WARN waiting for error on ep to be cleared\n");
d0e96f5a
SS
1242 /* FIXME event handling code for error needs to clear it */
1243 /* XXX not sure if this should be -ENOENT or not */
1244 return -EINVAL;
c92bcfa7
SS
1245 case EP_STATE_HALTED:
1246 xhci_dbg(xhci, "WARN halted endpoint, queueing URB anyway.\n");
d0e96f5a
SS
1247 case EP_STATE_STOPPED:
1248 case EP_STATE_RUNNING:
1249 break;
1250 default:
1251 xhci_err(xhci, "ERROR unknown endpoint state for ep\n");
1252 /*
1253 * FIXME issue Configure Endpoint command to try to get the HC
1254 * back into a known state.
1255 */
1256 return -EINVAL;
1257 }
1258 if (!room_on_ring(xhci, ep_ring, num_trbs)) {
1259 /* FIXME allocate more room */
1260 xhci_err(xhci, "ERROR no room on ep ring\n");
1261 return -ENOMEM;
1262 }
1263 return 0;
1264}
1265
23e3be11 1266static int prepare_transfer(struct xhci_hcd *xhci,
d0e96f5a
SS
1267 struct xhci_virt_device *xdev,
1268 unsigned int ep_index,
1269 unsigned int num_trbs,
1270 struct urb *urb,
1271 struct xhci_td **td,
1272 gfp_t mem_flags)
1273{
1274 int ret;
d115b048 1275 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
d0e96f5a 1276 ret = prepare_ring(xhci, xdev->ep_rings[ep_index],
d115b048 1277 ep_ctx->ep_info & EP_STATE_MASK,
d0e96f5a
SS
1278 num_trbs, mem_flags);
1279 if (ret)
1280 return ret;
1281 *td = kzalloc(sizeof(struct xhci_td), mem_flags);
1282 if (!*td)
1283 return -ENOMEM;
1284 INIT_LIST_HEAD(&(*td)->td_list);
ae636747 1285 INIT_LIST_HEAD(&(*td)->cancelled_td_list);
d0e96f5a
SS
1286
1287 ret = usb_hcd_link_urb_to_ep(xhci_to_hcd(xhci), urb);
1288 if (unlikely(ret)) {
1289 kfree(*td);
1290 return ret;
1291 }
1292
1293 (*td)->urb = urb;
1294 urb->hcpriv = (void *) (*td);
1295 /* Add this TD to the tail of the endpoint ring's TD list */
1296 list_add_tail(&(*td)->td_list, &xdev->ep_rings[ep_index]->td_list);
ae636747
SS
1297 (*td)->start_seg = xdev->ep_rings[ep_index]->enq_seg;
1298 (*td)->first_trb = xdev->ep_rings[ep_index]->enqueue;
d0e96f5a
SS
1299
1300 return 0;
1301}
1302
23e3be11 1303static unsigned int count_sg_trbs_needed(struct xhci_hcd *xhci, struct urb *urb)
8a96c052
SS
1304{
1305 int num_sgs, num_trbs, running_total, temp, i;
1306 struct scatterlist *sg;
1307
1308 sg = NULL;
1309 num_sgs = urb->num_sgs;
1310 temp = urb->transfer_buffer_length;
1311
1312 xhci_dbg(xhci, "count sg list trbs: \n");
1313 num_trbs = 0;
1314 for_each_sg(urb->sg->sg, sg, num_sgs, i) {
1315 unsigned int previous_total_trbs = num_trbs;
1316 unsigned int len = sg_dma_len(sg);
1317
1318 /* Scatter gather list entries may cross 64KB boundaries */
1319 running_total = TRB_MAX_BUFF_SIZE -
1320 (sg_dma_address(sg) & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
1321 if (running_total != 0)
1322 num_trbs++;
1323
1324 /* How many more 64KB chunks to transfer, how many more TRBs? */
1325 while (running_total < sg_dma_len(sg)) {
1326 num_trbs++;
1327 running_total += TRB_MAX_BUFF_SIZE;
1328 }
700e2052
GKH
1329 xhci_dbg(xhci, " sg #%d: dma = %#llx, len = %#x (%d), num_trbs = %d\n",
1330 i, (unsigned long long)sg_dma_address(sg),
1331 len, len, num_trbs - previous_total_trbs);
8a96c052
SS
1332
1333 len = min_t(int, len, temp);
1334 temp -= len;
1335 if (temp == 0)
1336 break;
1337 }
1338 xhci_dbg(xhci, "\n");
1339 if (!in_interrupt())
1340 dev_dbg(&urb->dev->dev, "ep %#x - urb len = %d, sglist used, num_trbs = %d\n",
1341 urb->ep->desc.bEndpointAddress,
1342 urb->transfer_buffer_length,
1343 num_trbs);
1344 return num_trbs;
1345}
1346
23e3be11 1347static void check_trb_math(struct urb *urb, int num_trbs, int running_total)
8a96c052
SS
1348{
1349 if (num_trbs != 0)
1350 dev_dbg(&urb->dev->dev, "%s - ep %#x - Miscalculated number of "
1351 "TRBs, %d left\n", __func__,
1352 urb->ep->desc.bEndpointAddress, num_trbs);
1353 if (running_total != urb->transfer_buffer_length)
1354 dev_dbg(&urb->dev->dev, "%s - ep %#x - Miscalculated tx length, "
1355 "queued %#x (%d), asked for %#x (%d)\n",
1356 __func__,
1357 urb->ep->desc.bEndpointAddress,
1358 running_total, running_total,
1359 urb->transfer_buffer_length,
1360 urb->transfer_buffer_length);
1361}
1362
23e3be11 1363static void giveback_first_trb(struct xhci_hcd *xhci, int slot_id,
8a96c052
SS
1364 unsigned int ep_index, int start_cycle,
1365 struct xhci_generic_trb *start_trb, struct xhci_td *td)
1366{
8a96c052
SS
1367 /*
1368 * Pass all the TRBs to the hardware at once and make sure this write
1369 * isn't reordered.
1370 */
1371 wmb();
1372 start_trb->field[3] |= start_cycle;
ae636747 1373 ring_ep_doorbell(xhci, slot_id, ep_index);
8a96c052
SS
1374}
1375
23e3be11 1376static int queue_bulk_sg_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
8a96c052
SS
1377 struct urb *urb, int slot_id, unsigned int ep_index)
1378{
1379 struct xhci_ring *ep_ring;
1380 unsigned int num_trbs;
1381 struct xhci_td *td;
1382 struct scatterlist *sg;
1383 int num_sgs;
1384 int trb_buff_len, this_sg_len, running_total;
1385 bool first_trb;
1386 u64 addr;
1387
1388 struct xhci_generic_trb *start_trb;
1389 int start_cycle;
1390
1391 ep_ring = xhci->devs[slot_id]->ep_rings[ep_index];
1392 num_trbs = count_sg_trbs_needed(xhci, urb);
1393 num_sgs = urb->num_sgs;
1394
23e3be11 1395 trb_buff_len = prepare_transfer(xhci, xhci->devs[slot_id],
8a96c052
SS
1396 ep_index, num_trbs, urb, &td, mem_flags);
1397 if (trb_buff_len < 0)
1398 return trb_buff_len;
1399 /*
1400 * Don't give the first TRB to the hardware (by toggling the cycle bit)
1401 * until we've finished creating all the other TRBs. The ring's cycle
1402 * state may change as we enqueue the other TRBs, so save it too.
1403 */
1404 start_trb = &ep_ring->enqueue->generic;
1405 start_cycle = ep_ring->cycle_state;
1406
1407 running_total = 0;
1408 /*
1409 * How much data is in the first TRB?
1410 *
1411 * There are three forces at work for TRB buffer pointers and lengths:
1412 * 1. We don't want to walk off the end of this sg-list entry buffer.
1413 * 2. The transfer length that the driver requested may be smaller than
1414 * the amount of memory allocated for this scatter-gather list.
1415 * 3. TRBs buffers can't cross 64KB boundaries.
1416 */
1417 sg = urb->sg->sg;
1418 addr = (u64) sg_dma_address(sg);
1419 this_sg_len = sg_dma_len(sg);
1420 trb_buff_len = TRB_MAX_BUFF_SIZE -
1421 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
1422 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
1423 if (trb_buff_len > urb->transfer_buffer_length)
1424 trb_buff_len = urb->transfer_buffer_length;
1425 xhci_dbg(xhci, "First length to xfer from 1st sglist entry = %u\n",
1426 trb_buff_len);
1427
1428 first_trb = true;
1429 /* Queue the first TRB, even if it's zero-length */
1430 do {
1431 u32 field = 0;
f9dc68fe 1432 u32 length_field = 0;
8a96c052
SS
1433
1434 /* Don't change the cycle bit of the first TRB until later */
1435 if (first_trb)
1436 first_trb = false;
1437 else
1438 field |= ep_ring->cycle_state;
1439
1440 /* Chain all the TRBs together; clear the chain bit in the last
1441 * TRB to indicate it's the last TRB in the chain.
1442 */
1443 if (num_trbs > 1) {
1444 field |= TRB_CHAIN;
1445 } else {
1446 /* FIXME - add check for ZERO_PACKET flag before this */
1447 td->last_trb = ep_ring->enqueue;
1448 field |= TRB_IOC;
1449 }
1450 xhci_dbg(xhci, " sg entry: dma = %#x, len = %#x (%d), "
1451 "64KB boundary at %#x, end dma = %#x\n",
1452 (unsigned int) addr, trb_buff_len, trb_buff_len,
1453 (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
1454 (unsigned int) addr + trb_buff_len);
1455 if (TRB_MAX_BUFF_SIZE -
1456 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1)) < trb_buff_len) {
1457 xhci_warn(xhci, "WARN: sg dma xfer crosses 64KB boundaries!\n");
1458 xhci_dbg(xhci, "Next boundary at %#x, end dma = %#x\n",
1459 (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
1460 (unsigned int) addr + trb_buff_len);
1461 }
f9dc68fe
SS
1462 length_field = TRB_LEN(trb_buff_len) |
1463 TD_REMAINDER(urb->transfer_buffer_length - running_total) |
1464 TRB_INTR_TARGET(0);
8a96c052 1465 queue_trb(xhci, ep_ring, false,
8e595a5d
SS
1466 lower_32_bits(addr),
1467 upper_32_bits(addr),
f9dc68fe 1468 length_field,
8a96c052
SS
1469 /* We always want to know if the TRB was short,
1470 * or we won't get an event when it completes.
1471 * (Unless we use event data TRBs, which are a
1472 * waste of space and HC resources.)
1473 */
1474 field | TRB_ISP | TRB_TYPE(TRB_NORMAL));
1475 --num_trbs;
1476 running_total += trb_buff_len;
1477
1478 /* Calculate length for next transfer --
1479 * Are we done queueing all the TRBs for this sg entry?
1480 */
1481 this_sg_len -= trb_buff_len;
1482 if (this_sg_len == 0) {
1483 --num_sgs;
1484 if (num_sgs == 0)
1485 break;
1486 sg = sg_next(sg);
1487 addr = (u64) sg_dma_address(sg);
1488 this_sg_len = sg_dma_len(sg);
1489 } else {
1490 addr += trb_buff_len;
1491 }
1492
1493 trb_buff_len = TRB_MAX_BUFF_SIZE -
1494 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
1495 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
1496 if (running_total + trb_buff_len > urb->transfer_buffer_length)
1497 trb_buff_len =
1498 urb->transfer_buffer_length - running_total;
1499 } while (running_total < urb->transfer_buffer_length);
1500
1501 check_trb_math(urb, num_trbs, running_total);
1502 giveback_first_trb(xhci, slot_id, ep_index, start_cycle, start_trb, td);
1503 return 0;
1504}
1505
b10de142 1506/* This is very similar to what ehci-q.c qtd_fill() does */
23e3be11 1507int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
b10de142
SS
1508 struct urb *urb, int slot_id, unsigned int ep_index)
1509{
1510 struct xhci_ring *ep_ring;
1511 struct xhci_td *td;
1512 int num_trbs;
1513 struct xhci_generic_trb *start_trb;
1514 bool first_trb;
1515 int start_cycle;
f9dc68fe 1516 u32 field, length_field;
b10de142
SS
1517
1518 int running_total, trb_buff_len, ret;
1519 u64 addr;
1520
8a96c052
SS
1521 if (urb->sg)
1522 return queue_bulk_sg_tx(xhci, mem_flags, urb, slot_id, ep_index);
1523
b10de142
SS
1524 ep_ring = xhci->devs[slot_id]->ep_rings[ep_index];
1525
1526 num_trbs = 0;
1527 /* How much data is (potentially) left before the 64KB boundary? */
1528 running_total = TRB_MAX_BUFF_SIZE -
1529 (urb->transfer_dma & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
1530
1531 /* If there's some data on this 64KB chunk, or we have to send a
1532 * zero-length transfer, we need at least one TRB
1533 */
1534 if (running_total != 0 || urb->transfer_buffer_length == 0)
1535 num_trbs++;
1536 /* How many more 64KB chunks to transfer, how many more TRBs? */
1537 while (running_total < urb->transfer_buffer_length) {
1538 num_trbs++;
1539 running_total += TRB_MAX_BUFF_SIZE;
1540 }
1541 /* FIXME: this doesn't deal with URB_ZERO_PACKET - need one more */
1542
1543 if (!in_interrupt())
700e2052 1544 dev_dbg(&urb->dev->dev, "ep %#x - urb len = %#x (%d), addr = %#llx, num_trbs = %d\n",
b10de142 1545 urb->ep->desc.bEndpointAddress,
8a96c052
SS
1546 urb->transfer_buffer_length,
1547 urb->transfer_buffer_length,
700e2052 1548 (unsigned long long)urb->transfer_dma,
b10de142 1549 num_trbs);
8a96c052 1550
23e3be11 1551 ret = prepare_transfer(xhci, xhci->devs[slot_id], ep_index,
b10de142
SS
1552 num_trbs, urb, &td, mem_flags);
1553 if (ret < 0)
1554 return ret;
1555
1556 /*
1557 * Don't give the first TRB to the hardware (by toggling the cycle bit)
1558 * until we've finished creating all the other TRBs. The ring's cycle
1559 * state may change as we enqueue the other TRBs, so save it too.
1560 */
1561 start_trb = &ep_ring->enqueue->generic;
1562 start_cycle = ep_ring->cycle_state;
1563
1564 running_total = 0;
1565 /* How much data is in the first TRB? */
1566 addr = (u64) urb->transfer_dma;
1567 trb_buff_len = TRB_MAX_BUFF_SIZE -
1568 (urb->transfer_dma & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
1569 if (urb->transfer_buffer_length < trb_buff_len)
1570 trb_buff_len = urb->transfer_buffer_length;
1571
1572 first_trb = true;
1573
1574 /* Queue the first TRB, even if it's zero-length */
1575 do {
1576 field = 0;
1577
1578 /* Don't change the cycle bit of the first TRB until later */
1579 if (first_trb)
1580 first_trb = false;
1581 else
1582 field |= ep_ring->cycle_state;
1583
1584 /* Chain all the TRBs together; clear the chain bit in the last
1585 * TRB to indicate it's the last TRB in the chain.
1586 */
1587 if (num_trbs > 1) {
1588 field |= TRB_CHAIN;
1589 } else {
1590 /* FIXME - add check for ZERO_PACKET flag before this */
1591 td->last_trb = ep_ring->enqueue;
1592 field |= TRB_IOC;
1593 }
f9dc68fe
SS
1594 length_field = TRB_LEN(trb_buff_len) |
1595 TD_REMAINDER(urb->transfer_buffer_length - running_total) |
1596 TRB_INTR_TARGET(0);
b10de142 1597 queue_trb(xhci, ep_ring, false,
8e595a5d
SS
1598 lower_32_bits(addr),
1599 upper_32_bits(addr),
f9dc68fe 1600 length_field,
b10de142
SS
1601 /* We always want to know if the TRB was short,
1602 * or we won't get an event when it completes.
1603 * (Unless we use event data TRBs, which are a
1604 * waste of space and HC resources.)
1605 */
1606 field | TRB_ISP | TRB_TYPE(TRB_NORMAL));
1607 --num_trbs;
1608 running_total += trb_buff_len;
1609
1610 /* Calculate length for next transfer */
1611 addr += trb_buff_len;
1612 trb_buff_len = urb->transfer_buffer_length - running_total;
1613 if (trb_buff_len > TRB_MAX_BUFF_SIZE)
1614 trb_buff_len = TRB_MAX_BUFF_SIZE;
1615 } while (running_total < urb->transfer_buffer_length);
1616
8a96c052
SS
1617 check_trb_math(urb, num_trbs, running_total);
1618 giveback_first_trb(xhci, slot_id, ep_index, start_cycle, start_trb, td);
b10de142
SS
1619 return 0;
1620}
1621
d0e96f5a 1622/* Caller must have locked xhci->lock */
23e3be11 1623int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
d0e96f5a
SS
1624 struct urb *urb, int slot_id, unsigned int ep_index)
1625{
1626 struct xhci_ring *ep_ring;
1627 int num_trbs;
1628 int ret;
1629 struct usb_ctrlrequest *setup;
1630 struct xhci_generic_trb *start_trb;
1631 int start_cycle;
f9dc68fe 1632 u32 field, length_field;
d0e96f5a
SS
1633 struct xhci_td *td;
1634
1635 ep_ring = xhci->devs[slot_id]->ep_rings[ep_index];
1636
1637 /*
1638 * Need to copy setup packet into setup TRB, so we can't use the setup
1639 * DMA address.
1640 */
1641 if (!urb->setup_packet)
1642 return -EINVAL;
1643
1644 if (!in_interrupt())
1645 xhci_dbg(xhci, "Queueing ctrl tx for slot id %d, ep %d\n",
1646 slot_id, ep_index);
1647 /* 1 TRB for setup, 1 for status */
1648 num_trbs = 2;
1649 /*
1650 * Don't need to check if we need additional event data and normal TRBs,
1651 * since data in control transfers will never get bigger than 16MB
1652 * XXX: can we get a buffer that crosses 64KB boundaries?
1653 */
1654 if (urb->transfer_buffer_length > 0)
1655 num_trbs++;
23e3be11 1656 ret = prepare_transfer(xhci, xhci->devs[slot_id], ep_index, num_trbs,
d0e96f5a
SS
1657 urb, &td, mem_flags);
1658 if (ret < 0)
1659 return ret;
1660
1661 /*
1662 * Don't give the first TRB to the hardware (by toggling the cycle bit)
1663 * until we've finished creating all the other TRBs. The ring's cycle
1664 * state may change as we enqueue the other TRBs, so save it too.
1665 */
1666 start_trb = &ep_ring->enqueue->generic;
1667 start_cycle = ep_ring->cycle_state;
1668
1669 /* Queue setup TRB - see section 6.4.1.2.1 */
1670 /* FIXME better way to translate setup_packet into two u32 fields? */
1671 setup = (struct usb_ctrlrequest *) urb->setup_packet;
1672 queue_trb(xhci, ep_ring, false,
1673 /* FIXME endianness is probably going to bite my ass here. */
1674 setup->bRequestType | setup->bRequest << 8 | setup->wValue << 16,
1675 setup->wIndex | setup->wLength << 16,
1676 TRB_LEN(8) | TRB_INTR_TARGET(0),
1677 /* Immediate data in pointer */
1678 TRB_IDT | TRB_TYPE(TRB_SETUP));
1679
1680 /* If there's data, queue data TRBs */
1681 field = 0;
f9dc68fe
SS
1682 length_field = TRB_LEN(urb->transfer_buffer_length) |
1683 TD_REMAINDER(urb->transfer_buffer_length) |
1684 TRB_INTR_TARGET(0);
d0e96f5a
SS
1685 if (urb->transfer_buffer_length > 0) {
1686 if (setup->bRequestType & USB_DIR_IN)
1687 field |= TRB_DIR_IN;
1688 queue_trb(xhci, ep_ring, false,
1689 lower_32_bits(urb->transfer_dma),
1690 upper_32_bits(urb->transfer_dma),
f9dc68fe 1691 length_field,
d0e96f5a
SS
1692 /* Event on short tx */
1693 field | TRB_ISP | TRB_TYPE(TRB_DATA) | ep_ring->cycle_state);
1694 }
1695
1696 /* Save the DMA address of the last TRB in the TD */
1697 td->last_trb = ep_ring->enqueue;
1698
1699 /* Queue status TRB - see Table 7 and sections 4.11.2.2 and 6.4.1.2.3 */
1700 /* If the device sent data, the status stage is an OUT transfer */
1701 if (urb->transfer_buffer_length > 0 && setup->bRequestType & USB_DIR_IN)
1702 field = 0;
1703 else
1704 field = TRB_DIR_IN;
1705 queue_trb(xhci, ep_ring, false,
1706 0,
1707 0,
1708 TRB_INTR_TARGET(0),
1709 /* Event on completion */
1710 field | TRB_IOC | TRB_TYPE(TRB_STATUS) | ep_ring->cycle_state);
1711
8a96c052 1712 giveback_first_trb(xhci, slot_id, ep_index, start_cycle, start_trb, td);
d0e96f5a
SS
1713 return 0;
1714}
1715
1716/**** Command Ring Operations ****/
1717
7f84eef0
SS
1718/* Generic function for queueing a command TRB on the command ring */
1719static int queue_command(struct xhci_hcd *xhci, u32 field1, u32 field2, u32 field3, u32 field4)
1720{
1721 if (!room_on_ring(xhci, xhci->cmd_ring, 1)) {
1722 if (!in_interrupt())
1723 xhci_err(xhci, "ERR: No room for command on command ring\n");
1724 return -ENOMEM;
1725 }
1726 queue_trb(xhci, xhci->cmd_ring, false, field1, field2, field3,
1727 field4 | xhci->cmd_ring->cycle_state);
1728 return 0;
1729}
1730
1731/* Queue a no-op command on the command ring */
1732static int queue_cmd_noop(struct xhci_hcd *xhci)
1733{
1734 return queue_command(xhci, 0, 0, 0, TRB_TYPE(TRB_CMD_NOOP));
1735}
1736
1737/*
1738 * Place a no-op command on the command ring to test the command and
1739 * event ring.
1740 */
23e3be11 1741void *xhci_setup_one_noop(struct xhci_hcd *xhci)
7f84eef0
SS
1742{
1743 if (queue_cmd_noop(xhci) < 0)
1744 return NULL;
1745 xhci->noops_submitted++;
23e3be11 1746 return xhci_ring_cmd_db;
7f84eef0 1747}
3ffbba95
SS
1748
1749/* Queue a slot enable or disable request on the command ring */
23e3be11 1750int xhci_queue_slot_control(struct xhci_hcd *xhci, u32 trb_type, u32 slot_id)
3ffbba95
SS
1751{
1752 return queue_command(xhci, 0, 0, 0,
1753 TRB_TYPE(trb_type) | SLOT_ID_FOR_TRB(slot_id));
1754}
1755
1756/* Queue an address device command TRB */
23e3be11
SS
1757int xhci_queue_address_device(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1758 u32 slot_id)
3ffbba95 1759{
8e595a5d
SS
1760 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
1761 upper_32_bits(in_ctx_ptr), 0,
3ffbba95
SS
1762 TRB_TYPE(TRB_ADDR_DEV) | SLOT_ID_FOR_TRB(slot_id));
1763}
f94e0186
SS
1764
1765/* Queue a configure endpoint command TRB */
23e3be11
SS
1766int xhci_queue_configure_endpoint(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1767 u32 slot_id)
f94e0186 1768{
8e595a5d
SS
1769 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
1770 upper_32_bits(in_ctx_ptr), 0,
f94e0186
SS
1771 TRB_TYPE(TRB_CONFIG_EP) | SLOT_ID_FOR_TRB(slot_id));
1772}
ae636747 1773
f2217e8e
SS
1774/* Queue an evaluate context command TRB */
1775int xhci_queue_evaluate_context(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1776 u32 slot_id)
1777{
1778 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
1779 upper_32_bits(in_ctx_ptr), 0,
1780 TRB_TYPE(TRB_EVAL_CONTEXT) | SLOT_ID_FOR_TRB(slot_id));
1781}
1782
23e3be11 1783int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, int slot_id,
ae636747
SS
1784 unsigned int ep_index)
1785{
1786 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
1787 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
1788 u32 type = TRB_TYPE(TRB_STOP_RING);
1789
1790 return queue_command(xhci, 0, 0, 0,
1791 trb_slot_id | trb_ep_index | type);
1792}
1793
1794/* Set Transfer Ring Dequeue Pointer command.
1795 * This should not be used for endpoints that have streams enabled.
1796 */
1797static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
1798 unsigned int ep_index, struct xhci_segment *deq_seg,
1799 union xhci_trb *deq_ptr, u32 cycle_state)
1800{
1801 dma_addr_t addr;
1802 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
1803 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
1804 u32 type = TRB_TYPE(TRB_SET_DEQ);
1805
23e3be11 1806 addr = xhci_trb_virt_to_dma(deq_seg, deq_ptr);
c92bcfa7 1807 if (addr == 0) {
ae636747 1808 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
700e2052
GKH
1809 xhci_warn(xhci, "WARN deq seg = %p, deq pt = %p\n",
1810 deq_seg, deq_ptr);
c92bcfa7
SS
1811 return 0;
1812 }
8e595a5d
SS
1813 return queue_command(xhci, lower_32_bits(addr) | cycle_state,
1814 upper_32_bits(addr), 0,
ae636747
SS
1815 trb_slot_id | trb_ep_index | type);
1816}
a1587d97
SS
1817
1818int xhci_queue_reset_ep(struct xhci_hcd *xhci, int slot_id,
1819 unsigned int ep_index)
1820{
1821 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
1822 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
1823 u32 type = TRB_TYPE(TRB_RESET_EP);
1824
1825 return queue_command(xhci, 0, 0, 0, trb_slot_id | trb_ep_index | type);
1826}