blob: 6e49b8628621647e89a838c006584cb45baf4431 [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
Ram Chandrasekar2a1abd12017-06-12 12:52:08 -060043/* upper limit requirement */
44#define THERMAL_MAX_LIMIT (THERMAL_NO_LIMIT - 1)
45
Kapileshwar Singh6cd9e9f2015-02-18 16:04:21 +000046/* Default weight of a bound cooling device */
47#define THERMAL_WEIGHT_DEFAULT 0
48
Ram Chandrasekar2f2b7462017-03-11 19:35:11 -070049/* Max sensors that can be used for a single virtual thermalzone */
50#define THERMAL_MAX_VIRT_SENSORS 5
51
Zhang Ruibb431ba2015-10-30 16:31:47 +080052/* use value, which < 0K, to indicate an invalid/uninitialized temperature */
53#define THERMAL_TEMP_INVALID -274000
54
Durgadoss R23064082012-09-18 11:04:52 +053055/* Unit conversion macros */
Rasmus Villemoese866a2e2015-10-01 23:45:31 +020056#define DECI_KELVIN_TO_CELSIUS(t) ({ \
57 long _t = (t); \
58 ((_t-2732 >= 0) ? (_t-2732+5)/10 : (_t-2732-5)/10); \
59})
60#define CELSIUS_TO_DECI_KELVIN(t) ((t)*10+2732)
Aaron Lu7b83fd92014-03-25 10:40:09 +080061#define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100)
62#define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 2732)
Aaron Lu77e337c2014-09-03 15:13:02 +080063#define MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, off) (((t) / 100) + (off))
64#define MILLICELSIUS_TO_DECI_KELVIN(t) MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, 2732)
Durgadoss R23064082012-09-18 11:04:52 +053065
Zhang Rui1f53ef12012-12-12 15:31:37 +080066/* Default Thermal Governor */
67#if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
68#define DEFAULT_THERMAL_GOVERNOR "step_wise"
69#elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
70#define DEFAULT_THERMAL_GOVERNOR "fair_share"
71#elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
72#define DEFAULT_THERMAL_GOVERNOR "user_space"
Javi Merino6b775e82015-03-02 17:17:19 +000073#elif defined(CONFIG_THERMAL_DEFAULT_GOV_POWER_ALLOCATOR)
74#define DEFAULT_THERMAL_GOVERNOR "power_allocator"
Zhang Rui1f53ef12012-12-12 15:31:37 +080075#endif
Durgadoss Ra4a15482012-09-18 11:04:57 +053076
Zhang Rui203d3d42008-01-17 15:51:08 +080077struct thermal_zone_device;
78struct thermal_cooling_device;
Javi Merino35b11d22015-02-26 19:00:28 +000079struct thermal_instance;
Zhang Rui203d3d42008-01-17 15:51:08 +080080
Matthew Garrett6503e5d2008-11-27 17:48:13 +000081enum thermal_device_mode {
82 THERMAL_DEVICE_DISABLED = 0,
83 THERMAL_DEVICE_ENABLED,
84};
85
Siddartha Mohanadoss45a944b2017-01-23 19:46:10 -080086enum thermal_trip_activation_mode {
87 THERMAL_TRIP_ACTIVATION_DISABLED = 0,
88 THERMAL_TRIP_ACTIVATION_ENABLED,
89};
90
Matthew Garrett6503e5d2008-11-27 17:48:13 +000091enum thermal_trip_type {
92 THERMAL_TRIP_ACTIVE = 0,
93 THERMAL_TRIP_PASSIVE,
94 THERMAL_TRIP_HOT,
95 THERMAL_TRIP_CRITICAL,
Siddartha Mohanadoss45a944b2017-01-23 19:46:10 -080096 THERMAL_TRIP_CONFIGURABLE_HI,
97 THERMAL_TRIP_CONFIGURABLE_LOW,
98 THERMAL_TRIP_CRITICAL_LOW,
Matthew Garrett6503e5d2008-11-27 17:48:13 +000099};
100
Zhang Rui601f3d42012-06-27 09:54:33 +0800101enum thermal_trend {
102 THERMAL_TREND_STABLE, /* temperature is stable */
103 THERMAL_TREND_RAISING, /* temperature is raising */
104 THERMAL_TREND_DROPPING, /* temperature is dropping */
Zhang Ruid069015e2012-11-19 15:33:51 +0800105 THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
106 THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
Zhang Rui601f3d42012-06-27 09:54:33 +0800107};
108
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700109/* Thermal notification reason */
110enum thermal_notify_event {
111 THERMAL_EVENT_UNSPECIFIED, /* Unspecified event */
112 THERMAL_EVENT_TEMP_SAMPLE, /* New Temperature sample */
113 THERMAL_TRIP_VIOLATED, /* TRIP Point violation */
114 THERMAL_TRIP_CHANGED, /* TRIP Point temperature changed */
115 THERMAL_DEVICE_DOWN, /* Thermal device is down */
116 THERMAL_DEVICE_UP, /* Thermal device is up after a down event */
117 THERMAL_DEVICE_POWER_CAPABILITY_CHANGED, /* power capability changed */
118};
119
Zhang Rui203d3d42008-01-17 15:51:08 +0800120struct thermal_zone_device_ops {
121 int (*bind) (struct thermal_zone_device *,
122 struct thermal_cooling_device *);
123 int (*unbind) (struct thermal_zone_device *,
124 struct thermal_cooling_device *);
Sascha Hauer17e83512015-07-24 08:12:54 +0200125 int (*get_temp) (struct thermal_zone_device *, int *);
Sascha Hauer060c0342016-06-22 16:42:01 +0800126 int (*set_trips) (struct thermal_zone_device *, int, int);
Matthew Garrett6503e5d2008-11-27 17:48:13 +0000127 int (*get_mode) (struct thermal_zone_device *,
128 enum thermal_device_mode *);
129 int (*set_mode) (struct thermal_zone_device *,
130 enum thermal_device_mode);
131 int (*get_trip_type) (struct thermal_zone_device *, int,
132 enum thermal_trip_type *);
Sascha Hauer17e83512015-07-24 08:12:54 +0200133 int (*get_trip_temp) (struct thermal_zone_device *, int, int *);
134 int (*set_trip_temp) (struct thermal_zone_device *, int, int);
135 int (*get_trip_hyst) (struct thermal_zone_device *, int, int *);
136 int (*set_trip_hyst) (struct thermal_zone_device *, int, int);
137 int (*get_crit_temp) (struct thermal_zone_device *, int *);
138 int (*set_emul_temp) (struct thermal_zone_device *, int);
Siddartha Mohanadoss45a944b2017-01-23 19:46:10 -0800139 int (*activate_trip_type)(struct thermal_zone_device *, int,
140 enum thermal_trip_activation_mode);
Zhang Rui601f3d42012-06-27 09:54:33 +0800141 int (*get_trend) (struct thermal_zone_device *, int,
142 enum thermal_trend *);
Matthew Garrettb1569e92008-12-03 17:55:32 +0000143 int (*notify) (struct thermal_zone_device *, int,
144 enum thermal_trip_type);
Zhang Rui203d3d42008-01-17 15:51:08 +0800145};
146
147struct thermal_cooling_device_ops {
Matthew Garrett6503e5d2008-11-27 17:48:13 +0000148 int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
149 int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
150 int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
Ram Chandrasekarbd155702017-03-17 16:42:15 -0600151 int (*set_min_state)(struct thermal_cooling_device *, unsigned long);
152 int (*get_min_state)(struct thermal_cooling_device *, unsigned long *);
Javi Merino35b11d22015-02-26 19:00:28 +0000153 int (*get_requested_power)(struct thermal_cooling_device *,
154 struct thermal_zone_device *, u32 *);
155 int (*state2power)(struct thermal_cooling_device *,
156 struct thermal_zone_device *, unsigned long, u32 *);
157 int (*power2state)(struct thermal_cooling_device *,
158 struct thermal_zone_device *, u32, unsigned long *);
Zhang Rui203d3d42008-01-17 15:51:08 +0800159};
160
Zhang Rui203d3d42008-01-17 15:51:08 +0800161struct thermal_cooling_device {
162 int id;
163 char type[THERMAL_NAME_LENGTH];
164 struct device device;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400165 struct device_node *np;
Zhang Rui203d3d42008-01-17 15:51:08 +0800166 void *devdata;
Alan Cox5b275ce2010-11-11 15:27:29 +0000167 const struct thermal_cooling_device_ops *ops;
Zhang Ruice119f82012-06-27 14:13:04 +0800168 bool updated; /* true if the cooling device does not need update */
Zhang Ruif4a821c2012-07-24 16:56:21 +0800169 struct mutex lock; /* protect thermal_instances list */
Zhang Ruib5e4ae62012-06-27 14:11:52 +0800170 struct list_head thermal_instances;
Zhang Rui203d3d42008-01-17 15:51:08 +0800171 struct list_head node;
Ram Chandrasekar5ab1c082016-09-20 17:09:28 -0600172 unsigned long sysfs_cur_state_req;
173 unsigned long sysfs_min_state_req;
Zhang Rui203d3d42008-01-17 15:51:08 +0800174};
175
Durgadoss Rc56f5c02012-07-25 10:10:58 +0800176struct thermal_attr {
177 struct device_attribute attr;
178 char name[THERMAL_NAME_LENGTH];
179};
180
Javi Merinoc708a982014-06-25 11:00:12 +0100181/**
182 * struct thermal_zone_device - structure for a thermal zone
183 * @id: unique id number for each thermal zone
184 * @type: the thermal zone device type
185 * @device: &struct device for this thermal zone
186 * @trip_temp_attrs: attributes for trip points for sysfs: trip temperature
187 * @trip_type_attrs: attributes for trip points for sysfs: trip type
188 * @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis
189 * @devdata: private pointer for device private data
190 * @trips: number of trip points the thermal zone supports
Zhang Rui81ad4272016-03-18 10:03:24 +0800191 * @trips_disabled; bitmap for disabled trips
Javi Merinoc708a982014-06-25 11:00:12 +0100192 * @passive_delay: number of milliseconds to wait between polls when
Javi Merino6b775e82015-03-02 17:17:19 +0000193 * performing passive cooling.
Javi Merinoc708a982014-06-25 11:00:12 +0100194 * @polling_delay: number of milliseconds to wait between polls when
195 * checking whether trip points have been crossed (0 for
196 * interrupt driven systems)
197 * @temperature: current temperature. This is only for core code,
198 * drivers should use thermal_zone_get_temp() to get the
199 * current temperature
200 * @last_temperature: previous temperature read
201 * @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION
202 * @passive: 1 if you've crossed a passive trip point, 0 otherwise.
Sascha Hauer060c0342016-06-22 16:42:01 +0800203 * @prev_low_trip: the low current temperature if you've crossed a passive
204 trip point.
205 * @prev_high_trip: the above current temperature if you've crossed a
206 passive trip point.
Javi Merinoc708a982014-06-25 11:00:12 +0100207 * @forced_passive: If > 0, temperature at which to switch on all ACPI
208 * processor cooling devices. Currently only used by the
209 * step-wise governor.
Chen Yu4511f712015-10-30 16:32:10 +0800210 * @need_update: if equals 1, thermal_zone_device_update needs to be invoked.
Javi Merinoc708a982014-06-25 11:00:12 +0100211 * @ops: operations this &thermal_zone_device supports
212 * @tzp: thermal zone parameters
213 * @governor: pointer to the governor for this thermal zone
Javi Merinoe33df1d2015-02-26 19:00:27 +0000214 * @governor_data: private pointer for governor data
Javi Merinoc708a982014-06-25 11:00:12 +0100215 * @thermal_instances: list of &struct thermal_instance of this thermal zone
216 * @idr: &struct idr to generate unique id for this zone's cooling
217 * devices
218 * @lock: lock to protect thermal_instances list
219 * @node: node in thermal_tz_list (in thermal_core.c)
220 * @poll_queue: delayed work for polling
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700221 * @notify_event: Last notification event
Javi Merinoc708a982014-06-25 11:00:12 +0100222 */
Zhang Rui203d3d42008-01-17 15:51:08 +0800223struct thermal_zone_device {
224 int id;
225 char type[THERMAL_NAME_LENGTH];
226 struct device device;
Durgadoss Rc56f5c02012-07-25 10:10:58 +0800227 struct thermal_attr *trip_temp_attrs;
228 struct thermal_attr *trip_type_attrs;
Durgadoss R27365a62012-07-25 10:10:59 +0800229 struct thermal_attr *trip_hyst_attrs;
Zhang Rui203d3d42008-01-17 15:51:08 +0800230 void *devdata;
231 int trips;
Zhang Rui81ad4272016-03-18 10:03:24 +0800232 unsigned long trips_disabled; /* bitmap for disabled trips */
Matthew Garrettb1569e92008-12-03 17:55:32 +0000233 int passive_delay;
234 int polling_delay;
Zhang Rui601f3d42012-06-27 09:54:33 +0800235 int temperature;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000236 int last_temperature;
Amit Daniel Kachhape6e238c2013-02-04 00:30:15 +0000237 int emul_temperature;
Zhang Rui908b9fb2012-06-27 14:14:05 +0800238 int passive;
Sascha Hauer060c0342016-06-22 16:42:01 +0800239 int prev_low_trip;
240 int prev_high_trip;
Matthew Garrett03a971a2008-12-03 18:00:38 +0000241 unsigned int forced_passive;
Chen Yu4511f712015-10-30 16:32:10 +0800242 atomic_t need_update;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400243 struct thermal_zone_device_ops *ops;
Javi Merino6b775e82015-03-02 17:17:19 +0000244 struct thermal_zone_params *tzp;
Durgadoss Ra4a15482012-09-18 11:04:57 +0530245 struct thermal_governor *governor;
Javi Merinoe33df1d2015-02-26 19:00:27 +0000246 void *governor_data;
Zhang Rui2d374132012-06-27 10:09:00 +0800247 struct list_head thermal_instances;
Zhang Rui203d3d42008-01-17 15:51:08 +0800248 struct idr idr;
Javi Merinoc708a982014-06-25 11:00:12 +0100249 struct mutex lock;
Zhang Rui203d3d42008-01-17 15:51:08 +0800250 struct list_head node;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000251 struct delayed_work poll_queue;
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700252 enum thermal_notify_event notify_event;
Zhang Rui203d3d42008-01-17 15:51:08 +0800253};
R.Durgadoss4cb18722010-10-27 03:33:29 +0530254
Javi Merinoc708a982014-06-25 11:00:12 +0100255/**
256 * struct thermal_governor - structure that holds thermal governor information
257 * @name: name of the governor
Javi Merinoe33df1d2015-02-26 19:00:27 +0000258 * @bind_to_tz: callback called when binding to a thermal zone. If it
259 * returns 0, the governor is bound to the thermal zone,
260 * otherwise it fails.
261 * @unbind_from_tz: callback called when a governor is unbound from a
262 * thermal zone.
Javi Merinoc708a982014-06-25 11:00:12 +0100263 * @throttle: callback called for every trip point even if temperature is
264 * below the trip point temperature
265 * @governor_list: node in thermal_governor_list (in thermal_core.c)
266 */
Durgadoss Ra4a15482012-09-18 11:04:57 +0530267struct thermal_governor {
268 char name[THERMAL_NAME_LENGTH];
Javi Merinoe33df1d2015-02-26 19:00:27 +0000269 int (*bind_to_tz)(struct thermal_zone_device *tz);
270 void (*unbind_from_tz)(struct thermal_zone_device *tz);
Durgadoss Ra4a15482012-09-18 11:04:57 +0530271 int (*throttle)(struct thermal_zone_device *tz, int trip);
272 struct list_head governor_list;
Ram Chandrasekarbd155702017-03-17 16:42:15 -0600273 int min_state_throttle;
Durgadoss Ra4a15482012-09-18 11:04:57 +0530274};
275
Durgadoss Ref873942012-09-18 11:04:55 +0530276/* Structure that holds binding parameters for a zone */
277struct thermal_bind_params {
278 struct thermal_cooling_device *cdev;
279
280 /*
281 * This is a measure of 'how effectively these devices can
Javi Merinobcdcbbc2015-02-18 16:04:25 +0000282 * cool 'this' thermal zone. It shall be determined by
283 * platform characterization. This value is relative to the
284 * rest of the weights so a cooling device whose weight is
285 * double that of another cooling device is twice as
286 * effective. See Documentation/thermal/sysfs-api.txt for more
287 * information.
Durgadoss Ref873942012-09-18 11:04:55 +0530288 */
289 int weight;
290
291 /*
292 * This is a bit mask that gives the binding relation between this
293 * thermal zone and cdev, for a particular trip point.
294 * See Documentation/thermal/sysfs-api.txt for more information.
295 */
296 int trip_mask;
Eduardo Valentina8892d832013-07-16 15:26:28 -0400297
298 /*
299 * This is an array of cooling state limits. Must have exactly
300 * 2 * thermal_zone.number_of_trip_points. It is an array consisting
301 * of tuples <lower-state upper-state> of state limits. Each trip
302 * will be associated with one state limit tuple when binding.
303 * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
304 * on all trips.
305 */
306 unsigned long *binding_limits;
Durgadoss Ref873942012-09-18 11:04:55 +0530307 int (*match) (struct thermal_zone_device *tz,
308 struct thermal_cooling_device *cdev);
309};
310
311/* Structure to define Thermal Zone parameters */
312struct thermal_zone_params {
Durgadoss Ra4a15482012-09-18 11:04:57 +0530313 char governor_name[THERMAL_NAME_LENGTH];
Eduardo Valentinccba4ff2013-08-15 11:34:17 -0400314
315 /*
316 * a boolean to indicate if the thermal to hwmon sysfs interface
317 * is required. when no_hwmon == false, a hwmon sysfs interface
318 * will be created. when no_hwmon == true, nothing will be done
319 */
320 bool no_hwmon;
321
Durgadoss Ref873942012-09-18 11:04:55 +0530322 int num_tbps; /* Number of tbp entries */
323 struct thermal_bind_params *tbp;
Javi Merino6b775e82015-03-02 17:17:19 +0000324
325 /*
326 * Sustainable power (heat) that this thermal zone can dissipate in
327 * mW
328 */
329 u32 sustainable_power;
330
331 /*
332 * Proportional parameter of the PID controller when
333 * overshooting (i.e., when temperature is below the target)
334 */
335 s32 k_po;
336
337 /*
338 * Proportional parameter of the PID controller when
339 * undershooting
340 */
341 s32 k_pu;
342
343 /* Integral parameter of the PID controller */
344 s32 k_i;
345
346 /* Derivative parameter of the PID controller */
347 s32 k_d;
348
349 /* threshold below which the error is no longer accumulated */
350 s32 integral_cutoff;
Eduardo Valentin9d0be7f2015-05-11 19:34:23 -0700351
352 /*
353 * @slope: slope of a linear temperature adjustment curve.
354 * Used by thermal zone drivers.
355 */
356 int slope;
357 /*
358 * @offset: offset of a linear temperature adjustment curve.
359 * Used by thermal zone drivers (default 0).
360 */
361 int offset;
Lina Iyer159f67d2016-07-27 11:34:46 -0600362
363 /*
364 * @tracks_low: Indicates that the thermal zone params are for
365 * temperatures falling below the thresholds.
366 */
367 bool tracks_low;
Durgadoss Ref873942012-09-18 11:04:55 +0530368};
369
R.Durgadoss4cb18722010-10-27 03:33:29 +0530370struct thermal_genl_event {
371 u32 orig;
372 enum events event;
373};
R.Durgadoss4cb18722010-10-27 03:33:29 +0530374
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400375/**
376 * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones
377 *
378 * Mandatory:
379 * @get_temp: a pointer to a function that reads the sensor temperature.
380 *
381 * Optional:
382 * @get_trend: a pointer to a function that reads the sensor temperature trend.
Sascha Hauer826386e2016-06-22 16:42:02 +0800383 * @set_trips: a pointer to a function that sets a temperature window. When
384 * this window is left the driver must inform the thermal core via
385 * thermal_zone_device_update.
Lukasz Majewski184a4bf2014-12-08 18:04:21 +0100386 * @set_emul_temp: a pointer to a function that sets sensor emulated
387 * temperature.
Caesar Wang5a5e78c2016-05-18 23:01:39 +0800388 * @set_trip_temp: a pointer to a function that sets the trip temperature on
389 * hardware.
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400390 */
391struct thermal_zone_of_device_ops {
Sascha Hauer17e83512015-07-24 08:12:54 +0200392 int (*get_temp)(void *, int *);
Sascha Hauere78eaf42016-06-22 16:42:03 +0800393 int (*get_trend)(void *, int, enum thermal_trend *);
Sascha Hauer826386e2016-06-22 16:42:02 +0800394 int (*set_trips)(void *, int, int);
Sascha Hauer17e83512015-07-24 08:12:54 +0200395 int (*set_emul_temp)(void *, int);
Wei Nic3509522016-03-29 18:29:17 +0800396 int (*set_trip_temp)(void *, int, int);
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400397};
398
Lukasz Majewskiad9914a2014-12-08 18:04:19 +0100399/**
400 * struct thermal_trip - representation of a point in temperature domain
401 * @np: pointer to struct device_node that this trip point was created from
402 * @temperature: temperature value in miliCelsius
403 * @hysteresis: relative hysteresis in miliCelsius
404 * @type: trip point type
405 */
406
407struct thermal_trip {
408 struct device_node *np;
Wei Ni1d0fd422016-03-03 17:33:46 +0800409 int temperature;
410 int hysteresis;
Lukasz Majewskiad9914a2014-12-08 18:04:19 +0100411 enum thermal_trip_type type;
412};
413
Ram Chandrasekar2f2b7462017-03-11 19:35:11 -0700414/* Different aggregation logic supported for virtual sensors */
415enum aggregation_logic {
416 VIRT_WEIGHTED_AVG,
417 VIRT_MAXIMUM,
418 VIRT_MINIMUM,
419 VIRT_AGGREGATION_NR,
420};
421
422/*
423 * struct virtual_sensor_data - Data structure used to provide
424 * information about the virtual zone.
425 * @virt_zone_name - Virtual thermal zone name
426 * @num_sensors - Number of sensors this virtual zone uses to compute
427 * temperature
428 * @sensor_names - Array of sensor names
429 * @logic - Temperature aggregation logic to be used
430 * @coefficients - Coefficients to be used for weighted average logic
431 * @coefficient_ct - number of coefficients provided as input
432 * @avg_offset - offset value to be used for the weighted aggregation logic
433 * @avg_denominator - denominator value to be used for the weighted aggregation
434 * logic
435 */
436struct virtual_sensor_data {
437 int num_sensors;
438 char virt_zone_name[THERMAL_NAME_LENGTH];
439 char *sensor_names[THERMAL_MAX_VIRT_SENSORS];
440 enum aggregation_logic logic;
441 int coefficients[THERMAL_MAX_VIRT_SENSORS];
442 int coefficient_ct;
443 int avg_offset;
444 int avg_denominator;
445};
446
Durgadoss R23064082012-09-18 11:04:52 +0530447/* Function declarations */
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400448#ifdef CONFIG_THERMAL_OF
449struct thermal_zone_device *
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400450thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
451 const struct thermal_zone_of_device_ops *ops);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400452void thermal_zone_of_sensor_unregister(struct device *dev,
453 struct thermal_zone_device *tz);
Laxman Dewangane498b492016-03-09 18:40:06 +0530454struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
455 struct device *dev, int id, void *data,
456 const struct thermal_zone_of_device_ops *ops);
457void devm_thermal_zone_of_sensor_unregister(struct device *dev,
458 struct thermal_zone_device *tz);
Ram Chandrasekar2f2b7462017-03-11 19:35:11 -0700459struct thermal_zone_device *devm_thermal_of_virtual_sensor_register(
460 struct device *dev,
461 const struct virtual_sensor_data *sensor_data);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400462#else
463static inline struct thermal_zone_device *
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400464thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
465 const struct thermal_zone_of_device_ops *ops)
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400466{
Punit Agrawalcd33dc92015-09-08 14:51:12 +0100467 return ERR_PTR(-ENODEV);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400468}
469
470static inline
471void thermal_zone_of_sensor_unregister(struct device *dev,
472 struct thermal_zone_device *tz)
473{
474}
475
Laxman Dewangane498b492016-03-09 18:40:06 +0530476static inline struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
477 struct device *dev, int id, void *data,
478 const struct thermal_zone_of_device_ops *ops)
479{
480 return ERR_PTR(-ENODEV);
481}
482
483static inline
484void devm_thermal_zone_of_sensor_unregister(struct device *dev,
485 struct thermal_zone_device *tz)
486{
487}
488
Ram Chandrasekar2f2b7462017-03-11 19:35:11 -0700489static inline
490struct thermal_zone_device *devm_thermal_of_virtual_sensor_register(
491 struct device *dev,
492 const struct virtual_sensor_data *sensor_data)
493{
494 return ERR_PTR(-ENODEV);
495}
496
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400497#endif
Nishanth Menon12ca7182015-02-13 19:28:02 -0600498
499#if IS_ENABLED(CONFIG_THERMAL)
Javi Merino35b11d22015-02-26 19:00:28 +0000500static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
501{
502 return cdev->ops->get_requested_power && cdev->ops->state2power &&
503 cdev->ops->power2state;
504}
505
506int power_actor_get_max_power(struct thermal_cooling_device *,
507 struct thermal_zone_device *tz, u32 *max_power);
Javi Merinoc973c3b2015-09-14 14:23:50 +0100508int power_actor_get_min_power(struct thermal_cooling_device *,
509 struct thermal_zone_device *tz, u32 *min_power);
Javi Merino35b11d22015-02-26 19:00:28 +0000510int power_actor_set_power(struct thermal_cooling_device *,
511 struct thermal_instance *, u32);
Anton Vorontsov4b1bf582012-07-31 04:39:30 -0700512struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400513 void *, struct thermal_zone_device_ops *,
Javi Merino6b775e82015-03-02 17:17:19 +0000514 struct thermal_zone_params *, int, int);
Zhang Rui203d3d42008-01-17 15:51:08 +0800515void thermal_zone_device_unregister(struct thermal_zone_device *);
516
517int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
Zhang Rui9d998422012-06-26 16:35:57 +0800518 struct thermal_cooling_device *,
Kapileshwar Singh6cd9e9f2015-02-18 16:04:21 +0000519 unsigned long, unsigned long,
520 unsigned int);
Zhang Rui203d3d42008-01-17 15:51:08 +0800521int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
522 struct thermal_cooling_device *);
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700523void thermal_zone_device_update(struct thermal_zone_device *,
524 enum thermal_notify_event);
Sascha Hauer060c0342016-06-22 16:42:01 +0800525void thermal_zone_set_trips(struct thermal_zone_device *);
Durgadoss R23064082012-09-18 11:04:52 +0530526
Zhang Rui203d3d42008-01-17 15:51:08 +0800527struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
Alan Cox5b275ce2010-11-11 15:27:29 +0000528 const struct thermal_cooling_device_ops *);
Eduardo Valentina116b5d2013-09-26 15:55:01 -0400529struct thermal_cooling_device *
530thermal_of_cooling_device_register(struct device_node *np, char *, void *,
531 const struct thermal_cooling_device_ops *);
Zhang Rui203d3d42008-01-17 15:51:08 +0800532void thermal_cooling_device_unregister(struct thermal_cooling_device *);
Eduardo Valentin63c4d912013-04-05 12:32:28 +0000533struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
Sascha Hauer17e83512015-07-24 08:12:54 +0200534int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp);
Rajendra Nayak4a7069a2016-05-05 14:21:42 +0530535int thermal_zone_get_slope(struct thermal_zone_device *tz);
536int thermal_zone_get_offset(struct thermal_zone_device *tz);
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100537
Durgadoss R9b4298a2012-09-18 11:04:54 +0530538int get_tz_trend(struct thermal_zone_device *, int);
539struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
540 struct thermal_cooling_device *, int);
Durgadoss Rdc765482012-09-18 11:05:00 +0530541void thermal_cdev_update(struct thermal_cooling_device *);
Eduardo Valentin7b73c992013-04-23 21:48:14 +0000542void thermal_notify_framework(struct thermal_zone_device *, int);
Nishanth Menon12ca7182015-02-13 19:28:02 -0600543#else
Javi Merino35b11d22015-02-26 19:00:28 +0000544static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
545{ return false; }
546static inline int power_actor_get_max_power(struct thermal_cooling_device *cdev,
547 struct thermal_zone_device *tz, u32 *max_power)
548{ return 0; }
Javi Merinoc973c3b2015-09-14 14:23:50 +0100549static inline int power_actor_get_min_power(struct thermal_cooling_device *cdev,
550 struct thermal_zone_device *tz,
551 u32 *min_power)
552{ return -ENODEV; }
Javi Merino35b11d22015-02-26 19:00:28 +0000553static inline int power_actor_set_power(struct thermal_cooling_device *cdev,
554 struct thermal_instance *tz, u32 power)
555{ return 0; }
Nishanth Menon12ca7182015-02-13 19:28:02 -0600556static inline struct thermal_zone_device *thermal_zone_device_register(
557 const char *type, int trips, int mask, void *devdata,
558 struct thermal_zone_device_ops *ops,
559 const struct thermal_zone_params *tzp,
560 int passive_delay, int polling_delay)
561{ return ERR_PTR(-ENODEV); }
562static inline void thermal_zone_device_unregister(
563 struct thermal_zone_device *tz)
564{ }
565static inline int thermal_zone_bind_cooling_device(
566 struct thermal_zone_device *tz, int trip,
567 struct thermal_cooling_device *cdev,
Arnd Bergmannc86b3de2015-11-17 17:48:52 +0100568 unsigned long upper, unsigned long lower,
569 unsigned int weight)
Nishanth Menon12ca7182015-02-13 19:28:02 -0600570{ return -ENODEV; }
571static inline int thermal_zone_unbind_cooling_device(
572 struct thermal_zone_device *tz, int trip,
573 struct thermal_cooling_device *cdev)
574{ return -ENODEV; }
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700575static inline void thermal_zone_device_update(struct thermal_zone_device *tz,
576 enum thermal_notify_event event)
Nishanth Menon12ca7182015-02-13 19:28:02 -0600577{ }
Sascha Hauer060c0342016-06-22 16:42:01 +0800578static inline void thermal_zone_set_trips(struct thermal_zone_device *tz)
579{ }
Nishanth Menon12ca7182015-02-13 19:28:02 -0600580static inline struct thermal_cooling_device *
581thermal_cooling_device_register(char *type, void *devdata,
582 const struct thermal_cooling_device_ops *ops)
583{ return ERR_PTR(-ENODEV); }
584static inline struct thermal_cooling_device *
585thermal_of_cooling_device_register(struct device_node *np,
586 char *type, void *devdata, const struct thermal_cooling_device_ops *ops)
587{ return ERR_PTR(-ENODEV); }
588static inline void thermal_cooling_device_unregister(
589 struct thermal_cooling_device *cdev)
590{ }
591static inline struct thermal_zone_device *thermal_zone_get_zone_by_name(
592 const char *name)
593{ return ERR_PTR(-ENODEV); }
594static inline int thermal_zone_get_temp(
Sascha Hauer17e83512015-07-24 08:12:54 +0200595 struct thermal_zone_device *tz, int *temp)
Nishanth Menon12ca7182015-02-13 19:28:02 -0600596{ return -ENODEV; }
Rajendra Nayak4a7069a2016-05-05 14:21:42 +0530597static inline int thermal_zone_get_slope(
598 struct thermal_zone_device *tz)
599{ return -ENODEV; }
600static inline int thermal_zone_get_offset(
601 struct thermal_zone_device *tz)
602{ return -ENODEV; }
Nishanth Menon12ca7182015-02-13 19:28:02 -0600603static inline int get_tz_trend(struct thermal_zone_device *tz, int trip)
604{ return -ENODEV; }
605static inline struct thermal_instance *
606get_thermal_instance(struct thermal_zone_device *tz,
607 struct thermal_cooling_device *cdev, int trip)
608{ return ERR_PTR(-ENODEV); }
609static inline void thermal_cdev_update(struct thermal_cooling_device *cdev)
610{ }
611static inline void thermal_notify_framework(struct thermal_zone_device *tz,
612 int trip)
613{ }
614#endif /* CONFIG_THERMAL */
Durgadoss Ra4a15482012-09-18 11:04:57 +0530615
Nishanth Menon12ca7182015-02-13 19:28:02 -0600616#if defined(CONFIG_NET) && IS_ENABLED(CONFIG_THERMAL)
Eduardo Valentin8ab3e6a2013-01-02 15:29:39 +0000617extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
618 enum events event);
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100619#else
Ezequiel Garciaf8b58702013-03-20 21:38:07 +0000620static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
Eduardo Valentin8ab3e6a2013-01-02 15:29:39 +0000621 enum events event)
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100622{
623 return 0;
624}
625#endif
Zhang Rui203d3d42008-01-17 15:51:08 +0800626
Len Browna0dd25b2008-02-09 04:01:48 -0500627#endif /* __THERMAL_H__ */