1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  *  thermal.h  ($Revision: 0 $)
4  *
5  *  Copyright (C) 2008  Intel Corp
6  *  Copyright (C) 2008  Zhang Rui <rui.zhang@intel.com>
7  *  Copyright (C) 2008  Sujith Thomas <sujith.thomas@intel.com>
8  */
9 
10 #ifndef __THERMAL_H__
11 #define __THERMAL_H__
12 
13 #include <linux/of.h>
14 #include <linux/idr.h>
15 #include <linux/device.h>
16 #include <linux/sysfs.h>
17 #include <linux/workqueue.h>
18 #include <uapi/linux/thermal.h>
19 
20 /* invalid cooling state */
21 #define THERMAL_CSTATE_INVALID -1UL
22 
23 /* No upper/lower limit requirement */
24 #define THERMAL_NO_LIMIT	((u32)~0)
25 
26 /* Default weight of a bound cooling device */
27 #define THERMAL_WEIGHT_DEFAULT 0
28 
29 /* use value, which < 0K, to indicate an invalid/uninitialized temperature */
30 #define THERMAL_TEMP_INVALID	-274000
31 
32 struct thermal_zone_device;
33 struct thermal_cooling_device;
34 struct thermal_instance;
35 struct thermal_attr;
36 
37 enum thermal_trend {
38 	THERMAL_TREND_STABLE, /* temperature is stable */
39 	THERMAL_TREND_RAISING, /* temperature is raising */
40 	THERMAL_TREND_DROPPING, /* temperature is dropping */
41 };
42 
43 /* Thermal notification reason */
44 enum thermal_notify_event {
45 	THERMAL_EVENT_UNSPECIFIED, /* Unspecified event */
46 	THERMAL_EVENT_TEMP_SAMPLE, /* New Temperature sample */
47 	THERMAL_TRIP_VIOLATED, /* TRIP Point violation */
48 	THERMAL_TRIP_CHANGED, /* TRIP Point temperature changed */
49 	THERMAL_DEVICE_DOWN, /* Thermal device is down */
50 	THERMAL_DEVICE_UP, /* Thermal device is up after a down event */
51 	THERMAL_DEVICE_POWER_CAPABILITY_CHANGED, /* power capability changed */
52 	THERMAL_TABLE_CHANGED, /* Thermal table(s) changed */
53 	THERMAL_EVENT_KEEP_ALIVE, /* Request for user space handler to respond */
54 };
55 
56 /**
57  * struct thermal_trip - representation of a point in temperature domain
58  * @temperature: temperature value in miliCelsius
59  * @hysteresis: relative hysteresis in miliCelsius
60  * @type: trip point type
61  * @priv: pointer to driver data associated with this trip
62  */
63 struct thermal_trip {
64 	int temperature;
65 	int hysteresis;
66 	enum thermal_trip_type type;
67 	void *priv;
68 };
69 
70 struct thermal_zone_device_ops {
71 	int (*bind) (struct thermal_zone_device *,
72 		     struct thermal_cooling_device *);
73 	int (*unbind) (struct thermal_zone_device *,
74 		       struct thermal_cooling_device *);
75 	int (*get_temp) (struct thermal_zone_device *, int *);
76 	int (*set_trips) (struct thermal_zone_device *, int, int);
77 	int (*change_mode) (struct thermal_zone_device *,
78 		enum thermal_device_mode);
79 	int (*set_trip_temp) (struct thermal_zone_device *, int, int);
80 	int (*set_trip_hyst) (struct thermal_zone_device *, int, int);
81 	int (*get_crit_temp) (struct thermal_zone_device *, int *);
82 	int (*set_emul_temp) (struct thermal_zone_device *, int);
83 	int (*get_trend) (struct thermal_zone_device *,
84 			  const struct thermal_trip *, enum thermal_trend *);
85 	void (*hot)(struct thermal_zone_device *);
86 	void (*critical)(struct thermal_zone_device *);
87 };
88 
89 struct thermal_cooling_device_ops {
90 	int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
91 	int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
92 	int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
93 	int (*get_requested_power)(struct thermal_cooling_device *, u32 *);
94 	int (*state2power)(struct thermal_cooling_device *, unsigned long, u32 *);
95 	int (*power2state)(struct thermal_cooling_device *, u32, unsigned long *);
96 };
97 
98 struct thermal_cooling_device {
99 	int id;
100 	char *type;
101 	unsigned long max_state;
102 	struct device device;
103 	struct device_node *np;
104 	void *devdata;
105 	void *stats;
106 	const struct thermal_cooling_device_ops *ops;
107 	bool updated; /* true if the cooling device does not need update */
108 	struct mutex lock; /* protect thermal_instances list */
109 	struct list_head thermal_instances;
110 	struct list_head node;
111 };
112 
113 /**
114  * struct thermal_zone_device - structure for a thermal zone
115  * @id:		unique id number for each thermal zone
116  * @type:	the thermal zone device type
117  * @device:	&struct device for this thermal zone
118  * @trip_temp_attrs:	attributes for trip points for sysfs: trip temperature
119  * @trip_type_attrs:	attributes for trip points for sysfs: trip type
120  * @trip_hyst_attrs:	attributes for trip points for sysfs: trip hysteresis
121  * @mode:		current mode of this thermal zone
122  * @devdata:	private pointer for device private data
123  * @trips:	an array of struct thermal_trip
124  * @num_trips:	number of trip points the thermal zone supports
125  * @trips_disabled;	bitmap for disabled trips
126  * @passive_delay_jiffies: number of jiffies to wait between polls when
127  *			performing passive cooling.
128  * @polling_delay_jiffies: number of jiffies to wait between polls when
129  *			checking whether trip points have been crossed (0 for
130  *			interrupt driven systems)
131  * @temperature:	current temperature.  This is only for core code,
132  *			drivers should use thermal_zone_get_temp() to get the
133  *			current temperature
134  * @last_temperature:	previous temperature read
135  * @emul_temperature:	emulated temperature when using CONFIG_THERMAL_EMULATION
136  * @passive:		1 if you've crossed a passive trip point, 0 otherwise.
137  * @prev_low_trip:	the low current temperature if you've crossed a passive
138 			trip point.
139  * @prev_high_trip:	the above current temperature if you've crossed a
140 			passive trip point.
141  * @need_update:	if equals 1, thermal_zone_device_update needs to be invoked.
142  * @ops:	operations this &thermal_zone_device supports
143  * @tzp:	thermal zone parameters
144  * @governor:	pointer to the governor for this thermal zone
145  * @governor_data:	private pointer for governor data
146  * @thermal_instances:	list of &struct thermal_instance of this thermal zone
147  * @ida:	&struct ida to generate unique id for this zone's cooling
148  *		devices
149  * @lock:	lock to protect thermal_instances list
150  * @node:	node in thermal_tz_list (in thermal_core.c)
151  * @poll_queue:	delayed work for polling
152  * @notify_event: Last notification event
153  * @suspended: thermal zone suspend indicator
154  */
155 struct thermal_zone_device {
156 	int id;
157 	char type[THERMAL_NAME_LENGTH];
158 	struct device device;
159 	struct attribute_group trips_attribute_group;
160 	struct thermal_attr *trip_temp_attrs;
161 	struct thermal_attr *trip_type_attrs;
162 	struct thermal_attr *trip_hyst_attrs;
163 	enum thermal_device_mode mode;
164 	void *devdata;
165 	struct thermal_trip *trips;
166 	int num_trips;
167 	unsigned long trips_disabled;	/* bitmap for disabled trips */
168 	unsigned long passive_delay_jiffies;
169 	unsigned long polling_delay_jiffies;
170 	int temperature;
171 	int last_temperature;
172 	int emul_temperature;
173 	int passive;
174 	int prev_low_trip;
175 	int prev_high_trip;
176 	atomic_t need_update;
177 	struct thermal_zone_device_ops *ops;
178 	struct thermal_zone_params *tzp;
179 	struct thermal_governor *governor;
180 	void *governor_data;
181 	struct list_head thermal_instances;
182 	struct ida ida;
183 	struct mutex lock;
184 	struct list_head node;
185 	struct delayed_work poll_queue;
186 	enum thermal_notify_event notify_event;
187 	bool suspended;
188 };
189 
190 /**
191  * struct thermal_governor - structure that holds thermal governor information
192  * @name:	name of the governor
193  * @bind_to_tz: callback called when binding to a thermal zone.  If it
194  *		returns 0, the governor is bound to the thermal zone,
195  *		otherwise it fails.
196  * @unbind_from_tz:	callback called when a governor is unbound from a
197  *			thermal zone.
198  * @throttle:	callback called for every trip point even if temperature is
199  *		below the trip point temperature
200  * @governor_list:	node in thermal_governor_list (in thermal_core.c)
201  */
202 struct thermal_governor {
203 	char name[THERMAL_NAME_LENGTH];
204 	int (*bind_to_tz)(struct thermal_zone_device *tz);
205 	void (*unbind_from_tz)(struct thermal_zone_device *tz);
206 	int (*throttle)(struct thermal_zone_device *tz, int trip);
207 	struct list_head	governor_list;
208 };
209 
210 /* Structure to define Thermal Zone parameters */
211 struct thermal_zone_params {
212 	char governor_name[THERMAL_NAME_LENGTH];
213 
214 	/*
215 	 * a boolean to indicate if the thermal to hwmon sysfs interface
216 	 * is required. when no_hwmon == false, a hwmon sysfs interface
217 	 * will be created. when no_hwmon == true, nothing will be done
218 	 */
219 	bool no_hwmon;
220 
221 	/*
222 	 * Sustainable power (heat) that this thermal zone can dissipate in
223 	 * mW
224 	 */
225 	u32 sustainable_power;
226 
227 	/*
228 	 * Proportional parameter of the PID controller when
229 	 * overshooting (i.e., when temperature is below the target)
230 	 */
231 	s32 k_po;
232 
233 	/*
234 	 * Proportional parameter of the PID controller when
235 	 * undershooting
236 	 */
237 	s32 k_pu;
238 
239 	/* Integral parameter of the PID controller */
240 	s32 k_i;
241 
242 	/* Derivative parameter of the PID controller */
243 	s32 k_d;
244 
245 	/* threshold below which the error is no longer accumulated */
246 	s32 integral_cutoff;
247 
248 	/*
249 	 * @slope:	slope of a linear temperature adjustment curve.
250 	 * 		Used by thermal zone drivers.
251 	 */
252 	int slope;
253 	/*
254 	 * @offset:	offset of a linear temperature adjustment curve.
255 	 * 		Used by thermal zone drivers (default 0).
256 	 */
257 	int offset;
258 };
259 
260 /* Function declarations */
261 #ifdef CONFIG_THERMAL_OF
262 struct thermal_zone_device *devm_thermal_of_zone_register(struct device *dev, int id, void *data,
263 							  const struct thermal_zone_device_ops *ops);
264 
265 void devm_thermal_of_zone_unregister(struct device *dev, struct thermal_zone_device *tz);
266 
267 #else
268 
269 static inline
devm_thermal_of_zone_register(struct device * dev,int id,void * data,const struct thermal_zone_device_ops * ops)270 struct thermal_zone_device *devm_thermal_of_zone_register(struct device *dev, int id, void *data,
271 							  const struct thermal_zone_device_ops *ops)
272 {
273 	return ERR_PTR(-ENOTSUPP);
274 }
275 
devm_thermal_of_zone_unregister(struct device * dev,struct thermal_zone_device * tz)276 static inline void devm_thermal_of_zone_unregister(struct device *dev,
277 						   struct thermal_zone_device *tz)
278 {
279 }
280 #endif
281 
282 int __thermal_zone_get_trip(struct thermal_zone_device *tz, int trip_id,
283 			    struct thermal_trip *trip);
284 int thermal_zone_get_trip(struct thermal_zone_device *tz, int trip_id,
285 			  struct thermal_trip *trip);
286 
287 int thermal_zone_set_trip(struct thermal_zone_device *tz, int trip_id,
288 			  const struct thermal_trip *trip);
289 
290 int for_each_thermal_trip(struct thermal_zone_device *tz,
291 			  int (*cb)(struct thermal_trip *, void *),
292 			  void *data);
293 int thermal_zone_get_num_trips(struct thermal_zone_device *tz);
294 
295 int thermal_zone_get_crit_temp(struct thermal_zone_device *tz, int *temp);
296 
297 #ifdef CONFIG_THERMAL_ACPI
298 int thermal_acpi_active_trip_temp(struct acpi_device *adev, int id, int *ret_temp);
299 int thermal_acpi_passive_trip_temp(struct acpi_device *adev, int *ret_temp);
300 int thermal_acpi_hot_trip_temp(struct acpi_device *adev, int *ret_temp);
301 int thermal_acpi_critical_trip_temp(struct acpi_device *adev, int *ret_temp);
302 #endif
303 
304 #ifdef CONFIG_THERMAL
305 struct thermal_zone_device *thermal_zone_device_register_with_trips(
306 					const char *type,
307 					struct thermal_trip *trips,
308 					int num_trips, int mask,
309 					void *devdata,
310 					struct thermal_zone_device_ops *ops,
311 					const struct thermal_zone_params *tzp,
312 					int passive_delay, int polling_delay);
313 
314 struct thermal_zone_device *thermal_tripless_zone_device_register(
315 					const char *type,
316 					void *devdata,
317 					struct thermal_zone_device_ops *ops,
318 					const struct thermal_zone_params *tzp);
319 
320 void thermal_zone_device_unregister(struct thermal_zone_device *tz);
321 
322 void *thermal_zone_device_priv(struct thermal_zone_device *tzd);
323 const char *thermal_zone_device_type(struct thermal_zone_device *tzd);
324 int thermal_zone_device_id(struct thermal_zone_device *tzd);
325 struct device *thermal_zone_device(struct thermal_zone_device *tzd);
326 
327 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
328 				     struct thermal_cooling_device *,
329 				     unsigned long, unsigned long,
330 				     unsigned int);
331 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
332 				       struct thermal_cooling_device *);
333 void thermal_zone_device_update(struct thermal_zone_device *,
334 				enum thermal_notify_event);
335 void thermal_zone_device_exec(struct thermal_zone_device *tz,
336 			      void (*cb)(struct thermal_zone_device *,
337 					 unsigned long),
338 			      unsigned long data);
339 
340 struct thermal_cooling_device *thermal_cooling_device_register(const char *,
341 		void *, const struct thermal_cooling_device_ops *);
342 struct thermal_cooling_device *
343 thermal_of_cooling_device_register(struct device_node *np, const char *, void *,
344 				   const struct thermal_cooling_device_ops *);
345 struct thermal_cooling_device *
346 devm_thermal_of_cooling_device_register(struct device *dev,
347 				struct device_node *np,
348 				char *type, void *devdata,
349 				const struct thermal_cooling_device_ops *ops);
350 void thermal_cooling_device_update(struct thermal_cooling_device *);
351 void thermal_cooling_device_unregister(struct thermal_cooling_device *);
352 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
353 int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp);
354 int thermal_zone_get_slope(struct thermal_zone_device *tz);
355 int thermal_zone_get_offset(struct thermal_zone_device *tz);
356 
357 int thermal_zone_device_enable(struct thermal_zone_device *tz);
358 int thermal_zone_device_disable(struct thermal_zone_device *tz);
359 void thermal_zone_device_critical(struct thermal_zone_device *tz);
360 #else
thermal_zone_device_register_with_trips(const char * type,struct thermal_trip * trips,int num_trips,int mask,void * devdata,struct thermal_zone_device_ops * ops,const struct thermal_zone_params * tzp,int passive_delay,int polling_delay)361 static inline struct thermal_zone_device *thermal_zone_device_register_with_trips(
362 					const char *type,
363 					struct thermal_trip *trips,
364 					int num_trips, int mask,
365 					void *devdata,
366 					struct thermal_zone_device_ops *ops,
367 					const struct thermal_zone_params *tzp,
368 					int passive_delay, int polling_delay)
369 { return ERR_PTR(-ENODEV); }
370 
thermal_tripless_zone_device_register(const char * type,void * devdata,struct thermal_zone_device_ops * ops,const struct thermal_zone_params * tzp)371 static inline struct thermal_zone_device *thermal_tripless_zone_device_register(
372 					const char *type,
373 					void *devdata,
374 					struct thermal_zone_device_ops *ops,
375 					const struct thermal_zone_params *tzp)
376 { return ERR_PTR(-ENODEV); }
377 
thermal_zone_device_unregister(struct thermal_zone_device * tz)378 static inline void thermal_zone_device_unregister(struct thermal_zone_device *tz)
379 { }
380 
381 static inline struct thermal_cooling_device *
thermal_cooling_device_register(const char * type,void * devdata,const struct thermal_cooling_device_ops * ops)382 thermal_cooling_device_register(const char *type, void *devdata,
383 	const struct thermal_cooling_device_ops *ops)
384 { return ERR_PTR(-ENODEV); }
385 static inline struct thermal_cooling_device *
thermal_of_cooling_device_register(struct device_node * np,const char * type,void * devdata,const struct thermal_cooling_device_ops * ops)386 thermal_of_cooling_device_register(struct device_node *np,
387 	const char *type, void *devdata,
388 	const struct thermal_cooling_device_ops *ops)
389 { return ERR_PTR(-ENODEV); }
390 static inline struct thermal_cooling_device *
devm_thermal_of_cooling_device_register(struct device * dev,struct device_node * np,char * type,void * devdata,const struct thermal_cooling_device_ops * ops)391 devm_thermal_of_cooling_device_register(struct device *dev,
392 				struct device_node *np,
393 				char *type, void *devdata,
394 				const struct thermal_cooling_device_ops *ops)
395 {
396 	return ERR_PTR(-ENODEV);
397 }
thermal_cooling_device_unregister(struct thermal_cooling_device * cdev)398 static inline void thermal_cooling_device_unregister(
399 	struct thermal_cooling_device *cdev)
400 { }
thermal_zone_get_zone_by_name(const char * name)401 static inline struct thermal_zone_device *thermal_zone_get_zone_by_name(
402 		const char *name)
403 { return ERR_PTR(-ENODEV); }
thermal_zone_get_temp(struct thermal_zone_device * tz,int * temp)404 static inline int thermal_zone_get_temp(
405 		struct thermal_zone_device *tz, int *temp)
406 { return -ENODEV; }
thermal_zone_get_slope(struct thermal_zone_device * tz)407 static inline int thermal_zone_get_slope(
408 		struct thermal_zone_device *tz)
409 { return -ENODEV; }
thermal_zone_get_offset(struct thermal_zone_device * tz)410 static inline int thermal_zone_get_offset(
411 		struct thermal_zone_device *tz)
412 { return -ENODEV; }
413 
thermal_zone_device_priv(struct thermal_zone_device * tz)414 static inline void *thermal_zone_device_priv(struct thermal_zone_device *tz)
415 {
416 	return NULL;
417 }
418 
thermal_zone_device_type(struct thermal_zone_device * tzd)419 static inline const char *thermal_zone_device_type(struct thermal_zone_device *tzd)
420 {
421 	return NULL;
422 }
423 
thermal_zone_device_id(struct thermal_zone_device * tzd)424 static inline int thermal_zone_device_id(struct thermal_zone_device *tzd)
425 {
426 	return -ENODEV;
427 }
428 
thermal_zone_device_enable(struct thermal_zone_device * tz)429 static inline int thermal_zone_device_enable(struct thermal_zone_device *tz)
430 { return -ENODEV; }
431 
thermal_zone_device_disable(struct thermal_zone_device * tz)432 static inline int thermal_zone_device_disable(struct thermal_zone_device *tz)
433 { return -ENODEV; }
434 #endif /* CONFIG_THERMAL */
435 
436 #endif /* __THERMAL_H__ */
437