OSDN Git Service

platform/x86: thinkpad_acpi: add documentation for battery charge control
authorBarnabás Pőcze <pobrn@protonmail.com>
Mon, 27 Jul 2020 19:31:25 +0000 (19:31 +0000)
committerAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Tue, 28 Jul 2020 09:31:14 +0000 (12:31 +0300)
Add 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>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Documentation/admin-guide/laptops/thinkpad-acpi.rst

index 99066aa..fb0d346 100644 (file)
@@ -1485,6 +1485,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
 ------------------------------------