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 struct thermal_zone_device;
  33 struct thermal_cooling_device;
  34
  35 enum thermal_device_mode {
  36         THERMAL_DEVICE_DISABLED = 0,
  37         THERMAL_DEVICE_ENABLED,
  38 };
  39
  40 enum thermal_trip_type {
  41         THERMAL_TRIP_ACTIVE = 0,
  42         THERMAL_TRIP_PASSIVE,
  43         THERMAL_TRIP_HOT,
  44         THERMAL_TRIP_CRITICAL,
  45 };
  46
  47 enum thermal_trend {
  48         THERMAL_TREND_STABLE, /* temperature is stable */
  49         THERMAL_TREND_RAISING, /* temperature is raising */
  50         THERMAL_TREND_DROPPING, /* temperature is dropping */
  51 };
  52
  53 struct thermal_zone_device_ops {
  54         int (*bind) (struct thermal_zone_device *,
  55                      struct thermal_cooling_device *);
  56         int (*unbind) (struct thermal_zone_device *,
  57                        struct thermal_cooling_device *);
  58         int (*get_temp) (struct thermal_zone_device *, unsigned long *);
  59         int (*get_mode) (struct thermal_zone_device *,
  60                          enum thermal_device_mode *);
  61         int (*set_mode) (struct thermal_zone_device *,
  62                 enum thermal_device_mode);
  63         int (*get_trip_type) (struct thermal_zone_device *, int,
  64                 enum thermal_trip_type *);
  65         int (*get_trip_temp) (struct thermal_zone_device *, int,
  66                               unsigned long *);
  67         int (*set_trip_temp) (struct thermal_zone_device *, int,
  68                               unsigned long);
  69         int (*get_trip_hyst) (struct thermal_zone_device *, int,
  70                               unsigned long *);
  71         int (*set_trip_hyst) (struct thermal_zone_device *, int,
  72                               unsigned long);
  73         int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
  74         int (*get_trend) (struct thermal_zone_device *, int,
  75                           enum thermal_trend *);
  76         int (*notify) (struct thermal_zone_device *, int,
  77                        enum thermal_trip_type);
  78 };
  79
  80 struct thermal_cooling_device_ops {
  81         int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
  82         int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
  83         int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
  84 };
  85
  86 #define THERMAL_NO_LIMIT -1UL /* no upper/lower limit requirement */
  87
  88 #define THERMAL_TRIPS_NONE -1
  89 #define THERMAL_MAX_TRIPS 12
  90 #define THERMAL_NAME_LENGTH 20
  91 struct thermal_cooling_device {
  92         int id;
  93         char type[THERMAL_NAME_LENGTH];
  94         struct device device;
  95         void *devdata;
  96         const struct thermal_cooling_device_ops *ops;
  97         struct list_head node;
  98 };
  99
 100 #define KELVIN_TO_CELSIUS(t)    (long)(((long)t-2732 >= 0) ?    \
 101                                 ((long)t-2732+5)/10 : ((long)t-2732-5)/10)
 102 #define CELSIUS_TO_KELVIN(t)    ((t)*10+2732)
 103
 104 struct thermal_attr {
 105         struct device_attribute attr;
 106         char name[THERMAL_NAME_LENGTH];
 107 };
 108
 109 struct thermal_zone_device {
 110         int id;
 111         char type[THERMAL_NAME_LENGTH];
 112         struct device device;
 113         struct thermal_attr *trip_temp_attrs;
 114         struct thermal_attr *trip_type_attrs;
 115         struct thermal_attr *trip_hyst_attrs;
 116         void *devdata;
 117         int trips;
 118         int passive_delay;
 119         int polling_delay;
 120         int temperature;
 121         int last_temperature;
 122         bool passive;
 123         unsigned int forced_passive;
 124         const struct thermal_zone_device_ops *ops;
 125         struct list_head thermal_instances;
 126         struct idr idr;
 127         struct mutex lock; /* protect thermal_instances list */
 128         struct list_head node;
 129         struct delayed_work poll_queue;
 130 };
 131 /* Adding event notification support elements */
 132 #define THERMAL_GENL_FAMILY_NAME                "thermal_event"
 133 #define THERMAL_GENL_VERSION                    0x01
 134 #define THERMAL_GENL_MCAST_GROUP_NAME           "thermal_mc_group"
 135
 136 enum events {
 137         THERMAL_AUX0,
 138         THERMAL_AUX1,
 139         THERMAL_CRITICAL,
 140         THERMAL_DEV_FAULT,
 141 };
 142
 143 struct thermal_genl_event {
 144         u32 orig;
 145         enum events event;
 146 };
 147 /* attributes of thermal_genl_family */
 148 enum {
 149         THERMAL_GENL_ATTR_UNSPEC,
 150         THERMAL_GENL_ATTR_EVENT,
 151         __THERMAL_GENL_ATTR_MAX,
 152 };
 153 #define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)
 154
 155 /* commands supported by the thermal_genl_family */
 156 enum {
 157         THERMAL_GENL_CMD_UNSPEC,
 158         THERMAL_GENL_CMD_EVENT,
 159         __THERMAL_GENL_CMD_MAX,
 160 };
 161 #define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)
 162
 163 struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
 164                 void *, const struct thermal_zone_device_ops *, int, int);
 165 void thermal_zone_device_unregister(struct thermal_zone_device *);
 166
 167 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
 168                                      struct thermal_cooling_device *,
 169                                      unsigned long, unsigned long);
 170 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
 171                                        struct thermal_cooling_device *);
 172 void thermal_zone_device_update(struct thermal_zone_device *);
 173 struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
 174                 const struct thermal_cooling_device_ops *);
 175 void thermal_cooling_device_unregister(struct thermal_cooling_device *);
 176
 177 #ifdef CONFIG_NET
 178 extern int thermal_generate_netlink_event(u32 orig, enum events event);
 179 #else
 180 static inline int thermal_generate_netlink_event(u32 orig, enum events event)
 181 {
 182         return 0;
 183 }
 184 #endif
 185
 186 #endif /* __THERMAL_H__ */