Merge branch accelerator-project:main into main

README.md

 # AES-128 Example Accelerator System Project
 
-This repo is the top-level repository which contains an example accelerator based on the secworks AES engine integrated in SoC Labs provided nanosoc chip design IP in forms of git subrepositories.
+This repo is the top-level project repository which is used as a base for other projects to be built from.
 
 ## Cloning this repository
 
@@ -22,6 +22,14 @@ Every time you wish to run commands in this project, you will need to make sure
 
 This sets the environment variables related to this project and creates visability to the scripts in the flow directory. 
 
+## Updating Subrepositories
+
+Once you have run a `source set_env.sh` in your current terminal, you are then able to update all your repositories to their latest version by running:
+
+`socpull`
+
+This runs a git pull on all repositories in your project.
+
 ## 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.

simulate/socsim/regression_aes128.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=yes \
-    ${@:2}
-

simulate/socsim/system_aes128.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=yes \
-    ${@:2}
-