types.hpp

Go to the documentation of this file.

/**
 * @file types.hpp
 * @brief ADC common types and enumerations
 * @ingroup hal
 *
 * Common ADC types shared across the HAL layer.
 * These types are used by both the HAL interface and platform implementations.
 */
 
#ifndef SBL_HAL_ADC_TYPES_HPP_
#define SBL_HAL_ADC_TYPES_HPP_
 
namespace sbl {
namespace hal {
namespace adc {
 
/**
 * @brief ADC sample time configuration
 *
 * Controls the sampling duration for ADC conversions.
 * Longer sample times provide better accuracy for high-impedance sources
 * but reduce throughput. Platform implementations map these to
 * hardware-specific cycle counts.
 *
 * Typical use cases:
 * - Fast: Low-impedance sources, high-speed scanning
 * - Medium: General purpose, balanced accuracy/speed (default)
 * - Slow: High-impedance sources, maximum accuracy
 */
enum class SampleTime {
    Fast,    ///< Shortest sample time, highest throughput
    Medium,  ///< Balanced sample time (recommended default)
    Slow     ///< Longest sample time, best for high-Z sources
};
 
/**
 * @brief ADC resolution configuration
 *
 * Some ADC peripherals support configurable resolution.
 * Lower resolution provides faster conversions.
 */
enum class Resolution {
    Bits8 = 8,
    Bits10 = 10,
    Bits12 = 12,
    Bits14 = 14,
    Bits16 = 16
};
 
} // namespace adc
} // namespace hal
} // namespace sbl
 
#endif // SBL_HAL_ADC_TYPES_HPP_