perf_api.h File Reference

API function protypes - Performance Analyzer application.

Copyright (c) 2013-2018 Microchip Technology Inc. and its subsidiaries.

#include "return_val.h"
#include "qmm.h"
#include "perf_msg_const.h"
#include "app_per_mode.h"

Functions
Functions for User Request Primitives
void	perf_set_req (uint8_t set_param_type, param_value_t *param_value)
	More...
void	perf_get_req (uint8_t param_type_data)
	Function to get the various configuaration paramters for PER Test. More...
void	initiate_per_test (void)
	Initiates the test procedure. More...
void	initiate_range_test (void)
	Initiates the Range test procedure. More...
void	start_ed_scan (uint8_t scan_duration, uint32_t channel_sel_mask)
	Function to start the ED scan. More...
void	get_sensor_data (void)
	Function to get the Sensor data like Battery volatge. More...
void	get_board_details (void)
	prints the hardware details More...
void	stop_range_test (void)
	Function to Stop the range Test in PER Mode. More...
void	identify_peer_node (void)
	Identifying peer node. More...
void	send_remote_cmd (uint8_t *serial_buf, uint8_t len, bool ack_req)
	Function to send the command to Remote node to perform remote test. More...
void	read_trx_registers (uint16_t reg_addr)
	Read transceiver register. More...
void	write_trx_registers (uint16_t reg_addr, uint8_t reg_val)
	write Transceiver registers More...
void	dump_trx_register_values (uint16_t start_reg_addr, uint16_t end_reg_addr)
	Read a set of registers. More...
void	disconnect_peer_node (void)
	Function to request the peer to get disconnected from source node. More...
void	set_default_configuration (void)
	Function to set the default values of. More...
void	config_per_test_parameters (void)
	Function to set trx configure parameters. More...
void	get_current_configuration (void)
	Function to get the current values of the all configurable parameters. More...
uint8_t	check_error_conditions (void)
	Function used to check the error conditions before. More...
uint8_t	get_param_length (uint8_t parameter_type)
void	pktstream_test (uint16_t gap_time, uint16_t timeout, bool start_stop, uint16_t frame_len)
	Starts Packet streaming test. More...
void	led_blinker_timer_handler_cb (void *parameter)
	Timer Callback function if identify command is received on air by a node in reflector configuration. More...
void	rx_on_test (bool start_stop_param)
	This function is called to initiate the RX_ON test The transceiver is put into the RX_ON mode and no requests are handled until this mode is stopped. More...
UART COMMUNICATION FRAMING
void	usr_range_test_beacon_rsp (uint8_t *mpdu, uint8_t lqi_h, int8_t ed_h, uint8_t lqi_r, int8_t ed_r)
	Function to send the Received Range Test Response frame to the Host application. More...
void	usr_range_test_marker_ind (uint8_t *mpdu, uint8_t lqi, int8_t ed_value)
	Function to send the Marker Indication frame to the Host application. More...
void	usr_perf_start_confirm (uint8_t status, uint8_t start_mode, trx_config_params_t *trx_config_params, uint8_t peer_ic_type, char *peer_soc_mcu_name, char *peer_trx_name, char *peer_board_name, uint64_t peer_mac_address, float peer_fw_version, uint32_t peer_feature_mask)
	Function to generate Perf Start confirmation frame that must be sent to host application via serial interface. More...
void	usr_per_test_start_confirm (uint8_t status)
	Function to generate Per Test Start confirmation frame that must be sent to host application via serial interface. More...
void	usr_range_test_start_confirm (uint8_t status)
	Function to generate Range Test Start confirmation frame that must be sent to host application via serial interface. More...
void	convert_ota_serial_frame_tx (uint8_t *buf, uint8_t len)
	The Received Remote Reply Command is converted into Serial Data and sent to the Host interface. More...
void	convert_ota_serial_frame_rx (uint8_t *buf, uint8_t len)
	More...
void	usr_range_test_stop_confirm (uint8_t status)
	Function to generate Range Test Stop confirmation frame that must be sent to host application via serial interface. More...
void	usr_range_test_beacon_tx (uint8_t *frame)
	Function to send the transmitted frame to the Host application. More...
void	usr_per_test_end_indication (uint8_t status, int8_t rssi_val, uint8_t aver_lqi, uint32_t frames_transmitted, uint32_t frames_received, uint32_t frames_failure, uint32_t frames_no_ack, uint32_t frames_channel_access_failure, uint32_t frames_with_wrong_crc, float test_duration_sec, float test_net_data_rate)
	Function to generate Per test End Indication frame that must be sent to host application via serial interface. More...
void	usr_ed_scan_start_confirm (uint8_t status, uint8_t scan_time_min, float scan_time_sec)
	Function to generate ED scan confirm test End Indication frame that must be sent to host application via serial interface. More...
void	usr_ed_scan_end_indication (uint8_t no_of_channels, ed_scan_result_t *ed_scan_result)
	Function to generate ED scan Indication frame that must be sent to host application via serial interface. More...
void	usr_sensor_data_get_confirm (uint8_t status, float bat_voltage, float temperature)
	Function to generate Sensor data confirm frame that must be sent to host application via serial interface. More...
void	usr_identify_board_confirm (uint8_t status, uint8_t ic_type, const char *mcu_soc_name, const char *trx_name, const char *board_name, uint64_t mac_address, float fw_version, uint32_t fw_feature_mask)
	Function to generate Identify Board confirm frame that must be sent to host application via serial interface. More...
void	usr_perf_set_confirm (uint8_t status, uint8_t param_type, param_value_t *param_value)
	Function to generate Perf Set confirmation frame that must be sent to host application via serial interface. More...
void	usr_perf_get_confirm (uint8_t status, uint8_t param_type, param_value_t *parame_value)
	Function to generate Perf Get confirmation frame that must be sent to host application via serial interface. More...
void	usr_identify_peer_node_confirm (uint8_t status)
	Function to generate Identify_peer_cnode_confirm that must be sent to host application via serial interface. More...
void	usr_cont_pulse_tx_confirm (uint8_t status)
	Function to generate cont_pulse_tx_confirm that must be sent to host application via serial interface. More...
void	usr_cont_wave_tx_confirm (uint8_t status, bool start_stop_param, uint8_t tx_mode)
	Function to generate cont_wave_tx_confirm that must be sent to host application via serial interface. More...
void	usr_register_read_confirm (uint8_t status, uint16_t reg_addr, uint8_t reg_val)
	Function to generate usr_register_read_confirm that must be sent to host application via serial interface. More...
void	usr_register_write_confirm (uint8_t status, uint16_t reg_addr, uint8_t reg_val)
	Function to generate usr_register_write_confirm that must be sent to host application via serial interface. More...
void	usr_register_dump_confirm (uint8_t status, uint16_t start_reg_addr, uint16_t end_reg_addr, uint8_t *reg_val)
	Function to generate usr_register_dump_confirm that must be sent to host application via serial interface. More...
void	usr_peer_disconnect_confirm (uint8_t status)
	Function to generate Disconnect Confirm frame that must be sent to host application via serial interface. More...
void	usr_set_default_config_confirm (uint8_t status, trx_config_params_t *default_trx_config_params)
	Function to generate Set default config Confirm frame that must be sent to host application via serial interface. More...
void	usr_get_current_config_confirm (uint8_t status, trx_config_params_t *curr_trx_conf_params)
	Function to generate Get Current config Confirm frame that must be sent to host application via serial interface. More...
void	usr_pkt_stream_confirm (uint8_t status, bool start_stop)
void	usr_rx_on_confirm (uint8_t status, bool start_stop)

Variables
bool	cw_ack_sent
uint8_t	cw_start_mode
uint16_t	cw_tmr_val
uint8_t	op_mode
bool	peer_found
uint32_t	pkt_stream_gap_time
bool	pkt_stream_stop
bool	pulse_mode
bool	rdy_to_tx
bool	remote_cw_start
bool	remote_pulse_cw_start
bool	remote_serial_tx_failure
bool	rx_on_mode
frame_info_t *	stream_pkt