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 #define THERMAL_TRIPS_NONE -1
21 #define THERMAL_MAX_TRIPS 12
22
23 /* invalid cooling state */
24 #define THERMAL_CSTATE_INVALID -1UL
25
26 /* No upper/lower limit requirement */
27 #define THERMAL_NO_LIMIT ((u32)~0)
28
29 /* Default weight of a bound cooling device */
30 #define THERMAL_WEIGHT_DEFAULT 0
31
32 /* use value, which < 0K, to indicate an invalid/uninitialized temperature */
33 #define THERMAL_TEMP_INVALID -274000
34
35 struct thermal_zone_device;
36 struct thermal_cooling_device;
37 struct thermal_instance;
38 struct thermal_attr;
39
40 enum thermal_trend {
41 THERMAL_TREND_STABLE, /* temperature is stable */
42 THERMAL_TREND_RAISING, /* temperature is raising */
43 THERMAL_TREND_DROPPING, /* temperature is dropping */
44 THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
45 THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
46 };
47
48 /* Thermal notification reason */
49 enum thermal_notify_event {
50 THERMAL_EVENT_UNSPECIFIED, /* Unspecified event */
51 THERMAL_EVENT_TEMP_SAMPLE, /* New Temperature sample */
52 THERMAL_TRIP_VIOLATED, /* TRIP Point violation */
53 THERMAL_TRIP_CHANGED, /* TRIP Point temperature changed */
54 THERMAL_DEVICE_DOWN, /* Thermal device is down */
55 THERMAL_DEVICE_UP, /* Thermal device is up after a down event */
56 THERMAL_DEVICE_POWER_CAPABILITY_CHANGED, /* power capability changed */
57 THERMAL_TABLE_CHANGED, /* Thermal table(s) changed */
58 THERMAL_EVENT_KEEP_ALIVE, /* Request for user space handler to respond */
59 };
60
61 struct thermal_zone_device_ops {
62 int (*bind) (struct thermal_zone_device *,
63 struct thermal_cooling_device *);
64 int (*unbind) (struct thermal_zone_device *,
65 struct thermal_cooling_device *);
66 int (*get_temp) (struct thermal_zone_device *, int *);
67 int (*set_trips) (struct thermal_zone_device *, int, int);
68 int (*change_mode) (struct thermal_zone_device *,
69 enum thermal_device_mode);
70 int (*get_trip_type) (struct thermal_zone_device *, int,
71 enum thermal_trip_type *);
72 int (*get_trip_temp) (struct thermal_zone_device *, int, int *);
73 int (*set_trip_temp) (struct thermal_zone_device *, int, int);
74 int (*get_trip_hyst) (struct thermal_zone_device *, int, int *);
75 int (*set_trip_hyst) (struct thermal_zone_device *, int, int);
76 int (*get_crit_temp) (struct thermal_zone_device *, int *);
77 int (*set_emul_temp) (struct thermal_zone_device *, int);
78 int (*get_trend) (struct thermal_zone_device *, int,
79 enum thermal_trend *);
80 int (*notify) (struct thermal_zone_device *, int,
81 enum thermal_trip_type);
82 };
83
84 struct thermal_cooling_device_ops {
85 int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
86 int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
87 int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
88 int (*get_requested_power)(struct thermal_cooling_device *, u32 *);
89 int (*state2power)(struct thermal_cooling_device *, unsigned long, u32 *);
90 int (*power2state)(struct thermal_cooling_device *, u32, unsigned long *);
91 };
92
93 struct thermal_cooling_device {
94 int id;
95 char *type;
96 struct device device;
97 struct device_node *np;
98 void *devdata;
99 void *stats;
100 const struct thermal_cooling_device_ops *ops;
101 bool updated; /* true if the cooling device does not need update */
102 struct mutex lock; /* protect thermal_instances list */
103 struct list_head thermal_instances;
104 struct list_head node;
105 };
106
107 /**
108 * struct thermal_zone_device - structure for a thermal zone
109 * @id: unique id number for each thermal zone
110 * @type: the thermal zone device type
111 * @device: &struct device for this thermal zone
112 * @trip_temp_attrs: attributes for trip points for sysfs: trip temperature
113 * @trip_type_attrs: attributes for trip points for sysfs: trip type
114 * @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis
115 * @mode: current mode of this thermal zone
116 * @devdata: private pointer for device private data
117 * @trips: number of trip points the thermal zone supports
118 * @trips_disabled; bitmap for disabled trips
119 * @passive_delay: number of milliseconds to wait between polls when
120 * performing passive cooling.
121 * @polling_delay: number of milliseconds to wait between polls when
122 * checking whether trip points have been crossed (0 for
123 * interrupt driven systems)
124 * @temperature: current temperature. This is only for core code,
125 * drivers should use thermal_zone_get_temp() to get the
126 * current temperature
127 * @last_temperature: previous temperature read
128 * @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION
129 * @passive: 1 if you've crossed a passive trip point, 0 otherwise.
130 * @prev_low_trip: the low current temperature if you've crossed a passive
131 trip point.
132 * @prev_high_trip: the above current temperature if you've crossed a
133 passive trip point.
134 * @forced_passive: If > 0, temperature at which to switch on all ACPI
135 * processor cooling devices. Currently only used by the
136 * step-wise governor.
137 * @need_update: if equals 1, thermal_zone_device_update needs to be invoked.
138 * @ops: operations this &thermal_zone_device supports
139 * @tzp: thermal zone parameters
140 * @governor: pointer to the governor for this thermal zone
141 * @governor_data: private pointer for governor data
142 * @thermal_instances: list of &struct thermal_instance of this thermal zone
143 * @ida: &struct ida to generate unique id for this zone's cooling
144 * devices
145 * @lock: lock to protect thermal_instances list
146 * @node: node in thermal_tz_list (in thermal_core.c)
147 * @poll_queue: delayed work for polling
148 * @notify_event: Last notification event
149 */
150 struct thermal_zone_device {
151 int id;
152 char type[THERMAL_NAME_LENGTH];
153 struct device device;
154 struct attribute_group trips_attribute_group;
155 struct thermal_attr *trip_temp_attrs;
156 struct thermal_attr *trip_type_attrs;
157 struct thermal_attr *trip_hyst_attrs;
158 enum thermal_device_mode mode;
159 void *devdata;
160 int trips;
161 unsigned long trips_disabled; /* bitmap for disabled trips */
162 int passive_delay;
163 int polling_delay;
164 int temperature;
165 int last_temperature;
166 int emul_temperature;
167 int passive;
168 int prev_low_trip;
169 int prev_high_trip;
170 unsigned int forced_passive;
171 atomic_t need_update;
172 struct thermal_zone_device_ops *ops;
173 struct thermal_zone_params *tzp;
174 struct thermal_governor *governor;
175 void *governor_data;
176 struct list_head thermal_instances;
177 struct ida ida;
178 struct mutex lock;
179 struct list_head node;
180 struct delayed_work poll_queue;
181 enum thermal_notify_event notify_event;
182 };
183
184 /**
185 * struct thermal_governor - structure that holds thermal governor information
186 * @name: name of the governor
187 * @bind_to_tz: callback called when binding to a thermal zone. If it
188 * returns 0, the governor is bound to the thermal zone,
189 * otherwise it fails.
190 * @unbind_from_tz: callback called when a governor is unbound from a
191 * thermal zone.
192 * @throttle: callback called for every trip point even if temperature is
193 * below the trip point temperature
194 * @governor_list: node in thermal_governor_list (in thermal_core.c)
195 */
196 struct thermal_governor {
197 char name[THERMAL_NAME_LENGTH];
198 int (*bind_to_tz)(struct thermal_zone_device *tz);
199 void (*unbind_from_tz)(struct thermal_zone_device *tz);
200 int (*throttle)(struct thermal_zone_device *tz, int trip);
201 struct list_head governor_list;
202 };
203
204 /* Structure that holds binding parameters for a zone */
205 struct thermal_bind_params {
206 struct thermal_cooling_device *cdev;
207
208 /*
209 * This is a measure of 'how effectively these devices can
210 * cool 'this' thermal zone. It shall be determined by
211 * platform characterization. This value is relative to the
212 * rest of the weights so a cooling device whose weight is
213 * double that of another cooling device is twice as
214 * effective. See Documentation/driver-api/thermal/sysfs-api.rst for more
215 * information.
216 */
217 int weight;
218
219 /*
220 * This is a bit mask that gives the binding relation between this
221 * thermal zone and cdev, for a particular trip point.
222 * See Documentation/driver-api/thermal/sysfs-api.rst for more information.
223 */
224 int trip_mask;
225
226 /*
227 * This is an array of cooling state limits. Must have exactly
228 * 2 * thermal_zone.number_of_trip_points. It is an array consisting
229 * of tuples <lower-state upper-state> of state limits. Each trip
230 * will be associated with one state limit tuple when binding.
231 * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
232 * on all trips.
233 */
234 unsigned long *binding_limits;
235 int (*match) (struct thermal_zone_device *tz,
236 struct thermal_cooling_device *cdev);
237 };
238
239 /* Structure to define Thermal Zone parameters */
240 struct thermal_zone_params {
241 char governor_name[THERMAL_NAME_LENGTH];
242
243 /*
244 * a boolean to indicate if the thermal to hwmon sysfs interface
245 * is required. when no_hwmon == false, a hwmon sysfs interface
246 * will be created. when no_hwmon == true, nothing will be done
247 */
248 bool no_hwmon;
249
250 int num_tbps; /* Number of tbp entries */
251 struct thermal_bind_params *tbp;
252
253 /*
254 * Sustainable power (heat) that this thermal zone can dissipate in
255 * mW
256 */
257 u32 sustainable_power;
258
259 /*
260 * Proportional parameter of the PID controller when
261 * overshooting (i.e., when temperature is below the target)
262 */
263 s32 k_po;
264
265 /*
266 * Proportional parameter of the PID controller when
267 * undershooting
268 */
269 s32 k_pu;
270
271 /* Integral parameter of the PID controller */
272 s32 k_i;
273
274 /* Derivative parameter of the PID controller */
275 s32 k_d;
276
277 /* threshold below which the error is no longer accumulated */
278 s32 integral_cutoff;
279
280 /*
281 * @slope: slope of a linear temperature adjustment curve.
282 * Used by thermal zone drivers.
283 */
284 int slope;
285 /*
286 * @offset: offset of a linear temperature adjustment curve.
287 * Used by thermal zone drivers (default 0).
288 */
289 int offset;
290 };
291
292 /**
293 * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones
294 *
295 * Mandatory:
296 * @get_temp: a pointer to a function that reads the sensor temperature.
297 *
298 * Optional:
299 * @get_trend: a pointer to a function that reads the sensor temperature trend.
300 * @set_trips: a pointer to a function that sets a temperature window. When
301 * this window is left the driver must inform the thermal core via
302 * thermal_zone_device_update.
303 * @set_emul_temp: a pointer to a function that sets sensor emulated
304 * temperature.
305 * @set_trip_temp: a pointer to a function that sets the trip temperature on
306 * hardware.
307 */
308 struct thermal_zone_of_device_ops {
309 int (*get_temp)(void *, int *);
310 int (*get_trend)(void *, int, enum thermal_trend *);
311 int (*set_trips)(void *, int, int);
312 int (*set_emul_temp)(void *, int);
313 int (*set_trip_temp)(void *, int, int);
314 };
315
316 /* Function declarations */
317 #ifdef CONFIG_THERMAL_OF
318 int thermal_zone_of_get_sensor_id(struct device_node *tz_np,
319 struct device_node *sensor_np,
320 u32 *id);
321 struct thermal_zone_device *
322 thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
323 const struct thermal_zone_of_device_ops *ops);
324 void thermal_zone_of_sensor_unregister(struct device *dev,
325 struct thermal_zone_device *tz);
326 struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
327 struct device *dev, int id, void *data,
328 const struct thermal_zone_of_device_ops *ops);
329 void devm_thermal_zone_of_sensor_unregister(struct device *dev,
330 struct thermal_zone_device *tz);
331 #else
332
thermal_zone_of_get_sensor_id(struct device_node * tz_np,struct device_node * sensor_np,u32 * id)333 static inline int thermal_zone_of_get_sensor_id(struct device_node *tz_np,
334 struct device_node *sensor_np,
335 u32 *id)
336 {
337 return -ENOENT;
338 }
339 static inline struct thermal_zone_device *
thermal_zone_of_sensor_register(struct device * dev,int id,void * data,const struct thermal_zone_of_device_ops * ops)340 thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
341 const struct thermal_zone_of_device_ops *ops)
342 {
343 return ERR_PTR(-ENODEV);
344 }
345
346 static inline
thermal_zone_of_sensor_unregister(struct device * dev,struct thermal_zone_device * tz)347 void thermal_zone_of_sensor_unregister(struct device *dev,
348 struct thermal_zone_device *tz)
349 {
350 }
351
devm_thermal_zone_of_sensor_register(struct device * dev,int id,void * data,const struct thermal_zone_of_device_ops * ops)352 static inline struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
353 struct device *dev, int id, void *data,
354 const struct thermal_zone_of_device_ops *ops)
355 {
356 return ERR_PTR(-ENODEV);
357 }
358
359 static inline
devm_thermal_zone_of_sensor_unregister(struct device * dev,struct thermal_zone_device * tz)360 void devm_thermal_zone_of_sensor_unregister(struct device *dev,
361 struct thermal_zone_device *tz)
362 {
363 }
364
365 #endif
366
367 #ifdef CONFIG_THERMAL
368 struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
369 void *, struct thermal_zone_device_ops *,
370 struct thermal_zone_params *, int, int);
371 void thermal_zone_device_unregister(struct thermal_zone_device *);
372
373 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
374 struct thermal_cooling_device *,
375 unsigned long, unsigned long,
376 unsigned int);
377 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
378 struct thermal_cooling_device *);
379 void thermal_zone_device_update(struct thermal_zone_device *,
380 enum thermal_notify_event);
381
382 struct thermal_cooling_device *thermal_cooling_device_register(const char *,
383 void *, const struct thermal_cooling_device_ops *);
384 struct thermal_cooling_device *
385 thermal_of_cooling_device_register(struct device_node *np, const char *, void *,
386 const struct thermal_cooling_device_ops *);
387 struct thermal_cooling_device *
388 devm_thermal_of_cooling_device_register(struct device *dev,
389 struct device_node *np,
390 char *type, void *devdata,
391 const struct thermal_cooling_device_ops *ops);
392 void thermal_cooling_device_unregister(struct thermal_cooling_device *);
393 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
394 int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp);
395 int thermal_zone_get_slope(struct thermal_zone_device *tz);
396 int thermal_zone_get_offset(struct thermal_zone_device *tz);
397
398 void thermal_cdev_update(struct thermal_cooling_device *);
399 void thermal_notify_framework(struct thermal_zone_device *, int);
400 int thermal_zone_device_enable(struct thermal_zone_device *tz);
401 int thermal_zone_device_disable(struct thermal_zone_device *tz);
402 #else
thermal_zone_device_register(const char * type,int trips,int mask,void * devdata,struct thermal_zone_device_ops * ops,struct thermal_zone_params * tzp,int passive_delay,int polling_delay)403 static inline struct thermal_zone_device *thermal_zone_device_register(
404 const char *type, int trips, int mask, void *devdata,
405 struct thermal_zone_device_ops *ops,
406 struct thermal_zone_params *tzp,
407 int passive_delay, int polling_delay)
408 { return ERR_PTR(-ENODEV); }
thermal_zone_device_unregister(struct thermal_zone_device * tz)409 static inline void thermal_zone_device_unregister(
410 struct thermal_zone_device *tz)
411 { }
412 static inline struct thermal_cooling_device *
thermal_cooling_device_register(const char * type,void * devdata,const struct thermal_cooling_device_ops * ops)413 thermal_cooling_device_register(const char *type, void *devdata,
414 const struct thermal_cooling_device_ops *ops)
415 { return ERR_PTR(-ENODEV); }
416 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)417 thermal_of_cooling_device_register(struct device_node *np,
418 const char *type, void *devdata,
419 const struct thermal_cooling_device_ops *ops)
420 { return ERR_PTR(-ENODEV); }
421 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)422 devm_thermal_of_cooling_device_register(struct device *dev,
423 struct device_node *np,
424 char *type, void *devdata,
425 const struct thermal_cooling_device_ops *ops)
426 {
427 return ERR_PTR(-ENODEV);
428 }
thermal_cooling_device_unregister(struct thermal_cooling_device * cdev)429 static inline void thermal_cooling_device_unregister(
430 struct thermal_cooling_device *cdev)
431 { }
thermal_zone_get_zone_by_name(const char * name)432 static inline struct thermal_zone_device *thermal_zone_get_zone_by_name(
433 const char *name)
434 { return ERR_PTR(-ENODEV); }
thermal_zone_get_temp(struct thermal_zone_device * tz,int * temp)435 static inline int thermal_zone_get_temp(
436 struct thermal_zone_device *tz, int *temp)
437 { return -ENODEV; }
thermal_zone_get_slope(struct thermal_zone_device * tz)438 static inline int thermal_zone_get_slope(
439 struct thermal_zone_device *tz)
440 { return -ENODEV; }
thermal_zone_get_offset(struct thermal_zone_device * tz)441 static inline int thermal_zone_get_offset(
442 struct thermal_zone_device *tz)
443 { return -ENODEV; }
444
thermal_cdev_update(struct thermal_cooling_device * cdev)445 static inline void thermal_cdev_update(struct thermal_cooling_device *cdev)
446 { }
thermal_notify_framework(struct thermal_zone_device * tz,int trip)447 static inline void thermal_notify_framework(struct thermal_zone_device *tz,
448 int trip)
449 { }
450
thermal_zone_device_enable(struct thermal_zone_device * tz)451 static inline int thermal_zone_device_enable(struct thermal_zone_device *tz)
452 { return -ENODEV; }
453
thermal_zone_device_disable(struct thermal_zone_device * tz)454 static inline int thermal_zone_device_disable(struct thermal_zone_device *tz)
455 { return -ENODEV; }
456 #endif /* CONFIG_THERMAL */
457
458 #endif /* __THERMAL_H__ */
459