diff --git a/app/boards/intel_adsp_cavs25.conf b/app/boards/intel_adsp_cavs25.conf index 7cd938ec7ff8..e4aa9bc5ff50 100644 --- a/app/boards/intel_adsp_cavs25.conf +++ b/app/boards/intel_adsp_cavs25.conf @@ -11,6 +11,11 @@ CONFIG_COMP_DRC=y CONFIG_COMP_MFCC=y CONFIG_COMP_MULTIBAND_DRC=y CONFIG_COMP_VOLUME_WINDOWS_FADE=y +CONFIG_COMP_WOV_ARBITER=y +CONFIG_COMP_VAD_GATE=y +CONFIG_COMP_KPB=y +CONFIG_SAMPLES=y +CONFIG_SAMPLE_KEYPHRASE=y CONFIG_FORMAT_CONVERT_HIFI3=n CONFIG_PCM_CONVERTER_FORMAT_S16LE=y CONFIG_PCM_CONVERTER_FORMAT_S24LE=y diff --git a/app/debug_overlay.conf b/app/debug_overlay.conf index e99910ebfff1..a6f8855d5011 100644 --- a/app/debug_overlay.conf +++ b/app/debug_overlay.conf @@ -31,3 +31,8 @@ CONFIG_GDBSTUB_ENTER_IMMEDIATELY=n # Testing with runtime filtering enabled ensures the same feature set is validated. # Note: This setting has no effect if CONFIG_LOG_RUNTIME_FILTERING is disabled. CONFIG_LOG_RUNTIME_DEFAULT_LEVEL=3 + +# Record fatal exception breadcrumbs (PC/cause/vaddr) in HP-SRAM window0 so the +# crash is visible in the host dmesg "Firmware state" line when no console or +# mtrace output is available. +CONFIG_XTENSA_ADSP_FATAL_BREADCRUMB=y diff --git a/app/prj.conf b/app/prj.conf index 5c22e19d6e0e..35b404ec92ce 100644 --- a/app/prj.conf +++ b/app/prj.conf @@ -49,3 +49,5 @@ CONFIG_SCHED_CPU_MASK=y CONFIG_SYS_CLOCK_TICKS_PER_SEC=15000 CONFIG_DAI=y CONFIG_HEAP_MEM_POOL_SIZE=2048 +CONFIG_SAMPLES=y +CONFIG_SAMPLE_KEYPHRASE=y diff --git a/src/audio/CMakeLists.txt b/src/audio/CMakeLists.txt index 92002c8b7c1c..9e63311f9eaf 100644 --- a/src/audio/CMakeLists.txt +++ b/src/audio/CMakeLists.txt @@ -104,9 +104,15 @@ if(NOT CONFIG_COMP_MODULE_SHARED_LIBRARY_BUILD) if(CONFIG_COMP_UP_DOWN_MIXER) add_subdirectory(up_down_mixer) endif() + if(CONFIG_COMP_VAD_GATE) + add_subdirectory(vad_gate) + endif() if(CONFIG_COMP_VOLUME) add_subdirectory(volume) endif() + if(CONFIG_COMP_WOV_ARBITER) + add_subdirectory(wov_arbiter) + endif() if(CONFIG_DTS_CODEC) add_subdirectory(codec) endif() diff --git a/src/audio/Kconfig b/src/audio/Kconfig index 8accb25738a2..b05fd8a55df1 100644 --- a/src/audio/Kconfig +++ b/src/audio/Kconfig @@ -102,6 +102,18 @@ config COMP_STUBS Select to force all 3P blocks to link against stubs rather than their libraries. This should only be used in testing environments like fuzzers or CI. +config COMP_WOV_ARBITER + bool "WOV arbiter component" + depends on COMP_KPB + depends on IPC_MAJOR_4 + select AMS + help + Select to build the WOV (Wake-on-Voice) arbiter. The arbiter sits + between multiple KPB host-drain outputs and a single host PCM copier. + When a keyword is detected by one of the WOV detectors the arbiter + routes that KPB's drain stream to the host and instructs the remaining + detectors to pause. + config COMP_KPB bool "KPB component" default y @@ -160,6 +172,7 @@ rsource "template/Kconfig" rsource "tensorflow/Kconfig" rsource "tone/Kconfig" rsource "up_down_mixer/Kconfig" +rsource "vad_gate/Kconfig" rsource "volume/Kconfig" # --- End Kconfig Sources (alphabetical order) --- diff --git a/src/audio/kpb.c b/src/audio/kpb.c index 2cec91393517..7c45817c03f4 100644 --- a/src/audio/kpb.c +++ b/src/audio/kpb.c @@ -18,10 +18,14 @@ #include #include #include +#define SOF_MODULE_API_PRIVATE +#include +#include #include #include #include #include +#include #include #include #include @@ -369,6 +373,9 @@ static int kpb_bind(struct comp_dev *dev, struct bind_info *bind_data) sink_buf_id = buf_get_id(sink); if (sink_buf_id == buf_id) { + struct comp_dev *sc = comp_buffer_get_sink_component(sink); + comp_err(dev, "kpb_bind: buf_id=%d sink_comp=0x%x -> %s", + buf_id, sc ? dev_comp_id(sc) : 0, sink_buf_id == 0 ? "sel_sink" : "host_sink"); if (sink_buf_id == 0) kpb->sel_sink = sink; else @@ -887,6 +894,38 @@ static int kpb_prepare(struct comp_dev *dev) return -ENOMEM; } + struct comp_buffer *sink; + comp_dev_for_each_consumer(dev, sink) { + struct comp_dev *sc = comp_buffer_get_sink_component(sink); + if (sc) { + comp_err(dev, "kpb consumer in bsink_list: comp_id=0x%x type=%d sink_buf=%p", + dev_comp_id(sc), sc->drv ? sc->drv->type : -1, sink); + if (dev_comp_id(sc) != 0x10) + kpb->sel_sink = sink; + else + kpb->host_sink = sink; + } + } + comp_err(dev, "kpb_params result: sel_sink=%p host_sink=%p", + kpb->sel_sink, kpb->host_sink); + + if (kpb->sel_sink) { + struct comp_dev *sink_comp = comp_buffer_get_sink_component(kpb->sel_sink); + if (sink_comp && sink_comp->state == COMP_STATE_INIT) { + struct sof_ipc_stream_params sink_params; + memset_s(&sink_params, sizeof(sink_params), 0, sizeof(sink_params)); + sink_params.channels = kpb->config.channels ? kpb->config.channels : 2; + sink_params.rate = kpb->config.sampling_freq ? kpb->config.sampling_freq : 16000; + sink_params.sample_container_bytes = 4; + sink_params.sample_valid_bytes = 4; + sink_params.frame_fmt = SOF_IPC_FRAME_S32_LE; + comp_params(sink_comp, &sink_params); + comp_prepare(sink_comp); + } + } + + kpb_change_state(kpb, KPB_STATE_RUN); + #ifndef CONFIG_IPC_MAJOR_4 /* Search for KPB related sinks. * NOTE! We assume here that channel selector component device @@ -936,10 +975,36 @@ static int kpb_prepare(struct comp_dev *dev) } #endif /* CONFIG_IPC_MAJOR_4 */ + if (!kpb->sel_sink || !kpb->host_sink) { + struct comp_buffer *sink; + + comp_dev_for_each_consumer(dev, sink) { + if (!kpb->sel_sink) + kpb->sel_sink = sink; + else if (!kpb->host_sink) + kpb->host_sink = sink; + } + } + if (!kpb->sel_sink) { comp_err(dev, "could not find sink: sel_sink %p", kpb->sel_sink); ret = -EIO; + } else { + struct comp_dev *sink_comp = comp_buffer_get_sink_component(kpb->sel_sink); + if (sink_comp && sink_comp->state == COMP_STATE_INIT) { + struct sof_ipc_stream_params sink_params; + memset_s(&sink_params, sizeof(sink_params), 0, sizeof(sink_params)); + sink_params.channels = kpb->config.channels ? kpb->config.channels : 2; + sink_params.rate = kpb->config.sampling_freq ? kpb->config.sampling_freq : 16000; + sink_params.sample_container_bytes = 4; + sink_params.sample_valid_bytes = 4; + sink_params.frame_fmt = SOF_IPC_FRAME_S32_LE; + comp_params(sink_comp, &sink_params); + comp_prepare(sink_comp); + comp_info(dev, "kpb_prepare: prepared downstream sink_comp %d in state %d", + dev_comp_id(sink_comp), sink_comp->state); + } } kpb->sync_draining_mode = true; @@ -1234,19 +1299,16 @@ static int kpb_copy(struct comp_dev *dev) sink = kpb->sel_sink; ret = PPL_STATUS_PATH_STOP; + comp_err(dev, "kpb_copy: source_buf=%p sel_sink=%p avail=%u", + source, sink, audio_stream_get_avail_bytes(&source->stream)); + if (!sink) { comp_err(dev, "no sink."); ret = -EINVAL; break; } - /* Discard data if sink is not active */ - if (comp_buffer_get_sink_component(sink)->state != COMP_STATE_ACTIVE) { - copy_bytes = audio_stream_get_avail_bytes(&source->stream); - comp_update_buffer_consume(source, copy_bytes); - comp_dbg(dev, "KD not active, dropping %zu bytes...", copy_bytes); - break; - } + /* Allow downstream WOV detector copy regardless of state */ /* Validate sink */ if (!audio_stream_get_wptr(&sink->stream)) { @@ -1313,6 +1375,15 @@ static int kpb_copy(struct comp_dev *dev) else comp_update_buffer_produce(sink, produced_bytes); + struct comp_dev *wov_comp = sink ? comp_buffer_get_sink_component(sink) : NULL; + if (wov_comp) { + comp_err(dev, "kpb_copy: produced=%u bytes, triggering wov=0x%x", + copy_bytes, dev_comp_id(wov_comp)); + comp_copy(wov_comp); + } else { + comp_err(dev, "kpb_copy: downstream sink_comp returned NULL!"); + } + comp_update_buffer_consume(source, copy_bytes); break; diff --git a/src/audio/kpb.toml b/src/audio/kpb.toml index e384632c1be8..2de8ef17aa80 100644 --- a/src/audio/kpb.toml +++ b/src/audio/kpb.toml @@ -2,7 +2,7 @@ name = "KPB" uuid = UUIDREG_STR_KPB4 affinity_mask = "0x1" - instance_count = "1" + instance_count = "4" domain_types = "0" load_type = "0" module_type = "0xB" diff --git a/src/audio/mixin_mixout/mixin_mixout.c b/src/audio/mixin_mixout/mixin_mixout.c index 839f0eea8e17..5868e3ec90bf 100644 --- a/src/audio/mixin_mixout/mixin_mixout.c +++ b/src/audio/mixin_mixout/mixin_mixout.c @@ -4,6 +4,7 @@ #include #include +#include #include #include #include @@ -309,7 +310,9 @@ static int mixin_process(struct processing_module *mod, int i, ret; struct cir_buf_ptr source_ptr; - comp_dbg(dev, "entry"); + source_avail_frames = source_get_data_frames_available(sources[0]); + comp_err(dev, "mixin_process entry: num_sinks=%d sources=%d avail=%u", + num_of_sinks, num_of_sources, source_avail_frames); source_avail_frames = source_get_data_frames_available(sources[0]); sinks_free_frames = INT32_MAX; @@ -342,14 +345,8 @@ static int mixin_process(struct processing_module *mod, unused_in_between_buf = comp_buffer_get_from_sink(sinks[i]); mixout = comp_buffer_get_sink_component(unused_in_between_buf); - /* Skip non-active mixout like it is not connected so it does not - * block other possibly connected mixouts. In addition, non-active - * mixouts might have their sink buffer/interface not yet configured. - */ - if (mixout->state != COMP_STATE_ACTIVE) { - active_mixouts[i] = NULL; - continue; - } + if (mixout->state != COMP_STATE_ACTIVE) + mixout->state = COMP_STATE_ACTIVE; mixout_mod = comp_mod(mixout); active_mixouts[i] = mixout_mod; @@ -394,8 +391,10 @@ static int mixin_process(struct processing_module *mod, sinks_free_frames = MIN(sinks_free_frames, free_frames - pending_frames->frames); } - if (sinks_free_frames == 0 || sinks_free_frames == INT32_MAX) + if (sinks_free_frames == 0 || sinks_free_frames == INT32_MAX) { + comp_err(dev, "mixin_process early return 0: sinks_free=%u", sinks_free_frames); return 0; + } #if CONFIG_XRUN_NOTIFICATIONS_ENABLE frame_bytes = source_get_frame_bytes(sources[0]); @@ -502,6 +501,9 @@ static int mixin_process(struct processing_module *mod, if (frames_to_copy + start_frame > mixout_data->mixed_frames) mixout_data->mixed_frames = frames_to_copy + start_frame; + + if (mixout_mod && mixout_mod->dev) + comp_copy(mixout_mod->dev); } if (bytes_to_consume) @@ -596,6 +598,18 @@ static int mixout_process(struct processing_module *mod, sink_commit_buffer(sinks[0], bytes_to_produce); md->acquired_buf.ptr = NULL; + if (bytes_to_produce > 0) { + struct comp_buffer *sink_buf = comp_buffer_get_from_sink(sinks[0]); + if (sink_buf && comp_buffer_get_sink_component(sink_buf)) { + struct comp_dev *sink_comp = comp_buffer_get_sink_component(sink_buf); + comp_err(dev, "mixout_process: sink_buf=0x%x produced=%u bytes, triggering kpb=0x%x", + sink_buf, bytes_to_produce, dev_comp_id(sink_comp)); + comp_copy(sink_comp); + } else { + comp_err(dev, "mixout_process: produced=%u bytes, BUT sink_buf/comp NULL", bytes_to_produce); + } + } + return 0; } diff --git a/src/audio/vad_gate/CMakeLists.txt b/src/audio/vad_gate/CMakeLists.txt new file mode 100644 index 000000000000..6c896ad86096 --- /dev/null +++ b/src/audio/vad_gate/CMakeLists.txt @@ -0,0 +1,2 @@ +# SPDX-License-Identifier: BSD-3-Clause +add_local_sources(sof vad_gate.c) diff --git a/src/audio/vad_gate/Kconfig b/src/audio/vad_gate/Kconfig new file mode 100644 index 000000000000..dcc7bf58185e --- /dev/null +++ b/src/audio/vad_gate/Kconfig @@ -0,0 +1,12 @@ +# SPDX-License-Identifier: BSD-3-Clause + +config COMP_VAD_GATE + bool "VAD gate component" + depends on IPC_MAJOR_4 + help + Select to build the VAD (Voice Activity Detection) gate component. + The gate sits between the DMIC copier and the downstream Mixin in + a WOV capture pipeline. During silence it drains the DMIC input + and returns PPL_STATUS_PATH_STOP so KPB and WOV detectors idle. + When voice onset is detected audio flows through and the downstream + chain wakes and begins buffering. diff --git a/src/audio/vad_gate/vad_gate.c b/src/audio/vad_gate/vad_gate.c new file mode 100644 index 000000000000..f5a362fd575e --- /dev/null +++ b/src/audio/vad_gate/vad_gate.c @@ -0,0 +1,344 @@ +// SPDX-License-Identifier: BSD-3-Clause +// +// Copyright(c) 2024 Intel Corporation. All rights reserved. +// +// VAD Gate — lightweight voice-activity detector placed between the DMIC +// copier and the downstream Mixin in a WOV pipeline. +// +// When the detected energy stays below the threshold for hangover_frames +// consecutive frames (silence), the gate drains its input but returns +// PPL_STATUS_PATH_STOP so the Mixin/KPB/WOV pipelines downstream do not +// run. When voice is detected (onset_frames consecutive frames above the +// threshold) the gate passes audio through and the downstream chain wakes. +// +// Energy estimator: first-order IIR on the peak |sample| amplitude per +// processing period; same pattern as detect_test.c's activation tracker. + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#if CONFIG_IPC_MAJOR_4 +#include +#endif +#include +#include +#include +#include +#include +#include + +LOG_MODULE_REGISTER(vad_gate, CONFIG_SOF_LOG_LEVEL); + +SOF_DEFINE_REG_UUID(vad_gate); +DECLARE_TR_CTX(vad_gate_tr, SOF_UUID(vad_gate_uuid), LOG_LEVEL_INFO); + +/* Private runtime data. */ +struct vad_gate_data { +#if CONFIG_IPC_MAJOR_4 + struct ipc4_base_module_cfg base_cfg; +#endif + struct ipc4_vad_gate_config config; + + /* IIR energy accumulator (same units as S32LE sample amplitude). */ + int32_t energy; + + /* Debounce counters. */ + uint16_t speech_cnt; + uint16_t silence_cnt; + + bool vad_active; +}; + +/* ------------------------------------------------------------------------- + * Energy estimation and VAD state machine + * ---------------------------------------------------------------------- */ + +/* Per-period energy update; assumes single-channel S32LE (mono DMIC capture). */ +static void vad_update_energy(struct comp_dev *dev, + struct audio_stream *s, uint32_t frames) +{ + struct vad_gate_data *cd = comp_get_drvdata(dev); + uint32_t i; + bool above; + + for (i = 0; i < frames; i++) { + const int32_t *src = audio_stream_read_frag_s32(s, i); + int32_t diff = abs(*src) - abs(cd->energy); + cd->energy += diff >> cd->config.energy_shift; + } + + static uint32_t log_cnt = 0; + if (++log_cnt % 100 == 0) { + comp_info(dev, "vad_gate: energy=%d threshold=%d active=%d speech_cnt=%u", + cd->energy, cd->config.threshold, cd->vad_active, cd->speech_cnt); + } + + above = (cd->energy >= cd->config.threshold); + if (above) { + cd->silence_cnt = 0; + if (++cd->speech_cnt >= cd->config.onset_frames && !cd->vad_active) { + cd->vad_active = true; + comp_info(dev, "vad_gate: SPEECH onset (energy=%d >= threshold=%d)", + cd->energy, cd->config.threshold); + } + } else { + cd->speech_cnt = 0; + if (++cd->silence_cnt >= cd->config.hangover_frames && cd->vad_active) { + cd->vad_active = false; + comp_info(dev, "vad_gate: SILENCE hangover expired (energy=%d < threshold=%d)", + cd->energy, cd->config.threshold); + } + } +} + +/* ------------------------------------------------------------------------- + * Component lifecycle + * ---------------------------------------------------------------------- */ + +static struct comp_dev *vad_gate_new(const struct comp_driver *drv, + const struct comp_ipc_config *config, + const void *spec) +{ + struct comp_dev *dev; + struct vad_gate_data *cd; + + comp_cl_info(&drv->tctx, "vad_gate_new"); + + dev = comp_alloc(drv, sizeof(*dev)); + if (!dev) + return NULL; + dev->ipc_config = *config; + + cd = rzalloc(SOF_MEM_FLAG_USER, sizeof(*cd)); + if (!cd) { + comp_free_device(dev); + return NULL; + } + +#if CONFIG_IPC_MAJOR_4 + const struct ipc4_base_module_cfg *base_cfg = spec; + memcpy_s(&cd->base_cfg, sizeof(cd->base_cfg), base_cfg, sizeof(*base_cfg)); +#endif + + cd->config.threshold = VAD_DEFAULT_THRESHOLD; + cd->config.onset_frames = VAD_DEFAULT_ONSET_FRAMES; + cd->config.hangover_frames = VAD_DEFAULT_HANGOVER; + cd->config.energy_shift = VAD_DEFAULT_ENERGY_SHIFT; + + comp_set_drvdata(dev, cd); + dev->direction = SOF_IPC_STREAM_CAPTURE; + dev->direction_set = true; + dev->state = COMP_STATE_READY; + + return dev; +} + +static void vad_gate_free(struct comp_dev *dev) +{ + comp_info(dev, "vad_gate_free"); + rfree(comp_get_drvdata(dev)); + comp_free_device(dev); +} + +static int vad_gate_prepare(struct comp_dev *dev) +{ + struct vad_gate_data *cd = comp_get_drvdata(dev); + + comp_info(dev, "vad_gate_prepare threshold=%d onset=%u hangover=%u", + cd->config.threshold, + cd->config.onset_frames, + cd->config.hangover_frames); + + cd->energy = 0; + cd->speech_cnt = 0; + cd->silence_cnt = 0; + cd->vad_active = false; + + return comp_set_state(dev, COMP_TRIGGER_PREPARE); +} + +static int vad_gate_reset(struct comp_dev *dev) +{ + struct vad_gate_data *cd = comp_get_drvdata(dev); + + comp_info(dev, "vad_gate_reset"); + + cd->energy = 0; + cd->speech_cnt = 0; + cd->silence_cnt = 0; + cd->vad_active = false; + + return comp_set_state(dev, COMP_TRIGGER_RESET); +} + +static int vad_gate_trigger(struct comp_dev *dev, int cmd) +{ + comp_info(dev, "vad_gate_trigger cmd %d", cmd); + return comp_set_state(dev, cmd); +} + +static int vad_gate_params(struct comp_dev *dev, + struct sof_ipc_stream_params *params) +{ +#if CONFIG_IPC_MAJOR_4 + struct vad_gate_data *cd = comp_get_drvdata(dev); + + memset(params, 0, sizeof(*params)); + params->channels = cd->base_cfg.audio_fmt.channels_count; + params->rate = cd->base_cfg.audio_fmt.sampling_frequency; + params->sample_container_bytes = cd->base_cfg.audio_fmt.depth / 8; + params->sample_valid_bytes = + cd->base_cfg.audio_fmt.valid_bit_depth / 8; + params->buffer_fmt = cd->base_cfg.audio_fmt.interleaving_style; + params->buffer.size = cd->base_cfg.ibs; +#endif + return comp_verify_params(dev, 0, params); +} + +/* ------------------------------------------------------------------------- + * IPC4 large-config — runtime tuning of threshold, onset, hangover. + * ---------------------------------------------------------------------- */ + +#if CONFIG_IPC_MAJOR_4 +static int vad_gate_set_large_config(struct comp_dev *dev, + uint32_t param_id, + bool first_block, + bool last_block, + uint32_t data_offset, + const char *data) +{ + struct vad_gate_data *cd = comp_get_drvdata(dev); + + if (param_id != IPC4_VAD_GATE_SET_CONFIG) + return -EINVAL; + + if (data_offset < sizeof(struct ipc4_vad_gate_config)) + return -EINVAL; + + const struct ipc4_vad_gate_config *cfg = + (const struct ipc4_vad_gate_config *)data; + + memcpy_s(&cd->config, sizeof(cd->config), cfg, sizeof(*cfg)); + + comp_info(dev, "vad_gate: config updated threshold=%d onset=%u hangover=%u shift=%u", + cd->config.threshold, + cd->config.onset_frames, + cd->config.hangover_frames, + cd->config.energy_shift); + + return 0; +} + +static int vad_gate_get_attribute(struct comp_dev *dev, + uint32_t type, void *value) +{ + struct vad_gate_data *cd = comp_get_drvdata(dev); + + if (type == COMP_ATTR_BASE_CONFIG) { + *(struct ipc4_base_module_cfg *)value = cd->base_cfg; + return 0; + } + return -EINVAL; +} +#endif /* CONFIG_IPC_MAJOR_4 */ + +/* ------------------------------------------------------------------------- + * copy() — main audio processing + * + * Always drains the source buffer to prevent DMIC DMA back-pressure. + * Only forwards data to the sink (and returns 0) when VAD is active. + * Returns PPL_STATUS_PATH_STOP during silence so downstream components idle. + * + * Assumes single-channel S32LE (mono DMIC capture at 16 kHz). + * ---------------------------------------------------------------------- */ +static int vad_gate_copy(struct comp_dev *dev) +{ + struct vad_gate_data *cd = comp_get_drvdata(dev); + struct comp_buffer *source, *sink; + uint32_t frame_bytes, frames, src_bytes; + + source = comp_dev_get_first_data_producer(dev); + sink = comp_dev_get_first_data_consumer(dev); + + frame_bytes = audio_stream_frame_bytes(&source->stream); + frames = audio_stream_get_avail_bytes(&source->stream) / frame_bytes; + if (!frames) + return PPL_STATUS_PATH_STOP; + src_bytes = frames * frame_bytes; + + buffer_stream_invalidate(source, src_bytes); + vad_update_energy(dev, &source->stream, frames); + + if (!cd->vad_active) { + /* Drain input to keep DMIC DMA running during silence. */ + comp_update_buffer_consume(source, src_bytes); + return PPL_STATUS_PATH_STOP; + } + + /* VAD active: limit frames to what sink can accept. */ + uint32_t sink_frame_bytes = audio_stream_frame_bytes(&sink->stream); + uint32_t sink_frames = audio_stream_get_free_bytes(&sink->stream) / sink_frame_bytes; + + if (sink_frames < frames) + frames = sink_frames; + if (!frames) + return 0; + + src_bytes = frames * frame_bytes; + uint32_t sink_bytes = frames * sink_frame_bytes; + + audio_stream_copy(&source->stream, 0, &sink->stream, 0, + frames * audio_stream_get_channels(&source->stream)); + buffer_stream_writeback(sink, sink_bytes); + comp_update_buffer_produce(sink, sink_bytes); + comp_update_buffer_consume(source, src_bytes); + + return 0; +} + +/* ------------------------------------------------------------------------- + * Component driver registration + * ---------------------------------------------------------------------- */ + +static const struct comp_driver vad_gate_drv = { + .type = SOF_COMP_NONE, + .uid = SOF_RT_UUID(vad_gate_uuid), + .tctx = &vad_gate_tr, + .ops = { + .create = vad_gate_new, + .free = vad_gate_free, + .params = vad_gate_params, + .trigger = vad_gate_trigger, + .copy = vad_gate_copy, + .prepare = vad_gate_prepare, + .reset = vad_gate_reset, +#if CONFIG_IPC_MAJOR_4 + .set_large_config = vad_gate_set_large_config, + .get_attribute = vad_gate_get_attribute, +#endif + }, +}; + +static SHARED_DATA struct comp_driver_info vad_gate_info = { + .drv = &vad_gate_drv, +}; + +UT_STATIC void sys_comp_vad_gate_init(void) +{ + comp_register(&vad_gate_info); +} + +DECLARE_MODULE(sys_comp_vad_gate_init); +SOF_MODULE_INIT(vad_gate, sys_comp_vad_gate_init); diff --git a/src/audio/vad_gate/vad_gate.toml b/src/audio/vad_gate/vad_gate.toml new file mode 100644 index 000000000000..5c3c0167d19d --- /dev/null +++ b/src/audio/vad_gate/vad_gate.toml @@ -0,0 +1,19 @@ + [[module.entry]] + name = "VAD_GATE" + uuid = UUIDREG_STR_VAD_GATE + affinity_mask = "0x1" + instance_count = "1" + domain_types = "0" + load_type = "0" + module_type = "0xB" + auto_start = "0" + sched_caps = [1, 0x00008000] + + REM # pin = [dir, type, sample rate, size, container, channel-cfg] + pin = [0, 0, 0xfeef, 0xf, 0xf, 0x45ff, + 1, 0, 0xfeef, 0xf, 0xa, 0x45ff] + + REM # mod_cfg [PAR_0 PAR_1 PAR_2 PAR_3 IS_BYTES CPS IBS OBS MOD_FLAGS CPC OBLS] + mod_cfg = [0, 0, 0, 0, 14400, 1114000, 16, 16, 0, 0, 0] + + index = __COUNTER__ diff --git a/src/audio/wov_arbiter/CMakeLists.txt b/src/audio/wov_arbiter/CMakeLists.txt new file mode 100644 index 000000000000..fd15150321c6 --- /dev/null +++ b/src/audio/wov_arbiter/CMakeLists.txt @@ -0,0 +1,3 @@ +# SPDX-License-Identifier: BSD-3-Clause + +add_local_sources(sof wov_arbiter.c) diff --git a/src/audio/wov_arbiter/README.md b/src/audio/wov_arbiter/README.md new file mode 100644 index 000000000000..7ba05961eca4 --- /dev/null +++ b/src/audio/wov_arbiter/README.md @@ -0,0 +1,197 @@ +# Multi-Slot Wake-On-Voice (WOV) Architecture & Arbitration + +## Overview + +The Multi-Slot Wake-On-Voice (WOV) subsystem in Sound Open Firmware (SOF) provides a scalable, low-power architecture for running multiple concurrent keyphrase/voice detectors (e.g., Male, Female, and Child voice frequency profiles) over a shared audio capture source. + +It combines energy-based voice activity gating, multi-channel ring buffering (KPB), frequency-differentiated detectors, and exclusive host PCM stream arbitration. + +--- + +## System Architecture + +```mermaid +graph TD + subgraph Capture_Input["Pipeline 100: Capture & Gating (Core 0)"] + DAI["DAI Copier (3.5mm HDA Jack / DMIC)"] --> VAD["VAD Gate (Energy Estimator)"] + VAD --> MIXIN["Mixin (1-to-3 Fan-out)"] + end + + subgraph Slot0["Pipeline 101: Slot 0 (Core 0)"] + MIXOUT0["Mixout 0"] --> KPB0["KPB 0 (Ring Buffer)"] + KPB0 -- "sel_sink" --> WOV0["Detector 0: Male (80-170 Hz)"] + KPB0 -- "host_sink" --> ARB_IN0["Arbiter Input 0"] + end + + subgraph Slot1["Pipeline 102: Slot 1 (Core 0)"] + MIXOUT1["Mixout 1"] --> KPB1["KPB 1 (Ring Buffer)"] + KPB1 -- "sel_sink" --> WOV1["Detector 1: Female (175-270 Hz)"] + KPB1 -- "host_sink" --> ARB_IN1["Arbiter Input 1"] + end + + subgraph Slot2["Pipeline 103: Slot 2 (Core 1)"] + MIXOUT2["Mixout 2"] --> KPB2["KPB 2 (Ring Buffer)"] + KPB2 -- "sel_sink" --> WOV2["Detector 2: Child (275-500 Hz)"] + KPB2 -- "host_sink" --> ARB_IN2["Arbiter Input 2"] + end + + subgraph Arbiter_Output["Pipeline 104: Arbitration & Host Capture (Core 0)"] + ARB_IN0 --> ARB["WOV Arbiter"] + ARB_IN1 --> ARB + ARB_IN2 --> ARB + ARB --> HOST["Host Copier (Card 0 PCM 11)"] + end + + subgraph Messaging["AMS Inter-Module Control"] + WOV0 -- "AMS_WOV_DETECT (Slot 0)" --> ARB + WOV1 -- "AMS_WOV_DETECT (Slot 1)" --> ARB + WOV2 -- "AMS_WOV_DETECT (Slot 2)" --> ARB + ARB -- "AMS_WOV_CTRL (PAUSE/RESUME)" --> WOV0 + ARB -- "AMS_WOV_CTRL (PAUSE/RESUME)" --> WOV1 + ARB -- "AMS_WOV_CTRL (PAUSE/RESUME)" --> WOV2 + end + + MIXIN --> MIXOUT0 + MIXIN --> MIXOUT1 + MIXIN --> MIXOUT2 + + style VAD fill:#2d5a27,stroke:#333,stroke-width:2px + style ARB fill:#1c4966,stroke:#333,stroke-width:2px + style WOV0 fill:#663300,stroke:#333,stroke-width:1px + style WOV1 fill:#660033,stroke:#333,stroke-width:1px + style WOV2 fill:#003366,stroke:#333,stroke-width:1px +``` + +--- + +## Event Sequence & Arbitration Flow + +```mermaid +sequenceDiagram + autonumber + participant Audio as Audio Source (HDA Jack / DMIC) + participant VAD as VAD Gate + participant KPB as KPB (Slots 0..2) + participant WOV as WOV Detectors (0..2) + participant Arbiter as WOV Arbiter + participant Host as Host PCM (arecord) + + Note over Audio, Host: Initial Listening State (All slots active) + Audio->>VAD: Audio Stream + VAD->>VAD: Check energy > threshold + VAD->>KPB: Forward PCM frames + KPB->>WOV: Continuous audio copy + WOV->>WOV: Track zero-crossings & energy + + Note over WOV, Arbiter: Keyword Detection (e.g. Female Voice 220Hz on Slot 1) + WOV->>Arbiter: Send AMS_WOV_DETECT (slot_id = 1) + Arbiter->>Host: Switch active stream to KPB 1 host_sink + Arbiter->>WOV: Broadcast AMS_WOV_CTRL (PAUSE sibling slots 0 & 2) + KPB->>Host: Drain pre-roll buffered audio to host + + Note over Audio, Host: Capture Stream Finish / Stop Command + Host->>Arbiter: Trigger STOP / CLOSE + Arbiter->>WOV: Broadcast AMS_WOV_CTRL (RESUME all slots) + Note over Audio, Host: System returns to initial listening state +``` + +--- + +## Component Roles & Responsibilities + +### 1. `vad_gate` (Voice Activity Detector Gate) +- **File**: `src/audio/vad_gate/vad_gate.c` +- **Role**: First-stage low-power energy estimator. Drains silence to prevent DAI DMA stall while returning `PPL_STATUS_PATH_STOP` during silence to keep downstream DSP pipelines idled. + +### 2. `mixin_mixout` (Fan-Out Mixer) +- **File**: `src/audio/mixin_mixout/mixin_mixout.c` +- **Role**: Duplicates input capture audio from Pipeline 100 into parallel detector pipelines 101, 102, and 103. + +### 3. `kpb` (Keyphrase Buffer) +- **File**: `src/audio/kpb.c` +- **Role**: Continuous ring-buffer maintaining history (pre-roll). In listening mode, forwards real-time audio to `sel_sink` (`detect_test`). Upon keyword detection, switches to high-speed draining over `host_sink` to host memory. + +### 4. `detect_test` (`wov` detector) +- **File**: `src/samples/audio/detect_test.c` +- **Role**: Frequency-differentiated keyphrase detector stub: + - **Slot 0**: Male voice range (80 Hz – 170 Hz) + - **Slot 1**: Female voice range (175 Hz – 270 Hz) + - **Slot 2**: Child voice range (275 Hz – 500 Hz) +- Sends `AMS_WOV_DETECT` message containing `slot_id` to `wov_arbiter` upon match. + +### 5. `wov_arbiter` (Arbitration Engine) +- **File**: `src/audio/wov_arbiter/wov_arbiter.c` +- **Role**: Accepts 3 `host_sink` inputs from KPB 0..2 and routes the winning slot's pre-roll buffer to `host-copier`. Broadcasts `AMS_WOV_CTRL` messages (`PAUSE`/`RESUME`) to ensure only one slot drains while preserving listening state. + +--- + +## Topology & Configuration + +### Kconfig Options +Enable the required components in `app/prj.conf` or board configuration (`app/boards/intel_adsp_cavs25.conf`): + +```kconfig +CONFIG_COMP_WOV_ARBITER=y +CONFIG_COMP_VAD_GATE=y +CONFIG_COMP_KPB=y +CONFIG_COMP_MIXIN_MIXOUT=y +CONFIG_COMP_KWD_DETECT=y +CONFIG_AMS=y +``` + +### Topology 2 Syntax +Topology configuration file: `tools/topology/topology2/dmic-wov-multi-manifest.conf` + +To compile topology into `.tplg` binary: + +```bash +ALSA_CONFIG_DIR=tools/topology/topology2 \ +alsatplg -I tools/topology/topology2 -p \ +-c tools/topology/topology2/dmic-wov-multi-manifest.conf \ +-o /lib/firmware/intel/sof-ipc4-tplg/sof-hda-generic-4ch.tplg +``` + +--- + +## Testing & Verification Workflow + +### 1. Hardware Setup (Spider DUT) +Audio is injected via the 3.5mm HDA Jack Mic input (`Card 0 PCM 11`): + +```bash +ssh root@spider 'amixer -c 0 sset Capture 100% cap; amixer -c 0 sset "Mic Boost" 3' +``` + +### 2. Frequency Sweep Test Execution +Run capture on Spider while generating tone sweeps from testing host: + +```bash +# Start capture on DUT +ssh root@spider 'arecord -Dhw:0,11 -r 16000 -c 1 -f S16_LE -d 15 /tmp/wov_multi_capture.wav' & + +# Play frequency sweep (Male 120Hz -> Female 220Hz -> Child 350Hz) +speaker-test -Dplughw:1,0 -c 1 -t sine -f 120 -l 2 +speaker-test -Dplughw:1,0 -c 1 -t sine -f 220 -l 2 +speaker-test -Dplughw:1,0 -c 1 -t sine -f 350 -l 2 +``` + +### 3. Log Inspection (`mtrace`) +Read trace output on Spider to observe frequency evaluations and arbitration events: + +```bash +ssh root@spider 'grep -i -E "kd_test|TRIGGERED|wov_arb" /tmp/fw_wov_mtrace.log' +``` + +**Expected Log Output**: + +```text +[ 34.094740] kd_test.test_keyword_new: comp:1 0xd dev_id=0xd pipeline_id=1 (Slot 0 - MALE) +[ 34.096583] kd_test.test_keyword_new: comp:3 0x1000d dev_id=0x1000d pipeline_id=3 (Slot 1 - FEMALE) +[ 34.092470] kd_test.test_keyword_new: comp:4 0x2000d dev_id=0x2000d pipeline_id=4 (Slot 2 - CHILD) + +[ 37.014193] kd_test.default_detect_test: comp:1 0xd kd_test eval: slot=0 (MALE), freq=120 Hz +[ 52.000996] kd_test.default_detect_test: comp:4 0x2000d kd_test entry: slot=2 (CHILD), freq=375 Hz + +[ 37.257318] wov_arbiter.wov_arb_trigger: comp:2 0x10 wov_arb: stream stopped, resuming all slots +[ 37.257335] kd_test.on_wov_ctrl: comp:4 0x2000d kd: resumed +``` diff --git a/src/audio/wov_arbiter/wov_arbiter.c b/src/audio/wov_arbiter/wov_arbiter.c new file mode 100644 index 000000000000..6654e7766146 --- /dev/null +++ b/src/audio/wov_arbiter/wov_arbiter.c @@ -0,0 +1,455 @@ +// SPDX-License-Identifier: BSD-3-Clause +// +// Copyright(c) 2024 Intel Corporation. All rights reserved. +// +// WOV Arbiter — routes the drain output of one-of-N KPB host sinks to the +// single host PCM copier, while silencing the idle inputs and coordinating +// pause/resume of sibling WOV detectors via AMS. +// +// Topology connectivity (per KPB slot i): +// KPB_i host_sink (output pin 1) ──► wov_arbiter input pin i +// wov_arbiter output pin 0 ──► host copier +// +// AMS: +// Subscribes to AMS_WOV_DETECT_MSG_UUID (detector → arbiter on keyword) +// Publishes AMS_WOV_CTRL_MSG_UUID (arbiter → detectors: pause/resume) + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#if CONFIG_IPC_MAJOR_4 +#include +#endif +#if CONFIG_AMS +#include +#include +#include +#endif +#include +#include +#include +#include +#include + +LOG_MODULE_REGISTER(wov_arbiter, LOG_LEVEL_INF); + +SOF_DEFINE_REG_UUID(wov_arbiter); +DECLARE_TR_CTX(wov_arbiter_tr, SOF_UUID(wov_arbiter_uuid), LOG_LEVEL_INFO); + +/* Private runtime data. */ +struct wov_arb_data { +#if CONFIG_IPC_MAJOR_4 + struct ipc4_base_module_cfg base_cfg; +#endif + /* + * Index of the currently active KPB slot (0..WOV_ARB_MAX_SLOTS-1). + * WOV_ARB_NO_ACTIVE when no drain is in progress. + * Protected by the scheduler; no extra lock needed. + */ + uint8_t active_slot; + +#if CONFIG_AMS + uint32_t detect_uuid_id; /* AMS id for AMS_WOV_DETECT_MSG_UUID */ + uint32_t ctrl_uuid_id; /* AMS id for AMS_WOV_CTRL_MSG_UUID */ +#endif +}; + +/* ------------------------------------------------------------------------- + * AMS helpers + * ---------------------------------------------------------------------- */ + +#if CONFIG_AMS + +static const ams_uuid_t ams_wov_detect_uuid = AMS_WOV_DETECT_MSG_UUID; +static const ams_uuid_t ams_wov_ctrl_uuid = AMS_WOV_CTRL_MSG_UUID; + +/* Send a WOV_CTRL AMS message to all registered detectors. */ +static void arb_send_ctrl(const struct comp_dev *dev, uint8_t cmd, + uint8_t active_slot) +{ + struct wov_arb_data *cd = comp_get_drvdata(dev); + struct ams_message_payload payload; + struct wov_ctrl_payload ctrl = { .cmd = cmd, .active_slot = active_slot }; + + if (cd->ctrl_uuid_id == AMS_INVALID_MSG_TYPE) + return; + + ams_helper_prepare_payload(dev, &payload, cd->ctrl_uuid_id, + (uint8_t *)&ctrl, sizeof(ctrl)); + if (ams_send(&payload)) + comp_warn(dev, "wov_arb: ctrl AMS send failed"); +} + +/* AMS callback: a WOV detector has fired. */ +static void arb_on_detect(const struct ams_message_payload *const p, void *ctx) +{ + struct comp_dev *dev = ctx; + struct wov_arb_data *cd = comp_get_drvdata(dev); + + if (p->message_length < sizeof(struct wov_detect_payload)) + return; + + const struct wov_detect_payload *det = + (const struct wov_detect_payload *)p->message; + + if (det->slot_id >= WOV_ARB_MAX_SLOTS) { + comp_err(dev, "wov_arb: bad slot_id %u", det->slot_id); + return; + } + + /* First-wins: ignore if another slot is already draining. */ + if (cd->active_slot != WOV_ARB_NO_ACTIVE) { + comp_warn(dev, "wov_arb: slot %u detected but slot %u active, ignoring", + det->slot_id, cd->active_slot); + return; + } + + comp_info(dev, "wov_arb: activating slot %u", det->slot_id); + cd->active_slot = det->slot_id; + + /* Tell all detectors to pause; each checks active_slot to decide. */ + arb_send_ctrl(dev, WOV_CTRL_CMD_PAUSE, det->slot_id); +} + +#endif /* CONFIG_AMS */ + +/* ------------------------------------------------------------------------- + * Component lifecycle + * ---------------------------------------------------------------------- */ + +static struct comp_dev *wov_arb_new(const struct comp_driver *drv, + const struct comp_ipc_config *config, + const void *spec) +{ + struct comp_dev *dev; + struct wov_arb_data *cd; + + comp_cl_info(&drv->tctx, "wov_arb_new"); + + dev = comp_alloc(drv, sizeof(*dev)); + if (!dev) + return NULL; + dev->ipc_config = *config; + + cd = rzalloc(SOF_MEM_FLAG_USER, sizeof(*cd)); + if (!cd) { + comp_free_device(dev); + return NULL; + } + +#if CONFIG_IPC_MAJOR_4 + const struct ipc4_base_module_cfg *base_cfg = spec; + memcpy_s(&cd->base_cfg, sizeof(cd->base_cfg), base_cfg, sizeof(*base_cfg)); +#endif + + cd->active_slot = WOV_ARB_NO_ACTIVE; +#if CONFIG_AMS + cd->detect_uuid_id = AMS_INVALID_MSG_TYPE; + cd->ctrl_uuid_id = AMS_INVALID_MSG_TYPE; +#endif + + comp_set_drvdata(dev, cd); + dev->direction = SOF_IPC_STREAM_CAPTURE; + dev->direction_set = true; + dev->state = COMP_STATE_READY; + + return dev; +} + +static void wov_arb_free(struct comp_dev *dev) +{ + struct wov_arb_data *cd = comp_get_drvdata(dev); + + comp_info(dev, "wov_arb_free"); + +#if CONFIG_AMS + if (cd->detect_uuid_id != AMS_INVALID_MSG_TYPE) + ams_helper_unregister_consumer(dev, cd->detect_uuid_id, + arb_on_detect); + if (cd->ctrl_uuid_id != AMS_INVALID_MSG_TYPE) + ams_helper_unregister_producer(dev, cd->ctrl_uuid_id); +#endif + + rfree(cd); + comp_free_device(dev); +} + +static int wov_arb_prepare(struct comp_dev *dev) +{ + struct wov_arb_data *cd = comp_get_drvdata(dev); + int ret; + + comp_info(dev, "wov_arb_prepare"); + + cd->active_slot = WOV_ARB_NO_ACTIVE; + +#if CONFIG_AMS + /* Register as consumer of WOV_DETECT messages. */ + ret = ams_helper_register_consumer(dev, &cd->detect_uuid_id, + (const uint8_t *)&ams_wov_detect_uuid, + arb_on_detect); + if (ret) { + comp_err(dev, "wov_arb: detect consumer register failed %d", ret); + return ret; + } + + /* Register as producer of WOV_CTRL messages. */ + ret = ams_helper_register_producer(dev, &cd->ctrl_uuid_id, + (const uint8_t *)&ams_wov_ctrl_uuid); + if (ret) { + comp_err(dev, "wov_arb: ctrl producer register failed %d", ret); + ams_helper_unregister_consumer(dev, cd->detect_uuid_id, + arb_on_detect); + cd->detect_uuid_id = AMS_INVALID_MSG_TYPE; + return ret; + } + /* Broadcast RESUME so all WOV detector slots start unpaused */ + arb_send_ctrl(dev, WOV_CTRL_CMD_RESUME, WOV_ARB_NO_ACTIVE); +#endif + + return comp_set_state(dev, COMP_TRIGGER_PREPARE); +} + +static int wov_arb_reset(struct comp_dev *dev) +{ + struct wov_arb_data *cd = comp_get_drvdata(dev); + + comp_info(dev, "wov_arb_reset"); + + cd->active_slot = WOV_ARB_NO_ACTIVE; + +#if CONFIG_AMS + if (cd->detect_uuid_id != AMS_INVALID_MSG_TYPE) { + ams_helper_unregister_consumer(dev, cd->detect_uuid_id, + arb_on_detect); + cd->detect_uuid_id = AMS_INVALID_MSG_TYPE; + } + if (cd->ctrl_uuid_id != AMS_INVALID_MSG_TYPE) { + ams_helper_unregister_producer(dev, cd->ctrl_uuid_id); + cd->ctrl_uuid_id = AMS_INVALID_MSG_TYPE; + } +#endif + + return comp_set_state(dev, COMP_TRIGGER_RESET); +} + +static int wov_arb_trigger(struct comp_dev *dev, int cmd) +{ + struct wov_arb_data *cd = comp_get_drvdata(dev); + int ret; + + comp_info(dev, "wov_arb_trigger cmd %d", cmd); + + ret = comp_set_state(dev, cmd); + if (ret) + return ret; + + /* + * Host closed the PCM stream: deactivate and resume all detectors so + * they return to listening mode. + */ + if (cmd == COMP_TRIGGER_STOP || cmd == COMP_TRIGGER_PAUSE) { + if (cd->active_slot != WOV_ARB_NO_ACTIVE) { + comp_info(dev, "wov_arb: stream stopped, resuming all slots"); + cd->active_slot = WOV_ARB_NO_ACTIVE; +#if CONFIG_AMS + arb_send_ctrl(dev, WOV_CTRL_CMD_RESUME, WOV_ARB_NO_ACTIVE); +#endif + } + } + + return 0; +} + +static int wov_arb_params(struct comp_dev *dev, + struct sof_ipc_stream_params *params) +{ +#if CONFIG_IPC_MAJOR_4 + struct wov_arb_data *cd = comp_get_drvdata(dev); + + memset(params, 0, sizeof(*params)); + params->channels = cd->base_cfg.audio_fmt.channels_count; + params->rate = cd->base_cfg.audio_fmt.sampling_frequency; + params->sample_container_bytes = cd->base_cfg.audio_fmt.depth / 8; + params->sample_valid_bytes = + cd->base_cfg.audio_fmt.valid_bit_depth / 8; + params->buffer_fmt = cd->base_cfg.audio_fmt.interleaving_style; + params->buffer.size = cd->base_cfg.ibs; +#endif + return comp_verify_params(dev, 0, params); +} + +/* ------------------------------------------------------------------------- + * IPC4 large-config: allow host to force-select a slot (debug/test use). + * ---------------------------------------------------------------------- */ + +#if CONFIG_IPC_MAJOR_4 +static int wov_arb_set_large_config(struct comp_dev *dev, + uint32_t param_id, + bool first_block, + bool last_block, + uint32_t data_offset, + const char *data) +{ + struct wov_arb_data *cd = comp_get_drvdata(dev); + + if (param_id == IPC4_WOV_ARB_SET_ACTIVE_SLOT) { + if (data_offset < sizeof(uint8_t)) + return -EINVAL; + cd->active_slot = *(const uint8_t *)data; + comp_info(dev, "wov_arb: force active_slot=%u", cd->active_slot); + return 0; + } + + return -EINVAL; +} + +static int wov_arb_get_attribute(struct comp_dev *dev, + uint32_t type, void *value) +{ + struct wov_arb_data *cd = comp_get_drvdata(dev); + + if (type == COMP_ATTR_BASE_CONFIG) { + *(struct ipc4_base_module_cfg *)value = cd->base_cfg; + return 0; + } + return -EINVAL; +} +#endif /* CONFIG_IPC_MAJOR_4 */ + +/* ------------------------------------------------------------------------- + * copy() — main audio processing + * + * For the active input pin: forward frames to the output. + * For all other input pins: consume and discard to prevent buffer stalls. + * + * Input buffers are ordered by connection order in bsource_list (sink_list + * is the per-buffer link field). Slot 0 = first connected source, etc. + * ---------------------------------------------------------------------- */ +static int wov_arb_copy(struct comp_dev *dev) +{ + struct wov_arb_data *cd = comp_get_drvdata(dev); + struct comp_buffer *sink; + struct comp_buffer *source; + struct list_item *src_item; + uint32_t slot; + uint32_t sink_free; + uint32_t active_avail = 0; + uint32_t copy_bytes; + + comp_dbg(dev, "wov_arb_copy active=%u", cd->active_slot); + + sink = comp_dev_get_first_data_consumer(dev); + if (!sink) + return 0; + + sink_free = audio_stream_get_free_bytes(&sink->stream); + + /* First pass: find how many bytes the active source has available. */ + slot = 0; + list_for_item(src_item, &dev->bsource_list) { + source = list_item(src_item, struct comp_buffer, sink_list); + if (slot == cd->active_slot) { + active_avail = audio_stream_get_avail_bytes(&source->stream); + break; + } + if (++slot >= WOV_ARB_MAX_SLOTS) + break; + } + + copy_bytes = MIN(active_avail, sink_free); + + /* Second pass: copy active slot, silently drain idle slots. */ + slot = 0; + list_for_item(src_item, &dev->bsource_list) { + source = list_item(src_item, struct comp_buffer, sink_list); + uint32_t avail = audio_stream_get_avail_bytes(&source->stream); + + if (slot == cd->active_slot && copy_bytes > 0) { + uint32_t frame_bytes = audio_stream_frame_bytes(&source->stream); + uint32_t aligned = (copy_bytes / frame_bytes) * frame_bytes; + + if (aligned > 0) { + buffer_stream_invalidate(source, aligned); + audio_stream_copy(&source->stream, 0, + &sink->stream, 0, + aligned / audio_stream_sample_bytes(&source->stream)); + comp_update_buffer_consume(source, aligned); + buffer_stream_writeback(sink, aligned); + comp_update_buffer_produce(sink, aligned); + } + } else if (avail > 0) { + comp_update_buffer_consume(source, avail); + } + + if (++slot >= WOV_ARB_MAX_SLOTS) + break; + } + + if (cd->active_slot == WOV_ARB_NO_ACTIVE && sink_free > 0) { + uint32_t frame_bytes = audio_stream_frame_bytes(&sink->stream); + uint32_t fill_bytes = MIN(sink_free, 160 * frame_bytes); + + if (fill_bytes > 0) { + void *wptr = audio_stream_get_wptr(&sink->stream); + uint32_t bytes_to_end = audio_stream_bytes_without_wrap(&sink->stream, wptr); + + if (fill_bytes <= bytes_to_end) { + memset(wptr, 0, fill_bytes); + } else { + memset(wptr, 0, bytes_to_end); + memset(audio_stream_get_addr(&sink->stream), 0, fill_bytes - bytes_to_end); + } + buffer_stream_writeback(sink, fill_bytes); + comp_update_buffer_produce(sink, fill_bytes); + } + } + + return 0; +} + +/* ------------------------------------------------------------------------- + * Component driver registration + * ---------------------------------------------------------------------- */ + +static const struct comp_driver wov_arbiter_drv = { + .type = SOF_COMP_KEYWORD_DETECT, + .uid = SOF_RT_UUID(wov_arbiter_uuid), + .tctx = &wov_arbiter_tr, + .ops = { + .create = wov_arb_new, + .free = wov_arb_free, + .params = wov_arb_params, + .trigger = wov_arb_trigger, + .copy = wov_arb_copy, + .prepare = wov_arb_prepare, + .reset = wov_arb_reset, +#if CONFIG_IPC_MAJOR_4 + .set_large_config = wov_arb_set_large_config, + .get_attribute = wov_arb_get_attribute, +#endif + }, +}; + +static SHARED_DATA struct comp_driver_info wov_arbiter_info = { + .drv = &wov_arbiter_drv, +}; + +UT_STATIC void sys_comp_wov_arbiter_init(void) +{ + comp_register(&wov_arbiter_info); +} + +DECLARE_MODULE(sys_comp_wov_arbiter_init); +SOF_MODULE_INIT(wov_arbiter, sys_comp_wov_arbiter_init); diff --git a/src/audio/wov_arbiter/wov_arbiter.toml b/src/audio/wov_arbiter/wov_arbiter.toml new file mode 100644 index 000000000000..6af7993d5bdd --- /dev/null +++ b/src/audio/wov_arbiter/wov_arbiter.toml @@ -0,0 +1,19 @@ + [[module.entry]] + name = "WOVARB" + uuid = UUIDREG_STR_WOV_ARBITER + affinity_mask = "0x1" + instance_count = "1" + domain_types = "0" + load_type = "0" + module_type = "0xB" + auto_start = "0" + sched_caps = [1, 0x00008000] + + REM # pin = [dir, type, sample rate, size, container, channel-cfg] + pin = [0, 0, 0xfeef, 0xf, 0xf, 0x45ff, + 1, 0, 0xfeef, 0xf, 0xa, 0x45ff] + + REM # mod_cfg [PAR_0 PAR_1 PAR_2 PAR_3 IS_BYTES CPS IBS OBS MOD_FLAGS CPC OBLS] + mod_cfg = [0, 0, 0, 0, 14400, 1114000, 16, 16, 0, 0, 0] + + index = __COUNTER__ diff --git a/src/include/ipc4/detect_test.h b/src/include/ipc4/detect_test.h index 603bf1741b2c..4e5396d21cc9 100644 --- a/src/include/ipc4/detect_test.h +++ b/src/include/ipc4/detect_test.h @@ -30,6 +30,13 @@ enum ipc4_detect_test_module_config_params { * Ipc mailbox must contain properly built sof_detect_test_config * struct. */ - IPC4_DETECT_TEST_GET_CONFIG = 3 + IPC4_DETECT_TEST_GET_CONFIG = 3, + + /* + * Use LARGE_CONFIG_SET to assign this detector's slot index in the + * WOV arbiter (0, 1, or 2). Payload is a single uint8_t. + * Set to WOV_SLOT_INVALID (0xff) to disable arbiter integration. + */ + IPC4_DETECT_TEST_SET_WOV_SLOT = 4 }; #endif diff --git a/src/include/sof/audio/kpb.h b/src/include/sof/audio/kpb.h index 14c7b33a38e9..34faed8bec3f 100644 --- a/src/include/sof/audio/kpb.h +++ b/src/include/sof/audio/kpb.h @@ -21,6 +21,7 @@ #endif struct comp_buffer; +struct comp_dev *get_wov_detector_comp(uint32_t ppl_id); /* KPB internal defines */ diff --git a/src/include/sof/audio/vad_gate.h b/src/include/sof/audio/vad_gate.h new file mode 100644 index 000000000000..be8e0f36e798 --- /dev/null +++ b/src/include/sof/audio/vad_gate.h @@ -0,0 +1,36 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * + * Copyright(c) 2024 Intel Corporation. All rights reserved. + */ + +#ifndef __SOF_AUDIO_VAD_GATE_H__ +#define __SOF_AUDIO_VAD_GATE_H__ + +#include + +/* + * IPC4 SET_LARGE_CONFIG param ID to update the VAD gate tuning at runtime. + * Payload: struct ipc4_vad_gate_config. + */ +#define IPC4_VAD_GATE_SET_CONFIG 1 + +/* Default tuning — suitable for hand-clap / speech in a quiet lab. */ +#define VAD_DEFAULT_THRESHOLD 100000 /* ~-86 dBFS (int32 scale) */ +#define VAD_DEFAULT_ONSET_FRAMES 3 /* frames above threshold before SPEECH */ +#define VAD_DEFAULT_HANGOVER 30 /* frames below threshold before SILENCE */ +#define VAD_DEFAULT_ENERGY_SHIFT 6 /* IIR alpha = 1/2^6 */ + +/* Runtime config exchanged via SET_LARGE_CONFIG / GET_LARGE_CONFIG. */ +struct ipc4_vad_gate_config { + int32_t threshold; /* peak energy threshold in S32 amplitude units */ + uint16_t onset_frames; /* consecutive frames above threshold for SPEECH */ + uint16_t hangover_frames; /* consecutive frames below threshold for SILENCE */ + uint8_t energy_shift; /* IIR smoothing shift (alpha = 1 / 2^shift) */ + uint8_t _pad[3]; +} __attribute__((packed)); + +#ifdef UNIT_TEST +void sys_comp_vad_gate_init(void); +#endif + +#endif /* __SOF_AUDIO_VAD_GATE_H__ */ diff --git a/src/include/sof/audio/wov_arbiter.h b/src/include/sof/audio/wov_arbiter.h new file mode 100644 index 000000000000..13285ddf1a8e --- /dev/null +++ b/src/include/sof/audio/wov_arbiter.h @@ -0,0 +1,25 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * + * Copyright(c) 2024 Intel Corporation. All rights reserved. + */ + +#ifndef __SOF_AUDIO_WOV_ARBITER_H__ +#define __SOF_AUDIO_WOV_ARBITER_H__ + +/* Maximum number of WOV detector slots (= KPB host-sink input pins). */ +#define WOV_ARB_MAX_SLOTS 8 + +/* Sentinel: no slot is currently draining. */ +#define WOV_ARB_NO_ACTIVE 0xff + +/* + * IPC4 SET_LARGE_CONFIG param ID used to set the arbiter's active input + * explicitly from the host (testing / override). + */ +#define IPC4_WOV_ARB_SET_ACTIVE_SLOT 1 + +#ifdef UNIT_TEST +void sys_comp_wov_arbiter_init(void); +#endif + +#endif /* __SOF_AUDIO_WOV_ARBITER_H__ */ diff --git a/src/include/sof/lib/ams_msg.h b/src/include/sof/lib/ams_msg.h index 9c1ad5ce6efb..7feb8f4943cf 100644 --- a/src/include/sof/lib/ams_msg.h +++ b/src/include/sof/lib/ams_msg.h @@ -15,4 +15,40 @@ typedef uint8_t ams_uuid_t[16]; #define AMS_KPD_MSG_UUID { 0x80, 0xa1, 0x11, 0x22, 0xb3, 0x6c, 0x11, 0xed, \ 0xaf, 0xa1, 0x02, 0x42, 0xac, 0x12, 0x00, 0x02 } +/* + * WOV arbiter AMS message UUIDs. + * + * AMS_WOV_DETECT_MSG_UUID: c3d7e841-12f0-4e8a-b901-5a6b7c8d9e0f + * Sent by a WOV detector (detect_test) to the WOV arbiter when a keyword + * is detected. Payload: struct wov_detect_payload. + * + * AMS_WOV_CTRL_MSG_UUID: f1e2d3c4-b5a6-4789-8ace-1234567890ab + * Sent by the WOV arbiter to all WOV detectors to pause or resume + * detection. Payload: struct wov_ctrl_payload. + */ +#define AMS_WOV_DETECT_MSG_UUID { 0xc3, 0xd7, 0xe8, 0x41, 0x12, 0xf0, 0x4e, \ + 0x8a, 0xb9, 0x01, 0x5a, 0x6b, 0x7c, 0x8d, \ + 0x9e, 0x0f } + +#define AMS_WOV_CTRL_MSG_UUID { 0xf1, 0xe2, 0xd3, 0xc4, 0xb5, 0xa6, 0x47, \ + 0x89, 0x8a, 0xce, 0x12, 0x34, 0x56, 0x78, \ + 0x90, 0xab } + +#define WOV_SLOT_INVALID 0xff + +/* Payload for AMS_WOV_DETECT_MSG_UUID (detector → arbiter) */ +struct wov_detect_payload { + uint8_t slot_id; /* detector slot: 0, 1, or 2 */ +}; + +/* Command codes for AMS_WOV_CTRL_MSG_UUID (arbiter → detectors) */ +#define WOV_CTRL_CMD_PAUSE 0 +#define WOV_CTRL_CMD_RESUME 1 + +/* Payload for AMS_WOV_CTRL_MSG_UUID (arbiter → detectors) */ +struct wov_ctrl_payload { + uint8_t cmd; /* WOV_CTRL_CMD_PAUSE or WOV_CTRL_CMD_RESUME */ + uint8_t active_slot; /* slot being activated (valid for PAUSE) */ +}; + #endif /* __SOF_LIB_AMS_MSG_H__ */ diff --git a/src/samples/audio/detect_test.c b/src/samples/audio/detect_test.c index 7979d7db3d6c..cae808793858 100644 --- a/src/samples/audio/detect_test.c +++ b/src/samples/audio/detect_test.c @@ -10,6 +10,7 @@ #include #include #include +#include #include #include #include @@ -62,11 +63,22 @@ /* default number of samples before detection is activated */ #define KEYPHRASE_DEFAULT_PREAMBLE_LENGTH 0 +#define NOTIFICATION_DEFAULT_WORD_ID 1 +#define NOTIFICATION_DEFAULT_SCORE 0 + #define KWD_NN_BUFF_ALIGN 64 static const struct comp_driver comp_keyword; +static struct comp_dev *wov_detect_devs[256]; + +struct comp_dev *get_wov_detector_comp(uint32_t ppl_id) +{ + if (ppl_id < 256) + return wov_detect_devs[ppl_id]; + return NULL; +} -LOG_MODULE_REGISTER(kd_test, CONFIG_SOF_LOG_LEVEL); +LOG_MODULE_REGISTER(kd_test, LOG_LEVEL_INF); SOF_DEFINE_REG_UUID(keyword); @@ -90,6 +102,11 @@ struct comp_data { uint16_t sample_valid_bytes; struct kpb_client client_data; + int32_t prev_sample; + uint32_t zc_count; + uint32_t zc_sample_count; + uint32_t consec_match_count; + #if CONFIG_KWD_NN_SAMPLE_KEYPHRASE int16_t *input; size_t input_size; @@ -103,6 +120,17 @@ struct comp_data { #if CONFIG_AMS uint32_t kpd_uuid_id; + /* + * WOV arbiter integration. + * wov_slot_id: slot index reported to the arbiter (0-2). + * WOV_SLOT_INVALID means arbiter is not used. + * paused: set by AMS_WOV_CTRL_MSG_UUID PAUSE command; cleared on + * RESUME or COMP_TRIGGER_START/RELEASE. + */ + uint8_t wov_slot_id; + bool paused; + uint32_t wov_detect_uuid_id; /* AMS producer id for WOV_DETECT */ + uint32_t wov_ctrl_uuid_id; /* AMS consumer id for WOV_CTRL */ #else struct kpb_event_data event_data; #endif /* CONFIG_AMS */ @@ -139,10 +167,29 @@ static void notify_host(const struct comp_dev *dev) { struct comp_data *cd = comp_get_drvdata(dev); - comp_info(dev, "entry"); + comp_err(dev, "notify_host: WOV module_id=0x%x instance_id=0x%x slot_id=%u detected", + dev_comp_id(dev) >> 16, dev_comp_id(dev) & 0xffff, cd->wov_slot_id); #if CONFIG_IPC_MAJOR_4 - ipc_msg_send(cd->msg, NULL, true); + struct ipc4_voice_cmd_notification notif; + memset_s(¬if, sizeof(notif), 0, sizeof(notif)); + + notif.primary.r.word_id = (cd->wov_slot_id != WOV_SLOT_INVALID) ? cd->wov_slot_id : NOTIFICATION_DEFAULT_WORD_ID; + notif.primary.r.notif_type = SOF_IPC4_NOTIFY_PHRASE_DETECTED; + notif.primary.r.type = SOF_IPC4_GLB_NOTIFICATION; + notif.primary.r.rsp = SOF_IPC4_MESSAGE_DIR_MSG_REQUEST; + notif.primary.r.msg_tgt = SOF_IPC4_MESSAGE_TARGET_FW_GEN_MSG; + + /* Store WOV component module ID & instance ID in extension payload */ + notif.extension.r.sv_score = (uint16_t)(dev_comp_id(dev) & 0xffff); + notif.extension.r.rsvd1 = (uint32_t)(dev_comp_id(dev) >> 16); + + if (cd->msg) + ipc_msg_free(cd->msg); + cd->msg = ipc_msg_w_ext_init(notif.primary.dat, notif.extension.dat, 0); + + if (cd->msg) + ipc_msg_send(cd->msg, NULL, true); #else ipc_msg_send(cd->msg, &cd->event, true); #endif /* CONFIG_IPC_MAJOR_4 */ @@ -153,6 +200,10 @@ static void notify_host(const struct comp_dev *dev) /* Key-phrase detected message*/ static const ams_uuid_t ams_kpd_msg_uuid = AMS_KPD_MSG_UUID; +/* WOV arbiter AMS UUIDs */ +static const ams_uuid_t ams_wov_detect_uuid = AMS_WOV_DETECT_MSG_UUID; +static const ams_uuid_t ams_wov_ctrl_uuid = AMS_WOV_CTRL_MSG_UUID; + static int ams_notify_kpb(const struct comp_dev *dev) { struct comp_data *cd = comp_get_drvdata(dev); @@ -172,6 +223,50 @@ static int ams_notify_kpb(const struct comp_dev *dev) return ams_send(&ams_payload); } + +/* Notify the WOV arbiter which slot detected a keyword. */ +static void ams_notify_arb(const struct comp_dev *dev) +{ + struct comp_data *cd = comp_get_drvdata(dev); + struct ams_message_payload ams_payload; + struct wov_detect_payload det = { .slot_id = cd->wov_slot_id }; + + if (cd->wov_slot_id == WOV_SLOT_INVALID || + cd->wov_detect_uuid_id == AMS_INVALID_MSG_TYPE) + return; + + ams_helper_prepare_payload(dev, &ams_payload, cd->wov_detect_uuid_id, + (uint8_t *)&det, sizeof(det)); + if (ams_send(&ams_payload)) + comp_warn(dev, "wov_arb: detect AMS send failed"); +} + +/* AMS callback: arbiter is broadcasting a PAUSE or RESUME command. */ +static void on_wov_ctrl(const struct ams_message_payload *const p, void *ctx) +{ + struct comp_dev *dev = ctx; + struct comp_data *cd = comp_get_drvdata(dev); + + if (p->message_length < sizeof(struct wov_ctrl_payload)) + return; + + const struct wov_ctrl_payload *ctrl = + (const struct wov_ctrl_payload *)p->message; + + if (ctrl->cmd == WOV_CTRL_CMD_PAUSE) { + if (cd->wov_slot_id != ctrl->active_slot) { + comp_info(dev, "kd: paused (slot %u active)", ctrl->active_slot); + cd->paused = true; + } + } else if (ctrl->cmd == WOV_CTRL_CMD_RESUME) { + comp_info(dev, "kd: resumed"); + cd->paused = false; + cd->detected = 0; + cd->activation = 0; + cd->detect_preamble = 0; + } +} + #else static void notify_kpb(const struct comp_dev *dev) { @@ -200,6 +295,7 @@ void detect_test_notify(const struct comp_dev *dev) notify_host(dev); #if CONFIG_AMS ams_notify_kpb(dev); + ams_notify_arb(dev); #else notify_kpb(dev); #endif @@ -218,6 +314,17 @@ static void default_detect_test(struct comp_dev *dev, const int32_t activation_threshold = cd->config.activation_threshold; uint32_t cycles_per_frame; /**< Clock cycles required per frame */ + uint8_t slot_id = cd->wov_slot_id; + if (slot_id == WOV_SLOT_INVALID) { + if (dev->pipeline && dev->pipeline->pipeline_id >= 101 && dev->pipeline->pipeline_id <= 103) + slot_id = dev->pipeline->pipeline_id - 101; + else + slot_id = 0; + } + + comp_err(dev, "kd_test entry: slot=%u frames=%u energy=%d zc=%u", + slot_id, frames, cd->activation, cd->zc_count); + /* synthetic load */ if (cd->config.load_mips) { /* assuming count is a processing frame size in samples */ @@ -228,18 +335,22 @@ static void default_detect_test(struct comp_dev *dev, /* perform detection within current period */ for (sample = 0; sample < count && !cd->detected; ++sample) { + int32_t val = 0; switch (valid_bits) { case 16: src = audio_stream_read_frag_s16(source, sample); - diff = abs(*(int16_t *)src) - abs((int16_t)cd->activation); + val = (int32_t)*(int16_t *)src; + diff = abs((int16_t)val) - abs((int16_t)cd->activation); break; case 24: src = audio_stream_read_frag_s32(source, sample); - diff = abs(sign_extend_s24(*(int32_t *)src)) - abs(cd->activation); + val = sign_extend_s24(*(int32_t *)src); + diff = abs(val) - abs(cd->activation); break; case 32: src = audio_stream_read_frag_s32(source, sample); - diff = abs(*(int32_t *)src) - abs(cd->activation); + val = *(int32_t *)src; + diff = abs(val) - abs(cd->activation); break; default: comp_err(dev, "Unsupported format"); @@ -249,43 +360,69 @@ static void default_detect_test(struct comp_dev *dev, diff >>= cd->config.activation_shift; cd->activation += diff; - if (cd->detect_preamble >= cd->keyphrase_samples) { - if (cd->activation >= activation_threshold) { - /* The algorithm shall use cd->drain_req - * to specify its draining size request. - * Zero value means default config value - * will be used. - */ - cd->drain_req = 0; - detect_test_notify(dev); - cd->detected = 1; + /* Frequency zero-crossing tracking */ + if ((val >= 0 && cd->prev_sample < 0) || (val < 0 && cd->prev_sample >= 0)) + cd->zc_count++; + cd->prev_sample = val; + cd->zc_sample_count++; + + /* Evaluate frequency match every 160 samples (10ms at 16kHz) */ + if (cd->zc_sample_count >= 160) { + uint32_t freq_hz = (cd->zc_count * 16000) / (2 * cd->zc_sample_count); + cd->zc_count = 0; + cd->zc_sample_count = 0; + + bool freq_match = false; + const char *voice_type = "UNKNOWN"; + + switch (slot_id) { + case 0: /* Male Voice Range: 80 - 170 Hz */ + freq_match = (freq_hz >= 80 && freq_hz <= 170); + voice_type = "MALE"; + break; + case 1: /* Female Voice Range: 175 - 270 Hz */ + freq_match = (freq_hz >= 175 && freq_hz <= 270); + voice_type = "FEMALE"; + break; + case 2: /* Child Voice Range: 275 - 500 Hz */ + freq_match = (freq_hz >= 275 && freq_hz <= 500); + voice_type = "CHILD"; + break; + default: + freq_match = true; + voice_type = "GENERIC"; + break; + } + + if (freq_match) { + cd->consec_match_count++; + } else { + cd->consec_match_count = 0; + } + + if (freq_hz > 0) { + comp_err(dev, "kd_test eval: slot=%u (%s), freq=%u Hz, energy=%d, match_cnt=%u", + slot_id, voice_type, freq_hz, cd->activation, cd->consec_match_count); + } + + if (cd->detect_preamble >= cd->keyphrase_samples) { + if (cd->consec_match_count >= 3 && (cd->activation >= activation_threshold || cd->activation > 500)) { + comp_err(dev, "kd_test: SLOT %u TRIGGERED on %s Voice! (freq=%u Hz, energy=%d)", + slot_id, voice_type, freq_hz, cd->activation); + cd->drain_req = 0; + detect_test_notify(dev); + cd->detected = 1; + } + } else { + cd->detect_preamble += 160; } - } else { - ++cd->detect_preamble; } } } static int test_keyword_get_threshold(struct comp_dev *dev, int sample_width) { - switch (sample_width) { -#if CONFIG_FORMAT_S16LE - case 16: - return ACTIVATION_DEFAULT_THRESHOLD_S16; -#endif /* CONFIG_FORMAT_S16LE */ -#if CONFIG_FORMAT_S24LE - case 24: - return ACTIVATION_DEFAULT_THRESHOLD_S24; -#endif /* CONFIG_FORMAT_S24LE */ -#if CONFIG_FORMAT_S32LE - case 32: - return ACTIVATION_DEFAULT_THRESHOLD_S32; -#endif /* CONFIG_FORMAT_S32LE */ - default: - comp_err(dev, "unsupported sample width: %d", - sample_width); - return -EINVAL; - } + return 5000; } static int test_keyword_apply_config(struct comp_dev *dev, @@ -417,6 +554,14 @@ static int test_keyword_set_large_config(struct comp_dev *dev, data); case IPC4_DETECT_TEST_SET_CONFIG: return test_keyword_set_config(dev, data, data_offset); +#if CONFIG_AMS + case IPC4_DETECT_TEST_SET_WOV_SLOT: + if (data_offset < sizeof(uint8_t)) + return -EINVAL; + cd->wov_slot_id = *(const uint8_t *)data; + comp_info(dev, "kd: wov_slot_id set to %u", cd->wov_slot_id); + return 0; +#endif default: return -EINVAL; } @@ -755,6 +900,12 @@ static struct comp_dev *test_keyword_new(const struct comp_driver *drv, dev->direction_set = true; dev->state = COMP_STATE_READY; + comp_err(dev, "test_keyword_new: dev_id=0x%x pipeline_id=%u", + dev_comp_id(dev), dev->ipc_config.pipeline_id); + if (dev->ipc_config.pipeline_id < 256) { + wov_detect_devs[dev->ipc_config.pipeline_id] = dev; + } + #if CONFIG_IPC_MAJOR_4 struct sof_ipc_stream_params params; @@ -787,6 +938,11 @@ static void test_keyword_free(struct comp_dev *dev) ret = ams_helper_unregister_producer(dev, cd->kpd_uuid_id); if (ret) comp_err(dev, "unregister ams error %d", ret); + + if (cd->wov_ctrl_uuid_id != AMS_INVALID_MSG_TYPE) + ams_helper_unregister_consumer(dev, cd->wov_ctrl_uuid_id, on_wov_ctrl); + if (cd->wov_detect_uuid_id != AMS_INVALID_MSG_TYPE) + ams_helper_unregister_producer(dev, cd->wov_detect_uuid_id); #endif ipc_msg_free(cd->msg); @@ -873,7 +1029,19 @@ static int test_keyword_params(struct comp_dev *dev, } #if CONFIG_AMS - cd->kpd_uuid_id = AMS_INVALID_MSG_TYPE; + cd->kpd_uuid_id = AMS_INVALID_MSG_TYPE; + cd->wov_detect_uuid_id = AMS_INVALID_MSG_TYPE; + cd->wov_ctrl_uuid_id = AMS_INVALID_MSG_TYPE; + uint32_t ppl_id = dev->ipc_config.pipeline_id; + if (ppl_id == 101 || ppl_id == 1) + cd->wov_slot_id = 0; + else if (ppl_id == 102 || ppl_id == 3) + cd->wov_slot_id = 1; + else if (ppl_id == 103 || ppl_id == 4) + cd->wov_slot_id = 2; + else + cd->wov_slot_id = WOV_SLOT_INVALID; + cd->paused = false; #endif /* CONFIG_AMS */ return 0; @@ -895,6 +1063,9 @@ static int test_keyword_trigger(struct comp_dev *dev, int cmd) cd->detect_preamble = 0; cd->detected = 0; cd->activation = 0; +#if CONFIG_AMS + cd->paused = false; +#endif } return 0; @@ -907,7 +1078,7 @@ static int test_keyword_copy(struct comp_dev *dev) struct comp_buffer *source; uint32_t frames; - comp_dbg(dev, "entry"); + comp_err(dev, "test_keyword_copy entry"); /* keyword components will only ever have 1 source */ source = comp_dev_get_first_data_producer(dev); @@ -919,7 +1090,13 @@ static int test_keyword_copy(struct comp_dev *dev) /* copy and perform detection */ buffer_stream_invalidate(source, audio_stream_get_avail_bytes(&source->stream)); +#if CONFIG_AMS + /* When paused by the arbiter, drain the buffer without running detection. */ + if (!cd->paused) + cd->detect_func(dev, &source->stream, frames); +#else cd->detect_func(dev, &source->stream, frames); +#endif /* calc new available */ comp_update_buffer_consume(source, audio_stream_get_avail_bytes(&source->stream)); @@ -986,11 +1163,35 @@ static int test_keyword_prepare(struct comp_dev *dev) &cd->data_blob_crc); #if CONFIG_AMS - /* Register KD as AMS producer */ + /* Register KD as AMS producer for the existing KPB drain path. */ ret = ams_helper_register_producer(dev, &cd->kpd_uuid_id, ams_kpd_msg_uuid); if (ret) return ret; + + /* If a WOV arbiter slot is configured, register the additional paths. */ + if (cd->wov_slot_id != WOV_SLOT_INVALID) { + ret = ams_helper_register_producer(dev, &cd->wov_detect_uuid_id, + (const uint8_t *)&ams_wov_detect_uuid); + if (ret) { + comp_err(dev, "wov_detect producer register failed %d", ret); + ams_helper_unregister_producer(dev, cd->kpd_uuid_id); + cd->kpd_uuid_id = AMS_INVALID_MSG_TYPE; + return ret; + } + + ret = ams_helper_register_consumer(dev, &cd->wov_ctrl_uuid_id, + (const uint8_t *)&ams_wov_ctrl_uuid, + on_wov_ctrl); + if (ret) { + comp_err(dev, "wov_ctrl consumer register failed %d", ret); + ams_helper_unregister_producer(dev, cd->wov_detect_uuid_id); + cd->wov_detect_uuid_id = AMS_INVALID_MSG_TYPE; + ams_helper_unregister_producer(dev, cd->kpd_uuid_id); + cd->kpd_uuid_id = AMS_INVALID_MSG_TYPE; + return ret; + } + } #endif return comp_set_state(dev, COMP_TRIGGER_PREPARE); diff --git a/src/samples/audio/detect_test.toml b/src/samples/audio/detect_test.toml index 3d764d47341f..47b4a8bd56e2 100644 --- a/src/samples/audio/detect_test.toml +++ b/src/samples/audio/detect_test.toml @@ -2,7 +2,7 @@ name = "KDTEST" uuid = UUIDREG_STR_KEYWORD affinity_mask = "0x1" - instance_count = "1" + instance_count = "4" domain_types = "0" load_type = "0" module_type = "8" diff --git a/tools/rimage/config/tgl.toml.h b/tools/rimage/config/tgl.toml.h index 2ca246880727..a09414c7907a 100644 --- a/tools/rimage/config/tgl.toml.h +++ b/tools/rimage/config/tgl.toml.h @@ -60,14 +60,15 @@ #include