Makefile

################################################################################
##
## Filename:	Makefile
## {{{
## Project:	KIMOS, a Mercury KX2 demonstration project
##
## Purpose:	A master project makefile.  It tries to build all targets
##		within the project, mostly by directing subdirectory makes.
##
## Creator:	Dan Gisselquist, Ph.D.
##		Gisselquist Technology, LLC
##
################################################################################
## }}}
## Copyright (C) 2024, Gisselquist Technology, LLC
## {{{
## This file is part of the KIMOS project.
##
## The KIMOS project is free software and gateware: you can redistribute it
## and/or modify it under the terms of the GNU General Public License as
## published by the Free Software Foundation, either version 3 of the License,
## or (at your option) any later version.
##
## This program is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or
## FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
## for more details.
##
## You should have received a copy of the GNU General Public License along
## with this program.  (It's in the $(ROOT)/doc directory.  Run make with no
## target there if the PDF file isn't present.)  If not, see
## <http://www.gnu.org/licenses/> for a copy.
## }}}
## License:	GPL, v3, as defined and found on www.gnu.org,
## {{{
##		http://www.gnu.org/licenses/gpl.html
##
################################################################################
##
## }}}
.PHONY: all
all:	check-install datestamp autodata sim sw
#
# Defines and directories
## {{{
AUTOD := autodata
SIMD  := sim
#
# Could also depend upon load, if desired, but not necessary
BENCH := # `find bench -name Makefile` `find bench -name "*.cpp"` `find bench -name "*.h"`
SIM   := `find sim -name Makefile` `find sim -name "*.cpp"` `find sim -name "*.h"` `find sim -name "*.c"`
RTL   := `find rtl -name "*.v"` `find rtl -name Makefile`
NOTES := `find . -name "*.txt"` `find . -name "*.html"`
SW    := `find sw -name "*.cpp"` `find sw -name "*.c"`	\
	`find sw -name "*.h"`	`find sw -name "*.sh"`	\
	`find sw -name "*.py"`	`find sw -name "*.pl"`	\
	`find sw -name "*.png"`	`find sw -name Makefile`
DEVSW := `find sw/board -name "*.cpp"` `find sw/board -name "*.h"` \
	`find sw/board -name Makefile`
PROJ  :=
BIN  := # `find xilinx -name "*.bit"`
AUTODATA := `find $(AUTOD) -name "*.txt"` `find $(AUTOD) -name Makefile`
CONSTRAINTS := `find . -name "*.xdc"`
YYMMDD:=`date +%Y%m%d`
SUBMAKE:= $(MAKE) --no-print-directory -C
LOADER:= openFPGALoader
## }}}
##
## Check that we have all the programs available to us that we need
## {{{
#
.PHONY: check-install
check-install: check-perl check-autofpga check-verilator check-zip-gcc check-gpp check-loader

.PHONY: check-perl
	$(call checkif-installed,perl,)

.PHONY: check-autofpga
check-autofpga:
	$(call checkif-installed,autofpga,-V)

.PHONY: check-verilator
check-verilator:
	$(call checkif-installed,verilator,-V)

.PHONY: check-zip-gcc
check-zip-gcc:
	$(call checkif-installed,zip-gcc,-v)

.PHONY: check-gpp
check-gpp:
	$(call checkif-installed,g++,-v)

.PHONY: check-loader
check-loader:
	$(call checkif-installed,openFPGALoader,-V)

## }}}
#
#
# Now that we know that all of our required components exist, we can build
# things
#
#
.PHONY: datestamp
## {{{
# Create a datestamp file, so that we can check for the build-date when the
# project was put together.
#
datestamp: check-perl
	@bash -c 'if [ ! -e $(YYMMDD)-build.v ]; then rm -f 20??????-build.v; perl mkdatev.pl > $(YYMMDD)-build.v; rm -f rtl/builddate.v; fi'
	@bash -c 'if [ ! -e rtl/builddate.v ]; then cd rtl; cp ../$(YYMMDD)-build.v builddate.v; fi'
## }}}

.PHONY: archive
## {{{
#
## Make a tar archive of this file, as a poor mans version of source code
## control. (Sorry ... I've been burned too many times by files I've wiped
## away ...)
#
ARCHIVEFILES := $(BENCH) $(SW) $(RTL) $(SIM) $(NOTES) $(PROJ) $(BIN) $(CONSTRAINTS) $(AUTODATA) README.md
archive:
	tar --transform s,^,$(YYMMDD)-tii/, --exclude=dump.txt --exclude=trace.vcd -chjf $(YYMMDD)-tii.tjz $(ARCHIVEFILES)

## }}}
################################################################################
##
## Auto-FPGA
## {{{
.PHONY: autodata
## Build our main (and toplevel) Verilog files via autofpga
##
autodata: check-autofpga
	$(SUBMAKE) $(AUTOD)
	$(call copyif-changed,$(AUTOD)/toplevel.v,rtl/toplevel.v)
	$(call copyif-changed,$(AUTOD)/main.v,rtl/main.v)
	$(call copyif-changed,$(AUTOD)/iscachable.v,rtl/iscachable.v)
	$(call copyif-changed,$(AUTOD)/build.xdc,rtl/board.xdc)
	$(call copyif-changed,$(AUTOD)/regdefs.h,sw/host/regdefs.h)
	$(call copyif-changed,$(AUTOD)/regdefs.cpp,sw/host/regdefs.cpp)
	$(call copyif-changed,$(AUTOD)/board.h,sw/zlib/board.h)
	$(call copyif-changed,$(AUTOD)/board.h,sw/board/board.h)
	$(call copyif-changed,$(AUTOD)/bkram.ld,sw/board/bkram.ld)
	$(call copyif-changed,$(AUTOD)/board.ld,sw/board/board.ld)
	$(call copyif-changed,$(AUTOD)/sdram.ld,sw/board/sdram.ld)
	$(call copyif-changed,$(AUTOD)/rtl.make.inc,rtl/make.inc)
	$(call copyif-changed,$(AUTOD)/testb.h,$(SIMD)/testb.h)
	$(call copyif-changed,$(AUTOD)/main_tb.cpp,$(SIMD)/main_tb.cpp)

.PHONY: altauto
## Build our main (and toplevel) Verilog files via autofpga
##
altauto: check-autofpga
	$(SUBMAKE) $(AUTOD) lddata
	$(call copyif-changed,$(AUTOD)/toplevel.v,rtl/toplevel.v)
	$(call copyif-changed,$(AUTOD)/main.v,rtl/main.v)
	$(call copyif-changed,$(AUTOD)/iscachable.v,rtl/iscachable.v)
	$(call copyif-changed,$(AUTOD)/build.xdc,rtl/board.xdc)
	$(call copyif-changed,$(AUTOD)/regdefs.h,sw/host/regdefs.h)
	$(call copyif-changed,$(AUTOD)/regdefs.cpp,sw/host/regdefs.cpp)
	$(call copyif-changed,$(AUTOD)/board.h,sw/zlib/board.h)
	$(call copyif-changed,$(AUTOD)/board.h,sw/board/board.h)
	$(call copyif-changed,$(AUTOD)/bkram.ld,sw/board/bkram.ld)
	$(call copyif-changed,$(AUTOD)/board.ld,sw/board/board.ld)
	$(call copyif-changed,$(AUTOD)/rtl.make.inc,rtl/make.inc)
	$(call copyif-changed,$(AUTOD)/testb.h,$(SIMD)/testb.h)
	$(call copyif-changed,$(AUTOD)/main_tb.cpp,$(SIMD)/main_tb.cpp)
## }}}
################################################################################
##
## RTL: Lint RTL, Verilate, build bit file, etc.
## {{{
.PHONY: verilated rtl
#
# Verify that the rtl has no bugs in it, while also creating a Verilator
# simulation class library that we can then use for simulation
#
verilated: datestamp check-verilator
	+@$(SUBMAKE) rtl

.PHONY: rtl
rtl: verilated

.PHONY: bit
bit:
	cd xilinx ; $(MAKE) --no-print-directory xula.bit

## }}}
################################################################################
##
## Simulation target
## {{{
## Build a simulation of this entire design
## (Running it will be part of the test target below)
##
.PHONY: sim
sim: rtl check-gpp
	+@$(SUBMAKE) $(SIMD)
## }}}
################################################################################
##
## Software targets
## {{{
##
## A master target to build all of the support software
##
.PHONY: sw
sw: sw-host sw-zlib sw-board # sw-boot

.PHONY: sw-host
## {{{
##
## Build the host support software
##
sw-host: check-gpp rtl
	+@$(SUBMAKE) sw/host
## }}}

.PHONY: sw-zlib
## {{{
##
## Build the hardware specific newlib library
##
sw-zlib: check-zip-gcc rtl
	+@$(SUBMAKE) sw/zlib
## }}}

.PHONY: sw-fatfs
## {{{
sw-fatfs: check-zip-gcc rtl
	+@$(SUBMAKE) sw/fatfs
## }}}

.PHONY: sw-board
## {{{
## Build the board software.  This may (or may not) use the software library
##
sw-board: sw-zlib sw-fatfs check-zip-gcc rtl
	+@$(SUBMAKE) sw/board
## }}}

.PHONY: sw-boot
## {{{
##
## Build the boot software.  This would allow us to boot from an SD card,
## however ... this project doesn't currently use it.
##
## sw-boot: check-zip-gcc sw-zlib
##	+@$(SUBMAKE) sw/boot
## }}}
## }}}
################################################################################
##
## Test targets
## {{{
.PHONY: test

#
# Run "Hello World", and ... see if this all works
#
#.PHONY: hello
#hello: sim sw
#	$(SIMD)/main_tb sw/board/hello

# .PHONY: sdtest
# sdtest: sim sw
#	$(SIMD)/main_tb sw/board/sdtest

#test: hello
## }}}
################################################################################
##
## Load the device
## {{{
## BITFILE := blinky.bit
BITFILE := kimos.bit
$(BITFILE): ../xilinx/kimos.runs/impl_1/toplevel.bit
	@cp $< $@

.PHONY: load
load: $(BITFILE)
	$(LOADER) --freq 3750000 --ftdi-serial FTENC $(BITFILE)
## }}}
################################################################################
##
## Macro definitions
## {{{

# copyif-changed
## {{{
##
## Copy a file from the auto-data directory that had been created by
## autofpga, into the directory structure where it might be used.
##
define	copyif-changed
	@bash -c 'cmp $(1) $(2); if [[ $$? != 0 ]]; then echo "Copying $(1) to $(2)"; cp $(1) $(2); fi'
endef
## }}}

# checkif-installed
## {{{
##
## Check if the given program is installed
##
define	checkif-installed
	@bash -c '$(1) $(2) < /dev/null >& /dev/null; if [[ $$? != 0 ]]; then echo "Program not found: $(1)"; exit -1; fi'
endef
## }}}
## }}}
################################################################################
##
.PHONY: clean
## {{{
clean:
	+$(SUBMAKE) $(AUTOD)	clean
	+$(SUBMAKE) $(SIMD)	clean
	+$(SUBMAKE) rtl		clean
	+$(SUBMAKE) sw/zlib	clean
	+$(SUBMAKE) sw/board	clean
	+$(SUBMAKE) sw/host	clean
## }}}