git.sur5r.net Git - freertos/blob - Demo/PC/main.c

   1 /*\r
   2         FreeRTOS.org V4.4.0 - Copyright (C) 2003-2007 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section \r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26         ***************************************************************************\r
  27         See http://www.FreeRTOS.org for documentation, latest information, license \r
  28         and contact details.  Please ensure to read the configuration and relevant \r
  29         port sections of the online documentation.\r
  30 \r
  31         Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along\r
  32         with commercial development and support options.\r
  33         ***************************************************************************\r
  34 */\r
  35 \r
  36 /**\r
  37  * Creates all the demo application tasks and co-routines, then starts the \r
  38  * scheduler.\r
  39  *\r
  40  * Main. c also creates a task called "Print".  This only executes every \r
  41  * five seconds but has the highest priority so is guaranteed to get \r
  42  * processor time.  Its main function is to check that all the other tasks \r
  43  * are still operational.  Nearly all the tasks in the demo application \r
  44  * maintain a unique count that is incremented each time the task successfully \r
  45  * completes its function.  Should any error occur within the task the count is \r
  46  * permanently halted.  The print task checks the count of each task to ensure \r
  47  * it has changed since the last time the print task executed.  If any count is \r
  48  * found not to have changed the print task displays an appropriate message.  \r
  49  * If all the tasks are still incrementing their unique counts the print task \r
  50  * displays an "OK" message.\r
  51  *\r
  52  * The LED flash tasks do not maintain a count as they already provide visual \r
  53  * feedback of their status.\r
  54  *\r
  55  * The print task blocks on the queue into which messages that require \r
  56  * displaying are posted.  It will therefore only block for the full 5 seconds\r
  57  * if no messages are posted onto the queue.\r
  58  *\r
  59  * Main. c also provides a demonstration of how the trace visualisation utility\r
  60  * can be used, and how the scheduler can be stopped.\r
  61  *\r
  62  * \page MainC main.c\r
  63  * \ingroup DemoFiles\r
  64  * <HR>\r
  65  */\r
  66 \r
  67 /*\r
  68 Changes from V1.00:\r
  69 \r
  70         + Prevent the call to kbhit() for debug builds as the debugger seems to\r
  71           have problems stepping over the call.\r
  72 \r
  73 Changes from V1.2.3\r
  74 \r
  75         + The integer and comtest tasks are now used when the cooperative scheduler \r
  76           is being used.  Previously they were only used with the preemptive\r
  77           scheduler.\r
  78 \r
  79 Changes from V1.2.6\r
  80 \r
  81         + Create new tasks as defined by the new demo application file dynamic.c.\r
  82 \r
  83 Changes from V2.0.0\r
  84 \r
  85         + Delay periods are now specified using variables and constants of\r
  86           portTickType rather than unsigned portLONG.\r
  87 \r
  88 Changes from V3.1.1\r
  89 \r
  90         + The tasks defined in the new file "events.c" are now created and \r
  91           monitored for errors. \r
  92 \r
  93 Changes from V3.2.4\r
  94 \r
  95         + Now includes the flash co-routine demo rather than the flash task demo.\r
  96           This is to demonstrate the co-routine functionality.\r
  97 */\r
  98 \r
  99 #include <stdlib.h>\r
 100 #include <conio.h>\r
 101 #include "FreeRTOS.h"\r
 102 #include "task.h"\r
 103 #include "croutine.h"\r
 104 #include "partest.h"\r
 105 #include "serial.h"\r
 106 \r
 107 /* Demo file headers. */\r
 108 #include "BlockQ.h"\r
 109 #include "PollQ.h"\r
 110 #include "death.h"\r
 111 #include "crflash.h"\r
 112 #include "flop.h"\r
 113 #include "print.h"\r
 114 #include "comtest.h"\r
 115 #include "fileio.h"\r
 116 #include "semtest.h"\r
 117 #include "integer.h"\r
 118 #include "dynamic.h"\r
 119 #include "mevents.h"\r
 120 #include "crhook.h"\r
 121 #include "blocktim.h"\r
 122 #include "GenQTest.h"\r
 123 #include "QPeek.h"\r
 124 \r
 125 /* Priority definitions for the tasks in the demo application. */\r
 126 #define mainLED_TASK_PRIORITY           ( tskIDLE_PRIORITY + 1 )\r
 127 #define mainCREATOR_TASK_PRIORITY       ( tskIDLE_PRIORITY + 3 )\r
 128 #define mainPRINT_TASK_PRIORITY         ( tskIDLE_PRIORITY + 4 )\r
 129 #define mainQUEUE_POLL_PRIORITY         ( tskIDLE_PRIORITY + 2 )\r
 130 #define mainQUEUE_BLOCK_PRIORITY        ( tskIDLE_PRIORITY + 3 )\r
 131 #define mainCOM_TEST_PRIORITY           ( tskIDLE_PRIORITY + 2 )\r
 132 #define mainSEMAPHORE_TASK_PRIORITY     ( tskIDLE_PRIORITY + 1 )\r
 133 #define mainGENERIC_QUEUE_PRIORITY      ( tskIDLE_PRIORITY )\r
 134 \r
 135 #define mainPRINT_STACK_SIZE            ( ( unsigned portSHORT ) 512 )\r
 136 #define mainDEBUG_LOG_BUFFER_SIZE       ( ( unsigned portSHORT ) 20480 )\r
 137 \r
 138 /* The number of flash co-routines to create. */\r
 139 #define mainNUM_FLASH_CO_ROUTINES       ( 8 )\r
 140 \r
 141 /* Task function for the "Print" task as described at the top of the file. */\r
 142 static void vErrorChecks( void *pvParameters );\r
 143 \r
 144 /* Function that checks the unique count of all the other tasks as described at\r
 145 the top of the file. */\r
 146 static void prvCheckOtherTasksAreStillRunning( void );\r
 147 \r
 148 /* Key presses can be used to start/stop the trace visualisation utility or stop\r
 149 the scheduler. */\r
 150 static void     prvCheckForKeyPresses( void );\r
 151 \r
 152 /* Buffer used by the trace visualisation utility so only needed if the trace\r
 153 being used. */\r
 154 #if configUSE_TRACE_FACILITY == 1\r
 155         static portCHAR pcWriteBuffer[ mainDEBUG_LOG_BUFFER_SIZE ];\r
 156 #endif\r
 157 \r
 158 /* Constant definition used to turn on/off the pre-emptive scheduler. */\r
 159 static const portSHORT sUsingPreemption = configUSE_PREEMPTION;\r
 160 \r
 161 /* Start the math tasks appropriate to the build.  The Borland port does\r
 162 not yet support floating point so uses the integer equivalent. */\r
 163 static void prvStartMathTasks( void );\r
 164 \r
 165 /* Check which ever tasks are relevant to this build. */\r
 166 static portBASE_TYPE prvCheckMathTasksAreStillRunning( void );\r
 167 \r
 168 /*-----------------------------------------------------------*/\r
 169 \r
 170 portSHORT main( void )\r
 171 {\r
 172         /* Initialise hardware and utilities. */\r
 173         vParTestInitialise();\r
 174         vPrintInitialise();\r
 175         \r
 176         /* CREATE ALL THE DEMO APPLICATION TASKS. */\r
 177         prvStartMathTasks();\r
 178         vStartComTestTasks( mainCOM_TEST_PRIORITY, serCOM1, ser115200 );\r
 179         vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
 180         vStartBlockingQueueTasks( mainQUEUE_BLOCK_PRIORITY );\r
 181         vCreateBlockTimeTasks();\r
 182         vStartGenericQueueTasks( mainGENERIC_QUEUE_PRIORITY );\r
 183         vStartSemaphoreTasks( mainSEMAPHORE_TASK_PRIORITY );\r
 184         vStartDynamicPriorityTasks();\r
 185         vStartMultiEventTasks();\r
 186         vStartQueuePeekTasks();\r
 187 \r
 188         /* Create the "Print" task as described at the top of the file. */\r
 189         xTaskCreate( vErrorChecks, "Print", mainPRINT_STACK_SIZE, NULL, mainPRINT_TASK_PRIORITY, NULL );\r
 190 \r
 191         /* This task has to be created last as it keeps account of the number of tasks\r
 192         it expects to see running. */\r
 193         vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 194 \r
 195         /* Create the co-routines that flash the LED's. */\r
 196         vStartFlashCoRoutines( mainNUM_FLASH_CO_ROUTINES );\r
 197 \r
 198         /* Create the co-routines that communicate with the tick hook. */\r
 199         vStartHookCoRoutines();\r
 200 \r
 201         /* Set the scheduler running.  This function will not return unless a task\r
 202         calls vTaskEndScheduler(). */\r
 203         vTaskStartScheduler();\r
 204 \r
 205         return 1;\r
 206 }\r
 207 /*-----------------------------------------------------------*/\r
 208 \r
 209 static void vErrorChecks( void *pvParameters )\r
 210 {\r
 211 portTickType xExpectedWakeTime;\r
 212 const portTickType xPrintRate = ( portTickType ) 5000 / portTICK_RATE_MS;\r
 213 const portLONG lMaxAllowableTimeDifference = ( portLONG ) 0;\r
 214 portTickType xWakeTime;\r
 215 portLONG lTimeDifference;\r
 216 const portCHAR *pcReceivedMessage;\r
 217 const portCHAR * const pcTaskBlockedTooLongMsg = "Print task blocked too long!\r\n";\r
 218 \r
 219         ( void ) pvParameters;\r
 220 \r
 221         /* Loop continuously, blocking, then checking all the other tasks are still\r
 222         running, before blocking once again.  This task blocks on the queue of\r
 223         messages that require displaying so will wake either by its time out expiring,\r
 224         or a message becoming available. */\r
 225         for( ;; )\r
 226         {\r
 227                 /* Calculate the time we will unblock if no messages are received\r
 228                 on the queue.  This is used to check that we have not blocked for too long. */\r
 229                 xExpectedWakeTime = xTaskGetTickCount();\r
 230                 xExpectedWakeTime += xPrintRate;\r
 231 \r
 232                 /* Block waiting for either a time out or a message to be posted that\r
 233                 required displaying. */\r
 234                 pcReceivedMessage = pcPrintGetNextMessage( xPrintRate );\r
 235 \r
 236                 /* Was a message received? */\r
 237                 if( pcReceivedMessage == NULL )\r
 238                 {\r
 239                         /* A message was not received so we timed out, did we unblock at the\r
 240                         expected time? */\r
 241                         xWakeTime = xTaskGetTickCount();\r
 242 \r
 243                         /* Calculate the difference between the time we unblocked and the\r
 244                         time we should have unblocked. */\r
 245                         if( xWakeTime > xExpectedWakeTime )\r
 246                         {\r
 247                                 lTimeDifference = ( portLONG ) ( xWakeTime - xExpectedWakeTime );\r
 248                         }\r
 249                         else\r
 250                         {\r
 251                                 lTimeDifference = ( portLONG ) ( xExpectedWakeTime - xWakeTime );\r
 252                         }\r
 253 \r
 254                         if( lTimeDifference > lMaxAllowableTimeDifference )\r
 255                         {\r
 256                                 /* We blocked too long - create a message that will get\r
 257                                 printed out the next time around.  If we are not using\r
 258                                 preemption then we won't expect the timing to be so\r
 259                                 accurate. */\r
 260                                 if( sUsingPreemption == pdTRUE )\r
 261                                 {\r
 262                                         vPrintDisplayMessage( &pcTaskBlockedTooLongMsg );\r
 263                                 }\r
 264                         }\r
 265 \r
 266                         /* Check the other tasks are still running, just in case. */\r
 267                         prvCheckOtherTasksAreStillRunning();\r
 268                 }\r
 269                 else\r
 270                 {\r
 271                         /* We unblocked due to a message becoming available.  Send the message\r
 272                         for printing. */\r
 273                         vDisplayMessage( pcReceivedMessage );\r
 274                 }\r
 275 \r
 276                 /* Key presses are used to invoke the trace visualisation utility, or end\r
 277                 the program. */\r
 278                 prvCheckForKeyPresses();\r
 279         }\r
 280 }\r
 281 /*-----------------------------------------------------------*/\r
 282 \r
 283 static void     prvCheckForKeyPresses( void )\r
 284 {\r
 285 portSHORT sIn;\r
 286 \r
 287         taskENTER_CRITICAL();\r
 288                 #ifdef DEBUG_BUILD\r
 289                         /* kbhit can be used in .exe's that are executed from the command\r
 290                         line, but not if executed through the debugger. */\r
 291                         sIn = 0;\r
 292                 #else\r
 293                         sIn = kbhit();\r
 294                 #endif\r
 295         taskEXIT_CRITICAL();\r
 296 \r
 297         if( sIn )\r
 298         {\r
 299                 /* Key presses can be used to start/stop the trace utility, or end the \r
 300                 program. */\r
 301                 sIn = getch();\r
 302                 switch( sIn )\r
 303                 {\r
 304                         /* Only define keys for turning on and off the trace if the trace\r
 305                         is being used. */\r
 306                         #if configUSE_TRACE_FACILITY == 1\r
 307                                 case 't' :      vTaskList( pcWriteBuffer );\r
 308                                                         vWriteMessageToDisk( pcWriteBuffer );\r
 309                                                         break;                  \r
 310                                 case 's' :      vTaskStartTrace( pcWriteBuffer, mainDEBUG_LOG_BUFFER_SIZE );\r
 311                                                         break;\r
 312 \r
 313                                 case 'e' :      {\r
 314                                                                 unsigned portLONG ulBufferLength;\r
 315                                                                 ulBufferLength = ulTaskEndTrace();\r
 316                                                                 vWriteBufferToDisk( pcWriteBuffer, ulBufferLength );\r
 317                                                         }\r
 318                                                         break;\r
 319                         #endif\r
 320 \r
 321                         default  :      vTaskEndScheduler();\r
 322                                                 break;\r
 323                 }\r
 324         }\r
 325 }\r
 326 /*-----------------------------------------------------------*/\r
 327 \r
 328 static void prvCheckOtherTasksAreStillRunning( void )\r
 329 {\r
 330 static portSHORT sErrorHasOccurred = pdFALSE;\r
 331 \r
 332         if( prvCheckMathTasksAreStillRunning() != pdTRUE )\r
 333         {\r
 334                 vDisplayMessage( "Maths task count unchanged!\r\n" );\r
 335                 sErrorHasOccurred = pdTRUE;\r
 336         }\r
 337 \r
 338         if( xAreComTestTasksStillRunning() != pdTRUE )\r
 339         {\r
 340                 vDisplayMessage( "Com test count unchanged!\r\n" );\r
 341                 sErrorHasOccurred = pdTRUE;\r
 342         }\r
 343 \r
 344         if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 345         {\r
 346                 vDisplayMessage( "Blocking queues count unchanged!\r\n" );\r
 347                 sErrorHasOccurred = pdTRUE;\r
 348         }\r
 349 \r
 350         if( xArePollingQueuesStillRunning() != pdTRUE )\r
 351         {\r
 352                 vDisplayMessage( "Polling queue count unchanged!\r\n" );\r
 353                 sErrorHasOccurred = pdTRUE;\r
 354         }\r
 355 \r
 356         if( xIsCreateTaskStillRunning() != pdTRUE )\r
 357         {\r
 358                 vDisplayMessage( "Incorrect number of tasks running!\r\n" );\r
 359                 sErrorHasOccurred = pdTRUE;\r
 360         }\r
 361 \r
 362         if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 363         {\r
 364                 vDisplayMessage( "Semaphore take count unchanged!\r\n" );\r
 365                 sErrorHasOccurred = pdTRUE;\r
 366         }\r
 367 \r
 368         if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 369         {\r
 370                 vDisplayMessage( "Dynamic priority count unchanged!\r\n" );\r
 371                 sErrorHasOccurred = pdTRUE;\r
 372         }\r
 373         \r
 374         if( xAreMultiEventTasksStillRunning() != pdTRUE )\r
 375         {\r
 376                 vDisplayMessage( "Error in multi events tasks!\r\n" );\r
 377                 sErrorHasOccurred = pdTRUE;\r
 378         }\r
 379 \r
 380         if( xAreFlashCoRoutinesStillRunning() != pdTRUE )\r
 381         {\r
 382                 vDisplayMessage( "Error in co-routine flash tasks!\r\n" );\r
 383                 sErrorHasOccurred = pdTRUE;\r
 384         }\r
 385 \r
 386         if( xAreHookCoRoutinesStillRunning() != pdTRUE )\r
 387         {\r
 388                 vDisplayMessage( "Error in tick hook to co-routine communications!\r\n" );\r
 389                 sErrorHasOccurred = pdTRUE;\r
 390         }\r
 391 \r
 392         if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 393         {\r
 394                 vDisplayMessage( "Error in block time test tasks!\r\n" );\r
 395                 sErrorHasOccurred = pdTRUE;\r
 396         }\r
 397 \r
 398         if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 399         {\r
 400                 vDisplayMessage( "Error in generic queue test task!\r\n" );\r
 401                 sErrorHasOccurred = pdTRUE;             \r
 402         }\r
 403 \r
 404         if( xAreQueuePeekTasksStillRunning() != pdTRUE )\r
 405         {\r
 406                 vDisplayMessage( "Error in queue peek test task!\r\n" );\r
 407                 sErrorHasOccurred = pdTRUE;\r
 408         }\r
 409 \r
 410         if( sErrorHasOccurred == pdFALSE )\r
 411         {\r
 412                 vDisplayMessage( "OK " );\r
 413         }\r
 414 }\r
 415 /*-----------------------------------------------------------*/\r
 416 \r
 417 static void prvStartMathTasks( void )\r
 418 {\r
 419         #ifdef BCC_INDUSTRIAL_PC_PORT\r
 420                 /* The Borland project does not yet support floating point. */\r
 421                 vStartIntegerMathTasks( tskIDLE_PRIORITY );\r
 422         #else\r
 423                 vStartMathTasks( tskIDLE_PRIORITY );\r
 424         #endif\r
 425 }\r
 426 /*-----------------------------------------------------------*/\r
 427 \r
 428 static portBASE_TYPE prvCheckMathTasksAreStillRunning( void )\r
 429 {\r
 430         #ifdef BCC_INDUSTRIAL_PC_PORT\r
 431                 /* The Borland project does not yet support floating point. */\r
 432                 return xAreIntegerMathsTaskStillRunning();\r
 433         #else\r
 434                 return xAreMathsTaskStillRunning();\r
 435         #endif\r
 436 }\r
 437 /*-----------------------------------------------------------*/\r
 438 \r
 439 void vApplicationIdleHook( void )\r
 440 {\r
 441         /* The co-routines are executed in the idle task using the idle task \r
 442         hook. */\r
 443         vCoRoutineSchedule();\r
 444 }\r
 445 /*-----------------------------------------------------------*/\r
 446 \r