aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRafał Miłecki <rafal@milecki.pl>2016-08-26 10:19:36 -0400
committerJacek Anaszewski <j.anaszewski@samsung.com>2016-08-29 09:06:32 -0400
commit1f70cb4045cba47287fed3ba98dadc7187f13ef8 (patch)
treeda23e6b36b40b6ec9b8a0975171a4ae25f82899b
parent1d1a77ddc8acfa3d506f1958e09a12085e71fc69 (diff)
Documentation: move oneshot trigger attributes documentation to ABI
Documentation of sysfs interface should be in ABI in the first place. This moves relevant part of documentation and mentions where to look for it. Fix trivial typos whilst we are at it. Signed-off-by: Rafał Miłecki <rafal@milecki.pl> Signed-off-by: Jacek Anaszewski <j.anaszewski@samsung.com>
-rw-r--r--Documentation/ABI/testing/sysfs-class-led3
-rw-r--r--Documentation/ABI/testing/sysfs-class-led-trigger-oneshot36
-rw-r--r--Documentation/leds/ledtrig-oneshot.txt20
3 files changed, 40 insertions, 19 deletions
diff --git a/Documentation/ABI/testing/sysfs-class-led b/Documentation/ABI/testing/sysfs-class-led
index 3646ec85d513..86ace287d48b 100644
--- a/Documentation/ABI/testing/sysfs-class-led
+++ b/Documentation/ABI/testing/sysfs-class-led
@@ -24,7 +24,8 @@ Description:
24 of led events. 24 of led events.
25 You can change triggers in a similar manner to the way an IO 25 You can change triggers in a similar manner to the way an IO
26 scheduler is chosen. Trigger specific parameters can appear in 26 scheduler is chosen. Trigger specific parameters can appear in
27 /sys/class/leds/<led> once a given trigger is selected. 27 /sys/class/leds/<led> once a given trigger is selected. For
28 their documentation see sysfs-class-led-trigger-*.
28 29
29What: /sys/class/leds/<led>/inverted 30What: /sys/class/leds/<led>/inverted
30Date: January 2011 31Date: January 2011
diff --git a/Documentation/ABI/testing/sysfs-class-led-trigger-oneshot b/Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
new file mode 100644
index 000000000000..378a3a4df3c8
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
@@ -0,0 +1,36 @@
1What: /sys/class/leds/<led>/delay_on
2Date: Jun 2012
3KernelVersion: 3.6
4Contact: linux-leds@vger.kernel.org
5Description:
6 Specifies for how many milliseconds the LED has to stay at
7 LED_FULL brightness after it has been armed.
8 Defaults to 100 ms.
9
10What: /sys/class/leds/<led>/delay_off
11Date: Jun 2012
12KernelVersion: 3.6
13Contact: linux-leds@vger.kernel.org
14Description:
15 Specifies for how many milliseconds the LED has to stay at
16 LED_OFF brightness after it has been armed.
17 Defaults to 100 ms.
18
19What: /sys/class/leds/<led>/invert
20Date: Jun 2012
21KernelVersion: 3.6
22Contact: linux-leds@vger.kernel.org
23Description:
24 Reverse the blink logic. If set to 0 (default) blink on for
25 delay_on ms, then blink off for delay_off ms, leaving the LED
26 normally off. If set to 1, blink off for delay_off ms, then
27 blink on for delay_on ms, leaving the LED normally on.
28 Setting this value also immediately changes the LED state.
29
30What: /sys/class/leds/<led>/shot
31Date: Jun 2012
32KernelVersion: 3.6
33Contact: linux-leds@vger.kernel.org
34Description:
35 Write any non-empty string to signal an events, this starts a
36 blink sequence if not already running.
diff --git a/Documentation/leds/ledtrig-oneshot.txt b/Documentation/leds/ledtrig-oneshot.txt
index 07cd1fa41a3a..fe57474a12e2 100644
--- a/Documentation/leds/ledtrig-oneshot.txt
+++ b/Documentation/leds/ledtrig-oneshot.txt
@@ -21,24 +21,8 @@ below:
21 21
22 echo oneshot > trigger 22 echo oneshot > trigger
23 23
24This adds the following sysfs attributes to the LED: 24This adds sysfs attributes to the LED that are documented in:
25 25Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
26 delay_on - specifies for how many milliseconds the LED has to stay at
27 LED_FULL brightness after it has been armed.
28 Default to 100 ms.
29
30 delay_off - specifies for how many milliseconds the LED has to stay at
31 LED_OFF brightness after it has been armed.
32 Default to 100 ms.
33
34 invert - reverse the blink logic. If set to 0 (default) blink on for delay_on
35 ms, then blink off for delay_off ms, leaving the LED normally off. If
36 set to 1, blink off for delay_off ms, then blink on for delay_on ms,
37 leaving the LED normally on.
38 Setting this value also immediately change the LED state.
39
40 shot - write any non-empty string to signal an events, this starts a blink
41 sequence if not already running.
42 26
43Example use-case: network devices, initialization: 27Example use-case: network devices, initialization:
44 28