Commit edef2fa2 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Greg Kroah-Hartman
Browse files

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: default avatarPavel Machek <pavel@ucw.cz>
Acked-by: default avatarJonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/1115022e7f172b19ee8610f2ad28cc2f0ca93592.1604042072.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 637ae1fb

Documentation/ABI/testing/sysfs-class-led

+22 −3
Original line number Diff line number Diff line
@@ -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

Documentation/ABI/testing/sysfs-class-led-multicolor

+6 −17
Original line number Diff line number Diff line 
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

Date:		March 2020
@@ -25,6 +8,9 @@ Description: read 
		as an array of strings as they are indexed in the

		multi_intensity file.



		For additional details please refer to

		Documentation/leds/leds-class-multicolor.rst.



What:		/sys/class/leds/<led>/multi_intensity

Date:		March 2020

KernelVersion:	5.9
@@ -33,3 +19,6 @@ Description: read/write 
		This file contains array of integers. Order of components is

		described by the multi_index array. The maximum intensity should

		not exceed /sys/class/leds/<led>/max_brightness.



		For additional details please refer to

		Documentation/leds/leds-class-multicolor.rst.

CRA Git | Maintained and supported by SUSTech CRA and CCSE