Skip to content

Commit 7553acf

Browse files
author
Alexander Merkle
committed
doc: add documentation for Lauterbach TRACE32 components
1 parent d6bc957 commit 7553acf

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

doc/configuration.rst

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -783,6 +783,45 @@ Arguments:
783783
Used by:
784784
- `OpenOCDDriver`_
785785

786+
USBLauterbachDebugger
787+
~~~~~~~~~~~~~~~~~~~~~
788+
An USBLauterbachDebugger resource describes a Lauterbach
789+
PowerDebug/PowerTrace/uTrace debugger device connected via USB.
790+
791+
.. code-block:: yaml
792+
793+
USBLauterbachDebugger:
794+
match:
795+
ID_PATH: pci-0000:00:10.0-usb-0:1.4
796+
797+
.. code-block:: yaml
798+
799+
USBLauterbachDebugger:
800+
match:
801+
ID_SERIAL_SHORT: C230901234567
802+
803+
Arguments:
804+
- match (dict): key and value pairs for a udev match, see `udev Matching`_
805+
806+
Used by:
807+
- `LauterbachDriver`_
808+
809+
NetworkLauterbachDebugger
810+
~~~~~~~~~~~~~~~~~~~~~~~~~
811+
An NetworkLauterbachDebugger resource describes a Lauterbach
812+
PowerDebug debugger device connected via Ethernet.
813+
814+
.. code-block:: yaml
815+
816+
NetworkLauterbachDebugger:
817+
node: E230901234567
818+
819+
Arguments:
820+
- node : Lauterbach NODENAME e.g. IP/NODENAME (factory default: serial number)
821+
822+
Used by:
823+
- `LauterbachDriver`_
824+
786825
SNMPEthernetPort
787826
~~~~~~~~~~~~~~~~
788827
A SNMPEthernetPort resource describes a port on an Ethernet switch, which is
@@ -1789,6 +1828,35 @@ Arguments:
17891828
- board_config (str): optional, board config in the ``openocd/scripts/board/`` directory
17901829
- load_commands (list of str): optional, load commands to use instead of ``init``, ``bootstrap {filename}``, ``shutdown``
17911830

1831+
LauterbachDriver
1832+
~~~~~~~~~~~~~~~~
1833+
A LauterbachDriver controls the “Lauterbach TRACE32 PowerView” to debug a target.
1834+
1835+
The ``t32_sys`` argument refers to paths declared in the environment configuration.
1836+
1837+
Binds to:
1838+
interface:
1839+
- `USBLauterbachDebugger`_
1840+
- `NetworkLauterbachDebugger`_
1841+
1842+
Implements:
1843+
- :any:`DebuggerProtocol`
1844+
1845+
.. code-block:: yaml
1846+
1847+
LauterbachDriver:
1848+
t32_bin: t32marm
1849+
t32_sys: t32_dvd202309
1850+
1851+
.. code-block:: yaml
1852+
1853+
paths:
1854+
t32_sys: ~/t32/t32dvd202309
1855+
1856+
Arguments:
1857+
- t32_bin (str): optional, name of the TRACE32 architecture executable ``t32m*`` (default ``t32marm``)
1858+
- t32_sys (str): optional, base folder of the TRACE32 installation (default ENV['T32SYS'] or ``/opt/t32``)
1859+
17921860
QuartusHPSDriver
17931861
~~~~~~~~~~~~~~~~
17941862
A QuartusHPSDriver controls the "Quartus Prime Programmer and Tools" to flash

0 commit comments

Comments
 (0)