From 17bc3bf60dc13014f04f1f364081b565319072a8 Mon Sep 17 00:00:00 2001
From: Jerry Zhao <jerryz123@berkeley.edu>
Date: Fri, 10 May 2019 02:24:10 -0700
Subject: [PATCH] Decouple SUB_PROJECT builds from example

---
 build.sbt                                                    | 5 ++++-
 common.mk                                                    | 4 ++--
 .../example => example/src/main/scala}/ConfigMixins.scala    | 0
 .../scala/example => example/src/main/scala}/Configs.scala   | 0
 .../scala/example => example/src/main/scala}/Generator.scala | 0
 {src/main/scala/example => example/src/main/scala}/PWM.scala | 0
 .../example => example/src/main/scala}/TestHarness.scala     | 0
 {src/main/scala/example => example/src/main/scala}/Top.scala | 0
 .../src/main/resources}/bootrom                              | 0
 .../src/main/resources}/csrc/emulator.cc                     | 0
 .../example => utilities/src/main/scala}/Simulator.scala     | 4 ++--
 11 files changed, 8 insertions(+), 5 deletions(-)
 rename {src/main/scala/example => example/src/main/scala}/ConfigMixins.scala (100%)
 rename {src/main/scala/example => example/src/main/scala}/Configs.scala (100%)
 rename {src/main/scala/example => example/src/main/scala}/Generator.scala (100%)
 rename {src/main/scala/example => example/src/main/scala}/PWM.scala (100%)
 rename {src/main/scala/example => example/src/main/scala}/TestHarness.scala (100%)
 rename {src/main/scala/example => example/src/main/scala}/Top.scala (100%)
 rename {src/main/resources/project-template => utilities/src/main/resources}/bootrom (100%)
 rename {src/main/resources/project-template => utilities/src/main/resources}/csrc/emulator.cc (100%)
 rename {src/main/scala/example => utilities/src/main/scala}/Simulator.scala (97%)

diff --git a/build.sbt b/build.sbt
index 9fdc386..faea433 100644
--- a/build.sbt
+++ b/build.sbt
@@ -45,10 +45,13 @@ def conditionalDependsOn(prj: Project): Project = {
   }
 }
 
-lazy val example = conditionalDependsOn(project in file("."))
+lazy val example = conditionalDependsOn(project in file("example"))
   .dependsOn(boom, hwacha, sifive_blocks)
   .settings(commonSettings)
 
+lazy val utilities = conditionalDependsOn(project in file("utilities"))
+  .settings(commonSettings)
+
 lazy val hwacha = (project in file ("generators/hwacha"))
   .dependsOn(rebarrocketchip)
   .settings(commonSettings)
diff --git a/common.mk b/common.mk
index f93e44a..41ad6a8 100644
--- a/common.mk
+++ b/common.mk
@@ -9,7 +9,7 @@ SHELL=/bin/bash
 lookup_scala_srcs = $(shell find -L $(1)/ -iname "*.scala" 2> /dev/null)
 
 PACKAGES=rocket-chip testchipip boom hwacha sifive-blocks
-SCALA_SOURCES=$(foreach pkg,$(PACKAGES),$(call lookup_scala_srcs,$(base_dir)/generators/$(pkg)/src/main/scala)) $(call lookup_scala_srcs,$(base_dir)/src/main/scala)
+SCALA_SOURCES=$(foreach pkg,$(PACKAGES),$(call lookup_scala_srcs,$(base_dir)/generators/$(pkg)/src/main/scala)) $(call lookup_scala_srcs,$(base_dir)/example/src/main/scala) $(call lookup_scala_srcs,$(base_dir)/utilities/src/main/scala)
 
 #########################################################################################
 # rocket and testchipip classes
@@ -32,7 +32,7 @@ $(FIRRTL_JAR): $(call lookup_scala_srcs, $(REBAR_FIRRTL_DIR)/src/main/scala)
 # create simulation args file rule
 #########################################################################################
 $(sim_dotf): $(SCALA_SOURCES) $(FIRRTL_JAR)
-	cd $(base_dir) && $(SBT) "runMain example.GenerateSimFiles -td $(build_dir) -sim $(sim_name)"
+	cd $(base_dir) && $(SBT) "project utilities" "runMain utilities.GenerateSimFiles -td $(build_dir) -sim $(sim_name)"
 
 #########################################################################################
 # create firrtl file rule and variables
diff --git a/src/main/scala/example/ConfigMixins.scala b/example/src/main/scala/ConfigMixins.scala
similarity index 100%
rename from src/main/scala/example/ConfigMixins.scala
rename to example/src/main/scala/ConfigMixins.scala
diff --git a/src/main/scala/example/Configs.scala b/example/src/main/scala/Configs.scala
similarity index 100%
rename from src/main/scala/example/Configs.scala
rename to example/src/main/scala/Configs.scala
diff --git a/src/main/scala/example/Generator.scala b/example/src/main/scala/Generator.scala
similarity index 100%
rename from src/main/scala/example/Generator.scala
rename to example/src/main/scala/Generator.scala
diff --git a/src/main/scala/example/PWM.scala b/example/src/main/scala/PWM.scala
similarity index 100%
rename from src/main/scala/example/PWM.scala
rename to example/src/main/scala/PWM.scala
diff --git a/src/main/scala/example/TestHarness.scala b/example/src/main/scala/TestHarness.scala
similarity index 100%
rename from src/main/scala/example/TestHarness.scala
rename to example/src/main/scala/TestHarness.scala
diff --git a/src/main/scala/example/Top.scala b/example/src/main/scala/Top.scala
similarity index 100%
rename from src/main/scala/example/Top.scala
rename to example/src/main/scala/Top.scala
diff --git a/src/main/resources/project-template/bootrom b/utilities/src/main/resources/bootrom
similarity index 100%
rename from src/main/resources/project-template/bootrom
rename to utilities/src/main/resources/bootrom
diff --git a/src/main/resources/project-template/csrc/emulator.cc b/utilities/src/main/resources/csrc/emulator.cc
similarity index 100%
rename from src/main/resources/project-template/csrc/emulator.cc
rename to utilities/src/main/resources/csrc/emulator.cc
diff --git a/src/main/scala/example/Simulator.scala b/utilities/src/main/scala/Simulator.scala
similarity index 97%
rename from src/main/scala/example/Simulator.scala
rename to utilities/src/main/scala/Simulator.scala
index 98d69c8..01edb06 100644
--- a/src/main/scala/example/Simulator.scala
+++ b/utilities/src/main/scala/Simulator.scala
@@ -1,4 +1,4 @@
-package example
+package utilities
 
 import java.io.File
 
@@ -102,7 +102,7 @@ object GenerateSimFiles extends App with HasGenerateSimConfig {
     firrtl.FileUtils.makeDirectory("./bootrom/")
     writeResource("/testchipip/bootrom/bootrom.rv64.img", "./bootrom/")
     writeResource("/testchipip/bootrom/bootrom.rv32.img", "./bootrom/")
-    writeResource("/project-template/bootrom/bootrom.img", "./bootrom/")
+    writeResource("/bootrom/bootrom.img", "./bootrom/")
   }
 
   def writeFiles(cfg: GenerateSimConfig): Unit = {