ptxFeliCa_DTE.h

Go to the documentation of this file.

 
#ifndef APIS_PTX_FELICA_DTE_H_
#define APIS_PTX_FELICA_DTE_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
 * ####################################################################################################################
 */
 
typedef enum ptxFeliCa_DTE_BitRate
{
    FELICA_DTE_BITRATE_212 = 1,                             
    FELICA_DTE_BITRATE_424 = 2,                             
} ptxFeliCa_DTE_BitRate_t;
 
typedef enum ptxFeliCa_DTE_TestID
{
    FELICA_DTE_TestID_PerformanceTest,                      
    FELICA_DTE_TestID_RWDigProtTest,                        
} ptxFeliCa_DTE_TestID_t;
 
typedef enum ptxFeliCa_DTE_RWDigProt_TestID
{
    FELICA_DTE_SubTestID_RWDigProt_eMoney_Variant1,            
    FELICA_DTE_SubTestID_RWDigProt_eMoney_Variant2,            
    FELICA_DTE_SubTestID_RWDigProt_eMoney_NFCDEP,              
    FELICA_DTE_SubTestID_RWDigProt_FrameStructure,             
    FELICA_DTE_SubTestID_RWDigProt_FrameStructure1,            
    FELICA_DTE_SubTestID_RWDigProt_FrameStructure2,            
    FELICA_DTE_SubTestID_RWDigProt_FrameStructure3,            
    FELICA_DTE_SubTestID_RWDigProt_FrameStructure4,            
    FELICA_DTE_SubTestID_RWDigProt_FrameStructure5,            
    FELICA_DTE_SubTestID_RWDigProt_FrameStructure6,            
    FELICA_DTE_SubTestID_RWDigProt_Setup_DP_POS,               
    FELICA_DTE_SubTestID_RWDigProt_Setup_DP_NEG,               
    FELICA_DTE_SubTestID_RWDigProt_Generic,                    
} ptxFeliCa_DTE_RWDigProt_TestID_t;
 
typedef struct ptxFeliCa_DTE_PerformanceTest
{
    uint8_t                             NrTests;            
    uint8_t                             *ResultBuffer;      
    uint8_t                             ResultBufferSize;   
    ptxFeliCa_DTE_BitRate_t             Bitrate;            
    uint32_t                            TimeOutMS;          
} ptxFeliCa_DTE_PerformanceTest_t;
 
typedef struct ptxFeliCa_DTE_RWDigProtTest
{
    ptxFeliCa_DTE_RWDigProt_TestID_t    SubTestID;           
    const uint32_t                      *T_OffGuardTime;     
    const uint32_t                      *T_OnGuardTime;      
    uint8_t                             *GenericCmdBuffer;   
    uint32_t                            GenericCmdBufferLen; 
    uint32_t                            TimeOutMS;           
    uint8_t                             *ResultBuffer;       
    uint32_t                            ResultBufferSize;    
} ptxFeliCa_DTE_RWDigProtTest_t;
 
typedef union ptxFeliCa_DTE_Params
{
    ptxFeliCa_DTE_PerformanceTest_t     PerformanceTest;    
    ptxFeliCa_DTE_RWDigProtTest_t       RWDigProtTest;      
} ptxFeliCa_DTE_Params_t;
 
typedef struct ptxFeliCa_DTE_TestProgressParams
{
    uint8_t                             ExitProcessing;     
    uint8_t                             NrTestsProcessed;   
} ptxFeliCa_DTE_TestProgressParams_t;
 
typedef void (*ptxFeliCa_DTE_ProgressFn_t)(ptxFeliCa_DTE_TestProgressParams_t *progressParams);
 
typedef struct ptxFeliCa_DTE_TestParams
{
    ptxFeliCa_DTE_TestID_t              ID;                 
    ptxFeliCa_DTE_Params_t              Params;             
    ptxFeliCa_DTE_ProgressFn_t          ProgressCB;         
} ptxFeliCa_DTE_TestParams_t;
 
typedef struct ptxFeliCa_DTE_InitParams
{
    void                                *StackComp;         
} ptxFeliCa_DTE_InitParams_t;
 
typedef struct ptxFeliCa_DTE
{
    /* Components */
    ptxStatus_Comps_t                   CompId;             
    struct ptxOsal                      *OS;                
    ptxLog_t                            *LOG;               
    void                                *StackComp;         
    ptxSemaphore_t                      *Sem_Completion;    
    uint16_t                            *CompletionStatus;  
    uint8_t                             *DataShared;        
} ptxFeliCa_DTE_t;
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
PTX_API_LIBFUNC ptxStatus_t ptxFeliCa_DTE_Init (ptxFeliCa_DTE_t *feliCaDTEComp, ptxFeliCa_DTE_InitParams_t *initParams);
 
PTX_API_LIBFUNC ptxStatus_t ptxFeliCa_DTE_Deinit (ptxFeliCa_DTE_t *feliCaDTEComp);
 
PTX_API_LIBFUNC ptxStatus_t ptxFeliCa_DTE_EnableMode (ptxFeliCa_DTE_t *feliCaDTEComp, uint8_t enableMode, ptxFeliCa_DTE_TestParams_t *testParams);
 
PTX_API_LIBFUNC ptxStatus_t ptxFeliCa_DTE_RunTest(ptxFeliCa_DTE_t *feliCaDTEComp, ptxFeliCa_DTE_TestParams_t *testParams);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */