2 * drivers/pci/pci-driver.c
7 #include <linux/module.h>
8 #include <linux/init.h>
9 #include <linux/device.h>
10 #include <linux/mempolicy.h>
11 #include <linux/string.h>
12 #include <linux/slab.h>
13 #include <linux/sched.h>
17 * Registration of PCI drivers and handling of hot-pluggable devices.
20 /* multithreaded probe logic */
21 static int pci_multithread_probe =
22 #ifdef CONFIG_PCI_MULTITHREAD_PROBE
27 __module_param_call("", pci_multithread_probe, param_set_bool, param_get_bool, &pci_multithread_probe, 0644);
31 * Dynamic device IDs are disabled for !CONFIG_HOTPLUG
35 struct list_head node;
36 struct pci_device_id id;
42 * store_new_id - add a new PCI device ID to this driver and re-probe devices
43 * @driver: target device driver
44 * @buf: buffer for scanning device ID data
47 * Adds a new dynamic pci device ID to this driver,
48 * and causes the driver to probe for all devices again.
51 store_new_id(struct device_driver *driver, const char *buf, size_t count)
53 struct pci_dynid *dynid;
54 struct pci_driver *pdrv = to_pci_driver(driver);
55 __u32 vendor=PCI_ANY_ID, device=PCI_ANY_ID, subvendor=PCI_ANY_ID,
56 subdevice=PCI_ANY_ID, class=0, class_mask=0;
57 unsigned long driver_data=0;
61 fields = sscanf(buf, "%x %x %x %x %x %x %lux",
62 &vendor, &device, &subvendor, &subdevice,
63 &class, &class_mask, &driver_data);
67 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
71 INIT_LIST_HEAD(&dynid->node);
72 dynid->id.vendor = vendor;
73 dynid->id.device = device;
74 dynid->id.subvendor = subvendor;
75 dynid->id.subdevice = subdevice;
76 dynid->id.class = class;
77 dynid->id.class_mask = class_mask;
78 dynid->id.driver_data = pdrv->dynids.use_driver_data ?
81 spin_lock(&pdrv->dynids.lock);
82 list_add_tail(&pdrv->dynids.list, &dynid->node);
83 spin_unlock(&pdrv->dynids.lock);
85 if (get_driver(&pdrv->driver)) {
86 retval = driver_attach(&pdrv->driver);
87 put_driver(&pdrv->driver);
94 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
97 pci_free_dynids(struct pci_driver *drv)
99 struct pci_dynid *dynid, *n;
101 spin_lock(&drv->dynids.lock);
102 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
103 list_del(&dynid->node);
106 spin_unlock(&drv->dynids.lock);
110 pci_create_newid_file(struct pci_driver *drv)
113 if (drv->probe != NULL)
114 error = sysfs_create_file(&drv->driver.kobj,
115 &driver_attr_new_id.attr);
119 #else /* !CONFIG_HOTPLUG */
120 static inline void pci_free_dynids(struct pci_driver *drv) {}
121 static inline int pci_create_newid_file(struct pci_driver *drv)
128 * pci_match_id - See if a pci device matches a given pci_id table
129 * @ids: array of PCI device id structures to search in
130 * @dev: the PCI device structure to match against.
132 * Used by a driver to check whether a PCI device present in the
133 * system is in its list of supported devices. Returns the matching
134 * pci_device_id structure or %NULL if there is no match.
136 * Depreciated, don't use this as it will not catch any dynamic ids
137 * that a driver might want to check for.
139 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
143 while (ids->vendor || ids->subvendor || ids->class_mask) {
144 if (pci_match_one_device(ids, dev))
153 * pci_match_device - Tell if a PCI device structure has a matching
154 * PCI device id structure
155 * @drv: the PCI driver to match against
156 * @dev: the PCI device structure to match against
158 * Used by a driver to check whether a PCI device present in the
159 * system is in its list of supported devices. Returns the matching
160 * pci_device_id structure or %NULL if there is no match.
162 const struct pci_device_id *pci_match_device(struct pci_driver *drv,
165 struct pci_dynid *dynid;
167 /* Look at the dynamic ids first, before the static ones */
168 spin_lock(&drv->dynids.lock);
169 list_for_each_entry(dynid, &drv->dynids.list, node) {
170 if (pci_match_one_device(&dynid->id, dev)) {
171 spin_unlock(&drv->dynids.lock);
175 spin_unlock(&drv->dynids.lock);
177 return pci_match_id(drv->id_table, dev);
180 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
181 const struct pci_device_id *id)
185 /* Execute driver initialization on node where the
186 device's bus is attached to. This way the driver likely
187 allocates its local memory on the right node without
188 any need to change it. */
189 struct mempolicy *oldpol;
190 cpumask_t oldmask = current->cpus_allowed;
191 int node = pcibus_to_node(dev->bus);
192 if (node >= 0 && node_online(node))
193 set_cpus_allowed(current, node_to_cpumask(node));
194 /* And set default memory allocation policy */
195 oldpol = current->mempolicy;
196 current->mempolicy = &default_policy;
197 mpol_get(current->mempolicy);
199 error = drv->probe(dev, id);
201 set_cpus_allowed(current, oldmask);
202 mpol_free(current->mempolicy);
203 current->mempolicy = oldpol;
209 * __pci_device_probe()
210 * @drv: driver to call to check if it wants the PCI device
211 * @pci_dev: PCI device being probed
213 * returns 0 on success, else error.
214 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
217 __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
219 const struct pci_device_id *id;
222 if (!pci_dev->driver && drv->probe) {
225 id = pci_match_device(drv, pci_dev);
227 error = pci_call_probe(drv, pci_dev, id);
229 pci_dev->driver = drv;
236 static int pci_device_probe(struct device * dev)
239 struct pci_driver *drv;
240 struct pci_dev *pci_dev;
242 drv = to_pci_driver(dev->driver);
243 pci_dev = to_pci_dev(dev);
244 pci_dev_get(pci_dev);
245 error = __pci_device_probe(drv, pci_dev);
247 pci_dev_put(pci_dev);
252 static int pci_device_remove(struct device * dev)
254 struct pci_dev * pci_dev = to_pci_dev(dev);
255 struct pci_driver * drv = pci_dev->driver;
259 drv->remove(pci_dev);
260 pci_dev->driver = NULL;
264 * If the device is still on, set the power state as "unknown",
265 * since it might change by the next time we load the driver.
267 if (pci_dev->current_state == PCI_D0)
268 pci_dev->current_state = PCI_UNKNOWN;
271 * We would love to complain here if pci_dev->is_enabled is set, that
272 * the driver should have called pci_disable_device(), but the
273 * unfortunate fact is there are too many odd BIOS and bridge setups
274 * that don't like drivers doing that all of the time.
275 * Oh well, we can dream of sane hardware when we sleep, no matter how
276 * horrible the crap we have to deal with is when we are awake...
279 pci_dev_put(pci_dev);
283 static int pci_device_suspend(struct device * dev, pm_message_t state)
285 struct pci_dev * pci_dev = to_pci_dev(dev);
286 struct pci_driver * drv = pci_dev->driver;
289 if (drv && drv->suspend) {
290 i = drv->suspend(pci_dev, state);
291 suspend_report_result(drv->suspend, i);
293 pci_save_state(pci_dev);
295 * mark its power state as "unknown", since we don't know if
296 * e.g. the BIOS will change its device state when we suspend.
298 if (pci_dev->current_state == PCI_D0)
299 pci_dev->current_state = PCI_UNKNOWN;
304 static int pci_device_suspend_late(struct device * dev, pm_message_t state)
306 struct pci_dev * pci_dev = to_pci_dev(dev);
307 struct pci_driver * drv = pci_dev->driver;
310 if (drv && drv->suspend_late) {
311 i = drv->suspend_late(pci_dev, state);
312 suspend_report_result(drv->suspend_late, i);
318 * Default resume method for devices that have no driver provided resume,
319 * or not even a driver at all.
321 static int pci_default_resume(struct pci_dev *pci_dev)
325 /* restore the PCI config space */
326 pci_restore_state(pci_dev);
327 /* if the device was enabled before suspend, reenable */
328 if (atomic_read(&pci_dev->enable_cnt))
329 retval = __pci_enable_device(pci_dev);
330 /* if the device was busmaster before the suspend, make it busmaster again */
331 if (pci_dev->is_busmaster)
332 pci_set_master(pci_dev);
337 static int pci_device_resume(struct device * dev)
340 struct pci_dev * pci_dev = to_pci_dev(dev);
341 struct pci_driver * drv = pci_dev->driver;
343 if (drv && drv->resume)
344 error = drv->resume(pci_dev);
346 error = pci_default_resume(pci_dev);
350 static int pci_device_resume_early(struct device * dev)
353 struct pci_dev * pci_dev = to_pci_dev(dev);
354 struct pci_driver * drv = pci_dev->driver;
356 pci_fixup_device(pci_fixup_resume, pci_dev);
358 if (drv && drv->resume_early)
359 error = drv->resume_early(pci_dev);
363 static void pci_device_shutdown(struct device *dev)
365 struct pci_dev *pci_dev = to_pci_dev(dev);
366 struct pci_driver *drv = pci_dev->driver;
368 if (drv && drv->shutdown)
369 drv->shutdown(pci_dev);
372 #define kobj_to_pci_driver(obj) container_of(obj, struct device_driver, kobj)
373 #define attr_to_driver_attribute(obj) container_of(obj, struct driver_attribute, attr)
376 pci_driver_attr_show(struct kobject * kobj, struct attribute *attr, char *buf)
378 struct device_driver *driver = kobj_to_pci_driver(kobj);
379 struct driver_attribute *dattr = attr_to_driver_attribute(attr);
382 if (!get_driver(driver))
385 ret = dattr->show ? dattr->show(driver, buf) : -EIO;
392 pci_driver_attr_store(struct kobject * kobj, struct attribute *attr,
393 const char *buf, size_t count)
395 struct device_driver *driver = kobj_to_pci_driver(kobj);
396 struct driver_attribute *dattr = attr_to_driver_attribute(attr);
399 if (!get_driver(driver))
402 ret = dattr->store ? dattr->store(driver, buf, count) : -EIO;
408 static struct sysfs_ops pci_driver_sysfs_ops = {
409 .show = pci_driver_attr_show,
410 .store = pci_driver_attr_store,
412 static struct kobj_type pci_driver_kobj_type = {
413 .sysfs_ops = &pci_driver_sysfs_ops,
417 * __pci_register_driver - register a new pci driver
418 * @drv: the driver structure to register
419 * @owner: owner module of drv
421 * Adds the driver structure to the list of registered drivers.
422 * Returns a negative value on error, otherwise 0.
423 * If no error occurred, the driver remains registered even if
424 * no device was claimed during registration.
426 int __pci_register_driver(struct pci_driver *drv, struct module *owner)
430 /* initialize common driver fields */
431 drv->driver.name = drv->name;
432 drv->driver.bus = &pci_bus_type;
433 drv->driver.owner = owner;
434 drv->driver.kobj.ktype = &pci_driver_kobj_type;
436 if (pci_multithread_probe)
437 drv->driver.multithread_probe = pci_multithread_probe;
439 drv->driver.multithread_probe = drv->multithread_probe;
441 spin_lock_init(&drv->dynids.lock);
442 INIT_LIST_HEAD(&drv->dynids.list);
444 /* register with core */
445 error = driver_register(&drv->driver);
449 error = pci_create_newid_file(drv);
451 driver_unregister(&drv->driver);
457 * pci_unregister_driver - unregister a pci driver
458 * @drv: the driver structure to unregister
460 * Deletes the driver structure from the list of registered PCI drivers,
461 * gives it a chance to clean up by calling its remove() function for
462 * each device it was responsible for, and marks those devices as
467 pci_unregister_driver(struct pci_driver *drv)
469 driver_unregister(&drv->driver);
470 pci_free_dynids(drv);
473 static struct pci_driver pci_compat_driver = {
478 * pci_dev_driver - get the pci_driver of a device
479 * @dev: the device to query
481 * Returns the appropriate pci_driver structure or %NULL if there is no
482 * registered driver for the device.
485 pci_dev_driver(const struct pci_dev *dev)
491 for(i=0; i<=PCI_ROM_RESOURCE; i++)
492 if (dev->resource[i].flags & IORESOURCE_BUSY)
493 return &pci_compat_driver;
499 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
500 * @dev: the PCI device structure to match against
501 * @drv: the device driver to search for matching PCI device id structures
503 * Used by a driver to check whether a PCI device present in the
504 * system is in its list of supported devices. Returns the matching
505 * pci_device_id structure or %NULL if there is no match.
507 static int pci_bus_match(struct device *dev, struct device_driver *drv)
509 struct pci_dev *pci_dev = to_pci_dev(dev);
510 struct pci_driver *pci_drv = to_pci_driver(drv);
511 const struct pci_device_id *found_id;
513 found_id = pci_match_device(pci_drv, pci_dev);
521 * pci_dev_get - increments the reference count of the pci device structure
522 * @dev: the device being referenced
524 * Each live reference to a device should be refcounted.
526 * Drivers for PCI devices should normally record such references in
527 * their probe() methods, when they bind to a device, and release
528 * them by calling pci_dev_put(), in their disconnect() methods.
530 * A pointer to the device with the incremented reference counter is returned.
532 struct pci_dev *pci_dev_get(struct pci_dev *dev)
535 get_device(&dev->dev);
540 * pci_dev_put - release a use of the pci device structure
541 * @dev: device that's been disconnected
543 * Must be called when a user of a device is finished with it. When the last
544 * user of the device calls this function, the memory of the device is freed.
546 void pci_dev_put(struct pci_dev *dev)
549 put_device(&dev->dev);
552 #ifndef CONFIG_HOTPLUG
553 int pci_uevent(struct device *dev, char **envp, int num_envp,
554 char *buffer, int buffer_size)
560 struct bus_type pci_bus_type = {
562 .match = pci_bus_match,
563 .uevent = pci_uevent,
564 .probe = pci_device_probe,
565 .remove = pci_device_remove,
566 .suspend = pci_device_suspend,
567 .suspend_late = pci_device_suspend_late,
568 .resume_early = pci_device_resume_early,
569 .resume = pci_device_resume,
570 .shutdown = pci_device_shutdown,
571 .dev_attrs = pci_dev_attrs,
574 static int __init pci_driver_init(void)
576 return bus_register(&pci_bus_type);
579 postcore_initcall(pci_driver_init);
581 EXPORT_SYMBOL(pci_match_id);
582 EXPORT_SYMBOL(pci_match_device);
583 EXPORT_SYMBOL(__pci_register_driver);
584 EXPORT_SYMBOL(pci_unregister_driver);
585 EXPORT_SYMBOL(pci_dev_driver);
586 EXPORT_SYMBOL(pci_bus_type);
587 EXPORT_SYMBOL(pci_dev_get);
588 EXPORT_SYMBOL(pci_dev_put);