From f7d53b12ad0d9ed652ead5dce77bc9e073c23632 Mon Sep 17 00:00:00 2001
From: Sina Karvandi <sina@hyperdbg.org>
Date: Sun, 14 Apr 2024 23:51:55 +0900
Subject: [PATCH] initialize register from memory

---
 src/main/scala/hwdbg/configs/configs.scala    |  2 +-
 ...ent.scala => init_reg_mem_from_file.scala} | 44 +++++++++++++------
 src/main/scala/top_test.scala                 |  2 +-
 3 files changed, 32 insertions(+), 16 deletions(-)
 rename src/main/scala/hwdbg/libs/mem/{init_mem_content.scala => init_reg_mem_from_file.scala} (73%)

diff --git a/src/main/scala/hwdbg/configs/configs.scala b/src/main/scala/hwdbg/configs/configs.scala
index 6c0fec1..2d36bcc 100644
--- a/src/main/scala/hwdbg/configs/configs.scala
+++ b/src/main/scala/hwdbg/configs/configs.scala
@@ -66,5 +66,5 @@ object GeneralConfigurations {
 object TestingConfigurations {
 
   val BRAM_INITIALIZATION_FILE_PATH: String =
-    "/home/sina/HyperDbg/hwdbg/src/resources/8kb_BRAM.hex.txt"
+    "./src/resources/8kb_BRAM.hex.txt"
 }
diff --git a/src/main/scala/hwdbg/libs/mem/init_mem_content.scala b/src/main/scala/hwdbg/libs/mem/init_reg_mem_from_file.scala
similarity index 73%
rename from src/main/scala/hwdbg/libs/mem/init_mem_content.scala
rename to src/main/scala/hwdbg/libs/mem/init_reg_mem_from_file.scala
index 0d83b13..59bcfd2 100644
--- a/src/main/scala/hwdbg/libs/mem/init_mem_content.scala
+++ b/src/main/scala/hwdbg/libs/mem/init_reg_mem_from_file.scala
@@ -1,9 +1,9 @@
 /** @file
-  *   init_mem_content.scala
+  *   init_reg_mem_from_file.scala
   * @author
   *   Sina Karvandi (sina@hyperdbg.org)
   * @brief
-  *   Initialize SRAM memory from a file (directly from the content of file)
+  *   Initialize registers from a file
   * @details
   * @version 0.1
   * @date
@@ -19,23 +19,37 @@ import scala.io.Source
 
 import chisel3._
 
+import hwdbg.utils._
 import hwdbg.configs._
 
-object Tools {
-  def readmemh(path: String, width: Int): Seq[UInt] = {
+object InitRegMemFromFileTools {
+  def readmemh(
+      debug: Boolean = DebuggerConfigurations.ENABLE_DEBUG,
+      path: String,
+      width: Int
+  ): Seq[UInt] = {
+
     val buffer = new ArrayBuffer[UInt]
     for (line <- Source.fromFile(path).getLines()) {
       val tokens: Array[String] = line.split("(//)").map(_.trim)
       if (tokens.nonEmpty && tokens.head != "") {
+
         val i = Integer.parseInt(tokens.head, 16)
+
+        LogInfo(debug)(
+          f"Initialize memory with 0x${i}%x"
+        )
+
         buffer.append(i.U(width.W))
       }
     }
+
     buffer.toSeq
+
   }
 }
 
-class InitMemContent(
+class InitRegMemFromFile(
     debug: Boolean = DebuggerConfigurations.ENABLE_DEBUG,
     memoryFile: String = TestingConfigurations.BRAM_INITIALIZATION_FILE_PATH,
     addrWidth: Int = DebuggerConfigurations.BLOCK_RAM_ADDR_WIDTH,
@@ -52,7 +66,9 @@ class InitMemContent(
     val dataOut = Output(UInt(width.W))
   })
 
-  val mem = RegInit(VecInit(Tools.readmemh(memoryFile, width)))
+  val mem = RegInit(
+    VecInit(InitRegMemFromFileTools.readmemh(debug, memoryFile, width))
+  )
 
   when(io.enable) {
     val rdwrPort = mem(io.addr)
@@ -66,7 +82,7 @@ class InitMemContent(
   }
 }
 
-object InitMemContent {
+object InitRegMemFromFile {
 
   def apply(
       debug: Boolean = DebuggerConfigurations.ENABLE_DEBUG,
@@ -82,8 +98,8 @@ object InitMemContent {
       dataIn: UInt
   ): UInt = {
 
-    val initMemContentModule = Module(
-      new InitMemContent(
+    val initRegMemFromFileModule = Module(
+      new InitRegMemFromFile(
         debug,
         memoryFile,
         addrWidth,
@@ -97,15 +113,15 @@ object InitMemContent {
     //
     // Configure the input signals
     //
-    initMemContentModule.io.enable := enable
-    initMemContentModule.io.write := write
-    initMemContentModule.io.addr := addr
-    initMemContentModule.io.dataIn := dataIn
+    initRegMemFromFileModule.io.enable := enable
+    initRegMemFromFileModule.io.write := write
+    initRegMemFromFileModule.io.addr := addr
+    initRegMemFromFileModule.io.dataIn := dataIn
 
     //
     // Configure the output signals
     //
-    dataOut := initMemContentModule.io.dataOut
+    dataOut := initRegMemFromFileModule.io.dataOut
 
     //
     // Return the output result
diff --git a/src/main/scala/top_test.scala b/src/main/scala/top_test.scala
index 661accf..8a852d7 100644
--- a/src/main/scala/top_test.scala
+++ b/src/main/scala/top_test.scala
@@ -64,7 +64,7 @@ class DebuggerModuleTestingBRAM(
   // Instantiate the BRAM memory initializer module
   //
   val dataOut =
-    InitMemContent(
+    InitRegMemFromFile(
       debug,
       TestingConfigurations.BRAM_INITIALIZATION_FILE_PATH,
       bramAddrWidth,