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

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