diff mbox series

[v2] dt-binding: leds: Document leds-multi-gpio bindings

Message ID 20210322091819.29119-1-chenhui.zhang@axis.com
State Superseded
Headers show
Series [v2] dt-binding: leds: Document leds-multi-gpio bindings | expand

Commit Message

Hermes Zhang March 22, 2021, 9:18 a.m. UTC 
From: Hermes Zhang <chenhuiz@axis.com>

Document the device tree bindings of the multiple GPIOs LED driver
Documentation/devicetree/bindings/leds/leds-multi-gpio.yaml.

Signed-off-by: Hermes Zhang <chenhuiz@axis.com>
---

Notes:
    Fix typo and missing item

 .../bindings/leds/leds-multi-gpio.yaml        | 49 +++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/leds-multi-gpio.yaml

Comments

Hermes Zhang March 23, 2021, 4:27 a.m. UTC | #1 
> -----Original Message-----

> From: Rob Herring <robh@kernel.org>

> Sent: 2021年3月23日 1:38

> My bot found errors running 'make dt_binding_check' on your patch:

> 

> yamllint warnings/errors:

> 

> dtschema/dtc warnings/errors:

> /builds/robherring/linux-dt-

> review/Documentation/devicetree/bindings/leds/leds-multi-

> gpio.example.dt.yaml: gpios-led: led-states: 'oneOf' conditional failed, one

> must be fixed:

> 	[[0, 1, 2, 3]] is too short

> 	[0, 1, 2, 3] is too long

> 	From schema: /builds/robherring/linux-dt-

> review/Documentation/devicetree/bindings/leds/leds-multi-gpio.yaml

> 


Hi Rob,

Thanks. Yes, now I can see the warning, but I could not understand what was wrong? Could you give some hint? 

Best Regards,
Hermes
Rob Herring (Arm) March 23, 2021, 2 p.m. UTC | #2 
On Mon, Mar 22, 2021 at 10:28 PM Hermes Zhang <Hermes.Zhang@axis.com> wrote:
>
> > -----Original Message-----
> > From: Rob Herring <robh@kernel.org>
> > Sent: 2021年3月23日 1:38
> > My bot found errors running 'make dt_binding_check' on your patch:
> >
> > yamllint warnings/errors:
> >
> > dtschema/dtc warnings/errors:
> > /builds/robherring/linux-dt-
> > review/Documentation/devicetree/bindings/leds/leds-multi-
> > gpio.example.dt.yaml: gpios-led: led-states: 'oneOf' conditional failed, one
> > must be fixed:
> >       [[0, 1, 2, 3]] is too short
> >       [0, 1, 2, 3] is too long
> >       From schema: /builds/robherring/linux-dt-
> > review/Documentation/devicetree/bindings/leds/leds-multi-gpio.yaml
> >
>
> Hi Rob,
>
> Thanks. Yes, now I can see the warning, but I could not understand what was wrong? Could you give some hint?

I think you need 'maxItems' in addition to minItems.

Rob
Hermes Zhang March 24, 2021, 2:52 a.m. UTC | #3 
> >

> > Hi Rob,

> >

> > Thanks. Yes, now I can see the warning, but I could not understand what

> was wrong? Could you give some hint?

> 

> I think you need 'maxItems' in addition to minItems.


Exactly! Thanks for the suggestion.

Best Regards,
Hermes
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/leds/leds-multi-gpio.yaml b/Documentation/devicetree/bindings/leds/leds-multi-gpio.yaml
new file mode 100644
index 000000000000..bc19d1758d92
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/leds-multi-gpio.yaml
@@ -0,0 +1,49 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/leds/leds-multi-gpio.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Multiple GPIOs LED driver
+
+maintainers:
+  - Hermes Zhang <chenhuiz@axis.com>
+
+description:
+  This will support some LED made of multiple GPIOs and the brightness of the
+  LED could map to different states of the GPIOs.
+
+properties:
+  compatible:
+    const: multi-gpio-led
+
+  led-gpios:
+    description: Array of one or more GPIOs pins used to control the LED.
+    minItems: 1
+    maxItems: 8  # Should be enough
+
+  led-states:
+    description: |
+      The array list the supported states here which will map to brightness
+      from 0 to maximum. Each item in the array will present all the GPIOs
+      value by bit.
+    $ref: /schemas/types.yaml#/definitions/uint8-array
+    minItems: 1
+
+required:
+  - compatible
+  - led-gpios
+  - led-states
+
+additionalProperties: false
+
+examples:
+  - |
+    gpios-led {
+      compatible = "multi-gpio-led";
+
+      led-gpios = <&gpio0 23 0x1>,
+                  <&gpio0 24 0x1>;
+      led-states = /bits/ 8 <0x00 0x01 0x02 0x03>;
+    };
+...