diff options
author | Pavel <pavel@ucw.cz> | 2018-12-01 15:32:13 +0100 |
---|---|---|
committer | Pavel <pavel@ucw.cz> | 2019-01-07 11:31:12 +0100 |
commit | e6bf14e7b3a1eb691bf04733a2a5d3501d6b11af (patch) | |
tree | c2fd23f7142342cb3a5b923cd3289e688d34e419 | |
parent | 3cdf32718a0e22172c787a6893593c4dd46a6a55 (diff) | |
download | linux-k-e6bf14e7b3a1eb691bf04733a2a5d3501d6b11af.tar.gz |
leds: Add list of well-known LED names
To: linux-doc@vger.kernel.org, l-k, jacek.anaszewski@gmail.com, linux-leds@vger.kernel.org
Signed-off-by: Pavel Machek <pavel@ucw.cz>
-rw-r--r-- | Documentation/leds/well-known-leds.txt | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/Documentation/leds/well-known-leds.txt b/Documentation/leds/well-known-leds.txt new file mode 100644 index 00000000000000..eb2e9d7c430a92 --- /dev/null +++ b/Documentation/leds/well-known-leds.txt @@ -0,0 +1,48 @@ +-*- org -*- + +It is somehow important to provide consistent interface to the +userland. LED devices have one problem there, and that is naming of +directories in /sys/class/leds. It would be nice if userland would +just know right "name" for given LED function, but situation got more +complex. + +Anyway, if backwards compatibility is not an issue, new code should +use one of the "good" names from this list, and you should extend the +list where applicable. + +Bad names are listed, too, in case you are writing application that +wants to use particular feature, you should probe for good name first +but then try the bad ones, too". + +* Keyboards + +Good: "input*:*:capslock" +Good: "input*:*:scrolllock" +Good: "input*:*:numlock" +Bad: "shift-key-light" (Motorola Droid 4, capslock) + +Set of common keyboard LEDs, going back to PC AT or so. + +Bad: "tpacpi::thinklight" (IBM/Lenovo Thinkpads) +Bad: "lp5523:kb{1,2,3,4,5,6}" (Nokia N900) + +Frontlight/backlight of main keyboard. + +Bad: "button-backlight" (Motorola Droid 4) + +Some phones have touch buttons below screen; it is different from main +keyboard. And this is their backlight. + +* Sound subsystem + +Good: "platform:*:mute" +Good: "platform:*:micmute" + +LEDs on notebook body, indicating that sound input / output is muted. + +* System notification + +Good: "status-led:{red,green,blue}" (Motorola Droid 4) +Bad: "lp5523:{r,g,b}" (Nokia N900) + +Phones usually have multi-color status LED. |