From: Dan Murphy <dmurphy@ti.com>
To: <jacek.anaszewski@gmail.com>, <pavel@ucw.cz>
Cc: <robh+dt@kernel.org>, <linux-leds@vger.kernel.org>,
<linux-kernel@vger.kernel.org>, Dan Murphy <dmurphy@ti.com>
Subject: [PATCH v5 1/9] leds: multicolor: Add sysfs interface definition
Date: Wed, 11 Sep 2019 13:01:07 -0500 [thread overview]
Message-ID: <20190911180115.21035-2-dmurphy@ti.com> (raw)
In-Reply-To: <20190911180115.21035-1-dmurphy@ti.com>
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 | 73 +++++++++++++++++++
1 file changed, 73 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..4ea54c2ad4c8
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
@@ -0,0 +1,73 @@
+What: /sys/class/leds/<led>/brightness
+Date: Sept 2019
+KernelVersion: 5.5
+Contact: Dan Murphy <dmurphy@ti.com>
+Description: read/write
+ The multicolor class will redirect the device drivers call back
+ function for brightness control to the multicolor class
+ brightness control function.
+
+ Writing to this file will update all LEDs within the group to a
+ calculated percentage of what each color LED in the group is set
+ to. The percentage is calculated via the equation below:
+
+ led_brightness = requested_value * led_color_intensity/led_color_max_intensity
+
+ For additional details please refer to
+ Documentation/leds/leds-class-multicolor.rst.
+
+ The value of the color is from 0 to
+ /sys/class/leds/<led>/max_brightness.
+
+What: /sys/class/leds/<led>/colors/color_mix
+Date: Sept 2019
+KernelVersion: 5.5
+Contact: Dan Murphy <dmurphy@ti.com>
+Description: read/write
+ The values written to this file should contain the intensity
+ values of each multicolor LED within the colors directory. The
+ index of given color is reported by the color_id file present in
+ colors/<color> directory. The index determines the position in
+ the sequence of intensities on which the related intensity
+ should be passed to this file.
+
+ For additional details please refer to
+ Documentation/leds/leds-class-multicolor.rst.
+
+What: /sys/class/leds/<led>/colors/<led_color>/color_id
+Date: Sept 2019
+KernelVersion: 5.5
+Contact: Dan Murphy <dmurphy@ti.com>
+Description: read only
+ This file when read will return the index of the color in the
+ color_mix.
+
+ For additional details please refer to
+ Documentation/leds/leds-class-multicolor.rst.
+
+What: /sys/class/leds/<led>/colors/<led_color>/intensity
+Date: Sept 2019
+KernelVersion: 5.5
+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. There is one directory per color
+ presented. The brightness file is created under each
+ led_color directory and controls the individual LED color
+ setting.
+
+ The value of the color is from 0 to
+ /sys/class/leds/<led>/colors/<led_color>/max_intensity.
+
+What: /sys/class/leds/<led>/colors/<led_color>/max_intensity
+Date: Sept 2019
+KernelVersion: 5.5
+Contact: Dan Murphy <dmurphy@ti.com>
+Description: read only
+ Maximum intensity level for the LED color, default is
+ 255 (LED_FULL).
+
+ If the LED does not support different intensity levels, this
+ should be 1.
--
2.22.0.214.g8dca754b1e
next prev parent reply other threads:[~2019-09-11 18:01 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-09-11 18:01 [PATCH v5 0/9] Multicolor FW update Dan Murphy
2019-09-11 18:01 ` Dan Murphy [this message]
2019-09-15 13:57 ` [PATCH v5 1/9] leds: multicolor: Add sysfs interface definition Jacek Anaszewski
2019-09-16 13:56 ` Dan Murphy
2019-09-16 18:31 ` Jacek Anaszewski
2019-09-11 18:01 ` [PATCH v5 2/9] documention: leds: Add multicolor class documentation Dan Murphy
2019-09-12 20:55 ` Pavel Machek
2019-09-13 2:09 ` Dan Murphy
2019-09-15 12:45 ` Jacek Anaszewski
2019-09-11 18:01 ` [PATCH v5 3/9] dt: bindings: Add multicolor class dt bindings documention Dan Murphy
2019-09-15 14:01 ` Jacek Anaszewski
2019-09-16 13:58 ` Dan Murphy
2019-09-11 18:01 ` [PATCH v5 4/9] dt-bindings: leds: Add multicolor ID to the color ID list Dan Murphy
2019-09-11 18:01 ` [PATCH v5 5/9] " Dan Murphy
2019-09-11 18:01 ` [PATCH v5 6/9] leds: multicolor: Introduce a multicolor class definition Dan Murphy
2019-09-15 16:20 ` Jacek Anaszewski
2019-09-16 14:04 ` Dan Murphy
2019-09-16 18:34 ` Dan Murphy
2019-09-16 20:18 ` Jacek Anaszewski
2019-09-11 18:01 ` [PATCH v5 7/9] dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers Dan Murphy
2019-09-11 18:01 ` [PATCH v5 8/9] leds: lp50xx: Add the LP50XX family of the RGB LED driver Dan Murphy
2019-09-11 18:01 ` [PATCH v5 9/9] leds: Update the lp55xx to use the multi color framework Dan Murphy
2019-09-15 16:28 ` Jacek Anaszewski
2019-09-16 14:03 ` Dan Murphy
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190911180115.21035-2-dmurphy@ti.com \
--to=dmurphy@ti.com \
--cc=jacek.anaszewski@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-leds@vger.kernel.org \
--cc=pavel@ucw.cz \
--cc=robh+dt@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).