git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/MicroBlaze_Kintex7_EthernetLite/RTOSDemo/src/main.c

   1 /*\r
   2     FreeRTOS V8.2.0 - Copyright (C) 2015 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  12 \r
  13         ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18         ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40         the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41         defined configASSERT()?\r
  42 \r
  43         http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44         embedded software for free we request you assist our global community by\r
  45         participating in the support forum.\r
  46 \r
  47         http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48         be as productive as possible as early as possible.  Now you can receive\r
  49         FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50         Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 /******************************************************************************\r
  71  * This project provides two demo applications.  A simple blinky style project,\r
  72  * and a more comprehensive test and demo application.  The\r
  73  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting (defined in this file) is used to\r
  74  * select between the two.  The simply blinky demo is implemented and described\r
  75  * in main_blinky.c.  The more comprehensive test and demo application is\r
  76  * implemented and described in main_full.c.\r
  77  *\r
  78  * This file implements the code that is not demo specific, including the\r
  79  * hardware setup and FreeRTOS hook functions.\r
  80  *\r
  81  * ENSURE TO READ THE DOCUMENTATION PAGE FOR THIS PORT AND DEMO APPLICATION ON\r
  82  * THE http://www.FreeRTOS.org WEB SITE FOR FULL INFORMATION ON USING THIS DEMO\r
  83  * APPLICATION, AND ITS ASSOCIATE FreeRTOS ARCHITECTURE PORT!\r
  84  *\r
  85  */\r
  86 \r
  87 /* Standard includes. */\r
  88 #include <stdio.h>\r
  89 #include <limits.h>\r
  90 \r
  91 /* Scheduler include files. */\r
  92 #include "FreeRTOS.h"\r
  93 #include "task.h"\r
  94 \r
  95 /* Demo app includes. */\r
  96 #include "partest.h"\r
  97 \r
  98 /* Xilinx includes. */\r
  99 #include "xtmrctr.h"\r
 100 #include "xil_cache.h"\r
 101 \r
 102 /* mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is used to select between the simply\r
 103  * blinky demo and the comprehensive test and demo application.\r
 104  *\r
 105  * When mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 1 the simple blinky example\r
 106  * will be run.\r
 107  *\r
 108  * When mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0 the comprehensive test\r
 109  * and demo application will be run.\r
 110  */\r
 111 #define mainCREATE_SIMPLE_BLINKY_DEMO_ONLY      0\r
 112 \r
 113 /*-----------------------------------------------------------*/\r
 114 \r
 115 /*\r
 116  * Configure the hardware as necessary to run this demo.\r
 117  */\r
 118 static void prvSetupHardware( void );\r
 119 \r
 120 /*\r
 121  * See the comments at the top of this file and above the\r
 122  * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY definition.\r
 123  */\r
 124 #if ( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1 )\r
 125         extern void main_blinky( void );\r
 126 #else\r
 127         extern void main_full( void );\r
 128 #endif\r
 129 \r
 130 /* Prototypes for the standard FreeRTOS callback/hook functions implemented\r
 131 within this file. */\r
 132 void vApplicationMallocFailedHook( void );\r
 133 void vApplicationIdleHook( void );\r
 134 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName );\r
 135 void vApplicationTickHook( void );\r
 136 \r
 137 /* The dual timer is used to generate the RTOS tick interrupt and as a time base\r
 138 for the run time stats. */\r
 139 static XTmrCtr xTickTimerInstance;\r
 140 \r
 141 /*-----------------------------------------------------------*/\r
 142 \r
 143 int main( void )\r
 144 {\r
 145         /* Configure the hardware ready to run the demo. */\r
 146         prvSetupHardware();\r
 147 \r
 148         /* The mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting is described at the top\r
 149         of this file. */\r
 150         #if( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 1 )\r
 151         {\r
 152                 main_blinky();\r
 153         }\r
 154         #else\r
 155         {\r
 156                 main_full();\r
 157         }\r
 158         #endif\r
 159 \r
 160         /* Don't expect to reach here. */\r
 161         return 0;\r
 162 }\r
 163 /*-----------------------------------------------------------*/\r
 164 \r
 165 static void prvSetupHardware( void )\r
 166 {\r
 167         microblaze_disable_interrupts();\r
 168 \r
 169         #if defined( XPAR_MICROBLAZE_USE_ICACHE ) && ( XPAR_MICROBLAZE_USE_ICACHE != 0 )\r
 170         {\r
 171                 Xil_ICacheEnable();\r
 172         }\r
 173         #endif\r
 174 \r
 175         #if defined( XPAR_MICROBLAZE_USE_DCACHE ) && ( XPAR_MICROBLAZE_USE_DCACHE != 0 )\r
 176         {\r
 177                 Xil_DCacheEnable();\r
 178         }\r
 179         #endif\r
 180 \r
 181         /* Initialise the LEDs.  ParTest is a historic name which used to stand for\r
 182         PARallel port TEST. */\r
 183         vParTestInitialise();\r
 184 }\r
 185 /*-----------------------------------------------------------*/\r
 186 \r
 187 void vApplicationMallocFailedHook( void )\r
 188 {\r
 189 volatile uint32_t ulDummy = 0;\r
 190 \r
 191         /* Called if a call to pvPortMalloc() fails because there is insufficient\r
 192         free memory available in the FreeRTOS heap.  pvPortMalloc() is called\r
 193         internally by FreeRTOS API functions that create tasks, queues, software\r
 194         timers, and semaphores.  The size of the FreeRTOS heap is set by the\r
 195         configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h.  Force an\r
 196         assertion failure. */\r
 197         configASSERT( ulDummy != 0 );\r
 198 }\r
 199 /*-----------------------------------------------------------*/\r
 200 \r
 201 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )\r
 202 {\r
 203         ( void ) pcTaskName;\r
 204         ( void ) pxTask;\r
 205 \r
 206         /* Run time stack overflow checking is performed if\r
 207         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 208         function is called if a stack overflow is detected.  Force an assertion\r
 209         failuse. */\r
 210         configASSERT( ( char * ) pxTask == pcTaskName );\r
 211 }\r
 212 /*-----------------------------------------------------------*/\r
 213 \r
 214 void vApplicationIdleHook( void )\r
 215 {\r
 216         #if( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 0 )\r
 217         {\r
 218                 extern void vFullDemoIdleHook( void );\r
 219 \r
 220                 /* When the full demo is build the idle hook is used to create some\r
 221                 timers to flash LEDs. */\r
 222                 vFullDemoIdleHook();\r
 223         }\r
 224         #endif\r
 225 }\r
 226 /*-----------------------------------------------------------*/\r
 227 \r
 228 void vAssertCalled( const char * pcFile, unsigned long ulLine )\r
 229 {\r
 230 volatile unsigned long ul = 0;\r
 231 \r
 232         ( void ) pcFile;\r
 233         ( void ) ulLine;\r
 234 \r
 235         taskENTER_CRITICAL();\r
 236         {\r
 237                 /* Set ul to a non-zero value using the debugger to step out of this\r
 238                 function. */\r
 239                 while( ul == 0 )\r
 240                 {\r
 241                         portNOP();\r
 242                 }\r
 243         }\r
 244         taskEXIT_CRITICAL();\r
 245 }\r
 246 /*-----------------------------------------------------------*/\r
 247 \r
 248 void vApplicationTickHook( void )\r
 249 {\r
 250         #if( mainCREATE_SIMPLE_BLINKY_DEMO_ONLY == 0 )\r
 251         {\r
 252                 extern void vFullDemoTickHook( void );\r
 253 \r
 254                 /* When the full demo is build the tick hook is used to demonstrate\r
 255                 functions being called from an interrupt and perform some tests. */\r
 256                 vFullDemoTickHook();\r
 257         }\r
 258         #endif\r
 259 }\r
 260 /*-----------------------------------------------------------*/\r
 261 \r
 262 /* This is an application defined callback function used to install the tick\r
 263 interrupt handler.  It is provided as an application callback because the kernel\r
 264 will run on lots of different MicroBlaze and FPGA configurations - not all of\r
 265 which will have the same timer peripherals defined or available.  This example\r
 266 uses the Dual Timer 0.  If that is available on your hardware platform then this\r
 267 example callback implementation may not require modification.   The name of the\r
 268 interrupt handler that must be installed is vPortTickISR(), which the function\r
 269 below declares as an extern. */\r
 270 void vApplicationSetupTimerInterrupt( void )\r
 271 {\r
 272 portBASE_TYPE xStatus;\r
 273 const unsigned char ucTickTimerCounterNumber = ( unsigned char ) 0U;\r
 274 const unsigned char ucRunTimeStatsCounterNumber = ( unsigned char ) 1U;\r
 275 const unsigned long ulCounterValue = ( ( XPAR_TMRCTR_0_CLOCK_FREQ_HZ / configTICK_RATE_HZ ) - 1UL );\r
 276 extern void vPortTickISR( void *pvUnused );\r
 277 \r
 278         /* Initialise the timer/counter. */\r
 279         xStatus = XTmrCtr_Initialize( &xTickTimerInstance, XPAR_TMRCTR_0_DEVICE_ID );\r
 280 \r
 281         if( xStatus == XST_SUCCESS )\r
 282         {\r
 283                 /* Install the tick interrupt handler as the timer ISR.\r
 284                 *NOTE* The xPortInstallInterruptHandler() API function must be used for\r
 285                 this purpose. */\r
 286                 xStatus = xPortInstallInterruptHandler( XPAR_INTC_0_TMRCTR_0_VEC_ID, vPortTickISR, NULL );\r
 287         }\r
 288 \r
 289         if( xStatus == pdPASS )\r
 290         {\r
 291                 /* Enable the timer interrupt in the interrupt controller.\r
 292                 *NOTE* The vPortEnableInterrupt() API function must be used for this\r
 293                 purpose. */\r
 294                 vPortEnableInterrupt( XPAR_INTC_0_TMRCTR_0_VEC_ID );\r
 295 \r
 296                 /* Configure the timer interrupt handler. */\r
 297                 XTmrCtr_SetHandler( &xTickTimerInstance, ( void * ) vPortTickISR, NULL );\r
 298 \r
 299                 /* Set the correct period for the timer. */\r
 300                 XTmrCtr_SetResetValue( &xTickTimerInstance, ucTickTimerCounterNumber, ulCounterValue );\r
 301 \r
 302                 /* Enable the interrupts.  Auto-reload mode is used to generate a\r
 303                 periodic tick.  Note that interrupts are disabled when this function is\r
 304                 called, so interrupts will not start to be processed until the first\r
 305                 task has started to run. */\r
 306                 XTmrCtr_SetOptions( &xTickTimerInstance, ucTickTimerCounterNumber, ( XTC_INT_MODE_OPTION | XTC_AUTO_RELOAD_OPTION | XTC_DOWN_COUNT_OPTION ) );\r
 307 \r
 308                 /* Start the timer. */\r
 309                 XTmrCtr_Start( &xTickTimerInstance, ucTickTimerCounterNumber );\r
 310 \r
 311 \r
 312 \r
 313 \r
 314                 /* The second timer is used as the time base for the run time stats.\r
 315                 Auto-reload mode is used to ensure the timer does not stop. */\r
 316                 XTmrCtr_SetOptions( &xTickTimerInstance, ucRunTimeStatsCounterNumber, XTC_AUTO_RELOAD_OPTION );\r
 317 \r
 318                 /* Start the timer. */\r
 319                 XTmrCtr_Start( &xTickTimerInstance, ucRunTimeStatsCounterNumber );\r
 320         }\r
 321 \r
 322         /* Sanity check that the function executed as expected. */\r
 323         configASSERT( ( xStatus == pdPASS ) );\r
 324 }\r
 325 /*-----------------------------------------------------------*/\r
 326 \r
 327 /* This is an application defined callback function used to clear whichever\r
 328 interrupt was installed by the the vApplicationSetupTimerInterrupt() callback\r
 329 function.  It is provided as an application callback because the kernel will run\r
 330 on lots of different MicroBlaze and FPGA configurations - not all of which will\r
 331 have the same timer peripherals defined or available.  This example uses the\r
 332 dual timer 0.  If that is available on your hardware platform then this example\r
 333 callback implementation will not require modification provided the example\r
 334 definition of vApplicationSetupTimerInterrupt() is also not modified. */\r
 335 void vApplicationClearTimerInterrupt( void )\r
 336 {\r
 337 unsigned long ulCSR;\r
 338 \r
 339         /* Clear the timer interrupt */\r
 340         ulCSR = XTmrCtr_GetControlStatusReg( XPAR_TMRCTR_0_BASEADDR, 0 );\r
 341         XTmrCtr_SetControlStatusReg( XPAR_TMRCTR_0_BASEADDR, 0, ulCSR );\r
 342 }\r
 343 /*-----------------------------------------------------------*/\r
 344 \r
 345 void *malloc( size_t x )\r
 346 {\r
 347         /* Just to check it never gets called as there is no heap defined (other\r
 348         than the FreeRTOS heap). */\r
 349         for( ;; );\r
 350 }\r
 351 /*-----------------------------------------------------------*/\r
 352 \r
 353 uint32_t ulMainGetRunTimeCounterValue( void )\r
 354 {\r
 355 static uint32_t ulOverflows = 0, ulLastTime = 0;\r
 356 uint32_t ulTimeNow, ulReturn;\r
 357 const uint32_t ulPrescale = 10, ulTCR2Offset = 24UL;\r
 358 \r
 359         ulTimeNow = * ( ( uint32_t * ) ( XPAR_TMRCTR_0_BASEADDR + ulTCR2Offset ) );\r
 360 \r
 361         if( ulTimeNow < ulLastTime )\r
 362         {\r
 363                 ulOverflows += ( 1UL << ulPrescale );\r
 364         }\r
 365 \r
 366         ulReturn = ( ulTimeNow >> ulPrescale ) + ulOverflows;\r
 367 \r
 368         return ulReturn;\r
 369 }\r