Collaboration diagram for Transparent Data Channel (TDC) API:

Data Structures
struct	ptxTDC_InitParams
	Transparent-Mode Initialization Parameters. More...

struct	ptxTDC
	Transparent-Mode Component. More...

Macros
#define	PTX_TDC_BUFFER_LEN_MASK (0x3F)
	Transparent-Mode Initialization Parameters.

#define	PTX_TDC_MAX_BUFFER_LEN (0x3F)

#define	PTX_TDC_DEFAULT_TIMEOUT (20u)

#define	PTX_TDC_CMD_NFC_FORUM_T2T_WRITE (0xA2)

#define	PTX_TDC_CMD_NFC_FORUM_T2T_READ (0x30)

#define	PTX_TDC_LEN_NFC_FORUM_T2T_READ (16u)

#define	PTX_TDC_CMD_PROP_WRITE (0xAF)

#define	PTX_TDC_CMD_PROP_READ (0x3F)

#define	PTX_TDC_LEN_PROP_WRITE (64u)

#define	PTX_TDC_LEN_PROP_READ (64u)

#define	PTX_TDC_PROP_BLOCK_SIZE (4u)

#define	PTX_TDC_BLOCK_NUM_POL_BUFF (48u)

#define	PTX_TDC_BLOCK_NUM_LIS_BUFF (64u)

#define	PTX_TDC_CMD_NSC_DATA_MSG (0x80)

Typedefs
typedef struct ptxTDC_InitParams	ptxTDC_InitParams_t
	Transparent-Mode Initialization Parameters.

typedef struct ptxTDC	ptxTDC_t
	Transparent-Mode Component.

Functions
ptxStatus_t	ptxTDC_Init (ptxTDC_t tdcComp, ptxTDC_InitParams_t initParams)
	Initializes the TDC Component.

ptxStatus_t	ptxTDC_Deinit (ptxTDC_t *tdcComp)
	Deinitializes the TDC Component.

ptxStatus_t	ptxTDC_Write (ptxTDC_t tdcComp, uint8_t txData, uint8_t txLen, uint32_t ackTimeoutMs)
	Writes messages to the listener's buffer. Customer can choose between NFC Forum compliant write access and proprietary write access (= faster) via compile switch ("TDC_NFC_FORUM_COMPLIANT").

ptxStatus_t	ptxTDC_Read (ptxTDC_t tdcComp, uint8_t rxData, uint8_t *rxDataLen, uint32_t rxTimeoutMs)
	Reads messages from the listener's buffer. Customer can choose between NFC Forum compliant read access and proprietary read access (= faster) via compile switch ("TDC_NFC_FORUM_COMPLIANT").

ptxStatus_t	ptxTDC_IsReceived (ptxTDC_t tdcComp, uint8_t received)
	Checks if the Listener's host MCU has read the previously sent message.

ptxStatus_t	ptxTDC_ReadT2T (ptxTDC_t tdcComp, uint8_t block, uint8_t rxData, uint32_t *rxDataLen)
	Issues a T2T read command over the RF interface.

ptxStatus_t	ptxTDC_WriteT2T (ptxTDC_t tdcComp, uint8_t block, uint8_t txData, uint32_t txLen)
	Issues a T2T write command over the RF interface.

ptxStatus_t	ptxTDC_ReadProprietary (ptxTDC_t tdcComp, uint8_t block, uint8_t rxData, uint32_t *rxDataLen)
	Issues a proprietary read command over the RF interface.

ptxStatus_t	ptxTDC_WriteProprietary (ptxTDC_t tdcComp, uint8_t block, uint8_t txData, uint32_t txLen)
	Issues a proprietary write command over the RF interface.

Detailed Description

Macro Definition Documentation

◆ PTX_TDC_BLOCK_NUM_LIS_BUFF

#define PTX_TDC_BLOCK_NUM_LIS_BUFF (64u)

Start Block address for TDC Read Operation

◆ PTX_TDC_BLOCK_NUM_POL_BUFF

#define PTX_TDC_BLOCK_NUM_POL_BUFF (48u)

Start Block address for TDC Write Operation

◆ PTX_TDC_BUFFER_LEN_MASK

#define PTX_TDC_BUFFER_LEN_MASK (0x3F)

Transparent-Mode Initialization Parameters.

Buffer size mask for TDC operation

◆ PTX_TDC_CMD_NFC_FORUM_T2T_READ

#define PTX_TDC_CMD_NFC_FORUM_T2T_READ (0x30)

Command for NFC Forum T2T Read operation

◆ PTX_TDC_CMD_NFC_FORUM_T2T_WRITE

#define PTX_TDC_CMD_NFC_FORUM_T2T_WRITE (0xA2)

Command for NFC Forum T2T Write operation

◆ PTX_TDC_CMD_NSC_DATA_MSG

#define PTX_TDC_CMD_NSC_DATA_MSG (0x80)

Command for internal NSC Data operation

◆ PTX_TDC_CMD_PROP_READ

#define PTX_TDC_CMD_PROP_READ (0x3F)

Command for proprietary Read operation

◆ PTX_TDC_CMD_PROP_WRITE

#define PTX_TDC_CMD_PROP_WRITE (0xAF)

Command for proprietary Write operation

◆ PTX_TDC_DEFAULT_TIMEOUT

#define PTX_TDC_DEFAULT_TIMEOUT (20u)

Default Timeout given in ms for all Read- and Write operations

◆ PTX_TDC_LEN_NFC_FORUM_T2T_READ

#define PTX_TDC_LEN_NFC_FORUM_T2T_READ (16u)

Length of response for NFC Forum T2T Read

◆ PTX_TDC_LEN_PROP_READ

#define PTX_TDC_LEN_PROP_READ (64u)

Max. Number of Bytes for proprietary Read operation (Header + Payload)

◆ PTX_TDC_LEN_PROP_WRITE

#define PTX_TDC_LEN_PROP_WRITE (64u)

Max. Number of Bytes for proprietary Write operation (Header + Payload)

◆ PTX_TDC_MAX_BUFFER_LEN

#define PTX_TDC_MAX_BUFFER_LEN (0x3F)

Max. Buffer size for TDC operation (Payload only)

◆ PTX_TDC_PROP_BLOCK_SIZE

#define PTX_TDC_PROP_BLOCK_SIZE (4u)

Block size of Listener device

Function Documentation

◆ ptxTDC_Deinit()

ptxStatus_t ptxTDC_Deinit ( ptxTDC_t * tdcComp )

Deinitializes the TDC Component.

Parameters

[in] tdcComp Pointer to an initialized instance of the TDC component.

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

◆ ptxTDC_Init()

ptxStatus_t ptxTDC_Init	(	ptxTDC_t *	tdcComp,
		ptxTDC_InitParams_t *	initParams )

Initializes the TDC Component.

Parameters

[in]	tdcComp	Pointer to an allocated instance of the TDC component.
[in]	initParams	Pointer to initialization parameters.

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

◆ ptxTDC_IsReceived()

ptxStatus_t ptxTDC_IsReceived	(	ptxTDC_t *	tdcComp,
		uint8_t *	received )

Checks if the Listener's host MCU has read the previously sent message.

Parameters

[in]	tdcComp	Pointer to an initialized instance of the TDC component.
[in,out]	received	Pointer to store the status, if the message has been read by the listener.

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

◆ ptxTDC_Read()

ptxStatus_t ptxTDC_Read	(	ptxTDC_t *	tdcComp,
		uint8_t *	rxData,
		uint8_t *	rxDataLen,
		uint32_t	rxTimeoutMs )

Reads messages from the listener's buffer. Customer can choose between NFC Forum compliant read access and proprietary read access (= faster) via compile switch ("TDC_NFC_FORUM_COMPLIANT").

Parameters

[in]	tdcComp	Pointer to an initialized instance of the TDC component.
[in,out]	rxData	Pointer to a buffer for storing the received data.
[in,out]	rxDataLen	Size of the buffer.
[in]	rxTimeoutMs	Timeout in ms for the transaction.

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

◆ ptxTDC_ReadProprietary()

ptxStatus_t ptxTDC_ReadProprietary	(	ptxTDC_t *	tdcComp,
		uint8_t	block,
		uint8_t *	rxData,
		uint32_t *	rxDataLen )

Issues a proprietary read command over the RF interface.

Parameters

[in]	tdcComp	Pointer to an initialized instance of the TDC component.
[in]	block	Block number to read from.
[in,out]	rxData	Pointer to a buffer to store the received data.
[in,out]	rxDataLen	Size of the buffer.

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

◆ ptxTDC_ReadT2T()

ptxStatus_t ptxTDC_ReadT2T	(	ptxTDC_t *	tdcComp,
		uint8_t	block,
		uint8_t *	rxData,
		uint32_t *	rxDataLen )

Issues a T2T read command over the RF interface.

Parameters

[in]	tdcComp	Pointer to an initialized instance of the TDC component.
[in]	block	Block number to read from.
[in,out]	rxData	Pointer to a buffer to store the received data.
[in,out]	rxDataLen	Size of the buffer.

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

◆ ptxTDC_Write()

ptxStatus_t ptxTDC_Write	(	ptxTDC_t *	tdcComp,
		uint8_t *	txData,
		uint8_t	txLen,
		uint32_t	ackTimeoutMs )

Writes messages to the listener's buffer. Customer can choose between NFC Forum compliant write access and proprietary write access (= faster) via compile switch ("TDC_NFC_FORUM_COMPLIANT").

Parameters

[in]	tdcComp	Pointer to an initialized instance of the TDC component.
[in]	txData	Pointer to the data which shall be transmitted.
[in]	txLen	Size of the buffer.
[in]	ackTimeoutMs	Timeout for the message to be received.

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

◆ ptxTDC_WriteProprietary()

ptxStatus_t ptxTDC_WriteProprietary	(	ptxTDC_t *	tdcComp,
		uint8_t	block,
		uint8_t *	txData,
		uint32_t	txLen )

Issues a proprietary write command over the RF interface.

Parameters

[in]	tdcComp	Pointer to an initialized instance of the TDC component.
[in]	block	Block number to write to.
[in]	txData	Pointer to a buffer containing the data to be written to the tag.
[in]	txLen	Size of the buffer.

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

◆ ptxTDC_WriteT2T()

ptxStatus_t ptxTDC_WriteT2T	(	ptxTDC_t *	tdcComp,
		uint8_t	block,
		uint8_t *	txData,
		uint32_t	txLen )

Issues a T2T write command over the RF interface.

Parameters

[in]	tdcComp	Pointer to an initialized instance of the TDC component.
[in]	block	Block number to write to.
[in]	txData	Pointer to a buffer containing the data to be written to the tag.
[in]	txLen	Size of the buffer.

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

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ PTX_TDC_BLOCK_NUM_LIS_BUFF

◆ PTX_TDC_BLOCK_NUM_POL_BUFF

◆ PTX_TDC_BUFFER_LEN_MASK

◆ PTX_TDC_CMD_NFC_FORUM_T2T_READ

◆ PTX_TDC_CMD_NFC_FORUM_T2T_WRITE

◆ PTX_TDC_CMD_NSC_DATA_MSG

◆ PTX_TDC_CMD_PROP_READ

◆ PTX_TDC_CMD_PROP_WRITE

◆ PTX_TDC_DEFAULT_TIMEOUT

◆ PTX_TDC_LEN_NFC_FORUM_T2T_READ

◆ PTX_TDC_LEN_PROP_READ

◆ PTX_TDC_LEN_PROP_WRITE

◆ PTX_TDC_MAX_BUFFER_LEN

◆ PTX_TDC_PROP_BLOCK_SIZE

Function Documentation

◆ ptxTDC_Deinit()

◆ ptxTDC_Init()

◆ ptxTDC_IsReceived()

◆ ptxTDC_Read()

◆ ptxTDC_ReadProprietary()

◆ ptxTDC_ReadT2T()

◆ ptxTDC_Write()

◆ ptxTDC_WriteProprietary()

◆ ptxTDC_WriteT2T()