doc: usage: add usage details for reset cmd
authorIgor Opaniuk <igor.opaniuk@foundries.io>
Wed, 31 Mar 2021 23:01:56 +0000 (02:01 +0300)
committerTom Rini <trini@konsulko.com>
Tue, 20 Apr 2021 11:31:12 +0000 (07:31 -0400)
Add usage details for reset command.

Signed-off-by: Igor Opaniuk <igor.opaniuk@foundries.io>
doc/usage/index.rst
doc/usage/reset.rst [new file with mode: 0644]

index b64cfe4..528b3c7 100644 (file)
@@ -40,3 +40,4 @@ Shell commands
    sbi
    true
    scp03
+   reset
diff --git a/doc/usage/reset.rst b/doc/usage/reset.rst
new file mode 100644 (file)
index 0000000..384d5d6
--- /dev/null
@@ -0,0 +1,26 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+reset command
+=============
+
+Synopsis
+--------
+
+::
+
+    reset [-w]
+
+Description
+-----------
+
+Perform reset of the CPU. By default does COLD reset, which resets CPU,
+DDR and peripherals, on some boards also resets external PMIC.
+
+-w
+    Do warm WARM, reset CPU but keep peripheral/DDR/PMIC active.
+
+
+Return value
+------------
+
+The return value $? is always set to 0 (true).