tiny_light.h

Go to the documentation of this file.

/*
    Copyright 2017-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.
*/

#ifndef _TINY_LIGHT_H_
#define _TINY_LIGHT_H_

#include "proto/hdlc/low_level/hdlc.h"
#include "hal/tiny_types.h"

#ifdef __cplusplus
extern "C"
{
#endif

/*************************************************************
 *
 *          Tiny defines
 *
 *************************************************************/

#define LIGHT_BUF_SIZE (sizeof(uintptr_t) * 18)

    typedef struct
    {
        write_block_cb_t write_func;
        read_block_cb_t read_func;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
        hdlc_ll_handle_t _hdlc;
        int rx_len;
        TINY_ALIGNED_STRUCT uint8_t buffer[LIGHT_BUF_SIZE];
#endif
        void *user_data;
        hdlc_crc_t crc_type;
    } STinyLightData;

    extern int tiny_light_init(STinyLightData *handle, write_block_cb_t write_func, read_block_cb_t read_func,
                               void *pdata);

    extern int tiny_light_close(STinyLightData *handle);

    extern int tiny_light_send(STinyLightData *handle, const uint8_t *pbuf, int len);

    extern int tiny_light_read(STinyLightData *handle, uint8_t *pbuf, int len);

    extern hdlc_ll_handle_t tiny_light_get_hdlc(STinyLightData *handle);

#ifdef __cplusplus
}
#endif

#endif /* _TINY_PROTOCOL_H_ */