Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/teigland/dlm
[linux-2.6] / drivers / usb / host / uhci-q.c
1 /*
2  * Universal Host Controller Interface driver for USB.
3  *
4  * Maintainer: Alan Stern <stern@rowland.harvard.edu>
5  *
6  * (C) Copyright 1999 Linus Torvalds
7  * (C) Copyright 1999-2002 Johannes Erdfelt, johannes@erdfelt.com
8  * (C) Copyright 1999 Randy Dunlap
9  * (C) Copyright 1999 Georg Acher, acher@in.tum.de
10  * (C) Copyright 1999 Deti Fliegl, deti@fliegl.de
11  * (C) Copyright 1999 Thomas Sailer, sailer@ife.ee.ethz.ch
12  * (C) Copyright 1999 Roman Weissgaerber, weissg@vienna.at
13  * (C) Copyright 2000 Yggdrasil Computing, Inc. (port of new PCI interface
14  *               support from usb-ohci.c by Adam Richter, adam@yggdrasil.com).
15  * (C) Copyright 1999 Gregory P. Smith (from usb-ohci.c)
16  * (C) Copyright 2004-2007 Alan Stern, stern@rowland.harvard.edu
17  */
18
19
20 /*
21  * Technically, updating td->status here is a race, but it's not really a
22  * problem. The worst that can happen is that we set the IOC bit again
23  * generating a spurious interrupt. We could fix this by creating another
24  * QH and leaving the IOC bit always set, but then we would have to play
25  * games with the FSBR code to make sure we get the correct order in all
26  * the cases. I don't think it's worth the effort
27  */
28 static void uhci_set_next_interrupt(struct uhci_hcd *uhci)
29 {
30         if (uhci->is_stopped)
31                 mod_timer(&uhci_to_hcd(uhci)->rh_timer, jiffies);
32         uhci->term_td->status |= cpu_to_le32(TD_CTRL_IOC); 
33 }
34
35 static inline void uhci_clear_next_interrupt(struct uhci_hcd *uhci)
36 {
37         uhci->term_td->status &= ~cpu_to_le32(TD_CTRL_IOC);
38 }
39
40
41 /*
42  * Full-Speed Bandwidth Reclamation (FSBR).
43  * We turn on FSBR whenever a queue that wants it is advancing,
44  * and leave it on for a short time thereafter.
45  */
46 static void uhci_fsbr_on(struct uhci_hcd *uhci)
47 {
48         struct uhci_qh *lqh;
49
50         /* The terminating skeleton QH always points back to the first
51          * FSBR QH.  Make the last async QH point to the terminating
52          * skeleton QH. */
53         uhci->fsbr_is_on = 1;
54         lqh = list_entry(uhci->skel_async_qh->node.prev,
55                         struct uhci_qh, node);
56         lqh->link = LINK_TO_QH(uhci->skel_term_qh);
57 }
58
59 static void uhci_fsbr_off(struct uhci_hcd *uhci)
60 {
61         struct uhci_qh *lqh;
62
63         /* Remove the link from the last async QH to the terminating
64          * skeleton QH. */
65         uhci->fsbr_is_on = 0;
66         lqh = list_entry(uhci->skel_async_qh->node.prev,
67                         struct uhci_qh, node);
68         lqh->link = UHCI_PTR_TERM;
69 }
70
71 static void uhci_add_fsbr(struct uhci_hcd *uhci, struct urb *urb)
72 {
73         struct urb_priv *urbp = urb->hcpriv;
74
75         if (!(urb->transfer_flags & URB_NO_FSBR))
76                 urbp->fsbr = 1;
77 }
78
79 static void uhci_urbp_wants_fsbr(struct uhci_hcd *uhci, struct urb_priv *urbp)
80 {
81         if (urbp->fsbr) {
82                 uhci->fsbr_is_wanted = 1;
83                 if (!uhci->fsbr_is_on)
84                         uhci_fsbr_on(uhci);
85                 else if (uhci->fsbr_expiring) {
86                         uhci->fsbr_expiring = 0;
87                         del_timer(&uhci->fsbr_timer);
88                 }
89         }
90 }
91
92 static void uhci_fsbr_timeout(unsigned long _uhci)
93 {
94         struct uhci_hcd *uhci = (struct uhci_hcd *) _uhci;
95         unsigned long flags;
96
97         spin_lock_irqsave(&uhci->lock, flags);
98         if (uhci->fsbr_expiring) {
99                 uhci->fsbr_expiring = 0;
100                 uhci_fsbr_off(uhci);
101         }
102         spin_unlock_irqrestore(&uhci->lock, flags);
103 }
104
105
106 static struct uhci_td *uhci_alloc_td(struct uhci_hcd *uhci)
107 {
108         dma_addr_t dma_handle;
109         struct uhci_td *td;
110
111         td = dma_pool_alloc(uhci->td_pool, GFP_ATOMIC, &dma_handle);
112         if (!td)
113                 return NULL;
114
115         td->dma_handle = dma_handle;
116         td->frame = -1;
117
118         INIT_LIST_HEAD(&td->list);
119         INIT_LIST_HEAD(&td->fl_list);
120
121         return td;
122 }
123
124 static void uhci_free_td(struct uhci_hcd *uhci, struct uhci_td *td)
125 {
126         if (!list_empty(&td->list))
127                 dev_WARN(uhci_dev(uhci), "td %p still in list!\n", td);
128         if (!list_empty(&td->fl_list))
129                 dev_WARN(uhci_dev(uhci), "td %p still in fl_list!\n", td);
130
131         dma_pool_free(uhci->td_pool, td, td->dma_handle);
132 }
133
134 static inline void uhci_fill_td(struct uhci_td *td, u32 status,
135                 u32 token, u32 buffer)
136 {
137         td->status = cpu_to_le32(status);
138         td->token = cpu_to_le32(token);
139         td->buffer = cpu_to_le32(buffer);
140 }
141
142 static void uhci_add_td_to_urbp(struct uhci_td *td, struct urb_priv *urbp)
143 {
144         list_add_tail(&td->list, &urbp->td_list);
145 }
146
147 static void uhci_remove_td_from_urbp(struct uhci_td *td)
148 {
149         list_del_init(&td->list);
150 }
151
152 /*
153  * We insert Isochronous URBs directly into the frame list at the beginning
154  */
155 static inline void uhci_insert_td_in_frame_list(struct uhci_hcd *uhci,
156                 struct uhci_td *td, unsigned framenum)
157 {
158         framenum &= (UHCI_NUMFRAMES - 1);
159
160         td->frame = framenum;
161
162         /* Is there a TD already mapped there? */
163         if (uhci->frame_cpu[framenum]) {
164                 struct uhci_td *ftd, *ltd;
165
166                 ftd = uhci->frame_cpu[framenum];
167                 ltd = list_entry(ftd->fl_list.prev, struct uhci_td, fl_list);
168
169                 list_add_tail(&td->fl_list, &ftd->fl_list);
170
171                 td->link = ltd->link;
172                 wmb();
173                 ltd->link = LINK_TO_TD(td);
174         } else {
175                 td->link = uhci->frame[framenum];
176                 wmb();
177                 uhci->frame[framenum] = LINK_TO_TD(td);
178                 uhci->frame_cpu[framenum] = td;
179         }
180 }
181
182 static inline void uhci_remove_td_from_frame_list(struct uhci_hcd *uhci,
183                 struct uhci_td *td)
184 {
185         /* If it's not inserted, don't remove it */
186         if (td->frame == -1) {
187                 WARN_ON(!list_empty(&td->fl_list));
188                 return;
189         }
190
191         if (uhci->frame_cpu[td->frame] == td) {
192                 if (list_empty(&td->fl_list)) {
193                         uhci->frame[td->frame] = td->link;
194                         uhci->frame_cpu[td->frame] = NULL;
195                 } else {
196                         struct uhci_td *ntd;
197
198                         ntd = list_entry(td->fl_list.next, struct uhci_td, fl_list);
199                         uhci->frame[td->frame] = LINK_TO_TD(ntd);
200                         uhci->frame_cpu[td->frame] = ntd;
201                 }
202         } else {
203                 struct uhci_td *ptd;
204
205                 ptd = list_entry(td->fl_list.prev, struct uhci_td, fl_list);
206                 ptd->link = td->link;
207         }
208
209         list_del_init(&td->fl_list);
210         td->frame = -1;
211 }
212
213 static inline void uhci_remove_tds_from_frame(struct uhci_hcd *uhci,
214                 unsigned int framenum)
215 {
216         struct uhci_td *ftd, *ltd;
217
218         framenum &= (UHCI_NUMFRAMES - 1);
219
220         ftd = uhci->frame_cpu[framenum];
221         if (ftd) {
222                 ltd = list_entry(ftd->fl_list.prev, struct uhci_td, fl_list);
223                 uhci->frame[framenum] = ltd->link;
224                 uhci->frame_cpu[framenum] = NULL;
225
226                 while (!list_empty(&ftd->fl_list))
227                         list_del_init(ftd->fl_list.prev);
228         }
229 }
230
231 /*
232  * Remove all the TDs for an Isochronous URB from the frame list
233  */
234 static void uhci_unlink_isochronous_tds(struct uhci_hcd *uhci, struct urb *urb)
235 {
236         struct urb_priv *urbp = (struct urb_priv *) urb->hcpriv;
237         struct uhci_td *td;
238
239         list_for_each_entry(td, &urbp->td_list, list)
240                 uhci_remove_td_from_frame_list(uhci, td);
241 }
242
243 static struct uhci_qh *uhci_alloc_qh(struct uhci_hcd *uhci,
244                 struct usb_device *udev, struct usb_host_endpoint *hep)
245 {
246         dma_addr_t dma_handle;
247         struct uhci_qh *qh;
248
249         qh = dma_pool_alloc(uhci->qh_pool, GFP_ATOMIC, &dma_handle);
250         if (!qh)
251                 return NULL;
252
253         memset(qh, 0, sizeof(*qh));
254         qh->dma_handle = dma_handle;
255
256         qh->element = UHCI_PTR_TERM;
257         qh->link = UHCI_PTR_TERM;
258
259         INIT_LIST_HEAD(&qh->queue);
260         INIT_LIST_HEAD(&qh->node);
261
262         if (udev) {             /* Normal QH */
263                 qh->type = hep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
264                 if (qh->type != USB_ENDPOINT_XFER_ISOC) {
265                         qh->dummy_td = uhci_alloc_td(uhci);
266                         if (!qh->dummy_td) {
267                                 dma_pool_free(uhci->qh_pool, qh, dma_handle);
268                                 return NULL;
269                         }
270                 }
271                 qh->state = QH_STATE_IDLE;
272                 qh->hep = hep;
273                 qh->udev = udev;
274                 hep->hcpriv = qh;
275
276                 if (qh->type == USB_ENDPOINT_XFER_INT ||
277                                 qh->type == USB_ENDPOINT_XFER_ISOC)
278                         qh->load = usb_calc_bus_time(udev->speed,
279                                         usb_endpoint_dir_in(&hep->desc),
280                                         qh->type == USB_ENDPOINT_XFER_ISOC,
281                                         le16_to_cpu(hep->desc.wMaxPacketSize))
282                                 / 1000 + 1;
283
284         } else {                /* Skeleton QH */
285                 qh->state = QH_STATE_ACTIVE;
286                 qh->type = -1;
287         }
288         return qh;
289 }
290
291 static void uhci_free_qh(struct uhci_hcd *uhci, struct uhci_qh *qh)
292 {
293         WARN_ON(qh->state != QH_STATE_IDLE && qh->udev);
294         if (!list_empty(&qh->queue))
295                 dev_WARN(uhci_dev(uhci), "qh %p list not empty!\n", qh);
296
297         list_del(&qh->node);
298         if (qh->udev) {
299                 qh->hep->hcpriv = NULL;
300                 if (qh->dummy_td)
301                         uhci_free_td(uhci, qh->dummy_td);
302         }
303         dma_pool_free(uhci->qh_pool, qh, qh->dma_handle);
304 }
305
306 /*
307  * When a queue is stopped and a dequeued URB is given back, adjust
308  * the previous TD link (if the URB isn't first on the queue) or
309  * save its toggle value (if it is first and is currently executing).
310  *
311  * Returns 0 if the URB should not yet be given back, 1 otherwise.
312  */
313 static int uhci_cleanup_queue(struct uhci_hcd *uhci, struct uhci_qh *qh,
314                 struct urb *urb)
315 {
316         struct urb_priv *urbp = urb->hcpriv;
317         struct uhci_td *td;
318         int ret = 1;
319
320         /* Isochronous pipes don't use toggles and their TD link pointers
321          * get adjusted during uhci_urb_dequeue().  But since their queues
322          * cannot truly be stopped, we have to watch out for dequeues
323          * occurring after the nominal unlink frame. */
324         if (qh->type == USB_ENDPOINT_XFER_ISOC) {
325                 ret = (uhci->frame_number + uhci->is_stopped !=
326                                 qh->unlink_frame);
327                 goto done;
328         }
329
330         /* If the URB isn't first on its queue, adjust the link pointer
331          * of the last TD in the previous URB.  The toggle doesn't need
332          * to be saved since this URB can't be executing yet. */
333         if (qh->queue.next != &urbp->node) {
334                 struct urb_priv *purbp;
335                 struct uhci_td *ptd;
336
337                 purbp = list_entry(urbp->node.prev, struct urb_priv, node);
338                 WARN_ON(list_empty(&purbp->td_list));
339                 ptd = list_entry(purbp->td_list.prev, struct uhci_td,
340                                 list);
341                 td = list_entry(urbp->td_list.prev, struct uhci_td,
342                                 list);
343                 ptd->link = td->link;
344                 goto done;
345         }
346
347         /* If the QH element pointer is UHCI_PTR_TERM then then currently
348          * executing URB has already been unlinked, so this one isn't it. */
349         if (qh_element(qh) == UHCI_PTR_TERM)
350                 goto done;
351         qh->element = UHCI_PTR_TERM;
352
353         /* Control pipes don't have to worry about toggles */
354         if (qh->type == USB_ENDPOINT_XFER_CONTROL)
355                 goto done;
356
357         /* Save the next toggle value */
358         WARN_ON(list_empty(&urbp->td_list));
359         td = list_entry(urbp->td_list.next, struct uhci_td, list);
360         qh->needs_fixup = 1;
361         qh->initial_toggle = uhci_toggle(td_token(td));
362
363 done:
364         return ret;
365 }
366
367 /*
368  * Fix up the data toggles for URBs in a queue, when one of them
369  * terminates early (short transfer, error, or dequeued).
370  */
371 static void uhci_fixup_toggles(struct uhci_qh *qh, int skip_first)
372 {
373         struct urb_priv *urbp = NULL;
374         struct uhci_td *td;
375         unsigned int toggle = qh->initial_toggle;
376         unsigned int pipe;
377
378         /* Fixups for a short transfer start with the second URB in the
379          * queue (the short URB is the first). */
380         if (skip_first)
381                 urbp = list_entry(qh->queue.next, struct urb_priv, node);
382
383         /* When starting with the first URB, if the QH element pointer is
384          * still valid then we know the URB's toggles are okay. */
385         else if (qh_element(qh) != UHCI_PTR_TERM)
386                 toggle = 2;
387
388         /* Fix up the toggle for the URBs in the queue.  Normally this
389          * loop won't run more than once: When an error or short transfer
390          * occurs, the queue usually gets emptied. */
391         urbp = list_prepare_entry(urbp, &qh->queue, node);
392         list_for_each_entry_continue(urbp, &qh->queue, node) {
393
394                 /* If the first TD has the right toggle value, we don't
395                  * need to change any toggles in this URB */
396                 td = list_entry(urbp->td_list.next, struct uhci_td, list);
397                 if (toggle > 1 || uhci_toggle(td_token(td)) == toggle) {
398                         td = list_entry(urbp->td_list.prev, struct uhci_td,
399                                         list);
400                         toggle = uhci_toggle(td_token(td)) ^ 1;
401
402                 /* Otherwise all the toggles in the URB have to be switched */
403                 } else {
404                         list_for_each_entry(td, &urbp->td_list, list) {
405                                 td->token ^= cpu_to_le32(
406                                                         TD_TOKEN_TOGGLE);
407                                 toggle ^= 1;
408                         }
409                 }
410         }
411
412         wmb();
413         pipe = list_entry(qh->queue.next, struct urb_priv, node)->urb->pipe;
414         usb_settoggle(qh->udev, usb_pipeendpoint(pipe),
415                         usb_pipeout(pipe), toggle);
416         qh->needs_fixup = 0;
417 }
418
419 /*
420  * Link an Isochronous QH into its skeleton's list
421  */
422 static inline void link_iso(struct uhci_hcd *uhci, struct uhci_qh *qh)
423 {
424         list_add_tail(&qh->node, &uhci->skel_iso_qh->node);
425
426         /* Isochronous QHs aren't linked by the hardware */
427 }
428
429 /*
430  * Link a high-period interrupt QH into the schedule at the end of its
431  * skeleton's list
432  */
433 static void link_interrupt(struct uhci_hcd *uhci, struct uhci_qh *qh)
434 {
435         struct uhci_qh *pqh;
436
437         list_add_tail(&qh->node, &uhci->skelqh[qh->skel]->node);
438
439         pqh = list_entry(qh->node.prev, struct uhci_qh, node);
440         qh->link = pqh->link;
441         wmb();
442         pqh->link = LINK_TO_QH(qh);
443 }
444
445 /*
446  * Link a period-1 interrupt or async QH into the schedule at the
447  * correct spot in the async skeleton's list, and update the FSBR link
448  */
449 static void link_async(struct uhci_hcd *uhci, struct uhci_qh *qh)
450 {
451         struct uhci_qh *pqh;
452         __le32 link_to_new_qh;
453
454         /* Find the predecessor QH for our new one and insert it in the list.
455          * The list of QHs is expected to be short, so linear search won't
456          * take too long. */
457         list_for_each_entry_reverse(pqh, &uhci->skel_async_qh->node, node) {
458                 if (pqh->skel <= qh->skel)
459                         break;
460         }
461         list_add(&qh->node, &pqh->node);
462
463         /* Link it into the schedule */
464         qh->link = pqh->link;
465         wmb();
466         link_to_new_qh = LINK_TO_QH(qh);
467         pqh->link = link_to_new_qh;
468
469         /* If this is now the first FSBR QH, link the terminating skeleton
470          * QH to it. */
471         if (pqh->skel < SKEL_FSBR && qh->skel >= SKEL_FSBR)
472                 uhci->skel_term_qh->link = link_to_new_qh;
473 }
474
475 /*
476  * Put a QH on the schedule in both hardware and software
477  */
478 static void uhci_activate_qh(struct uhci_hcd *uhci, struct uhci_qh *qh)
479 {
480         WARN_ON(list_empty(&qh->queue));
481
482         /* Set the element pointer if it isn't set already.
483          * This isn't needed for Isochronous queues, but it doesn't hurt. */
484         if (qh_element(qh) == UHCI_PTR_TERM) {
485                 struct urb_priv *urbp = list_entry(qh->queue.next,
486                                 struct urb_priv, node);
487                 struct uhci_td *td = list_entry(urbp->td_list.next,
488                                 struct uhci_td, list);
489
490                 qh->element = LINK_TO_TD(td);
491         }
492
493         /* Treat the queue as if it has just advanced */
494         qh->wait_expired = 0;
495         qh->advance_jiffies = jiffies;
496
497         if (qh->state == QH_STATE_ACTIVE)
498                 return;
499         qh->state = QH_STATE_ACTIVE;
500
501         /* Move the QH from its old list to the correct spot in the appropriate
502          * skeleton's list */
503         if (qh == uhci->next_qh)
504                 uhci->next_qh = list_entry(qh->node.next, struct uhci_qh,
505                                 node);
506         list_del(&qh->node);
507
508         if (qh->skel == SKEL_ISO)
509                 link_iso(uhci, qh);
510         else if (qh->skel < SKEL_ASYNC)
511                 link_interrupt(uhci, qh);
512         else
513                 link_async(uhci, qh);
514 }
515
516 /*
517  * Unlink a high-period interrupt QH from the schedule
518  */
519 static void unlink_interrupt(struct uhci_hcd *uhci, struct uhci_qh *qh)
520 {
521         struct uhci_qh *pqh;
522
523         pqh = list_entry(qh->node.prev, struct uhci_qh, node);
524         pqh->link = qh->link;
525         mb();
526 }
527
528 /*
529  * Unlink a period-1 interrupt or async QH from the schedule
530  */
531 static void unlink_async(struct uhci_hcd *uhci, struct uhci_qh *qh)
532 {
533         struct uhci_qh *pqh;
534         __le32 link_to_next_qh = qh->link;
535
536         pqh = list_entry(qh->node.prev, struct uhci_qh, node);
537         pqh->link = link_to_next_qh;
538
539         /* If this was the old first FSBR QH, link the terminating skeleton
540          * QH to the next (new first FSBR) QH. */
541         if (pqh->skel < SKEL_FSBR && qh->skel >= SKEL_FSBR)
542                 uhci->skel_term_qh->link = link_to_next_qh;
543         mb();
544 }
545
546 /*
547  * Take a QH off the hardware schedule
548  */
549 static void uhci_unlink_qh(struct uhci_hcd *uhci, struct uhci_qh *qh)
550 {
551         if (qh->state == QH_STATE_UNLINKING)
552                 return;
553         WARN_ON(qh->state != QH_STATE_ACTIVE || !qh->udev);
554         qh->state = QH_STATE_UNLINKING;
555
556         /* Unlink the QH from the schedule and record when we did it */
557         if (qh->skel == SKEL_ISO)
558                 ;
559         else if (qh->skel < SKEL_ASYNC)
560                 unlink_interrupt(uhci, qh);
561         else
562                 unlink_async(uhci, qh);
563
564         uhci_get_current_frame_number(uhci);
565         qh->unlink_frame = uhci->frame_number;
566
567         /* Force an interrupt so we know when the QH is fully unlinked */
568         if (list_empty(&uhci->skel_unlink_qh->node))
569                 uhci_set_next_interrupt(uhci);
570
571         /* Move the QH from its old list to the end of the unlinking list */
572         if (qh == uhci->next_qh)
573                 uhci->next_qh = list_entry(qh->node.next, struct uhci_qh,
574                                 node);
575         list_move_tail(&qh->node, &uhci->skel_unlink_qh->node);
576 }
577
578 /*
579  * When we and the controller are through with a QH, it becomes IDLE.
580  * This happens when a QH has been off the schedule (on the unlinking
581  * list) for more than one frame, or when an error occurs while adding
582  * the first URB onto a new QH.
583  */
584 static void uhci_make_qh_idle(struct uhci_hcd *uhci, struct uhci_qh *qh)
585 {
586         WARN_ON(qh->state == QH_STATE_ACTIVE);
587
588         if (qh == uhci->next_qh)
589                 uhci->next_qh = list_entry(qh->node.next, struct uhci_qh,
590                                 node);
591         list_move(&qh->node, &uhci->idle_qh_list);
592         qh->state = QH_STATE_IDLE;
593
594         /* Now that the QH is idle, its post_td isn't being used */
595         if (qh->post_td) {
596                 uhci_free_td(uhci, qh->post_td);
597                 qh->post_td = NULL;
598         }
599
600         /* If anyone is waiting for a QH to become idle, wake them up */
601         if (uhci->num_waiting)
602                 wake_up_all(&uhci->waitqh);
603 }
604
605 /*
606  * Find the highest existing bandwidth load for a given phase and period.
607  */
608 static int uhci_highest_load(struct uhci_hcd *uhci, int phase, int period)
609 {
610         int highest_load = uhci->load[phase];
611
612         for (phase += period; phase < MAX_PHASE; phase += period)
613                 highest_load = max_t(int, highest_load, uhci->load[phase]);
614         return highest_load;
615 }
616
617 /*
618  * Set qh->phase to the optimal phase for a periodic transfer and
619  * check whether the bandwidth requirement is acceptable.
620  */
621 static int uhci_check_bandwidth(struct uhci_hcd *uhci, struct uhci_qh *qh)
622 {
623         int minimax_load;
624
625         /* Find the optimal phase (unless it is already set) and get
626          * its load value. */
627         if (qh->phase >= 0)
628                 minimax_load = uhci_highest_load(uhci, qh->phase, qh->period);
629         else {
630                 int phase, load;
631                 int max_phase = min_t(int, MAX_PHASE, qh->period);
632
633                 qh->phase = 0;
634                 minimax_load = uhci_highest_load(uhci, qh->phase, qh->period);
635                 for (phase = 1; phase < max_phase; ++phase) {
636                         load = uhci_highest_load(uhci, phase, qh->period);
637                         if (load < minimax_load) {
638                                 minimax_load = load;
639                                 qh->phase = phase;
640                         }
641                 }
642         }
643
644         /* Maximum allowable periodic bandwidth is 90%, or 900 us per frame */
645         if (minimax_load + qh->load > 900) {
646                 dev_dbg(uhci_dev(uhci), "bandwidth allocation failed: "
647                                 "period %d, phase %d, %d + %d us\n",
648                                 qh->period, qh->phase, minimax_load, qh->load);
649                 return -ENOSPC;
650         }
651         return 0;
652 }
653
654 /*
655  * Reserve a periodic QH's bandwidth in the schedule
656  */
657 static void uhci_reserve_bandwidth(struct uhci_hcd *uhci, struct uhci_qh *qh)
658 {
659         int i;
660         int load = qh->load;
661         char *p = "??";
662
663         for (i = qh->phase; i < MAX_PHASE; i += qh->period) {
664                 uhci->load[i] += load;
665                 uhci->total_load += load;
666         }
667         uhci_to_hcd(uhci)->self.bandwidth_allocated =
668                         uhci->total_load / MAX_PHASE;
669         switch (qh->type) {
670         case USB_ENDPOINT_XFER_INT:
671                 ++uhci_to_hcd(uhci)->self.bandwidth_int_reqs;
672                 p = "INT";
673                 break;
674         case USB_ENDPOINT_XFER_ISOC:
675                 ++uhci_to_hcd(uhci)->self.bandwidth_isoc_reqs;
676                 p = "ISO";
677                 break;
678         }
679         qh->bandwidth_reserved = 1;
680         dev_dbg(uhci_dev(uhci),
681                         "%s dev %d ep%02x-%s, period %d, phase %d, %d us\n",
682                         "reserve", qh->udev->devnum,
683                         qh->hep->desc.bEndpointAddress, p,
684                         qh->period, qh->phase, load);
685 }
686
687 /*
688  * Release a periodic QH's bandwidth reservation
689  */
690 static void uhci_release_bandwidth(struct uhci_hcd *uhci, struct uhci_qh *qh)
691 {
692         int i;
693         int load = qh->load;
694         char *p = "??";
695
696         for (i = qh->phase; i < MAX_PHASE; i += qh->period) {
697                 uhci->load[i] -= load;
698                 uhci->total_load -= load;
699         }
700         uhci_to_hcd(uhci)->self.bandwidth_allocated =
701                         uhci->total_load / MAX_PHASE;
702         switch (qh->type) {
703         case USB_ENDPOINT_XFER_INT:
704                 --uhci_to_hcd(uhci)->self.bandwidth_int_reqs;
705                 p = "INT";
706                 break;
707         case USB_ENDPOINT_XFER_ISOC:
708                 --uhci_to_hcd(uhci)->self.bandwidth_isoc_reqs;
709                 p = "ISO";
710                 break;
711         }
712         qh->bandwidth_reserved = 0;
713         dev_dbg(uhci_dev(uhci),
714                         "%s dev %d ep%02x-%s, period %d, phase %d, %d us\n",
715                         "release", qh->udev->devnum,
716                         qh->hep->desc.bEndpointAddress, p,
717                         qh->period, qh->phase, load);
718 }
719
720 static inline struct urb_priv *uhci_alloc_urb_priv(struct uhci_hcd *uhci,
721                 struct urb *urb)
722 {
723         struct urb_priv *urbp;
724
725         urbp = kmem_cache_zalloc(uhci_up_cachep, GFP_ATOMIC);
726         if (!urbp)
727                 return NULL;
728
729         urbp->urb = urb;
730         urb->hcpriv = urbp;
731         
732         INIT_LIST_HEAD(&urbp->node);
733         INIT_LIST_HEAD(&urbp->td_list);
734
735         return urbp;
736 }
737
738 static void uhci_free_urb_priv(struct uhci_hcd *uhci,
739                 struct urb_priv *urbp)
740 {
741         struct uhci_td *td, *tmp;
742
743         if (!list_empty(&urbp->node))
744                 dev_WARN(uhci_dev(uhci), "urb %p still on QH's list!\n",
745                                 urbp->urb);
746
747         list_for_each_entry_safe(td, tmp, &urbp->td_list, list) {
748                 uhci_remove_td_from_urbp(td);
749                 uhci_free_td(uhci, td);
750         }
751
752         kmem_cache_free(uhci_up_cachep, urbp);
753 }
754
755 /*
756  * Map status to standard result codes
757  *
758  * <status> is (td_status(td) & 0xF60000), a.k.a.
759  * uhci_status_bits(td_status(td)).
760  * Note: <status> does not include the TD_CTRL_NAK bit.
761  * <dir_out> is True for output TDs and False for input TDs.
762  */
763 static int uhci_map_status(int status, int dir_out)
764 {
765         if (!status)
766                 return 0;
767         if (status & TD_CTRL_BITSTUFF)                  /* Bitstuff error */
768                 return -EPROTO;
769         if (status & TD_CTRL_CRCTIMEO) {                /* CRC/Timeout */
770                 if (dir_out)
771                         return -EPROTO;
772                 else
773                         return -EILSEQ;
774         }
775         if (status & TD_CTRL_BABBLE)                    /* Babble */
776                 return -EOVERFLOW;
777         if (status & TD_CTRL_DBUFERR)                   /* Buffer error */
778                 return -ENOSR;
779         if (status & TD_CTRL_STALLED)                   /* Stalled */
780                 return -EPIPE;
781         return 0;
782 }
783
784 /*
785  * Control transfers
786  */
787 static int uhci_submit_control(struct uhci_hcd *uhci, struct urb *urb,
788                 struct uhci_qh *qh)
789 {
790         struct uhci_td *td;
791         unsigned long destination, status;
792         int maxsze = le16_to_cpu(qh->hep->desc.wMaxPacketSize);
793         int len = urb->transfer_buffer_length;
794         dma_addr_t data = urb->transfer_dma;
795         __le32 *plink;
796         struct urb_priv *urbp = urb->hcpriv;
797         int skel;
798
799         /* The "pipe" thing contains the destination in bits 8--18 */
800         destination = (urb->pipe & PIPE_DEVEP_MASK) | USB_PID_SETUP;
801
802         /* 3 errors, dummy TD remains inactive */
803         status = uhci_maxerr(3);
804         if (urb->dev->speed == USB_SPEED_LOW)
805                 status |= TD_CTRL_LS;
806
807         /*
808          * Build the TD for the control request setup packet
809          */
810         td = qh->dummy_td;
811         uhci_add_td_to_urbp(td, urbp);
812         uhci_fill_td(td, status, destination | uhci_explen(8),
813                         urb->setup_dma);
814         plink = &td->link;
815         status |= TD_CTRL_ACTIVE;
816
817         /*
818          * If direction is "send", change the packet ID from SETUP (0x2D)
819          * to OUT (0xE1).  Else change it from SETUP to IN (0x69) and
820          * set Short Packet Detect (SPD) for all data packets.
821          *
822          * 0-length transfers always get treated as "send".
823          */
824         if (usb_pipeout(urb->pipe) || len == 0)
825                 destination ^= (USB_PID_SETUP ^ USB_PID_OUT);
826         else {
827                 destination ^= (USB_PID_SETUP ^ USB_PID_IN);
828                 status |= TD_CTRL_SPD;
829         }
830
831         /*
832          * Build the DATA TDs
833          */
834         while (len > 0) {
835                 int pktsze = maxsze;
836
837                 if (len <= pktsze) {            /* The last data packet */
838                         pktsze = len;
839                         status &= ~TD_CTRL_SPD;
840                 }
841
842                 td = uhci_alloc_td(uhci);
843                 if (!td)
844                         goto nomem;
845                 *plink = LINK_TO_TD(td);
846
847                 /* Alternate Data0/1 (start with Data1) */
848                 destination ^= TD_TOKEN_TOGGLE;
849         
850                 uhci_add_td_to_urbp(td, urbp);
851                 uhci_fill_td(td, status, destination | uhci_explen(pktsze),
852                                 data);
853                 plink = &td->link;
854
855                 data += pktsze;
856                 len -= pktsze;
857         }
858
859         /*
860          * Build the final TD for control status 
861          */
862         td = uhci_alloc_td(uhci);
863         if (!td)
864                 goto nomem;
865         *plink = LINK_TO_TD(td);
866
867         /* Change direction for the status transaction */
868         destination ^= (USB_PID_IN ^ USB_PID_OUT);
869         destination |= TD_TOKEN_TOGGLE;         /* End in Data1 */
870
871         uhci_add_td_to_urbp(td, urbp);
872         uhci_fill_td(td, status | TD_CTRL_IOC,
873                         destination | uhci_explen(0), 0);
874         plink = &td->link;
875
876         /*
877          * Build the new dummy TD and activate the old one
878          */
879         td = uhci_alloc_td(uhci);
880         if (!td)
881                 goto nomem;
882         *plink = LINK_TO_TD(td);
883
884         uhci_fill_td(td, 0, USB_PID_OUT | uhci_explen(0), 0);
885         wmb();
886         qh->dummy_td->status |= cpu_to_le32(TD_CTRL_ACTIVE);
887         qh->dummy_td = td;
888
889         /* Low-speed transfers get a different queue, and won't hog the bus.
890          * Also, some devices enumerate better without FSBR; the easiest way
891          * to do that is to put URBs on the low-speed queue while the device
892          * isn't in the CONFIGURED state. */
893         if (urb->dev->speed == USB_SPEED_LOW ||
894                         urb->dev->state != USB_STATE_CONFIGURED)
895                 skel = SKEL_LS_CONTROL;
896         else {
897                 skel = SKEL_FS_CONTROL;
898                 uhci_add_fsbr(uhci, urb);
899         }
900         if (qh->state != QH_STATE_ACTIVE)
901                 qh->skel = skel;
902         return 0;
903
904 nomem:
905         /* Remove the dummy TD from the td_list so it doesn't get freed */
906         uhci_remove_td_from_urbp(qh->dummy_td);
907         return -ENOMEM;
908 }
909
910 /*
911  * Common submit for bulk and interrupt
912  */
913 static int uhci_submit_common(struct uhci_hcd *uhci, struct urb *urb,
914                 struct uhci_qh *qh)
915 {
916         struct uhci_td *td;
917         unsigned long destination, status;
918         int maxsze = le16_to_cpu(qh->hep->desc.wMaxPacketSize);
919         int len = urb->transfer_buffer_length;
920         dma_addr_t data = urb->transfer_dma;
921         __le32 *plink;
922         struct urb_priv *urbp = urb->hcpriv;
923         unsigned int toggle;
924
925         if (len < 0)
926                 return -EINVAL;
927
928         /* The "pipe" thing contains the destination in bits 8--18 */
929         destination = (urb->pipe & PIPE_DEVEP_MASK) | usb_packetid(urb->pipe);
930         toggle = usb_gettoggle(urb->dev, usb_pipeendpoint(urb->pipe),
931                          usb_pipeout(urb->pipe));
932
933         /* 3 errors, dummy TD remains inactive */
934         status = uhci_maxerr(3);
935         if (urb->dev->speed == USB_SPEED_LOW)
936                 status |= TD_CTRL_LS;
937         if (usb_pipein(urb->pipe))
938                 status |= TD_CTRL_SPD;
939
940         /*
941          * Build the DATA TDs
942          */
943         plink = NULL;
944         td = qh->dummy_td;
945         do {    /* Allow zero length packets */
946                 int pktsze = maxsze;
947
948                 if (len <= pktsze) {            /* The last packet */
949                         pktsze = len;
950                         if (!(urb->transfer_flags & URB_SHORT_NOT_OK))
951                                 status &= ~TD_CTRL_SPD;
952                 }
953
954                 if (plink) {
955                         td = uhci_alloc_td(uhci);
956                         if (!td)
957                                 goto nomem;
958                         *plink = LINK_TO_TD(td);
959                 }
960                 uhci_add_td_to_urbp(td, urbp);
961                 uhci_fill_td(td, status,
962                                 destination | uhci_explen(pktsze) |
963                                         (toggle << TD_TOKEN_TOGGLE_SHIFT),
964                                 data);
965                 plink = &td->link;
966                 status |= TD_CTRL_ACTIVE;
967
968                 data += pktsze;
969                 len -= maxsze;
970                 toggle ^= 1;
971         } while (len > 0);
972
973         /*
974          * URB_ZERO_PACKET means adding a 0-length packet, if direction
975          * is OUT and the transfer_length was an exact multiple of maxsze,
976          * hence (len = transfer_length - N * maxsze) == 0
977          * however, if transfer_length == 0, the zero packet was already
978          * prepared above.
979          */
980         if ((urb->transfer_flags & URB_ZERO_PACKET) &&
981                         usb_pipeout(urb->pipe) && len == 0 &&
982                         urb->transfer_buffer_length > 0) {
983                 td = uhci_alloc_td(uhci);
984                 if (!td)
985                         goto nomem;
986                 *plink = LINK_TO_TD(td);
987
988                 uhci_add_td_to_urbp(td, urbp);
989                 uhci_fill_td(td, status,
990                                 destination | uhci_explen(0) |
991                                         (toggle << TD_TOKEN_TOGGLE_SHIFT),
992                                 data);
993                 plink = &td->link;
994
995                 toggle ^= 1;
996         }
997
998         /* Set the interrupt-on-completion flag on the last packet.
999          * A more-or-less typical 4 KB URB (= size of one memory page)
1000          * will require about 3 ms to transfer; that's a little on the
1001          * fast side but not enough to justify delaying an interrupt
1002          * more than 2 or 3 URBs, so we will ignore the URB_NO_INTERRUPT
1003          * flag setting. */
1004         td->status |= cpu_to_le32(TD_CTRL_IOC);
1005
1006         /*
1007          * Build the new dummy TD and activate the old one
1008          */
1009         td = uhci_alloc_td(uhci);
1010         if (!td)
1011                 goto nomem;
1012         *plink = LINK_TO_TD(td);
1013
1014         uhci_fill_td(td, 0, USB_PID_OUT | uhci_explen(0), 0);
1015         wmb();
1016         qh->dummy_td->status |= cpu_to_le32(TD_CTRL_ACTIVE);
1017         qh->dummy_td = td;
1018
1019         usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
1020                         usb_pipeout(urb->pipe), toggle);
1021         return 0;
1022
1023 nomem:
1024         /* Remove the dummy TD from the td_list so it doesn't get freed */
1025         uhci_remove_td_from_urbp(qh->dummy_td);
1026         return -ENOMEM;
1027 }
1028
1029 static int uhci_submit_bulk(struct uhci_hcd *uhci, struct urb *urb,
1030                 struct uhci_qh *qh)
1031 {
1032         int ret;
1033
1034         /* Can't have low-speed bulk transfers */
1035         if (urb->dev->speed == USB_SPEED_LOW)
1036                 return -EINVAL;
1037
1038         if (qh->state != QH_STATE_ACTIVE)
1039                 qh->skel = SKEL_BULK;
1040         ret = uhci_submit_common(uhci, urb, qh);
1041         if (ret == 0)
1042                 uhci_add_fsbr(uhci, urb);
1043         return ret;
1044 }
1045
1046 static int uhci_submit_interrupt(struct uhci_hcd *uhci, struct urb *urb,
1047                 struct uhci_qh *qh)
1048 {
1049         int ret;
1050
1051         /* USB 1.1 interrupt transfers only involve one packet per interval.
1052          * Drivers can submit URBs of any length, but longer ones will need
1053          * multiple intervals to complete.
1054          */
1055
1056         if (!qh->bandwidth_reserved) {
1057                 int exponent;
1058
1059                 /* Figure out which power-of-two queue to use */
1060                 for (exponent = 7; exponent >= 0; --exponent) {
1061                         if ((1 << exponent) <= urb->interval)
1062                                 break;
1063                 }
1064                 if (exponent < 0)
1065                         return -EINVAL;
1066
1067                 /* If the slot is full, try a lower period */
1068                 do {
1069                         qh->period = 1 << exponent;
1070                         qh->skel = SKEL_INDEX(exponent);
1071
1072                         /* For now, interrupt phase is fixed by the layout
1073                          * of the QH lists.
1074                          */
1075                         qh->phase = (qh->period / 2) & (MAX_PHASE - 1);
1076                         ret = uhci_check_bandwidth(uhci, qh);
1077                 } while (ret != 0 && --exponent >= 0);
1078                 if (ret)
1079                         return ret;
1080         } else if (qh->period > urb->interval)
1081                 return -EINVAL;         /* Can't decrease the period */
1082
1083         ret = uhci_submit_common(uhci, urb, qh);
1084         if (ret == 0) {
1085                 urb->interval = qh->period;
1086                 if (!qh->bandwidth_reserved)
1087                         uhci_reserve_bandwidth(uhci, qh);
1088         }
1089         return ret;
1090 }
1091
1092 /*
1093  * Fix up the data structures following a short transfer
1094  */
1095 static int uhci_fixup_short_transfer(struct uhci_hcd *uhci,
1096                 struct uhci_qh *qh, struct urb_priv *urbp)
1097 {
1098         struct uhci_td *td;
1099         struct list_head *tmp;
1100         int ret;
1101
1102         td = list_entry(urbp->td_list.prev, struct uhci_td, list);
1103         if (qh->type == USB_ENDPOINT_XFER_CONTROL) {
1104
1105                 /* When a control transfer is short, we have to restart
1106                  * the queue at the status stage transaction, which is
1107                  * the last TD. */
1108                 WARN_ON(list_empty(&urbp->td_list));
1109                 qh->element = LINK_TO_TD(td);
1110                 tmp = td->list.prev;
1111                 ret = -EINPROGRESS;
1112
1113         } else {
1114
1115                 /* When a bulk/interrupt transfer is short, we have to
1116                  * fix up the toggles of the following URBs on the queue
1117                  * before restarting the queue at the next URB. */
1118                 qh->initial_toggle = uhci_toggle(td_token(qh->post_td)) ^ 1;
1119                 uhci_fixup_toggles(qh, 1);
1120
1121                 if (list_empty(&urbp->td_list))
1122                         td = qh->post_td;
1123                 qh->element = td->link;
1124                 tmp = urbp->td_list.prev;
1125                 ret = 0;
1126         }
1127
1128         /* Remove all the TDs we skipped over, from tmp back to the start */
1129         while (tmp != &urbp->td_list) {
1130                 td = list_entry(tmp, struct uhci_td, list);
1131                 tmp = tmp->prev;
1132
1133                 uhci_remove_td_from_urbp(td);
1134                 uhci_free_td(uhci, td);
1135         }
1136         return ret;
1137 }
1138
1139 /*
1140  * Common result for control, bulk, and interrupt
1141  */
1142 static int uhci_result_common(struct uhci_hcd *uhci, struct urb *urb)
1143 {
1144         struct urb_priv *urbp = urb->hcpriv;
1145         struct uhci_qh *qh = urbp->qh;
1146         struct uhci_td *td, *tmp;
1147         unsigned status;
1148         int ret = 0;
1149
1150         list_for_each_entry_safe(td, tmp, &urbp->td_list, list) {
1151                 unsigned int ctrlstat;
1152                 int len;
1153
1154                 ctrlstat = td_status(td);
1155                 status = uhci_status_bits(ctrlstat);
1156                 if (status & TD_CTRL_ACTIVE)
1157                         return -EINPROGRESS;
1158
1159                 len = uhci_actual_length(ctrlstat);
1160                 urb->actual_length += len;
1161
1162                 if (status) {
1163                         ret = uhci_map_status(status,
1164                                         uhci_packetout(td_token(td)));
1165                         if ((debug == 1 && ret != -EPIPE) || debug > 1) {
1166                                 /* Some debugging code */
1167                                 dev_dbg(&urb->dev->dev,
1168                                                 "%s: failed with status %x\n",
1169                                                 __func__, status);
1170
1171                                 if (debug > 1 && errbuf) {
1172                                         /* Print the chain for debugging */
1173                                         uhci_show_qh(uhci, urbp->qh, errbuf,
1174                                                         ERRBUF_LEN, 0);
1175                                         lprintk(errbuf);
1176                                 }
1177                         }
1178
1179                 /* Did we receive a short packet? */
1180                 } else if (len < uhci_expected_length(td_token(td))) {
1181
1182                         /* For control transfers, go to the status TD if
1183                          * this isn't already the last data TD */
1184                         if (qh->type == USB_ENDPOINT_XFER_CONTROL) {
1185                                 if (td->list.next != urbp->td_list.prev)
1186                                         ret = 1;
1187                         }
1188
1189                         /* For bulk and interrupt, this may be an error */
1190                         else if (urb->transfer_flags & URB_SHORT_NOT_OK)
1191                                 ret = -EREMOTEIO;
1192
1193                         /* Fixup needed only if this isn't the URB's last TD */
1194                         else if (&td->list != urbp->td_list.prev)
1195                                 ret = 1;
1196                 }
1197
1198                 uhci_remove_td_from_urbp(td);
1199                 if (qh->post_td)
1200                         uhci_free_td(uhci, qh->post_td);
1201                 qh->post_td = td;
1202
1203                 if (ret != 0)
1204                         goto err;
1205         }
1206         return ret;
1207
1208 err:
1209         if (ret < 0) {
1210                 /* Note that the queue has stopped and save
1211                  * the next toggle value */
1212                 qh->element = UHCI_PTR_TERM;
1213                 qh->is_stopped = 1;
1214                 qh->needs_fixup = (qh->type != USB_ENDPOINT_XFER_CONTROL);
1215                 qh->initial_toggle = uhci_toggle(td_token(td)) ^
1216                                 (ret == -EREMOTEIO);
1217
1218         } else          /* Short packet received */
1219                 ret = uhci_fixup_short_transfer(uhci, qh, urbp);
1220         return ret;
1221 }
1222
1223 /*
1224  * Isochronous transfers
1225  */
1226 static int uhci_submit_isochronous(struct uhci_hcd *uhci, struct urb *urb,
1227                 struct uhci_qh *qh)
1228 {
1229         struct uhci_td *td = NULL;      /* Since urb->number_of_packets > 0 */
1230         int i, frame;
1231         unsigned long destination, status;
1232         struct urb_priv *urbp = (struct urb_priv *) urb->hcpriv;
1233
1234         /* Values must not be too big (could overflow below) */
1235         if (urb->interval >= UHCI_NUMFRAMES ||
1236                         urb->number_of_packets >= UHCI_NUMFRAMES)
1237                 return -EFBIG;
1238
1239         /* Check the period and figure out the starting frame number */
1240         if (!qh->bandwidth_reserved) {
1241                 qh->period = urb->interval;
1242                 if (urb->transfer_flags & URB_ISO_ASAP) {
1243                         qh->phase = -1;         /* Find the best phase */
1244                         i = uhci_check_bandwidth(uhci, qh);
1245                         if (i)
1246                                 return i;
1247
1248                         /* Allow a little time to allocate the TDs */
1249                         uhci_get_current_frame_number(uhci);
1250                         frame = uhci->frame_number + 10;
1251
1252                         /* Move forward to the first frame having the
1253                          * correct phase */
1254                         urb->start_frame = frame + ((qh->phase - frame) &
1255                                         (qh->period - 1));
1256                 } else {
1257                         i = urb->start_frame - uhci->last_iso_frame;
1258                         if (i <= 0 || i >= UHCI_NUMFRAMES)
1259                                 return -EINVAL;
1260                         qh->phase = urb->start_frame & (qh->period - 1);
1261                         i = uhci_check_bandwidth(uhci, qh);
1262                         if (i)
1263                                 return i;
1264                 }
1265
1266         } else if (qh->period != urb->interval) {
1267                 return -EINVAL;         /* Can't change the period */
1268
1269         } else {
1270                 /* Find the next unused frame */
1271                 if (list_empty(&qh->queue)) {
1272                         frame = qh->iso_frame;
1273                 } else {
1274                         struct urb *lurb;
1275
1276                         lurb = list_entry(qh->queue.prev,
1277                                         struct urb_priv, node)->urb;
1278                         frame = lurb->start_frame +
1279                                         lurb->number_of_packets *
1280                                         lurb->interval;
1281                 }
1282                 if (urb->transfer_flags & URB_ISO_ASAP) {
1283                         /* Skip some frames if necessary to insure
1284                          * the start frame is in the future.
1285                          */
1286                         uhci_get_current_frame_number(uhci);
1287                         if (uhci_frame_before_eq(frame, uhci->frame_number)) {
1288                                 frame = uhci->frame_number + 1;
1289                                 frame += ((qh->phase - frame) &
1290                                         (qh->period - 1));
1291                         }
1292                 }       /* Otherwise pick up where the last URB leaves off */
1293                 urb->start_frame = frame;
1294         }
1295
1296         /* Make sure we won't have to go too far into the future */
1297         if (uhci_frame_before_eq(uhci->last_iso_frame + UHCI_NUMFRAMES,
1298                         urb->start_frame + urb->number_of_packets *
1299                                 urb->interval))
1300                 return -EFBIG;
1301
1302         status = TD_CTRL_ACTIVE | TD_CTRL_IOS;
1303         destination = (urb->pipe & PIPE_DEVEP_MASK) | usb_packetid(urb->pipe);
1304
1305         for (i = 0; i < urb->number_of_packets; i++) {
1306                 td = uhci_alloc_td(uhci);
1307                 if (!td)
1308                         return -ENOMEM;
1309
1310                 uhci_add_td_to_urbp(td, urbp);
1311                 uhci_fill_td(td, status, destination |
1312                                 uhci_explen(urb->iso_frame_desc[i].length),
1313                                 urb->transfer_dma +
1314                                         urb->iso_frame_desc[i].offset);
1315         }
1316
1317         /* Set the interrupt-on-completion flag on the last packet. */
1318         td->status |= cpu_to_le32(TD_CTRL_IOC);
1319
1320         /* Add the TDs to the frame list */
1321         frame = urb->start_frame;
1322         list_for_each_entry(td, &urbp->td_list, list) {
1323                 uhci_insert_td_in_frame_list(uhci, td, frame);
1324                 frame += qh->period;
1325         }
1326
1327         if (list_empty(&qh->queue)) {
1328                 qh->iso_packet_desc = &urb->iso_frame_desc[0];
1329                 qh->iso_frame = urb->start_frame;
1330         }
1331
1332         qh->skel = SKEL_ISO;
1333         if (!qh->bandwidth_reserved)
1334                 uhci_reserve_bandwidth(uhci, qh);
1335         return 0;
1336 }
1337
1338 static int uhci_result_isochronous(struct uhci_hcd *uhci, struct urb *urb)
1339 {
1340         struct uhci_td *td, *tmp;
1341         struct urb_priv *urbp = urb->hcpriv;
1342         struct uhci_qh *qh = urbp->qh;
1343
1344         list_for_each_entry_safe(td, tmp, &urbp->td_list, list) {
1345                 unsigned int ctrlstat;
1346                 int status;
1347                 int actlength;
1348
1349                 if (uhci_frame_before_eq(uhci->cur_iso_frame, qh->iso_frame))
1350                         return -EINPROGRESS;
1351
1352                 uhci_remove_tds_from_frame(uhci, qh->iso_frame);
1353
1354                 ctrlstat = td_status(td);
1355                 if (ctrlstat & TD_CTRL_ACTIVE) {
1356                         status = -EXDEV;        /* TD was added too late? */
1357                 } else {
1358                         status = uhci_map_status(uhci_status_bits(ctrlstat),
1359                                         usb_pipeout(urb->pipe));
1360                         actlength = uhci_actual_length(ctrlstat);
1361
1362                         urb->actual_length += actlength;
1363                         qh->iso_packet_desc->actual_length = actlength;
1364                         qh->iso_packet_desc->status = status;
1365                 }
1366                 if (status)
1367                         urb->error_count++;
1368
1369                 uhci_remove_td_from_urbp(td);
1370                 uhci_free_td(uhci, td);
1371                 qh->iso_frame += qh->period;
1372                 ++qh->iso_packet_desc;
1373         }
1374         return 0;
1375 }
1376
1377 static int uhci_urb_enqueue(struct usb_hcd *hcd,
1378                 struct urb *urb, gfp_t mem_flags)
1379 {
1380         int ret;
1381         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
1382         unsigned long flags;
1383         struct urb_priv *urbp;
1384         struct uhci_qh *qh;
1385
1386         spin_lock_irqsave(&uhci->lock, flags);
1387
1388         ret = usb_hcd_link_urb_to_ep(hcd, urb);
1389         if (ret)
1390                 goto done_not_linked;
1391
1392         ret = -ENOMEM;
1393         urbp = uhci_alloc_urb_priv(uhci, urb);
1394         if (!urbp)
1395                 goto done;
1396
1397         if (urb->ep->hcpriv)
1398                 qh = urb->ep->hcpriv;
1399         else {
1400                 qh = uhci_alloc_qh(uhci, urb->dev, urb->ep);
1401                 if (!qh)
1402                         goto err_no_qh;
1403         }
1404         urbp->qh = qh;
1405
1406         switch (qh->type) {
1407         case USB_ENDPOINT_XFER_CONTROL:
1408                 ret = uhci_submit_control(uhci, urb, qh);
1409                 break;
1410         case USB_ENDPOINT_XFER_BULK:
1411                 ret = uhci_submit_bulk(uhci, urb, qh);
1412                 break;
1413         case USB_ENDPOINT_XFER_INT:
1414                 ret = uhci_submit_interrupt(uhci, urb, qh);
1415                 break;
1416         case USB_ENDPOINT_XFER_ISOC:
1417                 urb->error_count = 0;
1418                 ret = uhci_submit_isochronous(uhci, urb, qh);
1419                 break;
1420         }
1421         if (ret != 0)
1422                 goto err_submit_failed;
1423
1424         /* Add this URB to the QH */
1425         urbp->qh = qh;
1426         list_add_tail(&urbp->node, &qh->queue);
1427
1428         /* If the new URB is the first and only one on this QH then either
1429          * the QH is new and idle or else it's unlinked and waiting to
1430          * become idle, so we can activate it right away.  But only if the
1431          * queue isn't stopped. */
1432         if (qh->queue.next == &urbp->node && !qh->is_stopped) {
1433                 uhci_activate_qh(uhci, qh);
1434                 uhci_urbp_wants_fsbr(uhci, urbp);
1435         }
1436         goto done;
1437
1438 err_submit_failed:
1439         if (qh->state == QH_STATE_IDLE)
1440                 uhci_make_qh_idle(uhci, qh);    /* Reclaim unused QH */
1441 err_no_qh:
1442         uhci_free_urb_priv(uhci, urbp);
1443 done:
1444         if (ret)
1445                 usb_hcd_unlink_urb_from_ep(hcd, urb);
1446 done_not_linked:
1447         spin_unlock_irqrestore(&uhci->lock, flags);
1448         return ret;
1449 }
1450
1451 static int uhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1452 {
1453         struct uhci_hcd *uhci = hcd_to_uhci(hcd);
1454         unsigned long flags;
1455         struct uhci_qh *qh;
1456         int rc;
1457
1458         spin_lock_irqsave(&uhci->lock, flags);
1459         rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1460         if (rc)
1461                 goto done;
1462
1463         qh = ((struct urb_priv *) urb->hcpriv)->qh;
1464
1465         /* Remove Isochronous TDs from the frame list ASAP */
1466         if (qh->type == USB_ENDPOINT_XFER_ISOC) {
1467                 uhci_unlink_isochronous_tds(uhci, urb);
1468                 mb();
1469
1470                 /* If the URB has already started, update the QH unlink time */
1471                 uhci_get_current_frame_number(uhci);
1472                 if (uhci_frame_before_eq(urb->start_frame, uhci->frame_number))
1473                         qh->unlink_frame = uhci->frame_number;
1474         }
1475
1476         uhci_unlink_qh(uhci, qh);
1477
1478 done:
1479         spin_unlock_irqrestore(&uhci->lock, flags);
1480         return rc;
1481 }
1482
1483 /*
1484  * Finish unlinking an URB and give it back
1485  */
1486 static void uhci_giveback_urb(struct uhci_hcd *uhci, struct uhci_qh *qh,
1487                 struct urb *urb, int status)
1488 __releases(uhci->lock)
1489 __acquires(uhci->lock)
1490 {
1491         struct urb_priv *urbp = (struct urb_priv *) urb->hcpriv;
1492
1493         if (qh->type == USB_ENDPOINT_XFER_CONTROL) {
1494
1495                 /* Subtract off the length of the SETUP packet from
1496                  * urb->actual_length.
1497                  */
1498                 urb->actual_length -= min_t(u32, 8, urb->actual_length);
1499         }
1500
1501         /* When giving back the first URB in an Isochronous queue,
1502          * reinitialize the QH's iso-related members for the next URB. */
1503         else if (qh->type == USB_ENDPOINT_XFER_ISOC &&
1504                         urbp->node.prev == &qh->queue &&
1505                         urbp->node.next != &qh->queue) {
1506                 struct urb *nurb = list_entry(urbp->node.next,
1507                                 struct urb_priv, node)->urb;
1508
1509                 qh->iso_packet_desc = &nurb->iso_frame_desc[0];
1510                 qh->iso_frame = nurb->start_frame;
1511         }
1512
1513         /* Take the URB off the QH's queue.  If the queue is now empty,
1514          * this is a perfect time for a toggle fixup. */
1515         list_del_init(&urbp->node);
1516         if (list_empty(&qh->queue) && qh->needs_fixup) {
1517                 usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
1518                                 usb_pipeout(urb->pipe), qh->initial_toggle);
1519                 qh->needs_fixup = 0;
1520         }
1521
1522         uhci_free_urb_priv(uhci, urbp);
1523         usb_hcd_unlink_urb_from_ep(uhci_to_hcd(uhci), urb);
1524
1525         spin_unlock(&uhci->lock);
1526         usb_hcd_giveback_urb(uhci_to_hcd(uhci), urb, status);
1527         spin_lock(&uhci->lock);
1528
1529         /* If the queue is now empty, we can unlink the QH and give up its
1530          * reserved bandwidth. */
1531         if (list_empty(&qh->queue)) {
1532                 uhci_unlink_qh(uhci, qh);
1533                 if (qh->bandwidth_reserved)
1534                         uhci_release_bandwidth(uhci, qh);
1535         }
1536 }
1537
1538 /*
1539  * Scan the URBs in a QH's queue
1540  */
1541 #define QH_FINISHED_UNLINKING(qh)                       \
1542                 (qh->state == QH_STATE_UNLINKING &&     \
1543                 uhci->frame_number + uhci->is_stopped != qh->unlink_frame)
1544
1545 static void uhci_scan_qh(struct uhci_hcd *uhci, struct uhci_qh *qh)
1546 {
1547         struct urb_priv *urbp;
1548         struct urb *urb;
1549         int status;
1550
1551         while (!list_empty(&qh->queue)) {
1552                 urbp = list_entry(qh->queue.next, struct urb_priv, node);
1553                 urb = urbp->urb;
1554
1555                 if (qh->type == USB_ENDPOINT_XFER_ISOC)
1556                         status = uhci_result_isochronous(uhci, urb);
1557                 else
1558                         status = uhci_result_common(uhci, urb);
1559                 if (status == -EINPROGRESS)
1560                         break;
1561
1562                 /* Dequeued but completed URBs can't be given back unless
1563                  * the QH is stopped or has finished unlinking. */
1564                 if (urb->unlinked) {
1565                         if (QH_FINISHED_UNLINKING(qh))
1566                                 qh->is_stopped = 1;
1567                         else if (!qh->is_stopped)
1568                                 return;
1569                 }
1570
1571                 uhci_giveback_urb(uhci, qh, urb, status);
1572                 if (status < 0)
1573                         break;
1574         }
1575
1576         /* If the QH is neither stopped nor finished unlinking (normal case),
1577          * our work here is done. */
1578         if (QH_FINISHED_UNLINKING(qh))
1579                 qh->is_stopped = 1;
1580         else if (!qh->is_stopped)
1581                 return;
1582
1583         /* Otherwise give back each of the dequeued URBs */
1584 restart:
1585         list_for_each_entry(urbp, &qh->queue, node) {
1586                 urb = urbp->urb;
1587                 if (urb->unlinked) {
1588
1589                         /* Fix up the TD links and save the toggles for
1590                          * non-Isochronous queues.  For Isochronous queues,
1591                          * test for too-recent dequeues. */
1592                         if (!uhci_cleanup_queue(uhci, qh, urb)) {
1593                                 qh->is_stopped = 0;
1594                                 return;
1595                         }
1596                         uhci_giveback_urb(uhci, qh, urb, 0);
1597                         goto restart;
1598                 }
1599         }
1600         qh->is_stopped = 0;
1601
1602         /* There are no more dequeued URBs.  If there are still URBs on the
1603          * queue, the QH can now be re-activated. */
1604         if (!list_empty(&qh->queue)) {
1605                 if (qh->needs_fixup)
1606                         uhci_fixup_toggles(qh, 0);
1607
1608                 /* If the first URB on the queue wants FSBR but its time
1609                  * limit has expired, set the next TD to interrupt on
1610                  * completion before reactivating the QH. */
1611                 urbp = list_entry(qh->queue.next, struct urb_priv, node);
1612                 if (urbp->fsbr && qh->wait_expired) {
1613                         struct uhci_td *td = list_entry(urbp->td_list.next,
1614                                         struct uhci_td, list);
1615
1616                         td->status |= __cpu_to_le32(TD_CTRL_IOC);
1617                 }
1618
1619                 uhci_activate_qh(uhci, qh);
1620         }
1621
1622         /* The queue is empty.  The QH can become idle if it is fully
1623          * unlinked. */
1624         else if (QH_FINISHED_UNLINKING(qh))
1625                 uhci_make_qh_idle(uhci, qh);
1626 }
1627
1628 /*
1629  * Check for queues that have made some forward progress.
1630  * Returns 0 if the queue is not Isochronous, is ACTIVE, and
1631  * has not advanced since last examined; 1 otherwise.
1632  *
1633  * Early Intel controllers have a bug which causes qh->element sometimes
1634  * not to advance when a TD completes successfully.  The queue remains
1635  * stuck on the inactive completed TD.  We detect such cases and advance
1636  * the element pointer by hand.
1637  */
1638 static int uhci_advance_check(struct uhci_hcd *uhci, struct uhci_qh *qh)
1639 {
1640         struct urb_priv *urbp = NULL;
1641         struct uhci_td *td;
1642         int ret = 1;
1643         unsigned status;
1644
1645         if (qh->type == USB_ENDPOINT_XFER_ISOC)
1646                 goto done;
1647
1648         /* Treat an UNLINKING queue as though it hasn't advanced.
1649          * This is okay because reactivation will treat it as though
1650          * it has advanced, and if it is going to become IDLE then
1651          * this doesn't matter anyway.  Furthermore it's possible
1652          * for an UNLINKING queue not to have any URBs at all, or
1653          * for its first URB not to have any TDs (if it was dequeued
1654          * just as it completed).  So it's not easy in any case to
1655          * test whether such queues have advanced. */
1656         if (qh->state != QH_STATE_ACTIVE) {
1657                 urbp = NULL;
1658                 status = 0;
1659
1660         } else {
1661                 urbp = list_entry(qh->queue.next, struct urb_priv, node);
1662                 td = list_entry(urbp->td_list.next, struct uhci_td, list);
1663                 status = td_status(td);
1664                 if (!(status & TD_CTRL_ACTIVE)) {
1665
1666                         /* We're okay, the queue has advanced */
1667                         qh->wait_expired = 0;
1668                         qh->advance_jiffies = jiffies;
1669                         goto done;
1670                 }
1671                 ret = 0;
1672         }
1673
1674         /* The queue hasn't advanced; check for timeout */
1675         if (qh->wait_expired)
1676                 goto done;
1677
1678         if (time_after(jiffies, qh->advance_jiffies + QH_WAIT_TIMEOUT)) {
1679
1680                 /* Detect the Intel bug and work around it */
1681                 if (qh->post_td && qh_element(qh) == LINK_TO_TD(qh->post_td)) {
1682                         qh->element = qh->post_td->link;
1683                         qh->advance_jiffies = jiffies;
1684                         ret = 1;
1685                         goto done;
1686                 }
1687
1688                 qh->wait_expired = 1;
1689
1690                 /* If the current URB wants FSBR, unlink it temporarily
1691                  * so that we can safely set the next TD to interrupt on
1692                  * completion.  That way we'll know as soon as the queue
1693                  * starts moving again. */
1694                 if (urbp && urbp->fsbr && !(status & TD_CTRL_IOC))
1695                         uhci_unlink_qh(uhci, qh);
1696
1697         } else {
1698                 /* Unmoving but not-yet-expired queues keep FSBR alive */
1699                 if (urbp)
1700                         uhci_urbp_wants_fsbr(uhci, urbp);
1701         }
1702
1703 done:
1704         return ret;
1705 }
1706
1707 /*
1708  * Process events in the schedule, but only in one thread at a time
1709  */
1710 static void uhci_scan_schedule(struct uhci_hcd *uhci)
1711 {
1712         int i;
1713         struct uhci_qh *qh;
1714
1715         /* Don't allow re-entrant calls */
1716         if (uhci->scan_in_progress) {
1717                 uhci->need_rescan = 1;
1718                 return;
1719         }
1720         uhci->scan_in_progress = 1;
1721 rescan:
1722         uhci->need_rescan = 0;
1723         uhci->fsbr_is_wanted = 0;
1724
1725         uhci_clear_next_interrupt(uhci);
1726         uhci_get_current_frame_number(uhci);
1727         uhci->cur_iso_frame = uhci->frame_number;
1728
1729         /* Go through all the QH queues and process the URBs in each one */
1730         for (i = 0; i < UHCI_NUM_SKELQH - 1; ++i) {
1731                 uhci->next_qh = list_entry(uhci->skelqh[i]->node.next,
1732                                 struct uhci_qh, node);
1733                 while ((qh = uhci->next_qh) != uhci->skelqh[i]) {
1734                         uhci->next_qh = list_entry(qh->node.next,
1735                                         struct uhci_qh, node);
1736
1737                         if (uhci_advance_check(uhci, qh)) {
1738                                 uhci_scan_qh(uhci, qh);
1739                                 if (qh->state == QH_STATE_ACTIVE) {
1740                                         uhci_urbp_wants_fsbr(uhci,
1741         list_entry(qh->queue.next, struct urb_priv, node));
1742                                 }
1743                         }
1744                 }
1745         }
1746
1747         uhci->last_iso_frame = uhci->cur_iso_frame;
1748         if (uhci->need_rescan)
1749                 goto rescan;
1750         uhci->scan_in_progress = 0;
1751
1752         if (uhci->fsbr_is_on && !uhci->fsbr_is_wanted &&
1753                         !uhci->fsbr_expiring) {
1754                 uhci->fsbr_expiring = 1;
1755                 mod_timer(&uhci->fsbr_timer, jiffies + FSBR_OFF_DELAY);
1756         }
1757
1758         if (list_empty(&uhci->skel_unlink_qh->node))
1759                 uhci_clear_next_interrupt(uhci);
1760         else
1761                 uhci_set_next_interrupt(uhci);
1762 }