Skip to content

doc: api: ipc4: document protocol architecture and integrate all 8 IPC4 subgroups - #541

Merged
lgirdwood merged 1 commit into
thesofproject:masterfrom
lgirdwood:topic/docs-ipc4-reference
Oct 14, 2026
Merged

lgirdwood merged 1 commit into
thesofproject:masterfrom
lgirdwood:topic/docs-ipc4-reference

Conversation

@lgirdwood

Copy link
Copy Markdown
Member

Summary

Overhauls the IPC4 API documentation in api/ipc4.rst with comprehensive protocol architecture documentation, ASCII flow diagrams, and integration of all eight new IPC4 Doxygen subgroups:

  1. ipc4_envelope_api: 64-bit Message Envelope & Handlers
  2. ipc4_format_api: Audio Formats, Pins & Stream Descriptors
  3. ipc4_module_api: Dynamic Modules & Configuration Handshake
  4. ipc4_pipeline_api: Audio Pipelines & Scheduling Priorities
  5. ipc4_base_fw_api: Base Firmware & ADSP Configuration
  6. ipc4_gateway_api: Hardware Gateways & Peripherals
  7. ipc4_notification_api: Asynchronous Notifications & Mailbox Registers
  8. ipc4_telemetry_probe_api: Telemetry, Probes & Logging

Included Protocol Explanations & Diagrams

  • Shared SRAM Mailbox Windows 0 & 1 layout and register mappings.
  • 64-bit Message Envelope (Primary & Extension DWORD bitfields).
  • Hardware Doorbell handshake flow (Host BUSY / DSP DONE).
  • Dynamic audio pipeline construction, module initialization, inter-module binding, and state machine ordering.
  • Multi-chunk Large Configuration protocol sequence.

Verification

…C4 subgroups

Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
@lgirdwood
lgirdwood force-pushed the topic/docs-ipc4-reference branch from df70c2f to 7dcdd8d Compare October 14, 2026 12:35
@lgirdwood
lgirdwood merged commit a2bc554 into thesofproject:master Oct 14, 2026
5 checks passed
@lgirdwood
lgirdwood deleted the topic/docs-ipc4-reference branch October 14, 2026 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants