defaults.hpp

Go to the documentation of this file.

/**
 * @file defaults.hpp
 * @brief Default logger output sink and timestamp provider
 *
 * Provides UartOutput and TimerTimestamp that wrap standard SBL driver
 * calls. Guarded by __has_include so unit tests compile without hw headers.
 *
 * When <sbl/hw/hw.hpp> is available (firmware builds), these defaults
 * are used automatically by macros.hpp unless the application defines
 * SBL_LOG_OUTPUT / SBL_LOG_TIMESTAMP explicitly.
 */
#pragma once
 
#if __has_include(<sbl/hw/hw.hpp>)
#include <sbl/hw/hw.hpp>
 
namespace sbl::log {
 
/// Default UART output sink — writes to Uart<0> (debug UART)
struct UartOutput {
    static void write(const char* str) { sbl::driver::Uart<>::write_string(str); }
};
 
/// Polling UART output — bypasses ring buffer, works with interrupts disabled.
/// Use as SBL_FAULT_OUTPUT for fault/panic handlers.
struct UartFaultOutput {
    static void write(const char* str) { sbl::driver::Uart<>::write_string_polling(str); }
};
 
/// Default timestamp provider — milliseconds from Timer driver
struct TimerTimestamp {
    static uint32_t now() { return sbl::driver::Timer::millis(); }
};
 
} // namespace sbl::log
 
#define SBL_LOG_HW_DEFAULTS_AVAILABLE 1
#else
#define SBL_LOG_HW_DEFAULTS_AVAILABLE 0
#endif
 
// USB CDC output — available when sbl_setup_usb() was called
#if defined(SBL_HAS_USB) && __has_include(<sbl/usb/cdc.hpp>)
#include <sbl/usb/cdc.hpp>
#define SBL_LOG_USB_DEFAULTS_AVAILABLE 1
#else
#define SBL_LOG_USB_DEFAULTS_AVAILABLE 0
#endif