summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRaptor Engineering Development Team <support@raptorengineering.com>2019-04-29 12:14:53 -0500
committerRaptor Engineering Development Team <support@raptorengineering.com>2019-04-29 12:14:53 -0500
commitb8a1e206326e2a0e792f2663cae044ba363b9dbd (patch)
tree889cd7b970ac61169997ea8d9246d9816abff2ac
parent14ad067f65b45558a513879cf64e039b2212843c (diff)
downloadtalos-system-fpga-b8a1e206326e2a0e792f2663cae044ba363b9dbd.zip
talos-system-fpga-b8a1e206326e2a0e792f2663cae044ba363b9dbd.tar.gz
Add initial README.md file
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
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 &lt;number of threads in build system&gt; 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.
OpenPOWER on IntegriCloud