2 * thermal.c - sysfs interface of thermal devices
4 * Copyright (C) 2016 Eduardo Valentin <edubezval@gmail.com>
6 * Highly based on original thermal_core.c
7 * Copyright (C) 2008 Intel Corp
8 * Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
9 * Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; version 2 of the License.
16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18 #include <linux/sysfs.h>
19 #include <linux/device.h>
20 #include <linux/err.h>
21 #include <linux/slab.h>
22 #include <linux/string.h>
24 #include "thermal_core.h"
26 /* sys I/F for thermal zone */
29 type_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
31 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
33 return sprintf(buf
, "%s\n", tz
->type
);
37 temp_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
39 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
42 ret
= thermal_zone_get_temp(tz
, &temperature
);
47 return sprintf(buf
, "%d\n", temperature
);
51 mode_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
53 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
54 enum thermal_device_mode mode
;
57 if (!tz
->ops
->get_mode
)
60 result
= tz
->ops
->get_mode(tz
, &mode
);
64 return sprintf(buf
, "%s\n", mode
== THERMAL_DEVICE_ENABLED
? "enabled"
69 mode_store(struct device
*dev
, struct device_attribute
*attr
,
70 const char *buf
, size_t count
)
72 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
75 if (!tz
->ops
->set_mode
)
78 if (!strncmp(buf
, "enabled", sizeof("enabled") - 1))
79 result
= tz
->ops
->set_mode(tz
, THERMAL_DEVICE_ENABLED
);
80 else if (!strncmp(buf
, "disabled", sizeof("disabled") - 1))
81 result
= tz
->ops
->set_mode(tz
, THERMAL_DEVICE_DISABLED
);
92 trip_point_type_show(struct device
*dev
, struct device_attribute
*attr
,
95 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
96 enum thermal_trip_type type
;
99 if (!tz
->ops
->get_trip_type
)
102 if (sscanf(attr
->attr
.name
, "trip_point_%d_type", &trip
) != 1)
105 result
= tz
->ops
->get_trip_type(tz
, trip
, &type
);
110 case THERMAL_TRIP_CRITICAL
:
111 return sprintf(buf
, "critical\n");
112 case THERMAL_TRIP_HOT
:
113 return sprintf(buf
, "hot\n");
114 case THERMAL_TRIP_PASSIVE
:
115 return sprintf(buf
, "passive\n");
116 case THERMAL_TRIP_ACTIVE
:
117 return sprintf(buf
, "active\n");
119 return sprintf(buf
, "unknown\n");
124 trip_point_temp_store(struct device
*dev
, struct device_attribute
*attr
,
125 const char *buf
, size_t count
)
127 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
131 if (!tz
->ops
->set_trip_temp
)
134 if (sscanf(attr
->attr
.name
, "trip_point_%d_temp", &trip
) != 1)
137 if (kstrtoint(buf
, 10, &temperature
))
140 ret
= tz
->ops
->set_trip_temp(tz
, trip
, temperature
);
144 thermal_zone_device_update(tz
, THERMAL_EVENT_UNSPECIFIED
);
150 trip_point_temp_show(struct device
*dev
, struct device_attribute
*attr
,
153 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
157 if (!tz
->ops
->get_trip_temp
)
160 if (sscanf(attr
->attr
.name
, "trip_point_%d_temp", &trip
) != 1)
163 ret
= tz
->ops
->get_trip_temp(tz
, trip
, &temperature
);
168 return sprintf(buf
, "%d\n", temperature
);
172 trip_point_hyst_store(struct device
*dev
, struct device_attribute
*attr
,
173 const char *buf
, size_t count
)
175 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
179 if (!tz
->ops
->set_trip_hyst
)
182 if (sscanf(attr
->attr
.name
, "trip_point_%d_hyst", &trip
) != 1)
185 if (kstrtoint(buf
, 10, &temperature
))
189 * We are not doing any check on the 'temperature' value
190 * here. The driver implementing 'set_trip_hyst' has to
193 ret
= tz
->ops
->set_trip_hyst(tz
, trip
, temperature
);
196 thermal_zone_set_trips(tz
);
198 return ret
? ret
: count
;
202 trip_point_hyst_show(struct device
*dev
, struct device_attribute
*attr
,
205 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
209 if (!tz
->ops
->get_trip_hyst
)
212 if (sscanf(attr
->attr
.name
, "trip_point_%d_hyst", &trip
) != 1)
215 ret
= tz
->ops
->get_trip_hyst(tz
, trip
, &temperature
);
217 return ret
? ret
: sprintf(buf
, "%d\n", temperature
);
221 passive_store(struct device
*dev
, struct device_attribute
*attr
,
222 const char *buf
, size_t count
)
224 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
227 if (sscanf(buf
, "%d\n", &state
) != 1)
230 /* sanity check: values below 1000 millicelcius don't make sense
231 * and can cause the system to go into a thermal heart attack
233 if (state
&& state
< 1000)
236 if (state
&& !tz
->forced_passive
) {
237 if (!tz
->passive_delay
)
238 tz
->passive_delay
= 1000;
239 thermal_zone_device_rebind_exception(tz
, "Processor",
240 sizeof("Processor"));
241 } else if (!state
&& tz
->forced_passive
) {
242 tz
->passive_delay
= 0;
243 thermal_zone_device_unbind_exception(tz
, "Processor",
244 sizeof("Processor"));
247 tz
->forced_passive
= state
;
249 thermal_zone_device_update(tz
, THERMAL_EVENT_UNSPECIFIED
);
255 passive_show(struct device
*dev
, struct device_attribute
*attr
,
258 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
260 return sprintf(buf
, "%d\n", tz
->forced_passive
);
264 policy_store(struct device
*dev
, struct device_attribute
*attr
,
265 const char *buf
, size_t count
)
267 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
268 char name
[THERMAL_NAME_LENGTH
];
271 snprintf(name
, sizeof(name
), "%s", buf
);
273 ret
= thermal_zone_device_set_policy(tz
, name
);
281 policy_show(struct device
*dev
, struct device_attribute
*devattr
, char *buf
)
283 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
285 return sprintf(buf
, "%s\n", tz
->governor
->name
);
289 available_policies_show(struct device
*dev
, struct device_attribute
*devattr
,
292 return thermal_build_list_of_policies(buf
);
295 #if (IS_ENABLED(CONFIG_THERMAL_EMULATION))
297 emul_temp_store(struct device
*dev
, struct device_attribute
*attr
,
298 const char *buf
, size_t count
)
300 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
304 if (kstrtoint(buf
, 10, &temperature
))
307 if (!tz
->ops
->set_emul_temp
) {
308 mutex_lock(&tz
->lock
);
309 tz
->emul_temperature
= temperature
;
310 mutex_unlock(&tz
->lock
);
312 ret
= tz
->ops
->set_emul_temp(tz
, temperature
);
316 thermal_zone_device_update(tz
, THERMAL_EVENT_UNSPECIFIED
);
318 return ret
? ret
: count
;
320 static DEVICE_ATTR_WO(emul_temp
);
324 sustainable_power_show(struct device
*dev
, struct device_attribute
*devattr
,
327 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
330 return sprintf(buf
, "%u\n", tz
->tzp
->sustainable_power
);
336 sustainable_power_store(struct device
*dev
, struct device_attribute
*devattr
,
337 const char *buf
, size_t count
)
339 struct thermal_zone_device
*tz
= to_thermal_zone(dev
);
340 u32 sustainable_power
;
345 if (kstrtou32(buf
, 10, &sustainable_power
))
348 tz
->tzp
->sustainable_power
= sustainable_power
;
353 #define create_s32_tzp_attr(name) \
355 name##_show(struct device *dev, struct device_attribute *devattr, \
358 struct thermal_zone_device *tz = to_thermal_zone(dev); \
361 return sprintf(buf, "%d\n", tz->tzp->name); \
367 name##_store(struct device *dev, struct device_attribute *devattr, \
368 const char *buf, size_t count) \
370 struct thermal_zone_device *tz = to_thermal_zone(dev); \
376 if (kstrtos32(buf, 10, &value)) \
379 tz->tzp->name = value; \
383 static DEVICE_ATTR(name, S_IWUSR | S_IRUGO, name##_show, name##_store)
385 create_s32_tzp_attr(k_po
);
386 create_s32_tzp_attr(k_pu
);
387 create_s32_tzp_attr(k_i
);
388 create_s32_tzp_attr(k_d
);
389 create_s32_tzp_attr(integral_cutoff
);
390 create_s32_tzp_attr(slope
);
391 create_s32_tzp_attr(offset
);
392 #undef create_s32_tzp_attr
395 * These are thermal zone device attributes that will always be present.
396 * All the attributes created for tzp (create_s32_tzp_attr) also are always
397 * present on the sysfs interface.
399 static DEVICE_ATTR_RO(type
);
400 static DEVICE_ATTR_RO(temp
);
401 static DEVICE_ATTR_RW(policy
);
402 static DEVICE_ATTR_RO(available_policies
);
403 static DEVICE_ATTR_RW(sustainable_power
);
405 /* These thermal zone device attributes are created based on conditions */
406 static DEVICE_ATTR_RW(mode
);
407 static DEVICE_ATTR_RW(passive
);
409 /* These attributes are unconditionally added to a thermal zone */
410 static struct attribute
*thermal_zone_dev_attrs
[] = {
413 #if (IS_ENABLED(CONFIG_THERMAL_EMULATION))
414 &dev_attr_emul_temp
.attr
,
416 &dev_attr_policy
.attr
,
417 &dev_attr_available_policies
.attr
,
418 &dev_attr_sustainable_power
.attr
,
423 &dev_attr_integral_cutoff
.attr
,
424 &dev_attr_slope
.attr
,
425 &dev_attr_offset
.attr
,
429 static struct attribute_group thermal_zone_attribute_group
= {
430 .attrs
= thermal_zone_dev_attrs
,
433 /* We expose mode only if .get_mode is present */
434 static struct attribute
*thermal_zone_mode_attrs
[] = {
439 static umode_t
thermal_zone_mode_is_visible(struct kobject
*kobj
,
440 struct attribute
*attr
,
443 struct device
*dev
= container_of(kobj
, struct device
, kobj
);
444 struct thermal_zone_device
*tz
;
446 tz
= container_of(dev
, struct thermal_zone_device
, device
);
448 if (tz
->ops
->get_mode
)
454 static struct attribute_group thermal_zone_mode_attribute_group
= {
455 .attrs
= thermal_zone_mode_attrs
,
456 .is_visible
= thermal_zone_mode_is_visible
,
459 /* We expose passive only if passive trips are present */
460 static struct attribute
*thermal_zone_passive_attrs
[] = {
461 &dev_attr_passive
.attr
,
465 static umode_t
thermal_zone_passive_is_visible(struct kobject
*kobj
,
466 struct attribute
*attr
,
469 struct device
*dev
= container_of(kobj
, struct device
, kobj
);
470 struct thermal_zone_device
*tz
;
471 enum thermal_trip_type trip_type
;
472 int count
, passive
= 0;
474 tz
= container_of(dev
, struct thermal_zone_device
, device
);
476 for (count
= 0; count
< tz
->trips
&& !passive
; count
++) {
477 tz
->ops
->get_trip_type(tz
, count
, &trip_type
);
479 if (trip_type
== THERMAL_TRIP_PASSIVE
)
489 static struct attribute_group thermal_zone_passive_attribute_group
= {
490 .attrs
= thermal_zone_passive_attrs
,
491 .is_visible
= thermal_zone_passive_is_visible
,
494 static const struct attribute_group
*thermal_zone_attribute_groups
[] = {
495 &thermal_zone_attribute_group
,
496 &thermal_zone_mode_attribute_group
,
497 &thermal_zone_passive_attribute_group
,
498 /* This is not NULL terminated as we create the group dynamically */
502 * create_trip_attrs() - create attributes for trip points
503 * @tz: the thermal zone device
504 * @mask: Writeable trip point bitmap.
506 * helper function to instantiate sysfs entries for every trip
507 * point and its properties of a struct thermal_zone_device.
509 * Return: 0 on success, the proper error value otherwise.
511 static int create_trip_attrs(struct thermal_zone_device
*tz
, int mask
)
513 struct attribute
**attrs
;
516 /* This function works only for zones with at least one trip */
520 tz
->trip_type_attrs
= kcalloc(tz
->trips
, sizeof(*tz
->trip_type_attrs
),
522 if (!tz
->trip_type_attrs
)
525 tz
->trip_temp_attrs
= kcalloc(tz
->trips
, sizeof(*tz
->trip_temp_attrs
),
527 if (!tz
->trip_temp_attrs
) {
528 kfree(tz
->trip_type_attrs
);
532 if (tz
->ops
->get_trip_hyst
) {
533 tz
->trip_hyst_attrs
= kcalloc(tz
->trips
,
534 sizeof(*tz
->trip_hyst_attrs
),
536 if (!tz
->trip_hyst_attrs
) {
537 kfree(tz
->trip_type_attrs
);
538 kfree(tz
->trip_temp_attrs
);
543 attrs
= kcalloc(tz
->trips
* 3 + 1, sizeof(*attrs
), GFP_KERNEL
);
545 kfree(tz
->trip_type_attrs
);
546 kfree(tz
->trip_temp_attrs
);
547 if (tz
->ops
->get_trip_hyst
)
548 kfree(tz
->trip_hyst_attrs
);
552 for (indx
= 0; indx
< tz
->trips
; indx
++) {
553 /* create trip type attribute */
554 snprintf(tz
->trip_type_attrs
[indx
].name
, THERMAL_NAME_LENGTH
,
555 "trip_point_%d_type", indx
);
557 sysfs_attr_init(&tz
->trip_type_attrs
[indx
].attr
.attr
);
558 tz
->trip_type_attrs
[indx
].attr
.attr
.name
=
559 tz
->trip_type_attrs
[indx
].name
;
560 tz
->trip_type_attrs
[indx
].attr
.attr
.mode
= S_IRUGO
;
561 tz
->trip_type_attrs
[indx
].attr
.show
= trip_point_type_show
;
562 attrs
[indx
] = &tz
->trip_type_attrs
[indx
].attr
.attr
;
564 /* create trip temp attribute */
565 snprintf(tz
->trip_temp_attrs
[indx
].name
, THERMAL_NAME_LENGTH
,
566 "trip_point_%d_temp", indx
);
568 sysfs_attr_init(&tz
->trip_temp_attrs
[indx
].attr
.attr
);
569 tz
->trip_temp_attrs
[indx
].attr
.attr
.name
=
570 tz
->trip_temp_attrs
[indx
].name
;
571 tz
->trip_temp_attrs
[indx
].attr
.attr
.mode
= S_IRUGO
;
572 tz
->trip_temp_attrs
[indx
].attr
.show
= trip_point_temp_show
;
573 if (IS_ENABLED(CONFIG_THERMAL_WRITABLE_TRIPS
) &&
574 mask
& (1 << indx
)) {
575 tz
->trip_temp_attrs
[indx
].attr
.attr
.mode
|= S_IWUSR
;
576 tz
->trip_temp_attrs
[indx
].attr
.store
=
577 trip_point_temp_store
;
579 attrs
[indx
+ tz
->trips
] = &tz
->trip_temp_attrs
[indx
].attr
.attr
;
581 /* create Optional trip hyst attribute */
582 if (!tz
->ops
->get_trip_hyst
)
584 snprintf(tz
->trip_hyst_attrs
[indx
].name
, THERMAL_NAME_LENGTH
,
585 "trip_point_%d_hyst", indx
);
587 sysfs_attr_init(&tz
->trip_hyst_attrs
[indx
].attr
.attr
);
588 tz
->trip_hyst_attrs
[indx
].attr
.attr
.name
=
589 tz
->trip_hyst_attrs
[indx
].name
;
590 tz
->trip_hyst_attrs
[indx
].attr
.attr
.mode
= S_IRUGO
;
591 tz
->trip_hyst_attrs
[indx
].attr
.show
= trip_point_hyst_show
;
592 if (tz
->ops
->set_trip_hyst
) {
593 tz
->trip_hyst_attrs
[indx
].attr
.attr
.mode
|= S_IWUSR
;
594 tz
->trip_hyst_attrs
[indx
].attr
.store
=
595 trip_point_hyst_store
;
597 attrs
[indx
+ tz
->trips
* 2] =
598 &tz
->trip_hyst_attrs
[indx
].attr
.attr
;
600 attrs
[tz
->trips
* 3] = NULL
;
602 tz
->trips_attribute_group
.attrs
= attrs
;
608 * destroy_trip_attrs() - destroy attributes for trip points
609 * @tz: the thermal zone device
611 * helper function to free resources allocated by create_trip_attrs()
613 static void destroy_trip_attrs(struct thermal_zone_device
*tz
)
618 kfree(tz
->trip_type_attrs
);
619 kfree(tz
->trip_temp_attrs
);
620 if (tz
->ops
->get_trip_hyst
)
621 kfree(tz
->trip_hyst_attrs
);
622 kfree(tz
->trips_attribute_group
.attrs
);
625 int thermal_zone_create_device_groups(struct thermal_zone_device
*tz
,
628 const struct attribute_group
**groups
;
631 /* we need one extra for trips and the NULL to terminate the array */
632 size
= ARRAY_SIZE(thermal_zone_attribute_groups
) + 2;
633 /* This also takes care of API requirement to be NULL terminated */
634 groups
= kcalloc(size
, sizeof(*groups
), GFP_KERNEL
);
638 for (i
= 0; i
< size
- 2; i
++)
639 groups
[i
] = thermal_zone_attribute_groups
[i
];
642 result
= create_trip_attrs(tz
, mask
);
649 groups
[size
- 2] = &tz
->trips_attribute_group
;
652 tz
->device
.groups
= groups
;
657 void thermal_zone_destroy_device_groups(struct thermal_zone_device
*tz
)
663 destroy_trip_attrs(tz
);
665 kfree(tz
->device
.groups
);
668 /* sys I/F for cooling device */
670 thermal_cooling_device_type_show(struct device
*dev
,
671 struct device_attribute
*attr
, char *buf
)
673 struct thermal_cooling_device
*cdev
= to_cooling_device(dev
);
675 return sprintf(buf
, "%s\n", cdev
->type
);
679 thermal_cooling_device_max_state_show(struct device
*dev
,
680 struct device_attribute
*attr
, char *buf
)
682 struct thermal_cooling_device
*cdev
= to_cooling_device(dev
);
686 ret
= cdev
->ops
->get_max_state(cdev
, &state
);
689 return sprintf(buf
, "%ld\n", state
);
693 thermal_cooling_device_cur_state_show(struct device
*dev
,
694 struct device_attribute
*attr
, char *buf
)
696 struct thermal_cooling_device
*cdev
= to_cooling_device(dev
);
700 ret
= cdev
->ops
->get_cur_state(cdev
, &state
);
703 return sprintf(buf
, "%ld\n", state
);
707 thermal_cooling_device_cur_state_store(struct device
*dev
,
708 struct device_attribute
*attr
,
709 const char *buf
, size_t count
)
711 struct thermal_cooling_device
*cdev
= to_cooling_device(dev
);
715 if (sscanf(buf
, "%ld\n", &state
) != 1)
721 result
= cdev
->ops
->set_cur_state(cdev
, state
);
727 static struct device_attribute dev_attr_cdev_type
=
728 __ATTR(type
, 0444, thermal_cooling_device_type_show
, NULL
);
729 static DEVICE_ATTR(max_state
, 0444,
730 thermal_cooling_device_max_state_show
, NULL
);
731 static DEVICE_ATTR(cur_state
, 0644,
732 thermal_cooling_device_cur_state_show
,
733 thermal_cooling_device_cur_state_store
);
735 static struct attribute
*cooling_device_attrs
[] = {
736 &dev_attr_cdev_type
.attr
,
737 &dev_attr_max_state
.attr
,
738 &dev_attr_cur_state
.attr
,
742 static const struct attribute_group cooling_device_attr_group
= {
743 .attrs
= cooling_device_attrs
,
746 static const struct attribute_group
*cooling_device_attr_groups
[] = {
747 &cooling_device_attr_group
,
751 void thermal_cooling_device_setup_sysfs(struct thermal_cooling_device
*cdev
)
753 cdev
->device
.groups
= cooling_device_attr_groups
;
756 /* these helper will be used only at the time of bindig */
758 thermal_cooling_device_trip_point_show(struct device
*dev
,
759 struct device_attribute
*attr
, char *buf
)
761 struct thermal_instance
*instance
;
764 container_of(attr
, struct thermal_instance
, attr
);
766 if (instance
->trip
== THERMAL_TRIPS_NONE
)
767 return sprintf(buf
, "-1\n");
769 return sprintf(buf
, "%d\n", instance
->trip
);
773 thermal_cooling_device_weight_show(struct device
*dev
,
774 struct device_attribute
*attr
, char *buf
)
776 struct thermal_instance
*instance
;
778 instance
= container_of(attr
, struct thermal_instance
, weight_attr
);
780 return sprintf(buf
, "%d\n", instance
->weight
);
784 thermal_cooling_device_weight_store(struct device
*dev
,
785 struct device_attribute
*attr
,
786 const char *buf
, size_t count
)
788 struct thermal_instance
*instance
;
791 ret
= kstrtoint(buf
, 0, &weight
);
795 instance
= container_of(attr
, struct thermal_instance
, weight_attr
);
796 instance
->weight
= weight
;