.. _Building-Examples:

Building example designs
########################

Before building any example, set the installation directory to match what you
set it to earlier, for example:

.. code-block:: bash
   :name: export-install-dir

   export F4PGA_INSTALL_DIR=~/opt/f4pga

Select your FPGA family:

.. tabs::

   .. group-tab:: Artix-7

      .. code-block:: bash
         :name: fpga-fam-xc7

         FPGA_FAM="xc7"

   .. group-tab:: EOS S3

      .. code-block:: bash
         :name: fpga-fam-eos-s3

         FPGA_FAM="eos-s3"

Next, prepare the environment:


.. tabs::

   .. group-tab:: Artix-7

      .. code-block:: bash
         :name: conda-prep-env-xc7

         export PATH="$F4PGA_INSTALL_DIR/$FPGA_FAM/install/bin:$PATH";
         source "$F4PGA_INSTALL_DIR/$FPGA_FAM/conda/etc/profile.d/conda.sh"

   .. group-tab:: EOS S3

      .. code-block:: bash
         :name: conda-prep-env-eos-s3

         export PATH="$F4PGA_INSTALL_DIR/$FPGA_FAM/quicklogic-arch-defs/bin:$PATH";
         source "$F4PGA_INSTALL_DIR/$FPGA_FAM/conda/etc/profile.d/conda.sh"


.. code-block:: bash
   :name: f4pga-env-bin

   export F4PGA_ENV_BIN="$F4PGA_INSTALL_DIR/$FPGA_FAM/conda/bin"


.. tabs::

   .. group-tab:: AMD/Xilinx Series 7

      .. code-block:: bash
         :name: f4pga-env-share-xc7

         export F4PGA_ENV_SHARE="$F4PGA_INSTALL_DIR/$FPGA_FAM/install/share/symbiflow"

   .. group-tab:: EOS S3

      .. code-block:: bash
         :name: f4pga-env-share-ql

         export F4PGA_ENV_SHARE="$F4PGA_INSTALL_DIR/$FPGA_FAM/share"


Finally, enter your working Conda environment:

.. code-block:: bash
   :name: conda-act-env

   conda activate $FPGA_FAM

.. tip::

   You will need to run the commands for setting the path and source of your conda environment
   each time you open a new terminal. You will also need to activate the Conda environment for
   your hardware before you attempt to build your designs. It might be a good idea to add the
   above commands to your ``.bashrc`` either as default commands that run each time you open a
   new terminal or aliases to save yourself some repetitive typing.

.. note::

   If you don't know how to upload any of the following examples onto your
   development board, please refer to the Running examples section.

.. note::

   Make sure you have executed all the above commands, or otherwise you may encounter errors when
   building the designs.


Xilinx 7-Series
===============

Enter the directory that contains examples for Xilinx 7-Series FPGAs:

.. code-block:: bash
   :name: enter-dir-xc7

   cd xc7

.. jinja:: xc7_counter_test
   :file: templates/example.jinja

.. jinja:: xc7_picosoc_demo
   :file: templates/example.jinja

.. jinja:: xc7_litex_demo
   :file: templates/example.jinja

.. jinja:: xc7_linux_litex_demo
   :file: templates/example.jinja

.. jinja:: xc7_timer
   :file: templates/example.jinja

.. jinja:: xc7_pulse_width_led
   :file: templates/example.jinja


QuickLogic EOS S3
=================

Enter the directory that contains examples for QuickLogic EOS S3:

.. code-block:: bash
   :name: enter-dir-eos-s3

   cd eos-s3

.. jinja:: eos-s3_btn_counter
   :file: templates/example.jinja