docs: probes: document sofprobeclient and auto-enable logging - #521
Open
jsarha wants to merge 1 commit into
Open
docs: probes: document sofprobeclient and auto-enable logging#521jsarha wants to merge 1 commit into
jsarha wants to merge 1 commit into
Conversation
Update the probes documentation with two new features: 1. sofprobeclient (tinycompress >= 1.2.16): a dedicated SOF probes client that replaces the crecord + sof-probes workflow with a single command. It captures compressed probe data, parses it in real time, prints log output to stdout, and writes audio probe data to buffer_<id>.wav files. Document its usage, command-line options, and auto-close / non-overwrite behavior. 2. CONFIG_LOG_BACKEND_SOF_PROBE_OUTPUT_AUTO_ENABLE: a SOF firmware Kconfig option that automatically enables log output when probes DMA starts, removing the need to manually set the logging probe point after every boot. The existing crecord-based workflow is preserved as a 'legacy' alternative throughout. Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>
jsarha
requested review from
deb-intel,
intelkevinputnam,
lgirdwood,
mmaka1 and
mwasko
as code owners
July 30, 2026 16:56
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update the probes documentation with two new features:
sofprobeclient (tinycompress >= 1.2.16): a dedicated SOF probes client that replaces the crecord + sof-probes workflow with a single command. It captures compressed probe data, parses it in real time, prints log output to stdout, and writes audio probe data to buffer_.wav files. Document its usage, command-line options, and auto-close / non-overwrite behavior.
CONFIG_LOG_BACKEND_SOF_PROBE_OUTPUT_AUTO_ENABLE: a SOF firmware Kconfig option that automatically enables log output when probes DMA starts, removing the need to manually set the logging probe point after every boot.
The existing crecord-based workflow is preserved as a 'legacy' alternative throughout.