drivers/base/class.c

   1 /*
   2  * class.c - basic device class management
   3  *
   4  * Copyright (c) 2002-3 Patrick Mochel
   5  * Copyright (c) 2002-3 Open Source Development Labs
   6  * Copyright (c) 2003-2004 Greg Kroah-Hartman
   7  * Copyright (c) 2003-2004 IBM Corp.
   8  *
   9  * This file is released under the GPLv2
  10  *
  11  */
  12
  13 #include <linux/device.h>
  14 #include <linux/module.h>
  15 #include <linux/init.h>
  16 #include <linux/string.h>
  17 #include <linux/kdev_t.h>
  18 #include <linux/err.h>
  19 #include <linux/slab.h>
  20 #include <linux/genhd.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 class_private *cp = to_class(kobj);
  30         ssize_t ret = -EIO;
  31
  32         if (class_attr->show)
  33                 ret = class_attr->show(cp->class, 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 class_private *cp = to_class(kobj);
  42         ssize_t ret = -EIO;
  43
  44         if (class_attr->store)
  45                 ret = class_attr->store(cp->class, buf, count);
  46         return ret;
  47 }
  48
  49 static void class_release(struct kobject *kobj)
  50 {
  51         struct class_private *cp = to_class(kobj);
  52         struct class *class = cp->class;
  53
  54         pr_debug("class '%s': release.\n", class->name);
  55
  56         if (class->class_release)
  57                 class->class_release(class);
  58         else
  59                 pr_debug("class '%s' does not have a release() function, "
  60                          "be careful\n", class->name);
  61 }
  62
  63 static struct sysfs_ops class_sysfs_ops = {
  64         .show   = class_attr_show,
  65         .store  = class_attr_store,
  66 };
  67
  68 static struct kobj_type class_ktype = {
  69         .sysfs_ops      = &class_sysfs_ops,
  70         .release        = class_release,
  71 };
  72
  73 /* Hotplug events for classes go to the class class_subsys */
  74 static struct kset *class_kset;
  75
  76
  77 int class_create_file(struct class *cls, const struct class_attribute *attr)
  78 {
  79         int error;
  80         if (cls)
  81                 error = sysfs_create_file(&cls->p->class_subsys.kobj,
  82                                           &attr->attr);
  83         else
  84                 error = -EINVAL;
  85         return error;
  86 }
  87
  88 void class_remove_file(struct class *cls, const struct class_attribute *attr)
  89 {
  90         if (cls)
  91                 sysfs_remove_file(&cls->p->class_subsys.kobj, &attr->attr);
  92 }
  93
  94 static struct class *class_get(struct class *cls)
  95 {
  96         if (cls)
  97                 kset_get(&cls->p->class_subsys);
  98         return cls;
  99 }
 100
 101 static void class_put(struct class *cls)
 102 {
 103         if (cls)
 104                 kset_put(&cls->p->class_subsys);
 105 }
 106
 107 static int add_class_attrs(struct class *cls)
 108 {
 109         int i;
 110         int error = 0;
 111
 112         if (cls->class_attrs) {
 113                 for (i = 0; attr_name(cls->class_attrs[i]); i++) {
 114                         error = class_create_file(cls, &cls->class_attrs[i]);
 115                         if (error)
 116                                 goto error;
 117                 }
 118         }
 119 done:
 120         return error;
 121 error:
 122         while (--i >= 0)
 123                 class_remove_file(cls, &cls->class_attrs[i]);
 124         goto done;
 125 }
 126
 127 static void remove_class_attrs(struct class *cls)
 128 {
 129         int i;
 130
 131         if (cls->class_attrs) {
 132                 for (i = 0; attr_name(cls->class_attrs[i]); i++)
 133                         class_remove_file(cls, &cls->class_attrs[i]);
 134         }
 135 }
 136
 137 int __class_register(struct class *cls, struct lock_class_key *key)
 138 {
 139         struct class_private *cp;
 140         int error;
 141
 142         pr_debug("device class '%s': registering\n", cls->name);
 143
 144         cp = kzalloc(sizeof(*cp), GFP_KERNEL);
 145         if (!cp)
 146                 return -ENOMEM;
 147         INIT_LIST_HEAD(&cp->class_devices);
 148         INIT_LIST_HEAD(&cp->class_interfaces);
 149         kset_init(&cp->class_dirs);
 150         init_MUTEX(&cp->class_sem);
 151         error = kobject_set_name(&cp->class_subsys.kobj, "%s", cls->name);
 152         if (error) {
 153                 kfree(cp);
 154                 return error;
 155         }
 156
 157         /* set the default /sys/dev directory for devices of this class */
 158         if (!cls->dev_kobj)
 159                 cls->dev_kobj = sysfs_dev_char_kobj;
 160
 161 #if defined(CONFIG_SYSFS_DEPRECATED) && defined(CONFIG_BLOCK)
 162         /* let the block class directory show up in the root of sysfs */
 163         if (cls != &block_class)
 164                 cp->class_subsys.kobj.kset = class_kset;
 165 #else
 166         cp->class_subsys.kobj.kset = class_kset;
 167 #endif
 168         cp->class_subsys.kobj.ktype = &class_ktype;
 169         cp->class = cls;
 170         cls->p = cp;
 171
 172         error = kset_register(&cp->class_subsys);
 173         if (error) {
 174                 kfree(cp);
 175                 return error;
 176         }
 177         error = add_class_attrs(class_get(cls));
 178         class_put(cls);
 179         return error;
 180 }
 181 EXPORT_SYMBOL_GPL(__class_register);
 182
 183 void class_unregister(struct class *cls)
 184 {
 185         pr_debug("device class '%s': unregistering\n", cls->name);
 186         remove_class_attrs(cls);
 187         kset_unregister(&cls->p->class_subsys);
 188 }
 189
 190 static void class_create_release(struct class *cls)
 191 {
 192         pr_debug("%s called for %s\n", __func__, cls->name);
 193         kfree(cls);
 194 }
 195
 196 /**
 197  * class_create - create a struct class structure
 198  * @owner: pointer to the module that is to "own" this struct class
 199  * @name: pointer to a string for the name of this class.
 200  *
 201  * This is used to create a struct class pointer that can then be used
 202  * in calls to device_create().
 203  *
 204  * Note, the pointer created here is to be destroyed when finished by
 205  * making a call to class_destroy().
 206  */
 207 struct class *__class_create(struct module *owner, const char *name,
 208                              struct lock_class_key *key)
 209 {
 210         struct class *cls;
 211         int retval;
 212
 213         cls = kzalloc(sizeof(*cls), GFP_KERNEL);
 214         if (!cls) {
 215                 retval = -ENOMEM;
 216                 goto error;
 217         }
 218
 219         cls->name = name;
 220         cls->owner = owner;
 221         cls->class_release = class_create_release;
 222
 223         retval = __class_register(cls, key);
 224         if (retval)
 225                 goto error;
 226
 227         return cls;
 228
 229 error:
 230         kfree(cls);
 231         return ERR_PTR(retval);
 232 }
 233 EXPORT_SYMBOL_GPL(__class_create);
 234
 235 /**
 236  * class_destroy - destroys a struct class structure
 237  * @cls: pointer to the struct class that is to be destroyed
 238  *
 239  * Note, the pointer to be destroyed must have been created with a call
 240  * to class_create().
 241  */
 242 void class_destroy(struct class *cls)
 243 {
 244         if ((cls == NULL) || (IS_ERR(cls)))
 245                 return;
 246
 247         class_unregister(cls);
 248 }
 249
 250 #ifdef CONFIG_SYSFS_DEPRECATED
 251 char *make_class_name(const char *name, struct kobject *kobj)
 252 {
 253         char *class_name;
 254         int size;
 255
 256         size = strlen(name) + strlen(kobject_name(kobj)) + 2;
 257
 258         class_name = kmalloc(size, GFP_KERNEL);
 259         if (!class_name)
 260                 return NULL;
 261
 262         strcpy(class_name, name);
 263         strcat(class_name, ":");
 264         strcat(class_name, kobject_name(kobj));
 265         return class_name;
 266 }
 267 #endif
 268
 269 /**
 270  * class_for_each_device - device iterator
 271  * @class: the class we're iterating
 272  * @start: the device to start with in the list, if any.
 273  * @data: data for the callback
 274  * @fn: function to be called for each device
 275  *
 276  * Iterate over @class's list of devices, and call @fn for each,
 277  * passing it @data.  If @start is set, the list iteration will start
 278  * there, otherwise if it is NULL, the iteration starts at the
 279  * beginning of the list.
 280  *
 281  * We check the return of @fn each time. If it returns anything
 282  * other than 0, we break out and return that value.
 283  *
 284  * Note, we hold class->class_sem in this function, so it can not be
 285  * re-acquired in @fn, otherwise it will self-deadlocking. For
 286  * example, calls to add or remove class members would be verboten.
 287  */
 288 int class_for_each_device(struct class *class, struct device *start,
 289                           void *data, int (*fn)(struct device *, void *))
 290 {
 291         struct device *dev;
 292         int error = 0;
 293
 294         if (!class)
 295                 return -EINVAL;
 296         down(&class->p->class_sem);
 297         list_for_each_entry(dev, &class->p->class_devices, node) {
 298                 if (start) {
 299                         if (start == dev)
 300                                 start = NULL;
 301                         continue;
 302                 }
 303                 dev = get_device(dev);
 304                 error = fn(dev, data);
 305                 put_device(dev);
 306                 if (error)
 307                         break;
 308         }
 309         up(&class->p->class_sem);
 310
 311         return error;
 312 }
 313 EXPORT_SYMBOL_GPL(class_for_each_device);
 314
 315 /**
 316  * class_find_device - device iterator for locating a particular device
 317  * @class: the class we're iterating
 318  * @start: Device to begin with
 319  * @data: data for the match function
 320  * @match: function to check device
 321  *
 322  * This is similar to the class_for_each_dev() function above, but it
 323  * returns a reference to a device that is 'found' for later use, as
 324  * determined by the @match callback.
 325  *
 326  * The callback should return 0 if the device doesn't match and non-zero
 327  * if it does.  If the callback returns non-zero, this function will
 328  * return to the caller and not iterate over any more devices.
 329  *
 330  * Note, you will need to drop the reference with put_device() after use.
 331  *
 332  * We hold class->class_sem in this function, so it can not be
 333  * re-acquired in @match, otherwise it will self-deadlocking. For
 334  * example, calls to add or remove class members would be verboten.
 335  */
 336 struct device *class_find_device(struct class *class, struct device *start,
 337                                  void *data,
 338                                  int (*match)(struct device *, void *))
 339 {
 340         struct device *dev;
 341         int found = 0;
 342
 343         if (!class)
 344                 return NULL;
 345
 346         down(&class->p->class_sem);
 347         list_for_each_entry(dev, &class->p->class_devices, node) {
 348                 if (start) {
 349                         if (start == dev)
 350                                 start = NULL;
 351                         continue;
 352                 }
 353                 dev = get_device(dev);
 354                 if (match(dev, data)) {
 355                         found = 1;
 356                         break;
 357                 } else
 358                         put_device(dev);
 359         }
 360         up(&class->p->class_sem);
 361
 362         return found ? dev : NULL;
 363 }
 364 EXPORT_SYMBOL_GPL(class_find_device);
 365
 366 int class_interface_register(struct class_interface *class_intf)
 367 {
 368         struct class *parent;
 369         struct device *dev;
 370
 371         if (!class_intf || !class_intf->class)
 372                 return -ENODEV;
 373
 374         parent = class_get(class_intf->class);
 375         if (!parent)
 376                 return -EINVAL;
 377
 378         down(&parent->p->class_sem);
 379         list_add_tail(&class_intf->node, &parent->p->class_interfaces);
 380         if (class_intf->add_dev) {
 381                 list_for_each_entry(dev, &parent->p->class_devices, node)
 382                         class_intf->add_dev(dev, class_intf);
 383         }
 384         up(&parent->p->class_sem);
 385
 386         return 0;
 387 }
 388
 389 void class_interface_unregister(struct class_interface *class_intf)
 390 {
 391         struct class *parent = class_intf->class;
 392         struct device *dev;
 393
 394         if (!parent)
 395                 return;
 396
 397         down(&parent->p->class_sem);
 398         list_del_init(&class_intf->node);
 399         if (class_intf->remove_dev) {
 400                 list_for_each_entry(dev, &parent->p->class_devices, node)
 401                         class_intf->remove_dev(dev, class_intf);
 402         }
 403         up(&parent->p->class_sem);
 404
 405         class_put(parent);
 406 }
 407
 408 int __init classes_init(void)
 409 {
 410         class_kset = kset_create_and_add("class", NULL, NULL);
 411         if (!class_kset)
 412                 return -ENOMEM;
 413         return 0;
 414 }
 415
 416 EXPORT_SYMBOL_GPL(class_create_file);
 417 EXPORT_SYMBOL_GPL(class_remove_file);
 418 EXPORT_SYMBOL_GPL(class_unregister);
 419 EXPORT_SYMBOL_GPL(class_destroy);
 420
 421 EXPORT_SYMBOL_GPL(class_interface_register);
 422 EXPORT_SYMBOL_GPL(class_interface_unregister);