ab_ga_ertms_ctc_interface.h

 
#ifndef AB_GA_ERTMS_CTC_INTERFACE_H
#define AB_GA_ERTMS_CTC_INTERFACE_H
 
#include "../ab_ga_ertms_types.h"
#include "ab_ga_ertms_ctc_types.h"
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================= */
/* CTC Command IDs (CTC -> RBC)                                              */
/* ========================================================================= */
#define RBC_CTC_CMD_TYPE_ASSIGN_TRAIN_DESCRIBER  0x01U
#define RBC_CTC_CMD_TYPE_SET_TSR                 0x02U
#define RBC_CTC_CMD_TYPE_REVOKE_TSR              0x03U
#define RBC_CTC_CMD_TYPE_EMERGENCY_STOP          0x04U
#define RBC_CTC_CMD_TYPE_REVOKE_EMERGENCY_STOP   0x05U
#define RBC_CTC_CMD_TYPE_QUERY_STATUS            0x06U
 
/* ========================================================================= */
/* CTC Indication IDs (RBC -> CTC)                                           */
/* ========================================================================= */
#define RBC_CTC_IND_TYPE_TRAIN_CONNECTED         0x81U
#define RBC_CTC_IND_TYPE_TRAIN_DISCONNECTED      0x82U
#define RBC_CTC_IND_TYPE_TRAIN_TELEMETRY         0x83U
#define RBC_CTC_IND_TYPE_MA_STATUS_UPDATE        0x84U
#define RBC_CTC_IND_TYPE_TSR_CONFIRMATION        0x85U
#define RBC_CTC_IND_TYPE_ALARM_EVENT             0x86U
#define RBC_CTC_IND_TYPE_RBC_HEALTH              0x87U
 
/* ========================================================================= */
/* CTC Protocol Framing Header                                               */
/* ========================================================================= */
typedef struct rbc_ctc_header_s
{
    uint32_t           sequence_number;
    rbc_timestamp_ms_t timestamp_ms;
    uint8_t            msg_type;
} rbc_ctc_header_t;
 
/* ========================================================================= */
/* CTC -> RBC Commands                                                       */
/* ========================================================================= */
 
typedef struct rbc_ctc_cmd_assign_train_describer_s
{
    rbc_ctc_header_t          header;
    rbc_ctc_train_describer_t describer;
} rbc_ctc_cmd_assign_train_describer_t;
 
typedef struct rbc_ctc_cmd_set_tsr_s
{
    rbc_ctc_header_t      header;
    rbc_ctc_tsr_command_t tsr;
} rbc_ctc_cmd_set_tsr_t;
 
typedef struct rbc_ctc_cmd_revoke_tsr_s
{
    rbc_ctc_header_t header;
    rbc_nid_tsr_t    nid_tsr;
} rbc_ctc_cmd_revoke_tsr_t;
 
typedef struct rbc_ctc_cmd_emergency_stop_s
{
    rbc_ctc_header_t header;
    rbc_nid_engine_t nid_engine; 
    rbc_nid_em_t     nid_em;
} rbc_ctc_cmd_emergency_stop_t;
 
typedef struct rbc_ctc_cmd_revoke_emergency_stop_s
{
    rbc_ctc_header_t header;
    rbc_nid_engine_t nid_engine;
    rbc_nid_em_t     nid_em;
} rbc_ctc_cmd_revoke_emergency_stop_t;
 
/* ========================================================================= */
/* RBC -> CTC Indications                                                    */
/* ========================================================================= */
 
typedef struct rbc_ctc_ind_train_connected_s
{
    rbc_ctc_header_t   header;
    rbc_nid_engine_t   nid_engine;
    rbc_nid_lrbg_t     nid_lrbg;
    rbc_distance_m_t   d_lrbg_m;
    rbc_timestamp_ms_t connection_time_ms;
} rbc_ctc_ind_train_connected_t;
 
typedef struct rbc_ctc_ind_train_disconnected_s
{
    rbc_ctc_header_t   header;
    rbc_nid_engine_t   nid_engine;
    rbc_timestamp_ms_t disconnection_time_ms;
} rbc_ctc_ind_train_disconnected_t;
 
typedef struct rbc_ctc_ind_train_telemetry_s
{
    rbc_ctc_header_t          header;
    rbc_ctc_train_telemetry_t telemetry;
} rbc_ctc_ind_train_telemetry_t;
 
typedef enum rbc_ctc_ma_event_e
{
    RBC_CTC_MA_EVENT_GRANTED   = 0,
    RBC_CTC_MA_EVENT_EXTENDED  = 1,
    RBC_CTC_MA_EVENT_SHORTENED = 2,
    RBC_CTC_MA_EVENT_REVOKED   = 3
} rbc_ctc_ma_event_t;
 
typedef struct rbc_ctc_ind_ma_status_s
{
    rbc_ctc_header_t   header;
    rbc_nid_engine_t   nid_engine;
    rbc_ctc_ma_event_t event;
    uint32_t           ma_seq;
    rbc_distance_m_t   ma_length_m;
    rbc_speed_kmh_t    target_speed_kmh;
} rbc_ctc_ind_ma_status_t;
 
typedef struct rbc_ctc_ind_alarm_s
{
    rbc_ctc_header_t      header;
    rbc_ctc_alarm_event_t alarm;
} rbc_ctc_ind_alarm_t;
 
typedef struct rbc_ctc_ind_health_s
{
    rbc_ctc_header_t   header;
    rbc_nid_rbc_t      nid_rbc;
    bool               is_primary_active;
    bool               ixl_link_healthy;
    uint8_t            connected_train_count;
    uint32_t           cpu_load_percent;
} rbc_ctc_ind_health_t;
 
/* ========================================================================= */
/* Unified Generic Message Containers & Handlers                             */
/* ========================================================================= */
 
typedef struct rbc_ctc_command_s
{
    uint8_t msg_type;
    union
    {
        rbc_ctc_cmd_assign_train_describer_t assign_describer;
        rbc_ctc_cmd_set_tsr_t                set_tsr;
        rbc_ctc_cmd_revoke_tsr_t             revoke_tsr;
        rbc_ctc_cmd_emergency_stop_t         emergency_stop;
        rbc_ctc_cmd_revoke_emergency_stop_t  revoke_emergency_stop;
    } payload;
} rbc_ctc_command_t;
 
typedef struct rbc_ctc_indication_s
{
    uint8_t msg_type;
    union
    {
        rbc_ctc_ind_train_connected_t    train_connected;
        rbc_ctc_ind_train_disconnected_t train_disconnected;
        rbc_ctc_ind_train_telemetry_t    telemetry;
        rbc_ctc_ind_ma_status_t          ma_status;
        rbc_ctc_ind_alarm_t              alarm;
        rbc_ctc_ind_health_t             health;
    } payload;
} rbc_ctc_indication_t;

typedef void (*rbc_ctc_on_command_received_fn)(const rbc_ctc_command_t *cmd, void *user_context);

typedef int (*rbc_ctc_send_indication_fn)(const rbc_ctc_indication_t *ind, void *user_context);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RBC_CTC_INTERFACE_H */