NXP Reader Library  v17.1.0.2535

Implementation of helper interfaces for RC663 Reader IC. More...

Collaboration diagram for RC663 Reader IC:

Modules

 Rc663 User Configuration
 Custom Configuration of hardware related settings.
 
 Register Definitions
 Register definitions for Rc663.
 

Macros

#define PHHAL_HW_SAM_RC663_TIMER_FREQ   13.56f
 RC internal timer frequency.
 
#define PHHAL_HW_SAM_RC663_ETU_106   9.44f
 Duration of one ETU at 106 kBit/s in [us].
 
#define PHHAL_HW_SAM_RC663_TIMER_RELOAD_MAX   0xFFFFU
 (RC663) Maximum reload value of internal timers.
 
#define PHHAL_HW_SAM_RC663_I14443_ADD_DELAY_US   15U
 (RC663) Additional digital timeout delay for ISO14443.
 
#define PHHAL_HW_SAM_RC663_DIGI_DELAY_TXWAIT_DBFREQ   8U
 (RC663) Chip digital delay in ETUs for TxWait.
 
#define PHHAL_HW_SAM_RC663_RXTX_I14443A_106   0x00U
 ISO14443A Operating mode at 106kbit/s.
 
#define PHHAL_HW_SAM_RC663_RXTX_I14443A_212   0x01U
 ISO14443A Operating mode at 212kbit/s.
 
#define PHHAL_HW_SAM_RC663_RXTX_I14443A_424   0x02U
 ISO14443A Operating mode at 414kbit/s.
 
#define PHHAL_HW_SAM_RC663_RXTX_I14443A_848   0x03U
 ISO14443A Operating mode at 848kbit/s.
 

Functions

phStatus_t phhalHw_Sam_Rc663_SetCardMode (phhalHw_Sam_DataParams_t *pDataParams, uint16_t wTxDataRate, uint16_t wRxDataRate)
 Apply card mode according to given parameters. More...
 
phStatus_t phhalHw_Sam_Rc663_SetConfig (phhalHw_Sam_DataParams_t *pDataParams, uint16_t wConfig, uint16_t wValue)
 Set configuration parameter. More...
 
phStatus_t phhalHw_Sam_Rc663_Wait (phhalHw_Sam_DataParams_t *pDataParams, uint8_t bUnit, uint16_t wTimeout)
 Blocks until the time given by wTimeout elapsed. More...
 
phStatus_t phhalHw_Sam_Rc663_SetRxWait (phhalHw_Sam_DataParams_t *pDataParams, uint16_t wTimeEtu)
 Sets the RxWait time. More...
 
phStatus_t phhalHw_Sam_Rc663_SetTxWait (phhalHw_Sam_DataParams_t *pDataParams, uint16_t wTimeUs)
 Sets the TxWait time in microseconds. More...
 
phStatus_t phhalHw_Sam_Rc663_SetFdt (phhalHw_Sam_DataParams_t *pDataParams, uint8_t bUnit, uint16_t wTimeout)
 Sets the Frame Delay Time (Timeout). More...
 
phStatus_t phhalHw_Sam_Rc663_GetFdt (phhalHw_Sam_DataParams_t *pDataParams, phStatus_t wExchangeStatus, uint32_t *pTime)
 Retrieves the Frame Delay Time of the last command. More...
 
phStatus_t phhalHw_Sam_Rc663_GetDigiDelay (phhalHw_Sam_DataParams_t *pDataParams, uint8_t bIsTimeout, uint16_t *pDelayUs)
 Returns the delay of the digital circutry for the current protocol. More...
 

Detailed Description

Implementation of helper interfaces for RC663 Reader IC.

Function Documentation

◆ phhalHw_Sam_Rc663_SetCardMode()

phStatus_t phhalHw_Sam_Rc663_SetCardMode ( phhalHw_Sam_DataParams_t pDataParams,
uint16_t  wTxDataRate,
uint16_t  wRxDataRate 
)

Apply card mode according to given parameters.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]wTxDataRate[In] TxDataRate HAL config.
[in]wRxDataRate[In] RxDataRate HAL config.

◆ phhalHw_Sam_Rc663_SetConfig()

phStatus_t phhalHw_Sam_Rc663_SetConfig ( phhalHw_Sam_DataParams_t pDataParams,
uint16_t  wConfig,
uint16_t  wValue 
)

Set configuration parameter.

Rc663 Specific

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_UNSUPPORTED_PARAMETERConfiguration is not supported or invalid.
PH_ERR_INVALID_PARAMETERParameter value is invalid.
PH_ERR_PARAMETER_OVERFLOWSetting the parameter value would lead to an overflow.
PH_ERR_INTERFACE_ERRORCommunication error.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]wConfig[In] Configuration Identifier.
[in]wValue[In] Configuration Value.

◆ phhalHw_Sam_Rc663_Wait()

phStatus_t phhalHw_Sam_Rc663_Wait ( phhalHw_Sam_DataParams_t pDataParams,
uint8_t  bUnit,
uint16_t  wTimeout 
)

Blocks until the time given by wTimeout elapsed.

Rc663 Specific

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_PARAMETERbUnit is invalid.
PH_ERR_INTERFACE_ERRORCommunication error.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]bUnit[In] Unit of given timeout value (either PHHAL_HW_TIME_MICROSECONDS or PHHAL_HW_TIME_MILLISECONDS).
[in]wTimeout[In] Timeout value.

◆ phhalHw_Sam_Rc663_SetRxWait()

phStatus_t phhalHw_Sam_Rc663_SetRxWait ( phhalHw_Sam_DataParams_t pDataParams,
uint16_t  wTimeEtu 
)

Sets the RxWait time.

Rc663 Specific Note: RxWait is defined between the last transmitted bit and the activation of the receiver.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]wTimeEtu[In] RxWait time in ETUs.

◆ phhalHw_Sam_Rc663_SetTxWait()

phStatus_t phhalHw_Sam_Rc663_SetTxWait ( phhalHw_Sam_DataParams_t pDataParams,
uint16_t  wTimeUs 
)

Sets the TxWait time in microseconds.

Rc663 Specific Note: TxWait is defined between the last received bit and the next transmitted bit.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]wTimeUs[In] TxWait time in microseconds.

◆ phhalHw_Sam_Rc663_SetFdt()

phStatus_t phhalHw_Sam_Rc663_SetFdt ( phhalHw_Sam_DataParams_t pDataParams,
uint8_t  bUnit,
uint16_t  wTimeout 
)

Sets the Frame Delay Time (Timeout).

Rc663 Specific Note: Frame Delay Time is defined between the last transmitted bit and the first received bit.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]bUnit[In] Unit of given timeout value (either PHHAL_HW_TIME_MICROSECONDS or PHHAL_HW_TIME_MILLISECONDS).
[in]wTimeout[In] Timeout value.

◆ phhalHw_Sam_Rc663_GetFdt()

phStatus_t phhalHw_Sam_Rc663_GetFdt ( phhalHw_Sam_DataParams_t pDataParams,
phStatus_t  wExchangeStatus,
uint32_t pTime 
)

Retrieves the Frame Delay Time of the last command.

Rc663 Specific Note: Frame Delay Time is defined between the last transmitted bit and the first received bit.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]wExchangeStatus[In] Status code returned by exchange function.
[out]pTime[Out] Calculated time in microseconds from timer contents.

◆ phhalHw_Sam_Rc663_GetDigiDelay()

phStatus_t phhalHw_Sam_Rc663_GetDigiDelay ( phhalHw_Sam_DataParams_t pDataParams,
uint8_t  bIsTimeout,
uint16_t pDelayUs 
)

Returns the delay of the digital circutry for the current protocol.

Rc663 Specific

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]bIsTimeout[In] Wheter the returned delay is added to a timeout (PH_ON) or is used for measurement (PH_OFF).
[out]pDelayUs[Out] The digital delay in microseconds.