UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Mauro Carvalho Chehab 2020-10-30 08:40:53 +01:00 committed by Greg Kroah-Hartman
parent 637ae1fb5d
commit edef2fa297
2 changed files with 28 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Documentation/ABI/testing/sysfs-class-led
View File

@ -3,9 +3,26 @@ Date: March 2006
KernelVersion: 2.6.17 KernelVersion: 2.6.17
Contact: Richard Purdie <rpurdie@rpsys.net> Contact: Richard Purdie <rpurdie@rpsys.net>
Description: Description:
Set the brightness of the LED. Most LEDs don't Set the brightness of the LED.
have hardware brightness support, so will just be turned on for
non-zero brightness settings. The value is between 0 and 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. /sys/class/leds/<led>/max_brightness.
Writing 0 to this file clears active trigger. 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 Writing non-zero to this file while trigger is active changes the
top brightness trigger is going to use. top brightness trigger is going to use.
What: /sys/class/leds/<led>/max_brightness What: /sys/class/leds/<led>/max_brightness
Date: March 2006 Date: March 2006
KernelVersion: 2.6.17 KernelVersion: 2.6.17

23
Documentation/ABI/testing/sysfs-class-led-multicolor
View File

@ -1,20 +1,3 @@
What: /sys/class/leds/<led>/brightness
Date: March 2020
KernelVersion: 5.9
Contact: Dan Murphy <dmurphy@ti.com>
Description: read/write
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 of the LED is from 0 to
/sys/class/leds/<led>/max_brightness.
What: /sys/class/leds/<led>/multi_index What: /sys/class/leds/<led>/multi_index
Date: March 2020 Date: March 2020
@ -25,6 +8,9 @@ Description: read
as an array of strings as they are indexed in the as an array of strings as they are indexed in the
multi_intensity file. multi_intensity file.
For additional details please refer to
Documentation/leds/leds-class-multicolor.rst.
What: /sys/class/leds/<led>/multi_intensity What: /sys/class/leds/<led>/multi_intensity
Date: March 2020 Date: March 2020
KernelVersion: 5.9 KernelVersion: 5.9
@ -33,3 +19,6 @@ Description: read/write
This file contains array of integers. Order of components is This file contains array of integers. Order of components is
described by the multi_index array. The maximum intensity should described by the multi_index array. The maximum intensity should
not exceed /sys/class/leds/<led>/max_brightness. not exceed /sys/class/leds/<led>/max_brightness.
For additional details please refer to
Documentation/leds/leds-class-multicolor.rst.