Read/Write Register APIs - Read/Write Register APIs - 6.3 English - XD056

Vitis Video Analytics SDK (VVAS) 6.3 User Guide (XD056)

Document_ID
XD056
Release_Date
2026-09-24
Version
6.3 English

These APIs can be used only if the kernel object is created in exclusive mode. Moreover, ensure that the “is_multiprocess” parameter is set to “false” in the VVASKernel object in the acceleration software library.

If you decide to go for the option of programing the kernel using register programming, then the only option to start a kernel is to set the “ap_start” bit by writing into the control register.

Important

These APIs are deprecated and will be removed from next VVAS releases. VVAS supports only XRT managed kernel mode.

void vvas_register_write (VVASKernel *handle, void *src, size_t size,
size_t offset)
Parameters:
    handle - VVAS kernel handle which has kernel context
    src - pointer to data to be written at offset in ERT command buffer or
register at offset from base address of IP
    size - size of the data pointer src
    offset - offset at which data to be written

Return:
    None

The following API used to read from the registers of an IP/kernel. Use this API to read the interrupt status register to know the status of the task in polling mode.

void vvas_register_read (VVASKernel *handle, void *src, size_t size, size_t
offset)

Parameters:
    handle - VVAS kernel handle which has kernel context
    src - pointer to data which will be updated after read
    size - size of the data pointer src
    offset - offset from base address of an IP

Return:
    None