ptxRF_Test.h

Go to the documentation of this file.

 
#ifndef APIS_PTX_RF_TEST_H_
#define APIS_PTX_RF_TEST_H_
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include <stdint.h>
#include "ptx_Status.h"
#include "ptxOsal.h"
#include "ptxLog.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES
 * ####################################################################################################################
 */
#if defined (_WIN32) || defined (_WIN64) || defined (ming) || defined (__MINGW32__) || defined (__GNUWIN32__)
    #define PTX_API_LIBFUNC __declspec(dllexport) /* */
#else
 
    #if defined (__GNUC__)                                                  /* GCC */
        #define PTX_API_LIBFUNC __attribute__ ((visibility("default")))     /* requires  -fvisibility=hidden  as compiler option */
    #elif defined (_linux) || defined (__linux)                             /* Linux with some other compiler */
        #error Missing Platform Specification                               /* To be added */
    #else
        #error Missing Platform Specification
    #endif
#endif
 
/*
 * ####################################################################################################################
 * TYPES
 * ####################################################################################################################
 */
 
#define PTX_RF_TEST_FLAGS_PRBS_TYPE_A_INCLUDE_PARITY            (uint8_t)0x01   
typedef enum ptxRF_Test_TestID
{
    RF_TEST_ID_PRBS_9,                                  
    RF_TEST_ID_PRBS_15,                                 
    RF_TEST_ID_Carrier,                                 
} ptxRF_Test_TestID_t;
 
typedef enum ptxRF_Test_TechType
{
    RF_TEST_TECH_A,                                     
    RF_TEST_TECH_B,                                     
    RF_TEST_TECH_F,                                     
    RF_TEST_TECH_V,                                     
} ptxRF_Test_TechType_t;
 
typedef enum ptxRF_Test_BitRate
{
    RF_TEST_BITRATE_106  = 0,                                
    RF_TEST_BITRATE_212  = 1,                                
    RF_TEST_BITRATE_424  = 2,                                
    RF_TEST_BITRATE_848  = 3,                                
    RF_TEST_BITRATE_26   = 6,                                
} ptxRF_Test_BitRate_t;
 
typedef struct ptxRF_Test_PRBS_Params
{
    ptxRF_Test_TechType_t       Technology;             
    ptxRF_Test_BitRate_t        Bitrate;                
    uint8_t                     Flags;                  
} ptxRF_Test_PRBS_Params_t;
 
typedef struct ptxRF_Test_Carrier_Params
{
    uint8_t                     RFU;                  
} ptxRF_Test_Carrier_Params_t;
 
typedef union ptxRF_Test_Params
{
    ptxRF_Test_PRBS_Params_t       PRBS;                
    ptxRF_Test_Carrier_Params_t    Carrier;             
} ptxRF_Test_Params_t;
 
typedef struct ptxRF_Test_TestParams
{
    ptxRF_Test_TestID_t         ID;
    ptxRF_Test_Params_t         Params;
 
} ptxRF_Test_TestParams_t;
 
typedef struct ptxRF_Test_InitParams
{
    void                        *StackComp;             
} ptxRF_Test_InitParams_t;
 
typedef struct ptxRF_Test
{
    /* Components */
    ptxStatus_Comps_t           CompId;                 
    struct ptxOsal              *OS;                    
    ptxLog_t                    *LOG;                   
    void                        *StackComp;             
    ptxSemaphore_t              *Sem_Completion;        
    uint16_t                    *CompletionStatus;      
    uint8_t                     *DataShared;            
} ptxRF_Test_t;
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
PTX_API_LIBFUNC ptxStatus_t ptxRF_Test_Init (ptxRF_Test_t *rfTestComp, ptxRF_Test_InitParams_t *initParams);
 
PTX_API_LIBFUNC ptxStatus_t ptxRF_Test_Deinit (ptxRF_Test_t *rfTestComp);
 
PTX_API_LIBFUNC ptxStatus_t ptxRF_Test_RunTest(ptxRF_Test_t *rfTestComp, ptxRF_Test_TestParams_t *testParams);
 
PTX_API_LIBFUNC ptxStatus_t ptxRF_Test_StopTest(ptxRF_Test_t *rfTestComp);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */