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, THERMAL_NAME_LENGTH,
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, THERMAL_NAME_LENGTH,
615 "temp%d_crit", hwmon->count);
616 temp->temp_crit.attr.attr.name = temp->temp_crit.name;
617 temp->temp_crit.attr.attr.mode = 0444;
618 temp->temp_crit.attr.show = temp_crit_show;
619 sysfs_attr_init(&temp->temp_crit.attr.attr);
620 result = device_create_file(hwmon->device,
621 &temp->temp_crit.attr);
623 goto unregister_input;
627 mutex_lock(&thermal_list_lock);
628 if (new_hwmon_device)
629 list_add_tail(&hwmon->node, &thermal_hwmon_list);
630 list_add_tail(&temp->hwmon_node, &hwmon->tz_list);
631 mutex_unlock(&thermal_list_lock);
636 device_remove_file(hwmon->device, &temp->temp_input.attr);
640 if (new_hwmon_device) {
641 device_remove_file(hwmon->device, &dev_attr_name);
642 hwmon_device_unregister(hwmon->device);
645 if (new_hwmon_device)
652 thermal_remove_hwmon_sysfs(struct thermal_zone_device *tz)
654 struct thermal_hwmon_device *hwmon;
655 struct thermal_hwmon_temp *temp;
657 hwmon = thermal_hwmon_lookup_by_type(tz);
658 if (unlikely(!hwmon)) {
659 /* Should never happen... */
660 dev_dbg(&tz->device, "hwmon device lookup failed!\n");
664 temp = thermal_hwmon_lookup_temp(hwmon, tz);
665 if (unlikely(!temp)) {
666 /* Should never happen... */
667 dev_dbg(&tz->device, "temperature input lookup failed!\n");
671 device_remove_file(hwmon->device, &temp->temp_input.attr);
672 if (tz->ops->get_crit_temp)
673 device_remove_file(hwmon->device, &temp->temp_crit.attr);
675 mutex_lock(&thermal_list_lock);
676 list_del(&temp->hwmon_node);
678 if (!list_empty(&hwmon->tz_list)) {
679 mutex_unlock(&thermal_list_lock);
682 list_del(&hwmon->node);
683 mutex_unlock(&thermal_list_lock);
685 device_remove_file(hwmon->device, &dev_attr_name);
686 hwmon_device_unregister(hwmon->device);
691 thermal_add_hwmon_sysfs(struct thermal_zone_device *tz)
697 thermal_remove_hwmon_sysfs(struct thermal_zone_device *tz)
702 static void thermal_zone_device_set_polling(struct thermal_zone_device *tz,
705 cancel_delayed_work(&(tz->poll_queue));
711 queue_delayed_work(system_freezable_wq, &(tz->poll_queue),
712 round_jiffies(msecs_to_jiffies(delay)));
714 queue_delayed_work(system_freezable_wq, &(tz->poll_queue),
715 msecs_to_jiffies(delay));
718 static void thermal_zone_device_check(struct work_struct *work)
720 struct thermal_zone_device *tz = container_of(work, struct
723 thermal_zone_device_update(tz);
727 * thermal_zone_bind_cooling_device - bind a cooling device to a thermal zone
728 * @tz: thermal zone device
729 * @trip: indicates which trip point the cooling devices is
730 * associated with in this thermal zone.
731 * @cdev: thermal cooling device
733 * This function is usually called in the thermal zone device .bind callback.
735 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
737 struct thermal_cooling_device *cdev,
738 unsigned long upper, unsigned long lower)
740 struct thermal_instance *dev;
741 struct thermal_instance *pos;
742 struct thermal_zone_device *pos1;
743 struct thermal_cooling_device *pos2;
744 unsigned long max_state;
747 if (trip >= tz->trips || (trip < 0 && trip != THERMAL_TRIPS_NONE))
750 list_for_each_entry(pos1, &thermal_tz_list, node) {
754 list_for_each_entry(pos2, &thermal_cdev_list, node) {
759 if (tz != pos1 || cdev != pos2)
762 cdev->ops->get_max_state(cdev, &max_state);
764 /* lower default 0, upper default max_state */
765 lower = lower == THERMAL_NO_LIMIT ? 0 : lower;
766 upper = upper == THERMAL_NO_LIMIT ? max_state : upper;
768 if (lower > upper || upper > max_state)
772 kzalloc(sizeof(struct thermal_instance), GFP_KERNEL);
780 dev->target = THERMAL_NO_TARGET;
782 result = get_idr(&tz->idr, &tz->lock, &dev->id);
786 sprintf(dev->name, "cdev%d", dev->id);
788 sysfs_create_link(&tz->device.kobj, &cdev->device.kobj, dev->name);
792 sprintf(dev->attr_name, "cdev%d_trip_point", dev->id);
793 sysfs_attr_init(&dev->attr.attr);
794 dev->attr.attr.name = dev->attr_name;
795 dev->attr.attr.mode = 0444;
796 dev->attr.show = thermal_cooling_device_trip_point_show;
797 result = device_create_file(&tz->device, &dev->attr);
799 goto remove_symbol_link;
801 mutex_lock(&tz->lock);
802 mutex_lock(&cdev->lock);
803 list_for_each_entry(pos, &tz->thermal_instances, tz_node)
804 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
809 list_add_tail(&dev->tz_node, &tz->thermal_instances);
810 list_add_tail(&dev->cdev_node, &cdev->thermal_instances);
812 mutex_unlock(&cdev->lock);
813 mutex_unlock(&tz->lock);
818 device_remove_file(&tz->device, &dev->attr);
820 sysfs_remove_link(&tz->device.kobj, dev->name);
822 release_idr(&tz->idr, &tz->lock, dev->id);
827 EXPORT_SYMBOL(thermal_zone_bind_cooling_device);
830 * thermal_zone_unbind_cooling_device - unbind a cooling device from a thermal zone
831 * @tz: thermal zone device
832 * @trip: indicates which trip point the cooling devices is
833 * associated with in this thermal zone.
834 * @cdev: thermal cooling device
836 * This function is usually called in the thermal zone device .unbind callback.
838 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
840 struct thermal_cooling_device *cdev)
842 struct thermal_instance *pos, *next;
844 mutex_lock(&tz->lock);
845 mutex_lock(&cdev->lock);
846 list_for_each_entry_safe(pos, next, &tz->thermal_instances, tz_node) {
847 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
848 list_del(&pos->tz_node);
849 list_del(&pos->cdev_node);
850 mutex_unlock(&cdev->lock);
851 mutex_unlock(&tz->lock);
855 mutex_unlock(&cdev->lock);
856 mutex_unlock(&tz->lock);
861 device_remove_file(&tz->device, &pos->attr);
862 sysfs_remove_link(&tz->device.kobj, pos->name);
863 release_idr(&tz->idr, &tz->lock, pos->id);
867 EXPORT_SYMBOL(thermal_zone_unbind_cooling_device);
869 static void thermal_release(struct device *dev)
871 struct thermal_zone_device *tz;
872 struct thermal_cooling_device *cdev;
874 if (!strncmp(dev_name(dev), "thermal_zone",
875 sizeof("thermal_zone") - 1)) {
876 tz = to_thermal_zone(dev);
879 cdev = to_cooling_device(dev);
884 static struct class thermal_class = {
886 .dev_release = thermal_release,
890 * thermal_cooling_device_register - register a new thermal cooling device
891 * @type: the thermal cooling device type.
892 * @devdata: device private data.
893 * @ops: standard thermal cooling devices callbacks.
895 struct thermal_cooling_device *
896 thermal_cooling_device_register(char *type, void *devdata,
897 const struct thermal_cooling_device_ops *ops)
899 struct thermal_cooling_device *cdev;
900 struct thermal_zone_device *pos;
903 if (strlen(type) >= THERMAL_NAME_LENGTH)
904 return ERR_PTR(-EINVAL);
906 if (!ops || !ops->get_max_state || !ops->get_cur_state ||
908 return ERR_PTR(-EINVAL);
910 cdev = kzalloc(sizeof(struct thermal_cooling_device), GFP_KERNEL);
912 return ERR_PTR(-ENOMEM);
914 result = get_idr(&thermal_cdev_idr, &thermal_idr_lock, &cdev->id);
917 return ERR_PTR(result);
920 strcpy(cdev->type, type);
921 mutex_init(&cdev->lock);
922 INIT_LIST_HEAD(&cdev->thermal_instances);
924 cdev->updated = true;
925 cdev->device.class = &thermal_class;
926 cdev->devdata = devdata;
927 dev_set_name(&cdev->device, "cooling_device%d", cdev->id);
928 result = device_register(&cdev->device);
930 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
932 return ERR_PTR(result);
937 result = device_create_file(&cdev->device, &dev_attr_cdev_type);
942 result = device_create_file(&cdev->device, &dev_attr_max_state);
946 result = device_create_file(&cdev->device, &dev_attr_cur_state);
950 mutex_lock(&thermal_list_lock);
951 list_add(&cdev->node, &thermal_cdev_list);
952 list_for_each_entry(pos, &thermal_tz_list, node) {
955 result = pos->ops->bind(pos, cdev);
960 mutex_unlock(&thermal_list_lock);
966 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
967 device_unregister(&cdev->device);
968 return ERR_PTR(result);
970 EXPORT_SYMBOL(thermal_cooling_device_register);
973 * thermal_cooling_device_unregister - removes the registered thermal cooling device
974 * @cdev: the thermal cooling device to remove.
976 * thermal_cooling_device_unregister() must be called when the device is no
979 void thermal_cooling_device_unregister(struct
980 thermal_cooling_device
983 struct thermal_zone_device *tz;
984 struct thermal_cooling_device *pos = NULL;
989 mutex_lock(&thermal_list_lock);
990 list_for_each_entry(pos, &thermal_cdev_list, node)
994 /* thermal cooling device not found */
995 mutex_unlock(&thermal_list_lock);
998 list_del(&cdev->node);
999 list_for_each_entry(tz, &thermal_tz_list, node) {
1000 if (!tz->ops->unbind)
1002 tz->ops->unbind(tz, cdev);
1004 mutex_unlock(&thermal_list_lock);
1006 device_remove_file(&cdev->device, &dev_attr_cdev_type);
1007 device_remove_file(&cdev->device, &dev_attr_max_state);
1008 device_remove_file(&cdev->device, &dev_attr_cur_state);
1010 release_idr(&thermal_cdev_idr, &thermal_idr_lock, cdev->id);
1011 device_unregister(&cdev->device);
1014 EXPORT_SYMBOL(thermal_cooling_device_unregister);
1016 static void thermal_cdev_do_update(struct thermal_cooling_device *cdev)
1018 struct thermal_instance *instance;
1019 unsigned long target = 0;
1021 /* cooling device is updated*/
1025 mutex_lock(&cdev->lock);
1026 /* Make sure cdev enters the deepest cooling state */
1027 list_for_each_entry(instance, &cdev->thermal_instances, cdev_node) {
1028 if (instance->target == THERMAL_NO_TARGET)
1030 if (instance->target > target)
1031 target = instance->target;
1033 mutex_unlock(&cdev->lock);
1034 cdev->ops->set_cur_state(cdev, target);
1035 cdev->updated = true;
1038 static void thermal_zone_do_update(struct thermal_zone_device *tz)
1040 struct thermal_instance *instance;
1042 list_for_each_entry(instance, &tz->thermal_instances, tz_node)
1043 thermal_cdev_do_update(instance->cdev);
1047 * Cooling algorithm for both active and passive cooling
1049 * 1. if the temperature is higher than a trip point,
1050 * a. if the trend is THERMAL_TREND_RAISING, use higher cooling
1051 * state for this trip point
1052 * b. if the trend is THERMAL_TREND_DROPPING, use lower cooling
1053 * state for this trip point
1055 * 2. if the temperature is lower than a trip point, use lower
1056 * cooling state for this trip point
1058 * Note that this behaves the same as the previous passive cooling
1062 static void thermal_zone_trip_update(struct thermal_zone_device *tz,
1063 int trip, long temp)
1065 struct thermal_instance *instance;
1066 struct thermal_cooling_device *cdev = NULL;
1067 unsigned long cur_state, max_state;
1069 enum thermal_trip_type trip_type;
1070 enum thermal_trend trend;
1072 if (trip == THERMAL_TRIPS_NONE) {
1073 trip_temp = tz->forced_passive;
1074 trip_type = THERMAL_TRIPS_NONE;
1076 tz->ops->get_trip_temp(tz, trip, &trip_temp);
1077 tz->ops->get_trip_type(tz, trip, &trip_type);
1080 if (!tz->ops->get_trend || tz->ops->get_trend(tz, trip, &trend)) {
1082 * compare the current temperature and previous temperature
1083 * to get the thermal trend, if no special requirement
1085 if (tz->temperature > tz->last_temperature)
1086 trend = THERMAL_TREND_RAISING;
1087 else if (tz->temperature < tz->last_temperature)
1088 trend = THERMAL_TREND_DROPPING;
1090 trend = THERMAL_TREND_STABLE;
1093 if (temp >= trip_temp) {
1094 list_for_each_entry(instance, &tz->thermal_instances, tz_node) {
1095 if (instance->trip != trip)
1098 cdev = instance->cdev;
1100 cdev->ops->get_cur_state(cdev, &cur_state);
1101 cdev->ops->get_max_state(cdev, &max_state);
1103 if (trend == THERMAL_TREND_RAISING) {
1104 cur_state = cur_state < instance->upper ?
1105 (cur_state + 1) : instance->upper;
1106 } else if (trend == THERMAL_TREND_DROPPING) {
1107 cur_state = cur_state > instance->lower ?
1108 (cur_state - 1) : instance->lower;
1111 /* activate a passive thermal instance */
1112 if ((trip_type == THERMAL_TRIP_PASSIVE ||
1113 trip_type == THERMAL_TRIPS_NONE) &&
1114 instance->target == THERMAL_NO_TARGET)
1117 instance->target = cur_state;
1118 cdev->updated = false; /* cooling device needs update */
1120 } else { /* below trip */
1121 list_for_each_entry(instance, &tz->thermal_instances, tz_node) {
1122 if (instance->trip != trip)
1125 /* Do not use the inactive thermal instance */
1126 if (instance->target == THERMAL_NO_TARGET)
1128 cdev = instance->cdev;
1129 cdev->ops->get_cur_state(cdev, &cur_state);
1131 cur_state = cur_state > instance->lower ?
1132 (cur_state - 1) : THERMAL_NO_TARGET;
1134 /* deactivate a passive thermal instance */
1135 if ((trip_type == THERMAL_TRIP_PASSIVE ||
1136 trip_type == THERMAL_TRIPS_NONE) &&
1137 cur_state == THERMAL_NO_TARGET)
1139 instance->target = cur_state;
1140 cdev->updated = false; /* cooling device needs update */
1147 * thermal_zone_device_update - force an update of a thermal zone's state
1148 * @ttz: the thermal zone to update
1151 void thermal_zone_device_update(struct thermal_zone_device *tz)
1154 long temp, trip_temp;
1155 enum thermal_trip_type trip_type;
1157 mutex_lock(&tz->lock);
1159 if (tz->ops->get_temp(tz, &temp)) {
1160 /* get_temp failed - retry it later */
1161 pr_warn("failed to read out thermal zone %d\n", tz->id);
1165 tz->last_temperature = tz->temperature;
1166 tz->temperature = temp;
1168 for (count = 0; count < tz->trips; count++) {
1169 tz->ops->get_trip_type(tz, count, &trip_type);
1170 tz->ops->get_trip_temp(tz, count, &trip_temp);
1172 switch (trip_type) {
1173 case THERMAL_TRIP_CRITICAL:
1174 if (temp >= trip_temp) {
1175 if (tz->ops->notify)
1176 ret = tz->ops->notify(tz, count,
1179 pr_emerg("Critical temperature reached (%ld C), shutting down\n",
1181 orderly_poweroff(true);
1185 case THERMAL_TRIP_HOT:
1186 if (temp >= trip_temp)
1187 if (tz->ops->notify)
1188 tz->ops->notify(tz, count, trip_type);
1190 case THERMAL_TRIP_ACTIVE:
1191 thermal_zone_trip_update(tz, count, temp);
1193 case THERMAL_TRIP_PASSIVE:
1194 if (temp >= trip_temp || tz->passive)
1195 thermal_zone_trip_update(tz, count, temp);
1200 if (tz->forced_passive)
1201 thermal_zone_trip_update(tz, THERMAL_TRIPS_NONE, temp);
1202 thermal_zone_do_update(tz);
1206 thermal_zone_device_set_polling(tz, tz->passive_delay);
1207 else if (tz->polling_delay)
1208 thermal_zone_device_set_polling(tz, tz->polling_delay);
1210 thermal_zone_device_set_polling(tz, 0);
1211 mutex_unlock(&tz->lock);
1213 EXPORT_SYMBOL(thermal_zone_device_update);
1216 * create_trip_attrs - create attributes for trip points
1217 * @tz: the thermal zone device
1218 * @mask: Writeable trip point bitmap.
1220 static int create_trip_attrs(struct thermal_zone_device *tz, int mask)
1223 int size = sizeof(struct thermal_attr) * tz->trips;
1225 tz->trip_type_attrs = kzalloc(size, GFP_KERNEL);
1226 if (!tz->trip_type_attrs)
1229 tz->trip_temp_attrs = kzalloc(size, GFP_KERNEL);
1230 if (!tz->trip_temp_attrs) {
1231 kfree(tz->trip_type_attrs);
1235 if (tz->ops->get_trip_hyst) {
1236 tz->trip_hyst_attrs = kzalloc(size, GFP_KERNEL);
1237 if (!tz->trip_hyst_attrs) {
1238 kfree(tz->trip_type_attrs);
1239 kfree(tz->trip_temp_attrs);
1245 for (indx = 0; indx < tz->trips; indx++) {
1246 /* create trip type attribute */
1247 snprintf(tz->trip_type_attrs[indx].name, THERMAL_NAME_LENGTH,
1248 "trip_point_%d_type", indx);
1250 sysfs_attr_init(&tz->trip_type_attrs[indx].attr.attr);
1251 tz->trip_type_attrs[indx].attr.attr.name =
1252 tz->trip_type_attrs[indx].name;
1253 tz->trip_type_attrs[indx].attr.attr.mode = S_IRUGO;
1254 tz->trip_type_attrs[indx].attr.show = trip_point_type_show;
1256 device_create_file(&tz->device,
1257 &tz->trip_type_attrs[indx].attr);
1259 /* create trip temp attribute */
1260 snprintf(tz->trip_temp_attrs[indx].name, THERMAL_NAME_LENGTH,
1261 "trip_point_%d_temp", indx);
1263 sysfs_attr_init(&tz->trip_temp_attrs[indx].attr.attr);
1264 tz->trip_temp_attrs[indx].attr.attr.name =
1265 tz->trip_temp_attrs[indx].name;
1266 tz->trip_temp_attrs[indx].attr.attr.mode = S_IRUGO;
1267 tz->trip_temp_attrs[indx].attr.show = trip_point_temp_show;
1268 if (mask & (1 << indx)) {
1269 tz->trip_temp_attrs[indx].attr.attr.mode |= S_IWUSR;
1270 tz->trip_temp_attrs[indx].attr.store =
1271 trip_point_temp_store;
1274 device_create_file(&tz->device,
1275 &tz->trip_temp_attrs[indx].attr);
1277 /* create Optional trip hyst attribute */
1278 if (!tz->ops->get_trip_hyst)
1280 snprintf(tz->trip_hyst_attrs[indx].name, THERMAL_NAME_LENGTH,
1281 "trip_point_%d_hyst", indx);
1283 sysfs_attr_init(&tz->trip_hyst_attrs[indx].attr.attr);
1284 tz->trip_hyst_attrs[indx].attr.attr.name =
1285 tz->trip_hyst_attrs[indx].name;
1286 tz->trip_hyst_attrs[indx].attr.attr.mode = S_IRUGO;
1287 tz->trip_hyst_attrs[indx].attr.show = trip_point_hyst_show;
1288 if (tz->ops->set_trip_hyst) {
1289 tz->trip_hyst_attrs[indx].attr.attr.mode |= S_IWUSR;
1290 tz->trip_hyst_attrs[indx].attr.store =
1291 trip_point_hyst_store;
1294 device_create_file(&tz->device,
1295 &tz->trip_hyst_attrs[indx].attr);
1300 static void remove_trip_attrs(struct thermal_zone_device *tz)
1304 for (indx = 0; indx < tz->trips; indx++) {
1305 device_remove_file(&tz->device,
1306 &tz->trip_type_attrs[indx].attr);
1307 device_remove_file(&tz->device,
1308 &tz->trip_temp_attrs[indx].attr);
1309 if (tz->ops->get_trip_hyst)
1310 device_remove_file(&tz->device,
1311 &tz->trip_hyst_attrs[indx].attr);
1313 kfree(tz->trip_type_attrs);
1314 kfree(tz->trip_temp_attrs);
1315 kfree(tz->trip_hyst_attrs);
1319 * thermal_zone_device_register - register a new thermal zone device
1320 * @type: the thermal zone device type
1321 * @trips: the number of trip points the thermal zone support
1322 * @mask: a bit string indicating the writeablility of trip points
1323 * @devdata: private device data
1324 * @ops: standard thermal zone device callbacks
1325 * @passive_delay: number of milliseconds to wait between polls when
1326 * performing passive cooling
1327 * @polling_delay: number of milliseconds to wait between polls when checking
1328 * whether trip points have been crossed (0 for interrupt
1331 * thermal_zone_device_unregister() must be called when the device is no
1332 * longer needed. The passive cooling depends on the .get_trend() return value.
1334 struct thermal_zone_device *thermal_zone_device_register(const char *type,
1335 int trips, int mask, void *devdata,
1336 const struct thermal_zone_device_ops *ops,
1337 int passive_delay, int polling_delay)
1339 struct thermal_zone_device *tz;
1340 struct thermal_cooling_device *pos;
1341 enum thermal_trip_type trip_type;
1346 if (strlen(type) >= THERMAL_NAME_LENGTH)
1347 return ERR_PTR(-EINVAL);
1349 if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
1350 return ERR_PTR(-EINVAL);
1352 if (!ops || !ops->get_temp)
1353 return ERR_PTR(-EINVAL);
1355 tz = kzalloc(sizeof(struct thermal_zone_device), GFP_KERNEL);
1357 return ERR_PTR(-ENOMEM);
1359 INIT_LIST_HEAD(&tz->thermal_instances);
1361 mutex_init(&tz->lock);
1362 result = get_idr(&thermal_tz_idr, &thermal_idr_lock, &tz->id);
1365 return ERR_PTR(result);
1368 strcpy(tz->type, type);
1370 tz->device.class = &thermal_class;
1371 tz->devdata = devdata;
1373 tz->passive_delay = passive_delay;
1374 tz->polling_delay = polling_delay;
1376 dev_set_name(&tz->device, "thermal_zone%d", tz->id);
1377 result = device_register(&tz->device);
1379 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1381 return ERR_PTR(result);
1386 result = device_create_file(&tz->device, &dev_attr_type);
1391 result = device_create_file(&tz->device, &dev_attr_temp);
1395 if (ops->get_mode) {
1396 result = device_create_file(&tz->device, &dev_attr_mode);
1401 result = create_trip_attrs(tz, mask);
1405 for (count = 0; count < trips; count++) {
1406 tz->ops->get_trip_type(tz, count, &trip_type);
1407 if (trip_type == THERMAL_TRIP_PASSIVE)
1412 result = device_create_file(&tz->device,
1418 result = thermal_add_hwmon_sysfs(tz);
1422 mutex_lock(&thermal_list_lock);
1423 list_add_tail(&tz->node, &thermal_tz_list);
1425 list_for_each_entry(pos, &thermal_cdev_list, node) {
1426 result = ops->bind(tz, pos);
1430 mutex_unlock(&thermal_list_lock);
1432 INIT_DELAYED_WORK(&(tz->poll_queue), thermal_zone_device_check);
1434 thermal_zone_device_update(tz);
1440 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1441 device_unregister(&tz->device);
1442 return ERR_PTR(result);
1444 EXPORT_SYMBOL(thermal_zone_device_register);
1447 * thermal_device_unregister - removes the registered thermal zone device
1448 * @tz: the thermal zone device to remove
1450 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
1452 struct thermal_cooling_device *cdev;
1453 struct thermal_zone_device *pos = NULL;
1458 mutex_lock(&thermal_list_lock);
1459 list_for_each_entry(pos, &thermal_tz_list, node)
1463 /* thermal zone device not found */
1464 mutex_unlock(&thermal_list_lock);
1467 list_del(&tz->node);
1468 if (tz->ops->unbind)
1469 list_for_each_entry(cdev, &thermal_cdev_list, node)
1470 tz->ops->unbind(tz, cdev);
1471 mutex_unlock(&thermal_list_lock);
1473 thermal_zone_device_set_polling(tz, 0);
1476 device_remove_file(&tz->device, &dev_attr_type);
1477 device_remove_file(&tz->device, &dev_attr_temp);
1478 if (tz->ops->get_mode)
1479 device_remove_file(&tz->device, &dev_attr_mode);
1480 remove_trip_attrs(tz);
1482 thermal_remove_hwmon_sysfs(tz);
1483 release_idr(&thermal_tz_idr, &thermal_idr_lock, tz->id);
1484 idr_destroy(&tz->idr);
1485 mutex_destroy(&tz->lock);
1486 device_unregister(&tz->device);
1489 EXPORT_SYMBOL(thermal_zone_device_unregister);
1492 static struct genl_family thermal_event_genl_family = {
1493 .id = GENL_ID_GENERATE,
1494 .name = THERMAL_GENL_FAMILY_NAME,
1495 .version = THERMAL_GENL_VERSION,
1496 .maxattr = THERMAL_GENL_ATTR_MAX,
1499 static struct genl_multicast_group thermal_event_mcgrp = {
1500 .name = THERMAL_GENL_MCAST_GROUP_NAME,
1503 int thermal_generate_netlink_event(u32 orig, enum events event)
1505 struct sk_buff *skb;
1506 struct nlattr *attr;
1507 struct thermal_genl_event *thermal_event;
1511 static unsigned int thermal_event_seqnum;
1513 /* allocate memory */
1514 size = nla_total_size(sizeof(struct thermal_genl_event)) +
1517 skb = genlmsg_new(size, GFP_ATOMIC);
1521 /* add the genetlink message header */
1522 msg_header = genlmsg_put(skb, 0, thermal_event_seqnum++,
1523 &thermal_event_genl_family, 0,
1524 THERMAL_GENL_CMD_EVENT);
1531 attr = nla_reserve(skb, THERMAL_GENL_ATTR_EVENT,
1532 sizeof(struct thermal_genl_event));
1539 thermal_event = nla_data(attr);
1540 if (!thermal_event) {
1545 memset(thermal_event, 0, sizeof(struct thermal_genl_event));
1547 thermal_event->orig = orig;
1548 thermal_event->event = event;
1550 /* send multicast genetlink message */
1551 result = genlmsg_end(skb, msg_header);
1557 result = genlmsg_multicast(skb, 0, thermal_event_mcgrp.id, GFP_ATOMIC);
1559 pr_info("failed to send netlink event:%d\n", result);
1563 EXPORT_SYMBOL(thermal_generate_netlink_event);
1565 static int genetlink_init(void)
1569 result = genl_register_family(&thermal_event_genl_family);
1573 result = genl_register_mc_group(&thermal_event_genl_family,
1574 &thermal_event_mcgrp);
1576 genl_unregister_family(&thermal_event_genl_family);
1580 static void genetlink_exit(void)
1582 genl_unregister_family(&thermal_event_genl_family);
1584 #else /* !CONFIG_NET */
1585 static inline int genetlink_init(void) { return 0; }
1586 static inline void genetlink_exit(void) {}
1587 #endif /* !CONFIG_NET */
1589 static int __init thermal_init(void)
1593 result = class_register(&thermal_class);
1595 idr_destroy(&thermal_tz_idr);
1596 idr_destroy(&thermal_cdev_idr);
1597 mutex_destroy(&thermal_idr_lock);
1598 mutex_destroy(&thermal_list_lock);
1600 result = genetlink_init();
1604 static void __exit thermal_exit(void)
1606 class_unregister(&thermal_class);
1607 idr_destroy(&thermal_tz_idr);
1608 idr_destroy(&thermal_cdev_idr);
1609 mutex_destroy(&thermal_idr_lock);
1610 mutex_destroy(&thermal_list_lock);
1614 fs_initcall(thermal_init);
1615 module_exit(thermal_exit);