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 void thermal_zone_set_trips(struct thermal_zone_device *tz)
527 int trip_temp, hysteresis;
530 mutex_lock(&tz->lock);
532 if (!tz->ops->set_trips || !tz->ops->get_trip_hyst)
535 for (i = 0; i < tz->trips; i++) {
538 tz->ops->get_trip_temp(tz, i, &trip_temp);
539 tz->ops->get_trip_hyst(tz, i, &hysteresis);
541 trip_low = trip_temp - hysteresis;
543 if (trip_low < tz->temperature && trip_low > low)
546 if (trip_temp > tz->temperature && trip_temp < high)
550 /* No need to change trip points */
551 if (tz->prev_low_trip == low && tz->prev_high_trip == high)
554 tz->prev_low_trip = low;
555 tz->prev_high_trip = high;
558 "new temperature boundaries: %d < x < %d\n", low, high);
561 * Set a temperature window. When this window is left the driver
562 * must inform the thermal core via thermal_zone_device_update.
564 ret = tz->ops->set_trips(tz, low, high);
566 dev_err(&tz->device, "Failed to set trips: %d\n", ret);
569 mutex_unlock(&tz->lock);
571 EXPORT_SYMBOL_GPL(thermal_zone_set_trips);
573 static void update_temperature(struct thermal_zone_device *tz)
577 ret = thermal_zone_get_temp(tz, &temp);
580 dev_warn(&tz->device,
581 "failed to read out thermal zone (%d)\n",
586 mutex_lock(&tz->lock);
587 tz->last_temperature = tz->temperature;
588 tz->temperature = temp;
589 mutex_unlock(&tz->lock);
591 trace_thermal_temperature(tz);
592 if (tz->last_temperature == THERMAL_TEMP_INVALID)
593 dev_dbg(&tz->device, "last_temperature N/A, current_temperature=%d\n",
596 dev_dbg(&tz->device, "last_temperature=%d, current_temperature=%d\n",
597 tz->last_temperature, tz->temperature);
600 static void thermal_zone_device_init(struct thermal_zone_device *tz)
602 struct thermal_instance *pos;
603 tz->temperature = THERMAL_TEMP_INVALID;
604 tz->prev_low_trip = -INT_MAX;
605 tz->prev_high_trip = INT_MAX;
606 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
607 pos->initialized = false;
610 static void thermal_zone_device_reset(struct thermal_zone_device *tz)
613 thermal_zone_device_init(tz);
616 void thermal_zone_device_update(struct thermal_zone_device *tz,
617 enum thermal_notify_event event)
621 if (atomic_read(&in_suspend))
624 if (!tz->ops->get_temp)
627 update_temperature(tz);
629 thermal_zone_set_trips(tz);
631 tz->notify_event = event;
633 for (count = 0; count < tz->trips; count++)
634 handle_thermal_trip(tz, count);
636 EXPORT_SYMBOL_GPL(thermal_zone_device_update);
638 static void thermal_zone_device_check(struct work_struct *work)
640 struct thermal_zone_device *tz = container_of(work, struct
643 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
646 /* sys I/F for thermal zone */
648 #define to_thermal_zone(_dev) \
649 container_of(_dev, struct thermal_zone_device, device)
652 type_show(struct device *dev, struct device_attribute *attr, char *buf)
654 struct thermal_zone_device *tz = to_thermal_zone(dev);
656 return sprintf(buf, "%s\n", tz->type);
660 temp_show(struct device *dev, struct device_attribute *attr, char *buf)
662 struct thermal_zone_device *tz = to_thermal_zone(dev);
663 int temperature, ret;
665 ret = thermal_zone_get_temp(tz, &temperature);
670 return sprintf(buf, "%d\n", temperature);
674 mode_show(struct device *dev, struct device_attribute *attr, char *buf)
676 struct thermal_zone_device *tz = to_thermal_zone(dev);
677 enum thermal_device_mode mode;
680 if (!tz->ops->get_mode)
683 result = tz->ops->get_mode(tz, &mode);
687 return sprintf(buf, "%s\n", mode == THERMAL_DEVICE_ENABLED ? "enabled"
692 mode_store(struct device *dev, struct device_attribute *attr,
693 const char *buf, size_t count)
695 struct thermal_zone_device *tz = to_thermal_zone(dev);
698 if (!tz->ops->set_mode)
701 if (!strncmp(buf, "enabled", sizeof("enabled") - 1))
702 result = tz->ops->set_mode(tz, THERMAL_DEVICE_ENABLED);
703 else if (!strncmp(buf, "disabled", sizeof("disabled") - 1))
704 result = tz->ops->set_mode(tz, THERMAL_DEVICE_DISABLED);
715 trip_point_type_show(struct device *dev, struct device_attribute *attr,
718 struct thermal_zone_device *tz = to_thermal_zone(dev);
719 enum thermal_trip_type type;
722 if (!tz->ops->get_trip_type)
725 if (!sscanf(attr->attr.name, "trip_point_%d_type", &trip))
728 result = tz->ops->get_trip_type(tz, trip, &type);
733 case THERMAL_TRIP_CRITICAL:
734 return sprintf(buf, "critical\n");
735 case THERMAL_TRIP_HOT:
736 return sprintf(buf, "hot\n");
737 case THERMAL_TRIP_PASSIVE:
738 return sprintf(buf, "passive\n");
739 case THERMAL_TRIP_ACTIVE:
740 return sprintf(buf, "active\n");
742 return sprintf(buf, "unknown\n");
747 trip_point_temp_store(struct device *dev, struct device_attribute *attr,
748 const char *buf, size_t count)
750 struct thermal_zone_device *tz = to_thermal_zone(dev);
754 if (!tz->ops->set_trip_temp)
757 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
760 if (kstrtoint(buf, 10, &temperature))
763 ret = tz->ops->set_trip_temp(tz, trip, temperature);
767 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
773 trip_point_temp_show(struct device *dev, struct device_attribute *attr,
776 struct thermal_zone_device *tz = to_thermal_zone(dev);
780 if (!tz->ops->get_trip_temp)
783 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
786 ret = tz->ops->get_trip_temp(tz, trip, &temperature);
791 return sprintf(buf, "%d\n", temperature);
795 trip_point_hyst_store(struct device *dev, struct device_attribute *attr,
796 const char *buf, size_t count)
798 struct thermal_zone_device *tz = to_thermal_zone(dev);
802 if (!tz->ops->set_trip_hyst)
805 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
808 if (kstrtoint(buf, 10, &temperature))
812 * We are not doing any check on the 'temperature' value
813 * here. The driver implementing 'set_trip_hyst' has to
816 ret = tz->ops->set_trip_hyst(tz, trip, temperature);
819 thermal_zone_set_trips(tz);
821 return ret ? ret : count;
825 trip_point_hyst_show(struct device *dev, struct device_attribute *attr,
828 struct thermal_zone_device *tz = to_thermal_zone(dev);
832 if (!tz->ops->get_trip_hyst)
835 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
838 ret = tz->ops->get_trip_hyst(tz, trip, &temperature);
840 return ret ? ret : sprintf(buf, "%d\n", temperature);
844 passive_store(struct device *dev, struct device_attribute *attr,
845 const char *buf, size_t count)
847 struct thermal_zone_device *tz = to_thermal_zone(dev);
848 struct thermal_cooling_device *cdev = NULL;
851 if (!sscanf(buf, "%d\n", &state))
854 /* sanity check: values below 1000 millicelcius don't make sense
855 * and can cause the system to go into a thermal heart attack
857 if (state && state < 1000)
860 if (state && !tz->forced_passive) {
861 mutex_lock(&thermal_list_lock);
862 list_for_each_entry(cdev, &thermal_cdev_list, node) {
863 if (!strncmp("Processor", cdev->type,
864 sizeof("Processor")))
865 thermal_zone_bind_cooling_device(tz,
866 THERMAL_TRIPS_NONE, cdev,
869 THERMAL_WEIGHT_DEFAULT);
871 mutex_unlock(&thermal_list_lock);
872 if (!tz->passive_delay)
873 tz->passive_delay = 1000;
874 } else if (!state && tz->forced_passive) {
875 mutex_lock(&thermal_list_lock);
876 list_for_each_entry(cdev, &thermal_cdev_list, node) {
877 if (!strncmp("Processor", cdev->type,
878 sizeof("Processor")))
879 thermal_zone_unbind_cooling_device(tz,
883 mutex_unlock(&thermal_list_lock);
884 tz->passive_delay = 0;
887 tz->forced_passive = state;
889 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
895 passive_show(struct device *dev, struct device_attribute *attr,
898 struct thermal_zone_device *tz = to_thermal_zone(dev);
900 return sprintf(buf, "%d\n", tz->forced_passive);
904 policy_store(struct device *dev, struct device_attribute *attr,
905 const char *buf, size_t count)
908 struct thermal_zone_device *tz = to_thermal_zone(dev);
909 struct thermal_governor *gov;
910 char name[THERMAL_NAME_LENGTH];
912 snprintf(name, sizeof(name), "%s", buf);
914 mutex_lock(&thermal_governor_lock);
915 mutex_lock(&tz->lock);
917 gov = __find_governor(strim(name));
921 ret = thermal_set_governor(tz, gov);
926 mutex_unlock(&tz->lock);
927 mutex_unlock(&thermal_governor_lock);
932 policy_show(struct device *dev, struct device_attribute *devattr, char *buf)
934 struct thermal_zone_device *tz = to_thermal_zone(dev);
936 return sprintf(buf, "%s\n", tz->governor->name);
940 available_policies_show(struct device *dev, struct device_attribute *devattr,
943 struct thermal_governor *pos;
945 ssize_t size = PAGE_SIZE;
947 mutex_lock(&thermal_governor_lock);
949 list_for_each_entry(pos, &thermal_governor_list, governor_list) {
950 size = PAGE_SIZE - count;
951 count += scnprintf(buf + count, size, "%s ", pos->name);
953 count += scnprintf(buf + count, size, "\n");
955 mutex_unlock(&thermal_governor_lock);
961 emul_temp_store(struct device *dev, struct device_attribute *attr,
962 const char *buf, size_t count)
964 struct thermal_zone_device *tz = to_thermal_zone(dev);
968 if (kstrtoint(buf, 10, &temperature))
971 if (!tz->ops->set_emul_temp) {
972 mutex_lock(&tz->lock);
973 tz->emul_temperature = temperature;
974 mutex_unlock(&tz->lock);
976 ret = tz->ops->set_emul_temp(tz, temperature);
980 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
982 return ret ? ret : count;
984 static DEVICE_ATTR(emul_temp, S_IWUSR, NULL, emul_temp_store);
987 sustainable_power_show(struct device *dev, struct device_attribute *devattr,
990 struct thermal_zone_device *tz = to_thermal_zone(dev);
993 return sprintf(buf, "%u\n", tz->tzp->sustainable_power);
999 sustainable_power_store(struct device *dev, struct device_attribute *devattr,
1000 const char *buf, size_t count)
1002 struct thermal_zone_device *tz = to_thermal_zone(dev);
1003 u32 sustainable_power;
1008 if (kstrtou32(buf, 10, &sustainable_power))
1011 tz->tzp->sustainable_power = sustainable_power;
1015 static DEVICE_ATTR(sustainable_power, S_IWUSR | S_IRUGO, sustainable_power_show,
1016 sustainable_power_store);
1018 #define create_s32_tzp_attr(name) \
1020 name##_show(struct device *dev, struct device_attribute *devattr, \
1023 struct thermal_zone_device *tz = to_thermal_zone(dev); \
1026 return sprintf(buf, "%d\n", tz->tzp->name); \
1032 name##_store(struct device *dev, struct device_attribute *devattr, \
1033 const char *buf, size_t count) \
1035 struct thermal_zone_device *tz = to_thermal_zone(dev); \
1041 if (kstrtos32(buf, 10, &value)) \
1044 tz->tzp->name = value; \
1048 static DEVICE_ATTR(name, S_IWUSR | S_IRUGO, name##_show, name##_store)
1050 create_s32_tzp_attr(k_po);
1051 create_s32_tzp_attr(k_pu);
1052 create_s32_tzp_attr(k_i);
1053 create_s32_tzp_attr(k_d);
1054 create_s32_tzp_attr(integral_cutoff);
1055 create_s32_tzp_attr(slope);
1056 create_s32_tzp_attr(offset);
1057 #undef create_s32_tzp_attr
1059 static struct device_attribute *dev_tzp_attrs[] = {
1060 &dev_attr_sustainable_power,
1065 &dev_attr_integral_cutoff,
1070 static int create_tzp_attrs(struct device *dev)
1074 for (i = 0; i < ARRAY_SIZE(dev_tzp_attrs); i++) {
1076 struct device_attribute *dev_attr = dev_tzp_attrs[i];
1078 ret = device_create_file(dev, dev_attr);
1087 * power_actor_get_max_power() - get the maximum power that a cdev can consume
1088 * @cdev: pointer to &thermal_cooling_device
1089 * @tz: a valid thermal zone device pointer
1090 * @max_power: pointer in which to store the maximum power
1092 * Calculate the maximum power consumption in milliwats that the
1093 * cooling device can currently consume and store it in @max_power.
1095 * Return: 0 on success, -EINVAL if @cdev doesn't support the
1096 * power_actor API or -E* on other error.
1098 int power_actor_get_max_power(struct thermal_cooling_device *cdev,
1099 struct thermal_zone_device *tz, u32 *max_power)
1101 if (!cdev_is_power_actor(cdev))
1104 return cdev->ops->state2power(cdev, tz, 0, max_power);
1108 * power_actor_get_min_power() - get the mainimum power that a cdev can consume
1109 * @cdev: pointer to &thermal_cooling_device
1110 * @tz: a valid thermal zone device pointer
1111 * @min_power: pointer in which to store the minimum power
1113 * Calculate the minimum power consumption in milliwatts that the
1114 * cooling device can currently consume and store it in @min_power.
1116 * Return: 0 on success, -EINVAL if @cdev doesn't support the
1117 * power_actor API or -E* on other error.
1119 int power_actor_get_min_power(struct thermal_cooling_device *cdev,
1120 struct thermal_zone_device *tz, u32 *min_power)
1122 unsigned long max_state;
1125 if (!cdev_is_power_actor(cdev))
1128 ret = cdev->ops->get_max_state(cdev, &max_state);
1132 return cdev->ops->state2power(cdev, tz, max_state, min_power);
1136 * power_actor_set_power() - limit the maximum power that a cooling device can consume
1137 * @cdev: pointer to &thermal_cooling_device
1138 * @instance: thermal instance to update
1139 * @power: the power in milliwatts
1141 * Set the cooling device to consume at most @power milliwatts.
1143 * Return: 0 on success, -EINVAL if the cooling device does not
1144 * implement the power actor API or -E* for other failures.
1146 int power_actor_set_power(struct thermal_cooling_device *cdev,
1147 struct thermal_instance *instance, u32 power)
1149 unsigned long state;
1152 if (!cdev_is_power_actor(cdev))
1155 ret = cdev->ops->power2state(cdev, instance->tz, power, &state);
1159 instance->target = state;
1160 mutex_lock(&cdev->lock);
1161 cdev->updated = false;
1162 mutex_unlock(&cdev->lock);
1163 thermal_cdev_update(cdev);
1168 static DEVICE_ATTR(type, 0444, type_show, NULL);
1169 static DEVICE_ATTR(temp, 0444, temp_show, NULL);
1170 static DEVICE_ATTR(mode, 0644, mode_show, mode_store);
1171 static DEVICE_ATTR(passive, S_IRUGO | S_IWUSR, passive_show, passive_store);
1172 static DEVICE_ATTR(policy, S_IRUGO | S_IWUSR, policy_show, policy_store);
1173 static DEVICE_ATTR(available_policies, S_IRUGO, available_policies_show, NULL);
1175 /* sys I/F for cooling device */
1176 #define to_cooling_device(_dev) \
1177 container_of(_dev, struct thermal_cooling_device, device)
1180 thermal_cooling_device_type_show(struct device *dev,
1181 struct device_attribute *attr, char *buf)
1183 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1185 return sprintf(buf, "%s\n", cdev->type);
1189 thermal_cooling_device_max_state_show(struct device *dev,
1190 struct device_attribute *attr, char *buf)
1192 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1193 unsigned long state;
1196 ret = cdev->ops->get_max_state(cdev, &state);
1199 return sprintf(buf, "%ld\n", state);
1203 thermal_cooling_device_cur_state_show(struct device *dev,
1204 struct device_attribute *attr, char *buf)
1206 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1207 unsigned long state;
1210 ret = cdev->ops->get_cur_state(cdev, &state);
1213 return sprintf(buf, "%ld\n", state);
1217 thermal_cooling_device_cur_state_store(struct device *dev,
1218 struct device_attribute *attr,
1219 const char *buf, size_t count)
1221 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1222 unsigned long state;
1225 if (!sscanf(buf, "%ld\n", &state))
1228 if ((long)state < 0)
1231 result = cdev->ops->set_cur_state(cdev, state);
1237 static struct device_attribute dev_attr_cdev_type =
1238 __ATTR(type, 0444, thermal_cooling_device_type_show, NULL);
1239 static DEVICE_ATTR(max_state, 0444,
1240 thermal_cooling_device_max_state_show, NULL);
1241 static DEVICE_ATTR(cur_state, 0644,
1242 thermal_cooling_device_cur_state_show,
1243 thermal_cooling_device_cur_state_store);
1246 thermal_cooling_device_trip_point_show(struct device *dev,
1247 struct device_attribute *attr, char *buf)
1249 struct thermal_instance *instance;
1252 container_of(attr, struct thermal_instance, attr);
1254 if (instance->trip == THERMAL_TRIPS_NONE)
1255 return sprintf(buf, "-1\n");
1257 return sprintf(buf, "%d\n", instance->trip);
1260 static struct attribute *cooling_device_attrs[] = {
1261 &dev_attr_cdev_type.attr,
1262 &dev_attr_max_state.attr,
1263 &dev_attr_cur_state.attr,
1267 static const struct attribute_group cooling_device_attr_group = {
1268 .attrs = cooling_device_attrs,
1271 static const struct attribute_group *cooling_device_attr_groups[] = {
1272 &cooling_device_attr_group,
1277 thermal_cooling_device_weight_show(struct device *dev,
1278 struct device_attribute *attr, char *buf)
1280 struct thermal_instance *instance;
1282 instance = container_of(attr, struct thermal_instance, weight_attr);
1284 return sprintf(buf, "%d\n", instance->weight);
1288 thermal_cooling_device_weight_store(struct device *dev,
1289 struct device_attribute *attr,
1290 const char *buf, size_t count)
1292 struct thermal_instance *instance;
1295 ret = kstrtoint(buf, 0, &weight);
1299 instance = container_of(attr, struct thermal_instance, weight_attr);
1300 instance->weight = weight;
1304 /* Device management */
1307 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
1308 * @tz: pointer to struct thermal_zone_device
1309 * @trip: indicates which trip point the cooling devices is
1310 * associated with in this thermal zone.
1311 * @cdev: pointer to struct thermal_cooling_device
1312 * @upper: the Maximum cooling state for this trip point.
1313 * THERMAL_NO_LIMIT means no upper limit,
1314 * and the cooling device can be in max_state.
1315 * @lower: the Minimum cooling state can be used for this trip point.
1316 * THERMAL_NO_LIMIT means no lower limit,
1317 * and the cooling device can be in cooling state 0.
1318 * @weight: The weight of the cooling device to be bound to the
1319 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
1322 * This interface function bind a thermal cooling device to the certain trip
1323 * point of a thermal zone device.
1324 * This function is usually called in the thermal zone device .bind callback.
1326 * Return: 0 on success, the proper error value otherwise.
1328 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
1330 struct thermal_cooling_device *cdev,
1331 unsigned long upper, unsigned long lower,
1332 unsigned int weight)
1334 struct thermal_instance *dev;
1335 struct thermal_instance *pos;
1336 struct thermal_zone_device *pos1;
1337 struct thermal_cooling_device *pos2;
1338 unsigned long max_state;
1341 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
1344 list_for_each_entry(pos1, &thermal_tz_list, node) {
1348 list_for_each_entry(pos2, &thermal_cdev_list, node) {
1353 if (tz != pos1 || cdev != pos2)
1356 ret = cdev->ops->get_max_state(cdev, &max_state);
1360 /* lower default 0, upper default max_state */
1361 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
1362 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
1364 if (lower > upper || upper > max_state)
1368 kzalloc(sizeof(struct thermal_instance), GFP_KERNEL);
1376 dev->target = THERMAL_NO_TARGET;
1377 dev->weight = weight;
1379 result = get_idr(&tz->idr, &tz->lock, &dev->id);
1383 sprintf(dev->name, "cdev%d", dev->id);
1385 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
1389 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
1390 sysfs_attr_init(&dev->attr.attr);
1391 dev->attr.attr.name = dev->attr_name;
1392 dev->attr.attr.mode = 0444;
1393 dev->attr.show = thermal_cooling_device_trip_point_show;
1394 result = device_create_file(&tz->device, &dev->attr);
1396 goto remove_symbol_link;
1398 sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
1399 sysfs_attr_init(&dev->weight_attr.attr);
1400 dev->weight_attr.attr.name = dev->weight_attr_name;
1401 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
1402 dev->weight_attr.show = thermal_cooling_device_weight_show;
1403 dev->weight_attr.store = thermal_cooling_device_weight_store;
1404 result = device_create_file(&tz->device, &dev->weight_attr);
1406 goto remove_trip_file;
1408 mutex_lock(&tz->lock);
1409 mutex_lock(&cdev->lock);
1410 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
1411 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1416 list_add_tail(&dev->tz_node, &tz->thermal_instances);
1417 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
1418 atomic_set(&tz->need_update, 1);
1420 mutex_unlock(&cdev->lock);
1421 mutex_unlock(&tz->lock);
1426 device_remove_file(&tz->device, &dev->weight_attr);
1428 device_remove_file(&tz->device, &dev->attr);
1430 sysfs_remove_link(&tz->device.kobj, dev->name);
1432 release_idr(&tz->idr, &tz->lock, dev->id);
1437 EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
1440 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
1442 * @tz: pointer to a struct thermal_zone_device.
1443 * @trip: indicates which trip point the cooling devices is
1444 * associated with in this thermal zone.
1445 * @cdev: pointer to a struct thermal_cooling_device.
1447 * This interface function unbind a thermal cooling device from the certain
1448 * trip point of a thermal zone device.
1449 * This function is usually called in the thermal zone device .unbind callback.
1451 * Return: 0 on success, the proper error value otherwise.
1453 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
1455 struct thermal_cooling_device *cdev)
1457 struct thermal_instance *pos, *next;
1459 mutex_lock(&tz->lock);
1460 mutex_lock(&cdev->lock);
1461 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
1462 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1463 list_del(&pos->tz_node);
1464 list_del(&pos->cdev_node);
1465 mutex_unlock(&cdev->lock);
1466 mutex_unlock(&tz->lock);
1470 mutex_unlock(&cdev->lock);
1471 mutex_unlock(&tz->lock);
1476 device_remove_file(&tz->device, &pos->weight_attr);
1477 device_remove_file(&tz->device, &pos->attr);
1478 sysfs_remove_link(&tz->device.kobj, pos->name);
1479 release_idr(&tz->idr, &tz->lock, pos->id);
1483 EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
1485 static void thermal_release(struct device *dev)
1487 struct thermal_zone_device *tz;
1488 struct thermal_cooling_device *cdev;
1490 if (!strncmp(dev_name(dev), "thermal_zone",
1491 sizeof("thermal_zone") - 1)) {
1492 tz = to_thermal_zone(dev);
1494 } else if(!strncmp(dev_name(dev), "cooling_device",
1495 sizeof("cooling_device") - 1)){
1496 cdev = to_cooling_device(dev);
1501 static struct class thermal_class = {
1503 .dev_release = thermal_release,
1507 * __thermal_cooling_device_register() - register a new thermal cooling device
1508 * @np: a pointer to a device tree node.
1509 * @type: the thermal cooling device type.
1510 * @devdata: device private data.
1511 * @ops: standard thermal cooling devices callbacks.
1513 * This interface function adds a new thermal cooling device (fan/processor/...)
1514 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1515 * to all the thermal zone devices registered at the same time.
1516 * It also gives the opportunity to link the cooling device to a device tree
1517 * node, so that it can be bound to a thermal zone created out of device tree.
1519 * Return: a pointer to the created struct thermal_cooling_device or an
1520 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1522 static struct thermal_cooling_device *
1523 __thermal_cooling_device_register(struct device_node *np,
1524 char *type, void *devdata,
1525 const struct thermal_cooling_device_ops *ops)
1527 struct thermal_cooling_device *cdev;
1528 struct thermal_zone_device *pos = NULL;
1531 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1532 return ERR_PTR(-EINVAL);
1534 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
1535 !ops->set_cur_state)
1536 return ERR_PTR(-EINVAL);
1538 cdev = kzalloc(sizeof(struct thermal_cooling_device), GFP_KERNEL);
1540 return ERR_PTR(-ENOMEM);
1542 result = get_idr(&thermal_cdev_idr, &thermal_idr_lock, &cdev->id);
1545 return ERR_PTR(result);
1548 strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
1549 mutex_init(&cdev->lock);
1550 INIT_LIST_HEAD(&cdev->thermal_instances);
1553 cdev->updated = false;
1554 cdev->device.class = &thermal_class;
1555 cdev->device.groups = cooling_device_attr_groups;
1556 cdev->devdata = devdata;
1557 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
1558 result = device_register(&cdev->device);
1560 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1562 return ERR_PTR(result);
1565 /* Add 'this' new cdev to the global cdev list */
1566 mutex_lock(&thermal_list_lock);
1567 list_add(&cdev->node, &thermal_cdev_list);
1568 mutex_unlock(&thermal_list_lock);
1570 /* Update binding information for 'this' new cdev */
1573 mutex_lock(&thermal_list_lock);
1574 list_for_each_entry(pos, &thermal_tz_list, node)
1575 if (atomic_cmpxchg(&pos->need_update, 1, 0))
1576 thermal_zone_device_update(pos,
1577 THERMAL_EVENT_UNSPECIFIED);
1578 mutex_unlock(&thermal_list_lock);
1584 * thermal_cooling_device_register() - register a new thermal cooling device
1585 * @type: the thermal cooling device type.
1586 * @devdata: device private data.
1587 * @ops: standard thermal cooling devices callbacks.
1589 * This interface function adds a new thermal cooling device (fan/processor/...)
1590 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1591 * to all the thermal zone devices registered at the same time.
1593 * Return: a pointer to the created struct thermal_cooling_device or an
1594 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1596 struct thermal_cooling_device *
1597 thermal_cooling_device_register(char *type, void *devdata,
1598 const struct thermal_cooling_device_ops *ops)
1600 return __thermal_cooling_device_register(NULL, type, devdata, ops);
1602 EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
1605 * thermal_of_cooling_device_register() - register an OF thermal cooling device
1606 * @np: a pointer to a device tree node.
1607 * @type: the thermal cooling device type.
1608 * @devdata: device private data.
1609 * @ops: standard thermal cooling devices callbacks.
1611 * This function will register a cooling device with device tree node reference.
1612 * This interface function adds a new thermal cooling device (fan/processor/...)
1613 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1614 * to all the thermal zone devices registered at the same time.
1616 * Return: a pointer to the created struct thermal_cooling_device or an
1617 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1619 struct thermal_cooling_device *
1620 thermal_of_cooling_device_register(struct device_node *np,
1621 char *type, void *devdata,
1622 const struct thermal_cooling_device_ops *ops)
1624 return __thermal_cooling_device_register(np, type, devdata, ops);
1626 EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
1629 * thermal_cooling_device_unregister - removes the registered thermal cooling device
1630 * @cdev: the thermal cooling device to remove.
1632 * thermal_cooling_device_unregister() must be called when the device is no
1635 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1638 const struct thermal_zone_params *tzp;
1639 struct thermal_zone_device *tz;
1640 struct thermal_cooling_device *pos = NULL;
1645 mutex_lock(&thermal_list_lock);
1646 list_for_each_entry(pos, &thermal_cdev_list, node)
1650 /* thermal cooling device not found */
1651 mutex_unlock(&thermal_list_lock);
1654 list_del(&cdev->node);
1656 /* Unbind all thermal zones associated with 'this' cdev */
1657 list_for_each_entry(tz, &thermal_tz_list, node) {
1658 if (tz->ops->unbind) {
1659 tz->ops->unbind(tz, cdev);
1663 if (!tz->tzp || !tz->tzp->tbp)
1667 for (i = 0; i < tzp->num_tbps; i++) {
1668 if (tzp->tbp[i].cdev == cdev) {
1669 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1670 tzp->tbp[i].cdev = NULL;
1675 mutex_unlock(&thermal_list_lock);
1678 device_remove_file(&cdev->device, &dev_attr_cdev_type);
1679 device_remove_file(&cdev->device, &dev_attr_max_state);
1680 device_remove_file(&cdev->device, &dev_attr_cur_state);
1682 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1683 device_unregister(&cdev->device);
1686 EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1688 void thermal_cdev_update(struct thermal_cooling_device *cdev)
1690 struct thermal_instance *instance;
1691 unsigned long target = 0;
1693 mutex_lock(&cdev->lock);
1694 /* cooling device is updated*/
1695 if (cdev->updated) {
1696 mutex_unlock(&cdev->lock);
1700 /* Make sure cdev enters the deepest cooling state */
1701 list_for_each_entry(instance, &cdev->thermal_instances, cdev_node) {
1702 dev_dbg(&cdev->device, "zone%d->target=%lu\n",
1703 instance->tz->id, instance->target);
1704 if (instance->target == THERMAL_NO_TARGET)
1706 if (instance->target > target)
1707 target = instance->target;
1709 cdev->ops->set_cur_state(cdev, target);
1710 cdev->updated = true;
1711 mutex_unlock(&cdev->lock);
1712 trace_cdev_update(cdev, target);
1713 dev_dbg(&cdev->device, "set to state %lu\n", target);
1715 EXPORT_SYMBOL(thermal_cdev_update);
1718 * thermal_notify_framework - Sensor drivers use this API to notify framework
1719 * @tz: thermal zone device
1720 * @trip: indicates which trip point has been crossed
1722 * This function handles the trip events from sensor drivers. It starts
1723 * throttling the cooling devices according to the policy configured.
1724 * For CRITICAL and HOT trip points, this notifies the respective drivers,
1725 * and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
1726 * The throttling policy is based on the configured platform data; if no
1727 * platform data is provided, this uses the step_wise throttling policy.
1729 void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
1731 handle_thermal_trip(tz, trip);
1733 EXPORT_SYMBOL_GPL(thermal_notify_framework);
1736 * create_trip_attrs() - create attributes for trip points
1737 * @tz: the thermal zone device
1738 * @mask: Writeable trip point bitmap.
1740 * helper function to instantiate sysfs entries for every trip
1741 * point and its properties of a struct thermal_zone_device.
1743 * Return: 0 on success, the proper error value otherwise.
1745 static int create_trip_attrs(struct thermal_zone_device *tz, int mask)
1748 int size = sizeof(struct thermal_attr) * tz->trips;
1750 tz->trip_type_attrs = kzalloc(size, GFP_KERNEL);
1751 if (!tz->trip_type_attrs)
1754 tz->trip_temp_attrs = kzalloc(size, GFP_KERNEL);
1755 if (!tz->trip_temp_attrs) {
1756 kfree(tz->trip_type_attrs);
1760 if (tz->ops->get_trip_hyst) {
1761 tz->trip_hyst_attrs = kzalloc(size, GFP_KERNEL);
1762 if (!tz->trip_hyst_attrs) {
1763 kfree(tz->trip_type_attrs);
1764 kfree(tz->trip_temp_attrs);
1770 for (indx = 0; indx < tz->trips; indx++) {
1771 /* create trip type attribute */
1772 snprintf(tz->trip_type_attrs[indx].name, THERMAL_NAME_LENGTH,
1773 "trip_point_%d_type", indx);
1775 sysfs_attr_init(&tz->trip_type_attrs[indx].attr.attr);
1776 tz->trip_type_attrs[indx].attr.attr.name =
1777 tz->trip_type_attrs[indx].name;
1778 tz->trip_type_attrs[indx].attr.attr.mode = S_IRUGO;
1779 tz->trip_type_attrs[indx].attr.show = trip_point_type_show;
1781 device_create_file(&tz->device,
1782 &tz->trip_type_attrs[indx].attr);
1784 /* create trip temp attribute */
1785 snprintf(tz->trip_temp_attrs[indx].name, THERMAL_NAME_LENGTH,
1786 "trip_point_%d_temp", indx);
1788 sysfs_attr_init(&tz->trip_temp_attrs[indx].attr.attr);
1789 tz->trip_temp_attrs[indx].attr.attr.name =
1790 tz->trip_temp_attrs[indx].name;
1791 tz->trip_temp_attrs[indx].attr.attr.mode = S_IRUGO;
1792 tz->trip_temp_attrs[indx].attr.show = trip_point_temp_show;
1793 if (IS_ENABLED(CONFIG_THERMAL_WRITABLE_TRIPS) &&
1794 mask & (1 << indx)) {
1795 tz->trip_temp_attrs[indx].attr.attr.mode |= S_IWUSR;
1796 tz->trip_temp_attrs[indx].attr.store =
1797 trip_point_temp_store;
1800 device_create_file(&tz->device,
1801 &tz->trip_temp_attrs[indx].attr);
1803 /* create Optional trip hyst attribute */
1804 if (!tz->ops->get_trip_hyst)
1806 snprintf(tz->trip_hyst_attrs[indx].name, THERMAL_NAME_LENGTH,
1807 "trip_point_%d_hyst", indx);
1809 sysfs_attr_init(&tz->trip_hyst_attrs[indx].attr.attr);
1810 tz->trip_hyst_attrs[indx].attr.attr.name =
1811 tz->trip_hyst_attrs[indx].name;
1812 tz->trip_hyst_attrs[indx].attr.attr.mode = S_IRUGO;
1813 tz->trip_hyst_attrs[indx].attr.show = trip_point_hyst_show;
1814 if (tz->ops->set_trip_hyst) {
1815 tz->trip_hyst_attrs[indx].attr.attr.mode |= S_IWUSR;
1816 tz->trip_hyst_attrs[indx].attr.store =
1817 trip_point_hyst_store;
1820 device_create_file(&tz->device,
1821 &tz->trip_hyst_attrs[indx].attr);
1826 static void remove_trip_attrs(struct thermal_zone_device *tz)
1830 for (indx = 0; indx < tz->trips; indx++) {
1831 device_remove_file(&tz->device,
1832 &tz->trip_type_attrs[indx].attr);
1833 device_remove_file(&tz->device,
1834 &tz->trip_temp_attrs[indx].attr);
1835 if (tz->ops->get_trip_hyst)
1836 device_remove_file(&tz->device,
1837 &tz->trip_hyst_attrs[indx].attr);
1839 kfree(tz->trip_type_attrs);
1840 kfree(tz->trip_temp_attrs);
1841 kfree(tz->trip_hyst_attrs);
1845 * thermal_zone_device_register() - register a new thermal zone device
1846 * @type: the thermal zone device type
1847 * @trips: the number of trip points the thermal zone support
1848 * @mask: a bit string indicating the writeablility of trip points
1849 * @devdata: private device data
1850 * @ops: standard thermal zone device callbacks
1851 * @tzp: thermal zone platform parameters
1852 * @passive_delay: number of milliseconds to wait between polls when
1853 * performing passive cooling
1854 * @polling_delay: number of milliseconds to wait between polls when checking
1855 * whether trip points have been crossed (0 for interrupt
1858 * This interface function adds a new thermal zone device (sensor) to
1859 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1860 * thermal cooling devices registered at the same time.
1861 * thermal_zone_device_unregister() must be called when the device is no
1862 * longer needed. The passive cooling depends on the .get_trend() return value.
1864 * Return: a pointer to the created struct thermal_zone_device or an
1865 * in case of error, an ERR_PTR. Caller must check return value with
1866 * IS_ERR*() helpers.
1868 struct thermal_zone_device *thermal_zone_device_register(const char *type,
1869 int trips, int mask, void *devdata,
1870 struct thermal_zone_device_ops *ops,
1871 struct thermal_zone_params *tzp,
1872 int passive_delay, int polling_delay)
1874 struct thermal_zone_device *tz;
1875 enum thermal_trip_type trip_type;
1880 struct thermal_governor *governor;
1882 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1883 return ERR_PTR(-EINVAL);
1885 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
1886 return ERR_PTR(-EINVAL);
1889 return ERR_PTR(-EINVAL);
1891 if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
1892 return ERR_PTR(-EINVAL);
1894 tz = kzalloc(sizeof(struct thermal_zone_device), GFP_KERNEL);
1896 return ERR_PTR(-ENOMEM);
1898 INIT_LIST_HEAD(&tz->thermal_instances);
1900 mutex_init(&tz->lock);
1901 result = get_idr(&thermal_tz_idr, &thermal_idr_lock, &tz->id);
1904 return ERR_PTR(result);
1907 strlcpy(tz->type, type ? : "", sizeof(tz->type));
1910 tz->device.class = &thermal_class;
1911 tz->devdata = devdata;
1913 tz->passive_delay = passive_delay;
1914 tz->polling_delay = polling_delay;
1915 /* A new thermal zone needs to be updated anyway. */
1916 atomic_set(&tz->need_update, 1);
1918 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1919 result = device_register(&tz->device);
1921 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1923 return ERR_PTR(result);
1928 result = device_create_file(&tz->device, &dev_attr_type);
1933 result = device_create_file(&tz->device, &dev_attr_temp);
1937 if (ops->get_mode) {
1938 result = device_create_file(&tz->device, &dev_attr_mode);
1943 result = create_trip_attrs(tz, mask);
1947 for (count = 0; count < trips; count++) {
1948 if (tz->ops->get_trip_type(tz, count, &trip_type))
1949 set_bit(count, &tz->trips_disabled);
1950 if (trip_type == THERMAL_TRIP_PASSIVE)
1952 if (tz->ops->get_trip_temp(tz, count, &trip_temp))
1953 set_bit(count, &tz->trips_disabled);
1954 /* Check for bogus trip points */
1956 set_bit(count, &tz->trips_disabled);
1960 result = device_create_file(&tz->device, &dev_attr_passive);
1965 if (IS_ENABLED(CONFIG_THERMAL_EMULATION)) {
1966 result = device_create_file(&tz->device, &dev_attr_emul_temp);
1971 /* Create policy attribute */
1972 result = device_create_file(&tz->device, &dev_attr_policy);
1976 /* Add thermal zone params */
1977 result = create_tzp_attrs(&tz->device);
1981 /* Create available_policies attribute */
1982 result = device_create_file(&tz->device, &dev_attr_available_policies);
1986 /* Update 'this' zone's governor information */
1987 mutex_lock(&thermal_governor_lock);
1990 governor = __find_governor(tz->tzp->governor_name);
1992 governor = def_governor;
1994 result = thermal_set_governor(tz, governor);
1996 mutex_unlock(&thermal_governor_lock);
2000 mutex_unlock(&thermal_governor_lock);
2002 if (!tz->tzp || !tz->tzp->no_hwmon) {
2003 result = thermal_add_hwmon_sysfs(tz);
2008 mutex_lock(&thermal_list_lock);
2009 list_add_tail(&tz->node, &thermal_tz_list);
2010 mutex_unlock(&thermal_list_lock);
2012 /* Bind cooling devices for this zone */
2015 INIT_DELAYED_WORK(&(tz->poll_queue), thermal_zone_device_check);
2017 thermal_zone_device_reset(tz);
2018 /* Update the new thermal zone and mark it as already updated. */
2019 if (atomic_cmpxchg(&tz->need_update, 1, 0))
2020 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
2025 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
2026 device_unregister(&tz->device);
2027 return ERR_PTR(result);
2029 EXPORT_SYMBOL_GPL(thermal_zone_device_register);
2032 * thermal_zone_device_unregister - removes the registered thermal zone device
2033 * @tz: the thermal zone device to remove
2035 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
2038 const struct thermal_zone_params *tzp;
2039 struct thermal_cooling_device *cdev;
2040 struct thermal_zone_device *pos = NULL;
2047 mutex_lock(&thermal_list_lock);
2048 list_for_each_entry(pos, &thermal_tz_list, node)
2052 /* thermal zone device not found */
2053 mutex_unlock(&thermal_list_lock);
2056 list_del(&tz->node);
2058 /* Unbind all cdevs associated with 'this' thermal zone */
2059 list_for_each_entry(cdev, &thermal_cdev_list, node) {
2060 if (tz->ops->unbind) {
2061 tz->ops->unbind(tz, cdev);
2065 if (!tzp || !tzp->tbp)
2068 for (i = 0; i < tzp->num_tbps; i++) {
2069 if (tzp->tbp[i].cdev == cdev) {
2070 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
2071 tzp->tbp[i].cdev = NULL;
2076 mutex_unlock(&thermal_list_lock);
2078 cancel_delayed_work_sync(&tz->poll_queue);
2081 device_remove_file(&tz->device, &dev_attr_type);
2082 device_remove_file(&tz->device, &dev_attr_temp);
2083 if (tz->ops->get_mode)
2084 device_remove_file(&tz->device, &dev_attr_mode);
2085 device_remove_file(&tz->device, &dev_attr_policy);
2086 device_remove_file(&tz->device, &dev_attr_available_policies);
2087 remove_trip_attrs(tz);
2088 thermal_set_governor(tz, NULL);
2090 thermal_remove_hwmon_sysfs(tz);
2091 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
2092 idr_destroy(&tz->idr);
2093 mutex_destroy(&tz->lock);
2094 device_unregister(&tz->device);
2097 EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
2100 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
2101 * @name: thermal zone name to fetch the temperature
2103 * When only one zone is found with the passed name, returns a reference to it.
2105 * Return: On success returns a reference to an unique thermal zone with
2106 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
2107 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
2109 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
2111 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
2112 unsigned int found = 0;
2117 mutex_lock(&thermal_list_lock);
2118 list_for_each_entry(pos, &thermal_tz_list, node)
2119 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
2123 mutex_unlock(&thermal_list_lock);
2125 /* nothing has been found, thus an error code for it */
2127 ref = ERR_PTR(-ENODEV);
2129 /* Success only when an unique zone is found */
2130 ref = ERR_PTR(-EEXIST);
2135 EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
2138 * thermal_zone_get_slope - return the slope attribute of the thermal zone
2139 * @tz: thermal zone device with the slope attribute
2141 * Return: If the thermal zone device has a slope attribute, return it, else
2144 int thermal_zone_get_slope(struct thermal_zone_device *tz)
2147 return tz->tzp->slope;
2150 EXPORT_SYMBOL_GPL(thermal_zone_get_slope);
2153 * thermal_zone_get_offset - return the offset attribute of the thermal zone
2154 * @tz: thermal zone device with the offset attribute
2156 * Return: If the thermal zone device has a offset attribute, return it, else
2159 int thermal_zone_get_offset(struct thermal_zone_device *tz)
2162 return tz->tzp->offset;
2165 EXPORT_SYMBOL_GPL(thermal_zone_get_offset);
2168 static const struct genl_multicast_group thermal_event_mcgrps[] = {
2169 { .name = THERMAL_GENL_MCAST_GROUP_NAME, },
2172 static struct genl_family thermal_event_genl_family = {
2173 .id = GENL_ID_GENERATE,
2174 .name = THERMAL_GENL_FAMILY_NAME,
2175 .version = THERMAL_GENL_VERSION,
2176 .maxattr = THERMAL_GENL_ATTR_MAX,
2177 .mcgrps = thermal_event_mcgrps,
2178 .n_mcgrps = ARRAY_SIZE(thermal_event_mcgrps),
2181 int thermal_generate_netlink_event(struct thermal_zone_device *tz,
2184 struct sk_buff *skb;
2185 struct nlattr *attr;
2186 struct thermal_genl_event *thermal_event;
2190 static unsigned int thermal_event_seqnum;
2195 /* allocate memory */
2196 size = nla_total_size(sizeof(struct thermal_genl_event)) +
2199 skb = genlmsg_new(size, GFP_ATOMIC);
2203 /* add the genetlink message header */
2204 msg_header = genlmsg_put(skb, 0, thermal_event_seqnum++,
2205 &thermal_event_genl_family, 0,
2206 THERMAL_GENL_CMD_EVENT);
2213 attr = nla_reserve(skb, THERMAL_GENL_ATTR_EVENT,
2214 sizeof(struct thermal_genl_event));
2221 thermal_event = nla_data(attr);
2222 if (!thermal_event) {
2227 memset(thermal_event, 0, sizeof(struct thermal_genl_event));
2229 thermal_event->orig = tz->id;
2230 thermal_event->event = event;
2232 /* send multicast genetlink message */
2233 genlmsg_end(skb, msg_header);
2235 result = genlmsg_multicast(&thermal_event_genl_family, skb, 0,
2238 dev_err(&tz->device, "Failed to send netlink event:%d", result);
2242 EXPORT_SYMBOL_GPL(thermal_generate_netlink_event);
2244 static int genetlink_init(void)
2246 return genl_register_family(&thermal_event_genl_family);
2249 static void genetlink_exit(void)
2251 genl_unregister_family(&thermal_event_genl_family);
2253 #else /* !CONFIG_NET */
2254 static inline int genetlink_init(void) { return 0; }
2255 static inline void genetlink_exit(void) {}
2256 #endif /* !CONFIG_NET */
2258 static int __init thermal_register_governors(void)
2262 result = thermal_gov_step_wise_register();
2266 result = thermal_gov_fair_share_register();
2270 result = thermal_gov_bang_bang_register();
2274 result = thermal_gov_user_space_register();
2278 return thermal_gov_power_allocator_register();
2281 static void thermal_unregister_governors(void)
2283 thermal_gov_step_wise_unregister();
2284 thermal_gov_fair_share_unregister();
2285 thermal_gov_bang_bang_unregister();
2286 thermal_gov_user_space_unregister();
2287 thermal_gov_power_allocator_unregister();
2290 static int thermal_pm_notify(struct notifier_block *nb,
2291 unsigned long mode, void *_unused)
2293 struct thermal_zone_device *tz;
2296 case PM_HIBERNATION_PREPARE:
2297 case PM_RESTORE_PREPARE:
2298 case PM_SUSPEND_PREPARE:
2299 atomic_set(&in_suspend, 1);
2301 case PM_POST_HIBERNATION:
2302 case PM_POST_RESTORE:
2303 case PM_POST_SUSPEND:
2304 atomic_set(&in_suspend, 0);
2305 list_for_each_entry(tz, &thermal_tz_list, node) {
2306 thermal_zone_device_init(tz);
2307 thermal_zone_device_update(tz,
2308 THERMAL_EVENT_UNSPECIFIED);
2317 static struct notifier_block thermal_pm_nb = {
2318 .notifier_call = thermal_pm_notify,
2321 static int __init thermal_init(void)
2325 result = thermal_register_governors();
2329 result = class_register(&thermal_class);
2331 goto unregister_governors;
2333 result = genetlink_init();
2335 goto unregister_class;
2337 result = of_parse_thermal_zones();
2341 result = register_pm_notifier(&thermal_pm_nb);
2343 pr_warn("Thermal: Can not register suspend notifier, return %d\n",
2351 class_unregister(&thermal_class);
2352 unregister_governors:
2353 thermal_unregister_governors();
2355 idr_destroy(&thermal_tz_idr);
2356 idr_destroy(&thermal_cdev_idr);
2357 mutex_destroy(&thermal_idr_lock);
2358 mutex_destroy(&thermal_list_lock);
2359 mutex_destroy(&thermal_governor_lock);
2363 static void __exit thermal_exit(void)
2365 unregister_pm_notifier(&thermal_pm_nb);
2366 of_thermal_destroy_zones();
2368 class_unregister(&thermal_class);
2369 thermal_unregister_governors();
2370 idr_destroy(&thermal_tz_idr);
2371 idr_destroy(&thermal_cdev_idr);
2372 mutex_destroy(&thermal_idr_lock);
2373 mutex_destroy(&thermal_list_lock);
2374 mutex_destroy(&thermal_governor_lock);
2377 fs_initcall(thermal_init);
2378 module_exit(thermal_exit);