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_i.h>\r
  68 #include <xil_exception.h>\r
  69 #include <microblaze_exceptions_g.h>\r
  70 \r
  71 /* Tasks are started with a critical section nesting of 0 - however prior\r
  72 to the scheduler being commenced we don't want the critical nesting level\r
  73 to reach zero, so it is initialised to a high value. */\r
  74 #define portINITIAL_NESTING_VALUE       ( 0xff )\r
  75 \r
  76 /* The bit within the MSR register that enabled/disables interrupts. */\r
  77 #define portMSR_IE                                      ( 0x02U )\r
  78 \r
  79 #define portINITIAL_FSR                         ( 0U )\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 /* If an interrupt requests a context switch then ulTaskSwitchRequested will\r
 105 get set to 1, which in turn will cause vTaskSwitchContext() to be called\r
 106 prior to a task context getting restored on exit from the interrupt.  This\r
 107 mechanism is used as a single interrupt can cause multiple peripherals handlers\r
 108 to get called, and vTaskSwitchContext() should not get called in each handler. */\r
 109 volatile unsigned long ulTaskSwitchRequested = 0UL;\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         /* Place a few bytes of known values on the bottom of the stack. \r
 129         This is essential for the Microblaze port and these lines must\r
 130         not be omitted.  The parameter value will overwrite the \r
 131         0x22222222 value during the function prologue. */\r
 132         *pxTopOfStack = ( portSTACK_TYPE ) 0x11111111;\r
 133         pxTopOfStack--;\r
 134         *pxTopOfStack = ( portSTACK_TYPE ) 0x22222222;\r
 135         pxTopOfStack--;\r
 136         *pxTopOfStack = ( portSTACK_TYPE ) 0x33333333;\r
 137         pxTopOfStack--; \r
 138 \r
 139         /* The debugger will look at the previous stack frame. */\r
 140         *pxTopOfStack = ( portSTACK_TYPE ) 0x00000000;\r
 141         pxTopOfStack--;\r
 142         *pxTopOfStack = ( portSTACK_TYPE ) 0x00000000;\r
 143         pxTopOfStack--;\r
 144         *pxTopOfStack = ( portSTACK_TYPE ) 0x00000000;\r
 145         pxTopOfStack--;\r
 146 \r
 147         #if XPAR_MICROBLAZE_0_USE_FPU == 1\r
 148                 /* The FSR value placed in the initial task context is just 0. */\r
 149                 *pxTopOfStack = portINITIAL_FSR;\r
 150                 pxTopOfStack--;\r
 151         #endif\r
 152 \r
 153         /* The MSR value placed in the initial task context should have interrupts\r
 154         disabled.  Each task will enable interrupts automatically when it enters\r
 155         the running state for the first time. */\r
 156         *pxTopOfStack = mfmsr() & ~portMSR_IE;\r
 157         pxTopOfStack--;\r
 158 \r
 159         /* First stack an initial value for the critical section nesting.  This\r
 160         is initialised to zero. */\r
 161         *pxTopOfStack = ( portSTACK_TYPE ) 0x00;\r
 162         \r
 163         /* R0 is always zero. */\r
 164         /* R1 is the SP. */\r
 165 \r
 166         /* Place an initial value for all the general purpose registers. */\r
 167         pxTopOfStack--;\r
 168         *pxTopOfStack = ( portSTACK_TYPE ) ulR2;        /* R2 - read only small data area. */\r
 169         pxTopOfStack--;\r
 170         *pxTopOfStack = ( portSTACK_TYPE ) 0x03;        /* R3 - return values and temporaries. */\r
 171         pxTopOfStack--;\r
 172         *pxTopOfStack = ( portSTACK_TYPE ) 0x04;        /* R4 - return values and temporaries. */\r
 173         pxTopOfStack--;\r
 174         *pxTopOfStack = ( portSTACK_TYPE ) pvParameters;/* R5 contains the function call parameters. */\r
 175         pxTopOfStack--;\r
 176         *pxTopOfStack = ( portSTACK_TYPE ) 0x06;        /* R6 - other parameters and temporaries.  Used as the return address from vPortTaskEntryPoint. */\r
 177         pxTopOfStack--;\r
 178         *pxTopOfStack = ( portSTACK_TYPE ) 0x07;        /* R7 - other parameters and temporaries. */\r
 179         pxTopOfStack--;\r
 180         *pxTopOfStack = ( portSTACK_TYPE ) 0x08;        /* R8 - other parameters and temporaries. */\r
 181         pxTopOfStack--;\r
 182         *pxTopOfStack = ( portSTACK_TYPE ) 0x09;        /* R9 - other parameters and temporaries. */\r
 183         pxTopOfStack--;\r
 184         *pxTopOfStack = ( portSTACK_TYPE ) 0x0a;        /* R10 - other parameters and temporaries. */\r
 185         pxTopOfStack--;\r
 186         *pxTopOfStack = ( portSTACK_TYPE ) 0x0b;        /* R11 - temporaries. */\r
 187         pxTopOfStack--;\r
 188         *pxTopOfStack = ( portSTACK_TYPE ) 0x0c;        /* R12 - temporaries. */\r
 189         pxTopOfStack--;\r
 190         *pxTopOfStack = ( portSTACK_TYPE ) ulR13;       /* R13 - read/write small data area. */\r
 191         pxTopOfStack--;\r
 192         *pxTopOfStack = ( portSTACK_TYPE ) pxCode;      /* R14 - return address for interrupt. */\r
 193         pxTopOfStack--;\r
 194         *pxTopOfStack = ( portSTACK_TYPE ) NULL;        /* R15 - return address for subroutine. */\r
 195         pxTopOfStack--;\r
 196         *pxTopOfStack = ( portSTACK_TYPE ) 0x10;        /* R16 - return address for trap (debugger). */\r
 197         pxTopOfStack--;\r
 198         *pxTopOfStack = ( portSTACK_TYPE ) 0x11;        /* R17 - return address for exceptions, if configured. */\r
 199         pxTopOfStack--;\r
 200         *pxTopOfStack = ( portSTACK_TYPE ) 0x12;        /* R18 - reserved for assembler and compiler temporaries. */\r
 201         pxTopOfStack--;\r
 202         *pxTopOfStack = ( portSTACK_TYPE ) 0x00;        /* R19 - must be saved across function calls. Callee-save.  Seems to be interpreted as the frame pointer. */\r
 203         pxTopOfStack--;\r
 204         *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
 205         pxTopOfStack--;\r
 206         *pxTopOfStack = ( portSTACK_TYPE ) 0x15;        /* R21 - must be saved across function calls. Callee-save. */\r
 207         pxTopOfStack--;\r
 208         *pxTopOfStack = ( portSTACK_TYPE ) 0x16;        /* R22 - must be saved across function calls. Callee-save. */\r
 209         pxTopOfStack--;\r
 210         *pxTopOfStack = ( portSTACK_TYPE ) 0x17;        /* R23 - must be saved across function calls. Callee-save. */\r
 211         pxTopOfStack--;\r
 212         *pxTopOfStack = ( portSTACK_TYPE ) 0x18;        /* R24 - must be saved across function calls. Callee-save. */\r
 213         pxTopOfStack--;\r
 214         *pxTopOfStack = ( portSTACK_TYPE ) 0x19;        /* R25 - must be saved across function calls. Callee-save. */\r
 215         pxTopOfStack--;\r
 216         *pxTopOfStack = ( portSTACK_TYPE ) 0x1a;        /* R26 - must be saved across function calls. Callee-save. */\r
 217         pxTopOfStack--;\r
 218         *pxTopOfStack = ( portSTACK_TYPE ) 0x1b;        /* R27 - must be saved across function calls. Callee-save. */\r
 219         pxTopOfStack--;\r
 220         *pxTopOfStack = ( portSTACK_TYPE ) 0x1c;        /* R28 - must be saved across function calls. Callee-save. */\r
 221         pxTopOfStack--;\r
 222         *pxTopOfStack = ( portSTACK_TYPE ) 0x1d;        /* R29 - must be saved across function calls. Callee-save. */\r
 223         pxTopOfStack--;\r
 224         *pxTopOfStack = ( portSTACK_TYPE ) 0x1e;        /* R30 - must be saved across function calls. Callee-save. */\r
 225         pxTopOfStack--;\r
 226         *pxTopOfStack = ( portSTACK_TYPE ) 0x1f;        /* R31 - must be saved across function calls. Callee-save. */\r
 227         pxTopOfStack--;\r
 228 \r
 229         /* Return a pointer to the top of the stack we have generated so this can\r
 230         be stored in the task control block for the task. */\r
 231         return pxTopOfStack;\r
 232 }\r
 233 /*-----------------------------------------------------------*/\r
 234 \r
 235 portBASE_TYPE xPortStartScheduler( void )\r
 236 {\r
 237 extern void ( vPortStartFirstTask )( void );\r
 238 extern unsigned long _stack[];\r
 239 \r
 240         /* Setup the hardware to generate the tick.  Interrupts are disabled when\r
 241         this function is called. */\r
 242         vApplicationSetupTimerInterrupt();\r
 243 \r
 244         /* Reuse the stack from main as the stack for the interrupts/exceptions. */\r
 245         pulISRStack = ( unsigned long * ) _stack;\r
 246 \r
 247         /* Restore the context of the first task that is going to run.  From here\r
 248         on, the created tasks will be executing. */\r
 249         vPortStartFirstTask();\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         {\r
 274                 /* Jump directly to the yield function to ensure there is no\r
 275                 compiler generated prologue code. */\r
 276                 asm volatile (  "bralid r14, VPortYieldASM              \n\t" \\r
 277                                                 "or r0, r0, r0                                  \n\t" );\r
 278         }\r
 279         portEXIT_CRITICAL();\r
 280 }\r
 281 /*-----------------------------------------------------------*/\r
 282 \r
 283 void vPortEnableInterrupt( unsigned char ucInterruptID )\r
 284 {\r
 285         XIntc_Enable( &xInterruptControllerInstance, ucInterruptID );\r
 286 }\r
 287 /*-----------------------------------------------------------*/\r
 288 \r
 289 void vPortDisableInterrupt( unsigned char ucInterruptID )\r
 290 {\r
 291         XIntc_Disable( &xInterruptControllerInstance, ucInterruptID );\r
 292 }\r
 293 /*-----------------------------------------------------------*/\r
 294 \r
 295 portBASE_TYPE xPortInstallInterruptHandler( unsigned char ucInterruptID, XInterruptHandler pxHandler, void *pvCallBackRef )\r
 296 {\r
 297 static portBASE_TYPE xInterruptControllerInitialised = pdFALSE;\r
 298 portBASE_TYPE xReturn = XST_SUCCESS;\r
 299 \r
 300         if( xInterruptControllerInitialised != pdTRUE )\r
 301         {\r
 302                 xReturn = prvInitialiseInterruptController();\r
 303                 xInterruptControllerInitialised = pdTRUE;\r
 304         }\r
 305 \r
 306         if( xReturn == XST_SUCCESS )\r
 307         {\r
 308                 xReturn = XIntc_Connect( &xInterruptControllerInstance, ucInterruptID, pxHandler, pvCallBackRef );\r
 309         }\r
 310 \r
 311         if( xReturn == XST_SUCCESS )\r
 312         {\r
 313                 xReturn = pdPASS;\r
 314         }\r
 315 \r
 316         return xReturn;\r
 317 }\r
 318 /*-----------------------------------------------------------*/\r
 319 \r
 320 /* \r
 321  * Handler for the timer interrupt.\r
 322  */\r
 323 void vTickISR( void *pvUnused )\r
 324 {\r
 325 extern void vApplicationClearTimerInterrupt( void );\r
 326 \r
 327         /* Ensure the unused parameter does not generate a compiler warning. */\r
 328         ( void ) pvUnused;\r
 329 \r
 330         vApplicationClearTimerInterrupt();\r
 331 \r
 332         /* Increment the RTOS tick - this might cause a task to unblock. */\r
 333         vTaskIncrementTick();\r
 334 \r
 335         /* If we are using the preemptive scheduler then we also need to determine\r
 336         if this tick should cause a context switch. */\r
 337         #if configUSE_PREEMPTION == 1\r
 338                 /* Force vTaskSwitchContext() to be called as the interrupt exits. */\r
 339                 ulTaskSwitchRequested = 1;\r
 340         #endif\r
 341 }\r
 342 /*-----------------------------------------------------------*/\r
 343 \r
 344 static portBASE_TYPE prvInitialiseInterruptController( void )\r
 345 {\r
 346 portBASE_TYPE xStatus;\r
 347 \r
 348         xStatus = XIntc_Initialize( &xInterruptControllerInstance, configINTERRUPT_CONTROLLER_TO_USE );\r
 349 \r
 350         if( xStatus == XST_SUCCESS )\r
 351         {\r
 352                 /* Initialise the exception table. */\r
 353                 Xil_ExceptionInit();\r
 354 \r
 355             /* Service all pending interrupts each time the handler is entered. */\r
 356             XIntc_SetIntrSvcOption( xInterruptControllerInstance.BaseAddress, XIN_SVC_ALL_ISRS_OPTION );\r
 357 \r
 358             /* Install exception handlers if the MicroBlaze is configured to handle\r
 359             exceptions, and the application defined constant\r
 360             configINSTALL_EXCEPTION_HANDLERS is set to 1. */\r
 361                 #if ( MICROBLAZE_EXCEPTIONS_ENABLED == 1 ) && ( configINSTALL_EXCEPTION_HANDLERS == 1 )\r
 362             {\r
 363                 vPortExceptionsInstallHandlers();\r
 364             }\r
 365                 #endif /* MICROBLAZE_EXCEPTIONS_ENABLED */\r
 366 \r
 367                 /* Start the interrupt controller.  Interrupts are enabled when the\r
 368                 scheduler starts. */\r
 369                 xStatus = XIntc_Start( &xInterruptControllerInstance, XIN_REAL_MODE );\r
 370 \r
 371                 /* Ensure the compiler does not generate warnings for the unused\r
 372                 iStatus valud if configASSERT() is not defined. */\r
 373                 ( void ) xStatus;\r
 374         }\r
 375 \r
 376         configASSERT( ( xStatus == ( portBASE_TYPE ) XST_SUCCESS ) )\r
 377 \r
 378 /*_RB_ Exception test code. */\r
 379 #if 0\r
 380 This does not cause the bralid address to be in the r17 register.\r
 381 __asm volatile (\r
 382                                         "bralid r15, 1234 \n"\r
 383                                         "or r0, r0, r0 \n"\r
 384                                 );\r
 385 #endif\r
 386 #if 0\r
 387         xStatus /= 0;\r
 388 #endif\r
 389 \r
 390         return xStatus;\r
 391 }\r
 392 /*-----------------------------------------------------------*/\r
 393 \r
 394 \r