2 * drivers/base/core.c - core driver model code (device registration, etc)
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
6 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2006 Novell, Inc.
9 * This file is released under the GPLv2
13 #include <linux/device.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/slab.h>
18 #include <linux/string.h>
19 #include <linux/kdev_t.h>
20 #include <linux/notifier.h>
22 #include <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 * sysfs bindings for devices.
35 * dev_driver_string - Return a device's driver name, if at all possible
36 * @dev: struct device to get the name of
38 * Will return the device's driver's name if it is bound to a device. If
39 * the device is not bound to a device, it will return the name of the bus
40 * it is attached to. If it is not attached to a bus either, an empty
41 * string will be returned.
43 const char *dev_driver_string(struct device *dev)
45 return dev->driver ? dev->driver->name :
46 (dev->bus ? dev->bus->name :
47 (dev->class ? dev->class->name : ""));
49 EXPORT_SYMBOL(dev_driver_string);
51 #define to_dev(obj) container_of(obj, struct device, kobj)
52 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
55 dev_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
57 struct device_attribute * dev_attr = to_dev_attr(attr);
58 struct device * dev = to_dev(kobj);
62 ret = dev_attr->show(dev, dev_attr, buf);
67 dev_attr_store(struct kobject * kobj, struct attribute * attr,
68 const char * buf, size_t count)
70 struct device_attribute * dev_attr = to_dev_attr(attr);
71 struct device * dev = to_dev(kobj);
75 ret = dev_attr->store(dev, dev_attr, buf, count);
79 static struct sysfs_ops dev_sysfs_ops = {
80 .show = dev_attr_show,
81 .store = dev_attr_store,
86 * device_release - free device structure.
87 * @kobj: device's kobject.
89 * This is called once the reference count for the object
90 * reaches 0. We forward the call to the device's release
91 * method, which should handle actually freeing the structure.
93 static void device_release(struct kobject * kobj)
95 struct device * dev = to_dev(kobj);
99 else if (dev->type && dev->type->release)
100 dev->type->release(dev);
101 else if (dev->class && dev->class->dev_release)
102 dev->class->dev_release(dev);
104 printk(KERN_ERR "Device '%s' does not have a release() function, "
105 "it is broken and must be fixed.\n",
111 static struct kobj_type ktype_device = {
112 .release = device_release,
113 .sysfs_ops = &dev_sysfs_ops,
117 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
119 struct kobj_type *ktype = get_ktype(kobj);
121 if (ktype == &ktype_device) {
122 struct device *dev = to_dev(kobj);
123 if (dev->uevent_suppress)
133 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
135 struct device *dev = to_dev(kobj);
138 return dev->bus->name;
140 return dev->class->name;
144 static int dev_uevent(struct kset *kset, struct kobject *kobj, char **envp,
145 int num_envp, char *buffer, int buffer_size)
147 struct device *dev = to_dev(kobj);
152 /* add the major/minor if present */
153 if (MAJOR(dev->devt)) {
154 add_uevent_var(envp, num_envp, &i,
155 buffer, buffer_size, &length,
156 "MAJOR=%u", MAJOR(dev->devt));
157 add_uevent_var(envp, num_envp, &i,
158 buffer, buffer_size, &length,
159 "MINOR=%u", MINOR(dev->devt));
162 if (dev->type && dev->type->name)
163 add_uevent_var(envp, num_envp, &i,
164 buffer, buffer_size, &length,
165 "DEVTYPE=%s", dev->type->name);
168 add_uevent_var(envp, num_envp, &i,
169 buffer, buffer_size, &length,
170 "DRIVER=%s", dev->driver->name);
172 #ifdef CONFIG_SYSFS_DEPRECATED
174 struct device *parent = dev->parent;
176 /* find first bus device in parent chain */
177 while (parent && !parent->bus)
178 parent = parent->parent;
179 if (parent && parent->bus) {
182 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
184 add_uevent_var(envp, num_envp, &i,
185 buffer, buffer_size, &length,
186 "PHYSDEVPATH=%s", path);
190 add_uevent_var(envp, num_envp, &i,
191 buffer, buffer_size, &length,
192 "PHYSDEVBUS=%s", parent->bus->name);
195 add_uevent_var(envp, num_envp, &i,
196 buffer, buffer_size, &length,
197 "PHYSDEVDRIVER=%s", parent->driver->name);
199 } else if (dev->bus) {
200 add_uevent_var(envp, num_envp, &i,
201 buffer, buffer_size, &length,
202 "PHYSDEVBUS=%s", dev->bus->name);
205 add_uevent_var(envp, num_envp, &i,
206 buffer, buffer_size, &length,
207 "PHYSDEVDRIVER=%s", dev->driver->name);
211 /* terminate, set to next free slot, shrink available space */
215 buffer = &buffer[length];
216 buffer_size -= length;
218 if (dev->bus && dev->bus->uevent) {
219 /* have the bus specific function add its stuff */
220 retval = dev->bus->uevent(dev, envp, num_envp, buffer, buffer_size);
222 pr_debug ("%s: bus uevent() returned %d\n",
223 __FUNCTION__, retval);
226 if (dev->class && dev->class->dev_uevent) {
227 /* have the class specific function add its stuff */
228 retval = dev->class->dev_uevent(dev, envp, num_envp, buffer, buffer_size);
230 pr_debug("%s: class uevent() returned %d\n",
231 __FUNCTION__, retval);
234 if (dev->type && dev->type->uevent) {
235 /* have the device type specific fuction add its stuff */
236 retval = dev->type->uevent(dev, envp, num_envp, buffer, buffer_size);
238 pr_debug("%s: dev_type uevent() returned %d\n",
239 __FUNCTION__, retval);
245 static struct kset_uevent_ops device_uevent_ops = {
246 .filter = dev_uevent_filter,
247 .name = dev_uevent_name,
248 .uevent = dev_uevent,
251 static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
254 struct kobject *top_kobj;
263 /* search the kset, the device belongs to */
264 top_kobj = &dev->kobj;
265 if (!top_kobj->kset && top_kobj->parent) {
267 top_kobj = top_kobj->parent;
268 } while (!top_kobj->kset && top_kobj->parent);
272 kset = top_kobj->kset;
273 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
277 if (kset->uevent_ops && kset->uevent_ops->filter)
278 if (!kset->uevent_ops->filter(kset, &dev->kobj))
281 data = (char *)get_zeroed_page(GFP_KERNEL);
285 /* let the kset specific function add its keys */
287 retval = kset->uevent_ops->uevent(kset, &dev->kobj,
288 envp, ARRAY_SIZE(envp),
293 /* copy keys to file */
294 for (i = 0; envp[i]; i++) {
296 count += sprintf(pos, "%s\n", envp[i]);
299 free_page((unsigned long)data);
303 static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
304 const char *buf, size_t count)
307 enum kobject_action action;
309 if (len && buf[len-1] == '\n')
312 for (action = 0; action < KOBJ_MAX; action++) {
313 if (strncmp(kobject_actions[action], buf, len) != 0)
315 if (kobject_actions[action][len] != '\0')
317 kobject_uevent(&dev->kobj, action);
321 dev_err(dev, "uevent: unsupported action-string; this will "
322 "be ignored in a future kernel version\n");
323 kobject_uevent(&dev->kobj, KOBJ_ADD);
328 static struct device_attribute uevent_attr =
329 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
331 static int device_add_attributes(struct device *dev,
332 struct device_attribute *attrs)
338 for (i = 0; attr_name(attrs[i]); i++) {
339 error = device_create_file(dev, &attrs[i]);
345 device_remove_file(dev, &attrs[i]);
350 static void device_remove_attributes(struct device *dev,
351 struct device_attribute *attrs)
356 for (i = 0; attr_name(attrs[i]); i++)
357 device_remove_file(dev, &attrs[i]);
360 static int device_add_groups(struct device *dev,
361 struct attribute_group **groups)
367 for (i = 0; groups[i]; i++) {
368 error = sysfs_create_group(&dev->kobj, groups[i]);
371 sysfs_remove_group(&dev->kobj, groups[i]);
379 static void device_remove_groups(struct device *dev,
380 struct attribute_group **groups)
385 for (i = 0; groups[i]; i++)
386 sysfs_remove_group(&dev->kobj, groups[i]);
389 static int device_add_attrs(struct device *dev)
391 struct class *class = dev->class;
392 struct device_type *type = dev->type;
396 error = device_add_attributes(dev, class->dev_attrs);
402 error = device_add_groups(dev, type->groups);
404 goto err_remove_class_attrs;
407 error = device_add_groups(dev, dev->groups);
409 goto err_remove_type_groups;
413 err_remove_type_groups:
415 device_remove_groups(dev, type->groups);
416 err_remove_class_attrs:
418 device_remove_attributes(dev, class->dev_attrs);
423 static void device_remove_attrs(struct device *dev)
425 struct class *class = dev->class;
426 struct device_type *type = dev->type;
428 device_remove_groups(dev, dev->groups);
431 device_remove_groups(dev, type->groups);
434 device_remove_attributes(dev, class->dev_attrs);
438 static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
441 return print_dev_t(buf, dev->devt);
444 static struct device_attribute devt_attr =
445 __ATTR(dev, S_IRUGO, show_dev, NULL);
448 * devices_subsys - structure to be registered with kobject core.
451 decl_subsys(devices, &ktype_device, &device_uevent_ops);
455 * device_create_file - create sysfs attribute file for device.
457 * @attr: device attribute descriptor.
460 int device_create_file(struct device * dev, struct device_attribute * attr)
463 if (get_device(dev)) {
464 error = sysfs_create_file(&dev->kobj, &attr->attr);
471 * device_remove_file - remove sysfs attribute file.
473 * @attr: device attribute descriptor.
476 void device_remove_file(struct device * dev, struct device_attribute * attr)
478 if (get_device(dev)) {
479 sysfs_remove_file(&dev->kobj, &attr->attr);
485 * device_create_bin_file - create sysfs binary attribute file for device.
487 * @attr: device binary attribute descriptor.
489 int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
493 error = sysfs_create_bin_file(&dev->kobj, attr);
496 EXPORT_SYMBOL_GPL(device_create_bin_file);
499 * device_remove_bin_file - remove sysfs binary attribute file
501 * @attr: device binary attribute descriptor.
503 void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
506 sysfs_remove_bin_file(&dev->kobj, attr);
508 EXPORT_SYMBOL_GPL(device_remove_bin_file);
511 * device_schedule_callback_owner - helper to schedule a callback for a device
513 * @func: callback function to invoke later.
514 * @owner: module owning the callback routine
516 * Attribute methods must not unregister themselves or their parent device
517 * (which would amount to the same thing). Attempts to do so will deadlock,
518 * since unregistration is mutually exclusive with driver callbacks.
520 * Instead methods can call this routine, which will attempt to allocate
521 * and schedule a workqueue request to call back @func with @dev as its
522 * argument in the workqueue's process context. @dev will be pinned until
525 * This routine is usually called via the inline device_schedule_callback(),
526 * which automatically sets @owner to THIS_MODULE.
528 * Returns 0 if the request was submitted, -ENOMEM if storage could not
529 * be allocated, -ENODEV if a reference to @owner isn't available.
531 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
532 * underlying sysfs routine (since it is intended for use by attribute
533 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
535 int device_schedule_callback_owner(struct device *dev,
536 void (*func)(struct device *), struct module *owner)
538 return sysfs_schedule_callback(&dev->kobj,
539 (void (*)(void *)) func, dev, owner);
541 EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
543 static void klist_children_get(struct klist_node *n)
545 struct device *dev = container_of(n, struct device, knode_parent);
550 static void klist_children_put(struct klist_node *n)
552 struct device *dev = container_of(n, struct device, knode_parent);
559 * device_initialize - init device structure.
562 * This prepares the device for use by other layers,
563 * including adding it to the device hierarchy.
564 * It is the first half of device_register(), if called by
565 * that, though it can also be called separately, so one
566 * may use @dev's fields (e.g. the refcount).
569 void device_initialize(struct device *dev)
571 kobj_set_kset_s(dev, devices_subsys);
572 kobject_init(&dev->kobj);
573 klist_init(&dev->klist_children, klist_children_get,
575 INIT_LIST_HEAD(&dev->dma_pools);
576 INIT_LIST_HEAD(&dev->node);
577 init_MUTEX(&dev->sem);
578 spin_lock_init(&dev->devres_lock);
579 INIT_LIST_HEAD(&dev->devres_head);
580 device_init_wakeup(dev, 0);
581 set_dev_node(dev, -1);
584 #ifdef CONFIG_SYSFS_DEPRECATED
585 static struct kobject * get_device_parent(struct device *dev,
586 struct device *parent)
588 /* Set the parent to the class, not the parent device */
589 /* this keeps sysfs from having a symlink to make old udevs happy */
591 return &dev->class->subsys.kobj;
593 return &parent->kobj;
598 static struct kobject *virtual_device_parent(struct device *dev)
600 static struct kobject *virtual_dir = NULL;
603 virtual_dir = kobject_add_dir(&devices_subsys.kobj, "virtual");
608 static struct kobject * get_device_parent(struct device *dev,
609 struct device *parent)
612 struct kobject *kobj = NULL;
613 struct kobject *parent_kobj;
617 * If we have no parent, we live in "virtual".
618 * Class-devices with a bus-device as parent, live
619 * in a class-directory to prevent namespace collisions.
622 parent_kobj = virtual_device_parent(dev);
623 else if (parent->class)
624 return &parent->kobj;
626 parent_kobj = &parent->kobj;
628 /* find our class-directory at the parent and reference it */
629 spin_lock(&dev->class->class_dirs.list_lock);
630 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
631 if (k->parent == parent_kobj) {
632 kobj = kobject_get(k);
635 spin_unlock(&dev->class->class_dirs.list_lock);
639 /* or create a new class-directory at the parent device */
640 return kobject_kset_add_dir(&dev->class->class_dirs,
641 parent_kobj, dev->class->name);
645 return &parent->kobj;
650 static int setup_parent(struct device *dev, struct device *parent)
652 struct kobject *kobj;
653 kobj = get_device_parent(dev, parent);
655 return PTR_ERR(kobj);
657 dev->kobj.parent = kobj;
661 static int device_add_class_symlinks(struct device *dev)
667 error = sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
672 * If this is not a "fake" compatible device, then create the
673 * symlink from the class to the device.
675 if (dev->kobj.parent != &dev->class->subsys.kobj) {
676 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
682 #ifdef CONFIG_SYSFS_DEPRECATED
684 struct device *parent = dev->parent;
688 * In old sysfs stacked class devices had 'device'
689 * link pointing to real device instead of parent
691 while (parent->class && !parent->bus && parent->parent)
692 parent = parent->parent;
694 error = sysfs_create_link(&dev->kobj,
700 class_name = make_class_name(dev->class->name,
703 error = sysfs_create_link(&dev->parent->kobj,
704 &dev->kobj, class_name);
710 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
718 #ifdef CONFIG_SYSFS_DEPRECATED
721 sysfs_remove_link(&dev->kobj, "device");
724 if (dev->kobj.parent != &dev->class->subsys.kobj)
725 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
727 sysfs_remove_link(&dev->kobj, "subsystem");
732 static void device_remove_class_symlinks(struct device *dev)
737 #ifdef CONFIG_SYSFS_DEPRECATED
740 class_name = make_class_name(dev->class->name, &dev->kobj);
742 sysfs_remove_link(&dev->parent->kobj, class_name);
746 sysfs_remove_link(&dev->kobj, "device");
748 if (dev->kobj.parent != &dev->class->subsys.kobj)
749 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
750 sysfs_remove_link(&dev->kobj, "subsystem");
754 * device_add - add device to device hierarchy.
757 * This is part 2 of device_register(), though may be called
758 * separately _iff_ device_initialize() has been called separately.
760 * This adds it to the kobject hierarchy via kobject_add(), adds it
761 * to the global and sibling lists for the device, then
762 * adds it to the other relevant subsystems of the driver model.
764 int device_add(struct device *dev)
766 struct device *parent = NULL;
767 struct class_interface *class_intf;
770 dev = get_device(dev);
771 if (!dev || !strlen(dev->bus_id))
774 pr_debug("DEV: registering device: ID = '%s'\n", dev->bus_id);
776 parent = get_device(dev->parent);
777 error = setup_parent(dev, parent);
781 /* first, register with generic layer. */
782 kobject_set_name(&dev->kobj, "%s", dev->bus_id);
783 error = kobject_add(&dev->kobj);
787 /* notify platform of device entry */
789 platform_notify(dev);
791 /* notify clients of device entry (new way) */
793 blocking_notifier_call_chain(&dev->bus->bus_notifier,
794 BUS_NOTIFY_ADD_DEVICE, dev);
796 error = device_create_file(dev, &uevent_attr);
800 if (MAJOR(dev->devt)) {
801 error = device_create_file(dev, &devt_attr);
803 goto ueventattrError;
806 error = device_add_class_symlinks(dev);
809 error = device_add_attrs(dev);
812 error = device_pm_add(dev);
815 error = bus_add_device(dev);
818 kobject_uevent(&dev->kobj, KOBJ_ADD);
819 bus_attach_device(dev);
821 klist_add_tail(&dev->knode_parent, &parent->klist_children);
824 down(&dev->class->sem);
825 /* tie the class to the device */
826 list_add_tail(&dev->node, &dev->class->devices);
828 /* notify any interfaces that the device is here */
829 list_for_each_entry(class_intf, &dev->class->interfaces, node)
830 if (class_intf->add_dev)
831 class_intf->add_dev(dev, class_intf);
832 up(&dev->class->sem);
838 device_pm_remove(dev);
841 blocking_notifier_call_chain(&dev->bus->bus_notifier,
842 BUS_NOTIFY_DEL_DEVICE, dev);
843 device_remove_attrs(dev);
845 device_remove_class_symlinks(dev);
847 if (MAJOR(dev->devt))
848 device_remove_file(dev, &devt_attr);
851 sysfs_remove_link(&dev->kobj, "subsystem");
852 /* If this is not a "fake" compatible device, remove the
853 * symlink from the class to the device. */
854 if (dev->kobj.parent != &dev->class->subsys.kobj)
855 sysfs_remove_link(&dev->class->subsys.kobj,
858 #ifdef CONFIG_SYSFS_DEPRECATED
859 char *class_name = make_class_name(dev->class->name,
862 sysfs_remove_link(&dev->parent->kobj,
866 sysfs_remove_link(&dev->kobj, "device");
870 device_remove_file(dev, &uevent_attr);
872 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
873 kobject_del(&dev->kobj);
882 * device_register - register a device with the system.
883 * @dev: pointer to the device structure
885 * This happens in two clean steps - initialize the device
886 * and add it to the system. The two steps can be called
887 * separately, but this is the easiest and most common.
888 * I.e. you should only call the two helpers separately if
889 * have a clearly defined need to use and refcount the device
890 * before it is added to the hierarchy.
893 int device_register(struct device *dev)
895 device_initialize(dev);
896 return device_add(dev);
901 * get_device - increment reference count for device.
904 * This simply forwards the call to kobject_get(), though
905 * we do take care to provide for the case that we get a NULL
909 struct device * get_device(struct device * dev)
911 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
916 * put_device - decrement reference count.
917 * @dev: device in question.
919 void put_device(struct device * dev)
922 kobject_put(&dev->kobj);
927 * device_del - delete device from system.
930 * This is the first part of the device unregistration
931 * sequence. This removes the device from the lists we control
932 * from here, has it removed from the other driver model
933 * subsystems it was added to in device_add(), and removes it
934 * from the kobject hierarchy.
936 * NOTE: this should be called manually _iff_ device_add() was
937 * also called manually.
940 void device_del(struct device * dev)
942 struct device * parent = dev->parent;
943 struct class_interface *class_intf;
946 klist_del(&dev->knode_parent);
947 if (MAJOR(dev->devt))
948 device_remove_file(dev, &devt_attr);
950 sysfs_remove_link(&dev->kobj, "subsystem");
951 /* If this is not a "fake" compatible device, remove the
952 * symlink from the class to the device. */
953 if (dev->kobj.parent != &dev->class->subsys.kobj)
954 sysfs_remove_link(&dev->class->subsys.kobj,
957 #ifdef CONFIG_SYSFS_DEPRECATED
958 char *class_name = make_class_name(dev->class->name,
961 sysfs_remove_link(&dev->parent->kobj,
965 sysfs_remove_link(&dev->kobj, "device");
968 down(&dev->class->sem);
969 /* notify any interfaces that the device is now gone */
970 list_for_each_entry(class_intf, &dev->class->interfaces, node)
971 if (class_intf->remove_dev)
972 class_intf->remove_dev(dev, class_intf);
973 /* remove the device from the class list */
974 list_del_init(&dev->node);
975 up(&dev->class->sem);
977 /* If we live in a parent class-directory, unreference it */
978 if (dev->kobj.parent->kset == &dev->class->class_dirs) {
983 * if we are the last child of our class, delete
984 * our class-directory at this parent
986 down(&dev->class->sem);
987 list_for_each_entry(d, &dev->class->devices, node) {
990 if (d->kobj.parent == dev->kobj.parent) {
996 kobject_del(dev->kobj.parent);
998 kobject_put(dev->kobj.parent);
999 up(&dev->class->sem);
1002 device_remove_file(dev, &uevent_attr);
1003 device_remove_attrs(dev);
1004 bus_remove_device(dev);
1007 * Some platform devices are driven without driver attached
1008 * and managed resources may have been acquired. Make sure
1009 * all resources are released.
1011 devres_release_all(dev);
1013 /* Notify the platform of the removal, in case they
1014 * need to do anything...
1016 if (platform_notify_remove)
1017 platform_notify_remove(dev);
1019 blocking_notifier_call_chain(&dev->bus->bus_notifier,
1020 BUS_NOTIFY_DEL_DEVICE, dev);
1021 device_pm_remove(dev);
1022 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
1023 kobject_del(&dev->kobj);
1029 * device_unregister - unregister device from system.
1030 * @dev: device going away.
1032 * We do this in two parts, like we do device_register(). First,
1033 * we remove it from all the subsystems with device_del(), then
1034 * we decrement the reference count via put_device(). If that
1035 * is the final reference count, the device will be cleaned up
1036 * via device_release() above. Otherwise, the structure will
1037 * stick around until the final reference to the device is dropped.
1039 void device_unregister(struct device * dev)
1041 pr_debug("DEV: Unregistering device. ID = '%s'\n", dev->bus_id);
1047 static struct device * next_device(struct klist_iter * i)
1049 struct klist_node * n = klist_next(i);
1050 return n ? container_of(n, struct device, knode_parent) : NULL;
1054 * device_for_each_child - device child iterator.
1055 * @parent: parent struct device.
1056 * @data: data for the callback.
1057 * @fn: function to be called for each device.
1059 * Iterate over @parent's child devices, and call @fn for each,
1062 * We check the return of @fn each time. If it returns anything
1063 * other than 0, we break out and return that value.
1065 int device_for_each_child(struct device * parent, void * data,
1066 int (*fn)(struct device *, void *))
1068 struct klist_iter i;
1069 struct device * child;
1072 klist_iter_init(&parent->klist_children, &i);
1073 while ((child = next_device(&i)) && !error)
1074 error = fn(child, data);
1075 klist_iter_exit(&i);
1080 * device_find_child - device iterator for locating a particular device.
1081 * @parent: parent struct device
1082 * @data: Data to pass to match function
1083 * @match: Callback function to check device
1085 * This is similar to the device_for_each_child() function above, but it
1086 * returns a reference to a device that is 'found' for later use, as
1087 * determined by the @match callback.
1089 * The callback should return 0 if the device doesn't match and non-zero
1090 * if it does. If the callback returns non-zero and a reference to the
1091 * current device can be obtained, this function will return to the caller
1092 * and not iterate over any more devices.
1094 struct device * device_find_child(struct device *parent, void *data,
1095 int (*match)(struct device *, void *))
1097 struct klist_iter i;
1098 struct device *child;
1103 klist_iter_init(&parent->klist_children, &i);
1104 while ((child = next_device(&i)))
1105 if (match(child, data) && get_device(child))
1107 klist_iter_exit(&i);
1111 int __init devices_init(void)
1113 return subsystem_register(&devices_subsys);
1116 EXPORT_SYMBOL_GPL(device_for_each_child);
1117 EXPORT_SYMBOL_GPL(device_find_child);
1119 EXPORT_SYMBOL_GPL(device_initialize);
1120 EXPORT_SYMBOL_GPL(device_add);
1121 EXPORT_SYMBOL_GPL(device_register);
1123 EXPORT_SYMBOL_GPL(device_del);
1124 EXPORT_SYMBOL_GPL(device_unregister);
1125 EXPORT_SYMBOL_GPL(get_device);
1126 EXPORT_SYMBOL_GPL(put_device);
1128 EXPORT_SYMBOL_GPL(device_create_file);
1129 EXPORT_SYMBOL_GPL(device_remove_file);
1132 static void device_create_release(struct device *dev)
1134 pr_debug("%s called for %s\n", __FUNCTION__, dev->bus_id);
1139 * device_create - creates a device and registers it with sysfs
1140 * @class: pointer to the struct class that this device should be registered to
1141 * @parent: pointer to the parent struct device of this new device, if any
1142 * @devt: the dev_t for the char device to be added
1143 * @fmt: string for the device's name
1145 * This function can be used by char device classes. A struct device
1146 * will be created in sysfs, registered to the specified class.
1148 * A "dev" file will be created, showing the dev_t for the device, if
1149 * the dev_t is not 0,0.
1150 * If a pointer to a parent struct device is passed in, the newly created
1151 * struct device will be a child of that device in sysfs.
1152 * The pointer to the struct device will be returned from the call.
1153 * Any further sysfs files that might be required can be created using this
1156 * Note: the struct class passed to this function must have previously
1157 * been created with a call to class_create().
1159 struct device *device_create(struct class *class, struct device *parent,
1160 dev_t devt, const char *fmt, ...)
1163 struct device *dev = NULL;
1164 int retval = -ENODEV;
1166 if (class == NULL || IS_ERR(class))
1169 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1177 dev->parent = parent;
1178 dev->release = device_create_release;
1180 va_start(args, fmt);
1181 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1183 retval = device_register(dev);
1191 return ERR_PTR(retval);
1193 EXPORT_SYMBOL_GPL(device_create);
1196 * device_destroy - removes a device that was created with device_create()
1197 * @class: pointer to the struct class that this device was registered with
1198 * @devt: the dev_t of the device that was previously registered
1200 * This call unregisters and cleans up a device that was created with a
1201 * call to device_create().
1203 void device_destroy(struct class *class, dev_t devt)
1205 struct device *dev = NULL;
1206 struct device *dev_tmp;
1209 list_for_each_entry(dev_tmp, &class->devices, node) {
1210 if (dev_tmp->devt == devt) {
1218 device_unregister(dev);
1220 EXPORT_SYMBOL_GPL(device_destroy);
1223 * device_rename - renames a device
1224 * @dev: the pointer to the struct device to be renamed
1225 * @new_name: the new name of the device
1227 int device_rename(struct device *dev, char *new_name)
1229 char *old_class_name = NULL;
1230 char *new_class_name = NULL;
1231 char *old_device_name = NULL;
1234 dev = get_device(dev);
1238 pr_debug("DEVICE: renaming '%s' to '%s'\n", dev->bus_id, new_name);
1240 #ifdef CONFIG_SYSFS_DEPRECATED
1241 if ((dev->class) && (dev->parent))
1242 old_class_name = make_class_name(dev->class->name, &dev->kobj);
1245 old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1246 if (!old_device_name) {
1250 strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
1251 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1253 error = kobject_rename(&dev->kobj, new_name);
1255 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1259 #ifdef CONFIG_SYSFS_DEPRECATED
1260 if (old_class_name) {
1261 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1262 if (new_class_name) {
1263 error = sysfs_create_link(&dev->parent->kobj,
1264 &dev->kobj, new_class_name);
1267 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1273 sysfs_remove_link(&dev->class->subsys.kobj, old_device_name);
1274 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
1277 /* Uh... how to unravel this if restoring can fail? */
1278 dev_err(dev, "%s: sysfs_create_symlink failed (%d)\n",
1279 __FUNCTION__, error);
1285 kfree(new_class_name);
1286 kfree(old_class_name);
1287 kfree(old_device_name);
1291 EXPORT_SYMBOL_GPL(device_rename);
1293 static int device_move_class_links(struct device *dev,
1294 struct device *old_parent,
1295 struct device *new_parent)
1298 #ifdef CONFIG_SYSFS_DEPRECATED
1301 class_name = make_class_name(dev->class->name, &dev->kobj);
1307 sysfs_remove_link(&dev->kobj, "device");
1308 sysfs_remove_link(&old_parent->kobj, class_name);
1311 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1315 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1318 sysfs_remove_link(&dev->kobj, "device");
1327 sysfs_remove_link(&dev->kobj, "device");
1329 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1336 * device_move - moves a device to a new parent
1337 * @dev: the pointer to the struct device to be moved
1338 * @new_parent: the new parent of the device (can by NULL)
1340 int device_move(struct device *dev, struct device *new_parent)
1343 struct device *old_parent;
1344 struct kobject *new_parent_kobj;
1346 dev = get_device(dev);
1350 new_parent = get_device(new_parent);
1351 new_parent_kobj = get_device_parent (dev, new_parent);
1352 if (IS_ERR(new_parent_kobj)) {
1353 error = PTR_ERR(new_parent_kobj);
1354 put_device(new_parent);
1357 pr_debug("DEVICE: moving '%s' to '%s'\n", dev->bus_id,
1358 new_parent ? new_parent->bus_id : "<NULL>");
1359 error = kobject_move(&dev->kobj, new_parent_kobj);
1361 put_device(new_parent);
1364 old_parent = dev->parent;
1365 dev->parent = new_parent;
1367 klist_remove(&dev->knode_parent);
1369 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
1372 error = device_move_class_links(dev, old_parent, new_parent);
1374 /* We ignore errors on cleanup since we're hosed anyway... */
1375 device_move_class_links(dev, new_parent, old_parent);
1376 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1378 klist_remove(&dev->knode_parent);
1380 klist_add_tail(&dev->knode_parent,
1381 &old_parent->klist_children);
1383 put_device(new_parent);
1387 put_device(old_parent);
1393 EXPORT_SYMBOL_GPL(device_move);