LOG Reader

结构体
struct	oml_rx_data_stru_t
struct	rw_reg_mem_cmd_t

宏定义
#define	LIB_LOG_READER_LOG_OAM_MSG_H
#define	LOG_OML_HEADER_PRIME_ID_MASK   (0x0F)
#define	LOG_OAM_RX_BUFF_LEN   (300)
#define	LOG_OAM_RX_BUFF_NUM   (2)
#define	REGMEM_ADDR_AND_VALUE_MAX_LEN   (2)
#define	LOG_UART_LOG_WATERMARK_VALUE_ON_INIT   0
#define	LOG_UART_BT_LOG_WATERMARK_VALUE_HIGH   ((BT_CORE_LOGGING_LENGTH)*8 / 10)

类型定义
typedef void(*	ramfunc_oml_csstat_cmd) (uint8_t *, uint8_t)
typedef void(*	oam_cmd_handle_callback) (uint8_t *, uint16_t)
typedef void(*	log_uart_output_response_to_at_uart_callback) (const char *at_string, uint16_t len)
	output response to at uart callback

枚举
enum	oam_ret_t {   OAM_RET_OK , OAM_ERR_POINT_NULL , OAM_ERR_LEN_ERR , OAM_ERR_OP_ERR ,   OAM_ERR_SIZE_ERR , OAM_ERR_VALUE_ERR }
	Definitions of the operation result 更多...
enum	OM_LOG_CONFIG_RESULT_ENUM { OM_LOG_CONFIG_SUCCESS = 0 , OM_LOG_CONFIG_FAIL = 1 , OM_LOG_CONFIG_RESULT_BUTT }
enum	OM_IF_TYPE_ENUM { OM_IF_UART = 0 , OM_IF_SDIO = 1 , OM_IF_TYPE_BUTT }
enum	OM_TXQUEUE_NODE_STATUS { OM_TXQUEUE_NODE_INVALID , OM_TXQUEUE_NODE_VALID }
enum	oml_buff_status_t { OML_BUFF_NOT_USED , OML_BUFF_USING , OML_BUFF_USED , OML_BUFF_BUTT }
enum	nxlog_operation_t {   NXLOG_OPERATION_ENABLE = 0 , NXLOG_OPERATION_DISABLE , NXLOG_OPERATION_DELETE , NXLOG_OPERATION_DUMP_TO_AT_UART ,   NXLOG_OPERATION_DUMP_TO_DEBUG_UART }

函数
uint32_t	parse_reg_or_mem_cmd_operate (const uint8_t *data, uint32_t len, rw_reg_mem_cmd_t *reg_mem_cmd)
	Parse the opetaion in the command.
uint32_t	parse_reg_or_mem_cmd_size (const uint8_t *data, uint32_t len, rw_reg_mem_cmd_t *reg_mem_cmd)
	Parse the value size in the command.
uint32_t	parse_reg_or_mem_cmd_addr_value (const uint8_t *data, uint32_t len, rw_reg_mem_cmd_t *reg_mem_cmd)
	Parse the addr and value in the command.
bool	log_oam_register_handler_callback (uint8_t message_type, oam_cmd_handle_callback callback)
void	log_oam_prase_message (void)
void	oml_msg_parse (uint8_t *data, uint16_t data_len)
void	log_register_default_rx_callback (void)
void	log_uart_init (void)
	Initialises the uart logger before RTOS functions are available.
void	log_uart_send_buffer (const uint8_t *buffer, uint16_t length)
	Send buffer used log uart by write uart tx FIFO
void	log_uart_write_blocking (const void *buf, uint32_t len)
	Send buffer used log uart by write uart tx FIFO
void	log_uart_init_after_rtos (void)
	Initialises the UART logging when RTOS functions are available. This should be called before the RTOS scheduler starts, but when we can create mutexes.
void	log_uart_trigger (void)
	Triggers the uart logger. It can be called from program context or ISR.
uint32_t	log_uart_get_nxlog_state (void)
	Check if the xlog is enabled.
void	log_uart_reset_baud_rate (void)
	Reconfigure the baud rate when the frequency changes.
void	log_main (const void *unused_p)
	Main log uart task
void	log_uart_update_watermark_level (log_memory_region_section_t log_mem_region, uint16_t new_watermark_val)
	Update the watermark level for a given logging region.

详细描述

宏定义说明

LIB_LOG_READER_LOG_OAM_MSG_H

#define LIB_LOG_READER_LOG_OAM_MSG_H

LOG_OAM_RX_BUFF_LEN

#define LOG_OAM_RX_BUFF_LEN   (300)

LOG_OAM_RX_BUFF_NUM

#define LOG_OAM_RX_BUFF_NUM   (2)

LOG_OML_HEADER_PRIME_ID_MASK

#define LOG_OML_HEADER_PRIME_ID_MASK   (0x0F)

LOG_UART_BT_LOG_WATERMARK_VALUE_HIGH

#define LOG_UART_BT_LOG_WATERMARK_VALUE_HIGH   ((BT_CORE_LOGGING_LENGTH)*8 / 10)

LOG_UART_LOG_WATERMARK_VALUE_ON_INIT

#define LOG_UART_LOG_WATERMARK_VALUE_ON_INIT   0

REGMEM_ADDR_AND_VALUE_MAX_LEN

#define REGMEM_ADDR_AND_VALUE_MAX_LEN   (2)

类型定义说明

log_uart_output_response_to_at_uart_callback

typedef void(* log_uart_output_response_to_at_uart_callback) (const char *at_string, uint16_t len)

output response to at uart callback

参数

at_string

The at string to send out through at uart.

oam_cmd_handle_callback

typedef void(* oam_cmd_handle_callback) (uint8_t *, uint16_t)

ramfunc_oml_csstat_cmd

typedef void(* ramfunc_oml_csstat_cmd) (uint8_t *, uint8_t)

枚举类型说明

nxlog_operation_t

enum nxlog_operation_t

枚举值
NXLOG_OPERATION_ENABLE
NXLOG_OPERATION_DISABLE
NXLOG_OPERATION_DELETE
NXLOG_OPERATION_DUMP_TO_AT_UART
NXLOG_OPERATION_DUMP_TO_DEBUG_UART

oam_ret_t

enum oam_ret_t

Definitions of the operation result

枚举值
OAM_RET_OK
OAM_ERR_POINT_NULL
OAM_ERR_LEN_ERR
OAM_ERR_OP_ERR
OAM_ERR_SIZE_ERR
OAM_ERR_VALUE_ERR

OM_IF_TYPE_ENUM

enum OM_IF_TYPE_ENUM

枚举值
OM_IF_UART
OM_IF_SDIO
OM_IF_TYPE_BUTT

OM_LOG_CONFIG_RESULT_ENUM

enum OM_LOG_CONFIG_RESULT_ENUM

枚举值
OM_LOG_CONFIG_SUCCESS
OM_LOG_CONFIG_FAIL
OM_LOG_CONFIG_RESULT_BUTT

OM_TXQUEUE_NODE_STATUS

enum OM_TXQUEUE_NODE_STATUS

枚举值
OM_TXQUEUE_NODE_INVALID
OM_TXQUEUE_NODE_VALID

oml_buff_status_t

enum oml_buff_status_t

枚举值
OML_BUFF_NOT_USED
OML_BUFF_USING
OML_BUFF_USED
OML_BUFF_BUTT

函数说明

log_main()

void log_main

(

const void *

unused_p

)

Main log uart task

参数

unused_p

unused parameter

log_oam_prase_message()

void log_oam_prase_message

(

void

)

log_oam_register_handler_callback()

bool log_oam_register_handler_callback	(	uint8_t	message_type,
		oam_cmd_handle_callback	callback
	)

log_register_default_rx_callback()

void log_register_default_rx_callback

(

void

)

log_uart_get_nxlog_state()

uint32_t log_uart_get_nxlog_state

(

void

)

Check if the xlog is enabled.

返回

1 if the xlog is enabled.

log_uart_init()

void log_uart_init

(

void

)

Initialises the uart logger before RTOS functions are available.

This handler gets called when one of the cores wants to trigger the log reader

参数

message	The IPC message
payload_p	The payload, contains the reset reason
src	The core who has just started
id	The message ID (should always be 0 - the first message after starting)

返回

log_uart_init_after_rtos()

void log_uart_init_after_rtos

(

void

)

Initialises the UART logging when RTOS functions are available. This should be called before the RTOS scheduler starts, but when we can create mutexes.

log_uart_reset_baud_rate()

void log_uart_reset_baud_rate

(

void

)

Reconfigure the baud rate when the frequency changes.

log_uart_send_buffer()

void log_uart_send_buffer	(	const uint8_t *	buffer,
		uint16_t	length
	)

Send buffer used log uart by write uart tx FIFO

log_uart_trigger()

void log_uart_trigger

(

void

)

Triggers the uart logger. It can be called from program context or ISR.

log_uart_update_watermark_level()

void log_uart_update_watermark_level	(	log_memory_region_section_t	log_mem_region,
		uint16_t	new_watermark_val
	)

Update the watermark level for a given logging region.

注解

Currently just LOG_MEMORY_REGION_SECTION_1 is supported.

log_uart_write_blocking()

void log_uart_write_blocking	(	const void *	buf,
		uint32_t	len
	)

Send buffer used log uart by write uart tx FIFO

oml_msg_parse()

void oml_msg_parse	(	uint8_t *	data,
		uint16_t	data_len
	)

parse_reg_or_mem_cmd_addr_value()

uint32_t parse_reg_or_mem_cmd_addr_value	(	const uint8_t *	data,
		uint32_t	len,
		rw_reg_mem_cmd_t *	reg_mem_cmd
	)

Parse the addr and value in the command.

参数

data	The AT command from App core.
len	The length of the AT command.
reg_mem_cmd	The parse result stored here.

返回

OAM_RET.

parse_reg_or_mem_cmd_operate()

uint32_t parse_reg_or_mem_cmd_operate	(	const uint8_t *	data,
		uint32_t	len,
		rw_reg_mem_cmd_t *	reg_mem_cmd
	)

Parse the opetaion in the command.

参数

data	The AT command from App core.
len	The length of the AT command.
reg_mem_cmd	The parse result stored here.

返回

OAM_RET.

parse_reg_or_mem_cmd_size()

uint32_t parse_reg_or_mem_cmd_size	(	const uint8_t *	data,
		uint32_t	len,
		rw_reg_mem_cmd_t *	reg_mem_cmd
	)

Parse the value size in the command.

参数

data	The AT command from App core.
len	The length of the AT command.
reg_mem_cmd	The parse result stored here.

返回

OAM_RET.