Middleware utilities enumerated types

group group_utils_enums

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

  • module base

  • type

  • error code

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

Refer to 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 below

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 of the respetcive libraries

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

Each middleware module has been reserved with 128 error codes

Defines

CY_RSLT_MODULE_MDNS_BASE

MDNS module base.

CY_RSLT_MODULE_AWS_BASE

AWS IoT module base.

CY_RSLT_MODULE_JSON_BASE

JSON parser module base.

CY_RSLT_MODULE_LINKED_LIST_BASE

Linked list module base.

CY_RSLT_MODULE_COMMAND_CONSOLE_BASE

command console module base

CY_RSLT_MODULE_HTTP_SERVER

HTTP server module base.

CY_RSLT_MODULE_ENTERPRISE_SECURITY_BASE

Enterprise Security base.

CY_RSLT_MODULE_TCPIP_BASE

TCP/IP module base.

CY_RSLT_MODULE_MW_BASE

Generic middleware module base.

CY_RSLT_MODULE_TLS_BASE

TLS module base.

CY_RSLT_MODULE_SECURE_SOCKETS_BASE

Secure Sockets module base.

CY_RSLT_MODULE_WCM_BASE

WiFi Connection Manager (WCM) module base.

CY_RSLT_MODULE_LWIP_WHD_PORT_BASE

lwIP WHD port module base

CY_RSLT_MODULE_OTA_UPDATE_BASE

Over The Air Update Module base (OTA)

CY_RSLT_MODULE_HTTP_CLIENT

HTTP Client module base.