doc: device-tree-bindings: watchdog: document common properties
authorPhilippe Reynes <philippe.reynes@softathome.com>
Wed, 9 Mar 2022 13:56:19 +0000 (14:56 +0100)
committerStefan Roese <sr@denx.de>
Fri, 22 Apr 2022 07:02:34 +0000 (09:02 +0200)
Adds simple documentation about common properties for watchdog
in the device tree.

Signed-off-by: Philippe Reynes <philippe.reynes@softathome.com>
Reviewed-by: Stefan Roese <sr@denx.de>
doc/device-tree-bindings/watchdog/common.txt [new file with mode: 0644]

diff --git a/doc/device-tree-bindings/watchdog/common.txt b/doc/device-tree-bindings/watchdog/common.txt
new file mode 100644 (file)
index 0000000..9db6dd6
--- /dev/null
@@ -0,0 +1,12 @@
+Common watchdog properties.
+
+Optional properties:
+- timeout-sec : Timeout of the watchdog in seconds
+                If this timeout is not defined, the value of WATCHDOG_TIMEOUT_MSECS will
+                be used instead.
+- hw_margin_ms : Period used to reset the watchdog in ms
+                 If this period is not defined, the default value is 1000.
+- u-boot,noautostart : Specify that this watchdog should not autostart
+                       When the config option WATCHDOG_AUTOSTART is set, all enabled
+                       watchdogs are started. This property allows specifying that this
+                       watchdog should NOT be started.