User manual

NXP Semiconductors
UM10663
NXP Reader Library User Manual
UM10663
All information provided in this document is subject to legal disclaimers.
© NXP B.V. 2013. All rights reserved.
User Manual
COMPANY PUBLIC
Rev. 1.2 — 24 July 2013
257412
19 of 47
PH_ERR_UNSUPPORTED_PARAMETER – attempt to store an unsupported type of key
PH_ERR_INVALID_PARAMETER – wKeyNo is greater than 128
PH_ERR_SUCCESS - operation successful.
Other: depending on implementation and underlaying component.
2.1.15 SoftReset - phhalHw_Rc663_Cmd_SoftReset()
This function performs the SoftReset command. Triggered by this command all the
default values for the register setting will be read from the EEPROM and copied into the
register set. It is up to the caller to wait until the IC is powered-up and ready again. In
addition to that, the caller should call
phhalHw_ApplyProtocolSettings() again to re-
configure the reader chip.
phStatus_t phhalHw_Rc663_Cmd_SoftReset(
phhalHw_Rc663_DataParams_t * pDataParams ); [In]
*pDataParams: pointer to the HAL layer data parameter structure.
returnValues:
PH_ERR_SUCCESS - operation successful.
Other: depending on implementation and underlaying component.
2.2 HAL: Additional description of HAL layer
In this section there is firstly partially described HAL layer data parameter structure and
for CLRC663 reader, then HAL layer functions common for all the reader chips supported
by the library. Those functions can be implemented independently of hardware. Field
controlling and reading/writing registers functions are general functionalities necessary
for various the PCDs.
2.2.1 CLRC663 HAL layer data parameter structure
Entire structure is defined in the file phhalHw.h in folder NxpRdLib_PublicRelease\intfs.
In this section there are mentioned only some parameters from the CLRC663 HAL layer
data parameter structure which are implemented in the functions described in this
document.
void *pBalDataParams: pointer to the undelaying BAL data parameter structure.
uint8_t bLoadRegMode: binary switch for enabling/disabling ( PH_ON/PH_OFF ) Load
Register mode in
ApplyProtocolSettings() function (see section 2.1.13). If Load Register
mode intended to be used,
pLoadRegConfig (see line bellow) must have already been
defined.
uint8_t *pLoadRegConfig: pointer to configuration buffer for Load Register mode.
uint8_t bCardType: type of card for which the HAL component is configured for. This
member is set by
ApplyProtocolSettings() function (see section 2.1.13).
uint16_t wCfgShadow[PHHAL_HW_RC663_SHADOW_COUNT] ; configuration shadow. Stores
configuration of receiver and transmitter for current card type.
uint16_t wFieldOffTime: field off time in milliseconds for FieldReset() function described
in section 2.2.9. How long
FieldReset() function holds the field turned off while doing
nothing else.