Automatic merge of rsync://rsync.kernel.org/pub/scm/linux/kernel/git/gregkh/usb-2...
[linux-2.6] / drivers / usb / host / ehci-hcd.c
1 /*
2  * Copyright (c) 2000-2004 by David Brownell
3  * 
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License as published by the
6  * Free Software Foundation; either version 2 of the License, or (at your
7  * option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <linux/config.h>
20
21 #ifdef CONFIG_USB_DEBUG
22         #define DEBUG
23 #else
24         #undef DEBUG
25 #endif
26
27 #include <linux/module.h>
28 #include <linux/pci.h>
29 #include <linux/dmapool.h>
30 #include <linux/kernel.h>
31 #include <linux/delay.h>
32 #include <linux/ioport.h>
33 #include <linux/sched.h>
34 #include <linux/slab.h>
35 #include <linux/smp_lock.h>
36 #include <linux/errno.h>
37 #include <linux/init.h>
38 #include <linux/timer.h>
39 #include <linux/list.h>
40 #include <linux/interrupt.h>
41 #include <linux/reboot.h>
42 #include <linux/usb.h>
43 #include <linux/moduleparam.h>
44 #include <linux/dma-mapping.h>
45
46 #include "../core/hcd.h"
47
48 #include <asm/byteorder.h>
49 #include <asm/io.h>
50 #include <asm/irq.h>
51 #include <asm/system.h>
52 #include <asm/unaligned.h>
53
54
55 /*-------------------------------------------------------------------------*/
56
57 /*
58  * EHCI hc_driver implementation ... experimental, incomplete.
59  * Based on the final 1.0 register interface specification.
60  *
61  * USB 2.0 shows up in upcoming www.pcmcia.org technology.
62  * First was PCMCIA, like ISA; then CardBus, which is PCI.
63  * Next comes "CardBay", using USB 2.0 signals.
64  *
65  * Contains additional contributions by Brad Hards, Rory Bolt, and others.
66  * Special thanks to Intel and VIA for providing host controllers to
67  * test this driver on, and Cypress (including In-System Design) for
68  * providing early devices for those host controllers to talk to!
69  *
70  * HISTORY:
71  *
72  * 2004-05-10 Root hub and PCI suspend/resume support; remote wakeup. (db)
73  * 2004-02-24 Replace pci_* with generic dma_* API calls (dsaxena@plexity.net)
74  * 2003-12-29 Rewritten high speed iso transfer support (by Michal Sojka,
75  *      <sojkam@centrum.cz>, updates by DB).
76  *
77  * 2002-11-29   Correct handling for hw async_next register.
78  * 2002-08-06   Handling for bulk and interrupt transfers is mostly shared;
79  *      only scheduling is different, no arbitrary limitations.
80  * 2002-07-25   Sanity check PCI reads, mostly for better cardbus support,
81  *      clean up HC run state handshaking.
82  * 2002-05-24   Preliminary FS/LS interrupts, using scheduling shortcuts
83  * 2002-05-11   Clear TT errors for FS/LS ctrl/bulk.  Fill in some other
84  *      missing pieces:  enabling 64bit dma, handoff from BIOS/SMM.
85  * 2002-05-07   Some error path cleanups to report better errors; wmb();
86  *      use non-CVS version id; better iso bandwidth claim.
87  * 2002-04-19   Control/bulk/interrupt submit no longer uses giveback() on
88  *      errors in submit path.  Bugfixes to interrupt scheduling/processing.
89  * 2002-03-05   Initial high-speed ISO support; reduce ITD memory; shift
90  *      more checking to generic hcd framework (db).  Make it work with
91  *      Philips EHCI; reduce PCI traffic; shorten IRQ path (Rory Bolt).
92  * 2002-01-14   Minor cleanup; version synch.
93  * 2002-01-08   Fix roothub handoff of FS/LS to companion controllers.
94  * 2002-01-04   Control/Bulk queuing behaves.
95  *
96  * 2001-12-12   Initial patch version for Linux 2.5.1 kernel.
97  * 2001-June    Works with usb-storage and NEC EHCI on 2.4
98  */
99
100 #define DRIVER_VERSION "10 Dec 2004"
101 #define DRIVER_AUTHOR "David Brownell"
102 #define DRIVER_DESC "USB 2.0 'Enhanced' Host Controller (EHCI) Driver"
103
104 static const char       hcd_name [] = "ehci_hcd";
105
106
107 #undef EHCI_VERBOSE_DEBUG
108 #undef EHCI_URB_TRACE
109
110 #ifdef DEBUG
111 #define EHCI_STATS
112 #endif
113
114 /* magic numbers that can affect system performance */
115 #define EHCI_TUNE_CERR          3       /* 0-3 qtd retries; 0 == don't stop */
116 #define EHCI_TUNE_RL_HS         4       /* nak throttle; see 4.9 */
117 #define EHCI_TUNE_RL_TT         0
118 #define EHCI_TUNE_MULT_HS       1       /* 1-3 transactions/uframe; 4.10.3 */
119 #define EHCI_TUNE_MULT_TT       1
120 #define EHCI_TUNE_FLS           2       /* (small) 256 frame schedule */
121
122 #define EHCI_IAA_JIFFIES        (HZ/100)        /* arbitrary; ~10 msec */
123 #define EHCI_IO_JIFFIES         (HZ/10)         /* io watchdog > irq_thresh */
124 #define EHCI_ASYNC_JIFFIES      (HZ/20)         /* async idle timeout */
125 #define EHCI_SHRINK_JIFFIES     (HZ/200)        /* async qh unlink delay */
126
127 /* Initial IRQ latency:  faster than hw default */
128 static int log2_irq_thresh = 0;         // 0 to 6
129 module_param (log2_irq_thresh, int, S_IRUGO);
130 MODULE_PARM_DESC (log2_irq_thresh, "log2 IRQ latency, 1-64 microframes");
131
132 /* initial park setting:  slower than hw default */
133 static unsigned park = 0;
134 module_param (park, uint, S_IRUGO);
135 MODULE_PARM_DESC (park, "park setting; 1-3 back-to-back async packets");
136
137 #define INTR_MASK (STS_IAA | STS_FATAL | STS_PCD | STS_ERR | STS_INT)
138
139 /*-------------------------------------------------------------------------*/
140
141 #include "ehci.h"
142 #include "ehci-dbg.c"
143
144 /*-------------------------------------------------------------------------*/
145
146 /*
147  * handshake - spin reading hc until handshake completes or fails
148  * @ptr: address of hc register to be read
149  * @mask: bits to look at in result of read
150  * @done: value of those bits when handshake succeeds
151  * @usec: timeout in microseconds
152  *
153  * Returns negative errno, or zero on success
154  *
155  * Success happens when the "mask" bits have the specified value (hardware
156  * handshake done).  There are two failure modes:  "usec" have passed (major
157  * hardware flakeout), or the register reads as all-ones (hardware removed).
158  *
159  * That last failure should_only happen in cases like physical cardbus eject
160  * before driver shutdown. But it also seems to be caused by bugs in cardbus
161  * bridge shutdown:  shutting down the bridge before the devices using it.
162  */
163 static int handshake (void __iomem *ptr, u32 mask, u32 done, int usec)
164 {
165         u32     result;
166
167         do {
168                 result = readl (ptr);
169                 if (result == ~(u32)0)          /* card removed */
170                         return -ENODEV;
171                 result &= mask;
172                 if (result == done)
173                         return 0;
174                 udelay (1);
175                 usec--;
176         } while (usec > 0);
177         return -ETIMEDOUT;
178 }
179
180 /* force HC to halt state from unknown (EHCI spec section 2.3) */
181 static int ehci_halt (struct ehci_hcd *ehci)
182 {
183         u32     temp = readl (&ehci->regs->status);
184
185         if ((temp & STS_HALT) != 0)
186                 return 0;
187
188         temp = readl (&ehci->regs->command);
189         temp &= ~CMD_RUN;
190         writel (temp, &ehci->regs->command);
191         return handshake (&ehci->regs->status, 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) + 0x68);
201         tmp = readl (reg_ptr);
202         tmp |= 0x3;
203         writel (tmp, reg_ptr);
204 }
205
206 /* reset a non-running (STS_HALT == 1) controller */
207 static int ehci_reset (struct ehci_hcd *ehci)
208 {
209         int     retval;
210         u32     command = readl (&ehci->regs->command);
211
212         command |= CMD_RESET;
213         dbg_cmd (ehci, "reset", command);
214         writel (command, &ehci->regs->command);
215         ehci_to_hcd(ehci)->state = HC_STATE_HALT;
216         ehci->next_statechange = jiffies;
217         retval = handshake (&ehci->regs->command, CMD_RESET, 0, 250 * 1000);
218
219         if (retval)
220                 return retval;
221
222         if (ehci_is_TDI(ehci))
223                 tdi_reset (ehci);
224
225         return retval;
226 }
227
228 /* idle the controller (from running) */
229 static void ehci_quiesce (struct ehci_hcd *ehci)
230 {
231         u32     temp;
232
233 #ifdef DEBUG
234         if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state))
235                 BUG ();
236 #endif
237
238         /* wait for any schedule enables/disables to take effect */
239         temp = readl (&ehci->regs->command) << 10;
240         temp &= STS_ASS | STS_PSS;
241         if (handshake (&ehci->regs->status, STS_ASS | STS_PSS,
242                                 temp, 16 * 125) != 0) {
243                 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
244                 return;
245         }
246
247         /* then disable anything that's still active */
248         temp = readl (&ehci->regs->command);
249         temp &= ~(CMD_ASE | CMD_IAAD | CMD_PSE);
250         writel (temp, &ehci->regs->command);
251
252         /* hardware can take 16 microframes to turn off ... */
253         if (handshake (&ehci->regs->status, STS_ASS | STS_PSS,
254                                 0, 16 * 125) != 0) {
255                 ehci_to_hcd(ehci)->state = HC_STATE_HALT;
256                 return;
257         }
258 }
259
260 /*-------------------------------------------------------------------------*/
261
262 static void ehci_work(struct ehci_hcd *ehci, struct pt_regs *regs);
263
264 #include "ehci-hub.c"
265 #include "ehci-mem.c"
266 #include "ehci-q.c"
267 #include "ehci-sched.c"
268
269 /*-------------------------------------------------------------------------*/
270
271 static void ehci_watchdog (unsigned long param)
272 {
273         struct ehci_hcd         *ehci = (struct ehci_hcd *) param;
274         unsigned long           flags;
275
276         spin_lock_irqsave (&ehci->lock, flags);
277
278         /* lost IAA irqs wedge things badly; seen with a vt8235 */
279         if (ehci->reclaim) {
280                 u32             status = readl (&ehci->regs->status);
281
282                 if (status & STS_IAA) {
283                         ehci_vdbg (ehci, "lost IAA\n");
284                         COUNT (ehci->stats.lost_iaa);
285                         writel (STS_IAA, &ehci->regs->status);
286                         ehci->reclaim_ready = 1;
287                 }
288         }
289
290         /* stop async processing after it's idled a bit */
291         if (test_bit (TIMER_ASYNC_OFF, &ehci->actions))
292                 start_unlink_async (ehci, ehci->async);
293
294         /* ehci could run by timer, without IRQs ... */
295         ehci_work (ehci, NULL);
296
297         spin_unlock_irqrestore (&ehci->lock, flags);
298 }
299
300 #ifdef  CONFIG_PCI
301
302 /* EHCI 0.96 (and later) section 5.1 says how to kick BIOS/SMM/...
303  * off the controller (maybe it can boot from highspeed USB disks).
304  */
305 static int bios_handoff (struct ehci_hcd *ehci, int where, u32 cap)
306 {
307         if (cap & (1 << 16)) {
308                 int msec = 5000;
309                 struct pci_dev *pdev =
310                                 to_pci_dev(ehci_to_hcd(ehci)->self.controller);
311
312                 /* request handoff to OS */
313                 cap |= 1 << 24;
314                 pci_write_config_dword(pdev, where, cap);
315
316                 /* and wait a while for it to happen */
317                 do {
318                         msleep(10);
319                         msec -= 10;
320                         pci_read_config_dword(pdev, where, &cap);
321                 } while ((cap & (1 << 16)) && msec);
322                 if (cap & (1 << 16)) {
323                         ehci_err (ehci, "BIOS handoff failed (%d, %04x)\n",
324                                 where, cap);
325                         // some BIOS versions seem buggy...
326                         // return 1;
327                         ehci_warn (ehci, "continuing after BIOS bug...\n");
328                         return 0;
329                 } 
330                 ehci_dbg (ehci, "BIOS handoff succeeded\n");
331         }
332         return 0;
333 }
334
335 #endif
336
337 static int
338 ehci_reboot (struct notifier_block *self, unsigned long code, void *null)
339 {
340         struct ehci_hcd         *ehci;
341
342         ehci = container_of (self, struct ehci_hcd, reboot_notifier);
343
344         /* make BIOS/etc use companion controller during reboot */
345         writel (0, &ehci->regs->configured_flag);
346         return 0;
347 }
348
349 static void ehci_port_power (struct ehci_hcd *ehci, int is_on)
350 {
351         unsigned port;
352
353         if (!HCS_PPC (ehci->hcs_params))
354                 return;
355
356         ehci_dbg (ehci, "...power%s ports...\n", is_on ? "up" : "down");
357         for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; )
358                 (void) ehci_hub_control(ehci_to_hcd(ehci),
359                                 is_on ? SetPortFeature : ClearPortFeature,
360                                 USB_PORT_FEAT_POWER,
361                                 port--, NULL, 0);
362         msleep(20);
363 }
364
365
366 /* called by khubd or root hub init threads */
367
368 static int ehci_hc_reset (struct usb_hcd *hcd)
369 {
370         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
371         u32                     temp;
372         unsigned                count = 256/4;
373
374         spin_lock_init (&ehci->lock);
375
376         ehci->caps = hcd->regs;
377         ehci->regs = hcd->regs + HC_LENGTH (readl (&ehci->caps->hc_capbase));
378         dbg_hcs_params (ehci, "reset");
379         dbg_hcc_params (ehci, "reset");
380
381         /* cache this readonly data; minimize chip reads */
382         ehci->hcs_params = readl (&ehci->caps->hcs_params);
383
384 #ifdef  CONFIG_PCI
385         if (hcd->self.controller->bus == &pci_bus_type) {
386                 struct pci_dev  *pdev = to_pci_dev(hcd->self.controller);
387
388                 switch (pdev->vendor) {
389                 case PCI_VENDOR_ID_TDI:
390                         if (pdev->device == PCI_DEVICE_ID_TDI_EHCI) {
391                                 ehci->is_tdi_rh_tt = 1;
392                                 tdi_reset (ehci);
393                         }
394                         break;
395                 case PCI_VENDOR_ID_AMD:
396                         /* AMD8111 EHCI doesn't work, according to AMD errata */
397                         if (pdev->device == 0x7463) {
398                                 ehci_info (ehci, "ignoring AMD8111 (errata)\n");
399                                 return -EIO;
400                         }
401                         break;
402                 }
403
404                 /* optional debug port, normally in the first BAR */
405                 temp = pci_find_capability (pdev, 0x0a);
406                 if (temp) {
407                         pci_read_config_dword(pdev, temp, &temp);
408                         temp >>= 16;
409                         if ((temp & (3 << 13)) == (1 << 13)) {
410                                 temp &= 0x1fff;
411                                 ehci->debug = hcd->regs + temp;
412                                 temp = readl (&ehci->debug->control);
413                                 ehci_info (ehci, "debug port %d%s\n",
414                                         HCS_DEBUG_PORT(ehci->hcs_params),
415                                         (temp & DBGP_ENABLED)
416                                                 ? " IN USE"
417                                                 : "");
418                                 if (!(temp & DBGP_ENABLED))
419                                         ehci->debug = NULL;
420                         }
421                 }
422
423                 temp = HCC_EXT_CAPS (readl (&ehci->caps->hcc_params));
424         } else
425                 temp = 0;
426
427         /* EHCI 0.96 and later may have "extended capabilities" */
428         while (temp && count--) {
429                 u32             cap;
430
431                 pci_read_config_dword (to_pci_dev(hcd->self.controller),
432                                 temp, &cap);
433                 ehci_dbg (ehci, "capability %04x at %02x\n", cap, temp);
434                 switch (cap & 0xff) {
435                 case 1:                 /* BIOS/SMM/... handoff */
436                         if (bios_handoff (ehci, temp, cap) != 0)
437                                 return -EOPNOTSUPP;
438                         break;
439                 case 0:                 /* illegal reserved capability */
440                         ehci_warn (ehci, "illegal capability!\n");
441                         cap = 0;
442                         /* FALLTHROUGH */
443                 default:                /* unknown */
444                         break;
445                 }
446                 temp = (cap >> 8) & 0xff;
447         }
448         if (!count) {
449                 ehci_err (ehci, "bogus capabilities ... PCI problems!\n");
450                 return -EIO;
451         }
452         if (ehci_is_TDI(ehci))
453                 ehci_reset (ehci);
454 #endif
455
456         ehci_port_power (ehci, 0);
457
458         /* at least the Genesys GL880S needs fixup here */
459         temp = HCS_N_CC(ehci->hcs_params) * HCS_N_PCC(ehci->hcs_params);
460         temp &= 0x0f;
461         if (temp && HCS_N_PORTS(ehci->hcs_params) > temp) {
462                 ehci_dbg (ehci, "bogus port configuration: "
463                         "cc=%d x pcc=%d < ports=%d\n",
464                         HCS_N_CC(ehci->hcs_params),
465                         HCS_N_PCC(ehci->hcs_params),
466                         HCS_N_PORTS(ehci->hcs_params));
467
468 #ifdef  CONFIG_PCI
469                 if (hcd->self.controller->bus == &pci_bus_type) {
470                         struct pci_dev  *pdev;
471
472                         pdev = to_pci_dev(hcd->self.controller);
473                         switch (pdev->vendor) {
474                         case 0x17a0:            /* GENESYS */
475                                 /* GL880S: should be PORTS=2 */
476                                 temp |= (ehci->hcs_params & ~0xf);
477                                 ehci->hcs_params = temp;
478                                 break;
479                         case PCI_VENDOR_ID_NVIDIA:
480                                 /* NF4: should be PCC=10 */
481                                 break;
482                         }
483                 }
484 #endif
485         }
486
487         /* force HC to halt state */
488         return ehci_halt (ehci);
489 }
490
491 static int ehci_start (struct usb_hcd *hcd)
492 {
493         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
494         u32                     temp;
495         struct usb_device       *udev;
496         struct usb_bus          *bus;
497         int                     retval;
498         u32                     hcc_params;
499         u8                      sbrn = 0;
500         int                     first;
501
502         /* skip some things on restart paths */
503         first = (ehci->watchdog.data == 0);
504         if (first) {
505                 init_timer (&ehci->watchdog);
506                 ehci->watchdog.function = ehci_watchdog;
507                 ehci->watchdog.data = (unsigned long) ehci;
508         }
509
510         /*
511          * hw default: 1K periodic list heads, one per frame.
512          * periodic_size can shrink by USBCMD update if hcc_params allows.
513          */
514         ehci->periodic_size = DEFAULT_I_TDPS;
515         if (first && (retval = ehci_mem_init (ehci, GFP_KERNEL)) < 0)
516                 return retval;
517
518         /* controllers may cache some of the periodic schedule ... */
519         hcc_params = readl (&ehci->caps->hcc_params);
520         if (HCC_ISOC_CACHE (hcc_params))        // full frame cache
521                 ehci->i_thresh = 8;
522         else                                    // N microframes cached
523                 ehci->i_thresh = 2 + HCC_ISOC_THRES (hcc_params);
524
525         ehci->reclaim = NULL;
526         ehci->reclaim_ready = 0;
527         ehci->next_uframe = -1;
528
529         /* controller state:  unknown --> reset */
530
531         /* EHCI spec section 4.1 */
532         if ((retval = ehci_reset (ehci)) != 0) {
533                 ehci_mem_cleanup (ehci);
534                 return retval;
535         }
536         writel (ehci->periodic_dma, &ehci->regs->frame_list);
537
538 #ifdef  CONFIG_PCI
539         if (hcd->self.controller->bus == &pci_bus_type) {
540                 struct pci_dev          *pdev;
541                 u16                     port_wake;
542
543                 pdev = to_pci_dev(hcd->self.controller);
544
545                 /* Serial Bus Release Number is at PCI 0x60 offset */
546                 pci_read_config_byte(pdev, 0x60, &sbrn);
547
548                 /* port wake capability, reported by boot firmware */
549                 pci_read_config_word(pdev, 0x62, &port_wake);
550                 hcd->can_wakeup = (port_wake & 1) != 0;
551
552                 /* help hc dma work well with cachelines */
553                 pci_set_mwi (pdev);
554         }
555 #endif
556
557         /*
558          * dedicate a qh for the async ring head, since we couldn't unlink
559          * a 'real' qh without stopping the async schedule [4.8].  use it
560          * as the 'reclamation list head' too.
561          * its dummy is used in hw_alt_next of many tds, to prevent the qh
562          * from automatically advancing to the next td after short reads.
563          */
564         if (first) {
565                 ehci->async->qh_next.qh = NULL;
566                 ehci->async->hw_next = QH_NEXT (ehci->async->qh_dma);
567                 ehci->async->hw_info1 = cpu_to_le32 (QH_HEAD);
568                 ehci->async->hw_token = cpu_to_le32 (QTD_STS_HALT);
569                 ehci->async->hw_qtd_next = EHCI_LIST_END;
570                 ehci->async->qh_state = QH_STATE_LINKED;
571                 ehci->async->hw_alt_next = QTD_NEXT (ehci->async->dummy->qtd_dma);
572         }
573         writel ((u32)ehci->async->qh_dma, &ehci->regs->async_next);
574
575         /*
576          * hcc_params controls whether ehci->regs->segment must (!!!)
577          * be used; it constrains QH/ITD/SITD and QTD locations.
578          * pci_pool consistent memory always uses segment zero.
579          * streaming mappings for I/O buffers, like pci_map_single(),
580          * can return segments above 4GB, if the device allows.
581          *
582          * NOTE:  the dma mask is visible through dma_supported(), so
583          * drivers can pass this info along ... like NETIF_F_HIGHDMA,
584          * Scsi_Host.highmem_io, and so forth.  It's readonly to all
585          * host side drivers though.
586          */
587         if (HCC_64BIT_ADDR (hcc_params)) {
588                 writel (0, &ehci->regs->segment);
589 #if 0
590 // this is deeply broken on almost all architectures
591                 if (!pci_set_dma_mask (to_pci_dev(hcd->self.controller), 0xffffffffffffffffULL))
592                         ehci_info (ehci, "enabled 64bit PCI DMA\n");
593 #endif
594         }
595
596         /* clear interrupt enables, set irq latency */
597         if (log2_irq_thresh < 0 || log2_irq_thresh > 6)
598                 log2_irq_thresh = 0;
599         temp = 1 << (16 + log2_irq_thresh);
600         if (HCC_CANPARK(hcc_params)) {
601                 /* HW default park == 3, on hardware that supports it (like
602                  * NVidia and ALI silicon), maximizes throughput on the async
603                  * schedule by avoiding QH fetches between transfers.
604                  *
605                  * With fast usb storage devices and NForce2, "park" seems to
606                  * make problems:  throughput reduction (!), data errors...
607                  */
608                 if (park) {
609                         park = min (park, (unsigned) 3);
610                         temp |= CMD_PARK;
611                         temp |= park << 8;
612                 }
613                 ehci_info (ehci, "park %d\n", park);
614         }
615         if (HCC_PGM_FRAMELISTLEN (hcc_params)) {
616                 /* periodic schedule size can be smaller than default */
617                 temp &= ~(3 << 2);
618                 temp |= (EHCI_TUNE_FLS << 2);
619                 switch (EHCI_TUNE_FLS) {
620                 case 0: ehci->periodic_size = 1024; break;
621                 case 1: ehci->periodic_size = 512; break;
622                 case 2: ehci->periodic_size = 256; break;
623                 default:        BUG ();
624                 }
625         }
626         // Philips, Intel, and maybe others need CMD_RUN before the
627         // root hub will detect new devices (why?); NEC doesn't
628         temp |= CMD_RUN;
629         writel (temp, &ehci->regs->command);
630         dbg_cmd (ehci, "init", temp);
631
632         /* set async sleep time = 10 us ... ? */
633
634         /* wire up the root hub */
635         bus = hcd_to_bus (hcd);
636         udev = first ? usb_alloc_dev (NULL, bus, 0) : bus->root_hub;
637         if (!udev) {
638 done2:
639                 ehci_mem_cleanup (ehci);
640                 return -ENOMEM;
641         }
642         udev->speed = USB_SPEED_HIGH;
643         udev->state = first ? USB_STATE_ATTACHED : USB_STATE_CONFIGURED;
644
645         /*
646          * Start, enabling full USB 2.0 functionality ... usb 1.1 devices
647          * are explicitly handed to companion controller(s), so no TT is
648          * involved with the root hub.  (Except where one is integrated,
649          * and there's no companion controller unless maybe for USB OTG.)
650          */
651         if (first) {
652                 ehci->reboot_notifier.notifier_call = ehci_reboot;
653                 register_reboot_notifier (&ehci->reboot_notifier);
654         }
655
656         hcd->state = HC_STATE_RUNNING;
657         writel (FLAG_CF, &ehci->regs->configured_flag);
658         readl (&ehci->regs->command);   /* unblock posted write */
659
660         temp = HC_VERSION(readl (&ehci->caps->hc_capbase));
661         ehci_info (ehci,
662                 "USB %x.%x %s, EHCI %x.%02x, driver %s\n",
663                 ((sbrn & 0xf0)>>4), (sbrn & 0x0f),
664                 first ? "initialized" : "restarted",
665                 temp >> 8, temp & 0xff, DRIVER_VERSION);
666
667         /*
668          * From here on, khubd concurrently accesses the root
669          * hub; drivers will be talking to enumerated devices.
670          * (On restart paths, khubd already knows about the root
671          * hub and could find work as soon as we wrote FLAG_CF.)
672          *
673          * Before this point the HC was idle/ready.  After, khubd
674          * and device drivers may start it running.
675          */
676         if (first && usb_hcd_register_root_hub (udev, hcd) != 0) {
677                 if (hcd->state == HC_STATE_RUNNING)
678                         ehci_quiesce (ehci);
679                 ehci_reset (ehci);
680                 usb_put_dev (udev); 
681                 retval = -ENODEV;
682                 goto done2;
683         }
684
685         writel (INTR_MASK, &ehci->regs->intr_enable); /* Turn On Interrupts */
686
687         if (first)
688                 create_debug_files (ehci);
689
690         return 0;
691 }
692
693 /* always called by thread; normally rmmod */
694
695 static void ehci_stop (struct usb_hcd *hcd)
696 {
697         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
698
699         ehci_dbg (ehci, "stop\n");
700
701         /* Turn off port power on all root hub ports. */
702         ehci_port_power (ehci, 0);
703
704         /* no more interrupts ... */
705         del_timer_sync (&ehci->watchdog);
706
707         spin_lock_irq(&ehci->lock);
708         if (HC_IS_RUNNING (hcd->state))
709                 ehci_quiesce (ehci);
710
711         ehci_reset (ehci);
712         writel (0, &ehci->regs->intr_enable);
713         spin_unlock_irq(&ehci->lock);
714
715         /* let companion controllers work when we aren't */
716         writel (0, &ehci->regs->configured_flag);
717         unregister_reboot_notifier (&ehci->reboot_notifier);
718
719         remove_debug_files (ehci);
720
721         /* root hub is shut down separately (first, when possible) */
722         spin_lock_irq (&ehci->lock);
723         if (ehci->async)
724                 ehci_work (ehci, NULL);
725         spin_unlock_irq (&ehci->lock);
726         ehci_mem_cleanup (ehci);
727
728 #ifdef  EHCI_STATS
729         ehci_dbg (ehci, "irq normal %ld err %ld reclaim %ld (lost %ld)\n",
730                 ehci->stats.normal, ehci->stats.error, ehci->stats.reclaim,
731                 ehci->stats.lost_iaa);
732         ehci_dbg (ehci, "complete %ld unlink %ld\n",
733                 ehci->stats.complete, ehci->stats.unlink);
734 #endif
735
736         dbg_status (ehci, "ehci_stop completed", readl (&ehci->regs->status));
737 }
738
739 static int ehci_get_frame (struct usb_hcd *hcd)
740 {
741         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
742         return (readl (&ehci->regs->frame_index) >> 3) % ehci->periodic_size;
743 }
744
745 /*-------------------------------------------------------------------------*/
746
747 #ifdef  CONFIG_PM
748
749 /* suspend/resume, section 4.3 */
750
751 /* These routines rely on the bus (pci, platform, etc)
752  * to handle powerdown and wakeup, and currently also on
753  * transceivers that don't need any software attention to set up
754  * the right sort of wakeup.  
755  */
756
757 static int ehci_suspend (struct usb_hcd *hcd, pm_message_t message)
758 {
759         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
760
761         if (time_before (jiffies, ehci->next_statechange))
762                 msleep (100);
763
764 #ifdef  CONFIG_USB_SUSPEND
765         (void) usb_suspend_device (hcd->self.root_hub, message);
766 #else
767         usb_lock_device (hcd->self.root_hub);
768         (void) ehci_hub_suspend (hcd);
769         usb_unlock_device (hcd->self.root_hub);
770 #endif
771
772         // save (PCI) FLADJ in case of Vaux power loss
773         // ... we'd only use it to handle clock skew
774
775         return 0;
776 }
777
778 static int ehci_resume (struct usb_hcd *hcd)
779 {
780         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
781         unsigned                port;
782         struct usb_device       *root = hcd->self.root_hub;
783         int                     retval = -EINVAL;
784
785         // maybe restore (PCI) FLADJ
786
787         if (time_before (jiffies, ehci->next_statechange))
788                 msleep (100);
789
790         /* If any port is suspended, we know we can/must resume the HC. */
791         for (port = HCS_N_PORTS (ehci->hcs_params); port > 0; ) {
792                 u32     status;
793                 port--;
794                 status = readl (&ehci->regs->port_status [port]);
795                 if (status & PORT_SUSPEND) {
796                         down (&hcd->self.root_hub->serialize);
797                         retval = ehci_hub_resume (hcd);
798                         up (&hcd->self.root_hub->serialize);
799                         break;
800                 }
801                 if (!root->children [port])
802                         continue;
803                 dbg_port (ehci, __FUNCTION__, port + 1, status);
804                 usb_set_device_state (root->children[port],
805                                         USB_STATE_NOTATTACHED);
806         }
807
808         /* Else reset, to cope with power loss or flush-to-storage
809          * style "resume" having activated BIOS during reboot.
810          */
811         if (port == 0) {
812                 (void) ehci_halt (ehci);
813                 (void) ehci_reset (ehci);
814                 (void) ehci_hc_reset (hcd);
815
816                 /* emptying the schedule aborts any urbs */
817                 spin_lock_irq (&ehci->lock);
818                 if (ehci->reclaim)
819                         ehci->reclaim_ready = 1;
820                 ehci_work (ehci, NULL);
821                 spin_unlock_irq (&ehci->lock);
822
823                 /* restart; khubd will disconnect devices */
824                 retval = ehci_start (hcd);
825
826                 /* here we "know" root ports should always stay powered;
827                  * but some controllers may lose all power.
828                  */
829                 ehci_port_power (ehci, 1);
830         }
831
832         return retval;
833 }
834
835 #endif
836
837 /*-------------------------------------------------------------------------*/
838
839 /*
840  * ehci_work is called from some interrupts, timers, and so on.
841  * it calls driver completion functions, after dropping ehci->lock.
842  */
843 static void ehci_work (struct ehci_hcd *ehci, struct pt_regs *regs)
844 {
845         timer_action_done (ehci, TIMER_IO_WATCHDOG);
846         if (ehci->reclaim_ready)
847                 end_unlink_async (ehci, regs);
848
849         /* another CPU may drop ehci->lock during a schedule scan while
850          * it reports urb completions.  this flag guards against bogus
851          * attempts at re-entrant schedule scanning.
852          */
853         if (ehci->scanning)
854                 return;
855         ehci->scanning = 1;
856         scan_async (ehci, regs);
857         if (ehci->next_uframe != -1)
858                 scan_periodic (ehci, regs);
859         ehci->scanning = 0;
860
861         /* the IO watchdog guards against hardware or driver bugs that
862          * misplace IRQs, and should let us run completely without IRQs.
863          * such lossage has been observed on both VT6202 and VT8235. 
864          */
865         if (HC_IS_RUNNING (ehci_to_hcd(ehci)->state) &&
866                         (ehci->async->qh_next.ptr != NULL ||
867                          ehci->periodic_sched != 0))
868                 timer_action (ehci, TIMER_IO_WATCHDOG);
869 }
870
871 /*-------------------------------------------------------------------------*/
872
873 static irqreturn_t ehci_irq (struct usb_hcd *hcd, struct pt_regs *regs)
874 {
875         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
876         u32                     status;
877         int                     bh;
878
879         spin_lock (&ehci->lock);
880
881         status = readl (&ehci->regs->status);
882
883         /* e.g. cardbus physical eject */
884         if (status == ~(u32) 0) {
885                 ehci_dbg (ehci, "device removed\n");
886                 goto dead;
887         }
888
889         status &= INTR_MASK;
890         if (!status) {                  /* irq sharing? */
891                 spin_unlock(&ehci->lock);
892                 return IRQ_NONE;
893         }
894
895         /* clear (just) interrupts */
896         writel (status, &ehci->regs->status);
897         readl (&ehci->regs->command);   /* unblock posted write */
898         bh = 0;
899
900 #ifdef  EHCI_VERBOSE_DEBUG
901         /* unrequested/ignored: Frame List Rollover */
902         dbg_status (ehci, "irq", status);
903 #endif
904
905         /* INT, ERR, and IAA interrupt rates can be throttled */
906
907         /* normal [4.15.1.2] or error [4.15.1.1] completion */
908         if (likely ((status & (STS_INT|STS_ERR)) != 0)) {
909                 if (likely ((status & STS_ERR) == 0))
910                         COUNT (ehci->stats.normal);
911                 else
912                         COUNT (ehci->stats.error);
913                 bh = 1;
914         }
915
916         /* complete the unlinking of some qh [4.15.2.3] */
917         if (status & STS_IAA) {
918                 COUNT (ehci->stats.reclaim);
919                 ehci->reclaim_ready = 1;
920                 bh = 1;
921         }
922
923         /* remote wakeup [4.3.1] */
924         if ((status & STS_PCD) && hcd->remote_wakeup) {
925                 unsigned        i = HCS_N_PORTS (ehci->hcs_params);
926
927                 /* resume root hub? */
928                 status = readl (&ehci->regs->command);
929                 if (!(status & CMD_RUN))
930                         writel (status | CMD_RUN, &ehci->regs->command);
931
932                 while (i--) {
933                         status = readl (&ehci->regs->port_status [i]);
934                         if (status & PORT_OWNER)
935                                 continue;
936                         if (!(status & PORT_RESUME)
937                                         || ehci->reset_done [i] != 0)
938                                 continue;
939
940                         /* start 20 msec resume signaling from this port,
941                          * and make khubd collect PORT_STAT_C_SUSPEND to
942                          * stop that signaling.
943                          */
944                         ehci->reset_done [i] = jiffies + msecs_to_jiffies (20);
945                         mod_timer (&hcd->rh_timer,
946                                         ehci->reset_done [i] + 1);
947                         ehci_dbg (ehci, "port %d remote wakeup\n", i + 1);
948                 }
949         }
950
951         /* PCI errors [4.15.2.4] */
952         if (unlikely ((status & STS_FATAL) != 0)) {
953                 /* bogus "fatal" IRQs appear on some chips... why?  */
954                 status = readl (&ehci->regs->status);
955                 dbg_cmd (ehci, "fatal", readl (&ehci->regs->command));
956                 dbg_status (ehci, "fatal", status);
957                 if (status & STS_HALT) {
958                         ehci_err (ehci, "fatal error\n");
959 dead:
960                         ehci_reset (ehci);
961                         writel (0, &ehci->regs->configured_flag);
962                         /* generic layer kills/unlinks all urbs, then
963                          * uses ehci_stop to clean up the rest
964                          */
965                         bh = 1;
966                 }
967         }
968
969         if (bh)
970                 ehci_work (ehci, regs);
971         spin_unlock (&ehci->lock);
972         return IRQ_HANDLED;
973 }
974
975 /*-------------------------------------------------------------------------*/
976
977 /*
978  * non-error returns are a promise to giveback() the urb later
979  * we drop ownership so next owner (or urb unlink) can get it
980  *
981  * urb + dev is in hcd.self.controller.urb_list
982  * we're queueing TDs onto software and hardware lists
983  *
984  * hcd-specific init for hcpriv hasn't been done yet
985  *
986  * NOTE:  control, bulk, and interrupt share the same code to append TDs
987  * to a (possibly active) QH, and the same QH scanning code.
988  */
989 static int ehci_urb_enqueue (
990         struct usb_hcd  *hcd,
991         struct usb_host_endpoint *ep,
992         struct urb      *urb,
993         int             mem_flags
994 ) {
995         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
996         struct list_head        qtd_list;
997
998         INIT_LIST_HEAD (&qtd_list);
999
1000         switch (usb_pipetype (urb->pipe)) {
1001         // case PIPE_CONTROL:
1002         // case PIPE_BULK:
1003         default:
1004                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
1005                         return -ENOMEM;
1006                 return submit_async (ehci, ep, urb, &qtd_list, mem_flags);
1007
1008         case PIPE_INTERRUPT:
1009                 if (!qh_urb_transaction (ehci, urb, &qtd_list, mem_flags))
1010                         return -ENOMEM;
1011                 return intr_submit (ehci, ep, urb, &qtd_list, mem_flags);
1012
1013         case PIPE_ISOCHRONOUS:
1014                 if (urb->dev->speed == USB_SPEED_HIGH)
1015                         return itd_submit (ehci, urb, mem_flags);
1016                 else
1017                         return sitd_submit (ehci, urb, mem_flags);
1018         }
1019 }
1020
1021 static void unlink_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
1022 {
1023         /* if we need to use IAA and it's busy, defer */
1024         if (qh->qh_state == QH_STATE_LINKED
1025                         && ehci->reclaim
1026                         && HC_IS_RUNNING (ehci_to_hcd(ehci)->state)) {
1027                 struct ehci_qh          *last;
1028
1029                 for (last = ehci->reclaim;
1030                                 last->reclaim;
1031                                 last = last->reclaim)
1032                         continue;
1033                 qh->qh_state = QH_STATE_UNLINK_WAIT;
1034                 last->reclaim = qh;
1035
1036         /* bypass IAA if the hc can't care */
1037         } else if (!HC_IS_RUNNING (ehci_to_hcd(ehci)->state) && ehci->reclaim)
1038                 end_unlink_async (ehci, NULL);
1039
1040         /* something else might have unlinked the qh by now */
1041         if (qh->qh_state == QH_STATE_LINKED)
1042                 start_unlink_async (ehci, qh);
1043 }
1044
1045 /* remove from hardware lists
1046  * completions normally happen asynchronously
1047  */
1048
1049 static int ehci_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
1050 {
1051         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
1052         struct ehci_qh          *qh;
1053         unsigned long           flags;
1054
1055         spin_lock_irqsave (&ehci->lock, flags);
1056         switch (usb_pipetype (urb->pipe)) {
1057         // case PIPE_CONTROL:
1058         // case PIPE_BULK:
1059         default:
1060                 qh = (struct ehci_qh *) urb->hcpriv;
1061                 if (!qh)
1062                         break;
1063                 unlink_async (ehci, qh);
1064                 break;
1065
1066         case PIPE_INTERRUPT:
1067                 qh = (struct ehci_qh *) urb->hcpriv;
1068                 if (!qh)
1069                         break;
1070                 switch (qh->qh_state) {
1071                 case QH_STATE_LINKED:
1072                         intr_deschedule (ehci, qh);
1073                         /* FALL THROUGH */
1074                 case QH_STATE_IDLE:
1075                         qh_completions (ehci, qh, NULL);
1076                         break;
1077                 default:
1078                         ehci_dbg (ehci, "bogus qh %p state %d\n",
1079                                         qh, qh->qh_state);
1080                         goto done;
1081                 }
1082
1083                 /* reschedule QH iff another request is queued */
1084                 if (!list_empty (&qh->qtd_list)
1085                                 && HC_IS_RUNNING (hcd->state)) {
1086                         int status;
1087
1088                         status = qh_schedule (ehci, qh);
1089                         spin_unlock_irqrestore (&ehci->lock, flags);
1090
1091                         if (status != 0) {
1092                                 // shouldn't happen often, but ...
1093                                 // FIXME kill those tds' urbs
1094                                 err ("can't reschedule qh %p, err %d",
1095                                         qh, status);
1096                         }
1097                         return status;
1098                 }
1099                 break;
1100
1101         case PIPE_ISOCHRONOUS:
1102                 // itd or sitd ...
1103
1104                 // wait till next completion, do it then.
1105                 // completion irqs can wait up to 1024 msec,
1106                 break;
1107         }
1108 done:
1109         spin_unlock_irqrestore (&ehci->lock, flags);
1110         return 0;
1111 }
1112
1113 /*-------------------------------------------------------------------------*/
1114
1115 // bulk qh holds the data toggle
1116
1117 static void
1118 ehci_endpoint_disable (struct usb_hcd *hcd, struct usb_host_endpoint *ep)
1119 {
1120         struct ehci_hcd         *ehci = hcd_to_ehci (hcd);
1121         unsigned long           flags;
1122         struct ehci_qh          *qh, *tmp;
1123
1124         /* ASSERT:  any requests/urbs are being unlinked */
1125         /* ASSERT:  nobody can be submitting urbs for this any more */
1126
1127 rescan:
1128         spin_lock_irqsave (&ehci->lock, flags);
1129         qh = ep->hcpriv;
1130         if (!qh)
1131                 goto done;
1132
1133         /* endpoints can be iso streams.  for now, we don't
1134          * accelerate iso completions ... so spin a while.
1135          */
1136         if (qh->hw_info1 == 0) {
1137                 ehci_vdbg (ehci, "iso delay\n");
1138                 goto idle_timeout;
1139         }
1140
1141         if (!HC_IS_RUNNING (hcd->state))
1142                 qh->qh_state = QH_STATE_IDLE;
1143         switch (qh->qh_state) {
1144         case QH_STATE_LINKED:
1145                 for (tmp = ehci->async->qh_next.qh;
1146                                 tmp && tmp != qh;
1147                                 tmp = tmp->qh_next.qh)
1148                         continue;
1149                 /* periodic qh self-unlinks on empty */
1150                 if (!tmp)
1151                         goto nogood;
1152                 unlink_async (ehci, qh);
1153                 /* FALL THROUGH */
1154         case QH_STATE_UNLINK:           /* wait for hw to finish? */
1155 idle_timeout:
1156                 spin_unlock_irqrestore (&ehci->lock, flags);
1157                 set_current_state (TASK_UNINTERRUPTIBLE);
1158                 schedule_timeout (1);
1159                 goto rescan;
1160         case QH_STATE_IDLE:             /* fully unlinked */
1161                 if (list_empty (&qh->qtd_list)) {
1162                         qh_put (qh);
1163                         break;
1164                 }
1165                 /* else FALL THROUGH */
1166         default:
1167 nogood:
1168                 /* caller was supposed to have unlinked any requests;
1169                  * that's not our job.  just leak this memory.
1170                  */
1171                 ehci_err (ehci, "qh %p (#%02x) state %d%s\n",
1172                         qh, ep->desc.bEndpointAddress, qh->qh_state,
1173                         list_empty (&qh->qtd_list) ? "" : "(has tds)");
1174                 break;
1175         }
1176         ep->hcpriv = NULL;
1177 done:
1178         spin_unlock_irqrestore (&ehci->lock, flags);
1179         return;
1180 }
1181
1182 /*-------------------------------------------------------------------------*/
1183
1184 static const struct hc_driver ehci_driver = {
1185         .description =          hcd_name,
1186         .product_desc =         "EHCI Host Controller",
1187         .hcd_priv_size =        sizeof(struct ehci_hcd),
1188
1189         /*
1190          * generic hardware linkage
1191          */
1192         .irq =                  ehci_irq,
1193         .flags =                HCD_MEMORY | HCD_USB2,
1194
1195         /*
1196          * basic lifecycle operations
1197          */
1198         .reset =                ehci_hc_reset,
1199         .start =                ehci_start,
1200 #ifdef  CONFIG_PM
1201         .suspend =              ehci_suspend,
1202         .resume =               ehci_resume,
1203 #endif
1204         .stop =                 ehci_stop,
1205
1206         /*
1207          * managing i/o requests and associated device resources
1208          */
1209         .urb_enqueue =          ehci_urb_enqueue,
1210         .urb_dequeue =          ehci_urb_dequeue,
1211         .endpoint_disable =     ehci_endpoint_disable,
1212
1213         /*
1214          * scheduling support
1215          */
1216         .get_frame_number =     ehci_get_frame,
1217
1218         /*
1219          * root hub support
1220          */
1221         .hub_status_data =      ehci_hub_status_data,
1222         .hub_control =          ehci_hub_control,
1223         .hub_suspend =          ehci_hub_suspend,
1224         .hub_resume =           ehci_hub_resume,
1225 };
1226
1227 /*-------------------------------------------------------------------------*/
1228
1229 /* EHCI 1.0 doesn't require PCI */
1230
1231 #ifdef  CONFIG_PCI
1232
1233 /* PCI driver selection metadata; PCI hotplugging uses this */
1234 static const struct pci_device_id pci_ids [] = { {
1235         /* handle any USB 2.0 EHCI controller */
1236         PCI_DEVICE_CLASS(((PCI_CLASS_SERIAL_USB << 8) | 0x20), ~0),
1237         .driver_data =  (unsigned long) &ehci_driver,
1238         },
1239         { /* end: all zeroes */ }
1240 };
1241 MODULE_DEVICE_TABLE (pci, pci_ids);
1242
1243 /* pci driver glue; this is a "new style" PCI driver module */
1244 static struct pci_driver ehci_pci_driver = {
1245         .name =         (char *) hcd_name,
1246         .id_table =     pci_ids,
1247
1248         .probe =        usb_hcd_pci_probe,
1249         .remove =       usb_hcd_pci_remove,
1250
1251 #ifdef  CONFIG_PM
1252         .suspend =      usb_hcd_pci_suspend,
1253         .resume =       usb_hcd_pci_resume,
1254 #endif
1255 };
1256
1257 #endif  /* PCI */
1258
1259
1260 #define DRIVER_INFO DRIVER_VERSION " " DRIVER_DESC
1261
1262 MODULE_DESCRIPTION (DRIVER_INFO);
1263 MODULE_AUTHOR (DRIVER_AUTHOR);
1264 MODULE_LICENSE ("GPL");
1265
1266 static int __init init (void) 
1267 {
1268         if (usb_disabled())
1269                 return -ENODEV;
1270
1271         pr_debug ("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
1272                 hcd_name,
1273                 sizeof (struct ehci_qh), sizeof (struct ehci_qtd),
1274                 sizeof (struct ehci_itd), sizeof (struct ehci_sitd));
1275
1276         return pci_register_driver (&ehci_pci_driver);
1277 }
1278 module_init (init);
1279
1280 static void __exit cleanup (void) 
1281 {       
1282         pci_unregister_driver (&ehci_pci_driver);
1283 }
1284 module_exit (cleanup);