From: Dan Murphy <dmurphy@ti.com>
To: Jacek Anaszewski <jacek.anaszewski@gmail.com>, <pavel@ucw.cz>
Cc: <linux-leds@vger.kernel.org>, <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH v4 1/9] leds: multicolor: Add sysfs interface definition
Date: Tue, 27 Aug 2019 11:54:22 -0500 [thread overview]
Message-ID: <bfcd15e3-ed94-fd16-9281-d49129c23abf@ti.com> (raw)
In-Reply-To: <c451847b-d08e-19a2-281c-70ba46cff29a@gmail.com>
Jacek
OK finally getting back to this.
On 7/29/19 3:45 PM, Jacek Anaszewski wrote:
> Hi Dan,
>
> Thank you for the v4.
>
> I have a bunch of comments below. Please take a look.
>
> On 7/25/19 8:28 PM, Dan Murphy wrote:
>> 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 | 67 +++++++++++++++++++
>> 1 file changed, 67 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..59839f0eae76
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
>> @@ -0,0 +1,67 @@
>> +What: /sys/class/leds/<led>/brightness
>> +Date: Sept 2019
>> +KernelVersion: TBD
>> +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. Please refer to the leds-class-multicolor.txt in the
>> + Documentation directory for a complete description.
> Instead of redirecting the reader to led-class-multicolor.txt I'd prefer
> to have at least the formula to calculate the colors laid out here.
> Aside of that - it is more helpful to have a full path to the referenced
> file.
Ack
>> +
>> + 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: TBD
>> +Contact: Dan Murphy<dmurphy@ti.com>
>> +Description: read/write
>> + The color_mix file allows writing all registered multicolor LEDs
>> + virtually at the same time. The value(s) written to this file
> I'd drop parentheses form "value(s)". Multi color LED class device is
> supposed to always have more then one LED. And if I understand it
> correctly we have to pass intensities of all colors supported by LED
> multicolor class device here, even we're changing single one.
Yes that is true.
>> + contain the intensity values for each multicolor LED within
>> + the colors directory. The color indexes are reported in the
>> + color_id file as defined in this document.
> This is a bit misleading. It sounds as if single color_id file would be
> reporting more than one index.
>
>> + Please refer to the leds-class-multicolor.txt in the
>> + Documentation directory for a complete description.
> Here, similarly as for brightness, I would prefer to have complete
> documentation of this file.
>
> How about:
>
> 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.
>
> And here we could have the examples from leds-class-multicolor.txt.
I prefer to keep the examples in the leds-class-multicolor.rst.
This is an ABI document not a document describing the code.
I updated the doc to what you have above.
>> +
>> +What: /sys/class/leds/<led>/colors/<led_color>/color_id
>> +Date: Sept 2019
>> +KernelVersion: TBD
>> +Contact: Dan Murphy<dmurphy@ti.com>
>> +Description: read only
>> + This file when read will return the index of the color in the
>> + color_mix.
>> + Please refer to the leds-class-multicolor.txt in the
>> + Documentation directory for a complete description.
>> +
>> +What: /sys/class/leds/<led>/colors/<led_color>/intensity
>> +Date: Sept 2019
>> +KernelVersion: TBD
>> +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
> Instead of this vague sentence about the available colors I propose to
> maintain the list of supported colors in leds-class.rst or in a separate
> file and keep it in sync with the led_colors array. Then we could refer
> to that file here.
I would rather point to the file that contains the colors. This way we
don't have added documentation
maintenance to add a new color.
>
>> + LED color for presentation. There is one directory per color
> I'd not let drivers define their custom colors. It would entail issues
> related to lack of generic LED_COLOR_ID and DT parsing failure.
Ack
Dan
>
>> + 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: TBD
>> +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.
>>
next prev parent reply other threads:[~2019-08-27 16:54 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-25 18:28 [PATCH v4 0/9] Multicolor Framwork Dan Murphy
2019-07-25 18:28 ` [PATCH v4 1/9] leds: multicolor: Add sysfs interface definition Dan Murphy
2019-07-29 20:45 ` Jacek Anaszewski
2019-08-27 16:54 ` Dan Murphy [this message]
2019-07-25 18:28 ` [PATCH v4 2/9] documention: leds: Add multicolor class documentation Dan Murphy
2019-07-29 20:46 ` Jacek Anaszewski
2019-07-25 18:28 ` [PATCH v4 3/9] dt: bindings: Add multicolor class dt bindings documention Dan Murphy
2019-07-29 20:47 ` Jacek Anaszewski
2019-07-25 18:28 ` [PATCH v4 4/9] dt-bindings: leds: Add multicolor ID to the color ID list Dan Murphy
2019-07-25 18:28 ` [PATCH v4 5/9] " Dan Murphy
2019-07-25 18:28 ` [PATCH v4 6/9] leds: multicolor: Introduce a multicolor class definition Dan Murphy
2019-07-29 20:50 ` Jacek Anaszewski
2019-07-31 19:06 ` Dan Murphy
2019-07-31 20:44 ` Jacek Anaszewski
2019-08-02 14:14 ` Dan Murphy
2019-08-02 19:27 ` Jacek Anaszewski
2019-07-25 18:28 ` [PATCH v4 7/9] dt: bindings: lp50xx: Introduce the lp50xx family of RGB drivers Dan Murphy
2019-07-25 18:28 ` [PATCH v4 8/9] leds: lp50xx: Add the LP50XX family of the RGB LED driver Dan Murphy
2019-07-30 21:24 ` Jacek Anaszewski
2019-07-31 18:46 ` Dan Murphy
2019-07-25 18:28 ` [PATCH v4 9/9] leds: Update the lp55xx to use the multi color framework Dan Murphy
2019-07-31 18:45 ` Jacek Anaszewski
2019-07-31 18:55 ` Dan Murphy
2019-07-31 19:45 ` Jacek Anaszewski
2019-07-31 19:49 ` 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=bfcd15e3-ed94-fd16-9281-d49129c23abf@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 \
/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).