arm-virtualizer: Initial import of v2.1 releasearm_v2.1

From Release_Notes.txt:

ARM Virtualizer software release v2.1

This software release is a v2.1 snapshot of the ARM Virtualizer
software.

The ARM Virtualizer software is example code that demonstrates
cluster context switching capability on a coherent dual cluster
system composed of a Cortex-A7 cluster and a Cortex-A15 cluster.

The intent behind this delivery is to allow inspection of the
software architecture and to demonstrate existing functionality.

It is possible to execute the ARM Virtualizer software on a
Kingfisher Real-Time System Model (RTSM VE Cortex-A15 KF CCI
version 6.2 Beta).

1 files changed, 90 insertions, 0 deletions

diff --git a/docs/01-Usage.txt b/docs/01-Usage.txt
new file mode 100644
index 0000000..3eeb764
--- /dev/null
+++ b/docs/01-Usage.txt
@@ -0,0 +1,90 @@
+Usage
+=====
+
+1.  Requirements/Pre-requisites
+
+    1.  A Linux development environment. This release has been
+        build tested on the following Linux host environments:
+
+        1.  Linux Ubuntu 10.10  
+        2.  Red Hat Enterprise Linux WS release 4 (Nahant Update 4)
+
+        This release is not intended to be used on development
+        environments other than Linux.
+
+    2.  An installation of the ARM RealView Development Suite. This
+        release was built and tested with version 4.1 [Build 514].
+
+    3.  An installation of the Perl scripting language. This release
+        was built and tested with v5.10.1.
+
+    4.  An installation of the GNU coreutils suite 
+        <http://www.gnu.org/software/coreutils/>.  This release was
+        built and tested with v8.5.
+
+2.  Build instructions
+
+    Note that this release relies on the 'env' utility, which is
+    a part of the coreutils suite. The 'env' utility is expected
+    to be located at '/bin/env'. If it is at a different
+    location then this must be reflected in the first line of
+    the following file:
+
+    arm-virtualizer-v2_1-171111/bootwrapper/makemap
+
+    Failure to make this modification will result in a build
+    failure.
+
+    To build the software:
+
+    $ tar -jxf arm-virtualizer-v2_1-171111.tar.bz2
+    $ cd arm-virtualizer-v2_1-171111/bootwrapper
+    $ make clean && make
+
+    The resulting file is 'img.axf'.
+
+    This image may be loaded and executed on the model debugger 
+    as explained in section 3 below.
+
+    Note that the pre-built stub kernel image is located at:
+
+    arm-virtualizer-v2_1-171111/bootwrapper/payload/kernel
+
+    .. and the placeholder dummy root filesystem image is located 
+    at:
+        
+    arm-virtualizer-v2_1-171111/bootwrapper/payload/fsimg
+
+    These may be replaced with custom built images such as a 
+    suitably configured linux kernel image and a root filesystem 
+    image. 
+    
+    Look at docs/03-Linux-kernel-build.txt for instructions on 
+    building a suitable Linux kernel. 
+    
+    Look at docs/06-Optional-rootfs-build.txt for optionally 
+    building a complete root filesystem.
+
+3.  Usage
+
+    If the Kingfisher Real-Time System Model (RTSM VE Cortex-A15 KF
+    CCI version 6.2 Beta) is installed, the resulting 
+    img.axf file may be loaded, executed and debugged on the 
+    model and the associated model debugger.
+
+    This model may be obtained from ARM by separate arrangement.
+
+    Steps to run the software:
+
+    a.    Depending upon whether the MPx1 or MPx4 model is being used,
+          update the big-little-mp<x>.mxscript file (x is 1 or 
+          4 as the case may be) with the absolute
+          path to the model and the img.axf file. (Comments in the
+          file indicate where the changes have to be made)
+
+    b.    Invoke the modeldebugger and the script file as follows:
+
+          $ <path to modeldebugger> -s <path to big-little-mp<x>.mxscript>
+
+          The default build simultaneously switches clusters 
+          every 12 million cycles (appx).