Integrating EdgeLock® SE05X to MIMXRT1180-EVK

[#1]

DISCLAIMER APPLICABLE TO THIS DOCUMENT CONTENTS:

Any support, information, and technology (“Materials”) provided by NXP are provided AS IS, without any warranty express or implied, and NXP disclaims all direct and indirect liability and damages in connection with the Material to the maximum extent permitted by the applicable law. NXP accepts no liability for any assistance with applications or product design.  Materials may only be used in connection with NXP products. Any feedback provided to NXP regarding the Materials may be used by NXP without restriction.

Abstract

This document is intended to guide developers to integrate the EdgeLock® SE050   security chip on the NXP MIMXRT1180EVK  development board to achieve hardware-level security enhancement. The SE05x can be easily connected to any system, with the minimal requirements - only power and two pins for I2C are required. Additionally, it is easy to integrate thanks to the support of the Plug&Trust Middleware for the software on the host. 

Hardware Prerequisite

Host Platform:  MIMXRT1180EVK

Expansion Board: OM-SE050X  

Hardware setup

1.  Configure the OM-SE05xARD jumpers as below[1]:

2. Configure the jumpers on MIMXRT1180-EVK as default[2]:. 

3. Mount OM-SE05xARD on MIMXRT1180-EVK

Software Integration

There are two methods to integrate the OM-SE05xARD to MIMXRT1180-EVK, one is based on SDK, and the other is based on zephyr. Users may select either of them according to their requirements.

SDK Integration:

Platform files generation

The nano package offers a very simple way to integrate the MW on any MCU platforms, Users just need to add/modify the platform specific files which are maintained in simw-nanopkg/lib/platform folder.

Applying the attached patch, you may easily have them as above.

Import I2C demo project as a starting point

We recommend starting the integration based on the SDK I2C demo as this project contain the sdk I2C driver code already, so for RT1180, we import evkmimxrt1180_lpi2c_polling_b2b_master_cm33 . 

 exclude the board files and use the ones from the nano package instead.

import source files from the nano package

Import the example code, here we select ex_se05x_crypto.c and main.c.

Add definitions as below for nano package building , as well as the including paths.

Building project:

Debugging:

Zephyr Integration:
The integration is much simpler than SDK integration, since the platform specific files are already there, users just need to add the board overlay file for MIMXRT1180-EVK manually. The attached overlay file should be placed in the folder such as "workspace/modules/crypto/nxp-plugandtrust/examples/se05x_crypto/zephyr/boards/".

Please note the guide for Zephyr Integration is ready on https://github.com/NXPPlugNTrust/nano-package/blob/master/zephyr/readme.rst , while the tested zephyr version still stays on v3.7.0, which hasn't supported MIMXRT1180-EVK yet. To have the support for MIMXRT1180-EVK, we have to use the latest zephyr, with a modified west.yml file. 

Here are the steps we need to go through:

$ rm workspace/ -rf
 $ mkdir -p workspace
 $ cd workspace/
$ git clone https://github.com/NXPPlugNTrust/nano-package.git
//Edit ~/workspace/nano-package/zephyr/west.yml as below
$ cd ..
$ west init -m https://github.com/NXPPlugNTrust/nano-package.git --mf ~/workspace/nano-package/zephyr/west.yml ~/workspace/
$ cd workspace
$ west update

Build examples:

$ cd workspace/
$ west build -b mimxrt1180_evk/mimxrt1189/cm33 modules/crypto/nxp-plugandtrust/examples/se05x_crypto/zephyr/ --pristine

programming and run:

References:

[1]EdgeLock SE05x Quick start guide with Raspberry Pi

[2]i.MX RT1180 EVK Quick Start Guide