include/linux/thermal.h

   1 /*
   2  *  thermal.h  ($Revision: 0 $)
   3  *
   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>
   7  *
   8  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; version 2 of the License.
  12  *
  13  *  This program is distributed in the hope that it will be useful, but
  14  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  *  General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License along
  19  *  with this program; if not, write to the Free Software Foundation, Inc.,
  20  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  21  *
  22  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23  */
  24
  25 #ifndef __THERMAL_H__
  26 #define __THERMAL_H__
  27
  28 #include <linux/of.h>
  29 #include <linux/idr.h>
  30 #include <linux/device.h>
  31 #include <linux/workqueue.h>
  32
  33 #define THERMAL_TRIPS_NONE      -1
  34 #define THERMAL_MAX_TRIPS       12
  35 #define THERMAL_NAME_LENGTH     20
  36
  37 /* invalid cooling state */
  38 #define THERMAL_CSTATE_INVALID -1UL
  39
  40 /* No upper/lower limit requirement */
  41 #define THERMAL_NO_LIMIT        THERMAL_CSTATE_INVALID
  42
  43 /* Unit conversion macros */
  44 #define KELVIN_TO_CELSIUS(t)    (long)(((long)t-2732 >= 0) ?    \
  45                                 ((long)t-2732+5)/10 : ((long)t-2732-5)/10)
  46 #define CELSIUS_TO_KELVIN(t)    ((t)*10+2732)
  47
  48 /* Adding event notification support elements */
  49 #define THERMAL_GENL_FAMILY_NAME                "thermal_event"
  50 #define THERMAL_GENL_VERSION                    0x01
  51 #define THERMAL_GENL_MCAST_GROUP_NAME           "thermal_mc_grp"
  52
  53 /* Default Thermal Governor */
  54 #if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
  55 #define DEFAULT_THERMAL_GOVERNOR       "step_wise"
  56 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
  57 #define DEFAULT_THERMAL_GOVERNOR       "fair_share"
  58 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
  59 #define DEFAULT_THERMAL_GOVERNOR       "user_space"
  60 #endif
  61
  62 struct thermal_zone_device;
  63 struct thermal_cooling_device;
  64
  65 enum thermal_device_mode {
  66         THERMAL_DEVICE_DISABLED = 0,
  67         THERMAL_DEVICE_ENABLED,
  68 };
  69
  70 enum thermal_trip_type {
  71         THERMAL_TRIP_ACTIVE = 0,
  72         THERMAL_TRIP_PASSIVE,
  73         THERMAL_TRIP_HOT,
  74         THERMAL_TRIP_CRITICAL,
  75 };
  76
  77 enum thermal_trend {
  78         THERMAL_TREND_STABLE, /* temperature is stable */
  79         THERMAL_TREND_RAISING, /* temperature is raising */
  80         THERMAL_TREND_DROPPING, /* temperature is dropping */
  81         THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
  82         THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
  83 };
  84
  85 /* Events supported by Thermal Netlink */
  86 enum events {
  87         THERMAL_AUX0,
  88         THERMAL_AUX1,
  89         THERMAL_CRITICAL,
  90         THERMAL_DEV_FAULT,
  91 };
  92
  93 /* attributes of thermal_genl_family */
  94 enum {
  95         THERMAL_GENL_ATTR_UNSPEC,
  96         THERMAL_GENL_ATTR_EVENT,
  97         __THERMAL_GENL_ATTR_MAX,
  98 };
  99 #define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)
 100
 101 /* commands supported by the thermal_genl_family */
 102 enum {
 103         THERMAL_GENL_CMD_UNSPEC,
 104         THERMAL_GENL_CMD_EVENT,
 105         __THERMAL_GENL_CMD_MAX,
 106 };
 107 #define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)
 108
 109 struct thermal_zone_device_ops {
 110         int (*bind) (struct thermal_zone_device *,
 111                      struct thermal_cooling_device *);
 112         int (*unbind) (struct thermal_zone_device *,
 113                        struct thermal_cooling_device *);
 114         int (*get_temp) (struct thermal_zone_device *, unsigned long *);
 115         int (*get_mode) (struct thermal_zone_device *,
 116                          enum thermal_device_mode *);
 117         int (*set_mode) (struct thermal_zone_device *,
 118                 enum thermal_device_mode);
 119         int (*get_trip_type) (struct thermal_zone_device *, int,
 120                 enum thermal_trip_type *);
 121         int (*get_trip_temp) (struct thermal_zone_device *, int,
 122                               unsigned long *);
 123         int (*set_trip_temp) (struct thermal_zone_device *, int,
 124                               unsigned long);
 125         int (*get_trip_hyst) (struct thermal_zone_device *, int,
 126                               unsigned long *);
 127         int (*set_trip_hyst) (struct thermal_zone_device *, int,
 128                               unsigned long);
 129         int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
 130         int (*set_emul_temp) (struct thermal_zone_device *, unsigned long);
 131         int (*get_trend) (struct thermal_zone_device *, int,
 132                           enum thermal_trend *);
 133         int (*notify) (struct thermal_zone_device *, int,
 134                        enum thermal_trip_type);
 135 };
 136
 137 struct thermal_cooling_device_ops {
 138         int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
 139         int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
 140         int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
 141 };
 142
 143 struct thermal_cooling_device {
 144         int id;
 145         char type[THERMAL_NAME_LENGTH];
 146         struct device device;
 147         struct device_node *np;
 148         void *devdata;
 149         const struct thermal_cooling_device_ops *ops;
 150         bool updated; /* true if the cooling device does not need update */
 151         struct mutex lock; /* protect thermal_instances list */
 152         struct list_head thermal_instances;
 153         struct list_head node;
 154 };
 155
 156 struct thermal_attr {
 157         struct device_attribute attr;
 158         char name[THERMAL_NAME_LENGTH];
 159 };
 160
 161 struct thermal_zone_device {
 162         int id;
 163         char type[THERMAL_NAME_LENGTH];
 164         struct device device;
 165         struct thermal_attr *trip_temp_attrs;
 166         struct thermal_attr *trip_type_attrs;
 167         struct thermal_attr *trip_hyst_attrs;
 168         void *devdata;
 169         int trips;
 170         int passive_delay;
 171         int polling_delay;
 172         int temperature;
 173         int last_temperature;
 174         int emul_temperature;
 175         int passive;
 176         unsigned int forced_passive;
 177         struct thermal_zone_device_ops *ops;
 178         const struct thermal_zone_params *tzp;
 179         struct thermal_governor *governor;
 180         struct list_head thermal_instances;
 181         struct idr idr;
 182         struct mutex lock; /* protect thermal_instances list */
 183         struct list_head node;
 184         struct delayed_work poll_queue;
 185 };
 186
 187 /* Structure that holds thermal governor information */
 188 struct thermal_governor {
 189         char name[THERMAL_NAME_LENGTH];
 190         int (*throttle)(struct thermal_zone_device *tz, int trip);
 191         struct list_head        governor_list;
 192 };
 193
 194 /* Structure that holds binding parameters for a zone */
 195 struct thermal_bind_params {
 196         struct thermal_cooling_device *cdev;
 197
 198         /*
 199          * This is a measure of 'how effectively these devices can
 200          * cool 'this' thermal zone. The shall be determined by platform
 201          * characterization. This is on a 'percentage' scale.
 202          * See Documentation/thermal/sysfs-api.txt for more information.
 203          */
 204         int weight;
 205
 206         /*
 207          * This is a bit mask that gives the binding relation between this
 208          * thermal zone and cdev, for a particular trip point.
 209          * See Documentation/thermal/sysfs-api.txt for more information.
 210          */
 211         int trip_mask;
 212
 213         /*
 214          * This is an array of cooling state limits. Must have exactly
 215          * 2 * thermal_zone.number_of_trip_points. It is an array consisting
 216          * of tuples <lower-state upper-state> of state limits. Each trip
 217          * will be associated with one state limit tuple when binding.
 218          * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
 219          * on all trips.
 220          */
 221         unsigned long *binding_limits;
 222         int (*match) (struct thermal_zone_device *tz,
 223                         struct thermal_cooling_device *cdev);
 224 };
 225
 226 /* Structure to define Thermal Zone parameters */
 227 struct thermal_zone_params {
 228         char governor_name[THERMAL_NAME_LENGTH];
 229
 230         /*
 231          * a boolean to indicate if the thermal to hwmon sysfs interface
 232          * is required. when no_hwmon == false, a hwmon sysfs interface
 233          * will be created. when no_hwmon == true, nothing will be done
 234          */
 235         bool no_hwmon;
 236
 237         int num_tbps;   /* Number of tbp entries */
 238         struct thermal_bind_params *tbp;
 239 };
 240
 241 struct thermal_genl_event {
 242         u32 orig;
 243         enum events event;
 244 };
 245
 246 /* Function declarations */
 247 #ifdef CONFIG_THERMAL_OF
 248 struct thermal_zone_device *
 249 thermal_zone_of_sensor_register(struct device *dev, int id,
 250                                 void *data, int (*get_temp)(void *, long *),
 251                                 int (*get_trend)(void *, long *));
 252 void thermal_zone_of_sensor_unregister(struct device *dev,
 253                                        struct thermal_zone_device *tz);
 254 #else
 255 static inline struct thermal_zone_device *
 256 thermal_zone_of_sensor_register(struct device *dev, int id,
 257                                 void *data, int (*get_temp)(void *, long *),
 258                                 int (*get_trend)(void *, long *))
 259 {
 260         return NULL;
 261 }
 262
 263 static inline
 264 void thermal_zone_of_sensor_unregister(struct device *dev,
 265                                        struct thermal_zone_device *tz)
 266 {
 267 }
 268
 269 #endif
 270 struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
 271                 void *, struct thermal_zone_device_ops *,
 272                 const struct thermal_zone_params *, int, int);
 273 void thermal_zone_device_unregister(struct thermal_zone_device *);
 274
 275 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
 276                                      struct thermal_cooling_device *,
 277                                      unsigned long, unsigned long);
 278 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
 279                                        struct thermal_cooling_device *);
 280 void thermal_zone_device_update(struct thermal_zone_device *);
 281
 282 struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
 283                 const struct thermal_cooling_device_ops *);
 284 struct thermal_cooling_device *
 285 thermal_of_cooling_device_register(struct device_node *np, char *, void *,
 286                                    const struct thermal_cooling_device_ops *);
 287 void thermal_cooling_device_unregister(struct thermal_cooling_device *);
 288 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
 289 int thermal_zone_get_temp(struct thermal_zone_device *tz, unsigned long *temp);
 290
 291 int get_tz_trend(struct thermal_zone_device *, int);
 292 struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
 293                 struct thermal_cooling_device *, int);
 294 void thermal_cdev_update(struct thermal_cooling_device *);
 295 void thermal_notify_framework(struct thermal_zone_device *, int);
 296
 297 #ifdef CONFIG_NET
 298 extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
 299                                                 enum events event);
 300 #else
 301 static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
 302                                                 enum events event)
 303 {
 304         return 0;
 305 }
 306 #endif
 307
 308 #endif /* __THERMAL_H__ */