docs: developer_guides: add ALSA Use Case Manager v2 (UCM2) guide and runbook - #536
Merged
lgirdwood merged 1 commit intoSep 21, 2026
Merged
Conversation
lgirdwood
requested review from
deb-intel,
intelkevinputnam,
mmaka1 and
mwasko
as code owners
September 21, 2026 07:16
… runbook Add a comprehensive developer guide and practical runbook for ALSA Use Case Manager v2 (UCM2) under Pillar 3 of Developer Guides. Topics covered: - Architectural role of UCM2 in bridging kernel mixer controls/PCMs to user-space sound servers (PipeWire, WirePlumber, PulseAudio). - Evolution from legacy UCM1 to UCM2 comparison matrix. - Directory hierarchy, lookup precedence, and dynamic CardComponents hardware variant parsing via DefineRegex and If conditions. - UCM2 syntax specification (syntax versions 2 through 7), core primitives (SectionUseCase, SectionVerb, SectionDevice, Value blocks), and transition sequences. - Step-by-step authoring walkthrough: hardware enumeration, manual ALSA CLI bringup, card master entry, HiFi verb definition, and codec/HDMI modularization. - PipeWire/WirePlumber SPA-ACP engine integration and priority arbitration. - In-depth diagnostic runbooks for dummy output fallback, muted routing, jack detection failures, and live in-system hot-reloading. - Production readiness checklist and high-resolution architecture diagram. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
lgirdwood
force-pushed
the
topic/ucm2-developer-guide
branch
from
September 21, 2026 07:20
ab09d66 to
55446f5
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
2 participants
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
Adds an authoritative developer guide and practical runbook for ALSA Use Case Manager v2 (UCM2) under Pillar 3 of Developer Guides.
Highlights
${CardComponents}exported by kernel machine drivers.SectionUseCase,SectionVerb,SectionDevice, and theValueblock reference table.ucm2_architecture_flow.svg) detailing the 4-tier audio stack and 6-step CLI diagnostic track.Signed-off-by: Liam Girdwood liam.r.girdwood@linux.intel.com