stk_c_time.h

Go to the documentation of this file.

/*
 * SuperTinyKernel(TM) RTOS: Lightweight High-Performance Deterministic C++ RTOS for Embedded Systems.
 *
 * Source: https://github.com/SuperTinyKernel-RTOS
 *
 * Copyright (c) 2022-2026 Neutron Code Limited <stk@neutroncode.com>. All Rights Reserved.
 * License: MIT License, see LICENSE for a full text.
 */
 
#ifndef STK_C_TIME_H_
#define STK_C_TIME_H_
 
#include "stk_c.h"

 
#ifdef __cplusplus
extern "C" {
#endif
 
// =============================================================================
// Configuration macros
// =============================================================================

#ifndef STK_C_TIMER_MAX
    #define STK_C_TIMER_MAX (32U)
#endif

#ifndef STK_C_TIMER_HANDLER_STACK_SIZE
    #define STK_C_TIMER_HANDLER_STACK_SIZE (256U)
#endif
 
// =============================================================================
// Types
// =============================================================================

typedef struct stk_timerhost_t stk_timerhost_t;

typedef struct stk_timer_t stk_timer_t;

typedef void (*stk_timer_callback_t)(stk_timerhost_t *host,
                                     stk_timer_t     *timer,
                                     void            *user_data);
 
// =============================================================================
// TimerHost - per-core host management
// =============================================================================

stk_timerhost_t *stk_timerhost_get(uint8_t core_nr);

void stk_timerhost_init(stk_timerhost_t *host,
                        stk_kernel_t    *kernel,
                        bool             privileged);

bool stk_timerhost_shutdown(stk_timerhost_t *host);

bool stk_timerhost_is_empty(const stk_timerhost_t *host);

size_t stk_timerhost_get_size(const stk_timerhost_t *host);

int64_t stk_timerhost_get_time_now(const stk_timerhost_t *host);
 
// =============================================================================
// Timer lifecycle
// =============================================================================

stk_timer_t *stk_timer_create(stk_timer_callback_t callback, void *user_data);

void stk_timer_destroy(stk_timer_t *tmr);
 
// =============================================================================
// Timer control
// =============================================================================

bool stk_timer_start(stk_timerhost_t *host,
                     stk_timer_t     *tmr,
                     uint32_t         delay,
                     uint32_t         period);

bool stk_timer_stop(stk_timerhost_t *host, stk_timer_t *tmr);

bool stk_timer_reset(stk_timerhost_t *host, stk_timer_t *tmr);

bool stk_timer_restart(stk_timerhost_t *host,
                       stk_timer_t     *tmr,
                       uint32_t         delay,
                       uint32_t         period);

bool stk_timer_start_or_reset(stk_timerhost_t *host,
                              stk_timer_t     *tmr,
                              uint32_t         delay,
                              uint32_t         period_ticks);

bool stk_timer_set_period(stk_timerhost_t *host,
                          stk_timer_t     *tmr,
                          uint32_t         period_ticks);
 
// =============================================================================
// Timer query
// =============================================================================

bool stk_timer_is_active(const stk_timer_t *tmr);

uint32_t stk_timer_get_period(const stk_timer_t *tmr);

int64_t stk_timer_get_deadline(const stk_timer_t *tmr);

int64_t stk_timer_get_timestamp(const stk_timer_t *tmr);

uint32_t stk_timer_get_remaining_ticks(const stk_timer_t *tmr);
 
// =============================================================================
// PeriodicTrigger - lightweight in-place periodic polling helper
// =============================================================================


#define STK_PERIODIC_TRIGGER_IMPL_SIZE (16U)

typedef struct stk_periodic_trigger_mem_t {
    stk_word_t data[STK_PERIODIC_TRIGGER_IMPL_SIZE];
} stk_periodic_trigger_mem_t;

typedef struct stk_periodic_trigger_t stk_periodic_trigger_t;

stk_periodic_trigger_t *stk_periodic_trigger_create(stk_periodic_trigger_mem_t *const membuf,
                                                    uint32_t                    membuf_size,
                                                    uint32_t                    period_ticks,
                                                    bool                        started);

void stk_periodic_trigger_destroy(stk_periodic_trigger_t *const trig);

bool stk_periodic_trigger_poll(stk_periodic_trigger_t *trig);

void stk_periodic_trigger_set_period(stk_periodic_trigger_t *trig, uint32_t period_ticks);

void stk_periodic_trigger_restart(stk_periodic_trigger_t *trig);

uint32_t stk_periodic_trigger_get_period(const stk_periodic_trigger_t *trig);

 
#ifdef __cplusplus
}
#endif

 
#endif /* STK_C_TIME_H_ */