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

   1 /*\r
   2     FreeRTOS V8.1.2 - Copyright (C) 2014 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     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /******************************************************************************\r
  67  * This project provides two demo applications.  A simple blinky style project,\r
  68  * and a more comprehensive test and demo application.  The\r
  69  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is used to select between the two.\r
  70  * The simply blinky demo is implemented and described in main_blinky.c.  The\r
  71  * more comprehensive test and demo application is implemented and described in\r
  72  * main_full.c.\r
  73  *\r
  74  * This file implements the code that is not demo specific, including the\r
  75  * hardware setup and FreeRTOS hook functions.\r
  76  *\r
  77  *******************************************************************************\r
  78  * -NOTE- The Win32 port is a simulation (or is that emulation?) only!  Do not\r
  79  * expect to get real time behaviour from the Win32 port or this demo\r
  80  * application.  It is provided as a convenient development and demonstration\r
  81  * test bed only.  This was tested using Windows XP on a dual core laptop.\r
  82  *\r
  83  * Windows will not be running the FreeRTOS simulator threads continuously, so\r
  84  * the timing information in the FreeRTOS+Trace logs have no meaningful units.\r
  85  * See the documentation page for the Windows simulator for an explanation of\r
  86  * the slow timing:\r
  87  * http://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html\r
  88  * - READ THE WEB DOCUMENTATION FOR THIS PORT FOR MORE INFORMATION ON USING IT -\r
  89  *******************************************************************************\r
  90  *\r
  91  */\r
  92 \r
  93 /* Standard includes. */\r
  94 #include <stdio.h>\r
  95 #include <stdlib.h>\r
  96 #include <conio.h>\r
  97 \r
  98 /* FreeRTOS kernel includes. */\r
  99 #include "FreeRTOS.h"\r
 100 #include "task.h"\r
 101 \r
 102 /* This project provides two demo applications.  A simple blinky style project,\r
 103 and a more comprehensive test and demo application.  The\r
 104 mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is used to select between the two.\r
 105 The simply blinky demo is implemented and described in main_blinky.c.  The more\r
 106 comprehensive test and demo application is implemented and described in\r
 107 main_full.c. */\r
 108 #define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY      0\r
 109 \r
 110 /* This demo uses heap_5.c, and these constants define the sizes of the regions\r
 111 that make up the total heap.  This is only done to provide an example of heap_5\r
 112 being used as this demo could easily create one large heap region instead of\r
 113 multiple smaller heap regions - in which case heap_4.c would be the more\r
 114 appropriate choice. */\r
 115 #define mainREGION_1_SIZE       2001\r
 116 #define mainREGION_2_SIZE       18005\r
 117 #define mainREGION_3_SIZE       1007\r
 118 \r
 119 /*\r
 120  * main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.\r
 121  * main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.\r
 122  */\r
 123 extern void main_blinky( void );\r
 124 extern void main_full( void );\r
 125 \r
 126 /*\r
 127  * Some of the RTOS hook (callback) functions only need special processing when\r
 128  * the full demo is being used.  The simply blinky demo has no special\r
 129  * requirements, so these functions are called from the hook functions defined\r
 130  * in this file, but are defined in main_full.c.\r
 131  */\r
 132 void vFullDemoTickHookFunction( void );\r
 133 void vFullDemoIdleFunction( void );\r
 134 \r
 135 /*\r
 136  * This demo uses heap_5.c, so start by defining some heap regions.  This is\r
 137  * only done to provide an example as this demo could easily create one large\r
 138  * heap region instead of multiple smaller heap regions - in which case heap_4.c\r
 139  * would be the more appropriate choice.  No initialisation is required when\r
 140  * heap_4.c is used.\r
 141  */\r
 142 static void  prvInitialiseHeap( void );\r
 143 \r
 144 /*\r
 145  * Prototypes for the standard FreeRTOS callback/hook functions implemented\r
 146  * within this file.\r
 147  */\r
 148 void vApplicationMallocFailedHook( void );\r
 149 void vApplicationIdleHook( void );\r
 150 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName );\r
 151 void vApplicationTickHook( void );\r
 152 \r
 153 /*\r
 154  * Writes trace data to a disk file when the trace recording is stopped.\r
 155  * This function will simply overwrite any trace files that already exist.\r
 156  */\r
 157 static void prvSaveTraceFile( void );\r
 158 \r
 159 /* The user trace event posted to the trace recording on each tick interrupt.\r
 160 Note tick events will not appear in the trace recording with regular period\r
 161 because this project runs in a Windows simulator, and does not therefore\r
 162 exhibit deterministic behaviour. */\r
 163 traceLabel xTickTraceUserEvent;\r
 164 static portBASE_TYPE xTraceRunning = pdTRUE;\r
 165 \r
 166 /*-----------------------------------------------------------*/\r
 167 \r
 168 int main( void )\r
 169 {\r
 170         /* This demo uses heap_5.c, so start by defining some heap regions.  This\r
 171         is only done to provide an example as this demo could easily create one\r
 172         large heap region instead of multiple smaller heap regions - in which case\r
 173         heap_4.c would be the more appropriate choice.  No initialisation is\r
 174         required when heap_4.c is used. */\r
 175         prvInitialiseHeap();\r
 176 \r
 177         /* Initialise the trace recorder and create the label used to post user\r
 178         events to the trace recording on each tick interrupt. */\r
 179         vTraceInitTraceData();\r
 180         xTickTraceUserEvent = xTraceOpenLabel( "tick" );\r
 181 \r
 182         /* Start the trace recording - the recording is written to a file if\r
 183         configASSERT() is called. */\r
 184         printf( "\r\nTrace started.  Hit a key to dump trace file to disk.\r\n" );\r
 185         uiTraceStart();\r
 186 \r
 187         /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top\r
 188         of this file. */\r
 189         #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1 )\r
 190         {\r
 191                 main_blinky();\r
 192         }\r
 193         #else\r
 194         {\r
 195                 main_full();\r
 196         }\r
 197         #endif\r
 198 \r
 199         return 0;\r
 200 }\r
 201 /*-----------------------------------------------------------*/\r
 202 \r
 203 void vApplicationMallocFailedHook( void )\r
 204 {\r
 205         /* vApplicationMallocFailedHook() will only be called if\r
 206         configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h.  It is a hook\r
 207         function that will get called if a call to pvPortMalloc() fails.\r
 208         pvPortMalloc() is called internally by the kernel whenever a task, queue,\r
 209         timer or semaphore is created.  It is also called by various parts of the\r
 210         demo application.  If heap_1.c or heap_2.c are used, then the size of the\r
 211         heap available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in\r
 212         FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used\r
 213         to query the size of free heap space that remains (although it does not\r
 214         provide information on how the remaining heap might be fragmented). */\r
 215         vAssertCalled( __LINE__, __FILE__ );\r
 216 }\r
 217 /*-----------------------------------------------------------*/\r
 218 \r
 219 void vApplicationIdleHook( void )\r
 220 {\r
 221         /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set\r
 222         to 1 in FreeRTOSConfig.h.  It will be called on each iteration of the idle\r
 223         task.  It is essential that code added to this hook function never attempts\r
 224         to block in any way (for example, call xQueueReceive() with a block time\r
 225         specified, or call vTaskDelay()).  If the application makes use of the\r
 226         vTaskDelete() API function (as this demo application does) then it is also\r
 227         important that vApplicationIdleHook() is permitted to return to its calling\r
 228         function, because it is the responsibility of the idle task to clean up\r
 229         memory allocated by the kernel to any task that has since been deleted. */\r
 230 \r
 231         /* Uncomment the following code to allow the trace to be stopped with any\r
 232         key press.  The code is commented out by default as the kbhit() function\r
 233         interferes with the run time behaviour. */\r
 234         /*\r
 235                 if( _kbhit() != pdFALSE )\r
 236                 {\r
 237                         if( xTraceRunning == pdTRUE )\r
 238                         {\r
 239                                 vTraceStop();\r
 240                                 prvSaveTraceFile();\r
 241                                 xTraceRunning = pdFALSE;\r
 242                         }\r
 243                 }\r
 244         */\r
 245 \r
 246         #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY != 1 )\r
 247         {\r
 248                 /* Call the idle task processing used by the full demo.  The simple\r
 249                 blinky demo does not use the idle task hook. */\r
 250                 vFullDemoIdleFunction();\r
 251         }\r
 252         #endif\r
 253 }\r
 254 /*-----------------------------------------------------------*/\r
 255 \r
 256 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )\r
 257 {\r
 258         ( void ) pcTaskName;\r
 259         ( void ) pxTask;\r
 260 \r
 261         /* Run time stack overflow checking is performed if\r
 262         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 263         function is called if a stack overflow is detected. */\r
 264         vAssertCalled( __LINE__, __FILE__ );\r
 265 }\r
 266 /*-----------------------------------------------------------*/\r
 267 \r
 268 void vApplicationTickHook( void )\r
 269 {\r
 270         /* This function will be called by each tick interrupt if\r
 271         configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h.  User code can be\r
 272         added here, but the tick hook is called from an interrupt context, so\r
 273         code must not attempt to block, and only the interrupt safe FreeRTOS API\r
 274         functions can be used (those that end in FromISR()). */\r
 275 \r
 276         #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY != 1 )\r
 277         {\r
 278                 vFullDemoTickHookFunction();\r
 279         }\r
 280         #endif /* mainCREATE_SIMPLE_BLINKY_DEMO_ONLY */\r
 281 \r
 282         /* Write a user event to the trace log.\r
 283         Note tick events will not appear in the trace recording with regular period\r
 284         because this project runs in a Windows simulator, and does not therefore\r
 285         exhibit deterministic behaviour.  Windows will run the simulator in\r
 286         bursts. */\r
 287         vTraceUserEvent( xTickTraceUserEvent );\r
 288 }\r
 289 /*-----------------------------------------------------------*/\r
 290 \r
 291 void vAssertCalled( unsigned long ulLine, const char * const pcFileName )\r
 292 {\r
 293 static portBASE_TYPE xPrinted = pdFALSE;\r
 294 volatile uint32_t ulSetToNonZeroInDebuggerToContinue = 0;\r
 295 \r
 296         /* Parameters are not used. */\r
 297         ( void ) ulLine;\r
 298         ( void ) pcFileName;\r
 299 \r
 300         taskENTER_CRITICAL();\r
 301         {\r
 302                 /* Stop the trace recording. */\r
 303                 if( xPrinted == pdFALSE )\r
 304                 {\r
 305                         xPrinted = pdTRUE;\r
 306                         if( xTraceRunning == pdTRUE )\r
 307                         {\r
 308                                 vTraceStop();\r
 309                                 prvSaveTraceFile();\r
 310                         }\r
 311                 }\r
 312 \r
 313                 /* You can step out of this function to debug the assertion by using\r
 314                 the debugger to set ulSetToNonZeroInDebuggerToContinue to a non-zero\r
 315                 value. */\r
 316                 while( ulSetToNonZeroInDebuggerToContinue == 0 )\r
 317                 {\r
 318                         __asm{ NOP };\r
 319                         __asm{ NOP };\r
 320                 }\r
 321         }\r
 322         taskEXIT_CRITICAL();\r
 323 }\r
 324 /*-----------------------------------------------------------*/\r
 325 \r
 326 static void prvSaveTraceFile( void )\r
 327 {\r
 328 FILE* pxOutputFile;\r
 329 \r
 330         fopen_s( &pxOutputFile, "Trace.dump", "wb");\r
 331 \r
 332         if( pxOutputFile != NULL )\r
 333         {\r
 334                 fwrite( RecorderDataPtr, sizeof( RecorderDataType ), 1, pxOutputFile );\r
 335                 fclose( pxOutputFile );\r
 336                 printf( "\r\nTrace output saved to Trace.dump\r\n" );\r
 337         }\r
 338         else\r
 339         {\r
 340                 printf( "\r\nFailed to create trace dump file\r\n" );\r
 341         }\r
 342 }\r
 343 /*-----------------------------------------------------------*/\r
 344 \r
 345 static void  prvInitialiseHeap( void )\r
 346 {\r
 347 /* This demo uses heap_5.c, so start by defining some heap regions.  This is\r
 348 only done to provide an example as this demo could easily create one large heap\r
 349 region instead of multiple smaller heap regions - in which case heap_4.c would\r
 350 be the more appropriate choice.  No initialisation is required when heap_4.c is\r
 351 used.  The xHeapRegions structure requires the regions to be defined in order,\r
 352 so this just creates one big array, then populates the structure with offsets\r
 353 into the array - with gaps in between and messy alignment just for test\r
 354 purposes. */\r
 355 static uint8_t ucHeap[ configTOTAL_HEAP_SIZE ];\r
 356 volatile uint32_t ulAdditionalOffset = 19; /* Just to prevent 'condition is always true' warnings in configASSERT(). */\r
 357 const HeapRegion_t xHeapRegions[] =\r
 358 {\r
 359         /* Start address with dummy offsets                                             Size */\r
 360         { ucHeap + 1,                                                                                   mainREGION_1_SIZE },\r
 361         { ucHeap + 15 + mainREGION_1_SIZE,                                              mainREGION_2_SIZE },\r
 362         { ucHeap + 19 + mainREGION_1_SIZE + mainREGION_2_SIZE,  mainREGION_3_SIZE },\r
 363         { NULL, 0 }\r
 364 };\r
 365 \r
 366         /* Sanity check that the sizes and offsets defined actually fit into the\r
 367         array. */\r
 368         configASSERT( ( ulAdditionalOffset + mainREGION_1_SIZE + mainREGION_2_SIZE + mainREGION_3_SIZE ) < configTOTAL_HEAP_SIZE );\r
 369 \r
 370         vPortDefineHeapRegions( xHeapRegions );\r
 371 }\r
 372 \r