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