ptxTransparentMode.h

Go to the documentation of this file.

 
#ifndef APIS_PTX_TRANSPARENT_MODE_H_
#define APIS_PTX_TRANSPARENT_MODE_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
 
#define PTX_TRANSPARENT_MODE_FLAGS_TX_PARITY            (uint8_t)0x01            
#define PTX_TRANSPARENT_MODE_FLAGS_RX_PARITY            (uint8_t)0x02            
#define PTX_TRANSPARENT_MODE_FLAGS_TX_CRC               (uint8_t)0x04            
#define PTX_TRANSPARENT_MODE_FLAGS_RX_CRC               (uint8_t)0x08            
#define PTX_TRANSPARENT_MODE_FLAGS_RX_SOF_ONLY          (uint8_t)0x10            
#define PTX_TRANSPARENT_MODE_FLAGS_SKIP_1ST_BYTE_CRC    (uint8_t)0x20            
#define PTX_TRANSPARENT_MODE_RESET_DEFAULT      
/*
 * ####################################################################################################################
 * TYPES
 * ####################################################################################################################
 */
 
typedef enum ptxTransparentMode_RF_Tech
{
    TM_RF_Tech_A      = 0,
    TM_RF_Tech_B      = 1,
    TM_RF_Tech_F      = 2,
    TM_RF_Tech_V      = 6,
    TM_RF_Tech_BPrime = 7,
 
} ptxTransparentMode_RF_Tech_t;
 
typedef enum ptxTransparentMode_RF_Bitrate
{
    TM_RF_Bitrate_106 = 0,
    TM_RF_Bitrate_212 = 1,
    TM_RF_Bitrate_424 = 2,
    TM_RF_Bitrate_848 = 3,
    TM_RF_Bitrate_26  = 6,
 
} ptxTransparentMode_RF_Bitrate_t;
 
typedef struct ptxTransparentMode_RFParams
{
    ptxTransparentMode_RF_Tech_t       Tech;                    
    ptxTransparentMode_RF_Bitrate_t    TxRate;                  
    ptxTransparentMode_RF_Bitrate_t    RxRate;                  
    uint8_t                            Flags;                   
    uint8_t                            NrTxBits;                
    uint8_t                            ResLimit;                
} ptxTransparentMode_RFParams_t;
 
typedef struct ptxTransparentMode_InitParams
{
    void                                *StackComp;         
} ptxTransparentMode_InitParams_t;
 
typedef struct ptxTransparentMode
{
    /* Components */
    ptxStatus_Comps_t                   CompId;             
    struct ptxOsal                      *OS;                
    ptxLog_t                            *LOG;               
    void                                *StackComp;         
    ptxSemaphore_t                      *Sem_Completion;    
    uint16_t                            *CompletionStatus;  
    uint8_t                             *DataShared;        
    uint8_t                             BPrimeActive;       
    uint8_t                             SoFOnlyActive;      
    uint8_t                             SkipByteCRCActive;  
} ptxTransparentMode_t;
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
PTX_API_LIBFUNC ptxStatus_t ptxTransparentMode_Init (ptxTransparentMode_t *tmComp, ptxTransparentMode_InitParams_t *initParams);
 
PTX_API_LIBFUNC ptxStatus_t ptxTransparentMode_SetRFParameters (ptxTransparentMode_t *tmComp, ptxTransparentMode_RFParams_t *rfParams);
 
PTX_API_LIBFUNC ptxStatus_t ptxTransparentMode_SetField (ptxTransparentMode_t *tmComp, uint8_t state);
 
PTX_API_LIBFUNC ptxStatus_t ptxTransparentMode_Exchange (ptxTransparentMode_t *tmComp,
                                                         ptxTransparentMode_RFParams_t *rfParams,
                                                         uint8_t *tx,
                                                         uint8_t txLength,
                                                         uint8_t *rx,
                                                         uint32_t *rxLength,
                                                         uint32_t timeoutMS);
 
PTX_API_LIBFUNC ptxStatus_t ptxTransparentMode_Deinit (ptxTransparentMode_t *tmComp);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */