header: rtos: decouple headers into rtos specific directories.

No functional runtime change, but changes to rtos partitioning and the layout of headers . This patch creates RTOS specifc header paths and updates spinlock.h and kernel.h to show the new usage. Other headers will incrementally follow. It reuses the current zephyr topleve directory and creates a new toplevel xtos directory for xtos specific files. Due to the mixing of RTOS, driver and library headers at the top level include directory it was necessary to create rtos specific header directories i.e. src/include/rtos-xtos src/include/rtos-zephyr These RTOS include directories will eventually contain RTOS specific headers whilst common logic and structures will be placed in non RTOS directories. This will also mean "#include <sof/spinlock.h>" will become "#include <rtos/spinlock.h>" and will allow easier visualisation of where and why RTOS headers are being used. This will help to eliminate cross usage of headers between RTOSes. Subsequqnt patches will move more headers and rtos specific wrppaer source files into rtos specific locations. Signed-off-by: Liam Girdwood <[email protected]>
jsarha · Aug 31, 2022 · 1629a1f · 1629a1f
1 parent 9fc0bad
commit 1629a1f
Show file tree

Hide file tree

Showing 143 changed files with 279 additions and 161 deletions.
diff --git a/doc/sof.doxygen.in b/doc/sof.doxygen.in
@@ -9,7 +9,8 @@ CASE_SENSE_NAMES = NO
 INPUT            = @top_srcdir@/src/include/ipc \
                    @top_srcdir@/src/include/kernel \
 		   @top_srcdir@/src/include/user \
-                   @top_srcdir@/src/include/sof
+                   @top_srcdir@/src/include/sof \
+                   @top_srcdir@/xtos/include
 # Exlude some 3rd party codec headers with external references
 EXCLUDE		 = @top_srcdir@/src/include/sof/audio/MaxxEffect
 RECURSIVE	 = YES

diff --git a/smex/CMakeLists.txt b/smex/CMakeLists.txt
@@ -26,3 +26,10 @@ target_include_directories(smex PRIVATE
 	"${SOF_ROOT_SOURCE_DIRECTORY}/src/include"
 	"${SOF_ROOT_SOURCE_DIRECTORY}/rimage/src/include"
 )
+
+# TODO: smex should not need RTOS headers: FIX.
+if (NOT CONFIG_SOF_ZEPHYR_STRICT_HEADERS)
+target_include_directories(smex PRIVATE
+	"${SOF_ROOT_SOURCE_DIRECTORY}/xtos/include"
+)
+endif()
diff --git a/src/arch/CMakeLists.txt b/src/arch/CMakeLists.txt
@@ -1,7 +1,3 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 add_subdirectory(${ARCH})
-
-if(NOT CONFIG_ZEPHYR_SOF_MODULE)
-	add_subdirectory("xtos-wrapper")
-endif()
diff --git a/src/arch/host/CMakeLists.txt b/src/arch/host/CMakeLists.txt
@@ -4,6 +4,13 @@
 target_include_directories(sof_public_headers INTERFACE ${PROJECT_SOURCE_DIR}/src/arch/host/include)
 target_include_directories(sof_public_headers INTERFACE ${PROJECT_SOURCE_DIR}/src/platform/library/include)
 
+# TODO: library should not need RTOS headers: FIX.
+if (NOT CONFIG_SOF_ZEPHYR_STRICT_HEADERS)
+target_include_directories(sof_public_headers INTERFACE
+	${PROJECT_SOURCE_DIR}/xtos/include
+)
+endif()
+
 # C & ASM flags
 target_compile_options(sof_options INTERFACE -g -O3 -Wall -Werror -Wmissing-prototypes
   -Wimplicit-fallthrough -Wno-pointer-to-int-cast -Wno-int-to-pointer-cast -Wpointer-arith -DCONFIG_LIBRARY "-imacros${CONFIG_H_PATH}")

diff --git a/src/arch/host/include/arch/spinlock.h b/src/arch/host/include/arch/spinlock.h
@@ -5,7 +5,8 @@
  * Author: Liam Girdwood <[email protected]>
  */
 
-#ifdef __SOF_SPINLOCK_H__
+/* TODO: this needs fixed as part of the "host does not need rtos headers work" */
+#ifdef __XTOS_RTOS_SPINLOCK_H__
 
 #ifndef __ARCH_SPINLOCK_H__
 #define __ARCH_SPINLOCK_H__

diff --git a/src/arch/xtensa/CMakeLists.txt b/src/arch/xtensa/CMakeLists.txt
@@ -60,10 +60,14 @@ if(CONFIG_REMBRANDT)
 endif()
 # includes
 
+# None of these should be included if Zephyr strict headers are used.
+if (NOT CONFIG_SOF_ZEPHYR_STRICT_HEADERS)
 target_include_directories(sof_options INTERFACE
 	${PROJECT_SOURCE_DIR}/src/arch/xtensa/include
 	${PROJECT_SOURCE_DIR}/src/arch/xtensa/xtos
+	${PROJECT_SOURCE_DIR}/xtos/include
 )
+endif()
 
 target_include_directories(sof_options INTERFACE ${PROJECT_SOURCE_DIR}/src/platform/${platform_folder}/include)
 

diff --git a/src/arch/xtensa/include/arch/spinlock.h b/src/arch/xtensa/include/arch/spinlock.h
@@ -5,7 +5,7 @@
  * Author: Liam Girdwood <[email protected]>
  */
 
-#ifdef __SOF_SPINLOCK_H__
+#ifdef __XTOS_RTOS_SPINLOCK_H__
 
 #ifndef __ARCH_SPINLOCK_H__
 #define __ARCH_SPINLOCK_H__

diff --git a/src/arch/xtensa/init.c b/src/arch/xtensa/init.c
@@ -16,7 +16,7 @@
 #include <sof/init.h>
 #include <sof/lib/cpu.h>
 #include <sof/sof.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 
 #include <ipc/trace.h>
 

diff --git a/src/audio/buffer.c b/src/audio/buffer.c
@@ -13,7 +13,7 @@
 #include <sof/lib/memory.h>
 #include <sof/lib/notifier.h>
 #include <sof/list.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <ipc/topology.h>
 #include <errno.h>
 #include <stddef.h>

diff --git a/src/audio/pipeline/pipeline-graph.c b/src/audio/pipeline/pipeline-graph.c
@@ -14,7 +14,7 @@
 #include <sof/lib/uuid.h>
 #include <sof/compiler_attributes.h>
 #include <sof/list.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/string.h>
 #include <ipc/header.h>
 #include <ipc/stream.h>

diff --git a/src/audio/pipeline/pipeline-params.c b/src/audio/pipeline/pipeline-params.c
@@ -12,7 +12,7 @@
 #include <sof/lib/mm_heap.h>
 #include <sof/compiler_attributes.h>
 #include <sof/list.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <ipc/stream.h>
 #include <ipc/topology.h>
 #include <ipc4/error_status.h>

diff --git a/src/audio/pipeline/pipeline-schedule.c b/src/audio/pipeline/pipeline-schedule.c
@@ -14,7 +14,7 @@
 #include <sof/schedule/ll_schedule.h>
 #include <sof/schedule/schedule.h>
 #include <sof/schedule/task.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/string.h>
 #include <ipc/header.h>
 #include <ipc/stream.h>

diff --git a/src/audio/pipeline/pipeline-stream.c b/src/audio/pipeline/pipeline-stream.c
@@ -11,12 +11,11 @@
 #include <sof/lib/dai.h>
 #include <sof/lib/wait.h>
 #include <sof/list.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/string.h>
 #include <ipc/stream.h>
 #include <ipc/topology.h>
-
-#include <zephyr/kernel.h>
+#include <rtos/kernel.h>
 
 #include <errno.h>
 #include <stdbool.h>

diff --git a/src/audio/pipeline/pipeline-xrun.c b/src/audio/pipeline/pipeline-xrun.c
@@ -10,7 +10,7 @@
 #include <sof/audio/pipeline.h>
 #include <sof/ipc/msg.h>
 #include <sof/list.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/string.h>
 #include <ipc/header.h>
 #include <ipc/stream.h>

diff --git a/src/drivers/amd/rembrandt/acp_bt_dma.c b/src/drivers/amd/rembrandt/acp_bt_dma.c
@@ -20,7 +20,7 @@
 #include <sof/lib/notifier.h>
 #include <sof/platform.h>
 #include <sof/schedule/schedule.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/math/numbers.h>
 #include <sof/trace/trace.h>
 #include <ipc/topology.h>

diff --git a/src/drivers/amd/rembrandt/acp_dmic_dma.c b/src/drivers/amd/rembrandt/acp_dmic_dma.c
@@ -20,7 +20,7 @@
 #include <sof/lib/notifier.h>
 #include <sof/platform.h>
 #include <sof/schedule/schedule.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/math/numbers.h>
 #include <sof/trace/trace.h>
 #include <ipc/topology.h>

diff --git a/src/drivers/amd/rembrandt/acp_hs_dma.c b/src/drivers/amd/rembrandt/acp_hs_dma.c
@@ -20,7 +20,7 @@
 #include <sof/lib/notifier.h>
 #include <sof/platform.h>
 #include <sof/schedule/schedule.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/math/numbers.h>
 #include <sof/trace/trace.h>
 #include <ipc/topology.h>

diff --git a/src/drivers/amd/rembrandt/acp_sp_dma.c b/src/drivers/amd/rembrandt/acp_sp_dma.c
@@ -20,7 +20,7 @@
 #include <sof/lib/notifier.h>
 #include <sof/platform.h>
 #include <sof/schedule/schedule.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/math/numbers.h>
 #include <sof/trace/trace.h>
 #include <ipc/topology.h>

diff --git a/src/drivers/amd/rembrandt/interrupt.c b/src/drivers/amd/rembrandt/interrupt.c
@@ -13,7 +13,7 @@
 #include <sof/lib/memory.h>
 #include <sof/lib/uuid.h>
 #include <sof/list.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <xtensa/hal.h>
 #include <xtensa/config/core.h>
 #include <xtensa/config/specreg.h>

diff --git a/src/drivers/amd/rembrandt/ipc.c b/src/drivers/amd/rembrandt/ipc.c
@@ -24,7 +24,7 @@
 #include <sof/schedule/edf_schedule.h>
 #include <sof/schedule/schedule.h>
 #include <sof/schedule/task.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <ipc/header.h>
 #include <ipc/topology.h>
 #include <errno.h>

diff --git a/src/drivers/amd/renoir/acp_bt_dma.c b/src/drivers/amd/renoir/acp_bt_dma.c
@@ -21,7 +21,7 @@
 #include <sof/lib/notifier.h>
 #include <sof/platform.h>
 #include <sof/schedule/schedule.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/math/numbers.h>
 #include <sof/trace/trace.h>
 #include <ipc/topology.h>

diff --git a/src/drivers/amd/renoir/acp_dmic_dma.c b/src/drivers/amd/renoir/acp_dmic_dma.c
@@ -20,7 +20,7 @@
 #include <sof/lib/notifier.h>
 #include <sof/platform.h>
 #include <sof/schedule/schedule.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/math/numbers.h>
 #include <sof/trace/trace.h>
 #include <ipc/topology.h>

diff --git a/src/drivers/amd/renoir/acp_sp_dma.c b/src/drivers/amd/renoir/acp_sp_dma.c
@@ -21,7 +21,7 @@
 #include <sof/lib/notifier.h>
 #include <sof/platform.h>
 #include <sof/schedule/schedule.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/math/numbers.h>
 #include <sof/trace/trace.h>
 #include <ipc/topology.h>

diff --git a/src/drivers/amd/renoir/interrupt.c b/src/drivers/amd/renoir/interrupt.c
@@ -14,7 +14,7 @@
 #include <sof/lib/memory.h>
 #include <sof/lib/uuid.h>
 #include <sof/list.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <xtensa/hal.h>
 #include <xtensa/config/core.h>
 #include <xtensa/config/specreg.h>

diff --git a/src/drivers/amd/renoir/ipc.c b/src/drivers/amd/renoir/ipc.c
@@ -25,7 +25,7 @@
 #include <sof/schedule/edf_schedule.h>
 #include <sof/schedule/schedule.h>
 #include <sof/schedule/task.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <ipc/header.h>
 #include <ipc/topology.h>
 #include <errno.h>

diff --git a/src/drivers/dw/dma.c b/src/drivers/dw/dma.c
@@ -36,7 +36,7 @@
 #include <sof/lib/wait.h>
 #include <sof/lib/notifier.h>
 #include <sof/platform.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <ipc/topology.h>
 
 #include <errno.h>

diff --git a/src/drivers/dw/ssi-spi.c b/src/drivers/dw/ssi-spi.c
@@ -23,7 +23,7 @@
 #include <sof/schedule/ll_schedule.h>
 #include <sof/schedule/schedule.h>
 #include <sof/schedule/task.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/string.h>
 #include <ipc/header.h>
 #include <ipc/topology.h>

diff --git a/src/drivers/generic/dummy-dma.c b/src/drivers/generic/dummy-dma.c
@@ -34,7 +34,7 @@
 #include <sof/lib/notifier.h>
 #include <sof/lib/uuid.h>
 #include <sof/platform.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/string.h>
 #include <sof/trace/trace.h>
 #include <sys/types.h>

diff --git a/src/drivers/imx/interrupt-generic.c b/src/drivers/imx/interrupt-generic.c
@@ -11,7 +11,7 @@
 #include <sof/lib/memory.h>
 #include <sof/lib/uuid.h>
 #include <sof/list.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <errno.h>
 #include <inttypes.h>
 #include <stdbool.h>

diff --git a/src/drivers/imx/interrupt-irqsteer.c b/src/drivers/imx/interrupt-irqsteer.c
@@ -12,7 +12,7 @@
 #include <sof/lib/memory.h>
 #include <sof/lib/uuid.h>
 #include <sof/list.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <errno.h>
 #include <inttypes.h>
 #include <stdbool.h>

diff --git a/src/drivers/imx/ipc.c b/src/drivers/imx/ipc.c
@@ -21,7 +21,7 @@
 #include <sof/schedule/edf_schedule.h>
 #include <sof/schedule/schedule.h>
 #include <sof/schedule/task.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <ipc/header.h>
 #include <ipc/topology.h>
 #include <ipc/trace.h>

diff --git a/src/drivers/intel/baytrail/ipc.c b/src/drivers/intel/baytrail/ipc.c
@@ -20,7 +20,7 @@
 #include <sof/platform.h>
 #include <sof/schedule/edf_schedule.h>
 #include <sof/schedule/schedule.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <ipc/header.h>
 #include <ipc/topology.h>
 #include <stdbool.h>

diff --git a/src/drivers/intel/baytrail/ssp.c b/src/drivers/intel/baytrail/ssp.c
@@ -11,7 +11,7 @@
 #include <sof/lib/alloc.h>
 #include <sof/lib/dai.h>
 #include <sof/lib/dma.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/trace/trace.h>
 #include <ipc/dai.h>
 #include <ipc/dai-intel.h>

diff --git a/src/drivers/intel/cavs/interrupt.c b/src/drivers/intel/cavs/interrupt.c
@@ -14,7 +14,7 @@
 #include <sof/lib/shim.h>
 #include <sof/lib/uuid.h>
 #include <sof/list.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 
 #include <stdbool.h>
 #include <stddef.h>

diff --git a/src/drivers/intel/cavs/ipc.c b/src/drivers/intel/cavs/ipc.c
@@ -21,7 +21,7 @@
 #include <sof/schedule/edf_schedule.h>
 #include <sof/schedule/schedule.h>
 #include <sof/schedule/task.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <ipc/header.h>
 
 #include <stdbool.h>

diff --git a/src/drivers/intel/cavs/sue-ipc.c b/src/drivers/intel/cavs/sue-ipc.c
@@ -17,7 +17,7 @@
 #include <sof/schedule/edf_schedule.h>
 #include <sof/schedule/schedule.h>
 #include <sof/schedule/task.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <ipc/header.h>
 #include <stddef.h>
 #include <stdint.h>

diff --git a/src/drivers/intel/dmic/dmic.c b/src/drivers/intel/dmic/dmic.c
@@ -22,7 +22,7 @@
 #include <sof/lib/uuid.h>
 #include <sof/math/decibels.h>
 #include <sof/math/numbers.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/string.h>
 #include <ipc/dai.h>
 #include <ipc/dai-intel.h>

diff --git a/src/drivers/intel/haswell/ipc.c b/src/drivers/intel/haswell/ipc.c
@@ -20,7 +20,7 @@
 #include <sof/schedule/edf_schedule.h>
 #include <sof/schedule/schedule.h>
 #include <sof/schedule/task.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <ipc/header.h>
 #include <ipc/topology.h>
 #include <stdbool.h>

diff --git a/src/drivers/intel/haswell/ssp.c b/src/drivers/intel/haswell/ssp.c
@@ -11,7 +11,7 @@
 #include <sof/lib/dai.h>
 #include <sof/lib/dma.h>
 #include <sof/lib/shim.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/trace/trace.h>
 #include <ipc/dai.h>
 #include <ipc/dai-intel.h>

diff --git a/src/drivers/intel/hda/hda-dma.c b/src/drivers/intel/hda/hda-dma.c
@@ -20,7 +20,7 @@
 #include <sof/lib/notifier.h>
 #include <sof/platform.h>
 #include <sof/schedule/schedule.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/trace/trace.h>
 #include <ipc/topology.h>
 #include <user/trace.h>

diff --git a/src/drivers/intel/ssp/mn.c b/src/drivers/intel/ssp/mn.c
@@ -11,7 +11,7 @@
 #include <sof/lib/uuid.h>
 #include <sof/math/numbers.h>
 #include <sof/sof.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/trace/trace.h>
 
 #include <cavs/version.h>

diff --git a/src/drivers/intel/ssp/ssp.c b/src/drivers/intel/ssp/ssp.c
@@ -20,7 +20,7 @@
 #include <sof/lib/uuid.h>
 #include <sof/lib/wait.h>
 #include <sof/platform.h>
-#include <sof/spinlock.h>
+#include <rtos/spinlock.h>
 #include <sof/trace/trace.h>
 #include <ipc/dai.h>
 #include <ipc/dai-intel.h>