[PATCH] Add a semaphore to struct device to synchronize calls to its driver.
[linux-2.6] / 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_dev(node) container_of(node, struct device, bus_list)
21 #define to_drv(node) container_of(node, struct device_driver, kobj.entry)
22
23 #define to_bus_attr(_attr) container_of(_attr, struct bus_attribute, attr)
24 #define to_bus(obj) container_of(obj, struct bus_type, subsys.kset.kobj)
25
26 /*
27  * sysfs bindings for drivers
28  */
29
30 #define to_drv_attr(_attr) container_of(_attr, struct driver_attribute, attr)
31 #define to_driver(obj) container_of(obj, struct device_driver, kobj)
32
33
34 static ssize_t
35 drv_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
36 {
37         struct driver_attribute * drv_attr = to_drv_attr(attr);
38         struct device_driver * drv = to_driver(kobj);
39         ssize_t ret = -EIO;
40
41         if (drv_attr->show)
42                 ret = drv_attr->show(drv, buf);
43         return ret;
44 }
45
46 static ssize_t
47 drv_attr_store(struct kobject * kobj, struct attribute * attr,
48                const char * buf, size_t count)
49 {
50         struct driver_attribute * drv_attr = to_drv_attr(attr);
51         struct device_driver * drv = to_driver(kobj);
52         ssize_t ret = -EIO;
53
54         if (drv_attr->store)
55                 ret = drv_attr->store(drv, buf, count);
56         return ret;
57 }
58
59 static struct sysfs_ops driver_sysfs_ops = {
60         .show   = drv_attr_show,
61         .store  = drv_attr_store,
62 };
63
64
65 static void driver_release(struct kobject * kobj)
66 {
67         struct device_driver * drv = to_driver(kobj);
68         complete(&drv->unloaded);
69 }
70
71 static struct kobj_type ktype_driver = {
72         .sysfs_ops      = &driver_sysfs_ops,
73         .release        = driver_release,
74 };
75
76
77 /*
78  * sysfs bindings for buses
79  */
80
81
82 static ssize_t
83 bus_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
84 {
85         struct bus_attribute * bus_attr = to_bus_attr(attr);
86         struct bus_type * bus = to_bus(kobj);
87         ssize_t ret = 0;
88
89         if (bus_attr->show)
90                 ret = bus_attr->show(bus, buf);
91         return ret;
92 }
93
94 static ssize_t
95 bus_attr_store(struct kobject * kobj, struct attribute * attr,
96                const char * buf, size_t count)
97 {
98         struct bus_attribute * bus_attr = to_bus_attr(attr);
99         struct bus_type * bus = to_bus(kobj);
100         ssize_t ret = 0;
101
102         if (bus_attr->store)
103                 ret = bus_attr->store(bus, buf, count);
104         return ret;
105 }
106
107 static struct sysfs_ops bus_sysfs_ops = {
108         .show   = bus_attr_show,
109         .store  = bus_attr_store,
110 };
111
112 int bus_create_file(struct bus_type * bus, struct bus_attribute * attr)
113 {
114         int error;
115         if (get_bus(bus)) {
116                 error = sysfs_create_file(&bus->subsys.kset.kobj, &attr->attr);
117                 put_bus(bus);
118         } else
119                 error = -EINVAL;
120         return error;
121 }
122
123 void bus_remove_file(struct bus_type * bus, struct bus_attribute * attr)
124 {
125         if (get_bus(bus)) {
126                 sysfs_remove_file(&bus->subsys.kset.kobj, &attr->attr);
127                 put_bus(bus);
128         }
129 }
130
131 static struct kobj_type ktype_bus = {
132         .sysfs_ops      = &bus_sysfs_ops,
133
134 };
135
136 decl_subsys(bus, &ktype_bus, NULL);
137
138 static int __bus_for_each_dev(struct bus_type *bus, struct device *start,
139                               void *data, int (*fn)(struct device *, void *))
140 {
141         struct list_head *head;
142         struct device *dev;
143         int error = 0;
144
145         if (!(bus = get_bus(bus)))
146                 return -EINVAL;
147
148         head = &bus->devices.list;
149         dev = list_prepare_entry(start, head, bus_list);
150         list_for_each_entry_continue(dev, head, bus_list) {
151                 get_device(dev);
152                 error = fn(dev, data);
153                 put_device(dev);
154                 if (error)
155                         break;
156         }
157         put_bus(bus);
158         return error;
159 }
160
161 static int __bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
162                               void * data, int (*fn)(struct device_driver *, void *))
163 {
164         struct list_head *head;
165         struct device_driver *drv;
166         int error = 0;
167
168         if (!(bus = get_bus(bus)))
169                 return -EINVAL;
170
171         head = &bus->drivers.list;
172         drv = list_prepare_entry(start, head, kobj.entry);
173         list_for_each_entry_continue(drv, head, kobj.entry) {
174                 get_driver(drv);
175                 error = fn(drv, data);
176                 put_driver(drv);
177                 if (error)
178                         break;
179         }
180         put_bus(bus);
181         return error;
182 }
183
184 /**
185  *      bus_for_each_dev - device iterator.
186  *      @bus:   bus type.
187  *      @start: device to start iterating from.
188  *      @data:  data for the callback.
189  *      @fn:    function to be called for each device.
190  *
191  *      Iterate over @bus's list of devices, and call @fn for each,
192  *      passing it @data. If @start is not NULL, we use that device to
193  *      begin iterating from.
194  *
195  *      We check the return of @fn each time. If it returns anything
196  *      other than 0, we break out and return that value.
197  *
198  *      NOTE: The device that returns a non-zero value is not retained
199  *      in any way, nor is its refcount incremented. If the caller needs
200  *      to retain this data, it should do, and increment the reference
201  *      count in the supplied callback.
202  */
203
204 int bus_for_each_dev(struct bus_type * bus, struct device * start,
205                      void * data, int (*fn)(struct device *, void *))
206 {
207         int ret;
208
209         down_read(&bus->subsys.rwsem);
210         ret = __bus_for_each_dev(bus, start, data, fn);
211         up_read(&bus->subsys.rwsem);
212         return ret;
213 }
214
215 /**
216  *      bus_for_each_drv - driver iterator
217  *      @bus:   bus we're dealing with.
218  *      @start: driver to start iterating on.
219  *      @data:  data to pass to the callback.
220  *      @fn:    function to call for each driver.
221  *
222  *      This is nearly identical to the device iterator above.
223  *      We iterate over each driver that belongs to @bus, and call
224  *      @fn for each. If @fn returns anything but 0, we break out
225  *      and return it. If @start is not NULL, we use it as the head
226  *      of the list.
227  *
228  *      NOTE: we don't return the driver that returns a non-zero
229  *      value, nor do we leave the reference count incremented for that
230  *      driver. If the caller needs to know that info, it must set it
231  *      in the callback. It must also be sure to increment the refcount
232  *      so it doesn't disappear before returning to the caller.
233  */
234
235 int bus_for_each_drv(struct bus_type * bus, struct device_driver * start,
236                      void * data, int (*fn)(struct device_driver *, void *))
237 {
238         int ret;
239
240         down_read(&bus->subsys.rwsem);
241         ret = __bus_for_each_drv(bus, start, data, fn);
242         up_read(&bus->subsys.rwsem);
243         return ret;
244 }
245
246 /**
247  *      device_bind_driver - bind a driver to one device.
248  *      @dev:   device.
249  *
250  *      Allow manual attachment of a driver to a device.
251  *      Caller must have already set @dev->driver.
252  *
253  *      Note that this does not modify the bus reference count
254  *      nor take the bus's rwsem. Please verify those are accounted
255  *      for before calling this. (It is ok to call with no other effort
256  *      from a driver's probe() method.)
257  */
258
259 void device_bind_driver(struct device * dev)
260 {
261         pr_debug("bound device '%s' to driver '%s'\n",
262                  dev->bus_id, dev->driver->name);
263         list_add_tail(&dev->driver_list, &dev->driver->devices);
264         sysfs_create_link(&dev->driver->kobj, &dev->kobj,
265                           kobject_name(&dev->kobj));
266         sysfs_create_link(&dev->kobj, &dev->driver->kobj, "driver");
267 }
268
269
270 /**
271  *      driver_probe_device - attempt to bind device & driver.
272  *      @drv:   driver.
273  *      @dev:   device.
274  *
275  *      First, we call the bus's match function, if one present, which
276  *      should compare the device IDs the driver supports with the
277  *      device IDs of the device. Note we don't do this ourselves
278  *      because we don't know the format of the ID structures, nor what
279  *      is to be considered a match and what is not.
280  *
281  *      If we find a match, we call @drv->probe(@dev) if it exists, and
282  *      call device_bind_driver() above.
283  */
284 int driver_probe_device(struct device_driver * drv, struct device * dev)
285 {
286         int error = 0;
287
288         if (drv->bus->match && !drv->bus->match(dev, drv))
289                 return -ENODEV;
290
291         down(&dev->sem);
292         dev->driver = drv;
293         if (drv->probe) {
294                 error = drv->probe(dev);
295                 if (error) {
296                         dev->driver = NULL;
297                         up(&dev->sem);
298                         return error;
299                 }
300         }
301         up(&dev->sem);
302         device_bind_driver(dev);
303         return 0;
304 }
305
306
307 /**
308  *      device_attach - try to attach device to a driver.
309  *      @dev:   device.
310  *
311  *      Walk the list of drivers that the bus has and call
312  *      driver_probe_device() for each pair. If a compatible
313  *      pair is found, break out and return.
314  */
315 int device_attach(struct device * dev)
316 {
317         struct bus_type * bus = dev->bus;
318         struct list_head * entry;
319         int error;
320
321         if (dev->driver) {
322                 device_bind_driver(dev);
323                 return 1;
324         }
325
326         if (bus->match) {
327                 list_for_each(entry, &bus->drivers.list) {
328                         struct device_driver * drv = to_drv(entry);
329                         error = driver_probe_device(drv, dev);
330                         if (!error)
331                                 /* success, driver matched */
332                                 return 1;
333                         if (error != -ENODEV && error != -ENXIO)
334                                 /* driver matched but the probe failed */
335                                 printk(KERN_WARNING
336                                     "%s: probe of %s failed with error %d\n",
337                                     drv->name, dev->bus_id, error);
338                 }
339         }
340
341         return 0;
342 }
343
344
345 /**
346  *      driver_attach - try to bind driver to devices.
347  *      @drv:   driver.
348  *
349  *      Walk the list of devices that the bus has on it and try to
350  *      match the driver with each one.  If driver_probe_device()
351  *      returns 0 and the @dev->driver is set, we've found a
352  *      compatible pair.
353  *
354  *      Note that we ignore the -ENODEV error from driver_probe_device(),
355  *      since it's perfectly valid for a driver not to bind to any devices.
356  */
357 void driver_attach(struct device_driver * drv)
358 {
359         struct bus_type * bus = drv->bus;
360         struct list_head * entry;
361         int error;
362
363         if (!bus->match)
364                 return;
365
366         list_for_each(entry, &bus->devices.list) {
367                 struct device * dev = container_of(entry, struct device, bus_list);
368                 if (!dev->driver) {
369                         error = driver_probe_device(drv, dev);
370                         if (error && (error != -ENODEV))
371                                 /* driver matched but the probe failed */
372                                 printk(KERN_WARNING
373                                     "%s: probe of %s failed with error %d\n",
374                                     drv->name, dev->bus_id, error);
375                 }
376         }
377 }
378
379
380 /**
381  *      device_release_driver - manually detach device from driver.
382  *      @dev:   device.
383  *
384  *      Manually detach device from driver.
385  *      Note that this is called without incrementing the bus
386  *      reference count nor taking the bus's rwsem. Be sure that
387  *      those are accounted for before calling this function.
388  */
389
390 void device_release_driver(struct device * dev)
391 {
392         struct device_driver * drv;
393
394         down(&dev->sem);
395         drv = dev->driver;
396         if (drv) {
397                 sysfs_remove_link(&drv->kobj, kobject_name(&dev->kobj));
398                 sysfs_remove_link(&dev->kobj, "driver");
399                 list_del_init(&dev->driver_list);
400                 if (drv->remove)
401                         drv->remove(dev);
402                 dev->driver = NULL;
403         }
404         up(&dev->sem);
405 }
406
407
408 /**
409  *      driver_detach - detach driver from all devices it controls.
410  *      @drv:   driver.
411  */
412
413 static void driver_detach(struct device_driver * drv)
414 {
415         while (!list_empty(&drv->devices)) {
416                 struct device * dev = container_of(drv->devices.next, struct device, driver_list);
417                 device_release_driver(dev);
418         }
419 }
420
421 static int device_add_attrs(struct bus_type * bus, struct device * dev)
422 {
423         int error = 0;
424         int i;
425
426         if (bus->dev_attrs) {
427                 for (i = 0; attr_name(bus->dev_attrs[i]); i++) {
428                         error = device_create_file(dev,&bus->dev_attrs[i]);
429                         if (error)
430                                 goto Err;
431                 }
432         }
433  Done:
434         return error;
435  Err:
436         while (--i >= 0)
437                 device_remove_file(dev,&bus->dev_attrs[i]);
438         goto Done;
439 }
440
441
442 static void device_remove_attrs(struct bus_type * bus, struct device * dev)
443 {
444         int i;
445
446         if (bus->dev_attrs) {
447                 for (i = 0; attr_name(bus->dev_attrs[i]); i++)
448                         device_remove_file(dev,&bus->dev_attrs[i]);
449         }
450 }
451
452
453 /**
454  *      bus_add_device - add device to bus
455  *      @dev:   device being added
456  *
457  *      - Add the device to its bus's list of devices.
458  *      - Try to attach to driver.
459  *      - Create link to device's physical location.
460  */
461 int bus_add_device(struct device * dev)
462 {
463         struct bus_type * bus = get_bus(dev->bus);
464         int error = 0;
465
466         if (bus) {
467                 down_write(&dev->bus->subsys.rwsem);
468                 pr_debug("bus %s: add device %s\n", bus->name, dev->bus_id);
469                 list_add_tail(&dev->bus_list, &dev->bus->devices.list);
470                 device_attach(dev);
471                 up_write(&dev->bus->subsys.rwsem);
472                 device_add_attrs(bus, dev);
473                 sysfs_create_link(&bus->devices.kobj, &dev->kobj, dev->bus_id);
474                 sysfs_create_link(&dev->kobj, &dev->bus->subsys.kset.kobj, "bus");
475         }
476         return error;
477 }
478
479 /**
480  *      bus_remove_device - remove device from bus
481  *      @dev:   device to be removed
482  *
483  *      - Remove symlink from bus's directory.
484  *      - Delete device from bus's list.
485  *      - Detach from its driver.
486  *      - Drop reference taken in bus_add_device().
487  */
488 void bus_remove_device(struct device * dev)
489 {
490         if (dev->bus) {
491                 sysfs_remove_link(&dev->kobj, "bus");
492                 sysfs_remove_link(&dev->bus->devices.kobj, dev->bus_id);
493                 device_remove_attrs(dev->bus, dev);
494                 down_write(&dev->bus->subsys.rwsem);
495                 pr_debug("bus %s: remove device %s\n", dev->bus->name, dev->bus_id);
496                 device_release_driver(dev);
497                 list_del_init(&dev->bus_list);
498                 up_write(&dev->bus->subsys.rwsem);
499                 put_bus(dev->bus);
500         }
501 }
502
503 static int driver_add_attrs(struct bus_type * bus, struct device_driver * drv)
504 {
505         int error = 0;
506         int i;
507
508         if (bus->drv_attrs) {
509                 for (i = 0; attr_name(bus->drv_attrs[i]); i++) {
510                         error = driver_create_file(drv, &bus->drv_attrs[i]);
511                         if (error)
512                                 goto Err;
513                 }
514         }
515  Done:
516         return error;
517  Err:
518         while (--i >= 0)
519                 driver_remove_file(drv, &bus->drv_attrs[i]);
520         goto Done;
521 }
522
523
524 static void driver_remove_attrs(struct bus_type * bus, struct device_driver * drv)
525 {
526         int i;
527
528         if (bus->drv_attrs) {
529                 for (i = 0; attr_name(bus->drv_attrs[i]); i++)
530                         driver_remove_file(drv, &bus->drv_attrs[i]);
531         }
532 }
533
534
535 /**
536  *      bus_add_driver - Add a driver to the bus.
537  *      @drv:   driver.
538  *
539  */
540 int bus_add_driver(struct device_driver * drv)
541 {
542         struct bus_type * bus = get_bus(drv->bus);
543         int error = 0;
544
545         if (bus) {
546                 pr_debug("bus %s: add driver %s\n", bus->name, drv->name);
547                 error = kobject_set_name(&drv->kobj, "%s", drv->name);
548                 if (error) {
549                         put_bus(bus);
550                         return error;
551                 }
552                 drv->kobj.kset = &bus->drivers;
553                 if ((error = kobject_register(&drv->kobj))) {
554                         put_bus(bus);
555                         return error;
556                 }
557
558                 down_write(&bus->subsys.rwsem);
559                 driver_attach(drv);
560                 up_write(&bus->subsys.rwsem);
561                 module_add_driver(drv->owner, drv);
562
563                 driver_add_attrs(bus, drv);
564         }
565         return error;
566 }
567
568
569 /**
570  *      bus_remove_driver - delete driver from bus's knowledge.
571  *      @drv:   driver.
572  *
573  *      Detach the driver from the devices it controls, and remove
574  *      it from its bus's list of drivers. Finally, we drop the reference
575  *      to the bus we took in bus_add_driver().
576  */
577
578 void bus_remove_driver(struct device_driver * drv)
579 {
580         if (drv->bus) {
581                 driver_remove_attrs(drv->bus, drv);
582                 down_write(&drv->bus->subsys.rwsem);
583                 pr_debug("bus %s: remove driver %s\n", drv->bus->name, drv->name);
584                 driver_detach(drv);
585                 up_write(&drv->bus->subsys.rwsem);
586                 module_remove_driver(drv);
587                 kobject_unregister(&drv->kobj);
588                 put_bus(drv->bus);
589         }
590 }
591
592
593 /* Helper for bus_rescan_devices's iter */
594 static int bus_rescan_devices_helper(struct device *dev, void *data)
595 {
596         int *count = data;
597
598         if (!dev->driver && device_attach(dev))
599                 (*count)++;
600
601         return 0;
602 }
603
604
605 /**
606  *      bus_rescan_devices - rescan devices on the bus for possible drivers
607  *      @bus:   the bus to scan.
608  *
609  *      This function will look for devices on the bus with no driver
610  *      attached and rescan it against existing drivers to see if it
611  *      matches any. Calls device_attach(). Returns the number of devices
612  *      that were sucessfully bound to a driver.
613  */
614 int bus_rescan_devices(struct bus_type * bus)
615 {
616         int count = 0;
617
618         down_write(&bus->subsys.rwsem);
619         __bus_for_each_dev(bus, NULL, &count, bus_rescan_devices_helper);
620         up_write(&bus->subsys.rwsem);
621
622         return count;
623 }
624
625
626 struct bus_type * get_bus(struct bus_type * bus)
627 {
628         return bus ? container_of(subsys_get(&bus->subsys), struct bus_type, subsys) : NULL;
629 }
630
631 void put_bus(struct bus_type * bus)
632 {
633         subsys_put(&bus->subsys);
634 }
635
636
637 /**
638  *      find_bus - locate bus by name.
639  *      @name:  name of bus.
640  *
641  *      Call kset_find_obj() to iterate over list of buses to
642  *      find a bus by name. Return bus if found.
643  *
644  *      Note that kset_find_obj increments bus' reference count.
645  */
646
647 struct bus_type * find_bus(char * name)
648 {
649         struct kobject * k = kset_find_obj(&bus_subsys.kset, name);
650         return k ? to_bus(k) : NULL;
651 }
652
653
654 /**
655  *      bus_add_attrs - Add default attributes for this bus.
656  *      @bus:   Bus that has just been registered.
657  */
658
659 static int bus_add_attrs(struct bus_type * bus)
660 {
661         int error = 0;
662         int i;
663
664         if (bus->bus_attrs) {
665                 for (i = 0; attr_name(bus->bus_attrs[i]); i++) {
666                         if ((error = bus_create_file(bus,&bus->bus_attrs[i])))
667                                 goto Err;
668                 }
669         }
670  Done:
671         return error;
672  Err:
673         while (--i >= 0)
674                 bus_remove_file(bus,&bus->bus_attrs[i]);
675         goto Done;
676 }
677
678 static void bus_remove_attrs(struct bus_type * bus)
679 {
680         int i;
681
682         if (bus->bus_attrs) {
683                 for (i = 0; attr_name(bus->bus_attrs[i]); i++)
684                         bus_remove_file(bus,&bus->bus_attrs[i]);
685         }
686 }
687
688 /**
689  *      bus_register - register a bus with the system.
690  *      @bus:   bus.
691  *
692  *      Once we have that, we registered the bus with the kobject
693  *      infrastructure, then register the children subsystems it has:
694  *      the devices and drivers that belong to the bus.
695  */
696 int bus_register(struct bus_type * bus)
697 {
698         int retval;
699
700         retval = kobject_set_name(&bus->subsys.kset.kobj, "%s", bus->name);
701         if (retval)
702                 goto out;
703
704         subsys_set_kset(bus, bus_subsys);
705         retval = subsystem_register(&bus->subsys);
706         if (retval)
707                 goto out;
708
709         kobject_set_name(&bus->devices.kobj, "devices");
710         bus->devices.subsys = &bus->subsys;
711         retval = kset_register(&bus->devices);
712         if (retval)
713                 goto bus_devices_fail;
714
715         kobject_set_name(&bus->drivers.kobj, "drivers");
716         bus->drivers.subsys = &bus->subsys;
717         bus->drivers.ktype = &ktype_driver;
718         retval = kset_register(&bus->drivers);
719         if (retval)
720                 goto bus_drivers_fail;
721         bus_add_attrs(bus);
722
723         pr_debug("bus type '%s' registered\n", bus->name);
724         return 0;
725
726 bus_drivers_fail:
727         kset_unregister(&bus->devices);
728 bus_devices_fail:
729         subsystem_unregister(&bus->subsys);
730 out:
731         return retval;
732 }
733
734
735 /**
736  *      bus_unregister - remove a bus from the system
737  *      @bus:   bus.
738  *
739  *      Unregister the child subsystems and the bus itself.
740  *      Finally, we call put_bus() to release the refcount
741  */
742 void bus_unregister(struct bus_type * bus)
743 {
744         pr_debug("bus %s: unregistering\n", bus->name);
745         bus_remove_attrs(bus);
746         kset_unregister(&bus->drivers);
747         kset_unregister(&bus->devices);
748         subsystem_unregister(&bus->subsys);
749 }
750
751 int __init buses_init(void)
752 {
753         return subsystem_register(&bus_subsys);
754 }
755
756
757 EXPORT_SYMBOL_GPL(bus_for_each_dev);
758 EXPORT_SYMBOL_GPL(bus_for_each_drv);
759
760 EXPORT_SYMBOL_GPL(driver_probe_device);
761 EXPORT_SYMBOL_GPL(device_bind_driver);
762 EXPORT_SYMBOL_GPL(device_release_driver);
763 EXPORT_SYMBOL_GPL(device_attach);
764 EXPORT_SYMBOL_GPL(driver_attach);
765
766 EXPORT_SYMBOL_GPL(bus_add_device);
767 EXPORT_SYMBOL_GPL(bus_remove_device);
768 EXPORT_SYMBOL_GPL(bus_register);
769 EXPORT_SYMBOL_GPL(bus_unregister);
770 EXPORT_SYMBOL_GPL(bus_rescan_devices);
771 EXPORT_SYMBOL_GPL(get_bus);
772 EXPORT_SYMBOL_GPL(put_bus);
773 EXPORT_SYMBOL_GPL(find_bus);
774
775 EXPORT_SYMBOL_GPL(bus_create_file);
776 EXPORT_SYMBOL_GPL(bus_remove_file);