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 #define to_class_attr(_attr) container_of(_attr, struct class_attribute, attr)
23 #define to_class(obj) container_of(obj, struct class, subsys.kobj)
26 class_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
28 struct class_attribute * class_attr = to_class_attr(attr);
29 struct class * dc = to_class(kobj);
33 ret = class_attr->show(dc, buf);
38 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 ktype_class = {
69 .sysfs_ops = &class_sysfs_ops,
70 .release = class_release,
73 /* Hotplug events for classes go to the class_obj subsys */
74 static decl_subsys(class, &ktype_class, NULL);
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(subsys_get(&cls->subsys), struct class, subsys);
100 static void class_put(struct class * cls)
103 subsys_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 subsys_set_kset(cls, class_subsys);
154 error = subsystem_register(&cls->subsys);
156 error = add_class_attrs(class_get(cls));
162 void class_unregister(struct class * cls)
164 pr_debug("device class '%s': unregistering\n", cls->name);
165 remove_class_attrs(cls);
166 subsystem_unregister(&cls->subsys);
169 static void class_create_release(struct class *cls)
171 pr_debug("%s called for %s\n", __FUNCTION__, cls->name);
175 static void class_device_create_release(struct class_device *class_dev)
177 pr_debug("%s called for %s\n", __FUNCTION__, class_dev->class_id);
181 /* needed to allow these devices to have parent class devices */
182 static int class_device_create_uevent(struct class_device *class_dev,
183 char **envp, int num_envp,
184 char *buffer, int buffer_size)
186 pr_debug("%s called for %s\n", __FUNCTION__, class_dev->class_id);
191 * class_create - create a struct class structure
192 * @owner: pointer to the module that is to "own" this struct class
193 * @name: pointer to a string for the name of this class.
195 * This is used to create a struct class pointer that can then be used
196 * in calls to class_device_create().
198 * Note, the pointer created here is to be destroyed when finished by
199 * making a call to class_destroy().
201 struct class *class_create(struct module *owner, const char *name)
206 cls = kzalloc(sizeof(*cls), GFP_KERNEL);
214 cls->class_release = class_create_release;
215 cls->release = class_device_create_release;
217 retval = class_register(cls);
225 return ERR_PTR(retval);
229 * class_destroy - destroys a struct class structure
230 * @cls: pointer to the struct class that is to be destroyed
232 * Note, the pointer to be destroyed must have been created with a call
235 void class_destroy(struct class *cls)
237 if ((cls == NULL) || (IS_ERR(cls)))
240 class_unregister(cls);
243 /* Class Device Stuff */
245 int class_device_create_file(struct class_device * class_dev,
246 const struct class_device_attribute * attr)
250 error = sysfs_create_file(&class_dev->kobj, &attr->attr);
254 void class_device_remove_file(struct class_device * class_dev,
255 const struct class_device_attribute * attr)
258 sysfs_remove_file(&class_dev->kobj, &attr->attr);
261 int class_device_create_bin_file(struct class_device *class_dev,
262 struct bin_attribute *attr)
266 error = sysfs_create_bin_file(&class_dev->kobj, attr);
270 void class_device_remove_bin_file(struct class_device *class_dev,
271 struct bin_attribute *attr)
274 sysfs_remove_bin_file(&class_dev->kobj, attr);
278 class_device_attr_show(struct kobject * kobj, struct attribute * attr,
281 struct class_device_attribute * class_dev_attr = to_class_dev_attr(attr);
282 struct class_device * cd = to_class_dev(kobj);
285 if (class_dev_attr->show)
286 ret = class_dev_attr->show(cd, buf);
291 class_device_attr_store(struct kobject * kobj, struct attribute * attr,
292 const char * buf, size_t count)
294 struct class_device_attribute * class_dev_attr = to_class_dev_attr(attr);
295 struct class_device * cd = to_class_dev(kobj);
298 if (class_dev_attr->store)
299 ret = class_dev_attr->store(cd, buf, count);
303 static struct sysfs_ops class_dev_sysfs_ops = {
304 .show = class_device_attr_show,
305 .store = class_device_attr_store,
308 static void class_dev_release(struct kobject * kobj)
310 struct class_device *cd = to_class_dev(kobj);
311 struct class * cls = cd->class;
313 pr_debug("device class '%s': release.\n", cd->class_id);
315 kfree(cd->devt_attr);
316 cd->devt_attr = NULL;
320 else if (cls->release)
323 printk(KERN_ERR "Class Device '%s' does not have a release() function, "
324 "it is broken and must be fixed.\n",
330 static struct kobj_type ktype_class_device = {
331 .sysfs_ops = &class_dev_sysfs_ops,
332 .release = class_dev_release,
335 static int class_uevent_filter(struct kset *kset, struct kobject *kobj)
337 struct kobj_type *ktype = get_ktype(kobj);
339 if (ktype == &ktype_class_device) {
340 struct class_device *class_dev = to_class_dev(kobj);
341 if (class_dev->class)
347 static const char *class_uevent_name(struct kset *kset, struct kobject *kobj)
349 struct class_device *class_dev = to_class_dev(kobj);
351 return class_dev->class->name;
354 #ifdef CONFIG_SYSFS_DEPRECATED
355 char *make_class_name(const char *name, struct kobject *kobj)
360 size = strlen(name) + strlen(kobject_name(kobj)) + 2;
362 class_name = kmalloc(size, GFP_KERNEL);
366 strcpy(class_name, name);
367 strcat(class_name, ":");
368 strcat(class_name, kobject_name(kobj));
372 static int deprecated_class_uevent(char **envp, int num_envp, int *cur_index,
373 char *buffer, int buffer_size,
375 struct class_device *class_dev)
377 struct device *dev = class_dev->dev;
383 /* add device, backing this class device (deprecated) */
384 path = kobject_get_path(&dev->kobj, GFP_KERNEL);
386 add_uevent_var(envp, num_envp, cur_index, buffer, buffer_size,
387 cur_len, "PHYSDEVPATH=%s", path);
391 add_uevent_var(envp, num_envp, cur_index,
392 buffer, buffer_size, cur_len,
393 "PHYSDEVBUS=%s", dev->bus->name);
396 add_uevent_var(envp, num_envp, cur_index,
397 buffer, buffer_size, cur_len,
398 "PHYSDEVDRIVER=%s", dev->driver->name);
402 static int make_deprecated_class_device_links(struct class_device *class_dev)
410 class_name = make_class_name(class_dev->class->name, &class_dev->kobj);
412 error = sysfs_create_link(&class_dev->dev->kobj,
413 &class_dev->kobj, class_name);
420 static void remove_deprecated_class_device_links(struct class_device *class_dev)
427 class_name = make_class_name(class_dev->class->name, &class_dev->kobj);
429 sysfs_remove_link(&class_dev->dev->kobj, class_name);
433 static inline int deprecated_class_uevent(char **envp, int num_envp,
434 int *cur_index, char *buffer,
435 int buffer_size, int *cur_len,
436 struct class_device *class_dev)
438 static inline int make_deprecated_class_device_links(struct class_device *cd)
440 static void remove_deprecated_class_device_links(struct class_device *cd)
444 static int class_uevent(struct kset *kset, struct kobject *kobj, char **envp,
445 int num_envp, char *buffer, int buffer_size)
447 struct class_device *class_dev = to_class_dev(kobj);
452 pr_debug("%s - name = %s\n", __FUNCTION__, class_dev->class_id);
454 deprecated_class_uevent(envp, num_envp, &i, buffer, buffer_size,
457 if (MAJOR(class_dev->devt)) {
458 add_uevent_var(envp, num_envp, &i,
459 buffer, buffer_size, &length,
460 "MAJOR=%u", MAJOR(class_dev->devt));
462 add_uevent_var(envp, num_envp, &i,
463 buffer, buffer_size, &length,
464 "MINOR=%u", MINOR(class_dev->devt));
467 /* terminate, set to next free slot, shrink available space */
471 buffer = &buffer[length];
472 buffer_size -= length;
474 if (class_dev->uevent) {
475 /* have the class device specific function add its stuff */
476 retval = class_dev->uevent(class_dev, envp, num_envp,
477 buffer, buffer_size);
479 pr_debug("class_dev->uevent() returned %d\n", retval);
480 } else if (class_dev->class->uevent) {
481 /* have the class specific function add its stuff */
482 retval = class_dev->class->uevent(class_dev, envp, num_envp,
483 buffer, buffer_size);
485 pr_debug("class->uevent() returned %d\n", retval);
491 static struct kset_uevent_ops class_uevent_ops = {
492 .filter = class_uevent_filter,
493 .name = class_uevent_name,
494 .uevent = class_uevent,
497 static decl_subsys(class_obj, &ktype_class_device, &class_uevent_ops);
500 static int class_device_add_attrs(struct class_device * cd)
504 struct class * cls = cd->class;
506 if (cls->class_dev_attrs) {
507 for (i = 0; attr_name(cls->class_dev_attrs[i]); i++) {
508 error = class_device_create_file(cd,
509 &cls->class_dev_attrs[i]);
518 class_device_remove_file(cd,&cls->class_dev_attrs[i]);
522 static void class_device_remove_attrs(struct class_device * cd)
525 struct class * cls = cd->class;
527 if (cls->class_dev_attrs) {
528 for (i = 0; attr_name(cls->class_dev_attrs[i]); i++)
529 class_device_remove_file(cd,&cls->class_dev_attrs[i]);
533 static int class_device_add_groups(struct class_device * cd)
539 for (i = 0; cd->groups[i]; i++) {
540 error = sysfs_create_group(&cd->kobj, cd->groups[i]);
543 sysfs_remove_group(&cd->kobj, cd->groups[i]);
552 static void class_device_remove_groups(struct class_device * cd)
556 for (i = 0; cd->groups[i]; i++) {
557 sysfs_remove_group(&cd->kobj, cd->groups[i]);
562 static ssize_t show_dev(struct class_device *class_dev, char *buf)
564 return print_dev_t(buf, class_dev->devt);
567 static ssize_t store_uevent(struct class_device *class_dev,
568 const char *buf, size_t count)
570 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
574 void class_device_initialize(struct class_device *class_dev)
576 kobj_set_kset_s(class_dev, class_obj_subsys);
577 kobject_init(&class_dev->kobj);
578 INIT_LIST_HEAD(&class_dev->node);
581 int class_device_add(struct class_device *class_dev)
583 struct class *parent_class = NULL;
584 struct class_device *parent_class_dev = NULL;
585 struct class_interface *class_intf;
588 class_dev = class_device_get(class_dev);
592 if (!strlen(class_dev->class_id))
595 parent_class = class_get(class_dev->class);
599 parent_class_dev = class_device_get(class_dev->parent);
601 pr_debug("CLASS: registering class device: ID = '%s'\n",
602 class_dev->class_id);
604 /* first, register with generic layer. */
605 error = kobject_set_name(&class_dev->kobj, "%s", class_dev->class_id);
609 if (parent_class_dev)
610 class_dev->kobj.parent = &parent_class_dev->kobj;
612 class_dev->kobj.parent = &parent_class->subsys.kobj;
614 error = kobject_add(&class_dev->kobj);
618 /* add the needed attributes to this device */
619 error = sysfs_create_link(&class_dev->kobj,
620 &parent_class->subsys.kobj, "subsystem");
623 class_dev->uevent_attr.attr.name = "uevent";
624 class_dev->uevent_attr.attr.mode = S_IWUSR;
625 class_dev->uevent_attr.attr.owner = parent_class->owner;
626 class_dev->uevent_attr.store = store_uevent;
627 error = class_device_create_file(class_dev, &class_dev->uevent_attr);
631 if (MAJOR(class_dev->devt)) {
632 struct class_device_attribute *attr;
633 attr = kzalloc(sizeof(*attr), GFP_KERNEL);
638 attr->attr.name = "dev";
639 attr->attr.mode = S_IRUGO;
640 attr->attr.owner = parent_class->owner;
641 attr->show = show_dev;
642 error = class_device_create_file(class_dev, attr);
648 class_dev->devt_attr = attr;
651 error = class_device_add_attrs(class_dev);
655 if (class_dev->dev) {
656 error = sysfs_create_link(&class_dev->kobj,
657 &class_dev->dev->kobj, "device");
662 error = class_device_add_groups(class_dev);
666 error = make_deprecated_class_device_links(class_dev);
670 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
672 /* notify any interfaces this device is now here */
673 down(&parent_class->sem);
674 list_add_tail(&class_dev->node, &parent_class->children);
675 list_for_each_entry(class_intf, &parent_class->interfaces, node) {
677 class_intf->add(class_dev, class_intf);
679 up(&parent_class->sem);
684 class_device_remove_groups(class_dev);
687 sysfs_remove_link(&class_dev->kobj, "device");
689 class_device_remove_attrs(class_dev);
691 if (class_dev->devt_attr)
692 class_device_remove_file(class_dev, class_dev->devt_attr);
694 class_device_remove_file(class_dev, &class_dev->uevent_attr);
696 kobject_del(&class_dev->kobj);
699 class_device_put(parent_class_dev);
700 class_put(parent_class);
702 class_device_put(class_dev);
706 int class_device_register(struct class_device *class_dev)
708 class_device_initialize(class_dev);
709 return class_device_add(class_dev);
713 * class_device_create - creates a class device and registers it with sysfs
714 * @cls: pointer to the struct class that this device should be registered to.
715 * @parent: pointer to the parent struct class_device of this new device, if any.
716 * @devt: the dev_t for the char device to be added.
717 * @device: a pointer to a struct device that is assiociated with this class device.
718 * @fmt: string for the class device's name
720 * This function can be used by char device classes. A struct
721 * class_device will be created in sysfs, registered to the specified
723 * A "dev" file will be created, showing the dev_t for the device, if
724 * the dev_t is not 0,0.
725 * If a pointer to a parent struct class_device is passed in, the newly
726 * created struct class_device will be a child of that device in sysfs.
727 * The pointer to the struct class_device will be returned from the
728 * call. Any further sysfs files that might be required can be created
729 * using this pointer.
731 * Note: the struct class passed to this function must have previously
732 * been created with a call to class_create().
734 struct class_device *class_device_create(struct class *cls,
735 struct class_device *parent,
737 struct device *device,
738 const char *fmt, ...)
741 struct class_device *class_dev = NULL;
742 int retval = -ENODEV;
744 if (cls == NULL || IS_ERR(cls))
747 class_dev = kzalloc(sizeof(*class_dev), GFP_KERNEL);
753 class_dev->devt = devt;
754 class_dev->dev = device;
755 class_dev->class = cls;
756 class_dev->parent = parent;
757 class_dev->release = class_device_create_release;
758 class_dev->uevent = class_device_create_uevent;
761 vsnprintf(class_dev->class_id, BUS_ID_SIZE, fmt, args);
763 retval = class_device_register(class_dev);
771 return ERR_PTR(retval);
774 void class_device_del(struct class_device *class_dev)
776 struct class *parent_class = class_dev->class;
777 struct class_device *parent_device = class_dev->parent;
778 struct class_interface *class_intf;
781 down(&parent_class->sem);
782 list_del_init(&class_dev->node);
783 list_for_each_entry(class_intf, &parent_class->interfaces, node)
784 if (class_intf->remove)
785 class_intf->remove(class_dev, class_intf);
786 up(&parent_class->sem);
789 if (class_dev->dev) {
790 remove_deprecated_class_device_links(class_dev);
791 sysfs_remove_link(&class_dev->kobj, "device");
793 sysfs_remove_link(&class_dev->kobj, "subsystem");
794 class_device_remove_file(class_dev, &class_dev->uevent_attr);
795 if (class_dev->devt_attr)
796 class_device_remove_file(class_dev, class_dev->devt_attr);
797 class_device_remove_attrs(class_dev);
798 class_device_remove_groups(class_dev);
800 kobject_uevent(&class_dev->kobj, KOBJ_REMOVE);
801 kobject_del(&class_dev->kobj);
803 class_device_put(parent_device);
804 class_put(parent_class);
807 void class_device_unregister(struct class_device *class_dev)
809 pr_debug("CLASS: Unregistering class device. ID = '%s'\n",
810 class_dev->class_id);
811 class_device_del(class_dev);
812 class_device_put(class_dev);
816 * class_device_destroy - removes a class device that was created with class_device_create()
817 * @cls: the pointer to the struct class that this device was registered * with.
818 * @devt: the dev_t of the device that was previously registered.
820 * This call unregisters and cleans up a class device that was created with a
821 * call to class_device_create()
823 void class_device_destroy(struct class *cls, dev_t devt)
825 struct class_device *class_dev = NULL;
826 struct class_device *class_dev_tmp;
829 list_for_each_entry(class_dev_tmp, &cls->children, node) {
830 if (class_dev_tmp->devt == devt) {
831 class_dev = class_dev_tmp;
838 class_device_unregister(class_dev);
841 struct class_device * class_device_get(struct class_device *class_dev)
844 return to_class_dev(kobject_get(&class_dev->kobj));
848 void class_device_put(struct class_device *class_dev)
851 kobject_put(&class_dev->kobj);
855 int class_interface_register(struct class_interface *class_intf)
857 struct class *parent;
858 struct class_device *class_dev;
861 if (!class_intf || !class_intf->class)
864 parent = class_get(class_intf->class);
869 list_add_tail(&class_intf->node, &parent->interfaces);
870 if (class_intf->add) {
871 list_for_each_entry(class_dev, &parent->children, node)
872 class_intf->add(class_dev, class_intf);
874 if (class_intf->add_dev) {
875 list_for_each_entry(dev, &parent->devices, node)
876 class_intf->add_dev(dev, class_intf);
883 void class_interface_unregister(struct class_interface *class_intf)
885 struct class * parent = class_intf->class;
886 struct class_device *class_dev;
893 list_del_init(&class_intf->node);
894 if (class_intf->remove) {
895 list_for_each_entry(class_dev, &parent->children, node)
896 class_intf->remove(class_dev, class_intf);
898 if (class_intf->remove_dev) {
899 list_for_each_entry(dev, &parent->devices, node)
900 class_intf->remove_dev(dev, class_intf);
907 int __init classes_init(void)
911 retval = subsystem_register(&class_subsys);
915 /* ick, this is ugly, the things we go through to keep from showing up
917 subsystem_init(&class_obj_subsys);
918 if (!class_obj_subsys.kobj.parent)
919 class_obj_subsys.kobj.parent = &class_obj_subsys.kobj;
923 EXPORT_SYMBOL_GPL(class_create_file);
924 EXPORT_SYMBOL_GPL(class_remove_file);
925 EXPORT_SYMBOL_GPL(class_register);
926 EXPORT_SYMBOL_GPL(class_unregister);
927 EXPORT_SYMBOL_GPL(class_create);
928 EXPORT_SYMBOL_GPL(class_destroy);
930 EXPORT_SYMBOL_GPL(class_device_register);
931 EXPORT_SYMBOL_GPL(class_device_unregister);
932 EXPORT_SYMBOL_GPL(class_device_initialize);
933 EXPORT_SYMBOL_GPL(class_device_add);
934 EXPORT_SYMBOL_GPL(class_device_del);
935 EXPORT_SYMBOL_GPL(class_device_get);
936 EXPORT_SYMBOL_GPL(class_device_put);
937 EXPORT_SYMBOL_GPL(class_device_create);
938 EXPORT_SYMBOL_GPL(class_device_destroy);
939 EXPORT_SYMBOL_GPL(class_device_create_file);
940 EXPORT_SYMBOL_GPL(class_device_remove_file);
941 EXPORT_SYMBOL_GPL(class_device_create_bin_file);
942 EXPORT_SYMBOL_GPL(class_device_remove_bin_file);
944 EXPORT_SYMBOL_GPL(class_interface_register);
945 EXPORT_SYMBOL_GPL(class_interface_unregister);