Collaboration diagram for Tag Type T2T Operation API:

Data Structures
struct	ptxNDEF_T2TOP_InitParams
	T2T NDEF OP Initialization Parameters. More...

struct	ptxNDEF_T2TOP_CC
	T2T NDEF OP Capability Container Parameters. More...

struct	ptxNDEF_T2TOP_NDEF_TLV
	T2T NDEF TLV position. More...

struct	ptxNDEF_T2TOP_TERMINATOR_TLV
	T2T Terminator TLV position. More...

struct	ptxNDEF_T2TOP_LOCK_CTRL_TLV
	T2T Lock Control TLV positions and counter. More...

struct	ptxNDEF_T2TOP_MEMORY_CTRL_TLV
	T2T Memory Control TLV positions and counter. More...

struct	ptxNDEF_T2TOP_TLV
	T2T NDEF OP TLV byte adresses and counters. More...

struct	ptxNDEF_T2TOP_Sector
	T2T NDEF OP sector information. More...

struct	ptxNDEF_T2TOP
	T2T NDEF OP Component. More...

Typedefs
typedef enum ptxNDEF_T2TOP_ReadCCVariant	ptxNDEF_T2TOP_ReadCCVariant_t
	Variant which block(s) to read first to get the Capability Container CC.

typedef struct ptxNDEF_T2TOP_InitParams	ptxNDEF_T2TOP_InitParams_t
	T2T NDEF OP Initialization Parameters.

typedef struct ptxNDEF_T2TOP_CC	ptxNDEF_T2TOP_CC_t
	T2T NDEF OP Capability Container Parameters.

typedef struct ptxNDEF_T2TOP_NDEF_TLV	ptxNDEF_T2TOP_NDEF_TLV_t
	T2T NDEF TLV position.

typedef struct ptxNDEF_T2TOP_TERMINATOR_TLV	ptxNDEF_T2TOP_TERMINATOR_TLV_t
	T2T Terminator TLV position.

typedef struct ptxNDEF_T2TOP_LOCK_CTRL_TLV	ptxNDEF_T2TOP_LOCK_CTRL_TLV
	T2T Lock Control TLV positions and counter.

typedef struct ptxNDEF_T2TOP_MEMORY_CTRL_TLV	ptxNDEF_T2TOP_MEMORY_CTRL_TLV_t
	T2T Memory Control TLV positions and counter.

typedef struct ptxNDEF_T2TOP_TLV	ptxNDEF_T2TOP_TLV_t
	T2T NDEF OP TLV byte adresses and counters.

typedef struct ptxNDEF_T2TOP_Sector	ptxNDEF_T2TOP_Sector_t
	T2T NDEF OP sector information.

typedef struct ptxNDEF_T2TOP	ptxNDEF_T2TOP_t
	T2T NDEF OP Component.

Enumerations
enum	ptxNDEF_T2TOP_ReadCCVariant { ReadCCVariant_Block_3_Default , ReadCCVariant_Block_0 }
	Variant which block(s) to read first to get the Capability Container CC. More...

Functions
PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T2TOpOpen (ptxNDEF_T2TOP_t t2tOpComp, ptxNDEF_T2TOP_InitParams_t initParams)
	Initialize / Open the T2T OP Component.

PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T2TOpFormatTag (ptxNDEF_T2TOP_t *t2tOpComp)
	Formats a Type 2 Tag to INITIALIZED state.

PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T2TOpCheckMessage (ptxNDEF_T2TOP_t *t2tOpComp)
	Checks if a NDEF-message is present on the given Tag (or not).

PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T2TOpReadMessage (ptxNDEF_T2TOP_t t2tOpComp, uint8_t msgBuffer, uint32_t *msgLen)
	Reads a NDEF-message from a given Tag.

PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T2TOpWriteMessage (ptxNDEF_T2TOP_t t2tOpComp, uint8_t msgBuffer, uint32_t msgLen)
	Writes a NDEF-message onto a given Tag.

PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T2TOpLockTag (ptxNDEF_T2TOP_t *t2tOpComp)
	Puts a Tag into READ-ONLY state (Attention: This is a irreversible Operation!).

PTX_API_LIBFUNC ptxStatus_t	ptxNDEF_T2TOpClose (ptxNDEF_T2TOP_t *t2tOpComp)
	Unitialize / Close the T2T OP Component.

T2T Tag specific definitions
#define	PTX_T2T_DEFAULT_TIMEOUT_MS (uint32_t)100

#define	PTX_T2T_SUPPORTED_VERSION (uint8_t)0x11

#define	PTX_T2TOP_MAX_NUMBER_LOCK_CONTROL (uint8_t)3u

#define	PTX_T2TOP_MAX_NUMBER_MEMORY_CONTROL (uint8_t)3u

#define	PTX_T2TOP_MAX_NUMBER_NDEFTLVS (uint8_t)3u

Detailed Description

Macro Definition Documentation

◆ PTX_T2T_DEFAULT_TIMEOUT_MS

#define PTX_T2T_DEFAULT_TIMEOUT_MS (uint32_t)100

T2T default timeout in ms

◆ PTX_T2T_SUPPORTED_VERSION

#define PTX_T2T_SUPPORTED_VERSION (uint8_t)0x11

T2T supported version

◆ PTX_T2TOP_MAX_NUMBER_LOCK_CONTROL

#define PTX_T2TOP_MAX_NUMBER_LOCK_CONTROL (uint8_t)3u

Maximum number of T2T operation lock controls

◆ PTX_T2TOP_MAX_NUMBER_MEMORY_CONTROL

#define PTX_T2TOP_MAX_NUMBER_MEMORY_CONTROL (uint8_t)3u

Maximum number of T2T operation memory controls

◆ PTX_T2TOP_MAX_NUMBER_NDEFTLVS

#define PTX_T2TOP_MAX_NUMBER_NDEFTLVS (uint8_t)3u

T2T NDEF Operations Maximum NDEF TLVs to be handled.

Enumeration Type Documentation

◆ ptxNDEF_T2TOP_ReadCCVariant

enum ptxNDEF_T2TOP_ReadCCVariant

Variant which block(s) to read first to get the Capability Container CC.

Enumerator
ReadCCVariant_Block_3_Default	Reading CC-Block starts at Block 3 (default)
ReadCCVariant_Block_0	Reading CC-Block starts at Block 0

Function Documentation

◆ ptxNDEF_T2TOpCheckMessage()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T2TOpCheckMessage ( ptxNDEF_T2TOP_t * t2tOpComp )

Checks if a NDEF-message is present on the given Tag (or not).

Parameters

[in] t2tOpComp Pointer to an initialized instance of the T2T-OP component.

Returns: Status, indicating whether the operation was successful.

◆ ptxNDEF_T2TOpClose()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T2TOpClose ( ptxNDEF_T2TOP_t * t2tOpComp )

Unitialize / Close the T2T OP Component.

Parameters

[in] t2tOpComp Pointer to an initialized instance of the T2T-OP component.

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

◆ ptxNDEF_T2TOpFormatTag()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T2TOpFormatTag ( ptxNDEF_T2TOP_t * t2tOpComp )

Formats a Type 2 Tag to INITIALIZED state.

Parameters

[in] t2tOpComp Pointer to an initialized instance of the T2T-OP component.

Returns: Status, indicating whether the operation was successful.

◆ ptxNDEF_T2TOpLockTag()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T2TOpLockTag ( ptxNDEF_T2TOP_t * t2tOpComp )

Puts a Tag into READ-ONLY state (Attention: This is a irreversible Operation!).

Parameters

[in] t2tOpComp Pointer to an initialized instance of the T2T-OP component.

Returns: Status, indicating whether the operation was successful.

◆ ptxNDEF_T2TOpOpen()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T2TOpOpen	(	ptxNDEF_T2TOP_t *	t2tOpComp,
		ptxNDEF_T2TOP_InitParams_t *	initParams )

Initialize / Open the T2T OP Component.

Parameters

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

Returns: Status, indicating whether the operation was successful.

◆ ptxNDEF_T2TOpReadMessage()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T2TOpReadMessage	(	ptxNDEF_T2TOP_t *	t2tOpComp,
		uint8_t *	msgBuffer,
		uint32_t *	msgLen )

Reads a NDEF-message from a given Tag.

Parameters

[in]	t2tOpComp	Pointer to an initialized instance of the T2T-OP component.
[in]	msgBuffer	Pointer to buffer holding the read NDEF-message.
[in,out]	msgLen	Size of the buffer (in), Length of the read NDEF-message (out).

Returns: Status, indicating whether the operation was successful.

◆ ptxNDEF_T2TOpWriteMessage()

PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T2TOpWriteMessage	(	ptxNDEF_T2TOP_t *	t2tOpComp,
		uint8_t *	msgBuffer,
		uint32_t	msgLen )

Writes a NDEF-message onto a given Tag.

Parameters

[in]	t2tOpComp	Pointer to an initialized instance of the T2T-OP component.
[in]	msgBuffer	Pointer to buffer holding the NDEF-message to write (NULL -> empty NDEF-message is written).
[in]	msgLen	Size of NDEF-message (0 -> empty NDEF-message is written).

Returns: Status, indicating whether the operation was successful.

Data Structures

Typedefs

Enumerations

Functions

T2T Tag specific definitions

Detailed Description

Macro Definition Documentation

◆ PTX_T2T_DEFAULT_TIMEOUT_MS

◆ PTX_T2T_SUPPORTED_VERSION

◆ PTX_T2TOP_MAX_NUMBER_LOCK_CONTROL

◆ PTX_T2TOP_MAX_NUMBER_MEMORY_CONTROL

◆ PTX_T2TOP_MAX_NUMBER_NDEFTLVS

Enumeration Type Documentation

◆ ptxNDEF_T2TOP_ReadCCVariant

Function Documentation

◆ ptxNDEF_T2TOpCheckMessage()

◆ ptxNDEF_T2TOpClose()

◆ ptxNDEF_T2TOpFormatTag()

◆ ptxNDEF_T2TOpLockTag()

◆ ptxNDEF_T2TOpOpen()

◆ ptxNDEF_T2TOpReadMessage()

◆ ptxNDEF_T2TOpWriteMessage()