2 * thermal.h ($Revision: 0 $)
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>
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.
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.
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.
22 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29 #include <linux/idr.h>
30 #include <linux/device.h>
31 #include <linux/workqueue.h>
33 #define THERMAL_TRIPS_NONE -1
34 #define THERMAL_MAX_TRIPS 12
35 #define THERMAL_NAME_LENGTH 20
37 /* invalid cooling state */
38 #define THERMAL_CSTATE_INVALID -1UL
40 /* No upper/lower limit requirement */
41 #define THERMAL_NO_LIMIT THERMAL_CSTATE_INVALID
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)
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"
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"
62 struct thermal_zone_device;
63 struct thermal_cooling_device;
65 enum thermal_device_mode {
66 THERMAL_DEVICE_DISABLED = 0,
67 THERMAL_DEVICE_ENABLED,
70 enum thermal_trip_type {
71 THERMAL_TRIP_ACTIVE = 0,
74 THERMAL_TRIP_CRITICAL,
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 */
85 /* Events supported by Thermal Netlink */
93 /* attributes of thermal_genl_family */
95 THERMAL_GENL_ATTR_UNSPEC,
96 THERMAL_GENL_ATTR_EVENT,
97 __THERMAL_GENL_ATTR_MAX,
99 #define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)
101 /* commands supported by the thermal_genl_family */
103 THERMAL_GENL_CMD_UNSPEC,
104 THERMAL_GENL_CMD_EVENT,
105 __THERMAL_GENL_CMD_MAX,
107 #define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)
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,
123 int (*set_trip_temp) (struct thermal_zone_device *, int,
125 int (*get_trip_hyst) (struct thermal_zone_device *, int,
127 int (*set_trip_hyst) (struct thermal_zone_device *, int,
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);
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);
143 struct thermal_cooling_device {
145 char type[THERMAL_NAME_LENGTH];
146 struct device device;
147 struct device_node *np;
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;
156 struct thermal_attr {
157 struct device_attribute attr;
158 char name[THERMAL_NAME_LENGTH];
161 struct thermal_zone_device {
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;
173 int last_temperature;
174 int emul_temperature;
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;
182 struct mutex lock; /* protect thermal_instances list */
183 struct list_head node;
184 struct delayed_work poll_queue;
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;
194 /* Structure that holds binding parameters for a zone */
195 struct thermal_bind_params {
196 struct thermal_cooling_device *cdev;
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.
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.
212 int (*match) (struct thermal_zone_device *tz,
213 struct thermal_cooling_device *cdev);
216 /* Structure to define Thermal Zone parameters */
217 struct thermal_zone_params {
218 char governor_name[THERMAL_NAME_LENGTH];
221 * a boolean to indicate if the thermal to hwmon sysfs interface
222 * is required. when no_hwmon == false, a hwmon sysfs interface
223 * will be created. when no_hwmon == true, nothing will be done
227 int num_tbps; /* Number of tbp entries */
228 struct thermal_bind_params *tbp;
231 struct thermal_genl_event {
236 /* Function declarations */
237 #ifdef CONFIG_THERMAL_OF
238 struct thermal_zone_device *
239 thermal_zone_of_sensor_register(struct device *dev, int id,
240 void *data, int (*get_temp)(void *, long *),
241 int (*get_trend)(void *, long *));
242 void thermal_zone_of_sensor_unregister(struct device *dev,
243 struct thermal_zone_device *tz);
245 static inline struct thermal_zone_device *
246 thermal_zone_of_sensor_register(struct device *dev, int id,
247 void *data, int (*get_temp)(void *, long *),
248 int (*get_trend)(void *, long *))
254 void thermal_zone_of_sensor_unregister(struct device *dev,
255 struct thermal_zone_device *tz)
260 struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
261 void *, struct thermal_zone_device_ops *,
262 const struct thermal_zone_params *, int, int);
263 void thermal_zone_device_unregister(struct thermal_zone_device *);
265 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
266 struct thermal_cooling_device *,
267 unsigned long, unsigned long);
268 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
269 struct thermal_cooling_device *);
270 void thermal_zone_device_update(struct thermal_zone_device *);
272 struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
273 const struct thermal_cooling_device_ops *);
274 struct thermal_cooling_device *
275 thermal_of_cooling_device_register(struct device_node *np, char *, void *,
276 const struct thermal_cooling_device_ops *);
277 void thermal_cooling_device_unregister(struct thermal_cooling_device *);
278 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
279 int thermal_zone_get_temp(struct thermal_zone_device *tz, unsigned long *temp);
281 int get_tz_trend(struct thermal_zone_device *, int);
282 struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
283 struct thermal_cooling_device *, int);
284 void thermal_cdev_update(struct thermal_cooling_device *);
285 void thermal_notify_framework(struct thermal_zone_device *, int);
288 extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
291 static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
298 #endif /* __THERMAL_H__ */