1 // SPDX-License-Identifier: GPL-2.0
3 * thermal.c - Generic Thermal Management Sysfs support.
5 * Copyright (C) 2008 Intel Corp
6 * Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
7 * Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 #include <linux/device.h>
13 #include <linux/err.h>
14 #include <linux/export.h>
15 #include <linux/slab.h>
16 #include <linux/kdev_t.h>
17 #include <linux/idr.h>
18 #include <linux/thermal.h>
19 #include <linux/reboot.h>
20 #include <linux/string.h>
22 #include <linux/suspend.h>
24 #define CREATE_TRACE_POINTS
25 #include "thermal_trace.h"
27 #include "thermal_core.h"
28 #include "thermal_hwmon.h"
30 static DEFINE_IDA(thermal_tz_ida);
31 static DEFINE_IDA(thermal_cdev_ida);
33 static LIST_HEAD(thermal_tz_list);
34 static LIST_HEAD(thermal_cdev_list);
35 static LIST_HEAD(thermal_governor_list);
37 static DEFINE_MUTEX(thermal_list_lock);
38 static DEFINE_MUTEX(thermal_governor_lock);
40 static atomic_t in_suspend;
42 static struct thermal_governor *def_governor;
45 * Governor section: set of functions to handle thermal governors
47 * Functions to help in the life cycle of thermal governors within
48 * the thermal core and by the thermal governor code.
51 static struct thermal_governor *__find_governor(const char *name)
53 struct thermal_governor *pos;
55 if (!name || !name[0])
58 list_for_each_entry(pos, &thermal_governor_list, governor_list)
59 if (!strncasecmp(name, pos->name, THERMAL_NAME_LENGTH))
66 * bind_previous_governor() - bind the previous governor of the thermal zone
67 * @tz: a valid pointer to a struct thermal_zone_device
68 * @failed_gov_name: the name of the governor that failed to register
70 * Register the previous governor of the thermal zone after a new
71 * governor has failed to be bound.
73 static void bind_previous_governor(struct thermal_zone_device *tz,
74 const char *failed_gov_name)
76 if (tz->governor && tz->governor->bind_to_tz) {
77 if (tz->governor->bind_to_tz(tz)) {
79 "governor %s failed to bind and the previous one (%s) failed to bind again, thermal zone %s has no governor\n",
80 failed_gov_name, tz->governor->name, tz->type);
87 * thermal_set_governor() - Switch to another governor
88 * @tz: a valid pointer to a struct thermal_zone_device
89 * @new_gov: pointer to the new governor
91 * Change the governor of thermal zone @tz.
93 * Return: 0 on success, an error if the new governor's bind_to_tz() failed.
95 static int thermal_set_governor(struct thermal_zone_device *tz,
96 struct thermal_governor *new_gov)
100 if (tz->governor && tz->governor->unbind_from_tz)
101 tz->governor->unbind_from_tz(tz);
103 if (new_gov && new_gov->bind_to_tz) {
104 ret = new_gov->bind_to_tz(tz);
106 bind_previous_governor(tz, new_gov->name);
112 tz->governor = new_gov;
117 int thermal_register_governor(struct thermal_governor *governor)
121 struct thermal_zone_device *pos;
126 mutex_lock(&thermal_governor_lock);
129 if (!__find_governor(governor->name)) {
133 list_add(&governor->governor_list, &thermal_governor_list);
134 match_default = !strncmp(governor->name,
135 DEFAULT_THERMAL_GOVERNOR,
136 THERMAL_NAME_LENGTH);
138 if (!def_governor && match_default)
139 def_governor = governor;
142 mutex_lock(&thermal_list_lock);
144 list_for_each_entry(pos, &thermal_tz_list, node) {
146 * only thermal zones with specified tz->tzp->governor_name
147 * may run with tz->govenor unset
152 name = pos->tzp->governor_name;
154 if (!strncasecmp(name, governor->name, THERMAL_NAME_LENGTH)) {
157 ret = thermal_set_governor(pos, governor);
159 dev_err(&pos->device,
160 "Failed to set governor %s for thermal zone %s: %d\n",
161 governor->name, pos->type, ret);
165 mutex_unlock(&thermal_list_lock);
166 mutex_unlock(&thermal_governor_lock);
171 void thermal_unregister_governor(struct thermal_governor *governor)
173 struct thermal_zone_device *pos;
178 mutex_lock(&thermal_governor_lock);
180 if (!__find_governor(governor->name))
183 mutex_lock(&thermal_list_lock);
185 list_for_each_entry(pos, &thermal_tz_list, node) {
186 if (!strncasecmp(pos->governor->name, governor->name,
187 THERMAL_NAME_LENGTH))
188 thermal_set_governor(pos, NULL);
191 mutex_unlock(&thermal_list_lock);
192 list_del(&governor->governor_list);
194 mutex_unlock(&thermal_governor_lock);
197 int thermal_zone_device_set_policy(struct thermal_zone_device *tz,
200 struct thermal_governor *gov;
203 mutex_lock(&thermal_governor_lock);
204 mutex_lock(&tz->lock);
206 if (!device_is_registered(&tz->device))
209 gov = __find_governor(strim(policy));
213 ret = thermal_set_governor(tz, gov);
216 mutex_unlock(&tz->lock);
217 mutex_unlock(&thermal_governor_lock);
219 thermal_notify_tz_gov_change(tz->id, policy);
224 int thermal_build_list_of_policies(char *buf)
226 struct thermal_governor *pos;
229 mutex_lock(&thermal_governor_lock);
231 list_for_each_entry(pos, &thermal_governor_list, governor_list) {
232 count += sysfs_emit_at(buf, count, "%s ", pos->name);
234 count += sysfs_emit_at(buf, count, "\n");
236 mutex_unlock(&thermal_governor_lock);
241 static void __init thermal_unregister_governors(void)
243 struct thermal_governor **governor;
245 for_each_governor_table(governor)
246 thermal_unregister_governor(*governor);
249 static int __init thermal_register_governors(void)
252 struct thermal_governor **governor;
254 for_each_governor_table(governor) {
255 ret = thermal_register_governor(*governor);
257 pr_err("Failed to register governor: '%s'",
262 pr_info("Registered thermal governor '%s'",
267 struct thermal_governor **gov;
269 for_each_governor_table(gov) {
272 thermal_unregister_governor(*gov);
280 * Zone update section: main control loop applied to each zone while monitoring
282 * in polling mode. The monitoring is done using a workqueue.
283 * Same update may be done on a zone by calling thermal_zone_device_update().
286 * - Non-critical trips will invoke the governor responsible for that zone;
287 * - Hot trips will produce a notification to userspace;
288 * - Critical trip point will cause a system shutdown.
290 static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
294 mod_delayed_work(system_freezable_power_efficient_wq,
295 &tz->poll_queue, delay);
297 cancel_delayed_work(&tz->poll_queue);
300 static void monitor_thermal_zone(struct thermal_zone_device *tz)
302 if (tz->mode != THERMAL_DEVICE_ENABLED)
303 thermal_zone_device_set_polling(tz, 0);
304 else if (tz->passive)
305 thermal_zone_device_set_polling(tz, tz->passive_delay_jiffies);
306 else if (tz->polling_delay_jiffies)
307 thermal_zone_device_set_polling(tz, tz->polling_delay_jiffies);
310 static void handle_non_critical_trips(struct thermal_zone_device *tz, int trip)
312 tz->governor ? tz->governor->throttle(tz, trip) :
313 def_governor->throttle(tz, trip);
316 void thermal_zone_device_critical(struct thermal_zone_device *tz)
319 * poweroff_delay_ms must be a carefully profiled positive value.
320 * Its a must for forced_emergency_poweroff_work to be scheduled.
322 int poweroff_delay_ms = CONFIG_THERMAL_EMERGENCY_POWEROFF_DELAY_MS;
324 dev_emerg(&tz->device, "%s: critical temperature reached, "
325 "shutting down\n", tz->type);
327 hw_protection_shutdown("Temperature too high", poweroff_delay_ms);
329 EXPORT_SYMBOL(thermal_zone_device_critical);
331 static void handle_critical_trips(struct thermal_zone_device *tz,
332 int trip, int trip_temp, enum thermal_trip_type trip_type)
334 /* If we have not crossed the trip_temp, we do not care. */
335 if (trip_temp <= 0 || tz->temperature < trip_temp)
338 trace_thermal_zone_trip(tz, trip, trip_type);
340 if (trip_type == THERMAL_TRIP_HOT && tz->ops->hot)
342 else if (trip_type == THERMAL_TRIP_CRITICAL)
343 tz->ops->critical(tz);
346 static void handle_thermal_trip(struct thermal_zone_device *tz, int trip_id)
348 struct thermal_trip trip;
350 /* Ignore disabled trip points */
351 if (test_bit(trip_id, &tz->trips_disabled))
354 __thermal_zone_get_trip(tz, trip_id, &trip);
356 if (trip.temperature == THERMAL_TEMP_INVALID)
359 if (tz->last_temperature != THERMAL_TEMP_INVALID) {
360 if (tz->last_temperature < trip.temperature &&
361 tz->temperature >= trip.temperature)
362 thermal_notify_tz_trip_up(tz->id, trip_id,
364 if (tz->last_temperature >= trip.temperature &&
365 tz->temperature < (trip.temperature - trip.hysteresis))
366 thermal_notify_tz_trip_down(tz->id, trip_id,
370 if (trip.type == THERMAL_TRIP_CRITICAL || trip.type == THERMAL_TRIP_HOT)
371 handle_critical_trips(tz, trip_id, trip.temperature, trip.type);
373 handle_non_critical_trips(tz, trip_id);
376 static void update_temperature(struct thermal_zone_device *tz)
380 ret = __thermal_zone_get_temp(tz, &temp);
383 dev_warn(&tz->device,
384 "failed to read out thermal zone (%d)\n",
389 tz->last_temperature = tz->temperature;
390 tz->temperature = temp;
392 trace_thermal_temperature(tz);
394 thermal_genl_sampling_temp(tz->id, temp);
397 static void thermal_zone_device_init(struct thermal_zone_device *tz)
399 struct thermal_instance *pos;
400 tz->temperature = THERMAL_TEMP_INVALID;
401 tz->prev_low_trip = -INT_MAX;
402 tz->prev_high_trip = INT_MAX;
403 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
404 pos->initialized = false;
407 void __thermal_zone_device_update(struct thermal_zone_device *tz,
408 enum thermal_notify_event event)
412 if (atomic_read(&in_suspend))
415 if (WARN_ONCE(!tz->ops->get_temp,
416 "'%s' must not be called without 'get_temp' ops set\n",
420 if (!thermal_zone_device_is_enabled(tz))
423 update_temperature(tz);
425 __thermal_zone_set_trips(tz);
427 tz->notify_event = event;
429 for (count = 0; count < tz->num_trips; count++)
430 handle_thermal_trip(tz, count);
432 monitor_thermal_zone(tz);
435 static int thermal_zone_device_set_mode(struct thermal_zone_device *tz,
436 enum thermal_device_mode mode)
440 mutex_lock(&tz->lock);
442 /* do nothing if mode isn't changing */
443 if (mode == tz->mode) {
444 mutex_unlock(&tz->lock);
449 if (!device_is_registered(&tz->device)) {
450 mutex_unlock(&tz->lock);
455 if (tz->ops->change_mode)
456 ret = tz->ops->change_mode(tz, mode);
461 __thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
463 mutex_unlock(&tz->lock);
465 if (mode == THERMAL_DEVICE_ENABLED)
466 thermal_notify_tz_enable(tz->id);
468 thermal_notify_tz_disable(tz->id);
473 int thermal_zone_device_enable(struct thermal_zone_device *tz)
475 return thermal_zone_device_set_mode(tz, THERMAL_DEVICE_ENABLED);
477 EXPORT_SYMBOL_GPL(thermal_zone_device_enable);
479 int thermal_zone_device_disable(struct thermal_zone_device *tz)
481 return thermal_zone_device_set_mode(tz, THERMAL_DEVICE_DISABLED);
483 EXPORT_SYMBOL_GPL(thermal_zone_device_disable);
485 int thermal_zone_device_is_enabled(struct thermal_zone_device *tz)
487 lockdep_assert_held(&tz->lock);
489 return tz->mode == THERMAL_DEVICE_ENABLED;
492 void thermal_zone_device_update(struct thermal_zone_device *tz,
493 enum thermal_notify_event event)
495 mutex_lock(&tz->lock);
496 if (device_is_registered(&tz->device))
497 __thermal_zone_device_update(tz, event);
498 mutex_unlock(&tz->lock);
500 EXPORT_SYMBOL_GPL(thermal_zone_device_update);
503 * thermal_zone_device_exec - Run a callback under the zone lock.
505 * @cb: Callback to run.
506 * @data: Data to pass to the callback.
508 void thermal_zone_device_exec(struct thermal_zone_device *tz,
509 void (*cb)(struct thermal_zone_device *,
513 mutex_lock(&tz->lock);
517 mutex_unlock(&tz->lock);
519 EXPORT_SYMBOL_GPL(thermal_zone_device_exec);
521 static void thermal_zone_device_check(struct work_struct *work)
523 struct thermal_zone_device *tz = container_of(work, struct
526 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
529 int for_each_thermal_governor(int (*cb)(struct thermal_governor *, void *),
532 struct thermal_governor *gov;
535 mutex_lock(&thermal_governor_lock);
536 list_for_each_entry(gov, &thermal_governor_list, governor_list) {
541 mutex_unlock(&thermal_governor_lock);
546 int for_each_thermal_cooling_device(int (*cb)(struct thermal_cooling_device *,
549 struct thermal_cooling_device *cdev;
552 mutex_lock(&thermal_list_lock);
553 list_for_each_entry(cdev, &thermal_cdev_list, node) {
554 ret = cb(cdev, data);
558 mutex_unlock(&thermal_list_lock);
563 int for_each_thermal_zone(int (*cb)(struct thermal_zone_device *, void *),
566 struct thermal_zone_device *tz;
569 mutex_lock(&thermal_list_lock);
570 list_for_each_entry(tz, &thermal_tz_list, node) {
575 mutex_unlock(&thermal_list_lock);
580 struct thermal_zone_device *thermal_zone_get_by_id(int id)
582 struct thermal_zone_device *tz, *match = NULL;
584 mutex_lock(&thermal_list_lock);
585 list_for_each_entry(tz, &thermal_tz_list, node) {
591 mutex_unlock(&thermal_list_lock);
597 * Device management section: cooling devices, zones devices, and binding
599 * Set of functions provided by the thermal core for:
600 * - cooling devices lifecycle: registration, unregistration,
601 * binding, and unbinding.
602 * - thermal zone devices lifecycle: registration, unregistration,
603 * binding, and unbinding.
607 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
608 * @tz: pointer to struct thermal_zone_device
609 * @trip: indicates which trip point the cooling devices is
610 * associated with in this thermal zone.
611 * @cdev: pointer to struct thermal_cooling_device
612 * @upper: the Maximum cooling state for this trip point.
613 * THERMAL_NO_LIMIT means no upper limit,
614 * and the cooling device can be in max_state.
615 * @lower: the Minimum cooling state can be used for this trip point.
616 * THERMAL_NO_LIMIT means no lower limit,
617 * and the cooling device can be in cooling state 0.
618 * @weight: The weight of the cooling device to be bound to the
619 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
622 * This interface function bind a thermal cooling device to the certain trip
623 * point of a thermal zone device.
624 * This function is usually called in the thermal zone device .bind callback.
626 * Return: 0 on success, the proper error value otherwise.
628 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
630 struct thermal_cooling_device *cdev,
631 unsigned long upper, unsigned long lower,
634 struct thermal_instance *dev;
635 struct thermal_instance *pos;
636 struct thermal_zone_device *pos1;
637 struct thermal_cooling_device *pos2;
641 if (trip >= tz->num_trips || trip < 0)
644 list_for_each_entry(pos1, &thermal_tz_list, node) {
648 list_for_each_entry(pos2, &thermal_cdev_list, node) {
653 if (tz != pos1 || cdev != pos2)
656 /* lower default 0, upper default max_state */
657 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
659 if (upper == THERMAL_NO_LIMIT) {
660 upper = cdev->max_state;
661 upper_no_limit = true;
663 upper_no_limit = false;
666 if (lower > upper || upper > cdev->max_state)
669 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
676 dev->upper_no_limit = upper_no_limit;
678 dev->target = THERMAL_NO_TARGET;
679 dev->weight = weight;
681 result = ida_alloc(&tz->ida, GFP_KERNEL);
686 sprintf(dev->name, "cdev%d", dev->id);
688 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
692 snprintf(dev->attr_name, sizeof(dev->attr_name), "cdev%d_trip_point",
694 sysfs_attr_init(&dev->attr.attr);
695 dev->attr.attr.name = dev->attr_name;
696 dev->attr.attr.mode = 0444;
697 dev->attr.show = trip_point_show;
698 result = device_create_file(&tz->device, &dev->attr);
700 goto remove_symbol_link;
702 snprintf(dev->weight_attr_name, sizeof(dev->weight_attr_name),
703 "cdev%d_weight", dev->id);
704 sysfs_attr_init(&dev->weight_attr.attr);
705 dev->weight_attr.attr.name = dev->weight_attr_name;
706 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
707 dev->weight_attr.show = weight_show;
708 dev->weight_attr.store = weight_store;
709 result = device_create_file(&tz->device, &dev->weight_attr);
711 goto remove_trip_file;
713 mutex_lock(&tz->lock);
714 mutex_lock(&cdev->lock);
715 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
716 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
721 list_add_tail(&dev->tz_node, &tz->thermal_instances);
722 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
723 atomic_set(&tz->need_update, 1);
725 mutex_unlock(&cdev->lock);
726 mutex_unlock(&tz->lock);
731 device_remove_file(&tz->device, &dev->weight_attr);
733 device_remove_file(&tz->device, &dev->attr);
735 sysfs_remove_link(&tz->device.kobj, dev->name);
737 ida_free(&tz->ida, dev->id);
742 EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
745 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
747 * @tz: pointer to a struct thermal_zone_device.
748 * @trip: indicates which trip point the cooling devices is
749 * associated with in this thermal zone.
750 * @cdev: pointer to a struct thermal_cooling_device.
752 * This interface function unbind a thermal cooling device from the certain
753 * trip point of a thermal zone device.
754 * This function is usually called in the thermal zone device .unbind callback.
756 * Return: 0 on success, the proper error value otherwise.
758 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
760 struct thermal_cooling_device *cdev)
762 struct thermal_instance *pos, *next;
764 mutex_lock(&tz->lock);
765 mutex_lock(&cdev->lock);
766 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
767 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
768 list_del(&pos->tz_node);
769 list_del(&pos->cdev_node);
770 mutex_unlock(&cdev->lock);
771 mutex_unlock(&tz->lock);
775 mutex_unlock(&cdev->lock);
776 mutex_unlock(&tz->lock);
781 device_remove_file(&tz->device, &pos->weight_attr);
782 device_remove_file(&tz->device, &pos->attr);
783 sysfs_remove_link(&tz->device.kobj, pos->name);
784 ida_free(&tz->ida, pos->id);
788 EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
790 static void thermal_release(struct device *dev)
792 struct thermal_zone_device *tz;
793 struct thermal_cooling_device *cdev;
795 if (!strncmp(dev_name(dev), "thermal_zone",
796 sizeof("thermal_zone") - 1)) {
797 tz = to_thermal_zone(dev);
798 thermal_zone_destroy_device_groups(tz);
799 mutex_destroy(&tz->lock);
801 } else if (!strncmp(dev_name(dev), "cooling_device",
802 sizeof("cooling_device") - 1)) {
803 cdev = to_cooling_device(dev);
804 thermal_cooling_device_destroy_sysfs(cdev);
806 ida_free(&thermal_cdev_ida, cdev->id);
811 static struct class *thermal_class;
814 void print_bind_err_msg(struct thermal_zone_device *tz,
815 struct thermal_cooling_device *cdev, int ret)
817 dev_err(&tz->device, "binding zone %s with cdev %s failed:%d\n",
818 tz->type, cdev->type, ret);
821 static void bind_cdev(struct thermal_cooling_device *cdev)
824 struct thermal_zone_device *pos = NULL;
826 list_for_each_entry(pos, &thermal_tz_list, node) {
827 if (pos->ops->bind) {
828 ret = pos->ops->bind(pos, cdev);
830 print_bind_err_msg(pos, cdev, ret);
836 * __thermal_cooling_device_register() - register a new thermal cooling device
837 * @np: a pointer to a device tree node.
838 * @type: the thermal cooling device type.
839 * @devdata: device private data.
840 * @ops: standard thermal cooling devices callbacks.
842 * This interface function adds a new thermal cooling device (fan/processor/...)
843 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
844 * to all the thermal zone devices registered at the same time.
845 * It also gives the opportunity to link the cooling device to a device tree
846 * node, so that it can be bound to a thermal zone created out of device tree.
848 * Return: a pointer to the created struct thermal_cooling_device or an
849 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
851 static struct thermal_cooling_device *
852 __thermal_cooling_device_register(struct device_node *np,
853 const char *type, void *devdata,
854 const struct thermal_cooling_device_ops *ops)
856 struct thermal_cooling_device *cdev;
857 struct thermal_zone_device *pos = NULL;
860 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
862 return ERR_PTR(-EINVAL);
865 return ERR_PTR(-ENODEV);
867 cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
869 return ERR_PTR(-ENOMEM);
871 ret = ida_alloc(&thermal_cdev_ida, GFP_KERNEL);
877 cdev->type = kstrdup(type ? type : "", GFP_KERNEL);
883 mutex_init(&cdev->lock);
884 INIT_LIST_HEAD(&cdev->thermal_instances);
887 cdev->updated = false;
888 cdev->device.class = thermal_class;
889 cdev->devdata = devdata;
891 ret = cdev->ops->get_max_state(cdev, &cdev->max_state);
895 thermal_cooling_device_setup_sysfs(cdev);
897 ret = dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
899 goto out_cooling_dev;
901 ret = device_register(&cdev->device);
903 /* thermal_release() handles rest of the cleanup */
904 put_device(&cdev->device);
908 /* Add 'this' new cdev to the global cdev list */
909 mutex_lock(&thermal_list_lock);
911 list_add(&cdev->node, &thermal_cdev_list);
913 /* Update binding information for 'this' new cdev */
916 list_for_each_entry(pos, &thermal_tz_list, node)
917 if (atomic_cmpxchg(&pos->need_update, 1, 0))
918 thermal_zone_device_update(pos,
919 THERMAL_EVENT_UNSPECIFIED);
921 mutex_unlock(&thermal_list_lock);
926 thermal_cooling_device_destroy_sysfs(cdev);
930 ida_free(&thermal_cdev_ida, id);
937 * thermal_cooling_device_register() - register a new thermal cooling device
938 * @type: the thermal cooling device type.
939 * @devdata: device private data.
940 * @ops: standard thermal cooling devices callbacks.
942 * This interface function adds a new thermal cooling device (fan/processor/...)
943 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
944 * to all the thermal zone devices registered at the same time.
946 * Return: a pointer to the created struct thermal_cooling_device or an
947 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
949 struct thermal_cooling_device *
950 thermal_cooling_device_register(const char *type, void *devdata,
951 const struct thermal_cooling_device_ops *ops)
953 return __thermal_cooling_device_register(NULL, type, devdata, ops);
955 EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
958 * thermal_of_cooling_device_register() - register an OF thermal cooling device
959 * @np: a pointer to a device tree node.
960 * @type: the thermal cooling device type.
961 * @devdata: device private data.
962 * @ops: standard thermal cooling devices callbacks.
964 * This function will register a cooling device with device tree node reference.
965 * This interface function adds a new thermal cooling device (fan/processor/...)
966 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
967 * to all the thermal zone devices registered at the same time.
969 * Return: a pointer to the created struct thermal_cooling_device or an
970 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
972 struct thermal_cooling_device *
973 thermal_of_cooling_device_register(struct device_node *np,
974 const char *type, void *devdata,
975 const struct thermal_cooling_device_ops *ops)
977 return __thermal_cooling_device_register(np, type, devdata, ops);
979 EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
981 static void thermal_cooling_device_release(struct device *dev, void *res)
983 thermal_cooling_device_unregister(
984 *(struct thermal_cooling_device **)res);
988 * devm_thermal_of_cooling_device_register() - register an OF thermal cooling
990 * @dev: a valid struct device pointer of a sensor device.
991 * @np: a pointer to a device tree node.
992 * @type: the thermal cooling device type.
993 * @devdata: device private data.
994 * @ops: standard thermal cooling devices callbacks.
996 * This function will register a cooling device with device tree node reference.
997 * This interface function adds a new thermal cooling device (fan/processor/...)
998 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
999 * to all the thermal zone devices registered at the same time.
1001 * Return: a pointer to the created struct thermal_cooling_device or an
1002 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1004 struct thermal_cooling_device *
1005 devm_thermal_of_cooling_device_register(struct device *dev,
1006 struct device_node *np,
1007 char *type, void *devdata,
1008 const struct thermal_cooling_device_ops *ops)
1010 struct thermal_cooling_device **ptr, *tcd;
1012 ptr = devres_alloc(thermal_cooling_device_release, sizeof(*ptr),
1015 return ERR_PTR(-ENOMEM);
1017 tcd = __thermal_cooling_device_register(np, type, devdata, ops);
1024 devres_add(dev, ptr);
1028 EXPORT_SYMBOL_GPL(devm_thermal_of_cooling_device_register);
1030 static bool thermal_cooling_device_present(struct thermal_cooling_device *cdev)
1032 struct thermal_cooling_device *pos = NULL;
1034 list_for_each_entry(pos, &thermal_cdev_list, node) {
1043 * thermal_cooling_device_update - Update a cooling device object
1044 * @cdev: Target cooling device.
1046 * Update @cdev to reflect a change of the underlying hardware or platform.
1048 * Must be called when the maximum cooling state of @cdev becomes invalid and so
1049 * its .get_max_state() callback needs to be run to produce the new maximum
1050 * cooling state value.
1052 void thermal_cooling_device_update(struct thermal_cooling_device *cdev)
1054 struct thermal_instance *ti;
1055 unsigned long state;
1057 if (IS_ERR_OR_NULL(cdev))
1061 * Hold thermal_list_lock throughout the update to prevent the device
1062 * from going away while being updated.
1064 mutex_lock(&thermal_list_lock);
1066 if (!thermal_cooling_device_present(cdev))
1070 * Update under the cdev lock to prevent the state from being set beyond
1071 * the new limit concurrently.
1073 mutex_lock(&cdev->lock);
1075 if (cdev->ops->get_max_state(cdev, &cdev->max_state))
1078 thermal_cooling_device_stats_reinit(cdev);
1080 list_for_each_entry(ti, &cdev->thermal_instances, cdev_node) {
1081 if (ti->upper == cdev->max_state)
1084 if (ti->upper < cdev->max_state) {
1085 if (ti->upper_no_limit)
1086 ti->upper = cdev->max_state;
1091 ti->upper = cdev->max_state;
1092 if (ti->lower > ti->upper)
1093 ti->lower = ti->upper;
1095 if (ti->target == THERMAL_NO_TARGET)
1098 if (ti->target > ti->upper)
1099 ti->target = ti->upper;
1102 if (cdev->ops->get_cur_state(cdev, &state) || state > cdev->max_state)
1105 thermal_cooling_device_stats_update(cdev, state);
1108 mutex_unlock(&cdev->lock);
1111 mutex_unlock(&thermal_list_lock);
1113 EXPORT_SYMBOL_GPL(thermal_cooling_device_update);
1116 * thermal_cooling_device_unregister - removes a thermal cooling device
1117 * @cdev: the thermal cooling device to remove.
1119 * thermal_cooling_device_unregister() must be called when a registered
1120 * thermal cooling device is no longer needed.
1122 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1124 struct thermal_zone_device *tz;
1129 mutex_lock(&thermal_list_lock);
1131 if (!thermal_cooling_device_present(cdev)) {
1132 mutex_unlock(&thermal_list_lock);
1136 list_del(&cdev->node);
1138 /* Unbind all thermal zones associated with 'this' cdev */
1139 list_for_each_entry(tz, &thermal_tz_list, node) {
1140 if (tz->ops->unbind)
1141 tz->ops->unbind(tz, cdev);
1144 mutex_unlock(&thermal_list_lock);
1146 device_unregister(&cdev->device);
1148 EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1150 static void bind_tz(struct thermal_zone_device *tz)
1153 struct thermal_cooling_device *pos = NULL;
1158 mutex_lock(&thermal_list_lock);
1160 list_for_each_entry(pos, &thermal_cdev_list, node) {
1161 ret = tz->ops->bind(tz, pos);
1163 print_bind_err_msg(tz, pos, ret);
1166 mutex_unlock(&thermal_list_lock);
1169 static void thermal_set_delay_jiffies(unsigned long *delay_jiffies, int delay_ms)
1171 *delay_jiffies = msecs_to_jiffies(delay_ms);
1172 if (delay_ms > 1000)
1173 *delay_jiffies = round_jiffies(*delay_jiffies);
1176 int thermal_zone_get_crit_temp(struct thermal_zone_device *tz, int *temp)
1178 int i, ret = -EINVAL;
1180 if (tz->ops->get_crit_temp)
1181 return tz->ops->get_crit_temp(tz, temp);
1186 mutex_lock(&tz->lock);
1188 for (i = 0; i < tz->num_trips; i++) {
1189 if (tz->trips[i].type == THERMAL_TRIP_CRITICAL) {
1190 *temp = tz->trips[i].temperature;
1196 mutex_unlock(&tz->lock);
1200 EXPORT_SYMBOL_GPL(thermal_zone_get_crit_temp);
1203 * thermal_zone_device_register_with_trips() - register a new thermal zone device
1204 * @type: the thermal zone device type
1205 * @trips: a pointer to an array of thermal trips
1206 * @num_trips: the number of trip points the thermal zone support
1207 * @mask: a bit string indicating the writeablility of trip points
1208 * @devdata: private device data
1209 * @ops: standard thermal zone device callbacks
1210 * @tzp: thermal zone platform parameters
1211 * @passive_delay: number of milliseconds to wait between polls when
1212 * performing passive cooling
1213 * @polling_delay: number of milliseconds to wait between polls when checking
1214 * whether trip points have been crossed (0 for interrupt
1217 * This interface function adds a new thermal zone device (sensor) to
1218 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1219 * thermal cooling devices registered at the same time.
1220 * thermal_zone_device_unregister() must be called when the device is no
1221 * longer needed. The passive cooling depends on the .get_trend() return value.
1223 * Return: a pointer to the created struct thermal_zone_device or an
1224 * in case of error, an ERR_PTR. Caller must check return value with
1225 * IS_ERR*() helpers.
1227 struct thermal_zone_device *
1228 thermal_zone_device_register_with_trips(const char *type, struct thermal_trip *trips, int num_trips, int mask,
1229 void *devdata, struct thermal_zone_device_ops *ops,
1230 const struct thermal_zone_params *tzp, int passive_delay,
1233 struct thermal_zone_device *tz;
1237 struct thermal_governor *governor;
1239 if (!type || strlen(type) == 0) {
1240 pr_err("No thermal zone type defined\n");
1241 return ERR_PTR(-EINVAL);
1244 if (strlen(type) >= THERMAL_NAME_LENGTH) {
1245 pr_err("Thermal zone name (%s) too long, should be under %d chars\n",
1246 type, THERMAL_NAME_LENGTH);
1247 return ERR_PTR(-EINVAL);
1251 * Max trip count can't exceed 31 as the "mask >> num_trips" condition.
1252 * For example, shifting by 32 will result in compiler warning:
1253 * warning: right shift count >= width of type [-Wshift-count- overflow]
1255 * Also "mask >> num_trips" will always be true with 32 bit shift.
1256 * E.g. mask = 0x80000000 for trip id 31 to be RW. Then
1257 * mask >> 32 = 0x80000000
1258 * This will result in failure for the below condition.
1260 * Check will be true when the bit 31 of the mask is set.
1261 * 32 bit shift will cause overflow of 4 byte integer.
1263 if (num_trips > (BITS_PER_TYPE(int) - 1) || num_trips < 0 || mask >> num_trips) {
1264 pr_err("Incorrect number of thermal trips\n");
1265 return ERR_PTR(-EINVAL);
1269 pr_err("Thermal zone device ops not defined\n");
1270 return ERR_PTR(-EINVAL);
1273 if (num_trips > 0 && !trips)
1274 return ERR_PTR(-EINVAL);
1277 return ERR_PTR(-ENODEV);
1279 tz = kzalloc(sizeof(*tz), GFP_KERNEL);
1281 return ERR_PTR(-ENOMEM);
1284 tz->tzp = kmemdup(tzp, sizeof(*tzp), GFP_KERNEL);
1291 INIT_LIST_HEAD(&tz->thermal_instances);
1293 mutex_init(&tz->lock);
1294 id = ida_alloc(&thermal_tz_ida, GFP_KERNEL);
1301 strscpy(tz->type, type, sizeof(tz->type));
1304 ops->critical = thermal_zone_device_critical;
1307 tz->device.class = thermal_class;
1308 tz->devdata = devdata;
1310 tz->num_trips = num_trips;
1312 thermal_set_delay_jiffies(&tz->passive_delay_jiffies, passive_delay);
1313 thermal_set_delay_jiffies(&tz->polling_delay_jiffies, polling_delay);
1316 /* Add nodes that are always present via .groups */
1317 result = thermal_zone_create_device_groups(tz, mask);
1321 /* A new thermal zone needs to be updated anyway. */
1322 atomic_set(&tz->need_update, 1);
1324 result = dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1326 thermal_zone_destroy_device_groups(tz);
1329 result = device_register(&tz->device);
1331 goto release_device;
1333 for (count = 0; count < num_trips; count++) {
1334 struct thermal_trip trip;
1336 result = thermal_zone_get_trip(tz, count, &trip);
1337 if (result || !trip.temperature)
1338 set_bit(count, &tz->trips_disabled);
1341 /* Update 'this' zone's governor information */
1342 mutex_lock(&thermal_governor_lock);
1345 governor = __find_governor(tz->tzp->governor_name);
1347 governor = def_governor;
1349 result = thermal_set_governor(tz, governor);
1351 mutex_unlock(&thermal_governor_lock);
1355 mutex_unlock(&thermal_governor_lock);
1357 if (!tz->tzp || !tz->tzp->no_hwmon) {
1358 result = thermal_add_hwmon_sysfs(tz);
1363 mutex_lock(&thermal_list_lock);
1364 list_add_tail(&tz->node, &thermal_tz_list);
1365 mutex_unlock(&thermal_list_lock);
1367 /* Bind cooling devices for this zone */
1370 INIT_DELAYED_WORK(&tz->poll_queue, thermal_zone_device_check);
1372 thermal_zone_device_init(tz);
1373 /* Update the new thermal zone and mark it as already updated. */
1374 if (atomic_cmpxchg(&tz->need_update, 1, 0))
1375 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
1377 thermal_notify_tz_create(tz->id, tz->type);
1382 device_del(&tz->device);
1384 put_device(&tz->device);
1387 ida_free(&thermal_tz_ida, id);
1392 return ERR_PTR(result);
1394 EXPORT_SYMBOL_GPL(thermal_zone_device_register_with_trips);
1396 struct thermal_zone_device *thermal_tripless_zone_device_register(
1399 struct thermal_zone_device_ops *ops,
1400 const struct thermal_zone_params *tzp)
1402 return thermal_zone_device_register_with_trips(type, NULL, 0, 0, devdata,
1405 EXPORT_SYMBOL_GPL(thermal_tripless_zone_device_register);
1407 void *thermal_zone_device_priv(struct thermal_zone_device *tzd)
1409 return tzd->devdata;
1411 EXPORT_SYMBOL_GPL(thermal_zone_device_priv);
1413 const char *thermal_zone_device_type(struct thermal_zone_device *tzd)
1417 EXPORT_SYMBOL_GPL(thermal_zone_device_type);
1419 int thermal_zone_device_id(struct thermal_zone_device *tzd)
1423 EXPORT_SYMBOL_GPL(thermal_zone_device_id);
1425 struct device *thermal_zone_device(struct thermal_zone_device *tzd)
1427 return &tzd->device;
1429 EXPORT_SYMBOL_GPL(thermal_zone_device);
1432 * thermal_zone_device_unregister - removes the registered thermal zone device
1433 * @tz: the thermal zone device to remove
1435 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1438 struct thermal_cooling_device *cdev;
1439 struct thermal_zone_device *pos = NULL;
1446 mutex_lock(&thermal_list_lock);
1447 list_for_each_entry(pos, &thermal_tz_list, node)
1451 /* thermal zone device not found */
1452 mutex_unlock(&thermal_list_lock);
1455 list_del(&tz->node);
1457 /* Unbind all cdevs associated with 'this' thermal zone */
1458 list_for_each_entry(cdev, &thermal_cdev_list, node)
1459 if (tz->ops->unbind)
1460 tz->ops->unbind(tz, cdev);
1462 mutex_unlock(&thermal_list_lock);
1464 cancel_delayed_work_sync(&tz->poll_queue);
1466 thermal_set_governor(tz, NULL);
1468 thermal_remove_hwmon_sysfs(tz);
1469 ida_free(&thermal_tz_ida, tz->id);
1470 ida_destroy(&tz->ida);
1472 mutex_lock(&tz->lock);
1473 device_del(&tz->device);
1474 mutex_unlock(&tz->lock);
1478 put_device(&tz->device);
1480 thermal_notify_tz_delete(tz_id);
1482 EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
1485 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
1486 * @name: thermal zone name to fetch the temperature
1488 * When only one zone is found with the passed name, returns a reference to it.
1490 * Return: On success returns a reference to an unique thermal zone with
1491 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
1492 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
1494 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
1496 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
1497 unsigned int found = 0;
1502 mutex_lock(&thermal_list_lock);
1503 list_for_each_entry(pos, &thermal_tz_list, node)
1504 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
1508 mutex_unlock(&thermal_list_lock);
1510 /* nothing has been found, thus an error code for it */
1512 ref = ERR_PTR(-ENODEV);
1514 /* Success only when an unique zone is found */
1515 ref = ERR_PTR(-EEXIST);
1520 EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
1522 static int thermal_pm_notify(struct notifier_block *nb,
1523 unsigned long mode, void *_unused)
1525 struct thermal_zone_device *tz;
1528 case PM_HIBERNATION_PREPARE:
1529 case PM_RESTORE_PREPARE:
1530 case PM_SUSPEND_PREPARE:
1531 atomic_set(&in_suspend, 1);
1533 case PM_POST_HIBERNATION:
1534 case PM_POST_RESTORE:
1535 case PM_POST_SUSPEND:
1536 atomic_set(&in_suspend, 0);
1537 list_for_each_entry(tz, &thermal_tz_list, node) {
1538 thermal_zone_device_init(tz);
1539 thermal_zone_device_update(tz,
1540 THERMAL_EVENT_UNSPECIFIED);
1549 static struct notifier_block thermal_pm_nb = {
1550 .notifier_call = thermal_pm_notify,
1553 static int __init thermal_init(void)
1557 result = thermal_netlink_init();
1561 result = thermal_register_governors();
1563 goto unregister_netlink;
1565 thermal_class = kzalloc(sizeof(*thermal_class), GFP_KERNEL);
1566 if (!thermal_class) {
1568 goto unregister_governors;
1571 thermal_class->name = "thermal";
1572 thermal_class->dev_release = thermal_release;
1574 result = class_register(thermal_class);
1576 kfree(thermal_class);
1577 thermal_class = NULL;
1578 goto unregister_governors;
1581 result = register_pm_notifier(&thermal_pm_nb);
1583 pr_warn("Thermal: Can not register suspend notifier, return %d\n",
1588 unregister_governors:
1589 thermal_unregister_governors();
1591 thermal_netlink_exit();
1593 mutex_destroy(&thermal_list_lock);
1594 mutex_destroy(&thermal_governor_lock);
1597 postcore_initcall(thermal_init);