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
9 of 47
during software running, which means triggering, enabling or disabling of particular
software utilities and hardware modules.
At the beginning of program, it is necessary to load data parameter structure of layer with
default values by calling an initialization function of that layer. At the moment, when
particular data parameter structure is being initialized, underlaying structure must have
already been allocated - pointer to the structure must be known. So it is recommended to
begin initialization of particular data parameter structures from bottom to top layers. To
successfully implement functions described in this document, all the layer components
from Table 1 need to be incorporated and their structures initialized:
Table 1. Library layer components
Component
Component structure
Initialization function
Description
Layer
BAL
phbalReg_Stub_DataParams_t phbalReg_Stub_Init() Bus interface BAL
HAL CLRC663
phhalHw_Rc663_DataParams_t phhalHw_Rc663_Init()
Reader chip CLRC663
component
HAL
ISO14443-3A
phpalI14443p3a_Sw_DataParams_t phpalI14443p3a_Sw_Init()
Protocol ISO14443-3A
component
PAL
MIFARE
phpalMifare_Sw_DataParams_t phpalMifare_Sw_Init()
Authentication function and
ISO14443-3A implements this
layer component
PAL
MIFARE Classic
phalMfc_Sw_DataParams_t phalMfc_Sw_Init()
MIFARE Classic card
component
AL
MIFARE Ultralight
phalMful_Sw_DataParams_t
phalMful_Sw_Init()
MIFARE Ultralight card
component
AL
Initialization functions for HAL CLRC663, PAL ISO14443-3A, MIFARE Classic, MIFARE
Ultralight are described in sections 2.2.2 2.3.2, 2.4.1, 2.5.1 respectively. BAL and
MIFARE layer components initializations are mentioned in sample code in section 3 in
line 150 and 153 respectively.
Check each init function of data parameter structures whether its default values agrees
with your intended cause, otherwise, init manually. Pay special attention to
bBalConnectionType member in phhalHw_Rc663_DataParams_t , to set custom bus
communication between reader chip and MCU. However, you will need to initiate
bBalConnectionType “manually” (see sample code in section 3 line 164 or line 169), due to
HAL init function sets RS232 interface on default. The partial description of CLRC663
HAL layer structure and its initialization function are in sections 2.2.1 and 2.2.2
respectively. The HAL layer has its own couple of
phhalHw_SetConfig() and
phhalHw_GetConfig() functions (see sections 2.2.3 and 2.2.4) to modify parameters of the
structure and change configuration of the reader.