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/mutex.h>
24 #include <linux/async.h>
25 #include <linux/pm_runtime.h>
28 #include "power/power.h"
30 #ifdef CONFIG_SYSFS_DEPRECATED
31 #ifdef CONFIG_SYSFS_DEPRECATED_V2
32 long sysfs_deprecated
= 1;
34 long sysfs_deprecated
= 0;
36 static __init
int sysfs_deprecated_setup(char *arg
)
38 return strict_strtol(arg
, 10, &sysfs_deprecated
);
40 early_param("sysfs.deprecated", sysfs_deprecated_setup
);
43 int (*platform_notify
)(struct device
*dev
) = NULL
;
44 int (*platform_notify_remove
)(struct device
*dev
) = NULL
;
45 static struct kobject
*dev_kobj
;
46 struct kobject
*sysfs_dev_char_kobj
;
47 struct kobject
*sysfs_dev_block_kobj
;
50 static inline int device_is_not_partition(struct device
*dev
)
52 return !(dev
->type
== &part_type
);
55 static inline int device_is_not_partition(struct device
*dev
)
62 * dev_driver_string - Return a device's driver name, if at all possible
63 * @dev: struct device to get the name of
65 * Will return the device's driver's name if it is bound to a device. If
66 * the device is not bound to a device, it will return the name of the bus
67 * it is attached to. If it is not attached to a bus either, an empty
68 * string will be returned.
70 const char *dev_driver_string(const struct device
*dev
)
72 struct device_driver
*drv
;
74 /* dev->driver can change to NULL underneath us because of unbinding,
75 * so be careful about accessing it. dev->bus and dev->class should
76 * never change once they are set, so they don't need special care.
78 drv
= ACCESS_ONCE(dev
->driver
);
79 return drv
? drv
->name
:
80 (dev
->bus
? dev
->bus
->name
:
81 (dev
->class ? dev
->class->name
: ""));
83 EXPORT_SYMBOL(dev_driver_string
);
85 #define to_dev(obj) container_of(obj, struct device, kobj)
86 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
88 static ssize_t
dev_attr_show(struct kobject
*kobj
, struct attribute
*attr
,
91 struct device_attribute
*dev_attr
= to_dev_attr(attr
);
92 struct device
*dev
= to_dev(kobj
);
96 ret
= dev_attr
->show(dev
, dev_attr
, buf
);
97 if (ret
>= (ssize_t
)PAGE_SIZE
) {
98 print_symbol("dev_attr_show: %s returned bad count\n",
99 (unsigned long)dev_attr
->show
);
104 static ssize_t
dev_attr_store(struct kobject
*kobj
, struct attribute
*attr
,
105 const char *buf
, size_t count
)
107 struct device_attribute
*dev_attr
= to_dev_attr(attr
);
108 struct device
*dev
= to_dev(kobj
);
112 ret
= dev_attr
->store(dev
, dev_attr
, buf
, count
);
116 static const struct sysfs_ops dev_sysfs_ops
= {
117 .show
= dev_attr_show
,
118 .store
= dev_attr_store
,
123 * device_release - free device structure.
124 * @kobj: device's kobject.
126 * This is called once the reference count for the object
127 * reaches 0. We forward the call to the device's release
128 * method, which should handle actually freeing the structure.
130 static void device_release(struct kobject
*kobj
)
132 struct device
*dev
= to_dev(kobj
);
133 struct device_private
*p
= dev
->p
;
137 else if (dev
->type
&& dev
->type
->release
)
138 dev
->type
->release(dev
);
139 else if (dev
->class && dev
->class->dev_release
)
140 dev
->class->dev_release(dev
);
142 WARN(1, KERN_ERR
"Device '%s' does not have a release() "
143 "function, it is broken and must be fixed.\n",
148 static const void *device_namespace(struct kobject
*kobj
)
150 struct device
*dev
= to_dev(kobj
);
151 const void *ns
= NULL
;
153 if (dev
->class && dev
->class->ns_type
)
154 ns
= dev
->class->namespace(dev
);
159 static struct kobj_type device_ktype
= {
160 .release
= device_release
,
161 .sysfs_ops
= &dev_sysfs_ops
,
162 .namespace = device_namespace
,
166 static int dev_uevent_filter(struct kset
*kset
, struct kobject
*kobj
)
168 struct kobj_type
*ktype
= get_ktype(kobj
);
170 if (ktype
== &device_ktype
) {
171 struct device
*dev
= to_dev(kobj
);
180 static const char *dev_uevent_name(struct kset
*kset
, struct kobject
*kobj
)
182 struct device
*dev
= to_dev(kobj
);
185 return dev
->bus
->name
;
187 return dev
->class->name
;
191 static int dev_uevent(struct kset
*kset
, struct kobject
*kobj
,
192 struct kobj_uevent_env
*env
)
194 struct device
*dev
= to_dev(kobj
);
197 /* add device node properties if present */
198 if (MAJOR(dev
->devt
)) {
203 add_uevent_var(env
, "MAJOR=%u", MAJOR(dev
->devt
));
204 add_uevent_var(env
, "MINOR=%u", MINOR(dev
->devt
));
205 name
= device_get_devnode(dev
, &mode
, &tmp
);
207 add_uevent_var(env
, "DEVNAME=%s", name
);
210 add_uevent_var(env
, "DEVMODE=%#o", mode
& 0777);
214 if (dev
->type
&& dev
->type
->name
)
215 add_uevent_var(env
, "DEVTYPE=%s", dev
->type
->name
);
218 add_uevent_var(env
, "DRIVER=%s", dev
->driver
->name
);
220 /* have the bus specific function add its stuff */
221 if (dev
->bus
&& dev
->bus
->uevent
) {
222 retval
= dev
->bus
->uevent(dev
, env
);
224 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
225 dev_name(dev
), __func__
, retval
);
228 /* have the class specific function add its stuff */
229 if (dev
->class && dev
->class->dev_uevent
) {
230 retval
= dev
->class->dev_uevent(dev
, env
);
232 pr_debug("device: '%s': %s: class uevent() "
233 "returned %d\n", dev_name(dev
),
237 /* have the device type specific function add its stuff */
238 if (dev
->type
&& dev
->type
->uevent
) {
239 retval
= dev
->type
->uevent(dev
, env
);
241 pr_debug("device: '%s': %s: dev_type uevent() "
242 "returned %d\n", dev_name(dev
),
249 static const struct kset_uevent_ops device_uevent_ops
= {
250 .filter
= dev_uevent_filter
,
251 .name
= dev_uevent_name
,
252 .uevent
= dev_uevent
,
255 static ssize_t
show_uevent(struct device
*dev
, struct device_attribute
*attr
,
258 struct kobject
*top_kobj
;
260 struct kobj_uevent_env
*env
= NULL
;
265 /* search the kset, the device belongs to */
266 top_kobj
= &dev
->kobj
;
267 while (!top_kobj
->kset
&& top_kobj
->parent
)
268 top_kobj
= 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 env
= kzalloc(sizeof(struct kobj_uevent_env
), GFP_KERNEL
);
285 /* let the kset specific function add its keys */
286 retval
= kset
->uevent_ops
->uevent(kset
, &dev
->kobj
, env
);
290 /* copy keys to file */
291 for (i
= 0; i
< env
->envp_idx
; i
++)
292 count
+= sprintf(&buf
[count
], "%s\n", env
->envp
[i
]);
298 static ssize_t
store_uevent(struct device
*dev
, struct device_attribute
*attr
,
299 const char *buf
, size_t count
)
301 enum kobject_action action
;
303 if (kobject_action_type(buf
, count
, &action
) == 0)
304 kobject_uevent(&dev
->kobj
, action
);
306 dev_err(dev
, "uevent: unknown action-string\n");
310 static struct device_attribute uevent_attr
=
311 __ATTR(uevent
, S_IRUGO
| S_IWUSR
, show_uevent
, store_uevent
);
313 static int device_add_attributes(struct device
*dev
,
314 struct device_attribute
*attrs
)
320 for (i
= 0; attr_name(attrs
[i
]); i
++) {
321 error
= device_create_file(dev
, &attrs
[i
]);
327 device_remove_file(dev
, &attrs
[i
]);
332 static void device_remove_attributes(struct device
*dev
,
333 struct device_attribute
*attrs
)
338 for (i
= 0; attr_name(attrs
[i
]); i
++)
339 device_remove_file(dev
, &attrs
[i
]);
342 static int device_add_bin_attributes(struct device
*dev
,
343 struct bin_attribute
*attrs
)
349 for (i
= 0; attr_name(attrs
[i
]); i
++) {
350 error
= device_create_bin_file(dev
, &attrs
[i
]);
356 device_remove_bin_file(dev
, &attrs
[i
]);
361 static void device_remove_bin_attributes(struct device
*dev
,
362 struct bin_attribute
*attrs
)
367 for (i
= 0; attr_name(attrs
[i
]); i
++)
368 device_remove_bin_file(dev
, &attrs
[i
]);
371 static int device_add_groups(struct device
*dev
,
372 const struct attribute_group
**groups
)
378 for (i
= 0; groups
[i
]; i
++) {
379 error
= sysfs_create_group(&dev
->kobj
, groups
[i
]);
382 sysfs_remove_group(&dev
->kobj
,
391 static void device_remove_groups(struct device
*dev
,
392 const struct attribute_group
**groups
)
397 for (i
= 0; groups
[i
]; i
++)
398 sysfs_remove_group(&dev
->kobj
, groups
[i
]);
401 static int device_add_attrs(struct device
*dev
)
403 struct class *class = dev
->class;
404 const struct device_type
*type
= dev
->type
;
408 error
= device_add_attributes(dev
, class->dev_attrs
);
411 error
= device_add_bin_attributes(dev
, class->dev_bin_attrs
);
413 goto err_remove_class_attrs
;
417 error
= device_add_groups(dev
, type
->groups
);
419 goto err_remove_class_bin_attrs
;
422 error
= device_add_groups(dev
, dev
->groups
);
424 goto err_remove_type_groups
;
428 err_remove_type_groups
:
430 device_remove_groups(dev
, type
->groups
);
431 err_remove_class_bin_attrs
:
433 device_remove_bin_attributes(dev
, class->dev_bin_attrs
);
434 err_remove_class_attrs
:
436 device_remove_attributes(dev
, class->dev_attrs
);
441 static void device_remove_attrs(struct device
*dev
)
443 struct class *class = dev
->class;
444 const struct device_type
*type
= dev
->type
;
446 device_remove_groups(dev
, dev
->groups
);
449 device_remove_groups(dev
, type
->groups
);
452 device_remove_attributes(dev
, class->dev_attrs
);
453 device_remove_bin_attributes(dev
, class->dev_bin_attrs
);
458 static ssize_t
show_dev(struct device
*dev
, struct device_attribute
*attr
,
461 return print_dev_t(buf
, dev
->devt
);
464 static struct device_attribute devt_attr
=
465 __ATTR(dev
, S_IRUGO
, show_dev
, NULL
);
467 /* kset to create /sys/devices/ */
468 struct kset
*devices_kset
;
471 * device_create_file - create sysfs attribute file for device.
473 * @attr: device attribute descriptor.
475 int device_create_file(struct device
*dev
,
476 const struct device_attribute
*attr
)
480 error
= sysfs_create_file(&dev
->kobj
, &attr
->attr
);
485 * device_remove_file - remove sysfs attribute file.
487 * @attr: device attribute descriptor.
489 void device_remove_file(struct device
*dev
,
490 const struct device_attribute
*attr
)
493 sysfs_remove_file(&dev
->kobj
, &attr
->attr
);
497 * device_create_bin_file - create sysfs binary attribute file for device.
499 * @attr: device binary attribute descriptor.
501 int device_create_bin_file(struct device
*dev
,
502 const struct bin_attribute
*attr
)
506 error
= sysfs_create_bin_file(&dev
->kobj
, attr
);
509 EXPORT_SYMBOL_GPL(device_create_bin_file
);
512 * device_remove_bin_file - remove sysfs binary attribute file
514 * @attr: device binary attribute descriptor.
516 void device_remove_bin_file(struct device
*dev
,
517 const struct bin_attribute
*attr
)
520 sysfs_remove_bin_file(&dev
->kobj
, attr
);
522 EXPORT_SYMBOL_GPL(device_remove_bin_file
);
525 * device_schedule_callback_owner - helper to schedule a callback for a device
527 * @func: callback function to invoke later.
528 * @owner: module owning the callback routine
530 * Attribute methods must not unregister themselves or their parent device
531 * (which would amount to the same thing). Attempts to do so will deadlock,
532 * since unregistration is mutually exclusive with driver callbacks.
534 * Instead methods can call this routine, which will attempt to allocate
535 * and schedule a workqueue request to call back @func with @dev as its
536 * argument in the workqueue's process context. @dev will be pinned until
539 * This routine is usually called via the inline device_schedule_callback(),
540 * which automatically sets @owner to THIS_MODULE.
542 * Returns 0 if the request was submitted, -ENOMEM if storage could not
543 * be allocated, -ENODEV if a reference to @owner isn't available.
545 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
546 * underlying sysfs routine (since it is intended for use by attribute
547 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
549 int device_schedule_callback_owner(struct device
*dev
,
550 void (*func
)(struct device
*), struct module
*owner
)
552 return sysfs_schedule_callback(&dev
->kobj
,
553 (void (*)(void *)) func
, dev
, owner
);
555 EXPORT_SYMBOL_GPL(device_schedule_callback_owner
);
557 static void klist_children_get(struct klist_node
*n
)
559 struct device_private
*p
= to_device_private_parent(n
);
560 struct device
*dev
= p
->device
;
565 static void klist_children_put(struct klist_node
*n
)
567 struct device_private
*p
= to_device_private_parent(n
);
568 struct device
*dev
= p
->device
;
574 * device_initialize - init device structure.
577 * This prepares the device for use by other layers by initializing
579 * It is the first half of device_register(), if called by
580 * that function, though it can also be called separately, so one
581 * may use @dev's fields. In particular, get_device()/put_device()
582 * may be used for reference counting of @dev after calling this
585 * NOTE: Use put_device() to give up your reference instead of freeing
586 * @dev directly once you have called this function.
588 void device_initialize(struct device
*dev
)
590 dev
->kobj
.kset
= devices_kset
;
591 kobject_init(&dev
->kobj
, &device_ktype
);
592 INIT_LIST_HEAD(&dev
->dma_pools
);
593 mutex_init(&dev
->mutex
);
594 lockdep_set_novalidate_class(&dev
->mutex
);
595 spin_lock_init(&dev
->devres_lock
);
596 INIT_LIST_HEAD(&dev
->devres_head
);
598 set_dev_node(dev
, -1);
601 static struct kobject
*virtual_device_parent(struct device
*dev
)
603 static struct kobject
*virtual_dir
= NULL
;
606 virtual_dir
= kobject_create_and_add("virtual",
607 &devices_kset
->kobj
);
617 #define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
619 static void class_dir_release(struct kobject
*kobj
)
621 struct class_dir
*dir
= to_class_dir(kobj
);
626 struct kobj_ns_type_operations
*class_dir_child_ns_type(struct kobject
*kobj
)
628 struct class_dir
*dir
= to_class_dir(kobj
);
629 return dir
->class->ns_type
;
632 static struct kobj_type class_dir_ktype
= {
633 .release
= class_dir_release
,
634 .sysfs_ops
= &kobj_sysfs_ops
,
635 .child_ns_type
= class_dir_child_ns_type
638 static struct kobject
*
639 class_dir_create_and_add(struct class *class, struct kobject
*parent_kobj
)
641 struct class_dir
*dir
;
644 dir
= kzalloc(sizeof(*dir
), GFP_KERNEL
);
649 kobject_init(&dir
->kobj
, &class_dir_ktype
);
651 dir
->kobj
.kset
= &class->p
->glue_dirs
;
653 retval
= kobject_add(&dir
->kobj
, parent_kobj
, "%s", class->name
);
655 kobject_put(&dir
->kobj
);
662 static struct kobject
*get_device_parent(struct device
*dev
,
663 struct device
*parent
)
666 static DEFINE_MUTEX(gdp_mutex
);
667 struct kobject
*kobj
= NULL
;
668 struct kobject
*parent_kobj
;
672 /* block disks show up in /sys/block */
673 if (sysfs_deprecated
&& dev
->class == &block_class
) {
674 if (parent
&& parent
->class == &block_class
)
675 return &parent
->kobj
;
676 return &block_class
.p
->subsys
.kobj
;
681 * If we have no parent, we live in "virtual".
682 * Class-devices with a non class-device as parent, live
683 * in a "glue" directory to prevent namespace collisions.
686 parent_kobj
= virtual_device_parent(dev
);
687 else if (parent
->class && !dev
->class->ns_type
)
688 return &parent
->kobj
;
690 parent_kobj
= &parent
->kobj
;
692 mutex_lock(&gdp_mutex
);
694 /* find our class-directory at the parent and reference it */
695 spin_lock(&dev
->class->p
->glue_dirs
.list_lock
);
696 list_for_each_entry(k
, &dev
->class->p
->glue_dirs
.list
, entry
)
697 if (k
->parent
== parent_kobj
) {
698 kobj
= kobject_get(k
);
701 spin_unlock(&dev
->class->p
->glue_dirs
.list_lock
);
703 mutex_unlock(&gdp_mutex
);
707 /* or create a new class-directory at the parent device */
708 k
= class_dir_create_and_add(dev
->class, parent_kobj
);
709 /* do not emit an uevent for this simple "glue" directory */
710 mutex_unlock(&gdp_mutex
);
715 return &parent
->kobj
;
719 static void cleanup_glue_dir(struct device
*dev
, struct kobject
*glue_dir
)
721 /* see if we live in a "glue" directory */
722 if (!glue_dir
|| !dev
->class ||
723 glue_dir
->kset
!= &dev
->class->p
->glue_dirs
)
726 kobject_put(glue_dir
);
729 static void cleanup_device_parent(struct device
*dev
)
731 cleanup_glue_dir(dev
, dev
->kobj
.parent
);
734 static void setup_parent(struct device
*dev
, struct device
*parent
)
736 struct kobject
*kobj
;
737 kobj
= get_device_parent(dev
, parent
);
739 dev
->kobj
.parent
= kobj
;
742 static int device_add_class_symlinks(struct device
*dev
)
749 error
= sysfs_create_link(&dev
->kobj
,
750 &dev
->class->p
->subsys
.kobj
,
755 if (dev
->parent
&& device_is_not_partition(dev
)) {
756 error
= sysfs_create_link(&dev
->kobj
, &dev
->parent
->kobj
,
763 /* /sys/block has directories and does not need symlinks */
764 if (sysfs_deprecated
&& dev
->class == &block_class
)
768 /* link in the class directory pointing to the device */
769 error
= sysfs_create_link(&dev
->class->p
->subsys
.kobj
,
770 &dev
->kobj
, dev_name(dev
));
777 sysfs_remove_link(&dev
->kobj
, "device");
780 sysfs_remove_link(&dev
->kobj
, "subsystem");
785 static void device_remove_class_symlinks(struct device
*dev
)
790 if (dev
->parent
&& device_is_not_partition(dev
))
791 sysfs_remove_link(&dev
->kobj
, "device");
792 sysfs_remove_link(&dev
->kobj
, "subsystem");
794 if (sysfs_deprecated
&& dev
->class == &block_class
)
797 sysfs_delete_link(&dev
->class->p
->subsys
.kobj
, &dev
->kobj
, dev_name(dev
));
801 * dev_set_name - set a device name
803 * @fmt: format string for the device's name
805 int dev_set_name(struct device
*dev
, const char *fmt
, ...)
810 va_start(vargs
, fmt
);
811 err
= kobject_set_name_vargs(&dev
->kobj
, fmt
, vargs
);
815 EXPORT_SYMBOL_GPL(dev_set_name
);
818 * device_to_dev_kobj - select a /sys/dev/ directory for the device
821 * By default we select char/ for new entries. Setting class->dev_obj
822 * to NULL prevents an entry from being created. class->dev_kobj must
823 * be set (or cleared) before any devices are registered to the class
824 * otherwise device_create_sys_dev_entry() and
825 * device_remove_sys_dev_entry() will disagree about the the presence
828 static struct kobject
*device_to_dev_kobj(struct device
*dev
)
830 struct kobject
*kobj
;
833 kobj
= dev
->class->dev_kobj
;
835 kobj
= sysfs_dev_char_kobj
;
840 static int device_create_sys_dev_entry(struct device
*dev
)
842 struct kobject
*kobj
= device_to_dev_kobj(dev
);
847 format_dev_t(devt_str
, dev
->devt
);
848 error
= sysfs_create_link(kobj
, &dev
->kobj
, devt_str
);
854 static void device_remove_sys_dev_entry(struct device
*dev
)
856 struct kobject
*kobj
= device_to_dev_kobj(dev
);
860 format_dev_t(devt_str
, dev
->devt
);
861 sysfs_remove_link(kobj
, devt_str
);
865 int device_private_init(struct device
*dev
)
867 dev
->p
= kzalloc(sizeof(*dev
->p
), GFP_KERNEL
);
870 dev
->p
->device
= dev
;
871 klist_init(&dev
->p
->klist_children
, klist_children_get
,
877 * device_add - add device to device hierarchy.
880 * This is part 2 of device_register(), though may be called
881 * separately _iff_ device_initialize() has been called separately.
883 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
884 * to the global and sibling lists for the device, then
885 * adds it to the other relevant subsystems of the driver model.
887 * NOTE: _Never_ directly free @dev after calling this function, even
888 * if it returned an error! Always use put_device() to give up your
891 int device_add(struct device
*dev
)
893 struct device
*parent
= NULL
;
894 struct class_interface
*class_intf
;
897 dev
= get_device(dev
);
902 error
= device_private_init(dev
);
908 * for statically allocated devices, which should all be converted
909 * some day, we need to initialize the name. We prevent reading back
910 * the name, and force the use of dev_name()
912 if (dev
->init_name
) {
913 dev_set_name(dev
, "%s", dev
->init_name
);
914 dev
->init_name
= NULL
;
917 if (!dev_name(dev
)) {
922 pr_debug("device: '%s': %s\n", dev_name(dev
), __func__
);
924 parent
= get_device(dev
->parent
);
925 setup_parent(dev
, parent
);
927 /* use parent numa_node */
929 set_dev_node(dev
, dev_to_node(parent
));
931 /* first, register with generic layer. */
932 /* we require the name to be set before, and pass NULL */
933 error
= kobject_add(&dev
->kobj
, dev
->kobj
.parent
, NULL
);
937 /* notify platform of device entry */
939 platform_notify(dev
);
941 error
= device_create_file(dev
, &uevent_attr
);
945 if (MAJOR(dev
->devt
)) {
946 error
= device_create_file(dev
, &devt_attr
);
948 goto ueventattrError
;
950 error
= device_create_sys_dev_entry(dev
);
954 devtmpfs_create_node(dev
);
957 error
= device_add_class_symlinks(dev
);
960 error
= device_add_attrs(dev
);
963 error
= bus_add_device(dev
);
966 error
= dpm_sysfs_add(dev
);
971 /* Notify clients of device addition. This call must come
972 * after dpm_sysf_add() and before kobject_uevent().
975 blocking_notifier_call_chain(&dev
->bus
->p
->bus_notifier
,
976 BUS_NOTIFY_ADD_DEVICE
, dev
);
978 kobject_uevent(&dev
->kobj
, KOBJ_ADD
);
979 bus_probe_device(dev
);
981 klist_add_tail(&dev
->p
->knode_parent
,
982 &parent
->p
->klist_children
);
985 mutex_lock(&dev
->class->p
->class_mutex
);
986 /* tie the class to the device */
987 klist_add_tail(&dev
->knode_class
,
988 &dev
->class->p
->klist_devices
);
990 /* notify any interfaces that the device is here */
991 list_for_each_entry(class_intf
,
992 &dev
->class->p
->class_interfaces
, node
)
993 if (class_intf
->add_dev
)
994 class_intf
->add_dev(dev
, class_intf
);
995 mutex_unlock(&dev
->class->p
->class_mutex
);
1001 bus_remove_device(dev
);
1003 device_remove_attrs(dev
);
1005 device_remove_class_symlinks(dev
);
1007 if (MAJOR(dev
->devt
))
1008 devtmpfs_delete_node(dev
);
1009 if (MAJOR(dev
->devt
))
1010 device_remove_sys_dev_entry(dev
);
1012 if (MAJOR(dev
->devt
))
1013 device_remove_file(dev
, &devt_attr
);
1015 device_remove_file(dev
, &uevent_attr
);
1017 kobject_uevent(&dev
->kobj
, KOBJ_REMOVE
);
1018 kobject_del(&dev
->kobj
);
1020 cleanup_device_parent(dev
);
1030 * device_register - register a device with the system.
1031 * @dev: pointer to the device structure
1033 * This happens in two clean steps - initialize the device
1034 * and add it to the system. The two steps can be called
1035 * separately, but this is the easiest and most common.
1036 * I.e. you should only call the two helpers separately if
1037 * have a clearly defined need to use and refcount the device
1038 * before it is added to the hierarchy.
1040 * NOTE: _Never_ directly free @dev after calling this function, even
1041 * if it returned an error! Always use put_device() to give up the
1042 * reference initialized in this function instead.
1044 int device_register(struct device
*dev
)
1046 device_initialize(dev
);
1047 return device_add(dev
);
1051 * get_device - increment reference count for device.
1054 * This simply forwards the call to kobject_get(), though
1055 * we do take care to provide for the case that we get a NULL
1056 * pointer passed in.
1058 struct device
*get_device(struct device
*dev
)
1060 return dev
? to_dev(kobject_get(&dev
->kobj
)) : NULL
;
1064 * put_device - decrement reference count.
1065 * @dev: device in question.
1067 void put_device(struct device
*dev
)
1069 /* might_sleep(); */
1071 kobject_put(&dev
->kobj
);
1075 * device_del - delete device from system.
1078 * This is the first part of the device unregistration
1079 * sequence. This removes the device from the lists we control
1080 * from here, has it removed from the other driver model
1081 * subsystems it was added to in device_add(), and removes it
1082 * from the kobject hierarchy.
1084 * NOTE: this should be called manually _iff_ device_add() was
1085 * also called manually.
1087 void device_del(struct device
*dev
)
1089 struct device
*parent
= dev
->parent
;
1090 struct class_interface
*class_intf
;
1092 /* Notify clients of device removal. This call must come
1093 * before dpm_sysfs_remove().
1096 blocking_notifier_call_chain(&dev
->bus
->p
->bus_notifier
,
1097 BUS_NOTIFY_DEL_DEVICE
, dev
);
1098 device_pm_remove(dev
);
1099 dpm_sysfs_remove(dev
);
1101 klist_del(&dev
->p
->knode_parent
);
1102 if (MAJOR(dev
->devt
)) {
1103 devtmpfs_delete_node(dev
);
1104 device_remove_sys_dev_entry(dev
);
1105 device_remove_file(dev
, &devt_attr
);
1108 device_remove_class_symlinks(dev
);
1110 mutex_lock(&dev
->class->p
->class_mutex
);
1111 /* notify any interfaces that the device is now gone */
1112 list_for_each_entry(class_intf
,
1113 &dev
->class->p
->class_interfaces
, node
)
1114 if (class_intf
->remove_dev
)
1115 class_intf
->remove_dev(dev
, class_intf
);
1116 /* remove the device from the class list */
1117 klist_del(&dev
->knode_class
);
1118 mutex_unlock(&dev
->class->p
->class_mutex
);
1120 device_remove_file(dev
, &uevent_attr
);
1121 device_remove_attrs(dev
);
1122 bus_remove_device(dev
);
1125 * Some platform devices are driven without driver attached
1126 * and managed resources may have been acquired. Make sure
1127 * all resources are released.
1129 devres_release_all(dev
);
1131 /* Notify the platform of the removal, in case they
1132 * need to do anything...
1134 if (platform_notify_remove
)
1135 platform_notify_remove(dev
);
1136 kobject_uevent(&dev
->kobj
, KOBJ_REMOVE
);
1137 cleanup_device_parent(dev
);
1138 kobject_del(&dev
->kobj
);
1143 * device_unregister - unregister device from system.
1144 * @dev: device going away.
1146 * We do this in two parts, like we do device_register(). First,
1147 * we remove it from all the subsystems with device_del(), then
1148 * we decrement the reference count via put_device(). If that
1149 * is the final reference count, the device will be cleaned up
1150 * via device_release() above. Otherwise, the structure will
1151 * stick around until the final reference to the device is dropped.
1153 void device_unregister(struct device
*dev
)
1155 pr_debug("device: '%s': %s\n", dev_name(dev
), __func__
);
1160 static struct device
*next_device(struct klist_iter
*i
)
1162 struct klist_node
*n
= klist_next(i
);
1163 struct device
*dev
= NULL
;
1164 struct device_private
*p
;
1167 p
= to_device_private_parent(n
);
1174 * device_get_devnode - path of device node file
1176 * @mode: returned file access mode
1177 * @tmp: possibly allocated string
1179 * Return the relative path of a possible device node.
1180 * Non-default names may need to allocate a memory to compose
1181 * a name. This memory is returned in tmp and needs to be
1182 * freed by the caller.
1184 const char *device_get_devnode(struct device
*dev
,
1185 mode_t
*mode
, const char **tmp
)
1191 /* the device type may provide a specific name */
1192 if (dev
->type
&& dev
->type
->devnode
)
1193 *tmp
= dev
->type
->devnode(dev
, mode
);
1197 /* the class may provide a specific name */
1198 if (dev
->class && dev
->class->devnode
)
1199 *tmp
= dev
->class->devnode(dev
, mode
);
1203 /* return name without allocation, tmp == NULL */
1204 if (strchr(dev_name(dev
), '!') == NULL
)
1205 return dev_name(dev
);
1207 /* replace '!' in the name with '/' */
1208 *tmp
= kstrdup(dev_name(dev
), GFP_KERNEL
);
1211 while ((s
= strchr(*tmp
, '!')))
1217 * device_for_each_child - device child iterator.
1218 * @parent: parent struct device.
1219 * @data: data for the callback.
1220 * @fn: function to be called for each device.
1222 * Iterate over @parent's child devices, and call @fn for each,
1225 * We check the return of @fn each time. If it returns anything
1226 * other than 0, we break out and return that value.
1228 int device_for_each_child(struct device
*parent
, void *data
,
1229 int (*fn
)(struct device
*dev
, void *data
))
1231 struct klist_iter i
;
1232 struct device
*child
;
1238 klist_iter_init(&parent
->p
->klist_children
, &i
);
1239 while ((child
= next_device(&i
)) && !error
)
1240 error
= fn(child
, data
);
1241 klist_iter_exit(&i
);
1246 * device_find_child - device iterator for locating a particular device.
1247 * @parent: parent struct device
1248 * @data: Data to pass to match function
1249 * @match: Callback function to check device
1251 * This is similar to the device_for_each_child() function above, but it
1252 * returns a reference to a device that is 'found' for later use, as
1253 * determined by the @match callback.
1255 * The callback should return 0 if the device doesn't match and non-zero
1256 * if it does. If the callback returns non-zero and a reference to the
1257 * current device can be obtained, this function will return to the caller
1258 * and not iterate over any more devices.
1260 struct device
*device_find_child(struct device
*parent
, void *data
,
1261 int (*match
)(struct device
*dev
, void *data
))
1263 struct klist_iter i
;
1264 struct device
*child
;
1269 klist_iter_init(&parent
->p
->klist_children
, &i
);
1270 while ((child
= next_device(&i
)))
1271 if (match(child
, data
) && get_device(child
))
1273 klist_iter_exit(&i
);
1277 int __init
devices_init(void)
1279 devices_kset
= kset_create_and_add("devices", &device_uevent_ops
, NULL
);
1282 dev_kobj
= kobject_create_and_add("dev", NULL
);
1285 sysfs_dev_block_kobj
= kobject_create_and_add("block", dev_kobj
);
1286 if (!sysfs_dev_block_kobj
)
1287 goto block_kobj_err
;
1288 sysfs_dev_char_kobj
= kobject_create_and_add("char", dev_kobj
);
1289 if (!sysfs_dev_char_kobj
)
1295 kobject_put(sysfs_dev_block_kobj
);
1297 kobject_put(dev_kobj
);
1299 kset_unregister(devices_kset
);
1303 EXPORT_SYMBOL_GPL(device_for_each_child
);
1304 EXPORT_SYMBOL_GPL(device_find_child
);
1306 EXPORT_SYMBOL_GPL(device_initialize
);
1307 EXPORT_SYMBOL_GPL(device_add
);
1308 EXPORT_SYMBOL_GPL(device_register
);
1310 EXPORT_SYMBOL_GPL(device_del
);
1311 EXPORT_SYMBOL_GPL(device_unregister
);
1312 EXPORT_SYMBOL_GPL(get_device
);
1313 EXPORT_SYMBOL_GPL(put_device
);
1315 EXPORT_SYMBOL_GPL(device_create_file
);
1316 EXPORT_SYMBOL_GPL(device_remove_file
);
1318 struct root_device
{
1320 struct module
*owner
;
1323 inline struct root_device
*to_root_device(struct device
*d
)
1325 return container_of(d
, struct root_device
, dev
);
1328 static void root_device_release(struct device
*dev
)
1330 kfree(to_root_device(dev
));
1334 * __root_device_register - allocate and register a root device
1335 * @name: root device name
1336 * @owner: owner module of the root device, usually THIS_MODULE
1338 * This function allocates a root device and registers it
1339 * using device_register(). In order to free the returned
1340 * device, use root_device_unregister().
1342 * Root devices are dummy devices which allow other devices
1343 * to be grouped under /sys/devices. Use this function to
1344 * allocate a root device and then use it as the parent of
1345 * any device which should appear under /sys/devices/{name}
1347 * The /sys/devices/{name} directory will also contain a
1348 * 'module' symlink which points to the @owner directory
1351 * Returns &struct device pointer on success, or ERR_PTR() on error.
1353 * Note: You probably want to use root_device_register().
1355 struct device
*__root_device_register(const char *name
, struct module
*owner
)
1357 struct root_device
*root
;
1360 root
= kzalloc(sizeof(struct root_device
), GFP_KERNEL
);
1362 return ERR_PTR(err
);
1364 err
= dev_set_name(&root
->dev
, "%s", name
);
1367 return ERR_PTR(err
);
1370 root
->dev
.release
= root_device_release
;
1372 err
= device_register(&root
->dev
);
1374 put_device(&root
->dev
);
1375 return ERR_PTR(err
);
1378 #ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
1380 struct module_kobject
*mk
= &owner
->mkobj
;
1382 err
= sysfs_create_link(&root
->dev
.kobj
, &mk
->kobj
, "module");
1384 device_unregister(&root
->dev
);
1385 return ERR_PTR(err
);
1387 root
->owner
= owner
;
1393 EXPORT_SYMBOL_GPL(__root_device_register
);
1396 * root_device_unregister - unregister and free a root device
1397 * @dev: device going away
1399 * This function unregisters and cleans up a device that was created by
1400 * root_device_register().
1402 void root_device_unregister(struct device
*dev
)
1404 struct root_device
*root
= to_root_device(dev
);
1407 sysfs_remove_link(&root
->dev
.kobj
, "module");
1409 device_unregister(dev
);
1411 EXPORT_SYMBOL_GPL(root_device_unregister
);
1414 static void device_create_release(struct device
*dev
)
1416 pr_debug("device: '%s': %s\n", dev_name(dev
), __func__
);
1421 * device_create_vargs - creates a device and registers it with sysfs
1422 * @class: pointer to the struct class that this device should be registered to
1423 * @parent: pointer to the parent struct device of this new device, if any
1424 * @devt: the dev_t for the char device to be added
1425 * @drvdata: the data to be added to the device for callbacks
1426 * @fmt: string for the device's name
1427 * @args: va_list for the device's name
1429 * This function can be used by char device classes. A struct device
1430 * will be created in sysfs, registered to the specified class.
1432 * A "dev" file will be created, showing the dev_t for the device, if
1433 * the dev_t is not 0,0.
1434 * If a pointer to a parent struct device is passed in, the newly created
1435 * struct device will be a child of that device in sysfs.
1436 * The pointer to the struct device will be returned from the call.
1437 * Any further sysfs files that might be required can be created using this
1440 * Returns &struct device pointer on success, or ERR_PTR() on error.
1442 * Note: the struct class passed to this function must have previously
1443 * been created with a call to class_create().
1445 struct device
*device_create_vargs(struct class *class, struct device
*parent
,
1446 dev_t devt
, void *drvdata
, const char *fmt
,
1449 struct device
*dev
= NULL
;
1450 int retval
= -ENODEV
;
1452 if (class == NULL
|| IS_ERR(class))
1455 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
1463 dev
->parent
= parent
;
1464 dev
->release
= device_create_release
;
1465 dev_set_drvdata(dev
, drvdata
);
1467 retval
= kobject_set_name_vargs(&dev
->kobj
, fmt
, args
);
1471 retval
= device_register(dev
);
1479 return ERR_PTR(retval
);
1481 EXPORT_SYMBOL_GPL(device_create_vargs
);
1484 * device_create - creates a device and registers it with sysfs
1485 * @class: pointer to the struct class that this device should be registered to
1486 * @parent: pointer to the parent struct device of this new device, if any
1487 * @devt: the dev_t for the char device to be added
1488 * @drvdata: the data to be added to the device for callbacks
1489 * @fmt: string for the device's name
1491 * This function can be used by char device classes. A struct device
1492 * will be created in sysfs, registered to the specified class.
1494 * A "dev" file will be created, showing the dev_t for the device, if
1495 * the dev_t is not 0,0.
1496 * If a pointer to a parent struct device is passed in, the newly created
1497 * struct device will be a child of that device in sysfs.
1498 * The pointer to the struct device will be returned from the call.
1499 * Any further sysfs files that might be required can be created using this
1502 * Returns &struct device pointer on success, or ERR_PTR() on error.
1504 * Note: the struct class passed to this function must have previously
1505 * been created with a call to class_create().
1507 struct device
*device_create(struct class *class, struct device
*parent
,
1508 dev_t devt
, void *drvdata
, const char *fmt
, ...)
1513 va_start(vargs
, fmt
);
1514 dev
= device_create_vargs(class, parent
, devt
, drvdata
, fmt
, vargs
);
1518 EXPORT_SYMBOL_GPL(device_create
);
1520 static int __match_devt(struct device
*dev
, void *data
)
1524 return dev
->devt
== *devt
;
1528 * device_destroy - removes a device that was created with device_create()
1529 * @class: pointer to the struct class that this device was registered with
1530 * @devt: the dev_t of the device that was previously registered
1532 * This call unregisters and cleans up a device that was created with a
1533 * call to device_create().
1535 void device_destroy(struct class *class, dev_t devt
)
1539 dev
= class_find_device(class, NULL
, &devt
, __match_devt
);
1542 device_unregister(dev
);
1545 EXPORT_SYMBOL_GPL(device_destroy
);
1548 * device_rename - renames a device
1549 * @dev: the pointer to the struct device to be renamed
1550 * @new_name: the new name of the device
1552 * It is the responsibility of the caller to provide mutual
1553 * exclusion between two different calls of device_rename
1554 * on the same device to ensure that new_name is valid and
1555 * won't conflict with other devices.
1557 * Note: Don't call this function. Currently, the networking layer calls this
1558 * function, but that will change. The following text from Kay Sievers offers
1561 * Renaming devices is racy at many levels, symlinks and other stuff are not
1562 * replaced atomically, and you get a "move" uevent, but it's not easy to
1563 * connect the event to the old and new device. Device nodes are not renamed at
1564 * all, there isn't even support for that in the kernel now.
1566 * In the meantime, during renaming, your target name might be taken by another
1567 * driver, creating conflicts. Or the old name is taken directly after you
1568 * renamed it -- then you get events for the same DEVPATH, before you even see
1569 * the "move" event. It's just a mess, and nothing new should ever rely on
1570 * kernel device renaming. Besides that, it's not even implemented now for
1571 * other things than (driver-core wise very simple) network devices.
1573 * We are currently about to change network renaming in udev to completely
1574 * disallow renaming of devices in the same namespace as the kernel uses,
1575 * because we can't solve the problems properly, that arise with swapping names
1576 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
1577 * be allowed to some other name than eth[0-9]*, for the aforementioned
1580 * Make up a "real" name in the driver before you register anything, or add
1581 * some other attributes for userspace to find the device, or use udev to add
1582 * symlinks -- but never rename kernel devices later, it's a complete mess. We
1583 * don't even want to get into that and try to implement the missing pieces in
1584 * the core. We really have other pieces to fix in the driver core mess. :)
1586 int device_rename(struct device
*dev
, const char *new_name
)
1588 char *old_class_name
= NULL
;
1589 char *new_class_name
= NULL
;
1590 char *old_device_name
= NULL
;
1593 dev
= get_device(dev
);
1597 pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev
),
1598 __func__
, new_name
);
1600 old_device_name
= kstrdup(dev_name(dev
), GFP_KERNEL
);
1601 if (!old_device_name
) {
1607 error
= sysfs_rename_link(&dev
->class->p
->subsys
.kobj
,
1608 &dev
->kobj
, old_device_name
, new_name
);
1613 error
= kobject_rename(&dev
->kobj
, new_name
);
1620 kfree(new_class_name
);
1621 kfree(old_class_name
);
1622 kfree(old_device_name
);
1626 EXPORT_SYMBOL_GPL(device_rename
);
1628 static int device_move_class_links(struct device
*dev
,
1629 struct device
*old_parent
,
1630 struct device
*new_parent
)
1635 sysfs_remove_link(&dev
->kobj
, "device");
1637 error
= sysfs_create_link(&dev
->kobj
, &new_parent
->kobj
,
1643 * device_move - moves a device to a new parent
1644 * @dev: the pointer to the struct device to be moved
1645 * @new_parent: the new parent of the device (can by NULL)
1646 * @dpm_order: how to reorder the dpm_list
1648 int device_move(struct device
*dev
, struct device
*new_parent
,
1649 enum dpm_order dpm_order
)
1652 struct device
*old_parent
;
1653 struct kobject
*new_parent_kobj
;
1655 dev
= get_device(dev
);
1660 new_parent
= get_device(new_parent
);
1661 new_parent_kobj
= get_device_parent(dev
, new_parent
);
1663 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev
),
1664 __func__
, new_parent
? dev_name(new_parent
) : "<NULL>");
1665 error
= kobject_move(&dev
->kobj
, new_parent_kobj
);
1667 cleanup_glue_dir(dev
, new_parent_kobj
);
1668 put_device(new_parent
);
1671 old_parent
= dev
->parent
;
1672 dev
->parent
= new_parent
;
1674 klist_remove(&dev
->p
->knode_parent
);
1676 klist_add_tail(&dev
->p
->knode_parent
,
1677 &new_parent
->p
->klist_children
);
1678 set_dev_node(dev
, dev_to_node(new_parent
));
1683 error
= device_move_class_links(dev
, old_parent
, new_parent
);
1685 /* We ignore errors on cleanup since we're hosed anyway... */
1686 device_move_class_links(dev
, new_parent
, old_parent
);
1687 if (!kobject_move(&dev
->kobj
, &old_parent
->kobj
)) {
1689 klist_remove(&dev
->p
->knode_parent
);
1690 dev
->parent
= old_parent
;
1692 klist_add_tail(&dev
->p
->knode_parent
,
1693 &old_parent
->p
->klist_children
);
1694 set_dev_node(dev
, dev_to_node(old_parent
));
1697 cleanup_glue_dir(dev
, new_parent_kobj
);
1698 put_device(new_parent
);
1701 switch (dpm_order
) {
1702 case DPM_ORDER_NONE
:
1704 case DPM_ORDER_DEV_AFTER_PARENT
:
1705 device_pm_move_after(dev
, new_parent
);
1707 case DPM_ORDER_PARENT_BEFORE_DEV
:
1708 device_pm_move_before(new_parent
, dev
);
1710 case DPM_ORDER_DEV_LAST
:
1711 device_pm_move_last(dev
);
1715 put_device(old_parent
);
1721 EXPORT_SYMBOL_GPL(device_move
);
1724 * device_shutdown - call ->shutdown() on each device to shutdown.
1726 void device_shutdown(void)
1730 spin_lock(&devices_kset
->list_lock
);
1732 * Walk the devices list backward, shutting down each in turn.
1733 * Beware that device unplug events may also start pulling
1734 * devices offline, even as the system is shutting down.
1736 while (!list_empty(&devices_kset
->list
)) {
1737 dev
= list_entry(devices_kset
->list
.prev
, struct device
,
1741 * Make sure the device is off the kset list, in the
1742 * event that dev->*->shutdown() doesn't remove it.
1744 list_del_init(&dev
->kobj
.entry
);
1745 spin_unlock(&devices_kset
->list_lock
);
1746 /* Disable all device's runtime power management */
1747 pm_runtime_disable(dev
);
1749 if (dev
->bus
&& dev
->bus
->shutdown
) {
1750 dev_dbg(dev
, "shutdown\n");
1751 dev
->bus
->shutdown(dev
);
1752 } else if (dev
->driver
&& dev
->driver
->shutdown
) {
1753 dev_dbg(dev
, "shutdown\n");
1754 dev
->driver
->shutdown(dev
);
1758 spin_lock(&devices_kset
->list_lock
);
1760 spin_unlock(&devices_kset
->list_lock
);
1761 async_synchronize_full();
1765 * Device logging functions
1768 #ifdef CONFIG_PRINTK
1770 static int __dev_printk(const char *level
, const struct device
*dev
,
1771 struct va_format
*vaf
)
1774 return printk("%s(NULL device *): %pV", level
, vaf
);
1776 return printk("%s%s %s: %pV",
1777 level
, dev_driver_string(dev
), dev_name(dev
), vaf
);
1780 int dev_printk(const char *level
, const struct device
*dev
,
1781 const char *fmt
, ...)
1783 struct va_format vaf
;
1787 va_start(args
, fmt
);
1792 r
= __dev_printk(level
, dev
, &vaf
);
1797 EXPORT_SYMBOL(dev_printk
);
1799 #define define_dev_printk_level(func, kern_level) \
1800 int func(const struct device *dev, const char *fmt, ...) \
1802 struct va_format vaf; \
1806 va_start(args, fmt); \
1811 r = __dev_printk(kern_level, dev, &vaf); \
1816 EXPORT_SYMBOL(func);
1818 define_dev_printk_level(dev_emerg
, KERN_EMERG
);
1819 define_dev_printk_level(dev_alert
, KERN_ALERT
);
1820 define_dev_printk_level(dev_crit
, KERN_CRIT
);
1821 define_dev_printk_level(dev_err
, KERN_ERR
);
1822 define_dev_printk_level(dev_warn
, KERN_WARNING
);
1823 define_dev_printk_level(dev_notice
, KERN_NOTICE
);
1824 define_dev_printk_level(_dev_info
, KERN_INFO
);