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