Sapphire SoC DS Sapphire SoC UG Sapphire HP SoC DS Sapphire HP SoC UG RISC-V Embedded IDE UG Board Support Package
Loading...
Searching...
No Matches
Constants & Definitions

Overview

Register bitmasks, ANSI colors, and Debug Levels.

ANSI Colors

ANSI Escape codes for colored terminal output.

#define ANSI_RESET   "\033[0m"
 Reset to default color.
#define ANSI_RED   "\033[31m"
 Red Text.
#define ANSI_GREEN   "\033[32m"
 Green Text.
#define ANSI_YELLOW   "\033[33m"
 Yellow Text.
#define ANSI_BLUE   "\033[34m"
 Blue Text.
#define ANSI_MAGENTA   "\033[35m"
 Magenta Text.
#define ANSI_CYAN   "\033[36m"
 Cyan Text.
#define ANSI_BOLD   "\033[1m"
 Bold Text.
#define ANSI_UNDER   "\033[4m"
 Underlined Text.

Debug Modules

Bitmasks to enable logging for specific peripherals.

Note
Combine these using OR | operator in ACTIVE_DEBUG_MOD.
#define DBG_MOD_SYS   (1 << 0)
 System / Core.
#define DBG_MOD_IRQ   (1 << 1)
 Interrupt Controller.
#define DBG_MOD_FAULT   (1 << 2)
 Hard Faults / Errors.
#define DBG_MOD_UART   (1 << 3)
 UART Driver.
#define DBG_MOD_I2C   (1 << 4)
 I2C Driver.
#define DBG_MOD_SPI   (1 << 5)
 SPI Driver.
#define DBG_MOD_SPI_FLASH   (1 << 6)
 SPI Flash Driver.
#define DBG_MOD_RTC   (1 << 7)
 Real Time Clock.
#define DBG_MOD_CAM   (1 << 8)
 Camera.
#define DBG_MOD_SENSOR   (1 << 9)
 External Sensors.
#define DBG_MOD_ALL
 Enable ALL debug modules.

Debug Levels

Verbosity levels for logging.

Note
Set ACTIVE_MIN_LVL in userDef.h to one of these values.
#define DBG_LVL_ALL   0
 Print Everything (Info, Warn, Error).
#define DBG_LVL_WARN   1
 Print Warning and Error only.
#define DBG_LVL_ERR   2
 Print Error only.
#define DBG_LVL_NONE   3
 Silence (No output).

Macro Definition Documentation

◆ ANSI_BLUE

#define ANSI_BLUE   "\033[34m"

#include <debug.h>

Blue Text.

Definition at line 90 of file debug.h.

◆ ANSI_BOLD

#define ANSI_BOLD   "\033[1m"

#include <debug.h>

Bold Text.

Definition at line 93 of file debug.h.

◆ ANSI_CYAN

#define ANSI_CYAN   "\033[36m"

#include <debug.h>

Cyan Text.

Definition at line 92 of file debug.h.

◆ ANSI_GREEN

#define ANSI_GREEN   "\033[32m"

#include <debug.h>

Green Text.

Definition at line 88 of file debug.h.

◆ ANSI_MAGENTA

#define ANSI_MAGENTA   "\033[35m"

#include <debug.h>

Magenta Text.

Definition at line 91 of file debug.h.

◆ ANSI_RED

#define ANSI_RED   "\033[31m"

#include <debug.h>

Red Text.

Definition at line 87 of file debug.h.

◆ ANSI_RESET

#define ANSI_RESET   "\033[0m"

#include <debug.h>

Reset to default color.

Definition at line 86 of file debug.h.

◆ ANSI_UNDER

#define ANSI_UNDER   "\033[4m"

#include <debug.h>

Underlined Text.

Definition at line 94 of file debug.h.

◆ ANSI_YELLOW

#define ANSI_YELLOW   "\033[33m"

#include <debug.h>

Yellow Text.

Definition at line 89 of file debug.h.

◆ DBG_LVL_ALL

#define DBG_LVL_ALL   0

#include <debug.h>

Print Everything (Info, Warn, Error).

Definition at line 124 of file debug.h.

◆ DBG_LVL_ERR

#define DBG_LVL_ERR   2

#include <debug.h>

Print Error only.

Definition at line 126 of file debug.h.

◆ DBG_LVL_NONE

#define DBG_LVL_NONE   3

#include <debug.h>

Silence (No output).

Definition at line 127 of file debug.h.

◆ DBG_LVL_WARN

#define DBG_LVL_WARN   1

#include <debug.h>

Print Warning and Error only.

Definition at line 125 of file debug.h.

◆ DBG_MOD_ALL

#define DBG_MOD_ALL

#include <debug.h>

Value:
#define DBG_MOD_SYS
System / Core.
Definition debug.h:102
#define DBG_MOD_UART
UART Driver.
Definition debug.h:105
#define DBG_MOD_SPI
SPI Driver.
Definition debug.h:107
#define DBG_MOD_I2C
I2C Driver.
Definition debug.h:106
#define DBG_MOD_FAULT
Hard Faults / Errors.
Definition debug.h:104
#define DBG_MOD_IRQ
Interrupt Controller.
Definition debug.h:103
#define DBG_MOD_SENSOR
External Sensors.
Definition debug.h:111
#define DBG_MOD_SPI_FLASH
SPI Flash Driver.
Definition debug.h:108
#define DBG_MOD_RTC
Real Time Clock.
Definition debug.h:109

Enable ALL debug modules.

Definition at line 114 of file debug.h.

◆ DBG_MOD_CAM

#define DBG_MOD_CAM   (1 << 8)

#include <debug.h>

Camera.

Definition at line 110 of file debug.h.

◆ DBG_MOD_FAULT

#define DBG_MOD_FAULT   (1 << 2)

#include <debug.h>

Hard Faults / Errors.

Definition at line 104 of file debug.h.

◆ DBG_MOD_I2C

#define DBG_MOD_I2C   (1 << 4)

#include <debug.h>

I2C Driver.

Definition at line 106 of file debug.h.

◆ DBG_MOD_IRQ

#define DBG_MOD_IRQ   (1 << 1)

#include <debug.h>

Interrupt Controller.

Definition at line 103 of file debug.h.

◆ DBG_MOD_RTC

#define DBG_MOD_RTC   (1 << 7)

#include <debug.h>

Real Time Clock.

Definition at line 109 of file debug.h.

◆ DBG_MOD_SENSOR

#define DBG_MOD_SENSOR   (1 << 9)

#include <debug.h>

External Sensors.

Definition at line 111 of file debug.h.

◆ DBG_MOD_SPI

#define DBG_MOD_SPI   (1 << 5)

#include <debug.h>

SPI Driver.

Definition at line 107 of file debug.h.

◆ DBG_MOD_SPI_FLASH

#define DBG_MOD_SPI_FLASH   (1 << 6)

#include <debug.h>

SPI Flash Driver.

Definition at line 108 of file debug.h.

◆ DBG_MOD_SYS

#define DBG_MOD_SYS   (1 << 0)

#include <debug.h>

System / Core.

Definition at line 102 of file debug.h.

◆ DBG_MOD_UART

#define DBG_MOD_UART   (1 << 3)

#include <debug.h>

UART Driver.

Definition at line 105 of file debug.h.