Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-10-02 11:10:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

change(app_trace): move sysview to component registry

Browse Source
This commit is contained in:
Erhan Kurubas
2025-11-13 10:50:42 +01:00
parent ccc59ed681
commit 7d4ae881c5
66 changed files with 146 additions and 8456 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-guides/app_trace.rst
+15 -2
View File
@@ -400,7 +400,20 @@ Another useful ESP-IDF feature built on top of application tracing library is th
How To Use It
"""""""""""""
Support for this feature is enabled by ``Component config`` > ``ESP Trace Configuration`` > ``Trace library`` > ``SEGGER SystemView`` menuconfig option. There are several other options enabled under the same menu:
SystemView support is provided by the managed component ``espressif/esp_sysview``. The SystemView menu becomes visible only after:
1. Adding the component dependency in ``idf_component.yml``:
.. code-block:: yaml
dependencies:
espressif/esp_sysview: ^1
2. Selecting the external library in menuconfig: ``Component config`` > ``ESP Trace Configuration`` > ``Trace library`` > ``External library from component registry``.
After that, you can configure SystemView in ``Component config`` > ``SEGGER SystemView Configuration``. For full, up-to-date instructions, see the component README: `esp_sysview <https://components.espressif.com/components/espressif/esp_sysview>`_.
There are several other options enabled under the same menu:
1. {IDF_TARGET_NAME} timer to use as SystemView timestamp source: (:ref:`CONFIG_ESP_TRACE_TIMESTAMP_SOURCE`) selects the source of timestamps for SystemView events. In the single core mode, timestamps are generated using {IDF_TARGET_NAME} internal cycle counter running at maximum frequency. (:ref:`CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ`) In the dual-core mode, external timer is used to generate timestamps. It's frequency is 1/2 of the CPU frequency.
@@ -513,7 +526,7 @@ After trace data are collected, users can use a special tool to visualize the re
This command will create a single trace file that can be loaded directly into SystemView 3.60+ for multi-core visualization.
**Note:** SystemView versions before 3.60 do not support multi-core tracing. For older versions, when tracing from {IDF_TARGET_NAME} with JTAG interfaces in the dual-core mode, two separate files are generated: one for PRO CPU and another for APP CPU. Users can load each file into separate instances of the tool. For tracing over UART, users can select ``Component config`` > ``ESP Trace Configuration`` > ``SEGGER SystemView`` in menuconfig to choose which CPU (Pro or App) has to be traced.
**Note:** SystemView versions before 3.60 do not support multi-core tracing. For older versions, when tracing from {IDF_TARGET_NAME} with JTAG interfaces in the dual-core mode, two separate files are generated: one for PRO CPU and another for APP CPU. Users can load each file into separate instances of the tool. For tracing over UART, after selecting the external library in menuconfig, users can select ``Component config`` > ``SEGGER SystemView Configuration`` to choose which CPU (Pro or App) has to be traced.
For older SystemView versions, analyzing data for every core in separate instances can be awkward. An alternative is to use the Eclipse plugin called *Impulse*, which can load several trace files, making it possible to inspect events from both cores in one view. This plugin also has no limitation of 1,000,000 events as compared to the free version of SystemView.
docs/en/api-reference/system/app_trace.rst
-1
View File
@@ -25,4 +25,3 @@ API Reference
-------------
.. include-build-file:: inc/esp_app_trace.inc
.. include-build-file:: inc/esp_sysview_trace.inc
docs/en/migration-guides/release-6.x/6.0/system.rst
+19 -3
View File
@@ -134,10 +134,26 @@ New configuration:
CONFIG_APPTRACE_DEST_UART=y
CONFIG_APPTRACE_DEST_UART_NUM=0 # or 1, 2 depending on target
SystemView Configuration
^^^^^^^^^^^^^^^^^^^^^^^^
SEGGER SystemView
^^^^^^^^^^^^^^^^^
The SystemView configuration has been moved to a new location in the menuconfig: ``Component config`` > ``ESP Trace Configuration`` > ``Trace library`` > ``SEGGER SystemView``.
The SystemView component has been moved to a separate repository. `esp_sysview <https://components.espressif.com/components/espressif/esp_sysview>`_ is now a managed component.
Configuration
^^^^^^^^^^^^^^
The SystemView configuration has been moved to a new location in the menuconfig. It becomes visible only when the project adds the ``esp_sysview`` component dependency in ``idf_component.yml`` and the external library is selected in menuconfig.
Add the dependency in your component manifest:
.. code-block:: yaml
dependencies:
espressif/esp_sysview: ^1
Then, in menuconfig, select: ``Component config`` > ``ESP Trace Configuration`` > ``Trace library`` > ``External library from component registry``.
After that, the SystemView configuration can be shown by selecting ``Component config`` > ``SEGGER SystemView Configuration``.
The SystemView no longer has its own separate destination configuration. It shares the configuration with the application tracing transport (JTAG or UART).