Skip to content

Commit 5aaf07a

Browse files
jsarhadeb-intel
authored andcommitted
developer_guides: debugability: probes: Logging backend sof-probes update
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]>
1 parent 9839169 commit 5aaf07a

File tree

1 file changed

+34
-1
lines changed
  • developer_guides/debugability/probes

1 file changed

+34
-1
lines changed

developer_guides/debugability/probes/index.rst

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,28 @@ Firmware side
6565
6666
make menuconfig
6767

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+
6890
- Refer to **Step 3 Build firmware binaries** in :ref:`Build SOF from Scratch <build-from-scratch>` for reference.
6991

7092
Note that you do not need to modify the audio topology file.
@@ -101,6 +123,7 @@ the last stage of extraction.
101123
- Pause the playback stream. (optional)
102124
- Add probe points via the ``debugfs`` "probe_points" entry in ``/sys/kernel/debug/sof``
103125

126+
104127
For example, to add a buffer with 7 probe points:
105128

106129
.. code-block:: bash
@@ -159,4 +182,14 @@ Usage and ouput:
159182
sof-probes: done
160183
161184
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:
192+
193+
.. code-block:: bash
194+
195+
crecord -c3 -d0 -b8192 -f4 -FS32_LE -R48000 -C4 | sof-probes -l

0 commit comments

Comments
 (0)