diff mbox series

[v3] dt-bindings: watchdog: brcm,kona-wdt: convert txt file to yaml

Message ID 20230418170341.28805-1-n2h9z4@gmail.com
State Accepted
Commit c51251083ad6e9d2cc0fdf209de17b3009e6eccb
Headers show
Series [v3] dt-bindings: watchdog: brcm,kona-wdt: convert txt file to yaml | expand

Commit Message

Nik Bune April 18, 2023, 5:03 p.m. UTC 
Converted txt file to yaml. No additional changes.

Signed-off-by: Nikita Bondarenko <n2h9z4@gmail.com>
---

Changes in v3:
- updated commit message
- updated the compatible definition to probably fix "compatible is too long" warning
- updated example to how it was in the txt file


I do not have this warning when I am running  
make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dt_binding_check
maybe I run it without some additional variable?

But I checked arch/arm/boot/dts/bcm28155-ap.dts, it includes bcm11351.dtsiv which contains 
compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
which probably causes a warning
This is exact how it was in txt file example.

If I put it in an example in a yaml file, dt_binding_check does not pass.
Looks like the issue is in the enum type of compatible. It does not allow multiple strings.  
Updated to not to use enum. The example with two strings in compatible passes the checks.

make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dt_binding_check
  LINT    Documentation/devicetree/bindings
  CHKDT   Documentation/devicetree/bindings/processed-schema.json
  SCHEMA  Documentation/devicetree/bindings/processed-schema.json
  DTEX    Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.example.dts
  DTC_CHK Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.example.dtb

make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dtbs_check
  LINT    Documentation/devicetree/bindings
  CHKDT   Documentation/devicetree/bindings/processed-schema.json
  SCHEMA  Documentation/devicetree/bindings/processed-schema.json


v2 patch is here: https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230402135555.62507-1-n2h9z4@gmail.com/

 .../bindings/watchdog/brcm,kona-wdt.txt       | 15 -------
 .../bindings/watchdog/brcm,kona-wdt.yaml      | 41 +++++++++++++++++++
 2 files changed, 41 insertions(+), 15 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
 create mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml

Comments

Rob Herring April 21, 2023, 6:34 p.m. UTC | #1 
On Tue, Apr 18, 2023 at 07:03:41PM +0200, Nikita Bondarenko wrote:
> Converted txt file to yaml. No additional changes.
> 
> Signed-off-by: Nikita Bondarenko <n2h9z4@gmail.com>
> ---
> 
> Changes in v3:
> - updated commit message
> - updated the compatible definition to probably fix "compatible is too long" warning
> - updated example to how it was in the txt file
> 
> 
> I do not have this warning when I am running  
> make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dt_binding_check
> maybe I run it without some additional variable?
> 
> But I checked arch/arm/boot/dts/bcm28155-ap.dts, it includes bcm11351.dtsiv which contains 
> compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> which probably causes a warning
> This is exact how it was in txt file example.
> 
> If I put it in an example in a yaml file, dt_binding_check does not pass.
> Looks like the issue is in the enum type of compatible. It does not allow multiple strings.  
> Updated to not to use enum. The example with two strings in compatible passes the checks.
> 
> make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dt_binding_check
>   LINT    Documentation/devicetree/bindings
>   CHKDT   Documentation/devicetree/bindings/processed-schema.json
>   SCHEMA  Documentation/devicetree/bindings/processed-schema.json
>   DTEX    Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.example.dts
>   DTC_CHK Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.example.dtb
> 
> make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dtbs_check
>   LINT    Documentation/devicetree/bindings
>   CHKDT   Documentation/devicetree/bindings/processed-schema.json
>   SCHEMA  Documentation/devicetree/bindings/processed-schema.json

And that's it? You need to remove all the .dtb files if you don't see 
any DTB lines. But this runs it for you:

https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230418170341.28805-1-n2h9z4@gmail.com/

It all looks fine, so not sure what your question/issue is?

> 
> 
> v2 patch is here: https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230402135555.62507-1-n2h9z4@gmail.com/
> 
>  .../bindings/watchdog/brcm,kona-wdt.txt       | 15 -------
>  .../bindings/watchdog/brcm,kona-wdt.yaml      | 41 +++++++++++++++++++
>  2 files changed, 41 insertions(+), 15 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
>  create mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> 
> diff --git a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
> deleted file mode 100644
> index 2b86a00e351d..000000000000
> --- a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
> +++ /dev/null
> @@ -1,15 +0,0 @@
> -Broadcom Kona Family Watchdog Timer
> ------------------------------------
> -
> -This watchdog timer is used in the following Broadcom SoCs:
> -  BCM11130, BCM11140, BCM11351, BCM28145, BCM28155
> -
> -Required properties:
> -  - compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> -  - reg: memory address & range
> -
> -Example:
> -	watchdog@35002f40 {
> -		compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> -		reg = <0x35002f40 0x6c>;
> -	};
> diff --git a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> new file mode 100644
> index 000000000000..3d4403b41cbe
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> @@ -0,0 +1,41 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/watchdog/brcm,kona-wdt.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Broadcom Kona Family Watchdog Timer
> +
> +description: |
> +  This watchdog timer is used in the following Broadcom SoCs:
> +  BCM11130, BCM11140, BCM11351, BCM28145, BCM28155
> +
> +maintainers:
> +  - Florian Fainelli <f.fainelli@gmail.com>
> +  - Ray Jui <rjui@broadcom.com>
> +  - Scott Branden <sbranden@broadcom.com>
> +
> +allOf:
> +  - $ref: watchdog.yaml#
> +
> +properties:
> +  compatible:
> +    items:
> +      - const: brcm,bcm11351-wdt
> +      - const: brcm,kona-wdt
> +
> +  reg:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    watchdog@35002f40 {
> +        compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> +        reg = <0x35002f40 0x6c>;
> +    };
> -- 
> 2.34.1
>
Nik Bune April 24, 2023, 4:53 p.m. UTC | #2 
On Fri, 21 Apr 2023 at 20:34, Rob Herring <robh@kernel.org> wrote:
>
> On Tue, Apr 18, 2023 at 07:03:41PM +0200, Nikita Bondarenko wrote:
> > Converted txt file to yaml. No additional changes.
> >
> > Signed-off-by: Nikita Bondarenko <n2h9z4@gmail.com>
> > ---
> >
> > Changes in v3:
> > - updated commit message
> > - updated the compatible definition to probably fix "compatible is too long" warning
> > - updated example to how it was in the txt file
> >
> >
> > I do not have this warning when I am running
> > make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dt_binding_check
> > maybe I run it without some additional variable?
> >
> > But I checked arch/arm/boot/dts/bcm28155-ap.dts, it includes bcm11351.dtsiv which contains
> > compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> > which probably causes a warning
> > This is exact how it was in txt file example.
> >
> > If I put it in an example in a yaml file, dt_binding_check does not pass.
> > Looks like the issue is in the enum type of compatible. It does not allow multiple strings.
> > Updated to not to use enum. The example with two strings in compatible passes the checks.
> >
> > make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dt_binding_check
> >   LINT    Documentation/devicetree/bindings
> >   CHKDT   Documentation/devicetree/bindings/processed-schema.json
> >   SCHEMA  Documentation/devicetree/bindings/processed-schema.json
> >   DTEX    Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.example.dts
> >   DTC_CHK Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.example.dtb
> >
> > make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dtbs_check
> >   LINT    Documentation/devicetree/bindings
> >   CHKDT   Documentation/devicetree/bindings/processed-schema.json
> >   SCHEMA  Documentation/devicetree/bindings/processed-schema.json
>
> And that's it? You need to remove all the .dtb files if you don't see
> any DTB lines. But this runs it for you:
>
> https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230418170341.28805-1-n2h9z4@gmail.com/
>
> It all looks fine, so not sure what your question/issue is?
>
> >
> >
> > v2 patch is here: https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230402135555.62507-1-n2h9z4@gmail.com/
> >
> >  .../bindings/watchdog/brcm,kona-wdt.txt       | 15 -------
> >  .../bindings/watchdog/brcm,kona-wdt.yaml      | 41 +++++++++++++++++++
> >  2 files changed, 41 insertions(+), 15 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
> >  create mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
> > deleted file mode 100644
> > index 2b86a00e351d..000000000000
> > --- a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
> > +++ /dev/null
> > @@ -1,15 +0,0 @@
> > -Broadcom Kona Family Watchdog Timer
> > ------------------------------------
> > -
> > -This watchdog timer is used in the following Broadcom SoCs:
> > -  BCM11130, BCM11140, BCM11351, BCM28145, BCM28155
> > -
> > -Required properties:
> > -  - compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> > -  - reg: memory address & range
> > -
> > -Example:
> > -     watchdog@35002f40 {
> > -             compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> > -             reg = <0x35002f40 0x6c>;
> > -     };
> > diff --git a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> > new file mode 100644
> > index 000000000000..3d4403b41cbe
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> > @@ -0,0 +1,41 @@
> > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/watchdog/brcm,kona-wdt.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Broadcom Kona Family Watchdog Timer
> > +
> > +description: |
> > +  This watchdog timer is used in the following Broadcom SoCs:
> > +  BCM11130, BCM11140, BCM11351, BCM28145, BCM28155
> > +
> > +maintainers:
> > +  - Florian Fainelli <f.fainelli@gmail.com>
> > +  - Ray Jui <rjui@broadcom.com>
> > +  - Scott Branden <sbranden@broadcom.com>
> > +
> > +allOf:
> > +  - $ref: watchdog.yaml#
> > +
> > +properties:
> > +  compatible:
> > +    items:
> > +      - const: brcm,bcm11351-wdt
> > +      - const: brcm,kona-wdt
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +unevaluatedProperties: false
> > +
> > +examples:
> > +  - |
> > +    watchdog@35002f40 {
> > +        compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> > +        reg = <0x35002f40 0x6c>;
> > +    };
> > --
> > 2.34.1
> >

Hello!

Got it, thank you!
Rob Herring June 30, 2023, 5:16 p.m. UTC | #3 
On Tue, 18 Apr 2023 19:03:41 +0200, Nikita Bondarenko wrote:
> Converted txt file to yaml. No additional changes.
> 
> Signed-off-by: Nikita Bondarenko <n2h9z4@gmail.com>
> ---
> 
> Changes in v3:
> - updated commit message
> - updated the compatible definition to probably fix "compatible is too long" warning
> - updated example to how it was in the txt file
> 
> 
> I do not have this warning when I am running
> make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dt_binding_check
> maybe I run it without some additional variable?
> 
> But I checked arch/arm/boot/dts/bcm28155-ap.dts, it includes bcm11351.dtsiv which contains
> compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> which probably causes a warning
> This is exact how it was in txt file example.
> 
> If I put it in an example in a yaml file, dt_binding_check does not pass.
> Looks like the issue is in the enum type of compatible. It does not allow multiple strings.
> Updated to not to use enum. The example with two strings in compatible passes the checks.
> 
> make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dt_binding_check
>   LINT    Documentation/devicetree/bindings
>   CHKDT   Documentation/devicetree/bindings/processed-schema.json
>   SCHEMA  Documentation/devicetree/bindings/processed-schema.json
>   DTEX    Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.example.dts
>   DTC_CHK Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.example.dtb
> 
> make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dtbs_check
>   LINT    Documentation/devicetree/bindings
>   CHKDT   Documentation/devicetree/bindings/processed-schema.json
>   SCHEMA  Documentation/devicetree/bindings/processed-schema.json
> 
> 
> v2 patch is here: https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230402135555.62507-1-n2h9z4@gmail.com/
> 
>  .../bindings/watchdog/brcm,kona-wdt.txt       | 15 -------
>  .../bindings/watchdog/brcm,kona-wdt.yaml      | 41 +++++++++++++++++++
>  2 files changed, 41 insertions(+), 15 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
>  create mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> 

Applied, thanks!
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
deleted file mode 100644
index 2b86a00e351d..000000000000
--- a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
+++ /dev/null
@@ -1,15 +0,0 @@ 
-Broadcom Kona Family Watchdog Timer
------------------------------------
-
-This watchdog timer is used in the following Broadcom SoCs:
-  BCM11130, BCM11140, BCM11351, BCM28145, BCM28155
-
-Required properties:
-  - compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
-  - reg: memory address & range
-
-Example:
-	watchdog@35002f40 {
-		compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
-		reg = <0x35002f40 0x6c>;
-	};
diff --git a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
new file mode 100644
index 000000000000..3d4403b41cbe
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
@@ -0,0 +1,41 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/brcm,kona-wdt.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Broadcom Kona Family Watchdog Timer
+
+description: |
+  This watchdog timer is used in the following Broadcom SoCs:
+  BCM11130, BCM11140, BCM11351, BCM28145, BCM28155
+
+maintainers:
+  - Florian Fainelli <f.fainelli@gmail.com>
+  - Ray Jui <rjui@broadcom.com>
+  - Scott Branden <sbranden@broadcom.com>
+
+allOf:
+  - $ref: watchdog.yaml#
+
+properties:
+  compatible:
+    items:
+      - const: brcm,bcm11351-wdt
+      - const: brcm,kona-wdt
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    watchdog@35002f40 {
+        compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
+        reg = <0x35002f40 0x6c>;
+    };