From 76eb838beb702f6d81768d31cb8f602c2fcc834b Mon Sep 17 00:00:00 2001 From: Ahmad Fatoum Date: Mon, 24 Jan 2022 16:18:27 +0100 Subject: 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 Link: https://lore.barebox.org/20220124151827.3313412-6-a.fatoum@pengutronix.de Signed-off-by: Sascha Hauer --- Documentation/user/watchdog.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'Documentation/user/watchdog.rst') 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 ~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3