2 * thermal.c - Generic Thermal Management Sysfs support.
4 * Copyright (C) 2008 Intel Corp
5 * Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
6 * Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; version 2 of the License.
13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15 #include <linux/module.h>
16 #include <linux/device.h>
17 #include <linux/err.h>
18 #include <linux/slab.h>
19 #include <linux/kdev_t.h>
20 #include <linux/idr.h>
21 #include <linux/thermal.h>
22 #include <linux/reboot.h>
23 #include <linux/string.h>
25 #include <net/netlink.h>
26 #include <net/genetlink.h>
27 #include <linux/suspend.h>
29 #define CREATE_TRACE_POINTS
30 #include <trace/events/thermal.h>
32 #include "thermal_core.h"
33 #include "thermal_hwmon.h"
35 MODULE_AUTHOR("Zhang Rui");
36 MODULE_DESCRIPTION("Generic thermal management sysfs support");
37 MODULE_LICENSE("GPL v2");
39 static DEFINE_IDA(thermal_tz_ida);
40 static DEFINE_IDA(thermal_cdev_ida);
42 static LIST_HEAD(thermal_tz_list);
43 static LIST_HEAD(thermal_cdev_list);
44 static LIST_HEAD(thermal_governor_list);
46 static DEFINE_MUTEX(thermal_list_lock);
47 static DEFINE_MUTEX(thermal_governor_lock);
48 static DEFINE_MUTEX(poweroff_lock);
50 static atomic_t in_suspend;
51 static bool power_off_triggered;
53 static struct thermal_governor *def_governor;
56 * Governor section: set of functions to handle thermal governors
58 * Functions to help in the life cycle of thermal governors within
59 * the thermal core and by the thermal governor code.
62 static struct thermal_governor *__find_governor(const char *name)
64 struct thermal_governor *pos;
66 if (!name || !name[0])
69 list_for_each_entry(pos, &thermal_governor_list, governor_list)
70 if (!strncasecmp(name, pos->name, THERMAL_NAME_LENGTH))
77 * bind_previous_governor() - bind the previous governor of the thermal zone
78 * @tz: a valid pointer to a struct thermal_zone_device
79 * @failed_gov_name: the name of the governor that failed to register
81 * Register the previous governor of the thermal zone after a new
82 * governor has failed to be bound.
84 static void bind_previous_governor(struct thermal_zone_device *tz,
85 const char *failed_gov_name)
87 if (tz->governor && tz->governor->bind_to_tz) {
88 if (tz->governor->bind_to_tz(tz)) {
90 "governor %s failed to bind and the previous one (%s) failed to bind again, thermal zone %s has no governor\n",
91 failed_gov_name, tz->governor->name, tz->type);
98 * thermal_set_governor() - Switch to another governor
99 * @tz: a valid pointer to a struct thermal_zone_device
100 * @new_gov: pointer to the new governor
102 * Change the governor of thermal zone @tz.
104 * Return: 0 on success, an error if the new governor's bind_to_tz() failed.
106 static int thermal_set_governor(struct thermal_zone_device *tz,
107 struct thermal_governor *new_gov)
111 if (tz->governor && tz->governor->unbind_from_tz)
112 tz->governor->unbind_from_tz(tz);
114 if (new_gov && new_gov->bind_to_tz) {
115 ret = new_gov->bind_to_tz(tz);
117 bind_previous_governor(tz, new_gov->name);
123 tz->governor = new_gov;
128 int thermal_register_governor(struct thermal_governor *governor)
132 struct thermal_zone_device *pos;
137 mutex_lock(&thermal_governor_lock);
140 if (!__find_governor(governor->name)) {
144 list_add(&governor->governor_list, &thermal_governor_list);
145 match_default = !strncmp(governor->name,
146 DEFAULT_THERMAL_GOVERNOR,
147 THERMAL_NAME_LENGTH);
149 if (!def_governor && match_default)
150 def_governor = governor;
153 mutex_lock(&thermal_list_lock);
155 list_for_each_entry(pos, &thermal_tz_list, node) {
157 * only thermal zones with specified tz->tzp->governor_name
158 * may run with tz->govenor unset
163 name = pos->tzp->governor_name;
165 if (!strncasecmp(name, governor->name, THERMAL_NAME_LENGTH)) {
168 ret = thermal_set_governor(pos, governor);
170 dev_err(&pos->device,
171 "Failed to set governor %s for thermal zone %s: %d\n",
172 governor->name, pos->type, ret);
176 mutex_unlock(&thermal_list_lock);
177 mutex_unlock(&thermal_governor_lock);
182 void thermal_unregister_governor(struct thermal_governor *governor)
184 struct thermal_zone_device *pos;
189 mutex_lock(&thermal_governor_lock);
191 if (!__find_governor(governor->name))
194 mutex_lock(&thermal_list_lock);
196 list_for_each_entry(pos, &thermal_tz_list, node) {
197 if (!strncasecmp(pos->governor->name, governor->name,
198 THERMAL_NAME_LENGTH))
199 thermal_set_governor(pos, NULL);
202 mutex_unlock(&thermal_list_lock);
203 list_del(&governor->governor_list);
205 mutex_unlock(&thermal_governor_lock);
208 int thermal_zone_device_set_policy(struct thermal_zone_device *tz,
211 struct thermal_governor *gov;
214 mutex_lock(&thermal_governor_lock);
215 mutex_lock(&tz->lock);
217 gov = __find_governor(strim(policy));
221 ret = thermal_set_governor(tz, gov);
224 mutex_unlock(&tz->lock);
225 mutex_unlock(&thermal_governor_lock);
230 int thermal_build_list_of_policies(char *buf)
232 struct thermal_governor *pos;
235 mutex_lock(&thermal_governor_lock);
237 list_for_each_entry(pos, &thermal_governor_list, governor_list) {
238 count += scnprintf(buf + count, PAGE_SIZE - count, "%s ",
241 count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
243 mutex_unlock(&thermal_governor_lock);
248 static int __init thermal_register_governors(void)
252 result = thermal_gov_step_wise_register();
256 result = thermal_gov_fair_share_register();
260 result = thermal_gov_bang_bang_register();
264 result = thermal_gov_user_space_register();
268 return thermal_gov_power_allocator_register();
271 static void thermal_unregister_governors(void)
273 thermal_gov_step_wise_unregister();
274 thermal_gov_fair_share_unregister();
275 thermal_gov_bang_bang_unregister();
276 thermal_gov_user_space_unregister();
277 thermal_gov_power_allocator_unregister();
281 * Zone update section: main control loop applied to each zone while monitoring
283 * in polling mode. The monitoring is done using a workqueue.
284 * Same update may be done on a zone by calling thermal_zone_device_update().
287 * - Non-critical trips will invoke the governor responsible for that zone;
288 * - Hot trips will produce a notification to userspace;
289 * - Critical trip point will cause a system shutdown.
291 static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
295 mod_delayed_work(system_freezable_wq, &tz->poll_queue,
296 round_jiffies(msecs_to_jiffies(delay)));
298 mod_delayed_work(system_freezable_wq, &tz->poll_queue,
299 msecs_to_jiffies(delay));
301 cancel_delayed_work(&tz->poll_queue);
304 static void monitor_thermal_zone(struct thermal_zone_device *tz)
306 mutex_lock(&tz->lock);
309 thermal_zone_device_set_polling(tz, tz->passive_delay);
310 else if (tz->polling_delay)
311 thermal_zone_device_set_polling(tz, tz->polling_delay);
313 thermal_zone_device_set_polling(tz, 0);
315 mutex_unlock(&tz->lock);
318 static void handle_non_critical_trips(struct thermal_zone_device *tz,
320 enum thermal_trip_type trip_type)
322 tz->governor ? tz->governor->throttle(tz, trip) :
323 def_governor->throttle(tz, trip);
327 * thermal_emergency_poweroff_func - emergency poweroff work after a known delay
328 * @work: work_struct associated with the emergency poweroff function
330 * This function is called in very critical situations to force
331 * a kernel poweroff after a configurable timeout value.
333 static void thermal_emergency_poweroff_func(struct work_struct *work)
336 * We have reached here after the emergency thermal shutdown
337 * Waiting period has expired. This means orderly_poweroff has
338 * not been able to shut off the system for some reason.
339 * Try to shut down the system immediately using kernel_power_off
342 WARN(1, "Attempting kernel_power_off: Temperature too high\n");
346 * Worst of the worst case trigger emergency restart
348 WARN(1, "Attempting emergency_restart: Temperature too high\n");
352 static DECLARE_DELAYED_WORK(thermal_emergency_poweroff_work,
353 thermal_emergency_poweroff_func);
356 * thermal_emergency_poweroff - Trigger an emergency system poweroff
358 * This may be called from any critical situation to trigger a system shutdown
359 * after a known period of time. By default this is not scheduled.
361 static void thermal_emergency_poweroff(void)
363 int poweroff_delay_ms = CONFIG_THERMAL_EMERGENCY_POWEROFF_DELAY_MS;
365 * poweroff_delay_ms must be a carefully profiled positive value.
366 * Its a must for thermal_emergency_poweroff_work to be scheduled
368 if (poweroff_delay_ms <= 0)
370 schedule_delayed_work(&thermal_emergency_poweroff_work,
371 msecs_to_jiffies(poweroff_delay_ms));
374 static void handle_critical_trips(struct thermal_zone_device *tz,
375 int trip, enum thermal_trip_type trip_type)
379 tz->ops->get_trip_temp(tz, trip, &trip_temp);
381 /* If we have not crossed the trip_temp, we do not care. */
382 if (trip_temp <= 0 || tz->temperature < trip_temp)
385 trace_thermal_zone_trip(tz, trip, trip_type);
388 tz->ops->notify(tz, trip, trip_type);
390 if (trip_type == THERMAL_TRIP_CRITICAL) {
391 dev_emerg(&tz->device,
392 "critical temperature reached (%d C), shutting down\n",
393 tz->temperature / 1000);
394 mutex_lock(&poweroff_lock);
395 if (!power_off_triggered) {
397 * Queue a backup emergency shutdown in the event of
398 * orderly_poweroff failure
400 thermal_emergency_poweroff();
401 orderly_poweroff(true);
402 power_off_triggered = true;
404 mutex_unlock(&poweroff_lock);
408 static void handle_thermal_trip(struct thermal_zone_device *tz, int trip)
410 enum thermal_trip_type type;
412 /* Ignore disabled trip points */
413 if (test_bit(trip, &tz->trips_disabled))
416 tz->ops->get_trip_type(tz, trip, &type);
418 if (type == THERMAL_TRIP_CRITICAL || type == THERMAL_TRIP_HOT)
419 handle_critical_trips(tz, trip, type);
421 handle_non_critical_trips(tz, trip, type);
423 * Alright, we handled this trip successfully.
424 * So, start monitoring again.
426 monitor_thermal_zone(tz);
429 static void update_temperature(struct thermal_zone_device *tz)
433 ret = thermal_zone_get_temp(tz, &temp);
436 dev_warn(&tz->device,
437 "failed to read out thermal zone (%d)\n",
442 mutex_lock(&tz->lock);
443 tz->last_temperature = tz->temperature;
444 tz->temperature = temp;
445 mutex_unlock(&tz->lock);
447 trace_thermal_temperature(tz);
448 if (tz->last_temperature == THERMAL_TEMP_INVALID)
449 dev_dbg(&tz->device, "last_temperature N/A, current_temperature=%d\n",
452 dev_dbg(&tz->device, "last_temperature=%d, current_temperature=%d\n",
453 tz->last_temperature, tz->temperature);
456 static void thermal_zone_device_init(struct thermal_zone_device *tz)
458 struct thermal_instance *pos;
459 tz->temperature = THERMAL_TEMP_INVALID;
460 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
461 pos->initialized = false;
464 static void thermal_zone_device_reset(struct thermal_zone_device *tz)
467 thermal_zone_device_init(tz);
470 void thermal_zone_device_update(struct thermal_zone_device *tz,
471 enum thermal_notify_event event)
475 if (atomic_read(&in_suspend))
478 if (!tz->ops->get_temp)
481 update_temperature(tz);
483 thermal_zone_set_trips(tz);
485 tz->notify_event = event;
487 for (count = 0; count < tz->trips; count++)
488 handle_thermal_trip(tz, count);
490 EXPORT_SYMBOL_GPL(thermal_zone_device_update);
493 * thermal_notify_framework - Sensor drivers use this API to notify framework
494 * @tz: thermal zone device
495 * @trip: indicates which trip point has been crossed
497 * This function handles the trip events from sensor drivers. It starts
498 * throttling the cooling devices according to the policy configured.
499 * For CRITICAL and HOT trip points, this notifies the respective drivers,
500 * and does actual throttling for other trip points i.e ACTIVE and PASSIVE.
501 * The throttling policy is based on the configured platform data; if no
502 * platform data is provided, this uses the step_wise throttling policy.
504 void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
506 handle_thermal_trip(tz, trip);
508 EXPORT_SYMBOL_GPL(thermal_notify_framework);
510 static void thermal_zone_device_check(struct work_struct *work)
512 struct thermal_zone_device *tz = container_of(work, struct
515 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
519 * Power actor section: interface to power actors to estimate power
521 * Set of functions used to interact to cooling devices that know
522 * how to estimate their devices power consumption.
526 * power_actor_get_max_power() - get the maximum power that a cdev can consume
527 * @cdev: pointer to &thermal_cooling_device
528 * @tz: a valid thermal zone device pointer
529 * @max_power: pointer in which to store the maximum power
531 * Calculate the maximum power consumption in milliwats that the
532 * cooling device can currently consume and store it in @max_power.
534 * Return: 0 on success, -EINVAL if @cdev doesn't support the
535 * power_actor API or -E* on other error.
537 int power_actor_get_max_power(struct thermal_cooling_device *cdev,
538 struct thermal_zone_device *tz, u32 *max_power)
540 if (!cdev_is_power_actor(cdev))
543 return cdev->ops->state2power(cdev, tz, 0, max_power);
547 * power_actor_get_min_power() - get the mainimum power that a cdev can consume
548 * @cdev: pointer to &thermal_cooling_device
549 * @tz: a valid thermal zone device pointer
550 * @min_power: pointer in which to store the minimum power
552 * Calculate the minimum power consumption in milliwatts that the
553 * cooling device can currently consume and store it in @min_power.
555 * Return: 0 on success, -EINVAL if @cdev doesn't support the
556 * power_actor API or -E* on other error.
558 int power_actor_get_min_power(struct thermal_cooling_device *cdev,
559 struct thermal_zone_device *tz, u32 *min_power)
561 unsigned long max_state;
564 if (!cdev_is_power_actor(cdev))
567 ret = cdev->ops->get_max_state(cdev, &max_state);
571 return cdev->ops->state2power(cdev, tz, max_state, min_power);
575 * power_actor_set_power() - limit the maximum power a cooling device consumes
576 * @cdev: pointer to &thermal_cooling_device
577 * @instance: thermal instance to update
578 * @power: the power in milliwatts
580 * Set the cooling device to consume at most @power milliwatts. The limit is
581 * expected to be a cap at the maximum power consumption.
583 * Return: 0 on success, -EINVAL if the cooling device does not
584 * implement the power actor API or -E* for other failures.
586 int power_actor_set_power(struct thermal_cooling_device *cdev,
587 struct thermal_instance *instance, u32 power)
592 if (!cdev_is_power_actor(cdev))
595 ret = cdev->ops->power2state(cdev, instance->tz, power, &state);
599 instance->target = state;
600 mutex_lock(&cdev->lock);
601 cdev->updated = false;
602 mutex_unlock(&cdev->lock);
603 thermal_cdev_update(cdev);
608 void thermal_zone_device_rebind_exception(struct thermal_zone_device *tz,
609 const char *cdev_type, size_t size)
611 struct thermal_cooling_device *cdev = NULL;
613 mutex_lock(&thermal_list_lock);
614 list_for_each_entry(cdev, &thermal_cdev_list, node) {
615 /* skip non matching cdevs */
616 if (strncmp(cdev_type, cdev->type, size))
619 /* re binding the exception matching the type pattern */
620 thermal_zone_bind_cooling_device(tz, THERMAL_TRIPS_NONE, cdev,
623 THERMAL_WEIGHT_DEFAULT);
625 mutex_unlock(&thermal_list_lock);
628 void thermal_zone_device_unbind_exception(struct thermal_zone_device *tz,
629 const char *cdev_type, size_t size)
631 struct thermal_cooling_device *cdev = NULL;
633 mutex_lock(&thermal_list_lock);
634 list_for_each_entry(cdev, &thermal_cdev_list, node) {
635 /* skip non matching cdevs */
636 if (strncmp(cdev_type, cdev->type, size))
638 /* unbinding the exception matching the type pattern */
639 thermal_zone_unbind_cooling_device(tz, THERMAL_TRIPS_NONE,
642 mutex_unlock(&thermal_list_lock);
646 * Device management section: cooling devices, zones devices, and binding
648 * Set of functions provided by the thermal core for:
649 * - cooling devices lifecycle: registration, unregistration,
650 * binding, and unbinding.
651 * - thermal zone devices lifecycle: registration, unregistration,
652 * binding, and unbinding.
656 * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
657 * @tz: pointer to struct thermal_zone_device
658 * @trip: indicates which trip point the cooling devices is
659 * associated with in this thermal zone.
660 * @cdev: pointer to struct thermal_cooling_device
661 * @upper: the Maximum cooling state for this trip point.
662 * THERMAL_NO_LIMIT means no upper limit,
663 * and the cooling device can be in max_state.
664 * @lower: the Minimum cooling state can be used for this trip point.
665 * THERMAL_NO_LIMIT means no lower limit,
666 * and the cooling device can be in cooling state 0.
667 * @weight: The weight of the cooling device to be bound to the
668 * thermal zone. Use THERMAL_WEIGHT_DEFAULT for the
671 * This interface function bind a thermal cooling device to the certain trip
672 * point of a thermal zone device.
673 * This function is usually called in the thermal zone device .bind callback.
675 * Return: 0 on success, the proper error value otherwise.
677 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
679 struct thermal_cooling_device *cdev,
680 unsigned long upper, unsigned long lower,
683 struct thermal_instance *dev;
684 struct thermal_instance *pos;
685 struct thermal_zone_device *pos1;
686 struct thermal_cooling_device *pos2;
687 unsigned long max_state;
690 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
693 list_for_each_entry(pos1, &thermal_tz_list, node) {
697 list_for_each_entry(pos2, &thermal_cdev_list, node) {
702 if (tz != pos1 || cdev != pos2)
705 ret = cdev->ops->get_max_state(cdev, &max_state);
709 /* lower default 0, upper default max_state */
710 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
711 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
713 if (lower > upper || upper > max_state)
716 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
724 dev->target = THERMAL_NO_TARGET;
725 dev->weight = weight;
727 result = ida_simple_get(&tz->ida, 0, 0, GFP_KERNEL);
732 sprintf(dev->name, "cdev%d", dev->id);
734 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
738 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
739 sysfs_attr_init(&dev->attr.attr);
740 dev->attr.attr.name = dev->attr_name;
741 dev->attr.attr.mode = 0444;
742 dev->attr.show = thermal_cooling_device_trip_point_show;
743 result = device_create_file(&tz->device, &dev->attr);
745 goto remove_symbol_link;
747 sprintf(dev->weight_attr_name, "cdev%d_weight", dev->id);
748 sysfs_attr_init(&dev->weight_attr.attr);
749 dev->weight_attr.attr.name = dev->weight_attr_name;
750 dev->weight_attr.attr.mode = S_IWUSR | S_IRUGO;
751 dev->weight_attr.show = thermal_cooling_device_weight_show;
752 dev->weight_attr.store = thermal_cooling_device_weight_store;
753 result = device_create_file(&tz->device, &dev->weight_attr);
755 goto remove_trip_file;
757 mutex_lock(&tz->lock);
758 mutex_lock(&cdev->lock);
759 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
760 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
765 list_add_tail(&dev->tz_node, &tz->thermal_instances);
766 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
767 atomic_set(&tz->need_update, 1);
769 mutex_unlock(&cdev->lock);
770 mutex_unlock(&tz->lock);
775 device_remove_file(&tz->device, &dev->weight_attr);
777 device_remove_file(&tz->device, &dev->attr);
779 sysfs_remove_link(&tz->device.kobj, dev->name);
781 ida_simple_remove(&tz->ida, dev->id);
786 EXPORT_SYMBOL_GPL(thermal_zone_bind_cooling_device);
789 * thermal_zone_unbind_cooling_device() - unbind a cooling device from a
791 * @tz: pointer to a struct thermal_zone_device.
792 * @trip: indicates which trip point the cooling devices is
793 * associated with in this thermal zone.
794 * @cdev: pointer to a struct thermal_cooling_device.
796 * This interface function unbind a thermal cooling device from the certain
797 * trip point of a thermal zone device.
798 * This function is usually called in the thermal zone device .unbind callback.
800 * Return: 0 on success, the proper error value otherwise.
802 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
804 struct thermal_cooling_device *cdev)
806 struct thermal_instance *pos, *next;
808 mutex_lock(&tz->lock);
809 mutex_lock(&cdev->lock);
810 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
811 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
812 list_del(&pos->tz_node);
813 list_del(&pos->cdev_node);
814 mutex_unlock(&cdev->lock);
815 mutex_unlock(&tz->lock);
819 mutex_unlock(&cdev->lock);
820 mutex_unlock(&tz->lock);
825 device_remove_file(&tz->device, &pos->weight_attr);
826 device_remove_file(&tz->device, &pos->attr);
827 sysfs_remove_link(&tz->device.kobj, pos->name);
828 ida_simple_remove(&tz->ida, pos->id);
832 EXPORT_SYMBOL_GPL(thermal_zone_unbind_cooling_device);
834 static void thermal_release(struct device *dev)
836 struct thermal_zone_device *tz;
837 struct thermal_cooling_device *cdev;
839 if (!strncmp(dev_name(dev), "thermal_zone",
840 sizeof("thermal_zone") - 1)) {
841 tz = to_thermal_zone(dev);
842 thermal_zone_destroy_device_groups(tz);
844 } else if (!strncmp(dev_name(dev), "cooling_device",
845 sizeof("cooling_device") - 1)) {
846 cdev = to_cooling_device(dev);
851 static struct class thermal_class = {
853 .dev_release = thermal_release,
857 void print_bind_err_msg(struct thermal_zone_device *tz,
858 struct thermal_cooling_device *cdev, int ret)
860 dev_err(&tz->device, "binding zone %s with cdev %s failed:%d\n",
861 tz->type, cdev->type, ret);
864 static void __bind(struct thermal_zone_device *tz, int mask,
865 struct thermal_cooling_device *cdev,
866 unsigned long *limits,
871 for (i = 0; i < tz->trips; i++) {
872 if (mask & (1 << i)) {
873 unsigned long upper, lower;
875 upper = THERMAL_NO_LIMIT;
876 lower = THERMAL_NO_LIMIT;
878 lower = limits[i * 2];
879 upper = limits[i * 2 + 1];
881 ret = thermal_zone_bind_cooling_device(tz, i, cdev,
885 print_bind_err_msg(tz, cdev, ret);
890 static void bind_cdev(struct thermal_cooling_device *cdev)
893 const struct thermal_zone_params *tzp;
894 struct thermal_zone_device *pos = NULL;
896 mutex_lock(&thermal_list_lock);
898 list_for_each_entry(pos, &thermal_tz_list, node) {
899 if (!pos->tzp && !pos->ops->bind)
902 if (pos->ops->bind) {
903 ret = pos->ops->bind(pos, cdev);
905 print_bind_err_msg(pos, cdev, ret);
910 if (!tzp || !tzp->tbp)
913 for (i = 0; i < tzp->num_tbps; i++) {
914 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
916 if (tzp->tbp[i].match(pos, cdev))
918 tzp->tbp[i].cdev = cdev;
919 __bind(pos, tzp->tbp[i].trip_mask, cdev,
920 tzp->tbp[i].binding_limits,
925 mutex_unlock(&thermal_list_lock);
929 * __thermal_cooling_device_register() - register a new thermal cooling device
930 * @np: a pointer to a device tree node.
931 * @type: the thermal cooling device type.
932 * @devdata: device private data.
933 * @ops: standard thermal cooling devices callbacks.
935 * This interface function adds a new thermal cooling device (fan/processor/...)
936 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
937 * to all the thermal zone devices registered at the same time.
938 * It also gives the opportunity to link the cooling device to a device tree
939 * node, so that it can be bound to a thermal zone created out of device tree.
941 * Return: a pointer to the created struct thermal_cooling_device or an
942 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
944 static struct thermal_cooling_device *
945 __thermal_cooling_device_register(struct device_node *np,
946 char *type, void *devdata,
947 const struct thermal_cooling_device_ops *ops)
949 struct thermal_cooling_device *cdev;
950 struct thermal_zone_device *pos = NULL;
953 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
954 return ERR_PTR(-EINVAL);
956 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
958 return ERR_PTR(-EINVAL);
960 cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
962 return ERR_PTR(-ENOMEM);
964 result = ida_simple_get(&thermal_cdev_ida, 0, 0, GFP_KERNEL);
967 return ERR_PTR(result);
971 strlcpy(cdev->type, type ? : "", sizeof(cdev->type));
972 mutex_init(&cdev->lock);
973 INIT_LIST_HEAD(&cdev->thermal_instances);
976 cdev->updated = false;
977 cdev->device.class = &thermal_class;
978 thermal_cooling_device_setup_sysfs(cdev);
979 cdev->devdata = devdata;
980 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
981 result = device_register(&cdev->device);
983 ida_simple_remove(&thermal_cdev_ida, cdev->id);
985 return ERR_PTR(result);
988 /* Add 'this' new cdev to the global cdev list */
989 mutex_lock(&thermal_list_lock);
990 list_add(&cdev->node, &thermal_cdev_list);
991 mutex_unlock(&thermal_list_lock);
993 /* Update binding information for 'this' new cdev */
996 mutex_lock(&thermal_list_lock);
997 list_for_each_entry(pos, &thermal_tz_list, node)
998 if (atomic_cmpxchg(&pos->need_update, 1, 0))
999 thermal_zone_device_update(pos,
1000 THERMAL_EVENT_UNSPECIFIED);
1001 mutex_unlock(&thermal_list_lock);
1007 * thermal_cooling_device_register() - register a new thermal cooling device
1008 * @type: the thermal cooling device type.
1009 * @devdata: device private data.
1010 * @ops: standard thermal cooling devices callbacks.
1012 * This interface function adds a new thermal cooling device (fan/processor/...)
1013 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1014 * to all the thermal zone devices registered at the same time.
1016 * Return: a pointer to the created struct thermal_cooling_device or an
1017 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1019 struct thermal_cooling_device *
1020 thermal_cooling_device_register(char *type, void *devdata,
1021 const struct thermal_cooling_device_ops *ops)
1023 return __thermal_cooling_device_register(NULL, type, devdata, ops);
1025 EXPORT_SYMBOL_GPL(thermal_cooling_device_register);
1028 * thermal_of_cooling_device_register() - register an OF thermal cooling device
1029 * @np: a pointer to a device tree node.
1030 * @type: the thermal cooling device type.
1031 * @devdata: device private data.
1032 * @ops: standard thermal cooling devices callbacks.
1034 * This function will register a cooling device with device tree node reference.
1035 * This interface function adds a new thermal cooling device (fan/processor/...)
1036 * to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
1037 * to all the thermal zone devices registered at the same time.
1039 * Return: a pointer to the created struct thermal_cooling_device or an
1040 * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
1042 struct thermal_cooling_device *
1043 thermal_of_cooling_device_register(struct device_node *np,
1044 char *type, void *devdata,
1045 const struct thermal_cooling_device_ops *ops)
1047 return __thermal_cooling_device_register(np, type, devdata, ops);
1049 EXPORT_SYMBOL_GPL(thermal_of_cooling_device_register);
1051 static void __unbind(struct thermal_zone_device *tz, int mask,
1052 struct thermal_cooling_device *cdev)
1056 for (i = 0; i < tz->trips; i++)
1057 if (mask & (1 << i))
1058 thermal_zone_unbind_cooling_device(tz, i, cdev);
1062 * thermal_cooling_device_unregister - removes a thermal cooling device
1063 * @cdev: the thermal cooling device to remove.
1065 * thermal_cooling_device_unregister() must be called when a registered
1066 * thermal cooling device is no longer needed.
1068 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
1071 const struct thermal_zone_params *tzp;
1072 struct thermal_zone_device *tz;
1073 struct thermal_cooling_device *pos = NULL;
1078 mutex_lock(&thermal_list_lock);
1079 list_for_each_entry(pos, &thermal_cdev_list, node)
1083 /* thermal cooling device not found */
1084 mutex_unlock(&thermal_list_lock);
1087 list_del(&cdev->node);
1089 /* Unbind all thermal zones associated with 'this' cdev */
1090 list_for_each_entry(tz, &thermal_tz_list, node) {
1091 if (tz->ops->unbind) {
1092 tz->ops->unbind(tz, cdev);
1096 if (!tz->tzp || !tz->tzp->tbp)
1100 for (i = 0; i < tzp->num_tbps; i++) {
1101 if (tzp->tbp[i].cdev == cdev) {
1102 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1103 tzp->tbp[i].cdev = NULL;
1108 mutex_unlock(&thermal_list_lock);
1110 ida_simple_remove(&thermal_cdev_ida, cdev->id);
1111 device_unregister(&cdev->device);
1113 EXPORT_SYMBOL_GPL(thermal_cooling_device_unregister);
1115 static void bind_tz(struct thermal_zone_device *tz)
1118 struct thermal_cooling_device *pos = NULL;
1119 const struct thermal_zone_params *tzp = tz->tzp;
1121 if (!tzp && !tz->ops->bind)
1124 mutex_lock(&thermal_list_lock);
1126 /* If there is ops->bind, try to use ops->bind */
1127 if (tz->ops->bind) {
1128 list_for_each_entry(pos, &thermal_cdev_list, node) {
1129 ret = tz->ops->bind(tz, pos);
1131 print_bind_err_msg(tz, pos, ret);
1136 if (!tzp || !tzp->tbp)
1139 list_for_each_entry(pos, &thermal_cdev_list, node) {
1140 for (i = 0; i < tzp->num_tbps; i++) {
1141 if (tzp->tbp[i].cdev || !tzp->tbp[i].match)
1143 if (tzp->tbp[i].match(tz, pos))
1145 tzp->tbp[i].cdev = pos;
1146 __bind(tz, tzp->tbp[i].trip_mask, pos,
1147 tzp->tbp[i].binding_limits,
1148 tzp->tbp[i].weight);
1152 mutex_unlock(&thermal_list_lock);
1156 * thermal_zone_device_register() - register a new thermal zone device
1157 * @type: the thermal zone device type
1158 * @trips: the number of trip points the thermal zone support
1159 * @mask: a bit string indicating the writeablility of trip points
1160 * @devdata: private device data
1161 * @ops: standard thermal zone device callbacks
1162 * @tzp: thermal zone platform parameters
1163 * @passive_delay: number of milliseconds to wait between polls when
1164 * performing passive cooling
1165 * @polling_delay: number of milliseconds to wait between polls when checking
1166 * whether trip points have been crossed (0 for interrupt
1169 * This interface function adds a new thermal zone device (sensor) to
1170 * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
1171 * thermal cooling devices registered at the same time.
1172 * thermal_zone_device_unregister() must be called when the device is no
1173 * longer needed. The passive cooling depends on the .get_trend() return value.
1175 * Return: a pointer to the created struct thermal_zone_device or an
1176 * in case of error, an ERR_PTR. Caller must check return value with
1177 * IS_ERR*() helpers.
1179 struct thermal_zone_device *
1180 thermal_zone_device_register(const char *type, int trips, int mask,
1181 void *devdata, struct thermal_zone_device_ops *ops,
1182 struct thermal_zone_params *tzp, int passive_delay,
1185 struct thermal_zone_device *tz;
1186 enum thermal_trip_type trip_type;
1190 struct thermal_governor *governor;
1192 if (!type || strlen(type) == 0)
1193 return ERR_PTR(-EINVAL);
1195 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1196 return ERR_PTR(-EINVAL);
1198 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
1199 return ERR_PTR(-EINVAL);
1202 return ERR_PTR(-EINVAL);
1204 if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
1205 return ERR_PTR(-EINVAL);
1207 tz = kzalloc(sizeof(*tz), GFP_KERNEL);
1209 return ERR_PTR(-ENOMEM);
1211 INIT_LIST_HEAD(&tz->thermal_instances);
1213 mutex_init(&tz->lock);
1214 result = ida_simple_get(&thermal_tz_ida, 0, 0, GFP_KERNEL);
1219 strlcpy(tz->type, type, sizeof(tz->type));
1222 tz->device.class = &thermal_class;
1223 tz->devdata = devdata;
1225 tz->passive_delay = passive_delay;
1226 tz->polling_delay = polling_delay;
1229 /* Add nodes that are always present via .groups */
1230 result = thermal_zone_create_device_groups(tz, mask);
1234 /* A new thermal zone needs to be updated anyway. */
1235 atomic_set(&tz->need_update, 1);
1237 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1238 result = device_register(&tz->device);
1240 goto remove_device_groups;
1242 for (count = 0; count < trips; count++) {
1243 if (tz->ops->get_trip_type(tz, count, &trip_type))
1244 set_bit(count, &tz->trips_disabled);
1245 if (tz->ops->get_trip_temp(tz, count, &trip_temp))
1246 set_bit(count, &tz->trips_disabled);
1247 /* Check for bogus trip points */
1249 set_bit(count, &tz->trips_disabled);
1252 /* Update 'this' zone's governor information */
1253 mutex_lock(&thermal_governor_lock);
1256 governor = __find_governor(tz->tzp->governor_name);
1258 governor = def_governor;
1260 result = thermal_set_governor(tz, governor);
1262 mutex_unlock(&thermal_governor_lock);
1266 mutex_unlock(&thermal_governor_lock);
1268 if (!tz->tzp || !tz->tzp->no_hwmon) {
1269 result = thermal_add_hwmon_sysfs(tz);
1274 mutex_lock(&thermal_list_lock);
1275 list_add_tail(&tz->node, &thermal_tz_list);
1276 mutex_unlock(&thermal_list_lock);
1278 /* Bind cooling devices for this zone */
1281 INIT_DELAYED_WORK(&tz->poll_queue, thermal_zone_device_check);
1283 thermal_zone_device_reset(tz);
1284 /* Update the new thermal zone and mark it as already updated. */
1285 if (atomic_cmpxchg(&tz->need_update, 1, 0))
1286 thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
1291 ida_simple_remove(&thermal_tz_ida, tz->id);
1292 device_unregister(&tz->device);
1293 return ERR_PTR(result);
1295 remove_device_groups:
1296 thermal_zone_destroy_device_groups(tz);
1298 ida_simple_remove(&thermal_tz_ida, tz->id);
1301 return ERR_PTR(result);
1303 EXPORT_SYMBOL_GPL(thermal_zone_device_register);
1306 * thermal_zone_device_unregister - removes the registered thermal zone device
1307 * @tz: the thermal zone device to remove
1309 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1312 const struct thermal_zone_params *tzp;
1313 struct thermal_cooling_device *cdev;
1314 struct thermal_zone_device *pos = NULL;
1321 mutex_lock(&thermal_list_lock);
1322 list_for_each_entry(pos, &thermal_tz_list, node)
1326 /* thermal zone device not found */
1327 mutex_unlock(&thermal_list_lock);
1330 list_del(&tz->node);
1332 /* Unbind all cdevs associated with 'this' thermal zone */
1333 list_for_each_entry(cdev, &thermal_cdev_list, node) {
1334 if (tz->ops->unbind) {
1335 tz->ops->unbind(tz, cdev);
1339 if (!tzp || !tzp->tbp)
1342 for (i = 0; i < tzp->num_tbps; i++) {
1343 if (tzp->tbp[i].cdev == cdev) {
1344 __unbind(tz, tzp->tbp[i].trip_mask, cdev);
1345 tzp->tbp[i].cdev = NULL;
1350 mutex_unlock(&thermal_list_lock);
1352 cancel_delayed_work_sync(&tz->poll_queue);
1354 thermal_set_governor(tz, NULL);
1356 thermal_remove_hwmon_sysfs(tz);
1357 ida_simple_remove(&thermal_tz_ida, tz->id);
1358 ida_destroy(&tz->ida);
1359 mutex_destroy(&tz->lock);
1360 device_unregister(&tz->device);
1362 EXPORT_SYMBOL_GPL(thermal_zone_device_unregister);
1365 * thermal_zone_get_zone_by_name() - search for a zone and returns its ref
1366 * @name: thermal zone name to fetch the temperature
1368 * When only one zone is found with the passed name, returns a reference to it.
1370 * Return: On success returns a reference to an unique thermal zone with
1371 * matching name equals to @name, an ERR_PTR otherwise (-EINVAL for invalid
1372 * paramenters, -ENODEV for not found and -EEXIST for multiple matches).
1374 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name)
1376 struct thermal_zone_device *pos = NULL, *ref = ERR_PTR(-EINVAL);
1377 unsigned int found = 0;
1382 mutex_lock(&thermal_list_lock);
1383 list_for_each_entry(pos, &thermal_tz_list, node)
1384 if (!strncasecmp(name, pos->type, THERMAL_NAME_LENGTH)) {
1388 mutex_unlock(&thermal_list_lock);
1390 /* nothing has been found, thus an error code for it */
1392 ref = ERR_PTR(-ENODEV);
1394 /* Success only when an unique zone is found */
1395 ref = ERR_PTR(-EEXIST);
1400 EXPORT_SYMBOL_GPL(thermal_zone_get_zone_by_name);
1403 static const struct genl_multicast_group thermal_event_mcgrps[] = {
1404 { .name = THERMAL_GENL_MCAST_GROUP_NAME, },
1407 static struct genl_family thermal_event_genl_family __ro_after_init = {
1408 .module = THIS_MODULE,
1409 .name = THERMAL_GENL_FAMILY_NAME,
1410 .version = THERMAL_GENL_VERSION,
1411 .maxattr = THERMAL_GENL_ATTR_MAX,
1412 .mcgrps = thermal_event_mcgrps,
1413 .n_mcgrps = ARRAY_SIZE(thermal_event_mcgrps),
1416 int thermal_generate_netlink_event(struct thermal_zone_device *tz,
1419 struct sk_buff *skb;
1420 struct nlattr *attr;
1421 struct thermal_genl_event *thermal_event;
1425 static unsigned int thermal_event_seqnum;
1430 /* allocate memory */
1431 size = nla_total_size(sizeof(struct thermal_genl_event)) +
1434 skb = genlmsg_new(size, GFP_ATOMIC);
1438 /* add the genetlink message header */
1439 msg_header = genlmsg_put(skb, 0, thermal_event_seqnum++,
1440 &thermal_event_genl_family, 0,
1441 THERMAL_GENL_CMD_EVENT);
1448 attr = nla_reserve(skb, THERMAL_GENL_ATTR_EVENT,
1449 sizeof(struct thermal_genl_event));
1456 thermal_event = nla_data(attr);
1457 if (!thermal_event) {
1462 memset(thermal_event, 0, sizeof(struct thermal_genl_event));
1464 thermal_event->orig = tz->id;
1465 thermal_event->event = event;
1467 /* send multicast genetlink message */
1468 genlmsg_end(skb, msg_header);
1470 result = genlmsg_multicast(&thermal_event_genl_family, skb, 0,
1473 dev_err(&tz->device, "Failed to send netlink event:%d", result);
1477 EXPORT_SYMBOL_GPL(thermal_generate_netlink_event);
1479 static int __init genetlink_init(void)
1481 return genl_register_family(&thermal_event_genl_family);
1484 static void genetlink_exit(void)
1486 genl_unregister_family(&thermal_event_genl_family);
1488 #else /* !CONFIG_NET */
1489 static inline int genetlink_init(void) { return 0; }
1490 static inline void genetlink_exit(void) {}
1491 #endif /* !CONFIG_NET */
1493 static int thermal_pm_notify(struct notifier_block *nb,
1494 unsigned long mode, void *_unused)
1496 struct thermal_zone_device *tz;
1499 case PM_HIBERNATION_PREPARE:
1500 case PM_RESTORE_PREPARE:
1501 case PM_SUSPEND_PREPARE:
1502 atomic_set(&in_suspend, 1);
1504 case PM_POST_HIBERNATION:
1505 case PM_POST_RESTORE:
1506 case PM_POST_SUSPEND:
1507 atomic_set(&in_suspend, 0);
1508 list_for_each_entry(tz, &thermal_tz_list, node) {
1509 thermal_zone_device_init(tz);
1510 thermal_zone_device_update(tz,
1511 THERMAL_EVENT_UNSPECIFIED);
1520 static struct notifier_block thermal_pm_nb = {
1521 .notifier_call = thermal_pm_notify,
1524 static int __init thermal_init(void)
1528 mutex_init(&poweroff_lock);
1529 result = thermal_register_governors();
1533 result = class_register(&thermal_class);
1535 goto unregister_governors;
1537 result = genetlink_init();
1539 goto unregister_class;
1541 result = of_parse_thermal_zones();
1545 result = register_pm_notifier(&thermal_pm_nb);
1547 pr_warn("Thermal: Can not register suspend notifier, return %d\n",
1555 class_unregister(&thermal_class);
1556 unregister_governors:
1557 thermal_unregister_governors();
1559 ida_destroy(&thermal_tz_ida);
1560 ida_destroy(&thermal_cdev_ida);
1561 mutex_destroy(&thermal_list_lock);
1562 mutex_destroy(&thermal_governor_lock);
1563 mutex_destroy(&poweroff_lock);
1567 static void __exit thermal_exit(void)
1569 unregister_pm_notifier(&thermal_pm_nb);
1570 of_thermal_destroy_zones();
1572 class_unregister(&thermal_class);
1573 thermal_unregister_governors();
1574 ida_destroy(&thermal_tz_ida);
1575 ida_destroy(&thermal_cdev_ida);
1576 mutex_destroy(&thermal_list_lock);
1577 mutex_destroy(&thermal_governor_lock);
1580 fs_initcall(thermal_init);
1581 module_exit(thermal_exit);