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/device.h>
12 #include <linux/module.h>
13 #include <linux/errno.h>
14 #include <linux/init.h>
15 #include <linux/string.h>
17 #include "power/power.h"
19 #define to_bus_attr(_attr) container_of(_attr, struct bus_attribute, attr)
20 #define to_bus(obj) container_of(obj, struct bus_type, subsys.kobj)
23 * sysfs bindings for drivers
26 #define to_drv_attr(_attr) container_of(_attr, struct driver_attribute, attr)
27 #define to_driver(obj) container_of(obj, struct device_driver, kobj)
30 static int __must_check
bus_rescan_devices_helper(struct device
*dev
,
34 drv_attr_show(struct kobject
* kobj
, struct attribute
* attr
, char * buf
)
36 struct driver_attribute
* drv_attr
= to_drv_attr(attr
);
37 struct device_driver
* drv
= to_driver(kobj
);
41 ret
= drv_attr
->show(drv
, buf
);
46 drv_attr_store(struct kobject
* kobj
, struct attribute
* attr
,
47 const char * buf
, size_t count
)
49 struct driver_attribute
* drv_attr
= to_drv_attr(attr
);
50 struct device_driver
* drv
= to_driver(kobj
);
54 ret
= drv_attr
->store(drv
, buf
, count
);
58 static struct sysfs_ops driver_sysfs_ops
= {
59 .show
= drv_attr_show
,
60 .store
= drv_attr_store
,
64 static void driver_release(struct kobject
* kobj
)
67 * Yes this is an empty release function, it is this way because struct
68 * device is always a static object, not a dynamic one. Yes, this is
69 * not nice and bad, but remember, drivers are code, reference counted
70 * by the module count, not a device, which is really data. And yes,
71 * in the future I do want to have all drivers be created dynamically,
72 * and am working toward that goal, but it will take a bit longer...
74 * But do not let this example give _anyone_ the idea that they can
75 * create a release function without any code in it at all, to do that
76 * is almost always wrong. If you have any questions about this,
77 * please send an email to <greg@kroah.com>
81 static struct kobj_type ktype_driver
= {
82 .sysfs_ops
= &driver_sysfs_ops
,
83 .release
= driver_release
,
88 * sysfs bindings for buses
93 bus_attr_show(struct kobject
* kobj
, struct attribute
* attr
, char * buf
)
95 struct bus_attribute
* bus_attr
= to_bus_attr(attr
);
96 struct bus_type
* bus
= to_bus(kobj
);
100 ret
= bus_attr
->show(bus
, buf
);
105 bus_attr_store(struct kobject
* kobj
, struct attribute
* attr
,
106 const char * buf
, size_t count
)
108 struct bus_attribute
* bus_attr
= to_bus_attr(attr
);
109 struct bus_type
* bus
= to_bus(kobj
);
113 ret
= bus_attr
->store(bus
, buf
, count
);
117 static struct sysfs_ops bus_sysfs_ops
= {
118 .show
= bus_attr_show
,
119 .store
= bus_attr_store
,
122 int bus_create_file(struct bus_type
* bus
, struct bus_attribute
* attr
)
126 error
= sysfs_create_file(&bus
->subsys
.kobj
, &attr
->attr
);
133 void bus_remove_file(struct bus_type
* bus
, struct bus_attribute
* attr
)
136 sysfs_remove_file(&bus
->subsys
.kobj
, &attr
->attr
);
141 static struct kobj_type bus_ktype
= {
142 .sysfs_ops
= &bus_sysfs_ops
,
145 static int bus_uevent_filter(struct kset
*kset
, struct kobject
*kobj
)
147 struct kobj_type
*ktype
= get_ktype(kobj
);
149 if (ktype
== &bus_ktype
)
154 static struct kset_uevent_ops bus_uevent_ops
= {
155 .filter
= bus_uevent_filter
,
158 static decl_subsys(bus
, &bus_ktype
, &bus_uevent_ops
);
161 #ifdef CONFIG_HOTPLUG
162 /* Manually detach a device from its associated driver. */
163 static int driver_helper(struct device
*dev
, void *data
)
165 const char *name
= data
;
167 if (strcmp(name
, dev
->bus_id
) == 0)
172 static ssize_t
driver_unbind(struct device_driver
*drv
,
173 const char *buf
, size_t count
)
175 struct bus_type
*bus
= get_bus(drv
->bus
);
179 dev
= bus_find_device(bus
, NULL
, (void *)buf
, driver_helper
);
180 if (dev
&& dev
->driver
== drv
) {
181 if (dev
->parent
) /* Needed for USB */
182 down(&dev
->parent
->sem
);
183 device_release_driver(dev
);
185 up(&dev
->parent
->sem
);
192 static DRIVER_ATTR(unbind
, S_IWUSR
, NULL
, driver_unbind
);
195 * Manually attach a device to a driver.
196 * Note: the driver must want to bind to the device,
197 * it is not possible to override the driver's id table.
199 static ssize_t
driver_bind(struct device_driver
*drv
,
200 const char *buf
, size_t count
)
202 struct bus_type
*bus
= get_bus(drv
->bus
);
206 dev
= bus_find_device(bus
, NULL
, (void *)buf
, driver_helper
);
207 if (dev
&& dev
->driver
== NULL
) {
208 if (dev
->parent
) /* Needed for USB */
209 down(&dev
->parent
->sem
);
211 err
= driver_probe_device(drv
, dev
);
214 up(&dev
->parent
->sem
);
216 if (err
> 0) /* success */
218 else if (err
== 0) /* driver didn't accept device */
225 static DRIVER_ATTR(bind
, S_IWUSR
, NULL
, driver_bind
);
227 static ssize_t
show_drivers_autoprobe(struct bus_type
*bus
, char *buf
)
229 return sprintf(buf
, "%d\n", bus
->drivers_autoprobe
);
232 static ssize_t
store_drivers_autoprobe(struct bus_type
*bus
,
233 const char *buf
, size_t count
)
236 bus
->drivers_autoprobe
= 0;
238 bus
->drivers_autoprobe
= 1;
242 static ssize_t
store_drivers_probe(struct bus_type
*bus
,
243 const char *buf
, size_t count
)
247 dev
= bus_find_device(bus
, NULL
, (void *)buf
, driver_helper
);
250 if (bus_rescan_devices_helper(dev
, NULL
) != 0)
256 static struct device
* next_device(struct klist_iter
* i
)
258 struct klist_node
* n
= klist_next(i
);
259 return n
? container_of(n
, struct device
, knode_bus
) : NULL
;
263 * bus_for_each_dev - device iterator.
265 * @start: device to start iterating from.
266 * @data: data for the callback.
267 * @fn: function to be called for each device.
269 * Iterate over @bus's list of devices, and call @fn for each,
270 * passing it @data. If @start is not NULL, we use that device to
271 * begin iterating from.
273 * We check the return of @fn each time. If it returns anything
274 * other than 0, we break out and return that value.
276 * NOTE: The device that returns a non-zero value is not retained
277 * in any way, nor is its refcount incremented. If the caller needs
278 * to retain this data, it should do, and increment the reference
279 * count in the supplied callback.
282 int bus_for_each_dev(struct bus_type
* bus
, struct device
* start
,
283 void * data
, int (*fn
)(struct device
*, void *))
292 klist_iter_init_node(&bus
->klist_devices
, &i
,
293 (start
? &start
->knode_bus
: NULL
));
294 while ((dev
= next_device(&i
)) && !error
)
295 error
= fn(dev
, data
);
301 * bus_find_device - device iterator for locating a particular device.
303 * @start: Device to begin with
304 * @data: Data to pass to match function
305 * @match: Callback function to check device
307 * This is similar to the bus_for_each_dev() function above, but it
308 * returns a reference to a device that is 'found' for later use, as
309 * determined by the @match callback.
311 * The callback should return 0 if the device doesn't match and non-zero
312 * if it does. If the callback returns non-zero, this function will
313 * return to the caller and not iterate over any more devices.
315 struct device
* bus_find_device(struct bus_type
*bus
,
316 struct device
*start
, void *data
,
317 int (*match
)(struct device
*, void *))
325 klist_iter_init_node(&bus
->klist_devices
, &i
,
326 (start
? &start
->knode_bus
: NULL
));
327 while ((dev
= next_device(&i
)))
328 if (match(dev
, data
) && get_device(dev
))
335 static struct device_driver
* next_driver(struct klist_iter
* i
)
337 struct klist_node
* n
= klist_next(i
);
338 return n
? container_of(n
, struct device_driver
, knode_bus
) : NULL
;
342 * bus_for_each_drv - driver iterator
343 * @bus: bus we're dealing with.
344 * @start: driver to start iterating on.
345 * @data: data to pass to the callback.
346 * @fn: function to call for each driver.
348 * This is nearly identical to the device iterator above.
349 * We iterate over each driver that belongs to @bus, and call
350 * @fn for each. If @fn returns anything but 0, we break out
351 * and return it. If @start is not NULL, we use it as the head
354 * NOTE: we don't return the driver that returns a non-zero
355 * value, nor do we leave the reference count incremented for that
356 * driver. If the caller needs to know that info, it must set it
357 * in the callback. It must also be sure to increment the refcount
358 * so it doesn't disappear before returning to the caller.
361 int bus_for_each_drv(struct bus_type
* bus
, struct device_driver
* start
,
362 void * data
, int (*fn
)(struct device_driver
*, void *))
365 struct device_driver
* drv
;
371 klist_iter_init_node(&bus
->klist_drivers
, &i
,
372 start
? &start
->knode_bus
: NULL
);
373 while ((drv
= next_driver(&i
)) && !error
)
374 error
= fn(drv
, data
);
379 static int device_add_attrs(struct bus_type
*bus
, struct device
*dev
)
387 for (i
= 0; attr_name(bus
->dev_attrs
[i
]); i
++) {
388 error
= device_create_file(dev
,&bus
->dev_attrs
[i
]);
391 device_remove_file(dev
, &bus
->dev_attrs
[i
]);
398 static void device_remove_attrs(struct bus_type
* bus
, struct device
* dev
)
402 if (bus
->dev_attrs
) {
403 for (i
= 0; attr_name(bus
->dev_attrs
[i
]); i
++)
404 device_remove_file(dev
,&bus
->dev_attrs
[i
]);
408 #ifdef CONFIG_SYSFS_DEPRECATED
409 static int make_deprecated_bus_links(struct device
*dev
)
411 return sysfs_create_link(&dev
->kobj
,
412 &dev
->bus
->subsys
.kobj
, "bus");
415 static void remove_deprecated_bus_links(struct device
*dev
)
417 sysfs_remove_link(&dev
->kobj
, "bus");
420 static inline int make_deprecated_bus_links(struct device
*dev
) { return 0; }
421 static inline void remove_deprecated_bus_links(struct device
*dev
) { }
425 * bus_add_device - add device to bus
426 * @dev: device being added
428 * - Add the device to its bus's list of devices.
429 * - Create link to device's bus.
431 int bus_add_device(struct device
* dev
)
433 struct bus_type
* bus
= get_bus(dev
->bus
);
437 pr_debug("bus %s: add device %s\n", bus
->name
, dev
->bus_id
);
438 error
= device_add_attrs(bus
, dev
);
441 error
= sysfs_create_link(&bus
->devices
.kobj
,
442 &dev
->kobj
, dev
->bus_id
);
445 error
= sysfs_create_link(&dev
->kobj
,
446 &dev
->bus
->subsys
.kobj
, "subsystem");
449 error
= make_deprecated_bus_links(dev
);
456 sysfs_remove_link(&dev
->kobj
, "subsystem");
458 sysfs_remove_link(&bus
->devices
.kobj
, dev
->bus_id
);
460 device_remove_attrs(bus
, dev
);
467 * bus_attach_device - add device to bus
468 * @dev: device tried to attach to a driver
470 * - Add device to bus's list of devices.
471 * - Try to attach to driver.
473 void bus_attach_device(struct device
* dev
)
475 struct bus_type
*bus
= dev
->bus
;
479 dev
->is_registered
= 1;
480 if (bus
->drivers_autoprobe
)
481 ret
= device_attach(dev
);
484 klist_add_tail(&dev
->knode_bus
, &bus
->klist_devices
);
486 dev
->is_registered
= 0;
491 * bus_remove_device - remove device from bus
492 * @dev: device to be removed
494 * - Remove symlink from bus's directory.
495 * - Delete device from bus's list.
496 * - Detach from its driver.
497 * - Drop reference taken in bus_add_device().
499 void bus_remove_device(struct device
* dev
)
502 sysfs_remove_link(&dev
->kobj
, "subsystem");
503 remove_deprecated_bus_links(dev
);
504 sysfs_remove_link(&dev
->bus
->devices
.kobj
, dev
->bus_id
);
505 device_remove_attrs(dev
->bus
, dev
);
506 if (dev
->is_registered
) {
507 dev
->is_registered
= 0;
508 klist_del(&dev
->knode_bus
);
510 pr_debug("bus %s: remove device %s\n", dev
->bus
->name
, dev
->bus_id
);
511 device_release_driver(dev
);
516 static int driver_add_attrs(struct bus_type
* bus
, struct device_driver
* drv
)
521 if (bus
->drv_attrs
) {
522 for (i
= 0; attr_name(bus
->drv_attrs
[i
]); i
++) {
523 error
= driver_create_file(drv
, &bus
->drv_attrs
[i
]);
532 driver_remove_file(drv
, &bus
->drv_attrs
[i
]);
537 static void driver_remove_attrs(struct bus_type
* bus
, struct device_driver
* drv
)
541 if (bus
->drv_attrs
) {
542 for (i
= 0; attr_name(bus
->drv_attrs
[i
]); i
++)
543 driver_remove_file(drv
, &bus
->drv_attrs
[i
]);
547 #ifdef CONFIG_HOTPLUG
549 * Thanks to drivers making their tables __devinit, we can't allow manual
550 * bind and unbind from userspace unless CONFIG_HOTPLUG is enabled.
552 static int __must_check
add_bind_files(struct device_driver
*drv
)
556 ret
= driver_create_file(drv
, &driver_attr_unbind
);
558 ret
= driver_create_file(drv
, &driver_attr_bind
);
560 driver_remove_file(drv
, &driver_attr_unbind
);
565 static void remove_bind_files(struct device_driver
*drv
)
567 driver_remove_file(drv
, &driver_attr_bind
);
568 driver_remove_file(drv
, &driver_attr_unbind
);
571 static int add_probe_files(struct bus_type
*bus
)
575 bus
->drivers_probe_attr
.attr
.name
= "drivers_probe";
576 bus
->drivers_probe_attr
.attr
.mode
= S_IWUSR
;
577 bus
->drivers_probe_attr
.store
= store_drivers_probe
;
578 retval
= bus_create_file(bus
, &bus
->drivers_probe_attr
);
582 bus
->drivers_autoprobe_attr
.attr
.name
= "drivers_autoprobe";
583 bus
->drivers_autoprobe_attr
.attr
.mode
= S_IWUSR
| S_IRUGO
;
584 bus
->drivers_autoprobe_attr
.show
= show_drivers_autoprobe
;
585 bus
->drivers_autoprobe_attr
.store
= store_drivers_autoprobe
;
586 retval
= bus_create_file(bus
, &bus
->drivers_autoprobe_attr
);
588 bus_remove_file(bus
, &bus
->drivers_probe_attr
);
593 static void remove_probe_files(struct bus_type
*bus
)
595 bus_remove_file(bus
, &bus
->drivers_autoprobe_attr
);
596 bus_remove_file(bus
, &bus
->drivers_probe_attr
);
599 static inline int add_bind_files(struct device_driver
*drv
) { return 0; }
600 static inline void remove_bind_files(struct device_driver
*drv
) {}
601 static inline int add_probe_files(struct bus_type
*bus
) { return 0; }
602 static inline void remove_probe_files(struct bus_type
*bus
) {}
606 * bus_add_driver - Add a driver to the bus.
610 int bus_add_driver(struct device_driver
*drv
)
612 struct bus_type
* bus
= get_bus(drv
->bus
);
618 pr_debug("bus %s: add driver %s\n", bus
->name
, drv
->name
);
619 error
= kobject_set_name(&drv
->kobj
, "%s", drv
->name
);
622 drv
->kobj
.kset
= &bus
->drivers
;
623 error
= kobject_register(&drv
->kobj
);
627 if (drv
->bus
->drivers_autoprobe
) {
628 error
= driver_attach(drv
);
632 klist_add_tail(&drv
->knode_bus
, &bus
->klist_drivers
);
633 module_add_driver(drv
->owner
, drv
);
635 error
= driver_add_attrs(bus
, drv
);
637 /* How the hell do we get out of this pickle? Give up */
638 printk(KERN_ERR
"%s: driver_add_attrs(%s) failed\n",
639 __FUNCTION__
, drv
->name
);
641 error
= add_bind_files(drv
);
644 printk(KERN_ERR
"%s: add_bind_files(%s) failed\n",
645 __FUNCTION__
, drv
->name
);
650 kobject_unregister(&drv
->kobj
);
657 * bus_remove_driver - delete driver from bus's knowledge.
660 * Detach the driver from the devices it controls, and remove
661 * it from its bus's list of drivers. Finally, we drop the reference
662 * to the bus we took in bus_add_driver().
665 void bus_remove_driver(struct device_driver
* drv
)
670 remove_bind_files(drv
);
671 driver_remove_attrs(drv
->bus
, drv
);
672 klist_remove(&drv
->knode_bus
);
673 pr_debug("bus %s: remove driver %s\n", drv
->bus
->name
, drv
->name
);
675 module_remove_driver(drv
);
676 kobject_unregister(&drv
->kobj
);
681 /* Helper for bus_rescan_devices's iter */
682 static int __must_check
bus_rescan_devices_helper(struct device
*dev
,
688 if (dev
->parent
) /* Needed for USB */
689 down(&dev
->parent
->sem
);
690 ret
= device_attach(dev
);
692 up(&dev
->parent
->sem
);
694 return ret
< 0 ? ret
: 0;
698 * bus_rescan_devices - rescan devices on the bus for possible drivers
699 * @bus: the bus to scan.
701 * This function will look for devices on the bus with no driver
702 * attached and rescan it against existing drivers to see if it matches
703 * any by calling device_attach() for the unbound devices.
705 int bus_rescan_devices(struct bus_type
* bus
)
707 return bus_for_each_dev(bus
, NULL
, NULL
, bus_rescan_devices_helper
);
711 * device_reprobe - remove driver for a device and probe for a new driver
712 * @dev: the device to reprobe
714 * This function detaches the attached driver (if any) for the given
715 * device and restarts the driver probing process. It is intended
716 * to use if probing criteria changed during a devices lifetime and
717 * driver attachment should change accordingly.
719 int device_reprobe(struct device
*dev
)
722 if (dev
->parent
) /* Needed for USB */
723 down(&dev
->parent
->sem
);
724 device_release_driver(dev
);
726 up(&dev
->parent
->sem
);
728 return bus_rescan_devices_helper(dev
, NULL
);
730 EXPORT_SYMBOL_GPL(device_reprobe
);
732 struct bus_type
*get_bus(struct bus_type
*bus
)
734 return bus
? container_of(subsys_get(&bus
->subsys
),
735 struct bus_type
, subsys
) : NULL
;
738 void put_bus(struct bus_type
* bus
)
740 subsys_put(&bus
->subsys
);
745 * find_bus - locate bus by name.
746 * @name: name of bus.
748 * Call kset_find_obj() to iterate over list of buses to
749 * find a bus by name. Return bus if found.
751 * Note that kset_find_obj increments bus' reference count.
754 struct bus_type
* find_bus(char * name
)
756 struct kobject
* k
= kset_find_obj(&bus_subsys
.kset
, name
);
757 return k
? to_bus(k
) : NULL
;
763 * bus_add_attrs - Add default attributes for this bus.
764 * @bus: Bus that has just been registered.
767 static int bus_add_attrs(struct bus_type
* bus
)
772 if (bus
->bus_attrs
) {
773 for (i
= 0; attr_name(bus
->bus_attrs
[i
]); i
++) {
774 error
= bus_create_file(bus
,&bus
->bus_attrs
[i
]);
783 bus_remove_file(bus
,&bus
->bus_attrs
[i
]);
787 static void bus_remove_attrs(struct bus_type
* bus
)
791 if (bus
->bus_attrs
) {
792 for (i
= 0; attr_name(bus
->bus_attrs
[i
]); i
++)
793 bus_remove_file(bus
,&bus
->bus_attrs
[i
]);
797 static void klist_devices_get(struct klist_node
*n
)
799 struct device
*dev
= container_of(n
, struct device
, knode_bus
);
804 static void klist_devices_put(struct klist_node
*n
)
806 struct device
*dev
= container_of(n
, struct device
, knode_bus
);
812 * bus_register - register a bus with the system.
815 * Once we have that, we registered the bus with the kobject
816 * infrastructure, then register the children subsystems it has:
817 * the devices and drivers that belong to the bus.
819 int bus_register(struct bus_type
* bus
)
823 BLOCKING_INIT_NOTIFIER_HEAD(&bus
->bus_notifier
);
825 retval
= kobject_set_name(&bus
->subsys
.kobj
, "%s", bus
->name
);
829 subsys_set_kset(bus
, bus_subsys
);
830 retval
= subsystem_register(&bus
->subsys
);
834 kobject_set_name(&bus
->devices
.kobj
, "devices");
835 bus
->devices
.kobj
.parent
= &bus
->subsys
.kobj
;
836 retval
= kset_register(&bus
->devices
);
838 goto bus_devices_fail
;
840 kobject_set_name(&bus
->drivers
.kobj
, "drivers");
841 bus
->drivers
.kobj
.parent
= &bus
->subsys
.kobj
;
842 bus
->drivers
.ktype
= &ktype_driver
;
843 retval
= kset_register(&bus
->drivers
);
845 goto bus_drivers_fail
;
847 klist_init(&bus
->klist_devices
, klist_devices_get
, klist_devices_put
);
848 klist_init(&bus
->klist_drivers
, NULL
, NULL
);
850 bus
->drivers_autoprobe
= 1;
851 retval
= add_probe_files(bus
);
853 goto bus_probe_files_fail
;
855 retval
= bus_add_attrs(bus
);
859 pr_debug("bus type '%s' registered\n", bus
->name
);
863 remove_probe_files(bus
);
864 bus_probe_files_fail
:
865 kset_unregister(&bus
->drivers
);
867 kset_unregister(&bus
->devices
);
869 subsystem_unregister(&bus
->subsys
);
875 * bus_unregister - remove a bus from the system
878 * Unregister the child subsystems and the bus itself.
879 * Finally, we call put_bus() to release the refcount
881 void bus_unregister(struct bus_type
* bus
)
883 pr_debug("bus %s: unregistering\n", bus
->name
);
884 bus_remove_attrs(bus
);
885 remove_probe_files(bus
);
886 kset_unregister(&bus
->drivers
);
887 kset_unregister(&bus
->devices
);
888 subsystem_unregister(&bus
->subsys
);
891 int bus_register_notifier(struct bus_type
*bus
, struct notifier_block
*nb
)
893 return blocking_notifier_chain_register(&bus
->bus_notifier
, nb
);
895 EXPORT_SYMBOL_GPL(bus_register_notifier
);
897 int bus_unregister_notifier(struct bus_type
*bus
, struct notifier_block
*nb
)
899 return blocking_notifier_chain_unregister(&bus
->bus_notifier
, nb
);
901 EXPORT_SYMBOL_GPL(bus_unregister_notifier
);
903 int __init
buses_init(void)
905 return subsystem_register(&bus_subsys
);
909 EXPORT_SYMBOL_GPL(bus_for_each_dev
);
910 EXPORT_SYMBOL_GPL(bus_find_device
);
911 EXPORT_SYMBOL_GPL(bus_for_each_drv
);
913 EXPORT_SYMBOL_GPL(bus_register
);
914 EXPORT_SYMBOL_GPL(bus_unregister
);
915 EXPORT_SYMBOL_GPL(bus_rescan_devices
);
917 EXPORT_SYMBOL_GPL(bus_create_file
);
918 EXPORT_SYMBOL_GPL(bus_remove_file
);