From 28d6041b01171afbc2ecdc63f57e800937ac9e43 Mon Sep 17 00:00:00 2001 From: Liam Girdwood Date: Thu, 11 Jun 2026 10:33:28 +0100 Subject: [PATCH 1/2] doc: Add zephyr/include to the Doxygen input The Memory Allocation (alloc_api), PM Runtime (pm_runtime) and DMA (sof_dma_drivers, sof_dma_copy_func) API groups stopped appearing in the generated documentation when their headers were decoupled into zephyr/include during the RTOS split. The Doxygen INPUT still listed only src/include and xtos/include, so those Zephyr-era headers were no longer scanned and sof-docs reported "Cannot find group" for all four. Add zephyr/include to the INPUT. These headers declare exactly those four groups and no others, with no group-name overlap with xtos/include, so this recovers the missing API docs without introducing duplicates. Co-authored-by: Claude Opus 4.8 (1M context) Signed-off-by: Liam Girdwood --- doc/sof.doxygen.in | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/sof.doxygen.in b/doc/sof.doxygen.in index 6379da500f11..a54481858b31 100644 --- a/doc/sof.doxygen.in +++ b/doc/sof.doxygen.in @@ -10,7 +10,8 @@ INPUT = @top_srcdir@/src/include/ipc \ @top_srcdir@/src/include/kernel \ @top_srcdir@/src/include/user \ @top_srcdir@/src/include/sof \ - @top_srcdir@/xtos/include + @top_srcdir@/xtos/include \ + @top_srcdir@/zephyr/include # Exlude some 3rd party codec headers with external references EXCLUDE = @top_srcdir@/src/include/sof/audio/MaxxEffect RECURSIVE = YES From 8ce57b57ac99d3ccb8495447d97ce59e36a58aa6 Mon Sep 17 00:00:00 2001 From: Liam Girdwood Date: Fri, 28 Aug 2026 18:18:29 +0100 Subject: [PATCH 2/2] doc: fix doxygen comments in zephyr include headers Fix parameter name mismatch in module_driver_heap_remove() and correct struct field documentation for vmh_block_bundle_descriptor and vmh_heap_config so Doxygen parses zephyr/include cleanly without warnings. Signed-off-by: Liam Girdwood --- zephyr/include/rtos/userspace_helper.h | 2 +- zephyr/include/sof/lib/regions_mm.h | 14 ++------------ 2 files changed, 3 insertions(+), 13 deletions(-) diff --git a/zephyr/include/rtos/userspace_helper.h b/zephyr/include/rtos/userspace_helper.h index 20fb7bd40876..b29d2daa57c0 100644 --- a/zephyr/include/rtos/userspace_helper.h +++ b/zephyr/include/rtos/userspace_helper.h @@ -95,7 +95,7 @@ int user_stack_free(void *p_stack); /** * Free private processing module heap. - * @param sys_heap pointer to the sys_heap structure. + * @param mod_drv_heap pointer to the k_heap structure. * * @note * Function used only when CONFIG_USERSPACE is set. diff --git a/zephyr/include/sof/lib/regions_mm.h b/zephyr/include/sof/lib/regions_mm.h index abaaf158d3d4..6a22bfe7fd92 100644 --- a/zephyr/include/sof/lib/regions_mm.h +++ b/zephyr/include/sof/lib/regions_mm.h @@ -49,17 +49,9 @@ */ #define DEFAULT_CONFIG_ALOCATORS_COUNT 5 -/** @struct vmh_block_bundle_descriptor - * - * @brief This is a struct describing one bundle of blocks - * used as base for allocators blocks. - * - * @var block_size size of memory block. - * @var number_of_blocks number of memory blocks. - */ struct vmh_block_bundle_descriptor { - size_t block_size; - size_t number_of_blocks; + size_t block_size; /**< size of memory block. */ + size_t number_of_blocks; /**< number of memory blocks. */ }; /* @@ -75,8 +67,6 @@ struct vmh_block_bundle_descriptor { * Provided config size must be physical page aligned so it * will not overlap in physical space with other heaps during mapping. * So every block has to have its overall size aligned to CONFIG_MM_DRV_PAGE_SIZE - * - * @vmh_block_bundle_descriptor[] aggregation of bundle descriptors. */ struct vmh_heap_config { struct vmh_block_bundle_descriptor block_bundles_table[MAX_MEMORY_ALLOCATORS_COUNT];