2 * thermal.h ($Revision: 0 $)
4 * Copyright (C) 2008 Intel Corp
5 * Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
6 * Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; version 2 of the License.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
22 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29 #include <linux/idr.h>
30 #include <linux/device.h>
31 #include <linux/workqueue.h>
32 #include <uapi/linux/thermal.h>
34 #define THERMAL_TRIPS_NONE -1
35 #define THERMAL_MAX_TRIPS 12
37 /* invalid cooling state */
38 #define THERMAL_CSTATE_INVALID -1UL
40 /* No upper/lower limit requirement */
41 #define THERMAL_NO_LIMIT ((u32)~0)
43 /* Default weight of a bound cooling device */
44 #define THERMAL_WEIGHT_DEFAULT 0
46 /* Unit conversion macros */
47 #define KELVIN_TO_CELSIUS(t) (long)(((long)t-2732 >= 0) ? \
48 ((long)t-2732+5)/10 : ((long)t-2732-5)/10)
49 #define CELSIUS_TO_KELVIN(t) ((t)*10+2732)
50 #define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100)
51 #define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 2732)
52 #define MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, off) (((t) / 100) + (off))
53 #define MILLICELSIUS_TO_DECI_KELVIN(t) MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, 2732)
55 /* Default Thermal Governor */
56 #if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
57 #define DEFAULT_THERMAL_GOVERNOR "step_wise"
58 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
59 #define DEFAULT_THERMAL_GOVERNOR "fair_share"
60 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
61 #define DEFAULT_THERMAL_GOVERNOR "user_space"
62 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_POWER_ALLOCATOR)
63 #define DEFAULT_THERMAL_GOVERNOR "power_allocator"
66 struct thermal_zone_device
;
67 struct thermal_cooling_device
;
68 struct thermal_instance
;
70 enum thermal_device_mode
{
71 THERMAL_DEVICE_DISABLED
= 0,
72 THERMAL_DEVICE_ENABLED
,
75 enum thermal_trip_type
{
76 THERMAL_TRIP_ACTIVE
= 0,
79 THERMAL_TRIP_CRITICAL
,
83 THERMAL_TREND_STABLE
, /* temperature is stable */
84 THERMAL_TREND_RAISING
, /* temperature is raising */
85 THERMAL_TREND_DROPPING
, /* temperature is dropping */
86 THERMAL_TREND_RAISE_FULL
, /* apply highest cooling action */
87 THERMAL_TREND_DROP_FULL
, /* apply lowest cooling action */
90 struct thermal_zone_device_ops
{
91 int (*bind
) (struct thermal_zone_device
*,
92 struct thermal_cooling_device
*);
93 int (*unbind
) (struct thermal_zone_device
*,
94 struct thermal_cooling_device
*);
95 int (*get_temp
) (struct thermal_zone_device
*, int *);
96 int (*get_mode
) (struct thermal_zone_device
*,
97 enum thermal_device_mode
*);
98 int (*set_mode
) (struct thermal_zone_device
*,
99 enum thermal_device_mode
);
100 int (*get_trip_type
) (struct thermal_zone_device
*, int,
101 enum thermal_trip_type
*);
102 int (*get_trip_temp
) (struct thermal_zone_device
*, int, int *);
103 int (*set_trip_temp
) (struct thermal_zone_device
*, int, int);
104 int (*get_trip_hyst
) (struct thermal_zone_device
*, int, int *);
105 int (*set_trip_hyst
) (struct thermal_zone_device
*, int, int);
106 int (*get_crit_temp
) (struct thermal_zone_device
*, int *);
107 int (*set_emul_temp
) (struct thermal_zone_device
*, int);
108 int (*get_trend
) (struct thermal_zone_device
*, int,
109 enum thermal_trend
*);
110 int (*notify
) (struct thermal_zone_device
*, int,
111 enum thermal_trip_type
);
114 struct thermal_cooling_device_ops
{
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);
118 int (*get_requested_power
)(struct thermal_cooling_device
*,
119 struct thermal_zone_device
*, u32
*);
120 int (*state2power
)(struct thermal_cooling_device
*,
121 struct thermal_zone_device
*, unsigned long, u32
*);
122 int (*power2state
)(struct thermal_cooling_device
*,
123 struct thermal_zone_device
*, u32
, unsigned long *);
126 struct thermal_cooling_device
{
128 char type
[THERMAL_NAME_LENGTH
];
129 struct device device
;
130 struct device_node
*np
;
132 const struct thermal_cooling_device_ops
*ops
;
133 bool updated
; /* true if the cooling device does not need update */
134 struct mutex lock
; /* protect thermal_instances list */
135 struct list_head thermal_instances
;
136 struct list_head node
;
139 struct thermal_attr
{
140 struct device_attribute attr
;
141 char name
[THERMAL_NAME_LENGTH
];
145 * struct thermal_zone_device - structure for a thermal zone
146 * @id: unique id number for each thermal zone
147 * @type: the thermal zone device type
148 * @device: &struct device for this thermal zone
149 * @trip_temp_attrs: attributes for trip points for sysfs: trip temperature
150 * @trip_type_attrs: attributes for trip points for sysfs: trip type
151 * @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis
152 * @devdata: private pointer for device private data
153 * @trips: number of trip points the thermal zone supports
154 * @passive_delay: number of milliseconds to wait between polls when
155 * performing passive cooling.
156 * @polling_delay: number of milliseconds to wait between polls when
157 * checking whether trip points have been crossed (0 for
158 * interrupt driven systems)
159 * @temperature: current temperature. This is only for core code,
160 * drivers should use thermal_zone_get_temp() to get the
161 * current temperature
162 * @last_temperature: previous temperature read
163 * @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION
164 * @passive: 1 if you've crossed a passive trip point, 0 otherwise.
165 * @forced_passive: If > 0, temperature at which to switch on all ACPI
166 * processor cooling devices. Currently only used by the
167 * step-wise governor.
168 * @ops: operations this &thermal_zone_device supports
169 * @tzp: thermal zone parameters
170 * @governor: pointer to the governor for this thermal zone
171 * @governor_data: private pointer for governor data
172 * @thermal_instances: list of &struct thermal_instance of this thermal zone
173 * @idr: &struct idr to generate unique id for this zone's cooling
175 * @lock: lock to protect thermal_instances list
176 * @node: node in thermal_tz_list (in thermal_core.c)
177 * @poll_queue: delayed work for polling
179 struct thermal_zone_device
{
181 char type
[THERMAL_NAME_LENGTH
];
182 struct device device
;
183 struct thermal_attr
*trip_temp_attrs
;
184 struct thermal_attr
*trip_type_attrs
;
185 struct thermal_attr
*trip_hyst_attrs
;
191 int last_temperature
;
192 int emul_temperature
;
194 unsigned int forced_passive
;
195 struct thermal_zone_device_ops
*ops
;
196 struct thermal_zone_params
*tzp
;
197 struct thermal_governor
*governor
;
199 struct list_head thermal_instances
;
202 struct list_head node
;
203 struct delayed_work poll_queue
;
207 * struct thermal_governor - structure that holds thermal governor information
208 * @name: name of the governor
209 * @bind_to_tz: callback called when binding to a thermal zone. If it
210 * returns 0, the governor is bound to the thermal zone,
211 * otherwise it fails.
212 * @unbind_from_tz: callback called when a governor is unbound from a
214 * @throttle: callback called for every trip point even if temperature is
215 * below the trip point temperature
216 * @governor_list: node in thermal_governor_list (in thermal_core.c)
218 struct thermal_governor
{
219 char name
[THERMAL_NAME_LENGTH
];
220 int (*bind_to_tz
)(struct thermal_zone_device
*tz
);
221 void (*unbind_from_tz
)(struct thermal_zone_device
*tz
);
222 int (*throttle
)(struct thermal_zone_device
*tz
, int trip
);
223 struct list_head governor_list
;
226 /* Structure that holds binding parameters for a zone */
227 struct thermal_bind_params
{
228 struct thermal_cooling_device
*cdev
;
231 * This is a measure of 'how effectively these devices can
232 * cool 'this' thermal zone. It shall be determined by
233 * platform characterization. This value is relative to the
234 * rest of the weights so a cooling device whose weight is
235 * double that of another cooling device is twice as
236 * effective. See Documentation/thermal/sysfs-api.txt for more
242 * This is a bit mask that gives the binding relation between this
243 * thermal zone and cdev, for a particular trip point.
244 * See Documentation/thermal/sysfs-api.txt for more information.
249 * This is an array of cooling state limits. Must have exactly
250 * 2 * thermal_zone.number_of_trip_points. It is an array consisting
251 * of tuples <lower-state upper-state> of state limits. Each trip
252 * will be associated with one state limit tuple when binding.
253 * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
256 unsigned long *binding_limits
;
257 int (*match
) (struct thermal_zone_device
*tz
,
258 struct thermal_cooling_device
*cdev
);
261 /* Structure to define Thermal Zone parameters */
262 struct thermal_zone_params
{
263 char governor_name
[THERMAL_NAME_LENGTH
];
266 * a boolean to indicate if the thermal to hwmon sysfs interface
267 * is required. when no_hwmon == false, a hwmon sysfs interface
268 * will be created. when no_hwmon == true, nothing will be done
272 int num_tbps
; /* Number of tbp entries */
273 struct thermal_bind_params
*tbp
;
276 * Sustainable power (heat) that this thermal zone can dissipate in
279 u32 sustainable_power
;
282 * Proportional parameter of the PID controller when
283 * overshooting (i.e., when temperature is below the target)
288 * Proportional parameter of the PID controller when
293 /* Integral parameter of the PID controller */
296 /* Derivative parameter of the PID controller */
299 /* threshold below which the error is no longer accumulated */
303 * @slope: slope of a linear temperature adjustment curve.
304 * Used by thermal zone drivers.
308 * @offset: offset of a linear temperature adjustment curve.
309 * Used by thermal zone drivers (default 0).
314 struct thermal_genl_event
{
320 * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones
323 * @get_temp: a pointer to a function that reads the sensor temperature.
326 * @get_trend: a pointer to a function that reads the sensor temperature trend.
327 * @set_emul_temp: a pointer to a function that sets sensor emulated
330 struct thermal_zone_of_device_ops
{
331 int (*get_temp
)(void *, int *);
332 int (*get_trend
)(void *, long *);
333 int (*set_emul_temp
)(void *, int);
337 * struct thermal_trip - representation of a point in temperature domain
338 * @np: pointer to struct device_node that this trip point was created from
339 * @temperature: temperature value in miliCelsius
340 * @hysteresis: relative hysteresis in miliCelsius
341 * @type: trip point type
344 struct thermal_trip
{
345 struct device_node
*np
;
346 unsigned long int temperature
;
347 unsigned long int hysteresis
;
348 enum thermal_trip_type type
;
351 /* Function declarations */
352 #ifdef CONFIG_THERMAL_OF
353 struct thermal_zone_device
*
354 thermal_zone_of_sensor_register(struct device
*dev
, int id
, void *data
,
355 const struct thermal_zone_of_device_ops
*ops
);
356 void thermal_zone_of_sensor_unregister(struct device
*dev
,
357 struct thermal_zone_device
*tz
);
359 static inline struct thermal_zone_device
*
360 thermal_zone_of_sensor_register(struct device
*dev
, int id
, void *data
,
361 const struct thermal_zone_of_device_ops
*ops
)
363 return ERR_PTR(-ENODEV
);
367 void thermal_zone_of_sensor_unregister(struct device
*dev
,
368 struct thermal_zone_device
*tz
)
374 #if IS_ENABLED(CONFIG_THERMAL)
375 static inline bool cdev_is_power_actor(struct thermal_cooling_device
*cdev
)
377 return cdev
->ops
->get_requested_power
&& cdev
->ops
->state2power
&&
378 cdev
->ops
->power2state
;
381 int power_actor_get_max_power(struct thermal_cooling_device
*,
382 struct thermal_zone_device
*tz
, u32
*max_power
);
383 int power_actor_get_min_power(struct thermal_cooling_device
*,
384 struct thermal_zone_device
*tz
, u32
*min_power
);
385 int power_actor_set_power(struct thermal_cooling_device
*,
386 struct thermal_instance
*, u32
);
387 struct thermal_zone_device
*thermal_zone_device_register(const char *, int, int,
388 void *, struct thermal_zone_device_ops
*,
389 struct thermal_zone_params
*, int, int);
390 void thermal_zone_device_unregister(struct thermal_zone_device
*);
392 int thermal_zone_bind_cooling_device(struct thermal_zone_device
*, int,
393 struct thermal_cooling_device
*,
394 unsigned long, unsigned long,
396 int thermal_zone_unbind_cooling_device(struct thermal_zone_device
*, int,
397 struct thermal_cooling_device
*);
398 void thermal_zone_device_update(struct thermal_zone_device
*);
400 struct thermal_cooling_device
*thermal_cooling_device_register(char *, void *,
401 const struct thermal_cooling_device_ops
*);
402 struct thermal_cooling_device
*
403 thermal_of_cooling_device_register(struct device_node
*np
, char *, void *,
404 const struct thermal_cooling_device_ops
*);
405 void thermal_cooling_device_unregister(struct thermal_cooling_device
*);
406 struct thermal_zone_device
*thermal_zone_get_zone_by_name(const char *name
);
407 int thermal_zone_get_temp(struct thermal_zone_device
*tz
, int *temp
);
409 int get_tz_trend(struct thermal_zone_device
*, int);
410 struct thermal_instance
*get_thermal_instance(struct thermal_zone_device
*,
411 struct thermal_cooling_device
*, int);
412 void thermal_cdev_update(struct thermal_cooling_device
*);
413 void thermal_notify_framework(struct thermal_zone_device
*, int);
415 static inline bool cdev_is_power_actor(struct thermal_cooling_device
*cdev
)
417 static inline int power_actor_get_max_power(struct thermal_cooling_device
*cdev
,
418 struct thermal_zone_device
*tz
, u32
*max_power
)
420 static inline int power_actor_get_min_power(struct thermal_cooling_device
*cdev
,
421 struct thermal_zone_device
*tz
,
424 static inline int power_actor_set_power(struct thermal_cooling_device
*cdev
,
425 struct thermal_instance
*tz
, u32 power
)
427 static inline struct thermal_zone_device
*thermal_zone_device_register(
428 const char *type
, int trips
, int mask
, void *devdata
,
429 struct thermal_zone_device_ops
*ops
,
430 const struct thermal_zone_params
*tzp
,
431 int passive_delay
, int polling_delay
)
432 { return ERR_PTR(-ENODEV
); }
433 static inline void thermal_zone_device_unregister(
434 struct thermal_zone_device
*tz
)
436 static inline int thermal_zone_bind_cooling_device(
437 struct thermal_zone_device
*tz
, int trip
,
438 struct thermal_cooling_device
*cdev
,
439 unsigned long upper
, unsigned long lower
)
441 static inline int thermal_zone_unbind_cooling_device(
442 struct thermal_zone_device
*tz
, int trip
,
443 struct thermal_cooling_device
*cdev
)
445 static inline void thermal_zone_device_update(struct thermal_zone_device
*tz
)
447 static inline struct thermal_cooling_device
*
448 thermal_cooling_device_register(char *type
, void *devdata
,
449 const struct thermal_cooling_device_ops
*ops
)
450 { return ERR_PTR(-ENODEV
); }
451 static inline struct thermal_cooling_device
*
452 thermal_of_cooling_device_register(struct device_node
*np
,
453 char *type
, void *devdata
, const struct thermal_cooling_device_ops
*ops
)
454 { return ERR_PTR(-ENODEV
); }
455 static inline void thermal_cooling_device_unregister(
456 struct thermal_cooling_device
*cdev
)
458 static inline struct thermal_zone_device
*thermal_zone_get_zone_by_name(
460 { return ERR_PTR(-ENODEV
); }
461 static inline int thermal_zone_get_temp(
462 struct thermal_zone_device
*tz
, int *temp
)
464 static inline int get_tz_trend(struct thermal_zone_device
*tz
, int trip
)
466 static inline struct thermal_instance
*
467 get_thermal_instance(struct thermal_zone_device
*tz
,
468 struct thermal_cooling_device
*cdev
, int trip
)
469 { return ERR_PTR(-ENODEV
); }
470 static inline void thermal_cdev_update(struct thermal_cooling_device
*cdev
)
472 static inline void thermal_notify_framework(struct thermal_zone_device
*tz
,
475 #endif /* CONFIG_THERMAL */
477 #if defined(CONFIG_NET) && IS_ENABLED(CONFIG_THERMAL)
478 extern int thermal_generate_netlink_event(struct thermal_zone_device
*tz
,
481 static inline int thermal_generate_netlink_event(struct thermal_zone_device
*tz
,
488 #endif /* __THERMAL_H__ */