Release 1.5.0

nxp-mcuxpresso · Sep 7, 2021 · f18a900 · f18a900
1 parent bf4c530
commit f18a900
Show file tree

Hide file tree

Showing 419 changed files with 10,615 additions and 2,440 deletions.
diff --git a/docs/_static/images/spsdk-applications.png b/docs/_static/images/spsdk-applications.png
diff --git a/docs/_static/images/spsdk-architecture-apps.png b/docs/_static/images/spsdk-architecture-apps.png
diff --git a/docs/_static/images/spsdk-architecture.png b/docs/_static/images/spsdk-architecture.png
diff --git a/docs/_static/images/spsdk-help.png b/docs/_static/images/spsdk-help.png
diff --git a/docs/api/api.rst b/docs/api/api.rst
@@ -2,7 +2,7 @@
 
 .. toctree::
     :caption: crypto Module API
-    
+
     crypto
 
 .. toctree::
@@ -41,11 +41,11 @@
     sbfile
 
 .. toctree::
-    :caption: Debuggers Module API
+    :caption: SDP Module API
 
     sdp
 
 .. toctree::
     :caption: utils Module API
 
-    utils
+    utils
diff --git a/docs/api/mboot_interfaces.rst b/docs/api/mboot_interfaces.rst
@@ -20,6 +20,14 @@ MBoot USB
    :show-inheritance:
    :member-order: bysource
 
+MBoot USBSIO
+-------------
+
+.. automodule:: spsdk.mboot.interfaces.usbsio
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: bysource
 
 MBoot Interface Class
 ---------------------

diff --git a/docs/api/pfr.rst b/docs/api/pfr.rst
@@ -19,11 +19,19 @@ Protected Flash Region
 Protected Flash Region Checker for brick-conditions
 ----------------------------------------------------
 .. automodule:: spsdk.pfr.processor
-   :members: 
+   :members:
    :exclude-members: MyTransformer
    :undoc-members:
    :show-inheritance:
 .. automodule:: spsdk.pfr.translator
-   :members: 
+   :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
+
+
+PFR Exceptions
+--------------
+.. automodule:: spsdk.pfr.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/sbfile.rst b/docs/api/sbfile.rst
@@ -51,6 +51,14 @@ SBFile Version 3.1. functions
    :show-inheritance:
 
 
+SBFile Version 3.1. commands
+-------------------------------
+.. automodule:: spsdk.sbfile.sb31.commands
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
 SBFile Version 3.1. images
 ----------------------------
 .. automodule:: spsdk.sbfile.sb31.images

diff --git a/docs/api/utils.rst b/docs/api/utils.rst
@@ -55,7 +55,15 @@ Registers descriptions with support for XML files
    :show-inheritance:
 
 
-USB Device Scanner 
+Register's configuration
+------------------------
+.. automodule:: spsdk.utils.reg_config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+USB Device Scanner
 ---------------------
 .. automodule:: spsdk.utils.nxpdevscan
    :members:
@@ -69,3 +77,11 @@ Device description
    :members:
    :undoc-members:
    :show-inheritance:
+
+
+Utils Exceptions
+----------------
+.. automodule:: spsdk.utils.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/apps/blhost.rst b/docs/apps/blhost.rst
@@ -1,5 +1,3 @@
-.. TODO: [SPSDK-685] Add missing sub-commands into blhost user guide when available
-
 .. |br| raw:: html
 
    <br/>
@@ -45,9 +43,6 @@ The BusPal acts as a bus translator running on selected platforms. BusPal assist
 blhost - LPCUSBSIO
 ==================
 
-.. warning::
-    LPCUSBSIO is not supported in SPSDK
-
 LPCUSBSIO - LPC USB Serial I/O(LPCUSBSIO), a firmware built in LPC Link2. The LPCUSBSIO acts as a bus translator, and establishes connection with *blhost* over USB-HID, and the MCU bootloader device over I2C and SPI.
 
 -----------------------
@@ -434,3 +429,6 @@ After the reset the device boots from flash and user image is programmed success
 
 ..note:: Elf files are not supported yet.
 
+.. click:: spsdk.apps.blhost:trust_provisioning
+    :prog: blhost trust-provisioning
+    :nested: full
diff --git a/docs/apps/nxpcertgen.rst b/docs/apps/nxpcertgen.rst
@@ -7,3 +7,28 @@ This user’s guide describes how to use *nxpcertgen* application.
 .. click:: spsdk.apps.nxpcertgen:main
     :prog: nxpcertgen
     :nested: full
+
+-------------------------
+nxpcertgen - Sub-commands
+-------------------------
+
+*nxpcertgen* consist of a set of sub-commands followed by options and arguments.
+The options and the sub-command are separated with a ‘--’.
+
+.. code:: bash
+
+    nxpcertgen [options] -- [sub-command]
+
+The "help" guide of *nxpcertgen* lists all of the options and sub-commands supported by the *nxpcertgen* utility.
+
+.. code:: bash
+
+    nxpcertgen --help
+
+.. click:: spsdk.apps.nxpcertgen:generate
+    :prog: nxpcertgen generate
+    :nested: full
+
+.. click:: spsdk.apps.nxpcertgen:get_cfg_template
+    :prog: nxpcertgen get-cfg-template
+    :nested: full
diff --git a/docs/apps/nxpdevhsm.rst b/docs/apps/nxpdevhsm.rst
@@ -0,0 +1,64 @@
+======================
+User Guide - nxpdevhsm
+======================
+
+This user’s guide describes how to interface with the *MCU bootloader* to provisioned chip using *nxpdevhsm* application.
+
+The *nxpdevhsm* application is a command-line utility used on the host computer to use device HSM process to get provisioning SB3.
+
+.. click:: spsdk.apps.nxpdevhsm:main
+    :prog: nxpdevhsm
+    :nested: none
+
+-------------------------
+nxpdevhsm - Communication
+-------------------------
+
+The *nxpdevhsm* application is using blhost application and all supported communication interfaces that blhost offers(UART, USB, LPCUSBSIO[IC, SPI])
+
+nxpdevhsm - blhost - USB
+========================
+
+*blhost* could be connected to MCU Bootloader over USB HID.
+
+:ref:`USB device identification in SPSDK`
+
+nxpdevhsm - blhost - UART
+=========================
+
+*blhost* could be connected to MCU bootloader over UART.
+
+:ref:`UART device identification in SPSDK`
+
+nxpdevhsm - blhost - LPCUSBSIO
+==============================
+
+LPCUSBSIO - LPC USB Serial I/O(LPCUSBSIO), a firmware built in LPC Link2. The LPCUSBSIO acts as a bus translator, and establishes connection with *blhost* over USB-HID, and the MCU bootloader device over I2C and SPI.
+
+-------------------------
+nxpdevhsm - blhost - Note
+-------------------------
+
+For more information about supported communication interface check the blhost application documentation.
+
+
+------------------------
+nxpdevhsm - Sub-commands
+------------------------
+
+*nxpdevhsm* consist of a set of sub-commands followed by options and arguments.
+The options and the sub-command are separated with a ‘--’.
+
+.. code:: bash
+
+    nxpdevhsm [options] -- [sub-command]
+
+The "help" guide of *nxpdevhsm* lists all of the options and sub-commands supported by the *nxpdevhsm* utility.
+
+.. code:: bash
+
+    nxpdevhsm --help
+
+.. click:: spsdk.apps.nxpdevhsm:generate
+    :prog: nxpdevhsm generate
+    :nested: full
diff --git a/docs/apps/nxpkeygen.rst b/docs/apps/nxpkeygen.rst
@@ -32,3 +32,7 @@ The "help" guide of *nxpkeygen* lists all of the options and sub-commands suppor
 .. click:: spsdk.apps.nxpkeygen:genkey
     :prog: nxpkeygen genkey
     :nested: full
+
+.. click:: spsdk.apps.nxpkeygen:get_cfg_template
+    :prog: nxpkeygen get-cfg-template
+    :nested: full
diff --git a/docs/conf.py b/docs/conf.py
@@ -35,7 +35,6 @@
     ".rst": "restructuredtext",
     ".md": "markdown",
 }
-autodoc_mock_imports = ["hidapi", "hid"]
 
 autoclass_content = "both"
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -12,6 +12,7 @@ Secure Provisioning SDK (SPSDK)
     :maxdepth: 1
 
     spsdk.rst
+    release_notes.rst
 
 .. toctree::
     :caption: Usage
@@ -25,17 +26,18 @@ Secure Provisioning SDK (SPSDK)
     :caption: Application User Guides
     :maxdepth: 1
 
-    apps/nxpdevscan
-    apps/sdphost
     apps/blhost
-    apps/pfr
-    apps/pfrc
     apps/elftosb
-    apps/nxpkeygen
     apps/nxpcertgen
     apps/nxpdebugmbox
-    apps/shadowregs
+    apps/nxpdevhsm
+    apps/nxpdevscan
+    apps/nxpkeygen
+    apps/pfr
+    apps/pfrc
+    apps/sdphost
     apps/sdpshost
+    apps/shadowregs
 
 .. toctree::
     :caption: API Development Guide