Added coherence tile function defs, with traits and constants

rocket/src/main/scala/coherence.scala

@@ -0,0 +1,128 @@
+package Top {
+
+import Chisel._
+import Constants._
+
+class TransactionInit extends Bundle {
+  val ttype = Bits(width = 2)
+  val tileTransactionID = Bits(width = TILE_XACT_ID_BITS)
+  val address = Bits(width = PADDR_BITS)
+  val data = Bits(width = MEM_DATA_BITS)
+}
+
+class TransactionAbort extends Bundle {
+  val tileTransactionID = Bits(width = TILE_XACT_ID_BITS)
+}
+
+class ProbeRequest extends Bundle {
+  val ptype = Bits(width = 2)
+  val globalTransactionID = Bits(width = GLOBAL_XACT_ID_BITS)
+  val address = Bits(width = PADDR_BITS)
+}
+
+class ProbeReply extends Bundle {
+  val ptype = Bits(width = 2)
+  val hasData = Bool()
+  val globalTransactionID = Bits(width = GLOBAL_XACT_ID_BITS)
+  val data = Bits(width = MEM_DATA_BITS)
+}
+
+class TransactionReply extends Bundle {
+  val ttype = Bits(width = 2)
+  val tileTransactionID = Bits(width = TILE_XACT_ID_BITS)
+  val globalTransactionID = Bits(width = GLOBAL_XACT_ID_BITS)
+  val data = Bits(width = MEM_DATA_BITS)
+}
+
+class TransactionFinish extends Bundle {
+  val globalTransactionID = Bits(width = GLOBAL_XACT_ID_BITS)
+}
+
+class ioTileLink extends Bundle { 
+  val xact_init   = new TransactionInit().asOutput
+  val xact_abort  = new TransactionAbort().asInput
+  val probe_req   = new ProbeRequest().asInput
+  val probe_rep   = new ProbeReply().asOutput
+  val xact_rep    = new TransactionReply().asInput
+  val xact_finish = new TransactionFinish().asOutput
+}
+
+trait ThreeStateIncoherence {
+  val tileInvalid :: tileClean :: tileDirty :: Nil = Enum(3){ UFix() }
+
+  def cpuCmdToRW( cmd: Bits): (Bool, Bool) = {
+    val store   = (cmd === M_XWR)
+    val load    = (cmd === M_XRD)
+    val amo     = cmd(3).toBool
+    val read    = load  || amo || (cmd === M_PFR)
+    val write   = store || amo || (cmd === M_PFW)
+    (read, write)
+  }
+
+  def isHit ( cmd: Bits, state: UFix): Bool = {
+    val (read, write) = cpuCmdToRW(cmd)
+    ( state === tileClean || state === tileDirty)
+  }
+
+  def isValid (state: UFix): Bool = {
+    state != tileInvalid
+  }
+
+  def needsWriteback (state: UFix): Bool = {
+    state === tileDirty
+  }
+
+  def newStateOnWriteback() = tileInvalid
+  def newStateOnFlush() = tileInvalid
+  def newState(cmd: Bits, state: UFix): UFix = {
+    val (read, write) = cpuCmdToRW(cmd)
+    Mux(write, tileDirty, Mux(read, Mux(state === tileDirty, tileDirty, tileClean), tileInvalid))
+  }
+  def newStateOnHit(cmd: Bits, state: UFix): UFix = newState(cmd, state)
+  def newStateOnPrimaryMiss(cmd: Bits): UFix = newState(cmd, tileInvalid)
+  def newStateOnSecondaryMiss(cmd: Bits, state: UFix): UFix = {
+    val (read, write) = cpuCmdToRW(cmd)
+    Mux(write, tileDirty, state)
+  }
+
+}
+
+trait FourStateCoherence {
+
+  val tileInvalid :: tileShared :: tileExclusiveClean :: tileExclusiveDirty :: Nil = Enum(4){ UFix() }
+  val globalInvalid :: globalShared :: globalExclusiveClean :: Nil = Enum(3){ UFix() }
+  val probeInvalidate :: probeDowngrade :: probeCopy :: Nil = Enum(3){ UFix() }
+
+  def isHit ( cmd: Bits, state: UFix): Bool = {
+    val is_hit = Bool(false)
+    switch(cmd) {
+      is(M_XRD) {
+        is_hit := state === tileShared || 
+                  state === tileExclusiveClean ||
+                  state === tileExclusiveDirty
+      }
+      is(M_XWR) {
+        is_hit := state === tileExclusiveClean ||
+                  state === tileExclusiveDirty
+      }
+    }
+    is_hit
+  }
+
+  def needsWriteback (state: UFix): Bool = {
+    state === tileExclusiveDirty
+  }
+
+  def needsSecondaryXact (cmd: Bits, outstanding: TransactionInit): Bool
+
+  def getMetaUpdateOnProbe (incoming: ProbeRequest): Bits = {
+    val state = UFix(0)
+    switch(incoming.ptype) {
+      is(probeInvalidate) { state := tileInvalid }
+      is(probeDowngrade) { state := tileShared }
+    }
+    state.toBits
+  }
+}
+
+}

rocket/src/main/scala/consts.scala

@@ -160,7 +160,7 @@ object Constants
   val ASID_BITS = 7;
   val PERM_BITS = 6;
 
-  // rocketNBDCacheDM parameters
+  // rocketNBDCache parameters
   val CPU_DATA_BITS = 64;
   val CPU_TAG_BITS = 9;
   val DCACHE_TAG_BITS = 1 + CPU_TAG_BITS;
@@ -174,6 +174,10 @@ object Constants
   val NWAYS = 1;
   require(IDX_BITS+OFFSET_BITS <= PGIDX_BITS);
 
+  // coherence parameters
+  val TILE_XACT_ID_BITS = 1; // log2(NMSHR)
+  val GLOBAL_XACT_ID_BITS = IDX_BITS; // if one active xact per set
+
   // external memory interface
   val IMEM_TAG_BITS = 1;
   val DMEM_TAG_BITS = ceil(log(NMSHR)/log(2)).toInt;