Metadata-Version: 2.4
Name: spsdk-lauterbach
Version: 0.5.2
Summary: Lauterbach debug probe plugin for SPSDK
Author: NXP
Maintainer-email: Michal Starecek <spsdk@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.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: lauterbach-trace32-rcl
Requires-Dist: spsdk<4,>=3.10.0.dev0
Dynamic: license-file


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
    - to install spsdk run: `pip install spsdk`
* `pip install spsdk-lauterbach`
* Verify installation by running `nxpdebugmbox --help`
    - you should see `lauterbach` amongst available interfaces (--interface)


Setup
-----

* 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


Usage
-----

* Start Trace32
* Run your startup script
* Run `nxpdebugmbox`
  - you may specify `-i/--interface lauterbach`
  - you may specify `-s/--serial-no <probe's serial number>`

Alternatively you may pass the startup script to nxpdebugmbox:
* Start Trace32
* Run: `nxpdebugmbox -o startup=/path/to/startup_script.cmm`


Credits
-------

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [SPSDK Debug probe project template](https://github.com/nxp-mcuxpresso/spsdk/blob/master/examples/plugins/templates/cookiecutter-spsdk-debug-probe-plugin.zip).
