readme: add some initial context around developer tools#10596
Open
lgirdwood wants to merge 8 commits intothesofproject:mainfrom
Open
readme: add some initial context around developer tools#10596lgirdwood wants to merge 8 commits intothesofproject:mainfrom
lgirdwood wants to merge 8 commits intothesofproject:mainfrom
Conversation
High level documentation describing developer and debug tooling. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
lgirdwood
requested review from
abonislawski,
dbaluta,
kv2019i,
lbetlej,
mmaka1 and
plbossart
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Adds initial high-level documentation for SOF developer/debug tooling, plus expands the helper scripts README to better describe common build/test workflows.
Changes:
- Added new README documents for debug subsystems: tester harness, telemetry/perf, GDB stub, and debug_stream.
- Restructured and expanded
scripts/Readme.mdwith clearer script names/options and additional build/testbench guidance.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| src/debug/tester/readme.md | Documents the tester “pseudo-component” and how to enable/extend it. |
| src/debug/telemetry/readme.md | Documents telemetry/performance measurement capabilities and Kconfig toggles. |
| src/debug/gdb/readme.md | Documents the GDB remote debugging stub architecture and usage. |
| src/debug/debug_stream/readme.md | Documents debug_stream purpose, enablement, and host extraction. |
| scripts/Readme.md | Reworks build/tooling/testbench/Docker documentation for developer scripts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Architecture | ||
|
|
||
| The architecture functions identical to an IPC Version 4 standard module, containing `comp_driver`, `comp_dev`, `comp_buffer` wrappers and implementing `tester_params()` handlers. |
There was a problem hiding this comment.
This describes the module as implementing tester_params() handlers, but the implementation uses the module interface callbacks (e.g., .set_configuration = tester_set_configuration) and does not appear to define tester_params(). Update the wording to match the actual entry points used by the tester module.
Member
Author
There was a problem hiding this comment.
@copilot open a new pull request to apply changes based on this feedback
Typo: “I/O Throughout Tracking” should be “I/O Throughput Tracking”. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Liam Girdwood <lgirdwood@gmail.com>
The doc references MEMORY_WIN_2, but that identifier isn’t used anywhere else in this repository (the implementation uses the ADSP debug window slot mechanism via adsp_debug_window.h / ADSP_DW / ADSP_DW_SLOT_DEBUG_STREAM). Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Liam Girdwood <lgirdwood@gmail.com>
The numbered list has two consecutive items labeled “1)”. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Liam Girdwood <lgirdwood@gmail.com>
Minor capitalization: “github upstream” should be “GitHub upstream”. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Liam Girdwood <lgirdwood@gmail.com>
Remove example test password. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Liam Girdwood <lgirdwood@gmail.com>
The phrase “Battering memory allocations arrays” is ungrammatical/unclear. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Liam Girdwood <lgirdwood@gmail.com>
The instructions reference tester.c:tester_set_params, but that function doesn’t exist in src/debug/tester/tester.c (test selection happens in tester_init(), and runtime configuration is handled by tester_set_configuration()). Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Liam Girdwood <lgirdwood@gmail.com>
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.
High level documentation describing developer and debug tooling.