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 /* use value, which < 0K, to indicate an invalid/uninitialized temperature */
47 #define THERMAL_TEMP_INVALID -274000
49 /* Unit conversion macros */
50 #define DECI_KELVIN_TO_CELSIUS(t) ({ \
52 ((_t-2732 >= 0) ? (_t-2732+5)/10 : (_t-2732-5)/10); \
54 #define CELSIUS_TO_DECI_KELVIN(t) ((t)*10+2732)
55 #define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100)
56 #define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 2732)
57 #define MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, off) (((t) / 100) + (off))
58 #define MILLICELSIUS_TO_DECI_KELVIN(t) MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, 2732)
60 /* Default Thermal Governor */
61 #if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
62 #define DEFAULT_THERMAL_GOVERNOR "step_wise"
63 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
64 #define DEFAULT_THERMAL_GOVERNOR "fair_share"
65 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
66 #define DEFAULT_THERMAL_GOVERNOR "user_space"
67 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_POWER_ALLOCATOR)
68 #define DEFAULT_THERMAL_GOVERNOR "power_allocator"
71 struct thermal_zone_device
;
72 struct thermal_cooling_device
;
73 struct thermal_instance
;
75 enum thermal_device_mode
{
76 THERMAL_DEVICE_DISABLED
= 0,
77 THERMAL_DEVICE_ENABLED
,
80 enum thermal_trip_type
{
81 THERMAL_TRIP_ACTIVE
= 0,
84 THERMAL_TRIP_CRITICAL
,
88 THERMAL_TREND_STABLE
, /* temperature is stable */
89 THERMAL_TREND_RAISING
, /* temperature is raising */
90 THERMAL_TREND_DROPPING
, /* temperature is dropping */
91 THERMAL_TREND_RAISE_FULL
, /* apply highest cooling action */
92 THERMAL_TREND_DROP_FULL
, /* apply lowest cooling action */
95 struct thermal_zone_device_ops
{
96 int (*bind
) (struct thermal_zone_device
*,
97 struct thermal_cooling_device
*);
98 int (*unbind
) (struct thermal_zone_device
*,
99 struct thermal_cooling_device
*);
100 int (*get_temp
) (struct thermal_zone_device
*, int *);
101 int (*set_trips
) (struct thermal_zone_device
*, int, int);
102 int (*get_mode
) (struct thermal_zone_device
*,
103 enum thermal_device_mode
*);
104 int (*set_mode
) (struct thermal_zone_device
*,
105 enum thermal_device_mode
);
106 int (*get_trip_type
) (struct thermal_zone_device
*, int,
107 enum thermal_trip_type
*);
108 int (*get_trip_temp
) (struct thermal_zone_device
*, int, int *);
109 int (*set_trip_temp
) (struct thermal_zone_device
*, int, int);
110 int (*get_trip_hyst
) (struct thermal_zone_device
*, int, int *);
111 int (*set_trip_hyst
) (struct thermal_zone_device
*, int, int);
112 int (*get_crit_temp
) (struct thermal_zone_device
*, int *);
113 int (*set_emul_temp
) (struct thermal_zone_device
*, int);
114 int (*get_trend
) (struct thermal_zone_device
*, int,
115 enum thermal_trend
*);
116 int (*notify
) (struct thermal_zone_device
*, int,
117 enum thermal_trip_type
);
120 struct thermal_cooling_device_ops
{
121 int (*get_max_state
) (struct thermal_cooling_device
*, unsigned long *);
122 int (*get_cur_state
) (struct thermal_cooling_device
*, unsigned long *);
123 int (*set_cur_state
) (struct thermal_cooling_device
*, unsigned long);
124 int (*get_requested_power
)(struct thermal_cooling_device
*,
125 struct thermal_zone_device
*, u32
*);
126 int (*state2power
)(struct thermal_cooling_device
*,
127 struct thermal_zone_device
*, unsigned long, u32
*);
128 int (*power2state
)(struct thermal_cooling_device
*,
129 struct thermal_zone_device
*, u32
, unsigned long *);
132 struct thermal_cooling_device
{
134 char type
[THERMAL_NAME_LENGTH
];
135 struct device device
;
136 struct device_node
*np
;
138 const struct thermal_cooling_device_ops
*ops
;
139 bool updated
; /* true if the cooling device does not need update */
140 struct mutex lock
; /* protect thermal_instances list */
141 struct list_head thermal_instances
;
142 struct list_head node
;
145 struct thermal_attr
{
146 struct device_attribute attr
;
147 char name
[THERMAL_NAME_LENGTH
];
151 * struct thermal_zone_device - structure for a thermal zone
152 * @id: unique id number for each thermal zone
153 * @type: the thermal zone device type
154 * @device: &struct device for this thermal zone
155 * @trip_temp_attrs: attributes for trip points for sysfs: trip temperature
156 * @trip_type_attrs: attributes for trip points for sysfs: trip type
157 * @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis
158 * @devdata: private pointer for device private data
159 * @trips: number of trip points the thermal zone supports
160 * @trips_disabled; bitmap for disabled trips
161 * @passive_delay: number of milliseconds to wait between polls when
162 * performing passive cooling.
163 * @polling_delay: number of milliseconds to wait between polls when
164 * checking whether trip points have been crossed (0 for
165 * interrupt driven systems)
166 * @temperature: current temperature. This is only for core code,
167 * drivers should use thermal_zone_get_temp() to get the
168 * current temperature
169 * @last_temperature: previous temperature read
170 * @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION
171 * @passive: 1 if you've crossed a passive trip point, 0 otherwise.
172 * @prev_low_trip: the low current temperature if you've crossed a passive
174 * @prev_high_trip: the above current temperature if you've crossed a
176 * @forced_passive: If > 0, temperature at which to switch on all ACPI
177 * processor cooling devices. Currently only used by the
178 * step-wise governor.
179 * @need_update: if equals 1, thermal_zone_device_update needs to be invoked.
180 * @ops: operations this &thermal_zone_device supports
181 * @tzp: thermal zone parameters
182 * @governor: pointer to the governor for this thermal zone
183 * @governor_data: private pointer for governor data
184 * @thermal_instances: list of &struct thermal_instance of this thermal zone
185 * @idr: &struct idr to generate unique id for this zone's cooling
187 * @lock: lock to protect thermal_instances list
188 * @node: node in thermal_tz_list (in thermal_core.c)
189 * @poll_queue: delayed work for polling
191 struct thermal_zone_device
{
193 char type
[THERMAL_NAME_LENGTH
];
194 struct device device
;
195 struct thermal_attr
*trip_temp_attrs
;
196 struct thermal_attr
*trip_type_attrs
;
197 struct thermal_attr
*trip_hyst_attrs
;
200 unsigned long trips_disabled
; /* bitmap for disabled trips */
204 int last_temperature
;
205 int emul_temperature
;
209 unsigned int forced_passive
;
210 atomic_t need_update
;
211 struct thermal_zone_device_ops
*ops
;
212 struct thermal_zone_params
*tzp
;
213 struct thermal_governor
*governor
;
215 struct list_head thermal_instances
;
218 struct list_head node
;
219 struct delayed_work poll_queue
;
223 * struct thermal_governor - structure that holds thermal governor information
224 * @name: name of the governor
225 * @bind_to_tz: callback called when binding to a thermal zone. If it
226 * returns 0, the governor is bound to the thermal zone,
227 * otherwise it fails.
228 * @unbind_from_tz: callback called when a governor is unbound from a
230 * @throttle: callback called for every trip point even if temperature is
231 * below the trip point temperature
232 * @governor_list: node in thermal_governor_list (in thermal_core.c)
234 struct thermal_governor
{
235 char name
[THERMAL_NAME_LENGTH
];
236 int (*bind_to_tz
)(struct thermal_zone_device
*tz
);
237 void (*unbind_from_tz
)(struct thermal_zone_device
*tz
);
238 int (*throttle
)(struct thermal_zone_device
*tz
, int trip
);
239 struct list_head governor_list
;
242 /* Structure that holds binding parameters for a zone */
243 struct thermal_bind_params
{
244 struct thermal_cooling_device
*cdev
;
247 * This is a measure of 'how effectively these devices can
248 * cool 'this' thermal zone. It shall be determined by
249 * platform characterization. This value is relative to the
250 * rest of the weights so a cooling device whose weight is
251 * double that of another cooling device is twice as
252 * effective. See Documentation/thermal/sysfs-api.txt for more
258 * This is a bit mask that gives the binding relation between this
259 * thermal zone and cdev, for a particular trip point.
260 * See Documentation/thermal/sysfs-api.txt for more information.
265 * This is an array of cooling state limits. Must have exactly
266 * 2 * thermal_zone.number_of_trip_points. It is an array consisting
267 * of tuples <lower-state upper-state> of state limits. Each trip
268 * will be associated with one state limit tuple when binding.
269 * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
272 unsigned long *binding_limits
;
273 int (*match
) (struct thermal_zone_device
*tz
,
274 struct thermal_cooling_device
*cdev
);
277 /* Structure to define Thermal Zone parameters */
278 struct thermal_zone_params
{
279 char governor_name
[THERMAL_NAME_LENGTH
];
282 * a boolean to indicate if the thermal to hwmon sysfs interface
283 * is required. when no_hwmon == false, a hwmon sysfs interface
284 * will be created. when no_hwmon == true, nothing will be done
288 int num_tbps
; /* Number of tbp entries */
289 struct thermal_bind_params
*tbp
;
292 * Sustainable power (heat) that this thermal zone can dissipate in
295 u32 sustainable_power
;
298 * Proportional parameter of the PID controller when
299 * overshooting (i.e., when temperature is below the target)
304 * Proportional parameter of the PID controller when
309 /* Integral parameter of the PID controller */
312 /* Derivative parameter of the PID controller */
315 /* threshold below which the error is no longer accumulated */
319 * @slope: slope of a linear temperature adjustment curve.
320 * Used by thermal zone drivers.
324 * @offset: offset of a linear temperature adjustment curve.
325 * Used by thermal zone drivers (default 0).
330 struct thermal_genl_event
{
336 * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones
339 * @get_temp: a pointer to a function that reads the sensor temperature.
342 * @get_trend: a pointer to a function that reads the sensor temperature trend.
343 * @set_trips: a pointer to a function that sets a temperature window. When
344 * this window is left the driver must inform the thermal core via
345 * thermal_zone_device_update.
346 * @set_emul_temp: a pointer to a function that sets sensor emulated
348 * @set_trip_temp: a pointer to a function that sets the trip temperature on
351 struct thermal_zone_of_device_ops
{
352 int (*get_temp
)(void *, int *);
353 int (*get_trend
)(void *, int, enum thermal_trend
*);
354 int (*set_trips
)(void *, int, int);
355 int (*set_emul_temp
)(void *, int);
356 int (*set_trip_temp
)(void *, int, int);
360 * struct thermal_trip - representation of a point in temperature domain
361 * @np: pointer to struct device_node that this trip point was created from
362 * @temperature: temperature value in miliCelsius
363 * @hysteresis: relative hysteresis in miliCelsius
364 * @type: trip point type
367 struct thermal_trip
{
368 struct device_node
*np
;
371 enum thermal_trip_type type
;
374 /* Function declarations */
375 #ifdef CONFIG_THERMAL_OF
376 struct thermal_zone_device
*
377 thermal_zone_of_sensor_register(struct device
*dev
, int id
, void *data
,
378 const struct thermal_zone_of_device_ops
*ops
);
379 void thermal_zone_of_sensor_unregister(struct device
*dev
,
380 struct thermal_zone_device
*tz
);
381 struct thermal_zone_device
*devm_thermal_zone_of_sensor_register(
382 struct device
*dev
, int id
, void *data
,
383 const struct thermal_zone_of_device_ops
*ops
);
384 void devm_thermal_zone_of_sensor_unregister(struct device
*dev
,
385 struct thermal_zone_device
*tz
);
387 static inline struct thermal_zone_device
*
388 thermal_zone_of_sensor_register(struct device
*dev
, int id
, void *data
,
389 const struct thermal_zone_of_device_ops
*ops
)
391 return ERR_PTR(-ENODEV
);
395 void thermal_zone_of_sensor_unregister(struct device
*dev
,
396 struct thermal_zone_device
*tz
)
400 static inline struct thermal_zone_device
*devm_thermal_zone_of_sensor_register(
401 struct device
*dev
, int id
, void *data
,
402 const struct thermal_zone_of_device_ops
*ops
)
404 return ERR_PTR(-ENODEV
);
408 void devm_thermal_zone_of_sensor_unregister(struct device
*dev
,
409 struct thermal_zone_device
*tz
)
415 #if IS_ENABLED(CONFIG_THERMAL)
416 static inline bool cdev_is_power_actor(struct thermal_cooling_device
*cdev
)
418 return cdev
->ops
->get_requested_power
&& cdev
->ops
->state2power
&&
419 cdev
->ops
->power2state
;
422 int power_actor_get_max_power(struct thermal_cooling_device
*,
423 struct thermal_zone_device
*tz
, u32
*max_power
);
424 int power_actor_get_min_power(struct thermal_cooling_device
*,
425 struct thermal_zone_device
*tz
, u32
*min_power
);
426 int power_actor_set_power(struct thermal_cooling_device
*,
427 struct thermal_instance
*, u32
);
428 struct thermal_zone_device
*thermal_zone_device_register(const char *, int, int,
429 void *, struct thermal_zone_device_ops
*,
430 struct thermal_zone_params
*, int, int);
431 void thermal_zone_device_unregister(struct thermal_zone_device
*);
433 int thermal_zone_bind_cooling_device(struct thermal_zone_device
*, int,
434 struct thermal_cooling_device
*,
435 unsigned long, unsigned long,
437 int thermal_zone_unbind_cooling_device(struct thermal_zone_device
*, int,
438 struct thermal_cooling_device
*);
439 void thermal_zone_device_update(struct thermal_zone_device
*);
440 void thermal_zone_set_trips(struct thermal_zone_device
*);
442 struct thermal_cooling_device
*thermal_cooling_device_register(char *, void *,
443 const struct thermal_cooling_device_ops
*);
444 struct thermal_cooling_device
*
445 thermal_of_cooling_device_register(struct device_node
*np
, char *, void *,
446 const struct thermal_cooling_device_ops
*);
447 void thermal_cooling_device_unregister(struct thermal_cooling_device
*);
448 struct thermal_zone_device
*thermal_zone_get_zone_by_name(const char *name
);
449 int thermal_zone_get_temp(struct thermal_zone_device
*tz
, int *temp
);
450 int thermal_zone_get_slope(struct thermal_zone_device
*tz
);
451 int thermal_zone_get_offset(struct thermal_zone_device
*tz
);
453 int get_tz_trend(struct thermal_zone_device
*, int);
454 struct thermal_instance
*get_thermal_instance(struct thermal_zone_device
*,
455 struct thermal_cooling_device
*, int);
456 void thermal_cdev_update(struct thermal_cooling_device
*);
457 void thermal_notify_framework(struct thermal_zone_device
*, int);
459 static inline bool cdev_is_power_actor(struct thermal_cooling_device
*cdev
)
461 static inline int power_actor_get_max_power(struct thermal_cooling_device
*cdev
,
462 struct thermal_zone_device
*tz
, u32
*max_power
)
464 static inline int power_actor_get_min_power(struct thermal_cooling_device
*cdev
,
465 struct thermal_zone_device
*tz
,
468 static inline int power_actor_set_power(struct thermal_cooling_device
*cdev
,
469 struct thermal_instance
*tz
, u32 power
)
471 static inline struct thermal_zone_device
*thermal_zone_device_register(
472 const char *type
, int trips
, int mask
, void *devdata
,
473 struct thermal_zone_device_ops
*ops
,
474 const struct thermal_zone_params
*tzp
,
475 int passive_delay
, int polling_delay
)
476 { return ERR_PTR(-ENODEV
); }
477 static inline void thermal_zone_device_unregister(
478 struct thermal_zone_device
*tz
)
480 static inline int thermal_zone_bind_cooling_device(
481 struct thermal_zone_device
*tz
, int trip
,
482 struct thermal_cooling_device
*cdev
,
483 unsigned long upper
, unsigned long lower
,
486 static inline int thermal_zone_unbind_cooling_device(
487 struct thermal_zone_device
*tz
, int trip
,
488 struct thermal_cooling_device
*cdev
)
490 static inline void thermal_zone_device_update(struct thermal_zone_device
*tz
)
492 static inline void thermal_zone_set_trips(struct thermal_zone_device
*tz
)
494 static inline struct thermal_cooling_device
*
495 thermal_cooling_device_register(char *type
, void *devdata
,
496 const struct thermal_cooling_device_ops
*ops
)
497 { return ERR_PTR(-ENODEV
); }
498 static inline struct thermal_cooling_device
*
499 thermal_of_cooling_device_register(struct device_node
*np
,
500 char *type
, void *devdata
, const struct thermal_cooling_device_ops
*ops
)
501 { return ERR_PTR(-ENODEV
); }
502 static inline void thermal_cooling_device_unregister(
503 struct thermal_cooling_device
*cdev
)
505 static inline struct thermal_zone_device
*thermal_zone_get_zone_by_name(
507 { return ERR_PTR(-ENODEV
); }
508 static inline int thermal_zone_get_temp(
509 struct thermal_zone_device
*tz
, int *temp
)
511 static inline int thermal_zone_get_slope(
512 struct thermal_zone_device
*tz
)
514 static inline int thermal_zone_get_offset(
515 struct thermal_zone_device
*tz
)
517 static inline int get_tz_trend(struct thermal_zone_device
*tz
, int trip
)
519 static inline struct thermal_instance
*
520 get_thermal_instance(struct thermal_zone_device
*tz
,
521 struct thermal_cooling_device
*cdev
, int trip
)
522 { return ERR_PTR(-ENODEV
); }
523 static inline void thermal_cdev_update(struct thermal_cooling_device
*cdev
)
525 static inline void thermal_notify_framework(struct thermal_zone_device
*tz
,
528 #endif /* CONFIG_THERMAL */
530 #if defined(CONFIG_NET) && IS_ENABLED(CONFIG_THERMAL)
531 extern int thermal_generate_netlink_event(struct thermal_zone_device
*tz
,
534 static inline int thermal_generate_netlink_event(struct thermal_zone_device
*tz
,
541 #endif /* __THERMAL_H__ */