alloc: (cosmetic) simplify comments and fix indentation

Update and simplify Doxygen comments for SOF_MEM_FLAG_* flags, update
an outdated comment about memory zones, fix indentation and merge a
needlessly split line.

Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>

Author: lyakh

posix/include/rtos/alloc.h

@@ -38,21 +38,21 @@
  * the first two positions are reserved for SOF_BUF_ flags
  */
 
- /** \brief Indicates we should return DMA-able memory. */
+ /** \brief Allocate DMA-able memory. */
 #define SOF_MEM_FLAG_DMA		BIT(2)
-/** \brief Indicates that original content should not be copied by realloc. */
+/** \brief realloc() skips copying the original content. */
 #define SOF_MEM_FLAG_NO_COPY		BIT(3)
-/** \brief Indicates that if we should return uncached address. */
+/** \brief Allocate uncached address. */
 #define SOF_MEM_FLAG_COHERENT		BIT(4)
-/** \brief Indicates that if we should return L3 address. */
+/** \brief Allocate L3 address. */
 #define SOF_MEM_FLAG_L3			BIT(5)
-/** \brief Indicates that if we should return Low power memory address. */
+/** \brief Allocate Low power memory address. */
 #define SOF_MEM_FLAG_LOW_POWER		BIT(6)
-/** \brief Indicates that if we should return kernel memory address. */
+/** \brief Allocate kernel memory address. */
 #define SOF_MEM_FLAG_KERNEL		BIT(7)
-/** \brief Indicates that if we should return user memory address. */
+/** \brief Allocate user memory address. */
 #define SOF_MEM_FLAG_USER		BIT(8)
-/** \brief Indicates that if we should return shared user memory address. */
+/** \brief Allocate shared user memory address. */
 #define SOF_MEM_FLAG_USER_SHARED_BUFFER	BIT(9)
 /** \brief Use allocation method for large buffers. */
 #define SOF_MEM_FLAG_LARGE_BUFFER	BIT(10)

zephyr/include/rtos/alloc.h

@@ -25,25 +25,25 @@
  * the first two positions are reserved for SOF_BUF_ flags
  */
 
-/** \name Heap zone flags
+/** \name Allocation flags
  *  @{
  */
 
- /** \brief Indicates we should return DMA-able memory. */
+ /** \brief Allocate DMA-able memory. */
 #define SOF_MEM_FLAG_DMA		BIT(2)
-/** \brief Indicates that original content should not be copied by realloc. */
+/** \brief realloc() skips copying the original content. */
 #define SOF_MEM_FLAG_NO_COPY		BIT(3)
-/** \brief Indicates that if we should return uncached address. */
+/** \brief Allocate uncached address. */
 #define SOF_MEM_FLAG_COHERENT		BIT(4)
-/** \brief Indicates that if we should return L3 address. */
+/** \brief Allocate L3 address. */
 #define SOF_MEM_FLAG_L3			BIT(5)
-/** \brief Indicates that if we should return Low power memory address. */
+/** \brief Allocate Low power memory address. */
 #define SOF_MEM_FLAG_LOW_POWER		BIT(6)
-/** \brief Indicates that if we should return kernel memory address. */
+/** \brief Allocate kernel memory address. */
 #define SOF_MEM_FLAG_KERNEL		BIT(7)
-/** \brief Indicates that if we should return user memory address. */
+/** \brief Allocate user memory address. */
 #define SOF_MEM_FLAG_USER		BIT(8)
-/** \brief Indicates that if we should return shared user memory address. */
+/** \brief Allocate shared user memory address. */
 #define SOF_MEM_FLAG_USER_SHARED_BUFFER	BIT(9)
 /** \brief Use allocation method for large buffers. */
 #define SOF_MEM_FLAG_LARGE_BUFFER	BIT(10)

zephyr/lib/alloc.c

@@ -548,8 +548,7 @@ EXPORT_SYMBOL(rzalloc);
  * @param align Alignment in bytes.
  * @return Pointer to the allocated memory or NULL if failed.
  */
-void *rballoc_align(uint32_t flags, size_t bytes,
-		    uint32_t align)
+void *rballoc_align(uint32_t flags, size_t bytes, uint32_t align)
 {
 	struct k_heap *heap;
 
@@ -568,9 +567,9 @@ void *rballoc_align(uint32_t flags, size_t bytes,
 #endif /* CONFIG_USERSPACE */
 	} else {
 #if CONFIG_VIRTUAL_HEAP
-	/* Use virtual heap if it is available */
-	if (virtual_buffers_heap)
-		return virtual_heap_alloc(virtual_buffers_heap, flags, bytes, align);
+		/* Use virtual heap if it is available */
+		if (virtual_buffers_heap)
+			return virtual_heap_alloc(virtual_buffers_heap, flags, bytes, align);
 #endif /* CONFIG_VIRTUAL_HEAP */
 
 		heap = &sof_heap;