Added heap override and customization options when using heap_5 variant.

Author: VladimirUmek

CMSIS/RTOS2/FreeRTOS/Source/cmsis_os2.c

@@ -1,5 +1,5 @@
 /* --------------------------------------------------------------------------
- * Copyright (c) 2013-2018 Arm Limited. All rights reserved.
+ * Copyright (c) 2013-2019 Arm Limited. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *
@@ -97,22 +97,46 @@ typedef struct {
 /* Kernel initialization state */
 static osKernelState_t KernelState;
 
-/* Heap region definition used by heap_5 variant */
-#if defined(RTE_RTOS_FreeRTOS_HEAP_5)
-#if (configAPPLICATION_ALLOCATED_HEAP == 1)
 /*
-  The application writer has already defined the array used for the RTOS
-  heap - probably so it can be placed in a special segment or address.
+  Heap region definition used by heap_5 variant
+
+  Define configAPPLICATION_ALLOCATED_HEAP as nonzero value in FreeRTOSConfig.h if
+  heap regions are already defined and vPortDefineHeapRegions is called in application.
+
+  Otherwise vPortDefineHeapRegions will be called by osKernelInitialize using
+  definition configHEAP_5_REGIONS as parameter. Overriding configHEAP_5_REGIONS
+  is possible by defining it globally or in FreeRTOSConfig.h.
 */
-  extern uint8_t ucHeap[configTOTAL_HEAP_SIZE];
+#if defined(RTE_RTOS_FreeRTOS_HEAP_5)
+#if (configAPPLICATION_ALLOCATED_HEAP == 0)
+  /*
+    FreeRTOS heap is not defined by the application.
+    Single region of size configTOTAL_HEAP_SIZE (defined in FreeRTOSConfig.h)
+    is provided by default. Define configHEAP_5_REGIONS to provide custom
+    HeapRegion_t array.
+  */
+  #define HEAP_5_REGION_SETUP   1
+  
+  #ifndef configHEAP_5_REGIONS
+    #define configHEAP_5_REGIONS xHeapRegions
+
+    static uint8_t ucHeap[configTOTAL_HEAP_SIZE];
+
+    static HeapRegion_t xHeapRegions[] = {
+      { ucHeap, configTOTAL_HEAP_SIZE },
+      { NULL,   0                     }
+    };
+  #else
+    /* Global definition is provided to override default heap array */
+    extern HeapRegion_t configHEAP_5_REGIONS[];
+  #endif
 #else
-  static uint8_t ucHeap[configTOTAL_HEAP_SIZE];
+  /*
+    The application already defined the array used for the FreeRTOS heap and
+    called vPortDefineHeapRegions to initialize heap.
+  */
+  #define HEAP_5_REGION_SETUP   0
 #endif /* configAPPLICATION_ALLOCATED_HEAP */
-
-static HeapRegion_t xHeapRegions[] = {
-  { ucHeap, configTOTAL_HEAP_SIZE },
-  { NULL,   0                     }
-};
 #endif /* RTE_RTOS_FreeRTOS_HEAP_5 */
 
 #if defined(SysTick)
@@ -146,8 +170,8 @@ osStatus_t osKernelInitialize (void) {
   else {
     if (KernelState == osKernelInactive) {
       EvrFreeRTOSSetup();
-      #if defined(RTE_RTOS_FreeRTOS_HEAP_5)
-        vPortDefineHeapRegions (xHeapRegions);
+      #if defined(RTE_RTOS_FreeRTOS_HEAP_5) && (HEAP_5_REGION_SETUP == 1)
+        vPortDefineHeapRegions (configHEAP_5_REGIONS);
       #endif
       KernelState = osKernelReady;
       stat = osOK;