xref: /linux/Documentation/leds/leds-lp5812.rst (revision 2228d9cf7a562d1b0ca86bd529f6acb94f4bb80f)
1.. SPDX-License-Identifier: GPL-2.0
2
3========================
4Kernel driver for lp5812
5========================
6
7* TI/National Semiconductor LP5812 LED Driver
8* Datasheet: https://www.ti.com/product/LP5812#tech-docs
9
10Authors: Jared Zhou <jared-zhou@ti.com>
11
12Description
13===========
14
15The LP5812 is a 4x3 matrix LED driver with support for both manual and
16autonomous animation control. This driver provides sysfs interfaces to
17control and configure the LP5812 device and its LED channels.
18
19Sysfs Interface
20===============
21
22This driver uses the standard multicolor LED class interfaces defined
23in Documentation/ABI/testing/sysfs-class-led-multicolor.rst.
24
25Each LP5812 LED output appears under ``/sys/class/leds/`` with its
26assigned label (for example ``LED_A``).
27
28The following attributes are exposed:
29  - multi_intensity: Per-channel RGB intensity control
30  - brightness: Standard brightness control (0-255)
31
32Autonomous Control Modes
33========================
34
35The driver also supports autonomous control through pattern configuration
36(e.g., direct, tcmscan, or mixscan modes) defined in the device tree.
37When configured, the LP5812 can generate transitions and color effects
38without CPU intervention.
39
40Refer to the device tree binding document for valid mode strings and
41configuration examples.
42
43Example Usage
44=============
45
46To control LED_A::
47    # Set RGB intensity (R=50, G=50, B=50)
48    echo 50 50 50 > /sys/class/leds/LED_A/multi_intensity
49    # Set overall brightness to maximum
50    echo 255 > /sys/class/leds/LED_A/brightness
51