thermal: core: remove thermal_zone_device_find_by_name() to avoid duplication
[linux-3.10.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/workqueue.h>
32
33 #define THERMAL_TRIPS_NONE      -1
34 #define THERMAL_MAX_TRIPS       48
35 #define THERMAL_NAME_LENGTH     20
36
37 /* invalid cooling state */
38 #define THERMAL_CSTATE_INVALID -1UL
39
40 /* No upper/lower limit requirement */
41 #define THERMAL_NO_LIMIT        THERMAL_CSTATE_INVALID
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)
47
48 /* Adding event notification support elements */
49 #define THERMAL_GENL_FAMILY_NAME                "thermal_event"
50 #define THERMAL_GENL_VERSION                    0x01
51 #define THERMAL_GENL_MCAST_GROUP_NAME           "thermal_mc_grp"
52
53 /* Default Thermal Governor */
54 #if defined(CONFIG_THERMAL_DEFAULT_GOV_STEP_WISE)
55 #define DEFAULT_THERMAL_GOVERNOR       "step_wise"
56 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_FAIR_SHARE)
57 #define DEFAULT_THERMAL_GOVERNOR       "fair_share"
58 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_USER_SPACE)
59 #define DEFAULT_THERMAL_GOVERNOR       "user_space"
60 #elif defined(CONFIG_THERMAL_DEFAULT_GOV_PID)
61 #define DEFAULT_THERMAL_GOVERNOR       "pid_thermal_gov"
62 #endif
63
64 struct thermal_zone_device;
65 struct thermal_cooling_device;
66
67 enum thermal_device_mode {
68         THERMAL_DEVICE_DISABLED = 0,
69         THERMAL_DEVICE_ENABLED,
70 };
71
72 enum thermal_trip_type {
73         THERMAL_TRIP_ACTIVE = 0,
74         THERMAL_TRIP_PASSIVE,
75         THERMAL_TRIP_HOT,
76         THERMAL_TRIP_CRITICAL,
77 };
78
79 enum thermal_trend {
80         THERMAL_TREND_STABLE, /* temperature is stable */
81         THERMAL_TREND_RAISING, /* temperature is raising */
82         THERMAL_TREND_DROPPING, /* temperature is dropping */
83         THERMAL_TREND_RAISE_FULL, /* apply highest cooling action */
84         THERMAL_TREND_DROP_FULL, /* apply lowest cooling action */
85 };
86
87 /* Events supported by Thermal Netlink */
88 enum events {
89         THERMAL_AUX0,
90         THERMAL_AUX1,
91         THERMAL_CRITICAL,
92         THERMAL_DEV_FAULT,
93 };
94
95 /* attributes of thermal_genl_family */
96 enum {
97         THERMAL_GENL_ATTR_UNSPEC,
98         THERMAL_GENL_ATTR_EVENT,
99         __THERMAL_GENL_ATTR_MAX,
100 };
101 #define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1)
102
103 /* commands supported by the thermal_genl_family */
104 enum {
105         THERMAL_GENL_CMD_UNSPEC,
106         THERMAL_GENL_CMD_EVENT,
107         __THERMAL_GENL_CMD_MAX,
108 };
109 #define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1)
110
111 struct thermal_zone_device_ops {
112         int (*bind) (struct thermal_zone_device *,
113                      struct thermal_cooling_device *);
114         int (*unbind) (struct thermal_zone_device *,
115                        struct thermal_cooling_device *);
116         int (*get_temp) (struct thermal_zone_device *, unsigned long *);
117         int (*get_mode) (struct thermal_zone_device *,
118                          enum thermal_device_mode *);
119         int (*set_mode) (struct thermal_zone_device *,
120                 enum thermal_device_mode);
121         int (*get_trip_type) (struct thermal_zone_device *, int,
122                 enum thermal_trip_type *);
123         int (*get_trip_temp) (struct thermal_zone_device *, int,
124                               unsigned long *);
125         int (*set_trip_temp) (struct thermal_zone_device *, int,
126                               unsigned long);
127         int (*get_trip_hyst) (struct thermal_zone_device *, int,
128                               unsigned long *);
129         int (*set_trip_hyst) (struct thermal_zone_device *, int,
130                               unsigned long);
131         int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *);
132         int (*set_emul_temp) (struct thermal_zone_device *, unsigned long);
133         int (*get_trend) (struct thermal_zone_device *, int,
134                           enum thermal_trend *);
135         int (*notify) (struct thermal_zone_device *, int,
136                        enum thermal_trip_type);
137 };
138
139 struct thermal_cooling_device_ops {
140         int (*get_max_state) (struct thermal_cooling_device *, unsigned long *);
141         int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *);
142         int (*set_cur_state) (struct thermal_cooling_device *, 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 struct thermal_zone_device {
164         int id;
165         char type[THERMAL_NAME_LENGTH];
166         struct device device;
167         struct thermal_attr *trip_temp_attrs;
168         struct thermal_attr *trip_type_attrs;
169         struct thermal_attr *trip_hyst_attrs;
170         void *devdata;
171         int trips;
172         int passive_delay;
173         int polling_delay;
174         int temperature;
175         int last_temperature;
176         int emul_temperature;
177         int passive;
178         unsigned int forced_passive;
179         struct thermal_zone_device_ops *ops;
180         const struct thermal_zone_params *tzp;
181         struct thermal_governor *governor;
182         void *governor_data;
183         struct list_head thermal_instances;
184         struct idr idr;
185         struct mutex lock; /* protect thermal_instances list */
186         struct list_head node;
187         struct delayed_work poll_queue;
188 };
189
190 /* Structure that holds thermal governor information */
191 struct thermal_governor {
192         char name[THERMAL_NAME_LENGTH];
193
194         /*
195          * The start and stop operations will be called when thermal zone is
196          * registered and when change governor via sysfs. They will not be
197          * called when cooling devices are registered or when cooling devices
198          * are bound to thermal zones.
199          */
200         int (*start)(struct thermal_zone_device *tz);
201         void (*stop)(struct thermal_zone_device *tz);
202
203         int (*throttle)(struct thermal_zone_device *tz, int trip);
204         struct list_head        governor_list;
205 };
206
207 /* Structure that holds binding parameters for a zone */
208 struct thermal_bind_params {
209         struct thermal_cooling_device *cdev;
210
211         /*
212          * This is a measure of 'how effectively these devices can
213          * cool 'this' thermal zone. The shall be determined by platform
214          * characterization. This is on a 'percentage' scale.
215          * See Documentation/thermal/sysfs-api.txt for more information.
216          */
217         int weight;
218
219         /*
220          * This is a bit mask that gives the binding relation between this
221          * thermal zone and cdev, for a particular trip point.
222          * See Documentation/thermal/sysfs-api.txt for more information.
223          */
224         u64 trip_mask;
225
226         /*
227          * This is an array of cooling state limits. Must have exactly
228          * 2 * thermal_zone.number_of_trip_points. It is an array consisting
229          * of tuples <lower-state upper-state> of state limits. Each trip
230          * will be associated with one state limit tuple when binding.
231          * A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
232          * on all trips.
233          */
234         unsigned long *binding_limits;
235         int (*match) (struct thermal_zone_device *tz,
236                         struct thermal_cooling_device *cdev);
237 };
238
239 /* Structure to define Thermal Zone parameters */
240 struct thermal_zone_params {
241         char governor_name[THERMAL_NAME_LENGTH];
242         void *governor_params;
243
244         /*
245          * a boolean to indicate if the thermal to hwmon sysfs interface
246          * is required. when no_hwmon == false, a hwmon sysfs interface
247          * will be created. when no_hwmon == true, nothing will be done
248          */
249         bool no_hwmon;
250
251         int num_tbps;   /* Number of tbp entries */
252         struct thermal_bind_params *tbp;
253 };
254
255 struct thermal_genl_event {
256         u32 orig;
257         enum events event;
258         int temp;
259 };
260
261 /* Function declarations */
262 #ifdef CONFIG_THERMAL_OF
263 struct thermal_zone_device *
264 thermal_zone_of_sensor_register(struct device *dev, int id,
265                                 void *data, int (*get_temp)(void *, long *),
266                                 int (*get_trend)(void *, long *));
267 void thermal_zone_of_sensor_unregister(struct device *dev,
268                                        struct thermal_zone_device *tz);
269 #else
270 static inline struct thermal_zone_device *
271 thermal_zone_of_sensor_register(struct device *dev, int id,
272                                 void *data, int (*get_temp)(void *, long *),
273                                 int (*get_trend)(void *, long *))
274 {
275         return NULL;
276 }
277
278 static inline
279 void thermal_zone_of_sensor_unregister(struct device *dev,
280                                        struct thermal_zone_device *tz)
281 {
282 }
283
284 #endif
285 struct thermal_zone_device *thermal_zone_device_register(const char *, int, u64,
286                 void *, struct thermal_zone_device_ops *,
287                 const struct thermal_zone_params *, int, int);
288 void thermal_zone_device_unregister(struct thermal_zone_device *);
289
290 int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int,
291                                      struct thermal_cooling_device *,
292                                      unsigned long, unsigned long);
293 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int,
294                                        struct thermal_cooling_device *);
295 void thermal_zone_device_update(struct thermal_zone_device *);
296
297 struct thermal_cooling_device *thermal_cooling_device_register(char *, void *,
298                 const struct thermal_cooling_device_ops *);
299 struct thermal_cooling_device *
300 thermal_of_cooling_device_register(struct device_node *np, char *, void *,
301                                    const struct thermal_cooling_device_ops *);
302 void thermal_cooling_device_unregister(struct thermal_cooling_device *);
303 struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name);
304 int thermal_zone_get_temp(struct thermal_zone_device *tz, unsigned long *temp);
305 struct thermal_zone_device *thermal_zone_device_find(void *data,
306         int (*match)(struct thermal_zone_device *, void *));
307
308 int get_tz_trend(struct thermal_zone_device *, int);
309 struct thermal_instance *get_thermal_instance(struct thermal_zone_device *,
310                 struct thermal_cooling_device *, int);
311 void thermal_cdev_update(struct thermal_cooling_device *);
312 void thermal_notify_framework(struct thermal_zone_device *, int);
313
314 #ifdef CONFIG_NET
315 extern int thermal_generate_netlink_event(struct thermal_zone_device *tz,
316                                                 enum events event, int temp);
317 #else
318 static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz,
319                                                 enum events event, int temp)
320 {
321         return 0;
322 }
323 #endif
324
325 #endif /* __THERMAL_H__ */