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

Jacek Anaszewski
2019-08-18T13:42:01Z

Hi Oleh,

On 8/8/19 10: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

Please change this label description to the below:

- function: see Documentation/devicetree/bindings/leds/common.txt.
- color: See Documentation/devicetree/bindings/leds/common.txt.
- label: See Documentation/devicetree/bindings/leds/common.txt (deprecated).

> +- linux,default-trigger :
> + see Documentation/devicetree/bindings/leds/common.txt
> +
> +Example
> +-------

#include <dt-bindings/leds/common.h>

> +led-controller@0 {
> + compatible = "crane,el15203000";
> + reg = <0>;
> + spi-max-frequency = <50000>;
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + /* water pipe */
> + pipe@50 {

s/pipe/led/

> + reg = <0x50>;
> + label = "red:pipe";

label is now deprecated.

Please use function and color:

function = "pipe";
color = <LED_COLOR_ID_RED>;

> + };
> +
> + /* screen frame */
> + screen@53 {

s/screen/led/

> + reg = <0x53>;
> + label = "red:screen";

function = "screen";
color = <LED_COLOR_ID_RED>;

> + };
> +
> + /* vending area */
> + vend@56 {

s/vend/led/

> + reg = <0x56>;
> + label = "red:vend";

function = "vend";
color = <LED_COLOR_ID_RED>;

> + };
> +};
>

--
Best regards,
Jacek Anaszewski