debug.h

Go to the documentation of this file.

// Copyright (C) 2013-2026 Efinix Inc. All rights reserved.
// Full license header: bsp/efinix/EfxSapphireSocRV64/include/LICENSE.MD
 
#ifndef DEBUG_H
#define DEBUG_H

 
#include <stdio.h> /* Required for printf */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Forward declaration for the character output function used in Assertion */
extern void bsp_putChar(char c);

 
/* =========================================================================
 * ANSI Colors
 * ========================================================================= */

    #define ANSI_RESET    "\033[0m"   
    #define ANSI_RED      "\033[31m"  
    #define ANSI_GREEN    "\033[32m"  
    #define ANSI_YELLOW   "\033[33m"  
    #define ANSI_BLUE     "\033[34m"  
    #define ANSI_MAGENTA  "\033[35m"  
    #define ANSI_CYAN     "\033[36m"  
    #define ANSI_BOLD     "\033[1m"   
    #define ANSI_UNDER    "\033[4m"   
 
/* =========================================================================
 * Debug Modules
 * ========================================================================= */

    #define DBG_MOD_SYS        (1 << 0)  
    #define DBG_MOD_IRQ        (1 << 1)  
    #define DBG_MOD_FAULT      (1 << 2)  
    #define DBG_MOD_UART       (1 << 3)  
    #define DBG_MOD_I2C        (1 << 4)  
    #define DBG_MOD_SPI        (1 << 5)  
    #define DBG_MOD_SPI_FLASH  (1 << 6)  
    #define DBG_MOD_RTC        (1 << 7)  
    #define DBG_MOD_CAM        (1 << 8)  
    #define DBG_MOD_SENSOR     (1 << 9)  
    #define DBG_MOD_MAIN       (1 << 10) 

    #define DBG_MOD_ALL  \
        ( DBG_MOD_SYS | DBG_MOD_IRQ | DBG_MOD_FAULT | DBG_MOD_UART  | \
          DBG_MOD_I2C | DBG_MOD_SPI | DBG_MOD_SPI_FLASH | DBG_MOD_RTC | \
          DBG_MOD_CAM | DBG_MOD_SENSOR | DBG_MOD_MAIN )

 
/* =========================================================================
 * Debug Levels
 * ========================================================================= */

    #define DBG_LVL_ALL   0  
    #define DBG_LVL_WARN  1  
    #define DBG_LVL_ERR   2  
    #define DBG_LVL_NONE  3  
 
/* =========================================================================
 * Debug API Function
 * ========================================================================= */
 
#include "userDef.h"
 
#if (DEBUG_MODE == 1) || defined(__DOXYGEN__)
 
    /* --- Fallback defaults if userDef.h is incomplete --- */
    #if !defined(ACTIVE_DEBUG_MOD) || !defined(ACTIVE_MIN_LVL)
        #define ACTIVE_DEBUG_MOD  0 
        #define ACTIVE_MIN_LVL    DBG_LVL_NONE 
        #ifndef __DOXYGEN__
            #warning "Missing ACTIVE_DEBUG_MOD or ACTIVE_MIN_LVL in userDef.h — debug disabled."
        #endif
    #endif


    #define SHOULD_LOG(mod, lvl) \
        ( ((ACTIVE_DEBUG_MOD) & (mod)) && ((lvl) >= (ACTIVE_MIN_LVL)) )

    #define BSP_ASSERT(cond, msg)               \
        do {                                    \
            if (!(cond)) {                      \
                const char *_p = (msg);         \
                while (*_p) bsp_putChar(*_p++); \
                while (1);                      \
            }                                   \
        } while (0)

    #define LOG_INFO(mod, fmt, ...)                                         \
        do {                                                                \
            if (SHOULD_LOG(mod, DBG_LVL_ALL))                              \
                printf(ANSI_GREEN "INFO: " fmt ANSI_RESET "\n", ##__VA_ARGS__); \
        } while (0)

    #define LOG_WARN(mod, fmt, ...)                                            \
        do {                                                                   \
            if (SHOULD_LOG(mod, DBG_LVL_WARN))                                \
                printf(ANSI_YELLOW "WRN: " fmt ANSI_RESET "\n", ##__VA_ARGS__); \
        } while (0)

    #define LOG_ERR(mod, fmt, ...)                                          \
        do {                                                                \
            if (SHOULD_LOG(mod, DBG_LVL_ERR))                              \
                printf(ANSI_RED "ERR: " fmt ANSI_RESET "\n", ##__VA_ARGS__); \
        } while (0)
 /* DBG_FUNC */
 
#else /* DEBUG_MODE == 0 — optimize everything out */

    #define BSP_ASSERT(cond, msg)      ((void)0)
    #define LOG_INFO(mod, fmt, ...)    ((void)0)
    #define LOG_WARN(mod, fmt, ...)    ((void)0)
    #define LOG_ERR(mod, fmt, ...)     ((void)0)
 
#endif /* DEBUG_MODE */
 /* DEBUG */
 
#ifdef __cplusplus
}
#endif
 
#endif /* DEBUG_H */