handle.hpp

Go to the documentation of this file.

/**
 * @file handle.hpp
 * @brief UART handle type for hardware abstraction
 * @ingroup hal
 *
 * Canonical definition of UartHandle - the primary way to reference
 * UART peripherals in SBL. Used by drivers, generated hardware configs,
 * and user code.
 */
 
#ifndef SBL_HAL_UART_HANDLE_HPP_
#define SBL_HAL_UART_HANDLE_HPP_
 
#include <cstdint>
 
namespace sbl {
 
/**
 * @brief UART peripheral handle
 *
 * Represents a UART configuration as resolved from hardware manifests.
 * Includes peripheral number, pin mappings, and default baud rate.
 *
 * Examples:
 * - STM32H7 USART1 on PA9/PA10: UartHandle{1, 0, 9, 7, 0, 10, 7, 115200}
 * - RP2040 UART0 on GPIO0/GPIO1: UartHandle{0, 0, 0, 0, 0, 1, 0, 115200}
 */
struct UartHandle {
    uint32_t peripheral;  ///< UART peripheral number (e.g., 1 for USART1)
    uint32_t tx_port;     ///< TX GPIO port number
    uint32_t tx_pin;      ///< TX GPIO pin number
    uint32_t tx_af;       ///< TX alternate function (STM32), 0 for simpler MCUs
    uint32_t rx_port;     ///< RX GPIO port number
    uint32_t rx_pin;      ///< RX GPIO pin number
    uint32_t rx_af;       ///< RX alternate function (STM32), 0 for simpler MCUs
    uint32_t baud;        ///< Default baud rate
};
 
} // namespace sbl
 
#endif // SBL_HAL_UART_HANDLE_HPP_