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>
41 #define CREATE_TRACE_POINTS
42 #include <trace/events/thermal.h>
44 #include "thermal_core.h"
45 #include "thermal_hwmon.h"
47 MODULE_AUTHOR("Zhang Rui");
48 MODULE_DESCRIPTION("Generic thermal management sysfs support");
49 MODULE_LICENSE("GPL v2");
51 static DEFINE_IDR(thermal_tz_idr);
52 static DEFINE_IDR(thermal_cdev_idr);
53 static DEFINE_MUTEX(thermal_idr_lock);
55 static LIST_HEAD(thermal_tz_list);
56 static LIST_HEAD(thermal_cdev_list);
57 static LIST_HEAD(thermal_governor_list);
59 static DEFINE_MUTEX(thermal_list_lock);
60 static DEFINE_MUTEX(thermal_governor_lock);
62 static struct thermal_governor *def_governor;
64 static struct thermal_governor *__find_governor(const char *name)
66 struct thermal_governor *pos;
68 if (!name || !name[0])
71 list_for_each_entry(pos, &thermal_governor_list, governor_list)
72 if (!strncasecmp(name, pos->name, THERMAL_NAME_LENGTH))
79 * bind_previous_governor() - bind the previous governor of the thermal zone
80 * @tz: a valid pointer to a struct thermal_zone_device
81 * @failed_gov_name: the name of the governor that failed to register
83 * Register the previous governor of the thermal zone after a new
84 * governor has failed to be bound.
86 static void bind_previous_governor(struct thermal_zone_device *tz,
87 const char *failed_gov_name)
89 if (tz->governor && tz->governor->bind_to_tz) {
90 if (tz->governor->bind_to_tz(tz)) {
92 "governor %s failed to bind and the previous one (%s) failed to bind again, thermal zone %s has no governor\n",
93 failed_gov_name, tz->governor->name, tz->type);
100 * thermal_set_governor() - Switch to another governor
101 * @tz: a valid pointer to a struct thermal_zone_device
102 * @new_gov: pointer to the new governor
104 * Change the governor of thermal zone @tz.
106 * Return: 0 on success, an error if the new governor's bind_to_tz() failed.
108 static int thermal_set_governor(struct thermal_zone_device *tz,
109 struct thermal_governor *new_gov)
113 if (tz->governor && tz->governor->unbind_from_tz)
114 tz->governor->unbind_from_tz(tz);
116 if (new_gov && new_gov->bind_to_tz) {
117 ret = new_gov->bind_to_tz(tz);
119 bind_previous_governor(tz, new_gov->name);
125 tz->governor = new_gov;
130 int thermal_register_governor(struct thermal_governor *governor)
134 struct thermal_zone_device *pos;
139 mutex_lock(&thermal_governor_lock);
142 if (__find_governor(governor->name) == NULL) {
144 list_add(&governor->governor_list, &thermal_governor_list);
145 if (!def_governor && !strncmp(governor->name,
146 DEFAULT_THERMAL_GOVERNOR, THERMAL_NAME_LENGTH))
147 def_governor = governor;
150 mutex_lock(&thermal_list_lock);
152 list_for_each_entry(pos, &thermal_tz_list, node) {
154 * only thermal zones with specified tz->tzp->governor_name
155 * may run with tz->govenor unset
160 name = pos->tzp->governor_name;
162 if (!strncasecmp(name, governor->name, THERMAL_NAME_LENGTH)) {
165 ret = thermal_set_governor(pos, governor);
167 dev_err(&pos->device,
168 "Failed to set governor %s for thermal zone %s: %d\n",
169 governor->name, pos->type, ret);
173 mutex_unlock(&thermal_list_lock);
174 mutex_unlock(&thermal_governor_lock);
179 void thermal_unregister_governor(struct thermal_governor *governor)
181 struct thermal_zone_device *pos;
186 mutex_lock(&thermal_governor_lock);
188 if (__find_governor(governor->name) == NULL)
191 mutex_lock(&thermal_list_lock);
193 list_for_each_entry(pos, &thermal_tz_list, node) {
194 if (!strncasecmp(pos->governor->name, governor->name,
195 THERMAL_NAME_LENGTH))
196 thermal_set_governor(pos, NULL);
199 mutex_unlock(&thermal_list_lock);
200 list_del(&governor->governor_list);
202 mutex_unlock(&thermal_governor_lock);
206 static int get_idr(struct idr *idr, struct mutex *lock, int *id)
212 ret = idr_alloc(idr, NULL, 0, 0, GFP_KERNEL);
215 if (unlikely(ret < 0))
221 static void release_idr(struct idr *idr, struct mutex *lock, int id)
230 int get_tz_trend(struct thermal_zone_device *tz, int trip)
232 enum thermal_trend trend;
234 if (tz->emul_temperature || !tz->ops->get_trend ||
235 tz->ops->get_trend(tz, trip, &trend)) {
236 if (tz->temperature > tz->last_temperature)
237 trend = THERMAL_TREND_RAISING;
238 else if (tz->temperature < tz->last_temperature)
239 trend = THERMAL_TREND_DROPPING;
241 trend = THERMAL_TREND_STABLE;
246 EXPORT_SYMBOL(get_tz_trend);
248 struct thermal_instance *get_thermal_instance(struct thermal_zone_device *tz,
249 struct thermal_cooling_device *cdev, int trip)
251 struct thermal_instance *pos = NULL;
252 struct thermal_instance *target_instance = NULL;
254 mutex_lock(&tz->lock);
255 mutex_lock(&cdev->lock);
257 list_for_each_entry(pos, &tz->thermal_instances, tz_node) {
258 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
259 target_instance = pos;
264 mutex_unlock(&cdev->lock);
265 mutex_unlock(&tz->lock);
267 return target_instance;
269 EXPORT_SYMBOL(get_thermal_instance);
271 static void print_bind_err_msg(struct thermal_zone_device *tz,
272 struct thermal_cooling_device *cdev, int ret)
274 dev_err(&tz->device, "binding zone %s with cdev %s failed:%d\n",
275 tz->type, cdev->type, ret);
278 static void __bind(struct thermal_zone_device *tz, int mask,
279 struct thermal_cooling_device *cdev,
280 unsigned long *limits,
285 for (i = 0; i < tz->trips; i++) {
286 if (mask & (1 << i)) {
287 unsigned long upper, lower;
289 upper = THERMAL_NO_LIMIT;
290 lower = THERMAL_NO_LIMIT;
292 lower = limits[i * 2];
293 upper = limits[i * 2 + 1];
295 ret = thermal_zone_bind_cooling_device(tz, i, cdev,
299 print_bind_err_msg(tz, cdev, ret);
304 static void __unbind(struct thermal_zone_device *tz, int mask,
305 struct thermal_cooling_device *cdev)
309 for (i = 0; i < tz->trips; i++)
311 thermal_zone_unbind_cooling_device(tz, i, cdev);
314 static void bind_cdev(struct thermal_cooling_device *cdev)
317 const struct thermal_zone_params *tzp;
318 struct thermal_zone_device *pos = NULL;
320 mutex_lock(&thermal_list_lock);
322 list_for_each_entry(pos, &thermal_tz_list, node) {
323 if (!pos->tzp && !pos->ops->bind)
326 if (pos->ops->bind) {
327 ret = pos->ops->bind(pos, cdev);
329 print_bind_err_msg(pos, cdev, ret);
334 if (!tzp || !tzp->tbp)
337 for (i = 0; i < tzp->num_tbps; i++) {
338 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
340 if (tzp->tbp[i].match(pos, cdev))
342 tzp->tbp[i].cdev = cdev;
343 __bind(pos, tzp->tbp[i].trip_mask, cdev,
344 tzp->tbp[i].binding_limits,
349 mutex_unlock(&thermal_list_lock);
352 static void bind_tz(struct thermal_zone_device *tz)
355 struct thermal_cooling_device *pos = NULL;
356 const struct thermal_zone_params *tzp = tz->tzp;
358 if (!tzp && !tz->ops->bind)
361 mutex_lock(&thermal_list_lock);
363 /* If there is ops->bind, try to use ops->bind */
365 list_for_each_entry(pos, &thermal_cdev_list, node) {
366 ret = tz->ops->bind(tz, pos);
368 print_bind_err_msg(tz, pos, ret);
373 if (!tzp || !tzp->tbp)
376 list_for_each_entry(pos, &thermal_cdev_list, node) {
377 for (i = 0; i < tzp->num_tbps; i++) {
378 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
380 if (tzp->tbp[i].match(tz, pos))
382 tzp->tbp[i].cdev = pos;
383 __bind(tz, tzp->tbp[i].trip_mask, pos,
384 tzp->tbp[i].binding_limits,
389 mutex_unlock(&thermal_list_lock);
392 static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
396 mod_delayed_work(system_freezable_wq, &tz->poll_queue,
397 round_jiffies(msecs_to_jiffies(delay)));
399 mod_delayed_work(system_freezable_wq, &tz->poll_queue,
400 msecs_to_jiffies(delay));
402 cancel_delayed_work(&tz->poll_queue);
405 static void monitor_thermal_zone(struct thermal_zone_device *tz)
407 mutex_lock(&tz->lock);
410 thermal_zone_device_set_polling(tz, tz->passive_delay);
411 else if (tz->polling_delay)
412 thermal_zone_device_set_polling(tz, tz->polling_delay);
414 thermal_zone_device_set_polling(tz, 0);
416 mutex_unlock(&tz->lock);
419 static void handle_non_critical_trips(struct thermal_zone_device *tz,
420 int trip, enum thermal_trip_type trip_type)
422 tz->governor ? tz->governor->throttle(tz, trip) :
423 def_governor->throttle(tz, trip);
426 static void handle_critical_trips(struct thermal_zone_device *tz,
427 int trip, enum thermal_trip_type trip_type)
431 tz->ops->get_trip_temp(tz, trip, &trip_temp);
433 /* If we have not crossed the trip_temp, we do not care. */
434 if (trip_temp <= 0 || tz->temperature < trip_temp)
437 trace_thermal_zone_trip(tz, trip, trip_type);
440 tz->ops->notify(tz, trip, trip_type);
442 if (trip_type == THERMAL_TRIP_CRITICAL) {
443 dev_emerg(&tz->device,
444 "critical temperature reached(%d C),shutting down\n",
445 tz->temperature / 1000);
446 orderly_poweroff(true);
450 static void handle_thermal_trip(struct thermal_zone_device *tz, int trip)
452 enum thermal_trip_type type;
454 tz->ops->get_trip_type(tz, trip, &type);
456 if (type == THERMAL_TRIP_CRITICAL || type == THERMAL_TRIP_HOT)
457 handle_critical_trips(tz, trip, type);
459 handle_non_critical_trips(tz, trip, type);
461 * Alright, we handled this trip successfully.
462 * So, start monitoring again.
464 monitor_thermal_zone(tz);
468 * thermal_zone_get_temp() - returns the temperature of a thermal zone
469 * @tz: a valid pointer to a struct thermal_zone_device
470 * @temp: a valid pointer to where to store the resulting temperature.
472 * When a valid thermal zone reference is passed, it will fetch its
473 * temperature and fill @temp.
475 * Return: On success returns 0, an error code otherwise
477 int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp)
481 int crit_temp = INT_MAX;
482 enum thermal_trip_type type;
484 if (!tz || IS_ERR(tz) || !tz->ops->get_temp)
487 mutex_lock(&tz->lock);
489 ret = tz->ops->get_temp(tz, temp);
491 if (IS_ENABLED(CONFIG_THERMAL_EMULATION) && tz->emul_temperature) {
492 for (count = 0; count < tz->trips; count++) {
493 ret = tz->ops->get_trip_type(tz, count, &type);
494 if (!ret && type == THERMAL_TRIP_CRITICAL) {
495 ret = tz->ops->get_trip_temp(tz, count,
502 * Only allow emulating a temperature when the real temperature
503 * is below the critical temperature so that the emulation code
504 * cannot hide critical conditions.
506 if (!ret && *temp < crit_temp)
507 *temp = tz->emul_temperature;
510 mutex_unlock(&tz->lock);
514 EXPORT_SYMBOL_GPL(thermal_zone_get_temp);
516 static void update_temperature(struct thermal_zone_device *tz)
520 ret = thermal_zone_get_temp(tz, &temp);
523 dev_warn(&tz->device,
524 "failed to read out thermal zone (%d)\n",
529 mutex_lock(&tz->lock);
530 tz->last_temperature = tz->temperature;
531 tz->temperature = temp;
532 mutex_unlock(&tz->lock);
534 trace_thermal_temperature(tz);
535 dev_dbg(&tz->device, "last_temperature=%d, current_temperature=%d\n",
536 tz->last_temperature, tz->temperature);
539 void thermal_zone_device_update(struct thermal_zone_device *tz)
543 if (!tz->ops->get_temp)
546 update_temperature(tz);
548 for (count = 0; count < tz->trips; count++)
549 handle_thermal_trip(tz, count);
551 EXPORT_SYMBOL_GPL(thermal_zone_device_update);
553 static void thermal_zone_device_check(struct work_struct *work)
555 struct thermal_zone_device *tz = container_of(work, struct
558 thermal_zone_device_update(tz);
561 /* sys I/F for thermal zone */
563 #define to_thermal_zone(_dev) \
564 container_of(_dev, struct thermal_zone_device, device)
567 type_show(struct device *dev, struct device_attribute *attr, char *buf)
569 struct thermal_zone_device *tz = to_thermal_zone(dev);
571 return sprintf(buf, "%s\n", tz->type);
575 temp_show(struct device *dev, struct device_attribute *attr, char *buf)
577 struct thermal_zone_device *tz = to_thermal_zone(dev);
578 int temperature, ret;
580 ret = thermal_zone_get_temp(tz, &temperature);
585 return sprintf(buf, "%d\n", temperature);
589 mode_show(struct device *dev, struct device_attribute *attr, char *buf)
591 struct thermal_zone_device *tz = to_thermal_zone(dev);
592 enum thermal_device_mode mode;
595 if (!tz->ops->get_mode)
598 result = tz->ops->get_mode(tz, &mode);
602 return sprintf(buf, "%s\n", mode == THERMAL_DEVICE_ENABLED ? "enabled"
607 mode_store(struct device *dev, struct device_attribute *attr,
608 const char *buf, size_t count)
610 struct thermal_zone_device *tz = to_thermal_zone(dev);
613 if (!tz->ops->set_mode)
616 if (!strncmp(buf, "enabled", sizeof("enabled") - 1))
617 result = tz->ops->set_mode(tz, THERMAL_DEVICE_ENABLED);
618 else if (!strncmp(buf, "disabled", sizeof("disabled") - 1))
619 result = tz->ops->set_mode(tz, THERMAL_DEVICE_DISABLED);
630 trip_point_type_show(struct device *dev, struct device_attribute *attr,
633 struct thermal_zone_device *tz = to_thermal_zone(dev);
634 enum thermal_trip_type type;
637 if (!tz->ops->get_trip_type)
640 if (!sscanf(attr->attr.name, "trip_point_%d_type", &trip))
643 result = tz->ops->get_trip_type(tz, trip, &type);
648 case THERMAL_TRIP_CRITICAL:
649 return sprintf(buf, "critical\n");
650 case THERMAL_TRIP_HOT:
651 return sprintf(buf, "hot\n");
652 case THERMAL_TRIP_PASSIVE:
653 return sprintf(buf, "passive\n");
654 case THERMAL_TRIP_ACTIVE:
655 return sprintf(buf, "active\n");
657 return sprintf(buf, "unknown\n");
662 trip_point_temp_store(struct device *dev, struct device_attribute *attr,
663 const char *buf, size_t count)
665 struct thermal_zone_device *tz = to_thermal_zone(dev);
667 unsigned long temperature;
669 if (!tz->ops->set_trip_temp)
672 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
675 if (kstrtoul(buf, 10, &temperature))
678 ret = tz->ops->set_trip_temp(tz, trip, temperature);
680 return ret ? ret : count;
684 trip_point_temp_show(struct device *dev, struct device_attribute *attr,
687 struct thermal_zone_device *tz = to_thermal_zone(dev);
691 if (!tz->ops->get_trip_temp)
694 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
697 ret = tz->ops->get_trip_temp(tz, trip, &temperature);
702 return sprintf(buf, "%d\n", temperature);
706 trip_point_hyst_store(struct device *dev, struct device_attribute *attr,
707 const char *buf, size_t count)
709 struct thermal_zone_device *tz = to_thermal_zone(dev);
713 if (!tz->ops->set_trip_hyst)
716 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
719 if (kstrtoint(buf, 10, &temperature))
723 * We are not doing any check on the 'temperature' value
724 * here. The driver implementing 'set_trip_hyst' has to
727 ret = tz->ops->set_trip_hyst(tz, trip, temperature);
729 return ret ? ret : count;
733 trip_point_hyst_show(struct device *dev, struct device_attribute *attr,
736 struct thermal_zone_device *tz = to_thermal_zone(dev);
740 if (!tz->ops->get_trip_hyst)
743 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
746 ret = tz->ops->get_trip_hyst(tz, trip, &temperature);
748 return ret ? ret : sprintf(buf, "%d\n", temperature);
752 passive_store(struct device *dev, struct device_attribute *attr,
753 const char *buf, size_t count)
755 struct thermal_zone_device *tz = to_thermal_zone(dev);
756 struct thermal_cooling_device *cdev = NULL;
759 if (!sscanf(buf, "%d\n", &state))
762 /* sanity check: values below 1000 millicelcius don't make sense
763 * and can cause the system to go into a thermal heart attack
765 if (state && state < 1000)
768 if (state && !tz->forced_passive) {
769 mutex_lock(&thermal_list_lock);
770 list_for_each_entry(cdev, &thermal_cdev_list, node) {
771 if (!strncmp("Processor", cdev->type,
772 sizeof("Processor")))
773 thermal_zone_bind_cooling_device(tz,
774 THERMAL_TRIPS_NONE, cdev,
777 THERMAL_WEIGHT_DEFAULT);
779 mutex_unlock(&thermal_list_lock);
780 if (!tz->passive_delay)
781 tz->passive_delay = 1000;
782 } else if (!state && tz->forced_passive) {
783 mutex_lock(&thermal_list_lock);
784 list_for_each_entry(cdev, &thermal_cdev_list, node) {
785 if (!strncmp("Processor", cdev->type,
786 sizeof("Processor")))
787 thermal_zone_unbind_cooling_device(tz,
791 mutex_unlock(&thermal_list_lock);
792 tz->passive_delay = 0;
795 tz->forced_passive = state;
797 thermal_zone_device_update(tz);
803 passive_show(struct device *dev, struct device_attribute *attr,
806 struct thermal_zone_device *tz = to_thermal_zone(dev);
808 return sprintf(buf, "%d\n", tz->forced_passive);
812 policy_store(struct device *dev, struct device_attribute *attr,
813 const char *buf, size_t count)
816 struct thermal_zone_device *tz = to_thermal_zone(dev);
817 struct thermal_governor *gov;
818 char name[THERMAL_NAME_LENGTH];
820 snprintf(name, sizeof(name), "%s", buf);
822 mutex_lock(&thermal_governor_lock);
823 mutex_lock(&tz->lock);
825 gov = __find_governor(strim(name));
829 ret = thermal_set_governor(tz, gov);
834 mutex_unlock(&tz->lock);
835 mutex_unlock(&thermal_governor_lock);
840 policy_show(struct device *dev, struct device_attribute *devattr, char *buf)
842 struct thermal_zone_device *tz = to_thermal_zone(dev);
844 return sprintf(buf, "%s\n", tz->governor->name);
848 available_policies_show(struct device *dev, struct device_attribute *devattr,
851 struct thermal_governor *pos;
853 ssize_t size = PAGE_SIZE;
855 mutex_lock(&thermal_governor_lock);
857 list_for_each_entry(pos, &thermal_governor_list, governor_list) {
858 size = PAGE_SIZE - count;
859 count += scnprintf(buf + count, size, "%s ", pos->name);
861 count += scnprintf(buf + count, size, "\n");
863 mutex_unlock(&thermal_governor_lock);
869 emul_temp_store(struct device *dev, struct device_attribute *attr,
870 const char *buf, size_t count)
872 struct thermal_zone_device *tz = to_thermal_zone(dev);
874 unsigned long temperature;
876 if (kstrtoul(buf, 10, &temperature))
879 if (!tz->ops->set_emul_temp) {
880 mutex_lock(&tz->lock);
881 tz->emul_temperature = temperature;
882 mutex_unlock(&tz->lock);
884 ret = tz->ops->set_emul_temp(tz, temperature);
888 thermal_zone_device_update(tz);
890 return ret ? ret : count;
892 static DEVICE_ATTR(emul_temp, S_IWUSR, NULL, emul_temp_store);
895 sustainable_power_show(struct device *dev, struct device_attribute *devattr,
898 struct thermal_zone_device *tz = to_thermal_zone(dev);
901 return sprintf(buf, "%u\n", tz->tzp->sustainable_power);
907 sustainable_power_store(struct device *dev, struct device_attribute *devattr,
908 const char *buf, size_t count)
910 struct thermal_zone_device *tz = to_thermal_zone(dev);
911 u32 sustainable_power;
916 if (kstrtou32(buf, 10, &sustainable_power))
919 tz->tzp->sustainable_power = sustainable_power;
923 static DEVICE_ATTR(sustainable_power, S_IWUSR | S_IRUGO, sustainable_power_show,
924 sustainable_power_store);
926 #define create_s32_tzp_attr(name) \
928 name##_show(struct device *dev, struct device_attribute *devattr, \
931 struct thermal_zone_device *tz = to_thermal_zone(dev); \
934 return sprintf(buf, "%u\n", tz->tzp->name); \
940 name##_store(struct device *dev, struct device_attribute *devattr, \
941 const char *buf, size_t count) \
943 struct thermal_zone_device *tz = to_thermal_zone(dev); \
949 if (kstrtos32(buf, 10, &value)) \
952 tz->tzp->name = value; \
956 static DEVICE_ATTR(name, S_IWUSR | S_IRUGO, name##_show, name##_store)
958 create_s32_tzp_attr(k_po);
959 create_s32_tzp_attr(k_pu);
960 create_s32_tzp_attr(k_i);
961 create_s32_tzp_attr(k_d);
962 create_s32_tzp_attr(integral_cutoff);
963 create_s32_tzp_attr(slope);
964 create_s32_tzp_attr(offset);
965 #undef create_s32_tzp_attr
967 static struct device_attribute *dev_tzp_attrs[] = {
968 &dev_attr_sustainable_power,
973 &dev_attr_integral_cutoff,
978 static int create_tzp_attrs(struct device *dev)
982 for (i = 0; i < ARRAY_SIZE(dev_tzp_attrs); i++) {
984 struct device_attribute *dev_attr = dev_tzp_attrs[i];
986 ret = device_create_file(dev, dev_attr);
995 * power_actor_get_max_power() - get the maximum power that a cdev can consume
996 * @cdev: pointer to &thermal_cooling_device
997 * @tz: a valid thermal zone device pointer
998 * @max_power: pointer in which to store the maximum power
1000 * Calculate the maximum power consumption in milliwats that the
1001 * cooling device can currently consume and store it in @max_power.
1003 * Return: 0 on success, -EINVAL if @cdev doesn't support the
1004 * power_actor API or -E* on other error.
1006 int power_actor_get_max_power(struct thermal_cooling_device *cdev,
1007 struct thermal_zone_device *tz, u32 *max_power)
1009 if (!cdev_is_power_actor(cdev))
1012 return cdev->ops->state2power(cdev, tz, 0, max_power);
1016 * power_actor_set_power() - limit the maximum power that a cooling device can consume
1017 * @cdev: pointer to &thermal_cooling_device
1018 * @instance: thermal instance to update
1019 * @power: the power in milliwatts
1021 * Set the cooling device to consume at most @power milliwatts.
1023 * Return: 0 on success, -EINVAL if the cooling device does not
1024 * implement the power actor API or -E* for other failures.
1026 int power_actor_set_power(struct thermal_cooling_device *cdev,
1027 struct thermal_instance *instance, u32 power)
1029 unsigned long state;
1032 if (!cdev_is_power_actor(cdev))
1035 ret = cdev->ops->power2state(cdev, instance->tz, power, &state);
1039 instance->target = state;
1040 cdev->updated = false;
1041 thermal_cdev_update(cdev);
1046 static DEVICE_ATTR(type, 0444, type_show, NULL);
1047 static DEVICE_ATTR(temp, 0444, temp_show, NULL);
1048 static DEVICE_ATTR(mode, 0644, mode_show, mode_store);
1049 static DEVICE_ATTR(passive, S_IRUGO | S_IWUSR, passive_show, passive_store);
1050 static DEVICE_ATTR(policy, S_IRUGO | S_IWUSR, policy_show, policy_store);
1051 static DEVICE_ATTR(available_policies, S_IRUGO, available_policies_show, NULL);
1053 /* sys I/F for cooling device */
1054 #define to_cooling_device(_dev) \
1055 container_of(_dev, struct thermal_cooling_device, device)
1058 thermal_cooling_device_type_show(struct device *dev,
1059 struct device_attribute *attr, char *buf)
1061 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1063 return sprintf(buf, "%s\n", cdev->type);
1067 thermal_cooling_device_max_state_show(struct device *dev,
1068 struct device_attribute *attr, char *buf)
1070 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1071 unsigned long state;
1074 ret = cdev->ops->get_max_state(cdev, &state);
1077 return sprintf(buf, "%ld\n", state);
1081 thermal_cooling_device_cur_state_show(struct device *dev,
1082 struct device_attribute *attr, char *buf)
1084 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1085 unsigned long state;
1088 ret = cdev->ops->get_cur_state(cdev, &state);
1091 return sprintf(buf, "%ld\n", state);
1095 thermal_cooling_device_cur_state_store(struct device *dev,
1096 struct device_attribute *attr,
1097 const char *buf, size_t count)
1099 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1100 unsigned long state;
1103 if (!sscanf(buf, "%ld\n", &state))
1106 if ((long)state < 0)
1109 result = cdev->ops->set_cur_state(cdev, state);
1115 static struct device_attribute dev_attr_cdev_type =
1116 __ATTR(type, 0444, thermal_cooling_device_type_show, NULL);
1117 static DEVICE_ATTR(max_state, 0444,
1118 thermal_cooling_device_max_state_show, NULL);
1119 static DEVICE_ATTR(cur_state, 0644,
1120 thermal_cooling_device_cur_state_show,
1121 thermal_cooling_device_cur_state_store);
1124 thermal_cooling_device_trip_point_show(struct device *dev,
1125 struct device_attribute *attr, char *buf)
1127 struct thermal_instance *instance;
1130 container_of(attr, struct thermal_instance, attr);
1132 if (instance->trip == THERMAL_TRIPS_NONE)
1133 return sprintf(buf, "-1\n");
1135 return sprintf(buf, "%d\n", instance->trip);
1138 static struct attribute *cooling_device_attrs[] = {
1139 &dev_attr_cdev_type.attr,
1140 &dev_attr_max_state.attr,
1141 &dev_attr_cur_state.attr,
1145 static const struct attribute_group cooling_device_attr_group = {
1146 .attrs = cooling_device_attrs,
1149 static const struct attribute_group *cooling_device_attr_groups[] = {
1150 &cooling_device_attr_group,
1155 thermal_cooling_device_weight_show(struct device *dev,
1156 struct device_attribute *attr, char *buf)
1158 struct thermal_instance *instance;
1160 instance = container_of(attr, struct thermal_instance, weight_attr);
1162 return sprintf(buf, "%d\n", instance->weight);
1166 thermal_cooling_device_weight_store(struct device *dev,
1167 struct device_attribute *attr,
1168 const char *buf, size_t count)
1170 struct thermal_instance *instance;
1173 ret = kstrtoint(buf, 0, &weight);
1177 instance = container_of(attr, struct thermal_instance, weight_attr);
1178 instance->weight = weight;
1182 /* Device management */
1185 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
1186 * @tz: pointer to struct thermal_zone_device
1187 * @trip: indicates which trip point the cooling devices is
1188 * associated with in this thermal zone.
1189 * @cdev: pointer to struct thermal_cooling_device
1190 * @upper: the Maximum cooling state for this trip point.
1191 * THERMAL_NO_LIMIT means no upper limit,
1192 * and the cooling device can be in max_state.
1193 * @lower: the Minimum cooling state can be used for this trip point.
1194 * THERMAL_NO_LIMIT means no lower limit,
1195 * and the cooling device can be in cooling state 0.
1196 * @weight: The weight of the cooling device to be bound to the
1197 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
1200 * This interface function bind a thermal cooling device to the certain trip
1201 * point of a thermal zone device.
1202 * This function is usually called in the thermal zone device .bind callback.
1204 * Return: 0 on success, the proper error value otherwise.
1206 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
1208 struct thermal_cooling_device *cdev,
1209 unsigned long upper, unsigned long lower,
1210 unsigned int weight)
1212 struct thermal_instance *dev;
1213 struct thermal_instance *pos;
1214 struct thermal_zone_device *pos1;
1215 struct thermal_cooling_device *pos2;
1216 unsigned long max_state;
1219 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
1222 list_for_each_entry(pos1, &thermal_tz_list, node) {
1226 list_for_each_entry(pos2, &thermal_cdev_list, node) {
1231 if (tz != pos1 || cdev != pos2)
1234 ret = cdev->ops->get_max_state(cdev, &max_state);
1238 /* lower default 0, upper default max_state */
1239 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
1240 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
1242 if (lower > upper || upper > max_state)
1246 kzalloc(sizeof(struct thermal_instance), GFP_KERNEL);
1254 dev->target = THERMAL_NO_TARGET;
1255 dev->weight = weight;
1257 result = get_idr(&tz->idr, &tz->lock, &dev->id);
1261 sprintf(dev->name, "cdev%d", dev->id);
1263 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
1267 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
1268 sysfs_attr_init(&dev->attr.attr);
1269 dev->attr.attr.name = dev->attr_name;
1270 dev->attr.attr.mode = 0444;
1271 dev->attr.show = thermal_cooling_device_trip_point_show;
1272 result = device_create_file(&tz->device, &dev->attr);
1274 goto remove_symbol_link;
1276 sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
1277 sysfs_attr_init(&dev->weight_attr.attr);
1278 dev->weight_attr.attr.name = dev->weight_attr_name;
1279 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
1280 dev->weight_attr.show = thermal_cooling_device_weight_show;
1281 dev->weight_attr.store = thermal_cooling_device_weight_store;
1282 result = device_create_file(&tz->device, &dev->weight_attr);
1284 goto remove_trip_file;
1286 mutex_lock(&tz->lock);
1287 mutex_lock(&cdev->lock);
1288 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
1289 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1294 list_add_tail(&dev->tz_node, &tz->thermal_instances);
1295 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
1297 mutex_unlock(&cdev->lock);
1298 mutex_unlock(&tz->lock);
1303 device_remove_file(&tz->device, &dev->weight_attr);
1305 device_remove_file(&tz->device, &dev->attr);
1307 sysfs_remove_link(&tz->device.kobj, dev->name);
1309 release_idr(&tz->idr, &tz->lock, dev->id);
1314 EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
1317 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
1319 * @tz: pointer to a struct thermal_zone_device.
1320 * @trip: indicates which trip point the cooling devices is
1321 * associated with in this thermal zone.
1322 * @cdev: pointer to a struct thermal_cooling_device.
1324 * This interface function unbind a thermal cooling device from the certain
1325 * trip point of a thermal zone device.
1326 * This function is usually called in the thermal zone device .unbind callback.
1328 * Return: 0 on success, the proper error value otherwise.
1330 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
1332 struct thermal_cooling_device *cdev)
1334 struct thermal_instance *pos, *next;
1336 mutex_lock(&tz->lock);
1337 mutex_lock(&cdev->lock);
1338 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
1339 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1340 list_del(&pos->tz_node);
1341 list_del(&pos->cdev_node);
1342 mutex_unlock(&cdev->lock);
1343 mutex_unlock(&tz->lock);
1347 mutex_unlock(&cdev->lock);
1348 mutex_unlock(&tz->lock);
1353 device_remove_file(&tz->device, &pos->attr);
1354 sysfs_remove_link(&tz->device.kobj, pos->name);
1355 release_idr(&tz->idr, &tz->lock, pos->id);
1359 EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
1361 static void thermal_release(struct device *dev)
1363 struct thermal_zone_device *tz;
1364 struct thermal_cooling_device *cdev;
1366 if (!strncmp(dev_name(dev), "thermal_zone",
1367 sizeof("thermal_zone") - 1)) {
1368 tz = to_thermal_zone(dev);
1370 } else if(!strncmp(dev_name(dev), "cooling_device",
1371 sizeof("cooling_device") - 1)){
1372 cdev = to_cooling_device(dev);
1377 static struct class thermal_class = {
1379 .dev_release = thermal_release,
1383 * __thermal_cooling_device_register() - register a new thermal cooling device
1384 * @np: a pointer to a device tree node.
1385 * @type: the thermal cooling device type.
1386 * @devdata: device private data.
1387 * @ops: standard thermal cooling devices callbacks.
1389 * This interface function adds a new thermal cooling device (fan/processor/...)
1390 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1391 * to all the thermal zone devices registered at the same time.
1392 * It also gives the opportunity to link the cooling device to a device tree
1393 * node, so that it can be bound to a thermal zone created out of device tree.
1395 * Return: a pointer to the created struct thermal_cooling_device or an
1396 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1398 static struct thermal_cooling_device *
1399 __thermal_cooling_device_register(struct device_node *np,
1400 char *type, void *devdata,
1401 const struct thermal_cooling_device_ops *ops)
1403 struct thermal_cooling_device *cdev;
1406 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1407 return ERR_PTR(-EINVAL);
1409 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
1410 !ops->set_cur_state)
1411 return ERR_PTR(-EINVAL);
1413 cdev = kzalloc(sizeof(struct thermal_cooling_device), GFP_KERNEL);
1415 return ERR_PTR(-ENOMEM);
1417 result = get_idr(&thermal_cdev_idr, &thermal_idr_lock, &cdev->id);
1420 return ERR_PTR(result);
1423 strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
1424 mutex_init(&cdev->lock);
1425 INIT_LIST_HEAD(&cdev->thermal_instances);
1428 cdev->updated = false;
1429 cdev->device.class = &thermal_class;
1430 cdev->device.groups = cooling_device_attr_groups;
1431 cdev->devdata = devdata;
1432 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
1433 result = device_register(&cdev->device);
1435 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1437 return ERR_PTR(result);
1440 /* Add 'this' new cdev to the global cdev list */
1441 mutex_lock(&thermal_list_lock);
1442 list_add(&cdev->node, &thermal_cdev_list);
1443 mutex_unlock(&thermal_list_lock);
1445 /* Update binding information for 'this' new cdev */
1452 * thermal_cooling_device_register() - register a new thermal cooling device
1453 * @type: the thermal cooling device type.
1454 * @devdata: device private data.
1455 * @ops: standard thermal cooling devices callbacks.
1457 * This interface function adds a new thermal cooling device (fan/processor/...)
1458 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1459 * to all the thermal zone devices registered at the same time.
1461 * Return: a pointer to the created struct thermal_cooling_device or an
1462 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1464 struct thermal_cooling_device *
1465 thermal_cooling_device_register(char *type, void *devdata,
1466 const struct thermal_cooling_device_ops *ops)
1468 return __thermal_cooling_device_register(NULL, type, devdata, ops);
1470 EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
1473 * thermal_of_cooling_device_register() - register an OF thermal cooling device
1474 * @np: a pointer to a device tree node.
1475 * @type: the thermal cooling device type.
1476 * @devdata: device private data.
1477 * @ops: standard thermal cooling devices callbacks.
1479 * This function will register a cooling device with device tree node reference.
1480 * This interface function adds a new thermal cooling device (fan/processor/...)
1481 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1482 * to all the thermal zone devices registered at the same time.
1484 * Return: a pointer to the created struct thermal_cooling_device or an
1485 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1487 struct thermal_cooling_device *
1488 thermal_of_cooling_device_register(struct device_node *np,
1489 char *type, void *devdata,
1490 const struct thermal_cooling_device_ops *ops)
1492 return __thermal_cooling_device_register(np, type, devdata, ops);
1494 EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
1497 * thermal_cooling_device_unregister - removes the registered thermal cooling device
1498 * @cdev: the thermal cooling device to remove.
1500 * thermal_cooling_device_unregister() must be called when the device is no
1503 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1506 const struct thermal_zone_params *tzp;
1507 struct thermal_zone_device *tz;
1508 struct thermal_cooling_device *pos = NULL;
1513 mutex_lock(&thermal_list_lock);
1514 list_for_each_entry(pos, &thermal_cdev_list, node)
1518 /* thermal cooling device not found */
1519 mutex_unlock(&thermal_list_lock);
1522 list_del(&cdev->node);
1524 /* Unbind all thermal zones associated with 'this' cdev */
1525 list_for_each_entry(tz, &thermal_tz_list, node) {
1526 if (tz->ops->unbind) {
1527 tz->ops->unbind(tz, cdev);
1531 if (!tz->tzp || !tz->tzp->tbp)
1535 for (i = 0; i < tzp->num_tbps; i++) {
1536 if (tzp->tbp[i].cdev == cdev) {
1537 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1538 tzp->tbp[i].cdev = NULL;
1543 mutex_unlock(&thermal_list_lock);
1546 device_remove_file(&cdev->device, &dev_attr_cdev_type);
1547 device_remove_file(&cdev->device, &dev_attr_max_state);
1548 device_remove_file(&cdev->device, &dev_attr_cur_state);
1550 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1551 device_unregister(&cdev->device);
1554 EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1556 void thermal_cdev_update(struct thermal_cooling_device *cdev)
1558 struct thermal_instance *instance;
1559 unsigned long target = 0;
1561 /* cooling device is updated*/
1565 mutex_lock(&cdev->lock);
1566 /* Make sure cdev enters the deepest cooling state */
1567 list_for_each_entry(instance, &cdev->thermal_instances, cdev_node) {
1568 dev_dbg(&cdev->device, "zone%d->target=%lu\n",
1569 instance->tz->id, instance->target);
1570 if (instance->target == THERMAL_NO_TARGET)
1572 if (instance->target > target)
1573 target = instance->target;
1575 mutex_unlock(&cdev->lock);
1576 cdev->ops->set_cur_state(cdev, target);
1577 cdev->updated = true;
1578 trace_cdev_update(cdev, target);
1579 dev_dbg(&cdev->device, "set to state %lu\n", target);
1581 EXPORT_SYMBOL(thermal_cdev_update);
1584 * thermal_notify_framework - Sensor drivers use this API to notify framework
1585 * @tz: thermal zone device
1586 * @trip: indicates which trip point has been crossed
1588 * This function handles the trip events from sensor drivers. It starts
1589 * throttling the cooling devices according to the policy configured.
1590 * For CRITICAL and HOT trip points, this notifies the respective drivers,
1591 * and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
1592 * The throttling policy is based on the configured platform data; if no
1593 * platform data is provided, this uses the step_wise throttling policy.
1595 void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
1597 handle_thermal_trip(tz, trip);
1599 EXPORT_SYMBOL_GPL(thermal_notify_framework);
1602 * create_trip_attrs() - create attributes for trip points
1603 * @tz: the thermal zone device
1604 * @mask: Writeable trip point bitmap.
1606 * helper function to instantiate sysfs entries for every trip
1607 * point and its properties of a struct thermal_zone_device.
1609 * Return: 0 on success, the proper error value otherwise.
1611 static int create_trip_attrs(struct thermal_zone_device *tz, int mask)
1614 int size = sizeof(struct thermal_attr) * tz->trips;
1616 tz->trip_type_attrs = kzalloc(size, GFP_KERNEL);
1617 if (!tz->trip_type_attrs)
1620 tz->trip_temp_attrs = kzalloc(size, GFP_KERNEL);
1621 if (!tz->trip_temp_attrs) {
1622 kfree(tz->trip_type_attrs);
1626 if (tz->ops->get_trip_hyst) {
1627 tz->trip_hyst_attrs = kzalloc(size, GFP_KERNEL);
1628 if (!tz->trip_hyst_attrs) {
1629 kfree(tz->trip_type_attrs);
1630 kfree(tz->trip_temp_attrs);
1636 for (indx = 0; indx < tz->trips; indx++) {
1637 /* create trip type attribute */
1638 snprintf(tz->trip_type_attrs[indx].name, THERMAL_NAME_LENGTH,
1639 "trip_point_%d_type", indx);
1641 sysfs_attr_init(&tz->trip_type_attrs[indx].attr.attr);
1642 tz->trip_type_attrs[indx].attr.attr.name =
1643 tz->trip_type_attrs[indx].name;
1644 tz->trip_type_attrs[indx].attr.attr.mode = S_IRUGO;
1645 tz->trip_type_attrs[indx].attr.show = trip_point_type_show;
1647 device_create_file(&tz->device,
1648 &tz->trip_type_attrs[indx].attr);
1650 /* create trip temp attribute */
1651 snprintf(tz->trip_temp_attrs[indx].name, THERMAL_NAME_LENGTH,
1652 "trip_point_%d_temp", indx);
1654 sysfs_attr_init(&tz->trip_temp_attrs[indx].attr.attr);
1655 tz->trip_temp_attrs[indx].attr.attr.name =
1656 tz->trip_temp_attrs[indx].name;
1657 tz->trip_temp_attrs[indx].attr.attr.mode = S_IRUGO;
1658 tz->trip_temp_attrs[indx].attr.show = trip_point_temp_show;
1659 if (IS_ENABLED(CONFIG_THERMAL_WRITABLE_TRIPS) &&
1660 mask & (1 << indx)) {
1661 tz->trip_temp_attrs[indx].attr.attr.mode |= S_IWUSR;
1662 tz->trip_temp_attrs[indx].attr.store =
1663 trip_point_temp_store;
1666 device_create_file(&tz->device,
1667 &tz->trip_temp_attrs[indx].attr);
1669 /* create Optional trip hyst attribute */
1670 if (!tz->ops->get_trip_hyst)
1672 snprintf(tz->trip_hyst_attrs[indx].name, THERMAL_NAME_LENGTH,
1673 "trip_point_%d_hyst", indx);
1675 sysfs_attr_init(&tz->trip_hyst_attrs[indx].attr.attr);
1676 tz->trip_hyst_attrs[indx].attr.attr.name =
1677 tz->trip_hyst_attrs[indx].name;
1678 tz->trip_hyst_attrs[indx].attr.attr.mode = S_IRUGO;
1679 tz->trip_hyst_attrs[indx].attr.show = trip_point_hyst_show;
1680 if (tz->ops->set_trip_hyst) {
1681 tz->trip_hyst_attrs[indx].attr.attr.mode |= S_IWUSR;
1682 tz->trip_hyst_attrs[indx].attr.store =
1683 trip_point_hyst_store;
1686 device_create_file(&tz->device,
1687 &tz->trip_hyst_attrs[indx].attr);
1692 static void remove_trip_attrs(struct thermal_zone_device *tz)
1696 for (indx = 0; indx < tz->trips; indx++) {
1697 device_remove_file(&tz->device,
1698 &tz->trip_type_attrs[indx].attr);
1699 device_remove_file(&tz->device,
1700 &tz->trip_temp_attrs[indx].attr);
1701 if (tz->ops->get_trip_hyst)
1702 device_remove_file(&tz->device,
1703 &tz->trip_hyst_attrs[indx].attr);
1705 kfree(tz->trip_type_attrs);
1706 kfree(tz->trip_temp_attrs);
1707 kfree(tz->trip_hyst_attrs);
1711 * thermal_zone_device_register() - register a new thermal zone device
1712 * @type: the thermal zone device type
1713 * @trips: the number of trip points the thermal zone support
1714 * @mask: a bit string indicating the writeablility of trip points
1715 * @devdata: private device data
1716 * @ops: standard thermal zone device callbacks
1717 * @tzp: thermal zone platform parameters
1718 * @passive_delay: number of milliseconds to wait between polls when
1719 * performing passive cooling
1720 * @polling_delay: number of milliseconds to wait between polls when checking
1721 * whether trip points have been crossed (0 for interrupt
1724 * This interface function adds a new thermal zone device (sensor) to
1725 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1726 * thermal cooling devices registered at the same time.
1727 * thermal_zone_device_unregister() must be called when the device is no
1728 * longer needed. The passive cooling depends on the .get_trend() return value.
1730 * Return: a pointer to the created struct thermal_zone_device or an
1731 * in case of error, an ERR_PTR. Caller must check return value with
1732 * IS_ERR*() helpers.
1734 struct thermal_zone_device *thermal_zone_device_register(const char *type,
1735 int trips, int mask, void *devdata,
1736 struct thermal_zone_device_ops *ops,
1737 struct thermal_zone_params *tzp,
1738 int passive_delay, int polling_delay)
1740 struct thermal_zone_device *tz;
1741 enum thermal_trip_type trip_type;
1745 struct thermal_governor *governor;
1747 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1748 return ERR_PTR(-EINVAL);
1750 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
1751 return ERR_PTR(-EINVAL);
1754 return ERR_PTR(-EINVAL);
1756 if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
1757 return ERR_PTR(-EINVAL);
1759 tz = kzalloc(sizeof(struct thermal_zone_device), GFP_KERNEL);
1761 return ERR_PTR(-ENOMEM);
1763 INIT_LIST_HEAD(&tz->thermal_instances);
1765 mutex_init(&tz->lock);
1766 result = get_idr(&thermal_tz_idr, &thermal_idr_lock, &tz->id);
1769 return ERR_PTR(result);
1772 strlcpy(tz->type, type ? : "", sizeof(tz->type));
1775 tz->device.class = &thermal_class;
1776 tz->devdata = devdata;
1778 tz->passive_delay = passive_delay;
1779 tz->polling_delay = polling_delay;
1781 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1782 result = device_register(&tz->device);
1784 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1786 return ERR_PTR(result);
1791 result = device_create_file(&tz->device, &dev_attr_type);
1796 result = device_create_file(&tz->device, &dev_attr_temp);
1800 if (ops->get_mode) {
1801 result = device_create_file(&tz->device, &dev_attr_mode);
1806 result = create_trip_attrs(tz, mask);
1810 for (count = 0; count < trips; count++) {
1811 tz->ops->get_trip_type(tz, count, &trip_type);
1812 if (trip_type == THERMAL_TRIP_PASSIVE)
1817 result = device_create_file(&tz->device, &dev_attr_passive);
1822 if (IS_ENABLED(CONFIG_THERMAL_EMULATION)) {
1823 result = device_create_file(&tz->device, &dev_attr_emul_temp);
1828 /* Create policy attribute */
1829 result = device_create_file(&tz->device, &dev_attr_policy);
1833 /* Add thermal zone params */
1834 result = create_tzp_attrs(&tz->device);
1838 /* Create available_policies attribute */
1839 result = device_create_file(&tz->device, &dev_attr_available_policies);
1843 /* Update 'this' zone's governor information */
1844 mutex_lock(&thermal_governor_lock);
1847 governor = __find_governor(tz->tzp->governor_name);
1849 governor = def_governor;
1851 result = thermal_set_governor(tz, governor);
1853 mutex_unlock(&thermal_governor_lock);
1857 mutex_unlock(&thermal_governor_lock);
1859 if (!tz->tzp || !tz->tzp->no_hwmon) {
1860 result = thermal_add_hwmon_sysfs(tz);
1865 mutex_lock(&thermal_list_lock);
1866 list_add_tail(&tz->node, &thermal_tz_list);
1867 mutex_unlock(&thermal_list_lock);
1869 /* Bind cooling devices for this zone */
1872 INIT_DELAYED_WORK(&(tz->poll_queue), thermal_zone_device_check);
1874 thermal_zone_device_update(tz);
1879 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1880 device_unregister(&tz->device);
1881 return ERR_PTR(result);
1883 EXPORT_SYMBOL_GPL(thermal_zone_device_register);
1886 * thermal_device_unregister - removes the registered thermal zone device
1887 * @tz: the thermal zone device to remove
1889 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1892 const struct thermal_zone_params *tzp;
1893 struct thermal_cooling_device *cdev;
1894 struct thermal_zone_device *pos = NULL;
1901 mutex_lock(&thermal_list_lock);
1902 list_for_each_entry(pos, &thermal_tz_list, node)
1906 /* thermal zone device not found */
1907 mutex_unlock(&thermal_list_lock);
1910 list_del(&tz->node);
1912 /* Unbind all cdevs associated with 'this' thermal zone */
1913 list_for_each_entry(cdev, &thermal_cdev_list, node) {
1914 if (tz->ops->unbind) {
1915 tz->ops->unbind(tz, cdev);
1919 if (!tzp || !tzp->tbp)
1922 for (i = 0; i < tzp->num_tbps; i++) {
1923 if (tzp->tbp[i].cdev == cdev) {
1924 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1925 tzp->tbp[i].cdev = NULL;
1930 mutex_unlock(&thermal_list_lock);
1932 thermal_zone_device_set_polling(tz, 0);
1935 device_remove_file(&tz->device, &dev_attr_type);
1936 device_remove_file(&tz->device, &dev_attr_temp);
1937 if (tz->ops->get_mode)
1938 device_remove_file(&tz->device, &dev_attr_mode);
1939 device_remove_file(&tz->device, &dev_attr_policy);
1940 device_remove_file(&tz->device, &dev_attr_available_policies);
1941 remove_trip_attrs(tz);
1942 thermal_set_governor(tz, NULL);
1944 thermal_remove_hwmon_sysfs(tz);
1945 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1946 idr_destroy(&tz->idr);
1947 mutex_destroy(&tz->lock);
1948 device_unregister(&tz->device);
1951 EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
1954 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
1955 * @name: thermal zone name to fetch the temperature
1957 * When only one zone is found with the passed name, returns a reference to it.
1959 * Return: On success returns a reference to an unique thermal zone with
1960 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
1961 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
1963 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
1965 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
1966 unsigned int found = 0;
1971 mutex_lock(&thermal_list_lock);
1972 list_for_each_entry(pos, &thermal_tz_list, node)
1973 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
1977 mutex_unlock(&thermal_list_lock);
1979 /* nothing has been found, thus an error code for it */
1981 ref = ERR_PTR(-ENODEV);
1983 /* Success only when an unique zone is found */
1984 ref = ERR_PTR(-EEXIST);
1989 EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
1992 static const struct genl_multicast_group thermal_event_mcgrps[] = {
1993 { .name = THERMAL_GENL_MCAST_GROUP_NAME, },
1996 static struct genl_family thermal_event_genl_family = {
1997 .id = GENL_ID_GENERATE,
1998 .name = THERMAL_GENL_FAMILY_NAME,
1999 .version = THERMAL_GENL_VERSION,
2000 .maxattr = THERMAL_GENL_ATTR_MAX,
2001 .mcgrps = thermal_event_mcgrps,
2002 .n_mcgrps = ARRAY_SIZE(thermal_event_mcgrps),
2005 int thermal_generate_netlink_event(struct thermal_zone_device *tz,
2008 struct sk_buff *skb;
2009 struct nlattr *attr;
2010 struct thermal_genl_event *thermal_event;
2014 static unsigned int thermal_event_seqnum;
2019 /* allocate memory */
2020 size = nla_total_size(sizeof(struct thermal_genl_event)) +
2023 skb = genlmsg_new(size, GFP_ATOMIC);
2027 /* add the genetlink message header */
2028 msg_header = genlmsg_put(skb, 0, thermal_event_seqnum++,
2029 &thermal_event_genl_family, 0,
2030 THERMAL_GENL_CMD_EVENT);
2037 attr = nla_reserve(skb, THERMAL_GENL_ATTR_EVENT,
2038 sizeof(struct thermal_genl_event));
2045 thermal_event = nla_data(attr);
2046 if (!thermal_event) {
2051 memset(thermal_event, 0, sizeof(struct thermal_genl_event));
2053 thermal_event->orig = tz->id;
2054 thermal_event->event = event;
2056 /* send multicast genetlink message */
2057 genlmsg_end(skb, msg_header);
2059 result = genlmsg_multicast(&thermal_event_genl_family, skb, 0,
2062 dev_err(&tz->device, "Failed to send netlink event:%d", result);
2066 EXPORT_SYMBOL_GPL(thermal_generate_netlink_event);
2068 static int genetlink_init(void)
2070 return genl_register_family(&thermal_event_genl_family);
2073 static void genetlink_exit(void)
2075 genl_unregister_family(&thermal_event_genl_family);
2077 #else /* !CONFIG_NET */
2078 static inline int genetlink_init(void) { return 0; }
2079 static inline void genetlink_exit(void) {}
2080 #endif /* !CONFIG_NET */
2082 static int __init thermal_register_governors(void)
2086 result = thermal_gov_step_wise_register();
2090 result = thermal_gov_fair_share_register();
2094 result = thermal_gov_bang_bang_register();
2098 result = thermal_gov_user_space_register();
2102 return thermal_gov_power_allocator_register();
2105 static void thermal_unregister_governors(void)
2107 thermal_gov_step_wise_unregister();
2108 thermal_gov_fair_share_unregister();
2109 thermal_gov_bang_bang_unregister();
2110 thermal_gov_user_space_unregister();
2111 thermal_gov_power_allocator_unregister();
2114 static int __init thermal_init(void)
2118 result = thermal_register_governors();
2122 result = class_register(&thermal_class);
2124 goto unregister_governors;
2126 result = genetlink_init();
2128 goto unregister_class;
2130 result = of_parse_thermal_zones();
2139 class_unregister(&thermal_class);
2140 unregister_governors:
2141 thermal_unregister_governors();
2143 idr_destroy(&thermal_tz_idr);
2144 idr_destroy(&thermal_cdev_idr);
2145 mutex_destroy(&thermal_idr_lock);
2146 mutex_destroy(&thermal_list_lock);
2147 mutex_destroy(&thermal_governor_lock);
2151 static void __exit thermal_exit(void)
2153 of_thermal_destroy_zones();
2155 class_unregister(&thermal_class);
2156 thermal_unregister_governors();
2157 idr_destroy(&thermal_tz_idr);
2158 idr_destroy(&thermal_cdev_idr);
2159 mutex_destroy(&thermal_idr_lock);
2160 mutex_destroy(&thermal_list_lock);
2161 mutex_destroy(&thermal_governor_lock);
2164 fs_initcall(thermal_init);
2165 module_exit(thermal_exit);