pal_err.h

Go to the documentation of this file.

 
#ifndef __PAL_ERR_H__
#define __PAL_ERR_H__
 
#ifdef ESP_PLATFORM
#include "pal_err_esp.h"
#endif

#ifndef pal_err_t
typedef int pal_err_t;
#endif

 
#ifndef PAL_OK
#define PAL_OK 0
#endif
 
#ifndef PAL_FAIL
#define PAL_FAIL -1
#endif
 
#ifndef PAL_ERR_NO_MEM
#define PAL_ERR_NO_MEM -2
#endif
 
#ifndef PAL_ERR_INVALID_ARG
#define PAL_ERR_INVALID_ARG -3
#endif
 
#ifndef PAL_ERR_INVALID_STATE
#define PAL_ERR_INVALID_STATE -4
#endif
 
#ifndef PAL_ERR_INVALID_SIZE
#define PAL_ERR_INVALID_SIZE -5
#endif
 
#ifndef PAL_ERR_NOT_FOUND
#define PAL_ERR_NOT_FOUND -6
#endif
 
#ifndef PAL_ERR_NOT_SUPPORTED
#define PAL_ERR_NOT_SUPPORTED -7
#endif
 
#ifndef PAL_ERR_TIMEOUT
#define PAL_ERR_TIMEOUT -8
#endif
 
#ifndef PAL_ERR_INVALID_CRC
#define PAL_ERR_INVALID_CRC -9
#endif
 
#ifndef PAL_ERR_NOT_FINISHED
#define PAL_ERR_NOT_FINISHED -10
#endif
 
#ifndef PAL_ERR_NOT_ALLOWED
#define PAL_ERR_NOT_ALLOWED -11
#endif
 // end of Error Codes
 
#ifndef PAL_ERR_TO_NAME
static inline const char *_pal_err_to_name(pal_err_t err) {
    switch (err) {
    case PAL_OK:                return "PAL_OK";
    case PAL_FAIL:              return "PAL_FAIL";
    case PAL_ERR_NO_MEM:        return "PAL_ERR_NO_MEM";
    case PAL_ERR_INVALID_ARG:   return "PAL_ERR_INVALID_ARG";
    case PAL_ERR_INVALID_STATE: return "PAL_ERR_INVALID_STATE";
    case PAL_ERR_INVALID_SIZE:  return "PAL_ERR_INVALID_SIZE";
    case PAL_ERR_NOT_FOUND:     return "PAL_ERR_NOT_FOUND";
    case PAL_ERR_NOT_SUPPORTED: return "PAL_ERR_NOT_SUPPORTED";
    case PAL_ERR_TIMEOUT:       return "PAL_ERR_TIMEOUT";
    case PAL_ERR_INVALID_CRC:   return "PAL_ERR_INVALID_CRC";
    case PAL_ERR_NOT_FINISHED:  return "PAL_ERR_NOT_FINISHED";
    case PAL_ERR_NOT_ALLOWED:   return "PAL_ERR_NOT_ALLOWED";
    default:                    return "unknown";
    }
}

#define PAL_ERR_TO_NAME(err) _pal_err_to_name(err)
#endif

#define PAL_CHECK(x, tag, msg)                                  \
    do {                                                        \
        pal_err_t __;                                           \
        if ((__ = (x)) != PAL_OK) {                             \
            PAL_LOGE(tag, "%s (%s)", msg, PAL_ERR_TO_NAME(__)); \
            return __;                                          \
        }                                                       \
    } while (0)

#define PAL_CHECK_COND(cond, tag, msg)  \
    do {                                \
        if (!(cond)) {                  \
            PAL_LOGE(tag, msg);         \
            return PAL_ERR_INVALID_ARG; \
        }                               \
    } while (0)
 // end of pal_err group
 
#endif // __PAL_ERR_H__