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 its the temperature of 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, unsigned long *temp)
480 #ifdef CONFIG_THERMAL_EMULATION
482 unsigned long crit_temp = -1UL;
483 enum thermal_trip_type type;
486 if (!tz || IS_ERR(tz) || !tz->ops->get_temp)
489 mutex_lock(&tz->lock);
491 ret = tz->ops->get_temp(tz, temp);
492 #ifdef CONFIG_THERMAL_EMULATION
493 if (!tz->emul_temperature)
496 for (count = 0; count < tz->trips; count++) {
497 ret = tz->ops->get_trip_type(tz, count, &type);
498 if (!ret && type == THERMAL_TRIP_CRITICAL) {
499 ret = tz->ops->get_trip_temp(tz, count, &crit_temp);
507 if (*temp < crit_temp)
508 *temp = tz->emul_temperature;
511 mutex_unlock(&tz->lock);
515 EXPORT_SYMBOL_GPL(thermal_zone_get_temp);
517 static void update_temperature(struct thermal_zone_device *tz)
522 ret = thermal_zone_get_temp(tz, &temp);
525 dev_warn(&tz->device,
526 "failed to read out thermal zone (%d)\n",
531 mutex_lock(&tz->lock);
532 tz->last_temperature = tz->temperature;
533 tz->temperature = temp;
534 mutex_unlock(&tz->lock);
536 trace_thermal_temperature(tz);
537 dev_dbg(&tz->device, "last_temperature=%d, current_temperature=%d\n",
538 tz->last_temperature, tz->temperature);
541 void thermal_zone_device_update(struct thermal_zone_device *tz)
545 if (!tz->ops->get_temp)
548 update_temperature(tz);
550 for (count = 0; count < tz->trips; count++)
551 handle_thermal_trip(tz, count);
553 EXPORT_SYMBOL_GPL(thermal_zone_device_update);
555 static void thermal_zone_device_check(struct work_struct *work)
557 struct thermal_zone_device *tz = container_of(work, struct
560 thermal_zone_device_update(tz);
563 /* sys I/F for thermal zone */
565 #define to_thermal_zone(_dev) \
566 container_of(_dev, struct thermal_zone_device, device)
569 type_show(struct device *dev, struct device_attribute *attr, char *buf)
571 struct thermal_zone_device *tz = to_thermal_zone(dev);
573 return sprintf(buf, "%s\n", tz->type);
577 temp_show(struct device *dev, struct device_attribute *attr, char *buf)
579 struct thermal_zone_device *tz = to_thermal_zone(dev);
583 ret = thermal_zone_get_temp(tz, &temperature);
588 return sprintf(buf, "%ld\n", temperature);
592 mode_show(struct device *dev, struct device_attribute *attr, char *buf)
594 struct thermal_zone_device *tz = to_thermal_zone(dev);
595 enum thermal_device_mode mode;
598 if (!tz->ops->get_mode)
601 result = tz->ops->get_mode(tz, &mode);
605 return sprintf(buf, "%s\n", mode == THERMAL_DEVICE_ENABLED ? "enabled"
610 mode_store(struct device *dev, struct device_attribute *attr,
611 const char *buf, size_t count)
613 struct thermal_zone_device *tz = to_thermal_zone(dev);
616 if (!tz->ops->set_mode)
619 if (!strncmp(buf, "enabled", sizeof("enabled") - 1))
620 result = tz->ops->set_mode(tz, THERMAL_DEVICE_ENABLED);
621 else if (!strncmp(buf, "disabled", sizeof("disabled") - 1))
622 result = tz->ops->set_mode(tz, THERMAL_DEVICE_DISABLED);
633 trip_point_type_show(struct device *dev, struct device_attribute *attr,
636 struct thermal_zone_device *tz = to_thermal_zone(dev);
637 enum thermal_trip_type type;
640 if (!tz->ops->get_trip_type)
643 if (!sscanf(attr->attr.name, "trip_point_%d_type", &trip))
646 result = tz->ops->get_trip_type(tz, trip, &type);
651 case THERMAL_TRIP_CRITICAL:
652 return sprintf(buf, "critical\n");
653 case THERMAL_TRIP_HOT:
654 return sprintf(buf, "hot\n");
655 case THERMAL_TRIP_PASSIVE:
656 return sprintf(buf, "passive\n");
657 case THERMAL_TRIP_ACTIVE:
658 return sprintf(buf, "active\n");
660 return sprintf(buf, "unknown\n");
665 trip_point_temp_store(struct device *dev, struct device_attribute *attr,
666 const char *buf, size_t count)
668 struct thermal_zone_device *tz = to_thermal_zone(dev);
670 unsigned long temperature;
672 if (!tz->ops->set_trip_temp)
675 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
678 if (kstrtoul(buf, 10, &temperature))
681 ret = tz->ops->set_trip_temp(tz, trip, temperature);
683 return ret ? ret : count;
687 trip_point_temp_show(struct device *dev, struct device_attribute *attr,
690 struct thermal_zone_device *tz = to_thermal_zone(dev);
694 if (!tz->ops->get_trip_temp)
697 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
700 ret = tz->ops->get_trip_temp(tz, trip, &temperature);
705 return sprintf(buf, "%ld\n", temperature);
709 trip_point_hyst_store(struct device *dev, struct device_attribute *attr,
710 const char *buf, size_t count)
712 struct thermal_zone_device *tz = to_thermal_zone(dev);
714 unsigned long temperature;
716 if (!tz->ops->set_trip_hyst)
719 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
722 if (kstrtoul(buf, 10, &temperature))
726 * We are not doing any check on the 'temperature' value
727 * here. The driver implementing 'set_trip_hyst' has to
730 ret = tz->ops->set_trip_hyst(tz, trip, temperature);
732 return ret ? ret : count;
736 trip_point_hyst_show(struct device *dev, struct device_attribute *attr,
739 struct thermal_zone_device *tz = to_thermal_zone(dev);
741 unsigned long temperature;
743 if (!tz->ops->get_trip_hyst)
746 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
749 ret = tz->ops->get_trip_hyst(tz, trip, &temperature);
751 return ret ? ret : sprintf(buf, "%ld\n", temperature);
755 passive_store(struct device *dev, struct device_attribute *attr,
756 const char *buf, size_t count)
758 struct thermal_zone_device *tz = to_thermal_zone(dev);
759 struct thermal_cooling_device *cdev = NULL;
762 if (!sscanf(buf, "%d\n", &state))
765 /* sanity check: values below 1000 millicelcius don't make sense
766 * and can cause the system to go into a thermal heart attack
768 if (state && state < 1000)
771 if (state && !tz->forced_passive) {
772 mutex_lock(&thermal_list_lock);
773 list_for_each_entry(cdev, &thermal_cdev_list, node) {
774 if (!strncmp("Processor", cdev->type,
775 sizeof("Processor")))
776 thermal_zone_bind_cooling_device(tz,
777 THERMAL_TRIPS_NONE, cdev,
780 THERMAL_WEIGHT_DEFAULT);
782 mutex_unlock(&thermal_list_lock);
783 if (!tz->passive_delay)
784 tz->passive_delay = 1000;
785 } else if (!state && tz->forced_passive) {
786 mutex_lock(&thermal_list_lock);
787 list_for_each_entry(cdev, &thermal_cdev_list, node) {
788 if (!strncmp("Processor", cdev->type,
789 sizeof("Processor")))
790 thermal_zone_unbind_cooling_device(tz,
794 mutex_unlock(&thermal_list_lock);
795 tz->passive_delay = 0;
798 tz->forced_passive = state;
800 thermal_zone_device_update(tz);
806 passive_show(struct device *dev, struct device_attribute *attr,
809 struct thermal_zone_device *tz = to_thermal_zone(dev);
811 return sprintf(buf, "%d\n", tz->forced_passive);
815 policy_store(struct device *dev, struct device_attribute *attr,
816 const char *buf, size_t count)
819 struct thermal_zone_device *tz = to_thermal_zone(dev);
820 struct thermal_governor *gov;
821 char name[THERMAL_NAME_LENGTH];
823 snprintf(name, sizeof(name), "%s", buf);
825 mutex_lock(&thermal_governor_lock);
826 mutex_lock(&tz->lock);
828 gov = __find_governor(strim(name));
832 ret = thermal_set_governor(tz, gov);
837 mutex_unlock(&tz->lock);
838 mutex_unlock(&thermal_governor_lock);
843 policy_show(struct device *dev, struct device_attribute *devattr, char *buf)
845 struct thermal_zone_device *tz = to_thermal_zone(dev);
847 return sprintf(buf, "%s\n", tz->governor->name);
850 #ifdef CONFIG_THERMAL_EMULATION
852 emul_temp_store(struct device *dev, struct device_attribute *attr,
853 const char *buf, size_t count)
855 struct thermal_zone_device *tz = to_thermal_zone(dev);
857 unsigned long temperature;
859 if (kstrtoul(buf, 10, &temperature))
862 if (!tz->ops->set_emul_temp) {
863 mutex_lock(&tz->lock);
864 tz->emul_temperature = temperature;
865 mutex_unlock(&tz->lock);
867 ret = tz->ops->set_emul_temp(tz, temperature);
871 thermal_zone_device_update(tz);
873 return ret ? ret : count;
875 static DEVICE_ATTR(emul_temp, S_IWUSR, NULL, emul_temp_store);
876 #endif/*CONFIG_THERMAL_EMULATION*/
879 sustainable_power_show(struct device *dev, struct device_attribute *devattr,
882 struct thermal_zone_device *tz = to_thermal_zone(dev);
885 return sprintf(buf, "%u\n", tz->tzp->sustainable_power);
891 sustainable_power_store(struct device *dev, struct device_attribute *devattr,
892 const char *buf, size_t count)
894 struct thermal_zone_device *tz = to_thermal_zone(dev);
895 u32 sustainable_power;
900 if (kstrtou32(buf, 10, &sustainable_power))
903 tz->tzp->sustainable_power = sustainable_power;
907 static DEVICE_ATTR(sustainable_power, S_IWUSR | S_IRUGO, sustainable_power_show,
908 sustainable_power_store);
910 #define create_s32_tzp_attr(name) \
912 name##_show(struct device *dev, struct device_attribute *devattr, \
915 struct thermal_zone_device *tz = to_thermal_zone(dev); \
918 return sprintf(buf, "%u\n", tz->tzp->name); \
924 name##_store(struct device *dev, struct device_attribute *devattr, \
925 const char *buf, size_t count) \
927 struct thermal_zone_device *tz = to_thermal_zone(dev); \
933 if (kstrtos32(buf, 10, &value)) \
936 tz->tzp->name = value; \
940 static DEVICE_ATTR(name, S_IWUSR | S_IRUGO, name##_show, name##_store)
942 create_s32_tzp_attr(k_po);
943 create_s32_tzp_attr(k_pu);
944 create_s32_tzp_attr(k_i);
945 create_s32_tzp_attr(k_d);
946 create_s32_tzp_attr(integral_cutoff);
947 create_s32_tzp_attr(slope);
948 create_s32_tzp_attr(offset);
949 #undef create_s32_tzp_attr
951 static struct device_attribute *dev_tzp_attrs[] = {
952 &dev_attr_sustainable_power,
957 &dev_attr_integral_cutoff,
962 static int create_tzp_attrs(struct device *dev)
966 for (i = 0; i < ARRAY_SIZE(dev_tzp_attrs); i++) {
968 struct device_attribute *dev_attr = dev_tzp_attrs[i];
970 ret = device_create_file(dev, dev_attr);
979 * power_actor_get_max_power() - get the maximum power that a cdev can consume
980 * @cdev: pointer to &thermal_cooling_device
981 * @tz: a valid thermal zone device pointer
982 * @max_power: pointer in which to store the maximum power
984 * Calculate the maximum power consumption in milliwats that the
985 * cooling device can currently consume and store it in @max_power.
987 * Return: 0 on success, -EINVAL if @cdev doesn't support the
988 * power_actor API or -E* on other error.
990 int power_actor_get_max_power(struct thermal_cooling_device *cdev,
991 struct thermal_zone_device *tz, u32 *max_power)
993 if (!cdev_is_power_actor(cdev))
996 return cdev->ops->state2power(cdev, tz, 0, max_power);
1000 * power_actor_set_power() - limit the maximum power that a cooling device can consume
1001 * @cdev: pointer to &thermal_cooling_device
1002 * @instance: thermal instance to update
1003 * @power: the power in milliwatts
1005 * Set the cooling device to consume at most @power milliwatts.
1007 * Return: 0 on success, -EINVAL if the cooling device does not
1008 * implement the power actor API or -E* for other failures.
1010 int power_actor_set_power(struct thermal_cooling_device *cdev,
1011 struct thermal_instance *instance, u32 power)
1013 unsigned long state;
1016 if (!cdev_is_power_actor(cdev))
1019 ret = cdev->ops->power2state(cdev, instance->tz, power, &state);
1023 instance->target = state;
1024 cdev->updated = false;
1025 thermal_cdev_update(cdev);
1030 static DEVICE_ATTR(type, 0444, type_show, NULL);
1031 static DEVICE_ATTR(temp, 0444, temp_show, NULL);
1032 static DEVICE_ATTR(mode, 0644, mode_show, mode_store);
1033 static DEVICE_ATTR(passive, S_IRUGO | S_IWUSR, passive_show, passive_store);
1034 static DEVICE_ATTR(policy, S_IRUGO | S_IWUSR, policy_show, policy_store);
1036 /* sys I/F for cooling device */
1037 #define to_cooling_device(_dev) \
1038 container_of(_dev, struct thermal_cooling_device, device)
1041 thermal_cooling_device_type_show(struct device *dev,
1042 struct device_attribute *attr, char *buf)
1044 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1046 return sprintf(buf, "%s\n", cdev->type);
1050 thermal_cooling_device_max_state_show(struct device *dev,
1051 struct device_attribute *attr, char *buf)
1053 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1054 unsigned long state;
1057 ret = cdev->ops->get_max_state(cdev, &state);
1060 return sprintf(buf, "%ld\n", state);
1064 thermal_cooling_device_cur_state_show(struct device *dev,
1065 struct device_attribute *attr, char *buf)
1067 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1068 unsigned long state;
1071 ret = cdev->ops->get_cur_state(cdev, &state);
1074 return sprintf(buf, "%ld\n", state);
1078 thermal_cooling_device_cur_state_store(struct device *dev,
1079 struct device_attribute *attr,
1080 const char *buf, size_t count)
1082 struct thermal_cooling_device *cdev = to_cooling_device(dev);
1083 unsigned long state;
1086 if (!sscanf(buf, "%ld\n", &state))
1089 if ((long)state < 0)
1092 result = cdev->ops->set_cur_state(cdev, state);
1098 static struct device_attribute dev_attr_cdev_type =
1099 __ATTR(type, 0444, thermal_cooling_device_type_show, NULL);
1100 static DEVICE_ATTR(max_state, 0444,
1101 thermal_cooling_device_max_state_show, NULL);
1102 static DEVICE_ATTR(cur_state, 0644,
1103 thermal_cooling_device_cur_state_show,
1104 thermal_cooling_device_cur_state_store);
1107 thermal_cooling_device_trip_point_show(struct device *dev,
1108 struct device_attribute *attr, char *buf)
1110 struct thermal_instance *instance;
1113 container_of(attr, struct thermal_instance, attr);
1115 if (instance->trip == THERMAL_TRIPS_NONE)
1116 return sprintf(buf, "-1\n");
1118 return sprintf(buf, "%d\n", instance->trip);
1121 static struct attribute *cooling_device_attrs[] = {
1122 &dev_attr_cdev_type.attr,
1123 &dev_attr_max_state.attr,
1124 &dev_attr_cur_state.attr,
1128 static const struct attribute_group cooling_device_attr_group = {
1129 .attrs = cooling_device_attrs,
1132 static const struct attribute_group *cooling_device_attr_groups[] = {
1133 &cooling_device_attr_group,
1138 thermal_cooling_device_weight_show(struct device *dev,
1139 struct device_attribute *attr, char *buf)
1141 struct thermal_instance *instance;
1143 instance = container_of(attr, struct thermal_instance, weight_attr);
1145 return sprintf(buf, "%d\n", instance->weight);
1149 thermal_cooling_device_weight_store(struct device *dev,
1150 struct device_attribute *attr,
1151 const char *buf, size_t count)
1153 struct thermal_instance *instance;
1156 ret = kstrtoint(buf, 0, &weight);
1160 instance = container_of(attr, struct thermal_instance, weight_attr);
1161 instance->weight = weight;
1165 /* Device management */
1168 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
1169 * @tz: pointer to struct thermal_zone_device
1170 * @trip: indicates which trip point the cooling devices is
1171 * associated with in this thermal zone.
1172 * @cdev: pointer to struct thermal_cooling_device
1173 * @upper: the Maximum cooling state for this trip point.
1174 * THERMAL_NO_LIMIT means no upper limit,
1175 * and the cooling device can be in max_state.
1176 * @lower: the Minimum cooling state can be used for this trip point.
1177 * THERMAL_NO_LIMIT means no lower limit,
1178 * and the cooling device can be in cooling state 0.
1179 * @weight: The weight of the cooling device to be bound to the
1180 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
1183 * This interface function bind a thermal cooling device to the certain trip
1184 * point of a thermal zone device.
1185 * This function is usually called in the thermal zone device .bind callback.
1187 * Return: 0 on success, the proper error value otherwise.
1189 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
1191 struct thermal_cooling_device *cdev,
1192 unsigned long upper, unsigned long lower,
1193 unsigned int weight)
1195 struct thermal_instance *dev;
1196 struct thermal_instance *pos;
1197 struct thermal_zone_device *pos1;
1198 struct thermal_cooling_device *pos2;
1199 unsigned long max_state;
1202 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
1205 list_for_each_entry(pos1, &thermal_tz_list, node) {
1209 list_for_each_entry(pos2, &thermal_cdev_list, node) {
1214 if (tz != pos1 || cdev != pos2)
1217 ret = cdev->ops->get_max_state(cdev, &max_state);
1221 /* lower default 0, upper default max_state */
1222 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
1223 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
1225 if (lower > upper || upper > max_state)
1229 kzalloc(sizeof(struct thermal_instance), GFP_KERNEL);
1237 dev->target = THERMAL_NO_TARGET;
1238 dev->weight = weight;
1240 result = get_idr(&tz->idr, &tz->lock, &dev->id);
1244 sprintf(dev->name, "cdev%d", dev->id);
1246 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
1250 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
1251 sysfs_attr_init(&dev->attr.attr);
1252 dev->attr.attr.name = dev->attr_name;
1253 dev->attr.attr.mode = 0444;
1254 dev->attr.show = thermal_cooling_device_trip_point_show;
1255 result = device_create_file(&tz->device, &dev->attr);
1257 goto remove_symbol_link;
1259 sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
1260 sysfs_attr_init(&dev->weight_attr.attr);
1261 dev->weight_attr.attr.name = dev->weight_attr_name;
1262 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
1263 dev->weight_attr.show = thermal_cooling_device_weight_show;
1264 dev->weight_attr.store = thermal_cooling_device_weight_store;
1265 result = device_create_file(&tz->device, &dev->weight_attr);
1267 goto remove_trip_file;
1269 mutex_lock(&tz->lock);
1270 mutex_lock(&cdev->lock);
1271 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
1272 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1277 list_add_tail(&dev->tz_node, &tz->thermal_instances);
1278 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
1280 mutex_unlock(&cdev->lock);
1281 mutex_unlock(&tz->lock);
1286 device_remove_file(&tz->device, &dev->weight_attr);
1288 device_remove_file(&tz->device, &dev->attr);
1290 sysfs_remove_link(&tz->device.kobj, dev->name);
1292 release_idr(&tz->idr, &tz->lock, dev->id);
1297 EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
1300 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
1302 * @tz: pointer to a struct thermal_zone_device.
1303 * @trip: indicates which trip point the cooling devices is
1304 * associated with in this thermal zone.
1305 * @cdev: pointer to a struct thermal_cooling_device.
1307 * This interface function unbind a thermal cooling device from the certain
1308 * trip point of a thermal zone device.
1309 * This function is usually called in the thermal zone device .unbind callback.
1311 * Return: 0 on success, the proper error value otherwise.
1313 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
1315 struct thermal_cooling_device *cdev)
1317 struct thermal_instance *pos, *next;
1319 mutex_lock(&tz->lock);
1320 mutex_lock(&cdev->lock);
1321 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
1322 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
1323 list_del(&pos->tz_node);
1324 list_del(&pos->cdev_node);
1325 mutex_unlock(&cdev->lock);
1326 mutex_unlock(&tz->lock);
1330 mutex_unlock(&cdev->lock);
1331 mutex_unlock(&tz->lock);
1336 device_remove_file(&tz->device, &pos->weight_attr);
1337 device_remove_file(&tz->device, &pos->attr);
1338 sysfs_remove_link(&tz->device.kobj, pos->name);
1339 release_idr(&tz->idr, &tz->lock, pos->id);
1343 EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
1345 static void thermal_release(struct device *dev)
1347 struct thermal_zone_device *tz;
1348 struct thermal_cooling_device *cdev;
1350 if (!strncmp(dev_name(dev), "thermal_zone",
1351 sizeof("thermal_zone") - 1)) {
1352 tz = to_thermal_zone(dev);
1354 } else if(!strncmp(dev_name(dev), "cooling_device",
1355 sizeof("cooling_device") - 1)){
1356 cdev = to_cooling_device(dev);
1361 static struct class thermal_class = {
1363 .dev_release = thermal_release,
1367 * __thermal_cooling_device_register() - register a new thermal cooling device
1368 * @np: a pointer to a device tree node.
1369 * @type: the thermal cooling device type.
1370 * @devdata: device private data.
1371 * @ops: standard thermal cooling devices callbacks.
1373 * This interface function adds a new thermal cooling device (fan/processor/...)
1374 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1375 * to all the thermal zone devices registered at the same time.
1376 * It also gives the opportunity to link the cooling device to a device tree
1377 * node, so that it can be bound to a thermal zone created out of device tree.
1379 * Return: a pointer to the created struct thermal_cooling_device or an
1380 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1382 static struct thermal_cooling_device *
1383 __thermal_cooling_device_register(struct device_node *np,
1384 char *type, void *devdata,
1385 const struct thermal_cooling_device_ops *ops)
1387 struct thermal_cooling_device *cdev;
1390 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1391 return ERR_PTR(-EINVAL);
1393 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
1394 !ops->set_cur_state)
1395 return ERR_PTR(-EINVAL);
1397 cdev = kzalloc(sizeof(struct thermal_cooling_device), GFP_KERNEL);
1399 return ERR_PTR(-ENOMEM);
1401 result = get_idr(&thermal_cdev_idr, &thermal_idr_lock, &cdev->id);
1404 return ERR_PTR(result);
1407 strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
1408 mutex_init(&cdev->lock);
1409 INIT_LIST_HEAD(&cdev->thermal_instances);
1412 cdev->updated = false;
1413 cdev->device.class = &thermal_class;
1414 cdev->device.groups = cooling_device_attr_groups;
1415 cdev->devdata = devdata;
1416 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
1417 result = device_register(&cdev->device);
1419 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1421 return ERR_PTR(result);
1424 /* Add 'this' new cdev to the global cdev list */
1425 mutex_lock(&thermal_list_lock);
1426 list_add(&cdev->node, &thermal_cdev_list);
1427 mutex_unlock(&thermal_list_lock);
1429 /* Update binding information for 'this' new cdev */
1436 * thermal_cooling_device_register() - register a new thermal cooling device
1437 * @type: the thermal cooling device type.
1438 * @devdata: device private data.
1439 * @ops: standard thermal cooling devices callbacks.
1441 * This interface function adds a new thermal cooling device (fan/processor/...)
1442 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1443 * to all the thermal zone devices registered at the same time.
1445 * Return: a pointer to the created struct thermal_cooling_device or an
1446 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1448 struct thermal_cooling_device *
1449 thermal_cooling_device_register(char *type, void *devdata,
1450 const struct thermal_cooling_device_ops *ops)
1452 return __thermal_cooling_device_register(NULL, type, devdata, ops);
1454 EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
1457 * thermal_of_cooling_device_register() - register an OF thermal cooling device
1458 * @np: a pointer to a device tree node.
1459 * @type: the thermal cooling device type.
1460 * @devdata: device private data.
1461 * @ops: standard thermal cooling devices callbacks.
1463 * This function will register a cooling device with device tree node reference.
1464 * This interface function adds a new thermal cooling device (fan/processor/...)
1465 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1466 * to all the thermal zone devices registered at the same time.
1468 * Return: a pointer to the created struct thermal_cooling_device or an
1469 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1471 struct thermal_cooling_device *
1472 thermal_of_cooling_device_register(struct device_node *np,
1473 char *type, void *devdata,
1474 const struct thermal_cooling_device_ops *ops)
1476 return __thermal_cooling_device_register(np, type, devdata, ops);
1478 EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
1481 * thermal_cooling_device_unregister - removes the registered thermal cooling device
1482 * @cdev: the thermal cooling device to remove.
1484 * thermal_cooling_device_unregister() must be called when the device is no
1487 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1490 const struct thermal_zone_params *tzp;
1491 struct thermal_zone_device *tz;
1492 struct thermal_cooling_device *pos = NULL;
1497 mutex_lock(&thermal_list_lock);
1498 list_for_each_entry(pos, &thermal_cdev_list, node)
1502 /* thermal cooling device not found */
1503 mutex_unlock(&thermal_list_lock);
1506 list_del(&cdev->node);
1508 /* Unbind all thermal zones associated with 'this' cdev */
1509 list_for_each_entry(tz, &thermal_tz_list, node) {
1510 if (tz->ops->unbind) {
1511 tz->ops->unbind(tz, cdev);
1515 if (!tz->tzp || !tz->tzp->tbp)
1519 for (i = 0; i < tzp->num_tbps; i++) {
1520 if (tzp->tbp[i].cdev == cdev) {
1521 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1522 tzp->tbp[i].cdev = NULL;
1527 mutex_unlock(&thermal_list_lock);
1530 device_remove_file(&cdev->device, &dev_attr_cdev_type);
1531 device_remove_file(&cdev->device, &dev_attr_max_state);
1532 device_remove_file(&cdev->device, &dev_attr_cur_state);
1534 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1535 device_unregister(&cdev->device);
1538 EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1540 void thermal_cdev_update(struct thermal_cooling_device *cdev)
1542 struct thermal_instance *instance;
1543 unsigned long target = 0;
1545 /* cooling device is updated*/
1549 mutex_lock(&cdev->lock);
1550 /* Make sure cdev enters the deepest cooling state */
1551 list_for_each_entry(instance, &cdev->thermal_instances, cdev_node) {
1552 dev_dbg(&cdev->device, "zone%d->target=%lu\n",
1553 instance->tz->id, instance->target);
1554 if (instance->target == THERMAL_NO_TARGET)
1556 if (instance->target > target)
1557 target = instance->target;
1559 mutex_unlock(&cdev->lock);
1560 cdev->ops->set_cur_state(cdev, target);
1561 cdev->updated = true;
1562 trace_cdev_update(cdev, target);
1563 dev_dbg(&cdev->device, "set to state %lu\n", target);
1565 EXPORT_SYMBOL(thermal_cdev_update);
1568 * thermal_notify_framework - Sensor drivers use this API to notify framework
1569 * @tz: thermal zone device
1570 * @trip: indicates which trip point has been crossed
1572 * This function handles the trip events from sensor drivers. It starts
1573 * throttling the cooling devices according to the policy configured.
1574 * For CRITICAL and HOT trip points, this notifies the respective drivers,
1575 * and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
1576 * The throttling policy is based on the configured platform data; if no
1577 * platform data is provided, this uses the step_wise throttling policy.
1579 void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
1581 handle_thermal_trip(tz, trip);
1583 EXPORT_SYMBOL_GPL(thermal_notify_framework);
1586 * create_trip_attrs() - create attributes for trip points
1587 * @tz: the thermal zone device
1588 * @mask: Writeable trip point bitmap.
1590 * helper function to instantiate sysfs entries for every trip
1591 * point and its properties of a struct thermal_zone_device.
1593 * Return: 0 on success, the proper error value otherwise.
1595 static int create_trip_attrs(struct thermal_zone_device *tz, int mask)
1598 int size = sizeof(struct thermal_attr) * tz->trips;
1600 tz->trip_type_attrs = kzalloc(size, GFP_KERNEL);
1601 if (!tz->trip_type_attrs)
1604 tz->trip_temp_attrs = kzalloc(size, GFP_KERNEL);
1605 if (!tz->trip_temp_attrs) {
1606 kfree(tz->trip_type_attrs);
1610 if (tz->ops->get_trip_hyst) {
1611 tz->trip_hyst_attrs = kzalloc(size, GFP_KERNEL);
1612 if (!tz->trip_hyst_attrs) {
1613 kfree(tz->trip_type_attrs);
1614 kfree(tz->trip_temp_attrs);
1620 for (indx = 0; indx < tz->trips; indx++) {
1621 /* create trip type attribute */
1622 snprintf(tz->trip_type_attrs[indx].name, THERMAL_NAME_LENGTH,
1623 "trip_point_%d_type", indx);
1625 sysfs_attr_init(&tz->trip_type_attrs[indx].attr.attr);
1626 tz->trip_type_attrs[indx].attr.attr.name =
1627 tz->trip_type_attrs[indx].name;
1628 tz->trip_type_attrs[indx].attr.attr.mode = S_IRUGO;
1629 tz->trip_type_attrs[indx].attr.show = trip_point_type_show;
1631 device_create_file(&tz->device,
1632 &tz->trip_type_attrs[indx].attr);
1634 /* create trip temp attribute */
1635 snprintf(tz->trip_temp_attrs[indx].name, THERMAL_NAME_LENGTH,
1636 "trip_point_%d_temp", indx);
1638 sysfs_attr_init(&tz->trip_temp_attrs[indx].attr.attr);
1639 tz->trip_temp_attrs[indx].attr.attr.name =
1640 tz->trip_temp_attrs[indx].name;
1641 tz->trip_temp_attrs[indx].attr.attr.mode = S_IRUGO;
1642 tz->trip_temp_attrs[indx].attr.show = trip_point_temp_show;
1643 if (IS_ENABLED(CONFIG_THERMAL_WRITABLE_TRIPS) &&
1644 mask & (1 << indx)) {
1645 tz->trip_temp_attrs[indx].attr.attr.mode |= S_IWUSR;
1646 tz->trip_temp_attrs[indx].attr.store =
1647 trip_point_temp_store;
1650 device_create_file(&tz->device,
1651 &tz->trip_temp_attrs[indx].attr);
1653 /* create Optional trip hyst attribute */
1654 if (!tz->ops->get_trip_hyst)
1656 snprintf(tz->trip_hyst_attrs[indx].name, THERMAL_NAME_LENGTH,
1657 "trip_point_%d_hyst", indx);
1659 sysfs_attr_init(&tz->trip_hyst_attrs[indx].attr.attr);
1660 tz->trip_hyst_attrs[indx].attr.attr.name =
1661 tz->trip_hyst_attrs[indx].name;
1662 tz->trip_hyst_attrs[indx].attr.attr.mode = S_IRUGO;
1663 tz->trip_hyst_attrs[indx].attr.show = trip_point_hyst_show;
1664 if (tz->ops->set_trip_hyst) {
1665 tz->trip_hyst_attrs[indx].attr.attr.mode |= S_IWUSR;
1666 tz->trip_hyst_attrs[indx].attr.store =
1667 trip_point_hyst_store;
1670 device_create_file(&tz->device,
1671 &tz->trip_hyst_attrs[indx].attr);
1676 static void remove_trip_attrs(struct thermal_zone_device *tz)
1680 for (indx = 0; indx < tz->trips; indx++) {
1681 device_remove_file(&tz->device,
1682 &tz->trip_type_attrs[indx].attr);
1683 device_remove_file(&tz->device,
1684 &tz->trip_temp_attrs[indx].attr);
1685 if (tz->ops->get_trip_hyst)
1686 device_remove_file(&tz->device,
1687 &tz->trip_hyst_attrs[indx].attr);
1689 kfree(tz->trip_type_attrs);
1690 kfree(tz->trip_temp_attrs);
1691 kfree(tz->trip_hyst_attrs);
1695 * thermal_zone_device_register() - register a new thermal zone device
1696 * @type: the thermal zone device type
1697 * @trips: the number of trip points the thermal zone support
1698 * @mask: a bit string indicating the writeablility of trip points
1699 * @devdata: private device data
1700 * @ops: standard thermal zone device callbacks
1701 * @tzp: thermal zone platform parameters
1702 * @passive_delay: number of milliseconds to wait between polls when
1703 * performing passive cooling
1704 * @polling_delay: number of milliseconds to wait between polls when checking
1705 * whether trip points have been crossed (0 for interrupt
1708 * This interface function adds a new thermal zone device (sensor) to
1709 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1710 * thermal cooling devices registered at the same time.
1711 * thermal_zone_device_unregister() must be called when the device is no
1712 * longer needed. The passive cooling depends on the .get_trend() return value.
1714 * Return: a pointer to the created struct thermal_zone_device or an
1715 * in case of error, an ERR_PTR. Caller must check return value with
1716 * IS_ERR*() helpers.
1718 struct thermal_zone_device *thermal_zone_device_register(const char *type,
1719 int trips, int mask, void *devdata,
1720 struct thermal_zone_device_ops *ops,
1721 struct thermal_zone_params *tzp,
1722 int passive_delay, int polling_delay)
1724 struct thermal_zone_device *tz;
1725 enum thermal_trip_type trip_type;
1729 struct thermal_governor *governor;
1731 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1732 return ERR_PTR(-EINVAL);
1734 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
1735 return ERR_PTR(-EINVAL);
1738 return ERR_PTR(-EINVAL);
1740 if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
1741 return ERR_PTR(-EINVAL);
1743 tz = kzalloc(sizeof(struct thermal_zone_device), GFP_KERNEL);
1745 return ERR_PTR(-ENOMEM);
1747 INIT_LIST_HEAD(&tz->thermal_instances);
1749 mutex_init(&tz->lock);
1750 result = get_idr(&thermal_tz_idr, &thermal_idr_lock, &tz->id);
1753 return ERR_PTR(result);
1756 strlcpy(tz->type, type ? : "", sizeof(tz->type));
1759 tz->device.class = &thermal_class;
1760 tz->devdata = devdata;
1762 tz->passive_delay = passive_delay;
1763 tz->polling_delay = polling_delay;
1765 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1766 result = device_register(&tz->device);
1768 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1770 return ERR_PTR(result);
1775 result = device_create_file(&tz->device, &dev_attr_type);
1780 result = device_create_file(&tz->device, &dev_attr_temp);
1784 if (ops->get_mode) {
1785 result = device_create_file(&tz->device, &dev_attr_mode);
1790 result = create_trip_attrs(tz, mask);
1794 for (count = 0; count < trips; count++) {
1795 tz->ops->get_trip_type(tz, count, &trip_type);
1796 if (trip_type == THERMAL_TRIP_PASSIVE)
1801 result = device_create_file(&tz->device, &dev_attr_passive);
1806 #ifdef CONFIG_THERMAL_EMULATION
1807 result = device_create_file(&tz->device, &dev_attr_emul_temp);
1811 /* Create policy attribute */
1812 result = device_create_file(&tz->device, &dev_attr_policy);
1816 /* Add thermal zone params */
1817 result = create_tzp_attrs(&tz->device);
1821 /* Update 'this' zone's governor information */
1822 mutex_lock(&thermal_governor_lock);
1825 governor = __find_governor(tz->tzp->governor_name);
1827 governor = def_governor;
1829 result = thermal_set_governor(tz, governor);
1831 mutex_unlock(&thermal_governor_lock);
1835 mutex_unlock(&thermal_governor_lock);
1837 if (!tz->tzp || !tz->tzp->no_hwmon) {
1838 result = thermal_add_hwmon_sysfs(tz);
1843 mutex_lock(&thermal_list_lock);
1844 list_add_tail(&tz->node, &thermal_tz_list);
1845 mutex_unlock(&thermal_list_lock);
1847 /* Bind cooling devices for this zone */
1850 INIT_DELAYED_WORK(&(tz->poll_queue), thermal_zone_device_check);
1852 if (!tz->ops->get_temp)
1853 thermal_zone_device_set_polling(tz, 0);
1855 thermal_zone_device_update(tz);
1860 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1861 device_unregister(&tz->device);
1862 return ERR_PTR(result);
1864 EXPORT_SYMBOL_GPL(thermal_zone_device_register);
1867 * thermal_device_unregister - removes the registered thermal zone device
1868 * @tz: the thermal zone device to remove
1870 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1873 const struct thermal_zone_params *tzp;
1874 struct thermal_cooling_device *cdev;
1875 struct thermal_zone_device *pos = NULL;
1882 mutex_lock(&thermal_list_lock);
1883 list_for_each_entry(pos, &thermal_tz_list, node)
1887 /* thermal zone device not found */
1888 mutex_unlock(&thermal_list_lock);
1891 list_del(&tz->node);
1893 /* Unbind all cdevs associated with 'this' thermal zone */
1894 list_for_each_entry(cdev, &thermal_cdev_list, node) {
1895 if (tz->ops->unbind) {
1896 tz->ops->unbind(tz, cdev);
1900 if (!tzp || !tzp->tbp)
1903 for (i = 0; i < tzp->num_tbps; i++) {
1904 if (tzp->tbp[i].cdev == cdev) {
1905 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1906 tzp->tbp[i].cdev = NULL;
1911 mutex_unlock(&thermal_list_lock);
1913 thermal_zone_device_set_polling(tz, 0);
1916 device_remove_file(&tz->device, &dev_attr_type);
1917 device_remove_file(&tz->device, &dev_attr_temp);
1918 if (tz->ops->get_mode)
1919 device_remove_file(&tz->device, &dev_attr_mode);
1920 device_remove_file(&tz->device, &dev_attr_policy);
1921 remove_trip_attrs(tz);
1922 thermal_set_governor(tz, NULL);
1924 thermal_remove_hwmon_sysfs(tz);
1925 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1926 idr_destroy(&tz->idr);
1927 mutex_destroy(&tz->lock);
1928 device_unregister(&tz->device);
1931 EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
1934 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
1935 * @name: thermal zone name to fetch the temperature
1937 * When only one zone is found with the passed name, returns a reference to it.
1939 * Return: On success returns a reference to an unique thermal zone with
1940 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
1941 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
1943 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
1945 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
1946 unsigned int found = 0;
1951 mutex_lock(&thermal_list_lock);
1952 list_for_each_entry(pos, &thermal_tz_list, node)
1953 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
1957 mutex_unlock(&thermal_list_lock);
1959 /* nothing has been found, thus an error code for it */
1961 ref = ERR_PTR(-ENODEV);
1963 /* Success only when an unique zone is found */
1964 ref = ERR_PTR(-EEXIST);
1969 EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
1972 static const struct genl_multicast_group thermal_event_mcgrps[] = {
1973 { .name = THERMAL_GENL_MCAST_GROUP_NAME, },
1976 static struct genl_family thermal_event_genl_family = {
1977 .id = GENL_ID_GENERATE,
1978 .name = THERMAL_GENL_FAMILY_NAME,
1979 .version = THERMAL_GENL_VERSION,
1980 .maxattr = THERMAL_GENL_ATTR_MAX,
1981 .mcgrps = thermal_event_mcgrps,
1982 .n_mcgrps = ARRAY_SIZE(thermal_event_mcgrps),
1985 int thermal_generate_netlink_event(struct thermal_zone_device *tz,
1988 struct sk_buff *skb;
1989 struct nlattr *attr;
1990 struct thermal_genl_event *thermal_event;
1994 static unsigned int thermal_event_seqnum;
1999 /* allocate memory */
2000 size = nla_total_size(sizeof(struct thermal_genl_event)) +
2003 skb = genlmsg_new(size, GFP_ATOMIC);
2007 /* add the genetlink message header */
2008 msg_header = genlmsg_put(skb, 0, thermal_event_seqnum++,
2009 &thermal_event_genl_family, 0,
2010 THERMAL_GENL_CMD_EVENT);
2017 attr = nla_reserve(skb, THERMAL_GENL_ATTR_EVENT,
2018 sizeof(struct thermal_genl_event));
2025 thermal_event = nla_data(attr);
2026 if (!thermal_event) {
2031 memset(thermal_event, 0, sizeof(struct thermal_genl_event));
2033 thermal_event->orig = tz->id;
2034 thermal_event->event = event;
2036 /* send multicast genetlink message */
2037 genlmsg_end(skb, msg_header);
2039 result = genlmsg_multicast(&thermal_event_genl_family, skb, 0,
2042 dev_err(&tz->device, "Failed to send netlink event:%d", result);
2046 EXPORT_SYMBOL_GPL(thermal_generate_netlink_event);
2048 static int genetlink_init(void)
2050 return genl_register_family(&thermal_event_genl_family);
2053 static void genetlink_exit(void)
2055 genl_unregister_family(&thermal_event_genl_family);
2057 #else /* !CONFIG_NET */
2058 static inline int genetlink_init(void) { return 0; }
2059 static inline void genetlink_exit(void) {}
2060 #endif /* !CONFIG_NET */
2062 static int __init thermal_register_governors(void)
2066 result = thermal_gov_step_wise_register();
2070 result = thermal_gov_fair_share_register();
2074 result = thermal_gov_bang_bang_register();
2078 result = thermal_gov_user_space_register();
2082 return thermal_gov_power_allocator_register();
2085 static void thermal_unregister_governors(void)
2087 thermal_gov_step_wise_unregister();
2088 thermal_gov_fair_share_unregister();
2089 thermal_gov_bang_bang_unregister();
2090 thermal_gov_user_space_unregister();
2091 thermal_gov_power_allocator_unregister();
2094 static int __init thermal_init(void)
2098 result = thermal_register_governors();
2102 result = class_register(&thermal_class);
2104 goto unregister_governors;
2106 result = genetlink_init();
2108 goto unregister_class;
2110 result = of_parse_thermal_zones();
2119 class_unregister(&thermal_class);
2120 unregister_governors:
2121 thermal_unregister_governors();
2123 idr_destroy(&thermal_tz_idr);
2124 idr_destroy(&thermal_cdev_idr);
2125 mutex_destroy(&thermal_idr_lock);
2126 mutex_destroy(&thermal_list_lock);
2127 mutex_destroy(&thermal_governor_lock);
2131 static void __exit thermal_exit(void)
2133 of_thermal_destroy_zones();
2135 class_unregister(&thermal_class);
2136 thermal_unregister_governors();
2137 idr_destroy(&thermal_tz_idr);
2138 idr_destroy(&thermal_cdev_idr);
2139 mutex_destroy(&thermal_idr_lock);
2140 mutex_destroy(&thermal_list_lock);
2141 mutex_destroy(&thermal_governor_lock);
2144 fs_initcall(thermal_init);
2145 module_exit(thermal_exit);