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);

 
/* ========================================================================== */
/* SECTION 1: CONSTANTS & DEFINITIONS                                         */
/* ========================================================================== */


        #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"   

        #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_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_SENSOR)


        #define DBG_LVL_ALL     0   
        #define DBG_LVL_WARN    1   
        #define DBG_LVL_ERR     2   
        #define DBG_LVL_NONE    3   
 // End of DEBUG_Const
 
 
/* ========================================================================== */
/* SECTION 2: CONFIGURATION & MACROS                                          */
/* ========================================================================== */

#include "userDef.h"
 
    /* * FAILSAFE: We check defined(__DOXYGEN__) so these macros appear in 
     * documentation even if DEBUG_MODE is not set in Doxyfile.
     */
    #if (DEBUG_MODE == 1) || defined(__DOXYGEN__)
    
        /* -----------------------------------------------------------------------------*/
        /* DEFAULT CONFIGURATION                                                       */
        /* -----------------------------------------------------------------------------*/
        #if !defined(ACTIVE_DEBUG_MOD) ||  !defined(ACTIVE_MIN_LVL)
            /* Use safe defaults if userDef.h is missing values */
            #define ACTIVE_DEBUG_MOD   0
            #define ACTIVE_MIN_LVL     DBG_LVL_NONE
            
            /* Only trigger warning during real compilation, not documentation generation */
            #ifndef __DOXYGEN__
                #warning "Missing ACTIVE_DEBUG or ACTIVE_MIN_LVL in userDef.h! Disabling Debug."
            #endif
        #endif
            
        /* -----------------------------------------------------------------------------*/
        /* ASSERTION MACRO                                                             */
        /* -----------------------------------------------------------------------------*/
        #define BSP_ASSERT(cond, msg) \
            do { \
                if (!(cond)) { \
                    const char *p = (msg); \
                    while (*p) { \
                        bsp_putChar(*p); \
                        p++; \
                    } \
                    /* Hang forever */ \
                    while(1); \
                } \
            } while(0)
 
        /* -----------------------------------------------------------------------------*/
        /* LOGGING MACROS                                                              */
        /* -----------------------------------------------------------------------------*/
            
        #define SHOULD_LOG(debug, lvl) \
            ( ((ACTIVE_DEBUG_MOD) & (debug)) && ((lvl) >= (ACTIVE_MIN_LVL)) )
            
        #define LOG_INFO(debug, fmt, ...) \
            do { \
                if (SHOULD_LOG(debug, DBG_LVL_ALL)) { \
                    printf(ANSI_GREEN "INFO: " fmt ANSI_RESET "\n", ##__VA_ARGS__); \
                } \
            } while(0)
        
        #define LOG_WARN(debug, fmt, ...) \
            do { \
                if (SHOULD_LOG(debug, DBG_LVL_WARN)) { \
                    printf(ANSI_YELLOW "WRN: " fmt ANSI_RESET "\n", ##__VA_ARGS__); \
                } \
            } while(0)

        #define LOG_ERR(debug, fmt, ...) \
            do { \
                if (SHOULD_LOG(debug, DBG_LVL_ERR)) { \
                    printf(ANSI_RED "ERR: " fmt ANSI_RESET "\n", ##__VA_ARGS__); \
                } \
            } while(0)
 
    #else // DEBUG_MODE == 0
        
        #define BSP_ASSERT(cond, msg)      ((void)0)
        #define LOG_INFO(debug, fmt, ...)  ((void)0)
        #define LOG_WARN(debug, fmt, ...)  ((void)0)
        #define LOG_ERR(debug, fmt, ...)   ((void)0)
        
    #endif
 // End of DEBUG_Config group
 
#ifdef __cplusplus
}
#endif // C_plusplus
 // End of MAIN DEBUG Group
 
#endif // DEBUG_H