ipc4: module: interface: module_adapter: Add support for Config Get/Set ipc

Add support for Config Get and Config Set ipc commands. Handle them through
the get_attribute and set_attribute methods of the component with the
COMP_ATTR_IPC4_CONFIG parameter. Add the set_config_param and
get_config_param functions to the module interface. Extend the
functionality of module adapter to call the above functions to handle ipc
request. Increase the version of module api due to modification of
module_interface structure.

Using Module Config Get / Set command, host driver may send a parameter
that fits into the header (a very short one), packed along with
parameter id. Larger parameters require fragmentation and a series of
Large Config Set commands.

Signed-off-by: Adrian Warecki <adrian.warecki@intel.com>

Author: softwarecki

src/audio/module_adapter/module_adapter_ipc4.c

@@ -171,12 +171,17 @@ EXPORT_SYMBOL(module_get_large_config);
 int module_adapter_get_attribute(struct comp_dev *dev, uint32_t type, void *value)
 {
 	struct processing_module *mod = comp_mod(dev);
+	const struct module_interface *const interface = mod->dev->drv->adapter_ops;
 
 	switch (type) {
 	case COMP_ATTR_BASE_CONFIG:
 		memcpy_s(value, sizeof(struct ipc4_base_module_cfg),
 			 &mod->priv.cfg.base_cfg, sizeof(mod->priv.cfg.base_cfg));
 		break;
+	case COMP_ATTR_IPC4_CONFIG:
+		if (interface->get_config_param)
+			return interface->get_config_param(mod, (uint32_t *)value);
+		return -ENOEXEC;
 	default:
 		return -EINVAL;
 	}
@@ -185,6 +190,24 @@ int module_adapter_get_attribute(struct comp_dev *dev, uint32_t type, void *valu
 }
 EXPORT_SYMBOL(module_adapter_get_attribute);
 
+int module_adapter_set_attribute(struct comp_dev *dev, uint32_t type, void *value)
+{
+	struct processing_module *mod = comp_mod(dev);
+	const struct module_interface *const interface = mod->dev->drv->adapter_ops;
+
+	switch (type) {
+	case COMP_ATTR_IPC4_CONFIG:
+		if (interface->set_config_param)
+			return interface->set_config_param(mod, *(uint32_t *)value);
+		return -ENOEXEC;
+	default:
+		return -EINVAL;
+	}
+
+	return 0;
+}
+EXPORT_SYMBOL(module_adapter_set_attribute);
+
 static bool module_adapter_multi_sink_source_prepare(struct comp_dev *dev)
 {
 	struct processing_module *mod = comp_mod(dev);

src/include/module/module/api_ver.h

@@ -21,7 +21,7 @@
 
 #define SOF_MODULE_API_MAJOR_VERSION	5
 #define SOF_MODULE_API_MIDDLE_VERSION	0
-#define SOF_MODULE_API_MINOR_VERSION	0
+#define SOF_MODULE_API_MINOR_VERSION	1
 
 #define SOF_MODULE_API_CURRENT_VERSION	MODULE_API_VERSION_ENCODE(SOF_MODULE_API_MAJOR_VERSION,	\
 	SOF_MODULE_API_MIDDLE_VERSION, SOF_MODULE_API_MINOR_VERSION)

src/include/module/module/interface.h

@@ -66,6 +66,18 @@ struct processing_module;
 struct sof_source;
 struct sof_sink;
 
+/*
+ * This structure may be used by modules to carry short 16bit parameters.
+ */
+union config_param_id_data {
+	uint32_t dw;
+	struct {
+		uint32_t data16	: 16;	/* Input/Output small config data */
+		uint32_t id	: 14;	/* input parameter ID */
+		uint32_t _rsvd	: 2;
+	} f;
+};
+
 /**
  * \struct module_interface
  * \brief 3rd party processing module interface
@@ -170,6 +182,30 @@ struct module_interface {
 				struct output_stream_buffer *output_buffers,
 				int num_output_buffers);
 
+	/**
+	 * (optional) Set module configuration parameter
+	 *
+	 * Using Module Config Set command, host driver may send a parameter
+	 * that fits into the header (a very short one), packed along with parameter id.
+	 *
+	 * param_id_data specifies both ID of the parameter, defined by the module
+	 * and value of the parameter.
+	 * It is up to the module how to distribute bits to ID and value of the parameter.
+	 */
+	int (*set_config_param)(struct processing_module *mod, uint32_t param_id_data);
+
+	/**
+	 * (optional) Get module configuration parameter
+	 *
+	 * Using Module Config Get command, host driver may send a parameter
+	 * that fits into the header (a very short one), packed along with parameter id.
+	 *
+	 * param_id_data specifies both ID of the parameter, defined by the module
+	 * and value of the parameter.
+	 * It is up to the module how to distribute bits to ID and value of the parameter.
+	 */
+	int (*get_config_param)(struct processing_module *mod, uint32_t *param_id_data);
+
 	/**
 	 * (optional) Set module configuration for the given configuration ID
 	 *

src/include/sof/audio/component.h

@@ -119,6 +119,7 @@ enum {
 #define COMP_ATTR_COPY_DIR	2	/**< Comp copy direction */
 #define COMP_ATTR_VDMA_INDEX	3	/**< Comp index of the virtual DMA at the gateway. */
 #define COMP_ATTR_BASE_CONFIG	4	/**< Component base config */
+#define COMP_ATTR_IPC4_CONFIG	5	/**< Component ipc4 set/get config */
 /** @}*/
 
 /** \name Trace macros

src/include/sof/audio/module_adapter/module/generic.h

@@ -61,6 +61,7 @@ static const struct comp_driver comp_##adapter##_module = { \
 		.set_large_config = module_set_large_config,\
 		.get_large_config = module_get_large_config,\
 		.get_attribute = module_adapter_get_attribute,\
+		.set_attribute = module_adapter_set_attribute,\
 		.bind = module_adapter_bind,\
 		.unbind = module_adapter_unbind,\
 		.get_total_data_processed = module_adapter_get_total_data_processed,\
@@ -224,6 +225,12 @@ int module_adapter_get_attribute(struct comp_dev *dev, uint32_t type, void *valu
 	return -EINVAL;
 }
 
+static inline
+int module_adapter_set_attribute(struct comp_dev *dev, uint32_t type, void *value)
+{
+	return -EINVAL;
+}
+
 static inline
 int module_set_large_config(struct comp_dev *dev, uint32_t param_id, bool first_block,
 			    bool last_block, uint32_t data_offset, const char *data)
@@ -273,6 +280,7 @@ int module_set_large_config(struct comp_dev *dev, uint32_t param_id, bool first_
 int module_get_large_config(struct comp_dev *dev, uint32_t param_id, bool first_block,
 			    bool last_block, uint32_t *data_offset, char *data);
 int module_adapter_get_attribute(struct comp_dev *dev, uint32_t type, void *value);
+int module_adapter_set_attribute(struct comp_dev *dev, uint32_t type, void *value);
 int module_adapter_bind(struct comp_dev *dev, void *data);
 int module_adapter_unbind(struct comp_dev *dev, void *data);
 uint64_t module_adapter_get_total_data_processed(struct comp_dev *dev,

src/ipc/ipc4/handler.c

@@ -968,6 +968,58 @@ __cold static int ipc4_unbind_module_instance(struct ipc4_message_request *ipc4)
 	return ipc_comp_disconnect(ipc, (ipc_pipe_comp_connect *)&bu);
 }
 
+static int ipc4_set_get_config_module_instance(struct ipc4_message_request *ipc4, bool set)
+{
+	struct ipc4_module_config *config = (struct ipc4_module_config *)ipc4;
+	int (*function)(struct comp_dev *dev, uint32_t type, void *value);
+	const struct comp_driver *drv;
+	struct comp_dev *dev = NULL;
+	int ret;
+
+	tr_dbg(&ipc_tr, "ipc4_set_get_config_module_instance %x : %x, set %d",
+	       (uint32_t)config->primary.r.module_id, (uint32_t)config->primary.r.instance_id,
+	       !!set);
+
+	/* get component dev for non-basefw since there is no component dev for basefw */
+	if (config->primary.r.module_id) {
+		uint32_t comp_id;
+
+		comp_id = IPC4_COMP_ID(config->primary.r.module_id, config->primary.r.instance_id);
+		dev = ipc4_get_comp_dev(comp_id);
+		if (!dev)
+			return IPC4_MOD_INVALID_ID;
+
+		drv = dev->drv;
+
+		/* Pass IPC to target core */
+		if (!cpu_is_me(dev->ipc_config.core))
+			return ipc4_process_on_core(dev->ipc_config.core, false);
+	} else {
+		drv = ipc4_get_comp_drv(config->primary.r.module_id);
+	}
+
+	if (!drv)
+		return IPC4_MOD_INVALID_ID;
+
+	function = set ? drv->ops.set_attribute : drv->ops.get_attribute;
+	if (!function)
+		return IPC4_INVALID_REQUEST;
+
+	ret = function(dev, COMP_ATTR_IPC4_CONFIG, &config->extension.dat);
+	if (ret < 0) {
+		ipc_cmd_err(&ipc_tr, "ipc4_set_get_config_module_instance %x : %x failed %d, set %u, param %x",
+			    (uint32_t)config->primary.r.module_id,
+			    (uint32_t)config->primary.r.instance_id, ret, !!set,
+			    (uint32_t)config->extension.dat);
+		ret = IPC4_INVALID_CONFIG_PARAM_ID;
+	}
+
+	if (!set)
+		msg_reply.extension = config->extension.dat;
+
+	return ret;
+}
+
 __cold static int  ipc4_get_vendor_config_module_instance(struct comp_dev *dev,
 						   const struct comp_driver *drv,
 						   bool init_block,
@@ -1463,9 +1515,10 @@ __cold static int ipc4_process_module_message(struct ipc4_message_request *ipc4)
 		ret = ipc4_init_module_instance(ipc4);
 		break;
 	case SOF_IPC4_MOD_CONFIG_GET:
+		ret = ipc4_set_get_config_module_instance(ipc4, false);
+		break;
 	case SOF_IPC4_MOD_CONFIG_SET:
-		ret = IPC4_UNAVAILABLE;
-		tr_info(&ipc_tr, "unsupported module CONFIG_GET");
+		ret = ipc4_set_get_config_module_instance(ipc4, true);
 		break;
 	case SOF_IPC4_MOD_LARGE_CONFIG_GET:
 		ret = ipc4_get_large_config_module_instance(ipc4);

src/library_manager/lib_manager.c

@@ -572,6 +572,7 @@ static void lib_manager_prepare_module_adapter(struct comp_driver *drv, const st
 	drv->ops.set_large_config = module_set_large_config;
 	drv->ops.get_large_config = module_get_large_config;
 	drv->ops.get_attribute = module_adapter_get_attribute;
+	drv->ops.set_attribute = module_adapter_set_attribute;
 	drv->ops.bind = module_adapter_bind;
 	drv->ops.unbind = module_adapter_unbind;
 	drv->ops.get_total_data_processed = module_adapter_get_total_data_processed;