Slight polish of CI scripts

Author: dpretet

.github/workflows/ci.yaml

@@ -5,23 +5,17 @@ jobs:
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v2
-      - run: brew install verilator
       - run: git submodule update --init --recursive
       - run: ./flow.sh lint
-  Simulation:
+  Synthesis:
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v2
-      - run: brew install icarus-verilog
-      - run: brew install verilator
-      - run: iverilog -V
-      - run: verilator -V
       - run: git submodule update --init --recursive
-      - run: ./flow.sh sim
-  Synthesis:
+      - run: ./flow.sh syn
+  Simulation:
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v2
-      - run: brew install yosys
       - run: git submodule update --init --recursive
-      - run: ./flow.sh syn
+      - run: ./flow.sh sim

flow.sh

@@ -6,8 +6,20 @@
 # -o pipefail: causes a pipeline to fail if any command fails
 set -eu -o pipefail
 
-# Current script path; doesn't support symlink
-CURDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+#-------------------------------------------------------------
+# Get current script path (applicable even if is a symlink)
+#-------------------------------------------------------------
+
+SOURCE="${BASH_SOURCE[0]}"
+while [ -h "$SOURCE" ]; do
+  DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+done
+DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )"
+
+# Functions to install the flow
+source script/setup.sh
 
 ret=0
 
@@ -88,14 +100,15 @@ main() {
 
     # Print help
     if [[ $1 == "-h" || $1 == "help" ]]; then
-
         help
         exit 0
     fi
 
 
     if [[ $1 == "lint" ]]; then
 
+        install_verilator
+        # Disable break on error bc Verilator exit with 1 with warnings
         set +e
 
         printinfo "Start Verilator lint"
@@ -148,19 +161,21 @@ main() {
     fi
 
     if [[ $1 == "sim" ]]; then
-        # Install SVUT if missing in $PATH
-        source script/setup.sh
+        # Install SVUT and Icarus Verilog if needed
+        install_svut
+        install_icarus
         # Run all testsuites against all configurations
-        cd "$CURDIR/test/svut"
+        cd "$DIR/test/svut"
         ./run.sh --no-debug-log --no-wave
         ret=$?
         echo "Execution status: $ret"
         exit $ret
     fi
 
     if [[ $1 == "syn" ]]; then
+        install_yosys
         printinfo "Start synthesis flow"
-        cd "$CURDIR/syn/yosys"
+        cd "$DIR/syn/yosys"
         # AXI4 synthesis
         ./syn_asic.sh axicb_axi4.ys | tee axi4.log
         ret=$?

script/setup.sh

@@ -3,24 +3,51 @@
 #-------------------------------------------------------------
 # Install SVUT from https://github.com/dpretet/svut if missing
 #-------------------------------------------------------------
+install_svut() {
+    if [[ ! $(type svutRun) ]];
+    then
+        svut_dir="$DIR/.svut"
+        if [[ ! -d $svut_dir ]]; then
+            echo "INFO: Install SVUT (https://github.com/dpretet/svut)"
+            git clone "https://github.com/dpretet/svut.git" "$svut_dir"
+        fi
+        echo "INFO: Enable SVUT in PATH"
+        export PATH=$svut_dir/:$PATH
+    fi
+}
+
+#-------------------------------------------------------------
+# Install Verilator with brew
+#-------------------------------------------------------------
+install_verilator() {
+    if [[ ! $(type verilator) ]];
+    then
+        echo "INFO: Enable Verilator"
+        brew install verilator
+        verilator -V
+    fi
+}
 
-# Get current script path (applicable even if is a symlink)
-SOURCE="${BASH_SOURCE[0]}"
-while [ -h "$SOURCE" ]; do
-  DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )"
-  SOURCE="$(readlink "$SOURCE")"
-  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
-done
-DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )"
+#-------------------------------------------------------------
+# Install Icarus-verilog with brew
+#-------------------------------------------------------------
+install_icarus() {
+    if [[ ! $(type iverilog) ]];
+    then
+        echo "INFO: Enable Icarus-Verilog"
+        brew install icarus-verilog
+        iverilog -V
+    fi
+}
 
-# Clone SVUT and setup $PATH
-if [[ ! $(type svutRun) ]];
-then
-    svut_dir="$DIR/.svut"
-    if [[ ! -d $svut_dir ]]; then
-        echo "INFO: Install SVUT (https://github.com/dpretet/svut)"
-        git clone "https://github.com/dpretet/svut.git" "$svut_dir"
+#-------------------------------------------------------------
+# Install Icarus-verilog with brew
+#-------------------------------------------------------------
+install_icarus() {
+    if [[ ! $(type yosys) ]];
+    then
+        echo "INFO: Enable Yosys"
+        brew install yosys
+        iverilog -V
     fi
-    echo "INFO: Enable SVUT in PATH"
-    export PATH=$svut_dir/:$PATH
-fi
+}