1 // SPDX-License-Identifier: GPL-2.0
3 * thermal.c - Generic Thermal Management Sysfs support.
5 * Copyright (C) 2008 Intel Corp
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 (tz->last_temperature != THERMAL_TEMP_INVALID) {
357 if (tz->last_temperature < trip.temperature &&
358 tz->temperature >= trip.temperature)
359 thermal_notify_tz_trip_up(tz->id, trip_id,
361 if (tz->last_temperature >= trip.temperature &&
362 tz->temperature < (trip.temperature - trip.hysteresis))
363 thermal_notify_tz_trip_down(tz->id, trip_id,
367 if (trip.type == THERMAL_TRIP_CRITICAL || trip.type == THERMAL_TRIP_HOT)
368 handle_critical_trips(tz, trip_id, trip.temperature, trip.type);
370 handle_non_critical_trips(tz, trip_id);
373 static void update_temperature(struct thermal_zone_device *tz)
377 ret = __thermal_zone_get_temp(tz, &temp);
380 dev_warn(&tz->device,
381 "failed to read out thermal zone (%d)\n",
386 tz->last_temperature = tz->temperature;
387 tz->temperature = temp;
389 trace_thermal_temperature(tz);
391 thermal_genl_sampling_temp(tz->id, temp);
394 static void thermal_zone_device_init(struct thermal_zone_device *tz)
396 struct thermal_instance *pos;
397 tz->temperature = THERMAL_TEMP_INVALID;
398 tz->prev_low_trip = -INT_MAX;
399 tz->prev_high_trip = INT_MAX;
400 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
401 pos->initialized = false;
404 void __thermal_zone_device_update(struct thermal_zone_device *tz,
405 enum thermal_notify_event event)
409 if (atomic_read(&in_suspend))
412 if (WARN_ONCE(!tz->ops->get_temp,
413 "'%s' must not be called without 'get_temp' ops set\n",
417 if (!thermal_zone_device_is_enabled(tz))
420 update_temperature(tz);
422 __thermal_zone_set_trips(tz);
424 tz->notify_event = event;
426 for (count = 0; count < tz->num_trips; count++)
427 handle_thermal_trip(tz, count);
429 monitor_thermal_zone(tz);
432 static int thermal_zone_device_set_mode(struct thermal_zone_device *tz,
433 enum thermal_device_mode mode)
437 mutex_lock(&tz->lock);
439 /* do nothing if mode isn't changing */
440 if (mode == tz->mode) {
441 mutex_unlock(&tz->lock);
446 if (!device_is_registered(&tz->device)) {
447 mutex_unlock(&tz->lock);
452 if (tz->ops->change_mode)
453 ret = tz->ops->change_mode(tz, mode);
458 __thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
460 mutex_unlock(&tz->lock);
462 if (mode == THERMAL_DEVICE_ENABLED)
463 thermal_notify_tz_enable(tz->id);
465 thermal_notify_tz_disable(tz->id);
470 int thermal_zone_device_enable(struct thermal_zone_device *tz)
472 return thermal_zone_device_set_mode(tz, THERMAL_DEVICE_ENABLED);
474 EXPORT_SYMBOL_GPL(thermal_zone_device_enable);
476 int thermal_zone_device_disable(struct thermal_zone_device *tz)
478 return thermal_zone_device_set_mode(tz, THERMAL_DEVICE_DISABLED);
480 EXPORT_SYMBOL_GPL(thermal_zone_device_disable);
482 int thermal_zone_device_is_enabled(struct thermal_zone_device *tz)
484 lockdep_assert_held(&tz->lock);
486 return tz->mode == THERMAL_DEVICE_ENABLED;
489 void thermal_zone_device_update(struct thermal_zone_device *tz,
490 enum thermal_notify_event event)
492 mutex_lock(&tz->lock);
493 if (device_is_registered(&tz->device))
494 __thermal_zone_device_update(tz, event);
495 mutex_unlock(&tz->lock);
497 EXPORT_SYMBOL_GPL(thermal_zone_device_update);
499 static void thermal_zone_device_check(struct work_struct *work)
501 struct thermal_zone_device *tz = container_of(work, struct
504 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
507 int for_each_thermal_governor(int (*cb)(struct thermal_governor *, void *),
510 struct thermal_governor *gov;
513 mutex_lock(&thermal_governor_lock);
514 list_for_each_entry(gov, &thermal_governor_list, governor_list) {
519 mutex_unlock(&thermal_governor_lock);
524 int for_each_thermal_cooling_device(int (*cb)(struct thermal_cooling_device *,
527 struct thermal_cooling_device *cdev;
530 mutex_lock(&thermal_list_lock);
531 list_for_each_entry(cdev, &thermal_cdev_list, node) {
532 ret = cb(cdev, data);
536 mutex_unlock(&thermal_list_lock);
541 int for_each_thermal_zone(int (*cb)(struct thermal_zone_device *, void *),
544 struct thermal_zone_device *tz;
547 mutex_lock(&thermal_list_lock);
548 list_for_each_entry(tz, &thermal_tz_list, node) {
553 mutex_unlock(&thermal_list_lock);
558 struct thermal_zone_device *thermal_zone_get_by_id(int id)
560 struct thermal_zone_device *tz, *match = NULL;
562 mutex_lock(&thermal_list_lock);
563 list_for_each_entry(tz, &thermal_tz_list, node) {
569 mutex_unlock(&thermal_list_lock);
575 * Device management section: cooling devices, zones devices, and binding
577 * Set of functions provided by the thermal core for:
578 * - cooling devices lifecycle: registration, unregistration,
579 * binding, and unbinding.
580 * - thermal zone devices lifecycle: registration, unregistration,
581 * binding, and unbinding.
585 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
586 * @tz: pointer to struct thermal_zone_device
587 * @trip: indicates which trip point the cooling devices is
588 * associated with in this thermal zone.
589 * @cdev: pointer to struct thermal_cooling_device
590 * @upper: the Maximum cooling state for this trip point.
591 * THERMAL_NO_LIMIT means no upper limit,
592 * and the cooling device can be in max_state.
593 * @lower: the Minimum cooling state can be used for this trip point.
594 * THERMAL_NO_LIMIT means no lower limit,
595 * and the cooling device can be in cooling state 0.
596 * @weight: The weight of the cooling device to be bound to the
597 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
600 * This interface function bind a thermal cooling device to the certain trip
601 * point of a thermal zone device.
602 * This function is usually called in the thermal zone device .bind callback.
604 * Return: 0 on success, the proper error value otherwise.
606 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
608 struct thermal_cooling_device *cdev,
609 unsigned long upper, unsigned long lower,
612 struct thermal_instance *dev;
613 struct thermal_instance *pos;
614 struct thermal_zone_device *pos1;
615 struct thermal_cooling_device *pos2;
619 if (trip >= tz->num_trips || trip < 0)
622 list_for_each_entry(pos1, &thermal_tz_list, node) {
626 list_for_each_entry(pos2, &thermal_cdev_list, node) {
631 if (tz != pos1 || cdev != pos2)
634 /* lower default 0, upper default max_state */
635 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
637 if (upper == THERMAL_NO_LIMIT) {
638 upper = cdev->max_state;
639 upper_no_limit = true;
641 upper_no_limit = false;
644 if (lower > upper || upper > cdev->max_state)
647 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
654 dev->upper_no_limit = upper_no_limit;
656 dev->target = THERMAL_NO_TARGET;
657 dev->weight = weight;
659 result = ida_alloc(&tz->ida, GFP_KERNEL);
664 sprintf(dev->name, "cdev%d", dev->id);
666 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
670 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
671 sysfs_attr_init(&dev->attr.attr);
672 dev->attr.attr.name = dev->attr_name;
673 dev->attr.attr.mode = 0444;
674 dev->attr.show = trip_point_show;
675 result = device_create_file(&tz->device, &dev->attr);
677 goto remove_symbol_link;
679 sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
680 sysfs_attr_init(&dev->weight_attr.attr);
681 dev->weight_attr.attr.name = dev->weight_attr_name;
682 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
683 dev->weight_attr.show = weight_show;
684 dev->weight_attr.store = weight_store;
685 result = device_create_file(&tz->device, &dev->weight_attr);
687 goto remove_trip_file;
689 mutex_lock(&tz->lock);
690 mutex_lock(&cdev->lock);
691 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
692 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
697 list_add_tail(&dev->tz_node, &tz->thermal_instances);
698 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
699 atomic_set(&tz->need_update, 1);
701 mutex_unlock(&cdev->lock);
702 mutex_unlock(&tz->lock);
707 device_remove_file(&tz->device, &dev->weight_attr);
709 device_remove_file(&tz->device, &dev->attr);
711 sysfs_remove_link(&tz->device.kobj, dev->name);
713 ida_free(&tz->ida, dev->id);
718 EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
721 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
723 * @tz: pointer to a struct thermal_zone_device.
724 * @trip: indicates which trip point the cooling devices is
725 * associated with in this thermal zone.
726 * @cdev: pointer to a struct thermal_cooling_device.
728 * This interface function unbind a thermal cooling device from the certain
729 * trip point of a thermal zone device.
730 * This function is usually called in the thermal zone device .unbind callback.
732 * Return: 0 on success, the proper error value otherwise.
734 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
736 struct thermal_cooling_device *cdev)
738 struct thermal_instance *pos, *next;
740 mutex_lock(&tz->lock);
741 mutex_lock(&cdev->lock);
742 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
743 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
744 list_del(&pos->tz_node);
745 list_del(&pos->cdev_node);
746 mutex_unlock(&cdev->lock);
747 mutex_unlock(&tz->lock);
751 mutex_unlock(&cdev->lock);
752 mutex_unlock(&tz->lock);
757 device_remove_file(&tz->device, &pos->weight_attr);
758 device_remove_file(&tz->device, &pos->attr);
759 sysfs_remove_link(&tz->device.kobj, pos->name);
760 ida_free(&tz->ida, pos->id);
764 EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
766 static void thermal_release(struct device *dev)
768 struct thermal_zone_device *tz;
769 struct thermal_cooling_device *cdev;
771 if (!strncmp(dev_name(dev), "thermal_zone",
772 sizeof("thermal_zone") - 1)) {
773 tz = to_thermal_zone(dev);
774 thermal_zone_destroy_device_groups(tz);
775 mutex_destroy(&tz->lock);
777 } else if (!strncmp(dev_name(dev), "cooling_device",
778 sizeof("cooling_device") - 1)) {
779 cdev = to_cooling_device(dev);
780 thermal_cooling_device_destroy_sysfs(cdev);
782 ida_free(&thermal_cdev_ida, cdev->id);
787 static struct class *thermal_class;
790 void print_bind_err_msg(struct thermal_zone_device *tz,
791 struct thermal_cooling_device *cdev, int ret)
793 dev_err(&tz->device, "binding zone %s with cdev %s failed:%d\n",
794 tz->type, cdev->type, ret);
797 static void bind_cdev(struct thermal_cooling_device *cdev)
800 struct thermal_zone_device *pos = NULL;
802 list_for_each_entry(pos, &thermal_tz_list, node) {
803 if (pos->ops->bind) {
804 ret = pos->ops->bind(pos, cdev);
806 print_bind_err_msg(pos, cdev, ret);
812 * __thermal_cooling_device_register() - register a new thermal cooling device
813 * @np: a pointer to a device tree node.
814 * @type: the thermal cooling device type.
815 * @devdata: device private data.
816 * @ops: standard thermal cooling devices callbacks.
818 * This interface function adds a new thermal cooling device (fan/processor/...)
819 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
820 * to all the thermal zone devices registered at the same time.
821 * It also gives the opportunity to link the cooling device to a device tree
822 * node, so that it can be bound to a thermal zone created out of device tree.
824 * Return: a pointer to the created struct thermal_cooling_device or an
825 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
827 static struct thermal_cooling_device *
828 __thermal_cooling_device_register(struct device_node *np,
829 const char *type, void *devdata,
830 const struct thermal_cooling_device_ops *ops)
832 struct thermal_cooling_device *cdev;
833 struct thermal_zone_device *pos = NULL;
836 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
838 return ERR_PTR(-EINVAL);
841 return ERR_PTR(-ENODEV);
843 cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
845 return ERR_PTR(-ENOMEM);
847 ret = ida_alloc(&thermal_cdev_ida, GFP_KERNEL);
853 cdev->type = kstrdup(type ? type : "", GFP_KERNEL);
859 mutex_init(&cdev->lock);
860 INIT_LIST_HEAD(&cdev->thermal_instances);
863 cdev->updated = false;
864 cdev->device.class = thermal_class;
865 cdev->devdata = devdata;
867 ret = cdev->ops->get_max_state(cdev, &cdev->max_state);
871 thermal_cooling_device_setup_sysfs(cdev);
873 ret = dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
875 goto out_cooling_dev;
877 ret = device_register(&cdev->device);
879 /* thermal_release() handles rest of the cleanup */
880 put_device(&cdev->device);
884 /* Add 'this' new cdev to the global cdev list */
885 mutex_lock(&thermal_list_lock);
887 list_add(&cdev->node, &thermal_cdev_list);
889 /* Update binding information for 'this' new cdev */
892 list_for_each_entry(pos, &thermal_tz_list, node)
893 if (atomic_cmpxchg(&pos->need_update, 1, 0))
894 thermal_zone_device_update(pos,
895 THERMAL_EVENT_UNSPECIFIED);
897 mutex_unlock(&thermal_list_lock);
902 thermal_cooling_device_destroy_sysfs(cdev);
906 ida_free(&thermal_cdev_ida, id);
913 * thermal_cooling_device_register() - register a new thermal cooling device
914 * @type: the thermal cooling device type.
915 * @devdata: device private data.
916 * @ops: standard thermal cooling devices callbacks.
918 * This interface function adds a new thermal cooling device (fan/processor/...)
919 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
920 * to all the thermal zone devices registered at the same time.
922 * Return: a pointer to the created struct thermal_cooling_device or an
923 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
925 struct thermal_cooling_device *
926 thermal_cooling_device_register(const char *type, void *devdata,
927 const struct thermal_cooling_device_ops *ops)
929 return __thermal_cooling_device_register(NULL, type, devdata, ops);
931 EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
934 * thermal_of_cooling_device_register() - register an OF thermal cooling device
935 * @np: a pointer to a device tree node.
936 * @type: the thermal cooling device type.
937 * @devdata: device private data.
938 * @ops: standard thermal cooling devices callbacks.
940 * This function will register a cooling device with device tree node reference.
941 * This interface function adds a new thermal cooling device (fan/processor/...)
942 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
943 * to all the thermal zone devices registered at the same time.
945 * Return: a pointer to the created struct thermal_cooling_device or an
946 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
948 struct thermal_cooling_device *
949 thermal_of_cooling_device_register(struct device_node *np,
950 const char *type, void *devdata,
951 const struct thermal_cooling_device_ops *ops)
953 return __thermal_cooling_device_register(np, type, devdata, ops);
955 EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
957 static void thermal_cooling_device_release(struct device *dev, void *res)
959 thermal_cooling_device_unregister(
960 *(struct thermal_cooling_device **)res);
964 * devm_thermal_of_cooling_device_register() - register an OF thermal cooling
966 * @dev: a valid struct device pointer of a sensor device.
967 * @np: a pointer to a device tree node.
968 * @type: the thermal cooling device type.
969 * @devdata: device private data.
970 * @ops: standard thermal cooling devices callbacks.
972 * This function will register a cooling device with device tree node reference.
973 * This interface function adds a new thermal cooling device (fan/processor/...)
974 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
975 * to all the thermal zone devices registered at the same time.
977 * Return: a pointer to the created struct thermal_cooling_device or an
978 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
980 struct thermal_cooling_device *
981 devm_thermal_of_cooling_device_register(struct device *dev,
982 struct device_node *np,
983 char *type, void *devdata,
984 const struct thermal_cooling_device_ops *ops)
986 struct thermal_cooling_device **ptr, *tcd;
988 ptr = devres_alloc(thermal_cooling_device_release, sizeof(*ptr),
991 return ERR_PTR(-ENOMEM);
993 tcd = __thermal_cooling_device_register(np, type, devdata, ops);
1000 devres_add(dev, ptr);
1004 EXPORT_SYMBOL_GPL(devm_thermal_of_cooling_device_register);
1006 static bool thermal_cooling_device_present(struct thermal_cooling_device *cdev)
1008 struct thermal_cooling_device *pos = NULL;
1010 list_for_each_entry(pos, &thermal_cdev_list, node) {
1019 * thermal_cooling_device_update - Update a cooling device object
1020 * @cdev: Target cooling device.
1022 * Update @cdev to reflect a change of the underlying hardware or platform.
1024 * Must be called when the maximum cooling state of @cdev becomes invalid and so
1025 * its .get_max_state() callback needs to be run to produce the new maximum
1026 * cooling state value.
1028 void thermal_cooling_device_update(struct thermal_cooling_device *cdev)
1030 struct thermal_instance *ti;
1031 unsigned long state;
1033 if (IS_ERR_OR_NULL(cdev))
1037 * Hold thermal_list_lock throughout the update to prevent the device
1038 * from going away while being updated.
1040 mutex_lock(&thermal_list_lock);
1042 if (!thermal_cooling_device_present(cdev))
1046 * Update under the cdev lock to prevent the state from being set beyond
1047 * the new limit concurrently.
1049 mutex_lock(&cdev->lock);
1051 if (cdev->ops->get_max_state(cdev, &cdev->max_state))
1054 thermal_cooling_device_stats_reinit(cdev);
1056 list_for_each_entry(ti, &cdev->thermal_instances, cdev_node) {
1057 if (ti->upper == cdev->max_state)
1060 if (ti->upper < cdev->max_state) {
1061 if (ti->upper_no_limit)
1062 ti->upper = cdev->max_state;
1067 ti->upper = cdev->max_state;
1068 if (ti->lower > ti->upper)
1069 ti->lower = ti->upper;
1071 if (ti->target == THERMAL_NO_TARGET)
1074 if (ti->target > ti->upper)
1075 ti->target = ti->upper;
1078 if (cdev->ops->get_cur_state(cdev, &state) || state > cdev->max_state)
1081 thermal_cooling_device_stats_update(cdev, state);
1084 mutex_unlock(&cdev->lock);
1087 mutex_unlock(&thermal_list_lock);
1089 EXPORT_SYMBOL_GPL(thermal_cooling_device_update);
1092 * thermal_cooling_device_unregister - removes a thermal cooling device
1093 * @cdev: the thermal cooling device to remove.
1095 * thermal_cooling_device_unregister() must be called when a registered
1096 * thermal cooling device is no longer needed.
1098 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1100 struct thermal_zone_device *tz;
1105 mutex_lock(&thermal_list_lock);
1107 if (!thermal_cooling_device_present(cdev)) {
1108 mutex_unlock(&thermal_list_lock);
1112 list_del(&cdev->node);
1114 /* Unbind all thermal zones associated with 'this' cdev */
1115 list_for_each_entry(tz, &thermal_tz_list, node) {
1116 if (tz->ops->unbind)
1117 tz->ops->unbind(tz, cdev);
1120 mutex_unlock(&thermal_list_lock);
1122 device_unregister(&cdev->device);
1124 EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1126 static void bind_tz(struct thermal_zone_device *tz)
1129 struct thermal_cooling_device *pos = NULL;
1134 mutex_lock(&thermal_list_lock);
1136 list_for_each_entry(pos, &thermal_cdev_list, node) {
1137 ret = tz->ops->bind(tz, pos);
1139 print_bind_err_msg(tz, pos, ret);
1142 mutex_unlock(&thermal_list_lock);
1145 static void thermal_set_delay_jiffies(unsigned long *delay_jiffies, int delay_ms)
1147 *delay_jiffies = msecs_to_jiffies(delay_ms);
1148 if (delay_ms > 1000)
1149 *delay_jiffies = round_jiffies(*delay_jiffies);
1152 int thermal_zone_get_crit_temp(struct thermal_zone_device *tz, int *temp)
1154 int i, ret = -EINVAL;
1156 if (tz->ops->get_crit_temp)
1157 return tz->ops->get_crit_temp(tz, temp);
1162 mutex_lock(&tz->lock);
1164 for (i = 0; i < tz->num_trips; i++) {
1165 if (tz->trips[i].type == THERMAL_TRIP_CRITICAL) {
1166 *temp = tz->trips[i].temperature;
1172 mutex_unlock(&tz->lock);
1176 EXPORT_SYMBOL_GPL(thermal_zone_get_crit_temp);
1179 * thermal_zone_device_register_with_trips() - register a new thermal zone device
1180 * @type: the thermal zone device type
1181 * @trips: a pointer to an array of thermal trips
1182 * @num_trips: the number of trip points the thermal zone support
1183 * @mask: a bit string indicating the writeablility of trip points
1184 * @devdata: private device data
1185 * @ops: standard thermal zone device callbacks
1186 * @tzp: thermal zone platform parameters
1187 * @passive_delay: number of milliseconds to wait between polls when
1188 * performing passive cooling
1189 * @polling_delay: number of milliseconds to wait between polls when checking
1190 * whether trip points have been crossed (0 for interrupt
1193 * This interface function adds a new thermal zone device (sensor) to
1194 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1195 * thermal cooling devices registered at the same time.
1196 * thermal_zone_device_unregister() must be called when the device is no
1197 * longer needed. The passive cooling depends on the .get_trend() return value.
1199 * Return: a pointer to the created struct thermal_zone_device or an
1200 * in case of error, an ERR_PTR. Caller must check return value with
1201 * IS_ERR*() helpers.
1203 struct thermal_zone_device *
1204 thermal_zone_device_register_with_trips(const char *type, struct thermal_trip *trips, int num_trips, int mask,
1205 void *devdata, struct thermal_zone_device_ops *ops,
1206 const struct thermal_zone_params *tzp, int passive_delay,
1209 struct thermal_zone_device *tz;
1213 struct thermal_governor *governor;
1215 if (!type || strlen(type) == 0) {
1216 pr_err("No thermal zone type defined\n");
1217 return ERR_PTR(-EINVAL);
1220 if (strlen(type) >= THERMAL_NAME_LENGTH) {
1221 pr_err("Thermal zone name (%s) too long, should be under %d chars\n",
1222 type, THERMAL_NAME_LENGTH);
1223 return ERR_PTR(-EINVAL);
1227 * Max trip count can't exceed 31 as the "mask >> num_trips" condition.
1228 * For example, shifting by 32 will result in compiler warning:
1229 * warning: right shift count >= width of type [-Wshift-count- overflow]
1231 * Also "mask >> num_trips" will always be true with 32 bit shift.
1232 * E.g. mask = 0x80000000 for trip id 31 to be RW. Then
1233 * mask >> 32 = 0x80000000
1234 * This will result in failure for the below condition.
1236 * Check will be true when the bit 31 of the mask is set.
1237 * 32 bit shift will cause overflow of 4 byte integer.
1239 if (num_trips > (BITS_PER_TYPE(int) - 1) || num_trips < 0 || mask >> num_trips) {
1240 pr_err("Incorrect number of thermal trips\n");
1241 return ERR_PTR(-EINVAL);
1245 pr_err("Thermal zone device ops not defined\n");
1246 return ERR_PTR(-EINVAL);
1249 if (num_trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp) && !trips)
1250 return ERR_PTR(-EINVAL);
1253 return ERR_PTR(-ENODEV);
1255 tz = kzalloc(sizeof(*tz), GFP_KERNEL);
1257 return ERR_PTR(-ENOMEM);
1260 tz->tzp = kmemdup(tzp, sizeof(*tzp), GFP_KERNEL);
1267 INIT_LIST_HEAD(&tz->thermal_instances);
1269 mutex_init(&tz->lock);
1270 id = ida_alloc(&thermal_tz_ida, GFP_KERNEL);
1277 strscpy(tz->type, type, sizeof(tz->type));
1280 ops->critical = thermal_zone_device_critical;
1283 tz->device.class = thermal_class;
1284 tz->devdata = devdata;
1286 tz->num_trips = num_trips;
1288 thermal_set_delay_jiffies(&tz->passive_delay_jiffies, passive_delay);
1289 thermal_set_delay_jiffies(&tz->polling_delay_jiffies, polling_delay);
1292 /* Add nodes that are always present via .groups */
1293 result = thermal_zone_create_device_groups(tz, mask);
1297 /* A new thermal zone needs to be updated anyway. */
1298 atomic_set(&tz->need_update, 1);
1300 result = dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1302 thermal_zone_destroy_device_groups(tz);
1305 result = device_register(&tz->device);
1307 goto release_device;
1309 for (count = 0; count < num_trips; count++) {
1310 struct thermal_trip trip;
1312 result = thermal_zone_get_trip(tz, count, &trip);
1313 if (result || !trip.temperature)
1314 set_bit(count, &tz->trips_disabled);
1317 /* Update 'this' zone's governor information */
1318 mutex_lock(&thermal_governor_lock);
1321 governor = __find_governor(tz->tzp->governor_name);
1323 governor = def_governor;
1325 result = thermal_set_governor(tz, governor);
1327 mutex_unlock(&thermal_governor_lock);
1331 mutex_unlock(&thermal_governor_lock);
1333 if (!tz->tzp || !tz->tzp->no_hwmon) {
1334 result = thermal_add_hwmon_sysfs(tz);
1339 mutex_lock(&thermal_list_lock);
1340 list_add_tail(&tz->node, &thermal_tz_list);
1341 mutex_unlock(&thermal_list_lock);
1343 /* Bind cooling devices for this zone */
1346 INIT_DELAYED_WORK(&tz->poll_queue, thermal_zone_device_check);
1348 thermal_zone_device_init(tz);
1349 /* Update the new thermal zone and mark it as already updated. */
1350 if (atomic_cmpxchg(&tz->need_update, 1, 0))
1351 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
1353 thermal_notify_tz_create(tz->id, tz->type);
1358 device_del(&tz->device);
1360 put_device(&tz->device);
1363 ida_free(&thermal_tz_ida, id);
1368 return ERR_PTR(result);
1370 EXPORT_SYMBOL_GPL(thermal_zone_device_register_with_trips);
1372 struct thermal_zone_device *thermal_zone_device_register(const char *type, int ntrips, int mask,
1373 void *devdata, struct thermal_zone_device_ops *ops,
1374 const struct thermal_zone_params *tzp, int passive_delay,
1377 return thermal_zone_device_register_with_trips(type, NULL, ntrips, mask,
1379 passive_delay, polling_delay);
1381 EXPORT_SYMBOL_GPL(thermal_zone_device_register);
1383 void *thermal_zone_device_priv(struct thermal_zone_device *tzd)
1385 return tzd->devdata;
1387 EXPORT_SYMBOL_GPL(thermal_zone_device_priv);
1389 const char *thermal_zone_device_type(struct thermal_zone_device *tzd)
1393 EXPORT_SYMBOL_GPL(thermal_zone_device_type);
1395 int thermal_zone_device_id(struct thermal_zone_device *tzd)
1399 EXPORT_SYMBOL_GPL(thermal_zone_device_id);
1401 struct device *thermal_zone_device(struct thermal_zone_device *tzd)
1403 return &tzd->device;
1405 EXPORT_SYMBOL_GPL(thermal_zone_device);
1408 * thermal_zone_device_unregister - removes the registered thermal zone device
1409 * @tz: the thermal zone device to remove
1411 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1414 struct thermal_cooling_device *cdev;
1415 struct thermal_zone_device *pos = NULL;
1422 mutex_lock(&thermal_list_lock);
1423 list_for_each_entry(pos, &thermal_tz_list, node)
1427 /* thermal zone device not found */
1428 mutex_unlock(&thermal_list_lock);
1431 list_del(&tz->node);
1433 /* Unbind all cdevs associated with 'this' thermal zone */
1434 list_for_each_entry(cdev, &thermal_cdev_list, node)
1435 if (tz->ops->unbind)
1436 tz->ops->unbind(tz, cdev);
1438 mutex_unlock(&thermal_list_lock);
1440 cancel_delayed_work_sync(&tz->poll_queue);
1442 thermal_set_governor(tz, NULL);
1444 thermal_remove_hwmon_sysfs(tz);
1445 ida_free(&thermal_tz_ida, tz->id);
1446 ida_destroy(&tz->ida);
1448 mutex_lock(&tz->lock);
1449 device_del(&tz->device);
1450 mutex_unlock(&tz->lock);
1454 put_device(&tz->device);
1456 thermal_notify_tz_delete(tz_id);
1458 EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
1461 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
1462 * @name: thermal zone name to fetch the temperature
1464 * When only one zone is found with the passed name, returns a reference to it.
1466 * Return: On success returns a reference to an unique thermal zone with
1467 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
1468 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
1470 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
1472 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
1473 unsigned int found = 0;
1478 mutex_lock(&thermal_list_lock);
1479 list_for_each_entry(pos, &thermal_tz_list, node)
1480 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
1484 mutex_unlock(&thermal_list_lock);
1486 /* nothing has been found, thus an error code for it */
1488 ref = ERR_PTR(-ENODEV);
1490 /* Success only when an unique zone is found */
1491 ref = ERR_PTR(-EEXIST);
1496 EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
1498 static int thermal_pm_notify(struct notifier_block *nb,
1499 unsigned long mode, void *_unused)
1501 struct thermal_zone_device *tz;
1504 case PM_HIBERNATION_PREPARE:
1505 case PM_RESTORE_PREPARE:
1506 case PM_SUSPEND_PREPARE:
1507 atomic_set(&in_suspend, 1);
1509 case PM_POST_HIBERNATION:
1510 case PM_POST_RESTORE:
1511 case PM_POST_SUSPEND:
1512 atomic_set(&in_suspend, 0);
1513 list_for_each_entry(tz, &thermal_tz_list, node) {
1514 thermal_zone_device_init(tz);
1515 thermal_zone_device_update(tz,
1516 THERMAL_EVENT_UNSPECIFIED);
1525 static struct notifier_block thermal_pm_nb = {
1526 .notifier_call = thermal_pm_notify,
1529 static int __init thermal_init(void)
1533 result = thermal_netlink_init();
1537 result = thermal_register_governors();
1539 goto unregister_netlink;
1541 thermal_class = kzalloc(sizeof(*thermal_class), GFP_KERNEL);
1542 if (!thermal_class) {
1544 goto unregister_governors;
1547 thermal_class->name = "thermal";
1548 thermal_class->dev_release = thermal_release;
1550 result = class_register(thermal_class);
1552 kfree(thermal_class);
1553 thermal_class = NULL;
1554 goto unregister_governors;
1557 result = register_pm_notifier(&thermal_pm_nb);
1559 pr_warn("Thermal: Can not register suspend notifier, return %d\n",
1564 unregister_governors:
1565 thermal_unregister_governors();
1567 thermal_netlink_exit();
1569 mutex_destroy(&thermal_list_lock);
1570 mutex_destroy(&thermal_governor_lock);
1573 postcore_initcall(thermal_init);