userspace: Add userspace_context and common_partition memory domain

Introduce the userspace_context structure to store data required by modules
operating in userspace.

Add the common_partition memory domain to share SOF components that need
to be accessible from userspace.

Signed-off-by: Adrian Warecki <adrian.warecki@intel.com>

Author: softwarecki

src/audio/buffers/comp_buffer.c

@@ -11,6 +11,7 @@
 #include <sof/audio/sink_api.h>
 #include <sof/audio/source_api.h>
 #include <sof/audio/sink_source_utils.h>
+#include <rtos/userspace_helper.h>
 #include <sof/common.h>
 #include <rtos/interrupt.h>
 #include <rtos/alloc.h>
@@ -161,7 +162,7 @@ static void comp_buffer_free(struct sof_audio_buffer *audio_buffer)
 	rfree(buffer);
 }
 
-static const struct source_ops comp_buffer_source_ops = {
+APP_TASK_DATA static const struct source_ops comp_buffer_source_ops = {
 	.get_data_available = comp_buffer_get_data_available,
 	.get_data = comp_buffer_get_data,
 	.release_data = comp_buffer_release_data,
@@ -170,7 +171,7 @@ static const struct source_ops comp_buffer_source_ops = {
 	.set_alignment_constants = audio_buffer_source_set_alignment_constants,
 };
 
-static const struct sink_ops comp_buffer_sink_ops = {
+APP_TASK_DATA static const struct sink_ops comp_buffer_sink_ops = {
 	.get_free_size = comp_buffer_get_free_size,
 	.get_buffer = comp_buffer_get_buffer,
 	.commit_buffer = comp_buffer_commit_buffer,

src/include/module/module/base.h

@@ -15,6 +15,7 @@
 
 #include "interface.h"
 #include "../ipc4/base-config.h"
+#include <rtos/userspace_helper.h>
 
 #define module_get_private_data(mod) ((mod)->priv.private)
 #define module_set_private_data(mod, data) ((mod)->priv.private = data)
@@ -180,6 +181,7 @@ struct processing_module {
 	uint32_t max_sinks;
 
 	enum module_processing_type proc_type;
+	struct userspace_context *user_ctx;
 #endif /* SOF_MODULE_PRIVATE */
 };
 

src/include/sof/audio/module_adapter/library/userspace_proxy.h

@@ -0,0 +1,25 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Copyright(c) 2025 Intel Corporation. All rights reserved.
+ *
+ * Author: Jaroslaw Stelter <jaroslaw.stelter@intel.com>
+ * Author: Adrian Warecki <adrian.warecki@intel.com>
+ */
+
+#ifndef __SOF_AUDIO_USERSPACE_PROXY_H__
+#define __SOF_AUDIO_USERSPACE_PROXY_H__
+
+#if CONFIG_USERSPACE
+#include <stdint.h>
+#include <stdbool.h>
+
+#include <zephyr/kernel.h>
+
+/* Processing module structure fields needed for user mode */
+struct userspace_context {
+	struct k_mem_domain *comp_dom;			/* Module specific memory domain	*/
+};
+
+#endif /* CONFIG_USERSPACE */
+
+#endif /* __SOF_AUDIO_USERSPACE_PROXY_H__ */

zephyr/include/rtos/userspace_helper.h

@@ -12,9 +12,20 @@
 #ifndef __ZEPHYR_LIB_USERSPACE_HELPER_H__
 #define __ZEPHYR_LIB_USERSPACE_HELPER_H__
 
-#ifdef CONFIG_USERSPACE
+#ifndef CONFIG_USERSPACE
+#define APP_TASK_BSS
+#define APP_TASK_DATA
+#else
+
+#include <zephyr/app_memory/app_memdomain.h>
+
 #define DRV_HEAP_SIZE	ALIGN_UP(CONFIG_SOF_ZEPHYR_USERSPACE_MODULE_HEAP_SIZE, \
 				 CONFIG_MM_DRV_PAGE_SIZE)
+#define APP_TASK_BSS	K_APP_BMEM(common_partition)
+#define APP_TASK_DATA	K_APP_DMEM(common_partition)
+
+struct processing_module;
+struct userspace_context;
 
 /**
  * Initialize private processing module heap.
@@ -29,6 +40,18 @@
  */
 struct sys_heap *module_driver_heap_init(void);
 
+/**
+ * Add DP scheduler created thread to module memory domain.
+ * @param thread_id - id of thread to be added to memory domain.
+ * @param module    - processing module structure
+ *
+ * @return 0 for success, error otherwise.
+ *
+ * @note
+ * Function used only when CONFIG_USERSPACE is set.
+ */
+int user_memory_init_shared(k_tid_t thread_id, struct processing_module *mod);
+
 #endif
 
 /**

zephyr/lib/userspace_helper.c

@@ -16,10 +16,19 @@
 
 #include <rtos/alloc.h>
 #include <rtos/userspace_helper.h>
+#include <sof/audio/module_adapter/module/generic.h>
+#include <sof/audio/module_adapter/library/userspace_proxy.h>
 
 #define MODULE_DRIVER_HEAP_CACHED		CONFIG_SOF_ZEPHYR_HEAP_CACHED
 
+/* Zephyr includes */
+#include <zephyr/kernel.h>
+#include <zephyr/app_memory/app_memdomain.h>
+
 #if CONFIG_USERSPACE
+
+K_APPMEM_PARTITION_DEFINE(common_partition);
+
 struct sys_heap *module_driver_heap_init(void)
 {
 	struct sys_heap *mod_drv_heap = rballoc(SOF_MEM_FLAG_USER, sizeof(struct sys_heap));
@@ -122,6 +131,18 @@ void module_driver_heap_remove(struct sys_heap *mod_drv_heap)
 	}
 }
 
+int user_memory_init_shared(k_tid_t thread_id, struct processing_module *mod)
+{
+	struct k_mem_domain *comp_dom = mod->user_ctx->comp_dom;
+	int ret;
+
+	ret = k_mem_domain_add_partition(comp_dom, &common_partition);
+	if (ret < 0)
+		return ret;
+
+	return k_mem_domain_add_thread(comp_dom, thread_id);
+}
+
 #else /* CONFIG_USERSPACE */
 
 void *module_driver_heap_rmalloc(struct sys_heap *mod_drv_heap, uint32_t flags, size_t bytes)