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