Open Programmable Acceleration Engine
=====================================

The main documentation for the site is organized into following sections:

* :ref:`user-docs`
* :ref:`api-docs`
* :ref:`driver-docs`
* :ref:`tools-docs`

.. _user-docs:

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: OPAE User Guides

   docs/fpga_api/quick_start/readme
   docs/install_guide/installation_guide
   docs/fpga_api/prog_guide/readme
   docs/ase_userguide/ase_userguide
   docs/README

.. _api-docs:

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: OPAE Libraries

   docs/build_chain/fpga_api/api_build
   docs/fpga_api/fpga_api
   docs/fpga_api/fpga_cxx_api
   docs/fpga_api/fpga_python_api
   docs/fpga_api/plug_guide/readme

.. _driver-docs:

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: OPAE Linux Kernel Drivers

   docs/drv_arch/drv_arch
   docs/build_chain/fpga_driver/driver_build

.. _tools-docs:

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: OPAE FPGA Tools

   docs/fpga_tools/coreidle/coreidle
   docs/fpga_tools/fpgabist/fpgabist
   docs/fpga_tools/fpgainfo/fpgainfo
   docs/fpga_tools/fpgaconf/fpgaconf
   docs/fpga_tools/fpgad/fpgad
   docs/fpga_tools/fpgadiag/README
   docs/fpga_tools/fpgaflash/fpgaflash
   docs/fpga_tools/fpgaflash/superrsu
   docs/fpga_tools/super-rsu/super-rsu
   docs/fpga_tools/fpgamux/fpgamux
   docs/fpga_tools/fpgaport/fpgaport
   docs/fpga_tools/mmlink/mmlink
   docs/fpga_tools/packager/packager
   docs/fpga_tools/userclk/userclk

.. _afu-tools-docs:

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: OPAE AFU Tools

   docs/fpga_tools/hssi_config/readme
   docs/fpga_tools/hssi_loopback/readme
   

.. _opae_ups_drv:

.. toctree::
   :maxdepth: 1
   :glob:
   :caption: OPAE support on Intel FPGA PCIe driver and Linux PCIe FPGA DFL driver

   docs/fpga_dfl_drv/fpga_dfl_drv