Skip to contentSkip to conversation

dt-bindings: watchdog: convert ziirave-wdt.txt to yaml

PATCH Superseded Frank Li 2 participants 4 messages Aug 12, 2024 – Aug 14, 2024

Subsystems (3)

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Frank Li

author maintainer
#0 lore raw

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

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']

---
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
Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml new file +47 -0
new file mode 100644
index 0000000000000..0206d9ddf872d
@@ -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 <[email protected]>
+
+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>;
+        };
+    };
+
Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt deleted +0 -19
deleted file mode 100644
index 3d878184ec3ff..0000000000000
@@ -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

Reviewed-by on v2 1/1
#1 lore raw
Quoted 28 lines · 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']

---
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
Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml new file +0 -0
new file mode 100644
index 0000000000000..0206d9ddf872d

Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml line 10

Quoted 10 lines
Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml new file +10 -0
@@ -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 <[email protected]>

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

Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml line 23

Quoted 13 lines
Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml new file +13 -0
+
+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.

Thanks,
Conor.

Quoted 53 lines
Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml new file +24 -0
+
+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>;
+        };
+    };
+
Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt deleted +0 -20
deleted file mode 100644
index 3d878184ec3ff..0000000000000
@@ -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

author maintainer
#2 lore raw
Quoted 34 lines · Conor Dooley
Quoted 33 lines · 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']

---
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
Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml new file +5 -0
new file mode 100644
index 0000000000000..0206d9ddf872d
@@ -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#
Quoted 8 lines

Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml line 10

Quoted 5 lines
Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml new file +5 -0
+
+title: Zodiac RAVE Watchdog Timer
+
+maintainers:
+  - Frank Li <[email protected]>

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

Quoted 76 lines
Quoted 4 lines
Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml new file +3 -0
+
+properties:
+  compatible:

Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml line 23

Quoted 10 lines
Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml new file +10 -0
+    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.

Thanks,
Conor.

Quoted 53 lines
Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml new file +24 -0
+
+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>;
+        };
+    };
+
Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt deleted +0 -20
deleted file mode 100644
index 3d878184ec3ff..0000000000000
@@ -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

#3 lore raw
Quoted 44 lines · Frank Li
Quoted 34 lines · Conor Dooley
Quoted 33 lines · 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']

---
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
Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml new file +5 -0
new file mode 100644
index 0000000000000..0206d9ddf872d
@@ -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#
Quoted 8 lines

Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml line 10

Quoted 5 lines
Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml new file +5 -0
+
+title: Zodiac RAVE Watchdog Timer
+
+maintainers:
+  - Frank Li <[email protected]>

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

Quoted 2 lines

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.