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 const struct pci_device_id
*id
;
166 struct pci_dynid
*dynid
;
168 id
= pci_match_id(drv
->id_table
, dev
);
172 /* static ids didn't match, lets look at the dynamic ones */
173 spin_lock(&drv
->dynids
.lock
);
174 list_for_each_entry(dynid
, &drv
->dynids
.list
, node
) {
175 if (pci_match_one_device(&dynid
->id
, dev
)) {
176 spin_unlock(&drv
->dynids
.lock
);
180 spin_unlock(&drv
->dynids
.lock
);
184 static int pci_call_probe(struct pci_driver
*drv
, struct pci_dev
*dev
,
185 const struct pci_device_id
*id
)
189 /* Execute driver initialization on node where the
190 device's bus is attached to. This way the driver likely
191 allocates its local memory on the right node without
192 any need to change it. */
193 struct mempolicy
*oldpol
;
194 cpumask_t oldmask
= current
->cpus_allowed
;
195 int node
= pcibus_to_node(dev
->bus
);
196 if (node
>= 0 && node_online(node
))
197 set_cpus_allowed(current
, node_to_cpumask(node
));
198 /* And set default memory allocation policy */
199 oldpol
= current
->mempolicy
;
200 current
->mempolicy
= &default_policy
;
201 mpol_get(current
->mempolicy
);
203 error
= drv
->probe(dev
, id
);
205 set_cpus_allowed(current
, oldmask
);
206 mpol_free(current
->mempolicy
);
207 current
->mempolicy
= oldpol
;
213 * __pci_device_probe()
214 * @drv: driver to call to check if it wants the PCI device
215 * @pci_dev: PCI device being probed
217 * returns 0 on success, else error.
218 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
221 __pci_device_probe(struct pci_driver
*drv
, struct pci_dev
*pci_dev
)
223 const struct pci_device_id
*id
;
226 if (!pci_dev
->driver
&& drv
->probe
) {
229 id
= pci_match_device(drv
, pci_dev
);
231 error
= pci_call_probe(drv
, pci_dev
, id
);
233 pci_dev
->driver
= drv
;
240 static int pci_device_probe(struct device
* dev
)
243 struct pci_driver
*drv
;
244 struct pci_dev
*pci_dev
;
246 drv
= to_pci_driver(dev
->driver
);
247 pci_dev
= to_pci_dev(dev
);
248 pci_dev_get(pci_dev
);
249 error
= __pci_device_probe(drv
, pci_dev
);
251 pci_dev_put(pci_dev
);
256 static int pci_device_remove(struct device
* dev
)
258 struct pci_dev
* pci_dev
= to_pci_dev(dev
);
259 struct pci_driver
* drv
= pci_dev
->driver
;
263 drv
->remove(pci_dev
);
264 pci_dev
->driver
= NULL
;
268 * If the device is still on, set the power state as "unknown",
269 * since it might change by the next time we load the driver.
271 if (pci_dev
->current_state
== PCI_D0
)
272 pci_dev
->current_state
= PCI_UNKNOWN
;
275 * We would love to complain here if pci_dev->is_enabled is set, that
276 * the driver should have called pci_disable_device(), but the
277 * unfortunate fact is there are too many odd BIOS and bridge setups
278 * that don't like drivers doing that all of the time.
279 * Oh well, we can dream of sane hardware when we sleep, no matter how
280 * horrible the crap we have to deal with is when we are awake...
283 pci_dev_put(pci_dev
);
287 static int pci_device_suspend(struct device
* dev
, pm_message_t state
)
289 struct pci_dev
* pci_dev
= to_pci_dev(dev
);
290 struct pci_driver
* drv
= pci_dev
->driver
;
293 if (drv
&& drv
->suspend
) {
294 i
= drv
->suspend(pci_dev
, state
);
295 suspend_report_result(drv
->suspend
, i
);
297 pci_save_state(pci_dev
);
299 * mark its power state as "unknown", since we don't know if
300 * e.g. the BIOS will change its device state when we suspend.
302 if (pci_dev
->current_state
== PCI_D0
)
303 pci_dev
->current_state
= PCI_UNKNOWN
;
308 static int pci_device_suspend_late(struct device
* dev
, pm_message_t state
)
310 struct pci_dev
* pci_dev
= to_pci_dev(dev
);
311 struct pci_driver
* drv
= pci_dev
->driver
;
314 if (drv
&& drv
->suspend_late
) {
315 i
= drv
->suspend_late(pci_dev
, state
);
316 suspend_report_result(drv
->suspend_late
, i
);
322 * Default resume method for devices that have no driver provided resume,
323 * or not even a driver at all.
325 static int pci_default_resume(struct pci_dev
*pci_dev
)
329 /* restore the PCI config space */
330 pci_restore_state(pci_dev
);
331 /* if the device was enabled before suspend, reenable */
332 if (pci_dev
->is_enabled
)
333 retval
= pci_enable_device(pci_dev
);
334 /* if the device was busmaster before the suspend, make it busmaster again */
335 if (pci_dev
->is_busmaster
)
336 pci_set_master(pci_dev
);
341 static int pci_device_resume(struct device
* dev
)
344 struct pci_dev
* pci_dev
= to_pci_dev(dev
);
345 struct pci_driver
* drv
= pci_dev
->driver
;
347 if (drv
&& drv
->resume
)
348 error
= drv
->resume(pci_dev
);
350 error
= pci_default_resume(pci_dev
);
354 static int pci_device_resume_early(struct device
* dev
)
357 struct pci_dev
* pci_dev
= to_pci_dev(dev
);
358 struct pci_driver
* drv
= pci_dev
->driver
;
360 if (drv
&& drv
->resume_early
)
361 error
= drv
->resume_early(pci_dev
);
365 static void pci_device_shutdown(struct device
*dev
)
367 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
368 struct pci_driver
*drv
= pci_dev
->driver
;
370 if (drv
&& drv
->shutdown
)
371 drv
->shutdown(pci_dev
);
374 #define kobj_to_pci_driver(obj) container_of(obj, struct device_driver, kobj)
375 #define attr_to_driver_attribute(obj) container_of(obj, struct driver_attribute, attr)
378 pci_driver_attr_show(struct kobject
* kobj
, struct attribute
*attr
, char *buf
)
380 struct device_driver
*driver
= kobj_to_pci_driver(kobj
);
381 struct driver_attribute
*dattr
= attr_to_driver_attribute(attr
);
384 if (!get_driver(driver
))
387 ret
= dattr
->show
? dattr
->show(driver
, buf
) : -EIO
;
394 pci_driver_attr_store(struct kobject
* kobj
, struct attribute
*attr
,
395 const char *buf
, size_t count
)
397 struct device_driver
*driver
= kobj_to_pci_driver(kobj
);
398 struct driver_attribute
*dattr
= attr_to_driver_attribute(attr
);
401 if (!get_driver(driver
))
404 ret
= dattr
->store
? dattr
->store(driver
, buf
, count
) : -EIO
;
410 static struct sysfs_ops pci_driver_sysfs_ops
= {
411 .show
= pci_driver_attr_show
,
412 .store
= pci_driver_attr_store
,
414 static struct kobj_type pci_driver_kobj_type
= {
415 .sysfs_ops
= &pci_driver_sysfs_ops
,
419 * __pci_register_driver - register a new pci driver
420 * @drv: the driver structure to register
421 * @owner: owner module of drv
423 * Adds the driver structure to the list of registered drivers.
424 * Returns a negative value on error, otherwise 0.
425 * If no error occurred, the driver remains registered even if
426 * no device was claimed during registration.
428 int __pci_register_driver(struct pci_driver
*drv
, struct module
*owner
)
432 /* initialize common driver fields */
433 drv
->driver
.name
= drv
->name
;
434 drv
->driver
.bus
= &pci_bus_type
;
435 drv
->driver
.owner
= owner
;
436 drv
->driver
.kobj
.ktype
= &pci_driver_kobj_type
;
438 if (pci_multithread_probe
)
439 drv
->driver
.multithread_probe
= pci_multithread_probe
;
441 drv
->driver
.multithread_probe
= drv
->multithread_probe
;
443 spin_lock_init(&drv
->dynids
.lock
);
444 INIT_LIST_HEAD(&drv
->dynids
.list
);
446 /* register with core */
447 error
= driver_register(&drv
->driver
);
451 error
= pci_create_newid_file(drv
);
453 driver_unregister(&drv
->driver
);
459 * pci_unregister_driver - unregister a pci driver
460 * @drv: the driver structure to unregister
462 * Deletes the driver structure from the list of registered PCI drivers,
463 * gives it a chance to clean up by calling its remove() function for
464 * each device it was responsible for, and marks those devices as
469 pci_unregister_driver(struct pci_driver
*drv
)
471 driver_unregister(&drv
->driver
);
472 pci_free_dynids(drv
);
475 static struct pci_driver pci_compat_driver
= {
480 * pci_dev_driver - get the pci_driver of a device
481 * @dev: the device to query
483 * Returns the appropriate pci_driver structure or %NULL if there is no
484 * registered driver for the device.
487 pci_dev_driver(const struct pci_dev
*dev
)
493 for(i
=0; i
<=PCI_ROM_RESOURCE
; i
++)
494 if (dev
->resource
[i
].flags
& IORESOURCE_BUSY
)
495 return &pci_compat_driver
;
501 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
502 * @dev: the PCI device structure to match against
503 * @drv: the device driver to search for matching PCI device id structures
505 * Used by a driver to check whether a PCI device present in the
506 * system is in its list of supported devices. Returns the matching
507 * pci_device_id structure or %NULL if there is no match.
509 static int pci_bus_match(struct device
*dev
, struct device_driver
*drv
)
511 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
512 struct pci_driver
*pci_drv
= to_pci_driver(drv
);
513 const struct pci_device_id
*found_id
;
515 found_id
= pci_match_device(pci_drv
, pci_dev
);
523 * pci_dev_get - increments the reference count of the pci device structure
524 * @dev: the device being referenced
526 * Each live reference to a device should be refcounted.
528 * Drivers for PCI devices should normally record such references in
529 * their probe() methods, when they bind to a device, and release
530 * them by calling pci_dev_put(), in their disconnect() methods.
532 * A pointer to the device with the incremented reference counter is returned.
534 struct pci_dev
*pci_dev_get(struct pci_dev
*dev
)
537 get_device(&dev
->dev
);
542 * pci_dev_put - release a use of the pci device structure
543 * @dev: device that's been disconnected
545 * Must be called when a user of a device is finished with it. When the last
546 * user of the device calls this function, the memory of the device is freed.
548 void pci_dev_put(struct pci_dev
*dev
)
551 put_device(&dev
->dev
);
554 #ifndef CONFIG_HOTPLUG
555 int pci_uevent(struct device
*dev
, char **envp
, int num_envp
,
556 char *buffer
, int buffer_size
)
562 struct bus_type pci_bus_type
= {
564 .match
= pci_bus_match
,
565 .uevent
= pci_uevent
,
566 .probe
= pci_device_probe
,
567 .remove
= pci_device_remove
,
568 .suspend
= pci_device_suspend
,
569 .suspend_late
= pci_device_suspend_late
,
570 .resume_early
= pci_device_resume_early
,
571 .resume
= pci_device_resume
,
572 .shutdown
= pci_device_shutdown
,
573 .dev_attrs
= pci_dev_attrs
,
576 static int __init
pci_driver_init(void)
578 return bus_register(&pci_bus_type
);
581 postcore_initcall(pci_driver_init
);
583 EXPORT_SYMBOL(pci_match_id
);
584 EXPORT_SYMBOL(pci_match_device
);
585 EXPORT_SYMBOL(__pci_register_driver
);
586 EXPORT_SYMBOL(pci_unregister_driver
);
587 EXPORT_SYMBOL(pci_dev_driver
);
588 EXPORT_SYMBOL(pci_bus_type
);
589 EXPORT_SYMBOL(pci_dev_get
);
590 EXPORT_SYMBOL(pci_dev_put
);