]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * drivers/pci/pci-driver.c | |
3 | * | |
4 | */ | |
5 | ||
6 | #include <linux/pci.h> | |
7 | #include <linux/module.h> | |
8 | #include <linux/init.h> | |
9 | #include <linux/device.h> | |
d42c6997 | 10 | #include <linux/mempolicy.h> |
1da177e4 LT |
11 | #include "pci.h" |
12 | ||
13 | /* | |
14 | * Registration of PCI drivers and handling of hot-pluggable devices. | |
15 | */ | |
16 | ||
17 | /* | |
18 | * Dynamic device IDs are disabled for !CONFIG_HOTPLUG | |
19 | */ | |
20 | ||
75865858 GKH |
21 | struct pci_dynid { |
22 | struct list_head node; | |
23 | struct pci_device_id id; | |
24 | }; | |
1da177e4 | 25 | |
3d3c2ae1 GKH |
26 | #ifdef CONFIG_HOTPLUG |
27 | ||
1da177e4 LT |
28 | /** |
29 | * store_new_id | |
30 | * | |
31 | * Adds a new dynamic pci device ID to this driver, | |
32 | * and causes the driver to probe for all devices again. | |
33 | */ | |
34 | static inline ssize_t | |
35 | store_new_id(struct device_driver *driver, const char *buf, size_t count) | |
36 | { | |
75865858 | 37 | struct pci_dynid *dynid; |
1da177e4 LT |
38 | struct pci_driver *pdrv = to_pci_driver(driver); |
39 | __u32 vendor=PCI_ANY_ID, device=PCI_ANY_ID, subvendor=PCI_ANY_ID, | |
40 | subdevice=PCI_ANY_ID, class=0, class_mask=0; | |
41 | unsigned long driver_data=0; | |
42 | int fields=0; | |
43 | ||
44 | fields = sscanf(buf, "%x %x %x %x %x %x %lux", | |
45 | &vendor, &device, &subvendor, &subdevice, | |
46 | &class, &class_mask, &driver_data); | |
47 | if (fields < 0) | |
48 | return -EINVAL; | |
49 | ||
50 | dynid = kmalloc(sizeof(*dynid), GFP_KERNEL); | |
51 | if (!dynid) | |
52 | return -ENOMEM; | |
53 | ||
54 | memset(dynid, 0, sizeof(*dynid)); | |
55 | INIT_LIST_HEAD(&dynid->node); | |
56 | dynid->id.vendor = vendor; | |
57 | dynid->id.device = device; | |
58 | dynid->id.subvendor = subvendor; | |
59 | dynid->id.subdevice = subdevice; | |
60 | dynid->id.class = class; | |
61 | dynid->id.class_mask = class_mask; | |
62 | dynid->id.driver_data = pdrv->dynids.use_driver_data ? | |
63 | driver_data : 0UL; | |
64 | ||
65 | spin_lock(&pdrv->dynids.lock); | |
66 | list_add_tail(&pdrv->dynids.list, &dynid->node); | |
67 | spin_unlock(&pdrv->dynids.lock); | |
68 | ||
75865858 GKH |
69 | if (get_driver(&pdrv->driver)) { |
70 | driver_attach(&pdrv->driver); | |
71 | put_driver(&pdrv->driver); | |
1da177e4 LT |
72 | } |
73 | ||
74 | return count; | |
75 | } | |
1da177e4 | 76 | static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id); |
1da177e4 LT |
77 | |
78 | static void | |
79 | pci_free_dynids(struct pci_driver *drv) | |
80 | { | |
75865858 | 81 | struct pci_dynid *dynid, *n; |
1da177e4 LT |
82 | |
83 | spin_lock(&drv->dynids.lock); | |
75865858 | 84 | list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) { |
1da177e4 LT |
85 | list_del(&dynid->node); |
86 | kfree(dynid); | |
87 | } | |
88 | spin_unlock(&drv->dynids.lock); | |
89 | } | |
90 | ||
91 | static int | |
92 | pci_create_newid_file(struct pci_driver *drv) | |
93 | { | |
94 | int error = 0; | |
95 | if (drv->probe != NULL) | |
96 | error = sysfs_create_file(&drv->driver.kobj, | |
97 | &driver_attr_new_id.attr); | |
98 | return error; | |
99 | } | |
100 | ||
1da177e4 | 101 | #else /* !CONFIG_HOTPLUG */ |
1da177e4 LT |
102 | static inline void pci_free_dynids(struct pci_driver *drv) {} |
103 | static inline int pci_create_newid_file(struct pci_driver *drv) | |
104 | { | |
105 | return 0; | |
106 | } | |
1da177e4 LT |
107 | #endif |
108 | ||
109 | /** | |
75865858 | 110 | * pci_match_id - See if a pci device matches a given pci_id table |
1da177e4 | 111 | * @ids: array of PCI device id structures to search in |
75865858 GKH |
112 | * @dev: the PCI device structure to match against. |
113 | * | |
1da177e4 | 114 | * Used by a driver to check whether a PCI device present in the |
75865858 | 115 | * system is in its list of supported devices. Returns the matching |
1da177e4 | 116 | * pci_device_id structure or %NULL if there is no match. |
75865858 GKH |
117 | * |
118 | * Depreciated, don't use this as it will not catch any dynamic ids | |
119 | * that a driver might want to check for. | |
1da177e4 | 120 | */ |
75865858 GKH |
121 | const struct pci_device_id *pci_match_id(const struct pci_device_id *ids, |
122 | struct pci_dev *dev) | |
1da177e4 | 123 | { |
75865858 GKH |
124 | if (ids) { |
125 | while (ids->vendor || ids->subvendor || ids->class_mask) { | |
126 | if (pci_match_one_device(ids, dev)) | |
127 | return ids; | |
128 | ids++; | |
129 | } | |
1da177e4 LT |
130 | } |
131 | return NULL; | |
132 | } | |
133 | ||
134 | /** | |
75865858 GKH |
135 | * pci_match_device - Tell if a PCI device structure has a matching |
136 | * PCI device id structure | |
137 | * @ids: array of PCI device id structures to search in | |
138 | * @dev: the PCI device structure to match against | |
139 | * @drv: the PCI driver to match against | |
140 | * | |
141 | * Used by a driver to check whether a PCI device present in the | |
142 | * system is in its list of supported devices. Returns the matching | |
143 | * pci_device_id structure or %NULL if there is no match. | |
1da177e4 | 144 | */ |
75865858 GKH |
145 | const struct pci_device_id *pci_match_device(struct pci_driver *drv, |
146 | struct pci_dev *dev) | |
147 | { | |
1da177e4 | 148 | const struct pci_device_id *id; |
75865858 | 149 | struct pci_dynid *dynid; |
1da177e4 | 150 | |
75865858 | 151 | id = pci_match_id(drv->id_table, dev); |
1da177e4 | 152 | if (id) |
75865858 GKH |
153 | return id; |
154 | ||
155 | /* static ids didn't match, lets look at the dynamic ones */ | |
156 | spin_lock(&drv->dynids.lock); | |
157 | list_for_each_entry(dynid, &drv->dynids.list, node) { | |
158 | if (pci_match_one_device(&dynid->id, dev)) { | |
159 | spin_unlock(&drv->dynids.lock); | |
160 | return &dynid->id; | |
161 | } | |
1da177e4 | 162 | } |
75865858 GKH |
163 | spin_unlock(&drv->dynids.lock); |
164 | return NULL; | |
1da177e4 LT |
165 | } |
166 | ||
d42c6997 AK |
167 | static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev, |
168 | const struct pci_device_id *id) | |
169 | { | |
170 | int error; | |
171 | #ifdef CONFIG_NUMA | |
172 | /* Execute driver initialization on node where the | |
173 | device's bus is attached to. This way the driver likely | |
174 | allocates its local memory on the right node without | |
175 | any need to change it. */ | |
176 | struct mempolicy *oldpol; | |
177 | cpumask_t oldmask = current->cpus_allowed; | |
178 | int node = pcibus_to_node(dev->bus); | |
179 | if (node >= 0 && node_online(node)) | |
180 | set_cpus_allowed(current, node_to_cpumask(node)); | |
181 | /* And set default memory allocation policy */ | |
182 | oldpol = current->mempolicy; | |
183 | current->mempolicy = &default_policy; | |
184 | mpol_get(current->mempolicy); | |
185 | #endif | |
186 | error = drv->probe(dev, id); | |
187 | #ifdef CONFIG_NUMA | |
188 | set_cpus_allowed(current, oldmask); | |
189 | mpol_free(current->mempolicy); | |
190 | current->mempolicy = oldpol; | |
191 | #endif | |
192 | return error; | |
193 | } | |
194 | ||
1da177e4 LT |
195 | /** |
196 | * __pci_device_probe() | |
197 | * | |
198 | * returns 0 on success, else error. | |
199 | * side-effect: pci_dev->driver is set to drv when drv claims pci_dev. | |
200 | */ | |
201 | static int | |
202 | __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev) | |
75865858 GKH |
203 | { |
204 | const struct pci_device_id *id; | |
1da177e4 LT |
205 | int error = 0; |
206 | ||
207 | if (!pci_dev->driver && drv->probe) { | |
75865858 GKH |
208 | error = -ENODEV; |
209 | ||
210 | id = pci_match_device(drv, pci_dev); | |
211 | if (id) | |
d42c6997 | 212 | error = pci_call_probe(drv, pci_dev, id); |
75865858 GKH |
213 | if (error >= 0) { |
214 | pci_dev->driver = drv; | |
215 | error = 0; | |
216 | } | |
1da177e4 LT |
217 | } |
218 | return error; | |
219 | } | |
220 | ||
221 | static int pci_device_probe(struct device * dev) | |
222 | { | |
223 | int error = 0; | |
224 | struct pci_driver *drv; | |
225 | struct pci_dev *pci_dev; | |
226 | ||
227 | drv = to_pci_driver(dev->driver); | |
228 | pci_dev = to_pci_dev(dev); | |
229 | pci_dev_get(pci_dev); | |
230 | error = __pci_device_probe(drv, pci_dev); | |
231 | if (error) | |
232 | pci_dev_put(pci_dev); | |
233 | ||
234 | return error; | |
235 | } | |
236 | ||
237 | static int pci_device_remove(struct device * dev) | |
238 | { | |
239 | struct pci_dev * pci_dev = to_pci_dev(dev); | |
240 | struct pci_driver * drv = pci_dev->driver; | |
241 | ||
242 | if (drv) { | |
243 | if (drv->remove) | |
244 | drv->remove(pci_dev); | |
245 | pci_dev->driver = NULL; | |
246 | } | |
247 | ||
248 | /* | |
249 | * We would love to complain here if pci_dev->is_enabled is set, that | |
250 | * the driver should have called pci_disable_device(), but the | |
251 | * unfortunate fact is there are too many odd BIOS and bridge setups | |
252 | * that don't like drivers doing that all of the time. | |
253 | * Oh well, we can dream of sane hardware when we sleep, no matter how | |
254 | * horrible the crap we have to deal with is when we are awake... | |
255 | */ | |
256 | ||
257 | pci_dev_put(pci_dev); | |
258 | return 0; | |
259 | } | |
260 | ||
261 | static int pci_device_suspend(struct device * dev, pm_message_t state) | |
262 | { | |
263 | struct pci_dev * pci_dev = to_pci_dev(dev); | |
264 | struct pci_driver * drv = pci_dev->driver; | |
265 | int i = 0; | |
266 | ||
267 | if (drv && drv->suspend) | |
268 | i = drv->suspend(pci_dev, state); | |
269 | else | |
270 | pci_save_state(pci_dev); | |
271 | return i; | |
272 | } | |
273 | ||
274 | ||
95a62965 | 275 | /* |
1da177e4 LT |
276 | * Default resume method for devices that have no driver provided resume, |
277 | * or not even a driver at all. | |
278 | */ | |
279 | static void pci_default_resume(struct pci_dev *pci_dev) | |
280 | { | |
95a62965 GKH |
281 | int retval; |
282 | ||
1da177e4 LT |
283 | /* restore the PCI config space */ |
284 | pci_restore_state(pci_dev); | |
285 | /* if the device was enabled before suspend, reenable */ | |
286 | if (pci_dev->is_enabled) | |
95a62965 | 287 | retval = pci_enable_device(pci_dev); |
1da177e4 LT |
288 | /* if the device was busmaster before the suspend, make it busmaster again */ |
289 | if (pci_dev->is_busmaster) | |
290 | pci_set_master(pci_dev); | |
291 | } | |
292 | ||
293 | static int pci_device_resume(struct device * dev) | |
294 | { | |
295 | struct pci_dev * pci_dev = to_pci_dev(dev); | |
296 | struct pci_driver * drv = pci_dev->driver; | |
297 | ||
298 | if (drv && drv->resume) | |
299 | drv->resume(pci_dev); | |
300 | else | |
301 | pci_default_resume(pci_dev); | |
302 | return 0; | |
303 | } | |
304 | ||
c8958177 GKH |
305 | static void pci_device_shutdown(struct device *dev) |
306 | { | |
307 | struct pci_dev *pci_dev = to_pci_dev(dev); | |
308 | struct pci_driver *drv = pci_dev->driver; | |
309 | ||
310 | if (drv && drv->shutdown) | |
311 | drv->shutdown(pci_dev); | |
312 | } | |
1da177e4 LT |
313 | |
314 | #define kobj_to_pci_driver(obj) container_of(obj, struct device_driver, kobj) | |
315 | #define attr_to_driver_attribute(obj) container_of(obj, struct driver_attribute, attr) | |
316 | ||
317 | static ssize_t | |
318 | pci_driver_attr_show(struct kobject * kobj, struct attribute *attr, char *buf) | |
319 | { | |
320 | struct device_driver *driver = kobj_to_pci_driver(kobj); | |
321 | struct driver_attribute *dattr = attr_to_driver_attribute(attr); | |
fc7e4828 | 322 | ssize_t ret; |
1da177e4 | 323 | |
fc7e4828 DT |
324 | if (!get_driver(driver)) |
325 | return -ENODEV; | |
326 | ||
327 | ret = dattr->show ? dattr->show(driver, buf) : -EIO; | |
328 | ||
329 | put_driver(driver); | |
1da177e4 LT |
330 | return ret; |
331 | } | |
332 | ||
333 | static ssize_t | |
334 | pci_driver_attr_store(struct kobject * kobj, struct attribute *attr, | |
335 | const char *buf, size_t count) | |
336 | { | |
337 | struct device_driver *driver = kobj_to_pci_driver(kobj); | |
338 | struct driver_attribute *dattr = attr_to_driver_attribute(attr); | |
fc7e4828 | 339 | ssize_t ret; |
1da177e4 | 340 | |
fc7e4828 DT |
341 | if (!get_driver(driver)) |
342 | return -ENODEV; | |
343 | ||
344 | ret = dattr->store ? dattr->store(driver, buf, count) : -EIO; | |
345 | ||
346 | put_driver(driver); | |
1da177e4 LT |
347 | return ret; |
348 | } | |
349 | ||
350 | static struct sysfs_ops pci_driver_sysfs_ops = { | |
351 | .show = pci_driver_attr_show, | |
352 | .store = pci_driver_attr_store, | |
353 | }; | |
354 | static struct kobj_type pci_driver_kobj_type = { | |
355 | .sysfs_ops = &pci_driver_sysfs_ops, | |
356 | }; | |
357 | ||
1da177e4 LT |
358 | /** |
359 | * pci_register_driver - register a new pci driver | |
360 | * @drv: the driver structure to register | |
361 | * | |
362 | * Adds the driver structure to the list of registered drivers. | |
363 | * Returns a negative value on error, otherwise 0. | |
eaae4b3a | 364 | * If no error occurred, the driver remains registered even if |
1da177e4 LT |
365 | * no device was claimed during registration. |
366 | */ | |
367 | int pci_register_driver(struct pci_driver *drv) | |
368 | { | |
369 | int error; | |
370 | ||
371 | /* initialize common driver fields */ | |
372 | drv->driver.name = drv->name; | |
373 | drv->driver.bus = &pci_bus_type; | |
374 | drv->driver.probe = pci_device_probe; | |
375 | drv->driver.remove = pci_device_remove; | |
794f5bfa CH |
376 | /* FIXME, once all of the existing PCI drivers have been fixed to set |
377 | * the pci shutdown function, this test can go away. */ | |
378 | if (!drv->driver.shutdown) | |
c83d9945 | 379 | drv->driver.shutdown = pci_device_shutdown; |
1da177e4 LT |
380 | drv->driver.owner = drv->owner; |
381 | drv->driver.kobj.ktype = &pci_driver_kobj_type; | |
75865858 GKH |
382 | |
383 | spin_lock_init(&drv->dynids.lock); | |
384 | INIT_LIST_HEAD(&drv->dynids.list); | |
1da177e4 LT |
385 | |
386 | /* register with core */ | |
387 | error = driver_register(&drv->driver); | |
388 | ||
389 | if (!error) | |
75865858 | 390 | error = pci_create_newid_file(drv); |
1da177e4 LT |
391 | |
392 | return error; | |
393 | } | |
394 | ||
395 | /** | |
396 | * pci_unregister_driver - unregister a pci driver | |
397 | * @drv: the driver structure to unregister | |
398 | * | |
399 | * Deletes the driver structure from the list of registered PCI drivers, | |
400 | * gives it a chance to clean up by calling its remove() function for | |
401 | * each device it was responsible for, and marks those devices as | |
402 | * driverless. | |
403 | */ | |
404 | ||
405 | void | |
406 | pci_unregister_driver(struct pci_driver *drv) | |
407 | { | |
408 | driver_unregister(&drv->driver); | |
409 | pci_free_dynids(drv); | |
410 | } | |
411 | ||
412 | static struct pci_driver pci_compat_driver = { | |
413 | .name = "compat" | |
414 | }; | |
415 | ||
416 | /** | |
417 | * pci_dev_driver - get the pci_driver of a device | |
418 | * @dev: the device to query | |
419 | * | |
420 | * Returns the appropriate pci_driver structure or %NULL if there is no | |
421 | * registered driver for the device. | |
422 | */ | |
423 | struct pci_driver * | |
424 | pci_dev_driver(const struct pci_dev *dev) | |
425 | { | |
426 | if (dev->driver) | |
427 | return dev->driver; | |
428 | else { | |
429 | int i; | |
430 | for(i=0; i<=PCI_ROM_RESOURCE; i++) | |
431 | if (dev->resource[i].flags & IORESOURCE_BUSY) | |
432 | return &pci_compat_driver; | |
433 | } | |
434 | return NULL; | |
435 | } | |
436 | ||
437 | /** | |
438 | * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure | |
439 | * @ids: array of PCI device id structures to search in | |
440 | * @dev: the PCI device structure to match against | |
441 | * | |
442 | * Used by a driver to check whether a PCI device present in the | |
443 | * system is in its list of supported devices.Returns the matching | |
444 | * pci_device_id structure or %NULL if there is no match. | |
445 | */ | |
75865858 | 446 | static int pci_bus_match(struct device *dev, struct device_driver *drv) |
1da177e4 | 447 | { |
75865858 GKH |
448 | struct pci_dev *pci_dev = to_pci_dev(dev); |
449 | struct pci_driver *pci_drv = to_pci_driver(drv); | |
1da177e4 LT |
450 | const struct pci_device_id *found_id; |
451 | ||
75865858 | 452 | found_id = pci_match_device(pci_drv, pci_dev); |
1da177e4 LT |
453 | if (found_id) |
454 | return 1; | |
455 | ||
75865858 | 456 | return 0; |
1da177e4 LT |
457 | } |
458 | ||
459 | /** | |
460 | * pci_dev_get - increments the reference count of the pci device structure | |
461 | * @dev: the device being referenced | |
462 | * | |
463 | * Each live reference to a device should be refcounted. | |
464 | * | |
465 | * Drivers for PCI devices should normally record such references in | |
466 | * their probe() methods, when they bind to a device, and release | |
467 | * them by calling pci_dev_put(), in their disconnect() methods. | |
468 | * | |
469 | * A pointer to the device with the incremented reference counter is returned. | |
470 | */ | |
471 | struct pci_dev *pci_dev_get(struct pci_dev *dev) | |
472 | { | |
473 | if (dev) | |
474 | get_device(&dev->dev); | |
475 | return dev; | |
476 | } | |
477 | ||
478 | /** | |
479 | * pci_dev_put - release a use of the pci device structure | |
480 | * @dev: device that's been disconnected | |
481 | * | |
482 | * Must be called when a user of a device is finished with it. When the last | |
483 | * user of the device calls this function, the memory of the device is freed. | |
484 | */ | |
485 | void pci_dev_put(struct pci_dev *dev) | |
486 | { | |
487 | if (dev) | |
488 | put_device(&dev->dev); | |
489 | } | |
490 | ||
491 | #ifndef CONFIG_HOTPLUG | |
492 | int pci_hotplug (struct device *dev, char **envp, int num_envp, | |
493 | char *buffer, int buffer_size) | |
494 | { | |
495 | return -ENODEV; | |
496 | } | |
497 | #endif | |
498 | ||
499 | struct bus_type pci_bus_type = { | |
500 | .name = "pci", | |
501 | .match = pci_bus_match, | |
502 | .hotplug = pci_hotplug, | |
503 | .suspend = pci_device_suspend, | |
504 | .resume = pci_device_resume, | |
505 | .dev_attrs = pci_dev_attrs, | |
506 | }; | |
507 | ||
508 | static int __init pci_driver_init(void) | |
509 | { | |
510 | return bus_register(&pci_bus_type); | |
511 | } | |
512 | ||
513 | postcore_initcall(pci_driver_init); | |
514 | ||
75865858 | 515 | EXPORT_SYMBOL(pci_match_id); |
1da177e4 LT |
516 | EXPORT_SYMBOL(pci_match_device); |
517 | EXPORT_SYMBOL(pci_register_driver); | |
518 | EXPORT_SYMBOL(pci_unregister_driver); | |
519 | EXPORT_SYMBOL(pci_dev_driver); | |
520 | EXPORT_SYMBOL(pci_bus_type); | |
521 | EXPORT_SYMBOL(pci_dev_get); | |
522 | EXPORT_SYMBOL(pci_dev_put); |