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

   1 /*\r
   2     FreeRTOS V9.0.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 that demonstrates the tickless low power features of FreeRTOS, and a\r
  73  * more comprehensive test and demo application.  The configCREATE_LOW_POWER_DEMO\r
  74  * setting in FreeRTOSConifg.h is used to select between the two.  See the notes\r
  75  * on using conifgCREATE_LOW_POWER_DEMO in main.c.  This file implements the\r
  76  * comprehensive test and demo version.\r
  77  *\r
  78  * The simple blinky demo uses aggregated interrupts.  The full demo uses\r
  79  * disaggregated interrupts.\r
  80  *\r
  81  * NOTE 2:  This file only contains the source code that is specific to the\r
  82  * full demo.  Generic functions, such FreeRTOS hook functions, and functions\r
  83  * required to configure the hardware, are defined in main.c.\r
  84  *\r
  85  ******************************************************************************\r
  86  *\r
  87  * main_full() creates all the demo application tasks and software timers, then\r
  88  * starts the scheduler.  The web documentation provides more details of the\r
  89  * standard demo application tasks, which provide no particular functionality,\r
  90  * but do provide a good example of how to use the FreeRTOS API.\r
  91  *\r
  92  * In addition to the standard demo tasks, the following tasks and tests are\r
  93  * defined and/or created within this file:\r
  94  *\r
  95  * "Reg test" tasks - These fill both the core and floating point registers with\r
  96  * known values, then check that each register maintains its expected value for\r
  97  * the lifetime of the task.  Each task uses a different set of values.  The reg\r
  98  * test tasks execute with a very low priority, so get preempted very\r
  99  * frequently.  A register containing an unexpected value is indicative of an\r
 100  * error in the context switching mechanism.\r
 101  *\r
 102  * "Check" task - The check task period is initially set to three seconds.  The\r
 103  * task checks that all the standard demo tasks, and the register check tasks,\r
 104  * are not only still executing, but are executing without reporting any errors.\r
 105  * If the check task discovers that a task has either stalled, or reported an\r
 106  * error, then it changes its own execution period from the initial three\r
 107  * seconds, to just 200ms.  The check task also toggles an LED each time it is\r
 108  * called.  This provides a visual indication of the system status:  If the LED\r
 109  * toggles every three seconds, then no issues have been discovered.  If the LED\r
 110  * toggles every 200ms, then an issue has been discovered with at least one\r
 111  * task.\r
 112  */\r
 113 \r
 114 /* Standard includes. */\r
 115 #include <stdio.h>\r
 116 \r
 117 /* Kernel includes. */\r
 118 #include "FreeRTOS.h"\r
 119 #include "task.h"\r
 120 #include "timers.h"\r
 121 #include "semphr.h"\r
 122 \r
 123 /* Standard demo application includes. */\r
 124 #include "flop.h"\r
 125 #include "semtest.h"\r
 126 #include "dynamic.h"\r
 127 #include "blocktim.h"\r
 128 #include "countsem.h"\r
 129 #include "GenQTest.h"\r
 130 #include "death.h"\r
 131 #include "TimerDemo.h"\r
 132 #include "IntQueue.h"\r
 133 #include "EventGroupsDemo.h"\r
 134 #include "TaskNotify.h"\r
 135 #include "StaticAllocation.h"\r
 136 \r
 137 /* Priorities for the demo application tasks. */\r
 138 #define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 1UL )\r
 139 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2UL )\r
 140 #define mainCREATOR_TASK_PRIORITY                       ( tskIDLE_PRIORITY + 3UL )\r
 141 #define mainFLOP_TASK_PRIORITY                          ( tskIDLE_PRIORITY )\r
 142 #define mainCHECK_TASK_PRIORITY                         ( configMAX_PRIORITIES - 1 )\r
 143 \r
 144 /* A block time of zero simply means "don't block". */\r
 145 #define mainDONT_BLOCK                                          ( 0UL )\r
 146 \r
 147 /* The period of the check task, in ms, provided no errors have been reported by\r
 148 any of the standard demo tasks.  ms are converted to the equivalent in ticks\r
 149 using the pdMS_TO_TICKS() macro constant. */\r
 150 #define mainNO_ERROR_CHECK_TASK_PERIOD          pdMS_TO_TICKS( 3000UL )\r
 151 \r
 152 /* The period of the check task, in ms, if an error has been reported in one of\r
 153 the standard demo tasks.  ms are converted to the equivalent in ticks using the\r
 154 pdMS_TO_TICKS() macro. */\r
 155 #define mainERROR_CHECK_TASK_PERIOD             pdMS_TO_TICKS( 200UL )\r
 156 \r
 157 /* Parameters that are passed into the register check tasks solely for the\r
 158 purpose of ensuring parameters are passed into tasks correctly. */\r
 159 #define mainREG_TEST_TASK_1_PARAMETER           ( ( void * ) 0x12345678 )\r
 160 #define mainREG_TEST_TASK_2_PARAMETER           ( ( void * ) 0x87654321 )\r
 161 \r
 162 /* The base period used by the timer test tasks. */\r
 163 #define mainTIMER_TEST_PERIOD                           ( 50 )\r
 164 \r
 165 /*-----------------------------------------------------------*/\r
 166 \r
 167 /*\r
 168  * Called by main() to run the full demo (as opposed to the blinky demo) when\r
 169  * configCREATE_LOW_POWER_DEMO is set to 0.\r
 170  */\r
 171 void main_full( void );\r
 172 \r
 173 /*\r
 174  * The check task, as described at the top of this file.\r
 175  */\r
 176 static void prvCheckTask( void *pvParameters );\r
 177 \r
 178 /*\r
 179  * Some of the tests and demo tasks executed by the full demo include\r
 180  * interaction from an interrupt - for which the tick interrupt is used via the\r
 181  * tick hook function.\r
 182  */\r
 183 void vFullDemoTickHook( void );\r
 184 \r
 185 /*\r
 186  * Register check tasks, and the tasks used to write over and check the contents\r
 187  * of the FPU registers, as described at the top of this file.  The nature of\r
 188  * these files necessitates that they are written in an assembly file, but the\r
 189  * entry points are kept in the C file for the convenience of checking the task\r
 190  * parameter.\r
 191  */\r
 192 static void prvRegTestTaskEntry1( void *pvParameters );\r
 193 extern void vRegTest1Implementation( void );\r
 194 static void prvRegTestTaskEntry2( void *pvParameters );\r
 195 extern void vRegTest2Implementation( void );\r
 196 \r
 197 /*-----------------------------------------------------------*/\r
 198 \r
 199 /* The following two variables are used to communicate the status of the\r
 200 register check tasks to the check task.  If the variables keep incrementing,\r
 201 then the register check tasks have not discovered any errors.  If a variable\r
 202 stops incrementing, then an error has been found. */\r
 203 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;\r
 204 \r
 205 /* The variable that is incremented to represent each LED toggle.  On the\r
 206 clicker hardware the LED state is set to the value of the least significant bit\r
 207 of this variable.  On other hardware, where an LED is not used, the LED just\r
 208 keeps a count of the number of times the LED would otherwise have been toggled.\r
 209 See the comments at the top of this file for information on the expected LED\r
 210 toggle rate. */\r
 211 extern volatile uint32_t ulLED;\r
 212 \r
 213 /*-----------------------------------------------------------*/\r
 214 \r
 215 void main_full( void )\r
 216 {\r
 217         /* Start all the other standard demo/test tasks.  They have no particular\r
 218         functionality, but do demonstrate how to use the FreeRTOS API and test the\r
 219         kernel port. */\r
 220         vStartDynamicPriorityTasks();\r
 221         vCreateBlockTimeTasks();\r
 222         vStartCountingSemaphoreTasks();\r
 223         vStartGenericQueueTasks( tskIDLE_PRIORITY );\r
 224         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 225         vStartMathTasks( mainFLOP_TASK_PRIORITY );\r
 226         vStartTimerDemoTask( mainTIMER_TEST_PERIOD );\r
 227         vStartEventGroupTasks();\r
 228         vStartTaskNotifyTask();\r
 229         vStartInterruptQueueTasks();\r
 230         vStartStaticallyAllocatedTasks();\r
 231 \r
 232         /* Create the register check tasks, as described at the top of this     file */\r
 233         xTaskCreate( prvRegTestTaskEntry1, "Reg1", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_1_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 234         xTaskCreate( prvRegTestTaskEntry2, "Reg2", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );\r
 235 \r
 236         /* Create the task that performs the 'check' functionality,     as described at\r
 237         the top of this file. */\r
 238         xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
 239 \r
 240         /* The set of tasks created by the following function call have to be\r
 241         created last as they keep account of the number of tasks they expect to see\r
 242         running. */\r
 243         vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 244 \r
 245         /* Start the scheduler. */\r
 246         vTaskStartScheduler();\r
 247 \r
 248         /* If all is well, the scheduler will now be running, and the following\r
 249         line will never be reached.  If the following line does execute, then\r
 250         there was insufficient FreeRTOS heap memory available for the Idle and/or\r
 251         timer tasks to be created.  See the memory management section on the\r
 252         FreeRTOS web site for more details on the FreeRTOS heap\r
 253         http://www.freertos.org/a00111.html. */\r
 254         for( ;; );\r
 255 }\r
 256 /*-----------------------------------------------------------*/\r
 257 \r
 258 static void prvCheckTask( void *pvParameters )\r
 259 {\r
 260 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;\r
 261 TickType_t xLastExecutionTime;\r
 262 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;\r
 263 unsigned long ulErrorFound = pdFALSE;\r
 264 \r
 265         /* Just to stop compiler warnings. */\r
 266         ( void ) pvParameters;\r
 267 \r
 268         /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()\r
 269         works correctly. */\r
 270         xLastExecutionTime = xTaskGetTickCount();\r
 271 \r
 272         /* Cycle for ever, delaying then checking all the other tasks are still\r
 273         operating without error.  The on board LED is toggled on each iteration.\r
 274         If an error is detected then the delay period is decreased from\r
 275         mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD.  This has the\r
 276         effect of increasing the rate at which the on board LED toggles, and in so\r
 277         doing gives visual feedback of the system status. */\r
 278         for( ;; )\r
 279         {\r
 280                 /* Delay until it is time to execute again. */\r
 281                 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );\r
 282 \r
 283                 /* Check all the demo tasks (other than the flash tasks) to ensure\r
 284                 that they are all still running, and that none have detected an error. */\r
 285                 if( xAreIntQueueTasksStillRunning() != pdTRUE )\r
 286                 {\r
 287                         ulErrorFound = 1UL << 0UL;\r
 288                 }\r
 289 \r
 290                 if( xAreMathsTaskStillRunning() != pdTRUE )\r
 291                 {\r
 292                         ulErrorFound = 1UL << 1UL;\r
 293                 }\r
 294 \r
 295                 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
 296                 {\r
 297                         ulErrorFound = 1UL << 2UL;\r
 298                 }\r
 299 \r
 300                 if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 301                 {\r
 302                         ulErrorFound = 1UL << 4UL;\r
 303                 }\r
 304 \r
 305                 if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 306                 {\r
 307                         ulErrorFound = 1UL << 5UL;\r
 308                 }\r
 309 \r
 310                 if( xIsCreateTaskStillRunning() != pdTRUE )\r
 311                 {\r
 312                         ulErrorFound = 1UL << 7UL;\r
 313                 }\r
 314 \r
 315                 if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 316                 {\r
 317                         ulErrorFound = 1UL << 8UL;\r
 318                 }\r
 319 \r
 320                 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) xDelayPeriod ) != pdPASS )\r
 321                 {\r
 322                         ulErrorFound = 1UL << 9UL;\r
 323                 }\r
 324 \r
 325                 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )\r
 326                 {\r
 327                         ulErrorFound = 1UL << 10UL;\r
 328                 }\r
 329 \r
 330                 if( xAreStaticAllocationTasksStillRunning() != pdPASS )\r
 331                 {\r
 332                         ulErrorFound = 1UL << 11UL;\r
 333                 }\r
 334 \r
 335                 if( xAreEventGroupTasksStillRunning() != pdPASS )\r
 336                 {\r
 337                         ulErrorFound = 1UL << 12UL;\r
 338                 }\r
 339 \r
 340                 if( xAreTaskNotificationTasksStillRunning() != pdPASS )\r
 341                 {\r
 342                         ulErrorFound = 1UL << 14UL;\r
 343                 }\r
 344 \r
 345                 /* Check that the register test 1 task is still running. */\r
 346                 if( ulLastRegTest1Value == ulRegTest1LoopCounter )\r
 347                 {\r
 348                         ulErrorFound = 1UL << 15UL;\r
 349                 }\r
 350                 ulLastRegTest1Value = ulRegTest1LoopCounter;\r
 351 \r
 352                 /* Check that the register test 2 task is still running. */\r
 353                 if( ulLastRegTest2Value == ulRegTest2LoopCounter )\r
 354                 {\r
 355                         ulErrorFound = 1UL << 16UL;\r
 356                 }\r
 357                 ulLastRegTest2Value = ulRegTest2LoopCounter;\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                 configTOGGLE_LED();\r
 363 \r
 364                 if( ulErrorFound != 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. */\r
 369                         xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;\r
 370                 }\r
 371 \r
 372                 configASSERT( ulErrorFound == pdFALSE );\r
 373 \r
 374                 /* Just testing the xPortIsInsideInterrupt() functionality. */\r
 375                 configASSERT( xPortIsInsideInterrupt() == pdFALSE );\r
 376         }\r
 377 }\r
 378 /*-----------------------------------------------------------*/\r
 379 \r
 380 static void prvRegTestTaskEntry1( void *pvParameters )\r
 381 {\r
 382         /* Although the regtest task is written in assembler, its entry point is\r
 383         written in C for convenience of checking the task parameter is being passed\r
 384         in correctly. */\r
 385         if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )\r
 386         {\r
 387                 /* Start the part of the test that is written in assembler. */\r
 388                 vRegTest1Implementation();\r
 389         }\r
 390 \r
 391         /* The following line will only execute if the task parameter is found to\r
 392         be incorrect.  The check task will detect that the regtest loop counter is\r
 393         not being incremented and flag an error. */\r
 394         vTaskDelete( NULL );\r
 395 }\r
 396 /*-----------------------------------------------------------*/\r
 397 \r
 398 static void prvRegTestTaskEntry2( void *pvParameters )\r
 399 {\r
 400         /* Although the regtest task is written in assembler, its entry point is\r
 401         written in C for convenience of checking the task parameter is being passed\r
 402         in correctly. */\r
 403         if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )\r
 404         {\r
 405                 /* Start the part of the test that is written in assembler. */\r
 406                 vRegTest2Implementation();\r
 407         }\r
 408 \r
 409         /* The following line will only execute if the task parameter is found to\r
 410         be incorrect.  The check task will detect that the regtest loop counter is\r
 411         not being incremented and flag an error. */\r
 412         vTaskDelete( NULL );\r
 413 }\r
 414 /*-----------------------------------------------------------*/\r
 415 \r
 416 void vFullDemoTickHook( void )\r
 417 {\r
 418         /* Some of the tests and demo tasks executed by the full demo include\r
 419         interaction from an interrupt - for which the tick interrupt is used via\r
 420         the tick hook function. */\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 event group from ISR demo. */\r
 427         vPeriodicEventGroupsProcessing();\r
 428 \r
 429         /* Call the code that 'gives' a task notification from an ISR. */\r
 430         xNotifyTaskFromISR();\r
 431 }\r