git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/RX100_RX113-RSK_GCC_e2studio_IAR/src/Full_Demo/main_full.c

   1 /*\r
   2  * FreeRTOS Kernel V10.0.0\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. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 /******************************************************************************\r
  30  * NOTE 1:  This project provides two demo applications.  A simple blinky\r
  31  * style project, and a more comprehensive test and demo application.  The\r
  32  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to\r
  33  * select between the two.  See the notes on using\r
  34  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY in main.c.  This file implements the\r
  35  * comprehensive version.\r
  36  *\r
  37  * NOTE 2:  This file only contains the source code that is specific to the\r
  38  * full demo.  Generic functions, such FreeRTOS hook functions, and functions\r
  39  * required to configure the hardware, are defined in main.c.\r
  40  *\r
  41  ******************************************************************************\r
  42  *\r
  43  * main_full() creates a set of demo application tasks and software timers, then\r
  44  * starts the scheduler.  The web documentation provides more details of the\r
  45  * standard demo application tasks, which provide no particular functionality,\r
  46  * but do provide a good example of how to use the FreeRTOS API.\r
  47  *\r
  48  * In addition to the standard demo tasks, the following tasks and tests are\r
  49  * defined and/or created within this file:\r
  50  *\r
  51  * "FreeRTOS+CLI command console" -  The command console uses SCI1 for its\r
  52  * input and output.  The baud rate is set to 19200.  Type "help" to see a list\r
  53  * of registered commands.  The FreeRTOS+CLI license is different to the\r
  54  * FreeRTOS license, see http://www.FreeRTOS.org/cli for license and usage\r
  55  * details.\r
  56  *\r
  57  * "Reg test" tasks - These fill both the core and floating point registers with\r
  58  * known values, then check that each register maintains its expected value for\r
  59  * the lifetime of the task.  Each task uses a different set of values.  The reg\r
  60  * test tasks execute with a very low priority, so get preempted very\r
  61  * frequently.  A register containing an unexpected value is indicative of an\r
  62  * error in the context switching mechanism.\r
  63  *\r
  64  * "Check" task - The check task period is initially set to three seconds.  The\r
  65  * task checks that all the standard demo tasks are not only still executing,\r
  66  * but are executing without reporting any errors.  If the check task discovers\r
  67  * that a task has either stalled, or reported an error, then it changes its own\r
  68  * execution period from the initial three seconds, to just 200ms.  The check\r
  69  * task also toggles an LED on each iteration of its loop.  This provides a\r
  70  * visual indication of the system status:  If the LED toggles every three\r
  71  * seconds, then no issues have been discovered.  If the LED toggles every\r
  72  * 200ms, then an issue has been discovered with at least one task.\r
  73  */\r
  74 \r
  75 /* Standard includes. */\r
  76 #include <stdio.h>\r
  77 \r
  78 /* Kernel includes. */\r
  79 #include "FreeRTOS.h"\r
  80 #include "task.h"\r
  81 #include "timers.h"\r
  82 #include "semphr.h"\r
  83 \r
  84 /* Standard demo application includes. */\r
  85 #include "flop.h"\r
  86 #include "semtest.h"\r
  87 #include "dynamic.h"\r
  88 #include "BlockQ.h"\r
  89 #include "blocktim.h"\r
  90 #include "countsem.h"\r
  91 #include "GenQTest.h"\r
  92 #include "recmutex.h"\r
  93 #include "death.h"\r
  94 #include "partest.h"\r
  95 #include "comtest2.h"\r
  96 #include "serial.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 <rskrx113def.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  ( tskIDLE_PRIORITY + 1 )\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         vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );\r
 210         vStartEventGroupTasks();\r
 211         vStartTaskNotifyTask();\r
 212         vStartInterruptSemaphoreTasks();\r
 213 \r
 214         /* Create the register check tasks, as described at the top of this     file */\r
 215         xTaskCreate( prvRegTest1Task, "RegTst1", configMINIMAL_STACK_SIZE, mainREG_TEST_1_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 216         xTaskCreate( prvRegTest2Task, "RegTst2", configMINIMAL_STACK_SIZE, mainREG_TEST_2_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 217 \r
 218         /* Create the task that just adds a little random behaviour. */\r
 219         xTaskCreate( prvPseudoRandomiser, "Rnd", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 2, NULL );\r
 220 \r
 221         /* Start the tasks that implements the command console on the UART, as\r
 222         described above. */\r
 223         vUARTCommandConsoleStart( mainUART_COMMAND_CONSOLE_STACK_SIZE, mainUART_COMMAND_CONSOLE_TASK_PRIORITY );\r
 224 \r
 225         /* Register the standard CLI commands. */\r
 226         vRegisterSampleCLICommands();\r
 227 \r
 228         /* Create the task that performs the 'check' functionality,     as described at\r
 229         the top of this file. */\r
 230         xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
 231 \r
 232         /* The set of tasks created by the following function call have to be\r
 233         created last as they keep account of the number of tasks they expect to see\r
 234         running. */\r
 235         vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 236 \r
 237         /* Start the scheduler. */\r
 238         vTaskStartScheduler();\r
 239 \r
 240         /* If all is well, the scheduler will now be running, and the following\r
 241         line will never be reached.  If the following line does execute, then\r
 242         there was insufficient FreeRTOS heap memory available for the Idle and/or\r
 243         timer tasks to be created.  See the memory management section on the\r
 244         FreeRTOS web site for more details on the FreeRTOS heap\r
 245         http://www.freertos.org/a00111.html. */\r
 246         for( ;; );\r
 247 }\r
 248 /*-----------------------------------------------------------*/\r
 249 \r
 250 static void prvCheckTask( void *pvParameters )\r
 251 {\r
 252 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;\r
 253 TickType_t xLastExecutionTime;\r
 254 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;\r
 255 unsigned long ulErrorFound = pdFALSE;\r
 256 \r
 257         /* Just to stop compiler warnings. */\r
 258         ( void ) pvParameters;\r
 259 \r
 260         /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()\r
 261         works correctly. */\r
 262         xLastExecutionTime = xTaskGetTickCount();\r
 263 \r
 264         /* Cycle for ever, delaying then checking all the other tasks are still\r
 265         operating without error.  The onboard LED is toggled on each iteration.\r
 266         If an error is detected then the delay period is decreased from\r
 267         mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD.  This has the\r
 268         effect of increasing the rate at which the onboard LED toggles, and in so\r
 269         doing gives visual feedback of the system status. */\r
 270         for( ;; )\r
 271         {\r
 272                 /* Delay until it is time to execute again. */\r
 273                 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );\r
 274 \r
 275                 /* Check all the demo tasks (other than the flash tasks) to ensure\r
 276                 that they are all still running, and that none have detected an error. */\r
 277                 if( xAreIntQueueTasksStillRunning() != pdTRUE )\r
 278                 {\r
 279                         ulErrorFound |= 1UL << 0UL;\r
 280                 }\r
 281 \r
 282                 if( xAreMathsTaskStillRunning() != pdTRUE )\r
 283                 {\r
 284                         ulErrorFound |= 1UL << 1UL;\r
 285                 }\r
 286 \r
 287                 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 288                 {\r
 289                         ulErrorFound |= 1UL << 2UL;\r
 290                 }\r
 291 \r
 292                 if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 293                 {\r
 294                         ulErrorFound |= 1UL << 3UL;\r
 295                 }\r
 296 \r
 297                 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 298                 {\r
 299                         ulErrorFound |= 1UL << 4UL;\r
 300                 }\r
 301 \r
 302                 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 303                 {\r
 304                         ulErrorFound |= 1UL << 5UL;\r
 305                 }\r
 306 \r
 307                 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
 308                 {\r
 309                         ulErrorFound |= 1UL << 6UL;\r
 310                 }\r
 311 \r
 312                 if( xIsCreateTaskStillRunning() != pdTRUE )\r
 313                 {\r
 314                         ulErrorFound |= 1UL << 7UL;\r
 315                 }\r
 316 \r
 317                 if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 318                 {\r
 319                         ulErrorFound |= 1UL << 8UL;\r
 320                 }\r
 321 \r
 322                 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )\r
 323                 {\r
 324                         ulErrorFound |= 1UL << 10UL;\r
 325                 }\r
 326 \r
 327                 if( xIsQueueOverwriteTaskStillRunning() != pdPASS )\r
 328                 {\r
 329                         ulErrorFound |= 1UL << 11UL;\r
 330                 }\r
 331 \r
 332                 if( xAreEventGroupTasksStillRunning() != pdPASS )\r
 333                 {\r
 334                         ulErrorFound |= 1UL << 12UL;\r
 335                 }\r
 336 \r
 337                 if( xAreTaskNotificationTasksStillRunning() != pdTRUE )\r
 338                 {\r
 339                         ulErrorFound |= 1UL << 13UL;\r
 340                 }\r
 341 \r
 342                 if( xAreInterruptSemaphoreTasksStillRunning() != pdTRUE )\r
 343                 {\r
 344                         ulErrorFound |= 1UL << 14UL;\r
 345                 }\r
 346 \r
 347                 /* Check that the register test 1 task is still running. */\r
 348                 if( ulLastRegTest1Value == ulRegTest1LoopCounter )\r
 349                 {\r
 350                         ulErrorFound |= 1UL << 15UL;\r
 351                 }\r
 352                 ulLastRegTest1Value = ulRegTest1LoopCounter;\r
 353 \r
 354                 /* Check that the register test 2 task is still running. */\r
 355                 if( ulLastRegTest2Value == ulRegTest2LoopCounter )\r
 356                 {\r
 357                         ulErrorFound |= 1UL << 16UL;\r
 358                 }\r
 359                 ulLastRegTest2Value = ulRegTest2LoopCounter;\r
 360 \r
 361                 /* Toggle the check LED to give an indication of the system status.  If\r
 362                 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then\r
 363                 everything is ok.  A faster toggle indicates an error. */\r
 364                 LED0 = !LED0;\r
 365 \r
 366                 if( ulErrorFound != pdFALSE )\r
 367                 {\r
 368                         /* An error has been detected in one of the tasks - flash the LED\r
 369                         at a higher frequency to give visible feedback that something has\r
 370                         gone wrong (it might just be that the loop back connector required\r
 371                         by the comtest tasks has not been fitted). */\r
 372                         xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;\r
 373                 }\r
 374         }\r
 375 }\r
 376 /*-----------------------------------------------------------*/\r
 377 \r
 378 static void prvPseudoRandomiser( void *pvParameters )\r
 379 {\r
 380 const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL, ulMinDelay = pdMS_TO_TICKS( 35 );\r
 381 volatile uint32_t ulNextRand = ( uint32_t ) &pvParameters, ulValue;\r
 382 \r
 383         /* This task does nothing other than ensure there is a little bit of\r
 384         disruption in the scheduling pattern of the other tasks.  Normally this is\r
 385         done by generating interrupts at pseudo random times. */\r
 386         for( ;; )\r
 387         {\r
 388                 ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement;\r
 389                 ulValue = ( ulNextRand >> 16UL ) & 0xffUL;\r
 390 \r
 391                 if( ulValue < ulMinDelay )\r
 392                 {\r
 393                         ulValue = ulMinDelay;\r
 394                 }\r
 395 \r
 396                 vTaskDelay( ulValue );\r
 397 \r
 398                 while( ulValue > 0 )\r
 399                 {\r
 400                         __asm volatile( "NOP" );\r
 401                         __asm volatile( "NOP" );\r
 402                         __asm volatile( "NOP" );\r
 403                         __asm volatile( "NOP" );\r
 404                         __asm volatile( "NOP" );\r
 405                         __asm volatile( "NOP" );\r
 406                         __asm volatile( "NOP" );\r
 407                         vTaskDelay( 2 );\r
 408                         ulValue--;\r
 409                 }\r
 410         }\r
 411 }\r
 412 /*-----------------------------------------------------------*/\r
 413 \r
 414 void vFullDemoTickHook( void )\r
 415 {\r
 416         /* Call the periodic queue overwrite from ISR demo. */\r
 417         vQueueOverwritePeriodicISRDemo();\r
 418 \r
 419         /* Call the periodic event group from ISR demo. */\r
 420         vPeriodicEventGroupsProcessing();\r
 421 \r
 422         /* Use task notifications from an interrupt. */\r
 423         xNotifyTaskFromISR();\r
 424 \r
 425         /* Use mutexes from interrupts. */\r
 426         vInterruptSemaphorePeriodicTest();\r
 427 }\r
 428 /*-----------------------------------------------------------*/\r
 429 \r
 430 /* This function is explained in the comments at the top of this file. */\r
 431 static void prvRegTest1Task( void *pvParameters )\r
 432 {\r
 433         if( pvParameters != mainREG_TEST_1_PARAMETER )\r
 434         {\r
 435                 /* The parameter did not contain the expected value. */\r
 436                 for( ;; )\r
 437                 {\r
 438                         /* Stop the tick interrupt so its obvious something has gone wrong. */\r
 439                         taskDISABLE_INTERRUPTS();\r
 440                 }\r
 441         }\r
 442 \r
 443         /* This is an inline asm function that never returns. */\r
 444         vRegTest1Implementation();\r
 445 }\r
 446 /*-----------------------------------------------------------*/\r
 447 \r
 448 /* This function is explained in the comments at the top of this file. */\r
 449 static void prvRegTest2Task( void *pvParameters )\r
 450 {\r
 451         if( pvParameters != mainREG_TEST_2_PARAMETER )\r
 452         {\r
 453                 /* The parameter did not contain the expected value. */\r
 454                 for( ;; )\r
 455                 {\r
 456                         /* Stop the tick interrupt so its obvious something has gone wrong. */\r
 457                         taskDISABLE_INTERRUPTS();\r
 458                 }\r
 459         }\r
 460 \r
 461         /* This is an inline asm function that never returns. */\r
 462         vRegTest2Implementation();\r
 463 }\r
 464 /*-----------------------------------------------------------*/\r
 465 \r