types.hpp

Go to the documentation of this file.

/**
 * @file types.hpp
 * @brief GPIO common types and enumerations
 * @ingroup hal
 * 
 * Common GPIO types shared across the HAL layer.
 * These types are used by both the HAL interface and platform implementations.
 */
 
#ifndef SBL_HAL_GPIO_TYPES_HPP_
#define SBL_HAL_GPIO_TYPES_HPP_
 
namespace sbl {
namespace hal {
namespace gpio {
 
/**
 * @brief GPIO pin modes
 * 
 * Standard pin configuration modes supported across ARM Cortex-M platforms.
 * Platform implementations map these to hardware-specific configurations.
 */
enum class PinMode {
    Input,         ///< Digital input (high impedance)
    Output,        ///< Digital output (push-pull)
    InputPullup,   ///< Digital input with internal pull-up resistor
    InputPulldown, ///< Digital input with internal pull-down resistor
    OpenDrain,     ///< Open-drain output (requires external pull-up)
    Analog         ///< Analog input (for ADC)
};
 
/**
 * @brief Digital logic levels
 * 
 * Standard digital logic levels for GPIO operations.
 */
enum class PinLevel {
    Low = 0,   ///< Logic low (0V, GND)
    High = 1   ///< Logic high (Vdd, 3.3V typically)
};
 
} // namespace gpio
} // namespace hal
} // namespace sbl
 
#endif // SBL_HAL_GPIO_TYPES_HPP_