blob: bfc99a93945506bc745d830cf0bd4efbfcc4a92e [file] [log] [blame]
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001/*
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
Sarah Sharp8a96c052009-04-27 19:59:19 -070067#include <linux/scatterlist.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090068#include <linux/slab.h>
Sarah Sharp7f84eef2009-04-27 19:53:56 -070069#include "xhci.h"
70
71/*
72 * Returns zero if the TRB isn't in this segment, otherwise it returns the DMA
73 * address of the TRB.
74 */
Sarah Sharp23e3be12009-04-29 19:05:20 -070075dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg,
Sarah Sharp7f84eef2009-04-27 19:53:56 -070076 union xhci_trb *trb)
77{
Sarah Sharp6071d832009-05-14 11:44:14 -070078 unsigned long segment_offset;
Sarah Sharp7f84eef2009-04-27 19:53:56 -070079
Sarah Sharp6071d832009-05-14 11:44:14 -070080 if (!seg || !trb || trb < seg->trbs)
Sarah Sharp7f84eef2009-04-27 19:53:56 -070081 return 0;
Sarah Sharp6071d832009-05-14 11:44:14 -070082 /* offset in TRBs */
83 segment_offset = trb - seg->trbs;
84 if (segment_offset > TRBS_PER_SEGMENT)
Sarah Sharp7f84eef2009-04-27 19:53:56 -070085 return 0;
Sarah Sharp6071d832009-05-14 11:44:14 -070086 return seg->dma + (segment_offset * sizeof(*trb));
Sarah Sharp7f84eef2009-04-27 19:53:56 -070087}
88
89/* Does this link TRB point to the first segment in a ring,
90 * or was the previous TRB the last TRB on the last segment in the ERST?
91 */
92static inline bool last_trb_on_last_seg(struct xhci_hcd *xhci, struct xhci_ring *ring,
93 struct xhci_segment *seg, union xhci_trb *trb)
94{
95 if (ring == xhci->event_ring)
96 return (trb == &seg->trbs[TRBS_PER_SEGMENT]) &&
97 (seg->next == xhci->event_ring->first_seg);
98 else
99 return trb->link.control & LINK_TOGGLE;
100}
101
102/* Is this TRB a link TRB or was the last TRB the last TRB in this event ring
103 * segment? I.e. would the updated event TRB pointer step off the end of the
104 * event seg?
105 */
106static inline int last_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
107 struct xhci_segment *seg, union xhci_trb *trb)
108{
109 if (ring == xhci->event_ring)
110 return trb == &seg->trbs[TRBS_PER_SEGMENT];
111 else
112 return (trb->link.control & TRB_TYPE_BITMASK) == TRB_TYPE(TRB_LINK);
113}
114
John Youn6c12db92010-05-10 15:33:00 -0700115static inline int enqueue_is_link_trb(struct xhci_ring *ring)
116{
117 struct xhci_link_trb *link = &ring->enqueue->link;
118 return ((link->control & TRB_TYPE_BITMASK) == TRB_TYPE(TRB_LINK));
119}
120
Sarah Sharpae636742009-04-29 19:02:31 -0700121/* Updates trb to point to the next TRB in the ring, and updates seg if the next
122 * TRB is in a new segment. This does not skip over link TRBs, and it does not
123 * effect the ring dequeue or enqueue pointers.
124 */
125static void next_trb(struct xhci_hcd *xhci,
126 struct xhci_ring *ring,
127 struct xhci_segment **seg,
128 union xhci_trb **trb)
129{
130 if (last_trb(xhci, ring, *seg, *trb)) {
131 *seg = (*seg)->next;
132 *trb = ((*seg)->trbs);
133 } else {
134 *trb = (*trb)++;
135 }
136}
137
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700138/*
139 * See Cycle bit rules. SW is the consumer for the event ring only.
140 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
141 */
142static void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring, bool consumer)
143{
144 union xhci_trb *next = ++(ring->dequeue);
Sarah Sharp66e49d82009-07-27 12:03:46 -0700145 unsigned long long addr;
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700146
147 ring->deq_updates++;
148 /* Update the dequeue pointer further if that was a link TRB or we're at
149 * the end of an event ring segment (which doesn't have link TRBS)
150 */
151 while (last_trb(xhci, ring, ring->deq_seg, next)) {
152 if (consumer && last_trb_on_last_seg(xhci, ring, ring->deq_seg, next)) {
153 ring->cycle_state = (ring->cycle_state ? 0 : 1);
154 if (!in_interrupt())
Greg Kroah-Hartman700e2052009-04-29 19:14:08 -0700155 xhci_dbg(xhci, "Toggle cycle state for ring %p = %i\n",
156 ring,
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700157 (unsigned int) ring->cycle_state);
158 }
159 ring->deq_seg = ring->deq_seg->next;
160 ring->dequeue = ring->deq_seg->trbs;
161 next = ring->dequeue;
162 }
Sarah Sharp66e49d82009-07-27 12:03:46 -0700163 addr = (unsigned long long) xhci_trb_virt_to_dma(ring->deq_seg, ring->dequeue);
164 if (ring == xhci->event_ring)
165 xhci_dbg(xhci, "Event ring deq = 0x%llx (DMA)\n", addr);
166 else if (ring == xhci->cmd_ring)
167 xhci_dbg(xhci, "Command ring deq = 0x%llx (DMA)\n", addr);
168 else
169 xhci_dbg(xhci, "Ring deq = 0x%llx (DMA)\n", addr);
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700170}
171
172/*
173 * See Cycle bit rules. SW is the consumer for the event ring only.
174 * Don't make a ring full of link TRBs. That would be dumb and this would loop.
175 *
176 * If we've just enqueued a TRB that is in the middle of a TD (meaning the
177 * chain bit is set), then set the chain bit in all the following link TRBs.
178 * If we've enqueued the last TRB in a TD, make sure the following link TRBs
179 * have their chain bit cleared (so that each Link TRB is a separate TD).
180 *
181 * Section 6.4.4.1 of the 0.95 spec says link TRBs cannot have the chain bit
Sarah Sharpb0567b32009-08-07 14:04:36 -0700182 * set, but other sections talk about dealing with the chain bit set. This was
183 * fixed in the 0.96 specification errata, but we have to assume that all 0.95
184 * xHCI hardware can't handle the chain bit being cleared on a link TRB.
Sarah Sharp6cc30d82010-06-10 12:25:28 -0700185 *
186 * @more_trbs_coming: Will you enqueue more TRBs before calling
187 * prepare_transfer()?
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700188 */
Sarah Sharp6cc30d82010-06-10 12:25:28 -0700189static void inc_enq(struct xhci_hcd *xhci, struct xhci_ring *ring,
190 bool consumer, bool more_trbs_coming)
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700191{
192 u32 chain;
193 union xhci_trb *next;
Sarah Sharp66e49d82009-07-27 12:03:46 -0700194 unsigned long long addr;
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700195
196 chain = ring->enqueue->generic.field[3] & TRB_CHAIN;
197 next = ++(ring->enqueue);
198
199 ring->enq_updates++;
200 /* Update the dequeue pointer further if that was a link TRB or we're at
201 * the end of an event ring segment (which doesn't have link TRBS)
202 */
203 while (last_trb(xhci, ring, ring->enq_seg, next)) {
204 if (!consumer) {
205 if (ring != xhci->event_ring) {
Sarah Sharp6cc30d82010-06-10 12:25:28 -0700206 /*
207 * If the caller doesn't plan on enqueueing more
208 * TDs before ringing the doorbell, then we
209 * don't want to give the link TRB to the
210 * hardware just yet. We'll give the link TRB
211 * back in prepare_ring() just before we enqueue
212 * the TD at the top of the ring.
213 */
214 if (!chain && !more_trbs_coming)
John Youn6c12db92010-05-10 15:33:00 -0700215 break;
Sarah Sharp6cc30d82010-06-10 12:25:28 -0700216
217 /* If we're not dealing with 0.95 hardware,
218 * carry over the chain bit of the previous TRB
219 * (which may mean the chain bit is cleared).
220 */
221 if (!xhci_link_trb_quirk(xhci)) {
222 next->link.control &= ~TRB_CHAIN;
223 next->link.control |= chain;
Sarah Sharpb0567b32009-08-07 14:04:36 -0700224 }
Sarah Sharp6cc30d82010-06-10 12:25:28 -0700225 /* Give this link TRB to the hardware */
226 wmb();
227 next->link.control ^= TRB_CYCLE;
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700228 }
229 /* Toggle the cycle bit after the last ring segment. */
230 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
231 ring->cycle_state = (ring->cycle_state ? 0 : 1);
232 if (!in_interrupt())
Greg Kroah-Hartman700e2052009-04-29 19:14:08 -0700233 xhci_dbg(xhci, "Toggle cycle state for ring %p = %i\n",
234 ring,
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700235 (unsigned int) ring->cycle_state);
236 }
237 }
238 ring->enq_seg = ring->enq_seg->next;
239 ring->enqueue = ring->enq_seg->trbs;
240 next = ring->enqueue;
241 }
Sarah Sharp66e49d82009-07-27 12:03:46 -0700242 addr = (unsigned long long) xhci_trb_virt_to_dma(ring->enq_seg, ring->enqueue);
243 if (ring == xhci->event_ring)
244 xhci_dbg(xhci, "Event ring enq = 0x%llx (DMA)\n", addr);
245 else if (ring == xhci->cmd_ring)
246 xhci_dbg(xhci, "Command ring enq = 0x%llx (DMA)\n", addr);
247 else
248 xhci_dbg(xhci, "Ring enq = 0x%llx (DMA)\n", addr);
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700249}
250
251/*
252 * Check to see if there's room to enqueue num_trbs on the ring. See rules
253 * above.
254 * FIXME: this would be simpler and faster if we just kept track of the number
255 * of free TRBs in a ring.
256 */
257static int room_on_ring(struct xhci_hcd *xhci, struct xhci_ring *ring,
258 unsigned int num_trbs)
259{
260 int i;
261 union xhci_trb *enq = ring->enqueue;
262 struct xhci_segment *enq_seg = ring->enq_seg;
Sarah Sharp44ebd032010-05-18 16:05:26 -0700263 struct xhci_segment *cur_seg;
264 unsigned int left_on_ring;
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700265
John Youn6c12db92010-05-10 15:33:00 -0700266 /* If we are currently pointing to a link TRB, advance the
267 * enqueue pointer before checking for space */
268 while (last_trb(xhci, ring, enq_seg, enq)) {
269 enq_seg = enq_seg->next;
270 enq = enq_seg->trbs;
271 }
272
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700273 /* Check if ring is empty */
Sarah Sharp44ebd032010-05-18 16:05:26 -0700274 if (enq == ring->dequeue) {
275 /* Can't use link trbs */
276 left_on_ring = TRBS_PER_SEGMENT - 1;
277 for (cur_seg = enq_seg->next; cur_seg != enq_seg;
278 cur_seg = cur_seg->next)
279 left_on_ring += TRBS_PER_SEGMENT - 1;
280
281 /* Always need one TRB free in the ring. */
282 left_on_ring -= 1;
283 if (num_trbs > left_on_ring) {
284 xhci_warn(xhci, "Not enough room on ring; "
285 "need %u TRBs, %u TRBs left\n",
286 num_trbs, left_on_ring);
287 return 0;
288 }
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700289 return 1;
Sarah Sharp44ebd032010-05-18 16:05:26 -0700290 }
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700291 /* Make sure there's an extra empty TRB available */
292 for (i = 0; i <= num_trbs; ++i) {
293 if (enq == ring->dequeue)
294 return 0;
295 enq++;
296 while (last_trb(xhci, ring, enq_seg, enq)) {
297 enq_seg = enq_seg->next;
298 enq = enq_seg->trbs;
299 }
300 }
301 return 1;
302}
303
Sarah Sharp23e3be12009-04-29 19:05:20 -0700304void xhci_set_hc_event_deq(struct xhci_hcd *xhci)
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700305{
Sarah Sharp8e595a52009-07-27 12:03:31 -0700306 u64 temp;
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700307 dma_addr_t deq;
308
Sarah Sharp23e3be12009-04-29 19:05:20 -0700309 deq = xhci_trb_virt_to_dma(xhci->event_ring->deq_seg,
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700310 xhci->event_ring->dequeue);
311 if (deq == 0 && !in_interrupt())
312 xhci_warn(xhci, "WARN something wrong with SW event ring "
313 "dequeue ptr.\n");
314 /* Update HC event ring dequeue pointer */
Sarah Sharp8e595a52009-07-27 12:03:31 -0700315 temp = xhci_read_64(xhci, &xhci->ir_set->erst_dequeue);
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700316 temp &= ERST_PTR_MASK;
Sarah Sharp2d831092009-07-27 12:03:40 -0700317 /* Don't clear the EHB bit (which is RW1C) because
318 * there might be more events to service.
319 */
320 temp &= ~ERST_EHB;
Sarah Sharp66e49d82009-07-27 12:03:46 -0700321 xhci_dbg(xhci, "// Write event ring dequeue pointer, preserving EHB bit\n");
Sarah Sharp8e595a52009-07-27 12:03:31 -0700322 xhci_write_64(xhci, ((u64) deq & (u64) ~ERST_PTR_MASK) | temp,
323 &xhci->ir_set->erst_dequeue);
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700324}
325
326/* Ring the host controller doorbell after placing a command on the ring */
Sarah Sharp23e3be12009-04-29 19:05:20 -0700327void xhci_ring_cmd_db(struct xhci_hcd *xhci)
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700328{
329 u32 temp;
330
331 xhci_dbg(xhci, "// Ding dong!\n");
332 temp = xhci_readl(xhci, &xhci->dba->doorbell[0]) & DB_MASK;
333 xhci_writel(xhci, temp | DB_TARGET_HOST, &xhci->dba->doorbell[0]);
334 /* Flush PCI posted writes */
335 xhci_readl(xhci, &xhci->dba->doorbell[0]);
336}
337
Sarah Sharpae636742009-04-29 19:02:31 -0700338static void ring_ep_doorbell(struct xhci_hcd *xhci,
339 unsigned int slot_id,
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700340 unsigned int ep_index,
341 unsigned int stream_id)
Sarah Sharpae636742009-04-29 19:02:31 -0700342{
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700343 struct xhci_virt_ep *ep;
344 unsigned int ep_state;
Sarah Sharpae636742009-04-29 19:02:31 -0700345 u32 field;
346 __u32 __iomem *db_addr = &xhci->dba->doorbell[slot_id];
347
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700348 ep = &xhci->devs[slot_id]->eps[ep_index];
349 ep_state = ep->ep_state;
Sarah Sharpae636742009-04-29 19:02:31 -0700350 /* Don't ring the doorbell for this endpoint if there are pending
351 * cancellations because the we don't want to interrupt processing.
Sarah Sharp8df75f42010-04-02 15:34:16 -0700352 * We don't want to restart any stream rings if there's a set dequeue
353 * pointer command pending because the device can choose to start any
354 * stream once the endpoint is on the HW schedule.
355 * FIXME - check all the stream rings for pending cancellations.
Sarah Sharpae636742009-04-29 19:02:31 -0700356 */
Sarah Sharp678539c2009-10-27 10:55:52 -0700357 if (!(ep_state & EP_HALT_PENDING) && !(ep_state & SET_DEQ_PENDING)
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700358 && !(ep_state & EP_HALTED)) {
Sarah Sharpae636742009-04-29 19:02:31 -0700359 field = xhci_readl(xhci, db_addr) & DB_MASK;
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700360 field |= EPI_TO_DB(ep_index) | STREAM_ID_TO_DB(stream_id);
361 xhci_writel(xhci, field, db_addr);
Sarah Sharpae636742009-04-29 19:02:31 -0700362 /* Flush PCI posted writes - FIXME Matthew Wilcox says this
363 * isn't time-critical and we shouldn't make the CPU wait for
364 * the flush.
365 */
366 xhci_readl(xhci, db_addr);
367 }
368}
369
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700370/* Ring the doorbell for any rings with pending URBs */
371static void ring_doorbell_for_active_rings(struct xhci_hcd *xhci,
372 unsigned int slot_id,
373 unsigned int ep_index)
374{
375 unsigned int stream_id;
376 struct xhci_virt_ep *ep;
377
378 ep = &xhci->devs[slot_id]->eps[ep_index];
379
380 /* A ring has pending URBs if its TD list is not empty */
381 if (!(ep->ep_state & EP_HAS_STREAMS)) {
382 if (!(list_empty(&ep->ring->td_list)))
383 ring_ep_doorbell(xhci, slot_id, ep_index, 0);
384 return;
385 }
386
387 for (stream_id = 1; stream_id < ep->stream_info->num_streams;
388 stream_id++) {
389 struct xhci_stream_info *stream_info = ep->stream_info;
390 if (!list_empty(&stream_info->stream_rings[stream_id]->td_list))
391 ring_ep_doorbell(xhci, slot_id, ep_index, stream_id);
392 }
393}
394
Sarah Sharpae636742009-04-29 19:02:31 -0700395/*
396 * Find the segment that trb is in. Start searching in start_seg.
397 * If we must move past a segment that has a link TRB with a toggle cycle state
398 * bit set, then we will toggle the value pointed at by cycle_state.
399 */
400static struct xhci_segment *find_trb_seg(
401 struct xhci_segment *start_seg,
402 union xhci_trb *trb, int *cycle_state)
403{
404 struct xhci_segment *cur_seg = start_seg;
405 struct xhci_generic_trb *generic_trb;
406
407 while (cur_seg->trbs > trb ||
408 &cur_seg->trbs[TRBS_PER_SEGMENT - 1] < trb) {
409 generic_trb = &cur_seg->trbs[TRBS_PER_SEGMENT - 1].generic;
Andiry Xu54b5acf2010-05-10 19:57:17 -0700410 if ((generic_trb->field[3] & TRB_TYPE_BITMASK) ==
411 TRB_TYPE(TRB_LINK) &&
Sarah Sharpae636742009-04-29 19:02:31 -0700412 (generic_trb->field[3] & LINK_TOGGLE))
413 *cycle_state = ~(*cycle_state) & 0x1;
414 cur_seg = cur_seg->next;
415 if (cur_seg == start_seg)
416 /* Looped over the entire list. Oops! */
Randy Dunlap326b4812010-04-19 08:53:50 -0700417 return NULL;
Sarah Sharpae636742009-04-29 19:02:31 -0700418 }
419 return cur_seg;
420}
421
Sarah Sharpae636742009-04-29 19:02:31 -0700422/*
423 * Move the xHC's endpoint ring dequeue pointer past cur_td.
424 * Record the new state of the xHC's endpoint ring dequeue segment,
425 * dequeue pointer, and new consumer cycle state in state.
426 * Update our internal representation of the ring's dequeue pointer.
427 *
428 * We do this in three jumps:
429 * - First we update our new ring state to be the same as when the xHC stopped.
430 * - Then we traverse the ring to find the segment that contains
431 * the last TRB in the TD. We toggle the xHC's new cycle state when we pass
432 * any link TRBs with the toggle cycle bit set.
433 * - Finally we move the dequeue state one TRB further, toggling the cycle bit
434 * if we've moved it past a link TRB with the toggle cycle bit set.
435 */
Sarah Sharpc92bcfa2009-07-27 12:05:21 -0700436void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
Sarah Sharpae636742009-04-29 19:02:31 -0700437 unsigned int slot_id, unsigned int ep_index,
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700438 unsigned int stream_id, struct xhci_td *cur_td,
439 struct xhci_dequeue_state *state)
Sarah Sharpae636742009-04-29 19:02:31 -0700440{
441 struct xhci_virt_device *dev = xhci->devs[slot_id];
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700442 struct xhci_ring *ep_ring;
Sarah Sharpae636742009-04-29 19:02:31 -0700443 struct xhci_generic_trb *trb;
John Yound115b042009-07-27 12:05:15 -0700444 struct xhci_ep_ctx *ep_ctx;
Sarah Sharpc92bcfa2009-07-27 12:05:21 -0700445 dma_addr_t addr;
Sarah Sharpae636742009-04-29 19:02:31 -0700446
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700447 ep_ring = xhci_triad_to_transfer_ring(xhci, slot_id,
448 ep_index, stream_id);
449 if (!ep_ring) {
450 xhci_warn(xhci, "WARN can't find new dequeue state "
451 "for invalid stream ID %u.\n",
452 stream_id);
453 return;
454 }
Sarah Sharpae636742009-04-29 19:02:31 -0700455 state->new_cycle_state = 0;
Sarah Sharpc92bcfa2009-07-27 12:05:21 -0700456 xhci_dbg(xhci, "Finding segment containing stopped TRB.\n");
Sarah Sharpae636742009-04-29 19:02:31 -0700457 state->new_deq_seg = find_trb_seg(cur_td->start_seg,
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700458 dev->eps[ep_index].stopped_trb,
Sarah Sharpae636742009-04-29 19:02:31 -0700459 &state->new_cycle_state);
460 if (!state->new_deq_seg)
461 BUG();
462 /* Dig out the cycle state saved by the xHC during the stop ep cmd */
Sarah Sharpc92bcfa2009-07-27 12:05:21 -0700463 xhci_dbg(xhci, "Finding endpoint context\n");
John Yound115b042009-07-27 12:05:15 -0700464 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
465 state->new_cycle_state = 0x1 & ep_ctx->deq;
Sarah Sharpae636742009-04-29 19:02:31 -0700466
467 state->new_deq_ptr = cur_td->last_trb;
Sarah Sharpc92bcfa2009-07-27 12:05:21 -0700468 xhci_dbg(xhci, "Finding segment containing last TRB in TD.\n");
Sarah Sharpae636742009-04-29 19:02:31 -0700469 state->new_deq_seg = find_trb_seg(state->new_deq_seg,
470 state->new_deq_ptr,
471 &state->new_cycle_state);
472 if (!state->new_deq_seg)
473 BUG();
474
475 trb = &state->new_deq_ptr->generic;
Andiry Xu54b5acf2010-05-10 19:57:17 -0700476 if ((trb->field[3] & TRB_TYPE_BITMASK) == TRB_TYPE(TRB_LINK) &&
Sarah Sharpae636742009-04-29 19:02:31 -0700477 (trb->field[3] & LINK_TOGGLE))
478 state->new_cycle_state = ~(state->new_cycle_state) & 0x1;
479 next_trb(xhci, ep_ring, &state->new_deq_seg, &state->new_deq_ptr);
480
481 /* Don't update the ring cycle state for the producer (us). */
Sarah Sharpc92bcfa2009-07-27 12:05:21 -0700482 xhci_dbg(xhci, "New dequeue segment = %p (virtual)\n",
483 state->new_deq_seg);
484 addr = xhci_trb_virt_to_dma(state->new_deq_seg, state->new_deq_ptr);
485 xhci_dbg(xhci, "New dequeue pointer = 0x%llx (DMA)\n",
486 (unsigned long long) addr);
487 xhci_dbg(xhci, "Setting dequeue pointer in internal ring state.\n");
Sarah Sharpae636742009-04-29 19:02:31 -0700488 ep_ring->dequeue = state->new_deq_ptr;
489 ep_ring->deq_seg = state->new_deq_seg;
490}
491
Sarah Sharp23e3be12009-04-29 19:05:20 -0700492static void td_to_noop(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
Sarah Sharpae636742009-04-29 19:02:31 -0700493 struct xhci_td *cur_td)
494{
495 struct xhci_segment *cur_seg;
496 union xhci_trb *cur_trb;
497
498 for (cur_seg = cur_td->start_seg, cur_trb = cur_td->first_trb;
499 true;
500 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
501 if ((cur_trb->generic.field[3] & TRB_TYPE_BITMASK) ==
502 TRB_TYPE(TRB_LINK)) {
503 /* Unchain any chained Link TRBs, but
504 * leave the pointers intact.
505 */
506 cur_trb->generic.field[3] &= ~TRB_CHAIN;
507 xhci_dbg(xhci, "Cancel (unchain) link TRB\n");
Greg Kroah-Hartman700e2052009-04-29 19:14:08 -0700508 xhci_dbg(xhci, "Address = %p (0x%llx dma); "
509 "in seg %p (0x%llx dma)\n",
510 cur_trb,
Sarah Sharp23e3be12009-04-29 19:05:20 -0700511 (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
Greg Kroah-Hartman700e2052009-04-29 19:14:08 -0700512 cur_seg,
513 (unsigned long long)cur_seg->dma);
Sarah Sharpae636742009-04-29 19:02:31 -0700514 } else {
515 cur_trb->generic.field[0] = 0;
516 cur_trb->generic.field[1] = 0;
517 cur_trb->generic.field[2] = 0;
518 /* Preserve only the cycle bit of this TRB */
519 cur_trb->generic.field[3] &= TRB_CYCLE;
520 cur_trb->generic.field[3] |= TRB_TYPE(TRB_TR_NOOP);
Greg Kroah-Hartman700e2052009-04-29 19:14:08 -0700521 xhci_dbg(xhci, "Cancel TRB %p (0x%llx dma) "
522 "in seg %p (0x%llx dma)\n",
523 cur_trb,
Sarah Sharp23e3be12009-04-29 19:05:20 -0700524 (unsigned long long)xhci_trb_virt_to_dma(cur_seg, cur_trb),
Greg Kroah-Hartman700e2052009-04-29 19:14:08 -0700525 cur_seg,
526 (unsigned long long)cur_seg->dma);
Sarah Sharpae636742009-04-29 19:02:31 -0700527 }
528 if (cur_trb == cur_td->last_trb)
529 break;
530 }
531}
532
533static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700534 unsigned int ep_index, unsigned int stream_id,
535 struct xhci_segment *deq_seg,
Sarah Sharpae636742009-04-29 19:02:31 -0700536 union xhci_trb *deq_ptr, u32 cycle_state);
537
Sarah Sharpc92bcfa2009-07-27 12:05:21 -0700538void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700539 unsigned int slot_id, unsigned int ep_index,
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700540 unsigned int stream_id,
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700541 struct xhci_dequeue_state *deq_state)
Sarah Sharpc92bcfa2009-07-27 12:05:21 -0700542{
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700543 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
544
Sarah Sharpc92bcfa2009-07-27 12:05:21 -0700545 xhci_dbg(xhci, "Set TR Deq Ptr cmd, new deq seg = %p (0x%llx dma), "
546 "new deq ptr = %p (0x%llx dma), new cycle = %u\n",
547 deq_state->new_deq_seg,
548 (unsigned long long)deq_state->new_deq_seg->dma,
549 deq_state->new_deq_ptr,
550 (unsigned long long)xhci_trb_virt_to_dma(deq_state->new_deq_seg, deq_state->new_deq_ptr),
551 deq_state->new_cycle_state);
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700552 queue_set_tr_deq(xhci, slot_id, ep_index, stream_id,
Sarah Sharpc92bcfa2009-07-27 12:05:21 -0700553 deq_state->new_deq_seg,
554 deq_state->new_deq_ptr,
555 (u32) deq_state->new_cycle_state);
556 /* Stop the TD queueing code from ringing the doorbell until
557 * this command completes. The HC won't set the dequeue pointer
558 * if the ring is running, and ringing the doorbell starts the
559 * ring running.
560 */
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700561 ep->ep_state |= SET_DEQ_PENDING;
Sarah Sharpc92bcfa2009-07-27 12:05:21 -0700562}
563
Sarah Sharp6f5165c2009-10-27 10:57:01 -0700564static inline void xhci_stop_watchdog_timer_in_irq(struct xhci_hcd *xhci,
565 struct xhci_virt_ep *ep)
566{
567 ep->ep_state &= ~EP_HALT_PENDING;
568 /* Can't del_timer_sync in interrupt, so we attempt to cancel. If the
569 * timer is running on another CPU, we don't decrement stop_cmds_pending
570 * (since we didn't successfully stop the watchdog timer).
571 */
572 if (del_timer(&ep->stop_cmd_timer))
573 ep->stop_cmds_pending--;
574}
575
576/* Must be called with xhci->lock held in interrupt context */
577static void xhci_giveback_urb_in_irq(struct xhci_hcd *xhci,
578 struct xhci_td *cur_td, int status, char *adjective)
579{
580 struct usb_hcd *hcd = xhci_to_hcd(xhci);
581
582 cur_td->urb->hcpriv = NULL;
583 usb_hcd_unlink_urb_from_ep(hcd, cur_td->urb);
584 xhci_dbg(xhci, "Giveback %s URB %p\n", adjective, cur_td->urb);
585
586 spin_unlock(&xhci->lock);
587 usb_hcd_giveback_urb(hcd, cur_td->urb, status);
588 kfree(cur_td);
589 spin_lock(&xhci->lock);
590 xhci_dbg(xhci, "%s URB given back\n", adjective);
591}
592
Sarah Sharpae636742009-04-29 19:02:31 -0700593/*
594 * When we get a command completion for a Stop Endpoint Command, we need to
595 * unlink any cancelled TDs from the ring. There are two ways to do that:
596 *
597 * 1. If the HW was in the middle of processing the TD that needs to be
598 * cancelled, then we must move the ring's dequeue pointer past the last TRB
599 * in the TD with a Set Dequeue Pointer Command.
600 * 2. Otherwise, we turn all the TRBs in the TD into No-op TRBs (with the chain
601 * bit cleared) so that the HW will skip over them.
602 */
603static void handle_stopped_endpoint(struct xhci_hcd *xhci,
604 union xhci_trb *trb)
605{
606 unsigned int slot_id;
607 unsigned int ep_index;
608 struct xhci_ring *ep_ring;
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700609 struct xhci_virt_ep *ep;
Sarah Sharpae636742009-04-29 19:02:31 -0700610 struct list_head *entry;
Randy Dunlap326b4812010-04-19 08:53:50 -0700611 struct xhci_td *cur_td = NULL;
Sarah Sharpae636742009-04-29 19:02:31 -0700612 struct xhci_td *last_unlinked_td;
613
Sarah Sharpc92bcfa2009-07-27 12:05:21 -0700614 struct xhci_dequeue_state deq_state;
Sarah Sharpae636742009-04-29 19:02:31 -0700615
616 memset(&deq_state, 0, sizeof(deq_state));
617 slot_id = TRB_TO_SLOT_ID(trb->generic.field[3]);
618 ep_index = TRB_TO_EP_INDEX(trb->generic.field[3]);
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700619 ep = &xhci->devs[slot_id]->eps[ep_index];
Sarah Sharpae636742009-04-29 19:02:31 -0700620
Sarah Sharp678539c2009-10-27 10:55:52 -0700621 if (list_empty(&ep->cancelled_td_list)) {
Sarah Sharp6f5165c2009-10-27 10:57:01 -0700622 xhci_stop_watchdog_timer_in_irq(xhci, ep);
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700623 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
Sarah Sharpae636742009-04-29 19:02:31 -0700624 return;
Sarah Sharp678539c2009-10-27 10:55:52 -0700625 }
Sarah Sharpae636742009-04-29 19:02:31 -0700626
627 /* Fix up the ep ring first, so HW stops executing cancelled TDs.
628 * We have the xHCI lock, so nothing can modify this list until we drop
629 * it. We're also in the event handler, so we can't get re-interrupted
630 * if another Stop Endpoint command completes
631 */
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700632 list_for_each(entry, &ep->cancelled_td_list) {
Sarah Sharpae636742009-04-29 19:02:31 -0700633 cur_td = list_entry(entry, struct xhci_td, cancelled_td_list);
Greg Kroah-Hartman700e2052009-04-29 19:14:08 -0700634 xhci_dbg(xhci, "Cancelling TD starting at %p, 0x%llx (dma).\n",
635 cur_td->first_trb,
Sarah Sharp23e3be12009-04-29 19:05:20 -0700636 (unsigned long long)xhci_trb_virt_to_dma(cur_td->start_seg, cur_td->first_trb));
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700637 ep_ring = xhci_urb_to_transfer_ring(xhci, cur_td->urb);
638 if (!ep_ring) {
639 /* This shouldn't happen unless a driver is mucking
640 * with the stream ID after submission. This will
641 * leave the TD on the hardware ring, and the hardware
642 * will try to execute it, and may access a buffer
643 * that has already been freed. In the best case, the
644 * hardware will execute it, and the event handler will
645 * ignore the completion event for that TD, since it was
646 * removed from the td_list for that endpoint. In
647 * short, don't muck with the stream ID after
648 * submission.
649 */
650 xhci_warn(xhci, "WARN Cancelled URB %p "
651 "has invalid stream ID %u.\n",
652 cur_td->urb,
653 cur_td->urb->stream_id);
654 goto remove_finished_td;
655 }
Sarah Sharpae636742009-04-29 19:02:31 -0700656 /*
657 * If we stopped on the TD we need to cancel, then we have to
658 * move the xHC endpoint ring dequeue pointer past this TD.
659 */
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700660 if (cur_td == ep->stopped_td)
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700661 xhci_find_new_dequeue_state(xhci, slot_id, ep_index,
662 cur_td->urb->stream_id,
663 cur_td, &deq_state);
Sarah Sharpae636742009-04-29 19:02:31 -0700664 else
665 td_to_noop(xhci, ep_ring, cur_td);
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700666remove_finished_td:
Sarah Sharpae636742009-04-29 19:02:31 -0700667 /*
668 * The event handler won't see a completion for this TD anymore,
669 * so remove it from the endpoint ring's TD list. Keep it in
670 * the cancelled TD list for URB completion later.
671 */
672 list_del(&cur_td->td_list);
Sarah Sharpae636742009-04-29 19:02:31 -0700673 }
674 last_unlinked_td = cur_td;
Sarah Sharp6f5165c2009-10-27 10:57:01 -0700675 xhci_stop_watchdog_timer_in_irq(xhci, ep);
Sarah Sharpae636742009-04-29 19:02:31 -0700676
677 /* If necessary, queue a Set Transfer Ring Dequeue Pointer command */
678 if (deq_state.new_deq_ptr && deq_state.new_deq_seg) {
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700679 xhci_queue_new_dequeue_state(xhci,
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700680 slot_id, ep_index,
681 ep->stopped_td->urb->stream_id,
682 &deq_state);
Sarah Sharpac9d8fe2009-08-07 14:04:55 -0700683 xhci_ring_cmd_db(xhci);
Sarah Sharpae636742009-04-29 19:02:31 -0700684 } else {
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700685 /* Otherwise ring the doorbell(s) to restart queued transfers */
686 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
Sarah Sharpae636742009-04-29 19:02:31 -0700687 }
Sarah Sharp1624ae12010-05-06 13:40:08 -0700688 ep->stopped_td = NULL;
689 ep->stopped_trb = NULL;
Sarah Sharpae636742009-04-29 19:02:31 -0700690
691 /*
692 * Drop the lock and complete the URBs in the cancelled TD list.
693 * New TDs to be cancelled might be added to the end of the list before
694 * we can complete all the URBs for the TDs we already unlinked.
695 * So stop when we've completed the URB for the last TD we unlinked.
696 */
697 do {
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700698 cur_td = list_entry(ep->cancelled_td_list.next,
Sarah Sharpae636742009-04-29 19:02:31 -0700699 struct xhci_td, cancelled_td_list);
700 list_del(&cur_td->cancelled_td_list);
701
702 /* Clean up the cancelled URB */
Sarah Sharpae636742009-04-29 19:02:31 -0700703 /* Doesn't matter what we pass for status, since the core will
704 * just overwrite it (because the URB has been unlinked).
705 */
Sarah Sharp6f5165c2009-10-27 10:57:01 -0700706 xhci_giveback_urb_in_irq(xhci, cur_td, 0, "cancelled");
Sarah Sharpae636742009-04-29 19:02:31 -0700707
Sarah Sharp6f5165c2009-10-27 10:57:01 -0700708 /* Stop processing the cancelled list if the watchdog timer is
709 * running.
710 */
711 if (xhci->xhc_state & XHCI_STATE_DYING)
712 return;
Sarah Sharpae636742009-04-29 19:02:31 -0700713 } while (cur_td != last_unlinked_td);
714
715 /* Return to the event handler with xhci->lock re-acquired */
716}
717
Sarah Sharp6f5165c2009-10-27 10:57:01 -0700718/* Watchdog timer function for when a stop endpoint command fails to complete.
719 * In this case, we assume the host controller is broken or dying or dead. The
720 * host may still be completing some other events, so we have to be careful to
721 * let the event ring handler and the URB dequeueing/enqueueing functions know
722 * through xhci->state.
723 *
724 * The timer may also fire if the host takes a very long time to respond to the
725 * command, and the stop endpoint command completion handler cannot delete the
726 * timer before the timer function is called. Another endpoint cancellation may
727 * sneak in before the timer function can grab the lock, and that may queue
728 * another stop endpoint command and add the timer back. So we cannot use a
729 * simple flag to say whether there is a pending stop endpoint command for a
730 * particular endpoint.
731 *
732 * Instead we use a combination of that flag and a counter for the number of
733 * pending stop endpoint commands. If the timer is the tail end of the last
734 * stop endpoint command, and the endpoint's command is still pending, we assume
735 * the host is dying.
736 */
737void xhci_stop_endpoint_command_watchdog(unsigned long arg)
738{
739 struct xhci_hcd *xhci;
740 struct xhci_virt_ep *ep;
741 struct xhci_virt_ep *temp_ep;
742 struct xhci_ring *ring;
743 struct xhci_td *cur_td;
744 int ret, i, j;
745
746 ep = (struct xhci_virt_ep *) arg;
747 xhci = ep->xhci;
748
749 spin_lock(&xhci->lock);
750
751 ep->stop_cmds_pending--;
752 if (xhci->xhc_state & XHCI_STATE_DYING) {
753 xhci_dbg(xhci, "Stop EP timer ran, but another timer marked "
754 "xHCI as DYING, exiting.\n");
755 spin_unlock(&xhci->lock);
756 return;
757 }
758 if (!(ep->stop_cmds_pending == 0 && (ep->ep_state & EP_HALT_PENDING))) {
759 xhci_dbg(xhci, "Stop EP timer ran, but no command pending, "
760 "exiting.\n");
761 spin_unlock(&xhci->lock);
762 return;
763 }
764
765 xhci_warn(xhci, "xHCI host not responding to stop endpoint command.\n");
766 xhci_warn(xhci, "Assuming host is dying, halting host.\n");
767 /* Oops, HC is dead or dying or at least not responding to the stop
768 * endpoint command.
769 */
770 xhci->xhc_state |= XHCI_STATE_DYING;
771 /* Disable interrupts from the host controller and start halting it */
772 xhci_quiesce(xhci);
773 spin_unlock(&xhci->lock);
774
775 ret = xhci_halt(xhci);
776
777 spin_lock(&xhci->lock);
778 if (ret < 0) {
779 /* This is bad; the host is not responding to commands and it's
780 * not allowing itself to be halted. At least interrupts are
781 * disabled, so we can set HC_STATE_HALT and notify the
782 * USB core. But if we call usb_hc_died(), it will attempt to
783 * disconnect all device drivers under this host. Those
784 * disconnect() methods will wait for all URBs to be unlinked,
785 * so we must complete them.
786 */
787 xhci_warn(xhci, "Non-responsive xHCI host is not halting.\n");
788 xhci_warn(xhci, "Completing active URBs anyway.\n");
789 /* We could turn all TDs on the rings to no-ops. This won't
790 * help if the host has cached part of the ring, and is slow if
791 * we want to preserve the cycle bit. Skip it and hope the host
792 * doesn't touch the memory.
793 */
794 }
795 for (i = 0; i < MAX_HC_SLOTS; i++) {
796 if (!xhci->devs[i])
797 continue;
798 for (j = 0; j < 31; j++) {
799 temp_ep = &xhci->devs[i]->eps[j];
800 ring = temp_ep->ring;
801 if (!ring)
802 continue;
803 xhci_dbg(xhci, "Killing URBs for slot ID %u, "
804 "ep index %u\n", i, j);
805 while (!list_empty(&ring->td_list)) {
806 cur_td = list_first_entry(&ring->td_list,
807 struct xhci_td,
808 td_list);
809 list_del(&cur_td->td_list);
810 if (!list_empty(&cur_td->cancelled_td_list))
811 list_del(&cur_td->cancelled_td_list);
812 xhci_giveback_urb_in_irq(xhci, cur_td,
813 -ESHUTDOWN, "killed");
814 }
815 while (!list_empty(&temp_ep->cancelled_td_list)) {
816 cur_td = list_first_entry(
817 &temp_ep->cancelled_td_list,
818 struct xhci_td,
819 cancelled_td_list);
820 list_del(&cur_td->cancelled_td_list);
821 xhci_giveback_urb_in_irq(xhci, cur_td,
822 -ESHUTDOWN, "killed");
823 }
824 }
825 }
826 spin_unlock(&xhci->lock);
827 xhci_to_hcd(xhci)->state = HC_STATE_HALT;
828 xhci_dbg(xhci, "Calling usb_hc_died()\n");
829 usb_hc_died(xhci_to_hcd(xhci));
830 xhci_dbg(xhci, "xHCI host controller is dead.\n");
831}
832
Sarah Sharpae636742009-04-29 19:02:31 -0700833/*
834 * When we get a completion for a Set Transfer Ring Dequeue Pointer command,
835 * we need to clear the set deq pending flag in the endpoint ring state, so that
836 * the TD queueing code can ring the doorbell again. We also need to ring the
837 * endpoint doorbell to restart the ring, but only if there aren't more
838 * cancellations pending.
839 */
840static void handle_set_deq_completion(struct xhci_hcd *xhci,
841 struct xhci_event_cmd *event,
842 union xhci_trb *trb)
843{
844 unsigned int slot_id;
845 unsigned int ep_index;
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700846 unsigned int stream_id;
Sarah Sharpae636742009-04-29 19:02:31 -0700847 struct xhci_ring *ep_ring;
848 struct xhci_virt_device *dev;
John Yound115b042009-07-27 12:05:15 -0700849 struct xhci_ep_ctx *ep_ctx;
850 struct xhci_slot_ctx *slot_ctx;
Sarah Sharpae636742009-04-29 19:02:31 -0700851
852 slot_id = TRB_TO_SLOT_ID(trb->generic.field[3]);
853 ep_index = TRB_TO_EP_INDEX(trb->generic.field[3]);
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700854 stream_id = TRB_TO_STREAM_ID(trb->generic.field[2]);
Sarah Sharpae636742009-04-29 19:02:31 -0700855 dev = xhci->devs[slot_id];
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700856
857 ep_ring = xhci_stream_id_to_ring(dev, ep_index, stream_id);
858 if (!ep_ring) {
859 xhci_warn(xhci, "WARN Set TR deq ptr command for "
860 "freed stream ID %u\n",
861 stream_id);
862 /* XXX: Harmless??? */
863 dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
864 return;
865 }
866
John Yound115b042009-07-27 12:05:15 -0700867 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
868 slot_ctx = xhci_get_slot_ctx(xhci, dev->out_ctx);
Sarah Sharpae636742009-04-29 19:02:31 -0700869
870 if (GET_COMP_CODE(event->status) != COMP_SUCCESS) {
871 unsigned int ep_state;
872 unsigned int slot_state;
873
874 switch (GET_COMP_CODE(event->status)) {
875 case COMP_TRB_ERR:
876 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd invalid because "
877 "of stream ID configuration\n");
878 break;
879 case COMP_CTX_STATE:
880 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed due "
881 "to incorrect slot or ep state.\n");
John Yound115b042009-07-27 12:05:15 -0700882 ep_state = ep_ctx->ep_info;
Sarah Sharpae636742009-04-29 19:02:31 -0700883 ep_state &= EP_STATE_MASK;
John Yound115b042009-07-27 12:05:15 -0700884 slot_state = slot_ctx->dev_state;
Sarah Sharpae636742009-04-29 19:02:31 -0700885 slot_state = GET_SLOT_STATE(slot_state);
886 xhci_dbg(xhci, "Slot state = %u, EP state = %u\n",
887 slot_state, ep_state);
888 break;
889 case COMP_EBADSLT:
890 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd failed because "
891 "slot %u was not enabled.\n", slot_id);
892 break;
893 default:
894 xhci_warn(xhci, "WARN Set TR Deq Ptr cmd with unknown "
895 "completion code of %u.\n",
896 GET_COMP_CODE(event->status));
897 break;
898 }
899 /* OK what do we do now? The endpoint state is hosed, and we
900 * should never get to this point if the synchronization between
901 * queueing, and endpoint state are correct. This might happen
902 * if the device gets disconnected after we've finished
903 * cancelling URBs, which might not be an error...
904 */
905 } else {
Sarah Sharp8e595a52009-07-27 12:03:31 -0700906 xhci_dbg(xhci, "Successful Set TR Deq Ptr cmd, deq = @%08llx\n",
John Yound115b042009-07-27 12:05:15 -0700907 ep_ctx->deq);
Sarah Sharpae636742009-04-29 19:02:31 -0700908 }
909
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700910 dev->eps[ep_index].ep_state &= ~SET_DEQ_PENDING;
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700911 /* Restart any rings with pending URBs */
912 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
Sarah Sharpae636742009-04-29 19:02:31 -0700913}
914
Sarah Sharpa1587d92009-07-27 12:03:15 -0700915static void handle_reset_ep_completion(struct xhci_hcd *xhci,
916 struct xhci_event_cmd *event,
917 union xhci_trb *trb)
918{
919 int slot_id;
920 unsigned int ep_index;
921
922 slot_id = TRB_TO_SLOT_ID(trb->generic.field[3]);
923 ep_index = TRB_TO_EP_INDEX(trb->generic.field[3]);
924 /* This command will only fail if the endpoint wasn't halted,
925 * but we don't care.
926 */
927 xhci_dbg(xhci, "Ignoring reset ep completion code of %u\n",
928 (unsigned int) GET_COMP_CODE(event->status));
929
Sarah Sharpac9d8fe2009-08-07 14:04:55 -0700930 /* HW with the reset endpoint quirk needs to have a configure endpoint
931 * command complete before the endpoint can be used. Queue that here
932 * because the HW can't handle two commands being queued in a row.
933 */
934 if (xhci->quirks & XHCI_RESET_EP_QUIRK) {
935 xhci_dbg(xhci, "Queueing configure endpoint command\n");
936 xhci_queue_configure_endpoint(xhci,
Sarah Sharp913a8a32009-09-04 10:53:13 -0700937 xhci->devs[slot_id]->in_ctx->dma, slot_id,
938 false);
Sarah Sharpac9d8fe2009-08-07 14:04:55 -0700939 xhci_ring_cmd_db(xhci);
940 } else {
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700941 /* Clear our internal halted state and restart the ring(s) */
Sarah Sharp63a0d9a2009-09-04 10:53:09 -0700942 xhci->devs[slot_id]->eps[ep_index].ep_state &= ~EP_HALTED;
Sarah Sharpe9df17e2010-04-02 15:34:43 -0700943 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
Sarah Sharpac9d8fe2009-08-07 14:04:55 -0700944 }
Sarah Sharpa1587d92009-07-27 12:03:15 -0700945}
Sarah Sharpae636742009-04-29 19:02:31 -0700946
Sarah Sharpa50c8aa2009-09-04 10:53:15 -0700947/* Check to see if a command in the device's command queue matches this one.
948 * Signal the completion or free the command, and return 1. Return 0 if the
949 * completed command isn't at the head of the command list.
950 */
951static int handle_cmd_in_cmd_wait_list(struct xhci_hcd *xhci,
952 struct xhci_virt_device *virt_dev,
953 struct xhci_event_cmd *event)
954{
955 struct xhci_command *command;
956
957 if (list_empty(&virt_dev->cmd_list))
958 return 0;
959
960 command = list_entry(virt_dev->cmd_list.next,
961 struct xhci_command, cmd_list);
962 if (xhci->cmd_ring->dequeue != command->command_trb)
963 return 0;
964
965 command->status =
966 GET_COMP_CODE(event->status);
967 list_del(&command->cmd_list);
968 if (command->completion)
969 complete(command->completion);
970 else
971 xhci_free_command(xhci, command);
972 return 1;
973}
974
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700975static void handle_cmd_completion(struct xhci_hcd *xhci,
976 struct xhci_event_cmd *event)
977{
Sarah Sharp3ffbba92009-04-27 19:57:38 -0700978 int slot_id = TRB_TO_SLOT_ID(event->flags);
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700979 u64 cmd_dma;
980 dma_addr_t cmd_dequeue_dma;
Sarah Sharpac9d8fe2009-08-07 14:04:55 -0700981 struct xhci_input_control_ctx *ctrl_ctx;
Sarah Sharp913a8a32009-09-04 10:53:13 -0700982 struct xhci_virt_device *virt_dev;
Sarah Sharpac9d8fe2009-08-07 14:04:55 -0700983 unsigned int ep_index;
984 struct xhci_ring *ep_ring;
985 unsigned int ep_state;
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700986
Sarah Sharp8e595a52009-07-27 12:03:31 -0700987 cmd_dma = event->cmd_trb;
Sarah Sharp23e3be12009-04-29 19:05:20 -0700988 cmd_dequeue_dma = xhci_trb_virt_to_dma(xhci->cmd_ring->deq_seg,
Sarah Sharp7f84eef2009-04-27 19:53:56 -0700989 xhci->cmd_ring->dequeue);
990 /* Is the command ring deq ptr out of sync with the deq seg ptr? */
991 if (cmd_dequeue_dma == 0) {
992 xhci->error_bitmask |= 1 << 4;
993 return;
994 }
995 /* Does the DMA address match our internal dequeue pointer address? */
996 if (cmd_dma != (u64) cmd_dequeue_dma) {
997 xhci->error_bitmask |= 1 << 5;
998 return;
999 }
1000 switch (xhci->cmd_ring->dequeue->generic.field[3] & TRB_TYPE_BITMASK) {
Sarah Sharp3ffbba92009-04-27 19:57:38 -07001001 case TRB_TYPE(TRB_ENABLE_SLOT):
1002 if (GET_COMP_CODE(event->status) == COMP_SUCCESS)
1003 xhci->slot_id = slot_id;
1004 else
1005 xhci->slot_id = 0;
1006 complete(&xhci->addr_dev);
1007 break;
1008 case TRB_TYPE(TRB_DISABLE_SLOT):
1009 if (xhci->devs[slot_id])
1010 xhci_free_virt_device(xhci, slot_id);
1011 break;
Sarah Sharpf94e01862009-04-27 19:58:38 -07001012 case TRB_TYPE(TRB_CONFIG_EP):
Sarah Sharp913a8a32009-09-04 10:53:13 -07001013 virt_dev = xhci->devs[slot_id];
Sarah Sharpa50c8aa2009-09-04 10:53:15 -07001014 if (handle_cmd_in_cmd_wait_list(xhci, virt_dev, event))
Sarah Sharp913a8a32009-09-04 10:53:13 -07001015 break;
Sarah Sharpac9d8fe2009-08-07 14:04:55 -07001016 /*
1017 * Configure endpoint commands can come from the USB core
1018 * configuration or alt setting changes, or because the HW
1019 * needed an extra configure endpoint command after a reset
Sarah Sharp8df75f42010-04-02 15:34:16 -07001020 * endpoint command or streams were being configured.
1021 * If the command was for a halted endpoint, the xHCI driver
1022 * is not waiting on the configure endpoint command.
Sarah Sharpac9d8fe2009-08-07 14:04:55 -07001023 */
1024 ctrl_ctx = xhci_get_input_control_ctx(xhci,
Sarah Sharp913a8a32009-09-04 10:53:13 -07001025 virt_dev->in_ctx);
Sarah Sharpac9d8fe2009-08-07 14:04:55 -07001026 /* Input ctx add_flags are the endpoint index plus one */
1027 ep_index = xhci_last_valid_endpoint(ctrl_ctx->add_flags) - 1;
Sarah Sharp06df5722009-12-03 09:44:31 -08001028 /* A usb_set_interface() call directly after clearing a halted
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001029 * condition may race on this quirky hardware. Not worth
1030 * worrying about, since this is prototype hardware. Not sure
1031 * if this will work for streams, but streams support was
1032 * untested on this prototype.
Sarah Sharp06df5722009-12-03 09:44:31 -08001033 */
Sarah Sharpac9d8fe2009-08-07 14:04:55 -07001034 if (xhci->quirks & XHCI_RESET_EP_QUIRK &&
Sarah Sharp06df5722009-12-03 09:44:31 -08001035 ep_index != (unsigned int) -1 &&
1036 ctrl_ctx->add_flags - SLOT_FLAG ==
1037 ctrl_ctx->drop_flags) {
1038 ep_ring = xhci->devs[slot_id]->eps[ep_index].ring;
1039 ep_state = xhci->devs[slot_id]->eps[ep_index].ep_state;
1040 if (!(ep_state & EP_HALTED))
1041 goto bandwidth_change;
1042 xhci_dbg(xhci, "Completed config ep cmd - "
1043 "last ep index = %d, state = %d\n",
1044 ep_index, ep_state);
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001045 /* Clear internal halted state and restart ring(s) */
Sarah Sharp63a0d9a2009-09-04 10:53:09 -07001046 xhci->devs[slot_id]->eps[ep_index].ep_state &=
Sarah Sharpac9d8fe2009-08-07 14:04:55 -07001047 ~EP_HALTED;
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001048 ring_doorbell_for_active_rings(xhci, slot_id, ep_index);
Sarah Sharp06df5722009-12-03 09:44:31 -08001049 break;
Sarah Sharpac9d8fe2009-08-07 14:04:55 -07001050 }
Sarah Sharp06df5722009-12-03 09:44:31 -08001051bandwidth_change:
1052 xhci_dbg(xhci, "Completed config ep cmd\n");
1053 xhci->devs[slot_id]->cmd_status =
1054 GET_COMP_CODE(event->status);
1055 complete(&xhci->devs[slot_id]->cmd_completion);
Sarah Sharpf94e01862009-04-27 19:58:38 -07001056 break;
Sarah Sharp2d3f1fa2009-08-07 14:04:49 -07001057 case TRB_TYPE(TRB_EVAL_CONTEXT):
Sarah Sharpac1c1b72009-09-04 10:53:20 -07001058 virt_dev = xhci->devs[slot_id];
1059 if (handle_cmd_in_cmd_wait_list(xhci, virt_dev, event))
1060 break;
Sarah Sharp2d3f1fa2009-08-07 14:04:49 -07001061 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(event->status);
1062 complete(&xhci->devs[slot_id]->cmd_completion);
1063 break;
Sarah Sharp3ffbba92009-04-27 19:57:38 -07001064 case TRB_TYPE(TRB_ADDR_DEV):
1065 xhci->devs[slot_id]->cmd_status = GET_COMP_CODE(event->status);
1066 complete(&xhci->addr_dev);
1067 break;
Sarah Sharpae636742009-04-29 19:02:31 -07001068 case TRB_TYPE(TRB_STOP_RING):
1069 handle_stopped_endpoint(xhci, xhci->cmd_ring->dequeue);
1070 break;
1071 case TRB_TYPE(TRB_SET_DEQ):
1072 handle_set_deq_completion(xhci, event, xhci->cmd_ring->dequeue);
1073 break;
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001074 case TRB_TYPE(TRB_CMD_NOOP):
1075 ++xhci->noops_handled;
1076 break;
Sarah Sharpa1587d92009-07-27 12:03:15 -07001077 case TRB_TYPE(TRB_RESET_EP):
1078 handle_reset_ep_completion(xhci, event, xhci->cmd_ring->dequeue);
1079 break;
Sarah Sharp2a8f82c2009-12-09 15:59:13 -08001080 case TRB_TYPE(TRB_RESET_DEV):
1081 xhci_dbg(xhci, "Completed reset device command.\n");
1082 slot_id = TRB_TO_SLOT_ID(
1083 xhci->cmd_ring->dequeue->generic.field[3]);
1084 virt_dev = xhci->devs[slot_id];
1085 if (virt_dev)
1086 handle_cmd_in_cmd_wait_list(xhci, virt_dev, event);
1087 else
1088 xhci_warn(xhci, "Reset device command completion "
1089 "for disabled slot %u\n", slot_id);
1090 break;
Sarah Sharp02386342010-05-24 13:25:28 -07001091 case TRB_TYPE(TRB_NEC_GET_FW):
1092 if (!(xhci->quirks & XHCI_NEC_HOST)) {
1093 xhci->error_bitmask |= 1 << 6;
1094 break;
1095 }
1096 xhci_dbg(xhci, "NEC firmware version %2x.%02x\n",
1097 NEC_FW_MAJOR(event->status),
1098 NEC_FW_MINOR(event->status));
1099 break;
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001100 default:
1101 /* Skip over unknown commands on the event ring */
1102 xhci->error_bitmask |= 1 << 6;
1103 break;
1104 }
1105 inc_deq(xhci, xhci->cmd_ring, false);
1106}
1107
Sarah Sharp02386342010-05-24 13:25:28 -07001108static void handle_vendor_event(struct xhci_hcd *xhci,
1109 union xhci_trb *event)
1110{
1111 u32 trb_type;
1112
1113 trb_type = TRB_FIELD_TO_TYPE(event->generic.field[3]);
1114 xhci_dbg(xhci, "Vendor specific event TRB type = %u\n", trb_type);
1115 if (trb_type == TRB_NEC_CMD_COMP && (xhci->quirks & XHCI_NEC_HOST))
1116 handle_cmd_completion(xhci, &event->event_cmd);
1117}
1118
Sarah Sharp0f2a7932009-04-27 19:57:12 -07001119static void handle_port_status(struct xhci_hcd *xhci,
1120 union xhci_trb *event)
1121{
1122 u32 port_id;
1123
1124 /* Port status change events always have a successful completion code */
1125 if (GET_COMP_CODE(event->generic.field[2]) != COMP_SUCCESS) {
1126 xhci_warn(xhci, "WARN: xHC returned failed port status event\n");
1127 xhci->error_bitmask |= 1 << 8;
1128 }
1129 /* FIXME: core doesn't care about all port link state changes yet */
1130 port_id = GET_PORT_ID(event->generic.field[0]);
1131 xhci_dbg(xhci, "Port Status Change Event for port %d\n", port_id);
1132
1133 /* Update event ring dequeue pointer before dropping the lock */
1134 inc_deq(xhci, xhci->event_ring, true);
Sarah Sharp23e3be12009-04-29 19:05:20 -07001135 xhci_set_hc_event_deq(xhci);
Sarah Sharp0f2a7932009-04-27 19:57:12 -07001136
1137 spin_unlock(&xhci->lock);
1138 /* Pass this up to the core */
1139 usb_hcd_poll_rh_status(xhci_to_hcd(xhci));
1140 spin_lock(&xhci->lock);
1141}
1142
1143/*
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001144 * This TD is defined by the TRBs starting at start_trb in start_seg and ending
1145 * at end_trb, which may be in another segment. If the suspect DMA address is a
1146 * TRB in this TD, this function returns that TRB's segment. Otherwise it
1147 * returns 0.
1148 */
Sarah Sharp6648f292009-11-09 13:35:23 -08001149struct xhci_segment *trb_in_td(struct xhci_segment *start_seg,
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001150 union xhci_trb *start_trb,
1151 union xhci_trb *end_trb,
1152 dma_addr_t suspect_dma)
1153{
1154 dma_addr_t start_dma;
1155 dma_addr_t end_seg_dma;
1156 dma_addr_t end_trb_dma;
1157 struct xhci_segment *cur_seg;
1158
Sarah Sharp23e3be12009-04-29 19:05:20 -07001159 start_dma = xhci_trb_virt_to_dma(start_seg, start_trb);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001160 cur_seg = start_seg;
1161
1162 do {
Sarah Sharp2fa88da2009-11-03 22:02:24 -08001163 if (start_dma == 0)
Randy Dunlap326b4812010-04-19 08:53:50 -07001164 return NULL;
Sarah Sharpae636742009-04-29 19:02:31 -07001165 /* We may get an event for a Link TRB in the middle of a TD */
Sarah Sharp23e3be12009-04-29 19:05:20 -07001166 end_seg_dma = xhci_trb_virt_to_dma(cur_seg,
Sarah Sharp2fa88da2009-11-03 22:02:24 -08001167 &cur_seg->trbs[TRBS_PER_SEGMENT - 1]);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001168 /* If the end TRB isn't in this segment, this is set to 0 */
Sarah Sharp23e3be12009-04-29 19:05:20 -07001169 end_trb_dma = xhci_trb_virt_to_dma(cur_seg, end_trb);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001170
1171 if (end_trb_dma > 0) {
1172 /* The end TRB is in this segment, so suspect should be here */
1173 if (start_dma <= end_trb_dma) {
1174 if (suspect_dma >= start_dma && suspect_dma <= end_trb_dma)
1175 return cur_seg;
1176 } else {
1177 /* Case for one segment with
1178 * a TD wrapped around to the top
1179 */
1180 if ((suspect_dma >= start_dma &&
1181 suspect_dma <= end_seg_dma) ||
1182 (suspect_dma >= cur_seg->dma &&
1183 suspect_dma <= end_trb_dma))
1184 return cur_seg;
1185 }
Randy Dunlap326b4812010-04-19 08:53:50 -07001186 return NULL;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001187 } else {
1188 /* Might still be somewhere in this segment */
1189 if (suspect_dma >= start_dma && suspect_dma <= end_seg_dma)
1190 return cur_seg;
1191 }
1192 cur_seg = cur_seg->next;
Sarah Sharp23e3be12009-04-29 19:05:20 -07001193 start_dma = xhci_trb_virt_to_dma(cur_seg, &cur_seg->trbs[0]);
Sarah Sharp2fa88da2009-11-03 22:02:24 -08001194 } while (cur_seg != start_seg);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001195
Randy Dunlap326b4812010-04-19 08:53:50 -07001196 return NULL;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001197}
1198
Sarah Sharpbcef3fd2009-11-11 10:28:44 -08001199static void xhci_cleanup_halted_endpoint(struct xhci_hcd *xhci,
1200 unsigned int slot_id, unsigned int ep_index,
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001201 unsigned int stream_id,
Sarah Sharpbcef3fd2009-11-11 10:28:44 -08001202 struct xhci_td *td, union xhci_trb *event_trb)
1203{
1204 struct xhci_virt_ep *ep = &xhci->devs[slot_id]->eps[ep_index];
1205 ep->ep_state |= EP_HALTED;
1206 ep->stopped_td = td;
1207 ep->stopped_trb = event_trb;
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001208 ep->stopped_stream = stream_id;
Sarah Sharp1624ae12010-05-06 13:40:08 -07001209
Sarah Sharpbcef3fd2009-11-11 10:28:44 -08001210 xhci_queue_reset_ep(xhci, slot_id, ep_index);
1211 xhci_cleanup_stalled_ring(xhci, td->urb->dev, ep_index);
Sarah Sharp1624ae12010-05-06 13:40:08 -07001212
1213 ep->stopped_td = NULL;
1214 ep->stopped_trb = NULL;
Sarah Sharp5e5cf6f2010-05-06 13:40:18 -07001215 ep->stopped_stream = 0;
Sarah Sharp1624ae12010-05-06 13:40:08 -07001216
Sarah Sharpbcef3fd2009-11-11 10:28:44 -08001217 xhci_ring_cmd_db(xhci);
1218}
1219
1220/* Check if an error has halted the endpoint ring. The class driver will
1221 * cleanup the halt for a non-default control endpoint if we indicate a stall.
1222 * However, a babble and other errors also halt the endpoint ring, and the class
1223 * driver won't clear the halt in that case, so we need to issue a Set Transfer
1224 * Ring Dequeue Pointer command manually.
1225 */
1226static int xhci_requires_manual_halt_cleanup(struct xhci_hcd *xhci,
1227 struct xhci_ep_ctx *ep_ctx,
1228 unsigned int trb_comp_code)
1229{
1230 /* TRB completion codes that may require a manual halt cleanup */
1231 if (trb_comp_code == COMP_TX_ERR ||
1232 trb_comp_code == COMP_BABBLE ||
1233 trb_comp_code == COMP_SPLIT_ERR)
1234 /* The 0.96 spec says a babbling control endpoint
1235 * is not halted. The 0.96 spec says it is. Some HW
1236 * claims to be 0.95 compliant, but it halts the control
1237 * endpoint anyway. Check if a babble halted the
1238 * endpoint.
1239 */
1240 if ((ep_ctx->ep_info & EP_STATE_MASK) == EP_STATE_HALTED)
1241 return 1;
1242
1243 return 0;
1244}
1245
Sarah Sharpb45b5062009-12-09 15:59:06 -08001246int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code)
1247{
1248 if (trb_comp_code >= 224 && trb_comp_code <= 255) {
1249 /* Vendor defined "informational" completion code,
1250 * treat as not-an-error.
1251 */
1252 xhci_dbg(xhci, "Vendor defined info completion code %u\n",
1253 trb_comp_code);
1254 xhci_dbg(xhci, "Treating code as success.\n");
1255 return 1;
1256 }
1257 return 0;
1258}
1259
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001260/*
1261 * If this function returns an error condition, it means it got a Transfer
1262 * event with a corrupted Slot ID, Endpoint ID, or TRB DMA address.
1263 * At this point, the host controller is probably hosed and should be reset.
1264 */
1265static int handle_tx_event(struct xhci_hcd *xhci,
1266 struct xhci_transfer_event *event)
1267{
1268 struct xhci_virt_device *xdev;
Sarah Sharp63a0d9a2009-09-04 10:53:09 -07001269 struct xhci_virt_ep *ep;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001270 struct xhci_ring *ep_ring;
Sarah Sharp82d10092009-08-07 14:04:52 -07001271 unsigned int slot_id;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001272 int ep_index;
Randy Dunlap326b4812010-04-19 08:53:50 -07001273 struct xhci_td *td = NULL;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001274 dma_addr_t event_dma;
1275 struct xhci_segment *event_seg;
1276 union xhci_trb *event_trb;
Randy Dunlap326b4812010-04-19 08:53:50 -07001277 struct urb *urb = NULL;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001278 int status = -EINPROGRESS;
John Yound115b042009-07-27 12:05:15 -07001279 struct xhci_ep_ctx *ep_ctx;
Sarah Sharp66d1eeb2009-08-27 14:35:53 -07001280 u32 trb_comp_code;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001281
Sarah Sharp66e49d82009-07-27 12:03:46 -07001282 xhci_dbg(xhci, "In %s\n", __func__);
Sarah Sharp82d10092009-08-07 14:04:52 -07001283 slot_id = TRB_TO_SLOT_ID(event->flags);
1284 xdev = xhci->devs[slot_id];
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001285 if (!xdev) {
1286 xhci_err(xhci, "ERROR Transfer event pointed to bad slot\n");
1287 return -ENODEV;
1288 }
1289
1290 /* Endpoint ID is 1 based, our index is zero based */
1291 ep_index = TRB_TO_EP_ID(event->flags) - 1;
Sarah Sharp66e49d82009-07-27 12:03:46 -07001292 xhci_dbg(xhci, "%s - ep index = %d\n", __func__, ep_index);
Sarah Sharp63a0d9a2009-09-04 10:53:09 -07001293 ep = &xdev->eps[ep_index];
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001294 ep_ring = xhci_dma_to_transfer_ring(ep, event->buffer);
John Yound115b042009-07-27 12:05:15 -07001295 ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
1296 if (!ep_ring || (ep_ctx->ep_info & EP_STATE_MASK) == EP_STATE_DISABLED) {
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001297 xhci_err(xhci, "ERROR Transfer event for disabled endpoint "
1298 "or incorrect stream ring\n");
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001299 return -ENODEV;
1300 }
1301
Sarah Sharp8e595a52009-07-27 12:03:31 -07001302 event_dma = event->buffer;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001303 /* This TRB should be in the TD at the head of this ring's TD list */
Sarah Sharp66e49d82009-07-27 12:03:46 -07001304 xhci_dbg(xhci, "%s - checking for list empty\n", __func__);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001305 if (list_empty(&ep_ring->td_list)) {
1306 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d with no TDs queued?\n",
1307 TRB_TO_SLOT_ID(event->flags), ep_index);
1308 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n",
1309 (unsigned int) (event->flags & TRB_TYPE_BITMASK)>>10);
1310 xhci_print_trb_offsets(xhci, (union xhci_trb *) event);
1311 urb = NULL;
1312 goto cleanup;
1313 }
Sarah Sharp66e49d82009-07-27 12:03:46 -07001314 xhci_dbg(xhci, "%s - getting list entry\n", __func__);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001315 td = list_entry(ep_ring->td_list.next, struct xhci_td, td_list);
1316
1317 /* Is this a TRB in the currently executing TD? */
Sarah Sharp66e49d82009-07-27 12:03:46 -07001318 xhci_dbg(xhci, "%s - looking for TD\n", __func__);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001319 event_seg = trb_in_td(ep_ring->deq_seg, ep_ring->dequeue,
1320 td->last_trb, event_dma);
Sarah Sharp66e49d82009-07-27 12:03:46 -07001321 xhci_dbg(xhci, "%s - found event_seg = %p\n", __func__, event_seg);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001322 if (!event_seg) {
1323 /* HC is busted, give up! */
1324 xhci_err(xhci, "ERROR Transfer event TRB DMA ptr not part of current TD\n");
1325 return -ESHUTDOWN;
1326 }
1327 event_trb = &event_seg->trbs[(event_dma - event_seg->dma) / sizeof(*event_trb)];
Sarah Sharpb10de142009-04-27 19:58:50 -07001328 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n",
1329 (unsigned int) (event->flags & TRB_TYPE_BITMASK)>>10);
Sarah Sharp8e595a52009-07-27 12:03:31 -07001330 xhci_dbg(xhci, "Offset 0x00 (buffer lo) = 0x%x\n",
1331 lower_32_bits(event->buffer));
1332 xhci_dbg(xhci, "Offset 0x04 (buffer hi) = 0x%x\n",
1333 upper_32_bits(event->buffer));
Sarah Sharpb10de142009-04-27 19:58:50 -07001334 xhci_dbg(xhci, "Offset 0x08 (transfer length) = 0x%x\n",
1335 (unsigned int) event->transfer_len);
1336 xhci_dbg(xhci, "Offset 0x0C (flags) = 0x%x\n",
1337 (unsigned int) event->flags);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001338
Sarah Sharpb10de142009-04-27 19:58:50 -07001339 /* Look for common error cases */
Sarah Sharp66d1eeb2009-08-27 14:35:53 -07001340 trb_comp_code = GET_COMP_CODE(event->transfer_len);
1341 switch (trb_comp_code) {
Sarah Sharpb10de142009-04-27 19:58:50 -07001342 /* Skip codes that require special handling depending on
1343 * transfer type
1344 */
1345 case COMP_SUCCESS:
1346 case COMP_SHORT_TX:
1347 break;
Sarah Sharpae636742009-04-29 19:02:31 -07001348 case COMP_STOP:
1349 xhci_dbg(xhci, "Stopped on Transfer TRB\n");
1350 break;
1351 case COMP_STOP_INVAL:
1352 xhci_dbg(xhci, "Stopped on No-op or Link TRB\n");
1353 break;
Sarah Sharpb10de142009-04-27 19:58:50 -07001354 case COMP_STALL:
1355 xhci_warn(xhci, "WARN: Stalled endpoint\n");
Sarah Sharp63a0d9a2009-09-04 10:53:09 -07001356 ep->ep_state |= EP_HALTED;
Sarah Sharpb10de142009-04-27 19:58:50 -07001357 status = -EPIPE;
1358 break;
1359 case COMP_TRB_ERR:
1360 xhci_warn(xhci, "WARN: TRB error on endpoint\n");
1361 status = -EILSEQ;
1362 break;
Sarah Sharpec74e402009-11-11 10:28:36 -08001363 case COMP_SPLIT_ERR:
Sarah Sharpb10de142009-04-27 19:58:50 -07001364 case COMP_TX_ERR:
1365 xhci_warn(xhci, "WARN: transfer error on endpoint\n");
1366 status = -EPROTO;
1367 break;
Sarah Sharp4a731432009-07-27 12:04:32 -07001368 case COMP_BABBLE:
1369 xhci_warn(xhci, "WARN: babble error on endpoint\n");
1370 status = -EOVERFLOW;
1371 break;
Sarah Sharpb10de142009-04-27 19:58:50 -07001372 case COMP_DB_ERR:
1373 xhci_warn(xhci, "WARN: HC couldn't access mem fast enough\n");
1374 status = -ENOSR;
1375 break;
1376 default:
Sarah Sharpb45b5062009-12-09 15:59:06 -08001377 if (xhci_is_vendor_info_code(xhci, trb_comp_code)) {
Sarah Sharp5ad6a522009-11-11 10:28:40 -08001378 status = 0;
1379 break;
1380 }
Sarah Sharpb10de142009-04-27 19:58:50 -07001381 xhci_warn(xhci, "ERROR Unknown event condition, HC probably busted\n");
1382 urb = NULL;
1383 goto cleanup;
1384 }
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001385 /* Now update the urb's actual_length and give back to the core */
1386 /* Was this a control transfer? */
1387 if (usb_endpoint_xfer_control(&td->urb->ep->desc)) {
1388 xhci_debug_trb(xhci, xhci->event_ring->dequeue);
Sarah Sharp66d1eeb2009-08-27 14:35:53 -07001389 switch (trb_comp_code) {
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001390 case COMP_SUCCESS:
1391 if (event_trb == ep_ring->dequeue) {
1392 xhci_warn(xhci, "WARN: Success on ctrl setup TRB without IOC set??\n");
1393 status = -ESHUTDOWN;
1394 } else if (event_trb != td->last_trb) {
1395 xhci_warn(xhci, "WARN: Success on ctrl data TRB without IOC set??\n");
1396 status = -ESHUTDOWN;
1397 } else {
1398 xhci_dbg(xhci, "Successful control transfer!\n");
1399 status = 0;
1400 }
1401 break;
1402 case COMP_SHORT_TX:
1403 xhci_warn(xhci, "WARN: short transfer on control ep\n");
Sarah Sharp204970a2009-08-28 14:28:15 -07001404 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1405 status = -EREMOTEIO;
1406 else
1407 status = 0;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001408 break;
Sarah Sharpbcef3fd2009-11-11 10:28:44 -08001409
1410 default:
1411 if (!xhci_requires_manual_halt_cleanup(xhci,
1412 ep_ctx, trb_comp_code))
Sarah Sharp83fbcdc2009-08-27 14:36:03 -07001413 break;
Sarah Sharpbcef3fd2009-11-11 10:28:44 -08001414 xhci_dbg(xhci, "TRB error code %u, "
1415 "halted endpoint index = %u\n",
1416 trb_comp_code, ep_index);
Sarah Sharp83fbcdc2009-08-27 14:36:03 -07001417 /* else fall through */
Sarah Sharp82d10092009-08-07 14:04:52 -07001418 case COMP_STALL:
1419 /* Did we transfer part of the data (middle) phase? */
1420 if (event_trb != ep_ring->dequeue &&
1421 event_trb != td->last_trb)
1422 td->urb->actual_length =
1423 td->urb->transfer_buffer_length
1424 - TRB_LEN(event->transfer_len);
1425 else
1426 td->urb->actual_length = 0;
1427
Sarah Sharpbcef3fd2009-11-11 10:28:44 -08001428 xhci_cleanup_halted_endpoint(xhci,
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001429 slot_id, ep_index, 0, td, event_trb);
Sarah Sharp82d10092009-08-07 14:04:52 -07001430 goto td_cleanup;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001431 }
1432 /*
1433 * Did we transfer any data, despite the errors that might have
1434 * happened? I.e. did we get past the setup stage?
1435 */
1436 if (event_trb != ep_ring->dequeue) {
1437 /* The event was for the status stage */
1438 if (event_trb == td->last_trb) {
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001439 if (td->urb->actual_length != 0) {
1440 /* Don't overwrite a previously set error code */
Sarah Sharp204970a2009-08-28 14:28:15 -07001441 if ((status == -EINPROGRESS ||
1442 status == 0) &&
1443 (td->urb->transfer_flags
1444 & URB_SHORT_NOT_OK))
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001445 /* Did we already see a short data stage? */
1446 status = -EREMOTEIO;
1447 } else {
Sarah Sharp62889612009-07-27 12:03:36 -07001448 td->urb->actual_length =
1449 td->urb->transfer_buffer_length;
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001450 }
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001451 } else {
Sarah Sharpae636742009-04-29 19:02:31 -07001452 /* Maybe the event was for the data stage? */
Sarah Sharp66d1eeb2009-08-27 14:35:53 -07001453 if (trb_comp_code != COMP_STOP_INVAL) {
Sarah Sharpae636742009-04-29 19:02:31 -07001454 /* We didn't stop on a link TRB in the middle */
1455 td->urb->actual_length =
1456 td->urb->transfer_buffer_length -
1457 TRB_LEN(event->transfer_len);
Sarah Sharp62889612009-07-27 12:03:36 -07001458 xhci_dbg(xhci, "Waiting for status stage event\n");
1459 urb = NULL;
1460 goto cleanup;
1461 }
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001462 }
1463 }
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001464 } else {
Sarah Sharp66d1eeb2009-08-27 14:35:53 -07001465 switch (trb_comp_code) {
Sarah Sharpb10de142009-04-27 19:58:50 -07001466 case COMP_SUCCESS:
1467 /* Double check that the HW transferred everything. */
1468 if (event_trb != td->last_trb) {
1469 xhci_warn(xhci, "WARN Successful completion "
1470 "on short TX\n");
1471 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1472 status = -EREMOTEIO;
1473 else
1474 status = 0;
1475 } else {
Sarah Sharp624defa2009-09-02 12:14:28 -07001476 if (usb_endpoint_xfer_bulk(&td->urb->ep->desc))
1477 xhci_dbg(xhci, "Successful bulk "
1478 "transfer!\n");
1479 else
1480 xhci_dbg(xhci, "Successful interrupt "
1481 "transfer!\n");
Sarah Sharpb10de142009-04-27 19:58:50 -07001482 status = 0;
1483 }
1484 break;
1485 case COMP_SHORT_TX:
1486 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1487 status = -EREMOTEIO;
1488 else
1489 status = 0;
1490 break;
1491 default:
1492 /* Others already handled above */
1493 break;
1494 }
1495 dev_dbg(&td->urb->dev->dev,
1496 "ep %#x - asked for %d bytes, "
1497 "%d bytes untransferred\n",
1498 td->urb->ep->desc.bEndpointAddress,
1499 td->urb->transfer_buffer_length,
1500 TRB_LEN(event->transfer_len));
1501 /* Fast path - was this the last TRB in the TD for this URB? */
1502 if (event_trb == td->last_trb) {
1503 if (TRB_LEN(event->transfer_len) != 0) {
1504 td->urb->actual_length =
1505 td->urb->transfer_buffer_length -
1506 TRB_LEN(event->transfer_len);
Sarah Sharp99eb32d2009-08-27 14:36:24 -07001507 if (td->urb->transfer_buffer_length <
1508 td->urb->actual_length) {
Sarah Sharpb10de142009-04-27 19:58:50 -07001509 xhci_warn(xhci, "HC gave bad length "
1510 "of %d bytes left\n",
1511 TRB_LEN(event->transfer_len));
1512 td->urb->actual_length = 0;
Sarah Sharp2f697f62009-08-28 14:28:18 -07001513 if (td->urb->transfer_flags &
1514 URB_SHORT_NOT_OK)
1515 status = -EREMOTEIO;
1516 else
1517 status = 0;
Sarah Sharpb10de142009-04-27 19:58:50 -07001518 }
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001519 /* Don't overwrite a previously set error code */
1520 if (status == -EINPROGRESS) {
1521 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1522 status = -EREMOTEIO;
1523 else
1524 status = 0;
1525 }
Sarah Sharpb10de142009-04-27 19:58:50 -07001526 } else {
1527 td->urb->actual_length = td->urb->transfer_buffer_length;
1528 /* Ignore a short packet completion if the
1529 * untransferred length was zero.
1530 */
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001531 if (status == -EREMOTEIO)
1532 status = 0;
Sarah Sharpb10de142009-04-27 19:58:50 -07001533 }
1534 } else {
Sarah Sharpae636742009-04-29 19:02:31 -07001535 /* Slow path - walk the list, starting from the dequeue
1536 * pointer, to get the actual length transferred.
Sarah Sharpb10de142009-04-27 19:58:50 -07001537 */
Sarah Sharpae636742009-04-29 19:02:31 -07001538 union xhci_trb *cur_trb;
1539 struct xhci_segment *cur_seg;
Sarah Sharpb10de142009-04-27 19:58:50 -07001540
Sarah Sharpae636742009-04-29 19:02:31 -07001541 td->urb->actual_length = 0;
1542 for (cur_trb = ep_ring->dequeue, cur_seg = ep_ring->deq_seg;
1543 cur_trb != event_trb;
1544 next_trb(xhci, ep_ring, &cur_seg, &cur_trb)) {
Andiry Xu54b5acf2010-05-10 19:57:17 -07001545 if ((cur_trb->generic.field[3] &
1546 TRB_TYPE_BITMASK) != TRB_TYPE(TRB_TR_NOOP) &&
1547 (cur_trb->generic.field[3] &
1548 TRB_TYPE_BITMASK) != TRB_TYPE(TRB_LINK))
Sarah Sharpae636742009-04-29 19:02:31 -07001549 td->urb->actual_length +=
1550 TRB_LEN(cur_trb->generic.field[2]);
1551 }
1552 /* If the ring didn't stop on a Link or No-op TRB, add
1553 * in the actual bytes transferred from the Normal TRB
1554 */
Sarah Sharp66d1eeb2009-08-27 14:35:53 -07001555 if (trb_comp_code != COMP_STOP_INVAL)
Sarah Sharpae636742009-04-29 19:02:31 -07001556 td->urb->actual_length +=
1557 TRB_LEN(cur_trb->generic.field[2]) -
1558 TRB_LEN(event->transfer_len);
Sarah Sharpb10de142009-04-27 19:58:50 -07001559 }
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001560 }
Sarah Sharp66d1eeb2009-08-27 14:35:53 -07001561 if (trb_comp_code == COMP_STOP_INVAL ||
1562 trb_comp_code == COMP_STOP) {
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001563 /* The Endpoint Stop Command completion will take care of any
1564 * stopped TDs. A stopped TD may be restarted, so don't update
1565 * the ring dequeue pointer or take this TD off any lists yet.
1566 */
Sarah Sharp63a0d9a2009-09-04 10:53:09 -07001567 ep->stopped_td = td;
1568 ep->stopped_trb = event_trb;
Sarah Sharpae636742009-04-29 19:02:31 -07001569 } else {
Sarah Sharpbcef3fd2009-11-11 10:28:44 -08001570 if (trb_comp_code == COMP_STALL) {
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001571 /* The transfer is completed from the driver's
1572 * perspective, but we need to issue a set dequeue
1573 * command for this stalled endpoint to move the dequeue
1574 * pointer past the TD. We can't do that here because
Sarah Sharpbcef3fd2009-11-11 10:28:44 -08001575 * the halt condition must be cleared first. Let the
1576 * USB class driver clear the stall later.
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001577 */
Sarah Sharp63a0d9a2009-09-04 10:53:09 -07001578 ep->stopped_td = td;
1579 ep->stopped_trb = event_trb;
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001580 ep->stopped_stream = ep_ring->stream_id;
Sarah Sharpbcef3fd2009-11-11 10:28:44 -08001581 } else if (xhci_requires_manual_halt_cleanup(xhci,
1582 ep_ctx, trb_comp_code)) {
1583 /* Other types of errors halt the endpoint, but the
1584 * class driver doesn't call usb_reset_endpoint() unless
1585 * the error is -EPIPE. Clear the halted status in the
1586 * xHCI hardware manually.
1587 */
1588 xhci_cleanup_halted_endpoint(xhci,
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001589 slot_id, ep_index, ep_ring->stream_id, td, event_trb);
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001590 } else {
1591 /* Update ring dequeue pointer */
1592 while (ep_ring->dequeue != td->last_trb)
1593 inc_deq(xhci, ep_ring, false);
Sarah Sharpae636742009-04-29 19:02:31 -07001594 inc_deq(xhci, ep_ring, false);
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001595 }
Sarah Sharpb10de142009-04-27 19:58:50 -07001596
Sarah Sharp82d10092009-08-07 14:04:52 -07001597td_cleanup:
Sarah Sharpae636742009-04-29 19:02:31 -07001598 /* Clean up the endpoint's TD list */
1599 urb = td->urb;
Sarah Sharp99eb32d2009-08-27 14:36:24 -07001600 /* Do one last check of the actual transfer length.
1601 * If the host controller said we transferred more data than
1602 * the buffer length, urb->actual_length will be a very big
1603 * number (since it's unsigned). Play it safe and say we didn't
1604 * transfer anything.
1605 */
1606 if (urb->actual_length > urb->transfer_buffer_length) {
1607 xhci_warn(xhci, "URB transfer length is wrong, "
1608 "xHC issue? req. len = %u, "
1609 "act. len = %u\n",
1610 urb->transfer_buffer_length,
1611 urb->actual_length);
1612 urb->actual_length = 0;
Sarah Sharp2f697f62009-08-28 14:28:18 -07001613 if (td->urb->transfer_flags & URB_SHORT_NOT_OK)
1614 status = -EREMOTEIO;
1615 else
1616 status = 0;
Sarah Sharp99eb32d2009-08-27 14:36:24 -07001617 }
Sarah Sharpae636742009-04-29 19:02:31 -07001618 list_del(&td->td_list);
1619 /* Was this TD slated to be cancelled but completed anyway? */
Sarah Sharp678539c2009-10-27 10:55:52 -07001620 if (!list_empty(&td->cancelled_td_list))
Sarah Sharpae636742009-04-29 19:02:31 -07001621 list_del(&td->cancelled_td_list);
Sarah Sharp678539c2009-10-27 10:55:52 -07001622
Sarah Sharp82d10092009-08-07 14:04:52 -07001623 /* Leave the TD around for the reset endpoint function to use
1624 * (but only if it's not a control endpoint, since we already
1625 * queued the Set TR dequeue pointer command for stalled
1626 * control endpoints).
1627 */
1628 if (usb_endpoint_xfer_control(&urb->ep->desc) ||
Sarah Sharp83fbcdc2009-08-27 14:36:03 -07001629 (trb_comp_code != COMP_STALL &&
1630 trb_comp_code != COMP_BABBLE)) {
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001631 kfree(td);
1632 }
Sarah Sharpae636742009-04-29 19:02:31 -07001633 urb->hcpriv = NULL;
1634 }
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001635cleanup:
1636 inc_deq(xhci, xhci->event_ring, true);
Sarah Sharp23e3be12009-04-29 19:05:20 -07001637 xhci_set_hc_event_deq(xhci);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001638
Sarah Sharpb10de142009-04-27 19:58:50 -07001639 /* FIXME for multi-TD URBs (who have buffers bigger than 64MB) */
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001640 if (urb) {
1641 usb_hcd_unlink_urb_from_ep(xhci_to_hcd(xhci), urb);
Sarah Sharp66e49d82009-07-27 12:03:46 -07001642 xhci_dbg(xhci, "Giveback URB %p, len = %d, status = %d\n",
Sarah Sharp9191eee2009-08-27 14:36:14 -07001643 urb, urb->actual_length, status);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001644 spin_unlock(&xhci->lock);
1645 usb_hcd_giveback_urb(xhci_to_hcd(xhci), urb, status);
1646 spin_lock(&xhci->lock);
1647 }
1648 return 0;
1649}
1650
1651/*
Sarah Sharp0f2a7932009-04-27 19:57:12 -07001652 * This function handles all OS-owned events on the event ring. It may drop
1653 * xhci->lock between event processing (e.g. to pass up port status changes).
1654 */
Stephen Rothwellb7258a42009-04-29 19:02:47 -07001655void xhci_handle_event(struct xhci_hcd *xhci)
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001656{
1657 union xhci_trb *event;
Sarah Sharp0f2a7932009-04-27 19:57:12 -07001658 int update_ptrs = 1;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001659 int ret;
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001660
Sarah Sharp66e49d82009-07-27 12:03:46 -07001661 xhci_dbg(xhci, "In %s\n", __func__);
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001662 if (!xhci->event_ring || !xhci->event_ring->dequeue) {
1663 xhci->error_bitmask |= 1 << 1;
1664 return;
1665 }
1666
1667 event = xhci->event_ring->dequeue;
1668 /* Does the HC or OS own the TRB? */
1669 if ((event->event_cmd.flags & TRB_CYCLE) !=
1670 xhci->event_ring->cycle_state) {
1671 xhci->error_bitmask |= 1 << 2;
1672 return;
1673 }
Sarah Sharp66e49d82009-07-27 12:03:46 -07001674 xhci_dbg(xhci, "%s - OS owns TRB\n", __func__);
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001675
Sarah Sharp0f2a7932009-04-27 19:57:12 -07001676 /* FIXME: Handle more event types. */
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001677 switch ((event->event_cmd.flags & TRB_TYPE_BITMASK)) {
1678 case TRB_TYPE(TRB_COMPLETION):
Sarah Sharp66e49d82009-07-27 12:03:46 -07001679 xhci_dbg(xhci, "%s - calling handle_cmd_completion\n", __func__);
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001680 handle_cmd_completion(xhci, &event->event_cmd);
Sarah Sharp66e49d82009-07-27 12:03:46 -07001681 xhci_dbg(xhci, "%s - returned from handle_cmd_completion\n", __func__);
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001682 break;
Sarah Sharp0f2a7932009-04-27 19:57:12 -07001683 case TRB_TYPE(TRB_PORT_STATUS):
Sarah Sharp66e49d82009-07-27 12:03:46 -07001684 xhci_dbg(xhci, "%s - calling handle_port_status\n", __func__);
Sarah Sharp0f2a7932009-04-27 19:57:12 -07001685 handle_port_status(xhci, event);
Sarah Sharp66e49d82009-07-27 12:03:46 -07001686 xhci_dbg(xhci, "%s - returned from handle_port_status\n", __func__);
Sarah Sharp0f2a7932009-04-27 19:57:12 -07001687 update_ptrs = 0;
1688 break;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001689 case TRB_TYPE(TRB_TRANSFER):
Sarah Sharp66e49d82009-07-27 12:03:46 -07001690 xhci_dbg(xhci, "%s - calling handle_tx_event\n", __func__);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001691 ret = handle_tx_event(xhci, &event->trans_event);
Sarah Sharp66e49d82009-07-27 12:03:46 -07001692 xhci_dbg(xhci, "%s - returned from handle_tx_event\n", __func__);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001693 if (ret < 0)
1694 xhci->error_bitmask |= 1 << 9;
1695 else
1696 update_ptrs = 0;
1697 break;
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001698 default:
Sarah Sharp02386342010-05-24 13:25:28 -07001699 if ((event->event_cmd.flags & TRB_TYPE_BITMASK) >= TRB_TYPE(48))
1700 handle_vendor_event(xhci, event);
1701 else
1702 xhci->error_bitmask |= 1 << 3;
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001703 }
Sarah Sharp6f5165c2009-10-27 10:57:01 -07001704 /* Any of the above functions may drop and re-acquire the lock, so check
1705 * to make sure a watchdog timer didn't mark the host as non-responsive.
1706 */
1707 if (xhci->xhc_state & XHCI_STATE_DYING) {
1708 xhci_dbg(xhci, "xHCI host dying, returning from "
1709 "event handler.\n");
1710 return;
1711 }
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001712
Sarah Sharp0f2a7932009-04-27 19:57:12 -07001713 if (update_ptrs) {
1714 /* Update SW and HC event ring dequeue pointer */
1715 inc_deq(xhci, xhci->event_ring, true);
Sarah Sharp23e3be12009-04-29 19:05:20 -07001716 xhci_set_hc_event_deq(xhci);
Sarah Sharp0f2a7932009-04-27 19:57:12 -07001717 }
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001718 /* Are there more items on the event ring? */
Stephen Rothwellb7258a42009-04-29 19:02:47 -07001719 xhci_handle_event(xhci);
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001720}
1721
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001722/**** Endpoint Ring Operations ****/
1723
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001724/*
1725 * Generic function for queueing a TRB on a ring.
1726 * The caller must have checked to make sure there's room on the ring.
Sarah Sharp6cc30d82010-06-10 12:25:28 -07001727 *
1728 * @more_trbs_coming: Will you enqueue more TRBs before calling
1729 * prepare_transfer()?
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001730 */
1731static void queue_trb(struct xhci_hcd *xhci, struct xhci_ring *ring,
Sarah Sharp6cc30d82010-06-10 12:25:28 -07001732 bool consumer, bool more_trbs_coming,
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001733 u32 field1, u32 field2, u32 field3, u32 field4)
1734{
1735 struct xhci_generic_trb *trb;
1736
1737 trb = &ring->enqueue->generic;
1738 trb->field[0] = field1;
1739 trb->field[1] = field2;
1740 trb->field[2] = field3;
1741 trb->field[3] = field4;
Sarah Sharp6cc30d82010-06-10 12:25:28 -07001742 inc_enq(xhci, ring, consumer, more_trbs_coming);
Sarah Sharp7f84eef2009-04-27 19:53:56 -07001743}
1744
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001745/*
1746 * Does various checks on the endpoint ring, and makes it ready to queue num_trbs.
1747 * FIXME allocate segments if the ring is full.
1748 */
1749static int prepare_ring(struct xhci_hcd *xhci, struct xhci_ring *ep_ring,
1750 u32 ep_state, unsigned int num_trbs, gfp_t mem_flags)
1751{
1752 /* Make sure the endpoint has been added to xHC schedule */
1753 xhci_dbg(xhci, "Endpoint state = 0x%x\n", ep_state);
1754 switch (ep_state) {
1755 case EP_STATE_DISABLED:
1756 /*
1757 * USB core changed config/interfaces without notifying us,
1758 * or hardware is reporting the wrong state.
1759 */
1760 xhci_warn(xhci, "WARN urb submitted to disabled ep\n");
1761 return -ENOENT;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001762 case EP_STATE_ERROR:
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001763 xhci_warn(xhci, "WARN waiting for error on ep to be cleared\n");
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001764 /* FIXME event handling code for error needs to clear it */
1765 /* XXX not sure if this should be -ENOENT or not */
1766 return -EINVAL;
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07001767 case EP_STATE_HALTED:
1768 xhci_dbg(xhci, "WARN halted endpoint, queueing URB anyway.\n");
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001769 case EP_STATE_STOPPED:
1770 case EP_STATE_RUNNING:
1771 break;
1772 default:
1773 xhci_err(xhci, "ERROR unknown endpoint state for ep\n");
1774 /*
1775 * FIXME issue Configure Endpoint command to try to get the HC
1776 * back into a known state.
1777 */
1778 return -EINVAL;
1779 }
1780 if (!room_on_ring(xhci, ep_ring, num_trbs)) {
1781 /* FIXME allocate more room */
1782 xhci_err(xhci, "ERROR no room on ep ring\n");
1783 return -ENOMEM;
1784 }
John Youn6c12db92010-05-10 15:33:00 -07001785
1786 if (enqueue_is_link_trb(ep_ring)) {
1787 struct xhci_ring *ring = ep_ring;
1788 union xhci_trb *next;
John Youn6c12db92010-05-10 15:33:00 -07001789
1790 xhci_dbg(xhci, "prepare_ring: pointing to link trb\n");
1791 next = ring->enqueue;
1792
1793 while (last_trb(xhci, ring, ring->enq_seg, next)) {
1794
1795 /* If we're not dealing with 0.95 hardware,
1796 * clear the chain bit.
1797 */
1798 if (!xhci_link_trb_quirk(xhci))
1799 next->link.control &= ~TRB_CHAIN;
1800 else
1801 next->link.control |= TRB_CHAIN;
1802
1803 wmb();
1804 next->link.control ^= (u32) TRB_CYCLE;
1805
1806 /* Toggle the cycle bit after the last ring segment. */
1807 if (last_trb_on_last_seg(xhci, ring, ring->enq_seg, next)) {
1808 ring->cycle_state = (ring->cycle_state ? 0 : 1);
1809 if (!in_interrupt()) {
1810 xhci_dbg(xhci, "queue_trb: Toggle cycle "
1811 "state for ring %p = %i\n",
1812 ring, (unsigned int)ring->cycle_state);
1813 }
1814 }
1815 ring->enq_seg = ring->enq_seg->next;
1816 ring->enqueue = ring->enq_seg->trbs;
1817 next = ring->enqueue;
1818 }
1819 }
1820
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001821 return 0;
1822}
1823
Sarah Sharp23e3be12009-04-29 19:05:20 -07001824static int prepare_transfer(struct xhci_hcd *xhci,
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001825 struct xhci_virt_device *xdev,
1826 unsigned int ep_index,
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001827 unsigned int stream_id,
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001828 unsigned int num_trbs,
1829 struct urb *urb,
1830 struct xhci_td **td,
1831 gfp_t mem_flags)
1832{
1833 int ret;
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001834 struct xhci_ring *ep_ring;
John Yound115b042009-07-27 12:05:15 -07001835 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci, xdev->out_ctx, ep_index);
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001836
1837 ep_ring = xhci_stream_id_to_ring(xdev, ep_index, stream_id);
1838 if (!ep_ring) {
1839 xhci_dbg(xhci, "Can't prepare ring for bad stream ID %u\n",
1840 stream_id);
1841 return -EINVAL;
1842 }
1843
1844 ret = prepare_ring(xhci, ep_ring,
John Yound115b042009-07-27 12:05:15 -07001845 ep_ctx->ep_info & EP_STATE_MASK,
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001846 num_trbs, mem_flags);
1847 if (ret)
1848 return ret;
1849 *td = kzalloc(sizeof(struct xhci_td), mem_flags);
1850 if (!*td)
1851 return -ENOMEM;
1852 INIT_LIST_HEAD(&(*td)->td_list);
Sarah Sharpae636742009-04-29 19:02:31 -07001853 INIT_LIST_HEAD(&(*td)->cancelled_td_list);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001854
1855 ret = usb_hcd_link_urb_to_ep(xhci_to_hcd(xhci), urb);
1856 if (unlikely(ret)) {
1857 kfree(*td);
1858 return ret;
1859 }
1860
1861 (*td)->urb = urb;
1862 urb->hcpriv = (void *) (*td);
1863 /* Add this TD to the tail of the endpoint ring's TD list */
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001864 list_add_tail(&(*td)->td_list, &ep_ring->td_list);
1865 (*td)->start_seg = ep_ring->enq_seg;
1866 (*td)->first_trb = ep_ring->enqueue;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07001867
1868 return 0;
1869}
1870
Sarah Sharp23e3be12009-04-29 19:05:20 -07001871static unsigned int count_sg_trbs_needed(struct xhci_hcd *xhci, struct urb *urb)
Sarah Sharp8a96c052009-04-27 19:59:19 -07001872{
1873 int num_sgs, num_trbs, running_total, temp, i;
1874 struct scatterlist *sg;
1875
1876 sg = NULL;
1877 num_sgs = urb->num_sgs;
1878 temp = urb->transfer_buffer_length;
1879
1880 xhci_dbg(xhci, "count sg list trbs: \n");
1881 num_trbs = 0;
Matthew Wilcox910f8d02010-05-01 12:20:01 -06001882 for_each_sg(urb->sg, sg, num_sgs, i) {
Sarah Sharp8a96c052009-04-27 19:59:19 -07001883 unsigned int previous_total_trbs = num_trbs;
1884 unsigned int len = sg_dma_len(sg);
1885
1886 /* Scatter gather list entries may cross 64KB boundaries */
1887 running_total = TRB_MAX_BUFF_SIZE -
1888 (sg_dma_address(sg) & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
1889 if (running_total != 0)
1890 num_trbs++;
1891
1892 /* How many more 64KB chunks to transfer, how many more TRBs? */
1893 while (running_total < sg_dma_len(sg)) {
1894 num_trbs++;
1895 running_total += TRB_MAX_BUFF_SIZE;
1896 }
Greg Kroah-Hartman700e2052009-04-29 19:14:08 -07001897 xhci_dbg(xhci, " sg #%d: dma = %#llx, len = %#x (%d), num_trbs = %d\n",
1898 i, (unsigned long long)sg_dma_address(sg),
1899 len, len, num_trbs - previous_total_trbs);
Sarah Sharp8a96c052009-04-27 19:59:19 -07001900
1901 len = min_t(int, len, temp);
1902 temp -= len;
1903 if (temp == 0)
1904 break;
1905 }
1906 xhci_dbg(xhci, "\n");
1907 if (!in_interrupt())
1908 dev_dbg(&urb->dev->dev, "ep %#x - urb len = %d, sglist used, num_trbs = %d\n",
1909 urb->ep->desc.bEndpointAddress,
1910 urb->transfer_buffer_length,
1911 num_trbs);
1912 return num_trbs;
1913}
1914
Sarah Sharp23e3be12009-04-29 19:05:20 -07001915static void check_trb_math(struct urb *urb, int num_trbs, int running_total)
Sarah Sharp8a96c052009-04-27 19:59:19 -07001916{
1917 if (num_trbs != 0)
1918 dev_dbg(&urb->dev->dev, "%s - ep %#x - Miscalculated number of "
1919 "TRBs, %d left\n", __func__,
1920 urb->ep->desc.bEndpointAddress, num_trbs);
1921 if (running_total != urb->transfer_buffer_length)
1922 dev_dbg(&urb->dev->dev, "%s - ep %#x - Miscalculated tx length, "
1923 "queued %#x (%d), asked for %#x (%d)\n",
1924 __func__,
1925 urb->ep->desc.bEndpointAddress,
1926 running_total, running_total,
1927 urb->transfer_buffer_length,
1928 urb->transfer_buffer_length);
1929}
1930
Sarah Sharp23e3be12009-04-29 19:05:20 -07001931static void giveback_first_trb(struct xhci_hcd *xhci, int slot_id,
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001932 unsigned int ep_index, unsigned int stream_id, int start_cycle,
Sarah Sharp8a96c052009-04-27 19:59:19 -07001933 struct xhci_generic_trb *start_trb, struct xhci_td *td)
1934{
Sarah Sharp8a96c052009-04-27 19:59:19 -07001935 /*
1936 * Pass all the TRBs to the hardware at once and make sure this write
1937 * isn't reordered.
1938 */
1939 wmb();
1940 start_trb->field[3] |= start_cycle;
Sarah Sharpe9df17e2010-04-02 15:34:43 -07001941 ring_ep_doorbell(xhci, slot_id, ep_index, stream_id);
Sarah Sharp8a96c052009-04-27 19:59:19 -07001942}
1943
Sarah Sharp624defa2009-09-02 12:14:28 -07001944/*
1945 * xHCI uses normal TRBs for both bulk and interrupt. When the interrupt
1946 * endpoint is to be serviced, the xHC will consume (at most) one TD. A TD
1947 * (comprised of sg list entries) can take several service intervals to
1948 * transmit.
1949 */
1950int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
1951 struct urb *urb, int slot_id, unsigned int ep_index)
1952{
1953 struct xhci_ep_ctx *ep_ctx = xhci_get_ep_ctx(xhci,
1954 xhci->devs[slot_id]->out_ctx, ep_index);
1955 int xhci_interval;
1956 int ep_interval;
1957
1958 xhci_interval = EP_INTERVAL_TO_UFRAMES(ep_ctx->ep_info);
1959 ep_interval = urb->interval;
1960 /* Convert to microframes */
1961 if (urb->dev->speed == USB_SPEED_LOW ||
1962 urb->dev->speed == USB_SPEED_FULL)
1963 ep_interval *= 8;
1964 /* FIXME change this to a warning and a suggestion to use the new API
1965 * to set the polling interval (once the API is added).
1966 */
1967 if (xhci_interval != ep_interval) {
1968 if (!printk_ratelimit())
1969 dev_dbg(&urb->dev->dev, "Driver uses different interval"
1970 " (%d microframe%s) than xHCI "
1971 "(%d microframe%s)\n",
1972 ep_interval,
1973 ep_interval == 1 ? "" : "s",
1974 xhci_interval,
1975 xhci_interval == 1 ? "" : "s");
1976 urb->interval = xhci_interval;
1977 /* Convert back to frames for LS/FS devices */
1978 if (urb->dev->speed == USB_SPEED_LOW ||
1979 urb->dev->speed == USB_SPEED_FULL)
1980 urb->interval /= 8;
1981 }
1982 return xhci_queue_bulk_tx(xhci, GFP_ATOMIC, urb, slot_id, ep_index);
1983}
1984
Sarah Sharp04dd9502009-11-11 10:28:30 -08001985/*
1986 * The TD size is the number of bytes remaining in the TD (including this TRB),
1987 * right shifted by 10.
1988 * It must fit in bits 21:17, so it can't be bigger than 31.
1989 */
1990static u32 xhci_td_remainder(unsigned int remainder)
1991{
1992 u32 max = (1 << (21 - 17 + 1)) - 1;
1993
1994 if ((remainder >> 10) >= max)
1995 return max << 17;
1996 else
1997 return (remainder >> 10) << 17;
1998}
1999
Sarah Sharp23e3be12009-04-29 19:05:20 -07002000static int queue_bulk_sg_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
Sarah Sharp8a96c052009-04-27 19:59:19 -07002001 struct urb *urb, int slot_id, unsigned int ep_index)
2002{
2003 struct xhci_ring *ep_ring;
2004 unsigned int num_trbs;
2005 struct xhci_td *td;
2006 struct scatterlist *sg;
2007 int num_sgs;
2008 int trb_buff_len, this_sg_len, running_total;
2009 bool first_trb;
2010 u64 addr;
Sarah Sharp6cc30d82010-06-10 12:25:28 -07002011 bool more_trbs_coming;
Sarah Sharp8a96c052009-04-27 19:59:19 -07002012
2013 struct xhci_generic_trb *start_trb;
2014 int start_cycle;
2015
Sarah Sharpe9df17e2010-04-02 15:34:43 -07002016 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
2017 if (!ep_ring)
2018 return -EINVAL;
2019
Sarah Sharp8a96c052009-04-27 19:59:19 -07002020 num_trbs = count_sg_trbs_needed(xhci, urb);
2021 num_sgs = urb->num_sgs;
2022
Sarah Sharp23e3be12009-04-29 19:05:20 -07002023 trb_buff_len = prepare_transfer(xhci, xhci->devs[slot_id],
Sarah Sharpe9df17e2010-04-02 15:34:43 -07002024 ep_index, urb->stream_id,
2025 num_trbs, urb, &td, mem_flags);
Sarah Sharp8a96c052009-04-27 19:59:19 -07002026 if (trb_buff_len < 0)
2027 return trb_buff_len;
2028 /*
2029 * Don't give the first TRB to the hardware (by toggling the cycle bit)
2030 * until we've finished creating all the other TRBs. The ring's cycle
2031 * state may change as we enqueue the other TRBs, so save it too.
2032 */
2033 start_trb = &ep_ring->enqueue->generic;
2034 start_cycle = ep_ring->cycle_state;
2035
2036 running_total = 0;
2037 /*
2038 * How much data is in the first TRB?
2039 *
2040 * There are three forces at work for TRB buffer pointers and lengths:
2041 * 1. We don't want to walk off the end of this sg-list entry buffer.
2042 * 2. The transfer length that the driver requested may be smaller than
2043 * the amount of memory allocated for this scatter-gather list.
2044 * 3. TRBs buffers can't cross 64KB boundaries.
2045 */
Matthew Wilcox910f8d02010-05-01 12:20:01 -06002046 sg = urb->sg;
Sarah Sharp8a96c052009-04-27 19:59:19 -07002047 addr = (u64) sg_dma_address(sg);
2048 this_sg_len = sg_dma_len(sg);
2049 trb_buff_len = TRB_MAX_BUFF_SIZE -
2050 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
2051 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
2052 if (trb_buff_len > urb->transfer_buffer_length)
2053 trb_buff_len = urb->transfer_buffer_length;
2054 xhci_dbg(xhci, "First length to xfer from 1st sglist entry = %u\n",
2055 trb_buff_len);
2056
2057 first_trb = true;
2058 /* Queue the first TRB, even if it's zero-length */
2059 do {
2060 u32 field = 0;
Sarah Sharpf9dc68f2009-07-27 12:03:07 -07002061 u32 length_field = 0;
Sarah Sharp04dd9502009-11-11 10:28:30 -08002062 u32 remainder = 0;
Sarah Sharp8a96c052009-04-27 19:59:19 -07002063
2064 /* Don't change the cycle bit of the first TRB until later */
2065 if (first_trb)
2066 first_trb = false;
2067 else
2068 field |= ep_ring->cycle_state;
2069
2070 /* Chain all the TRBs together; clear the chain bit in the last
2071 * TRB to indicate it's the last TRB in the chain.
2072 */
2073 if (num_trbs > 1) {
2074 field |= TRB_CHAIN;
2075 } else {
2076 /* FIXME - add check for ZERO_PACKET flag before this */
2077 td->last_trb = ep_ring->enqueue;
2078 field |= TRB_IOC;
2079 }
2080 xhci_dbg(xhci, " sg entry: dma = %#x, len = %#x (%d), "
2081 "64KB boundary at %#x, end dma = %#x\n",
2082 (unsigned int) addr, trb_buff_len, trb_buff_len,
2083 (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
2084 (unsigned int) addr + trb_buff_len);
2085 if (TRB_MAX_BUFF_SIZE -
2086 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1)) < trb_buff_len) {
2087 xhci_warn(xhci, "WARN: sg dma xfer crosses 64KB boundaries!\n");
2088 xhci_dbg(xhci, "Next boundary at %#x, end dma = %#x\n",
2089 (unsigned int) (addr + TRB_MAX_BUFF_SIZE) & ~(TRB_MAX_BUFF_SIZE - 1),
2090 (unsigned int) addr + trb_buff_len);
2091 }
Sarah Sharp04dd9502009-11-11 10:28:30 -08002092 remainder = xhci_td_remainder(urb->transfer_buffer_length -
2093 running_total) ;
Sarah Sharpf9dc68f2009-07-27 12:03:07 -07002094 length_field = TRB_LEN(trb_buff_len) |
Sarah Sharp04dd9502009-11-11 10:28:30 -08002095 remainder |
Sarah Sharpf9dc68f2009-07-27 12:03:07 -07002096 TRB_INTR_TARGET(0);
Sarah Sharp6cc30d82010-06-10 12:25:28 -07002097 if (num_trbs > 1)
2098 more_trbs_coming = true;
2099 else
2100 more_trbs_coming = false;
2101 queue_trb(xhci, ep_ring, false, more_trbs_coming,
Sarah Sharp8e595a52009-07-27 12:03:31 -07002102 lower_32_bits(addr),
2103 upper_32_bits(addr),
Sarah Sharpf9dc68f2009-07-27 12:03:07 -07002104 length_field,
Sarah Sharp8a96c052009-04-27 19:59:19 -07002105 /* We always want to know if the TRB was short,
2106 * or we won't get an event when it completes.
2107 * (Unless we use event data TRBs, which are a
2108 * waste of space and HC resources.)
2109 */
2110 field | TRB_ISP | TRB_TYPE(TRB_NORMAL));
2111 --num_trbs;
2112 running_total += trb_buff_len;
2113
2114 /* Calculate length for next transfer --
2115 * Are we done queueing all the TRBs for this sg entry?
2116 */
2117 this_sg_len -= trb_buff_len;
2118 if (this_sg_len == 0) {
2119 --num_sgs;
2120 if (num_sgs == 0)
2121 break;
2122 sg = sg_next(sg);
2123 addr = (u64) sg_dma_address(sg);
2124 this_sg_len = sg_dma_len(sg);
2125 } else {
2126 addr += trb_buff_len;
2127 }
2128
2129 trb_buff_len = TRB_MAX_BUFF_SIZE -
2130 (addr & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
2131 trb_buff_len = min_t(int, trb_buff_len, this_sg_len);
2132 if (running_total + trb_buff_len > urb->transfer_buffer_length)
2133 trb_buff_len =
2134 urb->transfer_buffer_length - running_total;
2135 } while (running_total < urb->transfer_buffer_length);
2136
2137 check_trb_math(urb, num_trbs, running_total);
Sarah Sharpe9df17e2010-04-02 15:34:43 -07002138 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
2139 start_cycle, start_trb, td);
Sarah Sharp8a96c052009-04-27 19:59:19 -07002140 return 0;
2141}
2142
Sarah Sharpb10de142009-04-27 19:58:50 -07002143/* This is very similar to what ehci-q.c qtd_fill() does */
Sarah Sharp23e3be12009-04-29 19:05:20 -07002144int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
Sarah Sharpb10de142009-04-27 19:58:50 -07002145 struct urb *urb, int slot_id, unsigned int ep_index)
2146{
2147 struct xhci_ring *ep_ring;
2148 struct xhci_td *td;
2149 int num_trbs;
2150 struct xhci_generic_trb *start_trb;
2151 bool first_trb;
Sarah Sharp6cc30d82010-06-10 12:25:28 -07002152 bool more_trbs_coming;
Sarah Sharpb10de142009-04-27 19:58:50 -07002153 int start_cycle;
Sarah Sharpf9dc68f2009-07-27 12:03:07 -07002154 u32 field, length_field;
Sarah Sharpb10de142009-04-27 19:58:50 -07002155
2156 int running_total, trb_buff_len, ret;
2157 u64 addr;
2158
Alan Sternff9c8952010-04-02 13:27:28 -04002159 if (urb->num_sgs)
Sarah Sharp8a96c052009-04-27 19:59:19 -07002160 return queue_bulk_sg_tx(xhci, mem_flags, urb, slot_id, ep_index);
2161
Sarah Sharpe9df17e2010-04-02 15:34:43 -07002162 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
2163 if (!ep_ring)
2164 return -EINVAL;
Sarah Sharpb10de142009-04-27 19:58:50 -07002165
2166 num_trbs = 0;
2167 /* How much data is (potentially) left before the 64KB boundary? */
2168 running_total = TRB_MAX_BUFF_SIZE -
2169 (urb->transfer_dma & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
2170
2171 /* If there's some data on this 64KB chunk, or we have to send a
2172 * zero-length transfer, we need at least one TRB
2173 */
2174 if (running_total != 0 || urb->transfer_buffer_length == 0)
2175 num_trbs++;
2176 /* How many more 64KB chunks to transfer, how many more TRBs? */
2177 while (running_total < urb->transfer_buffer_length) {
2178 num_trbs++;
2179 running_total += TRB_MAX_BUFF_SIZE;
2180 }
2181 /* FIXME: this doesn't deal with URB_ZERO_PACKET - need one more */
2182
2183 if (!in_interrupt())
Greg Kroah-Hartman700e2052009-04-29 19:14:08 -07002184 dev_dbg(&urb->dev->dev, "ep %#x - urb len = %#x (%d), addr = %#llx, num_trbs = %d\n",
Sarah Sharpb10de142009-04-27 19:58:50 -07002185 urb->ep->desc.bEndpointAddress,
Sarah Sharp8a96c052009-04-27 19:59:19 -07002186 urb->transfer_buffer_length,
2187 urb->transfer_buffer_length,
Greg Kroah-Hartman700e2052009-04-29 19:14:08 -07002188 (unsigned long long)urb->transfer_dma,
Sarah Sharpb10de142009-04-27 19:58:50 -07002189 num_trbs);
Sarah Sharp8a96c052009-04-27 19:59:19 -07002190
Sarah Sharpe9df17e2010-04-02 15:34:43 -07002191 ret = prepare_transfer(xhci, xhci->devs[slot_id],
2192 ep_index, urb->stream_id,
Sarah Sharpb10de142009-04-27 19:58:50 -07002193 num_trbs, urb, &td, mem_flags);
2194 if (ret < 0)
2195 return ret;
2196
2197 /*
2198 * Don't give the first TRB to the hardware (by toggling the cycle bit)
2199 * until we've finished creating all the other TRBs. The ring's cycle
2200 * state may change as we enqueue the other TRBs, so save it too.
2201 */
2202 start_trb = &ep_ring->enqueue->generic;
2203 start_cycle = ep_ring->cycle_state;
2204
2205 running_total = 0;
2206 /* How much data is in the first TRB? */
2207 addr = (u64) urb->transfer_dma;
2208 trb_buff_len = TRB_MAX_BUFF_SIZE -
2209 (urb->transfer_dma & ((1 << TRB_MAX_BUFF_SHIFT) - 1));
2210 if (urb->transfer_buffer_length < trb_buff_len)
2211 trb_buff_len = urb->transfer_buffer_length;
2212
2213 first_trb = true;
2214
2215 /* Queue the first TRB, even if it's zero-length */
2216 do {
Sarah Sharp04dd9502009-11-11 10:28:30 -08002217 u32 remainder = 0;
Sarah Sharpb10de142009-04-27 19:58:50 -07002218 field = 0;
2219
2220 /* Don't change the cycle bit of the first TRB until later */
2221 if (first_trb)
2222 first_trb = false;
2223 else
2224 field |= ep_ring->cycle_state;
2225
2226 /* Chain all the TRBs together; clear the chain bit in the last
2227 * TRB to indicate it's the last TRB in the chain.
2228 */
2229 if (num_trbs > 1) {
2230 field |= TRB_CHAIN;
2231 } else {
2232 /* FIXME - add check for ZERO_PACKET flag before this */
2233 td->last_trb = ep_ring->enqueue;
2234 field |= TRB_IOC;
2235 }
Sarah Sharp04dd9502009-11-11 10:28:30 -08002236 remainder = xhci_td_remainder(urb->transfer_buffer_length -
2237 running_total);
Sarah Sharpf9dc68f2009-07-27 12:03:07 -07002238 length_field = TRB_LEN(trb_buff_len) |
Sarah Sharp04dd9502009-11-11 10:28:30 -08002239 remainder |
Sarah Sharpf9dc68f2009-07-27 12:03:07 -07002240 TRB_INTR_TARGET(0);
Sarah Sharp6cc30d82010-06-10 12:25:28 -07002241 if (num_trbs > 1)
2242 more_trbs_coming = true;
2243 else
2244 more_trbs_coming = false;
2245 queue_trb(xhci, ep_ring, false, more_trbs_coming,
Sarah Sharp8e595a52009-07-27 12:03:31 -07002246 lower_32_bits(addr),
2247 upper_32_bits(addr),
Sarah Sharpf9dc68f2009-07-27 12:03:07 -07002248 length_field,
Sarah Sharpb10de142009-04-27 19:58:50 -07002249 /* We always want to know if the TRB was short,
2250 * or we won't get an event when it completes.
2251 * (Unless we use event data TRBs, which are a
2252 * waste of space and HC resources.)
2253 */
2254 field | TRB_ISP | TRB_TYPE(TRB_NORMAL));
2255 --num_trbs;
2256 running_total += trb_buff_len;
2257
2258 /* Calculate length for next transfer */
2259 addr += trb_buff_len;
2260 trb_buff_len = urb->transfer_buffer_length - running_total;
2261 if (trb_buff_len > TRB_MAX_BUFF_SIZE)
2262 trb_buff_len = TRB_MAX_BUFF_SIZE;
2263 } while (running_total < urb->transfer_buffer_length);
2264
Sarah Sharp8a96c052009-04-27 19:59:19 -07002265 check_trb_math(urb, num_trbs, running_total);
Sarah Sharpe9df17e2010-04-02 15:34:43 -07002266 giveback_first_trb(xhci, slot_id, ep_index, urb->stream_id,
2267 start_cycle, start_trb, td);
Sarah Sharpb10de142009-04-27 19:58:50 -07002268 return 0;
2269}
2270
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07002271/* Caller must have locked xhci->lock */
Sarah Sharp23e3be12009-04-29 19:05:20 -07002272int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags,
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07002273 struct urb *urb, int slot_id, unsigned int ep_index)
2274{
2275 struct xhci_ring *ep_ring;
2276 int num_trbs;
2277 int ret;
2278 struct usb_ctrlrequest *setup;
2279 struct xhci_generic_trb *start_trb;
2280 int start_cycle;
Sarah Sharpf9dc68f2009-07-27 12:03:07 -07002281 u32 field, length_field;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07002282 struct xhci_td *td;
2283
Sarah Sharpe9df17e2010-04-02 15:34:43 -07002284 ep_ring = xhci_urb_to_transfer_ring(xhci, urb);
2285 if (!ep_ring)
2286 return -EINVAL;
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07002287
2288 /*
2289 * Need to copy setup packet into setup TRB, so we can't use the setup
2290 * DMA address.
2291 */
2292 if (!urb->setup_packet)
2293 return -EINVAL;
2294
2295 if (!in_interrupt())
2296 xhci_dbg(xhci, "Queueing ctrl tx for slot id %d, ep %d\n",
2297 slot_id, ep_index);
2298 /* 1 TRB for setup, 1 for status */
2299 num_trbs = 2;
2300 /*
2301 * Don't need to check if we need additional event data and normal TRBs,
2302 * since data in control transfers will never get bigger than 16MB
2303 * XXX: can we get a buffer that crosses 64KB boundaries?
2304 */
2305 if (urb->transfer_buffer_length > 0)
2306 num_trbs++;
Sarah Sharpe9df17e2010-04-02 15:34:43 -07002307 ret = prepare_transfer(xhci, xhci->devs[slot_id],
2308 ep_index, urb->stream_id,
2309 num_trbs, urb, &td, mem_flags);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07002310 if (ret < 0)
2311 return ret;
2312
2313 /*
2314 * Don't give the first TRB to the hardware (by toggling the cycle bit)
2315 * until we've finished creating all the other TRBs. The ring's cycle
2316 * state may change as we enqueue the other TRBs, so save it too.
2317 */
2318 start_trb = &ep_ring->enqueue->generic;
2319 start_cycle = ep_ring->cycle_state;
2320
2321 /* Queue setup TRB - see section 6.4.1.2.1 */
2322 /* FIXME better way to translate setup_packet into two u32 fields? */
2323 setup = (struct usb_ctrlrequest *) urb->setup_packet;
Sarah Sharp6cc30d82010-06-10 12:25:28 -07002324 queue_trb(xhci, ep_ring, false, true,
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07002325 /* FIXME endianness is probably going to bite my ass here. */
2326 setup->bRequestType | setup->bRequest << 8 | setup->wValue << 16,
2327 setup->wIndex | setup->wLength << 16,
2328 TRB_LEN(8) | TRB_INTR_TARGET(0),
2329 /* Immediate data in pointer */
2330 TRB_IDT | TRB_TYPE(TRB_SETUP));
2331
2332 /* If there's data, queue data TRBs */
2333 field = 0;
Sarah Sharpf9dc68f2009-07-27 12:03:07 -07002334 length_field = TRB_LEN(urb->transfer_buffer_length) |
Sarah Sharp04dd9502009-11-11 10:28:30 -08002335 xhci_td_remainder(urb->transfer_buffer_length) |
Sarah Sharpf9dc68f2009-07-27 12:03:07 -07002336 TRB_INTR_TARGET(0);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07002337 if (urb->transfer_buffer_length > 0) {
2338 if (setup->bRequestType & USB_DIR_IN)
2339 field |= TRB_DIR_IN;
Sarah Sharp6cc30d82010-06-10 12:25:28 -07002340 queue_trb(xhci, ep_ring, false, true,
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07002341 lower_32_bits(urb->transfer_dma),
2342 upper_32_bits(urb->transfer_dma),
Sarah Sharpf9dc68f2009-07-27 12:03:07 -07002343 length_field,
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07002344 /* Event on short tx */
2345 field | TRB_ISP | TRB_TYPE(TRB_DATA) | ep_ring->cycle_state);
2346 }
2347
2348 /* Save the DMA address of the last TRB in the TD */
2349 td->last_trb = ep_ring->enqueue;
2350
2351 /* Queue status TRB - see Table 7 and sections 4.11.2.2 and 6.4.1.2.3 */
2352 /* If the device sent data, the status stage is an OUT transfer */
2353 if (urb->transfer_buffer_length > 0 && setup->bRequestType & USB_DIR_IN)
2354 field = 0;
2355 else
2356 field = TRB_DIR_IN;
Sarah Sharp6cc30d82010-06-10 12:25:28 -07002357 queue_trb(xhci, ep_ring, false, false,
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07002358 0,
2359 0,
2360 TRB_INTR_TARGET(0),
2361 /* Event on completion */
2362 field | TRB_IOC | TRB_TYPE(TRB_STATUS) | ep_ring->cycle_state);
2363
Sarah Sharpe9df17e2010-04-02 15:34:43 -07002364 giveback_first_trb(xhci, slot_id, ep_index, 0,
2365 start_cycle, start_trb, td);
Sarah Sharpd0e96f5a2009-04-27 19:58:01 -07002366 return 0;
2367}
2368
2369/**** Command Ring Operations ****/
2370
Sarah Sharp913a8a32009-09-04 10:53:13 -07002371/* Generic function for queueing a command TRB on the command ring.
2372 * Check to make sure there's room on the command ring for one command TRB.
2373 * Also check that there's room reserved for commands that must not fail.
2374 * If this is a command that must not fail, meaning command_must_succeed = TRUE,
2375 * then only check for the number of reserved spots.
2376 * Don't decrement xhci->cmd_ring_reserved_trbs after we've queued the TRB
2377 * because the command event handler may want to resubmit a failed command.
2378 */
2379static int queue_command(struct xhci_hcd *xhci, u32 field1, u32 field2,
2380 u32 field3, u32 field4, bool command_must_succeed)
Sarah Sharp7f84eef2009-04-27 19:53:56 -07002381{
Sarah Sharp913a8a32009-09-04 10:53:13 -07002382 int reserved_trbs = xhci->cmd_ring_reserved_trbs;
Sarah Sharpd1dc9082010-07-09 17:08:38 +02002383 int ret;
2384
Sarah Sharp913a8a32009-09-04 10:53:13 -07002385 if (!command_must_succeed)
2386 reserved_trbs++;
2387
Sarah Sharpd1dc9082010-07-09 17:08:38 +02002388 ret = prepare_ring(xhci, xhci->cmd_ring, EP_STATE_RUNNING,
2389 reserved_trbs, GFP_ATOMIC);
2390 if (ret < 0) {
2391 xhci_err(xhci, "ERR: No room for command on command ring\n");
Sarah Sharp913a8a32009-09-04 10:53:13 -07002392 if (command_must_succeed)
2393 xhci_err(xhci, "ERR: Reserved TRB counting for "
2394 "unfailable commands failed.\n");
Sarah Sharpd1dc9082010-07-09 17:08:38 +02002395 return ret;
Sarah Sharp7f84eef2009-04-27 19:53:56 -07002396 }
Sarah Sharp6cc30d82010-06-10 12:25:28 -07002397 queue_trb(xhci, xhci->cmd_ring, false, false, field1, field2, field3,
Sarah Sharp7f84eef2009-04-27 19:53:56 -07002398 field4 | xhci->cmd_ring->cycle_state);
2399 return 0;
2400}
2401
2402/* Queue a no-op command on the command ring */
2403static int queue_cmd_noop(struct xhci_hcd *xhci)
2404{
Sarah Sharp913a8a32009-09-04 10:53:13 -07002405 return queue_command(xhci, 0, 0, 0, TRB_TYPE(TRB_CMD_NOOP), false);
Sarah Sharp7f84eef2009-04-27 19:53:56 -07002406}
2407
2408/*
2409 * Place a no-op command on the command ring to test the command and
2410 * event ring.
2411 */
Sarah Sharp23e3be12009-04-29 19:05:20 -07002412void *xhci_setup_one_noop(struct xhci_hcd *xhci)
Sarah Sharp7f84eef2009-04-27 19:53:56 -07002413{
2414 if (queue_cmd_noop(xhci) < 0)
2415 return NULL;
2416 xhci->noops_submitted++;
Sarah Sharp23e3be12009-04-29 19:05:20 -07002417 return xhci_ring_cmd_db;
Sarah Sharp7f84eef2009-04-27 19:53:56 -07002418}
Sarah Sharp3ffbba92009-04-27 19:57:38 -07002419
2420/* Queue a slot enable or disable request on the command ring */
Sarah Sharp23e3be12009-04-29 19:05:20 -07002421int xhci_queue_slot_control(struct xhci_hcd *xhci, u32 trb_type, u32 slot_id)
Sarah Sharp3ffbba92009-04-27 19:57:38 -07002422{
2423 return queue_command(xhci, 0, 0, 0,
Sarah Sharp913a8a32009-09-04 10:53:13 -07002424 TRB_TYPE(trb_type) | SLOT_ID_FOR_TRB(slot_id), false);
Sarah Sharp3ffbba92009-04-27 19:57:38 -07002425}
2426
2427/* Queue an address device command TRB */
Sarah Sharp23e3be12009-04-29 19:05:20 -07002428int xhci_queue_address_device(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
2429 u32 slot_id)
Sarah Sharp3ffbba92009-04-27 19:57:38 -07002430{
Sarah Sharp8e595a52009-07-27 12:03:31 -07002431 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
2432 upper_32_bits(in_ctx_ptr), 0,
Sarah Sharp913a8a32009-09-04 10:53:13 -07002433 TRB_TYPE(TRB_ADDR_DEV) | SLOT_ID_FOR_TRB(slot_id),
2434 false);
Sarah Sharp3ffbba92009-04-27 19:57:38 -07002435}
Sarah Sharpf94e01862009-04-27 19:58:38 -07002436
Sarah Sharp02386342010-05-24 13:25:28 -07002437int xhci_queue_vendor_command(struct xhci_hcd *xhci,
2438 u32 field1, u32 field2, u32 field3, u32 field4)
2439{
2440 return queue_command(xhci, field1, field2, field3, field4, false);
2441}
2442
Sarah Sharp2a8f82c2009-12-09 15:59:13 -08002443/* Queue a reset device command TRB */
2444int xhci_queue_reset_device(struct xhci_hcd *xhci, u32 slot_id)
2445{
2446 return queue_command(xhci, 0, 0, 0,
2447 TRB_TYPE(TRB_RESET_DEV) | SLOT_ID_FOR_TRB(slot_id),
2448 false);
2449}
2450
Sarah Sharpf94e01862009-04-27 19:58:38 -07002451/* Queue a configure endpoint command TRB */
Sarah Sharp23e3be12009-04-29 19:05:20 -07002452int xhci_queue_configure_endpoint(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
Sarah Sharp913a8a32009-09-04 10:53:13 -07002453 u32 slot_id, bool command_must_succeed)
Sarah Sharpf94e01862009-04-27 19:58:38 -07002454{
Sarah Sharp8e595a52009-07-27 12:03:31 -07002455 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
2456 upper_32_bits(in_ctx_ptr), 0,
Sarah Sharp913a8a32009-09-04 10:53:13 -07002457 TRB_TYPE(TRB_CONFIG_EP) | SLOT_ID_FOR_TRB(slot_id),
2458 command_must_succeed);
Sarah Sharpf94e01862009-04-27 19:58:38 -07002459}
Sarah Sharpae636742009-04-29 19:02:31 -07002460
Sarah Sharpf2217e82009-08-07 14:04:43 -07002461/* Queue an evaluate context command TRB */
2462int xhci_queue_evaluate_context(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
2463 u32 slot_id)
2464{
2465 return queue_command(xhci, lower_32_bits(in_ctx_ptr),
2466 upper_32_bits(in_ctx_ptr), 0,
Sarah Sharp913a8a32009-09-04 10:53:13 -07002467 TRB_TYPE(TRB_EVAL_CONTEXT) | SLOT_ID_FOR_TRB(slot_id),
2468 false);
Sarah Sharpf2217e82009-08-07 14:04:43 -07002469}
2470
Sarah Sharp23e3be12009-04-29 19:05:20 -07002471int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, int slot_id,
Sarah Sharpae636742009-04-29 19:02:31 -07002472 unsigned int ep_index)
2473{
2474 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
2475 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
2476 u32 type = TRB_TYPE(TRB_STOP_RING);
2477
2478 return queue_command(xhci, 0, 0, 0,
Sarah Sharp913a8a32009-09-04 10:53:13 -07002479 trb_slot_id | trb_ep_index | type, false);
Sarah Sharpae636742009-04-29 19:02:31 -07002480}
2481
2482/* Set Transfer Ring Dequeue Pointer command.
2483 * This should not be used for endpoints that have streams enabled.
2484 */
2485static int queue_set_tr_deq(struct xhci_hcd *xhci, int slot_id,
Sarah Sharpe9df17e2010-04-02 15:34:43 -07002486 unsigned int ep_index, unsigned int stream_id,
2487 struct xhci_segment *deq_seg,
Sarah Sharpae636742009-04-29 19:02:31 -07002488 union xhci_trb *deq_ptr, u32 cycle_state)
2489{
2490 dma_addr_t addr;
2491 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
2492 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
Sarah Sharpe9df17e2010-04-02 15:34:43 -07002493 u32 trb_stream_id = STREAM_ID_FOR_TRB(stream_id);
Sarah Sharpae636742009-04-29 19:02:31 -07002494 u32 type = TRB_TYPE(TRB_SET_DEQ);
2495
Sarah Sharp23e3be12009-04-29 19:05:20 -07002496 addr = xhci_trb_virt_to_dma(deq_seg, deq_ptr);
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07002497 if (addr == 0) {
Sarah Sharpae636742009-04-29 19:02:31 -07002498 xhci_warn(xhci, "WARN Cannot submit Set TR Deq Ptr\n");
Greg Kroah-Hartman700e2052009-04-29 19:14:08 -07002499 xhci_warn(xhci, "WARN deq seg = %p, deq pt = %p\n",
2500 deq_seg, deq_ptr);
Sarah Sharpc92bcfa2009-07-27 12:05:21 -07002501 return 0;
2502 }
Sarah Sharp8e595a52009-07-27 12:03:31 -07002503 return queue_command(xhci, lower_32_bits(addr) | cycle_state,
Sarah Sharpe9df17e2010-04-02 15:34:43 -07002504 upper_32_bits(addr), trb_stream_id,
Sarah Sharp913a8a32009-09-04 10:53:13 -07002505 trb_slot_id | trb_ep_index | type, false);
Sarah Sharpae636742009-04-29 19:02:31 -07002506}
Sarah Sharpa1587d92009-07-27 12:03:15 -07002507
2508int xhci_queue_reset_ep(struct xhci_hcd *xhci, int slot_id,
2509 unsigned int ep_index)
2510{
2511 u32 trb_slot_id = SLOT_ID_FOR_TRB(slot_id);
2512 u32 trb_ep_index = EP_ID_FOR_TRB(ep_index);
2513 u32 type = TRB_TYPE(TRB_RESET_EP);
2514
Sarah Sharp913a8a32009-09-04 10:53:13 -07002515 return queue_command(xhci, 0, 0, 0, trb_slot_id | trb_ep_index | type,
2516 false);
Sarah Sharpa1587d92009-07-27 12:03:15 -07002517}