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);
406 static inline bool pci_device_can_probe(struct pci_dev *pdev)
412 static int pci_device_probe(struct device *dev)
415 struct pci_dev *pci_dev = to_pci_dev(dev);
416 struct pci_driver *drv = to_pci_driver(dev->driver);
418 error = pcibios_alloc_irq(pci_dev);
422 pci_dev_get(pci_dev);
423 if (pci_device_can_probe(pci_dev)) {
424 error = __pci_device_probe(drv, pci_dev);
426 pcibios_free_irq(pci_dev);
427 pci_dev_put(pci_dev);
434 static int pci_device_remove(struct device *dev)
436 struct pci_dev *pci_dev = to_pci_dev(dev);
437 struct pci_driver *drv = pci_dev->driver;
441 pm_runtime_get_sync(dev);
442 drv->remove(pci_dev);
443 pm_runtime_put_noidle(dev);
445 pcibios_free_irq(pci_dev);
446 pci_dev->driver = NULL;
449 /* Undo the runtime PM settings in local_pci_probe() */
450 pm_runtime_put_sync(dev);
453 * If the device is still on, set the power state as "unknown",
454 * since it might change by the next time we load the driver.
456 if (pci_dev->current_state == PCI_D0)
457 pci_dev->current_state = PCI_UNKNOWN;
460 * We would love to complain here if pci_dev->is_enabled is set, that
461 * the driver should have called pci_disable_device(), but the
462 * unfortunate fact is there are too many odd BIOS and bridge setups
463 * that don't like drivers doing that all of the time.
464 * Oh well, we can dream of sane hardware when we sleep, no matter how
465 * horrible the crap we have to deal with is when we are awake...
468 pci_dev_put(pci_dev);
472 static void pci_device_shutdown(struct device *dev)
474 struct pci_dev *pci_dev = to_pci_dev(dev);
475 struct pci_driver *drv = pci_dev->driver;
477 pm_runtime_resume(dev);
479 if (drv && drv->shutdown)
480 drv->shutdown(pci_dev);
483 * If this is a kexec reboot, turn off Bus Master bit on the
484 * device to tell it to not continue to do DMA. Don't touch
485 * devices in D3cold or unknown states.
486 * If it is not a kexec reboot, firmware will hit the PCI
487 * devices with big hammer and stop their DMA any way.
489 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
490 pci_clear_master(pci_dev);
495 /* Auxiliary functions used for system resume and run-time resume. */
498 * pci_restore_standard_config - restore standard config registers of PCI device
499 * @pci_dev: PCI device to handle
501 static int pci_restore_standard_config(struct pci_dev *pci_dev)
503 pci_update_current_state(pci_dev, PCI_UNKNOWN);
505 if (pci_dev->current_state != PCI_D0) {
506 int error = pci_set_power_state(pci_dev, PCI_D0);
511 pci_restore_state(pci_dev);
517 #ifdef CONFIG_PM_SLEEP
519 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
521 pci_power_up(pci_dev);
522 pci_restore_state(pci_dev);
523 pci_fixup_device(pci_fixup_resume_early, pci_dev);
527 * Default "suspend" method for devices that have no driver provided suspend,
528 * or not even a driver at all (second part).
530 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
533 * mark its power state as "unknown", since we don't know if
534 * e.g. the BIOS will change its device state when we suspend.
536 if (pci_dev->current_state == PCI_D0)
537 pci_dev->current_state = PCI_UNKNOWN;
541 * Default "resume" method for devices that have no driver provided resume,
542 * or not even a driver at all (second part).
544 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
548 /* if the device was enabled before suspend, reenable */
549 retval = pci_reenable_device(pci_dev);
551 * if the device was busmaster before the suspend, make it busmaster
554 if (pci_dev->is_busmaster)
555 pci_set_master(pci_dev);
560 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
562 struct pci_dev *pci_dev = to_pci_dev(dev);
563 struct pci_driver *drv = pci_dev->driver;
565 if (drv && drv->suspend) {
566 pci_power_t prev = pci_dev->current_state;
569 error = drv->suspend(pci_dev, state);
570 suspend_report_result(drv->suspend, error);
574 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
575 && pci_dev->current_state != PCI_UNKNOWN) {
576 WARN_ONCE(pci_dev->current_state != prev,
577 "PCI PM: Device state not saved by %pF\n",
582 pci_fixup_device(pci_fixup_suspend, pci_dev);
587 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
589 struct pci_dev *pci_dev = to_pci_dev(dev);
590 struct pci_driver *drv = pci_dev->driver;
592 if (drv && drv->suspend_late) {
593 pci_power_t prev = pci_dev->current_state;
596 error = drv->suspend_late(pci_dev, state);
597 suspend_report_result(drv->suspend_late, error);
601 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
602 && pci_dev->current_state != PCI_UNKNOWN) {
603 WARN_ONCE(pci_dev->current_state != prev,
604 "PCI PM: Device state not saved by %pF\n",
610 if (!pci_dev->state_saved)
611 pci_save_state(pci_dev);
613 pci_pm_set_unknown_state(pci_dev);
616 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
621 static int pci_legacy_resume_early(struct device *dev)
623 struct pci_dev *pci_dev = to_pci_dev(dev);
624 struct pci_driver *drv = pci_dev->driver;
626 return drv && drv->resume_early ?
627 drv->resume_early(pci_dev) : 0;
630 static int pci_legacy_resume(struct device *dev)
632 struct pci_dev *pci_dev = to_pci_dev(dev);
633 struct pci_driver *drv = pci_dev->driver;
635 pci_fixup_device(pci_fixup_resume, pci_dev);
637 return drv && drv->resume ?
638 drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
641 /* Auxiliary functions used by the new power management framework */
643 static void pci_pm_default_resume(struct pci_dev *pci_dev)
645 pci_fixup_device(pci_fixup_resume, pci_dev);
647 if (!pci_has_subordinate(pci_dev))
648 pci_enable_wake(pci_dev, PCI_D0, false);
651 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
653 /* Disable non-bridge devices without PM support */
654 if (!pci_has_subordinate(pci_dev))
655 pci_disable_enabled_device(pci_dev);
658 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
660 struct pci_driver *drv = pci_dev->driver;
661 bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
662 || drv->resume_early);
665 * Legacy PM support is used by default, so warn if the new framework is
666 * supported as well. Drivers are supposed to support either the
667 * former, or the latter, but not both at the same time.
669 WARN(ret && drv->driver.pm, "driver %s device %04x:%04x\n",
670 drv->name, pci_dev->vendor, pci_dev->device);
675 /* New power management framework */
677 static int pci_pm_prepare(struct device *dev)
679 struct device_driver *drv = dev->driver;
682 * Devices having power.ignore_children set may still be necessary for
683 * suspending their children in the next phase of device suspend.
685 if (dev->power.ignore_children)
686 pm_runtime_resume(dev);
688 if (drv && drv->pm && drv->pm->prepare) {
689 int error = drv->pm->prepare(dev);
693 return pci_dev_keep_suspended(to_pci_dev(dev));
696 static void pci_pm_complete(struct device *dev)
698 struct pci_dev *pci_dev = to_pci_dev(dev);
700 pci_dev_complete_resume(pci_dev);
701 pm_generic_complete(dev);
703 /* Resume device if platform firmware has put it in reset-power-on */
704 if (dev->power.direct_complete && pm_resume_via_firmware()) {
705 pci_power_t pre_sleep_state = pci_dev->current_state;
707 pci_update_current_state(pci_dev, pci_dev->current_state);
708 if (pci_dev->current_state < pre_sleep_state)
709 pm_request_resume(dev);
713 #else /* !CONFIG_PM_SLEEP */
715 #define pci_pm_prepare NULL
716 #define pci_pm_complete NULL
718 #endif /* !CONFIG_PM_SLEEP */
720 #ifdef CONFIG_SUSPEND
722 static int pci_pm_suspend(struct device *dev)
724 struct pci_dev *pci_dev = to_pci_dev(dev);
725 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
727 if (pci_has_legacy_pm_support(pci_dev))
728 return pci_legacy_suspend(dev, PMSG_SUSPEND);
731 pci_pm_default_suspend(pci_dev);
736 * PCI devices suspended at run time need to be resumed at this point,
737 * because in general it is necessary to reconfigure them for system
738 * suspend. Namely, if the device is supposed to wake up the system
739 * from the sleep state, we may need to reconfigure it for this purpose.
740 * In turn, if the device is not supposed to wake up the system from the
741 * sleep state, we'll have to prevent it from signaling wake-up.
743 pm_runtime_resume(dev);
745 pci_dev->state_saved = false;
747 pci_power_t prev = pci_dev->current_state;
750 error = pm->suspend(dev);
751 suspend_report_result(pm->suspend, error);
755 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
756 && pci_dev->current_state != PCI_UNKNOWN) {
757 WARN_ONCE(pci_dev->current_state != prev,
758 "PCI PM: State of device not saved by %pF\n",
764 pci_fixup_device(pci_fixup_suspend, pci_dev);
769 static int pci_pm_suspend_noirq(struct device *dev)
771 struct pci_dev *pci_dev = to_pci_dev(dev);
772 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
774 if (pci_has_legacy_pm_support(pci_dev))
775 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
778 pci_save_state(pci_dev);
782 if (pm->suspend_noirq) {
783 pci_power_t prev = pci_dev->current_state;
786 error = pm->suspend_noirq(dev);
787 suspend_report_result(pm->suspend_noirq, error);
791 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
792 && pci_dev->current_state != PCI_UNKNOWN) {
793 WARN_ONCE(pci_dev->current_state != prev,
794 "PCI PM: State of device not saved by %pF\n",
800 if (!pci_dev->state_saved) {
801 pci_save_state(pci_dev);
802 if (pci_power_manageable(pci_dev))
803 pci_prepare_to_sleep(pci_dev);
806 pci_pm_set_unknown_state(pci_dev);
809 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
810 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
811 * hasn't been quiesced and tries to turn it off. If the controller
812 * is already in D3, this can hang or cause memory corruption.
814 * Since the value of the COMMAND register doesn't matter once the
815 * device has been suspended, we can safely set it to 0 here.
817 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
818 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
821 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
826 static int pci_pm_resume_noirq(struct device *dev)
828 struct pci_dev *pci_dev = to_pci_dev(dev);
829 struct device_driver *drv = dev->driver;
832 pci_pm_default_resume_early(pci_dev);
834 if (pci_has_legacy_pm_support(pci_dev))
835 return pci_legacy_resume_early(dev);
837 if (drv && drv->pm && drv->pm->resume_noirq)
838 error = drv->pm->resume_noirq(dev);
843 static int pci_pm_resume(struct device *dev)
845 struct pci_dev *pci_dev = to_pci_dev(dev);
846 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
850 * This is necessary for the suspend error path in which resume is
851 * called without restoring the standard config registers of the device.
853 if (pci_dev->state_saved)
854 pci_restore_standard_config(pci_dev);
856 if (pci_has_legacy_pm_support(pci_dev))
857 return pci_legacy_resume(dev);
859 pci_pm_default_resume(pci_dev);
863 error = pm->resume(dev);
865 pci_pm_reenable_device(pci_dev);
871 #else /* !CONFIG_SUSPEND */
873 #define pci_pm_suspend NULL
874 #define pci_pm_suspend_noirq NULL
875 #define pci_pm_resume NULL
876 #define pci_pm_resume_noirq NULL
878 #endif /* !CONFIG_SUSPEND */
880 #ifdef CONFIG_HIBERNATE_CALLBACKS
884 * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
885 * a hibernate transition
887 struct dev_pm_ops __weak pcibios_pm_ops;
889 static int pci_pm_freeze(struct device *dev)
891 struct pci_dev *pci_dev = to_pci_dev(dev);
892 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
894 if (pci_has_legacy_pm_support(pci_dev))
895 return pci_legacy_suspend(dev, PMSG_FREEZE);
898 pci_pm_default_suspend(pci_dev);
903 * This used to be done in pci_pm_prepare() for all devices and some
904 * drivers may depend on it, so do it here. Ideally, runtime-suspended
905 * devices should not be touched during freeze/thaw transitions,
908 pm_runtime_resume(dev);
910 pci_dev->state_saved = false;
914 error = pm->freeze(dev);
915 suspend_report_result(pm->freeze, error);
920 if (pcibios_pm_ops.freeze)
921 return pcibios_pm_ops.freeze(dev);
926 static int pci_pm_freeze_noirq(struct device *dev)
928 struct pci_dev *pci_dev = to_pci_dev(dev);
929 struct device_driver *drv = dev->driver;
931 if (pci_has_legacy_pm_support(pci_dev))
932 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
934 if (drv && drv->pm && drv->pm->freeze_noirq) {
937 error = drv->pm->freeze_noirq(dev);
938 suspend_report_result(drv->pm->freeze_noirq, error);
943 if (!pci_dev->state_saved)
944 pci_save_state(pci_dev);
946 pci_pm_set_unknown_state(pci_dev);
948 if (pcibios_pm_ops.freeze_noirq)
949 return pcibios_pm_ops.freeze_noirq(dev);
954 static int pci_pm_thaw_noirq(struct device *dev)
956 struct pci_dev *pci_dev = to_pci_dev(dev);
957 struct device_driver *drv = dev->driver;
960 if (pcibios_pm_ops.thaw_noirq) {
961 error = pcibios_pm_ops.thaw_noirq(dev);
966 if (pci_has_legacy_pm_support(pci_dev))
967 return pci_legacy_resume_early(dev);
969 pci_update_current_state(pci_dev, PCI_D0);
971 if (drv && drv->pm && drv->pm->thaw_noirq)
972 error = drv->pm->thaw_noirq(dev);
977 static int pci_pm_thaw(struct device *dev)
979 struct pci_dev *pci_dev = to_pci_dev(dev);
980 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
983 if (pcibios_pm_ops.thaw) {
984 error = pcibios_pm_ops.thaw(dev);
989 if (pci_has_legacy_pm_support(pci_dev))
990 return pci_legacy_resume(dev);
994 error = pm->thaw(dev);
996 pci_pm_reenable_device(pci_dev);
999 pci_dev->state_saved = false;
1004 static int pci_pm_poweroff(struct device *dev)
1006 struct pci_dev *pci_dev = to_pci_dev(dev);
1007 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1009 if (pci_has_legacy_pm_support(pci_dev))
1010 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1013 pci_pm_default_suspend(pci_dev);
1017 /* The reason to do that is the same as in pci_pm_suspend(). */
1018 pm_runtime_resume(dev);
1020 pci_dev->state_saved = false;
1024 error = pm->poweroff(dev);
1025 suspend_report_result(pm->poweroff, error);
1031 pci_fixup_device(pci_fixup_suspend, pci_dev);
1033 if (pcibios_pm_ops.poweroff)
1034 return pcibios_pm_ops.poweroff(dev);
1039 static int pci_pm_poweroff_noirq(struct device *dev)
1041 struct pci_dev *pci_dev = to_pci_dev(dev);
1042 struct device_driver *drv = dev->driver;
1044 if (pci_has_legacy_pm_support(to_pci_dev(dev)))
1045 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1047 if (!drv || !drv->pm) {
1048 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1052 if (drv->pm->poweroff_noirq) {
1055 error = drv->pm->poweroff_noirq(dev);
1056 suspend_report_result(drv->pm->poweroff_noirq, error);
1061 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1062 pci_prepare_to_sleep(pci_dev);
1065 * The reason for doing this here is the same as for the analogous code
1066 * in pci_pm_suspend_noirq().
1068 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1069 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1071 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1073 if (pcibios_pm_ops.poweroff_noirq)
1074 return pcibios_pm_ops.poweroff_noirq(dev);
1079 static int pci_pm_restore_noirq(struct device *dev)
1081 struct pci_dev *pci_dev = to_pci_dev(dev);
1082 struct device_driver *drv = dev->driver;
1085 if (pcibios_pm_ops.restore_noirq) {
1086 error = pcibios_pm_ops.restore_noirq(dev);
1091 pci_pm_default_resume_early(pci_dev);
1093 if (pci_has_legacy_pm_support(pci_dev))
1094 return pci_legacy_resume_early(dev);
1096 if (drv && drv->pm && drv->pm->restore_noirq)
1097 error = drv->pm->restore_noirq(dev);
1102 static int pci_pm_restore(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;
1108 if (pcibios_pm_ops.restore) {
1109 error = pcibios_pm_ops.restore(dev);
1115 * This is necessary for the hibernation error path in which restore is
1116 * called without restoring the standard config registers of the device.
1118 if (pci_dev->state_saved)
1119 pci_restore_standard_config(pci_dev);
1121 if (pci_has_legacy_pm_support(pci_dev))
1122 return pci_legacy_resume(dev);
1124 pci_pm_default_resume(pci_dev);
1128 error = pm->restore(dev);
1130 pci_pm_reenable_device(pci_dev);
1136 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1138 #define pci_pm_freeze NULL
1139 #define pci_pm_freeze_noirq NULL
1140 #define pci_pm_thaw NULL
1141 #define pci_pm_thaw_noirq NULL
1142 #define pci_pm_poweroff NULL
1143 #define pci_pm_poweroff_noirq NULL
1144 #define pci_pm_restore NULL
1145 #define pci_pm_restore_noirq NULL
1147 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1151 static int pci_pm_runtime_suspend(struct device *dev)
1153 struct pci_dev *pci_dev = to_pci_dev(dev);
1154 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1155 pci_power_t prev = pci_dev->current_state;
1159 * If pci_dev->driver is not set (unbound), the device should
1160 * always remain in D0 regardless of the runtime PM status
1162 if (!pci_dev->driver)
1165 if (!pm || !pm->runtime_suspend)
1168 pci_dev->state_saved = false;
1169 error = pm->runtime_suspend(dev);
1172 * -EBUSY and -EAGAIN is used to request the runtime PM core
1173 * to schedule a new suspend, so log the event only with debug
1176 if (error == -EBUSY || error == -EAGAIN)
1177 dev_dbg(dev, "can't suspend now (%pf returned %d)\n",
1178 pm->runtime_suspend, error);
1180 dev_err(dev, "can't suspend (%pf returned %d)\n",
1181 pm->runtime_suspend, error);
1186 pci_fixup_device(pci_fixup_suspend, pci_dev);
1188 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
1189 && pci_dev->current_state != PCI_UNKNOWN) {
1190 WARN_ONCE(pci_dev->current_state != prev,
1191 "PCI PM: State of device not saved by %pF\n",
1192 pm->runtime_suspend);
1196 if (!pci_dev->state_saved) {
1197 pci_save_state(pci_dev);
1198 pci_finish_runtime_suspend(pci_dev);
1204 static int pci_pm_runtime_resume(struct device *dev)
1207 struct pci_dev *pci_dev = to_pci_dev(dev);
1208 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1211 * If pci_dev->driver is not set (unbound), the device should
1212 * always remain in D0 regardless of the runtime PM status
1214 if (!pci_dev->driver)
1217 if (!pm || !pm->runtime_resume)
1220 pci_restore_standard_config(pci_dev);
1221 pci_fixup_device(pci_fixup_resume_early, pci_dev);
1222 pci_enable_wake(pci_dev, PCI_D0, false);
1223 pci_fixup_device(pci_fixup_resume, pci_dev);
1225 rc = pm->runtime_resume(dev);
1227 pci_dev->runtime_d3cold = false;
1232 static int pci_pm_runtime_idle(struct device *dev)
1234 struct pci_dev *pci_dev = to_pci_dev(dev);
1235 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1239 * If pci_dev->driver is not set (unbound), the device should
1240 * always remain in D0 regardless of the runtime PM status
1242 if (!pci_dev->driver)
1248 if (pm->runtime_idle)
1249 ret = pm->runtime_idle(dev);
1254 static const struct dev_pm_ops pci_dev_pm_ops = {
1255 .prepare = pci_pm_prepare,
1256 .complete = pci_pm_complete,
1257 .suspend = pci_pm_suspend,
1258 .resume = pci_pm_resume,
1259 .freeze = pci_pm_freeze,
1260 .thaw = pci_pm_thaw,
1261 .poweroff = pci_pm_poweroff,
1262 .restore = pci_pm_restore,
1263 .suspend_noirq = pci_pm_suspend_noirq,
1264 .resume_noirq = pci_pm_resume_noirq,
1265 .freeze_noirq = pci_pm_freeze_noirq,
1266 .thaw_noirq = pci_pm_thaw_noirq,
1267 .poweroff_noirq = pci_pm_poweroff_noirq,
1268 .restore_noirq = pci_pm_restore_noirq,
1269 .runtime_suspend = pci_pm_runtime_suspend,
1270 .runtime_resume = pci_pm_runtime_resume,
1271 .runtime_idle = pci_pm_runtime_idle,
1274 #define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
1276 #else /* !CONFIG_PM */
1278 #define pci_pm_runtime_suspend NULL
1279 #define pci_pm_runtime_resume NULL
1280 #define pci_pm_runtime_idle NULL
1282 #define PCI_PM_OPS_PTR NULL
1284 #endif /* !CONFIG_PM */
1287 * __pci_register_driver - register a new pci driver
1288 * @drv: the driver structure to register
1289 * @owner: owner module of drv
1290 * @mod_name: module name string
1292 * Adds the driver structure to the list of registered drivers.
1293 * Returns a negative value on error, otherwise 0.
1294 * If no error occurred, the driver remains registered even if
1295 * no device was claimed during registration.
1297 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1298 const char *mod_name)
1300 /* initialize common driver fields */
1301 drv->driver.name = drv->name;
1302 drv->driver.bus = &pci_bus_type;
1303 drv->driver.owner = owner;
1304 drv->driver.mod_name = mod_name;
1306 spin_lock_init(&drv->dynids.lock);
1307 INIT_LIST_HEAD(&drv->dynids.list);
1309 /* register with core */
1310 return driver_register(&drv->driver);
1312 EXPORT_SYMBOL(__pci_register_driver);
1315 * pci_unregister_driver - unregister a pci driver
1316 * @drv: the driver structure to unregister
1318 * Deletes the driver structure from the list of registered PCI drivers,
1319 * gives it a chance to clean up by calling its remove() function for
1320 * each device it was responsible for, and marks those devices as
1324 void pci_unregister_driver(struct pci_driver *drv)
1326 driver_unregister(&drv->driver);
1327 pci_free_dynids(drv);
1329 EXPORT_SYMBOL(pci_unregister_driver);
1331 static struct pci_driver pci_compat_driver = {
1336 * pci_dev_driver - get the pci_driver of a device
1337 * @dev: the device to query
1339 * Returns the appropriate pci_driver structure or %NULL if there is no
1340 * registered driver for the device.
1342 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1348 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1349 if (dev->resource[i].flags & IORESOURCE_BUSY)
1350 return &pci_compat_driver;
1354 EXPORT_SYMBOL(pci_dev_driver);
1357 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1358 * @dev: the PCI device structure to match against
1359 * @drv: the device driver to search for matching PCI device id structures
1361 * Used by a driver to check whether a PCI device present in the
1362 * system is in its list of supported devices. Returns the matching
1363 * pci_device_id structure or %NULL if there is no match.
1365 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1367 struct pci_dev *pci_dev = to_pci_dev(dev);
1368 struct pci_driver *pci_drv;
1369 const struct pci_device_id *found_id;
1371 if (!pci_dev->match_driver)
1374 pci_drv = to_pci_driver(drv);
1375 found_id = pci_match_device(pci_drv, pci_dev);
1383 * pci_dev_get - increments the reference count of the pci device structure
1384 * @dev: the device being referenced
1386 * Each live reference to a device should be refcounted.
1388 * Drivers for PCI devices should normally record such references in
1389 * their probe() methods, when they bind to a device, and release
1390 * them by calling pci_dev_put(), in their disconnect() methods.
1392 * A pointer to the device with the incremented reference counter is returned.
1394 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1397 get_device(&dev->dev);
1400 EXPORT_SYMBOL(pci_dev_get);
1403 * pci_dev_put - release a use of the pci device structure
1404 * @dev: device that's been disconnected
1406 * Must be called when a user of a device is finished with it. When the last
1407 * user of the device calls this function, the memory of the device is freed.
1409 void pci_dev_put(struct pci_dev *dev)
1412 put_device(&dev->dev);
1414 EXPORT_SYMBOL(pci_dev_put);
1416 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1418 struct pci_dev *pdev;
1423 pdev = to_pci_dev(dev);
1425 if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1428 if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1431 if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1432 pdev->subsystem_device))
1435 if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1438 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1439 pdev->vendor, pdev->device,
1440 pdev->subsystem_vendor, pdev->subsystem_device,
1441 (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1448 static int pci_bus_num_vf(struct device *dev)
1450 return pci_num_vf(to_pci_dev(dev));
1453 struct bus_type pci_bus_type = {
1455 .match = pci_bus_match,
1456 .uevent = pci_uevent,
1457 .probe = pci_device_probe,
1458 .remove = pci_device_remove,
1459 .shutdown = pci_device_shutdown,
1460 .dev_groups = pci_dev_groups,
1461 .bus_groups = pci_bus_groups,
1462 .drv_groups = pci_drv_groups,
1463 .pm = PCI_PM_OPS_PTR,
1464 .num_vf = pci_bus_num_vf,
1466 EXPORT_SYMBOL(pci_bus_type);
1468 static int __init pci_driver_init(void)
1470 return bus_register(&pci_bus_type);
1472 postcore_initcall(pci_driver_init);