1-*- org -*-
2
3It is somehow important to provide consistent interface to the
4userland. LED devices have one problem there, and that is naming of
5directories in /sys/class/leds. It would be nice if userland would
6just know right "name" for given LED function, but situation got more
7complex.
8
9Anyway, if backwards compatibility is not an issue, new code should
10use one of the "good" names from this list, and you should extend the
11list where applicable.
12
13Legacy names are listed, too; in case you are writing application that
14wants to use particular feature, you should probe for good name, first,
15but then try the legacy ones, too.
16
17Notice there's a list of functions in include/dt-bindings/leds/common.h .
18
19* Keyboards
20
21Good: "input*:*:capslock"
22Good: "input*:*:scrolllock"
23Good: "input*:*:numlock"
24Legacy: "shift-key-light" (Motorola Droid 4, capslock)
25
26Set of common keyboard LEDs, going back to PC AT or so.
27
28Legacy: "tpacpi::thinklight" (IBM/Lenovo Thinkpads)
29Legacy: "lp5523:kb{1,2,3,4,5,6}" (Nokia N900)
30
31Frontlight/backlight of main keyboard.
32
33Legacy: "button-backlight" (Motorola Droid 4)
34
35Some phones have touch buttons below screen; it is different from main
36keyboard. And this is their backlight.
37
38* Sound subsystem
39
40Good: "platform:*:mute"
41Good: "platform:*:micmute"
42
43LEDs on notebook body, indicating that sound input / output is muted.
44
45* System notification
46
47Legacy: "status-led:{red,green,blue}" (Motorola Droid 4)
48Legacy: "lp5523:{r,g,b}" (Nokia N900)
49
50Phones usually have multi-color status LED.
51
52* Power management
53
54Good: "platform:*:charging" (allwinner sun50i)
55
56* Screen
57
58Good: ":backlight" (Motorola Droid 4)
59