driver.hpp

Go to the documentation of this file.

/**
 * @file driver.hpp
 * @brief UART driver interface - canonical types for MCU driver implementations
 * @ingroup hal
 *
 * This header documents the UART driver interface that MCU drivers implement.
 *
 * Drivers implement the following static interface:
 *   static void init(uint32_t baud_rate);
 *   static void write_byte(uint8_t byte);
 *   static void write(const uint8_t* data, size_t len);
 *
 * Optional methods for bidirectional communication:
 *   static bool available();
 *   static uint8_t read_byte();
 *
 * Usage in driver:
 *   #include <sbl/hal/uart/driver.hpp>
 *
 * ## Design Notes
 *
 * UART is designed as a simple debug output interface. The initial implementation
 * focuses on TX-only operation for debug logging. RX support can be added later
 * for MIDI input or debug console features.
 *
 * The driver uses polling/blocking mode for simplicity. Interrupt-driven or DMA
 * modes can be added as separate driver variants (UartAsync, UartDma) if needed.
 */
 
#ifndef SBL_HAL_UART_DRIVER_HPP_
#define SBL_HAL_UART_DRIVER_HPP_
 
#include <cstdint>
#include <cstddef>
 
namespace sbl {
 
/**
 * @brief Standard baud rates for UART communication
 */
namespace uart {
    constexpr uint32_t BAUD_9600   = 9600;
    constexpr uint32_t BAUD_19200  = 19200;
    constexpr uint32_t BAUD_38400  = 38400;
    constexpr uint32_t BAUD_57600  = 57600;
    constexpr uint32_t BAUD_115200 = 115200;
    constexpr uint32_t BAUD_230400 = 230400;
    constexpr uint32_t BAUD_460800 = 460800;
    constexpr uint32_t BAUD_921600 = 921600;
 
    // MIDI baud rate
    constexpr uint32_t BAUD_MIDI   = 31250;
} // namespace uart
 
} // namespace sbl
 
#endif // SBL_HAL_UART_DRIVER_HPP_