timer.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_TIMER_H
#define OVE_TIMER_H
 
#include "ove/types.h"
#include "ove_config.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct ove_timer *ove_timer_t;
 
typedef void (*ove_timer_fn)(ove_timer_t timer, void *user_data);
 
#include "ove/storage.h"
 
#ifdef CONFIG_OVE_TIMER
 
int ove_timer_init(ove_timer_t *timer, ove_timer_storage_t *storage, ove_timer_fn callback,
           void *user_data, uint32_t period_ms, int one_shot);
 
void ove_timer_deinit(ove_timer_t timer);
 
int ove_timer_init_ns(ove_timer_t *timer, ove_timer_storage_t *storage, ove_timer_fn callback,
              void *user_data, uint64_t period_ns, int one_shot);
 
int ove_timer_set_period_ns(ove_timer_t timer, uint64_t period_ns);
 
/* _create / _destroy — heap-gated */
#ifdef OVE_HEAP_TIMER
 
int ove_timer_create(ove_timer_t *timer, ove_timer_fn callback, void *user_data, uint32_t period_ms,
             int one_shot);
 
int ove_timer_create_ns(ove_timer_t *timer, ove_timer_fn callback, void *user_data,
            uint64_t period_ns, int one_shot);
 
void ove_timer_destroy(ove_timer_t timer);
 
#endif /* OVE_HEAP_TIMER */
 
int ove_timer_start(ove_timer_t timer);
 
int ove_timer_stop(ove_timer_t timer);
 
int ove_timer_reset(ove_timer_t timer);
 
#else /* !CONFIG_OVE_TIMER */
 
/* P0-3: _init/_deinit stubs so OVE_TIMER_DEFINE_STATIC links cleanly when
 * CONFIG_OVE_TIMER=n. */
static inline int ove_timer_init(ove_timer_t *t, ove_timer_storage_t *s, ove_timer_fn cb, void *ud,
                 uint32_t p, int os)
{
    (void)t;
    (void)s;
    (void)cb;
    (void)ud;
    (void)p;
    (void)os;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_timer_deinit(ove_timer_t t)
{
    (void)t;
}
 
static inline int ove_timer_create(ove_timer_t *t, ove_timer_fn cb, void *ud, uint32_t p, int os)
{
    (void)t;
    (void)cb;
    (void)ud;
    (void)p;
    (void)os;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_timer_init_ns(ove_timer_t *t, ove_timer_storage_t *s, ove_timer_fn cb,
                    void *ud, uint64_t p, int os)
{
    (void)t;
    (void)s;
    (void)cb;
    (void)ud;
    (void)p;
    (void)os;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_timer_create_ns(ove_timer_t *t, ove_timer_fn cb, void *ud, uint64_t p, int os)
{
    (void)t;
    (void)cb;
    (void)ud;
    (void)p;
    (void)os;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_timer_set_period_ns(ove_timer_t t, uint64_t p)
{
    (void)t;
    (void)p;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_timer_destroy(ove_timer_t t)
{
    (void)t;
}
static inline int ove_timer_start(ove_timer_t t)
{
    (void)t;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_timer_stop(ove_timer_t t)
{
    (void)t;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_timer_reset(ove_timer_t t)
{
    (void)t;
    return OVE_ERR_NOT_SUPPORTED;
}
 
#endif /* CONFIG_OVE_TIMER */
 
#ifdef __cplusplus
}
#endif
 
#endif /* OVE_TIMER_H */