hdlc.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 TINY_HDLC_FILL_BYTE 0xFF

    typedef enum
    {
        HDLC_LL_RESET_BOTH = 0x00,
        HDLC_LL_RESET_TX_ONLY = 0x01,
        HDLC_LL_RESET_RX_ONLY = 0x02,
    } hdlc_ll_reset_flags_t;

    struct hdlc_ll_data_t;

    typedef struct hdlc_ll_data_t *hdlc_ll_handle_t;

    typedef struct
    {
        on_frame_cb_t on_frame_read;

        on_tx_frame_cb_t on_frame_send;

        void *buf;

        int buf_size;

        hdlc_crc_t crc_type;

        void *user_data;

        int mtu;
    } hdlc_ll_init_t;

    //------------------------ GENERIC FUNCIONS ------------------------------

    int hdlc_ll_init(hdlc_ll_handle_t *handle, hdlc_ll_init_t *init);

    int hdlc_ll_close(hdlc_ll_handle_t handle);

    void hdlc_ll_reset(hdlc_ll_handle_t handle, uint8_t flags);

    //------------------------ RX FUNCIONS ------------------------------

    int hdlc_ll_run_rx(hdlc_ll_handle_t handle, const void *data, int len, int *error);

    //------------------------ TX FUNCIONS ------------------------------

    int hdlc_ll_run_tx(hdlc_ll_handle_t handle, void *data, int len);

    int hdlc_ll_put(hdlc_ll_handle_t handle, const void *data, int len) __attribute__((deprecated));

    int hdlc_ll_put_frame(hdlc_ll_handle_t handle, const void *data, int len);

    int hdlc_ll_get_buf_size(int mtu);

    int hdlc_ll_get_buf_size_ex(int mtu, hdlc_crc_t crc_type, int rx_window);

#ifdef __cplusplus
}
#endif