WiFi middleware core
Macros
WiFi middleware specific error codes

General Description

Wi-Fi middleware core APIs return results of type cy_rslt_t and comprise of three parts:

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

Refer to 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, that is part of Github connectivity-utilities For instance, lwIP WHD PORT (CY_LWP_WHD_PORT) uses CY_RSLT_MODULE_LWIP_WHD_PORT_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 macro section

Helper macros used for creating the library specific result are provided as part of cy_result.h

Macros

#define CY_RSLT_LWIP_WHD_PORT_ERR_BASE   CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_LWIP_WHD_PORT_BASE, 0)
 Generic CY LWIP WHD port base error code.
 
#define CY_RSLT_LWIP_INTERFACE_EXISTS   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 1)
 CY LWIP error. More...
 
#define CY_RSLT_LWIP_ERROR_ADDING_INTERFACE   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 2)
 Denotes adding interface failed

 
#define CY_RSLT_LWIP_ERROR_STARTING_DHCP   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 3)
 Denotes failure to start DHCP

 
#define CY_RSLT_LWIP_INTERFACE_DOES_NOT_EXIST   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 4)
 Denotes interface does not exist

 
#define CY_RSLT_LWIP_BAD_ARG   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 6)
 Denotes BAD arg

 
#define CY_RSLT_LWIP_SOCKET_ERROR   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 7)
 Denotes LwIP socket error

 
#define CY_RSLT_LWIP_SOCKET_CREATE_FAIL   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 8)
 Denotes LwIP socket create fail

 
#define CY_RSLT_LWIP_INVALID_SOCKET   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 9)
 Denotes invalid socket

 
#define CY_RSLT_LWIP_CORRUPT_BUFFER   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 10)
 Denotes corrupt buffer

 
#define CY_RSLT_LWIP_DHCP_TIMEOUT   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 11)
 Denotes DHCP timeout

 
#define CY_RSLT_LWIP_DHCP_WAIT_TIMEOUT   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 12)
 Denotes DHCP wait timeout

 
#define CY_RSLT_LWIP_DHCP_MUTEX_ERROR   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 13)
 Denotes DHCP Mutex error

 
#define CY_RSLT_LWIP_ERROR_STARTING_INTERNAL_DHCP   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 14)
 Denotes failure to start internal DHCP server.
 
#define CY_RSLT_LWIP_INTERFACE_NETWORK_NOT_UP   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 15)
 Denotes network is not up for the given interface.
 
#define CY_RSLT_LWIP_ERROR_REMOVING_INTERFACE   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 16)
 Denotes error while removing interface.
 

Macro Definition Documentation

◆ CY_RSLT_LWIP_INTERFACE_EXISTS

#define CY_RSLT_LWIP_INTERFACE_EXISTS   (CY_RSLT_LWIP_WHD_PORT_ERR_BASE + 1)

CY LWIP error.

Denotes interface already exists