xf_utils_log

日志宏的封装。 更多...

xf_utils_log 的协作图:

宏定义
#define	XF_LOG_NONE   (0)
#define	XF_LOG_USER   (1)
#define	XF_LOG_ERROR   (2)
#define	XF_LOG_WARN   (3)
#define	XF_LOG_INFO   (4)
#define	XF_LOG_DEBUG   (5)
#define	XF_LOG_VERBOSE   (6)
#define	XF_DUMP_HEAD_BIT   (0)
#define	XF_DUMP_ASCII_BIT   (1)
#define	XF_DUMP_ESCAPE_BIT   (2)
#define	XF_DUMP_TAIL_BIT   (3)
#define	XF_DUMP_BIT(nr)   BIT(nr)
#define	XF_DUMP_TABLE   (XF_DUMP_BIT(XF_DUMP_HEAD_BIT) | XF_DUMP_BIT(XF_DUMP_TAIL_BIT))
#define	XF_DUMP_FLAG_HEX_ONLY   (XF_DUMP_TABLE)
#define	XF_DUMP_FLAG_HEX_ASCII   (XF_DUMP_BIT(XF_DUMP_ASCII_BIT) | XF_DUMP_TABLE)
#define	XF_DUMP_FLAG_HEX_ASCII_ESCAPE   (XF_DUMP_FLAG_HEX_ASCII | XF_DUMP_BIT(XF_DUMP_ESCAPE_BIT))
#define	XF_LOGU(tag, format, ...)   xf_log_level(XF_LOG_USER, tag, format, ##__VA_ARGS__)
	用户等级日志。始终显示文件名、行号等信息。
#define	XF_LOGE(tag, format, ...)   xf_log_level(XF_LOG_ERROR, tag, format, ##__VA_ARGS__)
	错误等级日志。始终显示文件名、行号等信息。
#define	XF_LOGW(tag, format, ...)   xf_log_level(XF_LOG_WARN, tag, format, ##__VA_ARGS__)
	警告等级日志。
#define	XF_LOGI(tag, format, ...)   xf_log_level(XF_LOG_INFO, tag, format, ##__VA_ARGS__)
	信息等级日志。
#define	XF_LOGD(tag, format, ...)   xf_log_level(XF_LOG_DEBUG, tag, format, ##__VA_ARGS__)
	调试等级日志。
#define	XF_LOGV(tag, format, ...)   xf_log_level(XF_LOG_VERBOSE, tag, format, ##__VA_ARGS__)
	冗余等级日志。
#define	XF_LOG_BUFFER_HEX(buffer, buffer_len)    xf_dump_mem(buffer, buffer_len, XF_DUMP_FLAG_HEX_ONLY)
	以十六进制输出 buffer 的内容。
#define	XF_LOG_BUFFER_HEXDUMP(buffer, buffer_len)    xf_dump_mem(buffer, buffer_len, XF_DUMP_FLAG_HEX_ASCII)
	以十六进制输出 buffer 的内容，同时输出可见的 ascii 码。
#define	XF_LOG_BUFFER_HEXDUMP_ESCAPE(buffer, buffer_len)    xf_dump_mem(buffer, buffer_len, XF_DUMP_FLAG_HEX_ASCII_ESCAPE)
	以十六进制输出 buffer 的内容，同时输出可见的 ascii 码，以及转义字符。

函数
xf_err_t	xf_dump_mem (void *addr, size_t size, uint8_t flags_mask)
	输出内存信息。

详细描述

日志宏的封装。

宏定义说明

XF_LOG_NONE

#define XF_LOG_NONE   (0)

在文件 xf_utils_log.h 第 35 行定义.

XF_LOG_USER

#define XF_LOG_USER   (1)

在文件 xf_utils_log.h 第 36 行定义.

XF_LOG_ERROR

#define XF_LOG_ERROR   (2)

在文件 xf_utils_log.h 第 37 行定义.

XF_LOG_WARN

#define XF_LOG_WARN   (3)

在文件 xf_utils_log.h 第 38 行定义.

XF_LOG_INFO

#define XF_LOG_INFO   (4)

在文件 xf_utils_log.h 第 39 行定义.

XF_LOG_DEBUG

#define XF_LOG_DEBUG   (5)

在文件 xf_utils_log.h 第 40 行定义.

XF_LOG_VERBOSE

#define XF_LOG_VERBOSE   (6)

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

XF_DUMP_HEAD_BIT

#define XF_DUMP_HEAD_BIT   (0)

flags_mask 中表头的标志位

在文件 xf_utils_log.h 第 45 行定义.

XF_DUMP_ASCII_BIT

#define XF_DUMP_ASCII_BIT   (1)

flags_mask 中 ASCII 的标志位

在文件 xf_utils_log.h 第 46 行定义.

XF_DUMP_ESCAPE_BIT

#define XF_DUMP_ESCAPE_BIT   (2)

flags_mask 中带有转义字符的标志位

在文件 xf_utils_log.h 第 47 行定义.

XF_DUMP_TAIL_BIT

#define XF_DUMP_TAIL_BIT   (3)

flags_mask 中表尾的标志位

在文件 xf_utils_log.h 第 48 行定义.

XF_DUMP_BIT

#define XF_DUMP_BIT

(

nr

)

BIT(nr)

在文件 xf_utils_log.h 第 50 行定义.

XF_DUMP_TABLE

#define XF_DUMP_TABLE   (XF_DUMP_BIT(XF_DUMP_HEAD_BIT) | XF_DUMP_BIT(XF_DUMP_TAIL_BIT))

在文件 xf_utils_log.h 第 52 行定义.

XF_DUMP_FLAG_HEX_ONLY

#define XF_DUMP_FLAG_HEX_ONLY   (XF_DUMP_TABLE)

在文件 xf_utils_log.h 第 55 行定义.

XF_DUMP_FLAG_HEX_ASCII

#define XF_DUMP_FLAG_HEX_ASCII   (XF_DUMP_BIT(XF_DUMP_ASCII_BIT) | XF_DUMP_TABLE)

在文件 xf_utils_log.h 第 57 行定义.

XF_DUMP_FLAG_HEX_ASCII_ESCAPE

#define XF_DUMP_FLAG_HEX_ASCII_ESCAPE   (XF_DUMP_FLAG_HEX_ASCII | XF_DUMP_BIT(XF_DUMP_ESCAPE_BIT))

在文件 xf_utils_log.h 第 59 行定义.

XF_LOGU

#define XF_LOGU	(		tag,
			format,
			...
	)		xf_log_level(XF_LOG_USER, tag, format, ##__VA_ARGS__)

用户等级日志。始终显示文件名、行号等信息。

参数

tag	日志标签。
format	日志格式化字符串。
...	可变参数。

返回

size_t 本次日志字节数。

在文件 xf_utils_log.h 第 92 行定义.

XF_LOGE

#define XF_LOGE	(		tag,
			format,
			...
	)		xf_log_level(XF_LOG_ERROR, tag, format, ##__VA_ARGS__)

错误等级日志。始终显示文件名、行号等信息。

参数

tag	日志标签。
format	日志格式化字符串。
...	可变参数。

返回

size_t 本次日志字节数。

在文件 xf_utils_log.h 第 106 行定义.

XF_LOGW

#define XF_LOGW	(		tag,
			format,
			...
	)		xf_log_level(XF_LOG_WARN, tag, format, ##__VA_ARGS__)

警告等级日志。

参数

tag	日志标签。
format	日志格式化字符串。
...	可变参数。

返回

size_t 本次日志字节数。

在文件 xf_utils_log.h 第 120 行定义.

XF_LOGI

#define XF_LOGI	(		tag,
			format,
			...
	)		xf_log_level(XF_LOG_INFO, tag, format, ##__VA_ARGS__)

信息等级日志。

参数

tag	日志标签。
format	日志格式化字符串。
...	可变参数。

返回

size_t 本次日志字节数。

在文件 xf_utils_log.h 第 134 行定义.

XF_LOGD

#define XF_LOGD	(		tag,
			format,
			...
	)		xf_log_level(XF_LOG_DEBUG, tag, format, ##__VA_ARGS__)

调试等级日志。

参数

tag	日志标签。
format	日志格式化字符串。
...	可变参数。

返回

size_t 本次日志字节数。

在文件 xf_utils_log.h 第 148 行定义.

XF_LOGV

#define XF_LOGV	(		tag,
			format,
			...
	)		xf_log_level(XF_LOG_VERBOSE, tag, format, ##__VA_ARGS__)

冗余等级日志。

参数

tag	日志标签。
format	日志格式化字符串。
...	可变参数。

返回

size_t 本次日志字节数。

在文件 xf_utils_log.h 第 162 行定义.

XF_LOG_BUFFER_HEX

#define XF_LOG_BUFFER_HEX	(		buffer,
			buffer_len
	)		xf_dump_mem(buffer, buffer_len, XF_DUMP_FLAG_HEX_ONLY)

以十六进制输出 buffer 的内容。

参数

buffer	待输出的 buffer。
buffer_len	buffer 的长度。

返回

xf_err_t 是否输出成功。

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

XF_LOG_BUFFER_HEXDUMP

#define XF_LOG_BUFFER_HEXDUMP	(		buffer,
			buffer_len
	)		xf_dump_mem(buffer, buffer_len, XF_DUMP_FLAG_HEX_ASCII)

以十六进制输出 buffer 的内容，同时输出可见的 ascii 码。

参数

buffer	待输出的 buffer。
buffer_len	buffer 的长度。

返回

xf_err_t 是否输出成功。

示例

examples/wireless/ble/sample_gatt_client/main/xf_main.c , 以及 examples/wireless/ble/sample_gatt_server/main/xf_main.c.

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

XF_LOG_BUFFER_HEXDUMP_ESCAPE

#define XF_LOG_BUFFER_HEXDUMP_ESCAPE	(		buffer,
			buffer_len
	)		xf_dump_mem(buffer, buffer_len, XF_DUMP_FLAG_HEX_ASCII_ESCAPE)

以十六进制输出 buffer 的内容，同时输出可见的 ascii 码，以及转义字符。

参数

buffer	待输出的 buffer。
buffer_len	buffer 的长度。

返回

xf_err_t 是否输出成功。

示例

examples/wireless/sle/sample_ssap_client/main/xf_main.c , 以及 examples/wireless/sle/sample_ssap_server/main/xf_main.c.

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

函数说明

xf_dump_mem()

xf_err_t xf_dump_mem	(	void *	addr,
		size_t	size,
		uint8_t	flags_mask
	)

输出内存信息。

参数

addr	内存地址。
size	待输出的内存字节长度。
flags_mask	格式掩码，见 XF_DUMP_FLAG_*。

返回

xf_err_t

• XF_ERR_INVALID_ARG 参数错误
• XF_OK 成功

在文件 xf_utils_log_dump.c 第 41 行定义.