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