readme: add high level detail around IPC#10592
Conversation
There was a problem hiding this comment.
Pull request overview
Adds new high-level documentation for the IPC core layer plus separate architecture overviews for IPC3 and IPC4, intended to help readers understand how mailbox interrupts are routed and how protocol-specific handlers process messages.
Changes:
- Added
src/ipc/readme.mddescribing the core IPC layer responsibilities and processing flows. - Added
src/ipc/ipc3/readme.mddocumenting IPC3 command routing and example flows. - Added
src/ipc/ipc4/readme.mddocumenting IPC4 dispatch, pipeline state handling, module binding, and compound messages.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 11 comments.
| File | Description |
|---|---|
| src/ipc/readme.md | New core IPC architecture/flow documentation with diagrams and helper object notes. |
| src/ipc/ipc4/readme.md | New IPC4-specific overview covering dispatch, pipelines, binding, and compound messaging. |
| src/ipc/ipc3/readme.md | New IPC3-specific overview covering command routing, stream trigger, DAI config, and mailbox validation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```mermaid | ||
| graph TD | ||
| Platform[Platform / Mailbox HW] -->|IRQ| CoreIPC[Core IPC Framework] | ||
|
|
||
| subgraph CoreIPC [src/ipc/ipc-common.c] | ||
| Queue[Msg Queue / Worker Task] | ||
| Dispatcher[IPC Message Dispatcher] | ||
| PM[Power Management Wait/Wake] | ||
|
|
||
| Queue --> Dispatcher | ||
| Dispatcher --> PM | ||
| end | ||
|
|
||
| Dispatcher -->|Version Specific Parsing| IPC3[IPC3 Handler] | ||
| Dispatcher -->|Version Specific Parsing| IPC4[IPC4 Handler] | ||
|
|
||
| IPC3 -.-> CoreIPC | ||
| IPC4 -.-> CoreIPC | ||
| CoreIPC -.->|Ack| Platform | ||
| ``` |
There was a problem hiding this comment.
This graph doesn't render nicely. It seems to be missing connections. I know this comment is not very precise, but for me this graph is unreadable.
There was a problem hiding this comment.
Does this link render in your browser. Its rendering for me in Chrome, Antigravity and vscode.
There was a problem hiding this comment.
The graph renders, I'm using the "rich diff" function for preview. The preview looks the same when I use https://mermaid.live/
I think it renders strangely because connections to individual IPC3/4 versions run from "Dispatcher", and the return path to "CoreIPC" within which "Dispatcher" is located.
In the graph I also don't understand why one path from "Dispatcher" leads to "PM". If this is about IPC related to power management such as SetDx, SetD0iX etc, these are handled under specific IPC3/4 variants.
lgirdwood
force-pushed
the
readme-ipc
branch
2 times, most recently
from
049fb6c to
cdb4ea3
Compare
| ```mermaid | ||
| graph TD | ||
| Platform[Platform / Mailbox HW] -->|IRQ| CoreIPC[Core IPC Framework] | ||
|
|
||
| subgraph CoreIPC [src/ipc/ipc-common.c] | ||
| Queue[Msg Queue / Worker Task] | ||
| Dispatcher[IPC Message Dispatcher] | ||
| PM[Power Management Wait/Wake] | ||
|
|
||
| Queue --> Dispatcher | ||
| Dispatcher --> PM | ||
| end | ||
|
|
||
| Dispatcher -->|Version Specific Parsing| IPC3[IPC3 Handler] | ||
| Dispatcher -->|Version Specific Parsing| IPC4[IPC4 Handler] | ||
|
|
||
| IPC3 -.-> CoreIPC | ||
| IPC4 -.-> CoreIPC | ||
| CoreIPC -.->|Ack| Platform | ||
| ``` |
There was a problem hiding this comment.
The graph renders, I'm using the "rich diff" function for preview. The preview looks the same when I use https://mermaid.live/
I think it renders strangely because connections to individual IPC3/4 versions run from "Dispatcher", and the return path to "CoreIPC" within which "Dispatcher" is located.
In the graph I also don't understand why one path from "Dispatcher" leads to "PM". If this is about IPC related to power management such as SetDx, SetD0iX etc, these are handled under specific IPC3/4 variants.
src/ipc/ipc4/README.md
Outdated
| graph TD | ||
| Mailbox[IPC Mailbox Interrupt] --> CoreIPC[ipc_cmd] | ||
|
|
||
| CoreIPC --> TypeSel[Decode IPC Message Target] |
There was a problem hiding this comment.
This is a good place for decision block (with diamond shape), I would also change the name (shorter description).
TypeSel{Decode IPC Message Target}
High level information about how IPC works and some specifics for IPC3 and IPC4 protocols. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
|
Not tested by CI. |
|
All review comments fixed. |
High level information about how IPC works and some specifics for IPC3 and IPC4 protocols.