Skip to contentSkip to conversation

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

PATCH In review Marek Vasut 3 participants 5 messages Nov 7, 2022 – Dec 15, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 dt-bindings: watchdog: gpio: Convert bindings to YAML

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

---
Cc: Guenter Roeck <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Wim Van Sebroeck <[email protected]>
Cc: [email protected]
To: [email protected]
---
V2: - Add missing required: properties
- Drop quotes around ref: referenced schema file name
V3: - Add Guenter as maintainer of the bindings
- Add RB from Rob

---
 .../devicetree/bindings/watchdog/gpio-wdt.txt | 28 -----------
 .../bindings/watchdog/linux,wdt-gpio.yaml     | 47 +++++++++++++++++++
 2 files changed, 47 insertions(+), 28 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
 create mode 100644 Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml
Documentation/devicetree/bindings/watchdog/gpio-wdt.txt deleted +0 -28
deleted file mode 100644
index 198794963786b..0000000000000
@@ -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>;
-	};
Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml new file +47 -0

47 lines not on this page · raw message

Signature · 1 line
2.35.1
maintainer Reviewed-by on v3 1/1
#1 lore raw
Quoted 4 lines · Marek Vasut

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

Quoted 109 lines

---
Cc: Guenter Roeck <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Wim Van Sebroeck <[email protected]>
Cc: [email protected]
To: [email protected]
---
V2: - Add missing required: properties
- Drop quotes around ref: referenced schema file name
V3: - Add Guenter as maintainer of the bindings
- Add RB from Rob

---
 .../devicetree/bindings/watchdog/gpio-wdt.txt | 28 -----------
 .../bindings/watchdog/linux,wdt-gpio.yaml     | 47 +++++++++++++++++++
 2 files changed, 47 insertions(+), 28 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
 create mode 100644 Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml
Documentation/devicetree/bindings/watchdog/gpio-wdt.txt deleted +0 -28
deleted file mode 100644
index 198794963786b..0000000000000
@@ -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>;
-	};
Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml new file +47 -0
new file mode 100644
index 0000000000000..c729c96a5dc75
@@ -0,0 +1,47 @@
+# 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:
+  - Guenter Roeck <[email protected]>
+
+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
+  - gpios
+  - hw_algo
+  - hw_margin_ms
+
+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>;
+    };
Signature · 1 line
2.35.1
maintainer
#2 lore raw
In reply to Marek Vasut
Quoted 16 lines · Marek Vasut

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

---
Cc: Guenter Roeck <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Wim Van Sebroeck <[email protected]>
Cc: [email protected]
To: [email protected]
---
V2: - Add missing required: properties
- Drop quotes around ref: referenced schema file name
V3: - Add Guenter as maintainer of the bindings
- Add RB from Rob

Quoted 7 lines
---
 .../devicetree/bindings/watchdog/gpio-wdt.txt | 28 -----------
 .../bindings/watchdog/linux,wdt-gpio.yaml     | 47 +++++++++++++++++++
 2 files changed, 47 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 like this was missed. Applied, thanks! You missed 'always-running', so I added it from the other conversion that was done[1].

Rob

[1] https://lore.kernel.org/all/[email protected]/

#3 lore raw
Quoted 26 lines · Rob Herring
Quoted 16 lines · Marek Vasut

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

---
Cc: Guenter Roeck <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Wim Van Sebroeck <[email protected]>
Cc: [email protected]
To: [email protected]
---
V2: - Add missing required: properties
- Drop quotes around ref: referenced schema file name
V3: - Add Guenter as maintainer of the bindings
- Add RB from Rob

Quoted 7 lines
---
  .../devicetree/bindings/watchdog/gpio-wdt.txt | 28 -----------
  .../bindings/watchdog/linux,wdt-gpio.yaml     | 47 +++++++++++++++++++
  2 files changed, 47 insertions(+), 28 deletions(-)

delete mode 100644 Documentation/devicetree/bindings/watchdog/gpio-wdt.txt create mode 100644 Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml

Quoted 7 lines

Looks like this was missed. Applied, thanks! You missed 'always-running', so I added it from the other conversion that was done[1].

Rob

[1] https://lore.kernel.org/all/[email protected]/

There is no 'always-enabled' DT property used anywhere in the Linux kernel, at least 'git grep' in latest next-20221215 indicates so. Shall we really add it in the bindings ?

#4 lore raw
Quoted 31 lines · Marek Vasut
Quoted 30 lines · Rob Herring
Quoted 19 lines · Marek Vasut

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

---
Cc: Guenter Roeck <[email protected]>
Cc: Krzysztof Kozlowski <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Wim Van Sebroeck <[email protected]>
Cc: [email protected]
To: [email protected]
---
V2: - Add missing required: properties
     - Drop quotes around ref: referenced schema file name
V3: - Add Guenter as maintainer of the bindings
     - Add RB from Rob
---
  .../devicetree/bindings/watchdog/gpio-wdt.txt | 28 ----------- .../bindings/watchdog/linux,wdt-gpio.yaml     | 47 +++++++++++++++++++

Quoted 4 lines
  2 files changed, 47 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 like this was missed. Applied, thanks! You missed 'always-running', so I added it from the other conversion that was done[1].

Quoted 5 lines
Quoted 3 lines

Rob

[1] https://lore.kernel.org/all/[email protected]/

There is no 'always-enabled' DT property used anywhere in the Linux kernel, at least 'git grep' in latest next-20221215 indicates so. Shall we really add it in the bindings ?

Please ignore what I wrote, always-running was indeed missed.