lkml.org 
[lkml]   [2019]   [Apr]   [1]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[RFC PATCH 1/5] leds: multicolor: Add sysfs interface definition
Date
Add a documentation of LED Multicolor LED class specific
sysfs attributes.

Signed-off-by: Dan Murphy <dmurphy@ti.com>
---
.../ABI/testing/sysfs-class-led-multicolor | 91 +++++++++++++++++++
1 file changed, 91 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-class-led-multicolor

diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor b/Documentation/ABI/testing/sysfs-class-led-multicolor
new file mode 100644
index 000000000000..5583ecaa3170
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
@@ -0,0 +1,91 @@
+What: /sys/class/leds/<led>/colors/sync_enable
+Date: April 2019
+KernelVersion: 5.2
+Contact: Dan Murphy <dmurphy@ti.com>
+Description: read/write
+ Writing a 1 to this file will enable the synchronization of all
+ the defined color LEDs within the LED node. Brightness values
+ for each LED will be stored and written when sync is set to 1.
+ Writing a 0 to this file will disable syncing and allow
+ individual control of the LEDs brightness settings.
+
+What: /sys/class/leds/<led>/colors/sync
+Date: April 2019
+KernelVersion: 5.2
+Contact: Dan Murphy <dmurphy@ti.com>
+Description: write only
+ Writing a 1 to this file while sync_enable is set to 1 will
+ write the current brightness values to all defined LEDs within
+ the LED node. All LEDs defined will be configured based
+ on the brightness that has been requested.
+
+ If sync_enable is set to 0 then writing a 1 to sync has no
+ affect on the LEDs.
+
+What: /sys/class/leds/<led>/colors/<led_color>/brightness
+Date: April 2019
+KernelVersion: 5.2
+Contact: Dan Murphy <dmurphy@ti.com>
+Description: read/write
+ The led_color directory is dynamically created based on the
+ colors defined by the registrar of the class.
+ The led_color can be but not limited to red, green, blue,
+ white, amber, yellow and violet. Drivers can also declare a
+ LED color for presentation. There is one directory per color
+ presented. The brightness file is created under each
+ led_color directory and controls the individual LED color
+ setting.
+
+ If sync is enabled then writing the brightness value of the LED
+ is deferred until a 1 is written to
+ /sys/class/leds/<led>/color/sync. If syncing is
+ disabled then the LED brightness value will be written
+ immediately to the LED driver.
+
+ The value of the color is from 0 to
+ /sys/class/leds/<led>/colors/<led_color>/max_brightness.
+
+What: /sys/class/leds/<led>/colors/<led_color>/max_brightness
+Date: April 2019
+KernelVersion: 5.2
+Contact: Dan Murphy <dmurphy@ti.com>
+Description: read only
+ Maximum brightness level for the LED color, default is
+ 255 (LED_FULL).
+
+ If the LED does not support different brightness levels, this
+ should be 1.
+
+What: /sys/class/leds/<led>/brightness_model/<model_color>
+Date: April 2019
+KernelVersion: 5.2
+Contact: Jacek Anaszewski <j.anaszewski@samsung.com>
+Description: read/write
+ This directory contains the defined color models that are read
+ from the firmware node. The model color will be the read from
+ the firmware node. The model names should be a color that the
+ LED cluster can produce.
+
+What: /sys/class/leds/<led>/brightness_model/<model_color>/brightness
+Date: April 2019
+KernelVersion: 5.2
+Contact: Jacek Anaszewski <j.anaszewski@samsung.com>
+Description: read/write
+ Writing this file will initiate a synchronized write to the LED
+ cluster to produce the color output defined in the firmware node.
+
+ This value cannot exceed <model_color>/max_brightness.
+ Writing a 0 to this file will cause the LED cluster to turn off.
+
+ The sync and sync_enable files do not have an affect on this as
+ this is a real time update of the LED cluster.
+
+What: /sys/class/leds/<led>/brightness_model/<model_color>/max_brightness
+Date: April 2019
+KernelVersion: 5.2
+Contact: Jacek Anaszewski <j.anaszewski@samsung.com>
+Description: read
+ Reading this file will return the maximum number of brightness
+ levels that are defined in the firmware node for the model color.
+ It should be assumed that the levels are from 1 -> max_brightness
+ and the LED cluster brightness is increasing.
--
2.19.0
\
 
 \ /
  Last update: 2019-04-01 19:45    [W:0.101 / U:4.968 seconds]
©2003-2018 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site