diff mbox series

doc: device-tree-bindings: watchdog: document common properties

Message ID 20220309135619.10334-1-philippe.reynes@softathome.com
State Accepted
Commit 33ef09072beb6330eaeae5c3fb039f5af31701ee
Delegated to: Stefan Roese
Headers show
Series doc: device-tree-bindings: watchdog: document common properties | expand

Commit Message

Philippe REYNES March 9, 2022, 1:56 p.m. UTC
Adds simple documentation about common properties for watchdog
in the device tree.

Signed-off-by: Philippe Reynes <philippe.reynes@softathome.com>
---
 doc/device-tree-bindings/watchdog/common.txt | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 doc/device-tree-bindings/watchdog/common.txt

Comments

Stefan Roese March 10, 2022, 7:45 a.m. UTC | #1
On 3/9/22 14:56, Philippe Reynes wrote:
> 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>

Thanks,
Stefan

> ---
>   doc/device-tree-bindings/watchdog/common.txt | 12 ++++++++++++
>   1 file changed, 12 insertions(+)
>   create mode 100644 doc/device-tree-bindings/watchdog/common.txt
> 
> diff --git a/doc/device-tree-bindings/watchdog/common.txt b/doc/device-tree-bindings/watchdog/common.txt
> new file mode 100644
> index 0000000000..9db6dd6146
> --- /dev/null
> +++ b/doc/device-tree-bindings/watchdog/common.txt
> @@ -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.

Viele Grüße,
Stefan Roese
Stefan Roese April 22, 2022, 9:52 a.m. UTC | #2
On 3/9/22 14:56, Philippe Reynes wrote:
> Adds simple documentation about common properties for watchdog
> in the device tree.
> 
> Signed-off-by: Philippe Reynes <philippe.reynes@softathome.com>

Applied to u-boot-watchdog/master

Thanks,
Stefan

> ---
>   doc/device-tree-bindings/watchdog/common.txt | 12 ++++++++++++
>   1 file changed, 12 insertions(+)
>   create mode 100644 doc/device-tree-bindings/watchdog/common.txt
> 
> diff --git a/doc/device-tree-bindings/watchdog/common.txt b/doc/device-tree-bindings/watchdog/common.txt
> new file mode 100644
> index 0000000000..9db6dd6146
> --- /dev/null
> +++ b/doc/device-tree-bindings/watchdog/common.txt
> @@ -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.

Viele Grüße,
Stefan Roese
diff mbox series

Patch

diff --git a/doc/device-tree-bindings/watchdog/common.txt b/doc/device-tree-bindings/watchdog/common.txt
new file mode 100644
index 0000000000..9db6dd6146
--- /dev/null
+++ b/doc/device-tree-bindings/watchdog/common.txt
@@ -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.