Microchip® Advanced Software Framework

2/inc/perf_api.h File Reference
#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 (trx_id_t trx, uint8_t set_param_type, param_value_t *param_value)
 
More...
 
void perf_set_sun_page (trx_id_t trx, uint8_t *sun_page)
 
More...
 
void perf_get_req (trx_id_t trx, uint8_t param_type)
 Function to get the various configuration parameters for PER Test. More...
 
void initiate_per_test (trx_id_t trx)
 Initiates the test procedure. More...
 
void start_ed_scan (trx_id_t trx, uint8_t scan_duration, uint32_t channel_sel_mask)
 Function to start the ED scan. More...
 
void get_sensor_data (trx_id_t trx)
 Function to get the Sensor data like Battery volatge. More...
 
void get_board_details (trx_id_t trx)
 prints the hardware details More...
 
void identify_peer_node (trx_id_t trx)
 Identifying peer node. More...
 
void read_trx_registers (trx_id_t trx, uint16_t reg_addr)
 Read transceiver register. More...
 
void write_trx_registers (trx_id_t trx, uint16_t reg_addr, uint8_t reg_val)
 write Transceiver registers More...
 
void dump_trx_register_values (trx_id_t trx, uint16_t start_reg_addr, uint16_t end_reg_addr)
 Read a set of registers. More...
 
void disconnect_peer_node (trx_id_t trx)
 Function to request the peer to get disconnected from source node. More...
 
void set_default_configuration (trx_id_t trx)
 Function to set the default values of. More...
 
void get_current_configuration (trx_id_t trx)
 Function to get the current values of the all configurabel patameters. More...
 
uint8_t check_error_conditions (trx_id_t trx)
 Function used to check the error conditions before. More...
 
Functions for User Request Primitives
uint8_t get_param_length (uint8_t parameter_type)
 
UART COMMUNICATION FRAMING
void usr_perf_start_confirm (trx_id_t trx, 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 (trx_id_t trx, uint8_t status)
 Function to generate Per Test Start confirmation frame that must be sent to host application via serial interface. More...
 
void usr_per_test_end_indication (trx_id_t trx, 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 (trx_id_t trx, 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 (trx_id_t trx, 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 (trx_id_t trx, 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 (trx_id_t trx, 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 (trx_id_t trx, 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 (trx_id_t trx, uint8_t status, uint8_t parameter_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 (trx_id_t trx, 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 (trx_id_t trx, 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 (trx_id_t trx, 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 (trx_id_t trx, 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 (trx_id_t trx, 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 (trx_id_t trx, 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 (trx_id_t trx, 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 (trx_id_t trx, 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 (trx_id_t trx, 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_range_test_beacon_rsp (trx_id_t trx, frame_info_t *frame, 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 (trx_id_t trx, frame_info_t *frame, uint8_t lqi, int8_t ed_value)
 Function to send the Marker Indication frame to the Host application. More...
 
void usr_range_test_start_confirm (trx_id_t trx, uint8_t status)
 Function to generate Range Test Start confirmation frame that must be sent to host application via serial interface. More...
 
void usr_range_test_stop_confirm (trx_id_t trx, 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 (trx_id_t trx, frame_info_t *frame)
 Function to send the transmitted frame to the Host application. More...
 
Functions for User Confirm/Indication Messages generated in response

to the Request Primitives

void initiate_range_test (trx_id_t trx)
 Initiates the Range test procedure. More...
 
void stop_range_test (trx_id_t trx)
 Function to Stop the range Test in PER Mode. More...
 
float reverse_float (const float float_val)
 The reverse_float is used for reversing a float variable for supporting BIG ENDIAN systems. More...