Overview

The NXP reader library is encapsulated into Layers and Components written in ANSI C. The library structure provides a modular way of programming and setting up the reader interface. The reader library consists of layers mentioned below

• AL (Application Layer)
• PAL (Protocol Abstraction Layer)
• HAL (Hardware Abstraction Layer)
• BAL (Bus Abstraction Layer)
• Common Layer
• Other
• Initialization Sequence

Each Layer consists of different components having a generic interface and a specific implementation.
Find more information on the usage of the reader library in the related Application Notes [17].

---

Application Layer

Contains Application specific implementations for various contactless cards like ULTRALIGHT, CLASSIC, Plus, DESFire and so on...

• MIFARE(R) Ultralight
  Command sets as described in [1]
• MIFARE(R) Classic
  Command sets as described in [2]
• MIFARE Plus (R)
  Command sets as described in [3]
• MIFARE Plus EVx
  Command sets as described in [3]
• MIFARE DESFire (R)
  Command sets as described in [4]
• MIFARE DESFire EVx
  Command sets as described in [4]
• MIFARE DESFire Light
  Command sets as described in [4]
• MIFARE DUOX
  Command sets as described in [5]
• MIFARE PRIME NTAG
  Command sets as described in [6]
• NTAG 42x DNA / TT
  Command sets as described in [7]
• NTAG X DNA
  Command sets for NTAG X DNA
• Virtual Card Architecture (R)
  Command sets as described in MIFARE Plus EVx, MIFARE DESFire EVx and MIFARE DUOX
• ICode
  Command sets as described in [8]
• ISO/IEC 18000-3 Mode3 Command sets as described in [8]
• Felica Part of Felica Open Command sets. Read, Write, Request Response, Request Service, REQC, ATQC are implemented.

---

Protocol Abstraction Layer

Contains Hardware-Independent implementations of various contactless protocols.

• ISO/IEC 14443-3A
  As described in [9]
• ISO/IEC 14443-3B
  As described in [9]
• ISO/IEC14443-4A
  As described in [10]
• ISO/IEC14443-4
  As described in [10]
• MIFARE(R)
  MIFARE TM component needs to be included for any MIFARE Card
• ISO/IEC 15693 / ISO/IEC 18000-3m1
  ISO15693/ISO 18000-3m1 as described in [11] and [12]
• ICODE EPC, ICODE UID
  ISO 18000-3m3 as described in [11]
• ISO/IEC 18092 Mode Passive Initiator
  ISO 18092 Passive initiator, the DEP protocol as well as the passive communication mode as described in [13]
• Felica Felica compliant protocol, as described in [23] parts of it are also part of ISO 18092, see [13]

---

Hardware Abstraction Layer

The Hardware Abstraction Layer implements the Hardware specific elements of the reader.

• Component : Callback
  It is used to test the whole library. For a real implementation within a reader,
  this component has no use.
• Component : Rc523
  Reader Specifics for the RC523. It therefore also covers PN512 and RC522.
• Component : Rc632
  Reader Specifics for the RC632. It therefore also covers RC500, RC530 and RC531.
• Component : Rc663
  Reader Specifics for the RC663. Find more information on this product in [14]
• Component : Rd70x
  Reader Specifics for the RD701 (Pegoda).
• Component : Rd710
  Reader Specifics for the RD710 (Pegoda). Find more information on this product in [15]
• Component : SamAV2
  Specifics on the MIFARE TM SAM AV2. Find more information on this product in [16]
• Component : SamAV3
  Specifics on the MIFARE TM SAM AV3. Find more information on this product in [17]

---

Bus Abstraction Layer

The Bus Abstraction Layer is defining the interface used.

• Component : Stub
  This is the template which may be filled out e.g. the specific SPI interface for a microcontroller.
• Component : PCSC (Windows)
  The PC/SC interface, this interface is used to communicate with PCSC readers, see [6]
• Component : RS232 (Windows)
  The RS232 is used for the demoboards, such as the RC663 demoboard.
• Component : Rd70x USB (Windows)
  This interface is used within the RD701 reader, see more in [5]
• Component : SAM
  This interface is used to communicate with SAM via PCSC or VCom interface, see more in [6]

---

Common Layer

• KeyStore
  Storage of the keys, like MIFARE keys.
• CryptoRng
  Random Number Generator, used for all random numbers to be generated within SW, part of the small footprint library
• CryptoSym
  Symmetric cryptographic algorithms, included in the small footprint library.
• Cid Manager
  The CID manager manages the CID of all cards.
• Tools
  Some tools are attached to calculate the CRC or Parity.
• Log
  Every block has a logging functionality, which can be used.
• TMI Utilities
  Activate, Deactivation and Collection of TMI.

---

Other

• Error Code Collection
  A collection of error codes known.
• Platform Definitions
  Definitions for specific platform.
• (Private definitions)

---

Initialization Sequence

• PAL Initialization Example(s)
  Initialization sequence of PAL Component linking the HALs.
• HAL and BAL Initialization Example(s)
  Initialization sequence of HAL Component linking the BALs.
• Initialization and sample code for ASymmetric Crypto component.