From 053002b7af7f6a87857216e6c75cec1814a0c672 Mon Sep 17 00:00:00 2001
From: joey0320 <joonho0320@gmail.com>
Date: Fri, 23 Dec 2022 20:05:17 -0800
Subject: [PATCH] Add comments & misc fixes

---
 common.mk | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/common.mk b/common.mk
index 6a916453..c1663ddd 100644
--- a/common.mk
+++ b/common.mk
@@ -146,6 +146,12 @@ FIRTOOL_TARGETS = \
 	$(FIRTOOL_FILELIST) \
 	$(FIRTOOL_BB_MODS_FILELIST)
 
+# If we are using a custom FIRRTL transform to generate LowFIRRTL, we need to use
+# the {top, harness}.mems.conf generated from SFC. Passing the REPL_SEQ_MEM
+# to the SFC will make it replace sequential memories with blackboxes(Macros) &
+# generates ${long_name}.top.mems.conf. Similarly, passing the HARNESS_CONF_FLAGS will
+# notify the SFC to generate ${long_name}.harness.mems.conf. The mems.conf files
+# will be passed to the MacroCompiler to generate verilog outputs of those Macros.
 ifeq (,$(ENABLE_CUSTOM_FIRRTL_PASS))
 	REPL_SEQ_MEM = none
 	TOP_TARGETS = none
@@ -204,7 +210,7 @@ endif
 		--annotation-file $(FINAL_ANNO_FILE) \
 		--log-level $(FIRRTL_LOGLEVEL) \
 		--allow-unrecognized-annotations \
-	  $(REPL_SEQ_MEM) \
+		$(REPL_SEQ_MEM) \
 		$(HARNESS_CONF_FLAGS) \
 		-X $(SFC_LEVEL) \
 		$(EXTRA_FIRRTL_OPTIONS))