blob: 9dff77bfe1e348a0ed3a3e4f450d192b6a4ac580 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/sysdev.h>
16#include <linux/err.h>
17#include <linux/module.h>
18#include <linux/kernel.h>
19#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/string.h>
Pavel Machek438510f2005-04-16 15:25:24 -070021#include <linux/pm.h>
Adrian Bunkf67d1152006-01-19 17:30:17 +010022#include <linux/device.h>
Matthias Kaehlcke9f3f7762007-05-23 14:19:42 -070023#include <linux/mutex.h>
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +010024#include <linux/interrupt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
Adrian Bunkf67d1152006-01-19 17:30:17 +010026#include "base.h"
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#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
32static ssize_t
Zhenwen Xu60530af2009-03-03 18:36:02 +080033sysdev_show(struct kobject *kobj, struct attribute *attr, char *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -070034{
Zhenwen Xu60530af2009-03-03 18:36:02 +080035 struct sys_device *sysdev = to_sysdev(kobj);
36 struct sysdev_attribute *sysdev_attr = to_sysdev_attr(attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38 if (sysdev_attr->show)
Andi Kleen4a0b2b42008-07-01 18:48:41 +020039 return sysdev_attr->show(sysdev, sysdev_attr, buffer);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050040 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041}
42
43
44static ssize_t
Zhenwen Xu60530af2009-03-03 18:36:02 +080045sysdev_store(struct kobject *kobj, struct attribute *attr,
46 const char *buffer, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070047{
Zhenwen Xu60530af2009-03-03 18:36:02 +080048 struct sys_device *sysdev = to_sysdev(kobj);
49 struct sysdev_attribute *sysdev_attr = to_sysdev_attr(attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
51 if (sysdev_attr->store)
Andi Kleen4a0b2b42008-07-01 18:48:41 +020052 return sysdev_attr->store(sysdev, sysdev_attr, buffer, count);
Dmitry Torokhov4a0c20b2005-04-29 01:23:47 -050053 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054}
55
Emese Revfy52cf25d2010-01-19 02:58:23 +010056static const struct sysfs_ops sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 .show = sysdev_show,
58 .store = sysdev_store,
59};
60
61static struct kobj_type ktype_sysdev = {
62 .sysfs_ops = &sysfs_ops,
63};
64
65
Zhenwen Xu60530af2009-03-03 18:36:02 +080066int sysdev_create_file(struct sys_device *s, struct sysdev_attribute *a)
Linus Torvalds1da177e2005-04-16 15:20:36 -070067{
68 return sysfs_create_file(&s->kobj, &a->attr);
69}
70
71
Zhenwen Xu60530af2009-03-03 18:36:02 +080072void sysdev_remove_file(struct sys_device *s, struct sysdev_attribute *a)
Linus Torvalds1da177e2005-04-16 15:20:36 -070073{
74 sysfs_remove_file(&s->kobj, &a->attr);
75}
76
77EXPORT_SYMBOL_GPL(sysdev_create_file);
78EXPORT_SYMBOL_GPL(sysdev_remove_file);
79
Shaohua Li670dd902006-05-08 13:45:57 +080080#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
84static ssize_t sysdev_class_show(struct kobject *kobj, struct attribute *attr,
85 char *buffer)
86{
Zhenwen Xu60530af2009-03-03 18:36:02 +080087 struct sysdev_class *class = to_sysdev_class(kobj);
Shaohua Li670dd902006-05-08 13:45:57 +080088 struct sysdev_class_attribute *class_attr = to_sysdev_class_attr(attr);
89
90 if (class_attr->show)
Andi Kleenc9be0a32010-01-05 12:47:58 +010091 return class_attr->show(class, class_attr, buffer);
Shaohua Li670dd902006-05-08 13:45:57 +080092 return -EIO;
93}
94
95static ssize_t sysdev_class_store(struct kobject *kobj, struct attribute *attr,
96 const char *buffer, size_t count)
97{
Zhenwen Xu60530af2009-03-03 18:36:02 +080098 struct sysdev_class *class = to_sysdev_class(kobj);
99 struct sysdev_class_attribute *class_attr = to_sysdev_class_attr(attr);
Shaohua Li670dd902006-05-08 13:45:57 +0800100
101 if (class_attr->store)
Andi Kleenc9be0a32010-01-05 12:47:58 +0100102 return class_attr->store(class, class_attr, buffer, count);
Shaohua Li670dd902006-05-08 13:45:57 +0800103 return -EIO;
104}
105
Emese Revfy52cf25d2010-01-19 02:58:23 +0100106static const struct sysfs_ops sysfs_class_ops = {
Shaohua Li670dd902006-05-08 13:45:57 +0800107 .show = sysdev_class_show,
108 .store = sysdev_class_store,
109};
110
111static struct kobj_type ktype_sysdev_class = {
112 .sysfs_ops = &sysfs_class_ops,
113};
114
115int 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}
120EXPORT_SYMBOL_GPL(sysdev_class_create_file);
121
122void 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}
127EXPORT_SYMBOL_GPL(sysdev_class_remove_file);
128
Greg Kroah-Hartmanaade4042007-11-01 09:29:06 -0600129static struct kset *system_kset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Zhenwen Xu60530af2009-03-03 18:36:02 +0800131int sysdev_class_register(struct sysdev_class *cls)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132{
Dave Young9227c472009-05-11 14:18:55 +0800133 int retval;
134
Ben Dooks838ea8e2008-06-12 19:00:34 +0100135 pr_debug("Registering sysdev class '%s'\n", cls->name);
136
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 INIT_LIST_HEAD(&cls->drivers);
Greg Kroah-Hartmanef79df22008-03-09 03:37:16 +0530138 memset(&cls->kset.kobj, 0x00, sizeof(struct kobject));
Greg Kroah-Hartmanaade4042007-11-01 09:29:06 -0600139 cls->kset.kobj.parent = &system_kset->kobj;
Greg Kroah-Hartman3514fac2007-10-16 10:11:44 -0600140 cls->kset.kobj.ktype = &ktype_sysdev_class;
Greg Kroah-Hartmanaade4042007-11-01 09:29:06 -0600141 cls->kset.kobj.kset = system_kset;
Dave Young9227c472009-05-11 14:18:55 +0800142
Greg Kroah-Hartmanacc0e902009-06-02 15:39:55 -0700143 retval = kobject_set_name(&cls->kset.kobj, "%s", cls->name);
Dave Young9227c472009-05-11 14:18:55 +0800144 if (retval)
145 return retval;
146
Andi Kleen38457ab2010-01-05 12:48:02 +0100147 retval = kset_register(&cls->kset);
148 if (!retval && cls->attrs)
149 retval = sysfs_create_files(&cls->kset.kobj,
150 (const struct attribute **)cls->attrs);
151 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152}
153
Zhenwen Xu60530af2009-03-03 18:36:02 +0800154void sysdev_class_unregister(struct sysdev_class *cls)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155{
156 pr_debug("Unregistering sysdev class '%s'\n",
157 kobject_name(&cls->kset.kobj));
Andi Kleen38457ab2010-01-05 12:48:02 +0100158 if (cls->attrs)
159 sysfs_remove_files(&cls->kset.kobj,
160 (const struct attribute **)cls->attrs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 kset_unregister(&cls->kset);
162}
163
164EXPORT_SYMBOL_GPL(sysdev_class_register);
165EXPORT_SYMBOL_GPL(sysdev_class_unregister);
166
Matthias Kaehlcke9f3f7762007-05-23 14:19:42 -0700167static DEFINE_MUTEX(sysdev_drivers_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Borislav Petkovf4203e32011-02-01 17:19:56 +0100169/*
170 * @dev != NULL means that we're unwinding because some drv->add()
171 * failed for some reason. You need to grab sysdev_drivers_lock before
172 * calling this.
173 */
174static void __sysdev_driver_remove(struct sysdev_class *cls,
175 struct sysdev_driver *drv,
176 struct sys_device *from_dev)
177{
178 struct sys_device *dev = from_dev;
179
180 list_del_init(&drv->entry);
181 if (!cls)
182 return;
183
184 if (!drv->remove)
185 goto kset_put;
186
187 if (dev)
188 list_for_each_entry_continue_reverse(dev, &cls->kset.list,
189 kobj.entry)
190 drv->remove(dev);
191 else
192 list_for_each_entry(dev, &cls->kset.list, kobj.entry)
193 drv->remove(dev);
194
195kset_put:
196 kset_put(&cls->kset);
197}
198
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199/**
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300200 * sysdev_driver_register - Register auxiliary driver
Akinobu Mita44b760a2007-08-19 16:51:14 +0900201 * @cls: Device class driver belongs to.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 * @drv: Driver.
203 *
Akinobu Mita44b760a2007-08-19 16:51:14 +0900204 * @drv is inserted into @cls->drivers to be
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 * called on each operation on devices of that class. The refcount
206 * of @cls is incremented.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 */
Akinobu Mita44b760a2007-08-19 16:51:14 +0900208int sysdev_driver_register(struct sysdev_class *cls, struct sysdev_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209{
Borislav Petkovf4203e32011-02-01 17:19:56 +0100210 struct sys_device *dev = NULL;
Akinobu Mita44b760a2007-08-19 16:51:14 +0900211 int err = 0;
212
Ben Dooksda009f32008-03-04 15:09:06 -0800213 if (!cls) {
Borislav Petkov345279b2011-02-01 17:19:57 +0100214 WARN(1, KERN_WARNING "sysdev: invalid class passed to %s!\n",
215 __func__);
Ben Dooksda009f32008-03-04 15:09:06 -0800216 return -EINVAL;
217 }
218
219 /* Check whether this driver has already been added to a class. */
Arjan van de Venf810a5c2008-07-25 19:45:39 -0700220 if (drv->entry.next && !list_empty(&drv->entry))
221 WARN(1, KERN_WARNING "sysdev: class %s: driver (%p) has already"
Ben Dooksda009f32008-03-04 15:09:06 -0800222 " been registered to a class, something is wrong, but "
223 "will forge on!\n", cls->name, drv);
Ben Dooksda009f32008-03-04 15:09:06 -0800224
Matthias Kaehlcke9f3f7762007-05-23 14:19:42 -0700225 mutex_lock(&sysdev_drivers_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 if (cls && kset_get(&cls->kset)) {
227 list_add_tail(&drv->entry, &cls->drivers);
228
229 /* If devices of this class already exist, tell the driver */
230 if (drv->add) {
Borislav Petkovf4203e32011-02-01 17:19:56 +0100231 list_for_each_entry(dev, &cls->kset.list, kobj.entry) {
232 err = drv->add(dev);
233 if (err)
234 goto unwind;
235 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 }
Akinobu Mita44b760a2007-08-19 16:51:14 +0900237 } else {
238 err = -EINVAL;
Arjan van de Venf810a5c2008-07-25 19:45:39 -0700239 WARN(1, KERN_ERR "%s: invalid device class\n", __func__);
Akinobu Mita44b760a2007-08-19 16:51:14 +0900240 }
Borislav Petkovf4203e32011-02-01 17:19:56 +0100241
242 goto unlock;
243
244unwind:
245 __sysdev_driver_remove(cls, drv, dev);
246
247unlock:
Matthias Kaehlcke9f3f7762007-05-23 14:19:42 -0700248 mutex_unlock(&sysdev_drivers_lock);
Akinobu Mita44b760a2007-08-19 16:51:14 +0900249 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250}
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252/**
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300253 * sysdev_driver_unregister - Remove an auxiliary driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 * @cls: Class driver belongs to.
255 * @drv: Driver.
256 */
Zhenwen Xu60530af2009-03-03 18:36:02 +0800257void sysdev_driver_unregister(struct sysdev_class *cls,
258 struct sysdev_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259{
Matthias Kaehlcke9f3f7762007-05-23 14:19:42 -0700260 mutex_lock(&sysdev_drivers_lock);
Borislav Petkovf4203e32011-02-01 17:19:56 +0100261 __sysdev_driver_remove(cls, drv, NULL);
Matthias Kaehlcke9f3f7762007-05-23 14:19:42 -0700262 mutex_unlock(&sysdev_drivers_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264EXPORT_SYMBOL_GPL(sysdev_driver_register);
265EXPORT_SYMBOL_GPL(sysdev_driver_unregister);
266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267/**
268 * sysdev_register - add a system device to the tree
269 * @sysdev: device in question
270 *
271 */
Zhenwen Xu60530af2009-03-03 18:36:02 +0800272int sysdev_register(struct sys_device *sysdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273{
274 int error;
Zhenwen Xu60530af2009-03-03 18:36:02 +0800275 struct sysdev_class *cls = sysdev->cls;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
277 if (!cls)
278 return -EINVAL;
279
Ben Dooks838ea8e2008-06-12 19:00:34 +0100280 pr_debug("Registering sys device of class '%s'\n",
281 kobject_name(&cls->kset.kobj));
Greg Kroah-Hartman61030bf2007-12-17 15:54:39 -0400282
Greg Kroah-Hartmanef79df22008-03-09 03:37:16 +0530283 /* initialize the kobject to 0, in case it had previously been used */
284 memset(&sysdev->kobj, 0x00, sizeof(struct kobject));
285
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 /* Make sure the kset is set */
287 sysdev->kobj.kset = &cls->kset;
288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 /* Register the object */
Greg Kroah-Hartman61030bf2007-12-17 15:54:39 -0400290 error = kobject_init_and_add(&sysdev->kobj, &ktype_sysdev, NULL,
291 "%s%d", kobject_name(&cls->kset.kobj),
292 sysdev->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
294 if (!error) {
Zhenwen Xu60530af2009-03-03 18:36:02 +0800295 struct sysdev_driver *drv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Ben Dooks838ea8e2008-06-12 19:00:34 +0100297 pr_debug("Registering sys device '%s'\n",
298 kobject_name(&sysdev->kobj));
299
Matthias Kaehlcke9f3f7762007-05-23 14:19:42 -0700300 mutex_lock(&sysdev_drivers_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 /* Generic notification is implicit, because it's that
302 * code that should have called us.
303 */
304
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300305 /* Notify class auxiliary drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 list_for_each_entry(drv, &cls->drivers, entry) {
307 if (drv->add)
308 drv->add(sysdev);
309 }
Matthias Kaehlcke9f3f7762007-05-23 14:19:42 -0700310 mutex_unlock(&sysdev_drivers_lock);
Xiaotian Feng79f03132009-07-24 17:31:41 +0800311 kobject_uevent(&sysdev->kobj, KOBJ_ADD);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 }
Ben Dooks838ea8e2008-06-12 19:00:34 +0100313
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 return error;
315}
316
Zhenwen Xu60530af2009-03-03 18:36:02 +0800317void sysdev_unregister(struct sys_device *sysdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318{
Zhenwen Xu60530af2009-03-03 18:36:02 +0800319 struct sysdev_driver *drv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
Matthias Kaehlcke9f3f7762007-05-23 14:19:42 -0700321 mutex_lock(&sysdev_drivers_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 list_for_each_entry(drv, &sysdev->cls->drivers, entry) {
323 if (drv->remove)
324 drv->remove(sysdev);
325 }
Matthias Kaehlcke9f3f7762007-05-23 14:19:42 -0700326 mutex_unlock(&sysdev_drivers_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Greg Kroah-Hartmanc10997f2007-12-20 08:13:05 -0800328 kobject_put(&sysdev->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329}
330
Rafael J. Wysocki2e711c02011-04-26 19:15:07 +0200331EXPORT_SYMBOL_GPL(sysdev_register);
332EXPORT_SYMBOL_GPL(sysdev_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
334int __init system_bus_init(void)
335{
Greg Kroah-Hartmanaade4042007-11-01 09:29:06 -0600336 system_kset = kset_create_and_add("system", NULL, &devices_kset->kobj);
337 if (!system_kset)
338 return -ENOMEM;
339 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340}
341
Andi Kleen98007942008-07-01 18:48:42 +0200342#define to_ext_attr(x) container_of(x, struct sysdev_ext_attribute, attr)
343
344ssize_t sysdev_store_ulong(struct sys_device *sysdev,
345 struct sysdev_attribute *attr,
346 const char *buf, size_t size)
347{
348 struct sysdev_ext_attribute *ea = to_ext_attr(attr);
349 char *end;
350 unsigned long new = simple_strtoul(buf, &end, 0);
351 if (end == buf)
352 return -EINVAL;
353 *(unsigned long *)(ea->var) = new;
Andi Kleen4e318d72008-10-13 12:03:03 +0200354 /* Always return full write size even if we didn't consume all */
355 return size;
Andi Kleen98007942008-07-01 18:48:42 +0200356}
357EXPORT_SYMBOL_GPL(sysdev_store_ulong);
358
359ssize_t sysdev_show_ulong(struct sys_device *sysdev,
360 struct sysdev_attribute *attr,
361 char *buf)
362{
363 struct sysdev_ext_attribute *ea = to_ext_attr(attr);
364 return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
365}
366EXPORT_SYMBOL_GPL(sysdev_show_ulong);
367
368ssize_t sysdev_store_int(struct sys_device *sysdev,
369 struct sysdev_attribute *attr,
370 const char *buf, size_t size)
371{
372 struct sysdev_ext_attribute *ea = to_ext_attr(attr);
373 char *end;
374 long new = simple_strtol(buf, &end, 0);
375 if (end == buf || new > INT_MAX || new < INT_MIN)
376 return -EINVAL;
377 *(int *)(ea->var) = new;
Andi Kleen4e318d72008-10-13 12:03:03 +0200378 /* Always return full write size even if we didn't consume all */
379 return size;
Andi Kleen98007942008-07-01 18:48:42 +0200380}
381EXPORT_SYMBOL_GPL(sysdev_store_int);
382
383ssize_t sysdev_show_int(struct sys_device *sysdev,
384 struct sysdev_attribute *attr,
385 char *buf)
386{
387 struct sysdev_ext_attribute *ea = to_ext_attr(attr);
388 return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
389}
390EXPORT_SYMBOL_GPL(sysdev_show_int);
391