diff mbox series

[RESEND,v4,3/3] Documentation: power: rt9471: Document exported sysfs entries

Message ID 1662965823-17760-4-git-send-email-u0084500@gmail.com (mailing list archive)
State Handled Elsewhere, archived
Headers show
Series Add Richtek RT9471 3A battery charger support | expand

Commit Message

ChiYuan Huang Sept. 12, 2022, 6:57 a.m. UTC 
From: ChiYuan Huang <cy_huang@richtek.com>

Document the settings exported by rt9471 charger driver through sysfs entries:
- sysoff_enable
- charge_term_enable
- port_detect_enable

Signed-off-by: ChiYuan Huang <cy_huang@richtek.com>
---
 Documentation/ABI/testing/sysfs-class-power | 44 +++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-power b/Documentation/ABI/testing/sysfs-class-power
index a9ce63c..1f8afe5 100644
--- a/Documentation/ABI/testing/sysfs-class-power
+++ b/Documentation/ABI/testing/sysfs-class-power
@@ -768,3 +768,47 @@  Description:
 
 		Access: Read
 		Valid values: 1-31
+
+What:		/sys/class/power_supply/rt9471-*/sysoff_enable
+Date:		Sep 2022
+KernelVersion:	6.1
+Contact:	ChiYuan Huang <cy_huang@richtek.com>
+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.
+
+		Access: Read, Write
+		Valid values:
+		- 1: enabled
+		- 0: disabled
+
+What:		/sys/class/power_supply/rt9471-*/charge_term_enable
+Date:		Sep 2022
+KernelVersion:	6.1
+Contact:	ChiYuan Huang <cy_huang@richtek.com>
+Description:
+		This entry allows enabling the charge termination function of rt9471 charger
+		devices. If enabled, the battery charging current, and the battery voltage
+		reachs charge termination condition, the internal battery FET will be turned off
+		to optimize the battery life. See device datasheet for details.
+
+		Access: Read, Write
+		Valid values:
+		- 1: enabled
+		- 0: disabled
+
+What:		/sys/class/power_supply/rt9471-*/port_detect_enable
+Date:		Sep 2022
+KernelVersion:	6.1
+Contact:	ChiYuan Huang <cy_huang@richtek.com>
+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.
+
+		Access: Read, Write
+		Valid values:
+		- 1: enabled
+		- 0: disabled