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