userspace_helper.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>
 *     Adrian Warecki <adrian.warecki@intel.com>
 */

#ifndef __ZEPHYR_LIB_USERSPACE_HELPER_H__
#define __ZEPHYR_LIB_USERSPACE_HELPER_H__
 
#include <zephyr/kernel.h>
 
#ifndef CONFIG_USERSPACE
#define APP_TASK_BSS
#define APP_TASK_DATA
#define APP_SYSUSER_BSS
#define APP_SYSUSER_DATA
#else
#include <zephyr/cache.h>
#include <zephyr/app_memory/app_memdomain.h>
 
#define USER_MOD_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)
 
#ifdef CONFIG_SOF_USERSPACE_LL
#define APP_SYSUSER_BSS K_APP_BMEM(sysuser_partition)
#define APP_SYSUSER_DATA    K_APP_DMEM(sysuser_partition)
#else
#define APP_SYSUSER_BSS
#define APP_SYSUSER_DATA
#endif
 
struct processing_module;
struct userspace_context;

struct k_heap *module_driver_heap_init(void);

int user_memory_attach_common_partition(struct k_mem_domain *dom);
 
#endif

void *user_stack_allocate(size_t stack_size, uint32_t options);

int user_stack_free(void *p_stack);

void module_driver_heap_remove(struct k_heap *mod_drv_heap);
 
#ifdef CONFIG_USERSPACE

int user_access_to_mailbox(struct k_mem_domain *domain, k_tid_t thread_id);

static inline uint32_t user_get_partition_cache_attr(uintptr_t ptr)
{
    return sys_cache_is_ptr_cached(UINT_TO_POINTER(ptr)) ? XTENSA_MMU_CACHED_WB : 0;
}

void user_grant_dai_access_all(struct k_thread *thread);

void user_grant_dma_access_all(struct k_thread *thread);
 
#else
 
static inline int user_access_to_mailbox(struct k_mem_domain *domain, k_tid_t thread_id)
{
    return 0;
}
 
#endif /* CONFIG_USERSPACE */
 
#ifdef CONFIG_SOF_USERSPACE_LL
 
int user_memory_attach_system_user_partition(struct k_mem_domain *dom);
 
#else

static inline int user_memory_attach_system_user_partition(struct k_mem_domain *dom)
{
    return 0;
}
 
#endif /* CONFIG_SOF_USERSPACE_LL */
 
#endif /* __ZEPHYR_LIB_USERSPACE_HELPER_H__ */