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