From 64bb4fb0581591bb67644397c292a18ddd68ec67 Mon Sep 17 00:00:00 2001
From: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
Date: Mon, 13 Jan 2025 15:52:26 +0100
Subject: [PATCH] smart-amp-test: remove obsolete build options

smart-amp-test was one of the first modules, used as an example for
loadable module development. Currently it can be built in 4 ways:
- monolithic
- as an LMDK native module
- as legacy LLEXT
- as current LLEXT
This commit removes legacy options and only preserves the first and
the last options.

Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
---
 lmdk/cmake/ldscripts/data_linker_script.txt   |   2 +-
 lmdk/libraries/smart_amp_test/CMakeLists.txt  |  25 ---
 .../smart_amp_test/smart_amp_test.toml        |  79 ---------
 lmdk/modules/smart_amp_test/CMakeLists.txt    |  16 --
 src/include/ipc4/base-config.h                |   3 +-
 .../sof/samples/audio/smart_amp_test.h        |  16 +-
 src/samples/audio/smart_amp_test_ipc4.c       | 159 +++++++-----------
 7 files changed, 62 insertions(+), 238 deletions(-)
 delete mode 100644 lmdk/libraries/smart_amp_test/CMakeLists.txt
 delete mode 100644 lmdk/libraries/smart_amp_test/smart_amp_test.toml
 delete mode 100644 lmdk/modules/smart_amp_test/CMakeLists.txt

diff --git a/lmdk/cmake/ldscripts/data_linker_script.txt b/lmdk/cmake/ldscripts/data_linker_script.txt
index c04a5ea3d97f..9327079f4d7b 100644
--- a/lmdk/cmake/ldscripts/data_linker_script.txt
+++ b/lmdk/cmake/ldscripts/data_linker_script.txt
@@ -15,7 +15,7 @@ SECTIONS {
         _data_end = ABSOLUTE(.);
     } >HPSRAM_seg : data_phdr
 
-    .rodata : ALIGN(4096) {
+    .rodata : {
         _rodata_start = ABSOLUTE(.);
         *(.gnu.linkonce.r.*)
         *(.rodata)
diff --git a/lmdk/libraries/smart_amp_test/CMakeLists.txt b/lmdk/libraries/smart_amp_test/CMakeLists.txt
deleted file mode 100644
index 0282a83bbf90..000000000000
--- a/lmdk/libraries/smart_amp_test/CMakeLists.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-cmake_minimum_required(VERSION 3.20)
-set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_LIST_DIR}/../../cmake/xtensa-toolchain.cmake")
-
-project(smart_amp_test)
-
-macro(is_zephyr ret)
-        if(CONFIG_ZEPHYR_SOF_MODULE)
-                set(${ret} TRUE)
-        else()
-                set(${ret} FALSE)
-        endif()
-endmacro()
-
-# list of modules to be built and included into this loadable library
-set(MODULES_LIST smart_amp_test)
-
-# toml file for rimage to generate manifets
-set(TOML "${CMAKE_CURRENT_LIST_DIR}/smart_amp_test.toml")
-
-# TODO: Move it somewhere???
-add_definitions(-DMAJOR_IADSP_API_VERSION=5)
-add_definitions(-DMIDDLE_IADSP_API_VERSION=0)
-add_definitions(-DMINOR_IADSP_API_VERSION=0)
-
-include(../../cmake/build.cmake)
diff --git a/lmdk/libraries/smart_amp_test/smart_amp_test.toml b/lmdk/libraries/smart_amp_test/smart_amp_test.toml
deleted file mode 100644
index 34f3463343dd..000000000000
--- a/lmdk/libraries/smart_amp_test/smart_amp_test.toml
+++ /dev/null
@@ -1,79 +0,0 @@
-version = [3, 0]
-
-[adsp]
-name = "mtl"
-image_size = "0x2C0000" # (22) bank * 128KB
-alias_mask = "0xE0000000"
-
-[[adsp.mem_zone]]
-type = "ROM"
-base = "0x1FF80000"
-size = "0x400"
-[[adsp.mem_zone]]
-type = "IMR"
-base = "0xA104A000"
-size = "0x2000"
-[[adsp.mem_zone]]
-type = "SRAM"
-base = "0xa00f0000"
-size = "0x100000"
-
-[[adsp.mem_alias]]
-type = "uncached"
-base = "0x40000000"
-[[adsp.mem_alias]]
-type = "cached"
-base = "0xA0000000"
-
-[cse]
-partition_name = "ADSP"
-[[cse.entry]]
-name = "ADSP.man"
-offset = "0x5c"
-length = "0x464"
-[[cse.entry]]
-name = "ADSP.met"
-offset = "0x4c0"
-length = "0x70"
-[[cse.entry]]
-name = "ADSP"
-offset = "0x540"
-length = "0x0"  # calculated by rimage
-
-[css]
-
-[signed_pkg]
-name = "ADSP"
-[[signed_pkg.module]]
-name = "ADSP.met"
-
-[adsp_file]
-[[adsp_file.comp]]
-base_offset = "0x2000"
-
-[fw_desc.header]
-name = "ADSPFW"
-load_offset = "0x40000"
-
-[module]
-count = 1
-
-	[[module.entry]]
-		name = "SMATEST"
-		uuid = "167A961E-8AE4-11EA-89F1-000C29CE1635"
-		affinity_mask = "0x1"
-		instance_count = "1"
-		domain_types = "0"
-		load_type = "0"
-		init_config = "1"
-		module_type = "0xD"
-		auto_start = "0"
-		sched_caps = [1, 0x00008000]
-
-		# pin = [dir, type, sample rate, size, container, channel-cfg]
-		pin = [0, 0, 0xfeef, 0xf, 0xa, 0x45ff,
-				0, 0, 0xfeef, 0xf, 0xa, 0x45ff,
-				1, 0, 0xfeef, 0xf, 0xa, 0x45ff]
-
-		# mod_cfg [PAR_0 PAR_1 PAR_2 PAR_3 IS_BYTES CPS IBS OBS MOD_FLAGS CPC OBLS]
-		mod_cfg = [0, 0, 0, 0, 4096, 1000000, 128, 128, 0, 0, 0]
diff --git a/lmdk/modules/smart_amp_test/CMakeLists.txt b/lmdk/modules/smart_amp_test/CMakeLists.txt
deleted file mode 100644
index 4c10559fcc03..000000000000
--- a/lmdk/modules/smart_amp_test/CMakeLists.txt
+++ /dev/null
@@ -1,16 +0,0 @@
-target_sources(smart_amp_test PRIVATE ${SOF_BASE}/src/samples/audio/smart_amp_test_ipc4.c)
-
-set_target_properties(smart_amp_test PROPERTIES
-	HPSRAM_ADDR "0xa06c1000"
-)
-
-target_compile_definitions(smart_amp_test PRIVATE
-	__SOF_MODULE_SERVICE_BUILD__=1
-	CONFIG_XTENSA=1
-	CONFIG_IPC_MAJOR_4=1
-)
-
-target_include_directories(smart_amp_test PRIVATE
-    "${SOF_BASE}/src/include"
-    "${SOF_BASE}/posix/include"
-)
diff --git a/src/include/ipc4/base-config.h b/src/include/ipc4/base-config.h
index 07a35a47e9aa..b95ecbd3e1f9 100644
--- a/src/include/ipc4/base-config.h
+++ b/src/include/ipc4/base-config.h
@@ -23,9 +23,8 @@
 
 #ifndef __SOF_IPC4_BASE_CONFIG_H__
 #define __SOF_IPC4_BASE_CONFIG_H__
-#ifndef __SOF_MODULE_SERVICE_BUILD__
+
 #include <sof/compiler_attributes.h>
-#endif
 #include <module/ipc4/base-config.h>
 
 struct sof_ipc_stream_params;
diff --git a/src/include/sof/samples/audio/smart_amp_test.h b/src/include/sof/samples/audio/smart_amp_test.h
index c5ddd8032d99..3feda5005125 100644
--- a/src/include/sof/samples/audio/smart_amp_test.h
+++ b/src/include/sof/samples/audio/smart_amp_test.h
@@ -8,10 +8,8 @@
 #ifndef __SOF_AUDIO_SMART_AMP_H__
 #define __SOF_AUDIO_SMART_AMP_H__
 
-#ifndef __SOF_MODULE_SERVICE_BUILD__
 #include <sof/audio/component.h>
 #include <sof/audio/data_blob.h>
-#endif
 
 #if CONFIG_IPC_MAJOR_4
 #include <ipc4/base-config.h>
@@ -21,20 +19,10 @@
 
 #define SMART_AMP_MAX_STREAM_CHAN   8
 
-/* Max channels for all intel platforms are 8 */
-#define MAX_CHANNELS	8
-
 /** IPC blob types */
 #define SOF_SMART_AMP_CONFIG	0
 #define SOF_SMART_AMP_MODEL	1
 
-#ifdef __SOF_MODULE_SERVICE_BUILD__
-#define LOG_ERR(...)
-#define LOG_WRN(...)
-#define LOG_DBG(...)
-#define LOG_INF(...)
-#endif
-
 struct smart_amp_model_data {
 	uint32_t data_size;
 	void *data;
@@ -95,8 +83,8 @@ struct smart_amp_model_data {
 struct sof_smart_amp_config {
 	uint32_t size;
 	uint32_t feedback_channels;
-	int8_t source_ch_map[MAX_CHANNELS];
-	int8_t feedback_ch_map[MAX_CHANNELS];
+	int8_t source_ch_map[PLATFORM_MAX_CHANNELS];
+	int8_t feedback_ch_map[PLATFORM_MAX_CHANNELS];
 };
 
 #if CONFIG_IPC_MAJOR_4
diff --git a/src/samples/audio/smart_amp_test_ipc4.c b/src/samples/audio/smart_amp_test_ipc4.c
index 41d8ff2db25a..7aeb5c0f2b6f 100644
--- a/src/samples/audio/smart_amp_test_ipc4.c
+++ b/src/samples/audio/smart_amp_test_ipc4.c
@@ -3,8 +3,8 @@
 // Copyright(c) 2020 Intel Corporation. All rights reserved.
 //
 // Author: Bartosz Kokoszko <bartoszx.kokoszko@linux.intel.com>
-
-#ifndef __SOF_MODULE_SERVICE_BUILD__
+#include <sof/compiler_attributes.h>
+#include <sof/samples/audio/smart_amp_test.h>
 #include <sof/audio/module_adapter/module/generic.h>
 #include <sof/audio/ipc-config.h>
 #include <sof/trace/trace.h>
@@ -18,29 +18,11 @@
 #include <ipc4/module.h>
 
 LOG_MODULE_REGISTER(smart_amp_test, CONFIG_SOF_LOG_LEVEL);
-#include <zephyr/logging/log.h>
 
 SOF_DEFINE_REG_UUID(smart_amp_test);
 
 DECLARE_TR_CTX(smart_amp_test_comp_tr, SOF_UUID(smart_amp_test_uuid),
 	       LOG_LEVEL_INFO);
-#else
-#include <string.h>
-#include <stdint.h>
-#include <stddef.h>
-
-#include <module/base.h>
-#include <module/interface.h>
-#include <iadk/adsp_error_code.h>
-#include <audio/source_api.h>
-#include <audio/sink_api.h>
-#include <ipc4/module.h>
-#include <sof/math/numbers.h>
-#endif
-#include <sof/compiler_attributes.h>
-#include <sof/samples/audio/smart_amp_test.h>
-#include <module/module/api_ver.h>
-#include <rimage/sof/user/manifest.h>
 
 typedef void (*smart_amp_proc)(int8_t const *src_ptr,
 			       int8_t const *src_begin,
@@ -53,61 +35,67 @@ typedef void (*smart_amp_proc)(int8_t const *src_ptr,
 struct smart_amp_data {
 	struct sof_smart_amp_ipc4_config ipc4_cfg;
 	struct sof_smart_amp_config config;
+	struct comp_data_blob_handler *model_handler;
+	void *data_blob;
+	size_t data_blob_size;
 	smart_amp_proc process;
 	uint32_t out_channels;
 };
 
-#ifdef __SOF_MODULE_SERVICE_BUILD__
-static struct smart_amp_data smart_amp_priv;
-#endif
-
 /* When building as a loadable module, we need .bss to avoid rimage errors */
 static int keep_bss __attribute__((used));
 
 static int smart_amp_init(struct processing_module *mod)
 {
 	struct smart_amp_data *sad;
+	struct comp_dev *dev = mod->dev;
 	struct module_data *mod_data = &mod->priv;
-	int ret;
+	const size_t in_size = sizeof(struct ipc4_input_pin_format) * SMART_AMP_NUM_IN_PINS;
+	const size_t out_size = sizeof(struct ipc4_output_pin_format) * SMART_AMP_NUM_OUT_PINS;
 	const struct ipc4_base_module_extended_cfg *base_cfg = mod_data->cfg.init_data;
+	int ret;
 
 	if (!base_cfg) {
-		LOG_ERR("smart_amp_init(): no module configuration");
+		comp_err(dev, "No module configuration");
 		return -EINVAL;
 	}
 
-	LOG_DBG("smart_amp_init()");
+	comp_dbg(dev, "entry");
 
-#ifndef __SOF_MODULE_SERVICE_BUILD__
 	sad = rzalloc(SOF_MEM_ZONE_RUNTIME, 0, SOF_MEM_CAPS_RAM, sizeof(*sad));
 	if (!sad)
 		return -ENOMEM;
-#else
-	sad = &smart_amp_priv;
-#endif
+
 	mod_data->private = sad;
 
+	/* component model data handler */
+	sad->model_handler = comp_data_blob_handler_new(dev);
+	if (!sad->model_handler) {
+		ret = -ENOMEM;
+		goto sad_fail;
+	}
+
 	if (base_cfg->base_cfg_ext.nb_input_pins != SMART_AMP_NUM_IN_PINS ||
 	    base_cfg->base_cfg_ext.nb_output_pins != SMART_AMP_NUM_OUT_PINS) {
+		comp_err(dev, "Invalid pin configuration");
 		ret = -EINVAL;
 		goto sad_fail;
 	}
 
 	/* Copy the pin formats */
-	sad->ipc4_cfg.input_pins[0] =
-		*((struct ipc4_input_pin_format *)base_cfg->base_cfg_ext.pin_formats);
-	sad->ipc4_cfg.input_pins[1] =
-		*((struct ipc4_input_pin_format *)base_cfg->base_cfg_ext.pin_formats + 1);
-	sad->ipc4_cfg.output_pin =
-		*(struct ipc4_output_pin_format *)(base_cfg->base_cfg_ext.pin_formats
-			+ sizeof(sad->ipc4_cfg.input_pins));
+	memcpy_s(sad->ipc4_cfg.input_pins, in_size,
+		 base_cfg->base_cfg_ext.pin_formats, in_size);
+	memcpy_s(&sad->ipc4_cfg.output_pin, out_size,
+		 &base_cfg->base_cfg_ext.pin_formats[in_size], out_size);
+
+	mod->max_sources = SMART_AMP_NUM_IN_PINS;
 
 	return 0;
 
 sad_fail:
-#ifndef __SOF_MODULE_SERVICE_BUILD__
+	comp_data_blob_handler_free(sad->model_handler);
 	rfree(sad);
-#endif
+
 	return ret;
 }
 
@@ -116,21 +104,23 @@ static int smart_amp_set_config(struct processing_module *mod, uint32_t config_i
 				const uint8_t *fragment, size_t fragment_size, uint8_t *response,
 				size_t response_size)
 {
+	struct comp_dev *dev = mod->dev;
 	struct smart_amp_data *sad = module_get_private_data(mod);
 
-	LOG_DBG("smart_amp_set_config()");
+	comp_dbg(dev, "smart_amp_set_config()");
 
 	switch (config_id) {
 	case SMART_AMP_SET_MODEL:
-		return 0;
+		return comp_data_blob_set(sad->model_handler, pos,
+					 data_offset_size, fragment, fragment_size);
 	case SMART_AMP_SET_CONFIG:
 		if (fragment_size != sizeof(sad->config)) {
-			LOG_ERR("smart_amp_set_config(): invalid config size %u, expect %u",
-				fragment_size, sizeof(struct sof_smart_amp_config));
+			comp_err(dev, "smart_amp_set_config(): invalid config size %u, expect %u",
+				 fragment_size, sizeof(struct sof_smart_amp_config));
 			return -EINVAL;
 		}
-		LOG_DBG("smart_amp_set_config(): config size = %u", fragment_size);
-		sad->config = *(struct sof_smart_amp_config *)fragment;
+		comp_dbg(dev, "smart_amp_set_config(): config size = %u", fragment_size);
+		memcpy_s(&sad->config, sizeof(sad->config), fragment, fragment_size);
 		return 0;
 	default:
 		return -EINVAL;
@@ -142,12 +132,19 @@ static inline int smart_amp_get_config(struct processing_module *mod,
 				       uint8_t *fragment, size_t fragment_size)
 {
 	struct smart_amp_data *sad = module_get_private_data(mod);
+	struct comp_dev *dev = mod->dev;
+	int ret;
 
-	LOG_DBG("smart_amp_get_config()");
+	comp_dbg(dev, "smart_amp_get_config()");
 
 	switch (config_id) {
 	case SMART_AMP_GET_CONFIG:
-		 *(struct sof_smart_amp_config *)fragment = sad->config;
+		ret = memcpy_s(fragment, fragment_size, &sad->config, sizeof(sad->config));
+		if (ret) {
+			comp_err(dev, "smart_amp_get_config(): wrong config size %d",
+				 fragment_size);
+			return ret;
+		}
 		*data_offset_size = sizeof(sad->config);
 		return 0;
 	default:
@@ -157,11 +154,12 @@ static inline int smart_amp_get_config(struct processing_module *mod,
 
 static int smart_amp_free(struct processing_module *mod)
 {
-#ifndef __SOF_MODULE_SERVICE_BUILD__
 	struct smart_amp_data *sad = module_get_private_data(mod);
+	struct comp_dev *dev = mod->dev;
 
+	comp_dbg(dev, "smart_amp_free()");
+	comp_data_blob_handler_free(sad->model_handler);
 	rfree(sad);
-#endif
 
 	return 0;
 }
@@ -333,7 +331,6 @@ static smart_amp_proc get_smart_amp_process(struct sof_source **sources, int num
 		case SOF_IPC_FRAME_S32_LE:
 			break;
 		default:
-			LOG_ERR("smart_amp_process() error: not supported frame format");
 			return NULL;
 		}
 	}
@@ -345,7 +342,6 @@ static smart_amp_proc get_smart_amp_process(struct sof_source **sources, int num
 		case SOF_IPC_FRAME_S32_LE:
 			break;
 		default:
-			LOG_ERR("smart_amp_process() error: not supported frame format");
 			return NULL;
 		}
 	}
@@ -357,12 +353,11 @@ static int smart_amp_prepare(struct processing_module *mod,
 			     struct sof_sink **sinks, int num_of_sinks)
 {
 	struct smart_amp_data *sad = module_get_private_data(mod);
-
-	LOG_DBG("smart_amp_prepare()");
+	struct comp_dev *dev = mod->dev;
 
 	sad->process = get_smart_amp_process(sources, num_of_sources, sinks, num_of_sinks);
 	if (!sad->process) {
-		LOG_ERR("smart_amp_prepare(): get_smart_amp_process failed");
+		comp_err(dev, "get_smart_amp_process() failed");
 		return -EINVAL;
 	}
 
@@ -379,61 +374,23 @@ static const struct module_interface smart_amp_test_interface = {
 	.free = smart_amp_free
 };
 
-/*
- * We have to distinguish between 3 kinds of builds:
- * 1. built-in: MAJOR_IADSP_API_VERSION isn't defined
- * 2. system-service API: MAJOR_IADSP_API_VERSION and
- *    __SOF_MODULE_SERVICE_BUILD__ are defined
- * 3. dynamic linking: only MAJOR_IADSP_API_VERSION is defined
- */
-
-#ifndef __SOF_MODULE_SERVICE_BUILD__
-/* All builds except system-service API */
-
 DECLARE_MODULE_ADAPTER(smart_amp_test_interface, smart_amp_test_uuid, smart_amp_test_comp_tr);
-/* DECLARE_MODULE_ADAPTER() creates
- * "sys_comp_module_<smart_amp_test_interface>_init()" (and a lot more)
- */
 SOF_MODULE_INIT(smart_amp_test, sys_comp_module_smart_amp_test_interface_init);
 
-#endif
-
-#if defined(MAJOR_IADSP_API_VERSION) || defined(CONFIG_SAMPLE_SMART_AMP_MODULE)
-/* modular: system-services or dynamic link */
+#if CONFIG_SAMPLE_SMART_AMP_MODULE
+/* modular: llext dynamic link */
 
+#include <module/module/api_ver.h>
 #include <module/module/llext.h>
+#include <rimage/sof/user/manifest.h>
 
+#define UUID_SMART_AMP_TEST 0x1e, 0x96, 0x7a, 0x16, 0xe4, 0x8a, 0xea, 0x11, \
+			0x89, 0xf1, 0x00, 0x0c, 0x29, 0xce, 0x16, 0x35
 SOF_LLEXT_MOD_ENTRY(smart_amp_test, &smart_amp_test_interface);
 
-static const struct sof_man_module_manifest main_manifest __section(".module") __attribute__((used)) = {
-	.module = {
-		.name = "SMATEST",
-		.uuid = {0x1E, 0x96, 0x7A, 0x16, 0xE4, 0x8A, 0xEA, 0x11,
-			 0x89, 0xF1, 0x00, 0x0C, 0x29, 0xCE, 0x16, 0x35},
-		.entry_point = (uint32_t)smart_amp_test_llext_entry,
-		.instance_max_count = 1,
-		.type = {
-#ifdef __SOF_MODULE_SERVICE_BUILD__
-			.load_type = SOF_MAN_MOD_TYPE_MODULE,
-#else
-			.load_type = SOF_MAN_MOD_TYPE_LLEXT,
-#endif
-			.domain_ll = 1,
-		},
-		.affinity_mask = 1,
-	}
+static const struct sof_man_module_manifest mod_manifest[] __section(".module") __used = {
+	SOF_LLEXT_MODULE_MANIFEST("SMATEST", smart_amp_test_llext_entry, 1, UUID_SMART_AMP_TEST, 1),
 };
 
-#ifdef __SOF_MODULE_SERVICE_BUILD__
-/* system services */
-
-DECLARE_LOADABLE_MODULE_API_VERSION(smart_amp_test);
-
-#else
-/* dynamic link */
-
 SOF_LLEXT_BUILDINFO;
-
-#endif
-
 #endif