2 * thermal.c - Generic Thermal Management Sysfs support.
4 * Copyright (C) 2008 Intel Corp
5 * Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
6 * Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2 of the License.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
28 #include <linux/module.h>
29 #include <linux/device.h>
30 #include <linux/err.h>
31 #include <linux/slab.h>
32 #include <linux/kdev_t.h>
33 #include <linux/idr.h>
34 #include <linux/thermal.h>
35 #include <linux/spinlock.h>
36 #include <linux/reboot.h>
37 #include <net/netlink.h>
38 #include <net/genetlink.h>
40 MODULE_AUTHOR("Zhang Rui");
41 MODULE_DESCRIPTION("Generic thermal management sysfs support");
42 MODULE_LICENSE("GPL");
44 #define THERMAL_NO_TARGET -1UL
46 * This structure is used to describe the behavior of
47 * a certain cooling device on a certain trip point
48 * in a certain thermal zone
50 struct thermal_instance {
52 char name[THERMAL_NAME_LENGTH];
53 struct thermal_zone_device *tz;
54 struct thermal_cooling_device *cdev;
56 unsigned long upper; /* Highest cooling state for this trip point */
57 unsigned long lower; /* Lowest cooling state for this trip point */
58 unsigned long target; /* expected cooling state */
59 char attr_name[THERMAL_NAME_LENGTH];
60 struct device_attribute attr;
61 struct list_head tz_node; /* node in tz->thermal_instances */
62 struct list_head cdev_node; /* node in cdev->thermal_instances */
65 static DEFINE_IDR(thermal_tz_idr);
66 static DEFINE_IDR(thermal_cdev_idr);
67 static DEFINE_MUTEX(thermal_idr_lock);
69 static LIST_HEAD(thermal_tz_list);
70 static LIST_HEAD(thermal_cdev_list);
71 static DEFINE_MUTEX(thermal_list_lock);
73 static int get_idr(struct idr *idr, struct mutex *lock, int *id)
78 if (unlikely(idr_pre_get(idr, GFP_KERNEL) == 0))
83 err = idr_get_new(idr, NULL, id);
86 if (unlikely(err == -EAGAIN))
88 else if (unlikely(err))
91 *id = *id & MAX_ID_MASK;
95 static void release_idr(struct idr *idr, struct mutex *lock, int id)
104 /* sys I/F for thermal zone */
106 #define to_thermal_zone(_dev) \
107 container_of(_dev, struct thermal_zone_device, device)
110 type_show(struct device *dev, struct device_attribute *attr, char *buf)
112 struct thermal_zone_device *tz = to_thermal_zone(dev);
114 return sprintf(buf, "%s\n", tz->type);
118 temp_show(struct device *dev, struct device_attribute *attr, char *buf)
120 struct thermal_zone_device *tz = to_thermal_zone(dev);
124 if (!tz->ops->get_temp)
127 ret = tz->ops->get_temp(tz, &temperature);
132 return sprintf(buf, "%ld\n", temperature);
136 mode_show(struct device *dev, struct device_attribute *attr, char *buf)
138 struct thermal_zone_device *tz = to_thermal_zone(dev);
139 enum thermal_device_mode mode;
142 if (!tz->ops->get_mode)
145 result = tz->ops->get_mode(tz, &mode);
149 return sprintf(buf, "%s\n", mode == THERMAL_DEVICE_ENABLED ? "enabled"
154 mode_store(struct device *dev, struct device_attribute *attr,
155 const char *buf, size_t count)
157 struct thermal_zone_device *tz = to_thermal_zone(dev);
160 if (!tz->ops->set_mode)
163 if (!strncmp(buf, "enabled", sizeof("enabled") - 1))
164 result = tz->ops->set_mode(tz, THERMAL_DEVICE_ENABLED);
165 else if (!strncmp(buf, "disabled", sizeof("disabled") - 1))
166 result = tz->ops->set_mode(tz, THERMAL_DEVICE_DISABLED);
177 trip_point_type_show(struct device *dev, struct device_attribute *attr,
180 struct thermal_zone_device *tz = to_thermal_zone(dev);
181 enum thermal_trip_type type;
184 if (!tz->ops->get_trip_type)
187 if (!sscanf(attr->attr.name, "trip_point_%d_type", &trip))
190 result = tz->ops->get_trip_type(tz, trip, &type);
195 case THERMAL_TRIP_CRITICAL:
196 return sprintf(buf, "critical\n");
197 case THERMAL_TRIP_HOT:
198 return sprintf(buf, "hot\n");
199 case THERMAL_TRIP_PASSIVE:
200 return sprintf(buf, "passive\n");
201 case THERMAL_TRIP_ACTIVE:
202 return sprintf(buf, "active\n");
204 return sprintf(buf, "unknown\n");
209 trip_point_temp_store(struct device *dev, struct device_attribute *attr,
210 const char *buf, size_t count)
212 struct thermal_zone_device *tz = to_thermal_zone(dev);
214 unsigned long temperature;
216 if (!tz->ops->set_trip_temp)
219 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
222 if (kstrtoul(buf, 10, &temperature))
225 ret = tz->ops->set_trip_temp(tz, trip, temperature);
227 return ret ? ret : count;
231 trip_point_temp_show(struct device *dev, struct device_attribute *attr,
234 struct thermal_zone_device *tz = to_thermal_zone(dev);
238 if (!tz->ops->get_trip_temp)
241 if (!sscanf(attr->attr.name, "trip_point_%d_temp", &trip))
244 ret = tz->ops->get_trip_temp(tz, trip, &temperature);
249 return sprintf(buf, "%ld\n", temperature);
253 trip_point_hyst_store(struct device *dev, struct device_attribute *attr,
254 const char *buf, size_t count)
256 struct thermal_zone_device *tz = to_thermal_zone(dev);
258 unsigned long temperature;
260 if (!tz->ops->set_trip_hyst)
263 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
266 if (kstrtoul(buf, 10, &temperature))
270 * We are not doing any check on the 'temperature' value
271 * here. The driver implementing 'set_trip_hyst' has to
274 ret = tz->ops->set_trip_hyst(tz, trip, temperature);
276 return ret ? ret : count;
280 trip_point_hyst_show(struct device *dev, struct device_attribute *attr,
283 struct thermal_zone_device *tz = to_thermal_zone(dev);
285 unsigned long temperature;
287 if (!tz->ops->get_trip_hyst)
290 if (!sscanf(attr->attr.name, "trip_point_%d_hyst", &trip))
293 ret = tz->ops->get_trip_hyst(tz, trip, &temperature);
295 return ret ? ret : sprintf(buf, "%ld\n", temperature);
299 passive_store(struct device *dev, struct device_attribute *attr,
300 const char *buf, size_t count)
302 struct thermal_zone_device *tz = to_thermal_zone(dev);
303 struct thermal_cooling_device *cdev = NULL;
306 if (!sscanf(buf, "%d\n", &state))
309 /* sanity check: values below 1000 millicelcius don't make sense
310 * and can cause the system to go into a thermal heart attack
312 if (state && state < 1000)
315 if (state && !tz->forced_passive) {
316 mutex_lock(&thermal_list_lock);
317 list_for_each_entry(cdev, &thermal_cdev_list, node) {
318 if (!strncmp("Processor", cdev->type,
319 sizeof("Processor")))
320 thermal_zone_bind_cooling_device(tz,
321 THERMAL_TRIPS_NONE, cdev,
325 mutex_unlock(&thermal_list_lock);
326 if (!tz->passive_delay)
327 tz->passive_delay = 1000;
328 } else if (!state && tz->forced_passive) {
329 mutex_lock(&thermal_list_lock);
330 list_for_each_entry(cdev, &thermal_cdev_list, node) {
331 if (!strncmp("Processor", cdev->type,
332 sizeof("Processor")))
333 thermal_zone_unbind_cooling_device(tz,
337 mutex_unlock(&thermal_list_lock);
338 tz->passive_delay = 0;
341 tz->forced_passive = state;
343 thermal_zone_device_update(tz);
349 passive_show(struct device *dev, struct device_attribute *attr,
352 struct thermal_zone_device *tz = to_thermal_zone(dev);
354 return sprintf(buf, "%d\n", tz->forced_passive);
357 static DEVICE_ATTR(type, 0444, type_show, NULL);
358 static DEVICE_ATTR(temp, 0444, temp_show, NULL);
359 static DEVICE_ATTR(mode, 0644, mode_show, mode_store);
360 static DEVICE_ATTR(passive, S_IRUGO | S_IWUSR, passive_show, passive_store);
362 /* sys I/F for cooling device */
363 #define to_cooling_device(_dev) \
364 container_of(_dev, struct thermal_cooling_device, device)
367 thermal_cooling_device_type_show(struct device *dev,
368 struct device_attribute *attr, char *buf)
370 struct thermal_cooling_device *cdev = to_cooling_device(dev);
372 return sprintf(buf, "%s\n", cdev->type);
376 thermal_cooling_device_max_state_show(struct device *dev,
377 struct device_attribute *attr, char *buf)
379 struct thermal_cooling_device *cdev = to_cooling_device(dev);
383 ret = cdev->ops->get_max_state(cdev, &state);
386 return sprintf(buf, "%ld\n", state);
390 thermal_cooling_device_cur_state_show(struct device *dev,
391 struct device_attribute *attr, char *buf)
393 struct thermal_cooling_device *cdev = to_cooling_device(dev);
397 ret = cdev->ops->get_cur_state(cdev, &state);
400 return sprintf(buf, "%ld\n", state);
404 thermal_cooling_device_cur_state_store(struct device *dev,
405 struct device_attribute *attr,
406 const char *buf, size_t count)
408 struct thermal_cooling_device *cdev = to_cooling_device(dev);
412 if (!sscanf(buf, "%ld\n", &state))
418 result = cdev->ops->set_cur_state(cdev, state);
424 static struct device_attribute dev_attr_cdev_type =
425 __ATTR(type, 0444, thermal_cooling_device_type_show, NULL);
426 static DEVICE_ATTR(max_state, 0444,
427 thermal_cooling_device_max_state_show, NULL);
428 static DEVICE_ATTR(cur_state, 0644,
429 thermal_cooling_device_cur_state_show,
430 thermal_cooling_device_cur_state_store);
433 thermal_cooling_device_trip_point_show(struct device *dev,
434 struct device_attribute *attr, char *buf)
436 struct thermal_instance *instance;
439 container_of(attr, struct thermal_instance, attr);
441 if (instance->trip == THERMAL_TRIPS_NONE)
442 return sprintf(buf, "-1\n");
444 return sprintf(buf, "%d\n", instance->trip);
447 /* Device management */
449 #if defined(CONFIG_THERMAL_HWMON)
452 #include <linux/hwmon.h>
454 /* thermal zone devices with the same type share one hwmon device */
455 struct thermal_hwmon_device {
456 char type[THERMAL_NAME_LENGTH];
457 struct device *device;
459 struct list_head tz_list;
460 struct list_head node;
463 struct thermal_hwmon_attr {
464 struct device_attribute attr;
468 /* one temperature input for each thermal zone */
469 struct thermal_hwmon_temp {
470 struct list_head hwmon_node;
471 struct thermal_zone_device *tz;
472 struct thermal_hwmon_attr temp_input; /* hwmon sys attr */
473 struct thermal_hwmon_attr temp_crit; /* hwmon sys attr */
476 static LIST_HEAD(thermal_hwmon_list);
479 name_show(struct device *dev, struct device_attribute *attr, char *buf)
481 struct thermal_hwmon_device *hwmon = dev_get_drvdata(dev);
482 return sprintf(buf, "%s\n", hwmon->type);
484 static DEVICE_ATTR(name, 0444, name_show, NULL);
487 temp_input_show(struct device *dev, struct device_attribute *attr, char *buf)
491 struct thermal_hwmon_attr *hwmon_attr
492 = container_of(attr, struct thermal_hwmon_attr, attr);
493 struct thermal_hwmon_temp *temp
494 = container_of(hwmon_attr, struct thermal_hwmon_temp,
496 struct thermal_zone_device *tz = temp->tz;
498 ret = tz->ops->get_temp(tz, &temperature);
503 return sprintf(buf, "%ld\n", temperature);
507 temp_crit_show(struct device *dev, struct device_attribute *attr,
510 struct thermal_hwmon_attr *hwmon_attr
511 = container_of(attr, struct thermal_hwmon_attr, attr);
512 struct thermal_hwmon_temp *temp
513 = container_of(hwmon_attr, struct thermal_hwmon_temp,
515 struct thermal_zone_device *tz = temp->tz;
519 ret = tz->ops->get_trip_temp(tz, 0, &temperature);
523 return sprintf(buf, "%ld\n", temperature);
527 static struct thermal_hwmon_device *
528 thermal_hwmon_lookup_by_type(const struct thermal_zone_device *tz)
530 struct thermal_hwmon_device *hwmon;
532 mutex_lock(&thermal_list_lock);
533 list_for_each_entry(hwmon, &thermal_hwmon_list, node)
534 if (!strcmp(hwmon->type, tz->type)) {
535 mutex_unlock(&thermal_list_lock);
538 mutex_unlock(&thermal_list_lock);
543 /* Find the temperature input matching a given thermal zone */
544 static struct thermal_hwmon_temp *
545 thermal_hwmon_lookup_temp(const struct thermal_hwmon_device *hwmon,
546 const struct thermal_zone_device *tz)
548 struct thermal_hwmon_temp *temp;
550 mutex_lock(&thermal_list_lock);
551 list_for_each_entry(temp, &hwmon->tz_list, hwmon_node)
552 if (temp->tz == tz) {
553 mutex_unlock(&thermal_list_lock);
556 mutex_unlock(&thermal_list_lock);
562 thermal_add_hwmon_sysfs(struct thermal_zone_device *tz)
564 struct thermal_hwmon_device *hwmon;
565 struct thermal_hwmon_temp *temp;
566 int new_hwmon_device = 1;
569 hwmon = thermal_hwmon_lookup_by_type(tz);
571 new_hwmon_device = 0;
572 goto register_sys_interface;
575 hwmon = kzalloc(sizeof(struct thermal_hwmon_device), GFP_KERNEL);
579 INIT_LIST_HEAD(&hwmon->tz_list);
580 strlcpy(hwmon->type, tz->type, THERMAL_NAME_LENGTH);
581 hwmon->device = hwmon_device_register(NULL);
582 if (IS_ERR(hwmon->device)) {
583 result = PTR_ERR(hwmon->device);
586 dev_set_drvdata(hwmon->device, hwmon);
587 result = device_create_file(hwmon->device, &dev_attr_name);
591 register_sys_interface:
592 temp = kzalloc(sizeof(struct thermal_hwmon_temp), GFP_KERNEL);
595 goto unregister_name;
601 snprintf(temp->temp_input.name, sizeof(temp->temp_input.name),
602 "temp%d_input", hwmon->count);
603 temp->temp_input.attr.attr.name = temp->temp_input.name;
604 temp->temp_input.attr.attr.mode = 0444;
605 temp->temp_input.attr.show = temp_input_show;
606 sysfs_attr_init(&temp->temp_input.attr.attr);
607 result = device_create_file(hwmon->device, &temp->temp_input.attr);
611 if (tz->ops->get_crit_temp) {
612 unsigned long temperature;
613 if (!tz->ops->get_crit_temp(tz, &temperature)) {
614 snprintf(temp->temp_crit.name,
615 sizeof(temp->temp_crit.name),
616 "temp%d_crit", hwmon->count);
617 temp->temp_crit.attr.attr.name = temp->temp_crit.name;
618 temp->temp_crit.attr.attr.mode = 0444;
619 temp->temp_crit.attr.show = temp_crit_show;
620 sysfs_attr_init(&temp->temp_crit.attr.attr);
621 result = device_create_file(hwmon->device,
622 &temp->temp_crit.attr);
624 goto unregister_input;
628 mutex_lock(&thermal_list_lock);
629 if (new_hwmon_device)
630 list_add_tail(&hwmon->node, &thermal_hwmon_list);
631 list_add_tail(&temp->hwmon_node, &hwmon->tz_list);
632 mutex_unlock(&thermal_list_lock);
637 device_remove_file(hwmon->device, &temp->temp_input.attr);
641 if (new_hwmon_device) {
642 device_remove_file(hwmon->device, &dev_attr_name);
643 hwmon_device_unregister(hwmon->device);
646 if (new_hwmon_device)
653 thermal_remove_hwmon_sysfs(struct thermal_zone_device *tz)
655 struct thermal_hwmon_device *hwmon;
656 struct thermal_hwmon_temp *temp;
658 hwmon = thermal_hwmon_lookup_by_type(tz);
659 if (unlikely(!hwmon)) {
660 /* Should never happen... */
661 dev_dbg(&tz->device, "hwmon device lookup failed!\n");
665 temp = thermal_hwmon_lookup_temp(hwmon, tz);
666 if (unlikely(!temp)) {
667 /* Should never happen... */
668 dev_dbg(&tz->device, "temperature input lookup failed!\n");
672 device_remove_file(hwmon->device, &temp->temp_input.attr);
673 if (tz->ops->get_crit_temp)
674 device_remove_file(hwmon->device, &temp->temp_crit.attr);
676 mutex_lock(&thermal_list_lock);
677 list_del(&temp->hwmon_node);
679 if (!list_empty(&hwmon->tz_list)) {
680 mutex_unlock(&thermal_list_lock);
683 list_del(&hwmon->node);
684 mutex_unlock(&thermal_list_lock);
686 device_remove_file(hwmon->device, &dev_attr_name);
687 hwmon_device_unregister(hwmon->device);
692 thermal_add_hwmon_sysfs(struct thermal_zone_device *tz)
698 thermal_remove_hwmon_sysfs(struct thermal_zone_device *tz)
703 static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
706 cancel_delayed_work(&(tz->poll_queue));
712 queue_delayed_work(system_freezable_wq, &(tz->poll_queue),
713 round_jiffies(msecs_to_jiffies(delay)));
715 queue_delayed_work(system_freezable_wq, &(tz->poll_queue),
716 msecs_to_jiffies(delay));
719 static void thermal_zone_device_check(struct work_struct *work)
721 struct thermal_zone_device *tz = container_of(work, struct
724 thermal_zone_device_update(tz);
728 * thermal_zone_bind_cooling_device - bind a cooling device to a thermal zone
729 * @tz: thermal zone device
730 * @trip: indicates which trip point the cooling devices is
731 * associated with in this thermal zone.
732 * @cdev: thermal cooling device
734 * This function is usually called in the thermal zone device .bind callback.
736 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
738 struct thermal_cooling_device *cdev,
739 unsigned long upper, unsigned long lower)
741 struct thermal_instance *dev;
742 struct thermal_instance *pos;
743 struct thermal_zone_device *pos1;
744 struct thermal_cooling_device *pos2;
745 unsigned long max_state;
748 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
751 list_for_each_entry(pos1, &thermal_tz_list, node) {
755 list_for_each_entry(pos2, &thermal_cdev_list, node) {
760 if (tz != pos1 || cdev != pos2)
763 cdev->ops->get_max_state(cdev, &max_state);
765 /* lower default 0, upper default max_state */
766 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
767 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
769 if (lower > upper || upper > max_state)
773 kzalloc(sizeof(struct thermal_instance), GFP_KERNEL);
781 dev->target = THERMAL_NO_TARGET;
783 result = get_idr(&tz->idr, &tz->lock, &dev->id);
787 sprintf(dev->name, "cdev%d", dev->id);
789 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
793 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
794 sysfs_attr_init(&dev->attr.attr);
795 dev->attr.attr.name = dev->attr_name;
796 dev->attr.attr.mode = 0444;
797 dev->attr.show = thermal_cooling_device_trip_point_show;
798 result = device_create_file(&tz->device, &dev->attr);
800 goto remove_symbol_link;
802 mutex_lock(&tz->lock);
803 mutex_lock(&cdev->lock);
804 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
805 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
810 list_add_tail(&dev->tz_node, &tz->thermal_instances);
811 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
813 mutex_unlock(&cdev->lock);
814 mutex_unlock(&tz->lock);
819 device_remove_file(&tz->device, &dev->attr);
821 sysfs_remove_link(&tz->device.kobj, dev->name);
823 release_idr(&tz->idr, &tz->lock, dev->id);
828 EXPORT_SYMBOL(thermal_zone_bind_cooling_device);
831 * thermal_zone_unbind_cooling_device - unbind a cooling device from a thermal zone
832 * @tz: thermal zone device
833 * @trip: indicates which trip point the cooling devices is
834 * associated with in this thermal zone.
835 * @cdev: thermal cooling device
837 * This function is usually called in the thermal zone device .unbind callback.
839 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
841 struct thermal_cooling_device *cdev)
843 struct thermal_instance *pos, *next;
845 mutex_lock(&tz->lock);
846 mutex_lock(&cdev->lock);
847 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
848 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
849 list_del(&pos->tz_node);
850 list_del(&pos->cdev_node);
851 mutex_unlock(&cdev->lock);
852 mutex_unlock(&tz->lock);
856 mutex_unlock(&cdev->lock);
857 mutex_unlock(&tz->lock);
862 device_remove_file(&tz->device, &pos->attr);
863 sysfs_remove_link(&tz->device.kobj, pos->name);
864 release_idr(&tz->idr, &tz->lock, pos->id);
868 EXPORT_SYMBOL(thermal_zone_unbind_cooling_device);
870 static void thermal_release(struct device *dev)
872 struct thermal_zone_device *tz;
873 struct thermal_cooling_device *cdev;
875 if (!strncmp(dev_name(dev), "thermal_zone",
876 sizeof("thermal_zone") - 1)) {
877 tz = to_thermal_zone(dev);
880 cdev = to_cooling_device(dev);
885 static struct class thermal_class = {
887 .dev_release = thermal_release,
891 * thermal_cooling_device_register - register a new thermal cooling device
892 * @type: the thermal cooling device type.
893 * @devdata: device private data.
894 * @ops: standard thermal cooling devices callbacks.
896 struct thermal_cooling_device *
897 thermal_cooling_device_register(char *type, void *devdata,
898 const struct thermal_cooling_device_ops *ops)
900 struct thermal_cooling_device *cdev;
901 struct thermal_zone_device *pos;
904 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
905 return ERR_PTR(-EINVAL);
907 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
909 return ERR_PTR(-EINVAL);
911 cdev = kzalloc(sizeof(struct thermal_cooling_device), GFP_KERNEL);
913 return ERR_PTR(-ENOMEM);
915 result = get_idr(&thermal_cdev_idr, &thermal_idr_lock, &cdev->id);
918 return ERR_PTR(result);
921 strcpy(cdev->type, type ? : "");
922 mutex_init(&cdev->lock);
923 INIT_LIST_HEAD(&cdev->thermal_instances);
925 cdev->updated = true;
926 cdev->device.class = &thermal_class;
927 cdev->devdata = devdata;
928 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
929 result = device_register(&cdev->device);
931 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
933 return ERR_PTR(result);
938 result = device_create_file(&cdev->device, &dev_attr_cdev_type);
943 result = device_create_file(&cdev->device, &dev_attr_max_state);
947 result = device_create_file(&cdev->device, &dev_attr_cur_state);
951 mutex_lock(&thermal_list_lock);
952 list_add(&cdev->node, &thermal_cdev_list);
953 list_for_each_entry(pos, &thermal_tz_list, node) {
956 result = pos->ops->bind(pos, cdev);
961 mutex_unlock(&thermal_list_lock);
967 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
968 device_unregister(&cdev->device);
969 return ERR_PTR(result);
971 EXPORT_SYMBOL(thermal_cooling_device_register);
974 * thermal_cooling_device_unregister - removes the registered thermal cooling device
975 * @cdev: the thermal cooling device to remove.
977 * thermal_cooling_device_unregister() must be called when the device is no
980 void thermal_cooling_device_unregister(struct
981 thermal_cooling_device
984 struct thermal_zone_device *tz;
985 struct thermal_cooling_device *pos = NULL;
990 mutex_lock(&thermal_list_lock);
991 list_for_each_entry(pos, &thermal_cdev_list, node)
995 /* thermal cooling device not found */
996 mutex_unlock(&thermal_list_lock);
999 list_del(&cdev->node);
1000 list_for_each_entry(tz, &thermal_tz_list, node) {
1001 if (!tz->ops->unbind)
1003 tz->ops->unbind(tz, cdev);
1005 mutex_unlock(&thermal_list_lock);
1007 device_remove_file(&cdev->device, &dev_attr_cdev_type);
1008 device_remove_file(&cdev->device, &dev_attr_max_state);
1009 device_remove_file(&cdev->device, &dev_attr_cur_state);
1011 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1012 device_unregister(&cdev->device);
1015 EXPORT_SYMBOL(thermal_cooling_device_unregister);
1017 static void thermal_cdev_do_update(struct thermal_cooling_device *cdev)
1019 struct thermal_instance *instance;
1020 unsigned long target = 0;
1022 /* cooling device is updated*/
1026 mutex_lock(&cdev->lock);
1027 /* Make sure cdev enters the deepest cooling state */
1028 list_for_each_entry(instance, &cdev->thermal_instances, cdev_node) {
1029 if (instance->target == THERMAL_NO_TARGET)
1031 if (instance->target > target)
1032 target = instance->target;
1034 mutex_unlock(&cdev->lock);
1035 cdev->ops->set_cur_state(cdev, target);
1036 cdev->updated = true;
1039 static void thermal_zone_do_update(struct thermal_zone_device *tz)
1041 struct thermal_instance *instance;
1043 list_for_each_entry(instance, &tz->thermal_instances, tz_node)
1044 thermal_cdev_do_update(instance->cdev);
1048 * Cooling algorithm for both active and passive cooling
1050 * 1. if the temperature is higher than a trip point,
1051 * a. if the trend is THERMAL_TREND_RAISING, use higher cooling
1052 * state for this trip point
1053 * b. if the trend is THERMAL_TREND_DROPPING, use lower cooling
1054 * state for this trip point
1056 * 2. if the temperature is lower than a trip point, use lower
1057 * cooling state for this trip point
1059 * Note that this behaves the same as the previous passive cooling
1063 static void thermal_zone_trip_update(struct thermal_zone_device *tz,
1064 int trip, long temp)
1066 struct thermal_instance *instance;
1067 struct thermal_cooling_device *cdev = NULL;
1068 unsigned long cur_state, max_state;
1070 enum thermal_trip_type trip_type;
1071 enum thermal_trend trend;
1073 if (trip == THERMAL_TRIPS_NONE) {
1074 trip_temp = tz->forced_passive;
1075 trip_type = THERMAL_TRIPS_NONE;
1077 tz->ops->get_trip_temp(tz, trip, &trip_temp);
1078 tz->ops->get_trip_type(tz, trip, &trip_type);
1081 if (!tz->ops->get_trend || tz->ops->get_trend(tz, trip, &trend)) {
1083 * compare the current temperature and previous temperature
1084 * to get the thermal trend, if no special requirement
1086 if (tz->temperature > tz->last_temperature)
1087 trend = THERMAL_TREND_RAISING;
1088 else if (tz->temperature < tz->last_temperature)
1089 trend = THERMAL_TREND_DROPPING;
1091 trend = THERMAL_TREND_STABLE;
1094 if (temp >= trip_temp) {
1095 list_for_each_entry(instance, &tz->thermal_instances, tz_node) {
1096 if (instance->trip != trip)
1099 cdev = instance->cdev;
1101 cdev->ops->get_cur_state(cdev, &cur_state);
1102 cdev->ops->get_max_state(cdev, &max_state);
1104 if (trend == THERMAL_TREND_RAISING) {
1105 cur_state = cur_state < instance->upper ?
1106 (cur_state + 1) : instance->upper;
1107 } else if (trend == THERMAL_TREND_DROPPING) {
1108 cur_state = cur_state > instance->lower ?
1109 (cur_state - 1) : instance->lower;
1112 /* activate a passive thermal instance */
1113 if ((trip_type == THERMAL_TRIP_PASSIVE ||
1114 trip_type == THERMAL_TRIPS_NONE) &&
1115 instance->target == THERMAL_NO_TARGET)
1118 instance->target = cur_state;
1119 cdev->updated = false; /* cooling device needs update */
1121 } else { /* below trip */
1122 list_for_each_entry(instance, &tz->thermal_instances, tz_node) {
1123 if (instance->trip != trip)
1126 /* Do not use the inactive thermal instance */
1127 if (instance->target == THERMAL_NO_TARGET)
1129 cdev = instance->cdev;
1130 cdev->ops->get_cur_state(cdev, &cur_state);
1132 cur_state = cur_state > instance->lower ?
1133 (cur_state - 1) : THERMAL_NO_TARGET;
1135 /* deactivate a passive thermal instance */
1136 if ((trip_type == THERMAL_TRIP_PASSIVE ||
1137 trip_type == THERMAL_TRIPS_NONE) &&
1138 cur_state == THERMAL_NO_TARGET)
1140 instance->target = cur_state;
1141 cdev->updated = false; /* cooling device needs update */
1148 * thermal_zone_device_update - force an update of a thermal zone's state
1149 * @ttz: the thermal zone to update
1152 void thermal_zone_device_update(struct thermal_zone_device *tz)
1155 long temp, trip_temp;
1156 enum thermal_trip_type trip_type;
1158 mutex_lock(&tz->lock);
1160 if (tz->ops->get_temp(tz, &temp)) {
1161 /* get_temp failed - retry it later */
1162 pr_warn("failed to read out thermal zone %d\n", tz->id);
1166 tz->last_temperature = tz->temperature;
1167 tz->temperature = temp;
1169 for (count = 0; count < tz->trips; count++) {
1170 tz->ops->get_trip_type(tz, count, &trip_type);
1171 tz->ops->get_trip_temp(tz, count, &trip_temp);
1173 switch (trip_type) {
1174 case THERMAL_TRIP_CRITICAL:
1175 if (temp >= trip_temp) {
1176 if (tz->ops->notify)
1177 ret = tz->ops->notify(tz, count,
1180 pr_emerg("Critical temperature reached (%ld C), shutting down\n",
1182 orderly_poweroff(true);
1186 case THERMAL_TRIP_HOT:
1187 if (temp >= trip_temp)
1188 if (tz->ops->notify)
1189 tz->ops->notify(tz, count, trip_type);
1191 case THERMAL_TRIP_ACTIVE:
1192 thermal_zone_trip_update(tz, count, temp);
1194 case THERMAL_TRIP_PASSIVE:
1195 if (temp >= trip_temp || tz->passive)
1196 thermal_zone_trip_update(tz, count, temp);
1201 if (tz->forced_passive)
1202 thermal_zone_trip_update(tz, THERMAL_TRIPS_NONE, temp);
1203 thermal_zone_do_update(tz);
1207 thermal_zone_device_set_polling(tz, tz->passive_delay);
1208 else if (tz->polling_delay)
1209 thermal_zone_device_set_polling(tz, tz->polling_delay);
1211 thermal_zone_device_set_polling(tz, 0);
1212 mutex_unlock(&tz->lock);
1214 EXPORT_SYMBOL(thermal_zone_device_update);
1217 * create_trip_attrs - create attributes for trip points
1218 * @tz: the thermal zone device
1219 * @mask: Writeable trip point bitmap.
1221 static int create_trip_attrs(struct thermal_zone_device *tz, int mask)
1224 int size = sizeof(struct thermal_attr) * tz->trips;
1226 tz->trip_type_attrs = kzalloc(size, GFP_KERNEL);
1227 if (!tz->trip_type_attrs)
1230 tz->trip_temp_attrs = kzalloc(size, GFP_KERNEL);
1231 if (!tz->trip_temp_attrs) {
1232 kfree(tz->trip_type_attrs);
1236 if (tz->ops->get_trip_hyst) {
1237 tz->trip_hyst_attrs = kzalloc(size, GFP_KERNEL);
1238 if (!tz->trip_hyst_attrs) {
1239 kfree(tz->trip_type_attrs);
1240 kfree(tz->trip_temp_attrs);
1246 for (indx = 0; indx < tz->trips; indx++) {
1247 /* create trip type attribute */
1248 snprintf(tz->trip_type_attrs[indx].name, THERMAL_NAME_LENGTH,
1249 "trip_point_%d_type", indx);
1251 sysfs_attr_init(&tz->trip_type_attrs[indx].attr.attr);
1252 tz->trip_type_attrs[indx].attr.attr.name =
1253 tz->trip_type_attrs[indx].name;
1254 tz->trip_type_attrs[indx].attr.attr.mode = S_IRUGO;
1255 tz->trip_type_attrs[indx].attr.show = trip_point_type_show;
1257 device_create_file(&tz->device,
1258 &tz->trip_type_attrs[indx].attr);
1260 /* create trip temp attribute */
1261 snprintf(tz->trip_temp_attrs[indx].name, THERMAL_NAME_LENGTH,
1262 "trip_point_%d_temp", indx);
1264 sysfs_attr_init(&tz->trip_temp_attrs[indx].attr.attr);
1265 tz->trip_temp_attrs[indx].attr.attr.name =
1266 tz->trip_temp_attrs[indx].name;
1267 tz->trip_temp_attrs[indx].attr.attr.mode = S_IRUGO;
1268 tz->trip_temp_attrs[indx].attr.show = trip_point_temp_show;
1269 if (mask & (1 << indx)) {
1270 tz->trip_temp_attrs[indx].attr.attr.mode |= S_IWUSR;
1271 tz->trip_temp_attrs[indx].attr.store =
1272 trip_point_temp_store;
1275 device_create_file(&tz->device,
1276 &tz->trip_temp_attrs[indx].attr);
1278 /* create Optional trip hyst attribute */
1279 if (!tz->ops->get_trip_hyst)
1281 snprintf(tz->trip_hyst_attrs[indx].name, THERMAL_NAME_LENGTH,
1282 "trip_point_%d_hyst", indx);
1284 sysfs_attr_init(&tz->trip_hyst_attrs[indx].attr.attr);
1285 tz->trip_hyst_attrs[indx].attr.attr.name =
1286 tz->trip_hyst_attrs[indx].name;
1287 tz->trip_hyst_attrs[indx].attr.attr.mode = S_IRUGO;
1288 tz->trip_hyst_attrs[indx].attr.show = trip_point_hyst_show;
1289 if (tz->ops->set_trip_hyst) {
1290 tz->trip_hyst_attrs[indx].attr.attr.mode |= S_IWUSR;
1291 tz->trip_hyst_attrs[indx].attr.store =
1292 trip_point_hyst_store;
1295 device_create_file(&tz->device,
1296 &tz->trip_hyst_attrs[indx].attr);
1301 static void remove_trip_attrs(struct thermal_zone_device *tz)
1305 for (indx = 0; indx < tz->trips; indx++) {
1306 device_remove_file(&tz->device,
1307 &tz->trip_type_attrs[indx].attr);
1308 device_remove_file(&tz->device,
1309 &tz->trip_temp_attrs[indx].attr);
1310 if (tz->ops->get_trip_hyst)
1311 device_remove_file(&tz->device,
1312 &tz->trip_hyst_attrs[indx].attr);
1314 kfree(tz->trip_type_attrs);
1315 kfree(tz->trip_temp_attrs);
1316 kfree(tz->trip_hyst_attrs);
1320 * thermal_zone_device_register - register a new thermal zone device
1321 * @type: the thermal zone device type
1322 * @trips: the number of trip points the thermal zone support
1323 * @mask: a bit string indicating the writeablility of trip points
1324 * @devdata: private device data
1325 * @ops: standard thermal zone device callbacks
1326 * @passive_delay: number of milliseconds to wait between polls when
1327 * performing passive cooling
1328 * @polling_delay: number of milliseconds to wait between polls when checking
1329 * whether trip points have been crossed (0 for interrupt
1332 * thermal_zone_device_unregister() must be called when the device is no
1333 * longer needed. The passive cooling depends on the .get_trend() return value.
1335 struct thermal_zone_device *thermal_zone_device_register(const char *type,
1336 int trips, int mask, void *devdata,
1337 const struct thermal_zone_device_ops *ops,
1338 int passive_delay, int polling_delay)
1340 struct thermal_zone_device *tz;
1341 struct thermal_cooling_device *pos;
1342 enum thermal_trip_type trip_type;
1347 if (type && strlen(type) >= THERMAL_NAME_LENGTH)
1348 return ERR_PTR(-EINVAL);
1350 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
1351 return ERR_PTR(-EINVAL);
1353 if (!ops || !ops->get_temp)
1354 return ERR_PTR(-EINVAL);
1356 tz = kzalloc(sizeof(struct thermal_zone_device), GFP_KERNEL);
1358 return ERR_PTR(-ENOMEM);
1360 INIT_LIST_HEAD(&tz->thermal_instances);
1362 mutex_init(&tz->lock);
1363 result = get_idr(&thermal_tz_idr, &thermal_idr_lock, &tz->id);
1366 return ERR_PTR(result);
1369 strcpy(tz->type, type ? : "");
1371 tz->device.class = &thermal_class;
1372 tz->devdata = devdata;
1374 tz->passive_delay = passive_delay;
1375 tz->polling_delay = polling_delay;
1377 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1378 result = device_register(&tz->device);
1380 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1382 return ERR_PTR(result);
1387 result = device_create_file(&tz->device, &dev_attr_type);
1392 result = device_create_file(&tz->device, &dev_attr_temp);
1396 if (ops->get_mode) {
1397 result = device_create_file(&tz->device, &dev_attr_mode);
1402 result = create_trip_attrs(tz, mask);
1406 for (count = 0; count < trips; count++) {
1407 tz->ops->get_trip_type(tz, count, &trip_type);
1408 if (trip_type == THERMAL_TRIP_PASSIVE)
1413 result = device_create_file(&tz->device,
1419 result = thermal_add_hwmon_sysfs(tz);
1423 mutex_lock(&thermal_list_lock);
1424 list_add_tail(&tz->node, &thermal_tz_list);
1426 list_for_each_entry(pos, &thermal_cdev_list, node) {
1427 result = ops->bind(tz, pos);
1431 mutex_unlock(&thermal_list_lock);
1433 INIT_DELAYED_WORK(&(tz->poll_queue), thermal_zone_device_check);
1435 thermal_zone_device_update(tz);
1441 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1442 device_unregister(&tz->device);
1443 return ERR_PTR(result);
1445 EXPORT_SYMBOL(thermal_zone_device_register);
1448 * thermal_device_unregister - removes the registered thermal zone device
1449 * @tz: the thermal zone device to remove
1451 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1453 struct thermal_cooling_device *cdev;
1454 struct thermal_zone_device *pos = NULL;
1459 mutex_lock(&thermal_list_lock);
1460 list_for_each_entry(pos, &thermal_tz_list, node)
1464 /* thermal zone device not found */
1465 mutex_unlock(&thermal_list_lock);
1468 list_del(&tz->node);
1469 if (tz->ops->unbind)
1470 list_for_each_entry(cdev, &thermal_cdev_list, node)
1471 tz->ops->unbind(tz, cdev);
1472 mutex_unlock(&thermal_list_lock);
1474 thermal_zone_device_set_polling(tz, 0);
1477 device_remove_file(&tz->device, &dev_attr_type);
1478 device_remove_file(&tz->device, &dev_attr_temp);
1479 if (tz->ops->get_mode)
1480 device_remove_file(&tz->device, &dev_attr_mode);
1481 remove_trip_attrs(tz);
1483 thermal_remove_hwmon_sysfs(tz);
1484 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1485 idr_destroy(&tz->idr);
1486 mutex_destroy(&tz->lock);
1487 device_unregister(&tz->device);
1490 EXPORT_SYMBOL(thermal_zone_device_unregister);
1493 static struct genl_family thermal_event_genl_family = {
1494 .id = GENL_ID_GENERATE,
1495 .name = THERMAL_GENL_FAMILY_NAME,
1496 .version = THERMAL_GENL_VERSION,
1497 .maxattr = THERMAL_GENL_ATTR_MAX,
1500 static struct genl_multicast_group thermal_event_mcgrp = {
1501 .name = THERMAL_GENL_MCAST_GROUP_NAME,
1504 int thermal_generate_netlink_event(u32 orig, enum events event)
1506 struct sk_buff *skb;
1507 struct nlattr *attr;
1508 struct thermal_genl_event *thermal_event;
1512 static unsigned int thermal_event_seqnum;
1514 /* allocate memory */
1515 size = nla_total_size(sizeof(struct thermal_genl_event)) +
1518 skb = genlmsg_new(size, GFP_ATOMIC);
1522 /* add the genetlink message header */
1523 msg_header = genlmsg_put(skb, 0, thermal_event_seqnum++,
1524 &thermal_event_genl_family, 0,
1525 THERMAL_GENL_CMD_EVENT);
1532 attr = nla_reserve(skb, THERMAL_GENL_ATTR_EVENT,
1533 sizeof(struct thermal_genl_event));
1540 thermal_event = nla_data(attr);
1541 if (!thermal_event) {
1546 memset(thermal_event, 0, sizeof(struct thermal_genl_event));
1548 thermal_event->orig = orig;
1549 thermal_event->event = event;
1551 /* send multicast genetlink message */
1552 result = genlmsg_end(skb, msg_header);
1558 result = genlmsg_multicast(skb, 0, thermal_event_mcgrp.id, GFP_ATOMIC);
1560 pr_info("failed to send netlink event:%d\n", result);
1564 EXPORT_SYMBOL(thermal_generate_netlink_event);
1566 static int genetlink_init(void)
1570 result = genl_register_family(&thermal_event_genl_family);
1574 result = genl_register_mc_group(&thermal_event_genl_family,
1575 &thermal_event_mcgrp);
1577 genl_unregister_family(&thermal_event_genl_family);
1581 static void genetlink_exit(void)
1583 genl_unregister_family(&thermal_event_genl_family);
1585 #else /* !CONFIG_NET */
1586 static inline int genetlink_init(void) { return 0; }
1587 static inline void genetlink_exit(void) {}
1588 #endif /* !CONFIG_NET */
1590 static int __init thermal_init(void)
1594 result = class_register(&thermal_class);
1596 idr_destroy(&thermal_tz_idr);
1597 idr_destroy(&thermal_cdev_idr);
1598 mutex_destroy(&thermal_idr_lock);
1599 mutex_destroy(&thermal_list_lock);
1601 result = genetlink_init();
1605 static void __exit thermal_exit(void)
1607 class_unregister(&thermal_class);
1608 idr_destroy(&thermal_tz_idr);
1609 idr_destroy(&thermal_cdev_idr);
1610 mutex_destroy(&thermal_idr_lock);
1611 mutex_destroy(&thermal_list_lock);
1615 fs_initcall(thermal_init);
1616 module_exit(thermal_exit);