mirror of
https://github.com/torvalds/linux.git
synced 2025-11-04 02:30:34 +02:00
docs: ABI: sysfs-class-led-trigger-pattern: remove hw_pattern duplication
The ABI files are supposed to be unique. Yet, in the specific case of hw_pattern, there are some duplicated entries as warned by scripts/get_abi.pl: Warning: /sys/class/leds/<led>/hw_pattern is defined 3 times: Documentation/ABI/testing/sysfs-class-led-trigger-pattern:14 Documentation/ABI/testing/sysfs-class-led-driver-sc27xx:0 Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0 Drop the duplication from the ABI files, moving the specific definitions to files inside Documentation/leds. Acked-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/038e57881550550b298e598f8f9b7f20515cbe15.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Mauro Carvalho Chehab
Greg Kroah-Hartman
parent
bd6e8441c2
commit
26a0755304
6 changed files with 170 additions and 159 deletions
|
|
@ -1,138 +1,3 @@
|
||||||
What: /sys/class/leds/<led>/hw_pattern
|
|
||||||
Date: September 2019
|
|
||||||
KernelVersion: 5.5
|
|
||||||
Description:
|
|
||||||
Specify a hardware pattern for the EL15203000 LED.
|
|
||||||
The LEDs board supports only predefined patterns by firmware
|
|
||||||
for specific LEDs.
|
|
||||||
|
|
||||||
Breathing mode for Screen frame light tube::
|
|
||||||
|
|
||||||
"0 4000 1 4000"
|
|
||||||
|
|
||||||
^
|
|
||||||
|
|
|
||||||
Max-| ---
|
|
||||||
| / \
|
|
||||||
| / \
|
|
||||||
| / \ /
|
|
||||||
| / \ /
|
|
||||||
Min-|- ---
|
|
||||||
|
|
|
||||||
0------4------8--> time (sec)
|
|
||||||
|
|
||||||
Cascade mode for Pipe LED::
|
|
||||||
|
|
||||||
"1 800 2 800 4 800 8 800 16 800"
|
|
||||||
|
|
||||||
^
|
|
||||||
|
|
|
||||||
0 On -|----+ +----+ +---
|
|
||||||
| | | | |
|
|
||||||
Off-| +-------------------+ +-------------------+
|
|
||||||
|
|
|
||||||
1 On -| +----+ +----+
|
|
||||||
| | | | |
|
|
||||||
Off |----+ +-------------------+ +------------------
|
|
||||||
|
|
|
||||||
2 On -| +----+ +----+
|
|
||||||
| | | | |
|
|
||||||
Off-|---------+ +-------------------+ +-------------
|
|
||||||
|
|
|
||||||
3 On -| +----+ +----+
|
|
||||||
| | | | |
|
|
||||||
Off-|--------------+ +-------------------+ +--------
|
|
||||||
|
|
|
||||||
4 On -| +----+ +----+
|
|
||||||
| | | | |
|
|
||||||
Off-|-------------------+ +-------------------+ +---
|
|
||||||
|
|
|
||||||
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
|
|
||||||
|
|
||||||
Inverted cascade mode for Pipe LED::
|
|
||||||
|
|
||||||
"30 800 29 800 27 800 23 800 15 800"
|
|
||||||
|
|
||||||
^
|
|
||||||
|
|
|
||||||
0 On -| +-------------------+ +-------------------+
|
|
||||||
| | | | |
|
|
||||||
Off-|----+ +----+ +---
|
|
||||||
|
|
|
||||||
1 On -|----+ +-------------------+ +------------------
|
|
||||||
| | | | |
|
|
||||||
Off | +----+ +----+
|
|
||||||
|
|
|
||||||
2 On -|---------+ +-------------------+ +-------------
|
|
||||||
| | | | |
|
|
||||||
Off-| +----+ +----+
|
|
||||||
|
|
|
||||||
3 On -|--------------+ +-------------------+ +--------
|
|
||||||
| | | | |
|
|
||||||
Off-| +----+ +----+
|
|
||||||
|
|
|
||||||
4 On -|-------------------+ +-------------------+ +---
|
|
||||||
| | | | |
|
|
||||||
Off-| +----+ +----+
|
|
||||||
|
|
|
||||||
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
|
|
||||||
|
|
||||||
Bounce mode for Pipe LED::
|
|
||||||
|
|
||||||
"1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800"
|
|
||||||
|
|
||||||
^
|
|
||||||
|
|
|
||||||
0 On -|----+ +--------
|
|
||||||
| | |
|
|
||||||
Off-| +---------------------------------------+
|
|
||||||
|
|
|
||||||
1 On -| +----+ +----+
|
|
||||||
| | | | |
|
|
||||||
Off |----+ +-----------------------------+ +--------
|
|
||||||
|
|
|
||||||
2 On -| +----+ +----+
|
|
||||||
| | | | |
|
|
||||||
Off-|---------+ +-------------------+ +-------------
|
|
||||||
|
|
|
||||||
3 On -| +----+ +----+
|
|
||||||
| | | | |
|
|
||||||
Off-|--------------+ +---------+ +------------------
|
|
||||||
|
|
|
||||||
4 On -| +---------+
|
|
||||||
| | |
|
|
||||||
Off-|-------------------+ +-----------------------
|
|
||||||
|
|
|
||||||
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
|
|
||||||
|
|
||||||
Inverted bounce mode for Pipe LED::
|
|
||||||
|
|
||||||
"30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800"
|
|
||||||
|
|
||||||
^
|
|
||||||
|
|
|
||||||
0 On -| +---------------------------------------+
|
|
||||||
| | |
|
|
||||||
Off-|----+ +--------
|
|
||||||
|
|
|
||||||
1 On -|----+ +-----------------------------+ +--------
|
|
||||||
| | | | |
|
|
||||||
Off | +----+ +----+
|
|
||||||
|
|
|
||||||
2 On -|---------+ +-------------------+ +-------------
|
|
||||||
| | | | |
|
|
||||||
Off-| +----+ +----+
|
|
||||||
|
|
|
||||||
3 On -|--------------+ +---------+ +------------------
|
|
||||||
| | | | |
|
|
||||||
Off-| +----+ +----+
|
|
||||||
|
|
|
||||||
4 On -|-------------------+ +-----------------------
|
|
||||||
| | |
|
|
||||||
Off-| +---------+
|
|
||||||
|
|
|
||||||
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
|
|
||||||
|
|
||||||
What: /sys/class/leds/<led>/repeat
|
What: /sys/class/leds/<led>/repeat
|
||||||
Date: September 2019
|
Date: September 2019
|
||||||
KernelVersion: 5.5
|
KernelVersion: 5.5
|
||||||
|
|
|
||||||
|
|
@ -1,22 +0,0 @@
|
||||||
What: /sys/class/leds/<led>/hw_pattern
|
|
||||||
Date: September 2018
|
|
||||||
KernelVersion: 4.20
|
|
||||||
Description:
|
|
||||||
Specify a hardware pattern for the SC27XX LED. For the SC27XX
|
|
||||||
LED controller, it only supports 4 stages to make a single
|
|
||||||
hardware pattern, which is used to configure the rise time,
|
|
||||||
high time, fall time and low time for the breathing mode.
|
|
||||||
|
|
||||||
For the breathing mode, the SC27XX LED only expects one brightness
|
|
||||||
for the high stage. To be compatible with the hardware pattern
|
|
||||||
format, we should set brightness as 0 for rise stage, fall
|
|
||||||
stage and low stage.
|
|
||||||
|
|
||||||
- Min stage duration: 125 ms
|
|
||||||
- Max stage duration: 31875 ms
|
|
||||||
|
|
||||||
Since the stage duration step is 125 ms, the duration should be
|
|
||||||
a multiplier of 125, like 125ms, 250ms, 375ms, 500ms ... 31875ms.
|
|
||||||
|
|
||||||
Thus the format of the hardware pattern values should be:
|
|
||||||
"0 rise_duration brightness high_duration 0 fall_duration 0 low_duration".
|
|
||||||
|
|
@ -23,8 +23,8 @@ Description:
|
||||||
|
|
||||||
Since different LED hardware can have different semantics of
|
Since different LED hardware can have different semantics of
|
||||||
hardware patterns, each driver is expected to provide its own
|
hardware patterns, each driver is expected to provide its own
|
||||||
description for the hardware patterns in their ABI documentation
|
description for the hardware patterns in their documentation
|
||||||
file.
|
file at Documentation/leds/.
|
||||||
|
|
||||||
What: /sys/class/leds/<led>/repeat
|
What: /sys/class/leds/<led>/repeat
|
||||||
Date: September 2018
|
Date: September 2018
|
||||||
|
|
|
||||||
|
|
@ -17,6 +17,7 @@ LEDs
|
||||||
uleds
|
uleds
|
||||||
|
|
||||||
leds-blinkm
|
leds-blinkm
|
||||||
|
leds-el15203000
|
||||||
leds-lm3556
|
leds-lm3556
|
||||||
leds-lp3944
|
leds-lp3944
|
||||||
leds-lp5521
|
leds-lp5521
|
||||||
|
|
|
||||||
140
Documentation/leds/leds-el15203000.rst
Normal file
140
Documentation/leds/leds-el15203000.rst
Normal file
|
|
@ -0,0 +1,140 @@
|
||||||
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
|
==================================
|
||||||
|
Kernel driver for Crane EL15203000
|
||||||
|
==================================
|
||||||
|
|
||||||
|
/sys/class/leds/<led>/hw_pattern
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
Specify a hardware pattern for the EL15203000 LED.
|
||||||
|
|
||||||
|
The LEDs board supports only predefined patterns by firmware
|
||||||
|
for specific LEDs.
|
||||||
|
|
||||||
|
Breathing mode for Screen frame light tube::
|
||||||
|
|
||||||
|
"0 4000 1 4000"
|
||||||
|
|
||||||
|
^
|
||||||
|
|
|
||||||
|
Max-| ---
|
||||||
|
| / \
|
||||||
|
| / \
|
||||||
|
| / \ /
|
||||||
|
| / \ /
|
||||||
|
Min-|- ---
|
||||||
|
|
|
||||||
|
0------4------8--> time (sec)
|
||||||
|
|
||||||
|
Cascade mode for Pipe LED::
|
||||||
|
|
||||||
|
"1 800 2 800 4 800 8 800 16 800"
|
||||||
|
|
||||||
|
^
|
||||||
|
|
|
||||||
|
0 On -|----+ +----+ +---
|
||||||
|
| | | | |
|
||||||
|
Off-| +-------------------+ +-------------------+
|
||||||
|
|
|
||||||
|
1 On -| +----+ +----+
|
||||||
|
| | | | |
|
||||||
|
Off |----+ +-------------------+ +------------------
|
||||||
|
|
|
||||||
|
2 On -| +----+ +----+
|
||||||
|
| | | | |
|
||||||
|
Off-|---------+ +-------------------+ +-------------
|
||||||
|
|
|
||||||
|
3 On -| +----+ +----+
|
||||||
|
| | | | |
|
||||||
|
Off-|--------------+ +-------------------+ +--------
|
||||||
|
|
|
||||||
|
4 On -| +----+ +----+
|
||||||
|
| | | | |
|
||||||
|
Off-|-------------------+ +-------------------+ +---
|
||||||
|
|
|
||||||
|
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
|
||||||
|
|
||||||
|
Inverted cascade mode for Pipe LED::
|
||||||
|
|
||||||
|
"30 800 29 800 27 800 23 800 15 800"
|
||||||
|
|
||||||
|
^
|
||||||
|
|
|
||||||
|
0 On -| +-------------------+ +-------------------+
|
||||||
|
| | | | |
|
||||||
|
Off-|----+ +----+ +---
|
||||||
|
|
|
||||||
|
1 On -|----+ +-------------------+ +------------------
|
||||||
|
| | | | |
|
||||||
|
Off | +----+ +----+
|
||||||
|
|
|
||||||
|
2 On -|---------+ +-------------------+ +-------------
|
||||||
|
| | | | |
|
||||||
|
Off-| +----+ +----+
|
||||||
|
|
|
||||||
|
3 On -|--------------+ +-------------------+ +--------
|
||||||
|
| | | | |
|
||||||
|
Off-| +----+ +----+
|
||||||
|
|
|
||||||
|
4 On -|-------------------+ +-------------------+ +---
|
||||||
|
| | | | |
|
||||||
|
Off-| +----+ +----+
|
||||||
|
|
|
||||||
|
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
|
||||||
|
|
||||||
|
Bounce mode for Pipe LED::
|
||||||
|
|
||||||
|
"1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800"
|
||||||
|
|
||||||
|
^
|
||||||
|
|
|
||||||
|
0 On -|----+ +--------
|
||||||
|
| | |
|
||||||
|
Off-| +---------------------------------------+
|
||||||
|
|
|
||||||
|
1 On -| +----+ +----+
|
||||||
|
| | | | |
|
||||||
|
Off |----+ +-----------------------------+ +--------
|
||||||
|
|
|
||||||
|
2 On -| +----+ +----+
|
||||||
|
| | | | |
|
||||||
|
Off-|---------+ +-------------------+ +-------------
|
||||||
|
|
|
||||||
|
3 On -| +----+ +----+
|
||||||
|
| | | | |
|
||||||
|
Off-|--------------+ +---------+ +------------------
|
||||||
|
|
|
||||||
|
4 On -| +---------+
|
||||||
|
| | |
|
||||||
|
Off-|-------------------+ +-----------------------
|
||||||
|
|
|
||||||
|
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
|
||||||
|
|
||||||
|
Inverted bounce mode for Pipe LED::
|
||||||
|
|
||||||
|
"30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800"
|
||||||
|
|
||||||
|
^
|
||||||
|
|
|
||||||
|
0 On -| +---------------------------------------+
|
||||||
|
| | |
|
||||||
|
Off-|----+ +--------
|
||||||
|
|
|
||||||
|
1 On -|----+ +-----------------------------+ +--------
|
||||||
|
| | | | |
|
||||||
|
Off | +----+ +----+
|
||||||
|
|
|
||||||
|
2 On -|---------+ +-------------------+ +-------------
|
||||||
|
| | | | |
|
||||||
|
Off-| +----+ +----+
|
||||||
|
|
|
||||||
|
3 On -|--------------+ +---------+ +------------------
|
||||||
|
| | | | |
|
||||||
|
Off-| +----+ +----+
|
||||||
|
|
|
||||||
|
4 On -|-------------------+ +-----------------------
|
||||||
|
| | |
|
||||||
|
Off-| +---------+
|
||||||
|
|
|
||||||
|
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
|
||||||
27
Documentation/leds/leds-sc27xx.rst
Normal file
27
Documentation/leds/leds-sc27xx.rst
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
|
===================================
|
||||||
|
Kernel driver for Spreadtrum SC27XX
|
||||||
|
===================================
|
||||||
|
|
||||||
|
/sys/class/leds/<led>/hw_pattern
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
Specify a hardware pattern for the SC27XX LED. For the SC27XX
|
||||||
|
LED controller, it only supports 4 stages to make a single
|
||||||
|
hardware pattern, which is used to configure the rise time,
|
||||||
|
high time, fall time and low time for the breathing mode.
|
||||||
|
|
||||||
|
For the breathing mode, the SC27XX LED only expects one brightness
|
||||||
|
for the high stage. To be compatible with the hardware pattern
|
||||||
|
format, we should set brightness as 0 for rise stage, fall
|
||||||
|
stage and low stage.
|
||||||
|
|
||||||
|
- Min stage duration: 125 ms
|
||||||
|
- Max stage duration: 31875 ms
|
||||||
|
|
||||||
|
Since the stage duration step is 125 ms, the duration should be
|
||||||
|
a multiplier of 125, like 125ms, 250ms, 375ms, 500ms ... 31875ms.
|
||||||
|
|
||||||
|
Thus the format of the hardware pattern values should be:
|
||||||
|
"0 rise_duration brightness high_duration 0 fall_duration 0 low_duration".
|
||||||
Loading…
Reference in a new issue