Modularize saturn

Author: jerryz123

build.sbt

@@ -181,6 +181,9 @@ lazy val chipyard = {
   val includeMempress = file("generators/mempress/.git").exists()
   if (includeMempress) chipyard = chipyard.dependsOn(mempress)
 
+  val includeSaturn = file("generators/saturn/.git").exists()
+  if (includeSaturn) chipyard = chipyard.dependsOn(saturn)
+
   chipyard
 }
 

common.mk

@@ -88,7 +88,7 @@ endif
 # Returns a list of files in directories $1 with *any* of the file extensions in $2
 lookup_srcs_by_multiple_type = $(foreach type,$(2),$(call lookup_srcs,$(1),$(type)))
 
-CHECK_SUBMODULES_COMMAND = echo "Checking required submodules in generators/ are initialized. Uninitialized submodules will be displayed" ; ! git submodule status $(base_dir)/generators | grep '^-.*' | grep -vE "(ara|caliptra|compress|mempress)"
+CHECK_SUBMODULES_COMMAND = echo "Checking required submodules in generators/ are initialized. Uninitialized submodules will be displayed" ; ! git submodule status $(base_dir)/generators | grep '^-.*' | grep -vE "(ara|caliptra|compress|mempress|saturn)"
 
 SCALA_EXT = scala
 VLOG_EXT = sv v

generators/chipyard/src/main/scala/config/SaturnConfigs.scala

@@ -0,0 +1 @@
+../../../../../saturn/chipyard/SaturnConfigs.scala

generators/chipyard/src/main/scala/config/SaturnConfigs.scala

@@ -37,15 +37,18 @@ function usage
     echo "Options:"
     echo "  -h            Display this help message"
     echo "  --full        Initialize all submodules"
-    echo "  --ara         Initialize the optional ara submodule"
+    echo "  --ara         Initialize the optional ara vector-unit submodule"
     echo "  --compressacc Initialize the optional compressor accelerator submodule"
+    echo "  --mempress    Initialize the optional mempress accelerator submodule"
+    echo "  --saturn      Initialize the optional saturn vector-unit submodule"
     echo ""
 }
 
 ENABLE_ARA=""
 ENABLE_CALIPTRA=""
 ENABLE_COMPRESSACC=""
 ENABLE_MEMPRESS=""
+ENABLE_SATURN=""
 
 while test $# -gt 0
 do
@@ -61,6 +64,7 @@ do
 	    ENABLE_CALIPTRA=1
 	    ENABLE_COMPRESSACC=1
 	    ENABLE_MEMPRESS=1
+	    ENABLE_SATURN=1
 	    ;;
 	--ara)
 	    ENABLE_ARA=1
@@ -74,6 +78,9 @@ do
 	--mempress)
 	    ENABLE_MEMPRESS=1
 	    ;;
+	--saturn)
+	    ENABLE_SATURN=1
+	    ;;
         *)
             echo "ERROR: bad argument $1"
             usage
@@ -125,6 +132,7 @@ cd "$RDIR"
 	    generators/mempress \
             generators/gemmini \
             generators/rocket-chip \
+	    generators/saturn \
             generators/compress-acc \
             generators/vexiiriscv \
             sims/firesim \
@@ -188,6 +196,10 @@ cd "$RDIR"
     if [[ "$ENABLE_MEMPRESS" -eq 1 ]] ; then
 	git submodule update --init generators/mempress
     fi
+
+    if [[ "$ENABLE_SATURN" -eq 1 ]] ; then
+	git submodule update --init --recursive generators/saturn
+    fi
 
     # Non-recursive clone to exclude gemmini-software
     submodule_name="generators/gemmini"