2 * drivers/pci/pci-driver.c
4 * (C) Copyright 2002-2004, 2007 Greg Kroah-Hartman <greg@kroah.com>
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;
59 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
63 dynid->id.vendor = vendor;
64 dynid->id.device = device;
65 dynid->id.subvendor = subvendor;
66 dynid->id.subdevice = subdevice;
67 dynid->id.class = class;
68 dynid->id.class_mask = class_mask;
69 dynid->id.driver_data = driver_data;
71 spin_lock(&drv->dynids.lock);
72 list_add_tail(&dynid->node, &drv->dynids.list);
73 spin_unlock(&drv->dynids.lock);
75 return driver_attach(&drv->driver);
77 EXPORT_SYMBOL_GPL(pci_add_dynid);
79 static void pci_free_dynids(struct pci_driver *drv)
81 struct pci_dynid *dynid, *n;
83 spin_lock(&drv->dynids.lock);
84 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
85 list_del(&dynid->node);
88 spin_unlock(&drv->dynids.lock);
92 * store_new_id - sysfs frontend to pci_add_dynid()
93 * @driver: target device driver
94 * @buf: buffer for scanning device ID data
97 * Allow PCI IDs to be added to an existing driver via sysfs.
99 static ssize_t new_id_store(struct device_driver *driver, const char *buf,
102 struct pci_driver *pdrv = to_pci_driver(driver);
103 const struct pci_device_id *ids = pdrv->id_table;
104 __u32 vendor, device, subvendor = PCI_ANY_ID,
105 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
106 unsigned long driver_data = 0;
110 fields = sscanf(buf, "%x %x %x %x %x %x %lx",
111 &vendor, &device, &subvendor, &subdevice,
112 &class, &class_mask, &driver_data);
117 struct pci_dev *pdev = kzalloc(sizeof(*pdev), GFP_KERNEL);
121 pdev->vendor = vendor;
122 pdev->device = device;
123 pdev->subsystem_vendor = subvendor;
124 pdev->subsystem_device = subdevice;
127 if (pci_match_id(pdrv->id_table, pdev))
136 /* Only accept driver_data values that match an existing id_table
140 while (ids->vendor || ids->subvendor || ids->class_mask) {
141 if (driver_data == ids->driver_data) {
147 if (retval) /* No match */
151 retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
152 class, class_mask, driver_data);
157 static DRIVER_ATTR_WO(new_id);
160 * store_remove_id - remove a PCI device ID from this driver
161 * @driver: target device driver
162 * @buf: buffer for scanning device ID data
165 * Removes a dynamic pci device ID to this driver.
167 static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
170 struct pci_dynid *dynid, *n;
171 struct pci_driver *pdrv = to_pci_driver(driver);
172 __u32 vendor, device, subvendor = PCI_ANY_ID,
173 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
175 size_t retval = -ENODEV;
177 fields = sscanf(buf, "%x %x %x %x %x %x",
178 &vendor, &device, &subvendor, &subdevice,
179 &class, &class_mask);
183 spin_lock(&pdrv->dynids.lock);
184 list_for_each_entry_safe(dynid, n, &pdrv->dynids.list, node) {
185 struct pci_device_id *id = &dynid->id;
186 if ((id->vendor == vendor) &&
187 (id->device == device) &&
188 (subvendor == PCI_ANY_ID || id->subvendor == subvendor) &&
189 (subdevice == PCI_ANY_ID || id->subdevice == subdevice) &&
190 !((id->class ^ class) & class_mask)) {
191 list_del(&dynid->node);
197 spin_unlock(&pdrv->dynids.lock);
201 static DRIVER_ATTR_WO(remove_id);
203 static struct attribute *pci_drv_attrs[] = {
204 &driver_attr_new_id.attr,
205 &driver_attr_remove_id.attr,
208 ATTRIBUTE_GROUPS(pci_drv);
211 * pci_match_id - See if a pci device matches a given pci_id table
212 * @ids: array of PCI device id structures to search in
213 * @dev: the PCI device structure to match against.
215 * Used by a driver to check whether a PCI device present in the
216 * system is in its list of supported devices. Returns the matching
217 * pci_device_id structure or %NULL if there is no match.
219 * Deprecated, don't use this as it will not catch any dynamic ids
220 * that a driver might want to check for.
222 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
226 while (ids->vendor || ids->subvendor || ids->class_mask) {
227 if (pci_match_one_device(ids, dev))
234 EXPORT_SYMBOL(pci_match_id);
236 static const struct pci_device_id pci_device_id_any = {
237 .vendor = PCI_ANY_ID,
238 .device = PCI_ANY_ID,
239 .subvendor = PCI_ANY_ID,
240 .subdevice = PCI_ANY_ID,
244 * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
245 * @drv: the PCI driver to match against
246 * @dev: the PCI device structure to match against
248 * Used by a driver to check whether a PCI device present in the
249 * system is in its list of supported devices. Returns the matching
250 * pci_device_id structure or %NULL if there is no match.
252 static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
255 struct pci_dynid *dynid;
256 const struct pci_device_id *found_id = NULL;
258 /* When driver_override is set, only bind to the matching driver */
259 if (dev->driver_override && strcmp(dev->driver_override, drv->name))
262 /* Look at the dynamic ids first, before the static ones */
263 spin_lock(&drv->dynids.lock);
264 list_for_each_entry(dynid, &drv->dynids.list, node) {
265 if (pci_match_one_device(&dynid->id, dev)) {
266 found_id = &dynid->id;
270 spin_unlock(&drv->dynids.lock);
273 found_id = pci_match_id(drv->id_table, dev);
275 /* driver_override will always match, send a dummy id */
276 if (!found_id && dev->driver_override)
277 found_id = &pci_device_id_any;
282 struct drv_dev_and_id {
283 struct pci_driver *drv;
285 const struct pci_device_id *id;
288 static long local_pci_probe(void *_ddi)
290 struct drv_dev_and_id *ddi = _ddi;
291 struct pci_dev *pci_dev = ddi->dev;
292 struct pci_driver *pci_drv = ddi->drv;
293 struct device *dev = &pci_dev->dev;
297 * Unbound PCI devices are always put in D0, regardless of
298 * runtime PM status. During probe, the device is set to
299 * active and the usage count is incremented. If the driver
300 * supports runtime PM, it should call pm_runtime_put_noidle(),
301 * or any other runtime PM helper function decrementing the usage
302 * count, in its probe routine and pm_runtime_get_noresume() in
303 * its remove routine.
305 pm_runtime_get_sync(dev);
306 pci_dev->driver = pci_drv;
307 rc = pci_drv->probe(pci_dev, ddi->id);
311 pci_dev->driver = NULL;
312 pm_runtime_put_sync(dev);
316 * Probe function should return < 0 for failure, 0 for success
317 * Treat values > 0 as success, but warn.
319 dev_warn(dev, "Driver probe function unexpectedly returned %d\n", rc);
323 static bool pci_physfn_is_probed(struct pci_dev *dev)
325 #ifdef CONFIG_PCI_IOV
326 return dev->is_virtfn && dev->physfn->is_probed;
332 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
333 const struct pci_device_id *id)
335 int error, node, cpu;
336 struct drv_dev_and_id ddi = { drv, dev, id };
339 * Execute driver initialization on node where the device is
340 * attached. This way the driver likely allocates its local memory
343 node = dev_to_node(&dev->dev);
346 cpu_hotplug_disable();
349 * Prevent nesting work_on_cpu() for the case where a Virtual Function
350 * device is probed from work_on_cpu() of the Physical device.
352 if (node < 0 || node >= MAX_NUMNODES || !node_online(node) ||
353 pci_physfn_is_probed(dev))
356 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 cpu_hotplug_enable();
369 * __pci_device_probe - check if a driver wants to claim a specific PCI device
370 * @drv: driver to call to check if it wants the PCI device
371 * @pci_dev: PCI device being probed
373 * returns 0 on success, else error.
374 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
376 static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
378 const struct pci_device_id *id;
381 if (!pci_dev->driver && drv->probe) {
384 id = pci_match_device(drv, pci_dev);
386 error = pci_call_probe(drv, pci_dev, id);
391 int __weak pcibios_alloc_irq(struct pci_dev *dev)
396 void __weak pcibios_free_irq(struct pci_dev *dev)
400 #ifdef CONFIG_PCI_IOV
401 static inline bool pci_device_can_probe(struct pci_dev *pdev)
403 return (!pdev->is_virtfn || pdev->physfn->sriov->drivers_autoprobe ||
404 pdev->driver_override);
407 static inline bool pci_device_can_probe(struct pci_dev *pdev)
413 static int pci_device_probe(struct device *dev)
416 struct pci_dev *pci_dev = to_pci_dev(dev);
417 struct pci_driver *drv = to_pci_driver(dev->driver);
419 if (!pci_device_can_probe(pci_dev))
422 pci_assign_irq(pci_dev);
424 error = pcibios_alloc_irq(pci_dev);
428 pci_dev_get(pci_dev);
429 error = __pci_device_probe(drv, pci_dev);
431 pcibios_free_irq(pci_dev);
432 pci_dev_put(pci_dev);
438 static int pci_device_remove(struct device *dev)
440 struct pci_dev *pci_dev = to_pci_dev(dev);
441 struct pci_driver *drv = pci_dev->driver;
445 pm_runtime_get_sync(dev);
446 drv->remove(pci_dev);
447 pm_runtime_put_noidle(dev);
449 pcibios_free_irq(pci_dev);
450 pci_dev->driver = NULL;
453 /* Undo the runtime PM settings in local_pci_probe() */
454 pm_runtime_put_sync(dev);
457 * If the device is still on, set the power state as "unknown",
458 * since it might change by the next time we load the driver.
460 if (pci_dev->current_state == PCI_D0)
461 pci_dev->current_state = PCI_UNKNOWN;
464 * We would love to complain here if pci_dev->is_enabled is set, that
465 * the driver should have called pci_disable_device(), but the
466 * unfortunate fact is there are too many odd BIOS and bridge setups
467 * that don't like drivers doing that all of the time.
468 * Oh well, we can dream of sane hardware when we sleep, no matter how
469 * horrible the crap we have to deal with is when we are awake...
472 pci_dev_put(pci_dev);
476 static void pci_device_shutdown(struct device *dev)
478 struct pci_dev *pci_dev = to_pci_dev(dev);
479 struct pci_driver *drv = pci_dev->driver;
481 pm_runtime_resume(dev);
483 if (drv && drv->shutdown)
484 drv->shutdown(pci_dev);
487 * If this is a kexec reboot, turn off Bus Master bit on the
488 * device to tell it to not continue to do DMA. Don't touch
489 * devices in D3cold or unknown states.
490 * If it is not a kexec reboot, firmware will hit the PCI
491 * devices with big hammer and stop their DMA any way.
493 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
494 pci_clear_master(pci_dev);
499 /* Auxiliary functions used for system resume and run-time resume. */
502 * pci_restore_standard_config - restore standard config registers of PCI device
503 * @pci_dev: PCI device to handle
505 static int pci_restore_standard_config(struct pci_dev *pci_dev)
507 pci_update_current_state(pci_dev, PCI_UNKNOWN);
509 if (pci_dev->current_state != PCI_D0) {
510 int error = pci_set_power_state(pci_dev, PCI_D0);
515 pci_restore_state(pci_dev);
516 pci_pme_restore(pci_dev);
522 #ifdef CONFIG_PM_SLEEP
524 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
526 pci_power_up(pci_dev);
527 pci_restore_state(pci_dev);
528 pci_pme_restore(pci_dev);
529 pci_fixup_device(pci_fixup_resume_early, pci_dev);
533 * Default "suspend" method for devices that have no driver provided suspend,
534 * or not even a driver at all (second part).
536 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
539 * mark its power state as "unknown", since we don't know if
540 * e.g. the BIOS will change its device state when we suspend.
542 if (pci_dev->current_state == PCI_D0)
543 pci_dev->current_state = PCI_UNKNOWN;
547 * Default "resume" method for devices that have no driver provided resume,
548 * or not even a driver at all (second part).
550 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
554 /* if the device was enabled before suspend, reenable */
555 retval = pci_reenable_device(pci_dev);
557 * if the device was busmaster before the suspend, make it busmaster
560 if (pci_dev->is_busmaster)
561 pci_set_master(pci_dev);
566 static int pci_legacy_suspend(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) {
572 pci_power_t prev = pci_dev->current_state;
575 error = drv->suspend(pci_dev, state);
576 suspend_report_result(drv->suspend, 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",
588 pci_fixup_device(pci_fixup_suspend, pci_dev);
593 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
595 struct pci_dev *pci_dev = to_pci_dev(dev);
596 struct pci_driver *drv = pci_dev->driver;
598 if (drv && drv->suspend_late) {
599 pci_power_t prev = pci_dev->current_state;
602 error = drv->suspend_late(pci_dev, state);
603 suspend_report_result(drv->suspend_late, error);
607 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
608 && pci_dev->current_state != PCI_UNKNOWN) {
609 WARN_ONCE(pci_dev->current_state != prev,
610 "PCI PM: Device state not saved by %pF\n",
616 if (!pci_dev->state_saved)
617 pci_save_state(pci_dev);
619 pci_pm_set_unknown_state(pci_dev);
622 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
627 static int pci_legacy_resume_early(struct device *dev)
629 struct pci_dev *pci_dev = to_pci_dev(dev);
630 struct pci_driver *drv = pci_dev->driver;
632 return drv && drv->resume_early ?
633 drv->resume_early(pci_dev) : 0;
636 static int pci_legacy_resume(struct device *dev)
638 struct pci_dev *pci_dev = to_pci_dev(dev);
639 struct pci_driver *drv = pci_dev->driver;
641 pci_fixup_device(pci_fixup_resume, pci_dev);
643 return drv && drv->resume ?
644 drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
647 /* Auxiliary functions used by the new power management framework */
649 static void pci_pm_default_resume(struct pci_dev *pci_dev)
651 pci_fixup_device(pci_fixup_resume, pci_dev);
652 pci_enable_wake(pci_dev, PCI_D0, false);
655 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
657 /* Disable non-bridge devices without PM support */
658 if (!pci_has_subordinate(pci_dev))
659 pci_disable_enabled_device(pci_dev);
662 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
664 struct pci_driver *drv = pci_dev->driver;
665 bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
666 || drv->resume_early);
669 * Legacy PM support is used by default, so warn if the new framework is
670 * supported as well. Drivers are supposed to support either the
671 * former, or the latter, but not both at the same time.
673 WARN(ret && drv->driver.pm, "driver %s device %04x:%04x\n",
674 drv->name, pci_dev->vendor, pci_dev->device);
679 /* New power management framework */
681 static int pci_pm_prepare(struct device *dev)
683 struct device_driver *drv = dev->driver;
686 * Devices having power.ignore_children set may still be necessary for
687 * suspending their children in the next phase of device suspend.
689 if (dev->power.ignore_children)
690 pm_runtime_resume(dev);
692 if (drv && drv->pm && drv->pm->prepare) {
693 int error = drv->pm->prepare(dev);
697 return pci_dev_keep_suspended(to_pci_dev(dev));
700 static void pci_pm_complete(struct device *dev)
702 struct pci_dev *pci_dev = to_pci_dev(dev);
704 pci_dev_complete_resume(pci_dev);
705 pm_generic_complete(dev);
707 /* Resume device if platform firmware has put it in reset-power-on */
708 if (dev->power.direct_complete && pm_resume_via_firmware()) {
709 pci_power_t pre_sleep_state = pci_dev->current_state;
711 pci_update_current_state(pci_dev, pci_dev->current_state);
712 if (pci_dev->current_state < pre_sleep_state)
713 pm_request_resume(dev);
717 #else /* !CONFIG_PM_SLEEP */
719 #define pci_pm_prepare NULL
720 #define pci_pm_complete NULL
722 #endif /* !CONFIG_PM_SLEEP */
724 #ifdef CONFIG_SUSPEND
726 static int pci_pm_suspend(struct device *dev)
728 struct pci_dev *pci_dev = to_pci_dev(dev);
729 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
731 if (pci_has_legacy_pm_support(pci_dev))
732 return pci_legacy_suspend(dev, PMSG_SUSPEND);
735 pci_pm_default_suspend(pci_dev);
740 * PCI devices suspended at run time need to be resumed at this point,
741 * because in general it is necessary to reconfigure them for system
742 * suspend. Namely, if the device is supposed to wake up the system
743 * from the sleep state, we may need to reconfigure it for this purpose.
744 * In turn, if the device is not supposed to wake up the system from the
745 * sleep state, we'll have to prevent it from signaling wake-up.
747 pm_runtime_resume(dev);
749 pci_dev->state_saved = false;
751 pci_power_t prev = pci_dev->current_state;
754 error = pm->suspend(dev);
755 suspend_report_result(pm->suspend, error);
759 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
760 && pci_dev->current_state != PCI_UNKNOWN) {
761 WARN_ONCE(pci_dev->current_state != prev,
762 "PCI PM: State of device not saved by %pF\n",
768 pci_fixup_device(pci_fixup_suspend, pci_dev);
773 static int pci_pm_suspend_noirq(struct device *dev)
775 struct pci_dev *pci_dev = to_pci_dev(dev);
776 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
778 if (pci_has_legacy_pm_support(pci_dev))
779 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
782 pci_save_state(pci_dev);
786 if (pm->suspend_noirq) {
787 pci_power_t prev = pci_dev->current_state;
790 error = pm->suspend_noirq(dev);
791 suspend_report_result(pm->suspend_noirq, error);
795 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
796 && pci_dev->current_state != PCI_UNKNOWN) {
797 WARN_ONCE(pci_dev->current_state != prev,
798 "PCI PM: State of device not saved by %pF\n",
804 if (!pci_dev->state_saved) {
805 pci_save_state(pci_dev);
806 if (pci_power_manageable(pci_dev))
807 pci_prepare_to_sleep(pci_dev);
810 pci_pm_set_unknown_state(pci_dev);
813 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
814 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
815 * hasn't been quiesced and tries to turn it off. If the controller
816 * is already in D3, this can hang or cause memory corruption.
818 * Since the value of the COMMAND register doesn't matter once the
819 * device has been suspended, we can safely set it to 0 here.
821 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
822 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
825 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
830 static int pci_pm_resume_noirq(struct device *dev)
832 struct pci_dev *pci_dev = to_pci_dev(dev);
833 struct device_driver *drv = dev->driver;
836 pci_pm_default_resume_early(pci_dev);
838 if (pci_has_legacy_pm_support(pci_dev))
839 return pci_legacy_resume_early(dev);
841 if (drv && drv->pm && drv->pm->resume_noirq)
842 error = drv->pm->resume_noirq(dev);
847 static int pci_pm_resume(struct device *dev)
849 struct pci_dev *pci_dev = to_pci_dev(dev);
850 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
854 * This is necessary for the suspend error path in which resume is
855 * called without restoring the standard config registers of the device.
857 if (pci_dev->state_saved)
858 pci_restore_standard_config(pci_dev);
860 if (pci_has_legacy_pm_support(pci_dev))
861 return pci_legacy_resume(dev);
863 pci_pm_default_resume(pci_dev);
867 error = pm->resume(dev);
869 pci_pm_reenable_device(pci_dev);
875 #else /* !CONFIG_SUSPEND */
877 #define pci_pm_suspend NULL
878 #define pci_pm_suspend_noirq NULL
879 #define pci_pm_resume NULL
880 #define pci_pm_resume_noirq NULL
882 #endif /* !CONFIG_SUSPEND */
884 #ifdef CONFIG_HIBERNATE_CALLBACKS
888 * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
889 * a hibernate transition
891 struct dev_pm_ops __weak pcibios_pm_ops;
893 static int pci_pm_freeze(struct device *dev)
895 struct pci_dev *pci_dev = to_pci_dev(dev);
896 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
898 if (pci_has_legacy_pm_support(pci_dev))
899 return pci_legacy_suspend(dev, PMSG_FREEZE);
902 pci_pm_default_suspend(pci_dev);
907 * This used to be done in pci_pm_prepare() for all devices and some
908 * drivers may depend on it, so do it here. Ideally, runtime-suspended
909 * devices should not be touched during freeze/thaw transitions,
912 pm_runtime_resume(dev);
914 pci_dev->state_saved = false;
918 error = pm->freeze(dev);
919 suspend_report_result(pm->freeze, error);
924 if (pcibios_pm_ops.freeze)
925 return pcibios_pm_ops.freeze(dev);
930 static int pci_pm_freeze_noirq(struct device *dev)
932 struct pci_dev *pci_dev = to_pci_dev(dev);
933 struct device_driver *drv = dev->driver;
935 if (pci_has_legacy_pm_support(pci_dev))
936 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
938 if (drv && drv->pm && drv->pm->freeze_noirq) {
941 error = drv->pm->freeze_noirq(dev);
942 suspend_report_result(drv->pm->freeze_noirq, error);
947 if (!pci_dev->state_saved)
948 pci_save_state(pci_dev);
950 pci_pm_set_unknown_state(pci_dev);
952 if (pcibios_pm_ops.freeze_noirq)
953 return pcibios_pm_ops.freeze_noirq(dev);
958 static int pci_pm_thaw_noirq(struct device *dev)
960 struct pci_dev *pci_dev = to_pci_dev(dev);
961 struct device_driver *drv = dev->driver;
964 if (pcibios_pm_ops.thaw_noirq) {
965 error = pcibios_pm_ops.thaw_noirq(dev);
971 * Both the legacy ->resume_early() and the new pm->thaw_noirq()
972 * callbacks assume the device has been returned to D0 and its
973 * config state has been restored.
975 * In addition, pci_restore_state() restores MSI-X state in MMIO
976 * space, which requires the device to be in D0, so return it to D0
977 * in case the driver's "freeze" callbacks put it into a low-power
980 pci_set_power_state(pci_dev, PCI_D0);
981 pci_restore_state(pci_dev);
983 if (pci_has_legacy_pm_support(pci_dev))
984 return pci_legacy_resume_early(dev);
986 if (drv && drv->pm && drv->pm->thaw_noirq)
987 error = drv->pm->thaw_noirq(dev);
992 static int pci_pm_thaw(struct device *dev)
994 struct pci_dev *pci_dev = to_pci_dev(dev);
995 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
998 if (pcibios_pm_ops.thaw) {
999 error = pcibios_pm_ops.thaw(dev);
1004 if (pci_has_legacy_pm_support(pci_dev))
1005 return pci_legacy_resume(dev);
1009 error = pm->thaw(dev);
1011 pci_pm_reenable_device(pci_dev);
1014 pci_dev->state_saved = false;
1019 static int pci_pm_poweroff(struct device *dev)
1021 struct pci_dev *pci_dev = to_pci_dev(dev);
1022 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1024 if (pci_has_legacy_pm_support(pci_dev))
1025 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1028 pci_pm_default_suspend(pci_dev);
1032 /* The reason to do that is the same as in pci_pm_suspend(). */
1033 pm_runtime_resume(dev);
1035 pci_dev->state_saved = false;
1039 error = pm->poweroff(dev);
1040 suspend_report_result(pm->poweroff, error);
1046 pci_fixup_device(pci_fixup_suspend, pci_dev);
1048 if (pcibios_pm_ops.poweroff)
1049 return pcibios_pm_ops.poweroff(dev);
1054 static int pci_pm_poweroff_noirq(struct device *dev)
1056 struct pci_dev *pci_dev = to_pci_dev(dev);
1057 struct device_driver *drv = dev->driver;
1059 if (pci_has_legacy_pm_support(to_pci_dev(dev)))
1060 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1062 if (!drv || !drv->pm) {
1063 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1067 if (drv->pm->poweroff_noirq) {
1070 error = drv->pm->poweroff_noirq(dev);
1071 suspend_report_result(drv->pm->poweroff_noirq, error);
1076 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1077 pci_prepare_to_sleep(pci_dev);
1080 * The reason for doing this here is the same as for the analogous code
1081 * in pci_pm_suspend_noirq().
1083 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1084 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1086 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1088 if (pcibios_pm_ops.poweroff_noirq)
1089 return pcibios_pm_ops.poweroff_noirq(dev);
1094 static int pci_pm_restore_noirq(struct device *dev)
1096 struct pci_dev *pci_dev = to_pci_dev(dev);
1097 struct device_driver *drv = dev->driver;
1100 if (pcibios_pm_ops.restore_noirq) {
1101 error = pcibios_pm_ops.restore_noirq(dev);
1106 pci_pm_default_resume_early(pci_dev);
1108 if (pci_has_legacy_pm_support(pci_dev))
1109 return pci_legacy_resume_early(dev);
1111 if (drv && drv->pm && drv->pm->restore_noirq)
1112 error = drv->pm->restore_noirq(dev);
1117 static int pci_pm_restore(struct device *dev)
1119 struct pci_dev *pci_dev = to_pci_dev(dev);
1120 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1123 if (pcibios_pm_ops.restore) {
1124 error = pcibios_pm_ops.restore(dev);
1130 * This is necessary for the hibernation error path in which restore is
1131 * called without restoring the standard config registers of the device.
1133 if (pci_dev->state_saved)
1134 pci_restore_standard_config(pci_dev);
1136 if (pci_has_legacy_pm_support(pci_dev))
1137 return pci_legacy_resume(dev);
1139 pci_pm_default_resume(pci_dev);
1143 error = pm->restore(dev);
1145 pci_pm_reenable_device(pci_dev);
1151 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1153 #define pci_pm_freeze NULL
1154 #define pci_pm_freeze_noirq NULL
1155 #define pci_pm_thaw NULL
1156 #define pci_pm_thaw_noirq NULL
1157 #define pci_pm_poweroff NULL
1158 #define pci_pm_poweroff_noirq NULL
1159 #define pci_pm_restore NULL
1160 #define pci_pm_restore_noirq NULL
1162 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1166 static int pci_pm_runtime_suspend(struct device *dev)
1168 struct pci_dev *pci_dev = to_pci_dev(dev);
1169 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1170 pci_power_t prev = pci_dev->current_state;
1174 * If pci_dev->driver is not set (unbound), we leave the device in D0,
1175 * but it may go to D3cold when the bridge above it runtime suspends.
1176 * Save its config space in case that happens.
1178 if (!pci_dev->driver) {
1179 pci_save_state(pci_dev);
1183 if (!pm || !pm->runtime_suspend)
1186 pci_dev->state_saved = false;
1187 error = pm->runtime_suspend(dev);
1190 * -EBUSY and -EAGAIN is used to request the runtime PM core
1191 * to schedule a new suspend, so log the event only with debug
1194 if (error == -EBUSY || error == -EAGAIN)
1195 dev_dbg(dev, "can't suspend now (%pf returned %d)\n",
1196 pm->runtime_suspend, error);
1198 dev_err(dev, "can't suspend (%pf returned %d)\n",
1199 pm->runtime_suspend, error);
1204 pci_fixup_device(pci_fixup_suspend, pci_dev);
1206 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
1207 && pci_dev->current_state != PCI_UNKNOWN) {
1208 WARN_ONCE(pci_dev->current_state != prev,
1209 "PCI PM: State of device not saved by %pF\n",
1210 pm->runtime_suspend);
1214 if (!pci_dev->state_saved) {
1215 pci_save_state(pci_dev);
1216 pci_finish_runtime_suspend(pci_dev);
1222 static int pci_pm_runtime_resume(struct device *dev)
1225 struct pci_dev *pci_dev = to_pci_dev(dev);
1226 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1229 * Restoring config space is necessary even if the device is not bound
1230 * to a driver because although we left it in D0, it may have gone to
1231 * D3cold when the bridge above it runtime suspended.
1233 pci_restore_standard_config(pci_dev);
1235 if (!pci_dev->driver)
1238 if (!pm || !pm->runtime_resume)
1241 pci_fixup_device(pci_fixup_resume_early, pci_dev);
1242 pci_enable_wake(pci_dev, PCI_D0, false);
1243 pci_fixup_device(pci_fixup_resume, pci_dev);
1245 rc = pm->runtime_resume(dev);
1247 pci_dev->runtime_d3cold = false;
1252 static int pci_pm_runtime_idle(struct device *dev)
1254 struct pci_dev *pci_dev = to_pci_dev(dev);
1255 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1259 * If pci_dev->driver is not set (unbound), the device should
1260 * always remain in D0 regardless of the runtime PM status
1262 if (!pci_dev->driver)
1268 if (pm->runtime_idle)
1269 ret = pm->runtime_idle(dev);
1274 static const struct dev_pm_ops pci_dev_pm_ops = {
1275 .prepare = pci_pm_prepare,
1276 .complete = pci_pm_complete,
1277 .suspend = pci_pm_suspend,
1278 .resume = pci_pm_resume,
1279 .freeze = pci_pm_freeze,
1280 .thaw = pci_pm_thaw,
1281 .poweroff = pci_pm_poweroff,
1282 .restore = pci_pm_restore,
1283 .suspend_noirq = pci_pm_suspend_noirq,
1284 .resume_noirq = pci_pm_resume_noirq,
1285 .freeze_noirq = pci_pm_freeze_noirq,
1286 .thaw_noirq = pci_pm_thaw_noirq,
1287 .poweroff_noirq = pci_pm_poweroff_noirq,
1288 .restore_noirq = pci_pm_restore_noirq,
1289 .runtime_suspend = pci_pm_runtime_suspend,
1290 .runtime_resume = pci_pm_runtime_resume,
1291 .runtime_idle = pci_pm_runtime_idle,
1294 #define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
1296 #else /* !CONFIG_PM */
1298 #define pci_pm_runtime_suspend NULL
1299 #define pci_pm_runtime_resume NULL
1300 #define pci_pm_runtime_idle NULL
1302 #define PCI_PM_OPS_PTR NULL
1304 #endif /* !CONFIG_PM */
1307 * __pci_register_driver - register a new pci driver
1308 * @drv: the driver structure to register
1309 * @owner: owner module of drv
1310 * @mod_name: module name string
1312 * Adds the driver structure to the list of registered drivers.
1313 * Returns a negative value on error, otherwise 0.
1314 * If no error occurred, the driver remains registered even if
1315 * no device was claimed during registration.
1317 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1318 const char *mod_name)
1320 /* initialize common driver fields */
1321 drv->driver.name = drv->name;
1322 drv->driver.bus = &pci_bus_type;
1323 drv->driver.owner = owner;
1324 drv->driver.mod_name = mod_name;
1325 drv->driver.groups = drv->groups;
1327 spin_lock_init(&drv->dynids.lock);
1328 INIT_LIST_HEAD(&drv->dynids.list);
1330 /* register with core */
1331 return driver_register(&drv->driver);
1333 EXPORT_SYMBOL(__pci_register_driver);
1336 * pci_unregister_driver - unregister a pci driver
1337 * @drv: the driver structure to unregister
1339 * Deletes the driver structure from the list of registered PCI drivers,
1340 * gives it a chance to clean up by calling its remove() function for
1341 * each device it was responsible for, and marks those devices as
1345 void pci_unregister_driver(struct pci_driver *drv)
1347 driver_unregister(&drv->driver);
1348 pci_free_dynids(drv);
1350 EXPORT_SYMBOL(pci_unregister_driver);
1352 static struct pci_driver pci_compat_driver = {
1357 * pci_dev_driver - get the pci_driver of a device
1358 * @dev: the device to query
1360 * Returns the appropriate pci_driver structure or %NULL if there is no
1361 * registered driver for the device.
1363 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1369 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1370 if (dev->resource[i].flags & IORESOURCE_BUSY)
1371 return &pci_compat_driver;
1375 EXPORT_SYMBOL(pci_dev_driver);
1378 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1379 * @dev: the PCI device structure to match against
1380 * @drv: the device driver to search for matching PCI device id structures
1382 * Used by a driver to check whether a PCI device present in the
1383 * system is in its list of supported devices. Returns the matching
1384 * pci_device_id structure or %NULL if there is no match.
1386 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1388 struct pci_dev *pci_dev = to_pci_dev(dev);
1389 struct pci_driver *pci_drv;
1390 const struct pci_device_id *found_id;
1392 if (!pci_dev->match_driver)
1395 pci_drv = to_pci_driver(drv);
1396 found_id = pci_match_device(pci_drv, pci_dev);
1404 * pci_dev_get - increments the reference count of the pci device structure
1405 * @dev: the device being referenced
1407 * Each live reference to a device should be refcounted.
1409 * Drivers for PCI devices should normally record such references in
1410 * their probe() methods, when they bind to a device, and release
1411 * them by calling pci_dev_put(), in their disconnect() methods.
1413 * A pointer to the device with the incremented reference counter is returned.
1415 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1418 get_device(&dev->dev);
1421 EXPORT_SYMBOL(pci_dev_get);
1424 * pci_dev_put - release a use of the pci device structure
1425 * @dev: device that's been disconnected
1427 * Must be called when a user of a device is finished with it. When the last
1428 * user of the device calls this function, the memory of the device is freed.
1430 void pci_dev_put(struct pci_dev *dev)
1433 put_device(&dev->dev);
1435 EXPORT_SYMBOL(pci_dev_put);
1437 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1439 struct pci_dev *pdev;
1444 pdev = to_pci_dev(dev);
1446 if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1449 if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1452 if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1453 pdev->subsystem_device))
1456 if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1459 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1460 pdev->vendor, pdev->device,
1461 pdev->subsystem_vendor, pdev->subsystem_device,
1462 (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1469 static int pci_bus_num_vf(struct device *dev)
1471 return pci_num_vf(to_pci_dev(dev));
1474 struct bus_type pci_bus_type = {
1476 .match = pci_bus_match,
1477 .uevent = pci_uevent,
1478 .probe = pci_device_probe,
1479 .remove = pci_device_remove,
1480 .shutdown = pci_device_shutdown,
1481 .dev_groups = pci_dev_groups,
1482 .bus_groups = pci_bus_groups,
1483 .drv_groups = pci_drv_groups,
1484 .pm = PCI_PM_OPS_PTR,
1485 .num_vf = pci_bus_num_vf,
1487 EXPORT_SYMBOL(pci_bus_type);
1489 static int __init pci_driver_init(void)
1491 return bus_register(&pci_bus_type);
1493 postcore_initcall(pci_driver_init);