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 /* No upper/lower limit requirement */
  37 #define THERMAL_NO_LIMIT        -1UL
  38
  39 /* Unit conversion macros */
  40 #define KELVIN_TO_CELSIUS(t)    (long)(((long)t-2732 >= 0) ?    \
  41                                 ((long)t-2732+5)/10 : ((long)t-2732-5)/10)
  42 #define CELSIUS_TO_KELVIN(t)    ((t)*10+2732)
  43
  44 /* Adding event notification support elements */
  45 #define THERMAL_GENL_FAMILY_NAME                "thermal_event"
  46 #define THERMAL_GENL_VERSION                    0x01
  47 #define THERMAL_GENL_MCAST_GROUP_NAME           "thermal_mc_group"
  48
  49 /* Default Thermal Governor */
  50 #if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
  51 #define DEFAULT_THERMAL_GOVERNOR       "step_wise"
  52 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
  53 #define DEFAULT_THERMAL_GOVERNOR       "fair_share"
  54 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
  55 #define DEFAULT_THERMAL_GOVERNOR       "user_space"
  56 #endif
  57
  58 struct thermal_zone_device;
  59 struct thermal_cooling_device;
  60
  61 enum thermal_device_mode {
  62         THERMAL_DEVICE_DISABLED = 0,
  63         THERMAL_DEVICE_ENABLED,
  64 };
  65
  66 enum thermal_trip_type {
  67         THERMAL_TRIP_ACTIVE = 0,
  68         THERMAL_TRIP_PASSIVE,
  69         THERMAL_TRIP_HOT,
  70         THERMAL_TRIP_CRITICAL,
  71 };
  72
  73 enum thermal_trend {
  74         THERMAL_TREND_STABLE, /* temperature is stable */
  75         THERMAL_TREND_RAISING, /* temperature is raising */
  76         THERMAL_TREND_DROPPING, /* temperature is dropping */
  77         THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
  78         THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
  79 };
  80
  81 /* Events supported by Thermal Netlink */
  82 enum events {
  83         THERMAL_AUX0,
  84         THERMAL_AUX1,
  85         THERMAL_CRITICAL,
  86         THERMAL_DEV_FAULT,
  87 };
  88
  89 /* attributes of thermal_genl_family */
  90 enum {
  91         THERMAL_GENL_ATTR_UNSPEC,
  92         THERMAL_GENL_ATTR_EVENT,
  93         __THERMAL_GENL_ATTR_MAX,
  94 };
  95 #define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)
  96
  97 /* commands supported by the thermal_genl_family */
  98 enum {
  99         THERMAL_GENL_CMD_UNSPEC,
 100         THERMAL_GENL_CMD_EVENT,
 101         __THERMAL_GENL_CMD_MAX,
 102 };
 103 #define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)
 104
 105 struct thermal_zone_device_ops {
 106         int (*bind) (struct thermal_zone_device *,
 107                      struct thermal_cooling_device *);
 108         int (*unbind) (struct thermal_zone_device *,
 109                        struct thermal_cooling_device *);
 110         int (*get_temp) (struct thermal_zone_device *, unsigned long *);
 111         int (*get_mode) (struct thermal_zone_device *,
 112                          enum thermal_device_mode *);
 113         int (*set_mode) (struct thermal_zone_device *,
 114                 enum thermal_device_mode);
 115         int (*get_trip_type) (struct thermal_zone_device *, int,
 116                 enum thermal_trip_type *);
 117         int (*get_trip_temp) (struct thermal_zone_device *, int,
 118                               unsigned long *);
 119         int (*set_trip_temp) (struct thermal_zone_device *, int,
 120                               unsigned long);
 121         int (*get_trip_hyst) (struct thermal_zone_device *, int,
 122                               unsigned long *);
 123         int (*set_trip_hyst) (struct thermal_zone_device *, int,
 124                               unsigned long);
 125         int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
 126         int (*get_trend) (struct thermal_zone_device *, int,
 127                           enum thermal_trend *);
 128         int (*notify) (struct thermal_zone_device *, int,
 129                        enum thermal_trip_type);
 130 };
 131
 132 struct thermal_cooling_device_ops {
 133         int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
 134         int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
 135         int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
 136 };
 137
 138 struct thermal_cooling_device {
 139         int id;
 140         char type[THERMAL_NAME_LENGTH];
 141         struct device device;
 142         void *devdata;
 143         const struct thermal_cooling_device_ops *ops;
 144         bool updated; /* true if the cooling device does not need update */
 145         struct mutex lock; /* protect thermal_instances list */
 146         struct list_head thermal_instances;
 147         struct list_head node;
 148 };
 149
 150 struct thermal_attr {
 151         struct device_attribute attr;
 152         char name[THERMAL_NAME_LENGTH];
 153 };
 154
 155 struct thermal_zone_device {
 156         int id;
 157         char type[THERMAL_NAME_LENGTH];
 158         struct device device;
 159         struct thermal_attr *trip_temp_attrs;
 160         struct thermal_attr *trip_type_attrs;
 161         struct thermal_attr *trip_hyst_attrs;
 162         void *devdata;
 163         int trips;
 164         int passive_delay;
 165         int polling_delay;
 166         int temperature;
 167         int last_temperature;
 168         int passive;
 169         unsigned int forced_passive;
 170         const struct thermal_zone_device_ops *ops;
 171         const struct thermal_zone_params *tzp;
 172         struct thermal_governor *governor;
 173         struct list_head thermal_instances;
 174         struct idr idr;
 175         struct mutex lock; /* protect thermal_instances list */
 176         struct list_head node;
 177         struct delayed_work poll_queue;
 178 };
 179
 180 /* Structure that holds thermal governor information */
 181 struct thermal_governor {
 182         char name[THERMAL_NAME_LENGTH];
 183         int (*throttle)(struct thermal_zone_device *tz, int trip);
 184         struct list_head        governor_list;
 185         struct module           *owner;
 186 };
 187
 188 /* Structure that holds binding parameters for a zone */
 189 struct thermal_bind_params {
 190         struct thermal_cooling_device *cdev;
 191
 192         /*
 193          * This is a measure of 'how effectively these devices can
 194          * cool 'this' thermal zone. The shall be determined by platform
 195          * characterization. This is on a 'percentage' scale.
 196          * See Documentation/thermal/sysfs-api.txt for more information.
 197          */
 198         int weight;
 199
 200         /*
 201          * This is a bit mask that gives the binding relation between this
 202          * thermal zone and cdev, for a particular trip point.
 203          * See Documentation/thermal/sysfs-api.txt for more information.
 204          */
 205         int trip_mask;
 206         int (*match) (struct thermal_zone_device *tz,
 207                         struct thermal_cooling_device *cdev);
 208 };
 209
 210 /* Structure to define Thermal Zone parameters */
 211 struct thermal_zone_params {
 212         char governor_name[THERMAL_NAME_LENGTH];
 213         int num_tbps;   /* Number of tbp entries */
 214         struct thermal_bind_params *tbp;
 215 };
 216
 217 struct thermal_genl_event {
 218         u32 orig;
 219         enum events event;
 220 };
 221
 222 /* Function declarations */
 223 struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
 224                 void *, const struct thermal_zone_device_ops *,
 225                 const struct thermal_zone_params *, int, int);
 226 void thermal_zone_device_unregister(struct thermal_zone_device *);
 227
 228 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
 229                                      struct thermal_cooling_device *,
 230                                      unsigned long, unsigned long);
 231 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
 232                                        struct thermal_cooling_device *);
 233 void thermal_zone_device_update(struct thermal_zone_device *);
 234
 235 struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
 236                 const struct thermal_cooling_device_ops *);
 237 void thermal_cooling_device_unregister(struct thermal_cooling_device *);
 238
 239 int get_tz_trend(struct thermal_zone_device *, int);
 240 struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
 241                 struct thermal_cooling_device *, int);
 242 void thermal_cdev_update(struct thermal_cooling_device *);
 243 void notify_thermal_framework(struct thermal_zone_device *, int);
 244
 245 int thermal_register_governor(struct thermal_governor *);
 246 void thermal_unregister_governor(struct thermal_governor *);
 247
 248 #ifdef CONFIG_NET
 249 extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
 250                                                 enum events event);
 251 #else
 252 static int thermal_generate_netlink_event(struct thermal_zone_device *tz,
 253                                                 enum events event)
 254 {
 255         return 0;
 256 }
 257 #endif
 258
 259 #endif /* __THERMAL_H__ */