[PATCH 1/1] doc: describe QEMU emulation of block devices

[Simon Glass]

On Mon, 24 Jul 2023 at 04:04, Heinrich Schuchardt
<heinrich.schuchardt at canonical.com> wrote:
>
> * Add a new page about the emulation of block devices
> * Add semihosting to the emulation index page
> * Set toc maxdepth to 1 to improve readability
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt at canonical.com>
> ---
>  doc/board/emulation/blkdev.rst | 38 ++++++++++++++++++++++++++++++++++
>  doc/board/emulation/index.rst  |  4 +++-
>  2 files changed, 41 insertions(+), 1 deletion(-)
>  create mode 100644 doc/board/emulation/blkdev.rst
>

Reviewed-by: Simon Glass <sjg at chromium.org>


> diff --git a/doc/board/emulation/blkdev.rst b/doc/board/emulation/blkdev.rst
> new file mode 100644
> index 0000000000..dc83a00526
> --- /dev/null
> +++ b/doc/board/emulation/blkdev.rst
> @@ -0,0 +1,38 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +Emulation of block devices
> +--------------------------
> +
> +QEMU can emulate common block devices by adding the following parameters to
> +the qemu-system-<arch> command line:
> +
> +* MMC
> +
> +  .. code-block:: bash
> +
> +      -device sdhci-pci,sd-spec-version=3 \
> +      -device sd-card,drive=MMC1 \
> +      -drive if=none,file=disk.img,format=raw,id=MMC1
> +
> +* NVMe
> +
> +  .. code-block:: bash
> +
> +      -drive if=none,file=disk.img,format=raw,id=NVME1 \
> +      -device nvme,drive=NVME1,serial=nvme-1
> +
> +* SATA
> +
> +  .. code-block:: bash
> +
> +      -device ahci,id=ahci0 \
> +      -drive if=none,file=disk.img,format=raw,id=SATA1 \
> +      -device ide-hd,bus=ahci0.0,drive=SATA1
> +
> +* USB
> +
> +  .. code-block:: bash
> +
> +      -device qemu-xhci \
> +      -drive if=none,file=disk.img,format=raw,id=USB1 \
> +      -device usb-storage,drive=USB1
> diff --git a/doc/board/emulation/index.rst b/doc/board/emulation/index.rst
> index b5b6c3fa0d..932c65adeb 100644
> --- a/doc/board/emulation/index.rst
> +++ b/doc/board/emulation/index.rst
> @@ -4,8 +4,10 @@ Emulation
>  =========
>
>  .. toctree::
> -   :maxdepth: 2
> +   :maxdepth: 1
>
> +   blkdev
> +   ../../usage/semihosting
>     qemu-arm
>     qemu-mips
>     qemu-ppce500
> --
> 2.40.1
>