* [Qemu-devel] [PATCH] docs: add firmware.txt
@ 2017-09-01 10:53 Gerd Hoffmann
2018-07-04 20:44 ` Eduardo Habkost
0 siblings, 1 reply; 3+ messages in thread
From: Gerd Hoffmann @ 2017-09-01 10:53 UTC (permalink / raw)
To: qemu-devel; +Cc: Gerd Hoffmann
Document how guest firmware is handled in qemu today.
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
---
docs/firmware.txt | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 49 insertions(+)
create mode 100644 docs/firmware.txt
diff --git a/docs/firmware.txt b/docs/firmware.txt
new file mode 100644
index 0000000000..e242413344
--- /dev/null
+++ b/docs/firmware.txt
@@ -0,0 +1,49 @@
+
+prebuilt firmware in qemu
+=========================
+
+The process of building firmware isn't as easy as building qemu
+itself, for example because you must have cross compilers installed
+when building firmware for other architectures. So qemu ships
+prebuilt firmware binaries for convenience reasons.
+
+
+directories
+-----------
+
+pc-bios/
+ Firmware binaries.
+ Also other files like keymaps and logos which are copied to
+ $prefix/share/qemu by "make install".
+
+pc-bios/optionrom/
+ Firmware sources, part of the qemu project.
+
+roms/
+ Firmware sources, third-party projects, as git submodules.
+
+
+third-party git repos
+---------------------
+
+For third party firmware sources it is recommended to have a git
+mirror on git.qemu.org. In case the firmware license is GPL the git
+mirror is mandatory for GPL compilance reasons: We ship binaries, so
+we must provide sources too.
+
+
+building the firmware
+---------------------
+
+Firmware builds should be done using rules in roms/Makefile. That
+serves as documentation how the firmware is built, and it also makes
+firmware updates easier for the maintainer.
+
+"make -C roms" prints a list of firmware build targets.
+"make -C roms $target" kicks a build.
+
+
+notes for specific firmwares
+----------------------------
+
+ipxe: see https://wiki.qemu.org/IpxeDownstreamForQemu
--
2.9.3
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [Qemu-devel] [PATCH] docs: add firmware.txt
2017-09-01 10:53 [Qemu-devel] [PATCH] docs: add firmware.txt Gerd Hoffmann
@ 2018-07-04 20:44 ` Eduardo Habkost
2018-07-05 6:47 ` Gerd Hoffmann
0 siblings, 1 reply; 3+ messages in thread
From: Eduardo Habkost @ 2018-07-04 20:44 UTC (permalink / raw)
To: Gerd Hoffmann, Peter Maydell; +Cc: qemu-devel
On Fri, Sep 01, 2017 at 12:53:31PM +0200, Gerd Hoffmann wrote:
> Document how guest firmware is handled in qemu today.
>
> Reviewed-by: Laszlo Ersek <lersek@redhat.com>
> Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
Is this document still valid? Should we apply this for QEMU 3.0?
> ---
> docs/firmware.txt | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 49 insertions(+)
> create mode 100644 docs/firmware.txt
>
> diff --git a/docs/firmware.txt b/docs/firmware.txt
> new file mode 100644
> index 0000000000..e242413344
> --- /dev/null
> +++ b/docs/firmware.txt
> @@ -0,0 +1,49 @@
> +
> +prebuilt firmware in qemu
> +=========================
> +
> +The process of building firmware isn't as easy as building qemu
> +itself, for example because you must have cross compilers installed
> +when building firmware for other architectures. So qemu ships
> +prebuilt firmware binaries for convenience reasons.
> +
> +
> +directories
> +-----------
> +
> +pc-bios/
> + Firmware binaries.
> + Also other files like keymaps and logos which are copied to
> + $prefix/share/qemu by "make install".
> +
> +pc-bios/optionrom/
> + Firmware sources, part of the qemu project.
> +
> +roms/
> + Firmware sources, third-party projects, as git submodules.
> +
> +
> +third-party git repos
> +---------------------
> +
> +For third party firmware sources it is recommended to have a git
> +mirror on git.qemu.org. In case the firmware license is GPL the git
> +mirror is mandatory for GPL compilance reasons: We ship binaries, so
> +we must provide sources too.
> +
> +
> +building the firmware
> +---------------------
> +
> +Firmware builds should be done using rules in roms/Makefile. That
> +serves as documentation how the firmware is built, and it also makes
> +firmware updates easier for the maintainer.
> +
> +"make -C roms" prints a list of firmware build targets.
> +"make -C roms $target" kicks a build.
> +
> +
> +notes for specific firmwares
> +----------------------------
> +
> +ipxe: see https://wiki.qemu.org/IpxeDownstreamForQemu
> --
> 2.9.3
>
>
--
Eduardo
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [Qemu-devel] [PATCH] docs: add firmware.txt
2018-07-04 20:44 ` Eduardo Habkost
@ 2018-07-05 6:47 ` Gerd Hoffmann
0 siblings, 0 replies; 3+ messages in thread
From: Gerd Hoffmann @ 2018-07-05 6:47 UTC (permalink / raw)
To: Eduardo Habkost; +Cc: Peter Maydell, qemu-devel
On Wed, Jul 04, 2018 at 05:44:07PM -0300, Eduardo Habkost wrote:
> On Fri, Sep 01, 2017 at 12:53:31PM +0200, Gerd Hoffmann wrote:
> > Document how guest firmware is handled in qemu today.
> >
> > Reviewed-by: Laszlo Ersek <lersek@redhat.com>
> > Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
>
> Is this document still valid? Should we apply this for QEMU 3.0?
I think so.
The effort to move the firmware to a separate repo is stalled due to
ENOTIME, and surely will not happen for 3.0. So it makes sense to just
merge the text as-is.
cheers,
Gerd
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2018-07-05 6:47 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-09-01 10:53 [Qemu-devel] [PATCH] docs: add firmware.txt Gerd Hoffmann
2018-07-04 20:44 ` Eduardo Habkost
2018-07-05 6:47 ` Gerd Hoffmann
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.