Skip to content

Commit 57e88d2

Browse files
greg-ferrlubos
authored andcommitted
doc: logging: link to nrfutil trace
Added links to the new pages for nrfutil trace. NRFU-1247. Signed-off-by: Grzegorz Ferenc <[email protected]> (cherry picked from commit 738c362)
1 parent e6d9e89 commit 57e88d2

File tree

2 files changed

+14
-18
lines changed

2 files changed

+14
-18
lines changed

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_logging.rst

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -148,27 +148,21 @@ Reading the logs
148148

149149
To read the dictionary-based STM log output, do the following:
150150

151-
1. Set up the log capture.
151+
1. Start capturing the log with the ``nrfutil trace stm`` command.
152+
Use the following command pattern, with ``<domain_id>`` being the ID of the domain which the application is running on, ``<port>`` being the serial port used for output, and ``<app_name>`` being the application name:
152153

153-
Use the ``nrfutil trace stm`` command to start capturing logs from the device, specifying the database configuration for each domain ID, along with the serial port, baud rate, and output type::
154+
.. parsed-literal::
155+
:class: highlight
154156
155-
nrfutil trace stm --database-config <domain_id>:build/<app_name>/zephyr/log_dictionary.json --input-serialport <port> --baudrate 115200 --stdout ascii
157+
nrfutil trace stm \
158+
--database-config <domain_id>:build/<app_name>/zephyr/log_dictionary.json \
159+
--input-serialport <port> \
160+
--baudrate 115200 \
161+
--stdout ascii
156162
157-
This command contains the following parameters:
158-
159-
* ``<domain_id>`` is the ID of the domain which the application is running on.
160-
It should be in decimals, not in hexadecimals.
161-
When using several domains, use a comma (`,`) to separate each domain in the list.
162-
* ``<app_name>`` is the application name.
163-
* ``<port>`` is the serial port used for output.
164-
|serial_port_number_list|
165-
* The output can be either the console (``--stdout ascii``) or a file (the :file:`out.txt` file if ``--output-ascii out.txt``).
166-
167-
#. Capture and decode the logs.
168-
169-
nrfutil will capture the log data from the specified UART port and use the provided dictionary databases to decode the logs into a human-readable format.
170-
The tool sends the decoded logs to the specified output (either the console or the :file:`out.txt` file in the example).
163+
The output can be either the console (``--stdout ascii``) or a file (the :file:`out.txt` file if ``--output-ascii out.txt``).
171164

165+
#. When done, stop tracing by pressing CTRL-C.
172166
#. Read the terminal or open the output file to review the decoded log messages.
173167

174168
The output contains timestamps and the log messages in a human-readable format.
@@ -191,7 +185,7 @@ The following are the prefixes used to indicate the cores:
191185
Fast Lightweight Processor (FLPR), ``flpr``, 0x2d
192186
Peripheral Processor (PPR), ``ppr``, 0x2e
193187

194-
For more information on ``nrfutil trace``, see `nrfutil-trace`_.
188+
For more information, see `Capturing STM trace data`_ in the nRF Util documentation.
195189

196190
Additional considerations
197191
-------------------------

doc/nrf/links.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -939,6 +939,8 @@
939939
.. _`sdk-manager Starting and inspecting the toolchain environment`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-sdk-manager/guides/sdk_manager_env_launch.html
940940
.. _`Recovering the device`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-device/guides/programming_recovery.html
941941
.. _`nrfutil-trace`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-trace/CHANGELOG.html
942+
.. _`Capturing LTE modem trace data`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-trace/guides/tracing_lte.html
943+
.. _`Capturing STM trace data`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-trace/guides/tracing_stm.html
942944
.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html
943945
.. _`Device command overview`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-device/guides/programming.html
944946
.. _`Programming application firmware using MCUboot serial recovery`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-device/guides/programming_firmware_thingy91.html

0 commit comments

Comments
 (0)