README and documentation source update by sonals · Pull Request #9787 · Xilinx/XRT

sonals · 2026-05-11T21:43:44Z

Problem solved by the commit

Update README and doc/toc rst files to focus on modern NPU and FPGA platforms.
Remove obsolete platform documentation
Update API documentation to include modern features like context, ctrlcode, etc. and enumerate HIP APIs.

Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered

NA

How problem was solved, alternative solutions (if any) and why they were rejected

Manual and Cursor based documentation updates

Risks (if any) associated the changes in the commit

NA

What has been tested and how, request additional testing if necessary

Regenerated the documentation and visually validated the changes

Documentation impact (if any)

Yes -- upgraded documents!

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

- Clarified the description of host-side APIs in C++ and Python. - Adjusted language for linking requirements and compiler standards. - Enhanced clarity in examples and descriptions of core data structures and their locations. - Improved consistency in terminology and phrasing throughout the document. Signed-off-by: [Your Name] [Your Email]

- Excluded specific RST files from Sphinx documentation build to prevent warnings. - Updated descriptions in system_requirements.rst for clarity on supported platforms. - Clarified memory-to-memory (M2M) DMA support in xrt_native_apis.rst. Signed-off-by: [Your Name] [Your Email]

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

github-actions · 2026-05-11T21:47:15Z

clang-tidy review says "All clean, LGTM! 👍"

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

I, Sonal Santan <sonal.santan@amd.com>, hereby add my Signed-off-by to this commit: adf482e I, Sonal Santan <sonal.santan@amd.com>, hereby add my Signed-off-by to this commit: bb204c8 Signed-off-by: Sonal Santan <sonal.santan@amd.com>

github-actions · 2026-05-11T22:52:32Z

clang-tidy review says "All clean, LGTM! 👍"

Copilot

Pull request overview

This PR modernizes the XRT documentation set to emphasize current AMD NPU + FPGA workflows, refreshes the generated API reference structure, and prunes/filters legacy platform docs from the published Sphinx output.

Changes:

Refactors the documentation index/toctrees and adds new pages for HIP runtime APIs and aiebu.
Updates Native API documentation to include newer concepts (context, ctrlcode/ELF, runlists) and refreshes examples/text.
Adjusts the documentation build pipeline (Sphinx/Doxygen/CMake + workflow checks) and removes/filters obsolete docs/assets.

Reviewed changes

Copilot reviewed 16 out of 17 changed files in this pull request and generated 16 comments.

Show a summary per file

File	Description
src/runtime_src/doc/toc/xrt-smi.rst	Updates xrt-smi command documentation formatting and content.
src/runtime_src/doc/toc/xrt_native.main.rst	Reorganizes Doxygen-driven C++ API reference sections (device/context/ctrlcode/runlist, etc.).
src/runtime_src/doc/toc/xrt_native_apis.rst	Major refresh of narrative Native API documentation and examples for modern flows.
src/runtime_src/doc/toc/xrt_hip_runtime_api.rst	Adds a new page enumerating HIP runtime APIs supported by XRT.
src/runtime_src/doc/toc/system_requirements.rst	Updates supported host/platform requirements, adding NPU host notes.
src/runtime_src/doc/toc/platforms.rst	Updates platform overview naming/wording.
src/runtime_src/doc/toc/install.rst	Updates install guidance and adds deployment vs development package notes.
src/runtime_src/doc/toc/index.rst	Reworks top-level doc structure/toctrees and contact info; adds HIP + aiebu links.
src/runtime_src/doc/toc/conf.py	Updates Sphinx configuration (extensions/theme/static handling, output configs).
src/runtime_src/doc/toc/aiebu.rst	Adds a new page describing AIE Binary Utilities (aiebu).
src/runtime_src/doc/toc/_static/theme_overrides.css	Removes old RTD-theme override CSS.
src/runtime_src/doc/CMakeLists.txt	Changes doc build pipeline (Doxygen inputs, Sphinx excludes, kernel-doc generation removal).
src/runtime_src/core/include/xrt/xrt_device.h	Minor Doxygen comment cleanup for `xrt::device`.
src/runtime_src/core/include/xrt/xrt_bo.h	Minor Doxygen comment cleanup for `xrt::bo`.
README.rst	Updates top-level repo README branding and pointers to docs/resources.
.github/workflows/binary_check.yml	Updates content-type checks to allow SVG (and related) content types.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

sonals · 2026-05-12T16:41:58Z


 xrt-smi validate
-~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~_


sonals · 2026-05-12T16:41:47Z

+
    - <user bdf> :  The Bus:Device.Function of the device of interest

 - The ``--run`` (or ``-r``) specifies the perticular test(s) to execute


sonals · 2026-05-12T16:21:29Z

 Install XRT Pre-requests on Deployment Server
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-XRT requires EPEL to install dependencies during installation process. Please use the folloing steps to install EPEL on your system if it hasn't been installed. 
+XRT requires EPEL to install dependencies during installation process. Please use the folloing steps to install EPEL on your system if it hasn't been installed.


sonals · 2026-05-12T16:22:48Z


    sudo apt install --reinstall ./xrt_<version>.deb

+Starting wirh 2026.1 XRT comes with separate *deployment* and *development* packages. The deployment package is sufficient to execute a precompiled XRT application. However, the development package is required to compile an XRT application. The development package includes XRT header files, CMake package files for discovery by CMake based appliation build environments, and XRT dynamic/static libraries for linking.


+html_theme = 'xilinx'
+html_theme_path = ["./_themes"]

 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
+html_logo = '_static/xilinx-header-logo.svg'
 html_theme_options = {
-    'logo_only': True,
+    'logo_only': False,
+    'style_nav_header_background': 'black',
 }

 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+html_css_files = ['_static/custom.css']


sonals · 2026-05-12T16:37:56Z

+           auto runt = krn(buf_a, buf_b, scalar_1);
+           // wait for 100 ms
+           while (1) {
+               try {
+                   auto result = runt.wait2(100);
+               } catch (std::exception &ex) {
+                   std::cout << ex.what();
+               }
+           }


sonals · 2026-05-12T16:37:43Z

+aiebu
+=====
+
+AIE Binary Utilities (aiebu) provides utilities and libraries to work with AIE ctrlcode. library and utilities to work with AIE ctrlcode. aiebu provides ctrlcode assembler and disassembler for aie2p, aie2ps, and aie4. aiebu also defines the ctrlcode ELF format and ctrlcode ISA.


sonals · 2026-05-12T16:37:28Z

-U280, VCK190 and MPSoC based embedded platforms. XRT provides a standardized software
-interface to Xilinx FPGA. The key user APIs are defined in
-`xrt.h <src/runtime_src/core/include/xrt.h>`_ header file.
+Flexible RunTime (XRT) is implemented as a combination of user-space and kernel driver components. It provides an


sonals · 2026-05-12T16:37:09Z

            continue;
          fi
-          if ! $(curl -s -L -I $f | grep "content-type:" | tail -1 | grep -q "text/"); then
+          if ! $(curl -s -L -I $f | grep "content-type:" | tail -1 | grep -qiE 'text/|image/svg[+]xml'); then


This is incremental grep switch change.

sonals · 2026-05-12T16:36:26Z

+----------------------+---------------------+------------------------------------------------+
+|   Run-list           | ``xrt::runlist``    |  ``#include <xrt/experimental/xrt_kernel.h>``  |
+----------------------+---------------------+------------------------------------------------+
+|   Context            | ``xrt::hw_context`` |  ``#include <xrt/experimental/xrt_xclbin.h>``  |


maxzhen · 2026-05-11T22:58:06Z

+aiebu
+=====
+
+AIE Binary Utilities (aiebu) provides utilities and libraries to work with AIE ctrlcode. library and utilities to work with AIE ctrlcode. aiebu provides ctrlcode assembler and disassembler for aie2p, aie2ps, and aie4. aiebu also defines the ctrlcode ELF format and ctrlcode ISA.


"library and utilities to work with AIE ctrlcode." Should be removed?

maxzhen · 2026-05-11T23:02:29Z

 =================================

-`Xilinx Runtime library (XRT) <https://www.xilinx.com/products/design-tools/vitis/xrt.html>`_ is an open-source easy to use software stack that facilitates management and usage of FPGA/ACAP devices. Users use familiar programming languages like C/C++ or Python to write host code which uses XRT to interact with FPGA/ACAP device. XRT exports well defined set of software APIs that work across PCIe based datacenter platforms and ZYNQ UltraScale+ MPSoC/Versal ACAP based embedded platforms. XRT is key component of `Vitis™ <https://www.xilinx.com/products/design-tools/vitis/vitis-platform.html>`_ and `Alveo™ <https://www.xilinx.com/products/boards-and-kits/alveo.html>`_ solutions.
+`FleXible RunTime library (XRT) <https://www.xilinx.com/products/design-tools/vitis/xrt.html>`_ is an open-source easy to use software stack that facilitates management and usage of FPGA/ACAP devices. Users use familiar programming languages like C/C++ or Python to write host code which uses XRT to interact with FPGA/ACAP device. XRT exports well defined set of software APIs that work across PCIe based datacenter platforms and ZYNQ UltraScale+ MPSoC/Versal ACAP based embedded platforms. XRT is key component of `Vitis™ <https://www.xilinx.com/products/design-tools/vitis/vitis-platform.html>`_ and `Alveo™ <https://www.xilinx.com/products/boards-and-kits/alveo.html>`_ solutions.


Do we want to mention NPU device?

The platforms .rst has been obsoleted. We do not include it in the documentation.

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

github-actions · 2026-05-12T19:19:57Z

clang-tidy review says "All clean, LGTM! 👍"

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

github-actions · 2026-05-12T22:11:23Z

clang-tidy review says "All clean, LGTM! 👍"

sonals added 7 commits May 6, 2026 10:49

First phase of XRT GitHub.io documentation cleanup

d81de05

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

Generate doxygen documentation for the new XRT APIs

a0d3d4c

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

Clarify deployment vs development package

e7cfe1d

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

Update the main README page

64c0de5

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

Update system requirements

34fe7a0

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

sonals requested review from rbramand-xilinx, stsoe and uday610 as code owners May 11, 2026 21:43

sonals added 2 commits May 11, 2026 15:43

Update binary file checker to treat SVG files as text files.

b0f66ad

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

sonals requested review from a team, SubhedarV and manikandan-xilinx as code owners May 11, 2026 22:48

maxzhen requested a review from Copilot May 11, 2026 22:54

Copilot started reviewing on behalf of maxzhen May 11, 2026 22:55 View session

Copilot AI reviewed May 11, 2026

View reviewed changes

maxzhen reviewed May 11, 2026

View reviewed changes

Address Co-pilot feedback

f09af9a

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

Update conf.py dates

54c99e2

Signed-off-by: Sonal Santan <sonal.santan@amd.com>

sonals merged commit 8048aea into Xilinx:master May 12, 2026
16 checks passed


		- <user bdf> : The Bus:Device.Function of the device of interest

		- The ``--run`` (or ``-r``) specifies the perticular test(s) to execute


		sudo apt install --reinstall ./xrt_<version>.deb

		Starting wirh 2026.1 XRT comes with separate deployment and development packages. The deployment package is sufficient to execute a precompiled XRT application. However, the development package is required to compile an XRT application. The development package includes XRT header files, CMake package files for discovery by CMake based appliation build environments, and XRT dynamic/static libraries for linking.

Conversation

sonals commented May 11, 2026

Problem solved by the commit

Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered

How problem was solved, alternative solutions (if any) and why they were rejected

Risks (if any) associated the changes in the commit

What has been tested and how, request additional testing if necessary

Documentation impact (if any)

Uh oh!

github-actions Bot commented May 11, 2026

Uh oh!

github-actions Bot commented May 11, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented May 12, 2026

Uh oh!

Uh oh!

github-actions Bot commented May 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants