doc: document sbi command
authorHeinrich Schuchardt <xypron.glpk@gmx.de>
Tue, 19 Jan 2021 18:30:04 +0000 (19:30 +0100)
committerHeinrich Schuchardt <xypron.glpk@gmx.de>
Mon, 25 Jan 2021 00:15:33 +0000 (01:15 +0100)
Add a man-page for the sbi command.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
MAINTAINERS
doc/usage/index.rst
doc/usage/sbi.rst [new file with mode: 0644]

index a7a62df..e7a6dd9 100644 (file)
@@ -951,6 +951,7 @@ S:  Maintained
 T:     git https://gitlab.denx.de/u-boot/custodians/u-boot-riscv.git
 F:     arch/riscv/
 F:     cmd/riscv/
+F:     doc/usage/sbi.rst
 F:     drivers/timer/andes_plmt_timer.c
 F:     drivers/timer/sifive_clint_timer.c
 F:     tools/prelink-riscv.c
index 6def250..eedcdb1 100644 (file)
@@ -19,3 +19,4 @@ Shell commands
    button
    mbr
    pstore
+   sbi
diff --git a/doc/usage/sbi.rst b/doc/usage/sbi.rst
new file mode 100644 (file)
index 0000000..96d8861
--- /dev/null
@@ -0,0 +1,49 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+sbi command
+===========
+
+Synopsis
+--------
+
+::
+
+    sbi
+
+Description
+-----------
+
+The sbi command is used to display information about the SBI (Supervisor Binary
+Interface) implementation on RISC-V systems.
+
+The output may look like:
+
+::
+
+    => sbi
+    SBI 0.2
+    OpenSBI
+    Extensions:
+      sbi_set_timer
+      sbi_console_putchar
+      sbi_console_getchar
+      sbi_clear_ipi
+      sbi_send_ipi
+      sbi_remote_fence_i
+      sbi_remote_sfence_vma
+      sbi_remote_sfence_vma_asid
+      sbi_shutdown
+      SBI Base Functionality
+      Timer Extension
+      IPI Extension
+      RFENCE Extension
+      Hart State Management Extension
+
+The first line indicates the version of the RISC-V SBI specification.
+The second line indicates the implementation.
+The further lines enumerate the implemented extensions.
+
+Configuration
+-------------
+
+To use the sbi command you must specify CONFIG_CMD_SBI=y.