api/c/queue_8h_source.html

/*

 * 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_QUEUE_H

#define OVE_QUEUE_H


#include "ove/types.h"

#include "ove_config.h"


#ifdef __cplusplus

extern "C" {

#endif


typedef struct ove_queue *ove_queue_t;


#include "ove/storage.h"


#ifdef CONFIG_OVE_QUEUE


int  ove_queue_init(ove_queue_t *q, ove_queue_storage_t *storage,

            void *buffer, size_t item_size, unsigned int max_items);


void ove_queue_deinit(ove_queue_t q);


/* _create / _destroy — heap-gated */

#ifdef OVE_HEAP_QUEUE


int  ove_queue_create(ove_queue_t *q, size_t item_size,

              unsigned int max_items);


void ove_queue_destroy(ove_queue_t q);


#elif !defined(__ZIG_CIMPORT__) /* !OVE_HEAP_QUEUE — zero-heap mode */


/* Unified macro — item_size and max_items must be compile-time constants. */

#define ove_queue_create(pq, item_size, max_items) \

    ({ static ove_queue_storage_t _ove_stor_; \

       static uint8_t _ove_buf_[(item_size) * (max_items)]; \

       ove_queue_init((pq), &_ove_stor_, _ove_buf_, \

              (item_size), (max_items)); })

#define ove_queue_destroy(q) ove_queue_deinit(q)


#endif /* OVE_HEAP_QUEUE */


int  ove_queue_send(ove_queue_t q, const void *data,

            uint32_t timeout_ms);


int  ove_queue_receive(ove_queue_t q, void *buf,

               uint32_t timeout_ms);


int  ove_queue_send_from_isr(ove_queue_t q, const void *data);


int  ove_queue_receive_from_isr(ove_queue_t q, void *buf);


#else /* !CONFIG_OVE_QUEUE */


static inline int  ove_queue_create(ove_queue_t *q, size_t is, unsigned int mi) { (void)q; (void)is; (void)mi; return OVE_ERR_NOT_SUPPORTED; }

static inline void ove_queue_destroy(ove_queue_t q) { (void)q; }

static inline int  ove_queue_send(ove_queue_t q, const void *d, uint32_t t) { (void)q; (void)d; (void)t; return OVE_ERR_NOT_SUPPORTED; }

static inline int  ove_queue_receive(ove_queue_t q, void *b, uint32_t t) { (void)q; (void)b; (void)t; return OVE_ERR_NOT_SUPPORTED; }

static inline int  ove_queue_send_from_isr(ove_queue_t q, const void *d) { (void)q; (void)d; return OVE_ERR_NOT_SUPPORTED; }

static inline int  ove_queue_receive_from_isr(ove_queue_t q, void *b) { (void)q; (void)b; return OVE_ERR_NOT_SUPPORTED; }


#endif /* CONFIG_OVE_QUEUE */


#ifdef __cplusplus

}

#endif


#endif /* OVE_QUEUE_H */


ove_queue_destroy
void ove_queue_destroy(ove_queue_t q)
Destroy and free a queue allocated with ove_queue_create().

ove_queue_send
int ove_queue_send(ove_queue_t q, const void *data, uint32_t timeout_ms)
Send an item to the back of the queue, blocking if it is full.

ove_queue_deinit
void ove_queue_deinit(ove_queue_t q)
Release resources held by a queue initialised with ove_queue_init().

ove_queue_receive_from_isr
int ove_queue_receive_from_isr(ove_queue_t q, void *buf)
Receive an item from the queue from an interrupt service routine.

ove_queue_t
struct ove_queue * ove_queue_t
Opaque handle for a message queue object.
Definition queue.h:39

ove_queue_init
int ove_queue_init(ove_queue_t *q, ove_queue_storage_t *storage, void *buffer, size_t item_size, unsigned int max_items)
Initialise a queue using caller-supplied static storage and data buffer.

ove_queue_send_from_isr
int ove_queue_send_from_isr(ove_queue_t q, const void *data)
Send an item to the queue from an interrupt service routine.

ove_queue_create
int ove_queue_create(ove_queue_t *q, size_t item_size, unsigned int max_items)
Allocate and initialise a queue from the heap.

ove_queue_receive
int ove_queue_receive(ove_queue_t q, void *buf, uint32_t timeout_ms)
Receive (remove) an item from the front of the queue, blocking if it is empty.

OVE_ERR_NOT_SUPPORTED
#define OVE_ERR_NOT_SUPPORTED
The requested feature is not supported by the active backend.
Definition types.h:38