]>
Commit | Line | Data |
---|---|---|
203d3d4a ZR |
1 | /* |
2 | * thermal.h ($Revision: 0 $) | |
3 | * | |
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> | |
7 | * | |
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. | |
12 | * | |
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. | |
17 | * | |
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. | |
21 | * | |
22 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
23 | */ | |
24 | ||
25 | #ifndef __THERMAL_H__ | |
26 | #define __THERMAL_H__ | |
27 | ||
a116b5d4 | 28 | #include <linux/of.h> |
203d3d4a ZR |
29 | #include <linux/idr.h> |
30 | #include <linux/device.h> | |
b1569e99 | 31 | #include <linux/workqueue.h> |
af6c9f16 | 32 | #include <uapi/linux/thermal.h> |
203d3d4a | 33 | |
23064088 D |
34 | #define THERMAL_TRIPS_NONE -1 |
35 | #define THERMAL_MAX_TRIPS 12 | |
23064088 | 36 | |
57df8106 ZR |
37 | /* invalid cooling state */ |
38 | #define THERMAL_CSTATE_INVALID -1UL | |
39 | ||
23064088 | 40 | /* No upper/lower limit requirement */ |
a940cb34 | 41 | #define THERMAL_NO_LIMIT ((u32)~0) |
23064088 D |
42 | |
43 | /* Unit conversion macros */ | |
44 | #define KELVIN_TO_CELSIUS(t) (long)(((long)t-2732 >= 0) ? \ | |
45 | ((long)t-2732+5)/10 : ((long)t-2732-5)/10) | |
46 | #define CELSIUS_TO_KELVIN(t) ((t)*10+2732) | |
7b83fd9d AL |
47 | #define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100) |
48 | #define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 2732) | |
77e337c6 AL |
49 | #define MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, off) (((t) / 100) + (off)) |
50 | #define MILLICELSIUS_TO_DECI_KELVIN(t) MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, 2732) | |
23064088 | 51 | |
1f53ef17 ZR |
52 | /* Default Thermal Governor */ |
53 | #if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE) | |
54 | #define DEFAULT_THERMAL_GOVERNOR "step_wise" | |
55 | #elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE) | |
56 | #define DEFAULT_THERMAL_GOVERNOR "fair_share" | |
57 | #elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE) | |
58 | #define DEFAULT_THERMAL_GOVERNOR "user_space" | |
59 | #endif | |
a4a15485 | 60 | |
203d3d4a ZR |
61 | struct thermal_zone_device; |
62 | struct thermal_cooling_device; | |
63 | ||
6503e5df MG |
64 | enum thermal_device_mode { |
65 | THERMAL_DEVICE_DISABLED = 0, | |
66 | THERMAL_DEVICE_ENABLED, | |
67 | }; | |
68 | ||
69 | enum thermal_trip_type { | |
70 | THERMAL_TRIP_ACTIVE = 0, | |
71 | THERMAL_TRIP_PASSIVE, | |
72 | THERMAL_TRIP_HOT, | |
73 | THERMAL_TRIP_CRITICAL, | |
74 | }; | |
75 | ||
601f3d42 ZR |
76 | enum thermal_trend { |
77 | THERMAL_TREND_STABLE, /* temperature is stable */ | |
78 | THERMAL_TREND_RAISING, /* temperature is raising */ | |
79 | THERMAL_TREND_DROPPING, /* temperature is dropping */ | |
d069015e ZR |
80 | THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */ |
81 | THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */ | |
601f3d42 ZR |
82 | }; |
83 | ||
203d3d4a ZR |
84 | struct thermal_zone_device_ops { |
85 | int (*bind) (struct thermal_zone_device *, | |
86 | struct thermal_cooling_device *); | |
87 | int (*unbind) (struct thermal_zone_device *, | |
88 | struct thermal_cooling_device *); | |
6503e5df MG |
89 | int (*get_temp) (struct thermal_zone_device *, unsigned long *); |
90 | int (*get_mode) (struct thermal_zone_device *, | |
91 | enum thermal_device_mode *); | |
92 | int (*set_mode) (struct thermal_zone_device *, | |
93 | enum thermal_device_mode); | |
94 | int (*get_trip_type) (struct thermal_zone_device *, int, | |
95 | enum thermal_trip_type *); | |
96 | int (*get_trip_temp) (struct thermal_zone_device *, int, | |
97 | unsigned long *); | |
c56f5c03 D |
98 | int (*set_trip_temp) (struct thermal_zone_device *, int, |
99 | unsigned long); | |
27365a6c D |
100 | int (*get_trip_hyst) (struct thermal_zone_device *, int, |
101 | unsigned long *); | |
102 | int (*set_trip_hyst) (struct thermal_zone_device *, int, | |
103 | unsigned long); | |
9ec732ff | 104 | int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *); |
e6e238c3 | 105 | int (*set_emul_temp) (struct thermal_zone_device *, unsigned long); |
601f3d42 ZR |
106 | int (*get_trend) (struct thermal_zone_device *, int, |
107 | enum thermal_trend *); | |
b1569e99 MG |
108 | int (*notify) (struct thermal_zone_device *, int, |
109 | enum thermal_trip_type); | |
203d3d4a ZR |
110 | }; |
111 | ||
112 | struct thermal_cooling_device_ops { | |
6503e5df MG |
113 | int (*get_max_state) (struct thermal_cooling_device *, unsigned long *); |
114 | int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *); | |
115 | int (*set_cur_state) (struct thermal_cooling_device *, unsigned long); | |
203d3d4a ZR |
116 | }; |
117 | ||
203d3d4a ZR |
118 | struct thermal_cooling_device { |
119 | int id; | |
120 | char type[THERMAL_NAME_LENGTH]; | |
121 | struct device device; | |
4e5e4705 | 122 | struct device_node *np; |
203d3d4a | 123 | void *devdata; |
5b275ce2 | 124 | const struct thermal_cooling_device_ops *ops; |
ce119f83 | 125 | bool updated; /* true if the cooling device does not need update */ |
f4a821ce | 126 | struct mutex lock; /* protect thermal_instances list */ |
b5e4ae62 | 127 | struct list_head thermal_instances; |
203d3d4a ZR |
128 | struct list_head node; |
129 | }; | |
130 | ||
c56f5c03 D |
131 | struct thermal_attr { |
132 | struct device_attribute attr; | |
133 | char name[THERMAL_NAME_LENGTH]; | |
134 | }; | |
135 | ||
c708a98f JM |
136 | /** |
137 | * struct thermal_zone_device - structure for a thermal zone | |
138 | * @id: unique id number for each thermal zone | |
139 | * @type: the thermal zone device type | |
140 | * @device: &struct device for this thermal zone | |
141 | * @trip_temp_attrs: attributes for trip points for sysfs: trip temperature | |
142 | * @trip_type_attrs: attributes for trip points for sysfs: trip type | |
143 | * @trip_hyst_attrs: attributes for trip points for sysfs: trip hysteresis | |
144 | * @devdata: private pointer for device private data | |
145 | * @trips: number of trip points the thermal zone supports | |
146 | * @passive_delay: number of milliseconds to wait between polls when | |
147 | * performing passive cooling. Currenty only used by the | |
148 | * step-wise governor | |
149 | * @polling_delay: number of milliseconds to wait between polls when | |
150 | * checking whether trip points have been crossed (0 for | |
151 | * interrupt driven systems) | |
152 | * @temperature: current temperature. This is only for core code, | |
153 | * drivers should use thermal_zone_get_temp() to get the | |
154 | * current temperature | |
155 | * @last_temperature: previous temperature read | |
156 | * @emul_temperature: emulated temperature when using CONFIG_THERMAL_EMULATION | |
157 | * @passive: 1 if you've crossed a passive trip point, 0 otherwise. | |
158 | * Currenty only used by the step-wise governor. | |
159 | * @forced_passive: If > 0, temperature at which to switch on all ACPI | |
160 | * processor cooling devices. Currently only used by the | |
161 | * step-wise governor. | |
162 | * @ops: operations this &thermal_zone_device supports | |
163 | * @tzp: thermal zone parameters | |
164 | * @governor: pointer to the governor for this thermal zone | |
165 | * @thermal_instances: list of &struct thermal_instance of this thermal zone | |
166 | * @idr: &struct idr to generate unique id for this zone's cooling | |
167 | * devices | |
168 | * @lock: lock to protect thermal_instances list | |
169 | * @node: node in thermal_tz_list (in thermal_core.c) | |
170 | * @poll_queue: delayed work for polling | |
171 | */ | |
203d3d4a ZR |
172 | struct thermal_zone_device { |
173 | int id; | |
174 | char type[THERMAL_NAME_LENGTH]; | |
175 | struct device device; | |
c56f5c03 D |
176 | struct thermal_attr *trip_temp_attrs; |
177 | struct thermal_attr *trip_type_attrs; | |
27365a6c | 178 | struct thermal_attr *trip_hyst_attrs; |
203d3d4a ZR |
179 | void *devdata; |
180 | int trips; | |
b1569e99 MG |
181 | int passive_delay; |
182 | int polling_delay; | |
601f3d42 | 183 | int temperature; |
b1569e99 | 184 | int last_temperature; |
e6e238c3 | 185 | int emul_temperature; |
908b9fb7 | 186 | int passive; |
03a971a2 | 187 | unsigned int forced_passive; |
4e5e4705 | 188 | struct thermal_zone_device_ops *ops; |
ef873947 | 189 | const struct thermal_zone_params *tzp; |
a4a15485 | 190 | struct thermal_governor *governor; |
2d374139 | 191 | struct list_head thermal_instances; |
203d3d4a | 192 | struct idr idr; |
c708a98f | 193 | struct mutex lock; |
203d3d4a | 194 | struct list_head node; |
b1569e99 | 195 | struct delayed_work poll_queue; |
203d3d4a | 196 | }; |
4cb18728 | 197 | |
c708a98f JM |
198 | /** |
199 | * struct thermal_governor - structure that holds thermal governor information | |
200 | * @name: name of the governor | |
201 | * @throttle: callback called for every trip point even if temperature is | |
202 | * below the trip point temperature | |
203 | * @governor_list: node in thermal_governor_list (in thermal_core.c) | |
204 | */ | |
a4a15485 D |
205 | struct thermal_governor { |
206 | char name[THERMAL_NAME_LENGTH]; | |
207 | int (*throttle)(struct thermal_zone_device *tz, int trip); | |
208 | struct list_head governor_list; | |
a4a15485 D |
209 | }; |
210 | ||
ef873947 D |
211 | /* Structure that holds binding parameters for a zone */ |
212 | struct thermal_bind_params { | |
213 | struct thermal_cooling_device *cdev; | |
214 | ||
215 | /* | |
216 | * This is a measure of 'how effectively these devices can | |
217 | * cool 'this' thermal zone. The shall be determined by platform | |
218 | * characterization. This is on a 'percentage' scale. | |
219 | * See Documentation/thermal/sysfs-api.txt for more information. | |
220 | */ | |
221 | int weight; | |
222 | ||
223 | /* | |
224 | * This is a bit mask that gives the binding relation between this | |
225 | * thermal zone and cdev, for a particular trip point. | |
226 | * See Documentation/thermal/sysfs-api.txt for more information. | |
227 | */ | |
228 | int trip_mask; | |
a8892d83 EV |
229 | |
230 | /* | |
231 | * This is an array of cooling state limits. Must have exactly | |
232 | * 2 * thermal_zone.number_of_trip_points. It is an array consisting | |
233 | * of tuples <lower-state upper-state> of state limits. Each trip | |
234 | * will be associated with one state limit tuple when binding. | |
235 | * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS> | |
236 | * on all trips. | |
237 | */ | |
238 | unsigned long *binding_limits; | |
ef873947 D |
239 | int (*match) (struct thermal_zone_device *tz, |
240 | struct thermal_cooling_device *cdev); | |
241 | }; | |
242 | ||
243 | /* Structure to define Thermal Zone parameters */ | |
244 | struct thermal_zone_params { | |
a4a15485 | 245 | char governor_name[THERMAL_NAME_LENGTH]; |
ccba4ffd EV |
246 | |
247 | /* | |
248 | * a boolean to indicate if the thermal to hwmon sysfs interface | |
249 | * is required. when no_hwmon == false, a hwmon sysfs interface | |
250 | * will be created. when no_hwmon == true, nothing will be done | |
251 | */ | |
252 | bool no_hwmon; | |
253 | ||
ef873947 D |
254 | int num_tbps; /* Number of tbp entries */ |
255 | struct thermal_bind_params *tbp; | |
256 | }; | |
257 | ||
4cb18728 D |
258 | struct thermal_genl_event { |
259 | u32 orig; | |
260 | enum events event; | |
261 | }; | |
203d3d4a | 262 | |
2251aef6 EV |
263 | /** |
264 | * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones | |
265 | * | |
266 | * Mandatory: | |
267 | * @get_temp: a pointer to a function that reads the sensor temperature. | |
268 | * | |
269 | * Optional: | |
270 | * @get_trend: a pointer to a function that reads the sensor temperature trend. | |
184a4bf6 LM |
271 | * @set_emul_temp: a pointer to a function that sets sensor emulated |
272 | * temperature. | |
2251aef6 EV |
273 | */ |
274 | struct thermal_zone_of_device_ops { | |
275 | int (*get_temp)(void *, long *); | |
276 | int (*get_trend)(void *, long *); | |
184a4bf6 | 277 | int (*set_emul_temp)(void *, unsigned long); |
2251aef6 EV |
278 | }; |
279 | ||
ad9914ac LM |
280 | /** |
281 | * struct thermal_trip - representation of a point in temperature domain | |
282 | * @np: pointer to struct device_node that this trip point was created from | |
283 | * @temperature: temperature value in miliCelsius | |
284 | * @hysteresis: relative hysteresis in miliCelsius | |
285 | * @type: trip point type | |
286 | */ | |
287 | ||
288 | struct thermal_trip { | |
289 | struct device_node *np; | |
290 | unsigned long int temperature; | |
291 | unsigned long int hysteresis; | |
292 | enum thermal_trip_type type; | |
293 | }; | |
294 | ||
23064088 | 295 | /* Function declarations */ |
4e5e4705 EV |
296 | #ifdef CONFIG_THERMAL_OF |
297 | struct thermal_zone_device * | |
2251aef6 EV |
298 | thermal_zone_of_sensor_register(struct device *dev, int id, void *data, |
299 | const struct thermal_zone_of_device_ops *ops); | |
4e5e4705 EV |
300 | void thermal_zone_of_sensor_unregister(struct device *dev, |
301 | struct thermal_zone_device *tz); | |
302 | #else | |
303 | static inline struct thermal_zone_device * | |
2251aef6 EV |
304 | thermal_zone_of_sensor_register(struct device *dev, int id, void *data, |
305 | const struct thermal_zone_of_device_ops *ops) | |
4e5e4705 EV |
306 | { |
307 | return NULL; | |
308 | } | |
309 | ||
310 | static inline | |
311 | void thermal_zone_of_sensor_unregister(struct device *dev, | |
312 | struct thermal_zone_device *tz) | |
313 | { | |
314 | } | |
315 | ||
316 | #endif | |
12ca7188 NM |
317 | |
318 | #if IS_ENABLED(CONFIG_THERMAL) | |
4b1bf587 | 319 | struct thermal_zone_device *thermal_zone_device_register(const char *, int, int, |
4e5e4705 | 320 | void *, struct thermal_zone_device_ops *, |
50125a9b | 321 | const struct thermal_zone_params *, int, int); |
203d3d4a ZR |
322 | void thermal_zone_device_unregister(struct thermal_zone_device *); |
323 | ||
324 | int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int, | |
9d99842f ZR |
325 | struct thermal_cooling_device *, |
326 | unsigned long, unsigned long); | |
203d3d4a ZR |
327 | int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int, |
328 | struct thermal_cooling_device *); | |
b1569e99 | 329 | void thermal_zone_device_update(struct thermal_zone_device *); |
23064088 | 330 | |
203d3d4a | 331 | struct thermal_cooling_device *thermal_cooling_device_register(char *, void *, |
5b275ce2 | 332 | const struct thermal_cooling_device_ops *); |
a116b5d4 EV |
333 | struct thermal_cooling_device * |
334 | thermal_of_cooling_device_register(struct device_node *np, char *, void *, | |
335 | const struct thermal_cooling_device_ops *); | |
203d3d4a | 336 | void thermal_cooling_device_unregister(struct thermal_cooling_device *); |
63c4d919 | 337 | struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name); |
837b26bb | 338 | int thermal_zone_get_temp(struct thermal_zone_device *tz, unsigned long *temp); |
af06216a | 339 | |
9b4298a0 D |
340 | int get_tz_trend(struct thermal_zone_device *, int); |
341 | struct thermal_instance *get_thermal_instance(struct thermal_zone_device *, | |
342 | struct thermal_cooling_device *, int); | |
dc765482 | 343 | void thermal_cdev_update(struct thermal_cooling_device *); |
7b73c993 | 344 | void thermal_notify_framework(struct thermal_zone_device *, int); |
12ca7188 NM |
345 | #else |
346 | static inline struct thermal_zone_device *thermal_zone_device_register( | |
347 | const char *type, int trips, int mask, void *devdata, | |
348 | struct thermal_zone_device_ops *ops, | |
349 | const struct thermal_zone_params *tzp, | |
350 | int passive_delay, int polling_delay) | |
351 | { return ERR_PTR(-ENODEV); } | |
352 | static inline void thermal_zone_device_unregister( | |
353 | struct thermal_zone_device *tz) | |
354 | { } | |
355 | static inline int thermal_zone_bind_cooling_device( | |
356 | struct thermal_zone_device *tz, int trip, | |
357 | struct thermal_cooling_device *cdev, | |
358 | unsigned long upper, unsigned long lower) | |
359 | { return -ENODEV; } | |
360 | static inline int thermal_zone_unbind_cooling_device( | |
361 | struct thermal_zone_device *tz, int trip, | |
362 | struct thermal_cooling_device *cdev) | |
363 | { return -ENODEV; } | |
364 | static inline void thermal_zone_device_update(struct thermal_zone_device *tz) | |
365 | { } | |
366 | static inline struct thermal_cooling_device * | |
367 | thermal_cooling_device_register(char *type, void *devdata, | |
368 | const struct thermal_cooling_device_ops *ops) | |
369 | { return ERR_PTR(-ENODEV); } | |
370 | static inline struct thermal_cooling_device * | |
371 | thermal_of_cooling_device_register(struct device_node *np, | |
372 | char *type, void *devdata, const struct thermal_cooling_device_ops *ops) | |
373 | { return ERR_PTR(-ENODEV); } | |
374 | static inline void thermal_cooling_device_unregister( | |
375 | struct thermal_cooling_device *cdev) | |
376 | { } | |
377 | static inline struct thermal_zone_device *thermal_zone_get_zone_by_name( | |
378 | const char *name) | |
379 | { return ERR_PTR(-ENODEV); } | |
380 | static inline int thermal_zone_get_temp( | |
381 | struct thermal_zone_device *tz, unsigned long *temp) | |
382 | { return -ENODEV; } | |
383 | static inline int get_tz_trend(struct thermal_zone_device *tz, int trip) | |
384 | { return -ENODEV; } | |
385 | static inline struct thermal_instance * | |
386 | get_thermal_instance(struct thermal_zone_device *tz, | |
387 | struct thermal_cooling_device *cdev, int trip) | |
388 | { return ERR_PTR(-ENODEV); } | |
389 | static inline void thermal_cdev_update(struct thermal_cooling_device *cdev) | |
390 | { } | |
391 | static inline void thermal_notify_framework(struct thermal_zone_device *tz, | |
392 | int trip) | |
393 | { } | |
394 | #endif /* CONFIG_THERMAL */ | |
395 | ||
396 | #if defined(CONFIG_NET) && IS_ENABLED(CONFIG_THERMAL) | |
8ab3e6a0 EV |
397 | extern int thermal_generate_netlink_event(struct thermal_zone_device *tz, |
398 | enum events event); | |
af06216a | 399 | #else |
f8b58705 | 400 | static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz, |
8ab3e6a0 | 401 | enum events event) |
af06216a RW |
402 | { |
403 | return 0; | |
404 | } | |
405 | #endif | |
203d3d4a | 406 | |
a0dd25b2 | 407 | #endif /* __THERMAL_H__ */ |