2 * drivers/base/core.c - core driver model code (device registration, etc)
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
6 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2006 Novell, Inc.
9 * This file is released under the GPLv2
13 #include <linux/device.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/slab.h>
18 #include <linux/string.h>
19 #include <linux/kdev_t.h>
20 #include <linux/notifier.h>
21 #include <linux/genhd.h>
22 #include <linux/kallsyms.h>
23 #include <linux/semaphore.h>
26 #include "power/power.h"
28 int (*platform_notify)(struct device *dev) = NULL;
29 int (*platform_notify_remove)(struct device *dev) = NULL;
32 static inline int device_is_not_partition(struct device *dev)
34 return !(dev->type == &part_type);
37 static inline int device_is_not_partition(struct device *dev)
44 * dev_driver_string - Return a device's driver name, if at all possible
45 * @dev: struct device to get the name of
47 * Will return the device's driver's name if it is bound to a device. If
48 * the device is not bound to a device, it will return the name of the bus
49 * it is attached to. If it is not attached to a bus either, an empty
50 * string will be returned.
52 const char *dev_driver_string(struct device *dev)
54 return dev->driver ? dev->driver->name :
55 (dev->bus ? dev->bus->name :
56 (dev->class ? dev->class->name : ""));
58 EXPORT_SYMBOL(dev_driver_string);
60 #define to_dev(obj) container_of(obj, struct device, kobj)
61 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
63 static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
66 struct device_attribute *dev_attr = to_dev_attr(attr);
67 struct device *dev = to_dev(kobj);
71 ret = dev_attr->show(dev, dev_attr, buf);
72 if (ret >= (ssize_t)PAGE_SIZE) {
73 print_symbol("dev_attr_show: %s returned bad count\n",
74 (unsigned long)dev_attr->show);
79 static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
80 const char *buf, size_t count)
82 struct device_attribute *dev_attr = to_dev_attr(attr);
83 struct device *dev = to_dev(kobj);
87 ret = dev_attr->store(dev, dev_attr, buf, count);
91 static struct sysfs_ops dev_sysfs_ops = {
92 .show = dev_attr_show,
93 .store = dev_attr_store,
98 * device_release - free device structure.
99 * @kobj: device's kobject.
101 * This is called once the reference count for the object
102 * reaches 0. We forward the call to the device's release
103 * method, which should handle actually freeing the structure.
105 static void device_release(struct kobject *kobj)
107 struct device *dev = to_dev(kobj);
111 else if (dev->type && dev->type->release)
112 dev->type->release(dev);
113 else if (dev->class && dev->class->dev_release)
114 dev->class->dev_release(dev);
116 printk(KERN_ERR "Device '%s' does not have a release() "
117 "function, it is broken and must be fixed.\n",
123 static struct kobj_type device_ktype = {
124 .release = device_release,
125 .sysfs_ops = &dev_sysfs_ops,
129 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
131 struct kobj_type *ktype = get_ktype(kobj);
133 if (ktype == &device_ktype) {
134 struct device *dev = to_dev(kobj);
135 if (dev->uevent_suppress)
145 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
147 struct device *dev = to_dev(kobj);
150 return dev->bus->name;
152 return dev->class->name;
156 static int dev_uevent(struct kset *kset, struct kobject *kobj,
157 struct kobj_uevent_env *env)
159 struct device *dev = to_dev(kobj);
162 /* add the major/minor if present */
163 if (MAJOR(dev->devt)) {
164 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
165 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
168 if (dev->type && dev->type->name)
169 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
172 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
174 #ifdef CONFIG_SYSFS_DEPRECATED
176 struct device *parent = dev->parent;
178 /* find first bus device in parent chain */
179 while (parent && !parent->bus)
180 parent = parent->parent;
181 if (parent && parent->bus) {
184 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
186 add_uevent_var(env, "PHYSDEVPATH=%s", path);
190 add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
193 add_uevent_var(env, "PHYSDEVDRIVER=%s",
194 parent->driver->name);
196 } else if (dev->bus) {
197 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
200 add_uevent_var(env, "PHYSDEVDRIVER=%s",
205 /* have the bus specific function add its stuff */
206 if (dev->bus && dev->bus->uevent) {
207 retval = dev->bus->uevent(dev, env);
209 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
210 dev->bus_id, __func__, retval);
213 /* have the class specific function add its stuff */
214 if (dev->class && dev->class->dev_uevent) {
215 retval = dev->class->dev_uevent(dev, env);
217 pr_debug("device: '%s': %s: class uevent() "
218 "returned %d\n", dev->bus_id,
222 /* have the device type specific fuction add its stuff */
223 if (dev->type && dev->type->uevent) {
224 retval = dev->type->uevent(dev, env);
226 pr_debug("device: '%s': %s: dev_type uevent() "
227 "returned %d\n", dev->bus_id,
234 static struct kset_uevent_ops device_uevent_ops = {
235 .filter = dev_uevent_filter,
236 .name = dev_uevent_name,
237 .uevent = dev_uevent,
240 static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
243 struct kobject *top_kobj;
245 struct kobj_uevent_env *env = NULL;
250 /* search the kset, the device belongs to */
251 top_kobj = &dev->kobj;
252 while (!top_kobj->kset && top_kobj->parent)
253 top_kobj = top_kobj->parent;
257 kset = top_kobj->kset;
258 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
262 if (kset->uevent_ops && kset->uevent_ops->filter)
263 if (!kset->uevent_ops->filter(kset, &dev->kobj))
266 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
270 /* let the kset specific function add its keys */
271 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
275 /* copy keys to file */
276 for (i = 0; i < env->envp_idx; i++)
277 count += sprintf(&buf[count], "%s\n", env->envp[i]);
283 static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
284 const char *buf, size_t count)
286 enum kobject_action action;
288 if (kobject_action_type(buf, count, &action) == 0) {
289 kobject_uevent(&dev->kobj, action);
293 dev_err(dev, "uevent: unsupported action-string; this will "
294 "be ignored in a future kernel version\n");
295 kobject_uevent(&dev->kobj, KOBJ_ADD);
300 static struct device_attribute uevent_attr =
301 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
303 static int device_add_attributes(struct device *dev,
304 struct device_attribute *attrs)
310 for (i = 0; attr_name(attrs[i]); i++) {
311 error = device_create_file(dev, &attrs[i]);
317 device_remove_file(dev, &attrs[i]);
322 static void device_remove_attributes(struct device *dev,
323 struct device_attribute *attrs)
328 for (i = 0; attr_name(attrs[i]); i++)
329 device_remove_file(dev, &attrs[i]);
332 static int device_add_groups(struct device *dev,
333 struct attribute_group **groups)
339 for (i = 0; groups[i]; i++) {
340 error = sysfs_create_group(&dev->kobj, groups[i]);
343 sysfs_remove_group(&dev->kobj,
352 static void device_remove_groups(struct device *dev,
353 struct attribute_group **groups)
358 for (i = 0; groups[i]; i++)
359 sysfs_remove_group(&dev->kobj, groups[i]);
362 static int device_add_attrs(struct device *dev)
364 struct class *class = dev->class;
365 struct device_type *type = dev->type;
369 error = device_add_attributes(dev, class->dev_attrs);
375 error = device_add_groups(dev, type->groups);
377 goto err_remove_class_attrs;
380 error = device_add_groups(dev, dev->groups);
382 goto err_remove_type_groups;
386 err_remove_type_groups:
388 device_remove_groups(dev, type->groups);
389 err_remove_class_attrs:
391 device_remove_attributes(dev, class->dev_attrs);
396 static void device_remove_attrs(struct device *dev)
398 struct class *class = dev->class;
399 struct device_type *type = dev->type;
401 device_remove_groups(dev, dev->groups);
404 device_remove_groups(dev, type->groups);
407 device_remove_attributes(dev, class->dev_attrs);
411 static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
414 return print_dev_t(buf, dev->devt);
417 static struct device_attribute devt_attr =
418 __ATTR(dev, S_IRUGO, show_dev, NULL);
420 /* kset to create /sys/devices/ */
421 struct kset *devices_kset;
424 * device_create_file - create sysfs attribute file for device.
426 * @attr: device attribute descriptor.
428 int device_create_file(struct device *dev, struct device_attribute *attr)
432 error = sysfs_create_file(&dev->kobj, &attr->attr);
437 * device_remove_file - remove sysfs attribute file.
439 * @attr: device attribute descriptor.
441 void device_remove_file(struct device *dev, struct device_attribute *attr)
444 sysfs_remove_file(&dev->kobj, &attr->attr);
448 * device_create_bin_file - create sysfs binary attribute file for device.
450 * @attr: device binary attribute descriptor.
452 int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
456 error = sysfs_create_bin_file(&dev->kobj, attr);
459 EXPORT_SYMBOL_GPL(device_create_bin_file);
462 * device_remove_bin_file - remove sysfs binary attribute file
464 * @attr: device binary attribute descriptor.
466 void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
469 sysfs_remove_bin_file(&dev->kobj, attr);
471 EXPORT_SYMBOL_GPL(device_remove_bin_file);
474 * device_schedule_callback_owner - helper to schedule a callback for a device
476 * @func: callback function to invoke later.
477 * @owner: module owning the callback routine
479 * Attribute methods must not unregister themselves or their parent device
480 * (which would amount to the same thing). Attempts to do so will deadlock,
481 * since unregistration is mutually exclusive with driver callbacks.
483 * Instead methods can call this routine, which will attempt to allocate
484 * and schedule a workqueue request to call back @func with @dev as its
485 * argument in the workqueue's process context. @dev will be pinned until
488 * This routine is usually called via the inline device_schedule_callback(),
489 * which automatically sets @owner to THIS_MODULE.
491 * Returns 0 if the request was submitted, -ENOMEM if storage could not
492 * be allocated, -ENODEV if a reference to @owner isn't available.
494 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
495 * underlying sysfs routine (since it is intended for use by attribute
496 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
498 int device_schedule_callback_owner(struct device *dev,
499 void (*func)(struct device *), struct module *owner)
501 return sysfs_schedule_callback(&dev->kobj,
502 (void (*)(void *)) func, dev, owner);
504 EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
506 static void klist_children_get(struct klist_node *n)
508 struct device *dev = container_of(n, struct device, knode_parent);
513 static void klist_children_put(struct klist_node *n)
515 struct device *dev = container_of(n, struct device, knode_parent);
521 * device_initialize - init device structure.
524 * This prepares the device for use by other layers,
525 * including adding it to the device hierarchy.
526 * It is the first half of device_register(), if called by
527 * that, though it can also be called separately, so one
528 * may use @dev's fields (e.g. the refcount).
530 void device_initialize(struct device *dev)
532 dev->kobj.kset = devices_kset;
533 kobject_init(&dev->kobj, &device_ktype);
534 klist_init(&dev->klist_children, klist_children_get,
536 INIT_LIST_HEAD(&dev->dma_pools);
537 INIT_LIST_HEAD(&dev->node);
538 init_MUTEX(&dev->sem);
539 spin_lock_init(&dev->devres_lock);
540 INIT_LIST_HEAD(&dev->devres_head);
541 device_init_wakeup(dev, 0);
542 set_dev_node(dev, -1);
545 #ifdef CONFIG_SYSFS_DEPRECATED
546 static struct kobject *get_device_parent(struct device *dev,
547 struct device *parent)
549 /* class devices without a parent live in /sys/class/<classname>/ */
550 if (dev->class && (!parent || parent->class != dev->class))
551 return &dev->class->subsys.kobj;
552 /* all other devices keep their parent */
554 return &parent->kobj;
559 static inline void cleanup_device_parent(struct device *dev) {}
560 static inline void cleanup_glue_dir(struct device *dev,
561 struct kobject *glue_dir) {}
563 static struct kobject *virtual_device_parent(struct device *dev)
565 static struct kobject *virtual_dir = NULL;
568 virtual_dir = kobject_create_and_add("virtual",
569 &devices_kset->kobj);
574 static struct kobject *get_device_parent(struct device *dev,
575 struct device *parent)
580 struct kobject *kobj = NULL;
581 struct kobject *parent_kobj;
585 * If we have no parent, we live in "virtual".
586 * Class-devices with a non class-device as parent, live
587 * in a "glue" directory to prevent namespace collisions.
590 parent_kobj = virtual_device_parent(dev);
591 else if (parent->class)
592 return &parent->kobj;
594 parent_kobj = &parent->kobj;
596 /* find our class-directory at the parent and reference it */
597 spin_lock(&dev->class->class_dirs.list_lock);
598 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
599 if (k->parent == parent_kobj) {
600 kobj = kobject_get(k);
603 spin_unlock(&dev->class->class_dirs.list_lock);
607 /* or create a new class-directory at the parent device */
608 k = kobject_create();
611 k->kset = &dev->class->class_dirs;
612 retval = kobject_add(k, parent_kobj, "%s", dev->class->name);
617 /* do not emit an uevent for this simple "glue" directory */
622 return &parent->kobj;
626 static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
628 /* see if we live in a "glue" directory */
629 if (!glue_dir || !dev->class ||
630 glue_dir->kset != &dev->class->class_dirs)
633 kobject_put(glue_dir);
636 static void cleanup_device_parent(struct device *dev)
638 cleanup_glue_dir(dev, dev->kobj.parent);
642 static void setup_parent(struct device *dev, struct device *parent)
644 struct kobject *kobj;
645 kobj = get_device_parent(dev, parent);
647 dev->kobj.parent = kobj;
650 static int device_add_class_symlinks(struct device *dev)
657 error = sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
662 #ifdef CONFIG_SYSFS_DEPRECATED
663 /* stacked class devices need a symlink in the class directory */
664 if (dev->kobj.parent != &dev->class->subsys.kobj &&
665 device_is_not_partition(dev)) {
666 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
672 if (dev->parent && device_is_not_partition(dev)) {
673 struct device *parent = dev->parent;
677 * stacked class devices have the 'device' link
678 * pointing to the bus device instead of the parent
680 while (parent->class && !parent->bus && parent->parent)
681 parent = parent->parent;
683 error = sysfs_create_link(&dev->kobj,
689 class_name = make_class_name(dev->class->name,
692 error = sysfs_create_link(&dev->parent->kobj,
693 &dev->kobj, class_name);
701 if (dev->parent && device_is_not_partition(dev))
702 sysfs_remove_link(&dev->kobj, "device");
704 if (dev->kobj.parent != &dev->class->subsys.kobj &&
705 device_is_not_partition(dev))
706 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
708 /* link in the class directory pointing to the device */
709 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
714 if (dev->parent && device_is_not_partition(dev)) {
715 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
723 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
727 sysfs_remove_link(&dev->kobj, "subsystem");
732 static void device_remove_class_symlinks(struct device *dev)
737 #ifdef CONFIG_SYSFS_DEPRECATED
738 if (dev->parent && device_is_not_partition(dev)) {
741 class_name = make_class_name(dev->class->name, &dev->kobj);
743 sysfs_remove_link(&dev->parent->kobj, class_name);
746 sysfs_remove_link(&dev->kobj, "device");
749 if (dev->kobj.parent != &dev->class->subsys.kobj &&
750 device_is_not_partition(dev))
751 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
753 if (dev->parent && device_is_not_partition(dev))
754 sysfs_remove_link(&dev->kobj, "device");
756 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
759 sysfs_remove_link(&dev->kobj, "subsystem");
763 * dev_set_name - set a device name
766 int dev_set_name(struct device *dev, const char *fmt, ...)
770 va_start(vargs, fmt);
771 vsnprintf(dev->bus_id, sizeof(dev->bus_id), fmt, vargs);
775 EXPORT_SYMBOL_GPL(dev_set_name);
778 * device_add - add device to device hierarchy.
781 * This is part 2 of device_register(), though may be called
782 * separately _iff_ device_initialize() has been called separately.
784 * This adds it to the kobject hierarchy via kobject_add(), adds it
785 * to the global and sibling lists for the device, then
786 * adds it to the other relevant subsystems of the driver model.
788 int device_add(struct device *dev)
790 struct device *parent = NULL;
791 struct class_interface *class_intf;
794 dev = get_device(dev);
795 if (!dev || !strlen(dev->bus_id)) {
800 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
802 parent = get_device(dev->parent);
803 setup_parent(dev, parent);
805 /* use parent numa_node */
807 set_dev_node(dev, dev_to_node(parent));
809 /* first, register with generic layer. */
810 error = kobject_add(&dev->kobj, dev->kobj.parent, "%s", dev->bus_id);
814 /* notify platform of device entry */
816 platform_notify(dev);
818 /* notify clients of device entry (new way) */
820 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
821 BUS_NOTIFY_ADD_DEVICE, dev);
823 error = device_create_file(dev, &uevent_attr);
827 if (MAJOR(dev->devt)) {
828 error = device_create_file(dev, &devt_attr);
830 goto ueventattrError;
833 error = device_add_class_symlinks(dev);
836 error = device_add_attrs(dev);
839 error = bus_add_device(dev);
842 error = device_pm_add(dev);
845 kobject_uevent(&dev->kobj, KOBJ_ADD);
846 bus_attach_device(dev);
848 klist_add_tail(&dev->knode_parent, &parent->klist_children);
851 down(&dev->class->sem);
852 /* tie the class to the device */
853 list_add_tail(&dev->node, &dev->class->devices);
855 /* notify any interfaces that the device is here */
856 list_for_each_entry(class_intf, &dev->class->interfaces, node)
857 if (class_intf->add_dev)
858 class_intf->add_dev(dev, class_intf);
859 up(&dev->class->sem);
865 bus_remove_device(dev);
868 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
869 BUS_NOTIFY_DEL_DEVICE, dev);
870 device_remove_attrs(dev);
872 device_remove_class_symlinks(dev);
874 if (MAJOR(dev->devt))
875 device_remove_file(dev, &devt_attr);
877 device_remove_file(dev, &uevent_attr);
879 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
880 kobject_del(&dev->kobj);
882 cleanup_device_parent(dev);
889 * device_register - register a device with the system.
890 * @dev: pointer to the device structure
892 * This happens in two clean steps - initialize the device
893 * and add it to the system. The two steps can be called
894 * separately, but this is the easiest and most common.
895 * I.e. you should only call the two helpers separately if
896 * have a clearly defined need to use and refcount the device
897 * before it is added to the hierarchy.
899 int device_register(struct device *dev)
901 device_initialize(dev);
902 return device_add(dev);
906 * get_device - increment reference count for device.
909 * This simply forwards the call to kobject_get(), though
910 * we do take care to provide for the case that we get a NULL
913 struct device *get_device(struct device *dev)
915 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
919 * put_device - decrement reference count.
920 * @dev: device in question.
922 void put_device(struct device *dev)
926 kobject_put(&dev->kobj);
930 * device_del - delete device from system.
933 * This is the first part of the device unregistration
934 * sequence. This removes the device from the lists we control
935 * from here, has it removed from the other driver model
936 * subsystems it was added to in device_add(), and removes it
937 * from the kobject hierarchy.
939 * NOTE: this should be called manually _iff_ device_add() was
940 * also called manually.
942 void device_del(struct device *dev)
944 struct device *parent = dev->parent;
945 struct class_interface *class_intf;
947 device_pm_remove(dev);
949 klist_del(&dev->knode_parent);
950 if (MAJOR(dev->devt))
951 device_remove_file(dev, &devt_attr);
953 device_remove_class_symlinks(dev);
955 down(&dev->class->sem);
956 /* notify any interfaces that the device is now gone */
957 list_for_each_entry(class_intf, &dev->class->interfaces, node)
958 if (class_intf->remove_dev)
959 class_intf->remove_dev(dev, class_intf);
960 /* remove the device from the class list */
961 list_del_init(&dev->node);
962 up(&dev->class->sem);
964 device_remove_file(dev, &uevent_attr);
965 device_remove_attrs(dev);
966 bus_remove_device(dev);
969 * Some platform devices are driven without driver attached
970 * and managed resources may have been acquired. Make sure
971 * all resources are released.
973 devres_release_all(dev);
975 /* Notify the platform of the removal, in case they
976 * need to do anything...
978 if (platform_notify_remove)
979 platform_notify_remove(dev);
981 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
982 BUS_NOTIFY_DEL_DEVICE, dev);
983 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
984 cleanup_device_parent(dev);
985 kobject_del(&dev->kobj);
990 * device_unregister - unregister device from system.
991 * @dev: device going away.
993 * We do this in two parts, like we do device_register(). First,
994 * we remove it from all the subsystems with device_del(), then
995 * we decrement the reference count via put_device(). If that
996 * is the final reference count, the device will be cleaned up
997 * via device_release() above. Otherwise, the structure will
998 * stick around until the final reference to the device is dropped.
1000 void device_unregister(struct device *dev)
1002 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
1007 static struct device *next_device(struct klist_iter *i)
1009 struct klist_node *n = klist_next(i);
1010 return n ? container_of(n, struct device, knode_parent) : NULL;
1014 * device_for_each_child - device child iterator.
1015 * @parent: parent struct device.
1016 * @data: data for the callback.
1017 * @fn: function to be called for each device.
1019 * Iterate over @parent's child devices, and call @fn for each,
1022 * We check the return of @fn each time. If it returns anything
1023 * other than 0, we break out and return that value.
1025 int device_for_each_child(struct device *parent, void *data,
1026 int (*fn)(struct device *dev, void *data))
1028 struct klist_iter i;
1029 struct device *child;
1032 klist_iter_init(&parent->klist_children, &i);
1033 while ((child = next_device(&i)) && !error)
1034 error = fn(child, data);
1035 klist_iter_exit(&i);
1040 * device_find_child - device iterator for locating a particular device.
1041 * @parent: parent struct device
1042 * @data: Data to pass to match function
1043 * @match: Callback function to check device
1045 * This is similar to the device_for_each_child() function above, but it
1046 * returns a reference to a device that is 'found' for later use, as
1047 * determined by the @match callback.
1049 * The callback should return 0 if the device doesn't match and non-zero
1050 * if it does. If the callback returns non-zero and a reference to the
1051 * current device can be obtained, this function will return to the caller
1052 * and not iterate over any more devices.
1054 struct device *device_find_child(struct device *parent, void *data,
1055 int (*match)(struct device *dev, void *data))
1057 struct klist_iter i;
1058 struct device *child;
1063 klist_iter_init(&parent->klist_children, &i);
1064 while ((child = next_device(&i)))
1065 if (match(child, data) && get_device(child))
1067 klist_iter_exit(&i);
1071 int __init devices_init(void)
1073 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1079 EXPORT_SYMBOL_GPL(device_for_each_child);
1080 EXPORT_SYMBOL_GPL(device_find_child);
1082 EXPORT_SYMBOL_GPL(device_initialize);
1083 EXPORT_SYMBOL_GPL(device_add);
1084 EXPORT_SYMBOL_GPL(device_register);
1086 EXPORT_SYMBOL_GPL(device_del);
1087 EXPORT_SYMBOL_GPL(device_unregister);
1088 EXPORT_SYMBOL_GPL(get_device);
1089 EXPORT_SYMBOL_GPL(put_device);
1091 EXPORT_SYMBOL_GPL(device_create_file);
1092 EXPORT_SYMBOL_GPL(device_remove_file);
1095 static void device_create_release(struct device *dev)
1097 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
1102 * device_create_vargs - creates a device and registers it with sysfs
1103 * @class: pointer to the struct class that this device should be registered to
1104 * @parent: pointer to the parent struct device of this new device, if any
1105 * @devt: the dev_t for the char device to be added
1106 * @drvdata: the data to be added to the device for callbacks
1107 * @fmt: string for the device's name
1108 * @args: va_list for the device's name
1110 * This function can be used by char device classes. A struct device
1111 * will be created in sysfs, registered to the specified class.
1113 * A "dev" file will be created, showing the dev_t for the device, if
1114 * the dev_t is not 0,0.
1115 * If a pointer to a parent struct device is passed in, the newly created
1116 * struct device will be a child of that device in sysfs.
1117 * The pointer to the struct device will be returned from the call.
1118 * Any further sysfs files that might be required can be created using this
1121 * Note: the struct class passed to this function must have previously
1122 * been created with a call to class_create().
1124 struct device *device_create_vargs(struct class *class, struct device *parent,
1125 dev_t devt, void *drvdata, const char *fmt,
1128 struct device *dev = NULL;
1129 int retval = -ENODEV;
1131 if (class == NULL || IS_ERR(class))
1134 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1142 dev->parent = parent;
1143 dev->release = device_create_release;
1144 dev_set_drvdata(dev, drvdata);
1146 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1147 retval = device_register(dev);
1155 return ERR_PTR(retval);
1157 EXPORT_SYMBOL_GPL(device_create_vargs);
1160 * device_create_drvdata - creates a device and registers it with sysfs
1161 * @class: pointer to the struct class that this device should be registered to
1162 * @parent: pointer to the parent struct device of this new device, if any
1163 * @devt: the dev_t for the char device to be added
1164 * @drvdata: the data to be added to the device for callbacks
1165 * @fmt: string for the device's name
1167 * This function can be used by char device classes. A struct device
1168 * will be created in sysfs, registered to the specified class.
1170 * A "dev" file will be created, showing the dev_t for the device, if
1171 * the dev_t is not 0,0.
1172 * If a pointer to a parent struct device is passed in, the newly created
1173 * struct device will be a child of that device in sysfs.
1174 * The pointer to the struct device will be returned from the call.
1175 * Any further sysfs files that might be required can be created using this
1178 * Note: the struct class passed to this function must have previously
1179 * been created with a call to class_create().
1181 struct device *device_create_drvdata(struct class *class,
1182 struct device *parent,
1185 const char *fmt, ...)
1190 va_start(vargs, fmt);
1191 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1195 EXPORT_SYMBOL_GPL(device_create_drvdata);
1198 * device_create - creates a device and registers it with sysfs
1199 * @class: pointer to the struct class that this device should be registered to
1200 * @parent: pointer to the parent struct device of this new device, if any
1201 * @devt: the dev_t for the char device to be added
1202 * @fmt: string for the device's name
1204 * This function can be used by char device classes. A struct device
1205 * will be created in sysfs, registered to the specified class.
1207 * A "dev" file will be created, showing the dev_t for the device, if
1208 * the dev_t is not 0,0.
1209 * If a pointer to a parent struct device is passed in, the newly created
1210 * struct device will be a child of that device in sysfs.
1211 * The pointer to the struct device will be returned from the call.
1212 * Any further sysfs files that might be required can be created using this
1215 * Note: the struct class passed to this function must have previously
1216 * been created with a call to class_create().
1218 struct device *device_create(struct class *class, struct device *parent,
1219 dev_t devt, const char *fmt, ...)
1224 va_start(vargs, fmt);
1225 dev = device_create_vargs(class, parent, devt, NULL, fmt, vargs);
1229 EXPORT_SYMBOL_GPL(device_create);
1231 static int __match_devt(struct device *dev, void *data)
1235 return dev->devt == *devt;
1239 * device_destroy - removes a device that was created with device_create()
1240 * @class: pointer to the struct class that this device was registered with
1241 * @devt: the dev_t of the device that was previously registered
1243 * This call unregisters and cleans up a device that was created with a
1244 * call to device_create().
1246 void device_destroy(struct class *class, dev_t devt)
1250 dev = class_find_device(class, &devt, __match_devt);
1253 device_unregister(dev);
1256 EXPORT_SYMBOL_GPL(device_destroy);
1259 * device_rename - renames a device
1260 * @dev: the pointer to the struct device to be renamed
1261 * @new_name: the new name of the device
1263 int device_rename(struct device *dev, char *new_name)
1265 char *old_class_name = NULL;
1266 char *new_class_name = NULL;
1267 char *old_device_name = NULL;
1270 dev = get_device(dev);
1274 pr_debug("device: '%s': %s: renaming to '%s'\n", dev->bus_id,
1275 __func__, new_name);
1277 #ifdef CONFIG_SYSFS_DEPRECATED
1278 if ((dev->class) && (dev->parent))
1279 old_class_name = make_class_name(dev->class->name, &dev->kobj);
1282 old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1283 if (!old_device_name) {
1287 strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
1288 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1290 error = kobject_rename(&dev->kobj, new_name);
1292 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1296 #ifdef CONFIG_SYSFS_DEPRECATED
1297 if (old_class_name) {
1298 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1299 if (new_class_name) {
1300 error = sysfs_create_link(&dev->parent->kobj,
1301 &dev->kobj, new_class_name);
1304 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1309 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
1313 sysfs_remove_link(&dev->class->subsys.kobj, old_device_name);
1320 kfree(new_class_name);
1321 kfree(old_class_name);
1322 kfree(old_device_name);
1326 EXPORT_SYMBOL_GPL(device_rename);
1328 static int device_move_class_links(struct device *dev,
1329 struct device *old_parent,
1330 struct device *new_parent)
1333 #ifdef CONFIG_SYSFS_DEPRECATED
1336 class_name = make_class_name(dev->class->name, &dev->kobj);
1342 sysfs_remove_link(&dev->kobj, "device");
1343 sysfs_remove_link(&old_parent->kobj, class_name);
1346 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1350 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1353 sysfs_remove_link(&dev->kobj, "device");
1361 sysfs_remove_link(&dev->kobj, "device");
1363 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1370 * device_move - moves a device to a new parent
1371 * @dev: the pointer to the struct device to be moved
1372 * @new_parent: the new parent of the device (can by NULL)
1374 int device_move(struct device *dev, struct device *new_parent)
1377 struct device *old_parent;
1378 struct kobject *new_parent_kobj;
1380 dev = get_device(dev);
1384 new_parent = get_device(new_parent);
1385 new_parent_kobj = get_device_parent(dev, new_parent);
1387 pr_debug("device: '%s': %s: moving to '%s'\n", dev->bus_id,
1388 __func__, new_parent ? new_parent->bus_id : "<NULL>");
1389 error = kobject_move(&dev->kobj, new_parent_kobj);
1391 cleanup_glue_dir(dev, new_parent_kobj);
1392 put_device(new_parent);
1395 old_parent = dev->parent;
1396 dev->parent = new_parent;
1398 klist_remove(&dev->knode_parent);
1400 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
1401 set_dev_node(dev, dev_to_node(new_parent));
1406 error = device_move_class_links(dev, old_parent, new_parent);
1408 /* We ignore errors on cleanup since we're hosed anyway... */
1409 device_move_class_links(dev, new_parent, old_parent);
1410 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1412 klist_remove(&dev->knode_parent);
1413 dev->parent = old_parent;
1415 klist_add_tail(&dev->knode_parent,
1416 &old_parent->klist_children);
1417 set_dev_node(dev, dev_to_node(old_parent));
1420 cleanup_glue_dir(dev, new_parent_kobj);
1421 put_device(new_parent);
1425 put_device(old_parent);
1430 EXPORT_SYMBOL_GPL(device_move);
1433 * device_shutdown - call ->shutdown() on each device to shutdown.
1435 void device_shutdown(void)
1437 struct device *dev, *devn;
1439 list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
1441 if (dev->bus && dev->bus->shutdown) {
1442 dev_dbg(dev, "shutdown\n");
1443 dev->bus->shutdown(dev);
1444 } else if (dev->driver && dev->driver->shutdown) {
1445 dev_dbg(dev, "shutdown\n");
1446 dev->driver->shutdown(dev);