 |
Enterprise Security Library
|
Enterprise Security library APIs return results of type cy_rslt_t and consist of three parts:
Module base Type Library-specific error code
+----------------------------------------+------+------------------------------+
|CY_RSLT_MODULE_ENTERPRISE_SECURITY_BASE | 0x2 | Error Code |
+----------------------------------------+------+------------------------------+
14 bits 2 bits 16 bits
See the macro section of this document for library-specific error codes.
The data structure cy_rslt_t is part of cy_result.h located in <core_lib/include>
Module base: This base is derived from CY_RSLT_MODULE_MIDDLEWARE_BASE (defined in cy_result.h) and is an offset of the CY_RSLT_MODULE_MIDDLEWARE_BASE. The details of the offset and the middleware base are defined in cy_result_mw.h, which is part of the GitHub connectivity-utilities repo. For example, the Enterprise Security library uses CY_RSLT_MODULE_ENTERPRISE_SECURITY_BASE as the module base.
Type: This type is defined in cy_result.h and can be one of CY_RSLT_TYPE_FATAL, CY_RSLT_TYPE_ERROR, CY_RSLT_TYPE_WARNING, or CY_RSLT_TYPE_INFO.
Library-specific error code: These error codes are library-specific and defined in the macro section.
Helper macros used for creating the library-specific result are provided as part of cy_result.h.
| #define CY_RSLT_ENTERPRISE_SECURITY_ERROR ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 1 ) |
Enterprise Security error codes.
Generic error.
| #define CY_RSLT_ENTERPRISE_SECURITY_BADARG ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 2 ) |
Bad argument.
| #define CY_RSLT_ENTERPRISE_SECURITY_NOMEM ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 3 ) |
Out of resources.
| #define CY_RSLT_ENTERPRISE_SECURITY_TIMEOUT ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 4 ) |
Out of resources.
| #define CY_RSLT_ENTERPRISE_SECURITY_ALREADY_CONNECTED ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 5 ) |
Already connected to AP.
| #define CY_RSLT_ENTERPRISE_SECURITY_NOT_CONNECTED ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 6 ) |
Not connected to any AP.
| #define CY_RSLT_ENTERPRISE_SECURITY_JOIN_ERROR ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 7 ) |
Error joining AP.
| #define CY_RSLT_ENTERPRISE_SECURITY_LEAVE_ERROR ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 8 ) |
Error leaving AP.
| #define CY_RSLT_ENTERPRISE_SECURITY_TLS_ERROR ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 9 ) |
TLS Error.
| #define CY_RSLT_ENTERPRISE_SECURITY_SUPPLICANT_ERROR ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 10 ) |
Supplicant error.
| #define CY_RSLT_ENTERPRISE_SECURITY_SUPPLICANT_IN_PROGRESS ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 11 ) |
Supplicant is in progress.
| #define CY_RSLT_ENTERPRISE_SECURITY_SUPPLICANT_ABORTED ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 12 ) |
Supplicant aborted.
| #define CY_RSLT_ENTERPRISE_SECURITY_SUPPLICANT_NOT_STARTED ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 13 ) |
Supplicant not yet started.
| #define CY_RSLT_ENTERPRISE_SECURITY_SUPPLICANT_UNPROCESSED ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 14 ) |
Unprocessed event.
| #define CY_RSLT_ENTERPRISE_SECURITY_EAP_ERROR ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 15 ) |
EAP error.
| #define CY_RSLT_ENTERPRISE_SECURITY_UTIL_ERROR ( CY_RSLT_ENTERPRISE_SECURITY_ERR_BASE + 16 ) |
Util error.