git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/MicroBlaze_Spartan-6_EthernetLite/SDKProjects/RTOSDemo/main-full.c

   1 /*\r
   2     FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT \r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  33     distribute a combined work that includes FreeRTOS without being obliged to\r
  34     provide the source code for proprietary components outside of the FreeRTOS\r
  35     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  36     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  37     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  38     more details. You should have received a copy of the GNU General Public\r
  39     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  40     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  41     by writing to Richard Barry, contact details for whom are available on the\r
  42     FreeRTOS WEB site.\r
  43 \r
  44     1 tab == 4 spaces!\r
  45     \r
  46     ***************************************************************************\r
  47      *                                                                       *\r
  48      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  49      *    not run, what could be wrong?"                                     *\r
  50      *                                                                       *\r
  51      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  52      *                                                                       *\r
  53     ***************************************************************************\r
  54 \r
  55     \r
  56     http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
  57     and contact details.  \r
  58     \r
  59     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  60     including FreeRTOS+Trace - an indispensable productivity tool.\r
  61 \r
  62     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  63     the code with commercial support, indemnification, and middleware, under \r
  64     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  65     provide a safety engineered and independently SIL3 certified version under \r
  66     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  67 */\r
  68 \r
  69 /* ****************************************************************************\r
  70  * main-blinky.c is included when the "Blinky" build configuration is used.\r
  71  * main-full.c is included when the "Full" build configuration is used.\r
  72  *\r
  73  * main-full.c creates a lot of demo and test tasks and timers,  and is \r
  74  * therefore very comprehensive but also complex.  If you would prefer a much \r
  75  * simpler project to get started with, then select the 'Blinky' build \r
  76  * configuration within the SDK Eclipse IDE.  See the documentation page for\r
  77  * this demo on the http://www.FreeRTOS.org web site for more information.\r
  78  * ****************************************************************************\r
  79  *\r
  80  * main() creates all the demo application tasks and timers, then starts the \r
  81  * scheduler.  The web documentation provides more details of the standard demo \r
  82  * application tasks, which provide no particular functionality, but do provide \r
  83  * a good example of how to use the FreeRTOS API.  \r
  84  *\r
  85  * In addition to the standard demo tasks, the following tasks and tests are\r
  86  * defined and/or created within this file:\r
  87  *\r
  88  * TCP/IP ("lwIP") task - lwIP is used to create a basic web server.  The web\r
  89  * server uses server side includes (SSI) to generate tables of task statistics,\r
  90  * and run time statistics (run time statistics show how much processing time\r
  91  * each task has consumed).  See\r
  92  * http://www.FreeRTOS.org/Free-RTOS-for-Xilinx-MicroBlaze-on-Spartan-6-FPGA.html\r
  93  * for details on setting up and using the embedded web server.\r
  94  *\r
  95  * "Reg test" tasks - These test the task context switch mechanism by first \r
  96  * filling the MicroBlaze registers with known values, before checking that each\r
  97  * register maintains the value that was written to it as the tasks are switched\r
  98  * in and out.  The two register test tasks do not use the same values, and\r
  99  * execute at a very low priority, to ensure they are pre-empted regularly.\r
 100  *\r
 101  * "Check" timer - The check timer period is initially set to five seconds.  \r
 102  * The check timer callback function checks that all the standard demo tasks,\r
 103  * and the register check tasks, are not only still executing, but are executing\r
 104  * without reporting any errors.  If the check timer discovers that a task has\r
 105  * either stalled, or reported an error, then it changes its own period from\r
 106  * the initial five seconds, to just 200ms.  The check timer callback function\r
 107  * also toggles an LED each time it is called.  This provides a visual\r
 108  * indication of the system status:  If the LED toggles every five seconds then\r
 109  * no issues have been discovered.  If the LED toggles every 200ms then an issue\r
 110  * has been discovered with at least one task.  The last reported issue is\r
 111  * latched into the pcStatusMessage variable, and can also be viewed at the\r
 112  * bottom of the pages served by the embedded web server.\r
 113  *\r
 114  * ***NOTE*** This demo uses the standard comtest tasks, which has special\r
 115  * hardware requirements.  See\r
 116  * http://www.FreeRTOS.org/Free-RTOS-for-Xilinx-MicroBlaze-on-Spartan-6-FPGA.html\r
 117  * for more information.\r
 118  *\r
 119  * This file also includes example implementations of the\r
 120  * vApplicationIdleHook(), vApplicationStackOverflowHook(),\r
 121  * vApplicationMallocFailedHook(), vApplicationClearTimerInterrupt(), and\r
 122  * vApplicationSetupTimerInterrupt() callback (hook) functions.\r
 123  */\r
 124 \r
 125 /* Standard includes. */\r
 126 #include <string.h>\r
 127 #include <stdio.h>\r
 128 \r
 129 /* BSP includes. */\r
 130 #include "xtmrctr.h"\r
 131 #include "microblaze_exceptions_g.h"\r
 132 \r
 133 /* Kernel includes. */\r
 134 #include "FreeRTOS.h"\r
 135 #include "task.h"\r
 136 #include "timers.h"\r
 137 \r
 138 /* Standard demo includes. */\r
 139 #include "partest.h"\r
 140 #include "flash.h"\r
 141 #include "BlockQ.h"\r
 142 #include "death.h"\r
 143 #include "blocktim.h"\r
 144 #include "semtest.h"\r
 145 #include "PollQ.h"\r
 146 #include "GenQTest.h"\r
 147 #include "QPeek.h"\r
 148 #include "recmutex.h"\r
 149 #include "flop.h"\r
 150 #include "dynamic.h"\r
 151 #include "comtest_strings.h"\r
 152 #include "TimerDemo.h"\r
 153 \r
 154 /* lwIP includes. */\r
 155 #include "lwip/tcpip.h"\r
 156 \r
 157 \r
 158 /* Priorities at which the various tasks are created. */\r
 159 #define mainQUEUE_POLL_PRIORITY         ( tskIDLE_PRIORITY + 1 )\r
 160 #define mainSEM_TEST_PRIORITY           ( tskIDLE_PRIORITY + 2 )\r
 161 #define mainBLOCK_Q_PRIORITY            ( tskIDLE_PRIORITY + 1 )\r
 162 #define mainCREATOR_TASK_PRIORITY   ( tskIDLE_PRIORITY + 3 )\r
 163 #define mainFLASH_TASK_PRIORITY         ( tskIDLE_PRIORITY + 1 )\r
 164 #define mainCOM_TEST_PRIORITY           ( tskIDLE_PRIORITY + 2 )\r
 165 #define mainINTEGER_TASK_PRIORITY   ( tskIDLE_PRIORITY )\r
 166 #define mainGEN_QUEUE_TASK_PRIORITY     ( tskIDLE_PRIORITY )\r
 167 #define mainFLOP_TASK_PRIORITY          ( tskIDLE_PRIORITY )\r
 168 \r
 169 /* The LED toggled by the check task. */\r
 170 #define mainCHECK_LED                           ( 3 )\r
 171 \r
 172 /* The rate at which mainCHECK_LED will toggle when all the tasks are running\r
 173 without error.  See the description of the check timer in the comments at the\r
 174 top of this file. */\r
 175 #define mainNO_ERROR_CHECK_TIMER_PERIOD         ( 5000 / portTICK_RATE_MS )\r
 176 \r
 177 /* The rate at which mainCHECK_LED will toggle when an error has been reported\r
 178 by at least one task.  See the description of the check timer in the comments at \r
 179 the top of this file. */\r
 180 #define mainERROR_CHECK_TIMER_PERIOD            ( 200 / portTICK_RATE_MS )\r
 181 \r
 182 /* A block time of zero simply means "don't block". */\r
 183 #define mainDONT_BLOCK                                          ( ( portTickType ) 0 )\r
 184 \r
 185 /* The LED used by the comtest tasks. See the comtest_strings.c file for more\r
 186 information.  In this case an invalid LED number is provided as all four\r
 187 available LEDs (LEDs 0 to 3) are already in use. */\r
 188 #define mainCOM_TEST_LED                        ( 4 )\r
 189 \r
 190 /* Baud rate used by the comtest tasks.  The baud rate used is actually fixed in \r
 191 UARTLite IP when the hardware was built, but the standard serial init function \r
 192 required a baud rate parameter to be provided - in this case it is just \r
 193 ignored. */\r
 194 #define mainCOM_TEST_BAUD_RATE                          ( XPAR_RS232_UART_1_BAUDRATE )\r
 195 \r
 196 /* The timer test task generates a lot of timers that all use a different \r
 197 period that is a multiple of the mainTIMER_TEST_PERIOD definition. */\r
 198 #define mainTIMER_TEST_PERIOD                   ( 20 )\r
 199 \r
 200 /*-----------------------------------------------------------*/\r
 201 \r
 202 /*\r
 203  * The register test tasks as described in the comments at the top of this file.\r
 204  * The nature of the register test tasks means they have to be implemented in\r
 205  * assembler.\r
 206  */\r
 207 extern void vRegisterTest1( void *pvParameters );\r
 208 extern void vRegisterTest2( void *pvParameters );\r
 209 \r
 210 /*\r
 211  * Defines the 'check' timer functionality as described at the top of this file.  \r
 212  * This function is the callback function associated with the 'check' timer.\r
 213  */\r
 214 static void vCheckTimerCallback( xTimerHandle xTimer );\r
 215 \r
 216 /* \r
 217  * Configure the interrupt controller, LED outputs and button inputs. \r
 218  */\r
 219 static void prvSetupHardware( void );\r
 220 \r
 221 /* Defined in lwIPApps.c. */\r
 222 extern void lwIPAppsInit( void *pvArguments );\r
 223 \r
 224 /*-----------------------------------------------------------*/\r
 225 \r
 226 /* The check timer callback function sets pcStatusMessage to a string that\r
 227 indicates the last reported error that it discovered. */\r
 228 static const char *pcStatusMessage = NULL;\r
 229 \r
 230 /* Structures that hold the state of the various peripherals used by this demo.\r
 231 These are used by the Xilinx peripheral driver API functions.  In this case,\r
 232 only the timer/counter is used directly within this file. */\r
 233 static XTmrCtr xTimer0Instance;\r
 234 \r
 235 /* The 'check' timer, as described at the top of this file. */\r
 236 static xTimerHandle xCheckTimer = NULL;\r
 237 \r
 238 /* Used in the run time stats calculations. */\r
 239 static unsigned long ulClocksPer10thOfAMilliSecond = 0UL;\r
 240 \r
 241 /* Constants used to set up the AXI timer to generate ticks. */\r
 242 static const unsigned char ucTimerCounterNumber = ( unsigned char ) 0U;\r
 243 static const unsigned long ulCounterReloadValue = ( ( XPAR_AXI_TIMER_0_CLOCK_FREQ_HZ / configTICK_RATE_HZ ) - 1UL );\r
 244 \r
 245 /*-----------------------------------------------------------*/\r
 246 \r
 247 int main( void )\r
 248 {\r
 249         /***************************************************************************\r
 250         This project includes a lot of demo and test tasks and timers,  and is \r
 251         therefore comprehensive, but complex.  If you would prefer a much simpler \r
 252         project to get started with, then select the 'Blinky' build configuration \r
 253         within the SDK Eclipse IDE.\r
 254         ***************************************************************************/\r
 255 \r
 256         /* Configure the interrupt controller, LED outputs and button inputs. */\r
 257         prvSetupHardware();\r
 258 \r
 259         /* This call creates the TCP/IP thread. */\r
 260         tcpip_init( lwIPAppsInit, NULL );\r
 261 \r
 262         /* Start the reg test tasks, as described in the comments at the top of this\r
 263         file. */\r
 264         xTaskCreate( vRegisterTest1, ( const signed char * const ) "RegTst1", configMINIMAL_STACK_SIZE, ( void * ) 0, tskIDLE_PRIORITY, NULL );\r
 265         xTaskCreate( vRegisterTest2, ( const signed char * const ) "RegTst2", configMINIMAL_STACK_SIZE, ( void * ) 0, tskIDLE_PRIORITY, NULL );\r
 266 \r
 267         /* Create the standard demo tasks. */\r
 268         vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );\r
 269         vCreateBlockTimeTasks();\r
 270         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
 271         vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
 272         vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );\r
 273         vStartLEDFlashTasks( mainFLASH_TASK_PRIORITY );\r
 274         vStartQueuePeekTasks();\r
 275         vStartRecursiveMutexTasks();\r
 276         vStartComTestStringsTasks( mainCOM_TEST_PRIORITY, mainCOM_TEST_BAUD_RATE, mainCOM_TEST_LED );\r
 277         vStartDynamicPriorityTasks();\r
 278         vStartTimerDemoTask( mainTIMER_TEST_PERIOD );\r
 279 \r
 280         /* Note - the set of standard demo tasks contains two versions of\r
 281         vStartMathTasks.c.  One is defined in flop.c, and uses double precision\r
 282         floating point numbers and variables.  The other is defined in sp_flop.c,\r
 283         and uses single precision floating point numbers and variables.  The\r
 284         MicroBlaze floating point unit only handles single precision floating.\r
 285         Therefore, to test the floating point hardware, sp_flop.c should be included\r
 286         in this project. */\r
 287         vStartMathTasks( mainFLOP_TASK_PRIORITY );\r
 288 \r
 289         /* The suicide tasks must be created last as they need to know how many\r
 290         tasks were running prior to their creation.  This then allows them to \r
 291         ascertain whether or not the correct/expected number of tasks are running at \r
 292         any given time. */\r
 293         vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );\r
 294 \r
 295         /* Create the 'check' timer - the timer that periodically calls the\r
 296         check function as described in the comments at the top of this file.  Note \r
 297         that, for reasons stated in the comments within vApplicationIdleHook()\r
 298         (defined in this file), the check timer is not actually started until after \r
 299         the scheduler has been started. */\r
 300         xCheckTimer = xTimerCreate( ( const signed char * ) "Check timer", mainNO_ERROR_CHECK_TIMER_PERIOD, pdTRUE, ( void * ) 0, vCheckTimerCallback );\r
 301 \r
 302         /* Start the scheduler running.  From this point on, only tasks and \r
 303         interrupts will be executing. */\r
 304         vTaskStartScheduler();\r
 305 \r
 306         /* If all is well then the following line will never be reached.  If\r
 307         execution does reach here, then it is highly probably that the heap size\r
 308         is too small for the idle and/or timer tasks to be created within \r
 309         vTaskStartScheduler(). */\r
 310         taskDISABLE_INTERRUPTS();\r
 311         for( ;; );\r
 312 }\r
 313 /*-----------------------------------------------------------*/\r
 314 \r
 315 static void vCheckTimerCallback( xTimerHandle xTimer )\r
 316 {\r
 317 extern unsigned long ulRegTest1CycleCount, ulRegTest2CycleCount;\r
 318 static volatile unsigned long ulLastRegTest1CycleCount = 0UL, ulLastRegTest2CycleCount = 0UL;\r
 319 static long lErrorAlreadyLatched = pdFALSE;\r
 320 portTickType xExecutionRate = mainNO_ERROR_CHECK_TIMER_PERIOD;\r
 321 \r
 322         /* This is the callback function used by the 'check' timer, as described\r
 323         in the comments at the top of this file. */\r
 324 \r
 325         /* Don't overwrite any errors that have already been latched. */\r
 326         if( pcStatusMessage == NULL )\r
 327         {\r
 328                 /* Check the standard demo tasks are running without error. */\r
 329                 if( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
 330                 {\r
 331                         pcStatusMessage = "Error: GenQueue";\r
 332                 }\r
 333                 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )\r
 334                 {\r
 335                         pcStatusMessage = "Error: QueuePeek\r\n";\r
 336                 }\r
 337                 else if( xAreBlockingQueuesStillRunning() != pdTRUE )\r
 338                 {\r
 339                         pcStatusMessage = "Error: BlockQueue\r\n";\r
 340                 }\r
 341                 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
 342                 {\r
 343                         pcStatusMessage = "Error: BlockTime\r\n";\r
 344                 }\r
 345                 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
 346                 {\r
 347                         pcStatusMessage = "Error: SemTest\r\n";\r
 348                 }\r
 349                 else if( xArePollingQueuesStillRunning() != pdTRUE )\r
 350                 {\r
 351                         pcStatusMessage = "Error: PollQueue\r\n";\r
 352                 }\r
 353                 else if( xIsCreateTaskStillRunning() != pdTRUE )\r
 354                 {\r
 355                         pcStatusMessage = "Error: Death\r\n";\r
 356                 }\r
 357                 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
 358                 {\r
 359                         pcStatusMessage = "Error: RecMutex\r\n";\r
 360                 }\r
 361                 else if( xAreMathsTaskStillRunning() != pdPASS )\r
 362                 {\r
 363                         pcStatusMessage = "Error: Flop\r\n";\r
 364                 }\r
 365                 else if( xAreComTestTasksStillRunning() != pdPASS )\r
 366                 {\r
 367                         pcStatusMessage = "Error: Comtest\r\n";\r
 368                 }\r
 369                 else if( xAreDynamicPriorityTasksStillRunning() != pdPASS )\r
 370                 {\r
 371                         pcStatusMessage = "Error: Dynamic\r\n";\r
 372                 }\r
 373                 else if( xAreTimerDemoTasksStillRunning( xExecutionRate ) != pdTRUE )\r
 374                 {\r
 375                         pcStatusMessage = "Error: TimerDemo";\r
 376                 }\r
 377                 else if( ulRegTest1CycleCount == ulLastRegTest1CycleCount )\r
 378                 {\r
 379                         /* Check the reg test tasks are still cycling.  They will stop\r
 380                         incrementing their loop counters if they encounter an error. */\r
 381                         pcStatusMessage = "Error: RegTest1\r\n";\r
 382                 }\r
 383                 else if( ulRegTest2CycleCount == ulLastRegTest2CycleCount )\r
 384                 {\r
 385                         pcStatusMessage = "Error: RegTest2\r\n";\r
 386                 }\r
 387         }\r
 388 \r
 389         /* Store a local copy of the current reg test loop counters.  If these have\r
 390         not incremented the next time this callback function is executed then the\r
 391         reg test tasks have either stalled or discovered an error. */\r
 392         ulLastRegTest1CycleCount = ulRegTest1CycleCount;\r
 393         ulLastRegTest2CycleCount = ulRegTest2CycleCount;\r
 394 \r
 395         /* Toggle the check LED to give an indication of the system status.  If\r
 396         the LED toggles every 5 seconds then everything is ok.  A faster toggle\r
 397         indicates an error. */\r
 398         vParTestToggleLED( mainCHECK_LED );\r
 399 \r
 400         if( pcStatusMessage != NULL )\r
 401         {\r
 402                 if( lErrorAlreadyLatched == pdFALSE )\r
 403                 {\r
 404                         /* An error has occurred, so change the period of the timer that\r
 405                         calls this callback function.  This results in the LED toggling at\r
 406                         a faster rate - giving the user visual feedback that something is not\r
 407                         as it should be.  This function is called from the context of the\r
 408                         timer service task so must ***not*** attempt to block while calling\r
 409                         this function. */\r
 410                         if( xTimerChangePeriod( xTimer, mainERROR_CHECK_TIMER_PERIOD, mainDONT_BLOCK ) == pdPASS )\r
 411                         {\r
 412                                 /* If the command to change the timer period was sent to the\r
 413                                 timer command queue successfully, then latch the fact that the\r
 414                                 timer period has already been changed.  This is just done to\r
 415                                 prevent xTimerChangePeriod() being called on every execution of\r
 416                                 this function once an error has been discovered.  */\r
 417                                 lErrorAlreadyLatched = pdTRUE;\r
 418                         }\r
 419 \r
 420                         /* Update the xExecutionRate variable too as the rate at which this\r
 421                         callback is executed has to be passed into the\r
 422                         xAreTimerDemoTasksStillRunning() function. */\r
 423                         xExecutionRate = mainERROR_CHECK_TIMER_PERIOD;\r
 424                 }\r
 425         }\r
 426 }\r
 427 /*-----------------------------------------------------------*/\r
 428 \r
 429 /* This is an application defined callback function used to install the tick\r
 430 interrupt handler.  It is provided as an application callback because the kernel\r
 431 will run on lots of different MicroBlaze and FPGA configurations - not all of\r
 432 which will have the same timer peripherals defined or available.  This example\r
 433 uses the AXI Timer 0.  If that is available on your hardware platform then this\r
 434 example callback implementation should not require modification.   The name of\r
 435 the interrupt handler that should be installed is vPortTickISR(), which the \r
 436 function below declares as an extern. */\r
 437 void vApplicationSetupTimerInterrupt( void )\r
 438 {\r
 439 portBASE_TYPE xStatus;\r
 440 extern void vPortTickISR( void *pvUnused );\r
 441 \r
 442         /* Initialise the timer/counter. */\r
 443         xStatus = XTmrCtr_Initialize( &xTimer0Instance, XPAR_AXI_TIMER_0_DEVICE_ID );\r
 444 \r
 445         if( xStatus == XST_SUCCESS )\r
 446         {\r
 447                 /* Install the tick interrupt handler as the timer ISR. \r
 448                 *NOTE* The xPortInstallInterruptHandler() API function must be used for\r
 449                 this purpose. */\r
 450                 xStatus = xPortInstallInterruptHandler( XPAR_INTC_0_TMRCTR_0_VEC_ID, vPortTickISR, NULL );\r
 451         }\r
 452 \r
 453         if( xStatus == pdPASS )\r
 454         {\r
 455                 /* Enable the timer interrupt in the interrupt controller.\r
 456                 *NOTE* The vPortEnableInterrupt() API function must be used for this\r
 457                 purpose. */\r
 458                 vPortEnableInterrupt( XPAR_INTC_0_TMRCTR_0_VEC_ID );\r
 459 \r
 460                 /* Configure the timer interrupt handler. */\r
 461                 XTmrCtr_SetHandler( &xTimer0Instance, ( void * ) vPortTickISR, NULL );\r
 462 \r
 463                 /* Set the correct period for the timer. */\r
 464                 XTmrCtr_SetResetValue( &xTimer0Instance, ucTimerCounterNumber, ulCounterReloadValue );\r
 465 \r
 466                 /* Enable the interrupts.  Auto-reload mode is used to generate a\r
 467                 periodic tick.  Note that interrupts are disabled when this function is\r
 468                 called, so interrupts will not start to be processed until the first\r
 469                 task has started to run. */\r
 470                 XTmrCtr_SetOptions( &xTimer0Instance, ucTimerCounterNumber, ( XTC_INT_MODE_OPTION | XTC_AUTO_RELOAD_OPTION | XTC_DOWN_COUNT_OPTION ) );\r
 471 \r
 472                 /* Start the timer. */\r
 473                 XTmrCtr_Start( &xTimer0Instance, ucTimerCounterNumber );\r
 474         }\r
 475 \r
 476         /* Sanity check that the function executed as expected. */\r
 477         configASSERT( ( xStatus == pdPASS ) );\r
 478 }\r
 479 /*-----------------------------------------------------------*/\r
 480 \r
 481 /* This is an application defined callback function used to clear whichever\r
 482 interrupt was installed by the the vApplicationSetupTimerInterrupt() callback\r
 483 function - in this case the interrupt generated by the AXI timer.  It is \r
 484 provided as an application callback because the kernel will run on lots of \r
 485 different MicroBlaze and FPGA configurations - not all of which will have the \r
 486 same timer peripherals defined or available.  This example uses the AXI Timer 0.  \r
 487 If that is available on your hardware platform then this example callback \r
 488 implementation should not require modification provided the example definition\r
 489 of vApplicationSetupTimerInterrupt() is also not modified. */\r
 490 void vApplicationClearTimerInterrupt( void )\r
 491 {\r
 492 unsigned long ulCSR;\r
 493 \r
 494         /* Clear the timer interrupt */\r
 495         ulCSR = XTmrCtr_GetControlStatusReg( XPAR_AXI_TIMER_0_BASEADDR, 0 );\r
 496         XTmrCtr_SetControlStatusReg( XPAR_AXI_TIMER_0_BASEADDR, 0, ulCSR );\r
 497 }\r
 498 /*-----------------------------------------------------------*/\r
 499 \r
 500 void vApplicationMallocFailedHook( void )\r
 501 {\r
 502         /* vApplicationMallocFailedHook() will only be called if\r
 503         configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h.  It is a hook\r
 504         function that will get called if a call to pvPortMalloc() fails. \r
 505         pvPortMalloc() is called internally by the kernel whenever a task, queue or\r
 506         semaphore is created.  It is also called by various parts of the demo\r
 507         application.  If heap_1.c or heap_2.c are used, then the size of the heap\r
 508         available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in\r
 509         FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used\r
 510         to query the size of free heap space that remains (although it does not\r
 511         provide information on how the remaining heap might be fragmented). */\r
 512         taskDISABLE_INTERRUPTS();\r
 513         for( ;; );\r
 514 }\r
 515 /*-----------------------------------------------------------*/\r
 516 \r
 517 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )\r
 518 {\r
 519         ( void ) pcTaskName;\r
 520         ( void ) pxTask;\r
 521 \r
 522         /* vApplicationStackOverflowHook() will only be called if\r
 523         configCHECK_FOR_STACK_OVERFLOW is set to either 1 or 2.  The handle and name\r
 524         of the offending task will be passed into the hook function via its \r
 525         parameters.  However, when a stack has overflowed, it is possible that the\r
 526         parameters will have been corrupted, in which case the pxCurrentTCB variable\r
 527         can be inspected directly. */\r
 528         taskDISABLE_INTERRUPTS();\r
 529         for( ;; );\r
 530 }\r
 531 /*-----------------------------------------------------------*/\r
 532 \r
 533 void vApplicationIdleHook( void )\r
 534 {\r
 535 static long lCheckTimerStarted = pdFALSE;\r
 536 \r
 537         /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set \r
 538         to 1 in FreeRTOSConfig.h.  It will be called on each iteration of the idle \r
 539         task.  It is essential that code added to this hook function never attempts \r
 540         to block in any way (for example, call xQueueReceive() with a block time \r
 541         specified, or call vTaskDelay()).  If the application makes use of the \r
 542         vTaskDelete() API function (as this demo application does) then it is also \r
 543         important that vApplicationIdleHook() is permitted to return to its calling \r
 544         function, because it is the responsibility of the idle task to clean up \r
 545         memory allocated by the kernel to any task that has since been deleted. */\r
 546 \r
 547         /* If the check timer has not already been started, then start it now.\r
 548         Normally, the xTimerStart() API function can be called immediately after the\r
 549         timer is created - how this demo application includes the timer demo tasks.\r
 550         The timer demo tasks, as part of their test function, deliberately fill up\r
 551         the timer command queue - meaning the check timer cannot be started until\r
 552         after the scheduler has been started - at which point the timer command\r
 553         queue will have been drained. */\r
 554         if( lCheckTimerStarted == pdFALSE )\r
 555         {\r
 556                 xTimerStart( xCheckTimer, mainDONT_BLOCK ); \r
 557                 lCheckTimerStarted = pdTRUE;\r
 558         }\r
 559 }\r
 560 /*-----------------------------------------------------------*/\r
 561 \r
 562 void vApplicationExceptionRegisterDump( xPortRegisterDump *xRegisterDump )\r
 563 {\r
 564         ( void ) xRegisterDump;\r
 565 \r
 566         /* If configINSTALL_EXCEPTION_HANDLERS is set to 1 in FreeRTOSConfig.h, then \r
 567         the kernel will automatically install its own exception handlers before the \r
 568         kernel is started, if the application writer has not already caused them to \r
 569         be installed by calling either of the vPortExceptionsInstallHandlers() \r
 570         or xPortInstallInterruptHandler() API functions before that time.  The \r
 571         kernels exception handler populates an xPortRegisterDump structure with\r
 572         the processor state at the point that the exception was triggered - and also\r
 573         includes a strings that say what the exception cause was and which task was\r
 574         running at the time.  The exception handler then passes the populated\r
 575         xPortRegisterDump structure into vApplicationExceptionRegisterDump() to\r
 576         allow the application writer to perform any debugging that may be necessary.\r
 577         However, defining vApplicationExceptionRegisterDump() within the application\r
 578         itself is optional.  The kernel will use a default implementation if the\r
 579         application writer chooses not to provide their own. */\r
 580         for( ;; )\r
 581         {\r
 582                 portNOP();\r
 583         }\r
 584 }\r
 585 /*-----------------------------------------------------------*/\r
 586 \r
 587 static void prvSetupHardware( void )\r
 588 {\r
 589         taskDISABLE_INTERRUPTS();\r
 590         \r
 591         /* Configure the LED outputs. */\r
 592         vParTestInitialise();\r
 593 \r
 594         /* Tasks inherit the exception and cache configuration of the MicroBlaze\r
 595         at the point that they are created. */\r
 596         #if MICROBLAZE_EXCEPTIONS_ENABLED == 1\r
 597                 microblaze_enable_exceptions();\r
 598         #endif\r
 599 \r
 600         #if XPAR_MICROBLAZE_USE_ICACHE == 1\r
 601                 microblaze_invalidate_icache();\r
 602                 microblaze_enable_icache();\r
 603         #endif\r
 604 \r
 605         #if XPAR_MICROBLAZE_USE_DCACHE == 1\r
 606                 microblaze_invalidate_dcache();\r
 607                 microblaze_enable_dcache();\r
 608         #endif\r
 609 \r
 610 }\r
 611 /*-----------------------------------------------------------*/\r
 612 \r
 613 void vMainConfigureTimerForRunTimeStats( void )\r
 614 {\r
 615         /* How many times does the counter counter increment in 10ms? */\r
 616         ulClocksPer10thOfAMilliSecond = XPAR_AXI_TIMER_0_CLOCK_FREQ_HZ / 10000UL;\r
 617 }\r
 618 /*-----------------------------------------------------------*/\r
 619 \r
 620 unsigned long ulMainGetRunTimeCounterValue( void )\r
 621 {\r
 622 unsigned long ulTimerCounts1, ulTimerCounts2, ulTickCount, ulReturn;\r
 623 \r
 624         /* NOTE: This can get called from a yield, in which case interrupts are\r
 625         disabled, or from a tick ISR, in which case the effect is the same as if\r
 626         interrupts were disabled.  In either case, it is going to run atomically. */\r
 627 \r
 628         /* The timer is in down count mode.  How many clocks have passed since it\r
 629         was last reloaded? */\r
 630         ulTimerCounts1 = ulCounterReloadValue - XTmrCtr_GetValue( &xTimer0Instance, ucTimerCounterNumber );\r
 631 \r
 632         /* How many times has it overflowed? */\r
 633         ulTickCount = xTaskGetTickCountFromISR();\r
 634 \r
 635         /* If this is being called from a yield, has the counter overflowed since\r
 636         it was read?  If that is the case then ulTickCounts will need incrementing\r
 637         again as it will not yet have been incremented from the tick interrupt. */\r
 638         ulTimerCounts2 = ulCounterReloadValue - XTmrCtr_GetValue( &xTimer0Instance, ucTimerCounterNumber );\r
 639         if( ulTimerCounts2 < ulTimerCounts1 )\r
 640         {\r
 641                 /* There is a tick interrupt pending but the tick count not yet\r
 642                 incremented. */\r
 643                 ulTickCount++;\r
 644 \r
 645                 /* Use the second timer reading. */\r
 646                 ulTimerCounts1 = ulTimerCounts2;\r
 647         }\r
 648 \r
 649         /* Convert the tick count into tenths of a millisecond.  THIS ASSUMES\r
 650         configTICK_RATE_HZ is 1000! */\r
 651         ulReturn = ( ulTickCount * 10UL );\r
 652 \r
 653         /* Add on the number of tenths of a millisecond that have passed since the\r
 654         tick count last got updated. */\r
 655         ulReturn += ( ulTimerCounts1 / ulClocksPer10thOfAMilliSecond );\r
 656 \r
 657         /* Some crude rounding. */\r
 658         if( ( ulTimerCounts1 % ulClocksPer10thOfAMilliSecond ) > ( ulClocksPer10thOfAMilliSecond >> 1UL ) )\r
 659         {\r
 660                 ulReturn++;\r
 661         }\r
 662 \r
 663         return ulReturn;\r
 664 }\r
 665 /*-----------------------------------------------------------*/\r
 666 \r
 667 char *pcMainGetTaskStatusMessage( void )\r
 668 {\r
 669 char * pcReturn;\r
 670 \r
 671         if( pcStatusMessage == NULL )\r
 672         {\r
 673                 pcReturn = ( char * ) "OK";\r
 674         }\r
 675         else\r
 676         {\r
 677                 pcReturn = ( char * ) pcStatusMessage;\r
 678         }\r
 679 \r
 680         return pcReturn;\r
 681 }\r
 682 \r
 683 \r
 684 \r