            _____________________________________________________

              NXPNFCRDLIB EXAMPLE : NFCRDLIB_SIMPLIFIEDAPI_ISO
                             (V4.040.05.011646)
            _____________________________________________________


Table of Contents
_________________

1 Document Purpose
2 Description of the Nfcrdlib_SimplifiedAPI_ISO
3 Restrictions on Nfcrdlib_SimplifiedAPI_ISO
4 Package Contents
5 Mandatory materials (not included)
6 Hardware Configuration
7 Software Configuration
8 Steps to follow
9 List of supported NFC Reader Boards/ICs





1 Document Purpose
==================

  This document describes the steps to be followed to execute
  Nfcrdlib_SimplifiedAPI_ISO example as well as it's known problems and
  restrictions.

  Note: This example is still under development and should be deemed to be of
  Beta Quality


2 Description of the Nfcrdlib_SimplifiedAPI_ISO
===============================================

  This example is a Reference Application to demonstrate the usage of
  Simplified API with ISO profile. Application contains example of Type A
  Layer 4, Type B Layer 4, Mifare Desfire, Mifare UltraLight, Mifare Classic,
  ISO 15693 and ISO 18000p3m3.


3 Restrictions on Nfcrdlib_SimplifiedAPI_ISO
============================================

  - Nfcrdlib_SimplifiedAPI_ISO is restricted to be run on NFC Reader
    Boards/ICs mentioned in Section-9.
  - The APIs are intended for NXP contact-less reader ICs only, as such the
    APIs are not to be ported to any technology from any other vendor.
  - NXP will not support porting to any other vendor platform.
  - This software project requires NxpNfcRdLib v4.040.05.011646 or later.
  - To compile and flash this project into the LPC Family or PN7462AU, you
    need to import this project using NXP LPCXpresso v8.1.x or later.
  - To compile and flash this project into the K82 Freedom Board, you need to
    import this project using KDS-3.2.0 or later.
  - The packages for KDS and LPCXpresso are separate. Package for KDS can not
    be imported into LPCXpresso and vice-versa.
  - This demo is executed only with FreeRTOS


4 Package Contents
==================

  - Readme.txt
    + This readme file
  - Nfcrdlib_SimplifiedAPI_ISO.c
    + Main example file.
  - intfs/Nfcrdlib_SimplifiedAPI_ISO.h
    + Interfaces/Defines specific to the example
  - intfs/ph_NxpBuild_App.h
    + Reader library build configuration file
  - src/Nfcrdlib_SimplifiedApi_ISO_15693.c
  - src/Nfcrdlib_SimplifiedApi_ISO_18000.c
  - src/Nfcrdlib_SimplifiedApi_ISO_Layer4TypeA.c
  - src/Nfcrdlib_SimplifiedApi_ISO_MFC.c
  - src/Nfcrdlib_SimplifiedApi_ISO_MFDF.c
  - src/Nfcrdlib_SimplifiedApi_ISO_MFUL.c
  - src/Nfcrdlib_SimplifiedApi_ISO_TypeB.c
    + Reference Functionality for the component of corresponding protocol
  - intfs/Nfcrdlib_SimplifiedApi_ISO.h
  - intfs/Nfcrdlib_SimplifiedApi_ISO_15693.h
  - intfs/Nfcrdlib_SimplifiedApi_ISO_18000.h
  - intfs/Nfcrdlib_SimplifiedApi_ISO_MFC.h
  - intfs/Nfcrdlib_SimplifiedApi_ISO_MFDF.h
  - intfs/Nfcrdlib_SimplifiedApi_ISO_MFUL.h
    + Function Macros to create the command for the component of
      corresponding protocol
  - .cproject and .project
    + LPCXpresso project configuration file


5 Mandatory materials (not included)
====================================

  - LPCXpresso IDE as described on the web site:
    [http://www.nxp.com/products/software-and-tools/software-development-tools/:LPCXPRESSO]
  - Kinetis(R) Design Studio IDE as described on the web site:
    [http://www.nxp.com/products/software-and-tools/run-time-software/kinetis-software-and-tools/:KDS_IDE]
  - LPCXpresso LPC1769 / LPCXpresso 11u68 / Freedom K82 development boards
    For NFC ICs listed in Section-9 (Note: PN7462AU (Section-9 Bullet-) does
    not need any other other microcontroller).


6 Hardware Configuration
========================

  Before starting this application, HW Changes may be required for the used
  board.  Refer to the following User Manuals / Application notes before
  starting with this example.

  - AN11211: Quick Start Up Guide RC663 Blueboard
    + Important: See Section on "Soldering the interrupt connection" in
      that document.
  - AN11744: PN5180 Evaluation board quick start guide


7 Software Configuration
========================

  - The Software can be compiled for Cortex M3 LPC1769 micro-controller.
  - Since this example can be configured to run on various MCU ICs and
    various NFC ICs, appropriate changes are required as mentioned in
    Section-8, Bullet-3, Bullet-4 and Bullet-5.


8 Steps to follow
=================

  Please note - If you have not done the hardware changes as required in
  Section-6, please do so.

  Steps for opening the package in LPCXpresso:

  1) For running this application, connect one of the boards as listed in
     Section-9

  2) Create a new LpcXpresso workspace and import this project and it's
     dependencies:

     For LPC1769 : NxpNfcRdLib, lpc_board_nxp_lpcxpresso_1769, lpc_chip_175x_6x
                   and FreeRTOS_Library needs to be imported
     For LPC11u68: NxpNfcRdLib, lpc_board_nxp_lpcxpresso_11u68, lpc_chip_11u6x
                   and FreeRTOS_Library needs to be imported
     For FRDMK82 : NxpNfcRdLib and SDK_2.0_FRDM-K82F and FreeRTOS_Library needs
                   to be imported
     For PN7462AU: NxpNfcRdLib, PN7462AU and FreeRTOS_Library needs to be
                   imported

  3) Ensure MCU Type in "Project Properties" --> "C/C++ Build" --> "MCU
     Settings" for this project and its dependencies as listed in Step-2 is
     set Correctly:

     For LPC1769 : LPC1700 --> LPC1769
     For LPC11u68: LPC11U6x --> LPC11U68
     For PN7462AU: PN74xxxx --> PN7462AU-C3-00

  4) Ensure Build Configuration for this project is selected correctly.
     Where allowed, set the build configuration of dependent projects also.

     For LPC1769 : DebugLPC1769 / ReleaseLPC1769
     For LPC11u68: DebugLPC11u68 / ReleaseLPC11u68
     For PN7462AU: DebugPN7462AU / ReleasePN7462AU
     For FRDMK82 : DebugFRDMK82F / ReleaseFRDMK82F

  5) Please ensure that ph_NxpBuild_App.h is updated as per the selection of
     the IC and Platform.

     e.g. For LPC1769, NXPBUILD__PH_LPC1769 needs to be enabled, and
     NXPBUILD__PH_LPC11U68, NXPBUILD__PHHAL_HW_PN7462AU, etc. needs to be
     disabled.  Similarly, for NXPBUILD__PHHAL_HW_PN5180,
     NXPBUILD__PHHAL_HW_PN7462AU, NXPBUILD__PHHAL_HW_RC523 needs to be
     disabled.  Similar change is needed when switching to other supported
     Board/IC as listed in Section-9

  6) Build the project.

  7) Start the "Debug" session of IDE which will first flash the executable
     and start the task.

  8) The running application can now be used for EMVCo Test case validation.


9 List of supported NFC Reader Boards/ICs
=========================================

  1) CLEV663B v3.0
  2) PN5180 TFBGA64 performance board v1.0

  ---------------------------------------------------------------------------

  For updates of this example, see
  [http://www.nxp.com/pages/:NFC-READER-LIBRARY]
