drivers/thermal/thermal_helpers.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  thermal_helpers.c - helper functions to handle thermal devices
   4  *
   5  *  Copyright (C) 2016 Eduardo Valentin <edubezval@gmail.com>
   6  *
   7  *  Highly based on original thermal_core.c
   8  *  Copyright (C) 2008 Intel Corp
   9  *  Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
  10  *  Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
  11  */
  12
  13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  14
  15 #include <linux/device.h>
  16 #include <linux/err.h>
  17 #include <linux/export.h>
  18 #include <linux/slab.h>
  19 #include <linux/string.h>
  20 #include <linux/sysfs.h>
  21
  22 #include <trace/events/thermal.h>
  23
  24 #include "thermal_core.h"
  25
  26 int get_tz_trend(struct thermal_zone_device *tz, int trip)
  27 {
  28         enum thermal_trend trend;
  29
  30         if (tz->emul_temperature || !tz->ops->get_trend ||
  31             tz->ops->get_trend(tz, trip, &trend)) {
  32                 if (tz->temperature > tz->last_temperature)
  33                         trend = THERMAL_TREND_RAISING;
  34                 else if (tz->temperature < tz->last_temperature)
  35                         trend = THERMAL_TREND_DROPPING;
  36                 else
  37                         trend = THERMAL_TREND_STABLE;
  38         }
  39
  40         return trend;
  41 }
  42
  43 struct thermal_instance *
  44 get_thermal_instance(struct thermal_zone_device *tz,
  45                      struct thermal_cooling_device *cdev, int trip)
  46 {
  47         struct thermal_instance *pos = NULL;
  48         struct thermal_instance *target_instance = NULL;
  49
  50         mutex_lock(&tz->lock);
  51         mutex_lock(&cdev->lock);
  52
  53         list_for_each_entry(pos, &tz->thermal_instances, tz_node) {
  54                 if (pos->tz == tz && pos->trip == trip && pos->cdev == cdev) {
  55                         target_instance = pos;
  56                         break;
  57                 }
  58         }
  59
  60         mutex_unlock(&cdev->lock);
  61         mutex_unlock(&tz->lock);
  62
  63         return target_instance;
  64 }
  65 EXPORT_SYMBOL(get_thermal_instance);
  66
  67 /**
  68  * __thermal_zone_get_temp() - returns the temperature of a thermal zone
  69  * @tz: a valid pointer to a struct thermal_zone_device
  70  * @temp: a valid pointer to where to store the resulting temperature.
  71  *
  72  * When a valid thermal zone reference is passed, it will fetch its
  73  * temperature and fill @temp.
  74  *
  75  * Both tz and tz->ops must be valid pointers when calling this function,
  76  * and the tz->ops->get_temp callback must be provided.
  77  * The function must be called under tz->lock.
  78  *
  79  * Return: On success returns 0, an error code otherwise
  80  */
  81 int __thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp)
  82 {
  83         int ret = -EINVAL;
  84         int count;
  85         int crit_temp = INT_MAX;
  86         struct thermal_trip trip;
  87
  88         lockdep_assert_held(&tz->lock);
  89
  90         ret = tz->ops->get_temp(tz, temp);
  91
  92         if (IS_ENABLED(CONFIG_THERMAL_EMULATION) && tz->emul_temperature) {
  93                 for (count = 0; count < tz->num_trips; count++) {
  94                         ret = __thermal_zone_get_trip(tz, count, &trip);
  95                         if (!ret && trip.type == THERMAL_TRIP_CRITICAL) {
  96                                 crit_temp = trip.temperature;
  97                                 break;
  98                         }
  99                 }
 100
 101                 /*
 102                  * Only allow emulating a temperature when the real temperature
 103                  * is below the critical temperature so that the emulation code
 104                  * cannot hide critical conditions.
 105                  */
 106                 if (!ret && *temp < crit_temp)
 107                         *temp = tz->emul_temperature;
 108         }
 109
 110         return ret;
 111 }
 112
 113 /**
 114  * thermal_zone_get_temp() - returns the temperature of a thermal zone
 115  * @tz: a valid pointer to a struct thermal_zone_device
 116  * @temp: a valid pointer to where to store the resulting temperature.
 117  *
 118  * When a valid thermal zone reference is passed, it will fetch its
 119  * temperature and fill @temp.
 120  *
 121  * Return: On success returns 0, an error code otherwise
 122  */
 123 int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp)
 124 {
 125         int ret;
 126
 127         if (IS_ERR_OR_NULL(tz))
 128                 return -EINVAL;
 129
 130         mutex_lock(&tz->lock);
 131
 132         if (!tz->ops->get_temp) {
 133                 ret = -EINVAL;
 134                 goto unlock;
 135         }
 136
 137         if (device_is_registered(&tz->device))
 138                 ret = __thermal_zone_get_temp(tz, temp);
 139         else
 140                 ret = -ENODEV;
 141
 142 unlock:
 143         mutex_unlock(&tz->lock);
 144
 145         return ret;
 146 }
 147 EXPORT_SYMBOL_GPL(thermal_zone_get_temp);
 148
 149 static void thermal_cdev_set_cur_state(struct thermal_cooling_device *cdev,
 150                                        int target)
 151 {
 152         if (cdev->ops->set_cur_state(cdev, target))
 153                 return;
 154
 155         thermal_notify_cdev_state_update(cdev->id, target);
 156         thermal_cooling_device_stats_update(cdev, target);
 157 }
 158
 159 void __thermal_cdev_update(struct thermal_cooling_device *cdev)
 160 {
 161         struct thermal_instance *instance;
 162         unsigned long target = 0;
 163
 164         /* Make sure cdev enters the deepest cooling state */
 165         list_for_each_entry(instance, &cdev->thermal_instances, cdev_node) {
 166                 dev_dbg(&cdev->device, "zone%d->target=%lu\n",
 167                         instance->tz->id, instance->target);
 168                 if (instance->target == THERMAL_NO_TARGET)
 169                         continue;
 170                 if (instance->target > target)
 171                         target = instance->target;
 172         }
 173
 174         thermal_cdev_set_cur_state(cdev, target);
 175
 176         trace_cdev_update(cdev, target);
 177         dev_dbg(&cdev->device, "set to state %lu\n", target);
 178 }
 179
 180 /**
 181  * thermal_cdev_update - update cooling device state if needed
 182  * @cdev:       pointer to struct thermal_cooling_device
 183  *
 184  * Update the cooling device state if there is a need.
 185  */
 186 void thermal_cdev_update(struct thermal_cooling_device *cdev)
 187 {
 188         mutex_lock(&cdev->lock);
 189         if (!cdev->updated) {
 190                 __thermal_cdev_update(cdev);
 191                 cdev->updated = true;
 192         }
 193         mutex_unlock(&cdev->lock);
 194 }
 195
 196 /**
 197  * thermal_zone_get_slope - return the slope attribute of the thermal zone
 198  * @tz: thermal zone device with the slope attribute
 199  *
 200  * Return: If the thermal zone device has a slope attribute, return it, else
 201  * return 1.
 202  */
 203 int thermal_zone_get_slope(struct thermal_zone_device *tz)
 204 {
 205         if (tz && tz->tzp)
 206                 return tz->tzp->slope;
 207         return 1;
 208 }
 209 EXPORT_SYMBOL_GPL(thermal_zone_get_slope);
 210
 211 /**
 212  * thermal_zone_get_offset - return the offset attribute of the thermal zone
 213  * @tz: thermal zone device with the offset attribute
 214  *
 215  * Return: If the thermal zone device has a offset attribute, return it, else
 216  * return 0.
 217  */
 218 int thermal_zone_get_offset(struct thermal_zone_device *tz)
 219 {
 220         if (tz && tz->tzp)
 221                 return tz->tzp->offset;
 222         return 0;
 223 }
 224 EXPORT_SYMBOL_GPL(thermal_zone_get_offset);