ptxNDEF_T2TOP.h File Reference

#include <stdint.h>
#include "ptxNativeTag_T2T.h"
#include "ptxNDEF_Defines.h"
#include "ptxStatus.h"

Include dependency graph for ptxNDEF_T2TOP.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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...

Macros
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
#define	PTX_T2TOP_INTERNAL_BYTES_LENGTH   (uint8_t)10u

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
ptxStatus_t	ptxNDEF_T2TOpOpen (ptxNDEF_T2TOP_t *t2tOpComp, ptxNDEF_T2TOP_InitParams_t *initParams)
	Initialize / Open the T2T OP Component.
ptxStatus_t	ptxNDEF_T2TOpFormatTag (ptxNDEF_T2TOP_t *t2tOpComp)
	Formats a Type 2 Tag to INITIALIZED state.
ptxStatus_t	ptxNDEF_T2TOpCheckMessage (ptxNDEF_T2TOP_t *t2tOpComp)
	Checks if a NDEF-message is present on the given Tag (or not).
ptxStatus_t	ptxNDEF_T2TOpReadMessage (ptxNDEF_T2TOP_t *t2tOpComp, uint8_t *msgBuffer, uint32_t *msgLen)
	Reads a NDEF-message from a given Tag.
ptxStatus_t	ptxNDEF_T2TOpWriteMessage (ptxNDEF_T2TOP_t *t2tOpComp, uint8_t *msgBuffer, uint32_t msgLen)
	Writes a NDEF-message onto a given Tag.
ptxStatus_t	ptxNDEF_T2TOpLockTag (ptxNDEF_T2TOP_t *t2tOpComp)
	Puts a Tag into READ-ONLY state (Attention: This is a irreversible Operation!).
ptxStatus_t	ptxNDEF_T2TOpClose (ptxNDEF_T2TOP_t *t2tOpComp)
	Unitialize / Close the T2T OP Component.

Detailed Description

SPDX-License-Identifier: BSD-3-Clause

Copyright (c) 2026, Renesas Electronics Corporation and/or its affiliates

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of Renesas nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY Renesas "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RENESAS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Project : PTX1K Module : NDEF T2T OPERATION API File : ptxNDEF_T2TOP.h

Description : Tag Type 2 NDEF Operation API (IOT READER - Extension)