vitis.mk

#!/usr/bin/make -f
# SPDX-License-Identifier: Apache-2.0
#
################################################################################
##
## Copyright 2019-2020 Missing Link Electronics, Inc.
##
## 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.
##
################################################################################
##
##  File Name      : Makefile
##  Initial Author : Stefan Wiehler <stefan.wiehler@missinglinkelectronics.com>
##
################################################################################
##
##  File Summary   : Vitis convenience wrapper
##
##                   Uses: vitis xsct
##
################################################################################

ifeq ($(XILINX_VITIS),)
$(error XILINX_VITIS is unset. This Makefile must be invoked from within a Vitis environment)
endif

MAKEFILE_PATH := $(dir $(realpath $(lastword $(MAKEFILE_LIST))))

all: build

# include config
CFG ?= default
include $(CFG).mk

include $(MAKEFILE_PATH)common.mk

###############################################################################
# Variables

# platform project paths
HDF ?=
XPFM ?=

# user arguments, defaults, usually set via config.mk
DEF_DOMAIN_PROC ?= psu_cortexa53_0
DEF_DOMAIN_OS ?= standalone
DEF_APP_TMPL ?= Empty Application(C)
DEF_APP_OS ?= standalone
DEF_APP_LANG ?= C
DEF_APP_BCFG ?= Release
DEF_APP_OPT ?= Optimize more (-O2)
DEF_APP_EXTRA_CFLAGS ?=

DOMAIN_PRJS ?=
APP_PRJS ?=

# user arguments, rarely modified
PLAT_PRJ ?= plat
XSCT ?= xsct
VITIS ?= vitis

###############################################################################
# Platform repos

PLATS ?=

ifneq ($(strip $(PLATS)),)
__PLATS_CCMD = $(foreach PLAT,$(PLATS), \
	repo -add-platforms {$(PLAT)};)
endif

$(O)/.metadata/plats.stamp:
ifneq ($(strip $(PLATS)),)
	$(XSCT) -eval 'setws {$(O)}; $(__PLATS_CCMD)'
else
	mkdir -p $(O)/.metadata/
endif
	touch $@

###############################################################################
# Platform

# arg1: platform name
# arg2: path to platform file
define gen-plat-rule
$(O)/$(1)/hw/$(1)_init.stamp: | $(O)/.metadata/repos.stamp $(O)/.metadata/plats.stamp
ifneq ($(HDF),)
	$(XSCT) -eval 'setws {$(O)}; \
		platform create -name {$(1)} -hw {$(2)}'
else
ifneq ($(XPFM),)
	$(XSCT) -eval 'setws {$(O)}; \
		platform create -name {$(1)} -xpfm {$(XPFM)}'
	touch $(O)/$(1)/xpfm.stamp
else
ifneq ($(HW_PLAT),)
	$(XSCT) -eval 'setws {$(O)}; \
		platform create -name {$(1)} -hw {$(HW_PLAT)}'
	touch $(O)/$(1)/xpfm.stamp
else
	@echo "error: missing HDF or XPFM, run either with HDF=<path-to-.xsa-file>, XPFM=<path-to-.xpfm-file> or provide HW_PLAT" >&2
	@false
endif
endif
endif
	touch $$@
	# Also create / touch updatehw stamp file
	touch $(O)/$(1)/hw/$(1).stamp

$(O)/$(1)/hw/$(1).stamp: $(2) | $(O)/$(1)/hw/$(1)_init.stamp
ifneq ($(HDF),)
	$(XSCT) -eval 'setws {$(O)}; \
		platform active {$(1)}; \
		platform config -updatehw {$(2)}'
	# Also create / touch initial stamp file
	touch $(O)/$(1)/hw/$(1)_init.stamp
	touch $$@
else
	@echo "error: missing HDF, run with HDF=<path-to-.xsa-file>" >&2
	@false
endif

# shortcut to create platform, "make <plat>"
$(1): | $(O)/$(1)/hw/$(1)_init.stamp
.PHONY: $(1)

# shortcut to update platform "make <plat>_updatehw"
$(1)_updatehw: $(O)/$(1)/hw/$(1).stamp
.PHONY: $(1)_updatehw

$(1)_distclean:
	-$(XSCT) -eval 'setws {$(O)}; \
		platform remove -name {$(1)}'
.PHONY: $(1)_distclean
endef

###############################################################################
# Domains

# arg1: domain name
# arg2: platform name
define gen-domain-rule
$(1)_PROC ?= $(DEF_DOMAIN_PROC)
$(1)_OS ?= $(DEF_DOMAIN_OS)
$(1)_LIBS ?=
$(1)_EXTRA_CFLAGS ?=
$(1)_STDIN ?=
$(1)_STDOUT ?=
$(1)_IS_FSBL ?=

ifneq ($$strip($$($(1)_LIBS)),)
__$(1)_LIBS_CCMD = $$(foreach LIB,$$($(1)_LIBS), \
	bsp setlib -name {$$(LIB)};)
endif
__$(1)_EXTRA_CCMD =
ifneq ($$($(1)_EXTRA_CFLAGS),)
__$(1)_EXTRA_CCMD += \
	bsp config extra_compiler_flags {$$($(1)_EXTRA_CFLAGS)};
endif
ifneq ($$($(1)_STDIN),)
__$(1)_EXTRA_CCMD += \
	bsp config stdin {$$($(1)_STDIN)};
endif
ifneq ($$($(1)_STDOUT),)
__$(1)_EXTRA_CCMD += \
	bsp config stdout {$$($(1)_STDOUT)};
endif
ifeq ($$($(1)_IS_FSBL),yes)
# non-default BSP settings for FSBL
ifeq ($(findstring psu_cortexa53,$($(1)_PROC)),psu_cortexa53)
# for A53, ZynqMP
__$(1)_EXTRA_CCMD += \
	bsp config {zynqmp_fsbl_bsp} {true}; \
	bsp config {read_only} {true}; \
	bsp config {use_mkfs} {false}; \
	bsp config {extra_compiler_flags} {-g -Wall -Wextra -Os -flto -ffat-lto-objects};
else ifeq ($(findstring ps7_cortexa9,$($(1)_PROC)),ps7_cortexa9)
# for A9, Zynq
__$(1)_EXTRA_CCMD += \
	bsp config {zynqmp_fsbl_bsp} {false}; \
	bsp config {read_only} {true}; \
	bsp config {use_mkfs} {true}; \
	bsp config {extra_compiler_flags} {-g -Wall -Wextra -Os -flto -ffat-lto-objects -mcpu=cortex-a9 -mfpu=vfpv3 -mfloat-abi=hard -nostartfiles};
else ifeq ($(findstring psu_cortexr5,$($(1)_PROC)),psu_cortexr5)
# for R5, ZynqMP
__$(1)_EXTRA_CCMD += \
	bsp config {zynqmp_fsbl_bsp} {true}; \
	bsp config {read_only} {true}; \
	bsp config {use_mkfs} {false}; \
	bsp config {extra_compiler_flags} {-g -DARMR5 -Wall -Wextra -Os -flto -ffat-lto-objects -mcpu=cortex-r5 -mfpu=vfpv3-d16 -mfloat-abi=hard};
else
# TODO Unknown or not yet supported architecture for FSBL (e.g. Versal)
endif
else
ifeq ($(findstring ps7_cortexa9,$($(1)_PROC)),ps7_cortexa9)
# for A9, Zynq
__$(1)_EXTRA_CCMD += \
	bsp config -append {extra_compiler_flags} {-mcpu=cortex-a9 -mfpu=vfpv3 -mfloat-abi=hard -nostartfiles};
else ifeq ($(findstring psu_cortexr5,$($(1)_PROC)),psu_cortexr5)
# for R5, ZynqMP
__$(1)_EXTRA_CCMD += \
	bsp config -append {extra_compiler_flags} {-mcpu=cortex-r5 -mfpu=vfpv3-d16 -mfloat-abi=hard};
else ifeq ($(findstring psv_cortexa72,$($(1)_PROC)),psv_cortexa72)
# for A72, Versal
__$(1)_EXTRA_CCMD += \
	bsp config -append {extra_compiler_flags} {-Dversal -DARMA72_EL3};
endif
endif

$(O)/$(2)/$$($(1)_PROC)/$(1)/bsp/Makefile: | $(O)/$(2)/hw/$(2)_init.stamp
	$(XSCT) -eval 'setws {$(O)}; \
		platform active {$(2)}; \
		domain create -name {$(1)} -proc {$$($(1)_PROC)} \
			-os {$$($(1)_OS)}; \
		$$(__$(1)_LIBS_CCMD) \
		$$(__$(1)_EXTRA_CCMD) \
		$$($(1)_POST_CREATE_TCL); \
		bsp regenerate'
ifneq ($$(strip $$($(1)_PATCH)),)
	$$(foreach PATCH,$$($(1)_PATCH),$(call patch-src,$(1),$$(PATCH))) :
endif
ifneq ($$(strip $$($(1)_SED)),)
	$$(foreach SED,$$($(1)_SED),$(call sed-src,$(1),$$(SED))) :
endif


$(O)/$(2)/export/$(2)/sw/$(2)/$(1)/bsplib/lib/libxil.a: $(O)/$(2)/$$($(1)_PROC)/$(1)/bsp/Makefile \
		$(O)/$(2)/hw/$(2).stamp
	$(XSCT) -eval 'setws {$(O)}; \
		platform active {$(2)}; \
		platform generate -domains {$(1)}'

# shortcut to create domain, "make <domain>"
$(1): $(O)/$(2)/export/$(2)/sw/$(2)/$(1)/bsplib/lib/libxil.a
.PHONY: $(1)

$(1)_distclean:
	-$(XSCT) -eval 'setws {$(O)}; \
		platform active {$(2)}; \
		domain remove -name {$(1)}'
.PHONY: $(1)_distclean
endef

###############################################################################
# Applications

# arg1: app name
# arg2: src file/folder name, scheme <srcfile>
# Paths are normalized because Vitis does not accept relative paths
define import-src
importsources -name $(1) -path [file normalize $(2)] -soft-link;
endef

# arg1: app name
# arg2: platform name
define gen-app-rule
$(1)_PROC ?= $($($(1)_DOMAIN)_PROC)
$(1)_TMPL ?= $(DEF_APP_TMPL)
$(1)_OS ?= $(DEF_APP_OS)
$(1)_LANG ?= $(DEF_APP_LANG)
$(1)_BCFG ?= $(DEF_APP_BCFG)
$(1)_OPT ?= $(DEF_APP_OPT)
$(1)_EXTRA_CFLAGS ?= $(DEF_APP_EXTRA_CFLAGS)
$(1)_LIBS ?=

ifneq ($$strip($$($(1)_CPPSYMS)),)
__$(1)_CPPSYMS_CCMD = $$(foreach SYM,$$($(1)_CPPSYMS), \
	app config -name {$(1)} define-compiler-symbols {$$(SYM)};)
endif
ifneq ($$strip($$($(1)_LIBS)),)
__$(1)_LIBS_CCMD = $$(foreach SYM,$$($(1)_LIBS), \
	app config -name {$(1)} -add libraries {$$(SYM)};)
endif
ifneq ($$($(1)_HW),)
$(O)/$(1)/src/lscript.ld:
	$(XSCT) -eval 'setws {$(O)}; \
		plat list; \
		exec sleep 3; \
		app create -name {$(1)} -hw {$$($(1)_HW)} \
			-proc {$$($(1)_PROC)} -template {$$($(1)_TMPL)} \
			-os {$$($(1)_OS)} -lang {$$($(1)_LANG)}'
else
ifneq ($$($(1)_PLAT),)
$(O)/$(1)/src/lscript.ld: | $(O)/$$($(1)_PLAT)/hw/$$($(1)_PLAT).stamp $(O)/$$($(1)_PLAT)/$$($(1)_PROC)/$$($(1)_DOMAIN)/bsp/Makefile
	$(XSCT) -eval 'setws {$(O)}; \
		plat list; \
		exec sleep 3; \
		app create -name {$(1)} -platform {$$($(1)_PLAT)} \
			-domain {$$($(1)_DOMAIN)} \
			-proc {$$($(1)_PROC)} -template {$$($(1)_TMPL)} \
			-os {$$($(1)_OS)} -lang {$$($(1)_LANG)}; \
		app config -name {$(1)} build-config {$$($(1)_BCFG)}; \
		app config -name {$(1)} compiler-optimization {$$($(1)_OPT)}; \
		app config -name {$(1)} -add compiler-misc {$$($(1)_EXTRA_CFLAGS)}; \
		$$(__$(1)_CPPSYMS_CCMD) \
		$$(__$(1)_LIBS_CCMD) \
		$$($(1)_POST_CREATE_TCL)'
else
$(O)/$(1)/src/lscript.ld: | $(O)/$(2)/hw/$(2).stamp $(O)/$(2)/$$($(1)_PROC)/$$($(1)_DOMAIN)/bsp/Makefile
	$(XSCT) -eval 'setws {$(O)}; \
		plat list; \
		exec sleep 3; \
		app create -name {$(1)} -platform {$(2)} \
			-domain {$$($(1)_DOMAIN)} \
			-proc {$$($(1)_PROC)} -template {$$($(1)_TMPL)} \
			-os {$$($(1)_OS)} -lang {$$($(1)_LANG)}; \
		app config -name {$(1)} build-config {$$($(1)_BCFG)}; \
		app config -name {$(1)} compiler-optimization {$$($(1)_OPT)}; \
		app config -name {$(1)} -add compiler-misc {$$($(1)_EXTRA_CFLAGS)}; \
		$$(__$(1)_CPPSYMS_CCMD) \
		$$(__$(1)_LIBS_CCMD) \
		$$($(1)_POST_CREATE_TCL)'
endif
endif
ifneq ($$(strip $$($(1)_SRC)),)
	$(XSCT) -eval 'setws {$(O)}; \
		$$(foreach SRC,$$($(1)_SRC),$(call import-src,$(1),$$(SRC)))'
endif
ifneq ($$(strip $$($(1)_PATCH)),)
	$$(foreach PATCH,$$($(1)_PATCH),$(call patch-src,$(1)/src,$$(PATCH))) :
endif
ifneq ($$(strip $$($(1)_SED)),)
	$$(foreach SED,$$($(1)_SED),$(call sed-src,$(1)/src,$$(SED))) :
endif

$(O)/$(1)/$$($(1)_BCFG)/makefile: $(O)/$(1)/src/lscript.ld
	$(XSCT) -eval 'setws {$(O)}; \
		app build -name {$(1)}'

$(O)/$(1)/$$($(1)_BCFG)/$(1).elf: $(O)/$(2)/export/$(2)/sw/$(2)/$$($(1)_DOMAIN)/bsplib/lib/libxil.a \
		$(O)/$(1)/$$($(1)_BCFG)/makefile $$($(1)_SRC)
	$(MAKE) -C $(O)/$(1)/$$($(1)_BCFG) all

GEN_APPS_DEP += $(O)/$(2)/export/$(2)/sw/$(2)/$$($(1)_DOMAIN)/bsplib/lib/libxil.a
BLD_APPS_DEP += $(O)/$(1)/$$($(1)_BCFG)/$(1).elf

# shortcut to create application, "make <app>"
$(1): $(O)/$(1)/$$($(1)_BCFG)/$(1).elf
.PHONY: $(1)

$(1)_clean:
	$(MAKE) -C $(O)/$(1)/$$($(1)_BCFG) clean
.PHONY: $(1)_clean

$(1)_distclean:
	-$(XSCT) -eval 'setws {$(O)}; \
		app remove {$(1)}'
.PHONY: $(1)_distclean

endef

###############################################################################
# JTAG boot

# arg1: path to platform file
# arg2: architecture
define gen-boot-jtag-rule
boot_jtag: $(O)/$(JTAG_PL_FILE) \
		$(O)/$(JTAG_FSBL_PRJ)/$$($(JTAG_FSBL_PRJ)_BCFG)/$(JTAG_FSBL_PRJ).elf \
		$(O)/$(JTAG_APP_PRJ)/$$($(JTAG_APP_PRJ)_BCFG)/$(JTAG_APP_PRJ).elf
ifeq ($(findstring zynqmp,$(2)),zynqmp)
	cd $(O) && \
	$(XSCT) -eval 'connect -url $(HW_SERVER_URL); \
		puts stderr "INFO: Resetting system..."; \
		targets -set -nocase -filter {name =~ "*APU*"}; \
		rst -srst; \
		after 1000; \
		puts stderr "INFO: Disabling JTAG security gates for DAP, PLTAP and PMU..."; \
		targets -set -filter {name =~ "PSU"}; \
		mwr 0xffca0038 0x1ff; \
		after 500; \
		if {[string trim "$(JTAG_PMU_PRJ)"] != ""} { \
			puts stderr "INFO: Downloading the PMU firmware..."; \
			targets -set -filter {name =~ "MicroBlaze PMU"}; \
			dow $(JTAG_PMU_PRJ)/$($(JTAG_PMU_PRJ)_BCFG)/$(JTAG_PMU_PRJ).elf; \
			con; \
			after 500; \
		}; \
		targets -set -nocase -filter {name =~ "*A53*#0"}; \
		rst -processor -clear-registers; \
		after 1000; \
		source ./$(PLAT_PRJ)/hw/psu_init.tcl; psu_post_config; \
		if { [string first "Stopped" [state]] != 0 } { \
			stop; \
		}; \
		puts stderr "INFO: Downloading FSBL to the target."; \
		dow $(JTAG_FSBL_PRJ)/$($(JTAG_FSBL_PRJ)_BCFG)/$(JTAG_FSBL_PRJ).elf; \
		con; \
		after 3000; stop; \
		puts stderr "INFO: Configuring the FPGA..."; \
		fpga $(JTAG_PL_ARG) $(JTAG_PL_FILE); \
		puts stderr "INFO: Downloading app to the target."; \
		dow $(JTAG_APP_PRJ)/$($(JTAG_APP_PRJ)_BCFG)/$(JTAG_APP_PRJ).elf; \
		puts stderr "INFO: Executing app."; \
		con; \
		exit;'
else ifeq ($(findstring zynq,$(2)),zynq)
	cd $(O) && \
	$(XSCT) -eval 'connect -url $(HW_SERVER_URL); \
		puts stderr "INFO: Resetting system..."; \
		targets -set -nocase -filter {name =~ "*APU*"}; \
		rst -srst; \
		after 1000; \
		targets -set -nocase -filter {name =~ "arm*#0"}; \
		rst -processor -clear-registers; \
		after 1000; \
		source ./$(PLAT_PRJ)/hw/ps7_init.tcl; ps7_post_config; \
		if { [string first "Stopped" [state]] != 0 } { \
			stop; \
		}; \
		puts stderr "INFO: Downloading FSBL to the target."; \
		dow $(JTAG_FSBL_PRJ)/$($(JTAG_FSBL_PRJ)_BCFG)/$(JTAG_FSBL_PRJ).elf; \
		con; \
		after 3000; stop; \
		puts stderr "INFO: Configuring the FPGA..."; \
		fpga $(JTAG_PL_ARG) $(JTAG_PL_FILE); \
		puts stderr "INFO: Downloading app to the target."; \
		dow $(JTAG_APP_PRJ)/$($(JTAG_APP_PRJ)_BCFG)/$(JTAG_APP_PRJ).elf; \
		puts stderr "INFO: Executing app."; \
		con; \
		exit;'
endif 
.PHONY: boot_jtag

boot_jtag_psonly: \
		$(O)/$(JTAG_FSBL_PRJ)/$($(JTAG_FSBL_PRJ)_BCFG)/$(JTAG_FSBL_PRJ).elf \
		$(O)/$(JTAG_APP_PRJ)/$($(JTAG_APP_PRJ)_BCFG)/$(JTAG_APP_PRJ).elf
ifeq ($(findstring zynqmp,$(2)),zynqmp)
	cd $(O) && \
	$(XSCT) -eval 'connect -url $(HW_SERVER_URL); \
		puts stderr "INFO: Disabling JTAG security gates for DAP, PLTAP and PMU..."; \
		targets -set -filter {name =~ "PSU"}; \
		mwr 0xffca0038 0x1ff; \
		after 500; \
		if {[string trim "$(JTAG_PMU_PRJ)"] != ""} { \
			puts stderr "INFO: Downloading the PMU firmware..."; \
			targets -set -filter {name =~ "MicroBlaze PMU"}; \
			dow $(JTAG_PMU_PRJ)/$($(JTAG_PMU_PRJ)_BCFG)/$(JTAG_PMU_PRJ).elf; \
			con; \
			after 500; \
		}; \
		targets -set -nocase -filter {name =~ "*A53*#0"}; \
		rst -processor -clear-registers; \
		after 1000; \
		source ./$(PLAT_PRJ)/hw/psu_init.tcl; psu_post_config; \
		if { [string first "Stopped" [state]] != 0 } { \
			stop; \
		}; \
		puts stderr "INFO: Downloading FSBL to the target."; \
		dow $(JTAG_FSBL_PRJ)/$($(JTAG_FSBL_PRJ)_BCFG)/$(JTAG_FSBL_PRJ).elf; \
		con; \
		after 3000; stop; \
		puts stderr "INFO: Downloading app to the target."; \
		dow $(JTAG_APP_PRJ)/$($(JTAG_APP_PRJ)_BCFG)/$(JTAG_APP_PRJ).elf; \
		puts stderr "INFO: Executing app."; \
		con; \
		exit;'
else ifeq ($(findstring zynq,$(2)),zynq)
	cd $(O) && \
	$(XSCT) -eval 'connect -url $(HW_SERVER_URL); \
		targets -set -nocase -filter {name =~ "arm*#0"}; \
		rst -processor -clear-registers; \
		after 1000; \
		source ./$(PLAT_PRJ)/hw/ps7_init.tcl; ps7_post_config; \
		if { [string first "Stopped" [state]] != 0 } { \
			stop; \
		}; \
		puts stderr "INFO: Downloading FSBL to the target."; \
		dow $(JTAG_FSBL_PRJ)/$($(JTAG_FSBL_PRJ)_BCFG)/$(JTAG_FSBL_PRJ).elf; \
		con; \
		after 3000; stop; \
		puts stderr "INFO: Downloading app to the target."; \
		dow $(JTAG_APP_PRJ)/$($(JTAG_APP_PRJ)_BCFG)/$(JTAG_APP_PRJ).elf; \
		puts stderr "INFO: Executing app."; \
		con; \
		exit;'
endif
.PHONY: boot_jtag_psonly

endef

###############################################################################
# Targets

# generate make rules for platform project, single
$(eval $(call gen-plat-rule,$(PLAT_PRJ),$(HDF)))
gethwplat: $(PLAT_PRJ)
.PHONY: gethwplat

# generate make rules for domains, multiple
$(foreach DOMAIN_PRJ,$(DOMAIN_PRJS),\
	$(eval $(call gen-domain-rule,$(DOMAIN_PRJ),$(PLAT_PRJ))))

# generate make rules for apps, multiple
$(foreach APP_PRJ,$(APP_PRJS),\
	$(eval $(call gen-app-rule,$(APP_PRJ),$(PLAT_PRJ))))

# generate make rules for bootgen projects, multiple
$(foreach BOOTGEN_PRJ,$(BOOTGEN_PRJS),\
	$(eval $(call gen-bif-rule,$(BOOTGEN_PRJ))))

# generate make rules for boot jtag project, single
$(eval $(call gen-boot-jtag-rule,$(HDF),$(JTAG_ARCH)))

# generate all projects
generate: $(GEN_APPS_DEP) $(GEN_BOOTGEN_DEP)
.PHONY: generate

# build all projects
build: $(BLD_APPS_DEP) $(BLD_BOOTGEN_DEP)
.PHONY: build

# open workspace in GUI mode
vitis:
	$(VITIS) -workspace $(O)
.PHONY: vitis

# do not execute any targets in parallel even if make is called with -j > 1 to 
# avoid Vitis workshop corruption
.NOTPARALLEL: