2020-04-29 13:08:03

by Dan Murphy

[permalink] [raw]
Subject: [PATCH v22 01/16] dt: bindings: Add multicolor class dt bindings documention

Add DT bindings for the LEDs multicolor class framework.
Add multicolor ID to the color ID list for device tree bindings.

CC: Rob Herring <[email protected]>
Acked-by: Pavel Machek <[email protected]>
Signed-off-by: Dan Murphy <[email protected]>
---
.../bindings/leds/leds-class-multicolor.yaml | 34 +++++++++++++++++++
drivers/leds/led-core.c | 1 +
include/dt-bindings/leds/common.h | 3 +-
3 files changed, 37 insertions(+), 1 deletion(-)
create mode 100644 Documentation/devicetree/bindings/leds/leds-class-multicolor.yaml

diff --git a/Documentation/devicetree/bindings/leds/leds-class-multicolor.yaml b/Documentation/devicetree/bindings/leds/leds-class-multicolor.yaml
new file mode 100644
index 000000000000..3d4f23d07440
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/leds-class-multicolor.yaml
@@ -0,0 +1,34 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/leds/leds-class-multicolor.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Common properties for the multicolor LED class.
+
+maintainers:
+ - Dan Murphy <[email protected]>
+
+description: |
+ Bindings for multi color LEDs show how to describe current outputs of
+ either integrated multi-color LED elements (like RGB, RGBW, RGBWA-UV
+ etc.) or standalone LEDs, to achieve logically grouped multi-color LED
+ modules. This is achieved by adding multi-led nodes layer to the
+ monochrome LED bindings.
+ The nodes and properties defined in this document are unique to the multicolor
+ LED class. Common LED nodes and properties are inherited from the common.txt
+ within this documentation directory.
+
+properties:
+ color:
+ description: |
+ For multicolor LED support this property should be defined as
+ LED_COLOR_ID_MULTI and further definition can be found in
+ include/linux/leds/common.h.
+
+required:
+ - color
+
+additionalProperties: false
+
+...
diff --git a/drivers/leds/led-core.c b/drivers/leds/led-core.c
index f1f718dbe0f8..846248a0693d 100644
--- a/drivers/leds/led-core.c
+++ b/drivers/leds/led-core.c
@@ -34,6 +34,7 @@ const char * const led_colors[LED_COLOR_ID_MAX] = {
[LED_COLOR_ID_VIOLET] = "violet",
[LED_COLOR_ID_YELLOW] = "yellow",
[LED_COLOR_ID_IR] = "ir",
+ [LED_COLOR_ID_MULTI] = "multicolor",
};
EXPORT_SYMBOL_GPL(led_colors);

diff --git a/include/dt-bindings/leds/common.h b/include/dt-bindings/leds/common.h
index 0ce7dfc00dcb..a463ce6a8794 100644
--- a/include/dt-bindings/leds/common.h
+++ b/include/dt-bindings/leds/common.h
@@ -30,7 +30,8 @@
#define LED_COLOR_ID_VIOLET 5
#define LED_COLOR_ID_YELLOW 6
#define LED_COLOR_ID_IR 7
-#define LED_COLOR_ID_MAX 8
+#define LED_COLOR_ID_MULTI 8
+#define LED_COLOR_ID_MAX 9

/* Standard LED functions */
/* Keyboard LEDs, usually it would be input4::capslock etc. */
--
2.25.1


2020-04-29 15:39:31

by Jacek Anaszewski

[permalink] [raw]
Subject: Re: [PATCH v22 01/16] dt: bindings: Add multicolor class dt bindings documention

Hi Dan,

Thanks for the conversion, but now the binding example is missing.
In Documentation/devicetree/bindings/leds/common.yaml we do have
examples.

Best regards,
Jacek Anaszewski

On 4/29/20 2:56 PM, Dan Murphy wrote:
> Add DT bindings for the LEDs multicolor class framework.
> Add multicolor ID to the color ID list for device tree bindings.
>
> CC: Rob Herring <[email protected]>
> Acked-by: Pavel Machek <[email protected]>
> Signed-off-by: Dan Murphy <[email protected]>
> ---
> .../bindings/leds/leds-class-multicolor.yaml | 34 +++++++++++++++++++
> drivers/leds/led-core.c | 1 +
> include/dt-bindings/leds/common.h | 3 +-
> 3 files changed, 37 insertions(+), 1 deletion(-)
> create mode 100644 Documentation/devicetree/bindings/leds/leds-class-multicolor.yaml
>
> diff --git a/Documentation/devicetree/bindings/leds/leds-class-multicolor.yaml b/Documentation/devicetree/bindings/leds/leds-class-multicolor.yaml
> new file mode 100644
> index 000000000000..3d4f23d07440
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/leds-class-multicolor.yaml
> @@ -0,0 +1,34 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/leds/leds-class-multicolor.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Common properties for the multicolor LED class.
> +
> +maintainers:
> + - Dan Murphy <[email protected]>
> +
> +description: |
> + Bindings for multi color LEDs show how to describe current outputs of
> + either integrated multi-color LED elements (like RGB, RGBW, RGBWA-UV
> + etc.) or standalone LEDs, to achieve logically grouped multi-color LED
> + modules. This is achieved by adding multi-led nodes layer to the
> + monochrome LED bindings.
> + The nodes and properties defined in this document are unique to the multicolor
> + LED class. Common LED nodes and properties are inherited from the common.txt
> + within this documentation directory.
> +
> +properties:
> + color:
> + description: |
> + For multicolor LED support this property should be defined as
> + LED_COLOR_ID_MULTI and further definition can be found in
> + include/linux/leds/common.h.
> +
> +required:
> + - color
> +
> +additionalProperties: false
> +
> +...
> diff --git a/drivers/leds/led-core.c b/drivers/leds/led-core.c
> index f1f718dbe0f8..846248a0693d 100644
> --- a/drivers/leds/led-core.c
> +++ b/drivers/leds/led-core.c
> @@ -34,6 +34,7 @@ const char * const led_colors[LED_COLOR_ID_MAX] = {
> [LED_COLOR_ID_VIOLET] = "violet",
> [LED_COLOR_ID_YELLOW] = "yellow",
> [LED_COLOR_ID_IR] = "ir",
> + [LED_COLOR_ID_MULTI] = "multicolor",
> };
> EXPORT_SYMBOL_GPL(led_colors);
>
> diff --git a/include/dt-bindings/leds/common.h b/include/dt-bindings/leds/common.h
> index 0ce7dfc00dcb..a463ce6a8794 100644
> --- a/include/dt-bindings/leds/common.h
> +++ b/include/dt-bindings/leds/common.h
> @@ -30,7 +30,8 @@
> #define LED_COLOR_ID_VIOLET 5
> #define LED_COLOR_ID_YELLOW 6
> #define LED_COLOR_ID_IR 7
> -#define LED_COLOR_ID_MAX 8
> +#define LED_COLOR_ID_MULTI 8
> +#define LED_COLOR_ID_MAX 9
>
> /* Standard LED functions */
> /* Keyboard LEDs, usually it would be input4::capslock etc. */
>

2020-04-29 15:53:28

by Dan Murphy

[permalink] [raw]
Subject: Re: [PATCH v22 01/16] dt: bindings: Add multicolor class dt bindings documention

Jacek

On 4/29/20 10:37 AM, Jacek Anaszewski wrote:
> Hi Dan,
>
> Thanks for the conversion, but now the binding example is missing.
> In Documentation/devicetree/bindings/leds/common.yaml we do have
> examples.
>
I have looked at a few recent examples of yaml files (rohm,bd71828-leds
and max77650) and there are no examples.

I am not sure if examples are required but more of a nice to have
especially for peripherals.

But additionalProperties: false is required

I can add a really basic example but I thought the intent of the
examples was to derive a sample dts.

Dan

2020-04-29 17:02:58

by Dan Murphy

[permalink] [raw]
Subject: Re: [PATCH v22 01/16] dt: bindings: Add multicolor class dt bindings documention

Jacek

On 4/29/20 10:44 AM, Dan Murphy wrote:
> Jacek
>
> On 4/29/20 10:37 AM, Jacek Anaszewski wrote:
>> Hi Dan,
>>
>> Thanks for the conversion, but now the binding example is missing.
>> In Documentation/devicetree/bindings/leds/common.yaml we do have
>> examples.
>>
> I have looked at a few recent examples of yaml files
> (rohm,bd71828-leds and max77650) and there are no examples.
>
> I am not sure if examples are required but more of a nice to have
> especially for peripherals.
>
> But additionalProperties: false is required
>
> I can add a really basic example but I thought the intent of the
> examples was to derive a sample dts.
>
I added examples to both the multicolor yaml and the LP50xx yaml.

I will post v23 tomorrow to give this series some soak time.

Dan


> Dan
>