Loading...
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 */
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 * @driver: USB HC driver handle
163 *
164 * Context: task context, might sleep
165 *
166 * Allocates basic PCI resources for this USB host controller, and
167 * then invokes the start() method for the HCD associated with it
168 * through the hotplug entry's driver_data.
169 *
170 * Store this function in the HCD's struct pci_driver as probe().
171 *
172 * Return: 0 if successful.
173 */
174int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id,
175 const struct hc_driver *driver)
176{
177 struct usb_hcd *hcd;
178 int retval;
179 int hcd_irq = 0;
180
181 if (usb_disabled())
182 return -ENODEV;
183
184 if (!id)
185 return -EINVAL;
186
187 if (!driver)
188 return -EINVAL;
189
190 if (pci_enable_device(dev) < 0)
191 return -ENODEV;
192
193 /*
194 * The xHCI driver has its own irq management
195 * make sure irq setup is not touched for xhci in generic hcd code
196 */
197 if ((driver->flags & HCD_MASK) < HCD_USB3) {
198 retval = pci_alloc_irq_vectors(dev, 1, 1, PCI_IRQ_LEGACY | PCI_IRQ_MSI);
199 if (retval < 0) {
200 dev_err(&dev->dev,
201 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
202 pci_name(dev));
203 retval = -ENODEV;
204 goto disable_pci;
205 }
206 hcd_irq = pci_irq_vector(dev, 0);
207 }
208
209 hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
210 if (!hcd) {
211 retval = -ENOMEM;
212 goto free_irq_vectors;
213 }
214
215 hcd->amd_resume_bug = (usb_hcd_amd_remote_wakeup_quirk(dev) &&
216 driver->flags & (HCD_USB11 | HCD_USB3)) ? 1 : 0;
217
218 if (driver->flags & HCD_MEMORY) {
219 /* EHCI, OHCI */
220 hcd->rsrc_start = pci_resource_start(dev, 0);
221 hcd->rsrc_len = pci_resource_len(dev, 0);
222 if (!devm_request_mem_region(&dev->dev, hcd->rsrc_start,
223 hcd->rsrc_len, driver->description)) {
224 dev_dbg(&dev->dev, "controller already in use\n");
225 retval = -EBUSY;
226 goto put_hcd;
227 }
228 hcd->regs = devm_ioremap(&dev->dev, hcd->rsrc_start,
229 hcd->rsrc_len);
230 if (hcd->regs == NULL) {
231 dev_dbg(&dev->dev, "error mapping memory\n");
232 retval = -EFAULT;
233 goto put_hcd;
234 }
235
236 } else {
237 /* UHCI */
238 int region;
239
240 for (region = 0; region < PCI_STD_NUM_BARS; region++) {
241 if (!(pci_resource_flags(dev, region) &
242 IORESOURCE_IO))
243 continue;
244
245 hcd->rsrc_start = pci_resource_start(dev, region);
246 hcd->rsrc_len = pci_resource_len(dev, region);
247 if (devm_request_region(&dev->dev, hcd->rsrc_start,
248 hcd->rsrc_len, driver->description))
249 break;
250 }
251 if (region == PCI_ROM_RESOURCE) {
252 dev_dbg(&dev->dev, "no i/o regions available\n");
253 retval = -EBUSY;
254 goto put_hcd;
255 }
256 }
257
258 pci_set_master(dev);
259
260 /* Note: dev_set_drvdata must be called while holding the rwsem */
261 if (dev->class == CL_EHCI) {
262 down_write(&companions_rwsem);
263 dev_set_drvdata(&dev->dev, hcd);
264 for_each_companion(dev, hcd, ehci_pre_add);
265 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
266 if (retval != 0)
267 dev_set_drvdata(&dev->dev, NULL);
268 for_each_companion(dev, hcd, ehci_post_add);
269 up_write(&companions_rwsem);
270 } else {
271 down_read(&companions_rwsem);
272 dev_set_drvdata(&dev->dev, hcd);
273 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
274 if (retval != 0)
275 dev_set_drvdata(&dev->dev, NULL);
276 else
277 for_each_companion(dev, hcd, non_ehci_add);
278 up_read(&companions_rwsem);
279 }
280
281 if (retval != 0)
282 goto put_hcd;
283 device_wakeup_enable(hcd->self.controller);
284
285 if (pci_dev_run_wake(dev))
286 pm_runtime_put_noidle(&dev->dev);
287 return retval;
288
289put_hcd:
290 usb_put_hcd(hcd);
291free_irq_vectors:
292 if ((driver->flags & HCD_MASK) < HCD_USB3)
293 pci_free_irq_vectors(dev);
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 *
309 * Context: task context, might sleep
310 *
311 * Reverses the effect of usb_hcd_pci_probe(), first invoking
312 * the HCD's stop() method. It is always called from a thread
313 * context, normally "rmmod", "apmd", or something similar.
314 *
315 * Store this function in the HCD's struct pci_driver as remove().
316 */
317void usb_hcd_pci_remove(struct pci_dev *dev)
318{
319 struct usb_hcd *hcd;
320 int hcd_driver_flags;
321
322 hcd = pci_get_drvdata(dev);
323 if (!hcd)
324 return;
325
326 hcd_driver_flags = hcd->driver->flags;
327
328 if (pci_dev_run_wake(dev))
329 pm_runtime_get_noresume(&dev->dev);
330
331 /* Fake an interrupt request in order to give the driver a chance
332 * to test whether the controller hardware has been removed (e.g.,
333 * cardbus physical eject).
334 */
335 local_irq_disable();
336 usb_hcd_irq(0, hcd);
337 local_irq_enable();
338
339 /* Note: dev_set_drvdata must be called while holding the rwsem */
340 if (dev->class == CL_EHCI) {
341 down_write(&companions_rwsem);
342 for_each_companion(dev, hcd, ehci_remove);
343 usb_remove_hcd(hcd);
344 dev_set_drvdata(&dev->dev, NULL);
345 up_write(&companions_rwsem);
346 } else {
347 /* Not EHCI; just clear the companion pointer */
348 down_read(&companions_rwsem);
349 hcd->self.hs_companion = NULL;
350 usb_remove_hcd(hcd);
351 dev_set_drvdata(&dev->dev, NULL);
352 up_read(&companions_rwsem);
353 }
354 usb_put_hcd(hcd);
355 if ((hcd_driver_flags & HCD_MASK) < HCD_USB3)
356 pci_free_irq_vectors(dev);
357 pci_disable_device(dev);
358}
359EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
360
361/**
362 * usb_hcd_pci_shutdown - shutdown host controller
363 * @dev: USB Host Controller being shutdown
364 */
365void usb_hcd_pci_shutdown(struct pci_dev *dev)
366{
367 struct usb_hcd *hcd;
368
369 hcd = pci_get_drvdata(dev);
370 if (!hcd)
371 return;
372
373 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
374 hcd->driver->shutdown) {
375 hcd->driver->shutdown(hcd);
376 if (usb_hcd_is_primary_hcd(hcd) && hcd->irq > 0)
377 free_irq(hcd->irq, hcd);
378 pci_disable_device(dev);
379 }
380}
381EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
382
383#ifdef CONFIG_PM
384
385#ifdef CONFIG_PPC_PMAC
386static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
387{
388 /* Enanble or disable ASIC clocks for USB */
389 if (machine_is(powermac)) {
390 struct device_node *of_node;
391
392 of_node = pci_device_to_OF_node(pci_dev);
393 if (of_node)
394 pmac_call_feature(PMAC_FTR_USB_ENABLE,
395 of_node, 0, enable);
396 }
397}
398
399#else
400
401static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
402{}
403
404#endif /* CONFIG_PPC_PMAC */
405
406static int check_root_hub_suspended(struct device *dev)
407{
408 struct usb_hcd *hcd = dev_get_drvdata(dev);
409
410 if (HCD_RH_RUNNING(hcd)) {
411 dev_warn(dev, "Root hub is not suspended\n");
412 return -EBUSY;
413 }
414 if (hcd->shared_hcd) {
415 hcd = hcd->shared_hcd;
416 if (HCD_RH_RUNNING(hcd)) {
417 dev_warn(dev, "Secondary root hub is not suspended\n");
418 return -EBUSY;
419 }
420 }
421 return 0;
422}
423
424static int suspend_common(struct device *dev, bool do_wakeup)
425{
426 struct pci_dev *pci_dev = to_pci_dev(dev);
427 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
428 int retval;
429
430 /* Root hub suspend should have stopped all downstream traffic,
431 * and all bus master traffic. And done so for both the interface
432 * and the stub usb_device (which we check here). But maybe it
433 * didn't; writing sysfs power/state files ignores such rules...
434 */
435 retval = check_root_hub_suspended(dev);
436 if (retval)
437 return retval;
438
439 if (hcd->driver->pci_suspend && !HCD_DEAD(hcd)) {
440 /* Optimization: Don't suspend if a root-hub wakeup is
441 * pending and it would cause the HCD to wake up anyway.
442 */
443 if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
444 return -EBUSY;
445 if (do_wakeup && hcd->shared_hcd &&
446 HCD_WAKEUP_PENDING(hcd->shared_hcd))
447 return -EBUSY;
448 retval = hcd->driver->pci_suspend(hcd, do_wakeup);
449 suspend_report_result(hcd->driver->pci_suspend, retval);
450
451 /* Check again in case wakeup raced with pci_suspend */
452 if ((retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) ||
453 (retval == 0 && do_wakeup && hcd->shared_hcd &&
454 HCD_WAKEUP_PENDING(hcd->shared_hcd))) {
455 if (hcd->driver->pci_resume)
456 hcd->driver->pci_resume(hcd, false);
457 retval = -EBUSY;
458 }
459 if (retval)
460 return retval;
461 }
462
463 /* If MSI-X is enabled, the driver will have synchronized all vectors
464 * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
465 * synchronized here.
466 */
467 if (!hcd->msix_enabled)
468 synchronize_irq(pci_irq_vector(pci_dev, 0));
469
470 /* Downstream ports from this root hub should already be quiesced, so
471 * there will be no DMA activity. Now we can shut down the upstream
472 * link (except maybe for PME# resume signaling). We'll enter a
473 * low power state during suspend_noirq, if the hardware allows.
474 */
475 pci_disable_device(pci_dev);
476 return retval;
477}
478
479static int resume_common(struct device *dev, int event)
480{
481 struct pci_dev *pci_dev = to_pci_dev(dev);
482 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
483 int retval;
484
485 if (HCD_RH_RUNNING(hcd) ||
486 (hcd->shared_hcd &&
487 HCD_RH_RUNNING(hcd->shared_hcd))) {
488 dev_dbg(dev, "can't resume, not suspended!\n");
489 return 0;
490 }
491
492 retval = pci_enable_device(pci_dev);
493 if (retval < 0) {
494 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
495 return retval;
496 }
497
498 pci_set_master(pci_dev);
499
500 if (hcd->driver->pci_resume && !HCD_DEAD(hcd)) {
501
502 /*
503 * Only EHCI controllers have to wait for their companions.
504 * No locking is needed because PCI controller drivers do not
505 * get unbound during system resume.
506 */
507 if (pci_dev->class == CL_EHCI && event != PM_EVENT_AUTO_RESUME)
508 for_each_companion(pci_dev, hcd,
509 ehci_wait_for_companions);
510
511 retval = hcd->driver->pci_resume(hcd,
512 event == PM_EVENT_RESTORE);
513 if (retval) {
514 dev_err(dev, "PCI post-resume error %d!\n", retval);
515 usb_hc_died(hcd);
516 }
517 }
518 return retval;
519}
520
521#ifdef CONFIG_PM_SLEEP
522
523static int hcd_pci_suspend(struct device *dev)
524{
525 return suspend_common(dev, device_may_wakeup(dev));
526}
527
528static int hcd_pci_suspend_noirq(struct device *dev)
529{
530 struct pci_dev *pci_dev = to_pci_dev(dev);
531 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
532 int retval;
533
534 retval = check_root_hub_suspended(dev);
535 if (retval)
536 return retval;
537
538 pci_save_state(pci_dev);
539
540 /* If the root hub is dead rather than suspended, disallow remote
541 * wakeup. usb_hc_died() should ensure that both hosts are marked as
542 * dying, so we only need to check the primary roothub.
543 */
544 if (HCD_DEAD(hcd))
545 device_set_wakeup_enable(dev, 0);
546 dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
547
548 /* Possibly enable remote wakeup,
549 * choose the appropriate low-power state, and go to that state.
550 */
551 retval = pci_prepare_to_sleep(pci_dev);
552 if (retval == -EIO) { /* Low-power not supported */
553 dev_dbg(dev, "--> PCI D0 legacy\n");
554 retval = 0;
555 } else if (retval == 0) {
556 dev_dbg(dev, "--> PCI %s\n",
557 pci_power_name(pci_dev->current_state));
558 } else {
559 suspend_report_result(pci_prepare_to_sleep, retval);
560 return retval;
561 }
562
563 powermac_set_asic(pci_dev, 0);
564 return retval;
565}
566
567static int hcd_pci_resume_noirq(struct device *dev)
568{
569 powermac_set_asic(to_pci_dev(dev), 1);
570 return 0;
571}
572
573static int hcd_pci_resume(struct device *dev)
574{
575 return resume_common(dev, PM_EVENT_RESUME);
576}
577
578static int hcd_pci_restore(struct device *dev)
579{
580 return resume_common(dev, PM_EVENT_RESTORE);
581}
582
583#else
584
585#define hcd_pci_suspend NULL
586#define hcd_pci_suspend_noirq NULL
587#define hcd_pci_resume_noirq NULL
588#define hcd_pci_resume NULL
589#define hcd_pci_restore NULL
590
591#endif /* CONFIG_PM_SLEEP */
592
593static int hcd_pci_runtime_suspend(struct device *dev)
594{
595 int retval;
596
597 retval = suspend_common(dev, true);
598 if (retval == 0)
599 powermac_set_asic(to_pci_dev(dev), 0);
600 dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
601 return retval;
602}
603
604static int hcd_pci_runtime_resume(struct device *dev)
605{
606 int retval;
607
608 powermac_set_asic(to_pci_dev(dev), 1);
609 retval = resume_common(dev, PM_EVENT_AUTO_RESUME);
610 dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
611 return retval;
612}
613
614const struct dev_pm_ops usb_hcd_pci_pm_ops = {
615 .suspend = hcd_pci_suspend,
616 .suspend_noirq = hcd_pci_suspend_noirq,
617 .resume_noirq = hcd_pci_resume_noirq,
618 .resume = hcd_pci_resume,
619 .freeze = check_root_hub_suspended,
620 .freeze_noirq = check_root_hub_suspended,
621 .thaw_noirq = NULL,
622 .thaw = NULL,
623 .poweroff = hcd_pci_suspend,
624 .poweroff_noirq = hcd_pci_suspend_noirq,
625 .restore_noirq = hcd_pci_resume_noirq,
626 .restore = hcd_pci_restore,
627 .runtime_suspend = hcd_pci_runtime_suspend,
628 .runtime_resume = hcd_pci_runtime_resume,
629};
630EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
631
632#endif /* CONFIG_PM */