Rename generated version.h to sof_versions.h

marc-hb · lgirdwood · commit deb0e7340ef9 · 2022-01-14T16:56:29.000Z
Zephyr also a version.h too so the situation was a buggy #include mess
that (among others) dropped the SOF git version from the SOF banner when
using Zephyr. It's absolutely impossible to fix this mess while keeping
two .h files both named exactly the same and even included with the
exact same '#include version.h' line, I mean no sof/version.h or other
prefix.

As a bonus, this rename also reduces the XTOS-only confusion between
"version.h" and cavs/version.h".

Generating a file in the source tree is a serious bug (to be fixed
later), it means this file is never cleaned. Do not hide this bug with a
.gitignore rule.

Signed-off-by: Marc Herbert &lt;marc.herbert@intel.com&gt;
diff --git a/.gitignore b/.gitignore
@@ -72,5 +72,3 @@ doc/Makefile
 cscope.*
 ncscope.*
 
-# zephyr files
-zephyr/include/version.h
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -94,7 +94,7 @@ file(MAKE_DIRECTORY ${GENERATED_DIRECTORY}/include)
 set(DOT_CONFIG_PATH ${GENERATED_DIRECTORY}/.config)
 set(CONFIG_H_PATH ${GENERATED_DIRECTORY}/include/autoconfig.h CACHE
   PATH "Path to kconfig's .h output file")
-set(VERSION_H_PATH ${GENERATED_DIRECTORY}/include/version.h)
+set(VERSION_H_PATH ${GENERATED_DIRECTORY}/include/sof_versions.h)
 
 include(scripts/cmake/version.cmake)
 
diff --git a/installer/sample-config.mk b/installer/sample-config.mk
@@ -17,7 +17,7 @@
 
 # Define this empty for a plain sof/ directory and no sof -> sof-v1.2.3
 # symbolic links. This is _only_ to override the top-level directory
-# name; for version.h see version.cmake and try sof/.tarball-version
+# name; for sof_versions.h see version.cmake and try sof/.tarball-version
 # SOF_VERSION :=
 #
 # SOF_VERSION := $(shell git describe --tags )
diff --git a/scripts/test-repro-build.sh b/scripts/test-repro-build.sh
@@ -124,7 +124,7 @@ diff_some_files()
 
           done
 
-          for f in generated/include/version.h sof.ri \
+          for f in generated/include/sof_versions.h sof.ri \
                   src/arch/xtensa/reproducible.ri; do
               diff -u --report-identical-files  \
                    {b0,b1}/build_"$p"_?cc/"$f"
diff --git a/src/audio/base_fw.c b/src/audio/base_fw.c
@@ -6,7 +6,7 @@
 #include <sof/ut.h>
 #include <ipc4/base_fw.h>
 #include <ipc4/pipeline.h>
-#include <version.h>
+#include <sof_versions.h>
 
 /* 0e398c32-5ade-ba4b-93b1-c50432280ee4 */
 DECLARE_SOF_RT_UUID("basefw", basefw_comp_uuid, 0xe398c32, 0x5ade, 0xba4b,
diff --git a/src/init/ext_manifest.c b/src/init/ext_manifest.c
@@ -12,7 +12,7 @@
 #include <kernel/abi.h>
 #include <kernel/ext_manifest.h>
 #include <user/abi_dbg.h>
-#include <version.h>
+#include <sof_versions.h>
 
 const struct ext_man_fw_version ext_man_fw_ver
 	__aligned(EXT_MAN_ALIGN) __section(".fw_metadata") = {
diff --git a/src/platform/amd/renoir/platform.c b/src/platform/amd/renoir/platform.c
@@ -31,7 +31,7 @@
 #include <ipc/header.h>
 #include <ipc/info.h>
 #include <kernel/abi.h>
-#include <version.h>
+#include <sof_versions.h>
 #include <errno.h>
 #include <stdint.h>
 #include <platform/chip_offset_byte.h>
diff --git a/src/platform/baytrail/platform.c b/src/platform/baytrail/platform.c
@@ -36,7 +36,7 @@
 #include <kernel/abi.h>
 #include <kernel/ext_manifest.h>
 
-#include <version.h>
+#include <sof_versions.h>
 #include <errno.h>
 #include <stdbool.h>
 #include <stddef.h>
diff --git a/src/platform/haswell/platform.c b/src/platform/haswell/platform.c
@@ -33,7 +33,7 @@
 #include <ipc/info.h>
 #include <kernel/abi.h>
 #include <kernel/ext_manifest.h>
-#include <version.h>
+#include <sof_versions.h>
 #include <errno.h>
 #include <stddef.h>
 #include <stdint.h>
diff --git a/src/platform/imx8/platform.c b/src/platform/imx8/platform.c
@@ -31,7 +31,7 @@
 #include <ipc/info.h>
 #include <kernel/abi.h>
 #include <kernel/ext_manifest.h>
-#include <version.h>
+#include <sof_versions.h>
 #include <errno.h>
 #include <stdint.h>
 
diff --git a/src/platform/imx8m/platform.c b/src/platform/imx8m/platform.c
@@ -30,7 +30,7 @@
 #include <ipc/info.h>
 #include <kernel/abi.h>
 #include <kernel/ext_manifest.h>
-#include <version.h>
+#include <sof_versions.h>
 #include <errno.h>
 #include <stdint.h>
 
diff --git a/src/platform/imx8ulp/platform.c b/src/platform/imx8ulp/platform.c
@@ -31,7 +31,7 @@
 #include <ipc/info.h>
 #include <kernel/abi.h>
 #include <kernel/ext_manifest.h>
-#include <version.h>
+#include <sof_versions.h>
 #include <errno.h>
 #include <stdint.h>
 
diff --git a/src/platform/intel/cavs/lib/pm_runtime.c b/src/platform/intel/cavs/lib/pm_runtime.c
@@ -33,7 +33,7 @@
 #include <cavs/drivers/sideband-ipc.h>
 #endif
 
-#include <version.h>
+#include <sof_versions.h>
 #include <stdint.h>
 
 #if !CONFIG_SUECREEK
diff --git a/src/platform/intel/cavs/platform.c b/src/platform/intel/cavs/platform.c
@@ -45,7 +45,7 @@
 #include <kernel/abi.h>
 #include <kernel/ext_manifest.h>
 
-#include <version.h>
+#include <sof_versions.h>
 #include <errno.h>
 #include <stdint.h>
 
diff --git a/src/platform/mt8195/platform.c b/src/platform/mt8195/platform.c
@@ -32,7 +32,7 @@
 #include <ipc/info.h>
 #include <kernel/abi.h>
 #include <kernel/ext_manifest.h>
-#include <version.h>
+#include <sof_versions.h>
 #include <errno.h>
 #include <stdint.h>
 #include <xtensa/hal.h>
diff --git a/src/trace/dma-trace.c b/src/trace/dma-trace.c
@@ -26,7 +26,7 @@
 #include <ipc/trace.h>
 #include <kernel/abi.h>
 #include <user/abi_dbg.h>
-#include <version.h>
+#include <sof_versions.h>
 
 #include <errno.h>
 #include <stddef.h>
diff --git a/zephyr/CMakeLists.txt b/zephyr/CMakeLists.txt
@@ -716,7 +716,7 @@ set(GENERATED_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
 file(MAKE_DIRECTORY ${GENERATED_DIRECTORY}/include)
 
 # generated files
-set(VERSION_H_PATH ${GENERATED_DIRECTORY}/include/version.h)
+set(VERSION_H_PATH ${GENERATED_DIRECTORY}/include/sof_versions.h)
 set(DOT_CONFIG_PATH ${GENERATED_DIRECTORY}/.config)
 
 if(${CMAKE_VERSION} VERSION_LESS "3.12.0")
@@ -738,9 +738,6 @@ add_definitions(-DXCC_TOOLS_VERSION="${ZEPHYR_TOOLCHAIN_VARIANT}" -DCC_OPTIMIZE_
 
 # create version information
 include(../scripts/cmake/version.cmake)
-add_definitions(-DSOF_MICRO=${SOF_MICRO} -DSOF_MINOR=${SOF_MINOR})
-add_definitions(-DSOF_MAJOR=${SOF_MAJOR} -DSOF_TAG="${SOF_TAG}")
-add_definitions(-DSOF_SRC_HASH=0x${SOF_SRC_HASH} -DSOF_GIT_TAG="${SOF_GIT_TAG}")
 
 # Create Trace realtive file paths
 sof_append_relative_path_definitions(modules_sof)

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`
`18`	`18`	`# Define this empty for a plain sof/ directory and no sof -> sof-v1.2.3`
`19`	`19`	`# symbolic links. This is _only_ to override the top-level directory`
`20`		`-# name; for version.h see version.cmake and try sof/.tarball-version`
	`20`	`+# name; for sof_versions.h see version.cmake and try sof/.tarball-version`
`21`	`21`	`# SOF_VERSION :=`
`22`	`22`	`#`
`23`	`23`	`# SOF_VERSION := $(shell git describe --tags )`