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