2 * bus.c - bus driver management
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
6 * Copyright (c) 2007 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2007 Novell Inc.
9 * This file is released under the GPLv2
13 #include <linux/device.h>
14 #include <linux/module.h>
15 #include <linux/errno.h>
16 #include <linux/init.h>
17 #include <linux/string.h>
19 #include "power/power.h"
21 #define to_bus_attr(_attr) container_of(_attr, struct bus_attribute, attr)
22 #define to_bus(obj) container_of(obj, struct bus_type_private, subsys.kobj)
25 * sysfs bindings for drivers
28 #define to_drv_attr(_attr) container_of(_attr, struct driver_attribute, attr)
31 static int __must_check bus_rescan_devices_helper(struct device *dev,
34 static struct bus_type *bus_get(struct bus_type *bus)
37 kset_get(&bus->p->subsys);
43 static void bus_put(struct bus_type *bus)
46 kset_put(&bus->p->subsys);
49 static ssize_t drv_attr_show(struct kobject *kobj, struct attribute *attr,
52 struct driver_attribute *drv_attr = to_drv_attr(attr);
53 struct driver_private *drv_priv = to_driver(kobj);
57 ret = drv_attr->show(drv_priv->driver, buf);
61 static ssize_t drv_attr_store(struct kobject *kobj, struct attribute *attr,
62 const char *buf, size_t count)
64 struct driver_attribute *drv_attr = to_drv_attr(attr);
65 struct driver_private *drv_priv = to_driver(kobj);
69 ret = drv_attr->store(drv_priv->driver, buf, count);
73 static struct sysfs_ops driver_sysfs_ops = {
74 .show = drv_attr_show,
75 .store = drv_attr_store,
78 static void driver_release(struct kobject *kobj)
80 struct driver_private *drv_priv = to_driver(kobj);
82 pr_debug("driver: '%s': %s\n", kobject_name(kobj), __func__);
86 static struct kobj_type driver_ktype = {
87 .sysfs_ops = &driver_sysfs_ops,
88 .release = driver_release,
92 * sysfs bindings for buses
94 static ssize_t bus_attr_show(struct kobject *kobj, struct attribute *attr,
97 struct bus_attribute *bus_attr = to_bus_attr(attr);
98 struct bus_type_private *bus_priv = to_bus(kobj);
102 ret = bus_attr->show(bus_priv->bus, buf);
106 static ssize_t bus_attr_store(struct kobject *kobj, struct attribute *attr,
107 const char *buf, size_t count)
109 struct bus_attribute *bus_attr = to_bus_attr(attr);
110 struct bus_type_private *bus_priv = to_bus(kobj);
114 ret = bus_attr->store(bus_priv->bus, buf, count);
118 static struct sysfs_ops bus_sysfs_ops = {
119 .show = bus_attr_show,
120 .store = bus_attr_store,
123 int bus_create_file(struct bus_type *bus, struct bus_attribute *attr)
127 error = sysfs_create_file(&bus->p->subsys.kobj, &attr->attr);
133 EXPORT_SYMBOL_GPL(bus_create_file);
135 void bus_remove_file(struct bus_type *bus, struct bus_attribute *attr)
138 sysfs_remove_file(&bus->p->subsys.kobj, &attr->attr);
142 EXPORT_SYMBOL_GPL(bus_remove_file);
144 static struct kobj_type bus_ktype = {
145 .sysfs_ops = &bus_sysfs_ops,
148 static int bus_uevent_filter(struct kset *kset, struct kobject *kobj)
150 struct kobj_type *ktype = get_ktype(kobj);
152 if (ktype == &bus_ktype)
157 static struct kset_uevent_ops bus_uevent_ops = {
158 .filter = bus_uevent_filter,
161 static struct kset *bus_kset;
164 #ifdef CONFIG_HOTPLUG
165 /* Manually detach a device from its associated driver. */
166 static ssize_t driver_unbind(struct device_driver *drv,
167 const char *buf, size_t count)
169 struct bus_type *bus = bus_get(drv->bus);
173 dev = bus_find_device_by_name(bus, NULL, buf);
174 if (dev && dev->driver == drv) {
175 if (dev->parent) /* Needed for USB */
176 down(&dev->parent->sem);
177 device_release_driver(dev);
179 up(&dev->parent->sem);
186 static DRIVER_ATTR(unbind, S_IWUSR, NULL, driver_unbind);
189 * Manually attach a device to a driver.
190 * Note: the driver must want to bind to the device,
191 * it is not possible to override the driver's id table.
193 static ssize_t driver_bind(struct device_driver *drv,
194 const char *buf, size_t count)
196 struct bus_type *bus = bus_get(drv->bus);
200 dev = bus_find_device_by_name(bus, NULL, buf);
201 if (dev && dev->driver == NULL) {
202 if (dev->parent) /* Needed for USB */
203 down(&dev->parent->sem);
205 err = driver_probe_device(drv, dev);
208 up(&dev->parent->sem);
213 } else if (err == 0) {
214 /* driver didn't accept device */
222 static DRIVER_ATTR(bind, S_IWUSR, NULL, driver_bind);
224 static ssize_t show_drivers_autoprobe(struct bus_type *bus, char *buf)
226 return sprintf(buf, "%d\n", bus->p->drivers_autoprobe);
229 static ssize_t store_drivers_autoprobe(struct bus_type *bus,
230 const char *buf, size_t count)
233 bus->p->drivers_autoprobe = 0;
235 bus->p->drivers_autoprobe = 1;
239 static ssize_t store_drivers_probe(struct bus_type *bus,
240 const char *buf, size_t count)
244 dev = bus_find_device_by_name(bus, NULL, buf);
247 if (bus_rescan_devices_helper(dev, NULL) != 0)
253 static struct device *next_device(struct klist_iter *i)
255 struct klist_node *n = klist_next(i);
256 return n ? container_of(n, struct device, knode_bus) : NULL;
260 * bus_for_each_dev - device iterator.
262 * @start: device to start iterating from.
263 * @data: data for the callback.
264 * @fn: function to be called for each device.
266 * Iterate over @bus's list of devices, and call @fn for each,
267 * passing it @data. If @start is not NULL, we use that device to
268 * begin iterating from.
270 * We check the return of @fn each time. If it returns anything
271 * other than 0, we break out and return that value.
273 * NOTE: The device that returns a non-zero value is not retained
274 * in any way, nor is its refcount incremented. If the caller needs
275 * to retain this data, it should do, and increment the reference
276 * count in the supplied callback.
278 int bus_for_each_dev(struct bus_type *bus, struct device *start,
279 void *data, int (*fn)(struct device *, void *))
288 klist_iter_init_node(&bus->p->klist_devices, &i,
289 (start ? &start->knode_bus : NULL));
290 while ((dev = next_device(&i)) && !error)
291 error = fn(dev, data);
295 EXPORT_SYMBOL_GPL(bus_for_each_dev);
298 * bus_find_device - device iterator for locating a particular device.
300 * @start: Device to begin with
301 * @data: Data to pass to match function
302 * @match: Callback function to check device
304 * This is similar to the bus_for_each_dev() function above, but it
305 * returns a reference to a device that is 'found' for later use, as
306 * determined by the @match callback.
308 * The callback should return 0 if the device doesn't match and non-zero
309 * if it does. If the callback returns non-zero, this function will
310 * return to the caller and not iterate over any more devices.
312 struct device *bus_find_device(struct bus_type *bus,
313 struct device *start, void *data,
314 int (*match)(struct device *dev, void *data))
322 klist_iter_init_node(&bus->p->klist_devices, &i,
323 (start ? &start->knode_bus : NULL));
324 while ((dev = next_device(&i)))
325 if (match(dev, data) && get_device(dev))
330 EXPORT_SYMBOL_GPL(bus_find_device);
332 static int match_name(struct device *dev, void *data)
334 const char *name = data;
336 if (strcmp(name, dev->bus_id) == 0)
342 * bus_find_device_by_name - device iterator for locating a particular device of a specific name
344 * @start: Device to begin with
345 * @name: name of the device to match
347 * This is similar to the bus_find_device() function above, but it handles
348 * searching by a name automatically, no need to write another strcmp matching
351 struct device *bus_find_device_by_name(struct bus_type *bus,
352 struct device *start, const char *name)
354 return bus_find_device(bus, start, (void *)name, match_name);
356 EXPORT_SYMBOL_GPL(bus_find_device_by_name);
358 static struct device_driver *next_driver(struct klist_iter *i)
360 struct klist_node *n = klist_next(i);
361 struct driver_private *drv_priv;
364 drv_priv = container_of(n, struct driver_private, knode_bus);
365 return drv_priv->driver;
371 * bus_for_each_drv - driver iterator
372 * @bus: bus we're dealing with.
373 * @start: driver to start iterating on.
374 * @data: data to pass to the callback.
375 * @fn: function to call for each driver.
377 * This is nearly identical to the device iterator above.
378 * We iterate over each driver that belongs to @bus, and call
379 * @fn for each. If @fn returns anything but 0, we break out
380 * and return it. If @start is not NULL, we use it as the head
383 * NOTE: we don't return the driver that returns a non-zero
384 * value, nor do we leave the reference count incremented for that
385 * driver. If the caller needs to know that info, it must set it
386 * in the callback. It must also be sure to increment the refcount
387 * so it doesn't disappear before returning to the caller.
389 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
390 void *data, int (*fn)(struct device_driver *, void *))
393 struct device_driver *drv;
399 klist_iter_init_node(&bus->p->klist_drivers, &i,
400 start ? &start->p->knode_bus : NULL);
401 while ((drv = next_driver(&i)) && !error)
402 error = fn(drv, data);
406 EXPORT_SYMBOL_GPL(bus_for_each_drv);
408 static int device_add_attrs(struct bus_type *bus, struct device *dev)
416 for (i = 0; attr_name(bus->dev_attrs[i]); i++) {
417 error = device_create_file(dev, &bus->dev_attrs[i]);
420 device_remove_file(dev, &bus->dev_attrs[i]);
427 static void device_remove_attrs(struct bus_type *bus, struct device *dev)
431 if (bus->dev_attrs) {
432 for (i = 0; attr_name(bus->dev_attrs[i]); i++)
433 device_remove_file(dev, &bus->dev_attrs[i]);
437 #ifdef CONFIG_SYSFS_DEPRECATED
438 static int make_deprecated_bus_links(struct device *dev)
440 return sysfs_create_link(&dev->kobj,
441 &dev->bus->p->subsys.kobj, "bus");
444 static void remove_deprecated_bus_links(struct device *dev)
446 sysfs_remove_link(&dev->kobj, "bus");
449 static inline int make_deprecated_bus_links(struct device *dev) { return 0; }
450 static inline void remove_deprecated_bus_links(struct device *dev) { }
454 * bus_add_device - add device to bus
455 * @dev: device being added
457 * - Add the device to its bus's list of devices.
458 * - Create link to device's bus.
460 int bus_add_device(struct device *dev)
462 struct bus_type *bus = bus_get(dev->bus);
466 pr_debug("bus: '%s': add device %s\n", bus->name, dev->bus_id);
467 error = device_add_attrs(bus, dev);
470 error = sysfs_create_link(&bus->p->devices_kset->kobj,
471 &dev->kobj, dev->bus_id);
474 error = sysfs_create_link(&dev->kobj,
475 &dev->bus->p->subsys.kobj, "subsystem");
478 error = make_deprecated_bus_links(dev);
485 sysfs_remove_link(&dev->kobj, "subsystem");
487 sysfs_remove_link(&bus->p->devices_kset->kobj, dev->bus_id);
489 device_remove_attrs(bus, dev);
496 * bus_attach_device - add device to bus
497 * @dev: device tried to attach to a driver
499 * - Add device to bus's list of devices.
500 * - Try to attach to driver.
502 void bus_attach_device(struct device *dev)
504 struct bus_type *bus = dev->bus;
508 if (bus->p->drivers_autoprobe)
509 ret = device_attach(dev);
512 klist_add_tail(&dev->knode_bus, &bus->p->klist_devices);
517 * bus_remove_device - remove device from bus
518 * @dev: device to be removed
520 * - Remove symlink from bus's directory.
521 * - Delete device from bus's list.
522 * - Detach from its driver.
523 * - Drop reference taken in bus_add_device().
525 void bus_remove_device(struct device *dev)
528 sysfs_remove_link(&dev->kobj, "subsystem");
529 remove_deprecated_bus_links(dev);
530 sysfs_remove_link(&dev->bus->p->devices_kset->kobj,
532 device_remove_attrs(dev->bus, dev);
533 klist_del(&dev->knode_bus);
535 pr_debug("bus: '%s': remove device %s\n",
536 dev->bus->name, dev->bus_id);
537 device_release_driver(dev);
542 static int driver_add_attrs(struct bus_type *bus, struct device_driver *drv)
547 if (bus->drv_attrs) {
548 for (i = 0; attr_name(bus->drv_attrs[i]); i++) {
549 error = driver_create_file(drv, &bus->drv_attrs[i]);
558 driver_remove_file(drv, &bus->drv_attrs[i]);
562 static void driver_remove_attrs(struct bus_type *bus,
563 struct device_driver *drv)
567 if (bus->drv_attrs) {
568 for (i = 0; attr_name(bus->drv_attrs[i]); i++)
569 driver_remove_file(drv, &bus->drv_attrs[i]);
573 #ifdef CONFIG_HOTPLUG
575 * Thanks to drivers making their tables __devinit, we can't allow manual
576 * bind and unbind from userspace unless CONFIG_HOTPLUG is enabled.
578 static int __must_check add_bind_files(struct device_driver *drv)
582 ret = driver_create_file(drv, &driver_attr_unbind);
584 ret = driver_create_file(drv, &driver_attr_bind);
586 driver_remove_file(drv, &driver_attr_unbind);
591 static void remove_bind_files(struct device_driver *drv)
593 driver_remove_file(drv, &driver_attr_bind);
594 driver_remove_file(drv, &driver_attr_unbind);
597 static BUS_ATTR(drivers_probe, S_IWUSR, NULL, store_drivers_probe);
598 static BUS_ATTR(drivers_autoprobe, S_IWUSR | S_IRUGO,
599 show_drivers_autoprobe, store_drivers_autoprobe);
601 static int add_probe_files(struct bus_type *bus)
605 retval = bus_create_file(bus, &bus_attr_drivers_probe);
609 retval = bus_create_file(bus, &bus_attr_drivers_autoprobe);
611 bus_remove_file(bus, &bus_attr_drivers_probe);
616 static void remove_probe_files(struct bus_type *bus)
618 bus_remove_file(bus, &bus_attr_drivers_autoprobe);
619 bus_remove_file(bus, &bus_attr_drivers_probe);
622 static inline int add_bind_files(struct device_driver *drv) { return 0; }
623 static inline void remove_bind_files(struct device_driver *drv) {}
624 static inline int add_probe_files(struct bus_type *bus) { return 0; }
625 static inline void remove_probe_files(struct bus_type *bus) {}
628 static ssize_t driver_uevent_store(struct device_driver *drv,
629 const char *buf, size_t count)
631 enum kobject_action action;
633 if (kobject_action_type(buf, count, &action) == 0)
634 kobject_uevent(&drv->p->kobj, action);
637 static DRIVER_ATTR(uevent, S_IWUSR, NULL, driver_uevent_store);
640 * bus_add_driver - Add a driver to the bus.
643 int bus_add_driver(struct device_driver *drv)
645 struct bus_type *bus;
646 struct driver_private *priv;
649 bus = bus_get(drv->bus);
653 pr_debug("bus: '%s': add driver %s\n", bus->name, drv->name);
655 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
660 klist_init(&priv->klist_devices, NULL, NULL);
663 priv->kobj.kset = bus->p->drivers_kset;
664 error = kobject_init_and_add(&priv->kobj, &driver_ktype, NULL,
669 if (drv->bus->p->drivers_autoprobe) {
670 error = driver_attach(drv);
674 klist_add_tail(&priv->knode_bus, &bus->p->klist_drivers);
675 module_add_driver(drv->owner, drv);
677 error = driver_create_file(drv, &driver_attr_uevent);
679 printk(KERN_ERR "%s: uevent attr (%s) failed\n",
680 __func__, drv->name);
682 error = driver_add_attrs(bus, drv);
684 /* How the hell do we get out of this pickle? Give up */
685 printk(KERN_ERR "%s: driver_add_attrs(%s) failed\n",
686 __func__, drv->name);
688 error = add_bind_files(drv);
691 printk(KERN_ERR "%s: add_bind_files(%s) failed\n",
692 __func__, drv->name);
695 kobject_uevent(&priv->kobj, KOBJ_ADD);
698 kobject_put(&priv->kobj);
705 * bus_remove_driver - delete driver from bus's knowledge.
708 * Detach the driver from the devices it controls, and remove
709 * it from its bus's list of drivers. Finally, we drop the reference
710 * to the bus we took in bus_add_driver().
712 void bus_remove_driver(struct device_driver *drv)
717 remove_bind_files(drv);
718 driver_remove_attrs(drv->bus, drv);
719 driver_remove_file(drv, &driver_attr_uevent);
720 klist_remove(&drv->p->knode_bus);
721 pr_debug("bus: '%s': remove driver %s\n", drv->bus->name, drv->name);
723 module_remove_driver(drv);
724 kobject_put(&drv->p->kobj);
728 /* Helper for bus_rescan_devices's iter */
729 static int __must_check bus_rescan_devices_helper(struct device *dev,
735 if (dev->parent) /* Needed for USB */
736 down(&dev->parent->sem);
737 ret = device_attach(dev);
739 up(&dev->parent->sem);
741 return ret < 0 ? ret : 0;
745 * bus_rescan_devices - rescan devices on the bus for possible drivers
746 * @bus: the bus to scan.
748 * This function will look for devices on the bus with no driver
749 * attached and rescan it against existing drivers to see if it matches
750 * any by calling device_attach() for the unbound devices.
752 int bus_rescan_devices(struct bus_type *bus)
754 return bus_for_each_dev(bus, NULL, NULL, bus_rescan_devices_helper);
756 EXPORT_SYMBOL_GPL(bus_rescan_devices);
759 * device_reprobe - remove driver for a device and probe for a new driver
760 * @dev: the device to reprobe
762 * This function detaches the attached driver (if any) for the given
763 * device and restarts the driver probing process. It is intended
764 * to use if probing criteria changed during a devices lifetime and
765 * driver attachment should change accordingly.
767 int device_reprobe(struct device *dev)
770 if (dev->parent) /* Needed for USB */
771 down(&dev->parent->sem);
772 device_release_driver(dev);
774 up(&dev->parent->sem);
776 return bus_rescan_devices_helper(dev, NULL);
778 EXPORT_SYMBOL_GPL(device_reprobe);
781 * find_bus - locate bus by name.
782 * @name: name of bus.
784 * Call kset_find_obj() to iterate over list of buses to
785 * find a bus by name. Return bus if found.
787 * Note that kset_find_obj increments bus' reference count.
790 struct bus_type *find_bus(char *name)
792 struct kobject *k = kset_find_obj(bus_kset, name);
793 return k ? to_bus(k) : NULL;
799 * bus_add_attrs - Add default attributes for this bus.
800 * @bus: Bus that has just been registered.
803 static int bus_add_attrs(struct bus_type *bus)
808 if (bus->bus_attrs) {
809 for (i = 0; attr_name(bus->bus_attrs[i]); i++) {
810 error = bus_create_file(bus, &bus->bus_attrs[i]);
819 bus_remove_file(bus, &bus->bus_attrs[i]);
823 static void bus_remove_attrs(struct bus_type *bus)
827 if (bus->bus_attrs) {
828 for (i = 0; attr_name(bus->bus_attrs[i]); i++)
829 bus_remove_file(bus, &bus->bus_attrs[i]);
833 static void klist_devices_get(struct klist_node *n)
835 struct device *dev = container_of(n, struct device, knode_bus);
840 static void klist_devices_put(struct klist_node *n)
842 struct device *dev = container_of(n, struct device, knode_bus);
847 static ssize_t bus_uevent_store(struct bus_type *bus,
848 const char *buf, size_t count)
850 enum kobject_action action;
852 if (kobject_action_type(buf, count, &action) == 0)
853 kobject_uevent(&bus->p->subsys.kobj, action);
856 static BUS_ATTR(uevent, S_IWUSR, NULL, bus_uevent_store);
859 * bus_register - register a bus with the system.
862 * Once we have that, we registered the bus with the kobject
863 * infrastructure, then register the children subsystems it has:
864 * the devices and drivers that belong to the bus.
866 int bus_register(struct bus_type *bus)
869 struct bus_type_private *priv;
871 priv = kzalloc(sizeof(struct bus_type_private), GFP_KERNEL);
878 BLOCKING_INIT_NOTIFIER_HEAD(&priv->bus_notifier);
880 retval = kobject_set_name(&priv->subsys.kobj, "%s", bus->name);
884 priv->subsys.kobj.kset = bus_kset;
885 priv->subsys.kobj.ktype = &bus_ktype;
886 priv->drivers_autoprobe = 1;
888 retval = kset_register(&priv->subsys);
892 retval = bus_create_file(bus, &bus_attr_uevent);
894 goto bus_uevent_fail;
896 priv->devices_kset = kset_create_and_add("devices", NULL,
898 if (!priv->devices_kset) {
900 goto bus_devices_fail;
903 priv->drivers_kset = kset_create_and_add("drivers", NULL,
905 if (!priv->drivers_kset) {
907 goto bus_drivers_fail;
910 klist_init(&priv->klist_devices, klist_devices_get, klist_devices_put);
911 klist_init(&priv->klist_drivers, NULL, NULL);
913 retval = add_probe_files(bus);
915 goto bus_probe_files_fail;
917 retval = bus_add_attrs(bus);
921 pr_debug("bus: '%s': registered\n", bus->name);
925 remove_probe_files(bus);
926 bus_probe_files_fail:
927 kset_unregister(bus->p->drivers_kset);
929 kset_unregister(bus->p->devices_kset);
931 bus_remove_file(bus, &bus_attr_uevent);
933 kset_unregister(&bus->p->subsys);
938 EXPORT_SYMBOL_GPL(bus_register);
941 * bus_unregister - remove a bus from the system
944 * Unregister the child subsystems and the bus itself.
945 * Finally, we call bus_put() to release the refcount
947 void bus_unregister(struct bus_type *bus)
949 pr_debug("bus: '%s': unregistering\n", bus->name);
950 bus_remove_attrs(bus);
951 remove_probe_files(bus);
952 kset_unregister(bus->p->drivers_kset);
953 kset_unregister(bus->p->devices_kset);
954 bus_remove_file(bus, &bus_attr_uevent);
955 kset_unregister(&bus->p->subsys);
958 EXPORT_SYMBOL_GPL(bus_unregister);
960 int bus_register_notifier(struct bus_type *bus, struct notifier_block *nb)
962 return blocking_notifier_chain_register(&bus->p->bus_notifier, nb);
964 EXPORT_SYMBOL_GPL(bus_register_notifier);
966 int bus_unregister_notifier(struct bus_type *bus, struct notifier_block *nb)
968 return blocking_notifier_chain_unregister(&bus->p->bus_notifier, nb);
970 EXPORT_SYMBOL_GPL(bus_unregister_notifier);
972 struct kset *bus_get_kset(struct bus_type *bus)
974 return &bus->p->subsys;
976 EXPORT_SYMBOL_GPL(bus_get_kset);
978 struct klist *bus_get_device_klist(struct bus_type *bus)
980 return &bus->p->klist_devices;
982 EXPORT_SYMBOL_GPL(bus_get_device_klist);
984 int __init buses_init(void)
986 bus_kset = kset_create_and_add("bus", &bus_uevent_ops, NULL);