Merge tag 'io_uring-6.16-20250630' of git://git.kernel.dk/linux
[linux-2.6-block.git] / include / linux / thermal.h
CommitLineData
7e3c0381 1/* SPDX-License-Identifier: GPL-2.0 */
203d3d4a
ZR
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>
203d3d4a
ZR
8 */
9
10#ifndef __THERMAL_H__
11#define __THERMAL_H__
12
a116b5d4 13#include <linux/of.h>
203d3d4a
ZR
14#include <linux/idr.h>
15#include <linux/device.h>
4d0fe749 16#include <linux/sysfs.h>
b1569e99 17#include <linux/workqueue.h>
af6c9f16 18#include <uapi/linux/thermal.h>
203d3d4a 19
57df8106
ZR
20/* invalid cooling state */
21#define THERMAL_CSTATE_INVALID -1UL
22
23064088 23/* No upper/lower limit requirement */
a940cb34 24#define THERMAL_NO_LIMIT ((u32)~0)
23064088 25
6cd9e9f6
KS
26/* Default weight of a bound cooling device */
27#define THERMAL_WEIGHT_DEFAULT 0
28
bb431ba2
ZR
29/* use value, which < 0K, to indicate an invalid/uninitialized temperature */
30#define THERMAL_TEMP_INVALID -274000
31
203d3d4a
ZR
32struct thermal_zone_device;
33struct thermal_cooling_device;
35b11d2e 34struct thermal_instance;
755113d7 35struct thermal_debugfs;
c68df440 36struct thermal_attr;
203d3d4a 37
601f3d42
ZR
38enum thermal_trend {
39 THERMAL_TREND_STABLE, /* temperature is stable */
40 THERMAL_TREND_RAISING, /* temperature is raising */
41 THERMAL_TREND_DROPPING, /* temperature is dropping */
42};
43
0e70f466
SP
44/* Thermal notification reason */
45enum thermal_notify_event {
46 THERMAL_EVENT_UNSPECIFIED, /* Unspecified event */
47 THERMAL_EVENT_TEMP_SAMPLE, /* New Temperature sample */
48 THERMAL_TRIP_VIOLATED, /* TRIP Point violation */
49 THERMAL_TRIP_CHANGED, /* TRIP Point temperature changed */
50 THERMAL_DEVICE_DOWN, /* Thermal device is down */
51 THERMAL_DEVICE_UP, /* Thermal device is up after a down event */
52 THERMAL_DEVICE_POWER_CAPABILITY_CHANGED, /* power capability changed */
38e44da5 53 THERMAL_TABLE_CHANGED, /* Thermal table(s) changed */
88052319 54 THERMAL_EVENT_KEEP_ALIVE, /* Request for user space handler to respond */
a8c95940
LL
55 THERMAL_TZ_BIND_CDEV, /* Cooling dev is bind to the thermal zone */
56 THERMAL_TZ_UNBIND_CDEV, /* Cooling dev is unbind from the thermal zone */
bfc57bd1 57 THERMAL_INSTANCE_WEIGHT_CHANGED, /* Thermal instance weight changed */
6e6f58a1 58 THERMAL_TZ_RESUME, /* Thermal zone is resuming after system sleep */
445936f9
DL
59 THERMAL_TZ_ADD_THRESHOLD, /* Threshold added */
60 THERMAL_TZ_DEL_THRESHOLD, /* Threshold deleted */
61 THERMAL_TZ_FLUSH_THRESHOLDS, /* All thresholds deleted */
0e70f466
SP
62};
63
8289d810
RW
64/**
65 * struct thermal_trip - representation of a point in temperature domain
66 * @temperature: temperature value in miliCelsius
67 * @hysteresis: relative hysteresis in miliCelsius
68 * @type: trip point type
69 * @priv: pointer to driver data associated with this trip
5340f764 70 * @flags: flags representing binary properties of the trip
8289d810
RW
71 */
72struct thermal_trip {
73 int temperature;
74 int hysteresis;
75 enum thermal_trip_type type;
5340f764 76 u8 flags;
8289d810
RW
77 void *priv;
78};
79
5340f764
RW
80#define THERMAL_TRIP_FLAG_RW_TEMP BIT(0)
81#define THERMAL_TRIP_FLAG_RW_HYST BIT(1)
82
83#define THERMAL_TRIP_FLAG_RW (THERMAL_TRIP_FLAG_RW_TEMP | \
84 THERMAL_TRIP_FLAG_RW_HYST)
85
d1fbf18a
RW
86#define THERMAL_TRIP_PRIV_TO_INT(_val_) (uintptr_t)(_val_)
87#define THERMAL_INT_TO_TRIP_PRIV(_val_) (void *)(uintptr_t)(_val_)
88
aa35e56a
RW
89struct cooling_spec {
90 unsigned long upper; /* Highest cooling state */
91 unsigned long lower; /* Lowest cooling state */
92 unsigned int weight; /* Cooling device weight */
93};
94
203d3d4a 95struct thermal_zone_device_ops {
aa35e56a
RW
96 bool (*should_bind) (struct thermal_zone_device *,
97 const struct thermal_trip *,
98 struct thermal_cooling_device *,
99 struct cooling_spec *);
17e8351a 100 int (*get_temp) (struct thermal_zone_device *, int *);
060c034a 101 int (*set_trips) (struct thermal_zone_device *, int, int);
f5e50bf4 102 int (*change_mode) (struct thermal_zone_device *,
6503e5df 103 enum thermal_device_mode);
0728c810
RW
104 int (*set_trip_temp) (struct thermal_zone_device *,
105 const struct thermal_trip *, int);
17e8351a
SH
106 int (*get_crit_temp) (struct thermal_zone_device *, int *);
107 int (*set_emul_temp) (struct thermal_zone_device *, int);
ebc7abb3
RW
108 int (*get_trend) (struct thermal_zone_device *,
109 const struct thermal_trip *, enum thermal_trend *);
d7203eed
DL
110 void (*hot)(struct thermal_zone_device *);
111 void (*critical)(struct thermal_zone_device *);
203d3d4a
ZR
112};
113
114struct thermal_cooling_device_ops {
6503e5df
MG
115 int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
116 int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
117 int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
ecd1d2a3 118 int (*get_requested_power)(struct thermal_cooling_device *, u32 *);
119 int (*state2power)(struct thermal_cooling_device *, unsigned long, u32 *);
120 int (*power2state)(struct thermal_cooling_device *, u32, unsigned long *);
203d3d4a
ZR
121};
122
203d3d4a
ZR
123struct thermal_cooling_device {
124 int id;
57a427c8 125 const char *type;
c408b3d1 126 unsigned long max_state;
203d3d4a 127 struct device device;
4e5e4705 128 struct device_node *np;
203d3d4a 129 void *devdata;
8ea22951 130 void *stats;
5b275ce2 131 const struct thermal_cooling_device_ops *ops;
ce119f83 132 bool updated; /* true if the cooling device does not need update */
f4a821ce 133 struct mutex lock; /* protect thermal_instances list */
b5e4ae62 134 struct list_head thermal_instances;
203d3d4a 135 struct list_head node;
755113d7
DL
136#ifdef CONFIG_THERMAL_DEBUGFS
137 struct thermal_debugfs *debugfs;
138#endif
203d3d4a
ZR
139};
140
a5a98a78
RW
141DEFINE_GUARD(cooling_dev, struct thermal_cooling_device *, mutex_lock(&_T->lock),
142 mutex_unlock(&_T->lock))
143
ef873947
D
144/* Structure to define Thermal Zone parameters */
145struct thermal_zone_params {
b377252e 146 const char *governor_name;
ccba4ffd
EV
147
148 /*
149 * a boolean to indicate if the thermal to hwmon sysfs interface
150 * is required. when no_hwmon == false, a hwmon sysfs interface
151 * will be created. when no_hwmon == true, nothing will be done
152 */
153 bool no_hwmon;
154
6b775e87
JM
155 /*
156 * Sustainable power (heat) that this thermal zone can dissipate in
157 * mW
158 */
159 u32 sustainable_power;
160
161 /*
162 * Proportional parameter of the PID controller when
163 * overshooting (i.e., when temperature is below the target)
164 */
165 s32 k_po;
166
167 /*
168 * Proportional parameter of the PID controller when
169 * undershooting
170 */
171 s32 k_pu;
172
173 /* Integral parameter of the PID controller */
174 s32 k_i;
175
176 /* Derivative parameter of the PID controller */
177 s32 k_d;
178
179 /* threshold below which the error is no longer accumulated */
180 s32 integral_cutoff;
9d0be7f4
EV
181
182 /*
183 * @slope: slope of a linear temperature adjustment curve.
184 * Used by thermal zone drivers.
185 */
186 int slope;
187 /*
188 * @offset: offset of a linear temperature adjustment curve.
189 * Used by thermal zone drivers (default 0).
190 */
191 int offset;
ef873947
D
192};
193
23064088 194/* Function declarations */
4e5e4705 195#ifdef CONFIG_THERMAL_OF
3fd6d6e2
DL
196struct thermal_zone_device *devm_thermal_of_zone_register(struct device *dev, int id, void *data,
197 const struct thermal_zone_device_ops *ops);
198
3fd6d6e2
DL
199void devm_thermal_of_zone_unregister(struct device *dev, struct thermal_zone_device *tz);
200
4e5e4705 201#else
4e5e4705 202
f59ac19b
DL
203static inline
204struct thermal_zone_device *devm_thermal_of_zone_register(struct device *dev, int id, void *data,
205 const struct thermal_zone_device_ops *ops)
e498b498 206{
f59ac19b 207 return ERR_PTR(-ENOTSUPP);
e498b498
LD
208}
209
f59ac19b
DL
210static inline void devm_thermal_of_zone_unregister(struct device *dev,
211 struct thermal_zone_device *tz)
3fd6d6e2
DL
212{
213}
4e5e4705 214#endif
12ca7188 215
96b8b436
RW
216int for_each_thermal_trip(struct thermal_zone_device *tz,
217 int (*cb)(struct thermal_trip *, void *),
218 void *data);
a56cc0a8
RW
219int thermal_zone_for_each_trip(struct thermal_zone_device *tz,
220 int (*cb)(struct thermal_trip *, void *),
221 void *data);
bdc22c8d
RW
222void thermal_zone_set_trip_temp(struct thermal_zone_device *tz,
223 struct thermal_trip *trip, int temp);
7c3d5c20
DL
224
225int thermal_zone_get_crit_temp(struct thermal_zone_device *tz, int *temp);
226
60518260 227#ifdef CONFIG_THERMAL
9ffa7b92
RW
228struct thermal_zone_device *thermal_zone_device_register_with_trips(
229 const char *type,
9b0a6275 230 const struct thermal_trip *trips,
4a62d588 231 int num_trips, void *devdata,
698a1eb1 232 const struct thermal_zone_device_ops *ops,
9ffa7b92 233 const struct thermal_zone_params *tzp,
d05374de
RW
234 unsigned int passive_delay,
235 unsigned int polling_delay);
9ffa7b92 236
d332db8f
RW
237struct thermal_zone_device *thermal_tripless_zone_device_register(
238 const char *type,
239 void *devdata,
698a1eb1 240 const struct thermal_zone_device_ops *ops,
d332db8f
RW
241 const struct thermal_zone_params *tzp);
242
9ffa7b92 243void thermal_zone_device_unregister(struct thermal_zone_device *tz);
fae11de5 244
a6ff3c00 245void *thermal_zone_device_priv(struct thermal_zone_device *tzd);
072e35c9 246const char *thermal_zone_device_type(struct thermal_zone_device *tzd);
3034f859 247int thermal_zone_device_id(struct thermal_zone_device *tzd);
7cefbaf0 248struct device *thermal_zone_device(struct thermal_zone_device *tzd);
a6ff3c00 249
0e70f466
SP
250void thermal_zone_device_update(struct thermal_zone_device *,
251 enum thermal_notify_event);
23064088 252
f991de53
JFD
253struct thermal_cooling_device *thermal_cooling_device_register(const char *,
254 void *, const struct thermal_cooling_device_ops *);
a116b5d4 255struct thermal_cooling_device *
f991de53 256thermal_of_cooling_device_register(struct device_node *np, const char *, void *,
a116b5d4 257 const struct thermal_cooling_device_ops *);
b4ab114c
GR
258struct thermal_cooling_device *
259devm_thermal_of_cooling_device_register(struct device *dev,
260 struct device_node *np,
4acab508 261 const char *type, void *devdata,
b4ab114c 262 const struct thermal_cooling_device_ops *ops);
790930f4 263void thermal_cooling_device_update(struct thermal_cooling_device *);
203d3d4a 264void thermal_cooling_device_unregister(struct thermal_cooling_device *);
63c4d919 265struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
17e8351a 266int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp);
4a7069a3
RN
267int thermal_zone_get_slope(struct thermal_zone_device *tz);
268int thermal_zone_get_offset(struct thermal_zone_device *tz);
463b86fe
RW
269bool thermal_trip_is_bound_to_cdev(struct thermal_zone_device *tz,
270 const struct thermal_trip *trip,
271 struct thermal_cooling_device *cdev);
af06216a 272
ac5d9ecc
AP
273int thermal_zone_device_enable(struct thermal_zone_device *tz);
274int thermal_zone_device_disable(struct thermal_zone_device *tz);
d7203eed 275void thermal_zone_device_critical(struct thermal_zone_device *tz);
12ca7188 276#else
9ffa7b92
RW
277static inline struct thermal_zone_device *thermal_zone_device_register_with_trips(
278 const char *type,
9b0a6275 279 const struct thermal_trip *trips,
4a62d588 280 int num_trips, void *devdata,
698a1eb1 281 const struct thermal_zone_device_ops *ops,
9ffa7b92
RW
282 const struct thermal_zone_params *tzp,
283 int passive_delay, int polling_delay)
12ca7188 284{ return ERR_PTR(-ENODEV); }
9ffa7b92 285
d332db8f
RW
286static inline struct thermal_zone_device *thermal_tripless_zone_device_register(
287 const char *type,
288 void *devdata,
289 struct thermal_zone_device_ops *ops,
290 const struct thermal_zone_params *tzp)
291{ return ERR_PTR(-ENODEV); }
292
9ffa7b92 293static inline void thermal_zone_device_unregister(struct thermal_zone_device *tz)
12ca7188 294{ }
9ffa7b92 295
868dc3cd
TW
296static inline void thermal_zone_device_update(struct thermal_zone_device *tz,
297 enum thermal_notify_event event)
298{ }
299
12ca7188 300static inline struct thermal_cooling_device *
fb836107 301thermal_cooling_device_register(const char *type, void *devdata,
12ca7188
NM
302 const struct thermal_cooling_device_ops *ops)
303{ return ERR_PTR(-ENODEV); }
304static inline struct thermal_cooling_device *
305thermal_of_cooling_device_register(struct device_node *np,
fb836107
AB
306 const char *type, void *devdata,
307 const struct thermal_cooling_device_ops *ops)
12ca7188 308{ return ERR_PTR(-ENODEV); }
b4ab114c
GR
309static inline struct thermal_cooling_device *
310devm_thermal_of_cooling_device_register(struct device *dev,
311 struct device_node *np,
4acab508 312 const char *type, void *devdata,
b4ab114c
GR
313 const struct thermal_cooling_device_ops *ops)
314{
315 return ERR_PTR(-ENODEV);
316}
12ca7188
NM
317static inline void thermal_cooling_device_unregister(
318 struct thermal_cooling_device *cdev)
319{ }
320static inline struct thermal_zone_device *thermal_zone_get_zone_by_name(
321 const char *name)
322{ return ERR_PTR(-ENODEV); }
323static inline int thermal_zone_get_temp(
17e8351a 324 struct thermal_zone_device *tz, int *temp)
12ca7188 325{ return -ENODEV; }
4a7069a3
RN
326static inline int thermal_zone_get_slope(
327 struct thermal_zone_device *tz)
328{ return -ENODEV; }
329static inline int thermal_zone_get_offset(
330 struct thermal_zone_device *tz)
331{ return -ENODEV; }
f0129c23 332
a6ff3c00
DL
333static inline void *thermal_zone_device_priv(struct thermal_zone_device *tz)
334{
335 return NULL;
336}
337
072e35c9
DL
338static inline const char *thermal_zone_device_type(struct thermal_zone_device *tzd)
339{
340 return NULL;
341}
342
3034f859
DL
343static inline int thermal_zone_device_id(struct thermal_zone_device *tzd)
344{
345 return -ENODEV;
346}
347
ac5d9ecc
AP
348static inline int thermal_zone_device_enable(struct thermal_zone_device *tz)
349{ return -ENODEV; }
350
351static inline int thermal_zone_device_disable(struct thermal_zone_device *tz)
352{ return -ENODEV; }
12ca7188
NM
353#endif /* CONFIG_THERMAL */
354
a0dd25b2 355#endif /* __THERMAL_H__ */