Skip to content

Commit

Permalink
doc: add documentation for Lauterbach TRACE32 components
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Merkle committed Sep 8, 2023
1 parent 4a64e31 commit 24b0bbe
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions doc/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -783,6 +783,45 @@ Arguments:
Used by:
- `OpenOCDDriver`_

USBLauterbachDebugger
~~~~~~~~~~~~~~~~~~~~~
An USBLauterbachDebugger resource describes a Lauterbach
PowerDebug/PowerTrace/uTrace debugger device connected via USB.

.. code-block:: yaml
USBLauterbachDebugger:
match:
ID_PATH: pci-0000:00:10.0-usb-0:1.4
.. code-block:: yaml
USBLauterbachDebugger:
match:
ID_SERIAL_SHORT: C230901234567
Arguments:
- match (dict): key and value pairs for a udev match, see `udev Matching`_

Used by:
- `LauterbachDriver`_

NetworkLauterbachDebugger
~~~~~~~~~~~~~~~~~~~~~~~~~
An NetworkLauterbachDebugger resource describes a Lauterbach
PowerDebug debugger device connected via Ethernet.

.. code-block:: yaml
NetworkLauterbachDebugger:
node: E230901234567
Arguments:
- node : Lauterbach NODENAME e.g. IP/NODENAME (factory default: serial number)

Used by:
- `LauterbachDriver`_

SNMPEthernetPort
~~~~~~~~~~~~~~~~
A SNMPEthernetPort resource describes a port on an Ethernet switch, which is
Expand Down Expand Up @@ -1789,6 +1828,35 @@ Arguments:
- board_config (str): optional, board config in the ``openocd/scripts/board/`` directory
- load_commands (list of str): optional, load commands to use instead of ``init``, ``bootstrap {filename}``, ``shutdown``

LauterbachDriver
~~~~~~~~~~~~~~~~
A LauterbachDriver controls the “Lauterbach TRACE32 PowerView” to debug a target.

The ``t32_sys`` argument refers to paths declared in the environment configuration.

Binds to:
interface:
- `USBLauterbachDebugger`_
- `NetworkLauterbachDebugger`_

Implements:
- :any:`DebuggerProtocol`

.. code-block:: yaml
LauterbachDriver:
t32_bin: t32marm
t32_sys: t32_dvd202309
.. code-block:: yaml
paths:
t32_sys: ~/t32/t32dvd202309
Arguments:
- t32_bin (str): optional, name of the TRACE32 architecture executable ``t32m*`` (default ``t32marm``)
- t32_sys (str): optional, base folder of the TRACE32 installation (default ENV['T32SYS'] or ``/opt/t32``)

QuartusHPSDriver
~~~~~~~~~~~~~~~~
A QuartusHPSDriver controls the "Quartus Prime Programmer and Tools" to flash
Expand Down

0 comments on commit 24b0bbe

Please sign in to comment.