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

   1 /*\r
   2  * FreeRTOS Kernel V10.0.1\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 /******************************************************************************\r
  29  *\r
  30  * See http://www.freertos.org/RTOS-Xilinx-Zynq.html for instructions.\r
  31  *\r
  32  * This project provides three demo applications.  A simple blinky style\r
  33  * project, a more comprehensive test and demo application, and an lwIP example.\r
  34  * The mainSELECTED_APPLICATION setting (defined in this file) is used to\r
  35  * select between the three.  The simply blinky demo is implemented and\r
  36  * described in main_blinky.c.  The more comprehensive test and demo application\r
  37  * is implemented and described in main_full.c.  The lwIP example is implemented\r
  38  * and described in main_lwIP.c.\r
  39  *\r
  40  * This file implements the code that is not demo specific, including the\r
  41  * hardware setup and FreeRTOS hook functions.\r
  42  *\r
  43  * !!! IMPORTANT NOTE !!!\r
  44  * The GCC libraries that ship with the Xilinx SDK make use of the floating\r
  45  * point registers.  To avoid this causing corruption it is necessary to avoid\r
  46  * their use unless a task has been given a floating point context.  See\r
  47  * http://www.freertos.org/Using-FreeRTOS-on-Cortex-A-Embedded-Processors.html\r
  48  * for information on how to give a task a floating point context, and how to\r
  49  * handle floating point operations in interrupts.  As this demo does not give\r
  50  * all tasks a floating point context main.c contains very basic C\r
  51  * implementations of the standard C library functions memset(), memcpy() and\r
  52  * memcmp(), which are are used by FreeRTOS itself.  Defining these functions in\r
  53  * the project prevents the linker pulling them in from the library.  Any other\r
  54  * standard C library functions that are used by the application must likewise\r
  55  * be defined in C.\r
  56  *\r
  57  * ENSURE TO READ THE DOCUMENTATION PAGE FOR THIS PORT AND DEMO APPLICATION ON\r
  58  * THE http://www.FreeRTOS.org WEB SITE FOR FULL INFORMATION ON USING THIS DEMO\r
  59  * APPLICATION, AND ITS ASSOCIATE FreeRTOS ARCHITECTURE PORT!\r
  60  *\r
  61  */\r
  62 \r
  63 /* Standard includes. */\r
  64 #include <stdio.h>\r
  65 #include <limits.h>\r
  66 \r
  67 /* Scheduler include files. */\r
  68 #include "FreeRTOS.h"\r
  69 #include "task.h"\r
  70 #include "semphr.h"\r
  71 \r
  72 /* Standard demo includes. */\r
  73 #include "partest.h"\r
  74 #include "TimerDemo.h"\r
  75 #include "QueueOverwrite.h"\r
  76 #include "EventGroupsDemo.h"\r
  77 #include "TaskNotify.h"\r
  78 #include "IntSemTest.h"\r
  79 \r
  80 /* Xilinx includes. */\r
  81 #include "platform.h"\r
  82 #include "xparameters.h"\r
  83 #include "xscutimer.h"\r
  84 #include "xscugic.h"\r
  85 #include "xil_exception.h"\r
  86 \r
  87 /* mainSELECTED_APPLICATION is used to select between three demo applications,\r
  88  * as described at the top of this file.\r
  89  *\r
  90  * When mainSELECTED_APPLICATION is set to 0 the simple blinky example will\r
  91  * be run.\r
  92  *\r
  93  * When mainSELECTED_APPLICATION is set to 1 the comprehensive test and demo\r
  94  * application will be run.\r
  95  *\r
  96  * When mainSELECTED_APPLICATION is set to 2 the lwIP example will be run.\r
  97  */\r
  98 #define mainSELECTED_APPLICATION        1\r
  99 \r
 100 /*-----------------------------------------------------------*/\r
 101 \r
 102 /*\r
 103  * Configure the hardware as necessary to run this demo.\r
 104  */\r
 105 static void prvSetupHardware( void );\r
 106 \r
 107 /*\r
 108  * See the comments at the top of this file and above the\r
 109  * mainSELECTED_APPLICATION definition.\r
 110  */\r
 111 #if ( mainSELECTED_APPLICATION == 0 )\r
 112         extern void main_blinky( void );\r
 113 #elif ( mainSELECTED_APPLICATION == 1 )\r
 114         extern void main_full( void );\r
 115 #elif ( mainSELECTED_APPLICATION == 2 )\r
 116         extern void main_lwIP( void );\r
 117 #else\r
 118         #error Invalid mainSELECTED_APPLICATION setting.  See the comments at the top of this file and above the mainSELECTED_APPLICATION definition.\r
 119 #endif\r
 120 \r
 121 /*\r
 122  * The Xilinx projects use a BSP that do not allow the start up code to be\r
 123  * altered easily.  Therefore the vector table used by FreeRTOS is defined in\r
 124  * FreeRTOS_asm_vectors.S, which is part of this project.  Switch to use the\r
 125  * FreeRTOS vector table.\r
 126  */\r
 127 extern void vPortInstallFreeRTOSVectorTable( void );\r
 128 \r
 129 /* Prototypes for the standard FreeRTOS callback/hook functions implemented\r
 130 within this file. */\r
 131 void vApplicationMallocFailedHook( void );\r
 132 void vApplicationIdleHook( void );\r
 133 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName );\r
 134 void vApplicationTickHook( void );\r
 135 \r
 136 /* The private watchdog is used as the timer that generates run time\r
 137 stats.  This frequency means it will overflow quite quickly. */\r
 138 XScuWdt xWatchDogInstance;\r
 139 \r
 140 /*-----------------------------------------------------------*/\r
 141 \r
 142 /* The interrupt controller is initialised in this file, and made available to\r
 143 other modules. */\r
 144 XScuGic xInterruptController;\r
 145 \r
 146 /*-----------------------------------------------------------*/\r
 147 \r
 148 int main( void )\r
 149 {\r
 150         /* See http://www.freertos.org/RTOS-Xilinx-Zynq.html for instructions. */\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 of this\r
 156         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 BaseType_t xStatus;\r
 179 XScuGic_Config *pxGICConfig;\r
 180 \r
 181         /* Ensure no interrupts execute while the scheduler is in an inconsistent\r
 182         state.  Interrupts are automatically enabled when the scheduler is\r
 183         started. */\r
 184         portDISABLE_INTERRUPTS();\r
 185 \r
 186         /* Obtain the configuration of the GIC. */\r
 187         pxGICConfig = XScuGic_LookupConfig( XPAR_SCUGIC_SINGLE_DEVICE_ID );\r
 188 \r
 189         /* Sanity check the FreeRTOSConfig.h settings are correct for the\r
 190         hardware. */\r
 191         configASSERT( pxGICConfig );\r
 192         configASSERT( pxGICConfig->CpuBaseAddress == ( configINTERRUPT_CONTROLLER_BASE_ADDRESS + configINTERRUPT_CONTROLLER_CPU_INTERFACE_OFFSET ) );\r
 193         configASSERT( pxGICConfig->DistBaseAddress == configINTERRUPT_CONTROLLER_BASE_ADDRESS );\r
 194 \r
 195         /* Install a default handler for each GIC interrupt. */\r
 196         xStatus = XScuGic_CfgInitialize( &xInterruptController, pxGICConfig, pxGICConfig->CpuBaseAddress );\r
 197         configASSERT( xStatus == XST_SUCCESS );\r
 198         ( void ) xStatus; /* Remove compiler warning if configASSERT() is not defined. */\r
 199 \r
 200         /* Initialise the LED port. */\r
 201         vParTestInitialise();\r
 202 \r
 203         /* The Xilinx projects use a BSP that do not allow the start up code to be\r
 204         altered easily.  Therefore the vector table used by FreeRTOS is defined in\r
 205         FreeRTOS_asm_vectors.S, which is part of this project.  Switch to use the\r
 206         FreeRTOS vector table. */\r
 207         vPortInstallFreeRTOSVectorTable();\r
 208 }\r
 209 /*-----------------------------------------------------------*/\r
 210 \r
 211 void vApplicationMallocFailedHook( void )\r
 212 {\r
 213         /* Called if a call to pvPortMalloc() fails because there is insufficient\r
 214         free memory available in the FreeRTOS heap.  pvPortMalloc() is called\r
 215         internally by FreeRTOS API functions that create tasks, queues, software\r
 216         timers, and semaphores.  The size of the FreeRTOS heap is set by the\r
 217         configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */\r
 218         taskDISABLE_INTERRUPTS();\r
 219         for( ;; );\r
 220 }\r
 221 /*-----------------------------------------------------------*/\r
 222 \r
 223 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )\r
 224 {\r
 225         ( void ) pcTaskName;\r
 226         ( void ) pxTask;\r
 227 \r
 228         /* Run time stack overflow checking is performed if\r
 229         configCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2.  This hook\r
 230         function is called if a stack overflow is detected. */\r
 231         taskDISABLE_INTERRUPTS();\r
 232         for( ;; );\r
 233 }\r
 234 /*-----------------------------------------------------------*/\r
 235 \r
 236 void vApplicationIdleHook( void )\r
 237 {\r
 238 volatile size_t xFreeHeapSpace, xMinimumEverFreeHeapSpace;\r
 239 \r
 240         /* This is just a trivial example of an idle hook.  It is called on each\r
 241         cycle of the idle task.  It must *NOT* attempt to block.  In this case the\r
 242         idle task just queries the amount of FreeRTOS heap that remains.  See the\r
 243         memory management section on the http://www.FreeRTOS.org web site for memory\r
 244         management options.  If there is a lot of heap memory free then the\r
 245         configTOTAL_HEAP_SIZE value in FreeRTOSConfig.h can be reduced to free up\r
 246         RAM. */\r
 247         xFreeHeapSpace = xPortGetFreeHeapSize();\r
 248         xMinimumEverFreeHeapSpace = xPortGetMinimumEverFreeHeapSize();\r
 249 \r
 250         /* Remove compiler warning about xFreeHeapSpace being set but never used. */\r
 251         ( void ) xFreeHeapSpace;\r
 252         ( void ) xMinimumEverFreeHeapSpace;\r
 253 }\r
 254 /*-----------------------------------------------------------*/\r
 255 \r
 256 void vAssertCalled( const char * pcFile, unsigned long ulLine )\r
 257 {\r
 258 volatile unsigned long ul = 0;\r
 259 \r
 260         ( void ) pcFile;\r
 261         ( void ) ulLine;\r
 262 \r
 263         taskENTER_CRITICAL();\r
 264         {\r
 265                 /* Set ul to a non-zero value using the debugger to step out of this\r
 266                 function. */\r
 267                 while( ul == 0 )\r
 268                 {\r
 269                         portNOP();\r
 270                 }\r
 271         }\r
 272         taskEXIT_CRITICAL();\r
 273 }\r
 274 /*-----------------------------------------------------------*/\r
 275 \r
 276 void vApplicationTickHook( void )\r
 277 {\r
 278         #if( mainSELECTED_APPLICATION == 1 )\r
 279         {\r
 280                 /* The full demo includes a software timer demo/test that requires\r
 281                 prodding periodically from the tick interrupt. */\r
 282                 vTimerPeriodicISRTests();\r
 283 \r
 284                 /* Call the periodic queue overwrite from ISR demo. */\r
 285                 vQueueOverwritePeriodicISRDemo();\r
 286 \r
 287                 /* Call the periodic event group from ISR demo. */\r
 288                 vPeriodicEventGroupsProcessing();\r
 289 \r
 290                 /* Use task notifications from an interrupt. */\r
 291                 xNotifyTaskFromISR();\r
 292 \r
 293                 /* Use mutexes from interrupts. */\r
 294                 vInterruptSemaphorePeriodicTest();\r
 295 \r
 296                 /* Test flop alignment in interrupts - calling printf from an interrupt\r
 297                 is BAD! */\r
 298                 #if( configASSERT_DEFINED == 1 )\r
 299                 {\r
 300                 char cBuf[ 20 ];\r
 301                 UBaseType_t uxSavedInterruptStatus;\r
 302 \r
 303                         uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
 304                         {\r
 305                                 sprintf( cBuf, "%1.3f", 1.234 );\r
 306                         }\r
 307                         portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
 308 \r
 309                         configASSERT( strcmp( cBuf, "1.234" ) == 0 );\r
 310                 }\r
 311                 #endif /* configASSERT_DEFINED */\r
 312         }\r
 313         #endif\r
 314 }\r
 315 /*-----------------------------------------------------------*/\r
 316 \r
 317 void *memcpy( void *pvDest, const void *pvSource, size_t xBytes )\r
 318 {\r
 319 /* The compiler used during development seems to err unless these volatiles are\r
 320 included at -O3 optimisation.  */\r
 321 volatile unsigned char *pcDest = ( volatile unsigned char * ) pvDest, *pcSource = ( volatile unsigned char * ) pvSource;\r
 322 size_t x;\r
 323 \r
 324         /* Extremely crude standard library implementations in lieu of having a C\r
 325         library. */\r
 326         if( pvDest != pvSource )\r
 327         {\r
 328                 for( x = 0; x < xBytes; x++ )\r
 329                 {\r
 330                         pcDest[ x ] = pcSource[ x ];\r
 331                 }\r
 332         }\r
 333 \r
 334         return pvDest;\r
 335 }\r
 336 /*-----------------------------------------------------------*/\r
 337 \r
 338 void *memset( void *pvDest, int iValue, size_t xBytes )\r
 339 {\r
 340 /* The compiler used during development seems to err unless these volatiles are\r
 341 included at -O3 optimisation.  */\r
 342 volatile unsigned char * volatile pcDest = ( volatile unsigned char * volatile ) pvDest;\r
 343 volatile size_t x;\r
 344 \r
 345         /* Extremely crude standard library implementations in lieu of having a C\r
 346         library. */\r
 347         for( x = 0; x < xBytes; x++ )\r
 348         {\r
 349                 pcDest[ x ] = ( unsigned char ) iValue;\r
 350         }\r
 351 \r
 352         return pvDest;\r
 353 }\r
 354 /*-----------------------------------------------------------*/\r
 355 \r
 356 int memcmp( const void *pvMem1, const void *pvMem2, size_t xBytes )\r
 357 {\r
 358 const volatile unsigned char *pucMem1 = pvMem1, *pucMem2 = pvMem2;\r
 359 volatile size_t x;\r
 360 \r
 361         /* Extremely crude standard library implementations in lieu of having a C\r
 362         library. */\r
 363         for( x = 0; x < xBytes; x++ )\r
 364         {\r
 365                 if( pucMem1[ x ] != pucMem2[ x ] )\r
 366                 {\r
 367                         break;\r
 368                 }\r
 369         }\r
 370 \r
 371         return xBytes - x;\r
 372 }\r
 373 /*-----------------------------------------------------------*/\r
 374 \r
 375 void vInitialiseTimerForRunTimeStats( void )\r
 376 {\r
 377 XScuWdt_Config *pxWatchDogInstance;\r
 378 uint32_t ulValue;\r
 379 const uint32_t ulMaxDivisor = 0xff, ulDivisorShift = 0x08;\r
 380 \r
 381          pxWatchDogInstance = XScuWdt_LookupConfig( XPAR_SCUWDT_0_DEVICE_ID );\r
 382          XScuWdt_CfgInitialize( &xWatchDogInstance, pxWatchDogInstance, pxWatchDogInstance->BaseAddr );\r
 383 \r
 384          ulValue = XScuWdt_GetControlReg( &xWatchDogInstance );\r
 385          ulValue |= ulMaxDivisor << ulDivisorShift;\r
 386          XScuWdt_SetControlReg( &xWatchDogInstance, ulValue );\r
 387 \r
 388          XScuWdt_LoadWdt( &xWatchDogInstance, UINT_MAX );\r
 389          XScuWdt_SetTimerMode( &xWatchDogInstance );\r
 390          XScuWdt_Start( &xWatchDogInstance );\r
 391 }\r
 392 /*-----------------------------------------------------------*/\r
 393 \r
 394 /* configUSE_STATIC_ALLOCATION is set to 1, so the application must provide an\r
 395 implementation of vApplicationGetIdleTaskMemory() to provide the memory that is\r
 396 used by the Idle task. */\r
 397 void vApplicationGetIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer, StackType_t **ppxIdleTaskStackBuffer, uint32_t *pulIdleTaskStackSize )\r
 398 {\r
 399 /* If the buffers to be provided to the Idle task are declared inside this\r
 400 function then they must be declared static - otherwise they will be allocated on\r
 401 the stack and so not exists after this function exits. */\r
 402 static StaticTask_t xIdleTaskTCB;\r
 403 static StackType_t uxIdleTaskStack[ configMINIMAL_STACK_SIZE ];\r
 404 \r
 405         /* Pass out a pointer to the StaticTask_t structure in which the Idle task's\r
 406         state will be stored. */\r
 407         *ppxIdleTaskTCBBuffer = &xIdleTaskTCB;\r
 408 \r
 409         /* Pass out the array that will be used as the Idle task's stack. */\r
 410         *ppxIdleTaskStackBuffer = uxIdleTaskStack;\r
 411 \r
 412         /* Pass out the size of the array pointed to by *ppxIdleTaskStackBuffer.\r
 413         Note that, as the array is necessarily of type StackType_t,\r
 414         configMINIMAL_STACK_SIZE is specified in words, not bytes. */\r
 415         *pulIdleTaskStackSize = configMINIMAL_STACK_SIZE;\r
 416 }\r
 417 /*-----------------------------------------------------------*/\r
 418 \r
 419 /* configUSE_STATIC_ALLOCATION and configUSE_TIMERS are both set to 1, so the\r
 420 application must provide an implementation of vApplicationGetTimerTaskMemory()\r
 421 to provide the memory that is used by the Timer service task. */\r
 422 void vApplicationGetTimerTaskMemory( StaticTask_t **ppxTimerTaskTCBBuffer, StackType_t **ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize )\r
 423 {\r
 424 /* If the buffers to be provided to the Timer task are declared inside this\r
 425 function then they must be declared static - otherwise they will be allocated on\r
 426 the stack and so not exists after this function exits. */\r
 427 static StaticTask_t xTimerTaskTCB;\r
 428 static StackType_t uxTimerTaskStack[ configTIMER_TASK_STACK_DEPTH ];\r
 429 \r
 430         /* Pass out a pointer to the StaticTask_t structure in which the Timer\r
 431         task's state will be stored. */\r
 432         *ppxTimerTaskTCBBuffer = &xTimerTaskTCB;\r
 433 \r
 434         /* Pass out the array that will be used as the Timer task's stack. */\r
 435         *ppxTimerTaskStackBuffer = uxTimerTaskStack;\r
 436 \r
 437         /* Pass out the size of the array pointed to by *ppxTimerTaskStackBuffer.\r
 438         Note that, as the array is necessarily of type StackType_t,\r
 439         configMINIMAL_STACK_SIZE is specified in words, not bytes. */\r
 440         *pulTimerTaskStackSize = configTIMER_TASK_STACK_DEPTH;\r
 441 }\r
 442 \r
 443 \r