summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBin Meng <bmeng.cn@gmail.com>2019-07-18 10:34:16 +0300
committerTom Rini <trini@konsulko.com>2019-07-24 17:07:24 +0300
commit40046df73947084cec8d46cf9bf5031a3900409c (patch)
tree1c50f8eabcd72c385fe35c7ca7bfc2c05c4211db /doc
parentc586ff0122eadc7063ae9ee5c8aef88724c981d7 (diff)
downloadu-boot-40046df73947084cec8d46cf9bf5031a3900409c.tar.xz
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>
Diffstat (limited to 'doc')
-rw-r--r--doc/board/emulation/index.rst1
-rw-r--r--doc/board/emulation/qemu-riscv.rst (renamed from doc/README.qemu-riscv)21
2 files changed, 13 insertions, 9 deletions
diff --git a/doc/board/emulation/index.rst b/doc/board/emulation/index.rst
index a2b1a600b7..7537179e2f 100644
--- 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/README.qemu-riscv b/doc/board/emulation/qemu-riscv.rst
index e2e4804917..214833496b 100644
--- a/doc/README.qemu-riscv
+++ b/doc/board/emulation/qemu-riscv.rst
@@ -1,9 +1,8 @@
-# SPDX-License-Identifier: GPL-2.0+
-#
-# Copyright (C) 2018, Bin Meng <bmeng.cn@gmail.com>
+.. 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 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.
@@ -19,11 +18,13 @@ Building U-Boot
---------------
Set the CROSS_COMPILE environment variable as usual, and run:
-- For 32-bit RISC-V:
+- For 32-bit RISC-V::
+
make qemu-riscv32_defconfig
make
-- For 64-bit RISC-V:
+- For 64-bit RISC-V::
+
make qemu-riscv64_defconfig
make
@@ -31,10 +32,12 @@ Running U-Boot
--------------
The minimal QEMU command line to get U-Boot up and running is:
-- For 32-bit RISC-V:
+- For 32-bit RISC-V::
+
qemu-system-riscv32 -nographic -machine virt -kernel u-boot
-- For 64-bit RISC-V:
+- For 64-bit RISC-V::
+
qemu-system-riscv64 -nographic -machine virt -kernel u-boot
The commands above create targets with 128MiB memory by default.