audio: iadk: accept module API 4.5.2

Accept IADK module API 4.5.2 in addition to 4.5.0. Extend the
detector and system-agent vtables and append the versioned
system-service lookup slot without changing earlier slots.

This only establishes the 4.5.2 ABI. Services unavailable in the base
firmware return an error and clear the interface pointer.

Signed-off-by: Gaggery Tsai <gaggery.tsai@intel.com>

Author: TsaiGaggery

src/audio/module_adapter/iadk/README.md

@@ -50,6 +50,12 @@ classDiagram
 
 Because the actual module resides in an external binary, it requires a "System Agent" to correctly instantiate the C++ objects during the component's `init` phase.
 
+The adapter accepts IADK API 4.5.0 and 4.5.2 binaries. API 4.5.2
+extends the detector interface with `WritePattern()`, adds
+`SystemAgentInterface3::GetBssBase()`, and appends a versioned lookup
+entry to the system service table. The existing table and vtable slots
+keep their API 4.5.0 layout.
+
 1. The OS host driver sends an IPC `INIT_INSTANCE` command for the module.
 2. The `system_agent_start()` function intercepts this, invokes the dynamic module's `create_instance` entry point (which invokes a `ModuleFactory`).
 3. The `SystemAgent` deduces the pin count (interfaces) and initial pipeline configurations using `ModuleInitialSettingsConcrete`.

src/audio/module_adapter/iadk/system_agent.cpp

@@ -24,6 +24,14 @@
 #include <sof/audio/module_adapter/library/native_system_service.h>
 #include <sof/audio/module_adapter/library/native_system_agent.h>
 
+struct sof_man_module;
+extern "C" const struct sof_man_module *
+lib_manager_get_module_manifest(const uint32_t module_id);
+extern "C" void
+lib_manager_get_instance_bss_address(uint32_t instance_id,
+				     const struct sof_man_module *mod,
+				     void **va_addr, size_t *size);
+
 using namespace intel_adsp;
 using namespace intel_adsp::system;
 using namespace dsp_fw;
@@ -47,6 +55,7 @@ const APP_TASK_DATA AdspSystemService SystemAgent::system_service_ = {
 	native_system_service_create_notification,
 	native_system_service_send_notif_msg,
 	native_system_service_get_interface,
+	native_system_service_get_interface_versioned,
 };
 
 SystemAgent::SystemAgent(uint32_t module_id,
@@ -79,6 +88,27 @@ void SystemAgent::CheckIn(ProcessingModuleInterface& processing_module,
 	log_handle = reinterpret_cast<LogHandle*>(log_handle_);
 }
 
+void SystemAgent::CheckInDetector(DetectorModuleInterface& processing_module,
+				  ModuleHandle &module_handle,
+				  LogHandle *&log_handle)
+{
+	CheckIn(static_cast<ProcessingModuleInterface&>(processing_module),
+		module_handle, log_handle);
+}
+
+void *SystemAgent::GetBssBase(void)
+{
+	const struct sof_man_module *mod = lib_manager_get_module_manifest(module_id_);
+	void *base = NULL;
+	size_t size = 0;
+
+	if (!mod)
+		return NULL;
+
+	lib_manager_get_instance_bss_address(instance_id_, mod, &base, &size);
+	return base;
+}
+
 int SystemAgent::CheckIn(ProcessingModuleFactoryInterface& module_factory,
 			 ModulePlaceholder *module_placeholder,
 			 size_t processing_module_size,
@@ -148,4 +178,3 @@ extern "C" void __cxa_pure_virtual()  __attribute__((weak));
 void __cxa_pure_virtual()
 {
 }
-

src/audio/module_adapter/library/native_system_service.c

@@ -158,9 +158,20 @@ AdspErrorCode native_system_service_send_notif_msg(enum notification_target noti
 AdspErrorCode native_system_service_get_interface(enum interface_id id,
 						  struct system_service_iface **iface)
 {
-	if (id < 0)
+	if (id < 0 || !iface)
 		return ADSP_INVALID_PARAMETERS;
-	return ADSP_NO_ERROR;
+
+	*iface = NULL;
+	return ADSP_INVALID_PARAMETERS;
+}
+
+AdspErrorCode native_system_service_get_interface_versioned(enum interface_id id,
+							    uint32_t version,
+							    struct system_service_iface **iface)
+{
+	(void)version;
+
+	return native_system_service_get_interface(id, iface);
 }
 
 const APP_TASK_DATA struct native_system_service native_system_service = {
@@ -171,6 +182,7 @@ const APP_TASK_DATA struct native_system_service native_system_service = {
 		.vec_memset = native_system_service_vec_memset,
 		.notification_create = native_system_service_create_notification,
 		.notification_send = native_system_service_send_notif_msg,
-		.get_interface = native_system_service_get_interface
+		.get_interface = native_system_service_get_interface,
+		.get_interface_versioned = native_system_service_get_interface_versioned
 	}
 };

src/include/module/module/system_service.h

@@ -79,7 +79,8 @@ enum interface_id {
 	INTERFACE_ID_SDCA = 0x1002,			/* See SdcaInterface */
 	INTERFACE_ID_ASYNC_MESSAGE_SERVICE = 0x1003,	/* See AsyncMessageInterface */
 	INTERFACE_ID_AM_SERVICE = 0x1005,		/* Reserved for ADSP system */
-	INTERFACE_ID_KPB_SERVICE = 0x1006		/* See KpbInterface */
+	INTERFACE_ID_KPB_SERVICE = 0x1006,		/* See KpbInterface */
+	INTERFACE_ID_TIMESTAMPING_SERVICE = 0x1007	/* See TimestampingInterface */
 };
 
 /* sub interface definition.
@@ -109,5 +110,8 @@ struct system_service {
 					   uint32_t actual_payload_size);
 
 	AdspErrorCode (*get_interface)(enum interface_id id, struct system_service_iface **iface);
+
+	AdspErrorCode (*get_interface_versioned)(enum interface_id id, uint32_t version,
+						 struct system_service_iface **iface);
 };
 #endif /* MODULE_MODULE_SYSTEM_SERVICE_H */

src/include/sof/audio/module_adapter/iadk/api_version.h

@@ -14,11 +14,14 @@
 
 #define IADK_MODULE_API_MAJOR_VERSION		4
 #define IADK_MODULE_API_MIDDLE_VERSION		5
-#define IADK_MODULE_API_MINOR_VERSION		0
+#define IADK_MODULE_API_MINOR_VERSION		2
 
 #define IADK_MODULE_API_CURRENT_VERSION	MODULE_API_VERSION_ENCODE(IADK_MODULE_API_MAJOR_VERSION, \
 	IADK_MODULE_API_MIDDLE_VERSION, IADK_MODULE_API_MINOR_VERSION)
 
+/* API 4.5.0 remains compatible with the extended interface tables. */
+#define IADK_MODULE_API_VERSION_4_5_0	MODULE_API_VERSION_ENCODE(4, 5, 0)
+
 /* Defines the size of the space reserved within ModuleHandle for SOF to store its private data.
  * This size comes from the IADK header files and must match the IADK API version.
  * Please do not modify this value!

src/include/sof/audio/module_adapter/iadk/processing_module_interface.h

@@ -399,6 +399,10 @@ namespace intel_adsp
 		virtual void OnStreamState(uint64_t counter,
 					uint32_t stream_index,
 					State state) = 0;
+
+		/*! Write a pattern when an output stream resumes processing. */
+		virtual void WritePattern(uint16_t stream_index,
+					  OutputStreamBuffer *output_buffer) = 0;
 	};
 } /*namespace intel_adsp */
 

src/include/sof/audio/module_adapter/iadk/system_agent.h

@@ -21,7 +21,7 @@ namespace system
 	 * A SystemAgent can only be delivered by the ADSP System.
 	 * Once registered, a ModuleHandle instance can be handled by the ADSP System.
 	 */
-	class SystemAgent : public intel_adsp::SystemAgentInterface
+	class SystemAgent : public intel_adsp::SystemAgentInterface3
 	{
 	public:
 		SystemAgent(uint32_t module_id,
@@ -34,6 +34,15 @@ namespace system
 				     intel_adsp::ModuleHandle & module_handle,
 				     intel_adsp::LogHandle * &log_handle) /*override*/;
 
+		/*! \brief Registers a detector module. */
+		virtual void CheckInDetector(
+			DetectorModuleInterface & processing_module,
+			ModuleHandle & module_handle,
+			LogHandle * &log_handle) /*override*/;
+
+		/*! \brief Returns the BSS base for the current module instance. */
+		virtual void *GetBssBase(void) /*override*/;
+
 		/*! \return a value part of error code list defined within the adsp_error.h*/
 		virtual int CheckIn(intel_adsp::ProcessingModuleFactoryInterface & module_factory,
 				    intel_adsp::ModulePlaceholder * module_placeholder,

src/include/sof/audio/module_adapter/iadk/system_agent_interface.h

@@ -134,6 +134,14 @@ namespace internal
 					    ) = 0;
 	};
 
+	class SystemAgentInterface3 : public SystemAgentInterface2
+	{
+	public:
+
+		/*! \brief Gets the BSS base for the current module instance. */
+		virtual void *GetBssBase(void) = 0;
+	};
+
 } /* namespace intel_adsp */
 
 #endif /* _ADSP_SYSTEM_AGENT_H_ */

src/include/sof/audio/module_adapter/library/native_system_service.h

@@ -42,6 +42,18 @@ AdspErrorCode native_system_service_send_notif_msg(enum notification_target noti
 AdspErrorCode native_system_service_get_interface(enum interface_id id,
 						  struct system_service_iface **iface);
 
+/**
+ * \brief Retrieve a versioned system service interface.
+ *
+ * \param id Service interface identifier.
+ * \param version Requested interface version.
+ * \param iface Location for the returned interface pointer.
+ * \return ADSP_INVALID_PARAMETERS if the interface is unavailable.
+ */
+AdspErrorCode native_system_service_get_interface_versioned(enum interface_id id,
+							    uint32_t version,
+							    struct system_service_iface **iface);
+
 extern const struct native_system_service native_system_service;
 
 #ifdef __cplusplus

src/library_manager/lib_manager.c

@@ -628,7 +628,8 @@ static enum buildinfo_mod_type lib_manager_get_module_type(const struct sof_man_
 	/* Check if module is IADK */
 	if (IS_ENABLED(CONFIG_INTEL_MODULES) &&
 	    build_info->format == IADK_MODULE_API_BUILD_INFO_FORMAT &&
-	    build_info->api_version_number.full == IADK_MODULE_API_CURRENT_VERSION) {
+	    (build_info->api_version_number.full == IADK_MODULE_API_CURRENT_VERSION ||
+	     build_info->api_version_number.full == IADK_MODULE_API_VERSION_4_5_0)) {
 		return MOD_TYPE_IADK;
 	} else {
 		/* Check if module is NOT native */