git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M7_STM32F7_STM32756G-EVAL_IAR_Keil/Full_Demo/main_full.c

   1 /*\r
   2  * FreeRTOS Kernel V10.3.0\r
   3  * Copyright (C) 2020 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  * NOTE 1:  This project provides two demo applications.  A simple blinky style\r
  30  * project, and a more comprehensive test and demo application.  The\r
  31  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to select\r
  32  * between the two.  See the notes on using mainCREATE_SIMPLE_BLINKY_DEMO_ONLY\r
  33  * in main.c.  This file implements the comprehensive test and demo version.\r
  34  *\r
  35  * NOTE 2:  This file only contains the source code that is specific to the\r
  36  * full demo.  Generic functions, such FreeRTOS hook functions, and functions\r
  37  * required to configure the hardware, are defined in main.c.\r
  38  *\r
  39  ******************************************************************************\r
  40  *\r
  41  * main_full() creates all the demo application tasks and software timers, then\r
  42  * starts the scheduler.  The web documentation provides more details of the\r
  43  * standard demo application tasks, which provide no particular functionality,\r
  44  * but do provide a good example of how to use the FreeRTOS API.\r
  45  *\r
  46  * "Reg test" tasks - These fill both the core and floating point registers with\r
  47  * known values, then check that each register maintains its expected value for\r
  48  * the lifetime of the task.  Each task uses a different set of values.  The reg\r
  49  * test tasks execute with a very low priority, so get preempted very\r
  50  * frequently.  A register containing an unexpected value is indicative of an\r
  51  * error in the context switching mechanism.\r
  52  *\r
  53  * "Check" task - The check task period is initially set to three seconds.  The\r
  54  * task checks that all the standard demo tasks, and the register check tasks,\r
  55  * are not only still executing, but are executing without reporting any errors.\r
  56  * If the check task discovers that a task has either stalled, or reported an\r
  57  * error, then it changes its own execution period from the initial three\r
  58  * seconds, to just 200ms.  The check task also toggles an LED each time it is\r
  59  * called.  This provides a visual indication of the system status:  If the LED\r
  60  * toggles every three seconds, then no issues have been discovered.  If the LED\r
  61  * toggles every 200ms, then an issue has been discovered with at least one\r
  62  * task.\r
  63  */\r
  64 \r
  65 /* Standard includes. */\r
  66 #include <stdio.h>\r
  67 \r
  68 /* Kernel includes. */\r
  69 #include "FreeRTOS.h"\r
  70 #include "task.h"\r
  71 #include "timers.h"\r
  72 #include "semphr.h"\r
  73 \r
  74 /* Standard demo application includes. */\r
  75 #include "flop.h"\r
  76 #include "semtest.h"\r
  77 #include "dynamic.h"\r
  78 #include "BlockQ.h"\r
  79 #include "blocktim.h"\r
  80 #include "countsem.h"\r
  81 #include "GenQTest.h"\r
  82 #include "recmutex.h"\r
  83 #include "death.h"\r
  84 #include "partest.h"\r
  85 #include "TimerDemo.h"\r
  86 #include "QueueOverwrite.h"\r
  87 #include "IntQueue.h"\r
  88 #include "EventGroupsDemo.h"\r
  89 #include "IntSemTest.h"\r
  90 #include "QueueSet.h"\r
  91 #include "TaskNotify.h"\r
  92 \r
  93 /* Priorities for the demo application tasks. */\r
  94 #define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 1UL )\r
  95 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2UL )\r
  96 #define mainCREATOR_TASK_PRIORITY                       ( tskIDLE_PRIORITY + 3UL )\r
  97 #define mainFLOP_TASK_PRIORITY                          ( tskIDLE_PRIORITY )\r
  98 #define mainCDC_COMMAND_CONSOLE_STACK_SIZE      ( configMINIMAL_STACK_SIZE * 2UL )\r
  99 #define mainCOM_TEST_TASK_PRIORITY                      ( tskIDLE_PRIORITY + 2 )\r
 100 #define mainCHECK_TASK_PRIORITY                         ( configMAX_PRIORITIES - 1 )\r
 101 #define mainQUEUE_OVERWRITE_PRIORITY            ( tskIDLE_PRIORITY )\r
 102 \r
 103 /* The initial priority used by the UART command console task. */\r
 104 #define mainUART_COMMAND_CONSOLE_TASK_PRIORITY  ( configMAX_PRIORITIES - 2 )\r
 105 \r
 106 /* A block time of zero simply means "don't block". */\r
 107 #define mainDONT_BLOCK                                          ( 0UL )\r
 108 \r
 109 /* The period of the check task, in ms, provided no errors have been reported by\r
 110 any of the standard demo tasks.  ms are converted to the equivalent in ticks\r
 111 using the pdMS_TO_TICKS() macro constant. */\r
 112 #define mainNO_ERROR_CHECK_TASK_PERIOD          pdMS_TO_TICKS( 3000UL )\r
 113 \r
 114 /* The period of the check task, in ms, if an error has been reported in one of\r
 115 the standard demo tasks.  ms are converted to the equivalent in ticks using the\r
 116 pdMS_TO_TICKS() macro. */\r
 117 #define mainERROR_CHECK_TASK_PERIOD             pdMS_TO_TICKS( 200UL )\r
 118 \r
 119 /* Parameters that are passed into the register check tasks solely for the\r
 120 purpose of ensuring parameters are passed into tasks correctly. */\r
 121 #define mainREG_TEST_TASK_1_PARAMETER           ( ( void * ) 0x12345678 )\r
 122 #define mainREG_TEST_TASK_2_PARAMETER           ( ( void * ) 0x87654321 )\r
 123 \r
 124 /* The base period used by the timer test tasks. */\r
 125 #define mainTIMER_TEST_PERIOD                           ( 50 )\r
 126 \r
 127 /* The LED is used to show the demo status.  (not connected on Rev A hardware) */\r
 128 #define mainTOGGLE_LED()        HAL_GPIO_TogglePin( GPIOF, GPIO_PIN_10 )\r
 129 \r
 130 /*-----------------------------------------------------------*/\r
 131 \r
 132 /*\r
 133  * Called by main() to run the full demo (as opposed to the blinky demo) when\r
 134  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.\r
 135  */\r
 136 void main_full( void );\r
 137 \r
 138 /*\r
 139  * The check task, as described at the top of this file.\r
 140  */\r
 141 static void prvCheckTask( void *pvParameters );\r
 142 \r
 143 /*\r
 144  * Register check tasks, and the tasks used to write over and check the contents\r
 145  * of the FPU registers, as described at the top of this file.  The nature of\r
 146  * these files necessitates that they are written in an assembly file, but the\r
 147  * entry points are kept in the C file for the convenience of checking the task\r
 148  * parameter.\r
 149  */\r
 150 static void prvRegTestTaskEntry1( void *pvParameters );\r
 151 extern void vRegTest1Implementation( void );\r
 152 static void prvRegTestTaskEntry2( void *pvParameters );\r
 153 extern void vRegTest2Implementation( void );\r
 154 \r
 155 /*\r
 156  * Register commands that can be used with FreeRTOS+CLI.  The commands are\r
 157  * defined in CLI-Commands.c and File-Related-CLI-Command.c respectively.\r
 158  */\r
 159 extern void vRegisterSampleCLICommands( void );\r
 160 \r
 161 /*\r
 162  * The task that manages the FreeRTOS+CLI input and output.\r
 163  */\r
 164 extern void vUSBCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority );\r
 165 \r
 166 /*-----------------------------------------------------------*/\r
 167 \r
 168 /* The following two variables are used to communicate the status of the\r
 169 register check tasks to the check task.  If the variables keep incrementing,\r
 170 then the register check tasks have not discovered any errors.  If a variable\r
 171 stops incrementing, then an error has been found. */\r
 172 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;\r
 173 \r
 174 /*-----------------------------------------------------------*/\r
 175 \r
 176 void main_full( void )\r
 177 {\r
 178         /* Start all the other standard demo/test tasks.  They have no particular\r
 179         functionality, but do demonstrate how to use the FreeRTOS API and test the\r
 180         kernel port. */\r
 181         vStartInterruptQueueTasks();\r
 182         vStartDynamicPriorityTasks();\r
 183         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 184         vCreateBlockTimeTasks();\r
 185         vStartCountingSemaphoreTasks();\r
 186         vStartGenericQueueTasks( tskIDLE_PRIORITY );\r
 187         vStartRecursiveMutexTasks();\r
 188         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 189         vStartMathTasks( mainFLOP_TASK_PRIORITY );\r
 190         vStartTimerDemoTask( mainTIMER_TEST_PERIOD );\r
 191         vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );\r
 192         vStartEventGroupTasks();\r
 193         vStartInterruptSemaphoreTasks();\r
 194         vStartQueueSetTasks();\r
 195         vStartTaskNotifyTask();\r
 196 \r
 197         /* Create the register check tasks, as described at the top of this     file */\r
 198         xTaskCreate( prvRegTestTaskEntry1, "Reg1", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_1_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 199         xTaskCreate( prvRegTestTaskEntry2, "Reg2", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 200 \r
 201         /* Create the task that performs the 'check' functionality,     as described at\r
 202         the top of this file. */\r
 203         xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
 204 \r
 205         /* The set of tasks created by the following function call have to be\r
 206         created last as they keep account of the number of tasks they expect to see\r
 207         running. */\r
 208         vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 209 \r
 210         /* Start the scheduler. */\r
 211         vTaskStartScheduler();\r
 212 \r
 213         /* If all is well, the scheduler will now be running, and the following\r
 214         line will never be reached.  If the following line does execute, then\r
 215         there was insufficient FreeRTOS heap memory available for the Idle and/or\r
 216         timer tasks to be created.  See the memory management section on the\r
 217         FreeRTOS web site for more details on the FreeRTOS heap\r
 218         http://www.freertos.org/a00111.html. */\r
 219         for( ;; );\r
 220 }\r
 221 /*-----------------------------------------------------------*/\r
 222 \r
 223 static void prvCheckTask( void *pvParameters )\r
 224 {\r
 225 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;\r
 226 TickType_t xLastExecutionTime;\r
 227 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;\r
 228 unsigned long ulErrorFound = pdFALSE;\r
 229 \r
 230         /* Just to stop compiler warnings. */\r
 231         ( void ) pvParameters;\r
 232 \r
 233         /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()\r
 234         works correctly. */\r
 235         xLastExecutionTime = xTaskGetTickCount();\r
 236 \r
 237         /* Cycle for ever, delaying then checking all the other tasks are still\r
 238         operating without error.  The onboard LED is toggled on each iteration.\r
 239         If an error is detected then the delay period is decreased from\r
 240         mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD.  This has the\r
 241         effect of increasing the rate at which the onboard LED toggles, and in so\r
 242         doing gives visual feedback of the system status. */\r
 243         for( ;; )\r
 244         {\r
 245                 /* Delay until it is time to execute again. */\r
 246                 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );\r
 247 \r
 248                 /* Check all the demo tasks (other than the flash tasks) to ensure\r
 249                 that they are all still running, and that none have detected an error. */\r
 250                 if( xAreIntQueueTasksStillRunning() != pdTRUE )\r
 251                 {\r
 252                         ulErrorFound = 1UL << 0UL;\r
 253                 }\r
 254 \r
 255                 if( xAreMathsTaskStillRunning() != pdTRUE )\r
 256                 {\r
 257                         ulErrorFound = 1UL << 1UL;\r
 258                 }\r
 259 \r
 260                 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 261                 {\r
 262                         ulErrorFound = 1UL << 2UL;\r
 263                 }\r
 264 \r
 265                 if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 266                 {\r
 267                         ulErrorFound = 1UL << 3UL;\r
 268                 }\r
 269 \r
 270                 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 271                 {\r
 272                         ulErrorFound = 1UL << 4UL;\r
 273                 }\r
 274 \r
 275                 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 276                 {\r
 277                         ulErrorFound = 1UL << 5UL;\r
 278                 }\r
 279 \r
 280                 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
 281                 {\r
 282                         ulErrorFound = 1UL << 6UL;\r
 283                 }\r
 284 \r
 285                 if( xIsCreateTaskStillRunning() != pdTRUE )\r
 286                 {\r
 287                         ulErrorFound = 1UL << 7UL;\r
 288                 }\r
 289 \r
 290                 if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 291                 {\r
 292                         ulErrorFound = 1UL << 8UL;\r
 293                 }\r
 294 \r
 295                 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) xDelayPeriod ) != pdPASS )\r
 296                 {\r
 297                         ulErrorFound = 1UL << 9UL;\r
 298                 }\r
 299 \r
 300                 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )\r
 301                 {\r
 302                         ulErrorFound = 1UL << 10UL;\r
 303                 }\r
 304 \r
 305                 if( xIsQueueOverwriteTaskStillRunning() != pdPASS )\r
 306                 {\r
 307                         ulErrorFound = 1UL << 11UL;\r
 308                 }\r
 309 \r
 310                 if( xAreEventGroupTasksStillRunning() != pdPASS )\r
 311                 {\r
 312                         ulErrorFound = 1UL << 12UL;\r
 313                 }\r
 314 \r
 315                 if( xAreInterruptSemaphoreTasksStillRunning() != pdPASS )\r
 316                 {\r
 317                         ulErrorFound = 1UL << 13UL;\r
 318                 }\r
 319 \r
 320                 if( xAreQueueSetTasksStillRunning() != pdPASS )\r
 321                 {\r
 322                         ulErrorFound = 1UL << 14UL;\r
 323                 }\r
 324 \r
 325                 if( xAreTaskNotificationTasksStillRunning() != pdPASS )\r
 326                 {\r
 327                         ulErrorFound = 1UL << 15UL;\r
 328                 }\r
 329 \r
 330                 /* Check that the register test 1 task is still running. */\r
 331                 if( ulLastRegTest1Value == ulRegTest1LoopCounter )\r
 332                 {\r
 333                         ulErrorFound = 1UL << 16UL;\r
 334                 }\r
 335                 ulLastRegTest1Value = ulRegTest1LoopCounter;\r
 336 \r
 337                 /* Check that the register test 2 task is still running. */\r
 338                 if( ulLastRegTest2Value == ulRegTest2LoopCounter )\r
 339                 {\r
 340                         ulErrorFound = 1UL << 17UL;\r
 341                 }\r
 342                 ulLastRegTest2Value = ulRegTest2LoopCounter;\r
 343 \r
 344                 /* Toggle the check LED to give an indication of the system status.  If\r
 345                 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then\r
 346                 everything is ok.  A faster toggle indicates an error. */\r
 347                 mainTOGGLE_LED();\r
 348 \r
 349                 if( ulErrorFound != pdFALSE )\r
 350                 {\r
 351                         /* An error has been detected in one of the tasks - flash the LED\r
 352                         at a higher frequency to give visible feedback that something has\r
 353                         gone wrong. */\r
 354                         xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;\r
 355                 }\r
 356         }\r
 357 }\r
 358 /*-----------------------------------------------------------*/\r
 359 \r
 360 static void prvRegTestTaskEntry1( void *pvParameters )\r
 361 {\r
 362         /* Although the regtest task is written in assembler, its entry point is\r
 363         written in C for convenience of checking the task parameter is being passed\r
 364         in correctly. */\r
 365         if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )\r
 366         {\r
 367                 /* Start the part of the test that is written in assembler. */\r
 368                 vRegTest1Implementation();\r
 369         }\r
 370 \r
 371         /* The following line will only execute if the task parameter is found to\r
 372         be incorrect.  The check task will detect that the regtest loop counter is\r
 373         not being incremented and flag an error. */\r
 374         vTaskDelete( NULL );\r
 375 }\r
 376 /*-----------------------------------------------------------*/\r
 377 \r
 378 static void prvRegTestTaskEntry2( void *pvParameters )\r
 379 {\r
 380         /* Although the regtest task is written in assembler, its entry point is\r
 381         written in C for convenience of checking the task parameter is being passed\r
 382         in correctly. */\r
 383         if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )\r
 384         {\r
 385                 /* Start the part of the test that is written in assembler. */\r
 386                 vRegTest2Implementation();\r
 387         }\r
 388 \r
 389         /* The following line will only execute if the task parameter is found to\r
 390         be incorrect.  The check task will detect that the regtest loop counter is\r
 391         not being incremented and flag an error. */\r
 392         vTaskDelete( NULL );\r
 393 }\r
 394 /*-----------------------------------------------------------*/\r
 395 \r
 396 \r
 397 \r
 398 \r
 399 \r
 400 \r