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