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/*
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 if (!dev->irq) {
191 dev_err(&dev->dev,
192 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
193 pci_name(dev));
194 retval = -ENODEV;
195 goto disable_pci;
196 }
197
198 hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
199 if (!hcd) {
200 retval = -ENOMEM;
201 goto disable_pci;
202 }
203
204 if (driver->flags & HCD_MEMORY) {
205 /* EHCI, OHCI */
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");
211 retval = -EBUSY;
212 goto clear_companion;
213 }
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");
217 retval = -EFAULT;
218 goto release_mem_region;
219 }
220
221 } else {
222 /* UHCI */
223 int region;
224
225 for (region = 0; region < PCI_ROM_RESOURCE; region++) {
226 if (!(pci_resource_flags(dev, region) &
227 IORESOURCE_IO))
228 continue;
229
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))
234 break;
235 }
236 if (region == PCI_ROM_RESOURCE) {
237 dev_dbg(&dev->dev, "no i/o regions available\n");
238 retval = -EBUSY;
239 goto clear_companion;
240 }
241 }
242
243 pci_set_master(dev);
244
245 retval = usb_add_hcd(hcd, dev->irq, IRQF_DISABLED | IRQF_SHARED);
246 if (retval != 0)
247 goto unmap_registers;
248 set_hs_companion(dev, hcd);
249
250 if (pci_dev_run_wake(dev))
251 pm_runtime_put_noidle(&dev->dev);
252 return retval;
253
254unmap_registers:
255 if (driver->flags & HCD_MEMORY) {
256 iounmap(hcd->regs);
257release_mem_region:
258 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
259 } else
260 release_region(hcd->rsrc_start, hcd->rsrc_len);
261clear_companion:
262 clear_hs_companion(dev, hcd);
263 usb_put_hcd(hcd);
264disable_pci:
265 pci_disable_device(dev);
266 dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
267 return retval;
268}
269EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
270
271
272/* may be called without controller electrically present */
273/* may be called with controller, bus, and devices active */
274
275/**
276 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
277 * @dev: USB Host Controller being removed
278 * Context: !in_interrupt()
279 *
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.
283 *
284 * Store this function in the HCD's struct pci_driver as remove().
285 */
286void usb_hcd_pci_remove(struct pci_dev *dev)
287{
288 struct usb_hcd *hcd;
289
290 hcd = pci_get_drvdata(dev);
291 if (!hcd)
292 return;
293
294 if (pci_dev_run_wake(dev))
295 pm_runtime_get_noresume(&dev->dev);
296
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).
300 */
301 local_irq_disable();
302 usb_hcd_irq(0, hcd);
303 local_irq_enable();
304
305 usb_remove_hcd(hcd);
306 if (hcd->driver->flags & HCD_MEMORY) {
307 iounmap(hcd->regs);
308 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
309 } else {
310 release_region(hcd->rsrc_start, hcd->rsrc_len);
311 }
312 clear_hs_companion(dev, hcd);
313 usb_put_hcd(hcd);
314 pci_disable_device(dev);
315}
316EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
317
318/**
319 * usb_hcd_pci_shutdown - shutdown host controller
320 * @dev: USB Host Controller being shutdown
321 */
322void usb_hcd_pci_shutdown(struct pci_dev *dev)
323{
324 struct usb_hcd *hcd;
325
326 hcd = pci_get_drvdata(dev);
327 if (!hcd)
328 return;
329
330 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
331 hcd->driver->shutdown) {
332 hcd->driver->shutdown(hcd);
333 pci_disable_device(dev);
334 }
335}
336EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
337
338#ifdef CONFIG_PM
339
340#ifdef CONFIG_PPC_PMAC
341static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
342{
343 /* Enanble or disable ASIC clocks for USB */
344 if (machine_is(powermac)) {
345 struct device_node *of_node;
346
347 of_node = pci_device_to_OF_node(pci_dev);
348 if (of_node)
349 pmac_call_feature(PMAC_FTR_USB_ENABLE,
350 of_node, 0, enable);
351 }
352}
353
354#else
355
356static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
357{}
358
359#endif /* CONFIG_PPC_PMAC */
360
361static int check_root_hub_suspended(struct device *dev)
362{
363 struct pci_dev *pci_dev = to_pci_dev(dev);
364 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
365
366 if (HCD_RH_RUNNING(hcd)) {
367 dev_warn(dev, "Root hub is not suspended\n");
368 return -EBUSY;
369 }
370 if (hcd->shared_hcd) {
371 hcd = hcd->shared_hcd;
372 if (HCD_RH_RUNNING(hcd)) {
373 dev_warn(dev, "Secondary root hub is not suspended\n");
374 return -EBUSY;
375 }
376 }
377 return 0;
378}
379
380static int suspend_common(struct device *dev, bool do_wakeup)
381{
382 struct pci_dev *pci_dev = to_pci_dev(dev);
383 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
384 int retval;
385
386 /* Root hub suspend should have stopped all downstream traffic,
387 * and all bus master traffic. And done so for both the interface
388 * and the stub usb_device (which we check here). But maybe it
389 * didn't; writing sysfs power/state files ignores such rules...
390 */
391 retval = check_root_hub_suspended(dev);
392 if (retval)
393 return retval;
394
395 if (hcd->driver->pci_suspend && !HCD_DEAD(hcd)) {
396 /* Optimization: Don't suspend if a root-hub wakeup is
397 * pending and it would cause the HCD to wake up anyway.
398 */
399 if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
400 return -EBUSY;
401 if (do_wakeup && hcd->shared_hcd &&
402 HCD_WAKEUP_PENDING(hcd->shared_hcd))
403 return -EBUSY;
404 retval = hcd->driver->pci_suspend(hcd, do_wakeup);
405 suspend_report_result(hcd->driver->pci_suspend, retval);
406
407 /* Check again in case wakeup raced with pci_suspend */
408 if ((retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) ||
409 (retval == 0 && do_wakeup && hcd->shared_hcd &&
410 HCD_WAKEUP_PENDING(hcd->shared_hcd))) {
411 if (hcd->driver->pci_resume)
412 hcd->driver->pci_resume(hcd, false);
413 retval = -EBUSY;
414 }
415 if (retval)
416 return retval;
417 }
418
419 /* If MSI-X is enabled, the driver will have synchronized all vectors
420 * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
421 * synchronized here.
422 */
423 if (!hcd->msix_enabled)
424 synchronize_irq(pci_dev->irq);
425
426 /* Downstream ports from this root hub should already be quiesced, so
427 * there will be no DMA activity. Now we can shut down the upstream
428 * link (except maybe for PME# resume signaling). We'll enter a
429 * low power state during suspend_noirq, if the hardware allows.
430 */
431 pci_disable_device(pci_dev);
432 return retval;
433}
434
435static int resume_common(struct device *dev, int event)
436{
437 struct pci_dev *pci_dev = to_pci_dev(dev);
438 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
439 int retval;
440
441 if (HCD_RH_RUNNING(hcd) ||
442 (hcd->shared_hcd &&
443 HCD_RH_RUNNING(hcd->shared_hcd))) {
444 dev_dbg(dev, "can't resume, not suspended!\n");
445 return 0;
446 }
447
448 retval = pci_enable_device(pci_dev);
449 if (retval < 0) {
450 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
451 return retval;
452 }
453
454 pci_set_master(pci_dev);
455
456 clear_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
457 if (hcd->shared_hcd)
458 clear_bit(HCD_FLAG_SAW_IRQ, &hcd->shared_hcd->flags);
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
476#ifdef CONFIG_PM_SLEEP
477
478static int hcd_pci_suspend(struct device *dev)
479{
480 return suspend_common(dev, device_may_wakeup(dev));
481}
482
483static int hcd_pci_suspend_noirq(struct device *dev)
484{
485 struct pci_dev *pci_dev = to_pci_dev(dev);
486 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
487 int retval;
488
489 retval = check_root_hub_suspended(dev);
490 if (retval)
491 return retval;
492
493 pci_save_state(pci_dev);
494
495 /* If the root hub is dead rather than suspended, disallow remote
496 * wakeup. usb_hc_died() should ensure that both hosts are marked as
497 * dying, so we only need to check the primary roothub.
498 */
499 if (HCD_DEAD(hcd))
500 device_set_wakeup_enable(dev, 0);
501 dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
502
503 /* Possibly enable remote wakeup,
504 * choose the appropriate low-power state, and go to that state.
505 */
506 retval = pci_prepare_to_sleep(pci_dev);
507 if (retval == -EIO) { /* Low-power not supported */
508 dev_dbg(dev, "--> PCI D0 legacy\n");
509 retval = 0;
510 } else if (retval == 0) {
511 dev_dbg(dev, "--> PCI %s\n",
512 pci_power_name(pci_dev->current_state));
513 } else {
514 suspend_report_result(pci_prepare_to_sleep, retval);
515 return retval;
516 }
517
518 powermac_set_asic(pci_dev, 0);
519 return retval;
520}
521
522static int hcd_pci_resume_noirq(struct device *dev)
523{
524 struct pci_dev *pci_dev = to_pci_dev(dev);
525
526 powermac_set_asic(pci_dev, 1);
527
528 /* Go back to D0 and disable remote wakeup */
529 pci_back_from_sleep(pci_dev);
530 return 0;
531}
532
533static int hcd_pci_resume(struct device *dev)
534{
535 return resume_common(dev, PM_EVENT_RESUME);
536}
537
538static int hcd_pci_restore(struct device *dev)
539{
540 return resume_common(dev, PM_EVENT_RESTORE);
541}
542
543#else
544
545#define hcd_pci_suspend NULL
546#define hcd_pci_suspend_noirq NULL
547#define hcd_pci_resume_noirq NULL
548#define hcd_pci_resume NULL
549#define hcd_pci_restore NULL
550
551#endif /* CONFIG_PM_SLEEP */
552
553#ifdef CONFIG_PM_RUNTIME
554
555static int hcd_pci_runtime_suspend(struct device *dev)
556{
557 int retval;
558
559 retval = suspend_common(dev, true);
560 if (retval == 0)
561 powermac_set_asic(to_pci_dev(dev), 0);
562 dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
563 return retval;
564}
565
566static int hcd_pci_runtime_resume(struct device *dev)
567{
568 int retval;
569
570 powermac_set_asic(to_pci_dev(dev), 1);
571 retval = resume_common(dev, PM_EVENT_AUTO_RESUME);
572 dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
573 return retval;
574}
575
576#else
577
578#define hcd_pci_runtime_suspend NULL
579#define hcd_pci_runtime_resume NULL
580
581#endif /* CONFIG_PM_RUNTIME */
582
583const struct dev_pm_ops usb_hcd_pci_pm_ops = {
584 .suspend = hcd_pci_suspend,
585 .suspend_noirq = hcd_pci_suspend_noirq,
586 .resume_noirq = hcd_pci_resume_noirq,
587 .resume = hcd_pci_resume,
588 .freeze = check_root_hub_suspended,
589 .freeze_noirq = check_root_hub_suspended,
590 .thaw_noirq = NULL,
591 .thaw = NULL,
592 .poweroff = hcd_pci_suspend,
593 .poweroff_noirq = hcd_pci_suspend_noirq,
594 .restore_noirq = hcd_pci_resume_noirq,
595 .restore = hcd_pci_restore,
596 .runtime_suspend = hcd_pci_runtime_suspend,
597 .runtime_resume = hcd_pci_runtime_resume,
598};
599EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
600
601#endif /* CONFIG_PM */