ab_gp_db.h

Go to the documentation of this file.

#ifndef RTE_EXAMPLE_AB_GP_DB_H
#define RTE_EXAMPLE_AB_GP_DB_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "rte/utils/status/rte_status.h"
 
#include "../../common/common_config.h"

#ifndef AB_GP_DB_ROUTE_IL_STATUS_T_DEFINED
#define AB_GP_DB_ROUTE_IL_STATUS_T_DEFINED
typedef enum
{
    AB_GP_DB_ROUTE_IL_STATUS_UNKNOWN = 0, 
    AB_GP_DB_ROUTE_IL_STATUS_FREE,        
    AB_GP_DB_ROUTE_IL_STATUS_RESERVED,    
    AB_GP_DB_ROUTE_IL_STATUS_LOCKED       
} ab_gp_db_route_il_status_t;
#endif

typedef struct
{
    uint16_t                 id;           
    uint16_t                 start_signal; 
    uint16_t                 end_signal;   
    bool                     occupied;     
    ab_gp_db_route_il_status_t  il_status;    
    uint32_t                 route_type;   
    bool                     used_in_ma;   
    uint8_t                  train_id;     
    uint32_t                 route_fsm_state; 
} ab_gp_db_route_t;

typedef struct
{
    uint8_t  nid_engine;   
    bool     connected;     
    bool     has_ma;         
 
    uint16_t route_ids[RTE_EXAMPLE_MAX_ROUTES_PER_TRAIN]; 
    uint8_t  route_count;    
 
    uint32_t last_nid_lrbg;  
} ab_gp_db_train_t;

#ifndef AB_GP_DB_T_DEFINED
#define AB_GP_DB_T_DEFINED
typedef struct ab_gp_db_s
{
    ab_gp_db_train_t trains[RTE_EXAMPLE_MAX_TRAINS];
    ab_gp_db_route_t routes[RTE_EXAMPLE_MAX_ROUTES];
} ab_gp_db_t;
#endif


bool ab_gp_db_route_connect_train(ab_gp_db_t *db, uint16_t route_id, uint8_t train_id);

bool ab_gp_db_route_disconnect_train(ab_gp_db_t *db, uint16_t route_id);


bool ab_gp_db_route_exists(const ab_gp_db_t *db, uint16_t route_id);

bool ab_gp_db_route_add(ab_gp_db_t *db, uint16_t route_id, uint16_t start_signal, uint16_t end_signal);

bool ab_gp_db_route_remove(ab_gp_db_t *db, uint16_t route_id);
 
/* ab_gp_db_route_get_status()/_get_used_in_ma()/_get_type() - REMOVED
 * (later session, on direct request - "it will be enough if GA can
 * getTrainContext/getRouteContext; setters stay separate since they
 * require validation"): every one of these is now a field on the ONE
 * ab_gp_db_get_route_context() snapshot below (dead in GP itself too -
 * zero internal callers, they existed purely for GA). */

bool ab_gp_db_route_set_status(ab_gp_db_t *db, uint16_t route_id, ab_gp_db_route_il_status_t status);

bool ab_gp_db_route_set_type(ab_gp_db_t *db, uint16_t route_id, uint32_t route_type);

bool ab_gp_db_route_set_fsm_state(ab_gp_db_t *db, uint16_t route_id, uint32_t fsm_state);
uint32_t ab_gp_db_route_get_fsm_state(const ab_gp_db_t *db, uint16_t route_id);

uint8_t ab_gp_db_route_get_count(const ab_gp_db_t *db);

bool ab_gp_db_route_get_by_index(const ab_gp_db_t *db, uint8_t index, uint16_t *out_route_id,
                                 uint16_t *out_start_signal, uint16_t *out_end_signal,
                                 uint8_t *out_train_id, bool *out_used_in_ma);

bool ab_gp_db_train_is_connected(const ab_gp_db_t *db, uint8_t train_id);

bool ab_gp_db_train_get_routes(const ab_gp_db_t *db, uint8_t train_id,
                               uint16_t out_routes[RTE_EXAMPLE_MAX_ROUTES_PER_TRAIN],
                               uint8_t *out_count);
 


#ifndef AB_GP_ROUTE_UPDATE_TYPE_T_DEFINED
#define AB_GP_ROUTE_UPDATE_TYPE_T_DEFINED
typedef enum
{
    AB_ROUTE_ADDED,          
    AB_ROUTE_STATUS_CHANGED, 
    AB_ROUTE_CONNECTED,      
    AB_ROUTE_DISCONNECTED    
} ab_gp_route_update_type_t;
#endif

#ifndef AB_GP_ROUTE_CONTEXT_T_DEFINED
#define AB_GP_ROUTE_CONTEXT_T_DEFINED
typedef struct
{
    uint16_t                   id;
    uint16_t                   start_signal;
    uint16_t                   end_signal;
    ab_gp_db_route_il_status_t il_status;
    uint32_t                   route_type;
    bool                       used_in_ma;
    uint8_t                    train_id; 
} ab_gp_route_context_t;
#endif
 
#ifndef AB_GP_DB_ROUTE_NOTIFY_FN_DEFINED
#define AB_GP_DB_ROUTE_NOTIFY_FN_DEFINED
typedef void (*ab_gp_route_context_notify_fn)(const void *context, const ab_gp_route_context_t *ctx,
                                            ab_gp_route_update_type_t update_type);
#endif

#define AB_GP_DB_MAX_ROUTE_CONTEXT_SUBSCRIBERS 4U

rte_status_t ab_gp_db_register_route_context_notify(ab_gp_route_context_notify_fn fn, const void *context);

bool ab_gp_db_get_route_context(const ab_gp_db_t *db, uint16_t route_id, ab_gp_route_context_t *out_ctx);


rte_status_t ab_gp_db_encode(const ab_gp_db_t *db, uint8_t *out_bytes, uint32_t out_capacity, uint32_t *out_written);

rte_status_t ab_gp_db_decode(ab_gp_db_t *db, const uint8_t *in_bytes, uint32_t in_size);

 
#endif /* RTE_EXAMPLE_AB_GP_DB_H */