ab_gp_proc_emergency_stop.c

Go to the documentation of this file.

 
#include "ab_gp_proc_emergency_stop.h"
#include "../state_machines/ab_gp_dispatch.h"
 
bool ab_gp_proc_emergency_stop_issue_ues(ab_gp_ertms_train_context_t *ctx, uint8_t nid_em)
{
    if (ctx == NULL)
    {
        return false;
    }
 
    ctx->emergency_stop.active = true;
    ctx->emergency_stop.is_conditional = false;
    ctx->emergency_stop.nid_em = (nid_em == 0U) ? 1U : nid_em;
    ctx->emergency_stop.d_ref_m = 0U;
    ctx->emergency_stop.d_emergencystop_m = 0U;
    ctx->emergency_stop.acknowledged = false;
 
    /* Handled from EVERY state (ab_gp_session_fsm.c's own table,
     * deliberately - see that file's own header doc) - an emergency stop
     * command must never be rejectable, so this can only fail on
     * ctx == NULL, already excluded above. */
    (void)ab_gp_dispatch(ctx, AB_GP_SESSION_EVENT_EMERGENCY_STOP_ISSUED);
    return true;
}
 
bool ab_gp_proc_emergency_stop_issue_ces(ab_gp_ertms_train_context_t *ctx,
                                         uint8_t nid_em,
                                         uint32_t d_ref_m,
                                         uint32_t d_emergencystop_m)
{
    if (ctx == NULL)
    {
        return false;
    }
 
    ctx->emergency_stop.active = true;
    ctx->emergency_stop.is_conditional = true;
    ctx->emergency_stop.nid_em = (nid_em == 0U) ? 1U : nid_em;
    ctx->emergency_stop.d_ref_m = d_ref_m;
    ctx->emergency_stop.d_emergencystop_m = d_emergencystop_m;
    ctx->emergency_stop.acknowledged = false;
 
    /* Handled from EVERY state (ab_gp_session_fsm.c's own table,
     * deliberately - see that file's own header doc) - an emergency stop
     * command must never be rejectable, so this can only fail on
     * ctx == NULL, already excluded above. */
    (void)ab_gp_dispatch(ctx, AB_GP_SESSION_EVENT_EMERGENCY_STOP_ISSUED);
    return true;
}
 
bool ab_gp_proc_emergency_stop_handle_ack(ab_gp_ertms_train_context_t *ctx,
                                          uint8_t nid_em,
                                          uint32_t timestamp_ms)
{
    if (ctx == NULL || !ctx->emergency_stop.active)
    {
        return false;
    }
 
    if (nid_em == ctx->emergency_stop.nid_em || nid_em == 0U)
    {
        ctx->emergency_stop.acknowledged = true;
        ctx->emergency_stop.ack_time_ms = timestamp_ms;
        return true;
    }
 
    return false;
}
 
bool ab_gp_proc_emergency_stop_revoke(ab_gp_ertms_train_context_t *ctx, uint8_t nid_em)
{
    if (ctx == NULL || !ctx->emergency_stop.active)
    {
        return false;
    }
 
    if (nid_em == ctx->emergency_stop.nid_em || nid_em == 0U)
    {
        ctx->emergency_stop.active = false;
        ctx->emergency_stop.acknowledged = false;
 
        /* Which of the three revoke outcomes applies is THIS procedure's
         * own domain decision (has_active_ma / train_data.valid), not the
         * state machine's - it fires the one matching event; the table
         * only says each is handled from EMERGENCY_STOP (ab_gp_session_fsm.c's
         * own table), so each call can only fail on ctx == NULL, already
         * excluded above. */
        if (ctx->ma.has_active_ma)
        {
            (void)ab_gp_dispatch(ctx, AB_GP_SESSION_EVENT_EMERGENCY_STOP_REVOKED_TO_FS);
        }
        else if (ctx->train_data.valid)
        {
            (void)ab_gp_dispatch(ctx, AB_GP_SESSION_EVENT_EMERGENCY_STOP_REVOKED_TO_STANDBY);
        }
        else
        {
            (void)ab_gp_dispatch(ctx, AB_GP_SESSION_EVENT_EMERGENCY_STOP_REVOKED_TO_ESTABLISHED);
        }
        return true;
    }
 
    return false;
}