ab_gp_train.h

Go to the documentation of this file.

#ifndef RTE_EXAMPLE_AB_GP_TRAIN_H
#define RTE_EXAMPLE_AB_GP_TRAIN_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "rte/utils/status/rte_status.h"
 
#include "../../common/common_config.h"
#include "../../common/rbc_wire_types.h"
#include "../../common/site_config.h"
#include "../db/ab_gp_db.h"

#ifndef TRAIN_SESSION_T_DEFINED
#define TRAIN_SESSION_T_DEFINED
typedef struct train_session_s
{
    bool     in_use;          
    uint8_t  train_id;        
    uint32_t cycle;            
    uint32_t d_lrbg;           
    uint32_t granted_length;   
    uint32_t ma_seq;            
    bool     ma_pending_send;  
    bool     ma_acked;          
 
    /* --- ADR-029: sticky (not per-cycle transient) "have I ever sent
     * this one-time CTC indication yet" flags - local scratch only, NOT
     * wire/cross-compare relevant, same posture as ma_pending_send above.
     * Deliberately sticky rather than a cyc_*[] flag set only on the
     * exact cycle the underlying event happened: should_forward_to_c
     * (ab_gp_channel_forward_to_c_if_needed()) can legitimately be false on
     * that exact cycle (e.g. no AGREE yet, right after a fresh connect) -
     * a transient flag would silently lose the notification forever with
     * no later cycle to retry it on (found live: a train's own
     * CTC_CONNECTED notification never arrived because cross-compare
     * had not AGREED yet on the cycle the connect itself was
     * processed). Checked and set only at the moment of an actual send,
     * so they naturally "catch up" whenever should_forward_to_c next
     * becomes true, however many cycles later that is. */
    bool     ctc_connected_sent;  
    bool     ctc_ma_granted_sent; 
    bool     position_reply_pending;  
    uint32_t position_reply_msg_type; 
    bool     ctc_ma_notify_pending;   
 
    /* last_ctc_train_info_(fields) / ctc_train_info_sent (the
     * RBC_MSG_CTC_TRAIN_INFO on-change comparison snapshot) REMOVED
     * (interface-simplification
     * pass) - GA no longer polls this session every cycle and diffs it;
     * ab_gp_register_train_context_notify() (this file's own "GA
     * notification" section) pushes a full ab_gp_train_context_t
     * snapshot exactly when something real changes instead. */
    uint32_t v_train;                           
    uint32_t m_mode;                            
} ab_gp_train_session_t;
#endif

#define RTE_EXAMPLE_TRAIN_SESSION_WIRE_SIZE 19U

rte_status_t ab_gp_train_init(void);

uint32_t ab_gp_train_payload_collector_id(void);


#ifndef AB_GP_TRAIN_UPDATE_TYPE_T_DEFINED
#define AB_GP_TRAIN_UPDATE_TYPE_T_DEFINED
typedef enum
{
    AB_TRAIN_REGISTERED,               
    AB_TRAIN_REMOVED,                  
    AB_TRAIN_POSITION,                 
    AB_TRAIN_MA_CHANGED,                
    AB_TRAIN_EMERGENCY_REACTION_RAISED  
} ab_gp_train_update_type_t;
#endif

#ifndef AB_GP_TRAIN_CONTEXT_T_DEFINED
#define AB_GP_TRAIN_CONTEXT_T_DEFINED
typedef struct
{
    uint8_t  train_id;
    bool     in_use;
    uint32_t cycle;
    uint32_t d_lrbg;
    uint32_t nid_lrbg;
    uint32_t v_train;
    uint32_t m_mode;
    uint32_t granted_length;
    uint32_t ma_seq;
    bool     ma_acked;
    bool     has_ma;
    bool     ma_pending_send;
    bool     ctc_connected_sent;
    bool     ctc_ma_granted_sent;
    bool     ctc_ma_notify_pending;
    uint16_t route_ids[RTE_EXAMPLE_MAX_ROUTES_PER_TRAIN];
    uint8_t  route_count;
} ab_gp_train_context_t;
#endif
 
#ifndef AB_GP_TRAIN_NOTIFY_FN_DEFINED
#define AB_GP_TRAIN_NOTIFY_FN_DEFINED
typedef void (*ab_gp_train_context_notify_fn)(const void *context, const ab_gp_train_context_t *ctx,
                                            ab_gp_train_update_type_t update_type);
#endif

#define AB_GP_TRAIN_MAX_CONTEXT_SUBSCRIBERS 4U

rte_status_t ab_gp_register_train_context_notify(ab_gp_train_context_notify_fn fn, const void *context);

bool ab_gp_get_train_context(const ab_gp_train_session_t sessions[], const ab_gp_db_t *db, uint8_t train_id,
                              ab_gp_train_context_t *out_ctx);

void ab_gp_train_notify_context_changed(const ab_gp_train_session_t sessions[], const ab_gp_db_t *db,
                                         uint8_t train_id, ab_gp_train_update_type_t update_type);

bool ab_gp_train_add(ab_gp_db_t *db, uint8_t train_id, uint8_t nid_engine);

bool ab_gp_train_remove(ab_gp_db_t *db, uint8_t train_id);

ab_gp_db_train_t *ab_gp_train_find(ab_gp_db_t *db, uint8_t train_id);

bool ab_gp_train_find_by_nid_engine(const ab_gp_db_t *db, uint8_t nid_engine, uint8_t *out_train_id);

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

bool ab_gp_train_get_nid_engine(const ab_gp_db_t *db, uint8_t train_id, uint8_t *out_nid_engine);
 
/* ab_gp_train_get_has_ma() - REMOVED (dead: zero GP-internal callers,
 * and GA's own former use is now ab_gp_get_train_context()'s
 * ->has_ma field). */

bool ab_gp_train_get_route_count(const ab_gp_db_t *db, uint8_t train_id, uint8_t *out_route_count);

bool ab_gp_train_set_nid_engine(ab_gp_db_t *db, uint8_t train_id, uint8_t nid_engine);

bool ab_gp_train_set_has_ma(ab_gp_db_t *db, uint8_t train_id, bool has_ma);

bool ab_gp_train_get_last_position(const ab_gp_db_t *db, uint8_t train_id, uint32_t *out_nid_lrbg);

bool ab_gp_train_set_last_position(ab_gp_db_t *db, uint8_t train_id, uint32_t nid_lrbg);


bool ab_gp_train_handle_connect(ab_gp_db_t *db, uint8_t train_id);

bool ab_gp_train_handle_position_report(ab_gp_db_t *db, uint8_t train_id, uint32_t nid_lrbg);


void ab_gp_train_build_position_answer(uint8_t out[RBC_ENVELOPE_WIRE_SIZE], uint8_t train_id, uint32_t cycle,
                                     uint32_t d_lrbg, uint32_t msg_type);

void ab_gp_train_build_movement_authority(uint8_t out[RBC_ENVELOPE_WIRE_SIZE], uint8_t train_id, uint32_t ma_seq,
                                        uint32_t ma_length);

typedef struct
{
    uint8_t index;
    uint8_t bytes[RBC_ENVELOPE_WIRE_SIZE];
    char    tag[8];
} ab_gp_train_pending_output_t;

#define AB_GP_TRAIN_MAX_PENDING_OUTPUTS ((uint8_t)(RTE_EXAMPLE_MAX_TRAINS * 2U))

uint8_t ab_gp_train_build_outputs(const ab_gp_train_session_t sessions[], const uint32_t cyc_msg_type_due[],
                                const bool cyc_position_reply_due[],
                                ab_gp_train_pending_output_t out[AB_GP_TRAIN_MAX_PENDING_OUTPUTS]);

bool ab_gp_train_apply_envelope(ab_gp_train_session_t sessions[], ab_gp_db_t *db,
                              const uint8_t env_bytes[RBC_ENVELOPE_WIRE_SIZE], uint32_t cycle, bool is_role_a,
                              rte_example_site_t site, const char *role_tag, uint32_t cyc_msg_type_due[],
                              bool cyc_position_reply_due[]);

 
/* ab_gp_train_session_get_in_use()/_get_d_lrbg()/_get_granted_length() -
 * 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 individual reads is now a
 * field on the ONE ab_gp_get_train_context() snapshot above. */

bool ab_gp_train_session_add_granted_length(ab_gp_train_session_t sessions[], uint8_t train_id, uint32_t delta);

bool ab_gp_train_session_set_granted_length(ab_gp_train_session_t sessions[], uint8_t train_id, uint32_t granted_length);

bool ab_gp_train_session_get_ma_seq(const ab_gp_train_session_t sessions[], uint8_t train_id, uint32_t *out_ma_seq);

bool ab_gp_train_session_increment_ma_seq(ab_gp_train_session_t sessions[], uint8_t train_id);
 
/* ab_gp_train_session_get_ma_pending_send()/_get_ctc_connected_sent()/
 * _get_ctc_ma_granted_sent()/_get_ctc_ma_notify_pending() - REMOVED, same
 * reasoning as _get_in_use() etc. above: all four are now fields on
 * ab_gp_get_train_context()'s own snapshot. The matching SETTERS below
 * are unaffected - mutation still needs GP's own validation, per the
 * same direct instruction this whole consolidation follows. */

bool ab_gp_train_session_set_ma_pending_send(ab_gp_train_session_t sessions[], uint8_t train_id, bool pending);

bool ab_gp_train_session_set_ma_acked(ab_gp_train_session_t sessions[], uint8_t train_id, bool acked);

bool ab_gp_train_session_set_ctc_connected_sent(ab_gp_train_session_t sessions[], uint8_t train_id, bool sent);

bool ab_gp_train_session_set_ctc_ma_granted_sent(ab_gp_train_session_t sessions[], uint8_t train_id, bool sent);
 
/* ab_gp_train_session_{get,set}_ctc_train_info_sent / _last_ctc_train_info /
 * _get_v_train_m_mode - REMOVED (interface-simplification pass), see
 * ab_gp_train_session_t's own comment at their old field location. */

bool ab_gp_train_session_set_ctc_ma_notify_pending(ab_gp_train_session_t sessions[], uint8_t train_id, bool pending);
 
#endif /* RTE_EXAMPLE_AB_GP_TRAIN_H */