a88ad517ec5c29c31a397e5e900ae55e8393f789
[linux-2.6.git] / drivers / usb / host / ehci-pci.c
1 /*
2  * EHCI HCD (Host Controller Driver) PCI Bus Glue.
3  *
4  * Copyright (c) 2000-2004 by David Brownell
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the
8  * Free Software Foundation; either version 2 of the License, or (at your
9  * option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19  */
20
21 #ifndef CONFIG_PCI
22 #error "This file is PCI bus glue.  CONFIG_PCI must be defined."
23 #endif
24
25 /*-------------------------------------------------------------------------*/
26
27 /* called after powerup, by probe or system-pm "wakeup" */
28 static int ehci_pci_reinit(struct ehci_hcd *ehci, struct pci_dev *pdev)
29 {
30         u32                     temp;
31         int                     retval;
32
33         /* optional debug port, normally in the first BAR */
34         temp = pci_find_capability(pdev, 0x0a);
35         if (temp) {
36                 pci_read_config_dword(pdev, temp, &temp);
37                 temp >>= 16;
38                 if ((temp & (3 << 13)) == (1 << 13)) {
39                         temp &= 0x1fff;
40                         ehci->debug = ehci_to_hcd(ehci)->regs + temp;
41                         temp = ehci_readl(ehci, &ehci->debug->control);
42                         ehci_info(ehci, "debug port %d%s\n",
43                                 HCS_DEBUG_PORT(ehci->hcs_params),
44                                 (temp & DBGP_ENABLED)
45                                         ? " IN USE"
46                                         : "");
47                         if (!(temp & DBGP_ENABLED))
48                                 ehci->debug = NULL;
49                 }
50         }
51
52         /* we expect static quirk code to handle the "extended capabilities"
53          * (currently just BIOS handoff) allowed starting with EHCI 0.96
54          */
55
56         /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
57         retval = pci_set_mwi(pdev);
58         if (!retval)
59                 ehci_dbg(ehci, "MWI active\n");
60
61         return 0;
62 }
63
64 /* called during probe() after chip reset completes */
65 static int ehci_pci_setup(struct usb_hcd *hcd)
66 {
67         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
68         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
69         struct pci_dev          *p_smbus;
70         u8                      rev;
71         u32                     temp;
72         int                     retval;
73
74         switch (pdev->vendor) {
75         case PCI_VENDOR_ID_TOSHIBA_2:
76                 /* celleb's companion chip */
77                 if (pdev->device == 0x01b5) {
78 #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
79                         ehci->big_endian_mmio = 1;
80 #else
81                         ehci_warn(ehci,
82                                   "unsupported big endian Toshiba quirk\n");
83 #endif
84                 }
85                 break;
86         }
87
88         ehci->caps = hcd->regs;
89         ehci->regs = hcd->regs +
90                 HC_LENGTH(ehci_readl(ehci, &ehci->caps->hc_capbase));
91
92         dbg_hcs_params(ehci, "reset");
93         dbg_hcc_params(ehci, "reset");
94
95         /* ehci_init() causes memory for DMA transfers to be
96          * allocated.  Thus, any vendor-specific workarounds based on
97          * limiting the type of memory used for DMA transfers must
98          * happen before ehci_init() is called. */
99         switch (pdev->vendor) {
100         case PCI_VENDOR_ID_NVIDIA:
101                 /* NVidia reports that certain chips don't handle
102                  * QH, ITD, or SITD addresses above 2GB.  (But TD,
103                  * data buffer, and periodic schedule are normal.)
104                  */
105                 switch (pdev->device) {
106                 case 0x003c:    /* MCP04 */
107                 case 0x005b:    /* CK804 */
108                 case 0x00d8:    /* CK8 */
109                 case 0x00e8:    /* CK8S */
110                         if (pci_set_consistent_dma_mask(pdev,
111                                                 DMA_BIT_MASK(31)) < 0)
112                                 ehci_warn(ehci, "can't enable NVidia "
113                                         "workaround for >2GB RAM\n");
114                         break;
115                 }
116                 break;
117         }
118
119         /* cache this readonly data; minimize chip reads */
120         ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
121
122         retval = ehci_halt(ehci);
123         if (retval)
124                 return retval;
125
126         /* data structure init */
127         retval = ehci_init(hcd);
128         if (retval)
129                 return retval;
130
131         switch (pdev->vendor) {
132         case PCI_VENDOR_ID_INTEL:
133                 ehci->need_io_watchdog = 0;
134                 break;
135         case PCI_VENDOR_ID_TDI:
136                 if (pdev->device == PCI_DEVICE_ID_TDI_EHCI) {
137                         hcd->has_tt = 1;
138                         tdi_reset(ehci);
139                 }
140                 break;
141         case PCI_VENDOR_ID_AMD:
142                 /* AMD8111 EHCI doesn't work, according to AMD errata */
143                 if (pdev->device == 0x7463) {
144                         ehci_info(ehci, "ignoring AMD8111 (errata)\n");
145                         retval = -EIO;
146                         goto done;
147                 }
148                 break;
149         case PCI_VENDOR_ID_NVIDIA:
150                 switch (pdev->device) {
151                 /* Some NForce2 chips have problems with selective suspend;
152                  * fixed in newer silicon.
153                  */
154                 case 0x0068:
155                         if (pdev->revision < 0xa4)
156                                 ehci->no_selective_suspend = 1;
157                         break;
158                 }
159                 break;
160         case PCI_VENDOR_ID_VIA:
161                 if (pdev->device == 0x3104 && (pdev->revision & 0xf0) == 0x60) {
162                         u8 tmp;
163
164                         /* The VT6212 defaults to a 1 usec EHCI sleep time which
165                          * hogs the PCI bus *badly*. Setting bit 5 of 0x4B makes
166                          * that sleep time use the conventional 10 usec.
167                          */
168                         pci_read_config_byte(pdev, 0x4b, &tmp);
169                         if (tmp & 0x20)
170                                 break;
171                         pci_write_config_byte(pdev, 0x4b, tmp | 0x20);
172                 }
173                 break;
174         case PCI_VENDOR_ID_ATI:
175                 /* SB600 and old version of SB700 have a bug in EHCI controller,
176                  * which causes usb devices lose response in some cases.
177                  */
178                 if ((pdev->device == 0x4386) || (pdev->device == 0x4396)) {
179                         p_smbus = pci_get_device(PCI_VENDOR_ID_ATI,
180                                                  PCI_DEVICE_ID_ATI_SBX00_SMBUS,
181                                                  NULL);
182                         if (!p_smbus)
183                                 break;
184                         rev = p_smbus->revision;
185                         if ((pdev->device == 0x4386) || (rev == 0x3a)
186                             || (rev == 0x3b)) {
187                                 u8 tmp;
188                                 ehci_info(ehci, "applying AMD SB600/SB700 USB "
189                                         "freeze workaround\n");
190                                 pci_read_config_byte(pdev, 0x53, &tmp);
191                                 pci_write_config_byte(pdev, 0x53, tmp | (1<<3));
192                         }
193                         pci_dev_put(p_smbus);
194                 }
195                 break;
196         }
197
198         ehci_reset(ehci);
199
200         /* at least the Genesys GL880S needs fixup here */
201         temp = HCS_N_CC(ehci->hcs_params) * HCS_N_PCC(ehci->hcs_params);
202         temp &= 0x0f;
203         if (temp && HCS_N_PORTS(ehci->hcs_params) > temp) {
204                 ehci_dbg(ehci, "bogus port configuration: "
205                         "cc=%d x pcc=%d < ports=%d\n",
206                         HCS_N_CC(ehci->hcs_params),
207                         HCS_N_PCC(ehci->hcs_params),
208                         HCS_N_PORTS(ehci->hcs_params));
209
210                 switch (pdev->vendor) {
211                 case 0x17a0:            /* GENESYS */
212                         /* GL880S: should be PORTS=2 */
213                         temp |= (ehci->hcs_params & ~0xf);
214                         ehci->hcs_params = temp;
215                         break;
216                 case PCI_VENDOR_ID_NVIDIA:
217                         /* NF4: should be PCC=10 */
218                         break;
219                 }
220         }
221
222         /* Serial Bus Release Number is at PCI 0x60 offset */
223         pci_read_config_byte(pdev, 0x60, &ehci->sbrn);
224
225         /* Keep this around for a while just in case some EHCI
226          * implementation uses legacy PCI PM support.  This test
227          * can be removed on 17 Dec 2009 if the dev_warn() hasn't
228          * been triggered by then.
229          */
230         if (!device_can_wakeup(&pdev->dev)) {
231                 u16     port_wake;
232
233                 pci_read_config_word(pdev, 0x62, &port_wake);
234                 if (port_wake & 0x0001) {
235                         dev_warn(&pdev->dev, "Enabling legacy PCI PM\n");
236                         device_set_wakeup_capable(&pdev->dev, 1);
237                 }
238         }
239
240 #ifdef  CONFIG_USB_SUSPEND
241         /* REVISIT: the controller works fine for wakeup iff the root hub
242          * itself is "globally" suspended, but usbcore currently doesn't
243          * understand such things.
244          *
245          * System suspend currently expects to be able to suspend the entire
246          * device tree, device-at-a-time.  If we failed selective suspend
247          * reports, system suspend would fail; so the root hub code must claim
248          * success.  That's lying to usbcore, and it matters for runtime
249          * PM scenarios with selective suspend and remote wakeup...
250          */
251         if (ehci->no_selective_suspend && device_can_wakeup(&pdev->dev))
252                 ehci_warn(ehci, "selective suspend/wakeup unavailable\n");
253 #endif
254
255         ehci_port_power(ehci, 1);
256         retval = ehci_pci_reinit(ehci, pdev);
257 done:
258         return retval;
259 }
260
261 /*-------------------------------------------------------------------------*/
262
263 #ifdef  CONFIG_PM
264
265 /* suspend/resume, section 4.3 */
266
267 /* These routines rely on the PCI bus glue
268  * to handle powerdown and wakeup, and currently also on
269  * transceivers that don't need any software attention to set up
270  * the right sort of wakeup.
271  * Also they depend on separate root hub suspend/resume.
272  */
273
274 static int ehci_pci_suspend(struct usb_hcd *hcd)
275 {
276         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
277         unsigned long           flags;
278         int                     rc = 0;
279
280         if (time_before(jiffies, ehci->next_statechange))
281                 msleep(10);
282
283         /* Root hub was already suspended. Disable irq emission and
284          * mark HW unaccessible, bail out if RH has been resumed. Use
285          * the spinlock to properly synchronize with possible pending
286          * RH suspend or resume activity.
287          *
288          * This is still racy as hcd->state is manipulated outside of
289          * any locks =P But that will be a different fix.
290          */
291         spin_lock_irqsave (&ehci->lock, flags);
292         if (hcd->state != HC_STATE_SUSPENDED) {
293                 rc = -EINVAL;
294                 goto bail;
295         }
296         ehci_writel(ehci, 0, &ehci->regs->intr_enable);
297         (void)ehci_readl(ehci, &ehci->regs->intr_enable);
298
299         clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
300  bail:
301         spin_unlock_irqrestore (&ehci->lock, flags);
302
303         // could save FLADJ in case of Vaux power loss
304         // ... we'd only use it to handle clock skew
305
306         return rc;
307 }
308
309 static int ehci_pci_resume(struct usb_hcd *hcd, bool hibernated)
310 {
311         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
312         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
313
314         // maybe restore FLADJ
315
316         if (time_before(jiffies, ehci->next_statechange))
317                 msleep(100);
318
319         /* Mark hardware accessible again as we are out of D3 state by now */
320         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
321
322         /* If CF is still set and we aren't resuming from hibernation
323          * then we maintained PCI Vaux power.
324          * Just undo the effect of ehci_pci_suspend().
325          */
326         if (ehci_readl(ehci, &ehci->regs->configured_flag) == FLAG_CF &&
327                                 !hibernated) {
328                 int     mask = INTR_MASK;
329
330                 if (!hcd->self.root_hub->do_remote_wakeup)
331                         mask &= ~STS_PCD;
332                 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
333                 ehci_readl(ehci, &ehci->regs->intr_enable);
334                 return 0;
335         }
336
337         usb_root_hub_lost_power(hcd->self.root_hub);
338
339         /* Else reset, to cope with power loss or flush-to-storage
340          * style "resume" having let BIOS kick in during reboot.
341          */
342         (void) ehci_halt(ehci);
343         (void) ehci_reset(ehci);
344         (void) ehci_pci_reinit(ehci, pdev);
345
346         /* emptying the schedule aborts any urbs */
347         spin_lock_irq(&ehci->lock);
348         if (ehci->reclaim)
349                 end_unlink_async(ehci);
350         ehci_work(ehci);
351         spin_unlock_irq(&ehci->lock);
352
353         ehci_writel(ehci, ehci->command, &ehci->regs->command);
354         ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
355         ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
356
357         /* here we "know" root ports should always stay powered */
358         ehci_port_power(ehci, 1);
359
360         hcd->state = HC_STATE_SUSPENDED;
361         return 0;
362 }
363 #endif
364
365 static const struct hc_driver ehci_pci_hc_driver = {
366         .description =          hcd_name,
367         .product_desc =         "EHCI Host Controller",
368         .hcd_priv_size =        sizeof(struct ehci_hcd),
369
370         /*
371          * generic hardware linkage
372          */
373         .irq =                  ehci_irq,
374         .flags =                HCD_MEMORY | HCD_USB2,
375
376         /*
377          * basic lifecycle operations
378          */
379         .reset =                ehci_pci_setup,
380         .start =                ehci_run,
381 #ifdef  CONFIG_PM
382         .pci_suspend =          ehci_pci_suspend,
383         .pci_resume =           ehci_pci_resume,
384 #endif
385         .stop =                 ehci_stop,
386         .shutdown =             ehci_shutdown,
387
388         /*
389          * managing i/o requests and associated device resources
390          */
391         .urb_enqueue =          ehci_urb_enqueue,
392         .urb_dequeue =          ehci_urb_dequeue,
393         .endpoint_disable =     ehci_endpoint_disable,
394         .endpoint_reset =       ehci_endpoint_reset,
395
396         /*
397          * scheduling support
398          */
399         .get_frame_number =     ehci_get_frame,
400
401         /*
402          * root hub support
403          */
404         .hub_status_data =      ehci_hub_status_data,
405         .hub_control =          ehci_hub_control,
406         .bus_suspend =          ehci_bus_suspend,
407         .bus_resume =           ehci_bus_resume,
408         .relinquish_port =      ehci_relinquish_port,
409         .port_handed_over =     ehci_port_handed_over,
410
411         .clear_tt_buffer_complete       = ehci_clear_tt_buffer_complete,
412 };
413
414 /*-------------------------------------------------------------------------*/
415
416 /* PCI driver selection metadata; PCI hotplugging uses this */
417 static const struct pci_device_id pci_ids [] = { {
418         /* handle any USB 2.0 EHCI controller */
419         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_EHCI, ~0),
420         .driver_data =  (unsigned long) &ehci_pci_hc_driver,
421         },
422         { /* end: all zeroes */ }
423 };
424 MODULE_DEVICE_TABLE(pci, pci_ids);
425
426 /* pci driver glue; this is a "new style" PCI driver module */
427 static struct pci_driver ehci_pci_driver = {
428         .name =         (char *) hcd_name,
429         .id_table =     pci_ids,
430
431         .probe =        usb_hcd_pci_probe,
432         .remove =       usb_hcd_pci_remove,
433         .shutdown =     usb_hcd_pci_shutdown,
434
435 #ifdef CONFIG_PM_SLEEP
436         .driver =       {
437                 .pm =   &usb_hcd_pci_pm_ops
438         },
439 #endif
440 };