From: Andreas Koelbl <andreas.koe...@st.oth-regensburg.de>

There is no documentation on how to configure jailhouse for a specific
platform. A documentation describing all available 'config.h' parameters
is created.

Signed-off-by: Andreas Koelbl <andreas.koe...@st.oth-regensburg.de>
---
 Documentation/hypervisor-configuration.txt | 55 ++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 Documentation/hypervisor-configuration.txt

diff --git a/Documentation/hypervisor-configuration.txt 
b/Documentation/hypervisor-configuration.txt
new file mode 100644
index 0000000..8894be0
--- /dev/null
+++ b/Documentation/hypervisor-configuration.txt
@@ -0,0 +1,55 @@
+Hypervisor Configuration
+========================
+
+The Jailhouse Hypervisor supports various static compile-time configuration
+parameters, such as different UART drivers, platform specific settings and
+debugging options.
+
+Those settings can optionally be defined in config.h in the project root
+directory.
+
+Jailhouse derives config.mk from this file that makes symbols available
+for the kbuild system.
+
+Available configuration options
+-------------------------------
+
+General configuration parameters
+CONFIG_TRACE_ERROR             /* Trace jailhouse errors to serial console */
+
+X86 specific
+CONFIG_UART_OXPCIE952          /* OXPCIE952 serial interface */
+
+ARM specific
+CONFIG_ARM_GIC_V2              /* ARM Generic Interrupt Controller */
+CONFIG_ARM_GIC_V3              /* ARM Generic Interrupt Controller version 3 */
+
+CONFIG_MACH_TEGRA124           /* Tegra124 platform */
+CONFIG_MACH_SUN7I              /* Sun7I platform */
+CONFIG_MACH_VEXPRESS           /* Versatile Express platform */
+
+CONFIG_SERIAL_TEGRA            /* Tegra serial interface */
+CONFIG_SERIAL_AMBA_PL011       /* AMBA_PL011 serial interface */
+CONFIG_SERIAL_8250_DW          /* 8250 serial interface */
+
+Examples for different platform configurations
+==============================================
+
+Jetson TK1
+----------
+#define CONFIG_ARM_GIC_V2              1
+#define CONFIG_MACH_TEGRA124           1
+#define CONFIG_SERIAL_TEGRA            1
+
+Banana Pi
+---------
+#define CONFIG_ARM_GIC_V2              1
+#define CONFIG_MACH_SUN7I              1
+#define CONFIG_SERIAL_8250_DW          1
+
+Versatile Express
+-----------------
+
+#define CONFIG_ARM_GIC_V3              1
+#define CONFIG_MACH_VEXPRESS           1
+#define CONFIG_SERIAL_AMBA_PL011       1
-- 
2.10.0

-- 
You received this message because you are subscribed to the Google Groups 
"Jailhouse" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to jailhouse-dev+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to