Return Code - 2021.2 English

Versal ACAP AI Engine Programming Environment User Guide (UG1076)

Document ID
UG1076
ft:locale
English (United States)
Release Date
2021-12-17
Version
2021.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
Possible invalid argument or use of the API in an unsupported way
aie_driver_error
If the AI Engine driver returns errors, the graph API returns this error code.
xrt_error
If XRT returns errors, the graph API returns this error code.
internal error
This means something is wrong with the tool; contact Xilinx support.
unsupported
Unsupported feature or unsupported scenario.