From 8ab05293548a447ec87578df767ce5062432d665 Mon Sep 17 00:00:00 2001
From: Hansung Kim <hansung_kim@berkeley.edu>
Date: Mon, 16 Oct 2023 17:54:12 -0700
Subject: [PATCH] Move VortexBundleA/D to Core; resolve TODOs

---
 src/main/scala/rocket/VortexCore.scala | 18 +++++++++++++++++-
 src/main/scala/tile/VortexTile.scala   | 26 ++------------------------
 2 files changed, 19 insertions(+), 25 deletions(-)

diff --git a/src/main/scala/rocket/VortexCore.scala b/src/main/scala/rocket/VortexCore.scala
index 983d0f8..8bb0b62 100644
--- a/src/main/scala/rocket/VortexCore.scala
+++ b/src/main/scala/rocket/VortexCore.scala
@@ -8,7 +8,23 @@ import chisel3.util._
 import chisel3.experimental._
 import org.chipsalliance.cde.config.Parameters
 import freechips.rocketchip.tile._
-import tile.{VortexTile, VortexBundleA, VortexBundleD}
+import tile.VortexTile
+
+class VortexBundleA extends Bundle {
+  val opcode = UInt(3.W) // FIXME: hardcoded
+  val size = UInt(4.W) // FIXME: hardcoded
+  val source = UInt(10.W) // FIXME: hardcoded
+  val address = UInt(32.W) // FIXME: hardcoded
+  val mask = UInt(4.W) // FIXME: hardcoded
+  val data = UInt(32.W) // FIXME: hardcoded
+}
+
+class VortexBundleD extends Bundle {
+  val opcode = UInt(3.W) // FIXME: hardcoded
+  val size = UInt(4.W) // FIXME: hardcoded
+  val source = UInt(10.W) // FIXME: hardcoded
+  val data = UInt(32.W) // FIXME: hardcoded
+}
 
 class VortexBundle(tile: VortexTile)(implicit p: Parameters) extends CoreBundle {
   val clock = Input(Clock())
diff --git a/src/main/scala/tile/VortexTile.scala b/src/main/scala/tile/VortexTile.scala
index a7bec4f..23cd4ca 100644
--- a/src/main/scala/tile/VortexTile.scala
+++ b/src/main/scala/tile/VortexTile.scala
@@ -16,7 +16,7 @@ import freechips.rocketchip.util._
 import freechips.rocketchip.prci.ClockSinkParameters
 import freechips.rocketchip.regmapper.RegField
 import freechips.rocketchip.tile._
-import rocket.Vortex
+import rocket.{Vortex, VortexBundleA, VortexBundleD}
 
 case class RocketTileBoundaryBufferParams(force: Boolean = false)
 
@@ -44,22 +44,6 @@ case class VortexTileParams(
   }
 }
 
-class VortexBundleA extends Bundle {
-  val opcode = UInt(3.W) // FIXME: hardcoded
-  val size = UInt(4.W) // FIXME: hardcoded
-  val source = UInt(10.W) // FIXME: hardcoded
-  val address = UInt(32.W) // FIXME: hardcoded
-  val mask = UInt(4.W) // FIXME: hardcoded
-  val data = UInt(32.W) // FIXME: hardcoded
-}
-
-class VortexBundleD extends Bundle {
-  val opcode = UInt(3.W) // FIXME: hardcoded
-  val size = UInt(4.W) // FIXME: hardcoded
-  val source = UInt(10.W) // FIXME: hardcoded
-  val data = UInt(32.W) // FIXME: hardcoded
-}
-
 class VortexTile private (
     val vortexParams: VortexTileParams,
     crossing: ClockCrossingType,
@@ -106,7 +90,7 @@ class VortexTile private (
     beatBytes = lazyCoreParamsView.coreDataBytes,
     minLatency = 1)))*/
 
-  val numLanes = 4 // FIXME: hardcoded
+  val numLanes = 4 // TODO: use Parameters for this
   val sourceWidth = 1 // TODO: use Parameters for this
 
   val imemNodes = Seq.tabulate(1) { i =>
@@ -375,9 +359,6 @@ class VortexTileModuleImp(outer: VortexTile) extends BaseTileModuleImp(outer) {
   // dcacheArb.io.requestor <> dcachePorts.toSeq
 }
 
-// TODO: Currently in/out are assumed to be the same TL bundle with the same
-// sourceWidth; this needs to be more flexible.
-//
 // Some @copypaste from CoalescerSourceGen.
 class VortexTLAdapter(
   newSourceWidth: Int,
@@ -388,7 +369,6 @@ class VortexTLAdapter(
 ) extends Module {
   val io = IO(new Bundle {
     // in/out means upstream/downstream
-    // TODO: change inReq/inResp to VortexBundle
     val inReq = Flipped(Decoupled(inReqT))
     val outReq = Decoupled(outReqT)
     val inResp = Decoupled(inRespT)
@@ -427,8 +407,6 @@ class VortexTLAdapter(
   // "man-in-the-middle"
   io.inReq.ready := io.outReq.ready && sourceGen.io.id.valid
   io.outReq.valid := io.inReq.valid && sourceGen.io.id.valid
-  // FIXME: Fill is a hack; just change downstream to the right sourceWidth
-  // io.outReq.bits.source := Fill(newSourceWidth, sourceGen.io.id.bits)
   io.outReq.bits.source := sourceGen.io.id.bits
   // translate upstream response back to its old sourceId
   io.inResp.bits.source := sourceGen.io.peek