ab_ga_route_fsm.h

Go to the documentation of this file.

 
#ifndef AB_GA_ROUTE_FSM_H
#define AB_GA_ROUTE_FSM_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "ab_ga_il_wire.h" /* ab_ga_il_route_cmd_t */
#include "ga_interface.h"  /* ab_gp_db_t + ab_gp_db_route_get/set_fsm_state() */
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum
{
    AB_GA_ROUTE_STATE_NO_ROUTE = 0, 
    AB_GA_ROUTE_STATE_LOCKED   = 1, 
    AB_GA_ROUTE_STATE_FS       = 2, 
    AB_GA_ROUTE_STATE_OS       = 3, 
    AB_GA_ROUTE_STATE_SH       = 4, 
    AB_GA_ROUTE_STATE_USED     = 5, 
    AB_GA_ROUTE_STATE_DEGRADED = 6  
} ab_ga_route_state_t;

typedef struct
{
    ab_ga_route_state_t from;      
    ab_ga_route_state_t to;        
    bool                changed;   
    bool                is_stub;   
    bool                is_release;
} ab_ga_route_fsm_result_t;

ab_ga_route_fsm_result_t ab_ga_route_fsm_eval(ab_ga_route_state_t from,
                                              const ab_ga_il_route_cmd_t *cmd);

ab_ga_route_fsm_result_t ab_ga_route_fsm_step(ab_gp_db_t *db, uint16_t route_id,
                                              const ab_ga_il_route_cmd_t *cmd,
                                              uint32_t cycle, const char *role_tag);
 
#ifdef __cplusplus
}
#endif
 
#endif /* AB_GA_ROUTE_FSM_H */