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

Include dependency graph for ptxTransparentMode.h:

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

struct	ptxTransparentMode_InitParams
	Transparent-Mode Initialization Parameters. More...

struct	ptxTransparentMode
	Transparent-Mode Component. More...

Macros
Transparent-Mode RF-Flags
#define	PTX_TRANSPARENT_MODE_FLAGS_TX_PARITY (uint8_t)0x01

#define	PTX_TRANSPARENT_MODE_FLAGS_RX_PARITY (uint8_t)0x02

#define	PTX_TRANSPARENT_MODE_FLAGS_TX_CRC (uint8_t)0x04

#define	PTX_TRANSPARENT_MODE_FLAGS_RX_CRC (uint8_t)0x08

#define	PTX_TRANSPARENT_MODE_FLAGS_RX_SOF_ONLY (uint8_t)0x10

#define	PTX_TRANSPARENT_MODE_FLAGS_SKIP_1ST_BYTE_CRC (uint8_t)0x20

Optional Module Configuration
#define	PTX_TRANSPARENT_MODE_RESET_DEFAULT

Typedefs
typedef enum ptxTransparentMode_RF_Tech	ptxTransparentMode_RF_Tech_t
	Transparent-Mode supported RF-Technologies.

typedef enum ptxTransparentMode_RF_Bitrate	ptxTransparentMode_RF_Bitrate_t
	Transparent-Mode supported RF-Bitrates for Type A, B and F (V fixed).

typedef struct ptxTransparentMode_RFParams	ptxTransparentMode_RFParams_t
	Transparent-Mode Initialization Parameters.

typedef struct ptxTransparentMode_InitParams	ptxTransparentMode_InitParams_t
	Transparent-Mode Initialization Parameters.

typedef struct ptxTransparentMode	ptxTransparentMode_t
	Transparent-Mode Component.

Enumerations
enum	ptxTransparentMode_RF_Tech { TM_RF_Tech_A = 0 , TM_RF_Tech_B = 1 , TM_RF_Tech_F = 2 , TM_RF_Tech_V = 6 , TM_RF_Tech_BPrime = 7 }
	Transparent-Mode supported RF-Technologies.

enum	ptxTransparentMode_RF_Bitrate { TM_RF_Bitrate_106 = 0 , TM_RF_Bitrate_212 = 1 , TM_RF_Bitrate_424 = 2 , TM_RF_Bitrate_848 = 3 , TM_RF_Bitrate_26 = 6 }
	Transparent-Mode supported RF-Bitrates for Type A, B and F (V fixed).

Functions
ptxStatus_t	ptxTransparentMode_Init (ptxTransparentMode_t tmComp, ptxTransparentMode_InitParams_t initParams)
	Initializes the Transparent-Mode Component.

ptxStatus_t	ptxTransparentMode_SetRFParameters (ptxTransparentMode_t tmComp, ptxTransparentMode_RFParams_t rfParams)
	Configures the HW using the provided RF-Parameters (used for all following RF-Exchanges, can be overwritten).

ptxStatus_t	ptxTransparentMode_SetField (ptxTransparentMode_t *tmComp, uint8_t state)
	Turns the RF-field on or off.

ptxStatus_t	ptxTransparentMode_Exchange (ptxTransparentMode_t tmComp, ptxTransparentMode_RFParams_t rfParams, uint8_t tx, uint8_t txLength, uint8_t rx, uint32_t *rxLength, uint32_t timeoutMS)
	Performs a RF data exchange.

ptxStatus_t	ptxTransparentMode_Deinit (ptxTransparentMode_t *tmComp)
	Deinitializes the Transparent-Mode Component.

Detailed Description

SPDX-License-Identifier: BSD-3-Clause

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

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.
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 : Transparent-Mode API File : ptxTransparentMode.h

Description : Dedicated API to enable low-level NFC-commands to implement custom/proprietary RF-protocols.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

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