2023-10-06 11:12:06

by Nik Bune

Subject: [PATCH] dt-bindings: watchdog: da9062-wdt: convert txt to yaml

Convert txt file to yaml.

Signed-off-by: Nik Bune <[email protected]>
---
.../bindings/watchdog/da9062-wdt.txt | 34 ------------
.../bindings/watchdog/da9062-wdt.yaml | 52 +++++++++++++++++++
2 files changed, 52 insertions(+), 34 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/watchdog/da9062-wdt.txt
create mode 100644 Documentation/devicetree/bindings/watchdog/da9062-wdt.yaml

diff --git a/Documentation/devicetree/bindings/watchdog/da9062-wdt.txt b/Documentation/devicetree/bindings/watchdog/da9062-wdt.txt
deleted file mode 100644
index 354314d854ef..000000000000
--- a/Documentation/devicetree/bindings/watchdog/da9062-wdt.txt
+++ /dev/null
@@ -1,34 +0,0 @@
-* Dialog Semiconductor DA9062/61 Watchdog Timer
-
-Required properties:
-
-- compatible: should be one of the following valid compatible string lines:
- "dlg,da9061-watchdog", "dlg,da9062-watchdog"
- "dlg,da9062-watchdog"
-
-Optional properties:
-- dlg,use-sw-pm: Add this property to disable the watchdog during suspend.
- Only use this option if you can't use the watchdog automatic suspend
- function during a suspend (see register CONTROL_B).
-- dlg,wdt-sd: Set what happens on watchdog timeout. If this bit is set the
- watchdog timeout triggers SHUTDOWN, if cleared the watchdog triggers
- POWERDOWN. Can be 0 or 1. Only use this option if you want to change the
- default chip's OTP setting for WATCHDOG_SD bit. If this property is NOT
- set the WATCHDOG_SD bit and on timeout watchdog behavior will match the
- chip's OTP settings.
-
-Example: DA9062
-
- pmic0: da9062@58 {
- watchdog {
- compatible = "dlg,da9062-watchdog";
- };
- };
-
-Example: DA9061 using a fall-back compatible for the DA9062 watchdog driver
-
- pmic0: da9061@58 {
- watchdog {
- compatible = "dlg,da9061-watchdog", "dlg,da9062-watchdog";
- };
- };
diff --git a/Documentation/devicetree/bindings/watchdog/da9062-wdt.yaml b/Documentation/devicetree/bindings/watchdog/da9062-wdt.yaml
new file mode 100644
index 000000000000..9911cc3068cf
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/da9062-wdt.yaml
@@ -0,0 +1,52 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/da9062-wdt.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Dialog Semiconductor DA9062/61 Watchdog Timer
+
+maintainers:
+ - Steve Twiss <[email protected]>
+
+allOf:
+ - $ref: watchdog.yaml#
+
+properties:
+ compatible:
+ enum:
+ - dlg,da9061-watchdog
+ - dlg,da9062-watchdog
+
+ reg:
+ maxItems: 1
+
+ dlg,use-sw-pm:
+ type: boolean
+ description: >
+ Add this property to disable the watchdog during suspend.
+ Only use this option if you can't use the watchdog automatic suspend
+ function during a suspend (see register CONTROL_B).
+
+ dlg,wdt-sd:
+ type: boolean
+ description: >
+ Set what happens on watchdog timeout. If this bit is set the
+ watchdog timeout triggers SHUTDOWN, if cleared the watchdog triggers
+ POWERDOWN. Can be 0 or 1. Only use this option if you want to change the
+ default chip's OTP setting for WATCHDOG_SD bit. If this property is NOT
+ set the WATCHDOG_SD bit and on timeout watchdog behavior will match the
+ chip's OTP settings.
+
+required:
+ - compatible
+ - reg
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ watchdog@fffffd00 {
+ compatible = "dlg,da9062-watchdog";
+ reg = <0xfffffd00 0x10>;
+ };
--
2.34.1

2023-10-09 08:59:50

by Krzysztof Kozlowski

Subject: Re: [PATCH] dt-bindings: watchdog: da9062-wdt: convert txt to yaml

On 06/10/2023 13:11, Nik Bune wrote:
> Convert txt file to yaml.

Please mention changes done during conversion with justification (e.g.
adding reg already used by something).

>

...

> diff --git a/Documentation/devicetree/bindings/watchdog/da9062-wdt.yaml b/Documentation/devicetree/bindings/watchdog/da9062-wdt.yaml
> new file mode 100644
> index 000000000000..9911cc3068cf
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/da9062-wdt.yaml

Filename based on compatible, so:
dlg,da9062-watchdog.yaml


> @@ -0,0 +1,52 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/watchdog/da9062-wdt.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Dialog Semiconductor DA9062/61 Watchdog Timer
> +
> +maintainers:
> + - Steve Twiss <[email protected]>
> +
> +allOf:
> + - $ref: watchdog.yaml#
> +
> +properties:
> + compatible:
> + enum:
> + - dlg,da9061-watchdog
> + - dlg,da9062-watchdog
> +
> + reg:
> + maxItems: 1
> +
> + dlg,use-sw-pm:
> + type: boolean
> + description: >

No need for >

> + Add this property to disable the watchdog during suspend.
> + Only use this option if you can't use the watchdog automatic suspend
> + function during a suspend (see register CONTROL_B).
> +
> + dlg,wdt-sd:
> + type: boolean
> + description: >

No need for >

> + Set what happens on watchdog timeout. If this bit is set the
> + watchdog timeout triggers SHUTDOWN, if cleared the watchdog triggers
> + POWERDOWN. Can be 0 or 1. Only use this option if you want to change the
> + default chip's OTP setting for WATCHDOG_SD bit. If this property is NOT
> + set the WATCHDOG_SD bit and on timeout watchdog behavior will match the
> + chip's OTP settings.
> +
> +required:
> + - compatible
> + - reg
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + watchdog@fffffd00 {
> + compatible = "dlg,da9062-watchdog";
> + reg = <0xfffffd00 0x10>;

It's nice to add here some properties to make example complete.

> + };

Best regards,
Krzysztof