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 store_new_id(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(new_id, S_IWUSR, NULL, store_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 store_remove_id(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 int 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);
203 static DRIVER_ATTR(remove_id, S_IWUSR, NULL, store_remove_id);
205 static struct attribute *pci_drv_attrs[] = {
206 &driver_attr_new_id.attr,
207 &driver_attr_remove_id.attr,
210 ATTRIBUTE_GROUPS(pci_drv);
213 * pci_match_id - See if a pci device matches a given pci_id table
214 * @ids: array of PCI device id structures to search in
215 * @dev: the PCI device structure to match against.
217 * Used by a driver to check whether a PCI device present in the
218 * system is in its list of supported devices. Returns the matching
219 * pci_device_id structure or %NULL if there is no match.
221 * Deprecated, don't use this as it will not catch any dynamic ids
222 * that a driver might want to check for.
224 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
228 while (ids->vendor || ids->subvendor || ids->class_mask) {
229 if (pci_match_one_device(ids, dev))
236 EXPORT_SYMBOL(pci_match_id);
238 static const struct pci_device_id pci_device_id_any = {
239 .vendor = PCI_ANY_ID,
240 .device = PCI_ANY_ID,
241 .subvendor = PCI_ANY_ID,
242 .subdevice = PCI_ANY_ID,
246 * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
247 * @drv: the PCI driver to match against
248 * @dev: the PCI device structure to match against
250 * Used by a driver to check whether a PCI device present in the
251 * system is in its list of supported devices. Returns the matching
252 * pci_device_id structure or %NULL if there is no match.
254 static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
257 struct pci_dynid *dynid;
258 const struct pci_device_id *found_id = NULL;
260 /* When driver_override is set, only bind to the matching driver */
261 if (dev->driver_override && strcmp(dev->driver_override, drv->name))
264 /* Look at the dynamic ids first, before the static ones */
265 spin_lock(&drv->dynids.lock);
266 list_for_each_entry(dynid, &drv->dynids.list, node) {
267 if (pci_match_one_device(&dynid->id, dev)) {
268 found_id = &dynid->id;
272 spin_unlock(&drv->dynids.lock);
275 found_id = pci_match_id(drv->id_table, dev);
277 /* driver_override will always match, send a dummy id */
278 if (!found_id && dev->driver_override)
279 found_id = &pci_device_id_any;
284 struct drv_dev_and_id {
285 struct pci_driver *drv;
287 const struct pci_device_id *id;
290 static long local_pci_probe(void *_ddi)
292 struct drv_dev_and_id *ddi = _ddi;
293 struct pci_dev *pci_dev = ddi->dev;
294 struct pci_driver *pci_drv = ddi->drv;
295 struct device *dev = &pci_dev->dev;
299 * Unbound PCI devices are always put in D0, regardless of
300 * runtime PM status. During probe, the device is set to
301 * active and the usage count is incremented. If the driver
302 * supports runtime PM, it should call pm_runtime_put_noidle(),
303 * or any other runtime PM helper function decrementing the usage
304 * count, in its probe routine and pm_runtime_get_noresume() in
305 * its remove routine.
307 pm_runtime_get_sync(dev);
308 pci_dev->driver = pci_drv;
309 rc = pci_drv->probe(pci_dev, ddi->id);
313 pci_dev->driver = NULL;
314 pm_runtime_put_sync(dev);
318 * Probe function should return < 0 for failure, 0 for success
319 * Treat values > 0 as success, but warn.
321 dev_warn(dev, "Driver probe function unexpectedly returned %d\n", rc);
325 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
326 const struct pci_device_id *id)
329 struct drv_dev_and_id ddi = { drv, dev, id };
332 * Execute driver initialization on node where the device is
333 * attached. This way the driver likely allocates its local memory
336 node = dev_to_node(&dev->dev);
339 * On NUMA systems, we are likely to call a PF probe function using
340 * work_on_cpu(). If that probe calls pci_enable_sriov() (which
341 * adds the VF devices via pci_bus_add_device()), we may re-enter
342 * this function to call the VF probe function. Calling
343 * work_on_cpu() again will cause a lockdep warning. Since VFs are
344 * always on the same node as the PF, we can work around this by
345 * avoiding work_on_cpu() when we're already on the correct node.
347 * Preemption is enabled, so it's theoretically unsafe to use
348 * numa_node_id(), but even if we run the probe function on the
349 * wrong node, it should be functionally correct.
351 if (node >= 0 && node != numa_node_id()) {
355 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
356 if (cpu < nr_cpu_ids)
357 error = work_on_cpu(cpu, local_pci_probe, &ddi);
359 error = local_pci_probe(&ddi);
362 error = local_pci_probe(&ddi);
368 * __pci_device_probe - check if a driver wants to claim a specific PCI device
369 * @drv: driver to call to check if it wants the PCI device
370 * @pci_dev: PCI device being probed
372 * returns 0 on success, else error.
373 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
375 static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
377 const struct pci_device_id *id;
380 if (!pci_dev->driver && drv->probe) {
383 id = pci_match_device(drv, pci_dev);
385 error = pci_call_probe(drv, pci_dev, id);
392 int __weak pcibios_alloc_irq(struct pci_dev *dev)
397 void __weak pcibios_free_irq(struct pci_dev *dev)
401 static int pci_device_probe(struct device *dev)
404 struct pci_dev *pci_dev = to_pci_dev(dev);
405 struct pci_driver *drv = to_pci_driver(dev->driver);
407 error = pcibios_alloc_irq(pci_dev);
411 pci_dev_get(pci_dev);
412 error = __pci_device_probe(drv, pci_dev);
414 pcibios_free_irq(pci_dev);
415 pci_dev_put(pci_dev);
421 static int pci_device_remove(struct device *dev)
423 struct pci_dev *pci_dev = to_pci_dev(dev);
424 struct pci_driver *drv = pci_dev->driver;
428 pm_runtime_get_sync(dev);
429 drv->remove(pci_dev);
430 pm_runtime_put_noidle(dev);
432 pcibios_free_irq(pci_dev);
433 pci_dev->driver = NULL;
436 /* Undo the runtime PM settings in local_pci_probe() */
437 pm_runtime_put_sync(dev);
440 * If the device is still on, set the power state as "unknown",
441 * since it might change by the next time we load the driver.
443 if (pci_dev->current_state == PCI_D0)
444 pci_dev->current_state = PCI_UNKNOWN;
447 * We would love to complain here if pci_dev->is_enabled is set, that
448 * the driver should have called pci_disable_device(), but the
449 * unfortunate fact is there are too many odd BIOS and bridge setups
450 * that don't like drivers doing that all of the time.
451 * Oh well, we can dream of sane hardware when we sleep, no matter how
452 * horrible the crap we have to deal with is when we are awake...
455 pci_dev_put(pci_dev);
459 static void pci_device_shutdown(struct device *dev)
461 struct pci_dev *pci_dev = to_pci_dev(dev);
462 struct pci_driver *drv = pci_dev->driver;
464 pm_runtime_resume(dev);
466 if (drv && drv->shutdown)
467 drv->shutdown(pci_dev);
468 pci_msi_shutdown(pci_dev);
469 pci_msix_shutdown(pci_dev);
471 #ifdef CONFIG_KEXEC_CORE
473 * If this is a kexec reboot, turn off Bus Master bit on the
474 * device to tell it to not continue to do DMA. Don't touch
475 * devices in D3cold or unknown states.
476 * If it is not a kexec reboot, firmware will hit the PCI
477 * devices with big hammer and stop their DMA any way.
479 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
480 pci_clear_master(pci_dev);
486 /* Auxiliary functions used for system resume and run-time resume. */
489 * pci_restore_standard_config - restore standard config registers of PCI device
490 * @pci_dev: PCI device to handle
492 static int pci_restore_standard_config(struct pci_dev *pci_dev)
494 pci_update_current_state(pci_dev, PCI_UNKNOWN);
496 if (pci_dev->current_state != PCI_D0) {
497 int error = pci_set_power_state(pci_dev, PCI_D0);
502 pci_restore_state(pci_dev);
508 #ifdef CONFIG_PM_SLEEP
510 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
512 pci_power_up(pci_dev);
513 pci_restore_state(pci_dev);
514 pci_fixup_device(pci_fixup_resume_early, pci_dev);
518 * Default "suspend" method for devices that have no driver provided suspend,
519 * or not even a driver at all (second part).
521 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
524 * mark its power state as "unknown", since we don't know if
525 * e.g. the BIOS will change its device state when we suspend.
527 if (pci_dev->current_state == PCI_D0)
528 pci_dev->current_state = PCI_UNKNOWN;
532 * Default "resume" method for devices that have no driver provided resume,
533 * or not even a driver at all (second part).
535 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
539 /* if the device was enabled before suspend, reenable */
540 retval = pci_reenable_device(pci_dev);
542 * if the device was busmaster before the suspend, make it busmaster
545 if (pci_dev->is_busmaster)
546 pci_set_master(pci_dev);
551 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
553 struct pci_dev *pci_dev = to_pci_dev(dev);
554 struct pci_driver *drv = pci_dev->driver;
556 if (drv && drv->suspend) {
557 pci_power_t prev = pci_dev->current_state;
560 error = drv->suspend(pci_dev, state);
561 suspend_report_result(drv->suspend, error);
565 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
566 && pci_dev->current_state != PCI_UNKNOWN) {
567 WARN_ONCE(pci_dev->current_state != prev,
568 "PCI PM: Device state not saved by %pF\n",
573 pci_fixup_device(pci_fixup_suspend, pci_dev);
578 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
580 struct pci_dev *pci_dev = to_pci_dev(dev);
581 struct pci_driver *drv = pci_dev->driver;
583 if (drv && drv->suspend_late) {
584 pci_power_t prev = pci_dev->current_state;
587 error = drv->suspend_late(pci_dev, state);
588 suspend_report_result(drv->suspend_late, error);
592 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
593 && pci_dev->current_state != PCI_UNKNOWN) {
594 WARN_ONCE(pci_dev->current_state != prev,
595 "PCI PM: Device state not saved by %pF\n",
601 if (!pci_dev->state_saved)
602 pci_save_state(pci_dev);
604 pci_pm_set_unknown_state(pci_dev);
607 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
612 static int pci_legacy_resume_early(struct device *dev)
614 struct pci_dev *pci_dev = to_pci_dev(dev);
615 struct pci_driver *drv = pci_dev->driver;
617 return drv && drv->resume_early ?
618 drv->resume_early(pci_dev) : 0;
621 static int pci_legacy_resume(struct device *dev)
623 struct pci_dev *pci_dev = to_pci_dev(dev);
624 struct pci_driver *drv = pci_dev->driver;
626 pci_fixup_device(pci_fixup_resume, pci_dev);
628 return drv && drv->resume ?
629 drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
632 /* Auxiliary functions used by the new power management framework */
634 static void pci_pm_default_resume(struct pci_dev *pci_dev)
636 pci_fixup_device(pci_fixup_resume, pci_dev);
638 if (!pci_has_subordinate(pci_dev))
639 pci_enable_wake(pci_dev, PCI_D0, false);
642 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
644 /* Disable non-bridge devices without PM support */
645 if (!pci_has_subordinate(pci_dev))
646 pci_disable_enabled_device(pci_dev);
649 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
651 struct pci_driver *drv = pci_dev->driver;
652 bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
653 || drv->resume_early);
656 * Legacy PM support is used by default, so warn if the new framework is
657 * supported as well. Drivers are supposed to support either the
658 * former, or the latter, but not both at the same time.
660 WARN(ret && drv->driver.pm, "driver %s device %04x:%04x\n",
661 drv->name, pci_dev->vendor, pci_dev->device);
666 /* New power management framework */
668 static int pci_pm_prepare(struct device *dev)
670 struct device_driver *drv = dev->driver;
673 * Devices having power.ignore_children set may still be necessary for
674 * suspending their children in the next phase of device suspend.
676 if (dev->power.ignore_children)
677 pm_runtime_resume(dev);
679 if (drv && drv->pm && drv->pm->prepare) {
680 int error = drv->pm->prepare(dev);
684 return pci_dev_keep_suspended(to_pci_dev(dev));
687 static void pci_pm_complete(struct device *dev)
689 pci_dev_complete_resume(to_pci_dev(dev));
690 pm_complete_with_resume_check(dev);
693 #else /* !CONFIG_PM_SLEEP */
695 #define pci_pm_prepare NULL
696 #define pci_pm_complete NULL
698 #endif /* !CONFIG_PM_SLEEP */
700 #ifdef CONFIG_SUSPEND
702 static int pci_pm_suspend(struct device *dev)
704 struct pci_dev *pci_dev = to_pci_dev(dev);
705 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
707 if (pci_has_legacy_pm_support(pci_dev))
708 return pci_legacy_suspend(dev, PMSG_SUSPEND);
711 pci_pm_default_suspend(pci_dev);
716 * PCI devices suspended at run time need to be resumed at this point,
717 * because in general it is necessary to reconfigure them for system
718 * suspend. Namely, if the device is supposed to wake up the system
719 * from the sleep state, we may need to reconfigure it for this purpose.
720 * In turn, if the device is not supposed to wake up the system from the
721 * sleep state, we'll have to prevent it from signaling wake-up.
723 pm_runtime_resume(dev);
725 pci_dev->state_saved = false;
727 pci_power_t prev = pci_dev->current_state;
730 error = pm->suspend(dev);
731 suspend_report_result(pm->suspend, error);
735 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
736 && pci_dev->current_state != PCI_UNKNOWN) {
737 WARN_ONCE(pci_dev->current_state != prev,
738 "PCI PM: State of device not saved by %pF\n",
744 pci_fixup_device(pci_fixup_suspend, pci_dev);
749 static int pci_pm_suspend_noirq(struct device *dev)
751 struct pci_dev *pci_dev = to_pci_dev(dev);
752 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
754 if (pci_has_legacy_pm_support(pci_dev))
755 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
758 pci_save_state(pci_dev);
762 if (pm->suspend_noirq) {
763 pci_power_t prev = pci_dev->current_state;
766 error = pm->suspend_noirq(dev);
767 suspend_report_result(pm->suspend_noirq, error);
771 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
772 && pci_dev->current_state != PCI_UNKNOWN) {
773 WARN_ONCE(pci_dev->current_state != prev,
774 "PCI PM: State of device not saved by %pF\n",
780 if (!pci_dev->state_saved) {
781 pci_save_state(pci_dev);
782 if (!pci_has_subordinate(pci_dev))
783 pci_prepare_to_sleep(pci_dev);
786 pci_pm_set_unknown_state(pci_dev);
789 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
790 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
791 * hasn't been quiesced and tries to turn it off. If the controller
792 * is already in D3, this can hang or cause memory corruption.
794 * Since the value of the COMMAND register doesn't matter once the
795 * device has been suspended, we can safely set it to 0 here.
797 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
798 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
801 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
806 static int pci_pm_resume_noirq(struct device *dev)
808 struct pci_dev *pci_dev = to_pci_dev(dev);
809 struct device_driver *drv = dev->driver;
812 pci_pm_default_resume_early(pci_dev);
814 if (pci_has_legacy_pm_support(pci_dev))
815 return pci_legacy_resume_early(dev);
817 if (drv && drv->pm && drv->pm->resume_noirq)
818 error = drv->pm->resume_noirq(dev);
823 static int pci_pm_resume(struct device *dev)
825 struct pci_dev *pci_dev = to_pci_dev(dev);
826 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
830 * This is necessary for the suspend error path in which resume is
831 * called without restoring the standard config registers of the device.
833 if (pci_dev->state_saved)
834 pci_restore_standard_config(pci_dev);
836 if (pci_has_legacy_pm_support(pci_dev))
837 return pci_legacy_resume(dev);
839 pci_pm_default_resume(pci_dev);
843 error = pm->resume(dev);
845 pci_pm_reenable_device(pci_dev);
851 #else /* !CONFIG_SUSPEND */
853 #define pci_pm_suspend NULL
854 #define pci_pm_suspend_noirq NULL
855 #define pci_pm_resume NULL
856 #define pci_pm_resume_noirq NULL
858 #endif /* !CONFIG_SUSPEND */
860 #ifdef CONFIG_HIBERNATE_CALLBACKS
864 * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
865 * a hibernate transition
867 struct dev_pm_ops __weak pcibios_pm_ops;
869 static int pci_pm_freeze(struct device *dev)
871 struct pci_dev *pci_dev = to_pci_dev(dev);
872 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
874 if (pci_has_legacy_pm_support(pci_dev))
875 return pci_legacy_suspend(dev, PMSG_FREEZE);
878 pci_pm_default_suspend(pci_dev);
883 * This used to be done in pci_pm_prepare() for all devices and some
884 * drivers may depend on it, so do it here. Ideally, runtime-suspended
885 * devices should not be touched during freeze/thaw transitions,
888 pm_runtime_resume(dev);
890 pci_dev->state_saved = false;
894 error = pm->freeze(dev);
895 suspend_report_result(pm->freeze, error);
900 if (pcibios_pm_ops.freeze)
901 return pcibios_pm_ops.freeze(dev);
906 static int pci_pm_freeze_noirq(struct device *dev)
908 struct pci_dev *pci_dev = to_pci_dev(dev);
909 struct device_driver *drv = dev->driver;
911 if (pci_has_legacy_pm_support(pci_dev))
912 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
914 if (drv && drv->pm && drv->pm->freeze_noirq) {
917 error = drv->pm->freeze_noirq(dev);
918 suspend_report_result(drv->pm->freeze_noirq, error);
923 if (!pci_dev->state_saved)
924 pci_save_state(pci_dev);
926 pci_pm_set_unknown_state(pci_dev);
928 if (pcibios_pm_ops.freeze_noirq)
929 return pcibios_pm_ops.freeze_noirq(dev);
934 static int pci_pm_thaw_noirq(struct device *dev)
936 struct pci_dev *pci_dev = to_pci_dev(dev);
937 struct device_driver *drv = dev->driver;
940 if (pcibios_pm_ops.thaw_noirq) {
941 error = pcibios_pm_ops.thaw_noirq(dev);
946 if (pci_has_legacy_pm_support(pci_dev))
947 return pci_legacy_resume_early(dev);
949 pci_update_current_state(pci_dev, PCI_D0);
951 if (drv && drv->pm && drv->pm->thaw_noirq)
952 error = drv->pm->thaw_noirq(dev);
957 static int pci_pm_thaw(struct device *dev)
959 struct pci_dev *pci_dev = to_pci_dev(dev);
960 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
963 if (pcibios_pm_ops.thaw) {
964 error = pcibios_pm_ops.thaw(dev);
969 if (pci_has_legacy_pm_support(pci_dev))
970 return pci_legacy_resume(dev);
974 error = pm->thaw(dev);
976 pci_pm_reenable_device(pci_dev);
979 pci_dev->state_saved = false;
984 static int pci_pm_poweroff(struct device *dev)
986 struct pci_dev *pci_dev = to_pci_dev(dev);
987 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
989 if (pci_has_legacy_pm_support(pci_dev))
990 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
993 pci_pm_default_suspend(pci_dev);
997 /* The reason to do that is the same as in pci_pm_suspend(). */
998 pm_runtime_resume(dev);
1000 pci_dev->state_saved = false;
1004 error = pm->poweroff(dev);
1005 suspend_report_result(pm->poweroff, error);
1011 pci_fixup_device(pci_fixup_suspend, pci_dev);
1013 if (pcibios_pm_ops.poweroff)
1014 return pcibios_pm_ops.poweroff(dev);
1019 static int pci_pm_poweroff_noirq(struct device *dev)
1021 struct pci_dev *pci_dev = to_pci_dev(dev);
1022 struct device_driver *drv = dev->driver;
1024 if (pci_has_legacy_pm_support(to_pci_dev(dev)))
1025 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1027 if (!drv || !drv->pm) {
1028 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1032 if (drv->pm->poweroff_noirq) {
1035 error = drv->pm->poweroff_noirq(dev);
1036 suspend_report_result(drv->pm->poweroff_noirq, error);
1041 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1042 pci_prepare_to_sleep(pci_dev);
1045 * The reason for doing this here is the same as for the analogous code
1046 * in pci_pm_suspend_noirq().
1048 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1049 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1051 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1053 if (pcibios_pm_ops.poweroff_noirq)
1054 return pcibios_pm_ops.poweroff_noirq(dev);
1059 static int pci_pm_restore_noirq(struct device *dev)
1061 struct pci_dev *pci_dev = to_pci_dev(dev);
1062 struct device_driver *drv = dev->driver;
1065 if (pcibios_pm_ops.restore_noirq) {
1066 error = pcibios_pm_ops.restore_noirq(dev);
1071 pci_pm_default_resume_early(pci_dev);
1073 if (pci_has_legacy_pm_support(pci_dev))
1074 return pci_legacy_resume_early(dev);
1076 if (drv && drv->pm && drv->pm->restore_noirq)
1077 error = drv->pm->restore_noirq(dev);
1082 static int pci_pm_restore(struct device *dev)
1084 struct pci_dev *pci_dev = to_pci_dev(dev);
1085 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1088 if (pcibios_pm_ops.restore) {
1089 error = pcibios_pm_ops.restore(dev);
1095 * This is necessary for the hibernation error path in which restore is
1096 * called without restoring the standard config registers of the device.
1098 if (pci_dev->state_saved)
1099 pci_restore_standard_config(pci_dev);
1101 if (pci_has_legacy_pm_support(pci_dev))
1102 return pci_legacy_resume(dev);
1104 pci_pm_default_resume(pci_dev);
1108 error = pm->restore(dev);
1110 pci_pm_reenable_device(pci_dev);
1116 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1118 #define pci_pm_freeze NULL
1119 #define pci_pm_freeze_noirq NULL
1120 #define pci_pm_thaw NULL
1121 #define pci_pm_thaw_noirq NULL
1122 #define pci_pm_poweroff NULL
1123 #define pci_pm_poweroff_noirq NULL
1124 #define pci_pm_restore NULL
1125 #define pci_pm_restore_noirq NULL
1127 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1131 static int pci_pm_runtime_suspend(struct device *dev)
1133 struct pci_dev *pci_dev = to_pci_dev(dev);
1134 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1135 pci_power_t prev = pci_dev->current_state;
1139 * If pci_dev->driver is not set (unbound), the device should
1140 * always remain in D0 regardless of the runtime PM status
1142 if (!pci_dev->driver)
1145 if (!pm || !pm->runtime_suspend)
1148 pci_dev->state_saved = false;
1149 pci_dev->no_d3cold = false;
1150 error = pm->runtime_suspend(dev);
1151 suspend_report_result(pm->runtime_suspend, error);
1154 if (!pci_dev->d3cold_allowed)
1155 pci_dev->no_d3cold = true;
1157 pci_fixup_device(pci_fixup_suspend, pci_dev);
1159 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
1160 && pci_dev->current_state != PCI_UNKNOWN) {
1161 WARN_ONCE(pci_dev->current_state != prev,
1162 "PCI PM: State of device not saved by %pF\n",
1163 pm->runtime_suspend);
1167 if (!pci_dev->state_saved) {
1168 pci_save_state(pci_dev);
1169 pci_finish_runtime_suspend(pci_dev);
1175 static int pci_pm_runtime_resume(struct device *dev)
1178 struct pci_dev *pci_dev = to_pci_dev(dev);
1179 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1182 * If pci_dev->driver is not set (unbound), the device should
1183 * always remain in D0 regardless of the runtime PM status
1185 if (!pci_dev->driver)
1188 if (!pm || !pm->runtime_resume)
1191 pci_restore_standard_config(pci_dev);
1192 pci_fixup_device(pci_fixup_resume_early, pci_dev);
1193 __pci_enable_wake(pci_dev, PCI_D0, true, false);
1194 pci_fixup_device(pci_fixup_resume, pci_dev);
1196 rc = pm->runtime_resume(dev);
1198 pci_dev->runtime_d3cold = false;
1203 static int pci_pm_runtime_idle(struct device *dev)
1205 struct pci_dev *pci_dev = to_pci_dev(dev);
1206 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1210 * If pci_dev->driver is not set (unbound), the device should
1211 * always remain in D0 regardless of the runtime PM status
1213 if (!pci_dev->driver)
1219 if (pm->runtime_idle)
1220 ret = pm->runtime_idle(dev);
1225 static const struct dev_pm_ops pci_dev_pm_ops = {
1226 .prepare = pci_pm_prepare,
1227 .complete = pci_pm_complete,
1228 .suspend = pci_pm_suspend,
1229 .resume = pci_pm_resume,
1230 .freeze = pci_pm_freeze,
1231 .thaw = pci_pm_thaw,
1232 .poweroff = pci_pm_poweroff,
1233 .restore = pci_pm_restore,
1234 .suspend_noirq = pci_pm_suspend_noirq,
1235 .resume_noirq = pci_pm_resume_noirq,
1236 .freeze_noirq = pci_pm_freeze_noirq,
1237 .thaw_noirq = pci_pm_thaw_noirq,
1238 .poweroff_noirq = pci_pm_poweroff_noirq,
1239 .restore_noirq = pci_pm_restore_noirq,
1240 .runtime_suspend = pci_pm_runtime_suspend,
1241 .runtime_resume = pci_pm_runtime_resume,
1242 .runtime_idle = pci_pm_runtime_idle,
1245 #define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
1247 #else /* !CONFIG_PM */
1249 #define pci_pm_runtime_suspend NULL
1250 #define pci_pm_runtime_resume NULL
1251 #define pci_pm_runtime_idle NULL
1253 #define PCI_PM_OPS_PTR NULL
1255 #endif /* !CONFIG_PM */
1258 * __pci_register_driver - register a new pci driver
1259 * @drv: the driver structure to register
1260 * @owner: owner module of drv
1261 * @mod_name: module name string
1263 * Adds the driver structure to the list of registered drivers.
1264 * Returns a negative value on error, otherwise 0.
1265 * If no error occurred, the driver remains registered even if
1266 * no device was claimed during registration.
1268 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1269 const char *mod_name)
1271 /* initialize common driver fields */
1272 drv->driver.name = drv->name;
1273 drv->driver.bus = &pci_bus_type;
1274 drv->driver.owner = owner;
1275 drv->driver.mod_name = mod_name;
1277 spin_lock_init(&drv->dynids.lock);
1278 INIT_LIST_HEAD(&drv->dynids.list);
1280 /* register with core */
1281 return driver_register(&drv->driver);
1283 EXPORT_SYMBOL(__pci_register_driver);
1286 * pci_unregister_driver - unregister a pci driver
1287 * @drv: the driver structure to unregister
1289 * Deletes the driver structure from the list of registered PCI drivers,
1290 * gives it a chance to clean up by calling its remove() function for
1291 * each device it was responsible for, and marks those devices as
1295 void pci_unregister_driver(struct pci_driver *drv)
1297 driver_unregister(&drv->driver);
1298 pci_free_dynids(drv);
1300 EXPORT_SYMBOL(pci_unregister_driver);
1302 static struct pci_driver pci_compat_driver = {
1307 * pci_dev_driver - get the pci_driver of a device
1308 * @dev: the device to query
1310 * Returns the appropriate pci_driver structure or %NULL if there is no
1311 * registered driver for the device.
1313 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1319 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1320 if (dev->resource[i].flags & IORESOURCE_BUSY)
1321 return &pci_compat_driver;
1325 EXPORT_SYMBOL(pci_dev_driver);
1328 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1329 * @dev: the PCI device structure to match against
1330 * @drv: the device driver to search for matching PCI device id structures
1332 * Used by a driver to check whether a PCI device present in the
1333 * system is in its list of supported devices. Returns the matching
1334 * pci_device_id structure or %NULL if there is no match.
1336 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1338 struct pci_dev *pci_dev = to_pci_dev(dev);
1339 struct pci_driver *pci_drv;
1340 const struct pci_device_id *found_id;
1342 if (!pci_dev->match_driver)
1345 pci_drv = to_pci_driver(drv);
1346 found_id = pci_match_device(pci_drv, pci_dev);
1354 * pci_dev_get - increments the reference count of the pci device structure
1355 * @dev: the device being referenced
1357 * Each live reference to a device should be refcounted.
1359 * Drivers for PCI devices should normally record such references in
1360 * their probe() methods, when they bind to a device, and release
1361 * them by calling pci_dev_put(), in their disconnect() methods.
1363 * A pointer to the device with the incremented reference counter is returned.
1365 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1368 get_device(&dev->dev);
1371 EXPORT_SYMBOL(pci_dev_get);
1374 * pci_dev_put - release a use of the pci device structure
1375 * @dev: device that's been disconnected
1377 * Must be called when a user of a device is finished with it. When the last
1378 * user of the device calls this function, the memory of the device is freed.
1380 void pci_dev_put(struct pci_dev *dev)
1383 put_device(&dev->dev);
1385 EXPORT_SYMBOL(pci_dev_put);
1387 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1389 struct pci_dev *pdev;
1394 pdev = to_pci_dev(dev);
1396 if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1399 if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1402 if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1403 pdev->subsystem_device))
1406 if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1409 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1410 pdev->vendor, pdev->device,
1411 pdev->subsystem_vendor, pdev->subsystem_device,
1412 (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1419 struct bus_type pci_bus_type = {
1421 .match = pci_bus_match,
1422 .uevent = pci_uevent,
1423 .probe = pci_device_probe,
1424 .remove = pci_device_remove,
1425 .shutdown = pci_device_shutdown,
1426 .dev_groups = pci_dev_groups,
1427 .bus_groups = pci_bus_groups,
1428 .drv_groups = pci_drv_groups,
1429 .pm = PCI_PM_OPS_PTR,
1431 EXPORT_SYMBOL(pci_bus_type);
1433 static int __init pci_driver_init(void)
1435 return bus_register(&pci_bus_type);
1437 postcore_initcall(pci_driver_init);