NSC Interface Structures

Collaboration diagram for NSC Interface Structures:

Topics
	NSC Interface Functions

Data Structures
struct	ptxNSC_InitParam
struct	ptxNSC
struct	ptxNSC_Event
	NSC Event data. Used to notify layer above, what kind of event had happened on the NSC Component. More...
struct	ptxTypes_WRA
	WRA data type. More...
struct	ptxNSC_Init_Param
	NSC Init CMD parameter structure. More...
struct	ptxNSC_WriteCmd_Par
	NSC Write CMD parameter structure. More...
struct	ptxNSC_ReadCmd_Par
	NSC Read CMD parameter structure. More...
struct	ptxNSC_RfConfig_Regs
	NSC Rf Config Registers Structures. More...
struct	ptxNSC_RfConfig_Param
	NSC Rf Config Parameters. More...
struct	ptxNSC_RfActTech_A_Param
	NSC Rf Tech A Activation Parameters. More...
struct	ptxNSC_RfActTech_B_Param
	NSC Rf Tech B Activation Parameters. More...
struct	ptxNSC_RfActTech_F_Param
	NSC Rf Tech F Activation Parameters. More...
struct	ptxNSC_RfActTech_V_Param
	NSC Rf Tech V Activation Parameters. More...
union	ptxNSC_RfActTech_Param
	NSC Rf Tech Activation Parameters. More...
union	ptxNSC_RfActProt_ISODEP_Param
	NSC Rf Prot ISO-DEP (Type-A) Activation Parameters. More...
union	ptxNSC_RfActProt_Param_t
	NSC Rf Prot Activation Parameters. More...
struct	ptxNSC_RfActiv_Param
	NSC Rf Activate structure. More...
struct	ptxNSC_Discover_Param
	NSC Discover parameter structure. More...
struct	ptxNSC_Rf_Deact_Param
	NSC RF Deactivate Parameters. More...
struct	ptxNsc_RfPar_RfTech
	NSC Rf Parameter Rf Tech. More...
struct	ptxNsc_RfPar_Fwt
	NSC Rf Parameter Fwt. More...
struct	ptxNsc_RfPar_TxBitRate
	NSC Rf Parameter Tx_Bit_Rate. More...
struct	ptxNsc_RfPar_RxBitRate
	NSC Rf Parameter Rx_Bit_Rate. More...
struct	ptxNsc_RfPar_TxParity
	NSC Rf Parameter Tx_Parity. More...
struct	ptxNsc_RfPar_RxParity
	NSC Rf Parameter Rx_Parity. More...
struct	ptxNsc_RfPar_TxCRC
	NSC Rf Parameter Tx_CRC. More...
struct	ptxNsc_RfPar_RxCRC
	NSC Rf Parameter Rx_CRC. More...
struct	ptxNsc_RfPar_ResLimit
	NSC Rf Parameter Res(ponse)_Limit. More...
struct	ptxNsc_RfPar_TxResidualBits
	NSC Rf Parameter Tx_Residual_Bits. More...
struct	ptxNsc_RfPar_RfField
	NSC Rf Parameter Rf_Field. More...
union	ptxNsc_RfPar_Params
	Union Rf Parameters. More...
struct	ptxNsc_RfPar
	Rf Param. More...
struct	ptxNSC_RfSetParams_Par
	NSC Rf Set Parameters CMD parameter structure. More...
struct	ptxNSC_RfTestParams_Par
	NSC Rf Test CMD parameter structure. More...
struct	ptxNSC_Custom_Extension
struct	ptxNSC_FwImage
	Main NSC Fw Image structure. More...
struct	ptxNSC_WRA
	Main NSC WRA structure. More...
struct	ptxNSC_WRAMulti
	Main NSC WRA Multi structure. More...
struct	ptxNSC_RRA
	Main NSC RRA structure. More...
struct	ptxNSC_RRAMulti
	Main NSC RRA Multi structure. More...
struct	ptxNSC_WCA
	Main NSC WCA structure. More...
struct	ptxNSC_WriteBuffer
	Main NSC Write Buffer. More...
struct	ptxNSC_RCA
	Main NSC RCA structure. More...
struct	ptxNSC_GPBuffer
	NSC General purpose buffer. Used to share already allocated data between threads. More...
struct	ptxNSC_ResetCmd
	NSC data type to shared between threads for NSC Reset Command. More...
struct	ptxNSC_RfDiscoverCmd
	NSC data type to shared between threads for NSC Rf Discover Command. More...
struct	ptxNSC_RfActivateCmd
	NSC data type to share between threads for NSC Rf Activate Command. More...
struct	ptxNSC_InitCmd
	NSC data type to shared between threads for NSC Initialization Command. More...
struct	ptxNSC_RfConfigCmd
	NSC data type to be shared between threads for NSC Rf Command. More...
struct	ptxNSC_CltMsg
	NSC CLT Message. More...
struct	ptxNSC_RFMiscConfig_Param
	NSC Misc. Rf Config Parameters. More...
union	ptxNSC_Data
	Compound of all possible data types for different scenarios at NSC Component. More...

Macros
#define	PTX_NSC_MIN_IO_BUFFER_SIZE   280
#define	PTX_NSC_RFCONFIG_NAME_CAPACITY   64
#define	PTX_NSC_IC_SERIAL_NUMBER_LENGTH   10

Typedefs
typedef ptxStatus_t(*	pptxTbInt_GetIORQNtf_t) (void *cpLayer, struct ptxIoRq *io_rq)
	Integration get IO RQ Ntf.
typedef struct ptxNSC *	pptxNSC_t
typedef struct ptxNSC_InitParam	ptxNSC_InitParam_t
typedef struct ptxNSC	ptxNSC_t
typedef enum ptxNSC_EventId	ptxNSC_EventId_t
	NSC Event Id. Type of event notifying layer above.
typedef struct ptxNSC_Event	ptxNSC_Event_t
	NSC Event data. Used to notify layer above, what kind of event had happened on the NSC Component.
typedef enum ptxNSC_Pause_Options	ptxNSC_Pause_Options
	NSC Pause Options. .
typedef struct ptxTypes_WRA	ptxTypes_WRA_t
	WRA data type.
typedef enum ptxNscWriteBufferId	ptxNscWriteBufferId_t
	ID of potential buffers handled by Hardware.
typedef enum ptxNSC_ConRfTech	ptxNSC_ConRfTech_t
	Type of Rf Tech.
typedef enum ptxNSC_ConRfProtocol	ptxNSC_ConRfProtocol_t
	Type of Rf Protocol.
typedef enum ptxNSC_SoftReset	ptxNSC_SoftReset_t
	Types of Soft-Reset.
typedef enum ptxNSC_ResetCpuEn	ptxNSC_ResetCpuEn_t
	Types of Enable cpu in NSC Reset CMD.
typedef enum ptxNSC_Init_clk_src	ptxNSC_Init_clk_src_t
	Types of Source Clock on NSC Init CMD.
typedef struct ptxNSC_Init_Param	ptxNSC_Init_Param_t
	NSC Init CMD parameter structure.
typedef enum ptxNSC_WriteCmd_Type	ptxNSC_WriteCmd_Type_t
	Types of NSC Write CMD.
typedef struct ptxNSC_WriteCmd_Par	ptxNSC_WriteCmd_Par_t
	NSC Write CMD parameter structure.
typedef enum ptxNSC_ReadCmd_Type	ptxNSC_ReadCmd_Type_t
	Types of NSC Read CMD.
typedef struct ptxNSC_ReadCmd_Par	ptxNSC_ReadCmd_Par_t
	NSC Read CMD parameter structure.
typedef enum ptxNSC_GPIO_Mode	ptxNSC_GPIO_Mode_t
	NSC Read CMD parameter structure.
typedef struct ptxNSC_RfConfig_Regs	ptxNSC_RfConfig_Regs_t
	NSC Rf Config Registers Structures.
typedef struct ptxNSC_RfConfig_Param	ptxNSC_RfConfig_Param_t
	NSC Rf Config Parameters.
typedef struct ptxNSC_RfActTech_A_Param	ptxNSC_RfActTech_A_Param_t
	NSC Rf Tech A Activation Parameters.
typedef struct ptxNSC_RfActTech_B_Param	ptxNSC_RfActTech_B_Param_t
	NSC Rf Tech B Activation Parameters.
typedef struct ptxNSC_RfActTech_F_Param	ptxNSC_RfActTech_F_Param_t
	NSC Rf Tech F Activation Parameters.
typedef struct ptxNSC_RfActTech_V_Param	ptxNSC_RfActTech_V_Param_t
	NSC Rf Tech V Activation Parameters.
typedef union ptxNSC_RfActTech_Param	ptxNSC_RfActTech_Param_t
	NSC Rf Tech Activation Parameters.
typedef union ptxNSC_RfActProt_ISODEP_Param	ptxNSC_RfActProt_ISODEP_Param_t
	NSC Rf Prot ISO-DEP (Type-A) Activation Parameters.
typedef union ptxNSC_RfActProt_Param_t	ptxNSC_RfActProt_Param_t
	NSC Rf Prot Activation Parameters.
typedef struct ptxNSC_RfActiv_Param	ptxNSC_RfActiv_Param_t
	NSC Rf Activate structure.
typedef enum ptxNSC_PollType	ptxNSC_PollType_t
	Enum for Polling-Loop type.
typedef enum ptxNSC_InitTechPoll	ptxNSC_InitTechPoll_t
	Enum for initial technology in the discovery loop.
typedef struct ptxNSC_Discover_Param	ptxNSC_Discover_Param_t
	NSC Discover parameter structure.
typedef enum ptxNsc_RfDiscovery_Mode	ptxNsc_RfDiscovery_Mode_t
	NSC Rf Discovery mode.
typedef enum ptxNSC_Rf_Deact_Type	ptxNSC_Rf_Deact_Type_t
	NSC Rf Deactivate procedure type.
typedef enum ptxNSC_Rf_Deact_State	ptxNSC_Rf_Deact_State_t
	NSC RF state-machine state after command execution.
typedef struct ptxNSC_Rf_Deact_Param	ptxNSC_Rf_Deact_Param_t
	NSC RF Deactivate Parameters.
typedef enum ptxNSC_RevisionType	ptxNSC_RevisionType_t
	NSC Revision-Info Types.
typedef enum ptxNsc_RfParameter_Id	ptxNsc_RfParameter_Id_t
	NSC Rf Parameter Id.
typedef enum ptxNsc_RfTest_Id	ptxNsc_RfTest_Id_t
	Test-IDs for RF-Test command.
typedef struct ptxNsc_RfPar_RfTech	ptxNsc_RfPar_RfTech_t
	NSC Rf Parameter Rf Tech.
typedef struct ptxNsc_RfPar_Fwt	ptxNsc_RfPar_Fwt_t
	NSC Rf Parameter Fwt.
typedef struct ptxNsc_RfPar_TxBitRate	ptxNsc_RfPar_TxBitRate_t
	NSC Rf Parameter Tx_Bit_Rate.
typedef struct ptxNsc_RfPar_RxBitRate	ptxNsc_RfPar_RxBitRate_t
	NSC Rf Parameter Rx_Bit_Rate.
typedef struct ptxNsc_RfPar_TxParity	ptxNsc_RfPar_TxParity_t
	NSC Rf Parameter Tx_Parity.
typedef struct ptxNsc_RfPar_RxParity	ptxNsc_RfPar_RxParity_t
	NSC Rf Parameter Rx_Parity.
typedef struct ptxNsc_RfPar_TxCRC	ptxNsc_RfPar_TxCRC_t
	NSC Rf Parameter Tx_CRC.
typedef struct ptxNsc_RfPar_RxCRC	ptxNsc_RfPar_RxCRC_t
	NSC Rf Parameter Rx_CRC.
typedef struct ptxNsc_RfPar_ResLimit	ptxNsc_RfPar_ResLimit_t
	NSC Rf Parameter Res(ponse)_Limit.
typedef struct ptxNsc_RfPar_TxResidualBits	ptxNsc_RfPar_TxResidualBits_t
	NSC Rf Parameter Tx_Residual_Bits.
typedef struct ptxNsc_RfPar_RfField	ptxNsc_RfPar_RfField_t
	NSC Rf Parameter Rf_Field.
typedef union ptxNsc_RfPar_Params	ptxNsc_RfPar_Params_t
	Union Rf Parameters.
typedef struct ptxNsc_RfPar	ptxNsc_RfPar_t
	Rf Param.
typedef struct ptxNSC_RfSetParams_Par	ptxNSC_RfSetParams_Par_t
	NSC Rf Set Parameters CMD parameter structure.
typedef struct ptxNSC_RfTestParams_Par	ptxNSC_RfTestParams_Par_t
	NSC Rf Test CMD parameter structure.
typedef enum ptxNSC_WfNtfAfterChained	ptxNSC_WfNtfAfterChained_t
typedef enum ptxNSC_NtfAfterCommError	ptxNSC_NtfAfterCommError_t
typedef enum ptxNSC_States	ptxNSC_States_t
typedef ptxStatus_t(*	pExtNSCDiscoverCmd_t) (void *extCtx, uint8_t *cmdBuffer)
typedef ptxStatus_t(*	pExtNSCDiscoverNtf_t) (void *extCtx, void *nscCtx, uint8_t *payload, size_t lengthOfPayload, ptxNSC_Event_t *event)
typedef ptxStatus_t(*	pExtNSCActivateNtf_t) (void *extCtx, void *nscCtx, uint8_t *payload, size_t lengthOfPayload, ptxNSC_Event_t *event)
typedef struct ptxNSC_Custom_Extension	ptxNSC_Custom_Extension_t
typedef enum ptxNsc_ErrorCodes	ptxNsc_ErrorCodes_t
	NSC error codes.
typedef enum ptxNscRdTriggModes	ptxNscRdTriggModes_t
	NSC Modes in Reader Mode (How has triggered the Reader Operation ? Either Application (e.g. NCI or Java) or HCI Component.)
typedef enum ptxNSC_CmdSched_Param	ptxNSC_CmdSched_Param_t
	NSC command execution schedule control flag.
typedef struct ptxNSC_FwImage	ptxNSC_FwImage_t
	Main NSC Fw Image structure.
typedef struct ptxNSC_WRA	ptxNSC_WRA_t
	Main NSC WRA structure.
typedef struct ptxNSC_WRAMulti	ptxNSC_WRAMulti_t
	Main NSC WRA Multi structure.
typedef struct ptxNSC_RRA	ptxNSC_RRA_t
	Main NSC RRA structure.
typedef struct ptxNSC_RRAMulti	ptxNSC_RRAMulti_t
	Main NSC RRA Multi structure.
typedef struct ptxNSC_WCA	ptxNSC_WCA_t
	Main NSC WCA structure.
typedef struct ptxNSC_WriteBuffer	ptxNSC_WriteBuffer_t
	Main NSC Write Buffer.
typedef struct ptxNSC_RCA	ptxNSC_RCA_t
	Main NSC RCA structure.
typedef struct ptxNSC_GPBuffer	ptxNSC_GPBuffer_t
	NSC General purpose buffer. Used to share already allocated data between threads.
typedef struct ptxNSC_ResetCmd	ptxNSC_ResetCmd_t
	NSC data type to shared between threads for NSC Reset Command.
typedef struct ptxNSC_RfDiscoverCmd	ptxNSC_RfDiscoverCmd_t
	NSC data type to shared between threads for NSC Rf Discover Command.
typedef struct ptxNSC_RfActivateCmd	ptxNSC_RfActivateCmd_t
	NSC data type to share between threads for NSC Rf Activate Command.
typedef struct ptxNSC_InitCmd	ptxNSC_InitCmd_t
	NSC data type to shared between threads for NSC Initialization Command.
typedef struct ptxNSC_RfConfigCmd	ptxNSC_RfConfigCmd_t
	NSC data type to be shared between threads for NSC Rf Command.
typedef struct ptxNSC_CltMsg	ptxNSC_CltMsg_t
	NSC CLT Message.
typedef struct ptxNSC_RFMiscConfig_Param	ptxNSC_RFMiscConfig_Param_t
	NSC Misc. Rf Config Parameters.
typedef union ptxNSC_Data	ptxNSC_Data_t
	Compound of all possible data types for different scenarios at NSC Component.

Enumerations
enum	ptxNSC_EventId {   NSC_EventFieldOn , NSC_EventFieldOff , NSC_EventRfAct_PassPoll_A , NSC_EventRfAct_PassPoll_B ,   NSC_EventRfAct_PassPoll_F , NSC_EventRfAct_PassPoll_V , NSC_EventRfAct_ActivePoll , NSC_EventRfAct_Extension ,   NSC_EventRfAct_PasLis_A , NSC_EventRfAct_PasLis_B , NSC_EventRfAct_PasLis_F , NSC_EventRfAct_PasLis_V ,   NSC_EventRfAct_ActiveListen , NSC_EventRfDisc_PassPoll_A , NSC_EventRfDisc_PassPoll_B , NSC_EventRfDisc_PassPoll_F ,   NSC_EventRfDisc_PassPoll_V , NSC_EventRfDisc_ActivePoll , NSC_EventRfDisc_Extension , NSC_EventRfDisc_LastOne ,   NSC_EventError , NSC_EventData_Msg , NSC_EventData_Msg_Chained , NSC_EventData_Clt ,   NSC_EventRfDeact , HCI_EventData_Msg , HCI_Network_Init , HCI_Network_Done ,   HCI_PipeCeA_Open , HCI_PipeCeB_Open , HCI_PipeCeF_Open , HCI_ReaderA_Req ,   HCI_ReaderB_Req , HCI_ReaderStop , HCI_SwpDeact , NSC_Debug ,   NSC_EventRfLPCD , NumOfEventsNCI , NoEvent , Nsc_HciIn_Msg ,   Nsc_HciOut_Msg , UnknownEvent }
	NSC Event Id. Type of event notifying layer above. More...
enum	ptxNSC_Pause_Options { ptxNSC_Thread_ResumeByApp , ptxNSC_Thread_ResumeByStack , ptxNSC_Thread_PauseByApp , ptxNSC_Thread_PauseByStack }
	NSC Pause Options. . More...
enum	ptxNscWriteBufferId {   NscWriteBuffer_0 , NscWriteBuffer_1 , NscWriteBuffer_2 , NscWriteBuffer_3 ,   NscWriteBuffer_4 , NscWriteBuffer_5 , NscWriteBuffer_6 , NscWriteBuffer_7 ,   NscWriteBuffer_8 , NscWriteBuffer_9 , NscWriteBuffer_10 , NscWriteBuffer_11 ,   NscWriteBuffer_12 , NscWriteBuffer_13 , NscWriteBuffer_14 , NscWriteBuffer_15 }
	ID of potential buffers handled by Hardware.
enum	ptxNSC_ConRfTech {   Passive_Poll_A = PTX_NSC_TYPES_TECH_POLL_A , Passive_Poll_B = PTX_NSC_TYPES_TECH_POLL_B , Passive_Poll_F = PTX_NSC_TYPES_TECH_POLL_F , Active_Pol = PTX_NSC_TYPES_TECH_POLL_ACT ,   Passive_Poll_V = PTX_NSC_TYPES_TECH_POLL_V , Passive_Listen_A = PTX_NSC_TYPES_TECH_LISTEN_A , Passive_Listen_B = PTX_NSC_TYPES_TECH_LISTEN_B , Passive_Listen_F = PTX_NSC_TYPES_TECH_LISTEN_F ,   Active_Listen = PTX_NSC_TYPES_TECH_LISTEN_ACT , Noone_RfTech }
	Type of Rf Tech. More...
enum	ptxNSC_ConRfProtocol {   Undefined = PTX_NSC_TYPES_PROT_UNDEFINED , T2T = PTX_NSC_TYPES_PROT_T2T , T3T = PTX_NSC_TYPES_PROT_T3T , IsoDep = PTX_NSC_TYPES_PROT_ISODEP ,   NfcDep = PTX_NSC_TYPES_PROT_NFCDEP , T5T = PTX_NSC_TYPES_PROT_T5T , Ndef = PTX_NSC_TYPES_PROT_NDEF }
	Type of Rf Protocol. More...
enum	ptxNSC_SoftReset { ptxNSC_SoftRst , ptxNSC_SoftRstAndRstStack }
	Types of Soft-Reset. More...
enum	ptxNSC_ResetCpuEn { ptxNSC_ResetCpuDisabled , ptxNSC_ResetCpuEnabled }
	Types of Enable cpu in NSC Reset CMD. More...
enum	ptxNSC_Init_clk_src { ptxNSC_InitClockCrystal , ptxNSC_InitClockHost }
	Types of Source Clock on NSC Init CMD. More...
enum	ptxNSC_WriteCmd_Type { WriteRandomAdd = 1u }
	Types of NSC Write CMD. More...
enum	ptxNSC_ReadCmd_Type { ReadRandomAdd = 1u }
	Types of NSC Read CMD. More...
enum	ptxNSC_GPIO_Mode { GPIO_Mode_Input , GPIO_Mode_Output , GPIO_Mode_Special }
	NSC Read CMD parameter structure. More...
enum	ptxNSC_PollType {   PollModeDisabled , ConstantField , NfcForumMode , EmvPollMode ,   EmvPollMode_TransacA , EmvPollMode_TransacB , IsoPollMode }
	Enum for Polling-Loop type. More...
enum	ptxNSC_InitTechPoll {   Init_Poll_ACM , Init_Poll_A , Init_Poll_B , Init_Poll_F ,   Init_Poll_V }
	Enum for initial technology in the discovery loop. More...
enum	ptxNsc_RfDiscovery_Mode { DiscoveryMode_Regular = 0x00u , DiscoveryMode_Lpcd = 0x01u , DiscoveryMode_Hybrid_Start = 0x02u , DiscoveryMode_Hybrid_End = 0xFFu }
	NSC Rf Discovery mode. More...
enum	ptxNSC_Rf_Deact_Type { DeactType_Generic = 0x01 , DeactType_Protocol_Specific = 0x02 }
	NSC Rf Deactivate procedure type. More...
enum	ptxNSC_Rf_Deact_State { RfIdle = 0x01 , RfDiscovery = 0x02 , RfPollSleep = 0x03 , RfDiscoverNoFieldOff = 0x05 }
	NSC RF state-machine state after command execution. More...
enum	ptxNSC_RevisionType {   ptxNSC_Info_C_Stack , ptxNSC_Info_Local_Changes , ptxNSC_Info_DFY_Code , ptxNSC_Info_DFY_Toolchain ,   ptxNSC_Info_Default , ptxNSC_Info_ProductID }
	NSC Revision-Info Types.
enum	ptxNsc_RfParameter_Id {   RfParameter_EoC , RfParameter_Rf_Tech , RfParameter_Fwt , RfParameter_Tx_Bit_Rate ,   RfParameter_Rx_Bit_Rate , RfParameter_Tx_PAR , RfParameter_Rx_PAR , RfParameter_Tx_CRC ,   RfParameter_Rx_CRC , RfParameter_Res_Limit , RfParameter_Tx_Residual_Bits , RfParameter_Rf_Field }
	NSC Rf Parameter Id. More...
enum	ptxNsc_RfTest_Id {   RfTest_TRANSAC_A = 1 , RfTest_TRANSAC_B = 2 , RfTest_Carrier = 3 , RfTest_PRBS_9 = 4 ,   RfTest_PRBS_15 = 5 }
	Test-IDs for RF-Test command. More...
enum	ptxNSC_WfNtfAfterChained { ptxNSC_WfNtf_NotExpected , ptxNSC_WfNtf_Expected , ptxNSC_WfNtf_Received }
enum	ptxNSC_NtfAfterCommError { ptxNSC_ErrNtf_NotGenerated , ptxNSC_ErrNtf_Generated }
enum	ptxNSC_States { ptxNSC_HwMode , ptxNSC_SystemMode , ptxNSC_ModeUndefined }
enum	ptxNsc_ErrorCodes {   ptxNsc_Sucessful = (0x00u) , ptxNsc_UnknownError = (0x01u) , ptxNsc_NotAllowedCmd = (0x02u) , ptxNsc_UnknownCmdError = (0x03u) ,   ptxNsc_InvalidParameter = (0x04u) , ptxNsc_RouteNotFound = (0x05u) , ptxNsc_PAThermalError = (0x06u) , ptxNsc_PAOvercurrentError = (0x07u) ,   ptxNsc_DeviceInStandby = (0x08u) , ptxNsc_PAOvercurrentLimiter = (0x09u) , ptxNsc_RfCollisionError = (0x11u) , ptxNsc_RfTimeoutError = (0x12u) ,   ptxNsc_RfTransmissionError = (0x13u) , ptxNsc_RfProtocolError = (0x14u) , ptxNsc_RfPollModeNotSupported = (0x15u) , ptxNsc_RfListenModeNotSupported = (0x16u) ,   ptxNsc_SwpUiccNotPresent = (0x21u) , ptxNsc_SwpInterfaceError = (0x22u) , ptxNsc_SwpIdentityCheckFailed = (0x23u) , ptxNsc_SwpModeNotSupported = (0x24u) ,   ptxNsc_CommInterfaceError = (0xFEu) }
	NSC error codes. More...
enum	ptxNscRdTriggModes { RdTriggByApp , RdTriggByHci }
	NSC Modes in Reader Mode (How has triggered the Reader Operation ? Either Application (e.g. NCI or Java) or HCI Component.)
enum	ptxNSC_CmdSched_Param { ptxNSC_CmdSched_Post , ptxNSC_CmdSched_Immediate }
	NSC command execution schedule control flag. More...

Functions
ptxStatus_t	ptxNSC_FwDownload (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint8_t *pData, size_t length, uint8_t forceDwnld)
	NSC FW Download.
ptxStatus_t	ptxNSC_Hal_Read_Synchronous (ptxNSC_t *nscCtx, uint8_t *rxBuf, size_t *rxLen)
	Read upcoming data from the chip.
ptxStatus_t	ptxNSC_WRA (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint16_t address, uint8_t valueToWrite)
	NSC WRA.
ptxStatus_t	ptxNSC_WRAMulti (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxTypes_WRA_t *pWRA, size_t WRASize)
	NSC WRA Multiple values.
ptxStatus_t	ptxNSC_WCA (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint16_t Address, uint8_t *pData, size_t length)
	NSC WCA.
ptxStatus_t	ptxNSC_RCA (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint16_t regAddress, size_t length)
	NSC read continuous Address.
ptxStatus_t	ptxNSC_RRA (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint16_t regAddress)
	NSC Read Random Address (just read one byte)
ptxStatus_t	ptxNSC_RRA_Multi (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint16_t *addresses, size_t numberOfAddresses)
	NSC Read Random Address Multiple addresses to read from.
ptxStatus_t	ptxNSC_NscResetCmd (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_ResetCpuEn_t cpuEn)
	Function for NSC_RESET_CMD.
ptxStatus_t	ptxNSC_DFY_Activation (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl)
	Function for DFY Activation. (Performed as synchronous operation).
ptxStatus_t	ptxNSC_DFY_Init (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl)
	Function for filling NSC_INIT_CMD.
ptxStatus_t	ptxNSC_InitCmd (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_Init_Param_t *initParams)
	Function for NSC_INIT_CMD.
ptxStatus_t	ptxNSC_ReadTempSensor (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl)
	Function for internal temperature sensor readout.
ptxStatus_t	ptxNSC_WriteCmd (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_WriteCmd_Par_t nscWritePar)
	Function used to build and send NSC_WRITE_CMD.
ptxStatus_t	ptxNSC_ReadCmd (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_ReadCmd_Par_t nscReadPar)
	Function used to build and send NSC_READ_CMD.
ptxStatus_t	ptxNSC_DiscoverCmd (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_Discover_Param_t *discoverParams)
	Function for NSC_RF_DISCOVER_CMD.
ptxStatus_t	ptxNSC_NSCRfDeactivateCmd (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_Rf_Deact_Param_t *rfDeactParam)
	Function for NSC_RF_DEACTIVATE_CMD.
ptxStatus_t	ptxNSC_RfActivate (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_RfActiv_Param_t *actParams)
	Function used to select card to activate when chip is Reader and there are more than one card on the field.
ptxStatus_t	ptxNSC_RfConfig (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNSC_RfConfig_Param_t *rfConfigParams)
	Function used to build and send NSC_RF_CONFIG_REG.
ptxStatus_t	ptxNSC_RfConfig_NvmLoad (ptxNSC_t *nscCtx, ptxNSC_RfConfig_Param_t *rfConfParams)
	Function used to load RF-Config parameters from NVM to given parameter structure.
ptxStatus_t	ptxNSC_NscDataMsg (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint8_t *payload, size_t length, uint8_t isChained)
	Function used to send NSC Data Msg to the chip.
ptxStatus_t	ptxNSC_NscCltMsg (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, uint8_t *pldBytes, uint8_t *pldParityBits, size_t length)
	Function used to send NSC Data Msg to the chip.
size_t	ptxNSC_NscDataMsg_GetMaxPayload (ptxNSC_t *nscCtx)
	Get Maximum payload length that can be transmitted to the NSC component.
ptxStatus_t	ptxNSC_SoftReset (ptxNSC_t *nscCtx, ptxNSC_SoftReset_t setUpNsc)
	Performs a Soft Reset on the NSC.
ptxStatus_t	ptxNSC_SetUcodeActive (ptxNSC_t *nscCtx)
	Set the uCode Image as Active.
ptxStatus_t	ptxNSC_SetUcodeInactive (ptxNSC_t *nscCtx)
	Set the uCode Image as Inactive.
ptxStatus_t	ptxNSC_StandbyCmd (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl)
	NSC_STANDY_CMD.
ptxStatus_t	ptxNSC_WakeupCmd (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl)
	NSC_WAKEUP_CMD.
ptxStatus_t	ptxNSC_PresCheck_IsoDep_Nack (struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl)
	ISO-DEP Presence Check (NACK).
ptxStatus_t	ptxNSC_PresCheck_IsoDep_EmptyBlock (struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl)
	ISO-DEP Presence Check (Empty Block).
ptxStatus_t	ptxNSC_PresCheck_NfcDep_AttentionCmd (struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl)
	ISO-DEP Presence Check (Attention Command).
ptxStatus_t	ptxNSC_T5T_IsolatedEoF (struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl)
	T5T Isolated EoF.
ptxStatus_t	ptxNSC_WriteSystemCfg (ptxNSC_t *nscCtx, struct ptxNSC_System *sysCfgParams)
	Writes NSC System-Configuration parameters.
ptxStatus_t	ptxNSC_ReadSystemCfg (ptxNSC_t *nscCtx, struct ptxNSC_System *sysCfgParams)
	Reads the current NSC System-Configuration parameters.
ptxStatus_t	ptxNSC_RfSetParamsCmd (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNsc_RfPar_t *rfPar, size_t rfParLen)
	Function for NSC_RF_SET_PARAMETER_CMD.
ptxStatus_t	ptxNSC_RfTestRun (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl, ptxNsc_RfTest_Id_t rfTestId, uint8_t *rfTestParams, size_t rfTestParamsLen)
	Function for NSC_RF_RUN_CMD.
ptxStatus_t	ptxNSC_RfTestStop (ptxNSC_t *nscCtx, struct ptxIoRq *ioCpl)
	Function for NSC_RF_STOP_CMD.
ptxStatus_t	ptxNSC_LoadSystemCfg (ptxNSC_t *nscCtx, struct ptxNSC_System *sysCfgParams, uint8_t paramSource)
	Loads NSC System-Configuration parameters and Reads them.
ptxStatus_t	ptxNSC_EmvGetDiscParams (struct ptxNSC *nscCtx, struct ptxNSC_Discover_Param *discoverParams)
	Get discovery loop parameters for EMV.
ptxStatus_t	ptxNSC_NfcForumGetDiscParams (struct ptxNSC *nscCtx, struct ptxNSC_Discover_Param *discoverParams)
	Get discovery loop parameters for NFC-Forum.
ptxStatus_t	ptxNSC_GetRevisionInfo (struct ptxNSC *nscCtx, ptxNSC_RevisionType_t revisionType, uint32_t *revisionInfo)
	Get various revisions of system (C-Stack, DFY-Code/-Toochain, Chip-ID, Local changes etc.
ptxStatus_t	ptxNSC_SetGPIOMode (struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl, uint8_t gpioNr, ptxNSC_GPIO_Mode_t gpioMode, uint8_t gpioFlags)
	Configures a selected GPIO-pin to work as output, output or special function.
ptxStatus_t	ptxNSC_SetGPIOOutput (struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl, uint8_t gpioNr, uint8_t gpioValue)
	Sets the selected GPIO-pin high or low.
ptxStatus_t	ptxNSC_GetGPIOInput (struct ptxNSC *nscCtx, struct ptxIoRq *ioCpl, uint8_t gpioNr)
	Gets the current value of a selected GPIO-pin (value returned in Completion-path).
ptxStatus_t	ptxNSC_GetDeactivateTimeout (struct ptxNSC *nscCtx, uint32_t *currentTimeout)
	Function to retrieve the current timeout value in [ms] to wait for a NSC.RF_DEACTIVATE_RSP.
ptxStatus_t	ptxNSC_SetDeactivateTimeout (struct ptxNSC *nscCtx, uint32_t *currentTimeout)
	Function to set the current timeout value in [ms] to wait for a NSC.RF_DEACTIVATE_RSP.
ptxStatus_t	ptxNSC_SetNrResidualTxBits (ptxNSC_t *nscCtx, uint8_t transparentModeEnabled, uint8_t nrTxBits)
	Enables or disables the NFC Type-A Transparent Mode and allows to set the number of residual Tx-bits if enabled.
ptxStatus_t	ptxNSC_RegisterExtension (ptxNSC_t *nscCtx, ptxNSC_Custom_Extension_t *extension)
	Register an NSC-Extension (Prototype/RFU).
ptxStatus_t	ptxNSC_DeRegisterExtension (ptxNSC_t *nscCtx, uint8_t extensionID)
	De-Register an NSC-Extension (Prototype/RFU).

Common Type of Rf Tech for the Stack
#define	PTX_NSC_TYPES_TECH_A   (0x00u)
#define	PTX_NSC_TYPES_TECH_B   (0x01u)
#define	PTX_NSC_TYPES_TECH_F   (0x02u)
#define	PTX_NSC_TYPES_TECH_V   (0x03u)
#define	PTX_NSC_TYPES_TECH_POLL_A   (0x00u)
#define	PTX_NSC_TYPES_TECH_POLL_B   (0x01u)
#define	PTX_NSC_TYPES_TECH_POLL_F   (0x02u)
#define	PTX_NSC_TYPES_TECH_POLL_ACT   (0x03u)
#define	PTX_NSC_TYPES_TECH_POLL_P2P   (0x04u)
#define	PTX_NSC_TYPES_TECH_POLL_V   (0x06u)
#define	PTX_NSC_TYPES_TECH_LISTEN_A   (0x80u)
#define	PTX_NSC_TYPES_TECH_LISTEN_B   (0x81u)
#define	PTX_NSC_TYPES_TECH_LISTEN_F   (0x82u)
#define	PTX_NSC_TYPES_TECH_LISTEN_ACT   (0x83u)
#define	PTX_NSC_TYPES_TECH_LISTEN_P2P   (0x84u)
#define	PTX_NSC_TYPES_TECH_LISTEN_V   (0x86u)

Common Type of Rf Protocol for the Stack
#define	PTX_NSC_TYPES_PROT_UNDEFINED   (0x00u)
#define	PTX_NSC_TYPES_PROT_T2T   (0x02u)
#define	PTX_NSC_TYPES_PROT_T3T   (0x03u)
#define	PTX_NSC_TYPES_PROT_ISODEP   (0x04u)
#define	PTX_NSC_TYPES_PROT_NFCDEP   (0x05u)
#define	PTX_NSC_TYPES_PROT_T5T   (0x06u)
#define	PTX_NSC_TYPES_PROT_NDEF   (0x07u)

Common Types for NSC Commands
#define	PTX_NSC_TYPES_WRRD_OP_MAX   (70u)
#define	PTX_NSC_TYPES_NHOST_LEN   (4U)
#define	PTX_NSC_TYPES_NHOSTCE_LEN   (4U)
#define	PTX_NSC_TYPES_PRNGSEED_LEN   (4U)
#define	PTX_NSC_TYPES_ALMMAX_LEN   (4U)
#define	PTX_NSC_TYPES_ALMMIN_LEN   (4U)
#define	PTX_NSC_TYPES_WAVBANK_GEN_LEN   (32U)
#define	PTX_NSC_TYPES_WAVBANK0_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK1_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK2_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK3_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK4_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK5_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK6_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK7_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK8_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK9_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK10_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK11_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK12_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK13_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK14_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK15_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK16_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK17_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK18_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_WAVBANK19_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)
#define	PTX_NSC_TYPES_POLLBCMD_LEN   (3U)
#define	PTX_NSC_TYPES_POLLBATTRIBINTF_LEN   (15U)
#define	PTX_NSC_TYPES_POLLFCMD_LEN   (6U)
#define	PTX_NSC_TYPES_POLLVCMD_LEN   (11U)
#define	PTX_NSC_TYPES_POLLISODEPATRIB_INF_LEN   (15U)
#define	PTX_NSC_TYPES_POLLNFCDEPATREQG_LEN   (20U)
#define	PTX_NSC_TYPES_RFU_1_LEN   (23U)
#define	PTX_NSC_TYPES_LISASENSRES_LEN   (2U)
#define	PTX_NSC_TYPES_LISANFCID1_LEN   (15U)
#define	PTX_NSC_TYPES_LISAATS_LEN   (21U)
#define	PTX_NSC_TYPES_LISBSENSRES_LEN   (13U)
#define	PTX_NSC_TYPES_LISBATTRIBRES_LEN   (16U)
#define	PTX_NSC_TYPES_LISFSENSFRES_LEN   (19U)
#define	PTX_NSC_TYPES_LISV_INVENTORYRES_LEN   (10U)
#define	PTX_NSC_TYPES_LISNFCDEP_ATRRESG_LEN   (20U)
#define	PTX_NSC_TYPES_SENSF_CMD_LEN   (6U)
#define	PTX_NSC_TYPES_INVENTORY_CMD_LEN   (11U)
#define	PTX_NSC_TYPES_INVENTORY_RES_LEN   (10U)
#define	PTX_NSC_TYPES_IDLETIME_LEN   (3U)
#define	PTX_NSC_MAXIMUM_NFCID1_LEN   (10u)
#define	PTX_NSC_NFCID0_LEN   (4u)
#define	PTX_NSC_NFCID2_LEN   (8u)
#define	PTX_NSC_TYPEV_UID_LEN   (8u)
#define	PTX_NSC_NFCID1_LEN_1   (4u)
#define	PTX_NSC_NFCID1_LEN_2   (7u)
#define	PTX_NSC_NFCID1_LEN_3   (10u)
#define	PTX_NSC_RF_SET_PARAMS_MAX   (11u)
#define	PTX_NSC_RF_TEST_PARAMS_MAX   (3u)

NSC GPIO Definitions
#define	PTX_NSC_GPIO_NR_01   (1u)
#define	PTX_NSC_GPIO_NR_02   (2u)
#define	PTX_NSC_GPIO_NR_03   (3u)
#define	PTX_NSC_GPIO_NR_04   (4u)
#define	PTX_NSC_GPIO_NR_05   (5u)
#define	PTX_NSC_GPIO_NR_06   (6u)
#define	PTX_NSC_GPIO_NR_07   (7u)
#define	PTX_NSC_GPIO_NR_08   (8u)
#define	PTX_NSC_GPIO_NR_09   (9u)
#define	PTX_NSC_GPIO_NR_10   (10u)
#define	PTX_NSC_GPIO_NR_11   (11u)
#define	PTX_NSC_GPIO_NR_12   (12u)
#define	PTX_NSC_GPIO_NR_01_CFG_INDEX   (0x00u)
#define	PTX_NSC_GPIO_NR_02_CFG_INDEX   (0x01u)
#define	PTX_NSC_GPIO_NR_03_CFG_INDEX   (0x02u)
#define	PTX_NSC_GPIO_NR_04_CFG_INDEX   (0x03u)
#define	PTX_NSC_GPIO_NR_05_CFG_INDEX   (0x04u)
#define	PTX_NSC_GPIO_NR_06_CFG_INDEX   (0x05u)
#define	PTX_NSC_GPIO_NR_07_CFG_INDEX   (0x06u)
#define	PTX_NSC_GPIO_NR_08_CFG_INDEX   (0x07u)
#define	PTX_NSC_GPIO_NR_09_CFG_INDEX   (0x08u)
#define	PTX_NSC_GPIO_NR_10_CFG_INDEX   (0x09u)
#define	PTX_NSC_GPIO_NR_11_CFG_INDEX   (0x0Au)
#define	PTX_NSC_GPIO_NR_12_CFG_INDEX   (0x0Bu)
#define	PTX_NSC_GPIO_MAX_GPIOS   (12u)
#define	PTX_NSC_GPIO_FLAGS_ENABLE_INTPULLUP   (0x01u)
#define	PTX_NSC_GPIO_FLAGS_ENABLE_HDRIVERSTRENGTH   (0x02u)

NSC Extension Definitions
#define	PTX_NSC_MAX_EXTENSIONS   (1u)

Definitions for NSC_DATA_MSG.
#define	PTX_NSC_DATA_MSG_MAX_PAYLOAD_LEN   (253u)
#define	PTX_NSC_HCP_MSG_MAX_LEN   (253u)
#define	PTX_NSC_HCP_MSG_MAX_PAYLOAD_LEN   (251u)
#define	PTX_NSC_DATA_MSG_OPCODE_INDEX   (0x00u)
#define	PTX_NSC_NSC_RFD_MSG_OPCODE   (0xC2u)
#define	PTX_NSC_DATA_MSG_OPCODE_CHAINING   (0xE2u)
#define	PTX_NSC_DATA_MSG_OPCODE_LENGTH   (0x01u)
#define	PTX_NSC_DATA_MSG_CON_MSG_LEN_INDEX   (0x01u)
#define	PTX_NSC_DATA_MSG_CON_MSG_LENGTH   (0x01u)
#define	PTX_NSC_DATA_MSG_CON_MSG_INDEX   (0x02u)
#define	PTX_NSC_DATA_MSG_MASK_ERR_STATUS_BIT   (0x80u)
#define	PTX_NSC_DATA_MSG_MASK_RESIDUAL_BITS   (0x07u)

Generic / Misc. Defines
#define	PTX_NSC_MISC_RF_CONFIG_BUFFER_SIZE   (size_t)37
#define	PTX_NSC_MISC_RF_CONFIG_FLAGS_SET   (uint8_t)0x01
#define	PTX_NSC_MISC_RF_CONFIG_FLAGS_LOADED   (uint8_t)0x02

Detailed Description

Macro Definition Documentation

PTX_NSC_DATA_MSG_CON_MSG_INDEX

#define PTX_NSC_DATA_MSG_CON_MSG_INDEX   (0x02u)

NSC Data Message CON Message index

PTX_NSC_DATA_MSG_CON_MSG_LEN_INDEX

#define PTX_NSC_DATA_MSG_CON_MSG_LEN_INDEX   (0x01u)

NSC Data Message CON Message length index

PTX_NSC_DATA_MSG_CON_MSG_LENGTH

#define PTX_NSC_DATA_MSG_CON_MSG_LENGTH   (0x01u)

NSC Data Message CON Message length

PTX_NSC_DATA_MSG_MASK_ERR_STATUS_BIT

#define PTX_NSC_DATA_MSG_MASK_ERR_STATUS_BIT   (0x80u)

NSC Data Message Mask error status bit

PTX_NSC_DATA_MSG_MASK_RESIDUAL_BITS

#define PTX_NSC_DATA_MSG_MASK_RESIDUAL_BITS   (0x07u)

NSC Data Message Mask Residual Bits

PTX_NSC_DATA_MSG_MAX_PAYLOAD_LEN

#define PTX_NSC_DATA_MSG_MAX_PAYLOAD_LEN   (253u)

NSC Data Message Maximum Payload length

PTX_NSC_DATA_MSG_OPCODE_CHAINING

#define PTX_NSC_DATA_MSG_OPCODE_CHAINING   (0xE2u)

NSC Data Message opcode chaining

PTX_NSC_DATA_MSG_OPCODE_INDEX

#define PTX_NSC_DATA_MSG_OPCODE_INDEX   (0x00u)

NSC Data Message opcode index

PTX_NSC_DATA_MSG_OPCODE_LENGTH

#define PTX_NSC_DATA_MSG_OPCODE_LENGTH   (0x01u)

NSC Data Message opcode length

PTX_NSC_GPIO_FLAGS_ENABLE_HDRIVERSTRENGTH

#define PTX_NSC_GPIO_FLAGS_ENABLE_HDRIVERSTRENGTH   (0x02u)

NSC GPIO Flags enable HDRIVERSTRENGTH

PTX_NSC_GPIO_FLAGS_ENABLE_INTPULLUP

#define PTX_NSC_GPIO_FLAGS_ENABLE_INTPULLUP   (0x01u)

NSC GPIO Flags enable INTPULLUP

PTX_NSC_GPIO_MAX_GPIOS

#define PTX_NSC_GPIO_MAX_GPIOS   (12u)

NSC GPIO Maximum GPIOs

PTX_NSC_GPIO_NR_01

#define PTX_NSC_GPIO_NR_01   (1u)

NSC GPIO NR 01

PTX_NSC_GPIO_NR_01_CFG_INDEX

#define PTX_NSC_GPIO_NR_01_CFG_INDEX   (0x00u)

NSC GPIO NR 01 Config Index

PTX_NSC_GPIO_NR_02

#define PTX_NSC_GPIO_NR_02   (2u)

NSC GPIO NR 02

PTX_NSC_GPIO_NR_02_CFG_INDEX

#define PTX_NSC_GPIO_NR_02_CFG_INDEX   (0x01u)

NSC GPIO NR 02 Config Index

PTX_NSC_GPIO_NR_03

#define PTX_NSC_GPIO_NR_03   (3u)

NSC GPIO NR 03

PTX_NSC_GPIO_NR_03_CFG_INDEX

#define PTX_NSC_GPIO_NR_03_CFG_INDEX   (0x02u)

NSC GPIO NR 03 Config Index

PTX_NSC_GPIO_NR_04

#define PTX_NSC_GPIO_NR_04   (4u)

NSC GPIO NR 04

PTX_NSC_GPIO_NR_04_CFG_INDEX

#define PTX_NSC_GPIO_NR_04_CFG_INDEX   (0x03u)

NSC GPIO NR 04 Config Index

PTX_NSC_GPIO_NR_05

#define PTX_NSC_GPIO_NR_05   (5u)

NSC GPIO NR 05

PTX_NSC_GPIO_NR_05_CFG_INDEX

#define PTX_NSC_GPIO_NR_05_CFG_INDEX   (0x04u)

NSC GPIO NR 05 Config Index

PTX_NSC_GPIO_NR_06

#define PTX_NSC_GPIO_NR_06   (6u)

NSC GPIO NR 06

PTX_NSC_GPIO_NR_06_CFG_INDEX

#define PTX_NSC_GPIO_NR_06_CFG_INDEX   (0x05u)

NSC GPIO NR 06 Config Index

PTX_NSC_GPIO_NR_07

#define PTX_NSC_GPIO_NR_07   (7u)

NSC GPIO NR 07

PTX_NSC_GPIO_NR_07_CFG_INDEX

#define PTX_NSC_GPIO_NR_07_CFG_INDEX   (0x06u)

NSC GPIO NR 07 Config Index

PTX_NSC_GPIO_NR_08

#define PTX_NSC_GPIO_NR_08   (8u)

NSC GPIO NR 08

PTX_NSC_GPIO_NR_08_CFG_INDEX

#define PTX_NSC_GPIO_NR_08_CFG_INDEX   (0x07u)

NSC GPIO NR 08 Config Index

PTX_NSC_GPIO_NR_09

#define PTX_NSC_GPIO_NR_09   (9u)

NSC GPIO NR 09

PTX_NSC_GPIO_NR_09_CFG_INDEX

#define PTX_NSC_GPIO_NR_09_CFG_INDEX   (0x08u)

NSC GPIO NR 09 Config Index

PTX_NSC_GPIO_NR_10

#define PTX_NSC_GPIO_NR_10   (10u)

NSC GPIO NR 10

PTX_NSC_GPIO_NR_10_CFG_INDEX

#define PTX_NSC_GPIO_NR_10_CFG_INDEX   (0x09u)

NSC GPIO NR 10 Config Index

PTX_NSC_GPIO_NR_11

#define PTX_NSC_GPIO_NR_11   (11u)

NSC GPIO NR 11

PTX_NSC_GPIO_NR_11_CFG_INDEX

#define PTX_NSC_GPIO_NR_11_CFG_INDEX   (0x0Au)

NSC GPIO NR 11 Config Index

PTX_NSC_GPIO_NR_12

#define PTX_NSC_GPIO_NR_12   (12u)

NSC GPIO NR 12

PTX_NSC_GPIO_NR_12_CFG_INDEX

#define PTX_NSC_GPIO_NR_12_CFG_INDEX   (0x0Bu)

NSC GPIO NR 12 Config Index

PTX_NSC_HCP_MSG_MAX_LEN

#define PTX_NSC_HCP_MSG_MAX_LEN   (253u)

NSC HCP Message Maximum length

PTX_NSC_HCP_MSG_MAX_PAYLOAD_LEN

#define PTX_NSC_HCP_MSG_MAX_PAYLOAD_LEN   (251u)

NSC HCP Message Maximum Payload length

PTX_NSC_IC_SERIAL_NUMBER_LENGTH

#define PTX_NSC_IC_SERIAL_NUMBER_LENGTH   10

NSC PTXxxx IC Serial Number and Manufacturer Information.

PTX_NSC_MAX_EXTENSIONS

#define PTX_NSC_MAX_EXTENSIONS   (1u)

NSC Max. amount of Extensions supported in parallel

PTX_NSC_MAXIMUM_NFCID1_LEN

#define PTX_NSC_MAXIMUM_NFCID1_LEN   (10u)

NSC maximum NFCID1 length

PTX_NSC_MIN_IO_BUFFER_SIZE

#define PTX_NSC_MIN_IO_BUFFER_SIZE   280

NSC large buffer.

PTX_NSC_MISC_RF_CONFIG_BUFFER_SIZE

#define PTX_NSC_MISC_RF_CONFIG_BUFFER_SIZE   (size_t)37

NSC MISC RF Config Buffer Size

PTX_NSC_MISC_RF_CONFIG_FLAGS_LOADED

#define PTX_NSC_MISC_RF_CONFIG_FLAGS_LOADED   (uint8_t)0x02

NSC MISC RF Config Flas loaded

PTX_NSC_MISC_RF_CONFIG_FLAGS_SET

#define PTX_NSC_MISC_RF_CONFIG_FLAGS_SET   (uint8_t)0x01

NSC MISC RF Config Flags Set

PTX_NSC_NFCID0_LEN

#define PTX_NSC_NFCID0_LEN   (4u)

NSC NFCID0 length

PTX_NSC_NFCID1_LEN_1

#define PTX_NSC_NFCID1_LEN_1   (4u)

NSC NFCID1 length 1

PTX_NSC_NFCID1_LEN_2

#define PTX_NSC_NFCID1_LEN_2   (7u)

NSC NFCID1 length 2

PTX_NSC_NFCID1_LEN_3

#define PTX_NSC_NFCID1_LEN_3   (10u)

NSC NFCID1 length 3

PTX_NSC_NFCID2_LEN

#define PTX_NSC_NFCID2_LEN   (8u)

NSC NFCID2 length

PTX_NSC_NSC_RFD_MSG_OPCODE

#define PTX_NSC_NSC_RFD_MSG_OPCODE   (0xC2u)

NSC RFD Message opcode

PTX_NSC_RF_SET_PARAMS_MAX

#define PTX_NSC_RF_SET_PARAMS_MAX   (11u)

NSC RF set Params maximum

PTX_NSC_RF_TEST_PARAMS_MAX

#define PTX_NSC_RF_TEST_PARAMS_MAX   (3u)

NSC RF Test Params maximum

PTX_NSC_RFCONFIG_NAME_CAPACITY

#define PTX_NSC_RFCONFIG_NAME_CAPACITY   64

NSC RF CONFIG NAME CAPACITY.

PTX_NSC_TYPES_ALMMAX_LEN

#define PTX_NSC_TYPES_ALMMAX_LEN   (4U)

NSC Type ALMMAX length

PTX_NSC_TYPES_ALMMIN_LEN

#define PTX_NSC_TYPES_ALMMIN_LEN   (4U)

NSC Type ALMMIN length

PTX_NSC_TYPES_IDLETIME_LEN

#define PTX_NSC_TYPES_IDLETIME_LEN   (3U)

NSC Type IDLETIME length

PTX_NSC_TYPES_INVENTORY_CMD_LEN

#define PTX_NSC_TYPES_INVENTORY_CMD_LEN   (11U)

NSC Type INVENTORY command length

PTX_NSC_TYPES_INVENTORY_RES_LEN

#define PTX_NSC_TYPES_INVENTORY_RES_LEN   (10U)

NSC Type INVENTORY response length

PTX_NSC_TYPES_LISAATS_LEN

#define PTX_NSC_TYPES_LISAATS_LEN   (21U)

NSC Type listen A ATS length

PTX_NSC_TYPES_LISANFCID1_LEN

#define PTX_NSC_TYPES_LISANFCID1_LEN   (15U)

NSC Type listen A NFCID1 length

PTX_NSC_TYPES_LISASENSRES_LEN

#define PTX_NSC_TYPES_LISASENSRES_LEN   (2U)

NSC Type listen A SENSRES length

PTX_NSC_TYPES_LISBATTRIBRES_LEN

#define PTX_NSC_TYPES_LISBATTRIBRES_LEN   (16U)

NSC Type listen B ATTRIBRES length

PTX_NSC_TYPES_LISBSENSRES_LEN

#define PTX_NSC_TYPES_LISBSENSRES_LEN   (13U)

NSC Type listen B SENSRES length

PTX_NSC_TYPES_LISFSENSFRES_LEN

#define PTX_NSC_TYPES_LISFSENSFRES_LEN   (19U)

NSC Type listen F SENSFRES length

PTX_NSC_TYPES_LISNFCDEP_ATRRESG_LEN

#define PTX_NSC_TYPES_LISNFCDEP_ATRRESG_LEN   (20U)

NSC Type listen NFCDEP ATRRESG length

PTX_NSC_TYPES_LISV_INVENTORYRES_LEN

#define PTX_NSC_TYPES_LISV_INVENTORYRES_LEN   (10U)

NSC Type listen V INVENTORYRES length

PTX_NSC_TYPES_NHOST_LEN

#define PTX_NSC_TYPES_NHOST_LEN   (4U)

NSC Type NHOST length

PTX_NSC_TYPES_NHOSTCE_LEN

#define PTX_NSC_TYPES_NHOSTCE_LEN   (4U)

NSC Type NHOSTCE length

PTX_NSC_TYPES_POLLBATTRIBINTF_LEN

#define PTX_NSC_TYPES_POLLBATTRIBINTF_LEN   (15U)

NSC Type Poll B ATTRIBINTF length

PTX_NSC_TYPES_POLLBCMD_LEN

#define PTX_NSC_TYPES_POLLBCMD_LEN   (3U)

NSC Type Poll B command length

PTX_NSC_TYPES_POLLFCMD_LEN

#define PTX_NSC_TYPES_POLLFCMD_LEN   (6U)

NSC Type Poll F command length

PTX_NSC_TYPES_POLLISODEPATRIB_INF_LEN

#define PTX_NSC_TYPES_POLLISODEPATRIB_INF_LEN   (15U)

NSC Type Poll ISODEP ATRIB INF length

PTX_NSC_TYPES_POLLNFCDEPATREQG_LEN

#define PTX_NSC_TYPES_POLLNFCDEPATREQG_LEN   (20U)

NSC Type Poll NFCDEP ATREQ length

PTX_NSC_TYPES_POLLVCMD_LEN

#define PTX_NSC_TYPES_POLLVCMD_LEN   (11U)

NSC Type Poll V command length

PTX_NSC_TYPES_PRNGSEED_LEN

#define PTX_NSC_TYPES_PRNGSEED_LEN   (4U)

NSC Type PRNGSEED length

PTX_NSC_TYPES_PROT_ISODEP

#define PTX_NSC_TYPES_PROT_ISODEP   (0x04u)

NSC Type Protocol ISODEP

PTX_NSC_TYPES_PROT_NDEF

#define PTX_NSC_TYPES_PROT_NDEF   (0x07u)

NSC Type Protocol NDEF

PTX_NSC_TYPES_PROT_NFCDEP

#define PTX_NSC_TYPES_PROT_NFCDEP   (0x05u)

NSC Type Protocol NFCDEP

PTX_NSC_TYPES_PROT_T2T

#define PTX_NSC_TYPES_PROT_T2T   (0x02u)

NSC Type Protocol T2T

PTX_NSC_TYPES_PROT_T3T

#define PTX_NSC_TYPES_PROT_T3T   (0x03u)

NSC Type Protocol T3T

PTX_NSC_TYPES_PROT_T5T

#define PTX_NSC_TYPES_PROT_T5T   (0x06u)

NSC Type Protocol T5T

PTX_NSC_TYPES_PROT_UNDEFINED

#define PTX_NSC_TYPES_PROT_UNDEFINED   (0x00u)

NSC Type Protocol Undefined

PTX_NSC_TYPES_RFU_1_LEN

#define PTX_NSC_TYPES_RFU_1_LEN   (23U)

RFU

PTX_NSC_TYPES_SENSF_CMD_LEN

#define PTX_NSC_TYPES_SENSF_CMD_LEN   (6U)

NSC Type SENSF command length

PTX_NSC_TYPES_TECH_A

#define PTX_NSC_TYPES_TECH_A   (0x00u)

NSC Type Tech A

PTX_NSC_TYPES_TECH_B

#define PTX_NSC_TYPES_TECH_B   (0x01u)

NSC Type Tech B

PTX_NSC_TYPES_TECH_F

#define PTX_NSC_TYPES_TECH_F   (0x02u)

NSC Type Tech F

PTX_NSC_TYPES_TECH_LISTEN_A

#define PTX_NSC_TYPES_TECH_LISTEN_A   (0x80u)

NSC Type Tech Listen A

PTX_NSC_TYPES_TECH_LISTEN_ACT

#define PTX_NSC_TYPES_TECH_LISTEN_ACT   (0x83u)

NSC Type Tech Listen ACT

PTX_NSC_TYPES_TECH_LISTEN_B

#define PTX_NSC_TYPES_TECH_LISTEN_B   (0x81u)

NSC Type Tech Listen B

PTX_NSC_TYPES_TECH_LISTEN_F

#define PTX_NSC_TYPES_TECH_LISTEN_F   (0x82u)

NSC Type Tech Listen F

PTX_NSC_TYPES_TECH_LISTEN_P2P

#define PTX_NSC_TYPES_TECH_LISTEN_P2P   (0x84u)

NSC Type Tech Listen P2P

PTX_NSC_TYPES_TECH_LISTEN_V

#define PTX_NSC_TYPES_TECH_LISTEN_V   (0x86u)

NSC Type Tech Listen V

PTX_NSC_TYPES_TECH_POLL_A

#define PTX_NSC_TYPES_TECH_POLL_A   (0x00u)

NSC Type Tech Poll A

PTX_NSC_TYPES_TECH_POLL_ACT

#define PTX_NSC_TYPES_TECH_POLL_ACT   (0x03u)

NSC Type Tech Poll ACT

PTX_NSC_TYPES_TECH_POLL_B

#define PTX_NSC_TYPES_TECH_POLL_B   (0x01u)

NSC Type Tech Poll B

PTX_NSC_TYPES_TECH_POLL_F

#define PTX_NSC_TYPES_TECH_POLL_F   (0x02u)

NSC Type Tech Poll F

PTX_NSC_TYPES_TECH_POLL_P2P

#define PTX_NSC_TYPES_TECH_POLL_P2P   (0x04u)

NSC Type Tech Poll P2P

PTX_NSC_TYPES_TECH_POLL_V

#define PTX_NSC_TYPES_TECH_POLL_V   (0x06u)

NSC Type Tech Poll V

PTX_NSC_TYPES_TECH_V

#define PTX_NSC_TYPES_TECH_V   (0x03u)

NSC Type Tech V

PTX_NSC_TYPES_WAVBANK0_LEN

#define PTX_NSC_TYPES_WAVBANK0_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 0 length

PTX_NSC_TYPES_WAVBANK10_LEN

#define PTX_NSC_TYPES_WAVBANK10_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 10 length

PTX_NSC_TYPES_WAVBANK11_LEN

#define PTX_NSC_TYPES_WAVBANK11_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 11 length

PTX_NSC_TYPES_WAVBANK12_LEN

#define PTX_NSC_TYPES_WAVBANK12_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 12 length

PTX_NSC_TYPES_WAVBANK13_LEN

#define PTX_NSC_TYPES_WAVBANK13_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 13 length

PTX_NSC_TYPES_WAVBANK14_LEN

#define PTX_NSC_TYPES_WAVBANK14_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 14 length

PTX_NSC_TYPES_WAVBANK15_LEN

#define PTX_NSC_TYPES_WAVBANK15_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 15 length

PTX_NSC_TYPES_WAVBANK16_LEN

#define PTX_NSC_TYPES_WAVBANK16_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 16 length

PTX_NSC_TYPES_WAVBANK17_LEN

#define PTX_NSC_TYPES_WAVBANK17_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 17 length

PTX_NSC_TYPES_WAVBANK18_LEN

#define PTX_NSC_TYPES_WAVBANK18_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 18 length

PTX_NSC_TYPES_WAVBANK19_LEN

#define PTX_NSC_TYPES_WAVBANK19_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 19 length

PTX_NSC_TYPES_WAVBANK1_LEN

#define PTX_NSC_TYPES_WAVBANK1_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 1 length

PTX_NSC_TYPES_WAVBANK2_LEN

#define PTX_NSC_TYPES_WAVBANK2_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 2 length

PTX_NSC_TYPES_WAVBANK3_LEN

#define PTX_NSC_TYPES_WAVBANK3_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 3 length

PTX_NSC_TYPES_WAVBANK4_LEN

#define PTX_NSC_TYPES_WAVBANK4_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 4 length

PTX_NSC_TYPES_WAVBANK5_LEN

#define PTX_NSC_TYPES_WAVBANK5_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 5 length

PTX_NSC_TYPES_WAVBANK6_LEN

#define PTX_NSC_TYPES_WAVBANK6_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 6 length

PTX_NSC_TYPES_WAVBANK7_LEN

#define PTX_NSC_TYPES_WAVBANK7_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 7 length

PTX_NSC_TYPES_WAVBANK8_LEN

#define PTX_NSC_TYPES_WAVBANK8_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 8 length

PTX_NSC_TYPES_WAVBANK9_LEN

#define PTX_NSC_TYPES_WAVBANK9_LEN   (PTX_NSC_TYPES_WAVBANK_GEN_LEN)

NSC Type WAVBANK 9 length

PTX_NSC_TYPES_WAVBANK_GEN_LEN

#define PTX_NSC_TYPES_WAVBANK_GEN_LEN   (32U)

NSC Type WAVBANK GEN length

PTX_NSC_TYPES_WRRD_OP_MAX

#define PTX_NSC_TYPES_WRRD_OP_MAX   (70u)

NSC Type WRRD operation maximum

PTX_NSC_TYPEV_UID_LEN

#define PTX_NSC_TYPEV_UID_LEN   (8u)

NSC Type V UID length

Typedef Documentation

pptxNSC_t

typedef struct ptxNSC* pptxNSC_t

Main NSC structure, forward declaration.

pptxTbInt_GetIORQNtf_t

typedef ptxStatus_t(* pptxTbInt_GetIORQNtf_t) (void *cpLayer, struct ptxIoRq *io_rq)

Integration get IO RQ Ntf.

Parameters

[in]	cpLayer	Pointer to an initialized component structure.
[in]	io_rq	Pointer to IO component structure.

ptxNSC_CmdSched_Param_t

typedef enum ptxNSC_CmdSched_Param ptxNSC_CmdSched_Param_t

NSC command execution schedule control flag.

Note

Use these to schedule command execution - post or immediate. The usage depends on the caller component state.

ptxNSC_InitParam_t

typedef struct ptxNSC_InitParam ptxNSC_InitParam_t

NSC Initialization parameter structure.

ptxNSC_t

typedef struct ptxNSC ptxNSC_t

Main NSC structure.

Enumeration Type Documentation

ptxNSC_CmdSched_Param

enum ptxNSC_CmdSched_Param

NSC command execution schedule control flag.

Note

Use these to schedule command execution - post or immediate. The usage depends on the caller component state.

ptxNSC_ConRfProtocol

enum ptxNSC_ConRfProtocol

Type of Rf Protocol.

Enumerator
Undefined	Rf Protocol Undefuined.
T2T	Rf Protocol T2T.
T3T	Rf Protocol T3T.
IsoDep	Rf Protocol ISO-DEP.
NfcDep	Rf Protocol NFC-DEP.
T5T	Rf Protocol T5T.
Ndef	Rf Protocol NDEF.

ptxNSC_ConRfTech

enum ptxNSC_ConRfTech

Type of Rf Tech.

Enumerator
Passive_Poll_A	Poll A Technology.
Passive_Poll_B	Poll B Technology.
Passive_Poll_F	Poll F Technology.
Active_Pol	Poll Active Technology.
Passive_Poll_V	Poll V Technology.
Passive_Listen_A	Listen A Technology.
Passive_Listen_B	Listen B Technology.
Passive_Listen_F	Listen F Technology.
Active_Listen	Listen Active Technology.

ptxNsc_ErrorCodes

enum ptxNsc_ErrorCodes

NSC error codes.

Enumerator
ptxNsc_Sucessful	Command successfully executed without errors.
ptxNsc_UnknownError	Command failed due to an unknown error.
ptxNsc_NotAllowedCmd	Command not allowed in the current state.
ptxNsc_UnknownCmdError	Command unknown.
ptxNsc_InvalidParameter	Invalid parameter.
ptxNsc_RouteNotFound	Route not found.
ptxNsc_PAThermalError	PA Thermal protection error.
ptxNsc_PAOvercurrentError	PA Overcurrent protection error.
ptxNsc_DeviceInStandby	Device was in Standby mode.
ptxNsc_PAOvercurrentLimiter	PA Overcurrent limiter activated warning.
ptxNsc_RfCollisionError	RF Collision error (valid for EMVCo poll mode).
ptxNsc_RfTimeoutError	RF Timeout error.
ptxNsc_RfTransmissionError	RF Transmission error.
ptxNsc_RfProtocolError	RF Protocol error.
ptxNsc_RfPollModeNotSupported	RF Poll mode not supported.
ptxNsc_RfListenModeNotSupported	RF Listen mode not supported.
ptxNsc_SwpUiccNotPresent	SWP error. UICC not present.
ptxNsc_SwpInterfaceError	SWP error. Interface error.
ptxNsc_SwpIdentityCheckFailed	SWP identity check failed.
ptxNsc_SwpModeNotSupported	SWP mode not supported.
ptxNsc_CommInterfaceError	Host Interface communication error.

ptxNSC_EventId

enum ptxNSC_EventId

NSC Event Id. Type of event notifying layer above.

Enumerator
NSC_EventFieldOn	Field On NTF has been received from NSC.
NSC_EventFieldOff	Field Off NTF has been received from NSC.
NSC_EventRfAct_PassPoll_A	Rf Activation. NFC-A passive poll mode.
NSC_EventRfAct_PassPoll_B	Rf Activation. NFC-B passive poll mode.
NSC_EventRfAct_PassPoll_F	Rf Activation. NFC-F passive poll mode.
NSC_EventRfAct_PassPoll_V	Rf Activation. NFC-V passive poll mode.
NSC_EventRfAct_ActivePoll	Rf Activation. NFC active poll mode.
NSC_EventRfAct_Extension	Rf Activation. Extension (Prototype / RFU).
NSC_EventRfAct_PasLis_A	Rf Activation. NFC-A passive listen mode.
NSC_EventRfAct_PasLis_B	Rf Activation. NFC-B passive listen mode.
NSC_EventRfAct_PasLis_F	Rf Activation. NFC-F passive listen mode.
NSC_EventRfAct_PasLis_V	Rf Activation. NFC-V passive listen mode.
NSC_EventRfAct_ActiveListen	Rf Activation. NFC active listen mode.
NSC_EventRfDisc_PassPoll_A	Rf Discovery. NFC-A passive poll mode.
NSC_EventRfDisc_PassPoll_B	Rf Discovery. NFC-B passive poll mode.
NSC_EventRfDisc_PassPoll_F	Rf Discovery. NFC-F passive poll mode.
NSC_EventRfDisc_PassPoll_V	Rf Discovery. NFC-V passive poll mode.
NSC_EventRfDisc_ActivePoll	Rf Discovery. NFC active poll mode.
NSC_EventRfDisc_Extension	Rf Discovery. Extension (Prototype / RFU).
NSC_EventRfDisc_LastOne	Rf Discovery. NFC active listen mode.
NSC_EventError	Error Notification.
NSC_EventData_Msg	NSC Data packet received (Not Chained).
NSC_EventData_Msg_Chained	NSC Data packet received (Chained).
NSC_EventData_Clt	NSC CLT Message packet received.
NSC_EventRfDeact	Rf Deactivation.
HCI_EventData_Msg	HCI message from HCI host controller to Host (Device Host Application).
HCI_Network_Init	HCI event telling upper layer that HCI Network initialization has started.
HCI_Network_Done	HCI event telling upper layer that HCI Network initialization has finished.
HCI_PipeCeA_Open	HCI event telling upper layer that Ce A Pipe has been created & opened.
HCI_PipeCeB_Open	HCI event telling upper layer that Ce B Pipe has been created & opened.
HCI_PipeCeF_Open	HCI event telling upper layer that Ce F Pipe has been created & opened.
HCI_ReaderA_Req	HCI event telling upper layer the Reader A pipe is requesting polling for Type A.
HCI_ReaderB_Req	HCI event telling upper layer the Reader B pipe is requesting polling for Type B.
HCI_ReaderStop	HCI event telling upper layer the HCI reader wants to stop polling.
HCI_SwpDeact	HCI event telling upper layer that SWP deactivation is required (Not NCI NTF involved).
NSC_Debug	NSC Debug Event.
NSC_EventRfLPCD	Device detected via low power card detection (LPDC).
NumOfEventsNCI	Number of events that are processed by NCI.
NoEvent	No event.
Nsc_HciIn_Msg	HCI input message for HCI SW Component.
Nsc_HciOut_Msg	HCI output message for HCI SW Component.
UnknownEvent	Unknown Event.

ptxNSC_GPIO_Mode

enum ptxNSC_GPIO_Mode

NSC Read CMD parameter structure.

Enumerator
GPIO_Mode_Input	GPIO-Mode = Input
GPIO_Mode_Output	GPIO-Mode = Output
GPIO_Mode_Special	GPIO-Mode = Special Function (depends on GPIO-Pin Number)

ptxNSC_Init_clk_src

enum ptxNSC_Init_clk_src

Types of Source Clock on NSC Init CMD.

Enumerator
ptxNSC_InitClockCrystal	Clock provided by Crystal Clock.
ptxNSC_InitClockHost	Clock provided by the Host.

ptxNSC_InitTechPoll

enum ptxNSC_InitTechPoll

Enum for initial technology in the discovery loop.

Enumerator
Init_Poll_ACM	In case of enabled, first technology to poll for NFC-ACM.
Init_Poll_A	In case of enabled, first technology to poll for NFC-A.
Init_Poll_B	In case of enabled, first technology to poll for NFC-B.
Init_Poll_F	In case of enabled, first technology to poll for NFC-F.
Init_Poll_V	In case of enabled, first technology to poll for NFC-V.

ptxNSC_Pause_Options

enum ptxNSC_Pause_Options

NSC Pause Options. .

Enumerator
ptxNSC_Thread_ResumeByApp	NSC Thread Resumed by Application.
ptxNSC_Thread_ResumeByStack	NSC Thread Resumed by Stack.
ptxNSC_Thread_PauseByApp	NSC Thread Paused by Application.
ptxNSC_Thread_PauseByStack	NSC Thread Paused by Stack.

ptxNSC_PollType

enum ptxNSC_PollType

Enum for Polling-Loop type.

Enumerator
PollModeDisabled	Disables any polling activity
ConstantField	Turns on RF-field (but no modulation!).
NfcForumMode	NFC-Forum polling mode
EmvPollMode	EMVCo polling mode (standard)
EmvPollMode_TransacA	EMVCo polling mode (TRANSAC_A)
EmvPollMode_TransacB	EMVCo polling mode (TRANSAC_B)
IsoPollMode	ISO polling mode

ptxNSC_ReadCmd_Type

enum ptxNSC_ReadCmd_Type

Types of NSC Read CMD.

Enumerator
ReadRandomAdd	Read Random Addres.

ptxNSC_ResetCpuEn

enum ptxNSC_ResetCpuEn

Types of Enable cpu in NSC Reset CMD.

Enumerator
ptxNSC_ResetCpuDisabled	Disable Reset CPU.
ptxNSC_ResetCpuEnabled	Enable Reset CPU.

ptxNSC_Rf_Deact_State

enum ptxNSC_Rf_Deact_State

NSC RF state-machine state after command execution.

Enumerator
RfIdle	Rf Idle State.
RfDiscovery	Rf Discovery State.
RfPollSleep	Rf Poll State.
RfDiscoverNoFieldOff	Rf Discovery No Field Off.

ptxNSC_Rf_Deact_Type

enum ptxNSC_Rf_Deact_Type

NSC Rf Deactivate procedure type.

Enumerator
DeactType_Generic	Generic Deactivation - no specific deactivation
DeactType_Protocol_Specific	Protocol Specific Deactivation - managed by the u??Code itself

ptxNsc_RfDiscovery_Mode

enum ptxNsc_RfDiscovery_Mode

NSC Rf Discovery mode.

Enumerator
DiscoveryMode_Regular	Regular RF discovery mode.
DiscoveryMode_Lpcd	Low power card detection (LPCD) mode.
DiscoveryMode_Hybrid_Start	Hybrid mode: regular/full-power RF poll phase is used in every n-th discovery period and LPCD is used in other periods. Acceptable values: 2 - 255.

ptxNsc_RfParameter_Id

enum ptxNsc_RfParameter_Id

NSC Rf Parameter Id.

Enumerator
RfParameter_EoC	End-of-Command parameter indicates the end of a command.
RfParameter_Rf_Tech	Set RF technology.
RfParameter_Fwt	Set Frame Waiting Time in 128/fc time units in big-endian format (most significant byte first).
RfParameter_Tx_Bit_Rate	Set transmission bitrate
RfParameter_Rx_Bit_Rate	Set reception bitrate
RfParameter_Tx_PAR	Enable or disable RF PARITY on tx automatically handled by PTX1K (enabled by default).
RfParameter_Rx_PAR	Enable or disable RF PARITY on rx automatically handled by PTX1K (enabled by default).
RfParameter_Tx_CRC	Enable or disable RF CRC on tx automatically handled by PTX1K (enabled by default).
RfParameter_Rx_CRC	Enable or disable RF CRC on rx automatically handled by PTX1K (enabled by default).
RfParameter_Res_Limit	Set max. response limit for NSC to receive on RF (0 == wait until Frame Waiting Time expires).
RfParameter_Tx_Residual_Bits	Defines residual bits for the last transmitted byte. In case the parameter is 0 a full byte is transmitted. Valid values are 0 to 7
RfParameter_Rf_Field	Enables or disables the RF Field (1 == enabled, 0 == disabled)

ptxNsc_RfTest_Id

enum ptxNsc_RfTest_Id

Test-IDs for RF-Test command.

Enumerator
RfTest_TRANSAC_A	RF-Test Identifier TRANSAC-A.
RfTest_TRANSAC_B	RF-Test Identifier TRANSAC-B.
RfTest_Carrier	RF-Test Identifier CARRIER.
RfTest_PRBS_9	RF-Test Identifier PRBS-9.
RfTest_PRBS_15	RF-Test Identifier PRBS-15.

ptxNSC_SoftReset

enum ptxNSC_SoftReset

Types of Soft-Reset.

Enumerator
ptxNSC_SoftRst	Performs simply a SoftReset on the NSC.
ptxNSC_SoftRstAndRstStack	Performs a SoftReset on the NSC and Reset the Stack state.

ptxNSC_WriteCmd_Type

enum ptxNSC_WriteCmd_Type

Types of NSC Write CMD.

Enumerator
WriteRandomAdd	Write Random Addres.

Function Documentation

ptxNSC_DeRegisterExtension()

ptxStatus_t ptxNSC_DeRegisterExtension	(	ptxNSC_t *	nscCtx,
		uint8_t	extensionID )

De-Register an NSC-Extension (Prototype/RFU).

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	extensionID	ID of Extension to be de-registered within component.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_DFY_Activation()

ptxStatus_t ptxNSC_DFY_Activation	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl )

Function for DFY Activation. (Performed as synchronous operation).

Old implementation not used for NSC_Reset_CMD. It does WRA for DragonFly activation and ReadBuffer to get NSC_Reset_RSP. It does not include CPU enable parameter.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_DFY_Init()

ptxStatus_t ptxNSC_DFY_Init	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl )

Function for filling NSC_INIT_CMD.

This function that fills the parameters for NSC_INIT_CMD and call ptxNSC_InitCmd.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_DiscoverCmd()

ptxStatus_t ptxNSC_DiscoverCmd	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		ptxNSC_Discover_Param_t *	discoverParams )

Function for NSC_RF_DISCOVER_CMD.

This function builds the NSC_RF_DISCOVER_CMD accordingly to inputParams and send it to the chip.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	discoverParams	Pointer to init params to build properly this command.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_EmvGetDiscParams()

ptxStatus_t ptxNSC_EmvGetDiscParams	(	struct ptxNSC *	nscCtx,
		struct ptxNSC_Discover_Param *	discoverParams )

Get discovery loop parameters for EMV.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in,out]	discoverParams	Pointer to discover parameters already allocated.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_FwDownload()

ptxStatus_t ptxNSC_FwDownload	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		uint8_t *	pData,
		size_t	length,
		uint8_t	forceDwnld )

NSC FW Download.

This function is used in the command path of a NSC Downloader functionality. It is just used to push the completion functions as the communication with the chip is done on the completion path.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	pData	Pointer to the not yet parsed data to be download to the chip.
[in]	length	Length of the data on the fw image.
[in]	forceDwnld	If (forceDwnld == 1) force the function to download, otherwise let the function decide.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_GetDeactivateTimeout()

ptxStatus_t ptxNSC_GetDeactivateTimeout	(	struct ptxNSC *	nscCtx,
		uint32_t *	currentTimeout )

Function to retrieve the current timeout value in [ms] to wait for a NSC.RF_DEACTIVATE_RSP.

Parameters

[in]	nscCtx	Pointer to the component structure.
[out]	currentTimeout	Pointer to store the current timeout value.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_GetGPIOInput()

ptxStatus_t ptxNSC_GetGPIOInput	(	struct ptxNSC *	nscCtx,
		struct ptxIoRq *	ioCpl,
		uint8_t	gpioNr )

Gets the current value of a selected GPIO-pin (value returned in Completion-path).

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	gpioNr	GPIO number.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_GetRevisionInfo()

ptxStatus_t ptxNSC_GetRevisionInfo	(	struct ptxNSC *	nscCtx,
		ptxNSC_RevisionType_t	revisionType,
		uint32_t *	revisionInfo )

Get various revisions of system (C-Stack, DFY-Code/-Toochain, Chip-ID, Local changes etc.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	revisionType	Type of Revision.
[out]	revisionInfo	Revision information..

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_Hal_Read_Synchronous()

ptxStatus_t ptxNSC_Hal_Read_Synchronous	(	ptxNSC_t *	nscCtx,
		uint8_t *	rxBuf,
		size_t *	rxLen )

Read upcoming data from the chip.

This function just provides capability to call /ref ptxHal_Rx or /ref ptxHal_MockRx from components above. This function is called when the receiving thread has been stopped so it works in HW_CONTROL_MODE.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	rxBuf	Buffer for receiving the data.
[in,out]	rxLen	As input provide as many bytes as want to be read by the caller As Output provide the caller the number of bytes actually read out.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_InitCmd()

ptxStatus_t ptxNSC_InitCmd	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		ptxNSC_Init_Param_t *	initParams )

Function for NSC_INIT_CMD.

This function builds the NSC_INIT_CMD accordingly to inputParams and send it to the chip.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	initParams	Pointer to initParams to build NSC_INIT_CMD.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_LoadSystemCfg()

ptxStatus_t ptxNSC_LoadSystemCfg	(	ptxNSC_t *	nscCtx,
		struct ptxNSC_System *	sysCfgParams,
		uint8_t	paramSource )

Loads NSC System-Configuration parameters and Reads them.

Parameters

[in]	nscCtx	Pointer to the component structure (already allocated and initialized).
[out]	sysCfgParams	Pointer to system-configuration structure to receive loaded system config values.
[in]	paramSource	Source of system configuration parameters: default or from NVM .dat file.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_NfcForumGetDiscParams()

ptxStatus_t ptxNSC_NfcForumGetDiscParams	(	struct ptxNSC *	nscCtx,
		struct ptxNSC_Discover_Param *	discoverParams )

Get discovery loop parameters for NFC-Forum.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in,out]	discoverParams	Pointer to discover parameters already allocated.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_NscCltMsg()

ptxStatus_t ptxNSC_NscCltMsg	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		uint8_t *	pldBytes,
		uint8_t *	pldParityBits,
		size_t	length )

Function used to send NSC Data Msg to the chip.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	pldBytes	Pointer to the payload bytes.
[in]	pldParityBits	Pointer to the parity bits (as bytes) of the payload bytes.
[in]	length	Length of /ref pldBytes and /ref pldParityBits.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_NscDataMsg()

ptxStatus_t ptxNSC_NscDataMsg	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		uint8_t *	payload,
		size_t	length,
		uint8_t	isChained )

Function used to send NSC Data Msg to the chip.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	payload	Pointer to the payload to be sent to the chip by NSC_DATA_MSG (CON_MSG).
[in]	length	Length of payload.
[in]	isChained	If 1 caller wants this data to be sent as chaining frame; If 0 not.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_NscDataMsg_GetMaxPayload()

size_t ptxNSC_NscDataMsg_GetMaxPayload

(

ptxNSC_t *

nscCtx

)

Get Maximum payload length that can be transmitted to the NSC component.

Parameters

[in]

nscCtx

Pointer to the component structure.

Returns

Max. number of bytes. 0 if error.

ptxNSC_NscResetCmd()

ptxStatus_t ptxNSC_NscResetCmd	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		ptxNSC_ResetCpuEn_t	cpuEn )

Function for NSC_RESET_CMD.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	cpuEn	Enable or disable the cpu after reset.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_NSCRfDeactivateCmd()

ptxStatus_t ptxNSC_NSCRfDeactivateCmd	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		ptxNSC_Rf_Deact_Param_t *	rfDeactParam )

Function for NSC_RF_DEACTIVATE_CMD.

This function builds the NSC_RF_DEACTIVATE_CMD and sendS it to the chip.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	rfDeactParam	Pointer to the rf Deactivation Parameters.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_PresCheck_IsoDep_EmptyBlock()

ptxStatus_t ptxNSC_PresCheck_IsoDep_EmptyBlock	(	struct ptxNSC *	nscCtx,
		struct ptxIoRq *	ioCpl )

ISO-DEP Presence Check (Empty Block).

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_PresCheck_IsoDep_Nack()

ptxStatus_t ptxNSC_PresCheck_IsoDep_Nack	(	struct ptxNSC *	nscCtx,
		struct ptxIoRq *	ioCpl )

ISO-DEP Presence Check (NACK).

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_PresCheck_NfcDep_AttentionCmd()

ptxStatus_t ptxNSC_PresCheck_NfcDep_AttentionCmd	(	struct ptxNSC *	nscCtx,
		struct ptxIoRq *	ioCpl )

ISO-DEP Presence Check (Attention Command).

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_RCA()

ptxStatus_t ptxNSC_RCA	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		uint16_t	regAddress,
		size_t	length )

NSC read continuous Address.

This function is used in the command path of a NSC RCA functionality. It is just used to push the completion functions as the communication with the chip is done on the completion path.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	regAddress	Memory Address to read from.
[in]	length	Number of bytes to read out.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_ReadCmd()

ptxStatus_t ptxNSC_ReadCmd	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		ptxNSC_ReadCmd_Par_t	nscReadPar )

Function used to build and send NSC_READ_CMD.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	nscReadPar	Valid address to read from.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_ReadSystemCfg()

ptxStatus_t ptxNSC_ReadSystemCfg	(	ptxNSC_t *	nscCtx,
		struct ptxNSC_System *	sysCfgParams )

Reads the current NSC System-Configuration parameters.

Parameters

[in]	nscCtx	Pointer to the component structure (already allocated and initialized).
[out]	sysCfgParams	Pointer to system-configuration structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_ReadTempSensor()

ptxStatus_t ptxNSC_ReadTempSensor	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl )

Function for internal temperature sensor readout.

If the operation completes successfully, readout value is stored in Nsc System parameters object.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_RegisterExtension()

ptxStatus_t ptxNSC_RegisterExtension	(	ptxNSC_t *	nscCtx,
		ptxNSC_Custom_Extension_t *	extension )

Register an NSC-Extension (Prototype/RFU).

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	extension	Pointer to Extension parameter structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_RfActivate()

ptxStatus_t ptxNSC_RfActivate	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		ptxNSC_RfActiv_Param_t *	actParams )

Function used to select card to activate when chip is Reader and there are more than one card on the field.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	actParams	Pointer to the structure of the Rf Activate parameters.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_RfConfig()

ptxStatus_t ptxNSC_RfConfig	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		ptxNSC_RfConfig_Param_t *	rfConfigParams )

Function used to build and send NSC_RF_CONFIG_REG.

Note

This function just sends Rf Parameters in Rf Config (Not routing Table).

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	rfConfigParams	Pointer to the Rf Config Parameters.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_RfConfig_NvmLoad()

ptxStatus_t ptxNSC_RfConfig_NvmLoad	(	ptxNSC_t *	nscCtx,
		ptxNSC_RfConfig_Param_t *	rfConfParams )

Function used to load RF-Config parameters from NVM to given parameter structure.

Note

This function just sends Rf Parameters in Rf Config (Not routing Table).

Parameters

[in]	nscCtx	Pointer to the component structure.
[out]	rfConfParams	Pointer to the Rf Config Parameters.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_RfSetParamsCmd()

ptxStatus_t ptxNSC_RfSetParamsCmd	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		ptxNsc_RfPar_t *	rfPar,
		size_t	rfParLen )

Function for NSC_RF_SET_PARAMETER_CMD.

This function builds the NSC_RF_SET_PARAMETER_CMD accordingly to inputParams and send it to the chip.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	rfPar	Pointer to array of Rf Params.
[in]	rfParLen	Length of /ref rfPar.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_RfTestRun()

ptxStatus_t ptxNSC_RfTestRun	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		ptxNsc_RfTest_Id_t	rfTestId,
		uint8_t *	rfTestParams,
		size_t	rfTestParamsLen )

Function for NSC_RF_RUN_CMD.

This function builds the NSC_RF_RUN_CMD accordingly to inputParams and send it to the chip.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	rfTestId	Test Identifier.
[in]	rfTestParams	Test Parameters.
[in]	rfTestParamsLen	Number of Test Parameters.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_RfTestStop()

ptxStatus_t ptxNSC_RfTestStop	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl )

Function for NSC_RF_STOP_CMD.

This function builds the NSC_RF_STOP_CMD accordingly to inputParams and send it to the chip.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_RRA()

ptxStatus_t ptxNSC_RRA	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		uint16_t	regAddress )

NSC Read Random Address (just read one byte)

This function is used in the command path of a NSC RRA functionality. It is just used to push the completion functions as the communication with the chip is done on the completion path.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	regAddress	Memory Address to write to.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_RRA_Multi()

ptxStatus_t ptxNSC_RRA_Multi	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		uint16_t *	addresses,
		size_t	numberOfAddresses )

NSC Read Random Address Multiple addresses to read from.

This function is used in the command path of a NSC RRA Multi functionality. It is just used to push the completion functions as the communication with the chip is done on the completion path.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	addresses	Buffer of addresses to read from.
[in]	numberOfAddresses	Length of addresses.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_SetDeactivateTimeout()

ptxStatus_t ptxNSC_SetDeactivateTimeout	(	struct ptxNSC *	nscCtx,
		uint32_t *	currentTimeout )

Function to set the current timeout value in [ms] to wait for a NSC.RF_DEACTIVATE_RSP.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	currentTimeout	Pointer to variable holding new timeout value. If set to NULL, default value will be used.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_SetGPIOMode()

ptxStatus_t ptxNSC_SetGPIOMode	(	struct ptxNSC *	nscCtx,
		struct ptxIoRq *	ioCpl,
		uint8_t	gpioNr,
		ptxNSC_GPIO_Mode_t	gpioMode,
		uint8_t	gpioFlags )

Configures a selected GPIO-pin to work as output, output or special function.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	gpioNr	GPIO number.
[in]	gpioMode	GPIO configuration (input, output, special function).
[in]	gpioFlags	GPIO flags (e.g. enable internal pull-up resistor).

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_SetGPIOOutput()

ptxStatus_t ptxNSC_SetGPIOOutput	(	struct ptxNSC *	nscCtx,
		struct ptxIoRq *	ioCpl,
		uint8_t	gpioNr,
		uint8_t	gpioValue )

Sets the selected GPIO-pin high or low.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	gpioNr	GPIO number.
[in]	gpioValue	Value to set (!= 0 = High, 0 = Low).

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_SetNrResidualTxBits()

ptxStatus_t ptxNSC_SetNrResidualTxBits	(	ptxNSC_t *	nscCtx,
		uint8_t	transparentModeEnabled,
		uint8_t	nrTxBits )

Enables or disables the NFC Type-A Transparent Mode and allows to set the number of residual Tx-bits if enabled.

Parameters

[in]	nscCtx	Pointer to an allocated and initialized structure.
[in]	transparentModeEnabled	Enables/Disables Type-A Transparent-Mode..
[in]	nrTxBits	Set number of residual Tx-bits if Type-A Transparent-Mode is enabled..

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_SetUcodeActive()

ptxStatus_t ptxNSC_SetUcodeActive

(

ptxNSC_t *

nscCtx

)

Set the uCode Image as Active.

Parameters

[in]

nscCtx

Pointer to the component structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_SetUcodeInactive()

ptxStatus_t ptxNSC_SetUcodeInactive

(

ptxNSC_t *

nscCtx

)

Set the uCode Image as Inactive.

Parameters

[in]

nscCtx

Pointer to the component structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_SoftReset()

ptxStatus_t ptxNSC_SoftReset	(	ptxNSC_t *	nscCtx,
		ptxNSC_SoftReset_t	setUpNsc )

Performs a Soft Reset on the NSC.

The result of the WRA of the soft Reset is uncertain. It is possible that the NSC does not acknowledge it properly as it is resetting itself.

Parameters

[in]	nscCtx	Pointer to the component structure (already allocated and initialized).
[in]	setUpNsc	Type of Soft Reset to be performed, defined in ptxNSC_SoftReset_t.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_StandbyCmd()

ptxStatus_t ptxNSC_StandbyCmd	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl )

NSC_STANDY_CMD.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_T5T_IsolatedEoF()

ptxStatus_t ptxNSC_T5T_IsolatedEoF	(	struct ptxNSC *	nscCtx,
		struct ptxIoRq *	ioCpl )

T5T Isolated EoF.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_WakeupCmd()

ptxStatus_t ptxNSC_WakeupCmd	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl )

NSC_WAKEUP_CMD.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_WCA()

ptxStatus_t ptxNSC_WCA	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		uint16_t	Address,
		uint8_t *	pData,
		size_t	length )

NSC WCA.

This function is used in the command path of a NSC WCA functionality. It is just used to push the completion functions as the communication with the chip is done on the completion path.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	Address	Starting address to write to the chip.
[in]	pData	Byte or bytes to write to the chip.
[in]	length	Number of bytes to be written to the chip.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_WRA()

ptxStatus_t ptxNSC_WRA	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		uint16_t	address,
		uint8_t	valueToWrite )

NSC WRA.

This function is used in the command path of a NSC WRA functionality. It is just used to push the completion functions as the communication with the chip is done on the completion path.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	address	Address to write to.
[in]	valueToWrite	VAlue to write to.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_WRAMulti()

ptxStatus_t ptxNSC_WRAMulti	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		ptxTypes_WRA_t *	pWRA,
		size_t	WRASize )

NSC WRA Multiple values.

This function is used in the command path of a NSC Multi WRA functionality. It is just used to push the completion functions as the communication with the chip is done on the completion path.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	pWRA	Buffer of WRA Objects.
[in]	WRASize	Number of WRA Objects in pWRA.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_WriteCmd()

ptxStatus_t ptxNSC_WriteCmd	(	ptxNSC_t *	nscCtx,
		struct ptxIoRq *	ioCpl,
		ptxNSC_WriteCmd_Par_t	nscWritePar )

Function used to build and send NSC_WRITE_CMD.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	ioCpl	Pointer to the I/O Completion structure.
[in]	nscWritePar	Parameter for the NSC_WRITE_CMD operation.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.

ptxNSC_WriteSystemCfg()

ptxStatus_t ptxNSC_WriteSystemCfg	(	ptxNSC_t *	nscCtx,
		struct ptxNSC_System *	sysCfgParams )

Writes NSC System-Configuration parameters.

Allows to set various system-configuration parameters like Power-Amplifier-settings etc. After setting the parameters, the a new call to NSC.INIT_CMD is required to apply updated settings.

Parameters

[in]	nscCtx	Pointer to the component structure (already allocated and initialized).
[in]	sysCfgParams	Pointer to system-configuration structure.

Returns

Status, indicating whether the operation was successful. See ptxStatus_t.