2 * drivers/pci/pci-driver.c
5 * (C) Copyright 2007 Novell Inc.
7 * Released under the GPL v2 only.
11 #include <linux/pci.h>
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/device.h>
15 #include <linux/mempolicy.h>
16 #include <linux/string.h>
17 #include <linux/slab.h>
18 #include <linux/sched.h>
19 #include <linux/cpu.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/suspend.h>
22 #include <linux/kexec.h>
26 struct list_head node;
27 struct pci_device_id id;
31 * pci_add_dynid - add a new PCI device ID to this driver and re-probe devices
32 * @drv: target pci driver
33 * @vendor: PCI vendor ID
34 * @device: PCI device ID
35 * @subvendor: PCI subvendor ID
36 * @subdevice: PCI subdevice ID
38 * @class_mask: PCI class mask
39 * @driver_data: private driver data
41 * Adds a new dynamic pci device ID to this driver and causes the
42 * driver to probe for all devices again. @drv must have been
43 * registered prior to calling this function.
46 * Does GFP_KERNEL allocation.
49 * 0 on success, -errno on failure.
51 int pci_add_dynid(struct pci_driver *drv,
52 unsigned int vendor, unsigned int device,
53 unsigned int subvendor, unsigned int subdevice,
54 unsigned int class, unsigned int class_mask,
55 unsigned long driver_data)
57 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 retval = driver_attach(&drv->driver);
80 EXPORT_SYMBOL_GPL(pci_add_dynid);
82 static void pci_free_dynids(struct pci_driver *drv)
84 struct pci_dynid *dynid, *n;
86 spin_lock(&drv->dynids.lock);
87 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
88 list_del(&dynid->node);
91 spin_unlock(&drv->dynids.lock);
95 * store_new_id - sysfs frontend to pci_add_dynid()
96 * @driver: target device driver
97 * @buf: buffer for scanning device ID data
100 * Allow PCI IDs to be added to an existing driver via sysfs.
102 static ssize_t store_new_id(struct device_driver *driver, const char *buf,
105 struct pci_driver *pdrv = to_pci_driver(driver);
106 const struct pci_device_id *ids = pdrv->id_table;
107 __u32 vendor, device, subvendor = PCI_ANY_ID,
108 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
109 unsigned long driver_data = 0;
113 fields = sscanf(buf, "%x %x %x %x %x %x %lx",
114 &vendor, &device, &subvendor, &subdevice,
115 &class, &class_mask, &driver_data);
120 struct pci_dev *pdev = kzalloc(sizeof(*pdev), GFP_KERNEL);
124 pdev->vendor = vendor;
125 pdev->device = device;
126 pdev->subsystem_vendor = subvendor;
127 pdev->subsystem_device = subdevice;
130 if (pci_match_id(pdrv->id_table, pdev))
139 /* Only accept driver_data values that match an existing id_table
143 while (ids->vendor || ids->subvendor || ids->class_mask) {
144 if (driver_data == ids->driver_data) {
150 if (retval) /* No match */
154 retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
155 class, class_mask, driver_data);
160 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
163 * store_remove_id - remove a PCI device ID from this driver
164 * @driver: target device driver
165 * @buf: buffer for scanning device ID data
168 * Removes a dynamic pci device ID to this driver.
170 static ssize_t store_remove_id(struct device_driver *driver, const char *buf,
173 struct pci_dynid *dynid, *n;
174 struct pci_driver *pdrv = to_pci_driver(driver);
175 __u32 vendor, device, subvendor = PCI_ANY_ID,
176 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
178 int retval = -ENODEV;
180 fields = sscanf(buf, "%x %x %x %x %x %x",
181 &vendor, &device, &subvendor, &subdevice,
182 &class, &class_mask);
186 spin_lock(&pdrv->dynids.lock);
187 list_for_each_entry_safe(dynid, n, &pdrv->dynids.list, node) {
188 struct pci_device_id *id = &dynid->id;
189 if ((id->vendor == vendor) &&
190 (id->device == device) &&
191 (subvendor == PCI_ANY_ID || id->subvendor == subvendor) &&
192 (subdevice == PCI_ANY_ID || id->subdevice == subdevice) &&
193 !((id->class ^ class) & class_mask)) {
194 list_del(&dynid->node);
200 spin_unlock(&pdrv->dynids.lock);
206 static DRIVER_ATTR(remove_id, S_IWUSR, NULL, store_remove_id);
208 static struct attribute *pci_drv_attrs[] = {
209 &driver_attr_new_id.attr,
210 &driver_attr_remove_id.attr,
213 ATTRIBUTE_GROUPS(pci_drv);
216 * pci_match_id - See if a pci device matches a given pci_id table
217 * @ids: array of PCI device id structures to search in
218 * @dev: the PCI device structure to match against.
220 * Used by a driver to check whether a PCI device present in the
221 * system is in its list of supported devices. Returns the matching
222 * pci_device_id structure or %NULL if there is no match.
224 * Deprecated, don't use this as it will not catch any dynamic ids
225 * that a driver might want to check for.
227 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
231 while (ids->vendor || ids->subvendor || ids->class_mask) {
232 if (pci_match_one_device(ids, dev))
239 EXPORT_SYMBOL(pci_match_id);
241 static const struct pci_device_id pci_device_id_any = {
242 .vendor = PCI_ANY_ID,
243 .device = PCI_ANY_ID,
244 .subvendor = PCI_ANY_ID,
245 .subdevice = PCI_ANY_ID,
249 * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
250 * @drv: the PCI driver to match against
251 * @dev: the PCI device structure to match against
253 * Used by a driver to check whether a PCI device present in the
254 * system is in its list of supported devices. Returns the matching
255 * pci_device_id structure or %NULL if there is no match.
257 static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
260 struct pci_dynid *dynid;
261 const struct pci_device_id *found_id = NULL;
263 /* When driver_override is set, only bind to the matching driver */
264 if (dev->driver_override && strcmp(dev->driver_override, drv->name))
267 /* Look at the dynamic ids first, before the static ones */
268 spin_lock(&drv->dynids.lock);
269 list_for_each_entry(dynid, &drv->dynids.list, node) {
270 if (pci_match_one_device(&dynid->id, dev)) {
271 found_id = &dynid->id;
275 spin_unlock(&drv->dynids.lock);
278 found_id = pci_match_id(drv->id_table, dev);
280 /* driver_override will always match, send a dummy id */
281 if (!found_id && dev->driver_override)
282 found_id = &pci_device_id_any;
287 struct drv_dev_and_id {
288 struct pci_driver *drv;
290 const struct pci_device_id *id;
293 static long local_pci_probe(void *_ddi)
295 struct drv_dev_and_id *ddi = _ddi;
296 struct pci_dev *pci_dev = ddi->dev;
297 struct pci_driver *pci_drv = ddi->drv;
298 struct device *dev = &pci_dev->dev;
302 * Unbound PCI devices are always put in D0, regardless of
303 * runtime PM status. During probe, the device is set to
304 * active and the usage count is incremented. If the driver
305 * supports runtime PM, it should call pm_runtime_put_noidle()
306 * in its probe routine and pm_runtime_get_noresume() in its
309 pm_runtime_get_sync(dev);
310 pci_dev->driver = pci_drv;
311 rc = pci_drv->probe(pci_dev, ddi->id);
315 pci_dev->driver = NULL;
316 pm_runtime_put_sync(dev);
320 * Probe function should return < 0 for failure, 0 for success
321 * Treat values > 0 as success, but warn.
323 dev_warn(dev, "Driver probe function unexpectedly returned %d\n", rc);
327 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
328 const struct pci_device_id *id)
331 struct drv_dev_and_id ddi = { drv, dev, id };
334 * Execute driver initialization on node where the device is
335 * attached. This way the driver likely allocates its local memory
338 node = dev_to_node(&dev->dev);
341 * On NUMA systems, we are likely to call a PF probe function using
342 * work_on_cpu(). If that probe calls pci_enable_sriov() (which
343 * adds the VF devices via pci_bus_add_device()), we may re-enter
344 * this function to call the VF probe function. Calling
345 * work_on_cpu() again will cause a lockdep warning. Since VFs are
346 * always on the same node as the PF, we can work around this by
347 * avoiding work_on_cpu() when we're already on the correct node.
349 * Preemption is enabled, so it's theoretically unsafe to use
350 * numa_node_id(), but even if we run the probe function on the
351 * wrong node, it should be functionally correct.
353 if (node >= 0 && node != numa_node_id()) {
357 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
358 if (cpu < nr_cpu_ids)
359 error = work_on_cpu(cpu, local_pci_probe, &ddi);
361 error = local_pci_probe(&ddi);
364 error = local_pci_probe(&ddi);
370 * __pci_device_probe - check if a driver wants to claim a specific PCI device
371 * @drv: driver to call to check if it wants the PCI device
372 * @pci_dev: PCI device being probed
374 * returns 0 on success, else error.
375 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
377 static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
379 const struct pci_device_id *id;
382 if (!pci_dev->driver && drv->probe) {
385 id = pci_match_device(drv, pci_dev);
387 error = pci_call_probe(drv, pci_dev, id);
394 static int pci_device_probe(struct device *dev)
397 struct pci_driver *drv;
398 struct pci_dev *pci_dev;
400 drv = to_pci_driver(dev->driver);
401 pci_dev = to_pci_dev(dev);
402 pci_dev_get(pci_dev);
403 error = __pci_device_probe(drv, pci_dev);
405 pci_dev_put(pci_dev);
410 static int pci_device_remove(struct device *dev)
412 struct pci_dev *pci_dev = to_pci_dev(dev);
413 struct pci_driver *drv = pci_dev->driver;
417 pm_runtime_get_sync(dev);
418 drv->remove(pci_dev);
419 pm_runtime_put_noidle(dev);
421 pci_dev->driver = NULL;
424 /* Undo the runtime PM settings in local_pci_probe() */
425 pm_runtime_put_sync(dev);
428 * If the device is still on, set the power state as "unknown",
429 * since it might change by the next time we load the driver.
431 if (pci_dev->current_state == PCI_D0)
432 pci_dev->current_state = PCI_UNKNOWN;
435 * We would love to complain here if pci_dev->is_enabled is set, that
436 * the driver should have called pci_disable_device(), but the
437 * unfortunate fact is there are too many odd BIOS and bridge setups
438 * that don't like drivers doing that all of the time.
439 * Oh well, we can dream of sane hardware when we sleep, no matter how
440 * horrible the crap we have to deal with is when we are awake...
443 pci_dev_put(pci_dev);
447 static void pci_device_shutdown(struct device *dev)
449 struct pci_dev *pci_dev = to_pci_dev(dev);
450 struct pci_driver *drv = pci_dev->driver;
452 pm_runtime_resume(dev);
454 if (drv && drv->shutdown)
455 drv->shutdown(pci_dev);
456 pci_msi_shutdown(pci_dev);
457 pci_msix_shutdown(pci_dev);
461 * If this is a kexec reboot, turn off Bus Master bit on the
462 * device to tell it to not continue to do DMA. Don't touch
463 * devices in D3cold or unknown states.
464 * If it is not a kexec reboot, firmware will hit the PCI
465 * devices with big hammer and stop their DMA any way.
467 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
468 pci_clear_master(pci_dev);
474 /* Auxiliary functions used for system resume and run-time resume. */
477 * pci_restore_standard_config - restore standard config registers of PCI device
478 * @pci_dev: PCI device to handle
480 static int pci_restore_standard_config(struct pci_dev *pci_dev)
482 pci_update_current_state(pci_dev, PCI_UNKNOWN);
484 if (pci_dev->current_state != PCI_D0) {
485 int error = pci_set_power_state(pci_dev, PCI_D0);
490 pci_restore_state(pci_dev);
496 #ifdef CONFIG_PM_SLEEP
498 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
500 pci_power_up(pci_dev);
501 pci_restore_state(pci_dev);
502 pci_fixup_device(pci_fixup_resume_early, pci_dev);
506 * Default "suspend" method for devices that have no driver provided suspend,
507 * or not even a driver at all (second part).
509 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
512 * mark its power state as "unknown", since we don't know if
513 * e.g. the BIOS will change its device state when we suspend.
515 if (pci_dev->current_state == PCI_D0)
516 pci_dev->current_state = PCI_UNKNOWN;
520 * Default "resume" method for devices that have no driver provided resume,
521 * or not even a driver at all (second part).
523 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
527 /* if the device was enabled before suspend, reenable */
528 retval = pci_reenable_device(pci_dev);
530 * if the device was busmaster before the suspend, make it busmaster
533 if (pci_dev->is_busmaster)
534 pci_set_master(pci_dev);
539 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
541 struct pci_dev *pci_dev = to_pci_dev(dev);
542 struct pci_driver *drv = pci_dev->driver;
544 if (drv && drv->suspend) {
545 pci_power_t prev = pci_dev->current_state;
548 error = drv->suspend(pci_dev, state);
549 suspend_report_result(drv->suspend, error);
553 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
554 && pci_dev->current_state != PCI_UNKNOWN) {
555 WARN_ONCE(pci_dev->current_state != prev,
556 "PCI PM: Device state not saved by %pF\n",
561 pci_fixup_device(pci_fixup_suspend, pci_dev);
566 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
568 struct pci_dev *pci_dev = to_pci_dev(dev);
569 struct pci_driver *drv = pci_dev->driver;
571 if (drv && drv->suspend_late) {
572 pci_power_t prev = pci_dev->current_state;
575 error = drv->suspend_late(pci_dev, state);
576 suspend_report_result(drv->suspend_late, error);
580 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
581 && pci_dev->current_state != PCI_UNKNOWN) {
582 WARN_ONCE(pci_dev->current_state != prev,
583 "PCI PM: Device state not saved by %pF\n",
589 if (!pci_dev->state_saved)
590 pci_save_state(pci_dev);
592 pci_pm_set_unknown_state(pci_dev);
597 static int pci_legacy_resume_early(struct device *dev)
599 struct pci_dev *pci_dev = to_pci_dev(dev);
600 struct pci_driver *drv = pci_dev->driver;
602 return drv && drv->resume_early ?
603 drv->resume_early(pci_dev) : 0;
606 static int pci_legacy_resume(struct device *dev)
608 struct pci_dev *pci_dev = to_pci_dev(dev);
609 struct pci_driver *drv = pci_dev->driver;
611 pci_fixup_device(pci_fixup_resume, pci_dev);
613 return drv && drv->resume ?
614 drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
617 /* Auxiliary functions used by the new power management framework */
619 static void pci_pm_default_resume(struct pci_dev *pci_dev)
621 pci_fixup_device(pci_fixup_resume, pci_dev);
623 if (!pci_has_subordinate(pci_dev))
624 pci_enable_wake(pci_dev, PCI_D0, false);
627 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
629 /* Disable non-bridge devices without PM support */
630 if (!pci_has_subordinate(pci_dev))
631 pci_disable_enabled_device(pci_dev);
634 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
636 struct pci_driver *drv = pci_dev->driver;
637 bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
638 || drv->resume_early);
641 * Legacy PM support is used by default, so warn if the new framework is
642 * supported as well. Drivers are supposed to support either the
643 * former, or the latter, but not both at the same time.
645 WARN(ret && drv->driver.pm, "driver %s device %04x:%04x\n",
646 drv->name, pci_dev->vendor, pci_dev->device);
651 /* New power management framework */
653 static int pci_pm_prepare(struct device *dev)
655 struct device_driver *drv = dev->driver;
659 * Devices having power.ignore_children set may still be necessary for
660 * suspending their children in the next phase of device suspend.
662 if (dev->power.ignore_children)
663 pm_runtime_resume(dev);
665 if (drv && drv->pm && drv->pm->prepare)
666 error = drv->pm->prepare(dev);
672 #else /* !CONFIG_PM_SLEEP */
674 #define pci_pm_prepare NULL
676 #endif /* !CONFIG_PM_SLEEP */
678 #ifdef CONFIG_SUSPEND
680 static int pci_pm_suspend(struct device *dev)
682 struct pci_dev *pci_dev = to_pci_dev(dev);
683 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
685 if (pci_has_legacy_pm_support(pci_dev))
686 return pci_legacy_suspend(dev, PMSG_SUSPEND);
689 pci_pm_default_suspend(pci_dev);
694 * PCI devices suspended at run time need to be resumed at this point,
695 * because in general it is necessary to reconfigure them for system
696 * suspend. Namely, if the device is supposed to wake up the system
697 * from the sleep state, we may need to reconfigure it for this purpose.
698 * In turn, if the device is not supposed to wake up the system from the
699 * sleep state, we'll have to prevent it from signaling wake-up.
701 pm_runtime_resume(dev);
703 pci_dev->state_saved = false;
705 pci_power_t prev = pci_dev->current_state;
708 error = pm->suspend(dev);
709 suspend_report_result(pm->suspend, error);
713 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
714 && pci_dev->current_state != PCI_UNKNOWN) {
715 WARN_ONCE(pci_dev->current_state != prev,
716 "PCI PM: State of device not saved by %pF\n",
722 pci_fixup_device(pci_fixup_suspend, pci_dev);
727 static int pci_pm_suspend_noirq(struct device *dev)
729 struct pci_dev *pci_dev = to_pci_dev(dev);
730 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
732 if (pci_has_legacy_pm_support(pci_dev))
733 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
736 pci_save_state(pci_dev);
740 if (pm->suspend_noirq) {
741 pci_power_t prev = pci_dev->current_state;
744 error = pm->suspend_noirq(dev);
745 suspend_report_result(pm->suspend_noirq, error);
749 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
750 && pci_dev->current_state != PCI_UNKNOWN) {
751 WARN_ONCE(pci_dev->current_state != prev,
752 "PCI PM: State of device not saved by %pF\n",
758 if (!pci_dev->state_saved) {
759 pci_save_state(pci_dev);
760 if (!pci_has_subordinate(pci_dev))
761 pci_prepare_to_sleep(pci_dev);
764 pci_pm_set_unknown_state(pci_dev);
767 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
768 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
769 * hasn't been quiesced and tries to turn it off. If the controller
770 * is already in D3, this can hang or cause memory corruption.
772 * Since the value of the COMMAND register doesn't matter once the
773 * device has been suspended, we can safely set it to 0 here.
775 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
776 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
781 static int pci_pm_resume_noirq(struct device *dev)
783 struct pci_dev *pci_dev = to_pci_dev(dev);
784 struct device_driver *drv = dev->driver;
787 pci_pm_default_resume_early(pci_dev);
789 if (pci_has_legacy_pm_support(pci_dev))
790 return pci_legacy_resume_early(dev);
792 if (drv && drv->pm && drv->pm->resume_noirq)
793 error = drv->pm->resume_noirq(dev);
798 static int pci_pm_resume(struct device *dev)
800 struct pci_dev *pci_dev = to_pci_dev(dev);
801 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
805 * This is necessary for the suspend error path in which resume is
806 * called without restoring the standard config registers of the device.
808 if (pci_dev->state_saved)
809 pci_restore_standard_config(pci_dev);
811 if (pci_has_legacy_pm_support(pci_dev))
812 return pci_legacy_resume(dev);
814 pci_pm_default_resume(pci_dev);
818 error = pm->resume(dev);
820 pci_pm_reenable_device(pci_dev);
826 #else /* !CONFIG_SUSPEND */
828 #define pci_pm_suspend NULL
829 #define pci_pm_suspend_noirq NULL
830 #define pci_pm_resume NULL
831 #define pci_pm_resume_noirq NULL
833 #endif /* !CONFIG_SUSPEND */
835 #ifdef CONFIG_HIBERNATE_CALLBACKS
839 * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
840 * a hibernate transition
842 struct dev_pm_ops __weak pcibios_pm_ops;
844 static int pci_pm_freeze(struct device *dev)
846 struct pci_dev *pci_dev = to_pci_dev(dev);
847 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
849 if (pci_has_legacy_pm_support(pci_dev))
850 return pci_legacy_suspend(dev, PMSG_FREEZE);
853 pci_pm_default_suspend(pci_dev);
858 * This used to be done in pci_pm_prepare() for all devices and some
859 * drivers may depend on it, so do it here. Ideally, runtime-suspended
860 * devices should not be touched during freeze/thaw transitions,
863 pm_runtime_resume(dev);
865 pci_dev->state_saved = false;
869 error = pm->freeze(dev);
870 suspend_report_result(pm->freeze, error);
875 if (pcibios_pm_ops.freeze)
876 return pcibios_pm_ops.freeze(dev);
881 static int pci_pm_freeze_noirq(struct device *dev)
883 struct pci_dev *pci_dev = to_pci_dev(dev);
884 struct device_driver *drv = dev->driver;
886 if (pci_has_legacy_pm_support(pci_dev))
887 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
889 if (drv && drv->pm && drv->pm->freeze_noirq) {
892 error = drv->pm->freeze_noirq(dev);
893 suspend_report_result(drv->pm->freeze_noirq, error);
898 if (!pci_dev->state_saved)
899 pci_save_state(pci_dev);
901 pci_pm_set_unknown_state(pci_dev);
903 if (pcibios_pm_ops.freeze_noirq)
904 return pcibios_pm_ops.freeze_noirq(dev);
909 static int pci_pm_thaw_noirq(struct device *dev)
911 struct pci_dev *pci_dev = to_pci_dev(dev);
912 struct device_driver *drv = dev->driver;
915 if (pcibios_pm_ops.thaw_noirq) {
916 error = pcibios_pm_ops.thaw_noirq(dev);
921 if (pci_has_legacy_pm_support(pci_dev))
922 return pci_legacy_resume_early(dev);
924 pci_update_current_state(pci_dev, PCI_D0);
926 if (drv && drv->pm && drv->pm->thaw_noirq)
927 error = drv->pm->thaw_noirq(dev);
932 static int pci_pm_thaw(struct device *dev)
934 struct pci_dev *pci_dev = to_pci_dev(dev);
935 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
938 if (pcibios_pm_ops.thaw) {
939 error = pcibios_pm_ops.thaw(dev);
944 if (pci_has_legacy_pm_support(pci_dev))
945 return pci_legacy_resume(dev);
949 error = pm->thaw(dev);
951 pci_pm_reenable_device(pci_dev);
954 pci_dev->state_saved = false;
959 static int pci_pm_poweroff(struct device *dev)
961 struct pci_dev *pci_dev = to_pci_dev(dev);
962 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
964 if (pci_has_legacy_pm_support(pci_dev))
965 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
968 pci_pm_default_suspend(pci_dev);
972 /* The reason to do that is the same as in pci_pm_suspend(). */
973 pm_runtime_resume(dev);
975 pci_dev->state_saved = false;
979 error = pm->poweroff(dev);
980 suspend_report_result(pm->poweroff, error);
986 pci_fixup_device(pci_fixup_suspend, pci_dev);
988 if (pcibios_pm_ops.poweroff)
989 return pcibios_pm_ops.poweroff(dev);
994 static int pci_pm_poweroff_noirq(struct device *dev)
996 struct pci_dev *pci_dev = to_pci_dev(dev);
997 struct device_driver *drv = dev->driver;
999 if (pci_has_legacy_pm_support(to_pci_dev(dev)))
1000 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1002 if (!drv || !drv->pm)
1005 if (drv->pm->poweroff_noirq) {
1008 error = drv->pm->poweroff_noirq(dev);
1009 suspend_report_result(drv->pm->poweroff_noirq, error);
1014 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1015 pci_prepare_to_sleep(pci_dev);
1018 * The reason for doing this here is the same as for the analogous code
1019 * in pci_pm_suspend_noirq().
1021 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1022 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1024 if (pcibios_pm_ops.poweroff_noirq)
1025 return pcibios_pm_ops.poweroff_noirq(dev);
1030 static int pci_pm_restore_noirq(struct device *dev)
1032 struct pci_dev *pci_dev = to_pci_dev(dev);
1033 struct device_driver *drv = dev->driver;
1036 if (pcibios_pm_ops.restore_noirq) {
1037 error = pcibios_pm_ops.restore_noirq(dev);
1042 pci_pm_default_resume_early(pci_dev);
1044 if (pci_has_legacy_pm_support(pci_dev))
1045 return pci_legacy_resume_early(dev);
1047 if (drv && drv->pm && drv->pm->restore_noirq)
1048 error = drv->pm->restore_noirq(dev);
1053 static int pci_pm_restore(struct device *dev)
1055 struct pci_dev *pci_dev = to_pci_dev(dev);
1056 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1059 if (pcibios_pm_ops.restore) {
1060 error = pcibios_pm_ops.restore(dev);
1066 * This is necessary for the hibernation error path in which restore is
1067 * called without restoring the standard config registers of the device.
1069 if (pci_dev->state_saved)
1070 pci_restore_standard_config(pci_dev);
1072 if (pci_has_legacy_pm_support(pci_dev))
1073 return pci_legacy_resume(dev);
1075 pci_pm_default_resume(pci_dev);
1079 error = pm->restore(dev);
1081 pci_pm_reenable_device(pci_dev);
1087 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1089 #define pci_pm_freeze NULL
1090 #define pci_pm_freeze_noirq NULL
1091 #define pci_pm_thaw NULL
1092 #define pci_pm_thaw_noirq NULL
1093 #define pci_pm_poweroff NULL
1094 #define pci_pm_poweroff_noirq NULL
1095 #define pci_pm_restore NULL
1096 #define pci_pm_restore_noirq NULL
1098 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1100 #ifdef CONFIG_PM_RUNTIME
1102 static int pci_pm_runtime_suspend(struct device *dev)
1104 struct pci_dev *pci_dev = to_pci_dev(dev);
1105 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1106 pci_power_t prev = pci_dev->current_state;
1110 * If pci_dev->driver is not set (unbound), the device should
1111 * always remain in D0 regardless of the runtime PM status
1113 if (!pci_dev->driver)
1116 if (!pm || !pm->runtime_suspend)
1119 pci_dev->state_saved = false;
1120 pci_dev->no_d3cold = false;
1121 error = pm->runtime_suspend(dev);
1122 suspend_report_result(pm->runtime_suspend, error);
1125 if (!pci_dev->d3cold_allowed)
1126 pci_dev->no_d3cold = true;
1128 pci_fixup_device(pci_fixup_suspend, pci_dev);
1130 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
1131 && pci_dev->current_state != PCI_UNKNOWN) {
1132 WARN_ONCE(pci_dev->current_state != prev,
1133 "PCI PM: State of device not saved by %pF\n",
1134 pm->runtime_suspend);
1138 if (!pci_dev->state_saved) {
1139 pci_save_state(pci_dev);
1140 pci_finish_runtime_suspend(pci_dev);
1146 static int pci_pm_runtime_resume(struct device *dev)
1149 struct pci_dev *pci_dev = to_pci_dev(dev);
1150 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1153 * If pci_dev->driver is not set (unbound), the device should
1154 * always remain in D0 regardless of the runtime PM status
1156 if (!pci_dev->driver)
1159 if (!pm || !pm->runtime_resume)
1162 pci_restore_standard_config(pci_dev);
1163 pci_fixup_device(pci_fixup_resume_early, pci_dev);
1164 __pci_enable_wake(pci_dev, PCI_D0, true, false);
1165 pci_fixup_device(pci_fixup_resume, pci_dev);
1167 rc = pm->runtime_resume(dev);
1169 pci_dev->runtime_d3cold = false;
1174 static int pci_pm_runtime_idle(struct device *dev)
1176 struct pci_dev *pci_dev = to_pci_dev(dev);
1177 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1181 * If pci_dev->driver is not set (unbound), the device should
1182 * always remain in D0 regardless of the runtime PM status
1184 if (!pci_dev->driver)
1190 if (pm->runtime_idle)
1191 ret = pm->runtime_idle(dev);
1196 #else /* !CONFIG_PM_RUNTIME */
1198 #define pci_pm_runtime_suspend NULL
1199 #define pci_pm_runtime_resume NULL
1200 #define pci_pm_runtime_idle NULL
1202 #endif /* !CONFIG_PM_RUNTIME */
1206 static const struct dev_pm_ops pci_dev_pm_ops = {
1207 .prepare = pci_pm_prepare,
1208 .suspend = pci_pm_suspend,
1209 .resume = pci_pm_resume,
1210 .freeze = pci_pm_freeze,
1211 .thaw = pci_pm_thaw,
1212 .poweroff = pci_pm_poweroff,
1213 .restore = pci_pm_restore,
1214 .suspend_noirq = pci_pm_suspend_noirq,
1215 .resume_noirq = pci_pm_resume_noirq,
1216 .freeze_noirq = pci_pm_freeze_noirq,
1217 .thaw_noirq = pci_pm_thaw_noirq,
1218 .poweroff_noirq = pci_pm_poweroff_noirq,
1219 .restore_noirq = pci_pm_restore_noirq,
1220 .runtime_suspend = pci_pm_runtime_suspend,
1221 .runtime_resume = pci_pm_runtime_resume,
1222 .runtime_idle = pci_pm_runtime_idle,
1225 #define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
1227 #else /* !COMFIG_PM_OPS */
1229 #define PCI_PM_OPS_PTR NULL
1231 #endif /* !COMFIG_PM_OPS */
1234 * __pci_register_driver - register a new pci driver
1235 * @drv: the driver structure to register
1236 * @owner: owner module of drv
1237 * @mod_name: module name string
1239 * Adds the driver structure to the list of registered drivers.
1240 * Returns a negative value on error, otherwise 0.
1241 * If no error occurred, the driver remains registered even if
1242 * no device was claimed during registration.
1244 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1245 const char *mod_name)
1247 /* initialize common driver fields */
1248 drv->driver.name = drv->name;
1249 drv->driver.bus = &pci_bus_type;
1250 drv->driver.owner = owner;
1251 drv->driver.mod_name = mod_name;
1253 spin_lock_init(&drv->dynids.lock);
1254 INIT_LIST_HEAD(&drv->dynids.list);
1256 /* register with core */
1257 return driver_register(&drv->driver);
1259 EXPORT_SYMBOL(__pci_register_driver);
1262 * pci_unregister_driver - unregister a pci driver
1263 * @drv: the driver structure to unregister
1265 * Deletes the driver structure from the list of registered PCI drivers,
1266 * gives it a chance to clean up by calling its remove() function for
1267 * each device it was responsible for, and marks those devices as
1271 void pci_unregister_driver(struct pci_driver *drv)
1273 driver_unregister(&drv->driver);
1274 pci_free_dynids(drv);
1276 EXPORT_SYMBOL(pci_unregister_driver);
1278 static struct pci_driver pci_compat_driver = {
1283 * pci_dev_driver - get the pci_driver of a device
1284 * @dev: the device to query
1286 * Returns the appropriate pci_driver structure or %NULL if there is no
1287 * registered driver for the device.
1289 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1295 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1296 if (dev->resource[i].flags & IORESOURCE_BUSY)
1297 return &pci_compat_driver;
1301 EXPORT_SYMBOL(pci_dev_driver);
1304 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1305 * @dev: the PCI device structure to match against
1306 * @drv: the device driver to search for matching PCI device id structures
1308 * Used by a driver to check whether a PCI device present in the
1309 * system is in its list of supported devices. Returns the matching
1310 * pci_device_id structure or %NULL if there is no match.
1312 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1314 struct pci_dev *pci_dev = to_pci_dev(dev);
1315 struct pci_driver *pci_drv;
1316 const struct pci_device_id *found_id;
1318 if (!pci_dev->match_driver)
1321 pci_drv = to_pci_driver(drv);
1322 found_id = pci_match_device(pci_drv, pci_dev);
1330 * pci_dev_get - increments the reference count of the pci device structure
1331 * @dev: the device being referenced
1333 * Each live reference to a device should be refcounted.
1335 * Drivers for PCI devices should normally record such references in
1336 * their probe() methods, when they bind to a device, and release
1337 * them by calling pci_dev_put(), in their disconnect() methods.
1339 * A pointer to the device with the incremented reference counter is returned.
1341 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1344 get_device(&dev->dev);
1347 EXPORT_SYMBOL(pci_dev_get);
1350 * pci_dev_put - release a use of the pci device structure
1351 * @dev: device that's been disconnected
1353 * Must be called when a user of a device is finished with it. When the last
1354 * user of the device calls this function, the memory of the device is freed.
1356 void pci_dev_put(struct pci_dev *dev)
1359 put_device(&dev->dev);
1361 EXPORT_SYMBOL(pci_dev_put);
1363 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1365 struct pci_dev *pdev;
1370 pdev = to_pci_dev(dev);
1372 if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1375 if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1378 if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1379 pdev->subsystem_device))
1382 if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1385 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02x",
1386 pdev->vendor, pdev->device,
1387 pdev->subsystem_vendor, pdev->subsystem_device,
1388 (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1395 struct bus_type pci_bus_type = {
1397 .match = pci_bus_match,
1398 .uevent = pci_uevent,
1399 .probe = pci_device_probe,
1400 .remove = pci_device_remove,
1401 .shutdown = pci_device_shutdown,
1402 .dev_groups = pci_dev_groups,
1403 .bus_groups = pci_bus_groups,
1404 .drv_groups = pci_drv_groups,
1405 .pm = PCI_PM_OPS_PTR,
1407 EXPORT_SYMBOL(pci_bus_type);
1409 static int __init pci_driver_init(void)
1411 return bus_register(&pci_bus_type);
1413 postcore_initcall(pci_driver_init);