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

   1 /*\r
   2     FreeRTOS V7.6.0 - Copyright (C) 2013 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 distribute\r
  28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  29     >>! the source code for proprietary components outside of the FreeRTOS\r
  30     >>! 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      1\r
 109 \r
 110 /*\r
 111  * main_blinky() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1.\r
 112  * main_full() is used when mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.\r
 113  */\r
 114 extern void main_blinky( void );\r
 115 extern void main_full( void );\r
 116 \r
 117 /* Some of the RTOS hook (callback) functions only need special processing when\r
 118 the full demo is being used.  The simply blinky demo has no special requirements,\r
 119 so these functions are called from the hook functions defined in this file, but\r
 120 are defined in main_full.c. */\r
 121 void vFullDemoTickHookFunction( void );\r
 122 void vFullDemoIdleFunction( void );\r
 123 \r
 124 /* Prototypes for the standard FreeRTOS callback/hook functions implemented\r
 125 within this file. */\r
 126 void vApplicationMallocFailedHook( void );\r
 127 void vApplicationIdleHook( void );\r
 128 void vApplicationStackOverflowHook( xTaskHandle pxTask, char *pcTaskName );\r
 129 void vApplicationTickHook( void );\r
 130 \r
 131 /*\r
 132  * Writes trace data to a disk file when the trace recording is stopped.\r
 133  * This function will simply overwrite any trace files that already exist.\r
 134  */\r
 135 static void prvSaveTraceFile( void );\r
 136 \r
 137 /* The user trace event posted to the trace recording on each tick interrupt.\r
 138 Note tick events will not appear in the trace recording with regular period\r
 139 because this project runs in a Windows simulator, and does not therefore\r
 140 exhibit deterministic behaviour. */\r
 141 traceLabel xTickTraceUserEvent;\r
 142 static portBASE_TYPE xTraceRunning = pdTRUE;\r
 143 \r
 144 /*-----------------------------------------------------------*/\r
 145 \r
 146 int main( void )\r
 147 {\r
 148         /* Initialise the trace recorder and create the label used to post user\r
 149         events to the trace recording on each tick interrupt. */\r
 150         vTraceInitTraceData();\r
 151         xTickTraceUserEvent = xTraceOpenLabel( "tick" );\r
 152 \r
 153         /* Start the trace recording - the recording is written to a file if\r
 154         configASSERT() is called. */\r
 155         printf( "\r\nTrace started.  Hit a key to dump trace file to disk (does not work from Eclipse console).\r\n" );\r
 156         fflush( stdout );\r
 157         uiTraceStart();\r
 158 \r
 159         /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top\r
 160         of this file. */\r
 161         #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1 )\r
 162         {\r
 163                 main_blinky();\r
 164         }\r
 165         #else\r
 166         {\r
 167                 main_full();\r
 168         }\r
 169         #endif\r
 170 \r
 171         return 0;\r
 172 }\r
 173 /*-----------------------------------------------------------*/\r
 174 \r
 175 void vApplicationMallocFailedHook( void )\r
 176 {\r
 177         /* vApplicationMallocFailedHook() will only be called if\r
 178         configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h.  It is a hook\r
 179         function that will get called if a call to pvPortMalloc() fails.\r
 180         pvPortMalloc() is called internally by the kernel whenever a task, queue,\r
 181         timer or semaphore is created.  It is also called by various parts of the\r
 182         demo application.  If heap_1.c or heap_2.c are used, then the size of the\r
 183         heap available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in\r
 184         FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used\r
 185         to query the size of free heap space that remains (although it does not\r
 186         provide information on how the remaining heap might be fragmented). */\r
 187         vAssertCalled( __LINE__, __FILE__ );\r
 188 }\r
 189 /*-----------------------------------------------------------*/\r
 190 \r
 191 void vApplicationIdleHook( void )\r
 192 {\r
 193         /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set\r
 194         to 1 in FreeRTOSConfig.h.  It will be called on each iteration of the idle\r
 195         task.  It is essential that code added to this hook function never attempts\r
 196         to block in any way (for example, call xQueueReceive() with a block time\r
 197         specified, or call vTaskDelay()).  If the application makes use of the\r
 198         vTaskDelete() API function (as this demo application does) then it is also\r
 199         important that vApplicationIdleHook() is permitted to return to its calling\r
 200         function, because it is the responsibility of the idle task to clean up\r
 201         memory allocated by the kernel to any task that has since been deleted. */\r
 202 \r
 203         /* The trace can be stopped with any key press. */\r
 204         if( _kbhit() != pdFALSE )\r
 205         {\r
 206                 if( xTraceRunning == pdTRUE )\r
 207                 {\r
 208                         vTraceStop();\r
 209                         prvSaveTraceFile();\r
 210                         xTraceRunning = pdFALSE;\r
 211                 }\r
 212         }\r
 213 \r
 214         #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY != 1 )\r
 215         {\r
 216                 /* Call the idle task processing used by the full demo.  The simple\r
 217                 blinky demo does not use the idle task hook. */\r
 218                 vFullDemoIdleFunction();\r
 219         }\r
 220         #endif\r
 221 }\r
 222 /*-----------------------------------------------------------*/\r
 223 \r
 224 void vApplicationStackOverflowHook( xTaskHandle pxTask, char *pcTaskName )\r
 225 {\r
 226         ( void ) pcTaskName;\r
 227         ( void ) pxTask;\r
 228 \r
 229         /* Run time stack overflow checking is performed if\r
 230         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 231         function is called if a stack overflow is detected. */\r
 232         vAssertCalled( __LINE__, __FILE__ );\r
 233 }\r
 234 /*-----------------------------------------------------------*/\r
 235 \r
 236 void vApplicationTickHook( void )\r
 237 {\r
 238         /* This function will be called by each tick interrupt if\r
 239         configUSE_TICK_HOOK is set to 1 in FreeRTOSConfig.h.  User code can be\r
 240         added here, but the tick hook is called from an interrupt context, so\r
 241         code must not attempt to block, and only the interrupt safe FreeRTOS API\r
 242         functions can be used (those that end in FromISR()). */\r
 243 \r
 244         #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY != 1 )\r
 245         {\r
 246                 vFullDemoTickHookFunction();\r
 247         }\r
 248         #endif /* mainCREATE_SIMPLE_BLINKY_DEMO_ONLY */\r
 249 \r
 250         /* Write a user event to the trace log.  \r
 251         Note tick events will not appear in the trace recording with regular period\r
 252         because this project runs in a Windows simulator, and does not therefore\r
 253         exhibit deterministic behaviour.  Windows will run the simulator in \r
 254         bursts. */\r
 255         vTraceUserEvent( xTickTraceUserEvent );\r
 256 }\r
 257 /*-----------------------------------------------------------*/\r
 258 \r
 259 void vAssertCalled( unsigned long ulLine, const char * const pcFileName )\r
 260 {\r
 261 static portBASE_TYPE xPrinted = pdFALSE;\r
 262 \r
 263         /* Parameters are not used. */\r
 264         ( void ) ulLine;\r
 265         ( void ) pcFileName;\r
 266 \r
 267         taskDISABLE_INTERRUPTS();\r
 268         __asm volatile( "int $3" );\r
 269 \r
 270         /* Stop the trace recording. */\r
 271         if( xPrinted == pdFALSE )\r
 272         {\r
 273                 xPrinted = pdTRUE;\r
 274                 if( xTraceRunning == pdTRUE )\r
 275                 {\r
 276                 vTraceStop();\r
 277                 prvSaveTraceFile();\r
 278                 }\r
 279         }\r
 280 \r
 281         taskENABLE_INTERRUPTS();\r
 282 }\r
 283 /*-----------------------------------------------------------*/\r
 284 \r
 285 static void prvSaveTraceFile( void )\r
 286 {\r
 287 FILE* pxOutputFile;\r
 288 \r
 289         pxOutputFile = fopen( "Trace.dump", "wb");\r
 290 \r
 291         if( pxOutputFile != NULL )\r
 292         {\r
 293                 fwrite( RecorderDataPtr, sizeof( RecorderDataType ), 1, pxOutputFile );\r
 294                 fclose( pxOutputFile );\r
 295                 printf( "\r\nTrace output saved to Trace.dump\r\n" );\r
 296         }\r
 297         else\r
 298         {\r
 299                 printf( "\r\nFailed to create trace dump file\r\n" );\r
 300         }\r
 301 }\r