* [PATCH 1/1] dt-bindings: leds: max77650: convert the binding document to yaml
@ 2024-06-28 22:55 Lucca fachinetti
2024-07-01 15:10 ` Conor Dooley
0 siblings, 1 reply; 2+ messages in thread
From: Lucca fachinetti @ 2024-06-28 22:55 UTC (permalink / raw)
To: pavel, dmurphy, robh+dt, lee
Cc: linux-leds, devicetree, linux-kernel, g.luiztrevisan,
Lucca Fachinetti
From: Lucca Fachinetti <luccafachinetti@gmail.com>
Convert the binding document for max77650 LED module to yaml.
Signed-off-by: Lucca Fachinetti <luccafachinetti@gmail.com>
---
.../bindings/leds/leds-is31fl32xx.txt | 52 --------------
.../bindings/leds/leds-is31fl32xx.yaml | 67 +++++++++++++++++++
2 files changed, 67 insertions(+), 52 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/leds/leds-is31fl32xx.txt
create mode 100644 Documentation/devicetree/bindings/leds/leds-is31fl32xx.yaml
diff --git a/Documentation/devicetree/bindings/leds/leds-is31fl32xx.txt b/Documentation/devicetree/bindings/leds/leds-is31fl32xx.txt
deleted file mode 100644
index 926c2117942c..000000000000
--- a/Documentation/devicetree/bindings/leds/leds-is31fl32xx.txt
+++ /dev/null
@@ -1,52 +0,0 @@
-Binding for ISSI IS31FL32xx and Si-En SN32xx LED Drivers
-
-The IS31FL32xx/SN32xx family of LED drivers are I2C devices with multiple
-constant-current channels, each with independent 256-level PWM control.
-Each LED is represented as a sub-node of the device.
-
-Required properties:
-- compatible: one of
- issi,is31fl3236
- issi,is31fl3235
- issi,is31fl3218
- issi,is31fl3216
- si-en,sn3218
- si-en,sn3216
-- reg: I2C slave address
-- address-cells : must be 1
-- size-cells : must be 0
-
-LED sub-node properties:
-- reg : LED channel number (1..N)
-- label : (optional)
- see Documentation/devicetree/bindings/leds/common.txt
-- linux,default-trigger : (optional)
- see Documentation/devicetree/bindings/leds/common.txt
-
-
-Example:
-
-is31fl3236: led-controller@3c {
- compatible = "issi,is31fl3236";
- reg = <0x3c>;
- #address-cells = <1>;
- #size-cells = <0>;
-
- led@1 {
- reg = <1>;
- label = "EB:blue:usr0";
- };
- led@2 {
- reg = <2>;
- label = "EB:blue:usr1";
- };
- ...
- led@36 {
- reg = <36>;
- label = "EB:blue:usr35";
- };
-};
-
-For more product information please see the links below:
-http://www.issi.com/US/product-analog-fxled-driver.shtml
-http://www.si-en.com/product.asp?parentid=890
diff --git a/Documentation/devicetree/bindings/leds/leds-is31fl32xx.yaml b/Documentation/devicetree/bindings/leds/leds-is31fl32xx.yaml
new file mode 100644
index 000000000000..0f4c7c3440c6
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/leds-is31fl32xx.yaml
@@ -0,0 +1,67 @@
+ # SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/leds/leds-is31fl32xx.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: LED driver for is31fl32xx and Si-En SN32xx.
+
+maintainers:
+ - Pavel Machek <pavel@ucw.cz>
+ - Lee Jones <lee@kernel.org>
+
+description: |
+ Binding for ISSI is31fl32xx and Si-En SN32xx LED Drivers
+
+ The is31fl32xx/SN32xx family of LED drivers are I2C devices with multiple
+ constant-current channels, each with independent 256-level PWM control.
+ Each LED is represented as a sub-node of the device.
+
+properties:
+ compatible:
+ enum:
+ - issi,is31fl3236
+ - issi,is31fl3235
+ - issi,is31fl3218
+ - issi,is31fl3216
+ - si-en,sn3218
+ - si-en,sn3216
+
+ reg:
+ maxItems: 1
+ description:
+ I2C slave address
+
+ '#address-cells':
+ const: 1
+
+ "#size-cells":
+ const: 0
+
+patternProperties:
+ "^led@[1-9][0-9]*$":
+ type: object
+ description: |
+ Properties for a single subnode LED.
+ additionalProperties: false
+
+ properties:
+ reg:
+ minItems: 1
+ description:
+ LED channel number (1..N)
+
+ label: true
+
+ linux,default-trigger: true
+
+ required:
+ - reg
+
+required:
+ - compatible
+ - reg
+ - "#size-cells"
+ - "#address-cells"
+
+additionalProperties: false
--
2.34.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH 1/1] dt-bindings: leds: max77650: convert the binding document to yaml
2024-06-28 22:55 [PATCH 1/1] dt-bindings: leds: max77650: convert the binding document to yaml Lucca fachinetti
@ 2024-07-01 15:10 ` Conor Dooley
0 siblings, 0 replies; 2+ messages in thread
From: Conor Dooley @ 2024-07-01 15:10 UTC (permalink / raw)
To: Lucca fachinetti
Cc: pavel, dmurphy, robh+dt, lee, linux-leds, devicetree,
linux-kernel, g.luiztrevisan
[-- Attachment #1: Type: text/plain, Size: 4754 bytes --]
On Fri, Jun 28, 2024 at 07:55:51PM -0300, Lucca fachinetti wrote:
> From: Lucca Fachinetti <luccafachinetti@gmail.com>
>
> Convert the binding document for max77650 LED module to yaml.
>
> Signed-off-by: Lucca Fachinetti <luccafachinetti@gmail.com>
> ---
> .../bindings/leds/leds-is31fl32xx.txt | 52 --------------
> .../bindings/leds/leds-is31fl32xx.yaml | 67 +++++++++++++++++++
> 2 files changed, 67 insertions(+), 52 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/leds/leds-is31fl32xx.txt
> create mode 100644 Documentation/devicetree/bindings/leds/leds-is31fl32xx.yaml
>
> diff --git a/Documentation/devicetree/bindings/leds/leds-is31fl32xx.txt b/Documentation/devicetree/bindings/leds/leds-is31fl32xx.txt
> deleted file mode 100644
> index 926c2117942c..000000000000
> --- a/Documentation/devicetree/bindings/leds/leds-is31fl32xx.txt
> +++ /dev/null
> @@ -1,52 +0,0 @@
> -Binding for ISSI IS31FL32xx and Si-En SN32xx LED Drivers
> -
> -The IS31FL32xx/SN32xx family of LED drivers are I2C devices with multiple
> -constant-current channels, each with independent 256-level PWM control.
> -Each LED is represented as a sub-node of the device.
> -
> -Required properties:
> -- compatible: one of
> - issi,is31fl3236
> - issi,is31fl3235
> - issi,is31fl3218
> - issi,is31fl3216
> - si-en,sn3218
> - si-en,sn3216
> -- reg: I2C slave address
> -- address-cells : must be 1
> -- size-cells : must be 0
> -
> -LED sub-node properties:
> -- reg : LED channel number (1..N)
> -- label : (optional)
> - see Documentation/devicetree/bindings/leds/common.txt
> -- linux,default-trigger : (optional)
> - see Documentation/devicetree/bindings/leds/common.txt
> -
> -
> -Example:
> -
> -is31fl3236: led-controller@3c {
> - compatible = "issi,is31fl3236";
> - reg = <0x3c>;
> - #address-cells = <1>;
> - #size-cells = <0>;
> -
> - led@1 {
> - reg = <1>;
> - label = "EB:blue:usr0";
> - };
> - led@2 {
> - reg = <2>;
> - label = "EB:blue:usr1";
> - };
> - ...
> - led@36 {
> - reg = <36>;
> - label = "EB:blue:usr35";
> - };
> -};
> -
> -For more product information please see the links below:
> -http://www.issi.com/US/product-analog-fxled-driver.shtml
> -http://www.si-en.com/product.asp?parentid=890
> diff --git a/Documentation/devicetree/bindings/leds/leds-is31fl32xx.yaml b/Documentation/devicetree/bindings/leds/leds-is31fl32xx.yaml
> new file mode 100644
> index 000000000000..0f4c7c3440c6
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/leds-is31fl32xx.yaml
Can you call the binding after one of the compatible strings please?
> @@ -0,0 +1,67 @@
> + # SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/leds/leds-is31fl32xx.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: LED driver for is31fl32xx and Si-En SN32xx.
> +
> +maintainers:
> + - Pavel Machek <pavel@ucw.cz>
> + - Lee Jones <lee@kernel.org>
> +
> +description: |
The | here likely isn't needed, the formatting isn't really worth
preserving....
> + Binding for ISSI is31fl32xx and Si-En SN32xx LED Drivers
Especially as this line is just duplicating the title.
> +
> + The is31fl32xx/SN32xx family of LED drivers are I2C devices with multiple
> + constant-current channels, each with independent 256-level PWM control.
> + Each LED is represented as a sub-node of the device.
> +
> +properties:
> + compatible:
> + enum:
> + - issi,is31fl3236
> + - issi,is31fl3235
> + - issi,is31fl3218
> + - issi,is31fl3216
> + - si-en,sn3218
> + - si-en,sn3216
> +
> + reg:
> + maxItems: 1
> + description:
> + I2C slave address
> +
> + '#address-cells':
> + const: 1
> +
> + "#size-cells":
> + const: 0
> +
> +patternProperties:
> + "^led@[1-9][0-9]*$":
> + type: object
You're missing a ref to leds/common.yaml here, where the label and
trigger properties are described.
> + description: |
And this | isn't needed either.
> + Properties for a single subnode LED.
> + additionalProperties: false
> +
> + properties:
> + reg:
> + minItems: 1
> + description:
> + LED channel number (1..N)
> +
> + label: true
> +
> + linux,default-trigger: true
> +
> + required:
> + - reg
> +
> +required:
> + - compatible
> + - reg
> + - "#size-cells"
> + - "#address-cells"
> +
> +additionalProperties: false
You should add the example from the text binding to the yaml one too, so
that dt_binding_check can be used to validate the binding versus the
example.
Thanks,
Conor.
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2024-07-01 15:10 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-06-28 22:55 [PATCH 1/1] dt-bindings: leds: max77650: convert the binding document to yaml Lucca fachinetti
2024-07-01 15:10 ` Conor Dooley
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).