docs/generic-loader: mention U-Boot and Intel HEX executable formats

The generic loader device supports the U-Boot and Intel HEX executable
formats in addition to the document raw and ELF formats.  Reword the
documentation to include these formats and explain how various options
depend on the executable format.

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Alistair Francis <alistair.francis@wdc.com>
Message-id: 20180816145554.9814-1-stefanha@redhat.com
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
This commit is contained in:
Stefan Hajnoczi 2018-08-20 11:24:31 +01:00 committed by Peter Maydell
parent c2d9644e6d
commit 67c791f611
1 changed files with 10 additions and 10 deletions

View File

@ -56,25 +56,25 @@ An example of setting CPU 0's PC to 0x8000 is:
Loading Files Loading Files
------------- -------------
The loader device also allows files to be loaded into memory. It can load raw The loader device also allows files to be loaded into memory. It can load ELF,
files and ELF executable files. Raw files are loaded verbatim. ELF executable U-Boot, and Intel HEX executable formats as well as raw images. The syntax is
files are loaded by an ELF loader. The syntax is shown below: shown below:
-device loader,file=<file>[,addr=<addr>][,cpu-num=<cpu-num>][,force-raw=<raw>] -device loader,file=<file>[,addr=<addr>][,cpu-num=<cpu-num>][,force-raw=<raw>]
<file> - A file to be loaded into memory <file> - A file to be loaded into memory
<addr> - The addr in memory that the file should be loaded. This is <addr> - The memory address where the file should be loaded. This is
ignored if you are using an ELF (unless force-raw is true). required for raw images and ignored for non-raw files.
This is required if you aren't loading an ELF.
<cpu-num> - This specifies the CPU that should be used. This is an <cpu-num> - This specifies the CPU that should be used. This is an
optional argument and will cause the CPU's PC to be set to optional argument and will cause the CPU's PC to be set to
where the image is stored or in the case of an ELF file to the memory address where the raw file is loaded or the entry
the value in the header. This option should only be used point specified in the executable format header. This option
for the boot image. should only be used for the boot image.
This will also cause the image to be written to the specified This will also cause the image to be written to the specified
CPU's address space. If not specified, the default is CPU 0. CPU's address space. If not specified, the default is CPU 0.
<force-raw> - Setting force-raw=on forces the file to be treated as a raw <force-raw> - Setting force-raw=on forces the file to be treated as a raw
image. This can be used to load ELF files as if they were raw. image. This can be used to load supported executable formats
as if they were raw.
All values are parsed using the standard QemuOps parsing. This allows the user All values are parsed using the standard QemuOps parsing. This allows the user
to specify any values in any format supported. By default the values to specify any values in any format supported. By default the values