Merge pull request #2284 from ucb-bar/custom_firtool

Allow overriding firtool in PATH with FIRTOOL_BIN flag

Author: jerryz123

common.mk

@@ -195,9 +195,9 @@ else
 endif
 
 $(SFC_MFC_TARGETS) &: $(FIRRTL_FILE) $(FINAL_ANNO_FILE) $(MFC_LOWERING_OPTIONS)
-	$(call require_cmd,firtool)
+	$(call require_cmd,$(FIRTOOL_BIN))
 	rm -rf $(GEN_COLLATERAL_DIR)
-	(set -o pipefail && firtool \
+	(set -o pipefail && $(FIRTOOL_BIN) \
 			--format=fir \
 			--export-module-hierarchy \
 			--verify-each=true \

variables.mk

@@ -9,6 +9,7 @@ HELP_COMPILATION_VARIABLES = \
 "   SBT_OPTS          = set additional sbt command line options (these take the form -Dsbt.<option>=<setting>) " \
 "                       See https://www.scala-sbt.org/1.x/docs/Command-Line-Reference.html\#Command+Line+Options" \
 "   SBT               = if overridden, used to invoke sbt (default is to invoke sbt by sbt-launch.jar)" \
+"   FIRTOOL_BIN       = path to CIRCT firtool (default: 'firtool' in PATH)" \
 
 HELP_PROJECT_VARIABLES = \
 "   SUB_PROJECT            = use the specific subproject default variables [$(SUB_PROJECT)]" \
@@ -180,6 +181,9 @@ ANNO_FILE   ?= $(build_dir)/$(long_name).anno.json
 CHISEL_LOG_FILE ?= $(build_dir)/$(long_name).chisel.log
 FIRTOOL_LOG_FILE ?= $(build_dir)/$(long_name).firtool.log
 
+# Allow users to override the CIRCT FIRRTL compiler binary
+FIRTOOL_BIN ?= firtool
+
 # chisel anno modification output
 MFC_EXTRA_ANNO_FILE ?= $(build_dir)/$(long_name).extrafirtool.anno.json
 FINAL_ANNO_FILE ?= $(build_dir)/$(long_name).appended.anno.json