Skip to content

topology2: cavs: generic WoV pipeline plumbing fixes #11033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TsaiGaggery wants to merge 2 commits into
base: main
Choose a base branch
from
Open

topology2: cavs: generic WoV pipeline plumbing fixes #11033

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ac7b2c
topology2: cavs: fix WoV pipeline routing
TsaiGaggery Jul 23, 2026
75b2660
topology2: cavs: configure WoV module formats
TsaiGaggery Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions tools/topology/topology2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,31 @@ default ID ranges for the same endpoint types.
> `BT_PCM_ID` override variable to set the correct value when BT coexists with a speaker
> amplifier (which also uses PCM ID 2 by default).
### Wake-on-voice parameters

For a CAVS topology with PCH DMIC enabled and `PASSTHROUGH=false`, set
`INCLUDE_WOV=true` to add the DMIC1, KPB, detector, and drain PCM
pipelines. IPC4 targets must also override `KPB_UUID` with the `kpb4`
UUID registered by their firmware. The class default is the IPC3 KPB
UUID so existing IPC3 users are unchanged.

The detector's module manifest determines its frame and memory settings.
Override these variables together when selecting a detector:

| Variable | Default | Purpose |
|---|---:|---|
| `WOV_FORMAT` | `s32le` | Pipeline sample format |
| `WOV_PCM_FMT` | `S32_LE` | Drain PCM sample format |
| `WOV_BIT_DEPTH` | 32 | Audio container width |
| `WOV_VALID_BIT_DEPTH` | 32 | Valid sample width |
| `WOV_IBS` | 64 | Detector input frame bytes |
| `WOV_OBS` | 64 | Detector output frame bytes |
| `WOV_IS_PAGES` | 0 | Module instance memory pages |
| `WOV_CONTROL_MAX` | 4096 | Maximum bytes-control payload |

The `wov_init` bytes control supports runtime TLV reads and writes. Increase
`WOV_CONTROL_MAX` only when a detector accepts a larger configuration.

**Intel HDA PCM IDs:**

| Endpoint | Default PCM ID | Override Variable |
Expand Down
4 changes: 4 additions & 0 deletions tools/topology/topology2/cavs-sdw.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@
<src.conf>
<io-gateway.conf>
<io-gateway-capture.conf>
<input_pin_binding.conf>
<output_pin_binding.conf>
<dai-kpb-be.conf>
<wov-detect.conf>
<highpass-capture-be.conf>
<data.conf>
<pcm.conf>
Expand Down
9 changes: 7 additions & 2 deletions tools/topology/topology2/include/components/kpb.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@
#
# Where N is the unique instance number for the kpb object within the same alsaconf node.

# Keep the IPC3 UUID as the default. IPC4 topologies must select kpb4 by
# overriding KPB_UUID in the top-level topology.
Define {
KPB_UUID "43:84:21:d8:f3:5f:4c:4a:b3:88:6c:fe:07:b9:56:2e"
}

Class.Widget."kpb" {
#
# Pipeline ID for the kpb object
Expand Down Expand Up @@ -67,8 +73,7 @@ Class.Widget."kpb" {
num_input_audio_formats 1
num_output_audio_formats 1

#UUID: D8218443-5FF3-4A4C-B388-6CFE07B9562E
uuid "43:84:21:d8:f3:5f:4c:4a:b3:88:6c:fe:07:b9:56:2e"
uuid $KPB_UUID
no_pm "true"
cpc 720000
num_input_pins 1
Expand Down
9 changes: 7 additions & 2 deletions tools/topology/topology2/include/components/wov.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@
#
# Where N is the unique instance number for the wov object within the same alsaconf node.

Define {
WOV_CONTROL_MAX 4096
}

Class.Widget."wov" {
#
# Pipeline ID for the wov object
Expand Down Expand Up @@ -72,13 +76,14 @@ Class.Widget."wov" {
name wov_init
access [
tlv_read
tlv_write
tlv_callback
]
Object.Base.extops."extctl" {
get 258
put 0
put 258
}
max 4096
max $WOV_CONTROL_MAX
Object.Base.data."1" {
IncludeByKey.WOV_UUID {
'1f:d5:a8:eb:27:78:b5:47:82:ee:de:6e:77:43:af:67' {bytes "0x53, 0x4f, 0x46, 0x34, 0x02, 0x00, 0x00, 0x00,
Expand Down
24 changes: 10 additions & 14 deletions tools/topology/topology2/include/pipelines/cavs/dai-kpb-be.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,14 @@ Class.Pipeline."dai-kpb-be" {
Object.Base.input_audio_format [
{
in_rate 16000
in_bit_depth 32
in_valid_bit_depth 32
in_bit_depth $WOV_BIT_DEPTH
in_valid_bit_depth $WOV_VALID_BIT_DEPTH
}
{
in_rate 16000
in_channels 4
in_bit_depth 32
in_valid_bit_depth 32
in_bit_depth $WOV_BIT_DEPTH
in_valid_bit_depth $WOV_VALID_BIT_DEPTH
in_ch_cfg $CHANNEL_CONFIG_3_POINT_1
in_ch_map $CHANNEL_MAP_3_POINT_1
}
Expand All @@ -105,14 +105,14 @@ Class.Pipeline."dai-kpb-be" {
Object.Base.output_audio_format [
{
out_rate 16000
out_bit_depth 32
out_valid_bit_depth 32
out_bit_depth $WOV_BIT_DEPTH
out_valid_bit_depth $WOV_VALID_BIT_DEPTH
}
{
out_rate 16000
out_channels 4
out_bit_depth 32
out_valid_bit_depth 32
out_bit_depth $WOV_BIT_DEPTH
out_valid_bit_depth $WOV_VALID_BIT_DEPTH
out_ch_cfg $CHANNEL_CONFIG_3_POINT_1
out_ch_map $CHANNEL_MAP_3_POINT_1
}
Expand All @@ -125,12 +125,8 @@ Class.Pipeline."dai-kpb-be" {
}
}

Object.Base {
route."1" {
source "dai-copier.DMIC.$index.1"
sink "kpb.$index.1"
}
}
# DAI copier names contain the stream name instead of the pipeline
# index. The instantiating topology must provide the route to KPB.

time_domain "timer"
dynamic_pipeline 1
Expand Down
18 changes: 10 additions & 8 deletions tools/topology/topology2/include/pipelines/cavs/wov-detect.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ Class.Pipeline."wov-detect" {
in_channels 2
in_ch_map $CHANNEL_MAP_STEREO
in_ch_cfg 1
in_bit_depth 32
in_valid_bit_depth 32
in_bit_depth $WOV_BIT_DEPTH
in_valid_bit_depth $WOV_VALID_BIT_DEPTH
}
]
Object.Base.output_audio_format [
Expand All @@ -74,8 +74,8 @@ Class.Pipeline."wov-detect" {
out_channels 1
out_ch_map $CHANNEL_MAP_MONO
out_ch_cfg 0
out_bit_depth 32
out_valid_bit_depth 32
out_bit_depth $WOV_BIT_DEPTH
out_valid_bit_depth $WOV_VALID_BIT_DEPTH
}
]
}
Expand All @@ -89,16 +89,18 @@ Class.Pipeline."wov-detect" {
in_channels 1
in_ch_cfg 0
in_ch_map $CHANNEL_MAP_MONO
in_bit_depth 32
in_valid_bit_depth 32
in_bit_depth $WOV_BIT_DEPTH
in_valid_bit_depth $WOV_VALID_BIT_DEPTH
ibs $WOV_IBS
}
]
Object.Base.output_audio_format [
{
out_rate 16000
out_channels 1
out_bit_depth 32
out_valid_bit_depth 32
out_bit_depth $WOV_BIT_DEPTH
out_valid_bit_depth $WOV_VALID_BIT_DEPTH
obs $WOV_OBS
}
]
}
Expand Down
12 changes: 7 additions & 5 deletions tools/topology/topology2/platform/intel/dmic-default.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,17 @@ Define {
DMIC1_HOST_PIPELINE_ID 18
DMIC1_DAI_PIPELINE_ID 19
WOV_PIPELINE_ID 20
DMIC1_HOST_PIPELINE_SINK 'copier.host.18.1'
DMIC_WOV_DAI_PIPELINE_SRC 'dai-copier.DMIC.dmic16k.capture'
DMIC_WOV_DAI_PIPELINE_KPB 'kpb.19.1'
WOV_PIPELINE_SINK 'micsel.20.1'
WOV_PIPELINE_VIRTUAL 'virtual.detect_sink'
INCLUDE_WOV 'false'
# The UUID corresponds to the test detect component
WOV_UUID '1f:d5:a8:eb:27:78:b5:47:82:ee:de:6e:77:43:af:67'
WOV_CPC '360000'
WOV_FORMAT s32le
WOV_PCM_FMT 'S32_LE'
WOV_BIT_DEPTH 32
WOV_VALID_BIT_DEPTH 32
WOV_IBS 64
WOV_OBS 64
WOV_IS_PAGES 0
DMIC1_PCM_CAPS 'Passthrough Capture 18'
DMIC_CORE_ID 0
PASSTHROUGH "false"
Expand Down
Loading
Loading