ab_gp_ertms_train_packet_codec.h

Go to the documentation of this file.

 
#ifndef AB_GP_ERTMS_TRAIN_PACKET_CODEC_H
#define AB_GP_ERTMS_TRAIN_PACKET_CODEC_H
 
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "ab_gp_ertms_train_packets.h"
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================= */
/* Low-level bounded big-endian byte primitives.                             */
/*                                                                           */
/* Shared by the per-packet functions below AND by                          */
/* ab_gp_ertms_train_message_codec.c's own message-header encode/decode - a  */
/* message header is not itself a Subset-026 "packet" so it has no          */
/* dedicated function here, but needs the same bounds-checked primitives.    */
/* ========================================================================= */
bool rbc_codec_read_u8(const uint8_t *buf, size_t len, size_t *offset, uint8_t *val);
bool rbc_codec_read_u16_be(const uint8_t *buf, size_t len, size_t *offset, uint16_t *val);
bool rbc_codec_read_u32_be(const uint8_t *buf, size_t len, size_t *offset, uint32_t *val);
bool rbc_codec_write_u8(uint8_t *buf, size_t cap, size_t *offset, uint8_t val);
bool rbc_codec_write_u16_be(uint8_t *buf, size_t cap, size_t *offset, uint16_t val);
bool rbc_codec_write_u32_be(uint8_t *buf, size_t cap, size_t *offset, uint32_t val);
bool rbc_codec_write_u64_be(uint8_t *buf, size_t cap, size_t *offset, uint64_t val);
 
/* ========================================================================= */
/* Packet decode (Train -> RBC): Packet 0 / Packet 1, carried bare (Msg      */
/* 129/130/132) or behind a leading NID_PACKET choice byte (Msg 136).        */
/* ========================================================================= */
bool rbc_packet_read_0_position_report(const uint8_t *buf, size_t len, size_t *offset,
                                       rbc_packet_0_position_report_t *out_p0);
bool rbc_packet_read_1_position_report_2bg(const uint8_t *buf, size_t len, size_t *offset,
                                           rbc_packet_1_position_report_2bg_t *out_p1);
 
/* ========================================================================= */
/* Packet encode (RBC -> Train), one per optional/mandatory packet a         */
/* track-to-train message can carry.                                        */
/* ========================================================================= */
bool rbc_packet_write_15_ma(uint8_t *buf, size_t cap, size_t *offset, const rbc_packet_15_ma_t *ma);
bool rbc_packet_write_21_gradient_profile(uint8_t *buf, size_t cap, size_t *offset,
                                          const rbc_packet_21_gradient_profile_t *gradient);
bool rbc_packet_write_27_ssp(uint8_t *buf, size_t cap, size_t *offset, const rbc_packet_27_ssp_t *ssp);
bool rbc_packet_write_5_linking(uint8_t *buf, size_t cap, size_t *offset, const rbc_packet_5_linking_t *linking);
bool rbc_packet_write_3_national_values(uint8_t *buf, size_t cap, size_t *offset,
                                        const rbc_packet_3_national_values_t *nv);
bool rbc_packet_write_57_ma_request_params(uint8_t *buf, size_t cap, size_t *offset,
                                           const rbc_packet_57_ma_request_params_t *params);
bool rbc_packet_write_58_pr_params(uint8_t *buf, size_t cap, size_t *offset,
                                   const rbc_packet_58_pr_params_t *params);
bool rbc_packet_write_65_tsr(uint8_t *buf, size_t cap, size_t *offset, const rbc_packet_65_tsr_t *tsr);
bool rbc_packet_write_66_tsr_revoke(uint8_t *buf, size_t cap, size_t *offset,
                                    const rbc_packet_66_tsr_revoke_t *revoke);
bool rbc_packet_write_72_text_message(uint8_t *buf, size_t cap, size_t *offset,
                                      const rbc_packet_72_text_message_t *text);
bool rbc_packet_write_131_rbc_transition(uint8_t *buf, size_t cap, size_t *offset,
                                         const rbc_packet_131_rbc_transition_t *transition);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RBC_TRAIN_PACKET_CODEC_H */