defaults.hpp

Go to the documentation of this file.

/**
 * @file defaults.hpp
 * @brief Sensible default constants for embedded systems
 * @ingroup common
 *
 * Provides buffer sizes and limits appropriate for resource-constrained
 * ARM Cortex-M systems. Use these when you don't have a specific reason
 * to choose different values.
 */
 
#ifndef SBL_DEFAULTS_HPP_
#define SBL_DEFAULTS_HPP_
 
#include <cstddef>
 
namespace sbl {
namespace defaults {
 
/**
 * @brief Small buffer size for number formatting, etc.
 *
 * 12 bytes is enough for a 32-bit number in any base plus sign and null.
 */
constexpr std::size_t SMALL_BUFFER = 12;
 
/**
 * @brief Medium buffer size for string operations
 */
constexpr std::size_t MEDIUM_BUFFER = 64;
 
/**
 * @brief Large buffer size for log messages, etc.
 */
constexpr std::size_t LARGE_BUFFER = 256;
 
/**
 * @brief Maximum log message length
 */
constexpr std::size_t LOG_MESSAGE = LARGE_BUFFER;
 
} // namespace defaults
} // namespace sbl
 
#endif // SBL_DEFAULTS_HPP_