From b8a1e206326e2a0e792f2663cae044ba363b9dbd Mon Sep 17 00:00:00 2001 From: Raptor Engineering Development Team Date: Mon, 29 Apr 2019 12:14:53 -0500 Subject: Add initial README.md file --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fb7725a --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Raptor System FPGA General Information + +This document contains general information applicable to most Raptor Computing Systems FPGA source trees. For specific information on a particular product, please consult the provided schematics and FPGA source HDL. + + +# Building + +The system FPGA sources are designed with, and are fully synthesizeable and routable with, the open-source Icestorm tooling. For more details on Icestorm please visit http://www.clifford.at/icestorm/ + +## Prerequisites + +We recommend using a Debian Buster installation with the non-free repositories disabled. As part of the build process runs timing-driven PAR, a multi-core system with at least 64 threads is useful to speed up the build process. We recommend building the FPGA image directly on a decently sized, blob free OpenPOWER system for maximum security and ease of development. + +At minimum, the following packages are required: +apt-get install build-essential yosys fpga-icestorm + +If simulation capability is desired, also install: +apt-get install iverilog gtkwave + +## Build + +Building is simple. From within the source directory, execute: +make -j <number of threads in build system> all + +## Output + +When the build is complete, you will see a system_fpga.rom file. This is the complete image you need to program the Flash device for the FPGA in question on your Raptor Computing Systems product. -- cgit v1.2.1