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