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