[PATCH] driver core: Add the ability to bind drivers to devices from userspace
[linux-2.6.git] / drivers / base / bus.c
1 /*
2  * bus.c - bus driver management
3  *
4  * Copyright (c) 2002-3 Patrick Mochel
5  * Copyright (c) 2002-3 Open Source Development Labs
6  *
7  * This file is released under the GPLv2
8  *
9  */
10
11 #include <linux/config.h>
12 #include <linux/device.h>
13 #include <linux/module.h>
14 #include <linux/errno.h>
15 #include <linux/init.h>
16 #include <linux/string.h>
17 #include "base.h"
18 #include "power/power.h"
19
20 #define to_bus_attr(_attr) container_of(_attr, struct bus_attribute, attr)
21 #define to_bus(obj) container_of(obj, struct bus_type, subsys.kset.kobj)
22
23 /*
24  * sysfs bindings for drivers
25  */
26
27 #define to_drv_attr(_attr) container_of(_attr, struct driver_attribute, attr)
28 #define to_driver(obj) container_of(obj, struct device_driver, kobj)
29
30
31 static ssize_t
32 drv_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
33 {
34         struct driver_attribute * drv_attr = to_drv_attr(attr);
35         struct device_driver * drv = to_driver(kobj);
36         ssize_t ret = -EIO;
37
38         if (drv_attr->show)
39                 ret = drv_attr->show(drv, buf);
40         return ret;
41 }
42
43 static ssize_t
44 drv_attr_store(struct kobject * kobj, struct attribute * attr,
45                const char * buf, size_t count)
46 {
47         struct driver_attribute * drv_attr = to_drv_attr(attr);
48         struct device_driver * drv = to_driver(kobj);
49         ssize_t ret = -EIO;
50
51         if (drv_attr->store)
52                 ret = drv_attr->store(drv, buf, count);
53         return ret;
54 }
55
56 static struct sysfs_ops driver_sysfs_ops = {
57         .show   = drv_attr_show,
58         .store  = drv_attr_store,
59 };
60
61
62 static void driver_release(struct kobject * kobj)
63 {
64         struct device_driver * drv = to_driver(kobj);
65         complete(&drv->unloaded);
66 }
67
68 static struct kobj_type ktype_driver = {
69         .sysfs_ops      = &driver_sysfs_ops,
70         .release        = driver_release,
71 };
72
73
74 /*
75  * sysfs bindings for buses
76  */
77
78
79 static ssize_t
80 bus_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
81 {
82         struct bus_attribute * bus_attr = to_bus_attr(attr);
83         struct bus_type * bus = to_bus(kobj);
84         ssize_t ret = 0;
85
86         if (bus_attr->show)
87                 ret = bus_attr->show(bus, buf);
88         return ret;
89 }
90
91 static ssize_t
92 bus_attr_store(struct kobject * kobj, struct attribute * attr,
93                const char * buf, size_t count)
94 {
95         struct bus_attribute * bus_attr = to_bus_attr(attr);
96         struct bus_type * bus = to_bus(kobj);
97         ssize_t ret = 0;
98
99         if (bus_attr->store)
100                 ret = bus_attr->store(bus, buf, count);
101         return ret;
102 }
103
104 static struct sysfs_ops bus_sysfs_ops = {
105         .show   = bus_attr_show,
106         .store  = bus_attr_store,
107 };
108
109 int bus_create_file(struct bus_type * bus, struct bus_attribute * attr)
110 {
111         int error;
112         if (get_bus(bus)) {
113                 error = sysfs_create_file(&bus->subsys.kset.kobj, &attr->attr);
114                 put_bus(bus);
115         } else
116                 error = -EINVAL;
117         return error;
118 }
119
120 void bus_remove_file(struct bus_type * bus, struct bus_attribute * attr)
121 {
122         if (get_bus(bus)) {
123                 sysfs_remove_file(&bus->subsys.kset.kobj, &attr->attr);
124                 put_bus(bus);
125         }
126 }
127
128 static struct kobj_type ktype_bus = {
129         .sysfs_ops      = &bus_sysfs_ops,
130
131 };
132
133 decl_subsys(bus, &ktype_bus, NULL);
134
135
136 /* Manually detach a device from it's associated driver. */
137 static int driver_helper(struct device *dev, void *data)
138 {
139         const char *name = data;
140
141         if (strcmp(name, dev->bus_id) == 0)
142                 return 1;
143         return 0;
144 }
145
146 static ssize_t driver_unbind(struct device_driver *drv,
147                              const char *buf, size_t count)
148 {
149         struct bus_type *bus = get_bus(drv->bus);
150         struct device *dev;
151         int err = -ENODEV;
152
153         dev = bus_find_device(bus, NULL, (void *)buf, driver_helper);
154         if ((dev) &&
155             (dev->driver == drv)) {
156                 device_release_driver(dev);
157                 err = count;
158         }
159         return err;
160 }
161 static DRIVER_ATTR(unbind, S_IWUSR, NULL, driver_unbind);
162
163 /*
164  * Manually attach a device to a driver.
165  * Note: the driver must want to bind to the device,
166  * it is not possible to override the driver's id table.
167  */
168 static ssize_t driver_bind(struct device_driver *drv,
169                            const char *buf, size_t count)
170 {
171         struct bus_type *bus = get_bus(drv->bus);
172         struct device *dev;
173         int err = -ENODEV;
174
175         dev = bus_find_device(bus, NULL, (void *)buf, driver_helper);
176         if ((dev) &&
177             (dev->driver == NULL)) {
178                 down(&dev->sem);
179                 err = driver_probe_device(drv, dev);
180                 up(&dev->sem);
181                 put_device(dev);
182         }
183         return err;
184 }
185 static DRIVER_ATTR(bind, S_IWUSR, NULL, driver_bind);
186
187
188 static struct device * next_device(struct klist_iter * i)
189 {
190         struct klist_node * n = klist_next(i);
191         return n ? container_of(n, struct device, knode_bus) : NULL;
192 }
193
194 /**
195  *      bus_for_each_dev - device iterator.
196  *      @bus:   bus type.
197  *      @start: device to start iterating from.
198  *      @data:  data for the callback.
199  *      @fn:    function to be called for each device.
200  *
201  *      Iterate over @bus's list of devices, and call @fn for each,
202  *      passing it @data. If @start is not NULL, we use that device to
203  *      begin iterating from.
204  *
205  *      We check the return of @fn each time. If it returns anything
206  *      other than 0, we break out and return that value.
207  *
208  *      NOTE: The device that returns a non-zero value is not retained
209  *      in any way, nor is its refcount incremented. If the caller needs
210  *      to retain this data, it should do, and increment the reference
211  *      count in the supplied callback.
212  */
213
214 int bus_for_each_dev(struct bus_type * bus, struct device * start,
215                      void * data, int (*fn)(struct device *, void *))
216 {
217         struct klist_iter i;
218         struct device * dev;
219         int error = 0;
220
221         if (!bus)
222                 return -EINVAL;
223
224         klist_iter_init_node(&bus->klist_devices, &i,
225                              (start ? &start->knode_bus : NULL));
226         while ((dev = next_device(&i)) && !error)
227                 error = fn(dev, data);
228         klist_iter_exit(&i);
229         return error;
230 }
231
232 /**
233  * bus_find_device - device iterator for locating a particular device.
234  * @bus: bus type
235  * @start: Device to begin with
236  * @data: Data to pass to match function
237  * @match: Callback function to check device
238  *
239  * This is similar to the bus_for_each_dev() function above, but it
240  * returns a reference to a device that is 'found' for later use, as
241  * determined by the @match callback.
242  *
243  * The callback should return 0 if the device doesn't match and non-zero
244  * if it does.  If the callback returns non-zero, this function will
245  * return to the caller and not iterate over any more devices.
246  */
247 struct device * bus_find_device(struct bus_type *bus,
248                                 struct device *start, void *data,
249                                 int (*match)(struct device *, void *))
250 {
251         struct klist_iter i;
252         struct device *dev;
253
254         if (!bus)
255                 return NULL;
256
257         klist_iter_init_node(&bus->klist_devices, &i,
258                              (start ? &start->knode_bus : NULL));
259         while ((dev = next_device(&i)))
260                 if (match(dev, data) && get_device(dev))
261                         break;
262         klist_iter_exit(&i);
263         return dev;
264 }
265
266
267 static struct device_driver * next_driver(struct klist_iter * i)
268 {
269         struct klist_node * n = klist_next(i);
270         return n ? container_of(n, struct device_driver, knode_bus) : NULL;
271 }
272
273 /**
274  *      bus_for_each_drv - driver iterator
275  *      @bus:   bus we're dealing with.
276  *      @start: driver to start iterating on.
277  *      @data:  data to pass to the callback.
278  *      @fn:    function to call for each driver.
279  *
280  *      This is nearly identical to the device iterator above.
281  *      We iterate over each driver that belongs to @bus, and call
282  *      @fn for each. If @fn returns anything but 0, we break out
283  *      and return it. If @start is not NULL, we use it as the head
284  *      of the list.
285  *
286  *      NOTE: we don't return the driver that returns a non-zero
287  *      value, nor do we leave the reference count incremented for that
288  *      driver. If the caller needs to know that info, it must set it
289  *      in the callback. It must also be sure to increment the refcount
290  *      so it doesn't disappear before returning to the caller.
291  */
292
293 int bus_for_each_drv(struct bus_type * bus, struct device_driver * start,
294                      void * data, int (*fn)(struct device_driver *, void *))
295 {
296         struct klist_iter i;
297         struct device_driver * drv;
298         int error = 0;
299
300         if (!bus)
301                 return -EINVAL;
302
303         klist_iter_init_node(&bus->klist_drivers, &i,
304                              start ? &start->knode_bus : NULL);
305         while ((drv = next_driver(&i)) && !error)
306                 error = fn(drv, data);
307         klist_iter_exit(&i);
308         return error;
309 }
310
311 static int device_add_attrs(struct bus_type * bus, struct device * dev)
312 {
313         int error = 0;
314         int i;
315
316         if (bus->dev_attrs) {
317                 for (i = 0; attr_name(bus->dev_attrs[i]); i++) {
318                         error = device_create_file(dev,&bus->dev_attrs[i]);
319                         if (error)
320                                 goto Err;
321                 }
322         }
323  Done:
324         return error;
325  Err:
326         while (--i >= 0)
327                 device_remove_file(dev,&bus->dev_attrs[i]);
328         goto Done;
329 }
330
331
332 static void device_remove_attrs(struct bus_type * bus, struct device * dev)
333 {
334         int i;
335
336         if (bus->dev_attrs) {
337                 for (i = 0; attr_name(bus->dev_attrs[i]); i++)
338                         device_remove_file(dev,&bus->dev_attrs[i]);
339         }
340 }
341
342
343 /**
344  *      bus_add_device - add device to bus
345  *      @dev:   device being added
346  *
347  *      - Add the device to its bus's list of devices.
348  *      - Try to attach to driver.
349  *      - Create link to device's physical location.
350  */
351 int bus_add_device(struct device * dev)
352 {
353         struct bus_type * bus = get_bus(dev->bus);
354         int error = 0;
355
356         if (bus) {
357                 pr_debug("bus %s: add device %s\n", bus->name, dev->bus_id);
358                 device_attach(dev);
359                 klist_add_tail(&bus->klist_devices, &dev->knode_bus);
360                 error = device_add_attrs(bus, dev);
361                 if (!error) {
362                         sysfs_create_link(&bus->devices.kobj, &dev->kobj, dev->bus_id);
363                         sysfs_create_link(&dev->kobj, &dev->bus->subsys.kset.kobj, "bus");
364                 }
365         }
366         return error;
367 }
368
369 /**
370  *      bus_remove_device - remove device from bus
371  *      @dev:   device to be removed
372  *
373  *      - Remove symlink from bus's directory.
374  *      - Delete device from bus's list.
375  *      - Detach from its driver.
376  *      - Drop reference taken in bus_add_device().
377  */
378 void bus_remove_device(struct device * dev)
379 {
380         if (dev->bus) {
381                 sysfs_remove_link(&dev->kobj, "bus");
382                 sysfs_remove_link(&dev->bus->devices.kobj, dev->bus_id);
383                 device_remove_attrs(dev->bus, dev);
384                 klist_remove(&dev->knode_bus);
385                 pr_debug("bus %s: remove device %s\n", dev->bus->name, dev->bus_id);
386                 device_release_driver(dev);
387                 put_bus(dev->bus);
388         }
389 }
390
391 static int driver_add_attrs(struct bus_type * bus, struct device_driver * drv)
392 {
393         int error = 0;
394         int i;
395
396         if (bus->drv_attrs) {
397                 for (i = 0; attr_name(bus->drv_attrs[i]); i++) {
398                         error = driver_create_file(drv, &bus->drv_attrs[i]);
399                         if (error)
400                                 goto Err;
401                 }
402         }
403  Done:
404         return error;
405  Err:
406         while (--i >= 0)
407                 driver_remove_file(drv, &bus->drv_attrs[i]);
408         goto Done;
409 }
410
411
412 static void driver_remove_attrs(struct bus_type * bus, struct device_driver * drv)
413 {
414         int i;
415
416         if (bus->drv_attrs) {
417                 for (i = 0; attr_name(bus->drv_attrs[i]); i++)
418                         driver_remove_file(drv, &bus->drv_attrs[i]);
419         }
420 }
421
422
423 /**
424  *      bus_add_driver - Add a driver to the bus.
425  *      @drv:   driver.
426  *
427  */
428 int bus_add_driver(struct device_driver * drv)
429 {
430         struct bus_type * bus = get_bus(drv->bus);
431         int error = 0;
432
433         if (bus) {
434                 pr_debug("bus %s: add driver %s\n", bus->name, drv->name);
435                 error = kobject_set_name(&drv->kobj, "%s", drv->name);
436                 if (error) {
437                         put_bus(bus);
438                         return error;
439                 }
440                 drv->kobj.kset = &bus->drivers;
441                 if ((error = kobject_register(&drv->kobj))) {
442                         put_bus(bus);
443                         return error;
444                 }
445
446                 driver_attach(drv);
447                 klist_add_tail(&bus->klist_drivers, &drv->knode_bus);
448                 module_add_driver(drv->owner, drv);
449
450                 driver_add_attrs(bus, drv);
451                 driver_create_file(drv, &driver_attr_unbind);
452                 driver_create_file(drv, &driver_attr_bind);
453         }
454         return error;
455 }
456
457
458 /**
459  *      bus_remove_driver - delete driver from bus's knowledge.
460  *      @drv:   driver.
461  *
462  *      Detach the driver from the devices it controls, and remove
463  *      it from its bus's list of drivers. Finally, we drop the reference
464  *      to the bus we took in bus_add_driver().
465  */
466
467 void bus_remove_driver(struct device_driver * drv)
468 {
469         if (drv->bus) {
470                 driver_remove_file(drv, &driver_attr_bind);
471                 driver_remove_file(drv, &driver_attr_unbind);
472                 driver_remove_attrs(drv->bus, drv);
473                 klist_remove(&drv->knode_bus);
474                 pr_debug("bus %s: remove driver %s\n", drv->bus->name, drv->name);
475                 driver_detach(drv);
476                 module_remove_driver(drv);
477                 kobject_unregister(&drv->kobj);
478                 put_bus(drv->bus);
479         }
480 }
481
482
483 /* Helper for bus_rescan_devices's iter */
484 static int bus_rescan_devices_helper(struct device *dev, void *data)
485 {
486         int *count = data;
487
488         if (!dev->driver && (device_attach(dev) > 0))
489                 (*count)++;
490
491         return 0;
492 }
493
494
495 /**
496  *      bus_rescan_devices - rescan devices on the bus for possible drivers
497  *      @bus:   the bus to scan.
498  *
499  *      This function will look for devices on the bus with no driver
500  *      attached and rescan it against existing drivers to see if it
501  *      matches any. Calls device_attach(). Returns the number of devices
502  *      that were sucessfully bound to a driver.
503  */
504 int bus_rescan_devices(struct bus_type * bus)
505 {
506         int count = 0;
507
508         bus_for_each_dev(bus, NULL, &count, bus_rescan_devices_helper);
509
510         return count;
511 }
512
513
514 struct bus_type * get_bus(struct bus_type * bus)
515 {
516         return bus ? container_of(subsys_get(&bus->subsys), struct bus_type, subsys) : NULL;
517 }
518
519 void put_bus(struct bus_type * bus)
520 {
521         subsys_put(&bus->subsys);
522 }
523
524
525 /**
526  *      find_bus - locate bus by name.
527  *      @name:  name of bus.
528  *
529  *      Call kset_find_obj() to iterate over list of buses to
530  *      find a bus by name. Return bus if found.
531  *
532  *      Note that kset_find_obj increments bus' reference count.
533  */
534
535 struct bus_type * find_bus(char * name)
536 {
537         struct kobject * k = kset_find_obj(&bus_subsys.kset, name);
538         return k ? to_bus(k) : NULL;
539 }
540
541
542 /**
543  *      bus_add_attrs - Add default attributes for this bus.
544  *      @bus:   Bus that has just been registered.
545  */
546
547 static int bus_add_attrs(struct bus_type * bus)
548 {
549         int error = 0;
550         int i;
551
552         if (bus->bus_attrs) {
553                 for (i = 0; attr_name(bus->bus_attrs[i]); i++) {
554                         if ((error = bus_create_file(bus,&bus->bus_attrs[i])))
555                                 goto Err;
556                 }
557         }
558  Done:
559         return error;
560  Err:
561         while (--i >= 0)
562                 bus_remove_file(bus,&bus->bus_attrs[i]);
563         goto Done;
564 }
565
566 static void bus_remove_attrs(struct bus_type * bus)
567 {
568         int i;
569
570         if (bus->bus_attrs) {
571                 for (i = 0; attr_name(bus->bus_attrs[i]); i++)
572                         bus_remove_file(bus,&bus->bus_attrs[i]);
573         }
574 }
575
576 /**
577  *      bus_register - register a bus with the system.
578  *      @bus:   bus.
579  *
580  *      Once we have that, we registered the bus with the kobject
581  *      infrastructure, then register the children subsystems it has:
582  *      the devices and drivers that belong to the bus.
583  */
584 int bus_register(struct bus_type * bus)
585 {
586         int retval;
587
588         retval = kobject_set_name(&bus->subsys.kset.kobj, "%s", bus->name);
589         if (retval)
590                 goto out;
591
592         subsys_set_kset(bus, bus_subsys);
593         retval = subsystem_register(&bus->subsys);
594         if (retval)
595                 goto out;
596
597         kobject_set_name(&bus->devices.kobj, "devices");
598         bus->devices.subsys = &bus->subsys;
599         retval = kset_register(&bus->devices);
600         if (retval)
601                 goto bus_devices_fail;
602
603         kobject_set_name(&bus->drivers.kobj, "drivers");
604         bus->drivers.subsys = &bus->subsys;
605         bus->drivers.ktype = &ktype_driver;
606         retval = kset_register(&bus->drivers);
607         if (retval)
608                 goto bus_drivers_fail;
609
610         klist_init(&bus->klist_devices);
611         klist_init(&bus->klist_drivers);
612         bus_add_attrs(bus);
613
614         pr_debug("bus type '%s' registered\n", bus->name);
615         return 0;
616
617 bus_drivers_fail:
618         kset_unregister(&bus->devices);
619 bus_devices_fail:
620         subsystem_unregister(&bus->subsys);
621 out:
622         return retval;
623 }
624
625
626 /**
627  *      bus_unregister - remove a bus from the system
628  *      @bus:   bus.
629  *
630  *      Unregister the child subsystems and the bus itself.
631  *      Finally, we call put_bus() to release the refcount
632  */
633 void bus_unregister(struct bus_type * bus)
634 {
635         pr_debug("bus %s: unregistering\n", bus->name);
636         bus_remove_attrs(bus);
637         kset_unregister(&bus->drivers);
638         kset_unregister(&bus->devices);
639         subsystem_unregister(&bus->subsys);
640 }
641
642 int __init buses_init(void)
643 {
644         return subsystem_register(&bus_subsys);
645 }
646
647
648 EXPORT_SYMBOL_GPL(bus_for_each_dev);
649 EXPORT_SYMBOL_GPL(bus_find_device);
650 EXPORT_SYMBOL_GPL(bus_for_each_drv);
651
652 EXPORT_SYMBOL_GPL(bus_add_device);
653 EXPORT_SYMBOL_GPL(bus_remove_device);
654 EXPORT_SYMBOL_GPL(bus_register);
655 EXPORT_SYMBOL_GPL(bus_unregister);
656 EXPORT_SYMBOL_GPL(bus_rescan_devices);
657 EXPORT_SYMBOL_GPL(get_bus);
658 EXPORT_SYMBOL_GPL(put_bus);
659 EXPORT_SYMBOL_GPL(find_bus);
660
661 EXPORT_SYMBOL_GPL(bus_create_file);
662 EXPORT_SYMBOL_GPL(bus_remove_file);