SPSDK Logo

Project overview

  • Introduction
  • Delivery
  • Organization
  • Supported Devices
  • Supported OS
  • Supported Environment
  • Release Notes

Usage

  • Installation Guide
  • Applications
  • APIs

Application User Guides

  • User Guide - blhost
  • User Guide - elftosb
  • User Guide - nxpcertgen
  • User Guide - nxpdebugmbox
  • User Guide - nxpdevhsm
  • User Guide - nxpdevscan
  • User Guide - nxpkeygen
  • User Guide - pfr
  • User Guide - pfrc
  • User Guide - sdphost
  • User Guide - sdpshost
  • User Guide - shadowregs

API Development Guide

  • Crypto Module API
  • Debug Authentication API
  • Debuggers API
  • Image Module API
  • MBoot Module API
  • Protected Flash Region API
  • SBFile Module API
  • SDP Module API
  • Shadow Registers API
  • Utils Module API

Examples

  • Crypto examples
  • General examples
  • Debug Credential with remote signing example
SPSDK
  • »
  • <no title>
  • Edit on GitHub

crypto Module API

  • Crypto Module API
    • Crypto module general information
    • Crypto module key generation
    • Crypto module certificate generation
    • Interface for all potential signature providers
    • Crypto module loading helper functions

dat Module API

  • Debug Authentication API
    • DAT module general information
    • Module for generating debug credentials
    • Module with Debug Authentication Challenge (DAC) Packet
    • Module with Debug Authentication Response (DAR) Packet
    • Module for NXP SPDK DebugMailbox support
    • Module with commands for Debug Mailbox
    • Module with common utils for DAT module

debuggers Module API

  • Debuggers API
    • Module for DebugMailbox Debug probes support
    • Module for DebugMailbox Jlink Debug probes support
    • Module for DebugMailbox Pemicro Debug probes support
    • Module for DebugMailbox PyOCD Debug probes support
    • Module with common utils for debuggers module

image Module API

  • Image Module API
    • Image Classes
    • Image Commands
    • Image Headers
    • Secret Module
    • Data Segments
    • TrustZone
    • Support for BEE encryption for RT10xx devices
    • Support for KeyStore used in MasterBootImage
    • Master Boot Image
    • Master Boot Image - miscellaneous functions
    • Master Boot Image - mixin classes
    • Image Exceptions

mboot Module API

  • MBoot Module API
    • MBoot Interfaces
      • MBoot UART
      • MBoot USB
      • MBoot USBSIO
      • MBoot Interface Class
    • McuBoot Class
    • MBoot Commands
    • MBoot Properties
    • External Memories
    • MBoot ErrorCodes
    • MBoot Exceptions

pfr Module API

  • Protected Flash Region API
    • Protected Flash Region
    • Protected Flash Region Checker for brick-conditions
    • PFR Exceptions

sbfile Module API

  • SBFile Module API
    • SBFile Version 1
    • SBFile Version 1 commands
    • SBFile Version 1 headers
    • SBFile Version 1 images
    • SBFile Version 1 sections
    • SBFile Version 2
    • SBFile Version 2 commands
    • SBFile Version 2 headers
    • SBFile Version 2 images
    • SBFile Version 2 sections
    • SBFile Version 3.1.
    • SBFile Version 3.1. functions
    • SBFile Version 3.1. commands
    • SBFile Version 3.1. images
    • SBFile - miscellaneous functions

SDP Module API

  • SDP Module API
    • SDP Interfaces
      • SDP UART
      • SDP USB
      • SDP Interface Class
    • SDP Communication protocol
    • SDP Commands
    • SDPS communication protocol
    • SDP Error/Status codes
    • SDP Exceptions

shadowregs Module API

  • Shadow Registers API
    • Module with the shadow registers control DAT support file

utils Module API

  • Utils Module API
    • Utils easy enum
    • Utils crypto
    • General utils
    • Serial Proxy
    • USB Filter
    • Registers descriptions with support for XML files
    • Register’s configuration
    • USB Device Scanner
    • Device description
    • Module for schema-based configuration validation
    • Utils Exceptions

© Copyright 2019-2021, NXP. Revision 6bc60909.

Built with Sphinx using a theme provided by Read the Docs.