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/module.h>
13 #include <linux/device.h>
14 #include <linux/err.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 <net/netlink.h>
23 #include <net/genetlink.h>
24 #include <linux/suspend.h>
26 #define CREATE_TRACE_POINTS
27 #include <trace/events/thermal.h>
29 #include "thermal_core.h"
30 #include "thermal_hwmon.h"
32 MODULE_AUTHOR("Zhang Rui");
33 MODULE_DESCRIPTION("Generic thermal management sysfs support");
34 MODULE_LICENSE("GPL v2");
36 static DEFINE_IDA(thermal_tz_ida);
37 static DEFINE_IDA(thermal_cdev_ida);
39 static LIST_HEAD(thermal_tz_list);
40 static LIST_HEAD(thermal_cdev_list);
41 static LIST_HEAD(thermal_governor_list);
43 static DEFINE_MUTEX(thermal_list_lock);
44 static DEFINE_MUTEX(thermal_governor_lock);
45 static DEFINE_MUTEX(poweroff_lock);
47 static atomic_t in_suspend;
48 static bool power_off_triggered;
50 static struct thermal_governor *def_governor;
53 * Governor section: set of functions to handle thermal governors
55 * Functions to help in the life cycle of thermal governors within
56 * the thermal core and by the thermal governor code.
59 static struct thermal_governor *__find_governor(const char *name)
61 struct thermal_governor *pos;
63 if (!name || !name[0])
66 list_for_each_entry(pos, &thermal_governor_list, governor_list)
67 if (!strncasecmp(name, pos->name, THERMAL_NAME_LENGTH))
74 * bind_previous_governor() - bind the previous governor of the thermal zone
75 * @tz: a valid pointer to a struct thermal_zone_device
76 * @failed_gov_name: the name of the governor that failed to register
78 * Register the previous governor of the thermal zone after a new
79 * governor has failed to be bound.
81 static void bind_previous_governor(struct thermal_zone_device *tz,
82 const char *failed_gov_name)
84 if (tz->governor && tz->governor->bind_to_tz) {
85 if (tz->governor->bind_to_tz(tz)) {
87 "governor %s failed to bind and the previous one (%s) failed to bind again, thermal zone %s has no governor\n",
88 failed_gov_name, tz->governor->name, tz->type);
95 * thermal_set_governor() - Switch to another governor
96 * @tz: a valid pointer to a struct thermal_zone_device
97 * @new_gov: pointer to the new governor
99 * Change the governor of thermal zone @tz.
101 * Return: 0 on success, an error if the new governor's bind_to_tz() failed.
103 static int thermal_set_governor(struct thermal_zone_device *tz,
104 struct thermal_governor *new_gov)
108 if (tz->governor && tz->governor->unbind_from_tz)
109 tz->governor->unbind_from_tz(tz);
111 if (new_gov && new_gov->bind_to_tz) {
112 ret = new_gov->bind_to_tz(tz);
114 bind_previous_governor(tz, new_gov->name);
120 tz->governor = new_gov;
125 int thermal_register_governor(struct thermal_governor *governor)
129 struct thermal_zone_device *pos;
134 mutex_lock(&thermal_governor_lock);
137 if (!__find_governor(governor->name)) {
141 list_add(&governor->governor_list, &thermal_governor_list);
142 match_default = !strncmp(governor->name,
143 DEFAULT_THERMAL_GOVERNOR,
144 THERMAL_NAME_LENGTH);
146 if (!def_governor && match_default)
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))
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);
205 int thermal_zone_device_set_policy(struct thermal_zone_device *tz,
208 struct thermal_governor *gov;
211 mutex_lock(&thermal_governor_lock);
212 mutex_lock(&tz->lock);
214 gov = __find_governor(strim(policy));
218 ret = thermal_set_governor(tz, gov);
221 mutex_unlock(&tz->lock);
222 mutex_unlock(&thermal_governor_lock);
227 int thermal_build_list_of_policies(char *buf)
229 struct thermal_governor *pos;
231 ssize_t size = PAGE_SIZE;
233 mutex_lock(&thermal_governor_lock);
235 list_for_each_entry(pos, &thermal_governor_list, governor_list) {
236 size = PAGE_SIZE - count;
237 count += scnprintf(buf + count, size, "%s ", pos->name);
239 count += scnprintf(buf + count, size, "\n");
241 mutex_unlock(&thermal_governor_lock);
246 static void __init thermal_unregister_governors(void)
248 struct thermal_governor **governor;
250 for_each_governor_table(governor)
251 thermal_unregister_governor(*governor);
254 static int __init thermal_register_governors(void)
257 struct thermal_governor **governor;
259 for_each_governor_table(governor) {
260 ret = thermal_register_governor(*governor);
262 pr_err("Failed to register governor: '%s'",
267 pr_info("Registered thermal governor '%s'",
272 struct thermal_governor **gov;
274 for_each_governor_table(gov) {
277 thermal_unregister_governor(*gov);
285 * Zone update section: main control loop applied to each zone while monitoring
287 * in polling mode. The monitoring is done using a workqueue.
288 * Same update may be done on a zone by calling thermal_zone_device_update().
291 * - Non-critical trips will invoke the governor responsible for that zone;
292 * - Hot trips will produce a notification to userspace;
293 * - Critical trip point will cause a system shutdown.
295 static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
299 mod_delayed_work(system_freezable_power_efficient_wq,
301 round_jiffies(msecs_to_jiffies(delay)));
303 mod_delayed_work(system_freezable_power_efficient_wq,
305 msecs_to_jiffies(delay));
307 cancel_delayed_work_sync(&tz->poll_queue);
310 static void monitor_thermal_zone(struct thermal_zone_device *tz)
312 mutex_lock(&tz->lock);
315 thermal_zone_device_set_polling(tz, tz->passive_delay);
316 else if (tz->polling_delay)
317 thermal_zone_device_set_polling(tz, tz->polling_delay);
319 thermal_zone_device_set_polling(tz, 0);
321 mutex_unlock(&tz->lock);
324 static void handle_non_critical_trips(struct thermal_zone_device *tz, int trip)
326 tz->governor ? tz->governor->throttle(tz, trip) :
327 def_governor->throttle(tz, trip);
331 * thermal_emergency_poweroff_func - emergency poweroff work after a known delay
332 * @work: work_struct associated with the emergency poweroff function
334 * This function is called in very critical situations to force
335 * a kernel poweroff after a configurable timeout value.
337 static void thermal_emergency_poweroff_func(struct work_struct *work)
340 * We have reached here after the emergency thermal shutdown
341 * Waiting period has expired. This means orderly_poweroff has
342 * not been able to shut off the system for some reason.
343 * Try to shut down the system immediately using kernel_power_off
346 WARN(1, "Attempting kernel_power_off: Temperature too high\n");
350 * Worst of the worst case trigger emergency restart
352 WARN(1, "Attempting emergency_restart: Temperature too high\n");
356 static DECLARE_DELAYED_WORK(thermal_emergency_poweroff_work,
357 thermal_emergency_poweroff_func);
360 * thermal_emergency_poweroff - Trigger an emergency system poweroff
362 * This may be called from any critical situation to trigger a system shutdown
363 * after a known period of time. By default this is not scheduled.
365 static void thermal_emergency_poweroff(void)
367 int poweroff_delay_ms = CONFIG_THERMAL_EMERGENCY_POWEROFF_DELAY_MS;
369 * poweroff_delay_ms must be a carefully profiled positive value.
370 * Its a must for thermal_emergency_poweroff_work to be scheduled
372 if (poweroff_delay_ms <= 0)
374 schedule_delayed_work(&thermal_emergency_poweroff_work,
375 msecs_to_jiffies(poweroff_delay_ms));
378 static void handle_critical_trips(struct thermal_zone_device *tz,
379 int trip, enum thermal_trip_type trip_type)
383 tz->ops->get_trip_temp(tz, trip, &trip_temp);
385 /* If we have not crossed the trip_temp, we do not care. */
386 if (trip_temp <= 0 || tz->temperature < trip_temp)
389 trace_thermal_zone_trip(tz, trip, trip_type);
392 tz->ops->notify(tz, trip, trip_type);
394 if (trip_type == THERMAL_TRIP_CRITICAL) {
395 dev_emerg(&tz->device,
396 "critical temperature reached (%d C), shutting down\n",
397 tz->temperature / 1000);
398 mutex_lock(&poweroff_lock);
399 if (!power_off_triggered) {
401 * Queue a backup emergency shutdown in the event of
402 * orderly_poweroff failure
404 thermal_emergency_poweroff();
405 orderly_poweroff(true);
406 power_off_triggered = true;
408 mutex_unlock(&poweroff_lock);
412 static void handle_thermal_trip(struct thermal_zone_device *tz, int trip)
414 enum thermal_trip_type type;
416 /* Ignore disabled trip points */
417 if (test_bit(trip, &tz->trips_disabled))
420 tz->ops->get_trip_type(tz, trip, &type);
422 if (type == THERMAL_TRIP_CRITICAL || type == THERMAL_TRIP_HOT)
423 handle_critical_trips(tz, trip, type);
425 handle_non_critical_trips(tz, trip);
427 * Alright, we handled this trip successfully.
428 * So, start monitoring again.
430 monitor_thermal_zone(tz);
433 static void update_temperature(struct thermal_zone_device *tz)
437 ret = thermal_zone_get_temp(tz, &temp);
440 dev_warn(&tz->device,
441 "failed to read out thermal zone (%d)\n",
446 mutex_lock(&tz->lock);
447 tz->last_temperature = tz->temperature;
448 tz->temperature = temp;
449 mutex_unlock(&tz->lock);
451 trace_thermal_temperature(tz);
452 if (tz->last_temperature == THERMAL_TEMP_INVALID)
453 dev_dbg(&tz->device, "last_temperature N/A, current_temperature=%d\n",
456 dev_dbg(&tz->device, "last_temperature=%d, current_temperature=%d\n",
457 tz->last_temperature, tz->temperature);
460 static void thermal_zone_device_init(struct thermal_zone_device *tz)
462 struct thermal_instance *pos;
463 tz->temperature = THERMAL_TEMP_INVALID;
464 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
465 pos->initialized = false;
468 static void thermal_zone_device_reset(struct thermal_zone_device *tz)
471 thermal_zone_device_init(tz);
474 void thermal_zone_device_update(struct thermal_zone_device *tz,
475 enum thermal_notify_event event)
479 if (atomic_read(&in_suspend))
482 if (!tz->ops->get_temp)
485 update_temperature(tz);
487 thermal_zone_set_trips(tz);
489 tz->notify_event = event;
491 for (count = 0; count < tz->trips; count++)
492 handle_thermal_trip(tz, count);
494 EXPORT_SYMBOL_GPL(thermal_zone_device_update);
497 * thermal_notify_framework - Sensor drivers use this API to notify framework
498 * @tz: thermal zone device
499 * @trip: indicates which trip point has been crossed
501 * This function handles the trip events from sensor drivers. It starts
502 * throttling the cooling devices according to the policy configured.
503 * For CRITICAL and HOT trip points, this notifies the respective drivers,
504 * and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
505 * The throttling policy is based on the configured platform data; if no
506 * platform data is provided, this uses the step_wise throttling policy.
508 void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
510 handle_thermal_trip(tz, trip);
512 EXPORT_SYMBOL_GPL(thermal_notify_framework);
514 static void thermal_zone_device_check(struct work_struct *work)
516 struct thermal_zone_device *tz = container_of(work, struct
519 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
523 * Power actor section: interface to power actors to estimate power
525 * Set of functions used to interact to cooling devices that know
526 * how to estimate their devices power consumption.
530 * power_actor_get_max_power() - get the maximum power that a cdev can consume
531 * @cdev: pointer to &thermal_cooling_device
532 * @tz: a valid thermal zone device pointer
533 * @max_power: pointer in which to store the maximum power
535 * Calculate the maximum power consumption in milliwats that the
536 * cooling device can currently consume and store it in @max_power.
538 * Return: 0 on success, -EINVAL if @cdev doesn't support the
539 * power_actor API or -E* on other error.
541 int power_actor_get_max_power(struct thermal_cooling_device *cdev,
542 struct thermal_zone_device *tz, u32 *max_power)
544 if (!cdev_is_power_actor(cdev))
547 return cdev->ops->state2power(cdev, tz, 0, max_power);
551 * power_actor_get_min_power() - get the mainimum power that a cdev can consume
552 * @cdev: pointer to &thermal_cooling_device
553 * @tz: a valid thermal zone device pointer
554 * @min_power: pointer in which to store the minimum power
556 * Calculate the minimum power consumption in milliwatts that the
557 * cooling device can currently consume and store it in @min_power.
559 * Return: 0 on success, -EINVAL if @cdev doesn't support the
560 * power_actor API or -E* on other error.
562 int power_actor_get_min_power(struct thermal_cooling_device *cdev,
563 struct thermal_zone_device *tz, u32 *min_power)
565 unsigned long max_state;
568 if (!cdev_is_power_actor(cdev))
571 ret = cdev->ops->get_max_state(cdev, &max_state);
575 return cdev->ops->state2power(cdev, tz, max_state, min_power);
579 * power_actor_set_power() - limit the maximum power a cooling device consumes
580 * @cdev: pointer to &thermal_cooling_device
581 * @instance: thermal instance to update
582 * @power: the power in milliwatts
584 * Set the cooling device to consume at most @power milliwatts. The limit is
585 * expected to be a cap at the maximum power consumption.
587 * Return: 0 on success, -EINVAL if the cooling device does not
588 * implement the power actor API or -E* for other failures.
590 int power_actor_set_power(struct thermal_cooling_device *cdev,
591 struct thermal_instance *instance, u32 power)
596 if (!cdev_is_power_actor(cdev))
599 ret = cdev->ops->power2state(cdev, instance->tz, power, &state);
603 instance->target = state;
604 mutex_lock(&cdev->lock);
605 cdev->updated = false;
606 mutex_unlock(&cdev->lock);
607 thermal_cdev_update(cdev);
612 void thermal_zone_device_rebind_exception(struct thermal_zone_device *tz,
613 const char *cdev_type, size_t size)
615 struct thermal_cooling_device *cdev = NULL;
617 mutex_lock(&thermal_list_lock);
618 list_for_each_entry(cdev, &thermal_cdev_list, node) {
619 /* skip non matching cdevs */
620 if (strncmp(cdev_type, cdev->type, size))
623 /* re binding the exception matching the type pattern */
624 thermal_zone_bind_cooling_device(tz, THERMAL_TRIPS_NONE, cdev,
627 THERMAL_WEIGHT_DEFAULT);
629 mutex_unlock(&thermal_list_lock);
632 void thermal_zone_device_unbind_exception(struct thermal_zone_device *tz,
633 const char *cdev_type, size_t size)
635 struct thermal_cooling_device *cdev = NULL;
637 mutex_lock(&thermal_list_lock);
638 list_for_each_entry(cdev, &thermal_cdev_list, node) {
639 /* skip non matching cdevs */
640 if (strncmp(cdev_type, cdev->type, size))
642 /* unbinding the exception matching the type pattern */
643 thermal_zone_unbind_cooling_device(tz, THERMAL_TRIPS_NONE,
646 mutex_unlock(&thermal_list_lock);
650 * Device management section: cooling devices, zones devices, and binding
652 * Set of functions provided by the thermal core for:
653 * - cooling devices lifecycle: registration, unregistration,
654 * binding, and unbinding.
655 * - thermal zone devices lifecycle: registration, unregistration,
656 * binding, and unbinding.
660 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
661 * @tz: pointer to struct thermal_zone_device
662 * @trip: indicates which trip point the cooling devices is
663 * associated with in this thermal zone.
664 * @cdev: pointer to struct thermal_cooling_device
665 * @upper: the Maximum cooling state for this trip point.
666 * THERMAL_NO_LIMIT means no upper limit,
667 * and the cooling device can be in max_state.
668 * @lower: the Minimum cooling state can be used for this trip point.
669 * THERMAL_NO_LIMIT means no lower limit,
670 * and the cooling device can be in cooling state 0.
671 * @weight: The weight of the cooling device to be bound to the
672 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
675 * This interface function bind a thermal cooling device to the certain trip
676 * point of a thermal zone device.
677 * This function is usually called in the thermal zone device .bind callback.
679 * Return: 0 on success, the proper error value otherwise.
681 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
683 struct thermal_cooling_device *cdev,
684 unsigned long upper, unsigned long lower,
687 struct thermal_instance *dev;
688 struct thermal_instance *pos;
689 struct thermal_zone_device *pos1;
690 struct thermal_cooling_device *pos2;
691 unsigned long max_state;
694 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
697 list_for_each_entry(pos1, &thermal_tz_list, node) {
701 list_for_each_entry(pos2, &thermal_cdev_list, node) {
706 if (tz != pos1 || cdev != pos2)
709 ret = cdev->ops->get_max_state(cdev, &max_state);
713 /* lower default 0, upper default max_state */
714 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
715 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
717 if (lower > upper || upper > max_state)
720 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
728 dev->target = THERMAL_NO_TARGET;
729 dev->weight = weight;
731 result = ida_simple_get(&tz->ida, 0, 0, GFP_KERNEL);
736 sprintf(dev->name, "cdev%d", dev->id);
738 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
742 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
743 sysfs_attr_init(&dev->attr.attr);
744 dev->attr.attr.name = dev->attr_name;
745 dev->attr.attr.mode = 0444;
746 dev->attr.show = trip_point_show;
747 result = device_create_file(&tz->device, &dev->attr);
749 goto remove_symbol_link;
751 sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
752 sysfs_attr_init(&dev->weight_attr.attr);
753 dev->weight_attr.attr.name = dev->weight_attr_name;
754 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
755 dev->weight_attr.show = weight_show;
756 dev->weight_attr.store = weight_store;
757 result = device_create_file(&tz->device, &dev->weight_attr);
759 goto remove_trip_file;
761 mutex_lock(&tz->lock);
762 mutex_lock(&cdev->lock);
763 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
764 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
769 list_add_tail(&dev->tz_node, &tz->thermal_instances);
770 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
771 atomic_set(&tz->need_update, 1);
773 mutex_unlock(&cdev->lock);
774 mutex_unlock(&tz->lock);
779 device_remove_file(&tz->device, &dev->weight_attr);
781 device_remove_file(&tz->device, &dev->attr);
783 sysfs_remove_link(&tz->device.kobj, dev->name);
785 ida_simple_remove(&tz->ida, dev->id);
790 EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
793 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
795 * @tz: pointer to a struct thermal_zone_device.
796 * @trip: indicates which trip point the cooling devices is
797 * associated with in this thermal zone.
798 * @cdev: pointer to a struct thermal_cooling_device.
800 * This interface function unbind a thermal cooling device from the certain
801 * trip point of a thermal zone device.
802 * This function is usually called in the thermal zone device .unbind callback.
804 * Return: 0 on success, the proper error value otherwise.
806 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
808 struct thermal_cooling_device *cdev)
810 struct thermal_instance *pos, *next;
812 mutex_lock(&tz->lock);
813 mutex_lock(&cdev->lock);
814 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
815 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
816 list_del(&pos->tz_node);
817 list_del(&pos->cdev_node);
818 mutex_unlock(&cdev->lock);
819 mutex_unlock(&tz->lock);
823 mutex_unlock(&cdev->lock);
824 mutex_unlock(&tz->lock);
829 device_remove_file(&tz->device, &pos->weight_attr);
830 device_remove_file(&tz->device, &pos->attr);
831 sysfs_remove_link(&tz->device.kobj, pos->name);
832 ida_simple_remove(&tz->ida, pos->id);
836 EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
838 static void thermal_release(struct device *dev)
840 struct thermal_zone_device *tz;
841 struct thermal_cooling_device *cdev;
843 if (!strncmp(dev_name(dev), "thermal_zone",
844 sizeof("thermal_zone") - 1)) {
845 tz = to_thermal_zone(dev);
846 thermal_zone_destroy_device_groups(tz);
848 } else if (!strncmp(dev_name(dev), "cooling_device",
849 sizeof("cooling_device") - 1)) {
850 cdev = to_cooling_device(dev);
855 static struct class thermal_class = {
857 .dev_release = thermal_release,
861 void print_bind_err_msg(struct thermal_zone_device *tz,
862 struct thermal_cooling_device *cdev, int ret)
864 dev_err(&tz->device, "binding zone %s with cdev %s failed:%d\n",
865 tz->type, cdev->type, ret);
868 static void __bind(struct thermal_zone_device *tz, int mask,
869 struct thermal_cooling_device *cdev,
870 unsigned long *limits,
875 for (i = 0; i < tz->trips; i++) {
876 if (mask & (1 << i)) {
877 unsigned long upper, lower;
879 upper = THERMAL_NO_LIMIT;
880 lower = THERMAL_NO_LIMIT;
882 lower = limits[i * 2];
883 upper = limits[i * 2 + 1];
885 ret = thermal_zone_bind_cooling_device(tz, i, cdev,
889 print_bind_err_msg(tz, cdev, ret);
894 static void bind_cdev(struct thermal_cooling_device *cdev)
897 const struct thermal_zone_params *tzp;
898 struct thermal_zone_device *pos = NULL;
900 mutex_lock(&thermal_list_lock);
902 list_for_each_entry(pos, &thermal_tz_list, node) {
903 if (!pos->tzp && !pos->ops->bind)
906 if (pos->ops->bind) {
907 ret = pos->ops->bind(pos, cdev);
909 print_bind_err_msg(pos, cdev, ret);
914 if (!tzp || !tzp->tbp)
917 for (i = 0; i < tzp->num_tbps; i++) {
918 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
920 if (tzp->tbp[i].match(pos, cdev))
922 tzp->tbp[i].cdev = cdev;
923 __bind(pos, tzp->tbp[i].trip_mask, cdev,
924 tzp->tbp[i].binding_limits,
929 mutex_unlock(&thermal_list_lock);
933 * __thermal_cooling_device_register() - register a new thermal cooling device
934 * @np: a pointer to a device tree node.
935 * @type: the thermal cooling device type.
936 * @devdata: device private data.
937 * @ops: standard thermal cooling devices callbacks.
939 * This interface function adds a new thermal cooling device (fan/processor/...)
940 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
941 * to all the thermal zone devices registered at the same time.
942 * It also gives the opportunity to link the cooling device to a device tree
943 * node, so that it can be bound to a thermal zone created out of device tree.
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 static struct thermal_cooling_device *
949 __thermal_cooling_device_register(struct device_node *np,
950 const char *type, void *devdata,
951 const struct thermal_cooling_device_ops *ops)
953 struct thermal_cooling_device *cdev;
954 struct thermal_zone_device *pos = NULL;
957 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
958 return ERR_PTR(-EINVAL);
960 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
962 return ERR_PTR(-EINVAL);
964 cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
966 return ERR_PTR(-ENOMEM);
968 result = ida_simple_get(&thermal_cdev_ida, 0, 0, GFP_KERNEL);
971 return ERR_PTR(result);
975 strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
976 mutex_init(&cdev->lock);
977 INIT_LIST_HEAD(&cdev->thermal_instances);
980 cdev->updated = false;
981 cdev->device.class = &thermal_class;
982 cdev->devdata = devdata;
983 thermal_cooling_device_setup_sysfs(cdev);
984 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
985 result = device_register(&cdev->device);
987 ida_simple_remove(&thermal_cdev_ida, cdev->id);
988 put_device(&cdev->device);
989 return ERR_PTR(result);
992 /* Add 'this' new cdev to the global cdev list */
993 mutex_lock(&thermal_list_lock);
994 list_add(&cdev->node, &thermal_cdev_list);
995 mutex_unlock(&thermal_list_lock);
997 /* Update binding information for 'this' new cdev */
1000 mutex_lock(&thermal_list_lock);
1001 list_for_each_entry(pos, &thermal_tz_list, node)
1002 if (atomic_cmpxchg(&pos->need_update, 1, 0))
1003 thermal_zone_device_update(pos,
1004 THERMAL_EVENT_UNSPECIFIED);
1005 mutex_unlock(&thermal_list_lock);
1011 * thermal_cooling_device_register() - register a new thermal cooling device
1012 * @type: the thermal cooling device type.
1013 * @devdata: device private data.
1014 * @ops: standard thermal cooling devices callbacks.
1016 * This interface function adds a new thermal cooling device (fan/processor/...)
1017 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1018 * to all the thermal zone devices registered at the same time.
1020 * Return: a pointer to the created struct thermal_cooling_device or an
1021 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1023 struct thermal_cooling_device *
1024 thermal_cooling_device_register(const char *type, void *devdata,
1025 const struct thermal_cooling_device_ops *ops)
1027 return __thermal_cooling_device_register(NULL, type, devdata, ops);
1029 EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
1032 * thermal_of_cooling_device_register() - register an OF thermal cooling device
1033 * @np: a pointer to a device tree node.
1034 * @type: the thermal cooling device type.
1035 * @devdata: device private data.
1036 * @ops: standard thermal cooling devices callbacks.
1038 * This function will register a cooling device with device tree node reference.
1039 * This interface function adds a new thermal cooling device (fan/processor/...)
1040 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1041 * to all the thermal zone devices registered at the same time.
1043 * Return: a pointer to the created struct thermal_cooling_device or an
1044 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1046 struct thermal_cooling_device *
1047 thermal_of_cooling_device_register(struct device_node *np,
1048 const char *type, void *devdata,
1049 const struct thermal_cooling_device_ops *ops)
1051 return __thermal_cooling_device_register(np, type, devdata, ops);
1053 EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
1055 static void thermal_cooling_device_release(struct device *dev, void *res)
1057 thermal_cooling_device_unregister(
1058 *(struct thermal_cooling_device **)res);
1062 * devm_thermal_of_cooling_device_register() - register an OF thermal cooling
1064 * @dev: a valid struct device pointer of a sensor device.
1065 * @np: a pointer to a device tree node.
1066 * @type: the thermal cooling device type.
1067 * @devdata: device private data.
1068 * @ops: standard thermal cooling devices callbacks.
1070 * This function will register a cooling device with device tree node reference.
1071 * This interface function adds a new thermal cooling device (fan/processor/...)
1072 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1073 * to all the thermal zone devices registered at the same time.
1075 * Return: a pointer to the created struct thermal_cooling_device or an
1076 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1078 struct thermal_cooling_device *
1079 devm_thermal_of_cooling_device_register(struct device *dev,
1080 struct device_node *np,
1081 char *type, void *devdata,
1082 const struct thermal_cooling_device_ops *ops)
1084 struct thermal_cooling_device **ptr, *tcd;
1086 ptr = devres_alloc(thermal_cooling_device_release, sizeof(*ptr),
1089 return ERR_PTR(-ENOMEM);
1091 tcd = __thermal_cooling_device_register(np, type, devdata, ops);
1098 devres_add(dev, ptr);
1102 EXPORT_SYMBOL_GPL(devm_thermal_of_cooling_device_register);
1104 static void __unbind(struct thermal_zone_device *tz, int mask,
1105 struct thermal_cooling_device *cdev)
1109 for (i = 0; i < tz->trips; i++)
1110 if (mask & (1 << i))
1111 thermal_zone_unbind_cooling_device(tz, i, cdev);
1115 * thermal_cooling_device_unregister - removes a thermal cooling device
1116 * @cdev: the thermal cooling device to remove.
1118 * thermal_cooling_device_unregister() must be called when a registered
1119 * thermal cooling device is no longer needed.
1121 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1124 const struct thermal_zone_params *tzp;
1125 struct thermal_zone_device *tz;
1126 struct thermal_cooling_device *pos = NULL;
1131 mutex_lock(&thermal_list_lock);
1132 list_for_each_entry(pos, &thermal_cdev_list, node)
1136 /* thermal cooling device not found */
1137 mutex_unlock(&thermal_list_lock);
1140 list_del(&cdev->node);
1142 /* Unbind all thermal zones associated with 'this' cdev */
1143 list_for_each_entry(tz, &thermal_tz_list, node) {
1144 if (tz->ops->unbind) {
1145 tz->ops->unbind(tz, cdev);
1149 if (!tz->tzp || !tz->tzp->tbp)
1153 for (i = 0; i < tzp->num_tbps; i++) {
1154 if (tzp->tbp[i].cdev == cdev) {
1155 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1156 tzp->tbp[i].cdev = NULL;
1161 mutex_unlock(&thermal_list_lock);
1163 ida_simple_remove(&thermal_cdev_ida, cdev->id);
1164 device_del(&cdev->device);
1165 thermal_cooling_device_destroy_sysfs(cdev);
1166 put_device(&cdev->device);
1168 EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1170 static void bind_tz(struct thermal_zone_device *tz)
1173 struct thermal_cooling_device *pos = NULL;
1174 const struct thermal_zone_params *tzp = tz->tzp;
1176 if (!tzp && !tz->ops->bind)
1179 mutex_lock(&thermal_list_lock);
1181 /* If there is ops->bind, try to use ops->bind */
1182 if (tz->ops->bind) {
1183 list_for_each_entry(pos, &thermal_cdev_list, node) {
1184 ret = tz->ops->bind(tz, pos);
1186 print_bind_err_msg(tz, pos, ret);
1191 if (!tzp || !tzp->tbp)
1194 list_for_each_entry(pos, &thermal_cdev_list, node) {
1195 for (i = 0; i < tzp->num_tbps; i++) {
1196 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
1198 if (tzp->tbp[i].match(tz, pos))
1200 tzp->tbp[i].cdev = pos;
1201 __bind(tz, tzp->tbp[i].trip_mask, pos,
1202 tzp->tbp[i].binding_limits,
1203 tzp->tbp[i].weight);
1207 mutex_unlock(&thermal_list_lock);
1211 * thermal_zone_device_register() - register a new thermal zone device
1212 * @type: the thermal zone device type
1213 * @trips: the number of trip points the thermal zone support
1214 * @mask: a bit string indicating the writeablility of trip points
1215 * @devdata: private device data
1216 * @ops: standard thermal zone device callbacks
1217 * @tzp: thermal zone platform parameters
1218 * @passive_delay: number of milliseconds to wait between polls when
1219 * performing passive cooling
1220 * @polling_delay: number of milliseconds to wait between polls when checking
1221 * whether trip points have been crossed (0 for interrupt
1224 * This interface function adds a new thermal zone device (sensor) to
1225 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1226 * thermal cooling devices registered at the same time.
1227 * thermal_zone_device_unregister() must be called when the device is no
1228 * longer needed. The passive cooling depends on the .get_trend() return value.
1230 * Return: a pointer to the created struct thermal_zone_device or an
1231 * in case of error, an ERR_PTR. Caller must check return value with
1232 * IS_ERR*() helpers.
1234 struct thermal_zone_device *
1235 thermal_zone_device_register(const char *type, int trips, int mask,
1236 void *devdata, struct thermal_zone_device_ops *ops,
1237 struct thermal_zone_params *tzp, int passive_delay,
1240 struct thermal_zone_device *tz;
1241 enum thermal_trip_type trip_type;
1246 struct thermal_governor *governor;
1248 if (!type || strlen(type) == 0) {
1249 pr_err("Error: No thermal zone type defined\n");
1250 return ERR_PTR(-EINVAL);
1253 if (type && strlen(type) >= THERMAL_NAME_LENGTH) {
1254 pr_err("Error: Thermal zone name (%s) too long, should be under %d chars\n",
1255 type, THERMAL_NAME_LENGTH);
1256 return ERR_PTR(-EINVAL);
1259 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips) {
1260 pr_err("Error: Incorrect number of thermal trips\n");
1261 return ERR_PTR(-EINVAL);
1265 pr_err("Error: Thermal zone device ops not defined\n");
1266 return ERR_PTR(-EINVAL);
1269 if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
1270 return ERR_PTR(-EINVAL);
1272 tz = kzalloc(sizeof(*tz), GFP_KERNEL);
1274 return ERR_PTR(-ENOMEM);
1276 INIT_LIST_HEAD(&tz->thermal_instances);
1278 mutex_init(&tz->lock);
1279 id = ida_simple_get(&thermal_tz_ida, 0, 0, GFP_KERNEL);
1286 strlcpy(tz->type, type, sizeof(tz->type));
1289 tz->device.class = &thermal_class;
1290 tz->devdata = devdata;
1292 tz->passive_delay = passive_delay;
1293 tz->polling_delay = polling_delay;
1296 /* Add nodes that are always present via .groups */
1297 result = thermal_zone_create_device_groups(tz, mask);
1301 /* A new thermal zone needs to be updated anyway. */
1302 atomic_set(&tz->need_update, 1);
1304 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1305 result = device_register(&tz->device);
1307 goto release_device;
1309 for (count = 0; count < trips; count++) {
1310 if (tz->ops->get_trip_type(tz, count, &trip_type))
1311 set_bit(count, &tz->trips_disabled);
1312 if (tz->ops->get_trip_temp(tz, count, &trip_temp))
1313 set_bit(count, &tz->trips_disabled);
1314 /* Check for bogus trip points */
1316 set_bit(count, &tz->trips_disabled);
1319 /* Update 'this' zone's governor information */
1320 mutex_lock(&thermal_governor_lock);
1323 governor = __find_governor(tz->tzp->governor_name);
1325 governor = def_governor;
1327 result = thermal_set_governor(tz, governor);
1329 mutex_unlock(&thermal_governor_lock);
1333 mutex_unlock(&thermal_governor_lock);
1335 if (!tz->tzp || !tz->tzp->no_hwmon) {
1336 result = thermal_add_hwmon_sysfs(tz);
1341 mutex_lock(&thermal_list_lock);
1342 list_add_tail(&tz->node, &thermal_tz_list);
1343 mutex_unlock(&thermal_list_lock);
1345 /* Bind cooling devices for this zone */
1348 INIT_DELAYED_WORK(&tz->poll_queue, thermal_zone_device_check);
1350 thermal_zone_device_reset(tz);
1351 /* Update the new thermal zone and mark it as already updated. */
1352 if (atomic_cmpxchg(&tz->need_update, 1, 0))
1353 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
1358 device_del(&tz->device);
1360 put_device(&tz->device);
1363 ida_simple_remove(&thermal_tz_ida, id);
1366 return ERR_PTR(result);
1368 EXPORT_SYMBOL_GPL(thermal_zone_device_register);
1371 * thermal_device_unregister - removes the registered thermal zone device
1372 * @tz: the thermal zone device to remove
1374 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1377 const struct thermal_zone_params *tzp;
1378 struct thermal_cooling_device *cdev;
1379 struct thermal_zone_device *pos = NULL;
1386 mutex_lock(&thermal_list_lock);
1387 list_for_each_entry(pos, &thermal_tz_list, node)
1391 /* thermal zone device not found */
1392 mutex_unlock(&thermal_list_lock);
1395 list_del(&tz->node);
1397 /* Unbind all cdevs associated with 'this' thermal zone */
1398 list_for_each_entry(cdev, &thermal_cdev_list, node) {
1399 if (tz->ops->unbind) {
1400 tz->ops->unbind(tz, cdev);
1404 if (!tzp || !tzp->tbp)
1407 for (i = 0; i < tzp->num_tbps; i++) {
1408 if (tzp->tbp[i].cdev == cdev) {
1409 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1410 tzp->tbp[i].cdev = NULL;
1415 mutex_unlock(&thermal_list_lock);
1417 thermal_zone_device_set_polling(tz, 0);
1419 thermal_set_governor(tz, NULL);
1421 thermal_remove_hwmon_sysfs(tz);
1422 ida_simple_remove(&thermal_tz_ida, tz->id);
1423 ida_destroy(&tz->ida);
1424 mutex_destroy(&tz->lock);
1425 device_unregister(&tz->device);
1427 EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
1430 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
1431 * @name: thermal zone name to fetch the temperature
1433 * When only one zone is found with the passed name, returns a reference to it.
1435 * Return: On success returns a reference to an unique thermal zone with
1436 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
1437 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
1439 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
1441 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
1442 unsigned int found = 0;
1447 mutex_lock(&thermal_list_lock);
1448 list_for_each_entry(pos, &thermal_tz_list, node)
1449 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
1453 mutex_unlock(&thermal_list_lock);
1455 /* nothing has been found, thus an error code for it */
1457 ref = ERR_PTR(-ENODEV);
1459 /* Success only when an unique zone is found */
1460 ref = ERR_PTR(-EEXIST);
1465 EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
1468 static const struct genl_multicast_group thermal_event_mcgrps[] = {
1469 { .name = THERMAL_GENL_MCAST_GROUP_NAME, },
1472 static struct genl_family thermal_event_genl_family __ro_after_init = {
1473 .module = THIS_MODULE,
1474 .name = THERMAL_GENL_FAMILY_NAME,
1475 .version = THERMAL_GENL_VERSION,
1476 .maxattr = THERMAL_GENL_ATTR_MAX,
1477 .mcgrps = thermal_event_mcgrps,
1478 .n_mcgrps = ARRAY_SIZE(thermal_event_mcgrps),
1481 int thermal_generate_netlink_event(struct thermal_zone_device *tz,
1484 struct sk_buff *skb;
1485 struct nlattr *attr;
1486 struct thermal_genl_event *thermal_event;
1490 static unsigned int thermal_event_seqnum;
1495 /* allocate memory */
1496 size = nla_total_size(sizeof(struct thermal_genl_event)) +
1499 skb = genlmsg_new(size, GFP_ATOMIC);
1503 /* add the genetlink message header */
1504 msg_header = genlmsg_put(skb, 0, thermal_event_seqnum++,
1505 &thermal_event_genl_family, 0,
1506 THERMAL_GENL_CMD_EVENT);
1513 attr = nla_reserve(skb, THERMAL_GENL_ATTR_EVENT,
1514 sizeof(struct thermal_genl_event));
1521 thermal_event = nla_data(attr);
1522 if (!thermal_event) {
1527 memset(thermal_event, 0, sizeof(struct thermal_genl_event));
1529 thermal_event->orig = tz->id;
1530 thermal_event->event = event;
1532 /* send multicast genetlink message */
1533 genlmsg_end(skb, msg_header);
1535 result = genlmsg_multicast(&thermal_event_genl_family, skb, 0,
1538 dev_err(&tz->device, "Failed to send netlink event:%d", result);
1542 EXPORT_SYMBOL_GPL(thermal_generate_netlink_event);
1544 static int __init genetlink_init(void)
1546 return genl_register_family(&thermal_event_genl_family);
1549 static void genetlink_exit(void)
1551 genl_unregister_family(&thermal_event_genl_family);
1553 #else /* !CONFIG_NET */
1554 static inline int genetlink_init(void) { return 0; }
1555 static inline void genetlink_exit(void) {}
1556 #endif /* !CONFIG_NET */
1558 static int thermal_pm_notify(struct notifier_block *nb,
1559 unsigned long mode, void *_unused)
1561 struct thermal_zone_device *tz;
1562 enum thermal_device_mode tz_mode;
1565 case PM_HIBERNATION_PREPARE:
1566 case PM_RESTORE_PREPARE:
1567 case PM_SUSPEND_PREPARE:
1568 atomic_set(&in_suspend, 1);
1570 case PM_POST_HIBERNATION:
1571 case PM_POST_RESTORE:
1572 case PM_POST_SUSPEND:
1573 atomic_set(&in_suspend, 0);
1574 list_for_each_entry(tz, &thermal_tz_list, node) {
1575 tz_mode = THERMAL_DEVICE_ENABLED;
1576 if (tz->ops->get_mode)
1577 tz->ops->get_mode(tz, &tz_mode);
1579 if (tz_mode == THERMAL_DEVICE_DISABLED)
1582 thermal_zone_device_init(tz);
1583 thermal_zone_device_update(tz,
1584 THERMAL_EVENT_UNSPECIFIED);
1593 static struct notifier_block thermal_pm_nb = {
1594 .notifier_call = thermal_pm_notify,
1597 static int __init thermal_init(void)
1601 mutex_init(&poweroff_lock);
1602 result = thermal_register_governors();
1606 result = class_register(&thermal_class);
1608 goto unregister_governors;
1610 result = genetlink_init();
1612 goto unregister_class;
1614 result = of_parse_thermal_zones();
1618 result = register_pm_notifier(&thermal_pm_nb);
1620 pr_warn("Thermal: Can not register suspend notifier, return %d\n",
1628 class_unregister(&thermal_class);
1629 unregister_governors:
1630 thermal_unregister_governors();
1632 ida_destroy(&thermal_tz_ida);
1633 ida_destroy(&thermal_cdev_ida);
1634 mutex_destroy(&thermal_list_lock);
1635 mutex_destroy(&thermal_governor_lock);
1636 mutex_destroy(&poweroff_lock);
1639 fs_initcall(thermal_init);