diff mbox series

[2/5] dt-bindings: backlight: convert zii,rave-sp-backlight.txt to yaml

Message ID 20241008-zii_yaml-v1-2-d06ba7e26225@nxp.com (mailing list archive)
State New, archived
Headers show
Series dt-bindings: mfd: convert zii,rave-sp.txt and child txt to yaml format | expand

Commit Message

Frank Li Oct. 8, 2024, 10 p.m. UTC
Convert device tree binding doc zii,rave-sp-backlight.txt to yaml format.
Additional Changes:
- Remove mfd parent node at example.
- Ref to backlight's common.yaml

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
 .../leds/backlight/zii,rave-sp-backlight.txt       | 23 --------------
 .../leds/backlight/zii,rave-sp-backlight.yaml      | 36 ++++++++++++++++++++++
 2 files changed, 36 insertions(+), 23 deletions(-)

Comments

Rob Herring Oct. 9, 2024, 12:14 a.m. UTC | #1
On Tue, 08 Oct 2024 18:00:58 -0400, Frank Li wrote:
> Convert device tree binding doc zii,rave-sp-backlight.txt to yaml format.
> Additional Changes:
> - Remove mfd parent node at example.
> - Ref to backlight's common.yaml
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
>  .../leds/backlight/zii,rave-sp-backlight.txt       | 23 --------------
>  .../leds/backlight/zii,rave-sp-backlight.yaml      | 36 ++++++++++++++++++++++
>  2 files changed, 36 insertions(+), 23 deletions(-)
> 

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

yamllint warnings/errors:

dtschema/dtc warnings/errors:


doc reference errors (make refcheckdocs):
Warning: Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/zii,rave-sp.yaml
Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.yaml: Documentation/devicetree/bindings/mfd/zii,rave-sp.yaml

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20241008-zii_yaml-v1-2-d06ba7e26225@nxp.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
Daniel Thompson Oct. 9, 2024, 2:27 p.m. UTC | #2
On Tue, Oct 08, 2024 at 06:00:58PM -0400, Frank Li wrote:
> Convert device tree binding doc zii,rave-sp-backlight.txt to yaml format.
> Additional Changes:
> - Remove mfd parent node at example.
> - Ref to backlight's common.yaml
>
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
>  .../leds/backlight/zii,rave-sp-backlight.txt       | 23 --------------
>  .../leds/backlight/zii,rave-sp-backlight.yaml      | 36 ++++++++++++++++++++++
>  2 files changed, 36 insertions(+), 23 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.txt b/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.txt
> deleted file mode 100644
> index ff5c921386502..0000000000000
> --- a/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.txt
> +++ /dev/null
> @@ -1,23 +0,0 @@
> -Zodiac Inflight Innovations RAVE Supervisory Processor Backlight Bindings
> -
> -RAVE SP backlight device is a "MFD cell" device corresponding to
> -backlight functionality of RAVE Supervisory Processor. It is expected
> -that its Device Tree node is specified as a child of the node
> -corresponding to the parent RAVE SP device (as documented in
> -Documentation/devicetree/bindings/mfd/zii,rave-sp.txt)
> -
> -Required properties:
> -
> -- compatible: Should be "zii,rave-sp-backlight"
> -
> -Example:
> -
> -	rave-sp {
> -		compatible = "zii,rave-sp-rdu1";
> -		current-speed = <38400>;
> -
> -		backlight {
> -			compatible = "zii,rave-sp-backlight";
> -		};
> -	}
> -
> diff --git a/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.yaml b/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.yaml
> new file mode 100644
> index 0000000000000..fe9dba8231bf1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.yaml
> @@ -0,0 +1,36 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/leds/backlight/zii,rave-sp-backlight.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Zodiac Inflight Innovations RAVE Supervisory Processor Backlight
> +
> +maintainers:
> +  - Lee Jones <lee@kernel.org>

How did you arrive at this maintainer list?

It's not the usual backlight group and it also doesn't match the
maintainer for the mfd bindings.


Daniel.
Rob Herring Oct. 9, 2024, 2:59 p.m. UTC | #3
On Wed, Oct 09, 2024 at 03:27:58PM +0100, Daniel Thompson wrote:
> On Tue, Oct 08, 2024 at 06:00:58PM -0400, Frank Li wrote:
> > Convert device tree binding doc zii,rave-sp-backlight.txt to yaml format.
> > Additional Changes:
> > - Remove mfd parent node at example.
> > - Ref to backlight's common.yaml
> >
> > Signed-off-by: Frank Li <Frank.Li@nxp.com>
> > ---
> >  .../leds/backlight/zii,rave-sp-backlight.txt       | 23 --------------
> >  .../leds/backlight/zii,rave-sp-backlight.yaml      | 36 ++++++++++++++++++++++
> >  2 files changed, 36 insertions(+), 23 deletions(-)
> >
> > diff --git a/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.txt b/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.txt
> > deleted file mode 100644
> > index ff5c921386502..0000000000000
> > --- a/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.txt
> > +++ /dev/null
> > @@ -1,23 +0,0 @@
> > -Zodiac Inflight Innovations RAVE Supervisory Processor Backlight Bindings
> > -
> > -RAVE SP backlight device is a "MFD cell" device corresponding to
> > -backlight functionality of RAVE Supervisory Processor. It is expected
> > -that its Device Tree node is specified as a child of the node
> > -corresponding to the parent RAVE SP device (as documented in
> > -Documentation/devicetree/bindings/mfd/zii,rave-sp.txt)
> > -
> > -Required properties:
> > -
> > -- compatible: Should be "zii,rave-sp-backlight"
> > -
> > -Example:
> > -
> > -	rave-sp {
> > -		compatible = "zii,rave-sp-rdu1";
> > -		current-speed = <38400>;
> > -
> > -		backlight {
> > -			compatible = "zii,rave-sp-backlight";
> > -		};
> > -	}
> > -
> > diff --git a/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.yaml b/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.yaml
> > new file mode 100644
> > index 0000000000000..fe9dba8231bf1
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.yaml
> > @@ -0,0 +1,36 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/leds/backlight/zii,rave-sp-backlight.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Zodiac Inflight Innovations RAVE Supervisory Processor Backlight
> > +
> > +maintainers:
> > +  - Lee Jones <lee@kernel.org>
> 
> How did you arrive at this maintainer list?
> 
> It's not the usual backlight group and it also doesn't match the
> maintainer for the mfd bindings.

It should be someone that has Zodiac h/w, not backlight maintainers 
either. If we can't identify anyone then maybe the platform should be 
removed.

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.txt b/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.txt
deleted file mode 100644
index ff5c921386502..0000000000000
--- a/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.txt
+++ /dev/null
@@ -1,23 +0,0 @@ 
-Zodiac Inflight Innovations RAVE Supervisory Processor Backlight Bindings
-
-RAVE SP backlight device is a "MFD cell" device corresponding to
-backlight functionality of RAVE Supervisory Processor. It is expected
-that its Device Tree node is specified as a child of the node
-corresponding to the parent RAVE SP device (as documented in
-Documentation/devicetree/bindings/mfd/zii,rave-sp.txt)
-
-Required properties:
-
-- compatible: Should be "zii,rave-sp-backlight"
-
-Example:
-
-	rave-sp {
-		compatible = "zii,rave-sp-rdu1";
-		current-speed = <38400>;
-
-		backlight {
-			compatible = "zii,rave-sp-backlight";
-		};
-	}
-
diff --git a/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.yaml b/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.yaml
new file mode 100644
index 0000000000000..fe9dba8231bf1
--- /dev/null
+++ b/Documentation/devicetree/bindings/leds/backlight/zii,rave-sp-backlight.yaml
@@ -0,0 +1,36 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/leds/backlight/zii,rave-sp-backlight.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Zodiac Inflight Innovations RAVE Supervisory Processor Backlight
+
+maintainers:
+  - Lee Jones <lee@kernel.org>
+
+description:
+  RAVE SP backlight device is a "MFD cell" device corresponding to
+  backlight functionality of RAVE Supervisory Processor. It is expected
+  that its Device Tree node is specified as a child of the node
+  corresponding to the parent RAVE SP device (as documented in
+  Documentation/devicetree/bindings/mfd/zii,rave-sp.yaml)
+
+properties:
+  compatible:
+    const: zii,rave-sp-backlight
+
+required:
+  - compatible
+
+allOf:
+  - $ref: common.yaml
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    backlight {
+        compatible = "zii,rave-sp-backlight";
+    };
+