diff mbox series

[RFC,v2,2/2] dt-bindings: leds: lp50xx: Document child reg, fix example

Message ID 20250522-led-fix-v2-2-652046323ec3@axis.com
State New
Headers show
Series leds-lp50xx: Support reg to set multi_index. | expand

Commit Message

Johan Adolfsson May 22, 2025, 2:14 p.m. UTC
The led child reg node is the index within the bank, document that
and update the example accordingly.

Signed-off-by: Johan Adolfsson <johan.adolfsson@axis.com>
---
 Documentation/devicetree/bindings/leds/leds-lp50xx.yaml | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

Comments

Krzysztof Kozlowski May 22, 2025, 5:40 p.m. UTC | #1
On 22/05/2025 16:14, Johan Adolfsson wrote:
> The led child reg node is the index within the bank, document that
> and update the example accordingly.
> 
> Signed-off-by: Johan Adolfsson <johan.adolfsson@axis.com>


<form letter>
Please use scripts/get_maintainers.pl to get a list of necessary people
and lists to CC. It might happen, that command when run on an older
kernel, gives you outdated entries. Therefore please be sure you base
your patches on recent Linux kernel.

Tools like b4 or scripts/get_maintainer.pl provide you proper list of
people, so fix your workflow. Tools might also fail if you work on some
ancient tree (don't, instead use mainline) or work on fork of kernel
(don't, instead use mainline). Just use b4 and everything should be
fine, although remember about `b4 prep --auto-to-cc` if you added new
patches to the patchset.

You missed at least devicetree list (maybe more), so this won't be
tested by automated tooling. Performing review on untested code might be
a waste of time.

Please kindly resend and include all necessary To/Cc entries.
</form letter>


> ---
>  Documentation/devicetree/bindings/leds/leds-lp50xx.yaml | 11 ++++++++---
>  1 file changed, 8 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/leds/leds-lp50xx.yaml b/Documentation/devicetree/bindings/leds/leds-lp50xx.yaml
> index 402c25424525..8ce327d00c2d 100644
> --- a/Documentation/devicetree/bindings/leds/leds-lp50xx.yaml
> +++ b/Documentation/devicetree/bindings/leds/leds-lp50xx.yaml
> @@ -82,6 +82,11 @@ patternProperties:
>          properties:
>            reg:
>              maxItems: 1
> +            description:
> +              This property denotes the index within the LED bank, 0, 1 or 2.

Do not open code constraints. You probably wanted minimum/maximum
instead of above syntax.

> +              The value is actually optional for backward compatibility reasons

No, it is not optional - see schema.

> +              but is highly recommended to handle reversed devicetree
> +              processing properly.
>  
>          required:
>            - reg
> @@ -139,17 +144,17 @@ examples:
>                  function = LED_FUNCTION_STANDBY;
>  
>                  led@3 {
> -                    reg = <0x3>;
> +                    reg = <0x0>;

Mismatched unit address.


Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/leds/leds-lp50xx.yaml b/Documentation/devicetree/bindings/leds/leds-lp50xx.yaml
index 402c25424525..8ce327d00c2d 100644
--- a/Documentation/devicetree/bindings/leds/leds-lp50xx.yaml
+++ b/Documentation/devicetree/bindings/leds/leds-lp50xx.yaml
@@ -82,6 +82,11 @@  patternProperties:
         properties:
           reg:
             maxItems: 1
+            description:
+              This property denotes the index within the LED bank, 0, 1 or 2.
+              The value is actually optional for backward compatibility reasons
+              but is highly recommended to handle reversed devicetree
+              processing properly.
 
         required:
           - reg
@@ -139,17 +144,17 @@  examples:
                 function = LED_FUNCTION_STANDBY;
 
                 led@3 {
-                    reg = <0x3>;
+                    reg = <0x0>;
                     color = <LED_COLOR_ID_RED>;
                 };
 
                 led@4 {
-                    reg = <0x4>;
+                    reg = <0x1>;
                     color = <LED_COLOR_ID_GREEN>;
                 };
 
                 led@5 {
-                    reg = <0x5>;
+                    reg = <0x2>;
                     color = <LED_COLOR_ID_BLUE>;
                 };
             };