system_time.hpp

Go to the documentation of this file.

/**
 * @file system_time.hpp
 * @brief System timing functions for cooperative scheduling
 * @ingroup hal
 *
 * Provides basic system time functions (millis/micros/delay) that
 * patterns and application code can use without directly accessing
 * platform implementations.
 *
 * These are fundamental HAL functions that wrap platform-specific
 * timing hardware (SysTick, hardware timers, etc).
 */
 
#ifndef SBL_HAL_TIMING_SYSTEM_TIME_HPP_
#define SBL_HAL_TIMING_SYSTEM_TIME_HPP_
 
#include <cstdint>
 
namespace sbl {
namespace hal {
namespace timing {
 
/**
 * @brief System time interface for platform-independent timing
 *
 * Template interface that platform implementations must provide.
 * Applications and patterns use this instead of accessing platform directly.
 *
 * @tparam PlatformTimer Platform-specific timer implementation
 */
template<typename PlatformTimer>
class SystemTime {
public:
    /**
     * @brief Get system time in milliseconds
     *
     * Returns monotonic millisecond counter for timing operations.
     * Wraps after ~49 days at 1ms resolution.
     *
     * @return Milliseconds since system start
     */
    static uint32_t millis() {
        return PlatformTimer::millis();
    }
 
    /**
     * @brief Get system time in microseconds
     *
     * Returns monotonic microsecond counter for high-resolution timing.
     * Wraps after ~71 minutes at 1μs resolution.
     *
     * @return Microseconds since system start
     */
    static uint32_t micros() {
        return PlatformTimer::micros();
    }
 
    /**
     * @brief Blocking delay in milliseconds
     *
     * Busy-wait delay. Blocks execution for specified duration.
     * Use NonBlockingDelay for cooperative scheduling.
     *
     * @param ms Delay duration in milliseconds
     */
    static void delayMs(uint32_t ms) {
        PlatformTimer::delayMs(ms);
    }
 
    /**
     * @brief Blocking delay in microseconds
     *
     * Busy-wait delay. Blocks execution for specified duration.
     *
     * @param us Delay duration in microseconds
     */
    static void delayUs(uint32_t us) {
        PlatformTimer::delayUs(us);
    }
};
 
} // namespace timing
} // namespace hal
} // namespace sbl
 
#endif // SBL_HAL_TIMING_SYSTEM_TIME_HPP_