2 FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.
\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
7 ***************************************************************************
\r
9 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
10 * Complete, revised, and edited pdf reference manuals are also *
\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
20 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
22 * Thank you for using FreeRTOS, and thank you for your support! *
\r
24 ***************************************************************************
\r
27 This file is part of the FreeRTOS distribution.
\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 >>>NOTE<<< The modification to the GPL is included to allow you to
\r
33 distribute a combined work that includes FreeRTOS without being obliged to
\r
34 provide the source code for proprietary components outside of the FreeRTOS
\r
35 kernel. FreeRTOS is distributed in the hope that it will be useful, but
\r
36 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
\r
37 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
38 more details. You should have received a copy of the GNU General Public
\r
39 License and the FreeRTOS license exception along with FreeRTOS; if not it
\r
40 can be viewed here: http://www.freertos.org/a00114.html and also obtained
\r
41 by writing to Richard Barry, contact details for whom are available on the
\r
46 ***************************************************************************
\r
48 * Having a problem? Start by reading the FAQ "My application does *
\r
49 * not run, what could be wrong?" *
\r
51 * http://www.FreeRTOS.org/FAQHelp.html *
\r
53 ***************************************************************************
\r
56 http://www.FreeRTOS.org - Documentation, training, latest versions, license
\r
57 and contact details.
\r
59 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
60 including FreeRTOS+Trace - an indispensable productivity tool.
\r
62 Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell
\r
63 the code with commercial support, indemnification, and middleware, under
\r
64 the OpenRTOS brand: http://www.OpenRTOS.com. High Integrity Systems also
\r
65 provide a safety engineered and independently SIL3 certified version under
\r
66 the SafeRTOS brand: http://www.SafeRTOS.com.
\r
69 /*-----------------------------------------------------------
\r
70 * Implementation of functions defined in portable.h for the ARM CM3 port.
\r
71 *----------------------------------------------------------*/
\r
73 /* Scheduler includes. */
\r
74 #include "FreeRTOS.h"
\r
77 #ifndef configKERNEL_INTERRUPT_PRIORITY
\r
78 #define configKERNEL_INTERRUPT_PRIORITY 255
\r
81 #if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0
\r
82 #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0. See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
\r
85 #ifndef configSYSTICK_CLOCK_HZ
\r
86 #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ
\r
89 /* The __weak attribute does not work as you might expect with the Keil tools
\r
90 so the configOVERRIDE_DEFAULT_TICK_CONFIGURATION constant must be set to 1 if
\r
91 the application writer wants to provide their own implementation of
\r
92 vPortSetupTimerInterrupt(). Ensure configOVERRIDE_DEFAULT_TICK_CONFIGURATION
\r
94 #ifndef configOVERRIDE_DEFAULT_TICK_CONFIGURATION
\r
95 #define configOVERRIDE_DEFAULT_TICK_CONFIGURATION 0
\r
98 /* Constants required to manipulate the core. Registers first... */
\r
99 #define portNVIC_SYSTICK_CTRL_REG ( * ( ( volatile unsigned long * ) 0xe000e010 ) )
\r
100 #define portNVIC_SYSTICK_LOAD_REG ( * ( ( volatile unsigned long * ) 0xe000e014 ) )
\r
101 #define portNVIC_SYSTICK_CURRENT_VALUE_REG ( * ( ( volatile unsigned long * ) 0xe000e018 ) )
\r
102 #define portNVIC_INT_CTRL_REG ( * ( ( volatile unsigned long * ) 0xe000ed04 ) )
\r
103 #define portNVIC_SYSPRI2_REG ( * ( ( volatile unsigned long * ) 0xe000ed20 ) )
\r
104 /* ...then bits in the registers. */
\r
105 #define portNVIC_SYSTICK_CLK_BIT ( 1UL << 2UL )
\r
106 #define portNVIC_SYSTICK_INT_BIT ( 1UL << 1UL )
\r
107 #define portNVIC_SYSTICK_ENABLE_BIT ( 1UL << 0UL )
\r
108 #define portNVIC_SYSTICK_COUNT_FLAG_BIT ( 1UL << 16UL )
\r
109 #define portNVIC_PENDSVSET_BIT ( 1UL << 28UL )
\r
110 #define portNVIC_PENDSVCLEAR_BIT ( 1UL << 27UL )
\r
111 #define portNVIC_PEND_SYSTICK_CLEAR_BIT ( 1UL << 25UL )
\r
113 #define portNVIC_PENDSV_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16 )
\r
114 #define portNVIC_SYSTICK_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24 )
\r
116 /* Constants required to set up the initial stack. */
\r
117 #define portINITIAL_XPSR ( 0x01000000 )
\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. The implementation in this
\r
125 * file is weak to allow application writers to change the timer used to
\r
126 * generate the tick interrupt.
\r
128 void vPortSetupTimerInterrupt( void );
\r
131 * Exception handlers.
\r
133 void xPortPendSVHandler( void );
\r
134 void xPortSysTickHandler( void );
\r
135 void vPortSVCHandler( void );
\r
138 * Start first task is a separate function so it can be tested in isolation.
\r
140 static void prvStartFirstTask( void );
\r
142 /*-----------------------------------------------------------*/
\r
145 * The number of SysTick increments that make up one tick period.
\r
147 #if configUSE_TICKLESS_IDLE == 1
\r
148 static unsigned long ulTimerReloadValueForOneTick = 0;
\r
152 * The maximum number of tick periods that can be suppressed is limited by the
\r
153 * 24 bit resolution of the SysTick timer.
\r
155 #if configUSE_TICKLESS_IDLE == 1
\r
156 static unsigned long xMaximumPossibleSuppressedTicks = 0;
\r
157 #endif /* configUSE_TICKLESS_IDLE */
\r
160 * Compensate for the CPU cycles that pass while the SysTick is stopped (low
\r
161 * power functionality only.
\r
163 #if configUSE_TICKLESS_IDLE == 1
\r
164 static unsigned long ulStoppedTimerCompensation = 0;
\r
165 #endif /* configUSE_TICKLESS_IDLE */
\r
167 /*-----------------------------------------------------------*/
\r
170 * See header file for description.
\r
172 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )
\r
174 /* Simulate the stack frame as it would be created by a context switch
\r
176 pxTopOfStack--; /* Offset added to account for the way the MCU uses the stack on entry/exit of interrupts. */
\r
177 *pxTopOfStack = portINITIAL_XPSR; /* xPSR */
\r
179 *pxTopOfStack = ( portSTACK_TYPE ) pxCode; /* PC */
\r
181 *pxTopOfStack = 0; /* LR */
\r
182 pxTopOfStack -= 5; /* R12, R3, R2 and R1. */
\r
183 *pxTopOfStack = ( portSTACK_TYPE ) pvParameters; /* R0 */
\r
184 pxTopOfStack -= 8; /* R11, R10, R9, R8, R7, R6, R5 and R4. */
\r
186 return pxTopOfStack;
\r
188 /*-----------------------------------------------------------*/
\r
190 __asm void vPortSVCHandler( void )
\r
194 ldr r3, =pxCurrentTCB /* Restore the context. */
\r
195 ldr r1, [r3] /* Use pxCurrentTCBConst to get the pxCurrentTCB address. */
\r
196 ldr r0, [r1] /* The first item in pxCurrentTCB is the task top of stack. */
\r
197 ldmia r0!, {r4-r11} /* Pop the registers that are not automatically saved on exception entry and the critical nesting count. */
\r
198 msr psp, r0 /* Restore the task stack pointer. */
\r
204 /*-----------------------------------------------------------*/
\r
206 __asm void prvStartFirstTask( void )
\r
210 /* Use the NVIC offset register to locate the stack. */
\r
211 ldr r0, =0xE000ED08
\r
214 /* Set the msp back to the start of the stack. */
\r
216 /* Globally enable interrupts. */
\r
218 /* Call SVC to start the first task. */
\r
222 /*-----------------------------------------------------------*/
\r
225 * See header file for description.
\r
227 portBASE_TYPE xPortStartScheduler( void )
\r
229 /* Make PendSV, CallSV and SysTick the same priority as the kernel. */
\r
230 portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;
\r
231 portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;
\r
233 /* Start the timer that generates the tick ISR. Interrupts are disabled
\r
235 vPortSetupTimerInterrupt();
\r
237 /* Initialise the critical nesting count ready for the first task. */
\r
238 uxCriticalNesting = 0;
\r
240 /* Start the first task. */
\r
241 prvStartFirstTask();
\r
243 /* Should not get here! */
\r
246 /*-----------------------------------------------------------*/
\r
248 void vPortEndScheduler( void )
\r
250 /* It is unlikely that the CM3 port will require this function as there
\r
251 is nothing to return to. */
\r
253 /*-----------------------------------------------------------*/
\r
255 void vPortYieldFromISR( void )
\r
257 /* Set a PendSV to request a context switch. */
\r
258 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
260 /*-----------------------------------------------------------*/
\r
262 void vPortEnterCritical( void )
\r
264 portDISABLE_INTERRUPTS();
\r
265 uxCriticalNesting++;
\r
267 /*-----------------------------------------------------------*/
\r
269 void vPortExitCritical( void )
\r
271 uxCriticalNesting--;
\r
272 if( uxCriticalNesting == 0 )
\r
274 portENABLE_INTERRUPTS();
\r
277 /*-----------------------------------------------------------*/
\r
279 __asm void xPortPendSVHandler( void )
\r
281 extern uxCriticalNesting;
\r
282 extern pxCurrentTCB;
\r
283 extern vTaskSwitchContext;
\r
289 ldr r3, =pxCurrentTCB /* Get the location of the current TCB. */
\r
292 stmdb r0!, {r4-r11} /* Save the remaining registers. */
\r
293 str r0, [r2] /* Save the new top of stack into the first member of the TCB. */
\r
295 stmdb sp!, {r3, r14}
\r
296 mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY
\r
298 bl vTaskSwitchContext
\r
301 ldmia sp!, {r3, r14}
\r
304 ldr r0, [r1] /* The first item in pxCurrentTCB is the task top of stack. */
\r
305 ldmia r0!, {r4-r11} /* Pop the registers and the critical nesting count. */
\r
310 /*-----------------------------------------------------------*/
\r
312 void xPortSysTickHandler( void )
\r
314 #if configUSE_PREEMPTION == 1
\r
316 /* If using preemption, also force a context switch. */
\r
317 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
321 /* Only reset the systick load register if configUSE_TICKLESS_IDLE is set to
\r
322 1. If it is set to 0 tickless idle is not being used. If it is set to a
\r
323 value other than 0 or 1 then a timer other than the SysTick is being used
\r
324 to generate the tick interrupt. */
\r
325 #if configUSE_TICKLESS_IDLE == 1
\r
326 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;
\r
329 ( void ) portSET_INTERRUPT_MASK_FROM_ISR();
\r
331 vTaskIncrementTick();
\r
333 portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );
\r
335 /*-----------------------------------------------------------*/
\r
337 #if configUSE_TICKLESS_IDLE == 1
\r
339 __weak void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )
\r
341 unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickIncrements;
\r
342 portTickType xModifiableIdleTime;
\r
344 /* Make sure the SysTick reload value does not overflow the counter. */
\r
345 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )
\r
347 xExpectedIdleTime = xMaximumPossibleSuppressedTicks;
\r
350 /* Calculate the reload value required to wait xExpectedIdleTime
\r
351 tick periods. -1 is used because this code will execute part way
\r
352 through one of the tick periods, and the fraction of a tick period is
\r
353 accounted for later. */
\r
354 ulReloadValue = ( ulTimerReloadValueForOneTick * ( xExpectedIdleTime - 1UL ) );
\r
355 if( ulReloadValue > ulStoppedTimerCompensation )
\r
357 ulReloadValue -= ulStoppedTimerCompensation;
\r
360 /* Stop the SysTick momentarily. The time the SysTick is stopped for
\r
361 is accounted for as best it can be, but using the tickless mode will
\r
362 inevitably result in some tiny drift of the time maintained by the
\r
363 kernel with respect to calendar time. */
\r
364 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
366 /* If a context switch is pending then abandon the low power entry as
\r
367 the context switch might have been pended by an external interrupt that
\r
368 requires processing. */
\r
369 if( ( portNVIC_INT_CTRL_REG & portNVIC_PENDSVSET_BIT ) != 0 )
\r
371 /* Restart SysTick. */
\r
372 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
376 /* Adjust the reload value to take into account that the current
\r
377 time slice is already partially complete. */
\r
378 ulReloadValue += ( portNVIC_SYSTICK_LOAD_REG - ( portNVIC_SYSTICK_LOAD_REG - portNVIC_SYSTICK_CURRENT_VALUE_REG ) );
\r
379 portNVIC_SYSTICK_LOAD_REG = ulReloadValue;
\r
381 /* Clear the SysTick count flag and set the count value back to
\r
383 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
385 /* Restart SysTick. */
\r
386 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
388 /* Sleep until something happens. configPRE_SLEEP_PROCESSING() can
\r
389 set its parameter to 0 to indicate that its implementation contains
\r
390 its own wait for interrupt or wait for event instruction, and so wfi
\r
391 should not be executed again. However, the original expected idle
\r
392 time variable must remain unmodified, so a copy is taken. */
\r
393 xModifiableIdleTime = xExpectedIdleTime;
\r
394 configPRE_SLEEP_PROCESSING( xModifiableIdleTime );
\r
395 if( xModifiableIdleTime > 0 )
\r
399 configPOST_SLEEP_PROCESSING( xExpectedIdleTime );
\r
401 /* Stop SysTick. Again, the time the SysTick is stopped for is
\r
402 accounted for as best it can be, but using the tickless mode will
\r
403 inevitably result in some tiny drift of the time maintained by the
\r
404 kernel with respect to calendar time. */
\r
405 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
407 if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )
\r
409 /* The tick interrupt has already executed, and the SysTick
\r
410 count reloaded with the portNVIC_SYSTICK_LOAD_REG value.
\r
411 Reset the portNVIC_SYSTICK_LOAD_REG with whatever remains of
\r
412 this tick period. */
\r
413 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );
\r
415 /* The tick interrupt handler will already have pended the tick
\r
416 processing in the kernel. As the pending tick will be
\r
417 processed as soon as this function exits, the tick value
\r
418 maintained by the tick is stepped forward by one less than the
\r
419 time spent waiting. */
\r
420 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;
\r
424 /* Something other than the tick interrupt ended the sleep.
\r
425 Work out how long the sleep lasted. */
\r
426 ulCompletedSysTickIncrements = ( xExpectedIdleTime * ulTimerReloadValueForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;
\r
428 /* How many complete tick periods passed while the processor
\r
430 ulCompleteTickPeriods = ulCompletedSysTickIncrements / ulTimerReloadValueForOneTick;
\r
432 /* The reload value is set to whatever fraction of a single tick
\r
434 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerReloadValueForOneTick ) - ulCompletedSysTickIncrements;
\r
437 /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG
\r
438 again, then set portNVIC_SYSTICK_LOAD_REG back to its standard
\r
440 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
441 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
443 vTaskStepTick( ulCompleteTickPeriods );
\r
447 #endif /* #if configUSE_TICKLESS_IDLE */
\r
449 /*-----------------------------------------------------------*/
\r
452 * Setup the SysTick timer to generate the tick interrupts at the required
\r
455 #if configOVERRIDE_DEFAULT_TICK_CONFIGURATION == 0
\r
457 void vPortSetupTimerInterrupt( void )
\r
459 /* Calculate the constants required to configure the tick interrupt. */
\r
460 #if configUSE_TICKLESS_IDLE == 1
\r
462 ulTimerReloadValueForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;
\r
463 xMaximumPossibleSuppressedTicks = 0xffffffUL / ( ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL );
\r
464 ulStoppedTimerCompensation = 45UL / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );
\r
466 #endif /* configUSE_TICKLESS_IDLE */
\r
468 /* Configure SysTick to interrupt at the requested rate. */
\r
469 portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;;
\r
470 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
473 #endif /* configOVERRIDE_DEFAULT_TICK_CONFIGURATION */
\r
474 /*-----------------------------------------------------------*/
\r
476 __asm unsigned long ulPortSetInterruptMask( void )
\r
481 mov r1, #configMAX_SYSCALL_INTERRUPT_PRIORITY
\r
485 /*-----------------------------------------------------------*/
\r
487 __asm void vPortClearInterruptMask( unsigned long ulNewMask )
\r