Diag

Diag 的协作图:

结构体
struct	diag_option_t
	option选项，当前存放对端地址 更多...
struct	diag_cmd_reg_obj_t
	diag命令注册结构体 更多...
struct	diag_sys_stat_obj_t
	统计量注册结构体 更多...

宏定义
#define	DIAG_OPTION_INIT_VAL   {0, {0, 0, 0}}
	diag_option的初始值

类型定义
typedef errcode_t(*	diag_cmd_f) (uint16_t cmd_id, void *cmd_param, uint16_t cmd_param_size, diag_option_t *option)
	diag命令行函数指针

函数
errcode_t	uapi_diag_register_cmd (const diag_cmd_reg_obj_t *cmd_tbl, uint16_t cmd_num)
	diag命令注册接口
errcode_t	uapi_diag_unregister_cmd (const diag_cmd_reg_obj_t *cmd_tbl, uint16_t cmd_num)
	diag命令解注册接口
errcode_t	uapi_diag_report_packet (uint16_t cmd_id, diag_option_t *option, const uint8_t *packet, uint16_t packet_size, bool sync)
	diag报文上报接口
errcode_t	uapi_diag_report_packets_critical (uint16_t cmd_id, diag_option_t *option, uint8_t **packet, uint16_t *packet_size, uint8_t pkt_cnt)
	diag上报多个关键报文
errcode_t	uapi_diag_report_packets_normal (uint16_t cmd_id, diag_option_t *option, uint8_t **packet, uint16_t *packet_size, uint8_t pkt_cnt)
	diag上报多个普通报文
errcode_t	uapi_diag_report_sys_msg (uint32_t module_id, uint32_t msg_id, const uint8_t *buf, uint16_t buf_size, uint8_t level)
	消息上报接口
errcode_t	uapi_diag_register_ind (const diag_cmd_reg_obj_t *cmd_tbl, uint16_t cmd_num)
	应答注册接口
errcode_t	uapi_diag_run_cmd (uint16_t cmd_id, uint8_t *data, uint16_t data_size, diag_option_t *option)
	命令执行接口
errcode_t	uapi_diag_register_stat_obj (const diag_sys_stat_obj_t *stat_obj_tbl, uint16_t obj_num)
	统计量注册接口

详细描述

Copyright (c) HiSilicon (Shanghai) Technologies Co., Ltd. 2021-2022. All rights reserved. Description: header file for diag api.
History:
2022-05-07, fix comments.
2021-12-31, Create file.

宏定义说明

DIAG_OPTION_INIT_VAL

#define DIAG_OPTION_INIT_VAL   {0, {0, 0, 0}}

diag_option的初始值

类型定义说明

diag_cmd_f

typedef errcode_t(* diag_cmd_f) (uint16_t cmd_id, void *cmd_param, uint16_t cmd_param_size, diag_option_t *option)

diag命令行函数指针

函数说明

uapi_diag_register_cmd()

errcode_t uapi_diag_register_cmd	(	const diag_cmd_reg_obj_t *	cmd_tbl,
		uint16_t	cmd_num
	)

diag命令注册接口

uapi_diag_register_ind()

errcode_t uapi_diag_register_ind	(	const diag_cmd_reg_obj_t *	cmd_tbl,
		uint16_t	cmd_num
	)

应答注册接口

uapi_diag_register_stat_obj()

errcode_t uapi_diag_register_stat_obj	(	const diag_sys_stat_obj_t *	stat_obj_tbl,
		uint16_t	obj_num
	)

统计量注册接口

uapi_diag_report_packet()

errcode_t uapi_diag_report_packet	(	uint16_t	cmd_id,
		diag_option_t *	option,
		const uint8_t *	packet,
		uint16_t	packet_size,
		bool	sync
	)

diag报文上报接口

uapi_diag_report_packets_critical()

errcode_t uapi_diag_report_packets_critical	(	uint16_t	cmd_id,
		diag_option_t *	option,
		uint8_t **	packet,
		uint16_t *	packet_size,
		uint8_t	pkt_cnt
	)

diag上报多个关键报文

uapi_diag_report_packets_normal()

errcode_t uapi_diag_report_packets_normal	(	uint16_t	cmd_id,
		diag_option_t *	option,
		uint8_t **	packet,
		uint16_t *	packet_size,
		uint8_t	pkt_cnt
	)

diag上报多个普通报文

uapi_diag_report_sys_msg()

errcode_t uapi_diag_report_sys_msg	(	uint32_t	module_id,
		uint32_t	msg_id,
		const uint8_t *	buf,
		uint16_t	buf_size,
		uint8_t	level
	)

消息上报接口

uapi_diag_run_cmd()

errcode_t uapi_diag_run_cmd	(	uint16_t	cmd_id,
		uint8_t *	data,
		uint16_t	data_size,
		diag_option_t *	option
	)

命令执行接口

uapi_diag_unregister_cmd()

errcode_t uapi_diag_unregister_cmd	(	const diag_cmd_reg_obj_t *	cmd_tbl,
		uint16_t	cmd_num
	)

diag命令解注册接口