xt_log（日志输出）

XTINY 日志模块——多级别日志、十六进制 dump、断言处理 更多...

宏定义
#define	XT_LOG_ERROR   1
#define	XT_LOG_WARN   2
#define	XT_LOG_INFO   3
#define	XT_LOG_DEBUG   4
#define	xt_log_error(format, ...)
#define	xt_log_warn(format, ...)
#define	xt_log_info(format, ...)
#define	xt_log_debug(format, ...)
#define	XT_LOGE(tag, format, ...)
#define	XT_LOGW(tag, format, ...)
#define	XT_LOGI(tag, format, ...)
#define	XT_LOGD(tag, format, ...)
#define	XT_ASSERT_MSG(expr, errcode)

类型定义
typedef void(*	xt_assert_cb_t) (xt_err_t errcode)
	assert 回调函数类型

函数
int	xt_vprintf (const char *fmt, va_list args)
	格式化输出（va_list 版本）
int	xt_printf (const char *fmt,...)
	格式化输出

初始化与配置
void	xt_log_setup (uint8_t id, uint32_t baudrate, uint8_t tx_io, uint8_t rx_io)
	初始化日志模块
void	xt_log_set_level (uint8_t level)
	设置日志输出级别
uint8_t	xt_log_get_level (void)
	获取当前日志级别

日志输出
void	xt_log (uint8_t level, const char *tag, const char *fmt,...)
	输出日志
void	xt_log_dump_hex (const void *ptr, uint32_t size)
	以十六进制格式打印内存数据
void	xt_log_dump_hex_debug (const void *ptr, uint32_t size)
	以十六进制格式打印内存数据（仅 DEBUG 级别）

断言处理
void	xt_assert_failed (xt_err_t errcode)
	断言失败处理函数（__weak 可重写）
void	xt_assert_set_callback (xt_assert_cb_t cb)
	注册 assert 触发回调

详细描述

XTINY 日志模块——多级别日志、十六进制 dump、断言处理

宏定义说明

XT_ASSERT_MSG

#define XT_ASSERT_MSG	(		expr,
			errcode )

值:

do { \
    if (!(expr)) { \
        xt_log_error("assert failed:%s:%d:err:%d", __FUNCTION__, __LINE__, (errcode)); \
        xt_assert_failed(errcode); \
    } \
} while(0)

在文件 xt_log.h 第 195 行定义.

XT_LOG_DEBUG

#define XT_LOG_DEBUG   4

调试级别

在文件 xt_log.h 第 44 行定义.

xt_log_debug

#define xt_log_debug	(		format,
			... )

值:

xt_log(XT_LOG_DEBUG, NULL, format, ##__VA_ARGS__)

在文件 xt_log.h 第 178 行定义.

XT_LOG_ERROR

#define XT_LOG_ERROR   1

错误级别

在文件 xt_log.h 第 41 行定义.

xt_log_error

#define xt_log_error	(		format,
			... )

值:

xt_log(XT_LOG_ERROR, NULL, format, ##__VA_ARGS__)

在文件 xt_log.h 第 169 行定义.

XT_LOG_INFO

#define XT_LOG_INFO   3

信息级别

在文件 xt_log.h 第 43 行定义.

xt_log_info

#define xt_log_info	(		format,
			... )

值:

xt_log(XT_LOG_INFO,  NULL, format, ##__VA_ARGS__)

在文件 xt_log.h 第 175 行定义.

XT_LOG_WARN

#define XT_LOG_WARN   2

警告级别

在文件 xt_log.h 第 42 行定义.

xt_log_warn

#define xt_log_warn	(		format,
			... )

值:

xt_log(XT_LOG_WARN,  NULL, format, ##__VA_ARGS__)

在文件 xt_log.h 第 172 行定义.

XT_LOGD

#define XT_LOGD	(		tag,
			format,
			... )

值:

xt_log(XT_LOG_DEBUG, tag, format, ##__VA_ARGS__)

在文件 xt_log.h 第 191 行定义.

XT_LOGE

#define XT_LOGE	(		tag,
			format,
			... )

值:

xt_log(XT_LOG_ERROR, tag, format, ##__VA_ARGS__)

在文件 xt_log.h 第 182 行定义.

XT_LOGI

#define XT_LOGI	(		tag,
			format,
			... )

值:

xt_log(XT_LOG_INFO,  tag, format, ##__VA_ARGS__)

在文件 xt_log.h 第 188 行定义.

XT_LOGW

#define XT_LOGW	(		tag,
			format,
			... )

值:

xt_log(XT_LOG_WARN,  tag, format, ##__VA_ARGS__)

在文件 xt_log.h 第 185 行定义.

类型定义说明

xt_assert_cb_t

typedef void(* xt_assert_cb_t) (xt_err_t errcode)

assert 回调函数类型

在文件 xt_log.h 第 49 行定义.

函数说明

xt_assert_failed()

void xt_assert_failed

(

xt_err_t

errcode

)

断言失败处理函数（__weak 可重写）

参数

errcode

错误码

xt_assert_set_callback()

void xt_assert_set_callback

(

xt_assert_cb_t

cb

)

注册 assert 触发回调

设置后每次 xt_assert_failed 被调用时，在平台特定处理之前调用回调。 cb 为 NULL 表示取消注册。

参数

cb	回调函数，NULL 取消注册

xt_log()

void xt_log	(	uint8_t	level,
		const char *	tag,
		const char *	fmt,
			... )

输出日志

参数

level	日志级别
tag	日志标签（可为 NULL）
fmt	格式化字符串
...	可变参数

xt_log_dump_hex()

void xt_log_dump_hex	(	const void *	ptr,
		uint32_t	size )

以十六进制格式打印内存数据

参数

ptr	数据指针
size	数据长度（字节）

xt_log_dump_hex_debug()

void xt_log_dump_hex_debug	(	const void *	ptr,
		uint32_t	size )

以十六进制格式打印内存数据（仅 DEBUG 级别）

参数

ptr	数据指针
size	数据长度（字节）

xt_log_get_level()

uint8_t xt_log_get_level

(

void

)

获取当前日志级别

返回

uint8_t 当前日志级别

xt_log_set_level()

void xt_log_set_level

(

uint8_t

level

)

设置日志输出级别

参数

level

日志级别（XT_LOG_ERROR / XT_LOG_WARN / XT_LOG_INFO / XT_LOG_DEBUG）

xt_log_setup()

void xt_log_setup	(	uint8_t	id,
		uint32_t	baudrate,
		uint8_t	tx_io,
		uint8_t	rx_io )

初始化日志模块

参数

id	UART 索引
baudrate	波特率
tx_io	发送引脚编号
rx_io	接收引脚编号

xt_printf()

int xt_printf	(	const char *	fmt,
			... )

格式化输出

参数

fmt	格式化字符串
...	可变参数

返回

int 输出字符数

xt_vprintf()

int xt_vprintf	(	const char *	fmt,
		va_list	args )

格式化输出（va_list 版本）

参数

fmt	格式化字符串
args	可变参数列表

返回

int 输出字符数