Makefile

#####################################################################################################################################################################################################################################################################################
#  _____ ____  __  __ __  __  ____  _   _
# / ____/ __ \|  \/  |  \/  |/ __ \| \ | |
#| |   | |  | | \  / | \  / | |  | |  \| |
#| |   | |  | | |\/| | |\/| | |  | | . ` |
#| |___| |__| | |  | | |  | | |__| | |\  |
# \_____\____/|_|  |_|_|  |_|\____/|_| \_|
#

# number of processors to use for build
UNAME := $(shell uname)
ifeq ($(UNAME), Linux)
NPROC = $(shell nproc)
else ifeq ($(UNAME), Darwin)
NPROC = $(shell sysctl -n hw.physicalcpu)
endif

# Common CMake setup args
INSTALL_PREFIX :=
CMAKE_COMMON_ARGS := -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_STANDARD=17 -DCMAKE_POSITION_INDEPENDENT_CODE=ON
ifdef INSTALL_PREFIX
    CMAKE_COMMON_ARGS := $(CMAKE_COMMON_ARGS) -DCMAKE_INSTALL_PREFIX=$(INSTALL_PREFIX)
endif

# use ccache if available
CCACHE := $(shell which ccache 2> /dev/null)
ifdef CCACHE
    CMAKE_COMMON_ARGS := $(CMAKE_COMMON_ARGS) -DCMAKE_CXX_COMPILER_LAUNCHER=$(shell which ccache)
endif
CMAKE_COMMON_ARGS_SHARED := -B build_shared $(CMAKE_COMMON_ARGS) -DBUILD_SHARED_LIBS=ON -DBUILD_TESTING=OFF
CMAKE_COMMON_ARGS_STATIC := -B build_static $(CMAKE_COMMON_ARGS) -DBUILD_SHARED_LIBS=OFF -DBUILD_TESTING=OFF

# Common CMake build args
CMAKE_BUILD_ARGS := -- -j $(NPROC)
CMAKE_BUILD_ARGS_SHARED := --build build_shared $(CMAKE_BUILD_ARGS)
CMAKE_BUILD_ARGS_STATIC := --build build_static $(CMAKE_BUILD_ARGS)

# Common CMake install args
CMAKE_INSTALL_ARGS :=
ifdef INSTALL_PREFIX
	CMAKE_INSTALL_ARGS := --prefix $(INSTALL_PREFIX)
endif

CMAKE_INSTALL_ARGS_SHARED := --install build_shared $(CMAKE_INSTALL_ARGS)
CMAKE_INSTALL_ARGS_STATIC := --install build_static $(CMAKE_INSTALL_ARGS)

# Common install vars
ifeq ($(UNAME), Linux)
ROOT_PREFIX := $(or $(INSTALL_PREFIX),"/usr/local")
BIN_DIR := $(or $(INSTALL_PREFIX),"/usr/local")/bin/
INC_DIR := $(or $(INSTALL_PREFIX),"/usr/local")/include/
LIB_DIR := $(or $(INSTALL_PREFIX),"/usr/local")/lib/
SHARE_DIR := $(or $(INSTALL_PREFIX),"/usr/local")/share
JAVA_INSTALL_DIR := /usr/local/share
else ifeq ($(UNAME), Darwin)
ROOT_PREFIX := $(or $(INSTALL_PREFIX),"/opt/homebrew")
BIN_DIR := $(or $(INSTALL_PREFIX),"/opt/homebrew")/bin/
INC_DIR := $(or $(INSTALL_PREFIX),"/opt/homebrew")/include/
LIB_DIR := $(or $(INSTALL_PREFIX),"/opt/homebrew")/lib/
SHARE_DIR := $(or $(INSTALL_PREFIX),"/opt/homebrew")/share
JAVA_INSTALL_DIR := /opt/homebrew/share
endif

SUDO:=sudo


#####################################################################################################################################################################################################################################################################################
# __      ________ _____   _____ _____ ____  _   _  _____
# \ \    / /  ____|  __ \ / ____|_   _/ __ \| \ | |/ ____|
#  \ \  / /| |__  | |__) | (___   | || |  | |  \| | (___
#   \ \/ / |  __| |  _  / \___ \  | || |  | | . ` |\___ \
#    \  /  | |____| | \ \ ____) |_| || |__| | |\  |____) |
#     \/   |______|_|  \_\_____/|_____\____/|_| \_|_____/
#
GOOGLETEST_VERSION := 1.15.2
CAPNPROTO_VERSION := 1.0.2
JSON_VERSION := 3.11.3
ANTLR_VERSION := 4.13.2
UHDM_VERSION := 1.84
SURELOG_VERSION := 1.84
VERIBLE_VERSION := 0.1.0
YOSYS_VERSION := 0.62
SLANG_COMMIT := d5e8d8558e
SLANG_VERSION := 0.0-g$(SLANG_COMMIT)
VERILATOR_VERSION := 5.044
OPENFPGALOADER_VERSION := 0.13.1
SIMVIEW_VERSION := 0.0.1
SURFER_VERSION := 0.0.1

# TODO
VERIBLE_TAG := v0.0-3981-g0e58c803

#####################################################################################################################################################################################################################################################################################
RELEASE_VERSION := 0.0.1

.PHONY: download
download:  ## Download all releases
	wget https://github.com/dau-dev/tools/releases/download/v$(RELEASE_VERSION)/antlr_$(ANTLR_VERSION)_amd64.deb
	wget https://github.com/dau-dev/tools/releases/download/v$(RELEASE_VERSION)/capnproto_$(CAPNPROTO_VERSION)_amd64.deb
	wget https://github.com/dau-dev/tools/releases/download/v$(RELEASE_VERSION)/json_$(JSON_VERSION)_amd64.deb
	wget https://github.com/dau-dev/tools/releases/download/v$(RELEASE_VERSION)/uhdm_$(UHDM_VERSION)_amd64.deb
	wget https://github.com/dau-dev/tools/releases/download/v$(RELEASE_VERSION)/surelog_$(SURELOG_VERSION)_amd64.deb
	# wget https://github.com/dau-dev/tools/releases/download/v$(RELEASE_VERSION)/simview_$(SIMVIEW_VERSION)_amd64.deb
	wget https://github.com/dau-dev/tools/releases/download/v$(RELEASE_VERSION)/yosys_$(YOSYS_VERSION)_amd64.deb
	wget https://github.com/dau-dev/tools/releases/download/v$(RELEASE_VERSION)/yosys-slang_$(SLANG_VERSION)_amd64.deb
	wget https://github.com/dau-dev/tools/releases/download/v$(RELEASE_VERSION)/verilator_$(VERILATOR_VERSION)_amd64.deb
	wget https://github.com/dau-dev/tools/releases/download/v$(RELEASE_VERSION)/openfpgaloader_$(OPENFPGALOADER_VERSION)_amd64.deb
	wget https://github.com/dau-dev/tools/releases/download/v$(RELEASE_VERSION)/simview_$(SIMVIEW_VERSION)_amd64.deb
	wget https://github.com/dau-dev/tools/releases/download/v$(RELEASE_VERSION)/surfer_$(SURFER_VERSION)_amd64.deb

#####################################################################################################################################################################################################################################################################################
#                         _      _            _
#                        | |    | |          | |
#  __ _  ___   ___   __ _| | ___| |_ ___  ___| |_
# / _` |/ _ \ / _ \ / _` | |/ _ \ __/ _ \/ __| __|
#| (_| | (_) | (_) | (_| | |  __/ ||  __/\__ \ |_
# \__, |\___/ \___/ \__, |_|\___|\__\___||___/\__|
#  __/ |             __/ |
# |___/             |___/
#
# https://github.com/google/googletest
#
googletest/.git:
	git clone --depth 1 --branch v$(GOOGLETEST_VERSION) https://github.com/google/googletest.git

googletest/build_shared: googletest/.git
	cd googletest && cmake $(CMAKE_COMMON_ARGS_SHARED) .
	cd googletest && cmake $(CMAKE_BUILD_ARGS_SHARED)

googletest/build_static: googletest/.git
	cd googletest && cmake $(CMAKE_COMMON_ARGS_STATIC)
	cd googletest && cmake $(CMAKE_BUILD_ARGS_STATIC)


.PHONY: googletest
googletest: googletest/build_shared googletest/build_static  ## build googletest

.PHONY: googletest/install
googletest/install: googletest/build_shared googletest/build_static  ## build and install googletest
	cd googletest && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_SHARED)
	cd googletest && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_STATIC)



#####################################################################################################################################################################################################################################################################################
#   _____            _       _____           _
#  / ____|          ( )     |  __ \         | |
# | |     __ _ _ __ |/ _ __ | |__) | __ ___ | |_ ___
# | |    / _` | '_ \  | '_ \|  ___/ '__/ _ \| __/ _ \
# | |___| (_| | |_) | | | | | |   | | | (_) | || (_) |
#  \_____\__,_| .__/  |_| |_|_|   |_|  \___/ \__\___/
#             | |
#             |_|
#
# https://github.com/capnproto/capnproto
#
.PHONY: capnproto/build_shared capnproto/build_static capnproto capnproto/install capnproto/debian

capnproto/.git:
	git clone --depth 1 --branch v$(CAPNPROTO_VERSION) https://github.com/capnproto/capnproto.git

capnproto/build_shared: capnproto/.git
	cd capnproto && cmake $(CMAKE_COMMON_ARGS_SHARED) .
	cd capnproto && cmake $(CMAKE_BUILD_ARGS_SHARED)

capnproto/build_static: capnproto/.git
	cd capnproto && cmake $(CMAKE_COMMON_ARGS_STATIC)
	cd capnproto && cmake $(CMAKE_BUILD_ARGS_STATIC)

capnproto: capnproto/build_shared capnproto/build_static  ## build capnproto

capnproto/install: capnproto/build_shared capnproto/build_static  ## build and install capnproto
	cd capnproto && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_SHARED)
	cd capnproto && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_STATIC)

capnproto/debian:  ## build debian package for capnproto
	$(SUDO) rm -rf capnproto/build_static/install_manifest.txt
	$(SUDO) rm -rf capnproto/build_shared/install_manifest.txt
	$(MAKE) capnproto/build_static INSTALL_PREFIX=./debian/usr/local
	$(MAKE) capnproto/build_shared INSTALL_PREFIX=./debian/usr/local
	$(MAKE) capnproto/install INSTALL_PREFIX=./debian/usr/local SUDO=
	mkdir -p capnproto/debian/DEBIAN
	printf "Package: capnproto\nVersion: $(CAPNPROTO_VERSION)\nSection: utils\nPriority: optional\nArchitecture: amd64\nMaintainer: timkpaine <t.paine154@gmail.com>\nDescription: capnproto\n" > capnproto/debian/DEBIAN/control
	dpkg-deb -Z"gzip" --root-owner-group --build capnproto/debian capnproto_$(CAPNPROTO_VERSION)_amd64.deb

#####################################################################################################################################################################################################################################################################################
#      _  _____  ____  _   _
#     | |/ ____|/ __ \| \ | |
#     | | (___ | |  | |  \| |
# _   | |\___ \| |  | | . ` |
#| |__| |____) | |__| | |\  |
# \____/|_____/ \____/|_| \_|
#
# https://github.com/nlohmann/json
#
.PHONY: json/build_shared json/build_static json json/install json/debian

JSON_CMAKE_ARGS:=-DJSON_BuildTests=OFF

json/.git:
	git clone --depth 1 --branch v$(JSON_VERSION) https://github.com/nlohmann/json.git

json/build_shared: json/.git
	cd json && cmake $(CMAKE_COMMON_ARGS_SHARED) $(JSON_CMAKE_ARGS)
	cd json && cmake $(CMAKE_BUILD_ARGS_SHARED)

json/build_static: json/.git
	cd json && cmake $(CMAKE_COMMON_ARGS_STATIC) $(JSON_CMAKE_ARGS)
	cd json && cmake $(CMAKE_BUILD_ARGS_STATIC)

json: json/build_shared json/build_static  ## build json

json/install: json/build_shared json/build_static  ## build and install json
	cd json && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_SHARED)
	cd json && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_STATIC)

json/debian:  ## build debian package for json
	$(SUDO) rm -rf json/build_static/install_manifest.txt
	$(SUDO) rm -rf json/build_shared/install_manifest.txt
	$(MAKE) json/build_static INSTALL_PREFIX=./debian/usr/local
	$(MAKE) json/build_shared INSTALL_PREFIX=./debian/usr/local
	$(MAKE) json/install INSTALL_PREFIX=./debian/usr/local SUDO=
	mkdir -p json/debian/DEBIAN
	printf "Package: json\nVersion: $(JSON_VERSION)\nSection: utils\nPriority: optional\nArchitecture: amd64\nMaintainer: timkpaine <t.paine154@gmail.com>\nDescription: json\n" > json/debian/DEBIAN/control
	dpkg-deb -Z"gzip" --root-owner-group --build json/debian json_$(JSON_VERSION)_amd64.deb


#####################################################################################################################################################################################################################################################################################
#           _   _ _______ _      _____
#     /\   | \ | |__   __| |    |  __ \
#    /  \  |  \| |  | |  | |    | |__) |
#   / /\ \ | . ` |  | |  | |    |  _  /
#  / ____ \| |\  |  | |  | |____| | \ \
# /_/    \_\_| \_|  |_|  |______|_|  \_\
#
# https://www.antlr.org/
#
.PHONY: antlr/build_shared antlr/build_static antlr antlr/install antlr/debian

antlr/antlr-$(ANTLR_VERSION)-complete.jar:
	mkdir -p antlr
	cd antlr && wget https://www.antlr.org/download/antlr4-cpp-runtime-$(ANTLR_VERSION)-source.zip
	cd antlr && unzip antlr4-cpp-runtime-$(ANTLR_VERSION)-source.zip
	wget https://www.antlr.org/download/antlr-$(ANTLR_VERSION)-complete.jar -P ./antlr

antlr/build_shared: antlr/antlr-$(ANTLR_VERSION)-complete.jar
	cd antlr && cmake $(CMAKE_COMMON_ARGS_SHARED) .
	cd antlr && cmake $(CMAKE_BUILD_ARGS_SHARED)

antlr/build_static: antlr/antlr-$(ANTLR_VERSION)-complete.jar
	cd antlr && cmake $(CMAKE_COMMON_ARGS_STATIC)
	cd antlr && cmake $(CMAKE_BUILD_ARGS_STATIC)

antlr: antlr/build_shared antlr/build_static  ## build antlr

antlr/install: antlr/build_shared antlr/build_static  ## build and install antlr
	cd antlr && $(SUDO) mkdir -p $(SHARE_DIR)/java
	cd antlr && $(SUDO) cp antlr-$(ANTLR_VERSION)-complete.jar $(SHARE_DIR)/java
	cd antlr && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_SHARED)
	cd antlr && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_STATIC)

antlr/debian:  ## build debian package for antlr
	$(SUDO) rm -rf antlr/build_static/install_manifest.txt
	$(SUDO) rm -rf antlr/build_shared/install_manifest.txt
	$(MAKE) antlr/build_static INSTALL_PREFIX=./debian/usr/local
	$(MAKE) antlr/build_shared INSTALL_PREFIX=./debian/usr/local
	$(MAKE) antlr/install INSTALL_PREFIX=./debian/usr/local SUDO=
	mkdir -p antlr/debian/DEBIAN
	printf "Package: antlr\nVersion: $(ANTLR_VERSION)\nSection: utils\nPriority: optional\nArchitecture: amd64\nMaintainer: timkpaine <t.paine154@gmail.com>\nDescription: antlr\n" > antlr/debian/DEBIAN/control
	dpkg-deb -Z"gzip" --root-owner-group --build antlr/debian antlr_$(ANTLR_VERSION)_amd64.deb


#####################################################################################################################################################################################################################################################################################
#  _    _ _    _ _____  __  __
# | |  | | |  | |  __ \|  \/  |
# | |  | | |__| | |  | | \  / |
# | |  | |  __  | |  | | |\/| |
# | |__| | |  | | |__| | |  | |
#  \____/|_|  |_|_____/|_|  |_|
#
# https://github.com/chipsalliance/UHDM
#
.PHONY: uhdm/build_shared uhdm/build_static uhdm uhdm/install uhdm/debian uhdm/rpm

UHDM_CMAKE_ARGS := -DUHDM_USE_HOST_GTEST=ON -DUHDM_USE_HOST_CAPNP=ON -DUHDM_BUILD_TESTS=OFF

uhdm/.git:
	git clone --depth 1 --branch v$(UHDM_VERSION) https://github.com/chipsalliance/UHDM.git uhdm

uhdm/build_shared: uhdm/.git
	cd uhdm && cmake $(UHDM_CMAKE_ARGS) $(CMAKE_COMMON_ARGS_SHARED) .
	cd uhdm && cmake $(CMAKE_BUILD_ARGS_SHARED)

uhdm/build_static: uhdm/.git
	cd uhdm && cmake $(UHDM_CMAKE_ARGS) $(CMAKE_COMMON_ARGS_STATIC)
	cd uhdm && cmake $(CMAKE_BUILD_ARGS_STATIC)

uhdm: uhdm/build_shared uhdm/build_static  ## build uhdm

uhdm/install: uhdm/build_shared uhdm/build_static  ## build and install uhdm
	cd uhdm && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_SHARED)
	cd uhdm && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_STATIC)

uhdm/debian:  ## build debian package for uhdm
	$(SUDO) rm -rf uhdm/build_static/install_manifest.txt
	$(SUDO) rm -rf uhdm/build_shared/install_manifest.txt
	$(MAKE) uhdm/build_static INSTALL_PREFIX=./debian/usr/local
	$(MAKE) uhdm/build_shared INSTALL_PREFIX=./debian/usr/local
	$(MAKE) uhdm/install INSTALL_PREFIX=./debian/usr/local SUDO=
	mkdir -p uhdm/debian/DEBIAN
	printf "Package: uhdm\nVersion: $(UHDM_VERSION)\nSection: utils\nPriority: optional\nArchitecture: amd64\nMaintainer: timkpaine <t.paine154@gmail.com>\nDescription: UHDM\n" > uhdm/debian/DEBIAN/control
	dpkg-deb -Z"gzip" --root-owner-group --build uhdm/debian uhdm_$(UHDM_VERSION)_amd64.deb

uhdm/rpm:  ## build rpm package for uhdm
	mkdir -p uhdm/rpm
	printf "Name: uhdm\nVersion: $(UHDM_VERSION)\nLicense: Apache-2\nRelease: 1%%{?dist}\nSummary: UHDM\nPackager: timkpaine <t.paine154@gmail.com>\nBuildArch: x86_64\n\n%%description\nUHDM\n\n%%setup\n\n%%build\n\n%%install\n\n%%clean\n\n%%post\n\n%%files\n%%{_bindir}/%%name\n\n%%changelog\n" > uhdm/rpm/uhdm.spec


#####################################################################################################################################################################################################################################################################################
#   _____                _
#  / ____|              | |
# | (___  _   _ _ __ ___| | ___   __ _
#  \___ \| | | | '__/ _ \ |/ _ \ / _` |
#  ____) | |_| | | |  __/ | (_) | (_| |
# |_____/ \__,_|_|  \___|_|\___/ \__, |
#                                 __/ |
#                                |___/
#
# https://github.com/chipsalliance/Surelog
#

.PHONY: surelog/build_shared surelog/build_static surelog surelog/install surelog/debian
SURELOG_CMAKE_ARGS := -DSURELOG_USE_HOST_ALL=ON -DSURELOG_WITH_TCMALLOC=OFF -DSURELOG_WITH_ZLIB=ON -DANTLR_JAR_LOCATION=${JAVA_INSTALL_DIR}/java/antlr-$(ANTLR_VERSION)-complete.jar

surelog/.git:
	git clone --depth 1 --branch v$(SURELOG_VERSION) https://github.com/chipsalliance/Surelog.git surelog

surelog/build_shared: surelog/.git
	cd surelog && cmake $(SURELOG_CMAKE_ARGS) $(CMAKE_COMMON_ARGS_SHARED) .
	cd surelog && cmake $(CMAKE_BUILD_ARGS_SHARED)

surelog/build_static: surelog/.git
	cd surelog && cmake $(SURELOG_CMAKE_ARGS) $(CMAKE_COMMON_ARGS_STATIC)
	cd surelog && cmake $(CMAKE_BUILD_ARGS_STATIC)

surelog: surelog/build_shared surelog/build_static  ## build surelog

surelog/install: surelog/build_shared surelog/build_static  ## build and install surelog
	cd surelog && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_SHARED)
	cd surelog && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_STATIC)

surelog/debian:  ## build debian package for surelog
	$(SUDO) rm -rf surelog/build_static/install_manifest.txt
	$(SUDO) rm -rf surelog/build_shared/install_manifest.txt
	$(MAKE) surelog/build_static INSTALL_PREFIX=./debian/usr/local
	$(MAKE) surelog/build_shared INSTALL_PREFIX=./debian/usr/local
	$(MAKE) surelog/install INSTALL_PREFIX=./debian/usr/local SUDO=
	mkdir -p surelog/debian/DEBIAN
	printf "Package: surelog\nVersion: $(SURELOG_VERSION)\nSection: utils\nPriority: optional\nArchitecture: amd64\nMaintainer: timkpaine <t.paine154@gmail.com>\nDescription: surelog\n" > surelog/debian/DEBIAN/control
	dpkg-deb -Z"gzip" --root-owner-group --build surelog/debian surelog_$(SURELOG_VERSION)_amd64.deb


#####################################################################################################################################################################################################################################################################################
# __      __       _ _     _
# \ \    / /      (_) |   | |
#  \ \  / /__ _ __ _| |__ | | ___
#   \ \/ / _ \ '__| | '_ \| |/ _ \
#    \  /  __/ |  | | |_) | |  __/
#     \/ \___|_|  |_|_.__/|_|\___|
#
# https://github.com/chipsalliance/verible
#
.PHONY: verible/libs verible verible/install verible/debian
verible/.git:
	git clone --depth 1 --branch $(VERIBLE_TAG) https://github.com/chipsalliance/verible.git

verible/libs: verible/.git
	cd verible && bazel build -c opt //...
	# cd verible && bazel build -c opt --config=create_static_linked_executables //...

verible: verible/libs  ## build verible

verible/install: verible/libs  ## build and install verible
	mkdir -p $(BIN_DIR)
	cd verible && $(SUDO) .github/bin/simple-install.sh $(BIN_DIR)

verible/debian:  ## build debian package for verible
	$(MAKE) verible/libs
	$(MAKE) verible/install INSTALL_PREFIX=$(shell pwd)/verible/debian/usr/local SUDO=
	mkdir -p verible/debian/DEBIAN
	printf "Package: verible\nVersion: $(VERIBLE_VERSION)\nSection: utils\nPriority: optional\nArchitecture: amd64\nMaintainer: timkpaine <t.paine154@gmail.com>\nDescription: verible\n" > verible/debian/DEBIAN/control
	dpkg-deb -Z"gzip" --root-owner-group --build verible/debian verible_$(VERIBLE_VERSION)_amd64.deb


#####################################################################################################################################################################################################################################################################################
#  _   _  ___  ___ _   _ ___
# | | | |/ _ \/ __| | | / __|
# | |_| | (_) \__ \ |_| \__ \
#  \__, |\___/|___/\__, |___/
#   __/ |           __/ |
#  |___/           |___/
#
# https://github.com/YosysHQ/yosys
#
.PHONY: yosys/libs yosys yosys/install yosys/debian

ifeq ($(UNAME), Linux)
YOSYS_ARGS := CONFIG=gcc
else ifeq ($(UNAME), Darwin)
YOSYS_ARGS := CONFIG=clang
endif

yosys/.git:
	git clone --depth 1 --branch v$(YOSYS_VERSION) https://github.com/YosysHQ/yosys.git
	cd yosys && git submodule update --init --recursive

yosys/libs: yosys/.git
	cd yosys && make $(YOSYS_ARGS) -j $(NPROC)

yosys: yosys/libs  ## build yosys

yosys/install: yosys/libs  ## build and install yosys
	cd yosys && $(SUDO) make $(YOSYS_ARGS) PREFIX=$(ROOT_PREFIX) install

yosys/debian:  ## build debian package for yosys
	$(MAKE) yosys/libs
	$(MAKE) yosys/install INSTALL_PREFIX=./debian/usr/local SUDO=
	mkdir -p yosys/debian/DEBIAN
	printf "Package: yosys\nVersion: $(YOSYS_VERSION)\nSection: utils\nPriority: optional\nArchitecture: amd64\nMaintainer: timkpaine <t.paine154@gmail.com>\nDescription: yosys\n" > yosys/debian/DEBIAN/control
	dpkg-deb -Z"gzip" --root-owner-group --build yosys/debian yosys_$(YOSYS_VERSION)_amd64.deb

#####################################################################################################################################################################################################################################################################################
#                         ______ _____   _____          _                     _
#                        |  ____|  __ \ / ____|   /\   | |                   | |
#   ___  _ __   ___ _ __ | |__  | |__) | |  __   /  \  | |     ___   __ _  __| | ___ _ __
#  / _ \| '_ \ / _ \ '_ \|  __| |  ___/| | |_ | / /\ \ | |    / _ \ / _` |/ _` |/ _ \ '__|
# | (_) | |_) |  __/ | | | |    | |    | |__| |/ ____ \| |___| (_) | (_| | (_| |  __/ |
#  \___/| .__/ \___|_| |_|_|    |_|     \_____/_/    \_\______\___/ \__,_|\__,_|\___|_|
#       | |
#       |_|
#
# https://github.com/trabucayre/openFPGALoader
#
.PHONY: openfpgaloader/libs openfpgaloader openfpgaloader/install openfpgaloader/debian

openfpgaloader/.git:
	git clone --depth 1 --branch v$(OPENFPGALOADER_VERSION) https://github.com/trabucayre/openFPGALoader.git openfpgaloader

openfpgaloader/build_shared: openfpgaloader/.git
	cd openfpgaloader && cmake $(CMAKE_COMMON_ARGS_SHARED) .
	cd openfpgaloader && cmake $(CMAKE_BUILD_ARGS_SHARED)

openfpgaloader/build_static: openfpgaloader/.git
	cd openfpgaloader && cmake $(CMAKE_COMMON_ARGS_STATIC)
	cd openfpgaloader && cmake $(CMAKE_BUILD_ARGS_STATIC)

openfpgaloader: openfpgaloader/build_shared openfpgaloader/build_static  ## build openfpgaloader

openfpgaloader/install: openfpgaloader/build_shared openfpgaloader/build_static  ## build and install openfpgaloader
	cd openfpgaloader && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_SHARED)
	cd openfpgaloader && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_STATIC)

openfpgaloader/debian:  ## build debian package for openfpgaloader
	$(SUDO) rm -rf openfpgaloader/build_static/install_manifest.txt
	$(SUDO) rm -rf openfpgaloader/build_shared/install_manifest.txt
	$(MAKE) openfpgaloader/build_static INSTALL_PREFIX=./debian/usr/local
	$(MAKE) openfpgaloader/build_shared INSTALL_PREFIX=./debian/usr/local
	$(MAKE) openfpgaloader/install INSTALL_PREFIX=./debian/usr/local SUDO=
	mkdir -p openfpgaloader/debian/DEBIAN
	printf "Package: openfpgaloader\nVersion: $(OPENFPGALOADER_VERSION)\nSection: utils\nPriority: optional\nArchitecture: amd64\nMaintainer: timkpaine <t.paine154@gmail.com>\nDescription: openfpgaloader\n" > openfpgaloader/debian/DEBIAN/control
	dpkg-deb -Z"gzip" --root-owner-group --build openfpgaloader/debian openfpgaloader_$(OPENFPGALOADER_VERSION)_amd64.deb

#####################################################################################################################################################################################################################################################################################
# yosys-slang
#
# https://github.com/povik/yosys-slang
#
.PHONY: yosys-slang/build yosys-slang yosys-slang/install yosys-slang/debian

yosys-slang/.git:
	git clone --recursive https://github.com/povik/yosys-slang.git
	cd yosys-slang && git checkout $(SLANG_COMMIT) && git submodule update --init --recursive

yosys-slang/build: yosys-slang/.git
	cd yosys-slang && cmake -S . -B build -DYOSYS_CONFIG=yosys-config -DCMAKE_BUILD_TYPE=Release
	cd yosys-slang && cmake --build build -j $(NPROC)

yosys-slang: yosys-slang/build  ## build yosys-slang

yosys-slang/install: yosys-slang/build  ## build and install yosys-slang
	cd yosys-slang && $(SUDO) cmake --install build

yosys-slang/debian:  ## build debian package for yosys-slang
	$(MAKE) yosys-slang/build
	mkdir -p yosys-slang/debian/DEBIAN
	cd yosys-slang && DESTDIR=$(CURDIR)/yosys-slang/debian cmake --install build
	printf "Package: yosys-slang\nVersion: $(SLANG_VERSION)\nSection: utils\nPriority: optional\nArchitecture: amd64\nMaintainer: timkpaine <t.paine154@gmail.com>\nDescription: yosys-slang\n" > yosys-slang/debian/DEBIAN/control
	dpkg-deb -Z"gzip" --root-owner-group --build yosys-slang/debian yosys-slang_$(SLANG_VERSION)_amd64.deb



#####################################################################################################################################################################################################################################################################################
# __      __       _ _       _
# \ \    / /      (_) |     | |
#  \ \  / /__ _ __ _| | __ _| |_ ___  _ __
#   \ \/ / _ \ '__| | |/ _` | __/ _ \| '__|
#    \  /  __/ |  | | | (_| | || (_) | |
#     \/ \___|_|  |_|_|\__,_|\__\___/|_|
#
#
# https://github.com/verilator/verilator
#
.PHONY: verilator/build_static verilator verilator/install verilator/debian

verilator/.git:
	git clone --depth 1 --branch v$(VERILATOR_VERSION) https://github.com/verilator/verilator.git

verilator/build_static: verilator/.git
	cd verilator && cmake $(CMAKE_COMMON_ARGS_STATIC) .
	cd verilator && cmake $(CMAKE_BUILD_ARGS_STATIC)
	cd verilator && echo "AR = ar" >> build_static/include/verilated.mk
	cd verilator && echo "CXX = c++" >> build_static/include/verilated.mk
	cd verilator && echo "LINK = c++" >> build_static/include/verilated.mk
	cd verilator && echo "PYTHON3 = python" >> build_static/include/verilated.mk
	# The cmake build leaves CFG_CXXFLAGS_STD empty where the autoconf build
	# would detect it, so nothing puts a -std flag on CPPFLAGS. Anything using
	# --timing then fails to compile: verilated_timing.h includes <coroutine>,
	# and gcc refuses that below C++20 with "requires -fcoroutines". Patch the
	# assignment rather than appending one, so it holds regardless of how the
	# CPPFLAGS += line expands.
	cd verilator && sed -i 's|^CFG_CXXFLAGS_STD = $$|CFG_CXXFLAGS_STD = -std=gnu++20|' build_static/include/verilated.mk
	cd verilator && grep -q '^CFG_CXXFLAGS_STD = -std=' build_static/include/verilated.mk

verilator: verilator/build_static  ## build verilator

verilator/install: verilator/build_static  ## build and install verilator
	cd verilator && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_STATIC)

verilator/debian:  ## build debian package for verilator
	$(SUDO) rm -rf verilator/debian
	$(MAKE) verilator/build_static INSTALL_PREFIX=./debian/usr/local
	$(MAKE) verilator/install INSTALL_PREFIX=./debian/usr/local SUDO=
	mkdir -p verilator/debian/DEBIAN
	printf "Package: verilator\nVersion: $(VERILATOR_VERSION)\nSection: utils\nPriority: optional\nArchitecture: amd64\nMaintainer: timkpaine <t.paine154@gmail.com>\nDescription: verilator\n" > verilator/debian/DEBIAN/control
	cd verilator/debian/usr/local && rm -rf share/verilator && mkdir -p share/verilator && mv include share/verilator && mv examples share/verilator && mv *.cmake share/verilator/ && sed -i 's|$$verilator_pkgdatadir_relpath = ".."|$$verilator_pkgdatadir_relpath = "../share/verilator"|g' bin/verilator && cp -r bin share/verilator
	dpkg-deb -Z"gzip" --root-owner-group --build verilator/debian verilator_$(VERILATOR_VERSION)_amd64.deb




#####################################################################################################################################################################################################################################################################################
#      _                _
#     (_)              (_)
#  ___ _ _ __ _____   ___  _____      __
# / __| | '_ ` _ \ \ / / |/ _ \ \ /\ / /
# \__ \ | | | | | \ V /| |  __/\ V  V /
# |___/_|_| |_| |_|\_/ |_|\___| \_/\_/
#
# https://github.com/pieter3d/simview
#
.PHONY: simview/build_static simview simview/install simview/debian

simview/.git:
	git clone --depth 1 --branch tkp/mac_and_sharedlibs https://github.com/timkpaine/simview.git

simview/build_static: simview/.git
	cd simview && cmake $(CMAKE_COMMON_ARGS_STATIC) .
	cd simview && cmake $(CMAKE_BUILD_ARGS_STATIC)

simview: simview/build_static  ## build simview

simview/install: simview/build_static  ## build and install simview
	cd simview && $(SUDO) cmake $(CMAKE_INSTALL_ARGS_STATIC)
	cd simview && $(SUDO) mkdir -p $(BIN_DIR) && $(SUDO) cp build_static/simview $(BIN_DIR)

simview/debian:  ## build debian package for simview
	$(SUDO) rm -rf simview/build_static/install_manifest.txt
	$(MAKE) simview/build_static INSTALL_PREFIX=./debian/usr/local
	$(MAKE) simview/install INSTALL_PREFIX=./debian/usr/local SUDO=
	mkdir -p simview/debian/DEBIAN
	printf "Package: simview\nVersion: $(SIMVIEW_VERSION)\nSection: utils\nPriority: optional\nArchitecture: amd64\nMaintainer: timkpaine <t.paine154@gmail.com>\nDescription: simview\n" > simview/debian/DEBIAN/control
	dpkg-deb -Z"gzip" --root-owner-group --build simview/debian simview_$(SIMVIEW_VERSION)_amd64.deb


#####################################################################################################################################################################################################################################################################################
#    _____             __
#   / ____|           / _|
#  | (___  _   _ _ __| |_ ___ _ __
#   \___ \| | | | '__|  _/ _ \ '__|
#   ____) | |_| | |  | ||  __/ |
#  |_____/ \__,_|_|  |_| \___|_|
#
# https://gitlab.com/surfer-project/surfer
#
.PHONY: surfer/build surfer surfer/install surfer/debian

surfer/.git:
	git clone --depth 1 --branch main https://gitlab.com/surfer-project/surfer.git
	cd surfer && git submodule update --init --recursive

surfer/build: surfer/.git
	cd surfer && cargo build --release

surfer: surfer/build  ## build surfer

surfer/install: surfer/build  ## build and install surfer
	cd surfer && $(SUDO) mkdir -p $(BIN_DIR) && $(SUDO) cp target/release/surfer $(BIN_DIR)

surfer/debian:  ## build debian package for surfer
	$(MAKE) surfer/build INSTALL_PREFIX=./debian/usr/local
	$(MAKE) surfer/install INSTALL_PREFIX=./debian/usr/local SUDO=
	mkdir -p surfer/debian/DEBIAN
	printf "Package: surfer\nVersion: $(SURFER_VERSION)\nSection: utils\nPriority: optional\nArchitecture: amd64\nMaintainer: timkpaine <t.paine154@gmail.com>\nDescription: surfer\n" > surfer/debian/DEBIAN/control
	dpkg-deb -Z"gzip" --root-owner-group --build surfer/debian surfer_$(SURFER_VERSION)_amd64.deb




#####################################################################################################################################################################################################################################################################################
#   _____ _      ______          _   _
#  / ____| |    |  ____|   /\   | \ | |
# | |    | |    | |__     /  \  |  \| |
# | |    | |    |  __|   / /\ \ | . ` |
# | |____| |____| |____ / ____ \| |\  |
#  \_____|______|______/_/    \_\_| \_|
#
.PHONY: clean
clean:  ## Delete all built repos
	rm -rf googletest
	rm -rf capnproto
	rm -rf json
	rm -rf antlr4
	rm -rf uhdm
	rm -rf surelog
	rm -rf yosys-slang
	rm -rf verible
	rm -rf yosys
	rm -rf openfpgaloader
	rm -rf surfer


.DEFAULT_GOAL := help
.PHONY: help
help:
	@grep -E '^[a-zA-Z0-9//_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

print-%:
	@echo '$*=$($*)'



#####################################################################################################################################################################################################################################################################################
#   _______ _                 _        _
#  |__   __| |               | |      | |
#     | |  | |__   __ _ _ __ | | _____| |
#     | |  | '_ \ / _` | '_ \| |/ / __| |
#     | |  | | | | (_| | | | |   <\__ \_|
#     |_|  |_| |_|\__,_|_| |_|_|\_\___(_)
#
# https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
# https://patorjk.com/software/taag/#p=display&f=Big&t=Type%20Something%20
#