Updated Readme and added socsim scripts

README.md

@@ -24,10 +24,21 @@ Custom accelerator repsitories can be added to your forked project using the fol
 
 `cd $SOCLABS_PROJECT_DIR; git submodule add youracceleratorurl.git`
 
-Once this has been done, you should see a folder at the top-level of your project containing your accelerator repository. This will be on 
-## Re-creating the top-level design
+Once this has been done, you should see a folder at the top-level of your project containing your accelerator repository. This will be on a hash and not on a branch. 
 
-Set up the environment variables and paths for this project:
+To get this repository to checkout to a branch, modify the top-level `projbranch` file to add your repository name (this should be the name of the directory it is in), followed by a colon and the name of the branch you wish it to check out to.
+
+Then re-run the set environment script and force it to checkout all subrepositories:
+
+`source set_env.sh -f` 
+
+The last thing you will wish to do it to modify the `env/dependency_env.sh` file. In here you can set an environment variable for your repsotry so it can be used in scripts and commands. Once this has been added, again run set environment command:
+
+`source set_env.sh` 
+
+## Setting up your environment
+
+Every time you wish to run commands in this project, you will need to make sure the set environment script has been run for your current terminal session. This is done by moving to the top-level of the project and running:
 
 `source set_env.sh` 
 
@@ -35,10 +46,14 @@ This sets the environment variables related to this project and creates visabili
 
 ## Running the simulation
 
-This design instantiates a custom (AMBA-AHB) wrapper around the AES core to implement a memory-mapped 128-bit AES encrypt/decrypt accelerator that can be used as a software-driven peripheral or a semi-autonomous DMA subystem when 128-bit keys and variable length data payloads can be set up as scatter/gather descriptor chains for background processing.
+socsim is a tool that SoC Labs have developed that allows for running of shell scripts anywhere within your project environment. The idea is these scripts can be customised to run scripts for different simulators.
+
+These scripts are located in `simulate/socsim`. There are some example scripts in there and can be run using the following command, where hello is the testcase to be run:
+
+  `socsim system_nanosoc TESTNAME=hello`
+  
+To run the simulation the 'socsim' command executes the makefile in the 'nanosoc_tech' microcontroller framework. (Edit the simulator target in nanosoc_tech/nanosoc/makefile for the simulator EDA tool used).
 
-To run the simulation the 'socsim' command executes the makefile in the 'nanosoc_tech' microcontroller framework. (Edit the simulator target in nanosoc_tech/nanosoc/makefile for the simulator EDA tool used). Then use the 
+This runs the integration test program on the Arm Cortex-M0 processor using the 'system_nanosoc.sh' script provided in the simulate/socsim directory and the logs are produced in the simulate/sim/system_nanosoc/logs directory.
 
-  `socsim system_aes128 TESTNAME=aes128_tests`
 
-This runs the integration test program on the Arm Cortex-M0 processor using the 'system_aes128.sh' script provided in the simulate/socsim directory and the logs are produced in the simulate/sim/system_aes128/logs directory.
\ No newline at end of file

simulate/socsim/regression_nanosoc.sh

+#-----------------------------------------------------------------------------
+# SoC Labs Simulation script for system level verification
+# A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.
+#
+# Contributors
+#
+# David Mapstone (d.a.mapstone@soton.ac.uk)
+#
+# Copyright  2023, SoC Labs (www.soclabs.org)
+#-----------------------------------------------------------------------------
+
+#!/usr/bin/env bash
+
+# Get simulation name from name of script
+SIM_NAME=`basename -s .sh "$0"`
+
+# Directory to put simulation files
+SIM_DIR=$SOCLABS_PROJECT_DIR/simulate/sim/$SIM_NAME
+
+# Create Directory to put simulation files
+mkdir -p $SIM_DIR
+cd $SOCLABS_PROJECT_DIR/simulate/sim/$SIM_NAME
+
+# Compile Simulation
+# Call makefile in NanoSoC Repo with options
+echo ${2}
+make -C $SOCLABS_NANOSOC_TECH_DIR regression_mti \
+    SIM_DIR=$SIM_DIR \
+    ACCELERATOR=no \
+    ${@:2}
+

simulate/socsim/system_nanosoc.sh

+#-----------------------------------------------------------------------------
+# SoC Labs Simulation script for system level verification
+# A joint work commissioned on behalf of SoC Labs, under Arm Academic Access license.
+#
+# Contributors
+#
+# David Mapstone (d.a.mapstone@soton.ac.uk)
+#
+# Copyright  2023, SoC Labs (www.soclabs.org)
+#-----------------------------------------------------------------------------
+
+#!/usr/bin/env bash
+
+# Get simulation name from name of script
+SIM_NAME=`basename -s .sh "$0"`
+
+# Directory to put simulation files
+SIM_DIR=$SOCLABS_PROJECT_DIR/simulate/sim/$SIM_NAME
+
+# Create Directory to put simulation files
+mkdir -p $SIM_DIR
+cd $SOCLABS_PROJECT_DIR/simulate/sim/$SIM_NAME
+
+# Compile Simulation
+# Call makefile in NanoSoC Repo with options
+echo ${2}
+make -C $SOCLABS_NANOSOC_TECH_DIR run_mti \
+    SIM_DIR=$SIM_DIR \
+    ACCELERATOR=no \
+    ${@:2}
+