Merge ../linus
[linux-2.6] / drivers / usb / host / ehci-hcd.c
1 /*
2  * Copyright (c) 2000-2004 by David Brownell
3  * 
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License as published by the
6  * Free Software Foundation; either version 2 of the License, or (at your
7  * option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <linux/config.h>
20
21 #ifdef CONFIG_USB_DEBUG
22         #define DEBUG
23 #else
24         #undef DEBUG
25 #endif
26
27 #include <linux/module.h>
28 #include <linux/pci.h>
29 #include <linux/dmapool.h>
30 #include <linux/kernel.h>
31 #include <linux/delay.h>
32 #include <linux/ioport.h>
33 #include <linux/sched.h>
34 #include <linux/slab.h>
35 #include <linux/smp_lock.h>
36 #include <linux/errno.h>
37 #include <linux/init.h>
38 #include <linux/timer.h>
39 #include <linux/list.h>
40 #include <linux/interrupt.h>
41 #include <linux/reboot.h>
42 #include <linux/usb.h>
43 #include <linux/moduleparam.h>
44 #include <linux/dma-mapping.h>
45
46 #include "../core/hcd.h"
47
48 #include <asm/byteorder.h>
49 #include <asm/io.h>
50 #include <asm/irq.h>
51 #include <asm/system.h>
52 #include <asm/unaligned.h>
53
54
55 /*-------------------------------------------------------------------------*/
56
57 /*
58  * EHCI hc_driver implementation ... experimental, incomplete.
59  * Based on the final 1.0 register interface specification.
60  *
61  * USB 2.0 shows up in upcoming www.pcmcia.org technology.
62  * First was PCMCIA, like ISA; then CardBus, which is PCI.
63  * Next comes "CardBay", using USB 2.0 signals.
64  *
65  * Contains additional contributions by Brad Hards, Rory Bolt, and others.
66  * Special thanks to Intel and VIA for providing host controllers to
67  * test this driver on, and Cypress (including In-System Design) for
68  * providing early devices for those host controllers to talk to!
69  *
70  * HISTORY:
71  *
72  * 2004-05-10 Root hub and PCI suspend/resume support; remote wakeup. (db)
73  * 2004-02-24 Replace pci_* with generic dma_* API calls (dsaxena@plexity.net)
74  * 2003-12-29 Rewritten high speed iso transfer support (by Michal Sojka,
75  *      <sojkam@centrum.cz>, updates by DB).
76  *
77  * 2002-11-29   Correct handling for hw async_next register.
78  * 2002-08-06   Handling for bulk and interrupt transfers is mostly shared;
79  *      only scheduling is different, no arbitrary limitations.
80  * 2002-07-25   Sanity check PCI reads, mostly for better cardbus support,
81  *      clean up HC run state handshaking.
82  * 2002-05-24   Preliminary FS/LS interrupts, using scheduling shortcuts
83  * 2002-05-11   Clear TT errors for FS/LS ctrl/bulk.  Fill in some other
84  *      missing pieces:  enabling 64bit dma, handoff from BIOS/SMM.
85  * 2002-05-07   Some error path cleanups to report better errors; wmb();
86  *      use non-CVS version id; better iso bandwidth claim.
87  * 2002-04-19   Control/bulk/interrupt submit no longer uses giveback() on
88  *      errors in submit path.  Bugfixes to interrupt scheduling/processing.
89  * 2002-03-05   Initial high-speed ISO support; reduce ITD memory; shift
90  *      more checking to generic hcd framework (db).  Make it work with
91  *      Philips EHCI; reduce PCI traffic; shorten IRQ path (Rory Bolt).
92  * 2002-01-14   Minor cleanup; version synch.
93  * 2002-01-08   Fix roothub handoff of FS/LS to companion controllers.
94  * 2002-01-04   Control/Bulk queuing behaves.
95  *
96  * 2001-12-12   Initial patch version for Linux 2.5.1 kernel.
97  * 2001-June    Works with usb-storage and NEC EHCI on 2.4
98  */
99
100 #define DRIVER_VERSION "10 Dec 2004"
101 #define DRIVER_AUTHOR "David Brownell"
102 #define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"
103
104 static const char       hcd_name [] = "ehci_hcd";
105
106
107 #undef EHCI_VERBOSE_DEBUG
108 #undef EHCI_URB_TRACE
109
110 #ifdef DEBUG
111 #define EHCI_STATS
112 #endif
113
114 /* magic numbers that can affect system performance */
115 #define EHCI_TUNE_CERR          3       /* 0-3 qtd retries; 0 == don't stop */
116 #define EHCI_TUNE_RL_HS         4       /* nak throttle; see 4.9 */
117 #define EHCI_TUNE_RL_TT         0
118 #define EHCI_TUNE_MULT_HS       1       /* 1-3 transactions/uframe; 4.10.3 */
119 #define EHCI_TUNE_MULT_TT       1
120 #define EHCI_TUNE_FLS           2       /* (small) 256 frame schedule */
121
122 #define EHCI_IAA_JIFFIES        (HZ/100)        /* arbitrary; ~10 msec */
123 #define EHCI_IO_JIFFIES         (HZ/10)         /* io watchdog > irq_thresh */
124 #define EHCI_ASYNC_JIFFIES      (HZ/20)         /* async idle timeout */
125 #define EHCI_SHRINK_JIFFIES     (HZ/200)        /* async qh unlink delay */
126
127 /* Initial IRQ latency:  faster than hw default */
128 static int log2_irq_thresh = 0;         // 0 to 6
129 module_param (log2_irq_thresh, int, S_IRUGO);
130 MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");
131
132 /* initial park setting:  slower than hw default */
133 static unsigned park = 0;
134 module_param (park, uint, S_IRUGO);
135 MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets");
136
137 #define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
138
139 /*-------------------------------------------------------------------------*/
140
141 #include "ehci.h"
142 #include "ehci-dbg.c"
143
144 /*-------------------------------------------------------------------------*/
145
146 /*
147  * handshake - spin reading hc until handshake completes or fails
148  * @ptr: address of hc register to be read
149  * @mask: bits to look at in result of read
150  * @done: value of those bits when handshake succeeds
151  * @usec: timeout in microseconds
152  *
153  * Returns negative errno, or zero on success
154  *
155  * Success happens when the "mask" bits have the specified value (hardware
156  * handshake done).  There are two failure modes:  "usec" have passed (major
157  * hardware flakeout), or the register reads as all-ones (hardware removed).
158  *
159  * That last failure should_only happen in cases like physical cardbus eject
160  * before driver shutdown. But it also seems to be caused by bugs in cardbus
161  * bridge shutdown:  shutting down the bridge before the devices using it.
162  */
163 static int handshake (void __iomem *ptr, u32 mask, u32 done, int usec)
164 {
165         u32     result;
166
167         do {
168                 result = readl (ptr);
169                 if (result == ~(u32)0)          /* card removed */
170                         return -ENODEV;
171                 result &= mask;
172                 if (result == done)
173                         return 0;
174                 udelay (1);
175                 usec--;
176         } while (usec > 0);
177         return -ETIMEDOUT;
178 }
179
180 /* force HC to halt state from unknown (EHCI spec section 2.3) */
181 static int ehci_halt (struct ehci_hcd *ehci)
182 {
183         u32     temp = readl (&ehci->regs->status);
184
185         /* disable any irqs left enabled by previous code */
186         writel (0, &ehci->regs->intr_enable);
187
188         if ((temp & STS_HALT) != 0)
189                 return 0;
190
191         temp = readl (&ehci->regs->command);
192         temp &= ~CMD_RUN;
193         writel (temp, &ehci->regs->command);
194         return handshake (&ehci->regs->status, STS_HALT, STS_HALT, 16 * 125);
195 }
196
197 /* put TDI/ARC silicon into EHCI mode */
198 static void tdi_reset (struct ehci_hcd *ehci)
199 {
200         u32 __iomem     *reg_ptr;
201         u32             tmp;
202
203         reg_ptr = (u32 __iomem *)(((u8 __iomem *)ehci->regs) + 0x68);
204         tmp = readl (reg_ptr);
205         tmp |= 0x3;
206         writel (tmp, reg_ptr);
207 }
208
209 /* reset a non-running (STS_HALT == 1) controller */
210 static int ehci_reset (struct ehci_hcd *ehci)
211 {
212         int     retval;
213         u32     command = readl (&ehci->regs->command);
214
215         command |= CMD_RESET;
216         dbg_cmd (ehci, "reset", command);
217         writel (command, &ehci->regs->command);
218         ehci_to_hcd(ehci)->state = HC_STATE_HALT;
219         ehci->next_statechange = jiffies;
220         retval = handshake (&ehci->regs->command, CMD_RESET, 0, 250 * 1000);
221
222         if (retval)
223                 return retval;
224
225         if (ehci_is_TDI(ehci))
226                 tdi_reset (ehci);
227
228         return retval;
229 }
230
231 /* idle the controller (from running) */
232 static void ehci_quiesce (struct ehci_hcd *ehci)
233 {
234         u32     temp;
235
236 #ifdef DEBUG
237         if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state))
238                 BUG ();
239 #endif
240
241         /* wait for any schedule enables/disables to take effect */
242         temp = readl (&ehci->regs->command) << 10;
243         temp &= STS_ASS | STS_PSS;
244         if (handshake (&ehci->regs->status, STS_ASS | STS_PSS,
245                                 temp, 16 * 125) != 0) {
246                 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
247                 return;
248         }
249
250         /* then disable anything that's still active */
251         temp = readl (&ehci->regs->command);
252         temp &= ~(CMD_ASE | CMD_IAAD | CMD_PSE);
253         writel (temp, &ehci->regs->command);
254
255         /* hardware can take 16 microframes to turn off ... */
256         if (handshake (&ehci->regs->status, STS_ASS | STS_PSS,
257                                 0, 16 * 125) != 0) {
258                 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
259                 return;
260         }
261 }
262
263 /*-------------------------------------------------------------------------*/
264
265 static void ehci_work(struct ehci_hcd *ehci, struct pt_regs *regs);
266
267 #include "ehci-hub.c"
268 #include "ehci-mem.c"
269 #include "ehci-q.c"
270 #include "ehci-sched.c"
271
272 /*-------------------------------------------------------------------------*/
273
274 static void ehci_watchdog (unsigned long param)
275 {
276         struct ehci_hcd         *ehci = (struct ehci_hcd *) param;
277         unsigned long           flags;
278
279         spin_lock_irqsave (&ehci->lock, flags);
280
281         /* lost IAA irqs wedge things badly; seen with a vt8235 */
282         if (ehci->reclaim) {
283                 u32             status = readl (&ehci->regs->status);
284
285                 if (status & STS_IAA) {
286                         ehci_vdbg (ehci, "lost IAA\n");
287                         COUNT (ehci->stats.lost_iaa);
288                         writel (STS_IAA, &ehci->regs->status);
289                         ehci->reclaim_ready = 1;
290                 }
291         }
292
293         /* stop async processing after it's idled a bit */
294         if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
295                 start_unlink_async (ehci, ehci->async);
296
297         /* ehci could run by timer, without IRQs ... */
298         ehci_work (ehci, NULL);
299
300         spin_unlock_irqrestore (&ehci->lock, flags);
301 }
302
303 /* Reboot notifiers kick in for silicon on any bus (not just pci, etc).
304  * This forcibly disables dma and IRQs, helping kexec and other cases
305  * where the next system software may expect clean state.
306  */
307 static int
308 ehci_reboot (struct notifier_block *self, unsigned long code, void *null)
309 {
310         struct ehci_hcd         *ehci;
311
312         ehci = container_of (self, struct ehci_hcd, reboot_notifier);
313         (void) ehci_halt (ehci);
314
315         /* make BIOS/etc use companion controller during reboot */
316         writel (0, &ehci->regs->configured_flag);
317         return 0;
318 }
319
320 static void ehci_port_power (struct ehci_hcd *ehci, int is_on)
321 {
322         unsigned port;
323
324         if (!HCS_PPC (ehci->hcs_params))
325                 return;
326
327         ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down");
328         for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; )
329                 (void) ehci_hub_control(ehci_to_hcd(ehci),
330                                 is_on ? SetPortFeature : ClearPortFeature,
331                                 USB_PORT_FEAT_POWER,
332                                 port--, NULL, 0);
333         msleep(20);
334 }
335
336 /*-------------------------------------------------------------------------*/
337
338 /*
339  * ehci_work is called from some interrupts, timers, and so on.
340  * it calls driver completion functions, after dropping ehci->lock.
341  */
342 static void ehci_work (struct ehci_hcd *ehci, struct pt_regs *regs)
343 {
344         timer_action_done (ehci, TIMER_IO_WATCHDOG);
345         if (ehci->reclaim_ready)
346                 end_unlink_async (ehci, regs);
347
348         /* another CPU may drop ehci->lock during a schedule scan while
349          * it reports urb completions.  this flag guards against bogus
350          * attempts at re-entrant schedule scanning.
351          */
352         if (ehci->scanning)
353                 return;
354         ehci->scanning = 1;
355         scan_async (ehci, regs);
356         if (ehci->next_uframe != -1)
357                 scan_periodic (ehci, regs);
358         ehci->scanning = 0;
359
360         /* the IO watchdog guards against hardware or driver bugs that
361          * misplace IRQs, and should let us run completely without IRQs.
362          * such lossage has been observed on both VT6202 and VT8235.
363          */
364         if (HC_IS_RUNNING (ehci_to_hcd(ehci)->state) &&
365                         (ehci->async->qh_next.ptr != NULL ||
366                          ehci->periodic_sched != 0))
367                 timer_action (ehci, TIMER_IO_WATCHDOG);
368 }
369
370 static void ehci_stop (struct usb_hcd *hcd)
371 {
372         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
373
374         ehci_dbg (ehci, "stop\n");
375
376         /* Turn off port power on all root hub ports. */
377         ehci_port_power (ehci, 0);
378
379         /* no more interrupts ... */
380         del_timer_sync (&ehci->watchdog);
381
382         spin_lock_irq(&ehci->lock);
383         if (HC_IS_RUNNING (hcd->state))
384                 ehci_quiesce (ehci);
385
386         ehci_reset (ehci);
387         writel (0, &ehci->regs->intr_enable);
388         spin_unlock_irq(&ehci->lock);
389
390         /* let companion controllers work when we aren't */
391         writel (0, &ehci->regs->configured_flag);
392         unregister_reboot_notifier (&ehci->reboot_notifier);
393
394         remove_debug_files (ehci);
395
396         /* root hub is shut down separately (first, when possible) */
397         spin_lock_irq (&ehci->lock);
398         if (ehci->async)
399                 ehci_work (ehci, NULL);
400         spin_unlock_irq (&ehci->lock);
401         ehci_mem_cleanup (ehci);
402
403 #ifdef  EHCI_STATS
404         ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
405                 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
406                 ehci->stats.lost_iaa);
407         ehci_dbg (ehci, "complete %ld unlink %ld\n",
408                 ehci->stats.complete, ehci->stats.unlink);
409 #endif
410
411         dbg_status (ehci, "ehci_stop completed", readl (&ehci->regs->status));
412 }
413
414 /* one-time init, only for memory state */
415 static int ehci_init(struct usb_hcd *hcd)
416 {
417         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
418         u32                     temp;
419         int                     retval;
420         u32                     hcc_params;
421
422         spin_lock_init(&ehci->lock);
423
424         init_timer(&ehci->watchdog);
425         ehci->watchdog.function = ehci_watchdog;
426         ehci->watchdog.data = (unsigned long) ehci;
427
428         /*
429          * hw default: 1K periodic list heads, one per frame.
430          * periodic_size can shrink by USBCMD update if hcc_params allows.
431          */
432         ehci->periodic_size = DEFAULT_I_TDPS;
433         if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
434                 return retval;
435
436         /* controllers may cache some of the periodic schedule ... */
437         hcc_params = readl(&ehci->caps->hcc_params);
438         if (HCC_ISOC_CACHE(hcc_params))         // full frame cache
439                 ehci->i_thresh = 8;
440         else                                    // N microframes cached
441                 ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
442
443         ehci->reclaim = NULL;
444         ehci->reclaim_ready = 0;
445         ehci->next_uframe = -1;
446
447         /*
448          * dedicate a qh for the async ring head, since we couldn't unlink
449          * a 'real' qh without stopping the async schedule [4.8].  use it
450          * as the 'reclamation list head' too.
451          * its dummy is used in hw_alt_next of many tds, to prevent the qh
452          * from automatically advancing to the next td after short reads.
453          */
454         ehci->async->qh_next.qh = NULL;
455         ehci->async->hw_next = QH_NEXT(ehci->async->qh_dma);
456         ehci->async->hw_info1 = cpu_to_le32(QH_HEAD);
457         ehci->async->hw_token = cpu_to_le32(QTD_STS_HALT);
458         ehci->async->hw_qtd_next = EHCI_LIST_END;
459         ehci->async->qh_state = QH_STATE_LINKED;
460         ehci->async->hw_alt_next = QTD_NEXT(ehci->async->dummy->qtd_dma);
461
462         /* clear interrupt enables, set irq latency */
463         if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
464                 log2_irq_thresh = 0;
465         temp = 1 << (16 + log2_irq_thresh);
466         if (HCC_CANPARK(hcc_params)) {
467                 /* HW default park == 3, on hardware that supports it (like
468                  * NVidia and ALI silicon), maximizes throughput on the async
469                  * schedule by avoiding QH fetches between transfers.
470                  *
471                  * With fast usb storage devices and NForce2, "park" seems to
472                  * make problems:  throughput reduction (!), data errors...
473                  */
474                 if (park) {
475                         park = min(park, (unsigned) 3);
476                         temp |= CMD_PARK;
477                         temp |= park << 8;
478                 }
479                 ehci_dbg(ehci, "park %d\n", park);
480         }
481         if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
482                 /* periodic schedule size can be smaller than default */
483                 temp &= ~(3 << 2);
484                 temp |= (EHCI_TUNE_FLS << 2);
485                 switch (EHCI_TUNE_FLS) {
486                 case 0: ehci->periodic_size = 1024; break;
487                 case 1: ehci->periodic_size = 512; break;
488                 case 2: ehci->periodic_size = 256; break;
489                 default:        BUG();
490                 }
491         }
492         ehci->command = temp;
493
494         ehci->reboot_notifier.notifier_call = ehci_reboot;
495         register_reboot_notifier(&ehci->reboot_notifier);
496
497         return 0;
498 }
499
500 /* start HC running; it's halted, ehci_init() has been run (once) */
501 static int ehci_run (struct usb_hcd *hcd)
502 {
503         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
504         int                     retval;
505         u32                     temp;
506         u32                     hcc_params;
507
508         /* EHCI spec section 4.1 */
509         if ((retval = ehci_reset(ehci)) != 0) {
510                 unregister_reboot_notifier(&ehci->reboot_notifier);
511                 ehci_mem_cleanup(ehci);
512                 return retval;
513         }
514         writel(ehci->periodic_dma, &ehci->regs->frame_list);
515         writel((u32)ehci->async->qh_dma, &ehci->regs->async_next);
516
517         /*
518          * hcc_params controls whether ehci->regs->segment must (!!!)
519          * be used; it constrains QH/ITD/SITD and QTD locations.
520          * pci_pool consistent memory always uses segment zero.
521          * streaming mappings for I/O buffers, like pci_map_single(),
522          * can return segments above 4GB, if the device allows.
523          *
524          * NOTE:  the dma mask is visible through dma_supported(), so
525          * drivers can pass this info along ... like NETIF_F_HIGHDMA,
526          * Scsi_Host.highmem_io, and so forth.  It's readonly to all
527          * host side drivers though.
528          */
529         hcc_params = readl(&ehci->caps->hcc_params);
530         if (HCC_64BIT_ADDR(hcc_params)) {
531                 writel(0, &ehci->regs->segment);
532 #if 0
533 // this is deeply broken on almost all architectures
534                 if (!dma_set_mask(hcd->self.controller, DMA_64BIT_MASK))
535                         ehci_info(ehci, "enabled 64bit DMA\n");
536 #endif
537         }
538
539
540         // Philips, Intel, and maybe others need CMD_RUN before the
541         // root hub will detect new devices (why?); NEC doesn't
542         ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
543         ehci->command |= CMD_RUN;
544         writel (ehci->command, &ehci->regs->command);
545         dbg_cmd (ehci, "init", ehci->command);
546
547         /*
548          * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
549          * are explicitly handed to companion controller(s), so no TT is
550          * involved with the root hub.  (Except where one is integrated,
551          * and there's no companion controller unless maybe for USB OTG.)
552          */
553         hcd->state = HC_STATE_RUNNING;
554         writel (FLAG_CF, &ehci->regs->configured_flag);
555         readl (&ehci->regs->command);   /* unblock posted writes */
556
557         temp = HC_VERSION(readl (&ehci->caps->hc_capbase));
558         ehci_info (ehci,
559                 "USB %x.%x started, EHCI %x.%02x, driver %s\n",
560                 ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
561                 temp >> 8, temp & 0xff, DRIVER_VERSION);
562
563         writel (INTR_MASK, &ehci->regs->intr_enable); /* Turn On Interrupts */
564
565         /* GRR this is run-once init(), being done every time the HC starts.
566          * So long as they're part of class devices, we can't do it init()
567          * since the class device isn't created that early.
568          */
569         create_debug_files(ehci);
570
571         return 0;
572 }
573
574 /*-------------------------------------------------------------------------*/
575
576 static irqreturn_t ehci_irq (struct usb_hcd *hcd, struct pt_regs *regs)
577 {
578         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
579         u32                     status;
580         int                     bh;
581
582         spin_lock (&ehci->lock);
583
584         status = readl (&ehci->regs->status);
585
586         /* e.g. cardbus physical eject */
587         if (status == ~(u32) 0) {
588                 ehci_dbg (ehci, "device removed\n");
589                 goto dead;
590         }
591
592         status &= INTR_MASK;
593         if (!status) {                  /* irq sharing? */
594                 spin_unlock(&ehci->lock);
595                 return IRQ_NONE;
596         }
597
598         /* clear (just) interrupts */
599         writel (status, &ehci->regs->status);
600         readl (&ehci->regs->command);   /* unblock posted write */
601         bh = 0;
602
603 #ifdef  EHCI_VERBOSE_DEBUG
604         /* unrequested/ignored: Frame List Rollover */
605         dbg_status (ehci, "irq", status);
606 #endif
607
608         /* INT, ERR, and IAA interrupt rates can be throttled */
609
610         /* normal [4.15.1.2] or error [4.15.1.1] completion */
611         if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
612                 if (likely ((status & STS_ERR) == 0))
613                         COUNT (ehci->stats.normal);
614                 else
615                         COUNT (ehci->stats.error);
616                 bh = 1;
617         }
618
619         /* complete the unlinking of some qh [4.15.2.3] */
620         if (status & STS_IAA) {
621                 COUNT (ehci->stats.reclaim);
622                 ehci->reclaim_ready = 1;
623                 bh = 1;
624         }
625
626         /* remote wakeup [4.3.1] */
627         if ((status & STS_PCD) && hcd->remote_wakeup) {
628                 unsigned        i = HCS_N_PORTS (ehci->hcs_params);
629
630                 /* resume root hub? */
631                 status = readl (&ehci->regs->command);
632                 if (!(status & CMD_RUN))
633                         writel (status | CMD_RUN, &ehci->regs->command);
634
635                 while (i--) {
636                         status = readl (&ehci->regs->port_status [i]);
637                         if (status & PORT_OWNER)
638                                 continue;
639                         if (!(status & PORT_RESUME)
640                                         || ehci->reset_done [i] != 0)
641                                 continue;
642
643                         /* start 20 msec resume signaling from this port,
644                          * and make khubd collect PORT_STAT_C_SUSPEND to
645                          * stop that signaling.
646                          */
647                         ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
648                         ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
649                         usb_hcd_resume_root_hub(hcd);
650                 }
651         }
652
653         /* PCI errors [4.15.2.4] */
654         if (unlikely ((status & STS_FATAL) != 0)) {
655                 /* bogus "fatal" IRQs appear on some chips... why?  */
656                 status = readl (&ehci->regs->status);
657                 dbg_cmd (ehci, "fatal", readl (&ehci->regs->command));
658                 dbg_status (ehci, "fatal", status);
659                 if (status & STS_HALT) {
660                         ehci_err (ehci, "fatal error\n");
661 dead:
662                         ehci_reset (ehci);
663                         writel (0, &ehci->regs->configured_flag);
664                         /* generic layer kills/unlinks all urbs, then
665                          * uses ehci_stop to clean up the rest
666                          */
667                         bh = 1;
668                 }
669         }
670
671         if (bh)
672                 ehci_work (ehci, regs);
673         spin_unlock (&ehci->lock);
674         return IRQ_HANDLED;
675 }
676
677 /*-------------------------------------------------------------------------*/
678
679 /*
680  * non-error returns are a promise to giveback() the urb later
681  * we drop ownership so next owner (or urb unlink) can get it
682  *
683  * urb + dev is in hcd.self.controller.urb_list
684  * we're queueing TDs onto software and hardware lists
685  *
686  * hcd-specific init for hcpriv hasn't been done yet
687  *
688  * NOTE:  control, bulk, and interrupt share the same code to append TDs
689  * to a (possibly active) QH, and the same QH scanning code.
690  */
691 static int ehci_urb_enqueue (
692         struct usb_hcd  *hcd,
693         struct usb_host_endpoint *ep,
694         struct urb      *urb,
695         gfp_t           mem_flags
696 ) {
697         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
698         struct list_head        qtd_list;
699
700         INIT_LIST_HEAD (&qtd_list);
701
702         switch (usb_pipetype (urb->pipe)) {
703         // case PIPE_CONTROL:
704         // case PIPE_BULK:
705         default:
706                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
707                         return -ENOMEM;
708                 return submit_async (ehci, ep, urb, &qtd_list, mem_flags);
709
710         case PIPE_INTERRUPT:
711                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
712                         return -ENOMEM;
713                 return intr_submit (ehci, ep, urb, &qtd_list, mem_flags);
714
715         case PIPE_ISOCHRONOUS:
716                 if (urb->dev->speed == USB_SPEED_HIGH)
717                         return itd_submit (ehci, urb, mem_flags);
718                 else
719                         return sitd_submit (ehci, urb, mem_flags);
720         }
721 }
722
723 static void unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
724 {
725         /* if we need to use IAA and it's busy, defer */
726         if (qh->qh_state == QH_STATE_LINKED
727                         && ehci->reclaim
728                         && HC_IS_RUNNING (ehci_to_hcd(ehci)->state)) {
729                 struct ehci_qh          *last;
730
731                 for (last = ehci->reclaim;
732                                 last->reclaim;
733                                 last = last->reclaim)
734                         continue;
735                 qh->qh_state = QH_STATE_UNLINK_WAIT;
736                 last->reclaim = qh;
737
738         /* bypass IAA if the hc can't care */
739         } else if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state) && ehci->reclaim)
740                 end_unlink_async (ehci, NULL);
741
742         /* something else might have unlinked the qh by now */
743         if (qh->qh_state == QH_STATE_LINKED)
744                 start_unlink_async (ehci, qh);
745 }
746
747 /* remove from hardware lists
748  * completions normally happen asynchronously
749  */
750
751 static int ehci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
752 {
753         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
754         struct ehci_qh          *qh;
755         unsigned long           flags;
756
757         spin_lock_irqsave (&ehci->lock, flags);
758         switch (usb_pipetype (urb->pipe)) {
759         // case PIPE_CONTROL:
760         // case PIPE_BULK:
761         default:
762                 qh = (struct ehci_qh *) urb->hcpriv;
763                 if (!qh)
764                         break;
765                 unlink_async (ehci, qh);
766                 break;
767
768         case PIPE_INTERRUPT:
769                 qh = (struct ehci_qh *) urb->hcpriv;
770                 if (!qh)
771                         break;
772                 switch (qh->qh_state) {
773                 case QH_STATE_LINKED:
774                         intr_deschedule (ehci, qh);
775                         /* FALL THROUGH */
776                 case QH_STATE_IDLE:
777                         qh_completions (ehci, qh, NULL);
778                         break;
779                 default:
780                         ehci_dbg (ehci, "bogus qh %p state %d\n",
781                                         qh, qh->qh_state);
782                         goto done;
783                 }
784
785                 /* reschedule QH iff another request is queued */
786                 if (!list_empty (&qh->qtd_list)
787                                 && HC_IS_RUNNING (hcd->state)) {
788                         int status;
789
790                         status = qh_schedule (ehci, qh);
791                         spin_unlock_irqrestore (&ehci->lock, flags);
792
793                         if (status != 0) {
794                                 // shouldn't happen often, but ...
795                                 // FIXME kill those tds' urbs
796                                 err ("can't reschedule qh %p, err %d",
797                                         qh, status);
798                         }
799                         return status;
800                 }
801                 break;
802
803         case PIPE_ISOCHRONOUS:
804                 // itd or sitd ...
805
806                 // wait till next completion, do it then.
807                 // completion irqs can wait up to 1024 msec,
808                 break;
809         }
810 done:
811         spin_unlock_irqrestore (&ehci->lock, flags);
812         return 0;
813 }
814
815 /*-------------------------------------------------------------------------*/
816
817 // bulk qh holds the data toggle
818
819 static void
820 ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
821 {
822         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
823         unsigned long           flags;
824         struct ehci_qh          *qh, *tmp;
825
826         /* ASSERT:  any requests/urbs are being unlinked */
827         /* ASSERT:  nobody can be submitting urbs for this any more */
828
829 rescan:
830         spin_lock_irqsave (&ehci->lock, flags);
831         qh = ep->hcpriv;
832         if (!qh)
833                 goto done;
834
835         /* endpoints can be iso streams.  for now, we don't
836          * accelerate iso completions ... so spin a while.
837          */
838         if (qh->hw_info1 == 0) {
839                 ehci_vdbg (ehci, "iso delay\n");
840                 goto idle_timeout;
841         }
842
843         if (!HC_IS_RUNNING (hcd->state))
844                 qh->qh_state = QH_STATE_IDLE;
845         switch (qh->qh_state) {
846         case QH_STATE_LINKED:
847                 for (tmp = ehci->async->qh_next.qh;
848                                 tmp && tmp != qh;
849                                 tmp = tmp->qh_next.qh)
850                         continue;
851                 /* periodic qh self-unlinks on empty */
852                 if (!tmp)
853                         goto nogood;
854                 unlink_async (ehci, qh);
855                 /* FALL THROUGH */
856         case QH_STATE_UNLINK:           /* wait for hw to finish? */
857 idle_timeout:
858                 spin_unlock_irqrestore (&ehci->lock, flags);
859                 schedule_timeout_uninterruptible(1);
860                 goto rescan;
861         case QH_STATE_IDLE:             /* fully unlinked */
862                 if (list_empty (&qh->qtd_list)) {
863                         qh_put (qh);
864                         break;
865                 }
866                 /* else FALL THROUGH */
867         default:
868 nogood:
869                 /* caller was supposed to have unlinked any requests;
870                  * that's not our job.  just leak this memory.
871                  */
872                 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
873                         qh, ep->desc.bEndpointAddress, qh->qh_state,
874                         list_empty (&qh->qtd_list) ? "" : "(has tds)");
875                 break;
876         }
877         ep->hcpriv = NULL;
878 done:
879         spin_unlock_irqrestore (&ehci->lock, flags);
880         return;
881 }
882
883 static int ehci_get_frame (struct usb_hcd *hcd)
884 {
885         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
886         return (readl (&ehci->regs->frame_index) >> 3) % ehci->periodic_size;
887 }
888
889 /*-------------------------------------------------------------------------*/
890
891 #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC
892
893 MODULE_DESCRIPTION (DRIVER_INFO);
894 MODULE_AUTHOR (DRIVER_AUTHOR);
895 MODULE_LICENSE ("GPL");
896
897 #ifdef CONFIG_PCI
898 #include "ehci-pci.c"
899 #endif
900
901 #if !defined(CONFIG_PCI)
902 #error "missing bus glue for ehci-hcd"
903 #endif