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 | ||
36 | /* No upper/lower limit requirement */ | |
37 | #define THERMAL_NO_LIMIT -1UL | |
38 | ||
39 | /* Unit conversion macros */ | |
40 | #define KELVIN_TO_CELSIUS(t) (long)(((long)t-2732 >= 0) ? \ | |
41 | ((long)t-2732+5)/10 : ((long)t-2732-5)/10) | |
42 | #define CELSIUS_TO_KELVIN(t) ((t)*10+2732) | |
43 | ||
44 | /* Adding event notification support elements */ | |
45 | #define THERMAL_GENL_FAMILY_NAME "thermal_event" | |
46 | #define THERMAL_GENL_VERSION 0x01 | |
47 | #define THERMAL_GENL_MCAST_GROUP_NAME "thermal_mc_group" | |
48 | ||
a4a15485 D |
49 | /* Default Thermal Governor: Does Linear Throttling */ |
50 | #define DEFAULT_THERMAL_GOVERNOR "step_wise" | |
51 | ||
203d3d4a ZR |
52 | struct thermal_zone_device; |
53 | struct thermal_cooling_device; | |
54 | ||
6503e5df MG |
55 | enum thermal_device_mode { |
56 | THERMAL_DEVICE_DISABLED = 0, | |
57 | THERMAL_DEVICE_ENABLED, | |
58 | }; | |
59 | ||
60 | enum thermal_trip_type { | |
61 | THERMAL_TRIP_ACTIVE = 0, | |
62 | THERMAL_TRIP_PASSIVE, | |
63 | THERMAL_TRIP_HOT, | |
64 | THERMAL_TRIP_CRITICAL, | |
65 | }; | |
66 | ||
601f3d42 ZR |
67 | enum thermal_trend { |
68 | THERMAL_TREND_STABLE, /* temperature is stable */ | |
69 | THERMAL_TREND_RAISING, /* temperature is raising */ | |
70 | THERMAL_TREND_DROPPING, /* temperature is dropping */ | |
71 | }; | |
72 | ||
23064088 D |
73 | /* Events supported by Thermal Netlink */ |
74 | enum events { | |
75 | THERMAL_AUX0, | |
76 | THERMAL_AUX1, | |
77 | THERMAL_CRITICAL, | |
78 | THERMAL_DEV_FAULT, | |
79 | }; | |
80 | ||
81 | /* attributes of thermal_genl_family */ | |
82 | enum { | |
83 | THERMAL_GENL_ATTR_UNSPEC, | |
84 | THERMAL_GENL_ATTR_EVENT, | |
85 | __THERMAL_GENL_ATTR_MAX, | |
86 | }; | |
87 | #define THERMAL_GENL_ATTR_MAX (__THERMAL_GENL_ATTR_MAX - 1) | |
88 | ||
89 | /* commands supported by the thermal_genl_family */ | |
90 | enum { | |
91 | THERMAL_GENL_CMD_UNSPEC, | |
92 | THERMAL_GENL_CMD_EVENT, | |
93 | __THERMAL_GENL_CMD_MAX, | |
94 | }; | |
95 | #define THERMAL_GENL_CMD_MAX (__THERMAL_GENL_CMD_MAX - 1) | |
96 | ||
203d3d4a ZR |
97 | struct thermal_zone_device_ops { |
98 | int (*bind) (struct thermal_zone_device *, | |
99 | struct thermal_cooling_device *); | |
100 | int (*unbind) (struct thermal_zone_device *, | |
101 | struct thermal_cooling_device *); | |
6503e5df MG |
102 | int (*get_temp) (struct thermal_zone_device *, unsigned long *); |
103 | int (*get_mode) (struct thermal_zone_device *, | |
104 | enum thermal_device_mode *); | |
105 | int (*set_mode) (struct thermal_zone_device *, | |
106 | enum thermal_device_mode); | |
107 | int (*get_trip_type) (struct thermal_zone_device *, int, | |
108 | enum thermal_trip_type *); | |
109 | int (*get_trip_temp) (struct thermal_zone_device *, int, | |
110 | unsigned long *); | |
c56f5c03 D |
111 | int (*set_trip_temp) (struct thermal_zone_device *, int, |
112 | unsigned long); | |
27365a6c D |
113 | int (*get_trip_hyst) (struct thermal_zone_device *, int, |
114 | unsigned long *); | |
115 | int (*set_trip_hyst) (struct thermal_zone_device *, int, | |
116 | unsigned long); | |
9ec732ff | 117 | int (*get_crit_temp) (struct thermal_zone_device *, unsigned long *); |
601f3d42 ZR |
118 | int (*get_trend) (struct thermal_zone_device *, int, |
119 | enum thermal_trend *); | |
b1569e99 MG |
120 | int (*notify) (struct thermal_zone_device *, int, |
121 | enum thermal_trip_type); | |
203d3d4a ZR |
122 | }; |
123 | ||
124 | struct thermal_cooling_device_ops { | |
6503e5df MG |
125 | int (*get_max_state) (struct thermal_cooling_device *, unsigned long *); |
126 | int (*get_cur_state) (struct thermal_cooling_device *, unsigned long *); | |
127 | int (*set_cur_state) (struct thermal_cooling_device *, unsigned long); | |
203d3d4a ZR |
128 | }; |
129 | ||
203d3d4a ZR |
130 | struct thermal_cooling_device { |
131 | int id; | |
132 | char type[THERMAL_NAME_LENGTH]; | |
133 | struct device device; | |
134 | void *devdata; | |
5b275ce2 | 135 | const struct thermal_cooling_device_ops *ops; |
ce119f83 | 136 | bool updated; /* true if the cooling device does not need update */ |
f4a821ce | 137 | struct mutex lock; /* protect thermal_instances list */ |
b5e4ae62 | 138 | struct list_head thermal_instances; |
203d3d4a ZR |
139 | struct list_head node; |
140 | }; | |
141 | ||
c56f5c03 D |
142 | struct thermal_attr { |
143 | struct device_attribute attr; | |
144 | char name[THERMAL_NAME_LENGTH]; | |
145 | }; | |
146 | ||
203d3d4a ZR |
147 | struct thermal_zone_device { |
148 | int id; | |
149 | char type[THERMAL_NAME_LENGTH]; | |
150 | struct device device; | |
c56f5c03 D |
151 | struct thermal_attr *trip_temp_attrs; |
152 | struct thermal_attr *trip_type_attrs; | |
27365a6c | 153 | struct thermal_attr *trip_hyst_attrs; |
203d3d4a ZR |
154 | void *devdata; |
155 | int trips; | |
b1569e99 MG |
156 | int passive_delay; |
157 | int polling_delay; | |
601f3d42 | 158 | int temperature; |
b1569e99 | 159 | int last_temperature; |
908b9fb7 | 160 | int passive; |
03a971a2 | 161 | unsigned int forced_passive; |
5b275ce2 | 162 | const struct thermal_zone_device_ops *ops; |
ef873947 | 163 | const struct thermal_zone_params *tzp; |
a4a15485 | 164 | struct thermal_governor *governor; |
2d374139 | 165 | struct list_head thermal_instances; |
203d3d4a | 166 | struct idr idr; |
2d374139 | 167 | struct mutex lock; /* protect thermal_instances list */ |
203d3d4a | 168 | struct list_head node; |
b1569e99 | 169 | struct delayed_work poll_queue; |
203d3d4a | 170 | }; |
4cb18728 | 171 | |
a4a15485 D |
172 | /* Structure that holds thermal governor information */ |
173 | struct thermal_governor { | |
174 | char name[THERMAL_NAME_LENGTH]; | |
175 | int (*throttle)(struct thermal_zone_device *tz, int trip); | |
176 | struct list_head governor_list; | |
177 | struct module *owner; | |
178 | }; | |
179 | ||
ef873947 D |
180 | /* Structure that holds binding parameters for a zone */ |
181 | struct thermal_bind_params { | |
182 | struct thermal_cooling_device *cdev; | |
183 | ||
184 | /* | |
185 | * This is a measure of 'how effectively these devices can | |
186 | * cool 'this' thermal zone. The shall be determined by platform | |
187 | * characterization. This is on a 'percentage' scale. | |
188 | * See Documentation/thermal/sysfs-api.txt for more information. | |
189 | */ | |
190 | int weight; | |
191 | ||
192 | /* | |
193 | * This is a bit mask that gives the binding relation between this | |
194 | * thermal zone and cdev, for a particular trip point. | |
195 | * See Documentation/thermal/sysfs-api.txt for more information. | |
196 | */ | |
197 | int trip_mask; | |
198 | int (*match) (struct thermal_zone_device *tz, | |
199 | struct thermal_cooling_device *cdev); | |
200 | }; | |
201 | ||
202 | /* Structure to define Thermal Zone parameters */ | |
203 | struct thermal_zone_params { | |
a4a15485 | 204 | char governor_name[THERMAL_NAME_LENGTH]; |
ef873947 D |
205 | int num_tbps; /* Number of tbp entries */ |
206 | struct thermal_bind_params *tbp; | |
207 | }; | |
208 | ||
4cb18728 D |
209 | struct thermal_genl_event { |
210 | u32 orig; | |
211 | enum events event; | |
212 | }; | |
203d3d4a | 213 | |
23064088 | 214 | /* Function declarations */ |
4b1bf587 | 215 | struct thermal_zone_device *thermal_zone_device_register(const char *, int, int, |
50125a9b D |
216 | void *, const struct thermal_zone_device_ops *, |
217 | const struct thermal_zone_params *, int, int); | |
203d3d4a ZR |
218 | void thermal_zone_device_unregister(struct thermal_zone_device *); |
219 | ||
220 | int thermal_zone_bind_cooling_device(struct thermal_zone_device *, int, | |
9d99842f ZR |
221 | struct thermal_cooling_device *, |
222 | unsigned long, unsigned long); | |
203d3d4a ZR |
223 | int thermal_zone_unbind_cooling_device(struct thermal_zone_device *, int, |
224 | struct thermal_cooling_device *); | |
b1569e99 | 225 | void thermal_zone_device_update(struct thermal_zone_device *); |
23064088 | 226 | |
203d3d4a | 227 | struct thermal_cooling_device *thermal_cooling_device_register(char *, void *, |
5b275ce2 | 228 | const struct thermal_cooling_device_ops *); |
203d3d4a | 229 | void thermal_cooling_device_unregister(struct thermal_cooling_device *); |
af06216a | 230 | |
9b4298a0 D |
231 | int get_tz_trend(struct thermal_zone_device *, int); |
232 | struct thermal_instance *get_thermal_instance(struct thermal_zone_device *, | |
233 | struct thermal_cooling_device *, int); | |
234 | ||
a4a15485 D |
235 | int thermal_register_governor(struct thermal_governor *); |
236 | void thermal_unregister_governor(struct thermal_governor *); | |
237 | ||
af06216a | 238 | #ifdef CONFIG_NET |
2d58d7ea | 239 | extern int thermal_generate_netlink_event(u32 orig, enum events event); |
af06216a | 240 | #else |
2d58d7ea | 241 | static inline int thermal_generate_netlink_event(u32 orig, enum events event) |
af06216a RW |
242 | { |
243 | return 0; | |
244 | } | |
245 | #endif | |
203d3d4a | 246 | |
a0dd25b2 | 247 | #endif /* __THERMAL_H__ */ |