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/idr.h>
  29 #include <linux/device.h>
  30 #include <linux/workqueue.h>
  31
  32 #define THERMAL_TRIPS_NONE      -1
  33 #define THERMAL_MAX_TRIPS       12
  34 #define THERMAL_NAME_LENGTH     20
  35
  36 /* invalid cooling state */
  37 #define THERMAL_CSTATE_INVALID -1UL
  38
  39 /* No upper/lower limit requirement */
  40 #define THERMAL_NO_LIMIT        THERMAL_CSTATE_INVALID
  41
  42 /* Unit conversion macros */
  43 #define KELVIN_TO_CELSIUS(t)    (long)(((long)t-2732 >= 0) ?    \
  44                                 ((long)t-2732+5)/10 : ((long)t-2732-5)/10)
  45 #define CELSIUS_TO_KELVIN(t)    ((t)*10+2732)
  46
  47 /* Adding event notification support elements */
  48 #define THERMAL_GENL_FAMILY_NAME                "thermal_event"
  49 #define THERMAL_GENL_VERSION                    0x01
  50 #define THERMAL_GENL_MCAST_GROUP_NAME           "thermal_mc_grp"
  51
  52 /* Default Thermal Governor */
  53 #if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
  54 #define DEFAULT_THERMAL_GOVERNOR       "step_wise"
  55 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
  56 #define DEFAULT_THERMAL_GOVERNOR       "fair_share"
  57 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
  58 #define DEFAULT_THERMAL_GOVERNOR       "user_space"
  59 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_BACKWARD_COMPATIBLE)
  60 #define DEFAULT_THERMAL_GOVERNOR       "backward_compatible"
  61 #endif
  62
  63 struct thermal_zone_device;
  64 struct thermal_cooling_device;
  65
  66 enum thermal_device_mode {
  67         THERMAL_DEVICE_DISABLED = 0,
  68         THERMAL_DEVICE_ENABLED,
  69 };
  70
  71 enum thermal_trip_type {
  72         THERMAL_TRIP_ACTIVE = 0,
  73         THERMAL_TRIP_PASSIVE,
  74         THERMAL_TRIP_HOT,
  75         THERMAL_TRIP_CRITICAL,
  76 };
  77
  78 enum thermal_trend {
  79         THERMAL_TREND_STABLE, /* temperature is stable */
  80         THERMAL_TREND_RAISING, /* temperature is raising */
  81         THERMAL_TREND_DROPPING, /* temperature is dropping */
  82         THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
  83         THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
  84 };
  85
  86 /* Events supported by Thermal Netlink */
  87 enum events {
  88         THERMAL_AUX0,
  89         THERMAL_AUX1,
  90         THERMAL_CRITICAL,
  91         THERMAL_DEV_FAULT,
  92 };
  93
  94 /* attributes of thermal_genl_family */
  95 enum {
  96         THERMAL_GENL_ATTR_UNSPEC,
  97         THERMAL_GENL_ATTR_EVENT,
  98         __THERMAL_GENL_ATTR_MAX,
  99 };
 100 #define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)
 101
 102 /* commands supported by the thermal_genl_family */
 103 enum {
 104         THERMAL_GENL_CMD_UNSPEC,
 105         THERMAL_GENL_CMD_EVENT,
 106         __THERMAL_GENL_CMD_MAX,
 107 };
 108 #define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)
 109
 110 struct thermal_zone_device_ops {
 111         int (*bind) (struct thermal_zone_device *,
 112                      struct thermal_cooling_device *);
 113         int (*unbind) (struct thermal_zone_device *,
 114                        struct thermal_cooling_device *);
 115         int (*get_temp) (struct thermal_zone_device *, unsigned long *);
 116         int (*get_mode) (struct thermal_zone_device *,
 117                          enum thermal_device_mode *);
 118         int (*set_mode) (struct thermal_zone_device *,
 119                 enum thermal_device_mode);
 120         int (*get_trip_type) (struct thermal_zone_device *, int,
 121                 enum thermal_trip_type *);
 122         int (*get_trip_temp) (struct thermal_zone_device *, int,
 123                               unsigned long *);
 124         int (*set_trip_temp) (struct thermal_zone_device *, int,
 125                               unsigned long);
 126         int (*get_trip_hyst) (struct thermal_zone_device *, int,
 127                               unsigned long *);
 128         int (*set_trip_hyst) (struct thermal_zone_device *, int,
 129                               unsigned long);
 130         int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
 131         int (*set_emul_temp) (struct thermal_zone_device *, unsigned long);
 132         int (*get_trend) (struct thermal_zone_device *, int,
 133                           enum thermal_trend *);
 134         int (*notify) (struct thermal_zone_device *, int,
 135                        enum thermal_trip_type);
 136 };
 137
 138 struct thermal_cooling_device_ops {
 139         int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
 140         int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
 141         int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
 142 };
 143
 144 struct thermal_cooling_device {
 145         int id;
 146         char type[THERMAL_NAME_LENGTH];
 147         struct device device;
 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         const 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         int (*match) (struct thermal_zone_device *tz,
 213                         struct thermal_cooling_device *cdev);
 214 };
 215
 216 /* Structure to define Thermal Zone parameters */
 217 struct thermal_zone_params {
 218         char governor_name[THERMAL_NAME_LENGTH];
 219         int num_tbps;   /* Number of tbp entries */
 220         struct thermal_bind_params *tbp;
 221 };
 222
 223 struct thermal_genl_event {
 224         u32 orig;
 225         enum events event;
 226 };
 227
 228 /* Function declarations */
 229 struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
 230                 void *, const struct thermal_zone_device_ops *,
 231                 const struct thermal_zone_params *, int, int);
 232 void thermal_zone_device_unregister(struct thermal_zone_device *);
 233
 234 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
 235                                      struct thermal_cooling_device *,
 236                                      unsigned long, unsigned long);
 237 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
 238                                        struct thermal_cooling_device *);
 239 void thermal_zone_device_update(struct thermal_zone_device *);
 240
 241 struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
 242                 const struct thermal_cooling_device_ops *);
 243 void thermal_cooling_device_unregister(struct thermal_cooling_device *);
 244 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
 245 int thermal_zone_get_temp(struct thermal_zone_device *tz, unsigned long *temp);
 246
 247 int get_tz_trend(struct thermal_zone_device *, int);
 248 struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
 249                 struct thermal_cooling_device *, int);
 250 void thermal_cdev_update(struct thermal_cooling_device *);
 251 void thermal_notify_framework(struct thermal_zone_device *, int);
 252
 253 #ifdef CONFIG_NET
 254 extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
 255                                                 enum events event);
 256 #else
 257 static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
 258                                                 enum events event)
 259 {
 260         return 0;
 261 }
 262 #endif
 263
 264 #endif /* __THERMAL_H__ */