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/cpu.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/suspend.h>
18 #include <linux/kexec.h>
19 #include <linux/of_device.h>
20 #include <linux/acpi.h>
22 #include "pcie/portdrv.h"
25 struct list_head node;
26 struct pci_device_id id;
30 * pci_add_dynid - add a new PCI device ID to this driver and re-probe devices
31 * @drv: target pci driver
32 * @vendor: PCI vendor ID
33 * @device: PCI device ID
34 * @subvendor: PCI subvendor ID
35 * @subdevice: PCI subdevice ID
37 * @class_mask: PCI class mask
38 * @driver_data: private driver data
40 * Adds a new dynamic pci device ID to this driver and causes the
41 * driver to probe for all devices again. @drv must have been
42 * registered prior to calling this function.
45 * Does GFP_KERNEL allocation.
48 * 0 on success, -errno on failure.
50 int pci_add_dynid(struct pci_driver *drv,
51 unsigned int vendor, unsigned int device,
52 unsigned int subvendor, unsigned int subdevice,
53 unsigned int class, unsigned int class_mask,
54 unsigned long driver_data)
56 struct pci_dynid *dynid;
58 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
62 dynid->id.vendor = vendor;
63 dynid->id.device = device;
64 dynid->id.subvendor = subvendor;
65 dynid->id.subdevice = subdevice;
66 dynid->id.class = class;
67 dynid->id.class_mask = class_mask;
68 dynid->id.driver_data = driver_data;
70 spin_lock(&drv->dynids.lock);
71 list_add_tail(&dynid->node, &drv->dynids.list);
72 spin_unlock(&drv->dynids.lock);
74 return driver_attach(&drv->driver);
76 EXPORT_SYMBOL_GPL(pci_add_dynid);
78 static void pci_free_dynids(struct pci_driver *drv)
80 struct pci_dynid *dynid, *n;
82 spin_lock(&drv->dynids.lock);
83 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
84 list_del(&dynid->node);
87 spin_unlock(&drv->dynids.lock);
91 * store_new_id - sysfs frontend to pci_add_dynid()
92 * @driver: target device driver
93 * @buf: buffer for scanning device ID data
96 * Allow PCI IDs to be added to an existing driver via sysfs.
98 static ssize_t new_id_store(struct device_driver *driver, const char *buf,
101 struct pci_driver *pdrv = to_pci_driver(driver);
102 const struct pci_device_id *ids = pdrv->id_table;
103 u32 vendor, device, subvendor = PCI_ANY_ID,
104 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
105 unsigned long driver_data = 0;
109 fields = sscanf(buf, "%x %x %x %x %x %x %lx",
110 &vendor, &device, &subvendor, &subdevice,
111 &class, &class_mask, &driver_data);
116 struct pci_dev *pdev = kzalloc(sizeof(*pdev), GFP_KERNEL);
120 pdev->vendor = vendor;
121 pdev->device = device;
122 pdev->subsystem_vendor = subvendor;
123 pdev->subsystem_device = subdevice;
126 if (pci_match_id(pdrv->id_table, pdev))
135 /* Only accept driver_data values that match an existing id_table
139 while (ids->vendor || ids->subvendor || ids->class_mask) {
140 if (driver_data == ids->driver_data) {
146 if (retval) /* No match */
150 retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
151 class, class_mask, driver_data);
156 static DRIVER_ATTR_WO(new_id);
159 * store_remove_id - remove a PCI device ID from this driver
160 * @driver: target device driver
161 * @buf: buffer for scanning device ID data
164 * Removes a dynamic pci device ID to this driver.
166 static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
169 struct pci_dynid *dynid, *n;
170 struct pci_driver *pdrv = to_pci_driver(driver);
171 u32 vendor, device, subvendor = PCI_ANY_ID,
172 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
174 size_t retval = -ENODEV;
176 fields = sscanf(buf, "%x %x %x %x %x %x",
177 &vendor, &device, &subvendor, &subdevice,
178 &class, &class_mask);
182 spin_lock(&pdrv->dynids.lock);
183 list_for_each_entry_safe(dynid, n, &pdrv->dynids.list, node) {
184 struct pci_device_id *id = &dynid->id;
185 if ((id->vendor == vendor) &&
186 (id->device == device) &&
187 (subvendor == PCI_ANY_ID || id->subvendor == subvendor) &&
188 (subdevice == PCI_ANY_ID || id->subdevice == subdevice) &&
189 !((id->class ^ class) & class_mask)) {
190 list_del(&dynid->node);
196 spin_unlock(&pdrv->dynids.lock);
200 static DRIVER_ATTR_WO(remove_id);
202 static struct attribute *pci_drv_attrs[] = {
203 &driver_attr_new_id.attr,
204 &driver_attr_remove_id.attr,
207 ATTRIBUTE_GROUPS(pci_drv);
210 * pci_match_id - See if a pci device matches a given pci_id table
211 * @ids: array of PCI device id structures to search in
212 * @dev: the PCI device structure to match against.
214 * Used by a driver to check whether a PCI device present in the
215 * system is in its list of supported devices. Returns the matching
216 * pci_device_id structure or %NULL if there is no match.
218 * Deprecated, don't use this as it will not catch any dynamic ids
219 * that a driver might want to check for.
221 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
225 while (ids->vendor || ids->subvendor || ids->class_mask) {
226 if (pci_match_one_device(ids, dev))
233 EXPORT_SYMBOL(pci_match_id);
235 static const struct pci_device_id pci_device_id_any = {
236 .vendor = PCI_ANY_ID,
237 .device = PCI_ANY_ID,
238 .subvendor = PCI_ANY_ID,
239 .subdevice = PCI_ANY_ID,
243 * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
244 * @drv: the PCI driver to match against
245 * @dev: the PCI device structure to match against
247 * Used by a driver to check whether a PCI device present in the
248 * system is in its list of supported devices. Returns the matching
249 * pci_device_id structure or %NULL if there is no match.
251 static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
254 struct pci_dynid *dynid;
255 const struct pci_device_id *found_id = NULL;
257 /* When driver_override is set, only bind to the matching driver */
258 if (dev->driver_override && strcmp(dev->driver_override, drv->name))
261 /* Look at the dynamic ids first, before the static ones */
262 spin_lock(&drv->dynids.lock);
263 list_for_each_entry(dynid, &drv->dynids.list, node) {
264 if (pci_match_one_device(&dynid->id, dev)) {
265 found_id = &dynid->id;
269 spin_unlock(&drv->dynids.lock);
272 found_id = pci_match_id(drv->id_table, dev);
274 /* driver_override will always match, send a dummy id */
275 if (!found_id && dev->driver_override)
276 found_id = &pci_device_id_any;
281 struct drv_dev_and_id {
282 struct pci_driver *drv;
284 const struct pci_device_id *id;
287 static long local_pci_probe(void *_ddi)
289 struct drv_dev_and_id *ddi = _ddi;
290 struct pci_dev *pci_dev = ddi->dev;
291 struct pci_driver *pci_drv = ddi->drv;
292 struct device *dev = &pci_dev->dev;
296 * Unbound PCI devices are always put in D0, regardless of
297 * runtime PM status. During probe, the device is set to
298 * active and the usage count is incremented. If the driver
299 * supports runtime PM, it should call pm_runtime_put_noidle(),
300 * or any other runtime PM helper function decrementing the usage
301 * count, in its probe routine and pm_runtime_get_noresume() in
302 * its remove routine.
304 pm_runtime_get_sync(dev);
305 pci_dev->driver = pci_drv;
306 rc = pci_drv->probe(pci_dev, ddi->id);
310 pci_dev->driver = NULL;
311 pm_runtime_put_sync(dev);
315 * Probe function should return < 0 for failure, 0 for success
316 * Treat values > 0 as success, but warn.
318 dev_warn(dev, "Driver probe function unexpectedly returned %d\n", rc);
322 static bool pci_physfn_is_probed(struct pci_dev *dev)
324 #ifdef CONFIG_PCI_IOV
325 return dev->is_virtfn && dev->physfn->is_probed;
331 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
332 const struct pci_device_id *id)
334 int error, node, cpu;
335 struct drv_dev_and_id ddi = { drv, dev, id };
338 * Execute driver initialization on node where the device is
339 * attached. This way the driver likely allocates its local memory
342 node = dev_to_node(&dev->dev);
345 cpu_hotplug_disable();
348 * Prevent nesting work_on_cpu() for the case where a Virtual Function
349 * device is probed from work_on_cpu() of the Physical device.
351 if (node < 0 || node >= MAX_NUMNODES || !node_online(node) ||
352 pci_physfn_is_probed(dev))
355 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
357 if (cpu < nr_cpu_ids)
358 error = work_on_cpu(cpu, local_pci_probe, &ddi);
360 error = local_pci_probe(&ddi);
363 cpu_hotplug_enable();
368 * __pci_device_probe - check if a driver wants to claim a specific PCI device
369 * @drv: driver to call to check if it wants the PCI device
370 * @pci_dev: PCI device being probed
372 * returns 0 on success, else error.
373 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
375 static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
377 const struct pci_device_id *id;
380 if (!pci_dev->driver && drv->probe) {
383 id = pci_match_device(drv, pci_dev);
385 error = pci_call_probe(drv, pci_dev, id);
390 int __weak pcibios_alloc_irq(struct pci_dev *dev)
395 void __weak pcibios_free_irq(struct pci_dev *dev)
399 #ifdef CONFIG_PCI_IOV
400 static inline bool pci_device_can_probe(struct pci_dev *pdev)
402 return (!pdev->is_virtfn || pdev->physfn->sriov->drivers_autoprobe);
405 static inline bool pci_device_can_probe(struct pci_dev *pdev)
411 static int pci_device_probe(struct device *dev)
414 struct pci_dev *pci_dev = to_pci_dev(dev);
415 struct pci_driver *drv = to_pci_driver(dev->driver);
417 pci_assign_irq(pci_dev);
419 error = pcibios_alloc_irq(pci_dev);
423 pci_dev_get(pci_dev);
424 if (pci_device_can_probe(pci_dev)) {
425 error = __pci_device_probe(drv, pci_dev);
427 pcibios_free_irq(pci_dev);
428 pci_dev_put(pci_dev);
435 static int pci_device_remove(struct device *dev)
437 struct pci_dev *pci_dev = to_pci_dev(dev);
438 struct pci_driver *drv = pci_dev->driver;
442 pm_runtime_get_sync(dev);
443 drv->remove(pci_dev);
444 pm_runtime_put_noidle(dev);
446 pcibios_free_irq(pci_dev);
447 pci_dev->driver = NULL;
448 pci_iov_remove(pci_dev);
451 /* Undo the runtime PM settings in local_pci_probe() */
452 pm_runtime_put_sync(dev);
455 * If the device is still on, set the power state as "unknown",
456 * since it might change by the next time we load the driver.
458 if (pci_dev->current_state == PCI_D0)
459 pci_dev->current_state = PCI_UNKNOWN;
462 * We would love to complain here if pci_dev->is_enabled is set, that
463 * the driver should have called pci_disable_device(), but the
464 * unfortunate fact is there are too many odd BIOS and bridge setups
465 * that don't like drivers doing that all of the time.
466 * Oh well, we can dream of sane hardware when we sleep, no matter how
467 * horrible the crap we have to deal with is when we are awake...
470 pci_dev_put(pci_dev);
474 static void pci_device_shutdown(struct device *dev)
476 struct pci_dev *pci_dev = to_pci_dev(dev);
477 struct pci_driver *drv = pci_dev->driver;
479 pm_runtime_resume(dev);
481 if (drv && drv->shutdown)
482 drv->shutdown(pci_dev);
485 * If this is a kexec reboot, turn off Bus Master bit on the
486 * device to tell it to not continue to do DMA. Don't touch
487 * devices in D3cold or unknown states.
488 * If it is not a kexec reboot, firmware will hit the PCI
489 * devices with big hammer and stop their DMA any way.
491 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
492 pci_clear_master(pci_dev);
497 /* Auxiliary functions used for system resume and run-time resume. */
500 * pci_restore_standard_config - restore standard config registers of PCI device
501 * @pci_dev: PCI device to handle
503 static int pci_restore_standard_config(struct pci_dev *pci_dev)
505 pci_update_current_state(pci_dev, PCI_UNKNOWN);
507 if (pci_dev->current_state != PCI_D0) {
508 int error = pci_set_power_state(pci_dev, PCI_D0);
513 pci_restore_state(pci_dev);
514 pci_pme_restore(pci_dev);
520 #ifdef CONFIG_PM_SLEEP
522 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
524 pci_power_up(pci_dev);
525 pci_restore_state(pci_dev);
526 pci_pme_restore(pci_dev);
530 * Default "suspend" method for devices that have no driver provided suspend,
531 * or not even a driver at all (second part).
533 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
536 * mark its power state as "unknown", since we don't know if
537 * e.g. the BIOS will change its device state when we suspend.
539 if (pci_dev->current_state == PCI_D0)
540 pci_dev->current_state = PCI_UNKNOWN;
544 * Default "resume" method for devices that have no driver provided resume,
545 * or not even a driver at all (second part).
547 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
551 /* if the device was enabled before suspend, reenable */
552 retval = pci_reenable_device(pci_dev);
554 * if the device was busmaster before the suspend, make it busmaster
557 if (pci_dev->is_busmaster)
558 pci_set_master(pci_dev);
563 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
565 struct pci_dev *pci_dev = to_pci_dev(dev);
566 struct pci_driver *drv = pci_dev->driver;
568 if (drv && drv->suspend) {
569 pci_power_t prev = pci_dev->current_state;
572 error = drv->suspend(pci_dev, state);
573 suspend_report_result(drv->suspend, error);
577 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
578 && pci_dev->current_state != PCI_UNKNOWN) {
579 WARN_ONCE(pci_dev->current_state != prev,
580 "PCI PM: Device state not saved by %pS\n",
585 pci_fixup_device(pci_fixup_suspend, pci_dev);
590 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
592 struct pci_dev *pci_dev = to_pci_dev(dev);
593 struct pci_driver *drv = pci_dev->driver;
595 if (drv && drv->suspend_late) {
596 pci_power_t prev = pci_dev->current_state;
599 error = drv->suspend_late(pci_dev, state);
600 suspend_report_result(drv->suspend_late, error);
604 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
605 && pci_dev->current_state != PCI_UNKNOWN) {
606 WARN_ONCE(pci_dev->current_state != prev,
607 "PCI PM: Device state not saved by %pS\n",
613 if (!pci_dev->state_saved)
614 pci_save_state(pci_dev);
616 pci_pm_set_unknown_state(pci_dev);
619 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
624 static int pci_legacy_resume_early(struct device *dev)
626 struct pci_dev *pci_dev = to_pci_dev(dev);
627 struct pci_driver *drv = pci_dev->driver;
629 return drv && drv->resume_early ?
630 drv->resume_early(pci_dev) : 0;
633 static int pci_legacy_resume(struct device *dev)
635 struct pci_dev *pci_dev = to_pci_dev(dev);
636 struct pci_driver *drv = pci_dev->driver;
638 pci_fixup_device(pci_fixup_resume, pci_dev);
640 return drv && drv->resume ?
641 drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
644 /* Auxiliary functions used by the new power management framework */
646 static void pci_pm_default_resume(struct pci_dev *pci_dev)
648 pci_fixup_device(pci_fixup_resume, pci_dev);
649 pci_enable_wake(pci_dev, PCI_D0, false);
652 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
654 /* Disable non-bridge devices without PM support */
655 if (!pci_has_subordinate(pci_dev))
656 pci_disable_enabled_device(pci_dev);
659 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
661 struct pci_driver *drv = pci_dev->driver;
662 bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
663 || drv->resume_early);
666 * Legacy PM support is used by default, so warn if the new framework is
667 * supported as well. Drivers are supposed to support either the
668 * former, or the latter, but not both at the same time.
670 WARN(ret && drv->driver.pm, "driver %s device %04x:%04x\n",
671 drv->name, pci_dev->vendor, pci_dev->device);
676 /* New power management framework */
678 static int pci_pm_prepare(struct device *dev)
680 struct device_driver *drv = dev->driver;
682 if (drv && drv->pm && drv->pm->prepare) {
683 int error = drv->pm->prepare(dev);
687 if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
690 return pci_dev_keep_suspended(to_pci_dev(dev));
693 static void pci_pm_complete(struct device *dev)
695 struct pci_dev *pci_dev = to_pci_dev(dev);
697 pci_dev_complete_resume(pci_dev);
698 pm_generic_complete(dev);
700 /* Resume device if platform firmware has put it in reset-power-on */
701 if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) {
702 pci_power_t pre_sleep_state = pci_dev->current_state;
704 pci_update_current_state(pci_dev, pci_dev->current_state);
705 if (pci_dev->current_state < pre_sleep_state)
706 pm_request_resume(dev);
710 #else /* !CONFIG_PM_SLEEP */
712 #define pci_pm_prepare NULL
713 #define pci_pm_complete NULL
715 #endif /* !CONFIG_PM_SLEEP */
717 #ifdef CONFIG_SUSPEND
718 static void pcie_pme_root_status_cleanup(struct pci_dev *pci_dev)
721 * Some BIOSes forget to clear Root PME Status bits after system
722 * wakeup, which breaks ACPI-based runtime wakeup on PCI Express.
723 * Clear those bits now just in case (shouldn't hurt).
725 if (pci_is_pcie(pci_dev) &&
726 (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT ||
727 pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC))
728 pcie_clear_root_pme_status(pci_dev);
731 static int pci_pm_suspend(struct device *dev)
733 struct pci_dev *pci_dev = to_pci_dev(dev);
734 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
736 pci_dev->skip_bus_pm = false;
738 if (pci_has_legacy_pm_support(pci_dev))
739 return pci_legacy_suspend(dev, PMSG_SUSPEND);
742 pci_pm_default_suspend(pci_dev);
747 * PCI devices suspended at run time may need to be resumed at this
748 * point, because in general it may be necessary to reconfigure them for
749 * system suspend. Namely, if the device is expected to wake up the
750 * system from the sleep state, it may have to be reconfigured for this
751 * purpose, or if the device is not expected to wake up the system from
752 * the sleep state, it should be prevented from signaling wakeup events
755 * Also if the driver of the device does not indicate that its system
756 * suspend callbacks can cope with runtime-suspended devices, it is
757 * better to resume the device from runtime suspend here.
759 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
760 !pci_dev_keep_suspended(pci_dev)) {
761 pm_runtime_resume(dev);
762 pci_dev->state_saved = false;
766 pci_power_t prev = pci_dev->current_state;
769 error = pm->suspend(dev);
770 suspend_report_result(pm->suspend, error);
774 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
775 && pci_dev->current_state != PCI_UNKNOWN) {
776 WARN_ONCE(pci_dev->current_state != prev,
777 "PCI PM: State of device not saved by %pS\n",
785 static int pci_pm_suspend_late(struct device *dev)
787 if (dev_pm_smart_suspend_and_suspended(dev))
790 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
792 return pm_generic_suspend_late(dev);
795 static int pci_pm_suspend_noirq(struct device *dev)
797 struct pci_dev *pci_dev = to_pci_dev(dev);
798 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
800 if (dev_pm_smart_suspend_and_suspended(dev)) {
801 dev->power.may_skip_resume = true;
805 if (pci_has_legacy_pm_support(pci_dev))
806 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
809 pci_save_state(pci_dev);
813 if (pm->suspend_noirq) {
814 pci_power_t prev = pci_dev->current_state;
817 error = pm->suspend_noirq(dev);
818 suspend_report_result(pm->suspend_noirq, error);
822 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
823 && pci_dev->current_state != PCI_UNKNOWN) {
824 WARN_ONCE(pci_dev->current_state != prev,
825 "PCI PM: State of device not saved by %pS\n",
831 if (pci_dev->skip_bus_pm) {
833 * Either the device is a bridge with a child in D0 below it, or
834 * the function is running for the second time in a row without
835 * going through full resume, which is possible only during
836 * suspend-to-idle in a spurious wakeup case. The device should
837 * be in D0 at this point, but if it is a bridge, it may be
838 * necessary to save its state.
840 if (!pci_dev->state_saved)
841 pci_save_state(pci_dev);
842 } else if (!pci_dev->state_saved) {
843 pci_save_state(pci_dev);
844 if (pci_power_manageable(pci_dev))
845 pci_prepare_to_sleep(pci_dev);
848 dev_dbg(dev, "PCI PM: Suspend power state: %s\n",
849 pci_power_name(pci_dev->current_state));
851 if (pci_dev->current_state == PCI_D0) {
852 pci_dev->skip_bus_pm = true;
854 * Per PCI PM r1.2, table 6-1, a bridge must be in D0 if any
855 * downstream device is in D0, so avoid changing the power state
856 * of the parent bridge by setting the skip_bus_pm flag for it.
858 if (pci_dev->bus->self)
859 pci_dev->bus->self->skip_bus_pm = true;
862 if (pci_dev->skip_bus_pm && !pm_suspend_via_firmware()) {
863 dev_dbg(dev, "PCI PM: Skipped\n");
867 pci_pm_set_unknown_state(pci_dev);
870 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
871 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
872 * hasn't been quiesced and tries to turn it off. If the controller
873 * is already in D3, this can hang or cause memory corruption.
875 * Since the value of the COMMAND register doesn't matter once the
876 * device has been suspended, we can safely set it to 0 here.
878 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
879 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
882 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
885 * If the target system sleep state is suspend-to-idle, it is sufficient
886 * to check whether or not the device's wakeup settings are good for
887 * runtime PM. Otherwise, the pm_resume_via_firmware() check will cause
888 * pci_pm_complete() to take care of fixing up the device's state
889 * anyway, if need be.
891 dev->power.may_skip_resume = device_may_wakeup(dev) ||
892 !device_can_wakeup(dev);
897 static int pci_pm_resume_noirq(struct device *dev)
899 struct pci_dev *pci_dev = to_pci_dev(dev);
900 struct device_driver *drv = dev->driver;
903 if (dev_pm_may_skip_resume(dev))
907 * Devices with DPM_FLAG_SMART_SUSPEND may be left in runtime suspend
908 * during system suspend, so update their runtime PM status to "active"
909 * as they are going to be put into D0 shortly.
911 if (dev_pm_smart_suspend_and_suspended(dev))
912 pm_runtime_set_active(dev);
915 * In the suspend-to-idle case, devices left in D0 during suspend will
916 * stay in D0, so it is not necessary to restore or update their
917 * configuration here and attempting to put them into D0 again may
918 * confuse some firmware, so avoid doing that.
920 if (!pci_dev->skip_bus_pm || pm_suspend_via_firmware())
921 pci_pm_default_resume_early(pci_dev);
923 pci_fixup_device(pci_fixup_resume_early, pci_dev);
925 if (pci_has_legacy_pm_support(pci_dev))
926 return pci_legacy_resume_early(dev);
928 pcie_pme_root_status_cleanup(pci_dev);
930 if (drv && drv->pm && drv->pm->resume_noirq)
931 error = drv->pm->resume_noirq(dev);
936 static int pci_pm_resume(struct device *dev)
938 struct pci_dev *pci_dev = to_pci_dev(dev);
939 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
943 * This is necessary for the suspend error path in which resume is
944 * called without restoring the standard config registers of the device.
946 if (pci_dev->state_saved)
947 pci_restore_standard_config(pci_dev);
949 if (pci_has_legacy_pm_support(pci_dev))
950 return pci_legacy_resume(dev);
952 pci_pm_default_resume(pci_dev);
956 error = pm->resume(dev);
958 pci_pm_reenable_device(pci_dev);
964 #else /* !CONFIG_SUSPEND */
966 #define pci_pm_suspend NULL
967 #define pci_pm_suspend_late NULL
968 #define pci_pm_suspend_noirq NULL
969 #define pci_pm_resume NULL
970 #define pci_pm_resume_noirq NULL
972 #endif /* !CONFIG_SUSPEND */
974 #ifdef CONFIG_HIBERNATE_CALLBACKS
978 * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
979 * a hibernate transition
981 struct dev_pm_ops __weak pcibios_pm_ops;
983 static int pci_pm_freeze(struct device *dev)
985 struct pci_dev *pci_dev = to_pci_dev(dev);
986 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
988 if (pci_has_legacy_pm_support(pci_dev))
989 return pci_legacy_suspend(dev, PMSG_FREEZE);
992 pci_pm_default_suspend(pci_dev);
997 * This used to be done in pci_pm_prepare() for all devices and some
998 * drivers may depend on it, so do it here. Ideally, runtime-suspended
999 * devices should not be touched during freeze/thaw transitions,
1002 if (!dev_pm_smart_suspend_and_suspended(dev)) {
1003 pm_runtime_resume(dev);
1004 pci_dev->state_saved = false;
1010 error = pm->freeze(dev);
1011 suspend_report_result(pm->freeze, error);
1019 static int pci_pm_freeze_late(struct device *dev)
1021 if (dev_pm_smart_suspend_and_suspended(dev))
1024 return pm_generic_freeze_late(dev);
1027 static int pci_pm_freeze_noirq(struct device *dev)
1029 struct pci_dev *pci_dev = to_pci_dev(dev);
1030 struct device_driver *drv = dev->driver;
1032 if (dev_pm_smart_suspend_and_suspended(dev))
1035 if (pci_has_legacy_pm_support(pci_dev))
1036 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
1038 if (drv && drv->pm && drv->pm->freeze_noirq) {
1041 error = drv->pm->freeze_noirq(dev);
1042 suspend_report_result(drv->pm->freeze_noirq, error);
1047 if (!pci_dev->state_saved)
1048 pci_save_state(pci_dev);
1050 pci_pm_set_unknown_state(pci_dev);
1052 if (pcibios_pm_ops.freeze_noirq)
1053 return pcibios_pm_ops.freeze_noirq(dev);
1058 static int pci_pm_thaw_noirq(struct device *dev)
1060 struct pci_dev *pci_dev = to_pci_dev(dev);
1061 struct device_driver *drv = dev->driver;
1065 * If the device is in runtime suspend, the code below may not work
1066 * correctly with it, so skip that code and make the PM core skip all of
1067 * the subsequent "thaw" callbacks for the device.
1069 if (dev_pm_smart_suspend_and_suspended(dev)) {
1070 dev_pm_skip_next_resume_phases(dev);
1074 if (pcibios_pm_ops.thaw_noirq) {
1075 error = pcibios_pm_ops.thaw_noirq(dev);
1080 if (pci_has_legacy_pm_support(pci_dev))
1081 return pci_legacy_resume_early(dev);
1084 * pci_restore_state() requires the device to be in D0 (because of MSI
1085 * restoration among other things), so force it into D0 in case the
1086 * driver's "freeze" callbacks put it into a low-power state directly.
1088 pci_set_power_state(pci_dev, PCI_D0);
1089 pci_restore_state(pci_dev);
1091 if (drv && drv->pm && drv->pm->thaw_noirq)
1092 error = drv->pm->thaw_noirq(dev);
1097 static int pci_pm_thaw(struct device *dev)
1099 struct pci_dev *pci_dev = to_pci_dev(dev);
1100 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1103 if (pci_has_legacy_pm_support(pci_dev))
1104 return pci_legacy_resume(dev);
1108 error = pm->thaw(dev);
1110 pci_pm_reenable_device(pci_dev);
1113 pci_dev->state_saved = false;
1118 static int pci_pm_poweroff(struct device *dev)
1120 struct pci_dev *pci_dev = to_pci_dev(dev);
1121 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1123 if (pci_has_legacy_pm_support(pci_dev))
1124 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1127 pci_pm_default_suspend(pci_dev);
1131 /* The reason to do that is the same as in pci_pm_suspend(). */
1132 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1133 !pci_dev_keep_suspended(pci_dev))
1134 pm_runtime_resume(dev);
1136 pci_dev->state_saved = false;
1140 error = pm->poweroff(dev);
1141 suspend_report_result(pm->poweroff, error);
1149 static int pci_pm_poweroff_late(struct device *dev)
1151 if (dev_pm_smart_suspend_and_suspended(dev))
1154 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
1156 return pm_generic_poweroff_late(dev);
1159 static int pci_pm_poweroff_noirq(struct device *dev)
1161 struct pci_dev *pci_dev = to_pci_dev(dev);
1162 struct device_driver *drv = dev->driver;
1164 if (dev_pm_smart_suspend_and_suspended(dev))
1167 if (pci_has_legacy_pm_support(to_pci_dev(dev)))
1168 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1170 if (!drv || !drv->pm) {
1171 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1175 if (drv->pm->poweroff_noirq) {
1178 error = drv->pm->poweroff_noirq(dev);
1179 suspend_report_result(drv->pm->poweroff_noirq, error);
1184 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1185 pci_prepare_to_sleep(pci_dev);
1188 * The reason for doing this here is the same as for the analogous code
1189 * in pci_pm_suspend_noirq().
1191 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1192 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1194 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1196 if (pcibios_pm_ops.poweroff_noirq)
1197 return pcibios_pm_ops.poweroff_noirq(dev);
1202 static int pci_pm_restore_noirq(struct device *dev)
1204 struct pci_dev *pci_dev = to_pci_dev(dev);
1205 struct device_driver *drv = dev->driver;
1208 /* This is analogous to the pci_pm_resume_noirq() case. */
1209 if (dev_pm_smart_suspend_and_suspended(dev))
1210 pm_runtime_set_active(dev);
1212 if (pcibios_pm_ops.restore_noirq) {
1213 error = pcibios_pm_ops.restore_noirq(dev);
1218 pci_pm_default_resume_early(pci_dev);
1219 pci_fixup_device(pci_fixup_resume_early, pci_dev);
1221 if (pci_has_legacy_pm_support(pci_dev))
1222 return pci_legacy_resume_early(dev);
1224 if (drv && drv->pm && drv->pm->restore_noirq)
1225 error = drv->pm->restore_noirq(dev);
1230 static int pci_pm_restore(struct device *dev)
1232 struct pci_dev *pci_dev = to_pci_dev(dev);
1233 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1237 * This is necessary for the hibernation error path in which restore is
1238 * called without restoring the standard config registers of the device.
1240 if (pci_dev->state_saved)
1241 pci_restore_standard_config(pci_dev);
1243 if (pci_has_legacy_pm_support(pci_dev))
1244 return pci_legacy_resume(dev);
1246 pci_pm_default_resume(pci_dev);
1250 error = pm->restore(dev);
1252 pci_pm_reenable_device(pci_dev);
1258 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1260 #define pci_pm_freeze NULL
1261 #define pci_pm_freeze_late NULL
1262 #define pci_pm_freeze_noirq NULL
1263 #define pci_pm_thaw NULL
1264 #define pci_pm_thaw_noirq NULL
1265 #define pci_pm_poweroff NULL
1266 #define pci_pm_poweroff_late NULL
1267 #define pci_pm_poweroff_noirq NULL
1268 #define pci_pm_restore NULL
1269 #define pci_pm_restore_noirq NULL
1271 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1275 static int pci_pm_runtime_suspend(struct device *dev)
1277 struct pci_dev *pci_dev = to_pci_dev(dev);
1278 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1279 pci_power_t prev = pci_dev->current_state;
1283 * If pci_dev->driver is not set (unbound), we leave the device in D0,
1284 * but it may go to D3cold when the bridge above it runtime suspends.
1285 * Save its config space in case that happens.
1287 if (!pci_dev->driver) {
1288 pci_save_state(pci_dev);
1292 pci_dev->state_saved = false;
1293 if (pm && pm->runtime_suspend) {
1294 error = pm->runtime_suspend(dev);
1296 * -EBUSY and -EAGAIN is used to request the runtime PM core
1297 * to schedule a new suspend, so log the event only with debug
1300 if (error == -EBUSY || error == -EAGAIN) {
1301 dev_dbg(dev, "can't suspend now (%ps returned %d)\n",
1302 pm->runtime_suspend, error);
1305 dev_err(dev, "can't suspend (%ps returned %d)\n",
1306 pm->runtime_suspend, error);
1311 pci_fixup_device(pci_fixup_suspend, pci_dev);
1313 if (pm && pm->runtime_suspend
1314 && !pci_dev->state_saved && pci_dev->current_state != PCI_D0
1315 && pci_dev->current_state != PCI_UNKNOWN) {
1316 WARN_ONCE(pci_dev->current_state != prev,
1317 "PCI PM: State of device not saved by %pS\n",
1318 pm->runtime_suspend);
1322 if (!pci_dev->state_saved) {
1323 pci_save_state(pci_dev);
1324 pci_finish_runtime_suspend(pci_dev);
1330 static int pci_pm_runtime_resume(struct device *dev)
1333 struct pci_dev *pci_dev = to_pci_dev(dev);
1334 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1337 * Restoring config space is necessary even if the device is not bound
1338 * to a driver because although we left it in D0, it may have gone to
1339 * D3cold when the bridge above it runtime suspended.
1341 pci_restore_standard_config(pci_dev);
1343 if (!pci_dev->driver)
1346 pci_fixup_device(pci_fixup_resume_early, pci_dev);
1347 pci_enable_wake(pci_dev, PCI_D0, false);
1348 pci_fixup_device(pci_fixup_resume, pci_dev);
1350 if (pm && pm->runtime_resume)
1351 rc = pm->runtime_resume(dev);
1353 pci_dev->runtime_d3cold = false;
1358 static int pci_pm_runtime_idle(struct device *dev)
1360 struct pci_dev *pci_dev = to_pci_dev(dev);
1361 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1365 * If pci_dev->driver is not set (unbound), the device should
1366 * always remain in D0 regardless of the runtime PM status
1368 if (!pci_dev->driver)
1374 if (pm->runtime_idle)
1375 ret = pm->runtime_idle(dev);
1380 static const struct dev_pm_ops pci_dev_pm_ops = {
1381 .prepare = pci_pm_prepare,
1382 .complete = pci_pm_complete,
1383 .suspend = pci_pm_suspend,
1384 .suspend_late = pci_pm_suspend_late,
1385 .resume = pci_pm_resume,
1386 .freeze = pci_pm_freeze,
1387 .freeze_late = pci_pm_freeze_late,
1388 .thaw = pci_pm_thaw,
1389 .poweroff = pci_pm_poweroff,
1390 .poweroff_late = pci_pm_poweroff_late,
1391 .restore = pci_pm_restore,
1392 .suspend_noirq = pci_pm_suspend_noirq,
1393 .resume_noirq = pci_pm_resume_noirq,
1394 .freeze_noirq = pci_pm_freeze_noirq,
1395 .thaw_noirq = pci_pm_thaw_noirq,
1396 .poweroff_noirq = pci_pm_poweroff_noirq,
1397 .restore_noirq = pci_pm_restore_noirq,
1398 .runtime_suspend = pci_pm_runtime_suspend,
1399 .runtime_resume = pci_pm_runtime_resume,
1400 .runtime_idle = pci_pm_runtime_idle,
1403 #define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
1405 #else /* !CONFIG_PM */
1407 #define pci_pm_runtime_suspend NULL
1408 #define pci_pm_runtime_resume NULL
1409 #define pci_pm_runtime_idle NULL
1411 #define PCI_PM_OPS_PTR NULL
1413 #endif /* !CONFIG_PM */
1416 * __pci_register_driver - register a new pci driver
1417 * @drv: the driver structure to register
1418 * @owner: owner module of drv
1419 * @mod_name: module name string
1421 * Adds the driver structure to the list of registered drivers.
1422 * Returns a negative value on error, otherwise 0.
1423 * If no error occurred, the driver remains registered even if
1424 * no device was claimed during registration.
1426 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1427 const char *mod_name)
1429 /* initialize common driver fields */
1430 drv->driver.name = drv->name;
1431 drv->driver.bus = &pci_bus_type;
1432 drv->driver.owner = owner;
1433 drv->driver.mod_name = mod_name;
1434 drv->driver.groups = drv->groups;
1436 spin_lock_init(&drv->dynids.lock);
1437 INIT_LIST_HEAD(&drv->dynids.list);
1439 /* register with core */
1440 return driver_register(&drv->driver);
1442 EXPORT_SYMBOL(__pci_register_driver);
1445 * pci_unregister_driver - unregister a pci driver
1446 * @drv: the driver structure to unregister
1448 * Deletes the driver structure from the list of registered PCI drivers,
1449 * gives it a chance to clean up by calling its remove() function for
1450 * each device it was responsible for, and marks those devices as
1454 void pci_unregister_driver(struct pci_driver *drv)
1456 driver_unregister(&drv->driver);
1457 pci_free_dynids(drv);
1459 EXPORT_SYMBOL(pci_unregister_driver);
1461 static struct pci_driver pci_compat_driver = {
1466 * pci_dev_driver - get the pci_driver of a device
1467 * @dev: the device to query
1469 * Returns the appropriate pci_driver structure or %NULL if there is no
1470 * registered driver for the device.
1472 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1478 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1479 if (dev->resource[i].flags & IORESOURCE_BUSY)
1480 return &pci_compat_driver;
1484 EXPORT_SYMBOL(pci_dev_driver);
1487 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1488 * @dev: the PCI device structure to match against
1489 * @drv: the device driver to search for matching PCI device id structures
1491 * Used by a driver to check whether a PCI device present in the
1492 * system is in its list of supported devices. Returns the matching
1493 * pci_device_id structure or %NULL if there is no match.
1495 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1497 struct pci_dev *pci_dev = to_pci_dev(dev);
1498 struct pci_driver *pci_drv;
1499 const struct pci_device_id *found_id;
1501 if (!pci_dev->match_driver)
1504 pci_drv = to_pci_driver(drv);
1505 found_id = pci_match_device(pci_drv, pci_dev);
1513 * pci_dev_get - increments the reference count of the pci device structure
1514 * @dev: the device being referenced
1516 * Each live reference to a device should be refcounted.
1518 * Drivers for PCI devices should normally record such references in
1519 * their probe() methods, when they bind to a device, and release
1520 * them by calling pci_dev_put(), in their disconnect() methods.
1522 * A pointer to the device with the incremented reference counter is returned.
1524 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1527 get_device(&dev->dev);
1530 EXPORT_SYMBOL(pci_dev_get);
1533 * pci_dev_put - release a use of the pci device structure
1534 * @dev: device that's been disconnected
1536 * Must be called when a user of a device is finished with it. When the last
1537 * user of the device calls this function, the memory of the device is freed.
1539 void pci_dev_put(struct pci_dev *dev)
1542 put_device(&dev->dev);
1544 EXPORT_SYMBOL(pci_dev_put);
1546 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1548 struct pci_dev *pdev;
1553 pdev = to_pci_dev(dev);
1555 if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1558 if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1561 if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1562 pdev->subsystem_device))
1565 if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1568 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1569 pdev->vendor, pdev->device,
1570 pdev->subsystem_vendor, pdev->subsystem_device,
1571 (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1578 #if defined(CONFIG_PCIEPORTBUS) || defined(CONFIG_EEH)
1580 * pci_uevent_ers - emit a uevent during recovery path of PCI device
1581 * @pdev: PCI device undergoing error recovery
1582 * @err_type: type of error event
1584 void pci_uevent_ers(struct pci_dev *pdev, enum pci_ers_result err_type)
1590 case PCI_ERS_RESULT_NONE:
1591 case PCI_ERS_RESULT_CAN_RECOVER:
1592 envp[idx++] = "ERROR_EVENT=BEGIN_RECOVERY";
1593 envp[idx++] = "DEVICE_ONLINE=0";
1595 case PCI_ERS_RESULT_RECOVERED:
1596 envp[idx++] = "ERROR_EVENT=SUCCESSFUL_RECOVERY";
1597 envp[idx++] = "DEVICE_ONLINE=1";
1599 case PCI_ERS_RESULT_DISCONNECT:
1600 envp[idx++] = "ERROR_EVENT=FAILED_RECOVERY";
1601 envp[idx++] = "DEVICE_ONLINE=0";
1609 kobject_uevent_env(&pdev->dev.kobj, KOBJ_CHANGE, envp);
1614 static int pci_bus_num_vf(struct device *dev)
1616 return pci_num_vf(to_pci_dev(dev));
1620 * pci_dma_configure - Setup DMA configuration
1621 * @dev: ptr to dev structure
1623 * Function to update PCI devices's DMA configuration using the same
1624 * info from the OF node or ACPI node of host bridge's parent (if any).
1626 static int pci_dma_configure(struct device *dev)
1628 struct device *bridge;
1631 bridge = pci_get_host_bridge_device(to_pci_dev(dev));
1633 if (IS_ENABLED(CONFIG_OF) && bridge->parent &&
1634 bridge->parent->of_node) {
1635 ret = of_dma_configure(dev, bridge->parent->of_node, true);
1636 } else if (has_acpi_companion(bridge)) {
1637 struct acpi_device *adev = to_acpi_device_node(bridge->fwnode);
1639 ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev));
1642 pci_put_host_bridge_device(bridge);
1646 struct bus_type pci_bus_type = {
1648 .match = pci_bus_match,
1649 .uevent = pci_uevent,
1650 .probe = pci_device_probe,
1651 .remove = pci_device_remove,
1652 .shutdown = pci_device_shutdown,
1653 .dev_groups = pci_dev_groups,
1654 .bus_groups = pci_bus_groups,
1655 .drv_groups = pci_drv_groups,
1656 .pm = PCI_PM_OPS_PTR,
1657 .num_vf = pci_bus_num_vf,
1658 .dma_configure = pci_dma_configure,
1660 EXPORT_SYMBOL(pci_bus_type);
1662 #ifdef CONFIG_PCIEPORTBUS
1663 static int pcie_port_bus_match(struct device *dev, struct device_driver *drv)
1665 struct pcie_device *pciedev;
1666 struct pcie_port_service_driver *driver;
1668 if (drv->bus != &pcie_port_bus_type || dev->bus != &pcie_port_bus_type)
1671 pciedev = to_pcie_device(dev);
1672 driver = to_service_driver(drv);
1674 if (driver->service != pciedev->service)
1677 if (driver->port_type != PCIE_ANY_PORT &&
1678 driver->port_type != pci_pcie_type(pciedev->port))
1684 struct bus_type pcie_port_bus_type = {
1685 .name = "pci_express",
1686 .match = pcie_port_bus_match,
1688 EXPORT_SYMBOL_GPL(pcie_port_bus_type);
1691 static int __init pci_driver_init(void)
1695 ret = bus_register(&pci_bus_type);
1699 #ifdef CONFIG_PCIEPORTBUS
1700 ret = bus_register(&pcie_port_bus_type);
1704 dma_debug_add_bus(&pci_bus_type);
1707 postcore_initcall(pci_driver_init);