sapi_safestate.h

Go to the documentation of this file.

#ifndef SAFEAPI_COMMON_SAFESTATE_H
#define SAFEAPI_COMMON_SAFESTATE_H
 
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum sapi_safestate_level_e
{
    SAPI_SAFESTATE_LEVEL_DEGRADED = 0,

    SAPI_SAFESTATE_LEVEL_SAFE = 1,

    SAPI_SAFESTATE_LEVEL_REBOOT = 2
} sapi_safestate_level_t;

typedef uint16_t sapi_safestate_reason_t;

#define SAPI_SAFESTATE_REASON_UNSPECIFIED    ((sapi_safestate_reason_t)0U)
#define SAPI_SAFESTATE_REASON_ASSERT_FAILED  ((sapi_safestate_reason_t)1U)
#define SAPI_SAFESTATE_REASON_CHECKPOINT_TIMEOUT ((sapi_safestate_reason_t)2U)
#define SAPI_SAFESTATE_REASON_APPLICATION_BASE ((sapi_safestate_reason_t)4096U)

typedef void (*sapi_safestate_handler_t)(sapi_safestate_level_t level,
                                          sapi_safestate_reason_t reason,
                                          const char *file,
                                          int32_t line,
                                          const char *message);

sapi_status_t sapi_safestate_register_handler(sapi_safestate_level_t level,
                                               sapi_safestate_handler_t handler);

void sapi_safestate_enter(sapi_safestate_level_t level,
                           sapi_safestate_reason_t reason,
                           const char *file,
                           int32_t line,
                           const char *message);

#define SAPI_ASSERT(cond)                                                    \
    do                                                                       \
    {                                                                        \
        if (!(cond))                                                         \
        {                                                                    \
            sapi_safestate_enter(SAPI_SAFESTATE_LEVEL_SAFE,                  \
                                  SAPI_SAFESTATE_REASON_ASSERT_FAILED,        \
                                  __FILE__, (int32_t)__LINE__, #cond);        \
        }                                                                    \
    } while (0)

#define SAPI_SAFESTATE(level, reason) \
    sapi_safestate_enter((level), (reason), __FILE__, (int32_t)__LINE__, NULL)

#define SAPI_REBOOT(reason) \
    sapi_safestate_enter(SAPI_SAFESTATE_LEVEL_REBOOT, (reason), __FILE__, (int32_t)__LINE__, NULL)
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAFEAPI_COMMON_SAFESTATE_H */
 /* SAFESTATE */