Mirrors/u-boot
2
0
Fork 0
mirror of https://github.com/AsahiLinux/u-boot synced 2024-12-18 09:13:06 +00:00
Code Issues Projects Releases Packages Wiki Activity
u-boot/doc/board/emulation/qemu-arm.rst

203 lines
6.4 KiB
ReStructuredText
Raw Normal View History

doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
.. SPDX-License-Identifier: GPL-2.0+
.. Copyright (C) 2017, Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
QEMU ARM
========
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
QEMU for ARM supports a special 'virt' machine designed for emulation and
virtualization purposes. This document describes how to run U-Boot under it.
ARM: Document AArch64 version of qemu-arm It's mostly obvious, except that QEMU is annoying and requires an explicit '-cpu cortex-a57' (or some other 64-bit core) to actually run in 64-bit mode. While at it, remove the references to setting the ARCH environment variable; that is not used in U-Boot. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi> Reviewed-by: Tom Rini <trini@konsulko.com>
2018-01-11 14:11:24 +00:00
Both 32-bit ARM and AArch64 are supported.
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
The 'virt' platform provides the following as the basic functionality:
- A freely configurable amount of CPU cores
- U-Boot loaded and executing in the emulated flash at address 0x0
- A generated device tree blob placed at the start of RAM
- A freely configurable amount of RAM, described by the DTB
- A PL011 serial port, discoverable via the DTB
ARM: Document AArch64 version of qemu-arm It's mostly obvious, except that QEMU is annoying and requires an explicit '-cpu cortex-a57' (or some other 64-bit core) to actually run in 64-bit mode. While at it, remove the references to setting the ARCH environment variable; that is not used in U-Boot. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi> Reviewed-by: Tom Rini <trini@konsulko.com>
2018-01-11 14:11:24 +00:00
- An ARMv7/ARMv8 architected timer
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
- PSCI for rebooting the system
- A generic ECAM-based PCI host controller, discoverable via the DTB
Additionally, a number of optional peripherals can be added to the PCI bus.
arm: riscv: qemu: Explain how to extract the generated dt QEMU currently generates a devicetree for use with U-Boot. Explain how to obtain it. Also explain how to merge it to produce a devicetree with the U-Boot features included. Signed-off-by: Simon Glass <sjg@chromium.org>
2021-12-17 03:59:09 +00:00
See :doc:`../../develop/devicetree/dt_qemu` for information on how to see
the devicetree actually generated by QEMU.
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
Building U-Boot
---------------
ARM: Document AArch64 version of qemu-arm It's mostly obvious, except that QEMU is annoying and requires an explicit '-cpu cortex-a57' (or some other 64-bit core) to actually run in 64-bit mode. While at it, remove the references to setting the ARCH environment variable; that is not used in U-Boot. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi> Reviewed-by: Tom Rini <trini@konsulko.com>
2018-01-11 14:11:24 +00:00
Set the CROSS_COMPILE environment variable as usual, and run:
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
- For ARM::
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
make qemu_arm_defconfig
make
doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
- For AArch64::
ARM: Document AArch64 version of qemu-arm It's mostly obvious, except that QEMU is annoying and requires an explicit '-cpu cortex-a57' (or some other 64-bit core) to actually run in 64-bit mode. While at it, remove the references to setting the ARCH environment variable; that is not used in U-Boot. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi> Reviewed-by: Tom Rini <trini@konsulko.com>
2018-01-11 14:11:24 +00:00
make qemu_arm64_defconfig
make
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
Running U-Boot
--------------
The minimal QEMU command line to get U-Boot up and running is:
doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
- For ARM::
arm: qemu: Mention -nographic in the docs Without this option QEMU appears to hang. Add it to avoid confusion. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-12-17 03:59:08 +00:00
qemu-system-arm -machine virt -nographic -bios u-boot.bin
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
- For AArch64::
arm: qemu: Mention -nographic in the docs Without this option QEMU appears to hang. Add it to avoid confusion. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-12-17 03:59:08 +00:00
qemu-system-aarch64 -machine virt -nographic -cpu cortex-a57 -bios u-boot.bin
ARM: Document AArch64 version of qemu-arm It's mostly obvious, except that QEMU is annoying and requires an explicit '-cpu cortex-a57' (or some other 64-bit core) to actually run in 64-bit mode. While at it, remove the references to setting the ARCH environment variable; that is not used in U-Boot. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi> Reviewed-by: Tom Rini <trini@konsulko.com>
2018-01-11 14:11:24 +00:00
doc: qemu-arm: Drop highmem=off references Now that U-Boot works fine with highmem enabled, there is no need to tell users to disable highmem. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi> Reviewed-by: Simon Glass <sjg@chromium.org>
2018-05-14 15:47:52 +00:00
Note that for some odd reason qemu-system-aarch64 needs to be explicitly
arm: qemu: Mention -nographic in the docs Without this option QEMU appears to hang. Add it to avoid confusion. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-12-17 03:59:08 +00:00
told to use a 64-bit CPU or it will boot in 32-bit mode. The -nographic argument
ensures that output appears on the terminal. Use Ctrl-A X to quit.
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
global: Use proper project name U-Boot Use proper project name in comments, Kconfig, readmes. Reviewed-by: Neil Armstrong <neil.armstrong@linaro.org> Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Stefan Roese <sr@denx.de> Reviewed-by: Qu Wenruo <wqu@suse.com> Signed-off-by: Michal Simek <michal.simek@amd.com> Link: https://lore.kernel.org/r/0dbdf0432405c1c38ffca55703b6737a48219e79.1684307818.git.michal.simek@amd.com
2023-05-17 07:17:16 +00:00
Additional persistent U-Boot environment support can be added as follows:
doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
- Create envstore.img using qemu-img::
qemu-arm: Add persistent environment support Currently on qemu-arm platforms environment is kept in RAM. Instead use pflash device 1 to provide persistent environment support across device reset. Also (optionally) provide support for persistent environment across qemu machine OFF/ON using following instructions: - Create envstore.img using qemu-img: qemu-img create -f raw envstore.img 64M - Add a pflash drive parameter to the command line: -drive if=pflash,format=raw,index=1,file=envstore.img Signed-off-by: Sumit Garg <sumit.garg@linaro.org>
2018-11-26 11:20:17 +00:00
qemu-img create -f raw envstore.img 64M
doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
- Add a pflash drive parameter to the command line::
qemu-arm: Add persistent environment support Currently on qemu-arm platforms environment is kept in RAM. Instead use pflash device 1 to provide persistent environment support across device reset. Also (optionally) provide support for persistent environment across qemu machine OFF/ON using following instructions: - Create envstore.img using qemu-img: qemu-img create -f raw envstore.img 64M - Add a pflash drive parameter to the command line: -drive if=pflash,format=raw,index=1,file=envstore.img Signed-off-by: Sumit Garg <sumit.garg@linaro.org>
2018-11-26 11:20:17 +00:00
-drive if=pflash,format=raw,index=1,file=envstore.img
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
Additional peripherals that have been tested to work in both U-Boot and Linux
can be enabled with the following command line parameters:
arm: qemu: Enable Bochs video support Commit 716161663ec49 ("riscv: qemu: Enable Bochs video support") enables a video console for QEMU RISC-V virtual machines using an emulated Bochs VGA card. Similarly, enable it for ARM virtual machines as well. Signed-off-by: Alper Nebi Yasak <alpernebiyasak@gmail.com> Reviewed-by: Bin Meng <bmeng@tinylab.org>
2023-08-14 17:39:41 +00:00
- To add a video console, remove "-nographic" and add e.g.::
-serial stdio -device VGA
doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
- To add a Serial ATA disk via an Intel ICH9 AHCI controller, pass e.g.::
doc: qemu-arm peripherials * add description how to add RNG device * for a disk specify format=raw to avoid a warning * fix a typo Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
2021-11-28 10:50:58 +00:00
-drive if=none,file=disk.img,format=raw,id=mydisk \
-device ich9-ahci,id=ahci -device ide-drive,drive=mydisk,bus=ahci.0
doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
- To add an Intel E1000 network adapter, pass e.g.::
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
-netdev user,id=net0 -device e1000,netdev=net0
doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
- To add an EHCI-compliant USB host controller, pass e.g.::
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
-device usb-ehci,id=ehci
doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
arm: qemu: Enable usb keyboard as an input device Commit 02be57caf730 ("riscv: qemu: Enable usb keyboard as an input device") adds PCI xHCI support to QEMU RISC-V virtual machines and enables using a USB keyboard as one of the input devices. Similarly, enable those for ARM virtual machines as well. Signed-off-by: Alper Nebi Yasak <alpernebiyasak@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng@tinylab.org>
2023-08-14 17:39:43 +00:00
- To add a USB keyboard attached to an emulated xHCI controller, pass e.g.::
-device qemu-xhci,id=xhci -device usb-kbd,bus=xhci.0
doc: qemu-arm peripherials * add description how to add RNG device * for a disk specify format=raw to avoid a warning * fix a typo Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
2021-11-28 10:50:58 +00:00
- To add an NVMe disk, pass e.g.::
doc: board: Convert README.qemu-arm 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>
2019-07-18 07:34:15 +00:00
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
-drive if=none,file=disk.img,id=mydisk -device nvme,drive=mydisk,serial=foo
doc: qemu-arm peripherials * add description how to add RNG device * for a disk specify format=raw to avoid a warning * fix a typo Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
2021-11-28 10:50:58 +00:00
- To add a random number generator, pass e.g.::
-device virtio-rng-pci
ARM: Add documentation for the qemu-arm board Add brief documentation for the recently merged qemu-arm board. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi>
2017-10-09 16:42:41 +00:00
These have been tested in QEMU 2.9.0 but should work in at least 2.5.0 as well.
doc: qemu: debug UART settings for QEMU ARM virt Provide the settings for the debug UART on the QEMU ARM virt board. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-09-15 22:17:55 +00:00
doc: qemu: arm: Add a section on booting Linux distros Add an example qemu-system-aarch64 command that can make U-Boot on QEMU boot into the Debian Installer, along with resulting console messages from U-Boot, based on the existing documentation section for the x86 version. Signed-off-by: Alper Nebi Yasak <alpernebiyasak@gmail.com>
2023-08-14 17:39:44 +00:00
Booting distros
---------------
It is possible to install and boot a standard Linux distribution using
qemu_arm64 by setting up a root disk::
qemu-img create root.img 20G
then using the installer to install. For example, with Debian 12::
qemu-system-aarch64 \
-machine virt -cpu cortex-a53 -m 4G -smp 4 \
-bios u-boot.bin \
-serial stdio -device VGA \
-nic user,model=virtio-net-pci \
-device virtio-rng-pci \
-device qemu-xhci,id=xhci \
-device usb-kbd -device usb-tablet \
-drive if=virtio,file=debian-12.0.0-arm64-netinst.iso,format=raw,readonly=on,media=cdrom \
-drive if=virtio,file=root.img,format=raw,media=disk
The output will be something like this::
U-Boot 2023.10-rc2-00075-gbe8fbe718e35 (Aug 11 2023 - 08:38:49 +0000)
DRAM: 4 GiB
Core: 51 devices, 14 uclasses, devicetree: board
Flash: 64 MiB
Loading Environment from Flash... *** Warning - bad CRC, using default environment
In: serial,usbkbd
Out: serial,vidconsole
Err: serial,vidconsole
Bus xhci_pci: Register 8001040 NbrPorts 8
Starting the controller
USB XHCI 1.00
scanning bus xhci_pci for devices... 3 USB Device(s) found
Net: eth0: virtio-net#32
Hit any key to stop autoboot: 0
Scanning for bootflows in all bootdevs
Seq Method State Uclass Part Name Filename
--- ----------- ------ -------- ---- ------------------------ ----------------
Scanning global bootmeth 'efi_mgr':
Scanning bootdev 'fw-cfg@9020000.bootdev':
fatal: no kernel available
scanning bus for devices...
Scanning bootdev 'virtio-blk#34.bootdev':
0 efi ready virtio 2 virtio-blk#34.bootdev.par efi/boot/bootaa64.efi
** Booting bootflow 'virtio-blk#34.bootdev.part_2' with efi
Using prior-stage device tree
Failed to load EFI variables
Error: writing contents
** Unable to write file ubootefi.var **
Failed to persist EFI variables
Missing TPMv2 device for EFI_TCG_PROTOCOL
Booting /efi\boot\bootaa64.efi
Error: writing contents
** Unable to write file ubootefi.var **
Failed to persist EFI variables
Welcome to GRUB!
Standard boot looks through various available devices and finds the virtio
disks, then boots from the first one. After a second or so the grub menu appears
and you can work through the installer flow normally.
After the installation, you can boot into the installed system by running QEMU
again without the drive argument corresponding to the installer CD image.
doc: qemu: Add instructions for swtpm usage A previous patch added support for an mmio based TPM. Add an example in QEMU on it's usage Reviewed-by: Simon Glass <sjg@chromium.org> Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
2021-11-09 07:02:21 +00:00
Enabling TPMv2 support
----------------------
To emulate a TPM the swtpm package may be used. It can be built from the
following repositories:
https://github.com/stefanberger/swtpm.git
Swtpm provides a socket for the TPM emulation which can be consumed by QEMU.
In a first console invoke swtpm with::
swtpm socket --tpmstate dir=/tmp/mytpm1 \
--ctrl type=unixio,path=/tmp/mytpm1/swtpm-sock --log level=20
In a second console invoke qemu-system-aarch64 with::
-chardev socket,id=chrtpm,path=/tmp/mytpm1/swtpm-sock \
-tpmdev emulator,id=tpm0,chardev=chrtpm \
-device tpm-tis-device,tpmdev=tpm0
Enable the TPM on U-Boot's command line with::
tpm2 startup TPM2_SU_CLEAR
doc: qemu: debug UART settings for QEMU ARM virt Provide the settings for the debug UART on the QEMU ARM virt board. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-09-15 22:17:55 +00:00
Debug UART
----------
The debug UART on the ARM virt board uses these settings::
CONFIG_DEBUG_UART=y
CONFIG_DEBUG_UART_PL010=y
CONFIG_DEBUG_UART_BASE=0x9000000
CONFIG_DEBUG_UART_CLOCK=0
Reference in a new issue Copy permalink