github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-11-07 06:17:02 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

docs: power: supply: fix power_supply_class.rst status, health and time_to

Browse Source 
Correct STATUS/HEALTH references to POWER_SUPPLY_* enums in
include/linux/power_supply.h instead of the nonexistent battery.h
macros. Document TIME_TO_{EMPTY,FULL}_{NOW,AVG}, fix the "operatable"
typo, and note that MODEL_NAME and MANUFACTURER already exist.

Signed-off-by: Iván Ezequiel Rodriguez <ivanrwcm25@gmail.com>
Link: https://patch.msgid.link/20260831155339.181487-4-ivanrwcm25@gmail.com
Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com>
This commit is contained in:
Iván Ezequiel Rodriguez 2026-08-31 12:53:37 -03:00 committed by Sebastian Reichel
parent c996fa11ce
commit 420a1e2763
1 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
Documentation/power/power_supply_class.rst
View File

@ -82,7 +82,8 @@ _NOW
STATUS
this attribute represents operating status (charging, full,
discharging (i.e., powering a load), etc.). This corresponds to
`BATTERY_STATUS_*` values, as defined in battery.h.
`POWER_SUPPLY_STATUS_*` values, as defined in
include/linux/power_supply.h.
CHARGE_TYPE
batteries can typically charge at different rates.
@ -95,8 +96,8 @@ AUTHENTIC
to the platform is authentic(1) or non-authentic(0).
HEALTH
represents health of the battery. Values corresponds to
POWER_SUPPLY_HEALTH_*, defined in battery.h.
represents health of the battery. Values correspond to
POWER_SUPPLY_HEALTH_*, defined in include/linux/power_supply.h.
VOLTAGE_OCV
open circuit voltage of the battery.
@ -202,16 +203,17 @@ TEMP_AMBIENT_ALERT_MIN
TEMP_AMBIENT_ALERT_MAX
maximum ambient temperature alert.
TEMP_MIN
minimum operatable temperature
minimum operable temperature
TEMP_MAX
maximum operatable temperature
maximum operable temperature
TIME_TO_EMPTY
TIME_TO_EMPTY_NOW, TIME_TO_EMPTY_AVG
seconds left for battery to be considered empty
(i.e., while battery powers a load)
TIME_TO_FULL
(i.e., while battery powers a load). *_NOW is a
momentary reading; *_AVG is averaged over a fixed period.
TIME_TO_FULL_NOW, TIME_TO_FULL_AVG
seconds left for battery to be considered full
(i.e., while battery is charging)
(i.e., while battery is charging). Same now/avg distinction.
Battery <-> external power supply interaction
@ -253,9 +255,6 @@ A:
The attributes available currently are the ones currently provided by the
drivers written.
Good candidates to add in future: model/part#, cycle_time, manufacturer,
etc.
Q:
I have some very specific attribute (e.g., battery color). Should I add