1 // SPDX-License-Identifier: GPL-2.0
3 * class.c - basic device class management
5 * Copyright (c) 2002-3 Patrick Mochel
6 * Copyright (c) 2002-3 Open Source Development Labs
7 * Copyright (c) 2003-2004 Greg Kroah-Hartman
8 * Copyright (c) 2003-2004 IBM Corp.
11 #include <linux/device/class.h>
12 #include <linux/device.h>
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/string.h>
16 #include <linux/kdev_t.h>
17 #include <linux/err.h>
18 #include <linux/slab.h>
19 #include <linux/blkdev.h>
20 #include <linux/mutex.h>
24 static struct kset *class_kset;
26 #define to_class_attr(_attr) container_of(_attr, struct class_attribute, attr)
29 * class_to_subsys - Turn a struct class into a struct subsys_private
31 * @class: pointer to the struct bus_type to look up
33 * The driver core internals need to work on the subsys_private structure, not
34 * the external struct class pointer. This function walks the list of
35 * registered classes in the system and finds the matching one and returns the
36 * internal struct subsys_private that relates to that class.
38 * Note, the reference count of the return value is INCREMENTED if it is not
39 * NULL. A call to subsys_put() must be done when finished with the pointer in
40 * order for it to be properly freed.
42 struct subsys_private *class_to_subsys(const struct class *class)
44 struct subsys_private *sp = NULL;
47 if (!class || !class_kset)
50 spin_lock(&class_kset->list_lock);
52 if (list_empty(&class_kset->list))
55 list_for_each_entry(kobj, &class_kset->list, entry) {
56 struct kset *kset = container_of(kobj, struct kset, kobj);
58 sp = container_of_const(kset, struct subsys_private, subsys);
59 if (sp->class == class)
65 spin_unlock(&class_kset->list_lock);
69 static ssize_t class_attr_show(struct kobject *kobj, struct attribute *attr,
72 struct class_attribute *class_attr = to_class_attr(attr);
73 struct subsys_private *cp = to_subsys_private(kobj);
77 ret = class_attr->show(cp->class, class_attr, buf);
81 static ssize_t class_attr_store(struct kobject *kobj, struct attribute *attr,
82 const char *buf, size_t count)
84 struct class_attribute *class_attr = to_class_attr(attr);
85 struct subsys_private *cp = to_subsys_private(kobj);
88 if (class_attr->store)
89 ret = class_attr->store(cp->class, class_attr, buf, count);
93 static void class_release(struct kobject *kobj)
95 struct subsys_private *cp = to_subsys_private(kobj);
96 struct class *class = cp->class;
98 pr_debug("class '%s': release.\n", class->name);
100 if (class->class_release)
101 class->class_release(class);
103 pr_debug("class '%s' does not have a release() function, "
104 "be careful\n", class->name);
109 static const struct kobj_ns_type_operations *class_child_ns_type(const struct kobject *kobj)
111 const struct subsys_private *cp = to_subsys_private(kobj);
112 struct class *class = cp->class;
114 return class->ns_type;
117 static const struct sysfs_ops class_sysfs_ops = {
118 .show = class_attr_show,
119 .store = class_attr_store,
122 static const struct kobj_type class_ktype = {
123 .sysfs_ops = &class_sysfs_ops,
124 .release = class_release,
125 .child_ns_type = class_child_ns_type,
128 int class_create_file_ns(const struct class *cls, const struct class_attribute *attr,
131 struct subsys_private *sp = class_to_subsys(cls);
137 error = sysfs_create_file_ns(&sp->subsys.kobj, &attr->attr, ns);
142 EXPORT_SYMBOL_GPL(class_create_file_ns);
144 void class_remove_file_ns(const struct class *cls, const struct class_attribute *attr,
147 struct subsys_private *sp = class_to_subsys(cls);
152 sysfs_remove_file_ns(&sp->subsys.kobj, &attr->attr, ns);
155 EXPORT_SYMBOL_GPL(class_remove_file_ns);
157 static struct device *klist_class_to_dev(struct klist_node *n)
159 struct device_private *p = to_device_private_class(n);
163 static void klist_class_dev_get(struct klist_node *n)
165 struct device *dev = klist_class_to_dev(n);
170 static void klist_class_dev_put(struct klist_node *n)
172 struct device *dev = klist_class_to_dev(n);
177 int class_register(struct class *cls)
179 struct subsys_private *cp;
180 struct lock_class_key *key;
183 pr_debug("device class '%s': registering\n", cls->name);
185 cp = kzalloc(sizeof(*cp), GFP_KERNEL);
188 klist_init(&cp->klist_devices, klist_class_dev_get, klist_class_dev_put);
189 INIT_LIST_HEAD(&cp->interfaces);
190 kset_init(&cp->glue_dirs);
192 lockdep_register_key(key);
193 __mutex_init(&cp->mutex, "subsys mutex", key);
194 error = kobject_set_name(&cp->subsys.kobj, "%s", cls->name);
200 /* set the default /sys/dev directory for devices of this class */
202 cls->dev_kobj = sysfs_dev_char_kobj;
204 cp->subsys.kobj.kset = class_kset;
205 cp->subsys.kobj.ktype = &class_ktype;
208 error = kset_register(&cp->subsys);
212 error = sysfs_create_groups(&cp->subsys.kobj, cls->class_groups);
214 kobject_del(&cp->subsys.kobj);
215 kfree_const(cp->subsys.kobj.name);
224 EXPORT_SYMBOL_GPL(class_register);
226 void class_unregister(const struct class *cls)
228 struct subsys_private *sp = class_to_subsys(cls);
233 pr_debug("device class '%s': unregistering\n", cls->name);
235 sysfs_remove_groups(&sp->subsys.kobj, cls->class_groups);
236 kset_unregister(&sp->subsys);
239 EXPORT_SYMBOL_GPL(class_unregister);
241 static void class_create_release(struct class *cls)
243 pr_debug("%s called for %s\n", __func__, cls->name);
248 * class_create - create a struct class structure
249 * @name: pointer to a string for the name of this class.
251 * This is used to create a struct class pointer that can then be used
252 * in calls to device_create().
254 * Returns &struct class pointer on success, or ERR_PTR() on error.
256 * Note, the pointer created here is to be destroyed when finished by
257 * making a call to class_destroy().
259 struct class *class_create(const char *name)
264 cls = kzalloc(sizeof(*cls), GFP_KERNEL);
271 cls->class_release = class_create_release;
273 retval = class_register(cls);
281 return ERR_PTR(retval);
283 EXPORT_SYMBOL_GPL(class_create);
286 * class_destroy - destroys a struct class structure
287 * @cls: pointer to the struct class that is to be destroyed
289 * Note, the pointer to be destroyed must have been created with a call
292 void class_destroy(const struct class *cls)
294 if (IS_ERR_OR_NULL(cls))
297 class_unregister(cls);
299 EXPORT_SYMBOL_GPL(class_destroy);
302 * class_dev_iter_init - initialize class device iterator
303 * @iter: class iterator to initialize
304 * @class: the class we wanna iterate over
305 * @start: the device to start iterating from, if any
306 * @type: device_type of the devices to iterate over, NULL for all
308 * Initialize class iterator @iter such that it iterates over devices
309 * of @class. If @start is set, the list iteration will start there,
310 * otherwise if it is NULL, the iteration starts at the beginning of
313 void class_dev_iter_init(struct class_dev_iter *iter, const struct class *class,
314 const struct device *start, const struct device_type *type)
316 struct subsys_private *sp = class_to_subsys(class);
317 struct klist_node *start_knode = NULL;
323 start_knode = &start->p->knode_class;
324 klist_iter_init_node(&sp->klist_devices, &iter->ki, start_knode);
327 EXPORT_SYMBOL_GPL(class_dev_iter_init);
330 * class_dev_iter_next - iterate to the next device
331 * @iter: class iterator to proceed
333 * Proceed @iter to the next device and return it. Returns NULL if
334 * iteration is complete.
336 * The returned device is referenced and won't be released till
337 * iterator is proceed to the next device or exited. The caller is
338 * free to do whatever it wants to do with the device including
339 * calling back into class code.
341 struct device *class_dev_iter_next(struct class_dev_iter *iter)
343 struct klist_node *knode;
347 knode = klist_next(&iter->ki);
350 dev = klist_class_to_dev(knode);
351 if (!iter->type || iter->type == dev->type)
355 EXPORT_SYMBOL_GPL(class_dev_iter_next);
358 * class_dev_iter_exit - finish iteration
359 * @iter: class iterator to finish
361 * Finish an iteration. Always call this function after iteration is
362 * complete whether the iteration ran till the end or not.
364 void class_dev_iter_exit(struct class_dev_iter *iter)
366 klist_iter_exit(&iter->ki);
368 EXPORT_SYMBOL_GPL(class_dev_iter_exit);
371 * class_for_each_device - device iterator
372 * @class: the class we're iterating
373 * @start: the device to start with in the list, if any.
374 * @data: data for the callback
375 * @fn: function to be called for each device
377 * Iterate over @class's list of devices, and call @fn for each,
378 * passing it @data. If @start is set, the list iteration will start
379 * there, otherwise if it is NULL, the iteration starts at the
380 * beginning of the list.
382 * We check the return of @fn each time. If it returns anything
383 * other than 0, we break out and return that value.
385 * @fn is allowed to do anything including calling back into class
386 * code. There's no locking restriction.
388 int class_for_each_device(const struct class *class, const struct device *start,
389 void *data, int (*fn)(struct device *, void *))
391 struct subsys_private *sp = class_to_subsys(class);
392 struct class_dev_iter iter;
399 WARN(1, "%s called for class '%s' before it was initialized",
400 __func__, class->name);
404 class_dev_iter_init(&iter, class, start, NULL);
405 while ((dev = class_dev_iter_next(&iter))) {
406 error = fn(dev, data);
410 class_dev_iter_exit(&iter);
415 EXPORT_SYMBOL_GPL(class_for_each_device);
418 * class_find_device - device iterator for locating a particular device
419 * @class: the class we're iterating
420 * @start: Device to begin with
421 * @data: data for the match function
422 * @match: function to check device
424 * This is similar to the class_for_each_dev() function above, but it
425 * returns a reference to a device that is 'found' for later use, as
426 * determined by the @match callback.
428 * The callback should return 0 if the device doesn't match and non-zero
429 * if it does. If the callback returns non-zero, this function will
430 * return to the caller and not iterate over any more devices.
432 * Note, you will need to drop the reference with put_device() after use.
434 * @match is allowed to do anything including calling back into class
435 * code. There's no locking restriction.
437 struct device *class_find_device(const struct class *class, const struct device *start,
439 int (*match)(struct device *, const void *))
441 struct subsys_private *sp = class_to_subsys(class);
442 struct class_dev_iter iter;
448 WARN(1, "%s called for class '%s' before it was initialized",
449 __func__, class->name);
453 class_dev_iter_init(&iter, class, start, NULL);
454 while ((dev = class_dev_iter_next(&iter))) {
455 if (match(dev, data)) {
460 class_dev_iter_exit(&iter);
465 EXPORT_SYMBOL_GPL(class_find_device);
467 int class_interface_register(struct class_interface *class_intf)
469 struct subsys_private *sp;
470 const struct class *parent;
471 struct class_dev_iter iter;
474 if (!class_intf || !class_intf->class)
477 parent = class_intf->class;
478 sp = class_to_subsys(parent);
483 * Reference in sp is now incremented and will be dropped when
484 * the interface is removed in the call to class_interface_unregister()
487 mutex_lock(&sp->mutex);
488 list_add_tail(&class_intf->node, &sp->interfaces);
489 if (class_intf->add_dev) {
490 class_dev_iter_init(&iter, parent, NULL, NULL);
491 while ((dev = class_dev_iter_next(&iter)))
492 class_intf->add_dev(dev, class_intf);
493 class_dev_iter_exit(&iter);
495 mutex_unlock(&sp->mutex);
499 EXPORT_SYMBOL_GPL(class_interface_register);
501 void class_interface_unregister(struct class_interface *class_intf)
503 struct subsys_private *sp;
504 struct class *parent = class_intf->class;
505 struct class_dev_iter iter;
511 sp = class_to_subsys(parent);
515 mutex_lock(&sp->mutex);
516 list_del_init(&class_intf->node);
517 if (class_intf->remove_dev) {
518 class_dev_iter_init(&iter, parent, NULL, NULL);
519 while ((dev = class_dev_iter_next(&iter)))
520 class_intf->remove_dev(dev, class_intf);
521 class_dev_iter_exit(&iter);
523 mutex_unlock(&sp->mutex);
526 * Decrement the reference count twice, once for the class_to_subsys()
527 * call in the start of this function, and the second one from the
528 * reference increment in class_interface_register()
533 EXPORT_SYMBOL_GPL(class_interface_unregister);
535 ssize_t show_class_attr_string(const struct class *class,
536 const struct class_attribute *attr, char *buf)
538 struct class_attribute_string *cs;
540 cs = container_of(attr, struct class_attribute_string, attr);
541 return sysfs_emit(buf, "%s\n", cs->str);
544 EXPORT_SYMBOL_GPL(show_class_attr_string);
546 struct class_compat {
547 struct kobject *kobj;
551 * class_compat_register - register a compatibility class
552 * @name: the name of the class
554 * Compatibility class are meant as a temporary user-space compatibility
555 * workaround when converting a family of class devices to a bus devices.
557 struct class_compat *class_compat_register(const char *name)
559 struct class_compat *cls;
561 cls = kmalloc(sizeof(struct class_compat), GFP_KERNEL);
564 cls->kobj = kobject_create_and_add(name, &class_kset->kobj);
571 EXPORT_SYMBOL_GPL(class_compat_register);
574 * class_compat_unregister - unregister a compatibility class
575 * @cls: the class to unregister
577 void class_compat_unregister(struct class_compat *cls)
579 kobject_put(cls->kobj);
582 EXPORT_SYMBOL_GPL(class_compat_unregister);
585 * class_compat_create_link - create a compatibility class device link to
587 * @cls: the compatibility class
588 * @dev: the target bus device
589 * @device_link: an optional device to which a "device" link should be created
591 int class_compat_create_link(struct class_compat *cls, struct device *dev,
592 struct device *device_link)
596 error = sysfs_create_link(cls->kobj, &dev->kobj, dev_name(dev));
601 * Optionally add a "device" link (typically to the parent), as a
602 * class device would have one and we want to provide as much
603 * backwards compatibility as possible.
606 error = sysfs_create_link(&dev->kobj, &device_link->kobj,
609 sysfs_remove_link(cls->kobj, dev_name(dev));
614 EXPORT_SYMBOL_GPL(class_compat_create_link);
617 * class_compat_remove_link - remove a compatibility class device link to
619 * @cls: the compatibility class
620 * @dev: the target bus device
621 * @device_link: an optional device to which a "device" link was previously
624 void class_compat_remove_link(struct class_compat *cls, struct device *dev,
625 struct device *device_link)
628 sysfs_remove_link(&dev->kobj, "device");
629 sysfs_remove_link(cls->kobj, dev_name(dev));
631 EXPORT_SYMBOL_GPL(class_compat_remove_link);
634 * class_is_registered - determine if at this moment in time, a class is
635 * registered in the driver core or not.
636 * @class: the class to check
638 * Returns a boolean to state if the class is registered in the driver core
639 * or not. Note that the value could switch right after this call is made,
640 * so only use this in places where you "know" it is safe to do so (usually
641 * to determine if the specific class has been registered yet or not).
643 * Be careful in using this.
645 bool class_is_registered(const struct class *class)
647 struct subsys_private *sp = class_to_subsys(class);
648 bool is_initialized = false;
651 is_initialized = true;
654 return is_initialized;
656 EXPORT_SYMBOL_GPL(class_is_registered);
658 int __init classes_init(void)
660 class_kset = kset_create_and_add("class", NULL, NULL);