types.h

Go to the documentation of this file.

/*
 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of oveRTOS.
 */
 
#ifndef OVE_TYPES_H
#define OVE_TYPES_H
 
#include <stddef.h>
#include <stdint.h>
 
#if !defined(__GNUC__) && !defined(__clang__)
#error "oveRTOS requires a GCC-compatible compiler (gcc or clang). Other toolchains (MSVC, etc.) are not supported: the substrate uses __attribute__ extensions, statement expressions, and other GCC-flavoured features throughout."
#endif
 
/*
 * Public-API annotation macros.
 *
 * The skip-list (bindgen / Zig @cImport / Emscripten / clang-tidy lint)
 * mirrors heap_assert.h: those tools either don't grok the attribute
 * cleanly or never produce a binary the annotation could affect, so
 * expand to nothing there. Mirroring the existing pattern keeps the
 * tooling surface consistent.
 */
#if defined(__BINDGEN__) || defined(__ZIG_CIMPORT__) || defined(__EMSCRIPTEN__) || \
    defined(__OVE_LINT__)
#define OVE_NONNULL(...)
#define OVE_NODISCARD
#define OVE_RETURNS_NONNULL
#define OVE_DEPRECATED(msg)
#else
#define OVE_NONNULL(...) __attribute__((nonnull(__VA_ARGS__)))
 
#define OVE_NODISCARD __attribute__((warn_unused_result))
 
#define OVE_RETURNS_NONNULL __attribute__((returns_nonnull))
 
#define OVE_DEPRECATED(msg) __attribute__((deprecated(msg)))
#endif
 
typedef enum ove_err {
    OVE_OK = 0,
 
    OVE_ERR_NOT_REGISTERED = -1,
 
    OVE_ERR_INVALID_PARAM = -2,
 
    OVE_ERR_NO_MEMORY = -3,
 
    OVE_ERR_TIMEOUT = -4,
 
    OVE_ERR_NOT_SUPPORTED = -5,
 
    OVE_ERR_QUEUE_FULL = -6,
 
    OVE_ERR_ML_FAILED = -7,
 
    OVE_ERR_NET_REFUSED = -8,
 
    OVE_ERR_NET_UNREACHABLE = -9,
 
    OVE_ERR_NET_ADDR_IN_USE = -10,
 
    OVE_ERR_NET_RESET = -11,
 
    OVE_ERR_NET_DNS_FAIL = -12,
 
    OVE_ERR_NET_CLOSED = -13,
 
    OVE_ERR_BUS_NACK = -14,
 
    OVE_ERR_BUS_BUSY = -15,
 
    OVE_ERR_BUS_ERROR = -16,
 
    OVE_ERR_QUEUE_EMPTY = -17,
 
    OVE_ERR_WOULD_BLOCK = -18,
 
    OVE_ERR_EOF = -19,
 
    OVE_ERR_INVAL = -20,
 
    OVE_ERR_NOT_FOUND = -21,
} ove_err_t;
 
#define OVE_WAIT_FOREVER UINT64_MAX
 
/*
 * Compile-time C-ABI shape check.  This file IS the C-ABI contract;
 * the assertions below pin the numeric values that every binding
 * (Rust `Error::from_code`, Zig `mapErrorCode`, C++ `static_assert`
 * block in <ove/types.hpp>) reads back.  If a future re-numbering
 * drifts an `OVE_ERR_*` value, every TU that includes this header
 * fails to compile with a clear message — the silent-drift surface is
 * closed at the substrate layer the higher-level bindings sit on.
 *
 * `_Static_assert` is the C99/C11 keyword (also a GCC extension in
 * C++); `static_assert` is the C++11 keyword.  Pick whichever the
 * including TU's language supports — TUs that include this header as
 * C++ (the C++ binding's <ove/types.hpp> for instance) need the
 * portable spelling.
 */
#if defined(__cplusplus)
#define OVE_STATIC_ASSERT(cond, msg) static_assert(cond, msg)
#else
#define OVE_STATIC_ASSERT(cond, msg) _Static_assert(cond, msg)
#endif
OVE_STATIC_ASSERT(OVE_ERR_NOT_REGISTERED == -1, "OVE_ERR_NOT_REGISTERED drifted");
OVE_STATIC_ASSERT(OVE_ERR_INVALID_PARAM == -2, "OVE_ERR_INVALID_PARAM drifted");
OVE_STATIC_ASSERT(OVE_ERR_NO_MEMORY == -3, "OVE_ERR_NO_MEMORY drifted");
OVE_STATIC_ASSERT(OVE_ERR_TIMEOUT == -4, "OVE_ERR_TIMEOUT drifted");
OVE_STATIC_ASSERT(OVE_ERR_NOT_SUPPORTED == -5, "OVE_ERR_NOT_SUPPORTED drifted");
OVE_STATIC_ASSERT(OVE_ERR_QUEUE_FULL == -6, "OVE_ERR_QUEUE_FULL drifted");
OVE_STATIC_ASSERT(OVE_ERR_ML_FAILED == -7, "OVE_ERR_ML_FAILED drifted");
OVE_STATIC_ASSERT(OVE_ERR_NET_REFUSED == -8, "OVE_ERR_NET_REFUSED drifted");
OVE_STATIC_ASSERT(OVE_ERR_NET_UNREACHABLE == -9, "OVE_ERR_NET_UNREACHABLE drifted");
OVE_STATIC_ASSERT(OVE_ERR_NET_ADDR_IN_USE == -10, "OVE_ERR_NET_ADDR_IN_USE drifted");
OVE_STATIC_ASSERT(OVE_ERR_NET_RESET == -11, "OVE_ERR_NET_RESET drifted");
OVE_STATIC_ASSERT(OVE_ERR_NET_DNS_FAIL == -12, "OVE_ERR_NET_DNS_FAIL drifted");
OVE_STATIC_ASSERT(OVE_ERR_NET_CLOSED == -13, "OVE_ERR_NET_CLOSED drifted");
OVE_STATIC_ASSERT(OVE_ERR_BUS_NACK == -14, "OVE_ERR_BUS_NACK drifted");
OVE_STATIC_ASSERT(OVE_ERR_BUS_BUSY == -15, "OVE_ERR_BUS_BUSY drifted");
OVE_STATIC_ASSERT(OVE_ERR_BUS_ERROR == -16, "OVE_ERR_BUS_ERROR drifted");
OVE_STATIC_ASSERT(OVE_ERR_QUEUE_EMPTY == -17, "OVE_ERR_QUEUE_EMPTY drifted");
OVE_STATIC_ASSERT(OVE_ERR_WOULD_BLOCK == -18, "OVE_ERR_WOULD_BLOCK drifted");
OVE_STATIC_ASSERT(OVE_ERR_EOF == -19, "OVE_ERR_EOF drifted");
OVE_STATIC_ASSERT(OVE_ERR_INVAL == -20, "OVE_ERR_INVAL drifted");
OVE_STATIC_ASSERT(OVE_ERR_NOT_FOUND == -21, "OVE_ERR_NOT_FOUND drifted");
OVE_STATIC_ASSERT(OVE_WAIT_FOREVER == UINT64_MAX, "OVE_WAIT_FOREVER drifted");
 
typedef struct ove_thread *ove_thread_t;
 
typedef struct ove_mutex *ove_mutex_t;
 
typedef struct ove_sem *ove_sem_t;
 
typedef struct ove_event *ove_event_t;
 
typedef struct ove_condvar *ove_condvar_t;
 
typedef struct ove_eventgroup *ove_eventgroup_t;
 
typedef struct ove_workqueue *ove_workqueue_t;
 
typedef struct ove_work *ove_work_t;
 
typedef struct ove_stream *ove_stream_t;
 
typedef struct ove_watchdog *ove_watchdog_t;
 
typedef struct ove_file *ove_file_t;
 
typedef struct ove_dir *ove_dir_t;
 
typedef struct ove_model *ove_model_t;
 
typedef struct ove_socket *ove_socket_t;
 
typedef struct ove_netif *ove_netif_t;
 
typedef struct ove_tls *ove_tls_t;
 
typedef struct ove_http_client *ove_http_client_t;
 
typedef struct ove_mqtt_client *ove_mqtt_client_t;
 
typedef struct ove_uart *ove_uart_t;
 
typedef struct ove_spi *ove_spi_t;
 
typedef struct ove_i2c *ove_i2c_t;
 
typedef struct ove_i2s *ove_i2s_t;
 
typedef uint32_t ove_eventbits_t;
 
typedef void (*ove_notify_cb)(void *user_data);
 
typedef void (*ove_dma_complete_cb)(int result, void *user_data);
 
/* RTOS name string (compile-time) */
#include "ove_config.h"
 
#if defined(CONFIG_OVE_RTOS_FREERTOS)
#define OVE_RTOS_NAME "FreeRTOS"
#elif defined(CONFIG_OVE_RTOS_ZEPHYR)
#define OVE_RTOS_NAME "Zephyr"
#elif defined(CONFIG_OVE_RTOS_NUTTX)
#define OVE_RTOS_NAME "NuttX"
#elif defined(CONFIG_OVE_RTOS_POSIX)
#define OVE_RTOS_NAME "POSIX"
#else
#define OVE_RTOS_NAME "Unknown"
#endif
 
#endif /* OVE_TYPES_H */