diff mbox series

dt-bindings: leds: Expand LED_COLOR_ID definitions

Message ID 7c688821-140b-4b05-651b-337f602dc1fe@schinagl.nl
State Changes Requested, archived
Headers show
Series dt-bindings: leds: Expand LED_COLOR_ID definitions | expand

Checks

Context Check Description
robh/checkpatch warning total: 17 errors, 3 warnings, 33 lines checked
robh/patch-applied fail build log

Commit Message

Olliver Schinagl Aug. 10, 2022, 11:07 a.m. UTC
In commit 853a78a7d6c7 (dt-bindings: leds: Add LED_COLOR_ID definitions,
Sun Jun 9 20:19:04 2019 +0200) the most basic color definitions where
added. However, there's a little more very common LED colors.

While the documentation states 'add what is missing', engineers tend to
be lazy and will just use what currently exists. So this patch will take
(a) list from online retailers [0], [1], [2] and use the common LED 
colors from
there, this being reasonable as this is what is currently available to 
purchase.

Note, that LIME seems to be the modern take to 'Yellow-green' or
'Yellowish-green' from some older datasheets.

[0]: https://www.digikey.com/en/products/filter/led-lighting-color/125
[1]: 
https://eu.mouser.com/c/optoelectronics/led-lighting/led-emitters/standard-leds-smd
[2]: 
https://nl.farnell.com/en-NL/c/optoelectronics-displays/led-products/standard-single-colour-leds-under-75ma

Signed-off-by: Olliver Schinagl <oliver@schinagl.nl>
---
  include/dt-bindings/leds/common.h | 28 ++++++++++++++++------------
  1 file changed, 16 insertions(+), 12 deletions(-)

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

Comments

Krzysztof Kozlowski Aug. 10, 2022, 1:27 p.m. UTC | #1
On 10/08/2022 14:07, Olliver Schinagl wrote:
> In commit 853a78a7d6c7 (dt-bindings: leds: Add LED_COLOR_ID definitions,
> Sun Jun 9 20:19:04 2019 +0200) the most basic color definitions where
> added. However, there's a little more very common LED colors.
> 
> While the documentation states 'add what is missing', engineers tend to
> be lazy and will just use what currently exists. So this patch will take
> (a) list from online retailers [0], [1], [2] and use the common LED 
> colors from
> there, this being reasonable as this is what is currently available to 
> purchase.
> 
> Note, that LIME seems to be the modern take to 'Yellow-green' or
> 'Yellowish-green' from some older datasheets.
> 
> [0]: https://www.digikey.com/en/products/filter/led-lighting-color/125
> [1]: 
> https://eu.mouser.com/c/optoelectronics/led-lighting/led-emitters/standard-leds-smd
> [2]: 
> https://nl.farnell.com/en-NL/c/optoelectronics-displays/led-products/standard-single-colour-leds-under-75ma
> 
> Signed-off-by: Olliver Schinagl <oliver@schinagl.nl>
> ---
>   include/dt-bindings/leds/common.h | 28 ++++++++++++++++------------
>   1 file changed, 16 insertions(+), 12 deletions(-)
> 
> diff --git a/include/dt-bindings/leds/common.h 
> b/include/dt-bindings/leds/common.h
> index 3be89a7c20a9..1d9b955267cc 100644
> --- a/include/dt-bindings/leds/common.h
> +++ b/include/dt-bindings/leds/common.h
> @@ -22,18 +22,22 @@
>   #define LEDS_BOOST_FIXED    2
> 
>   /* Standard LED colors */
> -#define LED_COLOR_ID_WHITE    0
> -#define LED_COLOR_ID_RED    1
> -#define LED_COLOR_ID_GREEN    2
> -#define LED_COLOR_ID_BLUE    3
> -#define LED_COLOR_ID_AMBER    4
> -#define LED_COLOR_ID_VIOLET    5
> -#define LED_COLOR_ID_YELLOW    6
> -#define LED_COLOR_ID_IR        7
> -#define LED_COLOR_ID_MULTI    8    /* For multicolor LEDs */
> -#define LED_COLOR_ID_RGB    9    /* For multicolor LEDs that can do 
> arbitrary color,
> -                       so this would include RGBW and similar */
> -#define LED_COLOR_ID_MAX    10
> +#define LED_COLOR_ID_WHITE      0
> +#define LED_COLOR_ID_RED        1
> +#define LED_COLOR_ID_YELLOW     2
> +#define LED_COLOR_ID_BLUE       3
> +#define LED_COLOR_ID_AMBER      4
> +#define LED_COLOR_ID_GREEN      5
> +#define LED_COLOR_ID_VIOLET     6
> +#define LED_COLOR_ID_PUPRPLE    7
> +#define LED_COLOR_ID_ORANGE     8
> +#define LED_COLOR_ID_PINK       9
> +#define LED_COLOR_ID_CYAN      10
> +#define LED_COLOR_ID_LIME      11

All this is a incompatible bindings change, so shortly ABI break. You
cannot change defines. Feel free to add new ones.

Best regards,
Krzysztof
Olliver Schinagl Aug. 10, 2022, 5:08 p.m. UTC | #2
Hey Krzysztof,

On 10-08-2022 15:27, Krzysztof Kozlowski wrote:
> On 10/08/2022 14:07, Olliver Schinagl wrote:
>> In commit 853a78a7d6c7 (dt-bindings: leds: Add LED_COLOR_ID definitions,
>> Sun Jun 9 20:19:04 2019 +0200) the most basic color definitions where
>> added. However, there's a little more very common LED colors.
>>
>> While the documentation states 'add what is missing', engineers tend to
>> be lazy and will just use what currently exists. So this patch will take
>> (a) list from online retailers [0], [1], [2] and use the common LED
>> colors from
>> there, this being reasonable as this is what is currently available to
>> purchase.
>>
>> Note, that LIME seems to be the modern take to 'Yellow-green' or
>> 'Yellowish-green' from some older datasheets.
>>
>> [0]: https://www.digikey.com/en/products/filter/led-lighting-color/125
>> [1]:
>> https://eu.mouser.com/c/optoelectronics/led-lighting/led-emitters/standard-leds-smd
>> [2]:
>> https://nl.farnell.com/en-NL/c/optoelectronics-displays/led-products/standard-single-colour-leds-under-75ma
>>
>> Signed-off-by: Olliver Schinagl <oliver@schinagl.nl>
>> ---
>>    include/dt-bindings/leds/common.h | 28 ++++++++++++++++------------
>>    1 file changed, 16 insertions(+), 12 deletions(-)
>>
>> diff --git a/include/dt-bindings/leds/common.h
>> b/include/dt-bindings/leds/common.h
>> index 3be89a7c20a9..1d9b955267cc 100644
>> --- a/include/dt-bindings/leds/common.h
>> +++ b/include/dt-bindings/leds/common.h
>> @@ -22,18 +22,22 @@
>>    #define LEDS_BOOST_FIXED    2
>>
>>    /* Standard LED colors */
>> -#define LED_COLOR_ID_WHITE    0
>> -#define LED_COLOR_ID_RED    1
>> -#define LED_COLOR_ID_GREEN    2
>> -#define LED_COLOR_ID_BLUE    3
>> -#define LED_COLOR_ID_AMBER    4
>> -#define LED_COLOR_ID_VIOLET    5
>> -#define LED_COLOR_ID_YELLOW    6
>> -#define LED_COLOR_ID_IR        7
>> -#define LED_COLOR_ID_MULTI    8    /* For multicolor LEDs */
>> -#define LED_COLOR_ID_RGB    9    /* For multicolor LEDs that can do
>> arbitrary color,
>> -                       so this would include RGBW and similar */
>> -#define LED_COLOR_ID_MAX    10
>> +#define LED_COLOR_ID_WHITE      0
>> +#define LED_COLOR_ID_RED        1
>> +#define LED_COLOR_ID_YELLOW     2
>> +#define LED_COLOR_ID_BLUE       3
>> +#define LED_COLOR_ID_AMBER      4
>> +#define LED_COLOR_ID_GREEN      5
>> +#define LED_COLOR_ID_VIOLET     6
>> +#define LED_COLOR_ID_PUPRPLE    7
>> +#define LED_COLOR_ID_ORANGE     8
>> +#define LED_COLOR_ID_PINK       9
>> +#define LED_COLOR_ID_CYAN      10
>> +#define LED_COLOR_ID_LIME      11
> 
> All this is a incompatible bindings change, so shortly ABI break. You
> cannot change defines. Feel free to add new ones.
Yep, I realized this the moment I got your message, I was even thinking 
about it, and figured, 'its internal defines, so should be fine' but of 
course, backwards compatibility with old DT's indeed. In hindsight, this 
probably could have been better as a string in the dt itself instead.

I'll re-spin it, which will make the order a bit wonky, but so be it.

Thanks, and sorry.
> 
> Best regards,
> Krzysztof
diff mbox series

Patch

diff --git a/include/dt-bindings/leds/common.h 
b/include/dt-bindings/leds/common.h
index 3be89a7c20a9..1d9b955267cc 100644
--- a/include/dt-bindings/leds/common.h
+++ b/include/dt-bindings/leds/common.h
@@ -22,18 +22,22 @@ 
  #define LEDS_BOOST_FIXED    2

  /* Standard LED colors */
-#define LED_COLOR_ID_WHITE    0
-#define LED_COLOR_ID_RED    1
-#define LED_COLOR_ID_GREEN    2
-#define LED_COLOR_ID_BLUE    3
-#define LED_COLOR_ID_AMBER    4
-#define LED_COLOR_ID_VIOLET    5
-#define LED_COLOR_ID_YELLOW    6
-#define LED_COLOR_ID_IR        7
-#define LED_COLOR_ID_MULTI    8    /* For multicolor LEDs */
-#define LED_COLOR_ID_RGB    9    /* For multicolor LEDs that can do 
arbitrary color,
-                       so this would include RGBW and similar */
-#define LED_COLOR_ID_MAX    10
+#define LED_COLOR_ID_WHITE      0
+#define LED_COLOR_ID_RED        1
+#define LED_COLOR_ID_YELLOW     2
+#define LED_COLOR_ID_BLUE       3
+#define LED_COLOR_ID_AMBER      4
+#define LED_COLOR_ID_GREEN      5
+#define LED_COLOR_ID_VIOLET     6
+#define LED_COLOR_ID_PUPRPLE    7
+#define LED_COLOR_ID_ORANGE     8
+#define LED_COLOR_ID_PINK       9
+#define LED_COLOR_ID_CYAN      10
+#define LED_COLOR_ID_LIME      11
+#define LED_COLOR_ID_IR        12
+#define LED_COLOR_ID_MULTI     13 /* For multicolor LEDs */
+#define LED_COLOR_ID_RGB       14 /* For multicolor LEDs that can do 
arbitrary color, including RGBW etc. */
+#define LED_COLOR_ID_MAX       15