spsdk-mcu-link 0.5.0__tar.gz

spsdk_mcu_link-0.5.0/LICENSE

@@ -0,0 +1,30 @@
+BSD 3-Clause "New" or "Revised" License
+
+Copyright 2024 NXP
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.
+

spsdk_mcu_link-0.5.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include LICENSE
+include README.md
+include SW_Content_Register_spsdk_mcu_link.txt
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude .github *

spsdk_mcu_link-0.5.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.1
+Name: spsdk_mcu_link
+Version: 0.5.0
+Summary: SPSDK MCU-Link. A debugger probe plugin for SPSDK supporting LPC-Link/MCU-Link from NXP.
+Author: NXP
+Maintainer-email: Kelnar Michal <michal.kelnar@nxp.com>
+License: BSD-3-Clause
+Project-URL: Homepage, https://github.com/nxp-mcuxpresso/spsdk_plugins/tree/master/mcu_link
+Project-URL: Issues, https://github.com/nxp-mcuxpresso/spsdk_plugins/issues
+Keywords: NXP,SPSDK,mcu-link,mculink,CMSIS-DAP
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: wasmtime~=24.0.0
+Requires-Dist: pyusb~=1.2.1
+Requires-Dist: hidapi~=0.14.0.post2
+Requires-Dist: libusb_package
+
+    SPSDK MCU-Link
+    ==============
+
+    NXP SPSDK MCU-Link debug probe support plugin for NXP LPC-Link/MCU-Link hardware debug probes. This plugin enables seamless integration with NXP's debug hardware.
+
+    * Free software: BSD-3-Clause
+    * Documentation: https://github.com/nxp-mcuxpresso/spsdk_plugins?tab=readme-ov-file#readme
+
+    Features
+    --------
+
+    * Support for NXP MCU-Link debug probes
+    * CMSIS-DAP protocol implementation
+    * Firmware update capabilities
+    * Debug session management
+    * SWD/JTAG interface support
+    * Integration with SPSDK tools
+
+    Installation
+    ------------
+
+    1. Activate your virtual environment with SPSDK (to install spsdk run: `pip install spsdk`):
+
+        python -m venv venv
+        source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+
+    2. Install the package:
+
+        pip install spsdk_mcu_link
+
+
+    3. Verify installation:
+
+        nxpdebugmbox --help
+
+        You should see `mcu-link` listed among available interfaces (--interface)
+
+    Usage
+    -----
+
+    1. Connect your MCU-Link debug probe to your computer
+    2. Basic debug session:
+
+        nxpdebugmbox --interface mcu-link --port auto
+
+    3. For firmware updates:
+
+        nxpdebugmbox update-firmware --interface mcu-link
+
+
+    Advanced Usage
+    -------------
+
+    * Configuration options
+    * Debugging commands
+    * Firmware management
+    * Troubleshooting tips
+
+    Requirements
+    -----------
+
+    * Python 3.7 or newer
+    * SPSDK package
+    * USB drivers for MCU-Link hardware
+
+    Contributing
+    -----------
+
+    Contributions are welcome! Please feel free to submit a Pull Request.
+
+    Credits
+    -------
+
+    Michal Kelnar
+    <michal.kelnar@nxp.com>
+
+    License
+    -------
+
+    BSD-3-Clause

spsdk_mcu_link-0.5.0/README.md

@@ -0,0 +1,81 @@
+    SPSDK MCU-Link
+    ==============
+
+    NXP SPSDK MCU-Link debug probe support plugin for NXP LPC-Link/MCU-Link hardware debug probes. This plugin enables seamless integration with NXP's debug hardware.
+
+    * Free software: BSD-3-Clause
+    * Documentation: https://github.com/nxp-mcuxpresso/spsdk_plugins?tab=readme-ov-file#readme
+
+    Features
+    --------
+
+    * Support for NXP MCU-Link debug probes
+    * CMSIS-DAP protocol implementation
+    * Firmware update capabilities
+    * Debug session management
+    * SWD/JTAG interface support
+    * Integration with SPSDK tools
+
+    Installation
+    ------------
+
+    1. Activate your virtual environment with SPSDK (to install spsdk run: `pip install spsdk`):
+
+        python -m venv venv
+        source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+
+    2. Install the package:
+
+        pip install spsdk_mcu_link
+
+
+    3. Verify installation:
+
+        nxpdebugmbox --help
+
+        You should see `mcu-link` listed among available interfaces (--interface)
+
+    Usage
+    -----
+
+    1. Connect your MCU-Link debug probe to your computer
+    2. Basic debug session:
+
+        nxpdebugmbox --interface mcu-link --port auto
+
+    3. For firmware updates:
+
+        nxpdebugmbox update-firmware --interface mcu-link
+
+
+    Advanced Usage
+    -------------
+
+    * Configuration options
+    * Debugging commands
+    * Firmware management
+    * Troubleshooting tips
+
+    Requirements
+    -----------
+
+    * Python 3.7 or newer
+    * SPSDK package
+    * USB drivers for MCU-Link hardware
+
+    Contributing
+    -----------
+
+    Contributions are welcome! Please feel free to submit a Pull Request.
+
+    Credits
+    -------
+
+    Michal Kelnar
+    <michal.kelnar@nxp.com>
+
+    License
+    -------
+
+    BSD-3-Clause

spsdk_mcu_link-0.5.0/SW_Content_Register_spsdk_mcu_link.txt

@@ -0,0 +1,10 @@
+NXP Software Content Register
+
+Package:                   spsdk-mcu-link
+Version:                   0.5.0
+Outgoing License:          BSD-3-Clause
+License Files:             LICENSE
+Type of content:           Source code
+Description and comments:  NXP Secure Provisioning SDK Team - Debug Probe plugin for CMSIS-DAP probes
+Origin:                    NXP (BSD-3-Clause)
+URL:                       https://github.com/nxp-mcuxpresso/spsdk_plugins/tree/master/mcu_link

spsdk_mcu_link-0.5.0/pyproject.toml

@@ -0,0 +1,168 @@
+[project]
+name = "spsdk_mcu_link"
+description = "SPSDK MCU-Link. A debugger probe plugin for SPSDK supporting LPC-Link/MCU-Link from NXP."
+dynamic = ["version"]
+
+requires-python = ">= 3.9"
+dependencies = [
+    "wasmtime~=24.0.0",
+    "pyusb~=1.2.1",
+    "hidapi~=0.14.0.post2",
+    "libusb_package",
+]
+
+authors = [{ name = "NXP" }]
+maintainers = [{ name = "Kelnar Michal", email = "michal.kelnar@nxp.com" }]
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { text = "BSD-3-Clause" }
+
+keywords = ["NXP", "SPSDK", "mcu-link", "mculink", "CMSIS-DAP"]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+
+[project.entry-points]
+"spsdk.debug_probe" = { mcu-link = "spsdk_mcu_link.probe" }
+pyinstaller40 = { hook-dirs = "spsdk_mcu_link.__pyinstaller:get_hook_dirs" }
+
+[project.urls]
+Homepage = "https://github.com/nxp-mcuxpresso/spsdk_plugins/tree/master/mcu_link"
+Issues = "https://github.com/nxp-mcuxpresso/spsdk_plugins/issues"
+
+
+[build-system]
+requires = ["setuptools >= 61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = [
+    "spsdk_mcu_link",
+    "spsdk_mcu_link.dapper",
+    "spsdk_mcu_link.__pyinstaller",
+]
+include-package-data = true
+
+[tool.setuptools.package-data]
+"spsdk_mcu_link.dapper" = ["*.wasm"]
+
+[tool.setuptools.dynamic]
+version = { attr = "spsdk_mcu_link.__version__" }
+
+[tool.bumpversion]
+current_version = "0.5.0"
+
+[[tool.bumpversion.files]]
+filename = "spsdk_mcu_link/__init__.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "SW_Content_Register_spsdk_mcu_link.txt"
+search = "{current_version}"
+replace = "{new_version}"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+junit_family = "xunit1"
+
+[tool.coverage.report]
+exclude_lines = ["pragma: no cover", "safe_main()", "sys.exit(main())"]
+
+[tool.coverage.run]
+relative_files = true
+
+[tool.black]
+line-length = 100
+target-version = ["py39", "py310", "py311", "py312", "py313"]
+include = '\.pyi?$'
+
+[tool.isort]
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+ensure_newline_before_comments = true
+line_length = 100
+
+[tool.mypy]
+disallow_untyped_defs = true
+ignore_missing_imports = true
+warn_unused_ignores = true
+
+[tool.mypy-spsdk-mcu-link.dapper.webix_dapper_wasm]
+ignore_errors = true
+
+[tool.radon]
+exclude = "spsdk_mcu_link/dapper/webix_dapper_wasm.py"
+
+[tool.pydocstyle]
+convention = "google"
+add_ignore = "D105,D301"
+match = '(?!test_|__version__|webix_dapper_wasm).*\.py'
+
+[tool.pylint]
+format = { max-line-length = 120 }
+"messages control" = { disable = ["logging-fstring-interpolation"] }
+ignore = ["webix_dapper_wasm.py"]
+max-attributes = 12
+
+[tool.checker_dependencies]
+root_package = "spsdk_mcu_link"
+[tool.checker_dependencies.spdx]
+
+"Apache-2.0" = [
+    "Apache 2.0",
+    "Apache-2.0 License",
+    "Apache Software License 2.0",
+    "Apache License, Version 2.0",
+    "Apache License 2.0",
+    "Apache Software License",
+]
+"BSD-2-Clause" = ["BSD 2-Clause License"]
+"BSD-3-Clause" = [
+    "BSD License",
+    "BSD 3-Clause",
+    "BSD (3 clause)",
+    "BSD 3-Clause License",
+    "Modified BSD License",
+]
+"MIT" = ["MIT License", "MIT license"]
+"MPL-2.0" = ["MPL 2.0", "Mozilla Public License 2.0 (MPL 2.0)"]
+"NLPL" = ["Public domain", "Public Domain"]
+"PSF-2.0" = ["PSF", "PSFL", "Python Software Foundation License"]
+"LGPL-3.0" = []
+"LGPL-2.0" = ["GPL-2.0-or-later"]
+"LGPL-2.1" = ["LGPL-2.1-or-later"]
+"ISC" = ["ISC license"]
+"Unlincense" = ["The Unlicense", "The Unlicense (Unlicense)"]
+
+[tool.nxp_codecheck]
+git_parent_branch = "origin/master"
+output_directory = "reports"
+default_check_paths = ["spsdk_mcu_link"]
+checkers = [
+    { "pytest" = { kwargs = { disable_xdist = true } } },
+    { "gitcov" = { info_only = true } },
+    "pylint",
+    "mypy",
+    "dependencies",
+    "pydocstyle",
+    "ruff",
+    "cspell",
+    { "radon_c" = { info_only = true } },
+    "radon_d",
+    "black",
+    "isort",
+    "copyright",
+    "py_headers",
+    { "bandit" = { info_only = true } },
+]

spsdk_mcu_link-0.5.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

spsdk_mcu_link-0.5.0/spsdk_mcu_link/__init__.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+#
+# Copyright 2024 NXP
+#
+# SPDX-License-Identifier: BSD-3-Clause
+"""Top-level package for MCU-Link."""
+
+__author__ = """NXP"""
+__email__ = "michal.kelnar@nxp.com"
+__version__ = "0.5.0"
+
+try:
+    from spsdk.__version__ import version, version_tuple
+except ImportError as exc:
+    raise RuntimeError("Unable to detect SPSDK version. Is SPSDK installed?") from exc
+
+
+MIN_SPSDK_VERSION = (2, 3)
+MIN_SPSDK_VERSION_STR = ".".join(str(i) for i in MIN_SPSDK_VERSION)
+
+if version_tuple < MIN_SPSDK_VERSION:
+    raise RuntimeError(
+        f"You are using old version of SPSDK ({version}). "
+        f"Please update SPSDK to at least version: {MIN_SPSDK_VERSION_STR}"
+    )
+
+# pylint: disable=wrong-import-position
+from .probe import DebugProbeMCULink  # noqa: E402
+
+__all__ = ["DebugProbeMCULink"]

spsdk_mcu_link-0.5.0/spsdk_mcu_link/__pyinstaller/__init__.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+#
+# Copyright 2024 NXP
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+"""Module containing all PyInstaller hooks."""
+
+import os
+
+
+def get_hook_dirs() -> list[str]:
+    """Get list of directories where PyInstaller should look for hooks."""
+    return [os.path.dirname(__file__)]

spsdk_mcu_link-0.5.0/spsdk_mcu_link/__pyinstaller/hook-spsdk_mcu_link.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+#
+# Copyright 2024 NXP
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+# pylint: disable=invalid-name, import-error
+
+"""Add hidden imports, binaries, and data for this package."""
+
+from PyInstaller.utils.hooks import PY_DYLIB_PATTERNS, collect_data_files, collect_dynamic_libs
+
+hiddenimports = ["spsdk_mcu_link"]
+
+datas = collect_data_files("spsdk_mcu_link")
+binaries = collect_dynamic_libs("wasmtime", search_patterns=PY_DYLIB_PATTERNS + ["_lib*.so"])

spsdk_mcu_link-0.5.0/spsdk_mcu_link/dapper/__init__.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# Copyright 2024 NXP
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+# noqa: D205, D212, D415
+"""
+SPSDK MCU Link Dapper Module
+============================
+
+This module provides interfaces for working with Dapper debug probes.
+
+Components
+---------
+* DapperFactory: Factory class for creating Dapper instances
+* DapperProbeInfo: Class containing probe information
+* WebixDapper: Main Dapper implementation class
+* WebixDapperWasm: WASM-based Dapper implementation
+* Uint8Array: Type for handling byte arrays
+* Interface: Enumeration of available interfaces
+"""
+
+from .webix_dapper import DapperFactory, DapperProbeInfo, Interface, WebixDapper
+from .webix_dapper_wasm import Uint8Array, WebixDapperWasm
+
+__all__ = [
+    "DapperFactory",
+    "DapperProbeInfo",
+    "WebixDapper",
+    "WebixDapperWasm",
+    "Uint8Array",
+    "Interface",
+]