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