[BNX2]: Use msleep().
[linux-2.6] / 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         ehci_port_power(ehci, 0);
62
63         return 0;
64 }
65
66 /* called during probe() after chip reset completes */
67 static int ehci_pci_setup(struct usb_hcd *hcd)
68 {
69         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
70         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
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_31BIT_MASK) < 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_TDI:
133                 if (pdev->device == PCI_DEVICE_ID_TDI_EHCI) {
134                         ehci->is_tdi_rh_tt = 1;
135                         tdi_reset(ehci);
136                 }
137                 break;
138         case PCI_VENDOR_ID_AMD:
139                 /* AMD8111 EHCI doesn't work, according to AMD errata */
140                 if (pdev->device == 0x7463) {
141                         ehci_info(ehci, "ignoring AMD8111 (errata)\n");
142                         retval = -EIO;
143                         goto done;
144                 }
145                 break;
146         case PCI_VENDOR_ID_NVIDIA:
147                 switch (pdev->device) {
148                 /* Some NForce2 chips have problems with selective suspend;
149                  * fixed in newer silicon.
150                  */
151                 case 0x0068:
152                         if (pdev->revision < 0xa4)
153                                 ehci->no_selective_suspend = 1;
154                         break;
155                 }
156                 break;
157         }
158
159         if (ehci_is_TDI(ehci))
160                 ehci_reset(ehci);
161
162         /* at least the Genesys GL880S needs fixup here */
163         temp = HCS_N_CC(ehci->hcs_params) * HCS_N_PCC(ehci->hcs_params);
164         temp &= 0x0f;
165         if (temp && HCS_N_PORTS(ehci->hcs_params) > temp) {
166                 ehci_dbg(ehci, "bogus port configuration: "
167                         "cc=%d x pcc=%d < ports=%d\n",
168                         HCS_N_CC(ehci->hcs_params),
169                         HCS_N_PCC(ehci->hcs_params),
170                         HCS_N_PORTS(ehci->hcs_params));
171
172                 switch (pdev->vendor) {
173                 case 0x17a0:            /* GENESYS */
174                         /* GL880S: should be PORTS=2 */
175                         temp |= (ehci->hcs_params & ~0xf);
176                         ehci->hcs_params = temp;
177                         break;
178                 case PCI_VENDOR_ID_NVIDIA:
179                         /* NF4: should be PCC=10 */
180                         break;
181                 }
182         }
183
184         /* Serial Bus Release Number is at PCI 0x60 offset */
185         pci_read_config_byte(pdev, 0x60, &ehci->sbrn);
186
187         /* Workaround current PCI init glitch:  wakeup bits aren't
188          * being set from PCI PM capability.
189          */
190         if (!device_can_wakeup(&pdev->dev)) {
191                 u16     port_wake;
192
193                 pci_read_config_word(pdev, 0x62, &port_wake);
194                 if (port_wake & 0x0001)
195                         device_init_wakeup(&pdev->dev, 1);
196         }
197
198 #ifdef  CONFIG_USB_SUSPEND
199         /* REVISIT: the controller works fine for wakeup iff the root hub
200          * itself is "globally" suspended, but usbcore currently doesn't
201          * understand such things.
202          *
203          * System suspend currently expects to be able to suspend the entire
204          * device tree, device-at-a-time.  If we failed selective suspend
205          * reports, system suspend would fail; so the root hub code must claim
206          * success.  That's lying to usbcore, and it matters for for runtime
207          * PM scenarios with selective suspend and remote wakeup...
208          */
209         if (ehci->no_selective_suspend && device_can_wakeup(&pdev->dev))
210                 ehci_warn(ehci, "selective suspend/wakeup unavailable\n");
211 #endif
212
213         retval = ehci_pci_reinit(ehci, pdev);
214 done:
215         return retval;
216 }
217
218 /*-------------------------------------------------------------------------*/
219
220 #ifdef  CONFIG_PM
221
222 /* suspend/resume, section 4.3 */
223
224 /* These routines rely on the PCI bus glue
225  * to handle powerdown and wakeup, and currently also on
226  * transceivers that don't need any software attention to set up
227  * the right sort of wakeup.
228  * Also they depend on separate root hub suspend/resume.
229  */
230
231 static int ehci_pci_suspend(struct usb_hcd *hcd, pm_message_t message)
232 {
233         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
234         unsigned long           flags;
235         int                     rc = 0;
236
237         if (time_before(jiffies, ehci->next_statechange))
238                 msleep(10);
239
240         /* Root hub was already suspended. Disable irq emission and
241          * mark HW unaccessible, bail out if RH has been resumed. Use
242          * the spinlock to properly synchronize with possible pending
243          * RH suspend or resume activity.
244          *
245          * This is still racy as hcd->state is manipulated outside of
246          * any locks =P But that will be a different fix.
247          */
248         spin_lock_irqsave (&ehci->lock, flags);
249         if (hcd->state != HC_STATE_SUSPENDED) {
250                 rc = -EINVAL;
251                 goto bail;
252         }
253         ehci_writel(ehci, 0, &ehci->regs->intr_enable);
254         (void)ehci_readl(ehci, &ehci->regs->intr_enable);
255
256         /* make sure snapshot being resumed re-enumerates everything */
257         if (message.event == PM_EVENT_PRETHAW) {
258                 ehci_halt(ehci);
259                 ehci_reset(ehci);
260         }
261
262         clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
263  bail:
264         spin_unlock_irqrestore (&ehci->lock, flags);
265
266         // could save FLADJ in case of Vaux power loss
267         // ... we'd only use it to handle clock skew
268
269         return rc;
270 }
271
272 static int ehci_pci_resume(struct usb_hcd *hcd)
273 {
274         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
275         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
276
277         // maybe restore FLADJ
278
279         if (time_before(jiffies, ehci->next_statechange))
280                 msleep(100);
281
282         /* Mark hardware accessible again as we are out of D3 state by now */
283         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
284
285         /* If CF is still set, we maintained PCI Vaux power.
286          * Just undo the effect of ehci_pci_suspend().
287          */
288         if (ehci_readl(ehci, &ehci->regs->configured_flag) == FLAG_CF) {
289                 int     mask = INTR_MASK;
290
291                 if (!device_may_wakeup(&hcd->self.root_hub->dev))
292                         mask &= ~STS_PCD;
293                 ehci_writel(ehci, mask, &ehci->regs->intr_enable);
294                 ehci_readl(ehci, &ehci->regs->intr_enable);
295                 return 0;
296         }
297
298         ehci_dbg(ehci, "lost power, restarting\n");
299         usb_root_hub_lost_power(hcd->self.root_hub);
300
301         /* Else reset, to cope with power loss or flush-to-storage
302          * style "resume" having let BIOS kick in during reboot.
303          */
304         (void) ehci_halt(ehci);
305         (void) ehci_reset(ehci);
306         (void) ehci_pci_reinit(ehci, pdev);
307
308         /* emptying the schedule aborts any urbs */
309         spin_lock_irq(&ehci->lock);
310         if (ehci->reclaim)
311                 ehci->reclaim_ready = 1;
312         ehci_work(ehci);
313         spin_unlock_irq(&ehci->lock);
314
315         ehci_writel(ehci, ehci->command, &ehci->regs->command);
316         ehci_writel(ehci, FLAG_CF, &ehci->regs->configured_flag);
317         ehci_readl(ehci, &ehci->regs->command); /* unblock posted writes */
318
319         /* here we "know" root ports should always stay powered */
320         ehci_port_power(ehci, 1);
321         ehci_handover_companion_ports(ehci);
322
323         hcd->state = HC_STATE_SUSPENDED;
324         return 0;
325 }
326 #endif
327
328 static const struct hc_driver ehci_pci_hc_driver = {
329         .description =          hcd_name,
330         .product_desc =         "EHCI Host Controller",
331         .hcd_priv_size =        sizeof(struct ehci_hcd),
332
333         /*
334          * generic hardware linkage
335          */
336         .irq =                  ehci_irq,
337         .flags =                HCD_MEMORY | HCD_USB2,
338
339         /*
340          * basic lifecycle operations
341          */
342         .reset =                ehci_pci_setup,
343         .start =                ehci_run,
344 #ifdef  CONFIG_PM
345         .suspend =              ehci_pci_suspend,
346         .resume =               ehci_pci_resume,
347 #endif
348         .stop =                 ehci_stop,
349         .shutdown =             ehci_shutdown,
350
351         /*
352          * managing i/o requests and associated device resources
353          */
354         .urb_enqueue =          ehci_urb_enqueue,
355         .urb_dequeue =          ehci_urb_dequeue,
356         .endpoint_disable =     ehci_endpoint_disable,
357
358         /*
359          * scheduling support
360          */
361         .get_frame_number =     ehci_get_frame,
362
363         /*
364          * root hub support
365          */
366         .hub_status_data =      ehci_hub_status_data,
367         .hub_control =          ehci_hub_control,
368         .bus_suspend =          ehci_bus_suspend,
369         .bus_resume =           ehci_bus_resume,
370 };
371
372 /*-------------------------------------------------------------------------*/
373
374 /* PCI driver selection metadata; PCI hotplugging uses this */
375 static const struct pci_device_id pci_ids [] = { {
376         /* handle any USB 2.0 EHCI controller */
377         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_EHCI, ~0),
378         .driver_data =  (unsigned long) &ehci_pci_hc_driver,
379         },
380         { /* end: all zeroes */ }
381 };
382 MODULE_DEVICE_TABLE(pci, pci_ids);
383
384 /* pci driver glue; this is a "new style" PCI driver module */
385 static struct pci_driver ehci_pci_driver = {
386         .name =         (char *) hcd_name,
387         .id_table =     pci_ids,
388
389         .probe =        usb_hcd_pci_probe,
390         .remove =       usb_hcd_pci_remove,
391
392 #ifdef  CONFIG_PM
393         .suspend =      usb_hcd_pci_suspend,
394         .resume =       usb_hcd_pci_resume,
395 #endif
396         .shutdown =     usb_hcd_pci_shutdown,
397 };