summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorAhmad Fatoum <a.fatoum@pengutronix.de>2022-01-24 16:18:27 +0100
committerSascha Hauer <s.hauer@pengutronix.de>2022-01-26 10:01:42 +0100
commit76eb838beb702f6d81768d31cb8f602c2fcc834b (patch)
treeca0cbd8ea3cd7b53a19d2ec453db9abce78f7711 /Documentation
parentc0fc382fec29d3faac380098ae462254f2559910 (diff)
downloadbarebox-76eb838beb702f6d81768d31cb8f602c2fcc834b.tar.gz
barebox-76eb838beb702f6d81768d31cb8f602c2fcc834b.tar.xz
Documentation: user: watchdog: note new wd -x option
wd command documentation is generated automatically and will list the new -x option. It's still a good idea to reference this in the watchdog user doc as well. Do so. Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Link: https://lore.barebox.org/20220124151827.3313412-6-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/user/watchdog.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/Documentation/user/watchdog.rst b/Documentation/user/watchdog.rst
index ff400317a0..0220965598 100644
--- a/Documentation/user/watchdog.rst
+++ b/Documentation/user/watchdog.rst
@@ -10,6 +10,15 @@ the bootloader. For these scenarios barebox provides the watchdog framework
with the following functionality and at least ``CONFIG_WATCHDOG`` should be
enabled.
+Disabling for development
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The shorthand command ``wd -x`` will disable all watchdogs.
+If hardware (or driver) doesn't support turning off the watchdog,
+an autpoller will be registered to periodically feed watchdogs.
+This should only be needed for development.
+See :ref:`boot-watchdog-timeout` for how to use the watchdog in the field.
+
Polling
~~~~~~~
@@ -98,6 +107,8 @@ device tree or via the ``priority`` device parameter. Normally, watchdogs
that have a wider effect should be given the higher priority (e.g.
PMIC watchdog resetting the board vs. SoC's watchdog resetting only itself).
+.. _boot-watchdog-timeout:
+
Boot Watchdog Timeout
~~~~~~~~~~~~~~~~~~~~~