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 * store_new_id - sysfs frontend to pci_add_dynid()
94 * @driver: target device driver
95 * @buf: buffer for scanning device ID data
98 * Allow PCI IDs to be added to an existing driver via sysfs.
100 static ssize_t new_id_store(struct device_driver *driver, const char *buf,
103 struct pci_driver *pdrv = to_pci_driver(driver);
104 const struct pci_device_id *ids = pdrv->id_table;
105 u32 vendor, device, subvendor = PCI_ANY_ID,
106 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
107 unsigned long driver_data = 0;
111 fields = sscanf(buf, "%x %x %x %x %x %x %lx",
112 &vendor, &device, &subvendor, &subdevice,
113 &class, &class_mask, &driver_data);
118 struct pci_dev *pdev = kzalloc(sizeof(*pdev), GFP_KERNEL);
122 pdev->vendor = vendor;
123 pdev->device = device;
124 pdev->subsystem_vendor = subvendor;
125 pdev->subsystem_device = subdevice;
128 if (pci_match_id(pdrv->id_table, pdev))
137 /* Only accept driver_data values that match an existing id_table
141 while (ids->vendor || ids->subvendor || ids->class_mask) {
142 if (driver_data == ids->driver_data) {
148 if (retval) /* No match */
152 retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
153 class, class_mask, driver_data);
158 static DRIVER_ATTR_WO(new_id);
161 * store_remove_id - remove a PCI device ID from this driver
162 * @driver: target device driver
163 * @buf: buffer for scanning device ID data
166 * Removes a dynamic pci device ID to this driver.
168 static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
171 struct pci_dynid *dynid, *n;
172 struct pci_driver *pdrv = to_pci_driver(driver);
173 u32 vendor, device, subvendor = PCI_ANY_ID,
174 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
176 size_t retval = -ENODEV;
178 fields = sscanf(buf, "%x %x %x %x %x %x",
179 &vendor, &device, &subvendor, &subdevice,
180 &class, &class_mask);
184 spin_lock(&pdrv->dynids.lock);
185 list_for_each_entry_safe(dynid, n, &pdrv->dynids.list, node) {
186 struct pci_device_id *id = &dynid->id;
187 if ((id->vendor == vendor) &&
188 (id->device == device) &&
189 (subvendor == PCI_ANY_ID || id->subvendor == subvendor) &&
190 (subdevice == PCI_ANY_ID || id->subdevice == subdevice) &&
191 !((id->class ^ class) & class_mask)) {
192 list_del(&dynid->node);
198 spin_unlock(&pdrv->dynids.lock);
202 static DRIVER_ATTR_WO(remove_id);
204 static struct attribute *pci_drv_attrs[] = {
205 &driver_attr_new_id.attr,
206 &driver_attr_remove_id.attr,
209 ATTRIBUTE_GROUPS(pci_drv);
212 * pci_match_id - See if a pci device matches a given pci_id table
213 * @ids: array of PCI device id structures to search in
214 * @dev: the PCI device structure to match against.
216 * Used by a driver to check whether a PCI device present in the
217 * system is in its list of supported devices. Returns the matching
218 * pci_device_id structure or %NULL if there is no match.
220 * Deprecated, don't use this as it will not catch any dynamic ids
221 * that a driver might want to check for.
223 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
227 while (ids->vendor || ids->subvendor || ids->class_mask) {
228 if (pci_match_one_device(ids, dev))
235 EXPORT_SYMBOL(pci_match_id);
237 static const struct pci_device_id pci_device_id_any = {
238 .vendor = PCI_ANY_ID,
239 .device = PCI_ANY_ID,
240 .subvendor = PCI_ANY_ID,
241 .subdevice = PCI_ANY_ID,
245 * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
246 * @drv: the PCI driver to match against
247 * @dev: the PCI device structure to match against
249 * Used by a driver to check whether a PCI device present in the
250 * system is in its list of supported devices. Returns the matching
251 * pci_device_id structure or %NULL if there is no match.
253 static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
256 struct pci_dynid *dynid;
257 const struct pci_device_id *found_id = NULL;
259 /* When driver_override is set, only bind to the matching driver */
260 if (dev->driver_override && strcmp(dev->driver_override, drv->name))
263 /* Look at the dynamic ids first, before the static ones */
264 spin_lock(&drv->dynids.lock);
265 list_for_each_entry(dynid, &drv->dynids.list, node) {
266 if (pci_match_one_device(&dynid->id, dev)) {
267 found_id = &dynid->id;
271 spin_unlock(&drv->dynids.lock);
274 found_id = pci_match_id(drv->id_table, dev);
276 /* driver_override will always match, send a dummy id */
277 if (!found_id && dev->driver_override)
278 found_id = &pci_device_id_any;
283 struct drv_dev_and_id {
284 struct pci_driver *drv;
286 const struct pci_device_id *id;
289 static long local_pci_probe(void *_ddi)
291 struct drv_dev_and_id *ddi = _ddi;
292 struct pci_dev *pci_dev = ddi->dev;
293 struct pci_driver *pci_drv = ddi->drv;
294 struct device *dev = &pci_dev->dev;
298 * Unbound PCI devices are always put in D0, regardless of
299 * runtime PM status. During probe, the device is set to
300 * active and the usage count is incremented. If the driver
301 * supports runtime PM, it should call pm_runtime_put_noidle(),
302 * or any other runtime PM helper function decrementing the usage
303 * count, in its probe routine and pm_runtime_get_noresume() in
304 * its remove routine.
306 pm_runtime_get_sync(dev);
307 pci_dev->driver = pci_drv;
308 rc = pci_drv->probe(pci_dev, ddi->id);
312 pci_dev->driver = NULL;
313 pm_runtime_put_sync(dev);
317 * Probe function should return < 0 for failure, 0 for success
318 * Treat values > 0 as success, but warn.
320 pci_warn(pci_dev, "Driver probe function unexpectedly returned %d\n",
325 static bool pci_physfn_is_probed(struct pci_dev *dev)
327 #ifdef CONFIG_PCI_IOV
328 return dev->is_virtfn && dev->physfn->is_probed;
334 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
335 const struct pci_device_id *id)
337 int error, node, cpu;
338 int hk_flags = HK_FLAG_DOMAIN | HK_FLAG_WQ;
339 struct drv_dev_and_id ddi = { drv, dev, id };
342 * Execute driver initialization on node where the device is
343 * attached. This way the driver likely allocates its local memory
346 node = dev_to_node(&dev->dev);
349 cpu_hotplug_disable();
352 * Prevent nesting work_on_cpu() for the case where a Virtual Function
353 * device is probed from work_on_cpu() of the Physical device.
355 if (node < 0 || node >= MAX_NUMNODES || !node_online(node) ||
356 pci_physfn_is_probed(dev))
359 cpu = cpumask_any_and(cpumask_of_node(node),
360 housekeeping_cpumask(hk_flags));
362 if (cpu < nr_cpu_ids)
363 error = work_on_cpu(cpu, local_pci_probe, &ddi);
365 error = local_pci_probe(&ddi);
368 cpu_hotplug_enable();
373 * __pci_device_probe - check if a driver wants to claim a specific PCI device
374 * @drv: driver to call to check if it wants the PCI device
375 * @pci_dev: PCI device being probed
377 * returns 0 on success, else error.
378 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
380 static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
382 const struct pci_device_id *id;
385 if (!pci_dev->driver && drv->probe) {
388 id = pci_match_device(drv, pci_dev);
390 error = pci_call_probe(drv, pci_dev, id);
395 int __weak pcibios_alloc_irq(struct pci_dev *dev)
400 void __weak pcibios_free_irq(struct pci_dev *dev)
404 #ifdef CONFIG_PCI_IOV
405 static inline bool pci_device_can_probe(struct pci_dev *pdev)
407 return (!pdev->is_virtfn || pdev->physfn->sriov->drivers_autoprobe ||
408 pdev->driver_override);
411 static inline bool pci_device_can_probe(struct pci_dev *pdev)
417 static int pci_device_probe(struct device *dev)
420 struct pci_dev *pci_dev = to_pci_dev(dev);
421 struct pci_driver *drv = to_pci_driver(dev->driver);
423 if (!pci_device_can_probe(pci_dev))
426 pci_assign_irq(pci_dev);
428 error = pcibios_alloc_irq(pci_dev);
432 pci_dev_get(pci_dev);
433 error = __pci_device_probe(drv, pci_dev);
435 pcibios_free_irq(pci_dev);
436 pci_dev_put(pci_dev);
442 static int pci_device_remove(struct device *dev)
444 struct pci_dev *pci_dev = to_pci_dev(dev);
445 struct pci_driver *drv = pci_dev->driver;
448 pm_runtime_get_sync(dev);
450 * If the driver provides a .runtime_idle() callback and it has
451 * started to run already, it may continue to run in parallel
452 * with the code below, so wait until all of the runtime PM
453 * activity has completed.
455 pm_runtime_barrier(dev);
456 drv->remove(pci_dev);
457 pm_runtime_put_noidle(dev);
459 pcibios_free_irq(pci_dev);
460 pci_dev->driver = NULL;
461 pci_iov_remove(pci_dev);
463 /* Undo the runtime PM settings in local_pci_probe() */
464 pm_runtime_put_sync(dev);
467 * If the device is still on, set the power state as "unknown",
468 * since it might change by the next time we load the driver.
470 if (pci_dev->current_state == PCI_D0)
471 pci_dev->current_state = PCI_UNKNOWN;
474 * We would love to complain here if pci_dev->is_enabled is set, that
475 * the driver should have called pci_disable_device(), but the
476 * unfortunate fact is there are too many odd BIOS and bridge setups
477 * that don't like drivers doing that all of the time.
478 * Oh well, we can dream of sane hardware when we sleep, no matter how
479 * horrible the crap we have to deal with is when we are awake...
482 pci_dev_put(pci_dev);
486 static void pci_device_shutdown(struct device *dev)
488 struct pci_dev *pci_dev = to_pci_dev(dev);
489 struct pci_driver *drv = pci_dev->driver;
491 pm_runtime_resume(dev);
493 if (drv && drv->shutdown)
494 drv->shutdown(pci_dev);
497 * If this is a kexec reboot, turn off Bus Master bit on the
498 * device to tell it to not continue to do DMA. Don't touch
499 * devices in D3cold or unknown states.
500 * If it is not a kexec reboot, firmware will hit the PCI
501 * devices with big hammer and stop their DMA any way.
503 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
504 pci_clear_master(pci_dev);
509 /* Auxiliary functions used for system resume and run-time resume. */
512 * pci_restore_standard_config - restore standard config registers of PCI device
513 * @pci_dev: PCI device to handle
515 static int pci_restore_standard_config(struct pci_dev *pci_dev)
517 pci_update_current_state(pci_dev, PCI_UNKNOWN);
519 if (pci_dev->current_state != PCI_D0) {
520 int error = pci_set_power_state(pci_dev, PCI_D0);
525 pci_restore_state(pci_dev);
526 pci_pme_restore(pci_dev);
530 static void pci_pm_default_resume(struct pci_dev *pci_dev)
532 pci_fixup_device(pci_fixup_resume, pci_dev);
533 pci_enable_wake(pci_dev, PCI_D0, false);
538 #ifdef CONFIG_PM_SLEEP
540 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
542 pci_power_up(pci_dev);
543 pci_update_current_state(pci_dev, PCI_D0);
544 pci_restore_state(pci_dev);
545 pci_pme_restore(pci_dev);
549 * Default "suspend" method for devices that have no driver provided suspend,
550 * or not even a driver at all (second part).
552 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
555 * mark its power state as "unknown", since we don't know if
556 * e.g. the BIOS will change its device state when we suspend.
558 if (pci_dev->current_state == PCI_D0)
559 pci_dev->current_state = PCI_UNKNOWN;
563 * Default "resume" method for devices that have no driver provided resume,
564 * or not even a driver at all (second part).
566 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
570 /* if the device was enabled before suspend, reenable */
571 retval = pci_reenable_device(pci_dev);
573 * if the device was busmaster before the suspend, make it busmaster
576 if (pci_dev->is_busmaster)
577 pci_set_master(pci_dev);
582 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
584 struct pci_dev *pci_dev = to_pci_dev(dev);
585 struct pci_driver *drv = pci_dev->driver;
587 if (drv && drv->suspend) {
588 pci_power_t prev = pci_dev->current_state;
591 error = drv->suspend(pci_dev, state);
592 suspend_report_result(drv->suspend, error);
596 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
597 && pci_dev->current_state != PCI_UNKNOWN) {
598 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
599 "PCI PM: Device state not saved by %pS\n",
604 pci_fixup_device(pci_fixup_suspend, pci_dev);
609 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
611 struct pci_dev *pci_dev = to_pci_dev(dev);
613 if (!pci_dev->state_saved)
614 pci_save_state(pci_dev);
616 pci_pm_set_unknown_state(pci_dev);
618 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
623 static int pci_legacy_resume(struct device *dev)
625 struct pci_dev *pci_dev = to_pci_dev(dev);
626 struct pci_driver *drv = pci_dev->driver;
628 pci_fixup_device(pci_fixup_resume, pci_dev);
630 return drv && drv->resume ?
631 drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
634 /* Auxiliary functions used by the new power management framework */
636 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
638 /* Disable non-bridge devices without PM support */
639 if (!pci_has_subordinate(pci_dev))
640 pci_disable_enabled_device(pci_dev);
643 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
645 struct pci_driver *drv = pci_dev->driver;
646 bool ret = drv && (drv->suspend || drv->resume);
649 * Legacy PM support is used by default, so warn if the new framework is
650 * supported as well. Drivers are supposed to support either the
651 * former, or the latter, but not both at the same time.
653 pci_WARN(pci_dev, ret && drv->driver.pm, "device %04x:%04x\n",
654 pci_dev->vendor, pci_dev->device);
659 /* New power management framework */
661 static int pci_pm_prepare(struct device *dev)
663 struct pci_dev *pci_dev = to_pci_dev(dev);
664 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
666 if (pm && pm->prepare) {
667 int error = pm->prepare(dev);
671 if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
674 if (pci_dev_need_resume(pci_dev))
678 * The PME setting needs to be adjusted here in case the direct-complete
679 * optimization is used with respect to this device.
681 pci_dev_adjust_pme(pci_dev);
685 static void pci_pm_complete(struct device *dev)
687 struct pci_dev *pci_dev = to_pci_dev(dev);
689 pci_dev_complete_resume(pci_dev);
690 pm_generic_complete(dev);
692 /* Resume device if platform firmware has put it in reset-power-on */
693 if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) {
694 pci_power_t pre_sleep_state = pci_dev->current_state;
696 pci_refresh_power_state(pci_dev);
698 * On platforms with ACPI this check may also trigger for
699 * devices sharing power resources if one of those power
700 * resources has been activated as a result of a change of the
701 * power state of another device sharing it. However, in that
702 * case it is also better to resume the device, in general.
704 if (pci_dev->current_state < pre_sleep_state)
705 pm_request_resume(dev);
709 #else /* !CONFIG_PM_SLEEP */
711 #define pci_pm_prepare NULL
712 #define pci_pm_complete NULL
714 #endif /* !CONFIG_PM_SLEEP */
716 #ifdef CONFIG_SUSPEND
717 static void pcie_pme_root_status_cleanup(struct pci_dev *pci_dev)
720 * Some BIOSes forget to clear Root PME Status bits after system
721 * wakeup, which breaks ACPI-based runtime wakeup on PCI Express.
722 * Clear those bits now just in case (shouldn't hurt).
724 if (pci_is_pcie(pci_dev) &&
725 (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT ||
726 pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC))
727 pcie_clear_root_pme_status(pci_dev);
730 static int pci_pm_suspend(struct device *dev)
732 struct pci_dev *pci_dev = to_pci_dev(dev);
733 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
735 pci_dev->skip_bus_pm = false;
737 if (pci_has_legacy_pm_support(pci_dev))
738 return pci_legacy_suspend(dev, PMSG_SUSPEND);
741 pci_pm_default_suspend(pci_dev);
746 * PCI devices suspended at run time may need to be resumed at this
747 * point, because in general it may be necessary to reconfigure them for
748 * system suspend. Namely, if the device is expected to wake up the
749 * system from the sleep state, it may have to be reconfigured for this
750 * purpose, or if the device is not expected to wake up the system from
751 * the sleep state, it should be prevented from signaling wakeup events
754 * Also if the driver of the device does not indicate that its system
755 * suspend callbacks can cope with runtime-suspended devices, it is
756 * better to resume the device from runtime suspend here.
758 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
759 pci_dev_need_resume(pci_dev)) {
760 pm_runtime_resume(dev);
761 pci_dev->state_saved = false;
763 pci_dev_adjust_pme(pci_dev);
767 pci_power_t prev = pci_dev->current_state;
770 error = pm->suspend(dev);
771 suspend_report_result(pm->suspend, error);
775 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
776 && pci_dev->current_state != PCI_UNKNOWN) {
777 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
778 "PCI PM: State of device not saved by %pS\n",
786 static int pci_pm_suspend_late(struct device *dev)
788 if (dev_pm_skip_suspend(dev))
791 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
793 return pm_generic_suspend_late(dev);
796 static int pci_pm_suspend_noirq(struct device *dev)
798 struct pci_dev *pci_dev = to_pci_dev(dev);
799 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
801 if (dev_pm_skip_suspend(dev))
804 if (pci_has_legacy_pm_support(pci_dev))
805 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
808 pci_save_state(pci_dev);
812 if (pm->suspend_noirq) {
813 pci_power_t prev = pci_dev->current_state;
816 error = pm->suspend_noirq(dev);
817 suspend_report_result(pm->suspend_noirq, error);
821 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
822 && pci_dev->current_state != PCI_UNKNOWN) {
823 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
824 "PCI PM: State of device not saved by %pS\n",
830 if (pci_dev->skip_bus_pm) {
832 * Either the device is a bridge with a child in D0 below it, or
833 * the function is running for the second time in a row without
834 * going through full resume, which is possible only during
835 * suspend-to-idle in a spurious wakeup case. The device should
836 * be in D0 at this point, but if it is a bridge, it may be
837 * necessary to save its state.
839 if (!pci_dev->state_saved)
840 pci_save_state(pci_dev);
841 } else if (!pci_dev->state_saved) {
842 pci_save_state(pci_dev);
843 if (pci_power_manageable(pci_dev))
844 pci_prepare_to_sleep(pci_dev);
847 pci_dbg(pci_dev, "PCI PM: Suspend power state: %s\n",
848 pci_power_name(pci_dev->current_state));
850 if (pci_dev->current_state == PCI_D0) {
851 pci_dev->skip_bus_pm = true;
853 * Per PCI PM r1.2, table 6-1, a bridge must be in D0 if any
854 * downstream device is in D0, so avoid changing the power state
855 * of the parent bridge by setting the skip_bus_pm flag for it.
857 if (pci_dev->bus->self)
858 pci_dev->bus->self->skip_bus_pm = true;
861 if (pci_dev->skip_bus_pm && pm_suspend_no_platform()) {
862 pci_dbg(pci_dev, "PCI PM: Skipped\n");
866 pci_pm_set_unknown_state(pci_dev);
869 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
870 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
871 * hasn't been quiesced and tries to turn it off. If the controller
872 * is already in D3, this can hang or cause memory corruption.
874 * Since the value of the COMMAND register doesn't matter once the
875 * device has been suspended, we can safely set it to 0 here.
877 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
878 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
881 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
884 * If the target system sleep state is suspend-to-idle, it is sufficient
885 * to check whether or not the device's wakeup settings are good for
886 * runtime PM. Otherwise, the pm_resume_via_firmware() check will cause
887 * pci_pm_complete() to take care of fixing up the device's state
888 * anyway, if need be.
890 if (device_can_wakeup(dev) && !device_may_wakeup(dev))
891 dev->power.may_skip_resume = false;
896 static int pci_pm_resume_noirq(struct device *dev)
898 struct pci_dev *pci_dev = to_pci_dev(dev);
899 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
900 pci_power_t prev_state = pci_dev->current_state;
901 bool skip_bus_pm = pci_dev->skip_bus_pm;
903 if (dev_pm_skip_resume(dev))
907 * In the suspend-to-idle case, devices left in D0 during suspend will
908 * stay in D0, so it is not necessary to restore or update their
909 * configuration here and attempting to put them into D0 again is
910 * pointless, so avoid doing that.
912 if (!(skip_bus_pm && pm_suspend_no_platform()))
913 pci_pm_default_resume_early(pci_dev);
915 pci_fixup_device(pci_fixup_resume_early, pci_dev);
916 pcie_pme_root_status_cleanup(pci_dev);
918 if (!skip_bus_pm && prev_state == PCI_D3cold)
919 pci_bridge_wait_for_secondary_bus(pci_dev, "resume", PCI_RESET_WAIT);
921 if (pci_has_legacy_pm_support(pci_dev))
924 if (pm && pm->resume_noirq)
925 return pm->resume_noirq(dev);
930 static int pci_pm_resume_early(struct device *dev)
932 if (dev_pm_skip_resume(dev))
935 return pm_generic_resume_early(dev);
938 static int pci_pm_resume(struct device *dev)
940 struct pci_dev *pci_dev = to_pci_dev(dev);
941 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
944 * This is necessary for the suspend error path in which resume is
945 * called without restoring the standard config registers of the device.
947 if (pci_dev->state_saved)
948 pci_restore_standard_config(pci_dev);
950 if (pci_has_legacy_pm_support(pci_dev))
951 return pci_legacy_resume(dev);
953 pci_pm_default_resume(pci_dev);
957 return pm->resume(dev);
959 pci_pm_reenable_device(pci_dev);
965 #else /* !CONFIG_SUSPEND */
967 #define pci_pm_suspend NULL
968 #define pci_pm_suspend_late NULL
969 #define pci_pm_suspend_noirq NULL
970 #define pci_pm_resume NULL
971 #define pci_pm_resume_early NULL
972 #define pci_pm_resume_noirq NULL
974 #endif /* !CONFIG_SUSPEND */
976 #ifdef CONFIG_HIBERNATE_CALLBACKS
978 static int pci_pm_freeze(struct device *dev)
980 struct pci_dev *pci_dev = to_pci_dev(dev);
981 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
983 if (pci_has_legacy_pm_support(pci_dev))
984 return pci_legacy_suspend(dev, PMSG_FREEZE);
987 pci_pm_default_suspend(pci_dev);
992 * Resume all runtime-suspended devices before creating a snapshot
993 * image of system memory, because the restore kernel generally cannot
994 * be expected to always handle them consistently and they need to be
995 * put into the runtime-active metastate during system resume anyway,
996 * so it is better to ensure that the state saved in the image will be
997 * always consistent with that.
999 pm_runtime_resume(dev);
1000 pci_dev->state_saved = false;
1005 error = pm->freeze(dev);
1006 suspend_report_result(pm->freeze, error);
1014 static int pci_pm_freeze_noirq(struct device *dev)
1016 struct pci_dev *pci_dev = to_pci_dev(dev);
1017 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1019 if (pci_has_legacy_pm_support(pci_dev))
1020 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
1022 if (pm && pm->freeze_noirq) {
1025 error = pm->freeze_noirq(dev);
1026 suspend_report_result(pm->freeze_noirq, error);
1031 if (!pci_dev->state_saved)
1032 pci_save_state(pci_dev);
1034 pci_pm_set_unknown_state(pci_dev);
1039 static int pci_pm_thaw_noirq(struct device *dev)
1041 struct pci_dev *pci_dev = to_pci_dev(dev);
1042 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1045 * The pm->thaw_noirq() callback assumes the device has been
1046 * returned to D0 and its config state has been restored.
1048 * In addition, pci_restore_state() restores MSI-X state in MMIO
1049 * space, which requires the device to be in D0, so return it to D0
1050 * in case the driver's "freeze" callbacks put it into a low-power
1053 pci_set_power_state(pci_dev, PCI_D0);
1054 pci_restore_state(pci_dev);
1056 if (pci_has_legacy_pm_support(pci_dev))
1059 if (pm && pm->thaw_noirq)
1060 return pm->thaw_noirq(dev);
1065 static int pci_pm_thaw(struct device *dev)
1067 struct pci_dev *pci_dev = to_pci_dev(dev);
1068 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1071 if (pci_has_legacy_pm_support(pci_dev))
1072 return pci_legacy_resume(dev);
1076 error = pm->thaw(dev);
1078 pci_pm_reenable_device(pci_dev);
1081 pci_dev->state_saved = false;
1086 static int pci_pm_poweroff(struct device *dev)
1088 struct pci_dev *pci_dev = to_pci_dev(dev);
1089 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1091 if (pci_has_legacy_pm_support(pci_dev))
1092 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1095 pci_pm_default_suspend(pci_dev);
1099 /* The reason to do that is the same as in pci_pm_suspend(). */
1100 if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1101 pci_dev_need_resume(pci_dev)) {
1102 pm_runtime_resume(dev);
1103 pci_dev->state_saved = false;
1105 pci_dev_adjust_pme(pci_dev);
1111 error = pm->poweroff(dev);
1112 suspend_report_result(pm->poweroff, error);
1120 static int pci_pm_poweroff_late(struct device *dev)
1122 if (dev_pm_skip_suspend(dev))
1125 pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
1127 return pm_generic_poweroff_late(dev);
1130 static int pci_pm_poweroff_noirq(struct device *dev)
1132 struct pci_dev *pci_dev = to_pci_dev(dev);
1133 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1135 if (dev_pm_skip_suspend(dev))
1138 if (pci_has_legacy_pm_support(pci_dev))
1139 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1142 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1146 if (pm->poweroff_noirq) {
1149 error = pm->poweroff_noirq(dev);
1150 suspend_report_result(pm->poweroff_noirq, error);
1155 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1156 pci_prepare_to_sleep(pci_dev);
1159 * The reason for doing this here is the same as for the analogous code
1160 * in pci_pm_suspend_noirq().
1162 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1163 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1165 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1170 static int pci_pm_restore_noirq(struct device *dev)
1172 struct pci_dev *pci_dev = to_pci_dev(dev);
1173 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1175 pci_pm_default_resume_early(pci_dev);
1176 pci_fixup_device(pci_fixup_resume_early, pci_dev);
1178 if (pci_has_legacy_pm_support(pci_dev))
1181 if (pm && pm->restore_noirq)
1182 return pm->restore_noirq(dev);
1187 static int pci_pm_restore(struct device *dev)
1189 struct pci_dev *pci_dev = to_pci_dev(dev);
1190 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1193 * This is necessary for the hibernation error path in which restore is
1194 * called without restoring the standard config registers of the device.
1196 if (pci_dev->state_saved)
1197 pci_restore_standard_config(pci_dev);
1199 if (pci_has_legacy_pm_support(pci_dev))
1200 return pci_legacy_resume(dev);
1202 pci_pm_default_resume(pci_dev);
1206 return pm->restore(dev);
1208 pci_pm_reenable_device(pci_dev);
1214 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1216 #define pci_pm_freeze NULL
1217 #define pci_pm_freeze_noirq NULL
1218 #define pci_pm_thaw NULL
1219 #define pci_pm_thaw_noirq NULL
1220 #define pci_pm_poweroff NULL
1221 #define pci_pm_poweroff_late NULL
1222 #define pci_pm_poweroff_noirq NULL
1223 #define pci_pm_restore NULL
1224 #define pci_pm_restore_noirq NULL
1226 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1230 static int pci_pm_runtime_suspend(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;
1234 pci_power_t prev = pci_dev->current_state;
1238 * If pci_dev->driver is not set (unbound), we leave the device in D0,
1239 * but it may go to D3cold when the bridge above it runtime suspends.
1240 * Save its config space in case that happens.
1242 if (!pci_dev->driver) {
1243 pci_save_state(pci_dev);
1247 pci_dev->state_saved = false;
1248 if (pm && pm->runtime_suspend) {
1249 error = pm->runtime_suspend(dev);
1251 * -EBUSY and -EAGAIN is used to request the runtime PM core
1252 * to schedule a new suspend, so log the event only with debug
1255 if (error == -EBUSY || error == -EAGAIN) {
1256 pci_dbg(pci_dev, "can't suspend now (%ps returned %d)\n",
1257 pm->runtime_suspend, error);
1260 pci_err(pci_dev, "can't suspend (%ps returned %d)\n",
1261 pm->runtime_suspend, error);
1266 pci_fixup_device(pci_fixup_suspend, pci_dev);
1268 if (pm && pm->runtime_suspend
1269 && !pci_dev->state_saved && pci_dev->current_state != PCI_D0
1270 && pci_dev->current_state != PCI_UNKNOWN) {
1271 pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
1272 "PCI PM: State of device not saved by %pS\n",
1273 pm->runtime_suspend);
1277 if (!pci_dev->state_saved) {
1278 pci_save_state(pci_dev);
1279 pci_finish_runtime_suspend(pci_dev);
1285 static int pci_pm_runtime_resume(struct device *dev)
1287 struct pci_dev *pci_dev = to_pci_dev(dev);
1288 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1289 pci_power_t prev_state = pci_dev->current_state;
1293 * Restoring config space is necessary even if the device is not bound
1294 * to a driver because although we left it in D0, it may have gone to
1295 * D3cold when the bridge above it runtime suspended.
1297 pci_restore_standard_config(pci_dev);
1299 if (!pci_dev->driver)
1302 pci_fixup_device(pci_fixup_resume_early, pci_dev);
1303 pci_pm_default_resume(pci_dev);
1305 if (prev_state == PCI_D3cold)
1306 pci_bridge_wait_for_secondary_bus(pci_dev, "resume", PCI_RESET_WAIT);
1308 if (pm && pm->runtime_resume)
1309 error = pm->runtime_resume(dev);
1311 pci_dev->runtime_d3cold = false;
1316 static int pci_pm_runtime_idle(struct device *dev)
1318 struct pci_dev *pci_dev = to_pci_dev(dev);
1319 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1322 * If pci_dev->driver is not set (unbound), the device should
1323 * always remain in D0 regardless of the runtime PM status
1325 if (!pci_dev->driver)
1331 if (pm->runtime_idle)
1332 return pm->runtime_idle(dev);
1337 static const struct dev_pm_ops pci_dev_pm_ops = {
1338 .prepare = pci_pm_prepare,
1339 .complete = pci_pm_complete,
1340 .suspend = pci_pm_suspend,
1341 .suspend_late = pci_pm_suspend_late,
1342 .resume = pci_pm_resume,
1343 .resume_early = pci_pm_resume_early,
1344 .freeze = pci_pm_freeze,
1345 .thaw = pci_pm_thaw,
1346 .poweroff = pci_pm_poweroff,
1347 .poweroff_late = pci_pm_poweroff_late,
1348 .restore = pci_pm_restore,
1349 .suspend_noirq = pci_pm_suspend_noirq,
1350 .resume_noirq = pci_pm_resume_noirq,
1351 .freeze_noirq = pci_pm_freeze_noirq,
1352 .thaw_noirq = pci_pm_thaw_noirq,
1353 .poweroff_noirq = pci_pm_poweroff_noirq,
1354 .restore_noirq = pci_pm_restore_noirq,
1355 .runtime_suspend = pci_pm_runtime_suspend,
1356 .runtime_resume = pci_pm_runtime_resume,
1357 .runtime_idle = pci_pm_runtime_idle,
1360 #define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
1362 #else /* !CONFIG_PM */
1364 #define pci_pm_runtime_suspend NULL
1365 #define pci_pm_runtime_resume NULL
1366 #define pci_pm_runtime_idle NULL
1368 #define PCI_PM_OPS_PTR NULL
1370 #endif /* !CONFIG_PM */
1373 * __pci_register_driver - register a new pci driver
1374 * @drv: the driver structure to register
1375 * @owner: owner module of drv
1376 * @mod_name: module name string
1378 * Adds the driver structure to the list of registered drivers.
1379 * Returns a negative value on error, otherwise 0.
1380 * If no error occurred, the driver remains registered even if
1381 * no device was claimed during registration.
1383 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1384 const char *mod_name)
1386 /* initialize common driver fields */
1387 drv->driver.name = drv->name;
1388 drv->driver.bus = &pci_bus_type;
1389 drv->driver.owner = owner;
1390 drv->driver.mod_name = mod_name;
1391 drv->driver.groups = drv->groups;
1393 spin_lock_init(&drv->dynids.lock);
1394 INIT_LIST_HEAD(&drv->dynids.list);
1396 /* register with core */
1397 return driver_register(&drv->driver);
1399 EXPORT_SYMBOL(__pci_register_driver);
1402 * pci_unregister_driver - unregister a pci driver
1403 * @drv: the driver structure to unregister
1405 * Deletes the driver structure from the list of registered PCI drivers,
1406 * gives it a chance to clean up by calling its remove() function for
1407 * each device it was responsible for, and marks those devices as
1411 void pci_unregister_driver(struct pci_driver *drv)
1413 driver_unregister(&drv->driver);
1414 pci_free_dynids(drv);
1416 EXPORT_SYMBOL(pci_unregister_driver);
1418 static struct pci_driver pci_compat_driver = {
1423 * pci_dev_driver - get the pci_driver of a device
1424 * @dev: the device to query
1426 * Returns the appropriate pci_driver structure or %NULL if there is no
1427 * registered driver for the device.
1429 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1435 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1436 if (dev->resource[i].flags & IORESOURCE_BUSY)
1437 return &pci_compat_driver;
1441 EXPORT_SYMBOL(pci_dev_driver);
1444 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1445 * @dev: the PCI device structure to match against
1446 * @drv: the device driver to search for matching PCI device id structures
1448 * Used by a driver to check whether a PCI device present in the
1449 * system is in its list of supported devices. Returns the matching
1450 * pci_device_id structure or %NULL if there is no match.
1452 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1454 struct pci_dev *pci_dev = to_pci_dev(dev);
1455 struct pci_driver *pci_drv;
1456 const struct pci_device_id *found_id;
1458 if (!pci_dev->match_driver)
1461 pci_drv = to_pci_driver(drv);
1462 found_id = pci_match_device(pci_drv, pci_dev);
1470 * pci_dev_get - increments the reference count of the pci device structure
1471 * @dev: the device being referenced
1473 * Each live reference to a device should be refcounted.
1475 * Drivers for PCI devices should normally record such references in
1476 * their probe() methods, when they bind to a device, and release
1477 * them by calling pci_dev_put(), in their disconnect() methods.
1479 * A pointer to the device with the incremented reference counter is returned.
1481 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1484 get_device(&dev->dev);
1487 EXPORT_SYMBOL(pci_dev_get);
1490 * pci_dev_put - release a use of the pci device structure
1491 * @dev: device that's been disconnected
1493 * Must be called when a user of a device is finished with it. When the last
1494 * user of the device calls this function, the memory of the device is freed.
1496 void pci_dev_put(struct pci_dev *dev)
1499 put_device(&dev->dev);
1501 EXPORT_SYMBOL(pci_dev_put);
1503 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1505 struct pci_dev *pdev;
1510 pdev = to_pci_dev(dev);
1512 if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1515 if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1518 if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1519 pdev->subsystem_device))
1522 if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1525 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1526 pdev->vendor, pdev->device,
1527 pdev->subsystem_vendor, pdev->subsystem_device,
1528 (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1535 #if defined(CONFIG_PCIEPORTBUS) || defined(CONFIG_EEH)
1537 * pci_uevent_ers - emit a uevent during recovery path of PCI device
1538 * @pdev: PCI device undergoing error recovery
1539 * @err_type: type of error event
1541 void pci_uevent_ers(struct pci_dev *pdev, enum pci_ers_result err_type)
1547 case PCI_ERS_RESULT_NONE:
1548 case PCI_ERS_RESULT_CAN_RECOVER:
1549 envp[idx++] = "ERROR_EVENT=BEGIN_RECOVERY";
1550 envp[idx++] = "DEVICE_ONLINE=0";
1552 case PCI_ERS_RESULT_RECOVERED:
1553 envp[idx++] = "ERROR_EVENT=SUCCESSFUL_RECOVERY";
1554 envp[idx++] = "DEVICE_ONLINE=1";
1556 case PCI_ERS_RESULT_DISCONNECT:
1557 envp[idx++] = "ERROR_EVENT=FAILED_RECOVERY";
1558 envp[idx++] = "DEVICE_ONLINE=0";
1566 kobject_uevent_env(&pdev->dev.kobj, KOBJ_CHANGE, envp);
1571 static int pci_bus_num_vf(struct device *dev)
1573 return pci_num_vf(to_pci_dev(dev));
1577 * pci_dma_configure - Setup DMA configuration
1578 * @dev: ptr to dev structure
1580 * Function to update PCI devices's DMA configuration using the same
1581 * info from the OF node or ACPI node of host bridge's parent (if any).
1583 static int pci_dma_configure(struct device *dev)
1585 struct device *bridge;
1588 bridge = pci_get_host_bridge_device(to_pci_dev(dev));
1590 if (IS_ENABLED(CONFIG_OF) && bridge->parent &&
1591 bridge->parent->of_node) {
1592 ret = of_dma_configure(dev, bridge->parent->of_node, true);
1593 } else if (has_acpi_companion(bridge)) {
1594 struct acpi_device *adev = to_acpi_device_node(bridge->fwnode);
1596 ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev));
1599 pci_put_host_bridge_device(bridge);
1603 struct bus_type pci_bus_type = {
1605 .match = pci_bus_match,
1606 .uevent = pci_uevent,
1607 .probe = pci_device_probe,
1608 .remove = pci_device_remove,
1609 .shutdown = pci_device_shutdown,
1610 .dev_groups = pci_dev_groups,
1611 .bus_groups = pci_bus_groups,
1612 .drv_groups = pci_drv_groups,
1613 .pm = PCI_PM_OPS_PTR,
1614 .num_vf = pci_bus_num_vf,
1615 .dma_configure = pci_dma_configure,
1617 EXPORT_SYMBOL(pci_bus_type);
1619 #ifdef CONFIG_PCIEPORTBUS
1620 static int pcie_port_bus_match(struct device *dev, struct device_driver *drv)
1622 struct pcie_device *pciedev;
1623 struct pcie_port_service_driver *driver;
1625 if (drv->bus != &pcie_port_bus_type || dev->bus != &pcie_port_bus_type)
1628 pciedev = to_pcie_device(dev);
1629 driver = to_service_driver(drv);
1631 if (driver->service != pciedev->service)
1634 if (driver->port_type != PCIE_ANY_PORT &&
1635 driver->port_type != pci_pcie_type(pciedev->port))
1641 struct bus_type pcie_port_bus_type = {
1642 .name = "pci_express",
1643 .match = pcie_port_bus_match,
1645 EXPORT_SYMBOL_GPL(pcie_port_bus_type);
1648 static int __init pci_driver_init(void)
1652 ret = bus_register(&pci_bus_type);
1656 #ifdef CONFIG_PCIEPORTBUS
1657 ret = bus_register(&pcie_port_bus_type);
1661 dma_debug_add_bus(&pci_bus_type);
1664 postcore_initcall(pci_driver_init);