.. SPSDK documentation master file, created by
   sphinx-quickstart on Fri Sep 20 15:24:29 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

================================
Secure Provisioning SDK (SPSDK)
================================

.. toctree::
    :caption: Project overview
    :maxdepth: 1

    .. literalinclude:: ../README.md
    release_notes.rst
    migration_guide.rst

.. toctree::
    :caption: Usage
    :maxdepth: 1

    usage/installation
    usage/applications
    usage/apis

.. toctree::
    :caption: Supported Binary Images
    :maxdepth: 1

    images/executable
    images/secure_update
    images/flash
    images/bootable

.. toctree::
    :caption: Application User Guides
    :maxdepth: 1

    apps/blhost
    apps/dk6prog
    apps/ifr
    apps/nxpcrypto
    apps/nxpdebugmbox
    apps/nxpdevhsm
    apps/nxpdevscan
    apps/nxpele
    apps/nxpimage
    apps/nxpmemcfg
    apps/pfr
    apps/sdphost
    apps/sdpshost
    apps/shadowregs
    apps/trust_provisioning
    apps/nxpwpc


.. toctree::
    :caption: API Development Guide
    :maxdepth: 1

    api/crypto
    api/dat
    api/debuggers
    api/dk6
    api/ele_msg
    api/image
    api/mboot
    api/memcfg
    api/pfr
    api/sbfile
    api/sdp
    api/shadowregs
    api/spsdk
    api/tp
    api/wpc
    api/utils

.. toctree::
    :caption: General examples
    :maxdepth: 1

    examples/jupyter
    examples/init_notebook
    examples/flashloader/ahab/rt118x_signed_flashloader
    examples/flashloader/hab/rt105x_flashloader
    examples/general/crypto
    examples/general/image
    examples/general/image_dcd
    examples/general/image_srk
    examples/general/sbfile
    examples/general/mboot
    examples/general/sdp_mboot
    examples/general/sdp
    examples/general/sdps
    examples/general/get_keys
    examples/plugins/README
    examples/signature_prov
    examples/wpc_provisioning

.. toctree::
    :caption: MCU examples
    :maxdepth: 1

    examples/lpc55sxx_secure_boot/lpc55sxx_secure_boot
    examples/lpc55sxx_secure_boot/lpc55sxx_secure_fw_update
    examples/kw45xx_k32w1xx/kw45xx_k32w1xx_secure_boot
    examples/kw45xx_k32w1xx/kw45xx_k32w1xx_load_NBU_image
    examples/dk6/dk6prog_intro
    examples/mc56/mc56_devhsm
    examples/rw61x_shadowregs/rw61x_shadowregs
    examples/rw61x_debug_auth/rw61x_debug_auth
    examples/mcxn9xx_debug_auth/mcxn9xx_debug_auth

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`