types.hpp

Go to the documentation of this file.

/**
 * @file types.hpp
 * @brief Common timing types and enumerations
 * @ingroup hal
 * 
 * Shared timing types used across timer and delay components.
 * Simple data structures with no behavior - pure types only.
 */
 
#ifndef SBL_HAL_TIMING_TYPES_HPP_
#define SBL_HAL_TIMING_TYPES_HPP_
 
#include <cstdint>
 
namespace sbl {
namespace hal {
namespace timing {
 
/**
 * @brief Timer operating modes
 */
enum class TimerMode : uint8_t {
    OneShot,    ///< Timer fires once then stops
    Periodic    ///< Timer fires repeatedly at interval
};
 
/**
 * @brief Timer interrupt types
 */
enum class TimerEvent : uint8_t {
    Overflow,   ///< Timer overflow/update interrupt
    Capture,    ///< Input capture interrupt (if supported)
    Compare     ///< Output compare interrupt (if supported)
};
 
/**
 * @brief Timer configuration structure
 * 
 * Simple configuration for timer setup. Platform implementations
 * can extend this or use it as-is based on hardware capabilities.
 */
struct TimerConfig {
    uint32_t frequency_hz;     ///< Desired timer frequency in Hz
    TimerMode mode;            ///< Operating mode
    bool enable_interrupt;     ///< Enable overflow interrupt
    
    constexpr TimerConfig(uint32_t freq, TimerMode m, bool irq = false)
        : frequency_hz(freq), mode(m), enable_interrupt(irq) {}
};
 
} // namespace timing
} // namespace hal
} // namespace sbl
 
#endif // SBL_HAL_TIMING_TYPES_HPP_