From 9a381e88d103f855375131be8c07fc22e9b6bb89 Mon Sep 17 00:00:00 2001
From: mwachs5 <megan@sifive.com>
Date: Fri, 30 Sep 2016 16:19:25 -0700
Subject: [PATCH] Suggest sane names for common objects (#369)

* Suggest sane names for common objects frequently instantiated with factory methods

* Suggest names for common primitives using more Scala-esque Options
---
 .../uncore/tilelink2/RegisterCrossing.scala   |  4 ++++
 src/main/scala/util/BlackBoxRegs.scala        | 24 ++++++++++++++-----
 2 files changed, 22 insertions(+), 6 deletions(-)

diff --git a/src/main/scala/uncore/tilelink2/RegisterCrossing.scala b/src/main/scala/uncore/tilelink2/RegisterCrossing.scala
index 01046dbc..b908baf4 100644
--- a/src/main/scala/uncore/tilelink2/RegisterCrossing.scala
+++ b/src/main/scala/uncore/tilelink2/RegisterCrossing.scala
@@ -147,15 +147,18 @@ object AsyncRWSlaveRegField {
     slave_reset: Bool,
     width:  Int,
     init: Int,
+    name: Option[String] = None,
     master_allow: Bool = Bool(true),
     slave_allow: Bool = Bool(true)
   ): (UInt, RegField) = {
 
     val async_slave_reg = Module(new AsyncResetRegVec(width, init))
+    name.foreach(async_slave_reg.suggestName(_))
     async_slave_reg.reset := slave_reset
     async_slave_reg.clock := slave_clock
 
     val wr_crossing = Module (new RegisterWriteCrossing(UInt(width = width)))
+    name.foreach(n => wr_crossing.suggestName(s"${n}_wcrossing"))
 
     val scope = Module (new AsyncScope())
 
@@ -170,6 +173,7 @@ object AsyncRWSlaveRegField {
     async_slave_reg.io.d  := wr_crossing.io.slave_register
 
     val rd_crossing = Module (new RegisterReadCrossing(UInt(width = width )))
+    name.foreach(n => rd_crossing.suggestName(s"${n}_rcrossing"))
 
     rd_crossing.io.master_clock := scope.clock
     rd_crossing.io.master_reset := scope.reset
diff --git a/src/main/scala/util/BlackBoxRegs.scala b/src/main/scala/util/BlackBoxRegs.scala
index 9424084e..0d114892 100644
--- a/src/main/scala/util/BlackBoxRegs.scala
+++ b/src/main/scala/util/BlackBoxRegs.scala
@@ -59,8 +59,6 @@ class AsyncResetRegVec(val w: Int, val init: BigInt) extends Module {
 
   val io = new SimpleRegIO(w)
 
-  val bb_d = Mux(io.en, io.d, io.q)
-
   val async_regs: List[AbstractBBReg] = List.tabulate(w)(
     i => Module (
       if (((init >> i) % 2) > 0)
@@ -74,14 +72,17 @@ class AsyncResetRegVec(val w: Int, val init: BigInt) extends Module {
   for ((reg, idx) <- async_regs.zipWithIndex) {
     reg.io.clk := clock
     reg.io.rst := reset
-    reg.io.d   := bb_d(idx)
+    reg.io.d   := io.d(idx)
     reg.io.en  := io.en
+    reg.suggestName(s"reg_$idx")
   }
 
 }
 
 object AsyncResetReg {
-  def apply(d: Bool, clk: Clock, rst: Bool, init: Boolean): Bool = {
+
+  // Create Single Registers
+  def apply(d: Bool, clk: Clock, rst: Bool, init: Boolean, name: Option[String]): Bool = {
     val reg: AbstractBBReg =
       if (init) Module (new AsyncSetReg)
       else Module(new AsyncResetReg)
@@ -89,22 +90,33 @@ object AsyncResetReg {
     reg.io.clk := clk
     reg.io.rst := rst
     reg.io.en  := Bool(true)
+    name.foreach(reg.suggestName(_))
     reg.io.q
   }
 
-  def apply(d: Bool, clk: Clock, rst: Bool): Bool = apply(d, clk, rst, false)
+  def apply(d: Bool, clk: Clock, rst: Bool): Bool = apply(d, clk, rst, false, None)
+  def apply(d: Bool, clk: Clock, rst: Bool, name: String): Bool = apply(d, clk, rst, false, Some(name))
 
-  def apply(updateData: UInt, resetData: BigInt, enable: Bool): UInt = {
+  // Create Vectors of Registers
+  def apply(updateData: UInt, resetData: BigInt, enable: Bool, name: Option[String] = None): UInt = {
     val w = updateData.getWidth max resetData.bitLength
     val reg = Module(new AsyncResetRegVec(w, resetData))
+    name.foreach(reg.suggestName(_))
     reg.io.d := updateData
     reg.io.en := enable
     reg.io.q
   }
+  def apply(updateData: UInt, resetData: BigInt, enable: Bool, name: String): UInt = apply(updateData,
+    resetData, enable, Some(name))
+
 
   def apply(updateData: UInt, resetData: BigInt): UInt = apply(updateData, resetData, enable=Bool(true))
+  def apply(updateData: UInt, resetData: BigInt, name: String): UInt = apply(updateData, resetData, enable=Bool(true), Some(name))
 
   def apply(updateData: UInt, enable: Bool): UInt = apply(updateData, resetData=BigInt(0), enable)
+  def apply(updateData: UInt, enable: Bool, name: String): UInt = apply(updateData, resetData=BigInt(0), enable, Some(name))
 
   def apply(updateData: UInt): UInt = apply(updateData, resetData=BigInt(0), enable=Bool(true))
+  def apply(updateData: UInt, name:String): UInt = apply(updateData, resetData=BigInt(0), enable=Bool(true), Some(name))
+
 }