diff options
| author | Tom Rini <trini@konsulko.com> | 2022-03-28 12:36:49 -0400 |
|---|---|---|
| committer | Tom Rini <trini@konsulko.com> | 2022-03-28 12:36:49 -0400 |
| commit | 34d2b7f20369d62c0f091d6572a8c0ea4655cf14 (patch) | |
| tree | 0591ee99c118e0e196730b6ec6582986200e6313 /doc/usage | |
| parent | 7f0826c169ff14d62e92d02f85d33d0030d45c12 (diff) | |
| parent | e893e8ea6a5d3af312747d00f93587559193a426 (diff) | |
| download | u-boot-34d2b7f20369d62c0f091d6572a8c0ea4655cf14.tar.gz u-boot-34d2b7f20369d62c0f091d6572a8c0ea4655cf14.tar.bz2 u-boot-34d2b7f20369d62c0f091d6572a8c0ea4655cf14.zip | |
Merge tag 'v2022.04-rc5' into next
Prepare v2022.04-rc5
Diffstat (limited to 'doc/usage')
| -rw-r--r-- | doc/usage/index.rst | 1 | ||||
| -rw-r--r-- | doc/usage/wdt.rst | 77 |
2 files changed, 78 insertions, 0 deletions
diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 750102830b..5b42579dfc 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -53,3 +53,4 @@ Shell commands size true ums + wdt diff --git a/doc/usage/wdt.rst b/doc/usage/wdt.rst new file mode 100644 index 0000000000..8d80433c1f --- /dev/null +++ b/doc/usage/wdt.rst @@ -0,0 +1,77 @@ +.. SPDX-License-Identifier: GPL-2.0+: + +wdt command +============ + +Synopsis +-------- + +:: + + wdt list + wdt dev [<name>] + wdt start <timeout_ms> [flags] + wdt stop + wdt reset + wdt expirer [flags] + +Description +----------- + +The wdt command is used to control watchdog timers. + +The 'wdt list' command shows a list of all watchdog devices. + +The 'wdt dev' command called without argument shows the current watchdog device. +The current device is set when passing the name of the device as argument. + +The 'wdt start' command starts the current watchdog timer. + +The 'wdt stop' command stops the current watchdog timer. + +The 'wdt reset' command resets the current watchdog timer without stopping it. + +The 'wdt expire' command let's the current watchdog timer expire immediately. +This will lead to a reset. + +name + name of the watchdog device + +timeout_ms + timeout interval in milliseconds + +flags + unsigned long value passed to the driver. The usage is driver specific. + The value is ignored by most drivers. + +Example +------- + +:: + + => wdt dev + No watchdog timer device set! + => wdt list + watchdog@1c20ca0 (sunxi_wdt) + => wdt dev watchdog@1c20ca0 + => wdt dev + dev: watchdog@1c20ca0 + => wdt start 3000 + => wdt reset + => wdt stop + => wdt expire + + U-Boot SPL 2022.04-rc3 (Mar 25 2022 - 13:48:33 +0000) + + In the example above '(sunxi_wdt)' refers to the driver for the watchdog + device. + +Configuration +------------- + +The command is only available if CONFIG_CMD_WDT=y. + +Return value +------------ + +The return value $? is 0 if the command succeeds, 1 upon failure. |