dt-bindings: watchdog: gpio: Convert bindings to YAML

Commit Message

Marek Vasut Nov. 2, 2022, 7:20 p.m. UTC

Convert the gpio-wdt bindings from text to YAML ones, to permit DT validation.

Signed-off-by: Marek Vasut <[e-mail]>
---
Cc: Guenter Roeck <[e-mail]>
Cc: Rob Herring <[e-mail]>
Cc: Wim Van Sebroeck <[e-mail]>
Cc: [e-mail]
To: [e-mail]
---
NOTE: The Maintainer entry should likely be changed, although it seems
      like this driver and its matching bindings are now unmaintained.
---
 .../devicetree/bindings/watchdog/gpio-wdt.txt | 28 ------------
 .../bindings/watchdog/linux,wdt-gpio.yaml     | 44 +++++++++++++++++++
 2 files changed, 44 insertions(+), 28 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
 create mode 100644 Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml

Comments

Rob Herring Nov. 2, 2022, 7:39 p.m. UTC | #1

On Wed, Nov 2, 2022 at 2:20 PM Marek Vasut <[e-mail]> wrote:
>
> Convert the gpio-wdt bindings from text to YAML ones, to permit DT validation.
>
> Signed-off-by: Marek Vasut <[e-mail]>
> ---
> Cc: Guenter Roeck <[e-mail]>
> Cc: Rob Herring <[e-mail]>
> Cc: Wim Van Sebroeck <[e-mail]>
> Cc: [e-mail]
> To: [e-mail]
> ---
> NOTE: The Maintainer entry should likely be changed, although it seems
>       like this driver and its matching bindings are now unmaintained.
> ---
>  .../devicetree/bindings/watchdog/gpio-wdt.txt | 28 ------------
>  .../bindings/watchdog/linux,wdt-gpio.yaml     | 44 +++++++++++++++++++
>  2 files changed, 44 insertions(+), 28 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
>  create mode 100644 Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml

Looks fine, but please resend to the DT list.

Rob

Patch

diff --git a/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt b/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
deleted file mode 100644
index 198794963786b..0000000000000
--- a/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
+++ /dev/null
@@ -1,28 +0,0 @@ 
-* GPIO-controlled Watchdog
-
-Required Properties:
-- compatible: Should contain "linux,wdt-gpio".
-- gpios: From common gpio binding; gpio connection to WDT reset pin.
-- hw_algo: The algorithm used by the driver. Should be one of the
-  following values:
-  - toggle: Either a high-to-low or a low-to-high transition clears
-    the WDT counter. The watchdog timer is disabled when GPIO is
-    left floating or connected to a three-state buffer.
-  - level: Low or high level starts counting WDT timeout,
-    the opposite level disables the WDT. Active level is determined
-    by the GPIO flags.
-- hw_margin_ms: Maximum time to reset watchdog circuit (milliseconds).
-
-Optional Properties:
-- always-running: If the watchdog timer cannot be disabled, add this flag to
-  have the driver keep toggling the signal without a client. It will only cease
-  to toggle the signal when the device is open and the timeout elapsed.
-
-Example:
-	watchdog: watchdog {
-		/* ADM706 */
-		compatible = "linux,wdt-gpio";
-		gpios = <&gpio3 9 GPIO_ACTIVE_LOW>;
-		hw_algo = "toggle";
-		hw_margin_ms = <1600>;
-	};
diff --git a/Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml b/Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml
new file mode 100644
index 0000000000000..6b014d60c9471
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml
@@ -0,0 +1,44 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/linux,wdt-gpio.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: GPIO-controlled Watchdog
+
+maintainers:
+  - Marek Vasut <[e-mail]>
+
+properties:
+  compatible:
+    const: linux,wdt-gpio
+
+  gpios:
+    description: gpio connection to WDT reset pin
+    maxItems: 1
+
+  hw_algo:
+    description: The algorithm used by the driver.
+    enum: [ level, toggle ]
+
+  hw_margin_ms:
+    description: Maximum time to reset watchdog circuit (milliseconds).
+    $ref: /schemas/types.yaml#/definitions/uint32
+
+required:
+  - compatible
+
+allOf:
+  - $ref: "watchdog.yaml#"
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    watchdog {
+        compatible = "linux,wdt-gpio";
+        gpios = <&gpio3 9 GPIO_ACTIVE_LOW>;
+        hw_algo = "toggle";
+        hw_margin_ms = <1600>;
+    };