1. Patchew
  2. linux
  3. [PATCH v4 0/4] leds: privacy-led support for devicetree
  4. View patch

[PATCH v4 1/4] dt-bindings: leds: add generic LED consumer documentation

Aleksandrs Vinarskis posted 4 patches 3 weeks, 1 day ago
There is a newer version of this series
[PATCH v4 1/4] dt-bindings: leds: add generic LED consumer documentation
Posted by Aleksandrs Vinarskis 3 weeks, 1 day ago 
Introduce common generic led consumer binding, where consumer defines
led(s) by phandle, as opposed to trigger-source binding where the
trigger source is defined in led itself.

Add already used in some schemas 'leds' parameter which expects
phandle-array. Additionally, introduce 'led-names' which could be used
by consumers to map LED devices to their respective functions.

Signed-off-by: Aleksandrs Vinarskis <alex@vinarskis.com>
---
 .../devicetree/bindings/leds/leds-consumer.yaml    | 67 ++++++++++++++++++++++
 1 file changed, 67 insertions(+)

diff --git a/Documentation/devicetree/bindings/leds/leds-consumer.yaml b/Documentation/devicetree/bindings/leds/leds-consumer.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..045b7a4fcd3bdcfb19a02fe4435b40445c168115
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/leds-consumer.yaml
@@ -0,0 +1,67 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/leds/leds-consumer.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Common leds consumer
+
+maintainers:
+  - Aleksandrs Vinarskis <alex@vinarskis.com>
+
+description:
+  Some LED defined in DT are required by other DT consumers, for example
+  v4l2 subnode may require privacy or flash LED. Unlike trigger-source
+  approach which is typically used as 'soft' binding, referencing LED
+  devices by phandle makes things simpler when 'hard' binding is desired.
+
+  Document LED properties that its consumers may define.
+
+select: true
+
+properties:
+  leds:
+    oneOf:
+      - type: object
+      - $ref: /schemas/types.yaml#/definitions/phandle-array
+        description:
+          A list of LED device(s) required by a particular consumer.
+        items:
+          maxItems: 1
+
+  led-names:
+    description:
+      A list of device name(s). Used to map LED devices to their respective
+      functions, when consumer requires more than one LED.
+
+additionalProperties: true
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    #include <dt-bindings/leds/common.h>
+
+    leds {
+        compatible = "gpio-leds";
+
+        privacy_led: privacy-led {
+            color = <LED_COLOR_ID_RED>;
+            default-state = "off";
+            function = LED_FUNCTION_INDICATOR;
+            gpios = <&tlmm 110 GPIO_ACTIVE_HIGH>;
+        };
+    };
+
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      v4l2_node: camera@36 {
+        reg = <0x36>;
+
+        leds = <&privacy_led>;
+        led-names = "privacy-led";
+      };
+    };
+
+...

-- 
2.48.1
Re: [PATCH v4 1/4] dt-bindings: leds: add generic LED consumer documentation
Posted by Hans de Goede 3 weeks, 1 day ago 
Hi Aleksandrs,

Thank you for your continued work on this.

One small remark below.

On 10-Sep-25 1:07 PM, Aleksandrs Vinarskis wrote:
> Introduce common generic led consumer binding, where consumer defines
> led(s) by phandle, as opposed to trigger-source binding where the
> trigger source is defined in led itself.
> 
> Add already used in some schemas 'leds' parameter which expects
> phandle-array. Additionally, introduce 'led-names' which could be used
> by consumers to map LED devices to their respective functions.
> 
> Signed-off-by: Aleksandrs Vinarskis <alex@vinarskis.com>
> ---
>  .../devicetree/bindings/leds/leds-consumer.yaml    | 67 ++++++++++++++++++++++
>  1 file changed, 67 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/leds/leds-consumer.yaml b/Documentation/devicetree/bindings/leds/leds-consumer.yaml
> new file mode 100644
> index 0000000000000000000000000000000000000000..045b7a4fcd3bdcfb19a02fe4435b40445c168115
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/leds-consumer.yaml
> @@ -0,0 +1,67 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/leds/leds-consumer.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Common leds consumer
> +
> +maintainers:
> +  - Aleksandrs Vinarskis <alex@vinarskis.com>
> +
> +description:
> +  Some LED defined in DT are required by other DT consumers, for example
> +  v4l2 subnode may require privacy or flash LED. Unlike trigger-source
> +  approach which is typically used as 'soft' binding, referencing LED
> +  devices by phandle makes things simpler when 'hard' binding is desired.
> +
> +  Document LED properties that its consumers may define.
> +
> +select: true
> +
> +properties:
> +  leds:
> +    oneOf:
> +      - type: object
> +      - $ref: /schemas/types.yaml#/definitions/phandle-array
> +        description:
> +          A list of LED device(s) required by a particular consumer.
> +        items:
> +          maxItems: 1
> +
> +  led-names:
> +    description:
> +      A list of device name(s). Used to map LED devices to their respective
> +      functions, when consumer requires more than one LED.
> +
> +additionalProperties: true
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +    #include <dt-bindings/leds/common.h>
> +
> +    leds {
> +        compatible = "gpio-leds";
> +
> +        privacy_led: privacy-led {
> +            color = <LED_COLOR_ID_RED>;
> +            default-state = "off";
> +            function = LED_FUNCTION_INDICATOR;
> +            gpios = <&tlmm 110 GPIO_ACTIVE_HIGH>;
> +        };
> +    };
> +
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      v4l2_node: camera@36 {
> +        reg = <0x36>;
> +
> +        leds = <&privacy_led>;
> +        led-names = "privacy-led";

This should probable be:

        led-names = "privacy";

Now without the "-led".

Regards,

Hans
Re: [PATCH v4 1/4] dt-bindings: leds: add generic LED consumer documentation
Posted by Aleksandrs Vinarskis 3 weeks, 1 day ago 




On Wednesday, September 10th, 2025 at 13:50, Hans de Goede <hansg@kernel.org> wrote:

> 
> 
> Hi Aleksandrs,
> 
> Thank you for your continued work on this.
> 
> One small remark below.
> 
> On 10-Sep-25 1:07 PM, Aleksandrs Vinarskis wrote:
> 
> > Introduce common generic led consumer binding, where consumer defines
> > led(s) by phandle, as opposed to trigger-source binding where the
> > trigger source is defined in led itself.
> > 
> > Add already used in some schemas 'leds' parameter which expects
> > phandle-array. Additionally, introduce 'led-names' which could be used
> > by consumers to map LED devices to their respective functions.
> > 
> > Signed-off-by: Aleksandrs Vinarskis alex@vinarskis.com
> > ---
> > .../devicetree/bindings/leds/leds-consumer.yaml | 67 ++++++++++++++++++++++
> > 1 file changed, 67 insertions(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/leds/leds-consumer.yaml b/Documentation/devicetree/bindings/leds/leds-consumer.yaml
> > new file mode 100644
> > index 0000000000000000000000000000000000000000..045b7a4fcd3bdcfb19a02fe4435b40445c168115
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/leds/leds-consumer.yaml
> > @@ -0,0 +1,67 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/leds/leds-consumer.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Common leds consumer
> > +
> > +maintainers:
> > + - Aleksandrs Vinarskis alex@vinarskis.com
> > +
> > +description:
> > + Some LED defined in DT are required by other DT consumers, for example
> > + v4l2 subnode may require privacy or flash LED. Unlike trigger-source
> > + approach which is typically used as 'soft' binding, referencing LED
> > + devices by phandle makes things simpler when 'hard' binding is desired.
> > +
> > + Document LED properties that its consumers may define.
> > +
> > +select: true
> > +
> > +properties:
> > + leds:
> > + oneOf:
> > + - type: object
> > + - $ref: /schemas/types.yaml#/definitions/phandle-array
> > + description:
> > + A list of LED device(s) required by a particular consumer.
> > + items:
> > + maxItems: 1
> > +
> > + led-names:
> > + description:
> > + A list of device name(s). Used to map LED devices to their respective
> > + functions, when consumer requires more than one LED.
> > +
> > +additionalProperties: true
> > +
> > +examples:
> > + - |
> > + #include <dt-bindings/gpio/gpio.h>
> > + #include <dt-bindings/leds/common.h>
> > +
> > + leds {
> > + compatible = "gpio-leds";
> > +
> > + privacy_led: privacy-led {
> > + color = <LED_COLOR_ID_RED>;
> > + default-state = "off";
> > + function = LED_FUNCTION_INDICATOR;
> > + gpios = <&tlmm 110 GPIO_ACTIVE_HIGH>;
> > + };
> > + };
> > +
> > + i2c {
> > + #address-cells = <1>;
> > + #size-cells = <0>;
> > +
> > + v4l2_node: camera@36 {
> > + reg = <0x36>;
> > +
> > + leds = <&privacy_led>;
> > + led-names = "privacy-led";
> 
> 
> This should probable be:
> 
> led-names = "privacy";
> 
> Now without the "-led".

Ah of course, seems I messed my rebasing, thanks for spotting it.
Re-spinning.

Alex

> 
> Regards,
> 
> Hans

Patchew 2.1-devel-b67e4c2

© 2016 - 2025 Red Hat, Inc.