git.sur5r.net Git - freertos/blob

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