meta-agl-jailhouse/README.md

   1 # Jailhouse support layer
   2
   3 Yocto layer that enables use of the Jailhouse partitioning hypervisor - <https://github.com/siemens/jailhouse>.
   4
   5 ## How to use
   6
   7 The AGL feature `agl-jailhouse` has to be enabled. That needs to be done when including aglsetup.sh, for example:
   8
   9     source meta-agl/scripts/aglsetup.sh -m raspberrypi4 agl-demo agl-netboot agl-appfw-smack agl-jailhouse
  10
  11 That will enable this layer and include the `jailhouse` package in the image.
  12
  13 Then, in the target system, the cell configurations (*.cell) are placed in `/usr/share/jailhouse/cells/` and the demo inmates (bare-metal applications to run in a non-root cell) are located in `/usr/share/jailhouse/inmates`.
  14
  15 ## Raspberry Pi 4 example
  16
  17 Use this commands to enable Jailhouse and run the GIC demo inmate in a non-root cell. After issuing these commands, the GIC demo will be mesauring jitter of a timer and print the output on the serial console of the RPi.
  18
  19     jailhouse enable /usr/share/jailhouse/cells/rpi4.cell
  20     jailhouse cell create /usr/share/jailhouse/cells/rpi4-inmate-demo.cell
  21     jailhouse cell load inmate-demo /usr/share/jailhouse/inmates/gic-demo.bin
  22     jailhouse cell start inmate-demo
  23
  24 ## Dependencies
  25
  26 This layer depends on:
  27
  28 * URI: git://git.yoctoproject.org/meta-arm
  29   * branch: dunfell
  30   * revision: 0bd9c740267c0926e89bcfdb489790b7bf1fbd4b
  31   * note: actually only required on the Raspberry Pi 4 target
  32
  33 ## Supported targets
  34
  35 * Raspberry Pi 4
  36     * All (1G-8G) memory variants. But note that there is 256M reserved for Jailhouse and 256MiB for GPU in AGL, so the smaller variants are not recommended.
  37
  38 * QEMU x86-64
  39     * Work in progress. Requires KVM. Nested virtualization must be enabled on the host. Currently, the right configuration of QEMU and Jailhouse to work out-of-box is being worked on.
  40
  41
  42
  43