Return Code - 2020.2 English

Versal ACAP AI Engine Programming Environment User Guide (UG1076)

Document ID
UG1076
Release Date
2020-11-24
Version
2020.2 English

ADF APIs have defined return codes to indicate success or different kinds of failures in the adf namespace.

enum return_code
  {
    ok = 0,
    user_error,
    aie_driver_error,
    xrt_error,
    internal_error,
    unsupported
  };

The following defines the different return codes:

ok
success
user error
such as invalid argument, use the API in an unsupported way, etc.
aie_driver_error
if AI Engine driver returns errors, graph API returns this error code.
xrt_error
if XRT returns errors, graph APIs returns this error code.
internal error
it means something wrong with the tool, users should contact Xilinx support.
unsupported
unsupported feature or unsupported scenario.