[PATCH] USB: Fix USB suspend/resume crasher (#2)
[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 /* EHCI 0.96 (and later) section 5.1 says how to kick BIOS/SMM/...
28  * off the controller (maybe it can boot from highspeed USB disks).
29  */
30 static int bios_handoff(struct ehci_hcd *ehci, int where, u32 cap)
31 {
32         struct pci_dev *pdev = to_pci_dev(ehci_to_hcd(ehci)->self.controller);
33
34         /* always say Linux will own the hardware */
35         pci_write_config_byte(pdev, where + 3, 1);
36
37         /* maybe wait a while for BIOS to respond */
38         if (cap & (1 << 16)) {
39                 int msec = 5000;
40
41                 do {
42                         msleep(10);
43                         msec -= 10;
44                         pci_read_config_dword(pdev, where, &cap);
45                 } while ((cap & (1 << 16)) && msec);
46                 if (cap & (1 << 16)) {
47                         ehci_err(ehci, "BIOS handoff failed (%d, %08x)\n",
48                                 where, cap);
49                         // some BIOS versions seem buggy...
50                         // return 1;
51                         ehci_warn(ehci, "continuing after BIOS bug...\n");
52                         /* disable all SMIs, and clear "BIOS owns" flag */
53                         pci_write_config_dword(pdev, where + 4, 0);
54                         pci_write_config_byte(pdev, where + 2, 0);
55                 } else
56                         ehci_dbg(ehci, "BIOS handoff succeeded\n");
57         }
58         return 0;
59 }
60
61 /* called after powerup, by probe or system-pm "wakeup" */
62 static int ehci_pci_reinit(struct ehci_hcd *ehci, struct pci_dev *pdev)
63 {
64         u32                     temp;
65         int                     retval;
66         unsigned                count = 256/4;
67
68         /* optional debug port, normally in the first BAR */
69         temp = pci_find_capability(pdev, 0x0a);
70         if (temp) {
71                 pci_read_config_dword(pdev, temp, &temp);
72                 temp >>= 16;
73                 if ((temp & (3 << 13)) == (1 << 13)) {
74                         temp &= 0x1fff;
75                         ehci->debug = ehci_to_hcd(ehci)->regs + temp;
76                         temp = readl(&ehci->debug->control);
77                         ehci_info(ehci, "debug port %d%s\n",
78                                 HCS_DEBUG_PORT(ehci->hcs_params),
79                                 (temp & DBGP_ENABLED)
80                                         ? " IN USE"
81                                         : "");
82                         if (!(temp & DBGP_ENABLED))
83                                 ehci->debug = NULL;
84                 }
85         }
86
87         temp = HCC_EXT_CAPS(readl(&ehci->caps->hcc_params));
88
89         /* EHCI 0.96 and later may have "extended capabilities" */
90         while (temp && count--) {
91                 u32             cap;
92
93                 pci_read_config_dword(pdev, temp, &cap);
94                 ehci_dbg(ehci, "capability %04x at %02x\n", cap, temp);
95                 switch (cap & 0xff) {
96                 case 1:                 /* BIOS/SMM/... handoff */
97                         if (bios_handoff(ehci, temp, cap) != 0)
98                                 return -EOPNOTSUPP;
99                         break;
100                 case 0:                 /* illegal reserved capability */
101                         ehci_dbg(ehci, "illegal capability!\n");
102                         cap = 0;
103                         /* FALLTHROUGH */
104                 default:                /* unknown */
105                         break;
106                 }
107                 temp = (cap >> 8) & 0xff;
108         }
109         if (!count) {
110                 ehci_err(ehci, "bogus capabilities ... PCI problems!\n");
111                 return -EIO;
112         }
113
114         /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
115         retval = pci_set_mwi(pdev);
116         if (!retval)
117                 ehci_dbg(ehci, "MWI active\n");
118
119         ehci_port_power(ehci, 0);
120
121         return 0;
122 }
123
124 /* called by khubd or root hub (re)init threads; leaves HC in halt state */
125 static int ehci_pci_reset(struct usb_hcd *hcd)
126 {
127         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
128         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
129         u32                     temp;
130         int                     retval;
131
132         ehci->caps = hcd->regs;
133         ehci->regs = hcd->regs + HC_LENGTH(readl(&ehci->caps->hc_capbase));
134         dbg_hcs_params(ehci, "reset");
135         dbg_hcc_params(ehci, "reset");
136
137         /* cache this readonly data; minimize chip reads */
138         ehci->hcs_params = readl(&ehci->caps->hcs_params);
139
140         retval = ehci_halt(ehci);
141         if (retval)
142                 return retval;
143
144         /* NOTE:  only the parts below this line are PCI-specific */
145
146         switch (pdev->vendor) {
147         case PCI_VENDOR_ID_TDI:
148                 if (pdev->device == PCI_DEVICE_ID_TDI_EHCI) {
149                         ehci->is_tdi_rh_tt = 1;
150                         tdi_reset(ehci);
151                 }
152                 break;
153         case PCI_VENDOR_ID_AMD:
154                 /* AMD8111 EHCI doesn't work, according to AMD errata */
155                 if (pdev->device == 0x7463) {
156                         ehci_info(ehci, "ignoring AMD8111 (errata)\n");
157                         return -EIO;
158                 }
159                 break;
160         case PCI_VENDOR_ID_NVIDIA:
161                 /* NVidia reports that certain chips don't handle
162                  * QH, ITD, or SITD addresses above 2GB.  (But TD,
163                  * data buffer, and periodic schedule are normal.)
164                  */
165                 switch (pdev->device) {
166                 case 0x003c:    /* MCP04 */
167                 case 0x005b:    /* CK804 */
168                 case 0x00d8:    /* CK8 */
169                 case 0x00e8:    /* CK8S */
170                         if (pci_set_consistent_dma_mask(pdev,
171                                                 DMA_31BIT_MASK) < 0)
172                                 ehci_warn(ehci, "can't enable NVidia "
173                                         "workaround for >2GB RAM\n");
174                         break;
175                 }
176                 break;
177         }
178
179         if (ehci_is_TDI(ehci))
180                 ehci_reset(ehci);
181
182         /* at least the Genesys GL880S needs fixup here */
183         temp = HCS_N_CC(ehci->hcs_params) * HCS_N_PCC(ehci->hcs_params);
184         temp &= 0x0f;
185         if (temp && HCS_N_PORTS(ehci->hcs_params) > temp) {
186                 ehci_dbg(ehci, "bogus port configuration: "
187                         "cc=%d x pcc=%d < ports=%d\n",
188                         HCS_N_CC(ehci->hcs_params),
189                         HCS_N_PCC(ehci->hcs_params),
190                         HCS_N_PORTS(ehci->hcs_params));
191
192                 switch (pdev->vendor) {
193                 case 0x17a0:            /* GENESYS */
194                         /* GL880S: should be PORTS=2 */
195                         temp |= (ehci->hcs_params & ~0xf);
196                         ehci->hcs_params = temp;
197                         break;
198                 case PCI_VENDOR_ID_NVIDIA:
199                         /* NF4: should be PCC=10 */
200                         break;
201                 }
202         }
203
204         /* Serial Bus Release Number is at PCI 0x60 offset */
205         pci_read_config_byte(pdev, 0x60, &ehci->sbrn);
206
207         /* REVISIT:  per-port wake capability (PCI 0x62) currently unused */
208
209         retval = ehci_pci_reinit(ehci, pdev);
210
211         /* finish init */
212         return ehci_init(hcd);
213 }
214
215 /*-------------------------------------------------------------------------*/
216
217 #ifdef  CONFIG_PM
218
219 /* suspend/resume, section 4.3 */
220
221 /* These routines rely on the PCI bus glue
222  * to handle powerdown and wakeup, and currently also on
223  * transceivers that don't need any software attention to set up
224  * the right sort of wakeup.
225  * Also they depend on separate root hub suspend/resume.
226  */
227
228 static int ehci_pci_suspend(struct usb_hcd *hcd, pm_message_t message)
229 {
230         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
231         unsigned long           flags;
232         int                     rc = 0;
233
234         if (time_before(jiffies, ehci->next_statechange))
235                 msleep(10);
236
237         /* Root hub was already suspended. Disable irq emission and
238          * mark HW unaccessible, bail out if RH has been resumed. Use
239          * the spinlock to properly synchronize with possible pending
240          * RH suspend or resume activity.
241          *
242          * This is still racy as hcd->state is manipulated outside of
243          * any locks =P But that will be a different fix.
244          */
245         spin_lock_irqsave (&ehci->lock, flags);
246         if (hcd->state != HC_STATE_SUSPENDED) {
247                 rc = -EINVAL;
248                 goto bail;
249         }
250         writel (0, &ehci->regs->intr_enable);
251         (void)readl(&ehci->regs->intr_enable);
252
253         clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
254  bail:
255         spin_unlock_irqrestore (&ehci->lock, flags);
256
257         // could save FLADJ in case of Vaux power loss
258         // ... we'd only use it to handle clock skew
259
260         return rc;
261 }
262
263 static int ehci_pci_resume(struct usb_hcd *hcd)
264 {
265         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
266         unsigned                port;
267         struct usb_device       *root = hcd->self.root_hub;
268         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
269         int                     retval = -EINVAL;
270
271         // maybe restore FLADJ
272
273         if (time_before(jiffies, ehci->next_statechange))
274                 msleep(100);
275
276         /* Mark hardware accessible again as we are out of D3 state by now */
277         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
278
279         /* If CF is clear, we lost PCI Vaux power and need to restart.  */
280         if (readl(&ehci->regs->configured_flag) != FLAG_CF)
281                 goto restart;
282
283         /* If any port is suspended (or owned by the companion),
284          * we know we can/must resume the HC (and mustn't reset it).
285          * We just defer that to the root hub code.
286          */
287         for (port = HCS_N_PORTS(ehci->hcs_params); port > 0; ) {
288                 u32     status;
289                 port--;
290                 status = readl(&ehci->regs->port_status [port]);
291                 if (!(status & PORT_POWER))
292                         continue;
293                 if (status & (PORT_SUSPEND | PORT_RESUME | PORT_OWNER)) {
294                         usb_hcd_resume_root_hub(hcd);
295                         return 0;
296                 }
297         }
298
299 restart:
300         ehci_dbg(ehci, "lost power, restarting\n");
301         for (port = HCS_N_PORTS(ehci->hcs_params); port > 0; ) {
302                 port--;
303                 if (!root->children [port])
304                         continue;
305                 usb_set_device_state(root->children[port],
306                                         USB_STATE_NOTATTACHED);
307         }
308
309         /* Else reset, to cope with power loss or flush-to-storage
310          * style "resume" having let BIOS kick in during reboot.
311          */
312         (void) ehci_halt(ehci);
313         (void) ehci_reset(ehci);
314         (void) ehci_pci_reinit(ehci, pdev);
315
316         /* emptying the schedule aborts any urbs */
317         spin_lock_irq(&ehci->lock);
318         if (ehci->reclaim)
319                 ehci->reclaim_ready = 1;
320         ehci_work(ehci, NULL);
321         spin_unlock_irq(&ehci->lock);
322
323         /* restart; khubd will disconnect devices */
324         retval = ehci_run(hcd);
325
326         /* here we "know" root ports should always stay powered */
327         ehci_port_power(ehci, 1);
328
329         return retval;
330 }
331 #endif
332
333 static const struct hc_driver ehci_pci_hc_driver = {
334         .description =          hcd_name,
335         .product_desc =         "EHCI Host Controller",
336         .hcd_priv_size =        sizeof(struct ehci_hcd),
337
338         /*
339          * generic hardware linkage
340          */
341         .irq =                  ehci_irq,
342         .flags =                HCD_MEMORY | HCD_USB2,
343
344         /*
345          * basic lifecycle operations
346          */
347         .reset =                ehci_pci_reset,
348         .start =                ehci_run,
349 #ifdef  CONFIG_PM
350         .suspend =              ehci_pci_suspend,
351         .resume =               ehci_pci_resume,
352 #endif
353         .stop =                 ehci_stop,
354
355         /*
356          * managing i/o requests and associated device resources
357          */
358         .urb_enqueue =          ehci_urb_enqueue,
359         .urb_dequeue =          ehci_urb_dequeue,
360         .endpoint_disable =     ehci_endpoint_disable,
361
362         /*
363          * scheduling support
364          */
365         .get_frame_number =     ehci_get_frame,
366
367         /*
368          * root hub support
369          */
370         .hub_status_data =      ehci_hub_status_data,
371         .hub_control =          ehci_hub_control,
372         .bus_suspend =          ehci_bus_suspend,
373         .bus_resume =           ehci_bus_resume,
374 };
375
376 /*-------------------------------------------------------------------------*/
377
378 /* PCI driver selection metadata; PCI hotplugging uses this */
379 static const struct pci_device_id pci_ids [] = { {
380         /* handle any USB 2.0 EHCI controller */
381         PCI_DEVICE_CLASS(((PCI_CLASS_SERIAL_USB << 8) | 0x20), ~0),
382         .driver_data =  (unsigned long) &ehci_pci_hc_driver,
383         },
384         { /* end: all zeroes */ }
385 };
386 MODULE_DEVICE_TABLE(pci, pci_ids);
387
388 /* pci driver glue; this is a "new style" PCI driver module */
389 static struct pci_driver ehci_pci_driver = {
390         .name =         (char *) hcd_name,
391         .id_table =     pci_ids,
392
393         .probe =        usb_hcd_pci_probe,
394         .remove =       usb_hcd_pci_remove,
395
396 #ifdef  CONFIG_PM
397         .suspend =      usb_hcd_pci_suspend,
398         .resume =       usb_hcd_pci_resume,
399 #endif
400 };
401
402 static int __init ehci_hcd_pci_init(void)
403 {
404         if (usb_disabled())
405                 return -ENODEV;
406
407         pr_debug("%s: block sizes: qh %Zd qtd %Zd itd %Zd sitd %Zd\n",
408                 hcd_name,
409                 sizeof(struct ehci_qh), sizeof(struct ehci_qtd),
410                 sizeof(struct ehci_itd), sizeof(struct ehci_sitd));
411
412         return pci_register_driver(&ehci_pci_driver);
413 }
414 module_init(ehci_hcd_pci_init);
415
416 static void __exit ehci_hcd_pci_cleanup(void)
417 {
418         pci_unregister_driver(&ehci_pci_driver);
419 }
420 module_exit(ehci_hcd_pci_cleanup);