2 * thermal.c - Generic Thermal Management Sysfs support.
4 * Copyright (C) 2008 Intel Corp
5 * Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
6 * Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2 of the License.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
28 #include <linux/module.h>
29 #include <linux/device.h>
30 #include <linux/err.h>
31 #include <linux/slab.h>
32 #include <linux/kdev_t.h>
33 #include <linux/idr.h>
34 #include <linux/thermal.h>
35 #include <linux/reboot.h>
36 #include <linux/string.h>
38 #include <net/netlink.h>
39 #include <net/genetlink.h>
40 #include <linux/suspend.h>
42 #define CREATE_TRACE_POINTS
43 #include <trace/events/thermal.h>
45 #include "thermal_core.h"
46 #include "thermal_hwmon.h"
48 MODULE_AUTHOR("Zhang Rui");
49 MODULE_DESCRIPTION("Generic thermal management sysfs support");
50 MODULE_LICENSE("GPL v2");
52 static DEFINE_IDR(thermal_tz_idr);
53 static DEFINE_IDR(thermal_cdev_idr);
54 static DEFINE_MUTEX(thermal_idr_lock);
56 static LIST_HEAD(thermal_tz_list);
57 static LIST_HEAD(thermal_cdev_list);
58 static LIST_HEAD(thermal_governor_list);
60 static DEFINE_MUTEX(thermal_list_lock);
61 static DEFINE_MUTEX(thermal_governor_lock);
63 static atomic_t in_suspend;
65 static struct thermal_governor *def_governor;
67 static struct thermal_governor *__find_governor(const char *name)
69 struct thermal_governor *pos;
71 if (!name || !name[0])
74 list_for_each_entry(pos, &thermal_governor_list, governor_list)
75 if (!strncasecmp(name, pos->name, THERMAL_NAME_LENGTH))
82 * bind_previous_governor() - bind the previous governor of the thermal zone
83 * @tz: a valid pointer to a struct thermal_zone_device
84 * @failed_gov_name: the name of the governor that failed to register
86 * Register the previous governor of the thermal zone after a new
87 * governor has failed to be bound.
89 static void bind_previous_governor(struct thermal_zone_device *tz,
90 const char *failed_gov_name)
92 if (tz->governor && tz->governor->bind_to_tz) {
93 if (tz->governor->bind_to_tz(tz)) {
95 "governor %s failed to bind and the previous one (%s) failed to bind again, thermal zone %s has no governor\n",
96 failed_gov_name, tz->governor->name, tz->type);
103 * thermal_set_governor() - Switch to another governor
104 * @tz: a valid pointer to a struct thermal_zone_device
105 * @new_gov: pointer to the new governor
107 * Change the governor of thermal zone @tz.
109 * Return: 0 on success, an error if the new governor's bind_to_tz() failed.
111 static int thermal_set_governor(struct thermal_zone_device *tz,
112 struct thermal_governor *new_gov)
116 if (tz->governor && tz->governor->unbind_from_tz)
117 tz->governor->unbind_from_tz(tz);
119 if (new_gov && new_gov->bind_to_tz) {
120 ret = new_gov->bind_to_tz(tz);
122 bind_previous_governor(tz, new_gov->name);
128 tz->governor = new_gov;
133 int thermal_register_governor(struct thermal_governor *governor)
137 struct thermal_zone_device *pos;
142 mutex_lock(&thermal_governor_lock);
145 if (__find_governor(governor->name) == NULL) {
147 list_add(&governor->governor_list, &thermal_governor_list);
148 if (!def_governor && !strncmp(governor->name,
149 DEFAULT_THERMAL_GOVERNOR, THERMAL_NAME_LENGTH))
150 def_governor = governor;
153 mutex_lock(&thermal_list_lock);
155 list_for_each_entry(pos, &thermal_tz_list, node) {
157 * only thermal zones with specified tz->tzp->governor_name
158 * may run with tz->govenor unset
163 name = pos->tzp->governor_name;
165 if (!strncasecmp(name, governor->name, THERMAL_NAME_LENGTH)) {
168 ret = thermal_set_governor(pos, governor);
170 dev_err(&pos->device,
171 "Failed to set governor %s for thermal zone %s: %d\n",
172 governor->name, pos->type, ret);
176 mutex_unlock(&thermal_list_lock);
177 mutex_unlock(&thermal_governor_lock);
182 void thermal_unregister_governor(struct thermal_governor *governor)
184 struct thermal_zone_device *pos;
189 mutex_lock(&thermal_governor_lock);
191 if (__find_governor(governor->name) == NULL)
194 mutex_lock(&thermal_list_lock);
196 list_for_each_entry(pos, &thermal_tz_list, node) {
197 if (!strncasecmp(pos->governor->name, governor->name,
198 THERMAL_NAME_LENGTH))
199 thermal_set_governor(pos, NULL);
202 mutex_unlock(&thermal_list_lock);
203 list_del(&governor->governor_list);
205 mutex_unlock(&thermal_governor_lock);
209 static int get_idr(struct idr *idr, struct mutex *lock, int *id)
215 ret = idr_alloc(idr, NULL, 0, 0, GFP_KERNEL);
218 if (unlikely(ret < 0))
224 static void release_idr(struct idr *idr, struct mutex *lock, int id)
233 int get_tz_trend(struct thermal_zone_device *tz, int trip)
235 enum thermal_trend trend;
237 if (tz->emul_temperature || !tz->ops->get_trend ||
238 tz->ops->get_trend(tz, trip, &trend)) {
239 if (tz->temperature > tz->last_temperature)
240 trend = THERMAL_TREND_RAISING;
241 else if (tz->temperature < tz->last_temperature)
242 trend = THERMAL_TREND_DROPPING;
244 trend = THERMAL_TREND_STABLE;
249 EXPORT_SYMBOL(get_tz_trend);
251 struct thermal_instance *get_thermal_instance(struct thermal_zone_device *tz,
252 struct thermal_cooling_device *cdev, int trip)
254 struct thermal_instance *pos = NULL;
255 struct thermal_instance *target_instance = NULL;
257 mutex_lock(&tz->lock);
258 mutex_lock(&cdev->lock);
260 list_for_each_entry(pos, &tz->thermal_instances, tz_node) {
261 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
262 target_instance = pos;
267 mutex_unlock(&cdev->lock);
268 mutex_unlock(&tz->lock);
270 return target_instance;
272 EXPORT_SYMBOL(get_thermal_instance);
274 static void print_bind_err_msg(struct thermal_zone_device *tz,
275 struct thermal_cooling_device *cdev, int ret)
277 dev_err(&tz->device, "binding zone %s with cdev %s failed:%d\n",
278 tz->type, cdev->type, ret);
281 static void __bind(struct thermal_zone_device *tz, int mask,
282 struct thermal_cooling_device *cdev,
283 unsigned long *limits,
288 for (i = 0; i < tz->trips; i++) {
289 if (mask & (1 << i)) {
290 unsigned long upper, lower;
292 upper = THERMAL_NO_LIMIT;
293 lower = THERMAL_NO_LIMIT;
295 lower = limits[i * 2];
296 upper = limits[i * 2 + 1];
298 ret = thermal_zone_bind_cooling_device(tz, i, cdev,
302 print_bind_err_msg(tz, cdev, ret);
307 static void __unbind(struct thermal_zone_device *tz, int mask,
308 struct thermal_cooling_device *cdev)
312 for (i = 0; i < tz->trips; i++)
314 thermal_zone_unbind_cooling_device(tz, i, cdev);
317 static void bind_cdev(struct thermal_cooling_device *cdev)
320 const struct thermal_zone_params *tzp;
321 struct thermal_zone_device *pos = NULL;
323 mutex_lock(&thermal_list_lock);
325 list_for_each_entry(pos, &thermal_tz_list, node) {
326 if (!pos->tzp && !pos->ops->bind)
329 if (pos->ops->bind) {
330 ret = pos->ops->bind(pos, cdev);
332 print_bind_err_msg(pos, cdev, ret);
337 if (!tzp || !tzp->tbp)
340 for (i = 0; i < tzp->num_tbps; i++) {
341 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
343 if (tzp->tbp[i].match(pos, cdev))
345 tzp->tbp[i].cdev = cdev;
346 __bind(pos, tzp->tbp[i].trip_mask, cdev,
347 tzp->tbp[i].binding_limits,
352 mutex_unlock(&thermal_list_lock);
355 static void bind_tz(struct thermal_zone_device *tz)
358 struct thermal_cooling_device *pos = NULL;
359 const struct thermal_zone_params *tzp = tz->tzp;
361 if (!tzp && !tz->ops->bind)
364 mutex_lock(&thermal_list_lock);
366 /* If there is ops->bind, try to use ops->bind */
368 list_for_each_entry(pos, &thermal_cdev_list, node) {
369 ret = tz->ops->bind(tz, pos);
371 print_bind_err_msg(tz, pos, ret);
376 if (!tzp || !tzp->tbp)
379 list_for_each_entry(pos, &thermal_cdev_list, node) {
380 for (i = 0; i < tzp->num_tbps; i++) {
381 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
383 if (tzp->tbp[i].match(tz, pos))
385 tzp->tbp[i].cdev = pos;
386 __bind(tz, tzp->tbp[i].trip_mask, pos,
387 tzp->tbp[i].binding_limits,
392 mutex_unlock(&thermal_list_lock);
395 static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
399 mod_delayed_work(system_freezable_wq, &tz->poll_queue,
400 round_jiffies(msecs_to_jiffies(delay)));
402 mod_delayed_work(system_freezable_wq, &tz->poll_queue,
403 msecs_to_jiffies(delay));
405 cancel_delayed_work(&tz->poll_queue);
408 static void monitor_thermal_zone(struct thermal_zone_device *tz)
410 mutex_lock(&tz->lock);
413 thermal_zone_device_set_polling(tz, tz->passive_delay);
414 else if (tz->polling_delay)
415 thermal_zone_device_set_polling(tz, tz->polling_delay);
417 thermal_zone_device_set_polling(tz, 0);
419 mutex_unlock(&tz->lock);
422 static void handle_non_critical_trips(struct thermal_zone_device *tz,
423 int trip, enum thermal_trip_type trip_type)
425 tz->governor ? tz->governor->throttle(tz, trip) :
426 def_governor->throttle(tz, trip);
429 static void handle_critical_trips(struct thermal_zone_device *tz,
430 int trip, enum thermal_trip_type trip_type)
434 tz->ops->get_trip_temp(tz, trip, &trip_temp);
436 /* If we have not crossed the trip_temp, we do not care. */
437 if (trip_temp <= 0 || tz->temperature < trip_temp)
440 trace_thermal_zone_trip(tz, trip, trip_type);
443 tz->ops->notify(tz, trip, trip_type);
445 if (trip_type == THERMAL_TRIP_CRITICAL) {
446 dev_emerg(&tz->device,
447 "critical temperature reached(%d C),shutting down\n",
448 tz->temperature / 1000);
449 orderly_poweroff(true);
453 static void handle_thermal_trip(struct thermal_zone_device *tz, int trip)
455 enum thermal_trip_type type;
457 tz->ops->get_trip_type(tz, trip, &type);
459 if (type == THERMAL_TRIP_CRITICAL || type == THERMAL_TRIP_HOT)
460 handle_critical_trips(tz, trip, type);
462 handle_non_critical_trips(tz, trip, type);
464 * Alright, we handled this trip successfully.
465 * So, start monitoring again.
467 monitor_thermal_zone(tz);
471 * thermal_zone_get_temp() - returns the temperature of a thermal zone
472 * @tz: a valid pointer to a struct thermal_zone_device
473 * @temp: a valid pointer to where to store the resulting temperature.
475 * When a valid thermal zone reference is passed, it will fetch its
476 * temperature and fill @temp.
478 * Return: On success returns 0, an error code otherwise
480 int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp)
484 int crit_temp = INT_MAX;
485 enum thermal_trip_type type;
487 if (!tz || IS_ERR(tz) || !tz->ops->get_temp)
490 mutex_lock(&tz->lock);
492 ret = tz->ops->get_temp(tz, temp);
494 if (IS_ENABLED(CONFIG_THERMAL_EMULATION) && tz->emul_temperature) {
495 for (count = 0; count < tz->trips; count++) {
496 ret = tz->ops->get_trip_type(tz, count, &type);
497 if (!ret && type == THERMAL_TRIP_CRITICAL) {
498 ret = tz->ops->get_trip_temp(tz, count,
505 * Only allow emulating a temperature when the real temperature
506 * is below the critical temperature so that the emulation code
507 * cannot hide critical conditions.
509 if (!ret && *temp < crit_temp)
510 *temp = tz->emul_temperature;
513 mutex_unlock(&tz->lock);
517 EXPORT_SYMBOL_GPL(thermal_zone_get_temp);
519 static void thermal_zone_set_trips(struct thermal_zone_device *tz)
523 int trip_temp, hysteresis;
524 int temp = tz->temperature;
527 if (!tz->ops->set_trips)
530 for (i = 0; i < tz->trips; i++) {
533 tz->ops->get_trip_temp(tz, i, &trip_temp);
534 tz->ops->get_trip_hyst(tz, i, &hysteresis);
536 trip_low = trip_temp - hysteresis;
538 if (trip_low < temp && trip_low > low)
541 if (trip_temp > temp && trip_temp < high)
545 /* No need to change trip points */
546 if (tz->prev_low_trip == low && tz->prev_high_trip == high)
549 tz->prev_low_trip = low;
550 tz->prev_high_trip = high;
552 dev_dbg(&tz->device, "new temperature boundaries: %d < x < %d\n",
555 ret = tz->ops->set_trips(tz, low, high);
557 dev_err(&tz->device, "Failed to set trips: %d\n", ret);
560 static void update_temperature(struct thermal_zone_device *tz)
564 ret = thermal_zone_get_temp(tz, &temp);
567 dev_warn(&tz->device,
568 "failed to read out thermal zone (%d)\n",
573 mutex_lock(&tz->lock);
574 tz->last_temperature = tz->temperature;
575 tz->temperature = temp;
576 mutex_unlock(&tz->lock);
578 trace_thermal_temperature(tz);
579 if (tz->last_temperature == THERMAL_TEMP_INVALID)
580 dev_dbg(&tz->device, "last_temperature N/A, current_temperature=%d\n",
583 dev_dbg(&tz->device, "last_temperature=%d, current_temperature=%d\n",
584 tz->last_temperature, tz->temperature);
587 static void thermal_zone_device_reset(struct thermal_zone_device *tz)
589 struct thermal_instance *pos;
591 tz->temperature = THERMAL_TEMP_INVALID;
593 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
594 pos->initialized = false;
597 void thermal_zone_device_update(struct thermal_zone_device *tz)
601 if (atomic_read(&in_suspend))
604 if (!tz->ops->get_temp)
607 update_temperature(tz);
609 thermal_zone_set_trips(tz);
611 for (count = 0; count < tz->trips; count++)
612 handle_thermal_trip(tz, count);
614 EXPORT_SYMBOL_GPL(thermal_zone_device_update);
616 static void thermal_zone_device_check(struct work_struct *work)
618 struct thermal_zone_device *tz = container_of(work, struct
621 thermal_zone_device_update(tz);
624 /* sys I/F for thermal zone */
626 #define to_thermal_zone(_dev) \
627 container_of(_dev, struct thermal_zone_device, device)
630 type_show(struct device *dev, struct device_attribute *attr, char *buf)
632 struct thermal_zone_device *tz = to_thermal_zone(dev);
634 return sprintf(buf, "%s\n", tz->type);
638 temp_show(struct device *dev, struct device_attribute *attr, char *buf)
640 struct thermal_zone_device *tz = to_thermal_zone(dev);
641 int temperature, ret;
643 ret = thermal_zone_get_temp(tz, &temperature);
648 return sprintf(buf, "%d\n", temperature);
652 mode_show(struct device *dev, struct device_attribute *attr, char *buf)
654 struct thermal_zone_device *tz = to_thermal_zone(dev);
655 enum thermal_device_mode mode;
658 if (!tz->ops->get_mode)
661 result = tz->ops->get_mode(tz, &mode);
665 return sprintf(buf, "%s\n", mode == THERMAL_DEVICE_ENABLED ? "enabled"
670 mode_store(struct device *dev, struct device_attribute *attr,
671 const char *buf, size_t count)
673 struct thermal_zone_device *tz = to_thermal_zone(dev);
676 if (!tz->ops->set_mode)
679 if (!strncmp(buf, "enabled", sizeof("enabled") - 1))
680 result = tz->ops->set_mode(tz, THERMAL_DEVICE_ENABLED);
681 else if (!strncmp(buf, "disabled", sizeof("disabled") - 1))
682 result = tz->ops->set_mode(tz, THERMAL_DEVICE_DISABLED);
693 trip_point_type_show(struct device *dev, struct device_attribute *attr,
696 struct thermal_zone_device *tz = to_thermal_zone(dev);
697 enum thermal_trip_type type;
700 if (!tz->ops->get_trip_type)
703 if (!sscanf(attr->attr.name, "trip_point_%d_type", &trip))
706 result = tz->ops->get_trip_type(tz, trip, &type);
711 case THERMAL_TRIP_CRITICAL:
712 return sprintf(buf, "critical\n");
713 case THERMAL_TRIP_HOT:
714 return sprintf(buf, "hot\n");
715 case THERMAL_TRIP_PASSIVE:
716 return sprintf(buf, "passive\n");
717 case THERMAL_TRIP_ACTIVE:
718 return sprintf(buf, "active\n");
720 return sprintf(buf, "unknown\n");
725 trip_point_temp_store(struct device *dev, struct device_attribute *attr,
726 const char *buf, size_t count)
728 struct thermal_zone_device *tz = to_thermal_zone(dev);
730 unsigned long temperature;
732 if (!tz->ops->set_trip_temp)
735 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
738 if (kstrtoul(buf, 10, &temperature))
741 ret = tz->ops->set_trip_temp(tz, trip, temperature);
744 thermal_zone_set_trips(tz);
746 return ret ? ret : count;
750 trip_point_temp_show(struct device *dev, struct device_attribute *attr,
753 struct thermal_zone_device *tz = to_thermal_zone(dev);
757 if (!tz->ops->get_trip_temp)
760 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
763 ret = tz->ops->get_trip_temp(tz, trip, &temperature);
768 return sprintf(buf, "%d\n", temperature);
772 trip_point_hyst_store(struct device *dev, struct device_attribute *attr,
773 const char *buf, size_t count)
775 struct thermal_zone_device *tz = to_thermal_zone(dev);
779 if (!tz->ops->set_trip_hyst)
782 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
785 if (kstrtoint(buf, 10, &temperature))
789 * We are not doing any check on the 'temperature' value
790 * here. The driver implementing 'set_trip_hyst' has to
793 ret = tz->ops->set_trip_hyst(tz, trip, temperature);
796 thermal_zone_set_trips(tz);
798 return ret ? ret : count;
802 trip_point_hyst_show(struct device *dev, struct device_attribute *attr,
805 struct thermal_zone_device *tz = to_thermal_zone(dev);
809 if (!tz->ops->get_trip_hyst)
812 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
815 ret = tz->ops->get_trip_hyst(tz, trip, &temperature);
817 return ret ? ret : sprintf(buf, "%d\n", temperature);
821 passive_store(struct device *dev, struct device_attribute *attr,
822 const char *buf, size_t count)
824 struct thermal_zone_device *tz = to_thermal_zone(dev);
825 struct thermal_cooling_device *cdev = NULL;
828 if (!sscanf(buf, "%d\n", &state))
831 /* sanity check: values below 1000 millicelcius don't make sense
832 * and can cause the system to go into a thermal heart attack
834 if (state && state < 1000)
837 if (state && !tz->forced_passive) {
838 mutex_lock(&thermal_list_lock);
839 list_for_each_entry(cdev, &thermal_cdev_list, node) {
840 if (!strncmp("Processor", cdev->type,
841 sizeof("Processor")))
842 thermal_zone_bind_cooling_device(tz,
843 THERMAL_TRIPS_NONE, cdev,
846 THERMAL_WEIGHT_DEFAULT);
848 mutex_unlock(&thermal_list_lock);
849 if (!tz->passive_delay)
850 tz->passive_delay = 1000;
851 } else if (!state && tz->forced_passive) {
852 mutex_lock(&thermal_list_lock);
853 list_for_each_entry(cdev, &thermal_cdev_list, node) {
854 if (!strncmp("Processor", cdev->type,
855 sizeof("Processor")))
856 thermal_zone_unbind_cooling_device(tz,
860 mutex_unlock(&thermal_list_lock);
861 tz->passive_delay = 0;
864 tz->forced_passive = state;
866 thermal_zone_device_update(tz);
872 passive_show(struct device *dev, struct device_attribute *attr,
875 struct thermal_zone_device *tz = to_thermal_zone(dev);
877 return sprintf(buf, "%d\n", tz->forced_passive);
881 policy_store(struct device *dev, struct device_attribute *attr,
882 const char *buf, size_t count)
885 struct thermal_zone_device *tz = to_thermal_zone(dev);
886 struct thermal_governor *gov;
887 char name[THERMAL_NAME_LENGTH];
889 snprintf(name, sizeof(name), "%s", buf);
891 mutex_lock(&thermal_governor_lock);
892 mutex_lock(&tz->lock);
894 gov = __find_governor(strim(name));
898 ret = thermal_set_governor(tz, gov);
903 mutex_unlock(&tz->lock);
904 mutex_unlock(&thermal_governor_lock);
909 policy_show(struct device *dev, struct device_attribute *devattr, char *buf)
911 struct thermal_zone_device *tz = to_thermal_zone(dev);
913 return sprintf(buf, "%s\n", tz->governor->name);
917 available_policies_show(struct device *dev, struct device_attribute *devattr,
920 struct thermal_governor *pos;
922 ssize_t size = PAGE_SIZE;
924 mutex_lock(&thermal_governor_lock);
926 list_for_each_entry(pos, &thermal_governor_list, governor_list) {
927 size = PAGE_SIZE - count;
928 count += scnprintf(buf + count, size, "%s ", pos->name);
930 count += scnprintf(buf + count, size, "\n");
932 mutex_unlock(&thermal_governor_lock);
938 emul_temp_store(struct device *dev, struct device_attribute *attr,
939 const char *buf, size_t count)
941 struct thermal_zone_device *tz = to_thermal_zone(dev);
943 unsigned long temperature;
945 if (kstrtoul(buf, 10, &temperature))
948 if (!tz->ops->set_emul_temp) {
949 mutex_lock(&tz->lock);
950 tz->emul_temperature = temperature;
951 mutex_unlock(&tz->lock);
953 ret = tz->ops->set_emul_temp(tz, temperature);
957 thermal_zone_device_update(tz);
959 return ret ? ret : count;
961 static DEVICE_ATTR(emul_temp, S_IWUSR, NULL, emul_temp_store);
964 sustainable_power_show(struct device *dev, struct device_attribute *devattr,
967 struct thermal_zone_device *tz = to_thermal_zone(dev);
970 return sprintf(buf, "%u\n", tz->tzp->sustainable_power);
976 sustainable_power_store(struct device *dev, struct device_attribute *devattr,
977 const char *buf, size_t count)
979 struct thermal_zone_device *tz = to_thermal_zone(dev);
980 u32 sustainable_power;
985 if (kstrtou32(buf, 10, &sustainable_power))
988 tz->tzp->sustainable_power = sustainable_power;
992 static DEVICE_ATTR(sustainable_power, S_IWUSR | S_IRUGO, sustainable_power_show,
993 sustainable_power_store);
995 #define create_s32_tzp_attr(name) \
997 name##_show(struct device *dev, struct device_attribute *devattr, \
1000 struct thermal_zone_device *tz = to_thermal_zone(dev); \
1003 return sprintf(buf, "%u\n", tz->tzp->name); \
1009 name##_store(struct device *dev, struct device_attribute *devattr, \
1010 const char *buf, size_t count) \
1012 struct thermal_zone_device *tz = to_thermal_zone(dev); \
1018 if (kstrtos32(buf, 10, &value)) \
1021 tz->tzp->name = value; \
1025 static DEVICE_ATTR(name, S_IWUSR | S_IRUGO, name##_show, name##_store)
1027 create_s32_tzp_attr(k_po);
1028 create_s32_tzp_attr(k_pu);
1029 create_s32_tzp_attr(k_i);
1030 create_s32_tzp_attr(k_d);
1031 create_s32_tzp_attr(integral_cutoff);
1032 create_s32_tzp_attr(slope);
1033 create_s32_tzp_attr(offset);
1034 #undef create_s32_tzp_attr
1036 static struct device_attribute *dev_tzp_attrs[] = {
1037 &dev_attr_sustainable_power,
1042 &dev_attr_integral_cutoff,
1047 static int create_tzp_attrs(struct device *dev)
1051 for (i = 0; i < ARRAY_SIZE(dev_tzp_attrs); i++) {
1053 struct device_attribute *dev_attr = dev_tzp_attrs[i];
1055 ret = device_create_file(dev, dev_attr);
1064 * power_actor_get_max_power() - get the maximum power that a cdev can consume
1065 * @cdev: pointer to &thermal_cooling_device
1066 * @tz: a valid thermal zone device pointer
1067 * @max_power: pointer in which to store the maximum power
1069 * Calculate the maximum power consumption in milliwats that the
1070 * cooling device can currently consume and store it in @max_power.
1072 * Return: 0 on success, -EINVAL if @cdev doesn't support the
1073 * power_actor API or -E* on other error.
1075 int power_actor_get_max_power(struct thermal_cooling_device *cdev,
1076 struct thermal_zone_device *tz, u32 *max_power)
1078 if (!cdev_is_power_actor(cdev))
1081 return cdev->ops->state2power(cdev, tz, 0, max_power);
1085 * power_actor_get_min_power() - get the mainimum power that a cdev can consume
1086 * @cdev: pointer to &thermal_cooling_device
1087 * @tz: a valid thermal zone device pointer
1088 * @min_power: pointer in which to store the minimum power
1090 * Calculate the minimum power consumption in milliwatts that the
1091 * cooling device can currently consume and store it in @min_power.
1093 * Return: 0 on success, -EINVAL if @cdev doesn't support the
1094 * power_actor API or -E* on other error.
1096 int power_actor_get_min_power(struct thermal_cooling_device *cdev,
1097 struct thermal_zone_device *tz, u32 *min_power)
1099 unsigned long max_state;
1102 if (!cdev_is_power_actor(cdev))
1105 ret = cdev->ops->get_max_state(cdev, &max_state);
1109 return cdev->ops->state2power(cdev, tz, max_state, min_power);
1113 * power_actor_set_power() - limit the maximum power that a cooling device can consume
1114 * @cdev: pointer to &thermal_cooling_device
1115 * @instance: thermal instance to update
1116 * @power: the power in milliwatts
1118 * Set the cooling device to consume at most @power milliwatts.
1120 * Return: 0 on success, -EINVAL if the cooling device does not
1121 * implement the power actor API or -E* for other failures.
1123 int power_actor_set_power(struct thermal_cooling_device *cdev,
1124 struct thermal_instance *instance, u32 power)
1126 unsigned long state;
1129 if (!cdev_is_power_actor(cdev))
1132 ret = cdev->ops->power2state(cdev, instance->tz, power, &state);
1136 instance->target = state;
1137 cdev->updated = false;
1138 thermal_cdev_update(cdev);
1143 static DEVICE_ATTR(type, 0444, type_show, NULL);
1144 static DEVICE_ATTR(temp, 0444, temp_show, NULL);
1145 static DEVICE_ATTR(mode, 0644, mode_show, mode_store);
1146 static DEVICE_ATTR(passive, S_IRUGO | S_IWUSR, passive_show, passive_store);
1147 static DEVICE_ATTR(policy, S_IRUGO | S_IWUSR, policy_show, policy_store);
1148 static DEVICE_ATTR(available_policies, S_IRUGO, available_policies_show, NULL);
1150 /* sys I/F for cooling device */
1151 #define to_cooling_device(_dev) \
1152 container_of(_dev, struct thermal_cooling_device, device)
1155 thermal_cooling_device_type_show(struct device *dev,
1156 struct device_attribute *attr, char *buf)
1158 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1160 return sprintf(buf, "%s\n", cdev->type);
1164 thermal_cooling_device_max_state_show(struct device *dev,
1165 struct device_attribute *attr, char *buf)
1167 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1168 unsigned long state;
1171 ret = cdev->ops->get_max_state(cdev, &state);
1174 return sprintf(buf, "%ld\n", state);
1178 thermal_cooling_device_cur_state_show(struct device *dev,
1179 struct device_attribute *attr, char *buf)
1181 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1182 unsigned long state;
1185 ret = cdev->ops->get_cur_state(cdev, &state);
1188 return sprintf(buf, "%ld\n", state);
1192 thermal_cooling_device_cur_state_store(struct device *dev,
1193 struct device_attribute *attr,
1194 const char *buf, size_t count)
1196 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1197 unsigned long state;
1200 if (!sscanf(buf, "%ld\n", &state))
1203 if ((long)state < 0)
1206 result = cdev->ops->set_cur_state(cdev, state);
1212 static struct device_attribute dev_attr_cdev_type =
1213 __ATTR(type, 0444, thermal_cooling_device_type_show, NULL);
1214 static DEVICE_ATTR(max_state, 0444,
1215 thermal_cooling_device_max_state_show, NULL);
1216 static DEVICE_ATTR(cur_state, 0644,
1217 thermal_cooling_device_cur_state_show,
1218 thermal_cooling_device_cur_state_store);
1221 thermal_cooling_device_trip_point_show(struct device *dev,
1222 struct device_attribute *attr, char *buf)
1224 struct thermal_instance *instance;
1227 container_of(attr, struct thermal_instance, attr);
1229 if (instance->trip == THERMAL_TRIPS_NONE)
1230 return sprintf(buf, "-1\n");
1232 return sprintf(buf, "%d\n", instance->trip);
1235 static struct attribute *cooling_device_attrs[] = {
1236 &dev_attr_cdev_type.attr,
1237 &dev_attr_max_state.attr,
1238 &dev_attr_cur_state.attr,
1242 static const struct attribute_group cooling_device_attr_group = {
1243 .attrs = cooling_device_attrs,
1246 static const struct attribute_group *cooling_device_attr_groups[] = {
1247 &cooling_device_attr_group,
1252 thermal_cooling_device_weight_show(struct device *dev,
1253 struct device_attribute *attr, char *buf)
1255 struct thermal_instance *instance;
1257 instance = container_of(attr, struct thermal_instance, weight_attr);
1259 return sprintf(buf, "%d\n", instance->weight);
1263 thermal_cooling_device_weight_store(struct device *dev,
1264 struct device_attribute *attr,
1265 const char *buf, size_t count)
1267 struct thermal_instance *instance;
1270 ret = kstrtoint(buf, 0, &weight);
1274 instance = container_of(attr, struct thermal_instance, weight_attr);
1275 instance->weight = weight;
1279 /* Device management */
1282 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
1283 * @tz: pointer to struct thermal_zone_device
1284 * @trip: indicates which trip point the cooling devices is
1285 * associated with in this thermal zone.
1286 * @cdev: pointer to struct thermal_cooling_device
1287 * @upper: the Maximum cooling state for this trip point.
1288 * THERMAL_NO_LIMIT means no upper limit,
1289 * and the cooling device can be in max_state.
1290 * @lower: the Minimum cooling state can be used for this trip point.
1291 * THERMAL_NO_LIMIT means no lower limit,
1292 * and the cooling device can be in cooling state 0.
1293 * @weight: The weight of the cooling device to be bound to the
1294 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
1297 * This interface function bind a thermal cooling device to the certain trip
1298 * point of a thermal zone device.
1299 * This function is usually called in the thermal zone device .bind callback.
1301 * Return: 0 on success, the proper error value otherwise.
1303 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
1305 struct thermal_cooling_device *cdev,
1306 unsigned long upper, unsigned long lower,
1307 unsigned int weight)
1309 struct thermal_instance *dev;
1310 struct thermal_instance *pos;
1311 struct thermal_zone_device *pos1;
1312 struct thermal_cooling_device *pos2;
1313 unsigned long max_state;
1316 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
1319 list_for_each_entry(pos1, &thermal_tz_list, node) {
1323 list_for_each_entry(pos2, &thermal_cdev_list, node) {
1328 if (tz != pos1 || cdev != pos2)
1331 ret = cdev->ops->get_max_state(cdev, &max_state);
1335 /* lower default 0, upper default max_state */
1336 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
1337 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
1339 if (lower > upper || upper > max_state)
1343 kzalloc(sizeof(struct thermal_instance), GFP_KERNEL);
1351 dev->target = THERMAL_NO_TARGET;
1352 dev->weight = weight;
1354 result = get_idr(&tz->idr, &tz->lock, &dev->id);
1358 sprintf(dev->name, "cdev%d", dev->id);
1360 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
1364 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
1365 sysfs_attr_init(&dev->attr.attr);
1366 dev->attr.attr.name = dev->attr_name;
1367 dev->attr.attr.mode = 0444;
1368 dev->attr.show = thermal_cooling_device_trip_point_show;
1369 result = device_create_file(&tz->device, &dev->attr);
1371 goto remove_symbol_link;
1373 sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
1374 sysfs_attr_init(&dev->weight_attr.attr);
1375 dev->weight_attr.attr.name = dev->weight_attr_name;
1376 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
1377 dev->weight_attr.show = thermal_cooling_device_weight_show;
1378 dev->weight_attr.store = thermal_cooling_device_weight_store;
1379 result = device_create_file(&tz->device, &dev->weight_attr);
1381 goto remove_trip_file;
1383 mutex_lock(&tz->lock);
1384 mutex_lock(&cdev->lock);
1385 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
1386 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1391 list_add_tail(&dev->tz_node, &tz->thermal_instances);
1392 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
1393 atomic_set(&tz->need_update, 1);
1395 mutex_unlock(&cdev->lock);
1396 mutex_unlock(&tz->lock);
1401 device_remove_file(&tz->device, &dev->weight_attr);
1403 device_remove_file(&tz->device, &dev->attr);
1405 sysfs_remove_link(&tz->device.kobj, dev->name);
1407 release_idr(&tz->idr, &tz->lock, dev->id);
1412 EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
1415 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
1417 * @tz: pointer to a struct thermal_zone_device.
1418 * @trip: indicates which trip point the cooling devices is
1419 * associated with in this thermal zone.
1420 * @cdev: pointer to a struct thermal_cooling_device.
1422 * This interface function unbind a thermal cooling device from the certain
1423 * trip point of a thermal zone device.
1424 * This function is usually called in the thermal zone device .unbind callback.
1426 * Return: 0 on success, the proper error value otherwise.
1428 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
1430 struct thermal_cooling_device *cdev)
1432 struct thermal_instance *pos, *next;
1434 mutex_lock(&tz->lock);
1435 mutex_lock(&cdev->lock);
1436 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
1437 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1438 list_del(&pos->tz_node);
1439 list_del(&pos->cdev_node);
1440 mutex_unlock(&cdev->lock);
1441 mutex_unlock(&tz->lock);
1445 mutex_unlock(&cdev->lock);
1446 mutex_unlock(&tz->lock);
1451 device_remove_file(&tz->device, &pos->weight_attr);
1452 device_remove_file(&tz->device, &pos->attr);
1453 sysfs_remove_link(&tz->device.kobj, pos->name);
1454 release_idr(&tz->idr, &tz->lock, pos->id);
1458 EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
1460 static void thermal_release(struct device *dev)
1462 struct thermal_zone_device *tz;
1463 struct thermal_cooling_device *cdev;
1465 if (!strncmp(dev_name(dev), "thermal_zone",
1466 sizeof("thermal_zone") - 1)) {
1467 tz = to_thermal_zone(dev);
1469 } else if(!strncmp(dev_name(dev), "cooling_device",
1470 sizeof("cooling_device") - 1)){
1471 cdev = to_cooling_device(dev);
1476 static struct class thermal_class = {
1478 .dev_release = thermal_release,
1482 * __thermal_cooling_device_register() - register a new thermal cooling device
1483 * @np: a pointer to a device tree node.
1484 * @type: the thermal cooling device type.
1485 * @devdata: device private data.
1486 * @ops: standard thermal cooling devices callbacks.
1488 * This interface function adds a new thermal cooling device (fan/processor/...)
1489 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1490 * to all the thermal zone devices registered at the same time.
1491 * It also gives the opportunity to link the cooling device to a device tree
1492 * node, so that it can be bound to a thermal zone created out of device tree.
1494 * Return: a pointer to the created struct thermal_cooling_device or an
1495 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1497 static struct thermal_cooling_device *
1498 __thermal_cooling_device_register(struct device_node *np,
1499 char *type, void *devdata,
1500 const struct thermal_cooling_device_ops *ops)
1502 struct thermal_cooling_device *cdev;
1503 struct thermal_zone_device *pos = NULL;
1506 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1507 return ERR_PTR(-EINVAL);
1509 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
1510 !ops->set_cur_state)
1511 return ERR_PTR(-EINVAL);
1513 cdev = kzalloc(sizeof(struct thermal_cooling_device), GFP_KERNEL);
1515 return ERR_PTR(-ENOMEM);
1517 result = get_idr(&thermal_cdev_idr, &thermal_idr_lock, &cdev->id);
1520 return ERR_PTR(result);
1523 strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
1524 mutex_init(&cdev->lock);
1525 INIT_LIST_HEAD(&cdev->thermal_instances);
1528 cdev->updated = false;
1529 cdev->device.class = &thermal_class;
1530 cdev->device.groups = cooling_device_attr_groups;
1531 cdev->devdata = devdata;
1532 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
1533 result = device_register(&cdev->device);
1535 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1537 return ERR_PTR(result);
1540 /* Add 'this' new cdev to the global cdev list */
1541 mutex_lock(&thermal_list_lock);
1542 list_add(&cdev->node, &thermal_cdev_list);
1543 mutex_unlock(&thermal_list_lock);
1545 /* Update binding information for 'this' new cdev */
1548 mutex_lock(&thermal_list_lock);
1549 list_for_each_entry(pos, &thermal_tz_list, node)
1550 if (atomic_cmpxchg(&pos->need_update, 1, 0))
1551 thermal_zone_device_update(pos);
1552 mutex_unlock(&thermal_list_lock);
1558 * thermal_cooling_device_register() - register a new thermal cooling device
1559 * @type: the thermal cooling device type.
1560 * @devdata: device private data.
1561 * @ops: standard thermal cooling devices callbacks.
1563 * This interface function adds a new thermal cooling device (fan/processor/...)
1564 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1565 * to all the thermal zone devices registered at the same time.
1567 * Return: a pointer to the created struct thermal_cooling_device or an
1568 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1570 struct thermal_cooling_device *
1571 thermal_cooling_device_register(char *type, void *devdata,
1572 const struct thermal_cooling_device_ops *ops)
1574 return __thermal_cooling_device_register(NULL, type, devdata, ops);
1576 EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
1579 * thermal_of_cooling_device_register() - register an OF thermal cooling device
1580 * @np: a pointer to a device tree node.
1581 * @type: the thermal cooling device type.
1582 * @devdata: device private data.
1583 * @ops: standard thermal cooling devices callbacks.
1585 * This function will register a cooling device with device tree node reference.
1586 * This interface function adds a new thermal cooling device (fan/processor/...)
1587 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1588 * to all the thermal zone devices registered at the same time.
1590 * Return: a pointer to the created struct thermal_cooling_device or an
1591 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1593 struct thermal_cooling_device *
1594 thermal_of_cooling_device_register(struct device_node *np,
1595 char *type, void *devdata,
1596 const struct thermal_cooling_device_ops *ops)
1598 return __thermal_cooling_device_register(np, type, devdata, ops);
1600 EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
1603 * thermal_cooling_device_unregister - removes the registered thermal cooling device
1604 * @cdev: the thermal cooling device to remove.
1606 * thermal_cooling_device_unregister() must be called when the device is no
1609 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1612 const struct thermal_zone_params *tzp;
1613 struct thermal_zone_device *tz;
1614 struct thermal_cooling_device *pos = NULL;
1619 mutex_lock(&thermal_list_lock);
1620 list_for_each_entry(pos, &thermal_cdev_list, node)
1624 /* thermal cooling device not found */
1625 mutex_unlock(&thermal_list_lock);
1628 list_del(&cdev->node);
1630 /* Unbind all thermal zones associated with 'this' cdev */
1631 list_for_each_entry(tz, &thermal_tz_list, node) {
1632 if (tz->ops->unbind) {
1633 tz->ops->unbind(tz, cdev);
1637 if (!tz->tzp || !tz->tzp->tbp)
1641 for (i = 0; i < tzp->num_tbps; i++) {
1642 if (tzp->tbp[i].cdev == cdev) {
1643 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1644 tzp->tbp[i].cdev = NULL;
1649 mutex_unlock(&thermal_list_lock);
1652 device_remove_file(&cdev->device, &dev_attr_cdev_type);
1653 device_remove_file(&cdev->device, &dev_attr_max_state);
1654 device_remove_file(&cdev->device, &dev_attr_cur_state);
1656 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1657 device_unregister(&cdev->device);
1660 EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1662 void thermal_cdev_update(struct thermal_cooling_device *cdev)
1664 struct thermal_instance *instance;
1665 unsigned long target = 0;
1667 /* cooling device is updated*/
1671 mutex_lock(&cdev->lock);
1672 /* Make sure cdev enters the deepest cooling state */
1673 list_for_each_entry(instance, &cdev->thermal_instances, cdev_node) {
1674 dev_dbg(&cdev->device, "zone%d->target=%lu\n",
1675 instance->tz->id, instance->target);
1676 if (instance->target == THERMAL_NO_TARGET)
1678 if (instance->target > target)
1679 target = instance->target;
1681 mutex_unlock(&cdev->lock);
1682 cdev->ops->set_cur_state(cdev, target);
1683 cdev->updated = true;
1684 trace_cdev_update(cdev, target);
1685 dev_dbg(&cdev->device, "set to state %lu\n", target);
1687 EXPORT_SYMBOL(thermal_cdev_update);
1690 * thermal_notify_framework - Sensor drivers use this API to notify framework
1691 * @tz: thermal zone device
1692 * @trip: indicates which trip point has been crossed
1694 * This function handles the trip events from sensor drivers. It starts
1695 * throttling the cooling devices according to the policy configured.
1696 * For CRITICAL and HOT trip points, this notifies the respective drivers,
1697 * and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
1698 * The throttling policy is based on the configured platform data; if no
1699 * platform data is provided, this uses the step_wise throttling policy.
1701 void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
1703 handle_thermal_trip(tz, trip);
1705 EXPORT_SYMBOL_GPL(thermal_notify_framework);
1708 * create_trip_attrs() - create attributes for trip points
1709 * @tz: the thermal zone device
1710 * @mask: Writeable trip point bitmap.
1712 * helper function to instantiate sysfs entries for every trip
1713 * point and its properties of a struct thermal_zone_device.
1715 * Return: 0 on success, the proper error value otherwise.
1717 static int create_trip_attrs(struct thermal_zone_device *tz, int mask)
1720 int size = sizeof(struct thermal_attr) * tz->trips;
1722 tz->trip_type_attrs = kzalloc(size, GFP_KERNEL);
1723 if (!tz->trip_type_attrs)
1726 tz->trip_temp_attrs = kzalloc(size, GFP_KERNEL);
1727 if (!tz->trip_temp_attrs) {
1728 kfree(tz->trip_type_attrs);
1732 if (tz->ops->get_trip_hyst) {
1733 tz->trip_hyst_attrs = kzalloc(size, GFP_KERNEL);
1734 if (!tz->trip_hyst_attrs) {
1735 kfree(tz->trip_type_attrs);
1736 kfree(tz->trip_temp_attrs);
1742 for (indx = 0; indx < tz->trips; indx++) {
1743 /* create trip type attribute */
1744 snprintf(tz->trip_type_attrs[indx].name, THERMAL_NAME_LENGTH,
1745 "trip_point_%d_type", indx);
1747 sysfs_attr_init(&tz->trip_type_attrs[indx].attr.attr);
1748 tz->trip_type_attrs[indx].attr.attr.name =
1749 tz->trip_type_attrs[indx].name;
1750 tz->trip_type_attrs[indx].attr.attr.mode = S_IRUGO;
1751 tz->trip_type_attrs[indx].attr.show = trip_point_type_show;
1753 device_create_file(&tz->device,
1754 &tz->trip_type_attrs[indx].attr);
1756 /* create trip temp attribute */
1757 snprintf(tz->trip_temp_attrs[indx].name, THERMAL_NAME_LENGTH,
1758 "trip_point_%d_temp", indx);
1760 sysfs_attr_init(&tz->trip_temp_attrs[indx].attr.attr);
1761 tz->trip_temp_attrs[indx].attr.attr.name =
1762 tz->trip_temp_attrs[indx].name;
1763 tz->trip_temp_attrs[indx].attr.attr.mode = S_IRUGO;
1764 tz->trip_temp_attrs[indx].attr.show = trip_point_temp_show;
1765 if (IS_ENABLED(CONFIG_THERMAL_WRITABLE_TRIPS) &&
1766 mask & (1 << indx)) {
1767 tz->trip_temp_attrs[indx].attr.attr.mode |= S_IWUSR;
1768 tz->trip_temp_attrs[indx].attr.store =
1769 trip_point_temp_store;
1772 device_create_file(&tz->device,
1773 &tz->trip_temp_attrs[indx].attr);
1775 /* create Optional trip hyst attribute */
1776 if (!tz->ops->get_trip_hyst)
1778 snprintf(tz->trip_hyst_attrs[indx].name, THERMAL_NAME_LENGTH,
1779 "trip_point_%d_hyst", indx);
1781 sysfs_attr_init(&tz->trip_hyst_attrs[indx].attr.attr);
1782 tz->trip_hyst_attrs[indx].attr.attr.name =
1783 tz->trip_hyst_attrs[indx].name;
1784 tz->trip_hyst_attrs[indx].attr.attr.mode = S_IRUGO;
1785 tz->trip_hyst_attrs[indx].attr.show = trip_point_hyst_show;
1786 if (tz->ops->set_trip_hyst) {
1787 tz->trip_hyst_attrs[indx].attr.attr.mode |= S_IWUSR;
1788 tz->trip_hyst_attrs[indx].attr.store =
1789 trip_point_hyst_store;
1792 device_create_file(&tz->device,
1793 &tz->trip_hyst_attrs[indx].attr);
1798 static void remove_trip_attrs(struct thermal_zone_device *tz)
1802 for (indx = 0; indx < tz->trips; indx++) {
1803 device_remove_file(&tz->device,
1804 &tz->trip_type_attrs[indx].attr);
1805 device_remove_file(&tz->device,
1806 &tz->trip_temp_attrs[indx].attr);
1807 if (tz->ops->get_trip_hyst)
1808 device_remove_file(&tz->device,
1809 &tz->trip_hyst_attrs[indx].attr);
1811 kfree(tz->trip_type_attrs);
1812 kfree(tz->trip_temp_attrs);
1813 kfree(tz->trip_hyst_attrs);
1817 * thermal_zone_device_register() - register a new thermal zone device
1818 * @type: the thermal zone device type
1819 * @trips: the number of trip points the thermal zone support
1820 * @mask: a bit string indicating the writeablility of trip points
1821 * @devdata: private device data
1822 * @ops: standard thermal zone device callbacks
1823 * @tzp: thermal zone platform parameters
1824 * @passive_delay: number of milliseconds to wait between polls when
1825 * performing passive cooling
1826 * @polling_delay: number of milliseconds to wait between polls when checking
1827 * whether trip points have been crossed (0 for interrupt
1830 * This interface function adds a new thermal zone device (sensor) to
1831 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1832 * thermal cooling devices registered at the same time.
1833 * thermal_zone_device_unregister() must be called when the device is no
1834 * longer needed. The passive cooling depends on the .get_trend() return value.
1836 * Return: a pointer to the created struct thermal_zone_device or an
1837 * in case of error, an ERR_PTR. Caller must check return value with
1838 * IS_ERR*() helpers.
1840 struct thermal_zone_device *thermal_zone_device_register(const char *type,
1841 int trips, int mask, void *devdata,
1842 struct thermal_zone_device_ops *ops,
1843 struct thermal_zone_params *tzp,
1844 int passive_delay, int polling_delay)
1846 struct thermal_zone_device *tz;
1847 enum thermal_trip_type trip_type;
1851 struct thermal_governor *governor;
1853 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1854 return ERR_PTR(-EINVAL);
1856 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
1857 return ERR_PTR(-EINVAL);
1860 return ERR_PTR(-EINVAL);
1862 if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
1863 return ERR_PTR(-EINVAL);
1865 tz = kzalloc(sizeof(struct thermal_zone_device), GFP_KERNEL);
1867 return ERR_PTR(-ENOMEM);
1869 INIT_LIST_HEAD(&tz->thermal_instances);
1871 mutex_init(&tz->lock);
1872 result = get_idr(&thermal_tz_idr, &thermal_idr_lock, &tz->id);
1875 return ERR_PTR(result);
1878 strlcpy(tz->type, type ? : "", sizeof(tz->type));
1881 tz->device.class = &thermal_class;
1882 tz->devdata = devdata;
1884 tz->passive_delay = passive_delay;
1885 tz->polling_delay = polling_delay;
1886 tz->prev_low_trip = INT_MAX;
1887 tz->prev_high_trip = -INT_MAX;
1889 /* A new thermal zone needs to be updated anyway. */
1890 atomic_set(&tz->need_update, 1);
1892 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1893 result = device_register(&tz->device);
1895 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1897 return ERR_PTR(result);
1902 result = device_create_file(&tz->device, &dev_attr_type);
1907 result = device_create_file(&tz->device, &dev_attr_temp);
1911 if (ops->get_mode) {
1912 result = device_create_file(&tz->device, &dev_attr_mode);
1917 result = create_trip_attrs(tz, mask);
1921 for (count = 0; count < trips; count++) {
1922 tz->ops->get_trip_type(tz, count, &trip_type);
1923 if (trip_type == THERMAL_TRIP_PASSIVE)
1928 result = device_create_file(&tz->device, &dev_attr_passive);
1933 if (IS_ENABLED(CONFIG_THERMAL_EMULATION)) {
1934 result = device_create_file(&tz->device, &dev_attr_emul_temp);
1939 /* Create policy attribute */
1940 result = device_create_file(&tz->device, &dev_attr_policy);
1944 /* Add thermal zone params */
1945 result = create_tzp_attrs(&tz->device);
1949 /* Create available_policies attribute */
1950 result = device_create_file(&tz->device, &dev_attr_available_policies);
1954 /* Update 'this' zone's governor information */
1955 mutex_lock(&thermal_governor_lock);
1958 governor = __find_governor(tz->tzp->governor_name);
1960 governor = def_governor;
1962 result = thermal_set_governor(tz, governor);
1964 mutex_unlock(&thermal_governor_lock);
1968 mutex_unlock(&thermal_governor_lock);
1970 if (!tz->tzp || !tz->tzp->no_hwmon) {
1971 result = thermal_add_hwmon_sysfs(tz);
1976 mutex_lock(&thermal_list_lock);
1977 list_add_tail(&tz->node, &thermal_tz_list);
1978 mutex_unlock(&thermal_list_lock);
1980 /* Bind cooling devices for this zone */
1983 INIT_DELAYED_WORK(&(tz->poll_queue), thermal_zone_device_check);
1985 thermal_zone_device_reset(tz);
1986 /* Update the new thermal zone and mark it as already updated. */
1987 if (atomic_cmpxchg(&tz->need_update, 1, 0))
1988 thermal_zone_device_update(tz);
1993 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1994 device_unregister(&tz->device);
1995 return ERR_PTR(result);
1997 EXPORT_SYMBOL_GPL(thermal_zone_device_register);
2000 * thermal_device_unregister - removes the registered thermal zone device
2001 * @tz: the thermal zone device to remove
2003 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
2006 const struct thermal_zone_params *tzp;
2007 struct thermal_cooling_device *cdev;
2008 struct thermal_zone_device *pos = NULL;
2015 mutex_lock(&thermal_list_lock);
2016 list_for_each_entry(pos, &thermal_tz_list, node)
2020 /* thermal zone device not found */
2021 mutex_unlock(&thermal_list_lock);
2024 list_del(&tz->node);
2026 /* Unbind all cdevs associated with 'this' thermal zone */
2027 list_for_each_entry(cdev, &thermal_cdev_list, node) {
2028 if (tz->ops->unbind) {
2029 tz->ops->unbind(tz, cdev);
2033 if (!tzp || !tzp->tbp)
2036 for (i = 0; i < tzp->num_tbps; i++) {
2037 if (tzp->tbp[i].cdev == cdev) {
2038 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
2039 tzp->tbp[i].cdev = NULL;
2044 mutex_unlock(&thermal_list_lock);
2046 thermal_zone_device_set_polling(tz, 0);
2049 device_remove_file(&tz->device, &dev_attr_type);
2050 device_remove_file(&tz->device, &dev_attr_temp);
2051 if (tz->ops->get_mode)
2052 device_remove_file(&tz->device, &dev_attr_mode);
2053 device_remove_file(&tz->device, &dev_attr_policy);
2054 device_remove_file(&tz->device, &dev_attr_available_policies);
2055 remove_trip_attrs(tz);
2056 thermal_set_governor(tz, NULL);
2058 thermal_remove_hwmon_sysfs(tz);
2059 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
2060 idr_destroy(&tz->idr);
2061 mutex_destroy(&tz->lock);
2062 device_unregister(&tz->device);
2065 EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
2068 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
2069 * @name: thermal zone name to fetch the temperature
2071 * When only one zone is found with the passed name, returns a reference to it.
2073 * Return: On success returns a reference to an unique thermal zone with
2074 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
2075 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
2077 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
2079 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
2080 unsigned int found = 0;
2085 mutex_lock(&thermal_list_lock);
2086 list_for_each_entry(pos, &thermal_tz_list, node)
2087 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
2091 mutex_unlock(&thermal_list_lock);
2093 /* nothing has been found, thus an error code for it */
2095 ref = ERR_PTR(-ENODEV);
2097 /* Success only when an unique zone is found */
2098 ref = ERR_PTR(-EEXIST);
2103 EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
2106 static const struct genl_multicast_group thermal_event_mcgrps[] = {
2107 { .name = THERMAL_GENL_MCAST_GROUP_NAME, },
2110 static struct genl_family thermal_event_genl_family = {
2111 .id = GENL_ID_GENERATE,
2112 .name = THERMAL_GENL_FAMILY_NAME,
2113 .version = THERMAL_GENL_VERSION,
2114 .maxattr = THERMAL_GENL_ATTR_MAX,
2115 .mcgrps = thermal_event_mcgrps,
2116 .n_mcgrps = ARRAY_SIZE(thermal_event_mcgrps),
2119 int thermal_generate_netlink_event(struct thermal_zone_device *tz,
2122 struct sk_buff *skb;
2123 struct nlattr *attr;
2124 struct thermal_genl_event *thermal_event;
2128 static unsigned int thermal_event_seqnum;
2133 /* allocate memory */
2134 size = nla_total_size(sizeof(struct thermal_genl_event)) +
2137 skb = genlmsg_new(size, GFP_ATOMIC);
2141 /* add the genetlink message header */
2142 msg_header = genlmsg_put(skb, 0, thermal_event_seqnum++,
2143 &thermal_event_genl_family, 0,
2144 THERMAL_GENL_CMD_EVENT);
2151 attr = nla_reserve(skb, THERMAL_GENL_ATTR_EVENT,
2152 sizeof(struct thermal_genl_event));
2159 thermal_event = nla_data(attr);
2160 if (!thermal_event) {
2165 memset(thermal_event, 0, sizeof(struct thermal_genl_event));
2167 thermal_event->orig = tz->id;
2168 thermal_event->event = event;
2170 /* send multicast genetlink message */
2171 genlmsg_end(skb, msg_header);
2173 result = genlmsg_multicast(&thermal_event_genl_family, skb, 0,
2176 dev_err(&tz->device, "Failed to send netlink event:%d", result);
2180 EXPORT_SYMBOL_GPL(thermal_generate_netlink_event);
2182 static int genetlink_init(void)
2184 return genl_register_family(&thermal_event_genl_family);
2187 static void genetlink_exit(void)
2189 genl_unregister_family(&thermal_event_genl_family);
2191 #else /* !CONFIG_NET */
2192 static inline int genetlink_init(void) { return 0; }
2193 static inline void genetlink_exit(void) {}
2194 #endif /* !CONFIG_NET */
2196 static int __init thermal_register_governors(void)
2200 result = thermal_gov_step_wise_register();
2204 result = thermal_gov_fair_share_register();
2208 result = thermal_gov_bang_bang_register();
2212 result = thermal_gov_user_space_register();
2216 return thermal_gov_power_allocator_register();
2219 static void thermal_unregister_governors(void)
2221 thermal_gov_step_wise_unregister();
2222 thermal_gov_fair_share_unregister();
2223 thermal_gov_bang_bang_unregister();
2224 thermal_gov_user_space_unregister();
2225 thermal_gov_power_allocator_unregister();
2228 static int thermal_pm_notify(struct notifier_block *nb,
2229 unsigned long mode, void *_unused)
2231 struct thermal_zone_device *tz;
2234 case PM_HIBERNATION_PREPARE:
2235 case PM_RESTORE_PREPARE:
2236 case PM_SUSPEND_PREPARE:
2237 atomic_set(&in_suspend, 1);
2239 case PM_POST_HIBERNATION:
2240 case PM_POST_RESTORE:
2241 case PM_POST_SUSPEND:
2242 atomic_set(&in_suspend, 0);
2243 list_for_each_entry(tz, &thermal_tz_list, node) {
2244 thermal_zone_device_reset(tz);
2245 thermal_zone_device_update(tz);
2254 static struct notifier_block thermal_pm_nb = {
2255 .notifier_call = thermal_pm_notify,
2258 static int __init thermal_init(void)
2262 result = thermal_register_governors();
2266 result = class_register(&thermal_class);
2268 goto unregister_governors;
2270 result = genetlink_init();
2272 goto unregister_class;
2274 result = of_parse_thermal_zones();
2278 result = register_pm_notifier(&thermal_pm_nb);
2280 pr_warn("Thermal: Can not register suspend notifier, return %d\n",
2288 class_unregister(&thermal_class);
2289 unregister_governors:
2290 thermal_unregister_governors();
2292 idr_destroy(&thermal_tz_idr);
2293 idr_destroy(&thermal_cdev_idr);
2294 mutex_destroy(&thermal_idr_lock);
2295 mutex_destroy(&thermal_list_lock);
2296 mutex_destroy(&thermal_governor_lock);
2300 static void __exit thermal_exit(void)
2302 unregister_pm_notifier(&thermal_pm_nb);
2303 of_thermal_destroy_zones();
2305 class_unregister(&thermal_class);
2306 thermal_unregister_governors();
2307 idr_destroy(&thermal_tz_idr);
2308 idr_destroy(&thermal_cdev_idr);
2309 mutex_destroy(&thermal_idr_lock);
2310 mutex_destroy(&thermal_list_lock);
2311 mutex_destroy(&thermal_governor_lock);
2314 fs_initcall(thermal_init);
2315 module_exit(thermal_exit);