Native Tag T3T API

Collaboration diagram for Native Tag T3T API:

Data Structures
struct	ptxNativeTag_T3T_MRTI
	MRTI parameters. More...
struct	ptxNativeTag_T3T_Services
	Service Code List parameters. More...
struct	ptxNativeTag_T3T_Blocks
	Block List parameters. More...
struct	ptxNativeTag_T3T_InitParams
	T3T Native Tag Initialization Parameters. More...
struct	ptxNativeTag_T3T
	T3T Native Tag Component. More...

Typedefs
typedef struct ptxNativeTag_T3T_MRTI	ptxNativeTag_T3T_MRTI_t
	MRTI parameters.
typedef struct ptxNativeTag_T3T_Services	ptxNativeTag_T3T_Services_t
	Service Code List parameters.
typedef struct ptxNativeTag_T3T_Blocks	ptxNativeTag_T3T_Blocks_t
	Block List parameters.
typedef struct ptxNativeTag_T3T_InitParams	ptxNativeTag_T3T_InitParams_t
	T3T Native Tag Initialization Parameters.
typedef struct ptxNativeTag_T3T	ptxNativeTag_T3T_t
	T3T Native Tag Component.

Functions
ptxStatus_t	ptxNativeTag_T3TOpen (ptxNativeTag_T3T_t *t3tComp, ptxNativeTag_T3T_InitParams_t *initParams)
	Component Initialization.
ptxStatus_t	ptxNativeTag_T3TClose (ptxNativeTag_T3T_t *t3tComp)
	Component De-Initialization.
ptxStatus_t	ptxNativeTag_T3TSENSF_REQ (ptxNativeTag_T3T_t *t3tComp, uint16_t sc, uint8_t rc, uint8_t tsn, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
	T3T SENSF_REQ Command, Detect Tag and NDEF Support.
ptxStatus_t	ptxNativeTag_T3TCheck (ptxNativeTag_T3T_t *t3tComp, uint8_t *NFCID2, size_t NFCID2Len, ptxNativeTag_T3T_Services_t serviceInfo, ptxNativeTag_T3T_Blocks_t blockInfo, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
	T3T Check Command.
ptxStatus_t	ptxNativeTag_T3TUpdate (ptxNativeTag_T3T_t *t3tComp, uint8_t *NFCID2, size_t NFCID2Len, ptxNativeTag_T3T_Services_t serviceInfo, ptxNativeTag_T3T_Blocks_t blockInfo, uint8_t *blockData, uint8_t blockDataLen, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
	T3T Update Command.
ptxStatus_t	ptxNativeTag_T3TSetTagParams (ptxNativeTag_T3T_t *t3tComp, uint8_t *NFCID2, uint8_t NFCID2Len, ptxNativeTag_T3T_MRTI_t mrtiInfo)
	Sets / Updates the NFCID2 to be used.

T3T Tag specific definitions
#define	PTX_T3T_MIN_TX_BUFFER_SIZE   (uint32_t)256
#define	PTX_T3T_NFCID2_SIZE   (uint8_t)8

Detailed Description

Macro Definition Documentation

PTX_T3T_MIN_TX_BUFFER_SIZE

#define PTX_T3T_MIN_TX_BUFFER_SIZE   (uint32_t)256

T3T minimum Tx buffer size

PTX_T3T_NFCID2_SIZE

#define PTX_T3T_NFCID2_SIZE   (uint8_t)8

T3T NFCID2 size

Function Documentation

ptxNativeTag_T3TCheck()

ptxStatus_t ptxNativeTag_T3TCheck	(	ptxNativeTag_T3T_t *	t3tComp,
		uint8_t *	NFCID2,
		size_t	NFCID2Len,
		ptxNativeTag_T3T_Services_t	serviceInfo,
		ptxNativeTag_T3T_Blocks_t	blockInfo,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

T3T Check Command.

Parameters

[in]	t3tComp	Pointer to an initialized instance of the T3T component.
[in]	NFCID2	ID to address the T3T tag.
[in]	NFCID2Len	Length of ID.
[in]	serviceInfo	Information about Services to be updated.
[in]	blockInfo	information about Blocks to be updated.
[out]	rx	Pointer to Rx-buffer where the received data from the card shall be stored.
[in,out]	rxLen	Size of Rx-buffer (in), Length of the received data (out).
[in]	msTimeout	Timeout in ms that the function is going to wait for receiving data from the card.

Returns

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

ptxNativeTag_T3TClose()

ptxStatus_t ptxNativeTag_T3TClose

(

ptxNativeTag_T3T_t *

t3tComp

)

Component De-Initialization.

Parameters

[in]

t3tComp

Pointer to an initialized instance of the T3T component.

Returns

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

ptxNativeTag_T3TOpen()

ptxStatus_t ptxNativeTag_T3TOpen	(	ptxNativeTag_T3T_t *	t3tComp,
		ptxNativeTag_T3T_InitParams_t *	initParams )

Component Initialization.

Parameters

[in]	t3tComp	Pointer to an allocated instance of the T3T component.
[in]	initParams	Pointer to initialization parameters.

Returns

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

ptxNativeTag_T3TSENSF_REQ()

ptxStatus_t ptxNativeTag_T3TSENSF_REQ	(	ptxNativeTag_T3T_t *	t3tComp,
		uint16_t	sc,
		uint8_t	rc,
		uint8_t	tsn,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

T3T SENSF_REQ Command, Detect Tag and NDEF Support.

Parameters

[in]	t3tComp	Pointer to an initialized instance of the T3T component.
[in]	sc	System code of the NFC forum device to be polled for.
[in]	rc	Request code for additional information in the SENSF_RES.
[in]	tsn	Time slot number, used for collision resolution.
[out]	rx	Pointer to Rx-buffer where the received data from the card shall be stored.
[in,out]	rxLen	Size of Rx-buffer (in), Length of the received data (out).
[in]	msTimeout	Timeout in ms that the function is going to wait for receiving data from the card.

Returns

Status, indicating whether the operation was successful.

ptxNativeTag_T3TSetTagParams()

ptxStatus_t ptxNativeTag_T3TSetTagParams	(	ptxNativeTag_T3T_t *	t3tComp,
		uint8_t *	NFCID2,
		uint8_t	NFCID2Len,
		ptxNativeTag_T3T_MRTI_t	mrtiInfo )

Sets / Updates the NFCID2 to be used.

Parameters

[in]	t3tComp	Pointer to an initialized instance of the T3T component.
[in]	NFCID2	Pointer to NFCID2 of the given Tag.
[in]	NFCID2Len	Length of NFCID2.
[in]	mrtiInfo	Information about MRTI Times of the T3T.

Returns

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

ptxNativeTag_T3TUpdate()

ptxStatus_t ptxNativeTag_T3TUpdate	(	ptxNativeTag_T3T_t *	t3tComp,
		uint8_t *	NFCID2,
		size_t	NFCID2Len,
		ptxNativeTag_T3T_Services_t	serviceInfo,
		ptxNativeTag_T3T_Blocks_t	blockInfo,
		uint8_t *	blockData,
		uint8_t	blockDataLen,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

T3T Update Command.

Parameters

[in]	t3tComp	Pointer to an initialized instance of the T3T component.
[in]	NFCID2	ID to address the T3T tag.
[in]	NFCID2Len	Length of ID.
[in]	serviceInfo	Information about Services to be updated.
[in]	blockInfo	Information about Blocks to be updated.
[in]	blockData	Data to be written to the blocks.
[in]	blockDataLen	Length of the data to be written to the blocks.
[out]	rx	Pointer to Rx-buffer where the received data from the card shall be stored.
[in,out]	rxLen	Size of Rx-buffer (in), Length of the received data (out).
[in]	msTimeout	Timeout in ms that the function is going to wait for receiving data from the card.

Returns

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