git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A53_64-bit_UltraScale_MPSoC/RTOSDemo_A53/src/Full_Demo/main_full.c

   1 /*\r
   2     FreeRTOS V9.0.0rc2 - Copyright (C) 2016 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 /******************************************************************************\r
  71  * NOTE 1:  This project provides two demo applications.  A simple blinky\r
  72  * style project, and a more comprehensive test and demo application.  The\r
  73  * mainSELECTED_APPLICATION setting in main.c is used to select between the two.\r
  74  * See the notes on using mainSELECTED_APPLICATION in main.c.  This file\r
  75  * implements the comprehensive version.\r
  76  *\r
  77  * NOTE 2:  This file only contains the source code that is specific to the\r
  78  * full demo.  Generic functions, such FreeRTOS hook functions, and functions\r
  79  * required to configure the hardware, are defined in main.c.\r
  80  *\r
  81  * NOTE 3:  The full demo includes a test that checks the floating point context\r
  82  * is maintained correctly across task switches.  The standard GCC libraries can\r
  83  * use floating point registers and made this test fail (unless the tasks that\r
  84  * use the library are given a floating point context as described on the\r
  85  * documentation page for this demo).\r
  86  *\r
  87  ******************************************************************************\r
  88  *\r
  89  * main_full() creates all the demo application tasks and software timers, then\r
  90  * starts the scheduler.  The web documentation provides more details of the\r
  91  * standard demo application tasks, which provide no particular functionality,\r
  92  * but do provide a good example of how to use the FreeRTOS API.\r
  93  *\r
  94  * In addition to the standard demo tasks, the following tasks and tests are\r
  95  * defined and/or created within this file:\r
  96  *\r
  97  * "Reg test" tasks - These fill both the core and floating point registers with\r
  98  * known values, then check that each register maintains its expected value for\r
  99  * the lifetime of the task.  Each task uses a different set of values.  The reg\r
 100  * test tasks execute with a very low priority, so get preempted very\r
 101  * frequently.  A register containing an unexpected value is indicative of an\r
 102  * error in the context switching mechanism.\r
 103  *\r
 104  * "Check" task - The check task period is initially set to three seconds.  The\r
 105  * task checks that all the standard demo tasks, and the register check tasks,\r
 106  * are not only still executing, but are executing without reporting any errors.\r
 107  * If the check task discovers that a task has either stalled, or reported an\r
 108  * error, then it changes its own execution period from the initial three\r
 109  * seconds, to just 200ms.  The check task also toggles an LED each time it is\r
 110  * called.  This provides a visual indication of the system status:  If the LED\r
 111  * toggles every five seconds, then no issues have been discovered.  If the LED\r
 112  * toggles every 200ms, then an issue has been discovered with at least one\r
 113  * task.\r
 114  */\r
 115 \r
 116 /* Standard includes. */\r
 117 #include <stdio.h>\r
 118 \r
 119 /* Kernel includes. */\r
 120 #include "FreeRTOS.h"\r
 121 #include "task.h"\r
 122 #include "timers.h"\r
 123 #include "semphr.h"\r
 124 \r
 125 /* Standard demo application includes. */\r
 126 #include "flop.h"\r
 127 #include "semtest.h"\r
 128 #include "dynamic.h"\r
 129 #include "blocktim.h"\r
 130 #include "countsem.h"\r
 131 #include "GenQTest.h"\r
 132 #include "recmutex.h"\r
 133 #include "partest.h"\r
 134 #include "IntQueue.h"\r
 135 #include "EventGroupsDemo.h"\r
 136 #include "TaskNotify.h"\r
 137 #include "IntSemTest.h"\r
 138 \r
 139 /* Priorities for the demo application tasks. */\r
 140 #define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + ( UBaseType_t ) 1 )\r
 141 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + ( UBaseType_t ) 2 )\r
 142 #define mainCREATOR_TASK_PRIORITY                       ( tskIDLE_PRIORITY + ( UBaseType_t ) 3 )\r
 143 #define mainFLOP_TASK_PRIORITY                          ( tskIDLE_PRIORITY )\r
 144 #define mainUART_COMMAND_CONSOLE_STACK_SIZE     ( configMINIMAL_STACK_SIZE * ( UBaseType_t ) 3 )\r
 145 #define mainCOM_TEST_TASK_PRIORITY                      ( tskIDLE_PRIORITY + ( UBaseType_t ) 2 )\r
 146 #define mainCHECK_TASK_PRIORITY                         ( configMAX_PRIORITIES - ( UBaseType_t ) 1 )\r
 147 \r
 148 /* The LED used by the check timer. */\r
 149 #define mainCHECK_LED                                           ( 0 )\r
 150 \r
 151 /* A block time of zero simply means "don't block". */\r
 152 #define mainDONT_BLOCK                                          ( ( TickType_t ) 0 )\r
 153 \r
 154 /* The period after which the check timer will expire, in ms, provided no errors\r
 155 have been reported by any of the standard demo tasks.  ms are converted to the\r
 156 equivalent in ticks using the portTICK_PERIOD_MS constant. */\r
 157 #define mainNO_ERROR_CHECK_TASK_PERIOD          pdMS_TO_TICKS( ( TickType_t ) 5000 )\r
 158 \r
 159 /* The period at which the check timer will expire, in ms, if an error has been\r
 160 reported in one of the standard demo tasks.  ms are converted to the equivalent\r
 161 in ticks using the portTICK_PERIOD_MS constant. */\r
 162 #define mainERROR_CHECK_TASK_PERIOD             pdMS_TO_TICKS( ( TickType_t ) ( 200 ) )\r
 163 \r
 164 /* Parameters that are passed into the register check tasks solely for the\r
 165 purpose of ensuring parameters are passed into tasks correctly. */\r
 166 #define mainREG_TEST_TASK_1_PARAMETER           ( ( void * ) 0x12345678 )\r
 167 #define mainREG_TEST_TASK_2_PARAMETER           ( ( void * ) 0x87654321 )\r
 168 \r
 169 /* The base period used by the timer test tasks. */\r
 170 #define mainTIMER_TEST_PERIOD                           ( 50 )\r
 171 \r
 172 /*-----------------------------------------------------------*/\r
 173 \r
 174 \r
 175 /*\r
 176  * The check task, as described at the top of this file.\r
 177  */\r
 178 static void prvCheckTask( void *pvParameters );\r
 179 \r
 180 /*\r
 181  * Register check tasks, and the tasks used to write over and check the contents\r
 182  * of the FPU registers, as described at the top of this file.  The nature of\r
 183  * these files necessitates that they are written in an assembly file, but the\r
 184  * entry points are kept in the C file for the convenience of checking the task\r
 185  * parameter.\r
 186  */\r
 187 static void prvRegTestTaskEntry1( void *pvParameters );\r
 188 extern void vRegTest1Implementation( void );\r
 189 static void prvRegTestTaskEntry2( void *pvParameters );\r
 190 extern void vRegTest2Implementation( void );\r
 191 \r
 192 /*\r
 193  * Register commands that can be used with FreeRTOS+CLI.  The commands are\r
 194  * defined in CLI-Commands.c and File-Related-CLI-Command.c respectively.\r
 195  */\r
 196 extern void vRegisterSampleCLICommands( void );\r
 197 \r
 198 /*\r
 199  * The task that manages the FreeRTOS+CLI input and output.\r
 200  */\r
 201 extern void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority );\r
 202 \r
 203 /*\r
 204  * A high priority task that does nothing other than execute at a pseudo random\r
 205  * time to ensure the other test tasks don't just execute in a repeating\r
 206  * pattern.\r
 207  */\r
 208 static void prvPseudoRandomiser( void *pvParameters );\r
 209 \r
 210 /*-----------------------------------------------------------*/\r
 211 \r
 212 /* The following two variables are used to communicate the status of the\r
 213 register check tasks to the check task.  If the variables keep incrementing,\r
 214 then the register check tasks have not discovered any errors.  If a variable\r
 215 stops incrementing, then an error has been found. */\r
 216 volatile uint64_t ullRegTest1LoopCounter = 0ULL, ullRegTest2LoopCounter = 0ULL;\r
 217 \r
 218 /*-----------------------------------------------------------*/\r
 219 \r
 220 void main_full( void )\r
 221 {\r
 222         /* Start all the other standard demo/test tasks.  They have no particular\r
 223         functionality, but do demonstrate how to use the FreeRTOS API and test the\r
 224         kernel port. */\r
 225         vStartInterruptQueueTasks();\r
 226         vStartDynamicPriorityTasks();\r
 227         vCreateBlockTimeTasks();\r
 228         vStartCountingSemaphoreTasks();\r
 229         vStartGenericQueueTasks( tskIDLE_PRIORITY );\r
 230         vStartRecursiveMutexTasks();\r
 231         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 232         vStartMathTasks( mainFLOP_TASK_PRIORITY );\r
 233         vStartEventGroupTasks();\r
 234         vStartTaskNotifyTask();\r
 235         vStartInterruptSemaphoreTasks();\r
 236 \r
 237         /* Create the register check tasks, as described at the top of this     file */\r
 238         xTaskCreate( prvRegTestTaskEntry1, "Reg1", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_1_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 239         xTaskCreate( prvRegTestTaskEntry2, "Reg2", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 240 \r
 241         /* Create the task that just adds a little random behaviour. */\r
 242         xTaskCreate( prvPseudoRandomiser, "Rnd", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 1, NULL );\r
 243 \r
 244         /* Create the task that performs the 'check' functionality,     as described at\r
 245         the top of this file. */\r
 246         xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
 247 \r
 248         /* Start the scheduler. */\r
 249         vTaskStartScheduler();\r
 250 \r
 251         /* If all is well, the scheduler will now be running, and the following\r
 252         line will never be reached.  If the following line does execute, then\r
 253         there was either insufficient FreeRTOS heap memory available for the idle\r
 254         and/or timer tasks to be created, or vTaskStartScheduler() was called from\r
 255         User mode.  See the memory management section on the FreeRTOS web site for\r
 256         more details on the FreeRTOS heap http://www.freertos.org/a00111.html.  The\r
 257         mode from which main() is called is set in the C start up code and must be\r
 258         a privileged mode (not user mode). */\r
 259         for( ;; );\r
 260 }\r
 261 /*-----------------------------------------------------------*/\r
 262 \r
 263 static void prvCheckTask( void *pvParameters )\r
 264 {\r
 265 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;\r
 266 TickType_t xLastExecutionTime;\r
 267 static uint64_t ullLastRegTest1Value = 0, ullLastRegTest2Value = 0;\r
 268 uint64_t ullErrorFound = pdFALSE;\r
 269 \r
 270         /* Just to stop compiler warnings. */\r
 271         ( void ) pvParameters;\r
 272 \r
 273         /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()\r
 274         works correctly. */\r
 275         xLastExecutionTime = xTaskGetTickCount();\r
 276 \r
 277         /* Cycle for ever, delaying then checking all the other tasks are still\r
 278         operating without error.  The onboard LED is toggled on each iteration.\r
 279         If an error is detected then the delay period is decreased from\r
 280         mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD.  This has the\r
 281         effect of increasing the rate at which the onboard LED toggles, and in so\r
 282         doing gives visual feedback of the system status. */\r
 283         for( ;; )\r
 284         {\r
 285                 /* Delay until it is time to execute again. */\r
 286                 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );\r
 287 \r
 288                 /* Check all the demo tasks (other than the flash tasks) to ensure\r
 289                 that they are all still running, and that none have detected an error. */\r
 290                 if( xAreIntQueueTasksStillRunning() != pdTRUE )\r
 291                 {\r
 292                         ullErrorFound |= 1ULL << 0ULL;\r
 293                 }\r
 294 \r
 295                 if( xAreMathsTaskStillRunning() != pdTRUE )\r
 296                 {\r
 297                         ullErrorFound |= 1ULL << 1ULL;\r
 298                 }\r
 299 \r
 300                 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 301                 {\r
 302                         ullErrorFound |= 1ULL << 2ULL;\r
 303                 }\r
 304 \r
 305                 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 306                 {\r
 307                         ullErrorFound |= 1ULL << 4ULL;\r
 308                 }\r
 309 \r
 310                 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 311                 {\r
 312                         ullErrorFound |= 1ULL << 5ULL;\r
 313                 }\r
 314 \r
 315                 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
 316                 {\r
 317                         ullErrorFound |= 1ULL << 6ULL;\r
 318                 }\r
 319 \r
 320                 if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 321                 {\r
 322                         ullErrorFound |= 1ULL << 8ULL;\r
 323                 }\r
 324 \r
 325                 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )\r
 326                 {\r
 327                         ullErrorFound |= 1ULL << 10ULL;\r
 328                 }\r
 329 \r
 330                 if( xAreEventGroupTasksStillRunning() != pdPASS )\r
 331                 {\r
 332                         ullErrorFound |= 1ULL << 12ULL;\r
 333                 }\r
 334 \r
 335                 if( xAreTaskNotificationTasksStillRunning() != pdTRUE )\r
 336                 {\r
 337                         ullErrorFound |= 1ULL << 13ULL;\r
 338                 }\r
 339 \r
 340                 if( xAreInterruptSemaphoreTasksStillRunning() != pdTRUE )\r
 341                 {\r
 342                         ullErrorFound |= 1ULL << 14ULL;\r
 343                 }\r
 344 \r
 345                 /* Check that the register test 1 task is still running. */\r
 346                 if( ullLastRegTest1Value == ullRegTest1LoopCounter )\r
 347                 {\r
 348                         ullErrorFound |= 1ULL << 15ULL;\r
 349                 }\r
 350                 ullLastRegTest1Value = ullRegTest1LoopCounter;\r
 351 \r
 352                 /* Check that the register test 2 task is still running. */\r
 353                 if( ullLastRegTest2Value == ullRegTest2LoopCounter )\r
 354                 {\r
 355                         ullErrorFound |= 1ULL << 16ULL;\r
 356                 }\r
 357                 ullLastRegTest2Value = ullRegTest2LoopCounter;\r
 358 \r
 359                 /* Toggle the check LED to give an indication of the system status.  If\r
 360                 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then\r
 361                 everything is ok.  A faster toggle indicates an error. */\r
 362                 vParTestToggleLED( mainCHECK_LED );\r
 363 \r
 364                 if( ullErrorFound != pdFALSE )\r
 365                 {\r
 366                         /* An error has been detected in one of the tasks - flash the LED\r
 367                         at a higher frequency to give visible feedback that something has\r
 368                         gone wrong (it might just be that the loop back connector required\r
 369                         by the comtest tasks has not been fitted). */\r
 370                         xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;\r
 371                 }\r
 372 \r
 373                 configASSERT( ullErrorFound == pdFALSE );\r
 374         }\r
 375 }\r
 376 /*-----------------------------------------------------------*/\r
 377 \r
 378 static void prvRegTestTaskEntry1( 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_1_PARAMETER )\r
 384         {\r
 385                 /* The reg test task also tests the floating point registers.  Tasks\r
 386                 that use the floating point unit must call vPortTaskUsesFPU() before\r
 387                 any floating point instructions are executed. */\r
 388                 vPortTaskUsesFPU();\r
 389 \r
 390                 /* Start the part of the test that is written in assembler. */\r
 391                 vRegTest1Implementation();\r
 392         }\r
 393 \r
 394         /* The following line will only execute if the task parameter is found to\r
 395         be incorrect.  The check timer will detect that the regtest loop counter is\r
 396         not being incremented and flag an error. */\r
 397         vTaskDelete( NULL );\r
 398 }\r
 399 /*-----------------------------------------------------------*/\r
 400 \r
 401 static void prvRegTestTaskEntry2( void *pvParameters )\r
 402 {\r
 403         /* Although the regtest task is written in assembler, its entry point is\r
 404         written in C for convenience of checking the task parameter is being passed\r
 405         in correctly. */\r
 406         if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )\r
 407         {\r
 408                 /* The reg test task also tests the floating point registers.  Tasks\r
 409                 that use the floating point unit must call vPortTaskUsesFPU() before\r
 410                 any floating point instructions are executed. */\r
 411                 vPortTaskUsesFPU();\r
 412 \r
 413                 /* Start the part of the test that is written in assembler. */\r
 414                 vRegTest2Implementation();\r
 415         }\r
 416 \r
 417         /* The following line will only execute if the task parameter is found to\r
 418         be incorrect.  The check timer will detect that the regtest loop counter is\r
 419         not being incremented and flag an error. */\r
 420         vTaskDelete( NULL );\r
 421 }\r
 422 /*-----------------------------------------------------------*/\r
 423 \r
 424 static void prvPseudoRandomiser( void *pvParameters )\r
 425 {\r
 426 const uint64_t ullMultiplier = 0x015a4e35ULL, ullIncrement = 1ULL, ullMinDelay = pdMS_TO_TICKS( 95 );\r
 427 volatile uint64_t ullNextRand = ( uint64_t ) &pvParameters, ullValue;\r
 428 \r
 429         /* This task does nothing other than ensure there is a little bit of\r
 430         disruption in the scheduling pattern of the other tasks.  Normally this is\r
 431         done by generating interrupts at pseudo random times. */\r
 432         for( ;; )\r
 433         {\r
 434                 ullNextRand = ( ullMultiplier * ullNextRand ) + ullIncrement;\r
 435                 ullValue = ( ullNextRand >> 16ULL ) & 0xffULL;\r
 436 \r
 437                 if( ullValue < ullMinDelay )\r
 438                 {\r
 439                         ullValue = ullMinDelay;\r
 440                 }\r
 441 \r
 442                 vTaskDelay( ullValue );\r
 443 \r
 444                 while( ullValue > 0 )\r
 445                 {\r
 446                         __asm volatile( "NOP" );\r
 447                         __asm volatile( "NOP" );\r
 448                         __asm volatile( "NOP" );\r
 449                         __asm volatile( "NOP" );\r
 450                         ullValue--;\r
 451                 }\r
 452         }\r
 453 }\r
 454 \r
 455 \r
 456 \r
 457 \r
 458 \r
 459 \r