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 update_temperature(struct thermal_zone_device *tz)
523 ret = thermal_zone_get_temp(tz, &temp);
526 dev_warn(&tz->device,
527 "failed to read out thermal zone (%d)\n",
532 mutex_lock(&tz->lock);
533 tz->last_temperature = tz->temperature;
534 tz->temperature = temp;
535 mutex_unlock(&tz->lock);
537 trace_thermal_temperature(tz);
538 if (tz->last_temperature == THERMAL_TEMP_INVALID)
539 dev_dbg(&tz->device, "last_temperature N/A, current_temperature=%d\n",
542 dev_dbg(&tz->device, "last_temperature=%d, current_temperature=%d\n",
543 tz->last_temperature, tz->temperature);
546 static void thermal_zone_device_reset(struct thermal_zone_device *tz)
548 struct thermal_instance *pos;
550 tz->temperature = THERMAL_TEMP_INVALID;
552 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
553 pos->initialized = false;
556 void thermal_zone_device_update(struct thermal_zone_device *tz)
560 if (atomic_read(&in_suspend))
563 if (!tz->ops->get_temp)
566 update_temperature(tz);
568 for (count = 0; count < tz->trips; count++)
569 handle_thermal_trip(tz, count);
571 EXPORT_SYMBOL_GPL(thermal_zone_device_update);
573 static void thermal_zone_device_check(struct work_struct *work)
575 struct thermal_zone_device *tz = container_of(work, struct
578 thermal_zone_device_update(tz);
581 /* sys I/F for thermal zone */
583 #define to_thermal_zone(_dev) \
584 container_of(_dev, struct thermal_zone_device, device)
587 type_show(struct device *dev, struct device_attribute *attr, char *buf)
589 struct thermal_zone_device *tz = to_thermal_zone(dev);
591 return sprintf(buf, "%s\n", tz->type);
595 temp_show(struct device *dev, struct device_attribute *attr, char *buf)
597 struct thermal_zone_device *tz = to_thermal_zone(dev);
598 int temperature, ret;
600 ret = thermal_zone_get_temp(tz, &temperature);
605 return sprintf(buf, "%d\n", temperature);
609 mode_show(struct device *dev, struct device_attribute *attr, char *buf)
611 struct thermal_zone_device *tz = to_thermal_zone(dev);
612 enum thermal_device_mode mode;
615 if (!tz->ops->get_mode)
618 result = tz->ops->get_mode(tz, &mode);
622 return sprintf(buf, "%s\n", mode == THERMAL_DEVICE_ENABLED ? "enabled"
627 mode_store(struct device *dev, struct device_attribute *attr,
628 const char *buf, size_t count)
630 struct thermal_zone_device *tz = to_thermal_zone(dev);
633 if (!tz->ops->set_mode)
636 if (!strncmp(buf, "enabled", sizeof("enabled") - 1))
637 result = tz->ops->set_mode(tz, THERMAL_DEVICE_ENABLED);
638 else if (!strncmp(buf, "disabled", sizeof("disabled") - 1))
639 result = tz->ops->set_mode(tz, THERMAL_DEVICE_DISABLED);
650 trip_point_type_show(struct device *dev, struct device_attribute *attr,
653 struct thermal_zone_device *tz = to_thermal_zone(dev);
654 enum thermal_trip_type type;
657 if (!tz->ops->get_trip_type)
660 if (!sscanf(attr->attr.name, "trip_point_%d_type", &trip))
663 result = tz->ops->get_trip_type(tz, trip, &type);
668 case THERMAL_TRIP_CRITICAL:
669 return sprintf(buf, "critical\n");
670 case THERMAL_TRIP_HOT:
671 return sprintf(buf, "hot\n");
672 case THERMAL_TRIP_PASSIVE:
673 return sprintf(buf, "passive\n");
674 case THERMAL_TRIP_ACTIVE:
675 return sprintf(buf, "active\n");
677 return sprintf(buf, "unknown\n");
682 trip_point_temp_store(struct device *dev, struct device_attribute *attr,
683 const char *buf, size_t count)
685 struct thermal_zone_device *tz = to_thermal_zone(dev);
687 unsigned long temperature;
689 if (!tz->ops->set_trip_temp)
692 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
695 if (kstrtoul(buf, 10, &temperature))
698 ret = tz->ops->set_trip_temp(tz, trip, temperature);
702 thermal_zone_device_update(tz);
708 trip_point_temp_show(struct device *dev, struct device_attribute *attr,
711 struct thermal_zone_device *tz = to_thermal_zone(dev);
715 if (!tz->ops->get_trip_temp)
718 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
721 ret = tz->ops->get_trip_temp(tz, trip, &temperature);
726 return sprintf(buf, "%d\n", temperature);
730 trip_point_hyst_store(struct device *dev, struct device_attribute *attr,
731 const char *buf, size_t count)
733 struct thermal_zone_device *tz = to_thermal_zone(dev);
737 if (!tz->ops->set_trip_hyst)
740 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
743 if (kstrtoint(buf, 10, &temperature))
747 * We are not doing any check on the 'temperature' value
748 * here. The driver implementing 'set_trip_hyst' has to
751 ret = tz->ops->set_trip_hyst(tz, trip, temperature);
753 return ret ? ret : count;
757 trip_point_hyst_show(struct device *dev, struct device_attribute *attr,
760 struct thermal_zone_device *tz = to_thermal_zone(dev);
764 if (!tz->ops->get_trip_hyst)
767 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
770 ret = tz->ops->get_trip_hyst(tz, trip, &temperature);
772 return ret ? ret : sprintf(buf, "%d\n", temperature);
776 passive_store(struct device *dev, struct device_attribute *attr,
777 const char *buf, size_t count)
779 struct thermal_zone_device *tz = to_thermal_zone(dev);
780 struct thermal_cooling_device *cdev = NULL;
783 if (!sscanf(buf, "%d\n", &state))
786 /* sanity check: values below 1000 millicelcius don't make sense
787 * and can cause the system to go into a thermal heart attack
789 if (state && state < 1000)
792 if (state && !tz->forced_passive) {
793 mutex_lock(&thermal_list_lock);
794 list_for_each_entry(cdev, &thermal_cdev_list, node) {
795 if (!strncmp("Processor", cdev->type,
796 sizeof("Processor")))
797 thermal_zone_bind_cooling_device(tz,
798 THERMAL_TRIPS_NONE, cdev,
801 THERMAL_WEIGHT_DEFAULT);
803 mutex_unlock(&thermal_list_lock);
804 if (!tz->passive_delay)
805 tz->passive_delay = 1000;
806 } else if (!state && tz->forced_passive) {
807 mutex_lock(&thermal_list_lock);
808 list_for_each_entry(cdev, &thermal_cdev_list, node) {
809 if (!strncmp("Processor", cdev->type,
810 sizeof("Processor")))
811 thermal_zone_unbind_cooling_device(tz,
815 mutex_unlock(&thermal_list_lock);
816 tz->passive_delay = 0;
819 tz->forced_passive = state;
821 thermal_zone_device_update(tz);
827 passive_show(struct device *dev, struct device_attribute *attr,
830 struct thermal_zone_device *tz = to_thermal_zone(dev);
832 return sprintf(buf, "%d\n", tz->forced_passive);
836 policy_store(struct device *dev, struct device_attribute *attr,
837 const char *buf, size_t count)
840 struct thermal_zone_device *tz = to_thermal_zone(dev);
841 struct thermal_governor *gov;
842 char name[THERMAL_NAME_LENGTH];
844 snprintf(name, sizeof(name), "%s", buf);
846 mutex_lock(&thermal_governor_lock);
847 mutex_lock(&tz->lock);
849 gov = __find_governor(strim(name));
853 ret = thermal_set_governor(tz, gov);
858 mutex_unlock(&tz->lock);
859 mutex_unlock(&thermal_governor_lock);
864 policy_show(struct device *dev, struct device_attribute *devattr, char *buf)
866 struct thermal_zone_device *tz = to_thermal_zone(dev);
868 return sprintf(buf, "%s\n", tz->governor->name);
872 available_policies_show(struct device *dev, struct device_attribute *devattr,
875 struct thermal_governor *pos;
877 ssize_t size = PAGE_SIZE;
879 mutex_lock(&thermal_governor_lock);
881 list_for_each_entry(pos, &thermal_governor_list, governor_list) {
882 size = PAGE_SIZE - count;
883 count += scnprintf(buf + count, size, "%s ", pos->name);
885 count += scnprintf(buf + count, size, "\n");
887 mutex_unlock(&thermal_governor_lock);
893 emul_temp_store(struct device *dev, struct device_attribute *attr,
894 const char *buf, size_t count)
896 struct thermal_zone_device *tz = to_thermal_zone(dev);
898 unsigned long temperature;
900 if (kstrtoul(buf, 10, &temperature))
903 if (!tz->ops->set_emul_temp) {
904 mutex_lock(&tz->lock);
905 tz->emul_temperature = temperature;
906 mutex_unlock(&tz->lock);
908 ret = tz->ops->set_emul_temp(tz, temperature);
912 thermal_zone_device_update(tz);
914 return ret ? ret : count;
916 static DEVICE_ATTR(emul_temp, S_IWUSR, NULL, emul_temp_store);
919 sustainable_power_show(struct device *dev, struct device_attribute *devattr,
922 struct thermal_zone_device *tz = to_thermal_zone(dev);
925 return sprintf(buf, "%u\n", tz->tzp->sustainable_power);
931 sustainable_power_store(struct device *dev, struct device_attribute *devattr,
932 const char *buf, size_t count)
934 struct thermal_zone_device *tz = to_thermal_zone(dev);
935 u32 sustainable_power;
940 if (kstrtou32(buf, 10, &sustainable_power))
943 tz->tzp->sustainable_power = sustainable_power;
947 static DEVICE_ATTR(sustainable_power, S_IWUSR | S_IRUGO, sustainable_power_show,
948 sustainable_power_store);
950 #define create_s32_tzp_attr(name) \
952 name##_show(struct device *dev, struct device_attribute *devattr, \
955 struct thermal_zone_device *tz = to_thermal_zone(dev); \
958 return sprintf(buf, "%u\n", tz->tzp->name); \
964 name##_store(struct device *dev, struct device_attribute *devattr, \
965 const char *buf, size_t count) \
967 struct thermal_zone_device *tz = to_thermal_zone(dev); \
973 if (kstrtos32(buf, 10, &value)) \
976 tz->tzp->name = value; \
980 static DEVICE_ATTR(name, S_IWUSR | S_IRUGO, name##_show, name##_store)
982 create_s32_tzp_attr(k_po);
983 create_s32_tzp_attr(k_pu);
984 create_s32_tzp_attr(k_i);
985 create_s32_tzp_attr(k_d);
986 create_s32_tzp_attr(integral_cutoff);
987 create_s32_tzp_attr(slope);
988 create_s32_tzp_attr(offset);
989 #undef create_s32_tzp_attr
991 static struct device_attribute *dev_tzp_attrs[] = {
992 &dev_attr_sustainable_power,
997 &dev_attr_integral_cutoff,
1002 static int create_tzp_attrs(struct device *dev)
1006 for (i = 0; i < ARRAY_SIZE(dev_tzp_attrs); i++) {
1008 struct device_attribute *dev_attr = dev_tzp_attrs[i];
1010 ret = device_create_file(dev, dev_attr);
1019 * power_actor_get_max_power() - get the maximum power that a cdev can consume
1020 * @cdev: pointer to &thermal_cooling_device
1021 * @tz: a valid thermal zone device pointer
1022 * @max_power: pointer in which to store the maximum power
1024 * Calculate the maximum power consumption in milliwats that the
1025 * cooling device can currently consume and store it in @max_power.
1027 * Return: 0 on success, -EINVAL if @cdev doesn't support the
1028 * power_actor API or -E* on other error.
1030 int power_actor_get_max_power(struct thermal_cooling_device *cdev,
1031 struct thermal_zone_device *tz, u32 *max_power)
1033 if (!cdev_is_power_actor(cdev))
1036 return cdev->ops->state2power(cdev, tz, 0, max_power);
1040 * power_actor_get_min_power() - get the mainimum power that a cdev can consume
1041 * @cdev: pointer to &thermal_cooling_device
1042 * @tz: a valid thermal zone device pointer
1043 * @min_power: pointer in which to store the minimum power
1045 * Calculate the minimum power consumption in milliwatts that the
1046 * cooling device can currently consume and store it in @min_power.
1048 * Return: 0 on success, -EINVAL if @cdev doesn't support the
1049 * power_actor API or -E* on other error.
1051 int power_actor_get_min_power(struct thermal_cooling_device *cdev,
1052 struct thermal_zone_device *tz, u32 *min_power)
1054 unsigned long max_state;
1057 if (!cdev_is_power_actor(cdev))
1060 ret = cdev->ops->get_max_state(cdev, &max_state);
1064 return cdev->ops->state2power(cdev, tz, max_state, min_power);
1068 * power_actor_set_power() - limit the maximum power that a cooling device can consume
1069 * @cdev: pointer to &thermal_cooling_device
1070 * @instance: thermal instance to update
1071 * @power: the power in milliwatts
1073 * Set the cooling device to consume at most @power milliwatts.
1075 * Return: 0 on success, -EINVAL if the cooling device does not
1076 * implement the power actor API or -E* for other failures.
1078 int power_actor_set_power(struct thermal_cooling_device *cdev,
1079 struct thermal_instance *instance, u32 power)
1081 unsigned long state;
1084 if (!cdev_is_power_actor(cdev))
1087 ret = cdev->ops->power2state(cdev, instance->tz, power, &state);
1091 instance->target = state;
1092 cdev->updated = false;
1093 thermal_cdev_update(cdev);
1098 static DEVICE_ATTR(type, 0444, type_show, NULL);
1099 static DEVICE_ATTR(temp, 0444, temp_show, NULL);
1100 static DEVICE_ATTR(mode, 0644, mode_show, mode_store);
1101 static DEVICE_ATTR(passive, S_IRUGO | S_IWUSR, passive_show, passive_store);
1102 static DEVICE_ATTR(policy, S_IRUGO | S_IWUSR, policy_show, policy_store);
1103 static DEVICE_ATTR(available_policies, S_IRUGO, available_policies_show, NULL);
1105 /* sys I/F for cooling device */
1106 #define to_cooling_device(_dev) \
1107 container_of(_dev, struct thermal_cooling_device, device)
1110 thermal_cooling_device_type_show(struct device *dev,
1111 struct device_attribute *attr, char *buf)
1113 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1115 return sprintf(buf, "%s\n", cdev->type);
1119 thermal_cooling_device_max_state_show(struct device *dev,
1120 struct device_attribute *attr, char *buf)
1122 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1123 unsigned long state;
1126 ret = cdev->ops->get_max_state(cdev, &state);
1129 return sprintf(buf, "%ld\n", state);
1133 thermal_cooling_device_cur_state_show(struct device *dev,
1134 struct device_attribute *attr, char *buf)
1136 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1137 unsigned long state;
1140 ret = cdev->ops->get_cur_state(cdev, &state);
1143 return sprintf(buf, "%ld\n", state);
1147 thermal_cooling_device_cur_state_store(struct device *dev,
1148 struct device_attribute *attr,
1149 const char *buf, size_t count)
1151 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1152 unsigned long state;
1155 if (!sscanf(buf, "%ld\n", &state))
1158 if ((long)state < 0)
1161 result = cdev->ops->set_cur_state(cdev, state);
1167 static struct device_attribute dev_attr_cdev_type =
1168 __ATTR(type, 0444, thermal_cooling_device_type_show, NULL);
1169 static DEVICE_ATTR(max_state, 0444,
1170 thermal_cooling_device_max_state_show, NULL);
1171 static DEVICE_ATTR(cur_state, 0644,
1172 thermal_cooling_device_cur_state_show,
1173 thermal_cooling_device_cur_state_store);
1176 thermal_cooling_device_trip_point_show(struct device *dev,
1177 struct device_attribute *attr, char *buf)
1179 struct thermal_instance *instance;
1182 container_of(attr, struct thermal_instance, attr);
1184 if (instance->trip == THERMAL_TRIPS_NONE)
1185 return sprintf(buf, "-1\n");
1187 return sprintf(buf, "%d\n", instance->trip);
1190 static struct attribute *cooling_device_attrs[] = {
1191 &dev_attr_cdev_type.attr,
1192 &dev_attr_max_state.attr,
1193 &dev_attr_cur_state.attr,
1197 static const struct attribute_group cooling_device_attr_group = {
1198 .attrs = cooling_device_attrs,
1201 static const struct attribute_group *cooling_device_attr_groups[] = {
1202 &cooling_device_attr_group,
1207 thermal_cooling_device_weight_show(struct device *dev,
1208 struct device_attribute *attr, char *buf)
1210 struct thermal_instance *instance;
1212 instance = container_of(attr, struct thermal_instance, weight_attr);
1214 return sprintf(buf, "%d\n", instance->weight);
1218 thermal_cooling_device_weight_store(struct device *dev,
1219 struct device_attribute *attr,
1220 const char *buf, size_t count)
1222 struct thermal_instance *instance;
1225 ret = kstrtoint(buf, 0, &weight);
1229 instance = container_of(attr, struct thermal_instance, weight_attr);
1230 instance->weight = weight;
1234 /* Device management */
1237 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
1238 * @tz: pointer to struct thermal_zone_device
1239 * @trip: indicates which trip point the cooling devices is
1240 * associated with in this thermal zone.
1241 * @cdev: pointer to struct thermal_cooling_device
1242 * @upper: the Maximum cooling state for this trip point.
1243 * THERMAL_NO_LIMIT means no upper limit,
1244 * and the cooling device can be in max_state.
1245 * @lower: the Minimum cooling state can be used for this trip point.
1246 * THERMAL_NO_LIMIT means no lower limit,
1247 * and the cooling device can be in cooling state 0.
1248 * @weight: The weight of the cooling device to be bound to the
1249 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
1252 * This interface function bind a thermal cooling device to the certain trip
1253 * point of a thermal zone device.
1254 * This function is usually called in the thermal zone device .bind callback.
1256 * Return: 0 on success, the proper error value otherwise.
1258 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
1260 struct thermal_cooling_device *cdev,
1261 unsigned long upper, unsigned long lower,
1262 unsigned int weight)
1264 struct thermal_instance *dev;
1265 struct thermal_instance *pos;
1266 struct thermal_zone_device *pos1;
1267 struct thermal_cooling_device *pos2;
1268 unsigned long max_state;
1271 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
1274 list_for_each_entry(pos1, &thermal_tz_list, node) {
1278 list_for_each_entry(pos2, &thermal_cdev_list, node) {
1283 if (tz != pos1 || cdev != pos2)
1286 ret = cdev->ops->get_max_state(cdev, &max_state);
1290 /* lower default 0, upper default max_state */
1291 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
1292 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
1294 if (lower > upper || upper > max_state)
1298 kzalloc(sizeof(struct thermal_instance), GFP_KERNEL);
1306 dev->target = THERMAL_NO_TARGET;
1307 dev->weight = weight;
1309 result = get_idr(&tz->idr, &tz->lock, &dev->id);
1313 sprintf(dev->name, "cdev%d", dev->id);
1315 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
1319 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
1320 sysfs_attr_init(&dev->attr.attr);
1321 dev->attr.attr.name = dev->attr_name;
1322 dev->attr.attr.mode = 0444;
1323 dev->attr.show = thermal_cooling_device_trip_point_show;
1324 result = device_create_file(&tz->device, &dev->attr);
1326 goto remove_symbol_link;
1328 sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
1329 sysfs_attr_init(&dev->weight_attr.attr);
1330 dev->weight_attr.attr.name = dev->weight_attr_name;
1331 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
1332 dev->weight_attr.show = thermal_cooling_device_weight_show;
1333 dev->weight_attr.store = thermal_cooling_device_weight_store;
1334 result = device_create_file(&tz->device, &dev->weight_attr);
1336 goto remove_trip_file;
1338 mutex_lock(&tz->lock);
1339 mutex_lock(&cdev->lock);
1340 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
1341 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1346 list_add_tail(&dev->tz_node, &tz->thermal_instances);
1347 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
1348 atomic_set(&tz->need_update, 1);
1350 mutex_unlock(&cdev->lock);
1351 mutex_unlock(&tz->lock);
1356 device_remove_file(&tz->device, &dev->weight_attr);
1358 device_remove_file(&tz->device, &dev->attr);
1360 sysfs_remove_link(&tz->device.kobj, dev->name);
1362 release_idr(&tz->idr, &tz->lock, dev->id);
1367 EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
1370 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
1372 * @tz: pointer to a struct thermal_zone_device.
1373 * @trip: indicates which trip point the cooling devices is
1374 * associated with in this thermal zone.
1375 * @cdev: pointer to a struct thermal_cooling_device.
1377 * This interface function unbind a thermal cooling device from the certain
1378 * trip point of a thermal zone device.
1379 * This function is usually called in the thermal zone device .unbind callback.
1381 * Return: 0 on success, the proper error value otherwise.
1383 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
1385 struct thermal_cooling_device *cdev)
1387 struct thermal_instance *pos, *next;
1389 mutex_lock(&tz->lock);
1390 mutex_lock(&cdev->lock);
1391 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
1392 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1393 list_del(&pos->tz_node);
1394 list_del(&pos->cdev_node);
1395 mutex_unlock(&cdev->lock);
1396 mutex_unlock(&tz->lock);
1400 mutex_unlock(&cdev->lock);
1401 mutex_unlock(&tz->lock);
1406 device_remove_file(&tz->device, &pos->weight_attr);
1407 device_remove_file(&tz->device, &pos->attr);
1408 sysfs_remove_link(&tz->device.kobj, pos->name);
1409 release_idr(&tz->idr, &tz->lock, pos->id);
1413 EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
1415 static void thermal_release(struct device *dev)
1417 struct thermal_zone_device *tz;
1418 struct thermal_cooling_device *cdev;
1420 if (!strncmp(dev_name(dev), "thermal_zone",
1421 sizeof("thermal_zone") - 1)) {
1422 tz = to_thermal_zone(dev);
1424 } else if(!strncmp(dev_name(dev), "cooling_device",
1425 sizeof("cooling_device") - 1)){
1426 cdev = to_cooling_device(dev);
1431 static struct class thermal_class = {
1433 .dev_release = thermal_release,
1437 * __thermal_cooling_device_register() - register a new thermal cooling device
1438 * @np: a pointer to a device tree node.
1439 * @type: the thermal cooling device type.
1440 * @devdata: device private data.
1441 * @ops: standard thermal cooling devices callbacks.
1443 * This interface function adds a new thermal cooling device (fan/processor/...)
1444 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1445 * to all the thermal zone devices registered at the same time.
1446 * It also gives the opportunity to link the cooling device to a device tree
1447 * node, so that it can be bound to a thermal zone created out of device tree.
1449 * Return: a pointer to the created struct thermal_cooling_device or an
1450 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1452 static struct thermal_cooling_device *
1453 __thermal_cooling_device_register(struct device_node *np,
1454 char *type, void *devdata,
1455 const struct thermal_cooling_device_ops *ops)
1457 struct thermal_cooling_device *cdev;
1458 struct thermal_zone_device *pos = NULL;
1461 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1462 return ERR_PTR(-EINVAL);
1464 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
1465 !ops->set_cur_state)
1466 return ERR_PTR(-EINVAL);
1468 cdev = kzalloc(sizeof(struct thermal_cooling_device), GFP_KERNEL);
1470 return ERR_PTR(-ENOMEM);
1472 result = get_idr(&thermal_cdev_idr, &thermal_idr_lock, &cdev->id);
1475 return ERR_PTR(result);
1478 strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
1479 mutex_init(&cdev->lock);
1480 INIT_LIST_HEAD(&cdev->thermal_instances);
1483 cdev->updated = false;
1484 cdev->device.class = &thermal_class;
1485 cdev->device.groups = cooling_device_attr_groups;
1486 cdev->devdata = devdata;
1487 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
1488 result = device_register(&cdev->device);
1490 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1492 return ERR_PTR(result);
1495 /* Add 'this' new cdev to the global cdev list */
1496 mutex_lock(&thermal_list_lock);
1497 list_add(&cdev->node, &thermal_cdev_list);
1498 mutex_unlock(&thermal_list_lock);
1500 /* Update binding information for 'this' new cdev */
1503 mutex_lock(&thermal_list_lock);
1504 list_for_each_entry(pos, &thermal_tz_list, node)
1505 if (atomic_cmpxchg(&pos->need_update, 1, 0))
1506 thermal_zone_device_update(pos);
1507 mutex_unlock(&thermal_list_lock);
1513 * thermal_cooling_device_register() - register a new thermal cooling device
1514 * @type: the thermal cooling device type.
1515 * @devdata: device private data.
1516 * @ops: standard thermal cooling devices callbacks.
1518 * This interface function adds a new thermal cooling device (fan/processor/...)
1519 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1520 * to all the thermal zone devices registered at the same time.
1522 * Return: a pointer to the created struct thermal_cooling_device or an
1523 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1525 struct thermal_cooling_device *
1526 thermal_cooling_device_register(char *type, void *devdata,
1527 const struct thermal_cooling_device_ops *ops)
1529 return __thermal_cooling_device_register(NULL, type, devdata, ops);
1531 EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
1534 * thermal_of_cooling_device_register() - register an OF thermal cooling device
1535 * @np: a pointer to a device tree node.
1536 * @type: the thermal cooling device type.
1537 * @devdata: device private data.
1538 * @ops: standard thermal cooling devices callbacks.
1540 * This function will register a cooling device with device tree node reference.
1541 * This interface function adds a new thermal cooling device (fan/processor/...)
1542 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1543 * to all the thermal zone devices registered at the same time.
1545 * Return: a pointer to the created struct thermal_cooling_device or an
1546 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1548 struct thermal_cooling_device *
1549 thermal_of_cooling_device_register(struct device_node *np,
1550 char *type, void *devdata,
1551 const struct thermal_cooling_device_ops *ops)
1553 return __thermal_cooling_device_register(np, type, devdata, ops);
1555 EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
1558 * thermal_cooling_device_unregister - removes the registered thermal cooling device
1559 * @cdev: the thermal cooling device to remove.
1561 * thermal_cooling_device_unregister() must be called when the device is no
1564 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1567 const struct thermal_zone_params *tzp;
1568 struct thermal_zone_device *tz;
1569 struct thermal_cooling_device *pos = NULL;
1574 mutex_lock(&thermal_list_lock);
1575 list_for_each_entry(pos, &thermal_cdev_list, node)
1579 /* thermal cooling device not found */
1580 mutex_unlock(&thermal_list_lock);
1583 list_del(&cdev->node);
1585 /* Unbind all thermal zones associated with 'this' cdev */
1586 list_for_each_entry(tz, &thermal_tz_list, node) {
1587 if (tz->ops->unbind) {
1588 tz->ops->unbind(tz, cdev);
1592 if (!tz->tzp || !tz->tzp->tbp)
1596 for (i = 0; i < tzp->num_tbps; i++) {
1597 if (tzp->tbp[i].cdev == cdev) {
1598 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1599 tzp->tbp[i].cdev = NULL;
1604 mutex_unlock(&thermal_list_lock);
1607 device_remove_file(&cdev->device, &dev_attr_cdev_type);
1608 device_remove_file(&cdev->device, &dev_attr_max_state);
1609 device_remove_file(&cdev->device, &dev_attr_cur_state);
1611 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1612 device_unregister(&cdev->device);
1615 EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1617 void thermal_cdev_update(struct thermal_cooling_device *cdev)
1619 struct thermal_instance *instance;
1620 unsigned long target = 0;
1622 /* cooling device is updated*/
1626 mutex_lock(&cdev->lock);
1627 /* Make sure cdev enters the deepest cooling state */
1628 list_for_each_entry(instance, &cdev->thermal_instances, cdev_node) {
1629 dev_dbg(&cdev->device, "zone%d->target=%lu\n",
1630 instance->tz->id, instance->target);
1631 if (instance->target == THERMAL_NO_TARGET)
1633 if (instance->target > target)
1634 target = instance->target;
1636 mutex_unlock(&cdev->lock);
1637 cdev->ops->set_cur_state(cdev, target);
1638 cdev->updated = true;
1639 trace_cdev_update(cdev, target);
1640 dev_dbg(&cdev->device, "set to state %lu\n", target);
1642 EXPORT_SYMBOL(thermal_cdev_update);
1645 * thermal_notify_framework - Sensor drivers use this API to notify framework
1646 * @tz: thermal zone device
1647 * @trip: indicates which trip point has been crossed
1649 * This function handles the trip events from sensor drivers. It starts
1650 * throttling the cooling devices according to the policy configured.
1651 * For CRITICAL and HOT trip points, this notifies the respective drivers,
1652 * and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
1653 * The throttling policy is based on the configured platform data; if no
1654 * platform data is provided, this uses the step_wise throttling policy.
1656 void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
1658 handle_thermal_trip(tz, trip);
1660 EXPORT_SYMBOL_GPL(thermal_notify_framework);
1663 * create_trip_attrs() - create attributes for trip points
1664 * @tz: the thermal zone device
1665 * @mask: Writeable trip point bitmap.
1667 * helper function to instantiate sysfs entries for every trip
1668 * point and its properties of a struct thermal_zone_device.
1670 * Return: 0 on success, the proper error value otherwise.
1672 static int create_trip_attrs(struct thermal_zone_device *tz, int mask)
1675 int size = sizeof(struct thermal_attr) * tz->trips;
1677 tz->trip_type_attrs = kzalloc(size, GFP_KERNEL);
1678 if (!tz->trip_type_attrs)
1681 tz->trip_temp_attrs = kzalloc(size, GFP_KERNEL);
1682 if (!tz->trip_temp_attrs) {
1683 kfree(tz->trip_type_attrs);
1687 if (tz->ops->get_trip_hyst) {
1688 tz->trip_hyst_attrs = kzalloc(size, GFP_KERNEL);
1689 if (!tz->trip_hyst_attrs) {
1690 kfree(tz->trip_type_attrs);
1691 kfree(tz->trip_temp_attrs);
1697 for (indx = 0; indx < tz->trips; indx++) {
1698 /* create trip type attribute */
1699 snprintf(tz->trip_type_attrs[indx].name, THERMAL_NAME_LENGTH,
1700 "trip_point_%d_type", indx);
1702 sysfs_attr_init(&tz->trip_type_attrs[indx].attr.attr);
1703 tz->trip_type_attrs[indx].attr.attr.name =
1704 tz->trip_type_attrs[indx].name;
1705 tz->trip_type_attrs[indx].attr.attr.mode = S_IRUGO;
1706 tz->trip_type_attrs[indx].attr.show = trip_point_type_show;
1708 device_create_file(&tz->device,
1709 &tz->trip_type_attrs[indx].attr);
1711 /* create trip temp attribute */
1712 snprintf(tz->trip_temp_attrs[indx].name, THERMAL_NAME_LENGTH,
1713 "trip_point_%d_temp", indx);
1715 sysfs_attr_init(&tz->trip_temp_attrs[indx].attr.attr);
1716 tz->trip_temp_attrs[indx].attr.attr.name =
1717 tz->trip_temp_attrs[indx].name;
1718 tz->trip_temp_attrs[indx].attr.attr.mode = S_IRUGO;
1719 tz->trip_temp_attrs[indx].attr.show = trip_point_temp_show;
1720 if (IS_ENABLED(CONFIG_THERMAL_WRITABLE_TRIPS) &&
1721 mask & (1 << indx)) {
1722 tz->trip_temp_attrs[indx].attr.attr.mode |= S_IWUSR;
1723 tz->trip_temp_attrs[indx].attr.store =
1724 trip_point_temp_store;
1727 device_create_file(&tz->device,
1728 &tz->trip_temp_attrs[indx].attr);
1730 /* create Optional trip hyst attribute */
1731 if (!tz->ops->get_trip_hyst)
1733 snprintf(tz->trip_hyst_attrs[indx].name, THERMAL_NAME_LENGTH,
1734 "trip_point_%d_hyst", indx);
1736 sysfs_attr_init(&tz->trip_hyst_attrs[indx].attr.attr);
1737 tz->trip_hyst_attrs[indx].attr.attr.name =
1738 tz->trip_hyst_attrs[indx].name;
1739 tz->trip_hyst_attrs[indx].attr.attr.mode = S_IRUGO;
1740 tz->trip_hyst_attrs[indx].attr.show = trip_point_hyst_show;
1741 if (tz->ops->set_trip_hyst) {
1742 tz->trip_hyst_attrs[indx].attr.attr.mode |= S_IWUSR;
1743 tz->trip_hyst_attrs[indx].attr.store =
1744 trip_point_hyst_store;
1747 device_create_file(&tz->device,
1748 &tz->trip_hyst_attrs[indx].attr);
1753 static void remove_trip_attrs(struct thermal_zone_device *tz)
1757 for (indx = 0; indx < tz->trips; indx++) {
1758 device_remove_file(&tz->device,
1759 &tz->trip_type_attrs[indx].attr);
1760 device_remove_file(&tz->device,
1761 &tz->trip_temp_attrs[indx].attr);
1762 if (tz->ops->get_trip_hyst)
1763 device_remove_file(&tz->device,
1764 &tz->trip_hyst_attrs[indx].attr);
1766 kfree(tz->trip_type_attrs);
1767 kfree(tz->trip_temp_attrs);
1768 kfree(tz->trip_hyst_attrs);
1772 * thermal_zone_device_register() - register a new thermal zone device
1773 * @type: the thermal zone device type
1774 * @trips: the number of trip points the thermal zone support
1775 * @mask: a bit string indicating the writeablility of trip points
1776 * @devdata: private device data
1777 * @ops: standard thermal zone device callbacks
1778 * @tzp: thermal zone platform parameters
1779 * @passive_delay: number of milliseconds to wait between polls when
1780 * performing passive cooling
1781 * @polling_delay: number of milliseconds to wait between polls when checking
1782 * whether trip points have been crossed (0 for interrupt
1785 * This interface function adds a new thermal zone device (sensor) to
1786 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1787 * thermal cooling devices registered at the same time.
1788 * thermal_zone_device_unregister() must be called when the device is no
1789 * longer needed. The passive cooling depends on the .get_trend() return value.
1791 * Return: a pointer to the created struct thermal_zone_device or an
1792 * in case of error, an ERR_PTR. Caller must check return value with
1793 * IS_ERR*() helpers.
1795 struct thermal_zone_device *thermal_zone_device_register(const char *type,
1796 int trips, int mask, void *devdata,
1797 struct thermal_zone_device_ops *ops,
1798 struct thermal_zone_params *tzp,
1799 int passive_delay, int polling_delay)
1801 struct thermal_zone_device *tz;
1802 enum thermal_trip_type trip_type;
1806 struct thermal_governor *governor;
1808 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1809 return ERR_PTR(-EINVAL);
1811 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
1812 return ERR_PTR(-EINVAL);
1815 return ERR_PTR(-EINVAL);
1817 if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
1818 return ERR_PTR(-EINVAL);
1820 tz = kzalloc(sizeof(struct thermal_zone_device), GFP_KERNEL);
1822 return ERR_PTR(-ENOMEM);
1824 INIT_LIST_HEAD(&tz->thermal_instances);
1826 mutex_init(&tz->lock);
1827 result = get_idr(&thermal_tz_idr, &thermal_idr_lock, &tz->id);
1830 return ERR_PTR(result);
1833 strlcpy(tz->type, type ? : "", sizeof(tz->type));
1836 tz->device.class = &thermal_class;
1837 tz->devdata = devdata;
1839 tz->passive_delay = passive_delay;
1840 tz->polling_delay = polling_delay;
1841 /* A new thermal zone needs to be updated anyway. */
1842 atomic_set(&tz->need_update, 1);
1844 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1845 result = device_register(&tz->device);
1847 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1849 return ERR_PTR(result);
1854 result = device_create_file(&tz->device, &dev_attr_type);
1859 result = device_create_file(&tz->device, &dev_attr_temp);
1863 if (ops->get_mode) {
1864 result = device_create_file(&tz->device, &dev_attr_mode);
1869 result = create_trip_attrs(tz, mask);
1873 for (count = 0; count < trips; count++) {
1874 tz->ops->get_trip_type(tz, count, &trip_type);
1875 if (trip_type == THERMAL_TRIP_PASSIVE)
1880 result = device_create_file(&tz->device, &dev_attr_passive);
1885 if (IS_ENABLED(CONFIG_THERMAL_EMULATION)) {
1886 result = device_create_file(&tz->device, &dev_attr_emul_temp);
1891 /* Create policy attribute */
1892 result = device_create_file(&tz->device, &dev_attr_policy);
1896 /* Add thermal zone params */
1897 result = create_tzp_attrs(&tz->device);
1901 /* Create available_policies attribute */
1902 result = device_create_file(&tz->device, &dev_attr_available_policies);
1906 /* Update 'this' zone's governor information */
1907 mutex_lock(&thermal_governor_lock);
1910 governor = __find_governor(tz->tzp->governor_name);
1912 governor = def_governor;
1914 result = thermal_set_governor(tz, governor);
1916 mutex_unlock(&thermal_governor_lock);
1920 mutex_unlock(&thermal_governor_lock);
1922 if (!tz->tzp || !tz->tzp->no_hwmon) {
1923 result = thermal_add_hwmon_sysfs(tz);
1928 mutex_lock(&thermal_list_lock);
1929 list_add_tail(&tz->node, &thermal_tz_list);
1930 mutex_unlock(&thermal_list_lock);
1932 /* Bind cooling devices for this zone */
1935 INIT_DELAYED_WORK(&(tz->poll_queue), thermal_zone_device_check);
1937 thermal_zone_device_reset(tz);
1938 /* Update the new thermal zone and mark it as already updated. */
1939 if (atomic_cmpxchg(&tz->need_update, 1, 0))
1940 thermal_zone_device_update(tz);
1945 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1946 device_unregister(&tz->device);
1947 return ERR_PTR(result);
1949 EXPORT_SYMBOL_GPL(thermal_zone_device_register);
1952 * thermal_device_unregister - removes the registered thermal zone device
1953 * @tz: the thermal zone device to remove
1955 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1958 const struct thermal_zone_params *tzp;
1959 struct thermal_cooling_device *cdev;
1960 struct thermal_zone_device *pos = NULL;
1967 mutex_lock(&thermal_list_lock);
1968 list_for_each_entry(pos, &thermal_tz_list, node)
1972 /* thermal zone device not found */
1973 mutex_unlock(&thermal_list_lock);
1976 list_del(&tz->node);
1978 /* Unbind all cdevs associated with 'this' thermal zone */
1979 list_for_each_entry(cdev, &thermal_cdev_list, node) {
1980 if (tz->ops->unbind) {
1981 tz->ops->unbind(tz, cdev);
1985 if (!tzp || !tzp->tbp)
1988 for (i = 0; i < tzp->num_tbps; i++) {
1989 if (tzp->tbp[i].cdev == cdev) {
1990 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1991 tzp->tbp[i].cdev = NULL;
1996 mutex_unlock(&thermal_list_lock);
1998 thermal_zone_device_set_polling(tz, 0);
2001 device_remove_file(&tz->device, &dev_attr_type);
2002 device_remove_file(&tz->device, &dev_attr_temp);
2003 if (tz->ops->get_mode)
2004 device_remove_file(&tz->device, &dev_attr_mode);
2005 device_remove_file(&tz->device, &dev_attr_policy);
2006 device_remove_file(&tz->device, &dev_attr_available_policies);
2007 remove_trip_attrs(tz);
2008 thermal_set_governor(tz, NULL);
2010 thermal_remove_hwmon_sysfs(tz);
2011 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
2012 idr_destroy(&tz->idr);
2013 mutex_destroy(&tz->lock);
2014 device_unregister(&tz->device);
2017 EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
2020 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
2021 * @name: thermal zone name to fetch the temperature
2023 * When only one zone is found with the passed name, returns a reference to it.
2025 * Return: On success returns a reference to an unique thermal zone with
2026 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
2027 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
2029 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
2031 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
2032 unsigned int found = 0;
2037 mutex_lock(&thermal_list_lock);
2038 list_for_each_entry(pos, &thermal_tz_list, node)
2039 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
2043 mutex_unlock(&thermal_list_lock);
2045 /* nothing has been found, thus an error code for it */
2047 ref = ERR_PTR(-ENODEV);
2049 /* Success only when an unique zone is found */
2050 ref = ERR_PTR(-EEXIST);
2055 EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
2058 static const struct genl_multicast_group thermal_event_mcgrps[] = {
2059 { .name = THERMAL_GENL_MCAST_GROUP_NAME, },
2062 static struct genl_family thermal_event_genl_family = {
2063 .id = GENL_ID_GENERATE,
2064 .name = THERMAL_GENL_FAMILY_NAME,
2065 .version = THERMAL_GENL_VERSION,
2066 .maxattr = THERMAL_GENL_ATTR_MAX,
2067 .mcgrps = thermal_event_mcgrps,
2068 .n_mcgrps = ARRAY_SIZE(thermal_event_mcgrps),
2071 int thermal_generate_netlink_event(struct thermal_zone_device *tz,
2074 struct sk_buff *skb;
2075 struct nlattr *attr;
2076 struct thermal_genl_event *thermal_event;
2080 static unsigned int thermal_event_seqnum;
2085 /* allocate memory */
2086 size = nla_total_size(sizeof(struct thermal_genl_event)) +
2089 skb = genlmsg_new(size, GFP_ATOMIC);
2093 /* add the genetlink message header */
2094 msg_header = genlmsg_put(skb, 0, thermal_event_seqnum++,
2095 &thermal_event_genl_family, 0,
2096 THERMAL_GENL_CMD_EVENT);
2103 attr = nla_reserve(skb, THERMAL_GENL_ATTR_EVENT,
2104 sizeof(struct thermal_genl_event));
2111 thermal_event = nla_data(attr);
2112 if (!thermal_event) {
2117 memset(thermal_event, 0, sizeof(struct thermal_genl_event));
2119 thermal_event->orig = tz->id;
2120 thermal_event->event = event;
2122 /* send multicast genetlink message */
2123 genlmsg_end(skb, msg_header);
2125 result = genlmsg_multicast(&thermal_event_genl_family, skb, 0,
2128 dev_err(&tz->device, "Failed to send netlink event:%d", result);
2132 EXPORT_SYMBOL_GPL(thermal_generate_netlink_event);
2134 static int genetlink_init(void)
2136 return genl_register_family(&thermal_event_genl_family);
2139 static void genetlink_exit(void)
2141 genl_unregister_family(&thermal_event_genl_family);
2143 #else /* !CONFIG_NET */
2144 static inline int genetlink_init(void) { return 0; }
2145 static inline void genetlink_exit(void) {}
2146 #endif /* !CONFIG_NET */
2148 static int __init thermal_register_governors(void)
2152 result = thermal_gov_step_wise_register();
2156 result = thermal_gov_fair_share_register();
2160 result = thermal_gov_bang_bang_register();
2164 result = thermal_gov_user_space_register();
2168 return thermal_gov_power_allocator_register();
2171 static void thermal_unregister_governors(void)
2173 thermal_gov_step_wise_unregister();
2174 thermal_gov_fair_share_unregister();
2175 thermal_gov_bang_bang_unregister();
2176 thermal_gov_user_space_unregister();
2177 thermal_gov_power_allocator_unregister();
2180 static int thermal_pm_notify(struct notifier_block *nb,
2181 unsigned long mode, void *_unused)
2183 struct thermal_zone_device *tz;
2186 case PM_HIBERNATION_PREPARE:
2187 case PM_RESTORE_PREPARE:
2188 case PM_SUSPEND_PREPARE:
2189 atomic_set(&in_suspend, 1);
2191 case PM_POST_HIBERNATION:
2192 case PM_POST_RESTORE:
2193 case PM_POST_SUSPEND:
2194 atomic_set(&in_suspend, 0);
2195 list_for_each_entry(tz, &thermal_tz_list, node) {
2196 thermal_zone_device_reset(tz);
2197 thermal_zone_device_update(tz);
2206 static struct notifier_block thermal_pm_nb = {
2207 .notifier_call = thermal_pm_notify,
2210 static int __init thermal_init(void)
2214 result = thermal_register_governors();
2218 result = class_register(&thermal_class);
2220 goto unregister_governors;
2222 result = genetlink_init();
2224 goto unregister_class;
2226 result = of_parse_thermal_zones();
2230 result = register_pm_notifier(&thermal_pm_nb);
2232 pr_warn("Thermal: Can not register suspend notifier, return %d\n",
2240 class_unregister(&thermal_class);
2241 unregister_governors:
2242 thermal_unregister_governors();
2244 idr_destroy(&thermal_tz_idr);
2245 idr_destroy(&thermal_cdev_idr);
2246 mutex_destroy(&thermal_idr_lock);
2247 mutex_destroy(&thermal_list_lock);
2248 mutex_destroy(&thermal_governor_lock);
2252 static void __exit thermal_exit(void)
2254 unregister_pm_notifier(&thermal_pm_nb);
2255 of_thermal_destroy_zones();
2257 class_unregister(&thermal_class);
2258 thermal_unregister_governors();
2259 idr_destroy(&thermal_tz_idr);
2260 idr_destroy(&thermal_cdev_idr);
2261 mutex_destroy(&thermal_idr_lock);
2262 mutex_destroy(&thermal_list_lock);
2263 mutex_destroy(&thermal_governor_lock);
2266 fs_initcall(thermal_init);
2267 module_exit(thermal_exit);