Release 1.7.0

marekvi95 · Jul 29, 2022 · 053fb9a · 053fb9a
1 parent c3c7fb2
commit 053fb9a
Show file tree

Hide file tree

Showing 467 changed files with 31,775 additions and 7,951 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,7 +1,7 @@
 [bumpversion]
-current_version = 1.6.3
+current_version = 1.7.0
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<suffix>.*))?
-serialize = 
+serialize =
 	{major}.{minor}.{patch}.{suffix}
 	{major}.{minor}.{patch}
 tag = True

diff --git a/.gitignore b/.gitignore
@@ -30,6 +30,7 @@ MANIFEST
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 *.manifest
 *.spec
+generated
 
 # Installer logs
 pip-log.txt
@@ -77,6 +78,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/_prebuild/
 
 # PyBuilder
 target/
@@ -132,3 +134,6 @@ pip-wheel-metadata
 
 # Mac stuff
 .DS_Store
+
+# loggin config
+logging.yaml
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,7 +8,7 @@ repos:
         entry: python tools/checker_copyright_year.py
         language: system
   - repo: https://github.com/psf/black
-    rev: 20.8b1
+    rev: 22.3.0
     hooks:
       - id: black
   - repo: https://github.com/pycqa/isort

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -11,8 +11,14 @@ sphinx:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
+  version: "3.7"
   install:
     - method: pip
-      path: .
+      path: .[tp]
     - requirements: docs/requirements.txt
+
+build:
+  apt_packages:
+    - swig
+    - pcscd
+    - libpcsclite-dev
diff --git a/SW_Content_Register_SPSDK.txt b/SW_Content_Register_SPSDK.txt
@@ -1,6 +1,6 @@
 NXP Software Content Register
 
-Package:                   NXP SPSDK 1.6.3
+Package:                   NXP SPSDK 1.7.0
 Outgoing License:          BSD-3-Clause
 License Files:             LICENSE
 Type of content:           Source code

diff --git a/codecheck.py b/codecheck.py
@@ -125,7 +125,7 @@ def check_pytest(output: str = OUTPUT_FOLDER) -> Dict[str, Any]:
         shutil.rmtree(output_folder, ignore_errors=True)
 
     args = (
-        f"pytest --cov spsdk --cov-branch --junit-xml {junit_report}"
+        f"pytest tests --cov spsdk --cov-branch --junit-xml {junit_report}"
         f" --cov-report term --cov-report html:{output_folder} --cov-report xml:{output_xml}"
     )
     with open(output_log, "w", encoding="utf-8") as f:
@@ -342,23 +342,24 @@ def main(
     """
     # logging.basicConfig(level=logging.DEBUG if debug else logging.INFO)
     logging.basicConfig(level=logging.INFO)
+    output_dir = str(output) if output else OUTPUT_FOLDER
     ret = 1
     try:
         available_checks = TaskList(
             [
-                TaskInfo("PYTEST", check_pytest, output=output),
-                TaskInfo("GITCOV", check_gitcov, output=output, dependencies=["PYTEST"]),
+                TaskInfo("PYTEST", check_pytest, output=output_dir),
+                TaskInfo("GITCOV", check_gitcov, output=output_dir, dependencies=["PYTEST"]),
                 TaskInfo(
                     "PYLINT_ALL",
                     check_pylint,
                     args="spsdk examples tools codecheck.py",
-                    output_log=os.path.join(output, "pylint_all.txt"),
+                    output_log=os.path.join(output_dir, "pylint_all.txt"),
                 ),
                 TaskInfo(
                     "PYLINT",
                     check_pylint_errors,
-                    input_log=os.path.join(output, "pylint_all.txt"),
-                    output_log=os.path.join(output, "pylint.txt"),
+                    input_log=os.path.join(output_dir, "pylint_all.txt"),
+                    output_log=os.path.join(output_dir, "pylint.txt"),
                     dependencies=["PYLINT_ALL"],
                 ),
                 # This is already covered by PYLINT
@@ -372,44 +373,44 @@ def main(
                     "PYLINT_DOCS",
                     check_pylint,
                     args="spsdk --rcfile pylint-doc-rules.ini",
-                    output_log=os.path.join(output, "pylint_docs.txt"),
+                    output_log=os.path.join(output_dir, "pylint_docs.txt"),
                 ),
                 TaskInfo(
                     "MYPY",
                     check_mypy,
                     args=["spsdk", "examples"],
-                    output_log=os.path.join(output, "mypy.txt"),
+                    output_log=os.path.join(output_dir, "mypy.txt"),
                 ),
                 TaskInfo(
                     "MYPY_TOOLS",
                     check_mypy,
                     args=["tools", "codecheck.py"],
-                    output_log=os.path.join(output, "mypy_tools.txt"),
+                    output_log=os.path.join(output_dir, "mypy_tools.txt"),
                 ),
                 TaskInfo("DEPENDENCIES", check_dependencies, output=output),
-                TaskInfo("PYDOCSTYLE", check_pydocstyle, output=output),
+                TaskInfo("PYDOCSTYLE", check_pydocstyle, output=output_dir),
                 TaskInfo(
-                    "RADON_ALL", check_radon, output_log=os.path.join(output, "radon_all.txt")
+                    "RADON_ALL", check_radon, output_log=os.path.join(output_dir, "radon_all.txt")
                 ),
                 TaskInfo(
                     "RADON_C",
                     check_radon_errors,
                     radon_type="C",
-                    input_log=os.path.join(output, "radon_all.txt"),
-                    output_log=os.path.join(output, "radon_c.txt"),
+                    input_log=os.path.join(output_dir, "radon_all.txt"),
+                    output_log=os.path.join(output_dir, "radon_c.txt"),
                     dependencies=["RADON_ALL"],
                 ),
                 TaskInfo(
                     "RADON_D",
                     check_radon_errors,
                     radon_type="D",
-                    input_log=os.path.join(output, "radon_all.txt"),
-                    output_log=os.path.join(output, "radon_d.txt"),
+                    input_log=os.path.join(output_dir, "radon_all.txt"),
+                    output_log=os.path.join(output_dir, "radon_d.txt"),
                     dependencies=["RADON_ALL"],
                 ),
-                TaskInfo("BLACK", check_black, output=output),
-                TaskInfo("ISORT", check_isort, output=output),
-                TaskInfo("COPYRIGHT", check_copyright_year, output=output),
+                TaskInfo("BLACK", check_black, output=output_dir),
+                TaskInfo("ISORT", check_isort, output=output_dir),
+                TaskInfo("COPYRIGHT", check_copyright_year, output=output_dir),
             ]
         )
         checks = TaskList()
@@ -432,13 +433,13 @@ def main(
         info_check.append("RADON_ALL")
         info_check.append("RADON_C")
 
-        if not os.path.isdir(output):
-            os.mkdir(output)
+        if not os.path.isdir(output_dir):
+            os.mkdir(output_dir)
 
         runner = PrettyProcessRunner(checks, print_func=print_nothing if silence else click.echo)
         runner.run(job_cnt, True)
 
-        ret = check_results(checks, info_check, output)
+        ret = check_results(checks, info_check, output_dir)
         if silence < 2:
             print_results(checks, info_check)
             click.echo(f"Overall time: {round(runner.process_time, 1)} second(s).")

diff --git a/devices.txt b/devices.txt
@@ -1,4 +1,4 @@
-List of devices and chip versions tested with SPSDK 1.6.2
+List of devices and chip versions tested
 
 - MIMXRT1170-EVK A
 - MIMXRT1160-EVK A1
@@ -12,3 +12,4 @@ List of devices and chip versions tested with SPSDK 1.6.2
 - LPC55S69-EVK A1
 - LPC55S16-EVK B1
 - LPC55S16-EVK A1
+- LPC55S06-EVK A0
diff --git a/docs/Makefile b/docs/Makefile
@@ -14,13 +14,7 @@ help:
 
 .PHONY: help Makefile
 
-table:
-	python generate_table.py
-
-schemas:
-	python generate_schemas.py
-
-html: schemas table
+html:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 # Catch-all target: route all unknown targets to Sphinx using the new

diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -0,0 +1,3 @@
+.wy-nav-content {
+    max-width: 75% !important;
+}
diff --git a/docs/_static/fonts/Roboto-Medium.ttf b/docs/_static/fonts/Roboto-Medium.ttf
diff --git a/docs/_static/images/spsdk-architecture-apis.png b/docs/_static/images/spsdk-architecture-apis.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/_static/images/spsdk-structure.png b/docs/_static/images/spsdk-structure.png
diff --git a/docs/api/image.rst b/docs/api/image.rst
@@ -102,3 +102,20 @@ Image Exceptions
    :members:
    :undoc-members:
    :show-inheritance:
+
+AHAB Container
+------------------
+.. automodule:: spsdk.image.ahab.ahab_container
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: bysource
+
+AHAB Container Interface
+------------------------
+.. automodule:: spsdk.image.ahab.ahab_abstract_interfaces
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: bysource
+
diff --git a/docs/apps/blhost.rst b/docs/apps/blhost.rst
@@ -10,9 +10,9 @@ This user’s guide describes how to interface with the *MCU bootloader* using *
 
 The *blhost* application is a command-line utility used on the host computer to initiate communication and issue commands to the *MCU bootloader*. The application only sends one command per invocation.
 
-----------------------
-blhost - Communication
-----------------------
+-------------
+Communication
+-------------
 
 The *blhost* application can communicate directly with the *MCU bootloader* over the host computer’s UART (Serial Port) or USB connections.
 
@@ -35,19 +35,16 @@ blhost - UART
 blhost - BUSPAL
 ===============
 
-.. warning::
-    BUSPAL is not supported in SPSDK
-
 The BusPal acts as a bus translator running on selected platforms. BusPal assists *blhost* in carrying out commands and responses from the target device through an established connection with *blhost* over UART, and the target device over I2C, SPI, or CAN.
 
 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.
 
------------------------
-blhost - MCU bootloader
------------------------
+----------------
+ MCU bootloader
+----------------
 
 The MCU bootloader is intended to be the standard bootloader for all MCU devices. It provides a standard interface to the device using any of the peripherals supported by the bootloader on a given NXP MCU device.
 
@@ -122,7 +119,8 @@ The bit number that identifies whether a command is present is the command's tag
     21       key-provisioning (0x15)
     22       trust-provisioning (0x16)
     23       fuse-read (0x17)
-    [31:24]  reserved
+    24       update-life-cycle(0x18)
+    [31:25]  reserved
     ======== ================================
 
 MCU Bootloader operation
@@ -147,9 +145,10 @@ If the ``-p COMx`` option is used, the UART is the active peripheral and all fut
 .. note::
     After the MCU bootloader is in the “Process Commands” state, the device has to be reset to communicate over a different peripheral or at a different baud rate over the same UART peripheral.
 
----------------------
-blhost - Sub-commands
----------------------
+
+----------------------
+Command line interface
+----------------------
 
 *blhost* consist of a set of sub-commands followed by options and arguments.
 The options and the sub-command are separated with a ‘--’.
@@ -438,3 +437,7 @@ After the reset the device boots from flash and user image is programmed success
 .. click:: spsdk.apps.blhost:batch
     :prog: blhost batch
     :nested: full
+
+.. click:: spsdk.apps.blhost:update_life_cycle
+    :prog: blhost update-life-cycle
+    :nested: full