handle.hpp

Go to the documentation of this file.

/**
 * @file handle.hpp
 * @brief GPIO handle type for hardware abstraction
 * @ingroup hal
 *
 * Canonical definition of GpioHandle - the primary way to reference
 * GPIO pins in SBL. Used by drivers, generated hardware configs, and
 * user code.
 */
 
#ifndef SBL_HAL_GPIO_HANDLE_HPP_
#define SBL_HAL_GPIO_HANDLE_HPP_
 
#include <cstdint>
 
namespace sbl {
 
/**
 * @brief GPIO pin handle with port, pin number, and polarity
 *
 * Represents a GPIO pin as resolved from hardware manifests.
 * Used to pass pin configuration to driver functions.
 *
 * Examples:
 * - RP2040 GPIO25: GpioHandle{0, 25, false} - Single port MCU
 * - STM32 PC7: GpioHandle{2, 7, false} - Port C (2), pin 7
 * - Active-low LED: GpioHandle{0, 25, true} - write(true) drives LOW
 */
struct GpioHandle {
    uint32_t port;       ///< GPIO port number (0 for single-port MCUs)
    uint32_t pin;        ///< Pin number within port
    bool active_low;     ///< True if signal is active-low (inverted)
 
    /**
     * @brief Get the effective physical level accounting for active_low
     * @param logical_state Logical state (true = active/on, false = inactive/off)
     * @return Physical level to write to hardware
     */
    [[nodiscard]] constexpr bool effective_level(bool logical_state) const noexcept {
        return active_low ? !logical_state : logical_state;
    }
};
 
} // namespace sbl
 
#endif // SBL_HAL_GPIO_HANDLE_HPP_