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>
23 * Dynamic device IDs are disabled for !CONFIG_HOTPLUG
27 struct list_head node;
28 struct pci_device_id id;
34 * store_new_id - add a new PCI device ID to this driver and re-probe devices
35 * @driver: target device driver
36 * @buf: buffer for scanning device ID data
39 * Adds a new dynamic pci device ID to this driver,
40 * and causes the driver to probe for all devices again.
43 store_new_id(struct device_driver *driver, const char *buf, size_t count)
45 struct pci_dynid *dynid;
46 struct pci_driver *pdrv = to_pci_driver(driver);
47 const struct pci_device_id *ids = pdrv->id_table;
48 __u32 vendor, device, subvendor=PCI_ANY_ID,
49 subdevice=PCI_ANY_ID, class=0, class_mask=0;
50 unsigned long driver_data=0;
54 fields = sscanf(buf, "%x %x %x %x %x %x %lx",
55 &vendor, &device, &subvendor, &subdevice,
56 &class, &class_mask, &driver_data);
60 /* Only accept driver_data values that match an existing id_table
64 while (ids->vendor || ids->subvendor || ids->class_mask) {
65 if (driver_data == ids->driver_data) {
71 if (retval) /* No match */
75 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
79 dynid->id.vendor = vendor;
80 dynid->id.device = device;
81 dynid->id.subvendor = subvendor;
82 dynid->id.subdevice = subdevice;
83 dynid->id.class = class;
84 dynid->id.class_mask = class_mask;
85 dynid->id.driver_data = driver_data;
87 spin_lock(&pdrv->dynids.lock);
88 list_add_tail(&dynid->node, &pdrv->dynids.list);
89 spin_unlock(&pdrv->dynids.lock);
91 if (get_driver(&pdrv->driver)) {
92 retval = driver_attach(&pdrv->driver);
93 put_driver(&pdrv->driver);
100 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
103 pci_free_dynids(struct pci_driver *drv)
105 struct pci_dynid *dynid, *n;
107 spin_lock(&drv->dynids.lock);
108 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
109 list_del(&dynid->node);
112 spin_unlock(&drv->dynids.lock);
116 pci_create_newid_file(struct pci_driver *drv)
119 if (drv->probe != NULL)
120 error = driver_create_file(&drv->driver, &driver_attr_new_id);
124 static void pci_remove_newid_file(struct pci_driver *drv)
126 driver_remove_file(&drv->driver, &driver_attr_new_id);
128 #else /* !CONFIG_HOTPLUG */
129 static inline void pci_free_dynids(struct pci_driver *drv) {}
130 static inline int pci_create_newid_file(struct pci_driver *drv)
134 static inline void pci_remove_newid_file(struct pci_driver *drv) {}
138 * pci_match_id - See if a pci device matches a given pci_id table
139 * @ids: array of PCI device id structures to search in
140 * @dev: the PCI device structure to match against.
142 * Used by a driver to check whether a PCI device present in the
143 * system is in its list of supported devices. Returns the matching
144 * pci_device_id structure or %NULL if there is no match.
146 * Deprecated, don't use this as it will not catch any dynamic ids
147 * that a driver might want to check for.
149 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
153 while (ids->vendor || ids->subvendor || ids->class_mask) {
154 if (pci_match_one_device(ids, dev))
163 * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
164 * @drv: the PCI driver to match against
165 * @dev: the PCI device structure to match against
167 * Used by a driver to check whether a PCI device present in the
168 * system is in its list of supported devices. Returns the matching
169 * pci_device_id structure or %NULL if there is no match.
171 static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
174 struct pci_dynid *dynid;
176 /* Look at the dynamic ids first, before the static ones */
177 spin_lock(&drv->dynids.lock);
178 list_for_each_entry(dynid, &drv->dynids.list, node) {
179 if (pci_match_one_device(&dynid->id, dev)) {
180 spin_unlock(&drv->dynids.lock);
184 spin_unlock(&drv->dynids.lock);
186 return pci_match_id(drv->id_table, dev);
189 struct drv_dev_and_id {
190 struct pci_driver *drv;
192 const struct pci_device_id *id;
195 static long local_pci_probe(void *_ddi)
197 struct drv_dev_and_id *ddi = _ddi;
199 return ddi->drv->probe(ddi->dev, ddi->id);
202 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
203 const struct pci_device_id *id)
206 struct drv_dev_and_id ddi = { drv, dev, id };
208 /* Execute driver initialization on node where the device's
209 bus is attached to. This way the driver likely allocates
210 its local memory on the right node without any need to
212 node = dev_to_node(&dev->dev);
215 node_to_cpumask_ptr(nodecpumask, node);
218 cpu = cpumask_any_and(nodecpumask, cpu_online_mask);
219 if (cpu < nr_cpu_ids)
220 error = work_on_cpu(cpu, local_pci_probe, &ddi);
222 error = local_pci_probe(&ddi);
225 error = local_pci_probe(&ddi);
230 * __pci_device_probe()
231 * @drv: driver to call to check if it wants the PCI device
232 * @pci_dev: PCI device being probed
234 * returns 0 on success, else error.
235 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
238 __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
240 const struct pci_device_id *id;
243 if (!pci_dev->driver && drv->probe) {
246 id = pci_match_device(drv, pci_dev);
248 error = pci_call_probe(drv, pci_dev, id);
250 pci_dev->driver = drv;
257 static int pci_device_probe(struct device * dev)
260 struct pci_driver *drv;
261 struct pci_dev *pci_dev;
263 drv = to_pci_driver(dev->driver);
264 pci_dev = to_pci_dev(dev);
265 pci_dev_get(pci_dev);
266 error = __pci_device_probe(drv, pci_dev);
268 pci_dev_put(pci_dev);
273 static int pci_device_remove(struct device * dev)
275 struct pci_dev * pci_dev = to_pci_dev(dev);
276 struct pci_driver * drv = pci_dev->driver;
280 drv->remove(pci_dev);
281 pci_dev->driver = NULL;
285 * If the device is still on, set the power state as "unknown",
286 * since it might change by the next time we load the driver.
288 if (pci_dev->current_state == PCI_D0)
289 pci_dev->current_state = PCI_UNKNOWN;
292 * We would love to complain here if pci_dev->is_enabled is set, that
293 * the driver should have called pci_disable_device(), but the
294 * unfortunate fact is there are too many odd BIOS and bridge setups
295 * that don't like drivers doing that all of the time.
296 * Oh well, we can dream of sane hardware when we sleep, no matter how
297 * horrible the crap we have to deal with is when we are awake...
300 pci_dev_put(pci_dev);
304 static void pci_device_shutdown(struct device *dev)
306 struct pci_dev *pci_dev = to_pci_dev(dev);
307 struct pci_driver *drv = pci_dev->driver;
309 if (drv && drv->shutdown)
310 drv->shutdown(pci_dev);
311 pci_msi_shutdown(pci_dev);
312 pci_msix_shutdown(pci_dev);
315 #ifdef CONFIG_PM_SLEEP
317 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
319 struct pci_driver *drv = pci_dev->driver;
321 return drv && (drv->suspend || drv->suspend_late || drv->resume
322 || drv->resume_early);
326 * Default "suspend" method for devices that have no driver provided suspend,
327 * or not even a driver at all (first part).
329 static void pci_default_pm_suspend_early(struct pci_dev *pci_dev)
331 /* If device is enabled at this point, disable it */
332 pci_disable_enabled_device(pci_dev);
336 * Default "suspend" method for devices that have no driver provided suspend,
337 * or not even a driver at all (second part).
339 static void pci_default_pm_suspend_late(struct pci_dev *pci_dev)
341 pci_save_state(pci_dev);
343 * mark its power state as "unknown", since we don't know if
344 * e.g. the BIOS will change its device state when we suspend.
346 if (pci_dev->current_state == PCI_D0)
347 pci_dev->current_state = PCI_UNKNOWN;
351 * Default "resume" method for devices that have no driver provided resume,
352 * or not even a driver at all (first part).
354 static void pci_default_pm_resume_early(struct pci_dev *pci_dev)
356 /* restore the PCI config space */
357 pci_restore_state(pci_dev);
361 * Default "resume" method for devices that have no driver provided resume,
362 * or not even a driver at all (second part).
364 static int pci_default_pm_resume_late(struct pci_dev *pci_dev)
368 /* if the device was enabled before suspend, reenable */
369 retval = pci_reenable_device(pci_dev);
371 * if the device was busmaster before the suspend, make it busmaster
374 if (pci_dev->is_busmaster)
375 pci_set_master(pci_dev);
380 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
382 struct pci_dev * pci_dev = to_pci_dev(dev);
383 struct pci_driver * drv = pci_dev->driver;
386 if (drv && drv->suspend) {
387 i = drv->suspend(pci_dev, state);
388 suspend_report_result(drv->suspend, i);
391 * For compatibility with existing code with legacy PM support
392 * don't call pci_default_pm_suspend_early() here.
394 pci_default_pm_suspend_late(pci_dev);
399 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
401 struct pci_dev * pci_dev = to_pci_dev(dev);
402 struct pci_driver * drv = pci_dev->driver;
405 if (drv && drv->suspend_late) {
406 i = drv->suspend_late(pci_dev, state);
407 suspend_report_result(drv->suspend_late, i);
412 static int pci_legacy_resume(struct device *dev)
415 struct pci_dev * pci_dev = to_pci_dev(dev);
416 struct pci_driver * drv = pci_dev->driver;
418 if (drv && drv->resume) {
419 error = drv->resume(pci_dev);
421 pci_default_pm_resume_early(pci_dev);
422 error = pci_default_pm_resume_late(pci_dev);
427 static int pci_legacy_resume_early(struct device *dev)
430 struct pci_dev * pci_dev = to_pci_dev(dev);
431 struct pci_driver * drv = pci_dev->driver;
433 if (drv && drv->resume_early)
434 error = drv->resume_early(pci_dev);
438 static int pci_pm_prepare(struct device *dev)
440 struct device_driver *drv = dev->driver;
443 if (drv && drv->pm && drv->pm->prepare)
444 error = drv->pm->prepare(dev);
449 static void pci_pm_complete(struct device *dev)
451 struct device_driver *drv = dev->driver;
453 if (drv && drv->pm && drv->pm->complete)
454 drv->pm->complete(dev);
457 #ifdef CONFIG_SUSPEND
459 static int pci_pm_suspend(struct device *dev)
461 struct pci_dev *pci_dev = to_pci_dev(dev);
462 struct device_driver *drv = dev->driver;
465 if (drv && drv->pm) {
466 if (drv->pm->suspend) {
467 error = drv->pm->suspend(dev);
468 suspend_report_result(drv->pm->suspend, error);
470 } else if (pci_has_legacy_pm_support(pci_dev)) {
471 error = pci_legacy_suspend(dev, PMSG_SUSPEND);
473 pci_default_pm_suspend_early(pci_dev);
476 pci_fixup_device(pci_fixup_suspend, pci_dev);
481 static int pci_pm_suspend_noirq(struct device *dev)
483 struct pci_dev *pci_dev = to_pci_dev(dev);
484 struct device_driver *drv = dev->driver;
487 if (drv && drv->pm) {
488 if (drv->pm->suspend_noirq) {
489 error = drv->pm->suspend_noirq(dev);
490 suspend_report_result(drv->pm->suspend_noirq, error);
492 } else if (pci_has_legacy_pm_support(pci_dev)) {
493 error = pci_legacy_suspend_late(dev, PMSG_SUSPEND);
495 pci_default_pm_suspend_late(pci_dev);
501 static int pci_pm_resume(struct device *dev)
503 struct pci_dev *pci_dev = to_pci_dev(dev);
504 struct device_driver *drv = dev->driver;
507 pci_fixup_device(pci_fixup_resume, pci_dev);
509 if (drv && drv->pm) {
511 error = drv->pm->resume(dev);
512 } else if (pci_has_legacy_pm_support(pci_dev)) {
513 error = pci_legacy_resume(dev);
515 error = pci_default_pm_resume_late(pci_dev);
521 static int pci_pm_resume_noirq(struct device *dev)
523 struct pci_dev *pci_dev = to_pci_dev(dev);
524 struct device_driver *drv = dev->driver;
527 pci_fixup_device(pci_fixup_resume_early, to_pci_dev(dev));
529 if (drv && drv->pm) {
530 if (drv->pm->resume_noirq)
531 error = drv->pm->resume_noirq(dev);
532 } else if (pci_has_legacy_pm_support(pci_dev)) {
533 error = pci_legacy_resume_early(dev);
535 pci_default_pm_resume_early(pci_dev);
541 #else /* !CONFIG_SUSPEND */
543 #define pci_pm_suspend NULL
544 #define pci_pm_suspend_noirq NULL
545 #define pci_pm_resume NULL
546 #define pci_pm_resume_noirq NULL
548 #endif /* !CONFIG_SUSPEND */
550 #ifdef CONFIG_HIBERNATION
552 static int pci_pm_freeze(struct device *dev)
554 struct pci_dev *pci_dev = to_pci_dev(dev);
555 struct device_driver *drv = dev->driver;
558 if (drv && drv->pm) {
559 if (drv->pm->freeze) {
560 error = drv->pm->freeze(dev);
561 suspend_report_result(drv->pm->freeze, error);
563 } else if (pci_has_legacy_pm_support(pci_dev)) {
564 error = pci_legacy_suspend(dev, PMSG_FREEZE);
565 pci_fixup_device(pci_fixup_suspend, pci_dev);
567 pci_default_pm_suspend_early(pci_dev);
573 static int pci_pm_freeze_noirq(struct device *dev)
575 struct pci_dev *pci_dev = to_pci_dev(dev);
576 struct device_driver *drv = dev->driver;
579 if (drv && drv->pm) {
580 if (drv->pm->freeze_noirq) {
581 error = drv->pm->freeze_noirq(dev);
582 suspend_report_result(drv->pm->freeze_noirq, error);
584 } else if (pci_has_legacy_pm_support(pci_dev)) {
585 error = pci_legacy_suspend_late(dev, PMSG_FREEZE);
587 pci_default_pm_suspend_late(pci_dev);
593 static int pci_pm_thaw(struct device *dev)
595 struct pci_dev *pci_dev = to_pci_dev(dev);
596 struct device_driver *drv = dev->driver;
599 if (drv && drv->pm) {
601 error = drv->pm->thaw(dev);
602 } else if (pci_has_legacy_pm_support(pci_dev)) {
603 pci_fixup_device(pci_fixup_resume, pci_dev);
604 error = pci_legacy_resume(dev);
606 pci_default_pm_resume_late(pci_dev);
612 static int pci_pm_thaw_noirq(struct device *dev)
614 struct pci_dev *pci_dev = to_pci_dev(dev);
615 struct device_driver *drv = dev->driver;
618 if (drv && drv->pm) {
619 if (drv->pm->thaw_noirq)
620 error = drv->pm->thaw_noirq(dev);
621 } else if (pci_has_legacy_pm_support(pci_dev)) {
622 pci_fixup_device(pci_fixup_resume_early, to_pci_dev(dev));
623 error = pci_legacy_resume_early(dev);
625 pci_default_pm_resume_early(pci_dev);
631 static int pci_pm_poweroff(struct device *dev)
633 struct pci_dev *pci_dev = to_pci_dev(dev);
634 struct device_driver *drv = dev->driver;
637 if (drv && drv->pm) {
638 if (drv->pm->poweroff) {
639 error = drv->pm->poweroff(dev);
640 suspend_report_result(drv->pm->poweroff, error);
642 } else if (pci_has_legacy_pm_support(pci_dev)) {
643 error = pci_legacy_suspend(dev, PMSG_HIBERNATE);
645 pci_default_pm_suspend_early(pci_dev);
648 pci_fixup_device(pci_fixup_suspend, pci_dev);
653 static int pci_pm_poweroff_noirq(struct device *dev)
655 struct device_driver *drv = dev->driver;
658 if (drv && drv->pm) {
659 if (drv->pm->poweroff_noirq) {
660 error = drv->pm->poweroff_noirq(dev);
661 suspend_report_result(drv->pm->poweroff_noirq, error);
663 } else if (pci_has_legacy_pm_support(to_pci_dev(dev))) {
664 error = pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
670 static int pci_pm_restore(struct device *dev)
672 struct pci_dev *pci_dev = to_pci_dev(dev);
673 struct device_driver *drv = dev->driver;
676 pci_fixup_device(pci_fixup_resume, pci_dev);
678 if (drv && drv->pm) {
679 if (drv->pm->restore)
680 error = drv->pm->restore(dev);
681 } else if (pci_has_legacy_pm_support(pci_dev)) {
682 error = pci_legacy_resume(dev);
684 error = pci_default_pm_resume_late(pci_dev);
690 static int pci_pm_restore_noirq(struct device *dev)
692 struct pci_dev *pci_dev = to_pci_dev(dev);
693 struct device_driver *drv = dev->driver;
696 pci_fixup_device(pci_fixup_resume_early, pci_dev);
698 if (drv && drv->pm) {
699 if (drv->pm->restore_noirq)
700 error = drv->pm->restore_noirq(dev);
701 } else if (pci_has_legacy_pm_support(pci_dev)) {
702 error = pci_legacy_resume_early(dev);
704 pci_default_pm_resume_early(pci_dev);
710 #else /* !CONFIG_HIBERNATION */
712 #define pci_pm_freeze NULL
713 #define pci_pm_freeze_noirq NULL
714 #define pci_pm_thaw NULL
715 #define pci_pm_thaw_noirq NULL
716 #define pci_pm_poweroff NULL
717 #define pci_pm_poweroff_noirq NULL
718 #define pci_pm_restore NULL
719 #define pci_pm_restore_noirq NULL
721 #endif /* !CONFIG_HIBERNATION */
723 struct dev_pm_ops pci_dev_pm_ops = {
724 .prepare = pci_pm_prepare,
725 .complete = pci_pm_complete,
726 .suspend = pci_pm_suspend,
727 .resume = pci_pm_resume,
728 .freeze = pci_pm_freeze,
730 .poweroff = pci_pm_poweroff,
731 .restore = pci_pm_restore,
732 .suspend_noirq = pci_pm_suspend_noirq,
733 .resume_noirq = pci_pm_resume_noirq,
734 .freeze_noirq = pci_pm_freeze_noirq,
735 .thaw_noirq = pci_pm_thaw_noirq,
736 .poweroff_noirq = pci_pm_poweroff_noirq,
737 .restore_noirq = pci_pm_restore_noirq,
740 #define PCI_PM_OPS_PTR (&pci_dev_pm_ops)
742 #else /* !CONFIG_PM_SLEEP */
744 #define PCI_PM_OPS_PTR NULL
746 #endif /* !CONFIG_PM_SLEEP */
749 * __pci_register_driver - register a new pci driver
750 * @drv: the driver structure to register
751 * @owner: owner module of drv
752 * @mod_name: module name string
754 * Adds the driver structure to the list of registered drivers.
755 * Returns a negative value on error, otherwise 0.
756 * If no error occurred, the driver remains registered even if
757 * no device was claimed during registration.
759 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
760 const char *mod_name)
764 /* initialize common driver fields */
765 drv->driver.name = drv->name;
766 drv->driver.bus = &pci_bus_type;
767 drv->driver.owner = owner;
768 drv->driver.mod_name = mod_name;
770 spin_lock_init(&drv->dynids.lock);
771 INIT_LIST_HEAD(&drv->dynids.list);
773 /* register with core */
774 error = driver_register(&drv->driver);
778 error = pci_create_newid_file(drv);
780 driver_unregister(&drv->driver);
786 * pci_unregister_driver - unregister a pci driver
787 * @drv: the driver structure to unregister
789 * Deletes the driver structure from the list of registered PCI drivers,
790 * gives it a chance to clean up by calling its remove() function for
791 * each device it was responsible for, and marks those devices as
796 pci_unregister_driver(struct pci_driver *drv)
798 pci_remove_newid_file(drv);
799 driver_unregister(&drv->driver);
800 pci_free_dynids(drv);
803 static struct pci_driver pci_compat_driver = {
808 * pci_dev_driver - get the pci_driver of a device
809 * @dev: the device to query
811 * Returns the appropriate pci_driver structure or %NULL if there is no
812 * registered driver for the device.
815 pci_dev_driver(const struct pci_dev *dev)
821 for(i=0; i<=PCI_ROM_RESOURCE; i++)
822 if (dev->resource[i].flags & IORESOURCE_BUSY)
823 return &pci_compat_driver;
829 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
830 * @dev: the PCI device structure to match against
831 * @drv: the device driver to search for matching PCI device id structures
833 * Used by a driver to check whether a PCI device present in the
834 * system is in its list of supported devices. Returns the matching
835 * pci_device_id structure or %NULL if there is no match.
837 static int pci_bus_match(struct device *dev, struct device_driver *drv)
839 struct pci_dev *pci_dev = to_pci_dev(dev);
840 struct pci_driver *pci_drv = to_pci_driver(drv);
841 const struct pci_device_id *found_id;
843 found_id = pci_match_device(pci_drv, pci_dev);
851 * pci_dev_get - increments the reference count of the pci device structure
852 * @dev: the device being referenced
854 * Each live reference to a device should be refcounted.
856 * Drivers for PCI devices should normally record such references in
857 * their probe() methods, when they bind to a device, and release
858 * them by calling pci_dev_put(), in their disconnect() methods.
860 * A pointer to the device with the incremented reference counter is returned.
862 struct pci_dev *pci_dev_get(struct pci_dev *dev)
865 get_device(&dev->dev);
870 * pci_dev_put - release a use of the pci device structure
871 * @dev: device that's been disconnected
873 * Must be called when a user of a device is finished with it. When the last
874 * user of the device calls this function, the memory of the device is freed.
876 void pci_dev_put(struct pci_dev *dev)
879 put_device(&dev->dev);
882 #ifndef CONFIG_HOTPLUG
883 int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
889 struct bus_type pci_bus_type = {
891 .match = pci_bus_match,
892 .uevent = pci_uevent,
893 .probe = pci_device_probe,
894 .remove = pci_device_remove,
895 .shutdown = pci_device_shutdown,
896 .dev_attrs = pci_dev_attrs,
897 .pm = PCI_PM_OPS_PTR,
900 static int __init pci_driver_init(void)
902 return bus_register(&pci_bus_type);
905 postcore_initcall(pci_driver_init);
907 EXPORT_SYMBOL(pci_match_id);
908 EXPORT_SYMBOL(__pci_register_driver);
909 EXPORT_SYMBOL(pci_unregister_driver);
910 EXPORT_SYMBOL(pci_dev_driver);
911 EXPORT_SYMBOL(pci_bus_type);
912 EXPORT_SYMBOL(pci_dev_get);
913 EXPORT_SYMBOL(pci_dev_put);