[Qemu-devel] [PATCH] docs/generic-loader: mention U-Boot and Intel HEX executable formats

[Qemu-devel] [PATCH] docs/generic-loader: mention U-Boot and Intel HEX executable formats

[Stefan Hajnoczi]

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>
---
Based-on: <20180816133438.17061-1-peter.maydell@linaro.org>
(https://git.linaro.org/people/pmaydell/qemu-arm.git/ pull-target-arm-20180816)

 docs/generic-loader.txt | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/docs/generic-loader.txt b/docs/generic-loader.txt
index 31bbcd42f6..a9603a2af7 100644
--- a/docs/generic-loader.txt
+++ b/docs/generic-loader.txt
@@ -56,25 +56,25 @@ An example of setting CPU 0's PC to 0x8000 is:
 
 Loading Files
 -------------
-The loader device also allows files to be loaded into memory. It can load raw
-files and ELF executable files.  Raw files are loaded verbatim.  ELF executable
-files are loaded by an ELF loader.  The syntax is shown below:
+The loader device also allows files to be loaded into memory. It can load ELF,
+U-Boot, and Intel HEX executable formats as well as raw images.  The syntax is
+shown below:
 
     -device loader,file=<file>[,addr=<addr>][,cpu-num=<cpu-num>][,force-raw=<raw>]
 
     <file>      - A file to be loaded into memory
-    <addr>      - The addr in memory that the file should be loaded. This is
-                  ignored if you are using an ELF (unless force-raw is true).
-                  This is required if you aren't loading an ELF.
+    <addr>      - The memory address where the file should be loaded. This is
+                  required for raw images and ignored for non-raw files.
     <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
-                  where the image is stored or in the case of an ELF file to
-                  the value in the header. This option should only be used
-                  for the boot image.
+                  the memory address where the raw file is loaded or the entry
+                  point specified in the executable format header. This option
+                  should only be used for the boot image.
                   This will also cause the image to be written to the specified
                   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
-                  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
 to specify any values in any format supported. By default the values
-- 
2.17.1

Re: [Qemu-devel] [PATCH] docs/generic-loader: mention U-Boot and Intel HEX executable formats

[Alistair Francis]

On Thu, Aug 16, 2018 at 7:55 AM, Stefan Hajnoczi <stefanha@redhat.com> wrote:
> 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>

Alistair

> ---
> Based-on: <20180816133438.17061-1-peter.maydell@linaro.org>
> (https://git.linaro.org/people/pmaydell/qemu-arm.git/ pull-target-arm-20180816)
>
>  docs/generic-loader.txt | 20 ++++++++++----------
>  1 file changed, 10 insertions(+), 10 deletions(-)
>
> diff --git a/docs/generic-loader.txt b/docs/generic-loader.txt
> index 31bbcd42f6..a9603a2af7 100644
> --- a/docs/generic-loader.txt
> +++ b/docs/generic-loader.txt
> @@ -56,25 +56,25 @@ An example of setting CPU 0's PC to 0x8000 is:
>
>  Loading Files
>  -------------
> -The loader device also allows files to be loaded into memory. It can load raw
> -files and ELF executable files.  Raw files are loaded verbatim.  ELF executable
> -files are loaded by an ELF loader.  The syntax is shown below:
> +The loader device also allows files to be loaded into memory. It can load ELF,
> +U-Boot, and Intel HEX executable formats as well as raw images.  The syntax is
> +shown below:
>
>      -device loader,file=<file>[,addr=<addr>][,cpu-num=<cpu-num>][,force-raw=<raw>]
>
>      <file>      - A file to be loaded into memory
> -    <addr>      - The addr in memory that the file should be loaded. This is
> -                  ignored if you are using an ELF (unless force-raw is true).
> -                  This is required if you aren't loading an ELF.
> +    <addr>      - The memory address where the file should be loaded. This is
> +                  required for raw images and ignored for non-raw files.
>      <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
> -                  where the image is stored or in the case of an ELF file to
> -                  the value in the header. This option should only be used
> -                  for the boot image.
> +                  the memory address where the raw file is loaded or the entry
> +                  point specified in the executable format header. This option
> +                  should only be used for the boot image.
>                    This will also cause the image to be written to the specified
>                    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
> -                  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
>  to specify any values in any format supported. By default the values
> --
> 2.17.1
>
>

Re: [Qemu-devel] [PATCH] docs/generic-loader: mention U-Boot and Intel HEX executable formats

[Peter Maydell]

On 16 August 2018 at 16:54, Alistair Francis <alistair23@gmail.com> wrote:
> On Thu, Aug 16, 2018 at 7:55 AM, Stefan Hajnoczi <stefanha@redhat.com> wrote:
>> 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>

Applied to target-arm.next, thanks.

-- PMM