Merge git://git.kernel.org/pub/scm/linux/kernel/git/paulus/powerpc-merge
[linux-2.6] / drivers / pci / pci-driver.c
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>
10 #include <linux/mempolicy.h>
11 #include <linux/string.h>
12 #include <linux/slab.h>
13 #include <linux/sched.h>
14 #include "pci.h"
15
16 /*
17  *  Registration of PCI drivers and handling of hot-pluggable devices.
18  */
19
20 /*
21  * Dynamic device IDs are disabled for !CONFIG_HOTPLUG
22  */
23
24 struct pci_dynid {
25         struct list_head node;
26         struct pci_device_id id;
27 };
28
29 #ifdef CONFIG_HOTPLUG
30
31 /**
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
35  * @count: input size
36  *
37  * Adds a new dynamic pci device ID to this driver,
38  * and causes the driver to probe for all devices again.
39  */
40 static ssize_t
41 store_new_id(struct device_driver *driver, const char *buf, size_t count)
42 {
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;
48         int fields=0;
49
50         fields = sscanf(buf, "%x %x %x %x %x %x %lux",
51                         &vendor, &device, &subvendor, &subdevice,
52                         &class, &class_mask, &driver_data);
53         if (fields < 0)
54                 return -EINVAL;
55
56         dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
57         if (!dynid)
58                 return -ENOMEM;
59
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 ?
68                 driver_data : 0UL;
69
70         spin_lock(&pdrv->dynids.lock);
71         list_add_tail(&pdrv->dynids.list, &dynid->node);
72         spin_unlock(&pdrv->dynids.lock);
73
74         if (get_driver(&pdrv->driver)) {
75                 driver_attach(&pdrv->driver);
76                 put_driver(&pdrv->driver);
77         }
78
79         return count;
80 }
81 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
82
83 static void
84 pci_free_dynids(struct pci_driver *drv)
85 {
86         struct pci_dynid *dynid, *n;
87
88         spin_lock(&drv->dynids.lock);
89         list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
90                 list_del(&dynid->node);
91                 kfree(dynid);
92         }
93         spin_unlock(&drv->dynids.lock);
94 }
95
96 static int
97 pci_create_newid_file(struct pci_driver *drv)
98 {
99         int error = 0;
100         if (drv->probe != NULL)
101                 error = sysfs_create_file(&drv->driver.kobj,
102                                           &driver_attr_new_id.attr);
103         return error;
104 }
105
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)
109 {
110         return 0;
111 }
112 #endif
113
114 /**
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.
118  *
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.
122  *
123  * Depreciated, don't use this as it will not catch any dynamic ids
124  * that a driver might want to check for.
125  */
126 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
127                                          struct pci_dev *dev)
128 {
129         if (ids) {
130                 while (ids->vendor || ids->subvendor || ids->class_mask) {
131                         if (pci_match_one_device(ids, dev))
132                                 return ids;
133                         ids++;
134                 }
135         }
136         return NULL;
137 }
138
139 /**
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
145  *
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.
149  */
150 const struct pci_device_id *pci_match_device(struct pci_driver *drv,
151                                              struct pci_dev *dev)
152 {
153         const struct pci_device_id *id;
154         struct pci_dynid *dynid;
155
156         id = pci_match_id(drv->id_table, dev);
157         if (id)
158                 return id;
159
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);
165                         return &dynid->id;
166                 }
167         }
168         spin_unlock(&drv->dynids.lock);
169         return NULL;
170 }
171
172 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
173                           const struct pci_device_id *id)
174 {
175         int error;
176 #ifdef CONFIG_NUMA
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);
190 #endif
191         error = drv->probe(dev, id);
192 #ifdef CONFIG_NUMA
193         set_cpus_allowed(current, oldmask);
194         mpol_free(current->mempolicy);
195         current->mempolicy = oldpol;
196 #endif
197         return error;
198 }
199
200 /**
201  * __pci_device_probe()
202  * @drv: driver to call to check if it wants the PCI device
203  * @pci_dev: PCI device being probed
204  * 
205  * returns 0 on success, else error.
206  * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
207  */
208 static int
209 __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
210 {
211         const struct pci_device_id *id;
212         int error = 0;
213
214         if (!pci_dev->driver && drv->probe) {
215                 error = -ENODEV;
216
217                 id = pci_match_device(drv, pci_dev);
218                 if (id)
219                         error = pci_call_probe(drv, pci_dev, id);
220                 if (error >= 0) {
221                         pci_dev->driver = drv;
222                         error = 0;
223                 }
224         }
225         return error;
226 }
227
228 static int pci_device_probe(struct device * dev)
229 {
230         int error = 0;
231         struct pci_driver *drv;
232         struct pci_dev *pci_dev;
233
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);
238         if (error)
239                 pci_dev_put(pci_dev);
240
241         return error;
242 }
243
244 static int pci_device_remove(struct device * dev)
245 {
246         struct pci_dev * pci_dev = to_pci_dev(dev);
247         struct pci_driver * drv = pci_dev->driver;
248
249         if (drv) {
250                 if (drv->remove)
251                         drv->remove(pci_dev);
252                 pci_dev->driver = NULL;
253         }
254
255         /*
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...
262          */
263
264         pci_dev_put(pci_dev);
265         return 0;
266 }
267
268 static int pci_device_suspend(struct device * dev, pm_message_t state)
269 {
270         struct pci_dev * pci_dev = to_pci_dev(dev);
271         struct pci_driver * drv = pci_dev->driver;
272         int i = 0;
273
274         if (drv && drv->suspend) {
275                 i = drv->suspend(pci_dev, state);
276                 suspend_report_result(drv->suspend, i);
277         } else {
278                 pci_save_state(pci_dev);
279         }
280         return i;
281 }
282
283
284 /*
285  * Default resume method for devices that have no driver provided resume,
286  * or not even a driver at all.
287  */
288 static void pci_default_resume(struct pci_dev *pci_dev)
289 {
290         int retval;
291
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);
300 }
301
302 static int pci_device_resume(struct device * dev)
303 {
304         struct pci_dev * pci_dev = to_pci_dev(dev);
305         struct pci_driver * drv = pci_dev->driver;
306
307         if (drv && drv->resume)
308                 drv->resume(pci_dev);
309         else
310                 pci_default_resume(pci_dev);
311         return 0;
312 }
313
314 static void pci_device_shutdown(struct device *dev)
315 {
316         struct pci_dev *pci_dev = to_pci_dev(dev);
317         struct pci_driver *drv = pci_dev->driver;
318
319         if (drv && drv->shutdown)
320                 drv->shutdown(pci_dev);
321 }
322
323 #define kobj_to_pci_driver(obj) container_of(obj, struct device_driver, kobj)
324 #define attr_to_driver_attribute(obj) container_of(obj, struct driver_attribute, attr)
325
326 static ssize_t
327 pci_driver_attr_show(struct kobject * kobj, struct attribute *attr, char *buf)
328 {
329         struct device_driver *driver = kobj_to_pci_driver(kobj);
330         struct driver_attribute *dattr = attr_to_driver_attribute(attr);
331         ssize_t ret;
332
333         if (!get_driver(driver))
334                 return -ENODEV;
335
336         ret = dattr->show ? dattr->show(driver, buf) : -EIO;
337
338         put_driver(driver);
339         return ret;
340 }
341
342 static ssize_t
343 pci_driver_attr_store(struct kobject * kobj, struct attribute *attr,
344                       const char *buf, size_t count)
345 {
346         struct device_driver *driver = kobj_to_pci_driver(kobj);
347         struct driver_attribute *dattr = attr_to_driver_attribute(attr);
348         ssize_t ret;
349
350         if (!get_driver(driver))
351                 return -ENODEV;
352
353         ret = dattr->store ? dattr->store(driver, buf, count) : -EIO;
354
355         put_driver(driver);
356         return ret;
357 }
358
359 static struct sysfs_ops pci_driver_sysfs_ops = {
360         .show = pci_driver_attr_show,
361         .store = pci_driver_attr_store,
362 };
363 static struct kobj_type pci_driver_kobj_type = {
364         .sysfs_ops = &pci_driver_sysfs_ops,
365 };
366
367 /**
368  * __pci_register_driver - register a new pci driver
369  * @drv: the driver structure to register
370  * @owner: owner module of drv
371  * 
372  * Adds the driver structure to the list of registered drivers.
373  * Returns a negative value on error, otherwise 0. 
374  * If no error occurred, the driver remains registered even if 
375  * no device was claimed during registration.
376  */
377 int __pci_register_driver(struct pci_driver *drv, struct module *owner)
378 {
379         int error;
380
381         /* initialize common driver fields */
382         drv->driver.name = drv->name;
383         drv->driver.bus = &pci_bus_type;
384         drv->driver.owner = owner;
385         drv->driver.kobj.ktype = &pci_driver_kobj_type;
386
387         spin_lock_init(&drv->dynids.lock);
388         INIT_LIST_HEAD(&drv->dynids.list);
389
390         /* register with core */
391         error = driver_register(&drv->driver);
392
393         if (!error)
394                 error = pci_create_newid_file(drv);
395
396         return error;
397 }
398
399 /**
400  * pci_unregister_driver - unregister a pci driver
401  * @drv: the driver structure to unregister
402  * 
403  * Deletes the driver structure from the list of registered PCI drivers,
404  * gives it a chance to clean up by calling its remove() function for
405  * each device it was responsible for, and marks those devices as
406  * driverless.
407  */
408
409 void
410 pci_unregister_driver(struct pci_driver *drv)
411 {
412         driver_unregister(&drv->driver);
413         pci_free_dynids(drv);
414 }
415
416 static struct pci_driver pci_compat_driver = {
417         .name = "compat"
418 };
419
420 /**
421  * pci_dev_driver - get the pci_driver of a device
422  * @dev: the device to query
423  *
424  * Returns the appropriate pci_driver structure or %NULL if there is no 
425  * registered driver for the device.
426  */
427 struct pci_driver *
428 pci_dev_driver(const struct pci_dev *dev)
429 {
430         if (dev->driver)
431                 return dev->driver;
432         else {
433                 int i;
434                 for(i=0; i<=PCI_ROM_RESOURCE; i++)
435                         if (dev->resource[i].flags & IORESOURCE_BUSY)
436                                 return &pci_compat_driver;
437         }
438         return NULL;
439 }
440
441 /**
442  * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
443  * @dev: the PCI device structure to match against
444  * @drv: the device driver to search for matching PCI device id structures
445  * 
446  * Used by a driver to check whether a PCI device present in the
447  * system is in its list of supported devices. Returns the matching
448  * pci_device_id structure or %NULL if there is no match.
449  */
450 static int pci_bus_match(struct device *dev, struct device_driver *drv)
451 {
452         struct pci_dev *pci_dev = to_pci_dev(dev);
453         struct pci_driver *pci_drv = to_pci_driver(drv);
454         const struct pci_device_id *found_id;
455
456         found_id = pci_match_device(pci_drv, pci_dev);
457         if (found_id)
458                 return 1;
459
460         return 0;
461 }
462
463 /**
464  * pci_dev_get - increments the reference count of the pci device structure
465  * @dev: the device being referenced
466  *
467  * Each live reference to a device should be refcounted.
468  *
469  * Drivers for PCI devices should normally record such references in
470  * their probe() methods, when they bind to a device, and release
471  * them by calling pci_dev_put(), in their disconnect() methods.
472  *
473  * A pointer to the device with the incremented reference counter is returned.
474  */
475 struct pci_dev *pci_dev_get(struct pci_dev *dev)
476 {
477         if (dev)
478                 get_device(&dev->dev);
479         return dev;
480 }
481
482 /**
483  * pci_dev_put - release a use of the pci device structure
484  * @dev: device that's been disconnected
485  *
486  * Must be called when a user of a device is finished with it.  When the last
487  * user of the device calls this function, the memory of the device is freed.
488  */
489 void pci_dev_put(struct pci_dev *dev)
490 {
491         if (dev)
492                 put_device(&dev->dev);
493 }
494
495 #ifndef CONFIG_HOTPLUG
496 int pci_uevent(struct device *dev, char **envp, int num_envp,
497                char *buffer, int buffer_size)
498 {
499         return -ENODEV;
500 }
501 #endif
502
503 struct bus_type pci_bus_type = {
504         .name           = "pci",
505         .match          = pci_bus_match,
506         .uevent         = pci_uevent,
507         .probe          = pci_device_probe,
508         .remove         = pci_device_remove,
509         .suspend        = pci_device_suspend,
510         .shutdown       = pci_device_shutdown,
511         .resume         = pci_device_resume,
512         .dev_attrs      = pci_dev_attrs,
513 };
514
515 static int __init pci_driver_init(void)
516 {
517         return bus_register(&pci_bus_type);
518 }
519
520 postcore_initcall(pci_driver_init);
521
522 EXPORT_SYMBOL(pci_match_id);
523 EXPORT_SYMBOL(pci_match_device);
524 EXPORT_SYMBOL(__pci_register_driver);
525 EXPORT_SYMBOL(pci_unregister_driver);
526 EXPORT_SYMBOL(pci_dev_driver);
527 EXPORT_SYMBOL(pci_bus_type);
528 EXPORT_SYMBOL(pci_dev_get);
529 EXPORT_SYMBOL(pci_dev_put);