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>
22 * Dynamic device IDs are disabled for !CONFIG_HOTPLUG
26 struct list_head node;
27 struct pci_device_id id;
33 * store_new_id - add a new PCI device ID to this driver and re-probe devices
34 * @driver: target device driver
35 * @buf: buffer for scanning device ID data
38 * Adds a new dynamic pci device ID to this driver,
39 * and causes the driver to probe for all devices again.
42 store_new_id(struct device_driver *driver, const char *buf, size_t count)
44 struct pci_dynid *dynid;
45 struct pci_driver *pdrv = to_pci_driver(driver);
46 __u32 vendor, device, subvendor=PCI_ANY_ID,
47 subdevice=PCI_ANY_ID, class=0, class_mask=0;
48 unsigned long driver_data=0;
52 fields = sscanf(buf, "%x %x %x %x %x %x %lux",
53 &vendor, &device, &subvendor, &subdevice,
54 &class, &class_mask, &driver_data);
58 dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
62 dynid->id.vendor = vendor;
63 dynid->id.device = device;
64 dynid->id.subvendor = subvendor;
65 dynid->id.subdevice = subdevice;
66 dynid->id.class = class;
67 dynid->id.class_mask = class_mask;
68 dynid->id.driver_data = pdrv->dynids.use_driver_data ?
71 spin_lock(&pdrv->dynids.lock);
72 list_add_tail(&dynid->node, &pdrv->dynids.list);
73 spin_unlock(&pdrv->dynids.lock);
75 if (get_driver(&pdrv->driver)) {
76 retval = driver_attach(&pdrv->driver);
77 put_driver(&pdrv->driver);
84 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
87 pci_free_dynids(struct pci_driver *drv)
89 struct pci_dynid *dynid, *n;
91 spin_lock(&drv->dynids.lock);
92 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
93 list_del(&dynid->node);
96 spin_unlock(&drv->dynids.lock);
100 pci_create_newid_file(struct pci_driver *drv)
103 if (drv->probe != NULL)
104 error = driver_create_file(&drv->driver, &driver_attr_new_id);
108 static void pci_remove_newid_file(struct pci_driver *drv)
110 driver_remove_file(&drv->driver, &driver_attr_new_id);
112 #else /* !CONFIG_HOTPLUG */
113 static inline void pci_free_dynids(struct pci_driver *drv) {}
114 static inline int pci_create_newid_file(struct pci_driver *drv)
118 static inline void pci_remove_newid_file(struct pci_driver *drv) {}
122 * pci_match_id - See if a pci device matches a given pci_id table
123 * @ids: array of PCI device id structures to search in
124 * @dev: the PCI device structure to match against.
126 * Used by a driver to check whether a PCI device present in the
127 * system is in its list of supported devices. Returns the matching
128 * pci_device_id structure or %NULL if there is no match.
130 * Deprecated, don't use this as it will not catch any dynamic ids
131 * that a driver might want to check for.
133 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
137 while (ids->vendor || ids->subvendor || ids->class_mask) {
138 if (pci_match_one_device(ids, dev))
147 * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
148 * @drv: the PCI driver to match against
149 * @dev: the PCI device structure to match against
151 * Used by a driver to check whether a PCI device present in the
152 * system is in its list of supported devices. Returns the matching
153 * pci_device_id structure or %NULL if there is no match.
155 static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
158 struct pci_dynid *dynid;
160 /* Look at the dynamic ids first, before the static ones */
161 spin_lock(&drv->dynids.lock);
162 list_for_each_entry(dynid, &drv->dynids.list, node) {
163 if (pci_match_one_device(&dynid->id, dev)) {
164 spin_unlock(&drv->dynids.lock);
168 spin_unlock(&drv->dynids.lock);
170 return pci_match_id(drv->id_table, dev);
173 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
174 const struct pci_device_id *id)
178 /* Execute driver initialization on node where the
179 device's bus is attached to. This way the driver likely
180 allocates its local memory on the right node without
181 any need to change it. */
182 struct mempolicy *oldpol;
183 cpumask_t oldmask = current->cpus_allowed;
184 int node = pcibus_to_node(dev->bus);
187 node_to_cpumask_ptr(nodecpumask, node);
188 set_cpus_allowed_ptr(current, nodecpumask);
190 /* And set default memory allocation policy */
191 oldpol = current->mempolicy;
192 current->mempolicy = NULL; /* fall back to system default policy */
194 error = drv->probe(dev, id);
196 set_cpus_allowed_ptr(current, &oldmask);
197 current->mempolicy = oldpol;
203 * __pci_device_probe()
204 * @drv: driver to call to check if it wants the PCI device
205 * @pci_dev: PCI device being probed
207 * returns 0 on success, else error.
208 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
211 __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
213 const struct pci_device_id *id;
216 if (!pci_dev->driver && drv->probe) {
219 id = pci_match_device(drv, pci_dev);
221 error = pci_call_probe(drv, pci_dev, id);
223 pci_dev->driver = drv;
230 static int pci_device_probe(struct device * dev)
233 struct pci_driver *drv;
234 struct pci_dev *pci_dev;
236 drv = to_pci_driver(dev->driver);
237 pci_dev = to_pci_dev(dev);
238 pci_dev_get(pci_dev);
239 error = __pci_device_probe(drv, pci_dev);
241 pci_dev_put(pci_dev);
246 static int pci_device_remove(struct device * dev)
248 struct pci_dev * pci_dev = to_pci_dev(dev);
249 struct pci_driver * drv = pci_dev->driver;
253 drv->remove(pci_dev);
254 pci_dev->driver = NULL;
258 * If the device is still on, set the power state as "unknown",
259 * since it might change by the next time we load the driver.
261 if (pci_dev->current_state == PCI_D0)
262 pci_dev->current_state = PCI_UNKNOWN;
265 * We would love to complain here if pci_dev->is_enabled is set, that
266 * the driver should have called pci_disable_device(), but the
267 * unfortunate fact is there are too many odd BIOS and bridge setups
268 * that don't like drivers doing that all of the time.
269 * Oh well, we can dream of sane hardware when we sleep, no matter how
270 * horrible the crap we have to deal with is when we are awake...
273 pci_dev_put(pci_dev);
277 static int pci_device_suspend(struct device * dev, pm_message_t state)
279 struct pci_dev * pci_dev = to_pci_dev(dev);
280 struct pci_driver * drv = pci_dev->driver;
283 if (drv && drv->suspend) {
284 i = drv->suspend(pci_dev, state);
285 suspend_report_result(drv->suspend, i);
287 pci_save_state(pci_dev);
289 * mark its power state as "unknown", since we don't know if
290 * e.g. the BIOS will change its device state when we suspend.
292 if (pci_dev->current_state == PCI_D0)
293 pci_dev->current_state = PCI_UNKNOWN;
296 pci_fixup_device(pci_fixup_suspend, pci_dev);
301 static int pci_device_suspend_late(struct device * dev, pm_message_t state)
303 struct pci_dev * pci_dev = to_pci_dev(dev);
304 struct pci_driver * drv = pci_dev->driver;
307 if (drv && drv->suspend_late) {
308 i = drv->suspend_late(pci_dev, state);
309 suspend_report_result(drv->suspend_late, i);
315 * Default resume method for devices that have no driver provided resume,
316 * or not even a driver at all.
318 static int pci_default_resume(struct pci_dev *pci_dev)
322 /* restore the PCI config space */
323 pci_restore_state(pci_dev);
324 /* if the device was enabled before suspend, reenable */
325 retval = pci_reenable_device(pci_dev);
326 /* if the device was busmaster before the suspend, make it busmaster again */
327 if (pci_dev->is_busmaster)
328 pci_set_master(pci_dev);
333 static int pci_device_resume(struct device * dev)
336 struct pci_dev * pci_dev = to_pci_dev(dev);
337 struct pci_driver * drv = pci_dev->driver;
339 if (drv && drv->resume)
340 error = drv->resume(pci_dev);
342 error = pci_default_resume(pci_dev);
343 pci_fixup_device(pci_fixup_resume, pci_dev);
347 static int pci_device_resume_early(struct device * dev)
350 struct pci_dev * pci_dev = to_pci_dev(dev);
351 struct pci_driver * drv = pci_dev->driver;
353 pci_fixup_device(pci_fixup_resume_early, pci_dev);
355 if (drv && drv->resume_early)
356 error = drv->resume_early(pci_dev);
360 static void pci_device_shutdown(struct device *dev)
362 struct pci_dev *pci_dev = to_pci_dev(dev);
363 struct pci_driver *drv = pci_dev->driver;
365 if (drv && drv->shutdown)
366 drv->shutdown(pci_dev);
367 pci_msi_shutdown(pci_dev);
368 pci_msix_shutdown(pci_dev);
372 * __pci_register_driver - register a new pci driver
373 * @drv: the driver structure to register
374 * @owner: owner module of drv
375 * @mod_name: module name string
377 * Adds the driver structure to the list of registered drivers.
378 * Returns a negative value on error, otherwise 0.
379 * If no error occurred, the driver remains registered even if
380 * no device was claimed during registration.
382 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
383 const char *mod_name)
387 /* initialize common driver fields */
388 drv->driver.name = drv->name;
389 drv->driver.bus = &pci_bus_type;
390 drv->driver.owner = owner;
391 drv->driver.mod_name = mod_name;
393 spin_lock_init(&drv->dynids.lock);
394 INIT_LIST_HEAD(&drv->dynids.list);
396 /* register with core */
397 error = driver_register(&drv->driver);
401 error = pci_create_newid_file(drv);
403 driver_unregister(&drv->driver);
409 * pci_unregister_driver - unregister a pci driver
410 * @drv: the driver structure to unregister
412 * Deletes the driver structure from the list of registered PCI drivers,
413 * gives it a chance to clean up by calling its remove() function for
414 * each device it was responsible for, and marks those devices as
419 pci_unregister_driver(struct pci_driver *drv)
421 pci_remove_newid_file(drv);
422 driver_unregister(&drv->driver);
423 pci_free_dynids(drv);
426 static struct pci_driver pci_compat_driver = {
431 * pci_dev_driver - get the pci_driver of a device
432 * @dev: the device to query
434 * Returns the appropriate pci_driver structure or %NULL if there is no
435 * registered driver for the device.
438 pci_dev_driver(const struct pci_dev *dev)
444 for(i=0; i<=PCI_ROM_RESOURCE; i++)
445 if (dev->resource[i].flags & IORESOURCE_BUSY)
446 return &pci_compat_driver;
452 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
453 * @dev: the PCI device structure to match against
454 * @drv: the device driver to search for matching PCI device id structures
456 * Used by a driver to check whether a PCI device present in the
457 * system is in its list of supported devices. Returns the matching
458 * pci_device_id structure or %NULL if there is no match.
460 static int pci_bus_match(struct device *dev, struct device_driver *drv)
462 struct pci_dev *pci_dev = to_pci_dev(dev);
463 struct pci_driver *pci_drv = to_pci_driver(drv);
464 const struct pci_device_id *found_id;
466 found_id = pci_match_device(pci_drv, pci_dev);
474 * pci_dev_get - increments the reference count of the pci device structure
475 * @dev: the device being referenced
477 * Each live reference to a device should be refcounted.
479 * Drivers for PCI devices should normally record such references in
480 * their probe() methods, when they bind to a device, and release
481 * them by calling pci_dev_put(), in their disconnect() methods.
483 * A pointer to the device with the incremented reference counter is returned.
485 struct pci_dev *pci_dev_get(struct pci_dev *dev)
488 get_device(&dev->dev);
493 * pci_dev_put - release a use of the pci device structure
494 * @dev: device that's been disconnected
496 * Must be called when a user of a device is finished with it. When the last
497 * user of the device calls this function, the memory of the device is freed.
499 void pci_dev_put(struct pci_dev *dev)
502 put_device(&dev->dev);
505 #ifndef CONFIG_HOTPLUG
506 int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
512 struct bus_type pci_bus_type = {
514 .match = pci_bus_match,
515 .uevent = pci_uevent,
516 .probe = pci_device_probe,
517 .remove = pci_device_remove,
518 .suspend = pci_device_suspend,
519 .suspend_late = pci_device_suspend_late,
520 .resume_early = pci_device_resume_early,
521 .resume = pci_device_resume,
522 .shutdown = pci_device_shutdown,
523 .dev_attrs = pci_dev_attrs,
526 static int __init pci_driver_init(void)
528 return bus_register(&pci_bus_type);
531 postcore_initcall(pci_driver_init);
533 EXPORT_SYMBOL(pci_match_id);
534 EXPORT_SYMBOL(__pci_register_driver);
535 EXPORT_SYMBOL(pci_unregister_driver);
536 EXPORT_SYMBOL(pci_dev_driver);
537 EXPORT_SYMBOL(pci_bus_type);
538 EXPORT_SYMBOL(pci_dev_get);
539 EXPORT_SYMBOL(pci_dev_put);