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 struct device_driver
*drv
= dev
->driver
;
690 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
692 pci_dev_complete_resume(pci_dev
);
694 if (drv
&& drv
->pm
&& drv
->pm
->complete
)
695 drv
->pm
->complete(dev
);
698 #else /* !CONFIG_PM_SLEEP */
700 #define pci_pm_prepare NULL
701 #define pci_pm_complete NULL
703 #endif /* !CONFIG_PM_SLEEP */
705 #ifdef CONFIG_SUSPEND
707 static int pci_pm_suspend(struct device
*dev
)
709 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
710 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
712 if (pci_has_legacy_pm_support(pci_dev
))
713 return pci_legacy_suspend(dev
, PMSG_SUSPEND
);
716 pci_pm_default_suspend(pci_dev
);
721 * PCI devices suspended at run time need to be resumed at this point,
722 * because in general it is necessary to reconfigure them for system
723 * suspend. Namely, if the device is supposed to wake up the system
724 * from the sleep state, we may need to reconfigure it for this purpose.
725 * In turn, if the device is not supposed to wake up the system from the
726 * sleep state, we'll have to prevent it from signaling wake-up.
728 pm_runtime_resume(dev
);
730 pci_dev
->state_saved
= false;
732 pci_power_t prev
= pci_dev
->current_state
;
735 error
= pm
->suspend(dev
);
736 suspend_report_result(pm
->suspend
, error
);
740 if (!pci_dev
->state_saved
&& pci_dev
->current_state
!= PCI_D0
741 && pci_dev
->current_state
!= PCI_UNKNOWN
) {
742 WARN_ONCE(pci_dev
->current_state
!= prev
,
743 "PCI PM: State of device not saved by %pF\n",
749 pci_fixup_device(pci_fixup_suspend
, pci_dev
);
754 static int pci_pm_suspend_noirq(struct device
*dev
)
756 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
757 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
759 if (pci_has_legacy_pm_support(pci_dev
))
760 return pci_legacy_suspend_late(dev
, PMSG_SUSPEND
);
763 pci_save_state(pci_dev
);
767 if (pm
->suspend_noirq
) {
768 pci_power_t prev
= pci_dev
->current_state
;
771 error
= pm
->suspend_noirq(dev
);
772 suspend_report_result(pm
->suspend_noirq
, error
);
776 if (!pci_dev
->state_saved
&& pci_dev
->current_state
!= PCI_D0
777 && pci_dev
->current_state
!= PCI_UNKNOWN
) {
778 WARN_ONCE(pci_dev
->current_state
!= prev
,
779 "PCI PM: State of device not saved by %pF\n",
785 if (!pci_dev
->state_saved
) {
786 pci_save_state(pci_dev
);
787 if (!pci_has_subordinate(pci_dev
))
788 pci_prepare_to_sleep(pci_dev
);
791 pci_pm_set_unknown_state(pci_dev
);
794 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
795 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
796 * hasn't been quiesced and tries to turn it off. If the controller
797 * is already in D3, this can hang or cause memory corruption.
799 * Since the value of the COMMAND register doesn't matter once the
800 * device has been suspended, we can safely set it to 0 here.
802 if (pci_dev
->class == PCI_CLASS_SERIAL_USB_EHCI
)
803 pci_write_config_word(pci_dev
, PCI_COMMAND
, 0);
806 pci_fixup_device(pci_fixup_suspend_late
, pci_dev
);
811 static int pci_pm_resume_noirq(struct device
*dev
)
813 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
814 struct device_driver
*drv
= dev
->driver
;
817 pci_pm_default_resume_early(pci_dev
);
819 if (pci_has_legacy_pm_support(pci_dev
))
820 return pci_legacy_resume_early(dev
);
822 if (drv
&& drv
->pm
&& drv
->pm
->resume_noirq
)
823 error
= drv
->pm
->resume_noirq(dev
);
828 static int pci_pm_resume(struct device
*dev
)
830 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
831 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
835 * This is necessary for the suspend error path in which resume is
836 * called without restoring the standard config registers of the device.
838 if (pci_dev
->state_saved
)
839 pci_restore_standard_config(pci_dev
);
841 if (pci_has_legacy_pm_support(pci_dev
))
842 return pci_legacy_resume(dev
);
844 pci_pm_default_resume(pci_dev
);
848 error
= pm
->resume(dev
);
850 pci_pm_reenable_device(pci_dev
);
856 #else /* !CONFIG_SUSPEND */
858 #define pci_pm_suspend NULL
859 #define pci_pm_suspend_noirq NULL
860 #define pci_pm_resume NULL
861 #define pci_pm_resume_noirq NULL
863 #endif /* !CONFIG_SUSPEND */
865 #ifdef CONFIG_HIBERNATE_CALLBACKS
869 * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
870 * a hibernate transition
872 struct dev_pm_ops __weak pcibios_pm_ops
;
874 static int pci_pm_freeze(struct device
*dev
)
876 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
877 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
879 if (pci_has_legacy_pm_support(pci_dev
))
880 return pci_legacy_suspend(dev
, PMSG_FREEZE
);
883 pci_pm_default_suspend(pci_dev
);
888 * This used to be done in pci_pm_prepare() for all devices and some
889 * drivers may depend on it, so do it here. Ideally, runtime-suspended
890 * devices should not be touched during freeze/thaw transitions,
893 pm_runtime_resume(dev
);
895 pci_dev
->state_saved
= false;
899 error
= pm
->freeze(dev
);
900 suspend_report_result(pm
->freeze
, error
);
905 if (pcibios_pm_ops
.freeze
)
906 return pcibios_pm_ops
.freeze(dev
);
911 static int pci_pm_freeze_noirq(struct device
*dev
)
913 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
914 struct device_driver
*drv
= dev
->driver
;
916 if (pci_has_legacy_pm_support(pci_dev
))
917 return pci_legacy_suspend_late(dev
, PMSG_FREEZE
);
919 if (drv
&& drv
->pm
&& drv
->pm
->freeze_noirq
) {
922 error
= drv
->pm
->freeze_noirq(dev
);
923 suspend_report_result(drv
->pm
->freeze_noirq
, error
);
928 if (!pci_dev
->state_saved
)
929 pci_save_state(pci_dev
);
931 pci_pm_set_unknown_state(pci_dev
);
933 if (pcibios_pm_ops
.freeze_noirq
)
934 return pcibios_pm_ops
.freeze_noirq(dev
);
939 static int pci_pm_thaw_noirq(struct device
*dev
)
941 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
942 struct device_driver
*drv
= dev
->driver
;
945 if (pcibios_pm_ops
.thaw_noirq
) {
946 error
= pcibios_pm_ops
.thaw_noirq(dev
);
951 if (pci_has_legacy_pm_support(pci_dev
))
952 return pci_legacy_resume_early(dev
);
954 pci_update_current_state(pci_dev
, PCI_D0
);
956 if (drv
&& drv
->pm
&& drv
->pm
->thaw_noirq
)
957 error
= drv
->pm
->thaw_noirq(dev
);
962 static int pci_pm_thaw(struct device
*dev
)
964 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
965 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
968 if (pcibios_pm_ops
.thaw
) {
969 error
= pcibios_pm_ops
.thaw(dev
);
974 if (pci_has_legacy_pm_support(pci_dev
))
975 return pci_legacy_resume(dev
);
979 error
= pm
->thaw(dev
);
981 pci_pm_reenable_device(pci_dev
);
984 pci_dev
->state_saved
= false;
989 static int pci_pm_poweroff(struct device
*dev
)
991 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
992 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
994 if (pci_has_legacy_pm_support(pci_dev
))
995 return pci_legacy_suspend(dev
, PMSG_HIBERNATE
);
998 pci_pm_default_suspend(pci_dev
);
1002 /* The reason to do that is the same as in pci_pm_suspend(). */
1003 pm_runtime_resume(dev
);
1005 pci_dev
->state_saved
= false;
1009 error
= pm
->poweroff(dev
);
1010 suspend_report_result(pm
->poweroff
, error
);
1016 pci_fixup_device(pci_fixup_suspend
, pci_dev
);
1018 if (pcibios_pm_ops
.poweroff
)
1019 return pcibios_pm_ops
.poweroff(dev
);
1024 static int pci_pm_poweroff_noirq(struct device
*dev
)
1026 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
1027 struct device_driver
*drv
= dev
->driver
;
1029 if (pci_has_legacy_pm_support(to_pci_dev(dev
)))
1030 return pci_legacy_suspend_late(dev
, PMSG_HIBERNATE
);
1032 if (!drv
|| !drv
->pm
) {
1033 pci_fixup_device(pci_fixup_suspend_late
, pci_dev
);
1037 if (drv
->pm
->poweroff_noirq
) {
1040 error
= drv
->pm
->poweroff_noirq(dev
);
1041 suspend_report_result(drv
->pm
->poweroff_noirq
, error
);
1046 if (!pci_dev
->state_saved
&& !pci_has_subordinate(pci_dev
))
1047 pci_prepare_to_sleep(pci_dev
);
1050 * The reason for doing this here is the same as for the analogous code
1051 * in pci_pm_suspend_noirq().
1053 if (pci_dev
->class == PCI_CLASS_SERIAL_USB_EHCI
)
1054 pci_write_config_word(pci_dev
, PCI_COMMAND
, 0);
1056 pci_fixup_device(pci_fixup_suspend_late
, pci_dev
);
1058 if (pcibios_pm_ops
.poweroff_noirq
)
1059 return pcibios_pm_ops
.poweroff_noirq(dev
);
1064 static int pci_pm_restore_noirq(struct device
*dev
)
1066 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
1067 struct device_driver
*drv
= dev
->driver
;
1070 if (pcibios_pm_ops
.restore_noirq
) {
1071 error
= pcibios_pm_ops
.restore_noirq(dev
);
1076 pci_pm_default_resume_early(pci_dev
);
1078 if (pci_has_legacy_pm_support(pci_dev
))
1079 return pci_legacy_resume_early(dev
);
1081 if (drv
&& drv
->pm
&& drv
->pm
->restore_noirq
)
1082 error
= drv
->pm
->restore_noirq(dev
);
1087 static int pci_pm_restore(struct device
*dev
)
1089 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
1090 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
1093 if (pcibios_pm_ops
.restore
) {
1094 error
= pcibios_pm_ops
.restore(dev
);
1100 * This is necessary for the hibernation error path in which restore is
1101 * called without restoring the standard config registers of the device.
1103 if (pci_dev
->state_saved
)
1104 pci_restore_standard_config(pci_dev
);
1106 if (pci_has_legacy_pm_support(pci_dev
))
1107 return pci_legacy_resume(dev
);
1109 pci_pm_default_resume(pci_dev
);
1113 error
= pm
->restore(dev
);
1115 pci_pm_reenable_device(pci_dev
);
1121 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1123 #define pci_pm_freeze NULL
1124 #define pci_pm_freeze_noirq NULL
1125 #define pci_pm_thaw NULL
1126 #define pci_pm_thaw_noirq NULL
1127 #define pci_pm_poweroff NULL
1128 #define pci_pm_poweroff_noirq NULL
1129 #define pci_pm_restore NULL
1130 #define pci_pm_restore_noirq NULL
1132 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1136 static int pci_pm_runtime_suspend(struct device
*dev
)
1138 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
1139 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
1140 pci_power_t prev
= pci_dev
->current_state
;
1144 * If pci_dev->driver is not set (unbound), the device should
1145 * always remain in D0 regardless of the runtime PM status
1147 if (!pci_dev
->driver
)
1150 if (!pm
|| !pm
->runtime_suspend
)
1153 pci_dev
->state_saved
= false;
1154 pci_dev
->no_d3cold
= false;
1155 error
= pm
->runtime_suspend(dev
);
1156 suspend_report_result(pm
->runtime_suspend
, error
);
1159 if (!pci_dev
->d3cold_allowed
)
1160 pci_dev
->no_d3cold
= true;
1162 pci_fixup_device(pci_fixup_suspend
, pci_dev
);
1164 if (!pci_dev
->state_saved
&& pci_dev
->current_state
!= PCI_D0
1165 && pci_dev
->current_state
!= PCI_UNKNOWN
) {
1166 WARN_ONCE(pci_dev
->current_state
!= prev
,
1167 "PCI PM: State of device not saved by %pF\n",
1168 pm
->runtime_suspend
);
1172 if (!pci_dev
->state_saved
) {
1173 pci_save_state(pci_dev
);
1174 pci_finish_runtime_suspend(pci_dev
);
1180 static int pci_pm_runtime_resume(struct device
*dev
)
1183 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
1184 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
1187 * If pci_dev->driver is not set (unbound), the device should
1188 * always remain in D0 regardless of the runtime PM status
1190 if (!pci_dev
->driver
)
1193 if (!pm
|| !pm
->runtime_resume
)
1196 pci_restore_standard_config(pci_dev
);
1197 pci_fixup_device(pci_fixup_resume_early
, pci_dev
);
1198 __pci_enable_wake(pci_dev
, PCI_D0
, true, false);
1199 pci_fixup_device(pci_fixup_resume
, pci_dev
);
1201 rc
= pm
->runtime_resume(dev
);
1203 pci_dev
->runtime_d3cold
= false;
1208 static int pci_pm_runtime_idle(struct device
*dev
)
1210 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
1211 const struct dev_pm_ops
*pm
= dev
->driver
? dev
->driver
->pm
: NULL
;
1215 * If pci_dev->driver is not set (unbound), the device should
1216 * always remain in D0 regardless of the runtime PM status
1218 if (!pci_dev
->driver
)
1224 if (pm
->runtime_idle
)
1225 ret
= pm
->runtime_idle(dev
);
1230 static const struct dev_pm_ops pci_dev_pm_ops
= {
1231 .prepare
= pci_pm_prepare
,
1232 .complete
= pci_pm_complete
,
1233 .suspend
= pci_pm_suspend
,
1234 .resume
= pci_pm_resume
,
1235 .freeze
= pci_pm_freeze
,
1236 .thaw
= pci_pm_thaw
,
1237 .poweroff
= pci_pm_poweroff
,
1238 .restore
= pci_pm_restore
,
1239 .suspend_noirq
= pci_pm_suspend_noirq
,
1240 .resume_noirq
= pci_pm_resume_noirq
,
1241 .freeze_noirq
= pci_pm_freeze_noirq
,
1242 .thaw_noirq
= pci_pm_thaw_noirq
,
1243 .poweroff_noirq
= pci_pm_poweroff_noirq
,
1244 .restore_noirq
= pci_pm_restore_noirq
,
1245 .runtime_suspend
= pci_pm_runtime_suspend
,
1246 .runtime_resume
= pci_pm_runtime_resume
,
1247 .runtime_idle
= pci_pm_runtime_idle
,
1250 #define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
1252 #else /* !CONFIG_PM */
1254 #define pci_pm_runtime_suspend NULL
1255 #define pci_pm_runtime_resume NULL
1256 #define pci_pm_runtime_idle NULL
1258 #define PCI_PM_OPS_PTR NULL
1260 #endif /* !CONFIG_PM */
1263 * __pci_register_driver - register a new pci driver
1264 * @drv: the driver structure to register
1265 * @owner: owner module of drv
1266 * @mod_name: module name string
1268 * Adds the driver structure to the list of registered drivers.
1269 * Returns a negative value on error, otherwise 0.
1270 * If no error occurred, the driver remains registered even if
1271 * no device was claimed during registration.
1273 int __pci_register_driver(struct pci_driver
*drv
, struct module
*owner
,
1274 const char *mod_name
)
1276 /* initialize common driver fields */
1277 drv
->driver
.name
= drv
->name
;
1278 drv
->driver
.bus
= &pci_bus_type
;
1279 drv
->driver
.owner
= owner
;
1280 drv
->driver
.mod_name
= mod_name
;
1282 spin_lock_init(&drv
->dynids
.lock
);
1283 INIT_LIST_HEAD(&drv
->dynids
.list
);
1285 /* register with core */
1286 return driver_register(&drv
->driver
);
1288 EXPORT_SYMBOL(__pci_register_driver
);
1291 * pci_unregister_driver - unregister a pci driver
1292 * @drv: the driver structure to unregister
1294 * Deletes the driver structure from the list of registered PCI drivers,
1295 * gives it a chance to clean up by calling its remove() function for
1296 * each device it was responsible for, and marks those devices as
1300 void pci_unregister_driver(struct pci_driver
*drv
)
1302 driver_unregister(&drv
->driver
);
1303 pci_free_dynids(drv
);
1305 EXPORT_SYMBOL(pci_unregister_driver
);
1307 static struct pci_driver pci_compat_driver
= {
1312 * pci_dev_driver - get the pci_driver of a device
1313 * @dev: the device to query
1315 * Returns the appropriate pci_driver structure or %NULL if there is no
1316 * registered driver for the device.
1318 struct pci_driver
*pci_dev_driver(const struct pci_dev
*dev
)
1324 for (i
= 0; i
<= PCI_ROM_RESOURCE
; i
++)
1325 if (dev
->resource
[i
].flags
& IORESOURCE_BUSY
)
1326 return &pci_compat_driver
;
1330 EXPORT_SYMBOL(pci_dev_driver
);
1333 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1334 * @dev: the PCI device structure to match against
1335 * @drv: the device driver to search for matching PCI device id structures
1337 * Used by a driver to check whether a PCI device present in the
1338 * system is in its list of supported devices. Returns the matching
1339 * pci_device_id structure or %NULL if there is no match.
1341 static int pci_bus_match(struct device
*dev
, struct device_driver
*drv
)
1343 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
1344 struct pci_driver
*pci_drv
;
1345 const struct pci_device_id
*found_id
;
1347 if (!pci_dev
->match_driver
)
1350 pci_drv
= to_pci_driver(drv
);
1351 found_id
= pci_match_device(pci_drv
, pci_dev
);
1359 * pci_dev_get - increments the reference count of the pci device structure
1360 * @dev: the device being referenced
1362 * Each live reference to a device should be refcounted.
1364 * Drivers for PCI devices should normally record such references in
1365 * their probe() methods, when they bind to a device, and release
1366 * them by calling pci_dev_put(), in their disconnect() methods.
1368 * A pointer to the device with the incremented reference counter is returned.
1370 struct pci_dev
*pci_dev_get(struct pci_dev
*dev
)
1373 get_device(&dev
->dev
);
1376 EXPORT_SYMBOL(pci_dev_get
);
1379 * pci_dev_put - release a use of the pci device structure
1380 * @dev: device that's been disconnected
1382 * Must be called when a user of a device is finished with it. When the last
1383 * user of the device calls this function, the memory of the device is freed.
1385 void pci_dev_put(struct pci_dev
*dev
)
1388 put_device(&dev
->dev
);
1390 EXPORT_SYMBOL(pci_dev_put
);
1392 static int pci_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
1394 struct pci_dev
*pdev
;
1399 pdev
= to_pci_dev(dev
);
1401 if (add_uevent_var(env
, "PCI_CLASS=%04X", pdev
->class))
1404 if (add_uevent_var(env
, "PCI_ID=%04X:%04X", pdev
->vendor
, pdev
->device
))
1407 if (add_uevent_var(env
, "PCI_SUBSYS_ID=%04X:%04X", pdev
->subsystem_vendor
,
1408 pdev
->subsystem_device
))
1411 if (add_uevent_var(env
, "PCI_SLOT_NAME=%s", pci_name(pdev
)))
1414 if (add_uevent_var(env
, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1415 pdev
->vendor
, pdev
->device
,
1416 pdev
->subsystem_vendor
, pdev
->subsystem_device
,
1417 (u8
)(pdev
->class >> 16), (u8
)(pdev
->class >> 8),
1424 struct bus_type pci_bus_type
= {
1426 .match
= pci_bus_match
,
1427 .uevent
= pci_uevent
,
1428 .probe
= pci_device_probe
,
1429 .remove
= pci_device_remove
,
1430 .shutdown
= pci_device_shutdown
,
1431 .dev_groups
= pci_dev_groups
,
1432 .bus_groups
= pci_bus_groups
,
1433 .drv_groups
= pci_drv_groups
,
1434 .pm
= PCI_PM_OPS_PTR
,
1436 EXPORT_SYMBOL(pci_bus_type
);
1438 static int __init
pci_driver_init(void)
1440 return bus_register(&pci_bus_type
);
1442 postcore_initcall(pci_driver_init
);