Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * (C) Copyright David Brownell 2000-2002
4 */
5
6#include <linux/kernel.h>
7#include <linux/module.h>
8#include <linux/pci.h>
9#include <linux/usb.h>
10#include <linux/usb/hcd.h>
11
12#include <asm/io.h>
13#include <asm/irq.h>
14
15#ifdef CONFIG_PPC_PMAC
16#include <asm/machdep.h>
17#include <asm/pmac_feature.h>
18#endif
19
20#include "usb.h"
21
22
23/* PCI-based HCs are common, but plenty of non-PCI HCs are used too */
24
25/*
26 * Coordinate handoffs between EHCI and companion controllers
27 * during EHCI probing and system resume.
28 */
29
30static DECLARE_RWSEM(companions_rwsem);
31
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
35
36static inline int is_ohci_or_uhci(struct pci_dev *pdev)
37{
38 return pdev->class == CL_OHCI || pdev->class == CL_UHCI;
39}
40
41typedef void (*companion_fn)(struct pci_dev *pdev, struct usb_hcd *hcd,
42 struct pci_dev *companion, struct usb_hcd *companion_hcd);
43
44/* Iterate over PCI devices in the same slot as pdev and call fn for each */
45static void for_each_companion(struct pci_dev *pdev, struct usb_hcd *hcd,
46 companion_fn fn)
47{
48 struct pci_dev *companion;
49 struct usb_hcd *companion_hcd;
50 unsigned int slot = PCI_SLOT(pdev->devfn);
51
52 /*
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.
56 */
57 companion = NULL;
58 for_each_pci_dev(companion) {
59 if (companion->bus != pdev->bus ||
60 PCI_SLOT(companion->devfn) != slot)
61 continue;
62
63 /*
64 * Companion device should be either UHCI,OHCI or EHCI host
65 * controller, otherwise skip.
66 */
67 if (companion->class != CL_UHCI && companion->class != CL_OHCI &&
68 companion->class != CL_EHCI)
69 continue;
70
71 companion_hcd = pci_get_drvdata(companion);
72 if (!companion_hcd || !companion_hcd->self.root_hub)
73 continue;
74 fn(pdev, hcd, companion, companion_hcd);
75 }
76}
77
78/*
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.
83 */
84static void ehci_pre_add(struct pci_dev *pdev, struct usb_hcd *hcd,
85 struct pci_dev *companion, struct usb_hcd *companion_hcd)
86{
87 struct usb_device *udev;
88
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);
93 }
94}
95
96/*
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.
100 */
101static void ehci_post_add(struct pci_dev *pdev, struct usb_hcd *hcd,
102 struct pci_dev *companion, struct usb_hcd *companion_hcd)
103{
104 struct usb_device *udev;
105
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;
111 }
112 udev = companion_hcd->self.root_hub;
113 usb_set_configuration(udev, 1);
114 usb_unlock_device(udev);
115 }
116}
117
118/*
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.
121 */
122static void non_ehci_add(struct pci_dev *pdev, struct usb_hcd *hcd,
123 struct pci_dev *companion, struct usb_hcd *companion_hcd)
124{
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;
129 }
130}
131
132/* We are removing an EHCI controller. Clear the companions' pointers. */
133static void ehci_remove(struct pci_dev *pdev, struct usb_hcd *hcd,
134 struct pci_dev *companion, struct usb_hcd *companion_hcd)
135{
136 if (is_ohci_or_uhci(companion))
137 companion_hcd->self.hs_companion = NULL;
138}
139
140#ifdef CONFIG_PM
141
142/* An EHCI controller must wait for its companions before resuming. */
143static void ehci_wait_for_companions(struct pci_dev *pdev, struct usb_hcd *hcd,
144 struct pci_dev *companion, struct usb_hcd *companion_hcd)
145{
146 if (is_ohci_or_uhci(companion))
147 device_pm_wait_for_dev(&pdev->dev, &companion->dev);
148}
149
150#endif /* CONFIG_PM */
151
152/*-------------------------------------------------------------------------*/
153
154/* configure so an HC device and id are always provided */
155/* always called with process context; sleeping is OK */
156
157/**
158 * usb_hcd_pci_probe - initialize PCI-based HCDs
159 * @dev: USB Host Controller being probed
160 * @driver: USB HC driver handle
161 *
162 * Context: task context, might sleep
163 *
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.
167 *
168 * Store this function in the HCD's struct pci_driver as probe().
169 *
170 * Return: 0 if successful.
171 */
172int usb_hcd_pci_probe(struct pci_dev *dev, const struct hc_driver *driver)
173{
174 struct usb_hcd *hcd;
175 int retval;
176 int hcd_irq = 0;
177
178 if (usb_disabled())
179 return -ENODEV;
180
181 if (!driver)
182 return -EINVAL;
183
184 if (pci_enable_device(dev) < 0)
185 return -ENODEV;
186
187 /*
188 * The xHCI driver has its own irq management
189 * make sure irq setup is not touched for xhci in generic hcd code
190 */
191 if ((driver->flags & HCD_MASK) < HCD_USB3) {
192 retval = pci_alloc_irq_vectors(dev, 1, 1, PCI_IRQ_LEGACY | PCI_IRQ_MSI);
193 if (retval < 0) {
194 dev_err(&dev->dev,
195 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
196 pci_name(dev));
197 retval = -ENODEV;
198 goto disable_pci;
199 }
200 hcd_irq = pci_irq_vector(dev, 0);
201 }
202
203 hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
204 if (!hcd) {
205 retval = -ENOMEM;
206 goto free_irq_vectors;
207 }
208
209 hcd->amd_resume_bug = usb_hcd_amd_resume_bug(dev, driver);
210
211 if (driver->flags & HCD_MEMORY) {
212 /* EHCI, OHCI */
213 hcd->rsrc_start = pci_resource_start(dev, 0);
214 hcd->rsrc_len = pci_resource_len(dev, 0);
215 if (!devm_request_mem_region(&dev->dev, hcd->rsrc_start,
216 hcd->rsrc_len, driver->description)) {
217 dev_dbg(&dev->dev, "controller already in use\n");
218 retval = -EBUSY;
219 goto put_hcd;
220 }
221 hcd->regs = devm_ioremap(&dev->dev, hcd->rsrc_start,
222 hcd->rsrc_len);
223 if (hcd->regs == NULL) {
224 dev_dbg(&dev->dev, "error mapping memory\n");
225 retval = -EFAULT;
226 goto put_hcd;
227 }
228
229 } else {
230 /* UHCI */
231 int region;
232
233 for (region = 0; region < PCI_STD_NUM_BARS; region++) {
234 if (!(pci_resource_flags(dev, region) &
235 IORESOURCE_IO))
236 continue;
237
238 hcd->rsrc_start = pci_resource_start(dev, region);
239 hcd->rsrc_len = pci_resource_len(dev, region);
240 if (devm_request_region(&dev->dev, hcd->rsrc_start,
241 hcd->rsrc_len, driver->description))
242 break;
243 }
244 if (region == PCI_STD_NUM_BARS) {
245 dev_dbg(&dev->dev, "no i/o regions available\n");
246 retval = -EBUSY;
247 goto put_hcd;
248 }
249 }
250
251 pci_set_master(dev);
252
253 /* Note: dev_set_drvdata must be called while holding the rwsem */
254 if (dev->class == CL_EHCI) {
255 down_write(&companions_rwsem);
256 dev_set_drvdata(&dev->dev, hcd);
257 for_each_companion(dev, hcd, ehci_pre_add);
258 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
259 if (retval != 0)
260 dev_set_drvdata(&dev->dev, NULL);
261 for_each_companion(dev, hcd, ehci_post_add);
262 up_write(&companions_rwsem);
263 } else {
264 down_read(&companions_rwsem);
265 dev_set_drvdata(&dev->dev, hcd);
266 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
267 if (retval != 0)
268 dev_set_drvdata(&dev->dev, NULL);
269 else
270 for_each_companion(dev, hcd, non_ehci_add);
271 up_read(&companions_rwsem);
272 }
273
274 if (retval != 0)
275 goto put_hcd;
276 device_wakeup_enable(hcd->self.controller);
277
278 if (pci_dev_run_wake(dev))
279 pm_runtime_put_noidle(&dev->dev);
280 return retval;
281
282put_hcd:
283 usb_put_hcd(hcd);
284free_irq_vectors:
285 if ((driver->flags & HCD_MASK) < HCD_USB3)
286 pci_free_irq_vectors(dev);
287disable_pci:
288 pci_disable_device(dev);
289 dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
290 return retval;
291}
292EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
293
294
295/* may be called without controller electrically present */
296/* may be called with controller, bus, and devices active */
297
298/**
299 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
300 * @dev: USB Host Controller being removed
301 *
302 * Context: task context, might sleep
303 *
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.
307 *
308 * Store this function in the HCD's struct pci_driver as remove().
309 */
310void usb_hcd_pci_remove(struct pci_dev *dev)
311{
312 struct usb_hcd *hcd;
313 int hcd_driver_flags;
314
315 hcd = pci_get_drvdata(dev);
316 if (!hcd)
317 return;
318
319 hcd_driver_flags = hcd->driver->flags;
320
321 if (pci_dev_run_wake(dev))
322 pm_runtime_get_noresume(&dev->dev);
323
324 /* Fake an interrupt request in order to give the driver a chance
325 * to test whether the controller hardware has been removed (e.g.,
326 * cardbus physical eject).
327 */
328 local_irq_disable();
329 usb_hcd_irq(0, hcd);
330 local_irq_enable();
331
332 /* Note: dev_set_drvdata must be called while holding the rwsem */
333 if (dev->class == CL_EHCI) {
334 down_write(&companions_rwsem);
335 for_each_companion(dev, hcd, ehci_remove);
336 usb_remove_hcd(hcd);
337 dev_set_drvdata(&dev->dev, NULL);
338 up_write(&companions_rwsem);
339 } else {
340 /* Not EHCI; just clear the companion pointer */
341 down_read(&companions_rwsem);
342 hcd->self.hs_companion = NULL;
343 usb_remove_hcd(hcd);
344 dev_set_drvdata(&dev->dev, NULL);
345 up_read(&companions_rwsem);
346 }
347 usb_put_hcd(hcd);
348 if ((hcd_driver_flags & HCD_MASK) < HCD_USB3)
349 pci_free_irq_vectors(dev);
350 pci_disable_device(dev);
351}
352EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
353
354/**
355 * usb_hcd_pci_shutdown - shutdown host controller
356 * @dev: USB Host Controller being shutdown
357 */
358void usb_hcd_pci_shutdown(struct pci_dev *dev)
359{
360 struct usb_hcd *hcd;
361
362 hcd = pci_get_drvdata(dev);
363 if (!hcd)
364 return;
365
366 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
367 hcd->driver->shutdown) {
368 hcd->driver->shutdown(hcd);
369 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
370 free_irq(hcd->irq, hcd);
371 pci_disable_device(dev);
372 }
373}
374EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
375
376#ifdef CONFIG_PM
377
378#ifdef CONFIG_PPC_PMAC
379static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
380{
381 /* Enanble or disable ASIC clocks for USB */
382 if (machine_is(powermac)) {
383 struct device_node *of_node;
384
385 of_node = pci_device_to_OF_node(pci_dev);
386 if (of_node)
387 pmac_call_feature(PMAC_FTR_USB_ENABLE,
388 of_node, 0, enable);
389 }
390}
391
392#else
393
394static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
395{}
396
397#endif /* CONFIG_PPC_PMAC */
398
399static int check_root_hub_suspended(struct device *dev)
400{
401 struct usb_hcd *hcd = dev_get_drvdata(dev);
402
403 if (HCD_RH_RUNNING(hcd)) {
404 dev_warn(dev, "Root hub is not suspended\n");
405 return -EBUSY;
406 }
407 if (hcd->shared_hcd) {
408 hcd = hcd->shared_hcd;
409 if (HCD_RH_RUNNING(hcd)) {
410 dev_warn(dev, "Secondary root hub is not suspended\n");
411 return -EBUSY;
412 }
413 }
414 return 0;
415}
416
417static int suspend_common(struct device *dev, pm_message_t msg)
418{
419 struct pci_dev *pci_dev = to_pci_dev(dev);
420 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
421 bool do_wakeup;
422 int retval;
423
424 do_wakeup = PMSG_IS_AUTO(msg) ? true : device_may_wakeup(dev);
425
426 /* Root hub suspend should have stopped all downstream traffic,
427 * and all bus master traffic. And done so for both the interface
428 * and the stub usb_device (which we check here). But maybe it
429 * didn't; writing sysfs power/state files ignores such rules...
430 */
431 retval = check_root_hub_suspended(dev);
432 if (retval)
433 return retval;
434
435 if (hcd->driver->pci_suspend && !HCD_DEAD(hcd)) {
436 /* Optimization: Don't suspend if a root-hub wakeup is
437 * pending and it would cause the HCD to wake up anyway.
438 */
439 if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
440 return -EBUSY;
441 if (do_wakeup && hcd->shared_hcd &&
442 HCD_WAKEUP_PENDING(hcd->shared_hcd))
443 return -EBUSY;
444 retval = hcd->driver->pci_suspend(hcd, do_wakeup);
445 suspend_report_result(dev, hcd->driver->pci_suspend, retval);
446
447 /* Check again in case wakeup raced with pci_suspend */
448 if ((retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) ||
449 (retval == 0 && do_wakeup && hcd->shared_hcd &&
450 HCD_WAKEUP_PENDING(hcd->shared_hcd))) {
451 if (hcd->driver->pci_resume)
452 hcd->driver->pci_resume(hcd, msg);
453 retval = -EBUSY;
454 }
455 if (retval)
456 return retval;
457 }
458
459 /* If MSI-X is enabled, the driver will have synchronized all vectors
460 * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
461 * synchronized here.
462 */
463 if (!hcd->msix_enabled)
464 synchronize_irq(pci_irq_vector(pci_dev, 0));
465
466 /* Downstream ports from this root hub should already be quiesced, so
467 * there will be no DMA activity. Now we can shut down the upstream
468 * link (except maybe for PME# resume signaling). We'll enter a
469 * low power state during suspend_noirq, if the hardware allows.
470 */
471 pci_disable_device(pci_dev);
472 return retval;
473}
474
475static int resume_common(struct device *dev, pm_message_t msg)
476{
477 struct pci_dev *pci_dev = to_pci_dev(dev);
478 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
479 int retval;
480
481 if (HCD_RH_RUNNING(hcd) ||
482 (hcd->shared_hcd &&
483 HCD_RH_RUNNING(hcd->shared_hcd))) {
484 dev_dbg(dev, "can't resume, not suspended!\n");
485 return 0;
486 }
487
488 retval = pci_enable_device(pci_dev);
489 if (retval < 0) {
490 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
491 return retval;
492 }
493
494 pci_set_master(pci_dev);
495
496 if (hcd->driver->pci_resume && !HCD_DEAD(hcd)) {
497
498 /*
499 * Only EHCI controllers have to wait for their companions.
500 * No locking is needed because PCI controller drivers do not
501 * get unbound during system resume.
502 */
503 if (pci_dev->class == CL_EHCI && msg.event != PM_EVENT_AUTO_RESUME)
504 for_each_companion(pci_dev, hcd,
505 ehci_wait_for_companions);
506
507 retval = hcd->driver->pci_resume(hcd, msg);
508 if (retval) {
509 dev_err(dev, "PCI post-resume error %d!\n", retval);
510 usb_hc_died(hcd);
511 }
512 }
513 return retval;
514}
515
516#ifdef CONFIG_PM_SLEEP
517
518static int hcd_pci_suspend(struct device *dev)
519{
520 return suspend_common(dev, PMSG_SUSPEND);
521}
522
523static int hcd_pci_suspend_noirq(struct device *dev)
524{
525 struct pci_dev *pci_dev = to_pci_dev(dev);
526 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
527 int retval;
528
529 retval = check_root_hub_suspended(dev);
530 if (retval)
531 return retval;
532
533 pci_save_state(pci_dev);
534
535 /* If the root hub is dead rather than suspended, disallow remote
536 * wakeup. usb_hc_died() should ensure that both hosts are marked as
537 * dying, so we only need to check the primary roothub.
538 */
539 if (HCD_DEAD(hcd))
540 device_set_wakeup_enable(dev, 0);
541 dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
542
543 /* Possibly enable remote wakeup,
544 * choose the appropriate low-power state, and go to that state.
545 */
546 retval = pci_prepare_to_sleep(pci_dev);
547 if (retval == -EIO) { /* Low-power not supported */
548 dev_dbg(dev, "--> PCI D0 legacy\n");
549 retval = 0;
550 } else if (retval == 0) {
551 dev_dbg(dev, "--> PCI %s\n",
552 pci_power_name(pci_dev->current_state));
553 } else {
554 suspend_report_result(dev, pci_prepare_to_sleep, retval);
555 return retval;
556 }
557
558 powermac_set_asic(pci_dev, 0);
559 return retval;
560}
561
562static int hcd_pci_poweroff_late(struct device *dev)
563{
564 struct pci_dev *pci_dev = to_pci_dev(dev);
565 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
566
567 if (hcd->driver->pci_poweroff_late && !HCD_DEAD(hcd))
568 return hcd->driver->pci_poweroff_late(hcd, device_may_wakeup(dev));
569
570 return 0;
571}
572
573static int hcd_pci_resume_noirq(struct device *dev)
574{
575 powermac_set_asic(to_pci_dev(dev), 1);
576 return 0;
577}
578
579static int hcd_pci_resume(struct device *dev)
580{
581 return resume_common(dev, PMSG_RESUME);
582}
583
584static int hcd_pci_restore(struct device *dev)
585{
586 return resume_common(dev, PMSG_RESTORE);
587}
588
589#else
590
591#define hcd_pci_suspend NULL
592#define hcd_pci_suspend_noirq NULL
593#define hcd_pci_poweroff_late NULL
594#define hcd_pci_resume_noirq NULL
595#define hcd_pci_resume NULL
596#define hcd_pci_restore NULL
597
598#endif /* CONFIG_PM_SLEEP */
599
600static int hcd_pci_runtime_suspend(struct device *dev)
601{
602 int retval;
603
604 retval = suspend_common(dev, PMSG_AUTO_SUSPEND);
605 if (retval == 0)
606 powermac_set_asic(to_pci_dev(dev), 0);
607 dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
608 return retval;
609}
610
611static int hcd_pci_runtime_resume(struct device *dev)
612{
613 int retval;
614
615 powermac_set_asic(to_pci_dev(dev), 1);
616 retval = resume_common(dev, PMSG_AUTO_RESUME);
617 dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
618 return retval;
619}
620
621const struct dev_pm_ops usb_hcd_pci_pm_ops = {
622 .suspend = hcd_pci_suspend,
623 .suspend_noirq = hcd_pci_suspend_noirq,
624 .resume_noirq = hcd_pci_resume_noirq,
625 .resume = hcd_pci_resume,
626 .freeze = hcd_pci_suspend,
627 .freeze_noirq = check_root_hub_suspended,
628 .thaw_noirq = NULL,
629 .thaw = hcd_pci_resume,
630 .poweroff = hcd_pci_suspend,
631 .poweroff_late = hcd_pci_poweroff_late,
632 .poweroff_noirq = hcd_pci_suspend_noirq,
633 .restore_noirq = hcd_pci_resume_noirq,
634 .restore = hcd_pci_restore,
635 .runtime_suspend = hcd_pci_runtime_suspend,
636 .runtime_resume = hcd_pci_runtime_resume,
637};
638EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
639
640#endif /* CONFIG_PM */
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * (C) Copyright David Brownell 2000-2002
4 */
5
6#include <linux/kernel.h>
7#include <linux/module.h>
8#include <linux/pci.h>
9#include <linux/usb.h>
10#include <linux/usb/hcd.h>
11
12#include <asm/io.h>
13#include <asm/irq.h>
14
15#ifdef CONFIG_PPC_PMAC
16#include <asm/machdep.h>
17#include <asm/pmac_feature.h>
18#include <asm/prom.h>
19#endif
20
21#include "usb.h"
22
23
24/* PCI-based HCs are common, but plenty of non-PCI HCs are used too */
25
26/*
27 * Coordinate handoffs between EHCI and companion controllers
28 * during EHCI probing and system resume.
29 */
30
31static DECLARE_RWSEM(companions_rwsem);
32
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
36
37static inline int is_ohci_or_uhci(struct pci_dev *pdev)
38{
39 return pdev->class == CL_OHCI || pdev->class == CL_UHCI;
40}
41
42typedef void (*companion_fn)(struct pci_dev *pdev, struct usb_hcd *hcd,
43 struct pci_dev *companion, struct usb_hcd *companion_hcd);
44
45/* Iterate over PCI devices in the same slot as pdev and call fn for each */
46static void for_each_companion(struct pci_dev *pdev, struct usb_hcd *hcd,
47 companion_fn fn)
48{
49 struct pci_dev *companion;
50 struct usb_hcd *companion_hcd;
51 unsigned int slot = PCI_SLOT(pdev->devfn);
52
53 /*
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.
57 */
58 companion = NULL;
59 for_each_pci_dev(companion) {
60 if (companion->bus != pdev->bus ||
61 PCI_SLOT(companion->devfn) != slot)
62 continue;
63
64 /*
65 * Companion device should be either UHCI,OHCI or EHCI host
66 * controller, otherwise skip.
67 */
68 if (companion->class != CL_UHCI && companion->class != CL_OHCI &&
69 companion->class != CL_EHCI)
70 continue;
71
72 companion_hcd = pci_get_drvdata(companion);
73 if (!companion_hcd || !companion_hcd->self.root_hub)
74 continue;
75 fn(pdev, hcd, companion, companion_hcd);
76 }
77}
78
79/*
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.
84 */
85static void ehci_pre_add(struct pci_dev *pdev, struct usb_hcd *hcd,
86 struct pci_dev *companion, struct usb_hcd *companion_hcd)
87{
88 struct usb_device *udev;
89
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);
94 }
95}
96
97/*
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.
101 */
102static void ehci_post_add(struct pci_dev *pdev, struct usb_hcd *hcd,
103 struct pci_dev *companion, struct usb_hcd *companion_hcd)
104{
105 struct usb_device *udev;
106
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;
112 }
113 udev = companion_hcd->self.root_hub;
114 usb_set_configuration(udev, 1);
115 usb_unlock_device(udev);
116 }
117}
118
119/*
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.
122 */
123static void non_ehci_add(struct pci_dev *pdev, struct usb_hcd *hcd,
124 struct pci_dev *companion, struct usb_hcd *companion_hcd)
125{
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;
130 }
131}
132
133/* We are removing an EHCI controller. Clear the companions' pointers. */
134static void ehci_remove(struct pci_dev *pdev, struct usb_hcd *hcd,
135 struct pci_dev *companion, struct usb_hcd *companion_hcd)
136{
137 if (is_ohci_or_uhci(companion))
138 companion_hcd->self.hs_companion = NULL;
139}
140
141#ifdef CONFIG_PM
142
143/* An EHCI controller must wait for its companions before resuming. */
144static void ehci_wait_for_companions(struct pci_dev *pdev, struct usb_hcd *hcd,
145 struct pci_dev *companion, struct usb_hcd *companion_hcd)
146{
147 if (is_ohci_or_uhci(companion))
148 device_pm_wait_for_dev(&pdev->dev, &companion->dev);
149}
150
151#endif /* CONFIG_PM */
152
153/*-------------------------------------------------------------------------*/
154
155/* configure so an HC device and id are always provided */
156/* always called with process context; sleeping is OK */
157
158/**
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()
163 *
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.
167 *
168 * Store this function in the HCD's struct pci_driver as probe().
169 *
170 * Return: 0 if successful.
171 */
172int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
173{
174 struct hc_driver *driver;
175 struct usb_hcd *hcd;
176 int retval;
177 int hcd_irq = 0;
178
179 if (usb_disabled())
180 return -ENODEV;
181
182 if (!id)
183 return -EINVAL;
184 driver = (struct hc_driver *)id->driver_data;
185 if (!driver)
186 return -EINVAL;
187
188 if (pci_enable_device(dev) < 0)
189 return -ENODEV;
190
191 /*
192 * The xHCI driver has its own irq management
193 * make sure irq setup is not touched for xhci in generic hcd code
194 */
195 if ((driver->flags & HCD_MASK) < HCD_USB3) {
196 if (!dev->irq) {
197 dev_err(&dev->dev,
198 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
199 pci_name(dev));
200 retval = -ENODEV;
201 goto disable_pci;
202 }
203 hcd_irq = dev->irq;
204 }
205
206 hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
207 if (!hcd) {
208 retval = -ENOMEM;
209 goto disable_pci;
210 }
211
212 hcd->amd_resume_bug = (usb_hcd_amd_remote_wakeup_quirk(dev) &&
213 driver->flags & (HCD_USB11 | HCD_USB3)) ? 1 : 0;
214
215 if (driver->flags & HCD_MEMORY) {
216 /* EHCI, OHCI */
217 hcd->rsrc_start = pci_resource_start(dev, 0);
218 hcd->rsrc_len = pci_resource_len(dev, 0);
219 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
220 driver->description)) {
221 dev_dbg(&dev->dev, "controller already in use\n");
222 retval = -EBUSY;
223 goto put_hcd;
224 }
225 hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
226 if (hcd->regs == NULL) {
227 dev_dbg(&dev->dev, "error mapping memory\n");
228 retval = -EFAULT;
229 goto release_mem_region;
230 }
231
232 } else {
233 /* UHCI */
234 int region;
235
236 for (region = 0; region < PCI_ROM_RESOURCE; region++) {
237 if (!(pci_resource_flags(dev, region) &
238 IORESOURCE_IO))
239 continue;
240
241 hcd->rsrc_start = pci_resource_start(dev, region);
242 hcd->rsrc_len = pci_resource_len(dev, region);
243 if (request_region(hcd->rsrc_start, hcd->rsrc_len,
244 driver->description))
245 break;
246 }
247 if (region == PCI_ROM_RESOURCE) {
248 dev_dbg(&dev->dev, "no i/o regions available\n");
249 retval = -EBUSY;
250 goto put_hcd;
251 }
252 }
253
254 pci_set_master(dev);
255
256 /* Note: dev_set_drvdata must be called while holding the rwsem */
257 if (dev->class == CL_EHCI) {
258 down_write(&companions_rwsem);
259 dev_set_drvdata(&dev->dev, hcd);
260 for_each_companion(dev, hcd, ehci_pre_add);
261 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
262 if (retval != 0)
263 dev_set_drvdata(&dev->dev, NULL);
264 for_each_companion(dev, hcd, ehci_post_add);
265 up_write(&companions_rwsem);
266 } else {
267 down_read(&companions_rwsem);
268 dev_set_drvdata(&dev->dev, hcd);
269 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
270 if (retval != 0)
271 dev_set_drvdata(&dev->dev, NULL);
272 else
273 for_each_companion(dev, hcd, non_ehci_add);
274 up_read(&companions_rwsem);
275 }
276
277 if (retval != 0)
278 goto unmap_registers;
279 device_wakeup_enable(hcd->self.controller);
280
281 if (pci_dev_run_wake(dev))
282 pm_runtime_put_noidle(&dev->dev);
283 return retval;
284
285unmap_registers:
286 if (driver->flags & HCD_MEMORY) {
287 iounmap(hcd->regs);
288release_mem_region:
289 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
290 } else
291 release_region(hcd->rsrc_start, hcd->rsrc_len);
292put_hcd:
293 usb_put_hcd(hcd);
294disable_pci:
295 pci_disable_device(dev);
296 dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
297 return retval;
298}
299EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
300
301
302/* may be called without controller electrically present */
303/* may be called with controller, bus, and devices active */
304
305/**
306 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
307 * @dev: USB Host Controller being removed
308 * Context: !in_interrupt()
309 *
310 * Reverses the effect of usb_hcd_pci_probe(), first invoking
311 * the HCD's stop() method. It is always called from a thread
312 * context, normally "rmmod", "apmd", or something similar.
313 *
314 * Store this function in the HCD's struct pci_driver as remove().
315 */
316void usb_hcd_pci_remove(struct pci_dev *dev)
317{
318 struct usb_hcd *hcd;
319
320 hcd = pci_get_drvdata(dev);
321 if (!hcd)
322 return;
323
324 if (pci_dev_run_wake(dev))
325 pm_runtime_get_noresume(&dev->dev);
326
327 /* Fake an interrupt request in order to give the driver a chance
328 * to test whether the controller hardware has been removed (e.g.,
329 * cardbus physical eject).
330 */
331 local_irq_disable();
332 usb_hcd_irq(0, hcd);
333 local_irq_enable();
334
335 /* Note: dev_set_drvdata must be called while holding the rwsem */
336 if (dev->class == CL_EHCI) {
337 down_write(&companions_rwsem);
338 for_each_companion(dev, hcd, ehci_remove);
339 usb_remove_hcd(hcd);
340 dev_set_drvdata(&dev->dev, NULL);
341 up_write(&companions_rwsem);
342 } else {
343 /* Not EHCI; just clear the companion pointer */
344 down_read(&companions_rwsem);
345 hcd->self.hs_companion = NULL;
346 usb_remove_hcd(hcd);
347 dev_set_drvdata(&dev->dev, NULL);
348 up_read(&companions_rwsem);
349 }
350
351 if (hcd->driver->flags & HCD_MEMORY) {
352 iounmap(hcd->regs);
353 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
354 } else {
355 release_region(hcd->rsrc_start, hcd->rsrc_len);
356 }
357
358 usb_put_hcd(hcd);
359 pci_disable_device(dev);
360}
361EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
362
363/**
364 * usb_hcd_pci_shutdown - shutdown host controller
365 * @dev: USB Host Controller being shutdown
366 */
367void usb_hcd_pci_shutdown(struct pci_dev *dev)
368{
369 struct usb_hcd *hcd;
370
371 hcd = pci_get_drvdata(dev);
372 if (!hcd)
373 return;
374
375 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
376 hcd->driver->shutdown) {
377 hcd->driver->shutdown(hcd);
378 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
379 free_irq(hcd->irq, hcd);
380 pci_disable_device(dev);
381 }
382}
383EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
384
385#ifdef CONFIG_PM
386
387#ifdef CONFIG_PPC_PMAC
388static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
389{
390 /* Enanble or disable ASIC clocks for USB */
391 if (machine_is(powermac)) {
392 struct device_node *of_node;
393
394 of_node = pci_device_to_OF_node(pci_dev);
395 if (of_node)
396 pmac_call_feature(PMAC_FTR_USB_ENABLE,
397 of_node, 0, enable);
398 }
399}
400
401#else
402
403static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
404{}
405
406#endif /* CONFIG_PPC_PMAC */
407
408static int check_root_hub_suspended(struct device *dev)
409{
410 struct pci_dev *pci_dev = to_pci_dev(dev);
411 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
412
413 if (HCD_RH_RUNNING(hcd)) {
414 dev_warn(dev, "Root hub is not suspended\n");
415 return -EBUSY;
416 }
417 if (hcd->shared_hcd) {
418 hcd = hcd->shared_hcd;
419 if (HCD_RH_RUNNING(hcd)) {
420 dev_warn(dev, "Secondary root hub is not suspended\n");
421 return -EBUSY;
422 }
423 }
424 return 0;
425}
426
427static int suspend_common(struct device *dev, bool do_wakeup)
428{
429 struct pci_dev *pci_dev = to_pci_dev(dev);
430 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
431 int retval;
432
433 /* Root hub suspend should have stopped all downstream traffic,
434 * and all bus master traffic. And done so for both the interface
435 * and the stub usb_device (which we check here). But maybe it
436 * didn't; writing sysfs power/state files ignores such rules...
437 */
438 retval = check_root_hub_suspended(dev);
439 if (retval)
440 return retval;
441
442 if (hcd->driver->pci_suspend && !HCD_DEAD(hcd)) {
443 /* Optimization: Don't suspend if a root-hub wakeup is
444 * pending and it would cause the HCD to wake up anyway.
445 */
446 if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
447 return -EBUSY;
448 if (do_wakeup && hcd->shared_hcd &&
449 HCD_WAKEUP_PENDING(hcd->shared_hcd))
450 return -EBUSY;
451 retval = hcd->driver->pci_suspend(hcd, do_wakeup);
452 suspend_report_result(hcd->driver->pci_suspend, retval);
453
454 /* Check again in case wakeup raced with pci_suspend */
455 if ((retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) ||
456 (retval == 0 && do_wakeup && hcd->shared_hcd &&
457 HCD_WAKEUP_PENDING(hcd->shared_hcd))) {
458 if (hcd->driver->pci_resume)
459 hcd->driver->pci_resume(hcd, false);
460 retval = -EBUSY;
461 }
462 if (retval)
463 return retval;
464 }
465
466 /* If MSI-X is enabled, the driver will have synchronized all vectors
467 * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
468 * synchronized here.
469 */
470 if (!hcd->msix_enabled)
471 synchronize_irq(pci_dev->irq);
472
473 /* Downstream ports from this root hub should already be quiesced, so
474 * there will be no DMA activity. Now we can shut down the upstream
475 * link (except maybe for PME# resume signaling). We'll enter a
476 * low power state during suspend_noirq, if the hardware allows.
477 */
478 pci_disable_device(pci_dev);
479 return retval;
480}
481
482static int resume_common(struct device *dev, int event)
483{
484 struct pci_dev *pci_dev = to_pci_dev(dev);
485 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
486 int retval;
487
488 if (HCD_RH_RUNNING(hcd) ||
489 (hcd->shared_hcd &&
490 HCD_RH_RUNNING(hcd->shared_hcd))) {
491 dev_dbg(dev, "can't resume, not suspended!\n");
492 return 0;
493 }
494
495 retval = pci_enable_device(pci_dev);
496 if (retval < 0) {
497 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
498 return retval;
499 }
500
501 pci_set_master(pci_dev);
502
503 if (hcd->driver->pci_resume && !HCD_DEAD(hcd)) {
504
505 /*
506 * Only EHCI controllers have to wait for their companions.
507 * No locking is needed because PCI controller drivers do not
508 * get unbound during system resume.
509 */
510 if (pci_dev->class == CL_EHCI && event != PM_EVENT_AUTO_RESUME)
511 for_each_companion(pci_dev, hcd,
512 ehci_wait_for_companions);
513
514 retval = hcd->driver->pci_resume(hcd,
515 event == PM_EVENT_RESTORE);
516 if (retval) {
517 dev_err(dev, "PCI post-resume error %d!\n", retval);
518 if (hcd->shared_hcd)
519 usb_hc_died(hcd->shared_hcd);
520 usb_hc_died(hcd);
521 }
522 }
523 return retval;
524}
525
526#ifdef CONFIG_PM_SLEEP
527
528static int hcd_pci_suspend(struct device *dev)
529{
530 return suspend_common(dev, device_may_wakeup(dev));
531}
532
533static int hcd_pci_suspend_noirq(struct device *dev)
534{
535 struct pci_dev *pci_dev = to_pci_dev(dev);
536 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
537 int retval;
538
539 retval = check_root_hub_suspended(dev);
540 if (retval)
541 return retval;
542
543 pci_save_state(pci_dev);
544
545 /* If the root hub is dead rather than suspended, disallow remote
546 * wakeup. usb_hc_died() should ensure that both hosts are marked as
547 * dying, so we only need to check the primary roothub.
548 */
549 if (HCD_DEAD(hcd))
550 device_set_wakeup_enable(dev, 0);
551 dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
552
553 /* Possibly enable remote wakeup,
554 * choose the appropriate low-power state, and go to that state.
555 */
556 retval = pci_prepare_to_sleep(pci_dev);
557 if (retval == -EIO) { /* Low-power not supported */
558 dev_dbg(dev, "--> PCI D0 legacy\n");
559 retval = 0;
560 } else if (retval == 0) {
561 dev_dbg(dev, "--> PCI %s\n",
562 pci_power_name(pci_dev->current_state));
563 } else {
564 suspend_report_result(pci_prepare_to_sleep, retval);
565 return retval;
566 }
567
568 powermac_set_asic(pci_dev, 0);
569 return retval;
570}
571
572static int hcd_pci_resume_noirq(struct device *dev)
573{
574 powermac_set_asic(to_pci_dev(dev), 1);
575 return 0;
576}
577
578static int hcd_pci_resume(struct device *dev)
579{
580 return resume_common(dev, PM_EVENT_RESUME);
581}
582
583static int hcd_pci_restore(struct device *dev)
584{
585 return resume_common(dev, PM_EVENT_RESTORE);
586}
587
588#else
589
590#define hcd_pci_suspend NULL
591#define hcd_pci_suspend_noirq NULL
592#define hcd_pci_resume_noirq NULL
593#define hcd_pci_resume NULL
594#define hcd_pci_restore NULL
595
596#endif /* CONFIG_PM_SLEEP */
597
598static int hcd_pci_runtime_suspend(struct device *dev)
599{
600 int retval;
601
602 retval = suspend_common(dev, true);
603 if (retval == 0)
604 powermac_set_asic(to_pci_dev(dev), 0);
605 dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
606 return retval;
607}
608
609static int hcd_pci_runtime_resume(struct device *dev)
610{
611 int retval;
612
613 powermac_set_asic(to_pci_dev(dev), 1);
614 retval = resume_common(dev, PM_EVENT_AUTO_RESUME);
615 dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
616 return retval;
617}
618
619const struct dev_pm_ops usb_hcd_pci_pm_ops = {
620 .suspend = hcd_pci_suspend,
621 .suspend_noirq = hcd_pci_suspend_noirq,
622 .resume_noirq = hcd_pci_resume_noirq,
623 .resume = hcd_pci_resume,
624 .freeze = check_root_hub_suspended,
625 .freeze_noirq = check_root_hub_suspended,
626 .thaw_noirq = NULL,
627 .thaw = NULL,
628 .poweroff = hcd_pci_suspend,
629 .poweroff_noirq = hcd_pci_suspend_noirq,
630 .restore_noirq = hcd_pci_resume_noirq,
631 .restore = hcd_pci_restore,
632 .runtime_suspend = hcd_pci_runtime_suspend,
633 .runtime_resume = hcd_pci_runtime_resume,
634};
635EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
636
637#endif /* CONFIG_PM */