audio: pipeline: enable position reporting for user-space pipelines

Place the pipeline position lookup table in the sysuser memory
partition and replace k_spinlock with a dynamically allocated
k_mutex when CONFIG_SOF_USERSPACE_LL is enabled. Spinlocks disable
interrupts which is a privileged operation unavailable from
user-mode threads.

The mutex pointer is stored in a separate APP_SYSUSER_BSS variable
outside the SHARED_DATA struct so Zephyr's kernel object tracking
can recognize it for syscall verification.

Move pipeline_posn_init() from task_main_start() to
primary_core_init() before platform_init(), so the mutex is
allocated before ipc_user_init() grants thread access to it.

In pipeline_posn_get(), bypass the sof_get() kernel singleton and
access the shared structure directly when running in user-space.
Grant the ipc_user_init thread access to the pipeline position
mutex via new pipeline_posn_grant_access() helper.

Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>

Author: kv2019i

src/audio/pipeline/pipeline-graph.c

@@ -12,6 +12,7 @@
 #include <rtos/interrupt.h>
 #include <rtos/symbol.h>
 #include <rtos/alloc.h>
+#include <rtos/userspace_helper.h>
 #include <sof/lib/mm_heap.h>
 #include <sof/lib/uuid.h>
 #include <sof/compiler_attributes.h>
@@ -41,18 +42,33 @@ DECLARE_TR_CTX(pipe_tr, SOF_UUID(pipe_uuid), LOG_LEVEL_INFO);
 /* lookup table to determine busy/free pipeline metadata objects */
 struct pipeline_posn {
 	bool posn_offset[PPL_POSN_OFFSETS];	/**< available offsets */
+#ifndef CONFIG_SOF_USERSPACE_LL
 	struct k_spinlock lock;			/**< lock mechanism */
+#endif
 };
 /* the pipeline position lookup table */
-static SHARED_DATA struct pipeline_posn pipeline_posn_shared;
+static APP_SYSUSER_BSS SHARED_DATA struct pipeline_posn pipeline_posn_shared;
+
+#ifdef CONFIG_SOF_USERSPACE_LL
+/* Mutex pointer in user-accessible partition so user-space threads
+ * can read the pointer for syscalls. Kept outside the SHARED_DATA
+ * struct to avoid kernel object tracking issues.
+ */
+static APP_SYSUSER_BSS struct k_mutex *pipeline_posn_lock;
+#endif
 
 /**
  * \brief Retrieves pipeline position structure.
  * \return Pointer to pipeline position structure.
  */
 static inline struct pipeline_posn *pipeline_posn_get(void)
 {
+#ifdef CONFIG_SOF_USERSPACE_LL
+	return platform_shared_get(&pipeline_posn_shared,
+				   sizeof(pipeline_posn_shared));
+#else
 	return sof_get()->pipeline_posn;
+#endif
 }
 
 /**
@@ -65,9 +81,14 @@ static inline int pipeline_posn_offset_get(uint32_t *posn_offset)
 	struct pipeline_posn *pipeline_posn = pipeline_posn_get();
 	int ret = -EINVAL;
 	uint32_t i;
+
+#ifdef CONFIG_SOF_USERSPACE_LL
+	k_mutex_lock(pipeline_posn_lock, K_FOREVER);
+#else
 	k_spinlock_key_t key;
 
 	key = k_spin_lock(&pipeline_posn->lock);
+#endif
 
 	for (i = 0; i < PPL_POSN_OFFSETS; ++i) {
 		if (!pipeline_posn->posn_offset[i]) {
@@ -78,8 +99,11 @@ static inline int pipeline_posn_offset_get(uint32_t *posn_offset)
 		}
 	}
 
-
+#ifdef CONFIG_SOF_USERSPACE_LL
+	k_mutex_unlock(pipeline_posn_lock);
+#else
 	k_spin_unlock(&pipeline_posn->lock, key);
+#endif
 
 	return ret;
 }
@@ -92,22 +116,43 @@ static inline void pipeline_posn_offset_put(uint32_t posn_offset)
 {
 	struct pipeline_posn *pipeline_posn = pipeline_posn_get();
 	int i = posn_offset / sizeof(struct sof_ipc_stream_posn);
+
+#ifdef CONFIG_SOF_USERSPACE_LL
+	k_mutex_lock(pipeline_posn_lock, K_FOREVER);
+	pipeline_posn->posn_offset[i] = false;
+	k_mutex_unlock(pipeline_posn_lock);
+#else
 	k_spinlock_key_t key;
 
 	key = k_spin_lock(&pipeline_posn->lock);
-
 	pipeline_posn->posn_offset[i] = false;
-
 	k_spin_unlock(&pipeline_posn->lock, key);
+#endif
 }
 
 void pipeline_posn_init(struct sof *sof)
 {
 	sof->pipeline_posn = platform_shared_get(&pipeline_posn_shared,
 						 sizeof(pipeline_posn_shared));
+#ifdef CONFIG_SOF_USERSPACE_LL
+	pipeline_posn_lock = k_object_alloc(K_OBJ_MUTEX);
+	if (!pipeline_posn_lock) {
+		pipe_cl_err("pipeline posn mutex alloc failed");
+		k_panic();
+	}
+	k_mutex_init(pipeline_posn_lock);
+#else
 	k_spinlock_init(&sof->pipeline_posn->lock);
+#endif
 }
 
+#ifdef CONFIG_SOF_USERSPACE_LL
+void pipeline_posn_grant_access(struct k_thread *thread)
+{
+	k_thread_access_grant(thread, pipeline_posn_lock);
+}
+#endif
+
 /* create new pipeline - returns pipeline id or negative error */
 struct pipeline *pipeline_new(struct k_heap *heap, uint32_t pipeline_id, uint32_t priority,
 			      uint32_t comp_id, struct create_pipeline_params *pparams)
@@ -138,12 +183,17 @@ struct pipeline *pipeline_new(struct k_heap *heap, uint32_t pipeline_id, uint32_
 	p->pipeline_id = pipeline_id;
 	p->status = COMP_STATE_INIT;
 	p->trigger.cmd = COMP_TRIGGER_NO_ACTION;
+
+#ifdef CONFIG_SOF_USERSPACE_LL
+	LOG_WRN("pipeline trace settings cannot be copied");
+#else
 	ret = memcpy_s(&p->tctx, sizeof(struct tr_ctx), &pipe_tr,
 		       sizeof(struct tr_ctx));
 	if (ret < 0) {
 		pipe_err(p, "failed to copy trace settings");
 		goto free;
 	}
+#endif
 
 	ret = pipeline_posn_offset_get(&p->posn_offset);
 	if (ret < 0) {

src/include/sof/audio/pipeline.h

@@ -206,6 +206,14 @@ int pipeline_complete(struct pipeline *p, struct comp_dev *source,
  */
 void pipeline_posn_init(struct sof *sof);
 
+#ifdef CONFIG_SOF_USERSPACE_LL
+/**
+ * \brief Grants user-space thread access to pipeline position mutex.
+ * \param[in] thread Thread to grant access to.
+ */
+void pipeline_posn_grant_access(struct k_thread *thread);
+#endif
+
 /**
  * \brief Resets the pipeline and free runtime resources.
  * \param[in] p pipeline.

src/init/init.c

@@ -32,6 +32,7 @@
 #include <sof/schedule/dp_schedule.h>
 #include <sof/schedule/ll_schedule.h>
 #include <sof/schedule/ll_schedule_domain.h>
+#include <sof/audio/pipeline.h>
 #include <ipc/trace.h>
 #if CONFIG_IPC_MAJOR_4
 #include <ipc4/fw_reg.h>
@@ -222,6 +223,11 @@ __cold static int primary_core_init(int argc, char *argv[], struct sof *sof)
 	zephyr_ll_user_resources_init();
 #endif
 
+	/* init pipeline position offsets - must be before platform_init()
+	 * which calls ipc_init() -> ipc_user_init() that needs the posn mutex.
+	 */
+	pipeline_posn_init(sof);
+
 	/* init the platform */
 	if (platform_init(sof) < 0)
 		sof_panic(SOF_IPC_PANIC_PLATFORM);

src/ipc/ipc-common.c

@@ -453,6 +453,7 @@ __cold int ipc_user_init(void)
 	user_grant_dma_access_all(&ipc_user_thread);
 	user_access_to_mailbox(zephyr_ll_mem_domain(), &ipc_user_thread);
 	zephyr_ll_grant_access(&ipc_user_thread);
+	pipeline_posn_grant_access(&ipc_user_thread);
 	k_mem_domain_add_thread(zephyr_ll_mem_domain(), &ipc_user_thread);
 
 	k_thread_name_set(&ipc_user_thread, __func__);

zephyr/wrapper.c

@@ -176,9 +176,6 @@ int task_main_start(struct sof *sof)
 	/* init default audio components */
 	sys_comp_init(sof);
 
-	/* init pipeline position offsets */
-	pipeline_posn_init(sof);
-
 	return 0;
 }