git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A9_Zynq_ZC702/RTOSDemo/src/Full_Demo/main_full.c

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