diff options
Diffstat (limited to 'src/include/usr/hwpf/fapi/fapiReturnCodes.H')
-rw-r--r-- | src/include/usr/hwpf/fapi/fapiReturnCodes.H | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/src/include/usr/hwpf/fapi/fapiReturnCodes.H b/src/include/usr/hwpf/fapi/fapiReturnCodes.H new file mode 100644 index 000000000..4d3cc7db2 --- /dev/null +++ b/src/include/usr/hwpf/fapi/fapiReturnCodes.H @@ -0,0 +1,39 @@ +/** + * @file fapiReturnCodes.H + * + * @brief Defines the returns codes generated by HWPF code. + */ + +#ifndef FAPIRETURNCODES_H_ +#define FAPIRETURNCODES_H_ + +#include <ecmdDataBuffer.H> + +namespace fapi +{ + +/** + * @brief Enumeration of return codes + */ +enum +{ + FAPI_RC_SUCCESS = 0, + + // Flag bits indicating which code generated the error If no flag set then + // it is generated by HWP + FAPI_RC_FAPI_MASK = 0x04000000, // FAPI generated error + FAPI_RC_PLAT_MASK = 0x02000000, // PLAT generated error + FAPI_RC_ECMD_MASK = ECMD_ERR_ECMD, // ECMD generated error (0x01000000) + + // FAPI generated return codes + FAPI_RC_NOT_IMPLEMENTED = FAPI_RC_FAPI_MASK | 0x01, + + // PLAT generated return codes + FAPI_RC_PLAT_ERR_SEE_DATA = FAPI_RC_PLAT_MASK | 0x01, + // Error details in attached ReturnCodeData + FAPI_RC_PLAT_NOT_IMPLEMENTED = FAPI_RC_PLAT_MASK | 0x02, +}; + +} + +#endif // FAPIRETURNCODES_H_ |