NXP_PN512_NFCReaderLibrary/Readme.txt

195 lines
6.1 KiB
Plaintext

_____________________________________________________
NXPNFCRDLIB SW PACKAGE :
(v4.040.05.011646_20161115)
_____________________________________________________
Table of Contents
_________________
1 Document Purpose
2 Description of the package
3 Restrictions
4 Configurations
5 Package Contents
6 Mandatory materials (not included)
7 Hardware Configuration
8 Software Configuration
9 Steps to follow
10 List of supported NFC Reader Boards/ICs
1 Document Purpose
==================
This document describes the content of the NXPNfcRdLib package and steps how
to import it to the LPCXPRESSO IDE as well, known problems and restrictions.
2 Description of the package
===================================================
- The package contains implementation of the NXPNfcReaderLibrary, LPC1769 and
LPC11u68 µC support and examples to demonstrate how to use the library.
- This package is preconfigured for LPC1769 and PNEV512B.
3 Restrictions
================================================
- Package contains implementation for LPC1769 and LPC11U68 only and it does
not provide support for any other platform.
- Application projects are prepared for LPCXpresso IDE.
4 Configurations
==================================================
- Package is preconfugured for LPC1769.
5 Package Contents
==================
- Readme.txt
+ This readme file
- NXP_SLDA.pdf
+ NXP Software License and Distribution Agreement
- NxpNfcRdLib_LPCx_PN512_PubRel.zip
+ release package of the NFCRdLib and examples
- FreeRTOS_Library
+ FreeRTOS support
- lpc_board_nxp_lpcxpresso_1769
+ LPC board support
- lpc_chip_175x_6x
+ LPC support
- Nfcrdlib_SimplifiedAPI_EMVCo
+ project package of the example
- Nfcrdlib_SimplifiedAPI_ISO
+ project package of the example
- NfcrdlibEx1_BasicDiscoveryLoop
+ project package of the example
- NfcrdlibEx2_AdvancedDiscoveryLoop
+ project package of the example
- NfcrdlibEx3_NFCForum NfcrdlibEx4_MIFAREClassic
+ project package of the example
- NfcrdlibEx5_ISO15693
+ project package of the example
- NfcrdlibEx6_EMVCo_Loopback
+ project package of the example
- NfcrdlibEx7_EMVCo_Polling
+ project package of the example
- NfcrdlibEx8_HCE_T4T
+ project package of the example
- NfcrdlibEx9_NTagI2C NxpNfcRdLib
+ project package of the example
- NxpNfcRdLib
+ NXPNfcReaderLibrary package
6 Mandatory materials (not included)
====================================
- LPCXpresso IDE as described on the web site:
[http://www.nxp.com/products/software-and-tools/software-development-tools/:LPCXPRESSO]
- LPCXpresso LPC1769 / LPCXpresso 11u68 / Freedom K82 development boards
For NFC ICs listed in Section-10 (Note: PN7462AU (Section-10 Bullet-4)
does not need any other other microcontroller).
7 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.
- AN11308: Quick Start Up Guide PNEV512B Board.
+ Important: See Section on "Soldering the interrupt connection" in
that document.
8 Software Configuration
========================
- The Software can be compiled for Cortex M3 LPC1769 micro-controller,
Cortex M0+ LPC11u68 micro-controller.
9 Steps to follow
=================
Steps for opening the package in LPCXpresso IDE:
1) For running this application, connect one of the boards as listed in
Section-10
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
Steps to import the project:
- Select "Import Project(s)" in Quickstart panel.
- Browse to the NxpNfcRdLib_LPCx_PN512_PubRel.zip file.
- Keep default setings in the wizard and finish it.
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
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
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-10
6) Build the project.
7) Start the "Debug" session of IDE which will first flash the executable
and start the task.
8) When this application is running on the target MCU setup and when you
bring the NFC cards or phone in proximity, the example application will
detect and reports the NFC technology types detected.
10 List of supported NFC Reader Boards/ICs
==========================================
1) PNEV512B Blueboard 1.5
---------------------------------------------------------------------------
For updates of this example, see
[http://www.nxp.com/pages/:NFC-READER-LIBRARY]