Documentation: articles: LJ-article-04-2015.txt

[jailhouse.git] / README.md

diff --git a/README.md b/README.md
index 169638bf60a0679b3481ee6f6bcf5c5825f3170b..9298c4f6eda53938bb48c6b920e7e06c7fb77e6f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -25,8 +25,8 @@ WARNING: This is work in progress! Don't expect things to be complete in any
 dimension. Use at your own risk. And keep the reset button in reach.
 
 
-Community
----------
+Community Resources
+-------------------
 
 Project home:
 
@@ -37,6 +37,10 @@ Source code:
  - https://github.com/siemens/jailhouse.git
  - git@github.com:siemens/jailhouse.git
 
+Frequently Asked Questions (FAQ):
+
+ - See [FAQ file](FAQ.md)
+
 Mailing list:
 
   - jailhouse-dev@googlegroups.com
@@ -48,6 +52,24 @@ Mailing list:
   - Archives
     - http://news.gmane.org/gmane.linux.jailhouse
 
+Continuous integration:
+
+  - https://travis-ci.org/siemens/jailhouse
+
+  - Status:
+    - ![](https://travis-ci.org/siemens/jailhouse.svg?branch=master) on master
+    - ![](https://travis-ci.org/siemens/jailhouse.svg?branch=next) on next
+
+Static code analysis:
+
+  - https://scan.coverity.com/projects/4114
+
+  - Status:
+    - ![](https://scan.coverity.com/projects/4114/badge.svg) on coverity_scan
+
+See the [contribution documentation](CONTRIBUTING.md) for details
+on how to write Jailhouse patches and propose them for upstream integration.
+
 
 Requirements (preliminary)
 --------------------------
@@ -75,6 +97,7 @@ x86 architecture:
   - at least 2 logical CPUs
 
   - x86-64 Linux kernel (tested against >= 3.14)
+
     - VT-d IOMMU usage (DMAR) has to be disabled in the Linux kernel, e.g. via
       the command line parameter:
 
@@ -83,6 +106,27 @@ x86 architecture:
     - To exploit the faster x2APIC, interrupt remapping needs to be on in the
       kernel (check for CONFIG_IRQ_REMAP)
 
+ARM architecture:
+
+  - Abstract:
+
+    - ARMv7 with virtualization extensions
+
+    - Appropriate boot loader support (typically U-Boot)
+      - Linux is started in HYP mode
+      - PSCI support for CPU offlining
+
+    - at least 2 logical CPUs
+
+  - Board support:
+
+    - Banana Pi (see also [below](#setup-on-banana-pi-arm-board))
+
+    - NVIDIA Jetson TK1
+
+    - ARM Versatile Express with Cortex-A15 or A7 cores
+      (includes ARM Fast Model)
+
 
 Build & Installation
 --------------------
@@ -141,7 +185,7 @@ nested SVM support. Start the virtual machine as follows:
         -device ide-hd,drive=disk -serial stdio -serial vc \
         -device intel-hda,addr=1b.0 -device hda-duplex
 
-Inside the VM, make sure that jailhouse-*.bin, generated by the build process,
+Inside the VM, make sure that `jailhouse-*.bin`, generated by the build process,
 are available for firmware loading (typically /lib/firmware), see above for
 installation steps.
 
@@ -151,8 +195,12 @@ need to add
 
     memmap=66M$0x3b000000
 
-as parameter to the command line of the virtual machine's kernel. Reboot the
-guest and load jailhouse.ko. Then enable Jailhouse like this:
+as parameter to the command line of the virtual machine's kernel. The Jailhouse
+QEMU cell config will block use of the serial port by the guest OS, so make
+sure that the guest kernel command line does NOT have its console set to log
+to the serial port (ie remove any 'console=ttyS0' arguments from the grub
+config). Reboot the guest and load jailhouse.ko. Then enable Jailhouse like
+this:
 
     jailhouse enable /path/to/qemu-vm.cell
 
@@ -225,8 +273,8 @@ The Banana Pi is a cheap Raspberry-Pi-like ARM board with an Allwinner A20 SoC
 comparably well hackable. Further information can be found on
 http://linux-sunxi.org.
 
-For Jailhouse, U-Boot currently requires a few additional patches that can be
-retrieved from https://github.com/siemens/u-boot/commits/sunxi.
+For Jailhouse, a U-Boot (pre-)release more recent than v2015.04-rc1 is
+required. Tested and know to work is git revision bd2a4888b1.
 
 The Linux kernel version should be at least 3.19-rcX. The configuration used
 for continuous integration builds can serve as reference, see