blob: 9f737ff0fc71f46d0bdade7c2a2caf90120515f5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#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>
gregkh@suse.dee9ba6362005-03-15 11:54:21 -080018#include <linux/err.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080019#include <linux/slab.h>
Kay Sieversedfaa7c2007-05-21 22:08:01 +020020#include <linux/genhd.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include "base.h"
22
23#define to_class_attr(_attr) container_of(_attr, struct class_attribute, attr)
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -070024#define to_class(obj) container_of(obj, struct class, subsys.kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26static ssize_t
27class_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
28{
29 struct class_attribute * class_attr = to_class_attr(attr);
30 struct class * dc = to_class(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050031 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
33 if (class_attr->show)
34 ret = class_attr->show(dc, buf);
35 return ret;
36}
37
38static ssize_t
39class_attr_store(struct kobject * kobj, struct attribute * attr,
40 const char * buf, size_t count)
41{
42 struct class_attribute * class_attr = to_class_attr(attr);
43 struct class * dc = to_class(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050044 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46 if (class_attr->store)
47 ret = class_attr->store(dc, buf, count);
48 return ret;
49}
50
51static void class_release(struct kobject * kobj)
52{
53 struct class *class = to_class(kobj);
54
55 pr_debug("class '%s': release.\n", class->name);
56
57 if (class->class_release)
58 class->class_release(class);
59 else
60 pr_debug("class '%s' does not have a release() function, "
61 "be careful\n", class->name);
62}
63
64static struct sysfs_ops class_sysfs_ops = {
65 .show = class_attr_show,
66 .store = class_attr_store,
67};
68
Greg Kroah-Hartmanadc56802007-10-11 10:47:49 -060069static struct kobj_type class_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 .sysfs_ops = &class_sysfs_ops,
71 .release = class_release,
72};
73
74/* Hotplug events for classes go to the class_obj subsys */
Greg Kroah-Hartman443dbf92007-10-29 23:22:26 -050075static struct kset *class_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77
78int class_create_file(struct class * cls, const struct class_attribute * attr)
79{
80 int error;
81 if (cls) {
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -070082 error = sysfs_create_file(&cls->subsys.kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 } else
84 error = -EINVAL;
85 return error;
86}
87
88void class_remove_file(struct class * cls, const struct class_attribute * attr)
89{
90 if (cls)
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -070091 sysfs_remove_file(&cls->subsys.kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092}
93
Greg Kroah-Hartman17407572006-05-02 16:59:59 +020094static struct class *class_get(struct class *cls)
Linus Torvalds1da177e2005-04-16 15:20:36 -070095{
96 if (cls)
Greg Kroah-Hartman1ef4cfa2007-09-12 15:06:57 -070097 return container_of(kset_get(&cls->subsys), struct class, subsys);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 return NULL;
99}
100
Greg Kroah-Hartman17407572006-05-02 16:59:59 +0200101static void class_put(struct class * cls)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102{
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700103 if (cls)
Greg Kroah-Hartman6e9d9302007-09-12 15:06:57 -0700104 kset_put(&cls->subsys);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105}
106
107
108static int add_class_attrs(struct class * cls)
109{
110 int i;
111 int error = 0;
112
113 if (cls->class_attrs) {
114 for (i = 0; attr_name(cls->class_attrs[i]); i++) {
115 error = class_create_file(cls,&cls->class_attrs[i]);
116 if (error)
117 goto Err;
118 }
119 }
120 Done:
121 return error;
122 Err:
123 while (--i >= 0)
124 class_remove_file(cls,&cls->class_attrs[i]);
125 goto Done;
126}
127
128static void remove_class_attrs(struct class * cls)
129{
130 int i;
131
132 if (cls->class_attrs) {
133 for (i = 0; attr_name(cls->class_attrs[i]); i++)
134 class_remove_file(cls,&cls->class_attrs[i]);
135 }
136}
137
138int class_register(struct class * cls)
139{
140 int error;
141
142 pr_debug("device class '%s': registering\n", cls->name);
143
144 INIT_LIST_HEAD(&cls->children);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700145 INIT_LIST_HEAD(&cls->devices);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 INIT_LIST_HEAD(&cls->interfaces);
Kay Sievers86406242007-03-14 03:25:56 +0100147 kset_init(&cls->class_dirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 init_MUTEX(&cls->sem);
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700149 error = kobject_set_name(&cls->subsys.kobj, "%s", cls->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 if (error)
151 return error;
152
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200153#ifdef CONFIG_SYSFS_DEPRECATED
154 /* let the block class directory show up in the root of sysfs */
155 if (cls != &block_class)
156 cls->subsys.kobj.kset = class_kset;
157#else
Greg Kroah-Hartman443dbf92007-10-29 23:22:26 -0500158 cls->subsys.kobj.kset = class_kset;
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200159#endif
Greg Kroah-Hartman3514fac2007-10-16 10:11:44 -0600160 cls->subsys.kobj.ktype = &class_ktype;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Greg Kroah-Hartman2fb91132007-11-06 15:03:30 -0800162 error = kset_register(&cls->subsys);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 if (!error) {
164 error = add_class_attrs(class_get(cls));
165 class_put(cls);
166 }
167 return error;
168}
169
170void class_unregister(struct class * cls)
171{
172 pr_debug("device class '%s': unregistering\n", cls->name);
173 remove_class_attrs(cls);
Greg Kroah-Hartman2fb91132007-11-06 15:03:30 -0800174 kset_unregister(&cls->subsys);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175}
176
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800177static void class_create_release(struct class *cls)
178{
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700179 pr_debug("%s called for %s\n", __FUNCTION__, cls->name);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800180 kfree(cls);
181}
182
183static void class_device_create_release(struct class_device *class_dev)
184{
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700185 pr_debug("%s called for %s\n", __FUNCTION__, class_dev->class_id);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800186 kfree(class_dev);
187}
188
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700189/* needed to allow these devices to have parent class devices */
Kay Sievers312c0042005-11-16 09:00:00 +0100190static int class_device_create_uevent(struct class_device *class_dev,
Kay Sievers7eff2e72007-08-14 15:15:12 +0200191 struct kobj_uevent_env *env)
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700192{
193 pr_debug("%s called for %s\n", __FUNCTION__, class_dev->class_id);
194 return 0;
195}
196
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800197/**
198 * class_create - create a struct class structure
199 * @owner: pointer to the module that is to "own" this struct class
200 * @name: pointer to a string for the name of this class.
201 *
202 * This is used to create a struct class pointer that can then be used
203 * in calls to class_device_create().
204 *
205 * Note, the pointer created here is to be destroyed when finished by
206 * making a call to class_destroy().
207 */
Miguel Ojeda Sandonisab7d7372006-09-13 15:34:05 +0200208struct class *class_create(struct module *owner, const char *name)
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800209{
210 struct class *cls;
211 int retval;
212
Jiri Slaby4aed0642005-09-13 01:25:01 -0700213 cls = kzalloc(sizeof(*cls), GFP_KERNEL);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800214 if (!cls) {
215 retval = -ENOMEM;
216 goto error;
217 }
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800218
219 cls->name = name;
220 cls->owner = owner;
221 cls->class_release = class_create_release;
222 cls->release = class_device_create_release;
223
224 retval = class_register(cls);
225 if (retval)
226 goto error;
227
228 return cls;
229
230error:
231 kfree(cls);
232 return ERR_PTR(retval);
233}
234
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800235/**
236 * class_destroy - destroys a struct class structure
Rolf Eike Beer92a0f862006-09-29 01:59:13 -0700237 * @cls: pointer to the struct class that is to be destroyed
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800238 *
239 * Note, the pointer to be destroyed must have been created with a call
240 * to class_create().
241 */
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800242void class_destroy(struct class *cls)
243{
244 if ((cls == NULL) || (IS_ERR(cls)))
245 return;
246
247 class_unregister(cls);
248}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
250/* Class Device Stuff */
251
252int class_device_create_file(struct class_device * class_dev,
253 const struct class_device_attribute * attr)
254{
255 int error = -EINVAL;
256 if (class_dev)
257 error = sysfs_create_file(&class_dev->kobj, &attr->attr);
258 return error;
259}
260
261void class_device_remove_file(struct class_device * class_dev,
262 const struct class_device_attribute * attr)
263{
264 if (class_dev)
265 sysfs_remove_file(&class_dev->kobj, &attr->attr);
266}
267
Greg Kroah-Hartmand919fd42007-10-31 12:51:29 -0700268int class_device_create_bin_file(struct class_device *class_dev,
269 struct bin_attribute *attr)
270{
271 int error = -EINVAL;
272 if (class_dev)
273 error = sysfs_create_bin_file(&class_dev->kobj, attr);
274 return error;
275}
276
277void class_device_remove_bin_file(struct class_device *class_dev,
278 struct bin_attribute *attr)
279{
280 if (class_dev)
281 sysfs_remove_bin_file(&class_dev->kobj, attr);
282}
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284static ssize_t
285class_device_attr_show(struct kobject * kobj, struct attribute * attr,
286 char * buf)
287{
288 struct class_device_attribute * class_dev_attr = to_class_dev_attr(attr);
289 struct class_device * cd = to_class_dev(kobj);
290 ssize_t ret = 0;
291
292 if (class_dev_attr->show)
293 ret = class_dev_attr->show(cd, buf);
294 return ret;
295}
296
297static ssize_t
298class_device_attr_store(struct kobject * kobj, struct attribute * attr,
299 const char * buf, size_t count)
300{
301 struct class_device_attribute * class_dev_attr = to_class_dev_attr(attr);
302 struct class_device * cd = to_class_dev(kobj);
303 ssize_t ret = 0;
304
305 if (class_dev_attr->store)
306 ret = class_dev_attr->store(cd, buf, count);
307 return ret;
308}
309
310static struct sysfs_ops class_dev_sysfs_ops = {
311 .show = class_device_attr_show,
312 .store = class_device_attr_store,
313};
314
315static void class_dev_release(struct kobject * kobj)
316{
317 struct class_device *cd = to_class_dev(kobj);
318 struct class * cls = cd->class;
319
320 pr_debug("device class '%s': release.\n", cd->class_id);
321
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700322 if (cd->release)
323 cd->release(cd);
324 else if (cls->release)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 cls->release(cd);
326 else {
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700327 printk(KERN_ERR "Class Device '%s' does not have a release() function, "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 "it is broken and must be fixed.\n",
329 cd->class_id);
330 WARN_ON(1);
331 }
332}
333
Greg Kroah-Hartmanadc56802007-10-11 10:47:49 -0600334static struct kobj_type class_device_ktype = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 .sysfs_ops = &class_dev_sysfs_ops,
336 .release = class_dev_release,
337};
338
Kay Sievers312c0042005-11-16 09:00:00 +0100339static int class_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340{
341 struct kobj_type *ktype = get_ktype(kobj);
342
Greg Kroah-Hartmanadc56802007-10-11 10:47:49 -0600343 if (ktype == &class_device_ktype) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 struct class_device *class_dev = to_class_dev(kobj);
345 if (class_dev->class)
346 return 1;
347 }
348 return 0;
349}
350
Kay Sievers312c0042005-11-16 09:00:00 +0100351static const char *class_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352{
353 struct class_device *class_dev = to_class_dev(kobj);
354
355 return class_dev->class->name;
356}
357
Kay Sievers805fab42006-09-14 11:23:28 +0200358#ifdef CONFIG_SYSFS_DEPRECATED
359char *make_class_name(const char *name, struct kobject *kobj)
360{
361 char *class_name;
362 int size;
363
364 size = strlen(name) + strlen(kobject_name(kobj)) + 2;
365
366 class_name = kmalloc(size, GFP_KERNEL);
367 if (!class_name)
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100368 return NULL;
Kay Sievers805fab42006-09-14 11:23:28 +0200369
370 strcpy(class_name, name);
371 strcat(class_name, ":");
372 strcat(class_name, kobject_name(kobj));
373 return class_name;
374}
375
Kay Sievers805fab42006-09-14 11:23:28 +0200376static int make_deprecated_class_device_links(struct class_device *class_dev)
377{
378 char *class_name;
379 int error;
380
381 if (!class_dev->dev)
382 return 0;
383
384 class_name = make_class_name(class_dev->class->name, &class_dev->kobj);
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100385 if (class_name)
386 error = sysfs_create_link(&class_dev->dev->kobj,
387 &class_dev->kobj, class_name);
388 else
389 error = -ENOMEM;
Kay Sievers805fab42006-09-14 11:23:28 +0200390 kfree(class_name);
391 return error;
392}
393
394static void remove_deprecated_class_device_links(struct class_device *class_dev)
395{
396 char *class_name;
397
398 if (!class_dev->dev)
399 return;
400
401 class_name = make_class_name(class_dev->class->name, &class_dev->kobj);
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100402 if (class_name)
403 sysfs_remove_link(&class_dev->dev->kobj, class_name);
Kay Sievers805fab42006-09-14 11:23:28 +0200404 kfree(class_name);
405}
406#else
Kay Sievers805fab42006-09-14 11:23:28 +0200407static inline int make_deprecated_class_device_links(struct class_device *cd)
408{ return 0; }
409static void remove_deprecated_class_device_links(struct class_device *cd)
410{ }
411#endif
412
Kay Sievers7eff2e72007-08-14 15:15:12 +0200413static int class_uevent(struct kset *kset, struct kobject *kobj,
414 struct kobj_uevent_env *env)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415{
416 struct class_device *class_dev = to_class_dev(kobj);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200417 struct device *dev = class_dev->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 int retval = 0;
419
420 pr_debug("%s - name = %s\n", __FUNCTION__, class_dev->class_id);
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 if (MAJOR(class_dev->devt)) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200423 add_uevent_var(env, "MAJOR=%u", MAJOR(class_dev->devt));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Kay Sievers7eff2e72007-08-14 15:15:12 +0200425 add_uevent_var(env, "MINOR=%u", MINOR(class_dev->devt));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 }
427
Kay Sievers2c7afd12007-05-01 13:46:26 +0200428 if (dev) {
429 const char *path = kobject_get_path(&dev->kobj, GFP_KERNEL);
430 if (path) {
Kay Sievers7eff2e72007-08-14 15:15:12 +0200431 add_uevent_var(env, "PHYSDEVPATH=%s", path);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200432 kfree(path);
433 }
434
435 if (dev->bus)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200436 add_uevent_var(env, "PHYSDEVBUS=%s", dev->bus->name);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200437
438 if (dev->driver)
Kay Sievers7eff2e72007-08-14 15:15:12 +0200439 add_uevent_var(env, "PHYSDEVDRIVER=%s", dev->driver->name);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200440 }
441
Kay Sievers312c0042005-11-16 09:00:00 +0100442 if (class_dev->uevent) {
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700443 /* have the class device specific function add its stuff */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200444 retval = class_dev->uevent(class_dev, env);
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700445 if (retval)
Kay Sievers312c0042005-11-16 09:00:00 +0100446 pr_debug("class_dev->uevent() returned %d\n", retval);
447 } else if (class_dev->class->uevent) {
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700448 /* have the class specific function add its stuff */
Kay Sievers7eff2e72007-08-14 15:15:12 +0200449 retval = class_dev->class->uevent(class_dev, env);
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700450 if (retval)
Kay Sievers312c0042005-11-16 09:00:00 +0100451 pr_debug("class->uevent() returned %d\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 }
453
454 return retval;
455}
456
Kay Sievers312c0042005-11-16 09:00:00 +0100457static struct kset_uevent_ops class_uevent_ops = {
458 .filter = class_uevent_filter,
459 .name = class_uevent_name,
460 .uevent = class_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461};
462
Greg Kroah-Hartman5c03c7a2007-11-02 16:19:59 -0700463/*
464 * DO NOT copy how this is created, kset_create_and_add() should be
465 * called, but this is a hold-over from the old-way and will be deleted
466 * entirely soon.
467 */
468static struct kset class_obj_subsys = {
Greg Kroah-Hartman5c03c7a2007-11-02 16:19:59 -0700469 .uevent_ops = &class_uevent_ops,
470};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
472static int class_device_add_attrs(struct class_device * cd)
473{
474 int i;
475 int error = 0;
476 struct class * cls = cd->class;
477
478 if (cls->class_dev_attrs) {
479 for (i = 0; attr_name(cls->class_dev_attrs[i]); i++) {
480 error = class_device_create_file(cd,
481 &cls->class_dev_attrs[i]);
482 if (error)
483 goto Err;
484 }
485 }
486 Done:
487 return error;
488 Err:
489 while (--i >= 0)
490 class_device_remove_file(cd,&cls->class_dev_attrs[i]);
491 goto Done;
492}
493
494static void class_device_remove_attrs(struct class_device * cd)
495{
496 int i;
497 struct class * cls = cd->class;
498
499 if (cls->class_dev_attrs) {
500 for (i = 0; attr_name(cls->class_dev_attrs[i]); i++)
501 class_device_remove_file(cd,&cls->class_dev_attrs[i]);
502 }
503}
504
Stephen Hemminger14982212006-05-06 17:55:11 -0700505static int class_device_add_groups(struct class_device * cd)
506{
507 int i;
508 int error = 0;
509
510 if (cd->groups) {
511 for (i = 0; cd->groups[i]; i++) {
512 error = sysfs_create_group(&cd->kobj, cd->groups[i]);
513 if (error) {
514 while (--i >= 0)
515 sysfs_remove_group(&cd->kobj, cd->groups[i]);
516 goto out;
517 }
518 }
519 }
520out:
521 return error;
522}
523
524static void class_device_remove_groups(struct class_device * cd)
525{
526 int i;
527 if (cd->groups) {
528 for (i = 0; cd->groups[i]; i++) {
529 sysfs_remove_group(&cd->kobj, cd->groups[i]);
530 }
531 }
532}
533
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534static ssize_t show_dev(struct class_device *class_dev, char *buf)
535{
536 return print_dev_t(buf, class_dev->devt);
537}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Tejun Heoad6a1e12007-06-14 03:45:17 +0900539static struct class_device_attribute class_devt_attr =
540 __ATTR(dev, S_IRUGO, show_dev, NULL);
541
Kay Sieversa7fd6702005-10-01 14:49:43 +0200542static ssize_t store_uevent(struct class_device *class_dev,
543 const char *buf, size_t count)
544{
Kay Sievers312c0042005-11-16 09:00:00 +0100545 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
Kay Sieversa7fd6702005-10-01 14:49:43 +0200546 return count;
547}
548
Tejun Heoad6a1e12007-06-14 03:45:17 +0900549static struct class_device_attribute class_uevent_attr =
550 __ATTR(uevent, S_IWUSR, NULL, store_uevent);
551
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552void class_device_initialize(struct class_device *class_dev)
553{
Greg Kroah-Hartman3514fac2007-10-16 10:11:44 -0600554 class_dev->kobj.kset = &class_obj_subsys;
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700555 kobject_init(&class_dev->kobj, &class_device_ktype);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 INIT_LIST_HEAD(&class_dev->node);
557}
558
559int class_device_add(struct class_device *class_dev)
560{
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700561 struct class *parent_class = NULL;
562 struct class_device *parent_class_dev = NULL;
563 struct class_interface *class_intf;
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700564 int error = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
566 class_dev = class_device_get(class_dev);
567 if (!class_dev)
568 return -EINVAL;
569
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700570 if (!strlen(class_dev->class_id))
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700571 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700573 parent_class = class_get(class_dev->class);
574 if (!parent_class)
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700575 goto out1;
576
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700577 parent_class_dev = class_device_get(class_dev->parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
579 pr_debug("CLASS: registering class device: ID = '%s'\n",
580 class_dev->class_id);
581
582 /* first, register with generic layer. */
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700583 if (parent_class_dev)
584 class_dev->kobj.parent = &parent_class_dev->kobj;
585 else
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700586 class_dev->kobj.parent = &parent_class->subsys.kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700588 error = kobject_add(&class_dev->kobj, class_dev->kobj.parent,
589 "%s", class_dev->class_id);
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700590 if (error)
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700591 goto out2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800593 /* add the needed attributes to this device */
Cornelia Huckf0e17612006-09-22 11:37:00 +0200594 error = sysfs_create_link(&class_dev->kobj,
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700595 &parent_class->subsys.kobj, "subsystem");
Cornelia Huckf0e17612006-09-22 11:37:00 +0200596 if (error)
597 goto out3;
Tejun Heoad6a1e12007-06-14 03:45:17 +0900598
599 error = class_device_create_file(class_dev, &class_uevent_attr);
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700600 if (error)
601 goto out3;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200602
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800603 if (MAJOR(class_dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +0900604 error = class_device_create_file(class_dev, &class_devt_attr);
605 if (error)
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700606 goto out4;
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800607 }
608
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700609 error = class_device_add_attrs(class_dev);
610 if (error)
611 goto out5;
612
Dmitry Torokhov76d1ce02005-07-10 01:21:24 -0500613 if (class_dev->dev) {
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700614 error = sysfs_create_link(&class_dev->kobj,
615 &class_dev->dev->kobj, "device");
616 if (error)
617 goto out6;
Dmitry Torokhov76d1ce02005-07-10 01:21:24 -0500618 }
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800619
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700620 error = class_device_add_groups(class_dev);
621 if (error)
Kay Sievers805fab42006-09-14 11:23:28 +0200622 goto out7;
623
624 error = make_deprecated_class_device_links(class_dev);
625 if (error)
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700626 goto out8;
Stephen Hemminger14982212006-05-06 17:55:11 -0700627
Kay Sievers312c0042005-11-16 09:00:00 +0100628 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
Dmitry Torokhovdbe90352005-09-15 02:01:37 -0500629
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800630 /* notify any interfaces this device is now here */
Jayachandran Ca1438892006-04-03 12:31:53 -0700631 down(&parent_class->sem);
632 list_add_tail(&class_dev->node, &parent_class->children);
633 list_for_each_entry(class_intf, &parent_class->interfaces, node) {
634 if (class_intf->add)
635 class_intf->add(class_dev, class_intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 }
Jayachandran Ca1438892006-04-03 12:31:53 -0700637 up(&parent_class->sem);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800638
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700639 goto out1;
640
641 out8:
Kay Sievers805fab42006-09-14 11:23:28 +0200642 class_device_remove_groups(class_dev);
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700643 out7:
644 if (class_dev->dev)
645 sysfs_remove_link(&class_dev->kobj, "device");
646 out6:
647 class_device_remove_attrs(class_dev);
648 out5:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900649 if (MAJOR(class_dev->devt))
650 class_device_remove_file(class_dev, &class_devt_attr);
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700651 out4:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900652 class_device_remove_file(class_dev, &class_uevent_attr);
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700653 out3:
654 kobject_del(&class_dev->kobj);
655 out2:
656 if(parent_class_dev)
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700657 class_device_put(parent_class_dev);
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700658 class_put(parent_class);
659 out1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 class_device_put(class_dev);
661 return error;
662}
663
664int class_device_register(struct class_device *class_dev)
665{
666 class_device_initialize(class_dev);
667 return class_device_add(class_dev);
668}
669
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800670/**
671 * class_device_create - creates a class device and registers it with sysfs
Rolf Eike Beer92a0f862006-09-29 01:59:13 -0700672 * @cls: pointer to the struct class that this device should be registered to.
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700673 * @parent: pointer to the parent struct class_device of this new device, if any.
Rolf Eike Beer92a0f862006-09-29 01:59:13 -0700674 * @devt: the dev_t for the char device to be added.
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800675 * @device: a pointer to a struct device that is assiociated with this class device.
676 * @fmt: string for the class device's name
677 *
678 * This function can be used by char device classes. A struct
679 * class_device will be created in sysfs, registered to the specified
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700680 * class.
681 * A "dev" file will be created, showing the dev_t for the device, if
682 * the dev_t is not 0,0.
683 * If a pointer to a parent struct class_device is passed in, the newly
684 * created struct class_device will be a child of that device in sysfs.
685 * The pointer to the struct class_device will be returned from the
686 * call. Any further sysfs files that might be required can be created
687 * using this pointer.
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800688 *
689 * Note: the struct class passed to this function must have previously
690 * been created with a call to class_create().
691 */
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700692struct class_device *class_device_create(struct class *cls,
693 struct class_device *parent,
694 dev_t devt,
Dmitry Torokhovddd5d352006-08-10 01:18:18 -0400695 struct device *device,
696 const char *fmt, ...)
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800697{
698 va_list args;
699 struct class_device *class_dev = NULL;
700 int retval = -ENODEV;
701
702 if (cls == NULL || IS_ERR(cls))
703 goto error;
704
Jiri Slaby4aed0642005-09-13 01:25:01 -0700705 class_dev = kzalloc(sizeof(*class_dev), GFP_KERNEL);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800706 if (!class_dev) {
707 retval = -ENOMEM;
708 goto error;
709 }
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800710
711 class_dev->devt = devt;
712 class_dev->dev = device;
713 class_dev->class = cls;
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700714 class_dev->parent = parent;
715 class_dev->release = class_device_create_release;
Kay Sievers312c0042005-11-16 09:00:00 +0100716 class_dev->uevent = class_device_create_uevent;
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800717
718 va_start(args, fmt);
719 vsnprintf(class_dev->class_id, BUS_ID_SIZE, fmt, args);
720 va_end(args);
721 retval = class_device_register(class_dev);
722 if (retval)
723 goto error;
724
725 return class_dev;
726
727error:
728 kfree(class_dev);
729 return ERR_PTR(retval);
730}
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732void class_device_del(struct class_device *class_dev)
733{
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700734 struct class *parent_class = class_dev->class;
735 struct class_device *parent_device = class_dev->parent;
736 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700738 if (parent_class) {
739 down(&parent_class->sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 list_del_init(&class_dev->node);
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700741 list_for_each_entry(class_intf, &parent_class->interfaces, node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 if (class_intf->remove)
Dmitry Torokhovd8539d82005-09-15 02:01:36 -0500743 class_intf->remove(class_dev, class_intf);
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700744 up(&parent_class->sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 }
746
Dmitry Torokhov76d1ce02005-07-10 01:21:24 -0500747 if (class_dev->dev) {
Kay Sievers805fab42006-09-14 11:23:28 +0200748 remove_deprecated_class_device_links(class_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 sysfs_remove_link(&class_dev->kobj, "device");
Dmitry Torokhov76d1ce02005-07-10 01:21:24 -0500750 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200751 sysfs_remove_link(&class_dev->kobj, "subsystem");
Tejun Heoad6a1e12007-06-14 03:45:17 +0900752 class_device_remove_file(class_dev, &class_uevent_attr);
753 if (MAJOR(class_dev->devt))
754 class_device_remove_file(class_dev, &class_devt_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 class_device_remove_attrs(class_dev);
Stephen Hemminger14982212006-05-06 17:55:11 -0700756 class_device_remove_groups(class_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
Kay Sievers312c0042005-11-16 09:00:00 +0100758 kobject_uevent(&class_dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 kobject_del(&class_dev->kobj);
760
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700761 class_device_put(parent_device);
762 class_put(parent_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763}
764
765void class_device_unregister(struct class_device *class_dev)
766{
767 pr_debug("CLASS: Unregistering class device. ID = '%s'\n",
768 class_dev->class_id);
769 class_device_del(class_dev);
770 class_device_put(class_dev);
771}
772
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800773/**
774 * class_device_destroy - removes a class device that was created with class_device_create()
775 * @cls: the pointer to the struct class that this device was registered * with.
Rolf Eike Beer92a0f862006-09-29 01:59:13 -0700776 * @devt: the dev_t of the device that was previously registered.
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800777 *
778 * This call unregisters and cleans up a class device that was created with a
779 * call to class_device_create()
780 */
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800781void class_device_destroy(struct class *cls, dev_t devt)
782{
783 struct class_device *class_dev = NULL;
784 struct class_device *class_dev_tmp;
785
786 down(&cls->sem);
787 list_for_each_entry(class_dev_tmp, &cls->children, node) {
788 if (class_dev_tmp->devt == devt) {
789 class_dev = class_dev_tmp;
790 break;
791 }
792 }
793 up(&cls->sem);
794
795 if (class_dev)
796 class_device_unregister(class_dev);
797}
798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799struct class_device * class_device_get(struct class_device *class_dev)
800{
801 if (class_dev)
802 return to_class_dev(kobject_get(&class_dev->kobj));
803 return NULL;
804}
805
806void class_device_put(struct class_device *class_dev)
807{
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700808 if (class_dev)
809 kobject_put(&class_dev->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810}
811
Dave Youngfd048972008-01-22 15:27:08 +0800812/**
813 * class_for_each_device - device iterator
814 * @class: the class we're iterating
815 * @data: data for the callback
816 * @fn: function to be called for each device
817 *
818 * Iterate over @class's list of devices, and call @fn for each,
819 * passing it @data.
820 *
821 * We check the return of @fn each time. If it returns anything
822 * other than 0, we break out and return that value.
823 *
824 * Note, we hold class->sem in this function, so it can not be
825 * re-acquired in @fn, otherwise it will self-deadlocking. For
826 * example, calls to add or remove class members would be verboten.
827 */
828int class_for_each_device(struct class *class, void *data,
829 int (*fn)(struct device *, void *))
830{
831 struct device *dev;
832 int error = 0;
833
834 if (!class)
835 return -EINVAL;
836 down(&class->sem);
837 list_for_each_entry(dev, &class->devices, node) {
838 dev = get_device(dev);
839 if (dev) {
840 error = fn(dev, data);
841 put_device(dev);
842 } else
843 error = -ENODEV;
844 if (error)
845 break;
846 }
847 up(&class->sem);
848
849 return error;
850}
851EXPORT_SYMBOL_GPL(class_for_each_device);
852
853/**
854 * class_find_device - device iterator for locating a particular device
855 * @class: the class we're iterating
856 * @data: data for the match function
857 * @match: function to check device
858 *
859 * This is similar to the class_for_each_dev() function above, but it
860 * returns a reference to a device that is 'found' for later use, as
861 * determined by the @match callback.
862 *
863 * The callback should return 0 if the device doesn't match and non-zero
864 * if it does. If the callback returns non-zero, this function will
865 * return to the caller and not iterate over any more devices.
866
867 * Note, you will need to drop the reference with put_device() after use.
868 *
869 * We hold class->sem in this function, so it can not be
870 * re-acquired in @match, otherwise it will self-deadlocking. For
871 * example, calls to add or remove class members would be verboten.
872 */
873struct device *class_find_device(struct class *class, void *data,
874 int (*match)(struct device *, void *))
875{
876 struct device *dev;
877 int found = 0;
878
879 if (!class)
880 return NULL;
881
882 down(&class->sem);
883 list_for_each_entry(dev, &class->devices, node) {
884 dev = get_device(dev);
885 if (dev) {
886 if (match(dev, data)) {
887 found = 1;
888 break;
889 } else
890 put_device(dev);
891 } else
892 break;
893 }
894 up(&class->sem);
895
896 return found ? dev : NULL;
897}
898EXPORT_SYMBOL_GPL(class_find_device);
899
900/**
901 * class_find_child - device iterator for locating a particular class_device
902 * @class: the class we're iterating
903 * @data: data for the match function
904 * @match: function to check class_device
905 *
906 * This function returns a reference to a class_device that is 'found' for
907 * later use, as determined by the @match callback.
908 *
909 * The callback should return 0 if the class_device doesn't match and non-zero
910 * if it does. If the callback returns non-zero, this function will
911 * return to the caller and not iterate over any more class_devices.
912 *
913 * Note, you will need to drop the reference with class_device_put() after use.
914 *
915 * We hold class->sem in this function, so it can not be
916 * re-acquired in @match, otherwise it will self-deadlocking. For
917 * example, calls to add or remove class members would be verboten.
918 */
919struct class_device *class_find_child(struct class *class, void *data,
920 int (*match)(struct class_device *, void *))
921{
922 struct class_device *dev;
923 int found = 0;
924
925 if (!class)
926 return NULL;
927
928 down(&class->sem);
929 list_for_each_entry(dev, &class->children, node) {
930 dev = class_device_get(dev);
931 if (dev) {
932 if (match(dev, data)) {
933 found = 1;
934 break;
935 } else
936 class_device_put(dev);
937 } else
938 break;
939 }
940 up(&class->sem);
941
942 return found ? dev : NULL;
943}
944EXPORT_SYMBOL_GPL(class_find_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945
946int class_interface_register(struct class_interface *class_intf)
947{
948 struct class *parent;
949 struct class_device *class_dev;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200950 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
952 if (!class_intf || !class_intf->class)
953 return -ENODEV;
954
955 parent = class_get(class_intf->class);
956 if (!parent)
957 return -EINVAL;
958
959 down(&parent->sem);
960 list_add_tail(&class_intf->node, &parent->interfaces);
961 if (class_intf->add) {
962 list_for_each_entry(class_dev, &parent->children, node)
Dmitry Torokhovd8539d82005-09-15 02:01:36 -0500963 class_intf->add(class_dev, class_intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 }
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200965 if (class_intf->add_dev) {
966 list_for_each_entry(dev, &parent->devices, node)
967 class_intf->add_dev(dev, class_intf);
968 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 up(&parent->sem);
970
971 return 0;
972}
973
974void class_interface_unregister(struct class_interface *class_intf)
975{
976 struct class * parent = class_intf->class;
977 struct class_device *class_dev;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200978 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
980 if (!parent)
981 return;
982
983 down(&parent->sem);
984 list_del_init(&class_intf->node);
985 if (class_intf->remove) {
986 list_for_each_entry(class_dev, &parent->children, node)
Dmitry Torokhovd8539d82005-09-15 02:01:36 -0500987 class_intf->remove(class_dev, class_intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 }
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200989 if (class_intf->remove_dev) {
990 list_for_each_entry(dev, &parent->devices, node)
991 class_intf->remove_dev(dev, class_intf);
992 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 up(&parent->sem);
994
995 class_put(parent);
996}
997
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998int __init classes_init(void)
999{
Greg Kroah-Hartman443dbf92007-10-29 23:22:26 -05001000 class_kset = kset_create_and_add("class", NULL, NULL);
1001 if (!class_kset)
1002 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003
1004 /* ick, this is ugly, the things we go through to keep from showing up
1005 * in sysfs... */
Greg Kroah-Hartmane4bc1662007-09-26 11:12:00 -07001006 kset_init(&class_obj_subsys);
Kay Sieversaf5ca3f2007-12-20 02:09:39 +01001007 kobject_set_name(&class_obj_subsys.kobj, "class_obj");
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -07001008 if (!class_obj_subsys.kobj.parent)
1009 class_obj_subsys.kobj.parent = &class_obj_subsys.kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 return 0;
1011}
1012
1013EXPORT_SYMBOL_GPL(class_create_file);
1014EXPORT_SYMBOL_GPL(class_remove_file);
1015EXPORT_SYMBOL_GPL(class_register);
1016EXPORT_SYMBOL_GPL(class_unregister);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -08001017EXPORT_SYMBOL_GPL(class_create);
1018EXPORT_SYMBOL_GPL(class_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
1020EXPORT_SYMBOL_GPL(class_device_register);
1021EXPORT_SYMBOL_GPL(class_device_unregister);
1022EXPORT_SYMBOL_GPL(class_device_initialize);
1023EXPORT_SYMBOL_GPL(class_device_add);
1024EXPORT_SYMBOL_GPL(class_device_del);
1025EXPORT_SYMBOL_GPL(class_device_get);
1026EXPORT_SYMBOL_GPL(class_device_put);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -08001027EXPORT_SYMBOL_GPL(class_device_create);
1028EXPORT_SYMBOL_GPL(class_device_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029EXPORT_SYMBOL_GPL(class_device_create_file);
1030EXPORT_SYMBOL_GPL(class_device_remove_file);
Greg Kroah-Hartmand919fd42007-10-31 12:51:29 -07001031EXPORT_SYMBOL_GPL(class_device_create_bin_file);
1032EXPORT_SYMBOL_GPL(class_device_remove_bin_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033
1034EXPORT_SYMBOL_GPL(class_interface_register);
1035EXPORT_SYMBOL_GPL(class_interface_unregister);