Prepare for V9.0.0 release:

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

diff --git a/FreeRTOS/Demo/WIN32-MSVC/main.c b/FreeRTOS/Demo/WIN32-MSVC/main.c
index d4c972c2f9fb8c985964ee5151d3257f0ef6b62c..effbafd51c20e066c3b17109c0b716a2b75c68e9 100644 (file)
--- a/FreeRTOS/Demo/WIN32-MSVC/main.c
+++ b/FreeRTOS/Demo/WIN32-MSVC/main.c
@@ -1,420 +1,460 @@
 /*\r
 /*\r

-    FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
-\r
-    FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT \r
-    http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
-     *    Complete, revised, and edited pdf reference manuals are also       *\r
-     *    available.                                                         *\r
-     *                                                                       *\r
-     *    Purchasing FreeRTOS documentation will not only help you, by       *\r
-     *    ensuring you get running as quickly as possible and with an        *\r
-     *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
-     *    the FreeRTOS project to continue with its mission of providing     *\r
-     *    professional grade, cross platform, de facto standard solutions    *\r
-     *    for microcontrollers - completely free of charge!                  *\r
-     *                                                                       *\r
-     *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
-     *                                                                       *\r
-     *    Thank you for using FreeRTOS, and thank you for your support!      *\r
-     *                                                                       *\r
-    ***************************************************************************\r
+    FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.\r
+    All rights reserved\r

 \r
 \r

+    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r

 \r
     This file is part of the FreeRTOS distribution.\r
 \r
     FreeRTOS is free software; you can redistribute it and/or modify it under\r
     the terms of the GNU General Public License (version 2) as published by the\r
 \r
     This file is part of the FreeRTOS distribution.\r
 \r
     FreeRTOS is free software; you can redistribute it and/or modify it under\r
     the terms of the GNU General Public License (version 2) as published by the\r

-    Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
-    >>>NOTE<<< The modification to the GPL is included to allow you to\r
-    distribute a combined work that includes FreeRTOS without being obliged to\r
-    provide the source code for proprietary components outside of the FreeRTOS\r
-    kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
-    WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
-    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
-    more details. You should have received a copy of the GNU General Public\r
-    License and the FreeRTOS license exception along with FreeRTOS; if not it\r
-    can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
-    by writing to Richard Barry, contact details for whom are available on the\r
-    FreeRTOS WEB site.\r
+    Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
+\r
+    ***************************************************************************\r
+    >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
+    >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
+    >>!   obliged to provide the source code for proprietary components     !<<\r
+    >>!   outside of the FreeRTOS kernel.                                   !<<\r
+    ***************************************************************************\r
+\r
+    FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
+    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
+    FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
+    link: http://www.freertos.org/a00114.html\r

 \r
 \r

-    1 tab == 4 spaces!\r
-    \r

     ***************************************************************************\r
      *                                                                       *\r
     ***************************************************************************\r
      *                                                                       *\r

-     *    Having a problem?  Start by reading the FAQ "My application does   *\r
-     *    not run, what could be wrong?"                                     *\r
+     *    FreeRTOS provides completely free yet professionally developed,    *\r
+     *    robust, strictly quality controlled, supported, and cross          *\r
+     *    platform software that is more than just the market leader, it     *\r
+     *    is the industry's de facto standard.                               *\r

      *                                                                       *\r
      *                                                                       *\r

-     *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
+     *    Help yourself get started quickly while simultaneously helping     *\r
+     *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
+     *    tutorial book, reference manual, or both:                          *\r
+     *    http://www.FreeRTOS.org/Documentation                              *\r

      *                                                                       *\r
     ***************************************************************************\r
 \r
      *                                                                       *\r
     ***************************************************************************\r
 \r

-    \r
-    http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
-    and contact details.  \r
-    \r
+    http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
+    the FAQ page "My application does not run, what could be wrong?".  Have you\r
+    defined configASSERT()?\r
+\r
+    http://www.FreeRTOS.org/support - In return for receiving this top quality\r
+    embedded software for free we request you assist our global community by\r
+    participating in the support forum.\r
+\r
+    http://www.FreeRTOS.org/training - Investing in training allows your team to\r
+    be as productive as possible as early as possible.  Now you can receive\r
+    FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
+    Ltd, and the world's leading authority on the world's leading RTOS.\r
+\r

     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r

-    including FreeRTOS+Trace - an indispensable productivity tool.\r
+    including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
+    compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
+\r
+    http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
+    Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
+\r
+    http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
+    Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
+    licenses offer ticketed support, indemnification and commercial middleware.\r
+\r
+    http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
+    engineered and independently SIL3 certified version for use in safety and\r
+    mission critical applications that require provable dependability.\r

 \r
 \r

-    Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
-    the code with commercial support, indemnification, and middleware, under \r
-    the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
-    provide a safety engineered and independently SIL3 certified version under \r
-    the SafeRTOS brand: http://www.SafeRTOS.com.\r
+    1 tab == 4 spaces!\r

 */\r
 \r
 */\r
 \r

-/*\r
- *******************************************************************************\r
- * -NOTE- The Win32 port is a simulation (or is that emulation?) only!  Do not\r
- * expect to get real time behaviour from the Win32 port or this demo\r
- * application.  It is provided as a convenient development and demonstration\r
- * test bed only.  This was tested using Windows XP on a dual core laptop.\r
- *\r
- * - READ THE WEB DOCUMENTATION FOR THIS PORT FOR MORE INFORMATION ON USING IT -\r
- *******************************************************************************\r
+/******************************************************************************\r
+ * This project provides two demo applications.  A simple blinky style project,\r
+ * and a more comprehensive test and demo application.  The\r
+ * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is used to select between the two.\r
+ * The simply blinky demo is implemented and described in main_blinky.c.  The\r
+ * more comprehensive test and demo application is implemented and described in\r
+ * main_full.c.\r

  *\r
  *\r

- * main() creates all the demo application tasks, then starts the scheduler.  \r
- * The web documentation provides more details of the standard demo application \r
- * tasks, which provide no particular functionality but do provide a good \r
- * example of how to use the FreeRTOS API.\r
+ * This file implements the code that is not demo specific, including the\r
+ * hardware setup and FreeRTOS hook functions.\r

  *\r
  *\r

- * In addition to the standard demo tasks, the following tasks and tests are\r
- * defined and/or created within this file:\r
+ *******************************************************************************\r
+ * NOTE: Windows will not be running the FreeRTOS demo threads continuously, so\r
+ * do not expect to get real time behaviour from the FreeRTOS Windows port, or\r
+ * this demo application.  Also, the timing information in the FreeRTOS+Trace\r
+ * logs have no meaningful units.  See the documentation page for the Windows\r
+ * port for further information:\r
+ * http://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html\r

  *\r
  *\r

- * "Check" task - This only executes every five seconds but has a high priority\r
- * to ensure it gets processor time.  Its main function is to check that all the\r
- * standard demo tasks are still operational.  While no errors have been\r
- * discovered the check task will print out "OK" and the current simulated tick\r
- * time.  If an error is discovered in the execution of a task then the check\r
- * task will print out an appropriate error message.\r
+ * This demo was created using Windows XP on a dual core laptop, and has since\r
+ * been maintained using Windows 7 on a quad core laptop.\r

  *\r
  *\r

+ *******************************************************************************\r

  */\r
 \r
  */\r
 \r

-\r

 /* Standard includes. */\r
 #include <stdio.h>\r
 /* Standard includes. */\r
 #include <stdio.h>\r

+#include <stdlib.h>\r
+#include <conio.h>\r

 \r
 \r

-/* Kernel includes. */\r
-#include <FreeRTOS.h>\r
+/* FreeRTOS kernel includes. */\r
+#include "FreeRTOS.h"\r

 #include "task.h"\r
 #include "task.h"\r

-#include "queue.h"\r
-#include "timers.h"\r
-#include "semphr.h"\r
-\r
-/* Standard demo includes. */\r
-#include "BlockQ.h"\r
-#include "integer.h"\r
-#include "semtest.h"\r
-#include "PollQ.h"\r
-#include "GenQTest.h"\r
-#include "QPeek.h"\r
-#include "recmutex.h"\r
-#include "flop.h"\r
-#include "TimerDemo.h"\r
-#include "countsem.h"\r
-#include "death.h"\r
-#include "dynamic.h"\r
-#include "QueueSet.h"\r
-\r
-/* Priorities at which the tasks are created. */\r
-#define mainCHECK_TASK_PRIORITY                        ( configMAX_PRIORITIES - 1 )\r
-#define mainQUEUE_POLL_PRIORITY                        ( tskIDLE_PRIORITY + 1 )\r
-#define mainSEM_TEST_PRIORITY                  ( tskIDLE_PRIORITY + 1 )\r
-#define mainBLOCK_Q_PRIORITY                   ( tskIDLE_PRIORITY + 2 )\r
-#define mainCREATOR_TASK_PRIORITY              ( tskIDLE_PRIORITY + 3 )\r
-#define mainFLASH_TASK_PRIORITY                        ( tskIDLE_PRIORITY + 1 )\r
-#define mainuIP_TASK_PRIORITY                  ( tskIDLE_PRIORITY + 2 )\r
-#define mainINTEGER_TASK_PRIORITY              ( tskIDLE_PRIORITY )\r
-#define mainGEN_QUEUE_TASK_PRIORITY            ( tskIDLE_PRIORITY )\r
-#define mainFLOP_TASK_PRIORITY                 ( tskIDLE_PRIORITY )\r
-\r
-#define mainTIMER_TEST_PERIOD                  ( 50 )\r
-\r
-/* Task function prototypes. */\r
-static void prvCheckTask( void *pvParameters );\r
-\r
-/* A task that is created from the idle task to test the functionality of \r
-eTaskStateGet(). */\r
-static void prvTestTask( void *pvParameters );\r
-\r
-/* The variable into which error messages are latched. */\r
-static char *pcStatusMessage = "OK";\r
-\r
-/* This semaphore is created purely to test using the vSemaphoreDelete() and\r
-semaphore tracing API functions.  It has no other purpose. */\r
-static xSemaphoreHandle xMutexToDelete = NULL;\r
+\r
+/* This project provides two demo applications.  A simple blinky style demo\r
+application, and a more comprehensive test and demo application.  The\r
+mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is used to select between the two.\r
+\r
+If mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is 1 then the blinky demo will be built.\r
+The blinky demo is implemented and described in main_blinky.c.\r
+\r
+If mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is not 1 then the comprehensive test and\r
+demo application will be built.  The comprehensive test and demo application is\r
+implemented and described in main_full.c. */\r
+#define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY     1\r
+\r
+/* This demo uses heap_5.c, and these constants define the sizes of the regions\r
+that make up the total heap.  heap_5 is only used for test and example purposes\r
+as this demo could easily create one large heap region instead of multiple\r
+smaller heap regions - in which case heap_4.c would be the more appropriate\r
+choice.  See http://www.freertos.org/a00111.html for an explanation. */\r
+#define mainREGION_1_SIZE      7001\r
+#define mainREGION_2_SIZE      18105\r
+#define mainREGION_3_SIZE      2807\r

 \r
 /*-----------------------------------------------------------*/\r
 \r
 \r
 /*-----------------------------------------------------------*/\r
 \r

-int main( void )\r
-{\r
-       /* Start the check task as described at the top of this file. */\r
-       xTaskCreate( prvCheckTask, ( signed char * ) "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
-\r
-       /* Create the standard demo tasks. */\r
-       vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
-       vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
-       vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
-       vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );\r
-       vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );\r
-       vStartQueuePeekTasks();\r
-       vStartMathTasks( mainFLOP_TASK_PRIORITY );\r
-       vStartRecursiveMutexTasks();\r
-       vStartTimerDemoTask( mainTIMER_TEST_PERIOD );\r
-       vStartCountingSemaphoreTasks();\r
-       vStartDynamicPriorityTasks();\r
-       vStartQueueSetTasks();\r
-\r
-       /* The suicide tasks must be created last as they need to know how many\r
-       tasks were running prior to their creation.  This then allows them to \r
-       ascertain whether or not the correct/expected number of tasks are running at \r
-       any given time. */\r
-       vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
-\r
-       /* Create the semaphore that will be deleted in the idle task hook.  This\r
-       is done purely to test the use of vSemaphoreDelete(). */\r
-       xMutexToDelete = xSemaphoreCreateMutex();\r
-\r
-       /* Start the scheduler itself. */\r
-       vTaskStartScheduler();\r
-\r
-    /* Should never get here unless there was not enough heap space to create \r
-       the idle and other system tasks. */\r
-    return 0;\r
-}\r
+/*\r
+ * main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.\r
+ * main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.\r
+ */\r
+extern void main_blinky( void );\r
+extern void main_full( void );\r
+\r
+/*\r
+ * Only the comprehensive demo uses application hook (callback) functions.  See\r
+ * http://www.freertos.org/a00016.html for more information.\r
+ */\r
+void vFullDemoTickHookFunction( void );\r
+void vFullDemoIdleFunction( void );\r
+\r
+/*\r
+ * This demo uses heap_5.c, so start by defining some heap regions.  It is not\r
+ * necessary for this demo to use heap_5, as it could define one large heap\r
+ * region.  Heap_5 is only used for test and example purposes.  See\r
+ * http://www.freertos.org/a00111.html for an explanation.\r
+ */\r
+static void  prvInitialiseHeap( void );\r
+\r
+/*\r
+ * Prototypes for the standard FreeRTOS application hook (callback) functions\r
+ * implemented within this file.  See http://www.freertos.org/a00016.html .\r
+ */\r
+void vApplicationMallocFailedHook( void );\r
+void vApplicationIdleHook( void );\r
+void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName );\r
+void vApplicationTickHook( void );\r
+void vApplicationGetIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer, StackType_t **ppxIdleTaskStackBuffer, uint32_t *pulIdleTaskStackSize );\r
+void vApplicationGetTimerTaskMemory( StaticTask_t **ppxTimerTaskTCBBuffer, StackType_t **ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize );\r
+\r
+/*\r
+ * Writes trace data to a disk file when the trace recording is stopped.\r
+ * This function will simply overwrite any trace files that already exist.\r
+ */\r
+static void prvSaveTraceFile( void );\r
+\r

 /*-----------------------------------------------------------*/\r
 \r
 /*-----------------------------------------------------------*/\r
 \r

-static void prvCheckTask( void *pvParameters )\r
-{\r
-portTickType xNextWakeTime;\r
-const portTickType xCycleFrequency = 1000 / portTICK_RATE_MS;\r
+/* When configSUPPORT_STATIC_ALLOCATION is set to 1 the application writer can\r
+use a callback function to optionally provide the memory required by the idle\r
+and timer tasks.  This is the stack that will be used by the timer task.  It is\r
+declared here, as a global, so it can be checked by a test that is implemented\r
+in a different file. */\r
+StackType_t uxTimerTaskStack[ configTIMER_TASK_STACK_DEPTH ];\r

 \r
 \r

-       /* Just to remove compiler warning. */\r
-       ( void ) pvParameters;\r
+/* The user trace event posted to the trace recording on each tick interrupt.\r
+Note:  This project runs under Windows, and Windows will not be executing the\r
+RTOS threads continuously.  Therefore tick events will not appear with a regular\r
+interval within the trace recording. */\r
+traceLabel xTickTraceUserEvent;\r
+static portBASE_TYPE xTraceRunning = pdTRUE;\r

 \r
 \r

-       /* Initialise xNextWakeTime - this only needs to be done once. */\r
-       xNextWakeTime = xTaskGetTickCount();\r
+/*-----------------------------------------------------------*/\r

 \r
 \r

-       for( ;; )\r
+int main( void )\r
+{\r
+       /* This demo uses heap_5.c, so start by defining some heap regions.  heap_5\r
+       is only used for test and example reasons.  Heap_4 is more appropriate.  See\r
+       http://www.freertos.org/a00111.html for an explanation. */\r
+       prvInitialiseHeap();\r
+\r
+       /* Initialise the trace recorder and create the label used to post user\r
+       events to the trace recording on each tick interrupt.  Use of the trace\r
+       recorder is optional.  See http://www.FreeRTOS.org/trace for more\r
+       information. */\r
+       vTraceInitTraceData();\r
+       xTickTraceUserEvent = xTraceOpenLabel( "tick" );\r
+\r
+       /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top\r
+       of this file. */\r
+       #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1 )\r
+       {\r
+               main_blinky();\r
+       }\r
+       #else\r

        {\r
        {\r

-               /* Place this task in the blocked state until it is time to run again. */\r
-               vTaskDelayUntil( &xNextWakeTime, xCycleFrequency );\r
+               /* Start the trace recording - the recording is written to a file if\r
+               configASSERT() is called. */\r
+               printf( "\r\nTrace started.\r\nThe trace will be dumped to disk if a call to configASSERT() fails.\r\n" );\r
+               printf( "Uncomment the call to kbhit() in this file to also dump trace with a key press.\r\n" );\r
+               uiTraceStart();\r

 \r
 \r

-               /* Check the standard demo tasks are running without error. */\r
-               if( xAreTimerDemoTasksStillRunning( xCycleFrequency ) != pdTRUE )\r
-               {\r
-                       pcStatusMessage = "Error: TimerDemo";\r
-               }\r
-           else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
-           {\r
-                       pcStatusMessage = "Error: IntMath";\r
-           }   \r
-               else if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
-               {                       \r
-                       pcStatusMessage = "Error: GenQueue";\r
-               }\r
-               else if( xAreQueuePeekTasksStillRunning() != pdTRUE )\r
-               {\r
-                       pcStatusMessage = "Error: QueuePeek";\r
-               }\r
-               else if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
-               {\r
-                       pcStatusMessage = "Error: BlockQueue";\r
-               }\r
-           else if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
-           {\r
-                       pcStatusMessage = "Error: SemTest";\r
-           }\r
-           else if( xArePollingQueuesStillRunning() != pdTRUE )\r
-           {\r
-                       pcStatusMessage = "Error: PollQueue";\r
-           }\r
-               else if( xAreMathsTaskStillRunning() != pdPASS )\r
-               {\r
-                       pcStatusMessage = "Error: Flop";\r
-               }\r
-           else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
-           {\r
-                       pcStatusMessage = "Error: RecMutex";\r
-               }\r
-               else if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )\r
-               {\r
-                       pcStatusMessage = "Error: CountSem";\r
-               }\r
-               else if( xIsCreateTaskStillRunning() != pdTRUE )\r
-               {\r
-                       pcStatusMessage = "Error: Death";\r
-               }\r
-               else if( xAreDynamicPriorityTasksStillRunning() != pdPASS )\r
-               {\r
-                       pcStatusMessage = "Error: Dynamic\r\n";\r
-               }\r
-               else if( xAreQueueSetTasksStillRunning() != pdPASS )\r
+               main_full();\r
+       }\r
+       #endif\r
+\r
+       return 0;\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+void vApplicationMallocFailedHook( void )\r
+{\r
+       /* vApplicationMallocFailedHook() will only be called if\r
+       configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h.  It is a hook\r
+       function that will get called if a call to pvPortMalloc() fails.\r
+       pvPortMalloc() is called internally by the kernel whenever a task, queue,\r
+       timer or semaphore is created.  It is also called by various parts of the\r
+       demo application.  If heap_1.c, heap_2.c or heap_4.c is being used, then the\r
+       size of the     heap available to pvPortMalloc() is defined by\r
+       configTOTAL_HEAP_SIZE in FreeRTOSConfig.h, and the xPortGetFreeHeapSize()\r
+       API function can be used to query the size of free heap space that remains\r
+       (although it does not provide information on how the remaining heap might be\r
+       fragmented).  See http://www.freertos.org/a00111.html for more\r
+       information. */\r
+       vAssertCalled( __LINE__, __FILE__ );\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+void vApplicationIdleHook( void )\r
+{\r
+       /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set\r
+       to 1 in FreeRTOSConfig.h.  It will be called on each iteration of the idle\r
+       task.  It is essential that code added to this hook function never attempts\r
+       to block in any way (for example, call xQueueReceive() with a block time\r
+       specified, or call vTaskDelay()).  If application tasks make use of the\r
+       vTaskDelete() API function to delete themselves then it is also important\r
+       that vApplicationIdleHook() is permitted to return to its calling function,\r
+       because it is the responsibility of the idle task to clean up memory\r
+       allocated by the kernel to any task that has since deleted itself. */\r
+\r
+       /* Uncomment the following code to allow the trace to be stopped with any\r
+       key press.  The code is commented out by default as the kbhit() function\r
+       interferes with the run time behaviour. */\r
+       /*\r
+               if( _kbhit() != pdFALSE )\r

                {\r
                {\r

-                       pcStatusMessage = "Error: Queue set\r\n";\r
+                       if( xTraceRunning == pdTRUE )\r
+                       {\r
+                               vTraceStop();\r
+                               prvSaveTraceFile();\r
+                               xTraceRunning = pdFALSE;\r
+                       }\r

                }\r
                }\r

+       */\r

 \r
 \r

-               /* This is the only task that uses stdout so its ok to call printf() \r
-               directly. */\r
-               printf( "%s - %d\r\n", pcStatusMessage, xTaskGetTickCount() );\r
+       #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY != 1 )\r
+       {\r
+               /* Call the idle task processing used by the full demo.  The simple\r
+               blinky demo does not use the idle task hook. */\r
+               vFullDemoIdleFunction();\r

        }\r
        }\r

+       #endif\r

 }\r
 /*-----------------------------------------------------------*/\r
 \r
 }\r
 /*-----------------------------------------------------------*/\r
 \r

-static void prvTestTask( void *pvParameters )\r
+void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )\r

 {\r
 {\r

-const unsigned long ulMSToSleep = 5;\r
+       ( void ) pcTaskName;\r
+       ( void ) pxTask;\r
+\r
+       /* Run time stack overflow checking is performed if\r
+       configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
+       function is called if a stack overflow is detected.  This function is\r
+       provided as an example only as stack overflow checking does not function\r
+       when running the FreeRTOS Windows port. */\r
+       vAssertCalled( __LINE__, __FILE__ );\r
+}\r
+/*-----------------------------------------------------------*/\r

 \r
 \r

-       /* Just to remove compiler warnings. */\r
-       ( void ) pvParameters;\r
+void vApplicationTickHook( void )\r
+{\r
+       /* This function will be called by each tick interrupt if\r
+       configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h.  User code can be\r
+       added here, but the tick hook is called from an interrupt context, so\r
+       code must not attempt to block, and only the interrupt safe FreeRTOS API\r
+       functions can be used (those that end in FromISR()). */\r

 \r
 \r

-       /* This task is just used to test the eTaskStateGet() function.  It\r
-       does not have anything to do. */\r
-       for( ;; )\r
+       #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY != 1 )\r

        {\r
        {\r

-               /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are\r
-               tasks waiting to be terminated by the idle task. */\r
-               Sleep( ulMSToSleep );\r
+               vFullDemoTickHookFunction();\r

        }\r
        }\r

+       #endif /* mainCREATE_SIMPLE_BLINKY_DEMO_ONLY */\r
+\r
+       /* Write a user event to the trace log.  Note:  This project runs under\r
+       Windows, and Windows will not be executing the RTOS threads continuously.\r
+       Therefore tick events will not appear with a regular interval within the the\r
+       trace recording. */\r
+       vTraceUserEvent( xTickTraceUserEvent );\r

 }\r
 /*-----------------------------------------------------------*/\r
 \r
 }\r
 /*-----------------------------------------------------------*/\r
 \r

-void vApplicationIdleHook( void )\r
+void vApplicationDaemonTaskStartupHook( void )\r

 {\r
 {\r

-const unsigned long ulMSToSleep = 15;\r
-xTaskHandle xIdleTaskHandle, xTimerTaskHandle, xTestTask;\r
-signed char *pcTaskName;\r
-const unsigned char ucConstQueueNumber = 0xaaU, ucConstTaskNumber = 0x55U;\r
-\r
-/* These three functions are only meant for use by trace code, and not for\r
-direct use from application code, hence their prototypes are not in queue.h. */\r
-extern void vQueueSetQueueNumber( xQueueHandle pxQueue, unsigned char ucQueueNumber );\r
-extern unsigned char ucQueueGetQueueNumber( xQueueHandle pxQueue );\r
-extern unsigned char ucQueueGetQueueType( xQueueHandle pxQueue );\r
-extern void vTaskSetTaskNumber( xTaskHandle xTask, unsigned portBASE_TYPE uxHandle );\r
-extern unsigned portBASE_TYPE uxTaskGetTaskNumber( xTaskHandle xTask );\r
-\r
-       /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are\r
-       tasks waiting to be terminated by the idle task. */\r
-       Sleep( ulMSToSleep );\r
-\r
-       /* Demonstrate the use of the xTimerGetTimerDaemonTaskHandle() and \r
-       xTaskGetIdleTaskHandle() functions.  Also try using the function that sets\r
-       the task number. */\r
-       xIdleTaskHandle = xTaskGetIdleTaskHandle();\r
-       xTimerTaskHandle = xTimerGetTimerDaemonTaskHandle();\r
-       vTaskSetTaskNumber( xIdleTaskHandle, ( unsigned long ) ucConstTaskNumber );\r
-       configASSERT( uxTaskGetTaskNumber( xIdleTaskHandle ) == ucConstTaskNumber );\r
-\r
-       /* This is the idle hook, so the current task handle should equal the \r
-       returned idle task handle. */\r
-       if( xTaskGetCurrentTaskHandle() != xIdleTaskHandle )\r
-       {\r
-               pcStatusMessage = "Error:  Returned idle task handle was incorrect";\r
-       }\r
+       /* This function will be called once only, when the daemon task starts to\r
+       execute (sometimes called the timer task).  This is useful if the\r
+       application includes initialisation code that would benefit from executing\r
+       after the scheduler has been started. */\r
+}\r
+/*-----------------------------------------------------------*/\r

 \r
 \r

-       /* Check the timer task handle was returned correctly. */\r
-       pcTaskName = pcTaskGetTaskName( xTimerTaskHandle );\r
-       if( strcmp( pcTaskName, "Tmr Svc" ) != 0 )\r
-       {\r
-               pcStatusMessage = "Error:  Returned timer task handle was incorrect";\r
-       }\r
+void vAssertCalled( unsigned long ulLine, const char * const pcFileName )\r
+{\r
+static portBASE_TYPE xPrinted = pdFALSE;\r
+volatile uint32_t ulSetToNonZeroInDebuggerToContinue = 0;\r

 \r
 \r

-       /* This task is running, make sure its state is returned as running. */\r
-       if( eTaskStateGet( xIdleTaskHandle ) != eRunning )\r
-       {\r
-               pcStatusMessage = "Error:  Returned idle task state was incorrect";\r
-       }\r
+       /* Called if an assertion passed to configASSERT() fails.  See\r
+       http://www.freertos.org/a00110.html#configASSERT for more information. */\r

 \r
 \r

-       /* If this task is running, then the timer task must be blocked. */\r
-       if( eTaskStateGet( xTimerTaskHandle ) != eBlocked )\r
-       {\r
-               pcStatusMessage = "Error:  Returned timer task state was incorrect";\r
-       }\r
+       /* Parameters are not used. */\r
+       ( void ) ulLine;\r
+       ( void ) pcFileName;\r
+\r
+       printf( "ASSERT! Line %d, file %s, GetLastError() %d\r\n", ulLine, pcFileName, GetLastError() );\r

 \r
 \r

-       /* If xMutexToDelete has not already been deleted, then delete it now.\r
-       This is done purely to demonstrate the use of, and test, the \r
-       vSemaphoreDelete() macro.  Care must be taken not to delete a semaphore\r
-       that has tasks blocked on it. */\r
-       if( xMutexToDelete != NULL )\r
+       taskENTER_CRITICAL();\r

        {\r
        {\r

-               /* Before deleting the semaphore, test the function used to set its\r
-               number.  This would normally only be done from trace software, rather\r
-               than application code. */\r
-               vQueueSetQueueNumber( xMutexToDelete, ucConstQueueNumber );\r
-\r
-               /* Before deleting the semaphore, test the functions used to get its\r
-               type and number.  Again, these would normally only be done from trace\r
-               software, rather than application code. */\r
-               configASSERT( ucQueueGetQueueNumber( xMutexToDelete ) == ucConstQueueNumber );\r
-               configASSERT( ucQueueGetQueueType( xMutexToDelete ) == queueQUEUE_TYPE_MUTEX );\r
-               vSemaphoreDelete( xMutexToDelete );\r
-               xMutexToDelete = NULL;\r
-\r
-               /* Other tests that should only be performed once follow.  The test task\r
-               is not created on each iteration because to do so would cause the death\r
-               task to report an error (too many tasks running). */\r
-\r
-               /* Create a test task to use to test other eTaskStateGet() return values. */\r
-               if( xTaskCreate( prvTestTask, "Test", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, &xTestTask ) == pdPASS )\r
+               /* Stop the trace recording. */\r
+               if( xPrinted == pdFALSE )\r

                {\r
                {\r

-                       /* If this task is running, the test task must be in the ready state. */\r
-                       if( eTaskStateGet( xTestTask ) != eReady )\r
-                       {\r
-                               pcStatusMessage = "Error: Returned test task state was incorrect 1";\r
-                       }\r
-\r
-                       /* Now suspend the test task and check its state is reported correctly. */\r
-                       vTaskSuspend( xTestTask );\r
-                       if( eTaskStateGet( xTestTask ) != eSuspended )\r
-                       {\r
-                               pcStatusMessage = "Error: Returned test task state was incorrect 2";\r
-                       }\r
-\r
-                       /* Now delete the task and check its state is reported correctly. */\r
-                       vTaskDelete( xTestTask );\r
-                       if( eTaskStateGet( xTestTask ) != eDeleted )\r
+                       xPrinted = pdTRUE;\r
+                       if( xTraceRunning == pdTRUE )\r

                        {\r
                        {\r

-                               pcStatusMessage = "Error: Returned test task state was incorrect 3";\r
+                               vTraceStop();\r
+                               prvSaveTraceFile();\r

                        }\r
                }\r
 \r
                        }\r
                }\r
 \r

+               /* You can step out of this function to debug the assertion by using\r
+               the debugger to set ulSetToNonZeroInDebuggerToContinue to a non-zero\r
+               value. */\r
+               while( ulSetToNonZeroInDebuggerToContinue == 0 )\r
+               {\r
+                       __asm{ NOP };\r
+                       __asm{ NOP };\r
+               }\r

        }\r
        }\r

+       taskEXIT_CRITICAL();\r

 }\r
 /*-----------------------------------------------------------*/\r
 \r
 }\r
 /*-----------------------------------------------------------*/\r
 \r

-void vApplicationMallocFailedHook( void )\r
+static void prvSaveTraceFile( void )\r

 {\r
 {\r

-       /* Can be implemented if required, but probably not required in this \r
-       environment and running this demo. */\r
+FILE* pxOutputFile;\r
+\r
+       fopen_s( &pxOutputFile, "Trace.dump", "wb");\r
+\r
+       if( pxOutputFile != NULL )\r
+       {\r
+               fwrite( RecorderDataPtr, sizeof( RecorderDataType ), 1, pxOutputFile );\r
+               fclose( pxOutputFile );\r
+               printf( "\r\nTrace output saved to Trace.dump\r\n" );\r
+       }\r
+       else\r
+       {\r
+               printf( "\r\nFailed to create trace dump file\r\n" );\r
+       }\r

 }\r
 /*-----------------------------------------------------------*/\r
 \r
 }\r
 /*-----------------------------------------------------------*/\r
 \r

-void vApplicationStackOverflowHook( void )\r
+static void  prvInitialiseHeap( void )\r
+{\r
+/* The Windows demo could create one large heap region, in which case it would\r
+be appropriate to use heap_4.  However, purely for demonstration purposes,\r
+heap_5 is used instead, so start by defining some heap regions.  No\r
+initialisation is required when any other heap implementation is used.  See\r
+http://www.freertos.org/a00111.html for more information.\r
+\r
+The xHeapRegions structure requires the regions to be defined in start address\r
+order, so this just creates one big array, then populates the structure with\r
+offsets into the array - with gaps in between and messy alignment just for test\r
+purposes. */\r
+static uint8_t ucHeap[ configTOTAL_HEAP_SIZE ];\r
+volatile uint32_t ulAdditionalOffset = 19; /* Just to prevent 'condition is always true' warnings in configASSERT(). */\r
+const HeapRegion_t xHeapRegions[] =\r

 {\r
 {\r

-       /* Can be implemented if required, but not required in this \r
-       environment and running this demo. */\r
+       /* Start address with dummy offsets                                             Size */\r
+       { ucHeap + 1,                                                                                   mainREGION_1_SIZE },\r
+       { ucHeap + 15 + mainREGION_1_SIZE,                                              mainREGION_2_SIZE },\r
+       { ucHeap + 19 + mainREGION_1_SIZE + mainREGION_2_SIZE,  mainREGION_3_SIZE },\r
+       { NULL, 0 }\r
+};\r
+\r
+       /* Sanity check that the sizes and offsets defined actually fit into the\r
+       array. */\r
+       configASSERT( ( ulAdditionalOffset + mainREGION_1_SIZE + mainREGION_2_SIZE + mainREGION_3_SIZE ) < configTOTAL_HEAP_SIZE );\r
+\r
+       /* Prevent compiler warnings when configASSERT() is not defined. */\r
+       ( void ) ulAdditionalOffset;\r
+\r
+       vPortDefineHeapRegions( xHeapRegions );\r

 }\r
 /*-----------------------------------------------------------*/\r
 \r
 }\r
 /*-----------------------------------------------------------*/\r
 \r

-void vApplicationTickHook( void )\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, uint32_t *pulIdleTaskStackSize )\r

 {\r
 {\r

-       /* Call the periodic timer test, which tests the timer API functions that\r
-       can be called from an ISR. */\r
-       vTimerPeriodicISRTests();\r
-\r
-       /* Write to a queue that is in use as part of the queue set demo to \r
-       demonstrate using queue sets from an ISR. */\r
-       vQueueSetWriteToQueueFromISR();\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
+       /* 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
+\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
+       *pulIdleTaskStackSize = configMINIMAL_STACK_SIZE;\r

 }\r
 /*-----------------------------------------------------------*/\r
 \r
 }\r
 /*-----------------------------------------------------------*/\r
 \r

-void vAssertCalled( void )\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, uint32_t *pulTimerTaskStackSize )\r

 {\r
 {\r

-       taskDISABLE_INTERRUPTS();\r
-       for( ;; );\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
+\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
+\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
+       *pulTimerTaskStackSize = configTIMER_TASK_STACK_DEPTH;\r

 }\r
 \r
 }\r
 \r