KVM: arm/arm64: GICv4: Handle INVALL applied to a vPE
[linux/fpc-iii.git] / drivers / pci / pci-driver.c
blob11bd267fc1371acc303795876a6fba0b7725767a
1 /*
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.
9 */
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>
23 #include "pci.h"
25 struct pci_dynid {
26 struct list_head node;
27 struct pci_device_id id;
30 /**
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
37 * @class: PCI class
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.
45 * CONTEXT:
46 * Does GFP_KERNEL allocation.
48 * RETURNS:
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);
60 if (!dynid)
61 return -ENOMEM;
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);
86 kfree(dynid);
88 spin_unlock(&drv->dynids.lock);
91 /**
92 * store_new_id - sysfs frontend to pci_add_dynid()
93 * @driver: target device driver
94 * @buf: buffer for scanning device ID data
95 * @count: input size
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,
100 size_t count)
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;
107 int fields = 0;
108 int retval = 0;
110 fields = sscanf(buf, "%x %x %x %x %x %x %lx",
111 &vendor, &device, &subvendor, &subdevice,
112 &class, &class_mask, &driver_data);
113 if (fields < 2)
114 return -EINVAL;
116 if (fields != 7) {
117 struct pci_dev *pdev = kzalloc(sizeof(*pdev), GFP_KERNEL);
118 if (!pdev)
119 return -ENOMEM;
121 pdev->vendor = vendor;
122 pdev->device = device;
123 pdev->subsystem_vendor = subvendor;
124 pdev->subsystem_device = subdevice;
125 pdev->class = class;
127 if (pci_match_id(pdrv->id_table, pdev))
128 retval = -EEXIST;
130 kfree(pdev);
132 if (retval)
133 return retval;
136 /* Only accept driver_data values that match an existing id_table
137 entry */
138 if (ids) {
139 retval = -EINVAL;
140 while (ids->vendor || ids->subvendor || ids->class_mask) {
141 if (driver_data == ids->driver_data) {
142 retval = 0;
143 break;
145 ids++;
147 if (retval) /* No match */
148 return retval;
151 retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
152 class, class_mask, driver_data);
153 if (retval)
154 return retval;
155 return count;
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
163 * @count: input size
165 * Removes a dynamic pci device ID to this driver.
167 static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
168 size_t count)
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;
174 int fields = 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);
180 if (fields < 2)
181 return -EINVAL;
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);
192 kfree(dynid);
193 retval = count;
194 break;
197 spin_unlock(&pdrv->dynids.lock);
199 return retval;
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,
206 NULL,
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,
223 struct pci_dev *dev)
225 if (ids) {
226 while (ids->vendor || ids->subvendor || ids->class_mask) {
227 if (pci_match_one_device(ids, dev))
228 return ids;
229 ids++;
232 return NULL;
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,
253 struct pci_dev *dev)
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))
260 return NULL;
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;
267 break;
270 spin_unlock(&drv->dynids.lock);
272 if (!found_id)
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;
279 return found_id;
282 struct drv_dev_and_id {
283 struct pci_driver *drv;
284 struct pci_dev *dev;
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;
294 int rc;
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);
308 if (!rc)
309 return rc;
310 if (rc < 0) {
311 pci_dev->driver = NULL;
312 pm_runtime_put_sync(dev);
313 return rc;
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);
320 return 0;
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;
327 #else
328 return false;
329 #endif
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
341 * on the right node.
343 node = dev_to_node(&dev->dev);
344 dev->is_probed = 1;
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))
354 cpu = nr_cpu_ids;
355 else
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);
360 else
361 error = local_pci_probe(&ddi);
363 dev->is_probed = 0;
364 cpu_hotplug_enable();
365 return error;
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;
379 int error = 0;
381 if (!pci_dev->driver && drv->probe) {
382 error = -ENODEV;
384 id = pci_match_device(drv, pci_dev);
385 if (id)
386 error = pci_call_probe(drv, pci_dev, id);
388 return error;
391 int __weak pcibios_alloc_irq(struct pci_dev *dev)
393 return 0;
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);
405 #else
406 static inline bool pci_device_can_probe(struct pci_dev *pdev)
408 return true;
410 #endif
412 static int pci_device_probe(struct device *dev)
414 int error;
415 struct pci_dev *pci_dev = to_pci_dev(dev);
416 struct pci_driver *drv = to_pci_driver(dev->driver);
418 pci_assign_irq(pci_dev);
420 error = pcibios_alloc_irq(pci_dev);
421 if (error < 0)
422 return error;
424 pci_dev_get(pci_dev);
425 if (pci_device_can_probe(pci_dev)) {
426 error = __pci_device_probe(drv, pci_dev);
427 if (error) {
428 pcibios_free_irq(pci_dev);
429 pci_dev_put(pci_dev);
433 return error;
436 static int pci_device_remove(struct device *dev)
438 struct pci_dev *pci_dev = to_pci_dev(dev);
439 struct pci_driver *drv = pci_dev->driver;
441 if (drv) {
442 if (drv->remove) {
443 pm_runtime_get_sync(dev);
444 drv->remove(pci_dev);
445 pm_runtime_put_noidle(dev);
447 pcibios_free_irq(pci_dev);
448 pci_dev->driver = NULL;
451 /* Undo the runtime PM settings in local_pci_probe() */
452 pm_runtime_put_sync(dev);
455 * If the device is still on, set the power state as "unknown",
456 * since it might change by the next time we load the driver.
458 if (pci_dev->current_state == PCI_D0)
459 pci_dev->current_state = PCI_UNKNOWN;
462 * We would love to complain here if pci_dev->is_enabled is set, that
463 * the driver should have called pci_disable_device(), but the
464 * unfortunate fact is there are too many odd BIOS and bridge setups
465 * that don't like drivers doing that all of the time.
466 * Oh well, we can dream of sane hardware when we sleep, no matter how
467 * horrible the crap we have to deal with is when we are awake...
470 pci_dev_put(pci_dev);
471 return 0;
474 static void pci_device_shutdown(struct device *dev)
476 struct pci_dev *pci_dev = to_pci_dev(dev);
477 struct pci_driver *drv = pci_dev->driver;
479 pm_runtime_resume(dev);
481 if (drv && drv->shutdown)
482 drv->shutdown(pci_dev);
485 * If this is a kexec reboot, turn off Bus Master bit on the
486 * device to tell it to not continue to do DMA. Don't touch
487 * devices in D3cold or unknown states.
488 * If it is not a kexec reboot, firmware will hit the PCI
489 * devices with big hammer and stop their DMA any way.
491 if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
492 pci_clear_master(pci_dev);
495 #ifdef CONFIG_PM
497 /* Auxiliary functions used for system resume and run-time resume. */
500 * pci_restore_standard_config - restore standard config registers of PCI device
501 * @pci_dev: PCI device to handle
503 static int pci_restore_standard_config(struct pci_dev *pci_dev)
505 pci_update_current_state(pci_dev, PCI_UNKNOWN);
507 if (pci_dev->current_state != PCI_D0) {
508 int error = pci_set_power_state(pci_dev, PCI_D0);
509 if (error)
510 return error;
513 pci_restore_state(pci_dev);
514 pci_pme_restore(pci_dev);
515 return 0;
518 #endif
520 #ifdef CONFIG_PM_SLEEP
522 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
524 pci_power_up(pci_dev);
525 pci_restore_state(pci_dev);
526 pci_pme_restore(pci_dev);
527 pci_fixup_device(pci_fixup_resume_early, pci_dev);
531 * Default "suspend" method for devices that have no driver provided suspend,
532 * or not even a driver at all (second part).
534 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
537 * mark its power state as "unknown", since we don't know if
538 * e.g. the BIOS will change its device state when we suspend.
540 if (pci_dev->current_state == PCI_D0)
541 pci_dev->current_state = PCI_UNKNOWN;
545 * Default "resume" method for devices that have no driver provided resume,
546 * or not even a driver at all (second part).
548 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
550 int retval;
552 /* if the device was enabled before suspend, reenable */
553 retval = pci_reenable_device(pci_dev);
555 * if the device was busmaster before the suspend, make it busmaster
556 * again
558 if (pci_dev->is_busmaster)
559 pci_set_master(pci_dev);
561 return retval;
564 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
566 struct pci_dev *pci_dev = to_pci_dev(dev);
567 struct pci_driver *drv = pci_dev->driver;
569 if (drv && drv->suspend) {
570 pci_power_t prev = pci_dev->current_state;
571 int error;
573 error = drv->suspend(pci_dev, state);
574 suspend_report_result(drv->suspend, error);
575 if (error)
576 return error;
578 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
579 && pci_dev->current_state != PCI_UNKNOWN) {
580 WARN_ONCE(pci_dev->current_state != prev,
581 "PCI PM: Device state not saved by %pF\n",
582 drv->suspend);
586 pci_fixup_device(pci_fixup_suspend, pci_dev);
588 return 0;
591 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
593 struct pci_dev *pci_dev = to_pci_dev(dev);
594 struct pci_driver *drv = pci_dev->driver;
596 if (drv && drv->suspend_late) {
597 pci_power_t prev = pci_dev->current_state;
598 int error;
600 error = drv->suspend_late(pci_dev, state);
601 suspend_report_result(drv->suspend_late, error);
602 if (error)
603 return error;
605 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
606 && pci_dev->current_state != PCI_UNKNOWN) {
607 WARN_ONCE(pci_dev->current_state != prev,
608 "PCI PM: Device state not saved by %pF\n",
609 drv->suspend_late);
610 goto Fixup;
614 if (!pci_dev->state_saved)
615 pci_save_state(pci_dev);
617 pci_pm_set_unknown_state(pci_dev);
619 Fixup:
620 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
622 return 0;
625 static int pci_legacy_resume_early(struct device *dev)
627 struct pci_dev *pci_dev = to_pci_dev(dev);
628 struct pci_driver *drv = pci_dev->driver;
630 return drv && drv->resume_early ?
631 drv->resume_early(pci_dev) : 0;
634 static int pci_legacy_resume(struct device *dev)
636 struct pci_dev *pci_dev = to_pci_dev(dev);
637 struct pci_driver *drv = pci_dev->driver;
639 pci_fixup_device(pci_fixup_resume, pci_dev);
641 return drv && drv->resume ?
642 drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
645 /* Auxiliary functions used by the new power management framework */
647 static void pci_pm_default_resume(struct pci_dev *pci_dev)
649 pci_fixup_device(pci_fixup_resume, pci_dev);
650 pci_enable_wake(pci_dev, PCI_D0, false);
653 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
655 /* Disable non-bridge devices without PM support */
656 if (!pci_has_subordinate(pci_dev))
657 pci_disable_enabled_device(pci_dev);
660 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
662 struct pci_driver *drv = pci_dev->driver;
663 bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
664 || drv->resume_early);
667 * Legacy PM support is used by default, so warn if the new framework is
668 * supported as well. Drivers are supposed to support either the
669 * former, or the latter, but not both at the same time.
671 WARN(ret && drv->driver.pm, "driver %s device %04x:%04x\n",
672 drv->name, pci_dev->vendor, pci_dev->device);
674 return ret;
677 /* New power management framework */
679 static int pci_pm_prepare(struct device *dev)
681 struct device_driver *drv = dev->driver;
684 * Devices having power.ignore_children set may still be necessary for
685 * suspending their children in the next phase of device suspend.
687 if (dev->power.ignore_children)
688 pm_runtime_resume(dev);
690 if (drv && drv->pm && drv->pm->prepare) {
691 int error = drv->pm->prepare(dev);
692 if (error)
693 return error;
695 return pci_dev_keep_suspended(to_pci_dev(dev));
698 static void pci_pm_complete(struct device *dev)
700 struct pci_dev *pci_dev = to_pci_dev(dev);
702 pci_dev_complete_resume(pci_dev);
703 pm_generic_complete(dev);
705 /* Resume device if platform firmware has put it in reset-power-on */
706 if (dev->power.direct_complete && pm_resume_via_firmware()) {
707 pci_power_t pre_sleep_state = pci_dev->current_state;
709 pci_update_current_state(pci_dev, pci_dev->current_state);
710 if (pci_dev->current_state < pre_sleep_state)
711 pm_request_resume(dev);
715 #else /* !CONFIG_PM_SLEEP */
717 #define pci_pm_prepare NULL
718 #define pci_pm_complete NULL
720 #endif /* !CONFIG_PM_SLEEP */
722 #ifdef CONFIG_SUSPEND
724 static int pci_pm_suspend(struct device *dev)
726 struct pci_dev *pci_dev = to_pci_dev(dev);
727 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
729 if (pci_has_legacy_pm_support(pci_dev))
730 return pci_legacy_suspend(dev, PMSG_SUSPEND);
732 if (!pm) {
733 pci_pm_default_suspend(pci_dev);
734 goto Fixup;
738 * PCI devices suspended at run time need to be resumed at this point,
739 * because in general it is necessary to reconfigure them for system
740 * suspend. Namely, if the device is supposed to wake up the system
741 * from the sleep state, we may need to reconfigure it for this purpose.
742 * In turn, if the device is not supposed to wake up the system from the
743 * sleep state, we'll have to prevent it from signaling wake-up.
745 pm_runtime_resume(dev);
747 pci_dev->state_saved = false;
748 if (pm->suspend) {
749 pci_power_t prev = pci_dev->current_state;
750 int error;
752 error = pm->suspend(dev);
753 suspend_report_result(pm->suspend, error);
754 if (error)
755 return error;
757 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
758 && pci_dev->current_state != PCI_UNKNOWN) {
759 WARN_ONCE(pci_dev->current_state != prev,
760 "PCI PM: State of device not saved by %pF\n",
761 pm->suspend);
765 Fixup:
766 pci_fixup_device(pci_fixup_suspend, pci_dev);
768 return 0;
771 static int pci_pm_suspend_noirq(struct device *dev)
773 struct pci_dev *pci_dev = to_pci_dev(dev);
774 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
776 if (pci_has_legacy_pm_support(pci_dev))
777 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
779 if (!pm) {
780 pci_save_state(pci_dev);
781 goto Fixup;
784 if (pm->suspend_noirq) {
785 pci_power_t prev = pci_dev->current_state;
786 int error;
788 error = pm->suspend_noirq(dev);
789 suspend_report_result(pm->suspend_noirq, error);
790 if (error)
791 return error;
793 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
794 && pci_dev->current_state != PCI_UNKNOWN) {
795 WARN_ONCE(pci_dev->current_state != prev,
796 "PCI PM: State of device not saved by %pF\n",
797 pm->suspend_noirq);
798 goto Fixup;
802 if (!pci_dev->state_saved) {
803 pci_save_state(pci_dev);
804 if (pci_power_manageable(pci_dev))
805 pci_prepare_to_sleep(pci_dev);
808 pci_pm_set_unknown_state(pci_dev);
811 * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
812 * PCI COMMAND register isn't 0, the BIOS assumes that the controller
813 * hasn't been quiesced and tries to turn it off. If the controller
814 * is already in D3, this can hang or cause memory corruption.
816 * Since the value of the COMMAND register doesn't matter once the
817 * device has been suspended, we can safely set it to 0 here.
819 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
820 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
822 Fixup:
823 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
825 return 0;
828 static int pci_pm_resume_noirq(struct device *dev)
830 struct pci_dev *pci_dev = to_pci_dev(dev);
831 struct device_driver *drv = dev->driver;
832 int error = 0;
834 pci_pm_default_resume_early(pci_dev);
836 if (pci_has_legacy_pm_support(pci_dev))
837 return pci_legacy_resume_early(dev);
839 if (drv && drv->pm && drv->pm->resume_noirq)
840 error = drv->pm->resume_noirq(dev);
842 return error;
845 static int pci_pm_resume(struct device *dev)
847 struct pci_dev *pci_dev = to_pci_dev(dev);
848 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
849 int error = 0;
852 * This is necessary for the suspend error path in which resume is
853 * called without restoring the standard config registers of the device.
855 if (pci_dev->state_saved)
856 pci_restore_standard_config(pci_dev);
858 if (pci_has_legacy_pm_support(pci_dev))
859 return pci_legacy_resume(dev);
861 pci_pm_default_resume(pci_dev);
863 if (pm) {
864 if (pm->resume)
865 error = pm->resume(dev);
866 } else {
867 pci_pm_reenable_device(pci_dev);
870 return error;
873 #else /* !CONFIG_SUSPEND */
875 #define pci_pm_suspend NULL
876 #define pci_pm_suspend_noirq NULL
877 #define pci_pm_resume NULL
878 #define pci_pm_resume_noirq NULL
880 #endif /* !CONFIG_SUSPEND */
882 #ifdef CONFIG_HIBERNATE_CALLBACKS
886 * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
887 * a hibernate transition
889 struct dev_pm_ops __weak pcibios_pm_ops;
891 static int pci_pm_freeze(struct device *dev)
893 struct pci_dev *pci_dev = to_pci_dev(dev);
894 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
896 if (pci_has_legacy_pm_support(pci_dev))
897 return pci_legacy_suspend(dev, PMSG_FREEZE);
899 if (!pm) {
900 pci_pm_default_suspend(pci_dev);
901 return 0;
905 * This used to be done in pci_pm_prepare() for all devices and some
906 * drivers may depend on it, so do it here. Ideally, runtime-suspended
907 * devices should not be touched during freeze/thaw transitions,
908 * however.
910 pm_runtime_resume(dev);
912 pci_dev->state_saved = false;
913 if (pm->freeze) {
914 int error;
916 error = pm->freeze(dev);
917 suspend_report_result(pm->freeze, error);
918 if (error)
919 return error;
922 if (pcibios_pm_ops.freeze)
923 return pcibios_pm_ops.freeze(dev);
925 return 0;
928 static int pci_pm_freeze_noirq(struct device *dev)
930 struct pci_dev *pci_dev = to_pci_dev(dev);
931 struct device_driver *drv = dev->driver;
933 if (pci_has_legacy_pm_support(pci_dev))
934 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
936 if (drv && drv->pm && drv->pm->freeze_noirq) {
937 int error;
939 error = drv->pm->freeze_noirq(dev);
940 suspend_report_result(drv->pm->freeze_noirq, error);
941 if (error)
942 return error;
945 if (!pci_dev->state_saved)
946 pci_save_state(pci_dev);
948 pci_pm_set_unknown_state(pci_dev);
950 if (pcibios_pm_ops.freeze_noirq)
951 return pcibios_pm_ops.freeze_noirq(dev);
953 return 0;
956 static int pci_pm_thaw_noirq(struct device *dev)
958 struct pci_dev *pci_dev = to_pci_dev(dev);
959 struct device_driver *drv = dev->driver;
960 int error = 0;
962 if (pcibios_pm_ops.thaw_noirq) {
963 error = pcibios_pm_ops.thaw_noirq(dev);
964 if (error)
965 return error;
968 if (pci_has_legacy_pm_support(pci_dev))
969 return pci_legacy_resume_early(dev);
971 pci_update_current_state(pci_dev, PCI_D0);
972 pci_restore_state(pci_dev);
974 if (drv && drv->pm && drv->pm->thaw_noirq)
975 error = drv->pm->thaw_noirq(dev);
977 return error;
980 static int pci_pm_thaw(struct device *dev)
982 struct pci_dev *pci_dev = to_pci_dev(dev);
983 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
984 int error = 0;
986 if (pcibios_pm_ops.thaw) {
987 error = pcibios_pm_ops.thaw(dev);
988 if (error)
989 return error;
992 if (pci_has_legacy_pm_support(pci_dev))
993 return pci_legacy_resume(dev);
995 if (pm) {
996 if (pm->thaw)
997 error = pm->thaw(dev);
998 } else {
999 pci_pm_reenable_device(pci_dev);
1002 pci_dev->state_saved = false;
1004 return error;
1007 static int pci_pm_poweroff(struct device *dev)
1009 struct pci_dev *pci_dev = to_pci_dev(dev);
1010 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1012 if (pci_has_legacy_pm_support(pci_dev))
1013 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1015 if (!pm) {
1016 pci_pm_default_suspend(pci_dev);
1017 goto Fixup;
1020 /* The reason to do that is the same as in pci_pm_suspend(). */
1021 pm_runtime_resume(dev);
1023 pci_dev->state_saved = false;
1024 if (pm->poweroff) {
1025 int error;
1027 error = pm->poweroff(dev);
1028 suspend_report_result(pm->poweroff, error);
1029 if (error)
1030 return error;
1033 Fixup:
1034 pci_fixup_device(pci_fixup_suspend, pci_dev);
1036 if (pcibios_pm_ops.poweroff)
1037 return pcibios_pm_ops.poweroff(dev);
1039 return 0;
1042 static int pci_pm_poweroff_noirq(struct device *dev)
1044 struct pci_dev *pci_dev = to_pci_dev(dev);
1045 struct device_driver *drv = dev->driver;
1047 if (pci_has_legacy_pm_support(to_pci_dev(dev)))
1048 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1050 if (!drv || !drv->pm) {
1051 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1052 return 0;
1055 if (drv->pm->poweroff_noirq) {
1056 int error;
1058 error = drv->pm->poweroff_noirq(dev);
1059 suspend_report_result(drv->pm->poweroff_noirq, error);
1060 if (error)
1061 return error;
1064 if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1065 pci_prepare_to_sleep(pci_dev);
1068 * The reason for doing this here is the same as for the analogous code
1069 * in pci_pm_suspend_noirq().
1071 if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1072 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1074 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1076 if (pcibios_pm_ops.poweroff_noirq)
1077 return pcibios_pm_ops.poweroff_noirq(dev);
1079 return 0;
1082 static int pci_pm_restore_noirq(struct device *dev)
1084 struct pci_dev *pci_dev = to_pci_dev(dev);
1085 struct device_driver *drv = dev->driver;
1086 int error = 0;
1088 if (pcibios_pm_ops.restore_noirq) {
1089 error = pcibios_pm_ops.restore_noirq(dev);
1090 if (error)
1091 return error;
1094 pci_pm_default_resume_early(pci_dev);
1096 if (pci_has_legacy_pm_support(pci_dev))
1097 return pci_legacy_resume_early(dev);
1099 if (drv && drv->pm && drv->pm->restore_noirq)
1100 error = drv->pm->restore_noirq(dev);
1102 return error;
1105 static int pci_pm_restore(struct device *dev)
1107 struct pci_dev *pci_dev = to_pci_dev(dev);
1108 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1109 int error = 0;
1111 if (pcibios_pm_ops.restore) {
1112 error = pcibios_pm_ops.restore(dev);
1113 if (error)
1114 return error;
1118 * This is necessary for the hibernation error path in which restore is
1119 * called without restoring the standard config registers of the device.
1121 if (pci_dev->state_saved)
1122 pci_restore_standard_config(pci_dev);
1124 if (pci_has_legacy_pm_support(pci_dev))
1125 return pci_legacy_resume(dev);
1127 pci_pm_default_resume(pci_dev);
1129 if (pm) {
1130 if (pm->restore)
1131 error = pm->restore(dev);
1132 } else {
1133 pci_pm_reenable_device(pci_dev);
1136 return error;
1139 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1141 #define pci_pm_freeze NULL
1142 #define pci_pm_freeze_noirq NULL
1143 #define pci_pm_thaw NULL
1144 #define pci_pm_thaw_noirq NULL
1145 #define pci_pm_poweroff NULL
1146 #define pci_pm_poweroff_noirq NULL
1147 #define pci_pm_restore NULL
1148 #define pci_pm_restore_noirq NULL
1150 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1152 #ifdef CONFIG_PM
1154 static int pci_pm_runtime_suspend(struct device *dev)
1156 struct pci_dev *pci_dev = to_pci_dev(dev);
1157 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1158 pci_power_t prev = pci_dev->current_state;
1159 int error;
1162 * If pci_dev->driver is not set (unbound), the device should
1163 * always remain in D0 regardless of the runtime PM status
1165 if (!pci_dev->driver)
1166 return 0;
1168 if (!pm || !pm->runtime_suspend)
1169 return -ENOSYS;
1171 pci_dev->state_saved = false;
1172 error = pm->runtime_suspend(dev);
1173 if (error) {
1175 * -EBUSY and -EAGAIN is used to request the runtime PM core
1176 * to schedule a new suspend, so log the event only with debug
1177 * log level.
1179 if (error == -EBUSY || error == -EAGAIN)
1180 dev_dbg(dev, "can't suspend now (%pf returned %d)\n",
1181 pm->runtime_suspend, error);
1182 else
1183 dev_err(dev, "can't suspend (%pf returned %d)\n",
1184 pm->runtime_suspend, error);
1186 return error;
1189 pci_fixup_device(pci_fixup_suspend, pci_dev);
1191 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
1192 && pci_dev->current_state != PCI_UNKNOWN) {
1193 WARN_ONCE(pci_dev->current_state != prev,
1194 "PCI PM: State of device not saved by %pF\n",
1195 pm->runtime_suspend);
1196 return 0;
1199 if (!pci_dev->state_saved) {
1200 pci_save_state(pci_dev);
1201 pci_finish_runtime_suspend(pci_dev);
1204 return 0;
1207 static int pci_pm_runtime_resume(struct device *dev)
1209 int rc;
1210 struct pci_dev *pci_dev = to_pci_dev(dev);
1211 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1214 * If pci_dev->driver is not set (unbound), the device should
1215 * always remain in D0 regardless of the runtime PM status
1217 if (!pci_dev->driver)
1218 return 0;
1220 if (!pm || !pm->runtime_resume)
1221 return -ENOSYS;
1223 pci_restore_standard_config(pci_dev);
1224 pci_fixup_device(pci_fixup_resume_early, pci_dev);
1225 pci_enable_wake(pci_dev, PCI_D0, false);
1226 pci_fixup_device(pci_fixup_resume, pci_dev);
1228 rc = pm->runtime_resume(dev);
1230 pci_dev->runtime_d3cold = false;
1232 return rc;
1235 static int pci_pm_runtime_idle(struct device *dev)
1237 struct pci_dev *pci_dev = to_pci_dev(dev);
1238 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1239 int ret = 0;
1242 * If pci_dev->driver is not set (unbound), the device should
1243 * always remain in D0 regardless of the runtime PM status
1245 if (!pci_dev->driver)
1246 return 0;
1248 if (!pm)
1249 return -ENOSYS;
1251 if (pm->runtime_idle)
1252 ret = pm->runtime_idle(dev);
1254 return ret;
1257 static const struct dev_pm_ops pci_dev_pm_ops = {
1258 .prepare = pci_pm_prepare,
1259 .complete = pci_pm_complete,
1260 .suspend = pci_pm_suspend,
1261 .resume = pci_pm_resume,
1262 .freeze = pci_pm_freeze,
1263 .thaw = pci_pm_thaw,
1264 .poweroff = pci_pm_poweroff,
1265 .restore = pci_pm_restore,
1266 .suspend_noirq = pci_pm_suspend_noirq,
1267 .resume_noirq = pci_pm_resume_noirq,
1268 .freeze_noirq = pci_pm_freeze_noirq,
1269 .thaw_noirq = pci_pm_thaw_noirq,
1270 .poweroff_noirq = pci_pm_poweroff_noirq,
1271 .restore_noirq = pci_pm_restore_noirq,
1272 .runtime_suspend = pci_pm_runtime_suspend,
1273 .runtime_resume = pci_pm_runtime_resume,
1274 .runtime_idle = pci_pm_runtime_idle,
1277 #define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
1279 #else /* !CONFIG_PM */
1281 #define pci_pm_runtime_suspend NULL
1282 #define pci_pm_runtime_resume NULL
1283 #define pci_pm_runtime_idle NULL
1285 #define PCI_PM_OPS_PTR NULL
1287 #endif /* !CONFIG_PM */
1290 * __pci_register_driver - register a new pci driver
1291 * @drv: the driver structure to register
1292 * @owner: owner module of drv
1293 * @mod_name: module name string
1295 * Adds the driver structure to the list of registered drivers.
1296 * Returns a negative value on error, otherwise 0.
1297 * If no error occurred, the driver remains registered even if
1298 * no device was claimed during registration.
1300 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1301 const char *mod_name)
1303 /* initialize common driver fields */
1304 drv->driver.name = drv->name;
1305 drv->driver.bus = &pci_bus_type;
1306 drv->driver.owner = owner;
1307 drv->driver.mod_name = mod_name;
1308 drv->driver.groups = drv->groups;
1310 spin_lock_init(&drv->dynids.lock);
1311 INIT_LIST_HEAD(&drv->dynids.list);
1313 /* register with core */
1314 return driver_register(&drv->driver);
1316 EXPORT_SYMBOL(__pci_register_driver);
1319 * pci_unregister_driver - unregister a pci driver
1320 * @drv: the driver structure to unregister
1322 * Deletes the driver structure from the list of registered PCI drivers,
1323 * gives it a chance to clean up by calling its remove() function for
1324 * each device it was responsible for, and marks those devices as
1325 * driverless.
1328 void pci_unregister_driver(struct pci_driver *drv)
1330 driver_unregister(&drv->driver);
1331 pci_free_dynids(drv);
1333 EXPORT_SYMBOL(pci_unregister_driver);
1335 static struct pci_driver pci_compat_driver = {
1336 .name = "compat"
1340 * pci_dev_driver - get the pci_driver of a device
1341 * @dev: the device to query
1343 * Returns the appropriate pci_driver structure or %NULL if there is no
1344 * registered driver for the device.
1346 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1348 if (dev->driver)
1349 return dev->driver;
1350 else {
1351 int i;
1352 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1353 if (dev->resource[i].flags & IORESOURCE_BUSY)
1354 return &pci_compat_driver;
1356 return NULL;
1358 EXPORT_SYMBOL(pci_dev_driver);
1361 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1362 * @dev: the PCI device structure to match against
1363 * @drv: the device driver to search for matching PCI device id structures
1365 * Used by a driver to check whether a PCI device present in the
1366 * system is in its list of supported devices. Returns the matching
1367 * pci_device_id structure or %NULL if there is no match.
1369 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1371 struct pci_dev *pci_dev = to_pci_dev(dev);
1372 struct pci_driver *pci_drv;
1373 const struct pci_device_id *found_id;
1375 if (!pci_dev->match_driver)
1376 return 0;
1378 pci_drv = to_pci_driver(drv);
1379 found_id = pci_match_device(pci_drv, pci_dev);
1380 if (found_id)
1381 return 1;
1383 return 0;
1387 * pci_dev_get - increments the reference count of the pci device structure
1388 * @dev: the device being referenced
1390 * Each live reference to a device should be refcounted.
1392 * Drivers for PCI devices should normally record such references in
1393 * their probe() methods, when they bind to a device, and release
1394 * them by calling pci_dev_put(), in their disconnect() methods.
1396 * A pointer to the device with the incremented reference counter is returned.
1398 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1400 if (dev)
1401 get_device(&dev->dev);
1402 return dev;
1404 EXPORT_SYMBOL(pci_dev_get);
1407 * pci_dev_put - release a use of the pci device structure
1408 * @dev: device that's been disconnected
1410 * Must be called when a user of a device is finished with it. When the last
1411 * user of the device calls this function, the memory of the device is freed.
1413 void pci_dev_put(struct pci_dev *dev)
1415 if (dev)
1416 put_device(&dev->dev);
1418 EXPORT_SYMBOL(pci_dev_put);
1420 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1422 struct pci_dev *pdev;
1424 if (!dev)
1425 return -ENODEV;
1427 pdev = to_pci_dev(dev);
1429 if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1430 return -ENOMEM;
1432 if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1433 return -ENOMEM;
1435 if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1436 pdev->subsystem_device))
1437 return -ENOMEM;
1439 if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1440 return -ENOMEM;
1442 if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1443 pdev->vendor, pdev->device,
1444 pdev->subsystem_vendor, pdev->subsystem_device,
1445 (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1446 (u8)(pdev->class)))
1447 return -ENOMEM;
1449 return 0;
1452 static int pci_bus_num_vf(struct device *dev)
1454 return pci_num_vf(to_pci_dev(dev));
1457 struct bus_type pci_bus_type = {
1458 .name = "pci",
1459 .match = pci_bus_match,
1460 .uevent = pci_uevent,
1461 .probe = pci_device_probe,
1462 .remove = pci_device_remove,
1463 .shutdown = pci_device_shutdown,
1464 .dev_groups = pci_dev_groups,
1465 .bus_groups = pci_bus_groups,
1466 .drv_groups = pci_drv_groups,
1467 .pm = PCI_PM_OPS_PTR,
1468 .num_vf = pci_bus_num_vf,
1470 EXPORT_SYMBOL(pci_bus_type);
1472 static int __init pci_driver_init(void)
1474 return bus_register(&pci_bus_type);
1476 postcore_initcall(pci_driver_init);