sapi_checksum.h

Go to the documentation of this file.

 
#ifndef SAPI_CHECKSUM_H
#define SAPI_CHECKSUM_H
 
#include <stdint.h>
#include <stddef.h>
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================
 * Types & Constants
 * ========================================================================== */

typedef enum {
    SAPI_CRC64_ERTMS,

    SAPI_CRC64_ISO,

    SAPI_CRC64_XZ
} sapi_crc64_polynomial_t;

typedef uint64_t sapi_crc64_t;

typedef struct {
    sapi_crc64_t computed;  
    sapi_crc64_t expected;  
    uint8_t match;          
} sapi_checksum_result_t;
 
/* ============================================================================
 * API: CRC-64 Computation
 * ========================================================================== */

sapi_status_t sapi_checksum_crc64_init(sapi_crc64_polynomial_t polynomial);

sapi_crc64_t sapi_checksum_crc64(const uint8_t *data, size_t size);

sapi_status_t sapi_checksum_crc64_verify(const uint8_t *data,
                                         size_t size,
                                         sapi_crc64_t expected_crc,
                                         sapi_checksum_result_t *result_out);

sapi_crc64_polynomial_t sapi_checksum_crc64_get_polynomial(void);
 
/* ============================================================================
 * API: Vital Channel Data Wrapper
 * ========================================================================== */

typedef struct {
    uint32_t sequence_number;  
    uint32_t sender_id;        
    uint32_t timestamp_ms;     
    uint8_t  payload_size;     
    uint8_t  padding;          
    uint16_t reserved;         
 
    uint8_t  payload[248];     
    sapi_crc64_t crc64;        
} sapi_vital_message_t;

sapi_status_t sapi_checksum_vital_message_create(
    sapi_vital_message_t *msg_out,
    uint32_t sender_id,
    uint32_t sequence,
    const uint8_t *payload,
    size_t payload_size
);

sapi_status_t sapi_checksum_vital_message_verify(
    const sapi_vital_message_t *msg,
    uint32_t expected_sequence,
    uint8_t *payload_out,
    size_t payload_max_size,
    uint8_t *payload_size_out
);
 
/* ============================================================================
 * API: Statistics & Diagnostics
 * ========================================================================== */

typedef struct {
    uint32_t total_checksums;       
    uint32_t verification_passes;   
    uint32_t verification_failures; 
    uint32_t sequence_errors;       
    uint32_t payload_oversize;      
} sapi_checksum_stats_t;

sapi_status_t sapi_checksum_get_stats(sapi_checksum_stats_t *stats_out);

sapi_status_t sapi_checksum_reset_stats(void);
 
#ifdef __cplusplus
}
#endif

 
#endif /* SAPI_CHECKSUM_H */