blob: 3306dd1da848c6768bd806ab8492ed90c2f15619 [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 Pallikunhi4291fee2018-01-02 17:01:23 +053050#define THERMAL_MAX_VIRT_SENSORS 10
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);
Manaf Meethalavalappu Pallikunhi11175e32019-02-14 18:03:00 +0530151 bool (*is_wakeable)(struct thermal_zone_device *);
Zhang Rui203d3d42008-01-17 15:51:08 +0800152};
153
154struct thermal_cooling_device_ops {
Matthew Garrett6503e5d2008-11-27 17:48:13 +0000155 int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
156 int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
157 int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
Ram Chandrasekarbd155702017-03-17 16:42:15 -0600158 int (*set_min_state)(struct thermal_cooling_device *, unsigned long);
159 int (*get_min_state)(struct thermal_cooling_device *, unsigned long *);
Javi Merino35b11d22015-02-26 19:00:28 +0000160 int (*get_requested_power)(struct thermal_cooling_device *,
161 struct thermal_zone_device *, u32 *);
162 int (*state2power)(struct thermal_cooling_device *,
163 struct thermal_zone_device *, unsigned long, u32 *);
164 int (*power2state)(struct thermal_cooling_device *,
165 struct thermal_zone_device *, u32, unsigned long *);
Zhang Rui203d3d42008-01-17 15:51:08 +0800166};
167
Zhang Rui203d3d42008-01-17 15:51:08 +0800168struct thermal_cooling_device {
169 int id;
170 char type[THERMAL_NAME_LENGTH];
171 struct device device;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400172 struct device_node *np;
Zhang Rui203d3d42008-01-17 15:51:08 +0800173 void *devdata;
Alan Cox5b275ce2010-11-11 15:27:29 +0000174 const struct thermal_cooling_device_ops *ops;
Zhang Ruice119f82012-06-27 14:13:04 +0800175 bool updated; /* true if the cooling device does not need update */
Zhang Ruif4a821c2012-07-24 16:56:21 +0800176 struct mutex lock; /* protect thermal_instances list */
Zhang Ruib5e4ae62012-06-27 14:11:52 +0800177 struct list_head thermal_instances;
Zhang Rui203d3d42008-01-17 15:51:08 +0800178 struct list_head node;
Ram Chandrasekar5ab1c082016-09-20 17:09:28 -0600179 unsigned long sysfs_cur_state_req;
180 unsigned long sysfs_min_state_req;
Zhang Rui203d3d42008-01-17 15:51:08 +0800181};
182
Durgadoss Rc56f5c02012-07-25 10:10:58 +0800183struct thermal_attr {
184 struct device_attribute attr;
185 char name[THERMAL_NAME_LENGTH];
186};
187
Javi Merinoc708a982014-06-25 11:00:12 +0100188/**
189 * struct thermal_zone_device - structure for a thermal zone
190 * @id: unique id number for each thermal zone
191 * @type: the thermal zone device type
192 * @device: &struct device for this thermal zone
193 * @trip_temp_attrs: attributes for trip points for sysfs: trip temperature
194 * @trip_type_attrs: attributes for trip points for sysfs: trip type
195 * @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis
196 * @devdata: private pointer for device private data
197 * @trips: number of trip points the thermal zone supports
Zhang Rui81ad4272016-03-18 10:03:24 +0800198 * @trips_disabled; bitmap for disabled trips
Javi Merinoc708a982014-06-25 11:00:12 +0100199 * @passive_delay: number of milliseconds to wait between polls when
Javi Merino6b775e82015-03-02 17:17:19 +0000200 * performing passive cooling.
Javi Merinoc708a982014-06-25 11:00:12 +0100201 * @polling_delay: number of milliseconds to wait between polls when
202 * checking whether trip points have been crossed (0 for
203 * interrupt driven systems)
204 * @temperature: current temperature. This is only for core code,
205 * drivers should use thermal_zone_get_temp() to get the
206 * current temperature
207 * @last_temperature: previous temperature read
208 * @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION
209 * @passive: 1 if you've crossed a passive trip point, 0 otherwise.
Sascha Hauer060c0342016-06-22 16:42:01 +0800210 * @prev_low_trip: the low current temperature if you've crossed a passive
211 trip point.
212 * @prev_high_trip: the above current temperature if you've crossed a
213 passive trip point.
Javi Merinoc708a982014-06-25 11:00:12 +0100214 * @forced_passive: If > 0, temperature at which to switch on all ACPI
215 * processor cooling devices. Currently only used by the
216 * step-wise governor.
Chen Yu4511f712015-10-30 16:32:10 +0800217 * @need_update: if equals 1, thermal_zone_device_update needs to be invoked.
Javi Merinoc708a982014-06-25 11:00:12 +0100218 * @ops: operations this &thermal_zone_device supports
219 * @tzp: thermal zone parameters
220 * @governor: pointer to the governor for this thermal zone
Javi Merinoe33df1d2015-02-26 19:00:27 +0000221 * @governor_data: private pointer for governor data
Javi Merinoc708a982014-06-25 11:00:12 +0100222 * @thermal_instances: list of &struct thermal_instance of this thermal zone
223 * @idr: &struct idr to generate unique id for this zone's cooling
224 * devices
225 * @lock: lock to protect thermal_instances list
226 * @node: node in thermal_tz_list (in thermal_core.c)
227 * @poll_queue: delayed work for polling
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700228 * @notify_event: Last notification event
Javi Merinoc708a982014-06-25 11:00:12 +0100229 */
Zhang Rui203d3d42008-01-17 15:51:08 +0800230struct thermal_zone_device {
231 int id;
232 char type[THERMAL_NAME_LENGTH];
233 struct device device;
Durgadoss Rc56f5c02012-07-25 10:10:58 +0800234 struct thermal_attr *trip_temp_attrs;
235 struct thermal_attr *trip_type_attrs;
Durgadoss R27365a62012-07-25 10:10:59 +0800236 struct thermal_attr *trip_hyst_attrs;
Zhang Rui203d3d42008-01-17 15:51:08 +0800237 void *devdata;
238 int trips;
Zhang Rui81ad4272016-03-18 10:03:24 +0800239 unsigned long trips_disabled; /* bitmap for disabled trips */
Matthew Garrettb1569e92008-12-03 17:55:32 +0000240 int passive_delay;
241 int polling_delay;
Zhang Rui601f3d42012-06-27 09:54:33 +0800242 int temperature;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000243 int last_temperature;
Amit Daniel Kachhape6e238c2013-02-04 00:30:15 +0000244 int emul_temperature;
Zhang Rui908b9fb2012-06-27 14:14:05 +0800245 int passive;
Sascha Hauer060c0342016-06-22 16:42:01 +0800246 int prev_low_trip;
247 int prev_high_trip;
Matthew Garrett03a971a2008-12-03 18:00:38 +0000248 unsigned int forced_passive;
Chen Yu4511f712015-10-30 16:32:10 +0800249 atomic_t need_update;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400250 struct thermal_zone_device_ops *ops;
Javi Merino6b775e82015-03-02 17:17:19 +0000251 struct thermal_zone_params *tzp;
Durgadoss Ra4a15482012-09-18 11:04:57 +0530252 struct thermal_governor *governor;
Javi Merinoe33df1d2015-02-26 19:00:27 +0000253 void *governor_data;
Zhang Rui2d374132012-06-27 10:09:00 +0800254 struct list_head thermal_instances;
Zhang Rui203d3d42008-01-17 15:51:08 +0800255 struct idr idr;
Javi Merinoc708a982014-06-25 11:00:12 +0100256 struct mutex lock;
Zhang Rui203d3d42008-01-17 15:51:08 +0800257 struct list_head node;
Matthew Garrettb1569e92008-12-03 17:55:32 +0000258 struct delayed_work poll_queue;
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700259 enum thermal_notify_event notify_event;
Zhang Rui203d3d42008-01-17 15:51:08 +0800260};
R.Durgadoss4cb18722010-10-27 03:33:29 +0530261
Javi Merinoc708a982014-06-25 11:00:12 +0100262/**
263 * struct thermal_governor - structure that holds thermal governor information
264 * @name: name of the governor
Javi Merinoe33df1d2015-02-26 19:00:27 +0000265 * @bind_to_tz: callback called when binding to a thermal zone. If it
266 * returns 0, the governor is bound to the thermal zone,
267 * otherwise it fails.
268 * @unbind_from_tz: callback called when a governor is unbound from a
269 * thermal zone.
Javi Merinoc708a982014-06-25 11:00:12 +0100270 * @throttle: callback called for every trip point even if temperature is
271 * below the trip point temperature
272 * @governor_list: node in thermal_governor_list (in thermal_core.c)
273 */
Durgadoss Ra4a15482012-09-18 11:04:57 +0530274struct thermal_governor {
275 char name[THERMAL_NAME_LENGTH];
Javi Merinoe33df1d2015-02-26 19:00:27 +0000276 int (*bind_to_tz)(struct thermal_zone_device *tz);
277 void (*unbind_from_tz)(struct thermal_zone_device *tz);
Durgadoss Ra4a15482012-09-18 11:04:57 +0530278 int (*throttle)(struct thermal_zone_device *tz, int trip);
279 struct list_head governor_list;
Ram Chandrasekarbd155702017-03-17 16:42:15 -0600280 int min_state_throttle;
Durgadoss Ra4a15482012-09-18 11:04:57 +0530281};
282
Durgadoss Ref873942012-09-18 11:04:55 +0530283/* Structure that holds binding parameters for a zone */
284struct thermal_bind_params {
285 struct thermal_cooling_device *cdev;
286
287 /*
288 * This is a measure of 'how effectively these devices can
Javi Merinobcdcbbc2015-02-18 16:04:25 +0000289 * cool 'this' thermal zone. It shall be determined by
290 * platform characterization. This value is relative to the
291 * rest of the weights so a cooling device whose weight is
292 * double that of another cooling device is twice as
293 * effective. See Documentation/thermal/sysfs-api.txt for more
294 * information.
Durgadoss Ref873942012-09-18 11:04:55 +0530295 */
296 int weight;
297
298 /*
299 * This is a bit mask that gives the binding relation between this
300 * thermal zone and cdev, for a particular trip point.
301 * See Documentation/thermal/sysfs-api.txt for more information.
302 */
303 int trip_mask;
Eduardo Valentina8892d832013-07-16 15:26:28 -0400304
305 /*
306 * This is an array of cooling state limits. Must have exactly
307 * 2 * thermal_zone.number_of_trip_points. It is an array consisting
308 * of tuples <lower-state upper-state> of state limits. Each trip
309 * will be associated with one state limit tuple when binding.
310 * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
311 * on all trips.
312 */
313 unsigned long *binding_limits;
Durgadoss Ref873942012-09-18 11:04:55 +0530314 int (*match) (struct thermal_zone_device *tz,
315 struct thermal_cooling_device *cdev);
316};
317
318/* Structure to define Thermal Zone parameters */
319struct thermal_zone_params {
Durgadoss Ra4a15482012-09-18 11:04:57 +0530320 char governor_name[THERMAL_NAME_LENGTH];
Eduardo Valentinccba4ff2013-08-15 11:34:17 -0400321
322 /*
323 * a boolean to indicate if the thermal to hwmon sysfs interface
324 * is required. when no_hwmon == false, a hwmon sysfs interface
325 * will be created. when no_hwmon == true, nothing will be done
326 */
327 bool no_hwmon;
328
Durgadoss Ref873942012-09-18 11:04:55 +0530329 int num_tbps; /* Number of tbp entries */
330 struct thermal_bind_params *tbp;
Javi Merino6b775e82015-03-02 17:17:19 +0000331
332 /*
333 * Sustainable power (heat) that this thermal zone can dissipate in
334 * mW
335 */
336 u32 sustainable_power;
337
338 /*
339 * Proportional parameter of the PID controller when
340 * overshooting (i.e., when temperature is below the target)
341 */
342 s32 k_po;
343
344 /*
345 * Proportional parameter of the PID controller when
346 * undershooting
347 */
348 s32 k_pu;
349
350 /* Integral parameter of the PID controller */
351 s32 k_i;
352
353 /* Derivative parameter of the PID controller */
354 s32 k_d;
355
356 /* threshold below which the error is no longer accumulated */
357 s32 integral_cutoff;
Eduardo Valentin9d0be7f2015-05-11 19:34:23 -0700358
359 /*
360 * @slope: slope of a linear temperature adjustment curve.
361 * Used by thermal zone drivers.
362 */
363 int slope;
364 /*
365 * @offset: offset of a linear temperature adjustment curve.
366 * Used by thermal zone drivers (default 0).
367 */
368 int offset;
Lina Iyer159f67d2016-07-27 11:34:46 -0600369
370 /*
371 * @tracks_low: Indicates that the thermal zone params are for
372 * temperatures falling below the thresholds.
373 */
374 bool tracks_low;
Durgadoss Ref873942012-09-18 11:04:55 +0530375};
376
R.Durgadoss4cb18722010-10-27 03:33:29 +0530377struct thermal_genl_event {
378 u32 orig;
379 enum events event;
380};
R.Durgadoss4cb18722010-10-27 03:33:29 +0530381
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400382/**
383 * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones
384 *
385 * Mandatory:
386 * @get_temp: a pointer to a function that reads the sensor temperature.
387 *
388 * Optional:
389 * @get_trend: a pointer to a function that reads the sensor temperature trend.
Sascha Hauer826386e2016-06-22 16:42:02 +0800390 * @set_trips: a pointer to a function that sets a temperature window. When
391 * this window is left the driver must inform the thermal core via
392 * thermal_zone_device_update.
Lukasz Majewski184a4bf2014-12-08 18:04:21 +0100393 * @set_emul_temp: a pointer to a function that sets sensor emulated
394 * temperature.
Caesar Wang5a5e78c2016-05-18 23:01:39 +0800395 * @set_trip_temp: a pointer to a function that sets the trip temperature on
396 * hardware.
Ram Chandrasekar32e8bfd2018-02-06 17:12:04 -0700397 * @get_trip_temp: a pointer to a function that gets the trip temperature on
398 * hardware.
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400399 */
400struct thermal_zone_of_device_ops {
Sascha Hauer17e83512015-07-24 08:12:54 +0200401 int (*get_temp)(void *, int *);
Sascha Hauere78eaf42016-06-22 16:42:03 +0800402 int (*get_trend)(void *, int, enum thermal_trend *);
Sascha Hauer826386e2016-06-22 16:42:02 +0800403 int (*set_trips)(void *, int, int);
Sascha Hauer17e83512015-07-24 08:12:54 +0200404 int (*set_emul_temp)(void *, int);
Wei Nic3509522016-03-29 18:29:17 +0800405 int (*set_trip_temp)(void *, int, int);
Ram Chandrasekar32e8bfd2018-02-06 17:12:04 -0700406 int (*get_trip_temp)(void *, int, int *);
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400407};
408
Lukasz Majewskiad9914a2014-12-08 18:04:19 +0100409/**
410 * struct thermal_trip - representation of a point in temperature domain
411 * @np: pointer to struct device_node that this trip point was created from
412 * @temperature: temperature value in miliCelsius
413 * @hysteresis: relative hysteresis in miliCelsius
414 * @type: trip point type
415 */
416
417struct thermal_trip {
418 struct device_node *np;
Wei Ni1d0fd422016-03-03 17:33:46 +0800419 int temperature;
420 int hysteresis;
Lukasz Majewskiad9914a2014-12-08 18:04:19 +0100421 enum thermal_trip_type type;
422};
423
Ram Chandrasekar2f2b7462017-03-11 19:35:11 -0700424/* Different aggregation logic supported for virtual sensors */
425enum aggregation_logic {
426 VIRT_WEIGHTED_AVG,
427 VIRT_MAXIMUM,
428 VIRT_MINIMUM,
429 VIRT_AGGREGATION_NR,
430};
431
432/*
433 * struct virtual_sensor_data - Data structure used to provide
434 * information about the virtual zone.
435 * @virt_zone_name - Virtual thermal zone name
436 * @num_sensors - Number of sensors this virtual zone uses to compute
437 * temperature
438 * @sensor_names - Array of sensor names
439 * @logic - Temperature aggregation logic to be used
440 * @coefficients - Coefficients to be used for weighted average logic
441 * @coefficient_ct - number of coefficients provided as input
442 * @avg_offset - offset value to be used for the weighted aggregation logic
443 * @avg_denominator - denominator value to be used for the weighted aggregation
444 * logic
445 */
446struct virtual_sensor_data {
447 int num_sensors;
448 char virt_zone_name[THERMAL_NAME_LENGTH];
449 char *sensor_names[THERMAL_MAX_VIRT_SENSORS];
450 enum aggregation_logic logic;
451 int coefficients[THERMAL_MAX_VIRT_SENSORS];
452 int coefficient_ct;
453 int avg_offset;
454 int avg_denominator;
455};
456
Durgadoss R23064082012-09-18 11:04:52 +0530457/* Function declarations */
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400458#ifdef CONFIG_THERMAL_OF
459struct thermal_zone_device *
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400460thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
461 const struct thermal_zone_of_device_ops *ops);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400462void thermal_zone_of_sensor_unregister(struct device *dev,
463 struct thermal_zone_device *tz);
Laxman Dewangane498b492016-03-09 18:40:06 +0530464struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
465 struct device *dev, int id, void *data,
466 const struct thermal_zone_of_device_ops *ops);
467void devm_thermal_zone_of_sensor_unregister(struct device *dev,
468 struct thermal_zone_device *tz);
Ram Chandrasekar2f2b7462017-03-11 19:35:11 -0700469struct thermal_zone_device *devm_thermal_of_virtual_sensor_register(
470 struct device *dev,
471 const struct virtual_sensor_data *sensor_data);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400472#else
473static inline struct thermal_zone_device *
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400474thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
475 const struct thermal_zone_of_device_ops *ops)
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400476{
Punit Agrawalcd33dc92015-09-08 14:51:12 +0100477 return ERR_PTR(-ENODEV);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400478}
479
480static inline
481void thermal_zone_of_sensor_unregister(struct device *dev,
482 struct thermal_zone_device *tz)
483{
484}
485
Laxman Dewangane498b492016-03-09 18:40:06 +0530486static inline struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
487 struct device *dev, int id, void *data,
488 const struct thermal_zone_of_device_ops *ops)
489{
490 return ERR_PTR(-ENODEV);
491}
492
493static inline
494void devm_thermal_zone_of_sensor_unregister(struct device *dev,
495 struct thermal_zone_device *tz)
496{
497}
498
Ram Chandrasekar2f2b7462017-03-11 19:35:11 -0700499static inline
500struct thermal_zone_device *devm_thermal_of_virtual_sensor_register(
501 struct device *dev,
502 const struct virtual_sensor_data *sensor_data)
503{
504 return ERR_PTR(-ENODEV);
505}
506
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400507#endif
Nishanth Menon12ca7182015-02-13 19:28:02 -0600508
509#if IS_ENABLED(CONFIG_THERMAL)
Javi Merino35b11d22015-02-26 19:00:28 +0000510static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
511{
512 return cdev->ops->get_requested_power && cdev->ops->state2power &&
513 cdev->ops->power2state;
514}
515
516int power_actor_get_max_power(struct thermal_cooling_device *,
517 struct thermal_zone_device *tz, u32 *max_power);
Javi Merinoc973c3b2015-09-14 14:23:50 +0100518int power_actor_get_min_power(struct thermal_cooling_device *,
519 struct thermal_zone_device *tz, u32 *min_power);
Javi Merino35b11d22015-02-26 19:00:28 +0000520int power_actor_set_power(struct thermal_cooling_device *,
521 struct thermal_instance *, u32);
Anton Vorontsov4b1bf582012-07-31 04:39:30 -0700522struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400523 void *, struct thermal_zone_device_ops *,
Javi Merino6b775e82015-03-02 17:17:19 +0000524 struct thermal_zone_params *, int, int);
Zhang Rui203d3d42008-01-17 15:51:08 +0800525void thermal_zone_device_unregister(struct thermal_zone_device *);
526
527int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
Zhang Rui9d998422012-06-26 16:35:57 +0800528 struct thermal_cooling_device *,
Kapileshwar Singh6cd9e9f2015-02-18 16:04:21 +0000529 unsigned long, unsigned long,
530 unsigned int);
Zhang Rui203d3d42008-01-17 15:51:08 +0800531int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
532 struct thermal_cooling_device *);
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700533void thermal_zone_device_update(struct thermal_zone_device *,
534 enum thermal_notify_event);
Ram Chandrasekarbae93a62018-11-02 12:23:40 -0600535void thermal_zone_device_update_temp(struct thermal_zone_device *tz,
536 enum thermal_notify_event event, int temp);
Sascha Hauer060c0342016-06-22 16:42:01 +0800537void thermal_zone_set_trips(struct thermal_zone_device *);
Durgadoss R23064082012-09-18 11:04:52 +0530538
Zhang Rui203d3d42008-01-17 15:51:08 +0800539struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
Alan Cox5b275ce2010-11-11 15:27:29 +0000540 const struct thermal_cooling_device_ops *);
Eduardo Valentina116b5d2013-09-26 15:55:01 -0400541struct thermal_cooling_device *
542thermal_of_cooling_device_register(struct device_node *np, char *, void *,
543 const struct thermal_cooling_device_ops *);
Zhang Rui203d3d42008-01-17 15:51:08 +0800544void thermal_cooling_device_unregister(struct thermal_cooling_device *);
Eduardo Valentin63c4d912013-04-05 12:32:28 +0000545struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
Sascha Hauer17e83512015-07-24 08:12:54 +0200546int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp);
Rajendra Nayak4a7069a2016-05-05 14:21:42 +0530547int thermal_zone_get_slope(struct thermal_zone_device *tz);
548int thermal_zone_get_offset(struct thermal_zone_device *tz);
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100549
Durgadoss R9b4298a2012-09-18 11:04:54 +0530550int get_tz_trend(struct thermal_zone_device *, int);
551struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
552 struct thermal_cooling_device *, int);
Durgadoss Rdc765482012-09-18 11:05:00 +0530553void thermal_cdev_update(struct thermal_cooling_device *);
Eduardo Valentin7b73c992013-04-23 21:48:14 +0000554void thermal_notify_framework(struct thermal_zone_device *, int);
Nishanth Menon12ca7182015-02-13 19:28:02 -0600555#else
Javi Merino35b11d22015-02-26 19:00:28 +0000556static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
557{ return false; }
558static inline int power_actor_get_max_power(struct thermal_cooling_device *cdev,
559 struct thermal_zone_device *tz, u32 *max_power)
560{ return 0; }
Javi Merinoc973c3b2015-09-14 14:23:50 +0100561static inline int power_actor_get_min_power(struct thermal_cooling_device *cdev,
562 struct thermal_zone_device *tz,
563 u32 *min_power)
564{ return -ENODEV; }
Javi Merino35b11d22015-02-26 19:00:28 +0000565static inline int power_actor_set_power(struct thermal_cooling_device *cdev,
566 struct thermal_instance *tz, u32 power)
567{ return 0; }
Nishanth Menon12ca7182015-02-13 19:28:02 -0600568static inline struct thermal_zone_device *thermal_zone_device_register(
569 const char *type, int trips, int mask, void *devdata,
570 struct thermal_zone_device_ops *ops,
571 const struct thermal_zone_params *tzp,
572 int passive_delay, int polling_delay)
573{ return ERR_PTR(-ENODEV); }
574static inline void thermal_zone_device_unregister(
575 struct thermal_zone_device *tz)
576{ }
577static inline int thermal_zone_bind_cooling_device(
578 struct thermal_zone_device *tz, int trip,
579 struct thermal_cooling_device *cdev,
Arnd Bergmannc86b3de2015-11-17 17:48:52 +0100580 unsigned long upper, unsigned long lower,
581 unsigned int weight)
Nishanth Menon12ca7182015-02-13 19:28:02 -0600582{ return -ENODEV; }
583static inline int thermal_zone_unbind_cooling_device(
584 struct thermal_zone_device *tz, int trip,
585 struct thermal_cooling_device *cdev)
586{ return -ENODEV; }
Srinivas Pandruvada0e70f462016-08-26 16:21:16 -0700587static inline void thermal_zone_device_update(struct thermal_zone_device *tz,
588 enum thermal_notify_event event)
Nishanth Menon12ca7182015-02-13 19:28:02 -0600589{ }
Ram Chandrasekarbae93a62018-11-02 12:23:40 -0600590static inline void thermal_zone_device_update_temp(
591 struct thermal_zone_device *tz, enum thermal_notify_event event,
592 int temp)
593{ }
Sascha Hauer060c0342016-06-22 16:42:01 +0800594static inline void thermal_zone_set_trips(struct thermal_zone_device *tz)
595{ }
Nishanth Menon12ca7182015-02-13 19:28:02 -0600596static inline struct thermal_cooling_device *
597thermal_cooling_device_register(char *type, void *devdata,
598 const struct thermal_cooling_device_ops *ops)
599{ return ERR_PTR(-ENODEV); }
600static inline struct thermal_cooling_device *
601thermal_of_cooling_device_register(struct device_node *np,
602 char *type, void *devdata, const struct thermal_cooling_device_ops *ops)
603{ return ERR_PTR(-ENODEV); }
604static inline void thermal_cooling_device_unregister(
605 struct thermal_cooling_device *cdev)
606{ }
607static inline struct thermal_zone_device *thermal_zone_get_zone_by_name(
608 const char *name)
609{ return ERR_PTR(-ENODEV); }
610static inline int thermal_zone_get_temp(
Sascha Hauer17e83512015-07-24 08:12:54 +0200611 struct thermal_zone_device *tz, int *temp)
Nishanth Menon12ca7182015-02-13 19:28:02 -0600612{ return -ENODEV; }
Rajendra Nayak4a7069a2016-05-05 14:21:42 +0530613static inline int thermal_zone_get_slope(
614 struct thermal_zone_device *tz)
615{ return -ENODEV; }
616static inline int thermal_zone_get_offset(
617 struct thermal_zone_device *tz)
618{ return -ENODEV; }
Nishanth Menon12ca7182015-02-13 19:28:02 -0600619static inline int get_tz_trend(struct thermal_zone_device *tz, int trip)
620{ return -ENODEV; }
621static inline struct thermal_instance *
622get_thermal_instance(struct thermal_zone_device *tz,
623 struct thermal_cooling_device *cdev, int trip)
624{ return ERR_PTR(-ENODEV); }
625static inline void thermal_cdev_update(struct thermal_cooling_device *cdev)
626{ }
627static inline void thermal_notify_framework(struct thermal_zone_device *tz,
628 int trip)
629{ }
630#endif /* CONFIG_THERMAL */
Durgadoss Ra4a15482012-09-18 11:04:57 +0530631
Nishanth Menon12ca7182015-02-13 19:28:02 -0600632#if defined(CONFIG_NET) && IS_ENABLED(CONFIG_THERMAL)
Eduardo Valentin8ab3e6a2013-01-02 15:29:39 +0000633extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
634 enum events event);
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100635#else
Ezequiel Garciaf8b58702013-03-20 21:38:07 +0000636static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
Eduardo Valentin8ab3e6a2013-01-02 15:29:39 +0000637 enum events event)
Rafael J. Wysockiaf062162011-03-01 01:12:19 +0100638{
639 return 0;
640}
641#endif
Zhang Rui203d3d42008-01-17 15:51:08 +0800642
Len Browna0dd25b2008-02-09 04:01:48 -0500643#endif /* __THERMAL_H__ */