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;
192 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
198 hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
204 if (driver->flags & HCD_MEMORY) {
206 hcd->rsrc_start = pci_resource_start(dev, 0);
207 hcd->rsrc_len = pci_resource_len(dev, 0);
208 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
209 driver->description)) {
210 dev_dbg(&dev->dev, "controller already in use\n");
214 hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
215 if (hcd->regs == NULL) {
216 dev_dbg(&dev->dev, "error mapping memory\n");
225 for (region = 0; region < PCI_ROM_RESOURCE; region++) {
226 if (!(pci_resource_flags(dev, region) &
230 hcd->rsrc_start = pci_resource_start(dev, region);
231 hcd->rsrc_len = pci_resource_len(dev, region);
232 if (request_region(hcd->rsrc_start, hcd->rsrc_len,
233 driver->description))
236 if (region == PCI_ROM_RESOURCE) {
237 dev_dbg(&dev->dev, "no i/o regions available\n");
245 retval = usb_add_hcd(hcd, dev->irq, IRQF_DISABLED | IRQF_SHARED);
248 set_hs_companion(dev, hcd);
250 if (pci_dev_run_wake(dev))
251 pm_runtime_put_noidle(&dev->dev);
255 if (driver->flags & HCD_MEMORY) {
258 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
260 release_region(hcd->rsrc_start, hcd->rsrc_len);
262 clear_hs_companion(dev, hcd);
265 pci_disable_device(dev);
266 dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
269 EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
272 /* may be called without controller electrically present */
273 /* may be called with controller, bus, and devices active */
276 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
277 * @dev: USB Host Controller being removed
278 * Context: !in_interrupt()
280 * Reverses the effect of usb_hcd_pci_probe(), first invoking
281 * the HCD's stop() method. It is always called from a thread
282 * context, normally "rmmod", "apmd", or something similar.
284 * Store this function in the HCD's struct pci_driver as remove().
286 void usb_hcd_pci_remove(struct pci_dev *dev)
290 hcd = pci_get_drvdata(dev);
294 if (pci_dev_run_wake(dev))
295 pm_runtime_get_noresume(&dev->dev);
297 /* Fake an interrupt request in order to give the driver a chance
298 * to test whether the controller hardware has been removed (e.g.,
299 * cardbus physical eject).
306 if (hcd->driver->flags & HCD_MEMORY) {
308 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
310 release_region(hcd->rsrc_start, hcd->rsrc_len);
312 clear_hs_companion(dev, hcd);
314 pci_disable_device(dev);
316 EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
319 * usb_hcd_pci_shutdown - shutdown host controller
320 * @dev: USB Host Controller being shutdown
322 void usb_hcd_pci_shutdown(struct pci_dev *dev)
326 hcd = pci_get_drvdata(dev);
330 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
331 hcd->driver->shutdown) {
332 hcd->driver->shutdown(hcd);
333 pci_disable_device(dev);
336 EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
340 #ifdef CONFIG_PPC_PMAC
341 static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
343 /* Enanble or disable ASIC clocks for USB */
344 if (machine_is(powermac)) {
345 struct device_node *of_node;
347 of_node = pci_device_to_OF_node(pci_dev);
349 pmac_call_feature(PMAC_FTR_USB_ENABLE,
356 static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
359 #endif /* CONFIG_PPC_PMAC */
361 static int check_root_hub_suspended(struct device *dev)
363 struct pci_dev *pci_dev = to_pci_dev(dev);
364 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
366 if (!(hcd->state == HC_STATE_SUSPENDED ||
367 hcd->state == HC_STATE_HALT)) {
368 dev_warn(dev, "Root hub is not suspended\n");
374 static int suspend_common(struct device *dev, bool do_wakeup)
376 struct pci_dev *pci_dev = to_pci_dev(dev);
377 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
380 /* Root hub suspend should have stopped all downstream traffic,
381 * and all bus master traffic. And done so for both the interface
382 * and the stub usb_device (which we check here). But maybe it
383 * didn't; writing sysfs power/state files ignores such rules...
385 retval = check_root_hub_suspended(dev);
389 if (hcd->driver->pci_suspend) {
390 /* Optimization: Don't suspend if a root-hub wakeup is
391 * pending and it would cause the HCD to wake up anyway.
393 if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
395 retval = hcd->driver->pci_suspend(hcd, do_wakeup);
396 suspend_report_result(hcd->driver->pci_suspend, retval);
398 /* Check again in case wakeup raced with pci_suspend */
399 if (retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) {
400 if (hcd->driver->pci_resume)
401 hcd->driver->pci_resume(hcd, false);
408 synchronize_irq(pci_dev->irq);
410 /* Downstream ports from this root hub should already be quiesced, so
411 * there will be no DMA activity. Now we can shut down the upstream
412 * link (except maybe for PME# resume signaling). We'll enter a
413 * low power state during suspend_noirq, if the hardware allows.
415 pci_disable_device(pci_dev);
419 static int resume_common(struct device *dev, int event)
421 struct pci_dev *pci_dev = to_pci_dev(dev);
422 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
425 if (hcd->state != HC_STATE_SUSPENDED) {
426 dev_dbg(dev, "can't resume, not suspended!\n");
430 retval = pci_enable_device(pci_dev);
432 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
436 pci_set_master(pci_dev);
438 clear_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
440 if (hcd->driver->pci_resume) {
441 if (event != PM_EVENT_AUTO_RESUME)
442 wait_for_companions(pci_dev, hcd);
444 retval = hcd->driver->pci_resume(hcd,
445 event == PM_EVENT_RESTORE);
447 dev_err(dev, "PCI post-resume error %d!\n", retval);
454 #ifdef CONFIG_PM_SLEEP
456 static int hcd_pci_suspend(struct device *dev)
458 return suspend_common(dev, device_may_wakeup(dev));
461 static int hcd_pci_suspend_noirq(struct device *dev)
463 struct pci_dev *pci_dev = to_pci_dev(dev);
464 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
467 retval = check_root_hub_suspended(dev);
471 pci_save_state(pci_dev);
473 /* If the root hub is HALTed rather than SUSPENDed,
474 * disallow remote wakeup.
476 if (hcd->state == HC_STATE_HALT)
477 device_set_wakeup_enable(dev, 0);
478 dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
480 /* Possibly enable remote wakeup,
481 * choose the appropriate low-power state, and go to that state.
483 retval = pci_prepare_to_sleep(pci_dev);
484 if (retval == -EIO) { /* Low-power not supported */
485 dev_dbg(dev, "--> PCI D0 legacy\n");
487 } else if (retval == 0) {
488 dev_dbg(dev, "--> PCI %s\n",
489 pci_power_name(pci_dev->current_state));
491 suspend_report_result(pci_prepare_to_sleep, retval);
495 powermac_set_asic(pci_dev, 0);
499 static int hcd_pci_resume_noirq(struct device *dev)
501 struct pci_dev *pci_dev = to_pci_dev(dev);
503 powermac_set_asic(pci_dev, 1);
505 /* Go back to D0 and disable remote wakeup */
506 pci_back_from_sleep(pci_dev);
510 static int hcd_pci_resume(struct device *dev)
512 return resume_common(dev, PM_EVENT_RESUME);
515 static int hcd_pci_restore(struct device *dev)
517 return resume_common(dev, PM_EVENT_RESTORE);
522 #define hcd_pci_suspend NULL
523 #define hcd_pci_suspend_noirq NULL
524 #define hcd_pci_resume_noirq NULL
525 #define hcd_pci_resume NULL
526 #define hcd_pci_restore NULL
528 #endif /* CONFIG_PM_SLEEP */
530 #ifdef CONFIG_PM_RUNTIME
532 static int hcd_pci_runtime_suspend(struct device *dev)
536 retval = suspend_common(dev, true);
538 powermac_set_asic(to_pci_dev(dev), 0);
539 dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
543 static int hcd_pci_runtime_resume(struct device *dev)
547 powermac_set_asic(to_pci_dev(dev), 1);
548 retval = resume_common(dev, PM_EVENT_AUTO_RESUME);
549 dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
555 #define hcd_pci_runtime_suspend NULL
556 #define hcd_pci_runtime_resume NULL
558 #endif /* CONFIG_PM_RUNTIME */
560 const struct dev_pm_ops usb_hcd_pci_pm_ops = {
561 .suspend = hcd_pci_suspend,
562 .suspend_noirq = hcd_pci_suspend_noirq,
563 .resume_noirq = hcd_pci_resume_noirq,
564 .resume = hcd_pci_resume,
565 .freeze = check_root_hub_suspended,
566 .freeze_noirq = check_root_hub_suspended,
569 .poweroff = hcd_pci_suspend,
570 .poweroff_noirq = hcd_pci_suspend_noirq,
571 .restore_noirq = hcd_pci_resume_noirq,
572 .restore = hcd_pci_restore,
573 .runtime_suspend = hcd_pci_runtime_suspend,
574 .runtime_resume = hcd_pci_runtime_resume,
576 EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
578 #endif /* CONFIG_PM_OPS */