Commit | Line | Data |
---|---|---|
4a11b59d AV |
1 | /* |
2 | * Universal power supply monitor class | |
3 | * | |
4 | * Copyright © 2007 Anton Vorontsov <cbou@mail.ru> | |
5 | * Copyright © 2004 Szabolcs Gyurko | |
6 | * Copyright © 2003 Ian Molton <spyro@f2s.com> | |
7 | * | |
8 | * Modified: 2004, Oct Szabolcs Gyurko | |
9 | * | |
10 | * You may use this code as per GPL version 2 | |
11 | */ | |
12 | ||
13 | #ifndef __LINUX_POWER_SUPPLY_H__ | |
14 | #define __LINUX_POWER_SUPPLY_H__ | |
15 | ||
4a11b59d AV |
16 | #include <linux/workqueue.h> |
17 | #include <linux/leds.h> | |
948dcf96 | 18 | #include <linux/spinlock.h> |
d36240d2 | 19 | #include <linux/notifier.h> |
4a11b59d AV |
20 | |
21 | /* | |
22 | * All voltages, currents, charges, energies, time and temperatures in uV, | |
23 | * µA, µAh, µWh, seconds and tenths of degree Celsius unless otherwise | |
24 | * stated. It's driver's job to convert its raw values to units in which | |
25 | * this class operates. | |
26 | */ | |
27 | ||
28 | /* | |
29 | * For systems where the charger determines the maximum battery capacity | |
30 | * the min and max fields should be used to present these values to user | |
31 | * space. Unused/unknown fields will not appear in sysfs. | |
32 | */ | |
33 | ||
34 | enum { | |
35 | POWER_SUPPLY_STATUS_UNKNOWN = 0, | |
36 | POWER_SUPPLY_STATUS_CHARGING, | |
37 | POWER_SUPPLY_STATUS_DISCHARGING, | |
38 | POWER_SUPPLY_STATUS_NOT_CHARGING, | |
39 | POWER_SUPPLY_STATUS_FULL, | |
40 | }; | |
41 | ||
ee8076ed AS |
42 | enum { |
43 | POWER_SUPPLY_CHARGE_TYPE_UNKNOWN = 0, | |
44 | POWER_SUPPLY_CHARGE_TYPE_NONE, | |
45 | POWER_SUPPLY_CHARGE_TYPE_TRICKLE, | |
46 | POWER_SUPPLY_CHARGE_TYPE_FAST, | |
47 | }; | |
48 | ||
4a11b59d AV |
49 | enum { |
50 | POWER_SUPPLY_HEALTH_UNKNOWN = 0, | |
51 | POWER_SUPPLY_HEALTH_GOOD, | |
52 | POWER_SUPPLY_HEALTH_OVERHEAT, | |
53 | POWER_SUPPLY_HEALTH_DEAD, | |
54 | POWER_SUPPLY_HEALTH_OVERVOLTAGE, | |
55 | POWER_SUPPLY_HEALTH_UNSPEC_FAILURE, | |
7e386e6e | 56 | POWER_SUPPLY_HEALTH_COLD, |
a05be991 RP |
57 | POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE, |
58 | POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE, | |
4a11b59d AV |
59 | }; |
60 | ||
61 | enum { | |
62 | POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0, | |
63 | POWER_SUPPLY_TECHNOLOGY_NiMH, | |
64 | POWER_SUPPLY_TECHNOLOGY_LION, | |
65 | POWER_SUPPLY_TECHNOLOGY_LIPO, | |
66 | POWER_SUPPLY_TECHNOLOGY_LiFe, | |
67 | POWER_SUPPLY_TECHNOLOGY_NiCd, | |
c7cc930f | 68 | POWER_SUPPLY_TECHNOLOGY_LiMn, |
4a11b59d AV |
69 | }; |
70 | ||
b294a290 AS |
71 | enum { |
72 | POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN = 0, | |
73 | POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL, | |
74 | POWER_SUPPLY_CAPACITY_LEVEL_LOW, | |
75 | POWER_SUPPLY_CAPACITY_LEVEL_NORMAL, | |
76 | POWER_SUPPLY_CAPACITY_LEVEL_HIGH, | |
77 | POWER_SUPPLY_CAPACITY_LEVEL_FULL, | |
78 | }; | |
79 | ||
25a0bc2d JF |
80 | enum { |
81 | POWER_SUPPLY_SCOPE_UNKNOWN = 0, | |
82 | POWER_SUPPLY_SCOPE_SYSTEM, | |
83 | POWER_SUPPLY_SCOPE_DEVICE, | |
84 | }; | |
85 | ||
4a11b59d AV |
86 | enum power_supply_property { |
87 | /* Properties of type `int' */ | |
88 | POWER_SUPPLY_PROP_STATUS = 0, | |
ee8076ed | 89 | POWER_SUPPLY_PROP_CHARGE_TYPE, |
4a11b59d AV |
90 | POWER_SUPPLY_PROP_HEALTH, |
91 | POWER_SUPPLY_PROP_PRESENT, | |
92 | POWER_SUPPLY_PROP_ONLINE, | |
b1b56872 | 93 | POWER_SUPPLY_PROP_AUTHENTIC, |
4a11b59d | 94 | POWER_SUPPLY_PROP_TECHNOLOGY, |
c955fe8e | 95 | POWER_SUPPLY_PROP_CYCLE_COUNT, |
c7cc930f DB |
96 | POWER_SUPPLY_PROP_VOLTAGE_MAX, |
97 | POWER_SUPPLY_PROP_VOLTAGE_MIN, | |
4a11b59d AV |
98 | POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN, |
99 | POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN, | |
100 | POWER_SUPPLY_PROP_VOLTAGE_NOW, | |
101 | POWER_SUPPLY_PROP_VOLTAGE_AVG, | |
a2ebfe2f | 102 | POWER_SUPPLY_PROP_VOLTAGE_OCV, |
a8adcc90 | 103 | POWER_SUPPLY_PROP_VOLTAGE_BOOT, |
fe3f6d09 | 104 | POWER_SUPPLY_PROP_CURRENT_MAX, |
4a11b59d AV |
105 | POWER_SUPPLY_PROP_CURRENT_NOW, |
106 | POWER_SUPPLY_PROP_CURRENT_AVG, | |
a8adcc90 | 107 | POWER_SUPPLY_PROP_CURRENT_BOOT, |
7faa144a AS |
108 | POWER_SUPPLY_PROP_POWER_NOW, |
109 | POWER_SUPPLY_PROP_POWER_AVG, | |
4a11b59d AV |
110 | POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN, |
111 | POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN, | |
112 | POWER_SUPPLY_PROP_CHARGE_FULL, | |
113 | POWER_SUPPLY_PROP_CHARGE_EMPTY, | |
114 | POWER_SUPPLY_PROP_CHARGE_NOW, | |
115 | POWER_SUPPLY_PROP_CHARGE_AVG, | |
8e552c36 | 116 | POWER_SUPPLY_PROP_CHARGE_COUNTER, |
3824c477 | 117 | POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT, |
2815b786 | 118 | POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX, |
3824c477 | 119 | POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE, |
2815b786 | 120 | POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX, |
ea2ce92e RP |
121 | POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT, |
122 | POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX, | |
6bb1d272 | 123 | POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT, |
4a11b59d AV |
124 | POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN, |
125 | POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN, | |
126 | POWER_SUPPLY_PROP_ENERGY_FULL, | |
127 | POWER_SUPPLY_PROP_ENERGY_EMPTY, | |
128 | POWER_SUPPLY_PROP_ENERGY_NOW, | |
129 | POWER_SUPPLY_PROP_ENERGY_AVG, | |
130 | POWER_SUPPLY_PROP_CAPACITY, /* in percents! */ | |
e908c418 RP |
131 | POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */ |
132 | POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */ | |
b294a290 | 133 | POWER_SUPPLY_PROP_CAPACITY_LEVEL, |
4a11b59d | 134 | POWER_SUPPLY_PROP_TEMP, |
6bb1d272 JT |
135 | POWER_SUPPLY_PROP_TEMP_MAX, |
136 | POWER_SUPPLY_PROP_TEMP_MIN, | |
e908c418 RP |
137 | POWER_SUPPLY_PROP_TEMP_ALERT_MIN, |
138 | POWER_SUPPLY_PROP_TEMP_ALERT_MAX, | |
4a11b59d | 139 | POWER_SUPPLY_PROP_TEMP_AMBIENT, |
e908c418 RP |
140 | POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN, |
141 | POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX, | |
4a11b59d AV |
142 | POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW, |
143 | POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG, | |
144 | POWER_SUPPLY_PROP_TIME_TO_FULL_NOW, | |
145 | POWER_SUPPLY_PROP_TIME_TO_FULL_AVG, | |
5f487cd3 | 146 | POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */ |
25a0bc2d | 147 | POWER_SUPPLY_PROP_SCOPE, |
6bb1d272 | 148 | POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT, |
a8adcc90 | 149 | POWER_SUPPLY_PROP_CALIBRATE, |
4a11b59d AV |
150 | /* Properties of type `const char *' */ |
151 | POWER_SUPPLY_PROP_MODEL_NAME, | |
152 | POWER_SUPPLY_PROP_MANUFACTURER, | |
7c2670bb | 153 | POWER_SUPPLY_PROP_SERIAL_NUMBER, |
4a11b59d AV |
154 | }; |
155 | ||
156 | enum power_supply_type { | |
9b887227 KM |
157 | POWER_SUPPLY_TYPE_UNKNOWN = 0, |
158 | POWER_SUPPLY_TYPE_BATTERY, | |
4a11b59d AV |
159 | POWER_SUPPLY_TYPE_UPS, |
160 | POWER_SUPPLY_TYPE_MAINS, | |
85efc8a1 HK |
161 | POWER_SUPPLY_TYPE_USB, /* Standard Downstream Port */ |
162 | POWER_SUPPLY_TYPE_USB_DCP, /* Dedicated Charging Port */ | |
163 | POWER_SUPPLY_TYPE_USB_CDP, /* Charging Downstream Port */ | |
164 | POWER_SUPPLY_TYPE_USB_ACA, /* Accessory Charger Adapters */ | |
4a11b59d AV |
165 | }; |
166 | ||
d36240d2 PR |
167 | enum power_supply_notifier_events { |
168 | PSY_EVENT_PROP_CHANGED, | |
169 | }; | |
170 | ||
4a11b59d AV |
171 | union power_supply_propval { |
172 | int intval; | |
173 | const char *strval; | |
174 | }; | |
175 | ||
3c5f8853 | 176 | struct device; |
b50df95c AV |
177 | struct device_node; |
178 | ||
4a11b59d AV |
179 | struct power_supply { |
180 | const char *name; | |
181 | enum power_supply_type type; | |
182 | enum power_supply_property *properties; | |
183 | size_t num_properties; | |
184 | ||
185 | char **supplied_to; | |
186 | size_t num_supplicants; | |
187 | ||
5e0848c6 RK |
188 | char **supplied_from; |
189 | size_t num_supplies; | |
f6e0b081 | 190 | struct device_node *of_node; |
5e0848c6 | 191 | |
4a11b59d AV |
192 | int (*get_property)(struct power_supply *psy, |
193 | enum power_supply_property psp, | |
194 | union power_supply_propval *val); | |
0011d2d4 DM |
195 | int (*set_property)(struct power_supply *psy, |
196 | enum power_supply_property psp, | |
197 | const union power_supply_propval *val); | |
198 | int (*property_is_writeable)(struct power_supply *psy, | |
199 | enum power_supply_property psp); | |
4a11b59d | 200 | void (*external_power_changed)(struct power_supply *psy); |
e5f5ccb6 | 201 | void (*set_charged)(struct power_supply *psy); |
4a11b59d | 202 | |
a69d82b9 KK |
203 | /* |
204 | * Set if thermal zone should not be created for this power supply. | |
205 | * For example for virtual supplies forwarding calls to actual | |
206 | * sensors or other supplies. | |
207 | */ | |
208 | bool no_thermal; | |
4a11b59d AV |
209 | /* For APM emulation, think legacy userspace. */ |
210 | int use_for_apm; | |
211 | ||
212 | /* private */ | |
213 | struct device *dev; | |
214 | struct work_struct changed_work; | |
948dcf96 ZM |
215 | spinlock_t changed_lock; |
216 | bool changed; | |
3be330bf JT |
217 | #ifdef CONFIG_THERMAL |
218 | struct thermal_zone_device *tzd; | |
952aeeb3 | 219 | struct thermal_cooling_device *tcd; |
3be330bf | 220 | #endif |
4a11b59d AV |
221 | |
222 | #ifdef CONFIG_LEDS_TRIGGERS | |
223 | struct led_trigger *charging_full_trig; | |
224 | char *charging_full_trig_name; | |
225 | struct led_trigger *charging_trig; | |
226 | char *charging_trig_name; | |
227 | struct led_trigger *full_trig; | |
228 | char *full_trig_name; | |
229 | struct led_trigger *online_trig; | |
230 | char *online_trig_name; | |
6501f728 VK |
231 | struct led_trigger *charging_blink_full_solid_trig; |
232 | char *charging_blink_full_solid_trig_name; | |
4a11b59d AV |
233 | #endif |
234 | }; | |
235 | ||
236 | /* | |
237 | * This is recommended structure to specify static power supply parameters. | |
238 | * Generic one, parametrizable for different power supplies. Power supply | |
239 | * class itself does not use it, but that's what implementing most platform | |
240 | * drivers, should try reuse for consistency. | |
241 | */ | |
242 | ||
243 | struct power_supply_info { | |
244 | const char *name; | |
245 | int technology; | |
246 | int voltage_max_design; | |
247 | int voltage_min_design; | |
248 | int charge_full_design; | |
249 | int charge_empty_design; | |
250 | int energy_full_design; | |
251 | int energy_empty_design; | |
252 | int use_for_apm; | |
253 | }; | |
254 | ||
d36240d2 PR |
255 | extern struct atomic_notifier_head power_supply_notifier; |
256 | extern int power_supply_reg_notifier(struct notifier_block *nb); | |
257 | extern void power_supply_unreg_notifier(struct notifier_block *nb); | |
9f3b795a | 258 | extern struct power_supply *power_supply_get_by_name(const char *name); |
abce9770 SR |
259 | #ifdef CONFIG_OF |
260 | extern struct power_supply *power_supply_get_by_phandle(struct device_node *np, | |
261 | const char *property); | |
262 | #else /* !CONFIG_OF */ | |
263 | static inline struct power_supply * | |
264 | power_supply_get_by_phandle(struct device_node *np, const char *property) | |
265 | { return NULL; } | |
266 | #endif /* CONFIG_OF */ | |
4a11b59d AV |
267 | extern void power_supply_changed(struct power_supply *psy); |
268 | extern int power_supply_am_i_supplied(struct power_supply *psy); | |
e5f5ccb6 | 269 | extern int power_supply_set_battery_charged(struct power_supply *psy); |
4a11b59d | 270 | |
0d4ed4e2 | 271 | #ifdef CONFIG_POWER_SUPPLY |
942ed161 MG |
272 | extern int power_supply_is_system_supplied(void); |
273 | #else | |
274 | static inline int power_supply_is_system_supplied(void) { return -ENOSYS; } | |
275 | #endif | |
276 | ||
4a11b59d AV |
277 | extern int power_supply_register(struct device *parent, |
278 | struct power_supply *psy); | |
9113e260 ZR |
279 | extern int power_supply_register_no_ws(struct device *parent, |
280 | struct power_supply *psy); | |
5d8a4219 N |
281 | extern int devm_power_supply_register(struct device *parent, |
282 | struct power_supply *psy); | |
283 | extern int devm_power_supply_register_no_ws(struct device *parent, | |
284 | struct power_supply *psy); | |
4a11b59d | 285 | extern void power_supply_unregister(struct power_supply *psy); |
83516651 | 286 | extern int power_supply_powers(struct power_supply *psy, struct device *dev); |
4a11b59d AV |
287 | |
288 | /* For APM emulation, think legacy userspace. */ | |
289 | extern struct class *power_supply_class; | |
290 | ||
51d07566 RK |
291 | static inline bool power_supply_is_amp_property(enum power_supply_property psp) |
292 | { | |
293 | switch (psp) { | |
294 | case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN: | |
295 | case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN: | |
296 | case POWER_SUPPLY_PROP_CHARGE_FULL: | |
297 | case POWER_SUPPLY_PROP_CHARGE_EMPTY: | |
298 | case POWER_SUPPLY_PROP_CHARGE_NOW: | |
299 | case POWER_SUPPLY_PROP_CHARGE_AVG: | |
300 | case POWER_SUPPLY_PROP_CHARGE_COUNTER: | |
3824c477 | 301 | case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT: |
2815b786 | 302 | case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX: |
51d07566 RK |
303 | case POWER_SUPPLY_PROP_CURRENT_MAX: |
304 | case POWER_SUPPLY_PROP_CURRENT_NOW: | |
305 | case POWER_SUPPLY_PROP_CURRENT_AVG: | |
a8adcc90 | 306 | case POWER_SUPPLY_PROP_CURRENT_BOOT: |
51d07566 RK |
307 | return 1; |
308 | default: | |
309 | break; | |
310 | } | |
311 | ||
312 | return 0; | |
313 | } | |
314 | ||
315 | static inline bool power_supply_is_watt_property(enum power_supply_property psp) | |
316 | { | |
317 | switch (psp) { | |
318 | case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN: | |
319 | case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN: | |
320 | case POWER_SUPPLY_PROP_ENERGY_FULL: | |
321 | case POWER_SUPPLY_PROP_ENERGY_EMPTY: | |
322 | case POWER_SUPPLY_PROP_ENERGY_NOW: | |
323 | case POWER_SUPPLY_PROP_ENERGY_AVG: | |
324 | case POWER_SUPPLY_PROP_VOLTAGE_MAX: | |
325 | case POWER_SUPPLY_PROP_VOLTAGE_MIN: | |
326 | case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN: | |
327 | case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN: | |
328 | case POWER_SUPPLY_PROP_VOLTAGE_NOW: | |
329 | case POWER_SUPPLY_PROP_VOLTAGE_AVG: | |
a2ebfe2f | 330 | case POWER_SUPPLY_PROP_VOLTAGE_OCV: |
a8adcc90 | 331 | case POWER_SUPPLY_PROP_VOLTAGE_BOOT: |
3824c477 | 332 | case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE: |
2815b786 | 333 | case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX: |
35c9d267 | 334 | case POWER_SUPPLY_PROP_POWER_NOW: |
51d07566 RK |
335 | return 1; |
336 | default: | |
337 | break; | |
338 | } | |
339 | ||
340 | return 0; | |
341 | } | |
342 | ||
4a11b59d | 343 | #endif /* __LINUX_POWER_SUPPLY_H__ */ |