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_TRIPS_NONE -1
21 #define THERMAL_MAX_TRIPS 12
23 /* invalid cooling state */
24 #define THERMAL_CSTATE_INVALID -1UL
26 /* No upper/lower limit requirement */
27 #define THERMAL_NO_LIMIT ((u32)~0)
29 /* Default weight of a bound cooling device */
30 #define THERMAL_WEIGHT_DEFAULT 0
32 /* use value, which < 0K, to indicate an invalid/uninitialized temperature */
33 #define THERMAL_TEMP_INVALID -274000
35 struct thermal_zone_device
;
36 struct thermal_cooling_device
;
37 struct thermal_instance
;
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 */
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 */
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 void (*hot
)(struct thermal_zone_device
*);
81 void (*critical
)(struct thermal_zone_device
*);
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 *);
93 struct thermal_cooling_device
{
95 char type
[THERMAL_NAME_LENGTH
];
97 struct device_node
*np
;
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
;
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
132 * @prev_high_trip: the above current temperature if you've crossed a
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
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
150 struct thermal_zone_device
{
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
;
161 unsigned long trips_disabled
; /* bitmap for disabled trips */
165 int last_temperature
;
166 int emul_temperature
;
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
;
176 struct list_head thermal_instances
;
179 struct list_head node
;
180 struct delayed_work poll_queue
;
181 enum thermal_notify_event notify_event
;
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
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)
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
;
204 /* Structure that holds binding parameters for a zone */
205 struct thermal_bind_params
{
206 struct thermal_cooling_device
*cdev
;
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
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.
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>
234 unsigned long *binding_limits
;
235 int (*match
) (struct thermal_zone_device
*tz
,
236 struct thermal_cooling_device
*cdev
);
239 /* Structure to define Thermal Zone parameters */
240 struct thermal_zone_params
{
241 char governor_name
[THERMAL_NAME_LENGTH
];
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
250 int num_tbps
; /* Number of tbp entries */
251 struct thermal_bind_params
*tbp
;
254 * Sustainable power (heat) that this thermal zone can dissipate in
257 u32 sustainable_power
;
260 * Proportional parameter of the PID controller when
261 * overshooting (i.e., when temperature is below the target)
266 * Proportional parameter of the PID controller when
271 /* Integral parameter of the PID controller */
274 /* Derivative parameter of the PID controller */
277 /* threshold below which the error is no longer accumulated */
281 * @slope: slope of a linear temperature adjustment curve.
282 * Used by thermal zone drivers.
286 * @offset: offset of a linear temperature adjustment curve.
287 * Used by thermal zone drivers (default 0).
293 * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones
296 * @get_temp: a pointer to a function that reads the sensor temperature.
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
305 * @set_trip_temp: a pointer to a function that sets the trip temperature on
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);
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
,
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
);
333 static inline int thermal_zone_of_get_sensor_id(struct device_node
*tz_np
,
334 struct device_node
*sensor_np
,
339 static inline struct thermal_zone_device
*
340 thermal_zone_of_sensor_register(struct device
*dev
, int id
, void *data
,
341 const struct thermal_zone_of_device_ops
*ops
)
343 return ERR_PTR(-ENODEV
);
347 void thermal_zone_of_sensor_unregister(struct device
*dev
,
348 struct thermal_zone_device
*tz
)
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
)
356 return ERR_PTR(-ENODEV
);
360 void devm_thermal_zone_of_sensor_unregister(struct device
*dev
,
361 struct thermal_zone_device
*tz
)
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
*);
373 int thermal_zone_bind_cooling_device(struct thermal_zone_device
*, int,
374 struct thermal_cooling_device
*,
375 unsigned long, unsigned long,
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
);
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
);
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 void thermal_zone_device_critical(struct thermal_zone_device
*tz
);
404 static inline struct thermal_zone_device
*thermal_zone_device_register(
405 const char *type
, int trips
, int mask
, void *devdata
,
406 struct thermal_zone_device_ops
*ops
,
407 struct thermal_zone_params
*tzp
,
408 int passive_delay
, int polling_delay
)
409 { return ERR_PTR(-ENODEV
); }
410 static inline void thermal_zone_device_unregister(
411 struct thermal_zone_device
*tz
)
413 static inline struct thermal_cooling_device
*
414 thermal_cooling_device_register(char *type
, void *devdata
,
415 const struct thermal_cooling_device_ops
*ops
)
416 { return ERR_PTR(-ENODEV
); }
417 static inline struct thermal_cooling_device
*
418 thermal_of_cooling_device_register(struct device_node
*np
,
419 char *type
, void *devdata
, const struct thermal_cooling_device_ops
*ops
)
420 { return ERR_PTR(-ENODEV
); }
421 static inline struct thermal_cooling_device
*
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
)
427 return ERR_PTR(-ENODEV
);
429 static inline void thermal_cooling_device_unregister(
430 struct thermal_cooling_device
*cdev
)
432 static inline struct thermal_zone_device
*thermal_zone_get_zone_by_name(
434 { return ERR_PTR(-ENODEV
); }
435 static inline int thermal_zone_get_temp(
436 struct thermal_zone_device
*tz
, int *temp
)
438 static inline int thermal_zone_get_slope(
439 struct thermal_zone_device
*tz
)
441 static inline int thermal_zone_get_offset(
442 struct thermal_zone_device
*tz
)
445 static inline void thermal_cdev_update(struct thermal_cooling_device
*cdev
)
447 static inline void thermal_notify_framework(struct thermal_zone_device
*tz
,
451 static inline int thermal_zone_device_enable(struct thermal_zone_device
*tz
)
454 static inline int thermal_zone_device_disable(struct thermal_zone_device
*tz
)
456 #endif /* CONFIG_THERMAL */
458 #endif /* __THERMAL_H__ */