You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Added firmware kconfig options for enabling probes and logging
backend. Also added notes about the latest updates for sof-probes
demuxing tool.
Signed-off-by: Jyri Sarha <[email protected]>
Copy file name to clipboardExpand all lines: developer_guides/debugability/probes/index.rst
+34-1Lines changed: 34 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,6 +65,28 @@ Firmware side
65
65
66
66
make menuconfig
67
67
68
+
The following options available
69
+
70
+
Required for audio probes:
71
+
72
+
.. code-block:: bash
73
+
74
+
CONFIG_PROBE=y # enable probes
75
+
CONFIG_PROBE_POINTS_MAX=16 # max probepoints
76
+
77
+
Required for logging through probes interface:
78
+
79
+
.. code-block:: bash
80
+
81
+
CONFIG_LOG_BACKEND_SOF_PROBE=y
82
+
CONFIG_ZEPHYR_LOG=y
83
+
84
+
This option enables the probes logging automatically when probes extraction DMA is started:
85
+
86
+
.. code-block:: bash
87
+
88
+
CONFIG_LOG_BACKEND_SOF_PROBE_OUTPUT_AUTO_ENABLE=y
89
+
68
90
- Refer to **Step 3 Build firmware binaries** in :ref:`Build SOF from Scratch <build-from-scratch>` for reference.
69
91
70
92
Note that you do not need to modify the audio topology file.
@@ -101,6 +123,7 @@ the last stage of extraction.
101
123
- Pause the playback stream. (optional)
102
124
- Add probe points via the ``debugfs`` "probe_points" entry in ``/sys/kernel/debug/sof``
103
125
126
+
104
127
For example, to add a buffer with 7 probe points:
105
128
106
129
.. code-block:: bash
@@ -159,4 +182,14 @@ Usage and ouput:
159
182
sof-probes: done
160
183
161
184
As a result, ``buffer_7.wav`` is generated in the *tools/build_tools/probes* folder. The wave file can then be examined with your tool of choice
162
-
such as ``Audacity``.
185
+
such as ``Audacity``.
186
+
187
+
188
+
Simple logging case
189
+
*******************
190
+
191
+
With the crecord and sof-probes in path, probes logging backend with auto enable option it is possible to get the firmware logs to stdout with this command combination:
0 commit comments