Martin Braun
6ef3795e42
- All RFNoC capable targets now require rfnoc_image_builder to be built - `make help` is updated for all targets to provide more useful and up-to-date information - The FPGA manual is also updated - All checked-in build artifacts are now removed from git - axi_ram_fifo.yml is updated to provide include path information (required for building N3xx BIST images, which use this) Original-commit: 28b994406d4c9547b1e2add62781b6a8162fdb74
214 lines
7.5 KiB
Makefile
214 lines
7.5 KiB
Makefile
#
|
|
# Copyright 2012-2016 Ettus Research LLC
|
|
#
|
|
|
|
# NOTE: All comments prefixed with a "##" will be displayed as a part of the "make help" target
|
|
##-------------------
|
|
##USRP X3X0 FPGA Help
|
|
##-------------------
|
|
##Usage:
|
|
## rfnoc_image_builder -y <image core file> [-t <target>]
|
|
##
|
|
## NOTE: For building X3x0 bitfiles, do not run make directly! Instead, use
|
|
## rfnoc_image_builder. It will create all intermediate files, set up a Vivado
|
|
## environment, and run Vivado to build a bitfile.
|
|
##
|
|
## There exist some special make targets which can be called directly like this:
|
|
##
|
|
## make <Targets> <Options>
|
|
##
|
|
##Output:
|
|
## $(BUILD_OUTPUT_DIR)/usrp_<product>_fpga_<image_type>.bit: Configuration bitstream with header
|
|
## $(BUILD_OUTPUT_DIR)/usrp_<product>_fpga_<image_type>.bin: Configuration bitstream without header
|
|
## $(BUILD_OUTPUT_DIR)/usrp_<product>_fpga_<image_type>.lvbitx: Configuration bitstream for PCIe (NI-RIO)
|
|
## $(BUILD_OUTPUT_DIR)/usrp_<product>_fpga_<image_type>.rpt: Build report (includes utilization and timing summary)
|
|
|
|
# Debug Options
|
|
# Uncomment the following line to add a debug UART on GPIO 10 & 11
|
|
#OPTIONS += DEBUG_UART=1
|
|
|
|
CREATE_LVBITX=python3 ../../lib/io_port2/create-lvbitx.py
|
|
|
|
# Base output directory for all builds.
|
|
BUILD_BASE_DIR ?= .
|
|
# Base directory for the build outputs.
|
|
BUILD_OUTPUT_DIR ?= $(BUILD_BASE_DIR)/build
|
|
|
|
# Initialize a build seed. This can be changed to randomly affect build results.
|
|
BUILD_SEED ?= 0
|
|
|
|
GIGE_DEFS=BUILD_1G=1 SFP0_1GBE=1 SFP1_1GBE=1 $(OPTIONS) BUILD_SEED=$(BUILD_SEED)
|
|
HG_DEFS=BUILD_1G=1 BUILD_10G=1 SFP0_1GBE=1 SFP1_10GBE=1 $(OPTIONS) BUILD_SEED=$(BUILD_SEED)
|
|
XG_DEFS=BUILD_10G=1 SFP0_10GBE=1 SFP1_10GBE=1 $(OPTIONS) BUILD_SEED=$(BUILD_SEED)
|
|
HA_DEFS=BUILD_1G=1 BUILD_AURORA=1 SFP0_1GBE=1 SFP1_AURORA=1 $(OPTIONS) BUILD_SEED=$(BUILD_SEED)
|
|
XA_DEFS=BUILD_10G=1 BUILD_AURORA=1 SFP0_10GBE=1 SFP1_AURORA=1 $(OPTIONS) BUILD_SEED=$(BUILD_SEED)
|
|
|
|
# Set build option (check RTL, run synthesis, or do a full build)
|
|
ifndef TARGET
|
|
ifeq ($(CHECK), 1)
|
|
TARGET = rtl
|
|
else ifeq ($(SYNTH), 1)
|
|
TARGET = synth
|
|
else ifeq ($(IP_ONLY), 1)
|
|
TARGET = viv_ip
|
|
else
|
|
TARGET = bin
|
|
endif
|
|
endif
|
|
TOP ?= x300
|
|
|
|
# vivado_build($1=Device, $2=Definitions)
|
|
vivado_build = make -f Makefile.x300.inc $(TARGET) NAME=$@ ARCH=$(XIL_ARCH_$1) PART_ID=$(XIL_PART_ID_$1) $2 TOP_MODULE=$(TOP) EXTRA_DEFS="$2"
|
|
vivado_ip = make -f Makefile.x300.inc viv_ip NAME=$@ ARCH=$(XIL_ARCH_$1) PART_ID=$(XIL_PART_ID_$1) $2 TOP_MODULE=$(TOP) EXTRA_DEFS="$2"
|
|
|
|
# post_build($1=Device, $2=Option)
|
|
ifeq ($(TARGET),bin)
|
|
post_build = @\
|
|
mkdir -p $(BUILD_OUTPUT_DIR); \
|
|
echo "Exporting bitstream files..."; \
|
|
cp $(BUILD_DIR)/x300.bin $(BUILD_OUTPUT_DIR)/$(IMAGE_CORE_NAME).bin; \
|
|
cp $(BUILD_DIR)/x300.bit $(BUILD_OUTPUT_DIR)/$(IMAGE_CORE_NAME).bit; \
|
|
echo "Generating LVBITX..."; \
|
|
$(CREATE_LVBITX) --input-bin=$(BUILD_DIR)/x300.bin --output-lvbitx=$(BUILD_OUTPUT_DIR)/$(IMAGE_CORE_NAME).lvbitx --device="USRP $(1)" x3x0_base.lvbitx; \
|
|
cp -f x3x0_base.lvbitx $(BUILD_OUTPUT_DIR)/`echo $(1) | tr A-Z a-z`.lvbitx_base; \
|
|
echo "Exporting build report..."; \
|
|
cp $(BUILD_DIR)/build.rpt $(BUILD_OUTPUT_DIR)/$(IMAGE_CORE_NAME).rpt; \
|
|
echo "Build DONE ... $(1)_$(2)";
|
|
else
|
|
post_build = @echo "Skipping bitfile export."
|
|
endif
|
|
|
|
##
|
|
##Supported Targets
|
|
##-----------------
|
|
##
|
|
##Reminder: Targets are built by calling
|
|
##
|
|
## $ rfnoc_image_builder -y <image core file.yml> [-t <target>]
|
|
##
|
|
##The default <image core file.yml> is one of:
|
|
##
|
|
##- x300_HG_rfnoc_image_core.yml
|
|
##- x300_XG_rfnoc_image_core.yml
|
|
##- x310_HG_rfnoc_image_core.yml
|
|
##- x310_XG_rfnoc_image_core.yml
|
|
##
|
|
##Of course, a custom YAML file may be used.
|
|
##
|
|
##When building a bitfile for X310, use a x310_*.yml file, otherwise, for X300,
|
|
##use a x300_*.yml file.
|
|
##
|
|
##When building an XG bitfile (dual 10-Gigabit Ethernet), use the
|
|
##*_XG_rfnoc_image_core.yml file. When building an HG bitfile (1-Gigabit and
|
|
##10 Gigabit Ethernet), use a *_HG_rfnoc_image_core.yml file. In these cases,
|
|
##using '--target' is not necessary, but it doesn't do any harm, either.
|
|
##
|
|
##For all other targets, choose a suitable target image core YAML file depending
|
|
##on the device type (x310_*.yml or x300_*.yml) and provide the '--target' option
|
|
##to override the default from the YAML file.
|
|
##
|
|
##Example:
|
|
## $ rfnoc_image_builder -y x310_XG_rfnoc_image_core.yml -t X310_XA
|
|
##will build the X310_XA target.
|
|
##
|
|
|
|
check-variables:
|
|
ifndef IMAGE_CORE_NAME
|
|
$(error IMAGE_CORE_NAME is not set! Use rfnoc_image_builder to create valid make commands)
|
|
endif
|
|
ifndef BUILD_DIR
|
|
$(error BUILD_DIR is not set! Use rfnoc_image_builder to create valid make commands)
|
|
endif
|
|
|
|
##X310_1G: 1GigE on both SFP+ ports.
|
|
X310_1G: check-variables X310_IP
|
|
$(call vivado_build,X310,$(GIGE_DEFS) X310=1)
|
|
$(call post_build,X310,1G)
|
|
|
|
##X300_1G: 1GigE on both SFP+ ports.
|
|
X300_1G: check-variables X300_IP
|
|
$(call vivado_build,X300,$(GIGE_DEFS) X300=1)
|
|
$(call post_build,X300,1G)
|
|
|
|
##X310_HG: 1GigE on SFP+ Port0, 10Gig on SFP+ Port1.
|
|
X310_HG: check-variables X310_IP
|
|
$(call vivado_build,X310,$(HG_DEFS) X310=1)
|
|
$(call post_build,X310,HG)
|
|
|
|
##X300_HG: 1GigE on SFP+ Port0, 10Gig on SFP+ Port1.
|
|
X300_HG: check-variables X300_IP
|
|
$(call vivado_build,X300,$(HG_DEFS) X300=1)
|
|
$(call post_build,X300,HG)
|
|
|
|
##X310_XG: 10GigE on both SFP+ ports.
|
|
X310_XG: check-variables X310_IP
|
|
$(call vivado_build,X310,$(XG_DEFS) X310=1)
|
|
$(call post_build,X310,XG)
|
|
|
|
##X300_XG: 10GigE on both SFP+ ports.
|
|
X300_XG: check-variables X300_IP
|
|
$(call vivado_build,X300,$(XG_DEFS) X300=1)
|
|
$(call post_build,X300,XG)
|
|
|
|
##X310_HA: 1Gig on SFP+ Port0, Aurora on SFP+ Port1.
|
|
X310_HA: check-variables X310_IP
|
|
$(call vivado_build,X310,$(HA_DEFS) X310=1)
|
|
$(call post_build,X310,HA)
|
|
|
|
##X300_HA: 1Gig on SFP+ Port0, Aurora on SFP+ Port1.
|
|
X300_HA: check-variables X300_IP
|
|
$(call vivado_build,X300,$(HA_DEFS) X300=1)
|
|
$(call post_build,X300,HA)
|
|
|
|
##X310_XA: 10Gig on SFP+ Port0, Aurora on SFP+ Port1.
|
|
X310_XA: check-variables X310_IP
|
|
$(call vivado_build,X310,$(XA_DEFS) X310=1)
|
|
$(call post_build,X310,XA)
|
|
|
|
##X300_XA: 10Gig on SFP+ Port0, Aurora on SFP+ Port1.
|
|
X300_XA: check-variables X300_IP
|
|
$(call vivado_build,X300,$(XA_DEFS) X300=1)
|
|
$(call post_build,X300,XA)
|
|
|
|
|
|
|
|
##
|
|
##Other Make Targets (these should be called directly)
|
|
##----------------------------------------------------
|
|
|
|
##X300_IP: Build IP for X300 only. Use the -j option to build multiple IP blocks simultaneously.
|
|
X300_IP:
|
|
+$(call vivado_ip,X300,$(HG_DEFS) X300=1)
|
|
|
|
##X310_IP: Build IP for X310 only. Use the -j option to build multiple IP blocks simultaneously.
|
|
X310_IP:
|
|
+$(call vivado_ip,X310,$(HG_DEFS) X310=1)
|
|
|
|
|
|
clean: ##Clean up all target build outputs.
|
|
@echo "Cleaning targets..."
|
|
@rm -rf $(BUILD_BASE_DIR)/build-X3*_* $(BUILD_BASE_DIR)/build-x3* $(BUILD_DIR)
|
|
@rm -rf $(BUILD_OUTPUT_DIR)
|
|
|
|
cleanall: ##Clean up all target and ip build outputs.
|
|
@echo "Cleaning targets and IP..."
|
|
@rm -rf build-ip
|
|
@rm -rf $(BUILD_BASE_DIR)/build-X3*_* $(BUILD_BASE_DIR)/build-x3* $(BUILD_DIR)
|
|
@rm -rf $(BUILD_OUTPUT_DIR)
|
|
|
|
help: ##Show this help message.
|
|
@grep -h "##" Makefile | grep -v "\"##\"" | sed -e 's/\\$$//' | sed -e 's/##//'
|
|
|
|
##
|
|
##Supported Options
|
|
##-----------------
|
|
##GUI=1 Launch the build in the Vivado GUI.
|
|
##PROJECT=1 Save Vivado project file, otherwise it's created in memory.
|
|
##CHECK=1 Launch the syntax checker instead of building a bitfile.
|
|
##IP_ONLY=1 Launch the build but stop after IP generation.
|
|
##SYNTH=1 Launch the build but stop after synthesis.
|
|
##BUILD_SEED=<N> Build seed to used to affect build results. (Default is 0)
|
|
##TOP=<module> Specify a top module for syntax checking. (Default is the bitfile top)
|
|
|
|
.PHONY: all clean cleanall help
|