Makefile

   1 GHDL ?= ghdl
   2 GHDLFLAGS=--std=08 -frelaxed
   3 CFLAGS=-O3 -Wall
   4 CXXFLAGS=-g -g
   5
   6 GHDLSYNTH ?= ghdl.so
   7 YOSYS     ?= yosys
   8 NEXTPNR   ?= nextpnr-ecp5
   9 ECPPACK   ?= ecppack
  10 OPENOCD   ?= openocd
  11
  12 # We need a version of GHDL built with either the LLVM or gcc backend.
  13 # Fedora provides this, but other distros may not. Another option is to use
  14 # the Docker image.
  15 DOCKER ?= 0
  16 PODMAN ?= 0
  17
  18 ifeq ($(DOCKER), 1)
  19 DOCKERBIN=docker
  20 USE_DOCKER=1
  21 endif
  22
  23 ifeq ($(PODMAN), 1)
  24 DOCKERBIN=podman
  25 USE_DOCKER=1
  26 endif
  27
  28 ifeq ($(USE_DOCKER), 1)
  29 PWD = $(shell pwd)
  30 DOCKERARGS = run --rm -v $(PWD):/src:z -w /src
  31 GHDL      = $(DOCKERBIN) $(DOCKERARGS) ghdl/ghdl:buster-llvm-7 ghdl
  32 CC        = $(DOCKERBIN) $(DOCKERARGS) ghdl/ghdl:buster-llvm-7 gcc
  33 GHDLSYNTH = ghdl
  34 YOSYS     = $(DOCKERBIN) $(DOCKERARGS) hdlc/ghdl:yosys yosys
  35 NEXTPNR   = $(DOCKERBIN) $(DOCKERARGS) hdlc/nextpnr:ecp5 nextpnr-ecp5
  36 ECPPACK   = $(DOCKERBIN) $(DOCKERARGS) hdlc/prjtrellis ecppack
  37 OPENOCD   = $(DOCKERBIN) $(DOCKERARGS) --device /dev/bus/usb hdlc/prog openocd
  38 endif
  39
  40 all = core_tb icache_tb dcache_tb multiply_tb dmi_dtm_tb divider_tb \
  41         rotator_tb countzero_tb wishbone_bram_tb soc_reset_tb
  42
  43 all: $(all)
  44
  45 core_files = decode_types.vhdl common.vhdl wishbone_types.vhdl fetch1.vhdl \
  46         utils.vhdl plru.vhdl cache_ram.vhdl icache.vhdl \
  47         decode1.vhdl helpers.vhdl insn_helpers.vhdl \
  48         control.vhdl decode2.vhdl register_file.vhdl \
  49         cr_file.vhdl crhelpers.vhdl ppc_fx_insns.vhdl rotator.vhdl \
  50         logical.vhdl countzero.vhdl multiply.vhdl divider.vhdl execute1.vhdl \
  51         loadstore1.vhdl mmu.vhdl dcache.vhdl writeback.vhdl core_debug.vhdl \
  52         core.vhdl fpu.vhdl
  53
  54 _soc_files = wishbone_arbiter.vhdl wishbone_bram_wrapper.vhdl sync_fifo.vhdl \
  55         wishbone_debug_master.vhdl xics.vhdl syscon.vhdl soc.vhdl \
  56         spi_rxtx.vhdl spi_flash_ctrl.vhdl
  57
  58 soc_files = $(core_files) $(_soc_files)
  59
  60 uart_files = $(wildcard uart16550/*.v)
  61
  62 soc_sim_files = $(soc_files) sim_console.vhdl sim_pp_uart.vhdl sim_bram_helpers.vhdl \
  63         sim_bram.vhdl sim_jtag_socket.vhdl sim_jtag.vhdl dmi_dtm_xilinx.vhdl \
  64         sim_16550_uart.vhdl \
  65         random.vhdl glibc_random.vhdl glibc_random_helpers.vhdl
  66
  67 soc_sim_c_files = sim_vhpi_c.c sim_bram_helpers_c.c sim_console_c.c \
  68         sim_jtag_socket_c.c
  69
  70 soc_sim_obj_files=$(soc_sim_c_files:.c=.o)
  71 comma := ,
  72 soc_sim_link=$(patsubst %,-Wl$(comma)%,$(soc_sim_obj_files))
  73
  74 unisim_dir = sim-unisim
  75 unisim_lib = $(unisim_dir)/unisim-obj08.cf
  76 unisim_lib_files = $(unisim_dir)/BSCANE2.vhdl $(unisim_dir)/BUFG.vhdl \
  77         $(unisim_dir)/unisim_vcomponents.vhdl
  78 $(unisim_lib): $(unisim_lib_files)
  79         $(GHDL) -i --std=08 --work=unisim --workdir=$(unisim_dir) $^
  80 GHDLFLAGS += -P$(unisim_dir)
  81
  82 core_tbs = multiply_tb divider_tb rotator_tb countzero_tb
  83 soc_tbs = core_tb icache_tb dcache_tb dmi_dtm_tb wishbone_bram_tb
  84 soc_flash_tbs = core_flash_tb
  85 soc_dram_tbs = dram_tb core_dram_tb
  86
  87 ifneq ($(FLASH_MODEL_PATH),)
  88 fmf_dir = $(FLASH_MODEL_PATH)/fmf
  89 fmf_lib = $(fmf_dir)/fmf-obj08.cf
  90 fmf_lib_files = $(wildcard $(fmf_dir)/*.vhd)
  91 GHDLFLAGS += -P$(fmf_dir)
  92 $(fmf_lib): $(fmf_lib_files)
  93         $(GHDL) -i --std=08 --work=fmf --workdir=$(fmf_dir) $^
  94
  95 flash_model_files=$(FLASH_MODEL_PATH)/s25fl128s.vhd
  96 flash_model_files: $(fmf_lib)
  97 else
  98 flash_model_files=sim_no_flash.vhdl
  99 fmf_lib=
 100 endif
 101
 102 $(soc_flash_tbs): %: $(soc_sim_files) $(soc_sim_obj_files) $(unisim_lib) $(fmf_lib) $(flash_model_files) %.vhdl
 103         $(GHDL) -c $(GHDLFLAGS) $(soc_sim_link) $(soc_sim_files) $(flash_model_files) $@.vhdl $(unisim_files) -e $@
 104
 105 $(soc_tbs): %: $(soc_sim_files) $(soc_sim_obj_files) $(unisim_lib) %.vhdl
 106         $(GHDL) -c $(GHDLFLAGS) $(soc_sim_link) $(soc_sim_files) $@.vhdl -e $@
 107
 108 $(core_tbs): %: $(core_files) glibc_random.vhdl glibc_random_helpers.vhdl %.vhdl
 109         $(GHDL) -c $(GHDLFLAGS) $(core_files) glibc_random.vhdl glibc_random_helpers.vhdl $@.vhdl -e $@
 110
 111 soc_reset_tb: fpga/soc_reset_tb.vhdl fpga/soc_reset.vhdl
 112         $(GHDL) -c $(GHDLFLAGS) fpga/soc_reset_tb.vhdl fpga/soc_reset.vhdl -e $@
 113
 114 # LiteDRAM sim
 115 VERILATOR_ROOT=$(shell verilator -getenv VERILATOR_ROOT 2>/dev/null)
 116 ifeq (, $(VERILATOR_ROOT))
 117 $(soc_dram_tbs):
 118         $(error "Verilator is required to make this target !")
 119 else
 120
 121 VERILATOR_CFLAGS=-O3
 122 VERILATOR_FLAGS=-O3
 123 verilated_dram: litedram/generated/sim/litedram_core.v
 124         verilator $(VERILATOR_FLAGS) -CFLAGS $(VERILATOR_CFLAGS) -Wno-fatal --cc $< --trace
 125         make -C obj_dir -f ../litedram/extras/sim_dram_verilate.mk VERILATOR_ROOT=$(VERILATOR_ROOT)
 126
 127 SIM_DRAM_CFLAGS  = -I. -Iobj_dir -Ilitedram/generated/sim -I$(VERILATOR_ROOT)/include -I$(VERILATOR_ROOT)/include/vltstd
 128 SIM_DRAM_CFLAGS += -DVM_COVERAGE=0 -DVM_SC=0 -DVM_TRACE=1 -DVL_PRINTF=printf -faligned-new
 129 sim_litedram_c.o: litedram/extras/sim_litedram_c.cpp verilated_dram
 130         $(CC)  $(CPPFLAGS) $(SIM_DRAM_CFLAGS) $(CFLAGS) -c $< -o $@
 131
 132 soc_dram_files = $(soc_files) litedram/extras/litedram-wrapper-l2.vhdl litedram/generated/sim/litedram-initmem.vhdl
 133 soc_dram_sim_files = $(soc_sim_files) litedram/extras/sim_litedram.vhdl
 134 soc_dram_sim_obj_files = $(soc_sim_obj_files) sim_litedram_c.o
 135 dram_link_files=-Wl,obj_dir/Vlitedram_core__ALL.a -Wl,obj_dir/verilated.o -Wl,obj_dir/verilated_vcd_c.o -Wl,-lstdc++
 136 soc_dram_sim_link=$(patsubst %,-Wl$(comma)%,$(soc_dram_sim_obj_files)) $(dram_link_files)
 137
 138 $(soc_dram_tbs): %: $(soc_dram_files) $(soc_dram_sim_files) $(soc_dram_sim_obj_files) $(flash_model_files) $(unisim_lib) $(fmf_lib) %.vhdl
 139         $(GHDL) -c $(GHDLFLAGS) $(soc_dram_sim_link) $(soc_dram_files) $(soc_dram_sim_files) $(flash_model_files) $@.vhdl -e $@
 140 endif
 141
 142 # Hello world
 143 MEMORY_SIZE=8192
 144 RAM_INIT_FILE=hello_world/hello_world.hex
 145 SIM_MAIN_BRAM=false
 146
 147 # Micropython
 148 #MEMORY_SIZE=393216
 149 #RAM_INIT_FILE=micropython/firmware.hex
 150
 151 # Linux
 152 #MEMORY_SIZE=536870912
 153 #RAM_INIT_FILE=dtbImage.microwatt.hex
 154 #SIM_MAIN_BRAM=false
 155 SIM_BRAM_CHAINBOOT=6291456 # 0x600000
 156
 157 FPGA_TARGET ?= ORANGE-CRAB
 158
 159 clkgen=fpga/clk_gen_ecp5.vhd
 160 toplevel=fpga/top-generic.vhdl
 161 dmi_dtm=dmi_dtm_dummy.vhdl
 162
 163 # ULX3S with ECP85
 164 ifeq ($(FPGA_TARGET), ULX3S)
 165 RESET_LOW=true
 166 CLK_INPUT=25000000
 167 CLK_FREQUENCY=12500000
 168 LPF=constraints/ulx3s.lpf
 169 PACKAGE=CABGA381
 170 NEXTPNR_FLAGS=--85k --freq 25
 171 OPENOCD_JTAG_CONFIG=openocd/ulx3s.cfg
 172 OPENOCD_DEVICE_CONFIG=openocd/LFE5U-85F.cfg
 173 toplevel=fpga/top-ulx3s.vhdl
 174 endif
 175
 176 # OrangeCrab with ECP85
 177 ifeq ($(FPGA_TARGET), ORANGE-CRAB)
 178 RESET_LOW=true
 179 CLK_INPUT=50000000
 180 CLK_FREQUENCY=40000000
 181 LPF=constraints/orange-crab.lpf
 182 PACKAGE=CSFBGA285
 183 NEXTPNR_FLAGS=--um5g-85k --freq 40
 184 OPENOCD_JTAG_CONFIG=openocd/olimex-arm-usb-tiny-h.cfg
 185 OPENOCD_DEVICE_CONFIG=openocd/LFE5UM5G-85F.cfg
 186 endif
 187
 188 # ECP5-EVN
 189 ifeq ($(FPGA_TARGET), ECP5-EVN)
 190 RESET_LOW=true
 191 CLK_INPUT=12000000
 192 CLK_FREQUENCY=40000000
 193 LPF=constraints/ecp5-evn.lpf
 194 PACKAGE=CABGA381
 195 NEXTPNR_FLAGS=--um5g-85k --freq 40
 196 OPENOCD_JTAG_CONFIG=openocd/ecp5-evn.cfg
 197 OPENOCD_DEVICE_CONFIG=openocd/LFE5UM5G-85F.cfg
 198 endif
 199
 200
 201
 202 ifeq ($(FPGA_TARGET), verilator)
 203 RESET_LOW=true
 204 CLK_INPUT=50000000
 205 CLK_FREQUENCY=50000000
 206 clkgen=fpga/clk_gen_bypass.vhd
 207 endif
 208
 209 FPGA_MAIN_BRAM=fpga/main_bram.vhdl
 210 #FPGA_MAIN_BRAM=
 211
 212 _fpga_files = fpga/soc_reset.vhdl \
 213         fpga/pp_fifo.vhd fpga/pp_soc_uart.vhd $(FPGA_MAIN_BRAM) \
 214         nonrandom.vhdl
 215
 216 # use an alternative core (in verilog)
 217 EXTERNAL_CORE=false
 218 # VHDL does not allow integers greater than 2^32, so shift down
 219 # by 16 bits and add 16 bits zeros back on in soc-generic.vhdl
 220 RESET_ADDRESS=0 # 65280 # 0xff00_0000>>16
 221 ifeq ($(EXTERNAL_CORE),false)
 222     fpga_files = $(_fpga_files) $(_soc_files) $(core_files)
 223     synth_files = $(core_files) $(soc_files) $(fpga_files) $(clkgen) $(toplevel) $(dmi_dtm)
 224 else
 225     util_files = decode_types.vhdl common.vhdl wishbone_types.vhdl utils.vhdl \
 226                 core_dummy.vhdl
 227     fpga_files = $(_fpga_files) $(_soc_files)
 228     synth_files = $(util_files) $(fpga_files) $(clkgen) $(toplevel) $(dmi_dtm)
 229     soc_extra_v = external_core_top.v
 230 endif
 231
 232 GHDL_IMAGE_GENERICS=-gMEMORY_SIZE=$(MEMORY_SIZE) \
 233     -gRAM_INIT_FILE=$(RAM_INIT_FILE) \
 234         -gRESET_LOW=$(RESET_LOW) \
 235         -gRESET_ADDRESS=$(RESET_ADDRESS) \
 236     -gCLK_INPUT=$(CLK_INPUT) \
 237     -gCLK_FREQUENCY=$(CLK_FREQUENCY) \
 238         -gSIM_MAIN_BRAM=$(SIM_MAIN_BRAM) \
 239     -gSIM_BRAM_CHAINBOOT=$(SIM_BRAM_CHAINBOOT) \
 240         -gEXTERNAL_CORE=$(EXTERNAL_CORE)
 241
 242 microwatt.json: $(synth_files) $(RAM_INIT_FILE)
 243         $(YOSYS) -m $(GHDLSYNTH) -p \
 244                 "ghdl --std=08 --no-formal $(GHDL_IMAGE_GENERICS) \
 245                 $(GHDL_TARGET_GENERICS) $(synth_files) -e toplevel; \
 246                 read_verilog $(uart_files) $(soc_extra_v); \
 247                 synth_ecp5 -top toplevel -nowidelut -json $@  $(SYNTH_ECP5_FLAGS)"
 248
 249 microwatt.v: $(synth_files) $(RAM_INIT_FILE)
 250         $(YOSYS) -m $(GHDLSYNTH) -p "ghdl --std=08 --no-formal $(GHDL_IMAGE_GENERICS) $(GHDL_TARGET_GENERICS) $(synth_files) -e toplevel; write_verilog $@"
 251
 252 THREADS=1 # How many threads should be used for verilator binary
 253 # Need to investigate why yosys is hitting verilator warnings, and eventually turn on -Wall
 254 # --top-module toplevel
 255 microwatt-verilator: microwatt.v verilator/microwatt-verilator.cpp verilator/uart-verilator.c
 256         verilator -O3 -CFLAGS "-DCLK_FREQUENCY=$(CLK_FREQUENCY) -I../verilator" \
 257     --threads $(THREADS) \
 258     --assert \
 259     --cc microwatt.v \
 260     --exe verilator/microwatt-verilator.cpp verilator/uart-verilator.c \
 261     -o $@ -Iuart16550 \
 262         -Wno-fatal -Wno-CASEOVERLAP -Wno-UNOPTFLAT \
 263             -Wno-BLKANDNBLK \
 264             -Wno-COMBDLY  \
 265             -Wno-CASEINCOMPLETE \
 266             -Wno-WIDTH \
 267          --savable \
 268          --trace \
 269         #    --unroll-count 256 \
 270         #    --output-split 5000 \
 271         #    --output-split-cfuncs 500 \
 272         #    --output-split-ctrace 500 \
 273         make -C obj_dir -f Vmicrowatt.mk
 274         @cp -f obj_dir/microwatt-verilator microwatt-verilator
 275
 276 microwatt_out.config: microwatt.json $(LPF)
 277         $(NEXTPNR) --json $< --lpf $(LPF) --lpf-allow-unconstrained \
 278                     --textcfg $@.tmp $(NEXTPNR_FLAGS) --package $(PACKAGE)
 279         mv -f $@.tmp $@
 280
 281 microwatt.bit: microwatt_out.config
 282         $(ECPPACK) --svf microwatt.svf $< $@
 283
 284 microwatt.svf: microwatt.bit
 285
 286 prog: microwatt.svf
 287         $(OPENOCD) -f $(OPENOCD_JTAG_CONFIG) -f $(OPENOCD_DEVICE_CONFIG) -c "transport select jtag; init; svf $<; exit"
 288
 289 tests = $(sort $(patsubst tests/%.out,%,$(wildcard tests/*.out)))
 290 tests_console = $(sort $(patsubst tests/%.console_out,%,$(wildcard tests/*.console_out)))
 291
 292 tests_console: $(tests_console)
 293
 294 check: $(tests) tests_console test_micropython test_micropython_long tests_unit
 295
 296 check_light: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 test_micropython test_micropython_long tests_console tests_unit
 297
 298 $(tests): core_tb
 299         @./scripts/run_test.sh $@
 300
 301 $(tests_console): core_tb
 302         @./scripts/run_test_console.sh $@
 303
 304 test_micropython: core_tb
 305         @./scripts/test_micropython.py
 306
 307 test_micropython_long: core_tb
 308         @./scripts/test_micropython_long.py
 309
 310 tests_core_tb = $(patsubst %_tb,%_tb_test,$(core_tbs))
 311 tests_soc_tb = $(patsubst %_tb,%_tb_test,$(soc_tbs))
 312
 313 %_test: %
 314         ./$< --assert-level=error > /dev/null
 315
 316 tests_core: $(tests_core_tb)
 317
 318 tests_soc: $(tests_soc_tb)
 319
 320 # FIXME SOC tests have bit rotted, so disable for now
 321 #tests_unit: tests_core tests_soc
 322 tests_unit: tests_core
 323
 324 TAGS:
 325         find . -name '*.vhdl' | xargs ./scripts/vhdltags
 326
 327 .PHONY: TAGS
 328
 329 _clean:
 330         rm -f *.o *.cf $(all)
 331         rm -f fpga/*.o fpga/*.cf
 332         rm -f sim-unisim/*.o sim-unisim/*.cf
 333         rm -f litedram/extras/*.o
 334         rm -f TAGS
 335         rm -f scripts/mw_debug/*.o
 336         rm -f scripts/mw_debug/mw_debug
 337         rm -f microwatt.bin microwatt.json microwatt.svf microwatt_out.config
 338         rm -f microwatt.v microwatt-verilator
 339         rm -rf obj_dir/
 340
 341 clean: _clean
 342         make -f scripts/mw_debug/Makefile clean
 343         make -f hello_world/Makefile clean
 344
 345 distclean: _clean
 346         rm -f *~ fpga/*~ lib/*~ console/*~ include/*~
 347         rm -rf litedram/build
 348         rm -f litedram/extras/*~
 349         rm -f litedram/gen-src/*~
 350         rm -f litedram/gen-src/sdram_init/*~
 351         make -f scripts/mw_debug/Makefile distclean
 352         make -f hello_world/Makefile distclean
 353
 354 .PHONY: all prog check check_light clean distclean
 355 .PRECIOUS: microwatt.json microwatt_out.config microwatt.bit