diff mbox series

[RESEND,v3,5/5] doc: usage: add usage details for reset cmd

Message ID 20210331201855.1425276-6-igor.opaniuk@gmail.com
State Superseded
Headers show
Series psci: add support for SYSTEM_RESET2 and PSCI_FEATURES | expand

Commit Message

Igor Opaniuk March 31, 2021, 8:18 p.m. UTC 
From: Igor Opaniuk <igor.opaniuk@foundries.io>

Add usage details for reset command.

Signed-off-by: Igor Opaniuk <igor.opaniuk@foundries.io>

---

 doc/usage/index.rst |  1 +
 doc/usage/reset.rst | 26 ++++++++++++++++++++++++++
 2 files changed, 27 insertions(+)
 create mode 100644 doc/usage/reset.rst
diff mbox series

Patch

diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 6c59bbadab..b1181011ae 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -34,3 +34,4 @@  Shell commands
    qfw
    sbi
    true
+   reset
diff --git a/doc/usage/reset.rst b/doc/usage/reset.rst
new file mode 100644
index 0000000000..f8cf3579c8
--- /dev/null
+++ b/doc/usage/reset.rst
@@ -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).