ASoC: SOF: rework FW ABI version handling on kernel side

The definitions in sof/abi.h have been a verbatim copy of
the firmware header definition.

The header also defines a version and this has caused issues:
  - kernel declares one version but as the interface supports
    backwards-compatible minor version updates, many firmware
    versions can be supported by any one kernel
  - a single firmware MINOR version bump can cover multiple
    changes to the interface and this can cause complex
    dependencies to kernel patch backporting as kernel will
    have multiple commits to support extensions identified
    by a single MAJOR.MINOR version of firwmare

To improve the situation, move all version information out from the
shared header and define version as part of the implementation. Add
local definitions to ipc.c, topology.c and loader.c. These versions will
be updated when the implementation is updated. E.g. when a new token
type is added to topology parser, the version is updated in topology.c
to reflect this.

BugLink: thesofproject/sof#4986
Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>

Author: kv2019i

include/uapi/sound/sof/abi.h

@@ -6,29 +6,9 @@
  * Copyright(c) 2018 Intel Corporation. All rights reserved.
  */
 
-/**
- * SOF ABI versioning is based on Semantic Versioning where we have a given
- * MAJOR.MINOR.PATCH version number. See https://semver.org/
- *
- * Rules for incrementing or changing version :-
- *
- * 1) Increment MAJOR version if you make incompatible API changes. MINOR and
- *    PATCH should be reset to 0.
- *
- * 2) Increment MINOR version if you add backwards compatible features or
- *    changes. PATCH should be reset to 0.
- *
- * 3) Increment PATCH version if you add backwards compatible bug fixes.
- */
-
 #ifndef __INCLUDE_UAPI_SOUND_SOF_ABI_H__
 #define __INCLUDE_UAPI_SOUND_SOF_ABI_H__
 
-/* SOF ABI version major, minor and patch numbers */
-#define SOF_ABI_MAJOR 3
-#define SOF_ABI_MINOR 18
-#define SOF_ABI_PATCH 0
-
 /* SOF ABI version number. Format within 32bit word is MMmmmppp */
 #define SOF_ABI_MAJOR_SHIFT	24
 #define SOF_ABI_MAJOR_MASK	0xff
@@ -54,8 +34,6 @@
 		SOF_ABI_VERSION_MAJOR((client_ver))			\
 	)
 
-#define SOF_ABI_VERSION SOF_ABI_VER(SOF_ABI_MAJOR, SOF_ABI_MINOR, SOF_ABI_PATCH)
-
 /* SOF ABI magic number "SOF\0". */
 #define SOF_ABI_MAGIC		0x00464F53
 

sound/soc/sof/control.c

@@ -15,6 +15,9 @@
 #include "sof-priv.h"
 #include "sof-audio.h"
 
+/* IPC interface version implemented for control */
+#define SOF_ABI_VERSION SOF_ABI_VER(3, 18, 0)
+
 static void update_mute_led(struct snd_sof_control *scontrol,
 			    struct snd_kcontrol *kcontrol,
 			    struct snd_ctl_elem_value *ucontrol)

sound/soc/sof/ipc.c

@@ -37,6 +37,12 @@ struct sof_ipc_ctrl_data_params {
 	u8 *dst;
 };
 
+/* IPC interface version implemented */
+#define SOF_ABI_MAJOR 3
+#define SOF_ABI_MINOR 18
+#define SOF_ABI_PATCH 0
+#define SOF_ABI_VERSION SOF_ABI_VER(SOF_ABI_MAJOR, SOF_ABI_MINOR, SOF_ABI_PATCH)
+
 #if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_VERBOSE_IPC)
 static void ipc_log_header(struct device *dev, u8 *text, u32 cmd)
 {
@@ -958,13 +964,10 @@ int snd_sof_ipc_valid(struct snd_sof_dev *sdev)
 		return -EINVAL;
 	}
 
-	if (SOF_ABI_VERSION_MINOR(v->abi_version) > SOF_ABI_MINOR) {
-		if (!IS_ENABLED(CONFIG_SND_SOC_SOF_STRICT_ABI_CHECKS)) {
-			dev_warn(sdev->dev, "warn: FW ABI is more recent than kernel\n");
-		} else {
-			dev_err(sdev->dev, "error: FW ABI is more recent than kernel\n");
-			return -EINVAL;
-		}
+	if (IS_ENABLED(CONFIG_SND_SOC_SOF_STRICT_ABI_CHECKS) &&
+	    SOF_ABI_VERSION_MINOR(v->abi_version) > SOF_ABI_MINOR) {
+		dev_err(sdev->dev, "error: FW ABI is more recent than kernel\n");
+		return -EINVAL;
 	}
 
 	if (ready->flags & SOF_IPC_INFO_BUILD) {

sound/soc/sof/topology.c

@@ -47,6 +47,12 @@
 /* size of tplg abi in byte */
 #define SOF_TPLG_ABI_SIZE 3
 
+/* IPC interface version implemented for topology parsing */
+#define SOF_ABI_MAJOR 3
+#define SOF_ABI_MINOR 18
+#define SOF_ABI_PATCH 0
+#define SOF_ABI_VERSION SOF_ABI_VER(SOF_ABI_MAJOR, SOF_ABI_MINOR, SOF_ABI_PATCH)
+
 struct sof_widget_data {
 	int ctrl_type;
 	int ipc_cmd;
@@ -3595,13 +3601,10 @@ static int sof_manifest(struct snd_soc_component *scomp, int index,
 		return -EINVAL;
 	}
 
-	if (SOF_ABI_VERSION_MINOR(abi_version) > SOF_ABI_MINOR) {
-		if (!IS_ENABLED(CONFIG_SND_SOC_SOF_STRICT_ABI_CHECKS)) {
-			dev_warn(scomp->dev, "warn: topology ABI is more recent than kernel\n");
-		} else {
-			dev_err(scomp->dev, "error: topology ABI is more recent than kernel\n");
-			return -EINVAL;
-		}
+	if (IS_ENABLED(CONFIG_SND_SOC_SOF_STRICT_ABI_CHECKS) &&
+	    SOF_ABI_VERSION_MINOR(abi_version) > SOF_ABI_MINOR) {
+		dev_err(scomp->dev, "topology ABI is more recent than kernel\n");
+		return -EINVAL;
 	}
 
 	return 0;