238 lines
10 KiB
Makefile
238 lines
10 KiB
Makefile
#########################################################################################
|
|
# makefile variables shared across multiple makefiles
|
|
# - to use the help text, your Makefile should have a 'help' target that just
|
|
# prints all the HELP_LINES
|
|
#########################################################################################
|
|
HELP_COMPILATION_VARIABLES =
|
|
HELP_PROJECT_VARIABLES = \
|
|
" SUB_PROJECT = use the specific subproject default variables [$(SUB_PROJECT)]" \
|
|
" SBT_PROJECT = the SBT project that you should find the classes/packages in [$(SBT_PROJECT)]" \
|
|
" MODEL = the top level module of the project in Chisel (normally the harness) [$(MODEL)]" \
|
|
" VLOG_MODEL = the top level module of the project in Firrtl/Verilog (normally the harness) [$(VLOG_MODEL)]" \
|
|
" MODEL_PACKAGE = the scala package to find the MODEL in [$(MODEL_PACKAGE)]" \
|
|
" CONFIG = the configuration class to give the parameters for the project [$(CONFIG)]" \
|
|
" CONFIG_PACKAGE = the scala package to find the CONFIG class [$(CONFIG_PACKAGE)]" \
|
|
" GENERATOR_PACKAGE = the scala package to find the Generator class in [$(GENERATOR_PACKAGE)]" \
|
|
" TB = testbench wrapper over the TestHarness needed to simulate in a verilog simulator [$(TB)]" \
|
|
" TOP = top level module of the project (normally the module instantiated by the harness) [$(TOP)]"
|
|
|
|
HELP_SIMULATION_VARIABLES = \
|
|
" BINARY = riscv elf binary that the simulator will run when using the run-binary* targets" \
|
|
" VERBOSE_FLAGS = flags used when doing verbose simulation [$(VERBOSE_FLAGS)]"
|
|
|
|
# include default simulation rules
|
|
HELP_COMMANDS = \
|
|
" help = display this help" \
|
|
" default = compiles non-debug simulator [./$(shell basename $(sim))]" \
|
|
" debug = compiles debug simulator [./$(shell basename $(sim_debug))]" \
|
|
" clean = remove all debug/non-debug simulators and intermediate files" \
|
|
" clean-sim = removes non-debug simulator and simulator-generated files" \
|
|
" clean-sim-debug = removes debug simulator and simulator-generated files"
|
|
|
|
HELP_LINES = "" \
|
|
" design specifier variables:" \
|
|
" ---------------------------" \
|
|
$(HELP_PROJECT_VARIABLES) \
|
|
"" \
|
|
" compilation variables:" \
|
|
" ----------------------" \
|
|
$(HELP_COMPILATION_VARIABLES) \
|
|
"" \
|
|
" simulation variables:" \
|
|
" ---------------------" \
|
|
$(HELP_SIMULATION_VARIABLES) \
|
|
"" \
|
|
" some useful general commands:" \
|
|
" -----------------------------" \
|
|
$(HELP_COMMANDS) \
|
|
""
|
|
|
|
#########################################################################################
|
|
# subproject overrides
|
|
# description:
|
|
# - make it so that you only change 1 param to change most or all of them!
|
|
# - mainly intended for quick developer setup for common flags
|
|
#########################################################################################
|
|
SUB_PROJECT ?= chipyard
|
|
|
|
ifeq ($(SUB_PROJECT),chipyard)
|
|
SBT_PROJECT ?= chipyard
|
|
MODEL ?= TestHarness
|
|
VLOG_MODEL ?= TestHarness
|
|
MODEL_PACKAGE ?= $(SBT_PROJECT)
|
|
CONFIG ?= RocketConfig
|
|
CONFIG_PACKAGE ?= $(SBT_PROJECT)
|
|
GENERATOR_PACKAGE ?= $(SBT_PROJECT)
|
|
TB ?= TestDriver
|
|
TOP ?= ChipTop
|
|
endif
|
|
# for Hwacha developers
|
|
ifeq ($(SUB_PROJECT),hwacha)
|
|
SBT_PROJECT ?= chipyard
|
|
MODEL ?= TestHarness
|
|
VLOG_MODEL ?= TestHarness
|
|
MODEL_PACKAGE ?= freechips.rocketchip.system
|
|
CONFIG ?= HwachaConfig
|
|
CONFIG_PACKAGE ?= hwacha
|
|
GENERATOR_PACKAGE ?= chipyard
|
|
TB ?= TestDriver
|
|
TOP ?= ExampleRocketSystem
|
|
endif
|
|
# For TestChipIP developers
|
|
ifeq ($(SUB_PROJECT),testchipip)
|
|
SBT_PROJECT ?= chipyard
|
|
MODEL ?= TestHarness
|
|
VLOG_MODEL ?= TestHarness
|
|
MODEL_PACKAGE ?= chipyard.unittest
|
|
CONFIG ?= TestChipUnitTestConfig
|
|
CONFIG_PACKAGE ?= testchipip
|
|
GENERATOR_PACKAGE ?= chipyard
|
|
TB ?= TestDriver
|
|
TOP ?= UnitTestSuite
|
|
endif
|
|
# For IceNet developers
|
|
ifeq ($(SUB_PROJECT),icenet)
|
|
SBT_PROJECT ?= chipyard
|
|
MODEL ?= TestHarness
|
|
VLOG_MODEL ?= TestHarness
|
|
MODEL_PACKAGE ?= chipyard.unittest
|
|
CONFIG ?= IceNetUnitTestConfig
|
|
CONFIG_PACKAGE ?= icenet
|
|
GENERATOR_PACKAGE ?= chipyard
|
|
TB ?= TestDriver
|
|
TOP ?= UnitTestSuite
|
|
endif
|
|
|
|
#########################################################################################
|
|
# path to rocket-chip and testchipip
|
|
#########################################################################################
|
|
ROCKETCHIP_DIR = $(base_dir)/generators/rocket-chip
|
|
TESTCHIP_DIR = $(base_dir)/generators/testchipip
|
|
CHIPYARD_FIRRTL_DIR = $(base_dir)/tools/firrtl
|
|
|
|
#########################################################################################
|
|
# names of various files needed to compile and run things
|
|
#########################################################################################
|
|
long_name = $(MODEL_PACKAGE).$(MODEL).$(CONFIG)
|
|
ifeq ($(GENERATOR_PACKAGE),hwacha)
|
|
long_name=$(MODEL_PACKAGE).$(CONFIG)
|
|
endif
|
|
|
|
FIRRTL_FILE ?= $(build_dir)/$(long_name).fir
|
|
ANNO_FILE ?= $(build_dir)/$(long_name).anno.json
|
|
|
|
TOP_FILE ?= $(build_dir)/$(long_name).top.v
|
|
TOP_FIR ?= $(build_dir)/$(long_name).top.fir
|
|
TOP_ANNO ?= $(build_dir)/$(long_name).top.anno.json
|
|
TOP_SMEMS_FILE ?= $(build_dir)/$(long_name).top.mems.v
|
|
TOP_SMEMS_CONF ?= $(build_dir)/$(long_name).top.mems.conf
|
|
TOP_SMEMS_FIR ?= $(build_dir)/$(long_name).top.mems.fir
|
|
|
|
HARNESS_FILE ?= $(build_dir)/$(long_name).harness.v
|
|
HARNESS_FIR ?= $(build_dir)/$(long_name).harness.fir
|
|
HARNESS_ANNO ?= $(build_dir)/$(long_name).harness.anno.json
|
|
HARNESS_SMEMS_FILE ?= $(build_dir)/$(long_name).harness.mems.v
|
|
HARNESS_SMEMS_CONF ?= $(build_dir)/$(long_name).harness.mems.conf
|
|
HARNESS_SMEMS_FIR ?= $(build_dir)/$(long_name).harness.mems.fir
|
|
|
|
# files that contain lists of files needed for VCS or Verilator simulation
|
|
sim_files ?= $(build_dir)/sim_files.f
|
|
sim_top_blackboxes ?= $(build_dir)/firrtl_black_box_resource_files.top.f
|
|
sim_harness_blackboxes ?= $(build_dir)/firrtl_black_box_resource_files.harness.f
|
|
# single file that contains all files needed for VCS or Verilator simulation (unique and without .h's)
|
|
sim_common_files ?= $(build_dir)/sim_files.common.f
|
|
|
|
#########################################################################################
|
|
# java arguments used in sbt
|
|
#########################################################################################
|
|
JAVA_HEAP_SIZE ?= 8G
|
|
JAVA_ARGS ?= -Xmx$(JAVA_HEAP_SIZE) -Xss8M -XX:MaxPermSize=256M
|
|
|
|
#########################################################################################
|
|
# default sbt launch command
|
|
#########################################################################################
|
|
# Running with sbt-launch.jar doesn't read .sbtopts by default
|
|
# # Set if the file exists (if it exists, we're building chisel3 and firrtl from source)
|
|
sbtopts_file := $(base_dir)/.sbtopts
|
|
ifneq (,$(wildcard $(sbtopts_file)))
|
|
SBT_OPTS ?= $(shell cat $(sbtopts_file))
|
|
endif
|
|
|
|
SCALA_VERSION=2.12.10
|
|
SCALA_VERSION_MAJOR=$(basename $(SCALA_VERSION))
|
|
SBT ?= java $(JAVA_ARGS) -jar $(ROCKETCHIP_DIR)/sbt-launch.jar $(SBT_OPTS)
|
|
|
|
BLOOP ?= bloop
|
|
BLOOP_CONFIG_DIR ?= $(base_dir)/.bloop
|
|
# This mirrors the bloop default. Set to a system-unique port in a multi-user environment
|
|
BLOOP_NAILGUN_PORT ?= 8212
|
|
|
|
SCALA_BUILDTOOL_DEPS = $(SBT_SOURCES)
|
|
|
|
ifdef ENABLE_BLOOP
|
|
override SCALA_BUILDTOOL_DEPS += $(BLOOP_CONFIG_DIR)/TIMESTAMP
|
|
# Two notes about the bloop invocation:
|
|
# 1) the sed removes a leading {file:<path>} that sometimes needs to be
|
|
# provided to SBT when a project but not for bloop.
|
|
# 2) Generally, one could could pass '--' to indicate all remaining arguments are
|
|
# destined for the scala Main, however a bug in Bloop's argument parsing causes the
|
|
# --nailgun-port argument to be lost in this case. Workaround this by prefixing
|
|
# every main-destined argument with "--args"
|
|
define run_scala_main
|
|
cd $(base_dir) && bloop --nailgun-port $(BLOOP_NAILGUN_PORT) run $(shell echo $(1) | sed 's/{.*}//') --main $(2) $(addprefix --args ,$3)
|
|
endef
|
|
else
|
|
define run_scala_main
|
|
cd $(base_dir) && $(SBT) "project $(1)" "runMain $(2) $(3)"
|
|
endef
|
|
endif
|
|
|
|
FIRRTL_LOGLEVEL ?= error
|
|
|
|
#########################################################################################
|
|
# output directory for tests
|
|
#########################################################################################
|
|
output_dir=$(sim_dir)/output/$(long_name)
|
|
|
|
#########################################################################################
|
|
# helper variables to run binaries
|
|
#########################################################################################
|
|
PERMISSIVE_ON=+permissive
|
|
PERMISSIVE_OFF=+permissive-off
|
|
BINARY ?=
|
|
LOADMEM ?=
|
|
LOADMEM_ADDR ?= 81000000
|
|
override SIM_FLAGS += +dramsim +dramsim_ini_dir=$(TESTCHIP_DIR)/src/main/resources/dramsim2_ini +max-cycles=$(timeout_cycles)
|
|
ifneq ($(LOADMEM),)
|
|
override SIM_FLAGS += +loadmem=$(LOADMEM) +loadmem_addr=$(LOADMEM_ADDR)
|
|
endif
|
|
VERBOSE_FLAGS ?= +verbose
|
|
sim_out_name = $(output_dir)/$(subst $() $(),_,$(notdir $(basename $(BINARY))))
|
|
binary_hex= $(sim_out_name).loadmem_hex
|
|
|
|
#########################################################################################
|
|
# build output directory for compilation
|
|
#########################################################################################
|
|
gen_dir=$(sim_dir)/generated-src
|
|
build_dir=$(gen_dir)/$(long_name)
|
|
|
|
#########################################################################################
|
|
# vsrcs needed to run projects
|
|
#########################################################################################
|
|
rocketchip_vsrc_dir = $(ROCKETCHIP_DIR)/src/main/resources/vsrc
|
|
|
|
#########################################################################################
|
|
# sources needed to run simulators
|
|
#########################################################################################
|
|
sim_vsrcs = \
|
|
$(TOP_FILE) \
|
|
$(HARNESS_FILE) \
|
|
$(TOP_SMEMS_FILE) \
|
|
$(HARNESS_SMEMS_FILE)
|
|
|
|
#########################################################################################
|
|
# assembly/benchmark variables
|
|
#########################################################################################
|
|
timeout_cycles = 10000000
|
|
bmark_timeout_cycles = 100000000
|