#===================================================================
#
# Makefile
# --------
# Makefile for building the modular exponentiation submodules, core
# and top simulations.
#
#
# Author: Joachim Strombergson
# Copyright (c) 2014, NORDUnet A/S
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
# - Redistributions of source code must retain the above copyright notice,
#   this list of conditions and the following disclaimer.
#
# - Redistributions in binary form must reproduce the above copyright
#   notice, this list of conditions and the following disclaimer in the
#   documentation and/or other materials provided with the distribution.
#
# - Neither the name of the NORDUnet nor the names of its contributors may
#   be used to endorse or promote products derived from this software
#   without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#===================================================================

# Tools.
CC = iverilog
CCFLAGS = -Wall
LINT = verilator
LINTFLAGS = --lint-only -Wall

# Sources.
COMMON_SRC = ../src/rtl/adder.v ../src/rtl/shl.v ../src/rtl/shr.v \
	../src/rtl/blockmem1r1w.v ../src/rtl/blockmem2r1w.v \
	../src/rtl/blockmem2r1wptr.v  ../src/rtl/blockmem2rptr1w.v

RESIDUE_TB = ../src/tb/tb_residue.v
RESIDUE_SRC = ../src/rtl/residue.v

MONTPROD_TB = ../src/tb/tb_montprod.v
MONTPROD_SRC = ../src/rtl/montprod.v

MODEXP_SRC=../src/rtl/modexp.v ../src/rtl/modexp_core.v $(MONTPROD_SRC) $(RESIDUE_SRC) $(COMMON_SRC)
MODEXP_TB=../src/tb/tb_modexp.v
MODEXP_AUTOGENERATED_TB = ../src/tb/tb_modexp_autogenerated.v


# Rules.
all: modexp.sim modexp.autogenerated.sim montprod.sim residue.sim


modexp.sim: $(MODEXP_TB) $(MODEXP_SRC)
	$(CC) $(CCFLAGS) -o modexp.sim $(MODEXP_TB) $(MODEXP_SRC)

modexp.autogenerated.sim: $(MODEXP_AUTOGENERATED_TB) $(MODEXP_SRC)
	$(CC) $(CCFLAGS) -o modexp.autogenerated.sim $(MODEXP_AUTOGENERATED_TB) $(MODEXP_SRC)

montprod.sim: $(MONTPROD_TB) $(MONTPROD_SRC) $(COMMON_SRC)
	$(CC) $(CCFLAGS) -o montprod.sim $(MONTPROD_TB) $(MONTPROD_SRC) $(COMMON_SRC)

residue.sim: $(RESIDUE_TB) $(RESIDUE_SRC) $(COMMON_SRC)
	$(CC) $(CCFLAGS) -o residue.sim $(RESIDUE_TB) $(RESIDUE_SRC) $(COMMON_SRC)


sim-modexp: modexp.sim
	./modexp.sim

# run autogenerate-tests manually to renew ../src/tb/tb_montprod_autogenerated.v
sim-modexp-autogenerated: modexp.autogenerated.sim
	./modexp.autogenerated.sim

sim-montprod: montprod.sim
	./montprod.sim


sim-residue: residue.sim
	./residue.sim


lint:
	@echo "Linting of montprod:"
	$(LINT) $(LINTFLAGS) --top-module montprod $(MONTPROD_SRC) $(COMMON_SRC)
	@echo ""

	@echo "Linting of residue:"
	$(LINT) $(LINTFLAGS) --top-module residue $(RESIDUE_SRC) $(COMMON_SRC)
	@echo ""

	@echo "Linting of modexp:"
	$(LINT) $(LINTFLAGS) --top-module modexp $(MODEXP_SRC)
	@echo ""


autogenerate-tests:
	javac -cp ../src/testgenerator/src/ -d ../src/testgenerator/bin/ ../src/testgenerator/src/org/crypttech/modexp/testgenerator/TestGenerator.java
	java -cp ../src/testgenerator/bin/ org.crypttech.modexp.testgenerator.TestGenerator ../src

clean:
	rm -f modexp.sim
	rm -f modexp.autogenerated.sim
	rm -f montprod.sim
	rm -f residue.sim


help:
	@echo "Build system for simulation of modular exponentation core"
	@echo ""
	@echo "Supported targets:"
	@echo "------------------"
	@echo "all:          Build all simulation targets."
	@echo "lint:         Lint all modules and hierarchies."
	@echo "modexp.sim:   Build modexp simulation target."
	@echo "montprod.sim: Build Montgomery product simulation target."
	@echo "residue.sim:  Build Residue calculation simulation target."
	@echo "sim-top:      Run top level simulation."
	@echo "sim-montprod: Run montprod simulation."
	@echo "sim-residue:  Run residue simulation."
	@echo "clean:        Delete all built files."
	@echo ""
	@echo "Supported autogeneration targets:"
	@echo "autogenerate-tests       - rebuild autogenerated tests source code"
	@echo "modexp.autogenerated.sim - run autogenerated test bench"
	@echo "sim-modexp-autogenerated - simulate autogenerated tests"

#===================================================================
# EOF Makefile
#===================================================================