diff mbox series

[3/3] thinkpad_acpi: document force_discharge and, inhibit_charge

Message ID 05bb641c-0390-bbd6-56bf-4871e65e4f20@gmail.com (mailing list archive)
State New
Headers show
Series [1/3] thinkpad_acpi: add support for force_discharge | expand

Commit Message

Nicolo' Piazzalunga March 17, 2021, 2:05 p.m. UTC
Describe the additional sysfs attributes for
forced discharging and charge inhibiting.

Improve description of charge_control_{start,end}_threshold.

Signed-off-by: Ognjen Galic <smclt30p@gmail.com>
Signed-off-by: Thomas Koch <linrunner@gmx.net>
Signed-off-by: Nicolo' Piazzalunga <nicolopiazzalunga@gmail.com>
---
 .../admin-guide/laptops/thinkpad-acpi.rst     | 30 +++++++++++++++----
 1 file changed, 25 insertions(+), 5 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/admin-guide/laptops/thinkpad-acpi.rst b/Documentation/admin-guide/laptops/thinkpad-acpi.rst
index 5e477869df18..e71bc74d69dc 100644
--- a/Documentation/admin-guide/laptops/thinkpad-acpi.rst
+++ b/Documentation/admin-guide/laptops/thinkpad-acpi.rst
@@ -1493,15 +1493,35 @@  sysfs attributes:
 
 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.
+given battery. Both values may be read and set.
+
+`charge_control_start_threshold` accepts an integer between 0 and 99 (inclusive).
+This value represents the battery percentage level below which charging will begin.
+
+`charge_control_end_threshold` accepts an integer between 1 and 100 (inclusive).
+This value represents the battery percentage level where charging will stop.
 
 The exact semantics of the attributes may be found in
 Documentation/ABI/testing/sysfs-class-power.
 
+Battery forced discharging
+--------------------------
+
+sysfs attribute:
+/sys/class/power_supply/BATx/force_discharge
+
+Setting this attribute to 1 forces the battery to discharge while AC is attached.
+Setting it to 0 terminates forced discharging.
+
+Battery charge inhibiting
+--------------------------
+
+sysfs attribute:
+/sys/class/power_supply/BATx/inhibit_discharge
+
+Setting this attribute to 1 stops charging of the battery as a manual override
+over the threshold attributes. Setting it to 0 terminates the override.
+
 Multiple Commands, Module Parameters
 ------------------------------------