meshx_err.h File Reference

MeshX Error Codes. More...

#include <stdint.h>

Go to the source code of this file.

Macros
#define	MESHX_UNUSED(x)
#define	MESHX_DO_NOTHING   do {} while(0)
#define	MESHX_WEEK   __attribute__((weak))
#define	MESHX_MALLOC   malloc
#define	MESHX_CALOC   calloc
#define	MESHX_FREE   free

Enumerations
enum	meshx_err_t {   MESHX_SUCCESS = 0 ,   MESHX_FAIL ,   MESHX_INVALID_ARG ,   MESHX_ERR_PLAT ,   MESHX_NO_MEM ,   MESHX_INVALID_STATE ,   MESHX_NOT_FOUND ,   MESHX_NOT_SUPPORTED ,   MESHX_TIMEOUT ,   MESHX_ERR_NOT_INIT ,   MESHX_ERR_RO_CFG_BASE = 0x4000 ,   MESHX_ERR_RO_CFG_FORMAT ,   MESHX_ERR_RO_CFG_VERSION ,   MESHX_ERR_RO_CFG_CRC ,   MESHX_ERR_GPIO_BASE = 0x5000 ,   MESHX_ERR_GPIO_INVALID_PIN ,   MESHX_ERR_GPIO_INVALID_MODE ,   MESHX_ERR_GPIO_INVALID_LEVEL ,   MESHX_ERR_GPIO_INTR_NOT_SUPPORTED ,   MESHX_ERR_GPIO_INTR_ALREADY_REGISTERED ,   MESHX_ERR_GPIO_PWM_NOT_SUPPORTED ,   MESHX_ERR_GPIO_PWM_INVALID_PARAM ,   MESHX_ERR_GPIO_NOT_INITIALIZED ,   MESHX_ERR_GPIO_CONFIG_INVALID ,   MESHX_ERR_GPIO_HOSTED_MODE ,   MESHX_ERR_GPIO_KV_STORAGE ,   MESHX_ERR_GPIO_SERIALIZATION ,   MESHX_ERR_MAX }
	MeshX Error Codes. More...

Detailed Description

MeshX Error Codes.

This file contains the MeshX Error Codes.

Author

Pranjal Chanda

Macro Definition Documentation

MESHX_CALOC

#define MESHX_CALOC   calloc

MESHX_DO_NOTHING

#define MESHX_DO_NOTHING   do {} while(0)

MESHX_FREE

#define MESHX_FREE   free

MESHX_MALLOC

#define MESHX_MALLOC   malloc

MESHX_UNUSED

#define MESHX_UNUSED

(

x

)

Value:

((void)(x))

MESHX_WEEK

#define MESHX_WEEK   __attribute__((weak))

Enumeration Type Documentation

meshx_err_t

enum meshx_err_t

MeshX Error Codes.

Enumerator
MESHX_SUCCESS	0	Success
MESHX_FAIL		Failure
MESHX_INVALID_ARG		Invalid Argument
MESHX_ERR_PLAT		Platform Error
MESHX_NO_MEM		No Memory
MESHX_INVALID_STATE		Invalid State
MESHX_NOT_FOUND		Not Found
MESHX_NOT_SUPPORTED		Not Supported
MESHX_TIMEOUT		Timeout
MESHX_ERR_NOT_INIT		Not Initialized
MESHX_ERR_RO_CFG_BASE	0x4000	RO Config error base
MESHX_ERR_RO_CFG_FORMAT		Invalid Format
MESHX_ERR_RO_CFG_VERSION		Invalid Version
MESHX_ERR_RO_CFG_CRC		CRC Error
MESHX_ERR_GPIO_BASE	0x5000	GPIO error base
MESHX_ERR_GPIO_INVALID_PIN		Invalid GPIO pin number
MESHX_ERR_GPIO_INVALID_MODE		Invalid GPIO mode for operation
MESHX_ERR_GPIO_INVALID_LEVEL		Invalid GPIO level value
MESHX_ERR_GPIO_INTR_NOT_SUPPORTED		Interrupt not supported on pin
MESHX_ERR_GPIO_INTR_ALREADY_REGISTERED		Interrupt already registered
MESHX_ERR_GPIO_PWM_NOT_SUPPORTED		PWM not supported on pin
MESHX_ERR_GPIO_PWM_INVALID_PARAM		Invalid PWM parameter
MESHX_ERR_GPIO_NOT_INITIALIZED		GPIO subsystem not initialized
MESHX_ERR_GPIO_CONFIG_INVALID		Invalid GPIO configuration
MESHX_ERR_GPIO_HOSTED_MODE		Operation not allowed in hosted mode
MESHX_ERR_GPIO_KV_STORAGE		KV Engine storage error
MESHX_ERR_GPIO_SERIALIZATION		Configuration serialization error
MESHX_ERR_MAX		Maximum Error

{
    MESHX_SUCCESS = 0,   /**< Success */
    MESHX_FAIL,          /**< Failure */
    MESHX_INVALID_ARG,   /**< Invalid Argument */
    MESHX_ERR_PLAT,      /**< Platform Error */
    MESHX_NO_MEM,        /**< No Memory */
    MESHX_INVALID_STATE, /**< Invalid State */
    MESHX_NOT_FOUND,     /**< Not Found */
    MESHX_NOT_SUPPORTED, /**< Not Supported */
    MESHX_TIMEOUT,       /**< Timeout */
    MESHX_ERR_NOT_INIT,  /**< Not Initialized */
 
    /* RO Config Error Codes (Base: 0x4000) */
    MESHX_ERR_RO_CFG_BASE = 0x4000,          /**< RO Config error base */
    MESHX_ERR_RO_CFG_FORMAT,   /**< Invalid Format */
    MESHX_ERR_RO_CFG_VERSION,  /**< Invalid Version */
    MESHX_ERR_RO_CFG_CRC,      /**< CRC Error */
 
    /* GPIO Error Codes (Base: 0x5000) */
    MESHX_ERR_GPIO_BASE = 0x5000,          /**< GPIO error base */
    MESHX_ERR_GPIO_INVALID_PIN,            /**< Invalid GPIO pin number */
    MESHX_ERR_GPIO_INVALID_MODE,           /**< Invalid GPIO mode for operation */
    MESHX_ERR_GPIO_INVALID_LEVEL,          /**< Invalid GPIO level value */
    MESHX_ERR_GPIO_INTR_NOT_SUPPORTED,     /**< Interrupt not supported on pin */
    MESHX_ERR_GPIO_INTR_ALREADY_REGISTERED,/**< Interrupt already registered */
    MESHX_ERR_GPIO_PWM_NOT_SUPPORTED,      /**< PWM not supported on pin */
    MESHX_ERR_GPIO_PWM_INVALID_PARAM,      /**< Invalid PWM parameter */
    MESHX_ERR_GPIO_NOT_INITIALIZED,        /**< GPIO subsystem not initialized */
    MESHX_ERR_GPIO_CONFIG_INVALID,         /**< Invalid GPIO configuration */
    MESHX_ERR_GPIO_HOSTED_MODE,            /**< Operation not allowed in hosted mode */
    MESHX_ERR_GPIO_KV_STORAGE,             /**< KV Engine storage error */
    MESHX_ERR_GPIO_SERIALIZATION,          /**< Configuration serialization error */
 
    MESHX_ERR_MAX        /**< Maximum Error */
} meshx_err_t;