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

   1 /*\r
   2     FreeRTOS V8.2.3 - 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 three demo applications.  A simple blinky style\r
  72  * project, a more comprehensive test and demo application, and an lwIP example.\r
  73  * The mainSELECTED_APPLICATION setting (defined in this file) is used to\r
  74  * select between the three.  The simply blinky demo is implemented and\r
  75  * described in main_blinky.c.  The more comprehensive test and demo application\r
  76  * is implemented and described in main_full.c.  The lwIP example is implemented\r
  77  * and described in main_lwIP.c.\r
  78  *\r
  79  * This file implements the code that is not demo specific, including the\r
  80  * hardware setup and FreeRTOS hook functions.\r
  81  *\r
  82  * ENSURE TO READ THE DOCUMENTATION PAGE FOR THIS PORT AND DEMO APPLICATION ON\r
  83  * THE http://www.FreeRTOS.org WEB SITE FOR FULL INFORMATION ON USING THIS DEMO\r
  84  * APPLICATION, AND ITS ASSOCIATE FreeRTOS ARCHITECTURE PORT!\r
  85  *\r
  86  */\r
  87 \r
  88 /* Standard includes. */\r
  89 #include <stdio.h>\r
  90 #include <limits.h>\r
  91 \r
  92 /* Scheduler include files. */\r
  93 #include "FreeRTOS.h"\r
  94 #include "task.h"\r
  95 \r
  96 /* Demo app includes. */\r
  97 #include "partest.h"\r
  98 \r
  99 /* Xilinx includes. */\r
 100 #include "xtmrctr.h"\r
 101 #include "xil_cache.h"\r
 102 \r
 103 /* mainSELECTED_APPLICATION is used to select between three demo applications,\r
 104  * as described at the top of this file.\r
 105  *\r
 106  * When mainSELECTED_APPLICATION is set to 0 the simple blinky example will\r
 107  * be run.\r
 108  *\r
 109  * When mainSELECTED_APPLICATION is set to 1 the comprehensive test and demo\r
 110  * application will be run.\r
 111  *\r
 112  * When mainSELECTED_APPLICATION is set to 2 the lwIP example will be run.\r
 113  */\r
 114 #define mainSELECTED_APPLICATION        0\r
 115 \r
 116 /*-----------------------------------------------------------*/\r
 117 \r
 118 /*\r
 119  * Configure the hardware as necessary to run this demo.\r
 120  */\r
 121 static void prvSetupHardware( void );\r
 122 \r
 123 /*\r
 124 * See the comments at the top of this file and above the\r
 125 * mainSELECTED_APPLICATION definition.\r
 126 */\r
 127 #if ( mainSELECTED_APPLICATION == 0 )\r
 128         extern void main_blinky( void );\r
 129 #elif ( mainSELECTED_APPLICATION == 1 )\r
 130         extern void main_full( void );\r
 131 #elif ( mainSELECTED_APPLICATION == 2 )\r
 132         extern void main_lwIP( void );\r
 133 #else\r
 134         #error Invalid mainSELECTED_APPLICATION setting.  See the comments at the top of this file and above the mainSELECTED_APPLICATION definition.\r
 135 #endif\r
 136 \r
 137 /* Prototypes for the standard FreeRTOS callback/hook functions implemented\r
 138 within this file. */\r
 139 void vApplicationMallocFailedHook( void );\r
 140 void vApplicationIdleHook( void );\r
 141 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName );\r
 142 void vApplicationTickHook( void );\r
 143 \r
 144 /* The dual timer is used to generate the RTOS tick interrupt and as a time base\r
 145 for the run time stats. */\r
 146 static XTmrCtr xTickTimerInstance;\r
 147 \r
 148 /*-----------------------------------------------------------*/\r
 149 \r
 150 int main( void )\r
 151 {\r
 152         /* Configure the hardware ready to run the demo. */\r
 153         prvSetupHardware();\r
 154 \r
 155         /* The mainSELECTED_APPLICATION setting is described at the top\r
 156         of this file. */\r
 157         #if( mainSELECTED_APPLICATION == 0 )\r
 158         {\r
 159                 main_blinky();\r
 160         }\r
 161         #elif( mainSELECTED_APPLICATION == 1 )\r
 162         {\r
 163                 main_full();\r
 164         }\r
 165         #else\r
 166         {\r
 167                 main_lwIP();\r
 168         }\r
 169         #endif\r
 170 \r
 171         /* Don't expect to reach here. */\r
 172         return 0;\r
 173 }\r
 174 /*-----------------------------------------------------------*/\r
 175 \r
 176 static void prvSetupHardware( void )\r
 177 {\r
 178         microblaze_disable_interrupts();\r
 179 \r
 180         #if defined( XPAR_MICROBLAZE_USE_ICACHE ) && ( XPAR_MICROBLAZE_USE_ICACHE != 0 )\r
 181         {\r
 182                 Xil_ICacheInvalidate();\r
 183                 Xil_ICacheEnable();\r
 184         }\r
 185         #endif\r
 186 \r
 187         #if defined( XPAR_MICROBLAZE_USE_DCACHE ) && ( XPAR_MICROBLAZE_USE_DCACHE != 0 )\r
 188         {\r
 189                 Xil_DCacheInvalidate();\r
 190                 Xil_DCacheEnable();\r
 191         }\r
 192         #endif\r
 193 \r
 194         /* Initialise the LEDs.  ParTest is a historic name which used to stand for\r
 195         PARallel port TEST. */\r
 196         vParTestInitialise();\r
 197 }\r
 198 /*-----------------------------------------------------------*/\r
 199 \r
 200 void vApplicationMallocFailedHook( void )\r
 201 {\r
 202 volatile uint32_t ulDummy = 0;\r
 203 \r
 204         /* Called if a call to pvPortMalloc() fails because there is insufficient\r
 205         free memory available in the FreeRTOS heap.  pvPortMalloc() is called\r
 206         internally by FreeRTOS API functions that create tasks, queues, software\r
 207         timers, and semaphores.  The size of the FreeRTOS heap is set by the\r
 208         configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h.  Force an\r
 209         assertion failure. */\r
 210         configASSERT( ulDummy != 0 );\r
 211 }\r
 212 /*-----------------------------------------------------------*/\r
 213 \r
 214 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )\r
 215 {\r
 216         ( void ) pcTaskName;\r
 217         ( void ) pxTask;\r
 218 \r
 219         /* Run time stack overflow checking is performed if\r
 220         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 221         function is called if a stack overflow is detected.  Force an assertion\r
 222         failure. */\r
 223         configASSERT( ( char * ) pxTask == pcTaskName );\r
 224 }\r
 225 /*-----------------------------------------------------------*/\r
 226 \r
 227 void vApplicationIdleHook( void )\r
 228 {\r
 229         #if( mainSELECTED_APPLICATION == 1 )\r
 230         {\r
 231                 extern void vFullDemoIdleHook( void );\r
 232 \r
 233                 /* When the full demo is build the idle hook is used to create some\r
 234                 timers to flash LEDs. */\r
 235                 vFullDemoIdleHook();\r
 236         }\r
 237         #endif\r
 238 }\r
 239 /*-----------------------------------------------------------*/\r
 240 \r
 241 void vAssertCalled( const char * pcFile, unsigned long ulLine )\r
 242 {\r
 243 volatile unsigned long ul = 0;\r
 244 \r
 245         ( void ) pcFile;\r
 246         ( void ) ulLine;\r
 247 \r
 248         taskENTER_CRITICAL();\r
 249         {\r
 250                 /* Set ul to a non-zero value using the debugger to step out of this\r
 251                 function. */\r
 252                 while( ul == 0 )\r
 253                 {\r
 254                         portNOP();\r
 255                 }\r
 256         }\r
 257         taskEXIT_CRITICAL();\r
 258 }\r
 259 /*-----------------------------------------------------------*/\r
 260 \r
 261 void vApplicationTickHook( void )\r
 262 {\r
 263         #if( mainSELECTED_APPLICATION == 1 )\r
 264         {\r
 265                 extern void vFullDemoTickHook( void );\r
 266 \r
 267                 /* When the full demo is build the tick hook is used to demonstrate\r
 268                 functions being called from an interrupt and perform some tests. */\r
 269                 vFullDemoTickHook();\r
 270         }\r
 271         #endif\r
 272 }\r
 273 /*-----------------------------------------------------------*/\r
 274 \r
 275 /* This is an application defined callback function used to install the tick\r
 276 interrupt handler.  It is provided as an application callback because the kernel\r
 277 will run on lots of different MicroBlaze and FPGA configurations - not all of\r
 278 which will have the same timer peripherals defined or available.  This example\r
 279 uses the Dual Timer 0.  If that is available on your hardware platform then this\r
 280 example callback implementation may not require modification.   The name of the\r
 281 interrupt handler that must be installed is vPortTickISR(), which the function\r
 282 below declares as an extern. */\r
 283 void vApplicationSetupTimerInterrupt( void )\r
 284 {\r
 285 portBASE_TYPE xStatus;\r
 286 const unsigned char ucTickTimerCounterNumber = ( unsigned char ) 0U;\r
 287 const unsigned char ucRunTimeStatsCounterNumber = ( unsigned char ) 1U;\r
 288 const unsigned long ulCounterValue = ( ( XPAR_TMRCTR_0_CLOCK_FREQ_HZ / configTICK_RATE_HZ ) - 1UL );\r
 289 extern void vPortTickISR( void *pvUnused );\r
 290 \r
 291         /* Initialise the timer/counter. */\r
 292         xStatus = XTmrCtr_Initialize( &xTickTimerInstance, XPAR_TMRCTR_0_DEVICE_ID );\r
 293 \r
 294         if( xStatus == XST_SUCCESS )\r
 295         {\r
 296                 /* Install the tick interrupt handler as the timer ISR.\r
 297                 *NOTE* The xPortInstallInterruptHandler() API function must be used for\r
 298                 this purpose. */\r
 299                 xStatus = xPortInstallInterruptHandler( XPAR_INTC_0_TMRCTR_0_VEC_ID, vPortTickISR, NULL );\r
 300         }\r
 301 \r
 302         if( xStatus == pdPASS )\r
 303         {\r
 304                 /* Enable the timer interrupt in the interrupt controller.\r
 305                 *NOTE* The vPortEnableInterrupt() API function must be used for this\r
 306                 purpose. */\r
 307                 vPortEnableInterrupt( XPAR_INTC_0_TMRCTR_0_VEC_ID );\r
 308 \r
 309                 /* Configure the timer interrupt handler.  This installs the handler\r
 310                 directly, rather than through the Xilinx driver.  This is done for\r
 311                 efficiency. */\r
 312                 XTmrCtr_SetHandler( &xTickTimerInstance, ( void * ) vPortTickISR, NULL );\r
 313 \r
 314                 /* Set the correct period for the timer. */\r
 315                 XTmrCtr_SetResetValue( &xTickTimerInstance, ucTickTimerCounterNumber, ulCounterValue );\r
 316 \r
 317                 /* Enable the interrupts.  Auto-reload mode is used to generate a\r
 318                 periodic tick.  Note that interrupts are disabled when this function is\r
 319                 called, so interrupts will not start to be processed until the first\r
 320                 task has started to run. */\r
 321                 XTmrCtr_SetOptions( &xTickTimerInstance, ucTickTimerCounterNumber, ( XTC_INT_MODE_OPTION | XTC_AUTO_RELOAD_OPTION | XTC_DOWN_COUNT_OPTION ) );\r
 322 \r
 323                 /* Start the timer. */\r
 324                 XTmrCtr_Start( &xTickTimerInstance, ucTickTimerCounterNumber );\r
 325 \r
 326 \r
 327 \r
 328 \r
 329                 /* The second timer is used as the time base for the run time stats.\r
 330                 Auto-reload mode is used to ensure the timer does not stop. */\r
 331                 XTmrCtr_SetOptions( &xTickTimerInstance, ucRunTimeStatsCounterNumber, XTC_AUTO_RELOAD_OPTION );\r
 332 \r
 333                 /* Start the timer. */\r
 334                 XTmrCtr_Start( &xTickTimerInstance, ucRunTimeStatsCounterNumber );\r
 335         }\r
 336 \r
 337         /* Sanity check that the function executed as expected. */\r
 338         configASSERT( ( xStatus == pdPASS ) );\r
 339 }\r
 340 /*-----------------------------------------------------------*/\r
 341 \r
 342 /* This is an application defined callback function used to clear whichever\r
 343 interrupt was installed by the the vApplicationSetupTimerInterrupt() callback\r
 344 function.  It is provided as an application callback because the kernel will run\r
 345 on lots of different MicroBlaze and FPGA configurations - not all of which will\r
 346 have the same timer peripherals defined or available.  This example uses the\r
 347 dual timer 0.  If that is available on your hardware platform then this example\r
 348 callback implementation will not require modification provided the example\r
 349 definition of vApplicationSetupTimerInterrupt() is also not modified. */\r
 350 void vApplicationClearTimerInterrupt( void )\r
 351 {\r
 352 unsigned long ulCSR;\r
 353 \r
 354         /* Clear the timer interrupt */\r
 355         ulCSR = XTmrCtr_GetControlStatusReg( XPAR_TMRCTR_0_BASEADDR, 0 );\r
 356         XTmrCtr_SetControlStatusReg( XPAR_TMRCTR_0_BASEADDR, 0, ulCSR );\r
 357 }\r
 358 /*-----------------------------------------------------------*/\r
 359 \r
 360 void *malloc( size_t x )\r
 361 {\r
 362         /* Just to check it never gets called as there is no heap defined (other\r
 363         than the FreeRTOS heap). */\r
 364         for( ;; );\r
 365 }\r
 366 /*-----------------------------------------------------------*/\r
 367 \r
 368 uint32_t ulMainGetRunTimeCounterValue( void )\r
 369 {\r
 370 static uint32_t ulOverflows = 0, ulLastTime = 0;\r
 371 uint32_t ulTimeNow, ulReturn;\r
 372 const uint32_t ulPrescale = 10, ulTCR2Offset = 24UL;\r
 373 \r
 374         ulTimeNow = * ( ( uint32_t * ) ( XPAR_TMRCTR_0_BASEADDR + ulTCR2Offset ) );\r
 375 \r
 376         if( ulTimeNow < ulLastTime )\r
 377         {\r
 378                 /* 32 as its a 32-bit number. */\r
 379                 ulOverflows += ( 1UL << ( 32 - ulPrescale ) );\r
 380         }\r
 381         ulLastTime = ulTimeNow;\r
 382 \r
 383         ulReturn = ( ulTimeNow >> ulPrescale ) + ulOverflows;\r
 384 \r
 385         return ulReturn;\r
 386 }\r
 387 /*-----------------------------------------------------------*/\r
 388 \r
 389 int outbyte( int c )\r
 390 {\r
 391         return c;\r
 392 }\r
 393 \r
 394 void xil_printf( const char *pc, ... )\r
 395 {\r
 396         ( void ) pc;\r
 397 }\r
 398 \r
 399 \r