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 <asm/semaphore.h>
25 #include "power/power.h"
27 int (*platform_notify)(struct device *dev) = NULL;
28 int (*platform_notify_remove)(struct device *dev) = NULL;
31 static inline int device_is_not_partition(struct device *dev)
33 return !(dev->type == &part_type);
36 static inline int device_is_not_partition(struct device *dev)
43 * dev_driver_string - Return a device's driver name, if at all possible
44 * @dev: struct device to get the name of
46 * Will return the device's driver's name if it is bound to a device. If
47 * the device is not bound to a device, it will return the name of the bus
48 * it is attached to. If it is not attached to a bus either, an empty
49 * string will be returned.
51 const char *dev_driver_string(struct device *dev)
53 return dev->driver ? dev->driver->name :
54 (dev->bus ? dev->bus->name :
55 (dev->class ? dev->class->name : ""));
57 EXPORT_SYMBOL(dev_driver_string);
59 #define to_dev(obj) container_of(obj, struct device, kobj)
60 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
62 static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
65 struct device_attribute *dev_attr = to_dev_attr(attr);
66 struct device *dev = to_dev(kobj);
70 ret = dev_attr->show(dev, dev_attr, buf);
74 static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
75 const char *buf, size_t count)
77 struct device_attribute *dev_attr = to_dev_attr(attr);
78 struct device *dev = to_dev(kobj);
82 ret = dev_attr->store(dev, dev_attr, buf, count);
86 static struct sysfs_ops dev_sysfs_ops = {
87 .show = dev_attr_show,
88 .store = dev_attr_store,
93 * device_release - free device structure.
94 * @kobj: device's kobject.
96 * This is called once the reference count for the object
97 * reaches 0. We forward the call to the device's release
98 * method, which should handle actually freeing the structure.
100 static void device_release(struct kobject *kobj)
102 struct device *dev = to_dev(kobj);
106 else if (dev->type && dev->type->release)
107 dev->type->release(dev);
108 else if (dev->class && dev->class->dev_release)
109 dev->class->dev_release(dev);
111 printk(KERN_ERR "Device '%s' does not have a release() "
112 "function, it is broken and must be fixed.\n",
118 static struct kobj_type device_ktype = {
119 .release = device_release,
120 .sysfs_ops = &dev_sysfs_ops,
124 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
126 struct kobj_type *ktype = get_ktype(kobj);
128 if (ktype == &device_ktype) {
129 struct device *dev = to_dev(kobj);
130 if (dev->uevent_suppress)
140 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
142 struct device *dev = to_dev(kobj);
145 return dev->bus->name;
147 return dev->class->name;
151 static int dev_uevent(struct kset *kset, struct kobject *kobj,
152 struct kobj_uevent_env *env)
154 struct device *dev = to_dev(kobj);
157 /* add the major/minor if present */
158 if (MAJOR(dev->devt)) {
159 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
160 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
163 if (dev->type && dev->type->name)
164 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
167 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
169 #ifdef CONFIG_SYSFS_DEPRECATED
171 struct device *parent = dev->parent;
173 /* find first bus device in parent chain */
174 while (parent && !parent->bus)
175 parent = parent->parent;
176 if (parent && parent->bus) {
179 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
181 add_uevent_var(env, "PHYSDEVPATH=%s", path);
185 add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
188 add_uevent_var(env, "PHYSDEVDRIVER=%s",
189 parent->driver->name);
191 } else if (dev->bus) {
192 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
195 add_uevent_var(env, "PHYSDEVDRIVER=%s",
200 /* have the bus specific function add its stuff */
201 if (dev->bus && dev->bus->uevent) {
202 retval = dev->bus->uevent(dev, env);
204 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
205 dev->bus_id, __FUNCTION__, retval);
208 /* have the class specific function add its stuff */
209 if (dev->class && dev->class->dev_uevent) {
210 retval = dev->class->dev_uevent(dev, env);
212 pr_debug("device: '%s': %s: class uevent() "
213 "returned %d\n", dev->bus_id,
214 __FUNCTION__, retval);
217 /* have the device type specific fuction add its stuff */
218 if (dev->type && dev->type->uevent) {
219 retval = dev->type->uevent(dev, env);
221 pr_debug("device: '%s': %s: dev_type uevent() "
222 "returned %d\n", dev->bus_id,
223 __FUNCTION__, retval);
229 static struct kset_uevent_ops device_uevent_ops = {
230 .filter = dev_uevent_filter,
231 .name = dev_uevent_name,
232 .uevent = dev_uevent,
235 static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
238 struct kobject *top_kobj;
240 struct kobj_uevent_env *env = NULL;
245 /* search the kset, the device belongs to */
246 top_kobj = &dev->kobj;
247 while (!top_kobj->kset && top_kobj->parent)
248 top_kobj = top_kobj->parent;
252 kset = top_kobj->kset;
253 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
257 if (kset->uevent_ops && kset->uevent_ops->filter)
258 if (!kset->uevent_ops->filter(kset, &dev->kobj))
261 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
265 /* let the kset specific function add its keys */
266 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
270 /* copy keys to file */
271 for (i = 0; i < env->envp_idx; i++)
272 count += sprintf(&buf[count], "%s\n", env->envp[i]);
278 static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
279 const char *buf, size_t count)
281 enum kobject_action action;
283 if (kobject_action_type(buf, count, &action) == 0) {
284 kobject_uevent(&dev->kobj, action);
288 dev_err(dev, "uevent: unsupported action-string; this will "
289 "be ignored in a future kernel version\n");
290 kobject_uevent(&dev->kobj, KOBJ_ADD);
295 static struct device_attribute uevent_attr =
296 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
298 static int device_add_attributes(struct device *dev,
299 struct device_attribute *attrs)
305 for (i = 0; attr_name(attrs[i]); i++) {
306 error = device_create_file(dev, &attrs[i]);
312 device_remove_file(dev, &attrs[i]);
317 static void device_remove_attributes(struct device *dev,
318 struct device_attribute *attrs)
323 for (i = 0; attr_name(attrs[i]); i++)
324 device_remove_file(dev, &attrs[i]);
327 static int device_add_groups(struct device *dev,
328 struct attribute_group **groups)
334 for (i = 0; groups[i]; i++) {
335 error = sysfs_create_group(&dev->kobj, groups[i]);
338 sysfs_remove_group(&dev->kobj,
347 static void device_remove_groups(struct device *dev,
348 struct attribute_group **groups)
353 for (i = 0; groups[i]; i++)
354 sysfs_remove_group(&dev->kobj, groups[i]);
357 static int device_add_attrs(struct device *dev)
359 struct class *class = dev->class;
360 struct device_type *type = dev->type;
364 error = device_add_attributes(dev, class->dev_attrs);
370 error = device_add_groups(dev, type->groups);
372 goto err_remove_class_attrs;
375 error = device_add_groups(dev, dev->groups);
377 goto err_remove_type_groups;
381 err_remove_type_groups:
383 device_remove_groups(dev, type->groups);
384 err_remove_class_attrs:
386 device_remove_attributes(dev, class->dev_attrs);
391 static void device_remove_attrs(struct device *dev)
393 struct class *class = dev->class;
394 struct device_type *type = dev->type;
396 device_remove_groups(dev, dev->groups);
399 device_remove_groups(dev, type->groups);
402 device_remove_attributes(dev, class->dev_attrs);
406 static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
409 return print_dev_t(buf, dev->devt);
412 static struct device_attribute devt_attr =
413 __ATTR(dev, S_IRUGO, show_dev, NULL);
415 /* kset to create /sys/devices/ */
416 struct kset *devices_kset;
419 * device_create_file - create sysfs attribute file for device.
421 * @attr: device attribute descriptor.
423 int device_create_file(struct device *dev, struct device_attribute *attr)
426 if (get_device(dev)) {
427 error = sysfs_create_file(&dev->kobj, &attr->attr);
434 * device_remove_file - remove sysfs attribute file.
436 * @attr: device attribute descriptor.
438 void device_remove_file(struct device *dev, struct device_attribute *attr)
440 if (get_device(dev)) {
441 sysfs_remove_file(&dev->kobj, &attr->attr);
447 * device_create_bin_file - create sysfs binary attribute file for device.
449 * @attr: device binary attribute descriptor.
451 int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
455 error = sysfs_create_bin_file(&dev->kobj, attr);
458 EXPORT_SYMBOL_GPL(device_create_bin_file);
461 * device_remove_bin_file - remove sysfs binary attribute file
463 * @attr: device binary attribute descriptor.
465 void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
468 sysfs_remove_bin_file(&dev->kobj, attr);
470 EXPORT_SYMBOL_GPL(device_remove_bin_file);
473 * device_schedule_callback_owner - helper to schedule a callback for a device
475 * @func: callback function to invoke later.
476 * @owner: module owning the callback routine
478 * Attribute methods must not unregister themselves or their parent device
479 * (which would amount to the same thing). Attempts to do so will deadlock,
480 * since unregistration is mutually exclusive with driver callbacks.
482 * Instead methods can call this routine, which will attempt to allocate
483 * and schedule a workqueue request to call back @func with @dev as its
484 * argument in the workqueue's process context. @dev will be pinned until
487 * This routine is usually called via the inline device_schedule_callback(),
488 * which automatically sets @owner to THIS_MODULE.
490 * Returns 0 if the request was submitted, -ENOMEM if storage could not
491 * be allocated, -ENODEV if a reference to @owner isn't available.
493 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
494 * underlying sysfs routine (since it is intended for use by attribute
495 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
497 int device_schedule_callback_owner(struct device *dev,
498 void (*func)(struct device *), struct module *owner)
500 return sysfs_schedule_callback(&dev->kobj,
501 (void (*)(void *)) func, dev, owner);
503 EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
505 static void klist_children_get(struct klist_node *n)
507 struct device *dev = container_of(n, struct device, knode_parent);
512 static void klist_children_put(struct klist_node *n)
514 struct device *dev = container_of(n, struct device, knode_parent);
520 * device_initialize - init device structure.
523 * This prepares the device for use by other layers,
524 * including adding it to the device hierarchy.
525 * It is the first half of device_register(), if called by
526 * that, though it can also be called separately, so one
527 * may use @dev's fields (e.g. the refcount).
529 void device_initialize(struct device *dev)
531 dev->kobj.kset = devices_kset;
532 kobject_init(&dev->kobj, &device_ktype);
533 klist_init(&dev->klist_children, klist_children_get,
535 INIT_LIST_HEAD(&dev->dma_pools);
536 INIT_LIST_HEAD(&dev->node);
537 init_MUTEX(&dev->sem);
538 spin_lock_init(&dev->devres_lock);
539 INIT_LIST_HEAD(&dev->devres_head);
540 device_init_wakeup(dev, 0);
541 set_dev_node(dev, -1);
544 #ifdef CONFIG_SYSFS_DEPRECATED
545 static struct kobject *get_device_parent(struct device *dev,
546 struct device *parent)
548 /* class devices without a parent live in /sys/class/<classname>/ */
549 if (dev->class && (!parent || parent->class != dev->class))
550 return &dev->class->subsys.kobj;
551 /* all other devices keep their parent */
553 return &parent->kobj;
558 static inline void cleanup_device_parent(struct device *dev) {}
559 static inline void cleanup_glue_dir(struct device *dev,
560 struct kobject *glue_dir) {}
562 static struct kobject *virtual_device_parent(struct device *dev)
564 static struct kobject *virtual_dir = NULL;
567 virtual_dir = kobject_create_and_add("virtual",
568 &devices_kset->kobj);
573 static struct kobject *get_device_parent(struct device *dev,
574 struct device *parent)
579 struct kobject *kobj = NULL;
580 struct kobject *parent_kobj;
584 * If we have no parent, we live in "virtual".
585 * Class-devices with a non class-device as parent, live
586 * in a "glue" directory to prevent namespace collisions.
589 parent_kobj = virtual_device_parent(dev);
590 else if (parent->class)
591 return &parent->kobj;
593 parent_kobj = &parent->kobj;
595 /* find our class-directory at the parent and reference it */
596 spin_lock(&dev->class->class_dirs.list_lock);
597 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
598 if (k->parent == parent_kobj) {
599 kobj = kobject_get(k);
602 spin_unlock(&dev->class->class_dirs.list_lock);
606 /* or create a new class-directory at the parent device */
607 k = kobject_create();
610 k->kset = &dev->class->class_dirs;
611 retval = kobject_add(k, parent_kobj, "%s", dev->class->name);
616 /* do not emit an uevent for this simple "glue" directory */
621 return &parent->kobj;
625 static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
627 /* see if we live in a "glue" directory */
628 if (!dev->class || glue_dir->kset != &dev->class->class_dirs)
631 kobject_put(glue_dir);
634 static void cleanup_device_parent(struct device *dev)
636 cleanup_glue_dir(dev, dev->kobj.parent);
640 static void setup_parent(struct device *dev, struct device *parent)
642 struct kobject *kobj;
643 kobj = get_device_parent(dev, parent);
645 dev->kobj.parent = kobj;
648 static int device_add_class_symlinks(struct device *dev)
655 error = sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
660 #ifdef CONFIG_SYSFS_DEPRECATED
661 /* stacked class devices need a symlink in the class directory */
662 if (dev->kobj.parent != &dev->class->subsys.kobj &&
663 device_is_not_partition(dev)) {
664 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
670 if (dev->parent && device_is_not_partition(dev)) {
671 struct device *parent = dev->parent;
675 * stacked class devices have the 'device' link
676 * pointing to the bus device instead of the parent
678 while (parent->class && !parent->bus && parent->parent)
679 parent = parent->parent;
681 error = sysfs_create_link(&dev->kobj,
687 class_name = make_class_name(dev->class->name,
690 error = sysfs_create_link(&dev->parent->kobj,
691 &dev->kobj, class_name);
699 if (dev->parent && device_is_not_partition(dev))
700 sysfs_remove_link(&dev->kobj, "device");
702 if (dev->kobj.parent != &dev->class->subsys.kobj &&
703 device_is_not_partition(dev))
704 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
706 /* link in the class directory pointing to the device */
707 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
712 if (dev->parent && device_is_not_partition(dev)) {
713 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
721 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
725 sysfs_remove_link(&dev->kobj, "subsystem");
730 static void device_remove_class_symlinks(struct device *dev)
735 #ifdef CONFIG_SYSFS_DEPRECATED
736 if (dev->parent && device_is_not_partition(dev)) {
739 class_name = make_class_name(dev->class->name, &dev->kobj);
741 sysfs_remove_link(&dev->parent->kobj, class_name);
744 sysfs_remove_link(&dev->kobj, "device");
747 if (dev->kobj.parent != &dev->class->subsys.kobj &&
748 device_is_not_partition(dev))
749 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
751 if (dev->parent && device_is_not_partition(dev))
752 sysfs_remove_link(&dev->kobj, "device");
754 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
757 sysfs_remove_link(&dev->kobj, "subsystem");
761 * device_add - add device to device hierarchy.
764 * This is part 2 of device_register(), though may be called
765 * separately _iff_ device_initialize() has been called separately.
767 * This adds it to the kobject hierarchy via kobject_add(), adds it
768 * to the global and sibling lists for the device, then
769 * adds it to the other relevant subsystems of the driver model.
771 int device_add(struct device *dev)
773 struct device *parent = NULL;
774 struct class_interface *class_intf;
777 error = pm_sleep_lock();
779 dev_warn(dev, "Suspicious %s during suspend\n", __FUNCTION__);
784 dev = get_device(dev);
785 if (!dev || !strlen(dev->bus_id)) {
790 pr_debug("device: '%s': %s\n", dev->bus_id, __FUNCTION__);
792 parent = get_device(dev->parent);
793 setup_parent(dev, parent);
795 /* first, register with generic layer. */
796 error = kobject_add(&dev->kobj, dev->kobj.parent, "%s", dev->bus_id);
800 /* notify platform of device entry */
802 platform_notify(dev);
804 /* notify clients of device entry (new way) */
806 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
807 BUS_NOTIFY_ADD_DEVICE, dev);
809 error = device_create_file(dev, &uevent_attr);
813 if (MAJOR(dev->devt)) {
814 error = device_create_file(dev, &devt_attr);
816 goto ueventattrError;
819 error = device_add_class_symlinks(dev);
822 error = device_add_attrs(dev);
825 error = dpm_sysfs_add(dev);
829 error = bus_add_device(dev);
832 kobject_uevent(&dev->kobj, KOBJ_ADD);
833 bus_attach_device(dev);
835 klist_add_tail(&dev->knode_parent, &parent->klist_children);
838 down(&dev->class->sem);
839 /* tie the class to the device */
840 list_add_tail(&dev->node, &dev->class->devices);
842 /* notify any interfaces that the device is here */
843 list_for_each_entry(class_intf, &dev->class->interfaces, node)
844 if (class_intf->add_dev)
845 class_intf->add_dev(dev, class_intf);
846 up(&dev->class->sem);
853 device_pm_remove(dev);
854 dpm_sysfs_remove(dev);
857 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
858 BUS_NOTIFY_DEL_DEVICE, dev);
859 device_remove_attrs(dev);
861 device_remove_class_symlinks(dev);
863 if (MAJOR(dev->devt))
864 device_remove_file(dev, &devt_attr);
866 device_remove_file(dev, &uevent_attr);
868 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
869 kobject_del(&dev->kobj);
871 cleanup_device_parent(dev);
878 * device_register - register a device with the system.
879 * @dev: pointer to the device structure
881 * This happens in two clean steps - initialize the device
882 * and add it to the system. The two steps can be called
883 * separately, but this is the easiest and most common.
884 * I.e. you should only call the two helpers separately if
885 * have a clearly defined need to use and refcount the device
886 * before it is added to the hierarchy.
888 int device_register(struct device *dev)
890 device_initialize(dev);
891 return device_add(dev);
895 * get_device - increment reference count for device.
898 * This simply forwards the call to kobject_get(), though
899 * we do take care to provide for the case that we get a NULL
902 struct device *get_device(struct device *dev)
904 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
908 * put_device - decrement reference count.
909 * @dev: device in question.
911 void put_device(struct device *dev)
915 kobject_put(&dev->kobj);
919 * device_del - delete device from system.
922 * This is the first part of the device unregistration
923 * sequence. This removes the device from the lists we control
924 * from here, has it removed from the other driver model
925 * subsystems it was added to in device_add(), and removes it
926 * from the kobject hierarchy.
928 * NOTE: this should be called manually _iff_ device_add() was
929 * also called manually.
931 void device_del(struct device *dev)
933 struct device *parent = dev->parent;
934 struct class_interface *class_intf;
936 device_pm_remove(dev);
938 klist_del(&dev->knode_parent);
939 if (MAJOR(dev->devt))
940 device_remove_file(dev, &devt_attr);
942 device_remove_class_symlinks(dev);
944 down(&dev->class->sem);
945 /* notify any interfaces that the device is now gone */
946 list_for_each_entry(class_intf, &dev->class->interfaces, node)
947 if (class_intf->remove_dev)
948 class_intf->remove_dev(dev, class_intf);
949 /* remove the device from the class list */
950 list_del_init(&dev->node);
951 up(&dev->class->sem);
953 device_remove_file(dev, &uevent_attr);
954 device_remove_attrs(dev);
955 bus_remove_device(dev);
958 * Some platform devices are driven without driver attached
959 * and managed resources may have been acquired. Make sure
960 * all resources are released.
962 devres_release_all(dev);
964 /* Notify the platform of the removal, in case they
965 * need to do anything...
967 if (platform_notify_remove)
968 platform_notify_remove(dev);
970 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
971 BUS_NOTIFY_DEL_DEVICE, dev);
972 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
973 cleanup_device_parent(dev);
974 kobject_del(&dev->kobj);
979 * device_unregister - unregister device from system.
980 * @dev: device going away.
982 * We do this in two parts, like we do device_register(). First,
983 * we remove it from all the subsystems with device_del(), then
984 * we decrement the reference count via put_device(). If that
985 * is the final reference count, the device will be cleaned up
986 * via device_release() above. Otherwise, the structure will
987 * stick around until the final reference to the device is dropped.
989 void device_unregister(struct device *dev)
991 pr_debug("device: '%s': %s\n", dev->bus_id, __FUNCTION__);
996 static struct device *next_device(struct klist_iter *i)
998 struct klist_node *n = klist_next(i);
999 return n ? container_of(n, struct device, knode_parent) : NULL;
1003 * device_for_each_child - device child iterator.
1004 * @parent: parent struct device.
1005 * @data: data for the callback.
1006 * @fn: function to be called for each device.
1008 * Iterate over @parent's child devices, and call @fn for each,
1011 * We check the return of @fn each time. If it returns anything
1012 * other than 0, we break out and return that value.
1014 int device_for_each_child(struct device *parent, void *data,
1015 int (*fn)(struct device *dev, void *data))
1017 struct klist_iter i;
1018 struct device *child;
1021 klist_iter_init(&parent->klist_children, &i);
1022 while ((child = next_device(&i)) && !error)
1023 error = fn(child, data);
1024 klist_iter_exit(&i);
1029 * device_find_child - device iterator for locating a particular device.
1030 * @parent: parent struct device
1031 * @data: Data to pass to match function
1032 * @match: Callback function to check device
1034 * This is similar to the device_for_each_child() function above, but it
1035 * returns a reference to a device that is 'found' for later use, as
1036 * determined by the @match callback.
1038 * The callback should return 0 if the device doesn't match and non-zero
1039 * if it does. If the callback returns non-zero and a reference to the
1040 * current device can be obtained, this function will return to the caller
1041 * and not iterate over any more devices.
1043 struct device *device_find_child(struct device *parent, void *data,
1044 int (*match)(struct device *dev, void *data))
1046 struct klist_iter i;
1047 struct device *child;
1052 klist_iter_init(&parent->klist_children, &i);
1053 while ((child = next_device(&i)))
1054 if (match(child, data) && get_device(child))
1056 klist_iter_exit(&i);
1060 int __init devices_init(void)
1062 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1068 EXPORT_SYMBOL_GPL(device_for_each_child);
1069 EXPORT_SYMBOL_GPL(device_find_child);
1071 EXPORT_SYMBOL_GPL(device_initialize);
1072 EXPORT_SYMBOL_GPL(device_add);
1073 EXPORT_SYMBOL_GPL(device_register);
1075 EXPORT_SYMBOL_GPL(device_del);
1076 EXPORT_SYMBOL_GPL(device_unregister);
1077 EXPORT_SYMBOL_GPL(get_device);
1078 EXPORT_SYMBOL_GPL(put_device);
1080 EXPORT_SYMBOL_GPL(device_create_file);
1081 EXPORT_SYMBOL_GPL(device_remove_file);
1084 static void device_create_release(struct device *dev)
1086 pr_debug("device: '%s': %s\n", dev->bus_id, __FUNCTION__);
1091 * device_create - creates a device and registers it with sysfs
1092 * @class: pointer to the struct class that this device should be registered to
1093 * @parent: pointer to the parent struct device of this new device, if any
1094 * @devt: the dev_t for the char device to be added
1095 * @fmt: string for the device's name
1097 * This function can be used by char device classes. A struct device
1098 * will be created in sysfs, registered to the specified class.
1100 * A "dev" file will be created, showing the dev_t for the device, if
1101 * the dev_t is not 0,0.
1102 * If a pointer to a parent struct device is passed in, the newly created
1103 * struct device will be a child of that device in sysfs.
1104 * The pointer to the struct device will be returned from the call.
1105 * Any further sysfs files that might be required can be created using this
1108 * Note: the struct class passed to this function must have previously
1109 * been created with a call to class_create().
1111 struct device *device_create(struct class *class, struct device *parent,
1112 dev_t devt, const char *fmt, ...)
1115 struct device *dev = NULL;
1116 int retval = -ENODEV;
1118 if (class == NULL || IS_ERR(class))
1121 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1129 dev->parent = parent;
1130 dev->release = device_create_release;
1132 va_start(args, fmt);
1133 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1135 retval = device_register(dev);
1143 return ERR_PTR(retval);
1145 EXPORT_SYMBOL_GPL(device_create);
1148 * find_device - finds a device that was created with device_create()
1149 * @class: pointer to the struct class that this device was registered with
1150 * @devt: the dev_t of the device that was previously registered
1152 static struct device *find_device(struct class *class, dev_t devt)
1154 struct device *dev = NULL;
1155 struct device *dev_tmp;
1158 list_for_each_entry(dev_tmp, &class->devices, node) {
1159 if (dev_tmp->devt == devt) {
1169 * device_destroy - removes a device that was created with device_create()
1170 * @class: pointer to the struct class that this device was registered with
1171 * @devt: the dev_t of the device that was previously registered
1173 * This call unregisters and cleans up a device that was created with a
1174 * call to device_create().
1176 void device_destroy(struct class *class, dev_t devt)
1180 dev = find_device(class, devt);
1182 device_unregister(dev);
1184 EXPORT_SYMBOL_GPL(device_destroy);
1186 #ifdef CONFIG_PM_SLEEP
1188 * destroy_suspended_device - asks the PM core to remove a suspended device
1189 * @class: pointer to the struct class that this device was registered with
1190 * @devt: the dev_t of the device that was previously registered
1192 * This call notifies the PM core of the necessity to unregister a suspended
1193 * device created with a call to device_create() (devices cannot be
1194 * unregistered directly while suspended, since the PM core holds their
1195 * semaphores at that time).
1197 * It can only be called within the scope of a system sleep transition. In
1198 * practice this means it has to be directly or indirectly invoked either by
1199 * a suspend or resume method, or by the PM core (e.g. via
1200 * disable_nonboot_cpus() or enable_nonboot_cpus()).
1202 void destroy_suspended_device(struct class *class, dev_t devt)
1206 dev = find_device(class, devt);
1208 device_pm_schedule_removal(dev);
1210 EXPORT_SYMBOL_GPL(destroy_suspended_device);
1211 #endif /* CONFIG_PM_SLEEP */
1214 * device_rename - renames a device
1215 * @dev: the pointer to the struct device to be renamed
1216 * @new_name: the new name of the device
1218 int device_rename(struct device *dev, char *new_name)
1220 char *old_class_name = NULL;
1221 char *new_class_name = NULL;
1222 char *old_device_name = NULL;
1225 dev = get_device(dev);
1229 pr_debug("device: '%s': %s: renaming to '%s'\n", dev->bus_id,
1230 __FUNCTION__, new_name);
1232 #ifdef CONFIG_SYSFS_DEPRECATED
1233 if ((dev->class) && (dev->parent))
1234 old_class_name = make_class_name(dev->class->name, &dev->kobj);
1237 old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1238 if (!old_device_name) {
1242 strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
1243 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1245 error = kobject_rename(&dev->kobj, new_name);
1247 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1251 #ifdef CONFIG_SYSFS_DEPRECATED
1252 if (old_class_name) {
1253 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1254 if (new_class_name) {
1255 error = sysfs_create_link(&dev->parent->kobj,
1256 &dev->kobj, new_class_name);
1259 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1264 sysfs_remove_link(&dev->class->subsys.kobj, old_device_name);
1265 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
1268 dev_err(dev, "%s: sysfs_create_symlink failed (%d)\n",
1269 __FUNCTION__, error);
1277 kfree(new_class_name);
1278 kfree(old_class_name);
1279 kfree(old_device_name);
1283 EXPORT_SYMBOL_GPL(device_rename);
1285 static int device_move_class_links(struct device *dev,
1286 struct device *old_parent,
1287 struct device *new_parent)
1290 #ifdef CONFIG_SYSFS_DEPRECATED
1293 class_name = make_class_name(dev->class->name, &dev->kobj);
1299 sysfs_remove_link(&dev->kobj, "device");
1300 sysfs_remove_link(&old_parent->kobj, class_name);
1303 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1307 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1310 sysfs_remove_link(&dev->kobj, "device");
1318 sysfs_remove_link(&dev->kobj, "device");
1320 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1327 * device_move - moves a device to a new parent
1328 * @dev: the pointer to the struct device to be moved
1329 * @new_parent: the new parent of the device (can by NULL)
1331 int device_move(struct device *dev, struct device *new_parent)
1334 struct device *old_parent;
1335 struct kobject *new_parent_kobj;
1337 dev = get_device(dev);
1341 new_parent = get_device(new_parent);
1342 new_parent_kobj = get_device_parent(dev, new_parent);
1344 pr_debug("device: '%s': %s: moving to '%s'\n", dev->bus_id,
1345 __FUNCTION__, new_parent ? new_parent->bus_id : "<NULL>");
1346 error = kobject_move(&dev->kobj, new_parent_kobj);
1348 cleanup_glue_dir(dev, new_parent_kobj);
1349 put_device(new_parent);
1352 old_parent = dev->parent;
1353 dev->parent = new_parent;
1355 klist_remove(&dev->knode_parent);
1357 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
1360 error = device_move_class_links(dev, old_parent, new_parent);
1362 /* We ignore errors on cleanup since we're hosed anyway... */
1363 device_move_class_links(dev, new_parent, old_parent);
1364 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1366 klist_remove(&dev->knode_parent);
1368 klist_add_tail(&dev->knode_parent,
1369 &old_parent->klist_children);
1371 cleanup_glue_dir(dev, new_parent_kobj);
1372 put_device(new_parent);
1376 put_device(old_parent);
1381 EXPORT_SYMBOL_GPL(device_move);
1384 * device_shutdown - call ->shutdown() on each device to shutdown.
1386 void device_shutdown(void)
1388 struct device *dev, *devn;
1390 list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
1392 if (dev->bus && dev->bus->shutdown) {
1393 dev_dbg(dev, "shutdown\n");
1394 dev->bus->shutdown(dev);
1395 } else if (dev->driver && dev->driver->shutdown) {
1396 dev_dbg(dev, "shutdown\n");
1397 dev->driver->shutdown(dev);