Debug API Functions

Overview

Logging macros and runtime assertion.

Macros
#define	BSP_ASSERT(cond, msg)
	Assert a condition. Prints message and halts on failure.
#define	LOG_INFO(mod, fmt, ...)
	Log an informational message (green).
#define	LOG_WARN(mod, fmt, ...)
	Log a warning message (yellow).
#define	LOG_ERR(mod, fmt, ...)
	Log an error message (red).

Macro Definition Documentation

BSP_ASSERT

#define BSP_ASSERT	(		cond,
			msg )

#include <debug.h>

Value:

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

Assert a condition. Prints message and halts on failure.

Parameters

cond	Condition to evaluate.
msg	Null-terminated string to print on failure.

Definition at line 218 of file debug.h.

LOG_ERR

#define LOG_ERR	(		mod,
			fmt,
			... )

#include <debug.h>

Value:

do {                                                                \
    if (SHOULD_LOG(mod, DBG_LVL_ERR))                              \
        printf(ANSI_RED "ERR: " fmt ANSI_RESET "\n", ##__VA_ARGS__); \
} while (0)

Log an error message (red).

Parameters

mod	Module flag — see Debug Modules.
fmt	Printf-style format string.
...	Format arguments.

Definition at line 257 of file debug.h.

LOG_INFO

#define LOG_INFO	(		mod,
			fmt,
			... )

#include <debug.h>

Value:

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

Log an informational message (green).

Parameters

mod	Module flag — see Debug Modules.
fmt	Printf-style format string.
...	Format arguments.

Definition at line 233 of file debug.h.

LOG_WARN

#define LOG_WARN	(		mod,
			fmt,
			... )

#include <debug.h>

Value:

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

Log a warning message (yellow).

Parameters

mod	Module flag — see Debug Modules.
fmt	Printf-style format string.
...	Format arguments.

Definition at line 245 of file debug.h.