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.h>\r
  68 #include <xintc_i.h>\r
  69 #include <xtmrctr.h>\r
  70 #include <xil_exception.h>\r
  71 #include <mb_interface.h>\r
  72 \r
  73 /* Tasks are started with a critical section nesting of 0 - however prior\r
  74 to the scheduler being commenced we don't want the critical nesting level\r
  75 to reach zero, so it is initialised to a high value. */\r
  76 #define portINITIAL_NESTING_VALUE       ( 0xff )\r
  77 \r
  78 /* The bit within the MSR register that enabled/disables interrupts. */\r
  79 #define portMSR_IE                                      ( 0x02U )\r
  80 \r
  81 /*-----------------------------------------------------------*/\r
  82 \r
  83 /*\r
  84  * Initialise the interrupt controller instance.\r
  85  */\r
  86 static portBASE_TYPE prvInitialiseInterruptController( void );\r
  87 \r
  88 /*\r
  89  * Call an application provided callback to set up the periodic interrupt used\r
  90  * for the RTOS tick.  Using an application callback allows the application\r
  91  * writer to decide\r
  92  */\r
  93 extern void vApplicationSetupTimerInterrupt( void );\r
  94 /*-----------------------------------------------------------*/\r
  95 \r
  96 /* Counts the nesting depth of calls to portENTER_CRITICAL().  Each task \r
  97 maintains it's own count, so this variable is saved as part of the task\r
  98 context. */\r
  99 volatile unsigned portBASE_TYPE uxCriticalNesting = portINITIAL_NESTING_VALUE;\r
 100 \r
 101 /* To limit the amount of stack required by each task, this port uses a\r
 102 separate stack for interrupts. */\r
 103 unsigned long *pulISRStack;\r
 104 \r
 105 /* The instance of the interrupt controller used by this port. */\r
 106 static XIntc xInterruptControllerInstance;\r
 107 \r
 108 /*-----------------------------------------------------------*/\r
 109 \r
 110 /* \r
 111  * Initialise the stack of a task to look exactly as if a call to \r
 112  * portSAVE_CONTEXT had been made.\r
 113  * \r
 114  * See the header file portable.h.\r
 115  */\r
 116 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
 117 {\r
 118 extern void *_SDA2_BASE_, *_SDA_BASE_;\r
 119 const unsigned long ulR2 = ( unsigned long ) &_SDA2_BASE_;\r
 120 const unsigned long ulR13 = ( unsigned long ) &_SDA_BASE_;\r
 121 \r
 122         /* Place a few bytes of known values on the bottom of the stack. \r
 123         This is essential for the Microblaze port and these lines must\r
 124         not be omitted.  The parameter value will overwrite the \r
 125         0x22222222 value during the function prologue. */\r
 126         *pxTopOfStack = ( portSTACK_TYPE ) 0x11111111;\r
 127         pxTopOfStack--;\r
 128         *pxTopOfStack = ( portSTACK_TYPE ) 0x22222222;\r
 129         pxTopOfStack--;\r
 130         *pxTopOfStack = ( portSTACK_TYPE ) 0x33333333;\r
 131         pxTopOfStack--; \r
 132 \r
 133         /* The debugger will look at the previous stack frame. */\r
 134         *pxTopOfStack = ( portSTACK_TYPE ) 0x00000000;\r
 135         pxTopOfStack--;\r
 136         *pxTopOfStack = ( portSTACK_TYPE ) 0x00000000;\r
 137         pxTopOfStack--;\r
 138         *pxTopOfStack = ( portSTACK_TYPE ) 0x00000000;\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 = ( portSTACK_TYPE ) 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 = ( portSTACK_TYPE ) ulR2;        /* R2 - read only small data area. */\r
 151         pxTopOfStack--;\r
 152         *pxTopOfStack = ( portSTACK_TYPE ) 0x03;        /* R3 - return values and temporaries. */\r
 153         pxTopOfStack--;\r
 154         *pxTopOfStack = ( portSTACK_TYPE ) 0x04;        /* R4 - return values and temporaries. */\r
 155         pxTopOfStack--;\r
 156         *pxTopOfStack = ( portSTACK_TYPE ) pvParameters;/* R5 contains the function call parameters. */\r
 157         pxTopOfStack--;\r
 158         *pxTopOfStack = ( portSTACK_TYPE ) 0x06;        /* R6 - other parameters and temporaries.  Used as the return address from vPortTaskEntryPoint. */\r
 159         pxTopOfStack--;\r
 160         *pxTopOfStack = ( portSTACK_TYPE ) 0x07;        /* R7 - other parameters and temporaries. */\r
 161         pxTopOfStack--;\r
 162         *pxTopOfStack = ( portSTACK_TYPE ) 0x08;        /* R8 - other parameters and temporaries. */\r
 163         pxTopOfStack--;\r
 164         *pxTopOfStack = ( portSTACK_TYPE ) 0x09;        /* R9 - other parameters and temporaries. */\r
 165         pxTopOfStack--;\r
 166         *pxTopOfStack = ( portSTACK_TYPE ) 0x0a;        /* R10 - other parameters and temporaries. */\r
 167         pxTopOfStack--;\r
 168         *pxTopOfStack = ( portSTACK_TYPE ) 0x0b;        /* R11 - temporaries. */\r
 169         pxTopOfStack--;\r
 170         *pxTopOfStack = ( portSTACK_TYPE ) 0x0c;        /* R12 - temporaries. */\r
 171         pxTopOfStack--;\r
 172         *pxTopOfStack = ( portSTACK_TYPE ) ulR13;       /* R13 - read/write small data area. */\r
 173         pxTopOfStack--;\r
 174         *pxTopOfStack = ( portSTACK_TYPE ) pxCode;      /* R14 - return address for interrupt. */\r
 175         pxTopOfStack--;\r
 176         *pxTopOfStack = ( portSTACK_TYPE ) NULL;        /* R15 - return address for subroutine. */\r
 177         pxTopOfStack--;\r
 178         *pxTopOfStack = ( portSTACK_TYPE ) 0x10;        /* R16 - return address for trap (debugger). */\r
 179         pxTopOfStack--;\r
 180         *pxTopOfStack = ( portSTACK_TYPE ) 0x11;        /* R17 - return address for exceptions, if configured. */\r
 181         pxTopOfStack--;\r
 182         *pxTopOfStack = ( portSTACK_TYPE ) 0x12;        /* R18 - reserved for assembler and compiler temporaries. */\r
 183         pxTopOfStack--;\r
 184         *pxTopOfStack = ( portSTACK_TYPE ) 0x00;        /* R19 - must be saved across function calls. Callee-save.  Seems to be interpreted as the frame pointer. */\r
 185         pxTopOfStack--;\r
 186         *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
 187         pxTopOfStack--;\r
 188         *pxTopOfStack = ( portSTACK_TYPE ) 0x15;        /* R21 - must be saved across function calls. Callee-save. */\r
 189         pxTopOfStack--;\r
 190         *pxTopOfStack = ( portSTACK_TYPE ) 0x16;        /* R22 - must be saved across function calls. Callee-save. */\r
 191         pxTopOfStack--;\r
 192         *pxTopOfStack = ( portSTACK_TYPE ) 0x17;        /* R23 - must be saved across function calls. Callee-save. */\r
 193         pxTopOfStack--;\r
 194         *pxTopOfStack = ( portSTACK_TYPE ) 0x18;        /* R24 - must be saved across function calls. Callee-save. */\r
 195         pxTopOfStack--;\r
 196         *pxTopOfStack = ( portSTACK_TYPE ) 0x19;        /* R25 - must be saved across function calls. Callee-save. */\r
 197         pxTopOfStack--;\r
 198         *pxTopOfStack = ( portSTACK_TYPE ) 0x1a;        /* R26 - must be saved across function calls. Callee-save. */\r
 199         pxTopOfStack--;\r
 200         *pxTopOfStack = ( portSTACK_TYPE ) 0x1b;        /* R27 - must be saved across function calls. Callee-save. */\r
 201         pxTopOfStack--;\r
 202         *pxTopOfStack = ( portSTACK_TYPE ) 0x1c;        /* R28 - must be saved across function calls. Callee-save. */\r
 203         pxTopOfStack--;\r
 204         *pxTopOfStack = ( portSTACK_TYPE ) 0x1d;        /* R29 - must be saved across function calls. Callee-save. */\r
 205         pxTopOfStack--;\r
 206         *pxTopOfStack = ( portSTACK_TYPE ) 0x1e;        /* R30 - must be saved across function calls. Callee-save. */\r
 207         pxTopOfStack--;\r
 208 \r
 209         /* The MSR is stacked between R30 and R31.  This should have interrupts\r
 210         disabled.  Each task will enable interrupts automatically when it enters\r
 211         the running state for the first time. */\r
 212         *pxTopOfStack = mfmsr() & ~portMSR_IE;\r
 213         pxTopOfStack--;\r
 214 \r
 215         *pxTopOfStack = ( portSTACK_TYPE ) 0x1f;        /* R31 - must be saved across function calls. Callee-save. */\r
 216         pxTopOfStack--;\r
 217 \r
 218         /* Return a pointer to the top of the stack we have generated so this can\r
 219         be stored in the task control block for the task. */\r
 220         return pxTopOfStack;\r
 221 }\r
 222 /*-----------------------------------------------------------*/\r
 223 \r
 224 portBASE_TYPE xPortStartScheduler( void )\r
 225 {\r
 226 extern void ( vPortStartFirstTask )( void );\r
 227 extern unsigned long _stack[];\r
 228 \r
 229         /* Setup the hardware to generate the tick.  Interrupts are disabled when\r
 230         this function is called. */\r
 231         vApplicationSetupTimerInterrupt();\r
 232 \r
 233         /* Reuse the stack from main as the stack for the interrupts/exceptions.\r
 234         The value is adjusted slightly to allow functions called from the\r
 235         interrupts/exceptions to write back into the stack of the interrupt/\r
 236         exception function itself. */\r
 237         pulISRStack = ( unsigned long * ) _stack;\r
 238         pulISRStack -= 2;\r
 239 \r
 240         /* Restore the context of the first task that is going to run.  From here\r
 241         on, the created tasks will be executing. */\r
 242         vPortStartFirstTask();\r
 243 \r
 244         /* Should not get here as the tasks are now running! */\r
 245         return pdFALSE;\r
 246 }\r
 247 /*-----------------------------------------------------------*/\r
 248 \r
 249 void vPortEndScheduler( void )\r
 250 {\r
 251         /* Not implemented. */\r
 252 }\r
 253 /*-----------------------------------------------------------*/\r
 254 \r
 255 /*\r
 256  * Manual context switch called by portYIELD or taskYIELD.  \r
 257  */\r
 258 void vPortYield( void )\r
 259 {\r
 260 extern void VPortYieldASM( void );\r
 261 \r
 262         /* Perform the context switch in a critical section to assure it is\r
 263         not interrupted by the tick ISR.  It is not a problem to do this as\r
 264         each task maintains it's own interrupt status. */\r
 265         portENTER_CRITICAL();\r
 266         {\r
 267                 /* Jump directly to the yield function to ensure there is no\r
 268                 compiler generated prologue code. */\r
 269                 asm volatile (  "bralid r14, VPortYieldASM              \n\t" \\r
 270                                                 "or r0, r0, r0                                  \n\t" );\r
 271         }\r
 272         portEXIT_CRITICAL();\r
 273 }\r
 274 /*-----------------------------------------------------------*/\r
 275 \r
 276 /*\r
 277  * The task context has already been saved when this is called.\r
 278  *\r
 279  * This handler determines the interrupt source and calls the relevant \r
 280  * peripheral handler.\r
 281  */\r
 282 void vTaskISRHandler( void )\r
 283 {\r
 284 static unsigned long ulPending;    \r
 285 static XIntc_VectorTableEntry *pxTablePtr;\r
 286 static XIntc_Config *pxConfig;\r
 287 static unsigned long ulInterruptMask;\r
 288 \r
 289         /* Which interrupts are pending? */\r
 290         ulPending = XIntc_In32( ( XPAR_INTC_SINGLE_BASEADDR + XIN_IVR_OFFSET ) );\r
 291 \r
 292         if( ulPending < XPAR_INTC_MAX_NUM_INTR_INPUTS )\r
 293         {\r
 294 \r
 295                 ulInterruptMask = ( unsigned long ) 1 << ulPending;\r
 296 \r
 297                 /* Get the configuration data using the device ID */\r
 298                 pxConfig = &XIntc_ConfigTable[ ( unsigned long ) XPAR_INTC_SINGLE_DEVICE_ID ];\r
 299 \r
 300                 pxTablePtr = &( pxConfig->HandlerTable[ ulPending ] );\r
 301                 if( pxConfig->AckBeforeService & ( ulInterruptMask  ) )\r
 302                 {\r
 303                         XIntc_AckIntr( pxConfig->BaseAddress, ulInterruptMask );\r
 304                         pxTablePtr->Handler( pxTablePtr->CallBackRef );\r
 305                 }\r
 306                 else\r
 307                 {\r
 308                         pxTablePtr->Handler( pxTablePtr->CallBackRef );\r
 309                         XIntc_AckIntr( pxConfig->BaseAddress, ulInterruptMask );\r
 310                 }\r
 311         }\r
 312 }\r
 313 /*-----------------------------------------------------------*/\r
 314 \r
 315 void vPortEnableInterrupt( unsigned char ucInterruptID )\r
 316 {\r
 317         XIntc_Enable( &xInterruptControllerInstance, ucInterruptID );\r
 318 }\r
 319 /*-----------------------------------------------------------*/\r
 320 \r
 321 void vPortDisableInterrupt( unsigned char ucInterruptID )\r
 322 {\r
 323         XIntc_Disable( &xInterruptControllerInstance, ucInterruptID );\r
 324 }\r
 325 /*-----------------------------------------------------------*/\r
 326 \r
 327 portBASE_TYPE xPortInstallInterruptHandler( unsigned char ucInterruptID, XInterruptHandler pxHandler, void *pvCallBackRef )\r
 328 {\r
 329 static portBASE_TYPE xInterruptControllerInitialised = pdFALSE;\r
 330 portBASE_TYPE xReturn = XST_SUCCESS;\r
 331 \r
 332         if( xInterruptControllerInitialised != pdTRUE )\r
 333         {\r
 334                 xReturn = prvInitialiseInterruptController();\r
 335                 xInterruptControllerInitialised = pdTRUE;\r
 336         }\r
 337 \r
 338         if( xReturn == XST_SUCCESS )\r
 339         {\r
 340                 xReturn = XIntc_Connect( &xInterruptControllerInstance, ucInterruptID, pxHandler, pvCallBackRef );\r
 341         }\r
 342 \r
 343         if( xReturn == XST_SUCCESS )\r
 344         {\r
 345                 xReturn = pdPASS;\r
 346         }\r
 347 \r
 348         return xReturn;\r
 349 }\r
 350 /*-----------------------------------------------------------*/\r
 351 \r
 352 /* \r
 353  * Handler for the timer interrupt.\r
 354  */\r
 355 void vTickISR( void *pvUnused )\r
 356 {\r
 357 extern void vApplicationClearTimerInterrupt();\r
 358 \r
 359         /* Ensure the unused parameter does not generate a compiler warning. */\r
 360         ( void ) pvUnused;\r
 361 \r
 362         vApplicationClearTimerInterrupt();\r
 363 \r
 364         /* Increment the RTOS tick - this might cause a task to unblock. */\r
 365         vTaskIncrementTick();\r
 366 \r
 367         /* If we are using the preemptive scheduler then we also need to determine\r
 368         if this tick should cause a context switch. */\r
 369         #if configUSE_PREEMPTION == 1\r
 370                 vTaskSwitchContext();\r
 371         #endif\r
 372 }\r
 373 /*-----------------------------------------------------------*/\r
 374 \r
 375 static portBASE_TYPE prvInitialiseInterruptController( void )\r
 376 {\r
 377 portBASE_TYPE xStatus;\r
 378 \r
 379         xStatus = XIntc_Initialize( &xInterruptControllerInstance, configINTERRUPT_CONTROLLER_TO_USE );\r
 380 \r
 381         if( xStatus == XST_SUCCESS )\r
 382         {\r
 383                 /* Initialise the exception table. */\r
 384                 Xil_ExceptionInit();\r
 385 \r
 386             /* Service all pending interrupts each time the handler is entered. */\r
 387             XIntc_SetIntrSvcOption( xInterruptControllerInstance.BaseAddress, XIN_SVC_ALL_ISRS_OPTION );\r
 388 \r
 389                 /* Start the interrupt controller.  Interrupts are enabled when the\r
 390                 scheduler starts. */\r
 391                 xStatus = XIntc_Start( &xInterruptControllerInstance, XIN_REAL_MODE );\r
 392 \r
 393                 /* Ensure the compiler does not generate warnings for the unused\r
 394                 iStatus valud if configASSERT() is not defined. */\r
 395                 ( void ) xStatus;\r
 396         }\r
 397 \r
 398         configASSERT( ( xStatus == ( portBASE_TYPE ) XST_SUCCESS ) )\r
 399 \r
 400         return xStatus;\r
 401 }\r
 402 \r
 403 \r
 404 \r
 405 \r