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

   1 /*\r
   2  * FreeRTOS Kernel V10.1.0\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 /*\r
  29  *******************************************************************************\r
  30  * NOTE 1: The Win32 port is a simulation (or is that emulation?) only!  Do not\r
  31  * expect to get real time behaviour from the Win32 port or this demo\r
  32  * application.  It is provided as a convenient development and demonstration\r
  33  * test bed only.\r
  34  *\r
  35  * Windows will not be running the FreeRTOS simulator threads continuously, so\r
  36  * the timing information in the FreeRTOS+Trace logs have no meaningful units.\r
  37  * See the documentation page for the Windows simulator for an explanation of\r
  38  * the slow timing:\r
  39  * http://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html\r
  40  * - READ THE WEB DOCUMENTATION FOR THIS PORT FOR MORE INFORMATION ON USING IT -\r
  41  *\r
  42  * NOTE 2:  This project provides two demo applications.  A simple blinky style\r
  43  * project, and a more comprehensive test and demo application.  The\r
  44  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to select\r
  45  * between the two.  See the notes on using mainCREATE_SIMPLE_BLINKY_DEMO_ONLY\r
  46  * in main.c.  This file implements the comprehensive test and demo version.\r
  47  *\r
  48  * NOTE 3:  This file only contains the source code that is specific to the\r
  49  * full demo.  Generic functions, such FreeRTOS hook functions, are defined in\r
  50  * main.c.\r
  51  *******************************************************************************\r
  52  *\r
  53  * main() creates all the demo application tasks, then starts the scheduler.\r
  54  * The web documentation provides more details of the standard demo application\r
  55  * tasks, which provide no particular functionality but do provide a good\r
  56  * example of how to use the FreeRTOS API.\r
  57  *\r
  58  * In addition to the standard demo tasks, the following tasks and tests are\r
  59  * defined and/or created within this file:\r
  60  *\r
  61  * "Check" task - This only executes every five seconds but has a high priority\r
  62  * to ensure it gets processor time.  Its main function is to check that all the\r
  63  * standard demo tasks are still operational.  While no errors have been\r
  64  * discovered the check task will print out "OK" and the current simulated tick\r
  65  * time.  If an error is discovered in the execution of a task then the check\r
  66  * task will print out an appropriate error message.\r
  67  *\r
  68  */\r
  69 \r
  70 \r
  71 /* Standard includes. */\r
  72 #include <stdio.h>\r
  73 #include <stdlib.h>\r
  74 \r
  75 /* Kernel includes. */\r
  76 #include <FreeRTOS.h>\r
  77 #include <task.h>\r
  78 #include <queue.h>\r
  79 #include <timers.h>\r
  80 #include <semphr.h>\r
  81 \r
  82 /* Standard demo includes. */\r
  83 #include "BlockQ.h"\r
  84 #include "integer.h"\r
  85 #include "semtest.h"\r
  86 #include "PollQ.h"\r
  87 #include "GenQTest.h"\r
  88 #include "QPeek.h"\r
  89 #include "recmutex.h"\r
  90 #include "flop.h"\r
  91 #include "TimerDemo.h"\r
  92 #include "countsem.h"\r
  93 #include "death.h"\r
  94 #include "dynamic.h"\r
  95 #include "QueueSet.h"\r
  96 #include "QueueOverwrite.h"\r
  97 #include "EventGroupsDemo.h"\r
  98 #include "IntSemTest.h"\r
  99 #include "TaskNotify.h"\r
 100 #include "QueueSetPolling.h"\r
 101 #include "StaticAllocation.h"\r
 102 #include "blocktim.h"\r
 103 #include "AbortDelay.h"\r
 104 #include "MessageBufferDemo.h"\r
 105 #include "StreamBufferDemo.h"\r
 106 #include "StreamBufferInterrupt.h"\r
 107 #include "MessageBufferAMP.h"\r
 108 \r
 109 /* Priorities at which the tasks are created. */\r
 110 #define mainCHECK_TASK_PRIORITY                 ( configMAX_PRIORITIES - 2 )\r
 111 #define mainQUEUE_POLL_PRIORITY                 ( tskIDLE_PRIORITY + 1 )\r
 112 #define mainSEM_TEST_PRIORITY                   ( tskIDLE_PRIORITY + 1 )\r
 113 #define mainBLOCK_Q_PRIORITY                    ( tskIDLE_PRIORITY + 2 )\r
 114 #define mainCREATOR_TASK_PRIORITY               ( tskIDLE_PRIORITY + 3 )\r
 115 #define mainFLASH_TASK_PRIORITY                 ( tskIDLE_PRIORITY + 1 )\r
 116 #define mainINTEGER_TASK_PRIORITY               ( tskIDLE_PRIORITY )\r
 117 #define mainGEN_QUEUE_TASK_PRIORITY             ( tskIDLE_PRIORITY )\r
 118 #define mainFLOP_TASK_PRIORITY                  ( tskIDLE_PRIORITY )\r
 119 #define mainQUEUE_OVERWRITE_PRIORITY    ( tskIDLE_PRIORITY )\r
 120 \r
 121 #define mainTIMER_TEST_PERIOD                   ( 50 )\r
 122 \r
 123 /* Task function prototypes. */\r
 124 static void prvCheckTask( void *pvParameters );\r
 125 \r
 126 /* A task that is created from the idle task to test the functionality of\r
 127 eTaskStateGet(). */\r
 128 static void prvTestTask( void *pvParameters );\r
 129 \r
 130 /*\r
 131  * Called from the idle task hook function to demonstrate a few utility\r
 132  * functions that are not demonstrated by any of the standard demo tasks.\r
 133  */\r
 134 static void prvDemonstrateTaskStateAndHandleGetFunctions( void );\r
 135 \r
 136 /*\r
 137  * Called from the idle task hook function to demonstrate the use of\r
 138  * xTimerPendFunctionCall() as xTimerPendFunctionCall() is not demonstrated by\r
 139  * any of the standard demo tasks.\r
 140  */\r
 141 static void prvDemonstratePendingFunctionCall( void );\r
 142 \r
 143 /*\r
 144  * The function that is pended by prvDemonstratePendingFunctionCall().\r
 145  */\r
 146 static void prvPendedFunction( void *pvParameter1, uint32_t ulParameter2 );\r
 147 \r
 148 /*\r
 149  * prvDemonstrateTimerQueryFunctions() is called from the idle task hook\r
 150  * function to demonstrate the use of functions that query information about a\r
 151  * software timer.  prvTestTimerCallback() is the callback function for the\r
 152  * timer being queried.\r
 153  */\r
 154 static void prvDemonstrateTimerQueryFunctions( void );\r
 155 static void prvTestTimerCallback( TimerHandle_t xTimer );\r
 156 \r
 157 /*\r
 158  * A task to demonstrate the use of the xQueueSpacesAvailable() function.\r
 159  */\r
 160 static void prvDemoQueueSpaceFunctions( void *pvParameters );\r
 161 \r
 162 /*\r
 163  * Tasks that ensure indefinite delays are truly indefinite.\r
 164  */\r
 165 static void prvPermanentlyBlockingSemaphoreTask( void *pvParameters );\r
 166 static void prvPermanentlyBlockingNotificationTask( void *pvParameters );\r
 167 \r
 168 /*-----------------------------------------------------------*/\r
 169 \r
 170 /* The variable into which error messages are latched. */\r
 171 static char *pcStatusMessage = "No errors";\r
 172 \r
 173 /* This semaphore is created purely to test using the vSemaphoreDelete() and\r
 174 semaphore tracing API functions.  It has no other purpose. */\r
 175 static SemaphoreHandle_t xMutexToDelete = NULL;\r
 176 \r
 177 /*-----------------------------------------------------------*/\r
 178 \r
 179 int main_full( void )\r
 180 {\r
 181         /* Start the check task as described at the top of this file. */\r
 182         xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
 183 \r
 184         /* Create the standard demo tasks. */\r
 185         vStartTaskNotifyTask();\r
 186         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 187         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 188         vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
 189         vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );\r
 190         vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );\r
 191         vStartQueuePeekTasks();\r
 192         vStartMathTasks( mainFLOP_TASK_PRIORITY );\r
 193         vStartRecursiveMutexTasks();\r
 194         vStartCountingSemaphoreTasks();\r
 195         vStartDynamicPriorityTasks();\r
 196         vStartQueueSetTasks();\r
 197         vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );\r
 198         vStartEventGroupTasks();\r
 199         vStartInterruptSemaphoreTasks();\r
 200         vStartQueueSetPollingTask();\r
 201         vCreateBlockTimeTasks();\r
 202         vCreateAbortDelayTasks();\r
 203         xTaskCreate( prvDemoQueueSpaceFunctions, "QSpace", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
 204         xTaskCreate( prvPermanentlyBlockingSemaphoreTask, "BlockSem", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
 205         xTaskCreate( prvPermanentlyBlockingNotificationTask, "BlockNoti", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
 206 \r
 207         vStartMessageBufferTasks( configMINIMAL_STACK_SIZE );\r
 208         vStartStreamBufferTasks();\r
 209         vStartStreamBufferInterruptDemo();\r
 210         vStartMessageBufferAMPTasks( configMINIMAL_STACK_SIZE );\r
 211 \r
 212         #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
 213         {\r
 214                 vStartStaticallyAllocatedTasks();\r
 215         }\r
 216         #endif\r
 217 \r
 218         #if( configUSE_PREEMPTION != 0  )\r
 219         {\r
 220                 /* Don't expect these tasks to pass when preemption is not used. */\r
 221                 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );\r
 222         }\r
 223         #endif\r
 224 \r
 225         /* The suicide tasks must be created last as they need to know how many\r
 226         tasks were running prior to their creation.  This then allows them to\r
 227         ascertain whether or not the correct/expected number of tasks are running at\r
 228         any given time. */\r
 229         vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 230 \r
 231         /* Create the semaphore that will be deleted in the idle task hook.  This\r
 232         is done purely to test the use of vSemaphoreDelete(). */\r
 233         xMutexToDelete = xSemaphoreCreateMutex();\r
 234 \r
 235         /* Start the scheduler itself. */\r
 236         vTaskStartScheduler();\r
 237 \r
 238         /* Should never get here unless there was not enough heap space to create\r
 239         the idle and other system tasks. */\r
 240         return 0;\r
 241 }\r
 242 /*-----------------------------------------------------------*/\r
 243 \r
 244 static void prvCheckTask( void *pvParameters )\r
 245 {\r
 246 TickType_t xNextWakeTime;\r
 247 const TickType_t xCycleFrequency = pdMS_TO_TICKS( 2500UL );\r
 248 \r
 249         /* Just to remove compiler warning. */\r
 250         ( void ) pvParameters;\r
 251 \r
 252         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 253         xNextWakeTime = xTaskGetTickCount();\r
 254 \r
 255         for( ;; )\r
 256         {\r
 257                 /* Place this task in the blocked state until it is time to run again. */\r
 258                 vTaskDelayUntil( &xNextWakeTime, xCycleFrequency );\r
 259 \r
 260                 /* Check the standard demo tasks are running without error. */\r
 261                 #if( configUSE_PREEMPTION != 0 )\r
 262                 {\r
 263                         /* These tasks are only created when preemption is used. */\r
 264                         if( xAreTimerDemoTasksStillRunning( xCycleFrequency ) != pdTRUE )\r
 265                         {\r
 266                                 pcStatusMessage = "Error: TimerDemo";\r
 267                         }\r
 268                 }\r
 269                 #endif\r
 270 \r
 271                 if( xAreStreamBufferTasksStillRunning() != pdTRUE )\r
 272                 {\r
 273                         pcStatusMessage = "Error:  StreamBuffer";\r
 274                 }\r
 275                 else if( xAreMessageBufferTasksStillRunning() != pdTRUE )\r
 276                 {\r
 277                         pcStatusMessage = "Error:  MessageBuffer";\r
 278                 }\r
 279                 else if( xAreTaskNotificationTasksStillRunning() != pdTRUE )\r
 280                 {\r
 281                         pcStatusMessage = "Error:  Notification";\r
 282                 }\r
 283                 else if( xAreInterruptSemaphoreTasksStillRunning() != pdTRUE )\r
 284                 {\r
 285                         pcStatusMessage = "Error: IntSem";\r
 286                 }\r
 287                 else if( xAreEventGroupTasksStillRunning() != pdTRUE )\r
 288                 {\r
 289                         pcStatusMessage = "Error: EventGroup";\r
 290                 }\r
 291                 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
 292                 {\r
 293                         pcStatusMessage = "Error: IntMath";\r
 294                 }\r
 295                 else if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 296                 {\r
 297                         pcStatusMessage = "Error: GenQueue";\r
 298                 }\r
 299                 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )\r
 300                 {\r
 301                         pcStatusMessage = "Error: QueuePeek";\r
 302                 }\r
 303                 else if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 304                 {\r
 305                         pcStatusMessage = "Error: BlockQueue";\r
 306                 }\r
 307                 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 308                 {\r
 309                         pcStatusMessage = "Error: SemTest";\r
 310                 }\r
 311                 else if( xArePollingQueuesStillRunning() != pdTRUE )\r
 312                 {\r
 313                         pcStatusMessage = "Error: PollQueue";\r
 314                 }\r
 315                 else if( xAreMathsTaskStillRunning() != pdPASS )\r
 316                 {\r
 317                         pcStatusMessage = "Error: Flop";\r
 318                 }\r
 319                 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
 320                 {\r
 321                         pcStatusMessage = "Error: RecMutex";\r
 322                 }\r
 323                 else if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )\r
 324                 {\r
 325                         pcStatusMessage = "Error: CountSem";\r
 326                 }\r
 327                 else if( xIsCreateTaskStillRunning() != pdTRUE )\r
 328                 {\r
 329                         pcStatusMessage = "Error: Death";\r
 330                 }\r
 331                 else if( xAreDynamicPriorityTasksStillRunning() != pdPASS )\r
 332                 {\r
 333                         pcStatusMessage = "Error: Dynamic";\r
 334                 }\r
 335                 else if( xAreQueueSetTasksStillRunning() != pdPASS )\r
 336                 {\r
 337                         pcStatusMessage = "Error: Queue set";\r
 338                 }\r
 339                 else if( xIsQueueOverwriteTaskStillRunning() != pdPASS )\r
 340                 {\r
 341                         pcStatusMessage = "Error: Queue overwrite";\r
 342                 }\r
 343                 else if( xAreQueueSetPollTasksStillRunning() != pdPASS )\r
 344                 {\r
 345                         pcStatusMessage = "Error: Queue set polling";\r
 346                 }\r
 347                 else if( xAreBlockTimeTestTasksStillRunning() != pdPASS )\r
 348                 {\r
 349                         pcStatusMessage = "Error: Block time";\r
 350                 }\r
 351                 else if( xAreAbortDelayTestTasksStillRunning() != pdPASS )\r
 352                 {\r
 353                         pcStatusMessage = "Error: Abort delay";\r
 354                 }\r
 355                 else if( xIsInterruptStreamBufferDemoStillRunning() != pdPASS )\r
 356                 {\r
 357                         pcStatusMessage = "Error: Stream buffer interrupt";\r
 358                 }\r
 359                 else if( xAreMessageBufferAMPTasksStillRunning() != pdPASS )\r
 360                 {\r
 361                         pcStatusMessage = "Error: Message buffer AMP";\r
 362                 }\r
 363 \r
 364                 #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
 365                         else if( xAreStaticAllocationTasksStillRunning() != pdPASS )\r
 366                         {\r
 367                                 pcStatusMessage = "Error: Static allocation";\r
 368                         }\r
 369                 #endif /* configSUPPORT_STATIC_ALLOCATION */\r
 370 \r
 371                 /* This is the only task that uses stdout so its ok to call printf()\r
 372                 directly. */\r
 373                 printf( "%s - tick count %zu - free heap %zu - min free heap %zu\r\n", pcStatusMessage,\r
 374                                                                                                                                                            xTaskGetTickCount(),\r
 375                                                                                                                                                            xPortGetFreeHeapSize(),\r
 376                                                                                                                                                            xPortGetMinimumEverFreeHeapSize() );\r
 377         }\r
 378 }\r
 379 /*-----------------------------------------------------------*/\r
 380 \r
 381 static void prvTestTask( void *pvParameters )\r
 382 {\r
 383 const unsigned long ulMSToSleep = 5;\r
 384 \r
 385         /* Just to remove compiler warnings. */\r
 386         ( void ) pvParameters;\r
 387 \r
 388         /* This task is just used to test the eTaskStateGet() function.  It\r
 389         does not have anything to do. */\r
 390         for( ;; )\r
 391         {\r
 392                 /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are\r
 393                 tasks waiting to be terminated by the idle task. */\r
 394                 Sleep( ulMSToSleep );\r
 395         }\r
 396 }\r
 397 /*-----------------------------------------------------------*/\r
 398 \r
 399 /* Called from vApplicationIdleHook(), which is defined in main.c. */\r
 400 void vFullDemoIdleFunction( void )\r
 401 {\r
 402 const unsigned long ulMSToSleep = 15;\r
 403 void *pvAllocated;\r
 404 \r
 405         /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are\r
 406         tasks waiting to be terminated by the idle task. */\r
 407         Sleep( ulMSToSleep );\r
 408 \r
 409         /* Demonstrate a few utility functions that are not demonstrated by any of\r
 410         the standard demo tasks. */\r
 411         prvDemonstrateTaskStateAndHandleGetFunctions();\r
 412 \r
 413         /* Demonstrate the use of xTimerPendFunctionCall(), which is not\r
 414         demonstrated by any of the standard demo tasks. */\r
 415         prvDemonstratePendingFunctionCall();\r
 416 \r
 417         /* Demonstrate the use of functions that query information about a software\r
 418         timer. */\r
 419         prvDemonstrateTimerQueryFunctions();\r
 420 \r
 421 \r
 422         /* If xMutexToDelete has not already been deleted, then delete it now.\r
 423         This is done purely to demonstrate the use of, and test, the\r
 424         vSemaphoreDelete() macro.  Care must be taken not to delete a semaphore\r
 425         that has tasks blocked on it. */\r
 426         if( xMutexToDelete != NULL )\r
 427         {\r
 428                 /* For test purposes, add the mutex to the registry, then remove it\r
 429                 again, before it is deleted - checking its name is as expected before\r
 430                 and after the assertion into the registry and its removal from the\r
 431                 registry. */\r
 432                 configASSERT( pcQueueGetName( xMutexToDelete ) == NULL );\r
 433                 vQueueAddToRegistry( xMutexToDelete, "Test_Mutex" );\r
 434                 configASSERT( strcmp( pcQueueGetName( xMutexToDelete ), "Test_Mutex" ) == 0 );\r
 435                 vQueueUnregisterQueue( xMutexToDelete );\r
 436                 configASSERT( pcQueueGetName( xMutexToDelete ) == NULL );\r
 437 \r
 438                 vSemaphoreDelete( xMutexToDelete );\r
 439                 xMutexToDelete = NULL;\r
 440         }\r
 441 \r
 442         /* Exercise heap_5 a bit.  The malloc failed hook will trap failed\r
 443         allocations so there is no need to test here. */\r
 444         pvAllocated = pvPortMalloc( ( rand() % 500 ) + 1 );\r
 445         vPortFree( pvAllocated );\r
 446 }\r
 447 /*-----------------------------------------------------------*/\r
 448 \r
 449 /* Called by vApplicationTickHook(), which is defined in main.c. */\r
 450 void vFullDemoTickHookFunction( void )\r
 451 {\r
 452 TaskHandle_t xTimerTask;\r
 453 \r
 454         /* Call the periodic timer test, which tests the timer API functions that\r
 455         can be called from an ISR. */\r
 456         #if( configUSE_PREEMPTION != 0 )\r
 457         {\r
 458                 /* Only created when preemption is used. */\r
 459                 vTimerPeriodicISRTests();\r
 460         }\r
 461         #endif\r
 462 \r
 463         /* Call the periodic queue overwrite from ISR demo. */\r
 464         vQueueOverwritePeriodicISRDemo();\r
 465 \r
 466         /* Write to a queue that is in use as part of the queue set demo to\r
 467         demonstrate using queue sets from an ISR. */\r
 468         vQueueSetAccessQueueSetFromISR();\r
 469         vQueueSetPollingInterruptAccess();\r
 470 \r
 471         /* Exercise event groups from interrupts. */\r
 472         vPeriodicEventGroupsProcessing();\r
 473 \r
 474         /* Exercise giving mutexes from an interrupt. */\r
 475         vInterruptSemaphorePeriodicTest();\r
 476 \r
 477         /* Exercise using task notifications from an interrupt. */\r
 478         xNotifyTaskFromISR();\r
 479 \r
 480         /* Writes to stream buffer byte by byte to test the stream buffer trigger\r
 481         level functionality. */\r
 482         vPeriodicStreamBufferProcessing();\r
 483 \r
 484         /* Writes a string to a string buffer four bytes at a time to demonstrate\r
 485         a stream being sent from an interrupt to a task. */\r
 486         vBasicStreamBufferSendFromISR();\r
 487 \r
 488         /* For code coverage purposes. */\r
 489         xTimerTask = xTimerGetTimerDaemonTaskHandle();\r
 490         configASSERT( uxTaskPriorityGetFromISR( xTimerTask ) == configTIMER_TASK_PRIORITY );\r
 491 }\r
 492 /*-----------------------------------------------------------*/\r
 493 \r
 494 static void prvPendedFunction( void *pvParameter1, uint32_t ulParameter2 )\r
 495 {\r
 496 static uint32_t ulLastParameter1 = 1000UL, ulLastParameter2 = 0UL;\r
 497 uint32_t ulParameter1;\r
 498 \r
 499         ulParameter1 = ( uint32_t ) pvParameter1;\r
 500 \r
 501         /* Ensure the parameters are as expected. */\r
 502         configASSERT( ulParameter1 == ( ulLastParameter1 + 1 ) );\r
 503         configASSERT( ulParameter2 == ( ulLastParameter2 + 1 ) );\r
 504 \r
 505         /* Remember the parameters for the next time the function is called. */\r
 506         ulLastParameter1 = ulParameter1;\r
 507         ulLastParameter2 = ulParameter2;\r
 508 }\r
 509 /*-----------------------------------------------------------*/\r
 510 \r
 511 static void prvTestTimerCallback( TimerHandle_t xTimer )\r
 512 {\r
 513         /* This is the callback function for the timer accessed by\r
 514         prvDemonstrateTimerQueryFunctions().  The callback does not do anything. */\r
 515         ( void ) xTimer;\r
 516 }\r
 517 /*-----------------------------------------------------------*/\r
 518 \r
 519 static void prvDemonstrateTimerQueryFunctions( void )\r
 520 {\r
 521 static TimerHandle_t xTimer = NULL;\r
 522 const char *pcTimerName = "TestTimer";\r
 523 volatile TickType_t xExpiryTime;\r
 524 const TickType_t xDontBlock = 0;\r
 525 \r
 526         if( xTimer == NULL )\r
 527         {\r
 528                 xTimer = xTimerCreate( pcTimerName, portMAX_DELAY, pdTRUE, NULL, prvTestTimerCallback );\r
 529 \r
 530                 if( xTimer != NULL )\r
 531                 {\r
 532                         /* Called from the idle task so a block time must not be\r
 533                         specified. */\r
 534                         xTimerStart( xTimer, xDontBlock );\r
 535                 }\r
 536         }\r
 537 \r
 538         if( xTimer != NULL )\r
 539         {\r
 540                 /* Demonstrate querying a timer's name. */\r
 541                 configASSERT( strcmp( pcTimerGetName( xTimer ), pcTimerName ) == 0 );\r
 542 \r
 543                 /* Demonstrate querying a timer's period. */\r
 544                 configASSERT( xTimerGetPeriod( xTimer ) == portMAX_DELAY );\r
 545 \r
 546                 /* Demonstrate querying a timer's next expiry time, although nothing is\r
 547                 done with the returned value.  Note if the expiry time is less than the\r
 548                 maximum tick count then the expiry time has overflowed from the current\r
 549                 time.  In this case the expiry time was set to portMAX_DELAY, so it is\r
 550                 expected to be less than the current time until the current time has\r
 551                 itself overflowed. */\r
 552                 xExpiryTime = xTimerGetExpiryTime( xTimer );\r
 553                 ( void ) xExpiryTime;\r
 554         }\r
 555 }\r
 556 /*-----------------------------------------------------------*/\r
 557 \r
 558 static void prvDemonstratePendingFunctionCall( void )\r
 559 {\r
 560 static uint32_t ulParameter1 = 1000UL, ulParameter2 = 0UL;\r
 561 const TickType_t xDontBlock = 0; /* This is called from the idle task so must *not* attempt to block. */\r
 562 \r
 563         /* prvPendedFunction() just expects the parameters to be incremented by one\r
 564         each time it is called. */\r
 565         ulParameter1++;\r
 566         ulParameter2++;\r
 567 \r
 568         /* Pend the function call, sending the parameters. */\r
 569         xTimerPendFunctionCall( prvPendedFunction, ( void * ) ulParameter1, ulParameter2, xDontBlock );\r
 570 }\r
 571 /*-----------------------------------------------------------*/\r
 572 \r
 573 static void prvDemonstrateTaskStateAndHandleGetFunctions( void )\r
 574 {\r
 575 TaskHandle_t xIdleTaskHandle, xTimerTaskHandle;\r
 576 char *pcTaskName;\r
 577 static portBASE_TYPE xPerformedOneShotTests = pdFALSE;\r
 578 TaskHandle_t xTestTask;\r
 579 TaskStatus_t xTaskInfo;\r
 580 extern StackType_t uxTimerTaskStack[];\r
 581 \r
 582         /* Demonstrate the use of the xTimerGetTimerDaemonTaskHandle() and\r
 583         xTaskGetIdleTaskHandle() functions.  Also try using the function that sets\r
 584         the task number. */\r
 585         xIdleTaskHandle = xTaskGetIdleTaskHandle();\r
 586         xTimerTaskHandle = xTimerGetTimerDaemonTaskHandle();\r
 587 \r
 588         /* This is the idle hook, so the current task handle should equal the\r
 589         returned idle task handle. */\r
 590         if( xTaskGetCurrentTaskHandle() != xIdleTaskHandle )\r
 591         {\r
 592                 pcStatusMessage = "Error:  Returned idle task handle was incorrect";\r
 593         }\r
 594 \r
 595         /* Check the same handle is obtained using the idle task's name.  First try\r
 596         with the wrong name, then the right name. */\r
 597         if( xTaskGetHandle( "Idle" ) == xIdleTaskHandle )\r
 598         {\r
 599                 pcStatusMessage = "Error:  Returned handle for name Idle was incorrect";\r
 600         }\r
 601 \r
 602         if( xTaskGetHandle( "IDLE" ) != xIdleTaskHandle )\r
 603         {\r
 604                 pcStatusMessage = "Error:  Returned handle for name Idle was incorrect";\r
 605         }\r
 606 \r
 607         /* Check the timer task handle was returned correctly. */\r
 608         pcTaskName = pcTaskGetName( xTimerTaskHandle );\r
 609         if( strcmp( pcTaskName, "Tmr Svc" ) != 0 )\r
 610         {\r
 611                 pcStatusMessage = "Error:  Returned timer task handle was incorrect";\r
 612         }\r
 613 \r
 614         if( xTaskGetHandle( "Tmr Svc" ) != xTimerTaskHandle )\r
 615         {\r
 616                 pcStatusMessage = "Error:  Returned handle for name Tmr Svc was incorrect";\r
 617         }\r
 618 \r
 619         /* This task is running, make sure it's state is returned as running. */\r
 620         if( eTaskStateGet( xIdleTaskHandle ) != eRunning )\r
 621         {\r
 622                 pcStatusMessage = "Error:  Returned idle task state was incorrect";\r
 623         }\r
 624 \r
 625         /* If this task is running, then the timer task must be blocked. */\r
 626         if( eTaskStateGet( xTimerTaskHandle ) != eBlocked )\r
 627         {\r
 628                 pcStatusMessage = "Error:  Returned timer task state was incorrect";\r
 629         }\r
 630 \r
 631         /* Also with the vTaskGetInfo() function. */\r
 632         vTaskGetInfo( xTimerTaskHandle, /* The task being queried. */\r
 633                                           &xTaskInfo,           /* The structure into which information on the task will be written. */\r
 634                                           pdTRUE,                       /* Include the task's high watermark in the structure. */\r
 635                                           eInvalid );           /* Include the task state in the structure. */\r
 636 \r
 637         /* Check the information returned by vTaskGetInfo() is as expected. */\r
 638         if( ( xTaskInfo.eCurrentState != eBlocked )                                              ||\r
 639                 ( strcmp( xTaskInfo.pcTaskName, "Tmr Svc" ) != 0 )                       ||\r
 640                 ( xTaskInfo.uxCurrentPriority != configTIMER_TASK_PRIORITY ) ||\r
 641                 ( xTaskInfo.pxStackBase != uxTimerTaskStack )                            ||\r
 642                 ( xTaskInfo.xHandle != xTimerTaskHandle ) )\r
 643         {\r
 644                 pcStatusMessage = "Error:  vTaskGetInfo() returned incorrect information about the timer task";\r
 645         }\r
 646 \r
 647         /* Other tests that should only be performed once follow.  The test task\r
 648         is not created on each iteration because to do so would cause the death\r
 649         task to report an error (too many tasks running). */\r
 650         if( xPerformedOneShotTests == pdFALSE )\r
 651         {\r
 652                 /* Don't run this part of the test again. */\r
 653                 xPerformedOneShotTests = pdTRUE;\r
 654 \r
 655                 /* Create a test task to use to test other eTaskStateGet() return values. */\r
 656                 if( xTaskCreate( prvTestTask, "Test", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, &xTestTask ) == pdPASS )\r
 657                 {\r
 658                         /* If this task is running, the test task must be in the ready state. */\r
 659                         if( eTaskStateGet( xTestTask ) != eReady )\r
 660                         {\r
 661                                 pcStatusMessage = "Error: Returned test task state was incorrect 1";\r
 662                         }\r
 663 \r
 664                         /* Now suspend the test task and check its state is reported correctly. */\r
 665                         vTaskSuspend( xTestTask );\r
 666                         if( eTaskStateGet( xTestTask ) != eSuspended )\r
 667                         {\r
 668                                 pcStatusMessage = "Error: Returned test task state was incorrect 2";\r
 669                         }\r
 670 \r
 671                         /* Now delete the task and check its state is reported correctly. */\r
 672                         vTaskDelete( xTestTask );\r
 673                         if( eTaskStateGet( xTestTask ) != eDeleted )\r
 674                         {\r
 675                                 pcStatusMessage = "Error: Returned test task state was incorrect 3";\r
 676                         }\r
 677                 }\r
 678         }\r
 679 }\r
 680 /*-----------------------------------------------------------*/\r
 681 \r
 682 static void prvDemoQueueSpaceFunctions( void *pvParameters )\r
 683 {\r
 684 QueueHandle_t xQueue = NULL;\r
 685 const unsigned portBASE_TYPE uxQueueLength = 10;\r
 686 unsigned portBASE_TYPE uxReturn, x;\r
 687 \r
 688         /* Remove compiler warnings. */\r
 689         ( void ) pvParameters;\r
 690 \r
 691         /* Create the queue that will be used.  Nothing is actually going to be\r
 692         sent or received so the queue item size is set to 0. */\r
 693         xQueue = xQueueCreate( uxQueueLength, 0 );\r
 694         configASSERT( xQueue );\r
 695 \r
 696         for( ;; )\r
 697         {\r
 698                 for( x = 0; x < uxQueueLength; x++ )\r
 699                 {\r
 700                         /* Ask how many messages are available... */\r
 701                         uxReturn = uxQueueMessagesWaiting( xQueue );\r
 702 \r
 703                         /* Check the number of messages being reported as being available\r
 704                         is as expected, and force an assert if not. */\r
 705                         if( uxReturn != x )\r
 706                         {\r
 707                                 /* xQueue cannot be NULL so this is deliberately causing an\r
 708                                 assert to be triggered as there is an error. */\r
 709                                 configASSERT( xQueue == NULL );\r
 710                         }\r
 711 \r
 712                         /* Ask how many spaces remain in the queue... */\r
 713                         uxReturn = uxQueueSpacesAvailable( xQueue );\r
 714 \r
 715                         /* Check the number of spaces being reported as being available\r
 716                         is as expected, and force an assert if not. */\r
 717                         if( uxReturn != ( uxQueueLength - x ) )\r
 718                         {\r
 719                                 /* xQueue cannot be NULL so this is deliberately causing an\r
 720                                 assert to be triggered as there is an error. */\r
 721                                 configASSERT( xQueue == NULL );\r
 722                         }\r
 723 \r
 724                         /* Fill one more space in the queue. */\r
 725                         xQueueSendToBack( xQueue, NULL, 0 );\r
 726                 }\r
 727 \r
 728                 /* Perform the same check while the queue is full. */\r
 729                 uxReturn = uxQueueMessagesWaiting( xQueue );\r
 730                 if( uxReturn != uxQueueLength )\r
 731                 {\r
 732                         configASSERT( xQueue == NULL );\r
 733                 }\r
 734 \r
 735                 uxReturn = uxQueueSpacesAvailable( xQueue );\r
 736 \r
 737                 if( uxReturn != 0 )\r
 738                 {\r
 739                         configASSERT( xQueue == NULL );\r
 740                 }\r
 741 \r
 742                 /* The queue is full, start again. */\r
 743                 xQueueReset( xQueue );\r
 744 \r
 745                 #if( configUSE_PREEMPTION == 0 )\r
 746                         taskYIELD();\r
 747                 #endif\r
 748         }\r
 749 }\r
 750 /*-----------------------------------------------------------*/\r
 751 \r
 752 static void prvPermanentlyBlockingSemaphoreTask( void *pvParameters )\r
 753 {\r
 754 SemaphoreHandle_t xSemaphore;\r
 755 \r
 756         /* Prevent compiler warning about unused parameter in the case that\r
 757         configASSERT() is not defined. */\r
 758         ( void ) pvParameters;\r
 759 \r
 760         /* This task should block on a semaphore, and never return. */\r
 761         xSemaphore = xSemaphoreCreateBinary();\r
 762         configASSERT( xSemaphore );\r
 763 \r
 764         xSemaphoreTake( xSemaphore, portMAX_DELAY );\r
 765 \r
 766         /* The above xSemaphoreTake() call should never return, force an assert if\r
 767         it does. */\r
 768         configASSERT( pvParameters != NULL );\r
 769         vTaskDelete( NULL );\r
 770 }\r
 771 /*-----------------------------------------------------------*/\r
 772 \r
 773 static void prvPermanentlyBlockingNotificationTask( void *pvParameters )\r
 774 {\r
 775         /* Prevent compiler warning about unused parameter in the case that\r
 776         configASSERT() is not defined. */\r
 777         ( void ) pvParameters;\r
 778 \r
 779         /* This task should block on a task notification, and never return. */\r
 780         ulTaskNotifyTake( pdTRUE, portMAX_DELAY );\r
 781 \r
 782         /* The above ulTaskNotifyTake() call should never return, force an assert\r
 783         if it does. */\r
 784         configASSERT( pvParameters != NULL );\r
 785         vTaskDelete( NULL );\r
 786 }\r
 787 \r
 788 \r
 789 \r