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
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
35enum {
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
43enum {
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
50enum {
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,
57 POWER_SUPPLY_HEALTH_COLD,
58 POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE,
59 POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE,
60};
61
62enum {
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,
69 POWER_SUPPLY_TECHNOLOGY_LiMn,
70};
71
72enum {
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
81enum {
82 POWER_SUPPLY_SCOPE_UNKNOWN = 0,
83 POWER_SUPPLY_SCOPE_SYSTEM,
84 POWER_SUPPLY_SCOPE_DEVICE,
85};
86
87enum power_supply_property {
88 /* Properties of type `int' */
89 POWER_SUPPLY_PROP_STATUS = 0,
90 POWER_SUPPLY_PROP_CHARGE_TYPE,
91 POWER_SUPPLY_PROP_HEALTH,
92 POWER_SUPPLY_PROP_PRESENT,
93 POWER_SUPPLY_PROP_ONLINE,
94 POWER_SUPPLY_PROP_AUTHENTIC,
95 POWER_SUPPLY_PROP_TECHNOLOGY,
96 POWER_SUPPLY_PROP_CYCLE_COUNT,
97 POWER_SUPPLY_PROP_VOLTAGE_MAX,
98 POWER_SUPPLY_PROP_VOLTAGE_MIN,
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,
103 POWER_SUPPLY_PROP_VOLTAGE_OCV,
104 POWER_SUPPLY_PROP_VOLTAGE_BOOT,
105 POWER_SUPPLY_PROP_CURRENT_MAX,
106 POWER_SUPPLY_PROP_CURRENT_NOW,
107 POWER_SUPPLY_PROP_CURRENT_AVG,
108 POWER_SUPPLY_PROP_CURRENT_BOOT,
109 POWER_SUPPLY_PROP_POWER_NOW,
110 POWER_SUPPLY_PROP_POWER_AVG,
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,
117 POWER_SUPPLY_PROP_CHARGE_COUNTER,
118 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
119 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
120 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
121 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
122 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
123 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
124 POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT,
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! */
132 POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
133 POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
134 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
135 POWER_SUPPLY_PROP_TEMP,
136 POWER_SUPPLY_PROP_TEMP_MAX,
137 POWER_SUPPLY_PROP_TEMP_MIN,
138 POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
139 POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
140 POWER_SUPPLY_PROP_TEMP_AMBIENT,
141 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
142 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
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,
147 POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
148 POWER_SUPPLY_PROP_USB_TYPE,
149 POWER_SUPPLY_PROP_SCOPE,
150 POWER_SUPPLY_PROP_PRECHARGE_CURRENT,
151 POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT,
152 POWER_SUPPLY_PROP_CALIBRATE,
153 /* Properties of type `const char *' */
154 POWER_SUPPLY_PROP_MODEL_NAME,
155 POWER_SUPPLY_PROP_MANUFACTURER,
156 POWER_SUPPLY_PROP_SERIAL_NUMBER,
157};
158
159enum power_supply_type {
160 POWER_SUPPLY_TYPE_UNKNOWN = 0,
161 POWER_SUPPLY_TYPE_BATTERY,
162 POWER_SUPPLY_TYPE_UPS,
163 POWER_SUPPLY_TYPE_MAINS,
164 POWER_SUPPLY_TYPE_USB, /* Standard Downstream Port */
165 POWER_SUPPLY_TYPE_USB_DCP, /* Dedicated Charging Port */
166 POWER_SUPPLY_TYPE_USB_CDP, /* Charging Downstream Port */
167 POWER_SUPPLY_TYPE_USB_ACA, /* Accessory Charger Adapters */
168 POWER_SUPPLY_TYPE_USB_TYPE_C, /* Type C Port */
169 POWER_SUPPLY_TYPE_USB_PD, /* Power Delivery Port */
170 POWER_SUPPLY_TYPE_USB_PD_DRP, /* PD Dual Role Port */
171 POWER_SUPPLY_TYPE_APPLE_BRICK_ID, /* Apple Charging Method */
172};
173
174enum power_supply_usb_type {
175 POWER_SUPPLY_USB_TYPE_UNKNOWN = 0,
176 POWER_SUPPLY_USB_TYPE_SDP, /* Standard Downstream Port */
177 POWER_SUPPLY_USB_TYPE_DCP, /* Dedicated Charging Port */
178 POWER_SUPPLY_USB_TYPE_CDP, /* Charging Downstream Port */
179 POWER_SUPPLY_USB_TYPE_ACA, /* Accessory Charger Adapters */
180 POWER_SUPPLY_USB_TYPE_C, /* Type C Port */
181 POWER_SUPPLY_USB_TYPE_PD, /* Power Delivery Port */
182 POWER_SUPPLY_USB_TYPE_PD_DRP, /* PD Dual Role Port */
183 POWER_SUPPLY_USB_TYPE_PD_PPS, /* PD Programmable Power Supply */
184 POWER_SUPPLY_USB_TYPE_APPLE_BRICK_ID, /* Apple Charging Method */
185};
186
187enum power_supply_notifier_events {
188 PSY_EVENT_PROP_CHANGED,
189};
190
191union power_supply_propval {
192 int intval;
193 const char *strval;
194};
195
196struct device_node;
197struct power_supply;
198
199/* Run-time specific power supply configuration */
200struct power_supply_config {
201 struct device_node *of_node;
202 struct fwnode_handle *fwnode;
203
204 /* Driver private data */
205 void *drv_data;
206
207 /* Device specific sysfs attributes */
208 const struct attribute_group **attr_grp;
209
210 char **supplied_to;
211 size_t num_supplicants;
212};
213
214/* Description of power supply */
215struct power_supply_desc {
216 const char *name;
217 enum power_supply_type type;
218 enum power_supply_usb_type *usb_types;
219 size_t num_usb_types;
220 enum power_supply_property *properties;
221 size_t num_properties;
222
223 /*
224 * Functions for drivers implementing power supply class.
225 * These shouldn't be called directly by other drivers for accessing
226 * this power supply. Instead use power_supply_*() functions (for
227 * example power_supply_get_property()).
228 */
229 int (*get_property)(struct power_supply *psy,
230 enum power_supply_property psp,
231 union power_supply_propval *val);
232 int (*set_property)(struct power_supply *psy,
233 enum power_supply_property psp,
234 const union power_supply_propval *val);
235 /*
236 * property_is_writeable() will be called during registration
237 * of power supply. If this happens during device probe then it must
238 * not access internal data of device (because probe did not end).
239 */
240 int (*property_is_writeable)(struct power_supply *psy,
241 enum power_supply_property psp);
242 void (*external_power_changed)(struct power_supply *psy);
243 void (*set_charged)(struct power_supply *psy);
244
245 /*
246 * Set if thermal zone should not be created for this power supply.
247 * For example for virtual supplies forwarding calls to actual
248 * sensors or other supplies.
249 */
250 bool no_thermal;
251 /* For APM emulation, think legacy userspace. */
252 int use_for_apm;
253};
254
255struct power_supply {
256 const struct power_supply_desc *desc;
257
258 char **supplied_to;
259 size_t num_supplicants;
260
261 char **supplied_from;
262 size_t num_supplies;
263 struct device_node *of_node;
264
265 /* Driver private data */
266 void *drv_data;
267
268 /* private */
269 struct device dev;
270 struct work_struct changed_work;
271 struct delayed_work deferred_register_work;
272 spinlock_t changed_lock;
273 bool changed;
274 bool initialized;
275 bool removing;
276 atomic_t use_cnt;
277#ifdef CONFIG_THERMAL
278 struct thermal_zone_device *tzd;
279 struct thermal_cooling_device *tcd;
280#endif
281
282#ifdef CONFIG_LEDS_TRIGGERS
283 struct led_trigger *charging_full_trig;
284 char *charging_full_trig_name;
285 struct led_trigger *charging_trig;
286 char *charging_trig_name;
287 struct led_trigger *full_trig;
288 char *full_trig_name;
289 struct led_trigger *online_trig;
290 char *online_trig_name;
291 struct led_trigger *charging_blink_full_solid_trig;
292 char *charging_blink_full_solid_trig_name;
293#endif
294};
295
296/*
297 * This is recommended structure to specify static power supply parameters.
298 * Generic one, parametrizable for different power supplies. Power supply
299 * class itself does not use it, but that's what implementing most platform
300 * drivers, should try reuse for consistency.
301 */
302
303struct power_supply_info {
304 const char *name;
305 int technology;
306 int voltage_max_design;
307 int voltage_min_design;
308 int charge_full_design;
309 int charge_empty_design;
310 int energy_full_design;
311 int energy_empty_design;
312 int use_for_apm;
313};
314
315struct power_supply_battery_ocv_table {
316 int ocv; /* microVolts */
317 int capacity; /* percent */
318};
319
320#define POWER_SUPPLY_OCV_TEMP_MAX 20
321
322/*
323 * This is the recommended struct to manage static battery parameters,
324 * populated by power_supply_get_battery_info(). Most platform drivers should
325 * use these for consistency.
326 * Its field names must correspond to elements in enum power_supply_property.
327 * The default field value is -EINVAL.
328 * Power supply class itself doesn't use this.
329 */
330
331struct power_supply_battery_info {
332 int energy_full_design_uwh; /* microWatt-hours */
333 int charge_full_design_uah; /* microAmp-hours */
334 int voltage_min_design_uv; /* microVolts */
335 int voltage_max_design_uv; /* microVolts */
336 int precharge_current_ua; /* microAmps */
337 int charge_term_current_ua; /* microAmps */
338 int constant_charge_current_max_ua; /* microAmps */
339 int constant_charge_voltage_max_uv; /* microVolts */
340 int factory_internal_resistance_uohm; /* microOhms */
341 int ocv_temp[POWER_SUPPLY_OCV_TEMP_MAX];/* celsius */
342 struct power_supply_battery_ocv_table *ocv_table[POWER_SUPPLY_OCV_TEMP_MAX];
343 int ocv_table_size[POWER_SUPPLY_OCV_TEMP_MAX];
344};
345
346extern struct atomic_notifier_head power_supply_notifier;
347extern int power_supply_reg_notifier(struct notifier_block *nb);
348extern void power_supply_unreg_notifier(struct notifier_block *nb);
349extern struct power_supply *power_supply_get_by_name(const char *name);
350extern void power_supply_put(struct power_supply *psy);
351#ifdef CONFIG_OF
352extern struct power_supply *power_supply_get_by_phandle(struct device_node *np,
353 const char *property);
354extern struct power_supply *devm_power_supply_get_by_phandle(
355 struct device *dev, const char *property);
356#else /* !CONFIG_OF */
357static inline struct power_supply *
358power_supply_get_by_phandle(struct device_node *np, const char *property)
359{ return NULL; }
360static inline struct power_supply *
361devm_power_supply_get_by_phandle(struct device *dev, const char *property)
362{ return NULL; }
363#endif /* CONFIG_OF */
364
365extern int power_supply_get_battery_info(struct power_supply *psy,
366 struct power_supply_battery_info *info);
367extern void power_supply_put_battery_info(struct power_supply *psy,
368 struct power_supply_battery_info *info);
369extern int power_supply_ocv2cap_simple(struct power_supply_battery_ocv_table *table,
370 int table_len, int ocv);
371extern struct power_supply_battery_ocv_table *
372power_supply_find_ocv2cap_table(struct power_supply_battery_info *info,
373 int temp, int *table_len);
374extern int power_supply_batinfo_ocv2cap(struct power_supply_battery_info *info,
375 int ocv, int temp);
376extern void power_supply_changed(struct power_supply *psy);
377extern int power_supply_am_i_supplied(struct power_supply *psy);
378extern int power_supply_set_input_current_limit_from_supplier(
379 struct power_supply *psy);
380extern int power_supply_set_battery_charged(struct power_supply *psy);
381
382#ifdef CONFIG_POWER_SUPPLY
383extern int power_supply_is_system_supplied(void);
384#else
385static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
386#endif
387
388extern int power_supply_get_property(struct power_supply *psy,
389 enum power_supply_property psp,
390 union power_supply_propval *val);
391extern int power_supply_set_property(struct power_supply *psy,
392 enum power_supply_property psp,
393 const union power_supply_propval *val);
394extern int power_supply_property_is_writeable(struct power_supply *psy,
395 enum power_supply_property psp);
396extern void power_supply_external_power_changed(struct power_supply *psy);
397
398extern struct power_supply *__must_check
399power_supply_register(struct device *parent,
400 const struct power_supply_desc *desc,
401 const struct power_supply_config *cfg);
402extern struct power_supply *__must_check
403power_supply_register_no_ws(struct device *parent,
404 const struct power_supply_desc *desc,
405 const struct power_supply_config *cfg);
406extern struct power_supply *__must_check
407devm_power_supply_register(struct device *parent,
408 const struct power_supply_desc *desc,
409 const struct power_supply_config *cfg);
410extern struct power_supply *__must_check
411devm_power_supply_register_no_ws(struct device *parent,
412 const struct power_supply_desc *desc,
413 const struct power_supply_config *cfg);
414extern void power_supply_unregister(struct power_supply *psy);
415extern int power_supply_powers(struct power_supply *psy, struct device *dev);
416
417#define to_power_supply(device) container_of(device, struct power_supply, dev)
418
419extern void *power_supply_get_drvdata(struct power_supply *psy);
420/* For APM emulation, think legacy userspace. */
421extern struct class *power_supply_class;
422
423static inline bool power_supply_is_amp_property(enum power_supply_property psp)
424{
425 switch (psp) {
426 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
427 case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
428 case POWER_SUPPLY_PROP_CHARGE_FULL:
429 case POWER_SUPPLY_PROP_CHARGE_EMPTY:
430 case POWER_SUPPLY_PROP_CHARGE_NOW:
431 case POWER_SUPPLY_PROP_CHARGE_AVG:
432 case POWER_SUPPLY_PROP_CHARGE_COUNTER:
433 case POWER_SUPPLY_PROP_PRECHARGE_CURRENT:
434 case POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT:
435 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
436 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
437 case POWER_SUPPLY_PROP_CURRENT_MAX:
438 case POWER_SUPPLY_PROP_CURRENT_NOW:
439 case POWER_SUPPLY_PROP_CURRENT_AVG:
440 case POWER_SUPPLY_PROP_CURRENT_BOOT:
441 return 1;
442 default:
443 break;
444 }
445
446 return 0;
447}
448
449static inline bool power_supply_is_watt_property(enum power_supply_property psp)
450{
451 switch (psp) {
452 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
453 case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
454 case POWER_SUPPLY_PROP_ENERGY_FULL:
455 case POWER_SUPPLY_PROP_ENERGY_EMPTY:
456 case POWER_SUPPLY_PROP_ENERGY_NOW:
457 case POWER_SUPPLY_PROP_ENERGY_AVG:
458 case POWER_SUPPLY_PROP_VOLTAGE_MAX:
459 case POWER_SUPPLY_PROP_VOLTAGE_MIN:
460 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
461 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
462 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
463 case POWER_SUPPLY_PROP_VOLTAGE_AVG:
464 case POWER_SUPPLY_PROP_VOLTAGE_OCV:
465 case POWER_SUPPLY_PROP_VOLTAGE_BOOT:
466 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
467 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
468 case POWER_SUPPLY_PROP_POWER_NOW:
469 return 1;
470 default:
471 break;
472 }
473
474 return 0;
475}
476
477#endif /* __LINUX_POWER_SUPPLY_H__ */
478