timer_requirements.hpp

Go to the documentation of this file.

/**
 * @file timer_requirements.hpp
 * @brief Timer driver requirements validator
 * @ingroup validation
 *
 * Validates that Timer drivers provide required functionality using the
 * method detection system.
 *
 * ## Timer Driver Contract
 *
 * Every Sound Byte Libs Timer driver MUST implement these methods:
 * - `busy_wait_ms(uint32_t)` - Blocking millisecond delay
 * - `millis() -> uint32_t` - Milliseconds since boot
 * - `micros() -> uint32_t` - Microseconds since boot
 *
 * Optional methods (validated if present):
 * - `init(uint32_t)` - Initialize timer (STM32 needs it, RP2xxx don't)
 *
 * ## Validation Usage
 *
 * Add validation at the bottom of driver timer.hpp:
 * ```cpp
 * #include <sbl/validation/timer_requirements.hpp>
 * static_assert(sbl::validation::timer_driver_valid<sbl::driver::Timer>,
 *               "Timer driver missing required methods");
 * ```
 *
 * @see method_detection.hpp
 */
 
#ifndef SBL_VALIDATION_TIMER_REQUIREMENTS_HPP_
#define SBL_VALIDATION_TIMER_REQUIREMENTS_HPP_
 
#include "method_detection.hpp"
 
namespace sbl {
namespace validation {
 
/**
 * @brief Timer driver requirements validator
 *
 * Validates that Timer drivers provide all required methods with correct
 * signatures and return types.
 */
template<typename TimerDriver>
class TimerDriverRequirements {
public:
    /**
     * @brief Validate all required Timer methods
     */
    static constexpr bool validate() {
        // --- Required methods (all platforms) ---
 
        static_assert(has_timer_busy_wait_ms<TimerDriver>::value,
                      "SBL ERROR: Timer driver missing busy_wait_ms() method.\n"
                      "Required: static void busy_wait_ms(uint32_t)");
 
        static_assert(has_timer_millis<TimerDriver>::value,
                      "SBL ERROR: Timer driver missing millis() method.\n"
                      "Required: static uint32_t millis()");
 
        static_assert(has_timer_micros<TimerDriver>::value,
                      "SBL ERROR: Timer driver missing micros() method.\n"
                      "Required: static uint32_t micros()");
 
        // --- Return type validation ---
 
        static_assert(timer_micros_returns_uint32<TimerDriver>::value,
                      "SBL ERROR: Timer micros() must return uint32_t.");
 
        // --- Optional methods (validated if present) ---
        // init(uint32_t) — STM32 needs it for SysTick setup, RP2xxx don't.
        // No return type constraint (STM32 returns bool, others may return void).
 
        return true;
    }
};
 
/**
 * @brief Helper to validate a Timer driver implementation
 *
 * Usage:
 * ```cpp
 * static_assert(sbl::validation::timer_driver_valid<MyTimerDriver>,
 *               "Timer driver incomplete");
 * ```
 */
template<typename TimerDriver>
constexpr bool timer_driver_valid = TimerDriverRequirements<TimerDriver>::validate();
 
} // namespace validation
} // namespace sbl
 
#endif // SBL_VALIDATION_TIMER_REQUIREMENTS_HPP_