Merge pull request #176 from ucb-bar/boom-ci

[boom] move boom integration into chipyard

.circleci/defaults.sh

@@ -38,7 +38,7 @@ declare -A mapping
 mapping["example"]="SUB_PROJECT=example"
 mapping["boomexample"]="SUB_PROJECT=example CONFIG=DefaultBoomConfig"
 mapping["boomrocketexample"]="SUB_PROJECT=example CONFIG=DefaultBoomAndRocketConfig"
-mapping["boom"]="SUB_PROJECT=boom"
+mapping["boom"]="SUB_PROJECT=example CONFIG=SmallBoomConfig"
 mapping["rocketchip"]="SUB_PROJECT=rocketchip"
 mapping["blockdevrocketchip"]="SUB_PROJECT=example CONFIG=BlockDeviceModelRocketConfig TOP=BoomRocketTopWithBlockDevice"
 mapping["hwacha"]="SUB_PROJECT=example CONFIG=HwachaL2Config GENERATOR_PACKAGE=hwacha"

docs/Advanced-Usage/DTM-Debugging.rst

@@ -0,0 +1,50 @@
+Debugging with DTM/JTAG
+===============================
+
+By default, Chipyard is not setup to use the Debug Test Module (DTM) to bringup the core.
+Instead, Chipyard uses TSI commands to bringup the core (which normally results in a faster simulation).
+TSI simulations use the SimSerial interface to directly write the test binary into memory, while the DTM 
+executes a small loop of code to write the test binary byte-wise into memory.
+However, if you want to use JTAG, you must do the following steps to setup a DTM enabled system.
+
+Creating a DTM/JTAG Config
+-------------------------------------------
+
+First, a DTM config must be created for the system that you want to create.
+This involves specifying the SoC top-level to add a DTM as well as configuring that DTM to use JTAG.
+
+.. code-block:: scala
+
+    class DTMBoomConfig extends Config(
+      new WithDTMBoomRocketTop ++
+      new WithBootROM ++
+      new WithJtagDTM ++
+      new boom.common.SmallBoomConfig)
+
+In this example, the ``WithDTMBoomRocketTop`` mixin specifies that the top-level SoC will instantiate a DTM.
+The ``WithJtagDTM`` will configure that instantiated DTM to use JTAG as the bringup method (note: this can be removed if you want a DTM-only bringup).
+The rest of the mixins specify the rest of the system (cores, accelerators, etc).
+
+Starting the DTM Simulation
+-------------------------------------------
+
+After creating the config, call the ``make`` command like the following:
+
+.. code-block:: bash
+
+    cd sims/verilator
+    # or
+    cd sims/vcs
+
+    make CONFIG=DTMBoomConfig TOP=BoomRocketTopWithDTM MODEL=TestHarnessWithDTM
+
+In this example, this will use the config that you previously specified, as well as set the other parameters that are needed to satisfy the build system.
+After that point, you should have a JTAG enabled simulation that you can attach to using OpenOCD and GDB!
+
+Debugging with JTAG
+-------------------------------------------------------
+
+Please refer to the following resources on how to debug with JTAG.
+
+* https://github.com/chipsalliance/rocket-chip#-debugging-with-gdb
+* https://github.com/riscv/riscv-isa-sim#debugging-with-gdb

docs/Advanced-Usage/index.rst

@@ -9,3 +9,4 @@ They expect you to know about Chisel, Parameters, Configs, etc.
    :caption: Getting Started:
 
    Heterogeneous-SoCs
+   DTM-Debugging

generators/example/src/main/scala/BoomConfigs.scala

@@ -0,0 +1,90 @@
+package example
+
+import chisel3._
+
+import freechips.rocketchip.config.{Config}
+import freechips.rocketchip.subsystem.{WithJtagDTM}
+
+import boom.common._
+
+// ---------------------
+// BOOM Configs
+// ---------------------
+
+class SmallBoomConfig extends Config(
+  new WithNormalBoomRocketTop ++
+  new WithBootROM ++
+  new boom.common.SmallBoomConfig)
+
+class MediumBoomConfig extends Config(
+  new WithNormalBoomRocketTop ++
+  new WithBootROM ++
+  new boom.common.MediumBoomConfig)
+
+class LargeBoomConfig extends Config(
+  new WithNormalBoomRocketTop ++
+  new WithBootROM ++
+  new boom.common.LargeBoomConfig)
+
+class MegaBoomConfig extends Config(
+  new WithNormalBoomRocketTop ++
+  new WithBootROM ++
+  new boom.common.MegaBoomConfig)
+
+class jtagSmallBoomConfig extends Config(
+  new WithDTMBoomRocketTop ++
+  new WithBootROM ++
+  new WithJtagDTM ++
+  new boom.common.SmallBoomConfig)
+
+class jtagMediumBoomConfig extends Config(
+  new WithDTMBoomRocketTop ++
+  new WithBootROM ++
+  new WithJtagDTM ++
+  new boom.common.MediumBoomConfig)
+
+class jtagLargeBoomConfig extends Config(
+  new WithDTMBoomRocketTop ++
+  new WithBootROM ++
+  new WithJtagDTM ++
+  new boom.common.LargeBoomConfig)
+
+class jtagMegaBoomConfig extends Config(
+  new WithDTMBoomRocketTop ++
+  new WithBootROM ++
+  new WithJtagDTM ++
+  new boom.common.MegaBoomConfig)
+
+class SmallDualBoomConfig extends Config(
+  new WithNormalBoomRocketTop ++
+  new WithBootROM ++
+  new boom.common.SmallDualBoomConfig)
+
+class TracedSmallBoomConfig extends Config(
+  new WithNormalBoomRocketTop ++
+  new WithBootROM ++
+  new boom.common.TracedSmallBoomConfig)
+
+class SmallRV32UnifiedBoomConfig extends Config(
+  new WithNormalBoomRocketTop ++
+  new WithBootROM ++
+  new boom.common.SmallRV32UnifiedBoomConfig)
+
+// --------------------------
+// BOOM + Rocket Configs
+// --------------------------
+
+class SmallBoomAndRocketConfig extends Config(
+  new WithNormalBoomRocketTop ++
+  new WithBootROM ++
+  new boom.common.SmallBoomAndRocketConfig)
+
+class MediumBoomAndRocketConfig extends Config(
+  new WithNormalBoomRocketTop ++
+  new WithBootROM ++
+  new boom.common.MediumBoomAndRocketConfig)
+
+class DualMediumBoomAndDualRocketConfig extends Config(
+  new WithNormalBoomRocketTop ++
+  new WithBootROM ++
+  new boom.common.DualMediumBoomAndDualRocketConfig)

generators/example/src/main/scala/ConfigMixins.scala

@@ -58,6 +58,15 @@ class WithNormalBoomRocketTop extends Config((site, here, up) => {
   }
 })
 
+/**
+ * Class to specify a top level BOOM and/or Rocket system with DTM
+ */
+class WithDTMBoomRocketTop extends Config((site, here, up) => {
+  case BuildBoomRocketTopWithDTM => (clock: Clock, reset: Bool, p: Parameters) => {
+    Module(LazyModule(new BoomRocketTopWithDTM()(p)).module)
+  }
+})
+
 /**
  * Class to specify a top level BOOM and/or Rocket system with PWM
  */

generators/example/src/main/scala/Configs.scala

@@ -77,11 +77,11 @@ class HwachaL2Config extends Config(
 
 class BaseBoomConfig extends Config(
   new WithBootROM ++
-  new boom.system.LargeBoomConfig)
+  new boom.common.LargeBoomConfig)
 
 class SmallBaseBoomConfig extends Config(
   new WithBootROM ++
-  new boom.system.SmallBoomConfig)
+  new boom.common.SmallBoomConfig)
 
 class DefaultBoomConfig extends Config(
   new WithNormalBoomRocketTop ++
@@ -132,7 +132,7 @@ class DualCoreBoomConfig extends Config(
   new boom.common.WithRVC ++
   new boom.common.WithLargeBooms ++
   new boom.common.BaseBoomConfig ++
-  new boom.system.WithNBoomCores(2) ++
+  new boom.common.WithNBoomCores(2) ++
   new freechips.rocketchip.subsystem.WithoutTLMonitors ++
   new freechips.rocketchip.system.BaseConfig)
 
@@ -142,14 +142,14 @@ class DualCoreSmallBoomConfig extends Config(
   new boom.common.WithRVC ++
   new boom.common.WithSmallBooms ++
   new boom.common.BaseBoomConfig ++
-  new boom.system.WithNBoomCores(2) ++
+  new boom.common.WithNBoomCores(2) ++
   new freechips.rocketchip.subsystem.WithoutTLMonitors ++
   new freechips.rocketchip.system.BaseConfig)
 
 class RV32UnifiedBoomConfig extends Config(
   new WithNormalBoomRocketTop ++
   new WithBootROM ++
-  new boom.system.SmallRV32UnifiedBoomConfig)
+  new boom.common.SmallRV32UnifiedBoomConfig)
 
 class BoomL2Config extends Config(
   new WithInclusiveCache ++
@@ -161,22 +161,22 @@ class BoomL2Config extends Config(
 
 class BaseBoomAndRocketConfig extends Config(
   new WithBootROM ++
-  new boom.system.WithRenumberHarts ++
+  new boom.common.WithRenumberHarts ++
   new boom.common.WithRVC ++
   new boom.common.WithLargeBooms ++
   new boom.common.BaseBoomConfig ++
-  new boom.system.WithNBoomCores(1) ++
+  new boom.common.WithNBoomCores(1) ++
   new freechips.rocketchip.subsystem.WithoutTLMonitors ++
   new freechips.rocketchip.subsystem.WithNBigCores(1) ++
   new freechips.rocketchip.system.BaseConfig)
 
 class SmallBaseBoomAndRocketConfig extends Config(
   new WithBootROM ++
-  new boom.system.WithRenumberHarts ++
+  new boom.common.WithRenumberHarts ++
   new boom.common.WithRVC ++
   new boom.common.WithSmallBooms ++
   new boom.common.BaseBoomConfig ++
-  new boom.system.WithNBoomCores(1) ++
+  new boom.common.WithNBoomCores(1) ++
   new freechips.rocketchip.subsystem.WithoutTLMonitors ++
   new freechips.rocketchip.subsystem.WithNBigCores(1) ++
   new freechips.rocketchip.system.BaseConfig)
@@ -223,11 +223,11 @@ class GPIOBoomAndRocketConfig extends Config(
 class DualCoreBoomAndOneRocketConfig extends Config(
   new WithNormalBoomRocketTop ++
   new WithBootROM ++
-  new boom.system.WithRenumberHarts ++
+  new boom.common.WithRenumberHarts ++
   new boom.common.WithRVC ++
   new boom.common.WithLargeBooms ++
   new boom.common.BaseBoomConfig ++
-  new boom.system.WithNBoomCores(2) ++
+  new boom.common.WithNBoomCores(2) ++
   new freechips.rocketchip.subsystem.WithoutTLMonitors ++
   new freechips.rocketchip.subsystem.WithNBigCores(1) ++
   new freechips.rocketchip.system.BaseConfig)
@@ -237,12 +237,12 @@ class DualBoomAndOneHwachaRocketConfig extends Config(
   new WithBootROM ++
   new WithMultiRoCC ++
   new WithMultiRoCCHwacha(0) ++ // put Hwacha just on hart0 which was renumbered to Rocket
-  new boom.system.WithRenumberHarts(rocketFirst = true) ++
+  new boom.common.WithRenumberHarts(rocketFirst = true) ++
   new hwacha.DefaultHwachaConfig ++
   new boom.common.WithRVC ++
   new boom.common.WithLargeBooms ++
   new boom.common.BaseBoomConfig ++
-  new boom.system.WithNBoomCores(2) ++
+  new boom.common.WithNBoomCores(2) ++
   new freechips.rocketchip.subsystem.WithoutTLMonitors ++
   new freechips.rocketchip.subsystem.WithNBigCores(1) ++
   new freechips.rocketchip.system.BaseConfig)
@@ -250,12 +250,12 @@ class DualBoomAndOneHwachaRocketConfig extends Config(
 class RV32BoomAndRocketConfig extends Config(
   new WithNormalBoomRocketTop ++
   new WithBootROM ++
-  new boom.system.WithRenumberHarts ++
+  new boom.common.WithRenumberHarts ++
   new boom.common.WithBoomRV32 ++
   new boom.common.WithRVC ++
   new boom.common.WithLargeBooms ++
   new boom.common.BaseBoomConfig ++
-  new boom.system.WithNBoomCores(1) ++
+  new boom.common.WithNBoomCores(1) ++
   new freechips.rocketchip.subsystem.WithoutTLMonitors ++
   new freechips.rocketchip.subsystem.WithRV32 ++
   new freechips.rocketchip.subsystem.WithNBigCores(1) ++

generators/example/src/main/scala/TestHarness.scala

@@ -8,14 +8,19 @@ import firrtl.transforms.{BlackBoxResourceAnno, BlackBoxSourceHelper}
 import freechips.rocketchip.diplomacy.LazyModule
 import freechips.rocketchip.config.{Field, Parameters}
 import freechips.rocketchip.util.GeneratorApp
+import freechips.rocketchip.devices.debug.{Debug}
 
-// --------------------------
+// -------------------------------
 // BOOM and/or Rocket Test Harness
-// --------------------------
+// -------------------------------
 
 case object BuildBoomRocketTop extends Field[(Clock, Bool, Parameters) => BoomRocketTopModule[BoomRocketTop]]
+case object BuildBoomRocketTopWithDTM extends Field[(Clock, Bool, Parameters) => BoomRocketTopWithDTMModule[BoomRocketTopWithDTM]]
 
-class BoomRocketTestHarness(implicit val p: Parameters) extends Module {
+/**
+ * Test harness using TSI to bringup the system
+ */
+class TestHarness(implicit val p: Parameters) extends Module {
   val io = IO(new Bundle {
     val success = Output(Bool())
   })
@@ -24,6 +29,7 @@ class BoomRocketTestHarness(implicit val p: Parameters) extends Module {
   override def desiredName = "TestHarness"
 
   val dut = p(BuildBoomRocketTop)(clock, reset.toBool, p)
+
   dut.debug := DontCare
   dut.connectSimAXIMem()
   dut.connectSimAXIMMIO()
@@ -41,5 +47,41 @@ class BoomRocketTestHarness(implicit val p: Parameters) extends Module {
         axi.w.bits := DontCare
     }
   })
+
   io.success := dut.connectSimSerial()
 }
+
+/**
+ * Test harness using the Debug Test Module (DTM) to bringup the system
+ */
+class TestHarnessWithDTM(implicit p: Parameters) extends Module
+{
+  val io = IO(new Bundle {
+    val success = Output(Bool())
+  })
+
+  // force Chisel to rename module
+  override def desiredName = "TestHarness"
+
+  val dut = p(BuildBoomRocketTopWithDTM)(clock, reset.toBool, p)
+
+  dut.reset := reset.asBool | dut.debug.ndreset
+  dut.connectSimAXIMem()
+  dut.connectSimAXIMMIO()
+  dut.dontTouchPorts()
+  dut.tieOffInterrupts()
+  dut.l2_frontend_bus_axi4.foreach(axi => {
+    axi.tieoff()
+    experimental.DataMirror.directionOf(axi.ar.ready) match {
+      case core.ActualDirection.Input =>
+        axi.r.bits := DontCare
+        axi.b.bits := DontCare
+      case core.ActualDirection.Output =>
+        axi.aw.bits := DontCare
+        axi.ar.bits := DontCare
+        axi.w.bits := DontCare
+    }
+  })
+
+  Debug.connectDebug(dut.debug, clock, reset.asBool, io.success)
+}

generators/example/src/main/scala/Top.scala

@@ -12,9 +12,9 @@ import testchipip._
 
 import sifive.blocks.devices.gpio._
 
-// -------------------------------
+// ------------------------------------
 // BOOM and/or Rocket Top Level Systems
-// -------------------------------
+// ------------------------------------
 
 class BoomRocketTop(implicit p: Parameters) extends boom.system.BoomRocketSystem
   with HasNoDebug
@@ -67,3 +67,12 @@ class BoomRocketTopWithGPIO(implicit p: Parameters) extends BoomRocketTop
 class BoomRocketTopWithGPIOModule(l: BoomRocketTopWithGPIO)
   extends BoomRocketTopModule(l)
   with HasPeripheryGPIOModuleImp
+
+//---------------------------------------------------------------------------------------------------------
+
+class BoomRocketTopWithDTM(implicit p: Parameters) extends boom.system.BoomRocketSystem
+{
+  override lazy val module = new BoomRocketTopWithDTMModule(this)
+}
+
+class BoomRocketTopWithDTMModule[+L <: BoomRocketTopWithDTM](l: L) extends boom.system.BoomRocketSystemModule(l)

variables.mk

@@ -29,7 +29,7 @@ SUB_PROJECT ?= example
 
 ifeq ($(SUB_PROJECT),example)
 	SBT_PROJECT       ?= example
-	MODEL             ?= BoomRocketTestHarness
+	MODEL             ?= TestHarness
 	VLOG_MODEL        ?= TestHarness
 	MODEL_PACKAGE     ?= $(SBT_PROJECT)
 	CONFIG            ?= DefaultRocketConfig
@@ -38,18 +38,6 @@ ifeq ($(SUB_PROJECT),example)
 	TB                ?= TestDriver
 	TOP               ?= BoomRocketTop
 endif
-# for BOOM developers
-ifeq ($(SUB_PROJECT),boom)
-	SBT_PROJECT       ?= boom
-	MODEL             ?= TestHarness
-	VLOG_MODEL        ?= TestHarness
-	MODEL_PACKAGE     ?= boom.system
-	CONFIG            ?= LargeBoomConfig
-	CONFIG_PACKAGE    ?= boom.system
-	GENERATOR_PACKAGE ?= boom.system
-	TB                ?= TestDriver
-	TOP               ?= BoomRocketSystem
-endif
 # for Rocket-chip developers
 ifeq ($(SUB_PROJECT),rocketchip)
 	SBT_PROJECT       ?= rocketchip