Skip to content

Commit 5f45198

Browse files
ujfalusilgirdwood
authored andcommitted
developer_guides: debugability: probes: Update for sof client version of probes
The probes got converted to sof client mode, update the documentation to be up to date. Signed-off-by: Peter Ujfalusi <peter.ujfalusi@linux.intel.com>
1 parent 5e7a342 commit 5f45198

File tree

1 file changed

+41
-6
lines changed
  • developer_guides/debugability/probes

1 file changed

+41
-6
lines changed

developer_guides/debugability/probes/index.rst

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,49 @@ Requirements
1717
Enabling Probes
1818
***************
1919

20-
- Enable the following Linux kernel configuration options:
20+
Kernel side
21+
===========
22+
23+
- The probes support is enabled by Kconfig on supported platforms as a SOF client
24+
driver, check the kernel config for ``SND_SOC_SOF_DEBUG_PROBES``.
25+
The debugfs also needs to be enabled for the probes to be usable.
2126

2227
.. code-block:: bash
2328
2429
CONFIG_DEBUG_FS=y
25-
CONFIG_SND_SOC_SOF_DEBUG_PROBES=y
26-
CONFIG_SND_SOC_SOF_HDA_PROBES=y
2730
28-
- Enable the Probe module in the SOF firmware ``kconfig`` using this command:
31+
- The probes client needs to be enabled via the 'enable' module parameter (e.g. ``/etc/modprobe.d/sof.conf``):
32+
33+
.. code-block:: bash
34+
35+
options snd_sof_probes enable=1
36+
37+
To make sure that the sound card for the probes is consistent between boots, a
38+
card slot can be forced for the module.
39+
For example to use card3, this can be added to the sof.conf file:
40+
41+
.. code-block:: bash
42+
43+
options snd slots=,,,snd_sof_probes
44+
45+
Remove and re-load the driver:
46+
47+
.. code-block:: bash
48+
49+
rmmod snd_sof_probes
50+
modprobe snd_sof_probes
51+
52+
Verify that the card is available (if not, try to reboot):
53+
54+
.. code-block:: bash
55+
56+
cat /proc/asound/cards | grep sofprobes
57+
58+
Firmware side
59+
=============
60+
61+
- The Probe module can be enabled under the 'Probe' menu's 'Probes enabled' prompt (``PROBES``)
62+
To edit the ``kconfig`` use this command:
2963

3064
.. code-block:: bash
3165
@@ -49,13 +83,14 @@ the last stage of extraction.
4983

5084
.. code-block:: bash
5185
52-
crecord -c0 -d23 -b8192 -f4 -FS32_LE -R48000 -C4 /tmp/extract.dat
86+
crecord -c3 -d0 -b8192 -f4 -FS32_LE -R48000 -C4 /tmp/extract.dat
5387

5488
Usage:
5589

5690
.. code-block:: none
5791
58-
-d : device ID; equals 23 in the above example.
92+
-c : card number; 3 in the above example if a slot is forced
93+
-d : device ID; equals 0 in the above example (probes card only have 1 compressed capture stream).
5994
-b : buffer size. For probes, this is part of the probe
6095
initialization IPC and denotes the extraction stream buffer size on the host side.
6196
-f : fragments is basically number of periods for compress stream.

0 commit comments

Comments
 (0)