NXP Semiconductors AN12398 User manual

AN12398
EdgeLock SE05x Quick start guide with Visual Studio project
examples
Rev. 2.5 — 12 September 2022 Application note
534625
Document information
Information Content
Keywords EdgeLock SE05x, EdgeLock SE05x Plug & Trust Middleware, Visual Studio
projects
Abstract This document explains how to get started with EdgeLock SE05x Plug &
Trust middleware using the Visual Studio project examples. It provides
detailed instructions to run the Microsoft Visual Studio projects using the
CMake-based build system included in the EdgeLock SE05x Plug & Trust
middleware.

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
Revision history
Revision
number
Date Description
1.0 2019-06-08 First document release
1.1 2019-06-20 Update of board figures
2.0 2019-11-25 Update of CMake buld system materials
2.1 2019-12-17 Corrected OM-SE05xARD J14 jumper setting
2.2 2020-11-19 Update for EdgeLock SE051
2.3 2020-12-07 Updated to the latest template and fixed broken URLs
2.4 2022-06-02 Add EdgeLock SE050E and EdgeLock A5000 product variants.
Update Table 1, Figure 1, Figure 2, Figure 3, Figure 5, Figure 6, Figure 7, Figure 8,
Figure 9, Figure 10, Figure 11, Figure 12, Figure 13, Figure 14, Figure 15, Figure 16,
Figure 17, Figure 18, Figure 19, Figure 20, Figure 21, Figure 22, Figure 23, Figure 31,
Figure 32, Figure 33, Figure 34, Figure 35, Figure 36, Figure 43, Figure 44 and Figure 45.
Add Section Section 5 Product specific CMake build settings.
Add Section Binding EdgeLock SE05x to a host using Platform SCP Binding EdgeLock
SE05x to a host using Platform SCP.
Update tool versions in Section 7, Section 8 and Section 9.
Moved section "Update FRDM-K64F board with DAPLink firmware" into Section 10.
2.5 2022-07-04 Update to EdgeLock SE Plug & Trust Middleware version 04.02.xx.
Update Section Section 5 Product specific CMake build settings.
Update Section Binding EdgeLock SE05x to a host using Platform SCP Binding EdgeLock
SE05x to a host using Platform SCP.
Revision history
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 2 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
1 How to use this document
The Plug & Trust middleware package is delivered with the CMake files that include
the set of directives and instructions describing the project's source files and targets.
The CMake architecture allows developers to build files for their platform and native
build environment and run exactly the same project example on PC/Windows/Linux and
embedded targets.
This document provides detailed instructions to run Visual Studio examples provided in
the Plug & Trust middleware using FRDM-K64F and OM-SE05xARD boards. The main
body of this document should be used in this sequence:
1. Order board samples. Section 2 contains the ordering details of the boards required in
this document
2. Setup your boards. Section 3 describes how to setup the OM-SE05xARD and FRDM-
K64F boards.
3. Run project examples. Go to Section 4 for instructions to import and run EdgeLock
SE05x Visual Studio project examples.
Supplementary material has been provided in the appendices.
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 3 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
2 Hardware required
The EdgeLock SE05x works as an auxiliary security device attached to a host controller,
communicating with through an I²C interface. To follow the instructions provided in this
document, you need an EdgeLock SE05x development board and a FRDM-K64F MCU
board, acting as a host controller.
EdgeLock SE05x development boards ordering details
The EdgeLock SE05x and EdgeLock A5000 product support packages are providing
development boards for evaluating EdgeLock SE05x and EdgeLock A5000 features.
Select the development board of the product you want to evaluate. Table 1 details the
ordering details of the EdgeLock SE05x and EdgeLock A5000 development boards.
Part number 12NC Description Picture
OM-SE050ARD-E 9354 332 66598 SE050E Arduino®
compatible
development kit
OM-SE050ARD-F 9354 357 63598 SE050 Arduino®
compatible
development kit
OM-SE050ARD 9353 832 82598 SE050F Arduino®
compatible
development kit
OM-SE051ARD 9353 991 87598 SE051 Arduino®
compatible
development kit
OM-A5000ARD 9354 243 19598 A5000 Arduino®
compatible
development kit
Table 1. EdgeLock SE05x development boards.
Note: The pictures in this guide will show SE050E, but all boards in Table 1 can be used
as well with the same hardware configuration.
FRDM-K64F MCU board ordering details
Table 2 details the ordering details for the FRDM-K64F board.
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 4 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
Part number 12NC Content Picture
FRDM-K64F 935326293598 Freedom development
platform for Kinetis
K64, K63 and K24
MCUs
Table 2. FRDM-K64F details
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 5 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
3 Boards setup
This section explains how to prepare the OM-SE05xARD boards and FRDM-K64F board
to run the Plug & Trust middleware project examples. This consists of:
1. OM-SE05xARD jumper configuration.
2. OM-SE05xARD and FRDM-K64F board connection.
Note: If your FRDM-K64F board does not already contain the DAPLink firmware, you
need to update the FRDM-K64F board as described in Section 10.
3.1 OM-SE05xARD jumper configuration
The OM-SE05xARD boards have jumpers that allow you to configure the I2C interface of
EdgeLock SE05x secure elements via the Arduino header. Configure the jumper settings
as shown in Figure 1 to enable this option.
Note: For more information about the jumper settings, refer to AN13539 OM-SE05xARD
hardware overview.
Figure 1. Jumper configuration for FRDM-K64F
3.2 OM-SE05xARD and FRDM-K64F board connection
The OM-SE05xARD boards and FRDM-K64F board can be directly connected using the
Arduino connectors. The OM-SE05xARD boards come with male connectors while the
FRDM-K64F board comes with female headers.
Mount any OM-SE05xARD board on top of the FRDM-K64F as shown in Figure 2:
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 6 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
Figure 2. Arduino connectors of OM-SE05xARD and FRDM-K64F boards
Double check that the two boards are connected as shown in Figure 3:
Figure 3. OM-SE05xARD mounted in FRDM-K64F board
Note: Refer to Figure 1 for OM-SE05xARD jumper configuration.
3.3 Flash FRDM-K64F with VCOM software
The VCOM software allows the FRDM-K64F board to be used as a bridge between the
Windows machine and the EdgeLock SE05x and enables the execution of the EdgeLock
SE05x ssscli tool and other utilities from the laptop. To flash the VCOM software into
the FRDM-K64F, follow these steps:
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 7 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
1. Unplug and plug again the USB cable to the openSDA USB port as shown in Figure 4:
Figure 4. Unplug and plug OpenSDA port
2. When you plug the board, your laptop should recognize the board as an external drive
as shown in Figure 5:
Figure 5. FRDM-K64F drive
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 8 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
3. Flash the VCOM software to FRDM-K64F. The VCOM software binary can be found
in the Plug & Trust middleware package, inside the simw-top\binaries folder as
shown in Figure 6:
Figure 6. VCOM binary folder
4. Drag and drop or copy and paste the a7x_vcom-T1oI2C-frdmk64f-SE050x.bin
file into the FRDM-K64F drive from your computer file explorer as shown in Figure 7:
Figure 7. Drag and drop VCOM binary
5. The serial and VCOM ports should be recognized by your Device Manager. To check
that the ports are recognized, follow the steps indicated in Figure 8:
a. Unplug the USB cable from the OpenSDA USB port.
b. Plug the USB cable to the OpenSDA USB port.
c. Check that the serial port is recognized in the category Ports (COM & LTP). In
this document, it is recognized as USB Serial Device (COM7) but this naming
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 9 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
might change depending on your computer. Therefore, it is important that you
identify which device is recognized at the moment you plug the SDA USB port to
the computer.
d. Plug the USB cable to the K64F USB port.
e. Check that the VCOM port is recognized in the category Ports (COM & LTP).
In this document, it is recognized as Virtual Com Port (COM8) but this naming
might change depending on your computer (e.g. It could also appear named as
USB Serial Device). Therefore, it is important that you identify which device is
recognized at the moment you plug the K64F USB port to the computer.
Figure 8. Check VCOM and serial ports
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 10 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
4 Run Plug & Trust middleware Visual Studio project examples
This section explains how to run Plug & Trust middleware Visual Studio project examples
using the CMake-based build system.
4.1 Prerequisites
The following tools are required to run the Plug & Trust middleware Visual Studio
projects:
1. Install Visual Studio ≥ 2017 version, or higher, in your laptop. For reference, Section 7
illustrates how Visual Studio 2022 version can be installed, but the same procedure
can be applied for more recent versions.
2. Install CMake. For reference, Section 8 illustrates the detailed installation instructions.
3. Install Python Python ≥ 3.7.x and ≤ 3.9.x 32-bit version, in your laptop. For reference,
Section 9 illustrates how Python 3.7.x 32-bit version can be installed, but the same
procedure can be applied for more recent versions.
4.2 Download Plug & Trust middleware
Follow these steps to download the Plug & Trust middleware in your local machine:
1. Download Plug & Trust middleware from the NXP website.
2. Create a folder called se05x_mw in C: directory as shown in Figure 9:
Figure 9. Create se05x_mw folder
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 11 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
3. Unzip the Plug & Trust middleware inside the se05x_mw folder. After unzipping, you
will see a folder called simw-top created. The contents of the simw-top directory
should look as shown in Figure 10:
Figure 10. Unzip se050 middleware
Note: It is recommended to keep se05x_mw with the shortest path possible and
without spaces in it. This avoids some issues that could appear when building the
middleware if the path contains spaces.
4.3 Build Plug & Trust middleware project examples
The Plug & Trust middleware uses CMake for building the project examples into your
local machine. To build Plug & Trust middleware, open a Command Prompt and use the
following steps as shown in Figure 12:
1. Go to folder with the unzipped SE050 middleware:
(1) Send >> cd C:\se05x_mw\simw-top\scripts
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 12 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
2. Define the environment:
(2) Send >> env_setup.bat
Figure 11. Generate Plug & Trust middleware define the environment
Depending on your PC installation you may need to update the application file
locations within the env_setup.bat file.
3. Generate the Plug & Trust middleware project examples:
(3) Send >> python create_cmake_projects.py
Note: This command may take a few seconds to complete.
Figure 12. Generate Plug & Trust middleware project examples
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 13 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
4. Your project directory should now contain two folders: a (1) simw-top folder and a (2)
simw-top_build folder as shown in Figure 13:
Figure 13. SE050 middleware project structure
4.4 Execute EdgeLock SE05x Visual Studio project examples
This section explains how to run the Plug & Trust middleware project example called
se05x_minimal. The se05x_minimal project outputs the memory left in EdgeLock
SE05x security IC.
Note: The execution of the se05x_minimal project is shown as an example. The steps
detailed in this section can be replicated to run any other project example included as
part of the Plug & Trust middleware.
To execute the se05x_minimal test example, follow these steps:
1. Connect the FRDM-K64F board to your laptop as shown in Figure 14. Check that your
Windows Device Manager recognizes FRDM-K64F board as shown in Figure 8. Refer
to Figure 1 for OM-SE05xARD jumper configuration.
Figure 14. Plug OpenSDA and USB FRDM-K64F ports.
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 14 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
2. Open the CMake configuration menu as shown in Figure 15 and ensure that all the
flags are set properly for your use case.
a. Open a command prompt and go to the directory where the Plug & Trust
middleware is built.
Send: cd C\se05x_mw\simw-top_build\se_x86
b. Open the cmake configuration interface.
Send: cmake-gui .
Figure 15. Open the CMake configuration interface
This step allows the user to customize the compiation options. The default build
configuration of the EdgeLock SE05x Plug & Trust middleware ≥ V04.02.0x
generates code for the OM-SE050ARD-E development board. You need to adapt
the CMake settings in case you are using a different EdgeLock secure element
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 15 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
development board or a different secure element product IC. The settings are
described in Section 5. The default SE050E settings are shown in Figure 16.
In this example we use plain communication. Plain communication for the example
execution is enabled by selecting the following options:
•Select None for the CMake option PTMW_SE05X_Auth.
•Select None for the CMake option PTMW_SCP.
How to enable Platform SCP is described in How to enable Platform SCP.
Figure 16. Review CMake configuration
If you have edited any of the parameters in the menu, before exiting press the buttons
Configure and Generate to apply the changes.
For more information about the CMake options please refer the CMake section
of Plug & Trust middleware documentation: simw-top/doc/scripts/
cmake_options.html
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 16 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
3. Go to the C:\se05x_mw\simw-top_build\se_x86 directory. Double click the
PlugAndTrustMW.sln Visual Studio project solution as shown in Figure 17:
Figure 17. Open PlugAndTrustMW.sln Visual Studio project solution
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 17 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
4. The Visual Studio IDE will open with the Plug & Trust middleware project examples
included in the workspace as can be seen in Figure 18:
Figure 18. PlugAndTrustMW.sln Visual Studio project workspace
5. Change the VCOM port number in the Plug & Trust middleware project. To do so,
follow the instructions shown in Figure 19:
a. Go to the ex_common project and open the ex_sss_ports.h file inside the
headers directory.
b. Change #define EX_SSS_BOOT_SSS_COMPORT_DEFAULT "\\\\.\\COMx"
with the port COM number your laptop assigned to your FRDM-K64F. In this setup,
the COM number is COM9.
Figure 19. Change VCOM port number in your solution
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 18 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
6. Select the se05x_minimal project from the Solution Explorer window located on the
right-hand side of the Visual Studio IDE. Do right-click on the project and click on Set
as StartUp project as shown in Figure 20:
Figure 20. Set se05x_minimal as StartUp project
7. Right click on the se05x_minimal project and build it by clicking the build option as
shown in Figure 21.
Figure 21. Build se05x_minimal project
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 19 / 48

NXP Semiconductors AN12398
EdgeLock SE05x Quick start guide with Visual Studio project examples
8. Click on Local Windows Debugger button in the top menu to run se05x_minimal
project as shown in Figure 22. The project will be executed after the project building
process has finished.
Figure 22. Run se05x_minimal project
9. If the se05x_minimal project runs successfully, a Console window will be opened.
The logs in this Console window indicate the available memory in EdgeLock SE05x
security IC (in this case, 592) as can be seen in Figure 23:
Figure 23. Verify that se05x_minimal project is running
10.The same operation can be repeated with any of the other Plug & Trust middleware
project examples.
AN12398 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2022. All rights reserved.
Application note Rev. 2.5 — 12 September 2022
534625 20 / 48