leds: core: document ABI change for RGB extension

PATCH Superseded Heiner Kallweit 1 participant 1 message Mar 4, 2016 LED

lore

Share & tools

lore

Heiner Kallweit

author

2016-03-04 21:14 UTC #0 lore raw

PATCH v7 4/5 leds: core: document ABI change for RGB extension

Document the ABI change in Documentation/ABI/testing/sysfs-class-led.

Signed-off-by Heiner Kallweit <[email protected]>

---
v7:
- separated from patch 3

---
 Documentation/ABI/testing/sysfs-class-led | 11 +++++++++++
 1 file changed, 11 insertions(+)

Documentation/ABI/testing/sysfs-class-led +11 -0

index 3646ec8..20357d5 100644
@@ -7,6 +7,17 @@ Description:
 		have hardware brightness support so will just be turned on for
 		non-zero brightness settings. The value is between 0 and
 		/sys/class/leds/<led>/max_brightness.
+		If a driver uses the RGB LED feature then this attribute is
+		interpreted as a HSV color model value:
+		<0000000F><HHHHHHHH><SSSSSSSS><VVVVVVVV>
+		Usage of the least byte is identical to monochrome mode.
+		Saturation can be 0-255 and hue 0-251 (Colour circle is mapped
+		to 0-252). If hue and saturation both are 0 the current colour
+		is preserved and only the brightness is set. This ensures
+		backwards compatibility with monochrome mode, e.g. for
+		led_set_brightness() calls from triggers.
+		Flag F enables setting hue and saturation even if both are 0.
+		For details and examples see Documentation/leds/leds-class.txt
 
 What:		/sys/class/leds/<led>/max_brightness
 Date:		March 2006

Signature · 1 line

2.7.1