blob: a700e5f5a820c7c43ddebc184f0fa005f16e35f3 [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 */
Manaf Meethalavalappu Pallikunhi3d62c3f2017-08-23 21:39:35 +053050#define THERMAL_MAX_VIRT_SENSORS 8
Ram Chandrasekar2f2b7462017-03-11 19:35:11 -070051
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
Ram Chandrasekar37c816d2017-08-25 12:34:02 -060055/*
56 * use a high value for low temp tracking zone,
57 * to indicate an invalid/uninitialized temperature
58 */
59#define THERMAL_TEMP_INVALID_LOW 274000
60
Durgadoss R23064082012-09-18 11:04:52 +053061/* Unit conversion macros */
Rasmus Villemoese866a2e2015-10-01 23:45:31 +020062#define DECI_KELVIN_TO_CELSIUS(t) ({ \
63 long _t = (t); \
64 ((_t-2732 >= 0) ? (_t-2732+5)/10 : (_t-2732-5)/10); \
65})
66#define CELSIUS_TO_DECI_KELVIN(t) ((t)*10+2732)
Aaron Lu7b83fd92014-03-25 10:40:09 +080067#define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100)
68#define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 2732)
Aaron Lu77e337c2014-09-03 15:13:02 +080069#define MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, off) (((t) / 100) + (off))
70#define MILLICELSIUS_TO_DECI_KELVIN(t) MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, 2732)
Durgadoss R23064082012-09-18 11:04:52 +053071
Zhang Rui1f53ef12012-12-12 15:31:37 +080072/* Default Thermal Governor */
73#if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
74#define DEFAULT_THERMAL_GOVERNOR "step_wise"
75#elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
76#define DEFAULT_THERMAL_GOVERNOR "fair_share"
77#elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
78#define DEFAULT_THERMAL_GOVERNOR "user_space"
Javi Merino6b775e82015-03-02 17:17:19 +000079#elif defined(CONFIG_THERMAL_DEFAULT_GOV_POWER_ALLOCATOR)
80#define DEFAULT_THERMAL_GOVERNOR "power_allocator"
Zhang Rui1f53ef12012-12-12 15:31:37 +080081#endif
Durgadoss Ra4a15482012-09-18 11:04:57 +053082
Zhang Rui203d3d42008-01-17 15:51:08 +080083struct thermal_zone_device;
84struct thermal_cooling_device;
Javi Merino35b11d22015-02-26 19:00:28 +000085struct thermal_instance;
Zhang Rui203d3d42008-01-17 15:51:08 +080086
Matthew Garrett6503e5d2008-11-27 17:48:13 +000087enum thermal_device_mode {
88 THERMAL_DEVICE_DISABLED = 0,
89 THERMAL_DEVICE_ENABLED,
90};
91
Siddartha Mohanadoss45a944b2017-01-23 19:46:10 -080092enum thermal_trip_activation_mode {
93 THERMAL_TRIP_ACTIVATION_DISABLED = 0,
94 THERMAL_TRIP_ACTIVATION_ENABLED,
95};
96
Matthew Garrett6503e5d2008-11-27 17:48:13 +000097enum thermal_trip_type {
98 THERMAL_TRIP_ACTIVE = 0,
99 THERMAL_TRIP_PASSIVE,
100 THERMAL_TRIP_HOT,
101 THERMAL_TRIP_CRITICAL,
Siddartha Mohanadoss45a944b2017-01-23 19:46:10 -0800102 THERMAL_TRIP_CONFIGURABLE_HI,
103 THERMAL_TRIP_CONFIGURABLE_LOW,
104 THERMAL_TRIP_CRITICAL_LOW,
Matthew Garrett6503e5d2008-11-27 17:48:13 +0000105};
106
Zhang Rui601f3d42012-06-27 09:54:33 +0800107enum thermal_trend {
108 THERMAL_TREND_STABLE, /* temperature is stable */
109 THERMAL_TREND_RAISING, /* temperature is raising */
110 THERMAL_TREND_DROPPING, /* temperature is dropping */
Zhang Ruid069015e2012-11-19 15:33:51 +0800111 THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
112 THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
Zhang Rui601f3d42012-06-27 09:54:33 +0800113};
114
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700115/* Thermal notification reason */
116enum thermal_notify_event {
117 THERMAL_EVENT_UNSPECIFIED, /* Unspecified event */
118 THERMAL_EVENT_TEMP_SAMPLE, /* New Temperature sample */
119 THERMAL_TRIP_VIOLATED, /* TRIP Point violation */
120 THERMAL_TRIP_CHANGED, /* TRIP Point temperature changed */
121 THERMAL_DEVICE_DOWN, /* Thermal device is down */
122 THERMAL_DEVICE_UP, /* Thermal device is up after a down event */
123 THERMAL_DEVICE_POWER_CAPABILITY_CHANGED, /* power capability changed */
124};
125
Zhang Rui203d3d42008-01-17 15:51:08 +0800126struct thermal_zone_device_ops {
127 int (*bind) (struct thermal_zone_device *,
128 struct thermal_cooling_device *);
129 int (*unbind) (struct thermal_zone_device *,
130 struct thermal_cooling_device *);
Sascha Hauer17e83512015-07-24 08:12:54 +0200131 int (*get_temp) (struct thermal_zone_device *, int *);
Sascha Hauer060c0342016-06-22 16:42:01 +0800132 int (*set_trips) (struct thermal_zone_device *, int, int);
Matthew Garrett6503e5d2008-11-27 17:48:13 +0000133 int (*get_mode) (struct thermal_zone_device *,
134 enum thermal_device_mode *);
135 int (*set_mode) (struct thermal_zone_device *,
136 enum thermal_device_mode);
137 int (*get_trip_type) (struct thermal_zone_device *, int,
138 enum thermal_trip_type *);
Sascha Hauer17e83512015-07-24 08:12:54 +0200139 int (*get_trip_temp) (struct thermal_zone_device *, int, int *);
140 int (*set_trip_temp) (struct thermal_zone_device *, int, int);
141 int (*get_trip_hyst) (struct thermal_zone_device *, int, int *);
142 int (*set_trip_hyst) (struct thermal_zone_device *, int, int);
143 int (*get_crit_temp) (struct thermal_zone_device *, int *);
144 int (*set_emul_temp) (struct thermal_zone_device *, int);
Siddartha Mohanadoss45a944b2017-01-23 19:46:10 -0800145 int (*activate_trip_type)(struct thermal_zone_device *, int,
146 enum thermal_trip_activation_mode);
Zhang Rui601f3d42012-06-27 09:54:33 +0800147 int (*get_trend) (struct thermal_zone_device *, int,
148 enum thermal_trend *);
Matthew Garrettb1569e92008-12-03 17:55:32 +0000149 int (*notify) (struct thermal_zone_device *, int,
150 enum thermal_trip_type);
Zhang Rui203d3d42008-01-17 15:51:08 +0800151};
152
153struct thermal_cooling_device_ops {
Matthew Garrett6503e5d2008-11-27 17:48:13 +0000154 int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
155 int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
156 int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
Ram Chandrasekarbd155702017-03-17 16:42:15 -0600157 int (*set_min_state)(struct thermal_cooling_device *, unsigned long);
158 int (*get_min_state)(struct thermal_cooling_device *, unsigned long *);
Javi Merino35b11d22015-02-26 19:00:28 +0000159 int (*get_requested_power)(struct thermal_cooling_device *,
160 struct thermal_zone_device *, u32 *);
161 int (*state2power)(struct thermal_cooling_device *,
162 struct thermal_zone_device *, unsigned long, u32 *);
163 int (*power2state)(struct thermal_cooling_device *,
164 struct thermal_zone_device *, u32, unsigned long *);
Zhang Rui203d3d42008-01-17 15:51:08 +0800165};
166
Zhang Rui203d3d42008-01-17 15:51:08 +0800167struct thermal_cooling_device {
168 int id;
169 char type[THERMAL_NAME_LENGTH];
170 struct device device;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400171 struct device_node *np;
Zhang Rui203d3d42008-01-17 15:51:08 +0800172 void *devdata;
Alan Cox5b275ce2010-11-11 15:27:29 +0000173 const struct thermal_cooling_device_ops *ops;
Zhang Ruice119f82012-06-27 14:13:04 +0800174 bool updated; /* true if the cooling device does not need update */
Zhang Ruif4a821c2012-07-24 16:56:21 +0800175 struct mutex lock; /* protect thermal_instances list */
Zhang Ruib5e4ae62012-06-27 14:11:52 +0800176 struct list_head thermal_instances;
Zhang Rui203d3d42008-01-17 15:51:08 +0800177 struct list_head node;
Ram Chandrasekar5ab1c082016-09-20 17:09:28 -0600178 unsigned long sysfs_cur_state_req;
179 unsigned long sysfs_min_state_req;
Zhang Rui203d3d42008-01-17 15:51:08 +0800180};
181
Durgadoss Rc56f5c02012-07-25 10:10:58 +0800182struct thermal_attr {
183 struct device_attribute attr;
184 char name[THERMAL_NAME_LENGTH];
185};
186
Javi Merinoc708a982014-06-25 11:00:12 +0100187/**
188 * struct thermal_zone_device - structure for a thermal zone
189 * @id: unique id number for each thermal zone
190 * @type: the thermal zone device type
191 * @device: &struct device for this thermal zone
192 * @trip_temp_attrs: attributes for trip points for sysfs: trip temperature
193 * @trip_type_attrs: attributes for trip points for sysfs: trip type
194 * @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis
195 * @devdata: private pointer for device private data
196 * @trips: number of trip points the thermal zone supports
Zhang Rui81ad4272016-03-18 10:03:24 +0800197 * @trips_disabled; bitmap for disabled trips
Javi Merinoc708a982014-06-25 11:00:12 +0100198 * @passive_delay: number of milliseconds to wait between polls when
Javi Merino6b775e82015-03-02 17:17:19 +0000199 * performing passive cooling.
Javi Merinoc708a982014-06-25 11:00:12 +0100200 * @polling_delay: number of milliseconds to wait between polls when
201 * checking whether trip points have been crossed (0 for
202 * interrupt driven systems)
203 * @temperature: current temperature. This is only for core code,
204 * drivers should use thermal_zone_get_temp() to get the
205 * current temperature
206 * @last_temperature: previous temperature read
207 * @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION
208 * @passive: 1 if you've crossed a passive trip point, 0 otherwise.
Sascha Hauer060c0342016-06-22 16:42:01 +0800209 * @prev_low_trip: the low current temperature if you've crossed a passive
210 trip point.
211 * @prev_high_trip: the above current temperature if you've crossed a
212 passive trip point.
Javi Merinoc708a982014-06-25 11:00:12 +0100213 * @forced_passive: If > 0, temperature at which to switch on all ACPI
214 * processor cooling devices. Currently only used by the
215 * step-wise governor.
Chen Yu4511f712015-10-30 16:32:10 +0800216 * @need_update: if equals 1, thermal_zone_device_update needs to be invoked.
Javi Merinoc708a982014-06-25 11:00:12 +0100217 * @ops: operations this &thermal_zone_device supports
218 * @tzp: thermal zone parameters
219 * @governor: pointer to the governor for this thermal zone
Javi Merinoe33df1d2015-02-26 19:00:27 +0000220 * @governor_data: private pointer for governor data
Javi Merinoc708a982014-06-25 11:00:12 +0100221 * @thermal_instances: list of &struct thermal_instance of this thermal zone
222 * @idr: &struct idr to generate unique id for this zone's cooling
223 * devices
224 * @lock: lock to protect thermal_instances list
225 * @node: node in thermal_tz_list (in thermal_core.c)
226 * @poll_queue: delayed work for polling
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700227 * @notify_event: Last notification event
Javi Merinoc708a982014-06-25 11:00:12 +0100228 */
Zhang Rui203d3d42008-01-17 15:51:08 +0800229struct thermal_zone_device {
230 int id;
231 char type[THERMAL_NAME_LENGTH];
232 struct device device;
Durgadoss Rc56f5c02012-07-25 10:10:58 +0800233 struct thermal_attr *trip_temp_attrs;
234 struct thermal_attr *trip_type_attrs;
Durgadoss R27365a62012-07-25 10:10:59 +0800235 struct thermal_attr *trip_hyst_attrs;
Zhang Rui203d3d42008-01-17 15:51:08 +0800236 void *devdata;
237 int trips;
Zhang Rui81ad4272016-03-18 10:03:24 +0800238 unsigned long trips_disabled; /* bitmap for disabled trips */
Matthew Garrettb1569e92008-12-03 17:55:32 +0000239 int passive_delay;
240 int polling_delay;
Zhang Rui601f3d42012-06-27 09:54:33 +0800241 int temperature;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000242 int last_temperature;
Amit Daniel Kachhape6e238c2013-02-04 00:30:15 +0000243 int emul_temperature;
Zhang Rui908b9fb2012-06-27 14:14:05 +0800244 int passive;
Sascha Hauer060c0342016-06-22 16:42:01 +0800245 int prev_low_trip;
246 int prev_high_trip;
Matthew Garrett03a971a2008-12-03 18:00:38 +0000247 unsigned int forced_passive;
Chen Yu4511f712015-10-30 16:32:10 +0800248 atomic_t need_update;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400249 struct thermal_zone_device_ops *ops;
Javi Merino6b775e82015-03-02 17:17:19 +0000250 struct thermal_zone_params *tzp;
Durgadoss Ra4a15482012-09-18 11:04:57 +0530251 struct thermal_governor *governor;
Javi Merinoe33df1d2015-02-26 19:00:27 +0000252 void *governor_data;
Zhang Rui2d374132012-06-27 10:09:00 +0800253 struct list_head thermal_instances;
Zhang Rui203d3d42008-01-17 15:51:08 +0800254 struct idr idr;
Javi Merinoc708a982014-06-25 11:00:12 +0100255 struct mutex lock;
Zhang Rui203d3d42008-01-17 15:51:08 +0800256 struct list_head node;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000257 struct delayed_work poll_queue;
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700258 enum thermal_notify_event notify_event;
Zhang Rui203d3d42008-01-17 15:51:08 +0800259};
R.Durgadoss4cb18722010-10-27 03:33:29 +0530260
Javi Merinoc708a982014-06-25 11:00:12 +0100261/**
262 * struct thermal_governor - structure that holds thermal governor information
263 * @name: name of the governor
Javi Merinoe33df1d2015-02-26 19:00:27 +0000264 * @bind_to_tz: callback called when binding to a thermal zone. If it
265 * returns 0, the governor is bound to the thermal zone,
266 * otherwise it fails.
267 * @unbind_from_tz: callback called when a governor is unbound from a
268 * thermal zone.
Javi Merinoc708a982014-06-25 11:00:12 +0100269 * @throttle: callback called for every trip point even if temperature is
270 * below the trip point temperature
271 * @governor_list: node in thermal_governor_list (in thermal_core.c)
272 */
Durgadoss Ra4a15482012-09-18 11:04:57 +0530273struct thermal_governor {
274 char name[THERMAL_NAME_LENGTH];
Javi Merinoe33df1d2015-02-26 19:00:27 +0000275 int (*bind_to_tz)(struct thermal_zone_device *tz);
276 void (*unbind_from_tz)(struct thermal_zone_device *tz);
Durgadoss Ra4a15482012-09-18 11:04:57 +0530277 int (*throttle)(struct thermal_zone_device *tz, int trip);
278 struct list_head governor_list;
Ram Chandrasekarbd155702017-03-17 16:42:15 -0600279 int min_state_throttle;
Durgadoss Ra4a15482012-09-18 11:04:57 +0530280};
281
Durgadoss Ref873942012-09-18 11:04:55 +0530282/* Structure that holds binding parameters for a zone */
283struct thermal_bind_params {
284 struct thermal_cooling_device *cdev;
285
286 /*
287 * This is a measure of 'how effectively these devices can
Javi Merinobcdcbbc2015-02-18 16:04:25 +0000288 * cool 'this' thermal zone. It shall be determined by
289 * platform characterization. This value is relative to the
290 * rest of the weights so a cooling device whose weight is
291 * double that of another cooling device is twice as
292 * effective. See Documentation/thermal/sysfs-api.txt for more
293 * information.
Durgadoss Ref873942012-09-18 11:04:55 +0530294 */
295 int weight;
296
297 /*
298 * This is a bit mask that gives the binding relation between this
299 * thermal zone and cdev, for a particular trip point.
300 * See Documentation/thermal/sysfs-api.txt for more information.
301 */
302 int trip_mask;
Eduardo Valentina8892d832013-07-16 15:26:28 -0400303
304 /*
305 * This is an array of cooling state limits. Must have exactly
306 * 2 * thermal_zone.number_of_trip_points. It is an array consisting
307 * of tuples <lower-state upper-state> of state limits. Each trip
308 * will be associated with one state limit tuple when binding.
309 * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
310 * on all trips.
311 */
312 unsigned long *binding_limits;
Durgadoss Ref873942012-09-18 11:04:55 +0530313 int (*match) (struct thermal_zone_device *tz,
314 struct thermal_cooling_device *cdev);
315};
316
317/* Structure to define Thermal Zone parameters */
318struct thermal_zone_params {
Durgadoss Ra4a15482012-09-18 11:04:57 +0530319 char governor_name[THERMAL_NAME_LENGTH];
Eduardo Valentinccba4ff2013-08-15 11:34:17 -0400320
321 /*
322 * a boolean to indicate if the thermal to hwmon sysfs interface
323 * is required. when no_hwmon == false, a hwmon sysfs interface
324 * will be created. when no_hwmon == true, nothing will be done
325 */
326 bool no_hwmon;
327
Durgadoss Ref873942012-09-18 11:04:55 +0530328 int num_tbps; /* Number of tbp entries */
329 struct thermal_bind_params *tbp;
Javi Merino6b775e82015-03-02 17:17:19 +0000330
331 /*
332 * Sustainable power (heat) that this thermal zone can dissipate in
333 * mW
334 */
335 u32 sustainable_power;
336
337 /*
338 * Proportional parameter of the PID controller when
339 * overshooting (i.e., when temperature is below the target)
340 */
341 s32 k_po;
342
343 /*
344 * Proportional parameter of the PID controller when
345 * undershooting
346 */
347 s32 k_pu;
348
349 /* Integral parameter of the PID controller */
350 s32 k_i;
351
352 /* Derivative parameter of the PID controller */
353 s32 k_d;
354
355 /* threshold below which the error is no longer accumulated */
356 s32 integral_cutoff;
Eduardo Valentin9d0be7f2015-05-11 19:34:23 -0700357
358 /*
359 * @slope: slope of a linear temperature adjustment curve.
360 * Used by thermal zone drivers.
361 */
362 int slope;
363 /*
364 * @offset: offset of a linear temperature adjustment curve.
365 * Used by thermal zone drivers (default 0).
366 */
367 int offset;
Lina Iyer159f67d2016-07-27 11:34:46 -0600368
369 /*
370 * @tracks_low: Indicates that the thermal zone params are for
371 * temperatures falling below the thresholds.
372 */
373 bool tracks_low;
Durgadoss Ref873942012-09-18 11:04:55 +0530374};
375
R.Durgadoss4cb18722010-10-27 03:33:29 +0530376struct thermal_genl_event {
377 u32 orig;
378 enum events event;
379};
R.Durgadoss4cb18722010-10-27 03:33:29 +0530380
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400381/**
382 * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones
383 *
384 * Mandatory:
385 * @get_temp: a pointer to a function that reads the sensor temperature.
386 *
387 * Optional:
388 * @get_trend: a pointer to a function that reads the sensor temperature trend.
Sascha Hauer826386e2016-06-22 16:42:02 +0800389 * @set_trips: a pointer to a function that sets a temperature window. When
390 * this window is left the driver must inform the thermal core via
391 * thermal_zone_device_update.
Lukasz Majewski184a4bf2014-12-08 18:04:21 +0100392 * @set_emul_temp: a pointer to a function that sets sensor emulated
393 * temperature.
Caesar Wang5a5e78c2016-05-18 23:01:39 +0800394 * @set_trip_temp: a pointer to a function that sets the trip temperature on
395 * hardware.
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400396 */
397struct thermal_zone_of_device_ops {
Sascha Hauer17e83512015-07-24 08:12:54 +0200398 int (*get_temp)(void *, int *);
Sascha Hauere78eaf42016-06-22 16:42:03 +0800399 int (*get_trend)(void *, int, enum thermal_trend *);
Sascha Hauer826386e2016-06-22 16:42:02 +0800400 int (*set_trips)(void *, int, int);
Sascha Hauer17e83512015-07-24 08:12:54 +0200401 int (*set_emul_temp)(void *, int);
Wei Nic3509522016-03-29 18:29:17 +0800402 int (*set_trip_temp)(void *, int, int);
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400403};
404
Lukasz Majewskiad9914a2014-12-08 18:04:19 +0100405/**
406 * struct thermal_trip - representation of a point in temperature domain
407 * @np: pointer to struct device_node that this trip point was created from
408 * @temperature: temperature value in miliCelsius
409 * @hysteresis: relative hysteresis in miliCelsius
410 * @type: trip point type
411 */
412
413struct thermal_trip {
414 struct device_node *np;
Wei Ni1d0fd422016-03-03 17:33:46 +0800415 int temperature;
416 int hysteresis;
Lukasz Majewskiad9914a2014-12-08 18:04:19 +0100417 enum thermal_trip_type type;
418};
419
Ram Chandrasekar2f2b7462017-03-11 19:35:11 -0700420/* Different aggregation logic supported for virtual sensors */
421enum aggregation_logic {
422 VIRT_WEIGHTED_AVG,
423 VIRT_MAXIMUM,
424 VIRT_MINIMUM,
425 VIRT_AGGREGATION_NR,
426};
427
428/*
429 * struct virtual_sensor_data - Data structure used to provide
430 * information about the virtual zone.
431 * @virt_zone_name - Virtual thermal zone name
432 * @num_sensors - Number of sensors this virtual zone uses to compute
433 * temperature
434 * @sensor_names - Array of sensor names
435 * @logic - Temperature aggregation logic to be used
436 * @coefficients - Coefficients to be used for weighted average logic
437 * @coefficient_ct - number of coefficients provided as input
438 * @avg_offset - offset value to be used for the weighted aggregation logic
439 * @avg_denominator - denominator value to be used for the weighted aggregation
440 * logic
441 */
442struct virtual_sensor_data {
443 int num_sensors;
444 char virt_zone_name[THERMAL_NAME_LENGTH];
445 char *sensor_names[THERMAL_MAX_VIRT_SENSORS];
446 enum aggregation_logic logic;
447 int coefficients[THERMAL_MAX_VIRT_SENSORS];
448 int coefficient_ct;
449 int avg_offset;
450 int avg_denominator;
451};
452
Durgadoss R23064082012-09-18 11:04:52 +0530453/* Function declarations */
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400454#ifdef CONFIG_THERMAL_OF
455struct thermal_zone_device *
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400456thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
457 const struct thermal_zone_of_device_ops *ops);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400458void thermal_zone_of_sensor_unregister(struct device *dev,
459 struct thermal_zone_device *tz);
Laxman Dewangane498b492016-03-09 18:40:06 +0530460struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
461 struct device *dev, int id, void *data,
462 const struct thermal_zone_of_device_ops *ops);
463void devm_thermal_zone_of_sensor_unregister(struct device *dev,
464 struct thermal_zone_device *tz);
Ram Chandrasekar2f2b7462017-03-11 19:35:11 -0700465struct thermal_zone_device *devm_thermal_of_virtual_sensor_register(
466 struct device *dev,
467 const struct virtual_sensor_data *sensor_data);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400468#else
469static inline struct thermal_zone_device *
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400470thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
471 const struct thermal_zone_of_device_ops *ops)
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400472{
Punit Agrawalcd33dc92015-09-08 14:51:12 +0100473 return ERR_PTR(-ENODEV);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400474}
475
476static inline
477void thermal_zone_of_sensor_unregister(struct device *dev,
478 struct thermal_zone_device *tz)
479{
480}
481
Laxman Dewangane498b492016-03-09 18:40:06 +0530482static inline struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
483 struct device *dev, int id, void *data,
484 const struct thermal_zone_of_device_ops *ops)
485{
486 return ERR_PTR(-ENODEV);
487}
488
489static inline
490void devm_thermal_zone_of_sensor_unregister(struct device *dev,
491 struct thermal_zone_device *tz)
492{
493}
494
Ram Chandrasekar2f2b7462017-03-11 19:35:11 -0700495static inline
496struct thermal_zone_device *devm_thermal_of_virtual_sensor_register(
497 struct device *dev,
498 const struct virtual_sensor_data *sensor_data)
499{
500 return ERR_PTR(-ENODEV);
501}
502
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400503#endif
Nishanth Menon12ca7182015-02-13 19:28:02 -0600504
505#if IS_ENABLED(CONFIG_THERMAL)
Javi Merino35b11d22015-02-26 19:00:28 +0000506static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
507{
508 return cdev->ops->get_requested_power && cdev->ops->state2power &&
509 cdev->ops->power2state;
510}
511
512int power_actor_get_max_power(struct thermal_cooling_device *,
513 struct thermal_zone_device *tz, u32 *max_power);
Javi Merinoc973c3b2015-09-14 14:23:50 +0100514int power_actor_get_min_power(struct thermal_cooling_device *,
515 struct thermal_zone_device *tz, u32 *min_power);
Javi Merino35b11d22015-02-26 19:00:28 +0000516int power_actor_set_power(struct thermal_cooling_device *,
517 struct thermal_instance *, u32);
Anton Vorontsov4b1bf582012-07-31 04:39:30 -0700518struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400519 void *, struct thermal_zone_device_ops *,
Javi Merino6b775e82015-03-02 17:17:19 +0000520 struct thermal_zone_params *, int, int);
Zhang Rui203d3d42008-01-17 15:51:08 +0800521void thermal_zone_device_unregister(struct thermal_zone_device *);
522
523int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
Zhang Rui9d998422012-06-26 16:35:57 +0800524 struct thermal_cooling_device *,
Kapileshwar Singh6cd9e9f2015-02-18 16:04:21 +0000525 unsigned long, unsigned long,
526 unsigned int);
Zhang Rui203d3d42008-01-17 15:51:08 +0800527int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
528 struct thermal_cooling_device *);
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700529void thermal_zone_device_update(struct thermal_zone_device *,
530 enum thermal_notify_event);
Sascha Hauer060c0342016-06-22 16:42:01 +0800531void thermal_zone_set_trips(struct thermal_zone_device *);
Durgadoss R23064082012-09-18 11:04:52 +0530532
Zhang Rui203d3d42008-01-17 15:51:08 +0800533struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
Alan Cox5b275ce2010-11-11 15:27:29 +0000534 const struct thermal_cooling_device_ops *);
Eduardo Valentina116b5d2013-09-26 15:55:01 -0400535struct thermal_cooling_device *
536thermal_of_cooling_device_register(struct device_node *np, char *, void *,
537 const struct thermal_cooling_device_ops *);
Zhang Rui203d3d42008-01-17 15:51:08 +0800538void thermal_cooling_device_unregister(struct thermal_cooling_device *);
Eduardo Valentin63c4d912013-04-05 12:32:28 +0000539struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
Sascha Hauer17e83512015-07-24 08:12:54 +0200540int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp);
Rajendra Nayak4a7069a2016-05-05 14:21:42 +0530541int thermal_zone_get_slope(struct thermal_zone_device *tz);
542int thermal_zone_get_offset(struct thermal_zone_device *tz);
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100543
Durgadoss R9b4298a2012-09-18 11:04:54 +0530544int get_tz_trend(struct thermal_zone_device *, int);
545struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
546 struct thermal_cooling_device *, int);
Durgadoss Rdc765482012-09-18 11:05:00 +0530547void thermal_cdev_update(struct thermal_cooling_device *);
Eduardo Valentin7b73c992013-04-23 21:48:14 +0000548void thermal_notify_framework(struct thermal_zone_device *, int);
Nishanth Menon12ca7182015-02-13 19:28:02 -0600549#else
Javi Merino35b11d22015-02-26 19:00:28 +0000550static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
551{ return false; }
552static inline int power_actor_get_max_power(struct thermal_cooling_device *cdev,
553 struct thermal_zone_device *tz, u32 *max_power)
554{ return 0; }
Javi Merinoc973c3b2015-09-14 14:23:50 +0100555static inline int power_actor_get_min_power(struct thermal_cooling_device *cdev,
556 struct thermal_zone_device *tz,
557 u32 *min_power)
558{ return -ENODEV; }
Javi Merino35b11d22015-02-26 19:00:28 +0000559static inline int power_actor_set_power(struct thermal_cooling_device *cdev,
560 struct thermal_instance *tz, u32 power)
561{ return 0; }
Nishanth Menon12ca7182015-02-13 19:28:02 -0600562static inline struct thermal_zone_device *thermal_zone_device_register(
563 const char *type, int trips, int mask, void *devdata,
564 struct thermal_zone_device_ops *ops,
565 const struct thermal_zone_params *tzp,
566 int passive_delay, int polling_delay)
567{ return ERR_PTR(-ENODEV); }
568static inline void thermal_zone_device_unregister(
569 struct thermal_zone_device *tz)
570{ }
571static inline int thermal_zone_bind_cooling_device(
572 struct thermal_zone_device *tz, int trip,
573 struct thermal_cooling_device *cdev,
Arnd Bergmannc86b3de2015-11-17 17:48:52 +0100574 unsigned long upper, unsigned long lower,
575 unsigned int weight)
Nishanth Menon12ca7182015-02-13 19:28:02 -0600576{ return -ENODEV; }
577static inline int thermal_zone_unbind_cooling_device(
578 struct thermal_zone_device *tz, int trip,
579 struct thermal_cooling_device *cdev)
580{ return -ENODEV; }
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700581static inline void thermal_zone_device_update(struct thermal_zone_device *tz,
582 enum thermal_notify_event event)
Nishanth Menon12ca7182015-02-13 19:28:02 -0600583{ }
Sascha Hauer060c0342016-06-22 16:42:01 +0800584static inline void thermal_zone_set_trips(struct thermal_zone_device *tz)
585{ }
Nishanth Menon12ca7182015-02-13 19:28:02 -0600586static inline struct thermal_cooling_device *
587thermal_cooling_device_register(char *type, void *devdata,
588 const struct thermal_cooling_device_ops *ops)
589{ return ERR_PTR(-ENODEV); }
590static inline struct thermal_cooling_device *
591thermal_of_cooling_device_register(struct device_node *np,
592 char *type, void *devdata, const struct thermal_cooling_device_ops *ops)
593{ return ERR_PTR(-ENODEV); }
594static inline void thermal_cooling_device_unregister(
595 struct thermal_cooling_device *cdev)
596{ }
597static inline struct thermal_zone_device *thermal_zone_get_zone_by_name(
598 const char *name)
599{ return ERR_PTR(-ENODEV); }
600static inline int thermal_zone_get_temp(
Sascha Hauer17e83512015-07-24 08:12:54 +0200601 struct thermal_zone_device *tz, int *temp)
Nishanth Menon12ca7182015-02-13 19:28:02 -0600602{ return -ENODEV; }
Rajendra Nayak4a7069a2016-05-05 14:21:42 +0530603static inline int thermal_zone_get_slope(
604 struct thermal_zone_device *tz)
605{ return -ENODEV; }
606static inline int thermal_zone_get_offset(
607 struct thermal_zone_device *tz)
608{ return -ENODEV; }
Nishanth Menon12ca7182015-02-13 19:28:02 -0600609static inline int get_tz_trend(struct thermal_zone_device *tz, int trip)
610{ return -ENODEV; }
611static inline struct thermal_instance *
612get_thermal_instance(struct thermal_zone_device *tz,
613 struct thermal_cooling_device *cdev, int trip)
614{ return ERR_PTR(-ENODEV); }
615static inline void thermal_cdev_update(struct thermal_cooling_device *cdev)
616{ }
617static inline void thermal_notify_framework(struct thermal_zone_device *tz,
618 int trip)
619{ }
620#endif /* CONFIG_THERMAL */
Durgadoss Ra4a15482012-09-18 11:04:57 +0530621
Nishanth Menon12ca7182015-02-13 19:28:02 -0600622#if defined(CONFIG_NET) && IS_ENABLED(CONFIG_THERMAL)
Eduardo Valentin8ab3e6a2013-01-02 15:29:39 +0000623extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
624 enum events event);
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100625#else
Ezequiel Garciaf8b58702013-03-20 21:38:07 +0000626static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
Eduardo Valentin8ab3e6a2013-01-02 15:29:39 +0000627 enum events event)
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100628{
629 return 0;
630}
631#endif
Zhang Rui203d3d42008-01-17 15:51:08 +0800632
Len Browna0dd25b2008-02-09 04:01:48 -0500633#endif /* __THERMAL_H__ */