stk_time_util.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_TIME_UTIL_H_
#define STK_TIME_UTIL_H_

 
namespace stk {
namespace time {

class PeriodicTrigger
{
public:
    PeriodicTrigger(uint32_t period, bool start = false) : m_next(0), m_period(period)
    {
        if (start)
        {
            Restart();
        }
    }

    uint32_t GetPeriod() const
    {
        return m_period;
    }

    void SetPeriod(uint32_t period)
    {
        m_next = (m_next - static_cast<Ticks>(m_period)) + static_cast<Ticks>(period);
        m_period = period;
    }

    void Restart()
    {
        m_next = GetTicks() + static_cast<Ticks>(m_period);
    }

    bool Poll()
    {
        STK_ASSERT(m_next > 0);
 
        bool triggered = false;
        const Ticks diff = GetTicks() - m_next;
 
        if (diff >= 0)
        {
            m_next += static_cast<Ticks>(m_period);
            triggered = true;
        }
 
        return triggered;
    }
 
protected:
    Ticks    m_next;   
    uint32_t m_period; 
};

class Stopwatch
{
    static constexpr Cycles NOT_STARTED = 0ULL; 
 
public:
    Stopwatch() : m_prev(NOT_STARTED)
    {}

    template <typename Func>
    void Start(Func now_func)
    {
        m_prev = static_cast<Cycles>(now_func());
    }

    template <typename Func>
    Cycles Update(Func now_func)
    {
        Cycles now = static_cast<Cycles>(now_func());
 
        if (STK_UNLIKELY(m_prev == NOT_STARTED))
        {
            m_prev = now;
        }
 
        Cycles diff = now - m_prev;
        m_prev = now;
 
        return diff;
    }
 
protected:
    Cycles m_prev; 
};
 
} // namespace time
} // namespace stk
 
#endif /* STK_TIME_UTIL_H_ */