Definitions

Collaboration diagram for Definitions:

Typedefs
typedef uint16_t	ptxStatus_t
	Status Type.
typedef enum ptxStatus_Values	ptxStatus_Values_t
	Status Code Definitions.
typedef enum ptxStatus_Comps	ptxStatus_Comps_t
	Component Definitions.

Enumerations
enum	ptxStatus_Values {   ptxStatus_Success_Internal , ptxStatus_Pending , ptxStatus_InternalError , ptxStatus_Cancelled ,   ptxStatus_NotImplemented , ptxStatus_IOTimeOut , ptxStatus_InsufficientResources , ptxStatus_WrongFwImage ,   ptxStatus_InterfaceError , ptxStatus_CompletionError , ptxStatus_SysErrOvertemperature , ptxStatus_SysErrOvercurrent ,   ptxStatus_NotSupported , ptxStatus_Reserved_0x0D , ptxStatus_Reserved_0x0E , ptxStatus_Reserved_0x0F ,   ptxStatus_InvalidParameter , ptxStatus_NotPermitted , ptxStatus_NotFound , ptxStatus_AccessDenied ,   ptxStatus_IOError , ptxStatus_InvalidState , ptxStatus_ACKError , ptxStatus_BufferTooSmall ,   ptxStatus_Reserved_0x18 , ptxStatus_IOD2xxError , ptxStatus_Reserved_0x1A , ptxStatus_Reserved_0x1B ,   ptxStatus_Reserved_0x1C , ptxStatus_Reserved_0x1D , ptxStatus_Reserved_0x1E , ptxStatus_Reserved_0x1F ,   ptxStatus_NscProtocolError , ptxStatus_NscInternalError , ptxStatus_NscRfError , ptxStatus_NscSwpActFailed ,   ptxStatus_NscSwpIdentityError , ptxStatus_NscSwpDeactError , ptxStatus_Reserved_0x26 , ptxStatus_NscUnknownEvent ,   ptxStatus_Reserved_28 , ptxStatus_None , ptxStatus_Reserved_0x2A , ptxStatus_Reserved_0x2B ,   ptxStatus_PSLQMeas_LowerCornerFrequencyNotFound , ptxStatus_PSLQMeas_UpperCornerFrequencyNotFound , ptxStatus_IgnoreNciPacket , ptxStatus_AssertionError ,   ptxStatus_HciPipeNotOpen , ptxStatus_HciRfParamNotWritten , ptxStatus_ProtocolError , ptxStatus_ResourceNotFound ,   ptxStatus_MFCC_NAK_Received , ptxStatus_MFCC_AUTHENT_Failed , ptxStatus_T3T_WriteFlagSet , ptxStatus_NoDataAvailable ,   ptxStatus_MAX }
	Status Code Definitions. More...
enum	ptxStatus_Comps {   ptxStatus_Comp_None , ptxStatus_Comp_IO , ptxStatus_Comp_NSC , ptxStatus_Comp_NCI ,   ptxStatus_Comp_Factory , ptxStatus_Comp_IORQ , ptxStatus_Comp_FIFO , ptxStatus_Comp_INTEGRATION ,   ptxStatus_Comp_OSAL , ptxStatus_Comp_HAL , ptxStatus_Comp_Reserved_10 , ptxStatus_Comp_Reserved_11 ,   ptxStatus_Comp_Reserved_12 , ptxStatus_Comp_Reserved_13 , ptxStatus_Comp_Reserved_14 , ptxStatus_Comp_Reserved_15 ,   ptxStatus_Comp_LOG , ptxStatus_Comp_HCI , ptxStatus_Comp_EMV , ptxStatus_Comp_Light_Integration ,   ptxStatus_Comp_BUFFER , ptxStatus_Comp_IFD , ptxStatus_Comp_REMOTE , ptxStatus_Comp_IO_LPC ,   ptxStatus_Comp_NVM , ptxStatus_Comp_BlockMngr , ptxStatus_Comp_Reserved_26 , ptxStatus_Comp_Reserved_27 ,   ptxStatus_Comp_Reserved_28 , ptxStatus_Comp_Reserved_29 , ptxStatus_Comp_Reserved_30 , ptxStatus_Comp_Reserved_31 ,   ptxStatus_Comp_Instrument , ptxStatus_Comp_Counterpart , ptxStatus_Comp_HAL_HIF , ptxStatus_Comp_FileMngr ,   ptxStatus_Comp_AOSP_INT , ptxStatus_Comp_IO_FTDXX , ptxStatus_Comp_POS , ptxStatus_Comp_Apdu ,   ptxStatus_Comp_IoTReader , ptxStatus_Comp_Support , ptxStatus_Comp_NciReader , ptxStatus_Comp_TFCI ,   ptxStatus_Comp_Reserved_44 , ptxStatus_Comp_Reserved_45 , ptxStatus_Comp_Reserved_46 , ptxStatus_Comp_Reserved_47 ,   ptxStatus_Comp_WPC_Factory , ptxStatus_Comp_WPC_NfcLink , ptxStatus_Comp_WPC_Pal , ptxStatus_Comp_WPC_Int ,   ptxStatus_Comp_Reserved_52 , ptxStatus_Comp_Reserved_53 , ptxStatus_Comp_Reserved_54 , ptxStatus_Comp_Reserved_55 ,   ptxStatus_Comp_Reserved_56 , ptxStatus_Comp_Reserved_57 , ptxStatus_Comp_Reserved_58 , ptxStatus_Comp_NativeTag_T2T ,   ptxStatus_Comp_NativeTag_T3T , ptxStatus_Comp_NativeTag_T4T , ptxStatus_Comp_NativeTag_T5T , ptxStatus_Comp_NativeTag_MFCC ,   ptxStatus_Comp_Reserved_59 , ptxStatus_Comp_T2TOP , ptxStatus_Comp_T3TOP , ptxStatus_Comp_T4TOP ,   ptxStatus_Comp_T5TOP , ptxStatus_Comp_NDEF , ptxStatus_Comp_GPIO , ptxStatus_Comp_FELICA_DTE ,   ptxStatus_Comp_RF_TEST , ptxStatus_Comp_FELICA , ptxStatus_Comp_HCE , ptxStatus_Comp_TransparentMode ,   ptxStatus_Comp_TDC , ptxStatus_Comp_EXT , ptxStatus_Comp_MAX }
	Component Definitions. More...

Status Code Composition and Decomposition
#define	PTX_STATUS(_comp_, _st_)   ((ptxStatus_t)((((ptxStatus_t)((uint16_t)_comp_))<<8)|((ptxStatus_t)(((uint16_t)_st_)&0xFFu)))) /* */
#define	PTX_GET_COMP(_cst_)   ((ptxStatus_Comps_t)((uint8_t)((_cst_)>>8))) /* */
#define	PTX_GET_STATUS(_cst_)   ((ptxStatus_Values_t)((uint8_t)((_cst_)))) /* */
#define	ptxStatus_Success   PTX_STATUS(ptxStatus_Comp_None,ptxStatus_Success_Internal) /* */

Component check
#define	PTX_COMP_CHECK(ptx_p_ctx, ptx_p_comp_id_)    ((NULL!=ptx_p_ctx)&&(ptx_p_comp_id_==ptx_p_ctx->CompId)) /* */
	Check whether the component is not NULL and actually what is appears to be.

Detailed Description

Macro Definition Documentation

PTX_GET_COMP

#define PTX_GET_COMP

(

_cst_

)

((ptxStatus_Comps_t)((uint8_t)((_cst_)>>8))) /* */

Get component ID from a combined status value.

PTX_GET_STATUS

#define PTX_GET_STATUS

(

_cst_

)

((ptxStatus_Values_t)((uint8_t)((_cst_)))) /* */

Get status code from a combined status value.

PTX_STATUS

#define PTX_STATUS	(		_comp_,
			_st_ )   ((ptxStatus_t)((((ptxStatus_t)((uint16_t)_comp_))<<8)|((ptxStatus_t)(((uint16_t)_st_)&0xFFu)))) /* */

Put together component ID and status into one value.

Note

Use only for status values not equal to ptxStatus_Success.

ptxStatus_Success

#define ptxStatus_Success   PTX_STATUS(ptxStatus_Comp_None,ptxStatus_Success_Internal) /* */

Status value composition for SUCCESSFUL operation.

Typedef Documentation

ptxStatus_Comps_t

typedef enum ptxStatus_Comps ptxStatus_Comps_t

Component Definitions.

Common usage of component definitions: => Create ptxStatus_t type => Inside function calls with PTX_COMP_CHECK to check that component is not NULL and that it is set as expected i.e. properly initialized.

ptxStatus_t

typedef uint16_t ptxStatus_t

Status Type.

INTERFACE

Status of the operation consists of 2 parts: component ID ptxStatus_Comps_t and status code ptxStatus_Values_t. Component ID defines which stack component is the owner of the operation. Status code holds actual operation result/status information.

Enumeration Type Documentation

ptxStatus_Comps

enum ptxStatus_Comps

Component Definitions.

Common usage of component definitions: => Create ptxStatus_t type => Inside function calls with PTX_COMP_CHECK to check that component is not NULL and that it is set as expected i.e. properly initialized.

Enumerator
ptxStatus_Comp_None	No component specified.
ptxStatus_Comp_IO	I/O Component.
ptxStatus_Comp_NSC	NSC layer.
ptxStatus_Comp_NCI	NCI layer.
ptxStatus_Comp_Factory	Factory; Stack Initializer.
ptxStatus_Comp_IORQ	IORQ: Handler of the LIFO.
ptxStatus_Comp_FIFO	FIFO: Handler of the FIFO.
ptxStatus_Comp_INTEGRATION	Integration of all components.
ptxStatus_Comp_OSAL	OSAL Component.
ptxStatus_Comp_HAL	HAL Component.
ptxStatus_Comp_Reserved_10	Don't use. Reserved value.
ptxStatus_Comp_Reserved_11	Don't use. Reserved value.
ptxStatus_Comp_Reserved_12	Don't use. Reserved value.
ptxStatus_Comp_Reserved_13	Don't use. Reserved value.
ptxStatus_Comp_Reserved_14	Don't use. Reserved value.
ptxStatus_Comp_Reserved_15	Don't use. Reserved value.
ptxStatus_Comp_LOG	Logger Component.
ptxStatus_Comp_HCI	HCI Component.
ptxStatus_Comp_EMV	EMV Component
ptxStatus_Comp_Light_Integration	Light Integration Component
ptxStatus_Comp_BUFFER	Buffer
ptxStatus_Comp_IFD	Interface device, generic
ptxStatus_Comp_REMOTE	Remote Interface
ptxStatus_Comp_IO_LPC	LPC Subcomponent in IO Component.
ptxStatus_Comp_NVM	NVM Component
ptxStatus_Comp_BlockMngr	Block Manager, used to manage flash memory
ptxStatus_Comp_Reserved_26	Don't use. Reserved value.
ptxStatus_Comp_Reserved_27	Don't use. Reserved value.
ptxStatus_Comp_Reserved_28	Don't use. Reserved value.
ptxStatus_Comp_Reserved_29	Don't use. Reserved value.
ptxStatus_Comp_Reserved_30	Don't use. Reserved value.
ptxStatus_Comp_Reserved_31	Don't use. Reserved value.
ptxStatus_Comp_Instrument	Instrument
ptxStatus_Comp_Counterpart	Counterpart component
ptxStatus_Comp_HAL_HIF	HAL for Host Interface on the microcontroller
ptxStatus_Comp_FileMngr	File Manager, used to manage flash memory
ptxStatus_Comp_AOSP_INT	Component ID used for AOSP.
ptxStatus_Comp_IO_FTDXX	FTD2XX Subcomponent in IO Component.
ptxStatus_Comp_POS	POS Component
ptxStatus_Comp_Apdu	APDU Component
ptxStatus_Comp_IoTReader	IoT Reader
ptxStatus_Comp_Support	Support(-Library)
ptxStatus_Comp_NciReader	NCI (2.0) Reader
ptxStatus_Comp_TFCI	TFCI Framework
ptxStatus_Comp_Reserved_44	Don't use. Reserved value.
ptxStatus_Comp_Reserved_45	Don't use. Reserved value.
ptxStatus_Comp_Reserved_46	Don't use. Reserved value.
ptxStatus_Comp_Reserved_47	Don't use. Reserved value.
ptxStatus_Comp_WPC_Factory	WPC Stack; Factory.
ptxStatus_Comp_WPC_NfcLink	WPC Stack; NFC-Link Component.
ptxStatus_Comp_WPC_Pal	WPC Stack; Protocol Abstraction Layer.
ptxStatus_Comp_WPC_Int	INT Stack; Integration Layer.
ptxStatus_Comp_Reserved_52	Free
ptxStatus_Comp_Reserved_53	Free
ptxStatus_Comp_Reserved_54	Free
ptxStatus_Comp_Reserved_55	Free
ptxStatus_Comp_Reserved_56	Free
ptxStatus_Comp_Reserved_57	Free
ptxStatus_Comp_Reserved_58	Free
ptxStatus_Comp_NativeTag_T2T	T2T Native Tag
ptxStatus_Comp_NativeTag_T3T	T3T Native Tag
ptxStatus_Comp_NativeTag_T4T	T4T Native Tag
ptxStatus_Comp_NativeTag_T5T	T5T Native Tag
ptxStatus_Comp_NativeTag_MFCC	Mifare Classic Compatibility Native Tag
ptxStatus_Comp_Reserved_59	Free
ptxStatus_Comp_T2TOP	T2T Operation Component
ptxStatus_Comp_T3TOP	T3T Operation Component
ptxStatus_Comp_T4TOP	T4T Operation Component
ptxStatus_Comp_T5TOP	T5T Operation Component
ptxStatus_Comp_NDEF	NDEF Component
ptxStatus_Comp_GPIO	GPIO Component
ptxStatus_Comp_FELICA_DTE	FELICA-DTE Component
ptxStatus_Comp_RF_TEST	RF-TEST Component
ptxStatus_Comp_FELICA	FELICA Component (RFU)
ptxStatus_Comp_HCE	Host-Card-Emulation (HCE) Component
ptxStatus_Comp_TransparentMode	Transparent-Mode Component
ptxStatus_Comp_TDC	Transparent Data Channel (TDC)Component
ptxStatus_Comp_EXT	Extension Components (Prototype)
ptxStatus_Comp_MAX	Maximum count.

ptxStatus_Values

enum ptxStatus_Values

Status Code Definitions.

Enumerator
ptxStatus_Pending	The operation was initiated successfully but is still ongoing (asynchronously).
ptxStatus_InternalError	There has been internal error in the function processing
ptxStatus_Cancelled	The processing has been cancelled.
ptxStatus_NotImplemented	The function/command is not implemented.
ptxStatus_IOTimeOut	The I/O operation has timed out.
ptxStatus_InsufficientResources	Insufficient resources available to complete the request; e.g. out of memory.
ptxStatus_WrongFwImage	The firmware image format is not correct (e.g. corrupted).
ptxStatus_InterfaceError	The interface (I/O line, UART, ...) is not accessible or an error has occurred.
ptxStatus_CompletionError	Error related to completion mechanism itself.
ptxStatus_SysErrOvertemperature	System-Error: Over-Temperature
ptxStatus_SysErrOvercurrent	System-Error: Over-Current
ptxStatus_NotSupported	Feature not supported / allowed in particular scenario
ptxStatus_Reserved_0x0D	Don't use. Value reserved
ptxStatus_Reserved_0x0E	Don't use. Value reserved
ptxStatus_Reserved_0x0F	Don't use. Value reserved
ptxStatus_InvalidParameter	The caller has provided invalid value(s) for function parameter(s).
ptxStatus_NotPermitted	The operation is not permitted. Use rather for state-related than access rights related cases.
ptxStatus_NotFound	Entry not found, e.g.: "No such file or directory".
ptxStatus_AccessDenied	No access to the resource. Use rather for access-rights related cases.
ptxStatus_IOError	An I/O error has occurred.
ptxStatus_InvalidState	The component state is invalid or the operation requested cannot be performed in the current state.
ptxStatus_ACKError	The request has not been acknowledged or a negative Acknowledge response was received.
ptxStatus_BufferTooSmall	Free
ptxStatus_Reserved_0x18	Don't use. Value reserved
ptxStatus_IOD2xxError	Error in communication to USB-Serial converter in D2xx Mode.
ptxStatus_Reserved_0x1A	Don't use. Reserved value.
ptxStatus_Reserved_0x1B	Don't use. Reserved value.
ptxStatus_Reserved_0x1C	Don't use. Reserved value.
ptxStatus_Reserved_0x1D	Don't use. Reserved value.
ptxStatus_Reserved_0x1E	Don't use. Reserved value.
ptxStatus_Reserved_0x1F	Don't use. Reserved value.
ptxStatus_NscProtocolError	Error at NSC protocol
ptxStatus_NscInternalError	Internal error has been reported from chip when trying to perform some action
ptxStatus_NscRfError	RF-Error
ptxStatus_NscSwpActFailed	SWP Activation process failed.
ptxStatus_NscSwpIdentityError	Identity check failed during the SWP activation process.
ptxStatus_NscSwpDeactError	Error during the SWP de-activation process.
ptxStatus_Reserved_0x26	Don't use. Reserved value.
ptxStatus_NscUnknownEvent	Unknown (RF-)Event reported by NSC
ptxStatus_Reserved_28	Free
ptxStatus_None	If assignment has gone wrong. DO NOT USE this value.
ptxStatus_Reserved_0x2A	Don't use. Reserved value.
ptxStatus_Reserved_0x2B	Don't use. Reserved value.
ptxStatus_PSLQMeas_LowerCornerFrequencyNotFound	PSL - QMeasurement: Lower 3dB Corner Frequency not found
ptxStatus_PSLQMeas_UpperCornerFrequencyNotFound	PSL - QMeasurement: Upper 3dB Corner Frequency not found
ptxStatus_IgnoreNciPacket	NCI CMD- or DATA-packet from the DH which shall be ignored by the NFCC
ptxStatus_AssertionError	An assertion has failed.
ptxStatus_HciPipeNotOpen	Pipe is not open.
ptxStatus_HciRfParamNotWritten	RF parameters are not set.(e.g. MODE is no in enabled state.)
ptxStatus_ProtocolError	General Protocol Error
ptxStatus_ResourceNotFound	Requested information or resource not available
ptxStatus_MFCC_NAK_Received	NAK-received in MFCC-mode
ptxStatus_MFCC_AUTHENT_Failed	Authentication failed in MFCC-mode
ptxStatus_T3T_WriteFlagSet	Write flag set to ON while trying to read
ptxStatus_NoDataAvailable	No data available in HCE event queue
ptxStatus_MAX	Maximum count.