hsm.h

Go to the documentation of this file.

 
#ifndef ECU_HSM_H_
#define ECU_HSM_H_
 
/*------------------------------------------------------------*/
/*------------------------- INCLUDES -------------------------*/
/*------------------------------------------------------------*/
 
/* STDLib. */
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
/* ECU. */
#include "ecu/utils.h"
 
/*------------------------------------------------------------*/
/*---------------------- DEFINES AND MACROS ------------------*/
/*------------------------------------------------------------*/
 
#define ECU_HSM_GET_CONTEXT(ecu_hsm_ptr_, type_, member_) \
    ECU_CONTAINER_OF(ecu_hsm_ptr_, type_, member_)
 
#define ECU_HSM_STATE_ENTRY_UNUSED \
    ((void (*)(struct ecu_hsm *))0)
 
#define ECU_HSM_STATE_EXIT_UNUSED \
    ((void (*)(struct ecu_hsm *))0)
 
#define ECU_HSM_STATE_INITIAL_UNUSED \
    ((void (*)(struct ecu_hsm *))0)
 
#define ECU_HSM_STATE_CTOR(entry_, exit_, initial_, handler_, parent_) \
    {                                                                  \
        .entry = (entry_),                                             \
        .exit = (exit_),                                               \
        .initial = (initial_),                                         \
        .handler = (handler_),                                         \
        .parent = (parent_)                                            \
    }
 
/*------------------------------------------------------------*/
/*---------------------------- HSM ---------------------------*/
/*------------------------------------------------------------*/
 
/* Forward declaration for ecu_hsm_state. */
struct ecu_hsm;
 
struct ecu_hsm_state
{
/* Normally, pointers are const-qualified to only allow states to
be created at compile-time. Const is stripped only for unit tests
since test code framework requires state creation at run-time. */
#ifdef ECU_UNIT_TEST
    void (*entry)(struct ecu_hsm *me);
 
    void (*exit)(struct ecu_hsm *me);
 
    void (*initial)(struct ecu_hsm *me);
 
    bool (*handler)(struct ecu_hsm *me, const void *event);
 
    const struct ecu_hsm_state *parent;
#else
    void (*const entry)(struct ecu_hsm *me);
 
    void (*const exit)(struct ecu_hsm *me);
 
    void (*const initial)(struct ecu_hsm *me);
 
    bool (*const handler)(struct ecu_hsm *me, const void *event);
 
    const struct ecu_hsm_state *const parent;
#endif
};
 
struct ecu_hsm
{
    const struct ecu_hsm_state *state;
 
    uint8_t height;
 
    uint32_t transition;
};
 
/*------------------------------------------------------------*/
/*---------------------- GLOBAL VARIABLES --------------------*/
/*------------------------------------------------------------*/
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern const struct ecu_hsm_state ECU_HSM_TOP_STATE;
 
/*------------------------------------------------------------*/
/*-------------------- HSM MEMBER FUNCTIONS ------------------*/
/*------------------------------------------------------------*/
 
extern void ecu_hsm_ctor(struct ecu_hsm *me,
                         const struct ecu_hsm_state *state,
                         uint8_t height);
extern void ecu_hsm_change_state(struct ecu_hsm *me, const struct ecu_hsm_state *state);
 
extern void ecu_hsm_dispatch(struct ecu_hsm *me, const void *event);
 
extern void ecu_hsm_start(struct ecu_hsm *me);
#ifdef __cplusplus
}
#endif
 
#endif /* ECU_HSM_H_ */