ptxNSC_Interface.h

Go to the documentation of this file.

 
#ifndef PTX_NSC_INTERFACE_H_
#define PTX_NSC_INTERFACE_H_
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include "ptxNSC_InternalTypes.h"
#include "ptxHal.h"
#include "ptxBufferPool.h"
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES / INTERNALS
 * ####################################################################################################################
 */
 
#define PTX_NSC_MIN_IO_BUFFER_SIZE          280
 
#define PTX_NSC_RFCONFIG_NAME_CAPACITY      64
 
#define PTX_NSC_IC_SERIAL_NUMBER_LENGTH     10
 
/* polyspace:begin<MISRA-C3:5.7:Not a defect:No action planned> Forward declaration. */
/* polyspace:begin<MISRA-C3:1.3:Not a defect:No action planned> Don't spread other defs via this header. */
struct ptxIoRq;
struct ptxFifoIoRq;
struct ptxHCI;
struct ptxHCE;
struct ptxHal;
struct ptxLog;
struct ptxBufferPool;
struct ptxNSC_HCI;
struct ptxNSC_HCE;
struct ptxBufferPool_Item;
struct ptxNvm;
struct ptxNSC_System;
struct ptxNSC_Custom_Extension;
/* polyspace:end<MISRA-C3:5.7:Not a defect:No action planned> Forward declaration. */
/* polyspace:end<MISRA-C3:1.3:Not a defect:No action planned> Don't spread other defs via this header. */
typedef ptxStatus_t (*pptxTbInt_GetIORQNtf_t)(void *cpLayer, struct ptxIoRq *io_rq);
 
typedef struct ptxNSC* pptxNSC_t; /*Typedef added to avoid compilation issues */
 
typedef struct ptxNSC_InitParam
{
    struct ptxHCI                      *HCI;                                                       
    struct ptxHCE                      *HCE;                                                       
    struct ptxHal                      *HAL;                                                       
    struct ptxOsal                     *OS;                                                        
    struct ptxLog                      *LOG;                                                       
    struct ptxFifoIoRq                 *FIO;                                                       
    struct ptxNvm                      *NVM;                                                       
    void                               *Integration;                                               
    pptxTbInt_GetIORQNtf_t              GetIORQDefault;                                            
    uint32_t                            ComSpeedApp;                                               
    uint8_t                             HwFlowControl;                                             
    uint8_t                             IsNCICommanding;                                           
    size_t                              NscBuffersSize;                                            
    size_t                              NumBuffers;                                                
    uint8_t                             BufPoolDbgLogEn;                                           
} ptxNSC_InitParam_t;
 
typedef struct ptxNSC
{
    ptxStatus_Comps_t                   CompId;                                                    
    struct ptxOsal                     *OS;                                                        
    struct ptxLog                      *LOG;                                                       
    struct ptxFifoIoRq                 *FIO;                                                       
    struct ptxHal                      *HAL;                                                       
    struct ptxNvm                      *NVM;                                                       
    void                               *Integration;                                               
    ptxBufferPool_t                     BP;                                                        
    uint8_t                             IsNCICommanding;                                           
    pptxTbInt_GetIORQNtf_t              GetIORQDefault;                                            
    struct ptxBufferPool_Item          *ActiveResponseBuffer;                                      
    ptxSemaphore_t                      SemIoSync;                                                 
    uint32_t                            RspTimeout;                                                
    ptxSemaphore_t                      SemPauseThreadPause;                                       
    ptxSemaphore_t                      SemPauseThreadConfirm;                                     
    volatile uint8_t                    ExitFlag;                                                  
    volatile uint8_t                    PauseFlag;                                                 
    struct ptxThread                   *RxThread;                                                  
    void                               *NSCData;                                                   
    ptxNSC_GPBuffer_t                   NSCGPBuffer;                                               
    struct ptxNSC_RoutingTable         *RoutingTable;                                              
    struct ptxNSC_HCI                  *NscHci;                                                    
    struct ptxNSC_System               *NscSystem;                                                 
    uint8_t                             ChainingState;                                             
    uint8_t                            *ChainedPayload;                                            
    uint8_t                             RxCltMode;                                                 
    size_t                              ChainedLength;                                             
    uint8_t                             StateUCodeImage;                                           
    ptxNSC_States_t                     State;                                                     
    uint8_t                             IcSerialNumber[PTX_NSC_IC_SERIAL_NUMBER_LENGTH];           
    uint32_t                            NscSpeed;                                                  
    uint8_t                             HwFlowControl;                                             
    uint32_t                            NscRxDelay;                                                
    uint32_t                            PollA_Enable;                                              
    uint32_t                            PollB_Enable;                                              
    uint32_t                            PollF_Enable;                                              
    uint32_t                            DiscoveryIdleTime;                                         
    uint32_t                            ListenA_Enable;                                            
    uint8_t                             ListenA_ATQA[PTX_NSC_TYPES_LISASENSRES_LEN];               
    uint32_t                            ListenA_SAK;                                               
    uint8_t                             ListenA_NFCID1[PTX_NSC_TYPES_LISANFCID1_LEN];              
    uint8_t                             ListenA_ATS[PTX_NSC_TYPES_LISAATS_LEN];                    
    uint32_t                            ListenB_Enable;                                            
    uint8_t                             ListenB_SENSB_RES[PTX_NSC_TYPES_LISBSENSRES_LEN];          
    uint8_t                             ListenB_ATTRIB_RES[PTX_NSC_TYPES_LISBATTRIBRES_LEN];       
    uint8_t                            *NSC_HCI_Data;                                              
    size_t                              NSC_HCI_Data_Len;                                          
    ptxNSC_WfNtfAfterChained_t          WfNtfState;                                                
    char                                RfConfigFileName[PTX_NSC_RFCONFIG_NAME_CAPACITY];          
    ptxNSC_RFMiscConfig_Param_t         RFConfigMiscParams;                                        
    ptxNscRdTriggModes_t                RdTriggMode;                                               
    uint8_t                             GPIO_Cfg[PTX_NSC_GPIO_MAX_GPIOS];                          
    uint8_t                             ProductID;                                                 
    uint32_t                            DeactiveTimeoutMS;                                         
    uint8_t                             TypeATransparentModeActive;                                
    uint8_t                             TransparentModeNrResidualTxBits;                           
#if defined (PTX_FEATURES_HCI_INCLUDED)
    ptxNSC_SWP_Activation_Param_t       Swp_Act_Params;                                            
    ptxNSC_SWP_DeactCmd_t               Swp_Deactivate_VCC;                                        
    ptxNSC_SWP_Interface_t              SwpIntfActive;                                             
    ptxNSC_SWP_Interface_t              SwpIntfTemp;                                               
#endif
 
    ptxNSC_CmdSched_Param_t             CmdSchedule;                                               
    ptxNSC_NtfAfterCommError_t          GenErrorNtf;                                               
    uint8_t                             NrCustomExtensions;                                        
    struct ptxNSC_Custom_Extension      CustomExtension[PTX_NSC_MAX_EXTENSIONS];                   
} ptxNSC_t;
 
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
ptxStatus_t ptxNSC_Init(ptxNSC_t *nscCtx, ptxNSC_InitParam_t *initParam);
 
ptxStatus_t ptxNSC_DeInit(ptxNSC_t *nscCtx);
 
ptxStatus_t ptxNSC_Pause(ptxNSC_t *nscCtx, ptxNSC_Pause_Options pauseMode);
 
ptxStatus_t ptxNSC_HALSetFlowCtrlState(ptxNSC_t *nscCtx, uint8_t enableTRx);
 
ptxStatus_t ptxNSC_HALSetSpeed(ptxNSC_t *nscCtx, uint32_t bdSpeed);
 
ptxStatus_t ptxNSC_SetState(ptxNSC_t *nscCtx, ptxNSC_States_t state);
 
ptxNSC_States_t ptxNSC_GetState(ptxNSC_t *nscCtx);
 
ptxStatus_t ptxNSC_GetMiscRFConfig(ptxNSC_t *nscCtx, uint8_t *configBuffer, size_t *configBufferLen);
 
ptxStatus_t ptxNSC_GetIORQNtf(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl);
/*
 * ####################################################################################################################
 * API FUNCTIONS *************** HARDWARE ACCESS
 * ####################################################################################################################
 */
 
ptxStatus_t ptxNSC_FwDownload(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint8_t *pData, size_t length, uint8_t forceDwnld);
 
ptxStatus_t ptxNSC_Hal_Read_Synchronous (ptxNSC_t *nscCtx, uint8_t *rxBuf, size_t *rxLen);
 
ptxStatus_t ptxNSC_WRA(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint16_t address, uint8_t valueToWrite);
 
ptxStatus_t ptxNSC_WRAMulti(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxTypes_WRA_t *pWRA, size_t WRASize);
 
ptxStatus_t ptxNSC_WCA(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint16_t Address, uint8_t *pData, size_t length);
 
ptxStatus_t ptxNSC_RCA(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint16_t regAddress, size_t length);
 
ptxStatus_t ptxNSC_RRA(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint16_t regAddress);
 
ptxStatus_t ptxNSC_RRA_Multi(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint16_t *addresses, size_t numberOfAddresses );
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS *************** NSC PROTOCOL
 * ####################################################################################################################
 */
 
ptxStatus_t ptxNSC_NscResetCmd(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_ResetCpuEn_t cpuEn );
 
ptxStatus_t ptxNSC_DFY_Activation (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl);
 
ptxStatus_t ptxNSC_DFY_Init ( ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl );
 
ptxStatus_t ptxNSC_InitCmd(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl , ptxNSC_Init_Param_t *initParams);
 
ptxStatus_t ptxNSC_ReadTempSensor(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl);
 
ptxStatus_t ptxNSC_WriteCmd(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_WriteCmd_Par_t nscWritePar);
 
ptxStatus_t ptxNSC_ReadCmd(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_ReadCmd_Par_t nscReadPar);
 
ptxStatus_t ptxNSC_DiscoverCmd(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_Discover_Param_t *discoverParams );
 
ptxStatus_t ptxNSC_NSCRfDeactivateCmd(ptxNSC_t *nscCtx, struct ptxIoRq*ioCpl, ptxNSC_Rf_Deact_Param_t *rfDeactParam);
 
ptxStatus_t ptxNSC_RfActivate(ptxNSC_t* nscCtx, struct ptxIoRq* ioCpl, ptxNSC_RfActiv_Param_t* actParams);
 
ptxStatus_t ptxNSC_RfConfig (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_RfConfig_Param_t *rfConfigParams);
 
ptxStatus_t ptxNSC_RfConfig_NvmLoad ( ptxNSC_t *nscCtx, ptxNSC_RfConfig_Param_t *rfConfParams );
 
ptxStatus_t ptxNSC_NscDataMsg (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint8_t *payload, size_t length, uint8_t isChained);
 
 
ptxStatus_t ptxNSC_NscCltMsg (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint8_t *pldBytes, uint8_t *pldParityBits, size_t length);
 
 
size_t ptxNSC_NscDataMsg_GetMaxPayload (ptxNSC_t *nscCtx);
 
ptxStatus_t ptxNSC_SoftReset(ptxNSC_t *nscCtx, ptxNSC_SoftReset_t setUpNsc);
 
ptxStatus_t ptxNSC_SetUcodeActive (ptxNSC_t *nscCtx);
 
ptxStatus_t ptxNSC_SetUcodeInactive (ptxNSC_t *nscCtx);
 
ptxStatus_t ptxNSC_StandbyCmd(ptxNSC_t *nscCtx, struct ptxIoRq*ioCpl);
 
ptxStatus_t ptxNSC_WakeupCmd(ptxNSC_t *nscCtx, struct ptxIoRq*ioCpl);
 
 
ptxStatus_t ptxNSC_PresCheck_IsoDep_Nack(struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl);
 
 
ptxStatus_t ptxNSC_PresCheck_IsoDep_EmptyBlock(struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl);
 
 
ptxStatus_t ptxNSC_PresCheck_NfcDep_AttentionCmd(struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl);
 
 
ptxStatus_t ptxNSC_T5T_IsolatedEoF(struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl);
 
 
ptxStatus_t ptxNSC_WriteSystemCfg(ptxNSC_t *nscCtx, struct ptxNSC_System *sysCfgParams);
 
ptxStatus_t ptxNSC_ReadSystemCfg(ptxNSC_t *nscCtx, struct ptxNSC_System *sysCfgParams);
 
ptxStatus_t ptxNSC_RfSetParamsCmd(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNsc_RfPar_t *rfPar, size_t rfParLen);
 
ptxStatus_t ptxNSC_RfTestRun(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNsc_RfTest_Id_t rfTestId, uint8_t *rfTestParams, size_t rfTestParamsLen);
 
ptxStatus_t ptxNSC_RfTestStop(ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl);
 
ptxStatus_t ptxNSC_LoadSystemCfg(ptxNSC_t *nscCtx, struct ptxNSC_System *sysCfgParams, uint8_t paramSource);
 
ptxStatus_t ptxNSC_EmvGetDiscParams(struct ptxNSC *nscCtx, struct ptxNSC_Discover_Param *discoverParams);
 
ptxStatus_t ptxNSC_NfcForumGetDiscParams(struct ptxNSC *nscCtx, struct ptxNSC_Discover_Param *discoverParams);
 
ptxStatus_t ptxNSC_GetRevisionInfo(struct ptxNSC *nscCtx, ptxNSC_RevisionType_t revisionType, uint32_t *revisionInfo);
 
ptxStatus_t ptxNSC_SetGPIOMode(struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl, uint8_t gpioNr, ptxNSC_GPIO_Mode_t gpioMode, uint8_t gpioFlags);
 
ptxStatus_t ptxNSC_SetGPIOOutput(struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl, uint8_t gpioNr, uint8_t gpioValue);
 
ptxStatus_t ptxNSC_GetGPIOInput(struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl, uint8_t gpioNr);
 
ptxStatus_t ptxNSC_GetDeactivateTimeout(struct ptxNSC *nscCtx, uint32_t *currentTimeout);
 
ptxStatus_t ptxNSC_SetDeactivateTimeout(struct ptxNSC *nscCtx, uint32_t *currentTimeout);
 
ptxStatus_t ptxNSC_SetNrResidualTxBits(ptxNSC_t *nscCtx, uint8_t transparentModeEnabled, uint8_t nrTxBits);
 
ptxStatus_t ptxNSC_RegisterExtension(ptxNSC_t *nscCtx, ptxNSC_Custom_Extension_t *extension);
 
ptxStatus_t ptxNSC_DeRegisterExtension(ptxNSC_t *nscCtx, uint8_t extensionID);
 
 /* Group */
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */