UM2495
User manual
High performance HF reader / NFC initiator IC software expansion for
NUCLEO-8S208RB
Introduction
The high performance HF reader / NFC initiator IC software expansion (STSW-STM8-NFC5) enables the NUCLEO-8S208RB board to operate with the X-NUCLEO-NFC05A1.
This package ports the RF abstraction layer (RFAL) onto the STM8 device to operate with the X-NUCLEO-NFC05A1, which contains the ST25R3911B high performance HF reader / NFC initiator. The package contains a sample application that detects different types of NFC tags and mobile phones supporting P2P.
The RFAL is the STMicroelectronics standard driver for ST25R NFC/RFID reader ICs. It is used, for instance, by the
ST25R3911B-DISCO (STSW-ST25R002) and X-NUCLEO-NFC05A1 (X-CUBE-NFC5) firmware. STSW-STM8-NFC5 supports all the ST25R3911B lower-layer protocols and also some higher layer protocols to abstract RF communication. As the RFAL is written in a portable manner, it can run on a wide range of devices, from 8-bit MCUs up to 64-bit processors running Linux. All the code is highly portable and only minimal effort is needed in order for it to run on any STM8 platform.
RFAL
Protocols ISO DEP NFC DEP
Technologies NFC-A NFC-B NFC-F NFC-V T1T ST25TB
RF
HAL RF Configurations
ST25R3911B
UM2495 - Rev 1 - November 2018
For further information contact your local STMicroelectronics sales office.
www.st.com
1
1.1
1.2
UM2495
Overview
Overview
•
•
•
•
•
STSW-STM8-NFC5 features
Complete driver (RF abstraction layer) to build NFC-enabled applications using the ST25R3911B or
ST25R391x high performance HF reader / NFC initiator with up to 1.4 W output power
Communication with the ST25R3911B or ST25R391x high performance NFC HF reader / NFC initiator using
SPI interface
Complete RF/NFC abstraction (RFAL) for all major technologies and higher layer protocols:
– NFC-A (ISO14443-A)
– NFC-B (ISO14443-B)
– NFC-F (FeliCa)
– NFC-V (ISO15693)
– P2P (ISO18092)
– ISO-DEP (ISO data exchange protocol, ISO14443-4)
– NFC-DEP (NFC data exchange protocol, ISO18092)
– Proprietary technologies (Kovio, B’, iClass, Calypso, among others)
Sample application to detect several NFC tag types and mobile phones supporting P2P
Free user-friendly license terms
Hardware setup
The setup is composed by the NUCLEO-8S208RB STM8 Nucleo-64 board together with the X-NUCLEO-
NFC05A1 expansion board which supports the ST25R3911B device.
Figure 1. X-NUCLEO-NFC05A1 expansion board
1.3
Sample application
A sample application using the X-NUCLEO-NFC05A1 expansion board with the NUCLEO-8S208RB development board is provided in the Projects directory. A ready-to-build project is available for ST Visual Development IDE.
On this application, NFC tags of different types or mobile phones supporting P2P are detected by the
ST25R3911B high performance HF reader / NFC initiator IC.
After system initialization and clock configuration, LED101, LED102, LED103, LED104 and LED105 blink briefly if initialization is successful. Then the demo starts polling for nearby tags/devices.
When a tag/device is detected, a LED is lit on the X-NUCLEO-NFC05A1 shield according to the table below:
UM2495 - Rev 1 page 2/16
UM2495 - Rev 1
UM2495
Sample application
NFC-F
NFC-B
NFC-A
NFC-V
Active P2P
Table 1. X-NUCLEO-NFC05A1 LED lit by detected device
NFC technology LED lit on tag detection
LED101 / Type F
LED102 / Type B
LED103 / Type A
LED104 / Type V
LED105 / Type AP2P
Additionally the user can enable the Wakeup mode by pressing the USER (blue) button on the
NUCLEO-8S208RB. When pressed, the ST25R3911B is placed into the low-power wake-up mode on which it monitors the antenna’s surroundings for any approaching tag/device and informs the MCU of that variation. The
MCU reacts by triggering another poll cycle as described above, and then the ST25R3911B returns to the lowpower wake-up mode.
When the USB cable is connected to a PC, a virtual COM port is listed as shown in the figure below.
Figure 2. Example of virtual COM listed when USB cable is connected to a PC
•
•
•
•
After checking the virtual COM port number, the user has to open a connection on Hyperterminal (or similar) with the following configuration:
Baud: 115200
Data bits: 8
Parity: none
Stop bits: 1
• Flow control: no
Following a successful connection, the user can view the messages on the Hyperterminal, as shown below.
page 3/16
Figure 3. Hyperterminal successful connection message
UM2495
Sample application
UM2495 - Rev 1 page 4/16
UM2495
System setup guide
2
2.1
2.1.1
2.2
System setup guide
This section describes how to setup the different components before writing and executing an application on the
STM8 Nucleo board with the X-NUCLEO-NFC05A1 expansion board.
Hardware description
This section describes the hardware components required for the setup described in this user manual.
X-NUCLEO-NFC05A1 expansion board
The X-NUCLEO-NFC05A1 is a high performance HF reader / NFC initiator expansion board usable with the
STM8 Nucleo boards. It is also compatible with Arduino™ UNO R3 connector layout, and is designed around the
STMicroelectronics IC ST25R3911B high performance HF reader / NFC initiator (with 1.4 W supporting VHBR and AAT). The X-NUCLEO-NFC05A1 interfaces with the STM8 MCU via SPI. Information regarding the X-
NUCLEO-NFC05A1 expansion board is available on www.st.com
.
•
•
Software description
The following software components are needed in order to setup the suitable development environment for creating applications for the STM8 Nucleo equipped with the NFC expansion board:
ST Visual Develop. Refer to STVD-STM8 on www.st.com
Cosmic compiler CXSTM8 for STM8 (COS-C-COMPILER). Refer to the Cosmic STM8 Cross Development
Tools section on www.cosmic-software.com.
UM2495 - Rev 1 page 5/16
UM2495
Hardware and software setup
3
3.1
3.1.1
3.1.2
3.1.3
3.1.3.1
3.1.3.2
Hardware and software setup
This section describes the hardware and software setup procedures as well as the required system setup.
System setup guide
This section describes how to setup the different components before writing and executing an application on the
STM8 Nucleo board with the X-NUCLEO-NFC05A1 expansion board.
STM8 Nucleo and X-NUCLEO-NFC05A1 expansion board setup
The STM8 Nucleo board integrates the ST-LINK/V2-1 debugger/programmer. The user can download the ST-
LINK/V2-1 USB driver by searching STSW-LINK009 software on www.st.com
.
The X-NUCLEO-NFC05A1 expansion board is easily plugged onto the STM8 Nucleo development board through the Arduino™ UNO R3 extension connector. It interfaces with the STM8 microcontroller on the STM8 Nucleo board through the SPI interface.
Hardware required for system setup
The following hardware components are required:
• One STM8S Nucleo development platform (order code: NUCLEO-8S208RB)
•
•
One ST25R3911B high performance HF reader / NFC initiator IC expansion board (order code: X-NUCLEO-
NFC05A1)
One USB type A to Mini-B USB cable to connect the STM8 Nucleo to the PC
Software required for system setup
This section lists the minimum requirements for the developer to set up the SDK and how to use the sample project.
Development toolchains and compilers
•
•
•
Download and install STVD-STM8
Download and install Cosmic STM8 compiler CXSTM8
Setup ST Visual Develop to use the Cosmic compiler
Using the project
This section describes how to compile the sample application and then how to program it on the board.
Compiling
After installling all the tools, follow the steps below:
1.
Open ST Visual Develop IDE
2.
Go to File → Open Workspace and select the file Project.stw
3.
Go to Project → Settings and ensure to select STM8 Cosmic on the Toolset Info
UM2495 - Rev 1 page 6/16
Figure 4. Project Settings window
UM2495
System setup guide
UM2495 - Rev 1
4.
To compile the project go to Build → Rebuild All
Figure 5. "Rebuild All" example at the compiling step
Debugging
1.
When debugging for the first time, it may be required to set the Target to be used. Go to Debug Instrument
→ Target Settings and select SWIM ST-Link page 7/16
Figure 6. Debug Instrument Settings window
UM2495
System setup guide
UM2495 - Rev 1
2.
In order to program the compiled FW and start a debug session go to Debug → Start Debugging , and select
Swim ST-Link
Figure 7. Target selection window
3.
Press Debug → Continue to execute the application.
Flashing
If a precompiled FW is available, it is possible to simply flash it on the IDE by going to Tools → Programmer , or using another tool called ST Visual Programmer (STVP) following the steps below:
1.
Open ST Visual Programmer
2.
Configure the tool in Configure → Configure ST Visual Programmer page 8/16
Figure 8. Configuration window
UM2495
System setup guide
UM2495 - Rev 1
3.
Open the program file by going into File → Open and selecting the generated file (*.s19) page 9/16
Figure 9. Example of file generated at the Flashing step
UM2495
System setup guide
UM2495 - Rev 1
4.
To program the STM8 go to Program → Current Tab.
page 10/16
4
Note:
UM2495
Automotive compliance
Automotive compliance
ST's 8-bit microcontroller platform (STM8) offers MCUs for automotive applications with its STM8AF Series and
STM8AL Series.
To better enable automotive applications, the RF/NFC library (RFAL) included in this demo is fully compliant with the MISRA C:2012 standard.
MISRA C is a set of guidelines for programming in the C language which have been developed and published by the Motor Industry Software Reliability Association (MISRA).
These guidelines aim to improve code safety, security, portability and reliability by identifying aspects of the C language that should be avoided due to their ambiguity and susceptibility to common programming mistakes. The
MISRA standard is widely used by the automotive industry for embedded software.
For further detail on RFAL’s MISRA compliance please refer to the Compliance Report provided on RFAL’s documentation folder.
This demo application is using a STM8S Series device which is not automotive grade. The demo relies on the
Nucleo-64 platform and no STM8A Series device is yet available in this platform.
The STM8S and STM8L Series are very similar to the STM8AF and STM8AL Series, and even pin compatible in some packages, which alleviates porting efforts.
UM2495 - Rev 1 page 11/16
Revision history
Date
05-Nov-2018
Version
1
Table 2. Document revision history
Changes
Initial release.
UM2495
UM2495 - Rev 1 page 12/16
UM2495
Contents
Contents
1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
1.1
STSW-STM8-NFC5 features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2
Hardware setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.3
Sample application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2 System setup guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
2.1
Hardware description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.1.1
X-NUCLEO-NFC05A1 expansion board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2
Software description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3 Hardware and software setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
3.1
System setup guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.1.1
3.1.2
3.1.3
STM8 Nucleo and X-NUCLEO-NFC05A1 expansion board setup. . . . . . . . . . . . . . . . . . . . 6
Hardware required for system setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Software required for system setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
4 Automotive compliance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
List of tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
List of figures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
UM2495 - Rev 1 page 13/16
UM2495
List of tables
List of tables
Table 1. X-NUCLEO-NFC05A1 LED lit by detected device. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Table 2. Document revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
UM2495 - Rev 1 page 14/16
UM2495
List of figures
List of figures
Figure 1. X-NUCLEO-NFC05A1 expansion board. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Figure 2. Example of virtual COM listed when USB cable is connected to a PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Figure 3. Hyperterminal successful connection message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Figure 4. Project Settings window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Figure 5. "Rebuild All" example at the compiling step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Figure 6. Debug Instrument Settings window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Figure 7. Target selection window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Figure 8. Configuration window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Figure 9. Example of file generated at the Flashing step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
UM2495 - Rev 1 page 15/16
UM2495
IMPORTANT NOTICE – PLEASE READ CAREFULLY
STMicroelectronics NV and its subsidiaries (“ST”) reserve the right to make changes, corrections, enhancements, modifications, and improvements to ST products and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on ST products before placing orders. ST products are sold pursuant to ST’s terms and conditions of sale in place at the time of order acknowledgement.
Purchasers are solely responsible for the choice, selection, and use of ST products and ST assumes no liability for application assistance or the design of
Purchasers’ products.
No license, express or implied, to any intellectual property right is granted by ST herein.
Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product.
ST and the ST logo are trademarks of ST. All other product or service names are the property of their respective owners.
Information in this document supersedes and replaces information previously supplied in any prior versions of this document.
© 2018 STMicroelectronics – All rights reserved
UM2495 - Rev 1 page 16/16
