1 /* SPDX-License-Identifier: GPL-2.0 */
3 * thermal.h ($Revision: 0 $)
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>
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>
20 #define THERMAL_MAX_TRIPS 12
22 /* invalid cooling state */
23 #define THERMAL_CSTATE_INVALID -1UL
25 /* No upper/lower limit requirement */
26 #define THERMAL_NO_LIMIT ((u32)~0)
28 /* Default weight of a bound cooling device */
29 #define THERMAL_WEIGHT_DEFAULT 0
31 /* use value, which < 0K, to indicate an invalid/uninitialized temperature */
32 #define THERMAL_TEMP_INVALID -274000
34 struct thermal_zone_device;
35 struct thermal_cooling_device;
36 struct thermal_instance;
40 THERMAL_TREND_STABLE, /* temperature is stable */
41 THERMAL_TREND_RAISING, /* temperature is raising */
42 THERMAL_TREND_DROPPING, /* temperature is dropping */
45 /* Thermal notification reason */
46 enum thermal_notify_event {
47 THERMAL_EVENT_UNSPECIFIED, /* Unspecified event */
48 THERMAL_EVENT_TEMP_SAMPLE, /* New Temperature sample */
49 THERMAL_TRIP_VIOLATED, /* TRIP Point violation */
50 THERMAL_TRIP_CHANGED, /* TRIP Point temperature changed */
51 THERMAL_DEVICE_DOWN, /* Thermal device is down */
52 THERMAL_DEVICE_UP, /* Thermal device is up after a down event */
53 THERMAL_DEVICE_POWER_CAPABILITY_CHANGED, /* power capability changed */
54 THERMAL_TABLE_CHANGED, /* Thermal table(s) changed */
55 THERMAL_EVENT_KEEP_ALIVE, /* Request for user space handler to respond */
58 struct thermal_zone_device_ops {
59 int (*bind) (struct thermal_zone_device *,
60 struct thermal_cooling_device *);
61 int (*unbind) (struct thermal_zone_device *,
62 struct thermal_cooling_device *);
63 int (*get_temp) (struct thermal_zone_device *, int *);
64 int (*set_trips) (struct thermal_zone_device *, int, int);
65 int (*change_mode) (struct thermal_zone_device *,
66 enum thermal_device_mode);
67 int (*get_trip_type) (struct thermal_zone_device *, int,
68 enum thermal_trip_type *);
69 int (*get_trip_temp) (struct thermal_zone_device *, int, int *);
70 int (*set_trip_temp) (struct thermal_zone_device *, int, int);
71 int (*get_trip_hyst) (struct thermal_zone_device *, int, int *);
72 int (*set_trip_hyst) (struct thermal_zone_device *, int, int);
73 int (*get_crit_temp) (struct thermal_zone_device *, int *);
74 int (*set_emul_temp) (struct thermal_zone_device *, int);
75 int (*get_trend) (struct thermal_zone_device *, int,
76 enum thermal_trend *);
77 void (*hot)(struct thermal_zone_device *);
78 void (*critical)(struct thermal_zone_device *);
82 * struct thermal_trip - representation of a point in temperature domain
83 * @temperature: temperature value in miliCelsius
84 * @hysteresis: relative hysteresis in miliCelsius
85 * @type: trip point type
90 enum thermal_trip_type type;
93 struct thermal_cooling_device_ops {
94 int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
95 int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
96 int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
97 int (*get_requested_power)(struct thermal_cooling_device *, u32 *);
98 int (*state2power)(struct thermal_cooling_device *, unsigned long, u32 *);
99 int (*power2state)(struct thermal_cooling_device *, u32, unsigned long *);
102 struct thermal_cooling_device {
105 struct device device;
106 struct device_node *np;
109 const struct thermal_cooling_device_ops *ops;
110 bool updated; /* true if the cooling device does not need update */
111 struct mutex lock; /* protect thermal_instances list */
112 struct list_head thermal_instances;
113 struct list_head node;
117 * struct thermal_zone_device - structure for a thermal zone
118 * @id: unique id number for each thermal zone
119 * @type: the thermal zone device type
120 * @device: &struct device for this thermal zone
121 * @trip_temp_attrs: attributes for trip points for sysfs: trip temperature
122 * @trip_type_attrs: attributes for trip points for sysfs: trip type
123 * @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis
124 * @mode: current mode of this thermal zone
125 * @devdata: private pointer for device private data
126 * @trips: an array of struct thermal_trip
127 * @num_trips: number of trip points the thermal zone supports
128 * @trips_disabled; bitmap for disabled trips
129 * @passive_delay_jiffies: number of jiffies to wait between polls when
130 * performing passive cooling.
131 * @polling_delay_jiffies: number of jiffies to wait between polls when
132 * checking whether trip points have been crossed (0 for
133 * interrupt driven systems)
134 * @temperature: current temperature. This is only for core code,
135 * drivers should use thermal_zone_get_temp() to get the
136 * current temperature
137 * @last_temperature: previous temperature read
138 * @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION
139 * @passive: 1 if you've crossed a passive trip point, 0 otherwise.
140 * @prev_low_trip: the low current temperature if you've crossed a passive
142 * @prev_high_trip: the above current temperature if you've crossed a
144 * @need_update: if equals 1, thermal_zone_device_update needs to be invoked.
145 * @ops: operations this &thermal_zone_device supports
146 * @tzp: thermal zone parameters
147 * @governor: pointer to the governor for this thermal zone
148 * @governor_data: private pointer for governor data
149 * @thermal_instances: list of &struct thermal_instance of this thermal zone
150 * @ida: &struct ida to generate unique id for this zone's cooling
152 * @lock: lock to protect thermal_instances list
153 * @node: node in thermal_tz_list (in thermal_core.c)
154 * @poll_queue: delayed work for polling
155 * @notify_event: Last notification event
157 struct thermal_zone_device {
159 char type[THERMAL_NAME_LENGTH];
160 struct device device;
161 struct attribute_group trips_attribute_group;
162 struct thermal_attr *trip_temp_attrs;
163 struct thermal_attr *trip_type_attrs;
164 struct thermal_attr *trip_hyst_attrs;
165 enum thermal_device_mode mode;
167 struct thermal_trip *trips;
169 unsigned long trips_disabled; /* bitmap for disabled trips */
170 unsigned long passive_delay_jiffies;
171 unsigned long polling_delay_jiffies;
173 int last_temperature;
174 int emul_temperature;
178 atomic_t need_update;
179 struct thermal_zone_device_ops *ops;
180 struct thermal_zone_params *tzp;
181 struct thermal_governor *governor;
183 struct list_head thermal_instances;
186 struct list_head node;
187 struct delayed_work poll_queue;
188 enum thermal_notify_event notify_event;
192 * struct thermal_governor - structure that holds thermal governor information
193 * @name: name of the governor
194 * @bind_to_tz: callback called when binding to a thermal zone. If it
195 * returns 0, the governor is bound to the thermal zone,
196 * otherwise it fails.
197 * @unbind_from_tz: callback called when a governor is unbound from a
199 * @throttle: callback called for every trip point even if temperature is
200 * below the trip point temperature
201 * @governor_list: node in thermal_governor_list (in thermal_core.c)
203 struct thermal_governor {
204 char name[THERMAL_NAME_LENGTH];
205 int (*bind_to_tz)(struct thermal_zone_device *tz);
206 void (*unbind_from_tz)(struct thermal_zone_device *tz);
207 int (*throttle)(struct thermal_zone_device *tz, int trip);
208 struct list_head governor_list;
211 /* Structure that holds binding parameters for a zone */
212 struct thermal_bind_params {
213 struct thermal_cooling_device *cdev;
216 * This is a measure of 'how effectively these devices can
217 * cool 'this' thermal zone. It shall be determined by
218 * platform characterization. This value is relative to the
219 * rest of the weights so a cooling device whose weight is
220 * double that of another cooling device is twice as
221 * effective. See Documentation/driver-api/thermal/sysfs-api.rst for more
227 * This is a bit mask that gives the binding relation between this
228 * thermal zone and cdev, for a particular trip point.
229 * See Documentation/driver-api/thermal/sysfs-api.rst for more information.
234 * This is an array of cooling state limits. Must have exactly
235 * 2 * thermal_zone.number_of_trip_points. It is an array consisting
236 * of tuples <lower-state upper-state> of state limits. Each trip
237 * will be associated with one state limit tuple when binding.
238 * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
241 unsigned long *binding_limits;
242 int (*match) (struct thermal_zone_device *tz,
243 struct thermal_cooling_device *cdev);
246 /* Structure to define Thermal Zone parameters */
247 struct thermal_zone_params {
248 char governor_name[THERMAL_NAME_LENGTH];
251 * a boolean to indicate if the thermal to hwmon sysfs interface
252 * is required. when no_hwmon == false, a hwmon sysfs interface
253 * will be created. when no_hwmon == true, nothing will be done
257 int num_tbps; /* Number of tbp entries */
258 struct thermal_bind_params *tbp;
261 * Sustainable power (heat) that this thermal zone can dissipate in
264 u32 sustainable_power;
267 * Proportional parameter of the PID controller when
268 * overshooting (i.e., when temperature is below the target)
273 * Proportional parameter of the PID controller when
278 /* Integral parameter of the PID controller */
281 /* Derivative parameter of the PID controller */
284 /* threshold below which the error is no longer accumulated */
288 * @slope: slope of a linear temperature adjustment curve.
289 * Used by thermal zone drivers.
293 * @offset: offset of a linear temperature adjustment curve.
294 * Used by thermal zone drivers (default 0).
300 * struct thermal_zone_of_device_ops - callbacks for handling DT based zones
303 * @get_temp: a pointer to a function that reads the sensor temperature.
306 * @get_trend: a pointer to a function that reads the sensor temperature trend.
307 * @set_trips: a pointer to a function that sets a temperature window. When
308 * this window is left the driver must inform the thermal core via
309 * thermal_zone_device_update.
310 * @set_emul_temp: a pointer to a function that sets sensor emulated
312 * @set_trip_temp: a pointer to a function that sets the trip temperature on
314 * @change_mode: a pointer to a function that notifies the thermal zone
317 struct thermal_zone_of_device_ops {
318 int (*get_temp)(void *, int *);
319 int (*get_trend)(void *, int, enum thermal_trend *);
320 int (*set_trips)(void *, int, int);
321 int (*set_emul_temp)(void *, int);
322 int (*set_trip_temp)(void *, int, int);
323 int (*change_mode) (void *, enum thermal_device_mode);
326 /* Function declarations */
327 #ifdef CONFIG_THERMAL_OF
328 int thermal_zone_of_get_sensor_id(struct device_node *tz_np,
329 struct device_node *sensor_np,
331 struct thermal_zone_device *
332 thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
333 const struct thermal_zone_of_device_ops *ops);
334 void thermal_zone_of_sensor_unregister(struct device *dev,
335 struct thermal_zone_device *tz);
336 struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
337 struct device *dev, int id, void *data,
338 const struct thermal_zone_of_device_ops *ops);
339 void devm_thermal_zone_of_sensor_unregister(struct device *dev,
340 struct thermal_zone_device *tz);
343 static inline int thermal_zone_of_get_sensor_id(struct device_node *tz_np,
344 struct device_node *sensor_np,
349 static inline struct thermal_zone_device *
350 thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
351 const struct thermal_zone_of_device_ops *ops)
353 return ERR_PTR(-ENODEV);
357 void thermal_zone_of_sensor_unregister(struct device *dev,
358 struct thermal_zone_device *tz)
362 static inline struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
363 struct device *dev, int id, void *data,
364 const struct thermal_zone_of_device_ops *ops)
366 return ERR_PTR(-ENODEV);
370 void devm_thermal_zone_of_sensor_unregister(struct device *dev,
371 struct thermal_zone_device *tz)
377 #ifdef CONFIG_THERMAL
378 struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
379 void *, struct thermal_zone_device_ops *,
380 struct thermal_zone_params *, int, int);
382 void thermal_zone_device_unregister(struct thermal_zone_device *);
384 struct thermal_zone_device *
385 thermal_zone_device_register_with_trips(const char *, struct thermal_trip *, int, int,
386 void *, struct thermal_zone_device_ops *,
387 struct thermal_zone_params *, int, int);
389 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
390 struct thermal_cooling_device *,
391 unsigned long, unsigned long,
393 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
394 struct thermal_cooling_device *);
395 void thermal_zone_device_update(struct thermal_zone_device *,
396 enum thermal_notify_event);
398 struct thermal_cooling_device *thermal_cooling_device_register(const char *,
399 void *, const struct thermal_cooling_device_ops *);
400 struct thermal_cooling_device *
401 thermal_of_cooling_device_register(struct device_node *np, const char *, void *,
402 const struct thermal_cooling_device_ops *);
403 struct thermal_cooling_device *
404 devm_thermal_of_cooling_device_register(struct device *dev,
405 struct device_node *np,
406 char *type, void *devdata,
407 const struct thermal_cooling_device_ops *ops);
408 void thermal_cooling_device_unregister(struct thermal_cooling_device *);
409 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
410 int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp);
411 int thermal_zone_get_slope(struct thermal_zone_device *tz);
412 int thermal_zone_get_offset(struct thermal_zone_device *tz);
414 int thermal_zone_device_enable(struct thermal_zone_device *tz);
415 int thermal_zone_device_disable(struct thermal_zone_device *tz);
416 void thermal_zone_device_critical(struct thermal_zone_device *tz);
418 static inline struct thermal_zone_device *thermal_zone_device_register(
419 const char *type, int trips, int mask, void *devdata,
420 struct thermal_zone_device_ops *ops,
421 struct thermal_zone_params *tzp,
422 int passive_delay, int polling_delay)
423 { return ERR_PTR(-ENODEV); }
424 static inline void thermal_zone_device_unregister(
425 struct thermal_zone_device *tz)
427 static inline struct thermal_cooling_device *
428 thermal_cooling_device_register(const char *type, void *devdata,
429 const struct thermal_cooling_device_ops *ops)
430 { return ERR_PTR(-ENODEV); }
431 static inline struct thermal_cooling_device *
432 thermal_of_cooling_device_register(struct device_node *np,
433 const char *type, void *devdata,
434 const struct thermal_cooling_device_ops *ops)
435 { return ERR_PTR(-ENODEV); }
436 static inline struct thermal_cooling_device *
437 devm_thermal_of_cooling_device_register(struct device *dev,
438 struct device_node *np,
439 char *type, void *devdata,
440 const struct thermal_cooling_device_ops *ops)
442 return ERR_PTR(-ENODEV);
444 static inline void thermal_cooling_device_unregister(
445 struct thermal_cooling_device *cdev)
447 static inline struct thermal_zone_device *thermal_zone_get_zone_by_name(
449 { return ERR_PTR(-ENODEV); }
450 static inline int thermal_zone_get_temp(
451 struct thermal_zone_device *tz, int *temp)
453 static inline int thermal_zone_get_slope(
454 struct thermal_zone_device *tz)
456 static inline int thermal_zone_get_offset(
457 struct thermal_zone_device *tz)
460 static inline int thermal_zone_device_enable(struct thermal_zone_device *tz)
463 static inline int thermal_zone_device_disable(struct thermal_zone_device *tz)
465 #endif /* CONFIG_THERMAL */
467 #endif /* __THERMAL_H__ */