            ______________________________________________________

                NXPNFCRDLIB EXAMPLE : NFCRDLIB_PRBSAPPLICATION
                                  (V06.10.00)
            ______________________________________________________


Table of Contents
_________________

1 Document Purpose
2 Description of the Nfcrdlib_PRBSApplication
3 Restrictions on Nfcrdlib_PRBSApplication
4 Package Contents
5 Mandatory materials (not included)
6 Hardware Configuration
7 Software Configuration
8 Steps to build Nfcrdlib_PRBSApplication for LPC1769 with PN5190 using MCUXpresso
9 Steps to build Nfcrdlib_PRBSApplication for FRDM-K82F using MCUXpresso
10 Selection of Board / OSAL / Frontend (MCUXpresso)
11 Running Nfcrdlib_PRBSApplication
12 List of supported NFC Reader Boards/ICs
13 Reference Documents





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

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


2 Description of the Nfcrdlib_PRBSApplication
=============================================

  - This example is a PRBS Application which is used to send PRBS9 and PRBS15
    Sequence with different protocols supported by PN5190 Reader.


3 Restrictions on Nfcrdlib_PRBSApplication
==========================================

  - Nfcrdlib_PRBSApplication is restricted to be run on NFC Reader Boards/ICs
    mentioned in Section-12.
  - 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 v06.10.00 or later.
  - **IMPORTANT** The default used MCU Type is K82.  When executing example on
    LPC1769, the MCU Type has to be changed in the MCUXpresso IDE.
  - For switching to MCU Type to LPC1769, see Section-
  - For switching to MCU Type to FRDMK82, see Section-9


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

  - Readme.txt
    + This readme file
  - Nfcrdlib_PRBSApplication.c
    + Main example file.
  - intfs/Nfcrdlib_PRBSApplication.h
    + Interfaces/Defines specific to the example
  - intfs/ph_NxpBuild_App.h
    + Reader library build configuration file
  - src/phApp_Helper.c
  - src/phApp_PN5190_Init.c
  - src/phApp_Init.c and intfs/phApp_Init.h
    + Common utility functions (common across all examples)
  - mcux/.cproject and mcux/.project
    + MCUXpresso project configuration file
  - cr_startup_lpc175x_6x.c
    + Startup required to compile example for LPC1769 Micro Controller.


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

  - MCUXpresso IDE. It can be downloaded from
    [http://www.nxp.com/products/:MCUXpresso-IDE]
  - SDK for Freedom K82 Board ([http://www.nxp.com/products/:FRDM-K82F]).  The
    pre-build SDK can be downloaded from
    [https://mcuxpresso.nxp.com/en/license?hash=9897a8c19a6bc569c3fade7141f0f405&hash_download=true&to_vault=true]
    See MCUXpresso User Manual for steps needed to install an SDK.

  - LPCXpresso LPC1769 / Freedom K82 development boards For NFC ICs listed in
    Section-12.


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.

  - AN12550: PNEV5190B Evaluation board quick start guide


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

  - The Software can be compiled for Cortex M3 LPC1769 micro-controller and
    Cortex M4 Freedom K82 from NXP.
  - 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,
    Section-9.


8 Steps to build Nfcrdlib_PRBSApplication for LPC1769 with PN5190 using MCUXpresso
==================================================================================

  See "PNEV5190B Evaluation board quick start guide" in AN12550 (See
  Section-13, Bullet-2 below)


9 Steps to build Nfcrdlib_PRBSApplication for FRDM-K82F using MCUXpresso
========================================================================

  See "Import projects to the MCUXpresso" in AN11908. (See Section-13, Bullet-1
  below)


10 Selection of Board / OSAL / Frontend (MCUXpresso)
====================================================

  For MCUXpresso, the selection of Board / OSAL / Frontend has to be done via
  -D (Preprocessor defines).

  1) To select the board go to "Project Properties" --> "C/C++ Build" -->
     "Settings" --> "Preprocessor" --> "Defined symbols (-D)", and define the
     relevant PHDRIVER_<BoardNFCCombination>_BOARD macro.

     e.g. For using K82 with Pn5190 use PHDRIVER_K82F_PNEV5190B_BOARD and for
     LPC1769 with PN5190 use PHDRIVER_LPC1769PN5190_BOARD.  For list of
     supported boards refer to Platform\DAL\cfg\BoardSelection.h.

  2) To select the osal/os type, go to "Project Properties" --> "C/C++ Build"
     --> "Settings" --> "Preprocessor" --> "Defined symbols (-D)".

     e.g. For using FreeRTOS use PH_OSAL_FREERTOS. For other options refer to
     RTOS\phOsal\inc\phOsal_Config.h.


11 Running Nfcrdlib_PRBSApplication
===================================

  The example application is written to demonstrate working of TypeBprime with
  PN5190 Reader IC.


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

  1) PNEV5190B v1.0 Customer Evaluation Board


13 Reference Documents
======================

  1) AN11908 : NFC Reader Library for FRDM-K82F Board Installation guidelines
     [http://www.nxp.com/docs/en/application-note/AN11908.pdf]

  2) AN12550 : PNEV5190B Evaluation board quick start guide


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

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