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