Skip to content

Commit 26a0755

Browse files
mchehabgregkh
mchehab
authored and
gregkh
committed
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 <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]> Link: https://lore.kernel.org/r/038e57881550550b298e598f8f9b7f20515cbe15.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <[email protected]>
1 parent bd6e844 commit 26a0755

File tree

6 files changed

+170
-159
lines changed

6 files changed

+170
-159
lines changed

‎Documentation/ABI/testing/sysfs-class-led-driver-el15203000‎

Lines changed: 0 additions & 135 deletions
Original file line numberDiff line numberDiff line change
@@ -1,138 +1,3 @@
1-
What: /sys/class/leds/<led>/hw_pattern
2-
Date: September 2019
3-
KernelVersion: 5.5
4-
Description:
5-
Specify a hardware pattern for the EL15203000 LED.
6-
The LEDs board supports only predefined patterns by firmware
7-
for specific LEDs.
8-
9-
Breathing mode for Screen frame light tube::
10-
11-
"0 4000 1 4000"
12-
13-
^
14-
|
15-
Max-| ---
16-
| / \
17-
| / \
18-
| / \ /
19-
| / \ /
20-
Min-|- ---
21-
|
22-
0------4------8--> time (sec)
23-
24-
Cascade mode for Pipe LED::
25-
26-
"1 800 2 800 4 800 8 800 16 800"
27-
28-
^
29-
|
30-
0 On -|----+ +----+ +---
31-
| | | | |
32-
Off-| +-------------------+ +-------------------+
33-
|
34-
1 On -| +----+ +----+
35-
| | | | |
36-
Off |----+ +-------------------+ +------------------
37-
|
38-
2 On -| +----+ +----+
39-
| | | | |
40-
Off-|---------+ +-------------------+ +-------------
41-
|
42-
3 On -| +----+ +----+
43-
| | | | |
44-
Off-|--------------+ +-------------------+ +--------
45-
|
46-
4 On -| +----+ +----+
47-
| | | | |
48-
Off-|-------------------+ +-------------------+ +---
49-
|
50-
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
51-
52-
Inverted cascade mode for Pipe LED::
53-
54-
"30 800 29 800 27 800 23 800 15 800"
55-
56-
^
57-
|
58-
0 On -| +-------------------+ +-------------------+
59-
| | | | |
60-
Off-|----+ +----+ +---
61-
|
62-
1 On -|----+ +-------------------+ +------------------
63-
| | | | |
64-
Off | +----+ +----+
65-
|
66-
2 On -|---------+ +-------------------+ +-------------
67-
| | | | |
68-
Off-| +----+ +----+
69-
|
70-
3 On -|--------------+ +-------------------+ +--------
71-
| | | | |
72-
Off-| +----+ +----+
73-
|
74-
4 On -|-------------------+ +-------------------+ +---
75-
| | | | |
76-
Off-| +----+ +----+
77-
|
78-
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
79-
80-
Bounce mode for Pipe LED::
81-
82-
"1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800"
83-
84-
^
85-
|
86-
0 On -|----+ +--------
87-
| | |
88-
Off-| +---------------------------------------+
89-
|
90-
1 On -| +----+ +----+
91-
| | | | |
92-
Off |----+ +-----------------------------+ +--------
93-
|
94-
2 On -| +----+ +----+
95-
| | | | |
96-
Off-|---------+ +-------------------+ +-------------
97-
|
98-
3 On -| +----+ +----+
99-
| | | | |
100-
Off-|--------------+ +---------+ +------------------
101-
|
102-
4 On -| +---------+
103-
| | |
104-
Off-|-------------------+ +-----------------------
105-
|
106-
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
107-
108-
Inverted bounce mode for Pipe LED::
109-
110-
"30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800"
111-
112-
^
113-
|
114-
0 On -| +---------------------------------------+
115-
| | |
116-
Off-|----+ +--------
117-
|
118-
1 On -|----+ +-----------------------------+ +--------
119-
| | | | |
120-
Off | +----+ +----+
121-
|
122-
2 On -|---------+ +-------------------+ +-------------
123-
| | | | |
124-
Off-| +----+ +----+
125-
|
126-
3 On -|--------------+ +---------+ +------------------
127-
| | | | |
128-
Off-| +----+ +----+
129-
|
130-
4 On -|-------------------+ +-----------------------
131-
| | |
132-
Off-| +---------+
133-
|
134-
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
135-
1361
What: /sys/class/leds/<led>/repeat
1372
Date: September 2019
1383
KernelVersion: 5.5

‎Documentation/ABI/testing/sysfs-class-led-driver-sc27xx‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎Documentation/ABI/testing/sysfs-class-led-trigger-pattern‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Description:
2323

2424
Since different LED hardware can have different semantics of
2525
hardware patterns, each driver is expected to provide its own
26-
description for the hardware patterns in their ABI documentation
27-
file.
26+
description for the hardware patterns in their documentation
27+
file at Documentation/leds/.
2828

2929
What: /sys/class/leds/<led>/repeat
3030
Date: September 2018

‎Documentation/leds/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ LEDs
1717
uleds
1818

1919
leds-blinkm
20+
leds-el15203000
2021
leds-lm3556
2122
leds-lp3944
2223
leds-lp5521

‎Documentation/leds/leds-el15203000.rst‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
==================================
4+
Kernel driver for Crane EL15203000
5+
==================================
6+
7+
/sys/class/leds/<led>/hw_pattern
8+
--------------------------------
9+
10+
Specify a hardware pattern for the EL15203000 LED.
11+
12+
The LEDs board supports only predefined patterns by firmware
13+
for specific LEDs.
14+
15+
Breathing mode for Screen frame light tube::
16+
17+
"0 4000 1 4000"
18+
19+
^
20+
|
21+
Max-| ---
22+
| / \
23+
| / \
24+
| / \ /
25+
| / \ /
26+
Min-|- ---
27+
|
28+
0------4------8--> time (sec)
29+
30+
Cascade mode for Pipe LED::
31+
32+
"1 800 2 800 4 800 8 800 16 800"
33+
34+
^
35+
|
36+
0 On -|----+ +----+ +---
37+
| | | | |
38+
Off-| +-------------------+ +-------------------+
39+
|
40+
1 On -| +----+ +----+
41+
| | | | |
42+
Off |----+ +-------------------+ +------------------
43+
|
44+
2 On -| +----+ +----+
45+
| | | | |
46+
Off-|---------+ +-------------------+ +-------------
47+
|
48+
3 On -| +----+ +----+
49+
| | | | |
50+
Off-|--------------+ +-------------------+ +--------
51+
|
52+
4 On -| +----+ +----+
53+
| | | | |
54+
Off-|-------------------+ +-------------------+ +---
55+
|
56+
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
57+
58+
Inverted cascade mode for Pipe LED::
59+
60+
"30 800 29 800 27 800 23 800 15 800"
61+
62+
^
63+
|
64+
0 On -| +-------------------+ +-------------------+
65+
| | | | |
66+
Off-|----+ +----+ +---
67+
|
68+
1 On -|----+ +-------------------+ +------------------
69+
| | | | |
70+
Off | +----+ +----+
71+
|
72+
2 On -|---------+ +-------------------+ +-------------
73+
| | | | |
74+
Off-| +----+ +----+
75+
|
76+
3 On -|--------------+ +-------------------+ +--------
77+
| | | | |
78+
Off-| +----+ +----+
79+
|
80+
4 On -|-------------------+ +-------------------+ +---
81+
| | | | |
82+
Off-| +----+ +----+
83+
|
84+
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
85+
86+
Bounce mode for Pipe LED::
87+
88+
"1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800"
89+
90+
^
91+
|
92+
0 On -|----+ +--------
93+
| | |
94+
Off-| +---------------------------------------+
95+
|
96+
1 On -| +----+ +----+
97+
| | | | |
98+
Off |----+ +-----------------------------+ +--------
99+
|
100+
2 On -| +----+ +----+
101+
| | | | |
102+
Off-|---------+ +-------------------+ +-------------
103+
|
104+
3 On -| +----+ +----+
105+
| | | | |
106+
Off-|--------------+ +---------+ +------------------
107+
|
108+
4 On -| +---------+
109+
| | |
110+
Off-|-------------------+ +-----------------------
111+
|
112+
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
113+
114+
Inverted bounce mode for Pipe LED::
115+
116+
"30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800"
117+
118+
^
119+
|
120+
0 On -| +---------------------------------------+
121+
| | |
122+
Off-|----+ +--------
123+
|
124+
1 On -|----+ +-----------------------------+ +--------
125+
| | | | |
126+
Off | +----+ +----+
127+
|
128+
2 On -|---------+ +-------------------+ +-------------
129+
| | | | |
130+
Off-| +----+ +----+
131+
|
132+
3 On -|--------------+ +---------+ +------------------
133+
| | | | |
134+
Off-| +----+ +----+
135+
|
136+
4 On -|-------------------+ +-----------------------
137+
| | |
138+
Off-| +---------+
139+
|
140+
0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)

‎Documentation/leds/leds-sc27xx.rst‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
===================================
4+
Kernel driver for Spreadtrum SC27XX
5+
===================================
6+
7+
/sys/class/leds/<led>/hw_pattern
8+
--------------------------------
9+
10+
Specify a hardware pattern for the SC27XX LED. For the SC27XX
11+
LED controller, it only supports 4 stages to make a single
12+
hardware pattern, which is used to configure the rise time,
13+
high time, fall time and low time for the breathing mode.
14+
15+
For the breathing mode, the SC27XX LED only expects one brightness
16+
for the high stage. To be compatible with the hardware pattern
17+
format, we should set brightness as 0 for rise stage, fall
18+
stage and low stage.
19+
20+
- Min stage duration: 125 ms
21+
- Max stage duration: 31875 ms
22+
23+
Since the stage duration step is 125 ms, the duration should be
24+
a multiplier of 125, like 125ms, 250ms, 375ms, 500ms ... 31875ms.
25+
26+
Thus the format of the hardware pattern values should be:
27+
"0 rise_duration brightness high_duration 0 fall_duration 0 low_duration".

0 commit comments

Comments
 (0)