Adding barstools to separate the top from harness and to generate the

memories as external modules, which makes VLSI flows easier to plug in.
2019-02-07 11:11:25 -08:00 · 2019-02-07 11:11:25 -08:00 · acd76e5410
parent d01e38ef8a
commit acd76e5410
8 changed files with 74 additions and 11 deletions
--- a/.gitmodules
+++ b/.gitmodules
@ -4,3 +4,6 @@
 [submodule "testchipip"]
 	path = testchipip
 	url = https://github.com/ucb-bar/testchipip.git
+[submodule "barstools"]
+	path = barstools
+	url = git@github.com:ucb-bar/barstools
--- a/48
+++ b/48
@ -1,13 +1,16 @@
 ROCKETCHIP_DIR=$(base_dir)/rocket-chip

-SBT ?= java -Xmx2G -Xss8M -XX:MaxPermSize=256M -jar $(ROCKETCHIP_DIR)/sbt-launch.jar ++2.12.4
+SCALA_VERSION=2.12.4
+SCALA_VERSION_MAJOR=$(basename $(SCALA_VERSION))
+
+SBT ?= java -Xmx2G -Xss8M -XX:MaxPermSize=256M -jar $(ROCKETCHIP_DIR)/sbt-launch.jar ++$(SCALA_VERSION)

 lookup_scala_srcs = $(shell find $(1)/ -iname "*.scala" 2> /dev/null)

 PACKAGES=rocket-chip testchipip
 SCALA_SOURCES=$(foreach pkg,$(PACKAGES),$(call lookup_scala_srcs,$(base_dir)/$(pkg)/src/main/scala)) $(call lookup_scala_srcs,$(base_dir)/src/main/scala)

-ROCKET_CLASSES ?= "$(ROCKETCHIP_DIR)/target/scala-2.12/classes:$(ROCKETCHIP_DIR)/chisel3/target/scala-2.12/*"
+ROCKET_CLASSES ?= "$(ROCKETCHIP_DIR)/target/scala-$(SCALA_VERSION_MAJOR)/classes:$(ROCKETCHIP_DIR)/chisel3/target/scala-$(SCALA_VERSION_MAJOR)/*"
 FIRRTL_JAR ?= $(ROCKETCHIP_DIR)/lib/firrtl.jar
 FIRRTL ?= java -Xmx2G -Xss8M -XX:MaxPermSize=256M -cp $(ROCKET_CLASSES):$(FIRRTL_JAR) firrtl.Driver

@ -24,16 +27,47 @@ include $(testchip_dir)/Makefrag

 CHISEL_ARGS ?=

-FIRRTL_FILE=$(build_dir)/$(PROJECT).$(MODEL).$(CONFIG).fir
-ANNO_FILE=$(build_dir)/$(PROJECT).$(MODEL).$(CONFIG).anno.json
-VERILOG_FILE=$(build_dir)/$(PROJECT).$(MODEL).$(CONFIG).v
+long_name=$(PROJECT).$(MODEL).$(CONFIG)
+
+FIRRTL_FILE  ?=$(build_dir)/$(long_name).fir
+ANNO_FILE    ?=$(build_dir)/$(long_name).anno.json
+VERILOG_FILE ?=$(build_dir)/$(long_name).top.v
+HARNESS_FILE ?=$(build_dir)/$(long_name).harness.v
+SMEMS_FILE   ?=$(build_dir)/$(long_name).mems.v
+SMEMS_CONF   ?=$(build_dir)/$(long_name).mems.conf
+
+REPL_SEQ_MEM = --repl-seq-mem -c:$(MODEL):-o:$(SMEMS_CONF)
+
+# This should match whatever the commonSettings version is in build.sbt
+BARSTOOLS_VER=1.0
+TAPEOUT_JAR=$(base_dir)/barstools/tapeout/target/scala-$(SCALA_VERSION_MAJOR)/tapeout_$(SCALA_VERSION_MAJOR)-$(BARSTOOLS_VER).jar
+MACROCOMPILER_JAR=$(base_dir)/barstools/macros/target/scala-$(SCALA_VERSION_MAJOR)/barstools-macros-assembly-$(BARSTOOLS_VER).jar
+
+TAPEOUT ?= java -Xmx8G -Xss8M -cp $(ROCKET_CLASSES):$(FIRRTL_JAR):$(TAPEOUT_JAR)
+MACROCOMPILER ?= java -Xmx8G -Xss8M -cp $(ROCKET_CLASSES):$(FIRRTL_JAR):$(MACROCOMPILER_JAR)
+
+$(TAPEOUT_JAR): $(call lookup_scala_srcs, $(base_dir)/barstools/tapeout/src/main/scala) $(FIRRTL_JAR)
+	cd $(base_dir) && $(SBT) "tapeout/package"
+
+$(MACROCOMPILER_JAR): $(call lookup_scala_srcs, $(base_dir)/barstools/macros/src/main/scala) $(call lookup_scala_srcs, $(base_dir)/barstools/mdf/scalalib/src/main/scala) $(FIRRTL_JAR)
+	cd $(base_dir) && $(SBT) "barstools-macros/assembly"
+
+.PHONY: jars
+jars: $(MACROCOMPILER_JAR) $(TAPEOUT_JAR)

 $(FIRRTL_FILE) $(ANNO_FILE): $(SCALA_SOURCES) $(bootrom_img) $(FIRRTL_JAR)
 	mkdir -p $(build_dir)
 	cd $(base_dir) && $(SBT) "runMain $(PROJECT).Generator $(CHISEL_ARGS) $(build_dir) $(PROJECT) $(MODEL) $(CFG_PROJECT) $(CONFIG)"

-$(VERILOG_FILE): $(FIRRTL_FILE) $(ANNO_FILE) $(FIRRTL_JAR)
-	$(FIRRTL) -i $(FIRRTL_FILE) -o $(VERILOG_FILE) -X verilog -faf $(ANNO_FILE)
+$(VERILOG_FILE) $(SMEMS_CONF): $(FIRRTL_FILE) $(ANNO_FILE) $(TAPEOUT_JAR)
+	$(TAPEOUT) barstools.tapeout.transforms.GenerateTop -o $(VERILOG_FILE) -i $(FIRRTL_FILE) --syn-top $(TOP) --harness-top $(MODEL) -faf $(ANNO_FILE) $(REPL_SEQ_MEM)
+
+$(HARNESS_FILE): $(FIRRTL_FILE) $(ANNO_FILE) $(TAPEOUT_JAR)
+	$(TAPEOUT) barstools.tapeout.transforms.GenerateHarness -o $(HARNESS_FILE) -i $(FIRRTL_FILE) --syn-top $(TOP) --harness-top $(MODEL) -faf $(ANNO_FILE)
+
+# This file is for simulation only. VLSI flows should replace this file with one containing hard SRAMs
+$(SMEMS_FILE): $(SMEMS_CONF) $(MACROCOMPILER_JAR)
+	$(MACROCOMPILER) barstools.macros.MacroCompiler -n $(SMEMS_CONF) -v $(SMEMS_FILE) --mode synflops

 regression-tests = \
 	rv64ud-v-fcvt \
--- a/1
+++ b/1
@ -0,0 +1 @@
+Subproject commit 1f58ea1e141c69276ae1680a9ece6c42a31653e5
--- a/build.sbt
+++ b/build.sbt
@ -3,10 +3,15 @@ lazy val commonSettings = Seq(
  version := "1.0",
  scalaVersion := "2.12.4",
  traceLevel := 15,
+  test in assembly := {},
+  assemblyMergeStrategy in assembly := { _ match {
+    case PathList("META-INF", "MANIFEST.MF") => MergeStrategy.discard
+    case _ => MergeStrategy.first}},
  scalacOptions ++= Seq("-deprecation","-unchecked","-Xsource:2.11"),
  libraryDependencies += "org.scalatest" %% "scalatest" % "3.0.1" % "test",
  libraryDependencies += "org.json4s" %% "json4s-native" % "3.5.3",
  libraryDependencies += "org.scala-lang" % "scala-reflect" % scalaVersion.value,
+  libraryDependencies += "edu.berkeley.cs" %% "firrtl-interpreter" % "1.2-SNAPSHOT",
  addCompilerPlugin("org.scalamacros" % "paradise" % "2.1.0" cross CrossVersion.full),
  resolvers ++= Seq(
    Resolver.sonatypeRepo("snapshots"),
@ -15,6 +20,21 @@ lazy val commonSettings = Seq(

 lazy val rocketchip = RootProject(file("rocket-chip"))

-lazy val testchipip = project.settings(commonSettings).dependsOn(rocketchip)
+lazy val testchipip = project.settings(commonSettings)
+  .dependsOn(rocketchip)
+
+lazy val example = (project in file("."))
+  .settings(commonSettings)
+  .dependsOn(testchipip)
+
+lazy val tapeout = (project in file("./barstools/tapeout/"))
+  .settings(commonSettings)
+  .dependsOn(rocketchip)
+
+lazy val mdf = (project in file("./barstools/mdf/scalalib/"))
+
+lazy val `barstools-macros` = (project in file("./barstools/macros/"))
+  .enablePlugins(sbtassembly.AssemblyPlugin)
+  .settings(commonSettings)
+  .dependsOn(rocketchip, mdf)

-lazy val example = (project in file(".")).settings(commonSettings).dependsOn(testchipip)
--- a/project/build.properties
+++ b/project/build.properties
@ -0,0 +1 @@
+sbt.version=1.2.7
--- a/project/plugins.sbt
+++ b/project/plugins.sbt
@ -0,0 +1 @@
+addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.14.5")
--- a/2
+++ b/2
@ -1 +1 @@
-Subproject commit ee3ad6b3b3218d88b56baeafbc499e2aa7b3f3e0
+Subproject commit 1fa12ec97974dcb04e1e588e799d349c6580095b
--- a/vsim/Makefile
+++ b/vsim/Makefile
@ -6,6 +6,7 @@ MODEL ?= TestHarness
 CONFIG ?= DefaultExampleConfig
 CFG_PROJECT ?= $(PROJECT)
 TB ?= TestDriver
+TOP ?= ExampleTop

 simv = $(sim_dir)/simv-$(PROJECT)-$(CONFIG)
 simv_debug = $(sim_dir)/simv-$(PROJECT)-$(CONFIG)-debug
@ -19,7 +20,9 @@ include $(base_dir)/Makefrag
 rocketchip_vsrc_dir = $(ROCKETCHIP_DIR)/src/main/resources/vsrc

 sim_vsrcs = \
-	$(build_dir)/$(PROJECT).$(MODEL).$(CONFIG).v \
+	$(VERILOG_FILE) \
+	$(HARNESS_FILE) \
+	$(SMEMS_FILE) \
 	$(rocketchip_vsrc_dir)/TestDriver.v \
 	$(rocketchip_vsrc_dir)/AsyncResetReg.v \
 	$(rocketchip_vsrc_dir)/plusarg_reader.v \
				`@ -0,0 +1 @@`
				`Subproject commit 1f58ea1e141c69276ae1680a9ece6c42a31653e5`
				`@ -0,0 +1 @@`
				`addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.14.5")`