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/*
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 */