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 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 decl_subsys(class, &class_ktype
, 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(kset_get(&cls
->subsys
), struct class, subsys
);
100 static void class_put(struct class * cls
)
103 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 cls
->subsys
.kobj
.kset
= &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 struct kobj_uevent_env
*env
)
185 pr_debug("%s called for %s\n", __FUNCTION__
, class_dev
->class_id
);
190 * class_create - create a struct class structure
191 * @owner: pointer to the module that is to "own" this struct class
192 * @name: pointer to a string for the name of this class.
194 * This is used to create a struct class pointer that can then be used
195 * in calls to class_device_create().
197 * Note, the pointer created here is to be destroyed when finished by
198 * making a call to class_destroy().
200 struct class *class_create(struct module
*owner
, const char *name
)
205 cls
= kzalloc(sizeof(*cls
), GFP_KERNEL
);
213 cls
->class_release
= class_create_release
;
214 cls
->release
= class_device_create_release
;
216 retval
= class_register(cls
);
224 return ERR_PTR(retval
);
228 * class_destroy - destroys a struct class structure
229 * @cls: pointer to the struct class that is to be destroyed
231 * Note, the pointer to be destroyed must have been created with a call
234 void class_destroy(struct class *cls
)
236 if ((cls
== NULL
) || (IS_ERR(cls
)))
239 class_unregister(cls
);
242 /* Class Device Stuff */
244 int class_device_create_file(struct class_device
* class_dev
,
245 const struct class_device_attribute
* attr
)
249 error
= sysfs_create_file(&class_dev
->kobj
, &attr
->attr
);
253 void class_device_remove_file(struct class_device
* class_dev
,
254 const struct class_device_attribute
* attr
)
257 sysfs_remove_file(&class_dev
->kobj
, &attr
->attr
);
260 int class_device_create_bin_file(struct class_device
*class_dev
,
261 struct bin_attribute
*attr
)
265 error
= sysfs_create_bin_file(&class_dev
->kobj
, attr
);
269 void class_device_remove_bin_file(struct class_device
*class_dev
,
270 struct bin_attribute
*attr
)
273 sysfs_remove_bin_file(&class_dev
->kobj
, attr
);
277 class_device_attr_show(struct kobject
* kobj
, struct attribute
* attr
,
280 struct class_device_attribute
* class_dev_attr
= to_class_dev_attr(attr
);
281 struct class_device
* cd
= to_class_dev(kobj
);
284 if (class_dev_attr
->show
)
285 ret
= class_dev_attr
->show(cd
, buf
);
290 class_device_attr_store(struct kobject
* kobj
, struct attribute
* attr
,
291 const char * buf
, size_t count
)
293 struct class_device_attribute
* class_dev_attr
= to_class_dev_attr(attr
);
294 struct class_device
* cd
= to_class_dev(kobj
);
297 if (class_dev_attr
->store
)
298 ret
= class_dev_attr
->store(cd
, buf
, count
);
302 static struct sysfs_ops class_dev_sysfs_ops
= {
303 .show
= class_device_attr_show
,
304 .store
= class_device_attr_store
,
307 static void class_dev_release(struct kobject
* kobj
)
309 struct class_device
*cd
= to_class_dev(kobj
);
310 struct class * cls
= cd
->class;
312 pr_debug("device class '%s': release.\n", cd
->class_id
);
316 else if (cls
->release
)
319 printk(KERN_ERR
"Class Device '%s' does not have a release() function, "
320 "it is broken and must be fixed.\n",
326 static struct kobj_type class_device_ktype
= {
327 .sysfs_ops
= &class_dev_sysfs_ops
,
328 .release
= class_dev_release
,
331 static int class_uevent_filter(struct kset
*kset
, struct kobject
*kobj
)
333 struct kobj_type
*ktype
= get_ktype(kobj
);
335 if (ktype
== &class_device_ktype
) {
336 struct class_device
*class_dev
= to_class_dev(kobj
);
337 if (class_dev
->class)
343 static const char *class_uevent_name(struct kset
*kset
, struct kobject
*kobj
)
345 struct class_device
*class_dev
= to_class_dev(kobj
);
347 return class_dev
->class->name
;
350 #ifdef CONFIG_SYSFS_DEPRECATED
351 char *make_class_name(const char *name
, struct kobject
*kobj
)
356 size
= strlen(name
) + strlen(kobject_name(kobj
)) + 2;
358 class_name
= kmalloc(size
, GFP_KERNEL
);
362 strcpy(class_name
, name
);
363 strcat(class_name
, ":");
364 strcat(class_name
, kobject_name(kobj
));
368 static int make_deprecated_class_device_links(struct class_device
*class_dev
)
376 class_name
= make_class_name(class_dev
->class->name
, &class_dev
->kobj
);
378 error
= sysfs_create_link(&class_dev
->dev
->kobj
,
379 &class_dev
->kobj
, class_name
);
386 static void remove_deprecated_class_device_links(struct class_device
*class_dev
)
393 class_name
= make_class_name(class_dev
->class->name
, &class_dev
->kobj
);
395 sysfs_remove_link(&class_dev
->dev
->kobj
, class_name
);
399 static inline int make_deprecated_class_device_links(struct class_device
*cd
)
401 static void remove_deprecated_class_device_links(struct class_device
*cd
)
405 static int class_uevent(struct kset
*kset
, struct kobject
*kobj
,
406 struct kobj_uevent_env
*env
)
408 struct class_device
*class_dev
= to_class_dev(kobj
);
409 struct device
*dev
= class_dev
->dev
;
412 pr_debug("%s - name = %s\n", __FUNCTION__
, class_dev
->class_id
);
414 if (MAJOR(class_dev
->devt
)) {
415 add_uevent_var(env
, "MAJOR=%u", MAJOR(class_dev
->devt
));
417 add_uevent_var(env
, "MINOR=%u", MINOR(class_dev
->devt
));
421 const char *path
= kobject_get_path(&dev
->kobj
, GFP_KERNEL
);
423 add_uevent_var(env
, "PHYSDEVPATH=%s", path
);
428 add_uevent_var(env
, "PHYSDEVBUS=%s", dev
->bus
->name
);
431 add_uevent_var(env
, "PHYSDEVDRIVER=%s", dev
->driver
->name
);
434 if (class_dev
->uevent
) {
435 /* have the class device specific function add its stuff */
436 retval
= class_dev
->uevent(class_dev
, env
);
438 pr_debug("class_dev->uevent() returned %d\n", retval
);
439 } else if (class_dev
->class->uevent
) {
440 /* have the class specific function add its stuff */
441 retval
= class_dev
->class->uevent(class_dev
, env
);
443 pr_debug("class->uevent() returned %d\n", retval
);
449 static struct kset_uevent_ops class_uevent_ops
= {
450 .filter
= class_uevent_filter
,
451 .name
= class_uevent_name
,
452 .uevent
= class_uevent
,
455 static decl_subsys(class_obj
, &class_device_ktype
, &class_uevent_ops
);
458 static int class_device_add_attrs(struct class_device
* cd
)
462 struct class * cls
= cd
->class;
464 if (cls
->class_dev_attrs
) {
465 for (i
= 0; attr_name(cls
->class_dev_attrs
[i
]); i
++) {
466 error
= class_device_create_file(cd
,
467 &cls
->class_dev_attrs
[i
]);
476 class_device_remove_file(cd
,&cls
->class_dev_attrs
[i
]);
480 static void class_device_remove_attrs(struct class_device
* cd
)
483 struct class * cls
= cd
->class;
485 if (cls
->class_dev_attrs
) {
486 for (i
= 0; attr_name(cls
->class_dev_attrs
[i
]); i
++)
487 class_device_remove_file(cd
,&cls
->class_dev_attrs
[i
]);
491 static int class_device_add_groups(struct class_device
* cd
)
497 for (i
= 0; cd
->groups
[i
]; i
++) {
498 error
= sysfs_create_group(&cd
->kobj
, cd
->groups
[i
]);
501 sysfs_remove_group(&cd
->kobj
, cd
->groups
[i
]);
510 static void class_device_remove_groups(struct class_device
* cd
)
514 for (i
= 0; cd
->groups
[i
]; i
++) {
515 sysfs_remove_group(&cd
->kobj
, cd
->groups
[i
]);
520 static ssize_t
show_dev(struct class_device
*class_dev
, char *buf
)
522 return print_dev_t(buf
, class_dev
->devt
);
525 static struct class_device_attribute class_devt_attr
=
526 __ATTR(dev
, S_IRUGO
, show_dev
, NULL
);
528 static ssize_t
store_uevent(struct class_device
*class_dev
,
529 const char *buf
, size_t count
)
531 kobject_uevent(&class_dev
->kobj
, KOBJ_ADD
);
535 static struct class_device_attribute class_uevent_attr
=
536 __ATTR(uevent
, S_IWUSR
, NULL
, store_uevent
);
538 void class_device_initialize(struct class_device
*class_dev
)
540 kobj_set_kset_s(class_dev
, class_obj_subsys
);
541 kobject_init(&class_dev
->kobj
);
542 INIT_LIST_HEAD(&class_dev
->node
);
545 int class_device_add(struct class_device
*class_dev
)
547 struct class *parent_class
= NULL
;
548 struct class_device
*parent_class_dev
= NULL
;
549 struct class_interface
*class_intf
;
552 class_dev
= class_device_get(class_dev
);
556 if (!strlen(class_dev
->class_id
))
559 parent_class
= class_get(class_dev
->class);
563 parent_class_dev
= class_device_get(class_dev
->parent
);
565 pr_debug("CLASS: registering class device: ID = '%s'\n",
566 class_dev
->class_id
);
568 /* first, register with generic layer. */
569 error
= kobject_set_name(&class_dev
->kobj
, "%s", class_dev
->class_id
);
573 if (parent_class_dev
)
574 class_dev
->kobj
.parent
= &parent_class_dev
->kobj
;
576 class_dev
->kobj
.parent
= &parent_class
->subsys
.kobj
;
578 error
= kobject_add(&class_dev
->kobj
);
582 /* add the needed attributes to this device */
583 error
= sysfs_create_link(&class_dev
->kobj
,
584 &parent_class
->subsys
.kobj
, "subsystem");
588 error
= class_device_create_file(class_dev
, &class_uevent_attr
);
592 if (MAJOR(class_dev
->devt
)) {
593 error
= class_device_create_file(class_dev
, &class_devt_attr
);
598 error
= class_device_add_attrs(class_dev
);
602 if (class_dev
->dev
) {
603 error
= sysfs_create_link(&class_dev
->kobj
,
604 &class_dev
->dev
->kobj
, "device");
609 error
= class_device_add_groups(class_dev
);
613 error
= make_deprecated_class_device_links(class_dev
);
617 kobject_uevent(&class_dev
->kobj
, KOBJ_ADD
);
619 /* notify any interfaces this device is now here */
620 down(&parent_class
->sem
);
621 list_add_tail(&class_dev
->node
, &parent_class
->children
);
622 list_for_each_entry(class_intf
, &parent_class
->interfaces
, node
) {
624 class_intf
->add(class_dev
, class_intf
);
626 up(&parent_class
->sem
);
631 class_device_remove_groups(class_dev
);
634 sysfs_remove_link(&class_dev
->kobj
, "device");
636 class_device_remove_attrs(class_dev
);
638 if (MAJOR(class_dev
->devt
))
639 class_device_remove_file(class_dev
, &class_devt_attr
);
641 class_device_remove_file(class_dev
, &class_uevent_attr
);
643 kobject_del(&class_dev
->kobj
);
646 class_device_put(parent_class_dev
);
647 class_put(parent_class
);
649 class_device_put(class_dev
);
653 int class_device_register(struct class_device
*class_dev
)
655 class_device_initialize(class_dev
);
656 return class_device_add(class_dev
);
660 * class_device_create - creates a class device and registers it with sysfs
661 * @cls: pointer to the struct class that this device should be registered to.
662 * @parent: pointer to the parent struct class_device of this new device, if any.
663 * @devt: the dev_t for the char device to be added.
664 * @device: a pointer to a struct device that is assiociated with this class device.
665 * @fmt: string for the class device's name
667 * This function can be used by char device classes. A struct
668 * class_device will be created in sysfs, registered to the specified
670 * A "dev" file will be created, showing the dev_t for the device, if
671 * the dev_t is not 0,0.
672 * If a pointer to a parent struct class_device is passed in, the newly
673 * created struct class_device will be a child of that device in sysfs.
674 * The pointer to the struct class_device will be returned from the
675 * call. Any further sysfs files that might be required can be created
676 * using this pointer.
678 * Note: the struct class passed to this function must have previously
679 * been created with a call to class_create().
681 struct class_device
*class_device_create(struct class *cls
,
682 struct class_device
*parent
,
684 struct device
*device
,
685 const char *fmt
, ...)
688 struct class_device
*class_dev
= NULL
;
689 int retval
= -ENODEV
;
691 if (cls
== NULL
|| IS_ERR(cls
))
694 class_dev
= kzalloc(sizeof(*class_dev
), GFP_KERNEL
);
700 class_dev
->devt
= devt
;
701 class_dev
->dev
= device
;
702 class_dev
->class = cls
;
703 class_dev
->parent
= parent
;
704 class_dev
->release
= class_device_create_release
;
705 class_dev
->uevent
= class_device_create_uevent
;
708 vsnprintf(class_dev
->class_id
, BUS_ID_SIZE
, fmt
, args
);
710 retval
= class_device_register(class_dev
);
718 return ERR_PTR(retval
);
721 void class_device_del(struct class_device
*class_dev
)
723 struct class *parent_class
= class_dev
->class;
724 struct class_device
*parent_device
= class_dev
->parent
;
725 struct class_interface
*class_intf
;
728 down(&parent_class
->sem
);
729 list_del_init(&class_dev
->node
);
730 list_for_each_entry(class_intf
, &parent_class
->interfaces
, node
)
731 if (class_intf
->remove
)
732 class_intf
->remove(class_dev
, class_intf
);
733 up(&parent_class
->sem
);
736 if (class_dev
->dev
) {
737 remove_deprecated_class_device_links(class_dev
);
738 sysfs_remove_link(&class_dev
->kobj
, "device");
740 sysfs_remove_link(&class_dev
->kobj
, "subsystem");
741 class_device_remove_file(class_dev
, &class_uevent_attr
);
742 if (MAJOR(class_dev
->devt
))
743 class_device_remove_file(class_dev
, &class_devt_attr
);
744 class_device_remove_attrs(class_dev
);
745 class_device_remove_groups(class_dev
);
747 kobject_uevent(&class_dev
->kobj
, KOBJ_REMOVE
);
748 kobject_del(&class_dev
->kobj
);
750 class_device_put(parent_device
);
751 class_put(parent_class
);
754 void class_device_unregister(struct class_device
*class_dev
)
756 pr_debug("CLASS: Unregistering class device. ID = '%s'\n",
757 class_dev
->class_id
);
758 class_device_del(class_dev
);
759 class_device_put(class_dev
);
763 * class_device_destroy - removes a class device that was created with class_device_create()
764 * @cls: the pointer to the struct class that this device was registered * with.
765 * @devt: the dev_t of the device that was previously registered.
767 * This call unregisters and cleans up a class device that was created with a
768 * call to class_device_create()
770 void class_device_destroy(struct class *cls
, dev_t devt
)
772 struct class_device
*class_dev
= NULL
;
773 struct class_device
*class_dev_tmp
;
776 list_for_each_entry(class_dev_tmp
, &cls
->children
, node
) {
777 if (class_dev_tmp
->devt
== devt
) {
778 class_dev
= class_dev_tmp
;
785 class_device_unregister(class_dev
);
788 struct class_device
* class_device_get(struct class_device
*class_dev
)
791 return to_class_dev(kobject_get(&class_dev
->kobj
));
795 void class_device_put(struct class_device
*class_dev
)
798 kobject_put(&class_dev
->kobj
);
802 int class_interface_register(struct class_interface
*class_intf
)
804 struct class *parent
;
805 struct class_device
*class_dev
;
808 if (!class_intf
|| !class_intf
->class)
811 parent
= class_get(class_intf
->class);
816 list_add_tail(&class_intf
->node
, &parent
->interfaces
);
817 if (class_intf
->add
) {
818 list_for_each_entry(class_dev
, &parent
->children
, node
)
819 class_intf
->add(class_dev
, class_intf
);
821 if (class_intf
->add_dev
) {
822 list_for_each_entry(dev
, &parent
->devices
, node
)
823 class_intf
->add_dev(dev
, class_intf
);
830 void class_interface_unregister(struct class_interface
*class_intf
)
832 struct class * parent
= class_intf
->class;
833 struct class_device
*class_dev
;
840 list_del_init(&class_intf
->node
);
841 if (class_intf
->remove
) {
842 list_for_each_entry(class_dev
, &parent
->children
, node
)
843 class_intf
->remove(class_dev
, class_intf
);
845 if (class_intf
->remove_dev
) {
846 list_for_each_entry(dev
, &parent
->devices
, node
)
847 class_intf
->remove_dev(dev
, class_intf
);
854 int __init
classes_init(void)
858 retval
= subsystem_register(&class_subsys
);
862 /* ick, this is ugly, the things we go through to keep from showing up
864 kset_init(&class_obj_subsys
);
865 if (!class_obj_subsys
.kobj
.parent
)
866 class_obj_subsys
.kobj
.parent
= &class_obj_subsys
.kobj
;
870 EXPORT_SYMBOL_GPL(class_create_file
);
871 EXPORT_SYMBOL_GPL(class_remove_file
);
872 EXPORT_SYMBOL_GPL(class_register
);
873 EXPORT_SYMBOL_GPL(class_unregister
);
874 EXPORT_SYMBOL_GPL(class_create
);
875 EXPORT_SYMBOL_GPL(class_destroy
);
877 EXPORT_SYMBOL_GPL(class_device_register
);
878 EXPORT_SYMBOL_GPL(class_device_unregister
);
879 EXPORT_SYMBOL_GPL(class_device_initialize
);
880 EXPORT_SYMBOL_GPL(class_device_add
);
881 EXPORT_SYMBOL_GPL(class_device_del
);
882 EXPORT_SYMBOL_GPL(class_device_get
);
883 EXPORT_SYMBOL_GPL(class_device_put
);
884 EXPORT_SYMBOL_GPL(class_device_create
);
885 EXPORT_SYMBOL_GPL(class_device_destroy
);
886 EXPORT_SYMBOL_GPL(class_device_create_file
);
887 EXPORT_SYMBOL_GPL(class_device_remove_file
);
888 EXPORT_SYMBOL_GPL(class_device_create_bin_file
);
889 EXPORT_SYMBOL_GPL(class_device_remove_bin_file
);
891 EXPORT_SYMBOL_GPL(class_interface_register
);
892 EXPORT_SYMBOL_GPL(class_interface_unregister
);