]>
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 | ||
28 | #include <linux/idr.h> | |
29 | #include <linux/device.h> | |
b1569e99 | 30 | #include <linux/workqueue.h> |
203d3d4a | 31 | |
23064088 D |
32 | #define THERMAL_TRIPS_NONE -1 |
33 | #define THERMAL_MAX_TRIPS 12 | |
34 | #define THERMAL_NAME_LENGTH 20 | |
35 | ||
57df8106 ZR |
36 | /* invalid cooling state */ |
37 | #define THERMAL_CSTATE_INVALID -1UL | |
38 | ||
23064088 | 39 | /* No upper/lower limit requirement */ |
57df8106 | 40 | #define THERMAL_NO_LIMIT THERMAL_CSTATE_INVALID |
23064088 D |
41 | |
42 | /* Unit conversion macros */ | |
43 | #define KELVIN_TO_CELSIUS(t) (long)(((long)t-2732 >= 0) ? \ | |
44 | ((long)t-2732+5)/10 : ((long)t-2732-5)/10) | |
45 | #define CELSIUS_TO_KELVIN(t) ((t)*10+2732) | |
46 | ||
47 | /* Adding event notification support elements */ | |
48 | #define THERMAL_GENL_FAMILY_NAME "thermal_event" | |
49 | #define THERMAL_GENL_VERSION 0x01 | |
73214f5d | 50 | #define THERMAL_GENL_MCAST_GROUP_NAME "thermal_mc_grp" |
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 | ||
23064088 D |
84 | /* Events supported by Thermal Netlink */ |
85 | enum events { | |
86 | THERMAL_AUX0, | |
87 | THERMAL_AUX1, | |
88 | THERMAL_CRITICAL, | |
89 | THERMAL_DEV_FAULT, | |
90 | }; | |
91 | ||
92 | /* attributes of thermal_genl_family */ | |
93 | enum { | |
94 | THERMAL_GENL_ATTR_UNSPEC, | |
95 | THERMAL_GENL_ATTR_EVENT, | |
96 | __THERMAL_GENL_ATTR_MAX, | |
97 | }; | |
98 | #define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1) | |
99 | ||
100 | /* commands supported by the thermal_genl_family */ | |
101 | enum { | |
102 | THERMAL_GENL_CMD_UNSPEC, | |
103 | THERMAL_GENL_CMD_EVENT, | |
104 | __THERMAL_GENL_CMD_MAX, | |
105 | }; | |
106 | #define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1) | |
107 | ||
203d3d4a ZR |
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 *); | |
6503e5df MG |
113 | int (*get_temp) (struct thermal_zone_device *, unsigned long *); |
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, | |
121 | unsigned long *); | |
c56f5c03 D |
122 | int (*set_trip_temp) (struct thermal_zone_device *, int, |
123 | unsigned long); | |
27365a6c D |
124 | int (*get_trip_hyst) (struct thermal_zone_device *, int, |
125 | unsigned long *); | |
126 | int (*set_trip_hyst) (struct thermal_zone_device *, int, | |
127 | unsigned long); | |
9ec732ff | 128 | int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *); |
e6e238c3 | 129 | int (*set_emul_temp) (struct thermal_zone_device *, unsigned long); |
601f3d42 ZR |
130 | int (*get_trend) (struct thermal_zone_device *, int, |
131 | enum thermal_trend *); | |
b1569e99 MG |
132 | int (*notify) (struct thermal_zone_device *, int, |
133 | enum thermal_trip_type); | |
203d3d4a ZR |
134 | }; |
135 | ||
136 | struct thermal_cooling_device_ops { | |
6503e5df MG |
137 | int (*get_max_state) (struct thermal_cooling_device *, unsigned long *); |
138 | int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *); | |
139 | int (*set_cur_state) (struct thermal_cooling_device *, unsigned long); | |
203d3d4a ZR |
140 | }; |
141 | ||
203d3d4a ZR |
142 | struct thermal_cooling_device { |
143 | int id; | |
144 | char type[THERMAL_NAME_LENGTH]; | |
145 | struct device device; | |
146 | void *devdata; | |
5b275ce2 | 147 | const struct thermal_cooling_device_ops *ops; |
ce119f83 | 148 | bool updated; /* true if the cooling device does not need update */ |
f4a821ce | 149 | struct mutex lock; /* protect thermal_instances list */ |
b5e4ae62 | 150 | struct list_head thermal_instances; |
203d3d4a ZR |
151 | struct list_head node; |
152 | }; | |
153 | ||
c56f5c03 D |
154 | struct thermal_attr { |
155 | struct device_attribute attr; | |
156 | char name[THERMAL_NAME_LENGTH]; | |
157 | }; | |
158 | ||
203d3d4a ZR |
159 | struct thermal_zone_device { |
160 | int id; | |
161 | char type[THERMAL_NAME_LENGTH]; | |
162 | struct device device; | |
c56f5c03 D |
163 | struct thermal_attr *trip_temp_attrs; |
164 | struct thermal_attr *trip_type_attrs; | |
27365a6c | 165 | struct thermal_attr *trip_hyst_attrs; |
203d3d4a ZR |
166 | void *devdata; |
167 | int trips; | |
b1569e99 MG |
168 | int passive_delay; |
169 | int polling_delay; | |
601f3d42 | 170 | int temperature; |
b1569e99 | 171 | int last_temperature; |
e6e238c3 | 172 | int emul_temperature; |
908b9fb7 | 173 | int passive; |
03a971a2 | 174 | unsigned int forced_passive; |
5b275ce2 | 175 | const struct thermal_zone_device_ops *ops; |
ef873947 | 176 | const struct thermal_zone_params *tzp; |
a4a15485 | 177 | struct thermal_governor *governor; |
2d374139 | 178 | struct list_head thermal_instances; |
203d3d4a | 179 | struct idr idr; |
2d374139 | 180 | struct mutex lock; /* protect thermal_instances list */ |
203d3d4a | 181 | struct list_head node; |
b1569e99 | 182 | struct delayed_work poll_queue; |
203d3d4a | 183 | }; |
4cb18728 | 184 | |
a4a15485 D |
185 | /* Structure that holds thermal governor information */ |
186 | struct thermal_governor { | |
187 | char name[THERMAL_NAME_LENGTH]; | |
188 | int (*throttle)(struct thermal_zone_device *tz, int trip); | |
189 | struct list_head governor_list; | |
a4a15485 D |
190 | }; |
191 | ||
ef873947 D |
192 | /* Structure that holds binding parameters for a zone */ |
193 | struct thermal_bind_params { | |
194 | struct thermal_cooling_device *cdev; | |
195 | ||
196 | /* | |
197 | * This is a measure of 'how effectively these devices can | |
198 | * cool 'this' thermal zone. The shall be determined by platform | |
199 | * characterization. This is on a 'percentage' scale. | |
200 | * See Documentation/thermal/sysfs-api.txt for more information. | |
201 | */ | |
202 | int weight; | |
203 | ||
204 | /* | |
205 | * This is a bit mask that gives the binding relation between this | |
206 | * thermal zone and cdev, for a particular trip point. | |
207 | * See Documentation/thermal/sysfs-api.txt for more information. | |
208 | */ | |
209 | int trip_mask; | |
210 | int (*match) (struct thermal_zone_device *tz, | |
211 | struct thermal_cooling_device *cdev); | |
212 | }; | |
213 | ||
214 | /* Structure to define Thermal Zone parameters */ | |
215 | struct thermal_zone_params { | |
a4a15485 | 216 | char governor_name[THERMAL_NAME_LENGTH]; |
ef873947 D |
217 | int num_tbps; /* Number of tbp entries */ |
218 | struct thermal_bind_params *tbp; | |
219 | }; | |
220 | ||
4cb18728 D |
221 | struct thermal_genl_event { |
222 | u32 orig; | |
223 | enum events event; | |
224 | }; | |
203d3d4a | 225 | |
23064088 | 226 | /* Function declarations */ |
4b1bf587 | 227 | struct thermal_zone_device *thermal_zone_device_register(const char *, int, int, |
50125a9b D |
228 | void *, const struct thermal_zone_device_ops *, |
229 | const struct thermal_zone_params *, int, int); | |
203d3d4a ZR |
230 | void thermal_zone_device_unregister(struct thermal_zone_device *); |
231 | ||
232 | int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int, | |
9d99842f ZR |
233 | struct thermal_cooling_device *, |
234 | unsigned long, unsigned long); | |
203d3d4a ZR |
235 | int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int, |
236 | struct thermal_cooling_device *); | |
b1569e99 | 237 | void thermal_zone_device_update(struct thermal_zone_device *); |
23064088 | 238 | |
203d3d4a | 239 | struct thermal_cooling_device *thermal_cooling_device_register(char *, void *, |
5b275ce2 | 240 | const struct thermal_cooling_device_ops *); |
203d3d4a | 241 | void thermal_cooling_device_unregister(struct thermal_cooling_device *); |
63c4d919 | 242 | struct thermal_zone_device *thermal_zone_get_zone_by_name(const char *name); |
837b26bb | 243 | int thermal_zone_get_temp(struct thermal_zone_device *tz, unsigned long *temp); |
af06216a | 244 | |
9b4298a0 D |
245 | int get_tz_trend(struct thermal_zone_device *, int); |
246 | struct thermal_instance *get_thermal_instance(struct thermal_zone_device *, | |
247 | struct thermal_cooling_device *, int); | |
dc765482 | 248 | void thermal_cdev_update(struct thermal_cooling_device *); |
7b73c993 | 249 | void thermal_notify_framework(struct thermal_zone_device *, int); |
a4a15485 | 250 | |
af06216a | 251 | #ifdef CONFIG_NET |
8ab3e6a0 EV |
252 | extern int thermal_generate_netlink_event(struct thermal_zone_device *tz, |
253 | enum events event); | |
af06216a | 254 | #else |
f8b58705 | 255 | static inline int thermal_generate_netlink_event(struct thermal_zone_device *tz, |
8ab3e6a0 | 256 | enum events event) |
af06216a RW |
257 | { |
258 | return 0; | |
259 | } | |
260 | #endif | |
203d3d4a | 261 | |
a0dd25b2 | 262 | #endif /* __THERMAL_H__ */ |