doc: board: Convert README.qemu-riscv to reST

Convert plain text documentation to reStructuredText format and add
it to Sphinx TOC tree. No essential content change.

Signed-off-by: Bin Meng <bmeng.cn@gmail.com>

diff --git a/doc/README.qemu-riscv b/doc/README.qemu-riscv
deleted file mode 100644 (file)
index e2e4804..0000000
--- a/doc/README.qemu-riscv
+++ /dev/null
@@ -1,46 +0,0 @@
-# SPDX-License-Identifier: GPL-2.0+
-#
-# Copyright (C) 2018, Bin Meng <bmeng.cn@gmail.com>
-
-U-Boot on QEMU's 'virt' machine on RISC-V
-=========================================
-
-QEMU for RISC-V supports a special 'virt' machine designed for emulation and
-virtualization purposes. This document describes how to run U-Boot under it.
-Both 32-bit 64-bit targets are supported.
-
-The QEMU virt machine models a generic RISC-V virtual machine with support for
-the VirtIO standard networking and block storage devices. It has CLINT, PLIC,
-16550A UART devices in addition to VirtIO and it also uses device-tree to pass
-configuration information to guest software. It implements RISC-V privileged
-architecture spec v1.10.
-
-Building U-Boot
----------------
-Set the CROSS_COMPILE environment variable as usual, and run:
-
-- For 32-bit RISC-V:
-    make qemu-riscv32_defconfig
-    make
-
-- For 64-bit RISC-V:
-    make qemu-riscv64_defconfig
-    make
-
-Running U-Boot
---------------
-The minimal QEMU command line to get U-Boot up and running is:
-
-- For 32-bit RISC-V:
-    qemu-system-riscv32 -nographic -machine virt -kernel u-boot
-
-- For 64-bit RISC-V:
-    qemu-system-riscv64 -nographic -machine virt -kernel u-boot
-
-The commands above create targets with 128MiB memory by default.
-A freely configurable amount of RAM can be created via the '-m'
-parameter. For example, '-m 2G' creates 2GiB memory for the target,
-and the memory node in the embedded DTB created by QEMU reflects
-the new setting.
-
-These have been tested in QEMU 3.0.0.

diff --git a/doc/board/emulation/index.rst b/doc/board/emulation/index.rst
index a2b1a600b79d5565a3d305cf7101866a0dd44da0..7537179e2fbee0956b9b95478ea2d9892063ceaa 100644 (file)
--- a/doc/board/emulation/index.rst
+++ b/doc/board/emulation/index.rst
@@ -7,4 +7,5 @@ Emulation
    :maxdepth: 2
 
    qemu-arm
+   qemu-riscv
    qemu-x86

diff --git a/doc/board/emulation/qemu-riscv.rst b/doc/board/emulation/qemu-riscv.rst
new file mode 100644 (file)
index 0000000..2148334
--- /dev/null
+++ b/doc/board/emulation/qemu-riscv.rst
@@ -0,0 +1,49 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. Copyright (C) 2018, Bin Meng <bmeng.cn@gmail.com>
+
+QEMU RISC-V
+===========
+
+QEMU for RISC-V supports a special 'virt' machine designed for emulation and
+virtualization purposes. This document describes how to run U-Boot under it.
+Both 32-bit 64-bit targets are supported.
+
+The QEMU virt machine models a generic RISC-V virtual machine with support for
+the VirtIO standard networking and block storage devices. It has CLINT, PLIC,
+16550A UART devices in addition to VirtIO and it also uses device-tree to pass
+configuration information to guest software. It implements RISC-V privileged
+architecture spec v1.10.
+
+Building U-Boot
+---------------
+Set the CROSS_COMPILE environment variable as usual, and run:
+
+- For 32-bit RISC-V::
+
+    make qemu-riscv32_defconfig
+    make
+
+- For 64-bit RISC-V::
+
+    make qemu-riscv64_defconfig
+    make
+
+Running U-Boot
+--------------
+The minimal QEMU command line to get U-Boot up and running is:
+
+- For 32-bit RISC-V::
+
+    qemu-system-riscv32 -nographic -machine virt -kernel u-boot
+
+- For 64-bit RISC-V::
+
+    qemu-system-riscv64 -nographic -machine virt -kernel u-boot
+
+The commands above create targets with 128MiB memory by default.
+A freely configurable amount of RAM can be created via the '-m'
+parameter. For example, '-m 2G' creates 2GiB memory for the target,
+and the memory node in the embedded DTB created by QEMU reflects
+the new setting.
+
+These have been tested in QEMU 3.0.0.