Makefile

# SPDX-FileCopyrightText: 2020 Efabless Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
MAKEFLAGS+=--warn-undefined-variables
export FRIGATE_ROOT?=$(PWD)/dependencies/frigate
export FRIGATE_REPO_URL?=https://github.com/efabless/frigate-os.git
export FRIGATE_BRANCH?=main
export MGMT_ROOT?=$(FRIGATE_ROOT)/dependencies/caravel_mgmt_soc
export MGMT_REPO_URL?=https://github.com/efabless/caravel_mgmt_soc_litex.git
export MGMT_BRANCH?=Add_newfill
export PDK_ROOT?=$(PWD)/dependencies/pdks
export OPEN_PDKS_COMMIT?=0fe599b2afb6708d281543108caf8310912f54af

export PROJECT_ROOT=$(shell pwd)

SIM?=RTL
PYTHON_BIN=python3

# PDK switch varient
export PDK?=sky130A
#export PDK?=gf180mcuC
export PDKPATH?=$(PDK_ROOT)/$(PDK)

.PHONY: setup
setup: check_dependencies install-frigate pdk-with-volare setup-cocotb 


.PHONY: check_dependencies
check_dependencies:
	@if [ ! -d "$(PWD)/dependencies" ]; then \
		mkdir $(PWD)/dependencies; \
	fi

.PHONY: pdk-with-volare
pdk-with-volare: check-python install-volare 
	./venv/bin/volare enable ${OPEN_PDKS_COMMIT}

check-python:
ifeq ($(shell which python3),)
$(error Please install python 3.6+)
endif

.PHONY: install-volare
install-volare:
	rm -rf ./venv
	$(PYTHON_BIN) -m venv ./venv
	./venv/bin/$(PYTHON_BIN) -m pip install --upgrade --no-cache-dir pip
	./venv/bin/$(PYTHON_BIN) -m pip install --upgrade --no-cache-dir volare

# Include frigate
.PHONY: install-frigate
install-frigate:
	if [ -d "$(FRIGATE_ROOT)" ]; then\
		MAKE_DIR="$(PWD)"; \
		echo "Updating $(FRIGATE_ROOT)"; \
		cd $(FRIGATE_ROOT) && \
		git checkout $(FRIGATE_BRANCH) && git pull && \
		make install-repos; \
		cd "$$MAKE_DIR"; \
	else \
		echo "Cloning $(FRIGATE_REPO_URL) -b $(FRIGATE_BRANCH)"; \
		git clone -b $(FRIGATE_BRANCH) $(FRIGATE_REPO_URL) $(FRIGATE_ROOT) --depth=1 --single-branch; \
		cd $(FRIGATE_ROOT) && \
		make install-repos; \
		cd "$$MAKE_DIR"; \
	fi

dv_patterns=$(shell cd verilog/dv && find * -maxdepth 0 -type d)
cocotb-dv_patterns=$(shell cd verilog/dv/cocotb && find . -name "*.c"  | sed -e 's|^.*/||' -e 's/.c//')
dv-targets-rtl=$(dv_patterns:%=verify-%-rtl)
cocotb-dv-targets-rtl=$(cocotb-dv_patterns:%=cocotb-verify-%-rtl)
dv-targets-gl=$(dv_patterns:%=verify-%-gl)
cocotb-dv-targets-gl=$(cocotb-dv_patterns:%=cocotb-verify-%-gl)
dv-targets-gl-sdf=$(dv_patterns:%=verify-%-gl-sdf)

.PHONY: install-caravel-cocotb
install-caravel-cocotb:
	rm -rf ./venv-cocotb
	$(PYTHON_BIN) -m venv ./venv-cocotb
	./venv-cocotb/bin/$(PYTHON_BIN) -m pip install --upgrade --no-cache-dir pip
	./venv-cocotb/bin/$(PYTHON_BIN) -m pip install --upgrade --no-cache-dir caravel-cocotb

.PHONY: setup-cocotb-env
setup-cocotb-env:
	@(python3 $(PROJECT_ROOT)/verilog/dv/setup-cocotb.py $(FRIGATE_ROOT) $(MGMT_ROOT) $(PDK_ROOT) $(PDK) $(PROJECT_ROOT))

.PHONY: cocotb-verify-all-rtl
cocotb-verify-all-rtl: 
	@(cd $(PROJECT_ROOT)/verilog/dv/cocotb && $(PROJECT_ROOT)/venv-cocotb/bin/caravel_cocotb -tl user_proj_tests/user_proj_tests.yaml  -gen_defaults_dir ./../../../dependencies/frigate  $(COCOTB_ARGS) )

.PHONY: cocotb-verify-all-gl 
cocotb-verify-all-gl:
	@(cd $(PROJECT_ROOT)/verilog/dv/cocotb && $(PROJECT_ROOT)/venv-cocotb/bin/caravel_cocotb -tl user_proj_tests/user_proj_tests_gl.yaml -sim GL -gen_defaults_dir ./../../../dependencies/frigate $(COCOTB_ARGS))

$(cocotb-dv-targets-rtl): cocotb-verify-%-rtl: 
	@(cd $(PROJECT_ROOT)/verilog/dv/cocotb && $(PROJECT_ROOT)/venv-cocotb/bin/caravel_cocotb -t $*  $(COCOTB_ARGS))
	
$(cocotb-dv-targets-gl): cocotb-verify-%-gl:
	@(cd $(PROJECT_ROOT)/verilog/dv/cocotb && $(PROJECT_ROOT)/venv-cocotb/bin/caravel_cocotb -t $* -sim GL $(COCOTB_ARGS))

# Install cocotb docker
.PHONY: simenv-cocotb
simenv-cocotb:
	docker pull efabless/dv:cocotb

.PHONY: setup-cocotb
setup-cocotb: install-caravel-cocotb setup-cocotb-env simenv-cocotb

check-pdk:
	@if [ ! -d "$(PDK_ROOT)" ]; then \
		echo "PDK Root: "$(PDK_ROOT)" doesn't exists, please export the correct path before running make. "; \
		exit 1; \
	fi

.PHONY: echo-var
echo-var:
	@echo $($(VAR))


# Harden with Openlane2
OPENLANE2_TAG ?= 2.3.10
OPENLANE2_IMAGE_NAME ?= efabless/openlane:$(OPENLANE2_TAG)
OPENLANE2_RUN_TAG = $(shell date '+%y_%m_%d_%H_%M')
OPENLANE2_USE_NIX ?= 1
ROOTLESS ?= 0
USER_ARGS = -u $$(id -u $$USER):$$(id -g $$USER)
current_design = null

ifeq ($(ROOTLESS), 1)
	USER_ARGS =
endif

# Install Openlane
.PHONY: openlane
openlane: openlane2-venv openlane2-docker-container
	# openlane installed

OPENLANE2_TAG_DOCKER=$(subst -,,$(OPENLANE2_TAG))
.PHONY: openlane2-docker-container
openlane2-docker-container:
	docker pull ghcr.io/efabless/openlane2:$(OPENLANE2_TAG_DOCKER)

openlane2-venv: $(PROJECT_ROOT)/openlane2-venv/manifest.txt
$(PROJECT_ROOT)/openlane2-venv/manifest.txt:
	rm -rf openlane2-venv
	python3 -m venv $(PROJECT_ROOT)/openlane2-venv
	PYTHONPATH= $(PROJECT_ROOT)/openlane2-venv/bin/python3 -m pip install openlane==$(OPENLANE2_TAG)
	PYTHONPATH= $(PROJECT_ROOT)/openlane2-venv/bin/python3 -m pip freeze > $(PROJECT_ROOT)/openlane2-venv/manifest.txt

openlane_args = \
	--run-tag $(OPENLANE2_RUN_TAG) \
	--manual-pdk \
	--pdk-root $(PDK_ROOT) \
	--pdk $(PDK) \
	--log-level WARNING \
	$(PROJECT_ROOT)/openlane/$*/config.yaml

docker_mounts = \
	-m $(PROJECT_ROOT)\
	-m $(PDK_ROOT) \

docker_env = \
	-e PDK_ROOT=$(PDK_ROOT) \
	-e PDK=$(PDK) \
	-e OPENLANE2_RUN_TAG=$(OPENLANE2_RUN_TAG)

ifneq ($(MGMT_ROOT),)
docker_env += -e MGMT_ROOT=$(MGMT_ROOT)
export MGMT_ROOT:=$(MGMT_ROOT)
docker_mounts += -m $(MGMT_ROOT)
endif

docker_startup_mode = $(shell test -t 0 && echo "-it" || echo "--rm" )
openlane_extra_args = $(shell test -t 0 || echo "--docker-no-tty")
docker_run = \
	docker run $(docker_startup_mode) \
	$(USER_ARGS) \
	$(docker_mounts) \
	$(docker_env) \

list:
	@echo $(designs)

designs = $(shell cd $(PROJECT_ROOT)/openlane && find * -maxdepth 0 -type d ! -name "user_project_wrapper")
ifeq ($(OPENLANE2_USE_NIX),1)
openlane_cmd=nix develop github:efabless/openlane2/$(OPENLANE2_TAG) --command openlane $(openlane_args) $(openlane_extra_args)
else
openlane_cmd=$(PROJECT_ROOT)/openlane2-venv/bin/python3 -m openlane $(docker_mounts) $(openlane_extra_args) --dockerized $(openlane_args) $(openlane_extra_args)
endif

define run_openlane
	rm -rf $(PROJECT_ROOT)/openlane/$*/runs/$(OPENLANE2_RUN_TAG)
	$(openlane_cmd) $1
	sh $(PROJECT_ROOT)/openlane/copy_views.sh $(PROJECT_ROOT) $* $(OPENLANE2_RUN_TAG)
endef

.PHONY: user_project_wrapper
user_project_wrapper: % : $(PROJECT_ROOT)/openlane/user_project_wrapper/config.yaml
	$(call run_openlane,$(PROJECT_ROOT)/openlane/user_project_wrapper/fixed_config.yaml)

.PHONY: $(designs)
$(designs) : export current_design=$@
$(designs) : % : $(PROJECT_ROOT)/openlane/%/config.yaml
	$(call run_openlane,)

.PHONY: harden
harden: $(designs)

.PHONY: clean
clean:
	rm -rf dependencies
	rm -rf $(FRIGATE_ROOT)