Contains SymbiFlow toolchain release packages for Quicklogic FPGAs
This guide describes everything you need to set up your system to develop for QuickLogic FPGA Toolchain. Currently, the SymbiFlow Installer runs only on Linux 64bit.
Note: Place a request for the installers that support QLF-K4N8 and QLF-K6N10. For EOS-S3 devices, the Release tag has installer which can be downloaded.
Symbiflow supports these QuickLogic devices - QLF-K4N8, QLF-K6N10 and EOS-S3
For more details on the symbiflow options refer the tutorial guide: Symbiflow_Tutorial <https://quicklogic-quicklogic-fpga-toolchain.readthedocs-hosted.com/en/latest/index.html>_
Ways to run Symbiflow on these devices are explained in the following sub-sections:
Below are some ways to run SymbiFlow for QLF-K4N8/QLF-K6N10 Devices:
1) Run an installer and run an example 2) Compile from source code and run example
.. _1-run-an-installer-and-run-an-example:
.. _2-compile-from-source-code-and-run-example:
This release package contains the following GitHub repositories that are compiled to create this package.
You may use the following command to get the source, compile and install it:
::
git clone https://github.com/QuickLogic-Corp/symbiflow-arch-defs.git cd symbiflow-arch-defs make env cd build;make all_conda
cd build/quicklogic/
make counter_16bit-umc22-adder_route
make counter_16bit-gf12-adder_route
Below are some ways to run SymbiFlow for EOS-S3 Device:
1) Run an installer and run an example 2) Compile from source code and run example 3) Run SymbiFlow in a container
For details on the usage of RAM, FIFO and Multiplier blocks, refer to
the following document:
Ram_Fifo_Mult_User_Document <https://quicklogic-fpga-tool-docs.readthedocs.io/en/latest/ram/S3BDeviceHardmacroResources.html>_
NOTE:
While running the compilation with the latest toolchain (v1.3.1), the following warning would be seen:
::
fasm/fasm/parser/init.py:27: RuntimeWarning: Falling back on slower textX parser implementation: ImportError: cannot import name 'tags' from 'fasm.parser' (/path/to/toolchain/install/quicklogic-arch-defs/tests/counter_16bit/fasm/fasm/parser/init.py) Please install all dependencies and reinstall with: pip uninstall pip install -v fasm ' pip install -v fasm'.format(e), RuntimeWarning) ['textx']
This is due to recent changes in the Symbiflow fasm <https://github.com/SymbiFlow/fasm>_ which adds support for the :code:antlr parser in place of :code:textx. |
This is not a problem, and current installation will continue to use :code:textx as the parser, as with previous releases. |
:code:antlr installation requires a few extra steps, which needs to be integrated into the toolchain installation. |
This is not yet incorporated in the current install, and will be added in a future release. | Manual Installation of :code:antlr can be done from the instructions at the Symbiflow fasm <https://github.com/SymbiFlow/fasm>_ readme. |
|---|---|---|---|---|
| A brief of the steps for manual installation (optional), after toolchain installation is completed: |
Ensure :code:conda activate is executed
Execute the following sequence
::
cd $INSTALL_DIR git clone https://github.com/SymbiFlow/fasm.git cd fasm git submodule update --init sudo apt install cmake default-jre-headless uuid-dev libantlr4-runtime-dev make build python setup.py test
If all goes well, run the below to test:
::
python3 -c "import fasm.parser as p; print(p.available)"
An output similar to below:
::
['antlr', 'textx']
indicates that :code:antlr is now installed and available, and will be used as the default parser.
.. _1-run-an-installer-and-run-an-example:
Download
Symbiflow_v1.3.2 <https://github.com/QuickLogic-Corp/quicklogic-fpga-toolchain/releases/download/v1.3.2/Symbiflow_v1.3.2.gz.run>__
This package installs these toolchains :
Steps:
::
export INSTALL_DIR="specify the installpath" bash Symbiflow_v1.3.2.gz.run
::
export INSTALL_DIR="specify the installpath" export PATH="$INSTALL_DIR/quicklogic-arch-defs/bin:$INSTALL_DIR/quicklogic-arch-defs/bin/python:$PATH" source "$INSTALL_DIR/conda/etc/profile.d/conda.sh" conda activate
::
ql_symbiflow -h
Run Example Design
The example designs are provided in separate directories at :code:$INSTALL_DIR/quicklogic-arch-defs/tests :
counter_16bit - simple 16-bit up-counter. The design targets the device ql-eos-s3 and package PD64.To run this example, run following commands:
::
cd $INSTALL_DIR/quicklogic-arch-defs/tests/counter_16bit ql_symbiflow -compile -d ql-eos-s3 -P pd64 -v counter_16bit.v -t top -p chandalar.pcf
.. _2-compile-from-source-code-and-run-example:
This release package contains the following GitHub repositories that are compiled to create this package.
Note: Refer the repositories read.md pages for the prerequisites to build.
You may use the following command to get the source, compile and install it:
::
git clone https://github.com/QuickLogic-Corp/yosys.git -b quicklogic-rebased quicklogic-yosys cd quicklogic-yosys
make config-gcc make install PREFIX='specify installation path' cd -
git clone https://github.com/QuickLogic-Corp/yosys-symbiflow-plugins -b ql-ios cd yosys-symbiflow-plugins export PATH='specify Yosys installation path as specified in PREFIX in previous step':$PATH make install cd -
git clone https://github.com/SymbiFlow/vtr-verilog-to-routing -b master cd vtr-verilog-to-routing make
git clone https://github.com/QuickLogic-Corp/symbiflow-arch-defs.git -b quicklogic-upstream-rebase export YOSYS='path to Yosys binary, installed in first step' export VPR='path to vpr binary built' export GENFASM='path to genfasm binary built' cd symbiflow-arch-defs make env cd build make all_conda
cd quicklogic/pp3/tests/quicklogic_testsuite/bin2seven make bin2seven-ql-chandalar_fasm