Documentation: power: rt9467: Document exported sysfs entries
authorChiaEn Wu <chiaen_wu@richtek.com>
Tue, 3 Jan 2023 07:29:58 +0000 (15:29 +0800)
committerSebastian Reichel <sre@kernel.org>
Fri, 3 Feb 2023 16:09:42 +0000 (17:09 +0100)
Document the settings exported by rt9467 charger driver through sysfs
entries:
- sysoff_enable

Signed-off-by: ChiaEn Wu <chiaen_wu@richtek.com>
[update kernel version and date]
Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com>
Documentation/ABI/testing/sysfs-class-power-rt9467 [new file with mode: 0644]

diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9467 b/Documentation/ABI/testing/sysfs-class-power-rt9467
new file mode 100644 (file)
index 0000000..619b7c4
--- /dev/null
@@ -0,0 +1,19 @@
+What:          /sys/class/power_supply/rt9467-*/sysoff_enable
+Date:          Feb 2023
+KernelVersion: 6.3
+Contact:       ChiaEn Wu <chiaen_wu@richtek.com>
+Description:
+               This entry allows enabling the sysoff mode of rt9467 charger
+               devices.
+               If enabled and the input is removed, the internal battery FET
+               is turned off to reduce the leakage from the BAT pin. See
+               device datasheet for details. It's commonly used when the
+               product enter shipping stage. After entering shipping mode,
+               only 'VBUS' or 'Power key" pressed can make it leave this mode.
+               'Disable' also can help to leave it, but it's more like to
+               abort the action before the device really enter shipping mode.
+
+               Access: Read, Write
+               Valid values:
+               - 1: enabled
+               - 0: disabled