Re: [PATCH v4 1/2] dt-bindings: Add docs for EL15203000

[Jacek Anaszewski <jacek.anaszewski@gmail.com>]

Dan,

On 8/13/19 10:31 PM, Dan Murphy wrote:
> Jacek
> 
> Need your input below
> 
> On 8/8/19 3:32 PM, Oleh Kravchenko wrote:
>> Add documentation and example for dt-bindings EL15203000.
>> LED board (aka RED LED board) from Crane Merchandising Systems.
>>
>> Signed-off-by: Oleh Kravchenko <oleg@kaa.org.ua>
>> ---
>>   .../bindings/leds/leds-el15203000.txt         | 47 +++++++++++++++++++
>>   1 file changed, 47 insertions(+)
>>   create mode 100644
>> Documentation/devicetree/bindings/leds/leds-el15203000.txt
>>
>> diff --git
>> a/Documentation/devicetree/bindings/leds/leds-el15203000.txt
>> b/Documentation/devicetree/bindings/leds/leds-el15203000.txt
>> new file mode 100644
>> index 000000000000..4c2245babfdc
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/leds/leds-el15203000.txt
>> @@ -0,0 +1,47 @@
>> +Crane Merchandising System - el15203000 LED driver
>> +--------------------------------------------------
>> +
>> +This LED Board (aka RED LEDs board) is widely used in
>> +coffee vending machines produced by Crane Merchandising Systems.
>> +
>> +Required properties:
>> +- compatible : "crane,el15203000"
>> +- reg :
>> +    see Documentation/devicetree/bindings/spi/spi-bus.txt
>> +- spi-max-frequency : (optional)
>> +    see Documentation/devicetree/bindings/spi/spi-bus.txt
>> +
>> +Optional LED sub-node properties:
>> +- label :
>> +    see Documentation/devicetree/bindings/leds/common.txt
>> +- linux,default-trigger :
>> +    see Documentation/devicetree/bindings/leds/common.txt
>> +
>> +Example
>> +-------
>> +
>> +led-controller@0 {
>> +    compatible = "crane,el15203000";
>> +    reg = <0>;
>> +    spi-max-frequency = <50000>;
>> +    #address-cells = <1>;
>> +    #size-cells = <0>;
>> +
>> +    /* water pipe */
>> +    pipe@50 {
>> +        reg = <0x50>;
>> +        label = "red:pipe";
> 
> Should we use the color and function property here?

Yes, label is already deprecated in the common LED bindings
in linux-next. We need separate color and function here.

> Not sure what function would be for pipe, screen or vending but there
> may be
> 
> comparable functions that may fit.

These are functions specific to this board and it is not something
that could have some vast system-wide use. Common LED functions aim
rather to unify the naming for LEDs on standard system devices and
peripherals.

I'd not strive for creating common LED_FUNCTION macros for these.

-- 
Best regards,
Jacek Anaszewski