Pull netlink 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 #ifdef CONFIG_CPU_FREQ
279
280 #include <linux/cpufreq.h>
281
282 static void ehci_cpufreq_pause (struct ehci_hcd *ehci)
283 {
284         unsigned long   flags;
285
286         spin_lock_irqsave(&ehci->lock, flags);
287         if (!ehci->cpufreq_changing++)
288                 qh_inactivate_split_intr_qhs(ehci);
289         spin_unlock_irqrestore(&ehci->lock, flags);
290 }
291
292 static void ehci_cpufreq_unpause (struct ehci_hcd *ehci)
293 {
294         unsigned long   flags;
295
296         spin_lock_irqsave(&ehci->lock, flags);
297         if (!--ehci->cpufreq_changing)
298                 qh_reactivate_split_intr_qhs(ehci);
299         spin_unlock_irqrestore(&ehci->lock, flags);
300 }
301
302 /*
303  * ehci_cpufreq_notifier is needed to avoid MMF errors that occur when
304  * EHCI controllers that don't cache many uframes get delayed trying to
305  * read main memory during CPU frequency transitions.  This can cause
306  * split interrupt transactions to not be completed in the required uframe.
307  * This has been observed on the Broadcom/ServerWorks HT1000 controller.
308  */
309 static int ehci_cpufreq_notifier(struct notifier_block *nb, unsigned long val,
310                                  void *data)
311 {
312         struct ehci_hcd *ehci = container_of(nb, struct ehci_hcd,
313                                              cpufreq_transition);
314
315         switch (val) {
316         case CPUFREQ_PRECHANGE:
317                 ehci_cpufreq_pause(ehci);
318                 break;
319         case CPUFREQ_POSTCHANGE:
320                 ehci_cpufreq_unpause(ehci);
321                 break;
322         }
323         return 0;
324 }
325
326 #endif
327
328 /*-------------------------------------------------------------------------*/
329
330 static void ehci_watchdog (unsigned long param)
331 {
332         struct ehci_hcd         *ehci = (struct ehci_hcd *) param;
333         unsigned long           flags;
334
335         spin_lock_irqsave (&ehci->lock, flags);
336
337         /* lost IAA irqs wedge things badly; seen with a vt8235 */
338         if (ehci->reclaim) {
339                 u32             status = ehci_readl(ehci, &ehci->regs->status);
340                 if (status & STS_IAA) {
341                         ehci_vdbg (ehci, "lost IAA\n");
342                         COUNT (ehci->stats.lost_iaa);
343                         ehci_writel(ehci, STS_IAA, &ehci->regs->status);
344                         ehci->reclaim_ready = 1;
345                 }
346         }
347
348         /* stop async processing after it's idled a bit */
349         if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
350                 start_unlink_async (ehci, ehci->async);
351
352         /* ehci could run by timer, without IRQs ... */
353         ehci_work (ehci);
354
355         spin_unlock_irqrestore (&ehci->lock, flags);
356 }
357
358 /* On some systems, leaving remote wakeup enabled prevents system shutdown.
359  * The firmware seems to think that powering off is a wakeup event!
360  * This routine turns off remote wakeup and everything else, on all ports.
361  */
362 static void ehci_turn_off_all_ports(struct ehci_hcd *ehci)
363 {
364         int     port = HCS_N_PORTS(ehci->hcs_params);
365
366         while (port--)
367                 ehci_writel(ehci, PORT_RWC_BITS,
368                                 &ehci->regs->port_status[port]);
369 }
370
371 /* ehci_shutdown kick in for silicon on any bus (not just pci, etc).
372  * This forcibly disables dma and IRQs, helping kexec and other cases
373  * where the next system software may expect clean state.
374  */
375 static void
376 ehci_shutdown (struct usb_hcd *hcd)
377 {
378         struct ehci_hcd *ehci;
379
380         ehci = hcd_to_ehci (hcd);
381         (void) ehci_halt (ehci);
382         ehci_turn_off_all_ports(ehci);
383
384         /* make BIOS/etc use companion controller during reboot */
385         ehci_writel(ehci, 0, &ehci->regs->configured_flag);
386
387         /* unblock posted writes */
388         ehci_readl(ehci, &ehci->regs->configured_flag);
389 }
390
391 static void ehci_port_power (struct ehci_hcd *ehci, int is_on)
392 {
393         unsigned port;
394
395         if (!HCS_PPC (ehci->hcs_params))
396                 return;
397
398         ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down");
399         for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; )
400                 (void) ehci_hub_control(ehci_to_hcd(ehci),
401                                 is_on ? SetPortFeature : ClearPortFeature,
402                                 USB_PORT_FEAT_POWER,
403                                 port--, NULL, 0);
404         /* Flush those writes */
405         ehci_readl(ehci, &ehci->regs->command);
406         msleep(20);
407 }
408
409 /*-------------------------------------------------------------------------*/
410
411 /*
412  * ehci_work is called from some interrupts, timers, and so on.
413  * it calls driver completion functions, after dropping ehci->lock.
414  */
415 static void ehci_work (struct ehci_hcd *ehci)
416 {
417         timer_action_done (ehci, TIMER_IO_WATCHDOG);
418         if (ehci->reclaim_ready)
419                 end_unlink_async (ehci);
420
421         /* another CPU may drop ehci->lock during a schedule scan while
422          * it reports urb completions.  this flag guards against bogus
423          * attempts at re-entrant schedule scanning.
424          */
425         if (ehci->scanning)
426                 return;
427         ehci->scanning = 1;
428         scan_async (ehci);
429         if (ehci->next_uframe != -1)
430                 scan_periodic (ehci);
431         ehci->scanning = 0;
432
433         /* the IO watchdog guards against hardware or driver bugs that
434          * misplace IRQs, and should let us run completely without IRQs.
435          * such lossage has been observed on both VT6202 and VT8235.
436          */
437         if (HC_IS_RUNNING (ehci_to_hcd(ehci)->state) &&
438                         (ehci->async->qh_next.ptr != NULL ||
439                          ehci->periodic_sched != 0))
440                 timer_action (ehci, TIMER_IO_WATCHDOG);
441 }
442
443 static void ehci_stop (struct usb_hcd *hcd)
444 {
445         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
446
447         ehci_dbg (ehci, "stop\n");
448
449         /* Turn off port power on all root hub ports. */
450         ehci_port_power (ehci, 0);
451
452         /* no more interrupts ... */
453         del_timer_sync (&ehci->watchdog);
454
455         spin_lock_irq(&ehci->lock);
456         if (HC_IS_RUNNING (hcd->state))
457                 ehci_quiesce (ehci);
458
459         ehci_reset (ehci);
460         ehci_writel(ehci, 0, &ehci->regs->intr_enable);
461         spin_unlock_irq(&ehci->lock);
462
463 #ifdef CONFIG_CPU_FREQ
464         cpufreq_unregister_notifier(&ehci->cpufreq_transition,
465                                     CPUFREQ_TRANSITION_NOTIFIER);
466 #endif
467         /* let companion controllers work when we aren't */
468         ehci_writel(ehci, 0, &ehci->regs->configured_flag);
469
470         remove_companion_file(ehci);
471         remove_debug_files (ehci);
472
473         /* root hub is shut down separately (first, when possible) */
474         spin_lock_irq (&ehci->lock);
475         if (ehci->async)
476                 ehci_work (ehci);
477         spin_unlock_irq (&ehci->lock);
478         ehci_mem_cleanup (ehci);
479
480 #ifdef  EHCI_STATS
481         ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
482                 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
483                 ehci->stats.lost_iaa);
484         ehci_dbg (ehci, "complete %ld unlink %ld\n",
485                 ehci->stats.complete, ehci->stats.unlink);
486 #endif
487
488         dbg_status (ehci, "ehci_stop completed",
489                     ehci_readl(ehci, &ehci->regs->status));
490 }
491
492 /* one-time init, only for memory state */
493 static int ehci_init(struct usb_hcd *hcd)
494 {
495         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
496         u32                     temp;
497         int                     retval;
498         u32                     hcc_params;
499
500         spin_lock_init(&ehci->lock);
501
502         init_timer(&ehci->watchdog);
503         ehci->watchdog.function = ehci_watchdog;
504         ehci->watchdog.data = (unsigned long) ehci;
505
506         /*
507          * hw default: 1K periodic list heads, one per frame.
508          * periodic_size can shrink by USBCMD update if hcc_params allows.
509          */
510         ehci->periodic_size = DEFAULT_I_TDPS;
511         if ((retval = ehci_mem_init(ehci, GFP_KERNEL)) < 0)
512                 return retval;
513
514         /* controllers may cache some of the periodic schedule ... */
515         hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
516         if (HCC_ISOC_CACHE(hcc_params))         // full frame cache
517                 ehci->i_thresh = 8;
518         else                                    // N microframes cached
519                 ehci->i_thresh = 2 + HCC_ISOC_THRES(hcc_params);
520
521         ehci->reclaim = NULL;
522         ehci->reclaim_ready = 0;
523         ehci->next_uframe = -1;
524
525         /*
526          * dedicate a qh for the async ring head, since we couldn't unlink
527          * a 'real' qh without stopping the async schedule [4.8].  use it
528          * as the 'reclamation list head' too.
529          * its dummy is used in hw_alt_next of many tds, to prevent the qh
530          * from automatically advancing to the next td after short reads.
531          */
532         ehci->async->qh_next.qh = NULL;
533         ehci->async->hw_next = QH_NEXT(ehci, ehci->async->qh_dma);
534         ehci->async->hw_info1 = cpu_to_hc32(ehci, QH_HEAD);
535         ehci->async->hw_token = cpu_to_hc32(ehci, QTD_STS_HALT);
536         ehci->async->hw_qtd_next = EHCI_LIST_END(ehci);
537         ehci->async->qh_state = QH_STATE_LINKED;
538         ehci->async->hw_alt_next = QTD_NEXT(ehci, ehci->async->dummy->qtd_dma);
539
540         /* clear interrupt enables, set irq latency */
541         if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
542                 log2_irq_thresh = 0;
543         temp = 1 << (16 + log2_irq_thresh);
544         if (HCC_CANPARK(hcc_params)) {
545                 /* HW default park == 3, on hardware that supports it (like
546                  * NVidia and ALI silicon), maximizes throughput on the async
547                  * schedule by avoiding QH fetches between transfers.
548                  *
549                  * With fast usb storage devices and NForce2, "park" seems to
550                  * make problems:  throughput reduction (!), data errors...
551                  */
552                 if (park) {
553                         park = min(park, (unsigned) 3);
554                         temp |= CMD_PARK;
555                         temp |= park << 8;
556                 }
557                 ehci_dbg(ehci, "park %d\n", park);
558         }
559         if (HCC_PGM_FRAMELISTLEN(hcc_params)) {
560                 /* periodic schedule size can be smaller than default */
561                 temp &= ~(3 << 2);
562                 temp |= (EHCI_TUNE_FLS << 2);
563                 switch (EHCI_TUNE_FLS) {
564                 case 0: ehci->periodic_size = 1024; break;
565                 case 1: ehci->periodic_size = 512; break;
566                 case 2: ehci->periodic_size = 256; break;
567                 default:        BUG();
568                 }
569         }
570         ehci->command = temp;
571
572 #ifdef CONFIG_CPU_FREQ
573         INIT_LIST_HEAD(&ehci->split_intr_qhs);
574         /*
575          * If the EHCI controller caches enough uframes, this probably
576          * isn't needed unless there are so many low/full speed devices
577          * that the controller's can't cache it all.
578          */
579         ehci->cpufreq_transition.notifier_call = ehci_cpufreq_notifier;
580         cpufreq_register_notifier(&ehci->cpufreq_transition,
581                                   CPUFREQ_TRANSITION_NOTIFIER);
582 #endif
583         return 0;
584 }
585
586 /* start HC running; it's halted, ehci_init() has been run (once) */
587 static int ehci_run (struct usb_hcd *hcd)
588 {
589         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
590         int                     retval;
591         u32                     temp;
592         u32                     hcc_params;
593
594         hcd->uses_new_polling = 1;
595         hcd->poll_rh = 0;
596
597         /* EHCI spec section 4.1 */
598         if ((retval = ehci_reset(ehci)) != 0) {
599                 ehci_mem_cleanup(ehci);
600                 return retval;
601         }
602         ehci_writel(ehci, ehci->periodic_dma, &ehci->regs->frame_list);
603         ehci_writel(ehci, (u32)ehci->async->qh_dma, &ehci->regs->async_next);
604
605         /*
606          * hcc_params controls whether ehci->regs->segment must (!!!)
607          * be used; it constrains QH/ITD/SITD and QTD locations.
608          * pci_pool consistent memory always uses segment zero.
609          * streaming mappings for I/O buffers, like pci_map_single(),
610          * can return segments above 4GB, if the device allows.
611          *
612          * NOTE:  the dma mask is visible through dma_supported(), so
613          * drivers can pass this info along ... like NETIF_F_HIGHDMA,
614          * Scsi_Host.highmem_io, and so forth.  It's readonly to all
615          * host side drivers though.
616          */
617         hcc_params = ehci_readl(ehci, &ehci->caps->hcc_params);
618         if (HCC_64BIT_ADDR(hcc_params)) {
619                 ehci_writel(ehci, 0, &ehci->regs->segment);
620 #if 0
621 // this is deeply broken on almost all architectures
622                 if (!dma_set_mask(hcd->self.controller, DMA_64BIT_MASK))
623                         ehci_info(ehci, "enabled 64bit DMA\n");
624 #endif
625         }
626
627
628         // Philips, Intel, and maybe others need CMD_RUN before the
629         // root hub will detect new devices (why?); NEC doesn't
630         ehci->command &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
631         ehci->command |= CMD_RUN;
632         ehci_writel(ehci, ehci->command, &ehci->regs->command);
633         dbg_cmd (ehci, "init", ehci->command);
634
635         /*
636          * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
637          * are explicitly handed to companion controller(s), so no TT is
638          * involved with the root hub.  (Except where one is integrated,
639          * and there's no companion controller unless maybe for USB OTG.)
640          */
641         hcd->state = HC_STATE_RUNNING;
642         ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
643         ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
644
645         temp = HC_VERSION(ehci_readl(ehci, &ehci->caps->hc_capbase));
646         ehci_info (ehci,
647                 "USB %x.%x started, EHCI %x.%02x, driver %s%s\n",
648                 ((ehci->sbrn & 0xf0)>>4), (ehci->sbrn & 0x0f),
649                 temp >> 8, temp & 0xff, DRIVER_VERSION,
650                 ignore_oc ? ", overcurrent ignored" : "");
651
652         ehci_writel(ehci, INTR_MASK,
653                     &ehci->regs->intr_enable); /* Turn On Interrupts */
654
655         /* GRR this is run-once init(), being done every time the HC starts.
656          * So long as they're part of class devices, we can't do it init()
657          * since the class device isn't created that early.
658          */
659         create_debug_files(ehci);
660         create_companion_file(ehci);
661
662         return 0;
663 }
664
665 /*-------------------------------------------------------------------------*/
666
667 static irqreturn_t ehci_irq (struct usb_hcd *hcd)
668 {
669         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
670         u32                     status, pcd_status = 0;
671         int                     bh;
672
673         spin_lock (&ehci->lock);
674
675         status = ehci_readl(ehci, &ehci->regs->status);
676
677         /* e.g. cardbus physical eject */
678         if (status == ~(u32) 0) {
679                 ehci_dbg (ehci, "device removed\n");
680                 goto dead;
681         }
682
683         status &= INTR_MASK;
684         if (!status) {                  /* irq sharing? */
685                 spin_unlock(&ehci->lock);
686                 return IRQ_NONE;
687         }
688
689         /* clear (just) interrupts */
690         ehci_writel(ehci, status, &ehci->regs->status);
691         ehci_readl(ehci, &ehci->regs->command); /* unblock posted write */
692         bh = 0;
693
694 #ifdef  EHCI_VERBOSE_DEBUG
695         /* unrequested/ignored: Frame List Rollover */
696         dbg_status (ehci, "irq", status);
697 #endif
698
699         /* INT, ERR, and IAA interrupt rates can be throttled */
700
701         /* normal [4.15.1.2] or error [4.15.1.1] completion */
702         if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
703                 if (likely ((status & STS_ERR) == 0))
704                         COUNT (ehci->stats.normal);
705                 else
706                         COUNT (ehci->stats.error);
707                 bh = 1;
708         }
709
710         /* complete the unlinking of some qh [4.15.2.3] */
711         if (status & STS_IAA) {
712                 COUNT (ehci->stats.reclaim);
713                 ehci->reclaim_ready = 1;
714                 bh = 1;
715         }
716
717         /* remote wakeup [4.3.1] */
718         if (status & STS_PCD) {
719                 unsigned        i = HCS_N_PORTS (ehci->hcs_params);
720                 pcd_status = status;
721
722                 /* resume root hub? */
723                 if (!(ehci_readl(ehci, &ehci->regs->command) & CMD_RUN))
724                         usb_hcd_resume_root_hub(hcd);
725
726                 while (i--) {
727                         int pstatus = ehci_readl(ehci,
728                                                  &ehci->regs->port_status [i]);
729
730                         if (pstatus & PORT_OWNER)
731                                 continue;
732                         if (!(pstatus & PORT_RESUME)
733                                         || ehci->reset_done [i] != 0)
734                                 continue;
735
736                         /* start 20 msec resume signaling from this port,
737                          * and make khubd collect PORT_STAT_C_SUSPEND to
738                          * stop that signaling.
739                          */
740                         ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
741                         ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
742                         mod_timer(&hcd->rh_timer, ehci->reset_done[i]);
743                 }
744         }
745
746         /* PCI errors [4.15.2.4] */
747         if (unlikely ((status & STS_FATAL) != 0)) {
748                 /* bogus "fatal" IRQs appear on some chips... why?  */
749                 status = ehci_readl(ehci, &ehci->regs->status);
750                 dbg_cmd (ehci, "fatal", ehci_readl(ehci,
751                                                    &ehci->regs->command));
752                 dbg_status (ehci, "fatal", status);
753                 if (status & STS_HALT) {
754                         ehci_err (ehci, "fatal error\n");
755 dead:
756                         ehci_reset (ehci);
757                         ehci_writel(ehci, 0, &ehci->regs->configured_flag);
758                         /* generic layer kills/unlinks all urbs, then
759                          * uses ehci_stop to clean up the rest
760                          */
761                         bh = 1;
762                 }
763         }
764
765         if (bh)
766                 ehci_work (ehci);
767         spin_unlock (&ehci->lock);
768         if (pcd_status & STS_PCD)
769                 usb_hcd_poll_rh_status(hcd);
770         return IRQ_HANDLED;
771 }
772
773 /*-------------------------------------------------------------------------*/
774
775 /*
776  * non-error returns are a promise to giveback() the urb later
777  * we drop ownership so next owner (or urb unlink) can get it
778  *
779  * urb + dev is in hcd.self.controller.urb_list
780  * we're queueing TDs onto software and hardware lists
781  *
782  * hcd-specific init for hcpriv hasn't been done yet
783  *
784  * NOTE:  control, bulk, and interrupt share the same code to append TDs
785  * to a (possibly active) QH, and the same QH scanning code.
786  */
787 static int ehci_urb_enqueue (
788         struct usb_hcd  *hcd,
789         struct usb_host_endpoint *ep,
790         struct urb      *urb,
791         gfp_t           mem_flags
792 ) {
793         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
794         struct list_head        qtd_list;
795
796         INIT_LIST_HEAD (&qtd_list);
797
798         switch (usb_pipetype (urb->pipe)) {
799         // case PIPE_CONTROL:
800         // case PIPE_BULK:
801         default:
802                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
803                         return -ENOMEM;
804                 return submit_async (ehci, ep, urb, &qtd_list, mem_flags);
805
806         case PIPE_INTERRUPT:
807                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
808                         return -ENOMEM;
809                 return intr_submit (ehci, ep, urb, &qtd_list, mem_flags);
810
811         case PIPE_ISOCHRONOUS:
812                 if (urb->dev->speed == USB_SPEED_HIGH)
813                         return itd_submit (ehci, urb, mem_flags);
814                 else
815                         return sitd_submit (ehci, urb, mem_flags);
816         }
817 }
818
819 static void unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
820 {
821         /* if we need to use IAA and it's busy, defer */
822         if (qh->qh_state == QH_STATE_LINKED
823                         && ehci->reclaim
824                         && HC_IS_RUNNING (ehci_to_hcd(ehci)->state)) {
825                 struct ehci_qh          *last;
826
827                 for (last = ehci->reclaim;
828                                 last->reclaim;
829                                 last = last->reclaim)
830                         continue;
831                 qh->qh_state = QH_STATE_UNLINK_WAIT;
832                 last->reclaim = qh;
833
834         /* bypass IAA if the hc can't care */
835         } else if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state) && ehci->reclaim)
836                 end_unlink_async (ehci);
837
838         /* something else might have unlinked the qh by now */
839         if (qh->qh_state == QH_STATE_LINKED)
840                 start_unlink_async (ehci, qh);
841 }
842
843 /* remove from hardware lists
844  * completions normally happen asynchronously
845  */
846
847 static int ehci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
848 {
849         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
850         struct ehci_qh          *qh;
851         unsigned long           flags;
852
853         spin_lock_irqsave (&ehci->lock, flags);
854         switch (usb_pipetype (urb->pipe)) {
855         // case PIPE_CONTROL:
856         // case PIPE_BULK:
857         default:
858                 qh = (struct ehci_qh *) urb->hcpriv;
859                 if (!qh)
860                         break;
861                 unlink_async (ehci, qh);
862                 break;
863
864         case PIPE_INTERRUPT:
865                 qh = (struct ehci_qh *) urb->hcpriv;
866                 if (!qh)
867                         break;
868                 switch (qh->qh_state) {
869                 case QH_STATE_LINKED:
870                         intr_deschedule (ehci, qh);
871                         /* FALL THROUGH */
872                 case QH_STATE_IDLE:
873                         qh_completions (ehci, qh);
874                         break;
875                 default:
876                         ehci_dbg (ehci, "bogus qh %p state %d\n",
877                                         qh, qh->qh_state);
878                         goto done;
879                 }
880
881                 /* reschedule QH iff another request is queued */
882                 if (!list_empty (&qh->qtd_list)
883                                 && HC_IS_RUNNING (hcd->state)) {
884                         int status;
885
886                         status = qh_schedule (ehci, qh);
887                         spin_unlock_irqrestore (&ehci->lock, flags);
888
889                         if (status != 0) {
890                                 // shouldn't happen often, but ...
891                                 // FIXME kill those tds' urbs
892                                 err ("can't reschedule qh %p, err %d",
893                                         qh, status);
894                         }
895                         return status;
896                 }
897                 break;
898
899         case PIPE_ISOCHRONOUS:
900                 // itd or sitd ...
901
902                 // wait till next completion, do it then.
903                 // completion irqs can wait up to 1024 msec,
904                 break;
905         }
906 done:
907         spin_unlock_irqrestore (&ehci->lock, flags);
908         return 0;
909 }
910
911 /*-------------------------------------------------------------------------*/
912
913 // bulk qh holds the data toggle
914
915 static void
916 ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
917 {
918         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
919         unsigned long           flags;
920         struct ehci_qh          *qh, *tmp;
921
922         /* ASSERT:  any requests/urbs are being unlinked */
923         /* ASSERT:  nobody can be submitting urbs for this any more */
924
925 rescan:
926         spin_lock_irqsave (&ehci->lock, flags);
927         qh = ep->hcpriv;
928         if (!qh)
929                 goto done;
930
931         /* endpoints can be iso streams.  for now, we don't
932          * accelerate iso completions ... so spin a while.
933          */
934         if (qh->hw_info1 == 0) {
935                 ehci_vdbg (ehci, "iso delay\n");
936                 goto idle_timeout;
937         }
938
939         if (!HC_IS_RUNNING (hcd->state))
940                 qh->qh_state = QH_STATE_IDLE;
941         switch (qh->qh_state) {
942         case QH_STATE_LINKED:
943                 for (tmp = ehci->async->qh_next.qh;
944                                 tmp && tmp != qh;
945                                 tmp = tmp->qh_next.qh)
946                         continue;
947                 /* periodic qh self-unlinks on empty */
948                 if (!tmp)
949                         goto nogood;
950                 unlink_async (ehci, qh);
951                 /* FALL THROUGH */
952         case QH_STATE_UNLINK:           /* wait for hw to finish? */
953 idle_timeout:
954                 spin_unlock_irqrestore (&ehci->lock, flags);
955                 schedule_timeout_uninterruptible(1);
956                 goto rescan;
957         case QH_STATE_IDLE:             /* fully unlinked */
958                 if (list_empty (&qh->qtd_list)) {
959                         qh_put (qh);
960                         break;
961                 }
962                 /* else FALL THROUGH */
963         default:
964 nogood:
965                 /* caller was supposed to have unlinked any requests;
966                  * that's not our job.  just leak this memory.
967                  */
968                 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
969                         qh, ep->desc.bEndpointAddress, qh->qh_state,
970                         list_empty (&qh->qtd_list) ? "" : "(has tds)");
971                 break;
972         }
973         ep->hcpriv = NULL;
974 done:
975         spin_unlock_irqrestore (&ehci->lock, flags);
976         return;
977 }
978
979 static int ehci_get_frame (struct usb_hcd *hcd)
980 {
981         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
982         return (ehci_readl(ehci, &ehci->regs->frame_index) >> 3) %
983                 ehci->periodic_size;
984 }
985
986 /*-------------------------------------------------------------------------*/
987
988 #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC
989
990 MODULE_DESCRIPTION (DRIVER_INFO);
991 MODULE_AUTHOR (DRIVER_AUTHOR);
992 MODULE_LICENSE ("GPL");
993
994 #ifdef CONFIG_PCI
995 #include "ehci-pci.c"
996 #define PCI_DRIVER              ehci_pci_driver
997 #endif
998
999 #ifdef CONFIG_USB_EHCI_FSL
1000 #include "ehci-fsl.c"
1001 #define PLATFORM_DRIVER         ehci_fsl_driver
1002 #endif
1003
1004 #ifdef CONFIG_SOC_AU1200
1005 #include "ehci-au1xxx.c"
1006 #define PLATFORM_DRIVER         ehci_hcd_au1xxx_driver
1007 #endif
1008
1009 #ifdef CONFIG_PPC_PS3
1010 #include "ehci-ps3.c"
1011 #define PS3_SYSTEM_BUS_DRIVER   ps3_ehci_driver
1012 #endif
1013
1014 #ifdef CONFIG_440EPX
1015 #include "ehci-ppc-soc.c"
1016 #define PLATFORM_DRIVER         ehci_ppc_soc_driver
1017 #endif
1018
1019 #if !defined(PCI_DRIVER) && !defined(PLATFORM_DRIVER) && \
1020     !defined(PS3_SYSTEM_BUS_DRIVER)
1021 #error "missing bus glue for ehci-hcd"
1022 #endif
1023
1024 static int __init ehci_hcd_init(void)
1025 {
1026         int retval = 0;
1027
1028         pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1029                  hcd_name,
1030                  sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
1031                  sizeof(struct ehci_itd), sizeof(struct ehci_sitd));
1032
1033 #ifdef PLATFORM_DRIVER
1034         retval = platform_driver_register(&PLATFORM_DRIVER);
1035         if (retval < 0)
1036                 return retval;
1037 #endif
1038
1039 #ifdef PCI_DRIVER
1040         retval = pci_register_driver(&PCI_DRIVER);
1041         if (retval < 0) {
1042 #ifdef PLATFORM_DRIVER
1043                 platform_driver_unregister(&PLATFORM_DRIVER);
1044 #endif
1045                 return retval;
1046         }
1047 #endif
1048
1049 #ifdef PS3_SYSTEM_BUS_DRIVER
1050         retval = ps3_ehci_driver_register(&PS3_SYSTEM_BUS_DRIVER);
1051         if (retval < 0) {
1052 #ifdef PLATFORM_DRIVER
1053                 platform_driver_unregister(&PLATFORM_DRIVER);
1054 #endif
1055 #ifdef PCI_DRIVER
1056                 pci_unregister_driver(&PCI_DRIVER);
1057 #endif
1058                 return retval;
1059         }
1060 #endif
1061
1062         return retval;
1063 }
1064 module_init(ehci_hcd_init);
1065
1066 static void __exit ehci_hcd_cleanup(void)
1067 {
1068 #ifdef PLATFORM_DRIVER
1069         platform_driver_unregister(&PLATFORM_DRIVER);
1070 #endif
1071 #ifdef PCI_DRIVER
1072         pci_unregister_driver(&PCI_DRIVER);
1073 #endif
1074 #ifdef PS3_SYSTEM_BUS_DRIVER
1075         ps3_ehci_driver_unregister(&PS3_SYSTEM_BUS_DRIVER);
1076 #endif
1077 }
1078 module_exit(ehci_hcd_cleanup);
1079