Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation: power: rt9471: Document exported sysfs entries

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

Signed-off-by: ChiYuan Huang <cy_huang@richtek.com>
[update kernel version and date]
Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com>

authored by

ChiYuan Huang and committed by
Sebastian Reichel
ab8174bb 4a1a5f67

+32
+32
Documentation/ABI/testing/sysfs-class-power-rt9471
··· 1 + What: /sys/class/power_supply/rt9471-*/sysoff_enable 2 + Date: Feb 2023 3 + KernelVersion: 6.3 4 + Contact: ChiYuan Huang <cy_huang@richtek.com> 5 + Description: 6 + This entry allows enabling the sysoff mode of rt9471 charger devices. 7 + If enabled and the input is removed, the internal battery FET is turned 8 + off to reduce the leakage from the BAT pin. See device datasheet for details. 9 + It's commonly used when the product enter shipping stage. After entering 10 + shipping mode, only 'VBUS' or 'Power key" pressed can make it leave this 11 + mode. 'Disable' also can help to leave it, but it's more like to abort 12 + the action before the device really enter shipping mode. 13 + 14 + Access: Read, Write 15 + Valid values: 16 + - 1: enabled 17 + - 0: disabled 18 + 19 + What: /sys/class/power_supply/rt9471-*/port_detect_enable 20 + Date: Feb 2023 21 + KernelVersion: 6.3 22 + Contact: ChiYuan Huang <cy_huang@richtek.com> 23 + Description: 24 + This entry allows enabling the USB BC12 port detect function of rt9471 charger 25 + devices. If enabled and VBUS is inserted, device will start to do the BC12 26 + port detect and report the usb port type when port detect is done. See 27 + datasheet for details. Normally controlled when TypeC/USBPD port integrated. 28 + 29 + Access: Read, Write 30 + Valid values: 31 + - 1: enabled 32 + - 0: disabled