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
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>
28 #ifdef CONFIG_PPC_PMAC
29 #include <asm/machdep.h>
30 #include <asm/pmac_feature.h>
37 /* PCI-based HCs are common, but plenty of non-PCI HCs are used too */
40 * Coordinate handoffs between EHCI and companion controllers
41 * during EHCI probing and system resume.
44 static DECLARE_RWSEM(companions_rwsem);
46 #define CL_UHCI PCI_CLASS_SERIAL_USB_UHCI
47 #define CL_OHCI PCI_CLASS_SERIAL_USB_OHCI
48 #define CL_EHCI PCI_CLASS_SERIAL_USB_EHCI
50 static inline int is_ohci_or_uhci(struct pci_dev *pdev)
52 return pdev->class == CL_OHCI || pdev->class == CL_UHCI;
55 typedef void (*companion_fn)(struct pci_dev *pdev, struct usb_hcd *hcd,
56 struct pci_dev *companion, struct usb_hcd *companion_hcd);
58 /* Iterate over PCI devices in the same slot as pdev and call fn for each */
59 static void for_each_companion(struct pci_dev *pdev, struct usb_hcd *hcd,
62 struct pci_dev *companion;
63 struct usb_hcd *companion_hcd;
64 unsigned int slot = PCI_SLOT(pdev->devfn);
67 * Iterate through other PCI functions in the same slot.
68 * If the function's drvdata isn't set then it isn't bound to
69 * a USB host controller driver, so skip it.
72 for_each_pci_dev(companion) {
73 if (companion->bus != pdev->bus ||
74 PCI_SLOT(companion->devfn) != slot)
76 companion_hcd = pci_get_drvdata(companion);
77 if (!companion_hcd || !companion_hcd->self.root_hub)
79 fn(pdev, hcd, companion, companion_hcd);
84 * We're about to add an EHCI controller, which will unceremoniously grab
85 * all the port connections away from its companions. To prevent annoying
86 * error messages, lock the companion's root hub and gracefully unconfigure
87 * it beforehand. Leave it locked until the EHCI controller is all set.
89 static void ehci_pre_add(struct pci_dev *pdev, struct usb_hcd *hcd,
90 struct pci_dev *companion, struct usb_hcd *companion_hcd)
92 struct usb_device *udev;
94 if (is_ohci_or_uhci(companion)) {
95 udev = companion_hcd->self.root_hub;
96 usb_lock_device(udev);
97 usb_set_configuration(udev, 0);
102 * Adding the EHCI controller has either succeeded or failed. Set the
103 * companion pointer accordingly, and in either case, reconfigure and
104 * unlock the root hub.
106 static void ehci_post_add(struct pci_dev *pdev, struct usb_hcd *hcd,
107 struct pci_dev *companion, struct usb_hcd *companion_hcd)
109 struct usb_device *udev;
111 if (is_ohci_or_uhci(companion)) {
112 if (dev_get_drvdata(&pdev->dev)) { /* Succeeded */
113 dev_dbg(&pdev->dev, "HS companion for %s\n",
114 dev_name(&companion->dev));
115 companion_hcd->self.hs_companion = &hcd->self;
117 udev = companion_hcd->self.root_hub;
118 usb_set_configuration(udev, 1);
119 usb_unlock_device(udev);
124 * We just added a non-EHCI controller. Find the EHCI controller to
125 * which it is a companion, and store a pointer to the bus structure.
127 static void non_ehci_add(struct pci_dev *pdev, struct usb_hcd *hcd,
128 struct pci_dev *companion, struct usb_hcd *companion_hcd)
130 if (is_ohci_or_uhci(pdev) && companion->class == CL_EHCI) {
131 dev_dbg(&pdev->dev, "FS/LS companion for %s\n",
132 dev_name(&companion->dev));
133 hcd->self.hs_companion = &companion_hcd->self;
137 /* We are removing an EHCI controller. Clear the companions' pointers. */
138 static void ehci_remove(struct pci_dev *pdev, struct usb_hcd *hcd,
139 struct pci_dev *companion, struct usb_hcd *companion_hcd)
141 if (is_ohci_or_uhci(companion))
142 companion_hcd->self.hs_companion = NULL;
147 /* An EHCI controller must wait for its companions before resuming. */
148 static void ehci_wait_for_companions(struct pci_dev *pdev, struct usb_hcd *hcd,
149 struct pci_dev *companion, struct usb_hcd *companion_hcd)
151 if (is_ohci_or_uhci(companion))
152 device_pm_wait_for_dev(&pdev->dev, &companion->dev);
155 #endif /* CONFIG_PM */
157 /*-------------------------------------------------------------------------*/
159 /* configure so an HC device and id are always provided */
160 /* always called with process context; sleeping is OK */
163 * usb_hcd_pci_probe - initialize PCI-based HCDs
164 * @dev: USB Host Controller being probed
165 * @id: pci hotplug id connecting controller to HCD framework
166 * Context: !in_interrupt()
168 * Allocates basic PCI resources for this USB host controller, and
169 * then invokes the start() method for the HCD associated with it
170 * through the hotplug entry's driver_data.
172 * Store this function in the HCD's struct pci_driver as probe().
174 * Return: 0 if successful.
176 int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
178 struct hc_driver *driver;
188 driver = (struct hc_driver *)id->driver_data;
192 if (pci_enable_device(dev) < 0)
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) {
202 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
210 hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
216 hcd->amd_resume_bug = (usb_hcd_amd_remote_wakeup_quirk(dev) &&
217 driver->flags & (HCD_USB11 | HCD_USB3)) ? 1 : 0;
219 if (driver->flags & HCD_MEMORY) {
221 hcd->rsrc_start = pci_resource_start(dev, 0);
222 hcd->rsrc_len = pci_resource_len(dev, 0);
223 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
224 driver->description)) {
225 dev_dbg(&dev->dev, "controller already in use\n");
229 hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
230 if (hcd->regs == NULL) {
231 dev_dbg(&dev->dev, "error mapping memory\n");
233 goto release_mem_region;
240 for (region = 0; region < PCI_ROM_RESOURCE; region++) {
241 if (!(pci_resource_flags(dev, region) &
245 hcd->rsrc_start = pci_resource_start(dev, region);
246 hcd->rsrc_len = pci_resource_len(dev, region);
247 if (request_region(hcd->rsrc_start, hcd->rsrc_len,
248 driver->description))
251 if (region == PCI_ROM_RESOURCE) {
252 dev_dbg(&dev->dev, "no i/o regions available\n");
260 /* Note: dev_set_drvdata must be called while holding the rwsem */
261 if (dev->class == CL_EHCI) {
262 down_write(&companions_rwsem);
263 dev_set_drvdata(&dev->dev, hcd);
264 for_each_companion(dev, hcd, ehci_pre_add);
265 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
267 dev_set_drvdata(&dev->dev, NULL);
268 for_each_companion(dev, hcd, ehci_post_add);
269 up_write(&companions_rwsem);
271 down_read(&companions_rwsem);
272 dev_set_drvdata(&dev->dev, hcd);
273 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
275 dev_set_drvdata(&dev->dev, NULL);
277 for_each_companion(dev, hcd, non_ehci_add);
278 up_read(&companions_rwsem);
282 goto unmap_registers;
283 device_wakeup_enable(hcd->self.controller);
285 if (pci_dev_run_wake(dev))
286 pm_runtime_put_noidle(&dev->dev);
290 if (driver->flags & HCD_MEMORY) {
293 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
295 release_region(hcd->rsrc_start, hcd->rsrc_len);
299 pci_disable_device(dev);
300 dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
303 EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
306 /* may be called without controller electrically present */
307 /* may be called with controller, bus, and devices active */
310 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
311 * @dev: USB Host Controller being removed
312 * Context: !in_interrupt()
314 * Reverses the effect of usb_hcd_pci_probe(), first invoking
315 * the HCD's stop() method. It is always called from a thread
316 * context, normally "rmmod", "apmd", or something similar.
318 * Store this function in the HCD's struct pci_driver as remove().
320 void usb_hcd_pci_remove(struct pci_dev *dev)
324 hcd = pci_get_drvdata(dev);
328 if (pci_dev_run_wake(dev))
329 pm_runtime_get_noresume(&dev->dev);
331 /* Fake an interrupt request in order to give the driver a chance
332 * to test whether the controller hardware has been removed (e.g.,
333 * cardbus physical eject).
339 /* Note: dev_set_drvdata must be called while holding the rwsem */
340 if (dev->class == CL_EHCI) {
341 down_write(&companions_rwsem);
342 for_each_companion(dev, hcd, ehci_remove);
344 dev_set_drvdata(&dev->dev, NULL);
345 up_write(&companions_rwsem);
347 /* Not EHCI; just clear the companion pointer */
348 down_read(&companions_rwsem);
349 hcd->self.hs_companion = NULL;
351 dev_set_drvdata(&dev->dev, NULL);
352 up_read(&companions_rwsem);
355 if (hcd->driver->flags & HCD_MEMORY) {
357 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
359 release_region(hcd->rsrc_start, hcd->rsrc_len);
363 pci_disable_device(dev);
365 EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
368 * usb_hcd_pci_shutdown - shutdown host controller
369 * @dev: USB Host Controller being shutdown
371 void usb_hcd_pci_shutdown(struct pci_dev *dev)
375 hcd = pci_get_drvdata(dev);
379 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
380 hcd->driver->shutdown) {
381 hcd->driver->shutdown(hcd);
382 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
383 free_irq(hcd->irq, hcd);
384 pci_disable_device(dev);
387 EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
391 #ifdef CONFIG_PPC_PMAC
392 static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
394 /* Enanble or disable ASIC clocks for USB */
395 if (machine_is(powermac)) {
396 struct device_node *of_node;
398 of_node = pci_device_to_OF_node(pci_dev);
400 pmac_call_feature(PMAC_FTR_USB_ENABLE,
407 static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
410 #endif /* CONFIG_PPC_PMAC */
412 static int check_root_hub_suspended(struct device *dev)
414 struct pci_dev *pci_dev = to_pci_dev(dev);
415 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
417 if (HCD_RH_RUNNING(hcd)) {
418 dev_warn(dev, "Root hub is not suspended\n");
421 if (hcd->shared_hcd) {
422 hcd = hcd->shared_hcd;
423 if (HCD_RH_RUNNING(hcd)) {
424 dev_warn(dev, "Secondary root hub is not suspended\n");
431 static int suspend_common(struct device *dev, bool do_wakeup)
433 struct pci_dev *pci_dev = to_pci_dev(dev);
434 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
437 /* Root hub suspend should have stopped all downstream traffic,
438 * and all bus master traffic. And done so for both the interface
439 * and the stub usb_device (which we check here). But maybe it
440 * didn't; writing sysfs power/state files ignores such rules...
442 retval = check_root_hub_suspended(dev);
446 if (hcd->driver->pci_suspend && !HCD_DEAD(hcd)) {
447 /* Optimization: Don't suspend if a root-hub wakeup is
448 * pending and it would cause the HCD to wake up anyway.
450 if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
452 if (do_wakeup && hcd->shared_hcd &&
453 HCD_WAKEUP_PENDING(hcd->shared_hcd))
455 retval = hcd->driver->pci_suspend(hcd, do_wakeup);
456 suspend_report_result(hcd->driver->pci_suspend, retval);
458 /* Check again in case wakeup raced with pci_suspend */
459 if ((retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) ||
460 (retval == 0 && do_wakeup && hcd->shared_hcd &&
461 HCD_WAKEUP_PENDING(hcd->shared_hcd))) {
462 if (hcd->driver->pci_resume)
463 hcd->driver->pci_resume(hcd, false);
470 /* If MSI-X is enabled, the driver will have synchronized all vectors
471 * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
474 if (!hcd->msix_enabled)
475 synchronize_irq(pci_dev->irq);
477 /* Downstream ports from this root hub should already be quiesced, so
478 * there will be no DMA activity. Now we can shut down the upstream
479 * link (except maybe for PME# resume signaling). We'll enter a
480 * low power state during suspend_noirq, if the hardware allows.
482 pci_disable_device(pci_dev);
486 static int resume_common(struct device *dev, int event)
488 struct pci_dev *pci_dev = to_pci_dev(dev);
489 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
492 if (HCD_RH_RUNNING(hcd) ||
494 HCD_RH_RUNNING(hcd->shared_hcd))) {
495 dev_dbg(dev, "can't resume, not suspended!\n");
499 retval = pci_enable_device(pci_dev);
501 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
505 pci_set_master(pci_dev);
507 if (hcd->driver->pci_resume && !HCD_DEAD(hcd)) {
510 * Only EHCI controllers have to wait for their companions.
511 * No locking is needed because PCI controller drivers do not
512 * get unbound during system resume.
514 if (pci_dev->class == CL_EHCI && event != PM_EVENT_AUTO_RESUME)
515 for_each_companion(pci_dev, hcd,
516 ehci_wait_for_companions);
518 retval = hcd->driver->pci_resume(hcd,
519 event == PM_EVENT_RESTORE);
521 dev_err(dev, "PCI post-resume error %d!\n", retval);
523 usb_hc_died(hcd->shared_hcd);
530 #ifdef CONFIG_PM_SLEEP
532 static int hcd_pci_suspend(struct device *dev)
534 return suspend_common(dev, device_may_wakeup(dev));
537 static int hcd_pci_suspend_noirq(struct device *dev)
539 struct pci_dev *pci_dev = to_pci_dev(dev);
540 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
543 retval = check_root_hub_suspended(dev);
547 pci_save_state(pci_dev);
549 /* If the root hub is dead rather than suspended, disallow remote
550 * wakeup. usb_hc_died() should ensure that both hosts are marked as
551 * dying, so we only need to check the primary roothub.
554 device_set_wakeup_enable(dev, 0);
555 dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
557 /* Possibly enable remote wakeup,
558 * choose the appropriate low-power state, and go to that state.
560 retval = pci_prepare_to_sleep(pci_dev);
561 if (retval == -EIO) { /* Low-power not supported */
562 dev_dbg(dev, "--> PCI D0 legacy\n");
564 } else if (retval == 0) {
565 dev_dbg(dev, "--> PCI %s\n",
566 pci_power_name(pci_dev->current_state));
568 suspend_report_result(pci_prepare_to_sleep, retval);
572 powermac_set_asic(pci_dev, 0);
576 static int hcd_pci_resume_noirq(struct device *dev)
578 struct pci_dev *pci_dev = to_pci_dev(dev);
580 powermac_set_asic(pci_dev, 1);
582 /* Go back to D0 and disable remote wakeup */
583 pci_back_from_sleep(pci_dev);
587 static int hcd_pci_resume(struct device *dev)
589 return resume_common(dev, PM_EVENT_RESUME);
592 static int hcd_pci_restore(struct device *dev)
594 return resume_common(dev, PM_EVENT_RESTORE);
599 #define hcd_pci_suspend NULL
600 #define hcd_pci_suspend_noirq NULL
601 #define hcd_pci_resume_noirq NULL
602 #define hcd_pci_resume NULL
603 #define hcd_pci_restore NULL
605 #endif /* CONFIG_PM_SLEEP */
607 static int hcd_pci_runtime_suspend(struct device *dev)
611 retval = suspend_common(dev, true);
613 powermac_set_asic(to_pci_dev(dev), 0);
614 dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
618 static int hcd_pci_runtime_resume(struct device *dev)
622 powermac_set_asic(to_pci_dev(dev), 1);
623 retval = resume_common(dev, PM_EVENT_AUTO_RESUME);
624 dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
628 const struct dev_pm_ops usb_hcd_pci_pm_ops = {
629 .suspend = hcd_pci_suspend,
630 .suspend_noirq = hcd_pci_suspend_noirq,
631 .resume_noirq = hcd_pci_resume_noirq,
632 .resume = hcd_pci_resume,
633 .freeze = check_root_hub_suspended,
634 .freeze_noirq = check_root_hub_suspended,
637 .poweroff = hcd_pci_suspend,
638 .poweroff_noirq = hcd_pci_suspend_noirq,
639 .restore_noirq = hcd_pci_resume_noirq,
640 .restore = hcd_pci_restore,
641 .runtime_suspend = hcd_pci_runtime_suspend,
642 .runtime_resume = hcd_pci_runtime_resume,
644 EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
646 #endif /* CONFIG_PM */