From dc386d3550e74829a42497dfc31dab93bc416e0d Mon Sep 17 00:00:00 2001 From: Jan Kiszka Date: Fri, 20 May 2016 10:26:11 +0200 Subject: [PATCH] README: Update and improve the configuration section We actually neglected to mention the config generator - fix this. Signed-off-by: Jan Kiszka --- README.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ff4fa0b..be6298a 100644 --- a/README.md +++ b/README.md @@ -145,13 +145,26 @@ Configuration ------------- Jailhouse requires one configuration file for the complete system and one for -each additional cell beside Linux. The configuration is currently being -defined manually by filling C structures. To study the structure, use -configs/qemu-vm.c for a system configuration and configs/apic-demo.c for a cell -configuration as reference. The build system will pick up every .c file from -the configs/ directory and generate a corresponding .cell file. .cell files can -then be passed to the jailhouse command line tool for enabling the hypervisor -and creating new cells. +each additional cell besides the primary Linux. These .cell files have to be +passed to the jailhouse command line tool for enabling the hypervisor or +creating new cells. + +A system configuration can be created on the target system by running the +following command: + + jailhouse config create sysconfig.c + +In order to translate this into the required binary form, place this file in +the configs/ directory. The build system will pick up every .c file from there +and generate a corresponding .cell file. + +Depending on the target system, the C structures may require some adjustments to +make Jailhouse work properly or to reduce the desired access rights of the Linux +root cell. + +Configurations for additional (non-root) cells currently require manual +creation. To study the structures, use one of the demo cell configurations files +as reference, e.g. configs/apic-demo.c or configs/e1000-demo.c. Demonstration in QEMU/KVM -- 2.39.2