1 // SPDX-License-Identifier: GPL-2.0
3 * (C) Copyright 2002-2004, 2007 Greg Kroah-Hartman <greg@kroah.com>
4 * (C) Copyright 2007 Novell Inc.
8 #include <linux/module.h>
9 #include <linux/init.h>
10 #include <linux/device.h>
11 #include <linux/mempolicy.h>
12 #include <linux/string.h>
13 #include <linux/slab.h>
14 #include <linux/sched.h>
15 #include <linux/sched/isolation.h>
16 #include <linux/cpu.h>
17 #include <linux/pm_runtime.h>
18 #include <linux/suspend.h>
19 #include <linux/kexec.h>
20 #include <linux/of_device.h>
21 #include <linux/acpi.h>
22 #include <linux/dma-map-ops.h>
24 #include "pcie/portdrv.h"
27 struct list_head node;
28 struct pci_device_id id;
32 * pci_add_dynid - add a new PCI device ID to this driver and re-probe devices
33 * @drv: target pci driver
34 * @vendor: PCI vendor ID
35 * @device: PCI device ID
36 * @subvendor: PCI subvendor ID
37 * @subdevice: PCI subdevice ID
39 * @class_mask: PCI class mask
40 * @driver_data: private driver data
42 * Adds a new dynamic pci device ID to this driver and causes the
43 * driver to probe for all devices again. @drv must have been
44 * registered prior to calling this function.
47 * Does GFP_KERNEL allocation.
50 * 0 on success, -errno on failure.
52 int pci_add_dynid(struct pci_driver *drv,
53 unsigned int vendor, unsigned int device,
54 unsigned int subvendor, unsigned int subdevice,
55 unsigned int class, unsigned int class_mask,
56 unsigned long driver_data)
58 struct pci_dynid *dynid;
60 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
64 dynid->id.vendor = vendor;
65 dynid->id.device = device;
66 dynid->id.subvendor = subvendor;
67 dynid->id.subdevice = subdevice;
68 dynid->id.class = class;
69 dynid->id.class_mask = class_mask;
70 dynid->id.driver_data = driver_data;
72 spin_lock(&drv->dynids.lock);
73 list_add_tail(&dynid->node, &drv->dynids.list);
74 spin_unlock(&drv->dynids.lock);
76 return driver_attach(&drv->driver);
78 EXPORT_SYMBOL_GPL(pci_add_dynid);
80 static void pci_free_dynids(struct pci_driver *drv)
82 struct pci_dynid *dynid, *n;
84 spin_lock(&drv->dynids.lock);
85 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
86 list_del(&dynid->node);
89 spin_unlock(&drv->dynids.lock);
93 * pci_match_id - See if a PCI device matches a given pci_id table
94 * @ids: array of PCI device ID structures to search in
95 * @dev: the PCI device structure to match against.
97 * Used by a driver to check whether a PCI device is in its list of
98 * supported devices. Returns the matching pci_device_id structure or
99 * %NULL if there is no match.
101 * Deprecated; don't use this as it will not catch any dynamic IDs
102 * that a driver might want to check for.
104 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
108 while (ids->vendor || ids->subvendor || ids->class_mask) {
109 if (pci_match_one_device(ids, dev))
116 EXPORT_SYMBOL(pci_match_id);
118 static const struct pci_device_id pci_device_id_any = {
119 .vendor = PCI_ANY_ID,
120 .device = PCI_ANY_ID,
121 .subvendor = PCI_ANY_ID,
122 .subdevice = PCI_ANY_ID,
126 * pci_match_device - See if a device matches a driver's list of IDs
127 * @drv: the PCI driver to match against
128 * @dev: the PCI device structure to match against
130 * Used by a driver to check whether a PCI device is in its list of
131 * supported devices or in the dynids list, which may have been augmented
132 * via the sysfs "new_id" file. Returns the matching pci_device_id
133 * structure or %NULL if there is no match.
135 static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
138 struct pci_dynid *dynid;
139 const struct pci_device_id *found_id = NULL, *ids;
141 /* When driver_override is set, only bind to the matching driver */
142 if (dev->driver_override && strcmp(dev->driver_override, drv->name))
145 /* Look at the dynamic ids first, before the static ones */
146 spin_lock(&drv->dynids.lock);
147 list_for_each_entry(dynid, &drv->dynids.list, node) {
148 if (pci_match_one_device(&dynid->id, dev)) {
149 found_id = &dynid->id;
153 spin_unlock(&drv->dynids.lock);
158 for (ids = drv->id_table; (found_id = pci_match_id(ids, dev));
159 ids = found_id + 1) {
161 * The match table is split based on driver_override.
162 * In case override_only was set, enforce driver_override
165 if (found_id->override_only) {
166 if (dev->driver_override)
173 /* driver_override will always match, send a dummy id */
174 if (dev->driver_override)
175 return &pci_device_id_any;
180 * new_id_store - sysfs frontend to pci_add_dynid()
181 * @driver: target device driver
182 * @buf: buffer for scanning device ID data
185 * Allow PCI IDs to be added to an existing driver via sysfs.
187 static ssize_t new_id_store(struct device_driver *driver, const char *buf,
190 struct pci_driver *pdrv = to_pci_driver(driver);
191 const struct pci_device_id *ids = pdrv->id_table;
192 u32 vendor, device, subvendor = PCI_ANY_ID,
193 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
194 unsigned long driver_data = 0;
198 fields = sscanf(buf, "%x %x %x %x %x %x %lx",
199 &vendor, &device, &subvendor, &subdevice,
200 &class, &class_mask, &driver_data);
205 struct pci_dev *pdev = kzalloc(sizeof(*pdev), GFP_KERNEL);
209 pdev->vendor = vendor;
210 pdev->device = device;
211 pdev->subsystem_vendor = subvendor;
212 pdev->subsystem_device = subdevice;
215 if (pci_match_device(pdrv, pdev))
224 /* Only accept driver_data values that match an existing id_table
228 while (ids->vendor || ids->subvendor || ids->class_mask) {
229 if (driver_data == ids->driver_data) {
235 if (retval) /* No match */
239 retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
240 class, class_mask, driver_data);
245 static DRIVER_ATTR_WO(new_id);
248 * remove_id_store - remove a PCI device ID from this driver
249 * @driver: target device driver
250 * @buf: buffer for scanning device ID data
253 * Removes a dynamic pci device ID to this driver.
255 static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
258 struct pci_dynid *dynid, *n;
259 struct pci_driver *pdrv = to_pci_driver(driver);
260 u32 vendor, device, subvendor = PCI_ANY_ID,
261 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
263 size_t retval = -ENODEV;
265 fields = sscanf(buf, "%x %x %x %x %x %x",
266 &vendor, &device, &subvendor, &subdevice,
267 &class, &class_mask);
271 spin_lock(&pdrv->dynids.lock);
272 list_for_each_entry_safe(dynid, n, &pdrv->dynids.list, node) {
273 struct pci_device_id *id = &dynid->id;
274 if ((id->vendor == vendor) &&
275 (id->device == device) &&
276 (subvendor == PCI_ANY_ID || id->subvendor == subvendor) &&
277 (subdevice == PCI_ANY_ID || id->subdevice == subdevice) &&
278 !((id->class ^ class) & class_mask)) {
279 list_del(&dynid->node);
285 spin_unlock(&pdrv->dynids.lock);
289 static DRIVER_ATTR_WO(remove_id);
291 static struct attribute *pci_drv_attrs[] = {
292 &driver_attr_new_id.attr,
293 &driver_attr_remove_id.attr,
296 ATTRIBUTE_GROUPS(pci_drv);
298 struct drv_dev_and_id {
299 struct pci_driver *drv;
301 const struct pci_device_id *id;
304 static long local_pci_probe(void *_ddi)
306 struct drv_dev_and_id *ddi = _ddi;
307 struct pci_dev *pci_dev = ddi->dev;
308 struct pci_driver *pci_drv = ddi->drv;
309 struct device *dev = &pci_dev->dev;
313 * Unbound PCI devices are always put in D0, regardless of
314 * runtime PM status. During probe, the device is set to
315 * active and the usage count is incremented. If the driver
316 * supports runtime PM, it should call pm_runtime_put_noidle(),
317 * or any other runtime PM helper function decrementing the usage
318 * count, in its probe routine and pm_runtime_get_noresume() in
319 * its remove routine.
321 pm_runtime_get_sync(dev);
322 pci_dev->driver = pci_drv;
323 rc = pci_drv->probe(pci_dev, ddi->id);
327 pci_dev->driver = NULL;
328 pm_runtime_put_sync(dev);
332 * Probe function should return < 0 for failure, 0 for success
333 * Treat values > 0 as success, but warn.
335 pci_warn(pci_dev, "Driver probe function unexpectedly returned %d\n",
340 static bool pci_physfn_is_probed(struct pci_dev *dev)
342 #ifdef CONFIG_PCI_IOV
343 return dev->is_virtfn && dev->physfn->is_probed;
349 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
350 const struct pci_device_id *id)
352 int error, node, cpu;
353 struct drv_dev_and_id ddi = { drv, dev, id };
356 * Execute driver initialization on node where the device is
357 * attached. This way the driver likely allocates its local memory
360 node = dev_to_node(&dev->dev);
363 cpu_hotplug_disable();
366 * Prevent nesting work_on_cpu() for the case where a Virtual Function
367 * device is probed from work_on_cpu() of the Physical device.
369 if (node < 0 || node >= MAX_NUMNODES || !node_online(node) ||
370 pci_physfn_is_probed(dev)) {
373 cpumask_var_t wq_domain_mask;
375 if (!zalloc_cpumask_var(&wq_domain_mask, GFP_KERNEL)) {
379 cpumask_and(wq_domain_mask,
380 housekeeping_cpumask(HK_TYPE_WQ),
381 housekeeping_cpumask(HK_TYPE_DOMAIN));
383 cpu = cpumask_any_and(cpumask_of_node(node),
385 free_cpumask_var(wq_domain_mask);
388 if (cpu < nr_cpu_ids)
389 error = work_on_cpu(cpu, local_pci_probe, &ddi);
391 error = local_pci_probe(&ddi);
394 cpu_hotplug_enable();
399 * __pci_device_probe - check if a driver wants to claim a specific PCI device
400 * @drv: driver to call to check if it wants the PCI device
401 * @pci_dev: PCI device being probed
403 * returns 0 on success, else error.
404 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
406 static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
408 const struct pci_device_id *id;
414 id = pci_match_device(drv, pci_dev);
416 error = pci_call_probe(drv, pci_dev, id);
421 int __weak pcibios_alloc_irq(struct pci_dev *dev)
426 void __weak pcibios_free_irq(struct pci_dev *dev)
430 #ifdef CONFIG_PCI_IOV
431 static inline bool pci_device_can_probe(struct pci_dev *pdev)
433 return (!pdev->is_virtfn || pdev->physfn->sriov->drivers_autoprobe ||
434 pdev->driver_override);
437 static inline bool pci_device_can_probe(struct pci_dev *pdev)
443 static int pci_device_probe(struct device *dev)
446 struct pci_dev *pci_dev = to_pci_dev(dev);
447 struct pci_driver *drv = to_pci_driver(dev->driver);
449 if (!pci_device_can_probe(pci_dev))
452 pci_assign_irq(pci_dev);
454 error = pcibios_alloc_irq(pci_dev);
458 pci_dev_get(pci_dev);
459 error = __pci_device_probe(drv, pci_dev);
461 pcibios_free_irq(pci_dev);
462 pci_dev_put(pci_dev);
468 static void pci_device_remove(struct device *dev)
470 struct pci_dev *pci_dev = to_pci_dev(dev);
471 struct pci_driver *drv = pci_dev->driver;
474 pm_runtime_get_sync(dev);
475 drv->remove(pci_dev);
476 pm_runtime_put_noidle(dev);
478 pcibios_free_irq(pci_dev);
479 pci_dev->driver = NULL;
480 pci_iov_remove(pci_dev);
482 /* Undo the runtime PM settings in local_pci_probe() */
483 pm_runtime_put_sync(dev);
486 * If the device is still on, set the power state as "unknown",
487 * since it might change by the next time we load the driver.
489 if (pci_dev->current_state == PCI_D0)
490 pci_dev->current_state = PCI_UNKNOWN;
493 * We would love to complain here if pci_dev->is_enabled is set, that
494 * the driver should have called pci_disable_device(), but the
495 * unfortunate fact is there are too many odd BIOS and bridge setups
496 * that don't like drivers doing that all of the time.
497 * Oh well, we can dream of sane hardware when we sleep, no matter how
498 * horrible the crap we have to deal with is when we are awake...
501 pci_dev_put(pci_dev);
504 static void pci_device_shutdown(struct device *dev)
506 struct pci_dev *pci_dev = to_pci_dev(dev);
507 struct pci_driver *drv = pci_dev->driver;
509 pm_runtime_resume(dev);
511 if (drv && drv->shutdown)
512 drv->shutdown(pci_dev);
515 * If this is a kexec reboot, turn off Bus Master bit on the
516 * device to tell it to not continue to do DMA. Don't touch
517 * devices in D3cold or unknown states.
518 * If it is not a kexec reboot, firmware will hit the PCI
519 * devices with big hammer and stop their DMA any way.
521 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
522 pci_clear_master(pci_dev);
525 #ifdef CONFIG_PM_SLEEP
527 /* Auxiliary functions used for system resume */
530 * pci_restore_standard_config - restore standard config registers of PCI device
531 * @pci_dev: PCI device to handle
533 static int pci_restore_standard_config(struct pci_dev *pci_dev)
535 pci_update_current_state(pci_dev, PCI_UNKNOWN);
537 if (pci_dev->current_state != PCI_D0) {
538 int error = pci_set_power_state(pci_dev, PCI_D0);
543 pci_restore_state(pci_dev);
544 pci_pme_restore(pci_dev);
547 #endif /* CONFIG_PM_SLEEP */
551 /* Auxiliary functions used for system resume and run-time resume */
553 static void pci_pm_default_resume(struct pci_dev *pci_dev)
555 pci_fixup_device(pci_fixup_resume, pci_dev);
556 pci_enable_wake(pci_dev, PCI_D0, false);
559 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
561 pci_power_up(pci_dev);
562 pci_update_current_state(pci_dev, PCI_D0);
563 pci_restore_state(pci_dev);
564 pci_pme_restore(pci_dev);
567 static void pci_pm_bridge_power_up_actions(struct pci_dev *pci_dev)
569 pci_bridge_wait_for_secondary_bus(pci_dev);
571 * When powering on a bridge from D3cold, the whole hierarchy may be
572 * powered on into D0uninitialized state, resume them to give them a
573 * chance to suspend again
575 pci_resume_bus(pci_dev->subordinate);
578 #endif /* CONFIG_PM */
580 #ifdef CONFIG_PM_SLEEP
583 * Default "suspend" method for devices that have no driver provided suspend,
584 * or not even a driver at all (second part).
586 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
589 * mark its power state as "unknown", since we don't know if
590 * e.g. the BIOS will change its device state when we suspend.
592 if (pci_dev->current_state == PCI_D0)
593 pci_dev->current_state = PCI_UNKNOWN;
597 * Default "resume" method for devices that have no driver provided resume,
598 * or not even a driver at all (second part).
600 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
604 /* if the device was enabled before suspend, re-enable */
605 retval = pci_reenable_device(pci_dev);
607 * if the device was busmaster before the suspend, make it busmaster
610 if (pci_dev->is_busmaster)
611 pci_set_master(pci_dev);
616 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
618 struct pci_dev *pci_dev = to_pci_dev(dev);
619 struct pci_driver *drv = pci_dev->driver;
621 if (drv && drv->suspend) {
622 pci_power_t prev = pci_dev->current_state;
625 error = drv->suspend(pci_dev, state);
626 suspend_report_result(dev, drv->suspend, error);
630 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
631 && pci_dev->current_state != PCI_UNKNOWN) {
632 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
633 "PCI PM: Device state not saved by %pS\n",
638 pci_fixup_device(pci_fixup_suspend, pci_dev);
643 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
645 struct pci_dev *pci_dev = to_pci_dev(dev);
647 if (!pci_dev->state_saved)
648 pci_save_state(pci_dev);
650 pci_pm_set_unknown_state(pci_dev);
652 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
657 static int pci_legacy_resume(struct device *dev)
659 struct pci_dev *pci_dev = to_pci_dev(dev);
660 struct pci_driver *drv = pci_dev->driver;
662 pci_fixup_device(pci_fixup_resume, pci_dev);
664 return drv && drv->resume ?
665 drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
668 /* Auxiliary functions used by the new power management framework */
670 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
672 /* Disable non-bridge devices without PM support */
673 if (!pci_has_subordinate(pci_dev))
674 pci_disable_enabled_device(pci_dev);
677 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
679 struct pci_driver *drv = pci_dev->driver;
680 bool ret = drv && (drv->suspend || drv->resume);
683 * Legacy PM support is used by default, so warn if the new framework is
684 * supported as well. Drivers are supposed to support either the
685 * former, or the latter, but not both at the same time.
687 pci_WARN(pci_dev, ret && drv->driver.pm, "device %04x:%04x\n",
688 pci_dev->vendor, pci_dev->device);
693 /* New power management framework */
695 static int pci_pm_prepare(struct device *dev)
697 struct pci_dev *pci_dev = to_pci_dev(dev);
698 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
700 if (pm && pm->prepare) {
701 int error = pm->prepare(dev);
705 if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
708 if (pci_dev_need_resume(pci_dev))
712 * The PME setting needs to be adjusted here in case the direct-complete
713 * optimization is used with respect to this device.
715 pci_dev_adjust_pme(pci_dev);
719 static void pci_pm_complete(struct device *dev)
721 struct pci_dev *pci_dev = to_pci_dev(dev);
723 pci_dev_complete_resume(pci_dev);
724 pm_generic_complete(dev);
726 /* Resume device if platform firmware has put it in reset-power-on */
727 if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) {
728 pci_power_t pre_sleep_state = pci_dev->current_state;
730 pci_refresh_power_state(pci_dev);
732 * On platforms with ACPI this check may also trigger for
733 * devices sharing power resources if one of those power
734 * resources has been activated as a result of a change of the
735 * power state of another device sharing it. However, in that
736 * case it is also better to resume the device, in general.
738 if (pci_dev->current_state < pre_sleep_state)
739 pm_request_resume(dev);
743 #else /* !CONFIG_PM_SLEEP */
745 #define pci_pm_prepare NULL
746 #define pci_pm_complete NULL
748 #endif /* !CONFIG_PM_SLEEP */
750 #ifdef CONFIG_SUSPEND
751 static void pcie_pme_root_status_cleanup(struct pci_dev *pci_dev)
754 * Some BIOSes forget to clear Root PME Status bits after system
755 * wakeup, which breaks ACPI-based runtime wakeup on PCI Express.
756 * Clear those bits now just in case (shouldn't hurt).
758 if (pci_is_pcie(pci_dev) &&
759 (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT ||
760 pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC))
761 pcie_clear_root_pme_status(pci_dev);
764 static int pci_pm_suspend(struct device *dev)
766 struct pci_dev *pci_dev = to_pci_dev(dev);
767 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
769 pci_dev->skip_bus_pm = false;
771 if (pci_has_legacy_pm_support(pci_dev))
772 return pci_legacy_suspend(dev, PMSG_SUSPEND);
775 pci_pm_default_suspend(pci_dev);
780 * PCI devices suspended at run time may need to be resumed at this
781 * point, because in general it may be necessary to reconfigure them for
782 * system suspend. Namely, if the device is expected to wake up the
783 * system from the sleep state, it may have to be reconfigured for this
784 * purpose, or if the device is not expected to wake up the system from
785 * the sleep state, it should be prevented from signaling wakeup events
788 * Also if the driver of the device does not indicate that its system
789 * suspend callbacks can cope with runtime-suspended devices, it is
790 * better to resume the device from runtime suspend here.
792 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
793 pci_dev_need_resume(pci_dev)) {
794 pm_runtime_resume(dev);
795 pci_dev->state_saved = false;
797 pci_dev_adjust_pme(pci_dev);
801 pci_power_t prev = pci_dev->current_state;
804 error = pm->suspend(dev);
805 suspend_report_result(dev, pm->suspend, error);
809 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
810 && pci_dev->current_state != PCI_UNKNOWN) {
811 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
812 "PCI PM: State of device not saved by %pS\n",
820 static int pci_pm_suspend_late(struct device *dev)
822 if (dev_pm_skip_suspend(dev))
825 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
827 return pm_generic_suspend_late(dev);
830 static int pci_pm_suspend_noirq(struct device *dev)
832 struct pci_dev *pci_dev = to_pci_dev(dev);
833 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
835 if (dev_pm_skip_suspend(dev))
838 if (pci_has_legacy_pm_support(pci_dev))
839 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
842 pci_save_state(pci_dev);
846 if (pm->suspend_noirq) {
847 pci_power_t prev = pci_dev->current_state;
850 error = pm->suspend_noirq(dev);
851 suspend_report_result(dev, pm->suspend_noirq, error);
855 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
856 && pci_dev->current_state != PCI_UNKNOWN) {
857 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
858 "PCI PM: State of device not saved by %pS\n",
864 if (pci_dev->skip_bus_pm) {
866 * Either the device is a bridge with a child in D0 below it, or
867 * the function is running for the second time in a row without
868 * going through full resume, which is possible only during
869 * suspend-to-idle in a spurious wakeup case. The device should
870 * be in D0 at this point, but if it is a bridge, it may be
871 * necessary to save its state.
873 if (!pci_dev->state_saved)
874 pci_save_state(pci_dev);
875 } else if (!pci_dev->state_saved) {
876 pci_save_state(pci_dev);
877 if (pci_power_manageable(pci_dev))
878 pci_prepare_to_sleep(pci_dev);
881 pci_dbg(pci_dev, "PCI PM: Suspend power state: %s\n",
882 pci_power_name(pci_dev->current_state));
884 if (pci_dev->current_state == PCI_D0) {
885 pci_dev->skip_bus_pm = true;
887 * Per PCI PM r1.2, table 6-1, a bridge must be in D0 if any
888 * downstream device is in D0, so avoid changing the power state
889 * of the parent bridge by setting the skip_bus_pm flag for it.
891 if (pci_dev->bus->self)
892 pci_dev->bus->self->skip_bus_pm = true;
895 if (pci_dev->skip_bus_pm && pm_suspend_no_platform()) {
896 pci_dbg(pci_dev, "PCI PM: Skipped\n");
900 pci_pm_set_unknown_state(pci_dev);
903 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
904 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
905 * hasn't been quiesced and tries to turn it off. If the controller
906 * is already in D3, this can hang or cause memory corruption.
908 * Since the value of the COMMAND register doesn't matter once the
909 * device has been suspended, we can safely set it to 0 here.
911 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
912 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
915 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
918 * If the target system sleep state is suspend-to-idle, it is sufficient
919 * to check whether or not the device's wakeup settings are good for
920 * runtime PM. Otherwise, the pm_resume_via_firmware() check will cause
921 * pci_pm_complete() to take care of fixing up the device's state
922 * anyway, if need be.
924 if (device_can_wakeup(dev) && !device_may_wakeup(dev))
925 dev->power.may_skip_resume = false;
930 static int pci_pm_resume_noirq(struct device *dev)
932 struct pci_dev *pci_dev = to_pci_dev(dev);
933 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
934 pci_power_t prev_state = pci_dev->current_state;
935 bool skip_bus_pm = pci_dev->skip_bus_pm;
937 if (dev_pm_skip_resume(dev))
941 * In the suspend-to-idle case, devices left in D0 during suspend will
942 * stay in D0, so it is not necessary to restore or update their
943 * configuration here and attempting to put them into D0 again is
944 * pointless, so avoid doing that.
946 if (!(skip_bus_pm && pm_suspend_no_platform()))
947 pci_pm_default_resume_early(pci_dev);
949 pci_fixup_device(pci_fixup_resume_early, pci_dev);
950 pcie_pme_root_status_cleanup(pci_dev);
952 if (!skip_bus_pm && prev_state == PCI_D3cold)
953 pci_pm_bridge_power_up_actions(pci_dev);
955 if (pci_has_legacy_pm_support(pci_dev))
958 if (pm && pm->resume_noirq)
959 return pm->resume_noirq(dev);
964 static int pci_pm_resume_early(struct device *dev)
966 if (dev_pm_skip_resume(dev))
969 return pm_generic_resume_early(dev);
972 static int pci_pm_resume(struct device *dev)
974 struct pci_dev *pci_dev = to_pci_dev(dev);
975 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
978 * This is necessary for the suspend error path in which resume is
979 * called without restoring the standard config registers of the device.
981 if (pci_dev->state_saved)
982 pci_restore_standard_config(pci_dev);
984 if (pci_has_legacy_pm_support(pci_dev))
985 return pci_legacy_resume(dev);
987 pci_pm_default_resume(pci_dev);
991 return pm->resume(dev);
993 pci_pm_reenable_device(pci_dev);
999 #else /* !CONFIG_SUSPEND */
1001 #define pci_pm_suspend NULL
1002 #define pci_pm_suspend_late NULL
1003 #define pci_pm_suspend_noirq NULL
1004 #define pci_pm_resume NULL
1005 #define pci_pm_resume_early NULL
1006 #define pci_pm_resume_noirq NULL
1008 #endif /* !CONFIG_SUSPEND */
1010 #ifdef CONFIG_HIBERNATE_CALLBACKS
1012 static int pci_pm_freeze(struct device *dev)
1014 struct pci_dev *pci_dev = to_pci_dev(dev);
1015 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1017 if (pci_has_legacy_pm_support(pci_dev))
1018 return pci_legacy_suspend(dev, PMSG_FREEZE);
1021 pci_pm_default_suspend(pci_dev);
1026 * Resume all runtime-suspended devices before creating a snapshot
1027 * image of system memory, because the restore kernel generally cannot
1028 * be expected to always handle them consistently and they need to be
1029 * put into the runtime-active metastate during system resume anyway,
1030 * so it is better to ensure that the state saved in the image will be
1031 * always consistent with that.
1033 pm_runtime_resume(dev);
1034 pci_dev->state_saved = false;
1039 error = pm->freeze(dev);
1040 suspend_report_result(dev, pm->freeze, error);
1048 static int pci_pm_freeze_noirq(struct device *dev)
1050 struct pci_dev *pci_dev = to_pci_dev(dev);
1051 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1053 if (pci_has_legacy_pm_support(pci_dev))
1054 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
1056 if (pm && pm->freeze_noirq) {
1059 error = pm->freeze_noirq(dev);
1060 suspend_report_result(dev, pm->freeze_noirq, error);
1065 if (!pci_dev->state_saved)
1066 pci_save_state(pci_dev);
1068 pci_pm_set_unknown_state(pci_dev);
1073 static int pci_pm_thaw_noirq(struct device *dev)
1075 struct pci_dev *pci_dev = to_pci_dev(dev);
1076 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1079 * The pm->thaw_noirq() callback assumes the device has been
1080 * returned to D0 and its config state has been restored.
1082 * In addition, pci_restore_state() restores MSI-X state in MMIO
1083 * space, which requires the device to be in D0, so return it to D0
1084 * in case the driver's "freeze" callbacks put it into a low-power
1087 pci_set_power_state(pci_dev, PCI_D0);
1088 pci_restore_state(pci_dev);
1090 if (pci_has_legacy_pm_support(pci_dev))
1093 if (pm && pm->thaw_noirq)
1094 return pm->thaw_noirq(dev);
1099 static int pci_pm_thaw(struct device *dev)
1101 struct pci_dev *pci_dev = to_pci_dev(dev);
1102 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1105 if (pci_has_legacy_pm_support(pci_dev))
1106 return pci_legacy_resume(dev);
1110 error = pm->thaw(dev);
1112 pci_pm_reenable_device(pci_dev);
1115 pci_dev->state_saved = false;
1120 static int pci_pm_poweroff(struct device *dev)
1122 struct pci_dev *pci_dev = to_pci_dev(dev);
1123 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1125 if (pci_has_legacy_pm_support(pci_dev))
1126 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1129 pci_pm_default_suspend(pci_dev);
1133 /* The reason to do that is the same as in pci_pm_suspend(). */
1134 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1135 pci_dev_need_resume(pci_dev)) {
1136 pm_runtime_resume(dev);
1137 pci_dev->state_saved = false;
1139 pci_dev_adjust_pme(pci_dev);
1145 error = pm->poweroff(dev);
1146 suspend_report_result(dev, pm->poweroff, error);
1154 static int pci_pm_poweroff_late(struct device *dev)
1156 if (dev_pm_skip_suspend(dev))
1159 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
1161 return pm_generic_poweroff_late(dev);
1164 static int pci_pm_poweroff_noirq(struct device *dev)
1166 struct pci_dev *pci_dev = to_pci_dev(dev);
1167 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1169 if (dev_pm_skip_suspend(dev))
1172 if (pci_has_legacy_pm_support(pci_dev))
1173 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1176 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1180 if (pm->poweroff_noirq) {
1183 error = pm->poweroff_noirq(dev);
1184 suspend_report_result(dev, pm->poweroff_noirq, error);
1189 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1190 pci_prepare_to_sleep(pci_dev);
1193 * The reason for doing this here is the same as for the analogous code
1194 * in pci_pm_suspend_noirq().
1196 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1197 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1199 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1204 static int pci_pm_restore_noirq(struct device *dev)
1206 struct pci_dev *pci_dev = to_pci_dev(dev);
1207 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1209 pci_pm_default_resume_early(pci_dev);
1210 pci_fixup_device(pci_fixup_resume_early, pci_dev);
1212 if (pci_has_legacy_pm_support(pci_dev))
1215 if (pm && pm->restore_noirq)
1216 return pm->restore_noirq(dev);
1221 static int pci_pm_restore(struct device *dev)
1223 struct pci_dev *pci_dev = to_pci_dev(dev);
1224 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1227 * This is necessary for the hibernation error path in which restore is
1228 * called without restoring the standard config registers of the device.
1230 if (pci_dev->state_saved)
1231 pci_restore_standard_config(pci_dev);
1233 if (pci_has_legacy_pm_support(pci_dev))
1234 return pci_legacy_resume(dev);
1236 pci_pm_default_resume(pci_dev);
1240 return pm->restore(dev);
1242 pci_pm_reenable_device(pci_dev);
1248 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1250 #define pci_pm_freeze NULL
1251 #define pci_pm_freeze_noirq NULL
1252 #define pci_pm_thaw NULL
1253 #define pci_pm_thaw_noirq NULL
1254 #define pci_pm_poweroff NULL
1255 #define pci_pm_poweroff_late NULL
1256 #define pci_pm_poweroff_noirq NULL
1257 #define pci_pm_restore NULL
1258 #define pci_pm_restore_noirq NULL
1260 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1264 static int pci_pm_runtime_suspend(struct device *dev)
1266 struct pci_dev *pci_dev = to_pci_dev(dev);
1267 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1268 pci_power_t prev = pci_dev->current_state;
1272 * If pci_dev->driver is not set (unbound), we leave the device in D0,
1273 * but it may go to D3cold when the bridge above it runtime suspends.
1274 * Save its config space in case that happens.
1276 if (!pci_dev->driver) {
1277 pci_save_state(pci_dev);
1281 pci_dev->state_saved = false;
1282 if (pm && pm->runtime_suspend) {
1283 error = pm->runtime_suspend(dev);
1285 * -EBUSY and -EAGAIN is used to request the runtime PM core
1286 * to schedule a new suspend, so log the event only with debug
1289 if (error == -EBUSY || error == -EAGAIN) {
1290 pci_dbg(pci_dev, "can't suspend now (%ps returned %d)\n",
1291 pm->runtime_suspend, error);
1294 pci_err(pci_dev, "can't suspend (%ps returned %d)\n",
1295 pm->runtime_suspend, error);
1300 pci_fixup_device(pci_fixup_suspend, pci_dev);
1302 if (pm && pm->runtime_suspend
1303 && !pci_dev->state_saved && pci_dev->current_state != PCI_D0
1304 && pci_dev->current_state != PCI_UNKNOWN) {
1305 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
1306 "PCI PM: State of device not saved by %pS\n",
1307 pm->runtime_suspend);
1311 if (!pci_dev->state_saved) {
1312 pci_save_state(pci_dev);
1313 pci_finish_runtime_suspend(pci_dev);
1319 static int pci_pm_runtime_resume(struct device *dev)
1321 struct pci_dev *pci_dev = to_pci_dev(dev);
1322 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1323 pci_power_t prev_state = pci_dev->current_state;
1327 * Restoring config space is necessary even if the device is not bound
1328 * to a driver because although we left it in D0, it may have gone to
1329 * D3cold when the bridge above it runtime suspended.
1331 pci_pm_default_resume_early(pci_dev);
1333 if (!pci_dev->driver)
1336 pci_fixup_device(pci_fixup_resume_early, pci_dev);
1337 pci_pm_default_resume(pci_dev);
1339 if (prev_state == PCI_D3cold)
1340 pci_pm_bridge_power_up_actions(pci_dev);
1342 if (pm && pm->runtime_resume)
1343 error = pm->runtime_resume(dev);
1345 pci_dev->runtime_d3cold = false;
1350 static int pci_pm_runtime_idle(struct device *dev)
1352 struct pci_dev *pci_dev = to_pci_dev(dev);
1353 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1356 * If pci_dev->driver is not set (unbound), the device should
1357 * always remain in D0 regardless of the runtime PM status
1359 if (!pci_dev->driver)
1365 if (pm->runtime_idle)
1366 return pm->runtime_idle(dev);
1371 static const struct dev_pm_ops pci_dev_pm_ops = {
1372 .prepare = pci_pm_prepare,
1373 .complete = pci_pm_complete,
1374 .suspend = pci_pm_suspend,
1375 .suspend_late = pci_pm_suspend_late,
1376 .resume = pci_pm_resume,
1377 .resume_early = pci_pm_resume_early,
1378 .freeze = pci_pm_freeze,
1379 .thaw = pci_pm_thaw,
1380 .poweroff = pci_pm_poweroff,
1381 .poweroff_late = pci_pm_poweroff_late,
1382 .restore = pci_pm_restore,
1383 .suspend_noirq = pci_pm_suspend_noirq,
1384 .resume_noirq = pci_pm_resume_noirq,
1385 .freeze_noirq = pci_pm_freeze_noirq,
1386 .thaw_noirq = pci_pm_thaw_noirq,
1387 .poweroff_noirq = pci_pm_poweroff_noirq,
1388 .restore_noirq = pci_pm_restore_noirq,
1389 .runtime_suspend = pci_pm_runtime_suspend,
1390 .runtime_resume = pci_pm_runtime_resume,
1391 .runtime_idle = pci_pm_runtime_idle,
1394 #define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
1396 #else /* !CONFIG_PM */
1398 #define pci_pm_runtime_suspend NULL
1399 #define pci_pm_runtime_resume NULL
1400 #define pci_pm_runtime_idle NULL
1402 #define PCI_PM_OPS_PTR NULL
1404 #endif /* !CONFIG_PM */
1407 * __pci_register_driver - register a new pci driver
1408 * @drv: the driver structure to register
1409 * @owner: owner module of drv
1410 * @mod_name: module name string
1412 * Adds the driver structure to the list of registered drivers.
1413 * Returns a negative value on error, otherwise 0.
1414 * If no error occurred, the driver remains registered even if
1415 * no device was claimed during registration.
1417 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1418 const char *mod_name)
1420 /* initialize common driver fields */
1421 drv->driver.name = drv->name;
1422 drv->driver.bus = &pci_bus_type;
1423 drv->driver.owner = owner;
1424 drv->driver.mod_name = mod_name;
1425 drv->driver.groups = drv->groups;
1426 drv->driver.dev_groups = drv->dev_groups;
1428 spin_lock_init(&drv->dynids.lock);
1429 INIT_LIST_HEAD(&drv->dynids.list);
1431 /* register with core */
1432 return driver_register(&drv->driver);
1434 EXPORT_SYMBOL(__pci_register_driver);
1437 * pci_unregister_driver - unregister a pci driver
1438 * @drv: the driver structure to unregister
1440 * Deletes the driver structure from the list of registered PCI drivers,
1441 * gives it a chance to clean up by calling its remove() function for
1442 * each device it was responsible for, and marks those devices as
1446 void pci_unregister_driver(struct pci_driver *drv)
1448 driver_unregister(&drv->driver);
1449 pci_free_dynids(drv);
1451 EXPORT_SYMBOL(pci_unregister_driver);
1453 static struct pci_driver pci_compat_driver = {
1458 * pci_dev_driver - get the pci_driver of a device
1459 * @dev: the device to query
1461 * Returns the appropriate pci_driver structure or %NULL if there is no
1462 * registered driver for the device.
1464 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1470 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1471 if (dev->resource[i].flags & IORESOURCE_BUSY)
1472 return &pci_compat_driver;
1476 EXPORT_SYMBOL(pci_dev_driver);
1479 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1480 * @dev: the PCI device structure to match against
1481 * @drv: the device driver to search for matching PCI device id structures
1483 * Used by a driver to check whether a PCI device present in the
1484 * system is in its list of supported devices. Returns the matching
1485 * pci_device_id structure or %NULL if there is no match.
1487 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1489 struct pci_dev *pci_dev = to_pci_dev(dev);
1490 struct pci_driver *pci_drv;
1491 const struct pci_device_id *found_id;
1493 if (!pci_dev->match_driver)
1496 pci_drv = to_pci_driver(drv);
1497 found_id = pci_match_device(pci_drv, pci_dev);
1505 * pci_dev_get - increments the reference count of the pci device structure
1506 * @dev: the device being referenced
1508 * Each live reference to a device should be refcounted.
1510 * Drivers for PCI devices should normally record such references in
1511 * their probe() methods, when they bind to a device, and release
1512 * them by calling pci_dev_put(), in their disconnect() methods.
1514 * A pointer to the device with the incremented reference counter is returned.
1516 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1519 get_device(&dev->dev);
1522 EXPORT_SYMBOL(pci_dev_get);
1525 * pci_dev_put - release a use of the pci device structure
1526 * @dev: device that's been disconnected
1528 * Must be called when a user of a device is finished with it. When the last
1529 * user of the device calls this function, the memory of the device is freed.
1531 void pci_dev_put(struct pci_dev *dev)
1534 put_device(&dev->dev);
1536 EXPORT_SYMBOL(pci_dev_put);
1538 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1540 struct pci_dev *pdev;
1545 pdev = to_pci_dev(dev);
1547 if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1550 if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1553 if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1554 pdev->subsystem_device))
1557 if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1560 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1561 pdev->vendor, pdev->device,
1562 pdev->subsystem_vendor, pdev->subsystem_device,
1563 (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1570 #if defined(CONFIG_PCIEAER) || defined(CONFIG_EEH)
1572 * pci_uevent_ers - emit a uevent during recovery path of PCI device
1573 * @pdev: PCI device undergoing error recovery
1574 * @err_type: type of error event
1576 void pci_uevent_ers(struct pci_dev *pdev, enum pci_ers_result err_type)
1582 case PCI_ERS_RESULT_NONE:
1583 case PCI_ERS_RESULT_CAN_RECOVER:
1584 envp[idx++] = "ERROR_EVENT=BEGIN_RECOVERY";
1585 envp[idx++] = "DEVICE_ONLINE=0";
1587 case PCI_ERS_RESULT_RECOVERED:
1588 envp[idx++] = "ERROR_EVENT=SUCCESSFUL_RECOVERY";
1589 envp[idx++] = "DEVICE_ONLINE=1";
1591 case PCI_ERS_RESULT_DISCONNECT:
1592 envp[idx++] = "ERROR_EVENT=FAILED_RECOVERY";
1593 envp[idx++] = "DEVICE_ONLINE=0";
1601 kobject_uevent_env(&pdev->dev.kobj, KOBJ_CHANGE, envp);
1606 static int pci_bus_num_vf(struct device *dev)
1608 return pci_num_vf(to_pci_dev(dev));
1612 * pci_dma_configure - Setup DMA configuration
1613 * @dev: ptr to dev structure
1615 * Function to update PCI devices's DMA configuration using the same
1616 * info from the OF node or ACPI node of host bridge's parent (if any).
1618 static int pci_dma_configure(struct device *dev)
1620 struct device *bridge;
1623 bridge = pci_get_host_bridge_device(to_pci_dev(dev));
1625 if (IS_ENABLED(CONFIG_OF) && bridge->parent &&
1626 bridge->parent->of_node) {
1627 ret = of_dma_configure(dev, bridge->parent->of_node, true);
1628 } else if (has_acpi_companion(bridge)) {
1629 struct acpi_device *adev = to_acpi_device_node(bridge->fwnode);
1631 ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev));
1634 pci_put_host_bridge_device(bridge);
1638 struct bus_type pci_bus_type = {
1640 .match = pci_bus_match,
1641 .uevent = pci_uevent,
1642 .probe = pci_device_probe,
1643 .remove = pci_device_remove,
1644 .shutdown = pci_device_shutdown,
1645 .dev_groups = pci_dev_groups,
1646 .bus_groups = pci_bus_groups,
1647 .drv_groups = pci_drv_groups,
1648 .pm = PCI_PM_OPS_PTR,
1649 .num_vf = pci_bus_num_vf,
1650 .dma_configure = pci_dma_configure,
1652 EXPORT_SYMBOL(pci_bus_type);
1654 #ifdef CONFIG_PCIEPORTBUS
1655 static int pcie_port_bus_match(struct device *dev, struct device_driver *drv)
1657 struct pcie_device *pciedev;
1658 struct pcie_port_service_driver *driver;
1660 if (drv->bus != &pcie_port_bus_type || dev->bus != &pcie_port_bus_type)
1663 pciedev = to_pcie_device(dev);
1664 driver = to_service_driver(drv);
1666 if (driver->service != pciedev->service)
1669 if (driver->port_type != PCIE_ANY_PORT &&
1670 driver->port_type != pci_pcie_type(pciedev->port))
1676 struct bus_type pcie_port_bus_type = {
1677 .name = "pci_express",
1678 .match = pcie_port_bus_match,
1680 EXPORT_SYMBOL_GPL(pcie_port_bus_type);
1683 static int __init pci_driver_init(void)
1687 ret = bus_register(&pci_bus_type);
1691 #ifdef CONFIG_PCIEPORTBUS
1692 ret = bus_register(&pcie_port_bus_type);
1696 dma_debug_add_bus(&pci_bus_type);
1699 postcore_initcall(pci_driver_init);