From: "Iván Ezequiel Rodriguez" <ivanrwcm25@gmail.com>
To: Sebastian Reichel <sre@kernel.org>
Cc: linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org,
"Rafael J . Wysocki" <rafael@kernel.org>,
"Iván Ezequiel Rodriguez" <ivanrwcm25@gmail.com>
Subject: [PATCH v1 3/5] docs: power: fix power_supply_class.rst status, health and time_to
Date: Mon, 31 Aug 2026 12:53:37 -0300 [thread overview]
Message-ID: <20260831155339.181487-4-ivanrwcm25@gmail.com> (raw)
In-Reply-To: <20260831155339.181487-1-ivanrwcm25@gmail.com>
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>
---
Documentation/power/power_supply_class.rst | 26 +++++++++++-----------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/Documentation/power/power_supply_class.rst b/Documentation/power/power_supply_class.rst
index 6d11f8c594a0..c60aa7ce717b 100644
--- a/Documentation/power/power_supply_class.rst
+++ b/Documentation/power/power_supply_class.rst
@@ -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
@@ -251,10 +253,8 @@ A:
to add it and send a patch along with your driver.
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.
+ drivers written. MODEL_NAME and MANUFACTURER are already part of the
+ standard attribute set.
Q:
--
2.43.0
next prev parent reply other threads:[~2026-08-31 15:54 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-08-31 15:53 [PATCH v1 0/5] power_supply: errno, hwmon rollback and docs/ABI sync Iván Ezequiel Rodriguez
2026-08-31 15:53 ` [PATCH v1 1/5] power: return -ENOMEM on OCV table alloc failure Iván Ezequiel Rodriguez
2026-08-31 15:53 ` [PATCH v1 2/5] power: restore hwmon if extension update fails Iván Ezequiel Rodriguez
2026-08-31 15:53 ` Iván Ezequiel Rodriguez [this message]
2026-08-31 15:53 ` [PATCH v1 4/5] docs: ABI: complete power_supply type valid values Iván Ezequiel Rodriguez
2026-08-31 15:53 ` [PATCH v1 5/5] power: use tabs in power_supply_get_property_direct Iván Ezequiel Rodriguez
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260831155339.181487-4-ivanrwcm25@gmail.com \
--to=ivanrwcm25@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=rafael@kernel.org \
--cc=sre@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.