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/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..8bb0100c4e76 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; @@ -981,11 +1046,30 @@ static int kpb_reset(struct comp_dev *dev) switch (kpb->state) { case KPB_STATE_BUFFERING: case KPB_STATE_DRAINING: - /* KPB is performing some task now, - * terminate it gently. + /* If a host drain is in progress, terminate gently and let + * kpb_copy complete the reset once scheduled. When there is + * no host_sink (WOV-only path) the scheduler has already + * stopped by the time RESET arrives, so reset immediately. */ - kpb_change_state(kpb, KPB_STATE_RESETTING); - ret = -EBUSY; + if (kpb->host_sink) { + kpb_change_state(kpb, KPB_STATE_RESETTING); + ret = -EBUSY; + break; + } + /* host_sink == NULL: immediate full reset (same as default) */ + kpb->hd.buffered = 0; + kpb->sel_sink = NULL; + kpb->host_sink = NULL; + kpb->host_buffer_size = 0; + kpb->host_period_size = 0; + for (i = 0; i < KPB_MAX_NO_OF_CLIENTS; i++) { + kpb->clients[i].state = KPB_CLIENT_UNREGISTERED; + kpb->clients[i].r_ptr = NULL; + } + if (kpb->hd.c_hb) + kpb_reset_history_buffer(kpb->hd.c_hb); + kpb_change_state(kpb, KPB_STATE_PREPARING); + ret = comp_set_state(dev, COMP_TRIGGER_RESET); break; case KPB_STATE_DISABLED: case KPB_STATE_CREATED: @@ -1234,19 +1318,16 @@ static int kpb_copy(struct comp_dev *dev) sink = kpb->sel_sink; ret = PPL_STATUS_PATH_STOP; + comp_dbg(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 +1394,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_dbg(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; @@ -1607,6 +1697,28 @@ static int kpb_register_client(struct comp_data *kpb, struct kpb_client *cli) static void kpb_init_draining(struct comp_dev *dev, struct kpb_client *cli) { struct comp_data *kpb = comp_get_drvdata(dev); + + if (!kpb->host_sink) { + if (!kpb->sel_sink) { + comp_warn(dev, "kpb_init_draining: no drain path, skipping"); + return; + } + /* WOV-only path: no dedicated host PCM sink. Route history drain + * through sel_sink so wov passthrough delivers it to the arbiter. + * Set host_period_size to one real-time period so sync_draining_mode + * throttles the EDF drain task to match the LL pipeline rate. + */ + comp_warn(dev, "kpb_init_draining: no host_sink, draining via sel_sink"); + kpb->host_sink = kpb->sel_sink; + if (!kpb->host_period_size) { + size_t bpm = (size_t)KPB_SAMPLES_PER_MS * + (KPB_SAMPLE_CONTAINER_SIZE(kpb->config.sampling_width) / 8) * + kpb->config.channels; + kpb->host_period_size = bpm; + kpb->host_buffer_size = audio_stream_get_size(&kpb->sel_sink->stream); + } + } + bool is_sink_ready = (comp_buffer_get_sink_state(kpb->host_sink) == COMP_STATE_ACTIVE); size_t sample_width = kpb->config.sampling_width; size_t drain_req = (size_t)cli->drain_req * kpb->config.channels * @@ -1633,14 +1745,16 @@ static void kpb_init_draining(struct comp_dev *dev, struct kpb_client *cli) /* TODO: check also if client is registered */ } else if (!is_sink_ready) { comp_err(dev, "sink not ready for draining"); - } else if (kpb->hd.buffered < drain_req || - cli->drain_req > KPB_MAX_DRAINING_REQ) { - comp_cl_err(&comp_kpb, "not enough data in history buffer"); + } else if (cli->drain_req > KPB_MAX_DRAINING_REQ) { + comp_cl_err(&comp_kpb, "drain request exceeds max"); } else { - /* Draining accepted, find proper buffer to start reading - * At this point we are guaranteed that there is enough data - * in the history buffer. All we have to do now is to calculate - * read pointer from which we will start draining. + if (kpb->hd.buffered < drain_req) { + comp_cl_warn(&comp_kpb, "partial pre-roll: capping drain to buffered"); + drain_req = kpb->hd.buffered; + } + /* Draining accepted, find proper buffer to start reading. + * If less history than requested is buffered, drain_req is + * capped above so we drain whatever is available. */ kpb_lock(kpb); @@ -1750,8 +1864,11 @@ static void kpb_init_draining(struct comp_dev *dev, struct kpb_client *cli) comp_set_attribute(comp_buffer_get_sink_component(kpb->host_sink), COMP_ATTR_COPY_TYPE, &kpb->force_copy_type); - /* Pause selector copy. */ - comp_buffer_get_sink_component(kpb->sel_sink)->state = COMP_STATE_PAUSED; + /* Pause selector copy to stop detection on stale drain data. + * Skip when sel_sink IS the drain path (wov passthrough needed). + */ + if (kpb->host_sink != kpb->sel_sink) + comp_buffer_get_sink_component(kpb->sel_sink)->state = COMP_STATE_PAUSED; if (!pm_runtime_is_active(PM_RUNTIME_DSP, PLATFORM_PRIMARY_CORE_ID)) pm_runtime_disable(PM_RUNTIME_DSP, PLATFORM_PRIMARY_CORE_ID); @@ -2368,7 +2485,7 @@ static void kpb_reset_history_buffer(struct history_buffer *buff) if (!buff) return; - kpb_clear_history_buffer(buff); + do { buff->w_ptr = buff->start_addr; 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..6f142e25db84 --- /dev/null +++ b/src/audio/wov_arbiter/README.md @@ -0,0 +1,919 @@ +# Multi-Slot Wake-On-Voice (WOV) Architecture & Arbitration + +## Overview + +The Multi-Slot WOV subsystem lets a single DMIC feed up to 3 concurrent keyword detectors +running on the DSP. Each detector has its own Keyphrase Buffer (KPB) that continuously records +a pre-roll window (6 seconds on TigerLake, 2.1 seconds on other platforms). When any detector +fires the `wov_arbiter` drains that KPB's ring buffer to the single host PCM device and pauses +the other detectors. When the host closes the stream the arbiter resumes all detectors. + +This design keeps host DMA live and eliminates the wakeup latency normally incurred by starting +DMA after detection. + +--- + +## Table of Contents + +1. [System Architecture](#system-architecture) +2. [Signal Processing Flow](#signal-processing-flow) +3. [Arbiter State Machine](#arbiter-state-machine) +4. [AMS Inter-Module Messaging](#ams-inter-module-messaging) +5. [Firmware API Reference](#firmware-api-reference) +6. [Linux Host API Reference](#linux-host-api-reference) +7. [Adding a New WOV Algorithm](#adding-a-new-wov-algorithm) +8. [Topology: Build and Deploy](#topology-build-and-deploy) +9. [Build System Configuration](#build-system-configuration) +10. [Testing and Verification](#testing-and-verification) + +--- + +## System Architecture + +### Component Graph + +```mermaid +graph TD + subgraph P100["Pipeline 100 — Capture & Gating (Core 0)"] + DAI["DAI Copier\nHDA Analog\ndai_index=1"] + VAD["vad_gate\n(energy estimator)"] + MIX["mixin\n(1→3 fan-out)"] + DAI --> VAD --> MIX + end + + subgraph P101["Pipeline 101 — Slot 0 (Core 0)"] + MO0["mixout 0"] + K0["kpb 0\n6 s ring buffer"] + D0["detect_test\nSlot 0\n(Male 80–170 Hz)"] + MO0 --> K0 + K0 -- sel_sink --> D0 + end + + subgraph P102["Pipeline 102 — Slot 1 (Core 0)"] + MO1["mixout 1"] + K1["kpb 1\n6 s ring buffer"] + D1["detect_test\nSlot 1\n(Female 175–270 Hz)"] + MO1 --> K1 + K1 -- sel_sink --> D1 + end + + subgraph P103["Pipeline 103 — Slot 2 (Core 1)"] + MO2["mixout 2"] + K2["kpb 2\n6 s ring buffer"] + D2["detect_test\nSlot 2\n(Child 275–500 Hz)"] + MO2 --> K2 + K2 -- sel_sink --> D2 + end + + subgraph P104["Pipeline 104 — Arbitration & Host Capture (Core 0)"] + ARB["wov_arbiter\n(first-wins)"] + HC["host-copier\nPCM 11\n'DMIC Multi-WOV'"] + ARB --> HC + end + + MIX --> MO0 + MIX --> MO1 + MIX --> MO2 + + K0 -- host_sink --> ARB + K1 -- host_sink --> ARB + K2 -- host_sink --> ARB + + D0 -- "AMS WOV_DETECT\n(slot_id=0)" --> ARB + D1 -- "AMS WOV_DETECT\n(slot_id=1)" --> ARB + D2 -- "AMS WOV_DETECT\n(slot_id=2)" --> ARB + ARB -- "AMS WOV_CTRL\n(PAUSE/RESUME)" --> D0 + ARB -- "AMS WOV_CTRL\n(PAUSE/RESUME)" --> D1 + ARB -- "AMS WOV_CTRL\n(PAUSE/RESUME)" --> D2 + + style VAD fill:#2d5a27,stroke:#555 + style ARB fill:#1c4966,stroke:#555 + style D0 fill:#663300,stroke:#555 + style D1 fill:#660033,stroke:#555 + style D2 fill:#003366,stroke:#555 +``` + +### Key Design Points + +| Property | Value | +|---|---| +| Audio format | 16 kHz · 1ch · S16_LE throughout | +| KPB pre-roll (TigerLake) | 6 000 ms (192 000 bytes) | +| KPB pre-roll (other) | 2 100 ms | +| Max arbiter slots | 3 (topology), 8 (header constant) | +| Arbitration policy | First-wins; subsequent detections ignored until RESUME | +| Slot 2 core affinity | DSP Core 1 (cross-core scheduling validation) | +| Host PCM | card 0, device 11 — `hw:0,11` | + +--- + +## Signal Processing Flow + +### LL Thread Path (every 1 ms) + +```mermaid +flowchart LR + HW["HW DMA\n(DMIC interrupt)"] + DAI_COPY["dai_copier.copy()\nPipeline 100"] + VAD_COPY["vad_gate.copy()\nenergy > threshold?"] + MIXIN["mixin.copy()\nduplicate into\n3 ring buffers"] + MIXOUT["mixout_N.copy()"] + KPB_COPY["kpb_N.copy()\nwrite ring buffer\nsel_sink → detect_test"] + DT_COPY["detect_test.copy()\naccumulate 320 frames\ninto ping-pong buffer\nthen k_sem_give()"] + + HW --> DAI_COPY --> VAD_COPY + VAD_COPY -- "energy OK" --> MIXIN + VAD_COPY -- "silence" --> STOP(["PPL_STATUS_PATH_STOP\n(idle pipelines)"]) + MIXIN --> MIXOUT --> KPB_COPY --> DT_COPY +``` + +### DP Thread Path (every 20 ms per slot) + +Each slot has its own `k_thread` at `K_PRIO_PREEMPT(12)`. Slot 2 is additionally pinned to +DSP Core 1 via `k_thread_cpu_pin()`. + +```mermaid +flowchart TD + SEM["k_sem_take()"] + CHECK{dp_thread_active?} + BUF["read dp_buf[read_slot]\n320 × S16_LE samples"] + DETECT["run detection algorithm\n(zero-crossing + energy)"] + FOUND{match?} + NOTIFY["detect_test_notify(dev)\n① IPC4 → host\n② AMS → KPB (drain)\n③ AMS → arbiter (activate)"] + AUTOTRIG["auto-trigger\n(test only, limit=320 frames)"] + LOOP(["loop"]) + + SEM --> CHECK + CHECK -- "false" --> EXIT(["thread exits"]) + CHECK -- "true" --> BUF --> DETECT --> FOUND + FOUND -- "yes" --> NOTIFY --> LOOP + FOUND -- "no" --> AUTOTRIG --> LOOP + LOOP --> SEM +``` + +### KPB Drain Sequence (triggered by AMS) + +```mermaid +flowchart LR + DETECT_AMS["AMS_WOV_DETECT\n→ kpb.copy()"] + SWITCH["KPB: switch sel_sink\n→ host_sink"] + DRAIN["drain ring buffer\n(up to 6 s pre-roll)\nto wov_arbiter input buffer"] + LIVE["continue forwarding\nlive DMIC audio"] + + DETECT_AMS --> SWITCH --> DRAIN --> LIVE +``` + +--- + +## Arbiter State Machine + +```mermaid +stateDiagram-v2 + [*] --> Idle : wov_arb_new() / prepare()\nactive_slot = NO_ACTIVE\nbroadcast RESUME + + Idle --> Active : AMS WOV_DETECT(slot_id=N)\nactive_slot = N\nbroadcast PAUSE(N) + + Active --> Active : AMS WOV_DETECT(slot_id=M)\n[first-wins: ignored] + + Active --> Idle : trigger(STOP or PAUSE)\nactive_slot = NO_ACTIVE\nbroadcast RESUME + + Idle --> [*] : wov_arb_free() +``` + +### `wov_arb_copy()` Routing Logic + +| Condition | Active slot buffer | Idle slot buffers | Sink output | +|---|---|---|---| +| `active_slot == NO_ACTIVE` | — | drained and discarded | filled with silence (memset 0) | +| `active_slot == N` | copied frame-aligned to sink | drained and discarded | pre-roll + live audio | + +The first-wins guard in `arb_on_detect()`: + +```c +if (cd->active_slot != WOV_ARB_NO_ACTIVE) { + comp_warn(dev, "wov_arb: slot %u fired but slot %u already active, ignoring", + det->slot_id, cd->active_slot); + return; +} +``` + +--- + +## AMS Inter-Module Messaging + +AMS (Asynchronous Messaging Service) is SOF's intra-DSP publish/subscribe bus. +Messages are fired synchronously but delivered to registered consumers without a +blocking round-trip. + +### Message Catalog + +| UUID constant | Direction | Payload | Purpose | +|---|---|---|---| +| `AMS_WOV_DETECT_MSG_UUID` | detector → arbiter | `struct wov_detect_payload { uint8_t slot_id; }` | Announce keyword detection | +| `AMS_WOV_CTRL_MSG_UUID` | arbiter → all detectors | `struct wov_ctrl_payload { uint8_t cmd; uint8_t active_slot; }` | Pause/resume detectors | +| `AMS_KPD_MSG_UUID` (existing) | detector → KPB | `struct kpb_client` | Switch KPB to host-drain mode | + +`cmd` values: `WOV_CTRL_CMD_PAUSE = 0`, `WOV_CTRL_CMD_RESUME = 1`. +`active_slot = WOV_ARB_NO_ACTIVE (0xff)` on RESUME means "resume all". + +### Full Detect-to-Drain Sequence + +```mermaid +sequenceDiagram + autonumber + participant DMIC as DMIC (HW) + participant KPB as KPB N + participant DET as detect_test (slot N) + participant ARB as wov_arbiter + participant HOST as Host PCM (arecord) + participant OTHER as detect_test (slots ≠ N) + + Note over DMIC,OTHER: Listening state — all slots accumulating pre-roll + + loop Every 1 ms (LL period) + DMIC->>KPB: DAI DMA frames + KPB->>DET: sel_sink copy + end + + loop Every 20 ms (DP batch) + DET->>DET: run algorithm on 320-frame batch + end + + Note over DET,ARB: Keyword detected on slot N + + DET->>HOST: ① IPC4 SOF_IPC4_NOTIFY_PHRASE_DETECTED\n (word_id = slot_id) + DET->>KPB: ② AMS AMS_KPD_MSG (switch to host_sink drain) + DET->>ARB: ③ AMS AMS_WOV_DETECT (slot_id = N) + + ARB->>ARB: active_slot = N + ARB->>OTHER: AMS AMS_WOV_CTRL (cmd=PAUSE, active_slot=N) + OTHER->>OTHER: cd->paused = true\n(stops DP batching) + + KPB->>ARB: stream pre-roll (up to 6 s) via host_sink + ARB->>HOST: route slot-N audio to host PCM + + Note over HOST,ARB: Host finishes reading / closes PCM + + HOST->>ARB: trigger STOP (ALSA hw_free / snd_pcm_close) + ARB->>ARB: active_slot = NO_ACTIVE + ARB->>OTHER: AMS AMS_WOV_CTRL (cmd=RESUME, active_slot=0xff) + ARB->>DET: AMS AMS_WOV_CTRL (cmd=RESUME) + OTHER->>OTHER: cd->paused = false\ncd->detected = 0\nresumed listening +``` + +--- + +## Firmware API Reference + +### IPC4 Module Parameters (`LARGE_CONFIG_SET`) + +#### `detect_test` — slot assignment + +| `param_id` | Constant | Payload | Effect | +|---|---|---|---| +| `4` | `IPC4_DETECT_TEST_SET_WOV_SLOT` | `uint8_t slot_id` | Override the pipeline-ID-derived slot assignment | + +This is called automatically from pipeline topology. Use it only when the +pipeline-ID → slot mapping (below) does not cover your layout: + +```c +/* pipeline_id → wov_slot_id (from test_keyword_new) */ +ppl_id 101 or 1 → slot 0 +ppl_id 102 or 3 → slot 1 +ppl_id 103 or 4 → slot 2 +other → WOV_SLOT_INVALID (arbiter path disabled) +``` + +#### `wov_arbiter` — force active slot (debug only) + +| `param_id` | Constant | Payload | Effect | +|---|---|---|---| +| `1` | `IPC4_WOV_ARB_SET_ACTIVE_SLOT` | `uint8_t slot_id` | Force-activate a slot without AMS, bypassing first-wins | + +### AMS Producer/Consumer Registration + +A WOV detector must register both roles during `prepare()`: + +```c +/* Register as producer of WOV_DETECT messages */ +ams_helper_register_producer(dev, &cd->wov_detect_uuid_id, + (const uint8_t *)&ams_wov_detect_uuid); + +/* Register as consumer of WOV_CTRL messages (arbiter → detector) */ +ams_helper_register_consumer(dev, &cd->wov_ctrl_uuid_id, + (const uint8_t *)&ams_wov_ctrl_uuid, + on_wov_ctrl); +``` + +Unregister in `reset()` or `free()`. + +### `detect_test_notify(dev)` — Detection Announcement + +Call this from your detection algorithm when a keyword is confirmed: + +```c +void detect_test_notify(const struct comp_dev *dev); +``` + +Internally executes three steps: +1. Sends `SOF_IPC4_NOTIFY_PHRASE_DETECTED` IPC4 notification to host +2. Sends `AMS_KPD_MSG` to KPB → triggers pre-roll drain on `host_sink` +3. Sends `AMS_WOV_DETECT` to `wov_arbiter` → activates this slot + +### DP Thread Ping-Pong Buffer Contract + +| Field | Type | Semantics | +|---|---|---| +| `dp_buf[2][320]` | `int16_t` | ping-pong accumulation buffer | +| `dp_buf_frames` | `uint32_t` | frames in write slot (0 to 319) | +| `dp_write_slot` | `uint8_t` | index (0 or 1) LL writes into | +| `dp_read_slot` | `uint8_t` | index DP thread reads from | +| `dp_sem` | `struct k_sem` | binary semaphore, max count = 1 | +| `dp_thread_active` | `bool` | false → thread exits on next wake | + +LL thread gives semaphore after every 320 accumulated frames. +DP thread takes semaphore and processes `dp_buf[dp_read_slot]`. +Missing a give (while thread is still processing) drops that batch silently +(semaphore max count = 1 prevents accumulation). + +--- + +## Linux Host API Reference + +### ALSA Capture + +The WOV audio is exposed as a standard ALSA PCM capture device: + +``` +Card: 0 Device: 11 Name: "DMIC Multi-WOV" +Formats: S16_LE, S24_LE, S32_LE +Rate: 16000 Hz +Channels: 1 (mono) +``` + +Open and capture with `arecord`: + +```bash +arecord -Dhw:0,11 -r 16000 -c 1 -f S16_LE -d 10 /tmp/wov_capture.wav +``` + +Or via libasound in code: + +```c +snd_pcm_t *handle; +snd_pcm_open(&handle, "hw:0,11", SND_PCM_STREAM_CAPTURE, 0); +snd_pcm_set_params(handle, SND_PCM_FORMAT_S16_LE, + SND_PCM_ACCESS_RW_INTERLEAVED, + 1, 16000, 1, 100000 /* 100ms latency */); +``` + +### Voice Detection Notification from Firmware + +When a keyword is detected the firmware sends an IPC4 `SOF_IPC4_NOTIFY_PHRASE_DETECTED` +notification. The SOF kernel driver surfaces this as an ALSA control-change event on a +`SOUNDWIRE_DETECT` or `KWD_DETECT` kcontrol (exact name depends on machine driver). + +To poll for the notification from userspace: + +```c +/* Open ALSA control interface */ +snd_ctl_t *ctl; +snd_ctl_open(&ctl, "hw:0", 0); + +/* Subscribe to events */ +snd_ctl_subscribe_events(ctl, 1); + +/* Block until a control change event arrives */ +snd_ctl_event_t *event; +snd_ctl_event_alloca(&event); +while (snd_ctl_read(ctl, event) >= 0) { + if (snd_ctl_event_get_type(event) == SND_CTL_EVENT_ELEM) { + /* Trigger: start reading from hw:0,11 */ + break; + } +} +``` + +The `word_id` field in the IPC4 notification carries the `wov_slot_id` (0, 1, or 2), +identifying which detector fired. + +### Audio Capture Timing + +Because host DMA is live from the moment `arecord` opens `hw:0,11`, the ALSA +buffer begins filling with `wov_arbiter` output immediately: + +- **Before any trigger**: arbiter writes silence (all-zero samples) +- **On trigger**: arbiter drains the KPB ring buffer (up to 6 s of pre-roll) then + continues forwarding live DMIC audio +- **On STOP**: arbiter returns to silence mode; detectors resume listening + +The host sees a seamless audio stream. The silence-to-audio transition marks the +trigger point in the buffer. + +### IPC4 Module Control via `sof-ctl` + +Override the slot assignment for a `detect_test` instance using the SOF IPC4 +LARGE_CONFIG_SET path (requires `sof-ctl` tool or equivalent hwdep ioctl): + +```bash +# Set detect_test in pipeline 102 to use slot_id = 1 +sof-ctl -c hw:0 -t large_config_set \ + -m -i \ + -p 4 -b 01 # param_id=4 (IPC4_DETECT_TEST_SET_WOV_SLOT), data=0x01 +``` + +--- + +## Adding a New WOV Algorithm + +The reference implementation (`detect_test.c`) is intentionally simple — it looks for +zero-crossing rate and signal energy in fixed frequency bands. Replace it with any +algorithm by following one of the approaches below. + +### Approach A — Modify `detect_test.c` directly + +This is simplest for prototyping. The DP thread calls `default_detect_test_buf()` on +every 320-frame batch. Replace its body with your algorithm: + +```c +/* src/samples/audio/detect_test.c */ + +static void default_detect_test_buf(struct comp_dev *dev, + const int16_t *samples, uint32_t frames) +{ + struct comp_data *cd = comp_get_drvdata(dev); + + if (cd->detected || cd->paused) + return; + + /* === YOUR ALGORITHM HERE === + * Input: samples — pointer to 'frames' interleaved S16_LE samples + * frames — always KD_DP_FRAMES (320) = 20 ms @ 16 kHz + * Output: call detect_test_notify(dev) when keyword is confirmed. + * =========================== + */ + bool keyword_found = my_algorithm_process(cd->algo_state, samples, frames); + + if (keyword_found) { + comp_err(dev, "KWD detected on slot %u", cd->wov_slot_id); + if (!cd->drain_req) + cd->drain_req = cd->config.drain_req ? cd->config.drain_req : 5000; + detect_test_notify(dev); + cd->detected = 1; + } +} +``` + +Store per-slot algorithm state in `struct comp_data` (add fields to the struct). +The slot index is available as `cd->wov_slot_id` (0, 1, or 2) so each KPB pipeline's +detector can hold independent model state. + +### Approach B — New Native SOF Module + +For a production algorithm create a new SOF module following the standard +`src/audio/template/` skeleton and integrate it with the arbiter AMS: + +**Step 1: Create the module files** + +``` +src/audio/my_kwd/ +├── CMakeLists.txt +├── my_kwd.c +└── my_kwd.h +``` + +**Step 2: Implement the module driver** + +```c +/* src/audio/my_kwd/my_kwd.c */ +#include +#include +#include +#include +#include + +struct my_kwd_data { + uint8_t wov_slot_id; + bool paused; + bool detected; + uint32_t wov_detect_uuid_id; + uint32_t wov_ctrl_uuid_id; + /* ... algorithm state ... */ +}; + +/* Called by arbiter when a sibling slot fires */ +static void on_wov_ctrl(const struct ams_message_payload *const p, void *ctx) +{ + struct comp_dev *dev = ctx; + struct my_kwd_data *cd = comp_get_drvdata(dev); + const struct wov_ctrl_payload *ctrl = (const void *)p->payload; + + if (ctrl->cmd == WOV_CTRL_CMD_PAUSE && cd->wov_slot_id != ctrl->active_slot) + cd->paused = true; + else if (ctrl->cmd == WOV_CTRL_CMD_RESUME) { + cd->paused = false; + cd->detected = 0; + } +} + +/* Notify arbiter + KPB + host that this slot fired */ +static void my_kwd_notify(struct comp_dev *dev) +{ + struct my_kwd_data *cd = comp_get_drvdata(dev); + + /* 1. IPC4 notification to host */ + struct ipc4_voice_cmd_notification notif = {}; + notif.primary.r.word_id = cd->wov_slot_id; + notif.primary.r.notif_type = SOF_IPC4_NOTIFY_PHRASE_DETECTED; + notif.primary.r.type = SOF_IPC4_GLB_NOTIFICATION; + /* ... fill in module_id / instance_id ... */ + ipc_msg_send(cd->msg, ¬if, true); + + /* 2. Tell KPB to start draining */ + /* (re-use existing ams_notify_kpb helper or send AMS_KPD_MSG directly) */ + + /* 3. Tell arbiter slot fired */ + struct wov_detect_payload det = { .slot_id = cd->wov_slot_id }; + struct ams_message_payload *payload = /* allocate from AMS pool */; + ams_helper_prepare_payload(dev, payload, cd->wov_detect_uuid_id, + (uint8_t *)&det, sizeof(det)); + ams_send(payload); +} + +static int my_kwd_prepare(struct comp_dev *dev) +{ + struct my_kwd_data *cd = comp_get_drvdata(dev); + + /* Derive slot from pipeline ID */ + uint32_t ppl = dev->ipc_config.pipeline_id; + cd->wov_slot_id = (ppl == 101 || ppl == 1) ? 0 : + (ppl == 102 || ppl == 3) ? 1 : + (ppl == 103 || ppl == 4) ? 2 : WOV_SLOT_INVALID; + + if (cd->wov_slot_id != WOV_SLOT_INVALID) { + ams_helper_register_producer(dev, &cd->wov_detect_uuid_id, + (const uint8_t *)&ams_wov_detect_uuid); + ams_helper_register_consumer(dev, &cd->wov_ctrl_uuid_id, + (const uint8_t *)&ams_wov_ctrl_uuid, + on_wov_ctrl); + } + return comp_set_state(dev, COMP_TRIGGER_PREPARE); +} + +static int my_kwd_copy(struct comp_dev *dev) +{ + struct my_kwd_data *cd = comp_get_drvdata(dev); + struct comp_buffer *source = comp_dev_get_first_data_producer(dev); + + if (!audio_stream_get_avail(&source->stream)) + return PPL_STATUS_PATH_STOP; + + uint32_t frames = audio_stream_get_avail_frames(&source->stream); + uint32_t avail_b = audio_stream_get_avail_bytes(&source->stream); + buffer_stream_invalidate(source, avail_b); + + /* Pass-through to arbiter input */ + struct comp_buffer *sink = comp_dev_get_first_data_consumer(dev); + if (sink && audio_stream_get_free_bytes(&sink->stream) >= avail_b) { + audio_stream_copy(&source->stream, 0, &sink->stream, 0, + frames * audio_stream_get_channels(&source->stream)); + buffer_stream_writeback(sink, avail_b); + comp_update_buffer_produce(sink, avail_b); + } + + if (!cd->paused && !cd->detected) { + /* Run your algorithm on the frames */ + if (my_algorithm_run(cd, &source->stream, frames)) { + my_kwd_notify(dev); + cd->detected = 1; + } + } + + comp_update_buffer_consume(source, avail_b); + return 0; +} +``` + +**Step 3: Register the UUID** + +Add to `uuid-registry.txt`: + +``` +MY_KWD_UUID_HEX my_kwd +``` + +Add to `src/audio/my_kwd/CMakeLists.txt`: + +```cmake +add_local_sources(sof my_kwd.c) +``` + +Add to `src/audio/CMakeLists.txt`: + +```cmake +if(CONFIG_COMP_MY_KWD) + add_subdirectory(my_kwd) +endif() +``` + +Add `src/audio/Kconfig`: + +```kconfig +config COMP_MY_KWD + bool "My keyword detector" + depends on COMP_KPB && IPC_MAJOR_4 + select AMS +``` + +**Step 4: Update the topology** + +In `dmic-wov-multi.conf`, replace `KWD_TEST_UUID` with the UUID bytes for `my_kwd` +in the `wov.101.1`, `wov.102.1`, `wov.103.1` widgets. + +### Approach C — IADK / LLEXT loadable module + +For algorithms that must ship as separate binaries (third-party IP, updatable +without reflashing), use the SOF IADK module adapter framework. The algorithm +is compiled as an LLEXT `.so` and loaded at runtime from the kernel filesystem. +See `src/audio/module_adapter/README.md` for the full IADK API. + +The AMS notification path (steps 2 and 3 of `my_kwd_notify`) remains the same; +only the binary delivery mechanism changes. + +### Algorithm State Isolation + +Each pipeline instance (101/102/103) creates its own `comp_dev` with independent +`comp_data`. Detector state is never shared between slots. The `wov_slot_id` field +identifies which pipeline a given instance belongs to: + +``` +Pipeline 101 → wov_slot_id=0 → kd_dp_stack_0 / kd_dp_threads[0] +Pipeline 102 → wov_slot_id=1 → kd_dp_stack_1 / kd_dp_threads[1] +Pipeline 103 → wov_slot_id=2 → kd_dp_stack_2 / kd_dp_threads[2] (Core 1) +``` + +--- + +## Topology: Build and Deploy + +### Topology Source Layout + +``` +tools/topology/topology2/ +├── platform/intel/ +│ └── dmic-wov-multi.conf ← main topology (edit here) +├── include/components/ +│ └── wov-arbiter.conf ← wov_arbiter widget class definition +└── dmic-wov-multi-manifest.conf ← top-level manifest (includes above) +``` + +### Compile Topology to `.tplg` + +From the root of the SOF repository: + +```bash +ALSA_CONFIG_DIR=tools/topology/topology2 \ +alsatplg \ + -I tools/topology/topology2 \ + -p \ + -c tools/topology/topology2/dmic-wov-multi-manifest.conf \ + -o sof-hda-generic-wov.tplg +``` + +Copy the compiled topology to the DUT: + +```bash +scp sof-hda-generic-wov.tplg \ + root@:/lib/firmware/intel/sof-ipc4-tplg/sof-hda-generic-wov.tplg +``` + +Tell the SOF driver which topology to load (edit `/etc/modprobe.d/sof.conf` on the DUT): + +``` +options snd_sof_pci_intel_tgl fw_path=intel/sof-ipc4/tgl \ + tplg_path=intel/sof-ipc4-tplg tplg_filename=sof-hda-generic-wov.tplg +``` + +Or pass directly at `modprobe` time: + +```bash +modprobe snd_sof_pci_intel_tgl \ + tplg_filename=intel/sof-ipc4-tplg/sof-hda-generic-wov.tplg +``` + +### Build Firmware with WOV Arbiter + +Configure a build directory with the required Kconfig options (see +[Build System Configuration](#build-system-configuration)), then build: + +```bash +ninja -C +``` + +Copy the firmware image to the DUT (path varies by platform): + +```bash +# TigerLake example +scp /zephyr/zephyr.ri \ + root@:/lib/firmware/intel/sof-ipc4/tgl/community/sof-tgl.ri +``` + +Reload the driver on the DUT: + +```bash +rmmod snd_sof_pci_intel_tgl && modprobe snd_sof_pci_intel_tgl +``` + +### Topology Configuration Reference + +Key parameters in `dmic-wov-multi.conf`: + +| Constant | Default | Description | +|---|---|---| +| `DMIC_PCM_ID` | `11` | ALSA PCM device index | +| `DMIC_DAI_INDEX` | `1` | HDA DAI instance | +| `KWD_CPC` | `100000` | cycles per chunk for detector widgets | +| `WOV_ARB_CPC` | `20000` | cycles per chunk for arbiter | +| `VAD_GATE_CPC` | `5000` | cycles per chunk for VAD gate | +| `FORMAT` | `s16le` | audio format throughout | + +Slot 2 (`Pipeline 103`) is deliberately placed on Core 1 (`core_id = 1`) to validate +cross-core scheduling. Set all three to `core_id = 0` if a single-core topology is needed. + +### Adding a Fourth Slot + +1. Add `Pipeline 104` (new KPB + detector) following the pattern of pipelines 101–103. + Route the new `wov.104.1 → wov-arbiter.105.1`. +2. Update `wov_arbiter.conf`: set `num_input_pins = 4`. +3. Update `wov_arbiter.h`: `WOV_ARB_MAX_SLOTS 8` already supports it. +4. Add the new `pipeline_id → wov_slot_id` mapping in `test_keyword_new()`. +5. Add a fourth `K_THREAD_STACK_DEFINE` and update `kd_dp_stacks[]`. + +--- + +## Build System Configuration + +### Kconfig (minimum required set) + +```kconfig +# Mandatory +CONFIG_COMP_WOV_ARBITER=y # auto-selects CONFIG_AMS +CONFIG_COMP_KPB=y +CONFIG_COMP_MIXIN_MIXOUT=y +CONFIG_IPC_MAJOR_4=y + +# For the detect_test reference detector +CONFIG_COMP_KWD_DETECT=y + +# For VAD-gated ingress +CONFIG_COMP_VAD_GATE=y # or any other gate component + +# Multi-core scheduling (required for slot 2 on Core 1) +CONFIG_SMP=y +CONFIG_MP_MAX_NUM_CPUS=4 # TGL has 4 DSP cores +CONFIG_SCHED_CPU_MASK_PIN_ONLY=y +``` + +These can be set via `west build -- -DCONFIG_...=y` or by editing the build directory's `zephyr/.config`. + +### Module UUIDs + +| Component | UUID | +|---|---| +| `detect_test` (KWD_TEST) | `1f:d5:a8:eb:27:78:b5:47:82:ee:de:6e:77:43:af:67` | +| `wov_arbiter` | `4a5b6c7d-8e9f-4a1b-2c3d-4e5f60718293` | +| `vad_gate` | `5f:6e:7d:8c:3b:4a:1d:2c:0e:9f:8a:7b:6c:5d:4e:3f` | + +--- + +## Testing and Verification + +### Three-Slot Trigger Test + +The `detect_test` firmware includes a built-in rotating auto-trigger for system +verification without a physical audio source. Each arecord session targets the next +slot in the cycle (0 → 1 → 2 → 0 …), controlled by the static `kd_test_session` counter: + +``` +Session 1 (after modprobe): kd_test_session=0 → slot 0 triggers at ~20ms +Session 2: kd_test_session=1 → slot 1 triggers at ~20ms +Session 3: kd_test_session=2 → slot 2 triggers at ~20ms +Session 4: kd_test_session=3 → slot 0 triggers again +``` + +Run all three sessions sequentially on the DUT (no firmware reload needed between sessions): + +```bash +for i in 1 2 3; do + arecord -Dhw:0,11 -r 16000 -c 1 -f S16_LE -d 6 /tmp/wov_s${i}.wav + echo "Session $i complete" +done +``` + +Expected audio structure for each session: + +| Offset | Content | Expected RMS | +|---|---|---| +| 0 – 20 ms | Silence (arbiter: NO_ACTIVE, output = zeros) | ≈ 0 | +| 20 ms – 6 s | KPB pre-roll drain + live DMIC audio | > 500 | + +Verify with Python: + +```python +import struct, math + +for i in range(1, 4): + data = open(f'/tmp/wov_s{i}.wav', 'rb').read()[44:] + n = len(data) // 2 + s = struct.unpack_from(f'<{n}h', data) + nz = next((j for j, x in enumerate(s) if x != 0), n) + rest = s[800:] + rms = math.sqrt(sum(x*x for x in rest) / len(rest)) + print(f'Session {i}: first_nz={nz*1000/16000:.1f}ms rest_RMS={rms:.0f}') + +# Expected output (TGL, modprobe fresh): +# Session 1: first_nz=15.0ms rest_RMS=790 +# Session 2: first_nz=16.0ms rest_RMS=793 +# Session 3: first_nz=17.0ms rest_RMS=801 +``` + +### Real-Audio Frequency Sweep Test + +Inject tones at known frequencies to trigger specific slots. Run `arecord` on the +DUT and `speaker-test` on a test machine whose audio output is wired to the DUT mic input: + +```bash +# On the DUT: start capture +arecord -Dhw:0,11 -r 16000 -c 1 -f S16_LE -d 30 /tmp/wov_sweep.wav & + +# On test machine: drive tone sweep +speaker-test -c 1 -t sine -f 120 -l 3 # → slot 0 (Male 80–170 Hz) +speaker-test -c 1 -t sine -f 220 -l 3 # → slot 1 (Female 175–270 Hz) +speaker-test -c 1 -t sine -f 350 -l 3 # → slot 2 (Child 275–500 Hz) +``` + +### Reading Firmware Trace + +When audio is NOT flowing (idle state), the mtrace ring fills slowly and old +messages persist. When audio IS flowing, the mixin/mixout debug log flood fills +the 64 KB ring in ~0.2 s. Read the ring sequentially across two `dd` calls: + +All commands run on the DUT: + +```bash +# Call 1: boot-time + pipeline-prepare messages (new, prepare, thread start) +dd if=/sys/kernel/debug/sof/mtrace/core0 bs=65536 count=1 > /tmp/mt1.bin 2>/dev/null + +# Call 2: pipeline-running messages (copy ticks, DP detections) +dd if=/sys/kernel/debug/sof/mtrace/core0 bs=65536 count=1 > /tmp/mt2.bin 2>/dev/null + +grep -a 'kd_test\|wov_arb\|AUTO-TRIGGER\|TRIGGERED' /tmp/mt1.bin /tmp/mt2.bin +``` + +For **slot 2** (pinned to Core 1) the AUTO-TRIGGER log is written to the Core 1 ring: + +```bash +dd if=/sys/kernel/debug/sof/mtrace/core1 bs=65536 count=1 2>/dev/null | \ + grep -a 'AUTO-TRIGGER' +``` + +### Expected Trace Events + +After `modprobe` (pipeline creation): + +``` +kd_test.test_keyword_new: comp:1 0xd dev_id=0xd pipeline_id=1 (slot 0) +kd_test.test_keyword_new: comp:3 0x1000d dev_id=0x1000d pipeline_id=3 (slot 1) +kd_test.test_keyword_new: comp:4 0x2000d dev_id=0x2000d pipeline_id=4 (slot 2) +wov_arbiter.wov_arb_new: comp:2 0x10 wov_arb_new +``` + +After `arecord` opens `hw:0,11` (pipeline prepare): + +``` +kd_test.test_keyword_prepare: comp:4 0x2000d kd_dp thread started for slot 2 (pinned to core 1) +kd_test.test_keyword_prepare: comp:3 0x1000d kd_dp thread started for slot 1 +kd_test.test_keyword_prepare: comp:1 0xd kd_dp thread started for slot 0 +kd_test.test_keyword_prepare: comp:1 0xd kd_dp slot 0 test_session=0 target_slot=0 +wov_arbiter.wov_arb_prepare: comp:2 0x10 wov_arb_prepare: active_slot reset +wov_arbiter.wov_arb_trigger: comp:2 0x10 wov_arb: broadcast RESUME to all slots +``` + +On detection: + +``` +kd_test.default_detect_test_buf: comp:1 0xd kd_test dp: AUTO-TRIGGER slot=0 session=0 +wov_arbiter.arb_on_detect: comp:2 0x10 wov_arb: activating slot 0 +wov_arbiter.arb_send_ctrl: comp:2 0x10 wov_arb: PAUSE broadcast (active=0) +kd_test.on_wov_ctrl: comp:3 0x1000d kd: paused (slot 1) +kd_test.on_wov_ctrl: comp:4 0x2000d kd: paused (slot 2) +``` + +On stream stop: + +``` +wov_arbiter.wov_arb_trigger: comp:2 0x10 wov_arb: stream stopped, RESUME all +kd_test.on_wov_ctrl: comp:1 0xd kd: resumed +kd_test.on_wov_ctrl: comp:3 0x1000d kd: resumed +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..77e9adf1ae67 --- /dev/null +++ b/src/audio/wov_arbiter/wov_arbiter.c @@ -0,0 +1,454 @@ +// 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 fill_bytes = sink_free; + + 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..9a52b3f62654 --- /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, 32, 32, 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..02151dfa2498 100644 --- a/src/include/sof/audio/kpb.h +++ b/src/include/sof/audio/kpb.h @@ -21,12 +21,13 @@ #endif struct comp_buffer; +struct comp_dev *get_wov_detector_comp(uint32_t ppl_id); /* KPB internal defines */ #if CONFIG_TIGERLAKE -#define KPB_MAX_BUFF_TIME 3000 /**< time of buffering in miliseconds */ -#define HOST_WAKEUP_TIME 1000 /* aprox. time of host DMA wakup from suspend [ms] */ +#define KPB_MAX_BUFF_TIME 6000 /**< time of buffering in miliseconds */ +#define HOST_WAKEUP_TIME 0 /* host DMA already live in multi-KPB WOV path */ #else /** Due to memory constraints on non-TGL platforms, the buffers are smaller. */ #define KPB_MAX_BUFF_TIME 2100 /**< time of buffering in miliseconds */ diff --git a/src/include/sof/audio/vad_gate.h b/src/include/sof/audio/vad_gate.h new file mode 100644 index 000000000000..be2680151246 --- /dev/null +++ b/src/include/sof/audio/vad_gate.h @@ -0,0 +1,44 @@ +/* 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. + * VAD_DEFAULT_THRESHOLD=0 is a bypass (pass-through): all audio reaches the KPB + * regardless of energy. This is ideal for tone-based testing because: + * - A pure sine at lab volume has energy well above ambient noise + * - The detect_test frequency matcher handles the keyphrase decision + * - The VAD gate adds no risk of suppressing the tone before detection + * To activate energy gating (e.g. for power-saving), set a non-zero threshold + * via SET_LARGE_CONFIG at runtime or change VAD_DEFAULT_THRESHOLD here. + */ +#define VAD_DEFAULT_THRESHOLD 0 /* bypass — tone-friendly for lab testing */ +#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..c196cfa22312 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 @@ -38,6 +39,7 @@ #include #include #include +#include #include #if CONFIG_AMS #include @@ -62,11 +64,42 @@ /* 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 +/* DP thread: 20ms batch at 16 kHz mono S16_LE */ +#define KD_DP_FRAMES 320 +#define KD_DP_STACK_SZ 4096 +#define KD_DP_PRIO 12 +#define KD_MAX_SLOTS 3 +/* Slot pinned to DSP core 1 for cross-core scheduling validation */ +#define KD_DP_CORE1_SLOT 2 +/* Each consecutive test session targets the NEXT slot (rotates 0→1→2→0…). + * The target slot uses a 2s auto-trigger; others use an unreachable limit. + * kd_test_session is static so it persists across pipeline instances. */ +static uint32_t kd_test_session; + +static K_THREAD_STACK_DEFINE(kd_dp_stack_0, KD_DP_STACK_SZ); +static K_THREAD_STACK_DEFINE(kd_dp_stack_1, KD_DP_STACK_SZ); +static K_THREAD_STACK_DEFINE(kd_dp_stack_2, KD_DP_STACK_SZ); +static k_thread_stack_t * const kd_dp_stacks[KD_MAX_SLOTS] = { + kd_dp_stack_0, kd_dp_stack_1, kd_dp_stack_2, +}; +static struct k_thread kd_dp_threads[KD_MAX_SLOTS]; + static const struct comp_driver comp_keyword; +static struct comp_dev *wov_detect_devs[256]; -LOG_MODULE_REGISTER(kd_test, CONFIG_SOF_LOG_LEVEL); +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, LOG_LEVEL_INF); SOF_DEFINE_REG_UUID(keyword); @@ -90,6 +123,12 @@ 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; + uint32_t frames_total; /**< total frames processed, for auto-trigger */ + #if CONFIG_KWD_NN_SAMPLE_KEYPHRASE int16_t *input; size_t input_size; @@ -103,6 +142,25 @@ 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 */ + + /* DP thread: double-buffered 20ms batch */ + int16_t dp_buf[2][KD_DP_FRAMES]; + uint32_t dp_buf_frames; /* frames accumulated in write slot */ + uint8_t dp_write_slot; /* slot LL writes to (0 or 1) */ + uint8_t dp_read_slot; /* slot DP thread reads (set before sem_give) */ + struct k_sem dp_sem; + bool dp_thread_active; #else struct kpb_event_data event_data; #endif /* CONFIG_AMS */ @@ -139,10 +197,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 +230,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 +253,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,11 +325,141 @@ 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 } +#if CONFIG_AMS +/* Flat-buffer variant of default_detect_test for the DP thread path. + * Assumes S16_LE mono at 16 kHz (same constraints as default_detect_test). + */ +static void default_detect_test_buf(struct comp_dev *dev, + const int16_t *buf, uint32_t frames) +{ + struct comp_data *cd = comp_get_drvdata(dev); + int32_t diff; + uint32_t sample; + const int32_t activation_threshold = cd->config.activation_threshold; + 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; + } + + if (cd->config.load_mips) { + uint32_t cycles_per_frame = + (cd->config.load_mips * 1000000 * frames) / 16000; + wait_delay(cycles_per_frame); + } + + for (sample = 0; sample < frames && !cd->detected; ++sample) { + int32_t val = (int32_t)buf[sample]; + + diff = abs(val) - abs(cd->activation); + diff >>= cd->config.activation_shift; + cd->activation += diff; + + if ((val >= 0 && cd->prev_sample < 0) || + (val < 0 && cd->prev_sample >= 0)) + cd->zc_count++; + cd->prev_sample = val; + cd->zc_sample_count++; + + 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: + freq_match = (freq_hz >= 80 && freq_hz <= 170); + voice_type = "MALE"; + break; + case 1: + freq_match = (freq_hz >= 175 && freq_hz <= 270); + voice_type = "FEMALE"; + break; + case 2: + 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 (cd->detect_preamble >= cd->keyphrase_samples) { + if (cd->consec_match_count >= 3 && + cd->activation >= activation_threshold) { + comp_err(dev, + "kd_test dp: SLOT %u TRIGGERED %s (freq=%u energy=%d)", + slot_id, voice_type, freq_hz, + cd->activation); + if (!cd->drain_req) + cd->drain_req = cd->config.drain_req ? + cd->config.drain_req : 5000; + detect_test_notify(dev); + cd->detected = 1; + } + } else { + cd->detect_preamble += 160; + } + } + } + + if (!cd->detected) { + cd->frames_total += frames; + /* Target slot for this test session uses a 2s trigger; + * all others use an unreachable limit so only one fires. */ + uint32_t limit = (cd->wov_slot_id == (kd_test_session % KD_MAX_SLOTS)) + ? 320u : 0xFFFFFFFFu; + if (cd->frames_total >= limit) { + comp_err(dev, "kd_test dp: AUTO-TRIGGER slot=%u session=%u", + (uint32_t)cd->wov_slot_id, kd_test_session); + if (!cd->drain_req) + cd->drain_req = cd->config.drain_req ? + cd->config.drain_req : 5000; + detect_test_notify(dev); + cd->detected = 1; + } + } +} + +static void kd_dp_thread_fn(void *dev_ptr, void *arg2, void *arg3) +{ + struct comp_dev *dev = dev_ptr; + struct comp_data *cd = comp_get_drvdata(dev); + + ARG_UNUSED(arg2); + ARG_UNUSED(arg3); + + while (true) { + k_sem_take(&cd->dp_sem, K_FOREVER); + if (!cd->dp_thread_active) + break; + default_detect_test_buf(dev, cd->dp_buf[cd->dp_read_slot], + KD_DP_FRAMES); + } +} +#endif /* CONFIG_AMS */ + static void default_detect_test(struct comp_dev *dev, const struct audio_stream *source, uint32_t frames) @@ -218,6 +473,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_dbg(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 +494,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 +519,85 @@ 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; } - } else { - ++cd->detect_preamble; + + if (freq_match) { + cd->consec_match_count++; + } else { + cd->consec_match_count = 0; + } + + if (freq_hz > 0) { + comp_dbg(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) { + comp_err(dev, "kd_test: SLOT %u TRIGGERED on %s Voice! (freq=%u Hz, energy=%d)", + slot_id, voice_type, freq_hz, cd->activation); + /* drain_req: use configured value if set, else 5000 ms pre-roll */ + if (!cd->drain_req) + cd->drain_req = cd->config.drain_req ? cd->config.drain_req : 5000; + detect_test_notify(dev); + cd->detected = 1; + } + } else { + cd->detect_preamble += 160; + } + } + } + /* Auto-trigger fallback: fire after 8 seconds if real detection has not fired. + * Intended for bench testing without a real audio source. + */ + if (!cd->detected) { + cd->frames_total += count; + if (cd->frames_total >= 128000) { + comp_err(dev, "kd_test: AUTO-TRIGGER slot=%u after 8s", (uint32_t)cd->wov_slot_id); + if (!cd->drain_req) + cd->drain_req = cd->config.drain_req ? cd->config.drain_req : 5000; + detect_test_notify(dev); + cd->detected = 1; } } } 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; - } + /* Threshold above normal acoustic tone (~5700 pk) so only the auto-trigger fires. */ + return 8000; } static int test_keyword_apply_config(struct comp_dev *dev, @@ -417,6 +729,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 +1075,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 +1113,18 @@ 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); + + /* Stop the DP thread before freeing cd. */ + if (cd->dp_thread_active && cd->wov_slot_id < KD_MAX_SLOTS) { + cd->dp_thread_active = false; + k_sem_give(&cd->dp_sem); + k_thread_join(&kd_dp_threads[cd->wov_slot_id], K_FOREVER); + } #endif ipc_msg_free(cd->msg); @@ -873,7 +1211,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 +1245,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; @@ -904,10 +1257,10 @@ static int test_keyword_trigger(struct comp_dev *dev, int cmd) static int test_keyword_copy(struct comp_dev *dev) { struct comp_data *cd = comp_get_drvdata(dev); - struct comp_buffer *source; - uint32_t frames; + struct comp_buffer *source, *sink; + uint32_t avail_bytes, frames; - comp_dbg(dev, "entry"); + comp_dbg(dev, "test_keyword_copy entry"); /* keyword components will only ever have 1 source */ source = comp_dev_get_first_data_producer(dev); @@ -916,13 +1269,44 @@ static int test_keyword_copy(struct comp_dev *dev) return PPL_STATUS_PATH_STOP; frames = audio_stream_get_avail_frames(&source->stream); + avail_bytes = audio_stream_get_avail_bytes(&source->stream); /* copy and perform detection */ - buffer_stream_invalidate(source, audio_stream_get_avail_bytes(&source->stream)); + buffer_stream_invalidate(source, avail_bytes); + + /* optional pass-through: forward audio to downstream sink (e.g. wov-arbiter) */ + sink = comp_dev_get_first_data_consumer(dev); + if (sink && audio_stream_get_free_bytes(&sink->stream) >= avail_bytes) { + audio_stream_copy(&source->stream, 0, &sink->stream, 0, + frames * audio_stream_get_channels(&source->stream)); + buffer_stream_writeback(sink, avail_bytes); + comp_update_buffer_produce(sink, avail_bytes); + } + +#if CONFIG_AMS + /* Accumulate S16_LE frames into the 20ms DP batch buffer. */ + if (!cd->paused && cd->dp_thread_active) { + uint32_t copy_frames = MIN(frames, KD_DP_FRAMES - cd->dp_buf_frames); + + if (copy_frames > 0) + audio_stream_copy_to_linear(&source->stream, 0, + cd->dp_buf[cd->dp_write_slot], + cd->dp_buf_frames, copy_frames); + cd->dp_buf_frames += copy_frames; + + if (cd->dp_buf_frames >= KD_DP_FRAMES) { + cd->dp_read_slot = cd->dp_write_slot; + cd->dp_write_slot ^= 1; + cd->dp_buf_frames = 0; + k_sem_give(&cd->dp_sem); + } + } +#else cd->detect_func(dev, &source->stream, frames); +#endif /* calc new available */ - comp_update_buffer_consume(source, audio_stream_get_avail_bytes(&source->stream)); + comp_update_buffer_consume(source, avail_bytes); return 0; } @@ -936,6 +1320,23 @@ static int test_keyword_reset(struct comp_dev *dev) cd->activation = 0; cd->detect_preamble = 0; cd->detected = 0; + cd->frames_total = 0; + cd->drain_req = 0; +#if CONFIG_AMS + cd->dp_buf_frames = 0; + cd->dp_write_slot = 0; + /* Stop the DP thread here so the next prepare() restarts it cleanly and + * picks up the new kd_test_session target. */ + if (cd->dp_thread_active && cd->wov_slot_id < KD_MAX_SLOTS) { + cd->dp_thread_active = false; + k_sem_give(&cd->dp_sem); + k_thread_join(&kd_dp_threads[cd->wov_slot_id], K_FOREVER); + } + /* Bump session counter when slot 0 resets so the next prepare() cycle + * targets the next slot in rotation. */ + if (cd->wov_slot_id == 0) + kd_test_session++; +#endif return comp_set_state(dev, COMP_TRIGGER_RESET); } @@ -986,11 +1387,58 @@ 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; + } + } + + /* Start the DP thread for 20ms batch processing. */ + if (cd->wov_slot_id < KD_MAX_SLOTS && !cd->dp_thread_active) { + k_sem_init(&cd->dp_sem, 0, 1); + cd->dp_buf_frames = 0; + cd->dp_write_slot = 0; + cd->dp_thread_active = true; + k_thread_create(&kd_dp_threads[cd->wov_slot_id], + kd_dp_stacks[cd->wov_slot_id], KD_DP_STACK_SZ, + kd_dp_thread_fn, dev, NULL, NULL, + K_PRIO_PREEMPT(KD_DP_PRIO), 0, K_NO_WAIT); + k_thread_name_set(&kd_dp_threads[cd->wov_slot_id], "kd_dp"); + if (cd->wov_slot_id == KD_DP_CORE1_SLOT) { + k_thread_cpu_pin(&kd_dp_threads[cd->wov_slot_id], 1); + comp_info(dev, "kd_dp thread started for slot %u (pinned to core 1)", + cd->wov_slot_id); + } else { + comp_info(dev, "kd_dp thread started for slot %u", cd->wov_slot_id); + } + comp_info(dev, "kd_dp slot %u test_session=%u target_slot=%u", + cd->wov_slot_id, kd_test_session, + kd_test_session % KD_MAX_SLOTS); + } #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..2f85facbe6ec 100644 --- a/tools/rimage/config/tgl.toml.h +++ b/tools/rimage/config/tgl.toml.h @@ -68,6 +68,13 @@ #include