tiny_types.h

Go to the documentation of this file.

/*
    Copyright 2016-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

#ifdef __cplusplus
extern "C"
{
#endif

#if defined(CONFIG_ENABLE_CPP_HAL)
#include "cpp/cpp_hal.h"
#elif defined(TINY_CUSTOM_PLATFORM)
#include "no_platform/no_platform_hal.h"
#elif defined(__AVR__)
#include "avr/avr_hal.h"
#elif defined(__XTENSA__)
#include "esp32/esp32_hal.h"
#elif defined(ARDUINO)
#include "arduino/arduino_hal.h"
#elif defined(__linux__)
#include "linux/linux_hal.h"
#elif defined(__APPLE__) && defined(__MACH__)
#include "macos/macos_hal.h"
#elif defined(__MINGW32__)
#include "mingw32/mingw32_hal.h"
#elif defined(_WIN32)
#include "win32/win32_hal.h"
#elif defined(CPU_S32K144HFT0VLLT)
#include "freertos/freertos_hal.h"
#else
#info "Platform not supported. Multithread support is disabled"
#include "no_platform/no_platform_hal.h"
#endif

#include <stdint.h>
#include <stdbool.h>


#ifndef CONFIG_TINYHAL_THREAD_SUPPORT

#define CONFIG_TINYHAL_THREAD_SUPPORT 0
#endif


#if defined(_MSC_VER)
#define TINY_ALIGNED(x)   __declspec(align(x))
#elif defined(__GNUC__)
#define TINY_ALIGNED(x)   __attribute__ ((aligned (x)))
#else
#define TINY_ALIGNED(x)
#endif


#if defined(__TARGET_CPU_CORTEX_M0) || defined(__TARGET_CPU_CORTEX_M0_) || defined(__ARM_ARCH_6M__) || \
    defined(__TARGET_CPU_CORTEX_M3) || defined(__TARGET_CPU_CORTEX_M4) || defined(__ARM_ARCH_7EM__) || \
    defined(__ARM_ARCH_7M__)

#define TINY_ALIGN_STRUCT_VALUE     (sizeof(uintptr_t))

#elif defined(_MSC_VER)

// MS Compiler at least in MSVC 2019 doesn't support sizeof and braces in __declspec(align(x)).
#define TINY_ALIGN_STRUCT_VALUE  8

#else

#define TINY_ALIGN_STRUCT_VALUE     (uintptr_t)(sizeof(uintptr_t))

#endif

#define TINY_ALIGNED_STRUCT TINY_ALIGNED(TINY_ALIGN_STRUCT_VALUE)

#define TINY_ALIGN_BUFFER(x) ((uint8_t *)( ((uintptr_t)x + TINY_ALIGN_STRUCT_VALUE - 1) & (~(TINY_ALIGN_STRUCT_VALUE - 1)) ))

#define TINY_SUCCESS (0)
#define TINY_ERR_FAILED (-1)
#define TINY_ERR_TIMEOUT (-2)
#define TINY_ERR_DATA_TOO_LARGE (-3)
#define TINY_ERR_INVALID_DATA (-4)
#define TINY_ERR_BUSY (-5)
#define TINY_ERR_OUT_OF_SYNC (-6)
#define TINY_ERR_AGAIN (-7)
#define TINY_ERR_WRONG_CRC (-8)
#define TINY_ERR_OUT_OF_MEMORY (-9)
#define TINY_ERR_UNKNOWN_PEER (-10)
#define TINY_ERR_IO (-11)

#define TINY_FLAG_NO_WAIT (0)
#define TINY_FLAG_READ_ALL (1)
#define TINY_FLAG_LOCK_SEND (2)
#define TINY_FLAG_WAIT_FOREVER (0x80)

    typedef int (*write_block_cb_t)(void *pdata, const void *buffer, int size);

    typedef int (*read_block_cb_t)(void *pdata, void *buffer, int size);

    typedef void (*on_frame_cb_t)(void *udata, uint8_t *pdata, int size);

    typedef void (*on_tx_frame_cb_t)(void *udata, const uint8_t *pdata, int size);

    typedef void (*on_frame_read_cb_t)(void *udata, uint8_t address, uint8_t *pdata, int size);

    typedef void (*on_frame_send_cb_t)(void *udata, uint8_t address, const uint8_t *pdata, int size);

    typedef void (*on_connect_event_cb_t)(void *udata, uint8_t address, bool connected);

#define EVENT_BITS_ALL 0xFF 
#define EVENT_BITS_CLEAR 1  
#define EVENT_BITS_LEAVE 0  


    void tiny_mutex_create(tiny_mutex_t *mutex);

    void tiny_mutex_destroy(tiny_mutex_t *mutex);

    void tiny_mutex_lock(tiny_mutex_t *mutex);

    uint8_t tiny_mutex_try_lock(tiny_mutex_t *mutex);

    void tiny_mutex_unlock(tiny_mutex_t *mutex);

    void tiny_events_create(tiny_events_t *events);

    void tiny_events_destroy(tiny_events_t *events);

    uint8_t tiny_events_wait(tiny_events_t *event, uint8_t bits, uint8_t clear, uint32_t timeout);

    uint8_t tiny_events_check_int(tiny_events_t *event, uint8_t bits, uint8_t clear);

    void tiny_events_set(tiny_events_t *event, uint8_t bits);

    void tiny_events_clear(tiny_events_t *event, uint8_t bits);

    void tiny_sleep(uint32_t ms);

    void tiny_sleep_us(uint32_t us);

    uint32_t tiny_millis();

    uint32_t tiny_micros();

    void tiny_log_level(uint8_t level);

#ifdef __cplusplus
}
#endif