handle.hpp

Go to the documentation of this file.

/**
 * @file handle.hpp
 * @brief ADC handle type for hardware abstraction
 * @ingroup hal
 *
 * Canonical definition of AdcHandle - the primary way to reference
 * ADC channels in SBL. Used by drivers, generated hardware configs, and
 * user code.
 */
 
#ifndef SBL_HAL_ADC_HANDLE_HPP_
#define SBL_HAL_ADC_HANDLE_HPP_
 
#include <cstdint>
 
namespace sbl {
 
/**
 * @brief ADC channel handle
 *
 * Represents an ADC input as resolved from hardware manifests.
 * Used to pass channel configuration to driver functions.
 *
 * Examples:
 * - STM32 ADC1 channel 0: AdcHandle{1, 0}
 * - RP2040 ADC channel 2: AdcHandle{0, 2} - Single ADC peripheral
 * - Daisy Seed CV input: AdcHandle{1, 17} - ADC1_IN17 on STM32H750
 */
struct AdcHandle {
    uint32_t adc;        ///< ADC peripheral number (1-indexed on STM32, 0 on RP2040)
    uint32_t channel;    ///< Channel within the ADC peripheral
};
 
} // namespace sbl
 
#endif // SBL_HAL_ADC_HANDLE_HPP_