Release 1.3

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: local
+    hooks:
+      - id: copyright-year
+        name: Check this year's Copyright
+        entry: python tools/checker_copyright_year.py
+        language: system

.pylintrc

@@ -3,7 +3,7 @@
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code.
-extension-pkg-whitelist=
+extension-pkg-whitelist=hid
 
 # Add files or directories to the blacklist. They should be base names, not
 # paths.

README.md

@@ -17,12 +17,10 @@ Architecure
     - SB - Secure Boot File [module](https://spsdk.readthedocs.io/en/latest/api/sbfile.html).
     - MBI - Master Boot Image [module](https://spsdk.readthedocs.io/en/latest/api/image.html).
     - Crypto - Cryptography [module](https://spsdk.readthedocs.io/en/latest/api/crypto.html).
-    - DAT - Debug Authentication [module](https://spsdk.readthedocs.io/en/latest/api/dat.html).
 
 - **Protocol Layer** packs or unpacks messages and images into a protocol defined by the required device counterpart.
     - BL Host [module](https://spsdk.readthedocs.io/en/latest/api/mboot.html).
     - SDP Host [module](https://spsdk.readthedocs.io/en/latest/api/sdp.html).
-    - Debug Mailbox
 
 - **Communication Layer** links SPSDK and connected devices.
 
@@ -65,14 +63,22 @@ Usage
 - See [examples](examples) directory
 - See [application](spsdk/apps) directory
 
+---
+**i.Mx RT 1050**
+
+To run examples using i.MX RT 1050 you need to download a flashloader:
+- Go to: https://www.nxp.com/webapp/sps/download/license.jsp?colCode=IMX-RT1050-FLASHLOADER
+- Review the license agreement, download and unzip the package
+- Convert the elf file into bin (For this operation you need to have MCUXpresso IDE, IAR or Keil)
+  - run ```python tools\flashloader_converter.py --elf-path <path/to/flashloader.elf> --ide-type <mcux | iar | keil> --ide-path <path/to/IDE/install/folder```
+
+---
+
 Dependencies
 ------------
 
 SPSDK requires [Python](https://www.python.org) >3.5 and <3.9 interpreter, old version 2.x is not supported !
 
-- requirements.txt
-  - list of requirements for running SPSDK core + apps
-- requirements-develop.txt
-  - requirements needed for development (running tests, checking coding style)
-- docs/requirements.txt
-  - requirements needed for generating docs
+The core dependencies are included in requirements.txt file. 
+
+The dependencies for the development and testing are included in requirements-develop.txt.

SW_Content_Register_SPSDK.txt

@@ -1,6 +1,6 @@
 NXP Software Content Register
 
-Package:                   NXP SPSDK 1.2.0
+Package:                   NXP SPSDK 1.3.0
 Outgoing License:          BSD-3-Clause
 License Files:             LICENSE
 Type of content:           Source code

codecheck.cmd

@@ -17,11 +17,10 @@ IF EXIST venv\Scripts\activate.bat call venv\Scripts\activate.bat
 IF EXIST %CD%\reports\htmlcov DEL %CD%\reports\htmlcov /Q
 pytest --cov=spsdk --cov-report=term --cov-report=html:reports/htmlcov/ --cov-branch --cov-report=xml:reports/coverage.xml .
 @rem WITH DURATIONS pytest --durations=0 --cov=spsdk --cov-report=term --cov-report=html:reports/htmlcov/ --cov-branch --cov-report=xml:reports/coverage.xml --log-cli-level=WARN .
-@if errorlevel 1 goto END
+@if errorlevel 1 echo "<<<### TESTS FAILED #################################################################>>>"
 @rem -------------------------------------------------------
 @rem mypy: python typing tests (modules tested: spsdk + examples)
-mypy spsdk > %CD%\reports\mypy.txt
-@rem mypy spsdk examples >%CD%\reports\mypy.txt
+mypy spsdk examples >%CD%\reports\mypy.txt
 @if errorlevel 1 echo "<<<### MYPY PROBLEM DETECTED ########################################################>>>"
 @rem -------------------------------------------------------
 @rem pylint (spsdk module only, errors only)
@@ -46,4 +45,3 @@ radon cc --min C spsdk > %CD%\reports\radonC.txt
 @rem gitcov (coverage of changed files)
 python tools\gitcov.py --verbose --coverage-report reports\coverage.xml
 @if %errorlevel% gtr 0 echo "<<<### GIT-COV ERROR DETECTED #################################################>>>"
-:END

docs/api/crypto.rst

@@ -45,4 +45,3 @@ Crypto module loading helper functions
    :members:
    :undoc-members:
    :show-inheritance:
-

docs/api/dat.rst

@@ -3,6 +3,13 @@ Debug Authentication API
 
 Debug Authentication module provides debugging for securely provisioned devices.
 
+DAT module general information
+--------------------------------
+.. automodule:: spsdk.dat
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 
 Module for generating debug credentials
 ----------------------------------------
@@ -49,4 +56,12 @@ Module with common utils for DAT module
 .. automodule:: spsdk.dat.utils
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
+
+
+Module with the shadow registers control DAT support file
+----------------------------------------------------------
+.. automodule:: spsdk.dat.shadow_regs
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/debuggers.rst

@@ -0,0 +1,37 @@
+Debuggers API
+===============
+
+Debuggers module provides wrappers for various types of debuggers.
+
+
+Module for DebugMailbox Debug probes support
+-----------------------------------------------
+.. automodule:: spsdk.debuggers.debug_probe
+   :members:
+   :special-members: DebugProbe
+   :undoc-members:
+   :show-inheritance:
+
+
+Module for DebugMailbox Jlink Debug probes support
+----------------------------------------------------
+.. automodule:: spsdk.debuggers.debug_probe_jlink
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module for DebugMailbox Pemicro Debug probes support
+-----------------------------------------------------
+.. automodule:: spsdk.debuggers.debug_probe_pemicro
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module for DebugMailbox PyOCD Debug probes support
+-----------------------------------------------------
+.. automodule:: spsdk.debuggers.debug_probe_pyocd
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/image.rst

@@ -56,3 +56,25 @@ TrustZone
    :show-inheritance:
 
 
+Support for BEE encryption for RT10xx devices
+----------------------------------------------
+.. automodule:: spsdk.image.bee
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Support for KeyStore used in MasterBootImage
+---------------------------------------------
+.. automodule:: spsdk.image.keystore
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Master Boot Image
+-------------------
+.. automodule:: spsdk.image.mbimg
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/mboot.rst

@@ -49,5 +49,9 @@ MBoot ErrorCodes
    :undoc-members:
    :show-inheritance:
 
-
-
+MBoot Exceptions
+-----------------
+.. automodule:: spsdk.mboot.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/pfr.rst

@@ -13,4 +13,17 @@ Protected Flash Region
    :special-members: CMPA, CFPA, BaseConfigArea
    :exclude-members: CONFIG_DIR
    :undoc-members:
+   :show-inheritance:
+
+
+Protected Flash Region Checker for brick-conditions
+----------------------------------------------------
+.. automodule:: spsdk.pfr.processor
+   :members: 
+   :exclude-members: MyTransformer
+   :undoc-members:
+   :show-inheritance:
+.. automodule:: spsdk.pfr.translator
+   :members: 
+   :undoc-members:
    :show-inheritance:

docs/api/sbfile.rst

@@ -3,37 +3,57 @@ SBFile Module API
 
 Module implementing SBFile.
 
-
 SBFile Commands
 ---------------
-
 .. automodule:: spsdk.sbfile.commands
    :members:
    :undoc-members:
    :show-inheritance:
 
+
 SBFile Headers
 ---------------
-
 .. automodule:: spsdk.sbfile.headers
    :members:
    :undoc-members:
    :show-inheritance:
 
+
 SBFile Segments
 ---------------
-
 .. automodule:: spsdk.sbfile.sections
    :members:
    :undoc-members:
    :show-inheritance:
 
+
 SBFile Images
 ---------------
-
 .. automodule:: spsdk.sbfile.images
    :members:
    :undoc-members:
    :show-inheritance:
 
 
+SBFile Version 3.1.
+--------------------
+.. automodule:: spsdk.sbfile.sb31
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+SBFile Version 3.1. functions
+-------------------------------
+.. automodule:: spsdk.sbfile.sb31.functions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+SBFile Version 3.1. images
+----------------------------
+.. automodule:: spsdk.sbfile.sb31.images
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/sdp.rst

@@ -42,4 +42,12 @@ SDP Error/Status codes
 .. automodule:: spsdk.sdp.error_codes
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
+
+
+SDP Exceptions
+----------------
+.. automodule:: spsdk.sdp.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/utils.rst

@@ -34,4 +34,38 @@ Serial Proxy
 .. automodule:: spsdk.utils.serial_proxy
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
+
+
+USB Filter
+-------------
+
+.. automodule:: spsdk.utils.usbfilter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Registers descriptions with support for XML files
+--------------------------------------------------
+
+.. automodule:: spsdk.utils.registers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+USB Device Scanner 
+---------------------
+.. automodule:: spsdk.utils.nxpdevscan
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Device description
+--------------------
+.. automodule:: spsdk.utils.devicedescription
+   :members:
+   :undoc-members:
+   :show-inheritance: