1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright David Brownell 2000-2002
6 #include <linux/kernel.h>
7 #include <linux/module.h>
10 #include <linux/usb/hcd.h>
15 #ifdef CONFIG_PPC_PMAC
16 #include <asm/machdep.h>
17 #include <asm/pmac_feature.h>
23 /* PCI-based HCs are common, but plenty of non-PCI HCs are used too */
26 * Coordinate handoffs between EHCI and companion controllers
27 * during EHCI probing and system resume.
30 static DECLARE_RWSEM(companions_rwsem);
32 #define CL_UHCI PCI_CLASS_SERIAL_USB_UHCI
33 #define CL_OHCI PCI_CLASS_SERIAL_USB_OHCI
34 #define CL_EHCI PCI_CLASS_SERIAL_USB_EHCI
36 static inline int is_ohci_or_uhci(struct pci_dev *pdev)
38 return pdev->class == CL_OHCI || pdev->class == CL_UHCI;
41 typedef void (*companion_fn)(struct pci_dev *pdev, struct usb_hcd *hcd,
42 struct pci_dev *companion, struct usb_hcd *companion_hcd);
44 /* Iterate over PCI devices in the same slot as pdev and call fn for each */
45 static void for_each_companion(struct pci_dev *pdev, struct usb_hcd *hcd,
48 struct pci_dev *companion;
49 struct usb_hcd *companion_hcd;
50 unsigned int slot = PCI_SLOT(pdev->devfn);
53 * Iterate through other PCI functions in the same slot.
54 * If the function's drvdata isn't set then it isn't bound to
55 * a USB host controller driver, so skip it.
58 for_each_pci_dev(companion) {
59 if (companion->bus != pdev->bus ||
60 PCI_SLOT(companion->devfn) != slot)
64 * Companion device should be either UHCI,OHCI or EHCI host
65 * controller, otherwise skip.
67 if (companion->class != CL_UHCI && companion->class != CL_OHCI &&
68 companion->class != CL_EHCI)
71 companion_hcd = pci_get_drvdata(companion);
72 if (!companion_hcd || !companion_hcd->self.root_hub)
74 fn(pdev, hcd, companion, companion_hcd);
79 * We're about to add an EHCI controller, which will unceremoniously grab
80 * all the port connections away from its companions. To prevent annoying
81 * error messages, lock the companion's root hub and gracefully unconfigure
82 * it beforehand. Leave it locked until the EHCI controller is all set.
84 static void ehci_pre_add(struct pci_dev *pdev, struct usb_hcd *hcd,
85 struct pci_dev *companion, struct usb_hcd *companion_hcd)
87 struct usb_device *udev;
89 if (is_ohci_or_uhci(companion)) {
90 udev = companion_hcd->self.root_hub;
91 usb_lock_device(udev);
92 usb_set_configuration(udev, 0);
97 * Adding the EHCI controller has either succeeded or failed. Set the
98 * companion pointer accordingly, and in either case, reconfigure and
99 * unlock the root hub.
101 static void ehci_post_add(struct pci_dev *pdev, struct usb_hcd *hcd,
102 struct pci_dev *companion, struct usb_hcd *companion_hcd)
104 struct usb_device *udev;
106 if (is_ohci_or_uhci(companion)) {
107 if (dev_get_drvdata(&pdev->dev)) { /* Succeeded */
108 dev_dbg(&pdev->dev, "HS companion for %s\n",
109 dev_name(&companion->dev));
110 companion_hcd->self.hs_companion = &hcd->self;
112 udev = companion_hcd->self.root_hub;
113 usb_set_configuration(udev, 1);
114 usb_unlock_device(udev);
119 * We just added a non-EHCI controller. Find the EHCI controller to
120 * which it is a companion, and store a pointer to the bus structure.
122 static void non_ehci_add(struct pci_dev *pdev, struct usb_hcd *hcd,
123 struct pci_dev *companion, struct usb_hcd *companion_hcd)
125 if (is_ohci_or_uhci(pdev) && companion->class == CL_EHCI) {
126 dev_dbg(&pdev->dev, "FS/LS companion for %s\n",
127 dev_name(&companion->dev));
128 hcd->self.hs_companion = &companion_hcd->self;
132 /* We are removing an EHCI controller. Clear the companions' pointers. */
133 static void ehci_remove(struct pci_dev *pdev, struct usb_hcd *hcd,
134 struct pci_dev *companion, struct usb_hcd *companion_hcd)
136 if (is_ohci_or_uhci(companion))
137 companion_hcd->self.hs_companion = NULL;
142 /* An EHCI controller must wait for its companions before resuming. */
143 static void ehci_wait_for_companions(struct pci_dev *pdev, struct usb_hcd *hcd,
144 struct pci_dev *companion, struct usb_hcd *companion_hcd)
146 if (is_ohci_or_uhci(companion))
147 device_pm_wait_for_dev(&pdev->dev, &companion->dev);
150 #endif /* CONFIG_PM */
152 /*-------------------------------------------------------------------------*/
154 /* configure so an HC device and id are always provided */
155 /* always called with process context; sleeping is OK */
158 * usb_hcd_pci_probe - initialize PCI-based HCDs
159 * @dev: USB Host Controller being probed
160 * @driver: USB HC driver handle
162 * Context: task context, might sleep
164 * Allocates basic PCI resources for this USB host controller, and
165 * then invokes the start() method for the HCD associated with it
166 * through the hotplug entry's driver_data.
168 * Store this function in the HCD's struct pci_driver as probe().
170 * Return: 0 if successful.
172 int usb_hcd_pci_probe(struct pci_dev *dev, const struct hc_driver *driver)
184 if (pci_enable_device(dev) < 0)
188 * The xHCI driver has its own irq management
189 * make sure irq setup is not touched for xhci in generic hcd code
191 if ((driver->flags & HCD_MASK) < HCD_USB3) {
192 retval = pci_alloc_irq_vectors(dev, 1, 1, PCI_IRQ_LEGACY | PCI_IRQ_MSI);
195 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
200 hcd_irq = pci_irq_vector(dev, 0);
203 hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
206 goto free_irq_vectors;
209 hcd->amd_resume_bug = (usb_hcd_amd_remote_wakeup_quirk(dev) &&
210 driver->flags & (HCD_USB11 | HCD_USB3)) ? 1 : 0;
212 if (driver->flags & HCD_MEMORY) {
214 hcd->rsrc_start = pci_resource_start(dev, 0);
215 hcd->rsrc_len = pci_resource_len(dev, 0);
216 if (!devm_request_mem_region(&dev->dev, hcd->rsrc_start,
217 hcd->rsrc_len, driver->description)) {
218 dev_dbg(&dev->dev, "controller already in use\n");
222 hcd->regs = devm_ioremap(&dev->dev, hcd->rsrc_start,
224 if (hcd->regs == NULL) {
225 dev_dbg(&dev->dev, "error mapping memory\n");
234 for (region = 0; region < PCI_STD_NUM_BARS; region++) {
235 if (!(pci_resource_flags(dev, region) &
239 hcd->rsrc_start = pci_resource_start(dev, region);
240 hcd->rsrc_len = pci_resource_len(dev, region);
241 if (devm_request_region(&dev->dev, hcd->rsrc_start,
242 hcd->rsrc_len, driver->description))
245 if (region == PCI_STD_NUM_BARS) {
246 dev_dbg(&dev->dev, "no i/o regions available\n");
254 /* Note: dev_set_drvdata must be called while holding the rwsem */
255 if (dev->class == CL_EHCI) {
256 down_write(&companions_rwsem);
257 dev_set_drvdata(&dev->dev, hcd);
258 for_each_companion(dev, hcd, ehci_pre_add);
259 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
261 dev_set_drvdata(&dev->dev, NULL);
262 for_each_companion(dev, hcd, ehci_post_add);
263 up_write(&companions_rwsem);
265 down_read(&companions_rwsem);
266 dev_set_drvdata(&dev->dev, hcd);
267 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
269 dev_set_drvdata(&dev->dev, NULL);
271 for_each_companion(dev, hcd, non_ehci_add);
272 up_read(&companions_rwsem);
277 device_wakeup_enable(hcd->self.controller);
279 if (pci_dev_run_wake(dev))
280 pm_runtime_put_noidle(&dev->dev);
286 if ((driver->flags & HCD_MASK) < HCD_USB3)
287 pci_free_irq_vectors(dev);
289 pci_disable_device(dev);
290 dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
293 EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
296 /* may be called without controller electrically present */
297 /* may be called with controller, bus, and devices active */
300 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
301 * @dev: USB Host Controller being removed
303 * Context: task context, might sleep
305 * Reverses the effect of usb_hcd_pci_probe(), first invoking
306 * the HCD's stop() method. It is always called from a thread
307 * context, normally "rmmod", "apmd", or something similar.
309 * Store this function in the HCD's struct pci_driver as remove().
311 void usb_hcd_pci_remove(struct pci_dev *dev)
314 int hcd_driver_flags;
316 hcd = pci_get_drvdata(dev);
320 hcd_driver_flags = hcd->driver->flags;
322 if (pci_dev_run_wake(dev))
323 pm_runtime_get_noresume(&dev->dev);
325 /* Fake an interrupt request in order to give the driver a chance
326 * to test whether the controller hardware has been removed (e.g.,
327 * cardbus physical eject).
333 /* Note: dev_set_drvdata must be called while holding the rwsem */
334 if (dev->class == CL_EHCI) {
335 down_write(&companions_rwsem);
336 for_each_companion(dev, hcd, ehci_remove);
338 dev_set_drvdata(&dev->dev, NULL);
339 up_write(&companions_rwsem);
341 /* Not EHCI; just clear the companion pointer */
342 down_read(&companions_rwsem);
343 hcd->self.hs_companion = NULL;
345 dev_set_drvdata(&dev->dev, NULL);
346 up_read(&companions_rwsem);
349 if ((hcd_driver_flags & HCD_MASK) < HCD_USB3)
350 pci_free_irq_vectors(dev);
351 pci_disable_device(dev);
353 EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
356 * usb_hcd_pci_shutdown - shutdown host controller
357 * @dev: USB Host Controller being shutdown
359 void usb_hcd_pci_shutdown(struct pci_dev *dev)
363 hcd = pci_get_drvdata(dev);
367 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
368 hcd->driver->shutdown) {
369 hcd->driver->shutdown(hcd);
370 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
371 free_irq(hcd->irq, hcd);
372 pci_disable_device(dev);
375 EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
379 #ifdef CONFIG_PPC_PMAC
380 static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
382 /* Enanble or disable ASIC clocks for USB */
383 if (machine_is(powermac)) {
384 struct device_node *of_node;
386 of_node = pci_device_to_OF_node(pci_dev);
388 pmac_call_feature(PMAC_FTR_USB_ENABLE,
395 static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
398 #endif /* CONFIG_PPC_PMAC */
400 static int check_root_hub_suspended(struct device *dev)
402 struct usb_hcd *hcd = dev_get_drvdata(dev);
404 if (HCD_RH_RUNNING(hcd)) {
405 dev_warn(dev, "Root hub is not suspended\n");
408 if (hcd->shared_hcd) {
409 hcd = hcd->shared_hcd;
410 if (HCD_RH_RUNNING(hcd)) {
411 dev_warn(dev, "Secondary root hub is not suspended\n");
418 static int suspend_common(struct device *dev, pm_message_t msg)
420 struct pci_dev *pci_dev = to_pci_dev(dev);
421 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
425 do_wakeup = PMSG_IS_AUTO(msg) ? true : device_may_wakeup(dev);
427 /* Root hub suspend should have stopped all downstream traffic,
428 * and all bus master traffic. And done so for both the interface
429 * and the stub usb_device (which we check here). But maybe it
430 * didn't; writing sysfs power/state files ignores such rules...
432 retval = check_root_hub_suspended(dev);
436 if (hcd->driver->pci_suspend && !HCD_DEAD(hcd)) {
437 /* Optimization: Don't suspend if a root-hub wakeup is
438 * pending and it would cause the HCD to wake up anyway.
440 if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
442 if (do_wakeup && hcd->shared_hcd &&
443 HCD_WAKEUP_PENDING(hcd->shared_hcd))
445 retval = hcd->driver->pci_suspend(hcd, do_wakeup);
446 suspend_report_result(dev, hcd->driver->pci_suspend, retval);
448 /* Check again in case wakeup raced with pci_suspend */
449 if ((retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) ||
450 (retval == 0 && do_wakeup && hcd->shared_hcd &&
451 HCD_WAKEUP_PENDING(hcd->shared_hcd))) {
452 if (hcd->driver->pci_resume)
453 hcd->driver->pci_resume(hcd, msg);
460 /* If MSI-X is enabled, the driver will have synchronized all vectors
461 * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
464 if (!hcd->msix_enabled)
465 synchronize_irq(pci_irq_vector(pci_dev, 0));
467 /* Downstream ports from this root hub should already be quiesced, so
468 * there will be no DMA activity. Now we can shut down the upstream
469 * link (except maybe for PME# resume signaling). We'll enter a
470 * low power state during suspend_noirq, if the hardware allows.
472 pci_disable_device(pci_dev);
476 static int resume_common(struct device *dev, pm_message_t msg)
478 struct pci_dev *pci_dev = to_pci_dev(dev);
479 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
482 if (HCD_RH_RUNNING(hcd) ||
484 HCD_RH_RUNNING(hcd->shared_hcd))) {
485 dev_dbg(dev, "can't resume, not suspended!\n");
489 retval = pci_enable_device(pci_dev);
491 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
495 pci_set_master(pci_dev);
497 if (hcd->driver->pci_resume && !HCD_DEAD(hcd)) {
500 * Only EHCI controllers have to wait for their companions.
501 * No locking is needed because PCI controller drivers do not
502 * get unbound during system resume.
504 if (pci_dev->class == CL_EHCI && msg.event != PM_EVENT_AUTO_RESUME)
505 for_each_companion(pci_dev, hcd,
506 ehci_wait_for_companions);
508 retval = hcd->driver->pci_resume(hcd, msg);
510 dev_err(dev, "PCI post-resume error %d!\n", retval);
517 #ifdef CONFIG_PM_SLEEP
519 static int hcd_pci_suspend(struct device *dev)
521 return suspend_common(dev, PMSG_SUSPEND);
524 static int hcd_pci_suspend_noirq(struct device *dev)
526 struct pci_dev *pci_dev = to_pci_dev(dev);
527 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
530 retval = check_root_hub_suspended(dev);
534 pci_save_state(pci_dev);
536 /* If the root hub is dead rather than suspended, disallow remote
537 * wakeup. usb_hc_died() should ensure that both hosts are marked as
538 * dying, so we only need to check the primary roothub.
541 device_set_wakeup_enable(dev, 0);
542 dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
544 /* Possibly enable remote wakeup,
545 * choose the appropriate low-power state, and go to that state.
547 retval = pci_prepare_to_sleep(pci_dev);
548 if (retval == -EIO) { /* Low-power not supported */
549 dev_dbg(dev, "--> PCI D0 legacy\n");
551 } else if (retval == 0) {
552 dev_dbg(dev, "--> PCI %s\n",
553 pci_power_name(pci_dev->current_state));
555 suspend_report_result(dev, pci_prepare_to_sleep, retval);
559 powermac_set_asic(pci_dev, 0);
563 static int hcd_pci_poweroff_late(struct device *dev)
565 struct pci_dev *pci_dev = to_pci_dev(dev);
566 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
568 if (hcd->driver->pci_poweroff_late && !HCD_DEAD(hcd))
569 return hcd->driver->pci_poweroff_late(hcd, device_may_wakeup(dev));
574 static int hcd_pci_resume_noirq(struct device *dev)
576 powermac_set_asic(to_pci_dev(dev), 1);
580 static int hcd_pci_resume(struct device *dev)
582 return resume_common(dev, PMSG_RESUME);
585 static int hcd_pci_restore(struct device *dev)
587 return resume_common(dev, PMSG_RESTORE);
592 #define hcd_pci_suspend NULL
593 #define hcd_pci_suspend_noirq NULL
594 #define hcd_pci_poweroff_late NULL
595 #define hcd_pci_resume_noirq NULL
596 #define hcd_pci_resume NULL
597 #define hcd_pci_restore NULL
599 #endif /* CONFIG_PM_SLEEP */
601 static int hcd_pci_runtime_suspend(struct device *dev)
605 retval = suspend_common(dev, PMSG_AUTO_SUSPEND);
607 powermac_set_asic(to_pci_dev(dev), 0);
608 dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
612 static int hcd_pci_runtime_resume(struct device *dev)
616 powermac_set_asic(to_pci_dev(dev), 1);
617 retval = resume_common(dev, PMSG_AUTO_RESUME);
618 dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
622 const struct dev_pm_ops usb_hcd_pci_pm_ops = {
623 .suspend = hcd_pci_suspend,
624 .suspend_noirq = hcd_pci_suspend_noirq,
625 .resume_noirq = hcd_pci_resume_noirq,
626 .resume = hcd_pci_resume,
627 .freeze = hcd_pci_suspend,
628 .freeze_noirq = check_root_hub_suspended,
630 .thaw = hcd_pci_resume,
631 .poweroff = hcd_pci_suspend,
632 .poweroff_late = hcd_pci_poweroff_late,
633 .poweroff_noirq = hcd_pci_suspend_noirq,
634 .restore_noirq = hcd_pci_resume_noirq,
635 .restore = hcd_pci_restore,
636 .runtime_suspend = hcd_pci_runtime_suspend,
637 .runtime_resume = hcd_pci_runtime_resume,
639 EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
641 #endif /* CONFIG_PM */