queue.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_QUEUE_H
#define OVE_QUEUE_H
 
#include "ove/types.h"
#include "ove_config.h"
#include "ove/time.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct ove_queue *ove_queue_t;
 
#include "ove/storage.h"
 
#ifdef CONFIG_OVE_QUEUE
 
OVE_NODISCARD int ove_queue_init(ove_queue_t *q, ove_queue_storage_t *storage, void *buffer,
                 size_t item_size, unsigned int max_items) OVE_NONNULL(1, 2, 3);
 
void ove_queue_deinit(ove_queue_t q);
 
/* _create / _destroy — heap-gated */
#ifdef OVE_HEAP_QUEUE
 
OVE_NODISCARD int ove_queue_create(ove_queue_t *q, size_t item_size, unsigned int max_items)
    OVE_NONNULL(1);
 
void ove_queue_destroy(ove_queue_t q);
 
#endif /* OVE_HEAP_QUEUE */
 
OVE_NODISCARD int ove_queue_send(ove_queue_t q, const void *data, uint64_t timeout_ns)
    OVE_NONNULL(1, 2);
 
OVE_NODISCARD static inline int ove_queue_send_until(ove_queue_t q, const void *data,
                             uint64_t deadline_ns)
{
    return ove_queue_send(q, data, ove_time_deadline_to_timeout_ns(deadline_ns));
}
 
OVE_NODISCARD int ove_queue_receive(ove_queue_t q, void *buf, uint64_t timeout_ns)
    OVE_NONNULL(1, 2);
 
OVE_NODISCARD static inline int ove_queue_receive_until(ove_queue_t q, void *buf,
                            uint64_t deadline_ns)
{
    return ove_queue_receive(q, buf, ove_time_deadline_to_timeout_ns(deadline_ns));
}
 
OVE_NODISCARD int ove_queue_send_from_isr(ove_queue_t q, const void *data) OVE_NONNULL(1, 2);
 
OVE_NODISCARD int ove_queue_receive_from_isr(ove_queue_t q, void *buf) OVE_NONNULL(1, 2);
 
int ove_queue_set_notify(ove_queue_t q, ove_notify_cb cb, void *user_data) OVE_NONNULL(1);
 
#else /* !CONFIG_OVE_QUEUE */
 
/* P0-3: _init/_deinit stubs so OVE_QUEUE_DEFINE_STATIC links cleanly
 * when CONFIG_OVE_QUEUE=n. */
static inline int ove_queue_init(ove_queue_t *q, ove_queue_storage_t *s, void *b, size_t is,
                 unsigned int mi)
{
    (void)q;
    (void)s;
    (void)b;
    (void)is;
    (void)mi;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_queue_deinit(ove_queue_t q)
{
    (void)q;
}
 
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, uint64_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, uint64_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;
}
static inline int ove_queue_set_notify(ove_queue_t q, ove_notify_cb cb, void *ud)
{
    (void)q;
    (void)cb;
    (void)ud;
    return OVE_ERR_NOT_SUPPORTED;
}
 
#endif /* CONFIG_OVE_QUEUE */
 
#ifdef __cplusplus
}
#endif
 
#endif /* OVE_QUEUE_H */