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

   1 /*\r
   2     FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT \r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  33     distribute a combined work that includes FreeRTOS without being obliged to\r
  34     provide the source code for proprietary components outside of the FreeRTOS\r
  35     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  36     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  37     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  38     more details. You should have received a copy of the GNU General Public\r
  39     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  40     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  41     by writing to Richard Barry, contact details for whom are available on the\r
  42     FreeRTOS WEB site.\r
  43 \r
  44     1 tab == 4 spaces!\r
  45     \r
  46     ***************************************************************************\r
  47      *                                                                       *\r
  48      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  49      *    not run, what could be wrong?"                                     *\r
  50      *                                                                       *\r
  51      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  52      *                                                                       *\r
  53     ***************************************************************************\r
  54 \r
  55     \r
  56     http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
  57     and contact details.  \r
  58     \r
  59     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  60     including FreeRTOS+Trace - an indispensable productivity tool.\r
  61 \r
  62     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  63     the code with commercial support, indemnification, and middleware, under \r
  64     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  65     provide a safety engineered and independently SIL3 certified version under \r
  66     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  67 */\r
  68 \r
  69 /*\r
  70  *******************************************************************************\r
  71  * -NOTE- The Win32 port is a simulation (or is that emulation?) only!  Do not\r
  72  * expect to get real time behaviour from the Win32 port or this demo\r
  73  * application.  It is provided as a convenient development and demonstration\r
  74  * test bed only.  This was tested using Windows XP on a dual core laptop.\r
  75  *\r
  76  * - READ THE WEB DOCUMENTATION FOR THIS PORT FOR MORE INFORMATION ON USING IT -\r
  77  *******************************************************************************\r
  78  *\r
  79  * main() creates all the demo application tasks, then starts the scheduler.  \r
  80  * The web documentation provides more details of the standard demo application \r
  81  * tasks, which provide no particular functionality but do provide a good \r
  82  * example of how to use the FreeRTOS API.\r
  83  *\r
  84  * In addition to the standard demo tasks, the following tasks and tests are\r
  85  * defined and/or created within this file:\r
  86  *\r
  87  * "Check" task - This only executes every five seconds but has a high priority\r
  88  * to ensure it gets processor time.  Its main function is to check that all the\r
  89  * standard demo tasks are still operational.  While no errors have been\r
  90  * discovered the check task will print out "OK" and the current simulated tick\r
  91  * time.  If an error is discovered in the execution of a task then the check\r
  92  * task will print out an appropriate error message.\r
  93  *\r
  94  */\r
  95 \r
  96 \r
  97 /* Standard includes. */\r
  98 #include <stdio.h>\r
  99 \r
 100 /* Kernel includes. */\r
 101 #include <FreeRTOS.h>\r
 102 #include "task.h"\r
 103 #include "queue.h"\r
 104 #include "timers.h"\r
 105 #include "semphr.h"\r
 106 \r
 107 /* Standard demo includes. */\r
 108 #include "BlockQ.h"\r
 109 #include "integer.h"\r
 110 #include "semtest.h"\r
 111 #include "PollQ.h"\r
 112 #include "GenQTest.h"\r
 113 #include "QPeek.h"\r
 114 #include "recmutex.h"\r
 115 #include "flop.h"\r
 116 #include "TimerDemo.h"\r
 117 #include "countsem.h"\r
 118 #include "death.h"\r
 119 #include "dynamic.h"\r
 120 #include "QueueSet.h"\r
 121 \r
 122 /* Priorities at which the tasks are created. */\r
 123 #define mainCHECK_TASK_PRIORITY                 ( configMAX_PRIORITIES - 1 )\r
 124 #define mainQUEUE_POLL_PRIORITY                 ( tskIDLE_PRIORITY + 1 )\r
 125 #define mainSEM_TEST_PRIORITY                   ( tskIDLE_PRIORITY + 1 )\r
 126 #define mainBLOCK_Q_PRIORITY                    ( tskIDLE_PRIORITY + 2 )\r
 127 #define mainCREATOR_TASK_PRIORITY               ( tskIDLE_PRIORITY + 3 )\r
 128 #define mainFLASH_TASK_PRIORITY                 ( tskIDLE_PRIORITY + 1 )\r
 129 #define mainuIP_TASK_PRIORITY                   ( tskIDLE_PRIORITY + 2 )\r
 130 #define mainINTEGER_TASK_PRIORITY               ( tskIDLE_PRIORITY )\r
 131 #define mainGEN_QUEUE_TASK_PRIORITY             ( tskIDLE_PRIORITY )\r
 132 #define mainFLOP_TASK_PRIORITY                  ( tskIDLE_PRIORITY )\r
 133 \r
 134 #define mainTIMER_TEST_PERIOD                   ( 50 )\r
 135 \r
 136 /* Task function prototypes. */\r
 137 static void prvCheckTask( void *pvParameters );\r
 138 \r
 139 /* A task that is created from the idle task to test the functionality of \r
 140 eTaskStateGet(). */\r
 141 static void prvTestTask( void *pvParameters );\r
 142 \r
 143 /* The variable into which error messages are latched. */\r
 144 static char *pcStatusMessage = "OK";\r
 145 \r
 146 /* This semaphore is created purely to test using the vSemaphoreDelete() and\r
 147 semaphore tracing API functions.  It has no other purpose. */\r
 148 static xSemaphoreHandle xMutexToDelete = NULL;\r
 149 \r
 150 /*-----------------------------------------------------------*/\r
 151 \r
 152 int main( void )\r
 153 {\r
 154         /* Start the check task as described at the top of this file. */\r
 155         xTaskCreate( prvCheckTask, ( signed char * ) "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
 156 \r
 157         /* Create the standard demo tasks. */\r
 158         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 159         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 160         vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
 161         vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );\r
 162         vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );\r
 163         vStartQueuePeekTasks();\r
 164         vStartMathTasks( mainFLOP_TASK_PRIORITY );\r
 165         vStartRecursiveMutexTasks();\r
 166         vStartTimerDemoTask( mainTIMER_TEST_PERIOD );\r
 167         vStartCountingSemaphoreTasks();\r
 168         vStartDynamicPriorityTasks();\r
 169         vStartQueueSetTasks();\r
 170 \r
 171         /* The suicide tasks must be created last as they need to know how many\r
 172         tasks were running prior to their creation.  This then allows them to \r
 173         ascertain whether or not the correct/expected number of tasks are running at \r
 174         any given time. */\r
 175         vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 176 \r
 177         /* Create the semaphore that will be deleted in the idle task hook.  This\r
 178         is done purely to test the use of vSemaphoreDelete(). */\r
 179         xMutexToDelete = xSemaphoreCreateMutex();\r
 180 \r
 181         /* Start the scheduler itself. */\r
 182         vTaskStartScheduler();\r
 183 \r
 184     /* Should never get here unless there was not enough heap space to create \r
 185         the idle and other system tasks. */\r
 186     return 0;\r
 187 }\r
 188 /*-----------------------------------------------------------*/\r
 189 \r
 190 static void prvCheckTask( void *pvParameters )\r
 191 {\r
 192 portTickType xNextWakeTime;\r
 193 const portTickType xCycleFrequency = 1000 / portTICK_RATE_MS;\r
 194 \r
 195         /* Just to remove compiler warning. */\r
 196         ( void ) pvParameters;\r
 197 \r
 198         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 199         xNextWakeTime = xTaskGetTickCount();\r
 200 \r
 201         for( ;; )\r
 202         {\r
 203                 /* Place this task in the blocked state until it is time to run again. */\r
 204                 vTaskDelayUntil( &xNextWakeTime, xCycleFrequency );\r
 205 \r
 206                 /* Check the standard demo tasks are running without error. */\r
 207                 if( xAreTimerDemoTasksStillRunning( xCycleFrequency ) != pdTRUE )\r
 208                 {\r
 209                         pcStatusMessage = "Error: TimerDemo";\r
 210                 }\r
 211             else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
 212             {\r
 213                         pcStatusMessage = "Error: IntMath";\r
 214             }   \r
 215                 else if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 216                 {                       \r
 217                         pcStatusMessage = "Error: GenQueue";\r
 218                 }\r
 219                 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )\r
 220                 {\r
 221                         pcStatusMessage = "Error: QueuePeek";\r
 222                 }\r
 223                 else if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 224                 {\r
 225                         pcStatusMessage = "Error: BlockQueue";\r
 226                 }\r
 227             else if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 228             {\r
 229                         pcStatusMessage = "Error: SemTest";\r
 230             }\r
 231             else if( xArePollingQueuesStillRunning() != pdTRUE )\r
 232             {\r
 233                         pcStatusMessage = "Error: PollQueue";\r
 234             }\r
 235                 else if( xAreMathsTaskStillRunning() != pdPASS )\r
 236                 {\r
 237                         pcStatusMessage = "Error: Flop";\r
 238                 }\r
 239             else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
 240             {\r
 241                         pcStatusMessage = "Error: RecMutex";\r
 242                 }\r
 243                 else if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )\r
 244                 {\r
 245                         pcStatusMessage = "Error: CountSem";\r
 246                 }\r
 247                 else if( xIsCreateTaskStillRunning() != pdTRUE )\r
 248                 {\r
 249                         pcStatusMessage = "Error: Death";\r
 250                 }\r
 251                 else if( xAreDynamicPriorityTasksStillRunning() != pdPASS )\r
 252                 {\r
 253                         pcStatusMessage = "Error: Dynamic\r\n";\r
 254                 }\r
 255                 else if( xAreQueueSetTasksStillRunning() != pdPASS )\r
 256                 {\r
 257                         pcStatusMessage = "Error: Queue set\r\n";\r
 258                 }\r
 259 \r
 260                 /* This is the only task that uses stdout so its ok to call printf() \r
 261                 directly. */\r
 262                 printf( "%s - %d\r\n", pcStatusMessage, xTaskGetTickCount() );\r
 263         }\r
 264 }\r
 265 /*-----------------------------------------------------------*/\r
 266 \r
 267 static void prvTestTask( void *pvParameters )\r
 268 {\r
 269 const unsigned long ulMSToSleep = 5;\r
 270 \r
 271         /* Just to remove compiler warnings. */\r
 272         ( void ) pvParameters;\r
 273 \r
 274         /* This task is just used to test the eTaskStateGet() function.  It\r
 275         does not have anything to do. */\r
 276         for( ;; )\r
 277         {\r
 278                 /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are\r
 279                 tasks waiting to be terminated by the idle task. */\r
 280                 Sleep( ulMSToSleep );\r
 281         }\r
 282 }\r
 283 /*-----------------------------------------------------------*/\r
 284 \r
 285 void vApplicationIdleHook( void )\r
 286 {\r
 287 const unsigned long ulMSToSleep = 15;\r
 288 xTaskHandle xIdleTaskHandle, xTimerTaskHandle, xTestTask;\r
 289 signed char *pcTaskName;\r
 290 const unsigned char ucConstQueueNumber = 0xaaU, ucConstTaskNumber = 0x55U;\r
 291 \r
 292 /* These three functions are only meant for use by trace code, and not for\r
 293 direct use from application code, hence their prototypes are not in queue.h. */\r
 294 extern void vQueueSetQueueNumber( xQueueHandle pxQueue, unsigned char ucQueueNumber );\r
 295 extern unsigned char ucQueueGetQueueNumber( xQueueHandle pxQueue );\r
 296 extern unsigned char ucQueueGetQueueType( xQueueHandle pxQueue );\r
 297 extern void vTaskSetTaskNumber( xTaskHandle xTask, unsigned portBASE_TYPE uxHandle );\r
 298 extern unsigned portBASE_TYPE uxTaskGetTaskNumber( xTaskHandle xTask );\r
 299 \r
 300         /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are\r
 301         tasks waiting to be terminated by the idle task. */\r
 302         Sleep( ulMSToSleep );\r
 303 \r
 304         /* Demonstrate the use of the xTimerGetTimerDaemonTaskHandle() and \r
 305         xTaskGetIdleTaskHandle() functions.  Also try using the function that sets\r
 306         the task number. */\r
 307         xIdleTaskHandle = xTaskGetIdleTaskHandle();\r
 308         xTimerTaskHandle = xTimerGetTimerDaemonTaskHandle();\r
 309         vTaskSetTaskNumber( xIdleTaskHandle, ( unsigned long ) ucConstTaskNumber );\r
 310         configASSERT( uxTaskGetTaskNumber( xIdleTaskHandle ) == ucConstTaskNumber );\r
 311 \r
 312         /* This is the idle hook, so the current task handle should equal the \r
 313         returned idle task handle. */\r
 314         if( xTaskGetCurrentTaskHandle() != xIdleTaskHandle )\r
 315         {\r
 316                 pcStatusMessage = "Error:  Returned idle task handle was incorrect";\r
 317         }\r
 318 \r
 319         /* Check the timer task handle was returned correctly. */\r
 320         pcTaskName = pcTaskGetTaskName( xTimerTaskHandle );\r
 321         if( strcmp( pcTaskName, "Tmr Svc" ) != 0 )\r
 322         {\r
 323                 pcStatusMessage = "Error:  Returned timer task handle was incorrect";\r
 324         }\r
 325 \r
 326         /* This task is running, make sure its state is returned as running. */\r
 327         if( eTaskStateGet( xIdleTaskHandle ) != eRunning )\r
 328         {\r
 329                 pcStatusMessage = "Error:  Returned idle task state was incorrect";\r
 330         }\r
 331 \r
 332         /* If this task is running, then the timer task must be blocked. */\r
 333         if( eTaskStateGet( xTimerTaskHandle ) != eBlocked )\r
 334         {\r
 335                 pcStatusMessage = "Error:  Returned timer task state was incorrect";\r
 336         }\r
 337 \r
 338         /* If xMutexToDelete has not already been deleted, then delete it now.\r
 339         This is done purely to demonstrate the use of, and test, the \r
 340         vSemaphoreDelete() macro.  Care must be taken not to delete a semaphore\r
 341         that has tasks blocked on it. */\r
 342         if( xMutexToDelete != NULL )\r
 343         {\r
 344                 /* Before deleting the semaphore, test the function used to set its\r
 345                 number.  This would normally only be done from trace software, rather\r
 346                 than application code. */\r
 347                 vQueueSetQueueNumber( xMutexToDelete, ucConstQueueNumber );\r
 348 \r
 349                 /* Before deleting the semaphore, test the functions used to get its\r
 350                 type and number.  Again, these would normally only be done from trace\r
 351                 software, rather than application code. */\r
 352                 configASSERT( ucQueueGetQueueNumber( xMutexToDelete ) == ucConstQueueNumber );\r
 353                 configASSERT( ucQueueGetQueueType( xMutexToDelete ) == queueQUEUE_TYPE_MUTEX );\r
 354                 vSemaphoreDelete( xMutexToDelete );\r
 355                 xMutexToDelete = NULL;\r
 356 \r
 357                 /* Other tests that should only be performed once follow.  The test task\r
 358                 is not created on each iteration because to do so would cause the death\r
 359                 task to report an error (too many tasks running). */\r
 360 \r
 361                 /* Create a test task to use to test other eTaskStateGet() return values. */\r
 362                 if( xTaskCreate( prvTestTask, "Test", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, &xTestTask ) == pdPASS )\r
 363                 {\r
 364                         /* If this task is running, the test task must be in the ready state. */\r
 365                         if( eTaskStateGet( xTestTask ) != eReady )\r
 366                         {\r
 367                                 pcStatusMessage = "Error: Returned test task state was incorrect 1";\r
 368                         }\r
 369 \r
 370                         /* Now suspend the test task and check its state is reported correctly. */\r
 371                         vTaskSuspend( xTestTask );\r
 372                         if( eTaskStateGet( xTestTask ) != eSuspended )\r
 373                         {\r
 374                                 pcStatusMessage = "Error: Returned test task state was incorrect 2";\r
 375                         }\r
 376 \r
 377                         /* Now delete the task and check its state is reported correctly. */\r
 378                         vTaskDelete( xTestTask );\r
 379                         if( eTaskStateGet( xTestTask ) != eDeleted )\r
 380                         {\r
 381                                 pcStatusMessage = "Error: Returned test task state was incorrect 3";\r
 382                         }\r
 383                 }\r
 384 \r
 385         }\r
 386 }\r
 387 /*-----------------------------------------------------------*/\r
 388 \r
 389 void vApplicationMallocFailedHook( void )\r
 390 {\r
 391         /* Can be implemented if required, but probably not required in this \r
 392         environment and running this demo. */\r
 393 }\r
 394 /*-----------------------------------------------------------*/\r
 395 \r
 396 void vApplicationStackOverflowHook( void )\r
 397 {\r
 398         /* Can be implemented if required, but not required in this \r
 399         environment and running this demo. */\r
 400 }\r
 401 /*-----------------------------------------------------------*/\r
 402 \r
 403 void vApplicationTickHook( void )\r
 404 {\r
 405         /* Call the periodic timer test, which tests the timer API functions that\r
 406         can be called from an ISR. */\r
 407         vTimerPeriodicISRTests();\r
 408 \r
 409         /* Write to a queue that is in use as part of the queue set demo to \r
 410         demonstrate using queue sets from an ISR. */\r
 411         vQueueSetWriteToQueueFromISR();\r
 412 }\r
 413 /*-----------------------------------------------------------*/\r
 414 \r
 415 void vAssertCalled( void )\r
 416 {\r
 417         taskDISABLE_INTERRUPTS();\r
 418         for( ;; );\r
 419 }\r
 420 \r