debug_log.h

Go to the documentation of this file.

/* Copyright 2019 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#include <stdint.h>
#include <stdarg.h>
#include "api.h"
#include "uart_print.h"
 
#ifdef APP_PRINTING
#define Print_Log(fmt, ...) UartPrint_printf(fmt, ##__VA_ARGS__)
#ifndef DEBUG_LOG_UART_BAUDRATE
#define DEBUG_LOG_UART_BAUDRATE 115200
#endif
#define LOG_INIT() UartPrint_init(DEBUG_LOG_UART_BAUDRATE)
#else
#define Print_Log(fmt, ...)
#define LOG_INIT()
#endif
 
#ifndef DEBUG_LOG_MAX_LEVEL
/* By default only errors are displayed */
#define DEBUG_LOG_MAX_LEVEL LVL_ERROR
#endif
 
#define LVL_DEBUG 4
#define LVL_INFO 3
#define LVL_WARNING 2
#define LVL_ERROR 1
#define LVL_NOLOG 0
 
/* Do not modify; number in macro name must match the defined log levels
 * above.
 */
#define LVL_STRING_4 "D"
#define LVL_STRING_3 "I"
#define LVL_STRING_2 "W"
#define LVL_STRING_1 "E"
#define LVL_STRING_0 ""
 
#define DEBUG_LVL_TO_STRING(level) LVL_STRING_##level
 
#define FLUSH_DELAY_MS 45
 
#ifndef DEBUG_LOG_CUSTOM
#    ifndef DEBUG_LOG_MODULE_NAME
         /* Name of the module must be defined. */
#        error "No module name set for logger"
#endif
     /* Use "[Module name][Time] Log level: " log prefix by default. */
#    define DEBUG_LOG_PRINT_MODULE_NAME
#    define DEBUG_LOG_PRINT_TIME
#    define DEBUG_LOG_PRINT_LEVEL
#    undef  DEBUG_LOG_PRINT_FUNCTION
#    undef  DEBUG_LOG_PRINT_LINE
#endif
 
/* Module name string. */
#ifdef DEBUG_LOG_PRINT_MODULE_NAME
#    define S_MOD_NAME_PREFIX "["DEBUG_LOG_MODULE_NAME"]"
#else
#    define S_MOD_NAME_PREFIX
#endif
/* Timestamp string. */
#ifdef DEBUG_LOG_PRINT_TIME_HP
#    define S_TIME_PREFIX "[%09u]"
#    define S_TIME_SUFFIX , lib_time->getTimestampHp()
#elif defined(DEBUG_LOG_PRINT_TIME_MS)
#    define S_TIME_PREFIX "[%09u]"
#    define S_TIME_SUFFIX , (lib_time->getTimestampCoarse() * 125) >> 4
#elif defined(DEBUG_LOG_PRINT_TIME)
#    define S_TIME_PREFIX "[%09u]"
#    define S_TIME_SUFFIX , lib_time->getTimestampCoarse()
#else
#    define S_TIME_PREFIX
#    define S_TIME_SUFFIX
#endif
/* Log level string. */
#ifdef DEBUG_LOG_PRINT_LEVEL
#    define S_LEVEL_PREFIX(level) " "DEBUG_LVL_TO_STRING(level)": "
#else
#    define S_LEVEL_PREFIX(level)
#endif
/* Function string. */
#ifdef DEBUG_LOG_PRINT_FUNCTION
#    define S_FUNCTION_PREFIX "func:%s, "
#    define S_FUNCTION_SUFFIX , __FUNCTION__
#else
#    define S_FUNCTION_PREFIX
#    define S_FUNCTION_SUFFIX
#endif
/* Line string. */
#ifdef DEBUG_LOG_PRINT_LINE
#    define S_LINE_PREFIX "line: %03d, "
#    define S_LINE_SUFFIX , __LINE__
#else
#    define S_LINE_PREFIX
#    define S_LINE_SUFFIX
#endif
 
#define LOG(level, fmt, ...) \
{ \
    ((uint8_t) level) <= ((uint8_t) DEBUG_LOG_MAX_LEVEL) ? \
    Print_Log( \
        S_MOD_NAME_PREFIX S_TIME_PREFIX S_LEVEL_PREFIX(level) \
        S_FUNCTION_PREFIX S_LINE_PREFIX \
        fmt"\n" S_TIME_SUFFIX S_FUNCTION_SUFFIX S_LINE_SUFFIX \
        , ##__VA_ARGS__) : \
    (void)NULL; \
}
 
#define LOGE(fmt, ...)  LOG(LVL_ERROR, fmt __VA_OPT__(,) __VA_ARGS__)
#define LOGW(fmt, ...)  LOG(LVL_WARNING, fmt __VA_OPT__(,) __VA_ARGS__)
#define LOGI(fmt, ...)  LOG(LVL_INFO, fmt __VA_OPT__(,) __VA_ARGS__)
#define LOGD(fmt, ...)  LOG(LVL_DEBUG, fmt __VA_OPT__(,) __VA_ARGS__)
 
#define LOG_BUFFER(level, buffer, size) \
{ \
    if(((uint8_t) level) <= ((uint8_t) DEBUG_LOG_MAX_LEVEL)) { \
        for (uint16_t i = 0; i < size; i++) \
        { \
            Print_Log("%02X ", buffer[i]); \
            if ((i & 0xF) == 0xF && i != (uint8_t)(size-1)) \
            { \
                Print_Log("\n"); \
            } \
        } \
        Print_Log("\n"); \
    } \
}
 
#define LOG_FLUSH(level) \
{ \
    if(((uint8_t) level) <= ((uint8_t) DEBUG_LOG_MAX_LEVEL)) { \
        app_lib_time_timestamp_hp_t end; \
        end = lib_time->addUsToHpTimestamp(lib_time->getTimestampHp(), \
                                           FLUSH_DELAY_MS * 1000); \
        while (lib_time->isHpTimestampBefore(lib_time->getTimestampHp(),end)); \
    } \
}