stream.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_STREAM_H
#define OVE_STREAM_H
 
#include "ove/types.h"
#include "ove_config.h"
#include "ove/storage.h"
#include "ove/time.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef CONFIG_OVE_STREAM
 
int ove_stream_init(ove_stream_t *stream, ove_stream_storage_t *storage, void *buffer, size_t size,
            size_t trigger);
 
void ove_stream_deinit(ove_stream_t stream);
 
#ifdef OVE_HEAP_STREAM
int ove_stream_create(ove_stream_t *stream, size_t size, size_t trigger);
 
void ove_stream_destroy(ove_stream_t stream);
#endif /* OVE_HEAP_STREAM */
 
int ove_stream_send(ove_stream_t stream, const void *data, size_t len, uint64_t timeout_ns,
            size_t *bytes_sent);
 
static inline int ove_stream_send_until(ove_stream_t stream, const void *data, size_t len,
                    uint64_t deadline_ns, size_t *bytes_sent)
{
    return ove_stream_send(stream, data, len, ove_time_deadline_to_timeout_ns(deadline_ns),
                   bytes_sent);
}
 
int ove_stream_receive(ove_stream_t stream, void *buf, size_t len, uint64_t timeout_ns,
               size_t *bytes_received);
 
static inline int ove_stream_receive_until(ove_stream_t stream, void *buf, size_t len,
                       uint64_t deadline_ns, size_t *bytes_received)
{
    return ove_stream_receive(stream, buf, len, ove_time_deadline_to_timeout_ns(deadline_ns),
                  bytes_received);
}
 
int ove_stream_send_from_isr(ove_stream_t stream, const void *data, size_t len, size_t *bytes_sent);
 
int ove_stream_receive_from_isr(ove_stream_t stream, void *buf, size_t len, size_t *bytes_received);
 
int ove_stream_reset(ove_stream_t stream);
 
size_t ove_stream_bytes_available(ove_stream_t stream);
 
int ove_stream_set_notify(ove_stream_t stream, ove_notify_cb cb, void *user_data);
 
#else /* !CONFIG_OVE_STREAM */
 
/* P0-3: _init/_deinit stubs so OVE_STREAM_DEFINE_STATIC links cleanly when
 * CONFIG_OVE_STREAM=n. */
static inline int ove_stream_init(ove_stream_t *s, ove_stream_storage_t *st, void *b, size_t sz,
                  size_t t)
{
    (void)s;
    (void)st;
    (void)b;
    (void)sz;
    (void)t;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_stream_deinit(ove_stream_t s)
{
    (void)s;
}
 
static inline int ove_stream_create(ove_stream_t *s, size_t sz, size_t t)
{
    (void)s;
    (void)sz;
    (void)t;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_stream_destroy(ove_stream_t s)
{
    (void)s;
}
static inline int ove_stream_send(ove_stream_t s, const void *d, size_t l, uint64_t t, size_t *bs)
{
    (void)s;
    (void)d;
    (void)l;
    (void)t;
    (void)bs;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_stream_receive(ove_stream_t s, void *b, size_t l, uint64_t t, size_t *br)
{
    (void)s;
    (void)b;
    (void)l;
    (void)t;
    (void)br;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_stream_send_from_isr(ove_stream_t s, const void *d, size_t l, size_t *bs)
{
    (void)s;
    (void)d;
    (void)l;
    (void)bs;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_stream_receive_from_isr(ove_stream_t s, void *b, size_t l, size_t *br)
{
    (void)s;
    (void)b;
    (void)l;
    (void)br;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_stream_reset(ove_stream_t s)
{
    (void)s;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline size_t ove_stream_bytes_available(ove_stream_t s)
{
    (void)s;
    return 0;
}
static inline int ove_stream_set_notify(ove_stream_t s, ove_notify_cb cb, void *ud)
{
    (void)s;
    (void)cb;
    (void)ud;
    return OVE_ERR_NOT_SUPPORTED;
}
 
#endif /* CONFIG_OVE_STREAM */
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* OVE_STREAM_H */