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>
22 extern struct subsystem devices_subsys;
24 #define to_class_attr(_attr) container_of(_attr, struct class_attribute, attr)
25 #define to_class(obj) container_of(obj, struct class, subsys.kset.kobj)
28 class_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
30 struct class_attribute * class_attr = to_class_attr(attr);
31 struct class * dc = to_class(kobj);
35 ret = class_attr->show(dc, buf);
40 class_attr_store(struct kobject * kobj, struct attribute * attr,
41 const char * buf, size_t count)
43 struct class_attribute * class_attr = to_class_attr(attr);
44 struct class * dc = to_class(kobj);
47 if (class_attr->store)
48 ret = class_attr->store(dc, buf, count);
52 static void class_release(struct kobject * kobj)
54 struct class *class = to_class(kobj);
56 pr_debug("class '%s': release.\n", class->name);
58 if (class->class_release)
59 class->class_release(class);
61 pr_debug("class '%s' does not have a release() function, "
62 "be careful\n", class->name);
65 static struct sysfs_ops class_sysfs_ops = {
66 .show = class_attr_show,
67 .store = class_attr_store,
70 static struct kobj_type ktype_class = {
71 .sysfs_ops = &class_sysfs_ops,
72 .release = class_release,
75 /* Hotplug events for classes go to the class_obj subsys */
76 static decl_subsys(class, &ktype_class, NULL);
79 int class_create_file(struct class * cls, const struct class_attribute * attr)
83 error = sysfs_create_file(&cls->subsys.kset.kobj, &attr->attr);
89 void class_remove_file(struct class * cls, const struct class_attribute * attr)
92 sysfs_remove_file(&cls->subsys.kset.kobj, &attr->attr);
95 static struct class *class_get(struct class *cls)
98 return container_of(subsys_get(&cls->subsys), struct class, subsys);
102 static void class_put(struct class * cls)
105 subsys_put(&cls->subsys);
109 static int add_class_attrs(struct class * cls)
114 if (cls->class_attrs) {
115 for (i = 0; attr_name(cls->class_attrs[i]); i++) {
116 error = class_create_file(cls,&cls->class_attrs[i]);
125 class_remove_file(cls,&cls->class_attrs[i]);
129 static void remove_class_attrs(struct class * cls)
133 if (cls->class_attrs) {
134 for (i = 0; attr_name(cls->class_attrs[i]); i++)
135 class_remove_file(cls,&cls->class_attrs[i]);
139 int class_register(struct class * cls)
143 pr_debug("device class '%s': registering\n", cls->name);
145 INIT_LIST_HEAD(&cls->children);
146 INIT_LIST_HEAD(&cls->devices);
147 INIT_LIST_HEAD(&cls->interfaces);
148 init_MUTEX(&cls->sem);
149 error = kobject_set_name(&cls->subsys.kset.kobj, "%s", cls->name);
153 subsys_set_kset(cls, class_subsys);
155 error = subsystem_register(&cls->subsys);
157 error = add_class_attrs(class_get(cls));
163 void class_unregister(struct class * cls)
165 pr_debug("device class '%s': unregistering\n", cls->name);
166 if (cls->virtual_dir)
167 kobject_unregister(cls->virtual_dir);
168 remove_class_attrs(cls);
169 subsystem_unregister(&cls->subsys);
172 static void class_create_release(struct class *cls)
174 pr_debug("%s called for %s\n", __FUNCTION__, cls->name);
178 static void class_device_create_release(struct class_device *class_dev)
180 pr_debug("%s called for %s\n", __FUNCTION__, class_dev->class_id);
184 /* needed to allow these devices to have parent class devices */
185 static int class_device_create_uevent(struct class_device *class_dev,
186 char **envp, int num_envp,
187 char *buffer, int buffer_size)
189 pr_debug("%s called for %s\n", __FUNCTION__, class_dev->class_id);
194 * class_create - create a struct class structure
195 * @owner: pointer to the module that is to "own" this struct class
196 * @name: pointer to a string for the name of this class.
198 * This is used to create a struct class pointer that can then be used
199 * in calls to class_device_create().
201 * Note, the pointer created here is to be destroyed when finished by
202 * making a call to class_destroy().
204 struct class *class_create(struct module *owner, const char *name)
209 cls = kzalloc(sizeof(*cls), GFP_KERNEL);
217 cls->class_release = class_create_release;
218 cls->release = class_device_create_release;
220 retval = class_register(cls);
228 return ERR_PTR(retval);
232 * class_destroy - destroys a struct class structure
233 * @cls: pointer to the struct class that is to be destroyed
235 * Note, the pointer to be destroyed must have been created with a call
238 void class_destroy(struct class *cls)
240 if ((cls == NULL) || (IS_ERR(cls)))
243 class_unregister(cls);
246 /* Class Device Stuff */
248 int class_device_create_file(struct class_device * class_dev,
249 const struct class_device_attribute * attr)
253 error = sysfs_create_file(&class_dev->kobj, &attr->attr);
257 void class_device_remove_file(struct class_device * class_dev,
258 const struct class_device_attribute * attr)
261 sysfs_remove_file(&class_dev->kobj, &attr->attr);
264 int class_device_create_bin_file(struct class_device *class_dev,
265 struct bin_attribute *attr)
269 error = sysfs_create_bin_file(&class_dev->kobj, attr);
273 void class_device_remove_bin_file(struct class_device *class_dev,
274 struct bin_attribute *attr)
277 sysfs_remove_bin_file(&class_dev->kobj, attr);
281 class_device_attr_show(struct kobject * kobj, struct attribute * attr,
284 struct class_device_attribute * class_dev_attr = to_class_dev_attr(attr);
285 struct class_device * cd = to_class_dev(kobj);
288 if (class_dev_attr->show)
289 ret = class_dev_attr->show(cd, buf);
294 class_device_attr_store(struct kobject * kobj, struct attribute * attr,
295 const char * buf, size_t count)
297 struct class_device_attribute * class_dev_attr = to_class_dev_attr(attr);
298 struct class_device * cd = to_class_dev(kobj);
301 if (class_dev_attr->store)
302 ret = class_dev_attr->store(cd, buf, count);
306 static struct sysfs_ops class_dev_sysfs_ops = {
307 .show = class_device_attr_show,
308 .store = class_device_attr_store,
311 static void class_dev_release(struct kobject * kobj)
313 struct class_device *cd = to_class_dev(kobj);
314 struct class * cls = cd->class;
316 pr_debug("device class '%s': release.\n", cd->class_id);
318 kfree(cd->devt_attr);
319 cd->devt_attr = NULL;
323 else if (cls->release)
326 printk(KERN_ERR "Class Device '%s' does not have a release() function, "
327 "it is broken and must be fixed.\n",
333 static struct kobj_type ktype_class_device = {
334 .sysfs_ops = &class_dev_sysfs_ops,
335 .release = class_dev_release,
338 static int class_uevent_filter(struct kset *kset, struct kobject *kobj)
340 struct kobj_type *ktype = get_ktype(kobj);
342 if (ktype == &ktype_class_device) {
343 struct class_device *class_dev = to_class_dev(kobj);
344 if (class_dev->class)
350 static const char *class_uevent_name(struct kset *kset, struct kobject *kobj)
352 struct class_device *class_dev = to_class_dev(kobj);
354 return class_dev->class->name;
357 #ifdef CONFIG_SYSFS_DEPRECATED
358 char *make_class_name(const char *name, struct kobject *kobj)
363 size = strlen(name) + strlen(kobject_name(kobj)) + 2;
365 class_name = kmalloc(size, GFP_KERNEL);
369 strcpy(class_name, name);
370 strcat(class_name, ":");
371 strcat(class_name, kobject_name(kobj));
375 static int deprecated_class_uevent(char **envp, int num_envp, int *cur_index,
376 char *buffer, int buffer_size,
378 struct class_device *class_dev)
380 struct device *dev = class_dev->dev;
386 /* add device, backing this class device (deprecated) */
387 path = kobject_get_path(&dev->kobj, GFP_KERNEL);
389 add_uevent_var(envp, num_envp, cur_index, buffer, buffer_size,
390 cur_len, "PHYSDEVPATH=%s", path);
394 add_uevent_var(envp, num_envp, cur_index,
395 buffer, buffer_size, cur_len,
396 "PHYSDEVBUS=%s", dev->bus->name);
399 add_uevent_var(envp, num_envp, cur_index,
400 buffer, buffer_size, cur_len,
401 "PHYSDEVDRIVER=%s", dev->driver->name);
405 static int make_deprecated_class_device_links(struct class_device *class_dev)
413 class_name = make_class_name(class_dev->class->name, &class_dev->kobj);
415 error = sysfs_create_link(&class_dev->dev->kobj,
416 &class_dev->kobj, class_name);
423 static void remove_deprecated_class_device_links(struct class_device *class_dev)
430 class_name = make_class_name(class_dev->class->name, &class_dev->kobj);
432 sysfs_remove_link(&class_dev->dev->kobj, class_name);
436 static inline int deprecated_class_uevent(char **envp, int num_envp,
437 int *cur_index, char *buffer,
438 int buffer_size, int *cur_len,
439 struct class_device *class_dev)
441 static inline int make_deprecated_class_device_links(struct class_device *cd)
443 static void remove_deprecated_class_device_links(struct class_device *cd)
447 static int class_uevent(struct kset *kset, struct kobject *kobj, char **envp,
448 int num_envp, char *buffer, int buffer_size)
450 struct class_device *class_dev = to_class_dev(kobj);
455 pr_debug("%s - name = %s\n", __FUNCTION__, class_dev->class_id);
457 deprecated_class_uevent(envp, num_envp, &i, buffer, buffer_size,
460 if (MAJOR(class_dev->devt)) {
461 add_uevent_var(envp, num_envp, &i,
462 buffer, buffer_size, &length,
463 "MAJOR=%u", MAJOR(class_dev->devt));
465 add_uevent_var(envp, num_envp, &i,
466 buffer, buffer_size, &length,
467 "MINOR=%u", MINOR(class_dev->devt));
470 /* terminate, set to next free slot, shrink available space */
474 buffer = &buffer[length];
475 buffer_size -= length;
477 if (class_dev->uevent) {
478 /* have the class device specific function add its stuff */
479 retval = class_dev->uevent(class_dev, envp, num_envp,
480 buffer, buffer_size);
482 pr_debug("class_dev->uevent() returned %d\n", retval);
483 } else if (class_dev->class->uevent) {
484 /* have the class specific function add its stuff */
485 retval = class_dev->class->uevent(class_dev, envp, num_envp,
486 buffer, buffer_size);
488 pr_debug("class->uevent() returned %d\n", retval);
494 static struct kset_uevent_ops class_uevent_ops = {
495 .filter = class_uevent_filter,
496 .name = class_uevent_name,
497 .uevent = class_uevent,
500 static decl_subsys(class_obj, &ktype_class_device, &class_uevent_ops);
503 static int class_device_add_attrs(struct class_device * cd)
507 struct class * cls = cd->class;
509 if (cls->class_dev_attrs) {
510 for (i = 0; attr_name(cls->class_dev_attrs[i]); i++) {
511 error = class_device_create_file(cd,
512 &cls->class_dev_attrs[i]);
521 class_device_remove_file(cd,&cls->class_dev_attrs[i]);
525 static void class_device_remove_attrs(struct class_device * cd)
528 struct class * cls = cd->class;
530 if (cls->class_dev_attrs) {
531 for (i = 0; attr_name(cls->class_dev_attrs[i]); i++)
532 class_device_remove_file(cd,&cls->class_dev_attrs[i]);
536 static int class_device_add_groups(struct class_device * cd)
542 for (i = 0; cd->groups[i]; i++) {
543 error = sysfs_create_group(&cd->kobj, cd->groups[i]);
546 sysfs_remove_group(&cd->kobj, cd->groups[i]);
555 static void class_device_remove_groups(struct class_device * cd)
559 for (i = 0; cd->groups[i]; i++) {
560 sysfs_remove_group(&cd->kobj, cd->groups[i]);
565 static ssize_t show_dev(struct class_device *class_dev, char *buf)
567 return print_dev_t(buf, class_dev->devt);
570 static ssize_t store_uevent(struct class_device *class_dev,
571 const char *buf, size_t count)
573 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
577 void class_device_initialize(struct class_device *class_dev)
579 kobj_set_kset_s(class_dev, class_obj_subsys);
580 kobject_init(&class_dev->kobj);
581 INIT_LIST_HEAD(&class_dev->node);
584 int class_device_add(struct class_device *class_dev)
586 struct class *parent_class = NULL;
587 struct class_device *parent_class_dev = NULL;
588 struct class_interface *class_intf;
591 class_dev = class_device_get(class_dev);
595 if (!strlen(class_dev->class_id))
598 parent_class = class_get(class_dev->class);
602 parent_class_dev = class_device_get(class_dev->parent);
604 pr_debug("CLASS: registering class device: ID = '%s'\n",
605 class_dev->class_id);
607 /* first, register with generic layer. */
608 error = kobject_set_name(&class_dev->kobj, "%s", class_dev->class_id);
612 if (parent_class_dev)
613 class_dev->kobj.parent = &parent_class_dev->kobj;
615 class_dev->kobj.parent = &parent_class->subsys.kset.kobj;
617 error = kobject_add(&class_dev->kobj);
621 /* add the needed attributes to this device */
622 error = sysfs_create_link(&class_dev->kobj,
623 &parent_class->subsys.kset.kobj, "subsystem");
626 class_dev->uevent_attr.attr.name = "uevent";
627 class_dev->uevent_attr.attr.mode = S_IWUSR;
628 class_dev->uevent_attr.attr.owner = parent_class->owner;
629 class_dev->uevent_attr.store = store_uevent;
630 error = class_device_create_file(class_dev, &class_dev->uevent_attr);
634 if (MAJOR(class_dev->devt)) {
635 struct class_device_attribute *attr;
636 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
641 attr->attr.name = "dev";
642 attr->attr.mode = S_IRUGO;
643 attr->attr.owner = parent_class->owner;
644 attr->show = show_dev;
645 error = class_device_create_file(class_dev, attr);
651 class_dev->devt_attr = attr;
654 error = class_device_add_attrs(class_dev);
658 if (class_dev->dev) {
659 error = sysfs_create_link(&class_dev->kobj,
660 &class_dev->dev->kobj, "device");
665 error = class_device_add_groups(class_dev);
669 error = make_deprecated_class_device_links(class_dev);
673 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
675 /* notify any interfaces this device is now here */
676 down(&parent_class->sem);
677 list_add_tail(&class_dev->node, &parent_class->children);
678 list_for_each_entry(class_intf, &parent_class->interfaces, node) {
680 class_intf->add(class_dev, class_intf);
682 up(&parent_class->sem);
687 class_device_remove_groups(class_dev);
690 sysfs_remove_link(&class_dev->kobj, "device");
692 class_device_remove_attrs(class_dev);
694 if (class_dev->devt_attr)
695 class_device_remove_file(class_dev, class_dev->devt_attr);
697 class_device_remove_file(class_dev, &class_dev->uevent_attr);
699 kobject_del(&class_dev->kobj);
702 class_device_put(parent_class_dev);
703 class_put(parent_class);
705 class_device_put(class_dev);
709 int class_device_register(struct class_device *class_dev)
711 class_device_initialize(class_dev);
712 return class_device_add(class_dev);
716 * class_device_create - creates a class device and registers it with sysfs
717 * @cls: pointer to the struct class that this device should be registered to.
718 * @parent: pointer to the parent struct class_device of this new device, if any.
719 * @devt: the dev_t for the char device to be added.
720 * @device: a pointer to a struct device that is assiociated with this class device.
721 * @fmt: string for the class device's name
723 * This function can be used by char device classes. A struct
724 * class_device will be created in sysfs, registered to the specified
726 * A "dev" file will be created, showing the dev_t for the device, if
727 * the dev_t is not 0,0.
728 * If a pointer to a parent struct class_device is passed in, the newly
729 * created struct class_device will be a child of that device in sysfs.
730 * The pointer to the struct class_device will be returned from the
731 * call. Any further sysfs files that might be required can be created
732 * using this pointer.
734 * Note: the struct class passed to this function must have previously
735 * been created with a call to class_create().
737 struct class_device *class_device_create(struct class *cls,
738 struct class_device *parent,
740 struct device *device,
741 const char *fmt, ...)
744 struct class_device *class_dev = NULL;
745 int retval = -ENODEV;
747 if (cls == NULL || IS_ERR(cls))
750 class_dev = kzalloc(sizeof(*class_dev), GFP_KERNEL);
756 class_dev->devt = devt;
757 class_dev->dev = device;
758 class_dev->class = cls;
759 class_dev->parent = parent;
760 class_dev->release = class_device_create_release;
761 class_dev->uevent = class_device_create_uevent;
764 vsnprintf(class_dev->class_id, BUS_ID_SIZE, fmt, args);
766 retval = class_device_register(class_dev);
774 return ERR_PTR(retval);
777 void class_device_del(struct class_device *class_dev)
779 struct class *parent_class = class_dev->class;
780 struct class_device *parent_device = class_dev->parent;
781 struct class_interface *class_intf;
784 down(&parent_class->sem);
785 list_del_init(&class_dev->node);
786 list_for_each_entry(class_intf, &parent_class->interfaces, node)
787 if (class_intf->remove)
788 class_intf->remove(class_dev, class_intf);
789 up(&parent_class->sem);
792 if (class_dev->dev) {
793 remove_deprecated_class_device_links(class_dev);
794 sysfs_remove_link(&class_dev->kobj, "device");
796 sysfs_remove_link(&class_dev->kobj, "subsystem");
797 class_device_remove_file(class_dev, &class_dev->uevent_attr);
798 if (class_dev->devt_attr)
799 class_device_remove_file(class_dev, class_dev->devt_attr);
800 class_device_remove_attrs(class_dev);
801 class_device_remove_groups(class_dev);
803 kobject_uevent(&class_dev->kobj, KOBJ_REMOVE);
804 kobject_del(&class_dev->kobj);
806 class_device_put(parent_device);
807 class_put(parent_class);
810 void class_device_unregister(struct class_device *class_dev)
812 pr_debug("CLASS: Unregistering class device. ID = '%s'\n",
813 class_dev->class_id);
814 class_device_del(class_dev);
815 class_device_put(class_dev);
819 * class_device_destroy - removes a class device that was created with class_device_create()
820 * @cls: the pointer to the struct class that this device was registered * with.
821 * @devt: the dev_t of the device that was previously registered.
823 * This call unregisters and cleans up a class device that was created with a
824 * call to class_device_create()
826 void class_device_destroy(struct class *cls, dev_t devt)
828 struct class_device *class_dev = NULL;
829 struct class_device *class_dev_tmp;
832 list_for_each_entry(class_dev_tmp, &cls->children, node) {
833 if (class_dev_tmp->devt == devt) {
834 class_dev = class_dev_tmp;
841 class_device_unregister(class_dev);
844 int class_device_rename(struct class_device *class_dev, char *new_name)
847 char *old_class_name = NULL, *new_class_name = NULL;
849 class_dev = class_device_get(class_dev);
853 pr_debug("CLASS: renaming '%s' to '%s'\n", class_dev->class_id,
856 #ifdef CONFIG_SYSFS_DEPRECATED
858 old_class_name = make_class_name(class_dev->class->name,
862 strlcpy(class_dev->class_id, new_name, KOBJ_NAME_LEN);
864 error = kobject_rename(&class_dev->kobj, new_name);
866 #ifdef CONFIG_SYSFS_DEPRECATED
867 if (class_dev->dev) {
868 new_class_name = make_class_name(class_dev->class->name,
871 sysfs_create_link(&class_dev->dev->kobj,
872 &class_dev->kobj, new_class_name);
874 sysfs_remove_link(&class_dev->dev->kobj,
878 class_device_put(class_dev);
880 kfree(old_class_name);
881 kfree(new_class_name);
886 struct class_device * class_device_get(struct class_device *class_dev)
889 return to_class_dev(kobject_get(&class_dev->kobj));
893 void class_device_put(struct class_device *class_dev)
896 kobject_put(&class_dev->kobj);
900 int class_interface_register(struct class_interface *class_intf)
902 struct class *parent;
903 struct class_device *class_dev;
906 if (!class_intf || !class_intf->class)
909 parent = class_get(class_intf->class);
914 list_add_tail(&class_intf->node, &parent->interfaces);
915 if (class_intf->add) {
916 list_for_each_entry(class_dev, &parent->children, node)
917 class_intf->add(class_dev, class_intf);
919 if (class_intf->add_dev) {
920 list_for_each_entry(dev, &parent->devices, node)
921 class_intf->add_dev(dev, class_intf);
928 void class_interface_unregister(struct class_interface *class_intf)
930 struct class * parent = class_intf->class;
931 struct class_device *class_dev;
938 list_del_init(&class_intf->node);
939 if (class_intf->remove) {
940 list_for_each_entry(class_dev, &parent->children, node)
941 class_intf->remove(class_dev, class_intf);
943 if (class_intf->remove_dev) {
944 list_for_each_entry(dev, &parent->devices, node)
945 class_intf->remove_dev(dev, class_intf);
952 int __init classes_init(void)
956 retval = subsystem_register(&class_subsys);
960 /* ick, this is ugly, the things we go through to keep from showing up
962 subsystem_init(&class_obj_subsys);
963 if (!class_obj_subsys.kset.subsys)
964 class_obj_subsys.kset.subsys = &class_obj_subsys;
968 EXPORT_SYMBOL_GPL(class_create_file);
969 EXPORT_SYMBOL_GPL(class_remove_file);
970 EXPORT_SYMBOL_GPL(class_register);
971 EXPORT_SYMBOL_GPL(class_unregister);
972 EXPORT_SYMBOL_GPL(class_create);
973 EXPORT_SYMBOL_GPL(class_destroy);
975 EXPORT_SYMBOL_GPL(class_device_register);
976 EXPORT_SYMBOL_GPL(class_device_unregister);
977 EXPORT_SYMBOL_GPL(class_device_initialize);
978 EXPORT_SYMBOL_GPL(class_device_add);
979 EXPORT_SYMBOL_GPL(class_device_del);
980 EXPORT_SYMBOL_GPL(class_device_get);
981 EXPORT_SYMBOL_GPL(class_device_put);
982 EXPORT_SYMBOL_GPL(class_device_create);
983 EXPORT_SYMBOL_GPL(class_device_destroy);
984 EXPORT_SYMBOL_GPL(class_device_create_file);
985 EXPORT_SYMBOL_GPL(class_device_remove_file);
986 EXPORT_SYMBOL_GPL(class_device_create_bin_file);
987 EXPORT_SYMBOL_GPL(class_device_remove_bin_file);
989 EXPORT_SYMBOL_GPL(class_interface_register);
990 EXPORT_SYMBOL_GPL(class_interface_unregister);