git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/GCC/MicroBlazeV8/port.c

   1 /*\r
   2     FreeRTOS V8.1.2 - Copyright (C) 2014 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /*-----------------------------------------------------------\r
  67  * Implementation of functions defined in portable.h for the MicroBlaze port.\r
  68  *----------------------------------------------------------*/\r
  69 \r
  70 \r
  71 /* Scheduler includes. */\r
  72 #include "FreeRTOS.h"\r
  73 #include "task.h"\r
  74 \r
  75 /* Standard includes. */\r
  76 #include <string.h>\r
  77 \r
  78 /* Hardware includes. */\r
  79 #include <xintc_i.h>\r
  80 #include <xil_exception.h>\r
  81 #include <microblaze_exceptions_g.h>\r
  82 \r
  83 /* Tasks are started with a critical section nesting of 0 - however, prior to\r
  84 the scheduler being commenced interrupts should not be enabled, so the critical\r
  85 nesting variable is initialised to a non-zero value. */\r
  86 #define portINITIAL_NESTING_VALUE       ( 0xff )\r
  87 \r
  88 /* The bit within the MSR register that enabled/disables interrupts. */\r
  89 #define portMSR_IE                                      ( 0x02U )\r
  90 \r
  91 /* If the floating point unit is included in the MicroBlaze build, then the\r
  92 FSR register is saved as part of the task context.  portINITIAL_FSR is the value\r
  93 given to the FSR register when the initial context is set up for a task being\r
  94 created. */\r
  95 #define portINITIAL_FSR                         ( 0U )\r
  96 /*-----------------------------------------------------------*/\r
  97 \r
  98 /*\r
  99  * Initialise the interrupt controller instance.\r
 100  */\r
 101 static int32_t prvInitialiseInterruptController( void );\r
 102 \r
 103 /* Ensure the interrupt controller instance variable is initialised before it is\r
 104  * used, and that the initialisation only happens once.\r
 105  */\r
 106 static int32_t prvEnsureInterruptControllerIsInitialised( void );\r
 107 \r
 108 /*-----------------------------------------------------------*/\r
 109 \r
 110 /* Counts the nesting depth of calls to portENTER_CRITICAL().  Each task\r
 111 maintains its own count, so this variable is saved as part of the task\r
 112 context. */\r
 113 volatile UBaseType_t uxCriticalNesting = portINITIAL_NESTING_VALUE;\r
 114 \r
 115 /* This port uses a separate stack for interrupts.  This prevents the stack of\r
 116 every task needing to be large enough to hold an entire interrupt stack on top\r
 117 of the task stack. */\r
 118 uint32_t *pulISRStack;\r
 119 \r
 120 /* If an interrupt requests a context switch, then ulTaskSwitchRequested will\r
 121 get set to 1.  ulTaskSwitchRequested is inspected just before the main interrupt\r
 122 handler exits.  If, at that time, ulTaskSwitchRequested is set to 1, the kernel\r
 123 will call vTaskSwitchContext() to ensure the task that runs immediately after\r
 124 the interrupt exists is the highest priority task that is able to run.  This is\r
 125 an unusual mechanism, but is used for this port because a single interrupt can\r
 126 cause the servicing of multiple peripherals - and it is inefficient to call\r
 127 vTaskSwitchContext() multiple times as each peripheral is serviced. */\r
 128 volatile uint32_t ulTaskSwitchRequested = 0UL;\r
 129 \r
 130 /* The instance of the interrupt controller used by this port.  This is required\r
 131 by the Xilinx library API functions. */\r
 132 static XIntc xInterruptControllerInstance;\r
 133 \r
 134 /*-----------------------------------------------------------*/\r
 135 \r
 136 /*\r
 137  * Initialise the stack of a task to look exactly as if a call to\r
 138  * portSAVE_CONTEXT had been made.\r
 139  *\r
 140  * See the portable.h header file.\r
 141  */\r
 142 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )\r
 143 {\r
 144 extern void *_SDA2_BASE_, *_SDA_BASE_;\r
 145 const uint32_t ulR2 = ( uint32_t ) &_SDA2_BASE_;\r
 146 const uint32_t ulR13 = ( uint32_t ) &_SDA_BASE_;\r
 147 \r
 148         /* Place a few bytes of known values on the bottom of the stack.\r
 149         This is essential for the Microblaze port and these lines must\r
 150         not be omitted. */\r
 151         *pxTopOfStack = ( StackType_t ) 0x00000000;\r
 152         pxTopOfStack--;\r
 153         *pxTopOfStack = ( StackType_t ) 0x00000000;\r
 154         pxTopOfStack--;\r
 155         *pxTopOfStack = ( StackType_t ) 0x00000000;\r
 156         pxTopOfStack--;\r
 157 \r
 158         #if XPAR_MICROBLAZE_0_USE_FPU == 1\r
 159                 /* The FSR value placed in the initial task context is just 0. */\r
 160                 *pxTopOfStack = portINITIAL_FSR;\r
 161                 pxTopOfStack--;\r
 162         #endif\r
 163 \r
 164         /* The MSR value placed in the initial task context should have interrupts\r
 165         disabled.  Each task will enable interrupts automatically when it enters\r
 166         the running state for the first time. */\r
 167         *pxTopOfStack = mfmsr() & ~portMSR_IE;\r
 168         pxTopOfStack--;\r
 169 \r
 170         /* First stack an initial value for the critical section nesting.  This\r
 171         is initialised to zero. */\r
 172         *pxTopOfStack = ( StackType_t ) 0x00;\r
 173 \r
 174         /* R0 is always zero. */\r
 175         /* R1 is the SP. */\r
 176 \r
 177         /* Place an initial value for all the general purpose registers. */\r
 178         pxTopOfStack--;\r
 179         *pxTopOfStack = ( StackType_t ) ulR2;   /* R2 - read only small data area. */\r
 180         pxTopOfStack--;\r
 181         *pxTopOfStack = ( StackType_t ) 0x03;   /* R3 - return values and temporaries. */\r
 182         pxTopOfStack--;\r
 183         *pxTopOfStack = ( StackType_t ) 0x04;   /* R4 - return values and temporaries. */\r
 184         pxTopOfStack--;\r
 185         *pxTopOfStack = ( StackType_t ) pvParameters;/* R5 contains the function call parameters. */\r
 186 \r
 187         #ifdef portPRE_LOAD_STACK_FOR_DEBUGGING\r
 188                 pxTopOfStack--;\r
 189                 *pxTopOfStack = ( StackType_t ) 0x06;   /* R6 - other parameters and temporaries.  Used as the return address from vPortTaskEntryPoint. */\r
 190                 pxTopOfStack--;\r
 191                 *pxTopOfStack = ( StackType_t ) 0x07;   /* R7 - other parameters and temporaries. */\r
 192                 pxTopOfStack--;\r
 193                 *pxTopOfStack = ( StackType_t ) 0x08;   /* R8 - other parameters and temporaries. */\r
 194                 pxTopOfStack--;\r
 195                 *pxTopOfStack = ( StackType_t ) 0x09;   /* R9 - other parameters and temporaries. */\r
 196                 pxTopOfStack--;\r
 197                 *pxTopOfStack = ( StackType_t ) 0x0a;   /* R10 - other parameters and temporaries. */\r
 198                 pxTopOfStack--;\r
 199                 *pxTopOfStack = ( StackType_t ) 0x0b;   /* R11 - temporaries. */\r
 200                 pxTopOfStack--;\r
 201                 *pxTopOfStack = ( StackType_t ) 0x0c;   /* R12 - temporaries. */\r
 202                 pxTopOfStack--;\r
 203         #else\r
 204                 pxTopOfStack-= 8;\r
 205         #endif\r
 206 \r
 207         *pxTopOfStack = ( StackType_t ) ulR13;  /* R13 - read/write small data area. */\r
 208         pxTopOfStack--;\r
 209         *pxTopOfStack = ( StackType_t ) pxCode; /* R14 - return address for interrupt. */\r
 210         pxTopOfStack--;\r
 211         *pxTopOfStack = ( StackType_t ) NULL;   /* R15 - return address for subroutine. */\r
 212 \r
 213         #ifdef portPRE_LOAD_STACK_FOR_DEBUGGING\r
 214                 pxTopOfStack--;\r
 215                 *pxTopOfStack = ( StackType_t ) 0x10;   /* R16 - return address for trap (debugger). */\r
 216                 pxTopOfStack--;\r
 217                 *pxTopOfStack = ( StackType_t ) 0x11;   /* R17 - return address for exceptions, if configured. */\r
 218                 pxTopOfStack--;\r
 219                 *pxTopOfStack = ( StackType_t ) 0x12;   /* R18 - reserved for assembler and compiler temporaries. */\r
 220                 pxTopOfStack--;\r
 221         #else\r
 222                 pxTopOfStack -= 4;\r
 223         #endif\r
 224 \r
 225         *pxTopOfStack = ( StackType_t ) 0x00;   /* R19 - must be saved across function calls. Callee-save.  Seems to be interpreted as the frame pointer. */\r
 226 \r
 227         #ifdef portPRE_LOAD_STACK_FOR_DEBUGGING\r
 228                 pxTopOfStack--;\r
 229                 *pxTopOfStack = ( StackType_t ) 0x14;   /* R20 - reserved for storing a pointer to the Global Offset Table (GOT) in Position Independent Code (PIC). Non-volatile in non-PIC code. Must be saved across function calls. Callee-save.  Not used by FreeRTOS. */\r
 230                 pxTopOfStack--;\r
 231                 *pxTopOfStack = ( StackType_t ) 0x15;   /* R21 - must be saved across function calls. Callee-save. */\r
 232                 pxTopOfStack--;\r
 233                 *pxTopOfStack = ( StackType_t ) 0x16;   /* R22 - must be saved across function calls. Callee-save. */\r
 234                 pxTopOfStack--;\r
 235                 *pxTopOfStack = ( StackType_t ) 0x17;   /* R23 - must be saved across function calls. Callee-save. */\r
 236                 pxTopOfStack--;\r
 237                 *pxTopOfStack = ( StackType_t ) 0x18;   /* R24 - must be saved across function calls. Callee-save. */\r
 238                 pxTopOfStack--;\r
 239                 *pxTopOfStack = ( StackType_t ) 0x19;   /* R25 - must be saved across function calls. Callee-save. */\r
 240                 pxTopOfStack--;\r
 241                 *pxTopOfStack = ( StackType_t ) 0x1a;   /* R26 - must be saved across function calls. Callee-save. */\r
 242                 pxTopOfStack--;\r
 243                 *pxTopOfStack = ( StackType_t ) 0x1b;   /* R27 - must be saved across function calls. Callee-save. */\r
 244                 pxTopOfStack--;\r
 245                 *pxTopOfStack = ( StackType_t ) 0x1c;   /* R28 - must be saved across function calls. Callee-save. */\r
 246                 pxTopOfStack--;\r
 247                 *pxTopOfStack = ( StackType_t ) 0x1d;   /* R29 - must be saved across function calls. Callee-save. */\r
 248                 pxTopOfStack--;\r
 249                 *pxTopOfStack = ( StackType_t ) 0x1e;   /* R30 - must be saved across function calls. Callee-save. */\r
 250                 pxTopOfStack--;\r
 251                 *pxTopOfStack = ( StackType_t ) 0x1f;   /* R31 - must be saved across function calls. Callee-save. */\r
 252                 pxTopOfStack--;\r
 253         #else\r
 254                 pxTopOfStack -= 13;\r
 255         #endif\r
 256 \r
 257         /* Return a pointer to the top of the stack that has been generated so this\r
 258         can     be stored in the task control block for the task. */\r
 259         return pxTopOfStack;\r
 260 }\r
 261 /*-----------------------------------------------------------*/\r
 262 \r
 263 BaseType_t xPortStartScheduler( void )\r
 264 {\r
 265 extern void ( vPortStartFirstTask )( void );\r
 266 extern uint32_t _stack[];\r
 267 \r
 268         /* Setup the hardware to generate the tick.  Interrupts are disabled when\r
 269         this function is called.\r
 270 \r
 271         This port uses an application defined callback function to install the tick\r
 272         interrupt handler because the kernel will run on lots of different\r
 273         MicroBlaze and FPGA configurations - not all of which will have the same\r
 274         timer peripherals defined or available.  An example definition of\r
 275         vApplicationSetupTimerInterrupt() is provided in the official demo\r
 276         application that accompanies this port. */\r
 277         vApplicationSetupTimerInterrupt();\r
 278 \r
 279         /* Reuse the stack from main() as the stack for the interrupts/exceptions. */\r
 280         pulISRStack = ( uint32_t * ) _stack;\r
 281 \r
 282         /* Ensure there is enough space for the functions called from the interrupt\r
 283         service routines to write back into the stack frame of the caller. */\r
 284         pulISRStack -= 2;\r
 285 \r
 286         /* Restore the context of the first task that is going to run.  From here\r
 287         on, the created tasks will be executing. */\r
 288         vPortStartFirstTask();\r
 289 \r
 290         /* Should not get here as the tasks are now running! */\r
 291         return pdFALSE;\r
 292 }\r
 293 /*-----------------------------------------------------------*/\r
 294 \r
 295 void vPortEndScheduler( void )\r
 296 {\r
 297         /* Not implemented in ports where there is nothing to return to.\r
 298         Artificially force an assert. */\r
 299         configASSERT( uxCriticalNesting == 1000UL );\r
 300 }\r
 301 /*-----------------------------------------------------------*/\r
 302 \r
 303 /*\r
 304  * Manual context switch called by portYIELD or taskYIELD.\r
 305  */\r
 306 void vPortYield( void )\r
 307 {\r
 308 extern void VPortYieldASM( void );\r
 309 \r
 310         /* Perform the context switch in a critical section to assure it is\r
 311         not interrupted by the tick ISR.  It is not a problem to do this as\r
 312         each task maintains its own interrupt status. */\r
 313         portENTER_CRITICAL();\r
 314         {\r
 315                 /* Jump directly to the yield function to ensure there is no\r
 316                 compiler generated prologue code. */\r
 317                 asm volatile (  "bralid r14, VPortYieldASM              \n\t" \\r
 318                                                 "or r0, r0, r0                                  \n\t" );\r
 319         }\r
 320         portEXIT_CRITICAL();\r
 321 }\r
 322 /*-----------------------------------------------------------*/\r
 323 \r
 324 void vPortEnableInterrupt( uint8_t ucInterruptID )\r
 325 {\r
 326 int32_t lReturn;\r
 327 \r
 328         /* An API function is provided to enable an interrupt in the interrupt\r
 329         controller because the interrupt controller instance variable is private\r
 330         to this file. */\r
 331         lReturn = prvEnsureInterruptControllerIsInitialised();\r
 332         if( lReturn == pdPASS )\r
 333         {\r
 334                 XIntc_Enable( &xInterruptControllerInstance, ucInterruptID );\r
 335         }\r
 336 \r
 337         configASSERT( lReturn );\r
 338 }\r
 339 /*-----------------------------------------------------------*/\r
 340 \r
 341 void vPortDisableInterrupt( uint8_t ucInterruptID )\r
 342 {\r
 343 int32_t lReturn;\r
 344 \r
 345         /* An API function is provided to disable an interrupt in the interrupt\r
 346         controller because the interrupt controller instance variable is private\r
 347         to this file. */\r
 348         lReturn = prvEnsureInterruptControllerIsInitialised();\r
 349 \r
 350         if( lReturn == pdPASS )\r
 351         {\r
 352                 XIntc_Disable( &xInterruptControllerInstance, ucInterruptID );\r
 353         }\r
 354 \r
 355         configASSERT( lReturn );\r
 356 }\r
 357 /*-----------------------------------------------------------*/\r
 358 \r
 359 BaseType_t xPortInstallInterruptHandler( uint8_t ucInterruptID, XInterruptHandler pxHandler, void *pvCallBackRef )\r
 360 {\r
 361 int32_t lReturn;\r
 362 \r
 363         /* An API function is provided to install an interrupt handler because the\r
 364         interrupt controller instance variable is private to this file. */\r
 365 \r
 366         lReturn = prvEnsureInterruptControllerIsInitialised();\r
 367 \r
 368         if( lReturn == pdPASS )\r
 369         {\r
 370                 lReturn = XIntc_Connect( &xInterruptControllerInstance, ucInterruptID, pxHandler, pvCallBackRef );\r
 371         }\r
 372 \r
 373         if( lReturn == XST_SUCCESS )\r
 374         {\r
 375                 lReturn = pdPASS;\r
 376         }\r
 377 \r
 378         configASSERT( lReturn == pdPASS );\r
 379 \r
 380         return lReturn;\r
 381 }\r
 382 /*-----------------------------------------------------------*/\r
 383 \r
 384 static int32_t prvEnsureInterruptControllerIsInitialised( void )\r
 385 {\r
 386 static int32_t lInterruptControllerInitialised = pdFALSE;\r
 387 int32_t lReturn;\r
 388 \r
 389         /* Ensure the interrupt controller instance variable is initialised before\r
 390         it is used, and that the initialisation only happens once. */\r
 391         if( lInterruptControllerInitialised != pdTRUE )\r
 392         {\r
 393                 lReturn = prvInitialiseInterruptController();\r
 394 \r
 395                 if( lReturn == pdPASS )\r
 396                 {\r
 397                         lInterruptControllerInitialised = pdTRUE;\r
 398                 }\r
 399         }\r
 400         else\r
 401         {\r
 402                 lReturn = pdPASS;\r
 403         }\r
 404 \r
 405         return lReturn;\r
 406 }\r
 407 /*-----------------------------------------------------------*/\r
 408 \r
 409 /*\r
 410  * Handler for the timer interrupt.  This is the handler that the application\r
 411  * defined callback function vApplicationSetupTimerInterrupt() should install.\r
 412  */\r
 413 void vPortTickISR( void *pvUnused )\r
 414 {\r
 415 extern void vApplicationClearTimerInterrupt( void );\r
 416 \r
 417         /* Ensure the unused parameter does not generate a compiler warning. */\r
 418         ( void ) pvUnused;\r
 419 \r
 420         /* This port uses an application defined callback function to clear the tick\r
 421         interrupt because the kernel will run on lots of different MicroBlaze and\r
 422         FPGA configurations - not all of which will have the same timer peripherals\r
 423         defined or available.  An example definition of\r
 424         vApplicationClearTimerInterrupt() is provided in the official demo\r
 425         application that accompanies this port. */\r
 426         vApplicationClearTimerInterrupt();\r
 427 \r
 428         /* Increment the RTOS tick - this might cause a task to unblock. */\r
 429         if( xTaskIncrementTick() != pdFALSE )\r
 430         {\r
 431                 /* Force vTaskSwitchContext() to be called as the interrupt exits. */\r
 432                 ulTaskSwitchRequested = 1;\r
 433         }\r
 434 }\r
 435 /*-----------------------------------------------------------*/\r
 436 \r
 437 static int32_t prvInitialiseInterruptController( void )\r
 438 {\r
 439 int32_t lStatus;\r
 440 \r
 441         lStatus = XIntc_Initialize( &xInterruptControllerInstance, configINTERRUPT_CONTROLLER_TO_USE );\r
 442 \r
 443         if( lStatus == XST_SUCCESS )\r
 444         {\r
 445                 /* Initialise the exception table. */\r
 446                 Xil_ExceptionInit();\r
 447 \r
 448             /* Service all pending interrupts each time the handler is entered. */\r
 449             XIntc_SetIntrSvcOption( xInterruptControllerInstance.BaseAddress, XIN_SVC_ALL_ISRS_OPTION );\r
 450 \r
 451             /* Install exception handlers if the MicroBlaze is configured to handle\r
 452             exceptions, and the application defined constant\r
 453             configINSTALL_EXCEPTION_HANDLERS is set to 1. */\r
 454                 #if ( MICROBLAZE_EXCEPTIONS_ENABLED == 1 ) && ( configINSTALL_EXCEPTION_HANDLERS == 1 )\r
 455             {\r
 456                 vPortExceptionsInstallHandlers();\r
 457             }\r
 458                 #endif /* MICROBLAZE_EXCEPTIONS_ENABLED */\r
 459 \r
 460                 /* Start the interrupt controller.  Interrupts are enabled when the\r
 461                 scheduler starts. */\r
 462                 lStatus = XIntc_Start( &xInterruptControllerInstance, XIN_REAL_MODE );\r
 463 \r
 464                 if( lStatus == XST_SUCCESS )\r
 465                 {\r
 466                         lStatus = pdPASS;\r
 467                 }\r
 468                 else\r
 469                 {\r
 470                         lStatus = pdFAIL;\r
 471                 }\r
 472         }\r
 473 \r
 474         configASSERT( lStatus == pdPASS );\r
 475 \r
 476         return lStatus;\r
 477 }\r
 478 /*-----------------------------------------------------------*/\r
 479 \r
 480 \r