Skip to content

Commit

Permalink
doc: Updated 54H logging documentation
Browse files Browse the repository at this point in the history
Updated 54h logging documentation.
Added small fix to 54h custom pcb documentation.

Signed-off-by: Francesco Domenico Servidio <francesco.servidio@nordicsemi.no>
  • Loading branch information
FrancescoSer committed Sep 20, 2024
1 parent 0abbcf4 commit 7b6ec8f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
1 change: 1 addition & 0 deletions doc/nrf/app_dev/device_guides/nrf54h.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,6 @@ The following table indicates the compatibility between nRF54H20 firmware bundle
working_with_nrf/nrf54h/ug_nrf54h20_architecture
working_with_nrf/nrf54h/ug_nrf54h20_configuration
working_with_nrf/nrf54h/ug_nrf54h20_suit_dfu
working_with_nrf/nrf54h/ug_nrf54h20_logging
working_with_nrf/nrf54h/ug_nrf54h20_debugging
working_with_nrf/nrf54h/ug_nrf54h20_custom_pcb
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
:orphan:

.. _ug_nrf54h20_logging:

nRF54H20 logging
Expand All @@ -22,14 +20,14 @@ For general information on how logging works in the |NCS|, consult the :ref:`ug_
nRF54H20 logging using a direct UART connection
***********************************************

.. to review
.. TO_REVIEW
Similarly to other SoCs from Nordic Semiconductor, to use a UART connection for reading logs, follow the :ref:`ug_logging_backends_uart` logging guide in the application development section.

nRF54H20 logging using System Trace Macrocell (STM)
***************************************************

.. to review
.. TO_REVIEW
nRF54H20 domains contain ARM Coresight System Trace Macrocell (STM) hardware devices for collecting trace data from multiple domains, using either standalone logging or assisted multicore logging.
The STM uses memory-mapped registers to write trace data generated by the domains in the system.
Expand All @@ -41,7 +39,7 @@ The STM implements a frontend of the Zephyr logging subsystem, allowing you to u
Embedded Trace Router (ETR)
===========================

.. to review
.. TO_REVIEW
The Embedded Trace Router (ETR) is a hardware feature that provides a circular buffer in RAM for trace data.
It can trigger interrupts when the buffer is half-full or full, allowing the CPU to be woken up in time to handle the data.
Expand All @@ -59,7 +57,7 @@ However, due to the limited size of the ETR buffer, there is a risk of data loss
Standalone logging
==================

.. to review
.. TO_REVIEW
The current implementation for the standalone logging mode with STM works as follows:

Expand All @@ -75,7 +73,7 @@ This method bypasses the need for string formatting functions and peripheral dri
Configuration
-------------

.. to review
.. TO_REVIEW
To show the logs for a given domain in the UART output, you must enable the STM for that domain.

Expand All @@ -85,7 +83,7 @@ The STM will be enabled by the build system in the configuration of the SDFW.
Reading the logs
----------------

.. to review
.. TO_REVIEW
To read the STM log output on the UART, consult the following documentation pages:

Expand Down Expand Up @@ -130,7 +128,7 @@ The following are the prefixes used to indicate the cores:
Assisted multicore logging
==========================

.. to review
.. TO_REVIEW
Assisted multicore logging uses dictionary-based logging to send messages without redundant strings to STM, and is based on the :ref:`logging_guide_dictionary` feature of the logging API provided by Zephyr.
Instead of including the format strings in the log messages, it logs the addresses (message IDs) where the strings are stored, which reduces the size of the logging subsystem.
Expand All @@ -145,7 +143,7 @@ When using logs, this method has the following advantages:
Configuration
-------------

.. to review
.. TO_REVIEW
To enable the assisted multicore logging for a domain, set the :kconfig:option:`CONFIG_LOG_STM_DICT` Kconfig option for that domain's image to ``y``.

Expand All @@ -155,7 +153,7 @@ This file is crucial for decoding the logs and is updated with every build.
Reading the logs
----------------

.. to review
.. TO_REVIEW
To read the dictionary-based STM log output, do the following:

Expand Down Expand Up @@ -196,7 +194,7 @@ The following are the prefixes used to indicate the cores:
Additional considerations
-------------------------

.. to review
.. TO_REVIEW
When using assisted multicore logging, consider the following:

Expand Down

0 comments on commit 7b6ec8f

Please sign in to comment.