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

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