voct.hpp

Go to the documentation of this file.

/**
 * @file voct.hpp
 * @brief V/Oct input convenience functions
 * @ingroup hal
 *
 * Composes ADC driver reads with VoctInput update in a single call.
 * Same pattern as sbl::cv::read<Driver>() and sbl::pot::read<Driver>().
 *
 * Usage:
 *   #include <sbl/hal/cv/voct.hpp>
 *
 *   sbl::voct::read<sbl::driver::Adc>(voct, handle, SampleTime::Slow);
 *   float freq = voct.frequency();
 */
 
#ifndef SBL_HAL_CV_VOCT_HPP_
#define SBL_HAL_CV_VOCT_HPP_
 
#include <sbl/hal/adc/driver.hpp>
#include <sbl/components/cv/voct.hpp>
 
namespace sbl {
namespace voct {
 
using VoctInput = sbl::components::cv::VoctInput;
using VoctCalibration = sbl::components::cv::VoctCalibration;
 
/**
 * @brief Read ADC channel and feed into VoctInput
 *
 * Blocking read followed by VoctInput::update().
 *
 * @tparam Driver ADC driver type (e.g., sbl::driver::Adc)
 * @param input      VoctInput instance to update
 * @param handle     ADC channel handle
 * @param sample_time Sampling duration (default: Slow for high-Z sources)
 *
 * @note Not ISR-safe — wraps blocking ADC polling read
 */
template<typename Driver>
inline void read(VoctInput& input, const AdcHandle& handle,
                 adc::SampleTime sample_time = adc::SampleTime::Slow) {
    uint16_t raw = adc::read<Driver>(handle, sample_time);
    input.update(raw);
}
 
/**
 * @brief Read from DMA scan buffer and feed into VoctInput
 *
 * For use with sbl::adc::start_scan(). Casts to volatile to ensure the
 * compiler generates a real memory read (buffer updated by DMA hardware).
 *
 * @param input         VoctInput instance to update
 * @param buffer        DMA scan buffer (from start_scan)
 * @param channel_index Index of this channel in the scan sequence
 *
 * @note ISR-safe — volatile DMA buffer read, no blocking
 */
inline void read_dma(VoctInput& input, const uint16_t* buffer,
                     uint8_t channel_index) {
    auto raw = static_cast<const volatile uint16_t*>(buffer)[channel_index];
    input.update(raw);
}
 
} // namespace voct
} // namespace sbl
 
#endif // SBL_HAL_CV_VOCT_HPP_