hdlc_decoder.h

Go to the documentation of this file.

/*
 * ether2ser — Ethernet <-> synchronous V.24 (RS-232/V.28) bridge
 *
 * File:    src/protocol/hdlc_decoder.h
 * Purpose: HDLC decoder API.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright (c) 2026 Florian <f.leuze@outlook.de>
 */
 
#ifndef HDLC_DECODER_H
#define HDLC_DECODER_H
 
// Related headers
 
// Standard library headers
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
// Project Headers
#include "hdlc_common.h"
 
// Generated headers
 
typedef struct
{
    uint64_t invalid_frame;
    uint64_t too_short;
    uint64_t payload_too_long;
    uint64_t unstuff_error;
    uint64_t crc_mismatch;
} hdlc_decode_stats_t;
 
bool hdlc_decode(const HDLC_FRAME_T* frame, uint8_t* payload, const size_t out_capacity,
                 size_t* payload_length, bool lsb_first);
 
bool hdlc_decode_byte(const HDLC_FRAME_T* frame, uint8_t* payload, const size_t out_capacity,
                      size_t* payload_length);
 
void hdlc_decode_stats_snapshot(hdlc_decode_stats_t* out_stats);
 
void hdlc_decode_stats_reset(void);
 
#endif /* HDLC_DECODER_H */