2 * class.c - basic device class management
4 * Copyright (c) 2002-3 Patrick Mochel
5 * Copyright (c) 2002-3 Open Source Development Labs
6 * Copyright (c) 2003-2004 Greg Kroah-Hartman
7 * Copyright (c) 2003-2004 IBM Corp.
9 * This file is released under the GPLv2
13 #include <linux/device.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/string.h>
17 #include <linux/kdev_t.h>
18 #include <linux/err.h>
19 #include <linux/slab.h>
20 #include <linux/genhd.h>
23 #define to_class_attr(_attr) container_of(_attr, struct class_attribute, attr)
24 #define to_class(obj) container_of(obj, struct class, subsys.kobj)
26 static ssize_t class_attr_show(struct kobject *kobj, struct attribute *attr,
29 struct class_attribute *class_attr = to_class_attr(attr);
30 struct class *dc = to_class(kobj);
34 ret = class_attr->show(dc, buf);
38 static ssize_t class_attr_store(struct kobject *kobj, struct attribute *attr,
39 const char *buf, size_t count)
41 struct class_attribute *class_attr = to_class_attr(attr);
42 struct class *dc = to_class(kobj);
45 if (class_attr->store)
46 ret = class_attr->store(dc, buf, count);
50 static void class_release(struct kobject *kobj)
52 struct class *class = to_class(kobj);
54 pr_debug("class '%s': release.\n", class->name);
56 if (class->class_release)
57 class->class_release(class);
59 pr_debug("class '%s' does not have a release() function, "
60 "be careful\n", class->name);
63 static struct sysfs_ops class_sysfs_ops = {
64 .show = class_attr_show,
65 .store = class_attr_store,
68 static struct kobj_type class_ktype = {
69 .sysfs_ops = &class_sysfs_ops,
70 .release = class_release,
73 /* Hotplug events for classes go to the class_obj subsys */
74 static struct kset *class_kset;
77 int class_create_file(struct class *cls, const struct class_attribute *attr)
81 error = sysfs_create_file(&cls->subsys.kobj, &attr->attr);
87 void class_remove_file(struct class *cls, const struct class_attribute *attr)
90 sysfs_remove_file(&cls->subsys.kobj, &attr->attr);
93 static struct class *class_get(struct class *cls)
96 return container_of(kset_get(&cls->subsys),
97 struct class, subsys);
101 static void class_put(struct class *cls)
104 kset_put(&cls->subsys);
107 static int add_class_attrs(struct class *cls)
112 if (cls->class_attrs) {
113 for (i = 0; attr_name(cls->class_attrs[i]); i++) {
114 error = class_create_file(cls, &cls->class_attrs[i]);
123 class_remove_file(cls, &cls->class_attrs[i]);
127 static void remove_class_attrs(struct class *cls)
131 if (cls->class_attrs) {
132 for (i = 0; attr_name(cls->class_attrs[i]); i++)
133 class_remove_file(cls, &cls->class_attrs[i]);
137 int class_register(struct class *cls)
141 pr_debug("device class '%s': registering\n", cls->name);
143 INIT_LIST_HEAD(&cls->children);
144 INIT_LIST_HEAD(&cls->devices);
145 INIT_LIST_HEAD(&cls->interfaces);
146 kset_init(&cls->class_dirs);
147 init_MUTEX(&cls->sem);
148 error = kobject_set_name(&cls->subsys.kobj, "%s", cls->name);
152 #if defined(CONFIG_SYSFS_DEPRECATED) && defined(CONFIG_BLOCK)
153 /* let the block class directory show up in the root of sysfs */
154 if (cls != &block_class)
155 cls->subsys.kobj.kset = class_kset;
157 cls->subsys.kobj.kset = class_kset;
159 cls->subsys.kobj.ktype = &class_ktype;
161 error = kset_register(&cls->subsys);
163 error = add_class_attrs(class_get(cls));
169 void class_unregister(struct class *cls)
171 pr_debug("device class '%s': unregistering\n", cls->name);
172 remove_class_attrs(cls);
173 kset_unregister(&cls->subsys);
176 static void class_create_release(struct class *cls)
178 pr_debug("%s called for %s\n", __func__, cls->name);
182 static void class_device_create_release(struct class_device *class_dev)
184 pr_debug("%s called for %s\n", __func__, class_dev->class_id);
188 /* needed to allow these devices to have parent class devices */
189 static int class_device_create_uevent(struct class_device *class_dev,
190 struct kobj_uevent_env *env)
192 pr_debug("%s called for %s\n", __func__, class_dev->class_id);
197 * class_create - create a struct class structure
198 * @owner: pointer to the module that is to "own" this struct class
199 * @name: pointer to a string for the name of this class.
201 * This is used to create a struct class pointer that can then be used
202 * in calls to class_device_create().
204 * Note, the pointer created here is to be destroyed when finished by
205 * making a call to class_destroy().
207 struct class *class_create(struct module *owner, const char *name)
212 cls = kzalloc(sizeof(*cls), GFP_KERNEL);
220 cls->class_release = class_create_release;
221 cls->release = class_device_create_release;
223 retval = class_register(cls);
231 return ERR_PTR(retval);
235 * class_destroy - destroys a struct class structure
236 * @cls: pointer to the struct class that is to be destroyed
238 * Note, the pointer to be destroyed must have been created with a call
241 void class_destroy(struct class *cls)
243 if ((cls == NULL) || (IS_ERR(cls)))
246 class_unregister(cls);
249 /* Class Device Stuff */
251 int class_device_create_file(struct class_device *class_dev,
252 const struct class_device_attribute *attr)
256 error = sysfs_create_file(&class_dev->kobj, &attr->attr);
260 void class_device_remove_file(struct class_device *class_dev,
261 const struct class_device_attribute *attr)
264 sysfs_remove_file(&class_dev->kobj, &attr->attr);
267 int class_device_create_bin_file(struct class_device *class_dev,
268 struct bin_attribute *attr)
272 error = sysfs_create_bin_file(&class_dev->kobj, attr);
276 void class_device_remove_bin_file(struct class_device *class_dev,
277 struct bin_attribute *attr)
280 sysfs_remove_bin_file(&class_dev->kobj, attr);
283 static ssize_t class_device_attr_show(struct kobject *kobj,
284 struct attribute *attr, char *buf)
286 struct class_device_attribute *class_dev_attr = to_class_dev_attr(attr);
287 struct class_device *cd = to_class_dev(kobj);
290 if (class_dev_attr->show)
291 ret = class_dev_attr->show(cd, buf);
295 static ssize_t class_device_attr_store(struct kobject *kobj,
296 struct attribute *attr,
297 const char *buf, size_t count)
299 struct class_device_attribute *class_dev_attr = to_class_dev_attr(attr);
300 struct class_device *cd = to_class_dev(kobj);
303 if (class_dev_attr->store)
304 ret = class_dev_attr->store(cd, buf, count);
308 static struct sysfs_ops class_dev_sysfs_ops = {
309 .show = class_device_attr_show,
310 .store = class_device_attr_store,
313 static void class_dev_release(struct kobject *kobj)
315 struct class_device *cd = to_class_dev(kobj);
316 struct class *cls = cd->class;
318 pr_debug("device class '%s': release.\n", cd->class_id);
322 else if (cls->release)
325 printk(KERN_ERR "Class Device '%s' does not have a release() "
326 "function, it is broken and must be fixed.\n",
332 static struct kobj_type class_device_ktype = {
333 .sysfs_ops = &class_dev_sysfs_ops,
334 .release = class_dev_release,
337 static int class_uevent_filter(struct kset *kset, struct kobject *kobj)
339 struct kobj_type *ktype = get_ktype(kobj);
341 if (ktype == &class_device_ktype) {
342 struct class_device *class_dev = to_class_dev(kobj);
343 if (class_dev->class)
349 static const char *class_uevent_name(struct kset *kset, struct kobject *kobj)
351 struct class_device *class_dev = to_class_dev(kobj);
353 return class_dev->class->name;
356 #ifdef CONFIG_SYSFS_DEPRECATED
357 char *make_class_name(const char *name, struct kobject *kobj)
362 size = strlen(name) + strlen(kobject_name(kobj)) + 2;
364 class_name = kmalloc(size, GFP_KERNEL);
368 strcpy(class_name, name);
369 strcat(class_name, ":");
370 strcat(class_name, kobject_name(kobj));
374 static int make_deprecated_class_device_links(struct class_device *class_dev)
382 class_name = make_class_name(class_dev->class->name, &class_dev->kobj);
384 error = sysfs_create_link(&class_dev->dev->kobj,
385 &class_dev->kobj, class_name);
392 static void remove_deprecated_class_device_links(struct class_device *class_dev)
399 class_name = make_class_name(class_dev->class->name, &class_dev->kobj);
401 sysfs_remove_link(&class_dev->dev->kobj, class_name);
405 static inline int make_deprecated_class_device_links(struct class_device *cd)
407 static void remove_deprecated_class_device_links(struct class_device *cd)
411 static int class_uevent(struct kset *kset, struct kobject *kobj,
412 struct kobj_uevent_env *env)
414 struct class_device *class_dev = to_class_dev(kobj);
415 struct device *dev = class_dev->dev;
418 pr_debug("%s - name = %s\n", __func__, class_dev->class_id);
420 if (MAJOR(class_dev->devt)) {
421 add_uevent_var(env, "MAJOR=%u", MAJOR(class_dev->devt));
423 add_uevent_var(env, "MINOR=%u", MINOR(class_dev->devt));
427 const char *path = kobject_get_path(&dev->kobj, GFP_KERNEL);
429 add_uevent_var(env, "PHYSDEVPATH=%s", path);
434 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
437 add_uevent_var(env, "PHYSDEVDRIVER=%s",
441 if (class_dev->uevent) {
442 /* have the class device specific function add its stuff */
443 retval = class_dev->uevent(class_dev, env);
445 pr_debug("class_dev->uevent() returned %d\n", retval);
446 } else if (class_dev->class->uevent) {
447 /* have the class specific function add its stuff */
448 retval = class_dev->class->uevent(class_dev, env);
450 pr_debug("class->uevent() returned %d\n", retval);
456 static struct kset_uevent_ops class_uevent_ops = {
457 .filter = class_uevent_filter,
458 .name = class_uevent_name,
459 .uevent = class_uevent,
463 * DO NOT copy how this is created, kset_create_and_add() should be
464 * called, but this is a hold-over from the old-way and will be deleted
467 static struct kset class_obj_subsys = {
468 .uevent_ops = &class_uevent_ops,
471 static int class_device_add_attrs(struct class_device *cd)
475 struct class *cls = cd->class;
477 if (cls->class_dev_attrs) {
478 for (i = 0; attr_name(cls->class_dev_attrs[i]); i++) {
479 error = class_device_create_file(cd,
480 &cls->class_dev_attrs[i]);
489 class_device_remove_file(cd, &cls->class_dev_attrs[i]);
493 static void class_device_remove_attrs(struct class_device *cd)
496 struct class *cls = cd->class;
498 if (cls->class_dev_attrs) {
499 for (i = 0; attr_name(cls->class_dev_attrs[i]); i++)
500 class_device_remove_file(cd, &cls->class_dev_attrs[i]);
504 static int class_device_add_groups(struct class_device *cd)
510 for (i = 0; cd->groups[i]; i++) {
511 error = sysfs_create_group(&cd->kobj, cd->groups[i]);
514 sysfs_remove_group(&cd->kobj,
524 static void class_device_remove_groups(struct class_device *cd)
528 for (i = 0; cd->groups[i]; i++)
529 sysfs_remove_group(&cd->kobj, cd->groups[i]);
532 static ssize_t show_dev(struct class_device *class_dev, char *buf)
534 return print_dev_t(buf, class_dev->devt);
537 static struct class_device_attribute class_devt_attr =
538 __ATTR(dev, S_IRUGO, show_dev, NULL);
540 static ssize_t store_uevent(struct class_device *class_dev,
541 const char *buf, size_t count)
543 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
547 static struct class_device_attribute class_uevent_attr =
548 __ATTR(uevent, S_IWUSR, NULL, store_uevent);
550 void class_device_initialize(struct class_device *class_dev)
552 class_dev->kobj.kset = &class_obj_subsys;
553 kobject_init(&class_dev->kobj, &class_device_ktype);
554 INIT_LIST_HEAD(&class_dev->node);
557 int class_device_add(struct class_device *class_dev)
559 struct class *parent_class = NULL;
560 struct class_device *parent_class_dev = NULL;
561 struct class_interface *class_intf;
564 class_dev = class_device_get(class_dev);
568 if (!strlen(class_dev->class_id))
571 parent_class = class_get(class_dev->class);
575 parent_class_dev = class_device_get(class_dev->parent);
577 pr_debug("CLASS: registering class device: ID = '%s'\n",
578 class_dev->class_id);
580 /* first, register with generic layer. */
581 if (parent_class_dev)
582 class_dev->kobj.parent = &parent_class_dev->kobj;
584 class_dev->kobj.parent = &parent_class->subsys.kobj;
586 error = kobject_add(&class_dev->kobj, class_dev->kobj.parent,
587 "%s", class_dev->class_id);
591 /* add the needed attributes to this device */
592 error = sysfs_create_link(&class_dev->kobj,
593 &parent_class->subsys.kobj, "subsystem");
597 error = class_device_create_file(class_dev, &class_uevent_attr);
601 if (MAJOR(class_dev->devt)) {
602 error = class_device_create_file(class_dev, &class_devt_attr);
607 error = class_device_add_attrs(class_dev);
611 if (class_dev->dev) {
612 error = sysfs_create_link(&class_dev->kobj,
613 &class_dev->dev->kobj, "device");
618 error = class_device_add_groups(class_dev);
622 error = make_deprecated_class_device_links(class_dev);
626 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
628 /* notify any interfaces this device is now here */
629 down(&parent_class->sem);
630 list_add_tail(&class_dev->node, &parent_class->children);
631 list_for_each_entry(class_intf, &parent_class->interfaces, node) {
633 class_intf->add(class_dev, class_intf);
635 up(&parent_class->sem);
640 class_device_remove_groups(class_dev);
643 sysfs_remove_link(&class_dev->kobj, "device");
645 class_device_remove_attrs(class_dev);
647 if (MAJOR(class_dev->devt))
648 class_device_remove_file(class_dev, &class_devt_attr);
650 class_device_remove_file(class_dev, &class_uevent_attr);
652 kobject_del(&class_dev->kobj);
654 if (parent_class_dev)
655 class_device_put(parent_class_dev);
656 class_put(parent_class);
658 class_device_put(class_dev);
662 int class_device_register(struct class_device *class_dev)
664 class_device_initialize(class_dev);
665 return class_device_add(class_dev);
669 * class_device_create - creates a class device and registers it with sysfs
670 * @cls: pointer to the struct class that this device should be registered to.
671 * @parent: pointer to the parent struct class_device of this new device, if
673 * @devt: the dev_t for the char device to be added.
674 * @device: a pointer to a struct device that is assiociated with this class
676 * @fmt: string for the class device's name
678 * This function can be used by char device classes. A struct
679 * class_device will be created in sysfs, registered to the specified
681 * A "dev" file will be created, showing the dev_t for the device, if
682 * the dev_t is not 0,0.
683 * If a pointer to a parent struct class_device is passed in, the newly
684 * created struct class_device will be a child of that device in sysfs.
685 * The pointer to the struct class_device will be returned from the
686 * call. Any further sysfs files that might be required can be created
687 * using this pointer.
689 * Note: the struct class passed to this function must have previously
690 * been created with a call to class_create().
692 struct class_device *class_device_create(struct class *cls,
693 struct class_device *parent,
695 struct device *device,
696 const char *fmt, ...)
699 struct class_device *class_dev = NULL;
700 int retval = -ENODEV;
702 if (cls == NULL || IS_ERR(cls))
705 class_dev = kzalloc(sizeof(*class_dev), GFP_KERNEL);
711 class_dev->devt = devt;
712 class_dev->dev = device;
713 class_dev->class = cls;
714 class_dev->parent = parent;
715 class_dev->release = class_device_create_release;
716 class_dev->uevent = class_device_create_uevent;
719 vsnprintf(class_dev->class_id, BUS_ID_SIZE, fmt, args);
721 retval = class_device_register(class_dev);
729 return ERR_PTR(retval);
732 void class_device_del(struct class_device *class_dev)
734 struct class *parent_class = class_dev->class;
735 struct class_device *parent_device = class_dev->parent;
736 struct class_interface *class_intf;
739 down(&parent_class->sem);
740 list_del_init(&class_dev->node);
741 list_for_each_entry(class_intf, &parent_class->interfaces, node)
742 if (class_intf->remove)
743 class_intf->remove(class_dev, class_intf);
744 up(&parent_class->sem);
747 if (class_dev->dev) {
748 remove_deprecated_class_device_links(class_dev);
749 sysfs_remove_link(&class_dev->kobj, "device");
751 sysfs_remove_link(&class_dev->kobj, "subsystem");
752 class_device_remove_file(class_dev, &class_uevent_attr);
753 if (MAJOR(class_dev->devt))
754 class_device_remove_file(class_dev, &class_devt_attr);
755 class_device_remove_attrs(class_dev);
756 class_device_remove_groups(class_dev);
758 kobject_uevent(&class_dev->kobj, KOBJ_REMOVE);
759 kobject_del(&class_dev->kobj);
761 class_device_put(parent_device);
762 class_put(parent_class);
765 void class_device_unregister(struct class_device *class_dev)
767 pr_debug("CLASS: Unregistering class device. ID = '%s'\n",
768 class_dev->class_id);
769 class_device_del(class_dev);
770 class_device_put(class_dev);
774 * class_device_destroy - removes a class device that was created with class_device_create()
775 * @cls: the pointer to the struct class that this device was registered * with.
776 * @devt: the dev_t of the device that was previously registered.
778 * This call unregisters and cleans up a class device that was created with a
779 * call to class_device_create()
781 void class_device_destroy(struct class *cls, dev_t devt)
783 struct class_device *class_dev = NULL;
784 struct class_device *class_dev_tmp;
787 list_for_each_entry(class_dev_tmp, &cls->children, node) {
788 if (class_dev_tmp->devt == devt) {
789 class_dev = class_dev_tmp;
796 class_device_unregister(class_dev);
799 struct class_device *class_device_get(struct class_device *class_dev)
802 return to_class_dev(kobject_get(&class_dev->kobj));
806 void class_device_put(struct class_device *class_dev)
809 kobject_put(&class_dev->kobj);
813 * class_for_each_device - device iterator
814 * @class: the class we're iterating
815 * @data: data for the callback
816 * @fn: function to be called for each device
818 * Iterate over @class's list of devices, and call @fn for each,
821 * We check the return of @fn each time. If it returns anything
822 * other than 0, we break out and return that value.
824 * Note, we hold class->sem in this function, so it can not be
825 * re-acquired in @fn, otherwise it will self-deadlocking. For
826 * example, calls to add or remove class members would be verboten.
828 int class_for_each_device(struct class *class, void *data,
829 int (*fn)(struct device *, void *))
837 list_for_each_entry(dev, &class->devices, node) {
838 dev = get_device(dev);
840 error = fn(dev, data);
851 EXPORT_SYMBOL_GPL(class_for_each_device);
854 * class_find_device - device iterator for locating a particular device
855 * @class: the class we're iterating
856 * @data: data for the match function
857 * @match: function to check device
859 * This is similar to the class_for_each_dev() function above, but it
860 * returns a reference to a device that is 'found' for later use, as
861 * determined by the @match callback.
863 * The callback should return 0 if the device doesn't match and non-zero
864 * if it does. If the callback returns non-zero, this function will
865 * return to the caller and not iterate over any more devices.
867 * Note, you will need to drop the reference with put_device() after use.
869 * We hold class->sem in this function, so it can not be
870 * re-acquired in @match, otherwise it will self-deadlocking. For
871 * example, calls to add or remove class members would be verboten.
873 struct device *class_find_device(struct class *class, void *data,
874 int (*match)(struct device *, void *))
883 list_for_each_entry(dev, &class->devices, node) {
884 dev = get_device(dev);
886 if (match(dev, data)) {
896 return found ? dev : NULL;
898 EXPORT_SYMBOL_GPL(class_find_device);
901 * class_find_child - device iterator for locating a particular class_device
902 * @class: the class we're iterating
903 * @data: data for the match function
904 * @match: function to check class_device
906 * This function returns a reference to a class_device that is 'found' for
907 * later use, as determined by the @match callback.
909 * The callback should return 0 if the class_device doesn't match and non-zero
910 * if it does. If the callback returns non-zero, this function will
911 * return to the caller and not iterate over any more class_devices.
913 * Note, you will need to drop the reference with class_device_put() after use.
915 * We hold class->sem in this function, so it can not be
916 * re-acquired in @match, otherwise it will self-deadlocking. For
917 * example, calls to add or remove class members would be verboten.
919 struct class_device *class_find_child(struct class *class, void *data,
920 int (*match)(struct class_device *, void *))
922 struct class_device *dev;
929 list_for_each_entry(dev, &class->children, node) {
930 dev = class_device_get(dev);
932 if (match(dev, data)) {
936 class_device_put(dev);
942 return found ? dev : NULL;
944 EXPORT_SYMBOL_GPL(class_find_child);
946 int class_interface_register(struct class_interface *class_intf)
948 struct class *parent;
949 struct class_device *class_dev;
952 if (!class_intf || !class_intf->class)
955 parent = class_get(class_intf->class);
960 list_add_tail(&class_intf->node, &parent->interfaces);
961 if (class_intf->add) {
962 list_for_each_entry(class_dev, &parent->children, node)
963 class_intf->add(class_dev, class_intf);
965 if (class_intf->add_dev) {
966 list_for_each_entry(dev, &parent->devices, node)
967 class_intf->add_dev(dev, class_intf);
974 void class_interface_unregister(struct class_interface *class_intf)
976 struct class *parent = class_intf->class;
977 struct class_device *class_dev;
984 list_del_init(&class_intf->node);
985 if (class_intf->remove) {
986 list_for_each_entry(class_dev, &parent->children, node)
987 class_intf->remove(class_dev, class_intf);
989 if (class_intf->remove_dev) {
990 list_for_each_entry(dev, &parent->devices, node)
991 class_intf->remove_dev(dev, class_intf);
998 int __init classes_init(void)
1000 class_kset = kset_create_and_add("class", NULL, NULL);
1004 /* ick, this is ugly, the things we go through to keep from showing up
1006 kset_init(&class_obj_subsys);
1007 kobject_set_name(&class_obj_subsys.kobj, "class_obj");
1008 if (!class_obj_subsys.kobj.parent)
1009 class_obj_subsys.kobj.parent = &class_obj_subsys.kobj;
1013 EXPORT_SYMBOL_GPL(class_create_file);
1014 EXPORT_SYMBOL_GPL(class_remove_file);
1015 EXPORT_SYMBOL_GPL(class_register);
1016 EXPORT_SYMBOL_GPL(class_unregister);
1017 EXPORT_SYMBOL_GPL(class_create);
1018 EXPORT_SYMBOL_GPL(class_destroy);
1020 EXPORT_SYMBOL_GPL(class_device_register);
1021 EXPORT_SYMBOL_GPL(class_device_unregister);
1022 EXPORT_SYMBOL_GPL(class_device_initialize);
1023 EXPORT_SYMBOL_GPL(class_device_add);
1024 EXPORT_SYMBOL_GPL(class_device_del);
1025 EXPORT_SYMBOL_GPL(class_device_get);
1026 EXPORT_SYMBOL_GPL(class_device_put);
1027 EXPORT_SYMBOL_GPL(class_device_create);
1028 EXPORT_SYMBOL_GPL(class_device_destroy);
1029 EXPORT_SYMBOL_GPL(class_device_create_file);
1030 EXPORT_SYMBOL_GPL(class_device_remove_file);
1031 EXPORT_SYMBOL_GPL(class_device_create_bin_file);
1032 EXPORT_SYMBOL_GPL(class_device_remove_bin_file);
1034 EXPORT_SYMBOL_GPL(class_interface_register);
1035 EXPORT_SYMBOL_GPL(class_interface_unregister);