ble_instr_api.h

Go to the documentation of this file.

 
#ifndef _BLE_INSTR_API_H_
#define _BLE_INSTR_API_H_
 
 /*************************************************************************/
 /* INCLUDE FILES                                                         */
 /*************************************************************************/
#include "stdint.h"
/*************************************************************************/
/*************************************************************************/
 
#ifndef __bool_true_false_are_defined
    #define __bool_true_false_are_defined 1
    #ifndef __cplusplus /* In C++, 'bool', 'true' and 'false' and keywords */
        #define bool char
        #define true 1
        #define false 0
    #else
        #ifdef __GNUC__
            /* GNU C++ supports direct inclusion of stdbool.h to provide C99
            compatibility by defining _Bool */
            #define BOOL bool
        #endif
    #endif
#endif /* __bool_true_false_are_defined */
 
#define BLE_INSTR_EXPORTS
#ifdef BLE_INSTR_EXPORTS
    #define BLE_INSTR_API __declspec(dllexport)
#else
    #define BLE_INSTR_API __declspec(dllimport)
#endif
 
#define BLE_INSTR_CALLBACK(A, Y, Z) (A != NULL) ? A(Y, Z) : ((void)0)
 
#define BLE_TESTER_STR_SIZE                     256
 
typedef 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,
}BLE_INSTR_STATUS_CODES;
typedef 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                                       
}_ble_instr_pwr_range;
#ifdef __cplusplus    // If used by C++ code,
extern "C" {          // we need to export the C interface
#endif
 
 
 
typedef void (*_callback_ble_instr)(int status, char *data);
 
BLE_INSTR_API int ble_instr_dbg_init(_dbg_params *dbg_params_t);
 
BLE_INSTR_API int ble_instr_dbg_close(void);
 
BLE_INSTR_API int ble_instr_init(void *data, _callback_ble_instr callback_ble_instr);
 
BLE_INSTR_API int ble_instr_close(void);
 
BLE_INSTR_API int ble_instr_set_path_loss(float path_loss);
 
BLE_INSTR_API int ble_instr_set_pwr_range(_ble_instr_pwr_range pwr_range);
 
BLE_INSTR_API int ble_instr_set_tx_pwr_h_lim(float avg_high_limit);
 
BLE_INSTR_API int ble_instr_set_tx_pwr_l_lim(float avg_low_limit);
 
BLE_INSTR_API int ble_instr_set_tx_pwr_pk_lim(float pk_avg_limit);
 
BLE_INSTR_API int ble_instr_do_tx_pwr(uint32_t freq);
 
BLE_INSTR_API int ble_instr_set_freq_offs_h_lim(uint32_t pos_freq_limit);
 
BLE_INSTR_API int ble_instr_set_freq_offs_l_lim(uint32_t neg_freq_limit);
 
BLE_INSTR_API int ble_instr_set_freq_drift_pkt_lim(uint32_t drift_pkt_limit);
 
BLE_INSTR_API int ble_instr_set_freq_drift_rate_lim(uint32_t drift_rate_limit);
 
BLE_INSTR_API int ble_instr_do_freq_offs(uint32_t freq);
 
BLE_INSTR_API int ble_instr_set_mod_idx_f1_min(uint32_t f1_min_limit);
 
BLE_INSTR_API int ble_instr_set_mod_idx_f1_max(uint32_t f1_max_limit);
 
BLE_INSTR_API int ble_instr_set_mod_idx_f2_max(uint32_t f2_max_limit);
 
BLE_INSTR_API int ble_instr_set_mod_idx_f1f2_ratio(float f1f2_ratio_limit);
 
BLE_INSTR_API int ble_instr_do_mod_idx(int payload, uint32_t freq);
 
BLE_INSTR_API int ble_instr_set_rx_sens_tx_pat(uint8_t pattern);
 
BLE_INSTR_API int ble_instr_set_rx_sens_pkt_space(uint16_t spacing);
 
BLE_INSTR_API int ble_instr_set_rx_sens_pkt_num(uint16_t num_of_pkts);
 
BLE_INSTR_API int ble_instr_set_rx_sens_tx_pwr(float tx_power);
 
BLE_INSTR_API int ble_instr_set_rx_sens_tx_dirty(bool dirty);
 
BLE_INSTR_API int ble_instr_set_rx_sens_tx_crc(bool crc_state);
 
BLE_INSTR_API int ble_instr_do_rx_sens(uint32_t freq);
#ifdef __cplusplus
}
#endif // @defgroup ble_instr_api
 
#endif //_BLE_INSTR_API_H_