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.
21 * Dynamic device IDs are disabled for !CONFIG_HOTPLUG
25 struct list_head node
;
26 struct pci_device_id id
;
32 * store_new_id - add a new PCI device ID to this driver and re-probe devices
33 * @driver: target device driver
34 * @buf: buffer for scanning device ID data
37 * Adds a new dynamic pci device ID to this driver,
38 * and causes the driver to probe for all devices again.
41 store_new_id(struct device_driver
*driver
, const char *buf
, size_t count
)
43 struct pci_dynid
*dynid
;
44 struct pci_driver
*pdrv
= to_pci_driver(driver
);
45 __u32 vendor
=PCI_ANY_ID
, device
=PCI_ANY_ID
, subvendor
=PCI_ANY_ID
,
46 subdevice
=PCI_ANY_ID
, class=0, class_mask
=0;
47 unsigned long driver_data
=0;
50 fields
= sscanf(buf
, "%x %x %x %x %x %x %lux",
51 &vendor
, &device
, &subvendor
, &subdevice
,
52 &class, &class_mask
, &driver_data
);
56 dynid
= kzalloc(sizeof(*dynid
), GFP_KERNEL
);
60 INIT_LIST_HEAD(&dynid
->node
);
61 dynid
->id
.vendor
= vendor
;
62 dynid
->id
.device
= device
;
63 dynid
->id
.subvendor
= subvendor
;
64 dynid
->id
.subdevice
= subdevice
;
65 dynid
->id
.class = class;
66 dynid
->id
.class_mask
= class_mask
;
67 dynid
->id
.driver_data
= pdrv
->dynids
.use_driver_data
?
70 spin_lock(&pdrv
->dynids
.lock
);
71 list_add_tail(&pdrv
->dynids
.list
, &dynid
->node
);
72 spin_unlock(&pdrv
->dynids
.lock
);
74 if (get_driver(&pdrv
->driver
)) {
75 driver_attach(&pdrv
->driver
);
76 put_driver(&pdrv
->driver
);
81 static DRIVER_ATTR(new_id
, S_IWUSR
, NULL
, store_new_id
);
84 pci_free_dynids(struct pci_driver
*drv
)
86 struct pci_dynid
*dynid
, *n
;
88 spin_lock(&drv
->dynids
.lock
);
89 list_for_each_entry_safe(dynid
, n
, &drv
->dynids
.list
, node
) {
90 list_del(&dynid
->node
);
93 spin_unlock(&drv
->dynids
.lock
);
97 pci_create_newid_file(struct pci_driver
*drv
)
100 if (drv
->probe
!= NULL
)
101 error
= sysfs_create_file(&drv
->driver
.kobj
,
102 &driver_attr_new_id
.attr
);
106 #else /* !CONFIG_HOTPLUG */
107 static inline void pci_free_dynids(struct pci_driver
*drv
) {}
108 static inline int pci_create_newid_file(struct pci_driver
*drv
)
115 * pci_match_id - See if a pci device matches a given pci_id table
116 * @ids: array of PCI device id structures to search in
117 * @dev: the PCI device structure to match against.
119 * Used by a driver to check whether a PCI device present in the
120 * system is in its list of supported devices. Returns the matching
121 * pci_device_id structure or %NULL if there is no match.
123 * Depreciated, don't use this as it will not catch any dynamic ids
124 * that a driver might want to check for.
126 const struct pci_device_id
*pci_match_id(const struct pci_device_id
*ids
,
130 while (ids
->vendor
|| ids
->subvendor
|| ids
->class_mask
) {
131 if (pci_match_one_device(ids
, dev
))
140 * pci_match_device - Tell if a PCI device structure has a matching
141 * PCI device id structure
142 * @ids: array of PCI device id structures to search in
143 * @dev: the PCI device structure to match against
144 * @drv: the PCI driver to match against
146 * Used by a driver to check whether a PCI device present in the
147 * system is in its list of supported devices. Returns the matching
148 * pci_device_id structure or %NULL if there is no match.
150 const struct pci_device_id
*pci_match_device(struct pci_driver
*drv
,
153 const struct pci_device_id
*id
;
154 struct pci_dynid
*dynid
;
156 id
= pci_match_id(drv
->id_table
, dev
);
160 /* static ids didn't match, lets look at the dynamic 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
);
172 static int pci_call_probe(struct pci_driver
*drv
, struct pci_dev
*dev
,
173 const struct pci_device_id
*id
)
177 /* Execute driver initialization on node where the
178 device's bus is attached to. This way the driver likely
179 allocates its local memory on the right node without
180 any need to change it. */
181 struct mempolicy
*oldpol
;
182 cpumask_t oldmask
= current
->cpus_allowed
;
183 int node
= pcibus_to_node(dev
->bus
);
184 if (node
>= 0 && node_online(node
))
185 set_cpus_allowed(current
, node_to_cpumask(node
));
186 /* And set default memory allocation policy */
187 oldpol
= current
->mempolicy
;
188 current
->mempolicy
= &default_policy
;
189 mpol_get(current
->mempolicy
);
191 error
= drv
->probe(dev
, id
);
193 set_cpus_allowed(current
, oldmask
);
194 mpol_free(current
->mempolicy
);
195 current
->mempolicy
= oldpol
;
201 * __pci_device_probe()
202 * @drv: driver to call to check if it wants the PCI device
203 * @pci_dev: PCI device being probed
205 * returns 0 on success, else error.
206 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
209 __pci_device_probe(struct pci_driver
*drv
, struct pci_dev
*pci_dev
)
211 const struct pci_device_id
*id
;
214 if (!pci_dev
->driver
&& drv
->probe
) {
217 id
= pci_match_device(drv
, pci_dev
);
219 error
= pci_call_probe(drv
, pci_dev
, id
);
221 pci_dev
->driver
= drv
;
228 static int pci_device_probe(struct device
* dev
)
231 struct pci_driver
*drv
;
232 struct pci_dev
*pci_dev
;
234 drv
= to_pci_driver(dev
->driver
);
235 pci_dev
= to_pci_dev(dev
);
236 pci_dev_get(pci_dev
);
237 error
= __pci_device_probe(drv
, pci_dev
);
239 pci_dev_put(pci_dev
);
244 static int pci_device_remove(struct device
* dev
)
246 struct pci_dev
* pci_dev
= to_pci_dev(dev
);
247 struct pci_driver
* drv
= pci_dev
->driver
;
251 drv
->remove(pci_dev
);
252 pci_dev
->driver
= NULL
;
256 * We would love to complain here if pci_dev->is_enabled is set, that
257 * the driver should have called pci_disable_device(), but the
258 * unfortunate fact is there are too many odd BIOS and bridge setups
259 * that don't like drivers doing that all of the time.
260 * Oh well, we can dream of sane hardware when we sleep, no matter how
261 * horrible the crap we have to deal with is when we are awake...
264 pci_dev_put(pci_dev
);
268 static int pci_device_suspend(struct device
* dev
, pm_message_t state
)
270 struct pci_dev
* pci_dev
= to_pci_dev(dev
);
271 struct pci_driver
* drv
= pci_dev
->driver
;
274 if (drv
&& drv
->suspend
) {
275 i
= drv
->suspend(pci_dev
, state
);
276 suspend_report_result(drv
->suspend
, i
);
278 pci_save_state(pci_dev
);
285 * Default resume method for devices that have no driver provided resume,
286 * or not even a driver at all.
288 static int pci_default_resume(struct pci_dev
*pci_dev
)
292 /* restore the PCI config space */
293 pci_restore_state(pci_dev
);
294 /* if the device was enabled before suspend, reenable */
295 if (pci_dev
->is_enabled
)
296 retval
= pci_enable_device(pci_dev
);
297 /* if the device was busmaster before the suspend, make it busmaster again */
298 if (pci_dev
->is_busmaster
)
299 pci_set_master(pci_dev
);
304 static int pci_device_resume(struct device
* dev
)
307 struct pci_dev
* pci_dev
= to_pci_dev(dev
);
308 struct pci_driver
* drv
= pci_dev
->driver
;
310 if (drv
&& drv
->resume
)
311 error
= drv
->resume(pci_dev
);
313 error
= pci_default_resume(pci_dev
);
317 static void pci_device_shutdown(struct device
*dev
)
319 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
320 struct pci_driver
*drv
= pci_dev
->driver
;
322 if (drv
&& drv
->shutdown
)
323 drv
->shutdown(pci_dev
);
326 #define kobj_to_pci_driver(obj) container_of(obj, struct device_driver, kobj)
327 #define attr_to_driver_attribute(obj) container_of(obj, struct driver_attribute, attr)
330 pci_driver_attr_show(struct kobject
* kobj
, struct attribute
*attr
, char *buf
)
332 struct device_driver
*driver
= kobj_to_pci_driver(kobj
);
333 struct driver_attribute
*dattr
= attr_to_driver_attribute(attr
);
336 if (!get_driver(driver
))
339 ret
= dattr
->show
? dattr
->show(driver
, buf
) : -EIO
;
346 pci_driver_attr_store(struct kobject
* kobj
, struct attribute
*attr
,
347 const char *buf
, size_t count
)
349 struct device_driver
*driver
= kobj_to_pci_driver(kobj
);
350 struct driver_attribute
*dattr
= attr_to_driver_attribute(attr
);
353 if (!get_driver(driver
))
356 ret
= dattr
->store
? dattr
->store(driver
, buf
, count
) : -EIO
;
362 static struct sysfs_ops pci_driver_sysfs_ops
= {
363 .show
= pci_driver_attr_show
,
364 .store
= pci_driver_attr_store
,
366 static struct kobj_type pci_driver_kobj_type
= {
367 .sysfs_ops
= &pci_driver_sysfs_ops
,
371 * __pci_register_driver - register a new pci driver
372 * @drv: the driver structure to register
373 * @owner: owner module of drv
375 * Adds the driver structure to the list of registered drivers.
376 * Returns a negative value on error, otherwise 0.
377 * If no error occurred, the driver remains registered even if
378 * no device was claimed during registration.
380 int __pci_register_driver(struct pci_driver
*drv
, struct module
*owner
)
384 /* initialize common driver fields */
385 drv
->driver
.name
= drv
->name
;
386 drv
->driver
.bus
= &pci_bus_type
;
387 drv
->driver
.owner
= owner
;
388 drv
->driver
.kobj
.ktype
= &pci_driver_kobj_type
;
390 spin_lock_init(&drv
->dynids
.lock
);
391 INIT_LIST_HEAD(&drv
->dynids
.list
);
393 /* register with core */
394 error
= driver_register(&drv
->driver
);
397 error
= pci_create_newid_file(drv
);
403 * pci_unregister_driver - unregister a pci driver
404 * @drv: the driver structure to unregister
406 * Deletes the driver structure from the list of registered PCI drivers,
407 * gives it a chance to clean up by calling its remove() function for
408 * each device it was responsible for, and marks those devices as
413 pci_unregister_driver(struct pci_driver
*drv
)
415 driver_unregister(&drv
->driver
);
416 pci_free_dynids(drv
);
419 static struct pci_driver pci_compat_driver
= {
424 * pci_dev_driver - get the pci_driver of a device
425 * @dev: the device to query
427 * Returns the appropriate pci_driver structure or %NULL if there is no
428 * registered driver for the device.
431 pci_dev_driver(const struct pci_dev
*dev
)
437 for(i
=0; i
<=PCI_ROM_RESOURCE
; i
++)
438 if (dev
->resource
[i
].flags
& IORESOURCE_BUSY
)
439 return &pci_compat_driver
;
445 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
446 * @dev: the PCI device structure to match against
447 * @drv: the device driver to search for matching PCI device id structures
449 * Used by a driver to check whether a PCI device present in the
450 * system is in its list of supported devices. Returns the matching
451 * pci_device_id structure or %NULL if there is no match.
453 static int pci_bus_match(struct device
*dev
, struct device_driver
*drv
)
455 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
456 struct pci_driver
*pci_drv
= to_pci_driver(drv
);
457 const struct pci_device_id
*found_id
;
459 found_id
= pci_match_device(pci_drv
, pci_dev
);
467 * pci_dev_get - increments the reference count of the pci device structure
468 * @dev: the device being referenced
470 * Each live reference to a device should be refcounted.
472 * Drivers for PCI devices should normally record such references in
473 * their probe() methods, when they bind to a device, and release
474 * them by calling pci_dev_put(), in their disconnect() methods.
476 * A pointer to the device with the incremented reference counter is returned.
478 struct pci_dev
*pci_dev_get(struct pci_dev
*dev
)
481 get_device(&dev
->dev
);
486 * pci_dev_put - release a use of the pci device structure
487 * @dev: device that's been disconnected
489 * Must be called when a user of a device is finished with it. When the last
490 * user of the device calls this function, the memory of the device is freed.
492 void pci_dev_put(struct pci_dev
*dev
)
495 put_device(&dev
->dev
);
498 #ifndef CONFIG_HOTPLUG
499 int pci_uevent(struct device
*dev
, char **envp
, int num_envp
,
500 char *buffer
, int buffer_size
)
506 struct bus_type pci_bus_type
= {
508 .match
= pci_bus_match
,
509 .uevent
= pci_uevent
,
510 .probe
= pci_device_probe
,
511 .remove
= pci_device_remove
,
512 .suspend
= pci_device_suspend
,
513 .shutdown
= pci_device_shutdown
,
514 .resume
= pci_device_resume
,
515 .dev_attrs
= pci_dev_attrs
,
518 static int __init
pci_driver_init(void)
520 return bus_register(&pci_bus_type
);
523 postcore_initcall(pci_driver_init
);
525 EXPORT_SYMBOL(pci_match_id
);
526 EXPORT_SYMBOL(pci_match_device
);
527 EXPORT_SYMBOL(__pci_register_driver
);
528 EXPORT_SYMBOL(pci_unregister_driver
);
529 EXPORT_SYMBOL(pci_dev_driver
);
530 EXPORT_SYMBOL(pci_bus_type
);
531 EXPORT_SYMBOL(pci_dev_get
);
532 EXPORT_SYMBOL(pci_dev_put
);