[PATCH v8 3/3] Documentation: power: rt9471: Document exported sysfs entries
From: cy_huang
Date: Fri Sep 30 2022 - 10:53:23 EST
From: ChiYuan Huang <cy_huang@xxxxxxxxxxx>
Document the settings exported by rt9471 charger driver through sysfs entries:
- sysoff_enable
- port_detect_enable
Signed-off-by: ChiYuan Huang <cy_huang@xxxxxxxxxxx>
---
Since v6:
- Explain more details for sysoff_enable attribute.
Since v5:
- Recover all the change in sysfs-class-power.
- New a sysfs-class-power-rt9471 file.
- Remove 'charge_term_enable' sysfs entry, directly integrate it in
'charge_term_current' power supply property control.
---
Documentation/ABI/testing/sysfs-class-power-rt9471 | 32 ++++++++++++++++++++++
1 file changed, 32 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-class-power-rt9471
diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9471 b/Documentation/ABI/testing/sysfs-class-power-rt9471
new file mode 100644
index 00000000..38227a8
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-power-rt9471
@@ -0,0 +1,32 @@
+What: /sys/class/power_supply/rt9471-*/sysoff_enable
+Date: Oct 2022
+KernelVersion: 6.1
+Contact: ChiYuan Huang <cy_huang@xxxxxxxxxxx>
+Description:
+ This entry allows enabling the sysoff mode of rt9471 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
+
+What: /sys/class/power_supply/rt9471-*/port_detect_enable
+Date: Oct 2022
+KernelVersion: 6.1
+Contact: ChiYuan Huang <cy_huang@xxxxxxxxxxx>
+Description:
+ This entry allows enabling the USB BC12 port detect function of rt9471 charger
+ devices. If enabled and VBUS is inserted, device will start to do the BC12
+ port detect and report the usb port type when port detect is done. See
+ datasheet for details. Normally controlled when TypeC/USBPD port integrated.
+
+ Access: Read, Write
+ Valid values:
+ - 1: enabled
+ - 0: disabled
--
2.7.4