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