Repository navigation
doc: api: add telemetry, logging, probes, and debug streams reference page - #542
Merged
lgirdwood merged 1 commit intoOct 15, 2026
Merged
Conversation
lgirdwood
requested review from
deb-intel,
intelkevinputnam,
mmaka1 and
mwasko
as code owners
October 15, 2026 16:42
… page Add dedicated Telemetry, Logging & Probes C API reference page (api/telemetry.rst) and integrate into api/index.rst. Highlights: - Document multi-tiered telemetry, logging, audio probes, and debug streams architecture. - Add ASCII flow diagrams for DSP firmware trace pipeline, audio probe tap points, and shared SRAM mailbox memory windows (Window 0-3). - Integrate Breathe Doxygen groups: - trace_logging_api (Host DMA Tracing & Dictionary Logging) - audio_probe_api (Audio Probes & Stream Tap Points) - telemetry_perf_api (Hardware Telemetry & Performance Monitoring) - debug_stream_api (Abstract Debug Streams & Low-Level Debugging) Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
lgirdwood
force-pushed
the
topic/docs-telemetry-reference
branch
from
October 15, 2026 18:16
f451c5c to
85779f5
Compare
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
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.
Summary
Add a dedicated Telemetry, Logging & Probes C API reference page (
api/telemetry.rst) and integrate it intoapi/index.rst.Architecture & Overview
SOF features a multi-tiered diagnostic and telemetry subsystem. This PR documents the four architectural domains and integrates their Doxygen API definitions via Breathe:
trace_logging_api):dma-trace.h), runtime logging filters and dictionary encoder (trace-soflogger.h), boot checkpoint codes (trace-boot.h), and panic crash dumps (ipc/trace.h).audio_probe_api):probe/probe.h), extraction frame format framing (0xBABEBEBA,ipc/probe_dma_frame.h), and IPC commands (ipc3/probe.h).telemetry_perf_api):telemetry.h), Memory Window 3 Performance Measurement Window (WIN3_MBASE,ADSP_PMW,performance_monitor.h), and SRAM Window 0 firmware status registers (kernel/mailbox.h).debug_stream_api):DEBUG_STREAM_IDENTIFIER 0x1ED15EED,user/debug_stream.h), Memory Window 2 debug slots (user/debug_stream_slot.h), text debug messages (user/debug_stream_text_msg.h), and GDB target stub (sof/debug/gdb/gdb.h).Diagrams Included
Verification
SPHINXOPTS="-W --keep-going" make htmlwith 0 errors and 0 warnings.