Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Universal power supply monitor class
4 *
5 * Copyright © 2007 Anton Vorontsov <cbou@mail.ru>
6 * Copyright © 2004 Szabolcs Gyurko
7 * Copyright © 2003 Ian Molton <spyro@f2s.com>
8 *
9 * Modified: 2004, Oct Szabolcs Gyurko
10 */
11
12#ifndef __LINUX_POWER_SUPPLY_H__
13#define __LINUX_POWER_SUPPLY_H__
14
15#include <linux/device.h>
16#include <linux/workqueue.h>
17#include <linux/leds.h>
18#include <linux/rwsem.h>
19#include <linux/list.h>
20#include <linux/spinlock.h>
21#include <linux/notifier.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
36enum {
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/* What algorithm is the charger using? */
45enum power_supply_charge_type {
46 POWER_SUPPLY_CHARGE_TYPE_UNKNOWN = 0,
47 POWER_SUPPLY_CHARGE_TYPE_NONE,
48 POWER_SUPPLY_CHARGE_TYPE_TRICKLE, /* slow speed */
49 POWER_SUPPLY_CHARGE_TYPE_FAST, /* fast speed */
50 POWER_SUPPLY_CHARGE_TYPE_STANDARD, /* normal speed */
51 POWER_SUPPLY_CHARGE_TYPE_ADAPTIVE, /* dynamically adjusted speed */
52 POWER_SUPPLY_CHARGE_TYPE_CUSTOM, /* use CHARGE_CONTROL_* props */
53 POWER_SUPPLY_CHARGE_TYPE_LONGLIFE, /* slow speed, longer life */
54 POWER_SUPPLY_CHARGE_TYPE_BYPASS, /* bypassing the charger */
55};
56
57enum {
58 POWER_SUPPLY_HEALTH_UNKNOWN = 0,
59 POWER_SUPPLY_HEALTH_GOOD,
60 POWER_SUPPLY_HEALTH_OVERHEAT,
61 POWER_SUPPLY_HEALTH_DEAD,
62 POWER_SUPPLY_HEALTH_OVERVOLTAGE,
63 POWER_SUPPLY_HEALTH_UNDERVOLTAGE,
64 POWER_SUPPLY_HEALTH_UNSPEC_FAILURE,
65 POWER_SUPPLY_HEALTH_COLD,
66 POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE,
67 POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE,
68 POWER_SUPPLY_HEALTH_OVERCURRENT,
69 POWER_SUPPLY_HEALTH_CALIBRATION_REQUIRED,
70 POWER_SUPPLY_HEALTH_WARM,
71 POWER_SUPPLY_HEALTH_COOL,
72 POWER_SUPPLY_HEALTH_HOT,
73 POWER_SUPPLY_HEALTH_NO_BATTERY,
74 POWER_SUPPLY_HEALTH_BLOWN_FUSE,
75 POWER_SUPPLY_HEALTH_CELL_IMBALANCE,
76};
77
78enum {
79 POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
80 POWER_SUPPLY_TECHNOLOGY_NiMH,
81 POWER_SUPPLY_TECHNOLOGY_LION,
82 POWER_SUPPLY_TECHNOLOGY_LIPO,
83 POWER_SUPPLY_TECHNOLOGY_LiFe,
84 POWER_SUPPLY_TECHNOLOGY_NiCd,
85 POWER_SUPPLY_TECHNOLOGY_LiMn,
86};
87
88enum {
89 POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN = 0,
90 POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL,
91 POWER_SUPPLY_CAPACITY_LEVEL_LOW,
92 POWER_SUPPLY_CAPACITY_LEVEL_NORMAL,
93 POWER_SUPPLY_CAPACITY_LEVEL_HIGH,
94 POWER_SUPPLY_CAPACITY_LEVEL_FULL,
95};
96
97enum {
98 POWER_SUPPLY_SCOPE_UNKNOWN = 0,
99 POWER_SUPPLY_SCOPE_SYSTEM,
100 POWER_SUPPLY_SCOPE_DEVICE,
101};
102
103enum power_supply_property {
104 /* Properties of type `int' */
105 POWER_SUPPLY_PROP_STATUS = 0,
106 POWER_SUPPLY_PROP_CHARGE_TYPE,
107 POWER_SUPPLY_PROP_CHARGE_TYPES,
108 POWER_SUPPLY_PROP_HEALTH,
109 POWER_SUPPLY_PROP_PRESENT,
110 POWER_SUPPLY_PROP_ONLINE,
111 POWER_SUPPLY_PROP_AUTHENTIC,
112 POWER_SUPPLY_PROP_TECHNOLOGY,
113 POWER_SUPPLY_PROP_CYCLE_COUNT,
114 POWER_SUPPLY_PROP_VOLTAGE_MAX,
115 POWER_SUPPLY_PROP_VOLTAGE_MIN,
116 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
117 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
118 POWER_SUPPLY_PROP_VOLTAGE_NOW,
119 POWER_SUPPLY_PROP_VOLTAGE_AVG,
120 POWER_SUPPLY_PROP_VOLTAGE_OCV,
121 POWER_SUPPLY_PROP_VOLTAGE_BOOT,
122 POWER_SUPPLY_PROP_CURRENT_MAX,
123 POWER_SUPPLY_PROP_CURRENT_NOW,
124 POWER_SUPPLY_PROP_CURRENT_AVG,
125 POWER_SUPPLY_PROP_CURRENT_BOOT,
126 POWER_SUPPLY_PROP_POWER_NOW,
127 POWER_SUPPLY_PROP_POWER_AVG,
128 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
129 POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
130 POWER_SUPPLY_PROP_CHARGE_FULL,
131 POWER_SUPPLY_PROP_CHARGE_EMPTY,
132 POWER_SUPPLY_PROP_CHARGE_NOW,
133 POWER_SUPPLY_PROP_CHARGE_AVG,
134 POWER_SUPPLY_PROP_CHARGE_COUNTER,
135 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
136 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
137 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
138 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
139 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
140 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
141 POWER_SUPPLY_PROP_CHARGE_CONTROL_START_THRESHOLD, /* in percents! */
142 POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD, /* in percents! */
143 POWER_SUPPLY_PROP_CHARGE_BEHAVIOUR,
144 POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT,
145 POWER_SUPPLY_PROP_INPUT_VOLTAGE_LIMIT,
146 POWER_SUPPLY_PROP_INPUT_POWER_LIMIT,
147 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
148 POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
149 POWER_SUPPLY_PROP_ENERGY_FULL,
150 POWER_SUPPLY_PROP_ENERGY_EMPTY,
151 POWER_SUPPLY_PROP_ENERGY_NOW,
152 POWER_SUPPLY_PROP_ENERGY_AVG,
153 POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
154 POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
155 POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
156 POWER_SUPPLY_PROP_CAPACITY_ERROR_MARGIN, /* in percents! */
157 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
158 POWER_SUPPLY_PROP_TEMP,
159 POWER_SUPPLY_PROP_TEMP_MAX,
160 POWER_SUPPLY_PROP_TEMP_MIN,
161 POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
162 POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
163 POWER_SUPPLY_PROP_TEMP_AMBIENT,
164 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
165 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
166 POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
167 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
168 POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
169 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
170 POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
171 POWER_SUPPLY_PROP_USB_TYPE,
172 POWER_SUPPLY_PROP_SCOPE,
173 POWER_SUPPLY_PROP_PRECHARGE_CURRENT,
174 POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT,
175 POWER_SUPPLY_PROP_CALIBRATE,
176 POWER_SUPPLY_PROP_MANUFACTURE_YEAR,
177 POWER_SUPPLY_PROP_MANUFACTURE_MONTH,
178 POWER_SUPPLY_PROP_MANUFACTURE_DAY,
179 POWER_SUPPLY_PROP_INTERNAL_RESISTANCE,
180 POWER_SUPPLY_PROP_STATE_OF_HEALTH,
181 /* Properties of type `const char *' */
182 POWER_SUPPLY_PROP_MODEL_NAME,
183 POWER_SUPPLY_PROP_MANUFACTURER,
184 POWER_SUPPLY_PROP_SERIAL_NUMBER,
185};
186
187enum power_supply_type {
188 POWER_SUPPLY_TYPE_UNKNOWN = 0,
189 POWER_SUPPLY_TYPE_BATTERY,
190 POWER_SUPPLY_TYPE_UPS,
191 POWER_SUPPLY_TYPE_MAINS,
192 POWER_SUPPLY_TYPE_USB, /* Standard Downstream Port */
193 POWER_SUPPLY_TYPE_USB_DCP, /* Dedicated Charging Port */
194 POWER_SUPPLY_TYPE_USB_CDP, /* Charging Downstream Port */
195 POWER_SUPPLY_TYPE_USB_ACA, /* Accessory Charger Adapters */
196 POWER_SUPPLY_TYPE_USB_TYPE_C, /* Type C Port */
197 POWER_SUPPLY_TYPE_USB_PD, /* Power Delivery Port */
198 POWER_SUPPLY_TYPE_USB_PD_DRP, /* PD Dual Role Port */
199 POWER_SUPPLY_TYPE_APPLE_BRICK_ID, /* Apple Charging Method */
200 POWER_SUPPLY_TYPE_WIRELESS, /* Wireless */
201};
202
203enum power_supply_usb_type {
204 POWER_SUPPLY_USB_TYPE_UNKNOWN = 0,
205 POWER_SUPPLY_USB_TYPE_SDP, /* Standard Downstream Port */
206 POWER_SUPPLY_USB_TYPE_DCP, /* Dedicated Charging Port */
207 POWER_SUPPLY_USB_TYPE_CDP, /* Charging Downstream Port */
208 POWER_SUPPLY_USB_TYPE_ACA, /* Accessory Charger Adapters */
209 POWER_SUPPLY_USB_TYPE_C, /* Type C Port */
210 POWER_SUPPLY_USB_TYPE_PD, /* Power Delivery Port */
211 POWER_SUPPLY_USB_TYPE_PD_DRP, /* PD Dual Role Port */
212 POWER_SUPPLY_USB_TYPE_PD_PPS, /* PD Programmable Power Supply */
213 /* PD Standard Power Range Adjustable Voltage Supply */
214 POWER_SUPPLY_USB_TYPE_PD_SPR_AVS,
215 POWER_SUPPLY_USB_TYPE_PD_PPS_SPR_AVS, /* Supports both PD PPS + SPR AVS */
216 POWER_SUPPLY_USB_TYPE_APPLE_BRICK_ID, /* Apple Charging Method */
217};
218
219enum power_supply_charge_behaviour {
220 POWER_SUPPLY_CHARGE_BEHAVIOUR_AUTO = 0,
221 POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE,
222 POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE_AWAKE,
223 POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE,
224};
225
226enum power_supply_notifier_events {
227 PSY_EVENT_PROP_CHANGED,
228};
229
230union power_supply_propval {
231 int intval;
232 const char *strval;
233};
234
235struct device_node;
236struct power_supply;
237
238/* Run-time specific power supply configuration */
239struct power_supply_config {
240 struct fwnode_handle *fwnode;
241
242 /* Driver private data */
243 void *drv_data;
244
245 /* Device specific sysfs attributes */
246 const struct attribute_group **attr_grp;
247
248 char **supplied_to;
249 size_t num_supplicants;
250
251 bool no_wakeup_source;
252};
253
254/* Description of power supply */
255struct power_supply_desc {
256 const char *name;
257 enum power_supply_type type;
258 u8 charge_behaviours;
259 u32 charge_types;
260 u32 usb_types;
261 const enum power_supply_property *properties;
262 size_t num_properties;
263
264 /*
265 * Functions for drivers implementing power supply class.
266 * These shouldn't be called directly by other drivers for accessing
267 * this power supply. Instead use power_supply_*() functions (for
268 * example power_supply_get_property()).
269 */
270 int (*get_property)(struct power_supply *psy,
271 enum power_supply_property psp,
272 union power_supply_propval *val);
273 int (*set_property)(struct power_supply *psy,
274 enum power_supply_property psp,
275 const union power_supply_propval *val);
276 /*
277 * property_is_writeable() will be called during registration
278 * of power supply. If this happens during device probe then it must
279 * not access internal data of device (because probe did not end).
280 */
281 int (*property_is_writeable)(struct power_supply *psy,
282 enum power_supply_property psp);
283 void (*external_power_changed)(struct power_supply *psy);
284
285 /*
286 * Set if thermal zone should not be created for this power supply.
287 * For example for virtual supplies forwarding calls to actual
288 * sensors or other supplies.
289 */
290 bool no_thermal;
291 /* For APM emulation, think legacy userspace. */
292 int use_for_apm;
293};
294
295struct power_supply_ext {
296 const char *const name;
297 u8 charge_behaviours;
298 u32 charge_types;
299 const enum power_supply_property *properties;
300 size_t num_properties;
301
302 int (*get_property)(struct power_supply *psy,
303 const struct power_supply_ext *ext,
304 void *data,
305 enum power_supply_property psp,
306 union power_supply_propval *val);
307 int (*set_property)(struct power_supply *psy,
308 const struct power_supply_ext *ext,
309 void *data,
310 enum power_supply_property psp,
311 const union power_supply_propval *val);
312 int (*property_is_writeable)(struct power_supply *psy,
313 const struct power_supply_ext *ext,
314 void *data,
315 enum power_supply_property psp);
316};
317
318struct power_supply {
319 const struct power_supply_desc *desc;
320
321 char **supplied_to;
322 size_t num_supplicants;
323
324 char **supplied_from;
325 size_t num_supplies;
326
327 /* Driver private data */
328 void *drv_data;
329
330 /* private */
331 struct device dev;
332 struct work_struct changed_work;
333 struct delayed_work deferred_register_work;
334 spinlock_t changed_lock;
335 bool changed;
336 bool update_groups;
337 bool initialized;
338 bool removing;
339 atomic_t use_cnt;
340 struct power_supply_battery_info *battery_info;
341 struct rw_semaphore extensions_sem; /* protects "extensions" */
342 struct list_head extensions;
343#ifdef CONFIG_THERMAL
344 struct thermal_zone_device *tzd;
345 struct thermal_cooling_device *tcd;
346#endif
347
348#ifdef CONFIG_LEDS_TRIGGERS
349 struct led_trigger *trig;
350 struct led_trigger *charging_trig;
351 struct led_trigger *full_trig;
352 struct led_trigger *charging_blink_full_solid_trig;
353 struct led_trigger *charging_orange_full_green_trig;
354#endif
355};
356
357#define dev_to_psy(__dev) container_of_const(__dev, struct power_supply, dev)
358
359/*
360 * This is recommended structure to specify static power supply parameters.
361 * Generic one, parametrizable for different power supplies. Power supply
362 * class itself does not use it, but that's what implementing most platform
363 * drivers, should try reuse for consistency.
364 */
365
366struct power_supply_info {
367 const char *name;
368 int technology;
369 int voltage_max_design;
370 int voltage_min_design;
371 int charge_full_design;
372 int charge_empty_design;
373 int energy_full_design;
374 int energy_empty_design;
375 int use_for_apm;
376};
377
378struct power_supply_battery_ocv_table {
379 int ocv; /* microVolts */
380 int capacity; /* percent */
381};
382
383struct power_supply_resistance_temp_table {
384 int temp; /* celsius */
385 int resistance; /* internal resistance percent */
386};
387
388struct power_supply_vbat_ri_table {
389 int vbat_uv; /* Battery voltage in microvolt */
390 int ri_uohm; /* Internal resistance in microohm */
391};
392
393/**
394 * struct power_supply_maintenance_charge_table - setting for maintenace charging
395 * @charge_current_max_ua: maintenance charging current that is used to keep
396 * the charge of the battery full as current is consumed after full charging.
397 * The corresponding charge_voltage_max_uv is used as a safeguard: when we
398 * reach this voltage the maintenance charging current is turned off. It is
399 * turned back on if we fall below this voltage.
400 * @charge_voltage_max_uv: maintenance charging voltage that is usually a bit
401 * lower than the constant_charge_voltage_max_uv. We can apply this settings
402 * charge_current_max_ua until we get back up to this voltage.
403 * @safety_timer_minutes: maintenance charging safety timer, with an expiry
404 * time in minutes. We will only use maintenance charging in this setting
405 * for a certain amount of time, then we will first move to the next
406 * maintenance charge current and voltage pair in respective array and wait
407 * for the next safety timer timeout, or, if we reached the last maintencance
408 * charging setting, disable charging until we reach
409 * charge_restart_voltage_uv and restart ordinary CC/CV charging from there.
410 * These timers should be chosen to align with the typical discharge curve
411 * for the battery.
412 *
413 * Ordinary CC/CV charging will stop charging when the charge current goes
414 * below charge_term_current_ua, and then restart it (if the device is still
415 * plugged into the charger) at charge_restart_voltage_uv. This happens in most
416 * consumer products because the power usage while connected to a charger is
417 * not zero, and devices are not manufactured to draw power directly from the
418 * charger: instead they will at all times dissipate the battery a little, like
419 * the power used in standby mode. This will over time give a charge graph
420 * such as this:
421 *
422 * Energy
423 * ^ ... ... ... ... ... ... ...
424 * | . . . . . . . . . . . . .
425 * | .. . .. . .. . .. . .. . .. . ..
426 * |. .. .. .. .. .. ..
427 * +-------------------------------------------------------------------> t
428 *
429 * Practically this means that the Li-ions are wandering back and forth in the
430 * battery and this causes degeneration of the battery anode and cathode.
431 * To prolong the life of the battery, maintenance charging is applied after
432 * reaching charge_term_current_ua to hold up the charge in the battery while
433 * consuming power, thus lowering the wear on the battery:
434 *
435 * Energy
436 * ^ .......................................
437 * | . ......................
438 * | ..
439 * |.
440 * +-------------------------------------------------------------------> t
441 *
442 * Maintenance charging uses the voltages from this table: a table of settings
443 * is traversed using a slightly lower current and voltage than what is used for
444 * CC/CV charging. The maintenance charging will for safety reasons not go on
445 * indefinately: we lower the current and voltage with successive maintenance
446 * settings, then disable charging completely after we reach the last one,
447 * and after that we do not restart charging until we reach
448 * charge_restart_voltage_uv (see struct power_supply_battery_info) and restart
449 * ordinary CC/CV charging from there.
450 *
451 * As an example, a Samsung EB425161LA Lithium-Ion battery is CC/CV charged
452 * at 900mA to 4340mV, then maintenance charged at 600mA and 4150mV for up to
453 * 60 hours, then maintenance charged at 600mA and 4100mV for up to 200 hours.
454 * After this the charge cycle is restarted waiting for
455 * charge_restart_voltage_uv.
456 *
457 * For most mobile electronics this type of maintenance charging is enough for
458 * the user to disconnect the device and make use of it before both maintenance
459 * charging cycles are complete, if the current and voltage has been chosen
460 * appropriately. These need to be determined from battery discharge curves
461 * and expected standby current.
462 *
463 * If the voltage anyway drops to charge_restart_voltage_uv during maintenance
464 * charging, ordinary CC/CV charging is restarted. This can happen if the
465 * device is e.g. actively used during charging, so more current is drawn than
466 * the expected stand-by current. Also overvoltage protection will be applied
467 * as usual.
468 */
469struct power_supply_maintenance_charge_table {
470 int charge_current_max_ua;
471 int charge_voltage_max_uv;
472 int charge_safety_timer_minutes;
473};
474
475#define POWER_SUPPLY_OCV_TEMP_MAX 20
476
477/**
478 * struct power_supply_battery_info - information about batteries
479 * @technology: from the POWER_SUPPLY_TECHNOLOGY_* enum
480 * @energy_full_design_uwh: energy content when fully charged in microwatt
481 * hours
482 * @charge_full_design_uah: charge content when fully charged in microampere
483 * hours
484 * @voltage_min_design_uv: minimum voltage across the poles when the battery
485 * is at minimum voltage level in microvolts. If the voltage drops below this
486 * level the battery will need precharging when using CC/CV charging.
487 * @voltage_max_design_uv: voltage across the poles when the battery is fully
488 * charged in microvolts. This is the "nominal voltage" i.e. the voltage
489 * printed on the label of the battery.
490 * @tricklecharge_current_ua: the tricklecharge current used when trickle
491 * charging the battery in microamperes. This is the charging phase when the
492 * battery is completely empty and we need to carefully trickle in some
493 * charge until we reach the precharging voltage.
494 * @precharge_current_ua: current to use in the precharge phase in microamperes,
495 * the precharge rate is limited by limiting the current to this value.
496 * @precharge_voltage_max_uv: the maximum voltage allowed when precharging in
497 * microvolts. When we pass this voltage we will nominally switch over to the
498 * CC (constant current) charging phase defined by constant_charge_current_ua
499 * and constant_charge_voltage_max_uv.
500 * @charge_term_current_ua: when the current in the CV (constant voltage)
501 * charging phase drops below this value in microamperes the charging will
502 * terminate completely and not restart until the voltage over the battery
503 * poles reach charge_restart_voltage_uv unless we use maintenance charging.
504 * @charge_restart_voltage_uv: when the battery has been fully charged by
505 * CC/CV charging and charging has been disabled, and the voltage subsequently
506 * drops below this value in microvolts, the charging will be restarted
507 * (typically using CV charging).
508 * @overvoltage_limit_uv: If the voltage exceeds the nominal voltage
509 * voltage_max_design_uv and we reach this voltage level, all charging must
510 * stop and emergency procedures take place, such as shutting down the system
511 * in some cases.
512 * @constant_charge_current_max_ua: current in microamperes to use in the CC
513 * (constant current) charging phase. The charging rate is limited
514 * by this current. This is the main charging phase and as the current is
515 * constant into the battery the voltage slowly ascends to
516 * constant_charge_voltage_max_uv.
517 * @constant_charge_voltage_max_uv: voltage in microvolts signifying the end of
518 * the CC (constant current) charging phase and the beginning of the CV
519 * (constant voltage) charging phase.
520 * @maintenance_charge: an array of maintenance charging settings to be used
521 * after the main CC/CV charging phase is complete.
522 * @maintenance_charge_size: the number of maintenance charging settings in
523 * maintenance_charge.
524 * @alert_low_temp_charge_current_ua: The charging current to use if the battery
525 * enters low alert temperature, i.e. if the internal temperature is between
526 * temp_alert_min and temp_min. No matter the charging phase, this
527 * and alert_high_temp_charge_voltage_uv will be applied.
528 * @alert_low_temp_charge_voltage_uv: Same as alert_low_temp_charge_current_ua,
529 * but for the charging voltage.
530 * @alert_high_temp_charge_current_ua: The charging current to use if the
531 * battery enters high alert temperature, i.e. if the internal temperature is
532 * between temp_alert_max and temp_max. No matter the charging phase, this
533 * and alert_high_temp_charge_voltage_uv will be applied, usually lowering
534 * the charging current as an evasive manouver.
535 * @alert_high_temp_charge_voltage_uv: Same as
536 * alert_high_temp_charge_current_ua, but for the charging voltage.
537 * @factory_internal_resistance_uohm: the internal resistance of the battery
538 * at fabrication time, expressed in microohms. This resistance will vary
539 * depending on the lifetime and charge of the battery, so this is just a
540 * nominal ballpark figure. This internal resistance is given for the state
541 * when the battery is discharging.
542 * @factory_internal_resistance_charging_uohm: the internal resistance of the
543 * battery at fabrication time while charging, expressed in microohms.
544 * The charging process will affect the internal resistance of the battery
545 * so this value provides a better resistance under these circumstances.
546 * This resistance will vary depending on the lifetime and charge of the
547 * battery, so this is just a nominal ballpark figure.
548 * @ocv_temp: array indicating the open circuit voltage (OCV) capacity
549 * temperature indices. This is an array of temperatures in degrees Celsius
550 * indicating which capacity table to use for a certain temperature, since
551 * the capacity for reasons of chemistry will be different at different
552 * temperatures. Determining capacity is a multivariate problem and the
553 * temperature is the first variable we determine.
554 * @temp_ambient_alert_min: the battery will go outside of operating conditions
555 * when the ambient temperature goes below this temperature in degrees
556 * Celsius.
557 * @temp_ambient_alert_max: the battery will go outside of operating conditions
558 * when the ambient temperature goes above this temperature in degrees
559 * Celsius.
560 * @temp_alert_min: the battery should issue an alert if the internal
561 * temperature goes below this temperature in degrees Celsius.
562 * @temp_alert_max: the battery should issue an alert if the internal
563 * temperature goes above this temperature in degrees Celsius.
564 * @temp_min: the battery will go outside of operating conditions when
565 * the internal temperature goes below this temperature in degrees Celsius.
566 * Normally this means the system should shut down.
567 * @temp_max: the battery will go outside of operating conditions when
568 * the internal temperature goes above this temperature in degrees Celsius.
569 * Normally this means the system should shut down.
570 * @ocv_table: for each entry in ocv_temp there is a corresponding entry in
571 * ocv_table and a size for each entry in ocv_table_size. These arrays
572 * determine the capacity in percent in relation to the voltage in microvolts
573 * at the indexed temperature.
574 * @ocv_table_size: for each entry in ocv_temp this array is giving the size of
575 * each entry in the array of capacity arrays in ocv_table.
576 * @resist_table: this is a table that correlates a battery temperature to the
577 * expected internal resistance at this temperature. The resistance is given
578 * as a percentage of factory_internal_resistance_uohm. Knowing the
579 * resistance of the battery is usually necessary for calculating the open
580 * circuit voltage (OCV) that is then used with the ocv_table to calculate
581 * the capacity of the battery. The resist_table must be ordered descending
582 * by temperature: highest temperature with lowest resistance first, lowest
583 * temperature with highest resistance last.
584 * @resist_table_size: the number of items in the resist_table.
585 * @vbat2ri_discharging: this is a table that correlates Battery voltage (VBAT)
586 * to internal resistance (Ri). The resistance is given in microohm for the
587 * corresponding voltage in microvolts. The internal resistance is used to
588 * determine the open circuit voltage so that we can determine the capacity
589 * of the battery. These voltages to resistance tables apply when the battery
590 * is discharging. The table must be ordered descending by voltage: highest
591 * voltage first.
592 * @vbat2ri_discharging_size: the number of items in the vbat2ri_discharging
593 * table.
594 * @vbat2ri_charging: same function as vbat2ri_discharging but for the state
595 * when the battery is charging. Being under charge changes the battery's
596 * internal resistance characteristics so a separate table is needed.*
597 * The table must be ordered descending by voltage: highest voltage first.
598 * @vbat2ri_charging_size: the number of items in the vbat2ri_charging
599 * table.
600 * @bti_resistance_ohm: The Battery Type Indicator (BIT) nominal resistance
601 * in ohms for this battery, if an identification resistor is mounted
602 * between a third battery terminal and ground. This scheme is used by a lot
603 * of mobile device batteries.
604 * @bti_resistance_tolerance: The tolerance in percent of the BTI resistance,
605 * for example 10 for +/- 10%, if the bti_resistance is set to 7000 and the
606 * tolerance is 10% we will detect a proper battery if the BTI resistance
607 * is between 6300 and 7700 Ohm.
608 *
609 * This is the recommended struct to manage static battery parameters,
610 * populated by power_supply_get_battery_info(). Most platform drivers should
611 * use these for consistency.
612 *
613 * Its field names must correspond to elements in enum power_supply_property.
614 * The default field value is -EINVAL or NULL for pointers.
615 *
616 * CC/CV CHARGING:
617 *
618 * The charging parameters here assume a CC/CV charging scheme. This method
619 * is most common with Lithium Ion batteries (other methods are possible) and
620 * looks as follows:
621 *
622 * ^ Battery voltage
623 * | --- overvoltage_limit_uv
624 * |
625 * | ...................................................
626 * | .. constant_charge_voltage_max_uv
627 * | ..
628 * | .
629 * | .
630 * | .
631 * | .
632 * | .
633 * | .. precharge_voltage_max_uv
634 * | ..
635 * |. (trickle charging)
636 * +------------------------------------------------------------------> time
637 *
638 * ^ Current into the battery
639 * |
640 * | ............. constant_charge_current_max_ua
641 * | . .
642 * | . .
643 * | . .
644 * | . .
645 * | . ..
646 * | . ....
647 * | . .....
648 * | ... precharge_current_ua ....... charge_term_current_ua
649 * | . .
650 * | . .
651 * |.... tricklecharge_current_ua .
652 * | .
653 * +-----------------------------------------------------------------> time
654 *
655 * These diagrams are synchronized on time and the voltage and current
656 * follow each other.
657 *
658 * With CC/CV charging commence over time like this for an empty battery:
659 *
660 * 1. When the battery is completely empty it may need to be charged with
661 * an especially small current so that electrons just "trickle in",
662 * this is the tricklecharge_current_ua.
663 *
664 * 2. Next a small initial pre-charge current (precharge_current_ua)
665 * is applied if the voltage is below precharge_voltage_max_uv until we
666 * reach precharge_voltage_max_uv. CAUTION: in some texts this is referred
667 * to as "trickle charging" but the use in the Linux kernel is different
668 * see below!
669 *
670 * 3. Then the main charging current is applied, which is called the constant
671 * current (CC) phase. A current regulator is set up to allow
672 * constant_charge_current_max_ua of current to flow into the battery.
673 * The chemical reaction in the battery will make the voltage go up as
674 * charge goes into the battery. This current is applied until we reach
675 * the constant_charge_voltage_max_uv voltage.
676 *
677 * 4. At this voltage we switch over to the constant voltage (CV) phase. This
678 * means we allow current to go into the battery, but we keep the voltage
679 * fixed. This current will continue to charge the battery while keeping
680 * the voltage the same. A chemical reaction in the battery goes on
681 * storing energy without affecting the voltage. Over time the current
682 * will slowly drop and when we reach charge_term_current_ua we will
683 * end the constant voltage phase.
684 *
685 * After this the battery is fully charged, and if we do not support maintenance
686 * charging, the charging will not restart until power dissipation makes the
687 * voltage fall so that we reach charge_restart_voltage_uv and at this point
688 * we restart charging at the appropriate phase, usually this will be inside
689 * the CV phase.
690 *
691 * If we support maintenance charging the voltage is however kept high after
692 * the CV phase with a very low current. This is meant to let the same charge
693 * go in for usage while the charger is still connected, mainly for
694 * dissipation for the power consuming entity while connected to the
695 * charger.
696 *
697 * All charging MUST terminate if the overvoltage_limit_uv is ever reached.
698 * Overcharging Lithium Ion cells can be DANGEROUS and lead to fire or
699 * explosions.
700 *
701 * DETERMINING BATTERY CAPACITY:
702 *
703 * Several members of the struct deal with trying to determine the remaining
704 * capacity in the battery, usually as a percentage of charge. In practice
705 * many chargers uses a so-called fuel gauge or coloumb counter that measure
706 * how much charge goes into the battery and how much goes out (+/- leak
707 * consumption). This does not help if we do not know how much capacity the
708 * battery has to begin with, such as when it is first used or was taken out
709 * and charged in a separate charger. Therefore many capacity algorithms use
710 * the open circuit voltage with a look-up table to determine the rough
711 * capacity of the battery. The open circuit voltage can be conceptualized
712 * with an ideal voltage source (V) in series with an internal resistance (Ri)
713 * like this:
714 *
715 * +-------> IBAT >----------------+
716 * | ^ |
717 * [ ] Ri | |
718 * | | VBAT |
719 * o <---------- | |
720 * +| ^ | [ ] Rload
721 * .---. | | |
722 * | V | | OCV | |
723 * '---' | | |
724 * | | | |
725 * GND +-------------------------------+
726 *
727 * If we disconnect the load (here simplified as a fixed resistance Rload)
728 * and measure VBAT with a infinite impedance voltage meter we will get
729 * VBAT = OCV and this assumption is sometimes made even under load, assuming
730 * Rload is insignificant. However this will be of dubious quality because the
731 * load is rarely that small and Ri is strongly nonlinear depending on
732 * temperature and how much capacity is left in the battery due to the
733 * chemistry involved.
734 *
735 * In many practical applications we cannot just disconnect the battery from
736 * the load, so instead we often try to measure the instantaneous IBAT (the
737 * current out from the battery), estimate the Ri and thus calculate the
738 * voltage drop over Ri and compensate like this:
739 *
740 * OCV = VBAT - (IBAT * Ri)
741 *
742 * The tables vbat2ri_discharging and vbat2ri_charging are used to determine
743 * (by interpolation) the Ri from the VBAT under load. These curves are highly
744 * nonlinear and may need many datapoints but can be found in datasheets for
745 * some batteries. This gives the compensated open circuit voltage (OCV) for
746 * the battery even under load. Using this method will also compensate for
747 * temperature changes in the environment: this will also make the internal
748 * resistance change, and it will affect the VBAT under load, so correlating
749 * VBAT to Ri takes both remaining capacity and temperature into consideration.
750 *
751 * Alternatively a manufacturer can specify how the capacity of the battery
752 * is dependent on the battery temperature which is the main factor affecting
753 * Ri. As we know all checmical reactions are faster when it is warm and slower
754 * when it is cold. You can put in 1500mAh and only get 800mAh out before the
755 * voltage drops too low for example. This effect is also highly nonlinear and
756 * the purpose of the table resist_table: this will take a temperature and
757 * tell us how big percentage of Ri the specified temperature correlates to.
758 * Usually we have 100% of the factory_internal_resistance_uohm at 25 degrees
759 * Celsius.
760 *
761 * The power supply class itself doesn't use this struct as of now.
762 */
763
764struct power_supply_battery_info {
765 unsigned int technology;
766 int energy_full_design_uwh;
767 int charge_full_design_uah;
768 int voltage_min_design_uv;
769 int voltage_max_design_uv;
770 int tricklecharge_current_ua;
771 int precharge_current_ua;
772 int precharge_voltage_max_uv;
773 int charge_term_current_ua;
774 int charge_restart_voltage_uv;
775 int overvoltage_limit_uv;
776 int constant_charge_current_max_ua;
777 int constant_charge_voltage_max_uv;
778 const struct power_supply_maintenance_charge_table *maintenance_charge;
779 int maintenance_charge_size;
780 int alert_low_temp_charge_current_ua;
781 int alert_low_temp_charge_voltage_uv;
782 int alert_high_temp_charge_current_ua;
783 int alert_high_temp_charge_voltage_uv;
784 int factory_internal_resistance_uohm;
785 int factory_internal_resistance_charging_uohm;
786 int ocv_temp[POWER_SUPPLY_OCV_TEMP_MAX];
787 int temp_ambient_alert_min;
788 int temp_ambient_alert_max;
789 int temp_alert_min;
790 int temp_alert_max;
791 int temp_min;
792 int temp_max;
793 const struct power_supply_battery_ocv_table *ocv_table[POWER_SUPPLY_OCV_TEMP_MAX];
794 int ocv_table_size[POWER_SUPPLY_OCV_TEMP_MAX];
795 const struct power_supply_resistance_temp_table *resist_table;
796 int resist_table_size;
797 const struct power_supply_vbat_ri_table *vbat2ri_discharging;
798 int vbat2ri_discharging_size;
799 const struct power_supply_vbat_ri_table *vbat2ri_charging;
800 int vbat2ri_charging_size;
801 int bti_resistance_ohm;
802 int bti_resistance_tolerance;
803};
804
805extern int power_supply_reg_notifier(struct notifier_block *nb);
806extern void power_supply_unreg_notifier(struct notifier_block *nb);
807#if IS_ENABLED(CONFIG_POWER_SUPPLY)
808extern struct power_supply *power_supply_get_by_name(const char *name);
809extern void power_supply_put(struct power_supply *psy);
810#else
811static inline void power_supply_put(struct power_supply *psy) {}
812static inline struct power_supply *power_supply_get_by_name(const char *name)
813{ return NULL; }
814#endif
815extern struct power_supply *power_supply_get_by_reference(struct fwnode_handle *fwnode,
816 const char *property);
817extern struct power_supply *devm_power_supply_get_by_reference(
818 struct device *dev, const char *property);
819
820extern const enum power_supply_property power_supply_battery_info_properties[];
821extern const size_t power_supply_battery_info_properties_size;
822extern int power_supply_get_battery_info(struct power_supply *psy,
823 struct power_supply_battery_info **info_out);
824extern void power_supply_put_battery_info(struct power_supply *psy,
825 struct power_supply_battery_info *info);
826extern bool power_supply_battery_info_has_prop(struct power_supply_battery_info *info,
827 enum power_supply_property psp);
828extern int power_supply_battery_info_get_prop(struct power_supply_battery_info *info,
829 enum power_supply_property psp,
830 union power_supply_propval *val);
831extern int power_supply_ocv2cap_simple(const struct power_supply_battery_ocv_table *table,
832 int table_len, int ocv);
833extern const struct power_supply_battery_ocv_table *
834power_supply_find_ocv2cap_table(struct power_supply_battery_info *info,
835 int temp, int *table_len);
836extern int power_supply_batinfo_ocv2cap(struct power_supply_battery_info *info,
837 int ocv, int temp);
838extern int
839power_supply_temp2resist_simple(const struct power_supply_resistance_temp_table *table,
840 int table_len, int temp);
841extern int power_supply_vbat2ri(struct power_supply_battery_info *info,
842 int vbat_uv, bool charging);
843extern const struct power_supply_maintenance_charge_table *
844power_supply_get_maintenance_charging_setting(struct power_supply_battery_info *info, int index);
845extern bool power_supply_battery_bti_in_range(struct power_supply_battery_info *info,
846 int resistance);
847extern void power_supply_changed(struct power_supply *psy);
848extern int power_supply_am_i_supplied(struct power_supply *psy);
849int power_supply_get_property_from_supplier(struct power_supply *psy,
850 enum power_supply_property psp,
851 union power_supply_propval *val);
852
853static inline bool
854power_supply_supports_maintenance_charging(struct power_supply_battery_info *info)
855{
856 const struct power_supply_maintenance_charge_table *mt;
857
858 mt = power_supply_get_maintenance_charging_setting(info, 0);
859
860 return (mt != NULL);
861}
862
863static inline bool
864power_supply_supports_vbat2ri(struct power_supply_battery_info *info)
865{
866 return ((info->vbat2ri_discharging != NULL) &&
867 info->vbat2ri_discharging_size > 0);
868}
869
870static inline bool
871power_supply_supports_temp2ri(struct power_supply_battery_info *info)
872{
873 return ((info->resist_table != NULL) &&
874 info->resist_table_size > 0);
875}
876
877#ifdef CONFIG_POWER_SUPPLY
878extern int power_supply_is_system_supplied(void);
879#else
880static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
881#endif
882
883extern int power_supply_get_property(struct power_supply *psy,
884 enum power_supply_property psp,
885 union power_supply_propval *val);
886int power_supply_get_property_direct(struct power_supply *psy, enum power_supply_property psp,
887 union power_supply_propval *val);
888#if IS_ENABLED(CONFIG_POWER_SUPPLY)
889extern int power_supply_set_property(struct power_supply *psy,
890 enum power_supply_property psp,
891 const union power_supply_propval *val);
892int power_supply_set_property_direct(struct power_supply *psy, enum power_supply_property psp,
893 const union power_supply_propval *val);
894#else
895static inline int power_supply_set_property(struct power_supply *psy,
896 enum power_supply_property psp,
897 const union power_supply_propval *val)
898{ return 0; }
899static inline int power_supply_set_property_direct(struct power_supply *psy,
900 enum power_supply_property psp,
901 const union power_supply_propval *val)
902{ return 0; }
903#endif
904extern void power_supply_external_power_changed(struct power_supply *psy);
905
906extern struct power_supply *__must_check
907power_supply_register(struct device *parent,
908 const struct power_supply_desc *desc,
909 const struct power_supply_config *cfg);
910extern struct power_supply *__must_check
911devm_power_supply_register(struct device *parent,
912 const struct power_supply_desc *desc,
913 const struct power_supply_config *cfg);
914extern void power_supply_unregister(struct power_supply *psy);
915extern int power_supply_powers(struct power_supply *psy, struct device *dev);
916
917extern int __must_check
918power_supply_register_extension(struct power_supply *psy,
919 const struct power_supply_ext *ext,
920 struct device *dev,
921 void *data);
922extern void power_supply_unregister_extension(struct power_supply *psy,
923 const struct power_supply_ext *ext);
924
925#define to_power_supply(device) container_of(device, struct power_supply, dev)
926
927extern void *power_supply_get_drvdata(struct power_supply *psy);
928extern int power_supply_for_each_psy(void *data, int (*fn)(struct power_supply *psy, void *data));
929
930static inline bool power_supply_is_amp_property(enum power_supply_property psp)
931{
932 switch (psp) {
933 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
934 case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
935 case POWER_SUPPLY_PROP_CHARGE_FULL:
936 case POWER_SUPPLY_PROP_CHARGE_EMPTY:
937 case POWER_SUPPLY_PROP_CHARGE_NOW:
938 case POWER_SUPPLY_PROP_CHARGE_AVG:
939 case POWER_SUPPLY_PROP_CHARGE_COUNTER:
940 case POWER_SUPPLY_PROP_PRECHARGE_CURRENT:
941 case POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT:
942 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
943 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
944 case POWER_SUPPLY_PROP_CURRENT_MAX:
945 case POWER_SUPPLY_PROP_CURRENT_NOW:
946 case POWER_SUPPLY_PROP_CURRENT_AVG:
947 case POWER_SUPPLY_PROP_CURRENT_BOOT:
948 return true;
949 default:
950 break;
951 }
952
953 return false;
954}
955
956static inline bool power_supply_is_watt_property(enum power_supply_property psp)
957{
958 switch (psp) {
959 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
960 case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
961 case POWER_SUPPLY_PROP_ENERGY_FULL:
962 case POWER_SUPPLY_PROP_ENERGY_EMPTY:
963 case POWER_SUPPLY_PROP_ENERGY_NOW:
964 case POWER_SUPPLY_PROP_ENERGY_AVG:
965 case POWER_SUPPLY_PROP_VOLTAGE_MAX:
966 case POWER_SUPPLY_PROP_VOLTAGE_MIN:
967 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
968 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
969 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
970 case POWER_SUPPLY_PROP_VOLTAGE_AVG:
971 case POWER_SUPPLY_PROP_VOLTAGE_OCV:
972 case POWER_SUPPLY_PROP_VOLTAGE_BOOT:
973 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
974 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
975 case POWER_SUPPLY_PROP_POWER_NOW:
976 return true;
977 default:
978 break;
979 }
980
981 return false;
982}
983
984#ifdef CONFIG_SYSFS
985ssize_t power_supply_charge_behaviour_show(struct device *dev,
986 unsigned int available_behaviours,
987 enum power_supply_charge_behaviour behaviour,
988 char *buf);
989
990int power_supply_charge_behaviour_parse(unsigned int available_behaviours, const char *buf);
991ssize_t power_supply_charge_types_show(struct device *dev,
992 unsigned int available_types,
993 enum power_supply_charge_type current_type,
994 char *buf);
995int power_supply_charge_types_parse(unsigned int available_types, const char *buf);
996#else
997static inline
998ssize_t power_supply_charge_behaviour_show(struct device *dev,
999 unsigned int available_behaviours,
1000 enum power_supply_charge_behaviour behaviour,
1001 char *buf)
1002{
1003 return -EOPNOTSUPP;
1004}
1005
1006static inline int power_supply_charge_behaviour_parse(unsigned int available_behaviours,
1007 const char *buf)
1008{
1009 return -EOPNOTSUPP;
1010}
1011
1012static inline
1013ssize_t power_supply_charge_types_show(struct device *dev,
1014 unsigned int available_types,
1015 enum power_supply_charge_type current_type,
1016 char *buf)
1017{
1018 return -EOPNOTSUPP;
1019}
1020
1021static inline int power_supply_charge_types_parse(unsigned int available_types, const char *buf)
1022{
1023 return -EOPNOTSUPP;
1024}
1025#endif
1026
1027#endif /* __LINUX_POWER_SUPPLY_H__ */