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