USB: update documentation for URB_ISO_ASAP
[deliverable/linux.git] / drivers / usb / host / ehci-sched.c
CommitLineData
1da177e4
LT
1/*
2 * Copyright (c) 2001-2004 by David Brownell
3 * Copyright (c) 2003 Michal Sojka, for high-speed iso transfers
53bd6a60 4 *
1da177e4
LT
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software Foundation,
17 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20/* this file is part of ehci-hcd.c */
21
22/*-------------------------------------------------------------------------*/
23
24/*
25 * EHCI scheduled transaction support: interrupt, iso, split iso
26 * These are called "periodic" transactions in the EHCI spec.
27 *
28 * Note that for interrupt transfers, the QH/QTD manipulation is shared
29 * with the "asynchronous" transaction support (control/bulk transfers).
30 * The only real difference is in how interrupt transfers are scheduled.
31 *
32 * For ISO, we make an "iso_stream" head to serve the same role as a QH.
33 * It keeps track of every ITD (or SITD) that's linked, and holds enough
34 * pre-calculated schedule data to make appending to the queue be quick.
35 */
36
37static int ehci_get_frame (struct usb_hcd *hcd);
38
68aa95d5
AS
39#ifdef CONFIG_PCI
40
41static unsigned ehci_read_frame_index(struct ehci_hcd *ehci)
42{
43 unsigned uf;
44
45 /*
46 * The MosChip MCS9990 controller updates its microframe counter
47 * a little before the frame counter, and occasionally we will read
48 * the invalid intermediate value. Avoid problems by checking the
49 * microframe number (the low-order 3 bits); if they are 0 then
50 * re-read the register to get the correct value.
51 */
52 uf = ehci_readl(ehci, &ehci->regs->frame_index);
53 if (unlikely(ehci->frame_index_bug && ((uf & 7) == 0)))
54 uf = ehci_readl(ehci, &ehci->regs->frame_index);
55 return uf;
56}
57
58#endif
59
1da177e4
LT
60/*-------------------------------------------------------------------------*/
61
62/*
63 * periodic_next_shadow - return "next" pointer on shadow list
64 * @periodic: host pointer to qh/itd/sitd
65 * @tag: hardware tag for type of this record
66 */
67static union ehci_shadow *
6dbd682b
SR
68periodic_next_shadow(struct ehci_hcd *ehci, union ehci_shadow *periodic,
69 __hc32 tag)
1da177e4 70{
6dbd682b 71 switch (hc32_to_cpu(ehci, tag)) {
1da177e4
LT
72 case Q_TYPE_QH:
73 return &periodic->qh->qh_next;
74 case Q_TYPE_FSTN:
75 return &periodic->fstn->fstn_next;
76 case Q_TYPE_ITD:
77 return &periodic->itd->itd_next;
78 // case Q_TYPE_SITD:
79 default:
80 return &periodic->sitd->sitd_next;
81 }
82}
83
3807e26d
AD
84static __hc32 *
85shadow_next_periodic(struct ehci_hcd *ehci, union ehci_shadow *periodic,
86 __hc32 tag)
87{
88 switch (hc32_to_cpu(ehci, tag)) {
89 /* our ehci_shadow.qh is actually software part */
90 case Q_TYPE_QH:
91 return &periodic->qh->hw->hw_next;
92 /* others are hw parts */
93 default:
94 return periodic->hw_next;
95 }
96}
97
1da177e4
LT
98/* caller must hold ehci->lock */
99static void periodic_unlink (struct ehci_hcd *ehci, unsigned frame, void *ptr)
100{
6dbd682b
SR
101 union ehci_shadow *prev_p = &ehci->pshadow[frame];
102 __hc32 *hw_p = &ehci->periodic[frame];
1da177e4
LT
103 union ehci_shadow here = *prev_p;
104
105 /* find predecessor of "ptr"; hw and shadow lists are in sync */
106 while (here.ptr && here.ptr != ptr) {
6dbd682b
SR
107 prev_p = periodic_next_shadow(ehci, prev_p,
108 Q_NEXT_TYPE(ehci, *hw_p));
3807e26d
AD
109 hw_p = shadow_next_periodic(ehci, &here,
110 Q_NEXT_TYPE(ehci, *hw_p));
1da177e4
LT
111 here = *prev_p;
112 }
113 /* an interrupt entry (at list end) could have been shared */
114 if (!here.ptr)
115 return;
116
117 /* update shadow and hardware lists ... the old "next" pointers
118 * from ptr may still be in use, the caller updates them.
119 */
6dbd682b
SR
120 *prev_p = *periodic_next_shadow(ehci, &here,
121 Q_NEXT_TYPE(ehci, *hw_p));
3d091a6f
AX
122
123 if (!ehci->use_dummy_qh ||
124 *shadow_next_periodic(ehci, &here, Q_NEXT_TYPE(ehci, *hw_p))
125 != EHCI_LIST_END(ehci))
126 *hw_p = *shadow_next_periodic(ehci, &here,
127 Q_NEXT_TYPE(ehci, *hw_p));
128 else
129 *hw_p = ehci->dummy->qh_dma;
1da177e4
LT
130}
131
132/* how many of the uframe's 125 usecs are allocated? */
133static unsigned short
134periodic_usecs (struct ehci_hcd *ehci, unsigned frame, unsigned uframe)
135{
6dbd682b 136 __hc32 *hw_p = &ehci->periodic [frame];
1da177e4
LT
137 union ehci_shadow *q = &ehci->pshadow [frame];
138 unsigned usecs = 0;
3807e26d 139 struct ehci_qh_hw *hw;
1da177e4
LT
140
141 while (q->ptr) {
6dbd682b 142 switch (hc32_to_cpu(ehci, Q_NEXT_TYPE(ehci, *hw_p))) {
1da177e4 143 case Q_TYPE_QH:
3807e26d 144 hw = q->qh->hw;
1da177e4 145 /* is it in the S-mask? */
3807e26d 146 if (hw->hw_info2 & cpu_to_hc32(ehci, 1 << uframe))
1da177e4
LT
147 usecs += q->qh->usecs;
148 /* ... or C-mask? */
3807e26d 149 if (hw->hw_info2 & cpu_to_hc32(ehci,
6dbd682b 150 1 << (8 + uframe)))
1da177e4 151 usecs += q->qh->c_usecs;
3807e26d 152 hw_p = &hw->hw_next;
1da177e4
LT
153 q = &q->qh->qh_next;
154 break;
155 // case Q_TYPE_FSTN:
156 default:
157 /* for "save place" FSTNs, count the relevant INTR
158 * bandwidth from the previous frame
159 */
6dbd682b 160 if (q->fstn->hw_prev != EHCI_LIST_END(ehci)) {
1da177e4
LT
161 ehci_dbg (ehci, "ignoring FSTN cost ...\n");
162 }
163 hw_p = &q->fstn->hw_next;
164 q = &q->fstn->fstn_next;
165 break;
166 case Q_TYPE_ITD:
3b6fcfd0
KW
167 if (q->itd->hw_transaction[uframe])
168 usecs += q->itd->stream->usecs;
1da177e4
LT
169 hw_p = &q->itd->hw_next;
170 q = &q->itd->itd_next;
171 break;
172 case Q_TYPE_SITD:
173 /* is it in the S-mask? (count SPLIT, DATA) */
6dbd682b
SR
174 if (q->sitd->hw_uframe & cpu_to_hc32(ehci,
175 1 << uframe)) {
1da177e4 176 if (q->sitd->hw_fullspeed_ep &
6dbd682b 177 cpu_to_hc32(ehci, 1<<31))
1da177e4
LT
178 usecs += q->sitd->stream->usecs;
179 else /* worst case for OUT start-split */
180 usecs += HS_USECS_ISO (188);
181 }
182
183 /* ... C-mask? (count CSPLIT, DATA) */
184 if (q->sitd->hw_uframe &
6dbd682b 185 cpu_to_hc32(ehci, 1 << (8 + uframe))) {
1da177e4
LT
186 /* worst case for IN complete-split */
187 usecs += q->sitd->stream->c_usecs;
188 }
189
190 hw_p = &q->sitd->hw_next;
191 q = &q->sitd->sitd_next;
192 break;
193 }
194 }
195#ifdef DEBUG
cc62a7eb 196 if (usecs > ehci->uframe_periodic_max)
1da177e4
LT
197 ehci_err (ehci, "uframe %d sched overrun: %d usecs\n",
198 frame * 8 + uframe, usecs);
199#endif
200 return usecs;
201}
202
203/*-------------------------------------------------------------------------*/
204
205static int same_tt (struct usb_device *dev1, struct usb_device *dev2)
206{
207 if (!dev1->tt || !dev2->tt)
208 return 0;
209 if (dev1->tt != dev2->tt)
210 return 0;
211 if (dev1->tt->multi)
212 return dev1->ttport == dev2->ttport;
213 else
214 return 1;
215}
216
ba47f66b
DS
217#ifdef CONFIG_USB_EHCI_TT_NEWSCHED
218
219/* Which uframe does the low/fullspeed transfer start in?
220 *
221 * The parameter is the mask of ssplits in "H-frame" terms
222 * and this returns the transfer start uframe in "B-frame" terms,
223 * which allows both to match, e.g. a ssplit in "H-frame" uframe 0
224 * will cause a transfer in "B-frame" uframe 0. "B-frames" lag
225 * "H-frames" by 1 uframe. See the EHCI spec sec 4.5 and figure 4.7.
226 */
6dbd682b 227static inline unsigned char tt_start_uframe(struct ehci_hcd *ehci, __hc32 mask)
ba47f66b 228{
6dbd682b 229 unsigned char smask = QH_SMASK & hc32_to_cpu(ehci, mask);
ba47f66b
DS
230 if (!smask) {
231 ehci_err(ehci, "invalid empty smask!\n");
232 /* uframe 7 can't have bw so this will indicate failure */
233 return 7;
234 }
235 return ffs(smask) - 1;
236}
237
238static const unsigned char
239max_tt_usecs[] = { 125, 125, 125, 125, 125, 125, 30, 0 };
240
241/* carryover low/fullspeed bandwidth that crosses uframe boundries */
242static inline void carryover_tt_bandwidth(unsigned short tt_usecs[8])
243{
244 int i;
245 for (i=0; i<7; i++) {
246 if (max_tt_usecs[i] < tt_usecs[i]) {
247 tt_usecs[i+1] += tt_usecs[i] - max_tt_usecs[i];
248 tt_usecs[i] = max_tt_usecs[i];
249 }
250 }
251}
252
253/* How many of the tt's periodic downstream 1000 usecs are allocated?
254 *
255 * While this measures the bandwidth in terms of usecs/uframe,
256 * the low/fullspeed bus has no notion of uframes, so any particular
257 * low/fullspeed transfer can "carry over" from one uframe to the next,
258 * since the TT just performs downstream transfers in sequence.
259 *
dc0d5c1e 260 * For example two separate 100 usec transfers can start in the same uframe,
ba47f66b
DS
261 * and the second one would "carry over" 75 usecs into the next uframe.
262 */
263static void
264periodic_tt_usecs (
265 struct ehci_hcd *ehci,
266 struct usb_device *dev,
267 unsigned frame,
268 unsigned short tt_usecs[8]
269)
270{
6dbd682b 271 __hc32 *hw_p = &ehci->periodic [frame];
ba47f66b
DS
272 union ehci_shadow *q = &ehci->pshadow [frame];
273 unsigned char uf;
274
275 memset(tt_usecs, 0, 16);
276
277 while (q->ptr) {
6dbd682b 278 switch (hc32_to_cpu(ehci, Q_NEXT_TYPE(ehci, *hw_p))) {
ba47f66b
DS
279 case Q_TYPE_ITD:
280 hw_p = &q->itd->hw_next;
281 q = &q->itd->itd_next;
282 continue;
283 case Q_TYPE_QH:
284 if (same_tt(dev, q->qh->dev)) {
3807e26d 285 uf = tt_start_uframe(ehci, q->qh->hw->hw_info2);
ba47f66b
DS
286 tt_usecs[uf] += q->qh->tt_usecs;
287 }
3807e26d 288 hw_p = &q->qh->hw->hw_next;
ba47f66b
DS
289 q = &q->qh->qh_next;
290 continue;
291 case Q_TYPE_SITD:
292 if (same_tt(dev, q->sitd->urb->dev)) {
293 uf = tt_start_uframe(ehci, q->sitd->hw_uframe);
294 tt_usecs[uf] += q->sitd->stream->tt_usecs;
295 }
296 hw_p = &q->sitd->hw_next;
297 q = &q->sitd->sitd_next;
298 continue;
299 // case Q_TYPE_FSTN:
300 default:
6dbd682b
SR
301 ehci_dbg(ehci, "ignoring periodic frame %d FSTN\n",
302 frame);
ba47f66b
DS
303 hw_p = &q->fstn->hw_next;
304 q = &q->fstn->fstn_next;
305 }
306 }
307
308 carryover_tt_bandwidth(tt_usecs);
309
310 if (max_tt_usecs[7] < tt_usecs[7])
311 ehci_err(ehci, "frame %d tt sched overrun: %d usecs\n",
312 frame, tt_usecs[7] - max_tt_usecs[7]);
313}
314
315/*
316 * Return true if the device's tt's downstream bus is available for a
317 * periodic transfer of the specified length (usecs), starting at the
318 * specified frame/uframe. Note that (as summarized in section 11.19
319 * of the usb 2.0 spec) TTs can buffer multiple transactions for each
320 * uframe.
321 *
322 * The uframe parameter is when the fullspeed/lowspeed transfer
323 * should be executed in "B-frame" terms, which is the same as the
324 * highspeed ssplit's uframe (which is in "H-frame" terms). For example
325 * a ssplit in "H-frame" 0 causes a transfer in "B-frame" 0.
326 * See the EHCI spec sec 4.5 and fig 4.7.
327 *
328 * This checks if the full/lowspeed bus, at the specified starting uframe,
329 * has the specified bandwidth available, according to rules listed
330 * in USB 2.0 spec section 11.18.1 fig 11-60.
331 *
332 * This does not check if the transfer would exceed the max ssplit
333 * limit of 16, specified in USB 2.0 spec section 11.18.4 requirement #4,
334 * since proper scheduling limits ssplits to less than 16 per uframe.
335 */
336static int tt_available (
337 struct ehci_hcd *ehci,
338 unsigned period,
339 struct usb_device *dev,
340 unsigned frame,
341 unsigned uframe,
342 u16 usecs
343)
344{
345 if ((period == 0) || (uframe >= 7)) /* error */
346 return 0;
347
348 for (; frame < ehci->periodic_size; frame += period) {
349 unsigned short tt_usecs[8];
350
351 periodic_tt_usecs (ehci, dev, frame, tt_usecs);
352
353 ehci_vdbg(ehci, "tt frame %d check %d usecs start uframe %d in"
354 " schedule %d/%d/%d/%d/%d/%d/%d/%d\n",
355 frame, usecs, uframe,
356 tt_usecs[0], tt_usecs[1], tt_usecs[2], tt_usecs[3],
357 tt_usecs[4], tt_usecs[5], tt_usecs[6], tt_usecs[7]);
358
359 if (max_tt_usecs[uframe] <= tt_usecs[uframe]) {
360 ehci_vdbg(ehci, "frame %d uframe %d fully scheduled\n",
361 frame, uframe);
362 return 0;
363 }
364
365 /* special case for isoc transfers larger than 125us:
366 * the first and each subsequent fully used uframe
367 * must be empty, so as to not illegally delay
368 * already scheduled transactions
369 */
370 if (125 < usecs) {
c065c60e 371 int ufs = (usecs / 125);
ba47f66b
DS
372 int i;
373 for (i = uframe; i < (uframe + ufs) && i < 8; i++)
374 if (0 < tt_usecs[i]) {
375 ehci_vdbg(ehci,
376 "multi-uframe xfer can't fit "
377 "in frame %d uframe %d\n",
378 frame, i);
379 return 0;
380 }
381 }
382
383 tt_usecs[uframe] += usecs;
384
385 carryover_tt_bandwidth(tt_usecs);
386
387 /* fail if the carryover pushed bw past the last uframe's limit */
388 if (max_tt_usecs[7] < tt_usecs[7]) {
389 ehci_vdbg(ehci,
390 "tt unavailable usecs %d frame %d uframe %d\n",
391 usecs, frame, uframe);
392 return 0;
393 }
394 }
395
396 return 1;
397}
398
399#else
400
1da177e4
LT
401/* return true iff the device's transaction translator is available
402 * for a periodic transfer starting at the specified frame, using
403 * all the uframes in the mask.
404 */
405static int tt_no_collision (
406 struct ehci_hcd *ehci,
407 unsigned period,
408 struct usb_device *dev,
409 unsigned frame,
410 u32 uf_mask
411)
412{
413 if (period == 0) /* error */
414 return 0;
415
416 /* note bandwidth wastage: split never follows csplit
417 * (different dev or endpoint) until the next uframe.
418 * calling convention doesn't make that distinction.
419 */
420 for (; frame < ehci->periodic_size; frame += period) {
421 union ehci_shadow here;
6dbd682b 422 __hc32 type;
3807e26d 423 struct ehci_qh_hw *hw;
1da177e4
LT
424
425 here = ehci->pshadow [frame];
6dbd682b 426 type = Q_NEXT_TYPE(ehci, ehci->periodic [frame]);
1da177e4 427 while (here.ptr) {
6dbd682b 428 switch (hc32_to_cpu(ehci, type)) {
1da177e4 429 case Q_TYPE_ITD:
6dbd682b 430 type = Q_NEXT_TYPE(ehci, here.itd->hw_next);
1da177e4
LT
431 here = here.itd->itd_next;
432 continue;
433 case Q_TYPE_QH:
3807e26d 434 hw = here.qh->hw;
1da177e4
LT
435 if (same_tt (dev, here.qh->dev)) {
436 u32 mask;
437
6dbd682b 438 mask = hc32_to_cpu(ehci,
3807e26d 439 hw->hw_info2);
1da177e4
LT
440 /* "knows" no gap is needed */
441 mask |= mask >> 8;
442 if (mask & uf_mask)
443 break;
444 }
3807e26d 445 type = Q_NEXT_TYPE(ehci, hw->hw_next);
1da177e4
LT
446 here = here.qh->qh_next;
447 continue;
448 case Q_TYPE_SITD:
449 if (same_tt (dev, here.sitd->urb->dev)) {
450 u16 mask;
451
6dbd682b 452 mask = hc32_to_cpu(ehci, here.sitd
1da177e4
LT
453 ->hw_uframe);
454 /* FIXME assumes no gap for IN! */
455 mask |= mask >> 8;
456 if (mask & uf_mask)
457 break;
458 }
6dbd682b 459 type = Q_NEXT_TYPE(ehci, here.sitd->hw_next);
1da177e4
LT
460 here = here.sitd->sitd_next;
461 continue;
462 // case Q_TYPE_FSTN:
463 default:
464 ehci_dbg (ehci,
465 "periodic frame %d bogus type %d\n",
466 frame, type);
467 }
468
469 /* collision or error */
470 return 0;
471 }
472 }
473
474 /* no collision */
475 return 1;
476}
477
ba47f66b
DS
478#endif /* CONFIG_USB_EHCI_TT_NEWSCHED */
479
1da177e4
LT
480/*-------------------------------------------------------------------------*/
481
b015cb79 482static void enable_periodic(struct ehci_hcd *ehci)
1da177e4 483{
3ca9aeba 484 if (ehci->periodic_count++)
b015cb79 485 return;
01c17142 486
3ca9aeba
AS
487 /* Stop waiting to turn off the periodic schedule */
488 ehci->enabled_hrtimer_events &= ~BIT(EHCI_HRTIMER_DISABLE_PERIODIC);
1da177e4 489
3ca9aeba
AS
490 /* Don't start the schedule until PSS is 0 */
491 ehci_poll_PSS(ehci);
18aafe64 492 turn_on_io_watchdog(ehci);
1da177e4
LT
493}
494
b015cb79 495static void disable_periodic(struct ehci_hcd *ehci)
1da177e4 496{
3ca9aeba 497 if (--ehci->periodic_count)
b015cb79 498 return;
01c17142 499
3ca9aeba
AS
500 /* Don't turn off the schedule until PSS is 1 */
501 ehci_poll_PSS(ehci);
1da177e4
LT
502}
503
504/*-------------------------------------------------------------------------*/
505
506/* periodic schedule slots have iso tds (normal or split) first, then a
507 * sparse tree for active interrupt transfers.
508 *
509 * this just links in a qh; caller guarantees uframe masks are set right.
510 * no FSTN support (yet; ehci 0.96+)
511 */
b015cb79 512static void qh_link_periodic(struct ehci_hcd *ehci, struct ehci_qh *qh)
1da177e4
LT
513{
514 unsigned i;
515 unsigned period = qh->period;
516
517 dev_dbg (&qh->dev->dev,
518 "link qh%d-%04x/%p start %d [%d/%d us]\n",
3807e26d
AD
519 period, hc32_to_cpup(ehci, &qh->hw->hw_info2)
520 & (QH_CMASK | QH_SMASK),
1da177e4
LT
521 qh, qh->start, qh->usecs, qh->c_usecs);
522
523 /* high bandwidth, or otherwise every microframe */
524 if (period == 0)
525 period = 1;
526
527 for (i = qh->start; i < ehci->periodic_size; i += period) {
6dbd682b
SR
528 union ehci_shadow *prev = &ehci->pshadow[i];
529 __hc32 *hw_p = &ehci->periodic[i];
1da177e4 530 union ehci_shadow here = *prev;
6dbd682b 531 __hc32 type = 0;
1da177e4
LT
532
533 /* skip the iso nodes at list head */
534 while (here.ptr) {
6dbd682b
SR
535 type = Q_NEXT_TYPE(ehci, *hw_p);
536 if (type == cpu_to_hc32(ehci, Q_TYPE_QH))
1da177e4 537 break;
6dbd682b 538 prev = periodic_next_shadow(ehci, prev, type);
3807e26d 539 hw_p = shadow_next_periodic(ehci, &here, type);
1da177e4
LT
540 here = *prev;
541 }
542
543 /* sorting each branch by period (slow-->fast)
544 * enables sharing interior tree nodes
545 */
546 while (here.ptr && qh != here.qh) {
547 if (qh->period > here.qh->period)
548 break;
549 prev = &here.qh->qh_next;
3807e26d 550 hw_p = &here.qh->hw->hw_next;
1da177e4
LT
551 here = *prev;
552 }
553 /* link in this qh, unless some earlier pass did that */
554 if (qh != here.qh) {
555 qh->qh_next = here;
556 if (here.qh)
3807e26d 557 qh->hw->hw_next = *hw_p;
1da177e4
LT
558 wmb ();
559 prev->qh = qh;
6dbd682b 560 *hw_p = QH_NEXT (ehci, qh->qh_dma);
1da177e4
LT
561 }
562 }
563 qh->qh_state = QH_STATE_LINKED;
ef4638f9 564 qh->xacterrs = 0;
1da177e4
LT
565
566 /* update per-qh bandwidth for usbfs */
567 ehci_to_hcd(ehci)->self.bandwidth_allocated += qh->period
568 ? ((qh->usecs + qh->c_usecs) / qh->period)
569 : (qh->usecs * 8);
570
569b394f
AS
571 list_add(&qh->intr_node, &ehci->intr_qh_list);
572
1da177e4 573 /* maybe enable periodic schedule processing */
569b394f 574 ++ehci->intr_count;
b015cb79 575 enable_periodic(ehci);
1da177e4
LT
576}
577
b015cb79 578static void qh_unlink_periodic(struct ehci_hcd *ehci, struct ehci_qh *qh)
1da177e4
LT
579{
580 unsigned i;
581 unsigned period;
582
df202255
AS
583 /*
584 * If qh is for a low/full-speed device, simply unlinking it
585 * could interfere with an ongoing split transaction. To unlink
586 * it safely would require setting the QH_INACTIVATE bit and
587 * waiting at least one frame, as described in EHCI 4.12.2.5.
588 *
589 * We won't bother with any of this. Instead, we assume that the
590 * only reason for unlinking an interrupt QH while the current URB
591 * is still active is to dequeue all the URBs (flush the whole
592 * endpoint queue).
593 *
594 * If rebalancing the periodic schedule is ever implemented, this
595 * approach will no longer be valid.
596 */
1da177e4
LT
597
598 /* high bandwidth, or otherwise part of every microframe */
599 if ((period = qh->period) == 0)
600 period = 1;
601
602 for (i = qh->start; i < ehci->periodic_size; i += period)
603 periodic_unlink (ehci, i, qh);
604
605 /* update per-qh bandwidth for usbfs */
606 ehci_to_hcd(ehci)->self.bandwidth_allocated -= qh->period
607 ? ((qh->usecs + qh->c_usecs) / qh->period)
608 : (qh->usecs * 8);
609
610 dev_dbg (&qh->dev->dev,
611 "unlink qh%d-%04x/%p start %d [%d/%d us]\n",
7dedacf4 612 qh->period,
3807e26d 613 hc32_to_cpup(ehci, &qh->hw->hw_info2) & (QH_CMASK | QH_SMASK),
1da177e4
LT
614 qh, qh->start, qh->usecs, qh->c_usecs);
615
616 /* qh->qh_next still "live" to HC */
617 qh->qh_state = QH_STATE_UNLINK;
618 qh->qh_next.ptr = NULL;
569b394f
AS
619
620 if (ehci->qh_scan_next == qh)
621 ehci->qh_scan_next = list_entry(qh->intr_node.next,
622 struct ehci_qh, intr_node);
623 list_del(&qh->intr_node);
1da177e4
LT
624}
625
df202255 626static void start_unlink_intr(struct ehci_hcd *ehci, struct ehci_qh *qh)
1da177e4 627{
a448c9d8
AS
628 /* If the QH isn't linked then there's nothing we can do
629 * unless we were called during a giveback, in which case
630 * qh_completions() has to deal with it.
631 */
632 if (qh->qh_state != QH_STATE_LINKED) {
633 if (qh->qh_state == QH_STATE_COMPLETING)
634 qh->needs_rescan = 1;
635 return;
636 }
1da177e4
LT
637
638 qh_unlink_periodic (ehci, qh);
639
df202255
AS
640 /* Make sure the unlinks are visible before starting the timer */
641 wmb();
642
643 /*
644 * The EHCI spec doesn't say how long it takes the controller to
645 * stop accessing an unlinked interrupt QH. The timer delay is
646 * 9 uframes; presumably that will be long enough.
1da177e4 647 */
df202255
AS
648 qh->unlink_cycle = ehci->intr_unlink_cycle;
649
650 /* New entries go at the end of the intr_unlink list */
651 if (ehci->intr_unlink)
652 ehci->intr_unlink_last->unlink_next = qh;
1da177e4 653 else
df202255
AS
654 ehci->intr_unlink = qh;
655 ehci->intr_unlink_last = qh;
656
657 if (ehci->intr_unlinking)
658 ; /* Avoid recursive calls */
659 else if (ehci->rh_state < EHCI_RH_RUNNING)
660 ehci_handle_intr_unlinks(ehci);
661 else if (ehci->intr_unlink == qh) {
662 ehci_enable_event(ehci, EHCI_HRTIMER_UNLINK_INTR, true);
663 ++ehci->intr_unlink_cycle;
664 }
665}
666
667static void end_unlink_intr(struct ehci_hcd *ehci, struct ehci_qh *qh)
668{
669 struct ehci_qh_hw *hw = qh->hw;
670 int rc;
1da177e4 671
1da177e4 672 qh->qh_state = QH_STATE_IDLE;
3807e26d 673 hw->hw_next = EHCI_LIST_END(ehci);
a448c9d8
AS
674
675 qh_completions(ehci, qh);
676
677 /* reschedule QH iff another request is queued */
df202255 678 if (!list_empty(&qh->qtd_list) && ehci->rh_state == EHCI_RH_RUNNING) {
a448c9d8
AS
679 rc = qh_schedule(ehci, qh);
680
681 /* An error here likely indicates handshake failure
682 * or no space left in the schedule. Neither fault
683 * should happen often ...
684 *
685 * FIXME kill the now-dysfunctional queued urbs
686 */
687 if (rc != 0)
688 ehci_err(ehci, "can't reschedule qh %p, err %d\n",
689 qh, rc);
690 }
3ca9aeba
AS
691
692 /* maybe turn off periodic schedule */
569b394f 693 --ehci->intr_count;
3ca9aeba 694 disable_periodic(ehci);
1da177e4
LT
695}
696
697/*-------------------------------------------------------------------------*/
698
699static int check_period (
53bd6a60 700 struct ehci_hcd *ehci,
1da177e4
LT
701 unsigned frame,
702 unsigned uframe,
703 unsigned period,
704 unsigned usecs
705) {
706 int claimed;
707
708 /* complete split running into next frame?
709 * given FSTN support, we could sometimes check...
710 */
711 if (uframe >= 8)
712 return 0;
713
cc62a7eb
KS
714 /* convert "usecs we need" to "max already claimed" */
715 usecs = ehci->uframe_periodic_max - usecs;
1da177e4
LT
716
717 /* we "know" 2 and 4 uframe intervals were rejected; so
718 * for period 0, check _every_ microframe in the schedule.
719 */
720 if (unlikely (period == 0)) {
721 do {
722 for (uframe = 0; uframe < 7; uframe++) {
723 claimed = periodic_usecs (ehci, frame, uframe);
724 if (claimed > usecs)
725 return 0;
726 }
727 } while ((frame += 1) < ehci->periodic_size);
728
729 /* just check the specified uframe, at that period */
730 } else {
731 do {
732 claimed = periodic_usecs (ehci, frame, uframe);
733 if (claimed > usecs)
734 return 0;
735 } while ((frame += period) < ehci->periodic_size);
736 }
737
738 // success!
739 return 1;
740}
741
742static int check_intr_schedule (
53bd6a60 743 struct ehci_hcd *ehci,
1da177e4
LT
744 unsigned frame,
745 unsigned uframe,
746 const struct ehci_qh *qh,
6dbd682b 747 __hc32 *c_maskp
1da177e4
LT
748)
749{
53bd6a60 750 int retval = -ENOSPC;
ba47f66b 751 u8 mask = 0;
1da177e4
LT
752
753 if (qh->c_usecs && uframe >= 6) /* FSTN territory? */
754 goto done;
755
756 if (!check_period (ehci, frame, uframe, qh->period, qh->usecs))
757 goto done;
758 if (!qh->c_usecs) {
759 retval = 0;
760 *c_maskp = 0;
761 goto done;
762 }
763
ba47f66b
DS
764#ifdef CONFIG_USB_EHCI_TT_NEWSCHED
765 if (tt_available (ehci, qh->period, qh->dev, frame, uframe,
766 qh->tt_usecs)) {
767 unsigned i;
768
769 /* TODO : this may need FSTN for SSPLIT in uframe 5. */
770 for (i=uframe+1; i<8 && i<uframe+4; i++)
771 if (!check_period (ehci, frame, i,
772 qh->period, qh->c_usecs))
773 goto done;
774 else
775 mask |= 1 << i;
776
777 retval = 0;
778
6dbd682b 779 *c_maskp = cpu_to_hc32(ehci, mask << 8);
ba47f66b
DS
780 }
781#else
1da177e4
LT
782 /* Make sure this tt's buffer is also available for CSPLITs.
783 * We pessimize a bit; probably the typical full speed case
784 * doesn't need the second CSPLIT.
53bd6a60 785 *
1da177e4
LT
786 * NOTE: both SPLIT and CSPLIT could be checked in just
787 * one smart pass...
788 */
789 mask = 0x03 << (uframe + qh->gap_uf);
6dbd682b 790 *c_maskp = cpu_to_hc32(ehci, mask << 8);
1da177e4
LT
791
792 mask |= 1 << uframe;
793 if (tt_no_collision (ehci, qh->period, qh->dev, frame, mask)) {
794 if (!check_period (ehci, frame, uframe + qh->gap_uf + 1,
795 qh->period, qh->c_usecs))
796 goto done;
797 if (!check_period (ehci, frame, uframe + qh->gap_uf,
798 qh->period, qh->c_usecs))
799 goto done;
800 retval = 0;
801 }
ba47f66b 802#endif
1da177e4
LT
803done:
804 return retval;
805}
806
807/* "first fit" scheduling policy used the first time through,
808 * or when the previous schedule slot can't be re-used.
809 */
6dbd682b 810static int qh_schedule(struct ehci_hcd *ehci, struct ehci_qh *qh)
1da177e4 811{
53bd6a60 812 int status;
1da177e4 813 unsigned uframe;
6dbd682b 814 __hc32 c_mask;
1da177e4 815 unsigned frame; /* 0..(qh->period - 1), or NO_FRAME */
3807e26d 816 struct ehci_qh_hw *hw = qh->hw;
1da177e4
LT
817
818 qh_refresh(ehci, qh);
3807e26d 819 hw->hw_next = EHCI_LIST_END(ehci);
1da177e4
LT
820 frame = qh->start;
821
822 /* reuse the previous schedule slots, if we can */
823 if (frame < qh->period) {
3807e26d 824 uframe = ffs(hc32_to_cpup(ehci, &hw->hw_info2) & QH_SMASK);
1da177e4
LT
825 status = check_intr_schedule (ehci, frame, --uframe,
826 qh, &c_mask);
827 } else {
828 uframe = 0;
829 c_mask = 0;
830 status = -ENOSPC;
831 }
832
833 /* else scan the schedule to find a group of slots such that all
834 * uframes have enough periodic bandwidth available.
835 */
836 if (status) {
837 /* "normal" case, uframing flexible except with splits */
838 if (qh->period) {
68335e81
AS
839 int i;
840
841 for (i = qh->period; status && i > 0; --i) {
842 frame = ++ehci->random_frame % qh->period;
1da177e4
LT
843 for (uframe = 0; uframe < 8; uframe++) {
844 status = check_intr_schedule (ehci,
845 frame, uframe, qh,
846 &c_mask);
847 if (status == 0)
848 break;
849 }
68335e81 850 }
1da177e4
LT
851
852 /* qh->period == 0 means every uframe */
853 } else {
854 frame = 0;
855 status = check_intr_schedule (ehci, 0, 0, qh, &c_mask);
856 }
857 if (status)
858 goto done;
859 qh->start = frame;
860
861 /* reset S-frame and (maybe) C-frame masks */
3807e26d
AD
862 hw->hw_info2 &= cpu_to_hc32(ehci, ~(QH_CMASK | QH_SMASK));
863 hw->hw_info2 |= qh->period
6dbd682b
SR
864 ? cpu_to_hc32(ehci, 1 << uframe)
865 : cpu_to_hc32(ehci, QH_SMASK);
3807e26d 866 hw->hw_info2 |= c_mask;
1da177e4
LT
867 } else
868 ehci_dbg (ehci, "reused qh %p schedule\n", qh);
869
870 /* stuff into the periodic schedule */
b015cb79 871 qh_link_periodic(ehci, qh);
1da177e4
LT
872done:
873 return status;
874}
875
876static int intr_submit (
877 struct ehci_hcd *ehci,
1da177e4
LT
878 struct urb *urb,
879 struct list_head *qtd_list,
55016f10 880 gfp_t mem_flags
1da177e4
LT
881) {
882 unsigned epnum;
883 unsigned long flags;
884 struct ehci_qh *qh;
e9df41c5 885 int status;
1da177e4
LT
886 struct list_head empty;
887
888 /* get endpoint and transfer/schedule data */
e9df41c5 889 epnum = urb->ep->desc.bEndpointAddress;
1da177e4
LT
890
891 spin_lock_irqsave (&ehci->lock, flags);
892
541c7d43 893 if (unlikely(!HCD_HW_ACCESSIBLE(ehci_to_hcd(ehci)))) {
8de98402 894 status = -ESHUTDOWN;
e9df41c5 895 goto done_not_linked;
8de98402 896 }
e9df41c5
AS
897 status = usb_hcd_link_urb_to_ep(ehci_to_hcd(ehci), urb);
898 if (unlikely(status))
899 goto done_not_linked;
8de98402 900
1da177e4
LT
901 /* get qh and force any scheduling errors */
902 INIT_LIST_HEAD (&empty);
e9df41c5 903 qh = qh_append_tds(ehci, urb, &empty, epnum, &urb->ep->hcpriv);
1da177e4
LT
904 if (qh == NULL) {
905 status = -ENOMEM;
906 goto done;
907 }
908 if (qh->qh_state == QH_STATE_IDLE) {
909 if ((status = qh_schedule (ehci, qh)) != 0)
910 goto done;
911 }
912
913 /* then queue the urb's tds to the qh */
e9df41c5 914 qh = qh_append_tds(ehci, urb, qtd_list, epnum, &urb->ep->hcpriv);
1da177e4
LT
915 BUG_ON (qh == NULL);
916
917 /* ... update usbfs periodic stats */
918 ehci_to_hcd(ehci)->self.bandwidth_int_reqs++;
919
920done:
e9df41c5
AS
921 if (unlikely(status))
922 usb_hcd_unlink_urb_from_ep(ehci_to_hcd(ehci), urb);
923done_not_linked:
1da177e4
LT
924 spin_unlock_irqrestore (&ehci->lock, flags);
925 if (status)
926 qtd_list_free (ehci, urb, qtd_list);
927
928 return status;
929}
930
569b394f
AS
931static void scan_intr(struct ehci_hcd *ehci)
932{
933 struct ehci_qh *qh;
934
935 list_for_each_entry_safe(qh, ehci->qh_scan_next, &ehci->intr_qh_list,
936 intr_node) {
937 rescan:
938 /* clean any finished work for this qh */
939 if (!list_empty(&qh->qtd_list)) {
940 int temp;
941
942 /*
943 * Unlinks could happen here; completion reporting
944 * drops the lock. That's why ehci->qh_scan_next
945 * always holds the next qh to scan; if the next qh
946 * gets unlinked then ehci->qh_scan_next is adjusted
947 * in qh_unlink_periodic().
948 */
949 temp = qh_completions(ehci, qh);
950 if (unlikely(qh->needs_rescan ||
951 (list_empty(&qh->qtd_list) &&
952 qh->qh_state == QH_STATE_LINKED)))
953 start_unlink_intr(ehci, qh);
954 else if (temp != 0)
955 goto rescan;
956 }
957 }
958}
959
1da177e4
LT
960/*-------------------------------------------------------------------------*/
961
962/* ehci_iso_stream ops work with both ITD and SITD */
963
964static struct ehci_iso_stream *
55016f10 965iso_stream_alloc (gfp_t mem_flags)
1da177e4
LT
966{
967 struct ehci_iso_stream *stream;
968
7b842b6e 969 stream = kzalloc(sizeof *stream, mem_flags);
1da177e4 970 if (likely (stream != NULL)) {
1da177e4
LT
971 INIT_LIST_HEAD(&stream->td_list);
972 INIT_LIST_HEAD(&stream->free_list);
973 stream->next_uframe = -1;
1da177e4
LT
974 }
975 return stream;
976}
977
978static void
979iso_stream_init (
980 struct ehci_hcd *ehci,
981 struct ehci_iso_stream *stream,
982 struct usb_device *dev,
983 int pipe,
984 unsigned interval
985)
986{
987 static const u8 smask_out [] = { 0x01, 0x03, 0x07, 0x0f, 0x1f, 0x3f };
988
989 u32 buf1;
990 unsigned epnum, maxp;
991 int is_input;
992 long bandwidth;
993
994 /*
995 * this might be a "high bandwidth" highspeed endpoint,
996 * as encoded in the ep descriptor's wMaxPacket field
997 */
998 epnum = usb_pipeendpoint (pipe);
999 is_input = usb_pipein (pipe) ? USB_DIR_IN : 0;
1000 maxp = usb_maxpacket(dev, pipe, !is_input);
1001 if (is_input) {
1002 buf1 = (1 << 11);
1003 } else {
1004 buf1 = 0;
1005 }
1006
1007 /* knows about ITD vs SITD */
1008 if (dev->speed == USB_SPEED_HIGH) {
1009 unsigned multi = hb_mult(maxp);
1010
1011 stream->highspeed = 1;
1012
1013 maxp = max_packet(maxp);
1014 buf1 |= maxp;
1015 maxp *= multi;
1016
6dbd682b
SR
1017 stream->buf0 = cpu_to_hc32(ehci, (epnum << 8) | dev->devnum);
1018 stream->buf1 = cpu_to_hc32(ehci, buf1);
1019 stream->buf2 = cpu_to_hc32(ehci, multi);
1da177e4
LT
1020
1021 /* usbfs wants to report the average usecs per frame tied up
1022 * when transfers on this endpoint are scheduled ...
1023 */
1024 stream->usecs = HS_USECS_ISO (maxp);
1025 bandwidth = stream->usecs * 8;
372dd6e8 1026 bandwidth /= interval;
1da177e4
LT
1027
1028 } else {
1029 u32 addr;
d0384200 1030 int think_time;
469d0229 1031 int hs_transfers;
1da177e4
LT
1032
1033 addr = dev->ttport << 24;
1034 if (!ehci_is_TDI(ehci)
1035 || (dev->tt->hub !=
1036 ehci_to_hcd(ehci)->self.root_hub))
1037 addr |= dev->tt->hub->devnum << 16;
1038 addr |= epnum << 8;
1039 addr |= dev->devnum;
1040 stream->usecs = HS_USECS_ISO (maxp);
d0384200 1041 think_time = dev->tt ? dev->tt->think_time : 0;
1042 stream->tt_usecs = NS_TO_US (think_time + usb_calc_bus_time (
1043 dev->speed, is_input, 1, maxp));
469d0229 1044 hs_transfers = max (1u, (maxp + 187) / 188);
1da177e4
LT
1045 if (is_input) {
1046 u32 tmp;
1047
1048 addr |= 1 << 31;
1049 stream->c_usecs = stream->usecs;
1050 stream->usecs = HS_USECS_ISO (1);
1051 stream->raw_mask = 1;
1052
469d0229
CL
1053 /* c-mask as specified in USB 2.0 11.18.4 3.c */
1054 tmp = (1 << (hs_transfers + 2)) - 1;
1055 stream->raw_mask |= tmp << (8 + 2);
1da177e4 1056 } else
469d0229 1057 stream->raw_mask = smask_out [hs_transfers - 1];
1da177e4 1058 bandwidth = stream->usecs + stream->c_usecs;
372dd6e8 1059 bandwidth /= interval << 3;
1da177e4
LT
1060
1061 /* stream->splits gets created from raw_mask later */
6dbd682b 1062 stream->address = cpu_to_hc32(ehci, addr);
1da177e4
LT
1063 }
1064 stream->bandwidth = bandwidth;
1065
1066 stream->udev = dev;
1067
1068 stream->bEndpointAddress = is_input | epnum;
1069 stream->interval = interval;
1070 stream->maxp = maxp;
1071}
1072
1da177e4
LT
1073static struct ehci_iso_stream *
1074iso_stream_find (struct ehci_hcd *ehci, struct urb *urb)
1075{
1076 unsigned epnum;
1077 struct ehci_iso_stream *stream;
1078 struct usb_host_endpoint *ep;
1079 unsigned long flags;
1080
1081 epnum = usb_pipeendpoint (urb->pipe);
1082 if (usb_pipein(urb->pipe))
1083 ep = urb->dev->ep_in[epnum];
1084 else
1085 ep = urb->dev->ep_out[epnum];
1086
1087 spin_lock_irqsave (&ehci->lock, flags);
1088 stream = ep->hcpriv;
1089
1090 if (unlikely (stream == NULL)) {
1091 stream = iso_stream_alloc(GFP_ATOMIC);
1092 if (likely (stream != NULL)) {
1da177e4
LT
1093 ep->hcpriv = stream;
1094 stream->ep = ep;
1095 iso_stream_init(ehci, stream, urb->dev, urb->pipe,
1096 urb->interval);
1097 }
1098
1082f57a
CL
1099 /* if dev->ep [epnum] is a QH, hw is set */
1100 } else if (unlikely (stream->hw != NULL)) {
1da177e4
LT
1101 ehci_dbg (ehci, "dev %s ep%d%s, not iso??\n",
1102 urb->dev->devpath, epnum,
1103 usb_pipein(urb->pipe) ? "in" : "out");
1104 stream = NULL;
1105 }
1106
1da177e4
LT
1107 spin_unlock_irqrestore (&ehci->lock, flags);
1108 return stream;
1109}
1110
1111/*-------------------------------------------------------------------------*/
1112
1113/* ehci_iso_sched ops can be ITD-only or SITD-only */
1114
1115static struct ehci_iso_sched *
55016f10 1116iso_sched_alloc (unsigned packets, gfp_t mem_flags)
1da177e4
LT
1117{
1118 struct ehci_iso_sched *iso_sched;
1119 int size = sizeof *iso_sched;
1120
1121 size += packets * sizeof (struct ehci_iso_packet);
80b6ca48 1122 iso_sched = kzalloc(size, mem_flags);
1da177e4 1123 if (likely (iso_sched != NULL)) {
1da177e4
LT
1124 INIT_LIST_HEAD (&iso_sched->td_list);
1125 }
1126 return iso_sched;
1127}
1128
1129static inline void
6dbd682b
SR
1130itd_sched_init(
1131 struct ehci_hcd *ehci,
1da177e4
LT
1132 struct ehci_iso_sched *iso_sched,
1133 struct ehci_iso_stream *stream,
1134 struct urb *urb
1135)
1136{
1137 unsigned i;
1138 dma_addr_t dma = urb->transfer_dma;
1139
1140 /* how many uframes are needed for these transfers */
1141 iso_sched->span = urb->number_of_packets * stream->interval;
1142
1143 /* figure out per-uframe itd fields that we'll need later
1144 * when we fit new itds into the schedule.
1145 */
1146 for (i = 0; i < urb->number_of_packets; i++) {
1147 struct ehci_iso_packet *uframe = &iso_sched->packet [i];
1148 unsigned length;
1149 dma_addr_t buf;
1150 u32 trans;
1151
1152 length = urb->iso_frame_desc [i].length;
1153 buf = dma + urb->iso_frame_desc [i].offset;
1154
1155 trans = EHCI_ISOC_ACTIVE;
1156 trans |= buf & 0x0fff;
1157 if (unlikely (((i + 1) == urb->number_of_packets))
1158 && !(urb->transfer_flags & URB_NO_INTERRUPT))
1159 trans |= EHCI_ITD_IOC;
1160 trans |= length << 16;
6dbd682b 1161 uframe->transaction = cpu_to_hc32(ehci, trans);
1da177e4 1162
77078570 1163 /* might need to cross a buffer page within a uframe */
1da177e4
LT
1164 uframe->bufp = (buf & ~(u64)0x0fff);
1165 buf += length;
1166 if (unlikely ((uframe->bufp != (buf & ~(u64)0x0fff))))
1167 uframe->cross = 1;
1168 }
1169}
1170
1171static void
1172iso_sched_free (
1173 struct ehci_iso_stream *stream,
1174 struct ehci_iso_sched *iso_sched
1175)
1176{
1177 if (!iso_sched)
1178 return;
1179 // caller must hold ehci->lock!
1180 list_splice (&iso_sched->td_list, &stream->free_list);
1181 kfree (iso_sched);
1182}
1183
1184static int
1185itd_urb_transaction (
1186 struct ehci_iso_stream *stream,
1187 struct ehci_hcd *ehci,
1188 struct urb *urb,
55016f10 1189 gfp_t mem_flags
1da177e4
LT
1190)
1191{
1192 struct ehci_itd *itd;
1193 dma_addr_t itd_dma;
1194 int i;
1195 unsigned num_itds;
1196 struct ehci_iso_sched *sched;
1197 unsigned long flags;
1198
1199 sched = iso_sched_alloc (urb->number_of_packets, mem_flags);
1200 if (unlikely (sched == NULL))
1201 return -ENOMEM;
1202
6dbd682b 1203 itd_sched_init(ehci, sched, stream, urb);
1da177e4
LT
1204
1205 if (urb->interval < 8)
1206 num_itds = 1 + (sched->span + 7) / 8;
1207 else
1208 num_itds = urb->number_of_packets;
1209
1210 /* allocate/init ITDs */
1211 spin_lock_irqsave (&ehci->lock, flags);
1212 for (i = 0; i < num_itds; i++) {
1213
55934eb3
AS
1214 /*
1215 * Use iTDs from the free list, but not iTDs that may
1216 * still be in use by the hardware.
1da177e4 1217 */
55934eb3
AS
1218 if (likely(!list_empty(&stream->free_list))) {
1219 itd = list_first_entry(&stream->free_list,
6dbd682b 1220 struct ehci_itd, itd_list);
f4289078 1221 if (itd->frame == ehci->now_frame)
55934eb3 1222 goto alloc_itd;
1da177e4
LT
1223 list_del (&itd->itd_list);
1224 itd_dma = itd->itd_dma;
3d01f0fe 1225 } else {
55934eb3 1226 alloc_itd:
1da177e4
LT
1227 spin_unlock_irqrestore (&ehci->lock, flags);
1228 itd = dma_pool_alloc (ehci->itd_pool, mem_flags,
1229 &itd_dma);
1230 spin_lock_irqsave (&ehci->lock, flags);
3d01f0fe
KW
1231 if (!itd) {
1232 iso_sched_free(stream, sched);
1233 spin_unlock_irqrestore(&ehci->lock, flags);
1234 return -ENOMEM;
1235 }
1da177e4
LT
1236 }
1237
1da177e4
LT
1238 memset (itd, 0, sizeof *itd);
1239 itd->itd_dma = itd_dma;
1240 list_add (&itd->itd_list, &sched->td_list);
1241 }
1242 spin_unlock_irqrestore (&ehci->lock, flags);
1243
1244 /* temporarily store schedule info in hcpriv */
1245 urb->hcpriv = sched;
1246 urb->error_count = 0;
1247 return 0;
1248}
1249
1250/*-------------------------------------------------------------------------*/
1251
1252static inline int
1253itd_slot_ok (
1254 struct ehci_hcd *ehci,
1255 u32 mod,
1256 u32 uframe,
1257 u8 usecs,
1258 u32 period
1259)
1260{
1261 uframe %= period;
1262 do {
cc62a7eb 1263 /* can't commit more than uframe_periodic_max usec */
1da177e4 1264 if (periodic_usecs (ehci, uframe >> 3, uframe & 0x7)
cc62a7eb 1265 > (ehci->uframe_periodic_max - usecs))
1da177e4
LT
1266 return 0;
1267
1268 /* we know urb->interval is 2^N uframes */
1269 uframe += period;
1270 } while (uframe < mod);
1271 return 1;
1272}
1273
1274static inline int
1275sitd_slot_ok (
1276 struct ehci_hcd *ehci,
1277 u32 mod,
1278 struct ehci_iso_stream *stream,
1279 u32 uframe,
1280 struct ehci_iso_sched *sched,
1281 u32 period_uframes
1282)
1283{
1284 u32 mask, tmp;
1285 u32 frame, uf;
1286
1287 mask = stream->raw_mask << (uframe & 7);
1288
1289 /* for IN, don't wrap CSPLIT into the next frame */
1290 if (mask & ~0xffff)
1291 return 0;
1292
65b8e5cb
AS
1293 /* check bandwidth */
1294 uframe %= period_uframes;
1295 frame = uframe >> 3;
1296
1297#ifdef CONFIG_USB_EHCI_TT_NEWSCHED
1298 /* The tt's fullspeed bus bandwidth must be available.
1299 * tt_available scheduling guarantees 10+% for control/bulk.
1300 */
1301 uf = uframe & 7;
1302 if (!tt_available(ehci, period_uframes >> 3,
1303 stream->udev, frame, uf, stream->tt_usecs))
1304 return 0;
1305#else
1306 /* tt must be idle for start(s), any gap, and csplit.
1307 * assume scheduling slop leaves 10+% for control/bulk.
1308 */
1309 if (!tt_no_collision(ehci, period_uframes >> 3,
1310 stream->udev, frame, mask))
1311 return 0;
1312#endif
1313
1da177e4
LT
1314 /* this multi-pass logic is simple, but performance may
1315 * suffer when the schedule data isn't cached.
1316 */
1da177e4
LT
1317 do {
1318 u32 max_used;
1319
1320 frame = uframe >> 3;
1321 uf = uframe & 7;
1322
1da177e4 1323 /* check starts (OUT uses more than one) */
cc62a7eb 1324 max_used = ehci->uframe_periodic_max - stream->usecs;
1da177e4
LT
1325 for (tmp = stream->raw_mask & 0xff; tmp; tmp >>= 1, uf++) {
1326 if (periodic_usecs (ehci, frame, uf) > max_used)
1327 return 0;
1328 }
1329
1330 /* for IN, check CSPLIT */
1331 if (stream->c_usecs) {
0c734622 1332 uf = uframe & 7;
cc62a7eb 1333 max_used = ehci->uframe_periodic_max - stream->c_usecs;
1da177e4
LT
1334 do {
1335 tmp = 1 << uf;
1336 tmp <<= 8;
1337 if ((stream->raw_mask & tmp) == 0)
1338 continue;
1339 if (periodic_usecs (ehci, frame, uf)
1340 > max_used)
1341 return 0;
1342 } while (++uf < 8);
1343 }
1344
1345 /* we know urb->interval is 2^N uframes */
1346 uframe += period_uframes;
1347 } while (uframe < mod);
1348
6dbd682b 1349 stream->splits = cpu_to_hc32(ehci, stream->raw_mask << (uframe & 7));
1da177e4
LT
1350 return 1;
1351}
1352
1353/*
1354 * This scheduler plans almost as far into the future as it has actual
1355 * periodic schedule slots. (Affected by TUNE_FLS, which defaults to
1356 * "as small as possible" to be cache-friendlier.) That limits the size
1357 * transfers you can stream reliably; avoid more than 64 msec per urb.
1358 * Also avoid queue depths of less than ehci's worst irq latency (affected
1359 * by the per-urb URB_NO_INTERRUPT hint, the log2_irq_thresh module parameter,
1360 * and other factors); or more than about 230 msec total (for portability,
1361 * given EHCI_TUNE_FLS and the slop). Or, write a smarter scheduler!
1362 */
1363
c3ee9b76 1364#define SCHEDULING_DELAY 40 /* microframes */
1da177e4
LT
1365
1366static int
1367iso_stream_schedule (
1368 struct ehci_hcd *ehci,
1369 struct urb *urb,
1370 struct ehci_iso_stream *stream
1371)
1372{
c3ee9b76 1373 u32 now, base, next, start, period, span;
1da177e4
LT
1374 int status;
1375 unsigned mod = ehci->periodic_size << 3;
1376 struct ehci_iso_sched *sched = urb->hcpriv;
1377
ffda0803
AS
1378 period = urb->interval;
1379 span = sched->span;
1380 if (!stream->highspeed) {
1381 period <<= 3;
1382 span <<= 3;
1383 }
1384
68aa95d5 1385 now = ehci_read_frame_index(ehci) & (mod - 1);
1da177e4 1386
b40e43fc
AS
1387 /* Typical case: reuse current schedule, stream is still active.
1388 * Hopefully there are no gaps from the host falling behind
1389 * (irq delays etc), but if there are we'll take the next
1390 * slot in the schedule, implicitly assuming URB_ISO_ASAP.
1da177e4
LT
1391 */
1392 if (likely (!list_empty (&stream->td_list))) {
dccd574c 1393
98cae42d
AS
1394 /* Take the isochronous scheduling threshold into account */
1395 if (ehci->i_thresh)
1396 next = now + ehci->i_thresh; /* uframe cache */
dccd574c 1397 else
98cae42d 1398 next = (now + 2 + 7) & ~0x07; /* full frame cache */
b40e43fc 1399
c3ee9b76
AS
1400 /*
1401 * Use ehci->last_iso_frame as the base. There can't be any
1402 * TDs scheduled for earlier than that.
1fb2e055 1403 */
c3ee9b76
AS
1404 base = ehci->last_iso_frame << 3;
1405 next = (next - base) & (mod - 1);
1406 start = (stream->next_uframe - base) & (mod - 1);
1407
1408 /* Is the schedule already full? */
1409 if (unlikely(start < period)) {
1410 ehci_dbg(ehci, "iso sched full %p (%u-%u < %u mod %u)\n",
1411 urb, stream->next_uframe, base,
1412 period, mod);
1413 status = -ENOSPC;
b40e43fc
AS
1414 goto fail;
1415 }
c3ee9b76
AS
1416
1417 /* Behind the scheduling threshold? Assume URB_ISO_ASAP. */
1418 if (unlikely(start < next))
72675479 1419 start += (next - start + period - 1) & (- period);
c3ee9b76
AS
1420
1421 start += base;
1da177e4
LT
1422 }
1423
1424 /* need to schedule; when's the next (u)frame we could start?
1425 * this is bigger than ehci->i_thresh allows; scheduling itself
c3ee9b76 1426 * isn't free, the delay should handle reasonably slow cpus. it
1da177e4
LT
1427 * can also help high bandwidth if the dma and irq loads don't
1428 * jump until after the queue is primed.
1429 */
1fb2e055 1430 else {
e3420901 1431 int done = 0;
1fb2e055 1432
c3ee9b76
AS
1433 base = now & ~0x07;
1434 start = base + SCHEDULING_DELAY;
1fb2e055 1435
811c926c
TP
1436 /* find a uframe slot with enough bandwidth.
1437 * Early uframes are more precious because full-speed
1438 * iso IN transfers can't use late uframes,
1439 * and therefore they should be allocated last.
1440 */
1441 next = start;
1442 start += period;
1443 do {
1444 start--;
1fb2e055
AS
1445 /* check schedule: enough space? */
1446 if (stream->highspeed) {
1447 if (itd_slot_ok(ehci, mod, start,
1448 stream->usecs, period))
e3420901 1449 done = 1;
1fb2e055
AS
1450 } else {
1451 if ((start % 8) >= 6)
1452 continue;
1453 if (sitd_slot_ok(ehci, mod, stream,
1454 start, sched, period))
e3420901 1455 done = 1;
1fb2e055 1456 }
e3420901 1457 } while (start > next && !done);
1da177e4 1458
1fb2e055 1459 /* no room in the schedule */
e3420901 1460 if (!done) {
c3ee9b76 1461 ehci_dbg(ehci, "iso sched full %p", urb);
1fb2e055
AS
1462 status = -ENOSPC;
1463 goto fail;
1da177e4
LT
1464 }
1465 }
1466
1fb2e055 1467 /* Tried to schedule too far into the future? */
c3ee9b76
AS
1468 if (unlikely(start - base + span - period >= mod)) {
1469 ehci_dbg(ehci, "request %p would overflow (%u+%u >= %u)\n",
1470 urb, start - base, span - period, mod);
1fb2e055
AS
1471 status = -EFBIG;
1472 goto fail;
1473 }
1da177e4 1474
1fb2e055 1475 stream->next_uframe = start & (mod - 1);
1da177e4 1476
1da177e4
LT
1477 /* report high speed start in uframes; full speed, in frames */
1478 urb->start_frame = stream->next_uframe;
1479 if (!stream->highspeed)
1480 urb->start_frame >>= 3;
569b394f
AS
1481
1482 /* Make sure scan_isoc() sees these */
1483 if (ehci->isoc_count == 0)
c3ee9b76 1484 ehci->last_iso_frame = now >> 3;
1da177e4 1485 return 0;
1fb2e055
AS
1486
1487 fail:
1488 iso_sched_free(stream, sched);
1489 urb->hcpriv = NULL;
1490 return status;
1da177e4
LT
1491}
1492
1493/*-------------------------------------------------------------------------*/
1494
1495static inline void
6dbd682b
SR
1496itd_init(struct ehci_hcd *ehci, struct ehci_iso_stream *stream,
1497 struct ehci_itd *itd)
1da177e4
LT
1498{
1499 int i;
1500
77078570 1501 /* it's been recently zeroed */
6dbd682b 1502 itd->hw_next = EHCI_LIST_END(ehci);
1da177e4
LT
1503 itd->hw_bufp [0] = stream->buf0;
1504 itd->hw_bufp [1] = stream->buf1;
1505 itd->hw_bufp [2] = stream->buf2;
1506
1507 for (i = 0; i < 8; i++)
1508 itd->index[i] = -1;
1509
1510 /* All other fields are filled when scheduling */
1511}
1512
1513static inline void
6dbd682b
SR
1514itd_patch(
1515 struct ehci_hcd *ehci,
1da177e4
LT
1516 struct ehci_itd *itd,
1517 struct ehci_iso_sched *iso_sched,
1518 unsigned index,
77078570 1519 u16 uframe
1da177e4
LT
1520)
1521{
1522 struct ehci_iso_packet *uf = &iso_sched->packet [index];
1523 unsigned pg = itd->pg;
1524
1525 // BUG_ON (pg == 6 && uf->cross);
1526
1527 uframe &= 0x07;
1528 itd->index [uframe] = index;
1529
6dbd682b
SR
1530 itd->hw_transaction[uframe] = uf->transaction;
1531 itd->hw_transaction[uframe] |= cpu_to_hc32(ehci, pg << 12);
1532 itd->hw_bufp[pg] |= cpu_to_hc32(ehci, uf->bufp & ~(u32)0);
1533 itd->hw_bufp_hi[pg] |= cpu_to_hc32(ehci, (u32)(uf->bufp >> 32));
1da177e4
LT
1534
1535 /* iso_frame_desc[].offset must be strictly increasing */
77078570 1536 if (unlikely (uf->cross)) {
1da177e4 1537 u64 bufp = uf->bufp + 4096;
6dbd682b 1538
1da177e4 1539 itd->pg = ++pg;
6dbd682b
SR
1540 itd->hw_bufp[pg] |= cpu_to_hc32(ehci, bufp & ~(u32)0);
1541 itd->hw_bufp_hi[pg] |= cpu_to_hc32(ehci, (u32)(bufp >> 32));
1da177e4
LT
1542 }
1543}
1544
1545static inline void
1546itd_link (struct ehci_hcd *ehci, unsigned frame, struct ehci_itd *itd)
1547{
92bc3648
CL
1548 union ehci_shadow *prev = &ehci->pshadow[frame];
1549 __hc32 *hw_p = &ehci->periodic[frame];
1550 union ehci_shadow here = *prev;
1551 __hc32 type = 0;
1552
1553 /* skip any iso nodes which might belong to previous microframes */
1554 while (here.ptr) {
1555 type = Q_NEXT_TYPE(ehci, *hw_p);
1556 if (type == cpu_to_hc32(ehci, Q_TYPE_QH))
1557 break;
1558 prev = periodic_next_shadow(ehci, prev, type);
1559 hw_p = shadow_next_periodic(ehci, &here, type);
1560 here = *prev;
1561 }
1562
1563 itd->itd_next = here;
1564 itd->hw_next = *hw_p;
1565 prev->itd = itd;
1da177e4
LT
1566 itd->frame = frame;
1567 wmb ();
92bc3648 1568 *hw_p = cpu_to_hc32(ehci, itd->itd_dma | Q_TYPE_ITD);
1da177e4
LT
1569}
1570
1571/* fit urb's itds into the selected schedule slot; activate as needed */
b015cb79 1572static void itd_link_urb(
1da177e4
LT
1573 struct ehci_hcd *ehci,
1574 struct urb *urb,
1575 unsigned mod,
1576 struct ehci_iso_stream *stream
1577)
1578{
77078570 1579 int packet;
1da177e4
LT
1580 unsigned next_uframe, uframe, frame;
1581 struct ehci_iso_sched *iso_sched = urb->hcpriv;
1582 struct ehci_itd *itd;
1583
bccbefaa 1584 next_uframe = stream->next_uframe & (mod - 1);
1da177e4
LT
1585
1586 if (unlikely (list_empty(&stream->td_list))) {
1587 ehci_to_hcd(ehci)->self.bandwidth_allocated
1588 += stream->bandwidth;
1589 ehci_vdbg (ehci,
1590 "schedule devp %s ep%d%s-iso period %d start %d.%d\n",
1591 urb->dev->devpath, stream->bEndpointAddress & 0x0f,
1592 (stream->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
1593 urb->interval,
1594 next_uframe >> 3, next_uframe & 0x7);
1da177e4 1595 }
05570297
AH
1596
1597 if (ehci_to_hcd(ehci)->self.bandwidth_isoc_reqs == 0) {
ad93562b
AX
1598 if (ehci->amd_pll_fix == 1)
1599 usb_amd_quirk_pll_disable();
05570297
AH
1600 }
1601
1da177e4
LT
1602 ehci_to_hcd(ehci)->self.bandwidth_isoc_reqs++;
1603
1604 /* fill iTDs uframe by uframe */
1605 for (packet = 0, itd = NULL; packet < urb->number_of_packets; ) {
1606 if (itd == NULL) {
1607 /* ASSERT: we have all necessary itds */
1608 // BUG_ON (list_empty (&iso_sched->td_list));
1609
1610 /* ASSERT: no itds for this endpoint in this uframe */
1611
1612 itd = list_entry (iso_sched->td_list.next,
1613 struct ehci_itd, itd_list);
1614 list_move_tail (&itd->itd_list, &stream->td_list);
8c5bf7be 1615 itd->stream = stream;
508db8c9 1616 itd->urb = urb;
6dbd682b 1617 itd_init (ehci, stream, itd);
1da177e4
LT
1618 }
1619
1620 uframe = next_uframe & 0x07;
1621 frame = next_uframe >> 3;
1622
6dbd682b 1623 itd_patch(ehci, itd, iso_sched, packet, uframe);
1da177e4
LT
1624
1625 next_uframe += stream->interval;
bccbefaa 1626 next_uframe &= mod - 1;
1da177e4
LT
1627 packet++;
1628
1629 /* link completed itds into the schedule */
1630 if (((next_uframe >> 3) != frame)
1631 || packet == urb->number_of_packets) {
bccbefaa 1632 itd_link(ehci, frame & (ehci->periodic_size - 1), itd);
1da177e4
LT
1633 itd = NULL;
1634 }
1635 }
1636 stream->next_uframe = next_uframe;
1637
1638 /* don't need that schedule data any more */
1639 iso_sched_free (stream, iso_sched);
1640 urb->hcpriv = NULL;
1641
569b394f 1642 ++ehci->isoc_count;
b015cb79 1643 enable_periodic(ehci);
1da177e4
LT
1644}
1645
1646#define ISO_ERRS (EHCI_ISOC_BUF_ERR | EHCI_ISOC_BABBLE | EHCI_ISOC_XACTERR)
1647
30bf54e6
DB
1648/* Process and recycle a completed ITD. Return true iff its urb completed,
1649 * and hence its completion callback probably added things to the hardware
1650 * schedule.
1651 *
1652 * Note that we carefully avoid recycling this descriptor until after any
1653 * completion callback runs, so that it won't be reused quickly. That is,
1654 * assuming (a) no more than two urbs per frame on this endpoint, and also
1655 * (b) only this endpoint's completions submit URBs. It seems some silicon
1656 * corrupts things if you reuse completed descriptors very quickly...
1657 */
f4289078
AS
1658static bool itd_complete(struct ehci_hcd *ehci, struct ehci_itd *itd)
1659{
1da177e4
LT
1660 struct urb *urb = itd->urb;
1661 struct usb_iso_packet_descriptor *desc;
1662 u32 t;
1663 unsigned uframe;
1664 int urb_index = -1;
1665 struct ehci_iso_stream *stream = itd->stream;
1666 struct usb_device *dev;
f4289078 1667 bool retval = false;
1da177e4
LT
1668
1669 /* for each uframe with a packet */
1670 for (uframe = 0; uframe < 8; uframe++) {
1671 if (likely (itd->index[uframe] == -1))
1672 continue;
1673 urb_index = itd->index[uframe];
1674 desc = &urb->iso_frame_desc [urb_index];
1675
6dbd682b 1676 t = hc32_to_cpup(ehci, &itd->hw_transaction [uframe]);
1da177e4 1677 itd->hw_transaction [uframe] = 0;
1da177e4
LT
1678
1679 /* report transfer status */
1680 if (unlikely (t & ISO_ERRS)) {
1681 urb->error_count++;
1682 if (t & EHCI_ISOC_BUF_ERR)
1683 desc->status = usb_pipein (urb->pipe)
1684 ? -ENOSR /* hc couldn't read */
1685 : -ECOMM; /* hc couldn't write */
1686 else if (t & EHCI_ISOC_BABBLE)
1687 desc->status = -EOVERFLOW;
1688 else /* (t & EHCI_ISOC_XACTERR) */
1689 desc->status = -EPROTO;
1690
1691 /* HC need not update length with this error */
ec6d67e3
AS
1692 if (!(t & EHCI_ISOC_BABBLE)) {
1693 desc->actual_length = EHCI_ITD_LENGTH(t);
1694 urb->actual_length += desc->actual_length;
1695 }
1da177e4
LT
1696 } else if (likely ((t & EHCI_ISOC_ACTIVE) == 0)) {
1697 desc->status = 0;
ec6d67e3
AS
1698 desc->actual_length = EHCI_ITD_LENGTH(t);
1699 urb->actual_length += desc->actual_length;
b40e43fc
AS
1700 } else {
1701 /* URB was too late */
1702 desc->status = -EXDEV;
1da177e4
LT
1703 }
1704 }
1705
1da177e4
LT
1706 /* handle completion now? */
1707 if (likely ((urb_index + 1) != urb->number_of_packets))
30bf54e6 1708 goto done;
1da177e4
LT
1709
1710 /* ASSERT: it's really the last itd for this urb
1711 list_for_each_entry (itd, &stream->td_list, itd_list)
1712 BUG_ON (itd->urb == urb);
1713 */
1714
aa16ca30 1715 /* give urb back to the driver; completion often (re)submits */
6a8e87b2 1716 dev = urb->dev;
14c04c0f 1717 ehci_urb_done(ehci, urb, 0);
30bf54e6 1718 retval = true;
1da177e4 1719 urb = NULL;
569b394f
AS
1720
1721 --ehci->isoc_count;
b015cb79 1722 disable_periodic(ehci);
1da177e4 1723
569b394f 1724 ehci_to_hcd(ehci)->self.bandwidth_isoc_reqs--;
05570297 1725 if (ehci_to_hcd(ehci)->self.bandwidth_isoc_reqs == 0) {
ad93562b
AX
1726 if (ehci->amd_pll_fix == 1)
1727 usb_amd_quirk_pll_enable();
05570297
AH
1728 }
1729
508db8c9 1730 if (unlikely(list_is_singular(&stream->td_list))) {
1da177e4
LT
1731 ehci_to_hcd(ehci)->self.bandwidth_allocated
1732 -= stream->bandwidth;
1733 ehci_vdbg (ehci,
1734 "deschedule devp %s ep%d%s-iso\n",
1735 dev->devpath, stream->bEndpointAddress & 0x0f,
1736 (stream->bEndpointAddress & USB_DIR_IN) ? "in" : "out");
1737 }
9aa09d2f 1738
30bf54e6 1739done:
30bf54e6 1740 itd->urb = NULL;
55934eb3
AS
1741
1742 /* Add to the end of the free list for later reuse */
1743 list_move_tail(&itd->itd_list, &stream->free_list);
1744
1745 /* Recycle the iTDs when the pipeline is empty (ep no longer in use) */
1746 if (list_empty(&stream->td_list)) {
1747 list_splice_tail_init(&stream->free_list,
1748 &ehci->cached_itd_list);
1749 start_free_itds(ehci);
9aa09d2f 1750 }
55934eb3 1751
30bf54e6 1752 return retval;
1da177e4
LT
1753}
1754
1755/*-------------------------------------------------------------------------*/
1756
5db539e4 1757static int itd_submit (struct ehci_hcd *ehci, struct urb *urb,
55016f10 1758 gfp_t mem_flags)
1da177e4
LT
1759{
1760 int status = -EINVAL;
1761 unsigned long flags;
1762 struct ehci_iso_stream *stream;
1763
1764 /* Get iso_stream head */
1765 stream = iso_stream_find (ehci, urb);
1766 if (unlikely (stream == NULL)) {
1767 ehci_dbg (ehci, "can't get iso stream\n");
1768 return -ENOMEM;
1769 }
1770 if (unlikely (urb->interval != stream->interval)) {
1771 ehci_dbg (ehci, "can't change iso interval %d --> %d\n",
1772 stream->interval, urb->interval);
1773 goto done;
1774 }
1775
1776#ifdef EHCI_URB_TRACE
1777 ehci_dbg (ehci,
1778 "%s %s urb %p ep%d%s len %d, %d pkts %d uframes [%p]\n",
441b62c1 1779 __func__, urb->dev->devpath, urb,
1da177e4
LT
1780 usb_pipeendpoint (urb->pipe),
1781 usb_pipein (urb->pipe) ? "in" : "out",
1782 urb->transfer_buffer_length,
1783 urb->number_of_packets, urb->interval,
1784 stream);
1785#endif
1786
1787 /* allocate ITDs w/o locking anything */
1788 status = itd_urb_transaction (stream, ehci, urb, mem_flags);
1789 if (unlikely (status < 0)) {
1790 ehci_dbg (ehci, "can't init itds\n");
1791 goto done;
1792 }
1793
1794 /* schedule ... need to lock */
1795 spin_lock_irqsave (&ehci->lock, flags);
541c7d43 1796 if (unlikely(!HCD_HW_ACCESSIBLE(ehci_to_hcd(ehci)))) {
8de98402 1797 status = -ESHUTDOWN;
e9df41c5
AS
1798 goto done_not_linked;
1799 }
1800 status = usb_hcd_link_urb_to_ep(ehci_to_hcd(ehci), urb);
1801 if (unlikely(status))
1802 goto done_not_linked;
1803 status = iso_stream_schedule(ehci, urb, stream);
53bd6a60 1804 if (likely (status == 0))
1da177e4 1805 itd_link_urb (ehci, urb, ehci->periodic_size << 3, stream);
e9df41c5
AS
1806 else
1807 usb_hcd_unlink_urb_from_ep(ehci_to_hcd(ehci), urb);
8c5bf7be 1808 done_not_linked:
1da177e4 1809 spin_unlock_irqrestore (&ehci->lock, flags);
8c5bf7be 1810 done:
1da177e4
LT
1811 return status;
1812}
1813
1da177e4
LT
1814/*-------------------------------------------------------------------------*/
1815
1816/*
1817 * "Split ISO TDs" ... used for USB 1.1 devices going through the
1818 * TTs in USB 2.0 hubs. These need microframe scheduling.
1819 */
1820
1821static inline void
6dbd682b
SR
1822sitd_sched_init(
1823 struct ehci_hcd *ehci,
1da177e4
LT
1824 struct ehci_iso_sched *iso_sched,
1825 struct ehci_iso_stream *stream,
1826 struct urb *urb
1827)
1828{
1829 unsigned i;
1830 dma_addr_t dma = urb->transfer_dma;
1831
1832 /* how many frames are needed for these transfers */
1833 iso_sched->span = urb->number_of_packets * stream->interval;
1834
1835 /* figure out per-frame sitd fields that we'll need later
1836 * when we fit new sitds into the schedule.
1837 */
1838 for (i = 0; i < urb->number_of_packets; i++) {
1839 struct ehci_iso_packet *packet = &iso_sched->packet [i];
1840 unsigned length;
1841 dma_addr_t buf;
1842 u32 trans;
1843
1844 length = urb->iso_frame_desc [i].length & 0x03ff;
1845 buf = dma + urb->iso_frame_desc [i].offset;
1846
1847 trans = SITD_STS_ACTIVE;
1848 if (((i + 1) == urb->number_of_packets)
1849 && !(urb->transfer_flags & URB_NO_INTERRUPT))
1850 trans |= SITD_IOC;
1851 trans |= length << 16;
6dbd682b 1852 packet->transaction = cpu_to_hc32(ehci, trans);
1da177e4
LT
1853
1854 /* might need to cross a buffer page within a td */
1855 packet->bufp = buf;
1856 packet->buf1 = (buf + length) & ~0x0fff;
1857 if (packet->buf1 != (buf & ~(u64)0x0fff))
1858 packet->cross = 1;
1859
53bd6a60 1860 /* OUT uses multiple start-splits */
1da177e4
LT
1861 if (stream->bEndpointAddress & USB_DIR_IN)
1862 continue;
1863 length = (length + 187) / 188;
1864 if (length > 1) /* BEGIN vs ALL */
1865 length |= 1 << 3;
1866 packet->buf1 |= length;
1867 }
1868}
1869
1870static int
1871sitd_urb_transaction (
1872 struct ehci_iso_stream *stream,
1873 struct ehci_hcd *ehci,
1874 struct urb *urb,
55016f10 1875 gfp_t mem_flags
1da177e4
LT
1876)
1877{
1878 struct ehci_sitd *sitd;
1879 dma_addr_t sitd_dma;
1880 int i;
1881 struct ehci_iso_sched *iso_sched;
1882 unsigned long flags;
1883
1884 iso_sched = iso_sched_alloc (urb->number_of_packets, mem_flags);
1885 if (iso_sched == NULL)
1886 return -ENOMEM;
1887
6dbd682b 1888 sitd_sched_init(ehci, iso_sched, stream, urb);
1da177e4
LT
1889
1890 /* allocate/init sITDs */
1891 spin_lock_irqsave (&ehci->lock, flags);
1892 for (i = 0; i < urb->number_of_packets; i++) {
1893
1894 /* NOTE: for now, we don't try to handle wraparound cases
1895 * for IN (using sitd->hw_backpointer, like a FSTN), which
1896 * means we never need two sitds for full speed packets.
1897 */
1898
55934eb3
AS
1899 /*
1900 * Use siTDs from the free list, but not siTDs that may
1901 * still be in use by the hardware.
1da177e4 1902 */
55934eb3
AS
1903 if (likely(!list_empty(&stream->free_list))) {
1904 sitd = list_first_entry(&stream->free_list,
1da177e4 1905 struct ehci_sitd, sitd_list);
f4289078 1906 if (sitd->frame == ehci->now_frame)
55934eb3 1907 goto alloc_sitd;
1da177e4
LT
1908 list_del (&sitd->sitd_list);
1909 sitd_dma = sitd->sitd_dma;
3d01f0fe 1910 } else {
55934eb3 1911 alloc_sitd:
1da177e4
LT
1912 spin_unlock_irqrestore (&ehci->lock, flags);
1913 sitd = dma_pool_alloc (ehci->sitd_pool, mem_flags,
1914 &sitd_dma);
1915 spin_lock_irqsave (&ehci->lock, flags);
3d01f0fe
KW
1916 if (!sitd) {
1917 iso_sched_free(stream, iso_sched);
1918 spin_unlock_irqrestore(&ehci->lock, flags);
1919 return -ENOMEM;
1920 }
1da177e4
LT
1921 }
1922
1da177e4
LT
1923 memset (sitd, 0, sizeof *sitd);
1924 sitd->sitd_dma = sitd_dma;
1925 list_add (&sitd->sitd_list, &iso_sched->td_list);
1926 }
1927
1928 /* temporarily store schedule info in hcpriv */
1929 urb->hcpriv = iso_sched;
1930 urb->error_count = 0;
1931
1932 spin_unlock_irqrestore (&ehci->lock, flags);
1933 return 0;
1934}
1935
1936/*-------------------------------------------------------------------------*/
1937
1938static inline void
6dbd682b
SR
1939sitd_patch(
1940 struct ehci_hcd *ehci,
1da177e4
LT
1941 struct ehci_iso_stream *stream,
1942 struct ehci_sitd *sitd,
1943 struct ehci_iso_sched *iso_sched,
1944 unsigned index
1945)
1946{
1947 struct ehci_iso_packet *uf = &iso_sched->packet [index];
1948 u64 bufp = uf->bufp;
1949
6dbd682b 1950 sitd->hw_next = EHCI_LIST_END(ehci);
1da177e4
LT
1951 sitd->hw_fullspeed_ep = stream->address;
1952 sitd->hw_uframe = stream->splits;
1953 sitd->hw_results = uf->transaction;
6dbd682b 1954 sitd->hw_backpointer = EHCI_LIST_END(ehci);
1da177e4
LT
1955
1956 bufp = uf->bufp;
6dbd682b
SR
1957 sitd->hw_buf[0] = cpu_to_hc32(ehci, bufp);
1958 sitd->hw_buf_hi[0] = cpu_to_hc32(ehci, bufp >> 32);
1da177e4 1959
6dbd682b 1960 sitd->hw_buf[1] = cpu_to_hc32(ehci, uf->buf1);
1da177e4
LT
1961 if (uf->cross)
1962 bufp += 4096;
6dbd682b 1963 sitd->hw_buf_hi[1] = cpu_to_hc32(ehci, bufp >> 32);
1da177e4
LT
1964 sitd->index = index;
1965}
1966
1967static inline void
1968sitd_link (struct ehci_hcd *ehci, unsigned frame, struct ehci_sitd *sitd)
1969{
1970 /* note: sitd ordering could matter (CSPLIT then SSPLIT) */
1971 sitd->sitd_next = ehci->pshadow [frame];
1972 sitd->hw_next = ehci->periodic [frame];
1973 ehci->pshadow [frame].sitd = sitd;
1974 sitd->frame = frame;
1975 wmb ();
6dbd682b 1976 ehci->periodic[frame] = cpu_to_hc32(ehci, sitd->sitd_dma | Q_TYPE_SITD);
1da177e4
LT
1977}
1978
1979/* fit urb's sitds into the selected schedule slot; activate as needed */
b015cb79 1980static void sitd_link_urb(
1da177e4
LT
1981 struct ehci_hcd *ehci,
1982 struct urb *urb,
1983 unsigned mod,
1984 struct ehci_iso_stream *stream
1985)
1986{
1987 int packet;
1988 unsigned next_uframe;
1989 struct ehci_iso_sched *sched = urb->hcpriv;
1990 struct ehci_sitd *sitd;
1991
1992 next_uframe = stream->next_uframe;
1993
1994 if (list_empty(&stream->td_list)) {
1995 /* usbfs ignores TT bandwidth */
1996 ehci_to_hcd(ehci)->self.bandwidth_allocated
1997 += stream->bandwidth;
1998 ehci_vdbg (ehci,
1999 "sched devp %s ep%d%s-iso [%d] %dms/%04x\n",
2000 urb->dev->devpath, stream->bEndpointAddress & 0x0f,
2001 (stream->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
bccbefaa 2002 (next_uframe >> 3) & (ehci->periodic_size - 1),
6dbd682b 2003 stream->interval, hc32_to_cpu(ehci, stream->splits));
1da177e4 2004 }
05570297
AH
2005
2006 if (ehci_to_hcd(ehci)->self.bandwidth_isoc_reqs == 0) {
ad93562b
AX
2007 if (ehci->amd_pll_fix == 1)
2008 usb_amd_quirk_pll_disable();
05570297
AH
2009 }
2010
1da177e4
LT
2011 ehci_to_hcd(ehci)->self.bandwidth_isoc_reqs++;
2012
2013 /* fill sITDs frame by frame */
2014 for (packet = 0, sitd = NULL;
2015 packet < urb->number_of_packets;
2016 packet++) {
2017
2018 /* ASSERT: we have all necessary sitds */
2019 BUG_ON (list_empty (&sched->td_list));
2020
2021 /* ASSERT: no itds for this endpoint in this frame */
2022
2023 sitd = list_entry (sched->td_list.next,
2024 struct ehci_sitd, sitd_list);
2025 list_move_tail (&sitd->sitd_list, &stream->td_list);
8c5bf7be 2026 sitd->stream = stream;
508db8c9 2027 sitd->urb = urb;
1da177e4 2028
6dbd682b 2029 sitd_patch(ehci, stream, sitd, sched, packet);
bccbefaa 2030 sitd_link(ehci, (next_uframe >> 3) & (ehci->periodic_size - 1),
1da177e4
LT
2031 sitd);
2032
2033 next_uframe += stream->interval << 3;
1da177e4 2034 }
bccbefaa 2035 stream->next_uframe = next_uframe & (mod - 1);
1da177e4
LT
2036
2037 /* don't need that schedule data any more */
2038 iso_sched_free (stream, sched);
2039 urb->hcpriv = NULL;
2040
569b394f 2041 ++ehci->isoc_count;
b015cb79 2042 enable_periodic(ehci);
1da177e4
LT
2043}
2044
2045/*-------------------------------------------------------------------------*/
2046
2047#define SITD_ERRS (SITD_STS_ERR | SITD_STS_DBE | SITD_STS_BABBLE \
53bd6a60 2048 | SITD_STS_XACT | SITD_STS_MMF)
1da177e4 2049
30bf54e6
DB
2050/* Process and recycle a completed SITD. Return true iff its urb completed,
2051 * and hence its completion callback probably added things to the hardware
2052 * schedule.
2053 *
2054 * Note that we carefully avoid recycling this descriptor until after any
2055 * completion callback runs, so that it won't be reused quickly. That is,
2056 * assuming (a) no more than two urbs per frame on this endpoint, and also
2057 * (b) only this endpoint's completions submit URBs. It seems some silicon
2058 * corrupts things if you reuse completed descriptors very quickly...
2059 */
f4289078
AS
2060static bool sitd_complete(struct ehci_hcd *ehci, struct ehci_sitd *sitd)
2061{
1da177e4
LT
2062 struct urb *urb = sitd->urb;
2063 struct usb_iso_packet_descriptor *desc;
2064 u32 t;
2065 int urb_index = -1;
2066 struct ehci_iso_stream *stream = sitd->stream;
2067 struct usb_device *dev;
f4289078 2068 bool retval = false;
1da177e4
LT
2069
2070 urb_index = sitd->index;
2071 desc = &urb->iso_frame_desc [urb_index];
6dbd682b 2072 t = hc32_to_cpup(ehci, &sitd->hw_results);
1da177e4
LT
2073
2074 /* report transfer status */
2075 if (t & SITD_ERRS) {
2076 urb->error_count++;
2077 if (t & SITD_STS_DBE)
2078 desc->status = usb_pipein (urb->pipe)
2079 ? -ENOSR /* hc couldn't read */
2080 : -ECOMM; /* hc couldn't write */
2081 else if (t & SITD_STS_BABBLE)
2082 desc->status = -EOVERFLOW;
2083 else /* XACT, MMF, etc */
2084 desc->status = -EPROTO;
2085 } else {
2086 desc->status = 0;
ec6d67e3
AS
2087 desc->actual_length = desc->length - SITD_LENGTH(t);
2088 urb->actual_length += desc->actual_length;
1da177e4 2089 }
1da177e4
LT
2090
2091 /* handle completion now? */
2092 if ((urb_index + 1) != urb->number_of_packets)
30bf54e6 2093 goto done;
1da177e4
LT
2094
2095 /* ASSERT: it's really the last sitd for this urb
2096 list_for_each_entry (sitd, &stream->td_list, sitd_list)
2097 BUG_ON (sitd->urb == urb);
2098 */
2099
aa16ca30 2100 /* give urb back to the driver; completion often (re)submits */
6a8e87b2 2101 dev = urb->dev;
14c04c0f 2102 ehci_urb_done(ehci, urb, 0);
30bf54e6 2103 retval = true;
1da177e4 2104 urb = NULL;
569b394f
AS
2105
2106 --ehci->isoc_count;
b015cb79 2107 disable_periodic(ehci);
1da177e4 2108
569b394f 2109 ehci_to_hcd(ehci)->self.bandwidth_isoc_reqs--;
05570297 2110 if (ehci_to_hcd(ehci)->self.bandwidth_isoc_reqs == 0) {
ad93562b
AX
2111 if (ehci->amd_pll_fix == 1)
2112 usb_amd_quirk_pll_enable();
05570297
AH
2113 }
2114
508db8c9 2115 if (list_is_singular(&stream->td_list)) {
1da177e4
LT
2116 ehci_to_hcd(ehci)->self.bandwidth_allocated
2117 -= stream->bandwidth;
2118 ehci_vdbg (ehci,
2119 "deschedule devp %s ep%d%s-iso\n",
2120 dev->devpath, stream->bEndpointAddress & 0x0f,
2121 (stream->bEndpointAddress & USB_DIR_IN) ? "in" : "out");
2122 }
0e5f231b 2123
30bf54e6 2124done:
30bf54e6 2125 sitd->urb = NULL;
55934eb3
AS
2126
2127 /* Add to the end of the free list for later reuse */
2128 list_move_tail(&sitd->sitd_list, &stream->free_list);
2129
2130 /* Recycle the siTDs when the pipeline is empty (ep no longer in use) */
2131 if (list_empty(&stream->td_list)) {
2132 list_splice_tail_init(&stream->free_list,
2133 &ehci->cached_sitd_list);
2134 start_free_itds(ehci);
0e5f231b 2135 }
55934eb3 2136
30bf54e6 2137 return retval;
1da177e4
LT
2138}
2139
2140
5db539e4 2141static int sitd_submit (struct ehci_hcd *ehci, struct urb *urb,
55016f10 2142 gfp_t mem_flags)
1da177e4
LT
2143{
2144 int status = -EINVAL;
2145 unsigned long flags;
2146 struct ehci_iso_stream *stream;
2147
2148 /* Get iso_stream head */
2149 stream = iso_stream_find (ehci, urb);
2150 if (stream == NULL) {
2151 ehci_dbg (ehci, "can't get iso stream\n");
2152 return -ENOMEM;
2153 }
2154 if (urb->interval != stream->interval) {
2155 ehci_dbg (ehci, "can't change iso interval %d --> %d\n",
2156 stream->interval, urb->interval);
2157 goto done;
2158 }
2159
2160#ifdef EHCI_URB_TRACE
2161 ehci_dbg (ehci,
2162 "submit %p dev%s ep%d%s-iso len %d\n",
2163 urb, urb->dev->devpath,
2164 usb_pipeendpoint (urb->pipe),
2165 usb_pipein (urb->pipe) ? "in" : "out",
2166 urb->transfer_buffer_length);
2167#endif
2168
2169 /* allocate SITDs */
2170 status = sitd_urb_transaction (stream, ehci, urb, mem_flags);
2171 if (status < 0) {
2172 ehci_dbg (ehci, "can't init sitds\n");
2173 goto done;
2174 }
2175
2176 /* schedule ... need to lock */
2177 spin_lock_irqsave (&ehci->lock, flags);
541c7d43 2178 if (unlikely(!HCD_HW_ACCESSIBLE(ehci_to_hcd(ehci)))) {
8de98402 2179 status = -ESHUTDOWN;
e9df41c5
AS
2180 goto done_not_linked;
2181 }
2182 status = usb_hcd_link_urb_to_ep(ehci_to_hcd(ehci), urb);
2183 if (unlikely(status))
2184 goto done_not_linked;
2185 status = iso_stream_schedule(ehci, urb, stream);
53bd6a60 2186 if (status == 0)
1da177e4 2187 sitd_link_urb (ehci, urb, ehci->periodic_size << 3, stream);
e9df41c5
AS
2188 else
2189 usb_hcd_unlink_urb_from_ep(ehci_to_hcd(ehci), urb);
8c5bf7be 2190 done_not_linked:
1da177e4 2191 spin_unlock_irqrestore (&ehci->lock, flags);
8c5bf7be 2192 done:
1da177e4
LT
2193 return status;
2194}
2195
1da177e4
LT
2196/*-------------------------------------------------------------------------*/
2197
569b394f 2198static void scan_isoc(struct ehci_hcd *ehci)
1da177e4 2199{
f4289078
AS
2200 unsigned uf, now_frame, frame;
2201 unsigned fmask = ehci->periodic_size - 1;
2202 bool modified, live;
1da177e4
LT
2203
2204 /*
2205 * When running, scan from last scan point up to "now"
2206 * else clean up by scanning everything that's left.
2207 * Touches as few pages as possible: cache-friendly.
2208 */
c0c53dbc 2209 if (ehci->rh_state >= EHCI_RH_RUNNING) {
f4289078
AS
2210 uf = ehci_read_frame_index(ehci);
2211 now_frame = (uf >> 3) & fmask;
2212 live = true;
9aa09d2f 2213 } else {
c3ee9b76 2214 now_frame = (ehci->last_iso_frame - 1) & fmask;
f4289078 2215 live = false;
9aa09d2f 2216 }
f4289078 2217 ehci->now_frame = now_frame;
1da177e4
LT
2218
2219 for (;;) {
2220 union ehci_shadow q, *q_p;
6dbd682b 2221 __hc32 type, *hw_p;
1da177e4 2222
c3ee9b76 2223 frame = ehci->last_iso_frame;
1da177e4
LT
2224restart:
2225 /* scan each element in frame's queue for completions */
2226 q_p = &ehci->pshadow [frame];
2227 hw_p = &ehci->periodic [frame];
2228 q.ptr = q_p->ptr;
6dbd682b 2229 type = Q_NEXT_TYPE(ehci, *hw_p);
f4289078 2230 modified = false;
1da177e4
LT
2231
2232 while (q.ptr != NULL) {
6dbd682b 2233 switch (hc32_to_cpu(ehci, type)) {
1da177e4 2234 case Q_TYPE_ITD:
79592b72
DB
2235 /* If this ITD is still active, leave it for
2236 * later processing ... check the next entry.
b40e43fc
AS
2237 * No need to check for activity unless the
2238 * frame is current.
79592b72 2239 */
f4289078 2240 if (frame == now_frame && live) {
b40e43fc
AS
2241 rmb();
2242 for (uf = 0; uf < 8; uf++) {
2243 if (q.itd->hw_transaction[uf] &
2244 ITD_ACTIVE(ehci))
2245 break;
2246 }
2247 if (uf < 8) {
b40e43fc
AS
2248 q_p = &q.itd->itd_next;
2249 hw_p = &q.itd->hw_next;
2250 type = Q_NEXT_TYPE(ehci,
6dbd682b 2251 q.itd->hw_next);
b40e43fc
AS
2252 q = *q_p;
2253 break;
2254 }
1da177e4 2255 }
1da177e4 2256
79592b72
DB
2257 /* Take finished ITDs out of the schedule
2258 * and process them: recycle, maybe report
2259 * URB completion. HC won't cache the
1da177e4
LT
2260 * pointer for much longer, if at all.
2261 */
2262 *q_p = q.itd->itd_next;
3d091a6f
AX
2263 if (!ehci->use_dummy_qh ||
2264 q.itd->hw_next != EHCI_LIST_END(ehci))
2265 *hw_p = q.itd->hw_next;
2266 else
2267 *hw_p = ehci->dummy->qh_dma;
6dbd682b 2268 type = Q_NEXT_TYPE(ehci, q.itd->hw_next);
1da177e4 2269 wmb();
7d12e780 2270 modified = itd_complete (ehci, q.itd);
1da177e4
LT
2271 q = *q_p;
2272 break;
2273 case Q_TYPE_SITD:
79592b72
DB
2274 /* If this SITD is still active, leave it for
2275 * later processing ... check the next entry.
b40e43fc
AS
2276 * No need to check for activity unless the
2277 * frame is current.
79592b72 2278 */
f4289078
AS
2279 if (((frame == now_frame) ||
2280 (((frame + 1) & fmask) == now_frame))
22e18694
DE
2281 && live
2282 && (q.sitd->hw_results &
2283 SITD_ACTIVE(ehci))) {
2284
1da177e4
LT
2285 q_p = &q.sitd->sitd_next;
2286 hw_p = &q.sitd->hw_next;
6dbd682b
SR
2287 type = Q_NEXT_TYPE(ehci,
2288 q.sitd->hw_next);
1da177e4
LT
2289 q = *q_p;
2290 break;
2291 }
79592b72
DB
2292
2293 /* Take finished SITDs out of the schedule
2294 * and process them: recycle, maybe report
2295 * URB completion.
2296 */
1da177e4 2297 *q_p = q.sitd->sitd_next;
3d091a6f
AX
2298 if (!ehci->use_dummy_qh ||
2299 q.sitd->hw_next != EHCI_LIST_END(ehci))
2300 *hw_p = q.sitd->hw_next;
2301 else
2302 *hw_p = ehci->dummy->qh_dma;
6dbd682b 2303 type = Q_NEXT_TYPE(ehci, q.sitd->hw_next);
1da177e4 2304 wmb();
7d12e780 2305 modified = sitd_complete (ehci, q.sitd);
1da177e4
LT
2306 q = *q_p;
2307 break;
2308 default:
2d0fe1bb 2309 ehci_dbg(ehci, "corrupt type %d frame %d shadow %p\n",
1da177e4
LT
2310 type, frame, q.ptr);
2311 // BUG ();
569b394f
AS
2312 /* FALL THROUGH */
2313 case Q_TYPE_QH:
2314 case Q_TYPE_FSTN:
2315 /* End of the iTDs and siTDs */
1da177e4 2316 q.ptr = NULL;
569b394f 2317 break;
1da177e4
LT
2318 }
2319
2320 /* assume completion callbacks modify the queue */
f4289078
AS
2321 if (unlikely(modified && ehci->isoc_count > 0))
2322 goto restart;
1da177e4
LT
2323 }
2324
f4289078
AS
2325 /* Stop when we have reached the current frame */
2326 if (frame == now_frame)
79592b72 2327 break;
c3ee9b76 2328 ehci->last_iso_frame = (frame + 1) & fmask;
53bd6a60 2329 }
1da177e4 2330}
This page took 0.851916 seconds and 5 git commands to generate.