vregion: Add support for per pipeline/module virtual regions

lrgirdwo · lyakh · commit d3aa0dfa5e0f · 2026-03-24T15:51:51.000+01:00
Add support for per pipeline and per module virtual memory regions.

The intention is to provide a single virtual memory region per pipeline or
per DP module that can simplify module/pipeline memory management.

The region takes advantage of the way pipeline and modules are constructed,
destroyed and used during their lifetimes.

1) memory tracking - 1 pointer/size per pipeline or DP module.
2) memory read/write/execute permissions
3) cache utilization.

Modules and pipelines will allocate from their region only and this
will be abstracted via the allocation APIs.

Signed-off-by: Liam Girdwood &lt;liam.r.girdwood@linux.intel.com&gt;
Signed-off-by: Guennadi Liakhovetski &lt;guennadi.liakhovetski@linux.intel.com&gt;
diff --git a/app/boards/intel_adsp_ace15_mtpm.conf b/app/boards/intel_adsp_ace15_mtpm.conf
@@ -71,7 +71,7 @@ CONFIG_DMA_DW_LLI_POOL_SIZE=50
 CONFIG_DMA_INTEL_ADSP_GPDMA=y
 CONFIG_MEMORY_WIN_2_SIZE=12288
 CONFIG_MM_DRV_INTEL_ADSP_TLB_REMAP_UNUSED_RAM=y
-CONFIG_MM_DRV_INTEL_VIRTUAL_REGION_COUNT=2
+CONFIG_MM_DRV_INTEL_VIRTUAL_REGION_COUNT=3
 CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC=38400000
 CONFIG_SYS_CLOCK_TICKS_PER_SEC=12000
 
diff --git a/app/boards/intel_adsp_ace20_lnl.conf b/app/boards/intel_adsp_ace20_lnl.conf
@@ -49,7 +49,7 @@ CONFIG_DAI_INIT_PRIORITY=70
 CONFIG_DMA_INTEL_ADSP_GPDMA=n
 CONFIG_MEMORY_WIN_2_SIZE=12288
 CONFIG_MM_DRV_INTEL_ADSP_TLB_REMAP_UNUSED_RAM=y
-CONFIG_MM_DRV_INTEL_VIRTUAL_REGION_COUNT=2
+CONFIG_MM_DRV_INTEL_VIRTUAL_REGION_COUNT=3
 CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC=38400000
 CONFIG_SYS_CLOCK_TICKS_PER_SEC=12000
 
diff --git a/app/boards/intel_adsp_ace30_ptl.conf b/app/boards/intel_adsp_ace30_ptl.conf
@@ -53,7 +53,7 @@ CONFIG_DMA_INTEL_ADSP_GPDMA=n
 CONFIG_DMA_DW_LLI_POOL_SIZE=50
 CONFIG_MEMORY_WIN_2_SIZE=12288
 CONFIG_MM_DRV_INTEL_ADSP_TLB_REMAP_UNUSED_RAM=y
-CONFIG_MM_DRV_INTEL_VIRTUAL_REGION_COUNT=2
+CONFIG_MM_DRV_INTEL_VIRTUAL_REGION_COUNT=3
 CONFIG_XTENSA_MMU_NUM_L2_TABLES=128
 CONFIG_SYS_CLOCK_TICKS_PER_SEC=12000
 
diff --git a/app/boards/intel_adsp_ace30_wcl.conf b/app/boards/intel_adsp_ace30_wcl.conf
@@ -50,7 +50,7 @@ CONFIG_DAI_DMIC_HAS_MULTIPLE_LINE_SYNC=y
 CONFIG_DMA_INTEL_ADSP_GPDMA=n
 CONFIG_MEMORY_WIN_2_SIZE=12288
 CONFIG_MM_DRV_INTEL_ADSP_TLB_REMAP_UNUSED_RAM=y
-CONFIG_MM_DRV_INTEL_VIRTUAL_REGION_COUNT=2
+CONFIG_MM_DRV_INTEL_VIRTUAL_REGION_COUNT=3
 CONFIG_SYS_CLOCK_TICKS_PER_SEC=12000
 
 # Zephyr / power settings
diff --git a/app/boards/intel_adsp_ace40_nvl.conf b/app/boards/intel_adsp_ace40_nvl.conf
@@ -42,7 +42,7 @@ CONFIG_DAI_DMIC_HAS_OWNERSHIP=n
 CONFIG_DAI_DMIC_HAS_MULTIPLE_LINE_SYNC=y
 CONFIG_DMA_INTEL_ADSP_GPDMA=n
 CONFIG_MM_DRV_INTEL_ADSP_TLB_REMAP_UNUSED_RAM=y
-CONFIG_MM_DRV_INTEL_VIRTUAL_REGION_COUNT=2
+CONFIG_MM_DRV_INTEL_VIRTUAL_REGION_COUNT=3
 CONFIG_SYS_CLOCK_TICKS_PER_SEC=12000
 
 # Zephyr / power settings
diff --git a/app/boards/intel_adsp_ace40_nvls.conf b/app/boards/intel_adsp_ace40_nvls.conf
@@ -42,7 +42,7 @@ CONFIG_DAI_DMIC_HAS_OWNERSHIP=n
 CONFIG_DAI_DMIC_HAS_MULTIPLE_LINE_SYNC=y
 CONFIG_DMA_INTEL_ADSP_GPDMA=n
 CONFIG_MM_DRV_INTEL_ADSP_TLB_REMAP_UNUSED_RAM=y
-CONFIG_MM_DRV_INTEL_VIRTUAL_REGION_COUNT=2
+CONFIG_MM_DRV_INTEL_VIRTUAL_REGION_COUNT=3
 CONFIG_SYS_CLOCK_TICKS_PER_SEC=12000
 
 # Zephyr / power settings
diff --git a/zephyr/CMakeLists.txt b/zephyr/CMakeLists.txt
@@ -289,8 +289,12 @@ if (CONFIG_SOC_SERIES_INTEL_ADSP_ACE)
 		${SOF_PLATFORM_PATH}/novalake/lib/clk.c
 	)
 
-	# Sources for virtual heap management
-	zephyr_library_sources(
+	zephyr_library_sources_ifdef(CONFIG_SOF_VREGIONS
+		lib/vpages.c
+		lib/vregion.c
+	)
+
+	zephyr_library_sources_ifdef(CONFIG_VIRTUAL_HEAP
 		lib/regions_mm.c
 	)
 
diff --git a/zephyr/Kconfig b/zephyr/Kconfig
@@ -93,10 +93,18 @@ config SOF_ZEPHYR_VIRTUAL_HEAP_SIZE
 config SOF_ZEPHYR_VIRTUAL_HEAP_REGION_SIZE
 	hex "Size in bytes of virtual memory region for virtual heap shared for all cores"
 	depends on MM_DRV_INTEL_ADSP_MTL_TLB
-	default 0x100000
+	default 0xc0000
 	help
 	  This config defines size of virtual heap region shared between all cores
 
+config SOF_ZEPHYR_VIRTUAL_PAGE_REGION_SIZE
+	hex "Size in bytes of virtual memory regions"
+	depends on MM_DRV_INTEL_ADSP_MTL_TLB
+	default 0x40000
+	help
+	  This config defines size of the memory region, available to the
+	  vregion / vpage API
+
 config SOF_USERSPACE_USE_DRIVER_HEAP
 	bool "Use driver heap for SOF userspace modules"
 	depends on USERSPACE
@@ -250,8 +258,19 @@ config SOF_ZEPHYR_NO_SOF_CLOCK
 	  Do not use SOF clk.h interface to set the DSP clock frequency.
 	  Requires implementation of platform/lib/clk.h.
 
+config SOF_VREGIONS
+	bool "Enable virtual memory regions"
+	default y if ACE
+	depends on ACE
+	help
+	  Enable the virtual regions memory allocator for pipeline resource management.
+	  This provides a way to manage memory resources for audio pipelines,
+	  including
+	    1) multiple pipeline static lifetime allocations.
+	    2) runtime pipeline allocations.
+
 config VIRTUAL_HEAP
-	bool "Use virtual memory heap to allocate a buffers"
+	bool "Use virtual memory heap to allocate buffers"
 	default y if ACE
 	depends on ACE
 	help
diff --git a/zephyr/include/sof/lib/vregion.h b/zephyr/include/sof/lib/vregion.h
@@ -0,0 +1,96 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright(c) 2025 Intel Corporation.
+
+/* Pre Allocated Contiguous Virtual Region */
+#ifndef __SOF_LIB_VREGION_H__
+#define __SOF_LIB_VREGION_H__
+
+#include <zephyr/kernel.h>
+#include <stddef.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct vregion;
+
+/**
+ * @brief Create a new virtual region instance.
+ *
+ * Create a new virtual region instance with specified static and dynamic partitions.
+ * Total size is the sum of static and dynamic sizes.
+ *
+ * @param[in] lifetime_size Size of the virtual region lifetime partition.
+ * @param[in] interim_size Size of the virtual region interim partition.
+ * @return struct vregion* Pointer to the new virtual region instance, or NULL on failure.
+ */
+struct vregion *vregion_create(size_t lifetime_size, size_t interim_size);
+
+/**
+ * @brief Destroy a virtual region instance.
+ *
+ * Free all associated resources and deallocate the virtual region instance.
+ *
+ * @param[in] vr Pointer to the virtual region instance to destroy.
+ */
+void vregion_destroy(struct vregion *vr);
+
+/**
+ * @brief Memory types for virtual region allocations.
+ * Used to specify the type of memory allocation within a virtual region.
+ *
+ * @note
+ * - interim: allocation that can be freed i.e. get/set large config, kcontrols.
+ * - lifetime: allocation that cannot be freed i.e. init data, pipeline data.
+ */
+enum vregion_mem_type {
+	VREGION_MEM_TYPE_INTERIM,		/* interim allocation that can be freed */
+	VREGION_MEM_TYPE_LIFETIME,		/* lifetime allocation */
+};
+
+/**
+ * @brief Allocate memory from the specified virtual region.
+ *
+ * @param[in] vr Pointer to the virtual region instance.
+ * @param[in] type Type of memory to allocate (static, dynamic, or shared static).
+ * @param[in] size Size of memory to allocate in bytes.
+ * @return void* Pointer to the allocated memory, or NULL on failure.
+ */
+void *vregion_alloc(struct vregion *vr, enum vregion_mem_type type, size_t size);
+
+/**
+ * @brief Allocate aligned memory from the specified virtual region.
+ *
+ * Allocate aligned memory from the specified virtual region based on the memory type.
+ *
+ * @param[in] vr Pointer to the virtual region instance.
+ * @param[in] type Type of memory to allocate (static, dynamic, or shared static).
+ * @param[in] size Size of memory to allocate in bytes.
+ * @param[in] alignment Alignment of memory to allocate in bytes.
+ * @return void* Pointer to the allocated memory, or NULL on failure.
+ */
+void *vregion_alloc_align(struct vregion *vr, enum vregion_mem_type type,
+			  size_t size, size_t alignment);
+
+/**
+ * @brief Free memory allocated from the specified virtual region.
+ *
+ * Free memory previously allocated from the specified virtual region.
+ *
+ * @param[in] vr Pointer to the virtual region instance.
+ * @param[in] ptr Pointer to the memory to free.
+ */
+void vregion_free(struct vregion *vr, void *ptr);
+
+/**
+ * @brief Log virtual region memory usage.
+ *
+ * @param[in] vr Pointer to the virtual region instance.
+ */
+void vregion_info(struct vregion *vr);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __SOF_LIB_VREGION_H__ */
diff --git a/zephyr/lib/alloc.c b/zephyr/lib/alloc.c
@@ -338,15 +338,14 @@ static void virtual_heap_free(void *ptr)
 
 static const struct vmh_heap_config static_hp_buffers = {
 	{
-		{ 128, 32},
-		{ 512, 8},
-		{ 1024, 44},
-		{ 2048, 8},
-		{ 4096, 11},
-		{ 8192, 10},
-		{ 65536, 3},
-		{ 131072, 1},
-		{ 524288, 1} /* buffer for kpb */
+		{128, 32}, /* 4k */
+		{512, 8}, /* 4k -> 8k */
+		{1024, 28}, /* 28k -> 36k */
+		{2048, 4}, /* 8k -> 44k */
+		{4096, 7}, /* 28k -> 72k */
+		{8192, 7}, /* 56k -> 128k */
+		{65536, 2}, /* 128k -> 256k */
+		{524288, 1} /* 512k -> 768k */ /* buffer for kpb */
 	},
 };
 
diff --git a/zephyr/lib/vregion.c b/zephyr/lib/vregion.c

Original file line number	Diff line number	Diff line change
`@@ -289,8 +289,12 @@ if (CONFIG_SOC_SERIES_INTEL_ADSP_ACE)`
`289`	`289`	`${SOF_PLATFORM_PATH}/novalake/lib/clk.c`
`290`	`290`	`)`
`291`	`291`
`292`		`- # Sources for virtual heap management`
`293`		`- zephyr_library_sources(`
	`292`	`+ zephyr_library_sources_ifdef(CONFIG_SOF_VREGIONS`
	`293`	`+ lib/vpages.c`
	`294`	`+ lib/vregion.c`
	`295`	`+ )`
	`296`	`+`
	`297`	`+ zephyr_library_sources_ifdef(CONFIG_VIRTUAL_HEAP`
`294`	`298`	`lib/regions_mm.c`
`295`	`299`	`)`
`296`	`300`