Merge branch 'x86-asm-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[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 hcd->amd_resume_bug = (usb_hcd_amd_remote_wakeup_quirk(dev) &&
219 driver->flags & (HCD_USB11 | HCD_USB3)) ? 1 : 0;
220
221 if (driver->flags & HCD_MEMORY) {
222 /* EHCI, OHCI */
223 hcd->rsrc_start = pci_resource_start(dev, 0);
224 hcd->rsrc_len = pci_resource_len(dev, 0);
225 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
226 driver->description)) {
227 dev_dbg(&dev->dev, "controller already in use\n");
228 retval = -EBUSY;
229 goto put_hcd;
230 }
231 hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
232 if (hcd->regs == NULL) {
233 dev_dbg(&dev->dev, "error mapping memory\n");
234 retval = -EFAULT;
235 goto release_mem_region;
236 }
237
238 } else {
239 /* UHCI */
240 int region;
241
242 for (region = 0; region < PCI_ROM_RESOURCE; region++) {
243 if (!(pci_resource_flags(dev, region) &
244 IORESOURCE_IO))
245 continue;
246
247 hcd->rsrc_start = pci_resource_start(dev, region);
248 hcd->rsrc_len = pci_resource_len(dev, region);
249 if (request_region(hcd->rsrc_start, hcd->rsrc_len,
250 driver->description))
251 break;
252 }
253 if (region == PCI_ROM_RESOURCE) {
254 dev_dbg(&dev->dev, "no i/o regions available\n");
255 retval = -EBUSY;
256 goto put_hcd;
257 }
258 }
259
260 pci_set_master(dev);
261
262 /* Note: dev_set_drvdata must be called while holding the rwsem */
263 if (dev->class == CL_EHCI) {
264 down_write(&companions_rwsem);
265 dev_set_drvdata(&dev->dev, hcd);
266 for_each_companion(dev, hcd, ehci_pre_add);
267 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
268 if (retval != 0)
269 dev_set_drvdata(&dev->dev, NULL);
270 for_each_companion(dev, hcd, ehci_post_add);
271 up_write(&companions_rwsem);
272 } else {
273 down_read(&companions_rwsem);
274 dev_set_drvdata(&dev->dev, hcd);
275 retval = usb_add_hcd(hcd, hcd_irq, IRQF_SHARED);
276 if (retval != 0)
277 dev_set_drvdata(&dev->dev, NULL);
278 else
279 for_each_companion(dev, hcd, non_ehci_add);
280 up_read(&companions_rwsem);
281 }
282
283 if (retval != 0)
284 goto unmap_registers;
285
286 if (pci_dev_run_wake(dev))
287 pm_runtime_put_noidle(&dev->dev);
288 return retval;
289
290 unmap_registers:
291 if (driver->flags & HCD_MEMORY) {
292 iounmap(hcd->regs);
293 release_mem_region:
294 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
295 } else
296 release_region(hcd->rsrc_start, hcd->rsrc_len);
297 put_hcd:
298 usb_put_hcd(hcd);
299 disable_pci:
300 pci_disable_device(dev);
301 dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
302 return retval;
303 }
304 EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
305
306
307 /* may be called without controller electrically present */
308 /* may be called with controller, bus, and devices active */
309
310 /**
311 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
312 * @dev: USB Host Controller being removed
313 * Context: !in_interrupt()
314 *
315 * Reverses the effect of usb_hcd_pci_probe(), first invoking
316 * the HCD's stop() method. It is always called from a thread
317 * context, normally "rmmod", "apmd", or something similar.
318 *
319 * Store this function in the HCD's struct pci_driver as remove().
320 */
321 void usb_hcd_pci_remove(struct pci_dev *dev)
322 {
323 struct usb_hcd *hcd;
324
325 hcd = pci_get_drvdata(dev);
326 if (!hcd)
327 return;
328
329 if (pci_dev_run_wake(dev))
330 pm_runtime_get_noresume(&dev->dev);
331
332 /* Fake an interrupt request in order to give the driver a chance
333 * to test whether the controller hardware has been removed (e.g.,
334 * cardbus physical eject).
335 */
336 local_irq_disable();
337 usb_hcd_irq(0, hcd);
338 local_irq_enable();
339
340 /* Note: dev_set_drvdata must be called while holding the rwsem */
341 if (dev->class == CL_EHCI) {
342 down_write(&companions_rwsem);
343 for_each_companion(dev, hcd, ehci_remove);
344 usb_remove_hcd(hcd);
345 dev_set_drvdata(&dev->dev, NULL);
346 up_write(&companions_rwsem);
347 } else {
348 /* Not EHCI; just clear the companion pointer */
349 down_read(&companions_rwsem);
350 hcd->self.hs_companion = NULL;
351 usb_remove_hcd(hcd);
352 dev_set_drvdata(&dev->dev, NULL);
353 up_read(&companions_rwsem);
354 }
355
356 if (hcd->driver->flags & HCD_MEMORY) {
357 iounmap(hcd->regs);
358 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
359 } else {
360 release_region(hcd->rsrc_start, hcd->rsrc_len);
361 }
362
363 usb_put_hcd(hcd);
364 pci_disable_device(dev);
365 }
366 EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
367
368 /**
369 * usb_hcd_pci_shutdown - shutdown host controller
370 * @dev: USB Host Controller being shutdown
371 */
372 void usb_hcd_pci_shutdown(struct pci_dev *dev)
373 {
374 struct usb_hcd *hcd;
375
376 hcd = pci_get_drvdata(dev);
377 if (!hcd)
378 return;
379
380 if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags) &&
381 hcd->driver->shutdown) {
382 hcd->driver->shutdown(hcd);
383 pci_disable_device(dev);
384 }
385 }
386 EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
387
388 #ifdef CONFIG_PM
389
390 #ifdef CONFIG_PPC_PMAC
391 static void powermac_set_asic(struct pci_dev *pci_dev, int enable)
392 {
393 /* Enanble or disable ASIC clocks for USB */
394 if (machine_is(powermac)) {
395 struct device_node *of_node;
396
397 of_node = pci_device_to_OF_node(pci_dev);
398 if (of_node)
399 pmac_call_feature(PMAC_FTR_USB_ENABLE,
400 of_node, 0, enable);
401 }
402 }
403
404 #else
405
406 static inline void powermac_set_asic(struct pci_dev *pci_dev, int enable)
407 {}
408
409 #endif /* CONFIG_PPC_PMAC */
410
411 static int check_root_hub_suspended(struct device *dev)
412 {
413 struct pci_dev *pci_dev = to_pci_dev(dev);
414 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
415
416 if (HCD_RH_RUNNING(hcd)) {
417 dev_warn(dev, "Root hub is not suspended\n");
418 return -EBUSY;
419 }
420 if (hcd->shared_hcd) {
421 hcd = hcd->shared_hcd;
422 if (HCD_RH_RUNNING(hcd)) {
423 dev_warn(dev, "Secondary root hub is not suspended\n");
424 return -EBUSY;
425 }
426 }
427 return 0;
428 }
429
430 #if defined(CONFIG_PM_SLEEP) || defined(CONFIG_PM_RUNTIME)
431 static int suspend_common(struct device *dev, bool do_wakeup)
432 {
433 struct pci_dev *pci_dev = to_pci_dev(dev);
434 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
435 int retval;
436
437 /* Root hub suspend should have stopped all downstream traffic,
438 * and all bus master traffic. And done so for both the interface
439 * and the stub usb_device (which we check here). But maybe it
440 * didn't; writing sysfs power/state files ignores such rules...
441 */
442 retval = check_root_hub_suspended(dev);
443 if (retval)
444 return retval;
445
446 if (hcd->driver->pci_suspend && !HCD_DEAD(hcd)) {
447 /* Optimization: Don't suspend if a root-hub wakeup is
448 * pending and it would cause the HCD to wake up anyway.
449 */
450 if (do_wakeup && HCD_WAKEUP_PENDING(hcd))
451 return -EBUSY;
452 if (do_wakeup && hcd->shared_hcd &&
453 HCD_WAKEUP_PENDING(hcd->shared_hcd))
454 return -EBUSY;
455 retval = hcd->driver->pci_suspend(hcd, do_wakeup);
456 suspend_report_result(hcd->driver->pci_suspend, retval);
457
458 /* Check again in case wakeup raced with pci_suspend */
459 if ((retval == 0 && do_wakeup && HCD_WAKEUP_PENDING(hcd)) ||
460 (retval == 0 && do_wakeup && hcd->shared_hcd &&
461 HCD_WAKEUP_PENDING(hcd->shared_hcd))) {
462 if (hcd->driver->pci_resume)
463 hcd->driver->pci_resume(hcd, false);
464 retval = -EBUSY;
465 }
466 if (retval)
467 return retval;
468 }
469
470 /* If MSI-X is enabled, the driver will have synchronized all vectors
471 * in pci_suspend(). If MSI or legacy PCI is enabled, that will be
472 * synchronized here.
473 */
474 if (!hcd->msix_enabled)
475 synchronize_irq(pci_dev->irq);
476
477 /* Downstream ports from this root hub should already be quiesced, so
478 * there will be no DMA activity. Now we can shut down the upstream
479 * link (except maybe for PME# resume signaling). We'll enter a
480 * low power state during suspend_noirq, if the hardware allows.
481 */
482 pci_disable_device(pci_dev);
483 return retval;
484 }
485
486 static int resume_common(struct device *dev, int event)
487 {
488 struct pci_dev *pci_dev = to_pci_dev(dev);
489 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
490 int retval;
491
492 if (HCD_RH_RUNNING(hcd) ||
493 (hcd->shared_hcd &&
494 HCD_RH_RUNNING(hcd->shared_hcd))) {
495 dev_dbg(dev, "can't resume, not suspended!\n");
496 return 0;
497 }
498
499 retval = pci_enable_device(pci_dev);
500 if (retval < 0) {
501 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
502 return retval;
503 }
504
505 pci_set_master(pci_dev);
506
507 if (hcd->driver->pci_resume && !HCD_DEAD(hcd)) {
508
509 /*
510 * Only EHCI controllers have to wait for their companions.
511 * No locking is needed because PCI controller drivers do not
512 * get unbound during system resume.
513 */
514 if (pci_dev->class == CL_EHCI && event != PM_EVENT_AUTO_RESUME)
515 for_each_companion(pci_dev, hcd,
516 ehci_wait_for_companions);
517
518 retval = hcd->driver->pci_resume(hcd,
519 event == PM_EVENT_RESTORE);
520 if (retval) {
521 dev_err(dev, "PCI post-resume error %d!\n", retval);
522 if (hcd->shared_hcd)
523 usb_hc_died(hcd->shared_hcd);
524 usb_hc_died(hcd);
525 }
526 }
527 return retval;
528 }
529 #endif /* SLEEP || RUNTIME */
530
531 #ifdef CONFIG_PM_SLEEP
532
533 static int hcd_pci_suspend(struct device *dev)
534 {
535 return suspend_common(dev, device_may_wakeup(dev));
536 }
537
538 static int hcd_pci_suspend_noirq(struct device *dev)
539 {
540 struct pci_dev *pci_dev = to_pci_dev(dev);
541 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
542 int retval;
543
544 retval = check_root_hub_suspended(dev);
545 if (retval)
546 return retval;
547
548 pci_save_state(pci_dev);
549
550 /* If the root hub is dead rather than suspended, disallow remote
551 * wakeup. usb_hc_died() should ensure that both hosts are marked as
552 * dying, so we only need to check the primary roothub.
553 */
554 if (HCD_DEAD(hcd))
555 device_set_wakeup_enable(dev, 0);
556 dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
557
558 /* Possibly enable remote wakeup,
559 * choose the appropriate low-power state, and go to that state.
560 */
561 retval = pci_prepare_to_sleep(pci_dev);
562 if (retval == -EIO) { /* Low-power not supported */
563 dev_dbg(dev, "--> PCI D0 legacy\n");
564 retval = 0;
565 } else if (retval == 0) {
566 dev_dbg(dev, "--> PCI %s\n",
567 pci_power_name(pci_dev->current_state));
568 } else {
569 suspend_report_result(pci_prepare_to_sleep, retval);
570 return retval;
571 }
572
573 powermac_set_asic(pci_dev, 0);
574 return retval;
575 }
576
577 static int hcd_pci_resume_noirq(struct device *dev)
578 {
579 struct pci_dev *pci_dev = to_pci_dev(dev);
580
581 powermac_set_asic(pci_dev, 1);
582
583 /* Go back to D0 and disable remote wakeup */
584 pci_back_from_sleep(pci_dev);
585 return 0;
586 }
587
588 static int hcd_pci_resume(struct device *dev)
589 {
590 return resume_common(dev, PM_EVENT_RESUME);
591 }
592
593 static int hcd_pci_restore(struct device *dev)
594 {
595 return resume_common(dev, PM_EVENT_RESTORE);
596 }
597
598 #else
599
600 #define hcd_pci_suspend NULL
601 #define hcd_pci_suspend_noirq NULL
602 #define hcd_pci_resume_noirq NULL
603 #define hcd_pci_resume NULL
604 #define hcd_pci_restore NULL
605
606 #endif /* CONFIG_PM_SLEEP */
607
608 #ifdef CONFIG_PM_RUNTIME
609
610 static int hcd_pci_runtime_suspend(struct device *dev)
611 {
612 int retval;
613
614 retval = suspend_common(dev, true);
615 if (retval == 0)
616 powermac_set_asic(to_pci_dev(dev), 0);
617 dev_dbg(dev, "hcd_pci_runtime_suspend: %d\n", retval);
618 return retval;
619 }
620
621 static int hcd_pci_runtime_resume(struct device *dev)
622 {
623 int retval;
624
625 powermac_set_asic(to_pci_dev(dev), 1);
626 retval = resume_common(dev, PM_EVENT_AUTO_RESUME);
627 dev_dbg(dev, "hcd_pci_runtime_resume: %d\n", retval);
628 return retval;
629 }
630
631 #else
632
633 #define hcd_pci_runtime_suspend NULL
634 #define hcd_pci_runtime_resume NULL
635
636 #endif /* CONFIG_PM_RUNTIME */
637
638 const struct dev_pm_ops usb_hcd_pci_pm_ops = {
639 .suspend = hcd_pci_suspend,
640 .suspend_noirq = hcd_pci_suspend_noirq,
641 .resume_noirq = hcd_pci_resume_noirq,
642 .resume = hcd_pci_resume,
643 .freeze = check_root_hub_suspended,
644 .freeze_noirq = check_root_hub_suspended,
645 .thaw_noirq = NULL,
646 .thaw = NULL,
647 .poweroff = hcd_pci_suspend,
648 .poweroff_noirq = hcd_pci_suspend_noirq,
649 .restore_noirq = hcd_pci_resume_noirq,
650 .restore = hcd_pci_restore,
651 .runtime_suspend = hcd_pci_runtime_suspend,
652 .runtime_resume = hcd_pci_runtime_resume,
653 };
654 EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
655
656 #endif /* CONFIG_PM */
This page took 0.096872 seconds and 5 git commands to generate.