Native Tag T2T API

Collaboration diagram for Native Tag T2T API:

Data Structures
struct	ptxNativeTag_T2T_InitParams
	T2T Native Tag Initialization Parameters. More...
struct	ptxNativeTag_T2T
	T2T Native Tag Component. More...

Typedefs
typedef struct ptxNativeTag_T2T_InitParams	ptxNativeTag_T2T_InitParams_t
	T2T Native Tag Initialization Parameters.
typedef struct ptxNativeTag_T2T	ptxNativeTag_T2T_t
	T2T Native Tag Component.

Functions
ptxStatus_t	ptxNativeTag_T2TOpen (ptxNativeTag_T2T_t *t2tComp, ptxNativeTag_T2T_InitParams_t *initParams)
	Initialize / Open the T2T Native Tag Component.
ptxStatus_t	ptxNativeTag_T2TRead (ptxNativeTag_T2T_t *t2tComp, uint8_t blockNr, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
	Read the T2T blocks.
ptxStatus_t	ptxNativeTag_T2TWrite (ptxNativeTag_T2T_t *t2tComp, uint8_t blockNr, uint8_t *blockData, uint8_t blockDataLen, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
	Write to the T2T blocks.
ptxStatus_t	ptxNativeTag_T2TSectorSelect (ptxNativeTag_T2T_t *t2tComp, uint8_t secNr, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
	Select the T2T sector.
ptxStatus_t	ptxNativeTag_T2TClose (ptxNativeTag_T2T_t *t2tComp)
	Uninitialize / Close the T2T Native Tag Component.

T2T Tag specific definitions
#define	PTX_T2T_MIN_TX_BUFFER_SIZE   (uint32_t)32
#define	PTX_T2T_BLOCK_SIZE   (uint8_t)4

Detailed Description

Macro Definition Documentation

PTX_T2T_BLOCK_SIZE

#define PTX_T2T_BLOCK_SIZE   (uint8_t)4

T2T memory block size

PTX_T2T_MIN_TX_BUFFER_SIZE

#define PTX_T2T_MIN_TX_BUFFER_SIZE   (uint32_t)32

Internal work-buffer size for transmissions.

Function Documentation

ptxNativeTag_T2TClose()

ptxStatus_t ptxNativeTag_T2TClose

(

ptxNativeTag_T2T_t *

t2tComp

)

Uninitialize / Close the T2T Native Tag Component.

Parameters

[in]

t2tComp

Pointer to an initialized instance of the T2T component.

Returns

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

ptxNativeTag_T2TOpen()

ptxStatus_t ptxNativeTag_T2TOpen	(	ptxNativeTag_T2T_t *	t2tComp,
		ptxNativeTag_T2T_InitParams_t *	initParams )

Initialize / Open the T2T Native Tag Component.

Parameters

[in]	t2tComp	Pointer to an allocated instance of the T2T component.
[in]	initParams	Pointer to initialization parameters.

Returns

Status, indicating whether the operation was successful.

ptxNativeTag_T2TRead()

ptxStatus_t ptxNativeTag_T2TRead	(	ptxNativeTag_T2T_t *	t2tComp,
		uint8_t	blockNr,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Read the T2T blocks.

Parameters

[in]	t2tComp	Pointer to an initialized instance of the T2T component.
[in]	blockNr	Block number to be read (within sector).
[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_T2TSectorSelect()

ptxStatus_t ptxNativeTag_T2TSectorSelect	(	ptxNativeTag_T2T_t *	t2tComp,
		uint8_t	secNr,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Select the T2T sector.

Parameters

[in]	t2tComp	Pointer to an initialized instance of the T2T component.
[in]	secNr	Sector number to be used (default sector is 0).
[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_T2TWrite()

ptxStatus_t ptxNativeTag_T2TWrite	(	ptxNativeTag_T2T_t *	t2tComp,
		uint8_t	blockNr,
		uint8_t *	blockData,
		uint8_t	blockDataLen,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Write to the T2T blocks.

Parameters

[in]	t2tComp	Pointer to an initialized instance of the T2T component.
[in]	blockNr	Block number to be written (within sector).
[in]	blockData	Data to write.
[in]	blockDataLen	Length of data to write.
[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.