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
= kmalloc(sizeof(*dynid
), GFP_KERNEL
);
60 memset(dynid
, 0, sizeof(*dynid
));
61 INIT_LIST_HEAD(&dynid
->node
);
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(&pdrv
->dynids
.list
, &dynid
->node
);
73 spin_unlock(&pdrv
->dynids
.lock
);
75 if (get_driver(&pdrv
->driver
)) {
76 driver_attach(&pdrv
->driver
);
77 put_driver(&pdrv
->driver
);
82 static DRIVER_ATTR(new_id
, S_IWUSR
, NULL
, store_new_id
);
85 pci_free_dynids(struct pci_driver
*drv
)
87 struct pci_dynid
*dynid
, *n
;
89 spin_lock(&drv
->dynids
.lock
);
90 list_for_each_entry_safe(dynid
, n
, &drv
->dynids
.list
, node
) {
91 list_del(&dynid
->node
);
94 spin_unlock(&drv
->dynids
.lock
);
98 pci_create_newid_file(struct pci_driver
*drv
)
101 if (drv
->probe
!= NULL
)
102 error
= sysfs_create_file(&drv
->driver
.kobj
,
103 &driver_attr_new_id
.attr
);
107 #else /* !CONFIG_HOTPLUG */
108 static inline void pci_free_dynids(struct pci_driver
*drv
) {}
109 static inline int pci_create_newid_file(struct pci_driver
*drv
)
116 * pci_match_id - See if a pci device matches a given pci_id table
117 * @ids: array of PCI device id structures to search in
118 * @dev: the PCI device structure to match against.
120 * Used by a driver to check whether a PCI device present in the
121 * system is in its list of supported devices. Returns the matching
122 * pci_device_id structure or %NULL if there is no match.
124 * Depreciated, don't use this as it will not catch any dynamic ids
125 * that a driver might want to check for.
127 const struct pci_device_id
*pci_match_id(const struct pci_device_id
*ids
,
131 while (ids
->vendor
|| ids
->subvendor
|| ids
->class_mask
) {
132 if (pci_match_one_device(ids
, dev
))
141 * pci_match_device - Tell if a PCI device structure has a matching
142 * PCI device id structure
143 * @ids: array of PCI device id structures to search in
144 * @dev: the PCI device structure to match against
145 * @drv: the PCI driver to match against
147 * Used by a driver to check whether a PCI device present in the
148 * system is in its list of supported devices. Returns the matching
149 * pci_device_id structure or %NULL if there is no match.
151 const struct pci_device_id
*pci_match_device(struct pci_driver
*drv
,
154 const struct pci_device_id
*id
;
155 struct pci_dynid
*dynid
;
157 id
= pci_match_id(drv
->id_table
, dev
);
161 /* static ids didn't match, lets look at the dynamic ones */
162 spin_lock(&drv
->dynids
.lock
);
163 list_for_each_entry(dynid
, &drv
->dynids
.list
, node
) {
164 if (pci_match_one_device(&dynid
->id
, dev
)) {
165 spin_unlock(&drv
->dynids
.lock
);
169 spin_unlock(&drv
->dynids
.lock
);
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
);
185 if (node
>= 0 && node_online(node
))
186 set_cpus_allowed(current
, node_to_cpumask(node
));
187 /* And set default memory allocation policy */
188 oldpol
= current
->mempolicy
;
189 current
->mempolicy
= &default_policy
;
190 mpol_get(current
->mempolicy
);
192 error
= drv
->probe(dev
, id
);
194 set_cpus_allowed(current
, oldmask
);
195 mpol_free(current
->mempolicy
);
196 current
->mempolicy
= oldpol
;
202 * __pci_device_probe()
203 * @drv: driver to call to check if it wants the PCI device
204 * @pci_dev: PCI device being probed
206 * returns 0 on success, else error.
207 * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
210 __pci_device_probe(struct pci_driver
*drv
, struct pci_dev
*pci_dev
)
212 const struct pci_device_id
*id
;
215 if (!pci_dev
->driver
&& drv
->probe
) {
218 id
= pci_match_device(drv
, pci_dev
);
220 error
= pci_call_probe(drv
, pci_dev
, id
);
222 pci_dev
->driver
= drv
;
229 static int pci_device_probe(struct device
* dev
)
232 struct pci_driver
*drv
;
233 struct pci_dev
*pci_dev
;
235 drv
= to_pci_driver(dev
->driver
);
236 pci_dev
= to_pci_dev(dev
);
237 pci_dev_get(pci_dev
);
238 error
= __pci_device_probe(drv
, pci_dev
);
240 pci_dev_put(pci_dev
);
245 static int pci_device_remove(struct device
* dev
)
247 struct pci_dev
* pci_dev
= to_pci_dev(dev
);
248 struct pci_driver
* drv
= pci_dev
->driver
;
252 drv
->remove(pci_dev
);
253 pci_dev
->driver
= NULL
;
257 * We would love to complain here if pci_dev->is_enabled is set, that
258 * the driver should have called pci_disable_device(), but the
259 * unfortunate fact is there are too many odd BIOS and bridge setups
260 * that don't like drivers doing that all of the time.
261 * Oh well, we can dream of sane hardware when we sleep, no matter how
262 * horrible the crap we have to deal with is when we are awake...
265 pci_dev_put(pci_dev
);
269 static int pci_device_suspend(struct device
* dev
, pm_message_t state
)
271 struct pci_dev
* pci_dev
= to_pci_dev(dev
);
272 struct pci_driver
* drv
= pci_dev
->driver
;
275 if (drv
&& drv
->suspend
)
276 i
= drv
->suspend(pci_dev
, state
);
278 pci_save_state(pci_dev
);
284 * Default resume method for devices that have no driver provided resume,
285 * or not even a driver at all.
287 static void pci_default_resume(struct pci_dev
*pci_dev
)
291 /* restore the PCI config space */
292 pci_restore_state(pci_dev
);
293 /* if the device was enabled before suspend, reenable */
294 if (pci_dev
->is_enabled
)
295 retval
= pci_enable_device(pci_dev
);
296 /* if the device was busmaster before the suspend, make it busmaster again */
297 if (pci_dev
->is_busmaster
)
298 pci_set_master(pci_dev
);
301 static int pci_device_resume(struct device
* dev
)
303 struct pci_dev
* pci_dev
= to_pci_dev(dev
);
304 struct pci_driver
* drv
= pci_dev
->driver
;
306 if (drv
&& drv
->resume
)
307 drv
->resume(pci_dev
);
309 pci_default_resume(pci_dev
);
313 static void pci_device_shutdown(struct device
*dev
)
315 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
316 struct pci_driver
*drv
= pci_dev
->driver
;
318 if (drv
&& drv
->shutdown
)
319 drv
->shutdown(pci_dev
);
322 #define kobj_to_pci_driver(obj) container_of(obj, struct device_driver, kobj)
323 #define attr_to_driver_attribute(obj) container_of(obj, struct driver_attribute, attr)
326 pci_driver_attr_show(struct kobject
* kobj
, struct attribute
*attr
, char *buf
)
328 struct device_driver
*driver
= kobj_to_pci_driver(kobj
);
329 struct driver_attribute
*dattr
= attr_to_driver_attribute(attr
);
332 if (!get_driver(driver
))
335 ret
= dattr
->show
? dattr
->show(driver
, buf
) : -EIO
;
342 pci_driver_attr_store(struct kobject
* kobj
, struct attribute
*attr
,
343 const char *buf
, size_t count
)
345 struct device_driver
*driver
= kobj_to_pci_driver(kobj
);
346 struct driver_attribute
*dattr
= attr_to_driver_attribute(attr
);
349 if (!get_driver(driver
))
352 ret
= dattr
->store
? dattr
->store(driver
, buf
, count
) : -EIO
;
358 static struct sysfs_ops pci_driver_sysfs_ops
= {
359 .show
= pci_driver_attr_show
,
360 .store
= pci_driver_attr_store
,
362 static struct kobj_type pci_driver_kobj_type
= {
363 .sysfs_ops
= &pci_driver_sysfs_ops
,
367 * __pci_register_driver - register a new pci driver
368 * @drv: the driver structure to register
369 * @owner: owner module of drv
371 * Adds the driver structure to the list of registered drivers.
372 * Returns a negative value on error, otherwise 0.
373 * If no error occurred, the driver remains registered even if
374 * no device was claimed during registration.
376 int __pci_register_driver(struct pci_driver
*drv
, struct module
*owner
)
380 /* initialize common driver fields */
381 drv
->driver
.name
= drv
->name
;
382 drv
->driver
.bus
= &pci_bus_type
;
383 drv
->driver
.probe
= pci_device_probe
;
384 drv
->driver
.remove
= pci_device_remove
;
385 /* FIXME, once all of the existing PCI drivers have been fixed to set
386 * the pci shutdown function, this test can go away. */
387 if (!drv
->driver
.shutdown
)
388 drv
->driver
.shutdown
= pci_device_shutdown
;
390 printk(KERN_WARNING
"Warning: PCI driver %s has a struct "
391 "device_driver shutdown method, please update!\n",
393 drv
->driver
.owner
= owner
;
394 drv
->driver
.kobj
.ktype
= &pci_driver_kobj_type
;
396 spin_lock_init(&drv
->dynids
.lock
);
397 INIT_LIST_HEAD(&drv
->dynids
.list
);
399 /* register with core */
400 error
= driver_register(&drv
->driver
);
403 error
= pci_create_newid_file(drv
);
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 driver_unregister(&drv
->driver
);
422 pci_free_dynids(drv
);
425 static struct pci_driver pci_compat_driver
= {
430 * pci_dev_driver - get the pci_driver of a device
431 * @dev: the device to query
433 * Returns the appropriate pci_driver structure or %NULL if there is no
434 * registered driver for the device.
437 pci_dev_driver(const struct pci_dev
*dev
)
443 for(i
=0; i
<=PCI_ROM_RESOURCE
; i
++)
444 if (dev
->resource
[i
].flags
& IORESOURCE_BUSY
)
445 return &pci_compat_driver
;
451 * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
452 * @dev: the PCI device structure to match against
453 * @drv: the device driver to search for matching PCI device id structures
455 * Used by a driver to check whether a PCI device present in the
456 * system is in its list of supported devices. Returns the matching
457 * pci_device_id structure or %NULL if there is no match.
459 static int pci_bus_match(struct device
*dev
, struct device_driver
*drv
)
461 struct pci_dev
*pci_dev
= to_pci_dev(dev
);
462 struct pci_driver
*pci_drv
= to_pci_driver(drv
);
463 const struct pci_device_id
*found_id
;
465 found_id
= pci_match_device(pci_drv
, pci_dev
);
473 * pci_dev_get - increments the reference count of the pci device structure
474 * @dev: the device being referenced
476 * Each live reference to a device should be refcounted.
478 * Drivers for PCI devices should normally record such references in
479 * their probe() methods, when they bind to a device, and release
480 * them by calling pci_dev_put(), in their disconnect() methods.
482 * A pointer to the device with the incremented reference counter is returned.
484 struct pci_dev
*pci_dev_get(struct pci_dev
*dev
)
487 get_device(&dev
->dev
);
492 * pci_dev_put - release a use of the pci device structure
493 * @dev: device that's been disconnected
495 * Must be called when a user of a device is finished with it. When the last
496 * user of the device calls this function, the memory of the device is freed.
498 void pci_dev_put(struct pci_dev
*dev
)
501 put_device(&dev
->dev
);
504 #ifndef CONFIG_HOTPLUG
505 int pci_uevent(struct device
*dev
, char **envp
, int num_envp
,
506 char *buffer
, int buffer_size
)
512 struct bus_type pci_bus_type
= {
514 .match
= pci_bus_match
,
515 .uevent
= pci_uevent
,
516 .suspend
= pci_device_suspend
,
517 .resume
= pci_device_resume
,
518 .dev_attrs
= pci_dev_attrs
,
521 static int __init
pci_driver_init(void)
523 return bus_register(&pci_bus_type
);
526 postcore_initcall(pci_driver_init
);
528 EXPORT_SYMBOL(pci_match_id
);
529 EXPORT_SYMBOL(pci_match_device
);
530 EXPORT_SYMBOL(__pci_register_driver
);
531 EXPORT_SYMBOL(pci_unregister_driver
);
532 EXPORT_SYMBOL(pci_dev_driver
);
533 EXPORT_SYMBOL(pci_bus_type
);
534 EXPORT_SYMBOL(pci_dev_get
);
535 EXPORT_SYMBOL(pci_dev_put
);