alloc: update comments and log string to align with new API

Zone was mentioned in many comments and one log message. Fix this to
remove zone references.

Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>

Author: lrgirdwo

posix/include/rtos/alloc.h

@@ -51,29 +51,20 @@
 
 /**
  * Allocates memory block.
- * @param zone Zone to allocate memory from, see enum mem_zone.
  * @param flags Flags, see SOF_MEM_FLAG_...
- * @param caps Capabilities, see SOF_MEM_CAPS_...
  * @param bytes Size in bytes.
  * @return Pointer to the allocated memory or NULL if failed.
- *
- * @note Do not use for buffers (SOF_MEM_ZONE_BUFFER zone).
- *       Use rballoc(), rballoc_align() to allocate memory for buffers.
  */
 void *rmalloc(uint32_t flags, size_t bytes);
 
 /**
  * Similar to rmalloc(), guarantees that returned block is zeroed.
- *
- * @note Do not use  for buffers (SOF_MEM_ZONE_BUFFER zone).
- *       rballoc(), rballoc_align() to allocate memory for buffers.
  */
 void *rzalloc(uint32_t flags, size_t bytes);
 
 /**
- * Allocates memory block from SOF_MEM_ZONE_BUFFER.
+ * Allocates memory block.
  * @param flags Flags, see SOF_MEM_FLAG_...
- * @param caps Capabilities, see SOF_MEM_CAPS_...
  * @param bytes Size in bytes.
  * @param alignment Alignment in bytes.
  * @return Pointer to the allocated memory or NULL if failed.
@@ -90,10 +81,9 @@ static inline void *rballoc(uint32_t flags, size_t bytes)
 }
 
 /**
- * Changes size of the memory block allocated from SOF_MEM_ZONE_BUFFER.
+ * Changes size of the memory block allocated.
  * @param ptr Address of the block to resize.
  * @param flags Flags, see SOF_MEM_FLAG_...
- * @param caps Capabilities, see SOF_MEM_CAPS_...
  * @param bytes New size in bytes.
  * @param old_bytes Old size in bytes.
  * @param alignment Alignment in bytes.
@@ -116,9 +106,6 @@ static inline void *rbrealloc(void *ptr, uint32_t flags,
 /**
  * Frees the memory block.
  * @param ptr Pointer to the memory block.
- *
- * @note Blocks from SOF_MEM_ZONE_SYS cannot be freed, such a call causes
- *       panic.
  */
 void rfree(void *ptr);
 

src/include/sof/audio/component.h

@@ -321,8 +321,6 @@ struct comp_ops {
 	 * @param spec Pointer to initialization data
 	 * @return Pointer to the new component device.
 	 *
-	 * All required data objects should be allocated from the run-time
-	 * heap (SOF_MEM_ZONE_RUNTIME).
 	 * Any component-specific private data is allocated separately and
 	 * pointer is connected to the comp_dev::private by using
 	 * comp_set_drvdata() and later retrieved by comp_get_drvdata().

src/include/sof/lib/dai-legacy.h

@@ -76,7 +76,7 @@ struct sof_ipc_stream_params;
  * If a single DAI instance can have multiple DMA links and/or there is
  * some other possibility of the same instance being used in multiple
  * contexts at the same time, the private data should be allocated in the
- * SOF_MEM_ZONE_SHARED.
+ * SOF_MEM_FLAG_COHERENT.
  */
 struct dai_ops {
 	int (*set_config)(struct dai *dai, struct ipc_config_dai *config,

zephyr/include/rtos/alloc.h

@@ -42,29 +42,21 @@
 
 /**
  * Allocates memory block.
- * @param zone Zone to allocate memory from, see enum mem_zone.
- * @param flags Flags, see SOF_MEM_FLAG_...
- * @param caps Capabilities, see SOF_MEM_CAPS_...
+ * @param flags Flags, see SOF_MEM_FLAG_....
  * @param bytes Size in bytes.
  * @return Pointer to the allocated memory or NULL if failed.
  *
- * @note Do not use for buffers (SOF_MEM_ZONE_BUFFER zone).
- *       Use rballoc(), rballoc_align() to allocate memory for buffers.
  */
 void *rmalloc(uint32_t flags, size_t bytes);
 
 /**
  * Similar to rmalloc(), guarantees that returned block is zeroed.
- *
- * @note Do not use  for buffers (SOF_MEM_ZONE_BUFFER zone).
- *       rballoc(), rballoc_align() to allocate memory for buffers.
  */
 void *rzalloc(uint32_t flags, size_t bytes);
 
 /**
- * Allocates memory block from SOF_MEM_ZONE_BUFFER.
+ * Allocates memory block.
  * @param flags Flags, see SOF_MEM_FLAG_...
- * @param caps Capabilities, see SOF_MEM_CAPS_...
  * @param bytes Size in bytes.
  * @param alignment Alignment in bytes.
  * @return Pointer to the allocated memory or NULL if failed.
@@ -81,10 +73,9 @@ static inline void *rballoc(uint32_t flags, size_t bytes)
 }
 
 /**
- * Changes size of the memory block allocated from SOF_MEM_ZONE_BUFFER.
+ * Changes size of the memory block allocated.
  * @param ptr Address of the block to resize.
  * @param flags Flags, see SOF_MEM_FLAG_...
- * @param caps Capabilities, see SOF_MEM_CAPS_...
  * @param bytes New size in bytes.
  * @param old_bytes Old size in bytes.
  * @param alignment Alignment in bytes.
@@ -107,9 +98,6 @@ static inline void *rbrealloc(void *ptr, uint32_t flags,
 /**
  * Frees the memory block.
  * @param ptr Pointer to the memory block.
- *
- * @note Blocks from SOF_MEM_ZONE_SYS cannot be freed, such a call causes
- *       panic.
  */
 void rfree(void *ptr);
 

zephyr/lib/alloc.c

@@ -385,7 +385,7 @@ void *rmalloc(uint32_t flags, size_t bytes)
 		heap = &l3_heap;
 		/* Uncached L3_HEAP should not be used */
 		if (flags & SOF_MEM_FLAG_COHERENT) {
-			tr_err(&zephyr_tr, "L3_HEAP available for cached zones only!");
+			tr_err(&zephyr_tr, "L3_HEAP available for cached addresses only!");
 			return NULL;
 		}
 		ptr = (__sparse_force void *)l3_heap_alloc_aligned(heap, 0, bytes);
@@ -412,14 +412,12 @@ void *rmalloc(uint32_t flags, size_t bytes)
 }
 EXPORT_SYMBOL(rmalloc);
 
-/* Use SOF_MEM_ZONE_BUFFER at the moment */
 void *rbrealloc_align(void *ptr, uint32_t flags, size_t bytes,
 		      size_t old_bytes, uint32_t alignment)
 {
 	void *new_ptr;
 
 	if (!ptr) {
-		/* TODO: Use correct zone */
 		return rballoc_align(flags, bytes, alignment);
 	}
 
@@ -446,9 +444,6 @@ void *rbrealloc_align(void *ptr, uint32_t flags, size_t bytes,
 
 /**
  * Similar to rmalloc(), guarantees that returned block is zeroed.
- *
- * @note Do not use  for buffers (SOF_MEM_ZONE_BUFFER zone).
- *       rballoc(), rballoc_align() to allocate memory for buffers.
  */
 void *rzalloc(uint32_t flags, size_t bytes)
 {
@@ -462,9 +457,8 @@ void *rzalloc(uint32_t flags, size_t bytes)
 EXPORT_SYMBOL(rzalloc);
 
 /**
- * Allocates memory block from SOF_MEM_ZONE_BUFFER.
+ * Allocates memory block.
  * @param flags see SOF_MEM_FLAG_...
- * @param caps Capabilities, see SOF_MEM_CAPS_...
  * @param bytes Size in bytes.
  * @param align Alignment in bytes.
  * @return Pointer to the allocated memory or NULL if failed.