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