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