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

   1 /*\r
   2  * FreeRTOS Kernel V10.3.0\r
   3  * Copyright (C) 2020 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  * Implementation of functions defined in portable.h for the MicroBlaze port.\r
  30  *----------------------------------------------------------*/\r
  31 \r
  32 \r
  33 /* Scheduler includes. */\r
  34 #include "FreeRTOS.h"\r
  35 #include "task.h"\r
  36 \r
  37 /* Standard includes. */\r
  38 #include <string.h>\r
  39 \r
  40 /* Hardware includes. */\r
  41 #include <xintc_i.h>\r
  42 #include <xil_exception.h>\r
  43 #include <microblaze_exceptions_g.h>\r
  44 \r
  45 /* Tasks are started with a critical section nesting of 0 - however, prior to\r
  46 the scheduler being commenced interrupts should not be enabled, so the critical\r
  47 nesting variable is initialised to a non-zero value. */\r
  48 #define portINITIAL_NESTING_VALUE       ( 0xff )\r
  49 \r
  50 /* The bit within the MSR register that enabled/disables interrupts and \r
  51 exceptions respectively. */\r
  52 #define portMSR_IE                                      ( 0x02U )\r
  53 #define portMSR_EE                                      ( 0x100U )\r
  54 \r
  55 /* If the floating point unit is included in the MicroBlaze build, then the\r
  56 FSR register is saved as part of the task context.  portINITIAL_FSR is the value\r
  57 given to the FSR register when the initial context is set up for a task being\r
  58 created. */\r
  59 #define portINITIAL_FSR                         ( 0U )\r
  60 /*-----------------------------------------------------------*/\r
  61 \r
  62 /*\r
  63  * Initialise the interrupt controller instance.\r
  64  */\r
  65 static int32_t prvInitialiseInterruptController( void );\r
  66 \r
  67 /* Ensure the interrupt controller instance variable is initialised before it is\r
  68  * used, and that the initialisation only happens once.\r
  69  */\r
  70 static int32_t prvEnsureInterruptControllerIsInitialised( void );\r
  71 \r
  72 /*-----------------------------------------------------------*/\r
  73 \r
  74 /* Counts the nesting depth of calls to portENTER_CRITICAL().  Each task\r
  75 maintains its own count, so this variable is saved as part of the task\r
  76 context. */\r
  77 volatile UBaseType_t uxCriticalNesting = portINITIAL_NESTING_VALUE;\r
  78 \r
  79 /* This port uses a separate stack for interrupts.  This prevents the stack of\r
  80 every task needing to be large enough to hold an entire interrupt stack on top\r
  81 of the task stack. */\r
  82 uint32_t *pulISRStack;\r
  83 \r
  84 /* If an interrupt requests a context switch, then ulTaskSwitchRequested will\r
  85 get set to 1.  ulTaskSwitchRequested is inspected just before the main interrupt\r
  86 handler exits.  If, at that time, ulTaskSwitchRequested is set to 1, the kernel\r
  87 will call vTaskSwitchContext() to ensure the task that runs immediately after\r
  88 the interrupt exists is the highest priority task that is able to run.  This is\r
  89 an unusual mechanism, but is used for this port because a single interrupt can\r
  90 cause the servicing of multiple peripherals - and it is inefficient to call\r
  91 vTaskSwitchContext() multiple times as each peripheral is serviced. */\r
  92 volatile uint32_t ulTaskSwitchRequested = 0UL;\r
  93 \r
  94 /* The instance of the interrupt controller used by this port.  This is required\r
  95 by the Xilinx library API functions. */\r
  96 static XIntc xInterruptControllerInstance;\r
  97 \r
  98 /*-----------------------------------------------------------*/\r
  99 \r
 100 /*\r
 101  * Initialise the stack of a task to look exactly as if a call to\r
 102  * portSAVE_CONTEXT had been made.\r
 103  *\r
 104  * See the portable.h header file.\r
 105  */\r
 106 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )\r
 107 {\r
 108 extern void *_SDA2_BASE_, *_SDA_BASE_;\r
 109 const uint32_t ulR2 = ( uint32_t ) &_SDA2_BASE_;\r
 110 const uint32_t ulR13 = ( uint32_t ) &_SDA_BASE_;\r
 111 \r
 112         /* Place a few bytes of known values on the bottom of the stack.\r
 113         This is essential for the Microblaze port and these lines must\r
 114         not be omitted. */\r
 115         *pxTopOfStack = ( StackType_t ) 0x00000000;\r
 116         pxTopOfStack--;\r
 117         *pxTopOfStack = ( StackType_t ) 0x00000000;\r
 118         pxTopOfStack--;\r
 119         *pxTopOfStack = ( StackType_t ) 0x00000000;\r
 120         pxTopOfStack--;\r
 121 \r
 122         #if( XPAR_MICROBLAZE_USE_FPU != 0 )\r
 123                 /* The FSR value placed in the initial task context is just 0. */\r
 124                 *pxTopOfStack = portINITIAL_FSR;\r
 125                 pxTopOfStack--;\r
 126         #endif\r
 127 \r
 128         /* The MSR value placed in the initial task context should have interrupts\r
 129         disabled.  Each task will enable interrupts automatically when it enters\r
 130         the running state for the first time. */\r
 131         *pxTopOfStack = mfmsr() & ~portMSR_IE;\r
 132         \r
 133         #if( MICROBLAZE_EXCEPTIONS_ENABLED == 1 )\r
 134         {\r
 135                 /* Ensure exceptions are enabled for the task. */\r
 136                 *pxTopOfStack |= portMSR_EE;\r
 137         }\r
 138         #endif\r
 139 \r
 140         pxTopOfStack--;\r
 141 \r
 142         /* First stack an initial value for the critical section nesting.  This\r
 143         is initialised to zero. */\r
 144         *pxTopOfStack = ( StackType_t ) 0x00;\r
 145 \r
 146         /* R0 is always zero. */\r
 147         /* R1 is the SP. */\r
 148 \r
 149         /* Place an initial value for all the general purpose registers. */\r
 150         pxTopOfStack--;\r
 151         *pxTopOfStack = ( StackType_t ) ulR2;   /* R2 - read only small data area. */\r
 152         pxTopOfStack--;\r
 153         *pxTopOfStack = ( StackType_t ) 0x03;   /* R3 - return values and temporaries. */\r
 154         pxTopOfStack--;\r
 155         *pxTopOfStack = ( StackType_t ) 0x04;   /* R4 - return values and temporaries. */\r
 156         pxTopOfStack--;\r
 157         *pxTopOfStack = ( StackType_t ) pvParameters;/* R5 contains the function call parameters. */\r
 158 \r
 159         #ifdef portPRE_LOAD_STACK_FOR_DEBUGGING\r
 160                 pxTopOfStack--;\r
 161                 *pxTopOfStack = ( StackType_t ) 0x06;   /* R6 - other parameters and temporaries.  Used as the return address from vPortTaskEntryPoint. */\r
 162                 pxTopOfStack--;\r
 163                 *pxTopOfStack = ( StackType_t ) 0x07;   /* R7 - other parameters and temporaries. */\r
 164                 pxTopOfStack--;\r
 165                 *pxTopOfStack = ( StackType_t ) 0x08;   /* R8 - other parameters and temporaries. */\r
 166                 pxTopOfStack--;\r
 167                 *pxTopOfStack = ( StackType_t ) 0x09;   /* R9 - other parameters and temporaries. */\r
 168                 pxTopOfStack--;\r
 169                 *pxTopOfStack = ( StackType_t ) 0x0a;   /* R10 - other parameters and temporaries. */\r
 170                 pxTopOfStack--;\r
 171                 *pxTopOfStack = ( StackType_t ) 0x0b;   /* R11 - temporaries. */\r
 172                 pxTopOfStack--;\r
 173                 *pxTopOfStack = ( StackType_t ) 0x0c;   /* R12 - temporaries. */\r
 174                 pxTopOfStack--;\r
 175         #else\r
 176                 pxTopOfStack-= 8;\r
 177         #endif\r
 178 \r
 179         *pxTopOfStack = ( StackType_t ) ulR13;  /* R13 - read/write small data area. */\r
 180         pxTopOfStack--;\r
 181         *pxTopOfStack = ( StackType_t ) pxCode; /* R14 - return address for interrupt. */\r
 182         pxTopOfStack--;\r
 183         *pxTopOfStack = ( StackType_t ) NULL;   /* R15 - return address for subroutine. */\r
 184 \r
 185         #ifdef portPRE_LOAD_STACK_FOR_DEBUGGING\r
 186                 pxTopOfStack--;\r
 187                 *pxTopOfStack = ( StackType_t ) 0x10;   /* R16 - return address for trap (debugger). */\r
 188                 pxTopOfStack--;\r
 189                 *pxTopOfStack = ( StackType_t ) 0x11;   /* R17 - return address for exceptions, if configured. */\r
 190                 pxTopOfStack--;\r
 191                 *pxTopOfStack = ( StackType_t ) 0x12;   /* R18 - reserved for assembler and compiler temporaries. */\r
 192                 pxTopOfStack--;\r
 193         #else\r
 194                 pxTopOfStack -= 4;\r
 195         #endif\r
 196 \r
 197         *pxTopOfStack = ( StackType_t ) 0x00;   /* R19 - must be saved across function calls. Callee-save.  Seems to be interpreted as the frame pointer. */\r
 198 \r
 199         #ifdef portPRE_LOAD_STACK_FOR_DEBUGGING\r
 200                 pxTopOfStack--;\r
 201                 *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
 202                 pxTopOfStack--;\r
 203                 *pxTopOfStack = ( StackType_t ) 0x15;   /* R21 - must be saved across function calls. Callee-save. */\r
 204                 pxTopOfStack--;\r
 205                 *pxTopOfStack = ( StackType_t ) 0x16;   /* R22 - must be saved across function calls. Callee-save. */\r
 206                 pxTopOfStack--;\r
 207                 *pxTopOfStack = ( StackType_t ) 0x17;   /* R23 - must be saved across function calls. Callee-save. */\r
 208                 pxTopOfStack--;\r
 209                 *pxTopOfStack = ( StackType_t ) 0x18;   /* R24 - must be saved across function calls. Callee-save. */\r
 210                 pxTopOfStack--;\r
 211                 *pxTopOfStack = ( StackType_t ) 0x19;   /* R25 - must be saved across function calls. Callee-save. */\r
 212                 pxTopOfStack--;\r
 213                 *pxTopOfStack = ( StackType_t ) 0x1a;   /* R26 - must be saved across function calls. Callee-save. */\r
 214                 pxTopOfStack--;\r
 215                 *pxTopOfStack = ( StackType_t ) 0x1b;   /* R27 - must be saved across function calls. Callee-save. */\r
 216                 pxTopOfStack--;\r
 217                 *pxTopOfStack = ( StackType_t ) 0x1c;   /* R28 - must be saved across function calls. Callee-save. */\r
 218                 pxTopOfStack--;\r
 219                 *pxTopOfStack = ( StackType_t ) 0x1d;   /* R29 - must be saved across function calls. Callee-save. */\r
 220                 pxTopOfStack--;\r
 221                 *pxTopOfStack = ( StackType_t ) 0x1e;   /* R30 - must be saved across function calls. Callee-save. */\r
 222                 pxTopOfStack--;\r
 223                 *pxTopOfStack = ( StackType_t ) 0x1f;   /* R31 - must be saved across function calls. Callee-save. */\r
 224                 pxTopOfStack--;\r
 225         #else\r
 226                 pxTopOfStack -= 13;\r
 227         #endif\r
 228 \r
 229         /* Return a pointer to the top of the stack that has been generated so this\r
 230         can     be stored in the task control block for the task. */\r
 231         return pxTopOfStack;\r
 232 }\r
 233 /*-----------------------------------------------------------*/\r
 234 \r
 235 BaseType_t xPortStartScheduler( void )\r
 236 {\r
 237 extern void ( vPortStartFirstTask )( void );\r
 238 extern uint32_t _stack[];\r
 239 \r
 240         /* Setup the hardware to generate the tick.  Interrupts are disabled when\r
 241         this function is called.\r
 242 \r
 243         This port uses an application defined callback function to install the tick\r
 244         interrupt handler because the kernel will run on lots of different\r
 245         MicroBlaze and FPGA configurations - not all of which will have the same\r
 246         timer peripherals defined or available.  An example definition of\r
 247         vApplicationSetupTimerInterrupt() is provided in the official demo\r
 248         application that accompanies this port. */\r
 249         vApplicationSetupTimerInterrupt();\r
 250 \r
 251         /* Reuse the stack from main() as the stack for the interrupts/exceptions. */\r
 252         pulISRStack = ( uint32_t * ) _stack;\r
 253 \r
 254         /* Ensure there is enough space for the functions called from the interrupt\r
 255         service routines to write back into the stack frame of the caller. */\r
 256         pulISRStack -= 2;\r
 257 \r
 258         /* Restore the context of the first task that is going to run.  From here\r
 259         on, the created tasks will be executing. */\r
 260         vPortStartFirstTask();\r
 261 \r
 262         /* Should not get here as the tasks are now running! */\r
 263         return pdFALSE;\r
 264 }\r
 265 /*-----------------------------------------------------------*/\r
 266 \r
 267 void vPortEndScheduler( void )\r
 268 {\r
 269         /* Not implemented in ports where there is nothing to return to.\r
 270         Artificially force an assert. */\r
 271         configASSERT( uxCriticalNesting == 1000UL );\r
 272 }\r
 273 /*-----------------------------------------------------------*/\r
 274 \r
 275 /*\r
 276  * Manual context switch called by portYIELD or taskYIELD.\r
 277  */\r
 278 void vPortYield( void )\r
 279 {\r
 280 extern void VPortYieldASM( void );\r
 281 \r
 282         /* Perform the context switch in a critical section to assure it is\r
 283         not interrupted by the tick ISR.  It is not a problem to do this as\r
 284         each task maintains its own interrupt status. */\r
 285         portENTER_CRITICAL();\r
 286         {\r
 287                 /* Jump directly to the yield function to ensure there is no\r
 288                 compiler generated prologue code. */\r
 289                 asm volatile (  "bralid r14, VPortYieldASM              \n\t" \\r
 290                                                 "or r0, r0, r0                                  \n\t" );\r
 291         }\r
 292         portEXIT_CRITICAL();\r
 293 }\r
 294 /*-----------------------------------------------------------*/\r
 295 \r
 296 void vPortEnableInterrupt( uint8_t ucInterruptID )\r
 297 {\r
 298 int32_t lReturn;\r
 299 \r
 300         /* An API function is provided to enable an interrupt in the interrupt\r
 301         controller because the interrupt controller instance variable is private\r
 302         to this file. */\r
 303         lReturn = prvEnsureInterruptControllerIsInitialised();\r
 304         if( lReturn == pdPASS )\r
 305         {\r
 306                 XIntc_Enable( &xInterruptControllerInstance, ucInterruptID );\r
 307         }\r
 308 \r
 309         configASSERT( lReturn );\r
 310 }\r
 311 /*-----------------------------------------------------------*/\r
 312 \r
 313 void vPortDisableInterrupt( uint8_t ucInterruptID )\r
 314 {\r
 315 int32_t lReturn;\r
 316 \r
 317         /* An API function is provided to disable an interrupt in the interrupt\r
 318         controller because the interrupt controller instance variable is private\r
 319         to this file. */\r
 320         lReturn = prvEnsureInterruptControllerIsInitialised();\r
 321 \r
 322         if( lReturn == pdPASS )\r
 323         {\r
 324                 XIntc_Disable( &xInterruptControllerInstance, ucInterruptID );\r
 325         }\r
 326 \r
 327         configASSERT( lReturn );\r
 328 }\r
 329 /*-----------------------------------------------------------*/\r
 330 \r
 331 BaseType_t xPortInstallInterruptHandler( uint8_t ucInterruptID, XInterruptHandler pxHandler, void *pvCallBackRef )\r
 332 {\r
 333 int32_t lReturn;\r
 334 \r
 335         /* An API function is provided to install an interrupt handler because the\r
 336         interrupt controller instance variable is private to this file. */\r
 337 \r
 338         lReturn = prvEnsureInterruptControllerIsInitialised();\r
 339 \r
 340         if( lReturn == pdPASS )\r
 341         {\r
 342                 lReturn = XIntc_Connect( &xInterruptControllerInstance, ucInterruptID, pxHandler, pvCallBackRef );\r
 343         }\r
 344 \r
 345         if( lReturn == XST_SUCCESS )\r
 346         {\r
 347                 lReturn = pdPASS;\r
 348         }\r
 349 \r
 350         configASSERT( lReturn == pdPASS );\r
 351 \r
 352         return lReturn;\r
 353 }\r
 354 /*-----------------------------------------------------------*/\r
 355 \r
 356 static int32_t prvEnsureInterruptControllerIsInitialised( void )\r
 357 {\r
 358 static int32_t lInterruptControllerInitialised = pdFALSE;\r
 359 int32_t lReturn;\r
 360 \r
 361         /* Ensure the interrupt controller instance variable is initialised before\r
 362         it is used, and that the initialisation only happens once. */\r
 363         if( lInterruptControllerInitialised != pdTRUE )\r
 364         {\r
 365                 lReturn = prvInitialiseInterruptController();\r
 366 \r
 367                 if( lReturn == pdPASS )\r
 368                 {\r
 369                         lInterruptControllerInitialised = pdTRUE;\r
 370                 }\r
 371         }\r
 372         else\r
 373         {\r
 374                 lReturn = pdPASS;\r
 375         }\r
 376 \r
 377         return lReturn;\r
 378 }\r
 379 /*-----------------------------------------------------------*/\r
 380 \r
 381 /*\r
 382  * Handler for the timer interrupt.  This is the handler that the application\r
 383  * defined callback function vApplicationSetupTimerInterrupt() should install.\r
 384  */\r
 385 void vPortTickISR( void *pvUnused )\r
 386 {\r
 387 extern void vApplicationClearTimerInterrupt( void );\r
 388 \r
 389         /* Ensure the unused parameter does not generate a compiler warning. */\r
 390         ( void ) pvUnused;\r
 391 \r
 392         /* This port uses an application defined callback function to clear the tick\r
 393         interrupt because the kernel will run on lots of different MicroBlaze and\r
 394         FPGA configurations - not all of which will have the same timer peripherals\r
 395         defined or available.  An example definition of\r
 396         vApplicationClearTimerInterrupt() is provided in the official demo\r
 397         application that accompanies this port. */\r
 398         vApplicationClearTimerInterrupt();\r
 399 \r
 400         /* Increment the RTOS tick - this might cause a task to unblock. */\r
 401         if( xTaskIncrementTick() != pdFALSE )\r
 402         {\r
 403                 /* Force vTaskSwitchContext() to be called as the interrupt exits. */\r
 404                 ulTaskSwitchRequested = 1;\r
 405         }\r
 406 }\r
 407 /*-----------------------------------------------------------*/\r
 408 \r
 409 static int32_t prvInitialiseInterruptController( void )\r
 410 {\r
 411 int32_t lStatus;\r
 412 \r
 413         lStatus = XIntc_Initialize( &xInterruptControllerInstance, configINTERRUPT_CONTROLLER_TO_USE );\r
 414 \r
 415         if( lStatus == XST_SUCCESS )\r
 416         {\r
 417                 /* Initialise the exception table. */\r
 418                 Xil_ExceptionInit();\r
 419 \r
 420             /* Service all pending interrupts each time the handler is entered. */\r
 421             XIntc_SetIntrSvcOption( xInterruptControllerInstance.BaseAddress, XIN_SVC_ALL_ISRS_OPTION );\r
 422 \r
 423             /* Install exception handlers if the MicroBlaze is configured to handle\r
 424             exceptions, and the application defined constant\r
 425             configINSTALL_EXCEPTION_HANDLERS is set to 1. */\r
 426                 #if ( MICROBLAZE_EXCEPTIONS_ENABLED == 1 ) && ( configINSTALL_EXCEPTION_HANDLERS == 1 )\r
 427             {\r
 428                 vPortExceptionsInstallHandlers();\r
 429             }\r
 430                 #endif /* MICROBLAZE_EXCEPTIONS_ENABLED */\r
 431 \r
 432                 /* Start the interrupt controller.  Interrupts are enabled when the\r
 433                 scheduler starts. */\r
 434                 lStatus = XIntc_Start( &xInterruptControllerInstance, XIN_REAL_MODE );\r
 435 \r
 436                 if( lStatus == XST_SUCCESS )\r
 437                 {\r
 438                         lStatus = pdPASS;\r
 439                 }\r
 440                 else\r
 441                 {\r
 442                         lStatus = pdFAIL;\r
 443                 }\r
 444         }\r
 445 \r
 446         configASSERT( lStatus == pdPASS );\r
 447 \r
 448         return lStatus;\r
 449 }\r
 450 /*-----------------------------------------------------------*/\r
 451 \r
 452 \r