Introduction#

Secure Provisioning SDK (SPSDK) is a unified, reliable, and easy to use Python SDK library working across the NXP MCU portfolio providing a strong foundation from quick customer prototyping up to production deployment.

The library allows the user to connect and communicate with the device, configure the device, prepare, download, and upload data including security operations.

It is delivered in a form of:

Applications - applications which could be called from command-line using Python virtual environment,
APIs - functions in form of Python library.

Delivery#

SPSDK is delivered to:

GitHub
PyPI

Organization#

SPSDK is organized into modules:

List of SPSDK modules#
Module name	Description
apps	This module contains various applications delivered with SPSDK.
crypto	Module for crypto operations (certificate and key management).
dat	This module contains support for Debug Authentication Tool.
debuggers	Wrappers for various types of debuggers.
dk6	Support for programming DK6 devices.
ele	This module contains support for EdgeLock Enclave Tool.
image	Module implementing functionality of srktool, dcdgen, mkimage and other similar tools.
mboot	Module implementing communication with the MCU Bootloader.
memcfg	Module for working with Memory configuration.
pfr	Module for working with Protected Flash Region.
sbfile	Module implementing SBFile.
sdp	Module implementing the SDP communication protocol.
shadowregs	This module contains support for Shadow Registers Tool.
tp	Trust provisioning.
uboot	Uboot device.
utils	Module containing various functions/modules used throughout the SPSDK.
wpc	Module containing support for WPC operations.

Supported Devices#

LPC55 S6x / S3x / S2x / S1x / S0x
i.MX RT 600 / 500
i.MX RT 1064 / 1060 / 1050 / 1024 / 1020 / 1015 / 1010
i.Mx RT 1180 / 1170 / 1160 (blhost)
KW45
K32W1
RW61x
NHS52Sxx
MCXN9xx
MCXA1xx
MCXN23x

Supported OS#

Windows 10 and 11, 64bit
Ubuntu 22.04.1 LTS
Mac OS Sonoma 14

Supported Environment#

SPSDK is tested on Python 3.8+ interpreter, old version 2.x is not supported.

Versioning#

In a given version spsdk x.y.z

x major version (SemVer)
y minor version
z patch version

CLI/API stability notice#

Minor release may break compatibility!!!
Patch release will not break backward compatibility (any occurrence is treated as a bug)

New features might be implemented in both patch and minor releases.

Disclaimer#

All products, including those with advanced security features, may be subject to unidentified vulnerabilities. Customers are responsible for the design and operation of their applications and products to reduce the effect of these vulnerabilities on the customer’s applications and products. NXP accepts no liability for any security vulnerability. Customers are responsible for the design and operation of their applications and products and are responsible to implement appropriate design and operating safeguards to minimize the risk of potential security vulnerabilities associated with their applications and products.

Introduction

Contents