spsdk-lauterbach 0.1.0__tar.gz

spsdk_lauterbach-0.1.0/LICENSE

@@ -0,0 +1,31 @@
+
+
+BSD 3-Clause "New" or "Revised" License
+
+Copyright 2024 NXP
+
+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_lauterbach-0.1.0/MANIFEST.in

@@ -0,0 +1,13 @@
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+include SW_Content_Register_spsdk_lauterbach.txt
+include requirements*
+
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude .github *
+prune tests
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

spsdk_lauterbach-0.1.0/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: spsdk-lauterbach
+Version: 0.1.0
+Summary: Lauterbach debug probe plugin for SPSDK
+Author: NXP
+Maintainer-email: Michal Starecek <michal.starecek@nxp.com>
+License: BSD-3-Clause
+Project-URL: Homepage, https://github.com/nxp-mcuxpresso/spsdk_plugins/tree/master/lauterbach
+Project-URL: Issues, https://github.com/nxp-mcuxpresso/spsdk_plugins/issues
+Keywords: NXP,SPSDK,Lauterbach
+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
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: spsdk>=2.2.0
+Requires-Dist: lauterbach-trace32-rcl
+
+
+Lauterbach debug probe Plugin
+=============================
+
+
+* Free software: BSD-3-Clause
+
+
+Features
+--------
+
+* Allow SPSDK to use Trace32 as an interface for Lauterbach debugger probes.
+
+
+Installation
+------------
+
+* Activate virtual env, where you have SPSDK
+    - if SPSDK is not installed, the latest one will be installed automatically from [PyPI](https://pypi.org/project/spsdk/)
+* `pip install spsdk-lauterbach`
+* Verify installation by running `nxpdebugmbox --help`
+    - you should see `lauterbach` amongst available interfaces (--interface)
+
+
+Usage
+-----
+
+* Make sure to enable remote control to Trace32 in your config file
+    ```
+    <mandatory empty line>
+    ; Remote Control Access
+    RCL=NETTCP
+    PORT=20000
+    <mandatory empty line>
+    ```
+
+* Make sure your startup script contains the following:
+  - (required) DEBUGPORTTYPE (SWD, JTAG, CJTAG)
+  - (required) CPU family (e.g.: CortexM33)
+  - (optional) exact CPU (e.g.: LPC55S69JBD64-CPU0)
+    - Exact CPU is not crucial for Debug Authentication (DA), it's for testing whether DA was successful
+    - Without specifying exact CPU, `nxpdebugmbox` will end `without AHB access`, thus unable to determine DA's status
+
+
+* Start Trace32
+* Run your startup script
+* Run `nxpdebugmbox`
+  - you may specify `-i/--interface lauterbach`
+  - you may specify `-s/--serial-no <probe's serial number>`
+
+
+Credits
+-------
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.

spsdk_lauterbach-0.1.0/README.md

@@ -0,0 +1,55 @@
+
+Lauterbach debug probe Plugin
+=============================
+
+
+* Free software: BSD-3-Clause
+
+
+Features
+--------
+
+* Allow SPSDK to use Trace32 as an interface for Lauterbach debugger probes.
+
+
+Installation
+------------
+
+* Activate virtual env, where you have SPSDK
+    - if SPSDK is not installed, the latest one will be installed automatically from [PyPI](https://pypi.org/project/spsdk/)
+* `pip install spsdk-lauterbach`
+* Verify installation by running `nxpdebugmbox --help`
+    - you should see `lauterbach` amongst available interfaces (--interface)
+
+
+Usage
+-----
+
+* Make sure to enable remote control to Trace32 in your config file
+    ```
+    <mandatory empty line>
+    ; Remote Control Access
+    RCL=NETTCP
+    PORT=20000
+    <mandatory empty line>
+    ```
+
+* Make sure your startup script contains the following:
+  - (required) DEBUGPORTTYPE (SWD, JTAG, CJTAG)
+  - (required) CPU family (e.g.: CortexM33)
+  - (optional) exact CPU (e.g.: LPC55S69JBD64-CPU0)
+    - Exact CPU is not crucial for Debug Authentication (DA), it's for testing whether DA was successful
+    - Without specifying exact CPU, `nxpdebugmbox` will end `without AHB access`, thus unable to determine DA's status
+
+
+* Start Trace32
+* Run your startup script
+* Run `nxpdebugmbox`
+  - you may specify `-i/--interface lauterbach`
+  - you may specify `-s/--serial-no <probe's serial number>`
+
+
+Credits
+-------
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.

spsdk_lauterbach-0.1.0/SW_Content_Register_spsdk_lauterbach.txt

@@ -0,0 +1,10 @@
+NXP Software Content Register
+
+Package:                   spsdk-lauterbach
+Version:                   0.1.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 Lauterbach probes
+Origin:                    NXP (BSD-3-Clause)
+URL:                       https://github.com/nxp-mcuxpresso/spsdk_plugins/tree/master/lauterbach

spsdk_lauterbach-0.1.0/pyproject.toml

@@ -0,0 +1,208 @@
+[project]
+name = "spsdk-lauterbach"
+description = "Lauterbach debug probe plugin for SPSDK"
+dynamic = ["version"]
+
+requires-python = ">= 3.9"
+dependencies = ["spsdk>=2.2.0", "lauterbach-trace32-rcl"]
+entry-points = { "spsdk.debug_probe" = { lauterbach = "spsdk_lauterbach.probe" } }
+
+authors = [{ name = "NXP" }]
+maintainers = [{ name = "Michal Starecek", email = "michal.starecek@nxp.com" }]
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { text = "BSD-3-Clause" }
+
+keywords = ["NXP", "SPSDK", "Lauterbach"]
+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",
+]
+
+[project.urls]
+Homepage = "https://github.com/nxp-mcuxpresso/spsdk_plugins/tree/master/lauterbach"
+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_lauterbach"]
+
+[tool.setuptools.dynamic]
+version = { attr = "spsdk_lauterbach.__version__" }
+
+[tool.bumpversion]
+current_version = "0.1.0"
+
+[[tool.bumpversion.files]]
+filename = "spsdk_lauterbach/__init__.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "SW_Content_Register_spsdk_lauterbach.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"]
+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.pydocstyle]
+convention = "google"
+add_ignore = "D105,D301"
+match = '(?!test_|__version__).*\.py'
+
+[tool.pylint]
+format = { max-line-length = 120 }
+"messages control" = { disable = ["logging-fstring-interpolation"] }
+
+
+[tool.checker_depencecies.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", "BSD 2-Clause License"]
+"BSD-3-Clause" = [
+    "BSD",
+    "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"]
+"GPL-2.0-or-later" = []
+"LGPL-2.0-only" = ["LGPL-2.0"]
+"LGPL-2.1-or-later" = []
+"LGPL-3.0-only" = ["LGPL-3.0"]
+"ISC" = ["ISC license"]
+
+[tool.nxp_codecheck]
+git_parent_branch = "origin/master"
+output_directory = "reports"
+default_check_paths = ["spsdk_lauterbach"]
+
+# *********************************** Checker list ***********************************
+[[tool.nxp_codecheck.checkers]]
+name = "PYTEST"
+method = "check_pytest"
+# check_paths = [] # The default check paths could be overrides by local settings
+info_only = false
+kwargs = { disable_xdist = false }
+
+# [[tool.nxp_codecheck.checkers]]
+#     name = "GITCOV"
+#     method = "check_gitcov"
+#     # check_paths = [] # The default check paths could be overrides by local settings
+#     info_only = true
+#     dependencies = ["PYTEST"]
+[[tool.nxp_codecheck.checkers]]
+name = "PYLINT"
+method = "check_pylint"
+# check_paths = [] # The default check paths could be overrides by local settings
+info_only = false
+[[tool.nxp_codecheck.checkers]]
+name = "MYPY"
+method = "check_mypy"
+# check_paths = [] # The default check paths could be overrides by local settings
+info_only = false
+[[tool.nxp_codecheck.checkers]]
+name = "DEPENDENCIES"
+method = "check_dependencies"
+# check_paths = [] # The default check paths could be overrides by local settings
+info_only = false
+fixer = "fix_dependencies"
+[[tool.nxp_codecheck.checkers]]
+name = "PYDOCSTYLE"
+method = "check_pydocstyle"
+# check_paths = [] # The default check paths could be overrides by local settings
+info_only = false
+[[tool.nxp_codecheck.checkers]]
+name = "RADON_C"
+method = "check_radon"
+# check_paths = [] # The default check paths could be overrides by local settings
+info_only = true
+kwargs = { min_rank = "C" }
+[[tool.nxp_codecheck.checkers]]
+name = "RADON_D"
+method = "check_radon"
+# check_paths = [] # The default check paths could be overrides by local settings
+info_only = false
+kwargs = { min_rank = "D" }
+[[tool.nxp_codecheck.checkers]]
+name = "BLACK"
+method = "check_black"
+# check_paths = [] # The default check paths could be overrides by local settings
+info_only = false
+dependencies = []
+fixer = "fix_black"
+[[tool.nxp_codecheck.checkers]]
+name = "ISORT"
+method = "check_isort"
+# check_paths = [] # The default check paths could be overrides by local settings
+info_only = false
+dependencies = []
+fixer = "fix_isort"
+[[tool.nxp_codecheck.checkers]]
+name = "COPYRIGHT"
+method = "check_copyright_year"
+# check_paths = [] # The default check paths could be overrides by local settings
+info_only = false
+dependencies = []
+fixer = "fix_copyright_year"
+[[tool.nxp_codecheck.checkers]]
+name = "PY_HEADERS"
+method = "check_py_file_headers"
+# check_paths = [] # The default check paths could be overrides by local settings
+info_only = false
+dependencies = []
+fixer = "fix_py_file_headers"
+[[tool.nxp_codecheck.checkers]]
+name = "CYCLIC"
+method = "check_cyclic_imports"
+# check_paths = [] # The default check paths could be overrides by local settings
+info_only = false
+dependencies = []

spsdk_lauterbach-0.1.0/requirements_dev.txt

@@ -0,0 +1,10 @@
+# package management
+build
+bump-my-version
+twine
+
+# testing
+tox
+
+# code quality
+nxp-codecheck

spsdk_lauterbach-0.1.0/setup.cfg

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

spsdk_lauterbach-0.1.0/spsdk_lauterbach/__init__.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+#
+# Copyright 2024 NXP
+#
+# SPDX-License-Identifier: BSD-3-Clause
+"""Top-level package for Lauterbach debug probe plugin."""
+
+__author__ = """NXP"""
+__email__ = "michal.starecek@nxp.com"
+__version__ = "0.1.0"
+
+from .probe import DebugProbeLauterbach
+
+__all__ = ["DebugProbeLauterbach"]

spsdk_lauterbach-0.1.0/spsdk_lauterbach/probe.py

@@ -0,0 +1,281 @@
+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+#
+# Copyright 2024 NXP
+#
+# SPDX-License-Identifier: BSD-3-Clause
+"""Main module for Lauterbach debug probe plugin."""
+
+import functools
+import logging
+import time
+from typing import Any, Callable, Dict, Optional, Tuple
+
+from spsdk.debuggers.debug_probe import (
+    DebugProbeLocal,
+    DebugProbes,
+    ProbeDescription,
+    SPSDKDebugProbeError,
+    SPSDKDebugProbeNotOpenError,
+    SPSDKDebugProbeTransferError,
+)
+from spsdk.utils.spsdk_enum import SpsdkEnum
+
+import lauterbach.trace32.rcl as t32
+
+logger = logging.getLogger(__name__)
+
+
+class T32Mode(SpsdkEnum):
+    """Enumeration of known T32 Modes (SYStem.Mode)."""
+
+    DOWN = (0, "Down")
+    STAND_BY = (1, "StandBy")
+    NO_DEBUG = (2, "NoDebug")
+    PREPARE = (4, "Prepare")
+    UP = (11, "Up")
+    UNKNOWN = (255, "UNKNOWN")
+
+
+def ensure_mode(mode: Optional[T32Mode]) -> Callable:
+    """Decorator that checks if connection is open and sets T32 mode.
+
+    If `mode` is set to None, perform only check for open connection.
+    """
+
+    def decorator(func: Callable) -> Any:
+        @functools.wraps(func)
+        def wrapper(self: "DebugProbeLauterbach", *args: Any, **kwargs: Any) -> Any:
+            self.set_mode(mode=mode)
+            return func(self, *args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
+class DebugProbeLauterbach(DebugProbeLocal):
+    """SPSDK Debug Probe Lauterbach debug probe plugin class."""
+
+    NAME = "lauterbach"
+
+    def __init__(self, hardware_id: str, options: Optional[Dict] = None) -> None:
+        """The Debug Probe class initialization."""
+        super().__init__(hardware_id, options)
+        self.address, self.port = self.parse_options(options=options)
+        self.connection: Optional[t32.Debugger] = None
+        self.mode = T32Mode.UNKNOWN
+
+    @classmethod
+    def parse_options(cls, options: Optional[Dict] = None) -> Tuple[str, int]:
+        """Parse options passed to __init__ method.
+
+        :param options: Options passed to __init__ method, defaults to None
+        :return: T32 address and port (default localhost, 20_000)
+        """
+        if not options:
+            address = "localhost"
+            port = 20_000
+        else:
+            ip: str = options.get("ip", "localhost:20000")
+            parts = ip.split(":")
+            address = parts[0]
+            port = 20_000 if len(parts) == 1 else int(parts[1], 0)
+
+        return address, port
+
+    @classmethod
+    def get_connected_probes(
+        cls, hardware_id: Optional[str] = None, options: Optional[Dict] = None
+    ) -> DebugProbes:
+        """Functions returns the list of all connected probes in system.
+
+        There is option to look for just for one debug probe defined by its hardware ID.
+
+        :param hardware_id: None to list all probes, otherwise the the only probe with
+            matching hardware id is listed.
+        :param options: The options dictionary
+        :return: List of ProbeDescription
+        """
+        probes = DebugProbes()
+        address, port = cls.parse_options(options=options)
+        try:
+            connection = t32.connect(node=address, port=port, timeout=1.0)
+            serial = connection.fnc("LICENSE.SERIAL(0)")
+            if hardware_id and hardware_id != serial:
+                return probes
+            probes.append(
+                ProbeDescription(
+                    interface="lauterbach",
+                    hardware_id=serial,
+                    description=f"Lauterbach probe at {address}:{port}",
+                    probe=cls,
+                )
+            )
+            connection.disconnect()
+        except (ConnectionRefusedError, TimeoutError):
+            pass
+
+        return probes
+
+    @staticmethod
+    def get_options_help() -> Dict[str, str]:
+        """Get full list of options of debug probe.
+
+        :return: Dictionary with individual options. Key is parameter name and value the help text.
+        """
+        return {
+            "ip": "[HOST][:PORT] of the Lauterbach T32. Default HOST: localhost, default PORT: 20_000",
+            "note": "Your config.t32 file shall contain the following settings: RCL=NETTCP PORT=20000",
+        }
+
+    def open(self) -> None:
+        """Debug probe open.
+
+        General opening function for SPSDK library to support various DEBUG PROBES.
+        The function is used to initialize the connection to target and enable using debug probe
+        for DAT purposes.
+        """
+        self.connection = t32.connect(node=self.address, port=self.port)
+
+    def connect(self) -> None:
+        """Connect to target.
+
+        The PyLink connecting function for SPSDK library to support various DEBUG PROBES.
+        The function is used to initialize the connection to target
+
+        :raises SPSDKDebugProbeError: The PyLink cannot establish communication with target
+        """
+        self.set_mode(T32Mode.PREPARE)
+
+    def close(self) -> None:
+        """Debug probe close.
+
+        This is general closing function for SPSDK library to support various DEBUG PROBES.
+        """
+        if self.connection:
+            self.set_mode(T32Mode.DOWN)
+            self.connection.disconnect()
+            self.connection = None
+
+    def set_mode(self, mode: Optional[T32Mode]) -> None:
+        """Method to check if connection is open and sets Trace32 to desired mode.
+
+        If `mode` is set to None, perform only check for open connection.
+        """
+        if self.connection is None:
+            raise SPSDKDebugProbeNotOpenError()
+        if mode is None:
+            return
+        if self.mode == mode:
+            return
+        try:
+            self.connection.cmd(f"SYStem.Mode {mode.label}")
+        except t32.CommandError:
+            time.sleep(self.RESET_TIME)
+        try:
+            self.connection.cmd(f"SYStem.Mode {mode.label}")
+        except t32.CommandError as e:
+            raise SPSDKDebugProbeError(f"Unable to set mode: {mode.label}. Error: {e}") from e
+        self.mode = T32Mode.from_tag(self.connection.fnc("SYStem.Mode()"))
+        if self.mode != mode:
+            raise SPSDKDebugProbeError(f"Unable to set mode: {mode.label}")
+
+    def _get_cs_addr(self, access_port: bool, addr: int) -> int:
+        """Get CoreSight register address.
+
+        :param access_port: Get address for Access Port (set to false for Debug Port)
+        :param addr: Address of the Coresight register
+        :return: Full CoreSight register address
+        """
+        if access_port:
+            ap_num = (addr & self.APSEL) >> self.APSEL_SHIFT
+            return self._get_ap_addr(ap_num, addr)
+        return self._get_dp_addr(addr)
+
+    @staticmethod
+    def _get_dp_addr(reg_addr: int) -> int:
+        """Encode DP register byte address into T32 special format.
+
+        :param reg_addr: DP register address
+        :return: T32 DP address
+        """
+        addr = reg_addr & 0xFF
+        addr |= 0x4100_0000
+        return addr
+
+    @staticmethod
+    def _get_ap_addr(ap_number: int, reg_addr: int) -> int:
+        """Encode AP register byte address into T32 special format.
+
+        :param ap_number: AP index
+        :param reg_addr: AP register address
+        :return: T32 AP address
+        """
+        addr = reg_addr & 0xFF
+        addr |= (ap_number & 0xFF) << 8
+        addr |= 0x4000_0000
+        return addr
+
+    @ensure_mode(T32Mode.PREPARE)
+    def coresight_reg_read(self, access_port: bool = True, addr: int = 0) -> int:
+        """Read coresight register.
+
+        It reads coresight register function for SPSDK library to support various DEBUG PROBES.
+
+        :param access_port: if True, the Access Port (AP) register will be read(default), otherwise the Debug Port
+        :param addr: the register address
+        :return: The read value of addressed register (4 bytes)
+        """
+        logger.debug(f"CS READ: AP: {access_port}, ADDR: {addr:#x}")
+        try:
+            cs_addr = self._get_cs_addr(access_port=access_port, addr=addr)
+            cmd = f"DATA.LONG(EDBG:{cs_addr:#06x})"
+            data = self.connection.fnc(cmd)  # type: ignore[union-attr] # None case is handled by "ensure_mode"
+            logger.debug(f"RESULT: {data:#x}")
+            return data
+        except t32.FunctionError as e:
+            raise SPSDKDebugProbeTransferError(str(e)) from e
+
+    @ensure_mode(T32Mode.PREPARE)
+    def coresight_reg_write(self, access_port: bool = True, addr: int = 0, data: int = 0) -> None:
+        """Write coresight register.
+
+        It writes coresight register function for SPSDK library to support various DEBUG PROBES.
+
+        :param access_port: if True, the Access Port (AP) register will be write(default), otherwise the Debug Port
+        :param addr: the register address
+        :param data: the data to be written into register
+        """
+        logger.debug(f"CS WRITE: AP: {access_port}, ADDR: {addr:#x}")
+        try:
+            cs_addr = self._get_cs_addr(access_port=access_port, addr=addr)
+            cmd = f"DATA.SET EDBG:{cs_addr:#06x} %Long {data:#x}"
+            try:
+                self.connection.cmd(cmd)  # type: ignore[union-attr] # None case is handled by "ensure_mode"
+            except t32.CommandError as e:
+                if e.args[0] == "target reset detected":
+                    time.sleep(0.5)
+                    return
+                raise
+        except t32.CommandError as e:
+            raise SPSDKDebugProbeTransferError(str(e)) from e
+
+    @ensure_mode(None)
+    def assert_reset_line(self, assert_reset: bool = False) -> None:
+        """Control reset line at a target.
+
+        :param assert_reset: If True, the reset line is asserted(pulled down), if False the reset line is not affected.
+        """
+        if assert_reset:
+            self.connection.cmd("SYStem.RESetOut")  # type: ignore[union-attr] # None case is handled by "ensure_mode"
+
+    @ensure_mode(None)
+    def clear_sticky_errors(self) -> None:
+        """Clear sticky errors of Debug port interface."""
+        self.set_mode(T32Mode.DOWN)
+        self.set_mode(T32Mode.PREPARE)
+
+    def __str__(self) -> str:
+        """Return information about the device."""
+        return f"lauterbach at {self.address}:{self.port}"

spsdk_lauterbach-0.1.0/spsdk_lauterbach.egg-info/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: spsdk-lauterbach
+Version: 0.1.0
+Summary: Lauterbach debug probe plugin for SPSDK
+Author: NXP
+Maintainer-email: Michal Starecek <michal.starecek@nxp.com>
+License: BSD-3-Clause
+Project-URL: Homepage, https://github.com/nxp-mcuxpresso/spsdk_plugins/tree/master/lauterbach
+Project-URL: Issues, https://github.com/nxp-mcuxpresso/spsdk_plugins/issues
+Keywords: NXP,SPSDK,Lauterbach
+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
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: spsdk>=2.2.0
+Requires-Dist: lauterbach-trace32-rcl
+
+
+Lauterbach debug probe Plugin
+=============================
+
+
+* Free software: BSD-3-Clause
+
+
+Features
+--------
+
+* Allow SPSDK to use Trace32 as an interface for Lauterbach debugger probes.
+
+
+Installation
+------------
+
+* Activate virtual env, where you have SPSDK
+    - if SPSDK is not installed, the latest one will be installed automatically from [PyPI](https://pypi.org/project/spsdk/)
+* `pip install spsdk-lauterbach`
+* Verify installation by running `nxpdebugmbox --help`
+    - you should see `lauterbach` amongst available interfaces (--interface)
+
+
+Usage
+-----
+
+* Make sure to enable remote control to Trace32 in your config file
+    ```
+    <mandatory empty line>
+    ; Remote Control Access
+    RCL=NETTCP
+    PORT=20000
+    <mandatory empty line>
+    ```
+
+* Make sure your startup script contains the following:
+  - (required) DEBUGPORTTYPE (SWD, JTAG, CJTAG)
+  - (required) CPU family (e.g.: CortexM33)
+  - (optional) exact CPU (e.g.: LPC55S69JBD64-CPU0)
+    - Exact CPU is not crucial for Debug Authentication (DA), it's for testing whether DA was successful
+    - Without specifying exact CPU, `nxpdebugmbox` will end `without AHB access`, thus unable to determine DA's status
+
+
+* Start Trace32
+* Run your startup script
+* Run `nxpdebugmbox`
+  - you may specify `-i/--interface lauterbach`
+  - you may specify `-s/--serial-no <probe's serial number>`
+
+
+Credits
+-------
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.

spsdk_lauterbach-0.1.0/spsdk_lauterbach.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+MANIFEST.in
+README.md
+SW_Content_Register_spsdk_lauterbach.txt
+pyproject.toml
+requirements_dev.txt
+spsdk_lauterbach/__init__.py
+spsdk_lauterbach/probe.py
+spsdk_lauterbach.egg-info/PKG-INFO
+spsdk_lauterbach.egg-info/SOURCES.txt
+spsdk_lauterbach.egg-info/dependency_links.txt
+spsdk_lauterbach.egg-info/entry_points.txt
+spsdk_lauterbach.egg-info/requires.txt
+spsdk_lauterbach.egg-info/top_level.txt

spsdk_lauterbach-0.1.0/spsdk_lauterbach.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

spsdk_lauterbach-0.1.0/spsdk_lauterbach.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[spsdk.debug_probe]
+lauterbach = spsdk_lauterbach.probe

spsdk_lauterbach-0.1.0/spsdk_lauterbach.egg-info/requires.txt

@@ -0,0 +1,2 @@
+spsdk>=2.2.0
+lauterbach-trace32-rcl

spsdk_lauterbach-0.1.0/spsdk_lauterbach.egg-info/top_level.txt

@@ -0,0 +1 @@
+spsdk_lauterbach