vvas_kernel_start - vvas_kernel_start - 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

Use this API to start the kernel. This API internally uses Xilinx Run Time (XRT) APIs to start the kernel.

 VvasReturnType vvas_kernel_start (VVASKernel * handle, const char *format, ...);

Parameters:
    handle - VVAS kernel handle which has kernel context
    format - Variable arguments for the list of arguments that the kernel takes.

Return:
    VvasReturnType

Use the following format specifiers for kernel arguments for the “format” argument:

“i” : Signed int argument.
“u” : Unsigned int argument.
“f” : Float argument.
“F” : Double argument.
“c” : Char argument.
“C” : Unsigned char argument.
“S” : Short argument.
“U” : Unsigned short argument.
“l” : Unsigned long long argument.
“d” : Long long argument.
“p” : Any pointer argument.
“b” : Buffer Object argument.
“s” : If you want to skip the argument.

For example: For passing three arguments of types int, unsigned int, and a pointer, then the format specifier string would be “iup”

If you want to skip the middle argument in that case, then the format specifier string would be “isp”.

Use the following API to check whether the IP or kernel has finished execution. This function internally loops for MAX_EXEC_WAIT_RETRY_CNT times until a timeout before returning an error.

VvasReturnType vvas_kernel_done (VVASKernel * handle, int32_t timeout);

Parameters:
    handle  - VVAS kernel handle which has kernel context
    timeout - Timeout in milliseconds

Return:
    VvasReturnType