[PATCH v2 1/1] dt-bindings: watchdog: convert ziirave-wdt.txt to yaml

[PATCH v2 1/1] dt-bindings: watchdog: convert ziirave-wdt.txt to yaml

[Frank Li]

Convert ziirave-wdt.txt to yaml format.

Additional change:
- Add i2c node in example.
- Add ref to watchdog.yaml

Fix below warning:
arch/arm64/boot/dts/freescale/imx8mq-zii-ultra-rmb3.dtb: /soc@0/bus@30800000/i2c@30a40000/watchdog@38:
	failed to match any schema with compatible: ['zii,rave-wdt']

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
Change from v1 to v2
- add ref watchdog.yaml
- Remove timeout-sec
---
 .../bindings/watchdog/zii,rave-wdt.yaml       | 47 +++++++++++++++++++
 .../bindings/watchdog/ziirave-wdt.txt         | 19 --------
 2 files changed, 47 insertions(+), 19 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
 delete mode 100644 Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt

diff --git a/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml b/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
new file mode 100644
index 0000000000000..0206d9ddf872d
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
@@ -0,0 +1,47 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/zii,rave-wdt.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Zodiac RAVE Watchdog Timer
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+properties:
+  compatible:
+    const: zii,rave-wdt
+
+  reg:
+    maxItems: 1
+    description: i2c slave address of device, usually 0x38
+
+  reset-duration-ms:
+    description:
+      Duration of the pulse generated when the watchdog times
+      out. Value in milliseconds.
+
+required:
+  - compatible
+  - reg
+
+allOf:
+  - $ref: watchdog.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        watchdog@38 {
+            compatible = "zii,rave-wdt";
+            reg = <0x38>;
+            timeout-sec = <30>;
+            reset-duration-ms = <30>;
+        };
+    };
+
diff --git a/Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt b/Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt
deleted file mode 100644
index 3d878184ec3ff..0000000000000
--- a/Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-Zodiac RAVE Watchdog Timer
-
-Required properties:
-- compatible: must be "zii,rave-wdt"
-- reg: i2c slave address of device, usually 0x38
-
-Optional Properties:
-- timeout-sec: Watchdog timeout value in seconds.
-- reset-duration-ms: Duration of the pulse generated when the watchdog times
-  out. Value in milliseconds.
-
-Example:
-
-	watchdog@38 {
-		compatible = "zii,rave-wdt";
-		reg = <0x38>;
-		timeout-sec = <30>;
-		reset-duration-ms = <30>;
-	};
--
2.34.1

Re: [PATCH v2 1/1] dt-bindings: watchdog: convert ziirave-wdt.txt to yaml

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 3498 bytes --]

On Mon, Aug 12, 2024 at 12:28:09PM -0400, Frank Li wrote:
> Convert ziirave-wdt.txt to yaml format.
> 
> Additional change:
> - Add i2c node in example.
> - Add ref to watchdog.yaml
> 
> Fix below warning:
> arch/arm64/boot/dts/freescale/imx8mq-zii-ultra-rmb3.dtb: /soc@0/bus@30800000/i2c@30a40000/watchdog@38:
> 	failed to match any schema with compatible: ['zii,rave-wdt']
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
> Change from v1 to v2
> - add ref watchdog.yaml
> - Remove timeout-sec
> ---
>  .../bindings/watchdog/zii,rave-wdt.yaml       | 47 +++++++++++++++++++
>  .../bindings/watchdog/ziirave-wdt.txt         | 19 --------
>  2 files changed, 47 insertions(+), 19 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
>  delete mode 100644 Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt
> 
> diff --git a/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml b/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
> new file mode 100644
> index 0000000000000..0206d9ddf872d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
> @@ -0,0 +1,47 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/watchdog/zii,rave-wdt.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Zodiac RAVE Watchdog Timer
> +
> +maintainers:
> +  - Frank Li <Frank.Li@nxp.com>

When you're converting bindings, listing yourself as the maintainer only
really makes sense if you know/care about the hardware IMO.

> +
> +properties:
> +  compatible:
> +    const: zii,rave-wdt
> +
> +  reg:
> +    maxItems: 1
> +    description: i2c slave address of device, usually 0x38
> +
> +  reset-duration-ms:
> +    description:
> +      Duration of the pulse generated when the watchdog times
> +      out. Value in milliseconds.
              ^^^^^^^^^^^^^^^^^^^^^
This is obvious, and could have been dropped. Keep an eye out for things
like that while doing conversions.

Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

Thanks,
Conor.

> +
> +required:
> +  - compatible
> +  - reg
> +
> +allOf:
> +  - $ref: watchdog.yaml#
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        watchdog@38 {
> +            compatible = "zii,rave-wdt";
> +            reg = <0x38>;
> +            timeout-sec = <30>;
> +            reset-duration-ms = <30>;
> +        };
> +    };
> +
> diff --git a/Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt b/Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt
> deleted file mode 100644
> index 3d878184ec3ff..0000000000000
> --- a/Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt
> +++ /dev/null
> @@ -1,19 +0,0 @@
> -Zodiac RAVE Watchdog Timer
> -
> -Required properties:
> -- compatible: must be "zii,rave-wdt"
> -- reg: i2c slave address of device, usually 0x38
> -
> -Optional Properties:
> -- timeout-sec: Watchdog timeout value in seconds.
> -- reset-duration-ms: Duration of the pulse generated when the watchdog times
> -  out. Value in milliseconds.
> -
> -Example:
> -
> -	watchdog@38 {
> -		compatible = "zii,rave-wdt";
> -		reg = <0x38>;
> -		timeout-sec = <30>;
> -		reset-duration-ms = <30>;
> -	};
> --
> 2.34.1
> 
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH v2 1/1] dt-bindings: watchdog: convert ziirave-wdt.txt to yaml

[Frank Li]

On Tue, Aug 13, 2024 at 05:09:52PM +0100, Conor Dooley wrote:
> On Mon, Aug 12, 2024 at 12:28:09PM -0400, Frank Li wrote:
> > Convert ziirave-wdt.txt to yaml format.
> >
> > Additional change:
> > - Add i2c node in example.
> > - Add ref to watchdog.yaml
> >
> > Fix below warning:
> > arch/arm64/boot/dts/freescale/imx8mq-zii-ultra-rmb3.dtb: /soc@0/bus@30800000/i2c@30a40000/watchdog@38:
> > 	failed to match any schema with compatible: ['zii,rave-wdt']
> >
> > Signed-off-by: Frank Li <Frank.Li@nxp.com>
> > ---
> > Change from v1 to v2
> > - add ref watchdog.yaml
> > - Remove timeout-sec
> > ---
> >  .../bindings/watchdog/zii,rave-wdt.yaml       | 47 +++++++++++++++++++
> >  .../bindings/watchdog/ziirave-wdt.txt         | 19 --------
> >  2 files changed, 47 insertions(+), 19 deletions(-)
> >  create mode 100644 Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
> >  delete mode 100644 Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt
> >
> > diff --git a/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml b/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
> > new file mode 100644
> > index 0000000000000..0206d9ddf872d
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
> > @@ -0,0 +1,47 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/watchdog/zii,rave-wdt.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Zodiac RAVE Watchdog Timer
> > +
> > +maintainers:
> > +  - Frank Li <Frank.Li@nxp.com>
>
> When you're converting bindings, listing yourself as the maintainer only
> really makes sense if you know/care about the hardware IMO.

I faced this problem. I am not sure who I can put as maintainer. How to
decide binding doc maintainer? same as driver maintainer?

Frank

>
> > +
> > +properties:
> > +  compatible:
> > +    const: zii,rave-wdt
> > +
> > +  reg:
> > +    maxItems: 1
> > +    description: i2c slave address of device, usually 0x38
> > +
> > +  reset-duration-ms:
> > +    description:
> > +      Duration of the pulse generated when the watchdog times
> > +      out. Value in milliseconds.
>               ^^^^^^^^^^^^^^^^^^^^^
> This is obvious, and could have been dropped. Keep an eye out for things
> like that while doing conversions.
>
> Reviewed-by: Conor Dooley <conor.dooley@microchip.com>
>
> Thanks,
> Conor.
>
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +allOf:
> > +  - $ref: watchdog.yaml#
> > +
> > +unevaluatedProperties: false
> > +
> > +examples:
> > +  - |
> > +    i2c {
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +
> > +        watchdog@38 {
> > +            compatible = "zii,rave-wdt";
> > +            reg = <0x38>;
> > +            timeout-sec = <30>;
> > +            reset-duration-ms = <30>;
> > +        };
> > +    };
> > +
> > diff --git a/Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt b/Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt
> > deleted file mode 100644
> > index 3d878184ec3ff..0000000000000
> > --- a/Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt
> > +++ /dev/null
> > @@ -1,19 +0,0 @@
> > -Zodiac RAVE Watchdog Timer
> > -
> > -Required properties:
> > -- compatible: must be "zii,rave-wdt"
> > -- reg: i2c slave address of device, usually 0x38
> > -
> > -Optional Properties:
> > -- timeout-sec: Watchdog timeout value in seconds.
> > -- reset-duration-ms: Duration of the pulse generated when the watchdog times
> > -  out. Value in milliseconds.
> > -
> > -Example:
> > -
> > -	watchdog@38 {
> > -		compatible = "zii,rave-wdt";
> > -		reg = <0x38>;
> > -		timeout-sec = <30>;
> > -		reset-duration-ms = <30>;
> > -	};
> > --
> > 2.34.1
> >
> >

Re: [PATCH v2 1/1] dt-bindings: watchdog: convert ziirave-wdt.txt to yaml

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 2137 bytes --]

On Tue, Aug 13, 2024 at 12:32:36PM -0400, Frank Li wrote:
> On Tue, Aug 13, 2024 at 05:09:52PM +0100, Conor Dooley wrote:
> > On Mon, Aug 12, 2024 at 12:28:09PM -0400, Frank Li wrote:
> > > Convert ziirave-wdt.txt to yaml format.
> > >
> > > Additional change:
> > > - Add i2c node in example.
> > > - Add ref to watchdog.yaml
> > >
> > > Fix below warning:
> > > arch/arm64/boot/dts/freescale/imx8mq-zii-ultra-rmb3.dtb: /soc@0/bus@30800000/i2c@30a40000/watchdog@38:
> > > 	failed to match any schema with compatible: ['zii,rave-wdt']
> > >
> > > Signed-off-by: Frank Li <Frank.Li@nxp.com>
> > > ---
> > > Change from v1 to v2
> > > - add ref watchdog.yaml
> > > - Remove timeout-sec
> > > ---
> > >  .../bindings/watchdog/zii,rave-wdt.yaml       | 47 +++++++++++++++++++
> > >  .../bindings/watchdog/ziirave-wdt.txt         | 19 --------
> > >  2 files changed, 47 insertions(+), 19 deletions(-)
> > >  create mode 100644 Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
> > >  delete mode 100644 Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt
> > >
> > > diff --git a/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml b/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
> > > new file mode 100644
> > > index 0000000000000..0206d9ddf872d
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
> > > @@ -0,0 +1,47 @@
> > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > > +%YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/watchdog/zii,rave-wdt.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: Zodiac RAVE Watchdog Timer
> > > +
> > > +maintainers:
> > > +  - Frank Li <Frank.Li@nxp.com>
> >
> > When you're converting bindings, listing yourself as the maintainer only
> > really makes sense if you know/care about the hardware IMO.
> 
> I faced this problem. I am not sure who I can put as maintainer. How to
> decide binding doc maintainer? same as driver maintainer?

Same as the driver maintainer is usually the way to go, yeah.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]