Repository navigation
Conversation
Add function topology description in the README file. Signed-off-by: Bard Liao <yung-chuan.liao@linux.intel.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only addition matches the stated purpose and has only an optional grammar correction.
1 open issue
What changed in this PR
Adds guidance on function topologies to the topology2 README, explaining their shared role across devices with the same audio function.
Changes:
- Defines function topologies and gives examples of supported functions.
- Describes ACPI-based selection by the Linux kernel driver.
- States that function topologies should not contain customized features.
| File | Description |
|---|---|
| tools/topology/topology2/README.md | Documents function topology purpose, selection, and customization constraints. |
Review effort: Balanced
Comment on lines
+388
to
+389
| Function topology provides generic and basic audio feature for a single function. Like headset, | ||
| amp, mic, etc. The Linux kernel driver will select the function topology based on the function |
bardliao
force-pushed
the
function-topology-readme
branch
from
October 23, 2026 06:34
4f70f0f to
72734ca
Compare
kv2019i
reviewed
Oct 23, 2026
| ``` | ||
| ### Function topology | ||
|
|
||
| A function topology provides generic and basic audio path for an individual hardware functio, such |
Collaborator
There was a problem hiding this comment.
Typo: s/functio/function/
| ### Function topology | ||
|
|
||
| A function topology provides generic and basic audio path for an individual hardware functio, such | ||
| asheadset, amplifier or microphone. The Linux kernel driver uses function information exposed by |
Collaborator
There was a problem hiding this comment.
"asheadset" -> "as headset" (probably not "ass headset" :) )
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.
Add function topology description in the README file.