blob: 4d2222618b780f47dfa54e40246dbd9e4c8bdcc7 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include "base.h"
21
22#define to_class_attr(_attr) container_of(_attr, struct class_attribute, attr)
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -070023#define to_class(obj) container_of(obj, struct class, subsys.kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25static ssize_t
26class_attr_show(struct kobject * kobj, struct attribute * attr, char * buf)
27{
28 struct class_attribute * class_attr = to_class_attr(attr);
29 struct class * dc = to_class(kobj);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050030 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
32 if (class_attr->show)
33 ret = class_attr->show(dc, buf);
34 return ret;
35}
36
37static ssize_t
38class_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);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050043 ssize_t ret = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
45 if (class_attr->store)
46 ret = class_attr->store(dc, buf, count);
47 return ret;
48}
49
50static 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
63static struct sysfs_ops class_sysfs_ops = {
64 .show = class_attr_show,
65 .store = class_attr_store,
66};
67
68static struct kobj_type ktype_class = {
69 .sysfs_ops = &class_sysfs_ops,
70 .release = class_release,
71};
72
73/* Hotplug events for classes go to the class_obj subsys */
74static decl_subsys(class, &ktype_class, NULL);
75
76
77int class_create_file(struct class * cls, const struct class_attribute * attr)
78{
79 int error;
80 if (cls) {
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -070081 error = sysfs_create_file(&cls->subsys.kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 } else
83 error = -EINVAL;
84 return error;
85}
86
87void class_remove_file(struct class * cls, const struct class_attribute * attr)
88{
89 if (cls)
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -070090 sysfs_remove_file(&cls->subsys.kobj, &attr->attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091}
92
Greg Kroah-Hartman17407572006-05-02 16:59:59 +020093static struct class *class_get(struct class *cls)
Linus Torvalds1da177e2005-04-16 15:20:36 -070094{
95 if (cls)
96 return container_of(subsys_get(&cls->subsys), struct class, subsys);
97 return NULL;
98}
99
Greg Kroah-Hartman17407572006-05-02 16:59:59 +0200100static void class_put(struct class * cls)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101{
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700102 if (cls)
103 subsys_put(&cls->subsys);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104}
105
106
107static 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 Err;
117 }
118 }
119 Done:
120 return error;
121 Err:
122 while (--i >= 0)
123 class_remove_file(cls,&cls->class_attrs[i]);
124 goto Done;
125}
126
127static 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
137int 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);
Greg Kroah-Hartman23681e42006-06-14 12:14:34 -0700144 INIT_LIST_HEAD(&cls->devices);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 INIT_LIST_HEAD(&cls->interfaces);
Kay Sievers86406242007-03-14 03:25:56 +0100146 kset_init(&cls->class_dirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 init_MUTEX(&cls->sem);
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700148 error = kobject_set_name(&cls->subsys.kobj, "%s", cls->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 if (error)
150 return error;
151
152 subsys_set_kset(cls, class_subsys);
153
154 error = subsystem_register(&cls->subsys);
155 if (!error) {
156 error = add_class_attrs(class_get(cls));
157 class_put(cls);
158 }
159 return error;
160}
161
162void class_unregister(struct class * cls)
163{
164 pr_debug("device class '%s': unregistering\n", cls->name);
165 remove_class_attrs(cls);
166 subsystem_unregister(&cls->subsys);
167}
168
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800169static void class_create_release(struct class *cls)
170{
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700171 pr_debug("%s called for %s\n", __FUNCTION__, cls->name);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800172 kfree(cls);
173}
174
175static void class_device_create_release(struct class_device *class_dev)
176{
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700177 pr_debug("%s called for %s\n", __FUNCTION__, class_dev->class_id);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800178 kfree(class_dev);
179}
180
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700181/* needed to allow these devices to have parent class devices */
Kay Sievers312c0042005-11-16 09:00:00 +0100182static int class_device_create_uevent(struct class_device *class_dev,
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700183 char **envp, int num_envp,
184 char *buffer, int buffer_size)
185{
186 pr_debug("%s called for %s\n", __FUNCTION__, class_dev->class_id);
187 return 0;
188}
189
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800190/**
191 * class_create - create a struct class structure
192 * @owner: pointer to the module that is to "own" this struct class
193 * @name: pointer to a string for the name of this class.
194 *
195 * This is used to create a struct class pointer that can then be used
196 * in calls to class_device_create().
197 *
198 * Note, the pointer created here is to be destroyed when finished by
199 * making a call to class_destroy().
200 */
Miguel Ojeda Sandonisab7d7372006-09-13 15:34:05 +0200201struct class *class_create(struct module *owner, const char *name)
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800202{
203 struct class *cls;
204 int retval;
205
Jiri Slaby4aed0642005-09-13 01:25:01 -0700206 cls = kzalloc(sizeof(*cls), GFP_KERNEL);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800207 if (!cls) {
208 retval = -ENOMEM;
209 goto error;
210 }
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800211
212 cls->name = name;
213 cls->owner = owner;
214 cls->class_release = class_create_release;
215 cls->release = class_device_create_release;
216
217 retval = class_register(cls);
218 if (retval)
219 goto error;
220
221 return cls;
222
223error:
224 kfree(cls);
225 return ERR_PTR(retval);
226}
227
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800228/**
229 * class_destroy - destroys a struct class structure
Rolf Eike Beer92a0f862006-09-29 01:59:13 -0700230 * @cls: pointer to the struct class that is to be destroyed
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800231 *
232 * Note, the pointer to be destroyed must have been created with a call
233 * to class_create().
234 */
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800235void class_destroy(struct class *cls)
236{
237 if ((cls == NULL) || (IS_ERR(cls)))
238 return;
239
240 class_unregister(cls);
241}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243/* Class Device Stuff */
244
245int class_device_create_file(struct class_device * class_dev,
246 const struct class_device_attribute * attr)
247{
248 int error = -EINVAL;
249 if (class_dev)
250 error = sysfs_create_file(&class_dev->kobj, &attr->attr);
251 return error;
252}
253
254void class_device_remove_file(struct class_device * class_dev,
255 const struct class_device_attribute * attr)
256{
257 if (class_dev)
258 sysfs_remove_file(&class_dev->kobj, &attr->attr);
259}
260
261int class_device_create_bin_file(struct class_device *class_dev,
262 struct bin_attribute *attr)
263{
264 int error = -EINVAL;
265 if (class_dev)
266 error = sysfs_create_bin_file(&class_dev->kobj, attr);
267 return error;
268}
269
270void class_device_remove_bin_file(struct class_device *class_dev,
271 struct bin_attribute *attr)
272{
273 if (class_dev)
274 sysfs_remove_bin_file(&class_dev->kobj, attr);
275}
276
277static ssize_t
278class_device_attr_show(struct kobject * kobj, struct attribute * attr,
279 char * buf)
280{
281 struct class_device_attribute * class_dev_attr = to_class_dev_attr(attr);
282 struct class_device * cd = to_class_dev(kobj);
283 ssize_t ret = 0;
284
285 if (class_dev_attr->show)
286 ret = class_dev_attr->show(cd, buf);
287 return ret;
288}
289
290static ssize_t
291class_device_attr_store(struct kobject * kobj, struct attribute * attr,
292 const char * buf, size_t count)
293{
294 struct class_device_attribute * class_dev_attr = to_class_dev_attr(attr);
295 struct class_device * cd = to_class_dev(kobj);
296 ssize_t ret = 0;
297
298 if (class_dev_attr->store)
299 ret = class_dev_attr->store(cd, buf, count);
300 return ret;
301}
302
303static struct sysfs_ops class_dev_sysfs_ops = {
304 .show = class_device_attr_show,
305 .store = class_device_attr_store,
306};
307
308static void class_dev_release(struct kobject * kobj)
309{
310 struct class_device *cd = to_class_dev(kobj);
311 struct class * cls = cd->class;
312
313 pr_debug("device class '%s': release.\n", cd->class_id);
314
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700315 if (cd->release)
316 cd->release(cd);
317 else if (cls->release)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 cls->release(cd);
319 else {
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700320 printk(KERN_ERR "Class Device '%s' does not have a release() function, "
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 "it is broken and must be fixed.\n",
322 cd->class_id);
323 WARN_ON(1);
324 }
325}
326
327static struct kobj_type ktype_class_device = {
328 .sysfs_ops = &class_dev_sysfs_ops,
329 .release = class_dev_release,
330};
331
Kay Sievers312c0042005-11-16 09:00:00 +0100332static int class_uevent_filter(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333{
334 struct kobj_type *ktype = get_ktype(kobj);
335
336 if (ktype == &ktype_class_device) {
337 struct class_device *class_dev = to_class_dev(kobj);
338 if (class_dev->class)
339 return 1;
340 }
341 return 0;
342}
343
Kay Sievers312c0042005-11-16 09:00:00 +0100344static const char *class_uevent_name(struct kset *kset, struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345{
346 struct class_device *class_dev = to_class_dev(kobj);
347
348 return class_dev->class->name;
349}
350
Kay Sievers805fab42006-09-14 11:23:28 +0200351#ifdef CONFIG_SYSFS_DEPRECATED
352char *make_class_name(const char *name, struct kobject *kobj)
353{
354 char *class_name;
355 int size;
356
357 size = strlen(name) + strlen(kobject_name(kobj)) + 2;
358
359 class_name = kmalloc(size, GFP_KERNEL);
360 if (!class_name)
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100361 return NULL;
Kay Sievers805fab42006-09-14 11:23:28 +0200362
363 strcpy(class_name, name);
364 strcat(class_name, ":");
365 strcat(class_name, kobject_name(kobj));
366 return class_name;
367}
368
Kay Sievers805fab42006-09-14 11:23:28 +0200369static int make_deprecated_class_device_links(struct class_device *class_dev)
370{
371 char *class_name;
372 int error;
373
374 if (!class_dev->dev)
375 return 0;
376
377 class_name = make_class_name(class_dev->class->name, &class_dev->kobj);
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100378 if (class_name)
379 error = sysfs_create_link(&class_dev->dev->kobj,
380 &class_dev->kobj, class_name);
381 else
382 error = -ENOMEM;
Kay Sievers805fab42006-09-14 11:23:28 +0200383 kfree(class_name);
384 return error;
385}
386
387static void remove_deprecated_class_device_links(struct class_device *class_dev)
388{
389 char *class_name;
390
391 if (!class_dev->dev)
392 return;
393
394 class_name = make_class_name(class_dev->class->name, &class_dev->kobj);
Cornelia Huckcb360bb2006-11-27 10:35:05 +0100395 if (class_name)
396 sysfs_remove_link(&class_dev->dev->kobj, class_name);
Kay Sievers805fab42006-09-14 11:23:28 +0200397 kfree(class_name);
398}
399#else
Kay Sievers805fab42006-09-14 11:23:28 +0200400static inline int make_deprecated_class_device_links(struct class_device *cd)
401{ return 0; }
402static void remove_deprecated_class_device_links(struct class_device *cd)
403{ }
404#endif
405
Kay Sievers312c0042005-11-16 09:00:00 +0100406static int class_uevent(struct kset *kset, struct kobject *kobj, char **envp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 int num_envp, char *buffer, int buffer_size)
408{
409 struct class_device *class_dev = to_class_dev(kobj);
Kay Sievers2c7afd12007-05-01 13:46:26 +0200410 struct device *dev = class_dev->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 int i = 0;
412 int length = 0;
413 int retval = 0;
414
415 pr_debug("%s - name = %s\n", __FUNCTION__, class_dev->class_id);
416
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 if (MAJOR(class_dev->devt)) {
Kay Sievers312c0042005-11-16 09:00:00 +0100418 add_uevent_var(envp, num_envp, &i,
419 buffer, buffer_size, &length,
420 "MAJOR=%u", MAJOR(class_dev->devt));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
Kay Sievers312c0042005-11-16 09:00:00 +0100422 add_uevent_var(envp, num_envp, &i,
423 buffer, buffer_size, &length,
424 "MINOR=%u", MINOR(class_dev->devt));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 }
426
Kay Sievers2c7afd12007-05-01 13:46:26 +0200427 if (dev) {
428 const char *path = kobject_get_path(&dev->kobj, GFP_KERNEL);
429 if (path) {
430 add_uevent_var(envp, num_envp, &i,
431 buffer, buffer_size, &length,
432 "PHYSDEVPATH=%s", path);
433 kfree(path);
434 }
435
436 if (dev->bus)
437 add_uevent_var(envp, num_envp, &i,
438 buffer, buffer_size, &length,
439 "PHYSDEVBUS=%s", dev->bus->name);
440
441 if (dev->driver)
442 add_uevent_var(envp, num_envp, &i,
443 buffer, buffer_size, &length,
444 "PHYSDEVDRIVER=%s", dev->driver->name);
445 }
446
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 /* terminate, set to next free slot, shrink available space */
448 envp[i] = NULL;
449 envp = &envp[i];
450 num_envp -= i;
451 buffer = &buffer[length];
452 buffer_size -= length;
453
Kay Sievers312c0042005-11-16 09:00:00 +0100454 if (class_dev->uevent) {
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700455 /* have the class device specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100456 retval = class_dev->uevent(class_dev, envp, num_envp,
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700457 buffer, buffer_size);
458 if (retval)
Kay Sievers312c0042005-11-16 09:00:00 +0100459 pr_debug("class_dev->uevent() returned %d\n", retval);
460 } else if (class_dev->class->uevent) {
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700461 /* have the class specific function add its stuff */
Kay Sievers312c0042005-11-16 09:00:00 +0100462 retval = class_dev->class->uevent(class_dev, envp, num_envp,
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700463 buffer, buffer_size);
464 if (retval)
Kay Sievers312c0042005-11-16 09:00:00 +0100465 pr_debug("class->uevent() returned %d\n", retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 }
467
468 return retval;
469}
470
Kay Sievers312c0042005-11-16 09:00:00 +0100471static struct kset_uevent_ops class_uevent_ops = {
472 .filter = class_uevent_filter,
473 .name = class_uevent_name,
474 .uevent = class_uevent,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475};
476
Kay Sievers312c0042005-11-16 09:00:00 +0100477static decl_subsys(class_obj, &ktype_class_device, &class_uevent_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
479
480static int class_device_add_attrs(struct class_device * cd)
481{
482 int i;
483 int error = 0;
484 struct class * cls = cd->class;
485
486 if (cls->class_dev_attrs) {
487 for (i = 0; attr_name(cls->class_dev_attrs[i]); i++) {
488 error = class_device_create_file(cd,
489 &cls->class_dev_attrs[i]);
490 if (error)
491 goto Err;
492 }
493 }
494 Done:
495 return error;
496 Err:
497 while (--i >= 0)
498 class_device_remove_file(cd,&cls->class_dev_attrs[i]);
499 goto Done;
500}
501
502static void class_device_remove_attrs(struct class_device * cd)
503{
504 int i;
505 struct class * cls = cd->class;
506
507 if (cls->class_dev_attrs) {
508 for (i = 0; attr_name(cls->class_dev_attrs[i]); i++)
509 class_device_remove_file(cd,&cls->class_dev_attrs[i]);
510 }
511}
512
Stephen Hemminger14982212006-05-06 17:55:11 -0700513static int class_device_add_groups(struct class_device * cd)
514{
515 int i;
516 int error = 0;
517
518 if (cd->groups) {
519 for (i = 0; cd->groups[i]; i++) {
520 error = sysfs_create_group(&cd->kobj, cd->groups[i]);
521 if (error) {
522 while (--i >= 0)
523 sysfs_remove_group(&cd->kobj, cd->groups[i]);
524 goto out;
525 }
526 }
527 }
528out:
529 return error;
530}
531
532static void class_device_remove_groups(struct class_device * cd)
533{
534 int i;
535 if (cd->groups) {
536 for (i = 0; cd->groups[i]; i++) {
537 sysfs_remove_group(&cd->kobj, cd->groups[i]);
538 }
539 }
540}
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542static ssize_t show_dev(struct class_device *class_dev, char *buf)
543{
544 return print_dev_t(buf, class_dev->devt);
545}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Tejun Heoad6a1e12007-06-14 03:45:17 +0900547static struct class_device_attribute class_devt_attr =
548 __ATTR(dev, S_IRUGO, show_dev, NULL);
549
Kay Sieversa7fd6702005-10-01 14:49:43 +0200550static ssize_t store_uevent(struct class_device *class_dev,
551 const char *buf, size_t count)
552{
Kay Sievers312c0042005-11-16 09:00:00 +0100553 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
Kay Sieversa7fd6702005-10-01 14:49:43 +0200554 return count;
555}
556
Tejun Heoad6a1e12007-06-14 03:45:17 +0900557static struct class_device_attribute class_uevent_attr =
558 __ATTR(uevent, S_IWUSR, NULL, store_uevent);
559
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560void class_device_initialize(struct class_device *class_dev)
561{
562 kobj_set_kset_s(class_dev, class_obj_subsys);
563 kobject_init(&class_dev->kobj);
564 INIT_LIST_HEAD(&class_dev->node);
565}
566
567int class_device_add(struct class_device *class_dev)
568{
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700569 struct class *parent_class = NULL;
570 struct class_device *parent_class_dev = NULL;
571 struct class_interface *class_intf;
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700572 int error = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
574 class_dev = class_device_get(class_dev);
575 if (!class_dev)
576 return -EINVAL;
577
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700578 if (!strlen(class_dev->class_id))
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700579 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700581 parent_class = class_get(class_dev->class);
582 if (!parent_class)
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700583 goto out1;
584
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700585 parent_class_dev = class_device_get(class_dev->parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
587 pr_debug("CLASS: registering class device: ID = '%s'\n",
588 class_dev->class_id);
589
590 /* first, register with generic layer. */
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700591 error = kobject_set_name(&class_dev->kobj, "%s", class_dev->class_id);
592 if (error)
593 goto out2;
594
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700595 if (parent_class_dev)
596 class_dev->kobj.parent = &parent_class_dev->kobj;
597 else
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700598 class_dev->kobj.parent = &parent_class->subsys.kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700600 error = kobject_add(&class_dev->kobj);
601 if (error)
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700602 goto out2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800604 /* add the needed attributes to this device */
Cornelia Huckf0e17612006-09-22 11:37:00 +0200605 error = sysfs_create_link(&class_dev->kobj,
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700606 &parent_class->subsys.kobj, "subsystem");
Cornelia Huckf0e17612006-09-22 11:37:00 +0200607 if (error)
608 goto out3;
Tejun Heoad6a1e12007-06-14 03:45:17 +0900609
610 error = class_device_create_file(class_dev, &class_uevent_attr);
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700611 if (error)
612 goto out3;
Kay Sieversa7fd6702005-10-01 14:49:43 +0200613
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800614 if (MAJOR(class_dev->devt)) {
Tejun Heoad6a1e12007-06-14 03:45:17 +0900615 error = class_device_create_file(class_dev, &class_devt_attr);
616 if (error)
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700617 goto out4;
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800618 }
619
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700620 error = class_device_add_attrs(class_dev);
621 if (error)
622 goto out5;
623
Dmitry Torokhov76d1ce02005-07-10 01:21:24 -0500624 if (class_dev->dev) {
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700625 error = sysfs_create_link(&class_dev->kobj,
626 &class_dev->dev->kobj, "device");
627 if (error)
628 goto out6;
Dmitry Torokhov76d1ce02005-07-10 01:21:24 -0500629 }
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800630
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700631 error = class_device_add_groups(class_dev);
632 if (error)
Kay Sievers805fab42006-09-14 11:23:28 +0200633 goto out7;
634
635 error = make_deprecated_class_device_links(class_dev);
636 if (error)
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700637 goto out8;
Stephen Hemminger14982212006-05-06 17:55:11 -0700638
Kay Sievers312c0042005-11-16 09:00:00 +0100639 kobject_uevent(&class_dev->kobj, KOBJ_ADD);
Dmitry Torokhovdbe90352005-09-15 02:01:37 -0500640
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800641 /* notify any interfaces this device is now here */
Jayachandran Ca1438892006-04-03 12:31:53 -0700642 down(&parent_class->sem);
643 list_add_tail(&class_dev->node, &parent_class->children);
644 list_for_each_entry(class_intf, &parent_class->interfaces, node) {
645 if (class_intf->add)
646 class_intf->add(class_dev, class_intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 }
Jayachandran Ca1438892006-04-03 12:31:53 -0700648 up(&parent_class->sem);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800649
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700650 goto out1;
651
652 out8:
Kay Sievers805fab42006-09-14 11:23:28 +0200653 class_device_remove_groups(class_dev);
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700654 out7:
655 if (class_dev->dev)
656 sysfs_remove_link(&class_dev->kobj, "device");
657 out6:
658 class_device_remove_attrs(class_dev);
659 out5:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900660 if (MAJOR(class_dev->devt))
661 class_device_remove_file(class_dev, &class_devt_attr);
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700662 out4:
Tejun Heoad6a1e12007-06-14 03:45:17 +0900663 class_device_remove_file(class_dev, &class_uevent_attr);
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700664 out3:
665 kobject_del(&class_dev->kobj);
666 out2:
667 if(parent_class_dev)
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700668 class_device_put(parent_class_dev);
Stephen Hemmingerb7fe4a62006-04-26 09:53:14 -0700669 class_put(parent_class);
670 out1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 class_device_put(class_dev);
672 return error;
673}
674
675int class_device_register(struct class_device *class_dev)
676{
677 class_device_initialize(class_dev);
678 return class_device_add(class_dev);
679}
680
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800681/**
682 * class_device_create - creates a class device and registers it with sysfs
Rolf Eike Beer92a0f862006-09-29 01:59:13 -0700683 * @cls: pointer to the struct class that this device should be registered to.
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700684 * @parent: pointer to the parent struct class_device of this new device, if any.
Rolf Eike Beer92a0f862006-09-29 01:59:13 -0700685 * @devt: the dev_t for the char device to be added.
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800686 * @device: a pointer to a struct device that is assiociated with this class device.
687 * @fmt: string for the class device's name
688 *
689 * This function can be used by char device classes. A struct
690 * class_device will be created in sysfs, registered to the specified
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700691 * class.
692 * A "dev" file will be created, showing the dev_t for the device, if
693 * the dev_t is not 0,0.
694 * If a pointer to a parent struct class_device is passed in, the newly
695 * created struct class_device will be a child of that device in sysfs.
696 * The pointer to the struct class_device will be returned from the
697 * call. Any further sysfs files that might be required can be created
698 * using this pointer.
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800699 *
700 * Note: the struct class passed to this function must have previously
701 * been created with a call to class_create().
702 */
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700703struct class_device *class_device_create(struct class *cls,
704 struct class_device *parent,
705 dev_t devt,
Dmitry Torokhovddd5d352006-08-10 01:18:18 -0400706 struct device *device,
707 const char *fmt, ...)
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800708{
709 va_list args;
710 struct class_device *class_dev = NULL;
711 int retval = -ENODEV;
712
713 if (cls == NULL || IS_ERR(cls))
714 goto error;
715
Jiri Slaby4aed0642005-09-13 01:25:01 -0700716 class_dev = kzalloc(sizeof(*class_dev), GFP_KERNEL);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800717 if (!class_dev) {
718 retval = -ENOMEM;
719 goto error;
720 }
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800721
722 class_dev->devt = devt;
723 class_dev->dev = device;
724 class_dev->class = cls;
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700725 class_dev->parent = parent;
726 class_dev->release = class_device_create_release;
Kay Sievers312c0042005-11-16 09:00:00 +0100727 class_dev->uevent = class_device_create_uevent;
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800728
729 va_start(args, fmt);
730 vsnprintf(class_dev->class_id, BUS_ID_SIZE, fmt, args);
731 va_end(args);
732 retval = class_device_register(class_dev);
733 if (retval)
734 goto error;
735
736 return class_dev;
737
738error:
739 kfree(class_dev);
740 return ERR_PTR(retval);
741}
742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743void class_device_del(struct class_device *class_dev)
744{
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700745 struct class *parent_class = class_dev->class;
746 struct class_device *parent_device = class_dev->parent;
747 struct class_interface *class_intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700749 if (parent_class) {
750 down(&parent_class->sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 list_del_init(&class_dev->node);
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700752 list_for_each_entry(class_intf, &parent_class->interfaces, node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 if (class_intf->remove)
Dmitry Torokhovd8539d82005-09-15 02:01:36 -0500754 class_intf->remove(class_dev, class_intf);
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700755 up(&parent_class->sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 }
757
Dmitry Torokhov76d1ce02005-07-10 01:21:24 -0500758 if (class_dev->dev) {
Kay Sievers805fab42006-09-14 11:23:28 +0200759 remove_deprecated_class_device_links(class_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 sysfs_remove_link(&class_dev->kobj, "device");
Dmitry Torokhov76d1ce02005-07-10 01:21:24 -0500761 }
Kay Sieversb9d9c822006-06-15 15:31:56 +0200762 sysfs_remove_link(&class_dev->kobj, "subsystem");
Tejun Heoad6a1e12007-06-14 03:45:17 +0900763 class_device_remove_file(class_dev, &class_uevent_attr);
764 if (MAJOR(class_dev->devt))
765 class_device_remove_file(class_dev, &class_devt_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 class_device_remove_attrs(class_dev);
Stephen Hemminger14982212006-05-06 17:55:11 -0700767 class_device_remove_groups(class_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
Kay Sievers312c0042005-11-16 09:00:00 +0100769 kobject_uevent(&class_dev->kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 kobject_del(&class_dev->kobj);
771
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700772 class_device_put(parent_device);
773 class_put(parent_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774}
775
776void class_device_unregister(struct class_device *class_dev)
777{
778 pr_debug("CLASS: Unregistering class device. ID = '%s'\n",
779 class_dev->class_id);
780 class_device_del(class_dev);
781 class_device_put(class_dev);
782}
783
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800784/**
785 * class_device_destroy - removes a class device that was created with class_device_create()
786 * @cls: the pointer to the struct class that this device was registered * with.
Rolf Eike Beer92a0f862006-09-29 01:59:13 -0700787 * @devt: the dev_t of the device that was previously registered.
gregkh@suse.de2fc68442005-03-23 10:02:56 -0800788 *
789 * This call unregisters and cleans up a class device that was created with a
790 * call to class_device_create()
791 */
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800792void class_device_destroy(struct class *cls, dev_t devt)
793{
794 struct class_device *class_dev = NULL;
795 struct class_device *class_dev_tmp;
796
797 down(&cls->sem);
798 list_for_each_entry(class_dev_tmp, &cls->children, node) {
799 if (class_dev_tmp->devt == devt) {
800 class_dev = class_dev_tmp;
801 break;
802 }
803 }
804 up(&cls->sem);
805
806 if (class_dev)
807 class_device_unregister(class_dev);
808}
809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810struct class_device * class_device_get(struct class_device *class_dev)
811{
812 if (class_dev)
813 return to_class_dev(kobject_get(&class_dev->kobj));
814 return NULL;
815}
816
817void class_device_put(struct class_device *class_dev)
818{
Greg Kroah-Hartman51d172d2005-10-27 22:25:43 -0700819 if (class_dev)
820 kobject_put(&class_dev->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821}
822
823
824int class_interface_register(struct class_interface *class_intf)
825{
826 struct class *parent;
827 struct class_device *class_dev;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200828 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
830 if (!class_intf || !class_intf->class)
831 return -ENODEV;
832
833 parent = class_get(class_intf->class);
834 if (!parent)
835 return -EINVAL;
836
837 down(&parent->sem);
838 list_add_tail(&class_intf->node, &parent->interfaces);
839 if (class_intf->add) {
840 list_for_each_entry(class_dev, &parent->children, node)
Dmitry Torokhovd8539d82005-09-15 02:01:36 -0500841 class_intf->add(class_dev, class_intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 }
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200843 if (class_intf->add_dev) {
844 list_for_each_entry(dev, &parent->devices, node)
845 class_intf->add_dev(dev, class_intf);
846 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 up(&parent->sem);
848
849 return 0;
850}
851
852void class_interface_unregister(struct class_interface *class_intf)
853{
854 struct class * parent = class_intf->class;
855 struct class_device *class_dev;
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200856 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
858 if (!parent)
859 return;
860
861 down(&parent->sem);
862 list_del_init(&class_intf->node);
863 if (class_intf->remove) {
864 list_for_each_entry(class_dev, &parent->children, node)
Dmitry Torokhovd8539d82005-09-15 02:01:36 -0500865 class_intf->remove(class_dev, class_intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 }
Greg Kroah-Hartmanc47ed212006-09-13 15:34:05 +0200867 if (class_intf->remove_dev) {
868 list_for_each_entry(dev, &parent->devices, node)
869 class_intf->remove_dev(dev, class_intf);
870 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 up(&parent->sem);
872
873 class_put(parent);
874}
875
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876int __init classes_init(void)
877{
878 int retval;
879
880 retval = subsystem_register(&class_subsys);
881 if (retval)
882 return retval;
883
884 /* ick, this is ugly, the things we go through to keep from showing up
885 * in sysfs... */
886 subsystem_init(&class_obj_subsys);
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700887 if (!class_obj_subsys.kobj.parent)
888 class_obj_subsys.kobj.parent = &class_obj_subsys.kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 return 0;
890}
891
892EXPORT_SYMBOL_GPL(class_create_file);
893EXPORT_SYMBOL_GPL(class_remove_file);
894EXPORT_SYMBOL_GPL(class_register);
895EXPORT_SYMBOL_GPL(class_unregister);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800896EXPORT_SYMBOL_GPL(class_create);
897EXPORT_SYMBOL_GPL(class_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898
899EXPORT_SYMBOL_GPL(class_device_register);
900EXPORT_SYMBOL_GPL(class_device_unregister);
901EXPORT_SYMBOL_GPL(class_device_initialize);
902EXPORT_SYMBOL_GPL(class_device_add);
903EXPORT_SYMBOL_GPL(class_device_del);
904EXPORT_SYMBOL_GPL(class_device_get);
905EXPORT_SYMBOL_GPL(class_device_put);
gregkh@suse.dee9ba6362005-03-15 11:54:21 -0800906EXPORT_SYMBOL_GPL(class_device_create);
907EXPORT_SYMBOL_GPL(class_device_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908EXPORT_SYMBOL_GPL(class_device_create_file);
909EXPORT_SYMBOL_GPL(class_device_remove_file);
910EXPORT_SYMBOL_GPL(class_device_create_bin_file);
911EXPORT_SYMBOL_GPL(class_device_remove_bin_file);
912
913EXPORT_SYMBOL_GPL(class_interface_register);
914EXPORT_SYMBOL_GPL(class_interface_unregister);