2 * drivers/base/core.c - core driver model code (device registration, etc)
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
6 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2006 Novell, Inc.
9 * This file is released under the GPLv2
13 #include <linux/device.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/slab.h>
18 #include <linux/string.h>
19 #include <linux/kdev_t.h>
20 #include <linux/notifier.h>
21 #include <linux/genhd.h>
22 #include <linux/kallsyms.h>
23 #include <linux/semaphore.h>
24 #include <linux/mutex.h>
27 #include "power/power.h"
29 int (*platform_notify
)(struct device
*dev
) = NULL
;
30 int (*platform_notify_remove
)(struct device
*dev
) = NULL
;
31 static struct kobject
*dev_kobj
;
32 struct kobject
*sysfs_dev_char_kobj
;
33 struct kobject
*sysfs_dev_block_kobj
;
36 static inline int device_is_not_partition(struct device
*dev
)
38 return !(dev
->type
== &part_type
);
41 static inline int device_is_not_partition(struct device
*dev
)
48 * dev_driver_string - Return a device's driver name, if at all possible
49 * @dev: struct device to get the name of
51 * Will return the device's driver's name if it is bound to a device. If
52 * the device is not bound to a device, it will return the name of the bus
53 * it is attached to. If it is not attached to a bus either, an empty
54 * string will be returned.
56 const char *dev_driver_string(const struct device
*dev
)
58 return dev
->driver
? dev
->driver
->name
:
59 (dev
->bus
? dev
->bus
->name
:
60 (dev
->class ? dev
->class->name
: ""));
62 EXPORT_SYMBOL(dev_driver_string
);
64 #define to_dev(obj) container_of(obj, struct device, kobj)
65 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
67 static ssize_t
dev_attr_show(struct kobject
*kobj
, struct attribute
*attr
,
70 struct device_attribute
*dev_attr
= to_dev_attr(attr
);
71 struct device
*dev
= to_dev(kobj
);
75 ret
= dev_attr
->show(dev
, dev_attr
, buf
);
76 if (ret
>= (ssize_t
)PAGE_SIZE
) {
77 print_symbol("dev_attr_show: %s returned bad count\n",
78 (unsigned long)dev_attr
->show
);
83 static ssize_t
dev_attr_store(struct kobject
*kobj
, struct attribute
*attr
,
84 const char *buf
, size_t count
)
86 struct device_attribute
*dev_attr
= to_dev_attr(attr
);
87 struct device
*dev
= to_dev(kobj
);
91 ret
= dev_attr
->store(dev
, dev_attr
, buf
, count
);
95 static struct sysfs_ops dev_sysfs_ops
= {
96 .show
= dev_attr_show
,
97 .store
= dev_attr_store
,
102 * device_release - free device structure.
103 * @kobj: device's kobject.
105 * This is called once the reference count for the object
106 * reaches 0. We forward the call to the device's release
107 * method, which should handle actually freeing the structure.
109 static void device_release(struct kobject
*kobj
)
111 struct device
*dev
= to_dev(kobj
);
115 else if (dev
->type
&& dev
->type
->release
)
116 dev
->type
->release(dev
);
117 else if (dev
->class && dev
->class->dev_release
)
118 dev
->class->dev_release(dev
);
120 WARN(1, KERN_ERR
"Device '%s' does not have a release() "
121 "function, it is broken and must be fixed.\n",
125 static struct kobj_type device_ktype
= {
126 .release
= device_release
,
127 .sysfs_ops
= &dev_sysfs_ops
,
131 static int dev_uevent_filter(struct kset
*kset
, struct kobject
*kobj
)
133 struct kobj_type
*ktype
= get_ktype(kobj
);
135 if (ktype
== &device_ktype
) {
136 struct device
*dev
= to_dev(kobj
);
137 if (dev
->uevent_suppress
)
147 static const char *dev_uevent_name(struct kset
*kset
, struct kobject
*kobj
)
149 struct device
*dev
= to_dev(kobj
);
152 return dev
->bus
->name
;
154 return dev
->class->name
;
158 static int dev_uevent(struct kset
*kset
, struct kobject
*kobj
,
159 struct kobj_uevent_env
*env
)
161 struct device
*dev
= to_dev(kobj
);
164 /* add the major/minor if present */
165 if (MAJOR(dev
->devt
)) {
166 add_uevent_var(env
, "MAJOR=%u", MAJOR(dev
->devt
));
167 add_uevent_var(env
, "MINOR=%u", MINOR(dev
->devt
));
170 if (dev
->type
&& dev
->type
->name
)
171 add_uevent_var(env
, "DEVTYPE=%s", dev
->type
->name
);
174 add_uevent_var(env
, "DRIVER=%s", dev
->driver
->name
);
176 #ifdef CONFIG_SYSFS_DEPRECATED
178 struct device
*parent
= dev
->parent
;
180 /* find first bus device in parent chain */
181 while (parent
&& !parent
->bus
)
182 parent
= parent
->parent
;
183 if (parent
&& parent
->bus
) {
186 path
= kobject_get_path(&parent
->kobj
, GFP_KERNEL
);
188 add_uevent_var(env
, "PHYSDEVPATH=%s", path
);
192 add_uevent_var(env
, "PHYSDEVBUS=%s", parent
->bus
->name
);
195 add_uevent_var(env
, "PHYSDEVDRIVER=%s",
196 parent
->driver
->name
);
198 } else if (dev
->bus
) {
199 add_uevent_var(env
, "PHYSDEVBUS=%s", dev
->bus
->name
);
202 add_uevent_var(env
, "PHYSDEVDRIVER=%s",
207 /* have the bus specific function add its stuff */
208 if (dev
->bus
&& dev
->bus
->uevent
) {
209 retval
= dev
->bus
->uevent(dev
, env
);
211 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
212 dev_name(dev
), __func__
, retval
);
215 /* have the class specific function add its stuff */
216 if (dev
->class && dev
->class->dev_uevent
) {
217 retval
= dev
->class->dev_uevent(dev
, env
);
219 pr_debug("device: '%s': %s: class uevent() "
220 "returned %d\n", dev_name(dev
),
224 /* have the device type specific fuction add its stuff */
225 if (dev
->type
&& dev
->type
->uevent
) {
226 retval
= dev
->type
->uevent(dev
, env
);
228 pr_debug("device: '%s': %s: dev_type uevent() "
229 "returned %d\n", dev_name(dev
),
236 static struct kset_uevent_ops device_uevent_ops
= {
237 .filter
= dev_uevent_filter
,
238 .name
= dev_uevent_name
,
239 .uevent
= dev_uevent
,
242 static ssize_t
show_uevent(struct device
*dev
, struct device_attribute
*attr
,
245 struct kobject
*top_kobj
;
247 struct kobj_uevent_env
*env
= NULL
;
252 /* search the kset, the device belongs to */
253 top_kobj
= &dev
->kobj
;
254 while (!top_kobj
->kset
&& top_kobj
->parent
)
255 top_kobj
= top_kobj
->parent
;
259 kset
= top_kobj
->kset
;
260 if (!kset
->uevent_ops
|| !kset
->uevent_ops
->uevent
)
264 if (kset
->uevent_ops
&& kset
->uevent_ops
->filter
)
265 if (!kset
->uevent_ops
->filter(kset
, &dev
->kobj
))
268 env
= kzalloc(sizeof(struct kobj_uevent_env
), GFP_KERNEL
);
272 /* let the kset specific function add its keys */
273 retval
= kset
->uevent_ops
->uevent(kset
, &dev
->kobj
, env
);
277 /* copy keys to file */
278 for (i
= 0; i
< env
->envp_idx
; i
++)
279 count
+= sprintf(&buf
[count
], "%s\n", env
->envp
[i
]);
285 static ssize_t
store_uevent(struct device
*dev
, struct device_attribute
*attr
,
286 const char *buf
, size_t count
)
288 enum kobject_action action
;
290 if (kobject_action_type(buf
, count
, &action
) == 0) {
291 kobject_uevent(&dev
->kobj
, action
);
295 dev_err(dev
, "uevent: unsupported action-string; this will "
296 "be ignored in a future kernel version\n");
297 kobject_uevent(&dev
->kobj
, KOBJ_ADD
);
302 static struct device_attribute uevent_attr
=
303 __ATTR(uevent
, S_IRUGO
| S_IWUSR
, show_uevent
, store_uevent
);
305 static int device_add_attributes(struct device
*dev
,
306 struct device_attribute
*attrs
)
312 for (i
= 0; attr_name(attrs
[i
]); i
++) {
313 error
= device_create_file(dev
, &attrs
[i
]);
319 device_remove_file(dev
, &attrs
[i
]);
324 static void device_remove_attributes(struct device
*dev
,
325 struct device_attribute
*attrs
)
330 for (i
= 0; attr_name(attrs
[i
]); i
++)
331 device_remove_file(dev
, &attrs
[i
]);
334 static int device_add_groups(struct device
*dev
,
335 struct attribute_group
**groups
)
341 for (i
= 0; groups
[i
]; i
++) {
342 error
= sysfs_create_group(&dev
->kobj
, groups
[i
]);
345 sysfs_remove_group(&dev
->kobj
,
354 static void device_remove_groups(struct device
*dev
,
355 struct attribute_group
**groups
)
360 for (i
= 0; groups
[i
]; i
++)
361 sysfs_remove_group(&dev
->kobj
, groups
[i
]);
364 static int device_add_attrs(struct device
*dev
)
366 struct class *class = dev
->class;
367 struct device_type
*type
= dev
->type
;
371 error
= device_add_attributes(dev
, class->dev_attrs
);
377 error
= device_add_groups(dev
, type
->groups
);
379 goto err_remove_class_attrs
;
382 error
= device_add_groups(dev
, dev
->groups
);
384 goto err_remove_type_groups
;
388 err_remove_type_groups
:
390 device_remove_groups(dev
, type
->groups
);
391 err_remove_class_attrs
:
393 device_remove_attributes(dev
, class->dev_attrs
);
398 static void device_remove_attrs(struct device
*dev
)
400 struct class *class = dev
->class;
401 struct device_type
*type
= dev
->type
;
403 device_remove_groups(dev
, dev
->groups
);
406 device_remove_groups(dev
, type
->groups
);
409 device_remove_attributes(dev
, class->dev_attrs
);
413 static ssize_t
show_dev(struct device
*dev
, struct device_attribute
*attr
,
416 return print_dev_t(buf
, dev
->devt
);
419 static struct device_attribute devt_attr
=
420 __ATTR(dev
, S_IRUGO
, show_dev
, NULL
);
422 /* kset to create /sys/devices/ */
423 struct kset
*devices_kset
;
426 * device_create_file - create sysfs attribute file for device.
428 * @attr: device attribute descriptor.
430 int device_create_file(struct device
*dev
, struct device_attribute
*attr
)
434 error
= sysfs_create_file(&dev
->kobj
, &attr
->attr
);
439 * device_remove_file - remove sysfs attribute file.
441 * @attr: device attribute descriptor.
443 void device_remove_file(struct device
*dev
, struct device_attribute
*attr
)
446 sysfs_remove_file(&dev
->kobj
, &attr
->attr
);
450 * device_create_bin_file - create sysfs binary attribute file for device.
452 * @attr: device binary attribute descriptor.
454 int device_create_bin_file(struct device
*dev
, struct bin_attribute
*attr
)
458 error
= sysfs_create_bin_file(&dev
->kobj
, attr
);
461 EXPORT_SYMBOL_GPL(device_create_bin_file
);
464 * device_remove_bin_file - remove sysfs binary attribute file
466 * @attr: device binary attribute descriptor.
468 void device_remove_bin_file(struct device
*dev
, struct bin_attribute
*attr
)
471 sysfs_remove_bin_file(&dev
->kobj
, attr
);
473 EXPORT_SYMBOL_GPL(device_remove_bin_file
);
476 * device_schedule_callback_owner - helper to schedule a callback for a device
478 * @func: callback function to invoke later.
479 * @owner: module owning the callback routine
481 * Attribute methods must not unregister themselves or their parent device
482 * (which would amount to the same thing). Attempts to do so will deadlock,
483 * since unregistration is mutually exclusive with driver callbacks.
485 * Instead methods can call this routine, which will attempt to allocate
486 * and schedule a workqueue request to call back @func with @dev as its
487 * argument in the workqueue's process context. @dev will be pinned until
490 * This routine is usually called via the inline device_schedule_callback(),
491 * which automatically sets @owner to THIS_MODULE.
493 * Returns 0 if the request was submitted, -ENOMEM if storage could not
494 * be allocated, -ENODEV if a reference to @owner isn't available.
496 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
497 * underlying sysfs routine (since it is intended for use by attribute
498 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
500 int device_schedule_callback_owner(struct device
*dev
,
501 void (*func
)(struct device
*), struct module
*owner
)
503 return sysfs_schedule_callback(&dev
->kobj
,
504 (void (*)(void *)) func
, dev
, owner
);
506 EXPORT_SYMBOL_GPL(device_schedule_callback_owner
);
508 static void klist_children_get(struct klist_node
*n
)
510 struct device
*dev
= container_of(n
, struct device
, knode_parent
);
515 static void klist_children_put(struct klist_node
*n
)
517 struct device
*dev
= container_of(n
, struct device
, knode_parent
);
523 * device_initialize - init device structure.
526 * This prepares the device for use by other layers by initializing
528 * It is the first half of device_register(), if called by
529 * that function, though it can also be called separately, so one
530 * may use @dev's fields. In particular, get_device()/put_device()
531 * may be used for reference counting of @dev after calling this
534 * NOTE: Use put_device() to give up your reference instead of freeing
535 * @dev directly once you have called this function.
537 void device_initialize(struct device
*dev
)
539 dev
->kobj
.kset
= devices_kset
;
540 kobject_init(&dev
->kobj
, &device_ktype
);
541 klist_init(&dev
->klist_children
, klist_children_get
,
543 INIT_LIST_HEAD(&dev
->dma_pools
);
544 init_MUTEX(&dev
->sem
);
545 spin_lock_init(&dev
->devres_lock
);
546 INIT_LIST_HEAD(&dev
->devres_head
);
547 device_init_wakeup(dev
, 0);
549 set_dev_node(dev
, -1);
552 #ifdef CONFIG_SYSFS_DEPRECATED
553 static struct kobject
*get_device_parent(struct device
*dev
,
554 struct device
*parent
)
556 /* class devices without a parent live in /sys/class/<classname>/ */
557 if (dev
->class && (!parent
|| parent
->class != dev
->class))
558 return &dev
->class->p
->class_subsys
.kobj
;
559 /* all other devices keep their parent */
561 return &parent
->kobj
;
566 static inline void cleanup_device_parent(struct device
*dev
) {}
567 static inline void cleanup_glue_dir(struct device
*dev
,
568 struct kobject
*glue_dir
) {}
570 static struct kobject
*virtual_device_parent(struct device
*dev
)
572 static struct kobject
*virtual_dir
= NULL
;
575 virtual_dir
= kobject_create_and_add("virtual",
576 &devices_kset
->kobj
);
581 static struct kobject
*get_device_parent(struct device
*dev
,
582 struct device
*parent
)
587 struct kobject
*kobj
= NULL
;
588 struct kobject
*parent_kobj
;
592 * If we have no parent, we live in "virtual".
593 * Class-devices with a non class-device as parent, live
594 * in a "glue" directory to prevent namespace collisions.
597 parent_kobj
= virtual_device_parent(dev
);
598 else if (parent
->class)
599 return &parent
->kobj
;
601 parent_kobj
= &parent
->kobj
;
603 /* find our class-directory at the parent and reference it */
604 spin_lock(&dev
->class->p
->class_dirs
.list_lock
);
605 list_for_each_entry(k
, &dev
->class->p
->class_dirs
.list
, entry
)
606 if (k
->parent
== parent_kobj
) {
607 kobj
= kobject_get(k
);
610 spin_unlock(&dev
->class->p
->class_dirs
.list_lock
);
614 /* or create a new class-directory at the parent device */
615 k
= kobject_create();
618 k
->kset
= &dev
->class->p
->class_dirs
;
619 retval
= kobject_add(k
, parent_kobj
, "%s", dev
->class->name
);
624 /* do not emit an uevent for this simple "glue" directory */
629 return &parent
->kobj
;
633 static void cleanup_glue_dir(struct device
*dev
, struct kobject
*glue_dir
)
635 /* see if we live in a "glue" directory */
636 if (!glue_dir
|| !dev
->class ||
637 glue_dir
->kset
!= &dev
->class->p
->class_dirs
)
640 kobject_put(glue_dir
);
643 static void cleanup_device_parent(struct device
*dev
)
645 cleanup_glue_dir(dev
, dev
->kobj
.parent
);
649 static void setup_parent(struct device
*dev
, struct device
*parent
)
651 struct kobject
*kobj
;
652 kobj
= get_device_parent(dev
, parent
);
654 dev
->kobj
.parent
= kobj
;
657 static int device_add_class_symlinks(struct device
*dev
)
664 error
= sysfs_create_link(&dev
->kobj
,
665 &dev
->class->p
->class_subsys
.kobj
,
670 #ifdef CONFIG_SYSFS_DEPRECATED
671 /* stacked class devices need a symlink in the class directory */
672 if (dev
->kobj
.parent
!= &dev
->class->p
->class_subsys
.kobj
&&
673 device_is_not_partition(dev
)) {
674 error
= sysfs_create_link(&dev
->class->p
->class_subsys
.kobj
,
675 &dev
->kobj
, dev_name(dev
));
680 if (dev
->parent
&& device_is_not_partition(dev
)) {
681 struct device
*parent
= dev
->parent
;
685 * stacked class devices have the 'device' link
686 * pointing to the bus device instead of the parent
688 while (parent
->class && !parent
->bus
&& parent
->parent
)
689 parent
= parent
->parent
;
691 error
= sysfs_create_link(&dev
->kobj
,
697 class_name
= make_class_name(dev
->class->name
,
700 error
= sysfs_create_link(&dev
->parent
->kobj
,
701 &dev
->kobj
, class_name
);
709 if (dev
->parent
&& device_is_not_partition(dev
))
710 sysfs_remove_link(&dev
->kobj
, "device");
712 if (dev
->kobj
.parent
!= &dev
->class->p
->class_subsys
.kobj
&&
713 device_is_not_partition(dev
))
714 sysfs_remove_link(&dev
->class->p
->class_subsys
.kobj
,
717 /* link in the class directory pointing to the device */
718 error
= sysfs_create_link(&dev
->class->p
->class_subsys
.kobj
,
719 &dev
->kobj
, dev_name(dev
));
723 if (dev
->parent
&& device_is_not_partition(dev
)) {
724 error
= sysfs_create_link(&dev
->kobj
, &dev
->parent
->kobj
,
732 sysfs_remove_link(&dev
->class->p
->class_subsys
.kobj
, dev_name(dev
));
736 sysfs_remove_link(&dev
->kobj
, "subsystem");
741 static void device_remove_class_symlinks(struct device
*dev
)
746 #ifdef CONFIG_SYSFS_DEPRECATED
747 if (dev
->parent
&& device_is_not_partition(dev
)) {
750 class_name
= make_class_name(dev
->class->name
, &dev
->kobj
);
752 sysfs_remove_link(&dev
->parent
->kobj
, class_name
);
755 sysfs_remove_link(&dev
->kobj
, "device");
758 if (dev
->kobj
.parent
!= &dev
->class->p
->class_subsys
.kobj
&&
759 device_is_not_partition(dev
))
760 sysfs_remove_link(&dev
->class->p
->class_subsys
.kobj
,
763 if (dev
->parent
&& device_is_not_partition(dev
))
764 sysfs_remove_link(&dev
->kobj
, "device");
766 sysfs_remove_link(&dev
->class->p
->class_subsys
.kobj
, dev_name(dev
));
769 sysfs_remove_link(&dev
->kobj
, "subsystem");
773 * dev_set_name - set a device name
775 * @fmt: format string for the device's name
777 int dev_set_name(struct device
*dev
, const char *fmt
, ...)
781 va_start(vargs
, fmt
);
782 vsnprintf(dev
->bus_id
, sizeof(dev
->bus_id
), fmt
, vargs
);
786 EXPORT_SYMBOL_GPL(dev_set_name
);
789 * device_to_dev_kobj - select a /sys/dev/ directory for the device
792 * By default we select char/ for new entries. Setting class->dev_obj
793 * to NULL prevents an entry from being created. class->dev_kobj must
794 * be set (or cleared) before any devices are registered to the class
795 * otherwise device_create_sys_dev_entry() and
796 * device_remove_sys_dev_entry() will disagree about the the presence
799 static struct kobject
*device_to_dev_kobj(struct device
*dev
)
801 struct kobject
*kobj
;
804 kobj
= dev
->class->dev_kobj
;
806 kobj
= sysfs_dev_char_kobj
;
811 static int device_create_sys_dev_entry(struct device
*dev
)
813 struct kobject
*kobj
= device_to_dev_kobj(dev
);
818 format_dev_t(devt_str
, dev
->devt
);
819 error
= sysfs_create_link(kobj
, &dev
->kobj
, devt_str
);
825 static void device_remove_sys_dev_entry(struct device
*dev
)
827 struct kobject
*kobj
= device_to_dev_kobj(dev
);
831 format_dev_t(devt_str
, dev
->devt
);
832 sysfs_remove_link(kobj
, devt_str
);
837 * device_add - add device to device hierarchy.
840 * This is part 2 of device_register(), though may be called
841 * separately _iff_ device_initialize() has been called separately.
843 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
844 * to the global and sibling lists for the device, then
845 * adds it to the other relevant subsystems of the driver model.
847 * NOTE: _Never_ directly free @dev after calling this function, even
848 * if it returned an error! Always use put_device() to give up your
851 int device_add(struct device
*dev
)
853 struct device
*parent
= NULL
;
854 struct class_interface
*class_intf
;
857 dev
= get_device(dev
);
861 /* Temporarily support init_name if it is set.
862 * It will override bus_id for now */
864 dev_set_name(dev
, "%s", dev
->init_name
);
866 if (!strlen(dev
->bus_id
))
869 pr_debug("device: '%s': %s\n", dev_name(dev
), __func__
);
871 parent
= get_device(dev
->parent
);
872 setup_parent(dev
, parent
);
874 /* use parent numa_node */
876 set_dev_node(dev
, dev_to_node(parent
));
878 /* first, register with generic layer. */
879 error
= kobject_add(&dev
->kobj
, dev
->kobj
.parent
, "%s", dev_name(dev
));
883 /* notify platform of device entry */
885 platform_notify(dev
);
887 error
= device_create_file(dev
, &uevent_attr
);
891 if (MAJOR(dev
->devt
)) {
892 error
= device_create_file(dev
, &devt_attr
);
894 goto ueventattrError
;
896 error
= device_create_sys_dev_entry(dev
);
901 error
= device_add_class_symlinks(dev
);
904 error
= device_add_attrs(dev
);
907 error
= bus_add_device(dev
);
910 error
= dpm_sysfs_add(dev
);
915 /* Notify clients of device addition. This call must come
916 * after dpm_sysf_add() and before kobject_uevent().
919 blocking_notifier_call_chain(&dev
->bus
->p
->bus_notifier
,
920 BUS_NOTIFY_ADD_DEVICE
, dev
);
922 kobject_uevent(&dev
->kobj
, KOBJ_ADD
);
923 bus_attach_device(dev
);
925 klist_add_tail(&dev
->knode_parent
, &parent
->klist_children
);
928 mutex_lock(&dev
->class->p
->class_mutex
);
929 /* tie the class to the device */
930 klist_add_tail(&dev
->knode_class
,
931 &dev
->class->p
->class_devices
);
933 /* notify any interfaces that the device is here */
934 list_for_each_entry(class_intf
,
935 &dev
->class->p
->class_interfaces
, node
)
936 if (class_intf
->add_dev
)
937 class_intf
->add_dev(dev
, class_intf
);
938 mutex_unlock(&dev
->class->p
->class_mutex
);
944 bus_remove_device(dev
);
946 device_remove_attrs(dev
);
948 device_remove_class_symlinks(dev
);
950 if (MAJOR(dev
->devt
))
951 device_remove_sys_dev_entry(dev
);
953 if (MAJOR(dev
->devt
))
954 device_remove_file(dev
, &devt_attr
);
956 device_remove_file(dev
, &uevent_attr
);
958 kobject_uevent(&dev
->kobj
, KOBJ_REMOVE
);
959 kobject_del(&dev
->kobj
);
961 cleanup_device_parent(dev
);
968 * device_register - register a device with the system.
969 * @dev: pointer to the device structure
971 * This happens in two clean steps - initialize the device
972 * and add it to the system. The two steps can be called
973 * separately, but this is the easiest and most common.
974 * I.e. you should only call the two helpers separately if
975 * have a clearly defined need to use and refcount the device
976 * before it is added to the hierarchy.
978 * NOTE: _Never_ directly free @dev after calling this function, even
979 * if it returned an error! Always use put_device() to give up the
980 * reference initialized in this function instead.
982 int device_register(struct device
*dev
)
984 device_initialize(dev
);
985 return device_add(dev
);
989 * get_device - increment reference count for device.
992 * This simply forwards the call to kobject_get(), though
993 * we do take care to provide for the case that we get a NULL
996 struct device
*get_device(struct device
*dev
)
998 return dev
? to_dev(kobject_get(&dev
->kobj
)) : NULL
;
1002 * put_device - decrement reference count.
1003 * @dev: device in question.
1005 void put_device(struct device
*dev
)
1007 /* might_sleep(); */
1009 kobject_put(&dev
->kobj
);
1013 * device_del - delete device from system.
1016 * This is the first part of the device unregistration
1017 * sequence. This removes the device from the lists we control
1018 * from here, has it removed from the other driver model
1019 * subsystems it was added to in device_add(), and removes it
1020 * from the kobject hierarchy.
1022 * NOTE: this should be called manually _iff_ device_add() was
1023 * also called manually.
1025 void device_del(struct device
*dev
)
1027 struct device
*parent
= dev
->parent
;
1028 struct class_interface
*class_intf
;
1030 /* Notify clients of device removal. This call must come
1031 * before dpm_sysfs_remove().
1034 blocking_notifier_call_chain(&dev
->bus
->p
->bus_notifier
,
1035 BUS_NOTIFY_DEL_DEVICE
, dev
);
1036 device_pm_remove(dev
);
1037 dpm_sysfs_remove(dev
);
1039 klist_del(&dev
->knode_parent
);
1040 if (MAJOR(dev
->devt
)) {
1041 device_remove_sys_dev_entry(dev
);
1042 device_remove_file(dev
, &devt_attr
);
1045 device_remove_class_symlinks(dev
);
1047 mutex_lock(&dev
->class->p
->class_mutex
);
1048 /* notify any interfaces that the device is now gone */
1049 list_for_each_entry(class_intf
,
1050 &dev
->class->p
->class_interfaces
, node
)
1051 if (class_intf
->remove_dev
)
1052 class_intf
->remove_dev(dev
, class_intf
);
1053 /* remove the device from the class list */
1054 klist_del(&dev
->knode_class
);
1055 mutex_unlock(&dev
->class->p
->class_mutex
);
1057 device_remove_file(dev
, &uevent_attr
);
1058 device_remove_attrs(dev
);
1059 bus_remove_device(dev
);
1062 * Some platform devices are driven without driver attached
1063 * and managed resources may have been acquired. Make sure
1064 * all resources are released.
1066 devres_release_all(dev
);
1068 /* Notify the platform of the removal, in case they
1069 * need to do anything...
1071 if (platform_notify_remove
)
1072 platform_notify_remove(dev
);
1073 kobject_uevent(&dev
->kobj
, KOBJ_REMOVE
);
1074 cleanup_device_parent(dev
);
1075 kobject_del(&dev
->kobj
);
1080 * device_unregister - unregister device from system.
1081 * @dev: device going away.
1083 * We do this in two parts, like we do device_register(). First,
1084 * we remove it from all the subsystems with device_del(), then
1085 * we decrement the reference count via put_device(). If that
1086 * is the final reference count, the device will be cleaned up
1087 * via device_release() above. Otherwise, the structure will
1088 * stick around until the final reference to the device is dropped.
1090 void device_unregister(struct device
*dev
)
1092 pr_debug("device: '%s': %s\n", dev_name(dev
), __func__
);
1097 static struct device
*next_device(struct klist_iter
*i
)
1099 struct klist_node
*n
= klist_next(i
);
1100 return n
? container_of(n
, struct device
, knode_parent
) : NULL
;
1104 * device_for_each_child - device child iterator.
1105 * @parent: parent struct device.
1106 * @data: data for the callback.
1107 * @fn: function to be called for each device.
1109 * Iterate over @parent's child devices, and call @fn for each,
1112 * We check the return of @fn each time. If it returns anything
1113 * other than 0, we break out and return that value.
1115 int device_for_each_child(struct device
*parent
, void *data
,
1116 int (*fn
)(struct device
*dev
, void *data
))
1118 struct klist_iter i
;
1119 struct device
*child
;
1122 klist_iter_init(&parent
->klist_children
, &i
);
1123 while ((child
= next_device(&i
)) && !error
)
1124 error
= fn(child
, data
);
1125 klist_iter_exit(&i
);
1130 * device_find_child - device iterator for locating a particular device.
1131 * @parent: parent struct device
1132 * @data: Data to pass to match function
1133 * @match: Callback function to check device
1135 * This is similar to the device_for_each_child() function above, but it
1136 * returns a reference to a device that is 'found' for later use, as
1137 * determined by the @match callback.
1139 * The callback should return 0 if the device doesn't match and non-zero
1140 * if it does. If the callback returns non-zero and a reference to the
1141 * current device can be obtained, this function will return to the caller
1142 * and not iterate over any more devices.
1144 struct device
*device_find_child(struct device
*parent
, void *data
,
1145 int (*match
)(struct device
*dev
, void *data
))
1147 struct klist_iter i
;
1148 struct device
*child
;
1153 klist_iter_init(&parent
->klist_children
, &i
);
1154 while ((child
= next_device(&i
)))
1155 if (match(child
, data
) && get_device(child
))
1157 klist_iter_exit(&i
);
1161 int __init
devices_init(void)
1163 devices_kset
= kset_create_and_add("devices", &device_uevent_ops
, NULL
);
1166 dev_kobj
= kobject_create_and_add("dev", NULL
);
1169 sysfs_dev_block_kobj
= kobject_create_and_add("block", dev_kobj
);
1170 if (!sysfs_dev_block_kobj
)
1171 goto block_kobj_err
;
1172 sysfs_dev_char_kobj
= kobject_create_and_add("char", dev_kobj
);
1173 if (!sysfs_dev_char_kobj
)
1179 kobject_put(sysfs_dev_block_kobj
);
1181 kobject_put(dev_kobj
);
1183 kset_unregister(devices_kset
);
1187 EXPORT_SYMBOL_GPL(device_for_each_child
);
1188 EXPORT_SYMBOL_GPL(device_find_child
);
1190 EXPORT_SYMBOL_GPL(device_initialize
);
1191 EXPORT_SYMBOL_GPL(device_add
);
1192 EXPORT_SYMBOL_GPL(device_register
);
1194 EXPORT_SYMBOL_GPL(device_del
);
1195 EXPORT_SYMBOL_GPL(device_unregister
);
1196 EXPORT_SYMBOL_GPL(get_device
);
1197 EXPORT_SYMBOL_GPL(put_device
);
1199 EXPORT_SYMBOL_GPL(device_create_file
);
1200 EXPORT_SYMBOL_GPL(device_remove_file
);
1205 struct module
*owner
;
1208 #define to_root_device(dev) container_of(dev, struct root_device, dev)
1210 static void root_device_release(struct device
*dev
)
1212 kfree(to_root_device(dev
));
1216 * __root_device_register - allocate and register a root device
1217 * @name: root device name
1218 * @owner: owner module of the root device, usually THIS_MODULE
1220 * This function allocates a root device and registers it
1221 * using device_register(). In order to free the returned
1222 * device, use root_device_unregister().
1224 * Root devices are dummy devices which allow other devices
1225 * to be grouped under /sys/devices. Use this function to
1226 * allocate a root device and then use it as the parent of
1227 * any device which should appear under /sys/devices/{name}
1229 * The /sys/devices/{name} directory will also contain a
1230 * 'module' symlink which points to the @owner directory
1233 * Note: You probably want to use root_device_register().
1235 struct device
*__root_device_register(const char *name
, struct module
*owner
)
1237 struct root_device
*root
;
1240 root
= kzalloc(sizeof(struct root_device
), GFP_KERNEL
);
1242 return ERR_PTR(err
);
1244 err
= dev_set_name(&root
->dev
, name
);
1247 return ERR_PTR(err
);
1250 root
->dev
.release
= root_device_release
;
1252 err
= device_register(&root
->dev
);
1254 put_device(&root
->dev
);
1255 return ERR_PTR(err
);
1258 #ifdef CONFIG_MODULE /* gotta find a "cleaner" way to do this */
1260 struct module_kobject
*mk
= &owner
->mkobj
;
1262 err
= sysfs_create_link(&root
->dev
.kobj
, &mk
->kobj
, "module");
1264 device_unregister(&root
->dev
);
1265 return ERR_PTR(err
);
1267 root
->owner
= owner
;
1273 EXPORT_SYMBOL_GPL(__root_device_register
);
1276 * root_device_unregister - unregister and free a root device
1277 * @root: device going away.
1279 * This function unregisters and cleans up a device that was created by
1280 * root_device_register().
1282 void root_device_unregister(struct device
*dev
)
1284 struct root_device
*root
= to_root_device(dev
);
1287 sysfs_remove_link(&root
->dev
.kobj
, "module");
1289 device_unregister(dev
);
1291 EXPORT_SYMBOL_GPL(root_device_unregister
);
1294 static void device_create_release(struct device
*dev
)
1296 pr_debug("device: '%s': %s\n", dev_name(dev
), __func__
);
1301 * device_create_vargs - creates a device and registers it with sysfs
1302 * @class: pointer to the struct class that this device should be registered to
1303 * @parent: pointer to the parent struct device of this new device, if any
1304 * @devt: the dev_t for the char device to be added
1305 * @drvdata: the data to be added to the device for callbacks
1306 * @fmt: string for the device's name
1307 * @args: va_list for the device's name
1309 * This function can be used by char device classes. A struct device
1310 * will be created in sysfs, registered to the specified class.
1312 * A "dev" file will be created, showing the dev_t for the device, if
1313 * the dev_t is not 0,0.
1314 * If a pointer to a parent struct device is passed in, the newly created
1315 * struct device will be a child of that device in sysfs.
1316 * The pointer to the struct device will be returned from the call.
1317 * Any further sysfs files that might be required can be created using this
1320 * Note: the struct class passed to this function must have previously
1321 * been created with a call to class_create().
1323 struct device
*device_create_vargs(struct class *class, struct device
*parent
,
1324 dev_t devt
, void *drvdata
, const char *fmt
,
1327 struct device
*dev
= NULL
;
1328 int retval
= -ENODEV
;
1330 if (class == NULL
|| IS_ERR(class))
1333 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
1341 dev
->parent
= parent
;
1342 dev
->release
= device_create_release
;
1343 dev_set_drvdata(dev
, drvdata
);
1345 vsnprintf(dev
->bus_id
, BUS_ID_SIZE
, fmt
, args
);
1346 retval
= device_register(dev
);
1354 return ERR_PTR(retval
);
1356 EXPORT_SYMBOL_GPL(device_create_vargs
);
1359 * device_create - creates a device and registers it with sysfs
1360 * @class: pointer to the struct class that this device should be registered to
1361 * @parent: pointer to the parent struct device of this new device, if any
1362 * @devt: the dev_t for the char device to be added
1363 * @drvdata: the data to be added to the device for callbacks
1364 * @fmt: string for the device's name
1366 * This function can be used by char device classes. A struct device
1367 * will be created in sysfs, registered to the specified class.
1369 * A "dev" file will be created, showing the dev_t for the device, if
1370 * the dev_t is not 0,0.
1371 * If a pointer to a parent struct device is passed in, the newly created
1372 * struct device will be a child of that device in sysfs.
1373 * The pointer to the struct device will be returned from the call.
1374 * Any further sysfs files that might be required can be created using this
1377 * Note: the struct class passed to this function must have previously
1378 * been created with a call to class_create().
1380 struct device
*device_create(struct class *class, struct device
*parent
,
1381 dev_t devt
, void *drvdata
, const char *fmt
, ...)
1386 va_start(vargs
, fmt
);
1387 dev
= device_create_vargs(class, parent
, devt
, drvdata
, fmt
, vargs
);
1391 EXPORT_SYMBOL_GPL(device_create
);
1393 static int __match_devt(struct device
*dev
, void *data
)
1397 return dev
->devt
== *devt
;
1401 * device_destroy - removes a device that was created with device_create()
1402 * @class: pointer to the struct class that this device was registered with
1403 * @devt: the dev_t of the device that was previously registered
1405 * This call unregisters and cleans up a device that was created with a
1406 * call to device_create().
1408 void device_destroy(struct class *class, dev_t devt
)
1412 dev
= class_find_device(class, NULL
, &devt
, __match_devt
);
1415 device_unregister(dev
);
1418 EXPORT_SYMBOL_GPL(device_destroy
);
1421 * device_rename - renames a device
1422 * @dev: the pointer to the struct device to be renamed
1423 * @new_name: the new name of the device
1425 * It is the responsibility of the caller to provide mutual
1426 * exclusion between two different calls of device_rename
1427 * on the same device to ensure that new_name is valid and
1428 * won't conflict with other devices.
1430 int device_rename(struct device
*dev
, char *new_name
)
1432 char *old_class_name
= NULL
;
1433 char *new_class_name
= NULL
;
1434 char *old_device_name
= NULL
;
1437 dev
= get_device(dev
);
1441 pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev
),
1442 __func__
, new_name
);
1444 #ifdef CONFIG_SYSFS_DEPRECATED
1445 if ((dev
->class) && (dev
->parent
))
1446 old_class_name
= make_class_name(dev
->class->name
, &dev
->kobj
);
1449 old_device_name
= kmalloc(BUS_ID_SIZE
, GFP_KERNEL
);
1450 if (!old_device_name
) {
1454 strlcpy(old_device_name
, dev
->bus_id
, BUS_ID_SIZE
);
1455 strlcpy(dev
->bus_id
, new_name
, BUS_ID_SIZE
);
1457 error
= kobject_rename(&dev
->kobj
, new_name
);
1459 strlcpy(dev
->bus_id
, old_device_name
, BUS_ID_SIZE
);
1463 #ifdef CONFIG_SYSFS_DEPRECATED
1464 if (old_class_name
) {
1465 new_class_name
= make_class_name(dev
->class->name
, &dev
->kobj
);
1466 if (new_class_name
) {
1467 error
= sysfs_create_link_nowarn(&dev
->parent
->kobj
,
1472 sysfs_remove_link(&dev
->parent
->kobj
, old_class_name
);
1477 error
= sysfs_create_link_nowarn(&dev
->class->p
->class_subsys
.kobj
,
1478 &dev
->kobj
, dev_name(dev
));
1481 sysfs_remove_link(&dev
->class->p
->class_subsys
.kobj
,
1489 kfree(new_class_name
);
1490 kfree(old_class_name
);
1491 kfree(old_device_name
);
1495 EXPORT_SYMBOL_GPL(device_rename
);
1497 static int device_move_class_links(struct device
*dev
,
1498 struct device
*old_parent
,
1499 struct device
*new_parent
)
1502 #ifdef CONFIG_SYSFS_DEPRECATED
1505 class_name
= make_class_name(dev
->class->name
, &dev
->kobj
);
1511 sysfs_remove_link(&dev
->kobj
, "device");
1512 sysfs_remove_link(&old_parent
->kobj
, class_name
);
1515 error
= sysfs_create_link(&dev
->kobj
, &new_parent
->kobj
,
1519 error
= sysfs_create_link(&new_parent
->kobj
, &dev
->kobj
,
1522 sysfs_remove_link(&dev
->kobj
, "device");
1530 sysfs_remove_link(&dev
->kobj
, "device");
1532 error
= sysfs_create_link(&dev
->kobj
, &new_parent
->kobj
,
1539 * device_move - moves a device to a new parent
1540 * @dev: the pointer to the struct device to be moved
1541 * @new_parent: the new parent of the device (can by NULL)
1543 int device_move(struct device
*dev
, struct device
*new_parent
)
1546 struct device
*old_parent
;
1547 struct kobject
*new_parent_kobj
;
1549 dev
= get_device(dev
);
1553 new_parent
= get_device(new_parent
);
1554 new_parent_kobj
= get_device_parent(dev
, new_parent
);
1556 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev
),
1557 __func__
, new_parent
? dev_name(new_parent
) : "<NULL>");
1558 error
= kobject_move(&dev
->kobj
, new_parent_kobj
);
1560 cleanup_glue_dir(dev
, new_parent_kobj
);
1561 put_device(new_parent
);
1564 old_parent
= dev
->parent
;
1565 dev
->parent
= new_parent
;
1567 klist_remove(&dev
->knode_parent
);
1569 klist_add_tail(&dev
->knode_parent
, &new_parent
->klist_children
);
1570 set_dev_node(dev
, dev_to_node(new_parent
));
1575 error
= device_move_class_links(dev
, old_parent
, new_parent
);
1577 /* We ignore errors on cleanup since we're hosed anyway... */
1578 device_move_class_links(dev
, new_parent
, old_parent
);
1579 if (!kobject_move(&dev
->kobj
, &old_parent
->kobj
)) {
1581 klist_remove(&dev
->knode_parent
);
1582 dev
->parent
= old_parent
;
1584 klist_add_tail(&dev
->knode_parent
,
1585 &old_parent
->klist_children
);
1586 set_dev_node(dev
, dev_to_node(old_parent
));
1589 cleanup_glue_dir(dev
, new_parent_kobj
);
1590 put_device(new_parent
);
1594 put_device(old_parent
);
1599 EXPORT_SYMBOL_GPL(device_move
);
1602 * device_shutdown - call ->shutdown() on each device to shutdown.
1604 void device_shutdown(void)
1606 struct device
*dev
, *devn
;
1608 list_for_each_entry_safe_reverse(dev
, devn
, &devices_kset
->list
,
1610 if (dev
->bus
&& dev
->bus
->shutdown
) {
1611 dev_dbg(dev
, "shutdown\n");
1612 dev
->bus
->shutdown(dev
);
1613 } else if (dev
->driver
&& dev
->driver
->shutdown
) {
1614 dev_dbg(dev
, "shutdown\n");
1615 dev
->driver
->shutdown(dev
);
1618 kobject_put(sysfs_dev_char_kobj
);
1619 kobject_put(sysfs_dev_block_kobj
);
1620 kobject_put(dev_kobj
);