Return Code - 2024.1 English

AI Engine-ML Kernel and Graph Programming Guide (UG1603)

Document ID
UG1603
Release Date
2024-06-06
Version
2024.1 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-ML driver returns errors, the graph API returns this error code.
xrt_error
If the Runtime library (XRT) returns errors, the graph API returns this error code.
internal error
This means a problem occurred with the tool; contact AMD support.
unsupported
Unsupported feature or unsupported scenario.