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