time.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_TIME_H
#define OVE_TIME_H
 
#include "ove/types.h"
#include "ove_config.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef CONFIG_OVE_TIME
 
int ove_time_get_us(uint64_t *out);
 
int ove_time_get_ns(uint64_t *out);
 
void ove_time_delay_ms(uint32_t ms);
 
void ove_time_delay_us(uint32_t us);
 
#else /* !CONFIG_OVE_TIME */
 
static inline int ove_time_get_us(uint64_t *o)
{
    if (o) {
        *o = 0;
    }
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_time_get_ns(uint64_t *o)
{
    if (o) {
        *o = 0;
    }
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_time_delay_ms(uint32_t ms)
{
    (void)ms;
}
static inline void ove_time_delay_us(uint32_t us)
{
    (void)us;
}
 
#endif /* CONFIG_OVE_TIME */
 
/* ── Duration helper macros (ns-resolution) ────────────────────────────
 *
 * Express timeouts for the upcoming uint64_t ns APIs ergonomically:
 *   ove_mutex_lock_ns(m, OVE_MS(100))
 *   ove_queue_send_ns(q, &item, OVE_SEC(5))
 *
 * All multiplications fold at compile time for constant inputs.
 * Available in both CONFIG_OVE_TIME modes — the macros don't call into
 * the time backend.
 */
#define OVE_NS(n) ((uint64_t)(n))
#define OVE_US(n) ((uint64_t)(n) * 1000ULL)
#define OVE_MS(n) ((uint64_t)(n) * 1000000ULL)
#define OVE_SEC(n) ((uint64_t)(n) * 1000000000ULL)
#define OVE_MIN(n) (OVE_SEC(n) * 60ULL)
 
static inline uint64_t ove_time_now_steady_ns(void)
{
    uint64_t out = 0;
    int rc = ove_time_get_ns(&out);
    (void)rc;
    return out;
}
 
static inline uint64_t ove_time_deadline_to_timeout_ns(uint64_t deadline_ns)
{
    if (deadline_ns == OVE_WAIT_FOREVER)
        return OVE_WAIT_FOREVER;
    uint64_t now = ove_time_now_steady_ns();
    return (deadline_ns > now) ? (deadline_ns - now) : 0;
}
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* OVE_TIME_H */