Conversation
Replace references to the sof-logger and smex tools with documentation for mtrace-reader.py. Highlight that SOF uses the Zephyr logging subsystem and that any Zephyr backend can be used to transport logs; mtrace-reader.py is the Intel ADSP-specific backend, while other hardware platforms use their own logging mechanisms. Document how to acquire mtrace-reader.py from the SOF main repository (tools/mtrace/mtrace-reader.py), how to run it locally and on a remote DUT over SSH, and how to enable the mtrace backend via the snd_sof kernel module parameter sof_debug=SOF_DBG_ENABLE_TRACE (0x1). Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
Remove references to sof-logger and smex from the DSP telemetry architecture diagram. These are only used in older SOF releases. Update the subtitle and section titles to reflect the Zephyr logging subsystem and mtrace backend, which are the most common tools used with new SOF releases. Replace the smex card with a generic build-time metadata extraction description, and replace the sof-logger decoder card with mtrace-reader.py for Intel ADSP, including the sof_debug=1 modprobe enable step. Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
Replace the build-time Log Dictionary Catalog (.ldc) description with a reference to the Zephyr logging dictionary (log_dictionary.json). Clarify that the dictionary is optional and is not required for basic log streaming with mtrace-reader.py. Point to the Zephyr documentation for details on dictionary-based logging. Update the architecture SVG accordingly. Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
Update sof_bin_releases.json to match latest release. Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
kv2019i
requested review from
deb-intel,
intelkevinputnam,
lgirdwood,
mmaka1 and
mwasko
as code owners
September 28, 2026 10:36
kv2019i
commented
Sep 28, 2026
| "asset_url": "https://github.com/thesofproject/sof-bin/releases/download/v2024.06/sof-bin-2024.06.tar.gz", | ||
| "asset_size_mb": 9.4, | ||
| "prerelease": false | ||
| } |
Contributor
Author
There was a problem hiding this comment.
@lgirdwood not sure why the new automation removes v2024.06 , but this is result of running the build now, so committing whatever the script updates.
This branch has not been deployed
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.
SOF's logging relies on Zephyr logging subsystem and the backend details (mtrace is just one), dictionary (multiple solutions) will depend on build options, platforms and are typically well documented in Zephyr (or platform specific documentation).
Modify the SOF docs to be more generic, refer to Zephyr and add brief examples on how to use mtrace-reader.py as that is the primary logging solution for all modern Intel ADSPs.