system_vivado.mk

##############################################################################
## This file is part of 'SLAC Firmware Standard Library'.
## It is subject to the license terms in the LICENSE.txt file found in the
## top-level directory of this distribution and at:
##    https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html.
## No part of 'SLAC Firmware Standard Library', including this file,
## may be copied, modified, propagated, or distributed except according to
## the terms contained in the LICENSE.txt file.
##############################################################################

ifndef PROJECT
export PROJECT = $(notdir $(PWD))
endif

ifndef PROJ_DIR
export PROJ_DIR = $(abspath $(PWD))
endif

ifndef TOP_DIR
export TOP_DIR  = $(abspath $(PROJ_DIR)/../..)
endif

ifndef RELEASE_DIR
export RELEASE_DIR = $(TOP_DIR)/release
endif

ifndef MODULES
export MODULES = $(TOP_DIR)/submodules
endif

ifndef REMOVE_UNUSED_CODE
export REMOVE_UNUSED_CODE = 0
endif

ifndef PARALLEL_SYNTH
export PARALLEL_SYNTH = $(shell cat /proc/cpuinfo | grep processor | wc -l)
endif

ifndef GIT_BYPASS
export GIT_BYPASS = 1
endif

ifndef REPORT_QOR
export REPORT_QOR = 0
endif

##############################################################################

ifndef GEN_BIT_IMAGE
export GEN_BIT_IMAGE = 1
endif

ifndef GEN_BIT_IMAGE_GZIP
export GEN_BIT_IMAGE_GZIP = 0
endif

ifndef GEN_BIN_IMAGE
export GEN_BIN_IMAGE = 0
endif

ifndef GEN_BIN_IMAGE_GZIP
export GEN_BIN_IMAGE_GZIP = 0
endif

ifndef GEN_PDI_IMAGE
export GEN_PDI_IMAGE = 1
endif

ifndef GEN_PDI_IMAGE_GZIP
export GEN_PDI_IMAGE_GZIP = 0
endif

ifndef GEN_MCS_IMAGE
export GEN_MCS_IMAGE = 1
endif

ifndef GEN_MCS_IMAGE_GZIP
export GEN_MCS_IMAGE_GZIP = 0
endif

ifndef GEN_XSA_IMAGE
export GEN_XSA_IMAGE = 0
endif

##############################################################################

ifndef RECONFIG_CHECKPOINT
export RECONFIG_CHECKPOINT = 0
export RECONFIG_STATIC_HASH = 0
else
export RECONFIG_STATIC_FILE = $(notdir $(RECONFIG_CHECKPOINT))
export RECONFIG_STATIC_HASH = -$(shell echo '$(RECONFIG_STATIC_FILE)' | awk -F'-' '{print $$5}' )
endif

ifndef RECONFIG_ENDPOINT
export RECONFIG_ENDPOINT = 0
endif

ifndef RECONFIG_PBLOCK
export RECONFIG_PBLOCK = 0
endif

# Vivado Simulation Variables
ifndef VIVADO_PROJECT_SIM
export VIVADO_PROJECT_SIM = $(PROJECT)
endif
ifndef VIVADO_PROJECT_SIM_TIME
export VIVADO_PROJECT_SIM_TIME = 1000 ns
endif

# Synthesis Variables
export VIVADO_VERSION   := $(shell vivado -version | grep -Po "v(\d+\.)+\d+" | cut -c2-)
export VIVADO_INSTALL   = $(abspath  $(shell which vivado)/../..)
export VIVADO_DIR       = $(abspath $(PROJ_DIR)/vivado)
export VIVADO_PROJECT   = $(PROJECT)_project
export VIVADO_DEPEND    = $(OUT_DIR)/$(VIVADO_PROJECT).xpr
ifndef RUCKUS_DIR
export RUCKUS_DIR = $(MODULES)/ruckus
endif
export SOURCE_DEPEND     = $(OUT_DIR)/$(PROJECT)_sources.txt
export RUCKUS_PROC_TCL   = $(RUCKUS_DIR)/vivado/proc.tcl
export RUCKUS_QUIET_FLAG = -quiet

# Images Directory
export IMAGES_DIR = $(abspath $(PROJ_DIR)/images)

# Project Build Directory
export OUT_DIR  = $(abspath $(TOP_DIR)/build/$(PROJECT))
export SYN_DIR  = $(OUT_DIR)/$(VIVADO_PROJECT).runs/synth_1
export IMPL_DIR = $(OUT_DIR)/$(VIVADO_PROJECT).runs/impl_1

# Define the user IP repo
ifndef IP_REPO
export IP_REPO = $(OUT_DIR)/ip_repo
endif

###############################################################

ifndef SIM_CARGS_VERILOG
export SIM_CARGS_VERILOG = -nc -l +v2k -xlrm -kdb -v2005 +define+SIM_SPEED_UP
endif

ifndef SIM_CARGS_VHDL
export SIM_CARGS_VHDL = -nc -l +v2k -xlrm -kdb
endif

ifndef SIM_VCS_FLAGS
export SIM_VCS_FLAGS = -debug_acc+pp+dmptf +warn=none -kdb -lca
endif

###############################################################
#           Vitis Variables (Vivado 2019.2 or newer)
###############################################################

export VITIS_PRJ = $(abspath $(OUT_DIR)/$(VIVADO_PROJECT).vitis)
export VITIS_ELF = $(abspath $(VITIS_PRJ)/$(PROJECT).elf)

ifdef SDK_LIB
   export VITIS_LIB = $(SDK_LIB)
else
   ifndef VITIS_LIB
      export VITIS_LIB = $(MODULES)/surf/xilinx/general/sdk/common
   endif
endif

# Check if SDK_SRC_PATH defined but VITIS_SRC_PATH not (legacy support)
ifdef SDK_SRC_PATH
   ifndef VITIS_SRC_PATH
      export VITIS_SRC_PATH = $(SDK_SRC_PATH)
   endif
endif

###############################################################
#           SDK Variables (Vivado 2019.1 or older)
###############################################################

export SDK_PRJ = $(abspath $(OUT_DIR)/$(VIVADO_PROJECT).sdk)
export SDK_ELF = $(abspath $(SDK_PRJ)/$(PROJECT).elf)

ifndef SDK_LIB
export SDK_LIB  =  $(MODULES)/surf/xilinx/general/sdk/common
endif

###############################################################

ifndef EMBED_PROC
export EMBED_PROC = microblaze_0
endif

ifneq (, $(shell which vitis 2>/dev/null))
   export EMBED_TYPE = Vitis
   export EMBED_GUI  = vitis -workspace $(OUT_DIR)/$(VIVADO_PROJECT).vitis -vmargs -Dorg.eclipse.swt.internal.gtk.cairoGraphics=false
   export EMBED_ELF  = vivado -mode batch -source $(RUCKUS_DIR)/MicroblazeBasicCore/vitis/bit.tcl
else
   export EMBED_TYPE = SDK
   export EMBED_GUI  = xsdk -workspace $(OUT_DIR)/$(VIVADO_PROJECT).sdk -vmargs -Dorg.eclipse.swt.internal.gtk.cairoGraphics=false
   export EMBED_ELF  = vivado -mode batch -source $(RUCKUS_DIR)/MicroblazeBasicCore/sdk/bit.tcl

   ifndef LD_PRELOAD
   export LD_PRELOAD =
   endif

   # Ubuntu SDK support
   ifndef SWT_GTK3
   export SWT_GTK3 = 0
   endif

endif

define COPY_PROBES_FILE
@if [ -f '$(OUT_DIR)/debugProbes.ltx' ] ; then \
	$(RM) '$(IMAGES_DIR)/$(IMAGENAME).ltx' ; \
	cp '$(OUT_DIR)/debugProbes.ltx' '$(IMAGES_DIR)/$(IMAGENAME).ltx' ; \
	echo "Debug Probes file copied to $(IMAGES_DIR)/$(IMAGENAME).ltx "; \
elif  [ -f '$(IMPL_DIR)/debug_nets.ltx' ] ; then \
	$(RM) '$(IMAGES_DIR)/$(IMAGENAME).ltx' ; \
	cp '$(IMPL_DIR)/debug_nets.ltx' '$(IMAGES_DIR)/$(IMAGENAME).ltx' ; \
	echo "Debug Probes file copied to $(IMAGES_DIR)/$(IMAGENAME).ltx "; \
else \
	echo "No Debug Probes found"; \
fi
endef

include $(TOP_DIR)/submodules/ruckus/system_shared.mk

.PHONY : all
all: target

###############################################################
#### Printout Environmental Variables #########################
###############################################################

.PHONY : test
test:
	@echo PROJECT: $(PROJECT)
	@echo PROJ_DIR: $(PROJ_DIR)
	@echo PRJ_VERSION: $(PRJ_VERSION)
	@echo PRJ_PART: $(PRJ_PART)
	@echo TOP_DIR: $(TOP_DIR)
	@echo OUT_DIR: $(OUT_DIR)
	@echo IMAGES_DIR: $(IMAGES_DIR)
	@echo IMPL_DIR: $(IMPL_DIR)
	@echo VIVADO_DIR: $(VIVADO_DIR)
	@echo RUCKUS_DIR: $(RUCKUS_DIR)
	@echo VIVADO_PROJECT: $(VIVADO_PROJECT)
	@echo VIVADO_VERSION: $(VIVADO_VERSION)
	@echo VIVADO_INSTALL: $(VIVADO_INSTALL)
	@echo XILINX_LOCAL_USER_DATA: $(XILINX_LOCAL_USER_DATA)
	@echo GIT_HASH_LONG: $(GIT_HASH_LONG)
	@echo GIT_HASH_SHORT: $(GIT_HASH_SHORT)
	@echo IMAGENAME: $(IMAGENAME)
	@echo BUILD_STRING: $${BUILD_STRING}
	@echo EMBED_PROC: $(EMBED_PROC)
	@echo EMBED_TYPE: $(EMBED_TYPE)
	@echo EMBED_GUI: $(EMBED_GUI)
	@echo EMBED_ELF: $(EMBED_ELF)
	@echo Untracked Files:
	@echo "${GIT_STATUS}" | sed -e 's/ /\n/g'

###############################################################
#### Build Location ###########################################
###############################################################
.PHONY : dir
dir:
	@test -d $(TOP_DIR)/build/ || { \
			 echo ""; \
			 echo "Build directory missing!"; \
			 echo "You must create a build directory at the top level."; \
			 echo ""; \
			 echo "This directory can either be a normal directory:"; \
			 echo "   mkdir $(TOP_DIR)/build"; \
			 echo ""; \
			 echo "Or by creating a symbolic link to a directory on another disk:"; \
			 echo "   ln -s $(TMP_DIR) $(TOP_DIR)/build"; \
			 echo ""; false; }
	@test -d $(OUT_DIR)     || mkdir $(OUT_DIR)
	@test -d $(RELEASE_DIR) || mkdir $(RELEASE_DIR)
	@test -d $(IP_REPO)     || mkdir $(IP_REPO)
	@cd $(OUT_DIR); rm -f firmware
	@cd $(OUT_DIR); ln -s $(TOP_DIR) firmware

###############################################################
#### Vivado Sources ###########################################
###############################################################
$(SOURCE_DEPEND) : dir
	$(call ACTION_HEADER,"Vivado Source Setup")
	@cd $(OUT_DIR); vivado -mode batch -source $(RUCKUS_DIR)/vivado/sources.tcl

###############################################################
#### Vivado Project GUI mode ##################################
###############################################################
.PHONY : gui
gui : $(SOURCE_DEPEND)
	$(call ACTION_HEADER,"Vivado Project GUI Mode")
	@cd $(OUT_DIR); vivado -source $(RUCKUS_DIR)/vivado/gui.tcl $(VIVADO_PROJECT).xpr

###############################################################
#### Vivado Batch #############################################
###############################################################
.PHONY : bit mcs prom pdi
bit mcs prom pdi : $(SOURCE_DEPEND)
	$(call ACTION_HEADER,"Vivado Batch Build for .bit/.mcs")
	@cd $(OUT_DIR); vivado -mode batch -source $(RUCKUS_DIR)/vivado/build.tcl

###############################################################
#### Vivado Synthesis Only ####################################
###############################################################
.PHONY : syn
syn : $(SOURCE_DEPEND)
	$(call ACTION_HEADER,"Vivado Synthesis Only")
	@cd $(OUT_DIR); export SYNTH_ONLY=1; vivado -mode batch -source $(RUCKUS_DIR)/vivado/build.tcl

###############################################################
#### Vivado Synthesis DCP  ####################################
###############################################################
.PHONY : dcp
dcp : $(SOURCE_DEPEND)
	$(call ACTION_HEADER,"Vivado Synthesis DCP")
	@cd $(OUT_DIR); export SYNTH_DCP=1; vivado -mode batch -source $(RUCKUS_DIR)/vivado/build.tcl

###############################################################
#### Vivado Interactive #######################################
###############################################################
.PHONY : interactive
interactive : $(SOURCE_DEPEND)
	$(call ACTION_HEADER,"Vivado Interactive")
	@cd $(OUT_DIR); vivado -mode tcl -source $(RUCKUS_DIR)/vivado/env_var.tcl

###############################################################
#### Vivado SDK ###############################################
###############################################################
.PHONY : sdk vitis
sdk vitis :
	$(call ACTION_HEADER,"Vivado $(EMBED_TYPE) GUI")
	@cd $(OUT_DIR); $(EMBED_GUI)

###############################################################
#### Vivado SDK ELF ###########################################
###############################################################
.PHONY : elf
elf :
	$(call ACTION_HEADER,"Vivado $(EMBED_TYPE) .ELF generation")
	@cd $(OUT_DIR); $(EMBED_ELF)
	@echo ""
	@echo "Bit file w/ Elf file copied to $(IMAGES_DIR)/$(IMAGENAME).bit"

###############################################################
#### Release ##################################################
###############################################################
.PHONY : release
release : dir
	$(call ACTION_HEADER,"Generating Release")
	@cd $(RELEASE_DIR); python3 $(RUCKUS_DIR)/scripts/firmwareRelease.py --project=$(TOP_DIR) --release=$(RELEASE) --push

###############################################################
#### Release Files ############################################
###############################################################
.PHONY : release_files
release_files : dir
	$(call ACTION_HEADER,"Generating Release Files")
	@cd $(RELEASE_DIR); python3 $(RUCKUS_DIR)/scripts/firmwareRelease.py --project=$(TOP_DIR) --release=$(RELEASE)

###############################################################
#### Vivado PyRogue ###########################################
###############################################################
.PHONY : pyrogue
pyrogue : $(SOURCE_DEPEND)
	$(call ACTION_HEADER,"Generating pyrogue.tar.gz file")
	@cd $(OUT_DIR); tclsh $(RUCKUS_DIR)/vivado/pyrogue.tcl

###############################################################
#### Vivado CPSW ##############################################
###############################################################
.PHONY : yaml
yaml : $(SOURCE_DEPEND)
	$(call ACTION_HEADER,"Generating cpsw.tar.gz file")
	@cd $(OUT_DIR); tclsh $(RUCKUS_DIR)/vivado/cpsw.tcl

###############################################################
#### Vivado WIS ###############################################
###############################################################
.PHONY : wis
wis : $(SOURCE_DEPEND)
	$(call ACTION_HEADER,"Generating init_wis.tcl file for Windows OS")
	@cd $(OUT_DIR); vivado -mode batch -source $(RUCKUS_DIR)/vivado/wis.tcl

###############################################################
#### Vivado XSIM Simulation ###################################
###############################################################
.PHONY : xsim
xsim : $(SOURCE_DEPEND)
	$(call ACTION_HEADER,"Vivado XSIM Simulation")
	@cd $(OUT_DIR); vivado -mode batch -source $(RUCKUS_DIR)/vivado/xsim.tcl

###############################################################
#### Vivado VCS Simulation ####################################
###############################################################
.PHONY : vcs
vcs : $(SOURCE_DEPEND)
	$(call ACTION_HEADER,"Generating the VCS Simulation scripts")
	@cd $(OUT_DIR); vivado -mode batch -source $(RUCKUS_DIR)/vivado/vcs.tcl

###############################################################
#### Vivado ModelSim/Questa Simulation ########################
###############################################################
.PHONY : msim
msim : $(SOURCE_DEPEND)
	$(call ACTION_HEADER,"ModelSim/Questa Simulation")
	@cd $(OUT_DIR); vivado -mode batch -source $(RUCKUS_DIR)/vivado/msim.tcl

###############################################################
#### Vivado Batch Mode within the Project Environment  ########
###############################################################
.PHONY : batch
batch : $(SOURCE_DEPEND)
	$(call ACTION_HEADER,"Vivado Project Batch")
	@cd $(OUT_DIR); vivado -mode batch -source $(RUCKUS_DIR)/vivado/batch.tcl $(VIVADO_PROJECT).xpr

###############################################################
#### Makefile Targets #########################################
###############################################################
.PHONY      : sources
sources     : $(SOURCE_DEPEND)

###############################################################
#### Clean ####################################################
###############################################################
.PHONY : clean
clean:
	rm -rf $(OUT_DIR)