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