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>
22 #include <linux/of_device.h>
23 #include <linux/genhd.h>
24 #include <linux/kallsyms.h>
25 #include <linux/mutex.h>
26 #include <linux/async.h>
27 #include <linux/pm_runtime.h>
30 #include "power/power.h"
32 #ifdef CONFIG_SYSFS_DEPRECATED
33 #ifdef CONFIG_SYSFS_DEPRECATED_V2
34 long sysfs_deprecated = 1;
36 long sysfs_deprecated = 0;
38 static __init int sysfs_deprecated_setup(char *arg)
40 return strict_strtol(arg, 10, &sysfs_deprecated);
42 early_param("sysfs.deprecated", sysfs_deprecated_setup);
45 int (*platform_notify)(struct device *dev) = NULL;
46 int (*platform_notify_remove)(struct device *dev) = NULL;
47 static struct kobject *dev_kobj;
48 struct kobject *sysfs_dev_char_kobj;
49 struct kobject *sysfs_dev_block_kobj;
52 static inline int device_is_not_partition(struct device *dev)
54 return !(dev->type == &part_type);
57 static inline int device_is_not_partition(struct device *dev)
64 * dev_driver_string - Return a device's driver name, if at all possible
65 * @dev: struct device to get the name of
67 * Will return the device's driver's name if it is bound to a device. If
68 * the device is not bound to a device, it will return the name of the bus
69 * it is attached to. If it is not attached to a bus either, an empty
70 * string will be returned.
72 const char *dev_driver_string(const struct device *dev)
74 struct device_driver *drv;
76 /* dev->driver can change to NULL underneath us because of unbinding,
77 * so be careful about accessing it. dev->bus and dev->class should
78 * never change once they are set, so they don't need special care.
80 drv = ACCESS_ONCE(dev->driver);
81 return drv ? drv->name :
82 (dev->bus ? dev->bus->name :
83 (dev->class ? dev->class->name : ""));
85 EXPORT_SYMBOL(dev_driver_string);
87 #define to_dev(obj) container_of(obj, struct device, kobj)
88 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
90 static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
93 struct device_attribute *dev_attr = to_dev_attr(attr);
94 struct device *dev = to_dev(kobj);
98 ret = dev_attr->show(dev, dev_attr, buf);
99 if (ret >= (ssize_t)PAGE_SIZE) {
100 print_symbol("dev_attr_show: %s returned bad count\n",
101 (unsigned long)dev_attr->show);
106 static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
107 const char *buf, size_t count)
109 struct device_attribute *dev_attr = to_dev_attr(attr);
110 struct device *dev = to_dev(kobj);
114 ret = dev_attr->store(dev, dev_attr, buf, count);
118 static const struct sysfs_ops dev_sysfs_ops = {
119 .show = dev_attr_show,
120 .store = dev_attr_store,
123 #define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
125 ssize_t device_store_ulong(struct device *dev,
126 struct device_attribute *attr,
127 const char *buf, size_t size)
129 struct dev_ext_attribute *ea = to_ext_attr(attr);
131 unsigned long new = simple_strtoul(buf, &end, 0);
134 *(unsigned long *)(ea->var) = new;
135 /* Always return full write size even if we didn't consume all */
138 EXPORT_SYMBOL_GPL(device_store_ulong);
140 ssize_t device_show_ulong(struct device *dev,
141 struct device_attribute *attr,
144 struct dev_ext_attribute *ea = to_ext_attr(attr);
145 return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
147 EXPORT_SYMBOL_GPL(device_show_ulong);
149 ssize_t device_store_int(struct device *dev,
150 struct device_attribute *attr,
151 const char *buf, size_t size)
153 struct dev_ext_attribute *ea = to_ext_attr(attr);
155 long new = simple_strtol(buf, &end, 0);
156 if (end == buf || new > INT_MAX || new < INT_MIN)
158 *(int *)(ea->var) = new;
159 /* Always return full write size even if we didn't consume all */
162 EXPORT_SYMBOL_GPL(device_store_int);
164 ssize_t device_show_int(struct device *dev,
165 struct device_attribute *attr,
168 struct dev_ext_attribute *ea = to_ext_attr(attr);
170 return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
172 EXPORT_SYMBOL_GPL(device_show_int);
175 * device_release - free device structure.
176 * @kobj: device's kobject.
178 * This is called once the reference count for the object
179 * reaches 0. We forward the call to the device's release
180 * method, which should handle actually freeing the structure.
182 static void device_release(struct kobject *kobj)
184 struct device *dev = to_dev(kobj);
185 struct device_private *p = dev->p;
189 else if (dev->type && dev->type->release)
190 dev->type->release(dev);
191 else if (dev->class && dev->class->dev_release)
192 dev->class->dev_release(dev);
194 WARN(1, KERN_ERR "Device '%s' does not have a release() "
195 "function, it is broken and must be fixed.\n",
200 static const void *device_namespace(struct kobject *kobj)
202 struct device *dev = to_dev(kobj);
203 const void *ns = NULL;
205 if (dev->class && dev->class->ns_type)
206 ns = dev->class->namespace(dev);
211 static struct kobj_type device_ktype = {
212 .release = device_release,
213 .sysfs_ops = &dev_sysfs_ops,
214 .namespace = device_namespace,
218 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
220 struct kobj_type *ktype = get_ktype(kobj);
222 if (ktype == &device_ktype) {
223 struct device *dev = to_dev(kobj);
232 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
234 struct device *dev = to_dev(kobj);
237 return dev->bus->name;
239 return dev->class->name;
243 static int dev_uevent(struct kset *kset, struct kobject *kobj,
244 struct kobj_uevent_env *env)
246 struct device *dev = to_dev(kobj);
249 /* add device node properties if present */
250 if (MAJOR(dev->devt)) {
255 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
256 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
257 name = device_get_devnode(dev, &mode, &tmp);
259 add_uevent_var(env, "DEVNAME=%s", name);
262 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
266 if (dev->type && dev->type->name)
267 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
270 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
272 /* Add common DT information about the device */
273 of_device_uevent(dev, env);
275 /* have the bus specific function add its stuff */
276 if (dev->bus && dev->bus->uevent) {
277 retval = dev->bus->uevent(dev, env);
279 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
280 dev_name(dev), __func__, retval);
283 /* have the class specific function add its stuff */
284 if (dev->class && dev->class->dev_uevent) {
285 retval = dev->class->dev_uevent(dev, env);
287 pr_debug("device: '%s': %s: class uevent() "
288 "returned %d\n", dev_name(dev),
292 /* have the device type specific function add its stuff */
293 if (dev->type && dev->type->uevent) {
294 retval = dev->type->uevent(dev, env);
296 pr_debug("device: '%s': %s: dev_type uevent() "
297 "returned %d\n", dev_name(dev),
304 static const struct kset_uevent_ops device_uevent_ops = {
305 .filter = dev_uevent_filter,
306 .name = dev_uevent_name,
307 .uevent = dev_uevent,
310 static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
313 struct kobject *top_kobj;
315 struct kobj_uevent_env *env = NULL;
320 /* search the kset, the device belongs to */
321 top_kobj = &dev->kobj;
322 while (!top_kobj->kset && top_kobj->parent)
323 top_kobj = top_kobj->parent;
327 kset = top_kobj->kset;
328 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
332 if (kset->uevent_ops && kset->uevent_ops->filter)
333 if (!kset->uevent_ops->filter(kset, &dev->kobj))
336 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
340 /* let the kset specific function add its keys */
341 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
345 /* copy keys to file */
346 for (i = 0; i < env->envp_idx; i++)
347 count += sprintf(&buf[count], "%s\n", env->envp[i]);
353 static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
354 const char *buf, size_t count)
356 enum kobject_action action;
358 if (kobject_action_type(buf, count, &action) == 0)
359 kobject_uevent(&dev->kobj, action);
361 dev_err(dev, "uevent: unknown action-string\n");
365 static struct device_attribute uevent_attr =
366 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
368 static int device_add_attributes(struct device *dev,
369 struct device_attribute *attrs)
375 for (i = 0; attr_name(attrs[i]); i++) {
376 error = device_create_file(dev, &attrs[i]);
382 device_remove_file(dev, &attrs[i]);
387 static void device_remove_attributes(struct device *dev,
388 struct device_attribute *attrs)
393 for (i = 0; attr_name(attrs[i]); i++)
394 device_remove_file(dev, &attrs[i]);
397 static int device_add_bin_attributes(struct device *dev,
398 struct bin_attribute *attrs)
404 for (i = 0; attr_name(attrs[i]); i++) {
405 error = device_create_bin_file(dev, &attrs[i]);
411 device_remove_bin_file(dev, &attrs[i]);
416 static void device_remove_bin_attributes(struct device *dev,
417 struct bin_attribute *attrs)
422 for (i = 0; attr_name(attrs[i]); i++)
423 device_remove_bin_file(dev, &attrs[i]);
426 static int device_add_groups(struct device *dev,
427 const struct attribute_group **groups)
433 for (i = 0; groups[i]; i++) {
434 error = sysfs_create_group(&dev->kobj, groups[i]);
437 sysfs_remove_group(&dev->kobj,
446 static void device_remove_groups(struct device *dev,
447 const struct attribute_group **groups)
452 for (i = 0; groups[i]; i++)
453 sysfs_remove_group(&dev->kobj, groups[i]);
456 static int device_add_attrs(struct device *dev)
458 struct class *class = dev->class;
459 const struct device_type *type = dev->type;
463 error = device_add_attributes(dev, class->dev_attrs);
466 error = device_add_bin_attributes(dev, class->dev_bin_attrs);
468 goto err_remove_class_attrs;
472 error = device_add_groups(dev, type->groups);
474 goto err_remove_class_bin_attrs;
477 error = device_add_groups(dev, dev->groups);
479 goto err_remove_type_groups;
483 err_remove_type_groups:
485 device_remove_groups(dev, type->groups);
486 err_remove_class_bin_attrs:
488 device_remove_bin_attributes(dev, class->dev_bin_attrs);
489 err_remove_class_attrs:
491 device_remove_attributes(dev, class->dev_attrs);
496 static void device_remove_attrs(struct device *dev)
498 struct class *class = dev->class;
499 const struct device_type *type = dev->type;
501 device_remove_groups(dev, dev->groups);
504 device_remove_groups(dev, type->groups);
507 device_remove_attributes(dev, class->dev_attrs);
508 device_remove_bin_attributes(dev, class->dev_bin_attrs);
513 static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
516 return print_dev_t(buf, dev->devt);
519 static struct device_attribute devt_attr =
520 __ATTR(dev, S_IRUGO, show_dev, NULL);
523 struct kset *devices_kset;
526 * device_create_file - create sysfs attribute file for device.
528 * @attr: device attribute descriptor.
530 int device_create_file(struct device *dev,
531 const struct device_attribute *attr)
535 error = sysfs_create_file(&dev->kobj, &attr->attr);
540 * device_remove_file - remove sysfs attribute file.
542 * @attr: device attribute descriptor.
544 void device_remove_file(struct device *dev,
545 const struct device_attribute *attr)
548 sysfs_remove_file(&dev->kobj, &attr->attr);
552 * device_create_bin_file - create sysfs binary attribute file for device.
554 * @attr: device binary attribute descriptor.
556 int device_create_bin_file(struct device *dev,
557 const struct bin_attribute *attr)
561 error = sysfs_create_bin_file(&dev->kobj, attr);
564 EXPORT_SYMBOL_GPL(device_create_bin_file);
567 * device_remove_bin_file - remove sysfs binary attribute file
569 * @attr: device binary attribute descriptor.
571 void device_remove_bin_file(struct device *dev,
572 const struct bin_attribute *attr)
575 sysfs_remove_bin_file(&dev->kobj, attr);
577 EXPORT_SYMBOL_GPL(device_remove_bin_file);
580 * device_schedule_callback_owner - helper to schedule a callback for a device
582 * @func: callback function to invoke later.
583 * @owner: module owning the callback routine
585 * Attribute methods must not unregister themselves or their parent device
586 * (which would amount to the same thing). Attempts to do so will deadlock,
587 * since unregistration is mutually exclusive with driver callbacks.
589 * Instead methods can call this routine, which will attempt to allocate
590 * and schedule a workqueue request to call back @func with @dev as its
591 * argument in the workqueue's process context. @dev will be pinned until
594 * This routine is usually called via the inline device_schedule_callback(),
595 * which automatically sets @owner to THIS_MODULE.
597 * Returns 0 if the request was submitted, -ENOMEM if storage could not
598 * be allocated, -ENODEV if a reference to @owner isn't available.
600 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
601 * underlying sysfs routine (since it is intended for use by attribute
602 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
604 int device_schedule_callback_owner(struct device *dev,
605 void (*func)(struct device *), struct module *owner)
607 return sysfs_schedule_callback(&dev->kobj,
608 (void (*)(void *)) func, dev, owner);
610 EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
612 static void klist_children_get(struct klist_node *n)
614 struct device_private *p = to_device_private_parent(n);
615 struct device *dev = p->device;
620 static void klist_children_put(struct klist_node *n)
622 struct device_private *p = to_device_private_parent(n);
623 struct device *dev = p->device;
629 * device_initialize - init device structure.
632 * This prepares the device for use by other layers by initializing
634 * It is the first half of device_register(), if called by
635 * that function, though it can also be called separately, so one
636 * may use @dev's fields. In particular, get_device()/put_device()
637 * may be used for reference counting of @dev after calling this
640 * All fields in @dev must be initialized by the caller to 0, except
641 * for those explicitly set to some other value. The simplest
642 * approach is to use kzalloc() to allocate the structure containing
645 * NOTE: Use put_device() to give up your reference instead of freeing
646 * @dev directly once you have called this function.
648 void device_initialize(struct device *dev)
650 dev->kobj.kset = devices_kset;
651 kobject_init(&dev->kobj, &device_ktype);
652 INIT_LIST_HEAD(&dev->dma_pools);
653 mutex_init(&dev->mutex);
654 lockdep_set_novalidate_class(&dev->mutex);
655 spin_lock_init(&dev->devres_lock);
656 INIT_LIST_HEAD(&dev->devres_head);
658 set_dev_node(dev, -1);
661 static struct kobject *virtual_device_parent(struct device *dev)
663 static struct kobject *virtual_dir = NULL;
666 virtual_dir = kobject_create_and_add("virtual",
667 &devices_kset->kobj);
677 #define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
679 static void class_dir_release(struct kobject *kobj)
681 struct class_dir *dir = to_class_dir(kobj);
686 struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
688 struct class_dir *dir = to_class_dir(kobj);
689 return dir->class->ns_type;
692 static struct kobj_type class_dir_ktype = {
693 .release = class_dir_release,
694 .sysfs_ops = &kobj_sysfs_ops,
695 .child_ns_type = class_dir_child_ns_type
698 static struct kobject *
699 class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
701 struct class_dir *dir;
704 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
709 kobject_init(&dir->kobj, &class_dir_ktype);
711 dir->kobj.kset = &class->p->glue_dirs;
713 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
715 kobject_put(&dir->kobj);
722 static struct kobject *get_device_parent(struct device *dev,
723 struct device *parent)
726 static DEFINE_MUTEX(gdp_mutex);
727 struct kobject *kobj = NULL;
728 struct kobject *parent_kobj;
732 /* block disks show up in /sys/block */
733 if (sysfs_deprecated && dev->class == &block_class) {
734 if (parent && parent->class == &block_class)
735 return &parent->kobj;
736 return &block_class.p->subsys.kobj;
741 * If we have no parent, we live in "virtual".
742 * Class-devices with a non class-device as parent, live
743 * in a "glue" directory to prevent namespace collisions.
746 parent_kobj = virtual_device_parent(dev);
747 else if (parent->class && !dev->class->ns_type)
748 return &parent->kobj;
750 parent_kobj = &parent->kobj;
752 mutex_lock(&gdp_mutex);
754 /* find our class-directory at the parent and reference it */
755 spin_lock(&dev->class->p->glue_dirs.list_lock);
756 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
757 if (k->parent == parent_kobj) {
758 kobj = kobject_get(k);
761 spin_unlock(&dev->class->p->glue_dirs.list_lock);
763 mutex_unlock(&gdp_mutex);
767 /* or create a new class-directory at the parent device */
768 k = class_dir_create_and_add(dev->class, parent_kobj);
769 /* do not emit an uevent for this simple "glue" directory */
770 mutex_unlock(&gdp_mutex);
774 /* subsystems can specify a default root directory for their devices */
775 if (!parent && dev->bus && dev->bus->dev_root)
776 return &dev->bus->dev_root->kobj;
779 return &parent->kobj;
783 static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
785 /* see if we live in a "glue" directory */
786 if (!glue_dir || !dev->class ||
787 glue_dir->kset != &dev->class->p->glue_dirs)
790 kobject_put(glue_dir);
793 static void cleanup_device_parent(struct device *dev)
795 cleanup_glue_dir(dev, dev->kobj.parent);
798 static int device_add_class_symlinks(struct device *dev)
805 error = sysfs_create_link(&dev->kobj,
806 &dev->class->p->subsys.kobj,
811 if (dev->parent && device_is_not_partition(dev)) {
812 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
819 /* /sys/block has directories and does not need symlinks */
820 if (sysfs_deprecated && dev->class == &block_class)
824 /* link in the class directory pointing to the device */
825 error = sysfs_create_link(&dev->class->p->subsys.kobj,
826 &dev->kobj, dev_name(dev));
833 sysfs_remove_link(&dev->kobj, "device");
836 sysfs_remove_link(&dev->kobj, "subsystem");
841 static void device_remove_class_symlinks(struct device *dev)
846 if (dev->parent && device_is_not_partition(dev))
847 sysfs_remove_link(&dev->kobj, "device");
848 sysfs_remove_link(&dev->kobj, "subsystem");
850 if (sysfs_deprecated && dev->class == &block_class)
853 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
857 * dev_set_name - set a device name
859 * @fmt: format string for the device's name
861 int dev_set_name(struct device *dev, const char *fmt, ...)
866 va_start(vargs, fmt);
867 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
871 EXPORT_SYMBOL_GPL(dev_set_name);
874 * device_to_dev_kobj - select a /sys/dev/ directory for the device
877 * By default we select char/ for new entries. Setting class->dev_obj
878 * to NULL prevents an entry from being created. class->dev_kobj must
879 * be set (or cleared) before any devices are registered to the class
880 * otherwise device_create_sys_dev_entry() and
881 * device_remove_sys_dev_entry() will disagree about the the presence
884 static struct kobject *device_to_dev_kobj(struct device *dev)
886 struct kobject *kobj;
889 kobj = dev->class->dev_kobj;
891 kobj = sysfs_dev_char_kobj;
896 static int device_create_sys_dev_entry(struct device *dev)
898 struct kobject *kobj = device_to_dev_kobj(dev);
903 format_dev_t(devt_str, dev->devt);
904 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
910 static void device_remove_sys_dev_entry(struct device *dev)
912 struct kobject *kobj = device_to_dev_kobj(dev);
916 format_dev_t(devt_str, dev->devt);
917 sysfs_remove_link(kobj, devt_str);
921 int device_private_init(struct device *dev)
923 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
926 dev->p->device = dev;
927 klist_init(&dev->p->klist_children, klist_children_get,
929 INIT_LIST_HEAD(&dev->p->deferred_probe);
934 * device_add - add device to device hierarchy.
937 * This is part 2 of device_register(), though may be called
938 * separately _iff_ device_initialize() has been called separately.
940 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
941 * to the global and sibling lists for the device, then
942 * adds it to the other relevant subsystems of the driver model.
944 * Do not call this routine or device_register() more than once for
945 * any device structure. The driver model core is not designed to work
946 * with devices that get unregistered and then spring back to life.
947 * (Among other things, it's very hard to guarantee that all references
948 * to the previous incarnation of @dev have been dropped.) Allocate
949 * and register a fresh new struct device instead.
951 * NOTE: _Never_ directly free @dev after calling this function, even
952 * if it returned an error! Always use put_device() to give up your
955 int device_add(struct device *dev)
957 struct device *parent = NULL;
958 struct kobject *kobj;
959 struct class_interface *class_intf;
962 dev = get_device(dev);
967 error = device_private_init(dev);
973 * for statically allocated devices, which should all be converted
974 * some day, we need to initialize the name. We prevent reading back
975 * the name, and force the use of dev_name()
977 if (dev->init_name) {
978 dev_set_name(dev, "%s", dev->init_name);
979 dev->init_name = NULL;
982 /* subsystems can specify simple device enumeration */
983 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
984 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
986 if (!dev_name(dev)) {
991 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
993 parent = get_device(dev->parent);
994 kobj = get_device_parent(dev, parent);
996 dev->kobj.parent = kobj;
998 /* use parent numa_node */
1000 set_dev_node(dev, dev_to_node(parent));
1002 /* first, register with generic layer. */
1003 /* we require the name to be set before, and pass NULL */
1004 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
1008 /* notify platform of device entry */
1009 if (platform_notify)
1010 platform_notify(dev);
1012 error = device_create_file(dev, &uevent_attr);
1016 if (MAJOR(dev->devt)) {
1017 error = device_create_file(dev, &devt_attr);
1019 goto ueventattrError;
1021 error = device_create_sys_dev_entry(dev);
1025 devtmpfs_create_node(dev);
1028 error = device_add_class_symlinks(dev);
1031 error = device_add_attrs(dev);
1034 error = bus_add_device(dev);
1037 error = dpm_sysfs_add(dev);
1042 /* Notify clients of device addition. This call must come
1043 * after dpm_sysfs_add() and before kobject_uevent().
1046 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1047 BUS_NOTIFY_ADD_DEVICE, dev);
1049 kobject_uevent(&dev->kobj, KOBJ_ADD);
1050 bus_probe_device(dev);
1052 klist_add_tail(&dev->p->knode_parent,
1053 &parent->p->klist_children);
1056 mutex_lock(&dev->class->p->mutex);
1057 /* tie the class to the device */
1058 klist_add_tail(&dev->knode_class,
1059 &dev->class->p->klist_devices);
1061 /* notify any interfaces that the device is here */
1062 list_for_each_entry(class_intf,
1063 &dev->class->p->interfaces, node)
1064 if (class_intf->add_dev)
1065 class_intf->add_dev(dev, class_intf);
1066 mutex_unlock(&dev->class->p->mutex);
1072 bus_remove_device(dev);
1074 device_remove_attrs(dev);
1076 device_remove_class_symlinks(dev);
1078 if (MAJOR(dev->devt))
1079 devtmpfs_delete_node(dev);
1080 if (MAJOR(dev->devt))
1081 device_remove_sys_dev_entry(dev);
1083 if (MAJOR(dev->devt))
1084 device_remove_file(dev, &devt_attr);
1086 device_remove_file(dev, &uevent_attr);
1088 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1089 kobject_del(&dev->kobj);
1091 cleanup_device_parent(dev);
1101 * device_register - register a device with the system.
1102 * @dev: pointer to the device structure
1104 * This happens in two clean steps - initialize the device
1105 * and add it to the system. The two steps can be called
1106 * separately, but this is the easiest and most common.
1107 * I.e. you should only call the two helpers separately if
1108 * have a clearly defined need to use and refcount the device
1109 * before it is added to the hierarchy.
1111 * For more information, see the kerneldoc for device_initialize()
1114 * NOTE: _Never_ directly free @dev after calling this function, even
1115 * if it returned an error! Always use put_device() to give up the
1116 * reference initialized in this function instead.
1118 int device_register(struct device *dev)
1120 device_initialize(dev);
1121 return device_add(dev);
1125 * get_device - increment reference count for device.
1128 * This simply forwards the call to kobject_get(), though
1129 * we do take care to provide for the case that we get a NULL
1130 * pointer passed in.
1132 struct device *get_device(struct device *dev)
1134 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
1138 * put_device - decrement reference count.
1139 * @dev: device in question.
1141 void put_device(struct device *dev)
1143 /* might_sleep(); */
1145 kobject_put(&dev->kobj);
1149 * device_del - delete device from system.
1152 * This is the first part of the device unregistration
1153 * sequence. This removes the device from the lists we control
1154 * from here, has it removed from the other driver model
1155 * subsystems it was added to in device_add(), and removes it
1156 * from the kobject hierarchy.
1158 * NOTE: this should be called manually _iff_ device_add() was
1159 * also called manually.
1161 void device_del(struct device *dev)
1163 struct device *parent = dev->parent;
1164 struct class_interface *class_intf;
1166 /* Notify clients of device removal. This call must come
1167 * before dpm_sysfs_remove().
1170 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1171 BUS_NOTIFY_DEL_DEVICE, dev);
1172 device_pm_remove(dev);
1173 dpm_sysfs_remove(dev);
1175 klist_del(&dev->p->knode_parent);
1176 if (MAJOR(dev->devt)) {
1177 devtmpfs_delete_node(dev);
1178 device_remove_sys_dev_entry(dev);
1179 device_remove_file(dev, &devt_attr);
1182 device_remove_class_symlinks(dev);
1184 mutex_lock(&dev->class->p->mutex);
1185 /* notify any interfaces that the device is now gone */
1186 list_for_each_entry(class_intf,
1187 &dev->class->p->interfaces, node)
1188 if (class_intf->remove_dev)
1189 class_intf->remove_dev(dev, class_intf);
1190 /* remove the device from the class list */
1191 klist_del(&dev->knode_class);
1192 mutex_unlock(&dev->class->p->mutex);
1194 device_remove_file(dev, &uevent_attr);
1195 device_remove_attrs(dev);
1196 bus_remove_device(dev);
1197 driver_deferred_probe_del(dev);
1200 * Some platform devices are driven without driver attached
1201 * and managed resources may have been acquired. Make sure
1202 * all resources are released.
1204 devres_release_all(dev);
1206 /* Notify the platform of the removal, in case they
1207 * need to do anything...
1209 if (platform_notify_remove)
1210 platform_notify_remove(dev);
1211 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1212 cleanup_device_parent(dev);
1213 kobject_del(&dev->kobj);
1218 * device_unregister - unregister device from system.
1219 * @dev: device going away.
1221 * We do this in two parts, like we do device_register(). First,
1222 * we remove it from all the subsystems with device_del(), then
1223 * we decrement the reference count via put_device(). If that
1224 * is the final reference count, the device will be cleaned up
1225 * via device_release() above. Otherwise, the structure will
1226 * stick around until the final reference to the device is dropped.
1228 void device_unregister(struct device *dev)
1230 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1235 static struct device *next_device(struct klist_iter *i)
1237 struct klist_node *n = klist_next(i);
1238 struct device *dev = NULL;
1239 struct device_private *p;
1242 p = to_device_private_parent(n);
1249 * device_get_devnode - path of device node file
1251 * @mode: returned file access mode
1252 * @tmp: possibly allocated string
1254 * Return the relative path of a possible device node.
1255 * Non-default names may need to allocate a memory to compose
1256 * a name. This memory is returned in tmp and needs to be
1257 * freed by the caller.
1259 const char *device_get_devnode(struct device *dev,
1260 umode_t *mode, const char **tmp)
1266 /* the device type may provide a specific name */
1267 if (dev->type && dev->type->devnode)
1268 *tmp = dev->type->devnode(dev, mode);
1272 /* the class may provide a specific name */
1273 if (dev->class && dev->class->devnode)
1274 *tmp = dev->class->devnode(dev, mode);
1278 /* return name without allocation, tmp == NULL */
1279 if (strchr(dev_name(dev), '!') == NULL)
1280 return dev_name(dev);
1282 /* replace '!' in the name with '/' */
1283 *tmp = kstrdup(dev_name(dev), GFP_KERNEL);
1286 while ((s = strchr(*tmp, '!')))
1292 * device_for_each_child - device child iterator.
1293 * @parent: parent struct device.
1294 * @data: data for the callback.
1295 * @fn: function to be called for each device.
1297 * Iterate over @parent's child devices, and call @fn for each,
1300 * We check the return of @fn each time. If it returns anything
1301 * other than 0, we break out and return that value.
1303 int device_for_each_child(struct device *parent, void *data,
1304 int (*fn)(struct device *dev, void *data))
1306 struct klist_iter i;
1307 struct device *child;
1313 klist_iter_init(&parent->p->klist_children, &i);
1314 while ((child = next_device(&i)) && !error)
1315 error = fn(child, data);
1316 klist_iter_exit(&i);
1321 * device_find_child - device iterator for locating a particular device.
1322 * @parent: parent struct device
1323 * @data: Data to pass to match function
1324 * @match: Callback function to check device
1326 * This is similar to the device_for_each_child() function above, but it
1327 * returns a reference to a device that is 'found' for later use, as
1328 * determined by the @match callback.
1330 * The callback should return 0 if the device doesn't match and non-zero
1331 * if it does. If the callback returns non-zero and a reference to the
1332 * current device can be obtained, this function will return to the caller
1333 * and not iterate over any more devices.
1335 struct device *device_find_child(struct device *parent, void *data,
1336 int (*match)(struct device *dev, void *data))
1338 struct klist_iter i;
1339 struct device *child;
1344 klist_iter_init(&parent->p->klist_children, &i);
1345 while ((child = next_device(&i)))
1346 if (match(child, data) && get_device(child))
1348 klist_iter_exit(&i);
1352 int __init devices_init(void)
1354 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1357 dev_kobj = kobject_create_and_add("dev", NULL);
1360 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1361 if (!sysfs_dev_block_kobj)
1362 goto block_kobj_err;
1363 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1364 if (!sysfs_dev_char_kobj)
1370 kobject_put(sysfs_dev_block_kobj);
1372 kobject_put(dev_kobj);
1374 kset_unregister(devices_kset);
1378 EXPORT_SYMBOL_GPL(device_for_each_child);
1379 EXPORT_SYMBOL_GPL(device_find_child);
1381 EXPORT_SYMBOL_GPL(device_initialize);
1382 EXPORT_SYMBOL_GPL(device_add);
1383 EXPORT_SYMBOL_GPL(device_register);
1385 EXPORT_SYMBOL_GPL(device_del);
1386 EXPORT_SYMBOL_GPL(device_unregister);
1387 EXPORT_SYMBOL_GPL(get_device);
1388 EXPORT_SYMBOL_GPL(put_device);
1390 EXPORT_SYMBOL_GPL(device_create_file);
1391 EXPORT_SYMBOL_GPL(device_remove_file);
1393 struct root_device {
1395 struct module *owner;
1398 inline struct root_device *to_root_device(struct device *d)
1400 return container_of(d, struct root_device, dev);
1403 static void root_device_release(struct device *dev)
1405 kfree(to_root_device(dev));
1409 * __root_device_register - allocate and register a root device
1410 * @name: root device name
1411 * @owner: owner module of the root device, usually THIS_MODULE
1413 * This function allocates a root device and registers it
1414 * using device_register(). In order to free the returned
1415 * device, use root_device_unregister().
1417 * Root devices are dummy devices which allow other devices
1418 * to be grouped under /sys/devices. Use this function to
1419 * allocate a root device and then use it as the parent of
1420 * any device which should appear under /sys/devices/{name}
1422 * The /sys/devices/{name} directory will also contain a
1423 * 'module' symlink which points to the @owner directory
1426 * Returns &struct device pointer on success, or ERR_PTR() on error.
1428 * Note: You probably want to use root_device_register().
1430 struct device *__root_device_register(const char *name, struct module *owner)
1432 struct root_device *root;
1435 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1437 return ERR_PTR(err);
1439 err = dev_set_name(&root->dev, "%s", name);
1442 return ERR_PTR(err);
1445 root->dev.release = root_device_release;
1447 err = device_register(&root->dev);
1449 put_device(&root->dev);
1450 return ERR_PTR(err);
1453 #ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
1455 struct module_kobject *mk = &owner->mkobj;
1457 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1459 device_unregister(&root->dev);
1460 return ERR_PTR(err);
1462 root->owner = owner;
1468 EXPORT_SYMBOL_GPL(__root_device_register);
1471 * root_device_unregister - unregister and free a root device
1472 * @dev: device going away
1474 * This function unregisters and cleans up a device that was created by
1475 * root_device_register().
1477 void root_device_unregister(struct device *dev)
1479 struct root_device *root = to_root_device(dev);
1482 sysfs_remove_link(&root->dev.kobj, "module");
1484 device_unregister(dev);
1486 EXPORT_SYMBOL_GPL(root_device_unregister);
1489 static void device_create_release(struct device *dev)
1491 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1496 * device_create_vargs - creates a device and registers it with sysfs
1497 * @class: pointer to the struct class that this device should be registered to
1498 * @parent: pointer to the parent struct device of this new device, if any
1499 * @devt: the dev_t for the char device to be added
1500 * @drvdata: the data to be added to the device for callbacks
1501 * @fmt: string for the device's name
1502 * @args: va_list for the device's name
1504 * This function can be used by char device classes. A struct device
1505 * will be created in sysfs, registered to the specified class.
1507 * A "dev" file will be created, showing the dev_t for the device, if
1508 * the dev_t is not 0,0.
1509 * If a pointer to a parent struct device is passed in, the newly created
1510 * struct device will be a child of that device in sysfs.
1511 * The pointer to the struct device will be returned from the call.
1512 * Any further sysfs files that might be required can be created using this
1515 * Returns &struct device pointer on success, or ERR_PTR() on error.
1517 * Note: the struct class passed to this function must have previously
1518 * been created with a call to class_create().
1520 struct device *device_create_vargs(struct class *class, struct device *parent,
1521 dev_t devt, void *drvdata, const char *fmt,
1524 struct device *dev = NULL;
1525 int retval = -ENODEV;
1527 if (class == NULL || IS_ERR(class))
1530 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1538 dev->parent = parent;
1539 dev->release = device_create_release;
1540 dev_set_drvdata(dev, drvdata);
1542 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1546 retval = device_register(dev);
1554 return ERR_PTR(retval);
1556 EXPORT_SYMBOL_GPL(device_create_vargs);
1559 * device_create - creates a device and registers it with sysfs
1560 * @class: pointer to the struct class that this device should be registered to
1561 * @parent: pointer to the parent struct device of this new device, if any
1562 * @devt: the dev_t for the char device to be added
1563 * @drvdata: the data to be added to the device for callbacks
1564 * @fmt: string for the device's name
1566 * This function can be used by char device classes. A struct device
1567 * will be created in sysfs, registered to the specified class.
1569 * A "dev" file will be created, showing the dev_t for the device, if
1570 * the dev_t is not 0,0.
1571 * If a pointer to a parent struct device is passed in, the newly created
1572 * struct device will be a child of that device in sysfs.
1573 * The pointer to the struct device will be returned from the call.
1574 * Any further sysfs files that might be required can be created using this
1577 * Returns &struct device pointer on success, or ERR_PTR() on error.
1579 * Note: the struct class passed to this function must have previously
1580 * been created with a call to class_create().
1582 struct device *device_create(struct class *class, struct device *parent,
1583 dev_t devt, void *drvdata, const char *fmt, ...)
1588 va_start(vargs, fmt);
1589 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1593 EXPORT_SYMBOL_GPL(device_create);
1595 static int __match_devt(struct device *dev, void *data)
1599 return dev->devt == *devt;
1603 * device_destroy - removes a device that was created with device_create()
1604 * @class: pointer to the struct class that this device was registered with
1605 * @devt: the dev_t of the device that was previously registered
1607 * This call unregisters and cleans up a device that was created with a
1608 * call to device_create().
1610 void device_destroy(struct class *class, dev_t devt)
1614 dev = class_find_device(class, NULL, &devt, __match_devt);
1617 device_unregister(dev);
1620 EXPORT_SYMBOL_GPL(device_destroy);
1623 * device_rename - renames a device
1624 * @dev: the pointer to the struct device to be renamed
1625 * @new_name: the new name of the device
1627 * It is the responsibility of the caller to provide mutual
1628 * exclusion between two different calls of device_rename
1629 * on the same device to ensure that new_name is valid and
1630 * won't conflict with other devices.
1632 * Note: Don't call this function. Currently, the networking layer calls this
1633 * function, but that will change. The following text from Kay Sievers offers
1636 * Renaming devices is racy at many levels, symlinks and other stuff are not
1637 * replaced atomically, and you get a "move" uevent, but it's not easy to
1638 * connect the event to the old and new device. Device nodes are not renamed at
1639 * all, there isn't even support for that in the kernel now.
1641 * In the meantime, during renaming, your target name might be taken by another
1642 * driver, creating conflicts. Or the old name is taken directly after you
1643 * renamed it -- then you get events for the same DEVPATH, before you even see
1644 * the "move" event. It's just a mess, and nothing new should ever rely on
1645 * kernel device renaming. Besides that, it's not even implemented now for
1646 * other things than (driver-core wise very simple) network devices.
1648 * We are currently about to change network renaming in udev to completely
1649 * disallow renaming of devices in the same namespace as the kernel uses,
1650 * because we can't solve the problems properly, that arise with swapping names
1651 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1652 * be allowed to some other name than eth[0-9]*, for the aforementioned
1655 * Make up a "real" name in the driver before you register anything, or add
1656 * some other attributes for userspace to find the device, or use udev to add
1657 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1658 * don't even want to get into that and try to implement the missing pieces in
1659 * the core. We really have other pieces to fix in the driver core mess. :)
1661 int device_rename(struct device *dev, const char *new_name)
1663 char *old_class_name = NULL;
1664 char *new_class_name = NULL;
1665 char *old_device_name = NULL;
1668 dev = get_device(dev);
1672 pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
1673 __func__, new_name);
1675 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
1676 if (!old_device_name) {
1682 error = sysfs_rename_link(&dev->class->p->subsys.kobj,
1683 &dev->kobj, old_device_name, new_name);
1688 error = kobject_rename(&dev->kobj, new_name);
1695 kfree(new_class_name);
1696 kfree(old_class_name);
1697 kfree(old_device_name);
1701 EXPORT_SYMBOL_GPL(device_rename);
1703 static int device_move_class_links(struct device *dev,
1704 struct device *old_parent,
1705 struct device *new_parent)
1710 sysfs_remove_link(&dev->kobj, "device");
1712 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1718 * device_move - moves a device to a new parent
1719 * @dev: the pointer to the struct device to be moved
1720 * @new_parent: the new parent of the device (can by NULL)
1721 * @dpm_order: how to reorder the dpm_list
1723 int device_move(struct device *dev, struct device *new_parent,
1724 enum dpm_order dpm_order)
1727 struct device *old_parent;
1728 struct kobject *new_parent_kobj;
1730 dev = get_device(dev);
1735 new_parent = get_device(new_parent);
1736 new_parent_kobj = get_device_parent(dev, new_parent);
1738 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1739 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
1740 error = kobject_move(&dev->kobj, new_parent_kobj);
1742 cleanup_glue_dir(dev, new_parent_kobj);
1743 put_device(new_parent);
1746 old_parent = dev->parent;
1747 dev->parent = new_parent;
1749 klist_remove(&dev->p->knode_parent);
1751 klist_add_tail(&dev->p->knode_parent,
1752 &new_parent->p->klist_children);
1753 set_dev_node(dev, dev_to_node(new_parent));
1758 error = device_move_class_links(dev, old_parent, new_parent);
1760 /* We ignore errors on cleanup since we're hosed anyway... */
1761 device_move_class_links(dev, new_parent, old_parent);
1762 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1764 klist_remove(&dev->p->knode_parent);
1765 dev->parent = old_parent;
1767 klist_add_tail(&dev->p->knode_parent,
1768 &old_parent->p->klist_children);
1769 set_dev_node(dev, dev_to_node(old_parent));
1772 cleanup_glue_dir(dev, new_parent_kobj);
1773 put_device(new_parent);
1776 switch (dpm_order) {
1777 case DPM_ORDER_NONE:
1779 case DPM_ORDER_DEV_AFTER_PARENT:
1780 device_pm_move_after(dev, new_parent);
1782 case DPM_ORDER_PARENT_BEFORE_DEV:
1783 device_pm_move_before(new_parent, dev);
1785 case DPM_ORDER_DEV_LAST:
1786 device_pm_move_last(dev);
1790 put_device(old_parent);
1796 EXPORT_SYMBOL_GPL(device_move);
1799 * device_shutdown - call ->shutdown() on each device to shutdown.
1801 void device_shutdown(void)
1805 spin_lock(&devices_kset->list_lock);
1807 * Walk the devices list backward, shutting down each in turn.
1808 * Beware that device unplug events may also start pulling
1809 * devices offline, even as the system is shutting down.
1811 while (!list_empty(&devices_kset->list)) {
1812 dev = list_entry(devices_kset->list.prev, struct device,
1816 * Make sure the device is off the kset list, in the
1817 * event that dev->*->shutdown() doesn't remove it.
1819 list_del_init(&dev->kobj.entry);
1820 spin_unlock(&devices_kset->list_lock);
1822 /* Don't allow any more runtime suspends */
1823 pm_runtime_get_noresume(dev);
1824 pm_runtime_barrier(dev);
1826 if (dev->bus && dev->bus->shutdown) {
1827 dev_dbg(dev, "shutdown\n");
1828 dev->bus->shutdown(dev);
1829 } else if (dev->driver && dev->driver->shutdown) {
1830 dev_dbg(dev, "shutdown\n");
1831 dev->driver->shutdown(dev);
1835 spin_lock(&devices_kset->list_lock);
1837 spin_unlock(&devices_kset->list_lock);
1838 async_synchronize_full();
1842 * Device logging functions
1845 #ifdef CONFIG_PRINTK
1847 int __dev_printk(const char *level, const struct device *dev,
1848 struct va_format *vaf)
1851 return printk("%s(NULL device *): %pV", level, vaf);
1853 return printk("%s%s %s: %pV",
1854 level, dev_driver_string(dev), dev_name(dev), vaf);
1856 EXPORT_SYMBOL(__dev_printk);
1858 int dev_printk(const char *level, const struct device *dev,
1859 const char *fmt, ...)
1861 struct va_format vaf;
1865 va_start(args, fmt);
1870 r = __dev_printk(level, dev, &vaf);
1875 EXPORT_SYMBOL(dev_printk);
1877 #define define_dev_printk_level(func, kern_level) \
1878 int func(const struct device *dev, const char *fmt, ...) \
1880 struct va_format vaf; \
1884 va_start(args, fmt); \
1889 r = __dev_printk(kern_level, dev, &vaf); \
1894 EXPORT_SYMBOL(func);
1896 define_dev_printk_level(dev_emerg, KERN_EMERG);
1897 define_dev_printk_level(dev_alert, KERN_ALERT);
1898 define_dev_printk_level(dev_crit, KERN_CRIT);
1899 define_dev_printk_level(dev_err, KERN_ERR);
1900 define_dev_printk_level(dev_warn, KERN_WARNING);
1901 define_dev_printk_level(dev_notice, KERN_NOTICE);
1902 define_dev_printk_level(_dev_info, KERN_INFO);