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.kset.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
)
66 struct device_driver
* drv
= to_driver(kobj
);
67 complete(&drv
->unloaded
);
70 static struct kobj_type ktype_driver
= {
71 .sysfs_ops
= &driver_sysfs_ops
,
72 .release
= driver_release
,
77 * sysfs bindings for buses
82 bus_attr_show(struct kobject
* kobj
, struct attribute
* attr
, char * buf
)
84 struct bus_attribute
* bus_attr
= to_bus_attr(attr
);
85 struct bus_type
* bus
= to_bus(kobj
);
89 ret
= bus_attr
->show(bus
, buf
);
94 bus_attr_store(struct kobject
* kobj
, struct attribute
* attr
,
95 const char * buf
, size_t count
)
97 struct bus_attribute
* bus_attr
= to_bus_attr(attr
);
98 struct bus_type
* bus
= to_bus(kobj
);
102 ret
= bus_attr
->store(bus
, buf
, count
);
106 static struct sysfs_ops bus_sysfs_ops
= {
107 .show
= bus_attr_show
,
108 .store
= bus_attr_store
,
111 int bus_create_file(struct bus_type
* bus
, struct bus_attribute
* attr
)
115 error
= sysfs_create_file(&bus
->subsys
.kset
.kobj
, &attr
->attr
);
122 void bus_remove_file(struct bus_type
* bus
, struct bus_attribute
* attr
)
125 sysfs_remove_file(&bus
->subsys
.kset
.kobj
, &attr
->attr
);
130 static struct kobj_type ktype_bus
= {
131 .sysfs_ops
= &bus_sysfs_ops
,
135 static decl_subsys(bus
, &ktype_bus
, NULL
);
138 #ifdef CONFIG_HOTPLUG
139 /* Manually detach a device from its associated driver. */
140 static int driver_helper(struct device
*dev
, void *data
)
142 const char *name
= data
;
144 if (strcmp(name
, dev
->bus_id
) == 0)
149 static ssize_t
driver_unbind(struct device_driver
*drv
,
150 const char *buf
, size_t count
)
152 struct bus_type
*bus
= get_bus(drv
->bus
);
156 dev
= bus_find_device(bus
, NULL
, (void *)buf
, driver_helper
);
157 if (dev
&& dev
->driver
== drv
) {
158 if (dev
->parent
) /* Needed for USB */
159 down(&dev
->parent
->sem
);
160 device_release_driver(dev
);
162 up(&dev
->parent
->sem
);
169 static DRIVER_ATTR(unbind
, S_IWUSR
, NULL
, driver_unbind
);
172 * Manually attach a device to a driver.
173 * Note: the driver must want to bind to the device,
174 * it is not possible to override the driver's id table.
176 static ssize_t
driver_bind(struct device_driver
*drv
,
177 const char *buf
, size_t count
)
179 struct bus_type
*bus
= get_bus(drv
->bus
);
183 dev
= bus_find_device(bus
, NULL
, (void *)buf
, driver_helper
);
184 if (dev
&& dev
->driver
== NULL
) {
185 if (dev
->parent
) /* Needed for USB */
186 down(&dev
->parent
->sem
);
188 err
= driver_probe_device(drv
, dev
);
191 up(&dev
->parent
->sem
);
193 if (err
> 0) /* success */
195 else if (err
== 0) /* driver didn't accept device */
202 static DRIVER_ATTR(bind
, S_IWUSR
, NULL
, driver_bind
);
204 static ssize_t
show_drivers_autoprobe(struct bus_type
*bus
, char *buf
)
206 return sprintf(buf
, "%d\n", bus
->drivers_autoprobe
);
209 static ssize_t
store_drivers_autoprobe(struct bus_type
*bus
,
210 const char *buf
, size_t count
)
213 bus
->drivers_autoprobe
= 0;
215 bus
->drivers_autoprobe
= 1;
219 static ssize_t
store_drivers_probe(struct bus_type
*bus
,
220 const char *buf
, size_t count
)
224 dev
= bus_find_device(bus
, NULL
, (void *)buf
, driver_helper
);
227 if (bus_rescan_devices_helper(dev
, NULL
) != 0)
233 static struct device
* next_device(struct klist_iter
* i
)
235 struct klist_node
* n
= klist_next(i
);
236 return n
? container_of(n
, struct device
, knode_bus
) : NULL
;
240 * bus_for_each_dev - device iterator.
242 * @start: device to start iterating from.
243 * @data: data for the callback.
244 * @fn: function to be called for each device.
246 * Iterate over @bus's list of devices, and call @fn for each,
247 * passing it @data. If @start is not NULL, we use that device to
248 * begin iterating from.
250 * We check the return of @fn each time. If it returns anything
251 * other than 0, we break out and return that value.
253 * NOTE: The device that returns a non-zero value is not retained
254 * in any way, nor is its refcount incremented. If the caller needs
255 * to retain this data, it should do, and increment the reference
256 * count in the supplied callback.
259 int bus_for_each_dev(struct bus_type
* bus
, struct device
* start
,
260 void * data
, int (*fn
)(struct device
*, void *))
269 klist_iter_init_node(&bus
->klist_devices
, &i
,
270 (start
? &start
->knode_bus
: NULL
));
271 while ((dev
= next_device(&i
)) && !error
)
272 error
= fn(dev
, data
);
278 * bus_find_device - device iterator for locating a particular device.
280 * @start: Device to begin with
281 * @data: Data to pass to match function
282 * @match: Callback function to check device
284 * This is similar to the bus_for_each_dev() function above, but it
285 * returns a reference to a device that is 'found' for later use, as
286 * determined by the @match callback.
288 * The callback should return 0 if the device doesn't match and non-zero
289 * if it does. If the callback returns non-zero, this function will
290 * return to the caller and not iterate over any more devices.
292 struct device
* bus_find_device(struct bus_type
*bus
,
293 struct device
*start
, void *data
,
294 int (*match
)(struct device
*, void *))
302 klist_iter_init_node(&bus
->klist_devices
, &i
,
303 (start
? &start
->knode_bus
: NULL
));
304 while ((dev
= next_device(&i
)))
305 if (match(dev
, data
) && get_device(dev
))
312 static struct device_driver
* next_driver(struct klist_iter
* i
)
314 struct klist_node
* n
= klist_next(i
);
315 return n
? container_of(n
, struct device_driver
, knode_bus
) : NULL
;
319 * bus_for_each_drv - driver iterator
320 * @bus: bus we're dealing with.
321 * @start: driver to start iterating on.
322 * @data: data to pass to the callback.
323 * @fn: function to call for each driver.
325 * This is nearly identical to the device iterator above.
326 * We iterate over each driver that belongs to @bus, and call
327 * @fn for each. If @fn returns anything but 0, we break out
328 * and return it. If @start is not NULL, we use it as the head
331 * NOTE: we don't return the driver that returns a non-zero
332 * value, nor do we leave the reference count incremented for that
333 * driver. If the caller needs to know that info, it must set it
334 * in the callback. It must also be sure to increment the refcount
335 * so it doesn't disappear before returning to the caller.
338 int bus_for_each_drv(struct bus_type
* bus
, struct device_driver
* start
,
339 void * data
, int (*fn
)(struct device_driver
*, void *))
342 struct device_driver
* drv
;
348 klist_iter_init_node(&bus
->klist_drivers
, &i
,
349 start
? &start
->knode_bus
: NULL
);
350 while ((drv
= next_driver(&i
)) && !error
)
351 error
= fn(drv
, data
);
356 static int device_add_attrs(struct bus_type
*bus
, struct device
*dev
)
364 for (i
= 0; attr_name(bus
->dev_attrs
[i
]); i
++) {
365 error
= device_create_file(dev
,&bus
->dev_attrs
[i
]);
368 device_remove_file(dev
, &bus
->dev_attrs
[i
]);
375 static void device_remove_attrs(struct bus_type
* bus
, struct device
* dev
)
379 if (bus
->dev_attrs
) {
380 for (i
= 0; attr_name(bus
->dev_attrs
[i
]); i
++)
381 device_remove_file(dev
,&bus
->dev_attrs
[i
]);
385 #ifdef CONFIG_SYSFS_DEPRECATED
386 static int make_deprecated_bus_links(struct device
*dev
)
388 return sysfs_create_link(&dev
->kobj
,
389 &dev
->bus
->subsys
.kset
.kobj
, "bus");
392 static void remove_deprecated_bus_links(struct device
*dev
)
394 sysfs_remove_link(&dev
->kobj
, "bus");
397 static inline int make_deprecated_bus_links(struct device
*dev
) { return 0; }
398 static inline void remove_deprecated_bus_links(struct device
*dev
) { }
402 * bus_add_device - add device to bus
403 * @dev: device being added
405 * - Add the device to its bus's list of devices.
406 * - Create link to device's bus.
408 int bus_add_device(struct device
* dev
)
410 struct bus_type
* bus
= get_bus(dev
->bus
);
414 pr_debug("bus %s: add device %s\n", bus
->name
, dev
->bus_id
);
415 error
= device_add_attrs(bus
, dev
);
418 error
= sysfs_create_link(&bus
->devices
.kobj
,
419 &dev
->kobj
, dev
->bus_id
);
422 error
= sysfs_create_link(&dev
->kobj
,
423 &dev
->bus
->subsys
.kset
.kobj
, "subsystem");
426 error
= make_deprecated_bus_links(dev
);
433 sysfs_remove_link(&dev
->kobj
, "subsystem");
435 sysfs_remove_link(&bus
->devices
.kobj
, dev
->bus_id
);
437 device_remove_attrs(bus
, dev
);
444 * bus_attach_device - add device to bus
445 * @dev: device tried to attach to a driver
447 * - Add device to bus's list of devices.
448 * - Try to attach to driver.
450 int bus_attach_device(struct device
* dev
)
452 struct bus_type
*bus
= dev
->bus
;
456 dev
->is_registered
= 1;
457 if (bus
->drivers_autoprobe
)
458 ret
= device_attach(dev
);
460 klist_add_tail(&dev
->knode_bus
, &bus
->klist_devices
);
463 dev
->is_registered
= 0;
469 * bus_remove_device - remove device from bus
470 * @dev: device to be removed
472 * - Remove symlink from bus's directory.
473 * - Delete device from bus's list.
474 * - Detach from its driver.
475 * - Drop reference taken in bus_add_device().
477 void bus_remove_device(struct device
* dev
)
480 sysfs_remove_link(&dev
->kobj
, "subsystem");
481 remove_deprecated_bus_links(dev
);
482 sysfs_remove_link(&dev
->bus
->devices
.kobj
, dev
->bus_id
);
483 device_remove_attrs(dev
->bus
, dev
);
484 if (dev
->is_registered
) {
485 dev
->is_registered
= 0;
486 klist_del(&dev
->knode_bus
);
488 pr_debug("bus %s: remove device %s\n", dev
->bus
->name
, dev
->bus_id
);
489 device_release_driver(dev
);
494 static int driver_add_attrs(struct bus_type
* bus
, struct device_driver
* drv
)
499 if (bus
->drv_attrs
) {
500 for (i
= 0; attr_name(bus
->drv_attrs
[i
]); i
++) {
501 error
= driver_create_file(drv
, &bus
->drv_attrs
[i
]);
510 driver_remove_file(drv
, &bus
->drv_attrs
[i
]);
515 static void driver_remove_attrs(struct bus_type
* bus
, struct device_driver
* drv
)
519 if (bus
->drv_attrs
) {
520 for (i
= 0; attr_name(bus
->drv_attrs
[i
]); i
++)
521 driver_remove_file(drv
, &bus
->drv_attrs
[i
]);
525 #ifdef CONFIG_HOTPLUG
527 * Thanks to drivers making their tables __devinit, we can't allow manual
528 * bind and unbind from userspace unless CONFIG_HOTPLUG is enabled.
530 static int __must_check
add_bind_files(struct device_driver
*drv
)
534 ret
= driver_create_file(drv
, &driver_attr_unbind
);
536 ret
= driver_create_file(drv
, &driver_attr_bind
);
538 driver_remove_file(drv
, &driver_attr_unbind
);
543 static void remove_bind_files(struct device_driver
*drv
)
545 driver_remove_file(drv
, &driver_attr_bind
);
546 driver_remove_file(drv
, &driver_attr_unbind
);
549 static int add_probe_files(struct bus_type
*bus
)
553 bus
->drivers_probe_attr
.attr
.name
= "drivers_probe";
554 bus
->drivers_probe_attr
.attr
.mode
= S_IWUSR
;
555 bus
->drivers_probe_attr
.attr
.owner
= bus
->owner
;
556 bus
->drivers_probe_attr
.store
= store_drivers_probe
;
557 retval
= bus_create_file(bus
, &bus
->drivers_probe_attr
);
561 bus
->drivers_autoprobe_attr
.attr
.name
= "drivers_autoprobe";
562 bus
->drivers_autoprobe_attr
.attr
.mode
= S_IWUSR
| S_IRUGO
;
563 bus
->drivers_autoprobe_attr
.attr
.owner
= bus
->owner
;
564 bus
->drivers_autoprobe_attr
.show
= show_drivers_autoprobe
;
565 bus
->drivers_autoprobe_attr
.store
= store_drivers_autoprobe
;
566 retval
= bus_create_file(bus
, &bus
->drivers_autoprobe_attr
);
568 bus_remove_file(bus
, &bus
->drivers_probe_attr
);
573 static void remove_probe_files(struct bus_type
*bus
)
575 bus_remove_file(bus
, &bus
->drivers_autoprobe_attr
);
576 bus_remove_file(bus
, &bus
->drivers_probe_attr
);
579 static inline int add_bind_files(struct device_driver
*drv
) { return 0; }
580 static inline void remove_bind_files(struct device_driver
*drv
) {}
581 static inline int add_probe_files(struct bus_type
*bus
) { return 0; }
582 static inline void remove_probe_files(struct bus_type
*bus
) {}
586 * bus_add_driver - Add a driver to the bus.
590 int bus_add_driver(struct device_driver
*drv
)
592 struct bus_type
* bus
= get_bus(drv
->bus
);
598 pr_debug("bus %s: add driver %s\n", bus
->name
, drv
->name
);
599 error
= kobject_set_name(&drv
->kobj
, "%s", drv
->name
);
602 drv
->kobj
.kset
= &bus
->drivers
;
603 if ((error
= kobject_register(&drv
->kobj
)))
606 if (drv
->bus
->drivers_autoprobe
) {
607 error
= driver_attach(drv
);
611 klist_add_tail(&drv
->knode_bus
, &bus
->klist_drivers
);
612 module_add_driver(drv
->owner
, drv
);
614 error
= driver_add_attrs(bus
, drv
);
616 /* How the hell do we get out of this pickle? Give up */
617 printk(KERN_ERR
"%s: driver_add_attrs(%s) failed\n",
618 __FUNCTION__
, drv
->name
);
620 error
= add_bind_files(drv
);
623 printk(KERN_ERR
"%s: add_bind_files(%s) failed\n",
624 __FUNCTION__
, drv
->name
);
629 kobject_unregister(&drv
->kobj
);
636 * bus_remove_driver - delete driver from bus's knowledge.
639 * Detach the driver from the devices it controls, and remove
640 * it from its bus's list of drivers. Finally, we drop the reference
641 * to the bus we took in bus_add_driver().
644 void bus_remove_driver(struct device_driver
* drv
)
649 remove_bind_files(drv
);
650 driver_remove_attrs(drv
->bus
, drv
);
651 klist_remove(&drv
->knode_bus
);
652 pr_debug("bus %s: remove driver %s\n", drv
->bus
->name
, drv
->name
);
654 module_remove_driver(drv
);
655 kobject_unregister(&drv
->kobj
);
660 /* Helper for bus_rescan_devices's iter */
661 static int __must_check
bus_rescan_devices_helper(struct device
*dev
,
667 if (dev
->parent
) /* Needed for USB */
668 down(&dev
->parent
->sem
);
669 ret
= device_attach(dev
);
671 up(&dev
->parent
->sem
);
675 return ret
< 0 ? ret
: 0;
679 * bus_rescan_devices - rescan devices on the bus for possible drivers
680 * @bus: the bus to scan.
682 * This function will look for devices on the bus with no driver
683 * attached and rescan it against existing drivers to see if it matches
684 * any by calling device_attach() for the unbound devices.
686 int bus_rescan_devices(struct bus_type
* bus
)
688 return bus_for_each_dev(bus
, NULL
, NULL
, bus_rescan_devices_helper
);
692 * device_reprobe - remove driver for a device and probe for a new driver
693 * @dev: the device to reprobe
695 * This function detaches the attached driver (if any) for the given
696 * device and restarts the driver probing process. It is intended
697 * to use if probing criteria changed during a devices lifetime and
698 * driver attachment should change accordingly.
700 int device_reprobe(struct device
*dev
)
703 if (dev
->parent
) /* Needed for USB */
704 down(&dev
->parent
->sem
);
705 device_release_driver(dev
);
707 up(&dev
->parent
->sem
);
709 return bus_rescan_devices_helper(dev
, NULL
);
711 EXPORT_SYMBOL_GPL(device_reprobe
);
713 struct bus_type
*get_bus(struct bus_type
*bus
)
715 return bus
? container_of(subsys_get(&bus
->subsys
),
716 struct bus_type
, subsys
) : NULL
;
719 void put_bus(struct bus_type
* bus
)
721 subsys_put(&bus
->subsys
);
726 * find_bus - locate bus by name.
727 * @name: name of bus.
729 * Call kset_find_obj() to iterate over list of buses to
730 * find a bus by name. Return bus if found.
732 * Note that kset_find_obj increments bus' reference count.
735 struct bus_type
* find_bus(char * name
)
737 struct kobject
* k
= kset_find_obj(&bus_subsys
.kset
, name
);
738 return k
? to_bus(k
) : NULL
;
744 * bus_add_attrs - Add default attributes for this bus.
745 * @bus: Bus that has just been registered.
748 static int bus_add_attrs(struct bus_type
* bus
)
753 if (bus
->bus_attrs
) {
754 for (i
= 0; attr_name(bus
->bus_attrs
[i
]); i
++) {
755 if ((error
= bus_create_file(bus
,&bus
->bus_attrs
[i
])))
763 bus_remove_file(bus
,&bus
->bus_attrs
[i
]);
767 static void bus_remove_attrs(struct bus_type
* bus
)
771 if (bus
->bus_attrs
) {
772 for (i
= 0; attr_name(bus
->bus_attrs
[i
]); i
++)
773 bus_remove_file(bus
,&bus
->bus_attrs
[i
]);
777 static void klist_devices_get(struct klist_node
*n
)
779 struct device
*dev
= container_of(n
, struct device
, knode_bus
);
784 static void klist_devices_put(struct klist_node
*n
)
786 struct device
*dev
= container_of(n
, struct device
, knode_bus
);
792 * bus_register - register a bus with the system.
795 * Once we have that, we registered the bus with the kobject
796 * infrastructure, then register the children subsystems it has:
797 * the devices and drivers that belong to the bus.
799 int bus_register(struct bus_type
* bus
)
803 BLOCKING_INIT_NOTIFIER_HEAD(&bus
->bus_notifier
);
805 retval
= kobject_set_name(&bus
->subsys
.kset
.kobj
, "%s", bus
->name
);
809 subsys_set_kset(bus
, bus_subsys
);
810 retval
= subsystem_register(&bus
->subsys
);
814 kobject_set_name(&bus
->devices
.kobj
, "devices");
815 bus
->devices
.subsys
= &bus
->subsys
;
816 retval
= kset_register(&bus
->devices
);
818 goto bus_devices_fail
;
820 kobject_set_name(&bus
->drivers
.kobj
, "drivers");
821 bus
->drivers
.subsys
= &bus
->subsys
;
822 bus
->drivers
.ktype
= &ktype_driver
;
823 retval
= kset_register(&bus
->drivers
);
825 goto bus_drivers_fail
;
827 klist_init(&bus
->klist_devices
, klist_devices_get
, klist_devices_put
);
828 klist_init(&bus
->klist_drivers
, NULL
, NULL
);
830 bus
->drivers_autoprobe
= 1;
831 retval
= add_probe_files(bus
);
833 goto bus_probe_files_fail
;
835 retval
= bus_add_attrs(bus
);
839 pr_debug("bus type '%s' registered\n", bus
->name
);
843 remove_probe_files(bus
);
844 bus_probe_files_fail
:
845 kset_unregister(&bus
->drivers
);
847 kset_unregister(&bus
->devices
);
849 subsystem_unregister(&bus
->subsys
);
855 * bus_unregister - remove a bus from the system
858 * Unregister the child subsystems and the bus itself.
859 * Finally, we call put_bus() to release the refcount
861 void bus_unregister(struct bus_type
* bus
)
863 pr_debug("bus %s: unregistering\n", bus
->name
);
864 bus_remove_attrs(bus
);
865 remove_probe_files(bus
);
866 kset_unregister(&bus
->drivers
);
867 kset_unregister(&bus
->devices
);
868 subsystem_unregister(&bus
->subsys
);
871 int bus_register_notifier(struct bus_type
*bus
, struct notifier_block
*nb
)
873 return blocking_notifier_chain_register(&bus
->bus_notifier
, nb
);
875 EXPORT_SYMBOL_GPL(bus_register_notifier
);
877 int bus_unregister_notifier(struct bus_type
*bus
, struct notifier_block
*nb
)
879 return blocking_notifier_chain_unregister(&bus
->bus_notifier
, nb
);
881 EXPORT_SYMBOL_GPL(bus_unregister_notifier
);
883 int __init
buses_init(void)
885 return subsystem_register(&bus_subsys
);
889 EXPORT_SYMBOL_GPL(bus_for_each_dev
);
890 EXPORT_SYMBOL_GPL(bus_find_device
);
891 EXPORT_SYMBOL_GPL(bus_for_each_drv
);
893 EXPORT_SYMBOL_GPL(bus_register
);
894 EXPORT_SYMBOL_GPL(bus_unregister
);
895 EXPORT_SYMBOL_GPL(bus_rescan_devices
);
897 EXPORT_SYMBOL_GPL(bus_create_file
);
898 EXPORT_SYMBOL_GPL(bus_remove_file
);