Documentation/leds/leds-lp5812.rst

Source file repositories/reference/linux-study-clean/Documentation/leds/leds-lp5812.rst

File Facts

System: Linux kernel
Corpus path: Documentation/leds/leds-lp5812.rst
Extension: .rst
Size: 1527 bytes
Lines: 51
Domain: Support Tooling And Documentation
Bucket: Documentation
Inferred role: Support Tooling And Documentation: documentation
Status: atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

No C-style include directives detected by the generator.

Detected Declarations

No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

.. 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.

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

Annotation

Atlas domain: Support Tooling And Documentation / Documentation.
Implementation status: atlas-only.

Implementation Notes

This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.