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

   1 /*\r
   2  * FreeRTOS Kernel V10.2.1\r
   3  * Copyright (C) 2019 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( 5000UL );\r
 248 HeapStats_t xHeapStats;\r
 249 \r
 250         /* Just to remove compiler warning. */\r
 251         ( void ) pvParameters;\r
 252 \r
 253         /* Initialise xNextWakeTime - this only needs to be done once. */\r
 254         xNextWakeTime = xTaskGetTickCount();\r
 255 \r
 256         for( ;; )\r
 257         {\r
 258                 /* Place this task in the blocked state until it is time to run again. */\r
 259                 vTaskDelayUntil( &xNextWakeTime, xCycleFrequency );\r
 260 \r
 261                 /* Check the standard demo tasks are running without error. */\r
 262                 #if( configUSE_PREEMPTION != 0 )\r
 263                 {\r
 264                         /* These tasks are only created when preemption is used. */\r
 265                         if( xAreTimerDemoTasksStillRunning( xCycleFrequency ) != pdTRUE )\r
 266                         {\r
 267                                 pcStatusMessage = "Error: TimerDemo";\r
 268                         }\r
 269                 }\r
 270                 #endif\r
 271 \r
 272                 if( xAreStreamBufferTasksStillRunning() != pdTRUE )\r
 273                 {\r
 274                         pcStatusMessage = "Error:  StreamBuffer";\r
 275                 }\r
 276                 else if( xAreMessageBufferTasksStillRunning() != pdTRUE )\r
 277                 {\r
 278                         pcStatusMessage = "Error:  MessageBuffer";\r
 279                 }\r
 280                 else if( xAreTaskNotificationTasksStillRunning() != pdTRUE )\r
 281                 {\r
 282                         pcStatusMessage = "Error:  Notification";\r
 283                 }\r
 284                 else if( xAreInterruptSemaphoreTasksStillRunning() != pdTRUE )\r
 285                 {\r
 286                         pcStatusMessage = "Error: IntSem";\r
 287                 }\r
 288                 else if( xAreEventGroupTasksStillRunning() != pdTRUE )\r
 289                 {\r
 290                         pcStatusMessage = "Error: EventGroup";\r
 291                 }\r
 292                 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
 293                 {\r
 294                         pcStatusMessage = "Error: IntMath";\r
 295                 }\r
 296                 else if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 297                 {\r
 298                         pcStatusMessage = "Error: GenQueue";\r
 299                 }\r
 300                 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )\r
 301                 {\r
 302                         pcStatusMessage = "Error: QueuePeek";\r
 303                 }\r
 304                 else if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 305                 {\r
 306                         pcStatusMessage = "Error: BlockQueue";\r
 307                 }\r
 308                 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 309                 {\r
 310                         pcStatusMessage = "Error: SemTest";\r
 311                 }\r
 312                 else if( xArePollingQueuesStillRunning() != pdTRUE )\r
 313                 {\r
 314                         pcStatusMessage = "Error: PollQueue";\r
 315                 }\r
 316                 else if( xAreMathsTaskStillRunning() != pdPASS )\r
 317                 {\r
 318                         pcStatusMessage = "Error: Flop";\r
 319                 }\r
 320                 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
 321                 {\r
 322                         pcStatusMessage = "Error: RecMutex";\r
 323                 }\r
 324                 else if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )\r
 325                 {\r
 326                         pcStatusMessage = "Error: CountSem";\r
 327                 }\r
 328                 else if( xIsCreateTaskStillRunning() != pdTRUE )\r
 329                 {\r
 330                         pcStatusMessage = "Error: Death";\r
 331                 }\r
 332                 else if( xAreDynamicPriorityTasksStillRunning() != pdPASS )\r
 333                 {\r
 334                         pcStatusMessage = "Error: Dynamic";\r
 335                 }\r
 336                 else if( xAreQueueSetTasksStillRunning() != pdPASS )\r
 337                 {\r
 338                         pcStatusMessage = "Error: Queue set";\r
 339                 }\r
 340                 else if( xIsQueueOverwriteTaskStillRunning() != pdPASS )\r
 341                 {\r
 342                         pcStatusMessage = "Error: Queue overwrite";\r
 343                 }\r
 344                 else if( xAreQueueSetPollTasksStillRunning() != pdPASS )\r
 345                 {\r
 346                         pcStatusMessage = "Error: Queue set polling";\r
 347                 }\r
 348                 else if( xAreBlockTimeTestTasksStillRunning() != pdPASS )\r
 349                 {\r
 350                         pcStatusMessage = "Error: Block time";\r
 351                 }\r
 352                 else if( xAreAbortDelayTestTasksStillRunning() != pdPASS )\r
 353                 {\r
 354                         pcStatusMessage = "Error: Abort delay";\r
 355                 }\r
 356                 else if( xIsInterruptStreamBufferDemoStillRunning() != pdPASS )\r
 357                 {\r
 358                         pcStatusMessage = "Error: Stream buffer interrupt";\r
 359                 }\r
 360                 else if( xAreMessageBufferAMPTasksStillRunning() != pdPASS )\r
 361                 {\r
 362                         pcStatusMessage = "Error: Message buffer AMP";\r
 363                 }\r
 364 \r
 365                 #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
 366                         else if( xAreStaticAllocationTasksStillRunning() != pdPASS )\r
 367                         {\r
 368                                 pcStatusMessage = "Error: Static allocation";\r
 369                         }\r
 370                 #endif /* configSUPPORT_STATIC_ALLOCATION */\r
 371 \r
 372                 /* This is the only task that uses stdout so its ok to call printf()\r
 373                 directly. */\r
 374                 vPortGetHeapStats( &xHeapStats );\r
 375 \r
 376                 configASSERT( xHeapStats.xAvailableHeapSpaceInBytes == xPortGetFreeHeapSize() );\r
 377                 configASSERT( xHeapStats.xMinimumEverFreeBytesRemaining == xPortGetMinimumEverFreeHeapSize() );\r
 378 \r
 379                 printf( "%s - tick count %zu - free heap %zu - min free heap %zu - largest free block %zu \r\n",\r
 380                         pcStatusMessage,\r
 381                         xTaskGetTickCount(),\r
 382                         xHeapStats.xAvailableHeapSpaceInBytes,\r
 383                         xHeapStats.xMinimumEverFreeBytesRemaining,\r
 384                         xHeapStats.xSizeOfLargestFreeBlockInBytes );\r
 385         }\r
 386 }\r
 387 /*-----------------------------------------------------------*/\r
 388 \r
 389 static void prvTestTask( void *pvParameters )\r
 390 {\r
 391 const unsigned long ulMSToSleep = 5;\r
 392 \r
 393         /* Just to remove compiler warnings. */\r
 394         ( void ) pvParameters;\r
 395 \r
 396         /* This task is just used to test the eTaskStateGet() function.  It\r
 397         does not have anything to do. */\r
 398         for( ;; )\r
 399         {\r
 400                 /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are\r
 401                 tasks waiting to be terminated by the idle task. */\r
 402                 Sleep( ulMSToSleep );\r
 403         }\r
 404 }\r
 405 /*-----------------------------------------------------------*/\r
 406 \r
 407 /* Called from vApplicationIdleHook(), which is defined in main.c. */\r
 408 void vFullDemoIdleFunction( void )\r
 409 {\r
 410 const unsigned long ulMSToSleep = 15;\r
 411 void *pvAllocated;\r
 412 \r
 413         /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are\r
 414         tasks waiting to be terminated by the idle task. */\r
 415         Sleep( ulMSToSleep );\r
 416 \r
 417         /* Demonstrate a few utility functions that are not demonstrated by any of\r
 418         the standard demo tasks. */\r
 419         prvDemonstrateTaskStateAndHandleGetFunctions();\r
 420 \r
 421         /* Demonstrate the use of xTimerPendFunctionCall(), which is not\r
 422         demonstrated by any of the standard demo tasks. */\r
 423         prvDemonstratePendingFunctionCall();\r
 424 \r
 425         /* Demonstrate the use of functions that query information about a software\r
 426         timer. */\r
 427         prvDemonstrateTimerQueryFunctions();\r
 428 \r
 429 \r
 430         /* If xMutexToDelete has not already been deleted, then delete it now.\r
 431         This is done purely to demonstrate the use of, and test, the\r
 432         vSemaphoreDelete() macro.  Care must be taken not to delete a semaphore\r
 433         that has tasks blocked on it. */\r
 434         if( xMutexToDelete != NULL )\r
 435         {\r
 436                 /* For test purposes, add the mutex to the registry, then remove it\r
 437                 again, before it is deleted - checking its name is as expected before\r
 438                 and after the assertion into the registry and its removal from the\r
 439                 registry. */\r
 440                 configASSERT( pcQueueGetName( xMutexToDelete ) == NULL );\r
 441                 vQueueAddToRegistry( xMutexToDelete, "Test_Mutex" );\r
 442                 configASSERT( strcmp( pcQueueGetName( xMutexToDelete ), "Test_Mutex" ) == 0 );\r
 443                 vQueueUnregisterQueue( xMutexToDelete );\r
 444                 configASSERT( pcQueueGetName( xMutexToDelete ) == NULL );\r
 445 \r
 446                 vSemaphoreDelete( xMutexToDelete );\r
 447                 xMutexToDelete = NULL;\r
 448         }\r
 449 \r
 450         /* Exercise heap_5 a bit.  The malloc failed hook will trap failed\r
 451         allocations so there is no need to test here. */\r
 452         pvAllocated = pvPortMalloc( ( rand() % 500 ) + 1 );\r
 453         vPortFree( pvAllocated );\r
 454 }\r
 455 /*-----------------------------------------------------------*/\r
 456 \r
 457 /* Called by vApplicationTickHook(), which is defined in main.c. */\r
 458 void vFullDemoTickHookFunction( void )\r
 459 {\r
 460 TaskHandle_t xTimerTask;\r
 461 \r
 462         /* Call the periodic timer test, which tests the timer API functions that\r
 463         can be called from an ISR. */\r
 464         #if( configUSE_PREEMPTION != 0 )\r
 465         {\r
 466                 /* Only created when preemption is used. */\r
 467                 vTimerPeriodicISRTests();\r
 468         }\r
 469         #endif\r
 470 \r
 471         /* Call the periodic queue overwrite from ISR demo. */\r
 472         vQueueOverwritePeriodicISRDemo();\r
 473 \r
 474         /* Write to a queue that is in use as part of the queue set demo to\r
 475         demonstrate using queue sets from an ISR. */\r
 476         vQueueSetAccessQueueSetFromISR();\r
 477         vQueueSetPollingInterruptAccess();\r
 478 \r
 479         /* Exercise event groups from interrupts. */\r
 480         vPeriodicEventGroupsProcessing();\r
 481 \r
 482         /* Exercise giving mutexes from an interrupt. */\r
 483         vInterruptSemaphorePeriodicTest();\r
 484 \r
 485         /* Exercise using task notifications from an interrupt. */\r
 486         xNotifyTaskFromISR();\r
 487 \r
 488         /* Writes to stream buffer byte by byte to test the stream buffer trigger\r
 489         level functionality. */\r
 490         vPeriodicStreamBufferProcessing();\r
 491 \r
 492         /* Writes a string to a string buffer four bytes at a time to demonstrate\r
 493         a stream being sent from an interrupt to a task. */\r
 494         vBasicStreamBufferSendFromISR();\r
 495 \r
 496         /* For code coverage purposes. */\r
 497         xTimerTask = xTimerGetTimerDaemonTaskHandle();\r
 498         configASSERT( uxTaskPriorityGetFromISR( xTimerTask ) == configTIMER_TASK_PRIORITY );\r
 499 }\r
 500 /*-----------------------------------------------------------*/\r
 501 \r
 502 static void prvPendedFunction( void *pvParameter1, uint32_t ulParameter2 )\r
 503 {\r
 504 static uint32_t ulLastParameter1 = 1000UL, ulLastParameter2 = 0UL;\r
 505 uint32_t ulParameter1;\r
 506 \r
 507         ulParameter1 = ( uint32_t ) pvParameter1;\r
 508 \r
 509         /* Ensure the parameters are as expected. */\r
 510         configASSERT( ulParameter1 == ( ulLastParameter1 + 1 ) );\r
 511         configASSERT( ulParameter2 == ( ulLastParameter2 + 1 ) );\r
 512 \r
 513         /* Remember the parameters for the next time the function is called. */\r
 514         ulLastParameter1 = ulParameter1;\r
 515         ulLastParameter2 = ulParameter2;\r
 516 }\r
 517 /*-----------------------------------------------------------*/\r
 518 \r
 519 static void prvTestTimerCallback( TimerHandle_t xTimer )\r
 520 {\r
 521         /* This is the callback function for the timer accessed by\r
 522         prvDemonstrateTimerQueryFunctions().  The callback does not do anything. */\r
 523         ( void ) xTimer;\r
 524 }\r
 525 /*-----------------------------------------------------------*/\r
 526 \r
 527 static void prvDemonstrateTimerQueryFunctions( void )\r
 528 {\r
 529 static TimerHandle_t xTimer = NULL;\r
 530 const char *pcTimerName = "TestTimer";\r
 531 volatile TickType_t xExpiryTime;\r
 532 const TickType_t xDontBlock = 0;\r
 533 \r
 534         if( xTimer == NULL )\r
 535         {\r
 536                 xTimer = xTimerCreate( pcTimerName, portMAX_DELAY, pdTRUE, NULL, prvTestTimerCallback );\r
 537 \r
 538                 if( xTimer != NULL )\r
 539                 {\r
 540                         /* Called from the idle task so a block time must not be\r
 541                         specified. */\r
 542                         xTimerStart( xTimer, xDontBlock );\r
 543                 }\r
 544         }\r
 545 \r
 546         if( xTimer != NULL )\r
 547         {\r
 548                 /* Demonstrate querying a timer's name. */\r
 549                 configASSERT( strcmp( pcTimerGetName( xTimer ), pcTimerName ) == 0 );\r
 550 \r
 551                 /* Demonstrate querying a timer's period. */\r
 552                 configASSERT( xTimerGetPeriod( xTimer ) == portMAX_DELAY );\r
 553 \r
 554                 /* Demonstrate querying a timer's next expiry time, although nothing is\r
 555                 done with the returned value.  Note if the expiry time is less than the\r
 556                 maximum tick count then the expiry time has overflowed from the current\r
 557                 time.  In this case the expiry time was set to portMAX_DELAY, so it is\r
 558                 expected to be less than the current time until the current time has\r
 559                 itself overflowed. */\r
 560                 xExpiryTime = xTimerGetExpiryTime( xTimer );\r
 561                 ( void ) xExpiryTime;\r
 562         }\r
 563 }\r
 564 /*-----------------------------------------------------------*/\r
 565 \r
 566 static void prvDemonstratePendingFunctionCall( void )\r
 567 {\r
 568 static uint32_t ulParameter1 = 1000UL, ulParameter2 = 0UL;\r
 569 const TickType_t xDontBlock = 0; /* This is called from the idle task so must *not* attempt to block. */\r
 570 \r
 571         /* prvPendedFunction() just expects the parameters to be incremented by one\r
 572         each time it is called. */\r
 573         ulParameter1++;\r
 574         ulParameter2++;\r
 575 \r
 576         /* Pend the function call, sending the parameters. */\r
 577         xTimerPendFunctionCall( prvPendedFunction, ( void * ) ulParameter1, ulParameter2, xDontBlock );\r
 578 }\r
 579 /*-----------------------------------------------------------*/\r
 580 \r
 581 static void prvDemonstrateTaskStateAndHandleGetFunctions( void )\r
 582 {\r
 583 TaskHandle_t xIdleTaskHandle, xTimerTaskHandle;\r
 584 char *pcTaskName;\r
 585 static portBASE_TYPE xPerformedOneShotTests = pdFALSE;\r
 586 TaskHandle_t xTestTask;\r
 587 TaskStatus_t xTaskInfo;\r
 588 extern StackType_t uxTimerTaskStack[];\r
 589 \r
 590         /* Demonstrate the use of the xTimerGetTimerDaemonTaskHandle() and\r
 591         xTaskGetIdleTaskHandle() functions.  Also try using the function that sets\r
 592         the task number. */\r
 593         xIdleTaskHandle = xTaskGetIdleTaskHandle();\r
 594         xTimerTaskHandle = xTimerGetTimerDaemonTaskHandle();\r
 595 \r
 596         /* This is the idle hook, so the current task handle should equal the\r
 597         returned idle task handle. */\r
 598         if( xTaskGetCurrentTaskHandle() != xIdleTaskHandle )\r
 599         {\r
 600                 pcStatusMessage = "Error:  Returned idle task handle was incorrect";\r
 601         }\r
 602 \r
 603         /* Check the same handle is obtained using the idle task's name.  First try\r
 604         with the wrong name, then the right name. */\r
 605         if( xTaskGetHandle( "Idle" ) == xIdleTaskHandle )\r
 606         {\r
 607                 pcStatusMessage = "Error:  Returned handle for name Idle was incorrect";\r
 608         }\r
 609 \r
 610         if( xTaskGetHandle( "IDLE" ) != xIdleTaskHandle )\r
 611         {\r
 612                 pcStatusMessage = "Error:  Returned handle for name Idle was incorrect";\r
 613         }\r
 614 \r
 615         /* Check the timer task handle was returned correctly. */\r
 616         pcTaskName = pcTaskGetName( xTimerTaskHandle );\r
 617         if( strcmp( pcTaskName, "Tmr Svc" ) != 0 )\r
 618         {\r
 619                 pcStatusMessage = "Error:  Returned timer task handle was incorrect";\r
 620         }\r
 621 \r
 622         if( xTaskGetHandle( "Tmr Svc" ) != xTimerTaskHandle )\r
 623         {\r
 624                 pcStatusMessage = "Error:  Returned handle for name Tmr Svc was incorrect";\r
 625         }\r
 626 \r
 627         /* This task is running, make sure it's state is returned as running. */\r
 628         if( eTaskStateGet( xIdleTaskHandle ) != eRunning )\r
 629         {\r
 630                 pcStatusMessage = "Error:  Returned idle task state was incorrect";\r
 631         }\r
 632 \r
 633         /* If this task is running, then the timer task must be blocked. */\r
 634         if( eTaskStateGet( xTimerTaskHandle ) != eBlocked )\r
 635         {\r
 636                 pcStatusMessage = "Error:  Returned timer task state was incorrect";\r
 637         }\r
 638 \r
 639         /* Also with the vTaskGetInfo() function. */\r
 640         vTaskGetInfo( xTimerTaskHandle, /* The task being queried. */\r
 641                                           &xTaskInfo,           /* The structure into which information on the task will be written. */\r
 642                                           pdTRUE,                       /* Include the task's high watermark in the structure. */\r
 643                                           eInvalid );           /* Include the task state in the structure. */\r
 644 \r
 645         /* Check the information returned by vTaskGetInfo() is as expected. */\r
 646         if( ( xTaskInfo.eCurrentState != eBlocked )                                              ||\r
 647                 ( strcmp( xTaskInfo.pcTaskName, "Tmr Svc" ) != 0 )                       ||\r
 648                 ( xTaskInfo.uxCurrentPriority != configTIMER_TASK_PRIORITY ) ||\r
 649                 ( xTaskInfo.pxStackBase != uxTimerTaskStack )                            ||\r
 650                 ( xTaskInfo.xHandle != xTimerTaskHandle ) )\r
 651         {\r
 652                 pcStatusMessage = "Error:  vTaskGetInfo() returned incorrect information about the timer task";\r
 653         }\r
 654 \r
 655         /* Other tests that should only be performed once follow.  The test task\r
 656         is not created on each iteration because to do so would cause the death\r
 657         task to report an error (too many tasks running). */\r
 658         if( xPerformedOneShotTests == pdFALSE )\r
 659         {\r
 660                 /* Don't run this part of the test again. */\r
 661                 xPerformedOneShotTests = pdTRUE;\r
 662 \r
 663                 /* Create a test task to use to test other eTaskStateGet() return values. */\r
 664                 if( xTaskCreate( prvTestTask, "Test", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, &xTestTask ) == pdPASS )\r
 665                 {\r
 666                         /* If this task is running, the test task must be in the ready state. */\r
 667                         if( eTaskStateGet( xTestTask ) != eReady )\r
 668                         {\r
 669                                 pcStatusMessage = "Error: Returned test task state was incorrect 1";\r
 670                         }\r
 671 \r
 672                         /* Now suspend the test task and check its state is reported correctly. */\r
 673                         vTaskSuspend( xTestTask );\r
 674                         if( eTaskStateGet( xTestTask ) != eSuspended )\r
 675                         {\r
 676                                 pcStatusMessage = "Error: Returned test task state was incorrect 2";\r
 677                         }\r
 678 \r
 679                         /* Now delete the task and check its state is reported correctly. */\r
 680                         vTaskDelete( xTestTask );\r
 681                         if( eTaskStateGet( xTestTask ) != eDeleted )\r
 682                         {\r
 683                                 pcStatusMessage = "Error: Returned test task state was incorrect 3";\r
 684                         }\r
 685                 }\r
 686         }\r
 687 }\r
 688 /*-----------------------------------------------------------*/\r
 689 \r
 690 static void prvDemoQueueSpaceFunctions( void *pvParameters )\r
 691 {\r
 692 QueueHandle_t xQueue = NULL;\r
 693 const unsigned portBASE_TYPE uxQueueLength = 10;\r
 694 unsigned portBASE_TYPE uxReturn, x;\r
 695 \r
 696         /* Remove compiler warnings. */\r
 697         ( void ) pvParameters;\r
 698 \r
 699         /* Create the queue that will be used.  Nothing is actually going to be\r
 700         sent or received so the queue item size is set to 0. */\r
 701         xQueue = xQueueCreate( uxQueueLength, 0 );\r
 702         configASSERT( xQueue );\r
 703 \r
 704         for( ;; )\r
 705         {\r
 706                 for( x = 0; x < uxQueueLength; x++ )\r
 707                 {\r
 708                         /* Ask how many messages are available... */\r
 709                         uxReturn = uxQueueMessagesWaiting( xQueue );\r
 710 \r
 711                         /* Check the number of messages being reported as being available\r
 712                         is as expected, and force an assert if not. */\r
 713                         if( uxReturn != x )\r
 714                         {\r
 715                                 /* xQueue cannot be NULL so this is deliberately causing an\r
 716                                 assert to be triggered as there is an error. */\r
 717                                 configASSERT( xQueue == NULL );\r
 718                         }\r
 719 \r
 720                         /* Ask how many spaces remain in the queue... */\r
 721                         uxReturn = uxQueueSpacesAvailable( xQueue );\r
 722 \r
 723                         /* Check the number of spaces being reported as being available\r
 724                         is as expected, and force an assert if not. */\r
 725                         if( uxReturn != ( uxQueueLength - x ) )\r
 726                         {\r
 727                                 /* xQueue cannot be NULL so this is deliberately causing an\r
 728                                 assert to be triggered as there is an error. */\r
 729                                 configASSERT( xQueue == NULL );\r
 730                         }\r
 731 \r
 732                         /* Fill one more space in the queue. */\r
 733                         xQueueSendToBack( xQueue, NULL, 0 );\r
 734                 }\r
 735 \r
 736                 /* Perform the same check while the queue is full. */\r
 737                 uxReturn = uxQueueMessagesWaiting( xQueue );\r
 738                 if( uxReturn != uxQueueLength )\r
 739                 {\r
 740                         configASSERT( xQueue == NULL );\r
 741                 }\r
 742 \r
 743                 uxReturn = uxQueueSpacesAvailable( xQueue );\r
 744 \r
 745                 if( uxReturn != 0 )\r
 746                 {\r
 747                         configASSERT( xQueue == NULL );\r
 748                 }\r
 749 \r
 750                 /* The queue is full, start again. */\r
 751                 xQueueReset( xQueue );\r
 752 \r
 753                 #if( configUSE_PREEMPTION == 0 )\r
 754                         taskYIELD();\r
 755                 #endif\r
 756         }\r
 757 }\r
 758 /*-----------------------------------------------------------*/\r
 759 \r
 760 static void prvPermanentlyBlockingSemaphoreTask( void *pvParameters )\r
 761 {\r
 762 SemaphoreHandle_t xSemaphore;\r
 763 \r
 764         /* Prevent compiler warning about unused parameter in the case that\r
 765         configASSERT() is not defined. */\r
 766         ( void ) pvParameters;\r
 767 \r
 768         /* This task should block on a semaphore, and never return. */\r
 769         xSemaphore = xSemaphoreCreateBinary();\r
 770         configASSERT( xSemaphore );\r
 771 \r
 772         xSemaphoreTake( xSemaphore, portMAX_DELAY );\r
 773 \r
 774         /* The above xSemaphoreTake() call should never return, force an assert if\r
 775         it does. */\r
 776         configASSERT( pvParameters != NULL );\r
 777         vTaskDelete( NULL );\r
 778 }\r
 779 /*-----------------------------------------------------------*/\r
 780 \r
 781 static void prvPermanentlyBlockingNotificationTask( void *pvParameters )\r
 782 {\r
 783         /* Prevent compiler warning about unused parameter in the case that\r
 784         configASSERT() is not defined. */\r
 785         ( void ) pvParameters;\r
 786 \r
 787         /* This task should block on a task notification, and never return. */\r
 788         ulTaskNotifyTake( pdTRUE, portMAX_DELAY );\r
 789 \r
 790         /* The above ulTaskNotifyTake() call should never return, force an assert\r
 791         if it does. */\r
 792         configASSERT( pvParameters != NULL );\r
 793         vTaskDelete( NULL );\r
 794 }\r
 795 \r
 796 \r
 797 \r