Renesas PTX1xxR IoT-Reader API Version 7.3.1
Renesas Software Stack for IoT-Reader Applications
Data Structures | Typedefs | Enumerations | Functions
Transparent Mode API
PTX NSC IoT-Reader API Component
Collaboration diagram for Transparent Mode API:

Data Structures

struct  ptxTransparentMode_RFParams
 Transparent-Mode Initialization Parameters. More...
 
struct  ptxTransparentMode_InitParams
 Transparent-Mode Initialization Parameters. More...
 
struct  ptxTransparentMode
 Transparent-Mode Component. More...
 

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

PTX_API_LIBFUNC ptxStatus_t ptxTransparentMode_Init (ptxTransparentMode_t *tmComp, ptxTransparentMode_InitParams_t *initParams)
 Initializes the Transparent-Mode Component.
 
PTX_API_LIBFUNC 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).
 
PTX_API_LIBFUNC ptxStatus_t ptxTransparentMode_SetField (ptxTransparentMode_t *tmComp, uint8_t state)
 Turns the RF-field on or off.
 
PTX_API_LIBFUNC 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.
 
PTX_API_LIBFUNC ptxStatus_t ptxTransparentMode_Deinit (ptxTransparentMode_t *tmComp)
 Deinitializes the Transparent-Mode Component.
 

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
 

Detailed Description

Macro Definition Documentation

◆ PTX_TRANSPARENT_MODE_FLAGS_RX_CRC

#define PTX_TRANSPARENT_MODE_FLAGS_RX_CRC   (uint8_t)0x08

Enable Rx-CRC (all Technology Types)

◆ PTX_TRANSPARENT_MODE_FLAGS_RX_PARITY

#define PTX_TRANSPARENT_MODE_FLAGS_RX_PARITY   (uint8_t)0x02

Enable Rx-Parity (Type-A only)

◆ PTX_TRANSPARENT_MODE_FLAGS_RX_SOF_ONLY

#define PTX_TRANSPARENT_MODE_FLAGS_RX_SOF_ONLY   (uint8_t)0x10

Enable SoF-Reception only (Start-of-Frame) - Type-V only!

◆ PTX_TRANSPARENT_MODE_FLAGS_SKIP_1ST_BYTE_CRC

#define PTX_TRANSPARENT_MODE_FLAGS_SKIP_1ST_BYTE_CRC   (uint8_t)0x20

If enabled, 1st Byte in Tx- and Rx-direction is excluded from automatic CRC-calculation - Type-V only!

◆ PTX_TRANSPARENT_MODE_FLAGS_TX_CRC

#define PTX_TRANSPARENT_MODE_FLAGS_TX_CRC   (uint8_t)0x04

Enable Tx-CRC (all Technology Types)

◆ PTX_TRANSPARENT_MODE_FLAGS_TX_PARITY

#define PTX_TRANSPARENT_MODE_FLAGS_TX_PARITY   (uint8_t)0x01

Enable Tx-Parity (Type-A only)

◆ PTX_TRANSPARENT_MODE_RESET_DEFAULT

#define PTX_TRANSPARENT_MODE_RESET_DEFAULT

If active, default RF-parameters will be applied when RF-field gets turned off (default)

Function Documentation

◆ ptxTransparentMode_Deinit()

PTX_API_LIBFUNC ptxStatus_t ptxTransparentMode_Deinit ( ptxTransparentMode_t * tmComp)

Deinitializes the Transparent-Mode Component.

Parameters
[in]tmCompPointer to an initialized instance of the Transparent-Mode component.
Returns
Status, indicating whether the operation was successful. See ptxStatus_t.

◆ ptxTransparentMode_Exchange()

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

Attention: The last received byte is the contactless status byte which is defined as follows: Bit 7: If set to 1, a contactless error occured (e.g. CRC- or Parity-error). Bit 6 - 0: Number of valid bits in last received byte.

Parameters
[in]tmCompPointer to an initialized instance of the Transparent-Mode component.
[in]rfParamsPointer to RF-parameters (optional, otherwise parameters from ptxTransparentMode_SetRFParameters are used).
[in]txBuffer containing the data to send.
[in]txLengthLength of "tx".
[out]rxPointer to buffer where the data will be received.
[in,out]rxLengthAs input, capacity of "rx". As output, actual number of bytes written on "rx".
[in]timeoutMSTimeout given in [ms].
Returns
Status, indicating whether the operation was successful.

◆ ptxTransparentMode_Init()

PTX_API_LIBFUNC ptxStatus_t ptxTransparentMode_Init ( ptxTransparentMode_t * tmComp,
ptxTransparentMode_InitParams_t * initParams )

Initializes the Transparent-Mode Component.

Parameters
[in]tmCompPointer to an allocated instance of the Transparent-Mode component.
[in]initParamsPointer to initialization parameters.
Returns
Status, indicating whether the operation was successful.

◆ ptxTransparentMode_SetField()

PTX_API_LIBFUNC ptxStatus_t ptxTransparentMode_SetField ( ptxTransparentMode_t * tmComp,
uint8_t state )

Turns the RF-field on or off.

Parameters
[in]tmCompPointer to an initialized instance of the Transparent-Mode component.
[in]stateState of RF-field (0 = off, != 0 = on).
Returns
Status, indicating whether the operation was successful.

◆ ptxTransparentMode_SetRFParameters()

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

Parameters
[in]tmCompPointer to an initialized instance of the Transparent-Mode component.
[in]rfParamsPointer to RF-parameters.
Returns
Status, indicating whether the operation was successful.
Generated by doxygen 1.10.0