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