2 * drivers/base/core.c - core driver model code (device registration, etc)
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
6 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2006 Novell, Inc.
9 * This file is released under the GPLv2
13 #include <linux/device.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/slab.h>
18 #include <linux/string.h>
19 #include <linux/kdev_t.h>
20 #include <linux/notifier.h>
21 #include <linux/genhd.h>
22 #include <linux/kallsyms.h>
23 #include <linux/semaphore.h>
24 #include <linux/mutex.h>
27 #include "power/power.h"
29 int (*platform_notify)(struct device *dev) = NULL;
30 int (*platform_notify_remove)(struct device *dev) = NULL;
31 static struct kobject *dev_kobj;
32 struct kobject *sysfs_dev_char_kobj;
33 struct kobject *sysfs_dev_block_kobj;
36 static inline int device_is_not_partition(struct device *dev)
38 return !(dev->type == &part_type);
41 static inline int device_is_not_partition(struct device *dev)
48 * dev_driver_string - Return a device's driver name, if at all possible
49 * @dev: struct device to get the name of
51 * Will return the device's driver's name if it is bound to a device. If
52 * the device is not bound to a device, it will return the name of the bus
53 * it is attached to. If it is not attached to a bus either, an empty
54 * string will be returned.
56 const char *dev_driver_string(const struct device *dev)
58 return dev->driver ? dev->driver->name :
59 (dev->bus ? dev->bus->name :
60 (dev->class ? dev->class->name : ""));
62 EXPORT_SYMBOL(dev_driver_string);
64 #define to_dev(obj) container_of(obj, struct device, kobj)
65 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
67 static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
70 struct device_attribute *dev_attr = to_dev_attr(attr);
71 struct device *dev = to_dev(kobj);
75 ret = dev_attr->show(dev, dev_attr, buf);
76 if (ret >= (ssize_t)PAGE_SIZE) {
77 print_symbol("dev_attr_show: %s returned bad count\n",
78 (unsigned long)dev_attr->show);
83 static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
84 const char *buf, size_t count)
86 struct device_attribute *dev_attr = to_dev_attr(attr);
87 struct device *dev = to_dev(kobj);
91 ret = dev_attr->store(dev, dev_attr, buf, count);
95 static struct sysfs_ops dev_sysfs_ops = {
96 .show = dev_attr_show,
97 .store = dev_attr_store,
102 * device_release - free device structure.
103 * @kobj: device's kobject.
105 * This is called once the reference count for the object
106 * reaches 0. We forward the call to the device's release
107 * method, which should handle actually freeing the structure.
109 static void device_release(struct kobject *kobj)
111 struct device *dev = to_dev(kobj);
112 struct device_private *p = dev->p;
116 else if (dev->type && dev->type->release)
117 dev->type->release(dev);
118 else if (dev->class && dev->class->dev_release)
119 dev->class->dev_release(dev);
121 WARN(1, KERN_ERR "Device '%s' does not have a release() "
122 "function, it is broken and must be fixed.\n",
127 static struct kobj_type device_ktype = {
128 .release = device_release,
129 .sysfs_ops = &dev_sysfs_ops,
133 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
135 struct kobj_type *ktype = get_ktype(kobj);
137 if (ktype == &device_ktype) {
138 struct device *dev = to_dev(kobj);
147 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
149 struct device *dev = to_dev(kobj);
152 return dev->bus->name;
154 return dev->class->name;
158 static int dev_uevent(struct kset *kset, struct kobject *kobj,
159 struct kobj_uevent_env *env)
161 struct device *dev = to_dev(kobj);
164 /* add the major/minor if present */
165 if (MAJOR(dev->devt)) {
166 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
167 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
170 if (dev->type && dev->type->name)
171 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
174 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
176 #ifdef CONFIG_SYSFS_DEPRECATED
178 struct device *parent = dev->parent;
180 /* find first bus device in parent chain */
181 while (parent && !parent->bus)
182 parent = parent->parent;
183 if (parent && parent->bus) {
186 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
188 add_uevent_var(env, "PHYSDEVPATH=%s", path);
192 add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
195 add_uevent_var(env, "PHYSDEVDRIVER=%s",
196 parent->driver->name);
198 } else if (dev->bus) {
199 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
202 add_uevent_var(env, "PHYSDEVDRIVER=%s",
207 /* have the bus specific function add its stuff */
208 if (dev->bus && dev->bus->uevent) {
209 retval = dev->bus->uevent(dev, env);
211 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
212 dev_name(dev), __func__, retval);
215 /* have the class specific function add its stuff */
216 if (dev->class && dev->class->dev_uevent) {
217 retval = dev->class->dev_uevent(dev, env);
219 pr_debug("device: '%s': %s: class uevent() "
220 "returned %d\n", dev_name(dev),
224 /* have the device type specific fuction add its stuff */
225 if (dev->type && dev->type->uevent) {
226 retval = dev->type->uevent(dev, env);
228 pr_debug("device: '%s': %s: dev_type uevent() "
229 "returned %d\n", dev_name(dev),
236 static struct kset_uevent_ops device_uevent_ops = {
237 .filter = dev_uevent_filter,
238 .name = dev_uevent_name,
239 .uevent = dev_uevent,
242 static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
245 struct kobject *top_kobj;
247 struct kobj_uevent_env *env = NULL;
252 /* search the kset, the device belongs to */
253 top_kobj = &dev->kobj;
254 while (!top_kobj->kset && top_kobj->parent)
255 top_kobj = top_kobj->parent;
259 kset = top_kobj->kset;
260 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
264 if (kset->uevent_ops && kset->uevent_ops->filter)
265 if (!kset->uevent_ops->filter(kset, &dev->kobj))
268 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
272 /* let the kset specific function add its keys */
273 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
277 /* copy keys to file */
278 for (i = 0; i < env->envp_idx; i++)
279 count += sprintf(&buf[count], "%s\n", env->envp[i]);
285 static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
286 const char *buf, size_t count)
288 enum kobject_action action;
290 if (kobject_action_type(buf, count, &action) == 0) {
291 kobject_uevent(&dev->kobj, action);
295 dev_err(dev, "uevent: unsupported action-string; this will "
296 "be ignored in a future kernel version\n");
297 kobject_uevent(&dev->kobj, KOBJ_ADD);
302 static struct device_attribute uevent_attr =
303 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
305 static int device_add_attributes(struct device *dev,
306 struct device_attribute *attrs)
312 for (i = 0; attr_name(attrs[i]); i++) {
313 error = device_create_file(dev, &attrs[i]);
319 device_remove_file(dev, &attrs[i]);
324 static void device_remove_attributes(struct device *dev,
325 struct device_attribute *attrs)
330 for (i = 0; attr_name(attrs[i]); i++)
331 device_remove_file(dev, &attrs[i]);
334 static int device_add_groups(struct device *dev,
335 struct attribute_group **groups)
341 for (i = 0; groups[i]; i++) {
342 error = sysfs_create_group(&dev->kobj, groups[i]);
345 sysfs_remove_group(&dev->kobj,
354 static void device_remove_groups(struct device *dev,
355 struct attribute_group **groups)
360 for (i = 0; groups[i]; i++)
361 sysfs_remove_group(&dev->kobj, groups[i]);
364 static int device_add_attrs(struct device *dev)
366 struct class *class = dev->class;
367 struct device_type *type = dev->type;
371 error = device_add_attributes(dev, class->dev_attrs);
377 error = device_add_groups(dev, type->groups);
379 goto err_remove_class_attrs;
382 error = device_add_groups(dev, dev->groups);
384 goto err_remove_type_groups;
388 err_remove_type_groups:
390 device_remove_groups(dev, type->groups);
391 err_remove_class_attrs:
393 device_remove_attributes(dev, class->dev_attrs);
398 static void device_remove_attrs(struct device *dev)
400 struct class *class = dev->class;
401 struct device_type *type = dev->type;
403 device_remove_groups(dev, dev->groups);
406 device_remove_groups(dev, type->groups);
409 device_remove_attributes(dev, class->dev_attrs);
413 static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
416 return print_dev_t(buf, dev->devt);
419 static struct device_attribute devt_attr =
420 __ATTR(dev, S_IRUGO, show_dev, NULL);
422 /* kset to create /sys/devices/ */
423 struct kset *devices_kset;
426 * device_create_file - create sysfs attribute file for device.
428 * @attr: device attribute descriptor.
430 int device_create_file(struct device *dev, struct device_attribute *attr)
434 error = sysfs_create_file(&dev->kobj, &attr->attr);
439 * device_remove_file - remove sysfs attribute file.
441 * @attr: device attribute descriptor.
443 void device_remove_file(struct device *dev, struct device_attribute *attr)
446 sysfs_remove_file(&dev->kobj, &attr->attr);
450 * device_create_bin_file - create sysfs binary attribute file for device.
452 * @attr: device binary attribute descriptor.
454 int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
458 error = sysfs_create_bin_file(&dev->kobj, attr);
461 EXPORT_SYMBOL_GPL(device_create_bin_file);
464 * device_remove_bin_file - remove sysfs binary attribute file
466 * @attr: device binary attribute descriptor.
468 void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
471 sysfs_remove_bin_file(&dev->kobj, attr);
473 EXPORT_SYMBOL_GPL(device_remove_bin_file);
476 * device_schedule_callback_owner - helper to schedule a callback for a device
478 * @func: callback function to invoke later.
479 * @owner: module owning the callback routine
481 * Attribute methods must not unregister themselves or their parent device
482 * (which would amount to the same thing). Attempts to do so will deadlock,
483 * since unregistration is mutually exclusive with driver callbacks.
485 * Instead methods can call this routine, which will attempt to allocate
486 * and schedule a workqueue request to call back @func with @dev as its
487 * argument in the workqueue's process context. @dev will be pinned until
490 * This routine is usually called via the inline device_schedule_callback(),
491 * which automatically sets @owner to THIS_MODULE.
493 * Returns 0 if the request was submitted, -ENOMEM if storage could not
494 * be allocated, -ENODEV if a reference to @owner isn't available.
496 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
497 * underlying sysfs routine (since it is intended for use by attribute
498 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
500 int device_schedule_callback_owner(struct device *dev,
501 void (*func)(struct device *), struct module *owner)
503 return sysfs_schedule_callback(&dev->kobj,
504 (void (*)(void *)) func, dev, owner);
506 EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
508 static void klist_children_get(struct klist_node *n)
510 struct device_private *p = to_device_private_parent(n);
511 struct device *dev = p->device;
516 static void klist_children_put(struct klist_node *n)
518 struct device_private *p = to_device_private_parent(n);
519 struct device *dev = p->device;
525 * device_initialize - init device structure.
528 * This prepares the device for use by other layers by initializing
530 * It is the first half of device_register(), if called by
531 * that function, though it can also be called separately, so one
532 * may use @dev's fields. In particular, get_device()/put_device()
533 * may be used for reference counting of @dev after calling this
536 * NOTE: Use put_device() to give up your reference instead of freeing
537 * @dev directly once you have called this function.
539 void device_initialize(struct device *dev)
541 dev->kobj.kset = devices_kset;
542 kobject_init(&dev->kobj, &device_ktype);
543 INIT_LIST_HEAD(&dev->dma_pools);
544 init_MUTEX(&dev->sem);
545 spin_lock_init(&dev->devres_lock);
546 INIT_LIST_HEAD(&dev->devres_head);
547 device_init_wakeup(dev, 0);
549 set_dev_node(dev, -1);
552 #ifdef CONFIG_SYSFS_DEPRECATED
553 static struct kobject *get_device_parent(struct device *dev,
554 struct device *parent)
556 /* class devices without a parent live in /sys/class/<classname>/ */
557 if (dev->class && (!parent || parent->class != dev->class))
558 return &dev->class->p->class_subsys.kobj;
559 /* all other devices keep their parent */
561 return &parent->kobj;
566 static inline void cleanup_device_parent(struct device *dev) {}
567 static inline void cleanup_glue_dir(struct device *dev,
568 struct kobject *glue_dir) {}
570 static struct kobject *virtual_device_parent(struct device *dev)
572 static struct kobject *virtual_dir = NULL;
575 virtual_dir = kobject_create_and_add("virtual",
576 &devices_kset->kobj);
581 static struct kobject *get_device_parent(struct device *dev,
582 struct device *parent)
587 struct kobject *kobj = NULL;
588 struct kobject *parent_kobj;
592 * If we have no parent, we live in "virtual".
593 * Class-devices with a non class-device as parent, live
594 * in a "glue" directory to prevent namespace collisions.
597 parent_kobj = virtual_device_parent(dev);
598 else if (parent->class)
599 return &parent->kobj;
601 parent_kobj = &parent->kobj;
603 /* find our class-directory at the parent and reference it */
604 spin_lock(&dev->class->p->class_dirs.list_lock);
605 list_for_each_entry(k, &dev->class->p->class_dirs.list, entry)
606 if (k->parent == parent_kobj) {
607 kobj = kobject_get(k);
610 spin_unlock(&dev->class->p->class_dirs.list_lock);
614 /* or create a new class-directory at the parent device */
615 k = kobject_create();
618 k->kset = &dev->class->p->class_dirs;
619 retval = kobject_add(k, parent_kobj, "%s", dev->class->name);
624 /* do not emit an uevent for this simple "glue" directory */
629 return &parent->kobj;
633 static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
635 /* see if we live in a "glue" directory */
636 if (!glue_dir || !dev->class ||
637 glue_dir->kset != &dev->class->p->class_dirs)
640 kobject_put(glue_dir);
643 static void cleanup_device_parent(struct device *dev)
645 cleanup_glue_dir(dev, dev->kobj.parent);
649 static void setup_parent(struct device *dev, struct device *parent)
651 struct kobject *kobj;
652 kobj = get_device_parent(dev, parent);
654 dev->kobj.parent = kobj;
657 static int device_add_class_symlinks(struct device *dev)
664 error = sysfs_create_link(&dev->kobj,
665 &dev->class->p->class_subsys.kobj,
670 #ifdef CONFIG_SYSFS_DEPRECATED
671 /* stacked class devices need a symlink in the class directory */
672 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
673 device_is_not_partition(dev)) {
674 error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
675 &dev->kobj, dev_name(dev));
680 if (dev->parent && device_is_not_partition(dev)) {
681 struct device *parent = dev->parent;
685 * stacked class devices have the 'device' link
686 * pointing to the bus device instead of the parent
688 while (parent->class && !parent->bus && parent->parent)
689 parent = parent->parent;
691 error = sysfs_create_link(&dev->kobj,
697 class_name = make_class_name(dev->class->name,
700 error = sysfs_create_link(&dev->parent->kobj,
701 &dev->kobj, class_name);
709 if (dev->parent && device_is_not_partition(dev))
710 sysfs_remove_link(&dev->kobj, "device");
712 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
713 device_is_not_partition(dev))
714 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
717 /* link in the class directory pointing to the device */
718 error = sysfs_create_link(&dev->class->p->class_subsys.kobj,
719 &dev->kobj, dev_name(dev));
723 if (dev->parent && device_is_not_partition(dev)) {
724 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
732 sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev_name(dev));
736 sysfs_remove_link(&dev->kobj, "subsystem");
741 static void device_remove_class_symlinks(struct device *dev)
746 #ifdef CONFIG_SYSFS_DEPRECATED
747 if (dev->parent && device_is_not_partition(dev)) {
750 class_name = make_class_name(dev->class->name, &dev->kobj);
752 sysfs_remove_link(&dev->parent->kobj, class_name);
755 sysfs_remove_link(&dev->kobj, "device");
758 if (dev->kobj.parent != &dev->class->p->class_subsys.kobj &&
759 device_is_not_partition(dev))
760 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
763 if (dev->parent && device_is_not_partition(dev))
764 sysfs_remove_link(&dev->kobj, "device");
766 sysfs_remove_link(&dev->class->p->class_subsys.kobj, dev_name(dev));
769 sysfs_remove_link(&dev->kobj, "subsystem");
773 * dev_set_name - set a device name
775 * @fmt: format string for the device's name
777 int dev_set_name(struct device *dev, const char *fmt, ...)
782 va_start(vargs, fmt);
783 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
787 EXPORT_SYMBOL_GPL(dev_set_name);
790 * device_to_dev_kobj - select a /sys/dev/ directory for the device
793 * By default we select char/ for new entries. Setting class->dev_obj
794 * to NULL prevents an entry from being created. class->dev_kobj must
795 * be set (or cleared) before any devices are registered to the class
796 * otherwise device_create_sys_dev_entry() and
797 * device_remove_sys_dev_entry() will disagree about the the presence
800 static struct kobject *device_to_dev_kobj(struct device *dev)
802 struct kobject *kobj;
805 kobj = dev->class->dev_kobj;
807 kobj = sysfs_dev_char_kobj;
812 static int device_create_sys_dev_entry(struct device *dev)
814 struct kobject *kobj = device_to_dev_kobj(dev);
819 format_dev_t(devt_str, dev->devt);
820 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
826 static void device_remove_sys_dev_entry(struct device *dev)
828 struct kobject *kobj = device_to_dev_kobj(dev);
832 format_dev_t(devt_str, dev->devt);
833 sysfs_remove_link(kobj, devt_str);
838 * device_add - add device to device hierarchy.
841 * This is part 2 of device_register(), though may be called
842 * separately _iff_ device_initialize() has been called separately.
844 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
845 * to the global and sibling lists for the device, then
846 * adds it to the other relevant subsystems of the driver model.
848 * NOTE: _Never_ directly free @dev after calling this function, even
849 * if it returned an error! Always use put_device() to give up your
852 int device_add(struct device *dev)
854 struct device *parent = NULL;
855 struct class_interface *class_intf;
858 dev = get_device(dev);
862 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
867 dev->p->device = dev;
868 klist_init(&dev->p->klist_children, klist_children_get,
872 * for statically allocated devices, which should all be converted
873 * some day, we need to initialize the name. We prevent reading back
874 * the name, and force the use of dev_name()
876 if (dev->init_name) {
877 dev_set_name(dev, dev->init_name);
878 dev->init_name = NULL;
884 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
886 parent = get_device(dev->parent);
887 setup_parent(dev, parent);
889 /* use parent numa_node */
891 set_dev_node(dev, dev_to_node(parent));
893 /* first, register with generic layer. */
894 error = kobject_add(&dev->kobj, dev->kobj.parent, "%s", dev_name(dev));
898 /* notify platform of device entry */
900 platform_notify(dev);
902 error = device_create_file(dev, &uevent_attr);
906 if (MAJOR(dev->devt)) {
907 error = device_create_file(dev, &devt_attr);
909 goto ueventattrError;
911 error = device_create_sys_dev_entry(dev);
916 error = device_add_class_symlinks(dev);
919 error = device_add_attrs(dev);
922 error = bus_add_device(dev);
925 error = dpm_sysfs_add(dev);
930 /* Notify clients of device addition. This call must come
931 * after dpm_sysf_add() and before kobject_uevent().
934 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
935 BUS_NOTIFY_ADD_DEVICE, dev);
937 kobject_uevent(&dev->kobj, KOBJ_ADD);
938 bus_attach_device(dev);
940 klist_add_tail(&dev->p->knode_parent,
941 &parent->p->klist_children);
944 mutex_lock(&dev->class->p->class_mutex);
945 /* tie the class to the device */
946 klist_add_tail(&dev->knode_class,
947 &dev->class->p->class_devices);
949 /* notify any interfaces that the device is here */
950 list_for_each_entry(class_intf,
951 &dev->class->p->class_interfaces, node)
952 if (class_intf->add_dev)
953 class_intf->add_dev(dev, class_intf);
954 mutex_unlock(&dev->class->p->class_mutex);
960 bus_remove_device(dev);
962 device_remove_attrs(dev);
964 device_remove_class_symlinks(dev);
966 if (MAJOR(dev->devt))
967 device_remove_sys_dev_entry(dev);
969 if (MAJOR(dev->devt))
970 device_remove_file(dev, &devt_attr);
972 device_remove_file(dev, &uevent_attr);
974 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
975 kobject_del(&dev->kobj);
977 cleanup_device_parent(dev);
984 * device_register - register a device with the system.
985 * @dev: pointer to the device structure
987 * This happens in two clean steps - initialize the device
988 * and add it to the system. The two steps can be called
989 * separately, but this is the easiest and most common.
990 * I.e. you should only call the two helpers separately if
991 * have a clearly defined need to use and refcount the device
992 * before it is added to the hierarchy.
994 * NOTE: _Never_ directly free @dev after calling this function, even
995 * if it returned an error! Always use put_device() to give up the
996 * reference initialized in this function instead.
998 int device_register(struct device *dev)
1000 device_initialize(dev);
1001 return device_add(dev);
1005 * get_device - increment reference count for device.
1008 * This simply forwards the call to kobject_get(), though
1009 * we do take care to provide for the case that we get a NULL
1010 * pointer passed in.
1012 struct device *get_device(struct device *dev)
1014 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
1018 * put_device - decrement reference count.
1019 * @dev: device in question.
1021 void put_device(struct device *dev)
1023 /* might_sleep(); */
1025 kobject_put(&dev->kobj);
1029 * device_del - delete device from system.
1032 * This is the first part of the device unregistration
1033 * sequence. This removes the device from the lists we control
1034 * from here, has it removed from the other driver model
1035 * subsystems it was added to in device_add(), and removes it
1036 * from the kobject hierarchy.
1038 * NOTE: this should be called manually _iff_ device_add() was
1039 * also called manually.
1041 void device_del(struct device *dev)
1043 struct device *parent = dev->parent;
1044 struct class_interface *class_intf;
1046 /* Notify clients of device removal. This call must come
1047 * before dpm_sysfs_remove().
1050 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
1051 BUS_NOTIFY_DEL_DEVICE, dev);
1052 device_pm_remove(dev);
1053 dpm_sysfs_remove(dev);
1055 klist_del(&dev->p->knode_parent);
1056 if (MAJOR(dev->devt)) {
1057 device_remove_sys_dev_entry(dev);
1058 device_remove_file(dev, &devt_attr);
1061 device_remove_class_symlinks(dev);
1063 mutex_lock(&dev->class->p->class_mutex);
1064 /* notify any interfaces that the device is now gone */
1065 list_for_each_entry(class_intf,
1066 &dev->class->p->class_interfaces, node)
1067 if (class_intf->remove_dev)
1068 class_intf->remove_dev(dev, class_intf);
1069 /* remove the device from the class list */
1070 klist_del(&dev->knode_class);
1071 mutex_unlock(&dev->class->p->class_mutex);
1073 device_remove_file(dev, &uevent_attr);
1074 device_remove_attrs(dev);
1075 bus_remove_device(dev);
1078 * Some platform devices are driven without driver attached
1079 * and managed resources may have been acquired. Make sure
1080 * all resources are released.
1082 devres_release_all(dev);
1084 /* Notify the platform of the removal, in case they
1085 * need to do anything...
1087 if (platform_notify_remove)
1088 platform_notify_remove(dev);
1089 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1090 cleanup_device_parent(dev);
1091 kobject_del(&dev->kobj);
1096 * device_unregister - unregister device from system.
1097 * @dev: device going away.
1099 * We do this in two parts, like we do device_register(). First,
1100 * we remove it from all the subsystems with device_del(), then
1101 * we decrement the reference count via put_device(). If that
1102 * is the final reference count, the device will be cleaned up
1103 * via device_release() above. Otherwise, the structure will
1104 * stick around until the final reference to the device is dropped.
1106 void device_unregister(struct device *dev)
1108 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1113 static struct device *next_device(struct klist_iter *i)
1115 struct klist_node *n = klist_next(i);
1116 struct device *dev = NULL;
1117 struct device_private *p;
1120 p = to_device_private_parent(n);
1127 * device_for_each_child - device child iterator.
1128 * @parent: parent struct device.
1129 * @data: data for the callback.
1130 * @fn: function to be called for each device.
1132 * Iterate over @parent's child devices, and call @fn for each,
1135 * We check the return of @fn each time. If it returns anything
1136 * other than 0, we break out and return that value.
1138 int device_for_each_child(struct device *parent, void *data,
1139 int (*fn)(struct device *dev, void *data))
1141 struct klist_iter i;
1142 struct device *child;
1145 klist_iter_init(&parent->p->klist_children, &i);
1146 while ((child = next_device(&i)) && !error)
1147 error = fn(child, data);
1148 klist_iter_exit(&i);
1153 * device_find_child - device iterator for locating a particular device.
1154 * @parent: parent struct device
1155 * @data: Data to pass to match function
1156 * @match: Callback function to check device
1158 * This is similar to the device_for_each_child() function above, but it
1159 * returns a reference to a device that is 'found' for later use, as
1160 * determined by the @match callback.
1162 * The callback should return 0 if the device doesn't match and non-zero
1163 * if it does. If the callback returns non-zero and a reference to the
1164 * current device can be obtained, this function will return to the caller
1165 * and not iterate over any more devices.
1167 struct device *device_find_child(struct device *parent, void *data,
1168 int (*match)(struct device *dev, void *data))
1170 struct klist_iter i;
1171 struct device *child;
1176 klist_iter_init(&parent->p->klist_children, &i);
1177 while ((child = next_device(&i)))
1178 if (match(child, data) && get_device(child))
1180 klist_iter_exit(&i);
1184 int __init devices_init(void)
1186 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1189 dev_kobj = kobject_create_and_add("dev", NULL);
1192 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
1193 if (!sysfs_dev_block_kobj)
1194 goto block_kobj_err;
1195 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
1196 if (!sysfs_dev_char_kobj)
1202 kobject_put(sysfs_dev_block_kobj);
1204 kobject_put(dev_kobj);
1206 kset_unregister(devices_kset);
1210 EXPORT_SYMBOL_GPL(device_for_each_child);
1211 EXPORT_SYMBOL_GPL(device_find_child);
1213 EXPORT_SYMBOL_GPL(device_initialize);
1214 EXPORT_SYMBOL_GPL(device_add);
1215 EXPORT_SYMBOL_GPL(device_register);
1217 EXPORT_SYMBOL_GPL(device_del);
1218 EXPORT_SYMBOL_GPL(device_unregister);
1219 EXPORT_SYMBOL_GPL(get_device);
1220 EXPORT_SYMBOL_GPL(put_device);
1222 EXPORT_SYMBOL_GPL(device_create_file);
1223 EXPORT_SYMBOL_GPL(device_remove_file);
1228 struct module *owner;
1231 #define to_root_device(dev) container_of(dev, struct root_device, dev)
1233 static void root_device_release(struct device *dev)
1235 kfree(to_root_device(dev));
1239 * __root_device_register - allocate and register a root device
1240 * @name: root device name
1241 * @owner: owner module of the root device, usually THIS_MODULE
1243 * This function allocates a root device and registers it
1244 * using device_register(). In order to free the returned
1245 * device, use root_device_unregister().
1247 * Root devices are dummy devices which allow other devices
1248 * to be grouped under /sys/devices. Use this function to
1249 * allocate a root device and then use it as the parent of
1250 * any device which should appear under /sys/devices/{name}
1252 * The /sys/devices/{name} directory will also contain a
1253 * 'module' symlink which points to the @owner directory
1256 * Note: You probably want to use root_device_register().
1258 struct device *__root_device_register(const char *name, struct module *owner)
1260 struct root_device *root;
1263 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
1265 return ERR_PTR(err);
1267 err = dev_set_name(&root->dev, name);
1270 return ERR_PTR(err);
1273 root->dev.release = root_device_release;
1275 err = device_register(&root->dev);
1277 put_device(&root->dev);
1278 return ERR_PTR(err);
1281 #ifdef CONFIG_MODULE /* gotta find a "cleaner" way to do this */
1283 struct module_kobject *mk = &owner->mkobj;
1285 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
1287 device_unregister(&root->dev);
1288 return ERR_PTR(err);
1290 root->owner = owner;
1296 EXPORT_SYMBOL_GPL(__root_device_register);
1299 * root_device_unregister - unregister and free a root device
1300 * @dev: device going away
1302 * This function unregisters and cleans up a device that was created by
1303 * root_device_register().
1305 void root_device_unregister(struct device *dev)
1307 struct root_device *root = to_root_device(dev);
1310 sysfs_remove_link(&root->dev.kobj, "module");
1312 device_unregister(dev);
1314 EXPORT_SYMBOL_GPL(root_device_unregister);
1317 static void device_create_release(struct device *dev)
1319 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
1324 * device_create_vargs - creates a device and registers it with sysfs
1325 * @class: pointer to the struct class that this device should be registered to
1326 * @parent: pointer to the parent struct device of this new device, if any
1327 * @devt: the dev_t for the char device to be added
1328 * @drvdata: the data to be added to the device for callbacks
1329 * @fmt: string for the device's name
1330 * @args: va_list for the device's name
1332 * This function can be used by char device classes. A struct device
1333 * will be created in sysfs, registered to the specified class.
1335 * A "dev" file will be created, showing the dev_t for the device, if
1336 * the dev_t is not 0,0.
1337 * If a pointer to a parent struct device is passed in, the newly created
1338 * struct device will be a child of that device in sysfs.
1339 * The pointer to the struct device will be returned from the call.
1340 * Any further sysfs files that might be required can be created using this
1343 * Note: the struct class passed to this function must have previously
1344 * been created with a call to class_create().
1346 struct device *device_create_vargs(struct class *class, struct device *parent,
1347 dev_t devt, void *drvdata, const char *fmt,
1350 struct device *dev = NULL;
1351 int retval = -ENODEV;
1353 if (class == NULL || IS_ERR(class))
1356 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1364 dev->parent = parent;
1365 dev->release = device_create_release;
1366 dev_set_drvdata(dev, drvdata);
1368 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
1372 retval = device_register(dev);
1380 return ERR_PTR(retval);
1382 EXPORT_SYMBOL_GPL(device_create_vargs);
1385 * device_create - creates a device and registers it with sysfs
1386 * @class: pointer to the struct class that this device should be registered to
1387 * @parent: pointer to the parent struct device of this new device, if any
1388 * @devt: the dev_t for the char device to be added
1389 * @drvdata: the data to be added to the device for callbacks
1390 * @fmt: string for the device's name
1392 * This function can be used by char device classes. A struct device
1393 * will be created in sysfs, registered to the specified class.
1395 * A "dev" file will be created, showing the dev_t for the device, if
1396 * the dev_t is not 0,0.
1397 * If a pointer to a parent struct device is passed in, the newly created
1398 * struct device will be a child of that device in sysfs.
1399 * The pointer to the struct device will be returned from the call.
1400 * Any further sysfs files that might be required can be created using this
1403 * Note: the struct class passed to this function must have previously
1404 * been created with a call to class_create().
1406 struct device *device_create(struct class *class, struct device *parent,
1407 dev_t devt, void *drvdata, const char *fmt, ...)
1412 va_start(vargs, fmt);
1413 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1417 EXPORT_SYMBOL_GPL(device_create);
1419 static int __match_devt(struct device *dev, void *data)
1423 return dev->devt == *devt;
1427 * device_destroy - removes a device that was created with device_create()
1428 * @class: pointer to the struct class that this device was registered with
1429 * @devt: the dev_t of the device that was previously registered
1431 * This call unregisters and cleans up a device that was created with a
1432 * call to device_create().
1434 void device_destroy(struct class *class, dev_t devt)
1438 dev = class_find_device(class, NULL, &devt, __match_devt);
1441 device_unregister(dev);
1444 EXPORT_SYMBOL_GPL(device_destroy);
1447 * device_rename - renames a device
1448 * @dev: the pointer to the struct device to be renamed
1449 * @new_name: the new name of the device
1451 * It is the responsibility of the caller to provide mutual
1452 * exclusion between two different calls of device_rename
1453 * on the same device to ensure that new_name is valid and
1454 * won't conflict with other devices.
1456 int device_rename(struct device *dev, char *new_name)
1458 char *old_class_name = NULL;
1459 char *new_class_name = NULL;
1460 char *old_device_name = NULL;
1463 dev = get_device(dev);
1467 pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev),
1468 __func__, new_name);
1470 #ifdef CONFIG_SYSFS_DEPRECATED
1471 if ((dev->class) && (dev->parent))
1472 old_class_name = make_class_name(dev->class->name, &dev->kobj);
1475 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
1476 if (!old_device_name) {
1481 error = kobject_rename(&dev->kobj, new_name);
1485 #ifdef CONFIG_SYSFS_DEPRECATED
1486 if (old_class_name) {
1487 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1488 if (new_class_name) {
1489 error = sysfs_create_link_nowarn(&dev->parent->kobj,
1494 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1499 error = sysfs_create_link_nowarn(&dev->class->p->class_subsys.kobj,
1500 &dev->kobj, dev_name(dev));
1503 sysfs_remove_link(&dev->class->p->class_subsys.kobj,
1511 kfree(new_class_name);
1512 kfree(old_class_name);
1513 kfree(old_device_name);
1517 EXPORT_SYMBOL_GPL(device_rename);
1519 static int device_move_class_links(struct device *dev,
1520 struct device *old_parent,
1521 struct device *new_parent)
1524 #ifdef CONFIG_SYSFS_DEPRECATED
1527 class_name = make_class_name(dev->class->name, &dev->kobj);
1533 sysfs_remove_link(&dev->kobj, "device");
1534 sysfs_remove_link(&old_parent->kobj, class_name);
1537 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1541 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1544 sysfs_remove_link(&dev->kobj, "device");
1552 sysfs_remove_link(&dev->kobj, "device");
1554 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1561 * device_move - moves a device to a new parent
1562 * @dev: the pointer to the struct device to be moved
1563 * @new_parent: the new parent of the device (can by NULL)
1564 * @dpm_order: how to reorder the dpm_list
1566 int device_move(struct device *dev, struct device *new_parent,
1567 enum dpm_order dpm_order)
1570 struct device *old_parent;
1571 struct kobject *new_parent_kobj;
1573 dev = get_device(dev);
1578 new_parent = get_device(new_parent);
1579 new_parent_kobj = get_device_parent(dev, new_parent);
1581 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
1582 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
1583 error = kobject_move(&dev->kobj, new_parent_kobj);
1585 cleanup_glue_dir(dev, new_parent_kobj);
1586 put_device(new_parent);
1589 old_parent = dev->parent;
1590 dev->parent = new_parent;
1592 klist_remove(&dev->p->knode_parent);
1594 klist_add_tail(&dev->p->knode_parent,
1595 &new_parent->p->klist_children);
1596 set_dev_node(dev, dev_to_node(new_parent));
1601 error = device_move_class_links(dev, old_parent, new_parent);
1603 /* We ignore errors on cleanup since we're hosed anyway... */
1604 device_move_class_links(dev, new_parent, old_parent);
1605 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1607 klist_remove(&dev->p->knode_parent);
1608 dev->parent = old_parent;
1610 klist_add_tail(&dev->p->knode_parent,
1611 &old_parent->p->klist_children);
1612 set_dev_node(dev, dev_to_node(old_parent));
1615 cleanup_glue_dir(dev, new_parent_kobj);
1616 put_device(new_parent);
1619 switch (dpm_order) {
1620 case DPM_ORDER_NONE:
1622 case DPM_ORDER_DEV_AFTER_PARENT:
1623 device_pm_move_after(dev, new_parent);
1625 case DPM_ORDER_PARENT_BEFORE_DEV:
1626 device_pm_move_before(new_parent, dev);
1628 case DPM_ORDER_DEV_LAST:
1629 device_pm_move_last(dev);
1633 put_device(old_parent);
1639 EXPORT_SYMBOL_GPL(device_move);
1642 * device_shutdown - call ->shutdown() on each device to shutdown.
1644 void device_shutdown(void)
1646 struct device *dev, *devn;
1648 list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
1650 if (dev->bus && dev->bus->shutdown) {
1651 dev_dbg(dev, "shutdown\n");
1652 dev->bus->shutdown(dev);
1653 } else if (dev->driver && dev->driver->shutdown) {
1654 dev_dbg(dev, "shutdown\n");
1655 dev->driver->shutdown(dev);
1658 kobject_put(sysfs_dev_char_kobj);
1659 kobject_put(sysfs_dev_block_kobj);
1660 kobject_put(dev_kobj);