2 FreeRTOS V8.2.1 - Copyright (C) 2015 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\r
9 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
10 the terms of the GNU General Public License (version 2) as published by the
\r
11 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
13 ***************************************************************************
\r
14 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
15 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
16 >>! obliged to provide the source code for proprietary components !<<
\r
17 >>! outside of the FreeRTOS kernel. !<<
\r
18 ***************************************************************************
\r
20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
22 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
23 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * FreeRTOS provides completely free yet professionally developed, *
\r
28 * robust, strictly quality controlled, supported, and cross *
\r
29 * platform software that is more than just the market leader, it *
\r
30 * is the industry's de facto standard. *
\r
32 * Help yourself get started quickly while simultaneously helping *
\r
33 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
34 * tutorial book, reference manual, or both: *
\r
35 * http://www.FreeRTOS.org/Documentation *
\r
37 ***************************************************************************
\r
39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
\r
40 the FAQ page "My application does not run, what could be wrong?". Have you
\r
41 defined configASSERT()?
\r
43 http://www.FreeRTOS.org/support - In return for receiving this top quality
\r
44 embedded software for free we request you assist our global community by
\r
45 participating in the support forum.
\r
47 http://www.FreeRTOS.org/training - Investing in training allows your team to
\r
48 be as productive as possible as early as possible. Now you can receive
\r
49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
\r
50 Ltd, and the world's leading authority on the world's leading RTOS.
\r
52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
54 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
\r
60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
61 licenses offer ticketed support, indemnification and commercial middleware.
\r
63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
64 engineered and independently SIL3 certified version for use in safety and
\r
65 mission critical applications that require provable dependability.
\r
70 /*-----------------------------------------------------------
\r
71 * Implementation of functions defined in portable.h for the MicroBlaze port.
\r
72 *----------------------------------------------------------*/
\r
75 /* Scheduler includes. */
\r
76 #include "FreeRTOS.h"
\r
79 /* Standard includes. */
\r
82 /* Hardware includes. */
\r
83 #include <xintc_i.h>
\r
84 #include <xil_exception.h>
\r
85 #include <microblaze_exceptions_g.h>
\r
87 /* Tasks are started with a critical section nesting of 0 - however, prior to
\r
88 the scheduler being commenced interrupts should not be enabled, so the critical
\r
89 nesting variable is initialised to a non-zero value. */
\r
90 #define portINITIAL_NESTING_VALUE ( 0xff )
\r
92 /* The bit within the MSR register that enabled/disables interrupts. */
\r
93 #define portMSR_IE ( 0x02U )
\r
95 /* If the floating point unit is included in the MicroBlaze build, then the
\r
96 FSR register is saved as part of the task context. portINITIAL_FSR is the value
\r
97 given to the FSR register when the initial context is set up for a task being
\r
99 #define portINITIAL_FSR ( 0U )
\r
100 /*-----------------------------------------------------------*/
\r
103 * Initialise the interrupt controller instance.
\r
105 static int32_t prvInitialiseInterruptController( void );
\r
107 /* Ensure the interrupt controller instance variable is initialised before it is
\r
108 * used, and that the initialisation only happens once.
\r
110 static int32_t prvEnsureInterruptControllerIsInitialised( void );
\r
112 /*-----------------------------------------------------------*/
\r
114 /* Counts the nesting depth of calls to portENTER_CRITICAL(). Each task
\r
115 maintains its own count, so this variable is saved as part of the task
\r
117 volatile UBaseType_t uxCriticalNesting = portINITIAL_NESTING_VALUE;
\r
119 /* This port uses a separate stack for interrupts. This prevents the stack of
\r
120 every task needing to be large enough to hold an entire interrupt stack on top
\r
121 of the task stack. */
\r
122 uint32_t *pulISRStack;
\r
124 /* If an interrupt requests a context switch, then ulTaskSwitchRequested will
\r
125 get set to 1. ulTaskSwitchRequested is inspected just before the main interrupt
\r
126 handler exits. If, at that time, ulTaskSwitchRequested is set to 1, the kernel
\r
127 will call vTaskSwitchContext() to ensure the task that runs immediately after
\r
128 the interrupt exists is the highest priority task that is able to run. This is
\r
129 an unusual mechanism, but is used for this port because a single interrupt can
\r
130 cause the servicing of multiple peripherals - and it is inefficient to call
\r
131 vTaskSwitchContext() multiple times as each peripheral is serviced. */
\r
132 volatile uint32_t ulTaskSwitchRequested = 0UL;
\r
134 /* The instance of the interrupt controller used by this port. This is required
\r
135 by the Xilinx library API functions. */
\r
136 static XIntc xInterruptControllerInstance;
\r
138 /*-----------------------------------------------------------*/
\r
141 * Initialise the stack of a task to look exactly as if a call to
\r
142 * portSAVE_CONTEXT had been made.
\r
144 * See the portable.h header file.
\r
146 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )
\r
148 extern void *_SDA2_BASE_, *_SDA_BASE_;
\r
149 const uint32_t ulR2 = ( uint32_t ) &_SDA2_BASE_;
\r
150 const uint32_t ulR13 = ( uint32_t ) &_SDA_BASE_;
\r
152 /* Place a few bytes of known values on the bottom of the stack.
\r
153 This is essential for the Microblaze port and these lines must
\r
155 *pxTopOfStack = ( StackType_t ) 0x00000000;
\r
157 *pxTopOfStack = ( StackType_t ) 0x00000000;
\r
159 *pxTopOfStack = ( StackType_t ) 0x00000000;
\r
162 #if XPAR_MICROBLAZE_0_USE_FPU != 0
\r
163 /* The FSR value placed in the initial task context is just 0. */
\r
164 *pxTopOfStack = portINITIAL_FSR;
\r
168 /* The MSR value placed in the initial task context should have interrupts
\r
169 disabled. Each task will enable interrupts automatically when it enters
\r
170 the running state for the first time. */
\r
171 *pxTopOfStack = mfmsr() & ~portMSR_IE;
\r
174 /* First stack an initial value for the critical section nesting. This
\r
175 is initialised to zero. */
\r
176 *pxTopOfStack = ( StackType_t ) 0x00;
\r
178 /* R0 is always zero. */
\r
179 /* R1 is the SP. */
\r
181 /* Place an initial value for all the general purpose registers. */
\r
183 *pxTopOfStack = ( StackType_t ) ulR2; /* R2 - read only small data area. */
\r
185 *pxTopOfStack = ( StackType_t ) 0x03; /* R3 - return values and temporaries. */
\r
187 *pxTopOfStack = ( StackType_t ) 0x04; /* R4 - return values and temporaries. */
\r
189 *pxTopOfStack = ( StackType_t ) pvParameters;/* R5 contains the function call parameters. */
\r
191 #ifdef portPRE_LOAD_STACK_FOR_DEBUGGING
\r
193 *pxTopOfStack = ( StackType_t ) 0x06; /* R6 - other parameters and temporaries. Used as the return address from vPortTaskEntryPoint. */
\r
195 *pxTopOfStack = ( StackType_t ) 0x07; /* R7 - other parameters and temporaries. */
\r
197 *pxTopOfStack = ( StackType_t ) 0x08; /* R8 - other parameters and temporaries. */
\r
199 *pxTopOfStack = ( StackType_t ) 0x09; /* R9 - other parameters and temporaries. */
\r
201 *pxTopOfStack = ( StackType_t ) 0x0a; /* R10 - other parameters and temporaries. */
\r
203 *pxTopOfStack = ( StackType_t ) 0x0b; /* R11 - temporaries. */
\r
205 *pxTopOfStack = ( StackType_t ) 0x0c; /* R12 - temporaries. */
\r
211 *pxTopOfStack = ( StackType_t ) ulR13; /* R13 - read/write small data area. */
\r
213 *pxTopOfStack = ( StackType_t ) pxCode; /* R14 - return address for interrupt. */
\r
215 *pxTopOfStack = ( StackType_t ) NULL; /* R15 - return address for subroutine. */
\r
217 #ifdef portPRE_LOAD_STACK_FOR_DEBUGGING
\r
219 *pxTopOfStack = ( StackType_t ) 0x10; /* R16 - return address for trap (debugger). */
\r
221 *pxTopOfStack = ( StackType_t ) 0x11; /* R17 - return address for exceptions, if configured. */
\r
223 *pxTopOfStack = ( StackType_t ) 0x12; /* R18 - reserved for assembler and compiler temporaries. */
\r
229 *pxTopOfStack = ( StackType_t ) 0x00; /* R19 - must be saved across function calls. Callee-save. Seems to be interpreted as the frame pointer. */
\r
231 #ifdef portPRE_LOAD_STACK_FOR_DEBUGGING
\r
233 *pxTopOfStack = ( StackType_t ) 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
235 *pxTopOfStack = ( StackType_t ) 0x15; /* R21 - must be saved across function calls. Callee-save. */
\r
237 *pxTopOfStack = ( StackType_t ) 0x16; /* R22 - must be saved across function calls. Callee-save. */
\r
239 *pxTopOfStack = ( StackType_t ) 0x17; /* R23 - must be saved across function calls. Callee-save. */
\r
241 *pxTopOfStack = ( StackType_t ) 0x18; /* R24 - must be saved across function calls. Callee-save. */
\r
243 *pxTopOfStack = ( StackType_t ) 0x19; /* R25 - must be saved across function calls. Callee-save. */
\r
245 *pxTopOfStack = ( StackType_t ) 0x1a; /* R26 - must be saved across function calls. Callee-save. */
\r
247 *pxTopOfStack = ( StackType_t ) 0x1b; /* R27 - must be saved across function calls. Callee-save. */
\r
249 *pxTopOfStack = ( StackType_t ) 0x1c; /* R28 - must be saved across function calls. Callee-save. */
\r
251 *pxTopOfStack = ( StackType_t ) 0x1d; /* R29 - must be saved across function calls. Callee-save. */
\r
253 *pxTopOfStack = ( StackType_t ) 0x1e; /* R30 - must be saved across function calls. Callee-save. */
\r
255 *pxTopOfStack = ( StackType_t ) 0x1f; /* R31 - must be saved across function calls. Callee-save. */
\r
258 pxTopOfStack -= 13;
\r
261 /* Return a pointer to the top of the stack that has been generated so this
\r
262 can be stored in the task control block for the task. */
\r
263 return pxTopOfStack;
\r
265 /*-----------------------------------------------------------*/
\r
267 BaseType_t xPortStartScheduler( void )
\r
269 extern void ( vPortStartFirstTask )( void );
\r
270 extern uint32_t _stack[];
\r
272 /* Setup the hardware to generate the tick. Interrupts are disabled when
\r
273 this function is called.
\r
275 This port uses an application defined callback function to install the tick
\r
276 interrupt handler because the kernel will run on lots of different
\r
277 MicroBlaze and FPGA configurations - not all of which will have the same
\r
278 timer peripherals defined or available. An example definition of
\r
279 vApplicationSetupTimerInterrupt() is provided in the official demo
\r
280 application that accompanies this port. */
\r
281 vApplicationSetupTimerInterrupt();
\r
283 /* Reuse the stack from main() as the stack for the interrupts/exceptions. */
\r
284 pulISRStack = ( uint32_t * ) _stack;
\r
286 /* Ensure there is enough space for the functions called from the interrupt
\r
287 service routines to write back into the stack frame of the caller. */
\r
290 /* Restore the context of the first task that is going to run. From here
\r
291 on, the created tasks will be executing. */
\r
292 vPortStartFirstTask();
\r
294 /* Should not get here as the tasks are now running! */
\r
297 /*-----------------------------------------------------------*/
\r
299 void vPortEndScheduler( void )
\r
301 /* Not implemented in ports where there is nothing to return to.
\r
302 Artificially force an assert. */
\r
303 configASSERT( uxCriticalNesting == 1000UL );
\r
305 /*-----------------------------------------------------------*/
\r
308 * Manual context switch called by portYIELD or taskYIELD.
\r
310 void vPortYield( void )
\r
312 extern void VPortYieldASM( void );
\r
314 /* Perform the context switch in a critical section to assure it is
\r
315 not interrupted by the tick ISR. It is not a problem to do this as
\r
316 each task maintains its own interrupt status. */
\r
317 portENTER_CRITICAL();
\r
319 /* Jump directly to the yield function to ensure there is no
\r
320 compiler generated prologue code. */
\r
321 asm volatile ( "bralid r14, VPortYieldASM \n\t" \
\r
322 "or r0, r0, r0 \n\t" );
\r
324 portEXIT_CRITICAL();
\r
326 /*-----------------------------------------------------------*/
\r
328 void vPortEnableInterrupt( uint8_t ucInterruptID )
\r
332 /* An API function is provided to enable an interrupt in the interrupt
\r
333 controller because the interrupt controller instance variable is private
\r
335 lReturn = prvEnsureInterruptControllerIsInitialised();
\r
336 if( lReturn == pdPASS )
\r
338 XIntc_Enable( &xInterruptControllerInstance, ucInterruptID );
\r
341 configASSERT( lReturn );
\r
343 /*-----------------------------------------------------------*/
\r
345 void vPortDisableInterrupt( uint8_t ucInterruptID )
\r
349 /* An API function is provided to disable an interrupt in the interrupt
\r
350 controller because the interrupt controller instance variable is private
\r
352 lReturn = prvEnsureInterruptControllerIsInitialised();
\r
354 if( lReturn == pdPASS )
\r
356 XIntc_Disable( &xInterruptControllerInstance, ucInterruptID );
\r
359 configASSERT( lReturn );
\r
361 /*-----------------------------------------------------------*/
\r
363 BaseType_t xPortInstallInterruptHandler( uint8_t ucInterruptID, XInterruptHandler pxHandler, void *pvCallBackRef )
\r
367 /* An API function is provided to install an interrupt handler because the
\r
368 interrupt controller instance variable is private to this file. */
\r
370 lReturn = prvEnsureInterruptControllerIsInitialised();
\r
372 if( lReturn == pdPASS )
\r
374 lReturn = XIntc_Connect( &xInterruptControllerInstance, ucInterruptID, pxHandler, pvCallBackRef );
\r
377 if( lReturn == XST_SUCCESS )
\r
382 configASSERT( lReturn == pdPASS );
\r
386 /*-----------------------------------------------------------*/
\r
388 static int32_t prvEnsureInterruptControllerIsInitialised( void )
\r
390 static int32_t lInterruptControllerInitialised = pdFALSE;
\r
393 /* Ensure the interrupt controller instance variable is initialised before
\r
394 it is used, and that the initialisation only happens once. */
\r
395 if( lInterruptControllerInitialised != pdTRUE )
\r
397 lReturn = prvInitialiseInterruptController();
\r
399 if( lReturn == pdPASS )
\r
401 lInterruptControllerInitialised = pdTRUE;
\r
411 /*-----------------------------------------------------------*/
\r
414 * Handler for the timer interrupt. This is the handler that the application
\r
415 * defined callback function vApplicationSetupTimerInterrupt() should install.
\r
417 void vPortTickISR( void *pvUnused )
\r
419 extern void vApplicationClearTimerInterrupt( void );
\r
421 /* Ensure the unused parameter does not generate a compiler warning. */
\r
424 /* This port uses an application defined callback function to clear the tick
\r
425 interrupt because the kernel will run on lots of different MicroBlaze and
\r
426 FPGA configurations - not all of which will have the same timer peripherals
\r
427 defined or available. An example definition of
\r
428 vApplicationClearTimerInterrupt() is provided in the official demo
\r
429 application that accompanies this port. */
\r
430 vApplicationClearTimerInterrupt();
\r
432 /* Increment the RTOS tick - this might cause a task to unblock. */
\r
433 if( xTaskIncrementTick() != pdFALSE )
\r
435 /* Force vTaskSwitchContext() to be called as the interrupt exits. */
\r
436 ulTaskSwitchRequested = 1;
\r
439 /*-----------------------------------------------------------*/
\r
441 static int32_t prvInitialiseInterruptController( void )
\r
445 lStatus = XIntc_Initialize( &xInterruptControllerInstance, configINTERRUPT_CONTROLLER_TO_USE );
\r
447 if( lStatus == XST_SUCCESS )
\r
449 /* Initialise the exception table. */
\r
450 Xil_ExceptionInit();
\r
452 /* Service all pending interrupts each time the handler is entered. */
\r
453 XIntc_SetIntrSvcOption( xInterruptControllerInstance.BaseAddress, XIN_SVC_ALL_ISRS_OPTION );
\r
455 /* Install exception handlers if the MicroBlaze is configured to handle
\r
456 exceptions, and the application defined constant
\r
457 configINSTALL_EXCEPTION_HANDLERS is set to 1. */
\r
458 #if ( MICROBLAZE_EXCEPTIONS_ENABLED == 1 ) && ( configINSTALL_EXCEPTION_HANDLERS == 1 )
\r
460 vPortExceptionsInstallHandlers();
\r
462 #endif /* MICROBLAZE_EXCEPTIONS_ENABLED */
\r
464 /* Start the interrupt controller. Interrupts are enabled when the
\r
465 scheduler starts. */
\r
466 lStatus = XIntc_Start( &xInterruptControllerInstance, XIN_REAL_MODE );
\r
468 if( lStatus == XST_SUCCESS )
\r
478 configASSERT( lStatus == pdPASS );
\r
482 /*-----------------------------------------------------------*/
\r