git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/WIN32-MSVC/main.c

   1 /*\r
   2     FreeRTOS V9.0.1 - Copyright (C) 2017 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 /******************************************************************************\r
  71  * This project provides two demo applications.  A simple blinky style project,\r
  72  * and a more comprehensive test and demo application.  The\r
  73  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is used to select between the two.\r
  74  * The simply blinky demo is implemented and described in main_blinky.c.  The\r
  75  * more comprehensive test and demo application is implemented and described in\r
  76  * main_full.c.\r
  77  *\r
  78  * This file implements the code that is not demo specific, including the\r
  79  * hardware setup and FreeRTOS hook functions.\r
  80  *\r
  81  *******************************************************************************\r
  82  * NOTE: Windows will not be running the FreeRTOS demo threads continuously, so\r
  83  * do not expect to get real time behaviour from the FreeRTOS Windows port, or\r
  84  * this demo application.  Also, the timing information in the FreeRTOS+Trace\r
  85  * logs have no meaningful units.  See the documentation page for the Windows\r
  86  * port for further information:\r
  87  * http://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html\r
  88  *\r
  89  * This demo was created using Windows XP on a dual core laptop, and has since\r
  90  * been maintained using Windows 7 on a quad core laptop.\r
  91  *\r
  92  *******************************************************************************\r
  93  */\r
  94 \r
  95 /* Standard includes. */\r
  96 #include <stdio.h>\r
  97 #include <stdlib.h>\r
  98 #include <conio.h>\r
  99 \r
 100 /* FreeRTOS kernel includes. */\r
 101 #include "FreeRTOS.h"\r
 102 #include "task.h"\r
 103 \r
 104 /* This project provides two demo applications.  A simple blinky style demo\r
 105 application, and a more comprehensive test and demo application.  The\r
 106 mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is used to select between the two.\r
 107 \r
 108 If mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is 1 then the blinky demo will be built.\r
 109 The blinky demo is implemented and described in main_blinky.c.\r
 110 \r
 111 If mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is not 1 then the comprehensive test and\r
 112 demo application will be built.  The comprehensive test and demo application is\r
 113 implemented and described in main_full.c. */\r
 114 #define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY      1\r
 115 \r
 116 /* This demo uses heap_5.c, and these constants define the sizes of the regions\r
 117 that make up the total heap.  heap_5 is only used for test and example purposes\r
 118 as this demo could easily create one large heap region instead of multiple\r
 119 smaller heap regions - in which case heap_4.c would be the more appropriate\r
 120 choice.  See http://www.freertos.org/a00111.html for an explanation. */\r
 121 #define mainREGION_1_SIZE       7001\r
 122 #define mainREGION_2_SIZE       18105\r
 123 #define mainREGION_3_SIZE       2807\r
 124 \r
 125 /*-----------------------------------------------------------*/\r
 126 \r
 127 /*\r
 128  * main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.\r
 129  * main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.\r
 130  */\r
 131 extern void main_blinky( void );\r
 132 extern void main_full( void );\r
 133 \r
 134 /*\r
 135  * Only the comprehensive demo uses application hook (callback) functions.  See\r
 136  * http://www.freertos.org/a00016.html for more information.\r
 137  */\r
 138 void vFullDemoTickHookFunction( void );\r
 139 void vFullDemoIdleFunction( void );\r
 140 \r
 141 /*\r
 142  * This demo uses heap_5.c, so start by defining some heap regions.  It is not\r
 143  * necessary for this demo to use heap_5, as it could define one large heap\r
 144  * region.  Heap_5 is only used for test and example purposes.  See\r
 145  * http://www.freertos.org/a00111.html for an explanation.\r
 146  */\r
 147 static void  prvInitialiseHeap( void );\r
 148 \r
 149 /*\r
 150  * Prototypes for the standard FreeRTOS application hook (callback) functions\r
 151  * implemented within this file.  See http://www.freertos.org/a00016.html .\r
 152  */\r
 153 void vApplicationMallocFailedHook( void );\r
 154 void vApplicationIdleHook( void );\r
 155 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName );\r
 156 void vApplicationTickHook( void );\r
 157 void vApplicationGetIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer, StackType_t **ppxIdleTaskStackBuffer, uint32_t *pulIdleTaskStackSize );\r
 158 void vApplicationGetTimerTaskMemory( StaticTask_t **ppxTimerTaskTCBBuffer, StackType_t **ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize );\r
 159 \r
 160 /*\r
 161  * Writes trace data to a disk file when the trace recording is stopped.\r
 162  * This function will simply overwrite any trace files that already exist.\r
 163  */\r
 164 static void prvSaveTraceFile( void );\r
 165 \r
 166 /*-----------------------------------------------------------*/\r
 167 \r
 168 /* When configSUPPORT_STATIC_ALLOCATION is set to 1 the application writer can\r
 169 use a callback function to optionally provide the memory required by the idle\r
 170 and timer tasks.  This is the stack that will be used by the timer task.  It is\r
 171 declared here, as a global, so it can be checked by a test that is implemented\r
 172 in a different file. */\r
 173 StackType_t uxTimerTaskStack[ configTIMER_TASK_STACK_DEPTH ];\r
 174 \r
 175 /* Notes if the trace is running or not. */\r
 176 static BaseType_t xTraceRunning = pdTRUE;\r
 177 \r
 178 /*-----------------------------------------------------------*/\r
 179 \r
 180 int main( void )\r
 181 {\r
 182         /* This demo uses heap_5.c, so start by defining some heap regions.  heap_5\r
 183         is only used for test and example reasons.  Heap_4 is more appropriate.  See\r
 184         http://www.freertos.org/a00111.html for an explanation. */\r
 185         prvInitialiseHeap();\r
 186 \r
 187         /* Initialise the trace recorder.  Use of the trace recorder is optional.\r
 188         See http://www.FreeRTOS.org/trace for more information. */\r
 189         vTraceEnable( TRC_START );\r
 190 \r
 191         /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top\r
 192         of this file. */\r
 193         #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1 )\r
 194         {\r
 195                 main_blinky();\r
 196         }\r
 197         #else\r
 198         {\r
 199                 /* Start the trace recording - the recording is written to a file if\r
 200                 configASSERT() is called. */\r
 201                 printf( "\r\nTrace started.\r\nThe trace will be dumped to disk if a call to configASSERT() fails.\r\n" );\r
 202                 printf( "Uncomment the call to kbhit() in this file to also dump trace with a key press.\r\n" );\r
 203                 uiTraceStart();\r
 204 \r
 205                 main_full();\r
 206         }\r
 207         #endif\r
 208 \r
 209         return 0;\r
 210 }\r
 211 /*-----------------------------------------------------------*/\r
 212 \r
 213 void vApplicationMallocFailedHook( void )\r
 214 {\r
 215         /* vApplicationMallocFailedHook() will only be called if\r
 216         configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h.  It is a hook\r
 217         function that will get called if a call to pvPortMalloc() fails.\r
 218         pvPortMalloc() is called internally by the kernel whenever a task, queue,\r
 219         timer or semaphore is created.  It is also called by various parts of the\r
 220         demo application.  If heap_1.c, heap_2.c or heap_4.c is being used, then the\r
 221         size of the     heap available to pvPortMalloc() is defined by\r
 222         configTOTAL_HEAP_SIZE in FreeRTOSConfig.h, and the xPortGetFreeHeapSize()\r
 223         API function can be used to query the size of free heap space that remains\r
 224         (although it does not provide information on how the remaining heap might be\r
 225         fragmented).  See http://www.freertos.org/a00111.html for more\r
 226         information. */\r
 227         vAssertCalled( __LINE__, __FILE__ );\r
 228 }\r
 229 /*-----------------------------------------------------------*/\r
 230 \r
 231 void vApplicationIdleHook( void )\r
 232 {\r
 233         /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set\r
 234         to 1 in FreeRTOSConfig.h.  It will be called on each iteration of the idle\r
 235         task.  It is essential that code added to this hook function never attempts\r
 236         to block in any way (for example, call xQueueReceive() with a block time\r
 237         specified, or call vTaskDelay()).  If application tasks make use of the\r
 238         vTaskDelete() API function to delete themselves then it is also important\r
 239         that vApplicationIdleHook() is permitted to return to its calling function,\r
 240         because it is the responsibility of the idle task to clean up memory\r
 241         allocated by the kernel to any task that has since deleted itself. */\r
 242 \r
 243         /* Uncomment the following code to allow the trace to be stopped with any\r
 244         key press.  The code is commented out by default as the kbhit() function\r
 245         interferes with the run time behaviour. */\r
 246         /*\r
 247                 if( _kbhit() != pdFALSE )\r
 248                 {\r
 249                         if( xTraceRunning == pdTRUE )\r
 250                         {\r
 251                                 vTraceStop();\r
 252                                 prvSaveTraceFile();\r
 253                                 xTraceRunning = pdFALSE;\r
 254                         }\r
 255                 }\r
 256         */\r
 257 \r
 258         #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY != 1 )\r
 259         {\r
 260                 /* Call the idle task processing used by the full demo.  The simple\r
 261                 blinky demo does not use the idle task hook. */\r
 262                 vFullDemoIdleFunction();\r
 263         }\r
 264         #endif\r
 265 }\r
 266 /*-----------------------------------------------------------*/\r
 267 \r
 268 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )\r
 269 {\r
 270         ( void ) pcTaskName;\r
 271         ( void ) pxTask;\r
 272 \r
 273         /* Run time stack overflow checking is performed if\r
 274         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 275         function is called if a stack overflow is detected.  This function is\r
 276         provided as an example only as stack overflow checking does not function\r
 277         when running the FreeRTOS Windows port. */\r
 278         vAssertCalled( __LINE__, __FILE__ );\r
 279 }\r
 280 /*-----------------------------------------------------------*/\r
 281 \r
 282 void vApplicationTickHook( void )\r
 283 {\r
 284         /* This function will be called by each tick interrupt if\r
 285         configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h.  User code can be\r
 286         added here, but the tick hook is called from an interrupt context, so\r
 287         code must not attempt to block, and only the interrupt safe FreeRTOS API\r
 288         functions can be used (those that end in FromISR()). */\r
 289 \r
 290         #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY != 1 )\r
 291         {\r
 292                 vFullDemoTickHookFunction();\r
 293         }\r
 294         #endif /* mainCREATE_SIMPLE_BLINKY_DEMO_ONLY */\r
 295 }\r
 296 /*-----------------------------------------------------------*/\r
 297 \r
 298 void vApplicationDaemonTaskStartupHook( void )\r
 299 {\r
 300         /* This function will be called once only, when the daemon task starts to\r
 301         execute (sometimes called the timer task).  This is useful if the\r
 302         application includes initialisation code that would benefit from executing\r
 303         after the scheduler has been started. */\r
 304 }\r
 305 /*-----------------------------------------------------------*/\r
 306 \r
 307 void vAssertCalled( unsigned long ulLine, const char * const pcFileName )\r
 308 {\r
 309 static BaseType_t xPrinted = pdFALSE;\r
 310 volatile uint32_t ulSetToNonZeroInDebuggerToContinue = 0;\r
 311 \r
 312         /* Called if an assertion passed to configASSERT() fails.  See\r
 313         http://www.freertos.org/a00110.html#configASSERT for more information. */\r
 314 \r
 315         /* Parameters are not used. */\r
 316         ( void ) ulLine;\r
 317         ( void ) pcFileName;\r
 318 \r
 319         printf( "ASSERT! Line %d, file %s, GetLastError() %d\r\n", ulLine, pcFileName, GetLastError() );\r
 320 \r
 321         taskENTER_CRITICAL();\r
 322         {\r
 323                 /* Stop the trace recording. */\r
 324                 if( xPrinted == pdFALSE )\r
 325                 {\r
 326                         xPrinted = pdTRUE;\r
 327                         if( xTraceRunning == pdTRUE )\r
 328                         {\r
 329                                 vTraceStop();\r
 330                                 prvSaveTraceFile();\r
 331                         }\r
 332                 }\r
 333 \r
 334                 /* You can step out of this function to debug the assertion by using\r
 335                 the debugger to set ulSetToNonZeroInDebuggerToContinue to a non-zero\r
 336                 value. */\r
 337                 while( ulSetToNonZeroInDebuggerToContinue == 0 )\r
 338                 {\r
 339                         __asm{ NOP };\r
 340                         __asm{ NOP };\r
 341                 }\r
 342         }\r
 343         taskEXIT_CRITICAL();\r
 344 }\r
 345 /*-----------------------------------------------------------*/\r
 346 \r
 347 static void prvSaveTraceFile( void )\r
 348 {\r
 349 FILE* pxOutputFile;\r
 350 \r
 351         fopen_s( &pxOutputFile, "Trace.dump", "wb");\r
 352 \r
 353         if( pxOutputFile != NULL )\r
 354         {\r
 355                 fwrite( RecorderDataPtr, sizeof( RecorderDataType ), 1, pxOutputFile );\r
 356                 fclose( pxOutputFile );\r
 357                 printf( "\r\nTrace output saved to Trace.dump\r\n" );\r
 358         }\r
 359         else\r
 360         {\r
 361                 printf( "\r\nFailed to create trace dump file\r\n" );\r
 362         }\r
 363 }\r
 364 /*-----------------------------------------------------------*/\r
 365 \r
 366 static void  prvInitialiseHeap( void )\r
 367 {\r
 368 /* The Windows demo could create one large heap region, in which case it would\r
 369 be appropriate to use heap_4.  However, purely for demonstration purposes,\r
 370 heap_5 is used instead, so start by defining some heap regions.  No\r
 371 initialisation is required when any other heap implementation is used.  See\r
 372 http://www.freertos.org/a00111.html for more information.\r
 373 \r
 374 The xHeapRegions structure requires the regions to be defined in start address\r
 375 order, so this just creates one big array, then populates the structure with\r
 376 offsets into the array - with gaps in between and messy alignment just for test\r
 377 purposes. */\r
 378 static uint8_t ucHeap[ configTOTAL_HEAP_SIZE ];\r
 379 volatile uint32_t ulAdditionalOffset = 19; /* Just to prevent 'condition is always true' warnings in configASSERT(). */\r
 380 const HeapRegion_t xHeapRegions[] =\r
 381 {\r
 382         /* Start address with dummy offsets                                             Size */\r
 383         { ucHeap + 1,                                                                                   mainREGION_1_SIZE },\r
 384         { ucHeap + 15 + mainREGION_1_SIZE,                                              mainREGION_2_SIZE },\r
 385         { ucHeap + 19 + mainREGION_1_SIZE + mainREGION_2_SIZE,  mainREGION_3_SIZE },\r
 386         { NULL, 0 }\r
 387 };\r
 388 \r
 389         /* Sanity check that the sizes and offsets defined actually fit into the\r
 390         array. */\r
 391         configASSERT( ( ulAdditionalOffset + mainREGION_1_SIZE + mainREGION_2_SIZE + mainREGION_3_SIZE ) < configTOTAL_HEAP_SIZE );\r
 392 \r
 393         /* Prevent compiler warnings when configASSERT() is not defined. */\r
 394         ( void ) ulAdditionalOffset;\r
 395 \r
 396         vPortDefineHeapRegions( xHeapRegions );\r
 397 }\r
 398 /*-----------------------------------------------------------*/\r
 399 \r
 400 /* configUSE_STATIC_ALLOCATION is set to 1, so the application must provide an\r
 401 implementation of vApplicationGetIdleTaskMemory() to provide the memory that is\r
 402 used by the Idle task. */\r
 403 void vApplicationGetIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer, StackType_t **ppxIdleTaskStackBuffer, uint32_t *pulIdleTaskStackSize )\r
 404 {\r
 405 /* If the buffers to be provided to the Idle task are declared inside this\r
 406 function then they must be declared static - otherwise they will be allocated on\r
 407 the stack and so not exists after this function exits. */\r
 408 static StaticTask_t xIdleTaskTCB;\r
 409 static StackType_t uxIdleTaskStack[ configMINIMAL_STACK_SIZE ];\r
 410 \r
 411         /* Pass out a pointer to the StaticTask_t structure in which the Idle task's\r
 412         state will be stored. */\r
 413         *ppxIdleTaskTCBBuffer = &xIdleTaskTCB;\r
 414 \r
 415         /* Pass out the array that will be used as the Idle task's stack. */\r
 416         *ppxIdleTaskStackBuffer = uxIdleTaskStack;\r
 417 \r
 418         /* Pass out the size of the array pointed to by *ppxIdleTaskStackBuffer.\r
 419         Note that, as the array is necessarily of type StackType_t,\r
 420         configMINIMAL_STACK_SIZE is specified in words, not bytes. */\r
 421         *pulIdleTaskStackSize = configMINIMAL_STACK_SIZE;\r
 422 }\r
 423 /*-----------------------------------------------------------*/\r
 424 \r
 425 /* configUSE_STATIC_ALLOCATION and configUSE_TIMERS are both set to 1, so the\r
 426 application must provide an implementation of vApplicationGetTimerTaskMemory()\r
 427 to provide the memory that is used by the Timer service task. */\r
 428 void vApplicationGetTimerTaskMemory( StaticTask_t **ppxTimerTaskTCBBuffer, StackType_t **ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize )\r
 429 {\r
 430 /* If the buffers to be provided to the Timer task are declared inside this\r
 431 function then they must be declared static - otherwise they will be allocated on\r
 432 the stack and so not exists after this function exits. */\r
 433 static StaticTask_t xTimerTaskTCB;\r
 434 \r
 435         /* Pass out a pointer to the StaticTask_t structure in which the Timer\r
 436         task's state will be stored. */\r
 437         *ppxTimerTaskTCBBuffer = &xTimerTaskTCB;\r
 438 \r
 439         /* Pass out the array that will be used as the Timer task's stack. */\r
 440         *ppxTimerTaskStackBuffer = uxTimerTaskStack;\r
 441 \r
 442         /* Pass out the size of the array pointed to by *ppxTimerTaskStackBuffer.\r
 443         Note that, as the array is necessarily of type StackType_t,\r
 444         configMINIMAL_STACK_SIZE is specified in words, not bytes. */\r
 445         *pulTimerTaskStackSize = configTIMER_TASK_STACK_DEPTH;\r
 446 }\r
 447 \r