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/fwnode.h>
16 #include <linux/init.h>
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <linux/string.h>
20 #include <linux/kdev_t.h>
21 #include <linux/notifier.h>
23 #include <linux/of_device.h>
24 #include <linux/genhd.h>
25 #include <linux/kallsyms.h>
26 #include <linux/mutex.h>
27 #include <linux/pm_runtime.h>
28 #include <linux/netdevice.h>
29 #include <linux/sysfs.h>
32 #include "power/power.h"
34 #ifdef CONFIG_SYSFS_DEPRECATED
35 #ifdef CONFIG_SYSFS_DEPRECATED_V2
36 long sysfs_deprecated = 1;
38 long sysfs_deprecated = 0;
40 static int __init sysfs_deprecated_setup(char *arg)
42 return kstrtol(arg, 10, &sysfs_deprecated);
44 early_param("sysfs.deprecated", sysfs_deprecated_setup);
47 int (*platform_notify)(struct device *dev) = NULL;
48 int (*platform_notify_remove)(struct device *dev) = NULL;
49 static struct kobject *dev_kobj;
50 struct kobject *sysfs_dev_char_kobj;
51 struct kobject *sysfs_dev_block_kobj;
53 static DEFINE_MUTEX(device_hotplug_lock);
55 void lock_device_hotplug(void)
57 mutex_lock(&device_hotplug_lock);
60 void unlock_device_hotplug(void)
62 mutex_unlock(&device_hotplug_lock);
65 int lock_device_hotplug_sysfs(void)
67 if (mutex_trylock(&device_hotplug_lock))
70 /* Avoid busy looping (5 ms of sleep should do). */
72 return restart_syscall();
76 static inline int device_is_not_partition(struct device *dev)
78 return !(dev->type == &part_type);
81 static inline int device_is_not_partition(struct device *dev)
88 * dev_driver_string - Return a device's driver name, if at all possible
89 * @dev: struct device to get the name of
91 * Will return the device's driver's name if it is bound to a device. If
92 * the device is not bound to a driver, it will return the name of the bus
93 * it is attached to. If it is not attached to a bus either, an empty
94 * string will be returned.
96 const char *dev_driver_string(const struct device *dev)
98 struct device_driver *drv;
100 /* dev->driver can change to NULL underneath us because of unbinding,
101 * so be careful about accessing it. dev->bus and dev->class should
102 * never change once they are set, so they don't need special care.
104 drv = ACCESS_ONCE(dev->driver);
105 return drv ? drv->name :
106 (dev->bus ? dev->bus->name :
107 (dev->class ? dev->class->name : ""));
109 EXPORT_SYMBOL(dev_driver_string);
111 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
113 static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
116 struct device_attribute *dev_attr = to_dev_attr(attr);
117 struct device *dev = kobj_to_dev(kobj);
121 ret = dev_attr->show(dev, dev_attr, buf);
122 if (ret >= (ssize_t)PAGE_SIZE) {
123 print_symbol("dev_attr_show: %s returned bad count\n",
124 (unsigned long)dev_attr->show);
129 static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
130 const char *buf, size_t count)
132 struct device_attribute *dev_attr = to_dev_attr(attr);
133 struct device *dev = kobj_to_dev(kobj);
137 ret = dev_attr->store(dev, dev_attr, buf, count);
141 static const struct sysfs_ops dev_sysfs_ops = {
142 .show = dev_attr_show,
143 .store = dev_attr_store,
146 #define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
148 ssize_t device_store_ulong(struct device *dev,
149 struct device_attribute *attr,
150 const char *buf, size_t size)
152 struct dev_ext_attribute *ea = to_ext_attr(attr);
154 unsigned long new = simple_strtoul(buf, &end, 0);
157 *(unsigned long *)(ea->var) = new;
158 /* Always return full write size even if we didn't consume all */
161 EXPORT_SYMBOL_GPL(device_store_ulong);
163 ssize_t device_show_ulong(struct device *dev,
164 struct device_attribute *attr,
167 struct dev_ext_attribute *ea = to_ext_attr(attr);
168 return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
170 EXPORT_SYMBOL_GPL(device_show_ulong);
172 ssize_t device_store_int(struct device *dev,
173 struct device_attribute *attr,
174 const char *buf, size_t size)
176 struct dev_ext_attribute *ea = to_ext_attr(attr);
178 long new = simple_strtol(buf, &end, 0);
179 if (end == buf || new > INT_MAX || new < INT_MIN)
181 *(int *)(ea->var) = new;
182 /* Always return full write size even if we didn't consume all */
185 EXPORT_SYMBOL_GPL(device_store_int);
187 ssize_t device_show_int(struct device *dev,
188 struct device_attribute *attr,
191 struct dev_ext_attribute *ea = to_ext_attr(attr);
193 return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
195 EXPORT_SYMBOL_GPL(device_show_int);
197 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
198 const char *buf, size_t size)
200 struct dev_ext_attribute *ea = to_ext_attr(attr);
202 if (strtobool(buf, ea->var) < 0)
207 EXPORT_SYMBOL_GPL(device_store_bool);
209 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
212 struct dev_ext_attribute *ea = to_ext_attr(attr);
214 return snprintf(buf, PAGE_SIZE, "%d\n", *(bool *)(ea->var));
216 EXPORT_SYMBOL_GPL(device_show_bool);
219 * device_release - free device structure.
220 * @kobj: device's kobject.
222 * This is called once the reference count for the object
223 * reaches 0. We forward the call to the device's release
224 * method, which should handle actually freeing the structure.
226 static void device_release(struct kobject *kobj)
228 struct device *dev = kobj_to_dev(kobj);
229 struct device_private *p = dev->p;
232 * Some platform devices are driven without driver attached
233 * and managed resources may have been acquired. Make sure
234 * all resources are released.
236 * Drivers still can add resources into device after device
237 * is deleted but alive, so release devres here to avoid
238 * possible memory leak.
240 devres_release_all(dev);
244 else if (dev->type && dev->type->release)
245 dev->type->release(dev);
246 else if (dev->class && dev->class->dev_release)
247 dev->class->dev_release(dev);
249 WARN(1, KERN_ERR "Device '%s' does not have a release() "
250 "function, it is broken and must be fixed.\n",
255 static const void *device_namespace(struct kobject *kobj)
257 struct device *dev = kobj_to_dev(kobj);
258 const void *ns = NULL;
260 if (dev->class && dev->class->ns_type)
261 ns = dev->class->namespace(dev);
266 static struct kobj_type device_ktype = {
267 .release = device_release,
268 .sysfs_ops = &dev_sysfs_ops,
269 .namespace = device_namespace,
273 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
275 struct kobj_type *ktype = get_ktype(kobj);
277 if (ktype == &device_ktype) {
278 struct device *dev = kobj_to_dev(kobj);
287 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
289 struct device *dev = kobj_to_dev(kobj);
292 return dev->bus->name;
294 return dev->class->name;
298 static int dev_uevent(struct kset *kset, struct kobject *kobj,
299 struct kobj_uevent_env *env)
301 struct device *dev = kobj_to_dev(kobj);
304 /* add device node properties if present */
305 if (MAJOR(dev->devt)) {
309 kuid_t uid = GLOBAL_ROOT_UID;
310 kgid_t gid = GLOBAL_ROOT_GID;
312 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
313 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
314 name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
316 add_uevent_var(env, "DEVNAME=%s", name);
318 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
319 if (!uid_eq(uid, GLOBAL_ROOT_UID))
320 add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid));
321 if (!gid_eq(gid, GLOBAL_ROOT_GID))
322 add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid));
327 if (dev->type && dev->type->name)
328 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
331 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
333 /* Add common DT information about the device */
334 of_device_uevent(dev, env);
336 /* have the bus specific function add its stuff */
337 if (dev->bus && dev->bus->uevent) {
338 retval = dev->bus->uevent(dev, env);
340 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
341 dev_name(dev), __func__, retval);
344 /* have the class specific function add its stuff */
345 if (dev->class && dev->class->dev_uevent) {
346 retval = dev->class->dev_uevent(dev, env);
348 pr_debug("device: '%s': %s: class uevent() "
349 "returned %d\n", dev_name(dev),
353 /* have the device type specific function add its stuff */
354 if (dev->type && dev->type->uevent) {
355 retval = dev->type->uevent(dev, env);
357 pr_debug("device: '%s': %s: dev_type uevent() "
358 "returned %d\n", dev_name(dev),
365 static const struct kset_uevent_ops device_uevent_ops = {
366 .filter = dev_uevent_filter,
367 .name = dev_uevent_name,
368 .uevent = dev_uevent,
371 static ssize_t uevent_show(struct device *dev, struct device_attribute *attr,
374 struct kobject *top_kobj;
376 struct kobj_uevent_env *env = NULL;
381 /* search the kset, the device belongs to */
382 top_kobj = &dev->kobj;
383 while (!top_kobj->kset && top_kobj->parent)
384 top_kobj = top_kobj->parent;
388 kset = top_kobj->kset;
389 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
393 if (kset->uevent_ops && kset->uevent_ops->filter)
394 if (!kset->uevent_ops->filter(kset, &dev->kobj))
397 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
401 /* let the kset specific function add its keys */
402 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
406 /* copy keys to file */
407 for (i = 0; i < env->envp_idx; i++)
408 count += sprintf(&buf[count], "%s\n", env->envp[i]);
414 static ssize_t uevent_store(struct device *dev, struct device_attribute *attr,
415 const char *buf, size_t count)
417 enum kobject_action action;
419 if (kobject_action_type(buf, count, &action) == 0)
420 kobject_uevent(&dev->kobj, action);
422 dev_err(dev, "uevent: unknown action-string\n");
425 static DEVICE_ATTR_RW(uevent);
427 static ssize_t online_show(struct device *dev, struct device_attribute *attr,
435 return sprintf(buf, "%u\n", val);
438 static ssize_t online_store(struct device *dev, struct device_attribute *attr,
439 const char *buf, size_t count)
444 ret = strtobool(buf, &val);
448 ret = lock_device_hotplug_sysfs();
452 ret = val ? device_online(dev) : device_offline(dev);
453 unlock_device_hotplug();
454 return ret < 0 ? ret : count;
456 static DEVICE_ATTR_RW(online);
458 int device_add_groups(struct device *dev, const struct attribute_group **groups)
460 return sysfs_create_groups(&dev->kobj, groups);
463 void device_remove_groups(struct device *dev,
464 const struct attribute_group **groups)
466 sysfs_remove_groups(&dev->kobj, groups);
469 static int device_add_attrs(struct device *dev)
471 struct class *class = dev->class;
472 const struct device_type *type = dev->type;
476 error = device_add_groups(dev, class->dev_groups);
482 error = device_add_groups(dev, type->groups);
484 goto err_remove_class_groups;
487 error = device_add_groups(dev, dev->groups);
489 goto err_remove_type_groups;
491 if (device_supports_offline(dev) && !dev->offline_disabled) {
492 error = device_create_file(dev, &dev_attr_online);
494 goto err_remove_dev_groups;
499 err_remove_dev_groups:
500 device_remove_groups(dev, dev->groups);
501 err_remove_type_groups:
503 device_remove_groups(dev, type->groups);
504 err_remove_class_groups:
506 device_remove_groups(dev, class->dev_groups);
511 static void device_remove_attrs(struct device *dev)
513 struct class *class = dev->class;
514 const struct device_type *type = dev->type;
516 device_remove_file(dev, &dev_attr_online);
517 device_remove_groups(dev, dev->groups);
520 device_remove_groups(dev, type->groups);
523 device_remove_groups(dev, class->dev_groups);
526 static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
529 return print_dev_t(buf, dev->devt);
531 static DEVICE_ATTR_RO(dev);
534 struct kset *devices_kset;
537 * devices_kset_move_before - Move device in the devices_kset's list.
538 * @deva: Device to move.
539 * @devb: Device @deva should come before.
541 static void devices_kset_move_before(struct device *deva, struct device *devb)
545 pr_debug("devices_kset: Moving %s before %s\n",
546 dev_name(deva), dev_name(devb));
547 spin_lock(&devices_kset->list_lock);
548 list_move_tail(&deva->kobj.entry, &devb->kobj.entry);
549 spin_unlock(&devices_kset->list_lock);
553 * devices_kset_move_after - Move device in the devices_kset's list.
554 * @deva: Device to move
555 * @devb: Device @deva should come after.
557 static void devices_kset_move_after(struct device *deva, struct device *devb)
561 pr_debug("devices_kset: Moving %s after %s\n",
562 dev_name(deva), dev_name(devb));
563 spin_lock(&devices_kset->list_lock);
564 list_move(&deva->kobj.entry, &devb->kobj.entry);
565 spin_unlock(&devices_kset->list_lock);
569 * devices_kset_move_last - move the device to the end of devices_kset's list.
570 * @dev: device to move
572 void devices_kset_move_last(struct device *dev)
576 pr_debug("devices_kset: Moving %s to end of list\n", dev_name(dev));
577 spin_lock(&devices_kset->list_lock);
578 list_move_tail(&dev->kobj.entry, &devices_kset->list);
579 spin_unlock(&devices_kset->list_lock);
583 * device_create_file - create sysfs attribute file for device.
585 * @attr: device attribute descriptor.
587 int device_create_file(struct device *dev,
588 const struct device_attribute *attr)
593 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
594 "Attribute %s: write permission without 'store'\n",
596 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
597 "Attribute %s: read permission without 'show'\n",
599 error = sysfs_create_file(&dev->kobj, &attr->attr);
604 EXPORT_SYMBOL_GPL(device_create_file);
607 * device_remove_file - remove sysfs attribute file.
609 * @attr: device attribute descriptor.
611 void device_remove_file(struct device *dev,
612 const struct device_attribute *attr)
615 sysfs_remove_file(&dev->kobj, &attr->attr);
617 EXPORT_SYMBOL_GPL(device_remove_file);
620 * device_remove_file_self - remove sysfs attribute file from its own method.
622 * @attr: device attribute descriptor.
624 * See kernfs_remove_self() for details.
626 bool device_remove_file_self(struct device *dev,
627 const struct device_attribute *attr)
630 return sysfs_remove_file_self(&dev->kobj, &attr->attr);
634 EXPORT_SYMBOL_GPL(device_remove_file_self);
637 * device_create_bin_file - create sysfs binary attribute file for device.
639 * @attr: device binary attribute descriptor.
641 int device_create_bin_file(struct device *dev,
642 const struct bin_attribute *attr)
646 error = sysfs_create_bin_file(&dev->kobj, attr);
649 EXPORT_SYMBOL_GPL(device_create_bin_file);
652 * device_remove_bin_file - remove sysfs binary attribute file
654 * @attr: device binary attribute descriptor.
656 void device_remove_bin_file(struct device *dev,
657 const struct bin_attribute *attr)
660 sysfs_remove_bin_file(&dev->kobj, attr);
662 EXPORT_SYMBOL_GPL(device_remove_bin_file);
664 static void klist_children_get(struct klist_node *n)
666 struct device_private *p = to_device_private_parent(n);
667 struct device *dev = p->device;
672 static void klist_children_put(struct klist_node *n)
674 struct device_private *p = to_device_private_parent(n);
675 struct device *dev = p->device;
681 * device_initialize - init device structure.
684 * This prepares the device for use by other layers by initializing
686 * It is the first half of device_register(), if called by
687 * that function, though it can also be called separately, so one
688 * may use @dev's fields. In particular, get_device()/put_device()
689 * may be used for reference counting of @dev after calling this
692 * All fields in @dev must be initialized by the caller to 0, except
693 * for those explicitly set to some other value. The simplest
694 * approach is to use kzalloc() to allocate the structure containing
697 * NOTE: Use put_device() to give up your reference instead of freeing
698 * @dev directly once you have called this function.
700 void device_initialize(struct device *dev)
702 dev->kobj.kset = devices_kset;
703 kobject_init(&dev->kobj, &device_ktype);
704 INIT_LIST_HEAD(&dev->dma_pools);
705 mutex_init(&dev->mutex);
706 lockdep_set_novalidate_class(&dev->mutex);
707 spin_lock_init(&dev->devres_lock);
708 INIT_LIST_HEAD(&dev->devres_head);
710 set_dev_node(dev, -1);
711 #ifdef CONFIG_GENERIC_MSI_IRQ
712 INIT_LIST_HEAD(&dev->msi_list);
715 EXPORT_SYMBOL_GPL(device_initialize);
717 struct kobject *virtual_device_parent(struct device *dev)
719 static struct kobject *virtual_dir = NULL;
722 virtual_dir = kobject_create_and_add("virtual",
723 &devices_kset->kobj);
733 #define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
735 static void class_dir_release(struct kobject *kobj)
737 struct class_dir *dir = to_class_dir(kobj);
742 struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
744 struct class_dir *dir = to_class_dir(kobj);
745 return dir->class->ns_type;
748 static struct kobj_type class_dir_ktype = {
749 .release = class_dir_release,
750 .sysfs_ops = &kobj_sysfs_ops,
751 .child_ns_type = class_dir_child_ns_type
754 static struct kobject *
755 class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
757 struct class_dir *dir;
760 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
765 kobject_init(&dir->kobj, &class_dir_ktype);
767 dir->kobj.kset = &class->p->glue_dirs;
769 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
771 kobject_put(&dir->kobj);
777 static DEFINE_MUTEX(gdp_mutex);
779 static struct kobject *get_device_parent(struct device *dev,
780 struct device *parent)
783 struct kobject *kobj = NULL;
784 struct kobject *parent_kobj;
788 /* block disks show up in /sys/block */
789 if (sysfs_deprecated && dev->class == &block_class) {
790 if (parent && parent->class == &block_class)
791 return &parent->kobj;
792 return &block_class.p->subsys.kobj;
797 * If we have no parent, we live in "virtual".
798 * Class-devices with a non class-device as parent, live
799 * in a "glue" directory to prevent namespace collisions.
802 parent_kobj = virtual_device_parent(dev);
803 else if (parent->class && !dev->class->ns_type)
804 return &parent->kobj;
806 parent_kobj = &parent->kobj;
808 mutex_lock(&gdp_mutex);
810 /* find our class-directory at the parent and reference it */
811 spin_lock(&dev->class->p->glue_dirs.list_lock);
812 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
813 if (k->parent == parent_kobj) {
814 kobj = kobject_get(k);
817 spin_unlock(&dev->class->p->glue_dirs.list_lock);
819 mutex_unlock(&gdp_mutex);
823 /* or create a new class-directory at the parent device */
824 k = class_dir_create_and_add(dev->class, parent_kobj);
825 /* do not emit an uevent for this simple "glue" directory */
826 mutex_unlock(&gdp_mutex);
830 /* subsystems can specify a default root directory for their devices */
831 if (!parent && dev->bus && dev->bus->dev_root)
832 return &dev->bus->dev_root->kobj;
835 return &parent->kobj;
839 static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
841 /* see if we live in a "glue" directory */
842 if (!glue_dir || !dev->class ||
843 glue_dir->kset != &dev->class->p->glue_dirs)
846 mutex_lock(&gdp_mutex);
847 kobject_put(glue_dir);
848 mutex_unlock(&gdp_mutex);
851 static void cleanup_device_parent(struct device *dev)
853 cleanup_glue_dir(dev, dev->kobj.parent);
856 static int device_add_class_symlinks(struct device *dev)
858 struct device_node *of_node = dev_of_node(dev);
862 error = sysfs_create_link(&dev->kobj, &of_node->kobj,"of_node");
864 dev_warn(dev, "Error %d creating of_node link\n",error);
865 /* An error here doesn't warrant bringing down the device */
871 error = sysfs_create_link(&dev->kobj,
872 &dev->class->p->subsys.kobj,
877 if (dev->parent && device_is_not_partition(dev)) {
878 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
885 /* /sys/block has directories and does not need symlinks */
886 if (sysfs_deprecated && dev->class == &block_class)
890 /* link in the class directory pointing to the device */
891 error = sysfs_create_link(&dev->class->p->subsys.kobj,
892 &dev->kobj, dev_name(dev));
899 sysfs_remove_link(&dev->kobj, "device");
902 sysfs_remove_link(&dev->kobj, "subsystem");
904 sysfs_remove_link(&dev->kobj, "of_node");
908 static void device_remove_class_symlinks(struct device *dev)
910 if (dev_of_node(dev))
911 sysfs_remove_link(&dev->kobj, "of_node");
916 if (dev->parent && device_is_not_partition(dev))
917 sysfs_remove_link(&dev->kobj, "device");
918 sysfs_remove_link(&dev->kobj, "subsystem");
920 if (sysfs_deprecated && dev->class == &block_class)
923 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
927 * dev_set_name - set a device name
929 * @fmt: format string for the device's name
931 int dev_set_name(struct device *dev, const char *fmt, ...)
936 va_start(vargs, fmt);
937 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
941 EXPORT_SYMBOL_GPL(dev_set_name);
944 * device_to_dev_kobj - select a /sys/dev/ directory for the device
947 * By default we select char/ for new entries. Setting class->dev_obj
948 * to NULL prevents an entry from being created. class->dev_kobj must
949 * be set (or cleared) before any devices are registered to the class
950 * otherwise device_create_sys_dev_entry() and
951 * device_remove_sys_dev_entry() will disagree about the presence of
954 static struct kobject *device_to_dev_kobj(struct device *dev)
956 struct kobject *kobj;
959 kobj = dev->class->dev_kobj;
961 kobj = sysfs_dev_char_kobj;
966 static int device_create_sys_dev_entry(struct device *dev)
968 struct kobject *kobj = device_to_dev_kobj(dev);
973 format_dev_t(devt_str, dev->devt);
974 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
980 static void device_remove_sys_dev_entry(struct device *dev)
982 struct kobject *kobj = device_to_dev_kobj(dev);
986 format_dev_t(devt_str, dev->devt);
987 sysfs_remove_link(kobj, devt_str);
991 int device_private_init(struct device *dev)
993 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
996 dev->p->device = dev;
997 klist_init(&dev->p->klist_children, klist_children_get,
999 INIT_LIST_HEAD(&dev->p->deferred_probe);
1004 * device_add - add device to device hierarchy.
1007 * This is part 2 of device_register(), though may be called
1008 * separately _iff_ device_initialize() has been called separately.
1010 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
1011 * to the global and sibling lists for the device, then
1012 * adds it to the other relevant subsystems of the driver model.
1014 * Do not call this routine or device_register() more than once for
1015 * any device structure. The driver model core is not designed to work
1016 * with devices that get unregistered and then spring back to life.
1017 * (Among other things, it's very hard to guarantee that all references
1018 * to the previous incarnation of @dev have been dropped.) Allocate
1019 * and register a fresh new struct device instead.
1021 * NOTE: _Never_ directly free @dev after calling this function, even
1022 * if it returned an error! Always use put_device() to give up your
1023 * reference instead.
1025 int device_add(struct device *dev)
1027 struct device *parent = NULL;
1028 struct kobject *kobj;
1029 struct class_interface *class_intf;
1030 int error = -EINVAL;
1032 dev = get_device(dev);
1037 error = device_private_init(dev);
1043 * for statically allocated devices, which should all be converted
1044 * some day, we need to initialize the name. We prevent reading back
1045 * the name, and force the use of dev_name()
1047 if (dev->init_name) {
1048 dev_set_name(dev, "%s", dev->init_name);
1049 dev->init_name = NULL;
1052 /* subsystems can specify simple device enumeration */
1053 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
1054 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
1056 if (!dev_name(dev)) {
1061 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1063 parent = get_device(dev->parent);
1064 kobj = get_device_parent(dev, parent);
1066 dev->kobj.parent = kobj;
1068 /* use parent numa_node */
1069 if (parent && (dev_to_node(dev) == NUMA_NO_NODE))
1070 set_dev_node(dev, dev_to_node(parent));
1072 /* first, register with generic layer. */
1073 /* we require the name to be set before, and pass NULL */
1074 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
1078 /* notify platform of device entry */
1079 if (platform_notify)
1080 platform_notify(dev);
1082 error = device_create_file(dev, &dev_attr_uevent);
1086 error = device_add_class_symlinks(dev);
1089 error = device_add_attrs(dev);
1092 error = bus_add_device(dev);
1095 error = dpm_sysfs_add(dev);
1100 if (MAJOR(dev->devt)) {
1101 error = device_create_file(dev, &dev_attr_dev);
1105 error = device_create_sys_dev_entry(dev);
1109 devtmpfs_create_node(dev);
1112 /* Notify clients of device addition. This call must come
1113 * after dpm_sysfs_add() and before kobject_uevent().
1116 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1117 BUS_NOTIFY_ADD_DEVICE, dev);
1119 kobject_uevent(&dev->kobj, KOBJ_ADD);
1120 bus_probe_device(dev);
1122 klist_add_tail(&dev->p->knode_parent,
1123 &parent->p->klist_children);
1126 mutex_lock(&dev->class->p->mutex);
1127 /* tie the class to the device */
1128 klist_add_tail(&dev->knode_class,
1129 &dev->class->p->klist_devices);
1131 /* notify any interfaces that the device is here */
1132 list_for_each_entry(class_intf,
1133 &dev->class->p->interfaces, node)
1134 if (class_intf->add_dev)
1135 class_intf->add_dev(dev, class_intf);
1136 mutex_unlock(&dev->class->p->mutex);
1142 if (MAJOR(dev->devt))
1143 device_remove_file(dev, &dev_attr_dev);
1145 device_pm_remove(dev);
1146 dpm_sysfs_remove(dev);
1148 bus_remove_device(dev);
1150 device_remove_attrs(dev);
1152 device_remove_class_symlinks(dev);
1154 device_remove_file(dev, &dev_attr_uevent);
1156 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1157 kobject_del(&dev->kobj);
1159 cleanup_device_parent(dev);
1166 EXPORT_SYMBOL_GPL(device_add);
1169 * device_register - register a device with the system.
1170 * @dev: pointer to the device structure
1172 * This happens in two clean steps - initialize the device
1173 * and add it to the system. The two steps can be called
1174 * separately, but this is the easiest and most common.
1175 * I.e. you should only call the two helpers separately if
1176 * have a clearly defined need to use and refcount the device
1177 * before it is added to the hierarchy.
1179 * For more information, see the kerneldoc for device_initialize()
1182 * NOTE: _Never_ directly free @dev after calling this function, even
1183 * if it returned an error! Always use put_device() to give up the
1184 * reference initialized in this function instead.
1186 int device_register(struct device *dev)
1188 device_initialize(dev);
1189 return device_add(dev);
1191 EXPORT_SYMBOL_GPL(device_register);
1194 * get_device - increment reference count for device.
1197 * This simply forwards the call to kobject_get(), though
1198 * we do take care to provide for the case that we get a NULL
1199 * pointer passed in.
1201 struct device *get_device(struct device *dev)
1203 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
1205 EXPORT_SYMBOL_GPL(get_device);
1208 * put_device - decrement reference count.
1209 * @dev: device in question.
1211 void put_device(struct device *dev)
1213 /* might_sleep(); */
1215 kobject_put(&dev->kobj);
1217 EXPORT_SYMBOL_GPL(put_device);
1220 * device_del - delete device from system.
1223 * This is the first part of the device unregistration
1224 * sequence. This removes the device from the lists we control
1225 * from here, has it removed from the other driver model
1226 * subsystems it was added to in device_add(), and removes it
1227 * from the kobject hierarchy.
1229 * NOTE: this should be called manually _iff_ device_add() was
1230 * also called manually.
1232 void device_del(struct device *dev)
1234 struct device *parent = dev->parent;
1235 struct class_interface *class_intf;
1237 /* Notify clients of device removal. This call must come
1238 * before dpm_sysfs_remove().
1241 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1242 BUS_NOTIFY_DEL_DEVICE, dev);
1243 dpm_sysfs_remove(dev);
1245 klist_del(&dev->p->knode_parent);
1246 if (MAJOR(dev->devt)) {
1247 devtmpfs_delete_node(dev);
1248 device_remove_sys_dev_entry(dev);
1249 device_remove_file(dev, &dev_attr_dev);
1252 device_remove_class_symlinks(dev);
1254 mutex_lock(&dev->class->p->mutex);
1255 /* notify any interfaces that the device is now gone */
1256 list_for_each_entry(class_intf,
1257 &dev->class->p->interfaces, node)
1258 if (class_intf->remove_dev)
1259 class_intf->remove_dev(dev, class_intf);
1260 /* remove the device from the class list */
1261 klist_del(&dev->knode_class);
1262 mutex_unlock(&dev->class->p->mutex);
1264 device_remove_file(dev, &dev_attr_uevent);
1265 device_remove_attrs(dev);
1266 bus_remove_device(dev);
1267 device_pm_remove(dev);
1268 driver_deferred_probe_del(dev);
1270 /* Notify the platform of the removal, in case they
1271 * need to do anything...
1273 if (platform_notify_remove)
1274 platform_notify_remove(dev);
1276 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1277 BUS_NOTIFY_REMOVED_DEVICE, dev);
1278 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1279 cleanup_device_parent(dev);
1280 kobject_del(&dev->kobj);
1283 EXPORT_SYMBOL_GPL(device_del);
1286 * device_unregister - unregister device from system.
1287 * @dev: device going away.
1289 * We do this in two parts, like we do device_register(). First,
1290 * we remove it from all the subsystems with device_del(), then
1291 * we decrement the reference count via put_device(). If that
1292 * is the final reference count, the device will be cleaned up
1293 * via device_release() above. Otherwise, the structure will
1294 * stick around until the final reference to the device is dropped.
1296 void device_unregister(struct device *dev)
1298 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1302 EXPORT_SYMBOL_GPL(device_unregister);
1304 static struct device *prev_device(struct klist_iter *i)
1306 struct klist_node *n = klist_prev(i);
1307 struct device *dev = NULL;
1308 struct device_private *p;
1311 p = to_device_private_parent(n);
1317 static struct device *next_device(struct klist_iter *i)
1319 struct klist_node *n = klist_next(i);
1320 struct device *dev = NULL;
1321 struct device_private *p;
1324 p = to_device_private_parent(n);
1331 * device_get_devnode - path of device node file
1333 * @mode: returned file access mode
1334 * @uid: returned file owner
1335 * @gid: returned file group
1336 * @tmp: possibly allocated string
1338 * Return the relative path of a possible device node.
1339 * Non-default names may need to allocate a memory to compose
1340 * a name. This memory is returned in tmp and needs to be
1341 * freed by the caller.
1343 const char *device_get_devnode(struct device *dev,
1344 umode_t *mode, kuid_t *uid, kgid_t *gid,
1351 /* the device type may provide a specific name */
1352 if (dev->type && dev->type->devnode)
1353 *tmp = dev->type->devnode(dev, mode, uid, gid);
1357 /* the class may provide a specific name */
1358 if (dev->class && dev->class->devnode)
1359 *tmp = dev->class->devnode(dev, mode);
1363 /* return name without allocation, tmp == NULL */
1364 if (strchr(dev_name(dev), '!') == NULL)
1365 return dev_name(dev);
1367 /* replace '!' in the name with '/' */
1368 s = kstrdup(dev_name(dev), GFP_KERNEL);
1371 strreplace(s, '!', '/');
1376 * device_for_each_child - device child iterator.
1377 * @parent: parent struct device.
1378 * @fn: function to be called for each device.
1379 * @data: data for the callback.
1381 * Iterate over @parent's child devices, and call @fn for each,
1384 * We check the return of @fn each time. If it returns anything
1385 * other than 0, we break out and return that value.
1387 int device_for_each_child(struct device *parent, void *data,
1388 int (*fn)(struct device *dev, void *data))
1390 struct klist_iter i;
1391 struct device *child;
1397 klist_iter_init(&parent->p->klist_children, &i);
1398 while ((child = next_device(&i)) && !error)
1399 error = fn(child, data);
1400 klist_iter_exit(&i);
1403 EXPORT_SYMBOL_GPL(device_for_each_child);
1406 * device_for_each_child_reverse - device child iterator in reversed order.
1407 * @parent: parent struct device.
1408 * @fn: function to be called for each device.
1409 * @data: data for the callback.
1411 * Iterate over @parent's child devices, and call @fn for each,
1414 * We check the return of @fn each time. If it returns anything
1415 * other than 0, we break out and return that value.
1417 int device_for_each_child_reverse(struct device *parent, void *data,
1418 int (*fn)(struct device *dev, void *data))
1420 struct klist_iter i;
1421 struct device *child;
1427 klist_iter_init(&parent->p->klist_children, &i);
1428 while ((child = prev_device(&i)) && !error)
1429 error = fn(child, data);
1430 klist_iter_exit(&i);
1433 EXPORT_SYMBOL_GPL(device_for_each_child_reverse);
1436 * device_find_child - device iterator for locating a particular device.
1437 * @parent: parent struct device
1438 * @match: Callback function to check device
1439 * @data: Data to pass to match function
1441 * This is similar to the device_for_each_child() function above, but it
1442 * returns a reference to a device that is 'found' for later use, as
1443 * determined by the @match callback.
1445 * The callback should return 0 if the device doesn't match and non-zero
1446 * if it does. If the callback returns non-zero and a reference to the
1447 * current device can be obtained, this function will return to the caller
1448 * and not iterate over any more devices.
1450 * NOTE: you will need to drop the reference with put_device() after use.
1452 struct device *device_find_child(struct device *parent, void *data,
1453 int (*match)(struct device *dev, void *data))
1455 struct klist_iter i;
1456 struct device *child;
1461 klist_iter_init(&parent->p->klist_children, &i);
1462 while ((child = next_device(&i)))
1463 if (match(child, data) && get_device(child))
1465 klist_iter_exit(&i);
1468 EXPORT_SYMBOL_GPL(device_find_child);
1470 int __init devices_init(void)
1472 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1475 dev_kobj = kobject_create_and_add("dev", NULL);
1478 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1479 if (!sysfs_dev_block_kobj)
1480 goto block_kobj_err;
1481 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1482 if (!sysfs_dev_char_kobj)
1488 kobject_put(sysfs_dev_block_kobj);
1490 kobject_put(dev_kobj);
1492 kset_unregister(devices_kset);
1496 static int device_check_offline(struct device *dev, void *not_used)
1500 ret = device_for_each_child(dev, NULL, device_check_offline);
1504 return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
1508 * device_offline - Prepare the device for hot-removal.
1509 * @dev: Device to be put offline.
1511 * Execute the device bus type's .offline() callback, if present, to prepare
1512 * the device for a subsequent hot-removal. If that succeeds, the device must
1513 * not be used until either it is removed or its bus type's .online() callback
1516 * Call under device_hotplug_lock.
1518 int device_offline(struct device *dev)
1522 if (dev->offline_disabled)
1525 ret = device_for_each_child(dev, NULL, device_check_offline);
1530 if (device_supports_offline(dev)) {
1534 ret = dev->bus->offline(dev);
1536 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
1537 dev->offline = true;
1547 * device_online - Put the device back online after successful device_offline().
1548 * @dev: Device to be put back online.
1550 * If device_offline() has been successfully executed for @dev, but the device
1551 * has not been removed subsequently, execute its bus type's .online() callback
1552 * to indicate that the device can be used again.
1554 * Call under device_hotplug_lock.
1556 int device_online(struct device *dev)
1561 if (device_supports_offline(dev)) {
1563 ret = dev->bus->online(dev);
1565 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
1566 dev->offline = false;
1577 struct root_device {
1579 struct module *owner;
1582 static inline struct root_device *to_root_device(struct device *d)
1584 return container_of(d, struct root_device, dev);
1587 static void root_device_release(struct device *dev)
1589 kfree(to_root_device(dev));
1593 * __root_device_register - allocate and register a root device
1594 * @name: root device name
1595 * @owner: owner module of the root device, usually THIS_MODULE
1597 * This function allocates a root device and registers it
1598 * using device_register(). In order to free the returned
1599 * device, use root_device_unregister().
1601 * Root devices are dummy devices which allow other devices
1602 * to be grouped under /sys/devices. Use this function to
1603 * allocate a root device and then use it as the parent of
1604 * any device which should appear under /sys/devices/{name}
1606 * The /sys/devices/{name} directory will also contain a
1607 * 'module' symlink which points to the @owner directory
1610 * Returns &struct device pointer on success, or ERR_PTR() on error.
1612 * Note: You probably want to use root_device_register().
1614 struct device *__root_device_register(const char *name, struct module *owner)
1616 struct root_device *root;
1619 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1621 return ERR_PTR(err);
1623 err = dev_set_name(&root->dev, "%s", name);
1626 return ERR_PTR(err);
1629 root->dev.release = root_device_release;
1631 err = device_register(&root->dev);
1633 put_device(&root->dev);
1634 return ERR_PTR(err);
1637 #ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
1639 struct module_kobject *mk = &owner->mkobj;
1641 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1643 device_unregister(&root->dev);
1644 return ERR_PTR(err);
1646 root->owner = owner;
1652 EXPORT_SYMBOL_GPL(__root_device_register);
1655 * root_device_unregister - unregister and free a root device
1656 * @dev: device going away
1658 * This function unregisters and cleans up a device that was created by
1659 * root_device_register().
1661 void root_device_unregister(struct device *dev)
1663 struct root_device *root = to_root_device(dev);
1666 sysfs_remove_link(&root->dev.kobj, "module");
1668 device_unregister(dev);
1670 EXPORT_SYMBOL_GPL(root_device_unregister);
1673 static void device_create_release(struct device *dev)
1675 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1679 static struct device *
1680 device_create_groups_vargs(struct class *class, struct device *parent,
1681 dev_t devt, void *drvdata,
1682 const struct attribute_group **groups,
1683 const char *fmt, va_list args)
1685 struct device *dev = NULL;
1686 int retval = -ENODEV;
1688 if (class == NULL || IS_ERR(class))
1691 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1697 device_initialize(dev);
1700 dev->parent = parent;
1701 dev->groups = groups;
1702 dev->release = device_create_release;
1703 dev_set_drvdata(dev, drvdata);
1705 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1709 retval = device_add(dev);
1717 return ERR_PTR(retval);
1721 * device_create_vargs - creates a device and registers it with sysfs
1722 * @class: pointer to the struct class that this device should be registered to
1723 * @parent: pointer to the parent struct device of this new device, if any
1724 * @devt: the dev_t for the char device to be added
1725 * @drvdata: the data to be added to the device for callbacks
1726 * @fmt: string for the device's name
1727 * @args: va_list for the device's name
1729 * This function can be used by char device classes. A struct device
1730 * will be created in sysfs, registered to the specified class.
1732 * A "dev" file will be created, showing the dev_t for the device, if
1733 * the dev_t is not 0,0.
1734 * If a pointer to a parent struct device is passed in, the newly created
1735 * struct device will be a child of that device in sysfs.
1736 * The pointer to the struct device will be returned from the call.
1737 * Any further sysfs files that might be required can be created using this
1740 * Returns &struct device pointer on success, or ERR_PTR() on error.
1742 * Note: the struct class passed to this function must have previously
1743 * been created with a call to class_create().
1745 struct device *device_create_vargs(struct class *class, struct device *parent,
1746 dev_t devt, void *drvdata, const char *fmt,
1749 return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
1752 EXPORT_SYMBOL_GPL(device_create_vargs);
1755 * device_create - creates a device and registers it with sysfs
1756 * @class: pointer to the struct class that this device should be registered to
1757 * @parent: pointer to the parent struct device of this new device, if any
1758 * @devt: the dev_t for the char device to be added
1759 * @drvdata: the data to be added to the device for callbacks
1760 * @fmt: string for the device's name
1762 * This function can be used by char device classes. A struct device
1763 * will be created in sysfs, registered to the specified class.
1765 * A "dev" file will be created, showing the dev_t for the device, if
1766 * the dev_t is not 0,0.
1767 * If a pointer to a parent struct device is passed in, the newly created
1768 * struct device will be a child of that device in sysfs.
1769 * The pointer to the struct device will be returned from the call.
1770 * Any further sysfs files that might be required can be created using this
1773 * Returns &struct device pointer on success, or ERR_PTR() on error.
1775 * Note: the struct class passed to this function must have previously
1776 * been created with a call to class_create().
1778 struct device *device_create(struct class *class, struct device *parent,
1779 dev_t devt, void *drvdata, const char *fmt, ...)
1784 va_start(vargs, fmt);
1785 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1789 EXPORT_SYMBOL_GPL(device_create);
1792 * device_create_with_groups - creates a device and registers it with sysfs
1793 * @class: pointer to the struct class that this device should be registered to
1794 * @parent: pointer to the parent struct device of this new device, if any
1795 * @devt: the dev_t for the char device to be added
1796 * @drvdata: the data to be added to the device for callbacks
1797 * @groups: NULL-terminated list of attribute groups to be created
1798 * @fmt: string for the device's name
1800 * This function can be used by char device classes. A struct device
1801 * will be created in sysfs, registered to the specified class.
1802 * Additional attributes specified in the groups parameter will also
1803 * be created automatically.
1805 * A "dev" file will be created, showing the dev_t for the device, if
1806 * the dev_t is not 0,0.
1807 * If a pointer to a parent struct device is passed in, the newly created
1808 * struct device will be a child of that device in sysfs.
1809 * The pointer to the struct device will be returned from the call.
1810 * Any further sysfs files that might be required can be created using this
1813 * Returns &struct device pointer on success, or ERR_PTR() on error.
1815 * Note: the struct class passed to this function must have previously
1816 * been created with a call to class_create().
1818 struct device *device_create_with_groups(struct class *class,
1819 struct device *parent, dev_t devt,
1821 const struct attribute_group **groups,
1822 const char *fmt, ...)
1827 va_start(vargs, fmt);
1828 dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
1833 EXPORT_SYMBOL_GPL(device_create_with_groups);
1835 static int __match_devt(struct device *dev, const void *data)
1837 const dev_t *devt = data;
1839 return dev->devt == *devt;
1843 * device_destroy - removes a device that was created with device_create()
1844 * @class: pointer to the struct class that this device was registered with
1845 * @devt: the dev_t of the device that was previously registered
1847 * This call unregisters and cleans up a device that was created with a
1848 * call to device_create().
1850 void device_destroy(struct class *class, dev_t devt)
1854 dev = class_find_device(class, NULL, &devt, __match_devt);
1857 device_unregister(dev);
1860 EXPORT_SYMBOL_GPL(device_destroy);
1863 * device_rename - renames a device
1864 * @dev: the pointer to the struct device to be renamed
1865 * @new_name: the new name of the device
1867 * It is the responsibility of the caller to provide mutual
1868 * exclusion between two different calls of device_rename
1869 * on the same device to ensure that new_name is valid and
1870 * won't conflict with other devices.
1872 * Note: Don't call this function. Currently, the networking layer calls this
1873 * function, but that will change. The following text from Kay Sievers offers
1876 * Renaming devices is racy at many levels, symlinks and other stuff are not
1877 * replaced atomically, and you get a "move" uevent, but it's not easy to
1878 * connect the event to the old and new device. Device nodes are not renamed at
1879 * all, there isn't even support for that in the kernel now.
1881 * In the meantime, during renaming, your target name might be taken by another
1882 * driver, creating conflicts. Or the old name is taken directly after you
1883 * renamed it -- then you get events for the same DEVPATH, before you even see
1884 * the "move" event. It's just a mess, and nothing new should ever rely on
1885 * kernel device renaming. Besides that, it's not even implemented now for
1886 * other things than (driver-core wise very simple) network devices.
1888 * We are currently about to change network renaming in udev to completely
1889 * disallow renaming of devices in the same namespace as the kernel uses,
1890 * because we can't solve the problems properly, that arise with swapping names
1891 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1892 * be allowed to some other name than eth[0-9]*, for the aforementioned
1895 * Make up a "real" name in the driver before you register anything, or add
1896 * some other attributes for userspace to find the device, or use udev to add
1897 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1898 * don't even want to get into that and try to implement the missing pieces in
1899 * the core. We really have other pieces to fix in the driver core mess. :)
1901 int device_rename(struct device *dev, const char *new_name)
1903 struct kobject *kobj = &dev->kobj;
1904 char *old_device_name = NULL;
1907 dev = get_device(dev);
1911 dev_dbg(dev, "renaming to %s\n", new_name);
1913 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
1914 if (!old_device_name) {
1920 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
1921 kobj, old_device_name,
1922 new_name, kobject_namespace(kobj));
1927 error = kobject_rename(kobj, new_name);
1934 kfree(old_device_name);
1938 EXPORT_SYMBOL_GPL(device_rename);
1940 static int device_move_class_links(struct device *dev,
1941 struct device *old_parent,
1942 struct device *new_parent)
1947 sysfs_remove_link(&dev->kobj, "device");
1949 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1955 * device_move - moves a device to a new parent
1956 * @dev: the pointer to the struct device to be moved
1957 * @new_parent: the new parent of the device (can by NULL)
1958 * @dpm_order: how to reorder the dpm_list
1960 int device_move(struct device *dev, struct device *new_parent,
1961 enum dpm_order dpm_order)
1964 struct device *old_parent;
1965 struct kobject *new_parent_kobj;
1967 dev = get_device(dev);
1972 new_parent = get_device(new_parent);
1973 new_parent_kobj = get_device_parent(dev, new_parent);
1975 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1976 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
1977 error = kobject_move(&dev->kobj, new_parent_kobj);
1979 cleanup_glue_dir(dev, new_parent_kobj);
1980 put_device(new_parent);
1983 old_parent = dev->parent;
1984 dev->parent = new_parent;
1986 klist_remove(&dev->p->knode_parent);
1988 klist_add_tail(&dev->p->knode_parent,
1989 &new_parent->p->klist_children);
1990 set_dev_node(dev, dev_to_node(new_parent));
1994 error = device_move_class_links(dev, old_parent, new_parent);
1996 /* We ignore errors on cleanup since we're hosed anyway... */
1997 device_move_class_links(dev, new_parent, old_parent);
1998 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
2000 klist_remove(&dev->p->knode_parent);
2001 dev->parent = old_parent;
2003 klist_add_tail(&dev->p->knode_parent,
2004 &old_parent->p->klist_children);
2005 set_dev_node(dev, dev_to_node(old_parent));
2008 cleanup_glue_dir(dev, new_parent_kobj);
2009 put_device(new_parent);
2013 switch (dpm_order) {
2014 case DPM_ORDER_NONE:
2016 case DPM_ORDER_DEV_AFTER_PARENT:
2017 device_pm_move_after(dev, new_parent);
2018 devices_kset_move_after(dev, new_parent);
2020 case DPM_ORDER_PARENT_BEFORE_DEV:
2021 device_pm_move_before(new_parent, dev);
2022 devices_kset_move_before(new_parent, dev);
2024 case DPM_ORDER_DEV_LAST:
2025 device_pm_move_last(dev);
2026 devices_kset_move_last(dev);
2030 put_device(old_parent);
2036 EXPORT_SYMBOL_GPL(device_move);
2039 * device_shutdown - call ->shutdown() on each device to shutdown.
2041 void device_shutdown(void)
2043 struct device *dev, *parent;
2045 spin_lock(&devices_kset->list_lock);
2047 * Walk the devices list backward, shutting down each in turn.
2048 * Beware that device unplug events may also start pulling
2049 * devices offline, even as the system is shutting down.
2051 while (!list_empty(&devices_kset->list)) {
2052 dev = list_entry(devices_kset->list.prev, struct device,
2056 * hold reference count of device's parent to
2057 * prevent it from being freed because parent's
2058 * lock is to be held
2060 parent = get_device(dev->parent);
2063 * Make sure the device is off the kset list, in the
2064 * event that dev->*->shutdown() doesn't remove it.
2066 list_del_init(&dev->kobj.entry);
2067 spin_unlock(&devices_kset->list_lock);
2069 /* hold lock to avoid race with probe/release */
2071 device_lock(parent);
2074 /* Don't allow any more runtime suspends */
2075 pm_runtime_get_noresume(dev);
2076 pm_runtime_barrier(dev);
2078 if (dev->bus && dev->bus->shutdown) {
2080 dev_info(dev, "shutdown\n");
2081 dev->bus->shutdown(dev);
2082 } else if (dev->driver && dev->driver->shutdown) {
2084 dev_info(dev, "shutdown\n");
2085 dev->driver->shutdown(dev);
2090 device_unlock(parent);
2095 spin_lock(&devices_kset->list_lock);
2097 spin_unlock(&devices_kset->list_lock);
2101 * Device logging functions
2104 #ifdef CONFIG_PRINTK
2106 create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
2112 subsys = dev->class->name;
2114 subsys = dev->bus->name;
2118 pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
2123 * Add device identifier DEVICE=:
2127 * +sound:card0 subsystem:devname
2129 if (MAJOR(dev->devt)) {
2132 if (strcmp(subsys, "block") == 0)
2137 pos += snprintf(hdr + pos, hdrlen - pos,
2139 c, MAJOR(dev->devt), MINOR(dev->devt));
2140 } else if (strcmp(subsys, "net") == 0) {
2141 struct net_device *net = to_net_dev(dev);
2144 pos += snprintf(hdr + pos, hdrlen - pos,
2145 "DEVICE=n%u", net->ifindex);
2148 pos += snprintf(hdr + pos, hdrlen - pos,
2149 "DEVICE=+%s:%s", subsys, dev_name(dev));
2158 dev_WARN(dev, "device/subsystem name too long");
2162 int dev_vprintk_emit(int level, const struct device *dev,
2163 const char *fmt, va_list args)
2168 hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
2170 return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
2172 EXPORT_SYMBOL(dev_vprintk_emit);
2174 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
2179 va_start(args, fmt);
2181 r = dev_vprintk_emit(level, dev, fmt, args);
2187 EXPORT_SYMBOL(dev_printk_emit);
2189 static void __dev_printk(const char *level, const struct device *dev,
2190 struct va_format *vaf)
2193 dev_printk_emit(level[1] - '0', dev, "%s %s: %pV",
2194 dev_driver_string(dev), dev_name(dev), vaf);
2196 printk("%s(NULL device *): %pV", level, vaf);
2199 void dev_printk(const char *level, const struct device *dev,
2200 const char *fmt, ...)
2202 struct va_format vaf;
2205 va_start(args, fmt);
2210 __dev_printk(level, dev, &vaf);
2214 EXPORT_SYMBOL(dev_printk);
2216 #define define_dev_printk_level(func, kern_level) \
2217 void func(const struct device *dev, const char *fmt, ...) \
2219 struct va_format vaf; \
2222 va_start(args, fmt); \
2227 __dev_printk(kern_level, dev, &vaf); \
2231 EXPORT_SYMBOL(func);
2233 define_dev_printk_level(dev_emerg, KERN_EMERG);
2234 define_dev_printk_level(dev_alert, KERN_ALERT);
2235 define_dev_printk_level(dev_crit, KERN_CRIT);
2236 define_dev_printk_level(dev_err, KERN_ERR);
2237 define_dev_printk_level(dev_warn, KERN_WARNING);
2238 define_dev_printk_level(dev_notice, KERN_NOTICE);
2239 define_dev_printk_level(_dev_info, KERN_INFO);
2243 static inline bool fwnode_is_primary(struct fwnode_handle *fwnode)
2245 return fwnode && !IS_ERR(fwnode->secondary);
2249 * set_primary_fwnode - Change the primary firmware node of a given device.
2250 * @dev: Device to handle.
2251 * @fwnode: New primary firmware node of the device.
2253 * Set the device's firmware node pointer to @fwnode, but if a secondary
2254 * firmware node of the device is present, preserve it.
2256 void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2259 struct fwnode_handle *fn = dev->fwnode;
2261 if (fwnode_is_primary(fn))
2265 WARN_ON(fwnode->secondary);
2266 fwnode->secondary = fn;
2268 dev->fwnode = fwnode;
2270 dev->fwnode = fwnode_is_primary(dev->fwnode) ?
2271 dev->fwnode->secondary : NULL;
2274 EXPORT_SYMBOL_GPL(set_primary_fwnode);
2277 * set_secondary_fwnode - Change the secondary firmware node of a given device.
2278 * @dev: Device to handle.
2279 * @fwnode: New secondary firmware node of the device.
2281 * If a primary firmware node of the device is present, set its secondary
2282 * pointer to @fwnode. Otherwise, set the device's firmware node pointer to
2285 void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
2288 fwnode->secondary = ERR_PTR(-ENODEV);
2290 if (fwnode_is_primary(dev->fwnode))
2291 dev->fwnode->secondary = fwnode;
2293 dev->fwnode = fwnode;