- Rework the StaticAllocation.c common demo file to reflect the changes to the static...

[freertos] / FreeRTOS / Demo / WIN32-MSVC-Static-Allocation-Only / main.c

diff --git a/FreeRTOS/Demo/WIN32-MSVC-Static-Allocation-Only/main.c b/FreeRTOS/Demo/WIN32-MSVC-Static-Allocation-Only/main.c
index c3a7d1be3f84ef89ca45a73a4a4e5732a49f42ba..a14fa4165164e7f7a67114d438f642c4a6b2057d 100644 (file)
--- a/FreeRTOS/Demo/WIN32-MSVC-Static-Allocation-Only/main.c
+++ b/FreeRTOS/Demo/WIN32-MSVC-Static-Allocation-Only/main.c
@@ -241,35 +241,52 @@ volatile uint32_t ulSetToNonZeroInDebuggerToContinue = 0;
 }\r
 /*-----------------------------------------------------------*/\r
 \r
+/* configUSE_STATIC_ALLOCATION is set to 1, so the application must provide an\r
+implementation of vApplicationGetIdleTaskMemory() to provide the memory that is\r
+used by the Idle task. */\r
 void vApplicationGetIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer, StackType_t **ppxIdleTaskStackBuffer, uint16_t *pusIdleTaskStackSize )\r
 {\r
-/* The buffers used by the idle task must be static so they are persistent, and\r
-so exist after this function returns. */\r
+/* If the buffers to be provided to the Idle task are declared inside this\r
+function then they must be declared static - otherwise they will be allocated on\r
+the stack and so not exists after this function exits. */\r
 static StaticTask_t xIdleTaskTCB;\r
 static StackType_t uxIdleTaskStack[ configMINIMAL_STACK_SIZE ];\r
 \r
-       /* configSUPORT_STATIC_ALLOCATION is set to 1 and\r
-       configSUPPORT_DYNAMIC_ALLOCATION is 0, so the application must supply the\r
-       buffers that will be used to hold the Idle task data structure and stack. */\r
+       /* Pass out a pointer to the StaticTask_t structure in which the Idle task's\r
+       state will be stored. */\r
        *ppxIdleTaskTCBBuffer = &xIdleTaskTCB;\r
+\r
+       /* Pass out the array that will be used as the Idle task's stack. */\r
        *ppxIdleTaskStackBuffer = uxIdleTaskStack;\r
-       *pusIdleTaskStackSize = configMINIMAL_STACK_SIZE; /* In words.  NOT in bytes! */\r
+\r
+       /* Pass out the size of the array pointed to by *ppxIdleTaskStackBuffer.\r
+       Note that, as the array is necessarily of type StackType_t,\r
+       configMINIMAL_STACK_SIZE is specified in words, not bytes. */\r
+       *pusIdleTaskStackSize = configMINIMAL_STACK_SIZE;\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
+/* configUSE_STATIC_ALLOCATION and configUSE_TIMERS are both set to 1, so the\r
+application must provide an implementation of vApplicationGetTimerTaskMemory()\r
+to provide the memory that is used by the Timer service task. */\r
 void vApplicationGetTimerTaskMemory( StaticTask_t **ppxTimerTaskTCBBuffer, StackType_t **ppxTimerTaskStackBuffer, uint16_t *pusTimerTaskStackSize )\r
 {\r
-/* The buffers used by the Timer/Daemon task must be static so they are\r
-persistent, and so exist after this function returns. */\r
+/* If the buffers to be provided to the Timer task are declared inside this\r
+function then they must be declared static - otherwise they will be allocated on\r
+the stack and so not exists after this function exits. */\r
 static StaticTask_t xTimerTaskTCB;\r
 static StackType_t uxTimerTaskStack[ configTIMER_TASK_STACK_DEPTH ];\r
 \r
-       /* configSUPPORT_STATIC_ALLOCATION is set to 1,\r
-       configSUPPORT_DYNAMIC_ALLOCATION is set to 1, and configUSE_TIMERS is set\r
-       to 1, so the application must supply the buffers that will be used to hold\r
-       the Timer task data structure and stack. */\r
+       /* Pass out a pointer to the StaticTask_t structure in which the Timer\r
+       task's state will be stored. */\r
        *ppxTimerTaskTCBBuffer = &xTimerTaskTCB;\r
+\r
+       /* Pass out the array that will be used as the Timer task's stack. */\r
        *ppxTimerTaskStackBuffer = uxTimerTaskStack;\r
-       *pusTimerTaskStackSize = configTIMER_TASK_STACK_DEPTH; /* In words.  NOT in bytes! */\r
+\r
+       /* Pass out the size of the array pointed to by *ppxTimerTaskStackBuffer.\r
+       Note that, as the array is necessarily of type StackType_t,\r
+       configMINIMAL_STACK_SIZE is specified in words, not bytes. */\r
+       *pusTimerTaskStackSize = configMINIMAL_STACK_SIZE;\r
 }\r
 \r