WCM results/error codes

group generic_wcm_defines

Cypress middleware APIs return results of type cy_rslt_t and consist of three parts:

  • module base

  • type

  • error code

           Module base                   Type    Library specific error code
   +-----------------------------------+------+------------------------------+
   |CY_RSLT_MODULE_WCM_BASE            | 0x2  |           Error Code         |
   +-----------------------------------+------+------------------------------+
             14-bits                    2-bits            16-bits

See the macro section of this document for library-specific error codes.
Result Format

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, that is part of GitHub connectivity-utilities For example, Wi-Fi Connection Manager (WCM) uses CY_RSLT_MODULE_WCM_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. AWS library error codes are of type CY_RSLT_TYPE_ERROR.

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.

Defines

CY_RSLT_WCM_ERR_BASE

Generic wcm base error code.

CY_RSLT_WCM_WAIT_TIMEOUT

WCM Error Codes.

Wait timeout.

CY_RSLT_WCM_BAD_NETWORK_PARAM

Bad network parameters.

CY_RSLT_WCM_BAD_SSID_LEN

Bad SSID length.

CY_RSLT_WCM_SECURITY_NOT_SUPPORTED

Security not supported.

CY_RSLT_WCM_BAD_PASSPHRASE_LEN

Bad passphrase length.

CY_RSLT_WCM_BAD_ARG

Bad argument.

CY_RSLT_WCM_INTERFACE_NOT_SUPPORTED

Interface type not supported.

CY_RSLT_WCM_MUTEX_ERROR

Mutex error.

CY_RSLT_WCM_STA_DISCONNECT_ERROR

STA disconnect error.

CY_RSLT_WCM_STA_NETWORK_DOWN

STA network is down.

CY_RSLT_WCM_BSP_INIT_ERROR

CY BSP initialization error.

CY_RSLT_WCM_BSP_DEINIT_ERROR

CY BSP error while de-initialization.

CY_RSLT_WCM_NO_ACTIVE_SCAN

No active scan running currently.

CY_RSLT_WCM_SCAN_IN_PROGRESS

Scan in progress.

CY_RSLT_WCM_SCAN_ERROR

Scan error.

CY_RSLT_WCM_STOP_SCAN_ERROR

Stop scan error.

CY_RSLT_WCM_BAND_NOT_SUPPORTED

BAND not supported.

CY_RSLT_WCM_OUT_OF_MEMORY

WCM out of memory error.

CY_RSLT_WCM_CHANNEL_ERROR

Error in retrieving the Wi-Fi channel.

CY_RSLT_WCM_NETIF_DOES_NOT_EXIST

Network interface does not exist.

CY_RSLT_WCM_ARP_REQUEST_FAILURE

Error returned for ARP request failure.

CY_RSLT_WCM_IPV6_GLOBAL_ADDRESS_NOT_SUPPORTED

IPv6 global IP not supported.

CY_RSLT_WCM_IPV6_INTERFACE_NOT_READY

IPV6 interface not ready.

CY_RSLT_WCM_PING_FAILURE

Failure in executing ping.

CY_RSLT_WCM_PING_REQUEST_TIMEOUT

Ping request timed out.

CY_RSLT_WCM_STATIC_IP_NOT_SUPPORTED

Static IP address not supported for IPv6.

CY_RSLT_WCM_BAD_STATIC_IP

Bad Static IP address.

CY_RSLT_WCM_SECONDARY_INTERFACE_ERROR

Error in bringing up the secondary interface.

CY_RSLT_WCM_AP_NETWORK_BRINGUP_ERROR

AP network bring up error.

CY_RSLT_WCM_AP_BAD_CHANNEL

Bad AP channel number.

CY_RSLT_WCM_AP_IE_REMOVAL_ERROR

AP IE removal error.

CY_RSLT_WCM_INVALID_IE

Invalid IE.

CY_RSLT_WCM_AP_NOT_UP

SoftAP is not started.

CY_RSLT_WCM_INTERFACE_NOT_UP

Interface is not initialized.

CY_RSLT_WCM_NOT_INITIALIZED

WCM not initialized.

CY_RSLT_WCM_WPS_PBC_OVERLAP

WPS Error Codes.

WPS PBC overlap.

CY_RSLT_WCM_WPS_ERROR_RECEIVED_WEP_CREDENTIALS

WPS received incorrect credentials.

CY_RSLT_WCM_WPS_FAILED

WPS PBC/PIN mode failed.

CY_RSLT_WCM_DHCP_TIMEOUT

DHCP Error Code.

DHCP timeout.