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 #define to_class(obj) container_of(obj, struct class, subsys.kobj)
  25
  26 static ssize_t class_attr_show(struct kobject *kobj, struct attribute *attr,
  27                                char *buf)
  28 {
  29         struct class_attribute *class_attr = to_class_attr(attr);
  30         struct class *dc = to_class(kobj);
  31         ssize_t ret = -EIO;
  32
  33         if (class_attr->show)
  34                 ret = class_attr->show(dc, buf);
  35         return ret;
  36 }
  37
  38 static ssize_t class_attr_store(struct kobject *kobj, struct attribute *attr,
  39                                 const char *buf, size_t count)
  40 {
  41         struct class_attribute *class_attr = to_class_attr(attr);
  42         struct class *dc = to_class(kobj);
  43         ssize_t ret = -EIO;
  44
  45         if (class_attr->store)
  46                 ret = class_attr->store(dc, buf, count);
  47         return ret;
  48 }
  49
  50 static void class_release(struct kobject *kobj)
  51 {
  52         struct class *class = to_class(kobj);
  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_obj 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->subsys.kobj, &attr->attr);
  82         else
  83                 error = -EINVAL;
  84         return error;
  85 }
  86
  87 void class_remove_file(struct class *cls, const struct class_attribute *attr)
  88 {
  89         if (cls)
  90                 sysfs_remove_file(&cls->subsys.kobj, &attr->attr);
  91 }
  92
  93 static struct class *class_get(struct class *cls)
  94 {
  95         if (cls)
  96                 return container_of(kset_get(&cls->subsys),
  97                                     struct class, subsys);
  98         return NULL;
  99 }
 100
 101 static void class_put(struct class *cls)
 102 {
 103         if (cls)
 104                 kset_put(&cls->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)
 138 {
 139         int error;
 140
 141         pr_debug("device class '%s': registering\n", cls->name);
 142
 143         INIT_LIST_HEAD(&cls->children);
 144         INIT_LIST_HEAD(&cls->devices);
 145         INIT_LIST_HEAD(&cls->interfaces);
 146         kset_init(&cls->class_dirs);
 147         init_MUTEX(&cls->sem);
 148         error = kobject_set_name(&cls->subsys.kobj, "%s", cls->name);
 149         if (error)
 150                 return error;
 151
 152 #if defined(CONFIG_SYSFS_DEPRECATED) && defined(CONFIG_BLOCK)
 153         /* let the block class directory show up in the root of sysfs */
 154         if (cls != &block_class)
 155                 cls->subsys.kobj.kset = class_kset;
 156 #else
 157         cls->subsys.kobj.kset = class_kset;
 158 #endif
 159         cls->subsys.kobj.ktype = &class_ktype;
 160
 161         error = kset_register(&cls->subsys);
 162         if (!error) {
 163                 error = add_class_attrs(class_get(cls));
 164                 class_put(cls);
 165         }
 166         return error;
 167 }
 168
 169 void class_unregister(struct class *cls)
 170 {
 171         pr_debug("device class '%s': unregistering\n", cls->name);
 172         remove_class_attrs(cls);
 173         kset_unregister(&cls->subsys);
 174 }
 175
 176 static void class_create_release(struct class *cls)
 177 {
 178         pr_debug("%s called for %s\n", __func__, cls->name);
 179         kfree(cls);
 180 }
 181
 182 /**
 183  * class_create - create a struct class structure
 184  * @owner: pointer to the module that is to "own" this struct class
 185  * @name: pointer to a string for the name of this class.
 186  *
 187  * This is used to create a struct class pointer that can then be used
 188  * in calls to device_create().
 189  *
 190  * Note, the pointer created here is to be destroyed when finished by
 191  * making a call to class_destroy().
 192  */
 193 struct class *class_create(struct module *owner, const char *name)
 194 {
 195         struct class *cls;
 196         int retval;
 197
 198         cls = kzalloc(sizeof(*cls), GFP_KERNEL);
 199         if (!cls) {
 200                 retval = -ENOMEM;
 201                 goto error;
 202         }
 203
 204         cls->name = name;
 205         cls->owner = owner;
 206         cls->class_release = class_create_release;
 207
 208         retval = class_register(cls);
 209         if (retval)
 210                 goto error;
 211
 212         return cls;
 213
 214 error:
 215         kfree(cls);
 216         return ERR_PTR(retval);
 217 }
 218
 219 /**
 220  * class_destroy - destroys a struct class structure
 221  * @cls: pointer to the struct class that is to be destroyed
 222  *
 223  * Note, the pointer to be destroyed must have been created with a call
 224  * to class_create().
 225  */
 226 void class_destroy(struct class *cls)
 227 {
 228         if ((cls == NULL) || (IS_ERR(cls)))
 229                 return;
 230
 231         class_unregister(cls);
 232 }
 233
 234 #ifdef CONFIG_SYSFS_DEPRECATED
 235 char *make_class_name(const char *name, struct kobject *kobj)
 236 {
 237         char *class_name;
 238         int size;
 239
 240         size = strlen(name) + strlen(kobject_name(kobj)) + 2;
 241
 242         class_name = kmalloc(size, GFP_KERNEL);
 243         if (!class_name)
 244                 return NULL;
 245
 246         strcpy(class_name, name);
 247         strcat(class_name, ":");
 248         strcat(class_name, kobject_name(kobj));
 249         return class_name;
 250 }
 251 #endif
 252
 253 /**
 254  * class_for_each_device - device iterator
 255  * @class: the class we're iterating
 256  * @data: data for the callback
 257  * @fn: function to be called for each device
 258  *
 259  * Iterate over @class's list of devices, and call @fn for each,
 260  * passing it @data.
 261  *
 262  * We check the return of @fn each time. If it returns anything
 263  * other than 0, we break out and return that value.
 264  *
 265  * Note, we hold class->sem in this function, so it can not be
 266  * re-acquired in @fn, otherwise it will self-deadlocking. For
 267  * example, calls to add or remove class members would be verboten.
 268  */
 269 int class_for_each_device(struct class *class, void *data,
 270                            int (*fn)(struct device *, void *))
 271 {
 272         struct device *dev;
 273         int error = 0;
 274
 275         if (!class)
 276                 return -EINVAL;
 277         down(&class->sem);
 278         list_for_each_entry(dev, &class->devices, node) {
 279                 dev = get_device(dev);
 280                 if (dev) {
 281                         error = fn(dev, data);
 282                         put_device(dev);
 283                 } else
 284                         error = -ENODEV;
 285                 if (error)
 286                         break;
 287         }
 288         up(&class->sem);
 289
 290         return error;
 291 }
 292 EXPORT_SYMBOL_GPL(class_for_each_device);
 293
 294 /**
 295  * class_find_device - device iterator for locating a particular device
 296  * @class: the class we're iterating
 297  * @data: data for the match function
 298  * @match: function to check device
 299  *
 300  * This is similar to the class_for_each_dev() function above, but it
 301  * returns a reference to a device that is 'found' for later use, as
 302  * determined by the @match callback.
 303  *
 304  * The callback should return 0 if the device doesn't match and non-zero
 305  * if it does.  If the callback returns non-zero, this function will
 306  * return to the caller and not iterate over any more devices.
 307  *
 308  * Note, you will need to drop the reference with put_device() after use.
 309  *
 310  * We hold class->sem in this function, so it can not be
 311  * re-acquired in @match, otherwise it will self-deadlocking. For
 312  * example, calls to add or remove class members would be verboten.
 313  */
 314 struct device *class_find_device(struct class *class, void *data,
 315                                    int (*match)(struct device *, void *))
 316 {
 317         struct device *dev;
 318         int found = 0;
 319
 320         if (!class)
 321                 return NULL;
 322
 323         down(&class->sem);
 324         list_for_each_entry(dev, &class->devices, node) {
 325                 dev = get_device(dev);
 326                 if (dev) {
 327                         if (match(dev, data)) {
 328                                 found = 1;
 329                                 break;
 330                         } else
 331                                 put_device(dev);
 332                 } else
 333                         break;
 334         }
 335         up(&class->sem);
 336
 337         return found ? dev : NULL;
 338 }
 339 EXPORT_SYMBOL_GPL(class_find_device);
 340
 341 int class_interface_register(struct class_interface *class_intf)
 342 {
 343         struct class *parent;
 344         struct device *dev;
 345
 346         if (!class_intf || !class_intf->class)
 347                 return -ENODEV;
 348
 349         parent = class_get(class_intf->class);
 350         if (!parent)
 351                 return -EINVAL;
 352
 353         down(&parent->sem);
 354         list_add_tail(&class_intf->node, &parent->interfaces);
 355         if (class_intf->add_dev) {
 356                 list_for_each_entry(dev, &parent->devices, node)
 357                         class_intf->add_dev(dev, class_intf);
 358         }
 359         up(&parent->sem);
 360
 361         return 0;
 362 }
 363
 364 void class_interface_unregister(struct class_interface *class_intf)
 365 {
 366         struct class *parent = class_intf->class;
 367         struct device *dev;
 368
 369         if (!parent)
 370                 return;
 371
 372         down(&parent->sem);
 373         list_del_init(&class_intf->node);
 374         if (class_intf->remove_dev) {
 375                 list_for_each_entry(dev, &parent->devices, node)
 376                         class_intf->remove_dev(dev, class_intf);
 377         }
 378         up(&parent->sem);
 379
 380         class_put(parent);
 381 }
 382
 383 int __init classes_init(void)
 384 {
 385         class_kset = kset_create_and_add("class", NULL, NULL);
 386         if (!class_kset)
 387                 return -ENOMEM;
 388         return 0;
 389 }
 390
 391 EXPORT_SYMBOL_GPL(class_create_file);
 392 EXPORT_SYMBOL_GPL(class_remove_file);
 393 EXPORT_SYMBOL_GPL(class_register);
 394 EXPORT_SYMBOL_GPL(class_unregister);
 395 EXPORT_SYMBOL_GPL(class_create);
 396 EXPORT_SYMBOL_GPL(class_destroy);
 397
 398 EXPORT_SYMBOL_GPL(class_interface_register);
 399 EXPORT_SYMBOL_GPL(class_interface_unregister);