NXP Reader Library  v17.1.0.2535

Implementation of SAM Reader IC commands. More...

Collaboration diagram for 14_ReaderIC:

Modules

 Defines
 Definitions for Reader IC commands.
 

Functions

phStatus_t phhalHw_Sam_Cmd_RC_ReadRegister (phhalHw_Sam_DataParams_t *pDataParams, uint8_t *pRegAddr, uint8_t bRegAddrLen, uint8_t *pValue)
 Read the content of one or more register(s) of the connected reader chip. More...
 
phStatus_t phhalHw_Sam_Cmd_RC_WriteRegister (phhalHw_Sam_DataParams_t *pDataParams, uint8_t *pData, uint8_t bDataLen)
 Write the content of one or more register(s) of the connected reader chip. More...
 
phStatus_t phhalHw_Sam_Cmd_RC_RFControl (phhalHw_Sam_DataParams_t *pDataParams, uint16_t wTime)
 Turn the radio frequency field On or Off. More...
 
phStatus_t phhalHw_Sam_Cmd_RC_Init (phhalHw_Sam_DataParams_t *pDataParams, uint8_t bLoadReg)
 Istablishes the serial connection between MIFARE SAM and Reader IC and initializes the reader chip with the register values stored in the selected register value set. More...
 
phStatus_t phhalHw_Sam_Cmd_RC_LoadRegisterValueSet (phhalHw_Sam_DataParams_t *pDataParams, uint8_t bStoreReg, uint8_t *pData, uint8_t bDataLen)
 Stores a customer defined register value set for the PN512/RC52x/RC663 in the non-volatile memory of the MIFARE SAM. More...
 

Detailed Description

Implementation of SAM Reader IC commands.

Function Documentation

◆ phhalHw_Sam_Cmd_RC_ReadRegister()

phStatus_t phhalHw_Sam_Cmd_RC_ReadRegister ( phhalHw_Sam_DataParams_t pDataParams,
uint8_t pRegAddr,
uint8_t  bRegAddrLen,
uint8_t pValue 
)

Read the content of one or more register(s) of the connected reader chip.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSpDataParams is NULL.
PH_ERR_INVALID_PARAMETERpRegAddr and pValue are NULL.
PH_ERR_LENGTH_ERRORIf length received from SAM is not equal to bRegAddrLen
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]pRegAddr[In] Address for the registers to be read.
[in]bRegAddrLen[In] Length of bytes available in pRegAddr buffer.
[out]pValue[Out] Register(s) content in the same order as the command data field address(es).

◆ phhalHw_Sam_Cmd_RC_WriteRegister()

phStatus_t phhalHw_Sam_Cmd_RC_WriteRegister ( phhalHw_Sam_DataParams_t pDataParams,
uint8_t pData,
uint8_t  bDataLen 
)

Write the content of one or more register(s) of the connected reader chip.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSpDataParams is NULL.
PH_ERR_INVALID_PARAMETERpData is NULL.
PH_ERR_LENGTH_ERRORIf response is received from SAM
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]pData[In] The registers to tbe updated. This buffer should contain register address followed by value.
The format should be as mentioned below.
RegAdd || Value || RegAdd || Value || ... || RegAdd || Value
[in]bDataLen[In] Length of bytes available in pData buffer.

◆ phhalHw_Sam_Cmd_RC_RFControl()

phStatus_t phhalHw_Sam_Cmd_RC_RFControl ( phhalHw_Sam_DataParams_t pDataParams,
uint16_t  wTime 
)

Turn the radio frequency field On or Off.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSpDataParams is NULL.
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]wTime[In] Shut-down time for the RF field, zero turns the field off.

◆ phhalHw_Sam_Cmd_RC_Init()

phStatus_t phhalHw_Sam_Cmd_RC_Init ( phhalHw_Sam_DataParams_t pDataParams,
uint8_t  bLoadReg 
)

Istablishes the serial connection between MIFARE SAM and Reader IC and initializes the reader chip with the register values stored in the selected register value set.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSpDataParams is NULL.
PH_ERR_LENGTH_ERRORIf response is received from SAM
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]bLoadReg[In] The Load register information.

◆ phhalHw_Sam_Cmd_RC_LoadRegisterValueSet()

phStatus_t phhalHw_Sam_Cmd_RC_LoadRegisterValueSet ( phhalHw_Sam_DataParams_t pDataParams,
uint8_t  bStoreReg,
uint8_t pData,
uint8_t  bDataLen 
)

Stores a customer defined register value set for the PN512/RC52x/RC663 in the non-volatile memory of the MIFARE SAM.

Returns
Status code
Return values
PH_ERR_SUCCESSOperation successful.
PH_ERR_INVALID_DATA_PARAMSpDataParams is NULL.
PH_ERR_INVALID_PARAMETERpData is NULL.
PH_ERR_LENGTH_ERRORIf response is received from SAM
OtherDepending on implementation and underlaying component.
Parameters
[in]pDataParams[In] Pointer to this layer's parameter structure.
[in]bStoreReg[In] Number of register value set to be used for storing the values.
[in]pData[In] List of Register descriptions. This buffer should be as meniotned below.
  • If RC663: SpeedID || ItemCount || RegAddr || RegValue ... [|| RegAddr || RegValue]
  • If RC5XX: RegAddr || RegValue ... [|| RegAddr || RegValue]
[in]bDataLen[In] The length of bytes available in pData buffer.