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 /* Ignore disabled trip points */
458 if (test_bit(trip, &tz->trips_disabled))
461 tz->ops->get_trip_type(tz, trip, &type);
463 if (type == THERMAL_TRIP_CRITICAL || type == THERMAL_TRIP_HOT)
464 handle_critical_trips(tz, trip, type);
466 handle_non_critical_trips(tz, trip, type);
468 * Alright, we handled this trip successfully.
469 * So, start monitoring again.
471 monitor_thermal_zone(tz);
475 * thermal_zone_get_temp() - returns the temperature of a thermal zone
476 * @tz: a valid pointer to a struct thermal_zone_device
477 * @temp: a valid pointer to where to store the resulting temperature.
479 * When a valid thermal zone reference is passed, it will fetch its
480 * temperature and fill @temp.
482 * Return: On success returns 0, an error code otherwise
484 int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp)
488 int crit_temp = INT_MAX;
489 enum thermal_trip_type type;
491 if (!tz || IS_ERR(tz) || !tz->ops->get_temp)
494 mutex_lock(&tz->lock);
496 ret = tz->ops->get_temp(tz, temp);
498 if (IS_ENABLED(CONFIG_THERMAL_EMULATION) && tz->emul_temperature) {
499 for (count = 0; count < tz->trips; count++) {
500 ret = tz->ops->get_trip_type(tz, count, &type);
501 if (!ret && type == THERMAL_TRIP_CRITICAL) {
502 ret = tz->ops->get_trip_temp(tz, count,
509 * Only allow emulating a temperature when the real temperature
510 * is below the critical temperature so that the emulation code
511 * cannot hide critical conditions.
513 if (!ret && *temp < crit_temp)
514 *temp = tz->emul_temperature;
517 mutex_unlock(&tz->lock);
521 EXPORT_SYMBOL_GPL(thermal_zone_get_temp);
523 static void update_temperature(struct thermal_zone_device *tz)
527 ret = thermal_zone_get_temp(tz, &temp);
530 dev_warn(&tz->device,
531 "failed to read out thermal zone (%d)\n",
536 mutex_lock(&tz->lock);
537 tz->last_temperature = tz->temperature;
538 tz->temperature = temp;
539 mutex_unlock(&tz->lock);
541 trace_thermal_temperature(tz);
542 if (tz->last_temperature == THERMAL_TEMP_INVALID)
543 dev_dbg(&tz->device, "last_temperature N/A, current_temperature=%d\n",
546 dev_dbg(&tz->device, "last_temperature=%d, current_temperature=%d\n",
547 tz->last_temperature, tz->temperature);
550 static void thermal_zone_device_reset(struct thermal_zone_device *tz)
552 struct thermal_instance *pos;
554 tz->temperature = THERMAL_TEMP_INVALID;
556 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
557 pos->initialized = false;
560 void thermal_zone_device_update(struct thermal_zone_device *tz)
564 if (atomic_read(&in_suspend))
567 if (!tz->ops->get_temp)
570 update_temperature(tz);
572 for (count = 0; count < tz->trips; count++)
573 handle_thermal_trip(tz, count);
575 EXPORT_SYMBOL_GPL(thermal_zone_device_update);
577 static void thermal_zone_device_check(struct work_struct *work)
579 struct thermal_zone_device *tz = container_of(work, struct
582 thermal_zone_device_update(tz);
585 /* sys I/F for thermal zone */
587 #define to_thermal_zone(_dev) \
588 container_of(_dev, struct thermal_zone_device, device)
591 type_show(struct device *dev, struct device_attribute *attr, char *buf)
593 struct thermal_zone_device *tz = to_thermal_zone(dev);
595 return sprintf(buf, "%s\n", tz->type);
599 temp_show(struct device *dev, struct device_attribute *attr, char *buf)
601 struct thermal_zone_device *tz = to_thermal_zone(dev);
602 int temperature, ret;
604 ret = thermal_zone_get_temp(tz, &temperature);
609 return sprintf(buf, "%d\n", temperature);
613 mode_show(struct device *dev, struct device_attribute *attr, char *buf)
615 struct thermal_zone_device *tz = to_thermal_zone(dev);
616 enum thermal_device_mode mode;
619 if (!tz->ops->get_mode)
622 result = tz->ops->get_mode(tz, &mode);
626 return sprintf(buf, "%s\n", mode == THERMAL_DEVICE_ENABLED ? "enabled"
631 mode_store(struct device *dev, struct device_attribute *attr,
632 const char *buf, size_t count)
634 struct thermal_zone_device *tz = to_thermal_zone(dev);
637 if (!tz->ops->set_mode)
640 if (!strncmp(buf, "enabled", sizeof("enabled") - 1))
641 result = tz->ops->set_mode(tz, THERMAL_DEVICE_ENABLED);
642 else if (!strncmp(buf, "disabled", sizeof("disabled") - 1))
643 result = tz->ops->set_mode(tz, THERMAL_DEVICE_DISABLED);
654 trip_point_type_show(struct device *dev, struct device_attribute *attr,
657 struct thermal_zone_device *tz = to_thermal_zone(dev);
658 enum thermal_trip_type type;
661 if (!tz->ops->get_trip_type)
664 if (!sscanf(attr->attr.name, "trip_point_%d_type", &trip))
667 result = tz->ops->get_trip_type(tz, trip, &type);
672 case THERMAL_TRIP_CRITICAL:
673 return sprintf(buf, "critical\n");
674 case THERMAL_TRIP_HOT:
675 return sprintf(buf, "hot\n");
676 case THERMAL_TRIP_PASSIVE:
677 return sprintf(buf, "passive\n");
678 case THERMAL_TRIP_ACTIVE:
679 return sprintf(buf, "active\n");
681 return sprintf(buf, "unknown\n");
686 trip_point_temp_store(struct device *dev, struct device_attribute *attr,
687 const char *buf, size_t count)
689 struct thermal_zone_device *tz = to_thermal_zone(dev);
693 if (!tz->ops->set_trip_temp)
696 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
699 if (kstrtoint(buf, 10, &temperature))
702 ret = tz->ops->set_trip_temp(tz, trip, temperature);
706 thermal_zone_device_update(tz);
712 trip_point_temp_show(struct device *dev, struct device_attribute *attr,
715 struct thermal_zone_device *tz = to_thermal_zone(dev);
719 if (!tz->ops->get_trip_temp)
722 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
725 ret = tz->ops->get_trip_temp(tz, trip, &temperature);
730 return sprintf(buf, "%d\n", temperature);
734 trip_point_hyst_store(struct device *dev, struct device_attribute *attr,
735 const char *buf, size_t count)
737 struct thermal_zone_device *tz = to_thermal_zone(dev);
741 if (!tz->ops->set_trip_hyst)
744 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
747 if (kstrtoint(buf, 10, &temperature))
751 * We are not doing any check on the 'temperature' value
752 * here. The driver implementing 'set_trip_hyst' has to
755 ret = tz->ops->set_trip_hyst(tz, trip, temperature);
757 return ret ? ret : count;
761 trip_point_hyst_show(struct device *dev, struct device_attribute *attr,
764 struct thermal_zone_device *tz = to_thermal_zone(dev);
768 if (!tz->ops->get_trip_hyst)
771 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
774 ret = tz->ops->get_trip_hyst(tz, trip, &temperature);
776 return ret ? ret : sprintf(buf, "%d\n", temperature);
780 passive_store(struct device *dev, struct device_attribute *attr,
781 const char *buf, size_t count)
783 struct thermal_zone_device *tz = to_thermal_zone(dev);
784 struct thermal_cooling_device *cdev = NULL;
787 if (!sscanf(buf, "%d\n", &state))
790 /* sanity check: values below 1000 millicelcius don't make sense
791 * and can cause the system to go into a thermal heart attack
793 if (state && state < 1000)
796 if (state && !tz->forced_passive) {
797 mutex_lock(&thermal_list_lock);
798 list_for_each_entry(cdev, &thermal_cdev_list, node) {
799 if (!strncmp("Processor", cdev->type,
800 sizeof("Processor")))
801 thermal_zone_bind_cooling_device(tz,
802 THERMAL_TRIPS_NONE, cdev,
805 THERMAL_WEIGHT_DEFAULT);
807 mutex_unlock(&thermal_list_lock);
808 if (!tz->passive_delay)
809 tz->passive_delay = 1000;
810 } else if (!state && tz->forced_passive) {
811 mutex_lock(&thermal_list_lock);
812 list_for_each_entry(cdev, &thermal_cdev_list, node) {
813 if (!strncmp("Processor", cdev->type,
814 sizeof("Processor")))
815 thermal_zone_unbind_cooling_device(tz,
819 mutex_unlock(&thermal_list_lock);
820 tz->passive_delay = 0;
823 tz->forced_passive = state;
825 thermal_zone_device_update(tz);
831 passive_show(struct device *dev, struct device_attribute *attr,
834 struct thermal_zone_device *tz = to_thermal_zone(dev);
836 return sprintf(buf, "%d\n", tz->forced_passive);
840 policy_store(struct device *dev, struct device_attribute *attr,
841 const char *buf, size_t count)
844 struct thermal_zone_device *tz = to_thermal_zone(dev);
845 struct thermal_governor *gov;
846 char name[THERMAL_NAME_LENGTH];
848 snprintf(name, sizeof(name), "%s", buf);
850 mutex_lock(&thermal_governor_lock);
851 mutex_lock(&tz->lock);
853 gov = __find_governor(strim(name));
857 ret = thermal_set_governor(tz, gov);
862 mutex_unlock(&tz->lock);
863 mutex_unlock(&thermal_governor_lock);
868 policy_show(struct device *dev, struct device_attribute *devattr, char *buf)
870 struct thermal_zone_device *tz = to_thermal_zone(dev);
872 return sprintf(buf, "%s\n", tz->governor->name);
876 available_policies_show(struct device *dev, struct device_attribute *devattr,
879 struct thermal_governor *pos;
881 ssize_t size = PAGE_SIZE;
883 mutex_lock(&thermal_governor_lock);
885 list_for_each_entry(pos, &thermal_governor_list, governor_list) {
886 size = PAGE_SIZE - count;
887 count += scnprintf(buf + count, size, "%s ", pos->name);
889 count += scnprintf(buf + count, size, "\n");
891 mutex_unlock(&thermal_governor_lock);
897 emul_temp_store(struct device *dev, struct device_attribute *attr,
898 const char *buf, size_t count)
900 struct thermal_zone_device *tz = to_thermal_zone(dev);
904 if (kstrtoint(buf, 10, &temperature))
907 if (!tz->ops->set_emul_temp) {
908 mutex_lock(&tz->lock);
909 tz->emul_temperature = temperature;
910 mutex_unlock(&tz->lock);
912 ret = tz->ops->set_emul_temp(tz, temperature);
916 thermal_zone_device_update(tz);
918 return ret ? ret : count;
920 static DEVICE_ATTR(emul_temp, S_IWUSR, NULL, emul_temp_store);
923 sustainable_power_show(struct device *dev, struct device_attribute *devattr,
926 struct thermal_zone_device *tz = to_thermal_zone(dev);
929 return sprintf(buf, "%u\n", tz->tzp->sustainable_power);
935 sustainable_power_store(struct device *dev, struct device_attribute *devattr,
936 const char *buf, size_t count)
938 struct thermal_zone_device *tz = to_thermal_zone(dev);
939 u32 sustainable_power;
944 if (kstrtou32(buf, 10, &sustainable_power))
947 tz->tzp->sustainable_power = sustainable_power;
951 static DEVICE_ATTR(sustainable_power, S_IWUSR | S_IRUGO, sustainable_power_show,
952 sustainable_power_store);
954 #define create_s32_tzp_attr(name) \
956 name##_show(struct device *dev, struct device_attribute *devattr, \
959 struct thermal_zone_device *tz = to_thermal_zone(dev); \
962 return sprintf(buf, "%d\n", tz->tzp->name); \
968 name##_store(struct device *dev, struct device_attribute *devattr, \
969 const char *buf, size_t count) \
971 struct thermal_zone_device *tz = to_thermal_zone(dev); \
977 if (kstrtos32(buf, 10, &value)) \
980 tz->tzp->name = value; \
984 static DEVICE_ATTR(name, S_IWUSR | S_IRUGO, name##_show, name##_store)
986 create_s32_tzp_attr(k_po);
987 create_s32_tzp_attr(k_pu);
988 create_s32_tzp_attr(k_i);
989 create_s32_tzp_attr(k_d);
990 create_s32_tzp_attr(integral_cutoff);
991 create_s32_tzp_attr(slope);
992 create_s32_tzp_attr(offset);
993 #undef create_s32_tzp_attr
995 static struct device_attribute *dev_tzp_attrs[] = {
996 &dev_attr_sustainable_power,
1001 &dev_attr_integral_cutoff,
1006 static int create_tzp_attrs(struct device *dev)
1010 for (i = 0; i < ARRAY_SIZE(dev_tzp_attrs); i++) {
1012 struct device_attribute *dev_attr = dev_tzp_attrs[i];
1014 ret = device_create_file(dev, dev_attr);
1023 * power_actor_get_max_power() - get the maximum power that a cdev can consume
1024 * @cdev: pointer to &thermal_cooling_device
1025 * @tz: a valid thermal zone device pointer
1026 * @max_power: pointer in which to store the maximum power
1028 * Calculate the maximum power consumption in milliwats that the
1029 * cooling device can currently consume and store it in @max_power.
1031 * Return: 0 on success, -EINVAL if @cdev doesn't support the
1032 * power_actor API or -E* on other error.
1034 int power_actor_get_max_power(struct thermal_cooling_device *cdev,
1035 struct thermal_zone_device *tz, u32 *max_power)
1037 if (!cdev_is_power_actor(cdev))
1040 return cdev->ops->state2power(cdev, tz, 0, max_power);
1044 * power_actor_get_min_power() - get the mainimum power that a cdev can consume
1045 * @cdev: pointer to &thermal_cooling_device
1046 * @tz: a valid thermal zone device pointer
1047 * @min_power: pointer in which to store the minimum power
1049 * Calculate the minimum power consumption in milliwatts that the
1050 * cooling device can currently consume and store it in @min_power.
1052 * Return: 0 on success, -EINVAL if @cdev doesn't support the
1053 * power_actor API or -E* on other error.
1055 int power_actor_get_min_power(struct thermal_cooling_device *cdev,
1056 struct thermal_zone_device *tz, u32 *min_power)
1058 unsigned long max_state;
1061 if (!cdev_is_power_actor(cdev))
1064 ret = cdev->ops->get_max_state(cdev, &max_state);
1068 return cdev->ops->state2power(cdev, tz, max_state, min_power);
1072 * power_actor_set_power() - limit the maximum power that a cooling device can consume
1073 * @cdev: pointer to &thermal_cooling_device
1074 * @instance: thermal instance to update
1075 * @power: the power in milliwatts
1077 * Set the cooling device to consume at most @power milliwatts.
1079 * Return: 0 on success, -EINVAL if the cooling device does not
1080 * implement the power actor API or -E* for other failures.
1082 int power_actor_set_power(struct thermal_cooling_device *cdev,
1083 struct thermal_instance *instance, u32 power)
1085 unsigned long state;
1088 if (!cdev_is_power_actor(cdev))
1091 ret = cdev->ops->power2state(cdev, instance->tz, power, &state);
1095 instance->target = state;
1096 mutex_lock(&cdev->lock);
1097 cdev->updated = false;
1098 mutex_unlock(&cdev->lock);
1099 thermal_cdev_update(cdev);
1104 static DEVICE_ATTR(type, 0444, type_show, NULL);
1105 static DEVICE_ATTR(temp, 0444, temp_show, NULL);
1106 static DEVICE_ATTR(mode, 0644, mode_show, mode_store);
1107 static DEVICE_ATTR(passive, S_IRUGO | S_IWUSR, passive_show, passive_store);
1108 static DEVICE_ATTR(policy, S_IRUGO | S_IWUSR, policy_show, policy_store);
1109 static DEVICE_ATTR(available_policies, S_IRUGO, available_policies_show, NULL);
1111 /* sys I/F for cooling device */
1112 #define to_cooling_device(_dev) \
1113 container_of(_dev, struct thermal_cooling_device, device)
1116 thermal_cooling_device_type_show(struct device *dev,
1117 struct device_attribute *attr, char *buf)
1119 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1121 return sprintf(buf, "%s\n", cdev->type);
1125 thermal_cooling_device_max_state_show(struct device *dev,
1126 struct device_attribute *attr, char *buf)
1128 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1129 unsigned long state;
1132 ret = cdev->ops->get_max_state(cdev, &state);
1135 return sprintf(buf, "%ld\n", state);
1139 thermal_cooling_device_cur_state_show(struct device *dev,
1140 struct device_attribute *attr, char *buf)
1142 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1143 unsigned long state;
1146 ret = cdev->ops->get_cur_state(cdev, &state);
1149 return sprintf(buf, "%ld\n", state);
1153 thermal_cooling_device_cur_state_store(struct device *dev,
1154 struct device_attribute *attr,
1155 const char *buf, size_t count)
1157 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1158 unsigned long state;
1161 if (!sscanf(buf, "%ld\n", &state))
1164 if ((long)state < 0)
1167 result = cdev->ops->set_cur_state(cdev, state);
1173 static struct device_attribute dev_attr_cdev_type =
1174 __ATTR(type, 0444, thermal_cooling_device_type_show, NULL);
1175 static DEVICE_ATTR(max_state, 0444,
1176 thermal_cooling_device_max_state_show, NULL);
1177 static DEVICE_ATTR(cur_state, 0644,
1178 thermal_cooling_device_cur_state_show,
1179 thermal_cooling_device_cur_state_store);
1182 thermal_cooling_device_trip_point_show(struct device *dev,
1183 struct device_attribute *attr, char *buf)
1185 struct thermal_instance *instance;
1188 container_of(attr, struct thermal_instance, attr);
1190 if (instance->trip == THERMAL_TRIPS_NONE)
1191 return sprintf(buf, "-1\n");
1193 return sprintf(buf, "%d\n", instance->trip);
1196 static struct attribute *cooling_device_attrs[] = {
1197 &dev_attr_cdev_type.attr,
1198 &dev_attr_max_state.attr,
1199 &dev_attr_cur_state.attr,
1203 static const struct attribute_group cooling_device_attr_group = {
1204 .attrs = cooling_device_attrs,
1207 static const struct attribute_group *cooling_device_attr_groups[] = {
1208 &cooling_device_attr_group,
1213 thermal_cooling_device_weight_show(struct device *dev,
1214 struct device_attribute *attr, char *buf)
1216 struct thermal_instance *instance;
1218 instance = container_of(attr, struct thermal_instance, weight_attr);
1220 return sprintf(buf, "%d\n", instance->weight);
1224 thermal_cooling_device_weight_store(struct device *dev,
1225 struct device_attribute *attr,
1226 const char *buf, size_t count)
1228 struct thermal_instance *instance;
1231 ret = kstrtoint(buf, 0, &weight);
1235 instance = container_of(attr, struct thermal_instance, weight_attr);
1236 instance->weight = weight;
1240 /* Device management */
1243 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
1244 * @tz: pointer to struct thermal_zone_device
1245 * @trip: indicates which trip point the cooling devices is
1246 * associated with in this thermal zone.
1247 * @cdev: pointer to struct thermal_cooling_device
1248 * @upper: the Maximum cooling state for this trip point.
1249 * THERMAL_NO_LIMIT means no upper limit,
1250 * and the cooling device can be in max_state.
1251 * @lower: the Minimum cooling state can be used for this trip point.
1252 * THERMAL_NO_LIMIT means no lower limit,
1253 * and the cooling device can be in cooling state 0.
1254 * @weight: The weight of the cooling device to be bound to the
1255 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
1258 * This interface function bind a thermal cooling device to the certain trip
1259 * point of a thermal zone device.
1260 * This function is usually called in the thermal zone device .bind callback.
1262 * Return: 0 on success, the proper error value otherwise.
1264 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
1266 struct thermal_cooling_device *cdev,
1267 unsigned long upper, unsigned long lower,
1268 unsigned int weight)
1270 struct thermal_instance *dev;
1271 struct thermal_instance *pos;
1272 struct thermal_zone_device *pos1;
1273 struct thermal_cooling_device *pos2;
1274 unsigned long max_state;
1277 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
1280 list_for_each_entry(pos1, &thermal_tz_list, node) {
1284 list_for_each_entry(pos2, &thermal_cdev_list, node) {
1289 if (tz != pos1 || cdev != pos2)
1292 ret = cdev->ops->get_max_state(cdev, &max_state);
1296 /* lower default 0, upper default max_state */
1297 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
1298 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
1300 if (lower > upper || upper > max_state)
1304 kzalloc(sizeof(struct thermal_instance), GFP_KERNEL);
1312 dev->target = THERMAL_NO_TARGET;
1313 dev->weight = weight;
1315 result = get_idr(&tz->idr, &tz->lock, &dev->id);
1319 sprintf(dev->name, "cdev%d", dev->id);
1321 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
1325 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
1326 sysfs_attr_init(&dev->attr.attr);
1327 dev->attr.attr.name = dev->attr_name;
1328 dev->attr.attr.mode = 0444;
1329 dev->attr.show = thermal_cooling_device_trip_point_show;
1330 result = device_create_file(&tz->device, &dev->attr);
1332 goto remove_symbol_link;
1334 sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
1335 sysfs_attr_init(&dev->weight_attr.attr);
1336 dev->weight_attr.attr.name = dev->weight_attr_name;
1337 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
1338 dev->weight_attr.show = thermal_cooling_device_weight_show;
1339 dev->weight_attr.store = thermal_cooling_device_weight_store;
1340 result = device_create_file(&tz->device, &dev->weight_attr);
1342 goto remove_trip_file;
1344 mutex_lock(&tz->lock);
1345 mutex_lock(&cdev->lock);
1346 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
1347 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1352 list_add_tail(&dev->tz_node, &tz->thermal_instances);
1353 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
1354 atomic_set(&tz->need_update, 1);
1356 mutex_unlock(&cdev->lock);
1357 mutex_unlock(&tz->lock);
1362 device_remove_file(&tz->device, &dev->weight_attr);
1364 device_remove_file(&tz->device, &dev->attr);
1366 sysfs_remove_link(&tz->device.kobj, dev->name);
1368 release_idr(&tz->idr, &tz->lock, dev->id);
1373 EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
1376 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
1378 * @tz: pointer to a struct thermal_zone_device.
1379 * @trip: indicates which trip point the cooling devices is
1380 * associated with in this thermal zone.
1381 * @cdev: pointer to a struct thermal_cooling_device.
1383 * This interface function unbind a thermal cooling device from the certain
1384 * trip point of a thermal zone device.
1385 * This function is usually called in the thermal zone device .unbind callback.
1387 * Return: 0 on success, the proper error value otherwise.
1389 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
1391 struct thermal_cooling_device *cdev)
1393 struct thermal_instance *pos, *next;
1395 mutex_lock(&tz->lock);
1396 mutex_lock(&cdev->lock);
1397 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
1398 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1399 list_del(&pos->tz_node);
1400 list_del(&pos->cdev_node);
1401 mutex_unlock(&cdev->lock);
1402 mutex_unlock(&tz->lock);
1406 mutex_unlock(&cdev->lock);
1407 mutex_unlock(&tz->lock);
1412 device_remove_file(&tz->device, &pos->weight_attr);
1413 device_remove_file(&tz->device, &pos->attr);
1414 sysfs_remove_link(&tz->device.kobj, pos->name);
1415 release_idr(&tz->idr, &tz->lock, pos->id);
1419 EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
1421 static void thermal_release(struct device *dev)
1423 struct thermal_zone_device *tz;
1424 struct thermal_cooling_device *cdev;
1426 if (!strncmp(dev_name(dev), "thermal_zone",
1427 sizeof("thermal_zone") - 1)) {
1428 tz = to_thermal_zone(dev);
1430 } else if(!strncmp(dev_name(dev), "cooling_device",
1431 sizeof("cooling_device") - 1)){
1432 cdev = to_cooling_device(dev);
1437 static struct class thermal_class = {
1439 .dev_release = thermal_release,
1443 * __thermal_cooling_device_register() - register a new thermal cooling device
1444 * @np: a pointer to a device tree node.
1445 * @type: the thermal cooling device type.
1446 * @devdata: device private data.
1447 * @ops: standard thermal cooling devices callbacks.
1449 * This interface function adds a new thermal cooling device (fan/processor/...)
1450 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1451 * to all the thermal zone devices registered at the same time.
1452 * It also gives the opportunity to link the cooling device to a device tree
1453 * node, so that it can be bound to a thermal zone created out of device tree.
1455 * Return: a pointer to the created struct thermal_cooling_device or an
1456 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1458 static struct thermal_cooling_device *
1459 __thermal_cooling_device_register(struct device_node *np,
1460 char *type, void *devdata,
1461 const struct thermal_cooling_device_ops *ops)
1463 struct thermal_cooling_device *cdev;
1464 struct thermal_zone_device *pos = NULL;
1467 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1468 return ERR_PTR(-EINVAL);
1470 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
1471 !ops->set_cur_state)
1472 return ERR_PTR(-EINVAL);
1474 cdev = kzalloc(sizeof(struct thermal_cooling_device), GFP_KERNEL);
1476 return ERR_PTR(-ENOMEM);
1478 result = get_idr(&thermal_cdev_idr, &thermal_idr_lock, &cdev->id);
1481 return ERR_PTR(result);
1484 strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
1485 mutex_init(&cdev->lock);
1486 INIT_LIST_HEAD(&cdev->thermal_instances);
1489 cdev->updated = false;
1490 cdev->device.class = &thermal_class;
1491 cdev->device.groups = cooling_device_attr_groups;
1492 cdev->devdata = devdata;
1493 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
1494 result = device_register(&cdev->device);
1496 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1498 return ERR_PTR(result);
1501 /* Add 'this' new cdev to the global cdev list */
1502 mutex_lock(&thermal_list_lock);
1503 list_add(&cdev->node, &thermal_cdev_list);
1504 mutex_unlock(&thermal_list_lock);
1506 /* Update binding information for 'this' new cdev */
1509 mutex_lock(&thermal_list_lock);
1510 list_for_each_entry(pos, &thermal_tz_list, node)
1511 if (atomic_cmpxchg(&pos->need_update, 1, 0))
1512 thermal_zone_device_update(pos);
1513 mutex_unlock(&thermal_list_lock);
1519 * thermal_cooling_device_register() - register a new thermal cooling device
1520 * @type: the thermal cooling device type.
1521 * @devdata: device private data.
1522 * @ops: standard thermal cooling devices callbacks.
1524 * This interface function adds a new thermal cooling device (fan/processor/...)
1525 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1526 * to all the thermal zone devices registered at the same time.
1528 * Return: a pointer to the created struct thermal_cooling_device or an
1529 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1531 struct thermal_cooling_device *
1532 thermal_cooling_device_register(char *type, void *devdata,
1533 const struct thermal_cooling_device_ops *ops)
1535 return __thermal_cooling_device_register(NULL, type, devdata, ops);
1537 EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
1540 * thermal_of_cooling_device_register() - register an OF thermal cooling device
1541 * @np: a pointer to a device tree node.
1542 * @type: the thermal cooling device type.
1543 * @devdata: device private data.
1544 * @ops: standard thermal cooling devices callbacks.
1546 * This function will register a cooling device with device tree node reference.
1547 * This interface function adds a new thermal cooling device (fan/processor/...)
1548 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1549 * to all the thermal zone devices registered at the same time.
1551 * Return: a pointer to the created struct thermal_cooling_device or an
1552 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1554 struct thermal_cooling_device *
1555 thermal_of_cooling_device_register(struct device_node *np,
1556 char *type, void *devdata,
1557 const struct thermal_cooling_device_ops *ops)
1559 return __thermal_cooling_device_register(np, type, devdata, ops);
1561 EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
1564 * thermal_cooling_device_unregister - removes the registered thermal cooling device
1565 * @cdev: the thermal cooling device to remove.
1567 * thermal_cooling_device_unregister() must be called when the device is no
1570 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1573 const struct thermal_zone_params *tzp;
1574 struct thermal_zone_device *tz;
1575 struct thermal_cooling_device *pos = NULL;
1580 mutex_lock(&thermal_list_lock);
1581 list_for_each_entry(pos, &thermal_cdev_list, node)
1585 /* thermal cooling device not found */
1586 mutex_unlock(&thermal_list_lock);
1589 list_del(&cdev->node);
1591 /* Unbind all thermal zones associated with 'this' cdev */
1592 list_for_each_entry(tz, &thermal_tz_list, node) {
1593 if (tz->ops->unbind) {
1594 tz->ops->unbind(tz, cdev);
1598 if (!tz->tzp || !tz->tzp->tbp)
1602 for (i = 0; i < tzp->num_tbps; i++) {
1603 if (tzp->tbp[i].cdev == cdev) {
1604 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1605 tzp->tbp[i].cdev = NULL;
1610 mutex_unlock(&thermal_list_lock);
1613 device_remove_file(&cdev->device, &dev_attr_cdev_type);
1614 device_remove_file(&cdev->device, &dev_attr_max_state);
1615 device_remove_file(&cdev->device, &dev_attr_cur_state);
1617 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1618 device_unregister(&cdev->device);
1621 EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1623 void thermal_cdev_update(struct thermal_cooling_device *cdev)
1625 struct thermal_instance *instance;
1626 unsigned long target = 0;
1628 mutex_lock(&cdev->lock);
1629 /* cooling device is updated*/
1630 if (cdev->updated) {
1631 mutex_unlock(&cdev->lock);
1635 /* Make sure cdev enters the deepest cooling state */
1636 list_for_each_entry(instance, &cdev->thermal_instances, cdev_node) {
1637 dev_dbg(&cdev->device, "zone%d->target=%lu\n",
1638 instance->tz->id, instance->target);
1639 if (instance->target == THERMAL_NO_TARGET)
1641 if (instance->target > target)
1642 target = instance->target;
1644 cdev->ops->set_cur_state(cdev, target);
1645 cdev->updated = true;
1646 mutex_unlock(&cdev->lock);
1647 trace_cdev_update(cdev, target);
1648 dev_dbg(&cdev->device, "set to state %lu\n", target);
1650 EXPORT_SYMBOL(thermal_cdev_update);
1653 * thermal_notify_framework - Sensor drivers use this API to notify framework
1654 * @tz: thermal zone device
1655 * @trip: indicates which trip point has been crossed
1657 * This function handles the trip events from sensor drivers. It starts
1658 * throttling the cooling devices according to the policy configured.
1659 * For CRITICAL and HOT trip points, this notifies the respective drivers,
1660 * and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
1661 * The throttling policy is based on the configured platform data; if no
1662 * platform data is provided, this uses the step_wise throttling policy.
1664 void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
1666 handle_thermal_trip(tz, trip);
1668 EXPORT_SYMBOL_GPL(thermal_notify_framework);
1671 * create_trip_attrs() - create attributes for trip points
1672 * @tz: the thermal zone device
1673 * @mask: Writeable trip point bitmap.
1675 * helper function to instantiate sysfs entries for every trip
1676 * point and its properties of a struct thermal_zone_device.
1678 * Return: 0 on success, the proper error value otherwise.
1680 static int create_trip_attrs(struct thermal_zone_device *tz, int mask)
1683 int size = sizeof(struct thermal_attr) * tz->trips;
1685 tz->trip_type_attrs = kzalloc(size, GFP_KERNEL);
1686 if (!tz->trip_type_attrs)
1689 tz->trip_temp_attrs = kzalloc(size, GFP_KERNEL);
1690 if (!tz->trip_temp_attrs) {
1691 kfree(tz->trip_type_attrs);
1695 if (tz->ops->get_trip_hyst) {
1696 tz->trip_hyst_attrs = kzalloc(size, GFP_KERNEL);
1697 if (!tz->trip_hyst_attrs) {
1698 kfree(tz->trip_type_attrs);
1699 kfree(tz->trip_temp_attrs);
1705 for (indx = 0; indx < tz->trips; indx++) {
1706 /* create trip type attribute */
1707 snprintf(tz->trip_type_attrs[indx].name, THERMAL_NAME_LENGTH,
1708 "trip_point_%d_type", indx);
1710 sysfs_attr_init(&tz->trip_type_attrs[indx].attr.attr);
1711 tz->trip_type_attrs[indx].attr.attr.name =
1712 tz->trip_type_attrs[indx].name;
1713 tz->trip_type_attrs[indx].attr.attr.mode = S_IRUGO;
1714 tz->trip_type_attrs[indx].attr.show = trip_point_type_show;
1716 device_create_file(&tz->device,
1717 &tz->trip_type_attrs[indx].attr);
1719 /* create trip temp attribute */
1720 snprintf(tz->trip_temp_attrs[indx].name, THERMAL_NAME_LENGTH,
1721 "trip_point_%d_temp", indx);
1723 sysfs_attr_init(&tz->trip_temp_attrs[indx].attr.attr);
1724 tz->trip_temp_attrs[indx].attr.attr.name =
1725 tz->trip_temp_attrs[indx].name;
1726 tz->trip_temp_attrs[indx].attr.attr.mode = S_IRUGO;
1727 tz->trip_temp_attrs[indx].attr.show = trip_point_temp_show;
1728 if (IS_ENABLED(CONFIG_THERMAL_WRITABLE_TRIPS) &&
1729 mask & (1 << indx)) {
1730 tz->trip_temp_attrs[indx].attr.attr.mode |= S_IWUSR;
1731 tz->trip_temp_attrs[indx].attr.store =
1732 trip_point_temp_store;
1735 device_create_file(&tz->device,
1736 &tz->trip_temp_attrs[indx].attr);
1738 /* create Optional trip hyst attribute */
1739 if (!tz->ops->get_trip_hyst)
1741 snprintf(tz->trip_hyst_attrs[indx].name, THERMAL_NAME_LENGTH,
1742 "trip_point_%d_hyst", indx);
1744 sysfs_attr_init(&tz->trip_hyst_attrs[indx].attr.attr);
1745 tz->trip_hyst_attrs[indx].attr.attr.name =
1746 tz->trip_hyst_attrs[indx].name;
1747 tz->trip_hyst_attrs[indx].attr.attr.mode = S_IRUGO;
1748 tz->trip_hyst_attrs[indx].attr.show = trip_point_hyst_show;
1749 if (tz->ops->set_trip_hyst) {
1750 tz->trip_hyst_attrs[indx].attr.attr.mode |= S_IWUSR;
1751 tz->trip_hyst_attrs[indx].attr.store =
1752 trip_point_hyst_store;
1755 device_create_file(&tz->device,
1756 &tz->trip_hyst_attrs[indx].attr);
1761 static void remove_trip_attrs(struct thermal_zone_device *tz)
1765 for (indx = 0; indx < tz->trips; indx++) {
1766 device_remove_file(&tz->device,
1767 &tz->trip_type_attrs[indx].attr);
1768 device_remove_file(&tz->device,
1769 &tz->trip_temp_attrs[indx].attr);
1770 if (tz->ops->get_trip_hyst)
1771 device_remove_file(&tz->device,
1772 &tz->trip_hyst_attrs[indx].attr);
1774 kfree(tz->trip_type_attrs);
1775 kfree(tz->trip_temp_attrs);
1776 kfree(tz->trip_hyst_attrs);
1780 * thermal_zone_device_register() - register a new thermal zone device
1781 * @type: the thermal zone device type
1782 * @trips: the number of trip points the thermal zone support
1783 * @mask: a bit string indicating the writeablility of trip points
1784 * @devdata: private device data
1785 * @ops: standard thermal zone device callbacks
1786 * @tzp: thermal zone platform parameters
1787 * @passive_delay: number of milliseconds to wait between polls when
1788 * performing passive cooling
1789 * @polling_delay: number of milliseconds to wait between polls when checking
1790 * whether trip points have been crossed (0 for interrupt
1793 * This interface function adds a new thermal zone device (sensor) to
1794 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1795 * thermal cooling devices registered at the same time.
1796 * thermal_zone_device_unregister() must be called when the device is no
1797 * longer needed. The passive cooling depends on the .get_trend() return value.
1799 * Return: a pointer to the created struct thermal_zone_device or an
1800 * in case of error, an ERR_PTR. Caller must check return value with
1801 * IS_ERR*() helpers.
1803 struct thermal_zone_device *thermal_zone_device_register(const char *type,
1804 int trips, int mask, void *devdata,
1805 struct thermal_zone_device_ops *ops,
1806 struct thermal_zone_params *tzp,
1807 int passive_delay, int polling_delay)
1809 struct thermal_zone_device *tz;
1810 enum thermal_trip_type trip_type;
1815 struct thermal_governor *governor;
1817 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1818 return ERR_PTR(-EINVAL);
1820 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
1821 return ERR_PTR(-EINVAL);
1824 return ERR_PTR(-EINVAL);
1826 if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
1827 return ERR_PTR(-EINVAL);
1829 tz = kzalloc(sizeof(struct thermal_zone_device), GFP_KERNEL);
1831 return ERR_PTR(-ENOMEM);
1833 INIT_LIST_HEAD(&tz->thermal_instances);
1835 mutex_init(&tz->lock);
1836 result = get_idr(&thermal_tz_idr, &thermal_idr_lock, &tz->id);
1839 return ERR_PTR(result);
1842 strlcpy(tz->type, type ? : "", sizeof(tz->type));
1845 tz->device.class = &thermal_class;
1846 tz->devdata = devdata;
1848 tz->passive_delay = passive_delay;
1849 tz->polling_delay = polling_delay;
1850 /* A new thermal zone needs to be updated anyway. */
1851 atomic_set(&tz->need_update, 1);
1853 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1854 result = device_register(&tz->device);
1856 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1858 return ERR_PTR(result);
1863 result = device_create_file(&tz->device, &dev_attr_type);
1868 result = device_create_file(&tz->device, &dev_attr_temp);
1872 if (ops->get_mode) {
1873 result = device_create_file(&tz->device, &dev_attr_mode);
1878 result = create_trip_attrs(tz, mask);
1882 for (count = 0; count < trips; count++) {
1883 if (tz->ops->get_trip_type(tz, count, &trip_type))
1884 set_bit(count, &tz->trips_disabled);
1885 if (trip_type == THERMAL_TRIP_PASSIVE)
1887 if (tz->ops->get_trip_temp(tz, count, &trip_temp))
1888 set_bit(count, &tz->trips_disabled);
1889 /* Check for bogus trip points */
1891 set_bit(count, &tz->trips_disabled);
1895 result = device_create_file(&tz->device, &dev_attr_passive);
1900 if (IS_ENABLED(CONFIG_THERMAL_EMULATION)) {
1901 result = device_create_file(&tz->device, &dev_attr_emul_temp);
1906 /* Create policy attribute */
1907 result = device_create_file(&tz->device, &dev_attr_policy);
1911 /* Add thermal zone params */
1912 result = create_tzp_attrs(&tz->device);
1916 /* Create available_policies attribute */
1917 result = device_create_file(&tz->device, &dev_attr_available_policies);
1921 /* Update 'this' zone's governor information */
1922 mutex_lock(&thermal_governor_lock);
1925 governor = __find_governor(tz->tzp->governor_name);
1927 governor = def_governor;
1929 result = thermal_set_governor(tz, governor);
1931 mutex_unlock(&thermal_governor_lock);
1935 mutex_unlock(&thermal_governor_lock);
1937 if (!tz->tzp || !tz->tzp->no_hwmon) {
1938 result = thermal_add_hwmon_sysfs(tz);
1943 mutex_lock(&thermal_list_lock);
1944 list_add_tail(&tz->node, &thermal_tz_list);
1945 mutex_unlock(&thermal_list_lock);
1947 /* Bind cooling devices for this zone */
1950 INIT_DELAYED_WORK(&(tz->poll_queue), thermal_zone_device_check);
1952 thermal_zone_device_reset(tz);
1953 /* Update the new thermal zone and mark it as already updated. */
1954 if (atomic_cmpxchg(&tz->need_update, 1, 0))
1955 thermal_zone_device_update(tz);
1960 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1961 device_unregister(&tz->device);
1962 return ERR_PTR(result);
1964 EXPORT_SYMBOL_GPL(thermal_zone_device_register);
1967 * thermal_device_unregister - removes the registered thermal zone device
1968 * @tz: the thermal zone device to remove
1970 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1973 const struct thermal_zone_params *tzp;
1974 struct thermal_cooling_device *cdev;
1975 struct thermal_zone_device *pos = NULL;
1982 mutex_lock(&thermal_list_lock);
1983 list_for_each_entry(pos, &thermal_tz_list, node)
1987 /* thermal zone device not found */
1988 mutex_unlock(&thermal_list_lock);
1991 list_del(&tz->node);
1993 /* Unbind all cdevs associated with 'this' thermal zone */
1994 list_for_each_entry(cdev, &thermal_cdev_list, node) {
1995 if (tz->ops->unbind) {
1996 tz->ops->unbind(tz, cdev);
2000 if (!tzp || !tzp->tbp)
2003 for (i = 0; i < tzp->num_tbps; i++) {
2004 if (tzp->tbp[i].cdev == cdev) {
2005 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
2006 tzp->tbp[i].cdev = NULL;
2011 mutex_unlock(&thermal_list_lock);
2013 thermal_zone_device_set_polling(tz, 0);
2016 device_remove_file(&tz->device, &dev_attr_type);
2017 device_remove_file(&tz->device, &dev_attr_temp);
2018 if (tz->ops->get_mode)
2019 device_remove_file(&tz->device, &dev_attr_mode);
2020 device_remove_file(&tz->device, &dev_attr_policy);
2021 device_remove_file(&tz->device, &dev_attr_available_policies);
2022 remove_trip_attrs(tz);
2023 thermal_set_governor(tz, NULL);
2025 thermal_remove_hwmon_sysfs(tz);
2026 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
2027 idr_destroy(&tz->idr);
2028 mutex_destroy(&tz->lock);
2029 device_unregister(&tz->device);
2032 EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
2035 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
2036 * @name: thermal zone name to fetch the temperature
2038 * When only one zone is found with the passed name, returns a reference to it.
2040 * Return: On success returns a reference to an unique thermal zone with
2041 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
2042 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
2044 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
2046 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
2047 unsigned int found = 0;
2052 mutex_lock(&thermal_list_lock);
2053 list_for_each_entry(pos, &thermal_tz_list, node)
2054 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
2058 mutex_unlock(&thermal_list_lock);
2060 /* nothing has been found, thus an error code for it */
2062 ref = ERR_PTR(-ENODEV);
2064 /* Success only when an unique zone is found */
2065 ref = ERR_PTR(-EEXIST);
2070 EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
2073 static const struct genl_multicast_group thermal_event_mcgrps[] = {
2074 { .name = THERMAL_GENL_MCAST_GROUP_NAME, },
2077 static struct genl_family thermal_event_genl_family = {
2078 .id = GENL_ID_GENERATE,
2079 .name = THERMAL_GENL_FAMILY_NAME,
2080 .version = THERMAL_GENL_VERSION,
2081 .maxattr = THERMAL_GENL_ATTR_MAX,
2082 .mcgrps = thermal_event_mcgrps,
2083 .n_mcgrps = ARRAY_SIZE(thermal_event_mcgrps),
2086 int thermal_generate_netlink_event(struct thermal_zone_device *tz,
2089 struct sk_buff *skb;
2090 struct nlattr *attr;
2091 struct thermal_genl_event *thermal_event;
2095 static unsigned int thermal_event_seqnum;
2100 /* allocate memory */
2101 size = nla_total_size(sizeof(struct thermal_genl_event)) +
2104 skb = genlmsg_new(size, GFP_ATOMIC);
2108 /* add the genetlink message header */
2109 msg_header = genlmsg_put(skb, 0, thermal_event_seqnum++,
2110 &thermal_event_genl_family, 0,
2111 THERMAL_GENL_CMD_EVENT);
2118 attr = nla_reserve(skb, THERMAL_GENL_ATTR_EVENT,
2119 sizeof(struct thermal_genl_event));
2126 thermal_event = nla_data(attr);
2127 if (!thermal_event) {
2132 memset(thermal_event, 0, sizeof(struct thermal_genl_event));
2134 thermal_event->orig = tz->id;
2135 thermal_event->event = event;
2137 /* send multicast genetlink message */
2138 genlmsg_end(skb, msg_header);
2140 result = genlmsg_multicast(&thermal_event_genl_family, skb, 0,
2143 dev_err(&tz->device, "Failed to send netlink event:%d", result);
2147 EXPORT_SYMBOL_GPL(thermal_generate_netlink_event);
2149 static int genetlink_init(void)
2151 return genl_register_family(&thermal_event_genl_family);
2154 static void genetlink_exit(void)
2156 genl_unregister_family(&thermal_event_genl_family);
2158 #else /* !CONFIG_NET */
2159 static inline int genetlink_init(void) { return 0; }
2160 static inline void genetlink_exit(void) {}
2161 #endif /* !CONFIG_NET */
2163 static int __init thermal_register_governors(void)
2167 result = thermal_gov_step_wise_register();
2171 result = thermal_gov_fair_share_register();
2175 result = thermal_gov_bang_bang_register();
2179 result = thermal_gov_user_space_register();
2183 return thermal_gov_power_allocator_register();
2186 static void thermal_unregister_governors(void)
2188 thermal_gov_step_wise_unregister();
2189 thermal_gov_fair_share_unregister();
2190 thermal_gov_bang_bang_unregister();
2191 thermal_gov_user_space_unregister();
2192 thermal_gov_power_allocator_unregister();
2195 static int thermal_pm_notify(struct notifier_block *nb,
2196 unsigned long mode, void *_unused)
2198 struct thermal_zone_device *tz;
2201 case PM_HIBERNATION_PREPARE:
2202 case PM_RESTORE_PREPARE:
2203 case PM_SUSPEND_PREPARE:
2204 atomic_set(&in_suspend, 1);
2206 case PM_POST_HIBERNATION:
2207 case PM_POST_RESTORE:
2208 case PM_POST_SUSPEND:
2209 atomic_set(&in_suspend, 0);
2210 list_for_each_entry(tz, &thermal_tz_list, node) {
2211 thermal_zone_device_reset(tz);
2212 thermal_zone_device_update(tz);
2221 static struct notifier_block thermal_pm_nb = {
2222 .notifier_call = thermal_pm_notify,
2225 static int __init thermal_init(void)
2229 result = thermal_register_governors();
2233 result = class_register(&thermal_class);
2235 goto unregister_governors;
2237 result = genetlink_init();
2239 goto unregister_class;
2241 result = of_parse_thermal_zones();
2245 result = register_pm_notifier(&thermal_pm_nb);
2247 pr_warn("Thermal: Can not register suspend notifier, return %d\n",
2255 class_unregister(&thermal_class);
2256 unregister_governors:
2257 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);
2267 static void __exit thermal_exit(void)
2269 unregister_pm_notifier(&thermal_pm_nb);
2270 of_thermal_destroy_zones();
2272 class_unregister(&thermal_class);
2273 thermal_unregister_governors();
2274 idr_destroy(&thermal_tz_idr);
2275 idr_destroy(&thermal_cdev_idr);
2276 mutex_destroy(&thermal_idr_lock);
2277 mutex_destroy(&thermal_list_lock);
2278 mutex_destroy(&thermal_governor_lock);
2281 fs_initcall(thermal_init);
2282 module_exit(thermal_exit);