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