workqueue.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_WORKQUEUE_H
#define OVE_WORKQUEUE_H
 
#include "ove/types.h"
#include "ove/thread.h"
#include "ove_config.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void (*ove_work_fn)(ove_work_t work);
 
#include "ove/storage.h"
 
#ifdef CONFIG_OVE_WORKQUEUE
 
int ove_workqueue_init(ove_workqueue_t *wq, ove_workqueue_storage_t *storage, const char *name,
               ove_prio_t priority, size_t stack_size, void *stack);
 
void ove_workqueue_deinit(ove_workqueue_t wq);
 
int ove_work_init_static(ove_work_t *work, ove_work_storage_t *storage, ove_work_fn handler);
 
#ifdef OVE_HEAP_WORKQUEUE
int ove_work_init(ove_work_t *work, ove_work_fn handler);
 
void ove_work_free(ove_work_t work);
#endif /* OVE_HEAP_WORKQUEUE */
 
#ifdef OVE_HEAP_WORKQUEUE
int ove_workqueue_create(ove_workqueue_t *wq, const char *name, ove_prio_t priority,
             size_t stack_size);
 
void ove_workqueue_destroy(ove_workqueue_t wq);
#endif /* OVE_HEAP_WORKQUEUE */
 
int ove_work_submit(ove_workqueue_t wq, ove_work_t work);
 
int ove_work_submit_delayed(ove_workqueue_t wq, ove_work_t work, uint32_t delay_ms);
 
int ove_work_cancel(ove_work_t work);
 
#else /* !CONFIG_OVE_WORKQUEUE */
 
/* P0-3: _init/_deinit stubs so OVE_WORKQUEUE_DEFINE_STATIC links cleanly
 * when CONFIG_OVE_WORKQUEUE=n. */
static inline int ove_workqueue_init(ove_workqueue_t *wq, ove_workqueue_storage_t *st,
                     const char *n, ove_prio_t p, size_t s, void *stack)
{
    (void)wq;
    (void)st;
    (void)n;
    (void)p;
    (void)s;
    (void)stack;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_workqueue_deinit(ove_workqueue_t wq)
{
    (void)wq;
}
 
static inline int ove_workqueue_create(ove_workqueue_t *wq, const char *n, ove_prio_t p, size_t s)
{
    (void)wq;
    (void)n;
    (void)p;
    (void)s;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_workqueue_destroy(ove_workqueue_t wq)
{
    (void)wq;
}
static inline int ove_work_init(ove_work_t *w, ove_work_fn h)
{
    (void)w;
    (void)h;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_work_free(ove_work_t w)
{
    (void)w;
}
static inline int ove_work_submit(ove_workqueue_t wq, ove_work_t w)
{
    (void)wq;
    (void)w;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_work_submit_delayed(ove_workqueue_t wq, ove_work_t w, uint32_t d)
{
    (void)wq;
    (void)w;
    (void)d;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_work_cancel(ove_work_t w)
{
    (void)w;
    return OVE_ERR_NOT_SUPPORTED;
}
 
#endif /* CONFIG_OVE_WORKQUEUE */
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* OVE_WORKQUEUE_H */