printk: export console_drivers
[linux-2.6/linux-loongson.git] / drivers / base / core.c
blobee0a51a3a41d876451395b0f2a93b6a06a430394
1 /*
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>
25 #include "base.h"
26 #include "power/power.h"
28 int (*platform_notify)(struct device *dev) = NULL;
29 int (*platform_notify_remove)(struct device *dev) = NULL;
31 #ifdef CONFIG_BLOCK
32 static inline int device_is_not_partition(struct device *dev)
34 return !(dev->type == &part_type);
36 #else
37 static inline int device_is_not_partition(struct device *dev)
39 return 1;
41 #endif
43 /**
44 * dev_driver_string - Return a device's driver name, if at all possible
45 * @dev: struct device to get the name of
47 * Will return the device's driver's name if it is bound to a device. If
48 * the device is not bound to a device, it will return the name of the bus
49 * it is attached to. If it is not attached to a bus either, an empty
50 * string will be returned.
52 const char *dev_driver_string(struct device *dev)
54 return dev->driver ? dev->driver->name :
55 (dev->bus ? dev->bus->name :
56 (dev->class ? dev->class->name : ""));
58 EXPORT_SYMBOL(dev_driver_string);
60 #define to_dev(obj) container_of(obj, struct device, kobj)
61 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
63 static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
64 char *buf)
66 struct device_attribute *dev_attr = to_dev_attr(attr);
67 struct device *dev = to_dev(kobj);
68 ssize_t ret = -EIO;
70 if (dev_attr->show)
71 ret = dev_attr->show(dev, dev_attr, buf);
72 if (ret >= (ssize_t)PAGE_SIZE) {
73 print_symbol("dev_attr_show: %s returned bad count\n",
74 (unsigned long)dev_attr->show);
76 return ret;
79 static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
80 const char *buf, size_t count)
82 struct device_attribute *dev_attr = to_dev_attr(attr);
83 struct device *dev = to_dev(kobj);
84 ssize_t ret = -EIO;
86 if (dev_attr->store)
87 ret = dev_attr->store(dev, dev_attr, buf, count);
88 return ret;
91 static struct sysfs_ops dev_sysfs_ops = {
92 .show = dev_attr_show,
93 .store = dev_attr_store,
97 /**
98 * device_release - free device structure.
99 * @kobj: device's kobject.
101 * This is called once the reference count for the object
102 * reaches 0. We forward the call to the device's release
103 * method, which should handle actually freeing the structure.
105 static void device_release(struct kobject *kobj)
107 struct device *dev = to_dev(kobj);
109 if (dev->release)
110 dev->release(dev);
111 else if (dev->type && dev->type->release)
112 dev->type->release(dev);
113 else if (dev->class && dev->class->dev_release)
114 dev->class->dev_release(dev);
115 else {
116 printk(KERN_ERR "Device '%s' does not have a release() "
117 "function, it is broken and must be fixed.\n",
118 dev->bus_id);
119 WARN_ON(1);
123 static struct kobj_type device_ktype = {
124 .release = device_release,
125 .sysfs_ops = &dev_sysfs_ops,
129 static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
131 struct kobj_type *ktype = get_ktype(kobj);
133 if (ktype == &device_ktype) {
134 struct device *dev = to_dev(kobj);
135 if (dev->uevent_suppress)
136 return 0;
137 if (dev->bus)
138 return 1;
139 if (dev->class)
140 return 1;
142 return 0;
145 static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
147 struct device *dev = to_dev(kobj);
149 if (dev->bus)
150 return dev->bus->name;
151 if (dev->class)
152 return dev->class->name;
153 return NULL;
156 static int dev_uevent(struct kset *kset, struct kobject *kobj,
157 struct kobj_uevent_env *env)
159 struct device *dev = to_dev(kobj);
160 int retval = 0;
162 /* add the major/minor if present */
163 if (MAJOR(dev->devt)) {
164 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
165 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
168 if (dev->type && dev->type->name)
169 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
171 if (dev->driver)
172 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
174 #ifdef CONFIG_SYSFS_DEPRECATED
175 if (dev->class) {
176 struct device *parent = dev->parent;
178 /* find first bus device in parent chain */
179 while (parent && !parent->bus)
180 parent = parent->parent;
181 if (parent && parent->bus) {
182 const char *path;
184 path = kobject_get_path(&parent->kobj, GFP_KERNEL);
185 if (path) {
186 add_uevent_var(env, "PHYSDEVPATH=%s", path);
187 kfree(path);
190 add_uevent_var(env, "PHYSDEVBUS=%s", parent->bus->name);
192 if (parent->driver)
193 add_uevent_var(env, "PHYSDEVDRIVER=%s",
194 parent->driver->name);
196 } else if (dev->bus) {
197 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
199 if (dev->driver)
200 add_uevent_var(env, "PHYSDEVDRIVER=%s",
201 dev->driver->name);
203 #endif
205 /* have the bus specific function add its stuff */
206 if (dev->bus && dev->bus->uevent) {
207 retval = dev->bus->uevent(dev, env);
208 if (retval)
209 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
210 dev->bus_id, __func__, retval);
213 /* have the class specific function add its stuff */
214 if (dev->class && dev->class->dev_uevent) {
215 retval = dev->class->dev_uevent(dev, env);
216 if (retval)
217 pr_debug("device: '%s': %s: class uevent() "
218 "returned %d\n", dev->bus_id,
219 __func__, retval);
222 /* have the device type specific fuction add its stuff */
223 if (dev->type && dev->type->uevent) {
224 retval = dev->type->uevent(dev, env);
225 if (retval)
226 pr_debug("device: '%s': %s: dev_type uevent() "
227 "returned %d\n", dev->bus_id,
228 __func__, retval);
231 return retval;
234 static struct kset_uevent_ops device_uevent_ops = {
235 .filter = dev_uevent_filter,
236 .name = dev_uevent_name,
237 .uevent = dev_uevent,
240 static ssize_t show_uevent(struct device *dev, struct device_attribute *attr,
241 char *buf)
243 struct kobject *top_kobj;
244 struct kset *kset;
245 struct kobj_uevent_env *env = NULL;
246 int i;
247 size_t count = 0;
248 int retval;
250 /* search the kset, the device belongs to */
251 top_kobj = &dev->kobj;
252 while (!top_kobj->kset && top_kobj->parent)
253 top_kobj = top_kobj->parent;
254 if (!top_kobj->kset)
255 goto out;
257 kset = top_kobj->kset;
258 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
259 goto out;
261 /* respect filter */
262 if (kset->uevent_ops && kset->uevent_ops->filter)
263 if (!kset->uevent_ops->filter(kset, &dev->kobj))
264 goto out;
266 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
267 if (!env)
268 return -ENOMEM;
270 /* let the kset specific function add its keys */
271 retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
272 if (retval)
273 goto out;
275 /* copy keys to file */
276 for (i = 0; i < env->envp_idx; i++)
277 count += sprintf(&buf[count], "%s\n", env->envp[i]);
278 out:
279 kfree(env);
280 return count;
283 static ssize_t store_uevent(struct device *dev, struct device_attribute *attr,
284 const char *buf, size_t count)
286 enum kobject_action action;
288 if (kobject_action_type(buf, count, &action) == 0) {
289 kobject_uevent(&dev->kobj, action);
290 goto out;
293 dev_err(dev, "uevent: unsupported action-string; this will "
294 "be ignored in a future kernel version\n");
295 kobject_uevent(&dev->kobj, KOBJ_ADD);
296 out:
297 return count;
300 static struct device_attribute uevent_attr =
301 __ATTR(uevent, S_IRUGO | S_IWUSR, show_uevent, store_uevent);
303 static int device_add_attributes(struct device *dev,
304 struct device_attribute *attrs)
306 int error = 0;
307 int i;
309 if (attrs) {
310 for (i = 0; attr_name(attrs[i]); i++) {
311 error = device_create_file(dev, &attrs[i]);
312 if (error)
313 break;
315 if (error)
316 while (--i >= 0)
317 device_remove_file(dev, &attrs[i]);
319 return error;
322 static void device_remove_attributes(struct device *dev,
323 struct device_attribute *attrs)
325 int i;
327 if (attrs)
328 for (i = 0; attr_name(attrs[i]); i++)
329 device_remove_file(dev, &attrs[i]);
332 static int device_add_groups(struct device *dev,
333 struct attribute_group **groups)
335 int error = 0;
336 int i;
338 if (groups) {
339 for (i = 0; groups[i]; i++) {
340 error = sysfs_create_group(&dev->kobj, groups[i]);
341 if (error) {
342 while (--i >= 0)
343 sysfs_remove_group(&dev->kobj,
344 groups[i]);
345 break;
349 return error;
352 static void device_remove_groups(struct device *dev,
353 struct attribute_group **groups)
355 int i;
357 if (groups)
358 for (i = 0; groups[i]; i++)
359 sysfs_remove_group(&dev->kobj, groups[i]);
362 static int device_add_attrs(struct device *dev)
364 struct class *class = dev->class;
365 struct device_type *type = dev->type;
366 int error;
368 if (class) {
369 error = device_add_attributes(dev, class->dev_attrs);
370 if (error)
371 return error;
374 if (type) {
375 error = device_add_groups(dev, type->groups);
376 if (error)
377 goto err_remove_class_attrs;
380 error = device_add_groups(dev, dev->groups);
381 if (error)
382 goto err_remove_type_groups;
384 return 0;
386 err_remove_type_groups:
387 if (type)
388 device_remove_groups(dev, type->groups);
389 err_remove_class_attrs:
390 if (class)
391 device_remove_attributes(dev, class->dev_attrs);
393 return error;
396 static void device_remove_attrs(struct device *dev)
398 struct class *class = dev->class;
399 struct device_type *type = dev->type;
401 device_remove_groups(dev, dev->groups);
403 if (type)
404 device_remove_groups(dev, type->groups);
406 if (class)
407 device_remove_attributes(dev, class->dev_attrs);
411 static ssize_t show_dev(struct device *dev, struct device_attribute *attr,
412 char *buf)
414 return print_dev_t(buf, dev->devt);
417 static struct device_attribute devt_attr =
418 __ATTR(dev, S_IRUGO, show_dev, NULL);
420 /* kset to create /sys/devices/ */
421 struct kset *devices_kset;
424 * device_create_file - create sysfs attribute file for device.
425 * @dev: device.
426 * @attr: device attribute descriptor.
428 int device_create_file(struct device *dev, struct device_attribute *attr)
430 int error = 0;
431 if (dev)
432 error = sysfs_create_file(&dev->kobj, &attr->attr);
433 return error;
437 * device_remove_file - remove sysfs attribute file.
438 * @dev: device.
439 * @attr: device attribute descriptor.
441 void device_remove_file(struct device *dev, struct device_attribute *attr)
443 if (dev)
444 sysfs_remove_file(&dev->kobj, &attr->attr);
448 * device_create_bin_file - create sysfs binary attribute file for device.
449 * @dev: device.
450 * @attr: device binary attribute descriptor.
452 int device_create_bin_file(struct device *dev, struct bin_attribute *attr)
454 int error = -EINVAL;
455 if (dev)
456 error = sysfs_create_bin_file(&dev->kobj, attr);
457 return error;
459 EXPORT_SYMBOL_GPL(device_create_bin_file);
462 * device_remove_bin_file - remove sysfs binary attribute file
463 * @dev: device.
464 * @attr: device binary attribute descriptor.
466 void device_remove_bin_file(struct device *dev, struct bin_attribute *attr)
468 if (dev)
469 sysfs_remove_bin_file(&dev->kobj, attr);
471 EXPORT_SYMBOL_GPL(device_remove_bin_file);
474 * device_schedule_callback_owner - helper to schedule a callback for a device
475 * @dev: device.
476 * @func: callback function to invoke later.
477 * @owner: module owning the callback routine
479 * Attribute methods must not unregister themselves or their parent device
480 * (which would amount to the same thing). Attempts to do so will deadlock,
481 * since unregistration is mutually exclusive with driver callbacks.
483 * Instead methods can call this routine, which will attempt to allocate
484 * and schedule a workqueue request to call back @func with @dev as its
485 * argument in the workqueue's process context. @dev will be pinned until
486 * @func returns.
488 * This routine is usually called via the inline device_schedule_callback(),
489 * which automatically sets @owner to THIS_MODULE.
491 * Returns 0 if the request was submitted, -ENOMEM if storage could not
492 * be allocated, -ENODEV if a reference to @owner isn't available.
494 * NOTE: This routine won't work if CONFIG_SYSFS isn't set! It uses an
495 * underlying sysfs routine (since it is intended for use by attribute
496 * methods), and if sysfs isn't available you'll get nothing but -ENOSYS.
498 int device_schedule_callback_owner(struct device *dev,
499 void (*func)(struct device *), struct module *owner)
501 return sysfs_schedule_callback(&dev->kobj,
502 (void (*)(void *)) func, dev, owner);
504 EXPORT_SYMBOL_GPL(device_schedule_callback_owner);
506 static void klist_children_get(struct klist_node *n)
508 struct device *dev = container_of(n, struct device, knode_parent);
510 get_device(dev);
513 static void klist_children_put(struct klist_node *n)
515 struct device *dev = container_of(n, struct device, knode_parent);
517 put_device(dev);
521 * device_initialize - init device structure.
522 * @dev: device.
524 * This prepares the device for use by other layers,
525 * including adding it to the device hierarchy.
526 * It is the first half of device_register(), if called by
527 * that, though it can also be called separately, so one
528 * may use @dev's fields (e.g. the refcount).
530 void device_initialize(struct device *dev)
532 dev->kobj.kset = devices_kset;
533 kobject_init(&dev->kobj, &device_ktype);
534 klist_init(&dev->klist_children, klist_children_get,
535 klist_children_put);
536 INIT_LIST_HEAD(&dev->dma_pools);
537 INIT_LIST_HEAD(&dev->node);
538 init_MUTEX(&dev->sem);
539 spin_lock_init(&dev->devres_lock);
540 INIT_LIST_HEAD(&dev->devres_head);
541 device_init_wakeup(dev, 0);
542 set_dev_node(dev, -1);
545 #ifdef CONFIG_SYSFS_DEPRECATED
546 static struct kobject *get_device_parent(struct device *dev,
547 struct device *parent)
549 /* class devices without a parent live in /sys/class/<classname>/ */
550 if (dev->class && (!parent || parent->class != dev->class))
551 return &dev->class->subsys.kobj;
552 /* all other devices keep their parent */
553 else if (parent)
554 return &parent->kobj;
556 return NULL;
559 static inline void cleanup_device_parent(struct device *dev) {}
560 static inline void cleanup_glue_dir(struct device *dev,
561 struct kobject *glue_dir) {}
562 #else
563 static struct kobject *virtual_device_parent(struct device *dev)
565 static struct kobject *virtual_dir = NULL;
567 if (!virtual_dir)
568 virtual_dir = kobject_create_and_add("virtual",
569 &devices_kset->kobj);
571 return virtual_dir;
574 static struct kobject *get_device_parent(struct device *dev,
575 struct device *parent)
577 int retval;
579 if (dev->class) {
580 struct kobject *kobj = NULL;
581 struct kobject *parent_kobj;
582 struct kobject *k;
585 * If we have no parent, we live in "virtual".
586 * Class-devices with a non class-device as parent, live
587 * in a "glue" directory to prevent namespace collisions.
589 if (parent == NULL)
590 parent_kobj = virtual_device_parent(dev);
591 else if (parent->class)
592 return &parent->kobj;
593 else
594 parent_kobj = &parent->kobj;
596 /* find our class-directory at the parent and reference it */
597 spin_lock(&dev->class->class_dirs.list_lock);
598 list_for_each_entry(k, &dev->class->class_dirs.list, entry)
599 if (k->parent == parent_kobj) {
600 kobj = kobject_get(k);
601 break;
603 spin_unlock(&dev->class->class_dirs.list_lock);
604 if (kobj)
605 return kobj;
607 /* or create a new class-directory at the parent device */
608 k = kobject_create();
609 if (!k)
610 return NULL;
611 k->kset = &dev->class->class_dirs;
612 retval = kobject_add(k, parent_kobj, "%s", dev->class->name);
613 if (retval < 0) {
614 kobject_put(k);
615 return NULL;
617 /* do not emit an uevent for this simple "glue" directory */
618 return k;
621 if (parent)
622 return &parent->kobj;
623 return NULL;
626 static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
628 /* see if we live in a "glue" directory */
629 if (!glue_dir || !dev->class ||
630 glue_dir->kset != &dev->class->class_dirs)
631 return;
633 kobject_put(glue_dir);
636 static void cleanup_device_parent(struct device *dev)
638 cleanup_glue_dir(dev, dev->kobj.parent);
640 #endif
642 static void setup_parent(struct device *dev, struct device *parent)
644 struct kobject *kobj;
645 kobj = get_device_parent(dev, parent);
646 if (kobj)
647 dev->kobj.parent = kobj;
650 static int device_add_class_symlinks(struct device *dev)
652 int error;
654 if (!dev->class)
655 return 0;
657 error = sysfs_create_link(&dev->kobj, &dev->class->subsys.kobj,
658 "subsystem");
659 if (error)
660 goto out;
662 #ifdef CONFIG_SYSFS_DEPRECATED
663 /* stacked class devices need a symlink in the class directory */
664 if (dev->kobj.parent != &dev->class->subsys.kobj &&
665 device_is_not_partition(dev)) {
666 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
667 dev->bus_id);
668 if (error)
669 goto out_subsys;
672 if (dev->parent && device_is_not_partition(dev)) {
673 struct device *parent = dev->parent;
674 char *class_name;
677 * stacked class devices have the 'device' link
678 * pointing to the bus device instead of the parent
680 while (parent->class && !parent->bus && parent->parent)
681 parent = parent->parent;
683 error = sysfs_create_link(&dev->kobj,
684 &parent->kobj,
685 "device");
686 if (error)
687 goto out_busid;
689 class_name = make_class_name(dev->class->name,
690 &dev->kobj);
691 if (class_name)
692 error = sysfs_create_link(&dev->parent->kobj,
693 &dev->kobj, class_name);
694 kfree(class_name);
695 if (error)
696 goto out_device;
698 return 0;
700 out_device:
701 if (dev->parent && device_is_not_partition(dev))
702 sysfs_remove_link(&dev->kobj, "device");
703 out_busid:
704 if (dev->kobj.parent != &dev->class->subsys.kobj &&
705 device_is_not_partition(dev))
706 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
707 #else
708 /* link in the class directory pointing to the device */
709 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
710 dev->bus_id);
711 if (error)
712 goto out_subsys;
714 if (dev->parent && device_is_not_partition(dev)) {
715 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
716 "device");
717 if (error)
718 goto out_busid;
720 return 0;
722 out_busid:
723 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
724 #endif
726 out_subsys:
727 sysfs_remove_link(&dev->kobj, "subsystem");
728 out:
729 return error;
732 static void device_remove_class_symlinks(struct device *dev)
734 if (!dev->class)
735 return;
737 #ifdef CONFIG_SYSFS_DEPRECATED
738 if (dev->parent && device_is_not_partition(dev)) {
739 char *class_name;
741 class_name = make_class_name(dev->class->name, &dev->kobj);
742 if (class_name) {
743 sysfs_remove_link(&dev->parent->kobj, class_name);
744 kfree(class_name);
746 sysfs_remove_link(&dev->kobj, "device");
749 if (dev->kobj.parent != &dev->class->subsys.kobj &&
750 device_is_not_partition(dev))
751 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
752 #else
753 if (dev->parent && device_is_not_partition(dev))
754 sysfs_remove_link(&dev->kobj, "device");
756 sysfs_remove_link(&dev->class->subsys.kobj, dev->bus_id);
757 #endif
759 sysfs_remove_link(&dev->kobj, "subsystem");
763 * dev_set_name - set a device name
764 * @dev: device
765 * @fmt: format string for the device's name
767 int dev_set_name(struct device *dev, const char *fmt, ...)
769 va_list vargs;
771 va_start(vargs, fmt);
772 vsnprintf(dev->bus_id, sizeof(dev->bus_id), fmt, vargs);
773 va_end(vargs);
774 return 0;
776 EXPORT_SYMBOL_GPL(dev_set_name);
779 * device_add - add device to device hierarchy.
780 * @dev: device.
782 * This is part 2 of device_register(), though may be called
783 * separately _iff_ device_initialize() has been called separately.
785 * This adds it to the kobject hierarchy via kobject_add(), adds it
786 * to the global and sibling lists for the device, then
787 * adds it to the other relevant subsystems of the driver model.
789 int device_add(struct device *dev)
791 struct device *parent = NULL;
792 struct class_interface *class_intf;
793 int error;
795 dev = get_device(dev);
796 if (!dev || !strlen(dev->bus_id)) {
797 error = -EINVAL;
798 goto Done;
801 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
803 parent = get_device(dev->parent);
804 setup_parent(dev, parent);
806 /* use parent numa_node */
807 if (parent)
808 set_dev_node(dev, dev_to_node(parent));
810 /* first, register with generic layer. */
811 error = kobject_add(&dev->kobj, dev->kobj.parent, "%s", dev->bus_id);
812 if (error)
813 goto Error;
815 /* notify platform of device entry */
816 if (platform_notify)
817 platform_notify(dev);
819 /* notify clients of device entry (new way) */
820 if (dev->bus)
821 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
822 BUS_NOTIFY_ADD_DEVICE, dev);
824 error = device_create_file(dev, &uevent_attr);
825 if (error)
826 goto attrError;
828 if (MAJOR(dev->devt)) {
829 error = device_create_file(dev, &devt_attr);
830 if (error)
831 goto ueventattrError;
834 error = device_add_class_symlinks(dev);
835 if (error)
836 goto SymlinkError;
837 error = device_add_attrs(dev);
838 if (error)
839 goto AttrsError;
840 error = bus_add_device(dev);
841 if (error)
842 goto BusError;
843 error = device_pm_add(dev);
844 if (error)
845 goto PMError;
846 kobject_uevent(&dev->kobj, KOBJ_ADD);
847 bus_attach_device(dev);
848 if (parent)
849 klist_add_tail(&dev->knode_parent, &parent->klist_children);
851 if (dev->class) {
852 down(&dev->class->sem);
853 /* tie the class to the device */
854 list_add_tail(&dev->node, &dev->class->devices);
856 /* notify any interfaces that the device is here */
857 list_for_each_entry(class_intf, &dev->class->interfaces, node)
858 if (class_intf->add_dev)
859 class_intf->add_dev(dev, class_intf);
860 up(&dev->class->sem);
862 Done:
863 put_device(dev);
864 return error;
865 PMError:
866 bus_remove_device(dev);
867 BusError:
868 if (dev->bus)
869 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
870 BUS_NOTIFY_DEL_DEVICE, dev);
871 device_remove_attrs(dev);
872 AttrsError:
873 device_remove_class_symlinks(dev);
874 SymlinkError:
875 if (MAJOR(dev->devt))
876 device_remove_file(dev, &devt_attr);
877 ueventattrError:
878 device_remove_file(dev, &uevent_attr);
879 attrError:
880 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
881 kobject_del(&dev->kobj);
882 Error:
883 cleanup_device_parent(dev);
884 if (parent)
885 put_device(parent);
886 goto Done;
890 * device_register - register a device with the system.
891 * @dev: pointer to the device structure
893 * This happens in two clean steps - initialize the device
894 * and add it to the system. The two steps can be called
895 * separately, but this is the easiest and most common.
896 * I.e. you should only call the two helpers separately if
897 * have a clearly defined need to use and refcount the device
898 * before it is added to the hierarchy.
900 int device_register(struct device *dev)
902 device_initialize(dev);
903 return device_add(dev);
907 * get_device - increment reference count for device.
908 * @dev: device.
910 * This simply forwards the call to kobject_get(), though
911 * we do take care to provide for the case that we get a NULL
912 * pointer passed in.
914 struct device *get_device(struct device *dev)
916 return dev ? to_dev(kobject_get(&dev->kobj)) : NULL;
920 * put_device - decrement reference count.
921 * @dev: device in question.
923 void put_device(struct device *dev)
925 /* might_sleep(); */
926 if (dev)
927 kobject_put(&dev->kobj);
931 * device_del - delete device from system.
932 * @dev: device.
934 * This is the first part of the device unregistration
935 * sequence. This removes the device from the lists we control
936 * from here, has it removed from the other driver model
937 * subsystems it was added to in device_add(), and removes it
938 * from the kobject hierarchy.
940 * NOTE: this should be called manually _iff_ device_add() was
941 * also called manually.
943 void device_del(struct device *dev)
945 struct device *parent = dev->parent;
946 struct class_interface *class_intf;
948 device_pm_remove(dev);
949 if (parent)
950 klist_del(&dev->knode_parent);
951 if (MAJOR(dev->devt))
952 device_remove_file(dev, &devt_attr);
953 if (dev->class) {
954 device_remove_class_symlinks(dev);
956 down(&dev->class->sem);
957 /* notify any interfaces that the device is now gone */
958 list_for_each_entry(class_intf, &dev->class->interfaces, node)
959 if (class_intf->remove_dev)
960 class_intf->remove_dev(dev, class_intf);
961 /* remove the device from the class list */
962 list_del_init(&dev->node);
963 up(&dev->class->sem);
965 device_remove_file(dev, &uevent_attr);
966 device_remove_attrs(dev);
967 bus_remove_device(dev);
970 * Some platform devices are driven without driver attached
971 * and managed resources may have been acquired. Make sure
972 * all resources are released.
974 devres_release_all(dev);
976 /* Notify the platform of the removal, in case they
977 * need to do anything...
979 if (platform_notify_remove)
980 platform_notify_remove(dev);
981 if (dev->bus)
982 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
983 BUS_NOTIFY_DEL_DEVICE, dev);
984 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
985 cleanup_device_parent(dev);
986 kobject_del(&dev->kobj);
987 put_device(parent);
991 * device_unregister - unregister device from system.
992 * @dev: device going away.
994 * We do this in two parts, like we do device_register(). First,
995 * we remove it from all the subsystems with device_del(), then
996 * we decrement the reference count via put_device(). If that
997 * is the final reference count, the device will be cleaned up
998 * via device_release() above. Otherwise, the structure will
999 * stick around until the final reference to the device is dropped.
1001 void device_unregister(struct device *dev)
1003 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
1004 device_del(dev);
1005 put_device(dev);
1008 static struct device *next_device(struct klist_iter *i)
1010 struct klist_node *n = klist_next(i);
1011 return n ? container_of(n, struct device, knode_parent) : NULL;
1015 * device_for_each_child - device child iterator.
1016 * @parent: parent struct device.
1017 * @data: data for the callback.
1018 * @fn: function to be called for each device.
1020 * Iterate over @parent's child devices, and call @fn for each,
1021 * passing it @data.
1023 * We check the return of @fn each time. If it returns anything
1024 * other than 0, we break out and return that value.
1026 int device_for_each_child(struct device *parent, void *data,
1027 int (*fn)(struct device *dev, void *data))
1029 struct klist_iter i;
1030 struct device *child;
1031 int error = 0;
1033 klist_iter_init(&parent->klist_children, &i);
1034 while ((child = next_device(&i)) && !error)
1035 error = fn(child, data);
1036 klist_iter_exit(&i);
1037 return error;
1041 * device_find_child - device iterator for locating a particular device.
1042 * @parent: parent struct device
1043 * @data: Data to pass to match function
1044 * @match: Callback function to check device
1046 * This is similar to the device_for_each_child() function above, but it
1047 * returns a reference to a device that is 'found' for later use, as
1048 * determined by the @match callback.
1050 * The callback should return 0 if the device doesn't match and non-zero
1051 * if it does. If the callback returns non-zero and a reference to the
1052 * current device can be obtained, this function will return to the caller
1053 * and not iterate over any more devices.
1055 struct device *device_find_child(struct device *parent, void *data,
1056 int (*match)(struct device *dev, void *data))
1058 struct klist_iter i;
1059 struct device *child;
1061 if (!parent)
1062 return NULL;
1064 klist_iter_init(&parent->klist_children, &i);
1065 while ((child = next_device(&i)))
1066 if (match(child, data) && get_device(child))
1067 break;
1068 klist_iter_exit(&i);
1069 return child;
1072 int __init devices_init(void)
1074 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
1075 if (!devices_kset)
1076 return -ENOMEM;
1077 return 0;
1080 EXPORT_SYMBOL_GPL(device_for_each_child);
1081 EXPORT_SYMBOL_GPL(device_find_child);
1083 EXPORT_SYMBOL_GPL(device_initialize);
1084 EXPORT_SYMBOL_GPL(device_add);
1085 EXPORT_SYMBOL_GPL(device_register);
1087 EXPORT_SYMBOL_GPL(device_del);
1088 EXPORT_SYMBOL_GPL(device_unregister);
1089 EXPORT_SYMBOL_GPL(get_device);
1090 EXPORT_SYMBOL_GPL(put_device);
1092 EXPORT_SYMBOL_GPL(device_create_file);
1093 EXPORT_SYMBOL_GPL(device_remove_file);
1096 static void device_create_release(struct device *dev)
1098 pr_debug("device: '%s': %s\n", dev->bus_id, __func__);
1099 kfree(dev);
1103 * device_create_vargs - creates a device and registers it with sysfs
1104 * @class: pointer to the struct class that this device should be registered to
1105 * @parent: pointer to the parent struct device of this new device, if any
1106 * @devt: the dev_t for the char device to be added
1107 * @drvdata: the data to be added to the device for callbacks
1108 * @fmt: string for the device's name
1109 * @args: va_list for the device's name
1111 * This function can be used by char device classes. A struct device
1112 * will be created in sysfs, registered to the specified class.
1114 * A "dev" file will be created, showing the dev_t for the device, if
1115 * the dev_t is not 0,0.
1116 * If a pointer to a parent struct device is passed in, the newly created
1117 * struct device will be a child of that device in sysfs.
1118 * The pointer to the struct device will be returned from the call.
1119 * Any further sysfs files that might be required can be created using this
1120 * pointer.
1122 * Note: the struct class passed to this function must have previously
1123 * been created with a call to class_create().
1125 struct device *device_create_vargs(struct class *class, struct device *parent,
1126 dev_t devt, void *drvdata, const char *fmt,
1127 va_list args)
1129 struct device *dev = NULL;
1130 int retval = -ENODEV;
1132 if (class == NULL || IS_ERR(class))
1133 goto error;
1135 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1136 if (!dev) {
1137 retval = -ENOMEM;
1138 goto error;
1141 dev->devt = devt;
1142 dev->class = class;
1143 dev->parent = parent;
1144 dev->release = device_create_release;
1145 dev_set_drvdata(dev, drvdata);
1147 vsnprintf(dev->bus_id, BUS_ID_SIZE, fmt, args);
1148 retval = device_register(dev);
1149 if (retval)
1150 goto error;
1152 return dev;
1154 error:
1155 kfree(dev);
1156 return ERR_PTR(retval);
1158 EXPORT_SYMBOL_GPL(device_create_vargs);
1161 * device_create_drvdata - creates a device and registers it with sysfs
1162 * @class: pointer to the struct class that this device should be registered to
1163 * @parent: pointer to the parent struct device of this new device, if any
1164 * @devt: the dev_t for the char device to be added
1165 * @drvdata: the data to be added to the device for callbacks
1166 * @fmt: string for the device's name
1168 * This function can be used by char device classes. A struct device
1169 * will be created in sysfs, registered to the specified class.
1171 * A "dev" file will be created, showing the dev_t for the device, if
1172 * the dev_t is not 0,0.
1173 * If a pointer to a parent struct device is passed in, the newly created
1174 * struct device will be a child of that device in sysfs.
1175 * The pointer to the struct device will be returned from the call.
1176 * Any further sysfs files that might be required can be created using this
1177 * pointer.
1179 * Note: the struct class passed to this function must have previously
1180 * been created with a call to class_create().
1182 struct device *device_create_drvdata(struct class *class,
1183 struct device *parent,
1184 dev_t devt,
1185 void *drvdata,
1186 const char *fmt, ...)
1188 va_list vargs;
1189 struct device *dev;
1191 va_start(vargs, fmt);
1192 dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
1193 va_end(vargs);
1194 return dev;
1196 EXPORT_SYMBOL_GPL(device_create_drvdata);
1199 * device_create - creates a device and registers it with sysfs
1200 * @class: pointer to the struct class that this device should be registered to
1201 * @parent: pointer to the parent struct device of this new device, if any
1202 * @devt: the dev_t for the char device to be added
1203 * @fmt: string for the device's name
1205 * This function can be used by char device classes. A struct device
1206 * will be created in sysfs, registered to the specified class.
1208 * A "dev" file will be created, showing the dev_t for the device, if
1209 * the dev_t is not 0,0.
1210 * If a pointer to a parent struct device is passed in, the newly created
1211 * struct device will be a child of that device in sysfs.
1212 * The pointer to the struct device will be returned from the call.
1213 * Any further sysfs files that might be required can be created using this
1214 * pointer.
1216 * Note: the struct class passed to this function must have previously
1217 * been created with a call to class_create().
1219 struct device *device_create(struct class *class, struct device *parent,
1220 dev_t devt, const char *fmt, ...)
1222 va_list vargs;
1223 struct device *dev;
1225 va_start(vargs, fmt);
1226 dev = device_create_vargs(class, parent, devt, NULL, fmt, vargs);
1227 va_end(vargs);
1228 return dev;
1230 EXPORT_SYMBOL_GPL(device_create);
1232 static int __match_devt(struct device *dev, void *data)
1234 dev_t *devt = data;
1236 return dev->devt == *devt;
1240 * device_destroy - removes a device that was created with device_create()
1241 * @class: pointer to the struct class that this device was registered with
1242 * @devt: the dev_t of the device that was previously registered
1244 * This call unregisters and cleans up a device that was created with a
1245 * call to device_create().
1247 void device_destroy(struct class *class, dev_t devt)
1249 struct device *dev;
1251 dev = class_find_device(class, &devt, __match_devt);
1252 if (dev) {
1253 put_device(dev);
1254 device_unregister(dev);
1257 EXPORT_SYMBOL_GPL(device_destroy);
1260 * device_rename - renames a device
1261 * @dev: the pointer to the struct device to be renamed
1262 * @new_name: the new name of the device
1264 int device_rename(struct device *dev, char *new_name)
1266 char *old_class_name = NULL;
1267 char *new_class_name = NULL;
1268 char *old_device_name = NULL;
1269 int error;
1271 dev = get_device(dev);
1272 if (!dev)
1273 return -EINVAL;
1275 pr_debug("device: '%s': %s: renaming to '%s'\n", dev->bus_id,
1276 __func__, new_name);
1278 #ifdef CONFIG_SYSFS_DEPRECATED
1279 if ((dev->class) && (dev->parent))
1280 old_class_name = make_class_name(dev->class->name, &dev->kobj);
1281 #endif
1283 old_device_name = kmalloc(BUS_ID_SIZE, GFP_KERNEL);
1284 if (!old_device_name) {
1285 error = -ENOMEM;
1286 goto out;
1288 strlcpy(old_device_name, dev->bus_id, BUS_ID_SIZE);
1289 strlcpy(dev->bus_id, new_name, BUS_ID_SIZE);
1291 error = kobject_rename(&dev->kobj, new_name);
1292 if (error) {
1293 strlcpy(dev->bus_id, old_device_name, BUS_ID_SIZE);
1294 goto out;
1297 #ifdef CONFIG_SYSFS_DEPRECATED
1298 if (old_class_name) {
1299 new_class_name = make_class_name(dev->class->name, &dev->kobj);
1300 if (new_class_name) {
1301 error = sysfs_create_link(&dev->parent->kobj,
1302 &dev->kobj, new_class_name);
1303 if (error)
1304 goto out;
1305 sysfs_remove_link(&dev->parent->kobj, old_class_name);
1308 #else
1309 if (dev->class) {
1310 error = sysfs_create_link(&dev->class->subsys.kobj, &dev->kobj,
1311 dev->bus_id);
1312 if (error)
1313 goto out;
1314 sysfs_remove_link(&dev->class->subsys.kobj, old_device_name);
1316 #endif
1318 out:
1319 put_device(dev);
1321 kfree(new_class_name);
1322 kfree(old_class_name);
1323 kfree(old_device_name);
1325 return error;
1327 EXPORT_SYMBOL_GPL(device_rename);
1329 static int device_move_class_links(struct device *dev,
1330 struct device *old_parent,
1331 struct device *new_parent)
1333 int error = 0;
1334 #ifdef CONFIG_SYSFS_DEPRECATED
1335 char *class_name;
1337 class_name = make_class_name(dev->class->name, &dev->kobj);
1338 if (!class_name) {
1339 error = -ENOMEM;
1340 goto out;
1342 if (old_parent) {
1343 sysfs_remove_link(&dev->kobj, "device");
1344 sysfs_remove_link(&old_parent->kobj, class_name);
1346 if (new_parent) {
1347 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1348 "device");
1349 if (error)
1350 goto out;
1351 error = sysfs_create_link(&new_parent->kobj, &dev->kobj,
1352 class_name);
1353 if (error)
1354 sysfs_remove_link(&dev->kobj, "device");
1355 } else
1356 error = 0;
1357 out:
1358 kfree(class_name);
1359 return error;
1360 #else
1361 if (old_parent)
1362 sysfs_remove_link(&dev->kobj, "device");
1363 if (new_parent)
1364 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
1365 "device");
1366 return error;
1367 #endif
1371 * device_move - moves a device to a new parent
1372 * @dev: the pointer to the struct device to be moved
1373 * @new_parent: the new parent of the device (can by NULL)
1375 int device_move(struct device *dev, struct device *new_parent)
1377 int error;
1378 struct device *old_parent;
1379 struct kobject *new_parent_kobj;
1381 dev = get_device(dev);
1382 if (!dev)
1383 return -EINVAL;
1385 new_parent = get_device(new_parent);
1386 new_parent_kobj = get_device_parent(dev, new_parent);
1388 pr_debug("device: '%s': %s: moving to '%s'\n", dev->bus_id,
1389 __func__, new_parent ? new_parent->bus_id : "<NULL>");
1390 error = kobject_move(&dev->kobj, new_parent_kobj);
1391 if (error) {
1392 cleanup_glue_dir(dev, new_parent_kobj);
1393 put_device(new_parent);
1394 goto out;
1396 old_parent = dev->parent;
1397 dev->parent = new_parent;
1398 if (old_parent)
1399 klist_remove(&dev->knode_parent);
1400 if (new_parent) {
1401 klist_add_tail(&dev->knode_parent, &new_parent->klist_children);
1402 set_dev_node(dev, dev_to_node(new_parent));
1405 if (!dev->class)
1406 goto out_put;
1407 error = device_move_class_links(dev, old_parent, new_parent);
1408 if (error) {
1409 /* We ignore errors on cleanup since we're hosed anyway... */
1410 device_move_class_links(dev, new_parent, old_parent);
1411 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
1412 if (new_parent)
1413 klist_remove(&dev->knode_parent);
1414 dev->parent = old_parent;
1415 if (old_parent) {
1416 klist_add_tail(&dev->knode_parent,
1417 &old_parent->klist_children);
1418 set_dev_node(dev, dev_to_node(old_parent));
1421 cleanup_glue_dir(dev, new_parent_kobj);
1422 put_device(new_parent);
1423 goto out;
1425 out_put:
1426 put_device(old_parent);
1427 out:
1428 put_device(dev);
1429 return error;
1431 EXPORT_SYMBOL_GPL(device_move);
1434 * device_shutdown - call ->shutdown() on each device to shutdown.
1436 void device_shutdown(void)
1438 struct device *dev, *devn;
1440 list_for_each_entry_safe_reverse(dev, devn, &devices_kset->list,
1441 kobj.entry) {
1442 if (dev->bus && dev->bus->shutdown) {
1443 dev_dbg(dev, "shutdown\n");
1444 dev->bus->shutdown(dev);
1445 } else if (dev->driver && dev->driver->shutdown) {
1446 dev_dbg(dev, "shutdown\n");
1447 dev->driver->shutdown(dev);