Makefile

TESTS = $(shell find tests -maxdepth 2 -name Makefile.in | cut -d\/ -f2 | sort -u)
TEST ?= tests/onenet

root_dir:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))

SURELOG_BIN = ${root_dir}/../image/bin/surelog
YOSYS_BIN = ${root_dir}/../image/bin/yosys
VERILATOR_BIN = ${root_dir}/../image/bin/verilator
VCDDIFF_BIN = ${root_dir}/../image/bin/vcddiff
COVARAGE_REPORT = ${root_dir}/build/coverage

TEST_DIR := $(realpath $(root_dir)/$(TEST))
MAIN_FILE ?= $(TEST_DIR)/main.cpp
YOSYS_TCL := $(TEST_DIR)/yosys_script.tcl
PARSER ?= surelog

# this include should set $(TOP_FILE) and $(TOP_MODULE) variables
include $(TEST)/Makefile.in

# this variables use $(TOP_MODULE) that is set in included Makefile.in
VERILATED_BIN := V$(TOP_MODULE)
TOP_UHDM = ${root_dir}/build/$(TOP_MODULE).uhdm
TOP_MAKEFILE := V$(TOP_MODULE).mk
# SURELOG_FLAGS are empty by default, unless set in Makefile.in

list:
	@echo "Available tests:"
	@for TEST in $(TESTS); do echo "- tests/$$TEST"; done
	@echo "Please specify the TEST variable."

# ------------ Test targets ------------

uhdm/vcddiff: $(root_dir)/dumps/dump_yosys.vcd $(root_dir)/dumps/dump_verilator.vcd
	$(VCDDIFF_BIN) $(root_dir)/dumps/dump_yosys.vcd $(root_dir)/dumps/dump_verilator.vcd | tee vcddiff_output.txt
	@(! grep differs vcddiff_output.txt)

uhdm/verilator/test-ast: surelog/parse
	mkdir -p $(root_dir)/dumps
	(cd $(root_dir)/build && \
		$(VERILATOR_BIN) --uhdm-ast-sv \
			--cc $(TOP_UHDM) \
			$(VERILATOR_FLAGS) \
			--top-module ${TOP_MODULE} \
			--dump-uhdm \
			--exe $(MAIN_FILE) --trace && \
		 make -j -C obj_dir -f $(TOP_MAKEFILE) $(VERILATED_BIN) && \
		 obj_dir/$(VERILATED_BIN) $(VERILATED_FLAGS))
	mv $(root_dir)/build/dump.vcd $(root_dir)/dumps/dump_verilator.vcd

uhdm/verilator/test-cmake: surelog/parse
	(cd $(root_dir)/build && \
		cmake -S ../$(TEST) -B . && \
		make $(VERILATED_BIN) VERBOSE=1 && \
		./$(VERILATED_BIN))

ifeq ($(PARSER),surelog)
uhdm/yosys/test-ast: clean-build surelog/parse
else
uhdm/yosys/test-ast: clean-build
endif
	(export TOP_FILE="${TOP_FILE}" TOP_MODULE="${TOP_MODULE}" PARSER=${PARSER} SURELOG_FLAGS="${SURELOG_FLAGS}" && \
	cd $(root_dir)/build && ${YOSYS_BIN} -c $(YOSYS_TCL))

# ------------ Test helper targets ------------

surelog/parse: clean-build
	(cd ${root_dir}/build && \
		${SURELOG_BIN} -parse -sverilog -d coveruhdm -elabuhdm ${SURELOG_FLAGS} $(INCLUDE) $(TOP_FILE))
	cp ${root_dir}/build/slpp_all/surelog.uhdm ${TOP_UHDM}

uhdm/yosys/verilate-ast:
	mkdir -p ${root_dir}/dumps
	(cd $(root_dir)/build && \
		$(VERILATOR_BIN) --cc ./yosys.sv \
			$(VERILATOR_FLAGS) \
			--top-module \$(TOP_MODULE) \
			--exe $(MAIN_FILE) --trace && \
		 make -j -C obj_dir -f $(TOP_MAKEFILE) $(VERILATED_BIN) && \
		 obj_dir/$(VERILATED_BIN))
	mv $(root_dir)/build/dump.vcd $(root_dir)/dumps/dump_yosys.vcd

# ------------ Coverage targets ------------

uhdm/verilator/coverage: surelog/parse
	(cd $(root_dir)/build && \
		$(VERILATOR_BIN) --uhdm-ast --cc $(TOP_UHDM) \
			$(VERILATOR_FLAGS) \
			--uhdm-cov uhdm.cov \
			--xml-only)
	python3 gen_coverage_report.py --verilator-uhdm $(root_dir)/build/uhdm.cov \
		--output-file $(root_dir)/build/coverage.out

uhdm/yosys/coverage: surelog/parse
	(cd ${root_dir}/build && ${YOSYS_BIN} -p "read_uhdm -report ${COVARAGE_REPORT} ${TOP_UHDM}")

# ------------ Clean targets ------------

clean-build:
	rm -rf $(root_dir)/build
	mkdir -p $(root_dir)/build

clean:: clean-build

# ------------ Other targets ------------

surelog/parse-earlgrey: clean-build
	(cd ${root_dir}/Surelog/third_party/tests/Earlgrey_0_1/sim-icarus && \
		${SURELOG_BIN} -f Earlgrey_0_1.sl \
	)
	cp ${root_dir}/Surelog/third_party/tests/Earlgrey_0_1/sim-icarus/slpp_all/surelog.uhdm ${TOP_UHDM}

surelog/ibex-verilator: clean-build
	(cd ${root_dir}/Surelog/third_party/tests/Earlgrey_Verilator_0_1/sim-verilator && \
		${SURELOG_BIN} -f Earlgrey_Verilator_0_1.sl)
	cp ${root_dir}/Surelog/third_party/tests/Earlgrey_Verilator_0_1/sim-verilator/slpp_all/surelog.uhdm ${TOP_UHDM}

surelog/ibex-simplesystem: clean-build
	(cd ${root_dir}/tests/ibex/ibex/build/lowrisc_ibex_ibex_simple_system_0/sim-verilator && \
		${SURELOG_BIN} +define+VERILATOR \
			-f lowrisc_ibex_ibex_simple_system_0.vc \
			-parse -d coveruhdm -verbose)
	cp ${root_dir}/tests/ibex/ibex/build/lowrisc_ibex_ibex_simple_system_0/sim-verilator/slpp_all/surelog.uhdm ${TOP_UHDM}

uhdm/verilator/get-ast: clean-build
	(cd $(root_dir)/build && \
		$(VERILATOR_BIN) --cc $(TOP_FILE) \
			$(INCLUDE) \
			$(VERILATOR_FLAGS) \
			--top-module ${TOP_MODULE} \
			--exe $(MAIN_FILE) --debug --xml-only)

uhdm/verilator/ast-xml: surelog/parse
	(cd $(root_dir)/build && \
		$(VERILATOR_BIN) --uhdm-ast-sv --cc $(TOP_UHDM) \
			$(VERILATOR_FLAGS) \
			--top-module ${TOP_MODULE} \
			--dump-uhdm \
			--debugi 6 \
			--exe $(MAIN_FILE) --xml-only)

verilator/test-ast: clean-build
	mkdir -p $(root_dir)/dumps
	(cd $(root_dir)/build && \
		$(VERILATOR_BIN) \
			$(INCLUDE) \
			--cc $(TOP_FILE) \
			$(VERILATOR_FLAGS) \
			--top-module ${TOP_MODULE} \
			--exe $(MAIN_FILE) --trace && \
		 make -j -C obj_dir -f $(TOP_MAKEFILE) $(VERILATED_BIN) && \
		 obj_dir/$(VERILATED_BIN) $(VERILATED_FLAGS))
	mv $(root_dir)/build/dump.vcd $(root_dir)/dumps/dump_vanilla.vcd

uhdm/verilator/vcddiff: verilator/test-ast uhdm/verilator/test-ast
	$(VCDDIFF_BIN) $(root_dir)/dumps/dump_vanilla.vcd $(root_dir)/dumps/dump_verilator.vcd

vcd:
	gtkwave $(root_dir)/build/dump.vcd &>/dev/null &