Skip to content

audio: kpb: add a Zephyr-native notification mechanism #11227

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
lgirdwood merged 1 commit into from
Sep 28, 2026
+92 −9
Merged

audio: kpb: add a Zephyr-native notification mechanism #11227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/audio/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,14 @@ config COMP_KPB
default y
help
Select for KPB component

if COMP_KPB

config KPB_CLI_Q
bool "Use a client queue for KPB"
help
Use a Zephyr queue instead of SOF notifiers

config KPB_FORCE_COPY_TYPE_NORMAL
bool "KPB force copy type normal"
default y
Expand Down
81 changes: 72 additions & 9 deletions src/audio/kpb.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
#include <rtos/alloc.h>
#include <rtos/clk.h>
#include <rtos/init.h>
#include <rtos/symbol.h>
#include <sof/lib/pm_runtime.h>
#include <sof/lib/uuid.h>
#include <sof/list.h>
Expand Down Expand Up @@ -107,13 +108,19 @@ struct comp_data {
struct kpb_fmt_dev_list fmt_device_list;
struct fast_mode_task fmt;

#if CONFIG_AMS
#if CONFIG_AMS && !CONFIG_KPB_CLI_Q
uint32_t kpd_uuid_id;
#endif
};

/*! KPB private functions */
#ifndef CONFIG_AMS
#if CONFIG_KPB_CLI_Q
#include <zephyr/kernel.h>

static struct k_queue *kpb_q;
static struct k_thread kpb_thread;
K_KERNEL_STACK_DEFINE(kpb_stack, 4096);
Comment on lines +120 to +122

@lyakh lyakh Sep 23, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm, I was assuming that multiple KPB instances don't make sense, but maybe I was wrong. Let me fix that.

@lyakh lyakh Sep 23, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alright, checked that: currently neither the notifier nor the AMS version support multiple KPB instances. The notifier version only supports a single handler per type (as in NOTIFIER_ID_KPB_CLIENT_EVT), and AMS could support routing to multiple handlers in principle, but current clients don't support it either: e.g.

sof/src/samples/audio/detect_test.c

Line 163 in b6c6a05

cd->client_data.id = 0; /**< TODO: acquire proper id from kpb */

#elif !CONFIG_AMS
static void kpb_event_handler(void *arg, enum notify_id type, void *event_data);
static int kpb_register_client(struct comp_data *kpb, struct kpb_client *cli);
#endif
Expand Down Expand Up @@ -176,7 +183,7 @@ static uint64_t kpb_task_deadline(void *data)
#endif
}

#if CONFIG_AMS
#if CONFIG_AMS && !CONFIG_KPB_CLI_Q

/* Key-phrase detected message*/
static const ams_uuid_t ams_kpd_msg_uuid = AMS_KPD_MSG_UUID;
Expand Down Expand Up @@ -456,6 +463,42 @@ static void kpb_set_params(struct comp_dev *dev,

static int kpb_params(struct comp_dev *dev, struct sof_ipc_stream_params *params);

#if CONFIG_KPB_CLI_Q
static void kpb_thread_fn(void *p1, void *p2, void *p3)
{
struct k_queue *q = p1;

for (;;) {
struct kpb_client *cli = k_queue_get(q, K_FOREVER);

kpb_init_draining(cli->dev, cli);
}
}

void kpb_notifier_schedule(struct kpb_client *cli)
{
k_queue_alloc_append(cli->queue, cli);
}
EXPORT_SYMBOL(kpb_notifier_schedule);

void z_impl_kpb_notifier_init(struct comp_dev *dev, struct kpb_client *cli)
{
comp_dbg(dev, "adding new client to %p", kpb_q);
k_thread_access_grant(k_current_get(), kpb_q);
cli->queue = kpb_q;
cli->dev = dev;
}

#include <zephyr/internal/syscall_handler.h>
void z_vrfy_kpb_notifier_init(struct comp_dev *dev, struct kpb_client *cli)
{
K_OOPS(K_SYSCALL_MEMORY_WRITE(dev, sizeof(*dev)));
K_OOPS(K_SYSCALL_MEMORY_WRITE(cli, sizeof(*cli)));
z_impl_kpb_notifier_init(dev, cli);
}
#include <zephyr/syscalls/kpb_notifier_init_mrsh.c>
#endif

/*
* \brief Create a key phrase buffer component.
* \param[in] config - generic ipc component pointer.
Expand Down Expand Up @@ -484,7 +527,7 @@ static struct comp_dev *kpb_new(const struct comp_driver *drv,
struct comp_data *kpb;
int ret;

comp_cl_info(&comp_kpb, "kpb_new()");
comp_cl_info(&comp_kpb, "entry");

/* make sure data size is not bigger than config space */
if (ipc_config_size > kpb_config_size) {
Expand Down Expand Up @@ -548,6 +591,21 @@ static struct comp_dev *kpb_new(const struct comp_driver *drv,
}
#endif

#if CONFIG_KPB_CLI_Q
kpb_q = k_object_alloc(K_OBJ_QUEUE);
if (!kpb_q) {
comp_free_device(dev);
return NULL;
}

k_queue_init(kpb_q);
k_thread_create(&kpb_thread, kpb_stack, 4096, kpb_thread_fn, kpb_q, NULL, NULL,
1, 0, K_FOREVER);

k_thread_cpu_pin(&kpb_thread, cpu_get_id());
k_thread_start(&kpb_thread);
#endif

return dev;
}

Expand Down Expand Up @@ -693,7 +751,10 @@ static void kpb_free(struct comp_dev *dev)

comp_info(dev, "entry");

#if CONFIG_AMS
#if CONFIG_KPB_CLI_Q
k_thread_abort(&kpb_thread);
k_object_free(kpb_q);
#elif CONFIG_AMS
/* Unregister KPB as AMS consumer */
int ret;

Expand All @@ -704,7 +765,7 @@ static void kpb_free(struct comp_dev *dev)
#else
/* Unregister KPB from notifications */
notifier_unregister(dev, NULL, NOTIFIER_ID_KPB_CLIENT_EVT);
#endif/* CONFIG_AMS */
#endif/* CONFIG_KPB_CLI_Q */

/* Reclaim memory occupied by history buffer */
kpb_free_history_buffer(kpb->hd.c_hb);
Expand Down Expand Up @@ -780,7 +841,7 @@ static int kpb_params(struct comp_dev *dev,
kpb->host_period_size = params->host_period_bytes;
kpb->config.sampling_width = params->sample_container_bytes * 8;

#if CONFIG_AMS
#if !CONFIG_KPB_CLI_Q && CONFIG_AMS
kpb->kpd_uuid_id = AMS_INVALID_MSG_TYPE;
#endif

Expand Down Expand Up @@ -869,16 +930,18 @@ static int kpb_prepare(struct comp_dev *dev)
kpb->clients[i].r_ptr = NULL;
}

#if !CONFIG_KPB_CLI_Q
#if CONFIG_AMS
/* AMS Register KPB for notification */
ret = ams_helper_register_consumer(dev, &kpb->kpd_uuid_id,
Comment thread
lyakh marked this conversation as resolved.
ams_kpd_msg_uuid,
kpb_ams_kpd_notification);
#else
/* Register KPB for notification */
/* Register KPB for notification *on the current core* */
ret = notifier_register(dev, NULL, NOTIFIER_ID_KPB_CLIENT_EVT,
kpb_event_handler, 0);
#endif /* CONFIG_AMS */
#endif

if (ret < 0) {
kpb_free_history_buffer(kpb->hd.c_hb);
Expand Down Expand Up @@ -1010,7 +1073,7 @@ static int kpb_reset(struct comp_dev *dev)
kpb_reset_history_buffer(kpb->hd.c_hb);
}

#ifndef CONFIG_AMS
#if !CONFIG_KPB_CLI_Q && !CONFIG_AMS
/* Unregister KPB from notifications */
notifier_unregister(dev, NULL, NOTIFIER_ID_KPB_CLIENT_EVT);
#endif
Expand Down
13 changes: 13 additions & 0 deletions src/include/sof/audio/kpb.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ enum kpb_client_state {
};

struct kpb_client {
struct comp_dev *dev;
struct k_queue *queue;
uint8_t id; /**< id associated with output sink */
uint32_t drain_req; /**< normalized value of buffered bytes */
enum kpb_client_state state; /**< current state of a client */
Expand Down Expand Up @@ -253,6 +255,17 @@ struct kpb_fmt_dev_list {
struct comp_dev *kpb_mi_ptr;
};

#if CONFIG_KPB_CLI_Q
void kpb_notifier_schedule(struct kpb_client *cli);
#if defined(__ZEPHYR__) && defined(CONFIG_SOF_FULL_ZEPHYR_APPLICATION)
#include <sof/compiler_attributes.h>
__syscall void kpb_notifier_init(struct comp_dev *dev, struct kpb_client *cli);
Comment on lines +258 to +262

@lgirdwood lgirdwood Sep 28, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lyakh can you update doxygen incrementally we have a few gaps here and in other places.

#include <zephyr/syscalls/kpb.h>
#else
#define kpb_notifier_init z_impl_kpb_notifier_init
#endif
#endif

#ifdef UNIT_TEST
void sys_comp_kpb_init(void);
#endif
Expand Down
1 change: 1 addition & 0 deletions zephyr/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -623,6 +623,7 @@ zephyr_library_sources_ifdef(CONFIG_SHELL
zephyr_syscall_header(include/sof/lib/cpu.h)
zephyr_library_sources_ifdef(CONFIG_USERSPACE syscall/cpu.c)
zephyr_syscall_header(${SOF_SRC_PATH}/include/sof/audio/module_adapter/module/generic.h)
zephyr_syscall_header(${SOF_SRC_PATH}/include/sof/audio/kpb.h)
zephyr_syscall_header(${SOF_SRC_PATH}/include/sof/lib/fast-get.h)
zephyr_syscall_header(${SOF_SRC_PATH}/include/sof/ipc/ipc_reply.h)
zephyr_syscall_header(${SOF_SRC_PATH}/include/sof/schedule/dp_schedule.h)
Expand Down
Loading