Native XRT Examples

XRT Native API's for optimized interfacing with Xilinx Devices.

Examples Table :

Example	Description	Key Concepts/Keywords
asynchronous_xrt	This is simple example which showcases asynchronous programming mechanism through the user-defined queues.	Key Concepts XRT Native API Asynchronous Programming Keywords xrt::queue enqueue wait()
copy_buffer_xrt	This Copy Buffer example demonstrate how one buffer can be copied from another buffer.	Key Concepts Copy Buffer Keywords copy
data_transfer_xrt	This example illustrates transferring of data to and from the FPGA using xrt native api's	Key Concepts XRT Native API Data Transfer Write Buffers Read Buffers Keywords xrt::bo::write xrt::bo::read
device_only_buffer_xrt	This example will demonstrate how to create buffers in global memory which are not mapped to host.	Key Concepts Device only buffer Keywords xrt::bo::flags::device_only
device_query_xrt	This Example prints device properties using XRT Native APIs. It also displays the limits and capabilities of the hardware.	Key Concepts Querying device properties Keywords xrt::device
hbm_simple_xrt	This is a simple example of vector addition to describe how to use HLS kernels with HBM (High Bandwidth Memory) for achieving high throughput using xrt native api's.	Key Concepts High Bandwidth Memory Multiple HBM Banks Keywords HBM
hello_world_xrt	This is simple example of vector addition to describe the usage of XRT Native API's. The kernel uses HLS Dataflow which allows the user to schedule multiple task together to achieve higher throughput.	Key Concepts XRT Native API Task Level Parallelism Keywords xrt::device load_xclbin xrt::bo xrt::kernel map sync XCL_BO_SYNC_BO_TO_DEVICE XCL_BO_SYNC_BO_FROM_DEVICE gmem #pragma HLS INTERFACE dataflow hls::stream
host_memory_copy_buffer_xrt	This is simple host memory example to describe how host-only memory can be copied to device-only memory and vice-versa using XRT Native API's.	Key Concepts host memory Keywords host_only device_only HOST[0]
host_memory_copy_kernel_xrt	This is a Host Memory Example to describe how data can be copied using xrt native api's between host-only buffer and device-only buffer using User Copy Kernel.	Key Concepts host memory Keywords host_only device_only
host_memory_simple_xrt	This is simple host memory example to describe how a user kernel can access the host memory using xrt native api's.	Key Concepts host memory address translation unit Keywords host_only HOST[0]
iops_fast_adapter_xrt	This is simple test design to measure Input/Output Operations per second using Fast Adapter. In this design, a simple kernel is enqueued many times and overall IOPS is measured using XRT native api's.	Key Concepts Input/Output Operations per second Fast Adapter Keywords nextDescriptorAddr
mailbox_auto_restart_xrt	This is a simple example demonstrating the Mailbox and Auto-restart features for writing registers to and reading registers from a never-ending kernel.	Key Concepts Mailbox Auto-restart Keywords set_arg get_arg write() read() STABLE
mult_compute_units_xrt	This is simple Example of Multiple Compute units to showcase how a single kernel can be instantiated into Multiple compute units. Host code will show how to use multiple compute units and run them concurrently using XRT Native api's.	Key Concepts Multiple compute units Keywords nk
multiple_cus_asymmetrical_xrt	This is simple example of vector addition to demonstrate how to connect each compute unit to different banks and how to use these compute units in host applications using xrt native api's.	Key Concepts Multiple compute units Task Level Parallelism
p2p_simple_xrt	This is simple example of vector increment to describe P2P between FPGA and NVMe SSD using xrt native api's.	Key Concepts P2P NVMe SSD SmartSSD Keywords xrt::bo::flags::p2p pread pwrite O_DIRECT O_RDWR
register_access_xrt	This is simple example which demonstrate register read & write using native xrt api's.	Keywords read_register write_register cu_access_mode exclusive
streaming_free_running_k2k_xrt	This is simple example which demonstrate how to use and configure a free running kernel.	Key Concepts Free Running Kernel Keywords ap_ctrl_none stream_connect
streaming_k2k_mm_xrt	This is a simple kernel to kernel streaming Vector Add and Vector Multiply C Kernel design with 2 memory mapped input to kernel 1, 1 Stream output from kernel 1 to input of kernel 2, 1 memory mapped input to kernel 2, and 1 memory mapped output that demonstrates on how to process a stream of data for computation between two kernels using XRT Native APIs. This design also illustrates how to set FIFO depth for AXIS connections i.e. for the stream connecting the two kernels	Key Concepts Read/Write Stream Create/Release Stream AXIS FIFO depth Keywords stream_connect