超越基础printf：为S32K打造带颜色、分级和Hexdump的豪华版日志库

在嵌入式开发中，调试信息的输出是开发过程中不可或缺的一环。对于使用NXP S32K系列微控制器的工程师来说，基础的printf功能虽然能够满足最基本的调试需求，但在复杂的汽车电子或工业控制项目中，面对海量的调试信息，如何快速定位问题、区分不同重要级别的日志，以及直观展示二进制数据，成为了提升开发效率的关键。

本文将带领读者从基础的printf重定向出发，逐步构建一个功能强大、易于使用的豪华版日志库。这个日志库不仅支持不同级别的日志输出（ERROR、WARN、INFO、DEBUG），还能通过ANSI转义码为不同级别的日志添加颜色标识，更包含实用的HEXDUMP功能，用于直观展示二进制数据。最终，我们将实现一个既美观又实用的调试工具，显著提升嵌入式开发的效率和体验。

1. 基础printf重定向的实现

在开始构建豪华版日志库之前，我们需要确保基础的printf功能能够在S32K上正常工作。这涉及到串口的初始化和printf的重定向。

1.1 硬件配置与初始化

首先，我们需要配置S32K的串口外设。以LPUART1为例，使用PTC3作为TX引脚：

// 引脚配置
pins_config_t pinConfig = {
    .base = PTC,
    .pinPortIdx = 3u,
    .pullConfig = PORT_INTERNAL_PULL_NOT_ENABLED,
    .passiveFilter = false,
    .driveSelect = PORT_LOW_DRIVE_STRENGTH,
    .mux = PORT_MUX_ALT2,  // LPUART1_TX
    .pinLock = false,
    .intConfig = PORT_DMA_INT_DISABLED
};

// 串口配置
lpuart_user_config_t lpuartConfig = {
    .baudRate = 115200,
    .bitCountPerChar = LPUART_8_BITS_PER_CHAR,
    .parityMode = LPUART_PARITY_DISABLED,
    .stopBitCount = LPUART_ONE_STOP_BIT,
    .transferType = LPUART_USING_INTERRUPTS,
    .rxDMAChannel = 0xFF,
    .txDMAChannel = 0xFF
};

1.2 printf重定向实现

在S32K上，printf的输出需要通过重定向__write_console函数来实现：

#include <stdio.h>
#include "lpuart_driver.h"

int __write_console(__file_handle handle, unsigned char* buffer, size_t* count) {
    (void)handle;
    uint32_t bytesRemaining;
    
    // 发送数据
    LPUART_DRV_SendData(INST_LPUART1, buffer, *count);
    
    // 等待发送完成
    while(LPUART_DRV_GetTransmitStatus(INST_LPUART1, &bytesRemaining) != STATUS_SUCCESS);
    
    return 0;
}

完成这些基础配置后，我们就可以在代码中使用标准的printf函数输出调试信息了。但这只是开始，接下来我们将在此基础上构建更强大的日志功能。

2. 实现分级日志系统

在复杂的嵌入式系统中，不同重要性的调试信息混杂在一起会大大降低调试效率。实现分级日志系统可以让开发者快速识别关键信息。

2.1 定义日志级别

我们首先定义几种常见的日志级别：

typedef enum {
    LOG_LEVEL_DEBUG = 0,  // 调试信息，最详细
    LOG_LEVEL_INFO,       // 一般信息
    LOG_LEVEL_WARNING,    // 警告信息
    LOG_LEVEL_ERROR,      // 错误信息
    LOG_LEVEL_NONE        // 关闭所有日志
} LogLevel_t;

2.2 实现日志级别控制

为了灵活控制日志输出，我们需要实现一个全局的日志级别设置：

static LogLevel_t currentLogLevel = LOG_LEVEL_DEBUG;  // 默认显示所有日志

void Log_SetLevel(LogLevel_t level) {
    currentLogLevel = level;
}

LogLevel_t Log_GetLevel(void) {
    return currentLogLevel;
}

2.3 分级日志宏定义

基于上述定义，我们可以实现不同级别的日志输出宏：

#define LOG_DEBUG(fmt, ...) \
    do { \
        if (currentLogLevel <= LOG_LEVEL_DEBUG) { \
            printf("[DEBUG] " fmt "\r\n", ##__VA_ARGS__); \
        } \
    } while (0)

#define LOG_INFO(fmt, ...) \
    do { \
        if (currentLogLevel <= LOG_LEVEL_INFO) { \
            printf("[INFO]  " fmt "\r\n", ##__VA_ARGS__); \
        } \
    } while (0)

#define LOG_WARNING(fmt, ...) \
    do { \
        if (currentLogLevel <= LOG_LEVEL_WARNING) { \
            printf("[WARN]  " fmt "\r\n", ##__VA_ARGS__); \
        } \
    } while (0)

#define LOG_ERROR(fmt, ...) \
    do { \
        if (currentLogLevel <= LOG_LEVEL_ERROR) { \
            printf("[ERROR] " fmt "\r\n", ##__VA_ARGS__); \
        } \
    } while (0)

使用这些宏，开发者可以方便地输出不同级别的日志信息：

LOG_DEBUG("This is a debug message");
LOG_INFO("System initialized");
LOG_WARNING("Temperature is approaching limit: %d°C", temp);
LOG_ERROR("Sensor %d not responding", sensorId);

3. 为日志添加颜色

在终端中显示不同颜色的日志可以进一步提高可读性。我们可以利用ANSI转义码来实现这一功能。

3.1 ANSI颜色代码

ANSI转义码是一系列用于控制终端显示的特殊字符序列。常用的颜色代码如下：

颜色	前景色代码	背景色代码
黑色	30	40
红色	31	41
绿色	32	42
黄色	33	43
蓝色	34	44
品红	35	45
青色	36	46
白色	37	47
重置所有属性	0	0

3.2 带颜色的日志宏

我们可以修改之前的日志宏，为不同级别的日志添加不同的颜色：

#define ANSI_COLOR_RED     "\x1b[31m"
#define ANSI_COLOR_GREEN   "\x1b[32m"
#define ANSI_COLOR_YELLOW  "\x1b[33m"
#define ANSI_COLOR_BLUE    "\x1b[34m"
#define ANSI_COLOR_MAGENTA "\x1b[35m"
#define ANSI_COLOR_CYAN    "\x1b[36m"
#define ANSI_COLOR_RESET   "\x1b[0m"

#define LOG_DEBUG(fmt, ...) \
    do { \
        if (currentLogLevel <= LOG_LEVEL_DEBUG) { \
            printf(ANSI_COLOR_CYAN "[DEBUG] " fmt ANSI_COLOR_RESET "\r\n", ##__VA_ARGS__); \
        } \
    } while (0)

#define LOG_INFO(fmt, ...) \
    do { \
        if (currentLogLevel <= LOG_LEVEL_INFO) { \
            printf(ANSI_COLOR_GREEN "[INFO]  " fmt ANSI_COLOR_RESET "\r\n", ##__VA_ARGS__); \
        } \
    } while (0)

#define LOG_WARNING(fmt, ...) \
    do { \
        if (currentLogLevel <= LOG_LEVEL_WARNING) { \
            printf(ANSI_COLOR_YELLOW "[WARN]  " fmt ANSI_COLOR_RESET "\r\n", ##__VA_ARGS__); \
        } \
    } while (0)

#define LOG_ERROR(fmt, ...) \
    do { \
        if (currentLogLevel <= LOG_LEVEL_ERROR) { \
            printf(ANSI_COLOR_RED "[ERROR] " fmt ANSI_COLOR_RESET "\r\n", ##__VA_ARGS__); \
        } \
    } while (0)

注意：并非所有终端都支持ANSI颜色代码。在使用前，请确保你的终端支持ANSI转义码。大多数现代终端（如PuTTY、Tera Term、SecureCRT等）都支持这一功能。

4. 实现HEXDUMP功能

在嵌入式开发中，经常需要查看二进制数据的内容。一个实用的HEXDUMP函数可以大大简化这一过程。

4.1 HEXDUMP函数实现

下面是一个功能完善的HEXDUMP函数实现：

void Log_HexDump(const char* label, const void* data, size_t size) {
    if (currentLogLevel > LOG_LEVEL_DEBUG) return;
    
    const uint8_t* bytes = (const uint8_t*)data;
    char ascii[17];
    size_t i, j;
    
    if (label) {
        printf(ANSI_COLOR_MAGENTA "[HEXDUMP] %s (%zu bytes):" ANSI_COLOR_RESET "\r\n", label, size);
    } else {
        printf(ANSI_COLOR_MAGENTA "[HEXDUMP] %zu bytes:" ANSI_COLOR_RESET "\r\n", size);
    }
    
    for (i = 0; i < size; i += 16) {
        // 打印偏移量
        printf("%08zx: ", i);
        
        // 打印16字节的十六进制值
        for (j = 0; j < 16; j++) {
            if (i + j < size) {
                printf("%02x ", bytes[i + j]);
            } else {
                printf("   ");
            }
            
            // 在第8字节后添加额外空格
            if (j == 7) printf(" ");
        }
        
        // 打印ASCII表示
        printf(" |");
        for (j = 0; j < 16; j++) {
            if (i + j < size) {
                uint8_t c = bytes[i + j];
                ascii[j] = (c >= 32 && c <= 126) ? c : '.';
                printf("%c", ascii[j]);
            } else {
                ascii[j] = ' ';
                printf(" ");
            }
        }
        ascii[16] = '\0';
        printf("|\r\n");
    }
}

4.2 HEXDUMP使用示例

使用这个函数可以方便地查看任何二进制数据：

uint8_t testData[] = {0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77,
                      0x88, 0x99, 0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0xFF,
                      'H', 'e', 'l', 'l', 'o', ' ', 'W', 'o',
                      'r', 'l', 'd', '!', 0x0A, 0x00};

Log_HexDump("Test Data", testData, sizeof(testData));

输出效果类似于：

[HEXDUMP] Test Data (30 bytes):
00000000: 00 11 22 33 44 55 66 77  88 99 aa bb cc dd ee ff  |.."3DUfw........|
00000010: 48 65 6c 6c 6f 20 57 6f  72 6c 64 21 0a 00        |Hello World!.. |

5. 高级功能与优化

5.1 条件编译控制

在产品发布时，我们可能希望完全移除调试日志以减少代码大小和提高性能。可以通过预编译宏来实现：

#ifdef LOG_DISABLE_DEBUG
    #undef LOG_DEBUG
    #define LOG_DEBUG(fmt, ...)
#endif

#ifdef LOG_DISABLE_INFO
    #undef LOG_INFO
    #define LOG_INFO(fmt, ...)
#endif

5.2 添加时间戳

对于时间敏感的应用，为日志添加时间戳非常有用：

uint32_t GetSystemTick(void);  // 假设这是获取系统tick的函数

#define LOG_DEBUG(fmt, ...) \
    do { \
        if (currentLogLevel <= LOG_LEVEL_DEBUG) { \
            printf(ANSI_COLOR_CYAN "[%08u][DEBUG] " fmt ANSI_COLOR_RESET "\r\n", \
                   GetSystemTick(), ##__VA_ARGS__); \
        } \
    } while (0)

5.3 线程安全实现

在多任务环境中，需要确保日志输出的原子性：

void Log_Lock(void);    // 实现日志锁
void Log_Unlock(void);  // 实现日志解锁

#define LOG_DEBUG(fmt, ...) \
    do { \
        if (currentLogLevel <= LOG_LEVEL_DEBUG) { \
            Log_Lock(); \
            printf(ANSI_COLOR_CYAN "[DEBUG] " fmt ANSI_COLOR_RESET "\r\n", ##__VA_ARGS__); \
            Log_Unlock(); \
        } \
    } while (0)

5.4 日志输出到文件

除了串口输出，我们还可以扩展日志输出到文件系统：

void Log_ToFile(const char* msg) {
    // 实现文件写入逻辑
}

#define LOG_DEBUG(fmt, ...) \
    do { \
        if (currentLogLevel <= LOG_LEVEL_DEBUG) { \
            char logMsg[256]; \
            snprintf(logMsg, sizeof(logMsg), "[DEBUG] " fmt "\r\n", ##__VA_ARGS__); \
            printf(ANSI_COLOR_CYAN "%s" ANSI_COLOR_RESET, logMsg); \
            Log_ToFile(logMsg); \
        } \
    } while (0)

6. 实际应用案例

让我们看一个在实际项目中使用这个日志系统的例子。假设我们正在开发一个汽车电子控制单元(ECU)，需要监控多个传感器并控制执行器。

void Sensor_Init(void) {
    LOG_INFO("Initializing sensors...");
    
    for (int i = 0; i < NUM_SENSORS; i++) {
        if (Sensor_InitSingle(i) != SENSOR_OK) {
            LOG_ERROR("Failed to initialize sensor %d", i);
            continue;
        }
        
        Sensor_CalibrationData calib;
        if (Sensor_ReadCalibration(i, &calib) == SENSOR_OK) {
            LOG_DEBUG("Sensor %d calibration data:", i);
            Log_HexDump(NULL, &calib, sizeof(calib));
        } else {
            LOG_WARNING("No calibration data for sensor %d", i);
        }
    }
    
    LOG_INFO("Sensor initialization complete");
}

void MainControlLoop(void) {
    while (1) {
        float temp = ReadTemperature();
        if (temp > TEMP_WARNING_THRESHOLD) {
            LOG_WARNING("High temperature: %.1f°C", temp);
        }
        if (temp > TEMP_ERROR_THRESHOLD) {
            LOG_ERROR("Critical temperature: %.1f°C - shutting down", temp);
            System_Shutdown();
            break;
        }
        
        // 其他控制逻辑...
    }
}

在这个例子中，不同重要级别的日志信息被清晰地标记出来，关键数据通过HEXDUMP直观展示，使得调试和维护变得更加高效。