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>
24 /* PCI-based HCs are common, but plenty of non-PCI HCs are used too */
27 * Coordinate handoffs between EHCI and companion controllers
28 * during EHCI probing and system resume.
31 static DECLARE_RWSEM(companions_rwsem);
33 #define CL_UHCI PCI_CLASS_SERIAL_USB_UHCI
34 #define CL_OHCI PCI_CLASS_SERIAL_USB_OHCI
35 #define CL_EHCI PCI_CLASS_SERIAL_USB_EHCI
37 static inline int is_ohci_or_uhci(struct pci_dev *pdev)
39 return pdev->class == CL_OHCI || pdev->class == CL_UHCI;
42 typedef void (*companion_fn)(struct pci_dev *pdev, struct usb_hcd *hcd,
43 struct pci_dev *companion, struct usb_hcd *companion_hcd);
45 /* Iterate over PCI devices in the same slot as pdev and call fn for each */
46 static void for_each_companion(struct pci_dev *pdev, struct usb_hcd *hcd,
49 struct pci_dev *companion;
50 struct usb_hcd *companion_hcd;
51 unsigned int slot = PCI_SLOT(pdev->devfn);
54 * Iterate through other PCI functions in the same slot.
55 * If the function's drvdata isn't set then it isn't bound to
56 * a USB host controller driver, so skip it.
59 for_each_pci_dev(companion) {
60 if (companion->bus != pdev->bus ||
61 PCI_SLOT(companion->devfn) != slot)
65 * Companion device should be either UHCI,OHCI or EHCI host
66 * controller, otherwise skip.
68 if (companion->class != CL_UHCI && companion->class != CL_OHCI &&
69 companion->class != CL_EHCI)
72 companion_hcd = pci_get_drvdata(companion);
73 if (!companion_hcd || !companion_hcd->self.root_hub)
75 fn(pdev, hcd, companion, companion_hcd);
80 * We're about to add an EHCI controller, which will unceremoniously grab
81 * all the port connections away from its companions. To prevent annoying
82 * error messages, lock the companion's root hub and gracefully unconfigure
83 * it beforehand. Leave it locked until the EHCI controller is all set.
85 static void ehci_pre_add(struct pci_dev *pdev, struct usb_hcd *hcd,
86 struct pci_dev *companion, struct usb_hcd *companion_hcd)
88 struct usb_device *udev;
90 if (is_ohci_or_uhci(companion)) {
91 udev = companion_hcd->self.root_hub;
92 usb_lock_device(udev);
93 usb_set_configuration(udev, 0);
98 * Adding the EHCI controller has either succeeded or failed. Set the
99 * companion pointer accordingly, and in either case, reconfigure and
100 * unlock the root hub.
102 static void ehci_post_add(struct pci_dev *pdev, struct usb_hcd *hcd,
103 struct pci_dev *companion, struct usb_hcd *companion_hcd)
105 struct usb_device *udev;
107 if (is_ohci_or_uhci(companion)) {
108 if (dev_get_drvdata(&pdev->dev)) { /* Succeeded */
109 dev_dbg(&pdev->dev, "HS companion for %s\n",
110 dev_name(&companion->dev));
111 companion_hcd->self.hs_companion = &hcd->self;
113 udev = companion_hcd->self.root_hub;
114 usb_set_configuration(udev, 1);
115 usb_unlock_device(udev);
120 * We just added a non-EHCI controller. Find the EHCI controller to
121 * which it is a companion, and store a pointer to the bus structure.
123 static void non_ehci_add(struct pci_dev *pdev, struct usb_hcd *hcd,
124 struct pci_dev *companion, struct usb_hcd *companion_hcd)
126 if (is_ohci_or_uhci(pdev) && companion->class == CL_EHCI) {
127 dev_dbg(&pdev->dev, "FS/LS companion for %s\n",
128 dev_name(&companion->dev));
129 hcd->self.hs_companion = &companion_hcd->self;
133 /* We are removing an EHCI controller. Clear the companions' pointers. */
134 static void ehci_remove(struct pci_dev *pdev, struct usb_hcd *hcd,
135 struct pci_dev *companion, struct usb_hcd *companion_hcd)
137 if (is_ohci_or_uhci(companion))
138 companion_hcd->self.hs_companion = NULL;
143 /* An EHCI controller must wait for its companions before resuming. */
144 static void ehci_wait_for_companions(struct pci_dev *pdev, struct usb_hcd *hcd,
145 struct pci_dev *companion, struct usb_hcd *companion_hcd)
147 if (is_ohci_or_uhci(companion))
148 device_pm_wait_for_dev(&pdev->dev, &companion->dev);
151 #endif /* CONFIG_PM */
153 /*-------------------------------------------------------------------------*/
155 /* configure so an HC device and id are always provided */
156 /* always called with process context; sleeping is OK */
159 * usb_hcd_pci_probe - initialize PCI-based HCDs
160 * @dev: USB Host Controller being probed
161 * @id: pci hotplug id connecting controller to HCD framework
162 * Context: !in_interrupt()
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 pci_device_id *id)
174 struct hc_driver *driver;
184 driver = (struct hc_driver *)id->driver_data;
188 if (pci_enable_device(dev) < 0)
192 * The xHCI driver has its own irq management
193 * make sure irq setup is not touched for xhci in generic hcd code
195 if ((driver->flags & HCD_MASK) < HCD_USB3) {
198 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
206 hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
212 hcd->amd_resume_bug = (usb_hcd_amd_remote_wakeup_quirk(dev) &&
213 driver->flags & (HCD_USB11 | HCD_USB3)) ? 1 : 0;
215 if (driver->flags & HCD_MEMORY) {
217 hcd->rsrc_start = pci_resource_start(dev, 0);
218 hcd->rsrc_len = pci_resource_len(dev, 0);
219 if (!devm_request_mem_region(&dev->dev, hcd->rsrc_start,
220 hcd->rsrc_len, driver->description)) {
221 dev_dbg(&dev->dev, "controller already in use\n");
225 hcd->regs = devm_ioremap_nocache(&dev->dev, hcd->rsrc_start,
227 if (hcd->regs == NULL) {
228 dev_dbg(&dev->dev, "error mapping memory\n");
237 for (region = 0; region < PCI_ROM_RESOURCE; region++) {
238 if (!(pci_resource_flags(dev, region) &
242 hcd->rsrc_start = pci_resource_start(dev, region);
243 hcd->rsrc_len = pci_resource_len(dev, region);
244 if (devm_request_region(&dev->dev, hcd->rsrc_start,
245 hcd->rsrc_len, driver->description))
248 if (region == PCI_ROM_RESOURCE) {
249 dev_dbg(&dev->dev, "no i/o regions available\n");
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);
264 dev_set_drvdata(&dev->dev, NULL);
265 for_each_companion(dev, hcd, ehci_post_add);
266 up_write(&companions_rwsem);
268 down_read(&companions_rwsem);
269 dev_set_drvdata(&dev->dev, hcd);
270 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
272 dev_set_drvdata(&dev->dev, NULL);
274 for_each_companion(dev, hcd, non_ehci_add);
275 up_read(&companions_rwsem);
280 device_wakeup_enable(hcd->self.controller);
282 if (pci_dev_run_wake(dev))
283 pm_runtime_put_noidle(&dev->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
302 * Context: !in_interrupt()
304 * Reverses the effect of usb_hcd_pci_probe(), first invoking
305 * the HCD's stop() method. It is always called from a thread
306 * context, normally "rmmod", "apmd", or something similar.
308 * Store this function in the HCD's struct pci_driver as remove().
310 void usb_hcd_pci_remove(struct pci_dev *dev)
314 hcd = pci_get_drvdata(dev);
318 if (pci_dev_run_wake(dev))
319 pm_runtime_get_noresume(&dev->dev);
321 /* Fake an interrupt request in order to give the driver a chance
322 * to test whether the controller hardware has been removed (e.g.,
323 * cardbus physical eject).
329 /* Note: dev_set_drvdata must be called while holding the rwsem */
330 if (dev->class == CL_EHCI) {
331 down_write(&companions_rwsem);
332 for_each_companion(dev, hcd, ehci_remove);
334 dev_set_drvdata(&dev->dev, NULL);
335 up_write(&companions_rwsem);
337 /* Not EHCI; just clear the companion pointer */
338 down_read(&companions_rwsem);
339 hcd->self.hs_companion = NULL;
341 dev_set_drvdata(&dev->dev, NULL);
342 up_read(&companions_rwsem);
345 pci_disable_device(dev);
347 EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
350 * usb_hcd_pci_shutdown - shutdown host controller
351 * @dev: USB Host Controller being shutdown
353 void usb_hcd_pci_shutdown(struct pci_dev *dev)
357 hcd = pci_get_drvdata(dev);
361 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
362 hcd->driver->shutdown) {
363 hcd->driver->shutdown(hcd);
364 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
365 free_irq(hcd->irq, hcd);
366 pci_disable_device(dev);
369 EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
373 #ifdef CONFIG_PPC_PMAC
374 static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
376 /* Enanble or disable ASIC clocks for USB */
377 if (machine_is(powermac)) {
378 struct device_node *of_node;
380 of_node = pci_device_to_OF_node(pci_dev);
382 pmac_call_feature(PMAC_FTR_USB_ENABLE,
389 static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
392 #endif /* CONFIG_PPC_PMAC */
394 static int check_root_hub_suspended(struct device *dev)
396 struct pci_dev *pci_dev = to_pci_dev(dev);
397 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
399 if (HCD_RH_RUNNING(hcd)) {
400 dev_warn(dev, "Root hub is not suspended\n");
403 if (hcd->shared_hcd) {
404 hcd = hcd->shared_hcd;
405 if (HCD_RH_RUNNING(hcd)) {
406 dev_warn(dev, "Secondary root hub is not suspended\n");
413 static int suspend_common(struct device *dev, bool do_wakeup)
415 struct pci_dev *pci_dev = to_pci_dev(dev);
416 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
419 /* Root hub suspend should have stopped all downstream traffic,
420 * and all bus master traffic. And done so for both the interface
421 * and the stub usb_device (which we check here). But maybe it
422 * didn't; writing sysfs power/state files ignores such rules...
424 retval = check_root_hub_suspended(dev);
428 if (hcd->driver->pci_suspend && !HCD_DEAD(hcd)) {
429 /* Optimization: Don't suspend if a root-hub wakeup is
430 * pending and it would cause the HCD to wake up anyway.
432 if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
434 if (do_wakeup && hcd->shared_hcd &&
435 HCD_WAKEUP_PENDING(hcd->shared_hcd))
437 retval = hcd->driver->pci_suspend(hcd, do_wakeup);
438 suspend_report_result(hcd->driver->pci_suspend, retval);
440 /* Check again in case wakeup raced with pci_suspend */
441 if ((retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) ||
442 (retval == 0 && do_wakeup && hcd->shared_hcd &&
443 HCD_WAKEUP_PENDING(hcd->shared_hcd))) {
444 if (hcd->driver->pci_resume)
445 hcd->driver->pci_resume(hcd, false);
452 /* If MSI-X is enabled, the driver will have synchronized all vectors
453 * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
456 if (!hcd->msix_enabled)
457 synchronize_irq(pci_dev->irq);
459 /* Downstream ports from this root hub should already be quiesced, so
460 * there will be no DMA activity. Now we can shut down the upstream
461 * link (except maybe for PME# resume signaling). We'll enter a
462 * low power state during suspend_noirq, if the hardware allows.
464 pci_disable_device(pci_dev);
468 static int resume_common(struct device *dev, int event)
470 struct pci_dev *pci_dev = to_pci_dev(dev);
471 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
474 if (HCD_RH_RUNNING(hcd) ||
476 HCD_RH_RUNNING(hcd->shared_hcd))) {
477 dev_dbg(dev, "can't resume, not suspended!\n");
481 retval = pci_enable_device(pci_dev);
483 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
487 pci_set_master(pci_dev);
489 if (hcd->driver->pci_resume && !HCD_DEAD(hcd)) {
492 * Only EHCI controllers have to wait for their companions.
493 * No locking is needed because PCI controller drivers do not
494 * get unbound during system resume.
496 if (pci_dev->class == CL_EHCI && event != PM_EVENT_AUTO_RESUME)
497 for_each_companion(pci_dev, hcd,
498 ehci_wait_for_companions);
500 retval = hcd->driver->pci_resume(hcd,
501 event == PM_EVENT_RESTORE);
503 dev_err(dev, "PCI post-resume error %d!\n", retval);
510 #ifdef CONFIG_PM_SLEEP
512 static int hcd_pci_suspend(struct device *dev)
514 return suspend_common(dev, device_may_wakeup(dev));
517 static int hcd_pci_suspend_noirq(struct device *dev)
519 struct pci_dev *pci_dev = to_pci_dev(dev);
520 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
523 retval = check_root_hub_suspended(dev);
527 pci_save_state(pci_dev);
529 /* If the root hub is dead rather than suspended, disallow remote
530 * wakeup. usb_hc_died() should ensure that both hosts are marked as
531 * dying, so we only need to check the primary roothub.
534 device_set_wakeup_enable(dev, 0);
535 dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
537 /* Possibly enable remote wakeup,
538 * choose the appropriate low-power state, and go to that state.
540 retval = pci_prepare_to_sleep(pci_dev);
541 if (retval == -EIO) { /* Low-power not supported */
542 dev_dbg(dev, "--> PCI D0 legacy\n");
544 } else if (retval == 0) {
545 dev_dbg(dev, "--> PCI %s\n",
546 pci_power_name(pci_dev->current_state));
548 suspend_report_result(pci_prepare_to_sleep, retval);
552 powermac_set_asic(pci_dev, 0);
556 static int hcd_pci_resume_noirq(struct device *dev)
558 powermac_set_asic(to_pci_dev(dev), 1);
562 static int hcd_pci_resume(struct device *dev)
564 return resume_common(dev, PM_EVENT_RESUME);
567 static int hcd_pci_restore(struct device *dev)
569 return resume_common(dev, PM_EVENT_RESTORE);
574 #define hcd_pci_suspend NULL
575 #define hcd_pci_suspend_noirq NULL
576 #define hcd_pci_resume_noirq NULL
577 #define hcd_pci_resume NULL
578 #define hcd_pci_restore NULL
580 #endif /* CONFIG_PM_SLEEP */
582 static int hcd_pci_runtime_suspend(struct device *dev)
586 retval = suspend_common(dev, true);
588 powermac_set_asic(to_pci_dev(dev), 0);
589 dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
593 static int hcd_pci_runtime_resume(struct device *dev)
597 powermac_set_asic(to_pci_dev(dev), 1);
598 retval = resume_common(dev, PM_EVENT_AUTO_RESUME);
599 dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
603 const struct dev_pm_ops usb_hcd_pci_pm_ops = {
604 .suspend = hcd_pci_suspend,
605 .suspend_noirq = hcd_pci_suspend_noirq,
606 .resume_noirq = hcd_pci_resume_noirq,
607 .resume = hcd_pci_resume,
608 .freeze = hcd_pci_suspend,
609 .freeze_noirq = check_root_hub_suspended,
611 .thaw = hcd_pci_resume,
612 .poweroff = hcd_pci_suspend,
613 .poweroff_noirq = hcd_pci_suspend_noirq,
614 .restore_noirq = hcd_pci_resume_noirq,
615 .restore = hcd_pci_restore,
616 .runtime_suspend = hcd_pci_runtime_suspend,
617 .runtime_resume = hcd_pci_runtime_resume,
619 EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
621 #endif /* CONFIG_PM */