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/config.h>
14 #include <linux/device.h>
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/string.h>
18 #include <linux/kdev_t.h>
19 #include <linux/err.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.kset.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
.kset
.kobj
, &attr
->attr
);
87 void class_remove_file(struct class * cls
, const struct class_attribute
* attr
)
90 sysfs_remove_file(&cls
->subsys
.kset
.kobj
, &attr
->attr
);
93 struct class * class_get(struct class * cls
)
96 return container_of(subsys_get(&cls
->subsys
), struct class, subsys
);
100 void class_put(struct class * cls
)
102 subsys_put(&cls
->subsys
);
106 static int add_class_attrs(struct class * cls
)
111 if (cls
->class_attrs
) {
112 for (i
= 0; attr_name(cls
->class_attrs
[i
]); i
++) {
113 error
= class_create_file(cls
,&cls
->class_attrs
[i
]);
122 class_remove_file(cls
,&cls
->class_attrs
[i
]);
126 static void remove_class_attrs(struct class * cls
)
130 if (cls
->class_attrs
) {
131 for (i
= 0; attr_name(cls
->class_attrs
[i
]); i
++)
132 class_remove_file(cls
,&cls
->class_attrs
[i
]);
136 int class_register(struct class * cls
)
140 pr_debug("device class '%s': registering\n", cls
->name
);
142 INIT_LIST_HEAD(&cls
->children
);
143 INIT_LIST_HEAD(&cls
->interfaces
);
144 init_MUTEX(&cls
->sem
);
145 error
= kobject_set_name(&cls
->subsys
.kset
.kobj
, "%s", cls
->name
);
149 subsys_set_kset(cls
, class_subsys
);
151 error
= subsystem_register(&cls
->subsys
);
153 error
= add_class_attrs(class_get(cls
));
159 void class_unregister(struct class * cls
)
161 pr_debug("device class '%s': unregistering\n", cls
->name
);
162 remove_class_attrs(cls
);
163 subsystem_unregister(&cls
->subsys
);
166 static void class_create_release(struct class *cls
)
171 static void class_device_create_release(struct class_device
*class_dev
)
177 * class_create - create a struct class structure
178 * @owner: pointer to the module that is to "own" this struct class
179 * @name: pointer to a string for the name of this class.
181 * This is used to create a struct class pointer that can then be used
182 * in calls to class_device_create().
184 * Note, the pointer created here is to be destroyed when finished by
185 * making a call to class_destroy().
187 struct class *class_create(struct module
*owner
, char *name
)
192 cls
= kmalloc(sizeof(struct class), GFP_KERNEL
);
197 memset(cls
, 0x00, sizeof(struct class));
201 cls
->class_release
= class_create_release
;
202 cls
->release
= class_device_create_release
;
204 retval
= class_register(cls
);
212 return ERR_PTR(retval
);
216 * class_destroy - destroys a struct class structure
217 * @cs: pointer to the struct class that is to be destroyed
219 * Note, the pointer to be destroyed must have been created with a call
222 void class_destroy(struct class *cls
)
224 if ((cls
== NULL
) || (IS_ERR(cls
)))
227 class_unregister(cls
);
230 /* Class Device Stuff */
232 int class_device_create_file(struct class_device
* class_dev
,
233 const struct class_device_attribute
* attr
)
237 error
= sysfs_create_file(&class_dev
->kobj
, &attr
->attr
);
241 void class_device_remove_file(struct class_device
* class_dev
,
242 const struct class_device_attribute
* attr
)
245 sysfs_remove_file(&class_dev
->kobj
, &attr
->attr
);
248 int class_device_create_bin_file(struct class_device
*class_dev
,
249 struct bin_attribute
*attr
)
253 error
= sysfs_create_bin_file(&class_dev
->kobj
, attr
);
257 void class_device_remove_bin_file(struct class_device
*class_dev
,
258 struct bin_attribute
*attr
)
261 sysfs_remove_bin_file(&class_dev
->kobj
, attr
);
265 class_device_attr_show(struct kobject
* kobj
, struct attribute
* attr
,
268 struct class_device_attribute
* class_dev_attr
= to_class_dev_attr(attr
);
269 struct class_device
* cd
= to_class_dev(kobj
);
272 if (class_dev_attr
->show
)
273 ret
= class_dev_attr
->show(cd
, buf
);
278 class_device_attr_store(struct kobject
* kobj
, struct attribute
* attr
,
279 const char * buf
, size_t count
)
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
->store
)
286 ret
= class_dev_attr
->store(cd
, buf
, count
);
290 static struct sysfs_ops class_dev_sysfs_ops
= {
291 .show
= class_device_attr_show
,
292 .store
= class_device_attr_store
,
295 static void class_dev_release(struct kobject
* kobj
)
297 struct class_device
*cd
= to_class_dev(kobj
);
298 struct class * cls
= cd
->class;
300 pr_debug("device class '%s': release.\n", cd
->class_id
);
302 kfree(cd
->devt_attr
);
303 cd
->devt_attr
= NULL
;
308 printk(KERN_ERR
"Device class '%s' does not have a release() function, "
309 "it is broken and must be fixed.\n",
315 static struct kobj_type ktype_class_device
= {
316 .sysfs_ops
= &class_dev_sysfs_ops
,
317 .release
= class_dev_release
,
320 static int class_hotplug_filter(struct kset
*kset
, struct kobject
*kobj
)
322 struct kobj_type
*ktype
= get_ktype(kobj
);
324 if (ktype
== &ktype_class_device
) {
325 struct class_device
*class_dev
= to_class_dev(kobj
);
326 if (class_dev
->class)
332 static const char *class_hotplug_name(struct kset
*kset
, struct kobject
*kobj
)
334 struct class_device
*class_dev
= to_class_dev(kobj
);
336 return class_dev
->class->name
;
339 static int class_hotplug(struct kset
*kset
, struct kobject
*kobj
, char **envp
,
340 int num_envp
, char *buffer
, int buffer_size
)
342 struct class_device
*class_dev
= to_class_dev(kobj
);
347 pr_debug("%s - name = %s\n", __FUNCTION__
, class_dev
->class_id
);
349 if (class_dev
->dev
) {
350 /* add physical device, backing this device */
351 struct device
*dev
= class_dev
->dev
;
352 char *path
= kobject_get_path(&dev
->kobj
, GFP_KERNEL
);
354 add_hotplug_env_var(envp
, num_envp
, &i
, buffer
, buffer_size
,
355 &length
, "PHYSDEVPATH=%s", path
);
359 add_hotplug_env_var(envp
, num_envp
, &i
,
360 buffer
, buffer_size
, &length
,
361 "PHYSDEVBUS=%s", dev
->bus
->name
);
364 add_hotplug_env_var(envp
, num_envp
, &i
,
365 buffer
, buffer_size
, &length
,
366 "PHYSDEVDRIVER=%s", dev
->driver
->name
);
369 if (MAJOR(class_dev
->devt
)) {
370 add_hotplug_env_var(envp
, num_envp
, &i
,
371 buffer
, buffer_size
, &length
,
372 "MAJOR=%u", MAJOR(class_dev
->devt
));
374 add_hotplug_env_var(envp
, num_envp
, &i
,
375 buffer
, buffer_size
, &length
,
376 "MINOR=%u", MINOR(class_dev
->devt
));
379 /* terminate, set to next free slot, shrink available space */
383 buffer
= &buffer
[length
];
384 buffer_size
-= length
;
386 if (class_dev
->class->hotplug
) {
387 /* have the bus specific function add its stuff */
388 retval
= class_dev
->class->hotplug (class_dev
, envp
, num_envp
,
389 buffer
, buffer_size
);
391 pr_debug ("%s - hotplug() returned %d\n",
392 __FUNCTION__
, retval
);
399 static struct kset_hotplug_ops class_hotplug_ops
= {
400 .filter
= class_hotplug_filter
,
401 .name
= class_hotplug_name
,
402 .hotplug
= class_hotplug
,
405 static decl_subsys(class_obj
, &ktype_class_device
, &class_hotplug_ops
);
408 static int class_device_add_attrs(struct class_device
* cd
)
412 struct class * cls
= cd
->class;
414 if (cls
->class_dev_attrs
) {
415 for (i
= 0; attr_name(cls
->class_dev_attrs
[i
]); i
++) {
416 error
= class_device_create_file(cd
,
417 &cls
->class_dev_attrs
[i
]);
426 class_device_remove_file(cd
,&cls
->class_dev_attrs
[i
]);
430 static void class_device_remove_attrs(struct class_device
* cd
)
433 struct class * cls
= cd
->class;
435 if (cls
->class_dev_attrs
) {
436 for (i
= 0; attr_name(cls
->class_dev_attrs
[i
]); i
++)
437 class_device_remove_file(cd
,&cls
->class_dev_attrs
[i
]);
441 static ssize_t
show_dev(struct class_device
*class_dev
, char *buf
)
443 return print_dev_t(buf
, class_dev
->devt
);
446 void class_device_initialize(struct class_device
*class_dev
)
448 kobj_set_kset_s(class_dev
, class_obj_subsys
);
449 kobject_init(&class_dev
->kobj
);
450 INIT_LIST_HEAD(&class_dev
->node
);
453 static char *make_class_name(struct class_device
*class_dev
)
458 size
= strlen(class_dev
->class->name
) +
459 strlen(kobject_name(&class_dev
->kobj
)) + 2;
461 name
= kmalloc(size
, GFP_KERNEL
);
463 return ERR_PTR(-ENOMEM
);
465 strcpy(name
, class_dev
->class->name
);
467 strcat(name
, kobject_name(&class_dev
->kobj
));
471 int class_device_add(struct class_device
*class_dev
)
473 struct class * parent
= NULL
;
474 struct class_interface
* class_intf
;
475 char *class_name
= NULL
;
478 class_dev
= class_device_get(class_dev
);
482 if (!strlen(class_dev
->class_id
)) {
487 parent
= class_get(class_dev
->class);
489 pr_debug("CLASS: registering class device: ID = '%s'\n",
490 class_dev
->class_id
);
492 /* first, register with generic layer. */
493 kobject_set_name(&class_dev
->kobj
, "%s", class_dev
->class_id
);
495 class_dev
->kobj
.parent
= &parent
->subsys
.kset
.kobj
;
497 if ((error
= kobject_add(&class_dev
->kobj
)))
500 /* add the needed attributes to this device */
501 if (MAJOR(class_dev
->devt
)) {
502 struct class_device_attribute
*attr
;
503 attr
= kmalloc(sizeof(*attr
), GFP_KERNEL
);
506 kobject_del(&class_dev
->kobj
);
509 memset(attr
, sizeof(*attr
), 0x00);
510 attr
->attr
.name
= "dev";
511 attr
->attr
.mode
= S_IRUGO
;
512 attr
->attr
.owner
= parent
->owner
;
513 attr
->show
= show_dev
;
515 class_device_create_file(class_dev
, attr
);
516 class_dev
->devt_attr
= attr
;
519 class_device_add_attrs(class_dev
);
520 if (class_dev
->dev
) {
521 class_name
= make_class_name(class_dev
);
522 sysfs_create_link(&class_dev
->kobj
,
523 &class_dev
->dev
->kobj
, "device");
524 sysfs_create_link(&class_dev
->dev
->kobj
, &class_dev
->kobj
,
528 /* notify any interfaces this device is now here */
531 list_add_tail(&class_dev
->node
, &parent
->children
);
532 list_for_each_entry(class_intf
, &parent
->interfaces
, node
)
534 class_intf
->add(class_dev
);
537 kobject_hotplug(&class_dev
->kobj
, KOBJ_ADD
);
542 class_device_put(class_dev
);
547 int class_device_register(struct class_device
*class_dev
)
549 class_device_initialize(class_dev
);
550 return class_device_add(class_dev
);
554 * class_device_create - creates a class device and registers it with sysfs
555 * @cs: pointer to the struct class that this device should be registered to.
556 * @dev: the dev_t for the char device to be added.
557 * @device: a pointer to a struct device that is assiociated with this class device.
558 * @fmt: string for the class device's name
560 * This function can be used by char device classes. A struct
561 * class_device will be created in sysfs, registered to the specified
562 * class. A "dev" file will be created, showing the dev_t for the
563 * device. The pointer to the struct class_device will be returned from
564 * the call. Any further sysfs files that might be required can be
565 * created using this pointer.
567 * Note: the struct class passed to this function must have previously
568 * been created with a call to class_create().
570 struct class_device
*class_device_create(struct class *cls
, dev_t devt
,
571 struct device
*device
, char *fmt
, ...)
574 struct class_device
*class_dev
= NULL
;
575 int retval
= -ENODEV
;
577 if (cls
== NULL
|| IS_ERR(cls
))
580 class_dev
= kmalloc(sizeof(struct class_device
), GFP_KERNEL
);
585 memset(class_dev
, 0x00, sizeof(struct class_device
));
587 class_dev
->devt
= devt
;
588 class_dev
->dev
= device
;
589 class_dev
->class = cls
;
592 vsnprintf(class_dev
->class_id
, BUS_ID_SIZE
, fmt
, args
);
594 retval
= class_device_register(class_dev
);
602 return ERR_PTR(retval
);
605 void class_device_del(struct class_device
*class_dev
)
607 struct class * parent
= class_dev
->class;
608 struct class_interface
* class_intf
;
609 char *class_name
= NULL
;
613 list_del_init(&class_dev
->node
);
614 list_for_each_entry(class_intf
, &parent
->interfaces
, node
)
615 if (class_intf
->remove
)
616 class_intf
->remove(class_dev
);
620 if (class_dev
->dev
) {
621 class_name
= make_class_name(class_dev
);
622 sysfs_remove_link(&class_dev
->kobj
, "device");
623 sysfs_remove_link(&class_dev
->dev
->kobj
, class_name
);
625 if (class_dev
->devt_attr
)
626 class_device_remove_file(class_dev
, class_dev
->devt_attr
);
627 class_device_remove_attrs(class_dev
);
629 kobject_hotplug(&class_dev
->kobj
, KOBJ_REMOVE
);
630 kobject_del(&class_dev
->kobj
);
637 void class_device_unregister(struct class_device
*class_dev
)
639 pr_debug("CLASS: Unregistering class device. ID = '%s'\n",
640 class_dev
->class_id
);
641 class_device_del(class_dev
);
642 class_device_put(class_dev
);
646 * class_device_destroy - removes a class device that was created with class_device_create()
647 * @cls: the pointer to the struct class that this device was registered * with.
648 * @dev: the dev_t of the device that was previously registered.
650 * This call unregisters and cleans up a class device that was created with a
651 * call to class_device_create()
653 void class_device_destroy(struct class *cls
, dev_t devt
)
655 struct class_device
*class_dev
= NULL
;
656 struct class_device
*class_dev_tmp
;
659 list_for_each_entry(class_dev_tmp
, &cls
->children
, node
) {
660 if (class_dev_tmp
->devt
== devt
) {
661 class_dev
= class_dev_tmp
;
668 class_device_unregister(class_dev
);
671 int class_device_rename(struct class_device
*class_dev
, char *new_name
)
675 class_dev
= class_device_get(class_dev
);
679 pr_debug("CLASS: renaming '%s' to '%s'\n", class_dev
->class_id
,
682 strlcpy(class_dev
->class_id
, new_name
, KOBJ_NAME_LEN
);
684 error
= kobject_rename(&class_dev
->kobj
, new_name
);
686 class_device_put(class_dev
);
691 struct class_device
* class_device_get(struct class_device
*class_dev
)
694 return to_class_dev(kobject_get(&class_dev
->kobj
));
698 void class_device_put(struct class_device
*class_dev
)
700 kobject_put(&class_dev
->kobj
);
704 int class_interface_register(struct class_interface
*class_intf
)
706 struct class *parent
;
707 struct class_device
*class_dev
;
709 if (!class_intf
|| !class_intf
->class)
712 parent
= class_get(class_intf
->class);
717 list_add_tail(&class_intf
->node
, &parent
->interfaces
);
718 if (class_intf
->add
) {
719 list_for_each_entry(class_dev
, &parent
->children
, node
)
720 class_intf
->add(class_dev
);
727 void class_interface_unregister(struct class_interface
*class_intf
)
729 struct class * parent
= class_intf
->class;
730 struct class_device
*class_dev
;
736 list_del_init(&class_intf
->node
);
737 if (class_intf
->remove
) {
738 list_for_each_entry(class_dev
, &parent
->children
, node
)
739 class_intf
->remove(class_dev
);
748 int __init
classes_init(void)
752 retval
= subsystem_register(&class_subsys
);
756 /* ick, this is ugly, the things we go through to keep from showing up
758 subsystem_init(&class_obj_subsys
);
759 if (!class_obj_subsys
.kset
.subsys
)
760 class_obj_subsys
.kset
.subsys
= &class_obj_subsys
;
764 EXPORT_SYMBOL_GPL(class_create_file
);
765 EXPORT_SYMBOL_GPL(class_remove_file
);
766 EXPORT_SYMBOL_GPL(class_register
);
767 EXPORT_SYMBOL_GPL(class_unregister
);
768 EXPORT_SYMBOL_GPL(class_get
);
769 EXPORT_SYMBOL_GPL(class_put
);
770 EXPORT_SYMBOL_GPL(class_create
);
771 EXPORT_SYMBOL_GPL(class_destroy
);
773 EXPORT_SYMBOL_GPL(class_device_register
);
774 EXPORT_SYMBOL_GPL(class_device_unregister
);
775 EXPORT_SYMBOL_GPL(class_device_initialize
);
776 EXPORT_SYMBOL_GPL(class_device_add
);
777 EXPORT_SYMBOL_GPL(class_device_del
);
778 EXPORT_SYMBOL_GPL(class_device_get
);
779 EXPORT_SYMBOL_GPL(class_device_put
);
780 EXPORT_SYMBOL_GPL(class_device_create
);
781 EXPORT_SYMBOL_GPL(class_device_destroy
);
782 EXPORT_SYMBOL_GPL(class_device_create_file
);
783 EXPORT_SYMBOL_GPL(class_device_remove_file
);
784 EXPORT_SYMBOL_GPL(class_device_create_bin_file
);
785 EXPORT_SYMBOL_GPL(class_device_remove_bin_file
);
787 EXPORT_SYMBOL_GPL(class_interface_register
);
788 EXPORT_SYMBOL_GPL(class_interface_unregister
);