3 * Copyright (c) 2013, Intel Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.
19 #include <linux/module.h>
20 #include <linux/device.h>
21 #include <linux/err.h>
22 #include <linux/slab.h>
23 #include <linux/powercap.h>
25 #define to_powercap_zone(n) container_of(n, struct powercap_zone, dev)
26 #define to_powercap_control_type(n) \
27 container_of(n, struct powercap_control_type, dev)
29 /* Power zone show function */
30 #define define_power_zone_show(_attr) \
31 static ssize_t _attr##_show(struct device *dev, \
32 struct device_attribute *dev_attr,\
36 ssize_t len = -EINVAL; \
37 struct powercap_zone *power_zone = to_powercap_zone(dev); \
39 if (power_zone->ops->get_##_attr) { \
40 if (!power_zone->ops->get_##_attr(power_zone, &value)) \
41 len = sprintf(buf, "%lld\n", value); \
47 /* The only meaningful input is 0 (reset), others are silently ignored */
48 #define define_power_zone_store(_attr) \
49 static ssize_t _attr##_store(struct device *dev,\
50 struct device_attribute *dev_attr, \
51 const char *buf, size_t count) \
54 struct powercap_zone *power_zone = to_powercap_zone(dev); \
57 err = kstrtoull(buf, 10, &value); \
62 if (power_zone->ops->reset_##_attr) { \
63 if (!power_zone->ops->reset_##_attr(power_zone)) \
70 /* Power zone constraint show function */
71 #define define_power_zone_constraint_show(_attr) \
72 static ssize_t show_constraint_##_attr(struct device *dev, \
73 struct device_attribute *dev_attr,\
77 ssize_t len = -ENODATA; \
78 struct powercap_zone *power_zone = to_powercap_zone(dev); \
80 struct powercap_zone_constraint *pconst;\
82 if (!sscanf(dev_attr->attr.name, "constraint_%d_", &id)) \
84 if (id >= power_zone->const_id_cnt) \
86 pconst = &power_zone->constraints[id]; \
87 if (pconst && pconst->ops && pconst->ops->get_##_attr) { \
88 if (!pconst->ops->get_##_attr(power_zone, id, &value)) \
89 len = sprintf(buf, "%lld\n", value); \
95 /* Power zone constraint store function */
96 #define define_power_zone_constraint_store(_attr) \
97 static ssize_t store_constraint_##_attr(struct device *dev,\
98 struct device_attribute *dev_attr, \
99 const char *buf, size_t count) \
103 struct powercap_zone *power_zone = to_powercap_zone(dev); \
105 struct powercap_zone_constraint *pconst;\
107 if (!sscanf(dev_attr->attr.name, "constraint_%d_", &id)) \
109 if (id >= power_zone->const_id_cnt) \
111 pconst = &power_zone->constraints[id]; \
112 err = kstrtoull(buf, 10, &value); \
115 if (pconst && pconst->ops && pconst->ops->set_##_attr) { \
116 if (!pconst->ops->set_##_attr(power_zone, id, value)) \
123 /* Power zone information callbacks */
124 define_power_zone_show(power_uw
);
125 define_power_zone_show(max_power_range_uw
);
126 define_power_zone_show(energy_uj
);
127 define_power_zone_store(energy_uj
);
128 define_power_zone_show(max_energy_range_uj
);
130 /* Power zone attributes */
131 static DEVICE_ATTR_RO(max_power_range_uw
);
132 static DEVICE_ATTR_RO(power_uw
);
133 static DEVICE_ATTR_RO(max_energy_range_uj
);
134 static DEVICE_ATTR_RW(energy_uj
);
136 /* Power zone constraint attributes callbacks */
137 define_power_zone_constraint_show(power_limit_uw
);
138 define_power_zone_constraint_store(power_limit_uw
);
139 define_power_zone_constraint_show(time_window_us
);
140 define_power_zone_constraint_store(time_window_us
);
141 define_power_zone_constraint_show(max_power_uw
);
142 define_power_zone_constraint_show(min_power_uw
);
143 define_power_zone_constraint_show(max_time_window_us
);
144 define_power_zone_constraint_show(min_time_window_us
);
146 /* For one time seeding of constraint device attributes */
147 struct powercap_constraint_attr
{
148 struct device_attribute power_limit_attr
;
149 struct device_attribute time_window_attr
;
150 struct device_attribute max_power_attr
;
151 struct device_attribute min_power_attr
;
152 struct device_attribute max_time_window_attr
;
153 struct device_attribute min_time_window_attr
;
154 struct device_attribute name_attr
;
157 static struct powercap_constraint_attr
158 constraint_attrs
[MAX_CONSTRAINTS_PER_ZONE
];
160 /* A list of powercap control_types */
161 static LIST_HEAD(powercap_cntrl_list
);
162 /* Mutex to protect list of powercap control_types */
163 static DEFINE_MUTEX(powercap_cntrl_list_lock
);
165 #define POWERCAP_CONSTRAINT_NAME_LEN 30 /* Some limit to avoid overflow */
166 static ssize_t
show_constraint_name(struct device
*dev
,
167 struct device_attribute
*dev_attr
,
171 struct powercap_zone
*power_zone
= to_powercap_zone(dev
);
173 ssize_t len
= -ENODATA
;
174 struct powercap_zone_constraint
*pconst
;
176 if (!sscanf(dev_attr
->attr
.name
, "constraint_%d_", &id
))
178 if (id
>= power_zone
->const_id_cnt
)
180 pconst
= &power_zone
->constraints
[id
];
182 if (pconst
&& pconst
->ops
&& pconst
->ops
->get_name
) {
183 name
= pconst
->ops
->get_name(power_zone
, id
);
185 snprintf(buf
, POWERCAP_CONSTRAINT_NAME_LEN
,
187 buf
[POWERCAP_CONSTRAINT_NAME_LEN
] = '\0';
195 static int create_constraint_attribute(int id
, const char *name
,
197 struct device_attribute
*dev_attr
,
198 ssize_t (*show
)(struct device
*,
199 struct device_attribute
*, char *),
200 ssize_t (*store
)(struct device
*,
201 struct device_attribute
*,
202 const char *, size_t)
206 dev_attr
->attr
.name
= kasprintf(GFP_KERNEL
, "constraint_%d_%s",
208 if (!dev_attr
->attr
.name
)
210 dev_attr
->attr
.mode
= mode
;
211 dev_attr
->show
= show
;
212 dev_attr
->store
= store
;
217 static void free_constraint_attributes(void)
221 for (i
= 0; i
< MAX_CONSTRAINTS_PER_ZONE
; ++i
) {
222 kfree(constraint_attrs
[i
].power_limit_attr
.attr
.name
);
223 kfree(constraint_attrs
[i
].time_window_attr
.attr
.name
);
224 kfree(constraint_attrs
[i
].name_attr
.attr
.name
);
225 kfree(constraint_attrs
[i
].max_power_attr
.attr
.name
);
226 kfree(constraint_attrs
[i
].min_power_attr
.attr
.name
);
227 kfree(constraint_attrs
[i
].max_time_window_attr
.attr
.name
);
228 kfree(constraint_attrs
[i
].min_time_window_attr
.attr
.name
);
232 static int seed_constraint_attributes(void)
237 for (i
= 0; i
< MAX_CONSTRAINTS_PER_ZONE
; ++i
) {
238 ret
= create_constraint_attribute(i
, "power_limit_uw",
240 &constraint_attrs
[i
].power_limit_attr
,
241 show_constraint_power_limit_uw
,
242 store_constraint_power_limit_uw
);
245 ret
= create_constraint_attribute(i
, "time_window_us",
247 &constraint_attrs
[i
].time_window_attr
,
248 show_constraint_time_window_us
,
249 store_constraint_time_window_us
);
252 ret
= create_constraint_attribute(i
, "name", S_IRUGO
,
253 &constraint_attrs
[i
].name_attr
,
254 show_constraint_name
,
258 ret
= create_constraint_attribute(i
, "max_power_uw", S_IRUGO
,
259 &constraint_attrs
[i
].max_power_attr
,
260 show_constraint_max_power_uw
,
264 ret
= create_constraint_attribute(i
, "min_power_uw", S_IRUGO
,
265 &constraint_attrs
[i
].min_power_attr
,
266 show_constraint_min_power_uw
,
270 ret
= create_constraint_attribute(i
, "max_time_window_us",
272 &constraint_attrs
[i
].max_time_window_attr
,
273 show_constraint_max_time_window_us
,
277 ret
= create_constraint_attribute(i
, "min_time_window_us",
279 &constraint_attrs
[i
].min_time_window_attr
,
280 show_constraint_min_time_window_us
,
290 free_constraint_attributes();
295 static int create_constraints(struct powercap_zone
*power_zone
,
297 struct powercap_zone_constraint_ops
*const_ops
)
302 struct powercap_zone_constraint
*pconst
;
304 if (!power_zone
|| !const_ops
|| !const_ops
->get_power_limit_uw
||
305 !const_ops
->set_power_limit_uw
||
306 !const_ops
->get_time_window_us
||
307 !const_ops
->set_time_window_us
)
310 count
= power_zone
->zone_attr_count
;
311 for (i
= 0; i
< nr_constraints
; ++i
) {
312 pconst
= &power_zone
->constraints
[i
];
313 pconst
->ops
= const_ops
;
314 pconst
->id
= power_zone
->const_id_cnt
;
315 power_zone
->const_id_cnt
++;
316 power_zone
->zone_dev_attrs
[count
++] =
317 &constraint_attrs
[i
].power_limit_attr
.attr
;
318 power_zone
->zone_dev_attrs
[count
++] =
319 &constraint_attrs
[i
].time_window_attr
.attr
;
320 if (pconst
->ops
->get_name
)
321 power_zone
->zone_dev_attrs
[count
++] =
322 &constraint_attrs
[i
].name_attr
.attr
;
323 if (pconst
->ops
->get_max_power_uw
)
324 power_zone
->zone_dev_attrs
[count
++] =
325 &constraint_attrs
[i
].max_power_attr
.attr
;
326 if (pconst
->ops
->get_min_power_uw
)
327 power_zone
->zone_dev_attrs
[count
++] =
328 &constraint_attrs
[i
].min_power_attr
.attr
;
329 if (pconst
->ops
->get_max_time_window_us
)
330 power_zone
->zone_dev_attrs
[count
++] =
331 &constraint_attrs
[i
].max_time_window_attr
.attr
;
332 if (pconst
->ops
->get_min_time_window_us
)
333 power_zone
->zone_dev_attrs
[count
++] =
334 &constraint_attrs
[i
].min_time_window_attr
.attr
;
336 power_zone
->zone_attr_count
= count
;
341 static bool control_type_valid(void *control_type
)
343 struct powercap_control_type
*pos
= NULL
;
346 mutex_lock(&powercap_cntrl_list_lock
);
348 list_for_each_entry(pos
, &powercap_cntrl_list
, node
) {
349 if (pos
== control_type
) {
354 mutex_unlock(&powercap_cntrl_list_lock
);
359 static ssize_t
name_show(struct device
*dev
,
360 struct device_attribute
*attr
,
363 struct powercap_zone
*power_zone
= to_powercap_zone(dev
);
365 return sprintf(buf
, "%s\n", power_zone
->name
);
368 static DEVICE_ATTR_RO(name
);
370 /* Create zone and attributes in sysfs */
371 static void create_power_zone_common_attributes(
372 struct powercap_zone
*power_zone
)
376 power_zone
->zone_dev_attrs
[count
++] = &dev_attr_name
.attr
;
377 if (power_zone
->ops
->get_max_energy_range_uj
)
378 power_zone
->zone_dev_attrs
[count
++] =
379 &dev_attr_max_energy_range_uj
.attr
;
380 if (power_zone
->ops
->get_energy_uj
) {
381 if (power_zone
->ops
->reset_energy_uj
)
382 dev_attr_energy_uj
.attr
.mode
= S_IWUSR
| S_IRUGO
;
384 dev_attr_energy_uj
.attr
.mode
= S_IRUGO
;
385 power_zone
->zone_dev_attrs
[count
++] =
386 &dev_attr_energy_uj
.attr
;
388 if (power_zone
->ops
->get_power_uw
)
389 power_zone
->zone_dev_attrs
[count
++] =
390 &dev_attr_power_uw
.attr
;
391 if (power_zone
->ops
->get_max_power_range_uw
)
392 power_zone
->zone_dev_attrs
[count
++] =
393 &dev_attr_max_power_range_uw
.attr
;
394 power_zone
->zone_dev_attrs
[count
] = NULL
;
395 power_zone
->zone_attr_count
= count
;
398 static void powercap_release(struct device
*dev
)
403 struct powercap_zone
*power_zone
= to_powercap_zone(dev
);
405 /* Store flag as the release() may free memory */
406 allocated
= power_zone
->allocated
;
407 /* Remove id from parent idr struct */
408 idr_remove(power_zone
->parent_idr
, power_zone
->id
);
409 /* Destroy idrs allocated for this zone */
410 idr_destroy(&power_zone
->idr
);
411 kfree(power_zone
->name
);
412 kfree(power_zone
->zone_dev_attrs
);
413 kfree(power_zone
->constraints
);
414 if (power_zone
->ops
->release
)
415 power_zone
->ops
->release(power_zone
);
419 struct powercap_control_type
*control_type
=
420 to_powercap_control_type(dev
);
422 /* Store flag as the release() may free memory */
423 allocated
= control_type
->allocated
;
424 idr_destroy(&control_type
->idr
);
425 mutex_destroy(&control_type
->lock
);
426 if (control_type
->ops
&& control_type
->ops
->release
)
427 control_type
->ops
->release(control_type
);
433 static ssize_t
enabled_show(struct device
*dev
,
434 struct device_attribute
*attr
,
439 /* Default is enabled */
441 struct powercap_zone
*power_zone
= to_powercap_zone(dev
);
442 if (power_zone
->ops
->get_enable
)
443 if (power_zone
->ops
->get_enable(power_zone
, &mode
))
446 struct powercap_control_type
*control_type
=
447 to_powercap_control_type(dev
);
448 if (control_type
->ops
&& control_type
->ops
->get_enable
)
449 if (control_type
->ops
->get_enable(control_type
, &mode
))
453 return sprintf(buf
, "%d\n", mode
);
456 static ssize_t
enabled_store(struct device
*dev
,
457 struct device_attribute
*attr
,
458 const char *buf
, size_t len
)
462 if (strtobool(buf
, &mode
))
465 struct powercap_zone
*power_zone
= to_powercap_zone(dev
);
466 if (power_zone
->ops
->set_enable
)
467 if (!power_zone
->ops
->set_enable(power_zone
, mode
))
470 struct powercap_control_type
*control_type
=
471 to_powercap_control_type(dev
);
472 if (control_type
->ops
&& control_type
->ops
->set_enable
)
473 if (!control_type
->ops
->set_enable(control_type
, mode
))
480 static DEVICE_ATTR_RW(enabled
);
482 static struct attribute
*powercap_attrs
[] = {
483 &dev_attr_enabled
.attr
,
486 ATTRIBUTE_GROUPS(powercap
);
488 static struct class powercap_class
= {
490 .dev_release
= powercap_release
,
491 .dev_groups
= powercap_groups
,
494 struct powercap_zone
*powercap_register_zone(
495 struct powercap_zone
*power_zone
,
496 struct powercap_control_type
*control_type
,
498 struct powercap_zone
*parent
,
499 const struct powercap_zone_ops
*ops
,
501 struct powercap_zone_constraint_ops
*const_ops
)
506 if (!name
|| !control_type
|| !ops
||
507 nr_constraints
> MAX_CONSTRAINTS_PER_ZONE
||
508 (!ops
->get_energy_uj
&& !ops
->get_power_uw
) ||
509 !control_type_valid(control_type
))
510 return ERR_PTR(-EINVAL
);
514 return ERR_PTR(-EINVAL
);
515 memset(power_zone
, 0, sizeof(*power_zone
));
517 power_zone
= kzalloc(sizeof(*power_zone
), GFP_KERNEL
);
519 return ERR_PTR(-ENOMEM
);
520 power_zone
->allocated
= true;
522 power_zone
->ops
= ops
;
523 power_zone
->control_type_inst
= control_type
;
525 power_zone
->dev
.parent
= &control_type
->dev
;
526 power_zone
->parent_idr
= &control_type
->idr
;
528 power_zone
->dev
.parent
= &parent
->dev
;
529 power_zone
->parent_idr
= &parent
->idr
;
531 power_zone
->dev
.class = &powercap_class
;
533 mutex_lock(&control_type
->lock
);
534 /* Using idr to get the unique id */
535 result
= idr_alloc(power_zone
->parent_idr
, NULL
, 0, 0, GFP_KERNEL
);
539 power_zone
->id
= result
;
540 idr_init(&power_zone
->idr
);
541 power_zone
->name
= kstrdup(name
, GFP_KERNEL
);
542 if (!power_zone
->name
)
544 dev_set_name(&power_zone
->dev
, "%s:%x",
545 dev_name(power_zone
->dev
.parent
),
547 power_zone
->constraints
= kzalloc(sizeof(*power_zone
->constraints
) *
548 nr_constraints
, GFP_KERNEL
);
549 if (!power_zone
->constraints
)
550 goto err_const_alloc
;
552 nr_attrs
= nr_constraints
* POWERCAP_CONSTRAINTS_ATTRS
+
553 POWERCAP_ZONE_MAX_ATTRS
+ 1;
554 power_zone
->zone_dev_attrs
= kzalloc(sizeof(void *) *
555 nr_attrs
, GFP_KERNEL
);
556 if (!power_zone
->zone_dev_attrs
)
558 create_power_zone_common_attributes(power_zone
);
559 result
= create_constraints(power_zone
, nr_constraints
, const_ops
);
563 power_zone
->zone_dev_attrs
[power_zone
->zone_attr_count
] = NULL
;
564 power_zone
->dev_zone_attr_group
.attrs
= power_zone
->zone_dev_attrs
;
565 power_zone
->dev_attr_groups
[0] = &power_zone
->dev_zone_attr_group
;
566 power_zone
->dev_attr_groups
[1] = NULL
;
567 power_zone
->dev
.groups
= power_zone
->dev_attr_groups
;
568 result
= device_register(&power_zone
->dev
);
572 control_type
->nr_zones
++;
573 mutex_unlock(&control_type
->lock
);
578 kfree(power_zone
->zone_dev_attrs
);
580 kfree(power_zone
->constraints
);
582 kfree(power_zone
->name
);
584 idr_remove(power_zone
->parent_idr
, power_zone
->id
);
586 if (power_zone
->allocated
)
588 mutex_unlock(&control_type
->lock
);
590 return ERR_PTR(result
);
592 EXPORT_SYMBOL_GPL(powercap_register_zone
);
594 int powercap_unregister_zone(struct powercap_control_type
*control_type
,
595 struct powercap_zone
*power_zone
)
597 if (!power_zone
|| !control_type
)
600 mutex_lock(&control_type
->lock
);
601 control_type
->nr_zones
--;
602 mutex_unlock(&control_type
->lock
);
604 device_unregister(&power_zone
->dev
);
608 EXPORT_SYMBOL_GPL(powercap_unregister_zone
);
610 struct powercap_control_type
*powercap_register_control_type(
611 struct powercap_control_type
*control_type
,
613 const struct powercap_control_type_ops
*ops
)
618 return ERR_PTR(-EINVAL
);
620 if (!ops
|| !ops
->release
)
621 return ERR_PTR(-EINVAL
);
622 memset(control_type
, 0, sizeof(*control_type
));
624 control_type
= kzalloc(sizeof(*control_type
), GFP_KERNEL
);
626 return ERR_PTR(-ENOMEM
);
627 control_type
->allocated
= true;
629 mutex_init(&control_type
->lock
);
630 control_type
->ops
= ops
;
631 INIT_LIST_HEAD(&control_type
->node
);
632 control_type
->dev
.class = &powercap_class
;
633 dev_set_name(&control_type
->dev
, "%s", name
);
634 result
= device_register(&control_type
->dev
);
636 if (control_type
->allocated
)
638 return ERR_PTR(result
);
640 idr_init(&control_type
->idr
);
642 mutex_lock(&powercap_cntrl_list_lock
);
643 list_add_tail(&control_type
->node
, &powercap_cntrl_list
);
644 mutex_unlock(&powercap_cntrl_list_lock
);
648 EXPORT_SYMBOL_GPL(powercap_register_control_type
);
650 int powercap_unregister_control_type(struct powercap_control_type
*control_type
)
652 struct powercap_control_type
*pos
= NULL
;
654 if (control_type
->nr_zones
) {
655 dev_err(&control_type
->dev
, "Zones of this type still not freed\n");
658 mutex_lock(&powercap_cntrl_list_lock
);
659 list_for_each_entry(pos
, &powercap_cntrl_list
, node
) {
660 if (pos
== control_type
) {
661 list_del(&control_type
->node
);
662 mutex_unlock(&powercap_cntrl_list_lock
);
663 device_unregister(&control_type
->dev
);
667 mutex_unlock(&powercap_cntrl_list_lock
);
671 EXPORT_SYMBOL_GPL(powercap_unregister_control_type
);
673 static int __init
powercap_init(void)
677 result
= seed_constraint_attributes();
681 result
= class_register(&powercap_class
);
686 device_initcall(powercap_init
);
688 MODULE_DESCRIPTION("PowerCap sysfs Driver");
689 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>");
690 MODULE_LICENSE("GPL v2");