Skip to contentSkip to conversation

dt-binding: leds: Document leds-multi-gpio bindings

PATCH In review Hermes Zhang 4 participants 5 messages Mar 24, 2021

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 dt-binding: leds: Document leds-multi-gpio bindings

From: Hermes Zhang <[email protected]>

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

---

Notes:
Add maxItems

 .../bindings/leds/leds-multi-gpio.yaml        | 50 +++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/leds-multi-gpio.yaml
Documentation/devicetree/bindings/leds/leds-multi-gpio.yaml new file +50 -0
new file mode 100644
index 000000000000..6f2b47487b90
@@ -0,0 +1,50 @@
+# 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 <[email protected]>
+
+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
+    maxItems: 16 # Should be enough
+
+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>;
+    };
+...
Signature · 1 line
2.20.1
#1 lore raw

Hello Hermes,

Quoted 5 lines

Hermes Zhang <[email protected]> hat am 24.03.2021 03:48 geschrieben:

From: Hermes Zhang <[email protected]>

Quoted 8 lines

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

---

Notes:
Add maxItems

What about the other part of the series? I think you should send both patches together with an introduction message on both. If you only change one patch for a new version spin of the series, just send the other one unchanged.

(It makes no sense to merge the binding as long as the driver is not merged, otherwise you would end up with a binding without driver. So keeping them together should help reviewers and maintainers.)

Greets
Alex

Quoted 63 lines
 .../bindings/leds/leds-multi-gpio.yaml        | 50 +++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/leds/leds-multi-gpio.yaml
Documentation/devicetree/bindings/leds/leds-multi-gpio.yaml new file +50 -0
new file mode 100644
index 000000000000..6f2b47487b90
@@ -0,0 +1,50 @@
+# 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 <[email protected]>
+
+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
+    maxItems: 16 # Should be enough
+
+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>;
+    };
+...
Signature · 1 line
2.20.1
#2 lore raw
Quoted 4 lines
Quoted 3 lines

Notes:
Add maxItems

Quoted 9 lines

What about the other part of the series? I think you should send both patches together with an introduction message on both. If you only change one patch for a new version spin of the series, just send the other one unchanged.

(It makes no sense to merge the binding as long as the driver is not merged, otherwise you would end up with a binding without driver. So keeping them together should help reviewers and maintainers.)

Hi Alexander,

The other part is here: https://lore.kernel.org/patchwork/patch/1399875/, so do you mean I need to combine these two as one commit? Or is there anyway to link them together? Thanks.

I'm first time to commit a new driver, sorry for that.

Best Regards,
Hermes

#3 lore raw

Hello,

Quoted 12 lines

Hermes Zhang <[email protected]> hat am 24.03.2021 07:04 geschrieben:

Quoted 9 lines
Quoted 3 lines

Notes:
Add maxItems

What about the other part of the series? I think you should send both patches together with an introduction message on both. If you only change one patch for a new version spin of the series, just send the other one unchanged.

Quoted 8 lines
Quoted 4 lines

(It makes no sense to merge the binding as long as the driver is not merged, otherwise you would end up with a binding without driver. So keeping them together should help reviewers and maintainers.)

Hi Alexander,

The other part is here: https://lore.kernel.org/patchwork/patch/1399875/, so do you mean I need to combine these two as one commit? Or is there anyway to link them together? Thanks.

Two commits.

For sending more than one patch in a series call git format-patch with the option --cover-letter. Please have a look at documentation on git format-patch and git send-email again.

You can see how it looks if you look out for other patch series on the from the past, especially those with subjects like "[PATCH 0/x] ...". An e-mail client supporting threaded view helps a lot.

Quoted 1 line

I'm first time to commit a new driver, sorry for that.

Thanks for trying. No need to be sorry, the tools are hard and expectations are high. In the end it's all about efficiency.

Have a nice day
Alex

#4 lore raw
In reply to Alexander Dahl
Quoted 10 lines · Alexander Dahl

Hello Hermes,

Quoted 8 lines

Hermes Zhang <[email protected]> hat am 24.03.2021 03:48 geschrieben:

From: Hermes Zhang <[email protected]>

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

Quoted 8 lines
Quoted 5 lines

---

Notes:
Add maxItems

What about the other part of the series? I think you should send both patches together with an introduction message on both. If you only change one patch for a new version spin of the series, just send the other one unchanged.

Please wrap emails after 72 columns or so.

Quoted 2 lines

(It makes no sense to merge the binding as long as the driver is not merged, otherwise you would end up with a binding without driver. So keeping them together should help reviewers and maintainers.)

This is actually okay to do if you expect discussion and not a patch merge. Series works, too.

Best regads,
Pavel

Signature · 1 line
http://www.livejournal.com/~pavelmachek