4eb19525e064fbf7c7f24df87a84108dac6064a1
[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 static struct device * next_device(struct klist_iter * i)
137 {
138         struct klist_node * n = klist_next(i);
139         return n ? container_of(n, struct device, knode_bus) : NULL;
140 }
141
142 /**
143  *      bus_for_each_dev - device iterator.
144  *      @bus:   bus type.
145  *      @start: device to start iterating from.
146  *      @data:  data for the callback.
147  *      @fn:    function to be called for each device.
148  *
149  *      Iterate over @bus's list of devices, and call @fn for each,
150  *      passing it @data. If @start is not NULL, we use that device to
151  *      begin iterating from.
152  *
153  *      We check the return of @fn each time. If it returns anything
154  *      other than 0, we break out and return that value.
155  *
156  *      NOTE: The device that returns a non-zero value is not retained
157  *      in any way, nor is its refcount incremented. If the caller needs
158  *      to retain this data, it should do, and increment the reference
159  *      count in the supplied callback.
160  */
161
162 int bus_for_each_dev(struct bus_type * bus, struct device * start,
163                      void * data, int (*fn)(struct device *, void *))
164 {
165         struct klist_iter i;
166         struct device * dev;
167         int error = 0;
168
169         if (!bus)
170                 return -EINVAL;
171
172         klist_iter_init_node(&bus->klist_devices, &i,
173                              (start ? &start->knode_bus : NULL));
174         while ((dev = next_device(&i)) && !error)
175                 error = fn(dev, data);
176         klist_iter_exit(&i);
177         return error;
178 }
179
180
181
182 static struct device_driver * next_driver(struct klist_iter * i)
183 {
184         struct klist_node * n = klist_next(i);
185         return n ? container_of(n, struct device_driver, knode_bus) : NULL;
186 }
187
188 /**
189  *      bus_for_each_drv - driver iterator
190  *      @bus:   bus we're dealing with.
191  *      @start: driver to start iterating on.
192  *      @data:  data to pass to the callback.
193  *      @fn:    function to call for each driver.
194  *
195  *      This is nearly identical to the device iterator above.
196  *      We iterate over each driver that belongs to @bus, and call
197  *      @fn for each. If @fn returns anything but 0, we break out
198  *      and return it. If @start is not NULL, we use it as the head
199  *      of the list.
200  *
201  *      NOTE: we don't return the driver that returns a non-zero
202  *      value, nor do we leave the reference count incremented for that
203  *      driver. If the caller needs to know that info, it must set it
204  *      in the callback. It must also be sure to increment the refcount
205  *      so it doesn't disappear before returning to the caller.
206  */
207
208 int bus_for_each_drv(struct bus_type * bus, struct device_driver * start,
209                      void * data, int (*fn)(struct device_driver *, void *))
210 {
211         struct klist_iter i;
212         struct device_driver * drv;
213         int error = 0;
214
215         if (!bus)
216                 return -EINVAL;
217
218         klist_iter_init_node(&bus->klist_drivers, &i,
219                              start ? &start->knode_bus : NULL);
220         while ((drv = next_driver(&i)) && !error)
221                 error = fn(drv, data);
222         klist_iter_exit(&i);
223         return error;
224 }
225
226 static int device_add_attrs(struct bus_type * bus, struct device * dev)
227 {
228         int error = 0;
229         int i;
230
231         if (bus->dev_attrs) {
232                 for (i = 0; attr_name(bus->dev_attrs[i]); i++) {
233                         error = device_create_file(dev,&bus->dev_attrs[i]);
234                         if (error)
235                                 goto Err;
236                 }
237         }
238  Done:
239         return error;
240  Err:
241         while (--i >= 0)
242                 device_remove_file(dev,&bus->dev_attrs[i]);
243         goto Done;
244 }
245
246
247 static void device_remove_attrs(struct bus_type * bus, struct device * dev)
248 {
249         int i;
250
251         if (bus->dev_attrs) {
252                 for (i = 0; attr_name(bus->dev_attrs[i]); i++)
253                         device_remove_file(dev,&bus->dev_attrs[i]);
254         }
255 }
256
257
258 /**
259  *      bus_add_device - add device to bus
260  *      @dev:   device being added
261  *
262  *      - Add the device to its bus's list of devices.
263  *      - Try to attach to driver.
264  *      - Create link to device's physical location.
265  */
266 int bus_add_device(struct device * dev)
267 {
268         struct bus_type * bus = get_bus(dev->bus);
269         int error = 0;
270
271         if (bus) {
272                 pr_debug("bus %s: add device %s\n", bus->name, dev->bus_id);
273                 device_attach(dev);
274                 klist_add_tail(&bus->klist_devices, &dev->knode_bus);
275                 device_add_attrs(bus, dev);
276                 sysfs_create_link(&bus->devices.kobj, &dev->kobj, dev->bus_id);
277                 sysfs_create_link(&dev->kobj, &dev->bus->subsys.kset.kobj, "bus");
278         }
279         return error;
280 }
281
282 /**
283  *      bus_remove_device - remove device from bus
284  *      @dev:   device to be removed
285  *
286  *      - Remove symlink from bus's directory.
287  *      - Delete device from bus's list.
288  *      - Detach from its driver.
289  *      - Drop reference taken in bus_add_device().
290  */
291 void bus_remove_device(struct device * dev)
292 {
293         if (dev->bus) {
294                 sysfs_remove_link(&dev->kobj, "bus");
295                 sysfs_remove_link(&dev->bus->devices.kobj, dev->bus_id);
296                 device_remove_attrs(dev->bus, dev);
297                 klist_remove(&dev->knode_bus);
298                 pr_debug("bus %s: remove device %s\n", dev->bus->name, dev->bus_id);
299                 device_release_driver(dev);
300                 put_bus(dev->bus);
301         }
302 }
303
304 static int driver_add_attrs(struct bus_type * bus, struct device_driver * drv)
305 {
306         int error = 0;
307         int i;
308
309         if (bus->drv_attrs) {
310                 for (i = 0; attr_name(bus->drv_attrs[i]); i++) {
311                         error = driver_create_file(drv, &bus->drv_attrs[i]);
312                         if (error)
313                                 goto Err;
314                 }
315         }
316  Done:
317         return error;
318  Err:
319         while (--i >= 0)
320                 driver_remove_file(drv, &bus->drv_attrs[i]);
321         goto Done;
322 }
323
324
325 static void driver_remove_attrs(struct bus_type * bus, struct device_driver * drv)
326 {
327         int i;
328
329         if (bus->drv_attrs) {
330                 for (i = 0; attr_name(bus->drv_attrs[i]); i++)
331                         driver_remove_file(drv, &bus->drv_attrs[i]);
332         }
333 }
334
335
336 /**
337  *      bus_add_driver - Add a driver to the bus.
338  *      @drv:   driver.
339  *
340  */
341 int bus_add_driver(struct device_driver * drv)
342 {
343         struct bus_type * bus = get_bus(drv->bus);
344         int error = 0;
345
346         if (bus) {
347                 pr_debug("bus %s: add driver %s\n", bus->name, drv->name);
348                 error = kobject_set_name(&drv->kobj, "%s", drv->name);
349                 if (error) {
350                         put_bus(bus);
351                         return error;
352                 }
353                 drv->kobj.kset = &bus->drivers;
354                 if ((error = kobject_register(&drv->kobj))) {
355                         put_bus(bus);
356                         return error;
357                 }
358
359                 driver_attach(drv);
360                 klist_add_tail(&bus->klist_drivers, &drv->knode_bus);
361                 module_add_driver(drv->owner, drv);
362
363                 driver_add_attrs(bus, drv);
364         }
365         return error;
366 }
367
368
369 /**
370  *      bus_remove_driver - delete driver from bus's knowledge.
371  *      @drv:   driver.
372  *
373  *      Detach the driver from the devices it controls, and remove
374  *      it from its bus's list of drivers. Finally, we drop the reference
375  *      to the bus we took in bus_add_driver().
376  */
377
378 void bus_remove_driver(struct device_driver * drv)
379 {
380         if (drv->bus) {
381                 driver_remove_attrs(drv->bus, drv);
382                 klist_remove(&drv->knode_bus);
383                 pr_debug("bus %s: remove driver %s\n", drv->bus->name, drv->name);
384                 driver_detach(drv);
385                 module_remove_driver(drv);
386                 kobject_unregister(&drv->kobj);
387                 put_bus(drv->bus);
388         }
389 }
390
391
392 /* Helper for bus_rescan_devices's iter */
393 static int bus_rescan_devices_helper(struct device *dev, void *data)
394 {
395         int *count = data;
396
397         if (!dev->driver && device_attach(dev))
398                 (*count)++;
399
400         return 0;
401 }
402
403
404 /**
405  *      bus_rescan_devices - rescan devices on the bus for possible drivers
406  *      @bus:   the bus to scan.
407  *
408  *      This function will look for devices on the bus with no driver
409  *      attached and rescan it against existing drivers to see if it
410  *      matches any. Calls device_attach(). Returns the number of devices
411  *      that were sucessfully bound to a driver.
412  */
413 int bus_rescan_devices(struct bus_type * bus)
414 {
415         int count = 0;
416
417         bus_for_each_dev(bus, NULL, &count, bus_rescan_devices_helper);
418
419         return count;
420 }
421
422
423 struct bus_type * get_bus(struct bus_type * bus)
424 {
425         return bus ? container_of(subsys_get(&bus->subsys), struct bus_type, subsys) : NULL;
426 }
427
428 void put_bus(struct bus_type * bus)
429 {
430         subsys_put(&bus->subsys);
431 }
432
433
434 /**
435  *      find_bus - locate bus by name.
436  *      @name:  name of bus.
437  *
438  *      Call kset_find_obj() to iterate over list of buses to
439  *      find a bus by name. Return bus if found.
440  *
441  *      Note that kset_find_obj increments bus' reference count.
442  */
443
444 struct bus_type * find_bus(char * name)
445 {
446         struct kobject * k = kset_find_obj(&bus_subsys.kset, name);
447         return k ? to_bus(k) : NULL;
448 }
449
450
451 /**
452  *      bus_add_attrs - Add default attributes for this bus.
453  *      @bus:   Bus that has just been registered.
454  */
455
456 static int bus_add_attrs(struct bus_type * bus)
457 {
458         int error = 0;
459         int i;
460
461         if (bus->bus_attrs) {
462                 for (i = 0; attr_name(bus->bus_attrs[i]); i++) {
463                         if ((error = bus_create_file(bus,&bus->bus_attrs[i])))
464                                 goto Err;
465                 }
466         }
467  Done:
468         return error;
469  Err:
470         while (--i >= 0)
471                 bus_remove_file(bus,&bus->bus_attrs[i]);
472         goto Done;
473 }
474
475 static void bus_remove_attrs(struct bus_type * bus)
476 {
477         int i;
478
479         if (bus->bus_attrs) {
480                 for (i = 0; attr_name(bus->bus_attrs[i]); i++)
481                         bus_remove_file(bus,&bus->bus_attrs[i]);
482         }
483 }
484
485 /**
486  *      bus_register - register a bus with the system.
487  *      @bus:   bus.
488  *
489  *      Once we have that, we registered the bus with the kobject
490  *      infrastructure, then register the children subsystems it has:
491  *      the devices and drivers that belong to the bus.
492  */
493 int bus_register(struct bus_type * bus)
494 {
495         int retval;
496
497         retval = kobject_set_name(&bus->subsys.kset.kobj, "%s", bus->name);
498         if (retval)
499                 goto out;
500
501         subsys_set_kset(bus, bus_subsys);
502         retval = subsystem_register(&bus->subsys);
503         if (retval)
504                 goto out;
505
506         kobject_set_name(&bus->devices.kobj, "devices");
507         bus->devices.subsys = &bus->subsys;
508         retval = kset_register(&bus->devices);
509         if (retval)
510                 goto bus_devices_fail;
511
512         kobject_set_name(&bus->drivers.kobj, "drivers");
513         bus->drivers.subsys = &bus->subsys;
514         bus->drivers.ktype = &ktype_driver;
515         retval = kset_register(&bus->drivers);
516         if (retval)
517                 goto bus_drivers_fail;
518
519         klist_init(&bus->klist_devices);
520         klist_init(&bus->klist_drivers);
521         bus_add_attrs(bus);
522
523         pr_debug("bus type '%s' registered\n", bus->name);
524         return 0;
525
526 bus_drivers_fail:
527         kset_unregister(&bus->devices);
528 bus_devices_fail:
529         subsystem_unregister(&bus->subsys);
530 out:
531         return retval;
532 }
533
534
535 /**
536  *      bus_unregister - remove a bus from the system
537  *      @bus:   bus.
538  *
539  *      Unregister the child subsystems and the bus itself.
540  *      Finally, we call put_bus() to release the refcount
541  */
542 void bus_unregister(struct bus_type * bus)
543 {
544         pr_debug("bus %s: unregistering\n", bus->name);
545         bus_remove_attrs(bus);
546         kset_unregister(&bus->drivers);
547         kset_unregister(&bus->devices);
548         subsystem_unregister(&bus->subsys);
549 }
550
551 int __init buses_init(void)
552 {
553         return subsystem_register(&bus_subsys);
554 }
555
556
557 EXPORT_SYMBOL_GPL(bus_for_each_dev);
558 EXPORT_SYMBOL_GPL(bus_for_each_drv);
559
560 EXPORT_SYMBOL_GPL(bus_add_device);
561 EXPORT_SYMBOL_GPL(bus_remove_device);
562 EXPORT_SYMBOL_GPL(bus_register);
563 EXPORT_SYMBOL_GPL(bus_unregister);
564 EXPORT_SYMBOL_GPL(bus_rescan_devices);
565 EXPORT_SYMBOL_GPL(get_bus);
566 EXPORT_SYMBOL_GPL(put_bus);
567 EXPORT_SYMBOL_GPL(find_bus);
568
569 EXPORT_SYMBOL_GPL(bus_create_file);
570 EXPORT_SYMBOL_GPL(bus_remove_file);