From: Nam Tran <trannamatk@gmail.com>
To: andy@kernel.org
Cc: geert@linux-m68k.org, robh@kernel.org, krzk+dt@kernel.org,
conor+dt@kernel.org, christophe.jaillet@wanadoo.fr,
corbet@lwn.net, devicetree@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
florian.fainelli@broadcom.com,
bcm-kernel-feedback-list@broadcom.com,
linux-rpi-kernel@lists.infradead.org,
linux-arm-kernel@lists.infradead.org,
Nam Tran <trannamatk@gmail.com>
Subject: [PATCH v8 3/5] docs: ABI: Document LP5812 sysfs interfaces
Date: Sun, 27 Apr 2025 15:24:45 +0700 [thread overview]
Message-ID: <20250427082447.138359-4-trannamatk@gmail.com> (raw)
In-Reply-To: <20250427082447.138359-1-trannamatk@gmail.com>
The LP5812 is a 4 × 3 matrix RGB LED driver
with autonomous animation engine control.
The driver provides interfaces to configure
LED modes manual/autonomous, set PWM/DC values,
and manage autonomous animation engines.
Signed-off-by: Nam Tran <trannamatk@gmail.com>
---
.../ABI/testing/sysfs-bus-i2c-devices-lp5812 | 144 ++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 145 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-bus-i2c-devices-lp5812
diff --git a/Documentation/ABI/testing/sysfs-bus-i2c-devices-lp5812 b/Documentation/ABI/testing/sysfs-bus-i2c-devices-lp5812
new file mode 100644
index 000000000000..04689663a643
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-i2c-devices-lp5812
@@ -0,0 +1,144 @@
+What: /sys/bus/i2c/devices/.../lp5812_chip_setup/device_enable
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ Enables or disables the LP5812 device. (RW)
+ 0 - Disable
+ 1 - Enable
+
+What: /sys/bus/i2c/devices/.../lp5812_chip_setup/dev_config
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ Configures drive mode and scan order. (RW)
+ Some valid values: tcmscan:4:0:1:2:3 (default), tcmscan:3:0:1:2, mixscan:2:2:0:3, mixscan:3:0:1:2:3
+
+What: /sys/bus/i2c/devices/.../lp5812_chip_setup/device_command
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ Issues device-level commands. (WO)
+ Valid values: "update", "start", "stop", "pause", "continue"
+
+What: /sys/bus/i2c/devices/.../lp5812_chip_setup/sw_reset
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ Triggers a software reset of the device. (WO)
+ 1 - resets device
+ 0 - does not reset device
+
+What: /sys/bus/i2c/devices/.../lp5812_chip_setup/fault_clear
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ Clears fault status. (WO)
+ 1 - clears fault status
+ 0 - does not clear fault status
+
+What: /sys/bus/i2c/devices/.../lp5812_chip_setup/tsd_config_status
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ Report the current thermal shutdown config status. (RO)
+
+What: /sys/bus/i2c/devices/.../led_<id>/activate
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ Activate or deactivate the specified LED channel. (RW)
+ 1 - Activate
+ 0 - Deactivate
+
+What: /sys/bus/i2c/devices/.../led_<id>/mode
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ Selects LED operation mode. (RW)
+ Valid values: "manual", "autonomous"
+
+What: /sys/bus/i2c/devices/.../led_<id>/manual_dc
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ DC current level in manual mode. (RW)
+ Valid values: 0 - 255
+
+What: /sys/bus/i2c/devices/.../led_<id>/manual_pwm
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ PWM duty cycle in manual mode. (RW)
+ Valid values: 0 - 255
+
+What: /sys/bus/i2c/devices/.../led_<id>/autonomous_dc
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ DC current level used in autonomous mode. (RW)
+ Valid values: 0 - 255
+
+What: /sys/bus/i2c/devices/.../led_<id>/autonomous_dc
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ DC current level used in autonomous mode. (RW)
+ Valid values: 0 - 255
+
+What: /sys/bus/i2c/devices/.../led_<id>/pwm_dimming_scale
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ PWM dimming scale type. (RW)
+ Valid values: "linear", "exponential"
+
+What: /sys/bus/i2c/devices/.../led_<id>/pwm_phase_align
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ Configures PWM phase alignment. (RW)
+ Valid values: "forward", "middle", "backward"
+
+What: /sys/bus/i2c/devices/.../led_<id>/autonomous_animation
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ Controls AEU configuration and playback. (RW)
+ Format: (aeu number):(start pause time):(stop pause time):(playback time)
+ with aeu number 1, 2, 3; playback time 0 - 15
+
+What: /sys/bus/i2c/devices/.../led_<id>/aep_status
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ Shows current animation pattern status, value from 0 to 7. (RO)
+
+What: /sys/bus/i2c/devices/.../led_<id>/auto_pwm_val
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ Shows the pwm value in autonomous mode when pause the animation, value from 0 to 255. (RO)
+
+What: /sys/bus/i2c/devices/.../led_<id>/lod_lsd
+Date: May 2025
+KernelVersion: 6.16
+Contact: Nam Tran <trannamatk@gmail.com>
+Description:
+ 0 0 mean no lod and lsd fault detected, 1 1 mean lod and lsd fault detected (RO)
diff --git a/MAINTAINERS b/MAINTAINERS
index 091373b01dc2..5d8ee0801c69 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -24020,6 +24020,7 @@ TEXAS INSTRUMENTS' LP5812 4X3 MATRIX LED DRIVER
M: Nam Tran <trannamatk@gmail.com>
L: linux-kernel@vger.kernel.org
S: Maintained
+F: Documentation/ABI/testing/sysfs-bus-i2c-devices-lp5812
F: Documentation/devicetree/bindings/auxdisplay/ti,lp5812.yaml
F: drivers/auxdisplay/Kconfig
F: drivers/auxdisplay/Makefile
--
2.25.1
next prev parent reply other threads:[~2025-04-27 8:42 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-27 8:24 [PATCH v8 0/5] auxdisplay: add support for TI LP5812 4x3 Matrix LED driver Nam Tran
2025-04-27 8:24 ` [PATCH v8 1/5] dt-bindings: auxdisplay: add TI LP5812 4×3 Matrix RGB LED Driver Nam Tran
2025-04-27 8:24 ` [PATCH v8 2/5] " Nam Tran
2025-04-27 16:04 ` Randy Dunlap
2025-04-28 17:39 ` Nam Tran
2025-04-27 8:24 ` Nam Tran [this message]
2025-04-27 8:24 ` [PATCH v8 4/5] docs: auxdisplay: document TI LP5812 RGB LED driver Nam Tran
2025-04-27 8:24 ` [PATCH v8 5/5] arm64: dts: Add LP5812 node for Raspberry Pi 4 Model B Nam Tran
2025-04-27 9:35 ` [PATCH v8 0/5] auxdisplay: add support for TI LP5812 4x3 Matrix LED driver Andy Shevchenko
2025-04-28 10:37 ` Pavel Machek
2025-04-28 11:34 ` Geert Uytterhoeven
2025-04-28 17:29 ` Nam Tran
2025-04-28 20:18 ` Pavel Machek
2025-04-29 17:02 ` Nam Tran
2025-04-29 19:47 ` Andy Shevchenko
2025-05-07 16:42 ` Nam Tran
2025-05-08 8:24 ` Andy Shevchenko
2025-05-08 13:26 ` Lee Jones
2025-05-08 14:26 ` Nam Tran
2025-05-08 14:46 ` Andy Shevchenko
2025-05-08 15:01 ` Lee Jones
2025-05-10 7:48 ` Nam Tran
2025-05-12 6:05 ` Andy Shevchenko
2025-05-12 17:38 ` Nam Tran
2025-05-12 17:44 ` Andy Shevchenko
2025-05-13 8:35 ` Lee Jones
2025-05-13 8:10 ` Geert Uytterhoeven
2025-05-13 8:50 ` Lee Jones
2025-04-30 7:15 ` Pavel Machek
2025-05-05 7:24 ` Nam Tran
2025-05-08 8:38 ` Pavel Machek
2025-04-28 16:37 ` Nam Tran
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250427082447.138359-4-trannamatk@gmail.com \
--to=trannamatk@gmail.com \
--cc=andy@kernel.org \
--cc=bcm-kernel-feedback-list@broadcom.com \
--cc=christophe.jaillet@wanadoo.fr \
--cc=conor+dt@kernel.org \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=florian.fainelli@broadcom.com \
--cc=geert@linux-m68k.org \
--cc=krzk+dt@kernel.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-rpi-kernel@lists.infradead.org \
--cc=robh@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).