]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - include/linux/thermal.h
mtd: nand: complain loudly when chip->bits_per_cell is not correctly initialized
[karo-tx-linux.git] / include / linux / thermal.h
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
28 #include <linux/of.h>
29 #include <linux/idr.h>
30 #include <linux/device.h>
31 #include <linux/sysfs.h>
32 #include <linux/workqueue.h>
33 #include <uapi/linux/thermal.h>
34
35 #define THERMAL_TRIPS_NONE      -1
36 #define THERMAL_MAX_TRIPS       12
37
38 /* invalid cooling state */
39 #define THERMAL_CSTATE_INVALID -1UL
40
41 /* No upper/lower limit requirement */
42 #define THERMAL_NO_LIMIT        ((u32)~0)
43
44 /* Default weight of a bound cooling device */
45 #define THERMAL_WEIGHT_DEFAULT 0
46
47 /* use value, which < 0K, to indicate an invalid/uninitialized temperature */
48 #define THERMAL_TEMP_INVALID    -274000
49
50 /* Unit conversion macros */
51 #define DECI_KELVIN_TO_CELSIUS(t)       ({                      \
52         long _t = (t);                                          \
53         ((_t-2732 >= 0) ? (_t-2732+5)/10 : (_t-2732-5)/10);     \
54 })
55 #define CELSIUS_TO_DECI_KELVIN(t)       ((t)*10+2732)
56 #define DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, off) (((t) - (off)) * 100)
57 #define DECI_KELVIN_TO_MILLICELSIUS(t) DECI_KELVIN_TO_MILLICELSIUS_WITH_OFFSET(t, 2732)
58 #define MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, off) (((t) / 100) + (off))
59 #define MILLICELSIUS_TO_DECI_KELVIN(t) MILLICELSIUS_TO_DECI_KELVIN_WITH_OFFSET(t, 2732)
60
61 /* Default Thermal Governor */
62 #if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
63 #define DEFAULT_THERMAL_GOVERNOR       "step_wise"
64 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
65 #define DEFAULT_THERMAL_GOVERNOR       "fair_share"
66 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
67 #define DEFAULT_THERMAL_GOVERNOR       "user_space"
68 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_POWER_ALLOCATOR)
69 #define DEFAULT_THERMAL_GOVERNOR       "power_allocator"
70 #endif
71
72 struct thermal_zone_device;
73 struct thermal_cooling_device;
74 struct thermal_instance;
75
76 enum thermal_device_mode {
77         THERMAL_DEVICE_DISABLED = 0,
78         THERMAL_DEVICE_ENABLED,
79 };
80
81 enum thermal_trip_type {
82         THERMAL_TRIP_ACTIVE = 0,
83         THERMAL_TRIP_PASSIVE,
84         THERMAL_TRIP_HOT,
85         THERMAL_TRIP_CRITICAL,
86 };
87
88 enum thermal_trend {
89         THERMAL_TREND_STABLE, /* temperature is stable */
90         THERMAL_TREND_RAISING, /* temperature is raising */
91         THERMAL_TREND_DROPPING, /* temperature is dropping */
92         THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
93         THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
94 };
95
96 /* Thermal notification reason */
97 enum thermal_notify_event {
98         THERMAL_EVENT_UNSPECIFIED, /* Unspecified event */
99         THERMAL_EVENT_TEMP_SAMPLE, /* New Temperature sample */
100         THERMAL_TRIP_VIOLATED, /* TRIP Point violation */
101         THERMAL_TRIP_CHANGED, /* TRIP Point temperature changed */
102         THERMAL_DEVICE_DOWN, /* Thermal device is down */
103         THERMAL_DEVICE_UP, /* Thermal device is up after a down event */
104         THERMAL_DEVICE_POWER_CAPABILITY_CHANGED, /* power capability changed */
105 };
106
107 struct thermal_zone_device_ops {
108         int (*bind) (struct thermal_zone_device *,
109                      struct thermal_cooling_device *);
110         int (*unbind) (struct thermal_zone_device *,
111                        struct thermal_cooling_device *);
112         int (*get_temp) (struct thermal_zone_device *, int *);
113         int (*set_trips) (struct thermal_zone_device *, int, int);
114         int (*get_mode) (struct thermal_zone_device *,
115                          enum thermal_device_mode *);
116         int (*set_mode) (struct thermal_zone_device *,
117                 enum thermal_device_mode);
118         int (*get_trip_type) (struct thermal_zone_device *, int,
119                 enum thermal_trip_type *);
120         int (*get_trip_temp) (struct thermal_zone_device *, int, int *);
121         int (*set_trip_temp) (struct thermal_zone_device *, int, int);
122         int (*get_trip_hyst) (struct thermal_zone_device *, int, int *);
123         int (*set_trip_hyst) (struct thermal_zone_device *, int, int);
124         int (*get_crit_temp) (struct thermal_zone_device *, int *);
125         int (*set_emul_temp) (struct thermal_zone_device *, int);
126         int (*get_trend) (struct thermal_zone_device *, int,
127                           enum thermal_trend *);
128         int (*notify) (struct thermal_zone_device *, int,
129                        enum thermal_trip_type);
130 };
131
132 struct thermal_cooling_device_ops {
133         int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
134         int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
135         int (*set_cur_state) (struct thermal_cooling_device *, unsigned long);
136         int (*get_requested_power)(struct thermal_cooling_device *,
137                                    struct thermal_zone_device *, u32 *);
138         int (*state2power)(struct thermal_cooling_device *,
139                            struct thermal_zone_device *, unsigned long, u32 *);
140         int (*power2state)(struct thermal_cooling_device *,
141                            struct thermal_zone_device *, u32, unsigned long *);
142 };
143
144 struct thermal_cooling_device {
145         int id;
146         char type[THERMAL_NAME_LENGTH];
147         struct device device;
148         struct device_node *np;
149         void *devdata;
150         const struct thermal_cooling_device_ops *ops;
151         bool updated; /* true if the cooling device does not need update */
152         struct mutex lock; /* protect thermal_instances list */
153         struct list_head thermal_instances;
154         struct list_head node;
155 };
156
157 struct thermal_attr {
158         struct device_attribute attr;
159         char name[THERMAL_NAME_LENGTH];
160 };
161
162 /**
163  * struct thermal_zone_device - structure for a thermal zone
164  * @id:         unique id number for each thermal zone
165  * @type:       the thermal zone device type
166  * @device:     &struct device for this thermal zone
167  * @trip_temp_attrs:    attributes for trip points for sysfs: trip temperature
168  * @trip_type_attrs:    attributes for trip points for sysfs: trip type
169  * @trip_hyst_attrs:    attributes for trip points for sysfs: trip hysteresis
170  * @devdata:    private pointer for device private data
171  * @trips:      number of trip points the thermal zone supports
172  * @trips_disabled;     bitmap for disabled trips
173  * @passive_delay:      number of milliseconds to wait between polls when
174  *                      performing passive cooling.
175  * @polling_delay:      number of milliseconds to wait between polls when
176  *                      checking whether trip points have been crossed (0 for
177  *                      interrupt driven systems)
178  * @temperature:        current temperature.  This is only for core code,
179  *                      drivers should use thermal_zone_get_temp() to get the
180  *                      current temperature
181  * @last_temperature:   previous temperature read
182  * @emul_temperature:   emulated temperature when using CONFIG_THERMAL_EMULATION
183  * @passive:            1 if you've crossed a passive trip point, 0 otherwise.
184  * @prev_low_trip:      the low current temperature if you've crossed a passive
185                         trip point.
186  * @prev_high_trip:     the above current temperature if you've crossed a
187                         passive trip point.
188  * @forced_passive:     If > 0, temperature at which to switch on all ACPI
189  *                      processor cooling devices.  Currently only used by the
190  *                      step-wise governor.
191  * @need_update:        if equals 1, thermal_zone_device_update needs to be invoked.
192  * @ops:        operations this &thermal_zone_device supports
193  * @tzp:        thermal zone parameters
194  * @governor:   pointer to the governor for this thermal zone
195  * @governor_data:      private pointer for governor data
196  * @thermal_instances:  list of &struct thermal_instance of this thermal zone
197  * @ida:        &struct ida to generate unique id for this zone's cooling
198  *              devices
199  * @lock:       lock to protect thermal_instances list
200  * @node:       node in thermal_tz_list (in thermal_core.c)
201  * @poll_queue: delayed work for polling
202  * @notify_event: Last notification event
203  */
204 struct thermal_zone_device {
205         int id;
206         char type[THERMAL_NAME_LENGTH];
207         struct device device;
208         struct attribute_group trips_attribute_group;
209         struct thermal_attr *trip_temp_attrs;
210         struct thermal_attr *trip_type_attrs;
211         struct thermal_attr *trip_hyst_attrs;
212         void *devdata;
213         int trips;
214         unsigned long trips_disabled;   /* bitmap for disabled trips */
215         int passive_delay;
216         int polling_delay;
217         int temperature;
218         int last_temperature;
219         int emul_temperature;
220         int passive;
221         int prev_low_trip;
222         int prev_high_trip;
223         unsigned int forced_passive;
224         atomic_t need_update;
225         struct thermal_zone_device_ops *ops;
226         struct thermal_zone_params *tzp;
227         struct thermal_governor *governor;
228         void *governor_data;
229         struct list_head thermal_instances;
230         struct ida ida;
231         struct mutex lock;
232         struct list_head node;
233         struct delayed_work poll_queue;
234         enum thermal_notify_event notify_event;
235 };
236
237 /**
238  * struct thermal_governor - structure that holds thermal governor information
239  * @name:       name of the governor
240  * @bind_to_tz: callback called when binding to a thermal zone.  If it
241  *              returns 0, the governor is bound to the thermal zone,
242  *              otherwise it fails.
243  * @unbind_from_tz:     callback called when a governor is unbound from a
244  *                      thermal zone.
245  * @throttle:   callback called for every trip point even if temperature is
246  *              below the trip point temperature
247  * @governor_list:      node in thermal_governor_list (in thermal_core.c)
248  */
249 struct thermal_governor {
250         char name[THERMAL_NAME_LENGTH];
251         int (*bind_to_tz)(struct thermal_zone_device *tz);
252         void (*unbind_from_tz)(struct thermal_zone_device *tz);
253         int (*throttle)(struct thermal_zone_device *tz, int trip);
254         struct list_head        governor_list;
255 };
256
257 /* Structure that holds binding parameters for a zone */
258 struct thermal_bind_params {
259         struct thermal_cooling_device *cdev;
260
261         /*
262          * This is a measure of 'how effectively these devices can
263          * cool 'this' thermal zone. It shall be determined by
264          * platform characterization. This value is relative to the
265          * rest of the weights so a cooling device whose weight is
266          * double that of another cooling device is twice as
267          * effective. See Documentation/thermal/sysfs-api.txt for more
268          * information.
269          */
270         int weight;
271
272         /*
273          * This is a bit mask that gives the binding relation between this
274          * thermal zone and cdev, for a particular trip point.
275          * See Documentation/thermal/sysfs-api.txt for more information.
276          */
277         int trip_mask;
278
279         /*
280          * This is an array of cooling state limits. Must have exactly
281          * 2 * thermal_zone.number_of_trip_points. It is an array consisting
282          * of tuples <lower-state upper-state> of state limits. Each trip
283          * will be associated with one state limit tuple when binding.
284          * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
285          * on all trips.
286          */
287         unsigned long *binding_limits;
288         int (*match) (struct thermal_zone_device *tz,
289                         struct thermal_cooling_device *cdev);
290 };
291
292 /* Structure to define Thermal Zone parameters */
293 struct thermal_zone_params {
294         char governor_name[THERMAL_NAME_LENGTH];
295
296         /*
297          * a boolean to indicate if the thermal to hwmon sysfs interface
298          * is required. when no_hwmon == false, a hwmon sysfs interface
299          * will be created. when no_hwmon == true, nothing will be done
300          */
301         bool no_hwmon;
302
303         int num_tbps;   /* Number of tbp entries */
304         struct thermal_bind_params *tbp;
305
306         /*
307          * Sustainable power (heat) that this thermal zone can dissipate in
308          * mW
309          */
310         u32 sustainable_power;
311
312         /*
313          * Proportional parameter of the PID controller when
314          * overshooting (i.e., when temperature is below the target)
315          */
316         s32 k_po;
317
318         /*
319          * Proportional parameter of the PID controller when
320          * undershooting
321          */
322         s32 k_pu;
323
324         /* Integral parameter of the PID controller */
325         s32 k_i;
326
327         /* Derivative parameter of the PID controller */
328         s32 k_d;
329
330         /* threshold below which the error is no longer accumulated */
331         s32 integral_cutoff;
332
333         /*
334          * @slope:      slope of a linear temperature adjustment curve.
335          *              Used by thermal zone drivers.
336          */
337         int slope;
338         /*
339          * @offset:     offset of a linear temperature adjustment curve.
340          *              Used by thermal zone drivers (default 0).
341          */
342         int offset;
343 };
344
345 struct thermal_genl_event {
346         u32 orig;
347         enum events event;
348 };
349
350 /**
351  * struct thermal_zone_of_device_ops - scallbacks for handling DT based zones
352  *
353  * Mandatory:
354  * @get_temp: a pointer to a function that reads the sensor temperature.
355  *
356  * Optional:
357  * @get_trend: a pointer to a function that reads the sensor temperature trend.
358  * @set_trips: a pointer to a function that sets a temperature window. When
359  *             this window is left the driver must inform the thermal core via
360  *             thermal_zone_device_update.
361  * @set_emul_temp: a pointer to a function that sets sensor emulated
362  *                 temperature.
363  * @set_trip_temp: a pointer to a function that sets the trip temperature on
364  *                 hardware.
365  */
366 struct thermal_zone_of_device_ops {
367         int (*get_temp)(void *, int *);
368         int (*get_trend)(void *, int, enum thermal_trend *);
369         int (*set_trips)(void *, int, int);
370         int (*set_emul_temp)(void *, int);
371         int (*set_trip_temp)(void *, int, int);
372 };
373
374 /**
375  * struct thermal_trip - representation of a point in temperature domain
376  * @np: pointer to struct device_node that this trip point was created from
377  * @temperature: temperature value in miliCelsius
378  * @hysteresis: relative hysteresis in miliCelsius
379  * @type: trip point type
380  */
381
382 struct thermal_trip {
383         struct device_node *np;
384         int temperature;
385         int hysteresis;
386         enum thermal_trip_type type;
387 };
388
389 /* Function declarations */
390 #ifdef CONFIG_THERMAL_OF
391 struct thermal_zone_device *
392 thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
393                                 const struct thermal_zone_of_device_ops *ops);
394 void thermal_zone_of_sensor_unregister(struct device *dev,
395                                        struct thermal_zone_device *tz);
396 struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
397                 struct device *dev, int id, void *data,
398                 const struct thermal_zone_of_device_ops *ops);
399 void devm_thermal_zone_of_sensor_unregister(struct device *dev,
400                                             struct thermal_zone_device *tz);
401 #else
402 static inline struct thermal_zone_device *
403 thermal_zone_of_sensor_register(struct device *dev, int id, void *data,
404                                 const struct thermal_zone_of_device_ops *ops)
405 {
406         return ERR_PTR(-ENODEV);
407 }
408
409 static inline
410 void thermal_zone_of_sensor_unregister(struct device *dev,
411                                        struct thermal_zone_device *tz)
412 {
413 }
414
415 static inline struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
416                 struct device *dev, int id, void *data,
417                 const struct thermal_zone_of_device_ops *ops)
418 {
419         return ERR_PTR(-ENODEV);
420 }
421
422 static inline
423 void devm_thermal_zone_of_sensor_unregister(struct device *dev,
424                                             struct thermal_zone_device *tz)
425 {
426 }
427
428 #endif
429
430 #if IS_ENABLED(CONFIG_THERMAL)
431 static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
432 {
433         return cdev->ops->get_requested_power && cdev->ops->state2power &&
434                 cdev->ops->power2state;
435 }
436
437 int power_actor_get_max_power(struct thermal_cooling_device *,
438                               struct thermal_zone_device *tz, u32 *max_power);
439 int power_actor_get_min_power(struct thermal_cooling_device *,
440                               struct thermal_zone_device *tz, u32 *min_power);
441 int power_actor_set_power(struct thermal_cooling_device *,
442                           struct thermal_instance *, u32);
443 struct thermal_zone_device *thermal_zone_device_register(const char *, int, int,
444                 void *, struct thermal_zone_device_ops *,
445                 struct thermal_zone_params *, int, int);
446 void thermal_zone_device_unregister(struct thermal_zone_device *);
447
448 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
449                                      struct thermal_cooling_device *,
450                                      unsigned long, unsigned long,
451                                      unsigned int);
452 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
453                                        struct thermal_cooling_device *);
454 void thermal_zone_device_update(struct thermal_zone_device *,
455                                 enum thermal_notify_event);
456 void thermal_zone_set_trips(struct thermal_zone_device *);
457
458 struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
459                 const struct thermal_cooling_device_ops *);
460 struct thermal_cooling_device *
461 thermal_of_cooling_device_register(struct device_node *np, char *, void *,
462                                    const struct thermal_cooling_device_ops *);
463 void thermal_cooling_device_unregister(struct thermal_cooling_device *);
464 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
465 int thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp);
466 int thermal_zone_get_slope(struct thermal_zone_device *tz);
467 int thermal_zone_get_offset(struct thermal_zone_device *tz);
468
469 int get_tz_trend(struct thermal_zone_device *, int);
470 struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
471                 struct thermal_cooling_device *, int);
472 void thermal_cdev_update(struct thermal_cooling_device *);
473 void thermal_notify_framework(struct thermal_zone_device *, int);
474 #else
475 static inline bool cdev_is_power_actor(struct thermal_cooling_device *cdev)
476 { return false; }
477 static inline int power_actor_get_max_power(struct thermal_cooling_device *cdev,
478                               struct thermal_zone_device *tz, u32 *max_power)
479 { return 0; }
480 static inline int power_actor_get_min_power(struct thermal_cooling_device *cdev,
481                                             struct thermal_zone_device *tz,
482                                             u32 *min_power)
483 { return -ENODEV; }
484 static inline int power_actor_set_power(struct thermal_cooling_device *cdev,
485                           struct thermal_instance *tz, u32 power)
486 { return 0; }
487 static inline struct thermal_zone_device *thermal_zone_device_register(
488         const char *type, int trips, int mask, void *devdata,
489         struct thermal_zone_device_ops *ops,
490         const struct thermal_zone_params *tzp,
491         int passive_delay, int polling_delay)
492 { return ERR_PTR(-ENODEV); }
493 static inline void thermal_zone_device_unregister(
494         struct thermal_zone_device *tz)
495 { }
496 static inline int thermal_zone_bind_cooling_device(
497         struct thermal_zone_device *tz, int trip,
498         struct thermal_cooling_device *cdev,
499         unsigned long upper, unsigned long lower,
500         unsigned int weight)
501 { return -ENODEV; }
502 static inline int thermal_zone_unbind_cooling_device(
503         struct thermal_zone_device *tz, int trip,
504         struct thermal_cooling_device *cdev)
505 { return -ENODEV; }
506 static inline void thermal_zone_device_update(struct thermal_zone_device *tz,
507                                               enum thermal_notify_event event)
508 { }
509 static inline void thermal_zone_set_trips(struct thermal_zone_device *tz)
510 { }
511 static inline struct thermal_cooling_device *
512 thermal_cooling_device_register(char *type, void *devdata,
513         const struct thermal_cooling_device_ops *ops)
514 { return ERR_PTR(-ENODEV); }
515 static inline struct thermal_cooling_device *
516 thermal_of_cooling_device_register(struct device_node *np,
517         char *type, void *devdata, const struct thermal_cooling_device_ops *ops)
518 { return ERR_PTR(-ENODEV); }
519 static inline void thermal_cooling_device_unregister(
520         struct thermal_cooling_device *cdev)
521 { }
522 static inline struct thermal_zone_device *thermal_zone_get_zone_by_name(
523                 const char *name)
524 { return ERR_PTR(-ENODEV); }
525 static inline int thermal_zone_get_temp(
526                 struct thermal_zone_device *tz, int *temp)
527 { return -ENODEV; }
528 static inline int thermal_zone_get_slope(
529                 struct thermal_zone_device *tz)
530 { return -ENODEV; }
531 static inline int thermal_zone_get_offset(
532                 struct thermal_zone_device *tz)
533 { return -ENODEV; }
534 static inline int get_tz_trend(struct thermal_zone_device *tz, int trip)
535 { return -ENODEV; }
536 static inline struct thermal_instance *
537 get_thermal_instance(struct thermal_zone_device *tz,
538         struct thermal_cooling_device *cdev, int trip)
539 { return ERR_PTR(-ENODEV); }
540 static inline void thermal_cdev_update(struct thermal_cooling_device *cdev)
541 { }
542 static inline void thermal_notify_framework(struct thermal_zone_device *tz,
543         int trip)
544 { }
545 #endif /* CONFIG_THERMAL */
546
547 #if defined(CONFIG_NET) && IS_ENABLED(CONFIG_THERMAL)
548 extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
549                                                 enum events event);
550 #else
551 static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
552                                                 enum events event)
553 {
554         return 0;
555 }
556 #endif
557
558 #endif /* __THERMAL_H__ */