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

   1 /*\r
   2  * FreeRTOS Kernel V10.0.1\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  * NOTE 1:  This project provides two demo applications.  A simple blinky\r
  30  * style project, and a more comprehensive test and demo application.  The\r
  31  * mainCREATE_SIMPLY_BLINKY_DEMO_ONLY setting in main.c is used to select\r
  32  * between the two.  See the notes on using mainCREATE_SIMPLY_BLINKY_DEMO_ONLY\r
  33  * in main.c.  This file implements the comprehensive 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 both the core and floating point registers with\r
  50  * known values, then check that each register maintains its expected value for\r
  51  * the lifetime of the task.  Each task uses a different set of values.  The reg\r
  52  * test tasks execute with a very low priority, so get preempted very\r
  53  * frequently.  A register containing an unexpected value is indicative of an\r
  54  * error in the context 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 "EventGroupsDemo.h"\r
  93 #include "IntSemTest.h"\r
  94 \r
  95 /* Priorities for the demo application tasks. */\r
  96 #define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 1UL )\r
  97 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2UL )\r
  98 #define mainCREATOR_TASK_PRIORITY                       ( tskIDLE_PRIORITY + 3UL )\r
  99 #define mainFLOP_TASK_PRIORITY                          ( tskIDLE_PRIORITY )\r
 100 #define mainUART_COMMAND_CONSOLE_STACK_SIZE     ( configMINIMAL_STACK_SIZE * 3UL )\r
 101 #define mainCOM_TEST_TASK_PRIORITY                      ( tskIDLE_PRIORITY + 2 )\r
 102 #define mainCHECK_TASK_PRIORITY                         ( configMAX_PRIORITIES - 1 )\r
 103 #define mainQUEUE_OVERWRITE_PRIORITY            ( tskIDLE_PRIORITY )\r
 104 \r
 105 /* The priority used by the UART command console task.  This is very basic and\r
 106 uses the Altera polling UART driver - so *must* run at the idle priority. */\r
 107 #define mainUART_COMMAND_CONSOLE_TASK_PRIORITY  ( tskIDLE_PRIORITY )\r
 108 \r
 109 /* The LED used by the check task. */\r
 110 #define mainCHECK_LED                                           ( 0 )\r
 111 \r
 112 /* A block time of zero simply means "don't block". */\r
 113 #define mainDONT_BLOCK                                          ( 0UL )\r
 114 \r
 115 /* The period of the check task, in ms, provided no errors have been reported by\r
 116 any of the standard demo tasks.  ms are converted to the equivalent in ticks\r
 117 using the pdMS_TO_TICKS() macro constant. */\r
 118 #define mainNO_ERROR_CHECK_TASK_PERIOD          pdMS_TO_TICKS( 3000UL )\r
 119 \r
 120 /* The period of the check task, in ms, if an error has been reported in one of\r
 121 the standard demo tasks.  ms are converted to the equivalent in ticks using the\r
 122 pdMS_TO_TICKS() macro. */\r
 123 #define mainERROR_CHECK_TASK_PERIOD             pdMS_TO_TICKS( 200UL )\r
 124 \r
 125 /* Parameters that are passed into the register check tasks solely for the\r
 126 purpose of ensuring parameters are passed into tasks correctly. */\r
 127 #define mainREG_TEST_TASK_1_PARAMETER           ( ( void * ) 0x12345678 )\r
 128 #define mainREG_TEST_TASK_2_PARAMETER           ( ( void * ) 0x87654321 )\r
 129 \r
 130 /* The base period used by the timer test tasks. */\r
 131 #define mainTIMER_TEST_PERIOD                           ( 50 )\r
 132 \r
 133 /*-----------------------------------------------------------*/\r
 134 \r
 135 \r
 136 /*\r
 137  * The check task, as described at the top of this file.\r
 138  */\r
 139 static void prvCheckTask( void *pvParameters );\r
 140 \r
 141 /*\r
 142  * Register check tasks, and the tasks used to write over and check the contents\r
 143  * of the FPU registers, as described at the top of this file.  The nature of\r
 144  * these files necessitates that they are written in an assembly file, but the\r
 145  * entry points are kept in the C file for the convenience of checking the task\r
 146  * parameter.\r
 147  */\r
 148 static void prvRegTestTaskEntry1( void *pvParameters );\r
 149 extern void vRegTest1Implementation( void );\r
 150 static void prvRegTestTaskEntry2( void *pvParameters );\r
 151 extern void vRegTest2Implementation( void );\r
 152 \r
 153 /*\r
 154  * Register commands that can be used with FreeRTOS+CLI.  The commands are\r
 155  * defined in CLI-Commands.c and File-Related-CLI-Command.c respectively.\r
 156  */\r
 157 extern void vRegisterSampleCLICommands( void );\r
 158 \r
 159 /*\r
 160  * The task that manages the FreeRTOS+CLI input and output.\r
 161  */\r
 162 extern void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority );\r
 163 \r
 164 /*\r
 165  * A high priority task that does nothing other than execute at a pseudo random\r
 166  * time to ensure the other test tasks don't just execute in a repeating\r
 167  * pattern.\r
 168  */\r
 169 static void prvPseudoRandomiser( void *pvParameters );\r
 170 \r
 171 /*-----------------------------------------------------------*/\r
 172 \r
 173 /* The following two variables are used to communicate the status of the\r
 174 register check tasks to the check task.  If the variables keep incrementing,\r
 175 then the register check tasks have not discovered any errors.  If a variable\r
 176 stops incrementing, then an error has been found. */\r
 177 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;\r
 178 \r
 179 /*-----------------------------------------------------------*/\r
 180 \r
 181 void main_full( void )\r
 182 {\r
 183         /* Start all the other standard demo/test tasks.  They have no particular\r
 184         functionality, but do demonstrate how to use the FreeRTOS API and test the\r
 185         kernel port. */\r
 186         vStartDynamicPriorityTasks();\r
 187         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 188         vCreateBlockTimeTasks();\r
 189         vStartCountingSemaphoreTasks();\r
 190         vStartGenericQueueTasks( tskIDLE_PRIORITY );\r
 191         vStartRecursiveMutexTasks();\r
 192         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 193         vStartMathTasks( mainFLOP_TASK_PRIORITY );\r
 194         vStartTimerDemoTask( mainTIMER_TEST_PERIOD );\r
 195         vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );\r
 196         vStartEventGroupTasks();\r
 197         vStartInterruptSemaphoreTasks();\r
 198 \r
 199         /* Start the tasks that implements the command console on the UART, as\r
 200         described above. */\r
 201         vUARTCommandConsoleStart( mainUART_COMMAND_CONSOLE_STACK_SIZE, mainUART_COMMAND_CONSOLE_TASK_PRIORITY );\r
 202 \r
 203         /* Register the standard CLI commands. */\r
 204         vRegisterSampleCLICommands();\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 either insufficient FreeRTOS heap memory available for the idle\r
 228         and/or timer tasks to be created, or vTaskStartScheduler() was called from\r
 229         User mode.  See the memory management section on the FreeRTOS web site for\r
 230         more details on the FreeRTOS heap http://www.freertos.org/a00111.html.  The\r
 231         mode from which main() is called is set in the C start up code and must be\r
 232         a privileged mode (not user mode). */\r
 233         for( ;; );\r
 234 }\r
 235 /*-----------------------------------------------------------*/\r
 236 \r
 237 static void prvCheckTask( void *pvParameters )\r
 238 {\r
 239 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;\r
 240 TickType_t xLastExecutionTime;\r
 241 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;\r
 242 unsigned long ulErrorFound = pdFALSE;\r
 243 \r
 244         /* Just to stop compiler warnings. */\r
 245         ( void ) pvParameters;\r
 246 \r
 247         /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()\r
 248         works correctly. */\r
 249         xLastExecutionTime = xTaskGetTickCount();\r
 250 \r
 251         /* Cycle for ever, delaying then checking all the other tasks are still\r
 252         operating without error.  The onboard LED is toggled on each iteration.\r
 253         If an error is detected then the delay period is decreased from\r
 254         mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD.  This has the\r
 255         effect of increasing the rate at which the onboard LED toggles, and in so\r
 256         doing gives visual feedback of the system status. */\r
 257         for( ;; )\r
 258         {\r
 259                 /* Delay until it is time to execute again. */\r
 260                 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );\r
 261 \r
 262                 /* Check all the demo tasks (other than the flash tasks) to ensure\r
 263                 that they are all still running, and that none have detected an error. */\r
 264                 if( xAreMathsTaskStillRunning() != pdTRUE )\r
 265                 {\r
 266                         ulErrorFound = 1 << 1;\r
 267                 }\r
 268 \r
 269                 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 270                 {\r
 271                         ulErrorFound = 1 << 2;\r
 272                 }\r
 273 \r
 274                 if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 275                 {\r
 276                         ulErrorFound = 1 << 3;\r
 277                 }\r
 278 \r
 279                 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 280                 {\r
 281                         ulErrorFound = 1 << 4;\r
 282                 }\r
 283 \r
 284                 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 285                 {\r
 286                         ulErrorFound = 1 << 5;\r
 287                 }\r
 288 \r
 289                 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
 290                 {\r
 291                         ulErrorFound = 1 << 6;\r
 292                 }\r
 293 \r
 294                 if( xIsCreateTaskStillRunning() != pdTRUE )\r
 295                 {\r
 296                         ulErrorFound = 1 << 7;\r
 297                 }\r
 298 \r
 299                 if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 300                 {\r
 301                         ulErrorFound = 1 << 8;\r
 302                 }\r
 303 \r
 304                 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) mainNO_ERROR_CHECK_TASK_PERIOD ) != pdPASS )\r
 305                 {\r
 306                         ulErrorFound = 1 << 9;\r
 307                 }\r
 308 \r
 309                 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )\r
 310                 {\r
 311                         ulErrorFound = 1 << 10;\r
 312                 }\r
 313 \r
 314                 if( xIsQueueOverwriteTaskStillRunning() != pdPASS )\r
 315                 {\r
 316                         ulErrorFound = 1 << 11;\r
 317                 }\r
 318 \r
 319                 if( xAreEventGroupTasksStillRunning() != pdPASS )\r
 320                 {\r
 321                         ulErrorFound = 1 << 12;\r
 322                 }\r
 323 \r
 324                 if( xAreInterruptSemaphoreTasksStillRunning() != pdPASS )\r
 325                 {\r
 326                         ulErrorFound = 1 << 13;\r
 327                 }\r
 328 \r
 329                 /* Check that the register test 1 task is still running. */\r
 330                 if( ulLastRegTest1Value == ulRegTest1LoopCounter )\r
 331                 {\r
 332                         ulErrorFound = 1 << 14;\r
 333                 }\r
 334                 ulLastRegTest1Value = ulRegTest1LoopCounter;\r
 335 \r
 336                 /* Check that the register test 2 task is still running. */\r
 337                 if( ulLastRegTest2Value == ulRegTest2LoopCounter )\r
 338                 {\r
 339                         ulErrorFound = 1 << 15;\r
 340                 }\r
 341                 ulLastRegTest2Value = ulRegTest2LoopCounter;\r
 342 \r
 343                 /* Toggle the check LED to give an indication of the system status.  If\r
 344                 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then\r
 345                 everything is ok.  A faster toggle indicates an error. */\r
 346                 vParTestToggleLED( mainCHECK_LED );\r
 347 \r
 348                 if( ulErrorFound != pdFALSE )\r
 349                 {\r
 350                         /* An error has been detected in one of the tasks - flash the LED\r
 351                         at a higher frequency to give visible feedback that something has\r
 352                         gone wrong (it might just be that the loop back connector required\r
 353                         by the comtest tasks has not been fitted). */\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                 /* The reg test task also tests the floating point registers.  Tasks\r
 368                 that use the floating point unit must call vPortTaskUsesFPU() before\r
 369                 any floating point instructions are executed. */\r
 370                 vPortTaskUsesFPU();\r
 371 \r
 372                 /* Start the part of the test that is written in assembler. */\r
 373                 vRegTest1Implementation();\r
 374         }\r
 375 \r
 376         /* The following line will only execute if the task parameter is found to\r
 377         be incorrect.  The check task will detect that the regtest loop counter is\r
 378         not being incremented and flag an error. */\r
 379         vTaskDelete( NULL );\r
 380 }\r
 381 /*-----------------------------------------------------------*/\r
 382 \r
 383 static void prvRegTestTaskEntry2( void *pvParameters )\r
 384 {\r
 385         /* Although the regtest task is written in assembler, its entry point is\r
 386         written in C for convenience of checking the task parameter is being passed\r
 387         in correctly. */\r
 388         if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )\r
 389         {\r
 390                 /* The reg test task also tests the floating point registers.  Tasks\r
 391                 that use the floating point unit must call vPortTaskUsesFPU() before\r
 392                 any floating point instructions are executed. */\r
 393                 vPortTaskUsesFPU();\r
 394 \r
 395                 /* Start the part of the test that is written in assembler. */\r
 396                 vRegTest2Implementation();\r
 397         }\r
 398 \r
 399         /* The following line will only execute if the task parameter is found to\r
 400         be incorrect.  The check task will detect that the regtest loop counter is\r
 401         not being incremented and flag an error. */\r
 402         vTaskDelete( NULL );\r
 403 }\r
 404 /*-----------------------------------------------------------*/\r
 405 \r
 406 static void prvPseudoRandomiser( void *pvParameters )\r
 407 {\r
 408 const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL, ulMinDelay = ( 35 / portTICK_PERIOD_MS );\r
 409 volatile uint32_t ulNextRand = ( uint32_t ) &pvParameters, ulValue;\r
 410 \r
 411 \r
 412         /* This task does nothing other than ensure there is a little bit of\r
 413         disruption in the scheduling pattern of the other tasks.  Normally this is\r
 414         done by generating interrupts at pseudo random times. */\r
 415         for( ;; )\r
 416         {\r
 417                 ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement;\r
 418                 ulValue = ( ulNextRand >> 16UL ) & 0xffUL;\r
 419 \r
 420                 if( ulValue < ulMinDelay )\r
 421                 {\r
 422                         ulValue = ulMinDelay;\r
 423                 }\r
 424 \r
 425                 vTaskDelay( ulValue );\r
 426 \r
 427                 while( ulValue > 0 )\r
 428                 {\r
 429                         __asm volatile( "NOP" );\r
 430                         __asm volatile( "NOP" );\r
 431                         __asm volatile( "NOP" );\r
 432                         __asm volatile( "NOP" );\r
 433 \r
 434                         ulValue--;\r
 435                 }\r
 436         }\r
 437 }\r
 438 \r
 439 \r
 440 \r
 441 \r
 442 \r
 443 \r