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 */
41 * Coordinate handoffs between EHCI and companion controllers
42 * during EHCI probing and system resume.
45 static DECLARE_RWSEM(companions_rwsem
);
47 #define CL_UHCI PCI_CLASS_SERIAL_USB_UHCI
48 #define CL_OHCI PCI_CLASS_SERIAL_USB_OHCI
49 #define CL_EHCI PCI_CLASS_SERIAL_USB_EHCI
51 static inline int is_ohci_or_uhci(struct pci_dev
*pdev
)
53 return pdev
->class == CL_OHCI
|| pdev
->class == CL_UHCI
;
56 typedef void (*companion_fn
)(struct pci_dev
*pdev
, struct usb_hcd
*hcd
,
57 struct pci_dev
*companion
, struct usb_hcd
*companion_hcd
);
59 /* Iterate over PCI devices in the same slot as pdev and call fn for each */
60 static void for_each_companion(struct pci_dev
*pdev
, struct usb_hcd
*hcd
,
63 struct pci_dev
*companion
;
64 struct usb_hcd
*companion_hcd
;
65 unsigned int slot
= PCI_SLOT(pdev
->devfn
);
68 * Iterate through other PCI functions in the same slot.
69 * If the function's drvdata isn't set then it isn't bound to
70 * a USB host controller driver, so skip it.
73 for_each_pci_dev(companion
) {
74 if (companion
->bus
!= pdev
->bus
||
75 PCI_SLOT(companion
->devfn
) != slot
)
77 companion_hcd
= pci_get_drvdata(companion
);
80 fn(pdev
, hcd
, companion
, companion_hcd
);
85 * We're about to add an EHCI controller, which will unceremoniously grab
86 * all the port connections away from its companions. To prevent annoying
87 * error messages, lock the companion's root hub and gracefully unconfigure
88 * it beforehand. Leave it locked until the EHCI controller is all set.
90 static void ehci_pre_add(struct pci_dev
*pdev
, struct usb_hcd
*hcd
,
91 struct pci_dev
*companion
, struct usb_hcd
*companion_hcd
)
93 struct usb_device
*udev
;
95 if (is_ohci_or_uhci(companion
)) {
96 udev
= companion_hcd
->self
.root_hub
;
97 usb_lock_device(udev
);
98 usb_set_configuration(udev
, 0);
103 * Adding the EHCI controller has either succeeded or failed. Set the
104 * companion pointer accordingly, and in either case, reconfigure and
105 * unlock the root hub.
107 static void ehci_post_add(struct pci_dev
*pdev
, struct usb_hcd
*hcd
,
108 struct pci_dev
*companion
, struct usb_hcd
*companion_hcd
)
110 struct usb_device
*udev
;
112 if (is_ohci_or_uhci(companion
)) {
113 if (dev_get_drvdata(&pdev
->dev
)) { /* Succeeded */
114 dev_dbg(&pdev
->dev
, "HS companion for %s\n",
115 dev_name(&companion
->dev
));
116 companion_hcd
->self
.hs_companion
= &hcd
->self
;
118 udev
= companion_hcd
->self
.root_hub
;
119 usb_set_configuration(udev
, 1);
120 usb_unlock_device(udev
);
125 * We just added a non-EHCI controller. Find the EHCI controller to
126 * which it is a companion, and store a pointer to the bus structure.
128 static void non_ehci_add(struct pci_dev
*pdev
, struct usb_hcd
*hcd
,
129 struct pci_dev
*companion
, struct usb_hcd
*companion_hcd
)
131 if (is_ohci_or_uhci(pdev
) && companion
->class == CL_EHCI
) {
132 dev_dbg(&pdev
->dev
, "FS/LS companion for %s\n",
133 dev_name(&companion
->dev
));
134 hcd
->self
.hs_companion
= &companion_hcd
->self
;
138 /* We are removing an EHCI controller. Clear the companions' pointers. */
139 static void ehci_remove(struct pci_dev
*pdev
, struct usb_hcd
*hcd
,
140 struct pci_dev
*companion
, struct usb_hcd
*companion_hcd
)
142 if (is_ohci_or_uhci(companion
))
143 companion_hcd
->self
.hs_companion
= NULL
;
148 /* An EHCI controller must wait for its companions before resuming. */
149 static void ehci_wait_for_companions(struct pci_dev
*pdev
, struct usb_hcd
*hcd
,
150 struct pci_dev
*companion
, struct usb_hcd
*companion_hcd
)
152 if (is_ohci_or_uhci(companion
))
153 device_pm_wait_for_dev(&pdev
->dev
, &companion
->dev
);
156 #endif /* CONFIG_PM */
158 /*-------------------------------------------------------------------------*/
160 /* configure so an HC device and id are always provided */
161 /* always called with process context; sleeping is OK */
164 * usb_hcd_pci_probe - initialize PCI-based HCDs
165 * @dev: USB Host Controller being probed
166 * @id: pci hotplug id connecting controller to HCD framework
167 * Context: !in_interrupt()
169 * Allocates basic PCI resources for this USB host controller, and
170 * then invokes the start() method for the HCD associated with it
171 * through the hotplug entry's driver_data.
173 * Store this function in the HCD's struct pci_driver as probe().
175 * Return: 0 if successful.
177 int usb_hcd_pci_probe(struct pci_dev
*dev
, const struct pci_device_id
*id
)
179 struct hc_driver
*driver
;
189 driver
= (struct hc_driver
*)id
->driver_data
;
193 if (pci_enable_device(dev
) < 0)
195 dev
->current_state
= PCI_D0
;
198 * The xHCI driver has its own irq management
199 * make sure irq setup is not touched for xhci in generic hcd code
201 if ((driver
->flags
& HCD_MASK
) != HCD_USB3
) {
204 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
212 hcd
= usb_create_hcd(driver
, &dev
->dev
, pci_name(dev
));
218 hcd
->amd_resume_bug
= (usb_hcd_amd_remote_wakeup_quirk(dev
) &&
219 driver
->flags
& (HCD_USB11
| HCD_USB3
)) ? 1 : 0;
221 if (driver
->flags
& HCD_MEMORY
) {
223 hcd
->rsrc_start
= pci_resource_start(dev
, 0);
224 hcd
->rsrc_len
= pci_resource_len(dev
, 0);
225 if (!request_mem_region(hcd
->rsrc_start
, hcd
->rsrc_len
,
226 driver
->description
)) {
227 dev_dbg(&dev
->dev
, "controller already in use\n");
231 hcd
->regs
= ioremap_nocache(hcd
->rsrc_start
, hcd
->rsrc_len
);
232 if (hcd
->regs
== NULL
) {
233 dev_dbg(&dev
->dev
, "error mapping memory\n");
235 goto release_mem_region
;
242 for (region
= 0; region
< PCI_ROM_RESOURCE
; region
++) {
243 if (!(pci_resource_flags(dev
, region
) &
247 hcd
->rsrc_start
= pci_resource_start(dev
, region
);
248 hcd
->rsrc_len
= pci_resource_len(dev
, region
);
249 if (request_region(hcd
->rsrc_start
, hcd
->rsrc_len
,
250 driver
->description
))
253 if (region
== PCI_ROM_RESOURCE
) {
254 dev_dbg(&dev
->dev
, "no i/o regions available\n");
262 /* Note: dev_set_drvdata must be called while holding the rwsem */
263 if (dev
->class == CL_EHCI
) {
264 down_write(&companions_rwsem
);
265 dev_set_drvdata(&dev
->dev
, hcd
);
266 for_each_companion(dev
, hcd
, ehci_pre_add
);
267 retval
= usb_add_hcd(hcd
, hcd_irq
, IRQF_SHARED
);
269 dev_set_drvdata(&dev
->dev
, NULL
);
270 for_each_companion(dev
, hcd
, ehci_post_add
);
271 up_write(&companions_rwsem
);
273 down_read(&companions_rwsem
);
274 dev_set_drvdata(&dev
->dev
, hcd
);
275 retval
= usb_add_hcd(hcd
, hcd_irq
, IRQF_SHARED
);
277 dev_set_drvdata(&dev
->dev
, NULL
);
279 for_each_companion(dev
, hcd
, non_ehci_add
);
280 up_read(&companions_rwsem
);
284 goto unmap_registers
;
285 device_wakeup_enable(hcd
->self
.controller
);
287 if (pci_dev_run_wake(dev
))
288 pm_runtime_put_noidle(&dev
->dev
);
292 if (driver
->flags
& HCD_MEMORY
) {
295 release_mem_region(hcd
->rsrc_start
, hcd
->rsrc_len
);
297 release_region(hcd
->rsrc_start
, hcd
->rsrc_len
);
301 pci_disable_device(dev
);
302 dev_err(&dev
->dev
, "init %s fail, %d\n", pci_name(dev
), retval
);
305 EXPORT_SYMBOL_GPL(usb_hcd_pci_probe
);
308 /* may be called without controller electrically present */
309 /* may be called with controller, bus, and devices active */
312 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
313 * @dev: USB Host Controller being removed
314 * Context: !in_interrupt()
316 * Reverses the effect of usb_hcd_pci_probe(), first invoking
317 * the HCD's stop() method. It is always called from a thread
318 * context, normally "rmmod", "apmd", or something similar.
320 * Store this function in the HCD's struct pci_driver as remove().
322 void usb_hcd_pci_remove(struct pci_dev
*dev
)
326 hcd
= pci_get_drvdata(dev
);
330 if (pci_dev_run_wake(dev
))
331 pm_runtime_get_noresume(&dev
->dev
);
333 /* Fake an interrupt request in order to give the driver a chance
334 * to test whether the controller hardware has been removed (e.g.,
335 * cardbus physical eject).
341 /* Note: dev_set_drvdata must be called while holding the rwsem */
342 if (dev
->class == CL_EHCI
) {
343 down_write(&companions_rwsem
);
344 for_each_companion(dev
, hcd
, ehci_remove
);
346 dev_set_drvdata(&dev
->dev
, NULL
);
347 up_write(&companions_rwsem
);
349 /* Not EHCI; just clear the companion pointer */
350 down_read(&companions_rwsem
);
351 hcd
->self
.hs_companion
= NULL
;
353 dev_set_drvdata(&dev
->dev
, NULL
);
354 up_read(&companions_rwsem
);
357 if (hcd
->driver
->flags
& HCD_MEMORY
) {
359 release_mem_region(hcd
->rsrc_start
, hcd
->rsrc_len
);
361 release_region(hcd
->rsrc_start
, hcd
->rsrc_len
);
365 pci_disable_device(dev
);
367 EXPORT_SYMBOL_GPL(usb_hcd_pci_remove
);
370 * usb_hcd_pci_shutdown - shutdown host controller
371 * @dev: USB Host Controller being shutdown
373 void usb_hcd_pci_shutdown(struct pci_dev
*dev
)
377 hcd
= pci_get_drvdata(dev
);
381 if (test_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
) &&
382 hcd
->driver
->shutdown
) {
383 hcd
->driver
->shutdown(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 #if defined(CONFIG_PM_SLEEP) || defined(CONFIG_PM_RUNTIME)
432 static int suspend_common(struct device
*dev
, bool do_wakeup
)
434 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
435 struct usb_hcd
*hcd
= pci_get_drvdata(pci_dev
);
438 /* Root hub suspend should have stopped all downstream traffic,
439 * and all bus master traffic. And done so for both the interface
440 * and the stub usb_device (which we check here). But maybe it
441 * didn't; writing sysfs power/state files ignores such rules...
443 retval
= check_root_hub_suspended(dev
);
447 if (hcd
->driver
->pci_suspend
&& !HCD_DEAD(hcd
)) {
448 /* Optimization: Don't suspend if a root-hub wakeup is
449 * pending and it would cause the HCD to wake up anyway.
451 if (do_wakeup
&& HCD_WAKEUP_PENDING(hcd
))
453 if (do_wakeup
&& hcd
->shared_hcd
&&
454 HCD_WAKEUP_PENDING(hcd
->shared_hcd
))
456 retval
= hcd
->driver
->pci_suspend(hcd
, do_wakeup
);
457 suspend_report_result(hcd
->driver
->pci_suspend
, retval
);
459 /* Check again in case wakeup raced with pci_suspend */
460 if ((retval
== 0 && do_wakeup
&& HCD_WAKEUP_PENDING(hcd
)) ||
461 (retval
== 0 && do_wakeup
&& hcd
->shared_hcd
&&
462 HCD_WAKEUP_PENDING(hcd
->shared_hcd
))) {
463 if (hcd
->driver
->pci_resume
)
464 hcd
->driver
->pci_resume(hcd
, false);
471 /* If MSI-X is enabled, the driver will have synchronized all vectors
472 * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
475 if (!hcd
->msix_enabled
)
476 synchronize_irq(pci_dev
->irq
);
478 /* Downstream ports from this root hub should already be quiesced, so
479 * there will be no DMA activity. Now we can shut down the upstream
480 * link (except maybe for PME# resume signaling). We'll enter a
481 * low power state during suspend_noirq, if the hardware allows.
483 pci_disable_device(pci_dev
);
487 static int resume_common(struct device
*dev
, int event
)
489 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
490 struct usb_hcd
*hcd
= pci_get_drvdata(pci_dev
);
493 if (HCD_RH_RUNNING(hcd
) ||
495 HCD_RH_RUNNING(hcd
->shared_hcd
))) {
496 dev_dbg(dev
, "can't resume, not suspended!\n");
500 retval
= pci_enable_device(pci_dev
);
502 dev_err(dev
, "can't re-enable after resume, %d!\n", retval
);
506 pci_set_master(pci_dev
);
508 if (hcd
->driver
->pci_resume
&& !HCD_DEAD(hcd
)) {
511 * Only EHCI controllers have to wait for their companions.
512 * No locking is needed because PCI controller drivers do not
513 * get unbound during system resume.
515 if (pci_dev
->class == CL_EHCI
&& event
!= PM_EVENT_AUTO_RESUME
)
516 for_each_companion(pci_dev
, hcd
,
517 ehci_wait_for_companions
);
519 retval
= hcd
->driver
->pci_resume(hcd
,
520 event
== PM_EVENT_RESTORE
);
522 dev_err(dev
, "PCI post-resume error %d!\n", retval
);
524 usb_hc_died(hcd
->shared_hcd
);
530 #endif /* SLEEP || RUNTIME */
532 #ifdef CONFIG_PM_SLEEP
534 static int hcd_pci_suspend(struct device
*dev
)
536 return suspend_common(dev
, device_may_wakeup(dev
));
539 static int hcd_pci_suspend_noirq(struct device
*dev
)
541 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
542 struct usb_hcd
*hcd
= pci_get_drvdata(pci_dev
);
545 retval
= check_root_hub_suspended(dev
);
549 pci_save_state(pci_dev
);
551 /* If the root hub is dead rather than suspended, disallow remote
552 * wakeup. usb_hc_died() should ensure that both hosts are marked as
553 * dying, so we only need to check the primary roothub.
556 device_set_wakeup_enable(dev
, 0);
557 dev_dbg(dev
, "wakeup: %d\n", device_may_wakeup(dev
));
559 /* Possibly enable remote wakeup,
560 * choose the appropriate low-power state, and go to that state.
562 retval
= pci_prepare_to_sleep(pci_dev
);
563 if (retval
== -EIO
) { /* Low-power not supported */
564 dev_dbg(dev
, "--> PCI D0 legacy\n");
566 } else if (retval
== 0) {
567 dev_dbg(dev
, "--> PCI %s\n",
568 pci_power_name(pci_dev
->current_state
));
570 suspend_report_result(pci_prepare_to_sleep
, retval
);
574 powermac_set_asic(pci_dev
, 0);
578 static int hcd_pci_resume_noirq(struct device
*dev
)
580 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
582 powermac_set_asic(pci_dev
, 1);
584 /* Go back to D0 and disable remote wakeup */
585 pci_back_from_sleep(pci_dev
);
589 static int hcd_pci_resume(struct device
*dev
)
591 return resume_common(dev
, PM_EVENT_RESUME
);
594 static int hcd_pci_restore(struct device
*dev
)
596 return resume_common(dev
, PM_EVENT_RESTORE
);
601 #define hcd_pci_suspend NULL
602 #define hcd_pci_suspend_noirq NULL
603 #define hcd_pci_resume_noirq NULL
604 #define hcd_pci_resume NULL
605 #define hcd_pci_restore NULL
607 #endif /* CONFIG_PM_SLEEP */
609 #ifdef CONFIG_PM_RUNTIME
611 static int hcd_pci_runtime_suspend(struct device
*dev
)
615 retval
= suspend_common(dev
, true);
617 powermac_set_asic(to_pci_dev(dev
), 0);
618 dev_dbg(dev
, "hcd_pci_runtime_suspend: %d\n", retval
);
622 static int hcd_pci_runtime_resume(struct device
*dev
)
626 powermac_set_asic(to_pci_dev(dev
), 1);
627 retval
= resume_common(dev
, PM_EVENT_AUTO_RESUME
);
628 dev_dbg(dev
, "hcd_pci_runtime_resume: %d\n", retval
);
634 #define hcd_pci_runtime_suspend NULL
635 #define hcd_pci_runtime_resume NULL
637 #endif /* CONFIG_PM_RUNTIME */
639 const struct dev_pm_ops usb_hcd_pci_pm_ops
= {
640 .suspend
= hcd_pci_suspend
,
641 .suspend_noirq
= hcd_pci_suspend_noirq
,
642 .resume_noirq
= hcd_pci_resume_noirq
,
643 .resume
= hcd_pci_resume
,
644 .freeze
= check_root_hub_suspended
,
645 .freeze_noirq
= check_root_hub_suspended
,
648 .poweroff
= hcd_pci_suspend
,
649 .poweroff_noirq
= hcd_pci_suspend_noirq
,
650 .restore_noirq
= hcd_pci_resume_noirq
,
651 .restore
= hcd_pci_restore
,
652 .runtime_suspend
= hcd_pci_runtime_suspend
,
653 .runtime_resume
= hcd_pci_runtime_resume
,
655 EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops
);
657 #endif /* CONFIG_PM */