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