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