ble_instr_api.h File Reference

API header file that all BLE tester instrument DLL plug-ins should use. More...

#include "stdint.h"

Go to the source code of this file.

Macros
#define	__bool_true_false_are_defined   1
#define	bool   char
#define	true   1
#define	false   0
#define	BLE_INSTR_EXPORTS
#define	BLE_INSTR_API   __declspec(dllexport)
#define	BLE_INSTR_CALLBACK(A, Y, Z)   (A != NULL) ? A(Y, Z) : ((void)0)
	Callback macro definition for NULL check. More...
#define	BLE_TESTER_STR_SIZE   256
	Callback result string data size. More...

Typedefs
typedef enum _BLE_INSTR_STATUS_CODES	BLE_INSTR_STATUS_CODES
	The BLE instrument API return and callback status codes.
typedef enum __ble_instr_pwr_range	_ble_instr_pwr_range
	The BLE tester instrument API TX power range requirements.
typedef void(*	_callback_ble_instr) (int status, char *data)
	BLE tester instrument API callback function type definition. More...

Enumerations
enum	_BLE_INSTR_STATUS_CODES {   BLE_INSTR_SUCCESS = 0 , BLE_INSTR_ERROR , BLE_INSTR_INVALID_DBG_PARAMS , BLE_INSTR_DBG_DLL_ERROR ,   BLE_INSTR_TX_PWR_START , BLE_INSTR_TX_PWR_PASSED , BLE_INSTR_TX_PWR_FAILED , BLE_INSTR_TX_FREQ_OFFS_START ,   BLE_INSTR_TX_FREQ_OFFS_PASSED , BLE_INSTR_TX_FREQ_OFFS_FAILED , BLE_INSTR_TX_MOD_IDX_START , BLE_INSTR_TX_MOD_IDX_PASSED ,   BLE_INSTR_TX_MOD_IDX_FAILED , BLE_INSTR_TX_RX_SENS_START , BLE_INSTR_TX_RX_SENS_OK , BLE_INSTR_TX_RX_SENS_ERROR }
	The BLE instrument API return and callback status codes. More...
enum	__ble_instr_pwr_range {   AUTO_PWR_RANGE = 0 , AUTO_PWR_RANGE_1 , AUTO_PWR_RANGE_2 , AUTO_PWR_RANGE_3 ,   AUTO_PWR_RANGE_4 , AUTO_PWR_RANGE_5 , AUTO_PWR_RANGE_6 , INVALID_PWR_RANGE }
	The BLE tester instrument API TX power range requirements. More...

Functions
BLE_INSTR_API int	ble_instr_dbg_init (_dbg_params *dbg_params_t)
	BLE tester instrument debug session initialize. More...
BLE_INSTR_API int	ble_instr_dbg_close (void)
	BLE tester instrument debug session close. More...
BLE_INSTR_API int	ble_instr_init (void *data, _callback_ble_instr callback_ble_instr)
	BLE tester instrument API initialize function. More...
BLE_INSTR_API int	ble_instr_close (void)
	BLE tester instrument API close function and free allocated resources. More...
BLE_INSTR_API int	ble_instr_set_path_loss (float path_loss)
	BLE tester instrument API function to set the path losses between the instrument and the DUT. More...
BLE_INSTR_API int	ble_instr_set_pwr_range (_ble_instr_pwr_range pwr_range)
	BLE tester instrument API function to set the instrument TX input power range. More...
BLE_INSTR_API int	ble_instr_set_tx_pwr_h_lim (float avg_high_limit)
	BLE tester instrument API function to set the packet average high power limit for the TX output power measurements. More...
BLE_INSTR_API int	ble_instr_set_tx_pwr_l_lim (float avg_low_limit)
	BLE tester instrument API function to set the packet average low power limit for the TX output power measurements. More...
BLE_INSTR_API int	ble_instr_set_tx_pwr_pk_lim (float pk_avg_limit)
	BLE tester instrument API function to set the peak to average power limit for the TX output power measurements. The largest peak power of a bit in a packet. measured for all packets in the tests. More...
BLE_INSTR_API int	ble_instr_do_tx_pwr (uint32_t freq)
	BLE tester instrument API function that performs the TX output power measurements on a specific BLE frequency channel. More...
BLE_INSTR_API int	ble_instr_set_freq_offs_h_lim (uint32_t pos_freq_limit)
	BLE tester instrument API function to set the maximum positive offset limit in KHz for the TX carrier frequency offset measurements. More...
BLE_INSTR_API int	ble_instr_set_freq_offs_l_lim (uint32_t neg_freq_limit)
	BLE tester instrument API function to set the maximum negative offset limit in KHz for the TX carrier frequency offset measurements. More...
BLE_INSTR_API int	ble_instr_set_freq_drift_pkt_lim (uint32_t drift_pkt_limit)
	BLE tester instrument API function to set the overall packet drift limit in KHz for the TX drift measurements. More...
BLE_INSTR_API int	ble_instr_set_freq_drift_rate_lim (uint32_t drift_rate_limit)
	BLE tester instrument API function to set the drift rate limit in KHz/50us for the TX drift measurements. More...
BLE_INSTR_API int	ble_instr_do_freq_offs (uint32_t freq)
	BLE tester instrument API function that performs the TX frequency offset measurements on a specific BLE channel. More...
BLE_INSTR_API int	ble_instr_set_mod_idx_f1_min (uint32_t f1_min_limit)
	Set the F1 minimum average limit in KHz for the TX modulation index measurements. More...
BLE_INSTR_API int	ble_instr_set_mod_idx_f1_max (uint32_t f1_max_limit)
	Set the F1 maximum average limit in KHz for the TX modulation index measurements. More...
BLE_INSTR_API int	ble_instr_set_mod_idx_f2_max (uint32_t f2_max_limit)
	Set the F2 maximum limit in KHz for the TX modulation index measurements. More...
BLE_INSTR_API int	ble_instr_set_mod_idx_f1f2_ratio (float f1f2_ratio_limit)
	Set the F1/F2 maximum average ratio limit for the TX modulation index measurements. More...
BLE_INSTR_API int	ble_instr_do_mod_idx (int payload, uint32_t freq)
	BLE tester instrument API function that performs the TX modulation index measurements on a specific BLE channel. More...
BLE_INSTR_API int	ble_instr_set_rx_sens_tx_pat (uint8_t pattern)
	Set the instrument TX packet pattern type for RX sensitivity measurements. More...
BLE_INSTR_API int	ble_instr_set_rx_sens_pkt_space (uint16_t spacing)
	Set the instrument TX packet spacing in us for RX sensitivity measurements. More...
BLE_INSTR_API int	ble_instr_set_rx_sens_pkt_num (uint16_t num_of_pkts)
	Set the instrument TX number of packets for RX sensitivity measurements. More...
BLE_INSTR_API int	ble_instr_set_rx_sens_tx_pwr (float tx_power)
	Set the instrument TX output power for RX sensitivity measurements. More...
BLE_INSTR_API int	ble_instr_set_rx_sens_tx_dirty (bool dirty)
	Set the instrument TX dirty packets enable/disable for RX sensitivity measurements. More...
BLE_INSTR_API int	ble_instr_set_rx_sens_tx_crc (bool crc_state)
	Set the instrument TX packet CRC alternate state on/off for RX sensitivity measurements. More...
BLE_INSTR_API int	ble_instr_do_rx_sens (uint32_t freq)
	Performs the transmission of packets, for DUT RX sensitivity measurements. More...

Detailed Description

API header file that all BLE tester instrument DLL plug-ins should use.

Copyright (C) 2022 Dialog Semiconductor. This computer program includes Confidential, Proprietary Information of Dialog Semiconductor. All Rights Reserved.

bluet.nosp@m.ooth.nosp@m..supp.nosp@m.ort@.nosp@m.diase.nosp@m.mi.c.nosp@m.om

Definition in file ble_instr_api.h.