blob: fc52e307efab8768effbb7880702986653e0a07c [file] [log] [blame]
Zhang Rui203d3d42008-01-17 15:51:08 +08001/*
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
Eduardo Valentina116b5d2013-09-26 15:55:01 -040028#include <linux/of.h>
Zhang Rui203d3d42008-01-17 15:51:08 +080029#include <linux/idr.h>
30#include <linux/device.h>
Matthew Garrettb1569e92008-12-03 17:55:32 +000031#include <linux/workqueue.h>
Florian Fainelliaf6c9f12014-11-19 18:11:00 -080032#include <uapi/linux/thermal.h>
Zhang Rui203d3d42008-01-17 15:51:08 +080033
Durgadoss R23064082012-09-18 11:04:52 +053034#define THERMAL_TRIPS_NONE -1
35#define THERMAL_MAX_TRIPS 12
Durgadoss R23064082012-09-18 11:04:52 +053036
Zhang Rui57df8102013-02-08 14:52:06 +080037/* invalid cooling state */
38#define THERMAL_CSTATE_INVALID -1UL
39
Durgadoss R23064082012-09-18 11:04:52 +053040/* No upper/lower limit requirement */
Punit Agrawala940cb32014-12-09 12:22:01 +000041#define THERMAL_NO_LIMIT ((u32)~0)
Durgadoss R23064082012-09-18 11:04:52 +053042
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)
Aaron Lu7b83fd92014-03-25 10:40:09 +080047#define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100)
48#define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 2732)
Aaron Lu77e337c2014-09-03 15:13:02 +080049#define MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, off) (((t) / 100) + (off))
50#define MILLICELSIUS_TO_DECI_KELVIN(t) MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, 2732)
Durgadoss R23064082012-09-18 11:04:52 +053051
Zhang Rui1f53ef12012-12-12 15:31:37 +080052/* 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#endif
Durgadoss Ra4a15482012-09-18 11:04:57 +053060
Zhang Rui203d3d42008-01-17 15:51:08 +080061struct thermal_zone_device;
62struct thermal_cooling_device;
63
Matthew Garrett6503e5d2008-11-27 17:48:13 +000064enum thermal_device_mode {
65 THERMAL_DEVICE_DISABLED = 0,
66 THERMAL_DEVICE_ENABLED,
67};
68
69enum thermal_trip_type {
70 THERMAL_TRIP_ACTIVE = 0,
71 THERMAL_TRIP_PASSIVE,
72 THERMAL_TRIP_HOT,
73 THERMAL_TRIP_CRITICAL,
74};
75
Zhang Rui601f3d42012-06-27 09:54:33 +080076enum thermal_trend {
77 THERMAL_TREND_STABLE, /* temperature is stable */
78 THERMAL_TREND_RAISING, /* temperature is raising */
79 THERMAL_TREND_DROPPING, /* temperature is dropping */
Zhang Ruid069015e2012-11-19 15:33:51 +080080 THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
81 THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
Zhang Rui601f3d42012-06-27 09:54:33 +080082};
83
Zhang Rui203d3d42008-01-17 15:51:08 +080084struct thermal_zone_device_ops {
85 int (*bind) (struct thermal_zone_device *,
86 struct thermal_cooling_device *);
87 int (*unbind) (struct thermal_zone_device *,
88 struct thermal_cooling_device *);
Matthew Garrett6503e5d2008-11-27 17:48:13 +000089 int (*get_temp) (struct thermal_zone_device *, unsigned long *);
90 int (*get_mode) (struct thermal_zone_device *,
91 enum thermal_device_mode *);
92 int (*set_mode) (struct thermal_zone_device *,
93 enum thermal_device_mode);
94 int (*get_trip_type) (struct thermal_zone_device *, int,
95 enum thermal_trip_type *);
96 int (*get_trip_temp) (struct thermal_zone_device *, int,
97 unsigned long *);
Durgadoss Rc56f5c02012-07-25 10:10:58 +080098 int (*set_trip_temp) (struct thermal_zone_device *, int,
99 unsigned long);
Durgadoss R27365a62012-07-25 10:10:59 +0800100 int (*get_trip_hyst) (struct thermal_zone_device *, int,
101 unsigned long *);
102 int (*set_trip_hyst) (struct thermal_zone_device *, int,
103 unsigned long);
Zhang, Rui9ec732f2008-04-10 16:13:10 +0800104 int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
Amit Daniel Kachhape6e238c2013-02-04 00:30:15 +0000105 int (*set_emul_temp) (struct thermal_zone_device *, unsigned long);
Zhang Rui601f3d42012-06-27 09:54:33 +0800106 int (*get_trend) (struct thermal_zone_device *, int,
107 enum thermal_trend *);
Matthew Garrettb1569e92008-12-03 17:55:32 +0000108 int (*notify) (struct thermal_zone_device *, int,
109 enum thermal_trip_type);
Zhang Rui203d3d42008-01-17 15:51:08 +0800110};
111
112struct thermal_cooling_device_ops {
Matthew Garrett6503e5d2008-11-27 17:48:13 +0000113 int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
114 int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
115 int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
Zhang Rui203d3d42008-01-17 15:51:08 +0800116};
117
Zhang Rui203d3d42008-01-17 15:51:08 +0800118struct thermal_cooling_device {
119 int id;
120 char type[THERMAL_NAME_LENGTH];
121 struct device device;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400122 struct device_node *np;
Zhang Rui203d3d42008-01-17 15:51:08 +0800123 void *devdata;
Alan Cox5b275ce2010-11-11 15:27:29 +0000124 const struct thermal_cooling_device_ops *ops;
Zhang Ruice119f82012-06-27 14:13:04 +0800125 bool updated; /* true if the cooling device does not need update */
Zhang Ruif4a821c2012-07-24 16:56:21 +0800126 struct mutex lock; /* protect thermal_instances list */
Zhang Ruib5e4ae62012-06-27 14:11:52 +0800127 struct list_head thermal_instances;
Zhang Rui203d3d42008-01-17 15:51:08 +0800128 struct list_head node;
129};
130
Durgadoss Rc56f5c02012-07-25 10:10:58 +0800131struct thermal_attr {
132 struct device_attribute attr;
133 char name[THERMAL_NAME_LENGTH];
134};
135
Javi Merinoc708a982014-06-25 11:00:12 +0100136/**
137 * struct thermal_zone_device - structure for a thermal zone
138 * @id: unique id number for each thermal zone
139 * @type: the thermal zone device type
140 * @device: &struct device for this thermal zone
141 * @trip_temp_attrs: attributes for trip points for sysfs: trip temperature
142 * @trip_type_attrs: attributes for trip points for sysfs: trip type
143 * @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis
144 * @devdata: private pointer for device private data
145 * @trips: number of trip points the thermal zone supports
146 * @passive_delay: number of milliseconds to wait between polls when
147 * performing passive cooling. Currenty only used by the
148 * step-wise governor
149 * @polling_delay: number of milliseconds to wait between polls when
150 * checking whether trip points have been crossed (0 for
151 * interrupt driven systems)
152 * @temperature: current temperature. This is only for core code,
153 * drivers should use thermal_zone_get_temp() to get the
154 * current temperature
155 * @last_temperature: previous temperature read
156 * @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION
157 * @passive: 1 if you've crossed a passive trip point, 0 otherwise.
158 * Currenty only used by the step-wise governor.
159 * @forced_passive: If > 0, temperature at which to switch on all ACPI
160 * processor cooling devices. Currently only used by the
161 * step-wise governor.
162 * @ops: operations this &thermal_zone_device supports
163 * @tzp: thermal zone parameters
164 * @governor: pointer to the governor for this thermal zone
165 * @thermal_instances: list of &struct thermal_instance of this thermal zone
166 * @idr: &struct idr to generate unique id for this zone's cooling
167 * devices
168 * @lock: lock to protect thermal_instances list
169 * @node: node in thermal_tz_list (in thermal_core.c)
170 * @poll_queue: delayed work for polling
171 */
Zhang Rui203d3d42008-01-17 15:51:08 +0800172struct thermal_zone_device {
173 int id;
174 char type[THERMAL_NAME_LENGTH];
175 struct device device;
Durgadoss Rc56f5c02012-07-25 10:10:58 +0800176 struct thermal_attr *trip_temp_attrs;
177 struct thermal_attr *trip_type_attrs;
Durgadoss R27365a62012-07-25 10:10:59 +0800178 struct thermal_attr *trip_hyst_attrs;
Zhang Rui203d3d42008-01-17 15:51:08 +0800179 void *devdata;
180 int trips;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000181 int passive_delay;
182 int polling_delay;
Zhang Rui601f3d42012-06-27 09:54:33 +0800183 int temperature;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000184 int last_temperature;
Amit Daniel Kachhape6e238c2013-02-04 00:30:15 +0000185 int emul_temperature;
Zhang Rui908b9fb2012-06-27 14:14:05 +0800186 int passive;
Matthew Garrett03a971a2008-12-03 18:00:38 +0000187 unsigned int forced_passive;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400188 struct thermal_zone_device_ops *ops;
Durgadoss Ref873942012-09-18 11:04:55 +0530189 const struct thermal_zone_params *tzp;
Durgadoss Ra4a15482012-09-18 11:04:57 +0530190 struct thermal_governor *governor;
Zhang Rui2d374132012-06-27 10:09:00 +0800191 struct list_head thermal_instances;
Zhang Rui203d3d42008-01-17 15:51:08 +0800192 struct idr idr;
Javi Merinoc708a982014-06-25 11:00:12 +0100193 struct mutex lock;
Zhang Rui203d3d42008-01-17 15:51:08 +0800194 struct list_head node;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000195 struct delayed_work poll_queue;
Zhang Rui203d3d42008-01-17 15:51:08 +0800196};
R.Durgadoss4cb18722010-10-27 03:33:29 +0530197
Javi Merinoc708a982014-06-25 11:00:12 +0100198/**
199 * struct thermal_governor - structure that holds thermal governor information
200 * @name: name of the governor
201 * @throttle: callback called for every trip point even if temperature is
202 * below the trip point temperature
203 * @governor_list: node in thermal_governor_list (in thermal_core.c)
204 */
Durgadoss Ra4a15482012-09-18 11:04:57 +0530205struct thermal_governor {
206 char name[THERMAL_NAME_LENGTH];
207 int (*throttle)(struct thermal_zone_device *tz, int trip);
208 struct list_head governor_list;
Durgadoss Ra4a15482012-09-18 11:04:57 +0530209};
210
Durgadoss Ref873942012-09-18 11:04:55 +0530211/* Structure that holds binding parameters for a zone */
212struct thermal_bind_params {
213 struct thermal_cooling_device *cdev;
214
215 /*
216 * This is a measure of 'how effectively these devices can
217 * cool 'this' thermal zone. The shall be determined by platform
218 * characterization. This is on a 'percentage' scale.
219 * See Documentation/thermal/sysfs-api.txt for more information.
220 */
221 int weight;
222
223 /*
224 * This is a bit mask that gives the binding relation between this
225 * thermal zone and cdev, for a particular trip point.
226 * See Documentation/thermal/sysfs-api.txt for more information.
227 */
228 int trip_mask;
Eduardo Valentina8892d832013-07-16 15:26:28 -0400229
230 /*
231 * This is an array of cooling state limits. Must have exactly
232 * 2 * thermal_zone.number_of_trip_points. It is an array consisting
233 * of tuples <lower-state upper-state> of state limits. Each trip
234 * will be associated with one state limit tuple when binding.
235 * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
236 * on all trips.
237 */
238 unsigned long *binding_limits;
Durgadoss Ref873942012-09-18 11:04:55 +0530239 int (*match) (struct thermal_zone_device *tz,
240 struct thermal_cooling_device *cdev);
241};
242
243/* Structure to define Thermal Zone parameters */
244struct thermal_zone_params {
Durgadoss Ra4a15482012-09-18 11:04:57 +0530245 char governor_name[THERMAL_NAME_LENGTH];
Eduardo Valentinccba4ff2013-08-15 11:34:17 -0400246
247 /*
248 * a boolean to indicate if the thermal to hwmon sysfs interface
249 * is required. when no_hwmon == false, a hwmon sysfs interface
250 * will be created. when no_hwmon == true, nothing will be done
251 */
252 bool no_hwmon;
253
Durgadoss Ref873942012-09-18 11:04:55 +0530254 int num_tbps; /* Number of tbp entries */
255 struct thermal_bind_params *tbp;
256};
257
R.Durgadoss4cb18722010-10-27 03:33:29 +0530258struct thermal_genl_event {
259 u32 orig;
260 enum events event;
261};
R.Durgadoss4cb18722010-10-27 03:33:29 +0530262
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400263/**
264 * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones
265 *
266 * Mandatory:
267 * @get_temp: a pointer to a function that reads the sensor temperature.
268 *
269 * Optional:
270 * @get_trend: a pointer to a function that reads the sensor temperature trend.
Lukasz Majewski184a4bf2014-12-08 18:04:21 +0100271 * @set_emul_temp: a pointer to a function that sets sensor emulated
272 * temperature.
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400273 */
274struct thermal_zone_of_device_ops {
275 int (*get_temp)(void *, long *);
276 int (*get_trend)(void *, long *);
Lukasz Majewski184a4bf2014-12-08 18:04:21 +0100277 int (*set_emul_temp)(void *, unsigned long);
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400278};
279
Lukasz Majewskiad9914a2014-12-08 18:04:19 +0100280/**
281 * struct thermal_trip - representation of a point in temperature domain
282 * @np: pointer to struct device_node that this trip point was created from
283 * @temperature: temperature value in miliCelsius
284 * @hysteresis: relative hysteresis in miliCelsius
285 * @type: trip point type
286 */
287
288struct thermal_trip {
289 struct device_node *np;
290 unsigned long int temperature;
291 unsigned long int hysteresis;
292 enum thermal_trip_type type;
293};
294
Durgadoss R23064082012-09-18 11:04:52 +0530295/* Function declarations */
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400296#ifdef CONFIG_THERMAL_OF
297struct thermal_zone_device *
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400298thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
299 const struct thermal_zone_of_device_ops *ops);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400300void thermal_zone_of_sensor_unregister(struct device *dev,
301 struct thermal_zone_device *tz);
302#else
303static inline struct thermal_zone_device *
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400304thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
305 const struct thermal_zone_of_device_ops *ops)
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400306{
307 return NULL;
308}
309
310static inline
311void thermal_zone_of_sensor_unregister(struct device *dev,
312 struct thermal_zone_device *tz)
313{
314}
315
316#endif
Anton Vorontsov4b1bf582012-07-31 04:39:30 -0700317struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400318 void *, struct thermal_zone_device_ops *,
Durgadoss R50125a92012-09-18 11:04:56 +0530319 const struct thermal_zone_params *, int, int);
Zhang Rui203d3d42008-01-17 15:51:08 +0800320void thermal_zone_device_unregister(struct thermal_zone_device *);
321
322int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
Zhang Rui9d998422012-06-26 16:35:57 +0800323 struct thermal_cooling_device *,
324 unsigned long, unsigned long);
Zhang Rui203d3d42008-01-17 15:51:08 +0800325int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
326 struct thermal_cooling_device *);
Matthew Garrettb1569e92008-12-03 17:55:32 +0000327void thermal_zone_device_update(struct thermal_zone_device *);
Durgadoss R23064082012-09-18 11:04:52 +0530328
Zhang Rui203d3d42008-01-17 15:51:08 +0800329struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
Alan Cox5b275ce2010-11-11 15:27:29 +0000330 const struct thermal_cooling_device_ops *);
Eduardo Valentina116b5d2013-09-26 15:55:01 -0400331struct thermal_cooling_device *
332thermal_of_cooling_device_register(struct device_node *np, char *, void *,
333 const struct thermal_cooling_device_ops *);
Zhang Rui203d3d42008-01-17 15:51:08 +0800334void thermal_cooling_device_unregister(struct thermal_cooling_device *);
Eduardo Valentin63c4d912013-04-05 12:32:28 +0000335struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
Eduardo Valentin837b26b2013-04-05 12:32:29 +0000336int thermal_zone_get_temp(struct thermal_zone_device *tz, unsigned long *temp);
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100337
Durgadoss R9b4298a2012-09-18 11:04:54 +0530338int get_tz_trend(struct thermal_zone_device *, int);
339struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
340 struct thermal_cooling_device *, int);
Durgadoss Rdc765482012-09-18 11:05:00 +0530341void thermal_cdev_update(struct thermal_cooling_device *);
Eduardo Valentin7b73c992013-04-23 21:48:14 +0000342void thermal_notify_framework(struct thermal_zone_device *, int);
Durgadoss Ra4a15482012-09-18 11:04:57 +0530343
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100344#ifdef CONFIG_NET
Eduardo Valentin8ab3e6a2013-01-02 15:29:39 +0000345extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
346 enum events event);
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100347#else
Ezequiel Garciaf8b58702013-03-20 21:38:07 +0000348static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
Eduardo Valentin8ab3e6a2013-01-02 15:29:39 +0000349 enum events event)
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100350{
351 return 0;
352}
353#endif
Zhang Rui203d3d42008-01-17 15:51:08 +0800354
Len Browna0dd25b2008-02-09 04:01:48 -0500355#endif /* __THERMAL_H__ */