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>
31 #include <asm/pci-bridge.h>
38 /* PCI-based HCs are common, but plenty of non-PCI HCs are used too */
40 #ifdef CONFIG_PM_SLEEP
42 /* Coordinate handoffs between EHCI and companion controllers
43 * during system resume
46 static DEFINE_MUTEX(companions_mutex);
48 #define CL_UHCI PCI_CLASS_SERIAL_USB_UHCI
49 #define CL_OHCI PCI_CLASS_SERIAL_USB_OHCI
50 #define CL_EHCI PCI_CLASS_SERIAL_USB_EHCI
52 enum companion_action {
53 SET_HS_COMPANION, CLEAR_HS_COMPANION, WAIT_FOR_COMPANIONS
56 static void companion_common(struct pci_dev *pdev, struct usb_hcd *hcd,
57 enum companion_action action)
59 struct pci_dev *companion;
60 struct usb_hcd *companion_hcd;
61 unsigned int slot = PCI_SLOT(pdev->devfn);
63 /* Iterate through other PCI functions in the same slot.
64 * If pdev is OHCI or UHCI then we are looking for EHCI, and
68 for_each_pci_dev(companion) {
69 if (companion->bus != pdev->bus ||
70 PCI_SLOT(companion->devfn) != slot)
73 companion_hcd = pci_get_drvdata(companion);
77 /* For SET_HS_COMPANION, store a pointer to the EHCI bus in
78 * the OHCI/UHCI companion bus structure.
79 * For CLEAR_HS_COMPANION, clear the pointer to the EHCI bus
80 * in the OHCI/UHCI companion bus structure.
81 * For WAIT_FOR_COMPANIONS, wait until the OHCI/UHCI
82 * companion controllers have fully resumed.
85 if ((pdev->class == CL_OHCI || pdev->class == CL_UHCI) &&
86 companion->class == CL_EHCI) {
87 /* action must be SET_HS_COMPANION */
88 dev_dbg(&companion->dev, "HS companion for %s\n",
89 dev_name(&pdev->dev));
90 hcd->self.hs_companion = &companion_hcd->self;
92 } else if (pdev->class == CL_EHCI &&
93 (companion->class == CL_OHCI ||
94 companion->class == CL_UHCI)) {
96 case SET_HS_COMPANION:
97 dev_dbg(&pdev->dev, "HS companion for %s\n",
98 dev_name(&companion->dev));
99 companion_hcd->self.hs_companion = &hcd->self;
101 case CLEAR_HS_COMPANION:
102 companion_hcd->self.hs_companion = NULL;
104 case WAIT_FOR_COMPANIONS:
105 device_pm_wait_for_dev(&pdev->dev,
113 static void set_hs_companion(struct pci_dev *pdev, struct usb_hcd *hcd)
115 mutex_lock(&companions_mutex);
116 dev_set_drvdata(&pdev->dev, hcd);
117 companion_common(pdev, hcd, SET_HS_COMPANION);
118 mutex_unlock(&companions_mutex);
121 static void clear_hs_companion(struct pci_dev *pdev, struct usb_hcd *hcd)
123 mutex_lock(&companions_mutex);
124 dev_set_drvdata(&pdev->dev, NULL);
126 /* If pdev is OHCI or UHCI, just clear its hs_companion pointer */
127 if (pdev->class == CL_OHCI || pdev->class == CL_UHCI)
128 hcd->self.hs_companion = NULL;
130 /* Otherwise search for companion buses and clear their pointers */
132 companion_common(pdev, hcd, CLEAR_HS_COMPANION);
133 mutex_unlock(&companions_mutex);
136 static void wait_for_companions(struct pci_dev *pdev, struct usb_hcd *hcd)
138 /* Only EHCI controllers need to wait.
139 * No locking is needed because a controller cannot be resumed
140 * while one of its companions is getting unbound.
142 if (pdev->class == CL_EHCI)
143 companion_common(pdev, hcd, WAIT_FOR_COMPANIONS);
146 #else /* !CONFIG_PM_SLEEP */
148 static inline void set_hs_companion(struct pci_dev *d, struct usb_hcd *h) {}
149 static inline void clear_hs_companion(struct pci_dev *d, struct usb_hcd *h) {}
150 static inline void wait_for_companions(struct pci_dev *d, struct usb_hcd *h) {}
152 #endif /* !CONFIG_PM_SLEEP */
154 /*-------------------------------------------------------------------------*/
156 /* configure so an HC device and id are always provided */
157 /* always called with process context; sleeping is OK */
160 * usb_hcd_pci_probe - initialize PCI-based HCDs
161 * @dev: USB Host Controller being probed
162 * @id: pci hotplug id connecting controller to HCD framework
163 * Context: !in_interrupt()
165 * Allocates basic PCI resources for this USB host controller, and
166 * then invokes the start() method for the HCD associated with it
167 * through the hotplug entry's driver_data.
169 * Store this function in the HCD's struct pci_driver as probe().
171 int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
173 struct hc_driver *driver;
182 driver = (struct hc_driver *)id->driver_data;
186 if (pci_enable_device(dev) < 0)
188 dev->current_state = PCI_D0;
190 /* The xHCI driver supports MSI and MSI-X,
191 * so don't fail if the BIOS doesn't provide a legacy IRQ.
193 if (!dev->irq && (driver->flags & HCD_MASK) != HCD_USB3) {
195 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
201 hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
207 if (driver->flags & HCD_MEMORY) {
209 hcd->rsrc_start = pci_resource_start(dev, 0);
210 hcd->rsrc_len = pci_resource_len(dev, 0);
211 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
212 driver->description)) {
213 dev_dbg(&dev->dev, "controller already in use\n");
215 goto clear_companion;
217 hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
218 if (hcd->regs == NULL) {
219 dev_dbg(&dev->dev, "error mapping memory\n");
221 goto release_mem_region;
228 for (region = 0; region < PCI_ROM_RESOURCE; region++) {
229 if (!(pci_resource_flags(dev, region) &
233 hcd->rsrc_start = pci_resource_start(dev, region);
234 hcd->rsrc_len = pci_resource_len(dev, region);
235 if (request_region(hcd->rsrc_start, hcd->rsrc_len,
236 driver->description))
239 if (region == PCI_ROM_RESOURCE) {
240 dev_dbg(&dev->dev, "no i/o regions available\n");
242 goto clear_companion;
248 retval = usb_add_hcd(hcd, dev->irq, IRQF_SHARED);
250 goto unmap_registers;
251 set_hs_companion(dev, hcd);
253 if (pci_dev_run_wake(dev))
254 pm_runtime_put_noidle(&dev->dev);
258 if (driver->flags & HCD_MEMORY) {
261 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
263 release_region(hcd->rsrc_start, hcd->rsrc_len);
265 clear_hs_companion(dev, hcd);
268 pci_disable_device(dev);
269 dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
272 EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
275 /* may be called without controller electrically present */
276 /* may be called with controller, bus, and devices active */
279 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
280 * @dev: USB Host Controller being removed
281 * Context: !in_interrupt()
283 * Reverses the effect of usb_hcd_pci_probe(), first invoking
284 * the HCD's stop() method. It is always called from a thread
285 * context, normally "rmmod", "apmd", or something similar.
287 * Store this function in the HCD's struct pci_driver as remove().
289 void usb_hcd_pci_remove(struct pci_dev *dev)
293 hcd = pci_get_drvdata(dev);
297 if (pci_dev_run_wake(dev))
298 pm_runtime_get_noresume(&dev->dev);
300 /* Fake an interrupt request in order to give the driver a chance
301 * to test whether the controller hardware has been removed (e.g.,
302 * cardbus physical eject).
309 if (hcd->driver->flags & HCD_MEMORY) {
311 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
313 release_region(hcd->rsrc_start, hcd->rsrc_len);
315 clear_hs_companion(dev, hcd);
317 pci_disable_device(dev);
319 EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
322 * usb_hcd_pci_shutdown - shutdown host controller
323 * @dev: USB Host Controller being shutdown
325 void usb_hcd_pci_shutdown(struct pci_dev *dev)
329 hcd = pci_get_drvdata(dev);
333 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
334 hcd->driver->shutdown) {
335 hcd->driver->shutdown(hcd);
336 pci_disable_device(dev);
339 EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
343 #ifdef CONFIG_PPC_PMAC
344 static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
346 /* Enanble or disable ASIC clocks for USB */
347 if (machine_is(powermac)) {
348 struct device_node *of_node;
350 of_node = pci_device_to_OF_node(pci_dev);
352 pmac_call_feature(PMAC_FTR_USB_ENABLE,
359 static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
362 #endif /* CONFIG_PPC_PMAC */
364 static int check_root_hub_suspended(struct device *dev)
366 struct pci_dev *pci_dev = to_pci_dev(dev);
367 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
369 if (HCD_RH_RUNNING(hcd)) {
370 dev_warn(dev, "Root hub is not suspended\n");
373 if (hcd->shared_hcd) {
374 hcd = hcd->shared_hcd;
375 if (HCD_RH_RUNNING(hcd)) {
376 dev_warn(dev, "Secondary root hub is not suspended\n");
383 #if defined(CONFIG_PM_SLEEP) || defined(CONFIG_PM_RUNTIME)
384 static int suspend_common(struct device *dev, bool do_wakeup)
386 struct pci_dev *pci_dev = to_pci_dev(dev);
387 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
390 /* Root hub suspend should have stopped all downstream traffic,
391 * and all bus master traffic. And done so for both the interface
392 * and the stub usb_device (which we check here). But maybe it
393 * didn't; writing sysfs power/state files ignores such rules...
395 retval = check_root_hub_suspended(dev);
399 if (hcd->driver->pci_suspend && !HCD_DEAD(hcd)) {
400 /* Optimization: Don't suspend if a root-hub wakeup is
401 * pending and it would cause the HCD to wake up anyway.
403 if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
405 if (do_wakeup && hcd->shared_hcd &&
406 HCD_WAKEUP_PENDING(hcd->shared_hcd))
408 retval = hcd->driver->pci_suspend(hcd, do_wakeup);
409 suspend_report_result(hcd->driver->pci_suspend, retval);
411 /* Check again in case wakeup raced with pci_suspend */
412 if ((retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) ||
413 (retval == 0 && do_wakeup && hcd->shared_hcd &&
414 HCD_WAKEUP_PENDING(hcd->shared_hcd))) {
415 if (hcd->driver->pci_resume)
416 hcd->driver->pci_resume(hcd, false);
423 /* If MSI-X is enabled, the driver will have synchronized all vectors
424 * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
427 if (!hcd->msix_enabled)
428 synchronize_irq(pci_dev->irq);
430 /* Downstream ports from this root hub should already be quiesced, so
431 * there will be no DMA activity. Now we can shut down the upstream
432 * link (except maybe for PME# resume signaling). We'll enter a
433 * low power state during suspend_noirq, if the hardware allows.
435 pci_disable_device(pci_dev);
439 static int resume_common(struct device *dev, int event)
441 struct pci_dev *pci_dev = to_pci_dev(dev);
442 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
445 if (HCD_RH_RUNNING(hcd) ||
447 HCD_RH_RUNNING(hcd->shared_hcd))) {
448 dev_dbg(dev, "can't resume, not suspended!\n");
452 retval = pci_enable_device(pci_dev);
454 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
458 pci_set_master(pci_dev);
460 if (hcd->driver->pci_resume && !HCD_DEAD(hcd)) {
461 if (event != PM_EVENT_AUTO_RESUME)
462 wait_for_companions(pci_dev, hcd);
464 retval = hcd->driver->pci_resume(hcd,
465 event == PM_EVENT_RESTORE);
467 dev_err(dev, "PCI post-resume error %d!\n", retval);
469 usb_hc_died(hcd->shared_hcd);
475 #endif /* SLEEP || RUNTIME */
477 #ifdef CONFIG_PM_SLEEP
479 static int hcd_pci_suspend(struct device *dev)
481 return suspend_common(dev, device_may_wakeup(dev));
484 static int hcd_pci_suspend_noirq(struct device *dev)
486 struct pci_dev *pci_dev = to_pci_dev(dev);
487 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
490 retval = check_root_hub_suspended(dev);
494 pci_save_state(pci_dev);
496 /* If the root hub is dead rather than suspended, disallow remote
497 * wakeup. usb_hc_died() should ensure that both hosts are marked as
498 * dying, so we only need to check the primary roothub.
501 device_set_wakeup_enable(dev, 0);
502 dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
504 /* Possibly enable remote wakeup,
505 * choose the appropriate low-power state, and go to that state.
507 retval = pci_prepare_to_sleep(pci_dev);
508 if (retval == -EIO) { /* Low-power not supported */
509 dev_dbg(dev, "--> PCI D0 legacy\n");
511 } else if (retval == 0) {
512 dev_dbg(dev, "--> PCI %s\n",
513 pci_power_name(pci_dev->current_state));
515 suspend_report_result(pci_prepare_to_sleep, retval);
519 powermac_set_asic(pci_dev, 0);
523 static int hcd_pci_resume_noirq(struct device *dev)
525 struct pci_dev *pci_dev = to_pci_dev(dev);
527 powermac_set_asic(pci_dev, 1);
529 /* Go back to D0 and disable remote wakeup */
530 pci_back_from_sleep(pci_dev);
534 static int hcd_pci_resume(struct device *dev)
536 return resume_common(dev, PM_EVENT_RESUME);
539 static int hcd_pci_restore(struct device *dev)
541 return resume_common(dev, PM_EVENT_RESTORE);
546 #define hcd_pci_suspend NULL
547 #define hcd_pci_suspend_noirq NULL
548 #define hcd_pci_resume_noirq NULL
549 #define hcd_pci_resume NULL
550 #define hcd_pci_restore NULL
552 #endif /* CONFIG_PM_SLEEP */
554 #ifdef CONFIG_PM_RUNTIME
556 static int hcd_pci_runtime_suspend(struct device *dev)
560 retval = suspend_common(dev, true);
562 powermac_set_asic(to_pci_dev(dev), 0);
563 dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
567 static int hcd_pci_runtime_resume(struct device *dev)
571 powermac_set_asic(to_pci_dev(dev), 1);
572 retval = resume_common(dev, PM_EVENT_AUTO_RESUME);
573 dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
579 #define hcd_pci_runtime_suspend NULL
580 #define hcd_pci_runtime_resume NULL
582 #endif /* CONFIG_PM_RUNTIME */
584 const struct dev_pm_ops usb_hcd_pci_pm_ops = {
585 .suspend = hcd_pci_suspend,
586 .suspend_noirq = hcd_pci_suspend_noirq,
587 .resume_noirq = hcd_pci_resume_noirq,
588 .resume = hcd_pci_resume,
589 .freeze = check_root_hub_suspended,
590 .freeze_noirq = check_root_hub_suspended,
593 .poweroff = hcd_pci_suspend,
594 .poweroff_noirq = hcd_pci_suspend_noirq,
595 .restore_noirq = hcd_pci_resume_noirq,
596 .restore = hcd_pci_restore,
597 .runtime_suspend = hcd_pci_runtime_suspend,
598 .runtime_resume = hcd_pci_runtime_resume,
600 EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
602 #endif /* CONFIG_PM */