mirror of
https://github.com/torvalds/linux
synced 2024-09-06 18:01:05 +00:00
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>
This commit is contained in:
parent
1d1a77ddc8
commit
1f70cb4045
|
@ -24,7 +24,8 @@ Description:
|
|||
of led events.
|
||||
You can change triggers in a similar manner to the way an IO
|
||||
scheduler is chosen. Trigger specific parameters can appear in
|
||||
/sys/class/leds/<led> once a given trigger is selected.
|
||||
/sys/class/leds/<led> once a given trigger is selected. For
|
||||
their documentation see sysfs-class-led-trigger-*.
|
||||
|
||||
What: /sys/class/leds/<led>/inverted
|
||||
Date: January 2011
|
||||
|
|
36
Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
Normal file
36
Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
Normal file
|
@ -0,0 +1,36 @@
|
|||
What: /sys/class/leds/<led>/delay_on
|
||||
Date: Jun 2012
|
||||
KernelVersion: 3.6
|
||||
Contact: linux-leds@vger.kernel.org
|
||||
Description:
|
||||
Specifies for how many milliseconds the LED has to stay at
|
||||
LED_FULL brightness after it has been armed.
|
||||
Defaults to 100 ms.
|
||||
|
||||
What: /sys/class/leds/<led>/delay_off
|
||||
Date: Jun 2012
|
||||
KernelVersion: 3.6
|
||||
Contact: linux-leds@vger.kernel.org
|
||||
Description:
|
||||
Specifies for how many milliseconds the LED has to stay at
|
||||
LED_OFF brightness after it has been armed.
|
||||
Defaults to 100 ms.
|
||||
|
||||
What: /sys/class/leds/<led>/invert
|
||||
Date: Jun 2012
|
||||
KernelVersion: 3.6
|
||||
Contact: linux-leds@vger.kernel.org
|
||||
Description:
|
||||
Reverse the blink logic. If set to 0 (default) blink on for
|
||||
delay_on ms, then blink off for delay_off ms, leaving the LED
|
||||
normally off. If set to 1, blink off for delay_off ms, then
|
||||
blink on for delay_on ms, leaving the LED normally on.
|
||||
Setting this value also immediately changes the LED state.
|
||||
|
||||
What: /sys/class/leds/<led>/shot
|
||||
Date: Jun 2012
|
||||
KernelVersion: 3.6
|
||||
Contact: linux-leds@vger.kernel.org
|
||||
Description:
|
||||
Write any non-empty string to signal an events, this starts a
|
||||
blink sequence if not already running.
|
|
@ -21,24 +21,8 @@ below:
|
|||
|
||||
echo oneshot > trigger
|
||||
|
||||
This adds the following sysfs attributes to the LED:
|
||||
|
||||
delay_on - specifies for how many milliseconds the LED has to stay at
|
||||
LED_FULL brightness after it has been armed.
|
||||
Default to 100 ms.
|
||||
|
||||
delay_off - specifies for how many milliseconds the LED has to stay at
|
||||
LED_OFF brightness after it has been armed.
|
||||
Default to 100 ms.
|
||||
|
||||
invert - reverse the blink logic. If set to 0 (default) blink on for delay_on
|
||||
ms, then blink off for delay_off ms, leaving the LED normally off. If
|
||||
set to 1, blink off for delay_off ms, then blink on for delay_on ms,
|
||||
leaving the LED normally on.
|
||||
Setting this value also immediately change the LED state.
|
||||
|
||||
shot - write any non-empty string to signal an events, this starts a blink
|
||||
sequence if not already running.
|
||||
This adds sysfs attributes to the LED that are documented in:
|
||||
Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
|
||||
|
||||
Example use-case: network devices, initialization:
|
||||
|
||||
|
|
Loading…
Reference in a new issue