Re: [RFC PATCH qemu] spapr/docs: Add a few words about x-vof

[Cédric Le Goater]

On 5/12/22 05:10, Alexey Kardashevskiy wrote:
> On 5/12/22 06:42, Daniel Henrique Barboza wrote:
> > On 5/6/22 02:51, Alexey Kardashevskiy wrote:
> > > The alternative small firmware needs a few words of what it can and
> > > absolutely cannot do; this adds those words.
> > >
> > > Signed-off-by: Alexey Kardashevskiy <aik@ozlabs.ru>
> > > ---
> > >   docs/system/ppc/pseries.rst | 28 ++++++++++++++++++++++++++++
> > >   1 file changed, 28 insertions(+)
> > >
> > > diff --git a/docs/system/ppc/pseries.rst b/docs/system/ppc/pseries.rst
> > > index d9b65ad4e850..4c98a94f9add 100644
> > > --- a/docs/system/ppc/pseries.rst
> > > +++ b/docs/system/ppc/pseries.rst
> > > @@ -32,14 +32,42 @@ Missing devices
> > >   Firmware
> > >   ========
> > > +The pSeries platform in QEMU comes with 2 firmwares:
> > > +
> > >   `SLOF <https://github.com/aik/SLOF>`_ (Slimline Open Firmware) is an
> > >   implementation of the `IEEE 1275-1994, Standard for Boot (Initialization
> > >   Configuration) Firmware: Core Requirements and Practices
> > >   <https://standards.ieee.org/standard/1275-1994.html>`_.
> > > +SLOF performs bus scanning, PCI resource allocation, provides the client
> > > +interface to boot from block devices and network.
> > > +
> > >   QEMU includes a prebuilt image of SLOF which is updated when a more recent
> > >   version is required.
> > > +VOF (Virtual Open Firmware) is a minimalistic firmware to work with
> > > +``-machine pseries,x-vof=on``. When enabled, the firmware acts as a slim
> > > +shim and QEMU implements parts of the IEEE 1275 Open Firmware interface.
> > > +
> > > +VOF does not have device drivers, does not do PCI resource allocation and
> > > +relies on ``-kernel`` used with Linux kernels recent enough (v5.4+)
> > > +to PCI resource assignment. It is ideal to use with petitboot.
> > > +
> > > +Booting via ``-kernel`` supports the following:
> > > ++-------------------+-------------------+------------------+
> > > +| kernel            | pseries,x-vof=off | pseries,x-vof=on |
> > > ++===================+===================+==================+
> > > +| vmlinux BE        |     ✓             |     ✓            |
> > > ++-------------------+-------------------+------------------+
> > > +| vmlinux LE        |     ✓             |     ✓            |
> > > ++-------------------+-------------------+------------------+
> > > +| zImage.pseries BE |     x             |     ✓¹           |
> > > ++-------------------+-------------------+------------------+
> > > +| zImage.pseries LE |     ✓             |     ✓            |
> > > ++-------------------+-------------------+------------------+
> >
> > You need an empty line at the start and at the end of the table. Otherwise it'll
> > be rendered as regular text.
>
> How do you build htmls from these btw?


Install python3-sphinx python3-sphinx-rtd-theme
run configure with --enable-docs
check the result in build/docs/manual/system/arm/

C.