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

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