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_3-130312/bootwrapper/makemap

    Failure to make this modification will result in a build
    failure.

    To build the software:

    $ tar -jxf arm-virtualizer-v2_3-130312.tar.bz2
    $ cd arm-virtualizer-v2_3-130312/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_3-130312/bootwrapper/payload/kernel

    .. and the placeholder dummy root filesystem image is located
    at:

    arm-virtualizer-v2_3-130312/bootwrapper/payload/fsimg

    These may be replaced with custom built images such as a
    suitably configured linux kernel image and a root filesystem
    image.

    The Virtualizer software image supports asynchronous switching
    by default. This means that an interrupt causes a cluster
    switch approx. every 12 million cycles. The payload software
    can request the Virtualizer software to invoke a switch
    explicitly. This can be done using the "HVC #1" ARM assembler
    instruction from the payload software. This is the synchronous
    method of switching. The two methods are mutually exclusive.
    The Virtualizer software can be built with support for
    synchronous switching by setting the ASYNC environment variable
    to FALSE prior to building it.

    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 Real-Time System Model v7.0.1 (RTSM_VE_Cortex_A15x1_A7x1
    and RTSM_VE_Cortex_A15x4_A7x4) 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).