modules: Drop alignment from mod_alloc() and introduce mod_alloc_align()

Drop alignment argument from mod_alloc() and introduce
mod_alloc_align() and apply all the necessary changes to mod_alloc()
calls.

Also adds Doxygen documentation to mod_alloc_align, mod_alloc,
mod_zalloc, mod_free, and mod_free_all.

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

Author: Jyri Sarha

src/audio/codec/dts/dts.c

@@ -25,7 +25,7 @@ static void *dts_effect_allocate_codec_memory(void *mod_void, unsigned int lengt
 
 	comp_dbg(dev, "dts_effect_allocate_codec_memory() start");
 
-	pMem = mod_alloc(mod, (uint32_t)length, (uint32_t)alignment);
+	pMem = mod_alloc_align(mod, (uint32_t)length, (uint32_t)alignment);
 
 	if (pMem == NULL)
 		comp_err(dev,

src/audio/module_adapter/module/cadence.c

@@ -519,7 +519,7 @@ static int init_memory_tables(struct processing_module *mod)
 			goto err;
 		}
 		/* Allocate memory for this type, taking alignment into account */
-		ptr = mod_alloc(mod, mem_size, mem_alignment);
+		ptr = mod_alloc_align(mod, mem_size, mem_alignment);
 		if (!ptr) {
 			comp_err(dev, "init_memory_tables() error %x: failed to allocate memory for %d",
 				 ret, mem_type);
@@ -688,7 +688,7 @@ static int cadence_codec_prepare(struct processing_module *mod,
 		return ret;
 	}
 
-	cd->mem_tabs = mod_alloc(mod, mem_tabs_size, 4);
+	cd->mem_tabs = mod_alloc(mod, mem_tabs_size);
 	if (!cd->mem_tabs) {
 		comp_err(dev, "cadence_codec_prepare() error: failed to allocate space for memtabs");
 		return -ENOMEM;

src/audio/module_adapter/module/generic.c

@@ -110,7 +110,16 @@ int module_init(struct processing_module *mod)
 	return 0;
 }
 
-void *mod_alloc(struct processing_module *mod, uint32_t size, uint32_t alignment)
+/**
+ * Allocates aligned memory block for module.
+ * @param mod		Pointer to the module this memory block is allocatd for.
+ * @param bytes		Size in bytes.
+ * @param alignment	Alignment in bytes.
+ * @return Pointer to the allocated memory or NULL if failed.
+ *
+ * The allocated memory is automatically freed when the module is unloaded.
+ */
+void *mod_alloc_align(struct processing_module *mod, uint32_t size, uint32_t alignment)
 {
 	struct comp_dev *dev = mod->dev;
 	struct module_memory *container;
@@ -147,11 +156,34 @@ void *mod_alloc(struct processing_module *mod, uint32_t size, uint32_t alignment
 
 	return ptr;
 }
+EXPORT_SYMBOL(mod_alloc_align);
+
+/**
+ * Allocates memory block for module.
+ * @param mod	Pointer to module this memory block is allocated for.
+ * @param bytes	Size in bytes.
+ * @return Pointer to the allocated memory or NULL if failed.
+ *
+ * Like mod_alloc_align() but the alignment can not be specified. However,
+ * rballoc() will always aligns the memory to PLATFORM_DCACHE_ALIGN.
+ */
+void *mod_alloc(struct processing_module *mod, uint32_t size)
+{
+	return mod_alloc_align(mod, size, 0);
+}
 EXPORT_SYMBOL(mod_alloc);
 
-void *mod_zalloc(struct processing_module *mod, uint32_t size, uint32_t alignment)
+/**
+ * Allocates memory block for module and initializes it to zero.
+ * @param mod	Pointer to module this memory block is allocated for.
+ * @param bytes	Size in bytes.
+ * @return Pointer to the allocated memory or NULL if failed.
+ *
+ * Like mod_alloc() but the allocated memory is initialized to zero.
+ */
+void *mod_zalloc(struct processing_module *mod, uint32_t size)
 {
-	void *ret = mod_alloc(mod, size, alignment);
+	void *ret = mod_alloc(mod, size);
 
 	if (ret)
 		memset(ret, 0, size);
@@ -160,6 +192,11 @@ void *mod_zalloc(struct processing_module *mod, uint32_t size, uint32_t alignmen
 }
 EXPORT_SYMBOL(mod_zalloc);
 
+/**
+ * Frees the memory block removes it from module's book keeping.
+ * @param mod	Pointer to module this memory block was allocated for.
+ * @param ptr	Pointer to the memory block.
+ */
 int mod_free(struct processing_module *mod, void *ptr)
 {
 	struct module_memory *mem;
@@ -357,6 +394,12 @@ int module_reset(struct processing_module *mod)
 	return 0;
 }
 
+/**
+ * Frees all the memory allocated for this module
+ * @param mod	Pointer to module this memory block was allocated for.
+ *
+ * This function is called automatically when the module is unloaded.
+ */
 void mod_free_all(struct processing_module *mod)
 {
 	struct module_memory *mem;

src/audio/module_adapter/module/waves/waves.c

@@ -200,7 +200,7 @@ static int waves_effect_allocate(struct processing_module *mod)
 		return -EINVAL;
 	}
 
-	waves_codec->effect = (MaxxEffect_t *)mod_alloc(mod,
+	waves_codec->effect = (MaxxEffect_t *)mod_alloc_align(mod,
 		waves_codec->effect_size, 16);
 
 	if (!waves_codec->effect) {
@@ -376,15 +376,15 @@ static int waves_effect_buffers(struct processing_module *mod)
 
 	comp_dbg(dev, "waves_effect_buffers() start");
 
-	i_buffer = mod_alloc(mod, waves_codec->buffer_bytes, 16);
+	i_buffer = mod_alloc_align(mod, waves_codec->buffer_bytes, 16);
 	if (!i_buffer) {
 		comp_err(dev, "waves_effect_buffers() failed to allocate %d bytes for i_buffer",
 			 waves_codec->buffer_bytes);
 		ret = -ENOMEM;
 		goto err;
 	}
 
-	o_buffer = mod_alloc(mod, waves_codec->buffer_bytes, 16);
+	o_buffer = mod_alloc_align(mod, waves_codec->buffer_bytes, 16);
 	if (!o_buffer) {
 		comp_err(dev, "waves_effect_buffers() failed to allocate %d bytes for o_buffer",
 			 waves_codec->buffer_bytes);
@@ -481,7 +481,7 @@ static int waves_effect_save_config_blob_to_cache(struct processing_module *mod,
 	}
 
 	if (!waves_codec->config_blob) {
-		waves_codec->config_blob = mod_alloc(mod, size, 16);
+		waves_codec->config_blob = mod_alloc_align(mod, size, 16);
 		if (!waves_codec->config_blob) {
 			comp_err(dev,
 				"waves_effect_save_config_blob_to_cache() failed to allocate %d bytes for config blob",
@@ -668,7 +668,7 @@ static int waves_codec_init(struct processing_module *mod)
 
 	comp_dbg(dev, "waves_codec_init() start");
 
-	waves_codec = mod_alloc(mod, sizeof(struct waves_codec_data), 16);
+	waves_codec = mod_alloc_align(mod, sizeof(struct waves_codec_data), 16);
 	if (!waves_codec) {
 		comp_err(dev, "waves_codec_init() failed to allocate %d bytes for waves_codec_data",
 			 sizeof(struct waves_codec_data));
@@ -696,7 +696,7 @@ static int waves_codec_init(struct processing_module *mod)
 		return -EINVAL;
 	}
 
-	response = mod_alloc(mod, waves_codec->response_max_bytes, 16);
+	response = mod_alloc_align(mod, waves_codec->response_max_bytes, 16);
 	if (!response) {
 		comp_err(dev, "waves_codec_init() failed to allocate %d bytes for response",
 			 waves_codec->response_max_bytes);

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

@@ -153,8 +153,9 @@ struct module_processing_data {
 /*****************************************************************************/
 int module_load_config(struct comp_dev *dev, const void *cfg, size_t size);
 int module_init(struct processing_module *mod);
-void *mod_alloc(struct processing_module *mod, uint32_t size, uint32_t alignment);
-void *mod_zalloc(struct processing_module *mod, uint32_t size, uint32_t alignment);
+void *mod_alloc_align(struct processing_module *mod, uint32_t size, uint32_t alignment);
+void *mod_alloc(struct processing_module *mod, uint32_t size);
+void *mod_zalloc(struct processing_module *mod, uint32_t size);
 int mod_free(struct processing_module *mod, void *ptr);
 void mod_free_all(struct processing_module *mod);
 int module_prepare(struct processing_module *mod,