diff --git a/developer_guides/debugability/logger/index.rst b/developer_guides/debugability/logger/index.rst index aadd2608..692fd104 100644 --- a/developer_guides/debugability/logger/index.rst +++ b/developer_guides/debugability/logger/index.rst @@ -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 *************** diff --git a/getting_started/intel_debug/suggestions.rst b/getting_started/intel_debug/suggestions.rst index 7e74a1c2..9b9c9b3c 100644 --- a/getting_started/intel_debug/suggestions.rst +++ b/getting_started/intel_debug/suggestions.rst @@ -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 `__. + Install sof-logger ****************** @@ -128,4 +131,12 @@ following command to extract DSP traces: .. code-block:: bash - sof-logger -t sof-tgl.ldc \ No newline at end of file + 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