add initial J1b support for ULX3S board

This patch adds initial J1b support for the ULX3S board, which is based on the
Lattice ECP5 FPGA and can be programmed with either the Trellis (Yosys) or
Diamond (vendor) toolchain.

Currently only the J1b core and UART are hooked up. So no LEDs, GPIO ports,
buttons, SDRAM, etc.. support yet.

You can connect to the core with the `shell.py` script, and you can replicate
the bootstap process: compiling swapforth.fs, writing out a new nuc.hex file
containing the new words and creating a new bitstream containing the new `.hex`
file. Flashing that on the ULX3S seems to replicate a functioning Forth system.

The `bram` and `ram16k` modules were split out from the `xilinx-top.v` file into
`ram.v` to foster some code reuse. Thanks to improved handling of bram within
Yosys, the modules could be reused as is.

Note that the changes weren't tested on either the Diamond or Xilinx
toolchains. The changes to Xilinx parts were minimal so hopefully no regression
was introduced. As for Diamond, it made sense to me to include the
Makefile-related parts needed to compile for Diamond to aid others wanting to
make this work.

j1b/ulx3s/Makefile

@@ -0,0 +1,29 @@
+# ******* project, board and chip name *******
+PROJECT = swapforth
+BOARD = ulx3s
+# 12 25 45 85
+FPGA_SIZE = 85
+
+# ******* design files *******
+CONSTRAINTS = ulx3s_v20_segpdi.lpf
+TOP_MODULE = ulx3s_top
+PREFIX = ../verilog
+TOP_MODULE_FILE = $(PREFIX)/$(TOP_MODULE).v
+
+VERILOG_FILES = \
+$(TOP_MODULE_FILE) \
+$(PREFIX)/j1.v \
+$(PREFIX)/ram.v \
+$(PREFIX)/uart.v \
+$(PREFIX)/stack.v \
+
+# *.vhd those files will be converted to *.v files with vhdl2vl (warning overwriting/deleting)
+VHDL_FILES = \
+
+YOSYS_OPTIONS = -abc9
+NEXTPNR_OPTIONS = --timing-allow-fail
+
+SCRIPTS = scripts
+include $(SCRIPTS)/diamond_path.mk
+include $(SCRIPTS)/trellis_path.mk
+include $(SCRIPTS)/trellis_main.mk

j1b/ulx3s/README.md

@@ -0,0 +1,18 @@
+The ULX3S board is based upon the Lattice ECP5 FPGA. It's a it's a prototype
+board with lots of features in a small form factor. For more info, see
+https://ulx3s.github.io.
+
+Currently the only tested toolchain is Trellis (or rather the tools associated
+with Trellis).
+
+As with the other supported platforms, have the Trellis tools installed, and run
+make in this directory to create a bitstream. Run fujprog to install it over
+USB:
+
+  fujprog ulx3s_85f_swapforth.bit
+
+Now you can use `shell.py` in the parent directory to attach to the Forth
+process over UART. The Verilator bootstrap process will also work for ULX3S.
+
+Currently only J1b itself and UART are supported. Support for low-hanging fruit
+like GPIOs, buttons and LEDs should follow shortly.

j1b/ulx3s/makefile.diamond

@@ -0,0 +1,31 @@
+# ******* project, board and chip name *******
+PROJECT = swapforth_hex
+BOARD = ulx3s
+# 12 25 45 85
+FPGA_SIZE = 12
+FPGA_PACKAGE = 6bg381c
+# config flash: 1:SPI (standard), 4:QSPI (quad)
+FLASH_SPI = 4
+# chip: is25lp032d is25lp128f s25fl164k
+FLASH_CHIP = is25lp128f
+
+# ******* design files *******
+CONSTRAINTS = ulx3s_v20_segpdi.lpf
+TOP_MODULE = ulx3s_top
+PREFIX = ../verilog
+TOP_MODULE_FILE = $(PREFIX)/$(TOP_MODULE).v
+
+VERILOG_FILES = \
+$(TOP_MODULE_FILE) \
+$(PREFIX)/j1.v \
+$(PREFIX)/ram.v \
+$(PREFIX)/uart.v \
+$(PREFIX)/stack.v \
+
+# *.vhd those files will be converted to *.v files with vhdl2vl (warning overwriting/deleting)
+VHDL_FILES = \
+
+SCRIPTS = ../../../../scripts/
+include $(SCRIPTS)/trellis_path.mk
+include $(SCRIPTS)/diamond_path.mk
+include $(SCRIPTS)/diamond_main.mk

j1b/ulx3s/scripts/diamond_main.mk

@@ -0,0 +1,285 @@
+# ******* project, board and chip name *******
+PROJECT ?= project
+BOARD ?= board
+FPGA_SIZE ?= 12
+FPGA_CHIP ?= lfe5u-$(FPGA_SIZE)f
+FPGA_PACKAGE ?= 6bg381c
+# config flash: 1:SPI (standard), 4:QSPI (quad)
+FLASH_SPI ?= 1
+# chip: is25lp032d is25lp128f s25fl164k
+FLASH_CHIP ?= is25lp032d
+
+# ******* design files *******
+CONSTRAINTS ?= board_constraints.lpf
+STRATEGY ?= $(SCRIPTS)/ulx3s.sty
+TOP_MODULE ?= top
+TOP_MODULE_FILE ?= $(TOP_MODULE).v
+VERILOG_FILES ?= $(TOP_MODULE_FILE)
+VHDL_FILES ?=
+SBX_FILES ?=
+
+# ******* tools installation paths *******
+# include $(SCRIPTS)/trellis_path.mk
+# https://github.com/ldoolitt/vhd2vl
+#VHDL2VL ?= /mt/scratch/tmp/openfpga/vhd2vl/src/vhd2vl
+# https://github.com/YosysHQ/yosys
+#YOSYS ?= /mt/scratch/tmp/openfpga/yosys/yosys
+# https://github.com/YosysHQ/nextpnr
+#NEXTPNR-ECP5 ?= /mt/scratch/tmp/openfpga/nextpnr/nextpnr-ecp5
+# https://github.com/SymbiFlow/prjtrellis
+#TRELLIS ?= /mt/scratch/tmp/openfpga/prjtrellis
+
+ifeq ($(FPGA_CHIP), lfe5u-12f)
+  CHIP_ID=0x21111043
+  MASK_FILE=LFE5U-45F.msk
+endif
+ifeq ($(FPGA_CHIP), lfe5u-25f)
+  CHIP_ID=0x41111043
+  MASK_FILE=LFE5U-45F.msk
+endif
+ifeq ($(FPGA_CHIP), lfe5u-45f)
+  CHIP_ID=0x41112043
+  MASK_FILE=LFE5U-45F.msk
+endif
+ifeq ($(FPGA_CHIP), lfe5u-85f)
+  CHIP_ID=0x41113043
+  MASK_FILE=LFE5U-85F.msk
+endif
+
+#ifeq ($(FPGA_SIZE), 12)
+#  FPGA_K=25
+#  IDCODE_CHIPID=--idcode $(CHIP_ID)
+#else
+  FPGA_K=$(FPGA_SIZE)
+  IDCODE_CHIPID=
+#endif
+
+FPGA_CHIP_EQUIVALENT ?= lfe5u-$(FPGA_K)f
+
+# open source synthesis tools
+ECPPLL ?= $(TRELLIS)/libtrellis/ecppll
+ECPPACK ?= $(TRELLIS)/libtrellis/ecppack
+TRELLISDB ?= $(TRELLIS)/database
+LIBTRELLIS ?= $(TRELLIS)/libtrellis
+BIT2SVF ?= $(TRELLIS)/tools/bit_to_svf.py
+#BASECFG ?= $(TRELLIS)/misc/basecfgs/empty_$(FPGA_CHIP_EQUIVALENT).config
+# yosys options, sometimes those can be used: -noccu2 -nomux -nodram
+YOSYS_OPTIONS ?= 
+
+# clock generator
+CLK0_NAME ?= clk0
+CLK0_FILE_NAME ?= clocks/$(CLK0_NAME).v
+CLK0_OPTIONS ?= --input 25 --output 100 --s1 50 --p1 0 --s2 25 --p2 0 --s3 125 --p3 0
+CLK1_NAME ?= clk1
+CLK1_FILE_NAME ?= clocks/$(CLK1_NAME).v
+CLK1_OPTIONS ?= --input 25 --output 100 --s1 50 --p1 0 --s2 25 --p2 0 --s3 125 --p3 0
+CLK2_NAME ?= clk2
+CLK2_FILE_NAME ?= clocks/$(CLK2_NAME).v
+CLK2_OPTIONS ?= --input 25 --output 100 --s1 50 --p1 0 --s2 25 --p2 0 --s3 125 --p3 0
+CLK3_NAME ?= clk3
+CLK3_FILE_NAME ?= clocks/$(CLK3_NAME).v
+CLK3_OPTIONS ?= --input 25 --output 100 --s1 50 --p1 0 --s2 25 --p2 0 --s3 125 --p3 0
+
+# closed source synthesis tools
+# include $(SCRIPTS)/diamond_path.mk
+#DIAMOND_BASE ?= /usr/local/diamond
+ifneq ($(wildcard $(DIAMOND_BASE)),)
+  DIAMOND_BIN :=  $(shell find ${DIAMOND_BASE}/ -maxdepth 2 -name bin | sort -rn | head -1)
+  DIAMONDC := $(shell find ${DIAMOND_BIN}/ -name diamondc)
+  DDTCMD := $(shell find ${DIAMOND_BIN}/ -name ddtcmd)
+  MASK_PATH := $(shell find ${DIAMOND_BASE}/ -maxdepth 5 -name xpga -type d)/ecp5
+endif
+
+#PROJ_FILE := $(shell ls *.ldf | head -1)
+#PROJ_NAME := $(shell fgrep default_implementation ${PROJ_FILE} | cut -d'"' -f 4)
+#IMPL_NAME := $(shell fgrep default_implementation ${PROJ_FILE} | cut -d'"' -f 8)
+#IMPL_DIR := $(shell fgrep default_strategy ${PROJ_FILE} | cut -d'"' -f 4)
+
+# programming tools
+UJPROG ?= fujprog
+OPENFPGALOADER ?= openFPGALoader
+OPENFPGALOADER_OPTIONS ?= --board ulx3s
+FLEAFPGA_JTAG ?= FleaFPGA-JTAG 
+OPENOCD ?= openocd
+OPENOCD_INTERFACE ?= $(SCRIPTS)/ft231x.ocd
+DFU_UTIL ?= dfu-util
+TINYFPGASP ?= tinyfpgasp
+
+# helper scripts directory
+SCRIPTS ?= scripts
+
+# rest of the include makefile
+FPGA_CHIP_UPPERCASE := $(shell echo $(FPGA_CHIP) | tr '[:lower:]' '[:upper:]')
+FPGA_PACKAGE_UPPERCASE := $(shell echo $(FPGA_PACKAGE) | tr '[:lower:]' '[:upper:]')
+
+BITSTREAM ?= $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit
+#BITSTREAM ?= $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).vme $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).svf $(BOARD)_$(FPGA_SIZE)f_$(PROJECT)_flash_$(FLASH_CHIP).vme
+
+all: $(BITSTREAM)
+
+# VHDL to VERILOG conversion
+#%.v: %.vhd
+#	$(VHDL2VL) $< $@
+
+#*.v: *.vhdl
+#	$(VHDL2VL) $< $@
+
+#$(PROJECT).ys: makefile
+#	$(SCRIPTS)/ysgen.sh $(VERILOG_FILES) $(VHDL_TO_VERILOG_FILES) > $@
+#	echo "hierarchy -top ${TOP_MODULE}" >> $@
+#	echo "synth_ecp5 -noccu2 -nomux -nodram -json ${PROJECT}.json" >> $@
+
+#$(PROJECT).json: $(PROJECT).ys $(VERILOG_FILES) $(VHDL_TO_VERILOG_FILES)
+#	$(YOSYS) $(PROJECT).ys
+
+$(PROJECT).json: $(VERILOG_FILES) $(VHDL_TO_VERILOG_FILES)
+	$(YOSYS) \
+	-p "hierarchy -top ${TOP_MODULE}" \
+	-p "synth_ecp5 ${YOSYS_OPTIONS} -json ${PROJECT}.json" \
+	$(VERILOG_FILES) $(VHDL_TO_VERILOG_FILES)
+
+$(BOARD)_$(FPGA_SIZE)f_$(PROJECT).config: $(PROJECT).json $(BASECFG)
+	$(NEXTPNR-ECP5) --$(FPGA_K)k --json $(PROJECT).json --lpf $(CONSTRAINTS) --basecfg $(BASECFG) --textcfg $@
+
+#$(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).config
+#	LANG=C LD_LIBRARY_PATH=$(LIBTRELLIS) $(ECPPACK) $(IDCODE_CHIPID) --db $(TRELLISDB) --input $< --bit $@
+
+# generate LDF project file for diamond
+$(BOARD)_$(FPGA_SIZE)f_$(PROJECT).ldf: $(SCRIPTS)/project.ldf $(SCRIPTS)/ldf.xsl $(SCRIPTS)/$(BOARD)_sram.xcf
+	xsltproc \
+	  --stringparam FPGA_DEVICE $(FPGA_CHIP_UPPERCASE)-$(FPGA_PACKAGE_UPPERCASE) \
+	  --stringparam CONSTRAINTS_FILE $(CONSTRAINTS) \
+	  --stringparam STRATEGY_FILE $(STRATEGY) \
+	  --stringparam XCF_FILE $(SCRIPTS)/$(BOARD)_sram.xcf \
+	  --stringparam TOP_MODULE $(TOP_MODULE) \
+	  --stringparam TOP_MODULE_FILE $(TOP_MODULE_FILE) \
+	  --stringparam VHDL_FILES "$(VHDL_FILES)" \
+	  --stringparam VERILOG_FILES "$(VERILOG_FILES)" \
+	  --stringparam SBX_FILES "$(SBX_FILES)" \
+	  $(SCRIPTS)/ldf.xsl $(SCRIPTS)/project.ldf > $@
+
+project/project_project.bit: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).ldf $(VERILOG_FILES) $(VHDL_FILES)
+	echo prj_project open $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).ldf \; prj_run Export -task Bitgen | ${DIAMONDC}
+
+$(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit: project/project_project.bit
+	ln -sf project/project_project.bit $@
+
+$(CLK0_FILE_NAME):
+	LANG=C LD_LIBRARY_PATH=$(LIBTRELLIS) $(ECPPLL) $(CLK0_OPTIONS) --file $@
+
+$(CLK1_FILE_NAME):
+	LANG=C LD_LIBRARY_PATH=$(LIBTRELLIS) $(ECPPLL) $(CLK1_OPTIONS) --file $@
+
+$(CLK2_FILE_NAME):
+	LANG=C LD_LIBRARY_PATH=$(LIBTRELLIS) $(ECPPLL) $(CLK2_OPTIONS) --file $@
+
+$(CLK3_FILE_NAME):
+	LANG=C LD_LIBRARY_PATH=$(LIBTRELLIS) $(ECPPLL) $(CLK3_OPTIONS) --file $@
+
+# generate sram programming XCF file for DDTCMD
+$(BOARD)_$(FPGA_SIZE)f.xcf: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit $(SCRIPTS)/$(BOARD)_sram.xcf $(SCRIPTS)/xcf.xsl
+	xsltproc \
+	  --stringparam FPGA_CHIP $(FPGA_CHIP_UPPERCASE) \
+	  --stringparam CHIP_ID $(CHIP_ID) \
+	  --stringparam BITSTREAM_FILE $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit \
+	  $(SCRIPTS)/xcf.xsl $(SCRIPTS)/$(BOARD)_sram.xcf > $@
+
+# run DDTCMD to generate sram VME file
+$(BOARD)_$(FPGA_SIZE)f_$(PROJECT).vme: $(BOARD)_$(FPGA_SIZE)f.xcf $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit
+	LANG=C ${DDTCMD} -oft -fullvme -if $(BOARD)_$(FPGA_SIZE)f.xcf -nocompress -noheader -of $@
+
+# run DDTCMD to generate SVF file
+$(BOARD)_$(FPGA_SIZE)f_$(PROJECT).svf: $(BOARD)_$(FPGA_SIZE)f.xcf $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit
+	LANG=C ${DDTCMD} -oft -svfsingle -revd -maxdata 8 -if $(BOARD)_$(FPGA_SIZE)f.xcf -of $@
+
+# run DDTCMD to generate flash MCS file
+$(BOARD)_$(FPGA_SIZE)f_$(PROJECT)_flash.mcs: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit
+	LANG=C ${DDTCMD} -dev $(FPGA_CHIP_UPPERCASE) \
+	-if $< -oft -int -quad $(FPGA_SPI) -of $@
+
+# generate flash programming XCF file for DDTCMD
+$(BOARD)_$(FPGA_SIZE)f_flash_$(FLASH_CHIP).xcf: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit $(SCRIPTS)/$(BOARD)_flash_$(FLASH_CHIP).xcf $(SCRIPTS)/xcf.xsl
+	xsltproc \
+	  --stringparam FPGA_CHIP $(FPGA_CHIP_UPPERCASE) \
+	  --stringparam CHIP_ID $(CHIP_ID) \
+	  --stringparam MASK_FILE $(MASK_PATH)/$(MASK_FILE) \
+	  --stringparam BITSTREAM_FILE $(BOARD)_$(FPGA_SIZE)f_$(PROJECT)_flash.mcs \
+	  $(SCRIPTS)/xcf.xsl $(SCRIPTS)/$(BOARD)_flash_$(FLASH_CHIP).xcf > $@
+
+# run DDTCMD to generate flash VME file
+$(BOARD)_$(FPGA_SIZE)f_$(PROJECT)_flash_$(FLASH_CHIP).vme: $(BOARD)_$(FPGA_SIZE)f_flash_$(FLASH_CHIP).xcf $(BOARD)_$(FPGA_SIZE)f_$(PROJECT)_flash.mcs
+	LANG=C ${DDTCMD} -oft -fullvme -if $(BOARD)_$(FPGA_SIZE)f_flash_$(FLASH_CHIP).xcf -nocompress -noheader -of $@
+
+# generate SVF file by prjtrellis python script
+#$(BOARD)_$(FPGA_SIZE)f_$(PROJECT).svf: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit
+#	$(BIT2SVF) $< $@
+
+#$(BOARD)_$(FPGA_SIZE)f_$(PROJECT).svf: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).config
+#	LD_LIBRARY_PATH=$(LIBTRELLIS) $(ECPPACK) $(IDCODE_CHIPID) --db $(TRELLISDB) $< --freq 62.0 --svf-rowsize 8000 --svf $@
+
+# program SRAM  with ujrprog (temporary)
+prog: program
+program: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit
+	$(UJPROG) $<
+
+# program SRAM with OPENFPGALOADER
+prog_ofl: program_ofl
+program_ofl: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit
+	$(OPENFPGALOADER) $(OPENFPGALOADER_OPTIONS) $<
+
+# program SRAM with FleaFPGA-JTAG (temporary)
+program_flea: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).vme
+	$(FLEAFPGA_JTAG) $<
+
+# program FLASH over US1 port with ujprog (permanently)
+flash: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit
+	$(UJPROG) -j flash $<
+
+# program FLASH uver US1 with FleaFPGA-JTAG (permanent)
+flash_flea: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT)_flash_$(FLASH_CHIP).vme
+	$(FLEAFPGA_JTAG) $<
+
+# program FLASH over US2 port with DFU bootloader (permanently)
+flash_dfu: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit
+	$(DFU_UTIL) -a 0 -D $<
+	$(DFU_UTIL) -a 0 -e
+
+# program FLASH over US2 port with tinyfpgasp bootloader (permanently)
+flash_tiny: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit
+	$(TINYFPGASP) -w $<
+
+# generate chip-specific openocd programming file
+$(BOARD)_$(FPGA_SIZE)f.ocd: $(SCRIPTS)/ecp5-ocd.sh
+	$(SCRIPTS)/ecp5-ocd.sh $(CHIP_ID) $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).svf > $@
+
+# program SRAM with OPENOCD
+prog_ocd: program_ocd
+program_ocd: $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).svf $(BOARD)_$(FPGA_SIZE)f.ocd
+	$(OPENOCD) --file=$(OPENOCD_INTERFACE) --file=$(BOARD)_$(FPGA_SIZE)f.ocd
+
+JUNK = *~
+#JUNK += $(PROJECT).ys
+JUNK += $(PROJECT).json
+JUNK += $(VHDL_TO_VERILOG_FILES)
+JUNK += $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).config
+JUNK += $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).ldf
+JUNK += $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).bit
+JUNK += $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).vme
+JUNK += $(BOARD)_$(FPGA_SIZE)f_$(PROJECT).svf
+JUNK += $(BOARD)_$(FPGA_SIZE)f.xcf
+JUNK += $(BOARD)_$(FPGA_SIZE)f_$(PROJECT)_flash.mcs
+JUNK += $(BOARD)_$(FPGA_SIZE)f_flash_$(FLASH_CHIP).xcf
+JUNK += $(BOARD)_$(FPGA_SIZE)f_$(PROJECT)_flash_$(FLASH_CHIP).vme
+JUNK += $(BOARD)_$(FPGA_SIZE)f.ocd
+JUNK += $(CLK0_FILE_NAME) $(CLK1_FILE_NAME) $(CLK2_FILE_NAME) $(CLK3_FILE_NAME)
+# diamond junk
+JUNK += ${IMPL_DIR} .recovery ._Real_._Math_.vhd *.sty reportview.xml
+JUNK += dummy_sym.sort project_tcl.html promote.xml .run_manager.ini
+JUNK += generate_core.tcl generate_ngd.tcl msg_file.log
+
+JUNK_DIR = project
+JUNK_DIR += project_tcr.dir
+
+clean:
+	rm -rf $(JUNK_DIR)
+	rm -f $(JUNK)

j1b/ulx3s/scripts/diamond_path.mk

@@ -0,0 +1,6 @@
+# the path of your diamond installation
+DIAMOND_BASE ?= /usr/local/diamond
+
+# it is a directory that looks like this:
+# ls /usr/local/diamond
+# 3.7_x64