drivers/base/class.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * class.c - basic device class management
   4  *
   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.
   9  */
  10
  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>
  21 #include "base.h"
  22
  23 /* /sys/class */
  24 static struct kset *class_kset;
  25
  26 #define to_class_attr(_attr) container_of(_attr, struct class_attribute, attr)
  27
  28 /**
  29  * class_to_subsys - Turn a struct class into a struct subsys_private
  30  *
  31  * @class: pointer to the struct bus_type to look up
  32  *
  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.
  37  *
  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.
  41  */
  42 struct subsys_private *class_to_subsys(const struct class *class)
  43 {
  44         struct subsys_private *sp = NULL;
  45         struct kobject *kobj;
  46
  47         if (!class || !class_kset)
  48                 return NULL;
  49
  50         spin_lock(&class_kset->list_lock);
  51
  52         if (list_empty(&class_kset->list))
  53                 goto done;
  54
  55         list_for_each_entry(kobj, &class_kset->list, entry) {
  56                 struct kset *kset = container_of(kobj, struct kset, kobj);
  57
  58                 sp = container_of_const(kset, struct subsys_private, subsys);
  59                 if (sp->class == class)
  60                         goto done;
  61         }
  62         sp = NULL;
  63 done:
  64         sp = subsys_get(sp);
  65         spin_unlock(&class_kset->list_lock);
  66         return sp;
  67 }
  68
  69 static ssize_t class_attr_show(struct kobject *kobj, struct attribute *attr,
  70                                char *buf)
  71 {
  72         struct class_attribute *class_attr = to_class_attr(attr);
  73         struct subsys_private *cp = to_subsys_private(kobj);
  74         ssize_t ret = -EIO;
  75
  76         if (class_attr->show)
  77                 ret = class_attr->show(cp->class, class_attr, buf);
  78         return ret;
  79 }
  80
  81 static ssize_t class_attr_store(struct kobject *kobj, struct attribute *attr,
  82                                 const char *buf, size_t count)
  83 {
  84         struct class_attribute *class_attr = to_class_attr(attr);
  85         struct subsys_private *cp = to_subsys_private(kobj);
  86         ssize_t ret = -EIO;
  87
  88         if (class_attr->store)
  89                 ret = class_attr->store(cp->class, class_attr, buf, count);
  90         return ret;
  91 }
  92
  93 static void class_release(struct kobject *kobj)
  94 {
  95         struct subsys_private *cp = to_subsys_private(kobj);
  96         const struct class *class = cp->class;
  97
  98         pr_debug("class '%s': release.\n", class->name);
  99
 100         if (class->class_release)
 101                 class->class_release(class);
 102         else
 103                 pr_debug("class '%s' does not have a release() function, "
 104                          "be careful\n", class->name);
 105
 106         lockdep_unregister_key(&cp->lock_key);
 107         kfree(cp);
 108 }
 109
 110 static const struct kobj_ns_type_operations *class_child_ns_type(const struct kobject *kobj)
 111 {
 112         const struct subsys_private *cp = to_subsys_private(kobj);
 113         const struct class *class = cp->class;
 114
 115         return class->ns_type;
 116 }
 117
 118 static const struct sysfs_ops class_sysfs_ops = {
 119         .show      = class_attr_show,
 120         .store     = class_attr_store,
 121 };
 122
 123 static const struct kobj_type class_ktype = {
 124         .sysfs_ops      = &class_sysfs_ops,
 125         .release        = class_release,
 126         .child_ns_type  = class_child_ns_type,
 127 };
 128
 129 int class_create_file_ns(const struct class *cls, const struct class_attribute *attr,
 130                          const void *ns)
 131 {
 132         struct subsys_private *sp = class_to_subsys(cls);
 133         int error;
 134
 135         if (!sp)
 136                 return -EINVAL;
 137
 138         error = sysfs_create_file_ns(&sp->subsys.kobj, &attr->attr, ns);
 139         subsys_put(sp);
 140
 141         return error;
 142 }
 143 EXPORT_SYMBOL_GPL(class_create_file_ns);
 144
 145 void class_remove_file_ns(const struct class *cls, const struct class_attribute *attr,
 146                           const void *ns)
 147 {
 148         struct subsys_private *sp = class_to_subsys(cls);
 149
 150         if (!sp)
 151                 return;
 152
 153         sysfs_remove_file_ns(&sp->subsys.kobj, &attr->attr, ns);
 154         subsys_put(sp);
 155 }
 156 EXPORT_SYMBOL_GPL(class_remove_file_ns);
 157
 158 static struct device *klist_class_to_dev(struct klist_node *n)
 159 {
 160         struct device_private *p = to_device_private_class(n);
 161         return p->device;
 162 }
 163
 164 static void klist_class_dev_get(struct klist_node *n)
 165 {
 166         struct device *dev = klist_class_to_dev(n);
 167
 168         get_device(dev);
 169 }
 170
 171 static void klist_class_dev_put(struct klist_node *n)
 172 {
 173         struct device *dev = klist_class_to_dev(n);
 174
 175         put_device(dev);
 176 }
 177
 178 int class_register(const struct class *cls)
 179 {
 180         struct subsys_private *cp;
 181         struct lock_class_key *key;
 182         int error;
 183
 184         pr_debug("device class '%s': registering\n", cls->name);
 185
 186         if (cls->ns_type && !cls->namespace) {
 187                 pr_err("%s: class '%s' does not have namespace\n",
 188                        __func__, cls->name);
 189                 return -EINVAL;
 190         }
 191         if (!cls->ns_type && cls->namespace) {
 192                 pr_err("%s: class '%s' does not have ns_type\n",
 193                        __func__, cls->name);
 194                 return -EINVAL;
 195         }
 196
 197         cp = kzalloc(sizeof(*cp), GFP_KERNEL);
 198         if (!cp)
 199                 return -ENOMEM;
 200         klist_init(&cp->klist_devices, klist_class_dev_get, klist_class_dev_put);
 201         INIT_LIST_HEAD(&cp->interfaces);
 202         kset_init(&cp->glue_dirs);
 203         key = &cp->lock_key;
 204         lockdep_register_key(key);
 205         __mutex_init(&cp->mutex, "subsys mutex", key);
 206         error = kobject_set_name(&cp->subsys.kobj, "%s", cls->name);
 207         if (error)
 208                 goto err_out;
 209
 210         cp->subsys.kobj.kset = class_kset;
 211         cp->subsys.kobj.ktype = &class_ktype;
 212         cp->class = cls;
 213
 214         error = kset_register(&cp->subsys);
 215         if (error)
 216                 goto err_out;
 217
 218         error = sysfs_create_groups(&cp->subsys.kobj, cls->class_groups);
 219         if (error) {
 220                 kobject_del(&cp->subsys.kobj);
 221                 kfree_const(cp->subsys.kobj.name);
 222                 goto err_out;
 223         }
 224         return 0;
 225
 226 err_out:
 227         lockdep_unregister_key(key);
 228         kfree(cp);
 229         return error;
 230 }
 231 EXPORT_SYMBOL_GPL(class_register);
 232
 233 void class_unregister(const struct class *cls)
 234 {
 235         struct subsys_private *sp = class_to_subsys(cls);
 236
 237         if (!sp)
 238                 return;
 239
 240         pr_debug("device class '%s': unregistering\n", cls->name);
 241
 242         sysfs_remove_groups(&sp->subsys.kobj, cls->class_groups);
 243         kset_unregister(&sp->subsys);
 244         subsys_put(sp);
 245 }
 246 EXPORT_SYMBOL_GPL(class_unregister);
 247
 248 static void class_create_release(const struct class *cls)
 249 {
 250         pr_debug("%s called for %s\n", __func__, cls->name);
 251         kfree(cls);
 252 }
 253
 254 /**
 255  * class_create - create a struct class structure
 256  * @name: pointer to a string for the name of this class.
 257  *
 258  * This is used to create a struct class pointer that can then be used
 259  * in calls to device_create().
 260  *
 261  * Returns &struct class pointer on success, or ERR_PTR() on error.
 262  *
 263  * Note, the pointer created here is to be destroyed when finished by
 264  * making a call to class_destroy().
 265  */
 266 struct class *class_create(const char *name)
 267 {
 268         struct class *cls;
 269         int retval;
 270
 271         cls = kzalloc(sizeof(*cls), GFP_KERNEL);
 272         if (!cls) {
 273                 retval = -ENOMEM;
 274                 goto error;
 275         }
 276
 277         cls->name = name;
 278         cls->class_release = class_create_release;
 279
 280         retval = class_register(cls);
 281         if (retval)
 282                 goto error;
 283
 284         return cls;
 285
 286 error:
 287         kfree(cls);
 288         return ERR_PTR(retval);
 289 }
 290 EXPORT_SYMBOL_GPL(class_create);
 291
 292 /**
 293  * class_destroy - destroys a struct class structure
 294  * @cls: pointer to the struct class that is to be destroyed
 295  *
 296  * Note, the pointer to be destroyed must have been created with a call
 297  * to class_create().
 298  */
 299 void class_destroy(const struct class *cls)
 300 {
 301         if (IS_ERR_OR_NULL(cls))
 302                 return;
 303
 304         class_unregister(cls);
 305 }
 306 EXPORT_SYMBOL_GPL(class_destroy);
 307
 308 /**
 309  * class_dev_iter_init - initialize class device iterator
 310  * @iter: class iterator to initialize
 311  * @class: the class we wanna iterate over
 312  * @start: the device to start iterating from, if any
 313  * @type: device_type of the devices to iterate over, NULL for all
 314  *
 315  * Initialize class iterator @iter such that it iterates over devices
 316  * of @class.  If @start is set, the list iteration will start there,
 317  * otherwise if it is NULL, the iteration starts at the beginning of
 318  * the list.
 319  */
 320 void class_dev_iter_init(struct class_dev_iter *iter, const struct class *class,
 321                          const struct device *start, const struct device_type *type)
 322 {
 323         struct subsys_private *sp = class_to_subsys(class);
 324         struct klist_node *start_knode = NULL;
 325
 326         if (!sp)
 327                 return;
 328
 329         if (start)
 330                 start_knode = &start->p->knode_class;
 331         klist_iter_init_node(&sp->klist_devices, &iter->ki, start_knode);
 332         iter->type = type;
 333         iter->sp = sp;
 334 }
 335 EXPORT_SYMBOL_GPL(class_dev_iter_init);
 336
 337 /**
 338  * class_dev_iter_next - iterate to the next device
 339  * @iter: class iterator to proceed
 340  *
 341  * Proceed @iter to the next device and return it.  Returns NULL if
 342  * iteration is complete.
 343  *
 344  * The returned device is referenced and won't be released till
 345  * iterator is proceed to the next device or exited.  The caller is
 346  * free to do whatever it wants to do with the device including
 347  * calling back into class code.
 348  */
 349 struct device *class_dev_iter_next(struct class_dev_iter *iter)
 350 {
 351         struct klist_node *knode;
 352         struct device *dev;
 353
 354         while (1) {
 355                 knode = klist_next(&iter->ki);
 356                 if (!knode)
 357                         return NULL;
 358                 dev = klist_class_to_dev(knode);
 359                 if (!iter->type || iter->type == dev->type)
 360                         return dev;
 361         }
 362 }
 363 EXPORT_SYMBOL_GPL(class_dev_iter_next);
 364
 365 /**
 366  * class_dev_iter_exit - finish iteration
 367  * @iter: class iterator to finish
 368  *
 369  * Finish an iteration.  Always call this function after iteration is
 370  * complete whether the iteration ran till the end or not.
 371  */
 372 void class_dev_iter_exit(struct class_dev_iter *iter)
 373 {
 374         klist_iter_exit(&iter->ki);
 375         subsys_put(iter->sp);
 376 }
 377 EXPORT_SYMBOL_GPL(class_dev_iter_exit);
 378
 379 /**
 380  * class_for_each_device - device iterator
 381  * @class: the class we're iterating
 382  * @start: the device to start with in the list, if any.
 383  * @data: data for the callback
 384  * @fn: function to be called for each device
 385  *
 386  * Iterate over @class's list of devices, and call @fn for each,
 387  * passing it @data.  If @start is set, the list iteration will start
 388  * there, otherwise if it is NULL, the iteration starts at the
 389  * beginning of the list.
 390  *
 391  * We check the return of @fn each time. If it returns anything
 392  * other than 0, we break out and return that value.
 393  *
 394  * @fn is allowed to do anything including calling back into class
 395  * code.  There's no locking restriction.
 396  */
 397 int class_for_each_device(const struct class *class, const struct device *start,
 398                           void *data, int (*fn)(struct device *, void *))
 399 {
 400         struct subsys_private *sp = class_to_subsys(class);
 401         struct class_dev_iter iter;
 402         struct device *dev;
 403         int error = 0;
 404
 405         if (!class)
 406                 return -EINVAL;
 407         if (!sp) {
 408                 WARN(1, "%s called for class '%s' before it was initialized",
 409                      __func__, class->name);
 410                 return -EINVAL;
 411         }
 412
 413         class_dev_iter_init(&iter, class, start, NULL);
 414         while ((dev = class_dev_iter_next(&iter))) {
 415                 error = fn(dev, data);
 416                 if (error)
 417                         break;
 418         }
 419         class_dev_iter_exit(&iter);
 420         subsys_put(sp);
 421
 422         return error;
 423 }
 424 EXPORT_SYMBOL_GPL(class_for_each_device);
 425
 426 /**
 427  * class_find_device - device iterator for locating a particular device
 428  * @class: the class we're iterating
 429  * @start: Device to begin with
 430  * @data: data for the match function
 431  * @match: function to check device
 432  *
 433  * This is similar to the class_for_each_dev() function above, but it
 434  * returns a reference to a device that is 'found' for later use, as
 435  * determined by the @match callback.
 436  *
 437  * The callback should return 0 if the device doesn't match and non-zero
 438  * if it does.  If the callback returns non-zero, this function will
 439  * return to the caller and not iterate over any more devices.
 440  *
 441  * Note, you will need to drop the reference with put_device() after use.
 442  *
 443  * @match is allowed to do anything including calling back into class
 444  * code.  There's no locking restriction.
 445  */
 446 struct device *class_find_device(const struct class *class, const struct device *start,
 447                                  const void *data, device_match_t match)
 448 {
 449         struct subsys_private *sp = class_to_subsys(class);
 450         struct class_dev_iter iter;
 451         struct device *dev;
 452
 453         if (!class)
 454                 return NULL;
 455         if (!sp) {
 456                 WARN(1, "%s called for class '%s' before it was initialized",
 457                      __func__, class->name);
 458                 return NULL;
 459         }
 460
 461         class_dev_iter_init(&iter, class, start, NULL);
 462         while ((dev = class_dev_iter_next(&iter))) {
 463                 if (match(dev, data)) {
 464                         get_device(dev);
 465                         break;
 466                 }
 467         }
 468         class_dev_iter_exit(&iter);
 469         subsys_put(sp);
 470
 471         return dev;
 472 }
 473 EXPORT_SYMBOL_GPL(class_find_device);
 474
 475 int class_interface_register(struct class_interface *class_intf)
 476 {
 477         struct subsys_private *sp;
 478         const struct class *parent;
 479         struct class_dev_iter iter;
 480         struct device *dev;
 481
 482         if (!class_intf || !class_intf->class)
 483                 return -ENODEV;
 484
 485         parent = class_intf->class;
 486         sp = class_to_subsys(parent);
 487         if (!sp)
 488                 return -EINVAL;
 489
 490         /*
 491          * Reference in sp is now incremented and will be dropped when
 492          * the interface is removed in the call to class_interface_unregister()
 493          */
 494
 495         mutex_lock(&sp->mutex);
 496         list_add_tail(&class_intf->node, &sp->interfaces);
 497         if (class_intf->add_dev) {
 498                 class_dev_iter_init(&iter, parent, NULL, NULL);
 499                 while ((dev = class_dev_iter_next(&iter)))
 500                         class_intf->add_dev(dev);
 501                 class_dev_iter_exit(&iter);
 502         }
 503         mutex_unlock(&sp->mutex);
 504
 505         return 0;
 506 }
 507 EXPORT_SYMBOL_GPL(class_interface_register);
 508
 509 void class_interface_unregister(struct class_interface *class_intf)
 510 {
 511         struct subsys_private *sp;
 512         const struct class *parent = class_intf->class;
 513         struct class_dev_iter iter;
 514         struct device *dev;
 515
 516         if (!parent)
 517                 return;
 518
 519         sp = class_to_subsys(parent);
 520         if (!sp)
 521                 return;
 522
 523         mutex_lock(&sp->mutex);
 524         list_del_init(&class_intf->node);
 525         if (class_intf->remove_dev) {
 526                 class_dev_iter_init(&iter, parent, NULL, NULL);
 527                 while ((dev = class_dev_iter_next(&iter)))
 528                         class_intf->remove_dev(dev);
 529                 class_dev_iter_exit(&iter);
 530         }
 531         mutex_unlock(&sp->mutex);
 532
 533         /*
 534          * Decrement the reference count twice, once for the class_to_subsys()
 535          * call in the start of this function, and the second one from the
 536          * reference increment in class_interface_register()
 537          */
 538         subsys_put(sp);
 539         subsys_put(sp);
 540 }
 541 EXPORT_SYMBOL_GPL(class_interface_unregister);
 542
 543 ssize_t show_class_attr_string(const struct class *class,
 544                                const struct class_attribute *attr, char *buf)
 545 {
 546         struct class_attribute_string *cs;
 547
 548         cs = container_of(attr, struct class_attribute_string, attr);
 549         return sysfs_emit(buf, "%s\n", cs->str);
 550 }
 551
 552 EXPORT_SYMBOL_GPL(show_class_attr_string);
 553
 554 struct class_compat {
 555         struct kobject *kobj;
 556 };
 557
 558 /**
 559  * class_compat_register - register a compatibility class
 560  * @name: the name of the class
 561  *
 562  * Compatibility class are meant as a temporary user-space compatibility
 563  * workaround when converting a family of class devices to a bus devices.
 564  */
 565 struct class_compat *class_compat_register(const char *name)
 566 {
 567         struct class_compat *cls;
 568
 569         cls = kmalloc(sizeof(struct class_compat), GFP_KERNEL);
 570         if (!cls)
 571                 return NULL;
 572         cls->kobj = kobject_create_and_add(name, &class_kset->kobj);
 573         if (!cls->kobj) {
 574                 kfree(cls);
 575                 return NULL;
 576         }
 577         return cls;
 578 }
 579 EXPORT_SYMBOL_GPL(class_compat_register);
 580
 581 /**
 582  * class_compat_unregister - unregister a compatibility class
 583  * @cls: the class to unregister
 584  */
 585 void class_compat_unregister(struct class_compat *cls)
 586 {
 587         kobject_put(cls->kobj);
 588         kfree(cls);
 589 }
 590 EXPORT_SYMBOL_GPL(class_compat_unregister);
 591
 592 /**
 593  * class_compat_create_link - create a compatibility class device link to
 594  *                            a bus device
 595  * @cls: the compatibility class
 596  * @dev: the target bus device
 597  * @device_link: an optional device to which a "device" link should be created
 598  */
 599 int class_compat_create_link(struct class_compat *cls, struct device *dev,
 600                              struct device *device_link)
 601 {
 602         int error;
 603
 604         error = sysfs_create_link(cls->kobj, &dev->kobj, dev_name(dev));
 605         if (error)
 606                 return error;
 607
 608         /*
 609          * Optionally add a "device" link (typically to the parent), as a
 610          * class device would have one and we want to provide as much
 611          * backwards compatibility as possible.
 612          */
 613         if (device_link) {
 614                 error = sysfs_create_link(&dev->kobj, &device_link->kobj,
 615                                           "device");
 616                 if (error)
 617                         sysfs_remove_link(cls->kobj, dev_name(dev));
 618         }
 619
 620         return error;
 621 }
 622 EXPORT_SYMBOL_GPL(class_compat_create_link);
 623
 624 /**
 625  * class_compat_remove_link - remove a compatibility class device link to
 626  *                            a bus device
 627  * @cls: the compatibility class
 628  * @dev: the target bus device
 629  * @device_link: an optional device to which a "device" link was previously
 630  *               created
 631  */
 632 void class_compat_remove_link(struct class_compat *cls, struct device *dev,
 633                               struct device *device_link)
 634 {
 635         if (device_link)
 636                 sysfs_remove_link(&dev->kobj, "device");
 637         sysfs_remove_link(cls->kobj, dev_name(dev));
 638 }
 639 EXPORT_SYMBOL_GPL(class_compat_remove_link);
 640
 641 /**
 642  * class_is_registered - determine if at this moment in time, a class is
 643  *                       registered in the driver core or not.
 644  * @class: the class to check
 645  *
 646  * Returns a boolean to state if the class is registered in the driver core
 647  * or not.  Note that the value could switch right after this call is made,
 648  * so only use this in places where you "know" it is safe to do so (usually
 649  * to determine if the specific class has been registered yet or not).
 650  *
 651  * Be careful in using this.
 652  */
 653 bool class_is_registered(const struct class *class)
 654 {
 655         struct subsys_private *sp = class_to_subsys(class);
 656         bool is_initialized = false;
 657
 658         if (sp) {
 659                 is_initialized = true;
 660                 subsys_put(sp);
 661         }
 662         return is_initialized;
 663 }
 664 EXPORT_SYMBOL_GPL(class_is_registered);
 665
 666 int __init classes_init(void)
 667 {
 668         class_kset = kset_create_and_add("class", NULL, NULL);
 669         if (!class_kset)
 670                 return -ENOMEM;
 671         return 0;
 672 }