hdlc.h

/*
    Copyright 2019-2024 (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/hdlc/low_level/hdlc.h"
#include "proto/crc/tiny_crc.h"
#include <stdint.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C"
{
#endif

    typedef struct _hdlc_handle_t
    {
        write_block_cb_t send_tx;

        int (*on_frame_read)(void *user_data, void *data, int len);

        int (*on_frame_send)(void *user_data, const void *data, int len);

        void *rx_buf;

        int rx_buf_size;

        hdlc_crc_t crc_type;

        bool multithread_mode;

        void *user_data;

#ifndef DOXYGEN_SHOULD_SKIP_THIS

        tiny_events_t events;

        hdlc_ll_handle_t handle;

        int rx_len;
#endif
    } hdlc_struct_t, *hdlc_handle_t; 

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

    hdlc_handle_t hdlc_init(hdlc_struct_t *hdlc_info);

    int hdlc_close(hdlc_handle_t handle);

    void hdlc_reset(hdlc_handle_t handle);

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

    int hdlc_run_rx(hdlc_handle_t handle, const void *data, int len, int *error);

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

    int hdlc_run_tx(hdlc_handle_t handle);

    int hdlc_get_tx_data(hdlc_handle_t handle, void *data, int len);

    int hdlc_send(hdlc_handle_t handle, const void *data, int len, uint32_t timeout);

#ifdef __cplusplus
}
#endif