Skip to content

Update some debugging information #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lgirdwood merged 3 commits into from
Jun 11, 2021
Merged

Update some debugging information #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6740a97
debugability: logger: Add note for etrace and trace debugfs files
ujfalusi May 31, 2021
664da17
intel_debug: Add link to dynamic debug documentation of the Linux kernel
ujfalusi May 31, 2021
b44a2e5
intel_debug: Add instruction to enable the trace debugfs
ujfalusi May 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions developer_guides/debugability/logger/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,14 @@ Examples
sof-logger -l ldc_file -d


.. note::
debugfs files used by ``sof-logger``

- ``etrace``: direct access to the shared TRACE window of the SOF firmware
- ``trace``: using DMA to stream debug trace information from SOF firmware (on
distribution kernels ``sof_debug=1`` module option for ``snd_sof`` might be
needed if the /sys/kernel/debug/sof/trace file is not present)

Trace filtering
***************

Expand Down
13 changes: 12 additions & 1 deletion getting_started/intel_debug/suggestions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,9 @@ file:

Note that this list is only an example.

Dynamic debug is a Linux kernel feature. For detailed information, see the
official `kernel documentation <https://www.kernel.org/doc/html/latest/admin-guide/dynamic-debug-howto.html>`__.

Install sof-logger
******************

Expand All @@ -128,4 +131,12 @@ following command to extract DSP traces:

.. code-block:: bash

sof-logger -t sof-tgl.ldc
sof-logger -t -l sof-tgl.ldc

Trace support might need to be enabled on distribution kernels in case the
``/sys/kernel/debug/sof/trace`` file is not present by adding sof_debug=1 option
to snd_sof module:

.. code-block::

options snd_sof sof_debug=1