Collaboration diagram for Native Tag T5T API:

Data Structures
struct	ptxNativeTag_T5T_InitParams
	T5T Native Tag Initialization Parameters. More...

struct	ptxNativeTag_T5T
	T5T Native Tag Component. More...

Typedefs
typedef struct ptxNativeTag_T5T_InitParams	ptxNativeTag_T5T_InitParams_t
	T5T Native Tag Initialization Parameters.

typedef struct ptxNativeTag_T5T	ptxNativeTag_T5T_t
	T5T Native Tag Component.

Functions
PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TOpen (ptxNativeTag_T5T_t t5tComp, ptxNativeTag_T5T_InitParams_t initParams)
	Initialize / Open the T5T Native Tag Component.

PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TReadSingleBlock (ptxNativeTag_T5T_t t5tComp, uint8_t optionFlag, uint8_t blockNr, uint8_t rx, size_t *rxLen, uint32_t msTimeout)
	Performs a READ_SINGLE_BLOCK_REQ-command.

PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TWriteSingleBlock (ptxNativeTag_T5T_t t5tComp, uint8_t optionFlag, uint8_t blockNr, uint8_t blockData, uint8_t blockDataLen, uint8_t rx, size_t rxLen, uint32_t msTimeout)
	Performs a WRITE_SINGLE_BLOCK_REQ-command.

PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TLockSingleBlock (ptxNativeTag_T5T_t t5tComp, uint8_t optionFlag, uint8_t blockNr, uint8_t rx, size_t *rxLen, uint32_t msTimeout)
	Performs a LOCK_SINGLE_BLOCK_REQ-command.

PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TReadMultipleBlock (ptxNativeTag_T5T_t t5tComp, uint8_t optionFlag, uint8_t blockNr, uint8_t nrBlocks, uint8_t rx, size_t *rxLen, uint32_t msTimeout)
	Performs a READ_MUTLIPLE_BLOCK_REQ-command.

PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TExtReadSingleBlock (ptxNativeTag_T5T_t t5tComp, uint8_t optionFlag, uint16_t blockNr, uint8_t rx, size_t *rxLen, uint32_t msTimeout)
	Performs a EXTENDED_READ_SINGLE_BLOCK_REQ-command.

PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TExtWriteSingleBlock (ptxNativeTag_T5T_t t5tComp, uint8_t optionFlag, uint16_t blockNr, uint8_t blockData, uint8_t blockDataLen, uint8_t rx, size_t rxLen, uint32_t msTimeout)
	Performs a EXTENDED_WRITE_SINGLE_BLOCK_REQ-command.

PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TExtLockSingleBlock (ptxNativeTag_T5T_t t5tComp, uint8_t optionFlag, uint16_t blockNr, uint8_t rx, size_t *rxLen, uint32_t msTimeout)
	Performs a EXTENDED_LOCK_SINGLE_BLOCK_REQ-command.

PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TExtReadMultipleBlock (ptxNativeTag_T5T_t t5tComp, uint8_t optionFlag, uint16_t blockNr, uint16_t nrBlocks, uint8_t rx, size_t *rxLen, uint32_t msTimeout)
	Performs a EXTENDED_READ_MUTLIPLE_BLOCK_REQ-command.

PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TSelect (ptxNativeTag_T5T_t t5tComp, uint8_t optionFlag, uint8_t uid, uint8_t uidLen, uint8_t rx, size_t rxLen, uint32_t msTimeout)
	Performs a SELECT_REQ-command.

PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TSleep (ptxNativeTag_T5T_t t5tComp, uint8_t optionFlag, uint8_t uid, uint8_t uidLen, uint8_t rx, size_t rxLen, uint32_t msTimeout)
	Performs a SELECT_REQ-command.

PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TSetUID (ptxNativeTag_T5T_t t5tComp, uint8_t uid, uint8_t uidLen)
	Sets / Updates the UID to be used (needs to be called after "ptxNativeTag_T5TSelect() is called and addressed-mode shall be used").

PTX_API_LIBFUNC ptxStatus_t	ptxNativeTag_T5TClose (ptxNativeTag_T5T_t *t5tComp)
	Unitialize / Close the T5T Native Tag Component.

T5T Tag specific definitions.
#define	PTX_T5T_UID_SIZE (uint8_t)8

#define	PTX_T5T_MIN_TX_BUFFER_SIZE (uint32_t)64

#define	PTX_T5T_MAX_NR_RETRIES (uint8_t)5

Detailed Description

Macro Definition Documentation

◆ PTX_T5T_MAX_NR_RETRIES

#define PTX_T5T_MAX_NR_RETRIES (uint8_t)5

T5T specific Retry Count upon timeout errors for read and write commands.

◆ PTX_T5T_MIN_TX_BUFFER_SIZE

#define PTX_T5T_MIN_TX_BUFFER_SIZE (uint32_t)64

T5T specific Minimum Tx Buffer size

◆ PTX_T5T_UID_SIZE

#define PTX_T5T_UID_SIZE (uint8_t)8

T5T specific UID Size

Function Documentation

◆ ptxNativeTag_T5TClose()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TClose ( ptxNativeTag_T5T_t * t5tComp )

Unitialize / Close the T5T Native Tag Component.

Parameters

[in] t5tComp Pointer to an initialized instance of the T5T component.

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

◆ ptxNativeTag_T5TExtLockSingleBlock()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TExtLockSingleBlock	(	ptxNativeTag_T5T_t *	t5tComp,
		uint8_t	optionFlag,
		uint16_t	blockNr,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Performs a EXTENDED_LOCK_SINGLE_BLOCK_REQ-command.

Parameters

[in]	t5tComp	Pointer to an initialized instance of the T5T component.
[in]	optionFlag	Option-flag provided by upper layer ("Use Special-Framing"-format for Write-alike commands).
[in]	blockNr	Number of block to lock.
[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_T5TExtReadMultipleBlock()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TExtReadMultipleBlock	(	ptxNativeTag_T5T_t *	t5tComp,
		uint8_t	optionFlag,
		uint16_t	blockNr,
		uint16_t	nrBlocks,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Performs a EXTENDED_READ_MUTLIPLE_BLOCK_REQ-command.

Parameters

[in]	t5tComp	Pointer to an initialized instance of the T5T component.
[in]	optionFlag	Option-flag provided by upper layer ("Request Block Security Status" for Read-alike commands).
[in]	blockNr	Number of start-block.
[in]	nrBlocks	Number of blocks to read.
[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_T5TExtReadSingleBlock()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TExtReadSingleBlock	(	ptxNativeTag_T5T_t *	t5tComp,
		uint8_t	optionFlag,
		uint16_t	blockNr,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Performs a EXTENDED_READ_SINGLE_BLOCK_REQ-command.

Parameters

[in]	t5tComp	Pointer to an initialized instance of the T5T component.
[in]	optionFlag	Option-flag provided by upper layer ("Request Block Security Status" for Read-alike commands).
[in]	blockNr	Number of block to read.
[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_T5TExtWriteSingleBlock()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TExtWriteSingleBlock	(	ptxNativeTag_T5T_t *	t5tComp,
		uint8_t	optionFlag,
		uint16_t	blockNr,
		uint8_t *	blockData,
		uint8_t	blockDataLen,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Performs a EXTENDED_WRITE_SINGLE_BLOCK_REQ-command.

Parameters

[in]	t5tComp	Pointer to an initialized instance of the T5T component.
[in]	optionFlag	Option-flag provided by upper layer ("Use Special-Framing"-format for Write-alike commands).
[in]	blockNr	Number of block to write.
[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. See ptxStatus_t.

◆ ptxNativeTag_T5TLockSingleBlock()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TLockSingleBlock	(	ptxNativeTag_T5T_t *	t5tComp,
		uint8_t	optionFlag,
		uint8_t	blockNr,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Performs a LOCK_SINGLE_BLOCK_REQ-command.

Parameters

[in]	t5tComp	Pointer to an initialized instance of the T5T component.
[in]	optionFlag	Option-flag provided by upper layer ("Use Special-Framing"-format for Write-alike commands).
[in]	blockNr	Number of block to lock.
[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	Application-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_T5TOpen()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TOpen	(	ptxNativeTag_T5T_t *	t5tComp,
		ptxNativeTag_T5T_InitParams_t *	initParams )

Initialize / Open the T5T Native Tag Component.

Parameters

[in]	t5tComp	Pointer to an allocated instance of the T5T component.
[in]	initParams	Pointer to initialization parameters.

Returns: Status, indicating whether the operation was successful.

◆ ptxNativeTag_T5TReadMultipleBlock()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TReadMultipleBlock	(	ptxNativeTag_T5T_t *	t5tComp,
		uint8_t	optionFlag,
		uint8_t	blockNr,
		uint8_t	nrBlocks,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Performs a READ_MUTLIPLE_BLOCK_REQ-command.

Parameters

[in]	t5tComp	Pointer to an initialized instance of the T5T component.
[in]	optionFlag	Option-flag provided by upper layer ("Request Block Security Status" for Read-alike commands).
[in]	blockNr	Number of start-block.
[in]	nrBlocks	Number of blocks to read.
[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_T5TReadSingleBlock()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TReadSingleBlock	(	ptxNativeTag_T5T_t *	t5tComp,
		uint8_t	optionFlag,
		uint8_t	blockNr,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Performs a READ_SINGLE_BLOCK_REQ-command.

Parameters

[in]	t5tComp	Pointer to an initialized instance of the T5T component.
[in]	optionFlag	Option-flag provided by upper layer ("Request Block Security Status" for Read-alike commands).
[in]	blockNr	Number of block to read.
[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_T5TSelect()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TSelect	(	ptxNativeTag_T5T_t *	t5tComp,
		uint8_t	optionFlag,
		uint8_t *	uid,
		uint8_t	uidLen,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Performs a SELECT_REQ-command.

Parameters

[in]	t5tComp	Pointer to an initialized instance of the T5T component.
[in]	optionFlag	Option-flag provided by upper layer ("Request Block Security Status" for Read-alike commands).
[in]	uid	Pointer to UID of the given Tag.
[in]	uidLen	Length of UID.
[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_T5TSetUID()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TSetUID	(	ptxNativeTag_T5T_t *	t5tComp,
		uint8_t *	uid,
		uint8_t	uidLen )

Sets / Updates the UID to be used (needs to be called after "ptxNativeTag_T5TSelect() is called and addressed-mode shall be used").

Parameters

[in]	t5tComp	Pointer to an initialized instance of the T5T component.
[in]	uid	Pointer to UID of the given Tag.
[in]	uidLen	Length of UID.

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

◆ ptxNativeTag_T5TSleep()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TSleep	(	ptxNativeTag_T5T_t *	t5tComp,
		uint8_t	optionFlag,
		uint8_t *	uid,
		uint8_t	uidLen,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Performs a SELECT_REQ-command.

Parameters

[in]	t5tComp	Pointer to an initialized instance of the T5T component.
[in]	optionFlag	Option-flag provided by upper layer ("Request Block Security Status" for Read-alike commands).
[in]	uid	Pointer to UID of the given Tag.
[in]	uidLen	Length of UID.
[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_T5TWriteSingleBlock()

PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TWriteSingleBlock	(	ptxNativeTag_T5T_t *	t5tComp,
		uint8_t	optionFlag,
		uint8_t	blockNr,
		uint8_t *	blockData,
		uint8_t	blockDataLen,
		uint8_t *	rx,
		size_t *	rxLen,
		uint32_t	msTimeout )

Performs a WRITE_SINGLE_BLOCK_REQ-command.

Parameters

[in]	t5tComp	Pointer to an initialized instance of the T5T component.
[in]	optionFlag	Option-flag provided by upper layer ("Use Special-Framing"-format for Write-alike commands).
[in]	blockNr	Number of block to write.
[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. See ptxStatus_t.

Data Structures

Typedefs

Functions

T5T Tag specific definitions.

Detailed Description

Macro Definition Documentation

◆ PTX_T5T_MAX_NR_RETRIES

◆ PTX_T5T_MIN_TX_BUFFER_SIZE

◆ PTX_T5T_UID_SIZE

Function Documentation

◆ ptxNativeTag_T5TClose()

◆ ptxNativeTag_T5TExtLockSingleBlock()

◆ ptxNativeTag_T5TExtReadMultipleBlock()

◆ ptxNativeTag_T5TExtReadSingleBlock()

◆ ptxNativeTag_T5TExtWriteSingleBlock()

◆ ptxNativeTag_T5TLockSingleBlock()

◆ ptxNativeTag_T5TOpen()

◆ ptxNativeTag_T5TReadMultipleBlock()

◆ ptxNativeTag_T5TReadSingleBlock()

◆ ptxNativeTag_T5TSelect()

◆ ptxNativeTag_T5TSetUID()

◆ ptxNativeTag_T5TSleep()

◆ ptxNativeTag_T5TWriteSingleBlock()