2 FreeRTOS V7.2.0 - Copyright (C) 2012 Real Time Engineers Ltd.
\r
5 ***************************************************************************
\r
7 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
8 * Complete, revised, and edited pdf reference manuals are also *
\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
18 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
20 * Thank you for using FreeRTOS, and thank you for your support! *
\r
22 ***************************************************************************
\r
25 This file is part of the FreeRTOS distribution.
\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
44 ***************************************************************************
\r
46 * Having a problem? Start by reading the FAQ "My application does *
\r
47 * not run, what could be wrong? *
\r
49 * http://www.FreeRTOS.org/FAQHelp.html *
\r
51 ***************************************************************************
\r
54 http://www.FreeRTOS.org - Documentation, training, latest information,
\r
55 license and contact details.
\r
57 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
58 including FreeRTOS+Trace - an indispensable productivity tool.
\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
67 /*-----------------------------------------------------------
\r
68 * Implementation of functions defined in portable.h for the ARM CM3 port.
\r
69 *----------------------------------------------------------*/
\r
71 /* Scheduler includes. */
\r
72 #include "FreeRTOS.h"
\r
75 /* For backward compatibility, ensure configKERNEL_INTERRUPT_PRIORITY is
\r
76 defined. The value should also ensure backward compatibility.
\r
77 FreeRTOS.org versions prior to V4.4.0 did not include this definition. */
\r
78 #ifndef configKERNEL_INTERRUPT_PRIORITY
\r
79 #define configKERNEL_INTERRUPT_PRIORITY 255
\r
82 #ifndef configSYSTICK_CLOCK_HZ
\r
83 #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ
\r
84 #if configUSE_TICKLESS_IDLE == 1
\r
85 static const unsigned long ulStoppedTimerCompensation = 45UL;
\r
87 #else /* configSYSTICK_CLOCK_HZ */
\r
88 #if configUSE_TICKLESS_IDLE == 1
\r
89 /* Assumes the SysTick clock is slower than the CPU clock. */
\r
90 static const unsigned long ulStoppedTimerCompensation = 45UL / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );
\r
92 #endif /* configSYSTICK_CLOCK_HZ */
\r
94 /* Constants required to manipulate the core. Registers first... */
\r
95 #define portNVIC_SYSTICK_CTRL_REG ( * ( ( volatile unsigned long * ) 0xe000e010 ) )
\r
96 #define portNVIC_SYSTICK_LOAD_REG ( * ( ( volatile unsigned long * ) 0xe000e014 ) )
\r
97 #define portNVIC_SYSTICK_CURRENT_VALUE_REG ( * ( ( volatile unsigned long * ) 0xe000e018 ) )
\r
98 #define portNVIC_INT_CTRL_REG ( * ( ( volatile unsigned long * ) 0xe000ed04 ) )
\r
99 #define portNVIC_SYSPRI2_REG ( * ( ( volatile unsigned long * ) 0xe000ed20 ) )
\r
100 /* ...then bits in the registers. */
\r
101 #define portNVIC_SYSTICK_CLK_BIT ( 1UL << 2UL )
\r
102 #define portNVIC_SYSTICK_INT_BIT ( 1UL << 1UL )
\r
103 #define portNVIC_SYSTICK_ENABLE_BIT ( 1UL << 0UL )
\r
104 #define portNVIC_SYSTICK_COUNT_FLAG_BIT ( 1UL << 16UL )
\r
105 #define portNVIC_PENDSVSET_BIT ( 1UL << 28UL )
\r
106 #define portNVIC_PENDSVCLEAR_BIT ( 1UL << 27UL )
\r
107 #define portNVIC_PEND_SYSTICK_CLEAR_BIT ( 1UL << 25UL )
\r
109 #define portNVIC_PENDSV_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16UL )
\r
110 #define portNVIC_SYSTICK_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )
\r
112 /* Constants required to set up the initial stack. */
\r
113 #define portINITIAL_XPSR ( 0x01000000 )
\r
115 /* The priority used by the kernel is assigned to a variable to make access
\r
116 from inline assembler easier. */
\r
117 const unsigned long ulKernelPriority = configKERNEL_INTERRUPT_PRIORITY;
\r
119 /* Each task maintains its own interrupt status in the critical nesting
\r
121 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;
\r
124 * Setup the timer to generate the tick interrupts.
\r
126 static void prvSetupTimerInterrupt( void );
\r
129 * Exception handlers.
\r
131 void xPortPendSVHandler( void ) __attribute__ (( naked ));
\r
132 void xPortSysTickHandler( void );
\r
133 void vPortSVCHandler( void ) __attribute__ (( naked ));
\r
136 * Start first task is a separate function so it can be tested in isolation.
\r
138 static void prvPortStartFirstTask( void ) __attribute__ (( naked ));
\r
140 /*-----------------------------------------------------------*/
\r
143 * The number of SysTick increments that make up one tick period.
\r
145 static unsigned long ulTimerReloadValueForOneTick = 0;
\r
148 * The maximum number of tick periods that can be suppressed is limited by the
\r
149 * 24 bit resolution of the SysTick timer.
\r
151 #if configUSE_TICKLESS_IDLE == 1
\r
152 static unsigned long xMaximumPossibleSuppressedTicks = 0;
\r
153 #endif /* configUSE_TICKLESS_IDLE */
\r
156 /*-----------------------------------------------------------*/
\r
159 * See header file for description.
\r
161 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )
\r
163 /* Simulate the stack frame as it would be created by a context switch
\r
165 pxTopOfStack--; /* Offset added to account for the way the MCU uses the stack on entry/exit of interrupts. */
\r
166 *pxTopOfStack = portINITIAL_XPSR; /* xPSR */
\r
168 *pxTopOfStack = ( portSTACK_TYPE ) pxCode; /* PC */
\r
170 *pxTopOfStack = 0; /* LR */
\r
171 pxTopOfStack -= 5; /* R12, R3, R2 and R1. */
\r
172 *pxTopOfStack = ( portSTACK_TYPE ) pvParameters; /* R0 */
\r
173 pxTopOfStack -= 8; /* R11, R10, R9, R8, R7, R6, R5 and R4. */
\r
175 return pxTopOfStack;
\r
177 /*-----------------------------------------------------------*/
\r
179 void vPortSVCHandler( void )
\r
182 " ldr r3, pxCurrentTCBConst2 \n" /* Restore the context. */
\r
183 " ldr r1, [r3] \n" /* Use pxCurrentTCBConst to get the pxCurrentTCB address. */
\r
184 " ldr r0, [r1] \n" /* The first item in pxCurrentTCB is the task top of stack. */
\r
185 " ldmia r0!, {r4-r11} \n" /* Pop the registers that are not automatically saved on exception entry and the critical nesting count. */
\r
186 " msr psp, r0 \n" /* Restore the task stack pointer. */
\r
188 " msr basepri, r0 \n"
\r
189 " orr r14, #0xd \n"
\r
193 "pxCurrentTCBConst2: .word pxCurrentTCB \n"
\r
196 /*-----------------------------------------------------------*/
\r
198 static void prvPortStartFirstTask( void )
\r
201 " ldr r0, =0xE000ED08 \n" /* Use the NVIC offset register to locate the stack. */
\r
204 " msr msp, r0 \n" /* Set the msp back to the start of the stack. */
\r
205 " cpsie i \n" /* Globally enable interrupts. */
\r
206 " svc 0 \n" /* System call to start first task. */
\r
210 /*-----------------------------------------------------------*/
\r
213 * See header file for description.
\r
215 portBASE_TYPE xPortStartScheduler( void )
\r
217 /* configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.
\r
218 See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
\r
219 configASSERT( configMAX_SYSCALL_INTERRUPT_PRIORITY );
\r
221 /* Make PendSV, CallSV and SysTick the same priroity as the kernel. */
\r
222 portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;
\r
223 portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;
\r
225 /* Start the timer that generates the tick ISR. Interrupts are disabled
\r
227 prvSetupTimerInterrupt();
\r
229 /* Initialise the critical nesting count ready for the first task. */
\r
230 uxCriticalNesting = 0;
\r
232 /* Start the first task. */
\r
233 prvPortStartFirstTask();
\r
235 /* Should not get here! */
\r
238 /*-----------------------------------------------------------*/
\r
240 void vPortEndScheduler( void )
\r
242 /* It is unlikely that the CM3 port will require this function as there
\r
243 is nothing to return to. */
\r
245 /*-----------------------------------------------------------*/
\r
247 void vPortYieldFromISR( void )
\r
249 /* Set a PendSV to request a context switch. */
\r
250 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
252 /*-----------------------------------------------------------*/
\r
254 void vPortEnterCritical( void )
\r
256 portDISABLE_INTERRUPTS();
\r
257 uxCriticalNesting++;
\r
259 /*-----------------------------------------------------------*/
\r
261 void vPortExitCritical( void )
\r
263 uxCriticalNesting--;
\r
264 if( uxCriticalNesting == 0 )
\r
266 portENABLE_INTERRUPTS();
\r
269 /*-----------------------------------------------------------*/
\r
271 __attribute__(( naked )) unsigned long ulPortSetInterruptMask( void )
\r
275 " mrs r0, basepri \n" \
\r
277 " msr basepri, r1 \n" \
\r
279 :: "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY ) : "r0", "r1" \
\r
282 /* This return will not be reached but is necessary to prevent compiler
\r
286 /*-----------------------------------------------------------*/
\r
288 __attribute__(( naked )) void vPortClearInterruptMask( unsigned long ulNewMaskValue )
\r
292 " msr basepri, r0 \n" \
\r
297 /*-----------------------------------------------------------*/
\r
299 void xPortPendSVHandler( void )
\r
301 /* This is a naked function. */
\r
307 " ldr r3, pxCurrentTCBConst \n" /* Get the location of the current TCB. */
\r
310 " stmdb r0!, {r4-r11} \n" /* Save the remaining registers. */
\r
311 " str r0, [r2] \n" /* Save the new top of stack into the first member of the TCB. */
\r
313 " stmdb sp!, {r3, r14} \n"
\r
315 " msr basepri, r0 \n"
\r
316 " bl vTaskSwitchContext \n"
\r
318 " msr basepri, r0 \n"
\r
319 " ldmia sp!, {r3, r14} \n"
\r
320 " \n" /* Restore the context, including the critical nesting count. */
\r
322 " ldr r0, [r1] \n" /* The first item in pxCurrentTCB is the task top of stack. */
\r
323 " ldmia r0!, {r4-r11} \n" /* Pop the registers. */
\r
328 "pxCurrentTCBConst: .word pxCurrentTCB \n"
\r
329 ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY)
\r
332 /*-----------------------------------------------------------*/
\r
334 void xPortSysTickHandler( void )
\r
336 /* If using preemption, also force a context switch. */
\r
337 #if configUSE_PREEMPTION == 1
\r
338 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
341 #if configUSE_TICKLESS_IDLE == 1
\r
342 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;
\r
345 ( void ) portSET_INTERRUPT_MASK_FROM_ISR();
\r
347 vTaskIncrementTick();
\r
349 portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );
\r
351 /*-----------------------------------------------------------*/
\r
353 #if configUSE_TICKLESS_IDLE == 1
\r
355 __attribute__((weak)) void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )
\r
357 unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickIncrements;
\r
359 /* Make sure the SysTick reload value does not overflow the counter. */
\r
360 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )
\r
362 xExpectedIdleTime = xMaximumPossibleSuppressedTicks;
\r
365 /* Calculate the reload value required to wait xExpectedIdleTime
\r
366 tick periods. -1 is used because this code will execute part way
\r
367 through one of the tick periods, and the fraction of a tick period is
\r
368 accounted for later. */
\r
369 ulReloadValue = ( ulTimerReloadValueForOneTick * ( xExpectedIdleTime - 1UL ) );
\r
370 if( ulReloadValue > ulStoppedTimerCompensation )
\r
372 ulReloadValue -= ulStoppedTimerCompensation;
\r
375 /* Stop the SysTick momentarily. The time the SysTick is stopped for
\r
376 is accounted for as best it can be, but using the tickless mode will
\r
377 inevitably result in some tiny drift of the time maintained by the
\r
378 kernel with respect to calendar time. */
\r
379 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
381 /* If a context switch is pending then abandon the low power entry as
\r
382 the context switch might have been pended by an external interrupt that
\r
383 requires processing. */
\r
384 if( ( portNVIC_INT_CTRL_REG & portNVIC_PENDSVSET_BIT ) != 0 )
\r
386 /* Restart SysTick. */
\r
387 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
391 /* Adjust the reload value to take into account that the current
\r
392 time slice is already partially complete. */
\r
393 ulReloadValue += ( portNVIC_SYSTICK_LOAD_REG - ( portNVIC_SYSTICK_LOAD_REG - portNVIC_SYSTICK_CURRENT_VALUE_REG ) );
\r
394 portNVIC_SYSTICK_LOAD_REG = ulReloadValue;
\r
396 /* Clear the SysTick count flag and set the count value back to
\r
398 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
400 /* Restart SysTick. */
\r
401 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
403 /* Sleep until something happens. */
\r
404 portPRE_SLEEP_PROCESSING();
\r
405 __asm volatile( "wfi" );
\r
406 portPOST_SLEEP_PROCESSING();
\r
408 /* Stop SysTick. Again, the time the SysTick is stopped for is
\r
409 accounted for as best it can be, but using the tickless mode will
\r
410 inevitably result in some tiny drift of the time maintained by the
\r
411 kernel with respect to calendar time. */
\r
412 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
414 if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )
\r
416 /* The tick interrupt has already executed, and the SysTick
\r
417 count reloaded with the portNVIC_SYSTICK_LOAD_REG value.
\r
418 Reset the portNVIC_SYSTICK_LOAD_REG with whatever remains of
\r
419 this tick period. */
\r
420 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );
\r
422 /* The tick interrupt handler will already have pended the tick
\r
423 processing in the kernel. As the pending tick will be
\r
424 processed as soon as this function exits, the tick value
\r
425 maintained by the tick is stepped forward by one less than the
\r
426 time spent waiting. */
\r
427 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;
\r
431 /* Something other than the tick interrupt ended the sleep.
\r
432 Work out how long the sleep lasted. */
\r
433 ulCompletedSysTickIncrements = ( xExpectedIdleTime * ulTimerReloadValueForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;
\r
435 /* How many complete tick periods passed while the processor
\r
437 ulCompleteTickPeriods = ulCompletedSysTickIncrements / ulTimerReloadValueForOneTick;
\r
439 /* The reload value is set to whatever fraction of a single tick
\r
441 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerReloadValueForOneTick ) - ulCompletedSysTickIncrements;
\r
444 /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG
\r
445 again, then set portNVIC_SYSTICK_LOAD_REG back to its standard
\r
447 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
448 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
450 vTaskStepTick( ulCompleteTickPeriods );
\r
454 #endif /* #if configUSE_TICKLESS_IDLE */
\r
455 /*-----------------------------------------------------------*/
\r
458 * Setup the systick timer to generate the tick interrupts at the required
\r
461 void prvSetupTimerInterrupt( void )
\r
463 /* Calculate the constants required to configure the tick interrupt. */
\r
464 ulTimerReloadValueForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;
\r
465 #if configUSE_TICKLESS_IDLE == 1
\r
466 xMaximumPossibleSuppressedTicks = 0xffffffUL / ( ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL );
\r
467 #endif /* configUSE_TICKLESS_IDLE */
\r
469 /* Configure SysTick to interrupt at the requested rate. */
\r
470 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;
\r
471 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
473 /*-----------------------------------------------------------*/
\r