2 * drivers/base/core.c - core driver model code (device registration, etc)
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
6 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
7 * Copyright (c) 2006 Novell, Inc.
9 * This file is released under the GPLv2
13 #include <linux/device.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/slab.h>
18 #include <linux/string.h>
19 #include <linux/kdev_t.h>
20 #include <linux/notifier.h>
21 #include <linux/genhd.h>
22 #include <linux/kallsyms.h>
23 #include <linux/semaphore.h>
24 #include <linux/mutex.h>
27 #include "power/power.h"
29 int (*platform_notify
)(struct device
*dev
) = NULL
;
30 int (*platform_notify_remove
)(struct device
*dev
) = NULL
;
31 static struct kobject
*dev_kobj
;
32 struct kobject
*sysfs_dev_char_kobj
;
33 struct kobject
*sysfs_dev_block_kobj
;
36 static inline int device_is_not_partition(struct device
*dev
)
38 return !(dev
->type
== &part_type
);
41 static inline int device_is_not_partition(struct device
*dev
)
48 * dev_driver_string - Return a device's driver name, if at all possible
49 * @dev: struct device to get the name of
51 * Will return the device's driver's name if it is bound to a device. If
52 * the device is not bound to a device, it will return the name of the bus
53 * it is attached to. If it is not attached to a bus either, an empty
54 * string will be returned.
56 const char *dev_driver_string(const struct device
*dev
)
58 return dev
->driver
? dev
->driver
->name
:
59 (dev
->bus
? dev
->bus
->name
:
60 (dev
->class ? dev
->class->name
: ""));
62 EXPORT_SYMBOL(dev_driver_string
);
64 #define to_dev(obj) container_of(obj, struct device, kobj)
65 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
67 static ssize_t
dev_attr_show(struct kobject
*kobj
, struct attribute
*attr
,
70 struct device_attribute
*dev_attr
= to_dev_attr(attr
);
71 struct device
*dev
= to_dev(kobj
);
75 ret
= dev_attr
->show(dev
, dev_attr
, buf
);
76 if (ret
>= (ssize_t
)PAGE_SIZE
) {
77 print_symbol("dev_attr_show: %s returned bad count\n",
78 (unsigned long)dev_attr
->show
);
83 static ssize_t
dev_attr_store(struct kobject
*kobj
, struct attribute
*attr
,
84 const char *buf
, size_t count
)
86 struct device_attribute
*dev_attr
= to_dev_attr(attr
);
87 struct device
*dev
= to_dev(kobj
);
91 ret
= dev_attr
->store(dev
, dev_attr
, buf
, count
);
95 static struct sysfs_ops dev_sysfs_ops
= {
96 .show
= dev_attr_show
,
97 .store
= dev_attr_store
,
102 * device_release - free device structure.
103 * @kobj: device's kobject.
105 * This is called once the reference count for the object
106 * reaches 0. We forward the call to the device's release
107 * method, which should handle actually freeing the structure.
109 static void device_release(struct kobject
*kobj
)
111 struct device
*dev
= to_dev(kobj
);
112 struct device_private
*p
= dev
->p
;
116 else if (dev
->type
&& dev
->type
->release
)
117 dev
->type
->release(dev
);
118 else if (dev
->class && dev
->class->dev_release
)
119 dev
->class->dev_release(dev
);
121 WARN(1, KERN_ERR
"Device '%s' does not have a release() "
122 "function, it is broken and must be fixed.\n",
127 static struct kobj_type device_ktype
= {
128 .release
= device_release
,
129 .sysfs_ops
= &dev_sysfs_ops
,
133 static int dev_uevent_filter(struct kset
*kset
, struct kobject
*kobj
)
135 struct kobj_type
*ktype
= get_ktype(kobj
);
137 if (ktype
== &device_ktype
) {
138 struct device
*dev
= to_dev(kobj
);
139 if (dev
->uevent_suppress
)
149 static const char *dev_uevent_name(struct kset
*kset
, struct kobject
*kobj
)
151 struct device
*dev
= to_dev(kobj
);
154 return dev
->bus
->name
;
156 return dev
->class->name
;
160 static int dev_uevent(struct kset
*kset
, struct kobject
*kobj
,
161 struct kobj_uevent_env
*env
)
163 struct device
*dev
= to_dev(kobj
);
166 /* add the major/minor if present */
167 if (MAJOR(dev
->devt
)) {
168 add_uevent_var(env
, "MAJOR=%u", MAJOR(dev
->devt
));
169 add_uevent_var(env
, "MINOR=%u", MINOR(dev
->devt
));
172 if (dev
->type
&& dev
->type
->name
)
173 add_uevent_var(env
, "DEVTYPE=%s", dev
->type
->name
);
176 add_uevent_var(env
, "DRIVER=%s", dev
->driver
->name
);
178 #ifdef CONFIG_SYSFS_DEPRECATED
180 struct device
*parent
= dev
->parent
;
182 /* find first bus device in parent chain */
183 while (parent
&& !parent
->bus
)
184 parent
= parent
->parent
;
185 if (parent
&& parent
->bus
) {
188 path
= kobject_get_path(&parent
->kobj
, GFP_KERNEL
);
190 add_uevent_var(env
, "PHYSDEVPATH=%s", path
);
194 add_uevent_var(env
, "PHYSDEVBUS=%s", parent
->bus
->name
);
197 add_uevent_var(env
, "PHYSDEVDRIVER=%s",
198 parent
->driver
->name
);
200 } else if (dev
->bus
) {
201 add_uevent_var(env
, "PHYSDEVBUS=%s", dev
->bus
->name
);
204 add_uevent_var(env
, "PHYSDEVDRIVER=%s",
209 /* have the bus specific function add its stuff */
210 if (dev
->bus
&& dev
->bus
->uevent
) {
211 retval
= dev
->bus
->uevent(dev
, env
);
213 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
214 dev_name(dev
), __func__
, retval
);
217 /* have the class specific function add its stuff */
218 if (dev
->class && dev
->class->dev_uevent
) {
219 retval
= dev
->class->dev_uevent(dev
, env
);
221 pr_debug("device: '%s': %s: class uevent() "
222 "returned %d\n", dev_name(dev
),
226 /* have the device type specific fuction add its stuff */
227 if (dev
->type
&& dev
->type
->uevent
) {
228 retval
= dev
->type
->uevent(dev
, env
);
230 pr_debug("device: '%s': %s: dev_type uevent() "
231 "returned %d\n", dev_name(dev
),
238 static struct kset_uevent_ops device_uevent_ops
= {
239 .filter
= dev_uevent_filter
,
240 .name
= dev_uevent_name
,
241 .uevent
= dev_uevent
,
244 static ssize_t
show_uevent(struct device
*dev
, struct device_attribute
*attr
,
247 struct kobject
*top_kobj
;
249 struct kobj_uevent_env
*env
= NULL
;
254 /* search the kset, the device belongs to */
255 top_kobj
= &dev
->kobj
;
256 while (!top_kobj
->kset
&& top_kobj
->parent
)
257 top_kobj
= top_kobj
->parent
;
261 kset
= top_kobj
->kset
;
262 if (!kset
->uevent_ops
|| !kset
->uevent_ops
->uevent
)
266 if (kset
->uevent_ops
&& kset
->uevent_ops
->filter
)
267 if (!kset
->uevent_ops
->filter(kset
, &dev
->kobj
))
270 env
= kzalloc(sizeof(struct kobj_uevent_env
), GFP_KERNEL
);
274 /* let the kset specific function add its keys */
275 retval
= kset
->uevent_ops
->uevent(kset
, &dev
->kobj
, env
);
279 /* copy keys to file */
280 for (i
= 0; i
< env
->envp_idx
; i
++)
281 count
+= sprintf(&buf
[count
], "%s\n", env
->envp
[i
]);
287 static ssize_t
store_uevent(struct device
*dev
, struct device_attribute
*attr
,
288 const char *buf
, size_t count
)
290 enum kobject_action action
;
292 if (kobject_action_type(buf
, count
, &action
) == 0) {
293 kobject_uevent(&dev
->kobj
, action
);
297 dev_err(dev
, "uevent: unsupported action-string; this will "
298 "be ignored in a future kernel version\n");
299 kobject_uevent(&dev
->kobj
, KOBJ_ADD
);
304 static struct device_attribute uevent_attr
=
305 __ATTR(uevent
, S_IRUGO
| S_IWUSR
, show_uevent
, store_uevent
);
307 static int device_add_attributes(struct device
*dev
,
308 struct device_attribute
*attrs
)
314 for (i
= 0; attr_name(attrs
[i
]); i
++) {
315 error
= device_create_file(dev
, &attrs
[i
]);
321 device_remove_file(dev
, &attrs
[i
]);
326 static void device_remove_attributes(struct device
*dev
,
327 struct device_attribute
*attrs
)
332 for (i
= 0; attr_name(attrs
[i
]); i
++)
333 device_remove_file(dev
, &attrs
[i
]);
336 static int device_add_groups(struct device
*dev
,
337 struct attribute_group
**groups
)
343 for (i
= 0; groups
[i
]; i
++) {
344 error
= sysfs_create_group(&dev
->kobj
, groups
[i
]);
347 sysfs_remove_group(&dev
->kobj
,
356 static void device_remove_groups(struct device
*dev
,
357 struct attribute_group
**groups
)
362 for (i
= 0; groups
[i
]; i
++)
363 sysfs_remove_group(&dev
->kobj
, groups
[i
]);
366 static int device_add_attrs(struct device
*dev
)
368 struct class *class = dev
->class;
369 struct device_type
*type
= dev
->type
;
373 error
= device_add_attributes(dev
, class->dev_attrs
);
379 error
= device_add_groups(dev
, type
->groups
);
381 goto err_remove_class_attrs
;
384 error
= device_add_groups(dev
, dev
->groups
);
386 goto err_remove_type_groups
;
390 err_remove_type_groups
:
392 device_remove_groups(dev
, type
->groups
);
393 err_remove_class_attrs
:
395 device_remove_attributes(dev
, class->dev_attrs
);
400 static void device_remove_attrs(struct device
*dev
)
402 struct class *class = dev
->class;
403 struct device_type
*type
= dev
->type
;
405 device_remove_groups(dev
, dev
->groups
);
408 device_remove_groups(dev
, type
->groups
);
411 device_remove_attributes(dev
, class->dev_attrs
);
415 static ssize_t
show_dev(struct device
*dev
, struct device_attribute
*attr
,
418 return print_dev_t(buf
, dev
->devt
);
421 static struct device_attribute devt_attr
=
422 __ATTR(dev
, S_IRUGO
, show_dev
, NULL
);
424 /* kset to create /sys/devices/ */
425 struct kset
*devices_kset
;
428 * device_create_file - create sysfs attribute file for device.
430 * @attr: device attribute descriptor.
432 int device_create_file(struct device
*dev
, struct device_attribute
*attr
)
436 error
= sysfs_create_file(&dev
->kobj
, &attr
->attr
);
441 * device_remove_file - remove sysfs attribute file.
443 * @attr: device attribute descriptor.
445 void device_remove_file(struct device
*dev
, struct device_attribute
*attr
)
448 sysfs_remove_file(&dev
->kobj
, &attr
->attr
);
452 * device_create_bin_file - create sysfs binary attribute file for device.
454 * @attr: device binary attribute descriptor.
456 int device_create_bin_file(struct device
*dev
, struct bin_attribute
*attr
)
460 error
= sysfs_create_bin_file(&dev
->kobj
, attr
);
463 EXPORT_SYMBOL_GPL(device_create_bin_file
);
466 * device_remove_bin_file - remove sysfs binary attribute file
468 * @attr: device binary attribute descriptor.
470 void device_remove_bin_file(struct device
*dev
, struct bin_attribute
*attr
)
473 sysfs_remove_bin_file(&dev
->kobj
, attr
);
475 EXPORT_SYMBOL_GPL(device_remove_bin_file
);
478 * device_schedule_callback_owner - helper to schedule a callback for a device
480 * @func: callback function to invoke later.
481 * @owner: module owning the callback routine
483 * Attribute methods must not unregister themselves or their parent device
484 * (which would amount to the same thing). Attempts to do so will deadlock,
485 * since unregistration is mutually exclusive with driver callbacks.
487 * Instead methods can call this routine, which will attempt to allocate
488 * and schedule a workqueue request to call back @func with @dev as its
489 * argument in the workqueue's process context. @dev will be pinned until
492 * This routine is usually called via the inline device_schedule_callback(),
493 * which automatically sets @owner to THIS_MODULE.
495 * Returns 0 if the request was submitted, -ENOMEM if storage could not
496 * be allocated, -ENODEV if a reference to @owner isn't available.
498 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
499 * underlying sysfs routine (since it is intended for use by attribute
500 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
502 int device_schedule_callback_owner(struct device
*dev
,
503 void (*func
)(struct device
*), struct module
*owner
)
505 return sysfs_schedule_callback(&dev
->kobj
,
506 (void (*)(void *)) func
, dev
, owner
);
508 EXPORT_SYMBOL_GPL(device_schedule_callback_owner
);
510 static void klist_children_get(struct klist_node
*n
)
512 struct device
*dev
= container_of(n
, struct device
, knode_parent
);
517 static void klist_children_put(struct klist_node
*n
)
519 struct device
*dev
= container_of(n
, struct device
, knode_parent
);
525 * device_initialize - init device structure.
528 * This prepares the device for use by other layers by initializing
530 * It is the first half of device_register(), if called by
531 * that function, though it can also be called separately, so one
532 * may use @dev's fields. In particular, get_device()/put_device()
533 * may be used for reference counting of @dev after calling this
536 * NOTE: Use put_device() to give up your reference instead of freeing
537 * @dev directly once you have called this function.
539 void device_initialize(struct device
*dev
)
541 dev
->p
= kzalloc(sizeof(*dev
->p
), GFP_KERNEL
);
546 dev
->p
->device
= dev
;
547 dev
->kobj
.kset
= devices_kset
;
548 kobject_init(&dev
->kobj
, &device_ktype
);
549 klist_init(&dev
->klist_children
, klist_children_get
,
551 INIT_LIST_HEAD(&dev
->dma_pools
);
552 init_MUTEX(&dev
->sem
);
553 spin_lock_init(&dev
->devres_lock
);
554 INIT_LIST_HEAD(&dev
->devres_head
);
555 device_init_wakeup(dev
, 0);
557 set_dev_node(dev
, -1);
560 #ifdef CONFIG_SYSFS_DEPRECATED
561 static struct kobject
*get_device_parent(struct device
*dev
,
562 struct device
*parent
)
564 /* class devices without a parent live in /sys/class/<classname>/ */
565 if (dev
->class && (!parent
|| parent
->class != dev
->class))
566 return &dev
->class->p
->class_subsys
.kobj
;
567 /* all other devices keep their parent */
569 return &parent
->kobj
;
574 static inline void cleanup_device_parent(struct device
*dev
) {}
575 static inline void cleanup_glue_dir(struct device
*dev
,
576 struct kobject
*glue_dir
) {}
578 static struct kobject
*virtual_device_parent(struct device
*dev
)
580 static struct kobject
*virtual_dir
= NULL
;
583 virtual_dir
= kobject_create_and_add("virtual",
584 &devices_kset
->kobj
);
589 static struct kobject
*get_device_parent(struct device
*dev
,
590 struct device
*parent
)
595 struct kobject
*kobj
= NULL
;
596 struct kobject
*parent_kobj
;
600 * If we have no parent, we live in "virtual".
601 * Class-devices with a non class-device as parent, live
602 * in a "glue" directory to prevent namespace collisions.
605 parent_kobj
= virtual_device_parent(dev
);
606 else if (parent
->class)
607 return &parent
->kobj
;
609 parent_kobj
= &parent
->kobj
;
611 /* find our class-directory at the parent and reference it */
612 spin_lock(&dev
->class->p
->class_dirs
.list_lock
);
613 list_for_each_entry(k
, &dev
->class->p
->class_dirs
.list
, entry
)
614 if (k
->parent
== parent_kobj
) {
615 kobj
= kobject_get(k
);
618 spin_unlock(&dev
->class->p
->class_dirs
.list_lock
);
622 /* or create a new class-directory at the parent device */
623 k
= kobject_create();
626 k
->kset
= &dev
->class->p
->class_dirs
;
627 retval
= kobject_add(k
, parent_kobj
, "%s", dev
->class->name
);
632 /* do not emit an uevent for this simple "glue" directory */
637 return &parent
->kobj
;
641 static void cleanup_glue_dir(struct device
*dev
, struct kobject
*glue_dir
)
643 /* see if we live in a "glue" directory */
644 if (!glue_dir
|| !dev
->class ||
645 glue_dir
->kset
!= &dev
->class->p
->class_dirs
)
648 kobject_put(glue_dir
);
651 static void cleanup_device_parent(struct device
*dev
)
653 cleanup_glue_dir(dev
, dev
->kobj
.parent
);
657 static void setup_parent(struct device
*dev
, struct device
*parent
)
659 struct kobject
*kobj
;
660 kobj
= get_device_parent(dev
, parent
);
662 dev
->kobj
.parent
= kobj
;
665 static int device_add_class_symlinks(struct device
*dev
)
672 error
= sysfs_create_link(&dev
->kobj
,
673 &dev
->class->p
->class_subsys
.kobj
,
678 #ifdef CONFIG_SYSFS_DEPRECATED
679 /* stacked class devices need a symlink in the class directory */
680 if (dev
->kobj
.parent
!= &dev
->class->p
->class_subsys
.kobj
&&
681 device_is_not_partition(dev
)) {
682 error
= sysfs_create_link(&dev
->class->p
->class_subsys
.kobj
,
683 &dev
->kobj
, dev_name(dev
));
688 if (dev
->parent
&& device_is_not_partition(dev
)) {
689 struct device
*parent
= dev
->parent
;
693 * stacked class devices have the 'device' link
694 * pointing to the bus device instead of the parent
696 while (parent
->class && !parent
->bus
&& parent
->parent
)
697 parent
= parent
->parent
;
699 error
= sysfs_create_link(&dev
->kobj
,
705 class_name
= make_class_name(dev
->class->name
,
708 error
= sysfs_create_link(&dev
->parent
->kobj
,
709 &dev
->kobj
, class_name
);
717 if (dev
->parent
&& device_is_not_partition(dev
))
718 sysfs_remove_link(&dev
->kobj
, "device");
720 if (dev
->kobj
.parent
!= &dev
->class->p
->class_subsys
.kobj
&&
721 device_is_not_partition(dev
))
722 sysfs_remove_link(&dev
->class->p
->class_subsys
.kobj
,
725 /* link in the class directory pointing to the device */
726 error
= sysfs_create_link(&dev
->class->p
->class_subsys
.kobj
,
727 &dev
->kobj
, dev_name(dev
));
731 if (dev
->parent
&& device_is_not_partition(dev
)) {
732 error
= sysfs_create_link(&dev
->kobj
, &dev
->parent
->kobj
,
740 sysfs_remove_link(&dev
->class->p
->class_subsys
.kobj
, dev_name(dev
));
744 sysfs_remove_link(&dev
->kobj
, "subsystem");
749 static void device_remove_class_symlinks(struct device
*dev
)
754 #ifdef CONFIG_SYSFS_DEPRECATED
755 if (dev
->parent
&& device_is_not_partition(dev
)) {
758 class_name
= make_class_name(dev
->class->name
, &dev
->kobj
);
760 sysfs_remove_link(&dev
->parent
->kobj
, class_name
);
763 sysfs_remove_link(&dev
->kobj
, "device");
766 if (dev
->kobj
.parent
!= &dev
->class->p
->class_subsys
.kobj
&&
767 device_is_not_partition(dev
))
768 sysfs_remove_link(&dev
->class->p
->class_subsys
.kobj
,
771 if (dev
->parent
&& device_is_not_partition(dev
))
772 sysfs_remove_link(&dev
->kobj
, "device");
774 sysfs_remove_link(&dev
->class->p
->class_subsys
.kobj
, dev_name(dev
));
777 sysfs_remove_link(&dev
->kobj
, "subsystem");
781 * dev_set_name - set a device name
783 * @fmt: format string for the device's name
785 int dev_set_name(struct device
*dev
, const char *fmt
, ...)
789 va_start(vargs
, fmt
);
790 vsnprintf(dev
->bus_id
, sizeof(dev
->bus_id
), fmt
, vargs
);
794 EXPORT_SYMBOL_GPL(dev_set_name
);
797 * device_to_dev_kobj - select a /sys/dev/ directory for the device
800 * By default we select char/ for new entries. Setting class->dev_obj
801 * to NULL prevents an entry from being created. class->dev_kobj must
802 * be set (or cleared) before any devices are registered to the class
803 * otherwise device_create_sys_dev_entry() and
804 * device_remove_sys_dev_entry() will disagree about the the presence
807 static struct kobject
*device_to_dev_kobj(struct device
*dev
)
809 struct kobject
*kobj
;
812 kobj
= dev
->class->dev_kobj
;
814 kobj
= sysfs_dev_char_kobj
;
819 static int device_create_sys_dev_entry(struct device
*dev
)
821 struct kobject
*kobj
= device_to_dev_kobj(dev
);
826 format_dev_t(devt_str
, dev
->devt
);
827 error
= sysfs_create_link(kobj
, &dev
->kobj
, devt_str
);
833 static void device_remove_sys_dev_entry(struct device
*dev
)
835 struct kobject
*kobj
= device_to_dev_kobj(dev
);
839 format_dev_t(devt_str
, dev
->devt
);
840 sysfs_remove_link(kobj
, devt_str
);
845 * device_add - add device to device hierarchy.
848 * This is part 2 of device_register(), though may be called
849 * separately _iff_ device_initialize() has been called separately.
851 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
852 * to the global and sibling lists for the device, then
853 * adds it to the other relevant subsystems of the driver model.
855 * NOTE: _Never_ directly free @dev after calling this function, even
856 * if it returned an error! Always use put_device() to give up your
859 int device_add(struct device
*dev
)
861 struct device
*parent
= NULL
;
862 struct class_interface
*class_intf
;
865 dev
= get_device(dev
);
869 /* Temporarily support init_name if it is set.
870 * It will override bus_id for now */
872 dev_set_name(dev
, "%s", dev
->init_name
);
874 if (!strlen(dev
->bus_id
))
877 pr_debug("device: '%s': %s\n", dev_name(dev
), __func__
);
879 parent
= get_device(dev
->parent
);
880 setup_parent(dev
, parent
);
882 /* use parent numa_node */
884 set_dev_node(dev
, dev_to_node(parent
));
886 /* first, register with generic layer. */
887 error
= kobject_add(&dev
->kobj
, dev
->kobj
.parent
, "%s", dev_name(dev
));
891 /* notify platform of device entry */
893 platform_notify(dev
);
895 error
= device_create_file(dev
, &uevent_attr
);
899 if (MAJOR(dev
->devt
)) {
900 error
= device_create_file(dev
, &devt_attr
);
902 goto ueventattrError
;
904 error
= device_create_sys_dev_entry(dev
);
909 error
= device_add_class_symlinks(dev
);
912 error
= device_add_attrs(dev
);
915 error
= bus_add_device(dev
);
918 error
= dpm_sysfs_add(dev
);
923 /* Notify clients of device addition. This call must come
924 * after dpm_sysf_add() and before kobject_uevent().
927 blocking_notifier_call_chain(&dev
->bus
->p
->bus_notifier
,
928 BUS_NOTIFY_ADD_DEVICE
, dev
);
930 kobject_uevent(&dev
->kobj
, KOBJ_ADD
);
931 bus_attach_device(dev
);
933 klist_add_tail(&dev
->knode_parent
, &parent
->klist_children
);
936 mutex_lock(&dev
->class->p
->class_mutex
);
937 /* tie the class to the device */
938 klist_add_tail(&dev
->knode_class
,
939 &dev
->class->p
->class_devices
);
941 /* notify any interfaces that the device is here */
942 list_for_each_entry(class_intf
,
943 &dev
->class->p
->class_interfaces
, node
)
944 if (class_intf
->add_dev
)
945 class_intf
->add_dev(dev
, class_intf
);
946 mutex_unlock(&dev
->class->p
->class_mutex
);
952 bus_remove_device(dev
);
954 device_remove_attrs(dev
);
956 device_remove_class_symlinks(dev
);
958 if (MAJOR(dev
->devt
))
959 device_remove_sys_dev_entry(dev
);
961 if (MAJOR(dev
->devt
))
962 device_remove_file(dev
, &devt_attr
);
964 device_remove_file(dev
, &uevent_attr
);
966 kobject_uevent(&dev
->kobj
, KOBJ_REMOVE
);
967 kobject_del(&dev
->kobj
);
969 cleanup_device_parent(dev
);
976 * device_register - register a device with the system.
977 * @dev: pointer to the device structure
979 * This happens in two clean steps - initialize the device
980 * and add it to the system. The two steps can be called
981 * separately, but this is the easiest and most common.
982 * I.e. you should only call the two helpers separately if
983 * have a clearly defined need to use and refcount the device
984 * before it is added to the hierarchy.
986 * NOTE: _Never_ directly free @dev after calling this function, even
987 * if it returned an error! Always use put_device() to give up the
988 * reference initialized in this function instead.
990 int device_register(struct device
*dev
)
992 device_initialize(dev
);
993 return device_add(dev
);
997 * get_device - increment reference count for device.
1000 * This simply forwards the call to kobject_get(), though
1001 * we do take care to provide for the case that we get a NULL
1002 * pointer passed in.
1004 struct device
*get_device(struct device
*dev
)
1006 return dev
? to_dev(kobject_get(&dev
->kobj
)) : NULL
;
1010 * put_device - decrement reference count.
1011 * @dev: device in question.
1013 void put_device(struct device
*dev
)
1015 /* might_sleep(); */
1017 kobject_put(&dev
->kobj
);
1021 * device_del - delete device from system.
1024 * This is the first part of the device unregistration
1025 * sequence. This removes the device from the lists we control
1026 * from here, has it removed from the other driver model
1027 * subsystems it was added to in device_add(), and removes it
1028 * from the kobject hierarchy.
1030 * NOTE: this should be called manually _iff_ device_add() was
1031 * also called manually.
1033 void device_del(struct device
*dev
)
1035 struct device
*parent
= dev
->parent
;
1036 struct class_interface
*class_intf
;
1038 /* Notify clients of device removal. This call must come
1039 * before dpm_sysfs_remove().
1042 blocking_notifier_call_chain(&dev
->bus
->p
->bus_notifier
,
1043 BUS_NOTIFY_DEL_DEVICE
, dev
);
1044 device_pm_remove(dev
);
1045 dpm_sysfs_remove(dev
);
1047 klist_del(&dev
->knode_parent
);
1048 if (MAJOR(dev
->devt
)) {
1049 device_remove_sys_dev_entry(dev
);
1050 device_remove_file(dev
, &devt_attr
);
1053 device_remove_class_symlinks(dev
);
1055 mutex_lock(&dev
->class->p
->class_mutex
);
1056 /* notify any interfaces that the device is now gone */
1057 list_for_each_entry(class_intf
,
1058 &dev
->class->p
->class_interfaces
, node
)
1059 if (class_intf
->remove_dev
)
1060 class_intf
->remove_dev(dev
, class_intf
);
1061 /* remove the device from the class list */
1062 klist_del(&dev
->knode_class
);
1063 mutex_unlock(&dev
->class->p
->class_mutex
);
1065 device_remove_file(dev
, &uevent_attr
);
1066 device_remove_attrs(dev
);
1067 bus_remove_device(dev
);
1070 * Some platform devices are driven without driver attached
1071 * and managed resources may have been acquired. Make sure
1072 * all resources are released.
1074 devres_release_all(dev
);
1076 /* Notify the platform of the removal, in case they
1077 * need to do anything...
1079 if (platform_notify_remove
)
1080 platform_notify_remove(dev
);
1081 kobject_uevent(&dev
->kobj
, KOBJ_REMOVE
);
1082 cleanup_device_parent(dev
);
1083 kobject_del(&dev
->kobj
);
1088 * device_unregister - unregister device from system.
1089 * @dev: device going away.
1091 * We do this in two parts, like we do device_register(). First,
1092 * we remove it from all the subsystems with device_del(), then
1093 * we decrement the reference count via put_device(). If that
1094 * is the final reference count, the device will be cleaned up
1095 * via device_release() above. Otherwise, the structure will
1096 * stick around until the final reference to the device is dropped.
1098 void device_unregister(struct device
*dev
)
1100 pr_debug("device: '%s': %s\n", dev_name(dev
), __func__
);
1105 static struct device
*next_device(struct klist_iter
*i
)
1107 struct klist_node
*n
= klist_next(i
);
1108 return n
? container_of(n
, struct device
, knode_parent
) : NULL
;
1112 * device_for_each_child - device child iterator.
1113 * @parent: parent struct device.
1114 * @data: data for the callback.
1115 * @fn: function to be called for each device.
1117 * Iterate over @parent's child devices, and call @fn for each,
1120 * We check the return of @fn each time. If it returns anything
1121 * other than 0, we break out and return that value.
1123 int device_for_each_child(struct device
*parent
, void *data
,
1124 int (*fn
)(struct device
*dev
, void *data
))
1126 struct klist_iter i
;
1127 struct device
*child
;
1130 klist_iter_init(&parent
->klist_children
, &i
);
1131 while ((child
= next_device(&i
)) && !error
)
1132 error
= fn(child
, data
);
1133 klist_iter_exit(&i
);
1138 * device_find_child - device iterator for locating a particular device.
1139 * @parent: parent struct device
1140 * @data: Data to pass to match function
1141 * @match: Callback function to check device
1143 * This is similar to the device_for_each_child() function above, but it
1144 * returns a reference to a device that is 'found' for later use, as
1145 * determined by the @match callback.
1147 * The callback should return 0 if the device doesn't match and non-zero
1148 * if it does. If the callback returns non-zero and a reference to the
1149 * current device can be obtained, this function will return to the caller
1150 * and not iterate over any more devices.
1152 struct device
*device_find_child(struct device
*parent
, void *data
,
1153 int (*match
)(struct device
*dev
, void *data
))
1155 struct klist_iter i
;
1156 struct device
*child
;
1161 klist_iter_init(&parent
->klist_children
, &i
);
1162 while ((child
= next_device(&i
)))
1163 if (match(child
, data
) && get_device(child
))
1165 klist_iter_exit(&i
);
1169 int __init
devices_init(void)
1171 devices_kset
= kset_create_and_add("devices", &device_uevent_ops
, NULL
);
1174 dev_kobj
= kobject_create_and_add("dev", NULL
);
1177 sysfs_dev_block_kobj
= kobject_create_and_add("block", dev_kobj
);
1178 if (!sysfs_dev_block_kobj
)
1179 goto block_kobj_err
;
1180 sysfs_dev_char_kobj
= kobject_create_and_add("char", dev_kobj
);
1181 if (!sysfs_dev_char_kobj
)
1187 kobject_put(sysfs_dev_block_kobj
);
1189 kobject_put(dev_kobj
);
1191 kset_unregister(devices_kset
);
1195 EXPORT_SYMBOL_GPL(device_for_each_child
);
1196 EXPORT_SYMBOL_GPL(device_find_child
);
1198 EXPORT_SYMBOL_GPL(device_initialize
);
1199 EXPORT_SYMBOL_GPL(device_add
);
1200 EXPORT_SYMBOL_GPL(device_register
);
1202 EXPORT_SYMBOL_GPL(device_del
);
1203 EXPORT_SYMBOL_GPL(device_unregister
);
1204 EXPORT_SYMBOL_GPL(get_device
);
1205 EXPORT_SYMBOL_GPL(put_device
);
1207 EXPORT_SYMBOL_GPL(device_create_file
);
1208 EXPORT_SYMBOL_GPL(device_remove_file
);
1213 struct module
*owner
;
1216 #define to_root_device(dev) container_of(dev, struct root_device, dev)
1218 static void root_device_release(struct device
*dev
)
1220 kfree(to_root_device(dev
));
1224 * __root_device_register - allocate and register a root device
1225 * @name: root device name
1226 * @owner: owner module of the root device, usually THIS_MODULE
1228 * This function allocates a root device and registers it
1229 * using device_register(). In order to free the returned
1230 * device, use root_device_unregister().
1232 * Root devices are dummy devices which allow other devices
1233 * to be grouped under /sys/devices. Use this function to
1234 * allocate a root device and then use it as the parent of
1235 * any device which should appear under /sys/devices/{name}
1237 * The /sys/devices/{name} directory will also contain a
1238 * 'module' symlink which points to the @owner directory
1241 * Note: You probably want to use root_device_register().
1243 struct device
*__root_device_register(const char *name
, struct module
*owner
)
1245 struct root_device
*root
;
1248 root
= kzalloc(sizeof(struct root_device
), GFP_KERNEL
);
1250 return ERR_PTR(err
);
1252 err
= dev_set_name(&root
->dev
, name
);
1255 return ERR_PTR(err
);
1258 root
->dev
.release
= root_device_release
;
1260 err
= device_register(&root
->dev
);
1262 put_device(&root
->dev
);
1263 return ERR_PTR(err
);
1266 #ifdef CONFIG_MODULE /* gotta find a "cleaner" way to do this */
1268 struct module_kobject
*mk
= &owner
->mkobj
;
1270 err
= sysfs_create_link(&root
->dev
.kobj
, &mk
->kobj
, "module");
1272 device_unregister(&root
->dev
);
1273 return ERR_PTR(err
);
1275 root
->owner
= owner
;
1281 EXPORT_SYMBOL_GPL(__root_device_register
);
1284 * root_device_unregister - unregister and free a root device
1285 * @root: device going away.
1287 * This function unregisters and cleans up a device that was created by
1288 * root_device_register().
1290 void root_device_unregister(struct device
*dev
)
1292 struct root_device
*root
= to_root_device(dev
);
1295 sysfs_remove_link(&root
->dev
.kobj
, "module");
1297 device_unregister(dev
);
1299 EXPORT_SYMBOL_GPL(root_device_unregister
);
1302 static void device_create_release(struct device
*dev
)
1304 pr_debug("device: '%s': %s\n", dev_name(dev
), __func__
);
1309 * device_create_vargs - creates a device and registers it with sysfs
1310 * @class: pointer to the struct class that this device should be registered to
1311 * @parent: pointer to the parent struct device of this new device, if any
1312 * @devt: the dev_t for the char device to be added
1313 * @drvdata: the data to be added to the device for callbacks
1314 * @fmt: string for the device's name
1315 * @args: va_list for the device's name
1317 * This function can be used by char device classes. A struct device
1318 * will be created in sysfs, registered to the specified class.
1320 * A "dev" file will be created, showing the dev_t for the device, if
1321 * the dev_t is not 0,0.
1322 * If a pointer to a parent struct device is passed in, the newly created
1323 * struct device will be a child of that device in sysfs.
1324 * The pointer to the struct device will be returned from the call.
1325 * Any further sysfs files that might be required can be created using this
1328 * Note: the struct class passed to this function must have previously
1329 * been created with a call to class_create().
1331 struct device
*device_create_vargs(struct class *class, struct device
*parent
,
1332 dev_t devt
, void *drvdata
, const char *fmt
,
1335 struct device
*dev
= NULL
;
1336 int retval
= -ENODEV
;
1338 if (class == NULL
|| IS_ERR(class))
1341 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
1349 dev
->parent
= parent
;
1350 dev
->release
= device_create_release
;
1351 dev_set_drvdata(dev
, drvdata
);
1353 vsnprintf(dev
->bus_id
, BUS_ID_SIZE
, fmt
, args
);
1354 retval
= device_register(dev
);
1362 return ERR_PTR(retval
);
1364 EXPORT_SYMBOL_GPL(device_create_vargs
);
1367 * device_create - creates a device and registers it with sysfs
1368 * @class: pointer to the struct class that this device should be registered to
1369 * @parent: pointer to the parent struct device of this new device, if any
1370 * @devt: the dev_t for the char device to be added
1371 * @drvdata: the data to be added to the device for callbacks
1372 * @fmt: string for the device's name
1374 * This function can be used by char device classes. A struct device
1375 * will be created in sysfs, registered to the specified class.
1377 * A "dev" file will be created, showing the dev_t for the device, if
1378 * the dev_t is not 0,0.
1379 * If a pointer to a parent struct device is passed in, the newly created
1380 * struct device will be a child of that device in sysfs.
1381 * The pointer to the struct device will be returned from the call.
1382 * Any further sysfs files that might be required can be created using this
1385 * Note: the struct class passed to this function must have previously
1386 * been created with a call to class_create().
1388 struct device
*device_create(struct class *class, struct device
*parent
,
1389 dev_t devt
, void *drvdata
, const char *fmt
, ...)
1394 va_start(vargs
, fmt
);
1395 dev
= device_create_vargs(class, parent
, devt
, drvdata
, fmt
, vargs
);
1399 EXPORT_SYMBOL_GPL(device_create
);
1401 static int __match_devt(struct device
*dev
, void *data
)
1405 return dev
->devt
== *devt
;
1409 * device_destroy - removes a device that was created with device_create()
1410 * @class: pointer to the struct class that this device was registered with
1411 * @devt: the dev_t of the device that was previously registered
1413 * This call unregisters and cleans up a device that was created with a
1414 * call to device_create().
1416 void device_destroy(struct class *class, dev_t devt
)
1420 dev
= class_find_device(class, NULL
, &devt
, __match_devt
);
1423 device_unregister(dev
);
1426 EXPORT_SYMBOL_GPL(device_destroy
);
1429 * device_rename - renames a device
1430 * @dev: the pointer to the struct device to be renamed
1431 * @new_name: the new name of the device
1433 * It is the responsibility of the caller to provide mutual
1434 * exclusion between two different calls of device_rename
1435 * on the same device to ensure that new_name is valid and
1436 * won't conflict with other devices.
1438 int device_rename(struct device
*dev
, char *new_name
)
1440 char *old_class_name
= NULL
;
1441 char *new_class_name
= NULL
;
1442 char *old_device_name
= NULL
;
1445 dev
= get_device(dev
);
1449 pr_debug("device: '%s': %s: renaming to '%s'\n", dev_name(dev
),
1450 __func__
, new_name
);
1452 #ifdef CONFIG_SYSFS_DEPRECATED
1453 if ((dev
->class) && (dev
->parent
))
1454 old_class_name
= make_class_name(dev
->class->name
, &dev
->kobj
);
1457 old_device_name
= kmalloc(BUS_ID_SIZE
, GFP_KERNEL
);
1458 if (!old_device_name
) {
1462 strlcpy(old_device_name
, dev
->bus_id
, BUS_ID_SIZE
);
1463 strlcpy(dev
->bus_id
, new_name
, BUS_ID_SIZE
);
1465 error
= kobject_rename(&dev
->kobj
, new_name
);
1467 strlcpy(dev
->bus_id
, old_device_name
, BUS_ID_SIZE
);
1471 #ifdef CONFIG_SYSFS_DEPRECATED
1472 if (old_class_name
) {
1473 new_class_name
= make_class_name(dev
->class->name
, &dev
->kobj
);
1474 if (new_class_name
) {
1475 error
= sysfs_create_link_nowarn(&dev
->parent
->kobj
,
1480 sysfs_remove_link(&dev
->parent
->kobj
, old_class_name
);
1485 error
= sysfs_create_link_nowarn(&dev
->class->p
->class_subsys
.kobj
,
1486 &dev
->kobj
, dev_name(dev
));
1489 sysfs_remove_link(&dev
->class->p
->class_subsys
.kobj
,
1497 kfree(new_class_name
);
1498 kfree(old_class_name
);
1499 kfree(old_device_name
);
1503 EXPORT_SYMBOL_GPL(device_rename
);
1505 static int device_move_class_links(struct device
*dev
,
1506 struct device
*old_parent
,
1507 struct device
*new_parent
)
1510 #ifdef CONFIG_SYSFS_DEPRECATED
1513 class_name
= make_class_name(dev
->class->name
, &dev
->kobj
);
1519 sysfs_remove_link(&dev
->kobj
, "device");
1520 sysfs_remove_link(&old_parent
->kobj
, class_name
);
1523 error
= sysfs_create_link(&dev
->kobj
, &new_parent
->kobj
,
1527 error
= sysfs_create_link(&new_parent
->kobj
, &dev
->kobj
,
1530 sysfs_remove_link(&dev
->kobj
, "device");
1538 sysfs_remove_link(&dev
->kobj
, "device");
1540 error
= sysfs_create_link(&dev
->kobj
, &new_parent
->kobj
,
1547 * device_move - moves a device to a new parent
1548 * @dev: the pointer to the struct device to be moved
1549 * @new_parent: the new parent of the device (can by NULL)
1551 int device_move(struct device
*dev
, struct device
*new_parent
)
1554 struct device
*old_parent
;
1555 struct kobject
*new_parent_kobj
;
1557 dev
= get_device(dev
);
1561 new_parent
= get_device(new_parent
);
1562 new_parent_kobj
= get_device_parent(dev
, new_parent
);
1564 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev
),
1565 __func__
, new_parent
? dev_name(new_parent
) : "<NULL>");
1566 error
= kobject_move(&dev
->kobj
, new_parent_kobj
);
1568 cleanup_glue_dir(dev
, new_parent_kobj
);
1569 put_device(new_parent
);
1572 old_parent
= dev
->parent
;
1573 dev
->parent
= new_parent
;
1575 klist_remove(&dev
->knode_parent
);
1577 klist_add_tail(&dev
->knode_parent
, &new_parent
->klist_children
);
1578 set_dev_node(dev
, dev_to_node(new_parent
));
1583 error
= device_move_class_links(dev
, old_parent
, new_parent
);
1585 /* We ignore errors on cleanup since we're hosed anyway... */
1586 device_move_class_links(dev
, new_parent
, old_parent
);
1587 if (!kobject_move(&dev
->kobj
, &old_parent
->kobj
)) {
1589 klist_remove(&dev
->knode_parent
);
1590 dev
->parent
= old_parent
;
1592 klist_add_tail(&dev
->knode_parent
,
1593 &old_parent
->klist_children
);
1594 set_dev_node(dev
, dev_to_node(old_parent
));
1597 cleanup_glue_dir(dev
, new_parent_kobj
);
1598 put_device(new_parent
);
1602 put_device(old_parent
);
1607 EXPORT_SYMBOL_GPL(device_move
);
1610 * device_shutdown - call ->shutdown() on each device to shutdown.
1612 void device_shutdown(void)
1614 struct device
*dev
, *devn
;
1616 list_for_each_entry_safe_reverse(dev
, devn
, &devices_kset
->list
,
1618 if (dev
->bus
&& dev
->bus
->shutdown
) {
1619 dev_dbg(dev
, "shutdown\n");
1620 dev
->bus
->shutdown(dev
);
1621 } else if (dev
->driver
&& dev
->driver
->shutdown
) {
1622 dev_dbg(dev
, "shutdown\n");
1623 dev
->driver
->shutdown(dev
);
1626 kobject_put(sysfs_dev_char_kobj
);
1627 kobject_put(sysfs_dev_block_kobj
);
1628 kobject_put(dev_kobj
);