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 remove_class_attrs(cls);
167 subsystem_unregister(&cls->subsys);
170 static void class_create_release(struct class *cls)
172 pr_debug("%s called for %s\n", __FUNCTION__, cls->name);
176 static void class_device_create_release(struct class_device *class_dev)
178 pr_debug("%s called for %s\n", __FUNCTION__, class_dev->class_id);
182 /* needed to allow these devices to have parent class devices */
183 static int class_device_create_uevent(struct class_device *class_dev,
184 char **envp, int num_envp,
185 char *buffer, int buffer_size)
187 pr_debug("%s called for %s\n", __FUNCTION__, class_dev->class_id);
192 * class_create - create a struct class structure
193 * @owner: pointer to the module that is to "own" this struct class
194 * @name: pointer to a string for the name of this class.
196 * This is used to create a struct class pointer that can then be used
197 * in calls to class_device_create().
199 * Note, the pointer created here is to be destroyed when finished by
200 * making a call to class_destroy().
202 struct class *class_create(struct module *owner, const char *name)
207 cls = kzalloc(sizeof(*cls), GFP_KERNEL);
215 cls->class_release = class_create_release;
216 cls->release = class_device_create_release;
218 retval = class_register(cls);
226 return ERR_PTR(retval);
230 * class_destroy - destroys a struct class structure
231 * @cls: pointer to the struct class that is to be destroyed
233 * Note, the pointer to be destroyed must have been created with a call
236 void class_destroy(struct class *cls)
238 if ((cls == NULL) || (IS_ERR(cls)))
241 class_unregister(cls);
244 /* Class Device Stuff */
246 int class_device_create_file(struct class_device * class_dev,
247 const struct class_device_attribute * attr)
251 error = sysfs_create_file(&class_dev->kobj, &attr->attr);
255 void class_device_remove_file(struct class_device * class_dev,
256 const struct class_device_attribute * attr)
259 sysfs_remove_file(&class_dev->kobj, &attr->attr);
262 int class_device_create_bin_file(struct class_device *class_dev,
263 struct bin_attribute *attr)
267 error = sysfs_create_bin_file(&class_dev->kobj, attr);
271 void class_device_remove_bin_file(struct class_device *class_dev,
272 struct bin_attribute *attr)
275 sysfs_remove_bin_file(&class_dev->kobj, attr);
279 class_device_attr_show(struct kobject * kobj, struct attribute * attr,
282 struct class_device_attribute * class_dev_attr = to_class_dev_attr(attr);
283 struct class_device * cd = to_class_dev(kobj);
286 if (class_dev_attr->show)
287 ret = class_dev_attr->show(cd, buf);
292 class_device_attr_store(struct kobject * kobj, struct attribute * attr,
293 const char * buf, size_t count)
295 struct class_device_attribute * class_dev_attr = to_class_dev_attr(attr);
296 struct class_device * cd = to_class_dev(kobj);
299 if (class_dev_attr->store)
300 ret = class_dev_attr->store(cd, buf, count);
304 static struct sysfs_ops class_dev_sysfs_ops = {
305 .show = class_device_attr_show,
306 .store = class_device_attr_store,
309 static void class_dev_release(struct kobject * kobj)
311 struct class_device *cd = to_class_dev(kobj);
312 struct class * cls = cd->class;
314 pr_debug("device class '%s': release.\n", cd->class_id);
316 kfree(cd->devt_attr);
317 cd->devt_attr = NULL;
321 else if (cls->release)
324 printk(KERN_ERR "Class Device '%s' does not have a release() function, "
325 "it is broken and must be fixed.\n",
331 static struct kobj_type ktype_class_device = {
332 .sysfs_ops = &class_dev_sysfs_ops,
333 .release = class_dev_release,
336 static int class_uevent_filter(struct kset *kset, struct kobject *kobj)
338 struct kobj_type *ktype = get_ktype(kobj);
340 if (ktype == &ktype_class_device) {
341 struct class_device *class_dev = to_class_dev(kobj);
342 if (class_dev->class)
348 static const char *class_uevent_name(struct kset *kset, struct kobject *kobj)
350 struct class_device *class_dev = to_class_dev(kobj);
352 return class_dev->class->name;
355 #ifdef CONFIG_SYSFS_DEPRECATED
356 char *make_class_name(const char *name, struct kobject *kobj)
361 size = strlen(name) + strlen(kobject_name(kobj)) + 2;
363 class_name = kmalloc(size, GFP_KERNEL);
365 return ERR_PTR(-ENOMEM);
367 strcpy(class_name, name);
368 strcat(class_name, ":");
369 strcat(class_name, kobject_name(kobj));
373 static int deprecated_class_uevent(char **envp, int num_envp, int *cur_index,
374 char *buffer, int buffer_size,
376 struct class_device *class_dev)
378 struct device *dev = class_dev->dev;
384 /* add device, backing this class device (deprecated) */
385 path = kobject_get_path(&dev->kobj, GFP_KERNEL);
387 add_uevent_var(envp, num_envp, cur_index, buffer, buffer_size,
388 cur_len, "PHYSDEVPATH=%s", path);
392 add_uevent_var(envp, num_envp, cur_index,
393 buffer, buffer_size, cur_len,
394 "PHYSDEVBUS=%s", dev->bus->name);
397 add_uevent_var(envp, num_envp, cur_index,
398 buffer, buffer_size, cur_len,
399 "PHYSDEVDRIVER=%s", dev->driver->name);
403 static int make_deprecated_class_device_links(struct class_device *class_dev)
411 class_name = make_class_name(class_dev->class->name, &class_dev->kobj);
412 error = sysfs_create_link(&class_dev->dev->kobj, &class_dev->kobj,
418 static void remove_deprecated_class_device_links(struct class_device *class_dev)
425 class_name = make_class_name(class_dev->class->name, &class_dev->kobj);
426 sysfs_remove_link(&class_dev->dev->kobj, class_name);
430 static inline int deprecated_class_uevent(char **envp, int num_envp,
431 int *cur_index, char *buffer,
432 int buffer_size, int *cur_len,
433 struct class_device *class_dev)
435 static inline int make_deprecated_class_device_links(struct class_device *cd)
437 static void remove_deprecated_class_device_links(struct class_device *cd)
441 static int class_uevent(struct kset *kset, struct kobject *kobj, char **envp,
442 int num_envp, char *buffer, int buffer_size)
444 struct class_device *class_dev = to_class_dev(kobj);
449 pr_debug("%s - name = %s\n", __FUNCTION__, class_dev->class_id);
451 deprecated_class_uevent(envp, num_envp, &i, buffer, buffer_size,
454 if (MAJOR(class_dev->devt)) {
455 add_uevent_var(envp, num_envp, &i,
456 buffer, buffer_size, &length,
457 "MAJOR=%u", MAJOR(class_dev->devt));
459 add_uevent_var(envp, num_envp, &i,
460 buffer, buffer_size, &length,
461 "MINOR=%u", MINOR(class_dev->devt));
464 /* terminate, set to next free slot, shrink available space */
468 buffer = &buffer[length];
469 buffer_size -= length;
471 if (class_dev->uevent) {
472 /* have the class device specific function add its stuff */
473 retval = class_dev->uevent(class_dev, envp, num_envp,
474 buffer, buffer_size);
476 pr_debug("class_dev->uevent() returned %d\n", retval);
477 } else if (class_dev->class->uevent) {
478 /* have the class specific function add its stuff */
479 retval = class_dev->class->uevent(class_dev, envp, num_envp,
480 buffer, buffer_size);
482 pr_debug("class->uevent() returned %d\n", retval);
488 static struct kset_uevent_ops class_uevent_ops = {
489 .filter = class_uevent_filter,
490 .name = class_uevent_name,
491 .uevent = class_uevent,
494 static decl_subsys(class_obj, &ktype_class_device, &class_uevent_ops);
497 static int class_device_add_attrs(struct class_device * cd)
501 struct class * cls = cd->class;
503 if (cls->class_dev_attrs) {
504 for (i = 0; attr_name(cls->class_dev_attrs[i]); i++) {
505 error = class_device_create_file(cd,
506 &cls->class_dev_attrs[i]);
515 class_device_remove_file(cd,&cls->class_dev_attrs[i]);
519 static void class_device_remove_attrs(struct class_device * cd)
522 struct class * cls = cd->class;
524 if (cls->class_dev_attrs) {
525 for (i = 0; attr_name(cls->class_dev_attrs[i]); i++)
526 class_device_remove_file(cd,&cls->class_dev_attrs[i]);
530 static int class_device_add_groups(struct class_device * cd)
536 for (i = 0; cd->groups[i]; i++) {
537 error = sysfs_create_group(&cd->kobj, cd->groups[i]);
540 sysfs_remove_group(&cd->kobj, cd->groups[i]);
549 static void class_device_remove_groups(struct class_device * cd)
553 for (i = 0; cd->groups[i]; i++) {
554 sysfs_remove_group(&cd->kobj, cd->groups[i]);
559 static ssize_t show_dev(struct class_device *class_dev, char *buf)
561 return print_dev_t(buf, class_dev->devt);
564 static ssize_t store_uevent(struct class_device *class_dev,
565 const char *buf, size_t count)
567 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
571 void class_device_initialize(struct class_device *class_dev)
573 kobj_set_kset_s(class_dev, class_obj_subsys);
574 kobject_init(&class_dev->kobj);
575 INIT_LIST_HEAD(&class_dev->node);
578 int class_device_add(struct class_device *class_dev)
580 struct class *parent_class = NULL;
581 struct class_device *parent_class_dev = NULL;
582 struct class_interface *class_intf;
585 class_dev = class_device_get(class_dev);
589 if (!strlen(class_dev->class_id))
592 parent_class = class_get(class_dev->class);
596 parent_class_dev = class_device_get(class_dev->parent);
598 pr_debug("CLASS: registering class device: ID = '%s'\n",
599 class_dev->class_id);
601 /* first, register with generic layer. */
602 error = kobject_set_name(&class_dev->kobj, "%s", class_dev->class_id);
606 if (parent_class_dev)
607 class_dev->kobj.parent = &parent_class_dev->kobj;
609 class_dev->kobj.parent = &parent_class->subsys.kset.kobj;
611 error = kobject_add(&class_dev->kobj);
615 /* add the needed attributes to this device */
616 error = sysfs_create_link(&class_dev->kobj,
617 &parent_class->subsys.kset.kobj, "subsystem");
620 class_dev->uevent_attr.attr.name = "uevent";
621 class_dev->uevent_attr.attr.mode = S_IWUSR;
622 class_dev->uevent_attr.attr.owner = parent_class->owner;
623 class_dev->uevent_attr.store = store_uevent;
624 error = class_device_create_file(class_dev, &class_dev->uevent_attr);
628 if (MAJOR(class_dev->devt)) {
629 struct class_device_attribute *attr;
630 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
635 attr->attr.name = "dev";
636 attr->attr.mode = S_IRUGO;
637 attr->attr.owner = parent_class->owner;
638 attr->show = show_dev;
639 error = class_device_create_file(class_dev, attr);
645 class_dev->devt_attr = attr;
648 error = class_device_add_attrs(class_dev);
652 if (class_dev->dev) {
653 error = sysfs_create_link(&class_dev->kobj,
654 &class_dev->dev->kobj, "device");
659 error = class_device_add_groups(class_dev);
663 error = make_deprecated_class_device_links(class_dev);
667 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
669 /* notify any interfaces this device is now here */
670 down(&parent_class->sem);
671 list_add_tail(&class_dev->node, &parent_class->children);
672 list_for_each_entry(class_intf, &parent_class->interfaces, node) {
674 class_intf->add(class_dev, class_intf);
676 up(&parent_class->sem);
681 class_device_remove_groups(class_dev);
684 sysfs_remove_link(&class_dev->kobj, "device");
686 class_device_remove_attrs(class_dev);
688 if (class_dev->devt_attr)
689 class_device_remove_file(class_dev, class_dev->devt_attr);
691 class_device_remove_file(class_dev, &class_dev->uevent_attr);
693 kobject_del(&class_dev->kobj);
696 class_device_put(parent_class_dev);
697 class_put(parent_class);
699 class_device_put(class_dev);
703 int class_device_register(struct class_device *class_dev)
705 class_device_initialize(class_dev);
706 return class_device_add(class_dev);
710 * class_device_create - creates a class device and registers it with sysfs
711 * @cls: pointer to the struct class that this device should be registered to.
712 * @parent: pointer to the parent struct class_device of this new device, if any.
713 * @devt: the dev_t for the char device to be added.
714 * @device: a pointer to a struct device that is assiociated with this class device.
715 * @fmt: string for the class device's name
717 * This function can be used by char device classes. A struct
718 * class_device will be created in sysfs, registered to the specified
720 * A "dev" file will be created, showing the dev_t for the device, if
721 * the dev_t is not 0,0.
722 * If a pointer to a parent struct class_device is passed in, the newly
723 * created struct class_device will be a child of that device in sysfs.
724 * The pointer to the struct class_device will be returned from the
725 * call. Any further sysfs files that might be required can be created
726 * using this pointer.
728 * Note: the struct class passed to this function must have previously
729 * been created with a call to class_create().
731 struct class_device *class_device_create(struct class *cls,
732 struct class_device *parent,
734 struct device *device,
735 const char *fmt, ...)
738 struct class_device *class_dev = NULL;
739 int retval = -ENODEV;
741 if (cls == NULL || IS_ERR(cls))
744 class_dev = kzalloc(sizeof(*class_dev), GFP_KERNEL);
750 class_dev->devt = devt;
751 class_dev->dev = device;
752 class_dev->class = cls;
753 class_dev->parent = parent;
754 class_dev->release = class_device_create_release;
755 class_dev->uevent = class_device_create_uevent;
758 vsnprintf(class_dev->class_id, BUS_ID_SIZE, fmt, args);
760 retval = class_device_register(class_dev);
768 return ERR_PTR(retval);
771 void class_device_del(struct class_device *class_dev)
773 struct class *parent_class = class_dev->class;
774 struct class_device *parent_device = class_dev->parent;
775 struct class_interface *class_intf;
778 down(&parent_class->sem);
779 list_del_init(&class_dev->node);
780 list_for_each_entry(class_intf, &parent_class->interfaces, node)
781 if (class_intf->remove)
782 class_intf->remove(class_dev, class_intf);
783 up(&parent_class->sem);
786 if (class_dev->dev) {
787 remove_deprecated_class_device_links(class_dev);
788 sysfs_remove_link(&class_dev->kobj, "device");
790 sysfs_remove_link(&class_dev->kobj, "subsystem");
791 class_device_remove_file(class_dev, &class_dev->uevent_attr);
792 if (class_dev->devt_attr)
793 class_device_remove_file(class_dev, class_dev->devt_attr);
794 class_device_remove_attrs(class_dev);
795 class_device_remove_groups(class_dev);
797 kobject_uevent(&class_dev->kobj, KOBJ_REMOVE);
798 kobject_del(&class_dev->kobj);
800 class_device_put(parent_device);
801 class_put(parent_class);
804 void class_device_unregister(struct class_device *class_dev)
806 pr_debug("CLASS: Unregistering class device. ID = '%s'\n",
807 class_dev->class_id);
808 class_device_del(class_dev);
809 class_device_put(class_dev);
813 * class_device_destroy - removes a class device that was created with class_device_create()
814 * @cls: the pointer to the struct class that this device was registered * with.
815 * @devt: the dev_t of the device that was previously registered.
817 * This call unregisters and cleans up a class device that was created with a
818 * call to class_device_create()
820 void class_device_destroy(struct class *cls, dev_t devt)
822 struct class_device *class_dev = NULL;
823 struct class_device *class_dev_tmp;
826 list_for_each_entry(class_dev_tmp, &cls->children, node) {
827 if (class_dev_tmp->devt == devt) {
828 class_dev = class_dev_tmp;
835 class_device_unregister(class_dev);
838 int class_device_rename(struct class_device *class_dev, char *new_name)
841 char *old_class_name = NULL, *new_class_name = NULL;
843 class_dev = class_device_get(class_dev);
847 pr_debug("CLASS: renaming '%s' to '%s'\n", class_dev->class_id,
850 #ifdef CONFIG_SYSFS_DEPRECATED
852 old_class_name = make_class_name(class_dev->class->name,
856 strlcpy(class_dev->class_id, new_name, KOBJ_NAME_LEN);
858 error = kobject_rename(&class_dev->kobj, new_name);
860 #ifdef CONFIG_SYSFS_DEPRECATED
861 if (class_dev->dev) {
862 new_class_name = make_class_name(class_dev->class->name,
864 sysfs_create_link(&class_dev->dev->kobj, &class_dev->kobj,
866 sysfs_remove_link(&class_dev->dev->kobj, old_class_name);
869 class_device_put(class_dev);
871 kfree(old_class_name);
872 kfree(new_class_name);
877 struct class_device * class_device_get(struct class_device *class_dev)
880 return to_class_dev(kobject_get(&class_dev->kobj));
884 void class_device_put(struct class_device *class_dev)
887 kobject_put(&class_dev->kobj);
891 int class_interface_register(struct class_interface *class_intf)
893 struct class *parent;
894 struct class_device *class_dev;
897 if (!class_intf || !class_intf->class)
900 parent = class_get(class_intf->class);
905 list_add_tail(&class_intf->node, &parent->interfaces);
906 if (class_intf->add) {
907 list_for_each_entry(class_dev, &parent->children, node)
908 class_intf->add(class_dev, class_intf);
910 if (class_intf->add_dev) {
911 list_for_each_entry(dev, &parent->devices, node)
912 class_intf->add_dev(dev, class_intf);
919 void class_interface_unregister(struct class_interface *class_intf)
921 struct class * parent = class_intf->class;
922 struct class_device *class_dev;
929 list_del_init(&class_intf->node);
930 if (class_intf->remove) {
931 list_for_each_entry(class_dev, &parent->children, node)
932 class_intf->remove(class_dev, class_intf);
934 if (class_intf->remove_dev) {
935 list_for_each_entry(dev, &parent->devices, node)
936 class_intf->remove_dev(dev, class_intf);
943 int __init classes_init(void)
947 retval = subsystem_register(&class_subsys);
951 /* ick, this is ugly, the things we go through to keep from showing up
953 subsystem_init(&class_obj_subsys);
954 if (!class_obj_subsys.kset.subsys)
955 class_obj_subsys.kset.subsys = &class_obj_subsys;
959 EXPORT_SYMBOL_GPL(class_create_file);
960 EXPORT_SYMBOL_GPL(class_remove_file);
961 EXPORT_SYMBOL_GPL(class_register);
962 EXPORT_SYMBOL_GPL(class_unregister);
963 EXPORT_SYMBOL_GPL(class_create);
964 EXPORT_SYMBOL_GPL(class_destroy);
966 EXPORT_SYMBOL_GPL(class_device_register);
967 EXPORT_SYMBOL_GPL(class_device_unregister);
968 EXPORT_SYMBOL_GPL(class_device_initialize);
969 EXPORT_SYMBOL_GPL(class_device_add);
970 EXPORT_SYMBOL_GPL(class_device_del);
971 EXPORT_SYMBOL_GPL(class_device_get);
972 EXPORT_SYMBOL_GPL(class_device_put);
973 EXPORT_SYMBOL_GPL(class_device_create);
974 EXPORT_SYMBOL_GPL(class_device_destroy);
975 EXPORT_SYMBOL_GPL(class_device_create_file);
976 EXPORT_SYMBOL_GPL(class_device_remove_file);
977 EXPORT_SYMBOL_GPL(class_device_create_bin_file);
978 EXPORT_SYMBOL_GPL(class_device_remove_bin_file);
980 EXPORT_SYMBOL_GPL(class_interface_register);
981 EXPORT_SYMBOL_GPL(class_interface_unregister);