diff options
| author | Vicentiu Galanopulo <vicentiu.galanopulo@remote-tech.co.uk> | 2024-12-18 21:19:53 +0300 |
|---|---|---|
| committer | Lee Jones <lee@kernel.org> | 2024-12-23 13:13:32 +0300 |
| commit | b1816b22381be67a899c8c0c65fb919102a0e750 (patch) | |
| tree | 44316749d97fd3d97b563d39a3e813071eea0237 | |
| parent | c2b148f3bc94b61e885dc8529d6b6136576bd865 (diff) | |
| download | linux-b1816b22381be67a899c8c0c65fb919102a0e750.tar.xz | |
Documentation:leds: Add leds-st1202.rst
Add usage for sysfs hw_pattern entry for leds-st1202
Signed-off-by: Vicentiu Galanopulo <vicentiu.galanopulo@remote-tech.co.uk>
Link: https://lore.kernel.org/r/20241218182001.41476-2-vicentiu.galanopulo@remote-tech.co.uk
Signed-off-by: Lee Jones <lee@kernel.org>
| -rw-r--r-- | Documentation/leds/index.rst | 1 | ||||
| -rw-r--r-- | Documentation/leds/leds-st1202.rst | 34 |
2 files changed, 35 insertions, 0 deletions
diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst index 3ade16c18328..0ab0a2128a11 100644 --- a/Documentation/leds/index.rst +++ b/Documentation/leds/index.rst @@ -28,4 +28,5 @@ LEDs leds-mlxcpld leds-mt6370-rgb leds-sc27xx + leds-st1202.rst leds-qcom-lpg diff --git a/Documentation/leds/leds-st1202.rst b/Documentation/leds/leds-st1202.rst new file mode 100644 index 000000000000..1a09fbfcedcf --- /dev/null +++ b/Documentation/leds/leds-st1202.rst @@ -0,0 +1,34 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============================================ +Kernel driver for STMicroelectronics LED1202 +============================================ + +/sys/class/leds/<led>/hw_pattern +-------------------------------- + +Specify a hardware pattern for the ST1202 LED. The LED controller +implements 12 low-side current generators with independent dimming +control. Internal volatile memory allows the user to store up to 8 +different patterns. Each pattern is a particular output configuration +in terms of PWM duty-cycle and duration (ms). + +To be compatible with the hardware pattern format, maximum 8 tuples of +brightness (PWM) and duration must be written to hw_pattern. + +- Min pattern duration: 22 ms +- Max pattern duration: 5660 ms + +The format of the hardware pattern values should be: +"brightness duration brightness duration ..." + +/sys/class/leds/<led>/repeat +---------------------------- + +Specify a pattern repeat number, which is common for all channels. +Default is 1; negative numbers and 0 are invalid. + +This file will always return the originally written repeat number. + +When the 255 value is written to it, all patterns will repeat +indefinitely. |