Demo/NxpNfcRdLib
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
Develop_Raspi4B+PN5180
NxpNfcRdLib/Examples/NfcrdlibEx5_ISO15693/Readme.txt
yegaogang 042721aab5 [Add] First commit
2024-07-08 21:03:06 +08:00

245 lines
8.5 KiB
Plaintext
Raw Permalink Blame History

__________________________________________________
NXPNFCRDLIB EXAMPLE : NFCRDLIBEX5_ISO15693
(V07.10.00)
__________________________________________________
Table of Contents
_________________
1 Document Purpose
2 Description of the NfcrdlibEx5_ISO15693
3 Restrictions on NfcrdlibEx5_ISO15693
4 Package Contents
5 Mandatory materials (not included)
6 Hardware Configuration
7 Software Configuration
8 Steps to build NfcrdlibEx5_ISO15693 for LPC1769 with PN5190 using MCUXpresso
9 Steps to build NfcrdlibEx5_ISO15693 for LPC1769 with PN5180 using MCUXpresso
10 Steps to build NfcrdlibEx5_ISO15693 for LPC1769 with RC663 using MCUXpresso
11 Steps to build NfcrdlibEx5_ISO15693 for PN7462AU using MCUXpresso
12 Steps to build NfcrdlibEx5_ISO15693 for FRDM-K82F using MCUXpresso
13 Selection of Board / OSAL / Frontend (MCUXpresso)
14 Steps to follow for PI / Linux / CMake
15 Running NfcrdlibEx5_ISO15693
16 List of supported NFC Reader Boards/ICs
17 Reference Documents
1 Document Purpose
==================
This document describes the steps to be followed to execute
NfcrdlibEx5_ISO15693 example as well as it's known problems and
restrictions.
2 Description of the NfcrdlibEx5_ISO15693
=========================================
- NfcrdlibEx5_ISO15693 can be run with CLEV663B, PN5180, PN5190 and
PN7462AU. (See Section-16 for supported versions)
- This example will load/configure Discovery loop with NFC profile via
SetConfig.
- By using POLL mode of discovery loop, example will detect the ISO
15693 cards and display/print detected tag information like UID,
Block Read and Block Write status.
- This example will activate device at index zero whenever multiple
cards are detected.
3 Restrictions on NfcrdlibEx5_ISO15693
======================================
- NfcrdlibEx5_ISO15693 is restricted to be run on NFC Reader
Boards/ICs mentioned in Section-16.
- 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 v07.10.00 or later.
- **IMPORTANT** The default used MCU Type is K82. When executing
example on LPC1769 or PN7462AU, the MCU Type has to be changed in
the MCUXpresso IDE.
- For switching to MCU Type to PN7462AU, see Section-11
- For switching to MCU Type to LPC1769, see Section-8, Section-9 and
Section-10.
4 Package Contents
==================
- Readme.txt
+ This readme file
- NfcrdlibEx5_ISO15693.c
+ Main example file.
- intfs/NfcrdlibEx5_ISO15693.h
+ Interfaces/Defines specific to the example
- intfs/ph_NxpBuild_App.h
+ Reader library build configuration file
- src/phApp_Helper.c
- src/phApp_PN5180_Init.c
- src/phApp_PN5190_Init.c
- src/phApp_PN7462AU_Init.c
- src/phApp_RC663_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.
- Plugin to extend MCUXpresso to support PN7462AU. (Required for
MCUXpresso versions before MCUXpressoIDE_10.0.2)
- LPCXpresso LPC1769 / Freedom K82 development boards For NFC ICs
listed in Section-16 (Note: PN7462AU (Section-16 Bullet-3) 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
- AN11744: PN5180 Evaluation board quick start guide
- AN11802: NFC Reader Library for Linux Installation Guidelines
- AN12550: PNEV5190B Evaluation board quick start guide
7 Software Configuration
========================
- The Software can be compiled for Cortex M3 LPC1769 micro-controller,
Cortex M4 Freedom K82 and Cortex M0 based PN7462AU 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, Section-10, Section-11 and Section-12.
8 Steps to build NfcrdlibEx5_ISO15693 for LPC1769 with PN5190 using MCUXpresso
==============================================================================
See "PNEV5190B Evaluation board quick start guide" in AN12550 (See
Section-17, Bullet-6 below)
9 Steps to build NfcrdlibEx5_ISO15693 for LPC1769 with PN5180 using MCUXpresso
==============================================================================
See "Importing provided SW example projects" in AN11908 (See
Section-17, Bullet-2 below)
10 Steps to build NfcrdlibEx5_ISO15693 for LPC1769 with RC663 using MCUXpresso
==============================================================================
See "Importing provided SW example projects" in AN11022 (See
Section-17, Bullet-3 below)
11 Steps to build NfcrdlibEx5_ISO15693 for PN7462AU using MCUXpresso
====================================================================
- For MCUXpresso versions before MCUXpressoIDE_10.0.2, See "Adding
PN7462AU Plugin" in UM10883. (See Section-17, Bullet-4 below)
- See "Importing provided SW example projects" in UM10883.
12 Steps to build NfcrdlibEx5_ISO15693 for FRDM-K82F using MCUXpresso
=====================================================================
See "Import projects to the MCUXpresso" in AN11908. (See Section-17,
Bullet-2 below)
13 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.
14 Steps to follow for PI / Linux / CMake
=========================================
The steps are described in AN11802. (See Section-17, Bullet-5 below)
15 Running NfcrdlibEx5_ISO15693
===============================
Run the application and when you bring the ISO 15693 in proximity, the
example application will detect and displays the detected card
information on console.
16 List of supported NFC Reader Boards/ICs
==========================================
1) CLEV6630B v2.0 Customer Evaluation Board
2) PNEV5180B v2.0 Customer Evaluation Board
3) PN7462AU v2.1 Customer Evaluation Board
4) PNEV5190B v1.0 Customer Evaluation Board
17 Reference Documents
======================
1) UM10954 : PN5180 SW Quick start guide
[http://www.nxp.com/docs/en/user-guide/UM10954.pdf]
2) AN11908 : NFC Reader Library for FRDM-K82F Board Installation
guidelines
[http://www.nxp.com/docs/en/application-note/AN11908.pdf]
3) AN11022 : CLRC663 Evaluation board quick start guide
[http://www.nxp.com/docs/en/application-note/AN11022.pdf]
4) UM10883 : PN7462AU Quick Start Guide - Development Kit
[http://www.nxp.com/docs/en/user-guide/UM10883.pdf]
5) AN11802 : NFC Reader Library for Linux Installation Guidelines
[http://www.nxp.com/docs/en/application-note/AN11802.pdf]
6) AN12550 : PNEV5190B Evaluation board quick start guide
----------------------------------------------------------------------
For updates of this example, see
[http://www.nxp.com/products/:NFC-READER-LIBRARY]
Reference in New Issue View Git Blame Copy Permalink