eventgroup.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_EVENTGROUP_H
#define OVE_EVENTGROUP_H
 
#include "ove/types.h"
#include "ove_config.h"
#include "ove/storage.h"
#include "ove/time.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define OVE_EG_WAIT_ALL 0x01
 
#define OVE_EG_CLEAR_ON_EXIT 0x02
 
#ifdef CONFIG_OVE_EVENTGROUP
 
int ove_eventgroup_init(ove_eventgroup_t *eg, ove_eventgroup_storage_t *storage);
 
void ove_eventgroup_deinit(ove_eventgroup_t eg);
 
#ifdef OVE_HEAP_EVENTGROUP
int ove_eventgroup_create(ove_eventgroup_t *eg);
 
void ove_eventgroup_destroy(ove_eventgroup_t eg);
#endif /* OVE_HEAP_EVENTGROUP */
 
ove_eventbits_t ove_eventgroup_set_bits(ove_eventgroup_t eg, ove_eventbits_t bits);
 
ove_eventbits_t ove_eventgroup_clear_bits(ove_eventgroup_t eg, ove_eventbits_t bits);
 
int ove_eventgroup_wait_bits(ove_eventgroup_t eg, ove_eventbits_t bits, uint32_t flags,
                 uint64_t timeout_ns, ove_eventbits_t *result);
 
static inline int ove_eventgroup_wait_bits_until(ove_eventgroup_t eg, ove_eventbits_t bits,
                         uint32_t flags, uint64_t deadline_ns,
                         ove_eventbits_t *result)
{
    return ove_eventgroup_wait_bits(eg, bits, flags,
                    ove_time_deadline_to_timeout_ns(deadline_ns), result);
}
 
ove_eventbits_t ove_eventgroup_set_bits_from_isr(ove_eventgroup_t eg, ove_eventbits_t bits);
 
ove_eventbits_t ove_eventgroup_get_bits(ove_eventgroup_t eg);
 
int ove_eventgroup_set_notify(ove_eventgroup_t eg, ove_notify_cb cb, void *user_data);
 
#else /* !CONFIG_OVE_EVENTGROUP */
 
/* P0-3: _init/_deinit stubs so OVE_EVENTGROUP_DEFINE_STATIC links cleanly
 * when CONFIG_OVE_EVENTGROUP=n. */
static inline int ove_eventgroup_init(ove_eventgroup_t *eg, ove_eventgroup_storage_t *s)
{
    (void)eg;
    (void)s;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_eventgroup_deinit(ove_eventgroup_t eg)
{
    (void)eg;
}
 
static inline int ove_eventgroup_create(ove_eventgroup_t *eg)
{
    (void)eg;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_eventgroup_destroy(ove_eventgroup_t eg)
{
    (void)eg;
}
static inline ove_eventbits_t ove_eventgroup_set_bits(ove_eventgroup_t eg, ove_eventbits_t bits)
{
    (void)eg;
    (void)bits;
    return 0;
}
static inline ove_eventbits_t ove_eventgroup_clear_bits(ove_eventgroup_t eg, ove_eventbits_t bits)
{
    (void)eg;
    (void)bits;
    return 0;
}
static inline int ove_eventgroup_wait_bits(ove_eventgroup_t eg, ove_eventbits_t bits,
                       uint32_t flags, uint64_t timeout_ns,
                       ove_eventbits_t *result)
{
    (void)eg;
    (void)bits;
    (void)flags;
    (void)timeout_ns;
    (void)result;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline ove_eventbits_t ove_eventgroup_set_bits_from_isr(ove_eventgroup_t eg,
                                   ove_eventbits_t bits)
{
    (void)eg;
    (void)bits;
    return 0;
}
static inline ove_eventbits_t ove_eventgroup_get_bits(ove_eventgroup_t eg)
{
    (void)eg;
    return 0;
}
static inline int ove_eventgroup_set_notify(ove_eventgroup_t eg, ove_notify_cb cb, void *ud)
{
    (void)eg;
    (void)cb;
    (void)ud;
    return OVE_ERR_NOT_SUPPORTED;
}
 
#endif /* CONFIG_OVE_EVENTGROUP */
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* OVE_EVENTGROUP_H */