Skip to contentSkip to conversation

leds: core: add documentation for color extension

PATCH Superseded Heiner Kallweit 3 participants 4 messages Mar 1, 2016 – Mar 2, 2016

Subsystems (2)

v5 of 8 Superseded Latest is v8 →

lore
Share & tools
lore
#0 lore raw

PATCH v5 3/4 leds: core: add documentation for color extension

Document the color extension in Documentation/leds/leds-class.txt

---
v2:
- introduced to patch series
v3:
- document extension in more detail
v4:
- Better explain why flag LED_SET_HUE_SAT is needed v5:
- no changes

---
 Documentation/leds/leds-class.txt | 27 ++++++++++++++++++++++-----
 1 file changed, 22 insertions(+), 5 deletions(-)
Documentation/leds/leds-class.txt +22 -5
index d406d98..b1e4cba 100644
@@ -8,6 +8,22 @@ LED is defined in max_brightness file. The brightness file will set the brightne
 of the LED (taking a value 0-max_brightness). Most LEDs don't have hardware
 brightness support so will just be turned on for non-zero brightness settings.
 
+If a driver uses the colour extension of the LED core then the brightness
+file can be used to set hue / saturation / value. The brightness value is
+interpreted as: <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.
+However we might want to have the option to set all HSV components, even
+if hue and saturation both are 0 (e.g. via brightness sysfs attribute).
+Use case: Set color to white (hue = 0 and saturation = 0).
+Therefore the default behaviour can be overridden with flag F (LED_SET_HUE_SAT).
+If this flag is set then hue and saturation are not checked for being 0 and
+the color components are set unconditionally. Example:
+0x010000ff sets the LED to white color with full brightness.
+
 The class also introduces the optional concept of an LED trigger. A trigger
 is a kernel based source of led events. Triggers can either be simple or
 complex. A simple trigger isn't configurable and is designed to slot into
@@ -45,11 +61,12 @@ Is currently of the form:
 
 "devicename:colour:function"
 
-There have been calls for LED properties such as colour to be exported as
-individual led class attributes. As a solution which doesn't incur as much
-overhead, I suggest these become part of the device name. The naming scheme
-above leaves scope for further attributes should they be needed. If sections
-of the name don't apply, just leave that section blank.
+If the colour extension is used hsv / rgb can be used instead of a specific
+colour.  There have been calls for LED properties such as colour to be
+exported as individual led class attributes. As a solution which doesn't
+incur as much overhead, I suggest these become part of the device name.
+The naming scheme above leaves scope for further attributes should they be
+needed. If sections of the name don't apply, just leave that section blank.
 
 
 Brightness setting API
Signature · 1 line
2.7.1
#1 lore raw
Quoted 12 lines · Heiner Kallweit

Document the color extension in Documentation/leds/leds-class.txt

---
v2:
- introduced to patch series
v3:
- document extension in more detail
v4:
- Better explain why flag LED_SET_HUE_SAT is needed v5:
- no changes

Quoted 3 lines
---
 Documentation/leds/leds-class.txt | 27 ++++++++++++++++++++++-----
 1 file changed, 22 insertions(+), 5 deletions(-)

What aboud Documentation/ABI/ ?

#2 lore raw
Quoted 17 lines · Greg KH
Quoted 12 lines · Heiner Kallweit

Document the color extension in Documentation/leds/leds-class.txt

---
v2:
- introduced to patch series
v3:
- document extension in more detail
v4:
- Better explain why flag LED_SET_HUE_SAT is needed v5:
- no changes

Quoted 3 lines
---
  Documentation/leds/leds-class.txt | 27 ++++++++++++++++++++++-----
  1 file changed, 22 insertions(+), 5 deletions(-)
Quoted 3 lines

What aboud Documentation/ABI/ ?

Right, I haven't pushed for this so far, but now, as the functionality seems to be reaching its final shape, please update also:

Documentation/ABI/testing/sysfs-class-led

Signature · 2 lines
Best regards,
Jacek Anaszewski
#3 lore raw
Quoted 21 lines · Jacek Anaszewski
Quoted 20 lines · Greg KH
Quoted 16 lines · Heiner Kallweit

Document the color extension in Documentation/leds/leds-class.txt

---
v2:
- introduced to patch series
v3:
- document extension in more detail
v4:
- Better explain why flag LED_SET_HUE_SAT is needed v5:
- no changes

---
  Documentation/leds/leds-class.txt | 27 ++++++++++++++++++++++-----
  1 file changed, 22 insertions(+), 5 deletions(-)
Quoted 2 lines
Quoted 2 lines

What aboud Documentation/ABI/ ?

Thanks for the hint. Will update also this part of the documentation.

Quoted 11 lines
Quoted 1 line

Right, I haven't pushed for this so far, but now, as the functionality seems to be reaching its final shape, please update also:

Documentation/ABI/testing/sysfs-class-led

--
Best regards,
Jacek Anaszewski