Wrap the heap based parts of portable.h in if dynamic allocation is supported. Update the CMakeLists.txt to account for this

Author: Skptak

CMakeLists.txt

@@ -284,18 +284,12 @@ target_sources(freertos_kernel PRIVATE
     stream_buffer.c
     tasks.c
     timers.c
-)
 
-# Check if user requested to not include a heap implementation
-if(NOT DEFINED FREERTOS_DO_NOT_INCLUDE_HEAP)
-    list(APPEND FREERTOS_KERNEL_SOURCES
+    # Check if user requested to not include a heap implementation
+    if(NOT DEFINED FREERTOS_DO_NOT_INCLUDE_HEAP)
         # If FREERTOS_HEAP is digit between 1 .. 5 - it is heap number, otherwise - it is path to custom heap source file
         $<IF:$<BOOL:$<FILTER:${FREERTOS_HEAP},EXCLUDE,^[1-5]$>>,${FREERTOS_HEAP},portable/MemMang/heap_${FREERTOS_HEAP}.c>
-    )
-endif()
-
-add_library(freertos_kernel STATIC
-    ${FREERTOS_KERNEL_SOURCES}
+    endif()
 )
 
 

include/portable.h

@@ -132,76 +132,80 @@
     #endif
 #endif /* if ( portUSING_MPU_WRAPPERS == 1 ) */
 
-/* Used by heap_5.c to define the start address and size of each memory region
- * that together comprise the total FreeRTOS heap space. */
-typedef struct HeapRegion
-{
-    uint8_t * pucStartAddress;
-    size_t xSizeInBytes;
-} HeapRegion_t;
+/* Only include heap related functions and structs if using dynamic allocation */
+#if ( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
 
-/* Used to pass information about the heap out of vPortGetHeapStats(). */
-typedef struct xHeapStats
-{
-    size_t xAvailableHeapSpaceInBytes;      /* The total heap size currently available - this is the sum of all the free blocks, not the largest block that can be allocated. */
-    size_t xSizeOfLargestFreeBlockInBytes;  /* The maximum size, in bytes, of all the free blocks within the heap at the time vPortGetHeapStats() is called. */
-    size_t xSizeOfSmallestFreeBlockInBytes; /* The minimum size, in bytes, of all the free blocks within the heap at the time vPortGetHeapStats() is called. */
-    size_t xNumberOfFreeBlocks;             /* The number of free memory blocks within the heap at the time vPortGetHeapStats() is called. */
-    size_t xMinimumEverFreeBytesRemaining;  /* The minimum amount of total free memory (sum of all free blocks) there has been in the heap since the system booted. */
-    size_t xNumberOfSuccessfulAllocations;  /* The number of calls to pvPortMalloc() that have returned a valid memory block. */
-    size_t xNumberOfSuccessfulFrees;        /* The number of calls to vPortFree() that has successfully freed a block of memory. */
-} HeapStats_t;
+    /* Used by heap_5.c to define the start address and size of each memory region
+    * that together comprise the total FreeRTOS heap space. */
+    typedef struct HeapRegion
+    {
+        uint8_t * pucStartAddress;
+        size_t xSizeInBytes;
+    } HeapRegion_t;
 
-/*
- * Used to define multiple heap regions for use by heap_5.c.  This function
- * must be called before any calls to pvPortMalloc() - not creating a task,
- * queue, semaphore, mutex, software timer, event group, etc. will result in
- * pvPortMalloc being called.
- *
- * pxHeapRegions passes in an array of HeapRegion_t structures - each of which
- * defines a region of memory that can be used as the heap.  The array is
- * terminated by a HeapRegions_t structure that has a size of 0.  The region
- * with the lowest start address must appear first in the array.
- */
-void vPortDefineHeapRegions( const HeapRegion_t * const pxHeapRegions ) PRIVILEGED_FUNCTION;
+    /* Used to pass information about the heap out of vPortGetHeapStats(). */
+    typedef struct xHeapStats
+    {
+        size_t xAvailableHeapSpaceInBytes;      /* The total heap size currently available - this is the sum of all the free blocks, not the largest block that can be allocated. */
+        size_t xSizeOfLargestFreeBlockInBytes;  /* The maximum size, in bytes, of all the free blocks within the heap at the time vPortGetHeapStats() is called. */
+        size_t xSizeOfSmallestFreeBlockInBytes; /* The minimum size, in bytes, of all the free blocks within the heap at the time vPortGetHeapStats() is called. */
+        size_t xNumberOfFreeBlocks;             /* The number of free memory blocks within the heap at the time vPortGetHeapStats() is called. */
+        size_t xMinimumEverFreeBytesRemaining;  /* The minimum amount of total free memory (sum of all free blocks) there has been in the heap since the system booted. */
+        size_t xNumberOfSuccessfulAllocations;  /* The number of calls to pvPortMalloc() that have returned a valid memory block. */
+        size_t xNumberOfSuccessfulFrees;        /* The number of calls to vPortFree() that has successfully freed a block of memory. */
+    } HeapStats_t;
 
-/*
- * Returns a HeapStats_t structure filled with information about the current
- * heap state.
- */
-void vPortGetHeapStats( HeapStats_t * pxHeapStats );
+    /*
+    * Used to define multiple heap regions for use by heap_5.c.  This function
+    * must be called before any calls to pvPortMalloc() - not creating a task,
+    * queue, semaphore, mutex, software timer, event group, etc. will result in
+    * pvPortMalloc being called.
+    *
+    * pxHeapRegions passes in an array of HeapRegion_t structures - each of which
+    * defines a region of memory that can be used as the heap.  The array is
+    * terminated by a HeapRegions_t structure that has a size of 0.  The region
+    * with the lowest start address must appear first in the array.
+    */
+    void vPortDefineHeapRegions( const HeapRegion_t * const pxHeapRegions ) PRIVILEGED_FUNCTION;
 
-/*
- * Map to the memory management routines required for the port.
- */
-void * pvPortMalloc( size_t xSize ) PRIVILEGED_FUNCTION;
-void * pvPortCalloc( size_t xNum,
-                     size_t xSize ) PRIVILEGED_FUNCTION;
-void vPortFree( void * pv ) PRIVILEGED_FUNCTION;
-void vPortInitialiseBlocks( void ) PRIVILEGED_FUNCTION;
-size_t xPortGetFreeHeapSize( void ) PRIVILEGED_FUNCTION;
-size_t xPortGetMinimumEverFreeHeapSize( void ) PRIVILEGED_FUNCTION;
+    /*
+    * Returns a HeapStats_t structure filled with information about the current
+    * heap state.
+    */
+    void vPortGetHeapStats( HeapStats_t * pxHeapStats );
 
-#if ( configSTACK_ALLOCATION_FROM_SEPARATE_HEAP == 1 )
-    void * pvPortMallocStack( size_t xSize ) PRIVILEGED_FUNCTION;
-    void vPortFreeStack( void * pv ) PRIVILEGED_FUNCTION;
-#else
-    #define pvPortMallocStack    pvPortMalloc
-    #define vPortFreeStack       vPortFree
-#endif
+    /*
+    * Map to the memory management routines required for the port.
+    */
+    void * pvPortMalloc( size_t xSize ) PRIVILEGED_FUNCTION;
+    void * pvPortCalloc( size_t xNum,
+                        size_t xSize ) PRIVILEGED_FUNCTION;
+    void vPortFree( void * pv ) PRIVILEGED_FUNCTION;
+    void vPortInitialiseBlocks( void ) PRIVILEGED_FUNCTION;
+    size_t xPortGetFreeHeapSize( void ) PRIVILEGED_FUNCTION;
+    size_t xPortGetMinimumEverFreeHeapSize( void ) PRIVILEGED_FUNCTION;
 
-#if ( configUSE_MALLOC_FAILED_HOOK == 1 )
+    #if ( configSTACK_ALLOCATION_FROM_SEPARATE_HEAP == 1 )
+        void * pvPortMallocStack( size_t xSize ) PRIVILEGED_FUNCTION;
+        void vPortFreeStack( void * pv ) PRIVILEGED_FUNCTION;
+    #else
+        #define pvPortMallocStack    pvPortMalloc
+        #define vPortFreeStack       vPortFree
+    #endif
 
-/**
- * task.h
- * @code{c}
- * void vApplicationMallocFailedHook( void )
- * @endcode
- *
- * This hook function is called when allocation failed.
- */
-    void vApplicationMallocFailedHook( void ); /*lint !e526 Symbol not defined as it is an application callback. */
-#endif
+    #if ( configUSE_MALLOC_FAILED_HOOK == 1 )
+        /**
+         * task.h
+         * @code{c}
+         * void vApplicationMallocFailedHook( void )
+         * @endcode
+         *
+         * This hook function is called when allocation failed.
+         */
+            void vApplicationMallocFailedHook( void ); /*lint !e526 Symbol not defined as it is an application callback. */
+    #endif /* ( configUSE_MALLOC_FAILED_HOOK == 1 ) */
+
+#endif /* if ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) */
 
 /*
  * Setup the hardware ready for the scheduler to take control.  This generally