Audio: Copier: All memory allocations through module API

Allocate all memory through module API mod_alloc() and friends
and remove all redundant rfree() calls from module unload
functions and init error branches.

When resources are allocated through module API functions they
are automatically freed when the module is unloaded. This
simplifies error handling process.

NOTE: copier_dai.c and copier_host.c still have their shared memory
allocated through the old API. This is to be fixed once we have
decided on how the shared memory allocations should work in
user-space.

Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>

Author: Jyri Sarha

src/audio/copier/copier.c

@@ -15,7 +15,6 @@
 #include <sof/ipc/topology.h>
 #include <rtos/interrupt.h>
 #include <rtos/timer.h>
-#include <rtos/alloc.h>
 #include <rtos/cache.h>
 #include <rtos/init.h>
 #include <sof/lib/memory.h>
@@ -82,13 +81,12 @@ static void mic_privacy_event(void *arg, enum notify_id type, void *data)
 	}
 }
 
-static int mic_privacy_configure(struct comp_dev *dev, struct copier_data *cd)
+static int mic_privacy_configure(struct processing_module *mod, struct copier_data *cd)
 {
 	struct mic_privacy_data *mic_priv_data;
 	int ret;
 
-	mic_priv_data = rzalloc(SOF_MEM_FLAG_USER,
-				sizeof(struct mic_privacy_data));
+	mic_priv_data = mod_zalloc(mod, sizeof(struct mic_privacy_data));
 	if (!mic_priv_data)
 		return -ENOMEM;
 
@@ -100,19 +98,15 @@ static int mic_privacy_configure(struct comp_dev *dev, struct copier_data *cd)
 	uint32_t zeroing_wait_time = (mic_privacy_get_dma_zeroing_wait_time() * 1000) /
 				     ADSP_RTC_FREQUENCY;
 
-	ret = copier_gain_set_params(dev, &mic_priv_data->mic_priv_gain_params,
+	ret = copier_gain_set_params(mod->dev, &mic_priv_data->mic_priv_gain_params,
 				     zeroing_wait_time, SOF_DAI_INTEL_NONE);
-	if (ret != 0) {
-		rfree(mic_priv_data);
+	if (ret != 0)
 		return ret;
-	}
 
 	cd->mic_priv = mic_priv_data;
 
 	ret = notifier_register(cd->mic_priv, NULL, NOTIFIER_ID_MIC_PRIVACY_STATE_CHANGE,
 				mic_privacy_event, 0);
-	if (ret != 0)
-		rfree(mic_priv_data);
 
 	return ret;
 }
@@ -123,8 +117,6 @@ static void mic_privacy_free(struct copier_data *cd)
 		mic_privacy_enable_dmic_irq(false);
 
 	notifier_unregister(cd->mic_priv, NULL, NOTIFIER_ID_MIC_PRIVACY_STATE_CHANGE);
-
-	rfree(cd->mic_priv);
 }
 #endif
 
@@ -141,7 +133,7 @@ __cold static int copier_init(struct processing_module *mod)
 
 	assert_can_be_cold();
 
-	cd = rzalloc(SOF_MEM_FLAG_USER, sizeof(*cd));
+	cd = mod_zalloc(mod, sizeof(*cd));
 	if (!cd)
 		return -ENOMEM;
 
@@ -151,10 +143,8 @@ __cold static int copier_init(struct processing_module *mod)
 	 * store it, it's only used during IPC processing, besides we haven't
 	 * allocated space for it, so don't "fix" this!
 	 */
-	if (memcpy_s(&cd->config, sizeof(cd->config), copier, sizeof(*copier)) < 0) {
-		ret = -EINVAL;
-		goto error_cd;
-	}
+	if (memcpy_s(&cd->config, sizeof(cd->config), copier, sizeof(*copier)) < 0)
+		return -EINVAL;
 
 	/* Allocate memory and store gateway_cfg in runtime. Gateway cfg has to
 	 * be kept even after copier is created e.g. during SET_PIPELINE_STATE
@@ -163,18 +153,15 @@ __cold static int copier_init(struct processing_module *mod)
 	 */
 	if (copier->gtw_cfg.config_length) {
 		gtw_cfg_size = copier->gtw_cfg.config_length << 2;
-		gtw_cfg = rmalloc(SOF_MEM_FLAG_USER,
-				  gtw_cfg_size);
-		if (!gtw_cfg) {
-			ret = -ENOMEM;
-			goto error_cd;
-		}
+		gtw_cfg = mod_alloc(mod, gtw_cfg_size);
+		if (!gtw_cfg)
+			return -ENOMEM;
 
 		ret = memcpy_s(gtw_cfg, gtw_cfg_size, &copier->gtw_cfg.config_data,
 			       gtw_cfg_size);
 		if (ret) {
 			comp_err(dev, "Unable to copy gateway config from copier blob");
-			goto error;
+			return ret;
 		}
 
 		cd->gtw_cfg = gtw_cfg;
@@ -191,18 +178,18 @@ __cold static int copier_init(struct processing_module *mod)
 		switch (node_id.f.dma_type) {
 		case ipc4_hda_host_output_class:
 		case ipc4_hda_host_input_class:
-			ret = copier_host_create(dev, cd, copier, dev->pipeline);
+			ret = copier_host_create(mod, cd, copier, dev->pipeline);
 			if (ret < 0) {
 				comp_err(dev, "unable to create host");
-				goto error;
+				return ret;
 			}
 #if CONFIG_INTEL_ADSP_MIC_PRIVACY
 			if (cd->direction == SOF_IPC_STREAM_CAPTURE &&
 			    node_id.f.dma_type == ipc4_hda_host_output_class) {
-				ret = mic_privacy_configure(dev, cd);
+				ret = mic_privacy_configure(mod, cd);
 				if (ret < 0) {
 					comp_err(dev, "unable to configure mic privacy");
-					goto error;
+					return ret;
 				}
 			}
 #endif
@@ -217,32 +204,31 @@ __cold static int copier_init(struct processing_module *mod)
 			ret = copier_dai_create(dev, cd, copier, dev->pipeline);
 			if (ret < 0) {
 				comp_err(dev, "unable to create dai");
-				goto error;
+				return ret;
 			}
 #if CONFIG_INTEL_ADSP_MIC_PRIVACY
 			if (cd->direction == SOF_IPC_STREAM_CAPTURE) {
-				ret = mic_privacy_configure(dev, cd);
+				ret = mic_privacy_configure(mod, cd);
 				if (ret < 0) {
 					comp_err(dev, "unable to configure mic privacy");
-					goto error;
+					return ret;
 				}
 			}
 #endif
 			break;
 #if CONFIG_IPC4_GATEWAY
 		case ipc4_ipc_output_class:
 		case ipc4_ipc_input_class:
-			ret = copier_ipcgtw_create(dev, cd, copier, dev->pipeline);
+			ret = copier_ipcgtw_create(mod, cd, copier, dev->pipeline);
 			if (ret < 0) {
 				comp_err(dev, "unable to create IPC gateway");
-				goto error;
+				return ret;
 			}
 			break;
 #endif
 		default:
 			comp_err(dev, "unsupported dma type %x", (uint32_t)node_id.f.dma_type);
-			ret = -EINVAL;
-			goto error;
+			return -EINVAL;
 		};
 
 		dev->direction_set = true;
@@ -256,11 +242,6 @@ __cold static int copier_init(struct processing_module *mod)
 	dev->direction = cd->direction;
 	dev->state = COMP_STATE_READY;
 	return 0;
-error:
-	rfree(gtw_cfg);
-error_cd:
-	rfree(cd);
-	return ret;
 }
 
 __cold static int copier_free(struct processing_module *mod)
@@ -289,10 +270,6 @@ __cold static int copier_free(struct processing_module *mod)
 		break;
 	}
 
-	if (cd)
-		rfree(cd->gtw_cfg);
-	rfree(cd);
-
 	return 0;
 }
 

src/audio/copier/copier_host.c

@@ -131,11 +131,11 @@ __cold static int init_pipeline_reg(struct comp_dev *dev)
  * Sof host component can support this case so copier reuses host
  * component to support host gateway.
  */
-__cold int copier_host_create(struct comp_dev *dev, struct copier_data *cd,
+__cold int copier_host_create(struct processing_module *mod, struct copier_data *cd,
 			      const struct ipc4_copier_module_cfg *copier_cfg,
 			      struct pipeline *pipeline)
 {
-	struct processing_module *mod = comp_mod(dev);
+	struct comp_dev *dev = mod->dev;
 	struct comp_ipc_config *config = &dev->ipc_config;
 	struct ipc_config_host ipc_host;
 	struct host_data *hd;
@@ -177,16 +177,17 @@ __cold int copier_host_create(struct comp_dev *dev, struct copier_data *cd,
 	ipc_host.dma_buffer_size = copier_cfg->gtw_cfg.dma_buffer_size;
 	ipc_host.feature_mask = copier_cfg->copier_feature_mask;
 
-	hd = rzalloc(SOF_MEM_FLAG_USER, sizeof(*hd));
+	hd = mod_zalloc(mod, sizeof(*hd));
 	if (!hd)
 		return -ENOMEM;
 
 	ret = host_common_new(hd, dev, &ipc_host, config->id);
 	if (ret < 0) {
 		comp_err(dev, "copier: host new failed with exit");
-		goto e_data;
+		return ret;
 	}
 #if CONFIG_HOST_DMA_STREAM_SYNCHRONIZATION
+	/* NOTE: Should use goto e_conv this #if section, not direct return */
 	/* Size of a configuration without optional parameters. */
 	const uint32_t basic_size = sizeof(*copier_cfg) +
 				    (copier_cfg->gtw_cfg.config_length - 1) * sizeof(uint32_t);
@@ -248,8 +249,6 @@ __cold int copier_host_create(struct comp_dev *dev, struct copier_data *cd,
 
 e_conv:
 	host_common_free(hd);
-e_data:
-	rfree(hd);
 
 	return ret;
 }
@@ -263,7 +262,6 @@ __cold void copier_host_free(struct copier_data *cd)
 		delete_from_fpi_sync_group(cd->hd);
 #endif
 	host_common_free(cd->hd);
-	rfree(cd->hd);
 }
 
 /* This is called by DMA driver every time when DMA completes its current

src/audio/copier/copier_ipcgtw.c

@@ -2,6 +2,7 @@
 //
 // Copyright 2023 Intel Corporation. All rights reserved.
 
+#include <sof/audio/module_adapter/module/generic.h>
 #include <sof/audio/component_ext.h>
 #include <sof/trace/trace.h>
 #include <sof/lib/memory.h>
@@ -207,15 +208,15 @@ void copier_ipcgtw_reset(struct comp_dev *dev)
 	}
 }
 
-__cold int copier_ipcgtw_create(struct comp_dev *dev, struct copier_data *cd,
+__cold int copier_ipcgtw_create(struct processing_module *mod, struct copier_data *cd,
 				const struct ipc4_copier_module_cfg *copier,
 				struct pipeline *pipeline)
 {
+	struct comp_dev *dev = mod->dev;
 	struct comp_ipc_config *config = &dev->ipc_config;
 	struct ipcgtw_data *ipcgtw_data;
 	const struct ipc4_copier_gateway_cfg *gtw_cfg;
 	const struct ipc4_ipc_gateway_config_blob *blob;
-	int ret;
 
 	assert_can_be_cold();
 
@@ -231,7 +232,7 @@ __cold int copier_ipcgtw_create(struct comp_dev *dev, struct copier_data *cd,
 	config->type = SOF_COMP_HOST;
 	cd->gtw_type = ipc4_gtw_host;
 
-	ipcgtw_data = rzalloc(SOF_MEM_FLAG_USER, sizeof(*ipcgtw_data));
+	ipcgtw_data = mod_zalloc(mod, sizeof(*ipcgtw_data));
 	if (!ipcgtw_data)
 		return -ENOMEM;
 
@@ -254,8 +255,7 @@ __cold int copier_ipcgtw_create(struct comp_dev *dev, struct copier_data *cd,
 	if (!cd->converter[IPC4_COPIER_GATEWAY_PIN]) {
 		comp_err(dev, "failed to get converter for IPC gateway, dir %d",
 			 cd->direction);
-		ret = -EINVAL;
-		goto e_ipcgtw;
+		return -EINVAL;
 	}
 
 	if (cd->direction == SOF_IPC_STREAM_PLAYBACK) {
@@ -271,16 +271,11 @@ __cold int copier_ipcgtw_create(struct comp_dev *dev, struct copier_data *cd,
 	cd->endpoint_num++;
 
 	return 0;
-
-e_ipcgtw:
-	rfree(ipcgtw_data);
-	return ret;
 }
 
 __cold void copier_ipcgtw_free(struct copier_data *cd)
 {
 	assert_can_be_cold();
 
 	list_item_del(&cd->ipcgtw_data->item);
-	rfree(cd->ipcgtw_data);
 }

src/audio/copier/host_copier.h

@@ -129,7 +129,7 @@ static inline int host_common_copy(struct host_data *hd, struct comp_dev *dev, c
 }
 void host_common_update(struct host_data *hd, struct comp_dev *dev, uint32_t bytes);
 void host_common_one_shot(struct host_data *hd, uint32_t bytes);
-int copier_host_create(struct comp_dev *dev, struct copier_data *cd,
+int copier_host_create(struct processing_module *mod, struct copier_data *cd,
 		       const struct ipc4_copier_module_cfg *copier_cfg,
 		       struct pipeline *pipeline);
 void copier_host_free(struct copier_data *cd);

src/audio/copier/ipcgtw_copier.h

@@ -95,7 +95,7 @@ struct ipc4_ipc_gateway_cmd_data_reply {
 int copier_ipcgtw_process(const struct ipc4_ipcgtw_cmd *cmd,
 			  void *reply_payload, uint32_t *reply_payload_size);
 
-int copier_ipcgtw_create(struct comp_dev *dev, struct copier_data *cd,
+int copier_ipcgtw_create(struct processing_module *mod, struct copier_data *cd,
 			 const struct ipc4_copier_module_cfg *copier, struct pipeline *pipeline);
 
 #if CONFIG_IPC4_GATEWAY