From: "Alex Bennée" <alex.bennee@linaro.org>
To: qemu-devel@nongnu.org
Cc: julien@xen.org, andre.przywara@arm.com,
stefano.stabellini@linaro.org,
"Alistair Francis" <alistair.francis@wdc.com>,
xen-devel@lists.xenproject.org, stefano.stabellini@xilinx.com,
"Alex Bennée" <alex.bennee@linaro.org>,
stratos-dev@op-lists.linaro.org
Subject: [PATCH v3 6/7] docs: add some documentation for the guest-loader
Date: Wed, 3 Mar 2021 17:36:41 +0000 [thread overview]
Message-ID: <20210303173642.3805-7-alex.bennee@linaro.org> (raw)
In-Reply-To: <20210303173642.3805-1-alex.bennee@linaro.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Alistair Francis <alistair.francis@wdc.com>
Message-Id: <20201105175153.30489-7-alex.bennee@linaro.org>
Message-Id: <20210211171945.18313-7-alex.bennee@linaro.org>
---
docs/system/guest-loader.rst | 54 ++++++++++++++++++++++++++++++++++++
docs/system/index.rst | 1 +
MAINTAINERS | 1 +
3 files changed, 56 insertions(+)
create mode 100644 docs/system/guest-loader.rst
diff --git a/docs/system/guest-loader.rst b/docs/system/guest-loader.rst
new file mode 100644
index 0000000000..37d03cbd89
--- /dev/null
+++ b/docs/system/guest-loader.rst
@@ -0,0 +1,54 @@
+..
+ Copyright (c) 2020, Linaro
+
+Guest Loader
+------------
+
+The guest loader is similar to the `generic-loader` although it is
+aimed at a particular use case of loading hypervisor guests. This is
+useful for debugging hypervisors without having to jump through the
+hoops of firmware and boot-loaders.
+
+The guest loader does two things:
+
+ - load blobs (kernels and initial ram disks) into memory
+ - sets platform FDT data so hypervisors can find and boot them
+
+This is what is typically done by a boot-loader like grub using it's
+multi-boot capability. A typical example would look like:
+
+.. parsed-literal::
+
+ |qemu_system| -kernel ~/xen.git/xen/xen \
+ -append "dom0_mem=1G,max:1G loglvl=all guest_loglvl=all" \
+ -device guest-loader,addr=0x42000000,kernel=Image,bootargs="root=/dev/sda2 ro console=hvc0 earlyprintk=xen" \
+ -device guest-loader,addr=0x47000000,initrd=rootfs.cpio
+
+In the above example the Xen hypervisor is loaded by the -kernel
+parameter and passed it's boot arguments via -append. The Dom0 guest
+is loaded into the areas of memory. Each blob will get
+`/chosen/module@<addr>` entry in the FDT to indicate it's location and
+size. Additional information can be passed with by using additional
+arguments.
+
+Currently the only supported machines which use FDT data to boot are
+the ARM and RiscV `virt` machines.
+
+Arguments
+^^^^^^^^^
+
+The full syntax of the guest-loader is::
+
+ -device guest-loader,addr=<addr>[,kernel=<file>,[bootargs=<args>]][,initrd=<file>]
+
+``addr=<addr>``
+ This is mandatory and indicates the start address of the blob.
+
+``kernel|initrd=<file>``
+ Indicates the filename of the kernel or initrd blob. Both blobs will
+ have the "multiboot,module" compatibility string as well as
+ "multiboot,kernel" or "multiboot,ramdisk" as appropriate.
+
+``bootargs=<args>``
+ This is an optional field for kernel blobs which will pass command
+ like via the `/chosen/module@<addr>/bootargs` node.
diff --git a/docs/system/index.rst b/docs/system/index.rst
index cee1c83540..6ad9c93806 100644
--- a/docs/system/index.rst
+++ b/docs/system/index.rst
@@ -26,6 +26,7 @@ Contents:
ivshmem
linuxboot
generic-loader
+ guest-loader
vnc-security
tls
gdb
diff --git a/MAINTAINERS b/MAINTAINERS
index 34cdd20672..8ec6fbc259 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -2011,6 +2011,7 @@ Guest Loader
M: Alex Bennée <alex.bennee@linaro.org>
S: Maintained
F: hw/core/guest-loader.c
+F: docs/system/guest-loader.rst
Intel Hexadecimal Object File Loader
M: Su Hang <suhang16@mails.ucas.ac.cn>
--
2.20.1
next prev parent reply other threads:[~2021-03-03 17:40 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-03 17:36 [PATCH v3 0/7] Xen guest-loader support, pre-PR Alex Bennée
2021-03-03 17:36 ` [PATCH v3 1/7] hw/board: promote fdt from ARM VirtMachineState to MachineState Alex Bennée
2021-03-03 17:36 ` [PATCH v3 2/7] hw/riscv: migrate fdt field to generic MachineState Alex Bennée
2021-03-03 17:36 ` [PATCH v3 3/7] device_tree: add qemu_fdt_setprop_string_array helper Alex Bennée
2021-03-03 17:36 ` [PATCH v3 4/7] hw/core: implement a guest-loader to support static hypervisor guests Alex Bennée
2021-03-03 18:37 ` Philippe Mathieu-Daudé
2021-03-03 18:38 ` Philippe Mathieu-Daudé
2021-03-04 22:34 ` Alistair Francis
2021-03-03 17:36 ` [PATCH v3 5/7] docs: move generic-loader documentation into the main manual Alex Bennée
2021-03-03 17:36 ` Alex Bennée [this message]
2021-03-03 17:36 ` [PATCH v3 7/7] tests/avocado: add boot_xen tests Alex Bennée
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210303173642.3805-7-alex.bennee@linaro.org \
--to=alex.bennee@linaro.org \
--cc=alistair.francis@wdc.com \
--cc=andre.przywara@arm.com \
--cc=julien@xen.org \
--cc=qemu-devel@nongnu.org \
--cc=stefano.stabellini@linaro.org \
--cc=stefano.stabellini@xilinx.com \
--cc=stratos-dev@op-lists.linaro.org \
--cc=xen-devel@lists.xenproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).