2 * sysfs.c - sysfs support
4 * (C) 2006-2007 Shaohua Li <shaohua.li@intel.com>
6 * This code is licenced under the GPL.
9 #include <linux/kernel.h>
10 #include <linux/cpuidle.h>
11 #include <linux/sysfs.h>
12 #include <linux/slab.h>
13 #include <linux/cpu.h>
14 #include <linux/completion.h>
15 #include <linux/capability.h>
16 #include <linux/device.h>
17 #include <linux/kobject.h>
21 static unsigned int sysfs_switch;
22 static int __init cpuidle_sysfs_setup(char *unused)
27 __setup("cpuidle_sysfs_switch", cpuidle_sysfs_setup);
29 static ssize_t show_available_governors(struct device *dev,
30 struct device_attribute *attr,
34 struct cpuidle_governor *tmp;
36 mutex_lock(&cpuidle_lock);
37 list_for_each_entry(tmp, &cpuidle_governors, governor_list) {
38 if (i >= (ssize_t) ((PAGE_SIZE/sizeof(char)) -
39 CPUIDLE_NAME_LEN - 2))
41 i += scnprintf(&buf[i], CPUIDLE_NAME_LEN, "%s ", tmp->name);
45 i+= sprintf(&buf[i], "\n");
46 mutex_unlock(&cpuidle_lock);
50 static ssize_t show_current_driver(struct device *dev,
51 struct device_attribute *attr,
55 struct cpuidle_driver *drv;
57 spin_lock(&cpuidle_driver_lock);
58 drv = cpuidle_get_driver();
60 ret = sprintf(buf, "%s\n", drv->name);
62 ret = sprintf(buf, "none\n");
63 spin_unlock(&cpuidle_driver_lock);
68 static ssize_t show_current_governor(struct device *dev,
69 struct device_attribute *attr,
74 mutex_lock(&cpuidle_lock);
75 if (cpuidle_curr_governor)
76 ret = sprintf(buf, "%s\n", cpuidle_curr_governor->name);
78 ret = sprintf(buf, "none\n");
79 mutex_unlock(&cpuidle_lock);
84 static ssize_t store_current_governor(struct device *dev,
85 struct device_attribute *attr,
86 const char *buf, size_t count)
88 char gov_name[CPUIDLE_NAME_LEN];
91 struct cpuidle_governor *gov;
93 if (!len || len >= sizeof(gov_name))
96 memcpy(gov_name, buf, len);
98 if (gov_name[len - 1] == '\n')
99 gov_name[--len] = '\0';
101 mutex_lock(&cpuidle_lock);
103 list_for_each_entry(gov, &cpuidle_governors, governor_list) {
104 if (strlen(gov->name) == len && !strcmp(gov->name, gov_name)) {
105 ret = cpuidle_switch_governor(gov);
110 mutex_unlock(&cpuidle_lock);
118 static DEVICE_ATTR(current_driver, 0444, show_current_driver, NULL);
119 static DEVICE_ATTR(current_governor_ro, 0444, show_current_governor, NULL);
121 static struct attribute *cpuidle_default_attrs[] = {
122 &dev_attr_current_driver.attr,
123 &dev_attr_current_governor_ro.attr,
127 static DEVICE_ATTR(available_governors, 0444, show_available_governors, NULL);
128 static DEVICE_ATTR(current_governor, 0644, show_current_governor,
129 store_current_governor);
131 static struct attribute *cpuidle_switch_attrs[] = {
132 &dev_attr_available_governors.attr,
133 &dev_attr_current_driver.attr,
134 &dev_attr_current_governor.attr,
138 static struct attribute_group cpuidle_attr_group = {
139 .attrs = cpuidle_default_attrs,
144 * cpuidle_add_interface - add CPU global sysfs attributes
146 int cpuidle_add_interface(struct device *dev)
149 cpuidle_attr_group.attrs = cpuidle_switch_attrs;
151 return sysfs_create_group(&dev->kobj, &cpuidle_attr_group);
155 * cpuidle_remove_interface - remove CPU global sysfs attributes
157 void cpuidle_remove_interface(struct device *dev)
159 sysfs_remove_group(&dev->kobj, &cpuidle_attr_group);
162 struct cpuidle_attr {
163 struct attribute attr;
164 ssize_t (*show)(struct cpuidle_device *, char *);
165 ssize_t (*store)(struct cpuidle_device *, const char *, size_t count);
168 #define define_one_ro(_name, show) \
169 static struct cpuidle_attr attr_##_name = __ATTR(_name, 0444, show, NULL)
170 #define define_one_rw(_name, show, store) \
171 static struct cpuidle_attr attr_##_name = __ATTR(_name, 0644, show, store)
173 #define attr_to_cpuidleattr(a) container_of(a, struct cpuidle_attr, attr)
175 struct cpuidle_device_kobj {
176 struct cpuidle_device *dev;
177 struct completion kobj_unregister;
181 static inline struct cpuidle_device *to_cpuidle_device(struct kobject *kobj)
183 struct cpuidle_device_kobj *kdev =
184 container_of(kobj, struct cpuidle_device_kobj, kobj);
189 static ssize_t cpuidle_show(struct kobject *kobj, struct attribute *attr,
193 struct cpuidle_device *dev = to_cpuidle_device(kobj);
194 struct cpuidle_attr *cattr = attr_to_cpuidleattr(attr);
197 mutex_lock(&cpuidle_lock);
198 ret = cattr->show(dev, buf);
199 mutex_unlock(&cpuidle_lock);
204 static ssize_t cpuidle_store(struct kobject *kobj, struct attribute *attr,
205 const char *buf, size_t count)
208 struct cpuidle_device *dev = to_cpuidle_device(kobj);
209 struct cpuidle_attr *cattr = attr_to_cpuidleattr(attr);
212 mutex_lock(&cpuidle_lock);
213 ret = cattr->store(dev, buf, count);
214 mutex_unlock(&cpuidle_lock);
219 static const struct sysfs_ops cpuidle_sysfs_ops = {
220 .show = cpuidle_show,
221 .store = cpuidle_store,
224 static void cpuidle_sysfs_release(struct kobject *kobj)
226 struct cpuidle_device_kobj *kdev =
227 container_of(kobj, struct cpuidle_device_kobj, kobj);
229 complete(&kdev->kobj_unregister);
232 static struct kobj_type ktype_cpuidle = {
233 .sysfs_ops = &cpuidle_sysfs_ops,
234 .release = cpuidle_sysfs_release,
237 struct cpuidle_state_attr {
238 struct attribute attr;
239 ssize_t (*show)(struct cpuidle_state *, \
240 struct cpuidle_state_usage *, char *);
241 ssize_t (*store)(struct cpuidle_state *, \
242 struct cpuidle_state_usage *, const char *, size_t);
245 #define define_one_state_ro(_name, show) \
246 static struct cpuidle_state_attr attr_##_name = __ATTR(_name, 0444, show, NULL)
248 #define define_one_state_rw(_name, show, store) \
249 static struct cpuidle_state_attr attr_##_name = __ATTR(_name, 0644, show, store)
251 #define define_show_state_function(_name) \
252 static ssize_t show_state_##_name(struct cpuidle_state *state, \
253 struct cpuidle_state_usage *state_usage, char *buf) \
255 return sprintf(buf, "%u\n", state->_name);\
258 #define define_store_state_ull_function(_name) \
259 static ssize_t store_state_##_name(struct cpuidle_state *state, \
260 struct cpuidle_state_usage *state_usage, \
261 const char *buf, size_t size) \
263 unsigned long long value; \
265 if (!capable(CAP_SYS_ADMIN)) \
267 err = kstrtoull(buf, 0, &value); \
271 state_usage->_name = 1; \
273 state_usage->_name = 0; \
277 #define define_show_state_ull_function(_name) \
278 static ssize_t show_state_##_name(struct cpuidle_state *state, \
279 struct cpuidle_state_usage *state_usage, \
282 return sprintf(buf, "%llu\n", state_usage->_name);\
285 #define define_show_state_str_function(_name) \
286 static ssize_t show_state_##_name(struct cpuidle_state *state, \
287 struct cpuidle_state_usage *state_usage, \
290 if (state->_name[0] == '\0')\
291 return sprintf(buf, "<null>\n");\
292 return sprintf(buf, "%s\n", state->_name);\
295 define_show_state_function(exit_latency)
296 define_show_state_function(target_residency)
297 define_show_state_function(power_usage)
298 define_show_state_ull_function(usage)
299 define_show_state_ull_function(time)
300 define_show_state_str_function(name)
301 define_show_state_str_function(desc)
302 define_show_state_ull_function(disable)
303 define_store_state_ull_function(disable)
305 define_one_state_ro(name, show_state_name);
306 define_one_state_ro(desc, show_state_desc);
307 define_one_state_ro(latency, show_state_exit_latency);
308 define_one_state_ro(residency, show_state_target_residency);
309 define_one_state_ro(power, show_state_power_usage);
310 define_one_state_ro(usage, show_state_usage);
311 define_one_state_ro(time, show_state_time);
312 define_one_state_rw(disable, show_state_disable, store_state_disable);
314 static struct attribute *cpuidle_state_default_attrs[] = {
318 &attr_residency.attr,
326 struct cpuidle_state_kobj {
327 struct cpuidle_state *state;
328 struct cpuidle_state_usage *state_usage;
329 struct completion kobj_unregister;
333 #define kobj_to_state_obj(k) container_of(k, struct cpuidle_state_kobj, kobj)
334 #define kobj_to_state(k) (kobj_to_state_obj(k)->state)
335 #define kobj_to_state_usage(k) (kobj_to_state_obj(k)->state_usage)
336 #define attr_to_stateattr(a) container_of(a, struct cpuidle_state_attr, attr)
338 static ssize_t cpuidle_state_show(struct kobject *kobj, struct attribute *attr,
342 struct cpuidle_state *state = kobj_to_state(kobj);
343 struct cpuidle_state_usage *state_usage = kobj_to_state_usage(kobj);
344 struct cpuidle_state_attr * cattr = attr_to_stateattr(attr);
347 ret = cattr->show(state, state_usage, buf);
352 static ssize_t cpuidle_state_store(struct kobject *kobj, struct attribute *attr,
353 const char *buf, size_t size)
356 struct cpuidle_state *state = kobj_to_state(kobj);
357 struct cpuidle_state_usage *state_usage = kobj_to_state_usage(kobj);
358 struct cpuidle_state_attr *cattr = attr_to_stateattr(attr);
361 ret = cattr->store(state, state_usage, buf, size);
366 static const struct sysfs_ops cpuidle_state_sysfs_ops = {
367 .show = cpuidle_state_show,
368 .store = cpuidle_state_store,
371 static void cpuidle_state_sysfs_release(struct kobject *kobj)
373 struct cpuidle_state_kobj *state_obj = kobj_to_state_obj(kobj);
375 complete(&state_obj->kobj_unregister);
378 static struct kobj_type ktype_state_cpuidle = {
379 .sysfs_ops = &cpuidle_state_sysfs_ops,
380 .default_attrs = cpuidle_state_default_attrs,
381 .release = cpuidle_state_sysfs_release,
384 static inline void cpuidle_free_state_kobj(struct cpuidle_device *device, int i)
386 kobject_put(&device->kobjs[i]->kobj);
387 wait_for_completion(&device->kobjs[i]->kobj_unregister);
388 kfree(device->kobjs[i]);
389 device->kobjs[i] = NULL;
393 * cpuidle_add_state_sysfs - adds cpuidle states sysfs attributes
394 * @device: the target device
396 static int cpuidle_add_state_sysfs(struct cpuidle_device *device)
398 int i, ret = -ENOMEM;
399 struct cpuidle_state_kobj *kobj;
400 struct cpuidle_device_kobj *kdev = device->kobj_dev;
401 struct cpuidle_driver *drv = cpuidle_get_cpu_driver(device);
403 /* state statistics */
404 for (i = 0; i < drv->state_count; i++) {
405 kobj = kzalloc(sizeof(struct cpuidle_state_kobj), GFP_KERNEL);
408 kobj->state = &drv->states[i];
409 kobj->state_usage = &device->states_usage[i];
410 init_completion(&kobj->kobj_unregister);
412 ret = kobject_init_and_add(&kobj->kobj, &ktype_state_cpuidle,
413 &kdev->kobj, "state%d", i);
415 kobject_put(&kobj->kobj);
418 kobject_uevent(&kobj->kobj, KOBJ_ADD);
419 device->kobjs[i] = kobj;
425 for (i = i - 1; i >= 0; i--)
426 cpuidle_free_state_kobj(device, i);
431 * cpuidle_remove_driver_sysfs - removes the cpuidle states sysfs attributes
432 * @device: the target device
434 static void cpuidle_remove_state_sysfs(struct cpuidle_device *device)
436 struct cpuidle_driver *drv = cpuidle_get_cpu_driver(device);
439 for (i = 0; i < drv->state_count; i++)
440 cpuidle_free_state_kobj(device, i);
443 #ifdef CONFIG_CPU_IDLE_MULTIPLE_DRIVERS
444 #define kobj_to_driver_kobj(k) container_of(k, struct cpuidle_driver_kobj, kobj)
445 #define attr_to_driver_attr(a) container_of(a, struct cpuidle_driver_attr, attr)
447 #define define_one_driver_ro(_name, show) \
448 static struct cpuidle_driver_attr attr_driver_##_name = \
449 __ATTR(_name, 0444, show, NULL)
451 struct cpuidle_driver_kobj {
452 struct cpuidle_driver *drv;
453 struct completion kobj_unregister;
457 struct cpuidle_driver_attr {
458 struct attribute attr;
459 ssize_t (*show)(struct cpuidle_driver *, char *);
460 ssize_t (*store)(struct cpuidle_driver *, const char *, size_t);
463 static ssize_t show_driver_name(struct cpuidle_driver *drv, char *buf)
467 spin_lock(&cpuidle_driver_lock);
468 ret = sprintf(buf, "%s\n", drv ? drv->name : "none");
469 spin_unlock(&cpuidle_driver_lock);
474 static void cpuidle_driver_sysfs_release(struct kobject *kobj)
476 struct cpuidle_driver_kobj *driver_kobj = kobj_to_driver_kobj(kobj);
477 complete(&driver_kobj->kobj_unregister);
480 static ssize_t cpuidle_driver_show(struct kobject *kobj, struct attribute *attr,
484 struct cpuidle_driver_kobj *driver_kobj = kobj_to_driver_kobj(kobj);
485 struct cpuidle_driver_attr *dattr = attr_to_driver_attr(attr);
488 ret = dattr->show(driver_kobj->drv, buf);
493 static ssize_t cpuidle_driver_store(struct kobject *kobj, struct attribute *attr,
494 const char *buf, size_t size)
497 struct cpuidle_driver_kobj *driver_kobj = kobj_to_driver_kobj(kobj);
498 struct cpuidle_driver_attr *dattr = attr_to_driver_attr(attr);
501 ret = dattr->store(driver_kobj->drv, buf, size);
506 define_one_driver_ro(name, show_driver_name);
508 static const struct sysfs_ops cpuidle_driver_sysfs_ops = {
509 .show = cpuidle_driver_show,
510 .store = cpuidle_driver_store,
513 static struct attribute *cpuidle_driver_default_attrs[] = {
514 &attr_driver_name.attr,
518 static struct kobj_type ktype_driver_cpuidle = {
519 .sysfs_ops = &cpuidle_driver_sysfs_ops,
520 .default_attrs = cpuidle_driver_default_attrs,
521 .release = cpuidle_driver_sysfs_release,
525 * cpuidle_add_driver_sysfs - adds the driver name sysfs attribute
526 * @device: the target device
528 static int cpuidle_add_driver_sysfs(struct cpuidle_device *dev)
530 struct cpuidle_driver_kobj *kdrv;
531 struct cpuidle_device_kobj *kdev = dev->kobj_dev;
532 struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
535 kdrv = kzalloc(sizeof(*kdrv), GFP_KERNEL);
540 init_completion(&kdrv->kobj_unregister);
542 ret = kobject_init_and_add(&kdrv->kobj, &ktype_driver_cpuidle,
543 &kdev->kobj, "driver");
545 kobject_put(&kdrv->kobj);
549 kobject_uevent(&kdrv->kobj, KOBJ_ADD);
550 dev->kobj_driver = kdrv;
556 * cpuidle_remove_driver_sysfs - removes the driver name sysfs attribute
557 * @device: the target device
559 static void cpuidle_remove_driver_sysfs(struct cpuidle_device *dev)
561 struct cpuidle_driver_kobj *kdrv = dev->kobj_driver;
562 kobject_put(&kdrv->kobj);
563 wait_for_completion(&kdrv->kobj_unregister);
567 static inline int cpuidle_add_driver_sysfs(struct cpuidle_device *dev)
572 static inline void cpuidle_remove_driver_sysfs(struct cpuidle_device *dev)
579 * cpuidle_add_device_sysfs - adds device specific sysfs attributes
580 * @device: the target device
582 int cpuidle_add_device_sysfs(struct cpuidle_device *device)
586 ret = cpuidle_add_state_sysfs(device);
590 ret = cpuidle_add_driver_sysfs(device);
592 cpuidle_remove_state_sysfs(device);
597 * cpuidle_remove_device_sysfs : removes device specific sysfs attributes
598 * @device : the target device
600 void cpuidle_remove_device_sysfs(struct cpuidle_device *device)
602 cpuidle_remove_driver_sysfs(device);
603 cpuidle_remove_state_sysfs(device);
607 * cpuidle_add_sysfs - creates a sysfs instance for the target device
608 * @dev: the target device
610 int cpuidle_add_sysfs(struct cpuidle_device *dev)
612 struct cpuidle_device_kobj *kdev;
613 struct device *cpu_dev = get_cpu_device((unsigned long)dev->cpu);
617 * Return if cpu_device is not setup for this CPU.
619 * This could happen if the arch did not set up cpu_device
620 * since this CPU is not in cpu_present mask and the
621 * driver did not send a correct CPU mask during registration.
622 * Without this check we would end up passing bogus
623 * value for &cpu_dev->kobj in kobject_init_and_add()
628 kdev = kzalloc(sizeof(*kdev), GFP_KERNEL);
632 dev->kobj_dev = kdev;
634 init_completion(&kdev->kobj_unregister);
636 error = kobject_init_and_add(&kdev->kobj, &ktype_cpuidle, &cpu_dev->kobj,
639 kobject_put(&kdev->kobj);
643 kobject_uevent(&kdev->kobj, KOBJ_ADD);
649 * cpuidle_remove_sysfs - deletes a sysfs instance on the target device
650 * @dev: the target device
652 void cpuidle_remove_sysfs(struct cpuidle_device *dev)
654 struct cpuidle_device_kobj *kdev = dev->kobj_dev;
656 kobject_put(&kdev->kobj);
657 wait_for_completion(&kdev->kobj_unregister);