2 * sys.c - pseudo-bus for system 'devices' (cpus, PICs, timers, etc)
4 * Copyright (c) 2002-3 Patrick Mochel
5 * 2002-3 Open Source Development Lab
7 * This file is released under the GPLv2
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.
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>
23 #include <linux/device.h>
24 #include <linux/mutex.h>
25 #include <linux/interrupt.h>
29 #define to_sysdev(k) container_of(k, struct sys_device, kobj)
30 #define to_sysdev_attr(a) container_of(a, struct sysdev_attribute, attr)
34 sysdev_show(struct kobject
*kobj
, struct attribute
*attr
, char *buffer
)
36 struct sys_device
*sysdev
= to_sysdev(kobj
);
37 struct sysdev_attribute
*sysdev_attr
= to_sysdev_attr(attr
);
39 if (sysdev_attr
->show
)
40 return sysdev_attr
->show(sysdev
, sysdev_attr
, buffer
);
46 sysdev_store(struct kobject
*kobj
, struct attribute
*attr
,
47 const char *buffer
, size_t count
)
49 struct sys_device
*sysdev
= to_sysdev(kobj
);
50 struct sysdev_attribute
*sysdev_attr
= to_sysdev_attr(attr
);
52 if (sysdev_attr
->store
)
53 return sysdev_attr
->store(sysdev
, sysdev_attr
, buffer
, count
);
57 static struct sysfs_ops sysfs_ops
= {
59 .store
= sysdev_store
,
62 static struct kobj_type ktype_sysdev
= {
63 .sysfs_ops
= &sysfs_ops
,
67 int sysdev_create_file(struct sys_device
*s
, struct sysdev_attribute
*a
)
69 return sysfs_create_file(&s
->kobj
, &a
->attr
);
73 void sysdev_remove_file(struct sys_device
*s
, struct sysdev_attribute
*a
)
75 sysfs_remove_file(&s
->kobj
, &a
->attr
);
78 EXPORT_SYMBOL_GPL(sysdev_create_file
);
79 EXPORT_SYMBOL_GPL(sysdev_remove_file
);
81 #define to_sysdev_class(k) container_of(k, struct sysdev_class, kset.kobj)
82 #define to_sysdev_class_attr(a) container_of(a, \
83 struct sysdev_class_attribute, attr)
85 static ssize_t
sysdev_class_show(struct kobject
*kobj
, struct attribute
*attr
,
88 struct sysdev_class
*class = to_sysdev_class(kobj
);
89 struct sysdev_class_attribute
*class_attr
= to_sysdev_class_attr(attr
);
92 return class_attr
->show(class, buffer
);
96 static ssize_t
sysdev_class_store(struct kobject
*kobj
, struct attribute
*attr
,
97 const char *buffer
, size_t count
)
99 struct sysdev_class
*class = to_sysdev_class(kobj
);
100 struct sysdev_class_attribute
*class_attr
= to_sysdev_class_attr(attr
);
102 if (class_attr
->store
)
103 return class_attr
->store(class, buffer
, count
);
107 static struct sysfs_ops sysfs_class_ops
= {
108 .show
= sysdev_class_show
,
109 .store
= sysdev_class_store
,
112 static struct kobj_type ktype_sysdev_class
= {
113 .sysfs_ops
= &sysfs_class_ops
,
116 int sysdev_class_create_file(struct sysdev_class
*c
,
117 struct sysdev_class_attribute
*a
)
119 return sysfs_create_file(&c
->kset
.kobj
, &a
->attr
);
121 EXPORT_SYMBOL_GPL(sysdev_class_create_file
);
123 void sysdev_class_remove_file(struct sysdev_class
*c
,
124 struct sysdev_class_attribute
*a
)
126 sysfs_remove_file(&c
->kset
.kobj
, &a
->attr
);
128 EXPORT_SYMBOL_GPL(sysdev_class_remove_file
);
130 static struct kset
*system_kset
;
132 int sysdev_class_register(struct sysdev_class
*cls
)
136 pr_debug("Registering sysdev class '%s'\n", cls
->name
);
138 INIT_LIST_HEAD(&cls
->drivers
);
139 memset(&cls
->kset
.kobj
, 0x00, sizeof(struct kobject
));
140 cls
->kset
.kobj
.parent
= &system_kset
->kobj
;
141 cls
->kset
.kobj
.ktype
= &ktype_sysdev_class
;
142 cls
->kset
.kobj
.kset
= system_kset
;
144 retval
= kobject_set_name(&cls
->kset
.kobj
, "%s", cls
->name
);
148 return kset_register(&cls
->kset
);
151 void sysdev_class_unregister(struct sysdev_class
*cls
)
153 pr_debug("Unregistering sysdev class '%s'\n",
154 kobject_name(&cls
->kset
.kobj
));
155 kset_unregister(&cls
->kset
);
158 EXPORT_SYMBOL_GPL(sysdev_class_register
);
159 EXPORT_SYMBOL_GPL(sysdev_class_unregister
);
161 static DEFINE_MUTEX(sysdev_drivers_lock
);
164 * sysdev_driver_register - Register auxillary driver
165 * @cls: Device class driver belongs to.
168 * @drv is inserted into @cls->drivers to be
169 * called on each operation on devices of that class. The refcount
170 * of @cls is incremented.
173 int sysdev_driver_register(struct sysdev_class
*cls
, struct sysdev_driver
*drv
)
178 WARN(1, KERN_WARNING
"sysdev: invalid class passed to "
179 "sysdev_driver_register!\n");
183 /* Check whether this driver has already been added to a class. */
184 if (drv
->entry
.next
&& !list_empty(&drv
->entry
))
185 WARN(1, KERN_WARNING
"sysdev: class %s: driver (%p) has already"
186 " been registered to a class, something is wrong, but "
187 "will forge on!\n", cls
->name
, drv
);
189 mutex_lock(&sysdev_drivers_lock
);
190 if (cls
&& kset_get(&cls
->kset
)) {
191 list_add_tail(&drv
->entry
, &cls
->drivers
);
193 /* If devices of this class already exist, tell the driver */
195 struct sys_device
*dev
;
196 list_for_each_entry(dev
, &cls
->kset
.list
, kobj
.entry
)
201 WARN(1, KERN_ERR
"%s: invalid device class\n", __func__
);
203 mutex_unlock(&sysdev_drivers_lock
);
209 * sysdev_driver_unregister - Remove an auxillary driver.
210 * @cls: Class driver belongs to.
213 void sysdev_driver_unregister(struct sysdev_class
*cls
,
214 struct sysdev_driver
*drv
)
216 mutex_lock(&sysdev_drivers_lock
);
217 list_del_init(&drv
->entry
);
220 struct sys_device
*dev
;
221 list_for_each_entry(dev
, &cls
->kset
.list
, kobj
.entry
)
224 kset_put(&cls
->kset
);
226 mutex_unlock(&sysdev_drivers_lock
);
229 EXPORT_SYMBOL_GPL(sysdev_driver_register
);
230 EXPORT_SYMBOL_GPL(sysdev_driver_unregister
);
235 * sysdev_register - add a system device to the tree
236 * @sysdev: device in question
239 int sysdev_register(struct sys_device
*sysdev
)
242 struct sysdev_class
*cls
= sysdev
->cls
;
247 pr_debug("Registering sys device of class '%s'\n",
248 kobject_name(&cls
->kset
.kobj
));
250 /* initialize the kobject to 0, in case it had previously been used */
251 memset(&sysdev
->kobj
, 0x00, sizeof(struct kobject
));
253 /* Make sure the kset is set */
254 sysdev
->kobj
.kset
= &cls
->kset
;
256 /* Register the object */
257 error
= kobject_init_and_add(&sysdev
->kobj
, &ktype_sysdev
, NULL
,
258 "%s%d", kobject_name(&cls
->kset
.kobj
),
262 struct sysdev_driver
*drv
;
264 pr_debug("Registering sys device '%s'\n",
265 kobject_name(&sysdev
->kobj
));
267 mutex_lock(&sysdev_drivers_lock
);
268 /* Generic notification is implicit, because it's that
269 * code that should have called us.
272 /* Notify class auxillary drivers */
273 list_for_each_entry(drv
, &cls
->drivers
, entry
) {
277 mutex_unlock(&sysdev_drivers_lock
);
278 kobject_uevent(&sysdev
->kobj
, KOBJ_ADD
);
284 void sysdev_unregister(struct sys_device
*sysdev
)
286 struct sysdev_driver
*drv
;
288 mutex_lock(&sysdev_drivers_lock
);
289 list_for_each_entry(drv
, &sysdev
->cls
->drivers
, entry
) {
293 mutex_unlock(&sysdev_drivers_lock
);
295 kobject_put(&sysdev
->kobj
);
301 * sysdev_shutdown - Shut down all system devices.
303 * Loop over each class of system devices, and the devices in each
304 * of those classes. For each device, we call the shutdown method for
305 * each driver registered for the device - the auxillaries,
306 * and the class driver.
308 * Note: The list is iterated in reverse order, so that we shut down
309 * child devices before we shut down their parents. The list ordering
310 * is guaranteed by virtue of the fact that child devices are registered
311 * after their parents.
313 void sysdev_shutdown(void)
315 struct sysdev_class
*cls
;
317 pr_debug("Shutting Down System Devices\n");
319 mutex_lock(&sysdev_drivers_lock
);
320 list_for_each_entry_reverse(cls
, &system_kset
->list
, kset
.kobj
.entry
) {
321 struct sys_device
*sysdev
;
323 pr_debug("Shutting down type '%s':\n",
324 kobject_name(&cls
->kset
.kobj
));
326 list_for_each_entry(sysdev
, &cls
->kset
.list
, kobj
.entry
) {
327 struct sysdev_driver
*drv
;
328 pr_debug(" %s\n", kobject_name(&sysdev
->kobj
));
330 /* Call auxillary drivers first */
331 list_for_each_entry(drv
, &cls
->drivers
, entry
) {
333 drv
->shutdown(sysdev
);
336 /* Now call the generic one */
338 cls
->shutdown(sysdev
);
341 mutex_unlock(&sysdev_drivers_lock
);
344 static void __sysdev_resume(struct sys_device
*dev
)
346 struct sysdev_class
*cls
= dev
->cls
;
347 struct sysdev_driver
*drv
;
349 /* First, call the class-specific one */
352 WARN_ONCE(!irqs_disabled(),
353 "Interrupts enabled after %pF\n", cls
->resume
);
355 /* Call auxillary drivers next. */
356 list_for_each_entry(drv
, &cls
->drivers
, entry
) {
359 WARN_ONCE(!irqs_disabled(),
360 "Interrupts enabled after %pF\n", drv
->resume
);
365 * sysdev_suspend - Suspend all system devices.
366 * @state: Power state to enter.
368 * We perform an almost identical operation as sysdev_shutdown()
369 * above, though calling ->suspend() instead. Interrupts are disabled
370 * when this called. Devices are responsible for both saving state and
371 * quiescing or powering down the device.
373 * This is only called by the device PM core, so we let them handle
374 * all synchronization.
376 int sysdev_suspend(pm_message_t state
)
378 struct sysdev_class
*cls
;
379 struct sys_device
*sysdev
, *err_dev
;
380 struct sysdev_driver
*drv
, *err_drv
;
383 pr_debug("Checking wake-up interrupts\n");
385 /* Return error code if there are any wake-up interrupts pending */
386 ret
= check_wakeup_irqs();
390 WARN_ONCE(!irqs_disabled(),
391 "Interrupts enabled while suspending system devices\n");
393 pr_debug("Suspending System Devices\n");
395 list_for_each_entry_reverse(cls
, &system_kset
->list
, kset
.kobj
.entry
) {
396 pr_debug("Suspending type '%s':\n",
397 kobject_name(&cls
->kset
.kobj
));
399 list_for_each_entry(sysdev
, &cls
->kset
.list
, kobj
.entry
) {
400 pr_debug(" %s\n", kobject_name(&sysdev
->kobj
));
402 /* Call auxillary drivers first */
403 list_for_each_entry(drv
, &cls
->drivers
, entry
) {
405 ret
= drv
->suspend(sysdev
, state
);
409 WARN_ONCE(!irqs_disabled(),
410 "Interrupts enabled after %pF\n",
414 /* Now call the generic one */
416 ret
= cls
->suspend(sysdev
, state
);
419 WARN_ONCE(!irqs_disabled(),
420 "Interrupts enabled after %pF\n",
426 /* resume current sysdev */
429 printk(KERN_ERR
"Class suspend failed for %s\n",
430 kobject_name(&sysdev
->kobj
));
434 printk(KERN_ERR
"Class driver suspend failed for %s\n",
435 kobject_name(&sysdev
->kobj
));
436 list_for_each_entry(err_drv
, &cls
->drivers
, entry
) {
440 err_drv
->resume(sysdev
);
443 /* resume other sysdevs in current class */
444 list_for_each_entry(err_dev
, &cls
->kset
.list
, kobj
.entry
) {
445 if (err_dev
== sysdev
)
447 pr_debug(" %s\n", kobject_name(&err_dev
->kobj
));
448 __sysdev_resume(err_dev
);
451 /* resume other classes */
452 list_for_each_entry_continue(cls
, &system_kset
->list
, kset
.kobj
.entry
) {
453 list_for_each_entry(err_dev
, &cls
->kset
.list
, kobj
.entry
) {
454 pr_debug(" %s\n", kobject_name(&err_dev
->kobj
));
455 __sysdev_resume(err_dev
);
460 EXPORT_SYMBOL_GPL(sysdev_suspend
);
463 * sysdev_resume - Bring system devices back to life.
465 * Similar to sysdev_suspend(), but we iterate the list forwards
466 * to guarantee that parent devices are resumed before their children.
468 * Note: Interrupts are disabled when called.
470 int sysdev_resume(void)
472 struct sysdev_class
*cls
;
474 WARN_ONCE(!irqs_disabled(),
475 "Interrupts enabled while resuming system devices\n");
477 pr_debug("Resuming System Devices\n");
479 list_for_each_entry(cls
, &system_kset
->list
, kset
.kobj
.entry
) {
480 struct sys_device
*sysdev
;
482 pr_debug("Resuming type '%s':\n",
483 kobject_name(&cls
->kset
.kobj
));
485 list_for_each_entry(sysdev
, &cls
->kset
.list
, kobj
.entry
) {
486 pr_debug(" %s\n", kobject_name(&sysdev
->kobj
));
488 __sysdev_resume(sysdev
);
493 EXPORT_SYMBOL_GPL(sysdev_resume
);
495 int __init
system_bus_init(void)
497 system_kset
= kset_create_and_add("system", NULL
, &devices_kset
->kobj
);
503 EXPORT_SYMBOL_GPL(sysdev_register
);
504 EXPORT_SYMBOL_GPL(sysdev_unregister
);
506 #define to_ext_attr(x) container_of(x, struct sysdev_ext_attribute, attr)
508 ssize_t
sysdev_store_ulong(struct sys_device
*sysdev
,
509 struct sysdev_attribute
*attr
,
510 const char *buf
, size_t size
)
512 struct sysdev_ext_attribute
*ea
= to_ext_attr(attr
);
514 unsigned long new = simple_strtoul(buf
, &end
, 0);
517 *(unsigned long *)(ea
->var
) = new;
518 /* Always return full write size even if we didn't consume all */
521 EXPORT_SYMBOL_GPL(sysdev_store_ulong
);
523 ssize_t
sysdev_show_ulong(struct sys_device
*sysdev
,
524 struct sysdev_attribute
*attr
,
527 struct sysdev_ext_attribute
*ea
= to_ext_attr(attr
);
528 return snprintf(buf
, PAGE_SIZE
, "%lx\n", *(unsigned long *)(ea
->var
));
530 EXPORT_SYMBOL_GPL(sysdev_show_ulong
);
532 ssize_t
sysdev_store_int(struct sys_device
*sysdev
,
533 struct sysdev_attribute
*attr
,
534 const char *buf
, size_t size
)
536 struct sysdev_ext_attribute
*ea
= to_ext_attr(attr
);
538 long new = simple_strtol(buf
, &end
, 0);
539 if (end
== buf
|| new > INT_MAX
|| new < INT_MIN
)
541 *(int *)(ea
->var
) = new;
542 /* Always return full write size even if we didn't consume all */
545 EXPORT_SYMBOL_GPL(sysdev_store_int
);
547 ssize_t
sysdev_show_int(struct sys_device
*sysdev
,
548 struct sysdev_attribute
*attr
,
551 struct sysdev_ext_attribute
*ea
= to_ext_attr(attr
);
552 return snprintf(buf
, PAGE_SIZE
, "%d\n", *(int *)(ea
->var
));
554 EXPORT_SYMBOL_GPL(sysdev_show_int
);