diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-10-30 10:40:53 +0300 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2020-10-30 15:14:48 +0300 |
| commit | edef2fa29739172643dbe9f44fb38d23793816d6 (patch) | |
| tree | cb74fff9a0d79b3633a13d7beb6751ea4c1101b5 /Documentation/ABI/testing/sysfs-class-led | |
| parent | 637ae1fb5dca38649eed31f943114486bacce416 (diff) | |
| download | linux-edef2fa29739172643dbe9f44fb38d23793816d6.tar.xz | |
docs: ABI: unify /sys/class/leds/<led>/brightness documentation
This ABI is defined twice, one for normal leds and another
one for multicolor ones.
Ensure that just one definition is there at ABI.
Acked-by: Pavel Machek <pavel@ucw.cz>
Acked-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/1115022e7f172b19ee8610f2ad28cc2f0ca93592.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/ABI/testing/sysfs-class-led')
| -rw-r--r-- | Documentation/ABI/testing/sysfs-class-led | 25 |
1 files changed, 22 insertions, 3 deletions
diff --git a/Documentation/ABI/testing/sysfs-class-led b/Documentation/ABI/testing/sysfs-class-led index 0ed5c2629c6f..2e24ac3bd7ef 100644 --- a/Documentation/ABI/testing/sysfs-class-led +++ b/Documentation/ABI/testing/sysfs-class-led @@ -3,9 +3,26 @@ Date: March 2006 KernelVersion: 2.6.17 Contact: Richard Purdie <rpurdie@rpsys.net> Description: - Set the brightness of the LED. Most LEDs don't - have hardware brightness support, so will just be turned on for - non-zero brightness settings. The value is between 0 and + Set the brightness of the LED. + + Most LEDs don't have hardware brightness support, so will + just be turned on for non-zero brightness settings. + + .. Note:: + + For multicolor LEDs, writing to this file will update all + LEDs within the group to a calculated percentage of what + each color LED intensity is set to. + + The percentage is calculated for each grouped LED via + the equation below:: + + led_brightness = brightness * multi_intensity/max_brightness + + For additional details please refer to + Documentation/leds/leds-class-multicolor.rst. + + The value is between 0 and /sys/class/leds/<led>/max_brightness. Writing 0 to this file clears active trigger. @@ -13,6 +30,8 @@ Description: Writing non-zero to this file while trigger is active changes the top brightness trigger is going to use. + + What: /sys/class/leds/<led>/max_brightness Date: March 2006 KernelVersion: 2.6.17 |