userspace_proxy.h

Go to the documentation of this file.

/* 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>
#include <zephyr/app_memory/app_memdomain.h>
#include <utilities/array.h>
 
#include <native_system_agent.h>
#include <module/module/interface.h>
#include <sof/audio/module_adapter/library/userspace_proxy_user.h>
 
struct module_interface;
struct comp_driver;
struct sof_man_module;
struct system_agent_params;
 
/* Processing module structure fields needed for user mode */
struct userspace_context {
    struct k_mem_domain *comp_dom;          /* Module specific memory domain    */
    const struct module_interface *interface;   /* Userspace module interface       */
    struct user_work_item *work_item;       /* work item for user worker thread */
    struct k_event *dp_event;           /* DP thread event          */
};
#endif /* CONFIG_USERSPACE */
 
#if CONFIG_SOF_USERSPACE_PROXY
int userspace_proxy_create(struct userspace_context **user_ctx, const struct comp_driver *drv,
               const struct sof_man_module *manifest, system_agent_start_fn start_fn,
               const struct system_agent_params *agent_params,
               const void **agent_interface, const struct module_interface **ops);

void userspace_proxy_destroy(const struct comp_driver *drv, struct userspace_context *user_ctx);
 
#if IS_ENABLED(CONFIG_SOF_USERSPACE_MOD_IPC_BY_DP_THREAD)
struct k_work_user *userspace_proxy_register_ipc_handler(struct processing_module *mod,
                             struct k_event *event);
#endif
 
#endif /* CONFIG_SOF_USERSPACE_PROXY */
 
#endif /* __SOF_AUDIO_USERSPACE_PROXY_H__ */