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