begriffs open source - freertos/blob - portable/GCC/MicroBlazeV8/port.c

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