Merge branch 'for-3.11' of git://linux-nfs.org/~bfields/linux
[linux-2.6.git] / drivers / usb / core / hcd-pci.c
blobcaeb8d6d39fbb8b2e93cb4a0e1cf9d5bd54c2a67
1 /*
2 * (C) Copyright David Brownell 2000-2002
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.
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.
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.
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/pci.h>
22 #include <linux/usb.h>
23 #include <linux/usb/hcd.h>
25 #include <asm/io.h>
26 #include <asm/irq.h>
28 #ifdef CONFIG_PPC_PMAC
29 #include <asm/machdep.h>
30 #include <asm/pmac_feature.h>
31 #include <asm/pci-bridge.h>
32 #include <asm/prom.h>
33 #endif
35 #include "usb.h"
38 /* PCI-based HCs are common, but plenty of non-PCI HCs are used too */
41 * Coordinate handoffs between EHCI and companion controllers
42 * during EHCI probing and system resume.
45 static DECLARE_RWSEM(companions_rwsem);
47 #define CL_UHCI PCI_CLASS_SERIAL_USB_UHCI
48 #define CL_OHCI PCI_CLASS_SERIAL_USB_OHCI
49 #define CL_EHCI PCI_CLASS_SERIAL_USB_EHCI
51 static inline int is_ohci_or_uhci(struct pci_dev *pdev)
53 return pdev->class == CL_OHCI || pdev->class == CL_UHCI;
56 typedef void (*companion_fn)(struct pci_dev *pdev, struct usb_hcd *hcd,
57 struct pci_dev *companion, struct usb_hcd *companion_hcd);
59 /* Iterate over PCI devices in the same slot as pdev and call fn for each */
60 static void for_each_companion(struct pci_dev *pdev, struct usb_hcd *hcd,
61 companion_fn fn)
63 struct pci_dev *companion;
64 struct usb_hcd *companion_hcd;
65 unsigned int slot = PCI_SLOT(pdev->devfn);
68 * Iterate through other PCI functions in the same slot.
69 * If the function's drvdata isn't set then it isn't bound to
70 * a USB host controller driver, so skip it.
72 companion = NULL;
73 for_each_pci_dev(companion) {
74 if (companion->bus != pdev->bus ||
75 PCI_SLOT(companion->devfn) != slot)
76 continue;
77 companion_hcd = pci_get_drvdata(companion);
78 if (!companion_hcd)
79 continue;
80 fn(pdev, hcd, companion, companion_hcd);
85 * We're about to add an EHCI controller, which will unceremoniously grab
86 * all the port connections away from its companions. To prevent annoying
87 * error messages, lock the companion's root hub and gracefully unconfigure
88 * it beforehand. Leave it locked until the EHCI controller is all set.
90 static void ehci_pre_add(struct pci_dev *pdev, struct usb_hcd *hcd,
91 struct pci_dev *companion, struct usb_hcd *companion_hcd)
93 struct usb_device *udev;
95 if (is_ohci_or_uhci(companion)) {
96 udev = companion_hcd->self.root_hub;
97 usb_lock_device(udev);
98 usb_set_configuration(udev, 0);
103 * Adding the EHCI controller has either succeeded or failed. Set the
104 * companion pointer accordingly, and in either case, reconfigure and
105 * unlock the root hub.
107 static void ehci_post_add(struct pci_dev *pdev, struct usb_hcd *hcd,
108 struct pci_dev *companion, struct usb_hcd *companion_hcd)
110 struct usb_device *udev;
112 if (is_ohci_or_uhci(companion)) {
113 if (dev_get_drvdata(&pdev->dev)) { /* Succeeded */
114 dev_dbg(&pdev->dev, "HS companion for %s\n",
115 dev_name(&companion->dev));
116 companion_hcd->self.hs_companion = &hcd->self;
118 udev = companion_hcd->self.root_hub;
119 usb_set_configuration(udev, 1);
120 usb_unlock_device(udev);
125 * We just added a non-EHCI controller. Find the EHCI controller to
126 * which it is a companion, and store a pointer to the bus structure.
128 static void non_ehci_add(struct pci_dev *pdev, struct usb_hcd *hcd,
129 struct pci_dev *companion, struct usb_hcd *companion_hcd)
131 if (is_ohci_or_uhci(pdev) && companion->class == CL_EHCI) {
132 dev_dbg(&pdev->dev, "FS/LS companion for %s\n",
133 dev_name(&companion->dev));
134 hcd->self.hs_companion = &companion_hcd->self;
138 /* We are removing an EHCI controller. Clear the companions' pointers. */
139 static void ehci_remove(struct pci_dev *pdev, struct usb_hcd *hcd,
140 struct pci_dev *companion, struct usb_hcd *companion_hcd)
142 if (is_ohci_or_uhci(companion))
143 companion_hcd->self.hs_companion = NULL;
146 #ifdef CONFIG_PM
148 /* An EHCI controller must wait for its companions before resuming. */
149 static void ehci_wait_for_companions(struct pci_dev *pdev, struct usb_hcd *hcd,
150 struct pci_dev *companion, struct usb_hcd *companion_hcd)
152 if (is_ohci_or_uhci(companion))
153 device_pm_wait_for_dev(&pdev->dev, &companion->dev);
156 #endif /* CONFIG_PM */
158 /*-------------------------------------------------------------------------*/
160 /* configure so an HC device and id are always provided */
161 /* always called with process context; sleeping is OK */
164 * usb_hcd_pci_probe - initialize PCI-based HCDs
165 * @dev: USB Host Controller being probed
166 * @id: pci hotplug id connecting controller to HCD framework
167 * Context: !in_interrupt()
169 * Allocates basic PCI resources for this USB host controller, and
170 * then invokes the start() method for the HCD associated with it
171 * through the hotplug entry's driver_data.
173 * Store this function in the HCD's struct pci_driver as probe().
175 int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
177 struct hc_driver *driver;
178 struct usb_hcd *hcd;
179 int retval;
180 int hcd_irq = 0;
182 if (usb_disabled())
183 return -ENODEV;
185 if (!id)
186 return -EINVAL;
187 driver = (struct hc_driver *)id->driver_data;
188 if (!driver)
189 return -EINVAL;
191 if (pci_enable_device(dev) < 0)
192 return -ENODEV;
193 dev->current_state = PCI_D0;
196 * The xHCI driver has its own irq management
197 * make sure irq setup is not touched for xhci in generic hcd code
199 if ((driver->flags & HCD_MASK) != HCD_USB3) {
200 if (!dev->irq) {
201 dev_err(&dev->dev,
202 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
203 pci_name(dev));
204 retval = -ENODEV;
205 goto disable_pci;
207 hcd_irq = dev->irq;
210 hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
211 if (!hcd) {
212 retval = -ENOMEM;
213 goto disable_pci;
216 if (driver->flags & HCD_MEMORY) {
217 /* EHCI, OHCI */
218 hcd->rsrc_start = pci_resource_start(dev, 0);
219 hcd->rsrc_len = pci_resource_len(dev, 0);
220 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
221 driver->description)) {
222 dev_dbg(&dev->dev, "controller already in use\n");
223 retval = -EBUSY;
224 goto put_hcd;
226 hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
227 if (hcd->regs == NULL) {
228 dev_dbg(&dev->dev, "error mapping memory\n");
229 retval = -EFAULT;
230 goto release_mem_region;
233 } else {
234 /* UHCI */
235 int region;
237 for (region = 0; region < PCI_ROM_RESOURCE; region++) {
238 if (!(pci_resource_flags(dev, region) &
239 IORESOURCE_IO))
240 continue;
242 hcd->rsrc_start = pci_resource_start(dev, region);
243 hcd->rsrc_len = pci_resource_len(dev, region);
244 if (request_region(hcd->rsrc_start, hcd->rsrc_len,
245 driver->description))
246 break;
248 if (region == PCI_ROM_RESOURCE) {
249 dev_dbg(&dev->dev, "no i/o regions available\n");
250 retval = -EBUSY;
251 goto put_hcd;
255 pci_set_master(dev);
257 /* Note: dev_set_drvdata must be called while holding the rwsem */
258 if (dev->class == CL_EHCI) {
259 down_write(&companions_rwsem);
260 dev_set_drvdata(&dev->dev, hcd);
261 for_each_companion(dev, hcd, ehci_pre_add);
262 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
263 if (retval != 0)
264 dev_set_drvdata(&dev->dev, NULL);
265 for_each_companion(dev, hcd, ehci_post_add);
266 up_write(&companions_rwsem);
267 } else {
268 down_read(&companions_rwsem);
269 dev_set_drvdata(&dev->dev, hcd);
270 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
271 if (retval != 0)
272 dev_set_drvdata(&dev->dev, NULL);
273 else
274 for_each_companion(dev, hcd, non_ehci_add);
275 up_read(&companions_rwsem);
278 if (retval != 0)
279 goto unmap_registers;
281 if (pci_dev_run_wake(dev))
282 pm_runtime_put_noidle(&dev->dev);
283 return retval;
285 unmap_registers:
286 if (driver->flags & HCD_MEMORY) {
287 iounmap(hcd->regs);
288 release_mem_region:
289 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
290 } else
291 release_region(hcd->rsrc_start, hcd->rsrc_len);
292 put_hcd:
293 usb_put_hcd(hcd);
294 disable_pci:
295 pci_disable_device(dev);
296 dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
297 return retval;
299 EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
302 /* may be called without controller electrically present */
303 /* may be called with controller, bus, and devices active */
306 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
307 * @dev: USB Host Controller being removed
308 * Context: !in_interrupt()
310 * Reverses the effect of usb_hcd_pci_probe(), first invoking
311 * the HCD's stop() method. It is always called from a thread
312 * context, normally "rmmod", "apmd", or something similar.
314 * Store this function in the HCD's struct pci_driver as remove().
316 void usb_hcd_pci_remove(struct pci_dev *dev)
318 struct usb_hcd *hcd;
320 hcd = pci_get_drvdata(dev);
321 if (!hcd)
322 return;
324 if (pci_dev_run_wake(dev))
325 pm_runtime_get_noresume(&dev->dev);
327 /* Fake an interrupt request in order to give the driver a chance
328 * to test whether the controller hardware has been removed (e.g.,
329 * cardbus physical eject).
331 local_irq_disable();
332 usb_hcd_irq(0, hcd);
333 local_irq_enable();
335 /* Note: dev_set_drvdata must be called while holding the rwsem */
336 if (dev->class == CL_EHCI) {
337 down_write(&companions_rwsem);
338 for_each_companion(dev, hcd, ehci_remove);
339 usb_remove_hcd(hcd);
340 dev_set_drvdata(&dev->dev, NULL);
341 up_write(&companions_rwsem);
342 } else {
343 /* Not EHCI; just clear the companion pointer */
344 down_read(&companions_rwsem);
345 hcd->self.hs_companion = NULL;
346 usb_remove_hcd(hcd);
347 dev_set_drvdata(&dev->dev, NULL);
348 up_read(&companions_rwsem);
351 if (hcd->driver->flags & HCD_MEMORY) {
352 iounmap(hcd->regs);
353 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
354 } else {
355 release_region(hcd->rsrc_start, hcd->rsrc_len);
358 usb_put_hcd(hcd);
359 pci_disable_device(dev);
361 EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
364 * usb_hcd_pci_shutdown - shutdown host controller
365 * @dev: USB Host Controller being shutdown
367 void usb_hcd_pci_shutdown(struct pci_dev *dev)
369 struct usb_hcd *hcd;
371 hcd = pci_get_drvdata(dev);
372 if (!hcd)
373 return;
375 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
376 hcd->driver->shutdown) {
377 hcd->driver->shutdown(hcd);
378 pci_disable_device(dev);
381 EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
383 #ifdef CONFIG_PM
385 #ifdef CONFIG_PPC_PMAC
386 static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
388 /* Enanble or disable ASIC clocks for USB */
389 if (machine_is(powermac)) {
390 struct device_node *of_node;
392 of_node = pci_device_to_OF_node(pci_dev);
393 if (of_node)
394 pmac_call_feature(PMAC_FTR_USB_ENABLE,
395 of_node, 0, enable);
399 #else
401 static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
404 #endif /* CONFIG_PPC_PMAC */
406 static int check_root_hub_suspended(struct device *dev)
408 struct pci_dev *pci_dev = to_pci_dev(dev);
409 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
411 if (HCD_RH_RUNNING(hcd)) {
412 dev_warn(dev, "Root hub is not suspended\n");
413 return -EBUSY;
415 if (hcd->shared_hcd) {
416 hcd = hcd->shared_hcd;
417 if (HCD_RH_RUNNING(hcd)) {
418 dev_warn(dev, "Secondary root hub is not suspended\n");
419 return -EBUSY;
422 return 0;
425 #if defined(CONFIG_PM_SLEEP) || defined(CONFIG_PM_RUNTIME)
426 static int suspend_common(struct device *dev, bool do_wakeup)
428 struct pci_dev *pci_dev = to_pci_dev(dev);
429 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
430 int retval;
432 /* Root hub suspend should have stopped all downstream traffic,
433 * and all bus master traffic. And done so for both the interface
434 * and the stub usb_device (which we check here). But maybe it
435 * didn't; writing sysfs power/state files ignores such rules...
437 retval = check_root_hub_suspended(dev);
438 if (retval)
439 return retval;
441 if (hcd->driver->pci_suspend && !HCD_DEAD(hcd)) {
442 /* Optimization: Don't suspend if a root-hub wakeup is
443 * pending and it would cause the HCD to wake up anyway.
445 if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
446 return -EBUSY;
447 if (do_wakeup && hcd->shared_hcd &&
448 HCD_WAKEUP_PENDING(hcd->shared_hcd))
449 return -EBUSY;
450 retval = hcd->driver->pci_suspend(hcd, do_wakeup);
451 suspend_report_result(hcd->driver->pci_suspend, retval);
453 /* Check again in case wakeup raced with pci_suspend */
454 if ((retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) ||
455 (retval == 0 && do_wakeup && hcd->shared_hcd &&
456 HCD_WAKEUP_PENDING(hcd->shared_hcd))) {
457 if (hcd->driver->pci_resume)
458 hcd->driver->pci_resume(hcd, false);
459 retval = -EBUSY;
461 if (retval)
462 return retval;
465 /* If MSI-X is enabled, the driver will have synchronized all vectors
466 * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
467 * synchronized here.
469 if (!hcd->msix_enabled)
470 synchronize_irq(pci_dev->irq);
472 /* Downstream ports from this root hub should already be quiesced, so
473 * there will be no DMA activity. Now we can shut down the upstream
474 * link (except maybe for PME# resume signaling). We'll enter a
475 * low power state during suspend_noirq, if the hardware allows.
477 pci_disable_device(pci_dev);
478 return retval;
481 static int resume_common(struct device *dev, int event)
483 struct pci_dev *pci_dev = to_pci_dev(dev);
484 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
485 int retval;
487 if (HCD_RH_RUNNING(hcd) ||
488 (hcd->shared_hcd &&
489 HCD_RH_RUNNING(hcd->shared_hcd))) {
490 dev_dbg(dev, "can't resume, not suspended!\n");
491 return 0;
494 retval = pci_enable_device(pci_dev);
495 if (retval < 0) {
496 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
497 return retval;
500 pci_set_master(pci_dev);
502 if (hcd->driver->pci_resume && !HCD_DEAD(hcd)) {
505 * Only EHCI controllers have to wait for their companions.
506 * No locking is needed because PCI controller drivers do not
507 * get unbound during system resume.
509 if (pci_dev->class == CL_EHCI && event != PM_EVENT_AUTO_RESUME)
510 for_each_companion(pci_dev, hcd,
511 ehci_wait_for_companions);
513 retval = hcd->driver->pci_resume(hcd,
514 event == PM_EVENT_RESTORE);
515 if (retval) {
516 dev_err(dev, "PCI post-resume error %d!\n", retval);
517 if (hcd->shared_hcd)
518 usb_hc_died(hcd->shared_hcd);
519 usb_hc_died(hcd);
522 return retval;
524 #endif /* SLEEP || RUNTIME */
526 #ifdef CONFIG_PM_SLEEP
528 static int hcd_pci_suspend(struct device *dev)
530 return suspend_common(dev, device_may_wakeup(dev));
533 static int hcd_pci_suspend_noirq(struct device *dev)
535 struct pci_dev *pci_dev = to_pci_dev(dev);
536 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
537 int retval;
539 retval = check_root_hub_suspended(dev);
540 if (retval)
541 return retval;
543 pci_save_state(pci_dev);
545 /* If the root hub is dead rather than suspended, disallow remote
546 * wakeup. usb_hc_died() should ensure that both hosts are marked as
547 * dying, so we only need to check the primary roothub.
549 if (HCD_DEAD(hcd))
550 device_set_wakeup_enable(dev, 0);
551 dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
553 /* Possibly enable remote wakeup,
554 * choose the appropriate low-power state, and go to that state.
556 retval = pci_prepare_to_sleep(pci_dev);
557 if (retval == -EIO) { /* Low-power not supported */
558 dev_dbg(dev, "--> PCI D0 legacy\n");
559 retval = 0;
560 } else if (retval == 0) {
561 dev_dbg(dev, "--> PCI %s\n",
562 pci_power_name(pci_dev->current_state));
563 } else {
564 suspend_report_result(pci_prepare_to_sleep, retval);
565 return retval;
568 powermac_set_asic(pci_dev, 0);
569 return retval;
572 static int hcd_pci_resume_noirq(struct device *dev)
574 struct pci_dev *pci_dev = to_pci_dev(dev);
576 powermac_set_asic(pci_dev, 1);
578 /* Go back to D0 and disable remote wakeup */
579 pci_back_from_sleep(pci_dev);
580 return 0;
583 static int hcd_pci_resume(struct device *dev)
585 return resume_common(dev, PM_EVENT_RESUME);
588 static int hcd_pci_restore(struct device *dev)
590 return resume_common(dev, PM_EVENT_RESTORE);
593 #else
595 #define hcd_pci_suspend NULL
596 #define hcd_pci_suspend_noirq NULL
597 #define hcd_pci_resume_noirq NULL
598 #define hcd_pci_resume NULL
599 #define hcd_pci_restore NULL
601 #endif /* CONFIG_PM_SLEEP */
603 #ifdef CONFIG_PM_RUNTIME
605 static int hcd_pci_runtime_suspend(struct device *dev)
607 int retval;
609 retval = suspend_common(dev, true);
610 if (retval == 0)
611 powermac_set_asic(to_pci_dev(dev), 0);
612 dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
613 return retval;
616 static int hcd_pci_runtime_resume(struct device *dev)
618 int retval;
620 powermac_set_asic(to_pci_dev(dev), 1);
621 retval = resume_common(dev, PM_EVENT_AUTO_RESUME);
622 dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
623 return retval;
626 #else
628 #define hcd_pci_runtime_suspend NULL
629 #define hcd_pci_runtime_resume NULL
631 #endif /* CONFIG_PM_RUNTIME */
633 const struct dev_pm_ops usb_hcd_pci_pm_ops = {
634 .suspend = hcd_pci_suspend,
635 .suspend_noirq = hcd_pci_suspend_noirq,
636 .resume_noirq = hcd_pci_resume_noirq,
637 .resume = hcd_pci_resume,
638 .freeze = check_root_hub_suspended,
639 .freeze_noirq = check_root_hub_suspended,
640 .thaw_noirq = NULL,
641 .thaw = NULL,
642 .poweroff = hcd_pci_suspend,
643 .poweroff_noirq = hcd_pci_suspend_noirq,
644 .restore_noirq = hcd_pci_resume_noirq,
645 .restore = hcd_pci_restore,
646 .runtime_suspend = hcd_pci_runtime_suspend,
647 .runtime_resume = hcd_pci_runtime_resume,
649 EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
651 #endif /* CONFIG_PM */