2 * bus.c - bus driver management
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
7 * This file is released under the GPLv2
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>
18 #include "power/power.h"
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)
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)
27 * sysfs bindings for drivers
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)
35 drv_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
37 struct driver_attribute * drv_attr = to_drv_attr(attr);
38 struct device_driver * drv = to_driver(kobj);
42 ret = drv_attr->show(drv, buf);
47 drv_attr_store(struct kobject * kobj, struct attribute * attr,
48 const char * buf, size_t count)
50 struct driver_attribute * drv_attr = to_drv_attr(attr);
51 struct device_driver * drv = to_driver(kobj);
55 ret = drv_attr->store(drv, buf, count);
59 static struct sysfs_ops driver_sysfs_ops = {
60 .show = drv_attr_show,
61 .store = drv_attr_store,
65 static void driver_release(struct kobject * kobj)
67 struct device_driver * drv = to_driver(kobj);
68 complete(&drv->unloaded);
71 static struct kobj_type ktype_driver = {
72 .sysfs_ops = &driver_sysfs_ops,
73 .release = driver_release,
78 * sysfs bindings for buses
83 bus_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
85 struct bus_attribute * bus_attr = to_bus_attr(attr);
86 struct bus_type * bus = to_bus(kobj);
90 ret = bus_attr->show(bus, buf);
95 bus_attr_store(struct kobject * kobj, struct attribute * attr,
96 const char * buf, size_t count)
98 struct bus_attribute * bus_attr = to_bus_attr(attr);
99 struct bus_type * bus = to_bus(kobj);
103 ret = bus_attr->store(bus, buf, count);
107 static struct sysfs_ops bus_sysfs_ops = {
108 .show = bus_attr_show,
109 .store = bus_attr_store,
112 int bus_create_file(struct bus_type * bus, struct bus_attribute * attr)
116 error = sysfs_create_file(&bus->subsys.kset.kobj, &attr->attr);
123 void bus_remove_file(struct bus_type * bus, struct bus_attribute * attr)
126 sysfs_remove_file(&bus->subsys.kset.kobj, &attr->attr);
131 static struct kobj_type ktype_bus = {
132 .sysfs_ops = &bus_sysfs_ops,
136 decl_subsys(bus, &ktype_bus, NULL);
138 static int __bus_for_each_dev(struct bus_type *bus, struct device *start,
139 void *data, int (*fn)(struct device *, void *))
141 struct list_head *head;
145 if (!(bus = get_bus(bus)))
148 head = &bus->devices.list;
149 dev = list_prepare_entry(start, head, bus_list);
150 list_for_each_entry_continue(dev, head, bus_list) {
152 error = fn(dev, data);
161 static int __bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
162 void * data, int (*fn)(struct device_driver *, void *))
164 struct list_head *head;
165 struct device_driver *drv;
168 if (!(bus = get_bus(bus)))
171 head = &bus->drivers.list;
172 drv = list_prepare_entry(start, head, kobj.entry);
173 list_for_each_entry_continue(drv, head, kobj.entry) {
175 error = fn(drv, data);
185 * bus_for_each_dev - device iterator.
187 * @start: device to start iterating from.
188 * @data: data for the callback.
189 * @fn: function to be called for each device.
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.
195 * We check the return of @fn each time. If it returns anything
196 * other than 0, we break out and return that value.
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.
204 int bus_for_each_dev(struct bus_type * bus, struct device * start,
205 void * data, int (*fn)(struct device *, void *))
209 down_read(&bus->subsys.rwsem);
210 ret = __bus_for_each_dev(bus, start, data, fn);
211 up_read(&bus->subsys.rwsem);
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.
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
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.
235 int bus_for_each_drv(struct bus_type * bus, struct device_driver * start,
236 void * data, int (*fn)(struct device_driver *, void *))
240 down_read(&bus->subsys.rwsem);
241 ret = __bus_for_each_drv(bus, start, data, fn);
242 up_read(&bus->subsys.rwsem);
247 * device_bind_driver - bind a driver to one device.
250 * Allow manual attachment of a driver to a device.
251 * Caller must have already set @dev->driver.
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.)
259 void device_bind_driver(struct device * dev)
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");
271 * driver_probe_device - attempt to bind device & driver.
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.
281 * If we find a match, we call @drv->probe(@dev) if it exists, and
282 * call device_bind_driver() above.
284 int driver_probe_device(struct device_driver * drv, struct device * dev)
286 if (drv->bus->match && !drv->bus->match(dev, drv))
291 int error = drv->probe(dev);
298 device_bind_driver(dev);
304 * device_attach - try to attach device to a driver.
307 * Walk the list of drivers that the bus has and call
308 * driver_probe_device() for each pair. If a compatible
309 * pair is found, break out and return.
311 int device_attach(struct device * dev)
313 struct bus_type * bus = dev->bus;
314 struct list_head * entry;
318 device_bind_driver(dev);
323 list_for_each(entry, &bus->drivers.list) {
324 struct device_driver * drv = to_drv(entry);
325 error = driver_probe_device(drv, dev);
327 /* success, driver matched */
329 if (error != -ENODEV && error != -ENXIO)
330 /* driver matched but the probe failed */
332 "%s: probe of %s failed with error %d\n",
333 drv->name, dev->bus_id, error);
342 * driver_attach - try to bind driver to devices.
345 * Walk the list of devices that the bus has on it and try to
346 * match the driver with each one. If driver_probe_device()
347 * returns 0 and the @dev->driver is set, we've found a
350 * Note that we ignore the -ENODEV error from driver_probe_device(),
351 * since it's perfectly valid for a driver not to bind to any devices.
353 void driver_attach(struct device_driver * drv)
355 struct bus_type * bus = drv->bus;
356 struct list_head * entry;
362 list_for_each(entry, &bus->devices.list) {
363 struct device * dev = container_of(entry, struct device, bus_list);
365 error = driver_probe_device(drv, dev);
366 if (error && (error != -ENODEV))
367 /* driver matched but the probe failed */
369 "%s: probe of %s failed with error %d\n",
370 drv->name, dev->bus_id, error);
377 * device_release_driver - manually detach device from driver.
380 * Manually detach device from driver.
381 * Note that this is called without incrementing the bus
382 * reference count nor taking the bus's rwsem. Be sure that
383 * those are accounted for before calling this function.
386 void device_release_driver(struct device * dev)
388 struct device_driver * drv = dev->driver;
390 sysfs_remove_link(&drv->kobj, kobject_name(&dev->kobj));
391 sysfs_remove_link(&dev->kobj, "driver");
392 list_del_init(&dev->driver_list);
401 * driver_detach - detach driver from all devices it controls.
405 static void driver_detach(struct device_driver * drv)
407 while (!list_empty(&drv->devices)) {
408 struct device * dev = container_of(drv->devices.next, struct device, driver_list);
409 device_release_driver(dev);
413 static int device_add_attrs(struct bus_type * bus, struct device * dev)
418 if (bus->dev_attrs) {
419 for (i = 0; attr_name(bus->dev_attrs[i]); i++) {
420 error = device_create_file(dev,&bus->dev_attrs[i]);
429 device_remove_file(dev,&bus->dev_attrs[i]);
434 static void device_remove_attrs(struct bus_type * bus, struct device * dev)
438 if (bus->dev_attrs) {
439 for (i = 0; attr_name(bus->dev_attrs[i]); i++)
440 device_remove_file(dev,&bus->dev_attrs[i]);
446 * bus_add_device - add device to bus
447 * @dev: device being added
449 * - Add the device to its bus's list of devices.
450 * - Try to attach to driver.
451 * - Create link to device's physical location.
453 int bus_add_device(struct device * dev)
455 struct bus_type * bus = get_bus(dev->bus);
459 down_write(&dev->bus->subsys.rwsem);
460 pr_debug("bus %s: add device %s\n", bus->name, dev->bus_id);
461 list_add_tail(&dev->bus_list, &dev->bus->devices.list);
463 up_write(&dev->bus->subsys.rwsem);
464 device_add_attrs(bus, dev);
465 sysfs_create_link(&bus->devices.kobj, &dev->kobj, dev->bus_id);
466 sysfs_create_link(&dev->kobj, &dev->bus->subsys.kset.kobj, "bus");
472 * bus_remove_device - remove device from bus
473 * @dev: device to be removed
475 * - Remove symlink from bus's directory.
476 * - Delete device from bus's list.
477 * - Detach from its driver.
478 * - Drop reference taken in bus_add_device().
480 void bus_remove_device(struct device * dev)
483 sysfs_remove_link(&dev->kobj, "bus");
484 sysfs_remove_link(&dev->bus->devices.kobj, dev->bus_id);
485 device_remove_attrs(dev->bus, dev);
486 down_write(&dev->bus->subsys.rwsem);
487 pr_debug("bus %s: remove device %s\n", dev->bus->name, dev->bus_id);
488 device_release_driver(dev);
489 list_del_init(&dev->bus_list);
490 up_write(&dev->bus->subsys.rwsem);
495 static int driver_add_attrs(struct bus_type * bus, struct device_driver * drv)
500 if (bus->drv_attrs) {
501 for (i = 0; attr_name(bus->drv_attrs[i]); i++) {
502 error = driver_create_file(drv, &bus->drv_attrs[i]);
511 driver_remove_file(drv, &bus->drv_attrs[i]);
516 static void driver_remove_attrs(struct bus_type * bus, struct device_driver * drv)
520 if (bus->drv_attrs) {
521 for (i = 0; attr_name(bus->drv_attrs[i]); i++)
522 driver_remove_file(drv, &bus->drv_attrs[i]);
528 * bus_add_driver - Add a driver to the bus.
532 int bus_add_driver(struct device_driver * drv)
534 struct bus_type * bus = get_bus(drv->bus);
538 pr_debug("bus %s: add driver %s\n", bus->name, drv->name);
539 error = kobject_set_name(&drv->kobj, "%s", drv->name);
544 drv->kobj.kset = &bus->drivers;
545 if ((error = kobject_register(&drv->kobj))) {
550 down_write(&bus->subsys.rwsem);
552 up_write(&bus->subsys.rwsem);
553 module_add_driver(drv->owner, drv);
555 driver_add_attrs(bus, drv);
562 * bus_remove_driver - delete driver from bus's knowledge.
565 * Detach the driver from the devices it controls, and remove
566 * it from its bus's list of drivers. Finally, we drop the reference
567 * to the bus we took in bus_add_driver().
570 void bus_remove_driver(struct device_driver * drv)
573 driver_remove_attrs(drv->bus, drv);
574 down_write(&drv->bus->subsys.rwsem);
575 pr_debug("bus %s: remove driver %s\n", drv->bus->name, drv->name);
577 up_write(&drv->bus->subsys.rwsem);
578 module_remove_driver(drv);
579 kobject_unregister(&drv->kobj);
585 /* Helper for bus_rescan_devices's iter */
586 static int bus_rescan_devices_helper(struct device *dev, void *data)
590 if (!dev->driver && device_attach(dev))
598 * bus_rescan_devices - rescan devices on the bus for possible drivers
599 * @bus: the bus to scan.
601 * This function will look for devices on the bus with no driver
602 * attached and rescan it against existing drivers to see if it
603 * matches any. Calls device_attach(). Returns the number of devices
604 * that were sucessfully bound to a driver.
606 int bus_rescan_devices(struct bus_type * bus)
610 down_write(&bus->subsys.rwsem);
611 __bus_for_each_dev(bus, NULL, &count, bus_rescan_devices_helper);
612 up_write(&bus->subsys.rwsem);
618 struct bus_type * get_bus(struct bus_type * bus)
620 return bus ? container_of(subsys_get(&bus->subsys), struct bus_type, subsys) : NULL;
623 void put_bus(struct bus_type * bus)
625 subsys_put(&bus->subsys);
630 * find_bus - locate bus by name.
631 * @name: name of bus.
633 * Call kset_find_obj() to iterate over list of buses to
634 * find a bus by name. Return bus if found.
636 * Note that kset_find_obj increments bus' reference count.
639 struct bus_type * find_bus(char * name)
641 struct kobject * k = kset_find_obj(&bus_subsys.kset, name);
642 return k ? to_bus(k) : NULL;
647 * bus_add_attrs - Add default attributes for this bus.
648 * @bus: Bus that has just been registered.
651 static int bus_add_attrs(struct bus_type * bus)
656 if (bus->bus_attrs) {
657 for (i = 0; attr_name(bus->bus_attrs[i]); i++) {
658 if ((error = bus_create_file(bus,&bus->bus_attrs[i])))
666 bus_remove_file(bus,&bus->bus_attrs[i]);
670 static void bus_remove_attrs(struct bus_type * bus)
674 if (bus->bus_attrs) {
675 for (i = 0; attr_name(bus->bus_attrs[i]); i++)
676 bus_remove_file(bus,&bus->bus_attrs[i]);
681 * bus_register - register a bus with the system.
684 * Once we have that, we registered the bus with the kobject
685 * infrastructure, then register the children subsystems it has:
686 * the devices and drivers that belong to the bus.
688 int bus_register(struct bus_type * bus)
692 retval = kobject_set_name(&bus->subsys.kset.kobj, "%s", bus->name);
696 subsys_set_kset(bus, bus_subsys);
697 retval = subsystem_register(&bus->subsys);
701 kobject_set_name(&bus->devices.kobj, "devices");
702 bus->devices.subsys = &bus->subsys;
703 retval = kset_register(&bus->devices);
705 goto bus_devices_fail;
707 kobject_set_name(&bus->drivers.kobj, "drivers");
708 bus->drivers.subsys = &bus->subsys;
709 bus->drivers.ktype = &ktype_driver;
710 retval = kset_register(&bus->drivers);
712 goto bus_drivers_fail;
715 pr_debug("bus type '%s' registered\n", bus->name);
719 kset_unregister(&bus->devices);
721 subsystem_unregister(&bus->subsys);
728 * bus_unregister - remove a bus from the system
731 * Unregister the child subsystems and the bus itself.
732 * Finally, we call put_bus() to release the refcount
734 void bus_unregister(struct bus_type * bus)
736 pr_debug("bus %s: unregistering\n", bus->name);
737 bus_remove_attrs(bus);
738 kset_unregister(&bus->drivers);
739 kset_unregister(&bus->devices);
740 subsystem_unregister(&bus->subsys);
743 int __init buses_init(void)
745 return subsystem_register(&bus_subsys);
749 EXPORT_SYMBOL_GPL(bus_for_each_dev);
750 EXPORT_SYMBOL_GPL(bus_for_each_drv);
752 EXPORT_SYMBOL_GPL(driver_probe_device);
753 EXPORT_SYMBOL_GPL(device_bind_driver);
754 EXPORT_SYMBOL_GPL(device_release_driver);
755 EXPORT_SYMBOL_GPL(device_attach);
756 EXPORT_SYMBOL_GPL(driver_attach);
758 EXPORT_SYMBOL_GPL(bus_add_device);
759 EXPORT_SYMBOL_GPL(bus_remove_device);
760 EXPORT_SYMBOL_GPL(bus_register);
761 EXPORT_SYMBOL_GPL(bus_unregister);
762 EXPORT_SYMBOL_GPL(bus_rescan_devices);
763 EXPORT_SYMBOL_GPL(get_bus);
764 EXPORT_SYMBOL_GPL(put_bus);
765 EXPORT_SYMBOL_GPL(find_bus);
767 EXPORT_SYMBOL_GPL(bus_create_file);
768 EXPORT_SYMBOL_GPL(bus_remove_file);