hdlc_int.h

/*
    Copyright 2019-2025 (C) Alexey Dynda

    This file is part of Tiny Protocol Library.

    GNU General Public License Usage

    Protocol Library is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Protocol Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with Protocol Library.  If not, see <http://www.gnu.org/licenses/>.

    Commercial License Usage

    Licensees holding valid commercial Tiny Protocol licenses may use this file in
    accordance with the commercial license agreement provided in accordance with
    the terms contained in a written agreement between you and Alexey Dynda.
    For further information contact via email on github account.
*/
#pragma once

#include "hal/tiny_types.h"
#include "proto/crc/tiny_crc.h"
#include <stdint.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C"
{
#endif

#define HDLC_MIN_BUF_SIZE(mtu, crc) (sizeof(hdlc_ll_data_t) + (int)(crc) / 8 + (mtu) + TINY_ALIGN_STRUCT_VALUE - 1)

#define HDLC_BUF_SIZE_EX(mtu, crc, window) (sizeof(hdlc_ll_data_t) + ((int)(crc) / 8 + (mtu)) * (window) + TINY_ALIGN_STRUCT_VALUE - 1)

    typedef struct hdlc_ll_data_t
    {
        on_frame_cb_t on_frame_read;

        on_tx_frame_cb_t on_frame_send;

        uint8_t *rx_buf;

        int rx_buf_size;

        hdlc_crc_t crc_type;

        void *user_data;

#ifndef DOXYGEN_SHOULD_SKIP_THIS

        int phys_mtu;
        struct
        {
            int (*state)(hdlc_ll_handle_t handle, const uint8_t *data, int len);
            // pointer to the next byte in frame buffer
            uint8_t *ptr;
            uint8_t escape;
            // pointer to the start of the frame buffer
            uint8_t *active_frame_buf;
        } rx;

        struct
        {
            int (*state)(hdlc_ll_handle_t handle);
            uint8_t *out_buffer;
            int out_buffer_len;
            const uint8_t *origin_data;
            const uint8_t *data;
            int len;
            crc_t crc;
            uint8_t escape;
        } tx;
#endif
    } hdlc_ll_data_t;

#ifdef __cplusplus
}
#endif