git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/GCC/MicroBlaze/port.c

   1 /*\r
   2     FreeRTOS V7.2.0 - Copyright (C) 2012 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     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 /*-----------------------------------------------------------\r
  68  * Implementation of functions defined in portable.h for the MicroBlaze port.\r
  69  *----------------------------------------------------------*/\r
  70 \r
  71 \r
  72 /* Scheduler includes. */\r
  73 #include "FreeRTOS.h"\r
  74 #include "task.h"\r
  75 \r
  76 /* Standard includes. */\r
  77 #include <string.h>\r
  78 \r
  79 /* Hardware includes. */\r
  80 #include <xintc.h>\r
  81 #include <xintc_i.h>\r
  82 #include <xtmrctr.h>\r
  83 \r
  84 /* Tasks are started with interrupts enabled. */\r
  85 #define portINITIAL_MSR_STATE           ( ( portSTACK_TYPE ) 0x02 )\r
  86 \r
  87 /* Tasks are started with a critical section nesting of 0 - however prior\r
  88 to the scheduler being commenced we don't want the critical nesting level\r
  89 to reach zero, so it is initialised to a high value. */\r
  90 #define portINITIAL_NESTING_VALUE       ( 0xff )\r
  91 \r
  92 /* Our hardware setup only uses one counter. */\r
  93 #define portCOUNTER_0                           0\r
  94 \r
  95 /* The stack used by the ISR is filled with a known value to assist in\r
  96 debugging. */\r
  97 #define portISR_STACK_FILL_VALUE        0x55555555\r
  98 \r
  99 /* Counts the nesting depth of calls to portENTER_CRITICAL().  Each task \r
 100 maintains it's own count, so this variable is saved as part of the task\r
 101 context. */\r
 102 volatile unsigned portBASE_TYPE uxCriticalNesting = portINITIAL_NESTING_VALUE;\r
 103 \r
 104 /* To limit the amount of stack required by each task, this port uses a\r
 105 separate stack for interrupts. */\r
 106 unsigned long *pulISRStack;\r
 107 \r
 108 /*-----------------------------------------------------------*/\r
 109 \r
 110 /*\r
 111  * Sets up the periodic ISR used for the RTOS tick.  This uses timer 0, but\r
 112  * could have alternatively used the watchdog timer or timer 1.\r
 113  */\r
 114 static void prvSetupTimerInterrupt( void );\r
 115 /*-----------------------------------------------------------*/\r
 116 \r
 117 /* \r
 118  * Initialise the stack of a task to look exactly as if a call to \r
 119  * portSAVE_CONTEXT had been made.\r
 120  * \r
 121  * See the header file portable.h.\r
 122  */\r
 123 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
 124 {\r
 125 extern void *_SDA2_BASE_, *_SDA_BASE_;\r
 126 const unsigned long ulR2 = ( unsigned long ) &_SDA2_BASE_;\r
 127 const unsigned long ulR13 = ( unsigned long ) &_SDA_BASE_;\r
 128 \r
 129         /* Place a few bytes of known values on the bottom of the stack. \r
 130         This is essential for the Microblaze port and these lines must\r
 131         not be omitted.  The parameter value will overwrite the \r
 132         0x22222222 value during the function prologue. */\r
 133         *pxTopOfStack = ( portSTACK_TYPE ) 0x11111111;\r
 134         pxTopOfStack--;\r
 135         *pxTopOfStack = ( portSTACK_TYPE ) 0x22222222;\r
 136         pxTopOfStack--;\r
 137         *pxTopOfStack = ( portSTACK_TYPE ) 0x33333333;\r
 138         pxTopOfStack--; \r
 139 \r
 140         /* First stack an initial value for the critical section nesting.  This\r
 141         is initialised to zero as tasks are started with interrupts enabled. */\r
 142         *pxTopOfStack = ( portSTACK_TYPE ) 0x00;        /* R0. */\r
 143 \r
 144         /* Place an initial value for all the general purpose registers. */\r
 145         pxTopOfStack--;\r
 146         *pxTopOfStack = ( portSTACK_TYPE ) ulR2;        /* R2 - small data area. */\r
 147         pxTopOfStack--;\r
 148         *pxTopOfStack = ( portSTACK_TYPE ) 0x03;        /* R3. */\r
 149         pxTopOfStack--;\r
 150         *pxTopOfStack = ( portSTACK_TYPE ) 0x04;        /* R4. */\r
 151         pxTopOfStack--;\r
 152         *pxTopOfStack = ( portSTACK_TYPE ) pvParameters;/* R5 contains the function call parameters. */\r
 153         pxTopOfStack--;\r
 154         *pxTopOfStack = ( portSTACK_TYPE ) 0x06;        /* R6. */\r
 155         pxTopOfStack--;\r
 156         *pxTopOfStack = ( portSTACK_TYPE ) 0x07;        /* R7. */\r
 157         pxTopOfStack--;\r
 158         *pxTopOfStack = ( portSTACK_TYPE ) 0x08;        /* R8. */\r
 159         pxTopOfStack--;\r
 160         *pxTopOfStack = ( portSTACK_TYPE ) 0x09;        /* R9. */\r
 161         pxTopOfStack--;\r
 162         *pxTopOfStack = ( portSTACK_TYPE ) 0x0a;        /* R10. */\r
 163         pxTopOfStack--;\r
 164         *pxTopOfStack = ( portSTACK_TYPE ) 0x0b;        /* R11. */\r
 165         pxTopOfStack--;\r
 166         *pxTopOfStack = ( portSTACK_TYPE ) 0x0c;        /* R12. */\r
 167         pxTopOfStack--;\r
 168         *pxTopOfStack = ( portSTACK_TYPE ) ulR13;       /* R13 - small data read write area. */\r
 169         pxTopOfStack--;\r
 170         *pxTopOfStack = ( portSTACK_TYPE ) pxCode;      /* R14. */\r
 171         pxTopOfStack--;\r
 172         *pxTopOfStack = ( portSTACK_TYPE ) 0x0f;        /* R15. */\r
 173         pxTopOfStack--;\r
 174         *pxTopOfStack = ( portSTACK_TYPE ) 0x10;        /* R16. */\r
 175         pxTopOfStack--;\r
 176         *pxTopOfStack = ( portSTACK_TYPE ) 0x11;        /* R17. */\r
 177         pxTopOfStack--;\r
 178         *pxTopOfStack = ( portSTACK_TYPE ) 0x12;        /* R18. */\r
 179         pxTopOfStack--;\r
 180         *pxTopOfStack = ( portSTACK_TYPE ) 0x13;        /* R19. */\r
 181         pxTopOfStack--;\r
 182         *pxTopOfStack = ( portSTACK_TYPE ) 0x14;        /* R20. */\r
 183         pxTopOfStack--;\r
 184         *pxTopOfStack = ( portSTACK_TYPE ) 0x15;        /* R21. */\r
 185         pxTopOfStack--;\r
 186         *pxTopOfStack = ( portSTACK_TYPE ) 0x16;        /* R22. */\r
 187         pxTopOfStack--;\r
 188         *pxTopOfStack = ( portSTACK_TYPE ) 0x17;        /* R23. */\r
 189         pxTopOfStack--;\r
 190         *pxTopOfStack = ( portSTACK_TYPE ) 0x18;        /* R24. */\r
 191         pxTopOfStack--;\r
 192         *pxTopOfStack = ( portSTACK_TYPE ) 0x19;        /* R25. */\r
 193         pxTopOfStack--;\r
 194         *pxTopOfStack = ( portSTACK_TYPE ) 0x1a;        /* R26. */\r
 195         pxTopOfStack--;\r
 196         *pxTopOfStack = ( portSTACK_TYPE ) 0x1b;        /* R27. */\r
 197         pxTopOfStack--;\r
 198         *pxTopOfStack = ( portSTACK_TYPE ) 0x1c;        /* R28. */\r
 199         pxTopOfStack--;\r
 200         *pxTopOfStack = ( portSTACK_TYPE ) 0x1d;        /* R29. */\r
 201         pxTopOfStack--;\r
 202         *pxTopOfStack = ( portSTACK_TYPE ) 0x1e;        /* R30. */\r
 203         pxTopOfStack--;\r
 204 \r
 205         /* The MSR is stacked between R30 and R31. */\r
 206         *pxTopOfStack = portINITIAL_MSR_STATE;\r
 207         pxTopOfStack--;\r
 208 \r
 209         *pxTopOfStack = ( portSTACK_TYPE ) 0x1f;        /* R31. */\r
 210         pxTopOfStack--;\r
 211 \r
 212         /* Return a pointer to the top of the stack we have generated so this can\r
 213         be stored in the task control block for the task. */\r
 214         return pxTopOfStack;\r
 215 }\r
 216 /*-----------------------------------------------------------*/\r
 217 \r
 218 portBASE_TYPE xPortStartScheduler( void )\r
 219 {\r
 220 extern void ( __FreeRTOS_interrupt_Handler )( void );\r
 221 extern void ( vStartFirstTask )( void );\r
 222 \r
 223 \r
 224         /* Setup the FreeRTOS interrupt handler.  Code copied from crt0.s. */\r
 225         asm volatile (  "la     r6, r0, __FreeRTOS_interrupt_handler            \n\t" \\r
 226                                         "sw     r6, r1, r0                                                                      \n\t" \\r
 227                                         "lhu r7, r1, r0                                                                 \n\t" \\r
 228                                         "shi r7, r0, 0x12                                                               \n\t" \\r
 229                                         "shi r6, r0, 0x16 " );\r
 230 \r
 231         /* Setup the hardware to generate the tick.  Interrupts are disabled when\r
 232         this function is called. */\r
 233         prvSetupTimerInterrupt();\r
 234 \r
 235         /* Allocate the stack to be used by the interrupt handler. */\r
 236         pulISRStack = ( unsigned long * ) pvPortMalloc( configMINIMAL_STACK_SIZE * sizeof( portSTACK_TYPE ) );\r
 237 \r
 238         /* Restore the context of the first task that is going to run. */\r
 239         if( pulISRStack != NULL )\r
 240         {\r
 241                 /* Fill the ISR stack with a known value to facilitate debugging. */\r
 242                 memset( pulISRStack, portISR_STACK_FILL_VALUE, configMINIMAL_STACK_SIZE * sizeof( portSTACK_TYPE ) );\r
 243                 pulISRStack += ( configMINIMAL_STACK_SIZE - 1 );\r
 244 \r
 245                 /* Kick off the first task. */\r
 246                 vStartFirstTask();\r
 247         }\r
 248 \r
 249         /* Should not get here as the tasks are now running! */\r
 250         return pdFALSE;\r
 251 }\r
 252 /*-----------------------------------------------------------*/\r
 253 \r
 254 void vPortEndScheduler( void )\r
 255 {\r
 256         /* Not implemented. */\r
 257 }\r
 258 /*-----------------------------------------------------------*/\r
 259 \r
 260 /*\r
 261  * Manual context switch called by portYIELD or taskYIELD.  \r
 262  */\r
 263 void vPortYield( void )\r
 264 {\r
 265 extern void VPortYieldASM( void );\r
 266 \r
 267         /* Perform the context switch in a critical section to assure it is\r
 268         not interrupted by the tick ISR.  It is not a problem to do this as\r
 269         each task maintains it's own interrupt status. */\r
 270         portENTER_CRITICAL();\r
 271                 /* Jump directly to the yield function to ensure there is no\r
 272                 compiler generated prologue code. */\r
 273                 asm volatile (  "bralid r14, VPortYieldASM              \n\t" \\r
 274                                                 "or r0, r0, r0                                  \n\t" );\r
 275         portEXIT_CRITICAL();\r
 276 }\r
 277 /*-----------------------------------------------------------*/\r
 278 \r
 279 /*\r
 280  * Hardware initialisation to generate the RTOS tick.   \r
 281  */\r
 282 static void prvSetupTimerInterrupt( void )\r
 283 {\r
 284 XTmrCtr xTimer;\r
 285 const unsigned long ulCounterValue = configCPU_CLOCK_HZ / configTICK_RATE_HZ;\r
 286 unsigned portBASE_TYPE uxMask;\r
 287 \r
 288         /* The OPB timer1 is used to generate the tick.  Use the provided library\r
 289         functions to enable the timer and set the tick frequency. */\r
 290         XTmrCtr_mDisable( XPAR_OPB_TIMER_1_BASEADDR, XPAR_OPB_TIMER_1_DEVICE_ID );\r
 291         XTmrCtr_Initialize( &xTimer, XPAR_OPB_TIMER_1_DEVICE_ID );\r
 292         XTmrCtr_mSetLoadReg( XPAR_OPB_TIMER_1_BASEADDR, portCOUNTER_0, ulCounterValue );\r
 293         XTmrCtr_mSetControlStatusReg( XPAR_OPB_TIMER_1_BASEADDR, portCOUNTER_0, XTC_CSR_LOAD_MASK | XTC_CSR_INT_OCCURED_MASK );\r
 294 \r
 295         /* Set the timer interrupt enable bit while maintaining the other bit \r
 296         states. */\r
 297         uxMask = XIntc_In32( ( XPAR_OPB_INTC_0_BASEADDR + XIN_IER_OFFSET ) );\r
 298         uxMask |= XPAR_OPB_TIMER_1_INTERRUPT_MASK;\r
 299         XIntc_Out32( ( XPAR_OPB_INTC_0_BASEADDR + XIN_IER_OFFSET ), ( uxMask ) );       \r
 300         \r
 301         XTmrCtr_Start( &xTimer, XPAR_OPB_TIMER_1_DEVICE_ID );\r
 302         XTmrCtr_mSetControlStatusReg(XPAR_OPB_TIMER_1_BASEADDR, portCOUNTER_0, XTC_CSR_ENABLE_TMR_MASK | XTC_CSR_ENABLE_INT_MASK | XTC_CSR_AUTO_RELOAD_MASK | XTC_CSR_DOWN_COUNT_MASK | XTC_CSR_INT_OCCURED_MASK );\r
 303         XIntc_mAckIntr( XPAR_INTC_SINGLE_BASEADDR, 1 );\r
 304 }\r
 305 /*-----------------------------------------------------------*/\r
 306 \r
 307 /*\r
 308  * The interrupt handler placed in the interrupt vector when the scheduler is\r
 309  * started.  The task context has already been saved when this is called.\r
 310  * This handler determines the interrupt source and calls the relevant \r
 311  * peripheral handler.\r
 312  */\r
 313 void vTaskISRHandler( void )\r
 314 {\r
 315 static unsigned long ulPending;    \r
 316 \r
 317         /* Which interrupts are pending? */\r
 318         ulPending = XIntc_In32( ( XPAR_INTC_SINGLE_BASEADDR + XIN_IVR_OFFSET ) );\r
 319 \r
 320         if( ulPending < XPAR_INTC_MAX_NUM_INTR_INPUTS )\r
 321         {\r
 322                 static XIntc_VectorTableEntry *pxTablePtr;\r
 323                 static XIntc_Config *pxConfig;\r
 324                 static unsigned long ulInterruptMask;\r
 325 \r
 326                 ulInterruptMask = ( unsigned long ) 1 << ulPending;\r
 327 \r
 328                 /* Get the configuration data using the device ID */\r
 329                 pxConfig = &XIntc_ConfigTable[ ( unsigned long ) XPAR_INTC_SINGLE_DEVICE_ID ];\r
 330 \r
 331                 pxTablePtr = &( pxConfig->HandlerTable[ ulPending ] );\r
 332                 if( pxConfig->AckBeforeService & ( ulInterruptMask  ) )\r
 333                 {\r
 334                         XIntc_mAckIntr( pxConfig->BaseAddress, ulInterruptMask );\r
 335                         pxTablePtr->Handler( pxTablePtr->CallBackRef );\r
 336                 }\r
 337                 else\r
 338                 {\r
 339                         pxTablePtr->Handler( pxTablePtr->CallBackRef );\r
 340                         XIntc_mAckIntr( pxConfig->BaseAddress, ulInterruptMask );\r
 341                 }\r
 342         }\r
 343 }\r
 344 /*-----------------------------------------------------------*/\r
 345 \r
 346 /* \r
 347  * Handler for the timer interrupt.\r
 348  */\r
 349 void vTickISR( void *pvBaseAddress )\r
 350 {\r
 351 unsigned long ulCSR;\r
 352 \r
 353         /* Increment the RTOS tick - this might cause a task to unblock. */\r
 354         vTaskIncrementTick();\r
 355 \r
 356         /* Clear the timer interrupt */\r
 357         ulCSR = XTmrCtr_mGetControlStatusReg(XPAR_OPB_TIMER_1_BASEADDR, 0);     \r
 358         XTmrCtr_mSetControlStatusReg( XPAR_OPB_TIMER_1_BASEADDR, portCOUNTER_0, ulCSR );\r
 359 \r
 360         /* If we are using the preemptive scheduler then we also need to determine\r
 361         if this tick should cause a context switch. */\r
 362         #if configUSE_PREEMPTION == 1\r
 363                 vTaskSwitchContext();\r
 364         #endif\r
 365 }\r
 366 /*-----------------------------------------------------------*/\r
 367 \r
 368 \r
 369 \r
 370 \r
 371 \r