Commit 444bb79e authored by Nam Tran's avatar Nam Tran Committed by Lee Jones
Browse files

docs: leds: Document TI LP5812 LED driver 



The driver provides sysfs interfaces to control and configure the
LP5812 device and its LED channels.

The documentation describes the chip's capabilities, sysfs interface,
and usage examples.

Signed-off-by: default avatarNam Tran <trannamatk@gmail.com>
Link: https://patch.msgid.link/20260115161013.40706-3-trannamatk@gmail.com


Signed-off-by: default avatarLee Jones <lee@kernel.org>
parent a0309dc6

Documentation/leds/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -25,6 +25,7 @@ LEDs 
   leds-lp5523

   leds-lp5562

   leds-lp55xx

   leds-lp5812

   leds-mlxcpld

   leds-mt6370-rgb

   leds-sc27xx

Documentation/leds/leds-lp5812.rst

0 → 100644
+50 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



========================

Kernel driver for lp5812

========================



* TI/National Semiconductor LP5812 LED Driver

* Datasheet: https://www.ti.com/product/LP5812#tech-docs



Authors: Jared Zhou <jared-zhou@ti.com>



Description

===========



The LP5812 is a 4x3 matrix LED driver with support for both manual and

autonomous animation control. This driver provides sysfs interfaces to

control and configure the LP5812 device and its LED channels.



Sysfs Interface

===============



This driver uses the standard multicolor LED class interfaces defined

in Documentation/ABI/testing/sysfs-class-led-multicolor.rst.



Each LP5812 LED output appears under ``/sys/class/leds/`` with its

assigned label (for example ``LED_A``).



The following attributes are exposed:

  - multi_intensity: Per-channel RGB intensity control

  - brightness: Standard brightness control (0-255)



Autonomous Control Modes

========================



The driver also supports autonomous control through pattern configuration

(e.g., direct, tcmscan, or mixscan modes) defined in the device tree.

When configured, the LP5812 can generate transitions and color effects

without CPU intervention.



Refer to the device tree binding document for valid mode strings and

configuration examples.



Example Usage

=============



To control LED_A::

    # Set RGB intensity (R=50, G=50, B=50)

    echo 50 50 50 > /sys/class/leds/LED_A/multi_intensity

    # Set overall brightness to maximum

    echo 255 > /sys/class/leds/LED_A/brightness

MAINTAINERS

+1 −0
Original line number Diff line number Diff line
@@ -25841,6 +25841,7 @@ M: Nam Tran <trannamatk@gmail.com> 
L:	linux-leds@vger.kernel.org

S:	Maintained

F:	Documentation/devicetree/bindings/leds/ti,lp5812.yaml

F:	Documentation/leds/leds-lp5812.rst

F:	drivers/leds/rgb/Kconfig

F:	drivers/leds/rgb/Makefile

F:	drivers/leds/rgb/leds-lp5812.c