Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6
[linux-2.6] / drivers / base / sys.c
1 /*
2  * sys.c - pseudo-bus for system 'devices' (cpus, PICs, timers, etc)
3  *
4  * Copyright (c) 2002-3 Patrick Mochel
5  *               2002-3 Open Source Development Lab
6  *
7  * This file is released under the GPLv2
8  *
9  * This exports a 'system' bus type.
10  * By default, a 'sys' bus gets added to the root of the system. There will
11  * always be core system devices. Devices can use sysdev_register() to
12  * add themselves as children of the system bus.
13  */
14
15 #include <linux/sysdev.h>
16 #include <linux/err.h>
17 #include <linux/module.h>
18 #include <linux/kernel.h>
19 #include <linux/init.h>
20 #include <linux/slab.h>
21 #include <linux/string.h>
22 #include <linux/pm.h>
23 #include <linux/device.h>
24 #include <linux/mutex.h>
25
26 #include "base.h"
27
28 #define to_sysdev(k) container_of(k, struct sys_device, kobj)
29 #define to_sysdev_attr(a) container_of(a, struct sysdev_attribute, attr)
30
31
32 static ssize_t
33 sysdev_show(struct kobject * kobj, struct attribute * attr, char * buffer)
34 {
35         struct sys_device * sysdev = to_sysdev(kobj);
36         struct sysdev_attribute * sysdev_attr = to_sysdev_attr(attr);
37
38         if (sysdev_attr->show)
39                 return sysdev_attr->show(sysdev, sysdev_attr, buffer);
40         return -EIO;
41 }
42
43
44 static ssize_t
45 sysdev_store(struct kobject * kobj, struct attribute * attr,
46              const char * buffer, size_t count)
47 {
48         struct sys_device * sysdev = to_sysdev(kobj);
49         struct sysdev_attribute * sysdev_attr = to_sysdev_attr(attr);
50
51         if (sysdev_attr->store)
52                 return sysdev_attr->store(sysdev, sysdev_attr, buffer, count);
53         return -EIO;
54 }
55
56 static struct sysfs_ops sysfs_ops = {
57         .show   = sysdev_show,
58         .store  = sysdev_store,
59 };
60
61 static struct kobj_type ktype_sysdev = {
62         .sysfs_ops      = &sysfs_ops,
63 };
64
65
66 int sysdev_create_file(struct sys_device * s, struct sysdev_attribute * a)
67 {
68         return sysfs_create_file(&s->kobj, &a->attr);
69 }
70
71
72 void sysdev_remove_file(struct sys_device * s, struct sysdev_attribute * a)
73 {
74         sysfs_remove_file(&s->kobj, &a->attr);
75 }
76
77 EXPORT_SYMBOL_GPL(sysdev_create_file);
78 EXPORT_SYMBOL_GPL(sysdev_remove_file);
79
80 #define to_sysdev_class(k) container_of(k, struct sysdev_class, kset.kobj)
81 #define to_sysdev_class_attr(a) container_of(a, \
82         struct sysdev_class_attribute, attr)
83
84 static ssize_t sysdev_class_show(struct kobject *kobj, struct attribute *attr,
85                                  char *buffer)
86 {
87         struct sysdev_class * class = to_sysdev_class(kobj);
88         struct sysdev_class_attribute *class_attr = to_sysdev_class_attr(attr);
89
90         if (class_attr->show)
91                 return class_attr->show(class, buffer);
92         return -EIO;
93 }
94
95 static ssize_t sysdev_class_store(struct kobject *kobj, struct attribute *attr,
96                                   const char *buffer, size_t count)
97 {
98         struct sysdev_class * class = to_sysdev_class(kobj);
99         struct sysdev_class_attribute * class_attr = to_sysdev_class_attr(attr);
100
101         if (class_attr->store)
102                 return class_attr->store(class, buffer, count);
103         return -EIO;
104 }
105
106 static struct sysfs_ops sysfs_class_ops = {
107         .show   = sysdev_class_show,
108         .store  = sysdev_class_store,
109 };
110
111 static struct kobj_type ktype_sysdev_class = {
112         .sysfs_ops      = &sysfs_class_ops,
113 };
114
115 int sysdev_class_create_file(struct sysdev_class *c,
116                              struct sysdev_class_attribute *a)
117 {
118         return sysfs_create_file(&c->kset.kobj, &a->attr);
119 }
120 EXPORT_SYMBOL_GPL(sysdev_class_create_file);
121
122 void sysdev_class_remove_file(struct sysdev_class *c,
123                               struct sysdev_class_attribute *a)
124 {
125         sysfs_remove_file(&c->kset.kobj, &a->attr);
126 }
127 EXPORT_SYMBOL_GPL(sysdev_class_remove_file);
128
129 static struct kset *system_kset;
130
131 int sysdev_class_register(struct sysdev_class * cls)
132 {
133         pr_debug("Registering sysdev class '%s'\n", cls->name);
134
135         INIT_LIST_HEAD(&cls->drivers);
136         memset(&cls->kset.kobj, 0x00, sizeof(struct kobject));
137         cls->kset.kobj.parent = &system_kset->kobj;
138         cls->kset.kobj.ktype = &ktype_sysdev_class;
139         cls->kset.kobj.kset = system_kset;
140         kobject_set_name(&cls->kset.kobj, cls->name);
141         return kset_register(&cls->kset);
142 }
143
144 void sysdev_class_unregister(struct sysdev_class * cls)
145 {
146         pr_debug("Unregistering sysdev class '%s'\n",
147                  kobject_name(&cls->kset.kobj));
148         kset_unregister(&cls->kset);
149 }
150
151 EXPORT_SYMBOL_GPL(sysdev_class_register);
152 EXPORT_SYMBOL_GPL(sysdev_class_unregister);
153
154 static DEFINE_MUTEX(sysdev_drivers_lock);
155
156 /**
157  *      sysdev_driver_register - Register auxillary driver
158  *      @cls:   Device class driver belongs to.
159  *      @drv:   Driver.
160  *
161  *      @drv is inserted into @cls->drivers to be
162  *      called on each operation on devices of that class. The refcount
163  *      of @cls is incremented.
164  */
165
166 int sysdev_driver_register(struct sysdev_class *cls, struct sysdev_driver *drv)
167 {
168         int err = 0;
169
170         if (!cls) {
171                 WARN(1, KERN_WARNING "sysdev: invalid class passed to "
172                         "sysdev_driver_register!\n");
173                 return -EINVAL;
174         }
175
176         /* Check whether this driver has already been added to a class. */
177         if (drv->entry.next && !list_empty(&drv->entry))
178                 WARN(1, KERN_WARNING "sysdev: class %s: driver (%p) has already"
179                         " been registered to a class, something is wrong, but "
180                         "will forge on!\n", cls->name, drv);
181
182         mutex_lock(&sysdev_drivers_lock);
183         if (cls && kset_get(&cls->kset)) {
184                 list_add_tail(&drv->entry, &cls->drivers);
185
186                 /* If devices of this class already exist, tell the driver */
187                 if (drv->add) {
188                         struct sys_device *dev;
189                         list_for_each_entry(dev, &cls->kset.list, kobj.entry)
190                                 drv->add(dev);
191                 }
192         } else {
193                 err = -EINVAL;
194                 WARN(1, KERN_ERR "%s: invalid device class\n", __func__);
195         }
196         mutex_unlock(&sysdev_drivers_lock);
197         return err;
198 }
199
200
201 /**
202  *      sysdev_driver_unregister - Remove an auxillary driver.
203  *      @cls:   Class driver belongs to.
204  *      @drv:   Driver.
205  */
206 void sysdev_driver_unregister(struct sysdev_class * cls,
207                               struct sysdev_driver * drv)
208 {
209         mutex_lock(&sysdev_drivers_lock);
210         list_del_init(&drv->entry);
211         if (cls) {
212                 if (drv->remove) {
213                         struct sys_device *dev;
214                         list_for_each_entry(dev, &cls->kset.list, kobj.entry)
215                                 drv->remove(dev);
216                 }
217                 kset_put(&cls->kset);
218         }
219         mutex_unlock(&sysdev_drivers_lock);
220 }
221
222 EXPORT_SYMBOL_GPL(sysdev_driver_register);
223 EXPORT_SYMBOL_GPL(sysdev_driver_unregister);
224
225
226
227 /**
228  *      sysdev_register - add a system device to the tree
229  *      @sysdev:        device in question
230  *
231  */
232 int sysdev_register(struct sys_device * sysdev)
233 {
234         int error;
235         struct sysdev_class * cls = sysdev->cls;
236
237         if (!cls)
238                 return -EINVAL;
239
240         pr_debug("Registering sys device of class '%s'\n",
241                  kobject_name(&cls->kset.kobj));
242
243         /* initialize the kobject to 0, in case it had previously been used */
244         memset(&sysdev->kobj, 0x00, sizeof(struct kobject));
245
246         /* Make sure the kset is set */
247         sysdev->kobj.kset = &cls->kset;
248
249         /* Register the object */
250         error = kobject_init_and_add(&sysdev->kobj, &ktype_sysdev, NULL,
251                                      "%s%d", kobject_name(&cls->kset.kobj),
252                                      sysdev->id);
253
254         if (!error) {
255                 struct sysdev_driver * drv;
256
257                 pr_debug("Registering sys device '%s'\n",
258                          kobject_name(&sysdev->kobj));
259
260                 mutex_lock(&sysdev_drivers_lock);
261                 /* Generic notification is implicit, because it's that
262                  * code that should have called us.
263                  */
264
265                 /* Notify class auxillary drivers */
266                 list_for_each_entry(drv, &cls->drivers, entry) {
267                         if (drv->add)
268                                 drv->add(sysdev);
269                 }
270                 mutex_unlock(&sysdev_drivers_lock);
271         }
272
273         kobject_uevent(&sysdev->kobj, KOBJ_ADD);
274         return error;
275 }
276
277 void sysdev_unregister(struct sys_device * sysdev)
278 {
279         struct sysdev_driver * drv;
280
281         mutex_lock(&sysdev_drivers_lock);
282         list_for_each_entry(drv, &sysdev->cls->drivers, entry) {
283                 if (drv->remove)
284                         drv->remove(sysdev);
285         }
286         mutex_unlock(&sysdev_drivers_lock);
287
288         kobject_put(&sysdev->kobj);
289 }
290
291
292
293 /**
294  *      sysdev_shutdown - Shut down all system devices.
295  *
296  *      Loop over each class of system devices, and the devices in each
297  *      of those classes. For each device, we call the shutdown method for
298  *      each driver registered for the device - the auxillaries,
299  *      and the class driver.
300  *
301  *      Note: The list is iterated in reverse order, so that we shut down
302  *      child devices before we shut down thier parents. The list ordering
303  *      is guaranteed by virtue of the fact that child devices are registered
304  *      after their parents.
305  */
306
307 void sysdev_shutdown(void)
308 {
309         struct sysdev_class * cls;
310
311         pr_debug("Shutting Down System Devices\n");
312
313         mutex_lock(&sysdev_drivers_lock);
314         list_for_each_entry_reverse(cls, &system_kset->list, kset.kobj.entry) {
315                 struct sys_device * sysdev;
316
317                 pr_debug("Shutting down type '%s':\n",
318                          kobject_name(&cls->kset.kobj));
319
320                 list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
321                         struct sysdev_driver * drv;
322                         pr_debug(" %s\n", kobject_name(&sysdev->kobj));
323
324                         /* Call auxillary drivers first */
325                         list_for_each_entry(drv, &cls->drivers, entry) {
326                                 if (drv->shutdown)
327                                         drv->shutdown(sysdev);
328                         }
329
330                         /* Now call the generic one */
331                         if (cls->shutdown)
332                                 cls->shutdown(sysdev);
333                 }
334         }
335         mutex_unlock(&sysdev_drivers_lock);
336 }
337
338 static void __sysdev_resume(struct sys_device *dev)
339 {
340         struct sysdev_class *cls = dev->cls;
341         struct sysdev_driver *drv;
342
343         /* First, call the class-specific one */
344         if (cls->resume)
345                 cls->resume(dev);
346
347         /* Call auxillary drivers next. */
348         list_for_each_entry(drv, &cls->drivers, entry) {
349                 if (drv->resume)
350                         drv->resume(dev);
351         }
352 }
353
354 /**
355  *      sysdev_suspend - Suspend all system devices.
356  *      @state:         Power state to enter.
357  *
358  *      We perform an almost identical operation as sys_device_shutdown()
359  *      above, though calling ->suspend() instead. Interrupts are disabled
360  *      when this called. Devices are responsible for both saving state and
361  *      quiescing or powering down the device.
362  *
363  *      This is only called by the device PM core, so we let them handle
364  *      all synchronization.
365  */
366
367 int sysdev_suspend(pm_message_t state)
368 {
369         struct sysdev_class * cls;
370         struct sys_device *sysdev, *err_dev;
371         struct sysdev_driver *drv, *err_drv;
372         int ret;
373
374         pr_debug("Suspending System Devices\n");
375
376         list_for_each_entry_reverse(cls, &system_kset->list, kset.kobj.entry) {
377                 pr_debug("Suspending type '%s':\n",
378                          kobject_name(&cls->kset.kobj));
379
380                 list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
381                         pr_debug(" %s\n", kobject_name(&sysdev->kobj));
382
383                         /* Call auxillary drivers first */
384                         list_for_each_entry(drv, &cls->drivers, entry) {
385                                 if (drv->suspend) {
386                                         ret = drv->suspend(sysdev, state);
387                                         if (ret)
388                                                 goto aux_driver;
389                                 }
390                         }
391
392                         /* Now call the generic one */
393                         if (cls->suspend) {
394                                 ret = cls->suspend(sysdev, state);
395                                 if (ret)
396                                         goto cls_driver;
397                         }
398                 }
399         }
400         return 0;
401         /* resume current sysdev */
402 cls_driver:
403         drv = NULL;
404         printk(KERN_ERR "Class suspend failed for %s\n",
405                 kobject_name(&sysdev->kobj));
406
407 aux_driver:
408         if (drv)
409                 printk(KERN_ERR "Class driver suspend failed for %s\n",
410                                 kobject_name(&sysdev->kobj));
411         list_for_each_entry(err_drv, &cls->drivers, entry) {
412                 if (err_drv == drv)
413                         break;
414                 if (err_drv->resume)
415                         err_drv->resume(sysdev);
416         }
417
418         /* resume other sysdevs in current class */
419         list_for_each_entry(err_dev, &cls->kset.list, kobj.entry) {
420                 if (err_dev == sysdev)
421                         break;
422                 pr_debug(" %s\n", kobject_name(&err_dev->kobj));
423                 __sysdev_resume(err_dev);
424         }
425
426         /* resume other classes */
427         list_for_each_entry_continue(cls, &system_kset->list, kset.kobj.entry) {
428                 list_for_each_entry(err_dev, &cls->kset.list, kobj.entry) {
429                         pr_debug(" %s\n", kobject_name(&err_dev->kobj));
430                         __sysdev_resume(err_dev);
431                 }
432         }
433         return ret;
434 }
435
436
437 /**
438  *      sysdev_resume - Bring system devices back to life.
439  *
440  *      Similar to sys_device_suspend(), but we iterate the list forwards
441  *      to guarantee that parent devices are resumed before their children.
442  *
443  *      Note: Interrupts are disabled when called.
444  */
445
446 int sysdev_resume(void)
447 {
448         struct sysdev_class * cls;
449
450         pr_debug("Resuming System Devices\n");
451
452         list_for_each_entry(cls, &system_kset->list, kset.kobj.entry) {
453                 struct sys_device * sysdev;
454
455                 pr_debug("Resuming type '%s':\n",
456                          kobject_name(&cls->kset.kobj));
457
458                 list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
459                         pr_debug(" %s\n", kobject_name(&sysdev->kobj));
460
461                         __sysdev_resume(sysdev);
462                 }
463         }
464         return 0;
465 }
466
467
468 int __init system_bus_init(void)
469 {
470         system_kset = kset_create_and_add("system", NULL, &devices_kset->kobj);
471         if (!system_kset)
472                 return -ENOMEM;
473         return 0;
474 }
475
476 EXPORT_SYMBOL_GPL(sysdev_register);
477 EXPORT_SYMBOL_GPL(sysdev_unregister);
478
479 #define to_ext_attr(x) container_of(x, struct sysdev_ext_attribute, attr)
480
481 ssize_t sysdev_store_ulong(struct sys_device *sysdev,
482                            struct sysdev_attribute *attr,
483                            const char *buf, size_t size)
484 {
485         struct sysdev_ext_attribute *ea = to_ext_attr(attr);
486         char *end;
487         unsigned long new = simple_strtoul(buf, &end, 0);
488         if (end == buf)
489                 return -EINVAL;
490         *(unsigned long *)(ea->var) = new;
491         return end - buf;
492 }
493 EXPORT_SYMBOL_GPL(sysdev_store_ulong);
494
495 ssize_t sysdev_show_ulong(struct sys_device *sysdev,
496                           struct sysdev_attribute *attr,
497                           char *buf)
498 {
499         struct sysdev_ext_attribute *ea = to_ext_attr(attr);
500         return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
501 }
502 EXPORT_SYMBOL_GPL(sysdev_show_ulong);
503
504 ssize_t sysdev_store_int(struct sys_device *sysdev,
505                            struct sysdev_attribute *attr,
506                            const char *buf, size_t size)
507 {
508         struct sysdev_ext_attribute *ea = to_ext_attr(attr);
509         char *end;
510         long new = simple_strtol(buf, &end, 0);
511         if (end == buf || new > INT_MAX || new < INT_MIN)
512                 return -EINVAL;
513         *(int *)(ea->var) = new;
514         return end - buf;
515 }
516 EXPORT_SYMBOL_GPL(sysdev_store_int);
517
518 ssize_t sysdev_show_int(struct sys_device *sysdev,
519                           struct sysdev_attribute *attr,
520                           char *buf)
521 {
522         struct sysdev_ext_attribute *ea = to_ext_attr(attr);
523         return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
524 }
525 EXPORT_SYMBOL_GPL(sysdev_show_int);
526