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