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