ptxTbInt.h

Go to the documentation of this file.

 
#ifndef PTXTBINT_H
#define PTXTBINT_H
 
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include "ptxNscFactory.h"
#include "ptxNSC_System.h"
#include "ptxHal_Ext.h"
 
#if (defined PTX_FEATURES_TESTING)
#include "CpMain.h"
#endif
 
#if (defined PTX_FEATURES_NCI_INCLUDED)
#include "ptxNCI_Interface.h"
#endif
 
#if (defined PTX_FEATURES_HCI_INCLUDED)
#include "ptxHci_Interface.h"
#endif
 
#if (defined (PTX_IOT_READER_API) || defined (PTX_POS_READER_API))
    #pragma push_macro("PTX_LIBFUNC")
    #undef PTX_LIBFUNC
    #define PTX_LIBFUNC
#endif
 
#ifdef __cplusplus
    extern "C" {
#endif
 
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES
 * ####################################################################################################################
 */
 
typedef void (*pptxInt_Completion_t) (void *sysCtx, uint8_t *complData, size_t complDataLen, int32_t complStatus);
 
typedef void (*pptxInt_CompletionNTF_t) (void *sysCtx, ptxNSC_Event_t *complData);
 
/*
 * Forward declaration.
 */
struct ptxOsal;
 
typedef struct ptxTbInt
{
    ptxStatus_Comps_t       CompId;             
    /*
     * Comps
     */
    ptxNscFactory_t         F;                  
#if (defined PTX_FEATURES_NCI_INCLUDED)
    ptxNCI_t                NCI;                
    ptxNCI_Command_t        NCI_test;           
#endif
 
#if (defined PTX_FEATURES_HCI_INCLUDED)
    ptxHCI_t                HCI;                
#endif
 
    ptxNSC_t                NSC;                
    ptxHal_t                HAL;                
    struct ptxOsal         *OS;                 
    ptxLog_t                LOG;                
    pptxInt_Completion_t    Completion;         
    pptxInt_CompletionNTF_t Completion_NTF;     
    /*
     * System
     */
    void                   *SysCtx;             
    size_t                  MtU;                
    /*
     * NVM
     */
    ptxNvm_t                NVM;                
    /*
     * Mock
     */
    ptxHal_t                M_HAL;              
    /*
     * Counterpart
     */
#   if (defined PTX_FEATURES_TESTING)
    ptx_CpMain_t            Counterpart;        
#   endif
 
    ptxFileHandle_t         RTLogFileHandle;    
    uint8_t                 RTLogInit;          
    size_t                  RTLogNumLines;      
    uint16_t                RTLogFilesIndex;    
} ptxTbInt_t;
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / SETUP RELATED
 * ####################################################################################################################
 */
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_SetUp(void *compCtx, pptxInt_Completion_t complFn, pptxInt_CompletionNTF_t complFnNtf, void *sysCtx);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_ShutDown(void *compCtx);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / FACTORY RELATED
 * ####################################################################################################################
 */
 
PTX_LIBFUNC const char *ptxTbInt_GetVersionDescription(void);
 
PTX_LIBFUNC ptxTbInt_t *ptxTbInt_Allocate(void);
 
PTX_LIBFUNC void ptxTbInt_Free(ptxTbInt_t *cInst);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_SetParameter(ptxTbInt_t        *cInst,
                                              ptxNscFactory_P_t  parType,
                                              uint8_t           *parBuf,
                                              uint32_t           parLenOrValue);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_BuildStack(ptxTbInt_t *cInst, void *systemContext);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_DestroyStack(ptxTbInt_t *cInst);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_DestroyStack_Finalize(ptxTbInt_t *cInst);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / NSC RELATED
 * ####################################################################################################################
 */
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSCFwDownloader(void *compCtx, uint8_t *pData, int length);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_DragonFlyActivation(void *compCtx);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_Init(void *compCtx, ptxNSC_Init_Param_t *initParams);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfConfig(void *compCtx, ptxNSC_RfConfig_Param_t *rfConfigParams);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfSetParams(void *compCtx, ptxNsc_RfPar_t *rfPar, size_t rfParLen);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfTestRun(void *compCtx, ptxNsc_RfTest_Id_t rfTestId, uint8_t *rfTestParams, size_t rfTestParamsLen);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfTestStop(void *compCtx);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSCGetMode(void *compCtx, uint8_t *mode);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSCGetMiscRFConfig(void *compCtx, uint8_t *configBuffer, size_t *configBufferLen);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_Read(void *compCtx, uint16_t *address, size_t addressLen, ptxNSC_ReadCmd_Type_t typeRd);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_Write(void *compCtx, uint16_t *address, size_t addressLen, uint8_t *value, size_t valueLen, ptxNSC_WriteCmd_Type_t typeWr);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfDiscover(void *compCtx, ptxNSC_Discover_Param_t *discoverParams );
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfDiscover_EmvCo_TRANSAC_A(void *compCtx);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfDiscover_EmvCo_TRANSAC_B(void *compCtx);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_SetField(void *compCtx, uint8_t enabled);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfConfig_NVMLoad (void *compCtx, ptxNSC_RfConfig_Param_t *rfConfigParams);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfConfig_NVMUnLoad (void *compCtx, ptxNSC_RfConfig_Param_t *rfConfigParams);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_DataMsg(void *compCtx, uint8_t *payload, size_t length, uint8_t isChained);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_CltMsg(void *compCtx, uint8_t *pld, uint8_t *pldPar, size_t length);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_PresCheck_IsoDep_Nack(void *compCtx);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_PresCheck_IsoDep_EmptyBlock(void *compCtx);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_PresCheck_NfcDep_AttentionCmd(void *compCtx);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_T5T_IsolatedEoF(void *compCtx);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfActivate (void *compCtx, ptxNSC_RfActiv_Param_t *rfActivParams);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_RfDeactivate(void *compCtx, ptxNSC_Rf_Deact_Param_t *rfDeactParam);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_Standby(void *compCtx, uint8_t powerMode);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NscSoftReset(void *compCtx);
 
PTX_LIBFUNC size_t ptxTbInt_GetMtU(void *cInst);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_SetMtU(ptxTbInt_t *cInst, size_t MaxTransferUnit);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_SetEMVParams(void *compCtx, ptxNSC_Discover_Param_t *discoverParams );
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_SetNFCForumParams(void *compCtx, ptxNSC_Discover_Param_t *discoverParams );
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_GetRevisionInfo(void *compCtx, ptxNSC_RevisionType_t revisionType, uint32_t *revisionInfo);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_WriteSystemConfig(void *compCtx, ptxNSC_System_t *sysConfigParams);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_ReadSystemConfig(void *compCtx, ptxNSC_System_t *sysConfigParams);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_ReadTempSensor(void *compCtx);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_NSC_LoadSystemConfig(void *compCtx, ptxNSC_System_t *sysConfigParams, ptxNSC_System_LoadParams_t loadType);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_GPIO_Config(void *compCtx, uint8_t gpioNr, uint8_t gpioMode, uint8_t gpioFlags);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_GPIO_Write(void *compCtx, uint8_t gpioNr, uint8_t gpioValue);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_GPIO_Read(void *compCtx, uint8_t gpioNr);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_GetDeactivateTimeout(void *compCtx, uint32_t *currentTimeout);
 
PTX_LIBFUNC ptxStatus_t ptxTbInt_SetDeactivateTimeout(void *compCtx, uint32_t *currentTimeout);
 
/*
 * ####################################################################################################################
 * INTERNAL FUNCTIONS
 * ####################################################################################################################
 */
 
ptxStatus_t ptxTbInt_BuildStackCommon(ptxTbInt_t *cInst, void *systemContext, ptxLog_t *log);
 /* Group */
 
ptxStatus_t ptxTbInt_GetIORQNtf(void *cpLayer, ptxIoRq_t *io_rq);
 
#if (defined PTX_FEATURES_NCI_INCLUDED)
ptxStatus_t ptxTbInt_GetIORQNCINtf(void *cpLayer, ptxIoRq_t *io_rq);
#endif
 
void ptxTbInt_ReturnIoRqItem(ptxTbInt_t *cInst, ptxIoRq_t *ioCpl, ptxStatus_t reqStatus);
 
void ptxTbInt_GetIORQNtfCompletion(ptxIoRq_t *ioCpl, void *cplLayer, void *data, size_t dataLength, ptxStatus_t cplStatus);
 
void ptxTbInt_NSCCompletion(ptxIoRq_t *ioCpl, void *cplLayer, void *data, size_t dataLength, ptxStatus_t cplStatus);
 
 
#ifdef __cplusplus
} /* extern C */
#endif
 
#if (defined (PTX_IOT_READER_API) || defined (PTX_POS_READER_API))
    #pragma pop_macro("PTX_LIBFUNC")
#endif
 
#endif /* Guard */