aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/leds-class.txt
diff options
context:
space:
mode:
authorCorentin Chary <corentincj@iksaif.net>2009-08-28 08:56:45 -0400
committerLen Brown <len.brown@intel.com>2009-08-28 15:21:12 -0400
commit5f634c6527249275df4199a294ee9cec2f3ff3b1 (patch)
tree44c2d69f6e28823a6c1c66683440d7ba2e3890a4 /Documentation/leds-class.txt
parent243ca3e401bc62e704785d215931f1a51fd53bd7 (diff)
led: document sysfs interface
Also fix Documentation/led-class.txt, the acceptable range of values for brightness is 0-max_brightness, not 0-255. Cc: Richard Purdie <rpurdie@rpsys.net> Signed-off-by: Corentin Chary <corentincj@iksaif.net> Signed-off-by: Len Brown <len.brown@intel.com>
Diffstat (limited to 'Documentation/leds-class.txt')
-rw-r--r--Documentation/leds-class.txt9
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/leds-class.txt b/Documentation/leds-class.txt
index 6399557cdab3..8fd5ca2ae32d 100644
--- a/Documentation/leds-class.txt
+++ b/Documentation/leds-class.txt
@@ -1,3 +1,4 @@
1
1LED handling under Linux 2LED handling under Linux
2======================== 3========================
3 4
@@ -5,10 +6,10 @@ If you're reading this and thinking about keyboard leds, these are
5handled by the input subsystem and the led class is *not* needed. 6handled by the input subsystem and the led class is *not* needed.
6 7
7In its simplest form, the LED class just allows control of LEDs from 8In its simplest form, the LED class just allows control of LEDs from
8userspace. LEDs appear in /sys/class/leds/. The brightness file will 9userspace. LEDs appear in /sys/class/leds/. The maximum brightness of the
9set the brightness of the LED (taking a value 0-255). Most LEDs don't 10LED is defined in max_brightness file. The brightness file will set the brightness
10have hardware brightness support so will just be turned on for non-zero 11of the LED (taking a value 0-max_brightness). Most LEDs don't have hardware
11brightness settings. 12brightness support so will just be turned on for non-zero brightness settings.
12 13
13The class also introduces the optional concept of an LED trigger. A trigger 14The class also introduces the optional concept of an LED trigger. A trigger
14is a kernel based source of led events. Triggers can either be simple or 15is a kernel based source of led events. Triggers can either be simple or