Skip to content

Commit

Permalink
boards: arm64: rpi_5: add xen specific doc
Browse files Browse the repository at this point in the history
Add Xen specific documentation.

Signed-off-by: Grygorii Strashko <[email protected]>
  • Loading branch information
Grygorii Strashko committed Apr 26, 2024
1 parent 594df9d commit 99a0bdc
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions boards/arm64/rpi_5/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,3 +159,35 @@ When you power on the Raspberry Pi 5, you will see the following output in the s

.. _Raspberry Pi Debug Probe:
https://www.raspberrypi.com/products/debug-probe/

XEN Dom0
========

The Raspberry Pi 5 platform can be used to run as Xen Zephyr Dom0. For such purposes the `xen_dom0`
can be used.

Run below command as an example of RPI 5 Zephyr build as Dom0:

.. code-block:: bash
west build -b rpi_5 -p always -S xen_dom0 samples/hello_world
It is expected to be used with special application performing Xen0 functions.

.. note::

The "hypervisor@x" and "memory@x" DT nodes may need to be updated depending on the Xen boot,
because normaly Xan will update DT for the target Kernel, but this is not possible in case
of Zephyr. See comments in `rpi_5_xen_dom0.dts`.

XEN DomU with HW passthrough
============================

The Raspberry Pi 5 platform can be used to run as Xen Zephyr DomU with RPI 5 HW support.
For such purposes the `rpi_5_xen_domd` can be used.

Run below command as an example of RPI 5 Zephyr build as Dom0:

.. code-block:: bash
west build -b xenvm -S rpi_5_xen_domd samples/basic/blinky

0 comments on commit 99a0bdc

Please sign in to comment.