Add tutorial config and tutorial patches

.circleci/config.yml

@@ -143,6 +143,15 @@ jobs:
                 name: Check commits of each submodule
                 command: |
                     .circleci/check-commit.sh
+    tutorial-setup-check:
+        executor: main-env
+        steps:
+            - checkout
+            - run:
+                name: Check that the tutorial-setup patches apply
+                command: |
+                    scripts/tutorial-setup.sh
+
     install-riscv-toolchain:
         executor: main-env
         steps:
@@ -193,6 +202,11 @@ jobs:
         steps:
             - prepare-rtl:
                 project-key: "chipyard-rocket"
+    prepare-chipyard-sha3:
+        executor: main-env
+        steps:
+            - prepare-rtl:
+                project-key: "chipyard-sha3"
     prepare-chipyard-hetero:
         executor: main-env
         steps:
@@ -256,6 +270,11 @@ jobs:
         steps:
             - run-tests:
                 project-key: "chipyard-rocket"
+    chipyard-sha3-run-tests:
+        executor: main-env
+        steps:
+            - run-tests:
+                project-key: "chipyard-sha3"
     chipyard-hetero-run-tests:
         executor: main-env
         steps:
@@ -343,6 +362,9 @@ workflows:
 
             - commit-on-master-check
 
+            # Attempt to apply the tutorial patches
+            - tutorial-setup-check
+
             # Build extra tests
             - build-extra-tests:
                 requires:
@@ -354,6 +376,11 @@ workflows:
                     - install-riscv-toolchain
                     - install-verilator
 
+            - prepare-chipyard-sha3:
+                requires:
+                    - install-riscv-toolchain
+                    - install-verilator
+
             - prepare-chipyard-hetero:
                 requires:
                     - install-riscv-toolchain
@@ -417,6 +444,10 @@ workflows:
                 requires:
                     - prepare-chipyard-rocket
 
+            - chipyard-sha3-run-tests:
+                requires:
+                    - prepare-chipyard-sha3
+
             - chipyard-hetero-run-tests:
                 requires:
                     - prepare-chipyard-hetero

.circleci/defaults.sh

@@ -42,6 +42,7 @@ LOCAL_FIRESIM_DIR=$LOCAL_CHIPYARD_DIR/sims/firesim/sim
 # key value store to get the build strings
 declare -A mapping
 mapping["chipyard-rocket"]="SUB_PROJECT=chipyard"
+mapping["chipyard-sha3"]="SUB_PROJECT=chipyard CONFIG=Sha3RocketConfig"
 mapping["chipyard-hetero"]="SUB_PROJECT=chipyard CONFIG=LargeBoomAndRocketConfig"
 mapping["chipyard-boom"]="SUB_PROJECT=chipyard CONFIG=SmallBoomConfig"
 mapping["rocketchip"]="SUB_PROJECT=rocketchip"

.circleci/run-tests.sh

@@ -28,6 +28,8 @@ run_tracegen () {
     make tracegen -C $LOCAL_SIM_DIR VERILATOR_INSTALL_DIR=$LOCAL_VERILATOR_DIR $@
 }
 
+# TODO BUG: the run-binary command forces a rebuild of the simulator in CI
+#           instead, directly run the simulator binary
 case $1 in
     chipyard-rocket)
         run_bmark ${mapping[$1]}
@@ -58,6 +60,10 @@ case $1 in
         $LOCAL_SIM_DIR/simulator-chipyard-GemminiRocketConfig $GEMMINI_SOFTWARE_DIR/build/bareMetalC/raw_hazard-baremetal
         $LOCAL_SIM_DIR/simulator-chipyard-GemminiRocketConfig $GEMMINI_SOFTWARE_DIR/build/bareMetalC/mvin_mvout-baremetal
         ;;
+    chipyard-sha3)
+        (cd $LOCAL_CHIPYARD_DIR/generators/sha3/software && ./build.sh)
+        $LOCAL_SIM_DIR/simulator-chipyard-Sha3RocketConfig $LOCAL_CHIPYARD_DIR/generators/sha3/software/benchmarks/bare/sha3-rocc.riscv
+        ;;
     tracegen)
         run_tracegen ${mapping[$1]}
         ;;