Skip to contentSkip to conversation

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

PATCH RESEND Superseded Marek Vasut 2 participants 4 messages Nov 2, 2022 – Nov 3, 2022

Subsystems (2)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH RESEND 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: Rob Herring <[email protected]>
Cc: Wim Van Sebroeck <[email protected]>
Cc: [email protected]
To: [email protected]
---
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
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 +44 -0

44 lines not on this page · raw message

Signature · 1 line
2.35.1
#1 lore raw
Quoted 12 lines · Marek Vasut

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

---
Cc: Guenter Roeck <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Wim Van Sebroeck <[email protected]>
Cc: [email protected]
To: [email protected]
---
NOTE: The Maintainer entry should likely be changed, although it seems
like this driver and its matching bindings are now unmaintained.

Please use scripts/get_maintainers.pl to get a list of necessary people and lists to CC. It might happen, that command when run on an older kernel, gives you outdated entries. Therefore please be sure you base your patches on recent Linux kernel.

Even if driver does not have updated maintainers entry, generic rules apply.

Quoted 66 lines
---
 .../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
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 +19 -0
new file mode 100644
index 0000000000000..6b014d60c9471
@@ -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 <[email protected]>
+
+properties:
+  compatible:
+    const: linux,wdt-gpio
+
+  gpios:
+    description: gpio connection to WDT reset pin
+    maxItems: 1
+

Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml line 29

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

Several other properties were required.

Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml line 32

Quoted 3 lines
Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml new file +3 -0
+
+allOf:
+  - $ref: "watchdog.yaml#"

Drop quotes

Best regards,
Krzysztof

#2 lore raw
Quoted 14 lines · Krzysztof Kozlowski
Quoted 12 lines · Marek Vasut

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

---
Cc: Guenter Roeck <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Wim Van Sebroeck <[email protected]>
Cc: [email protected]
To: [email protected]
---
NOTE: The Maintainer entry should likely be changed, although it seems
like this driver and its matching bindings are now unmaintained.

Quoted 6 lines

Please use scripts/get_maintainers.pl to get a list of necessary people and lists to CC. It might happen, that command when run on an older kernel, gives you outdated entries. Therefore please be sure you base your patches on recent Linux kernel.

Even if driver does not have updated maintainers entry, generic rules apply.

I'm based on next-20221102, i.e. todays' next, should be recent enough.

$ ./scripts/get_maintainer.pl -f drivers/watchdog/gpio_wdt.c
Wim Van Sebroeck <[email protected]> (maintainer:WATCHDOG DEVICE DRIVERS)
Guenter Roeck <[email protected]> (maintainer:WATCHDOG DEVICE DRIVERS)
[email protected] (open list:WATCHDOG DEVICE DRIVERS)
[email protected] (open list)

Running it against the bindings file, old or new, just adds the DT maintainers into the list, so not much help either. Hence the NOTE.

[...]

The rest is fixed in v2, thanks.

#3 lore raw
Quoted 31 lines · Marek Vasut
Quoted 14 lines · Krzysztof Kozlowski
Quoted 12 lines · Marek Vasut

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

---
Cc: Guenter Roeck <[email protected]>
Cc: Rob Herring <[email protected]>
Cc: Wim Van Sebroeck <[email protected]>
Cc: [email protected]
To: [email protected]
---
NOTE: The Maintainer entry should likely be changed, although it seems
like this driver and its matching bindings are now unmaintained.

Quoted 6 lines

Please use scripts/get_maintainers.pl to get a list of necessary people and lists to CC. It might happen, that command when run on an older kernel, gives you outdated entries. Therefore please be sure you base your patches on recent Linux kernel.

Even if driver does not have updated maintainers entry, generic rules apply.

I'm based on next-20221102, i.e. todays' next, should be recent enough.

$ ./scripts/get_maintainer.pl -f drivers/watchdog/gpio_wdt.c
Wim Van Sebroeck <[email protected]> (maintainer:WATCHDOG DEVICE 
DRIVERS)
Guenter Roeck <[email protected]> (maintainer:WATCHDOG DEVICE DRIVERS)
[email protected] (open list:WATCHDOG DEVICE DRIVERS)
[email protected] (open list)
Quoted 2 lines

Running it against the bindings file, old or new, just adds the DT maintainers into the list, so not much help either. Hence the NOTE.

Yet you did not CC all DT binding maintainers, hence my reply.

Best regards,
Krzysztof