diff mbox series

[v2] docs/admin-guide/thinkpad-acpi: add section for battery charge control

Message ID QMrVZuZNCFAbIPTNcpoa_mYs--kCZx_hjTGXsA6WY4xPnBNVPCIAXnIL3cbphM8nyueZR9TEmqwrGJunSuZ2p0zpG7GvLnbF14hV6vIDqwc=@protonmail.com (mailing list archive)
State Superseded, archived
Headers show
Series [v2] docs/admin-guide/thinkpad-acpi: add section for battery charge control | expand

Commit Message

Barnabás Pőcze July 27, 2020, 7:23 p.m. UTC
This patch adds a section to the Thinkpad ACPI extras driver
documentation detailing the provided features that may be used
to modify battery charge related state. As of yet, only
charge_control_{start,end}_threshold attributes are supported
and documented.

Signed-off-by: Barnabás Pőcze <pobrn@protonmail.com>
---
 .../admin-guide/laptops/thinkpad-acpi.rst       | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

--
2.27.0

Comments

Barnabás Pőcze July 27, 2020, 7:25 p.m. UTC | #1
Please ignore v2 of the patch.
diff mbox series

Patch

diff --git a/Documentation/admin-guide/laptops/thinkpad-acpi.rst b/Documentation/admin-guide/laptops/thinkpad-acpi.rst
index 822907dcc845..07fc005e96de 100644
--- a/Documentation/admin-guide/laptops/thinkpad-acpi.rst
+++ b/Documentation/admin-guide/laptops/thinkpad-acpi.rst
@@ -1470,6 +1470,23 @@  For more details about which buttons will appear depending on the mode, please
 review the laptop's user guide:
 http://www.lenovo.com/shop/americas/content/user_guides/x1carbon_2_ug_en.pdf

+Battery charge control
+----------------------
+
+sysfs attributes:
+/sys/class/power_supply/BAT*/charge_control_{start,end}_threshold
+
+These two attributes are created for those batteries that are supported by the
+driver. They enable the user to control the battery charge thresholds of the
+given battery. Both values may be read and set. `charge_control_start_threshold`
+accepts an integer between 0 and 99 (inclusive); this value represents a battery
+percentage level, below which charging will begin. `charge_control_end_threshold`
+accepts an integer between 1 and 100 (inclusive); this value represents a battery
+percentage level, above which charging will stop.
+
+The exact semantics of the attributes may be found in
+Documentation/ABI/testing/sysfs-class-power.
+
 Multiple Commands, Module Parameters
 ------------------------------------