..
   comment:: SPDX-License-Identifier: Apache-2.0
   comment:: Copyright (C) 2019-2021 Xilinx, Inc. All rights reserved.

==================================
Xilinx® Runtime (XRT) Architecture
==================================

Xilinx® Runtime (XRT) is implemented as a combination of userspace and kernel
driver components. XRT supports both PCIe based accelerator cards and MPSoC
based embedded architecture provides standardized software interface to Xilinx®
FPGA. The key user APIs are defined in ``xrt.h`` header file.

.. image:: XRT-Layers.svg
   :align: center

----------------------------------------------------------------------------

.. toctree::
   :maxdepth: 1
   :caption: Introduction

   platforms.rst
   system_requirements.rst
   build.rst
   install.rst
   test.rst


.. toctree::
   :maxdepth: 1
   :caption: Use Model and Features

   execution-model.rst
   xrt_kernel_executions.rst
   multiprocess.rst
   p2p.rst
   m2m.rst
   hm.rst
   xrt_ini.rst

.. toctree::
   :maxdepth: 1
   :caption: Video Acceleration Using XMA

   xma_user_guide.rst
   xma_apps_dev.rst
   xma_plugin_dev.rst
   xmakernels.main.rst
   xma.main.rst
   xma_19.2.rst

.. toctree::
   :maxdepth: 1
   :caption: User API Library

   opencl_extension.rst
   xrt_native_apis.rst
   xrt_native.main.rst


.. toctree::
   :caption: XRT Developer's Space
   :maxdepth: 1

   platforms_partitions.rst
   sysfs.rst
   formats.rst
   xrt.main.rst
   ert.main.rst
   mgmt-ioctl.main.rst
   xocl_ioctl.main.rst
   zocl_ioctl.main.rst



.. toctree::
   :caption: Tools and Utilities
   :maxdepth: 1

   xclbintools.rst
   xbutil.rst
   xbmgmt.rst
   xbflash2.rst
   xball.rst
   xbtop.rst
   xbtools_map.rst


.. toctree::
   :caption: Building Platforms
   :maxdepth: 1

   yocto.rst
   test.rst


.. toctree::
   :caption: Cloud Support
   :maxdepth: 1

   mailbox.main.rst
   mailbox.proto.rst
   cloud_vendor_support.rst
   fpga_device_ready.rst
   vsec.rst


.. toctree::
   :caption: Security
   :maxdepth: 1

   security.rst

.. toctree::
   :caption: Python binding
   :maxdepth: 1

   pyxrt.rst

.. toctree::
   :caption: Debug and Faqs
   :maxdepth: 1

   debug-faq.rst

----------------------------------------------------------------------------

For any questions on XRT please email runtime@xilinx.com
