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