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