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