#####
XiBIF
#####

.. image:: img/xibif_logo.png
   :alt: XiBIF Logo
   :align: center
   :width: 300px

.. image:: img/xibif_logo_text.png
   :alt: XiBIF Logo
   :align: center
   :width: 350px


The Xilinx Board Interface, XiBIF for short, is a hardware platform and a Python package based on Xilinx system-on-chip solutions which aims to ease the beginnings of hardware design on FPGA as well as a software package to interface with such hardware.

.. warning::
   Upgrading existing projects to XiBIF v5.0.0 requires manual migration steps because v5.0.0 introduces breaking changes.
   See :ref:`Upgrade to version 5.0.0 <troubleshooting-upgrade-v5>` in the troubleshooting guide before upgrading.

.. image:: img/xibif-block-diagram.drawio.png
   :alt: Block Diagram of an FPGA System with XiBIF and a host
   :align: center

.. toctree::
   :maxdepth: 1
   :caption: Quickstart
   
   quickstart/quickstart

.. toctree::
   :maxdepth: 1
   :caption: Overview
   
   overview/introduction
   overview/how-to-read
   overview/fpga-primer
   overview/zynq
   overview/registers
   overview/axi-stream
   overview/software
   
.. toctree::
   :maxdepth: 1
   :caption: Tutorials

   tutorials/installation
   tutorials/network
   tutorials/hardware-design-flow
   tutorials/register-generation
   tutorials/writing-software
   tutorials/axi-stream
   tutorials/status-control
   tutorials/open-logic
   tutorials/processing-system
   tutorials/webserver
   tutorials/simulation
   
.. toctree::
   :maxdepth: 1
   :caption: Sourcecode

   code/classes
   code/api
   code/cli
   
.. toctree::
   :maxdepth: 1
   :caption: Appendix

   appendix/fpga-boards
   appendix/troubleshooting
   appendix/faq