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 /* For backward compatibility, ensure configKERNEL_INTERRUPT_PRIORITY is
\r
78 defined. The value should also ensure backward compatibility.
\r
79 FreeRTOS.org versions prior to V4.4.0 did not include this definition. */
\r
80 #ifndef configKERNEL_INTERRUPT_PRIORITY
\r
81 #define configKERNEL_INTERRUPT_PRIORITY 255
\r
84 #ifndef configSYSTICK_CLOCK_HZ
\r
85 #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ
\r
86 #if configUSE_TICKLESS_IDLE == 1
\r
87 static const unsigned long ulStoppedTimerCompensation = 45UL;
\r
89 #else /* configSYSTICK_CLOCK_HZ */
\r
90 #if configUSE_TICKLESS_IDLE == 1
\r
91 /* Assumes the SysTick clock is slower than the CPU clock. */
\r
92 static const unsigned long ulStoppedTimerCompensation = 45UL / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );
\r
94 #endif /* configSYSTICK_CLOCK_HZ */
\r
96 /* Constants required to manipulate the core. Registers first... */
\r
97 #define portNVIC_SYSTICK_CTRL_REG ( * ( ( volatile unsigned long * ) 0xe000e010 ) )
\r
98 #define portNVIC_SYSTICK_LOAD_REG ( * ( ( volatile unsigned long * ) 0xe000e014 ) )
\r
99 #define portNVIC_SYSTICK_CURRENT_VALUE_REG ( * ( ( volatile unsigned long * ) 0xe000e018 ) )
\r
100 #define portNVIC_INT_CTRL_REG ( * ( ( volatile unsigned long * ) 0xe000ed04 ) )
\r
101 #define portNVIC_SYSPRI2_REG ( * ( ( volatile unsigned long * ) 0xe000ed20 ) )
\r
102 /* ...then bits in the registers. */
\r
103 #define portNVIC_SYSTICK_CLK_BIT ( 1UL << 2UL )
\r
104 #define portNVIC_SYSTICK_INT_BIT ( 1UL << 1UL )
\r
105 #define portNVIC_SYSTICK_ENABLE_BIT ( 1UL << 0UL )
\r
106 #define portNVIC_SYSTICK_COUNT_FLAG_BIT ( 1UL << 16UL )
\r
107 #define portNVIC_PENDSVSET_BIT ( 1UL << 28UL )
\r
108 #define portNVIC_PENDSVCLEAR_BIT ( 1UL << 27UL )
\r
109 #define portNVIC_PEND_SYSTICK_CLEAR_BIT ( 1UL << 25UL )
\r
111 #define portNVIC_PENDSV_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16UL )
\r
112 #define portNVIC_SYSTICK_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )
\r
114 /* Constants required to set up the initial stack. */
\r
115 #define portINITIAL_XPSR ( 0x01000000 )
\r
117 /* The priority used by the kernel is assigned to a variable to make access
\r
118 from inline assembler easier. */
\r
119 const unsigned long ulKernelPriority = configKERNEL_INTERRUPT_PRIORITY;
\r
121 /* Each task maintains its own interrupt status in the critical nesting
\r
123 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;
\r
126 * Setup the timer to generate the tick interrupts.
\r
128 static void prvSetupTimerInterrupt( void );
\r
131 * Exception handlers.
\r
133 void xPortPendSVHandler( void ) __attribute__ (( naked ));
\r
134 void xPortSysTickHandler( void );
\r
135 void vPortSVCHandler( void ) __attribute__ (( naked ));
\r
138 * Start first task is a separate function so it can be tested in isolation.
\r
140 static void prvPortStartFirstTask( void ) __attribute__ (( naked ));
\r
142 /*-----------------------------------------------------------*/
\r
145 * The number of SysTick increments that make up one tick period.
\r
147 static unsigned long ulTimerReloadValueForOneTick = 0;
\r
150 * The maximum number of tick periods that can be suppressed is limited by the
\r
151 * 24 bit resolution of the SysTick timer.
\r
153 #if configUSE_TICKLESS_IDLE == 1
\r
154 static unsigned long xMaximumPossibleSuppressedTicks = 0;
\r
155 #endif /* configUSE_TICKLESS_IDLE */
\r
158 /*-----------------------------------------------------------*/
\r
161 * See header file for description.
\r
163 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )
\r
165 /* Simulate the stack frame as it would be created by a context switch
\r
167 pxTopOfStack--; /* Offset added to account for the way the MCU uses the stack on entry/exit of interrupts. */
\r
168 *pxTopOfStack = portINITIAL_XPSR; /* xPSR */
\r
170 *pxTopOfStack = ( portSTACK_TYPE ) pxCode; /* PC */
\r
172 *pxTopOfStack = 0; /* LR */
\r
173 pxTopOfStack -= 5; /* R12, R3, R2 and R1. */
\r
174 *pxTopOfStack = ( portSTACK_TYPE ) pvParameters; /* R0 */
\r
175 pxTopOfStack -= 8; /* R11, R10, R9, R8, R7, R6, R5 and R4. */
\r
177 return pxTopOfStack;
\r
179 /*-----------------------------------------------------------*/
\r
181 void vPortSVCHandler( void )
\r
184 " ldr r3, pxCurrentTCBConst2 \n" /* Restore the context. */
\r
185 " ldr r1, [r3] \n" /* Use pxCurrentTCBConst to get the pxCurrentTCB address. */
\r
186 " ldr r0, [r1] \n" /* The first item in pxCurrentTCB is the task top of stack. */
\r
187 " ldmia r0!, {r4-r11} \n" /* Pop the registers that are not automatically saved on exception entry and the critical nesting count. */
\r
188 " msr psp, r0 \n" /* Restore the task stack pointer. */
\r
190 " msr basepri, r0 \n"
\r
191 " orr r14, #0xd \n"
\r
195 "pxCurrentTCBConst2: .word pxCurrentTCB \n"
\r
198 /*-----------------------------------------------------------*/
\r
200 static void prvPortStartFirstTask( void )
\r
203 " ldr r0, =0xE000ED08 \n" /* Use the NVIC offset register to locate the stack. */
\r
206 " msr msp, r0 \n" /* Set the msp back to the start of the stack. */
\r
207 " cpsie i \n" /* Globally enable interrupts. */
\r
208 " svc 0 \n" /* System call to start first task. */
\r
212 /*-----------------------------------------------------------*/
\r
215 * See header file for description.
\r
217 portBASE_TYPE xPortStartScheduler( void )
\r
219 /* configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.
\r
220 See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
\r
221 configASSERT( configMAX_SYSCALL_INTERRUPT_PRIORITY );
\r
223 /* Make PendSV, CallSV and SysTick the same priroity as the kernel. */
\r
224 portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;
\r
225 portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;
\r
227 /* Start the timer that generates the tick ISR. Interrupts are disabled
\r
229 prvSetupTimerInterrupt();
\r
231 /* Initialise the critical nesting count ready for the first task. */
\r
232 uxCriticalNesting = 0;
\r
234 /* Start the first task. */
\r
235 prvPortStartFirstTask();
\r
237 /* Should not get here! */
\r
240 /*-----------------------------------------------------------*/
\r
242 void vPortEndScheduler( void )
\r
244 /* It is unlikely that the CM3 port will require this function as there
\r
245 is nothing to return to. */
\r
247 /*-----------------------------------------------------------*/
\r
249 void vPortYieldFromISR( void )
\r
251 /* Set a PendSV to request a context switch. */
\r
252 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
254 /*-----------------------------------------------------------*/
\r
256 void vPortEnterCritical( void )
\r
258 portDISABLE_INTERRUPTS();
\r
259 uxCriticalNesting++;
\r
261 /*-----------------------------------------------------------*/
\r
263 void vPortExitCritical( void )
\r
265 uxCriticalNesting--;
\r
266 if( uxCriticalNesting == 0 )
\r
268 portENABLE_INTERRUPTS();
\r
271 /*-----------------------------------------------------------*/
\r
273 __attribute__(( naked )) unsigned long ulPortSetInterruptMask( void )
\r
277 " mrs r0, basepri \n" \
\r
279 " msr basepri, r1 \n" \
\r
281 :: "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY ) : "r0", "r1" \
\r
284 /* This return will not be reached but is necessary to prevent compiler
\r
288 /*-----------------------------------------------------------*/
\r
290 __attribute__(( naked )) void vPortClearInterruptMask( unsigned long ulNewMaskValue )
\r
294 " msr basepri, r0 \n" \
\r
299 /*-----------------------------------------------------------*/
\r
301 void xPortPendSVHandler( void )
\r
303 /* This is a naked function. */
\r
309 " ldr r3, pxCurrentTCBConst \n" /* Get the location of the current TCB. */
\r
312 " stmdb r0!, {r4-r11} \n" /* Save the remaining registers. */
\r
313 " str r0, [r2] \n" /* Save the new top of stack into the first member of the TCB. */
\r
315 " stmdb sp!, {r3, r14} \n"
\r
317 " msr basepri, r0 \n"
\r
318 " bl vTaskSwitchContext \n"
\r
320 " msr basepri, r0 \n"
\r
321 " ldmia sp!, {r3, r14} \n"
\r
322 " \n" /* Restore the context, including the critical nesting count. */
\r
324 " ldr r0, [r1] \n" /* The first item in pxCurrentTCB is the task top of stack. */
\r
325 " ldmia r0!, {r4-r11} \n" /* Pop the registers. */
\r
330 "pxCurrentTCBConst: .word pxCurrentTCB \n"
\r
331 ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY)
\r
334 /*-----------------------------------------------------------*/
\r
336 void xPortSysTickHandler( void )
\r
338 /* If using preemption, also force a context switch. */
\r
339 #if configUSE_PREEMPTION == 1
\r
340 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
343 #if configUSE_TICKLESS_IDLE == 1
\r
344 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;
\r
347 ( void ) portSET_INTERRUPT_MASK_FROM_ISR();
\r
349 vTaskIncrementTick();
\r
351 portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );
\r
353 /*-----------------------------------------------------------*/
\r
355 #if configUSE_TICKLESS_IDLE == 1
\r
357 __attribute__((weak)) void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )
\r
359 unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickIncrements;
\r
361 /* Make sure the SysTick reload value does not overflow the counter. */
\r
362 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )
\r
364 xExpectedIdleTime = xMaximumPossibleSuppressedTicks;
\r
367 /* Calculate the reload value required to wait xExpectedIdleTime
\r
368 tick periods. -1 is used because this code will execute part way
\r
369 through one of the tick periods, and the fraction of a tick period is
\r
370 accounted for later. */
\r
371 ulReloadValue = ( ulTimerReloadValueForOneTick * ( xExpectedIdleTime - 1UL ) );
\r
372 if( ulReloadValue > ulStoppedTimerCompensation )
\r
374 ulReloadValue -= ulStoppedTimerCompensation;
\r
377 /* Stop the SysTick momentarily. The time the SysTick is stopped for
\r
378 is accounted for as best it can be, but using the tickless mode will
\r
379 inevitably result in some tiny drift of the time maintained by the
\r
380 kernel with respect to calendar time. */
\r
381 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
383 /* If a context switch is pending then abandon the low power entry as
\r
384 the context switch might have been pended by an external interrupt that
\r
385 requires processing. */
\r
386 if( ( portNVIC_INT_CTRL_REG & portNVIC_PENDSVSET_BIT ) != 0 )
\r
388 /* Restart SysTick. */
\r
389 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
393 /* Adjust the reload value to take into account that the current
\r
394 time slice is already partially complete. */
\r
395 ulReloadValue += ( portNVIC_SYSTICK_LOAD_REG - ( portNVIC_SYSTICK_LOAD_REG - portNVIC_SYSTICK_CURRENT_VALUE_REG ) );
\r
396 portNVIC_SYSTICK_LOAD_REG = ulReloadValue;
\r
398 /* Clear the SysTick count flag and set the count value back to
\r
400 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
402 /* Restart SysTick. */
\r
403 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
405 /* Sleep until something happens. */
\r
406 configPRE_SLEEP_PROCESSING();
\r
407 __asm volatile( "wfi" );
\r
408 configPOST_SLEEP_PROCESSING();
\r
410 /* Stop SysTick. Again, the time the SysTick is stopped for is
\r
411 accounted for as best it can be, but using the tickless mode will
\r
412 inevitably result in some tiny drift of the time maintained by the
\r
413 kernel with respect to calendar time. */
\r
414 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
416 if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )
\r
418 /* The tick interrupt has already executed, and the SysTick
\r
419 count reloaded with the portNVIC_SYSTICK_LOAD_REG value.
\r
420 Reset the portNVIC_SYSTICK_LOAD_REG with whatever remains of
\r
421 this tick period. */
\r
422 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );
\r
424 /* The tick interrupt handler will already have pended the tick
\r
425 processing in the kernel. As the pending tick will be
\r
426 processed as soon as this function exits, the tick value
\r
427 maintained by the tick is stepped forward by one less than the
\r
428 time spent waiting. */
\r
429 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;
\r
433 /* Something other than the tick interrupt ended the sleep.
\r
434 Work out how long the sleep lasted. */
\r
435 ulCompletedSysTickIncrements = ( xExpectedIdleTime * ulTimerReloadValueForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;
\r
437 /* How many complete tick periods passed while the processor
\r
439 ulCompleteTickPeriods = ulCompletedSysTickIncrements / ulTimerReloadValueForOneTick;
\r
441 /* The reload value is set to whatever fraction of a single tick
\r
443 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerReloadValueForOneTick ) - ulCompletedSysTickIncrements;
\r
446 /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG
\r
447 again, then set portNVIC_SYSTICK_LOAD_REG back to its standard
\r
449 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
450 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
452 vTaskStepTick( ulCompleteTickPeriods );
\r
456 #endif /* #if configUSE_TICKLESS_IDLE */
\r
457 /*-----------------------------------------------------------*/
\r
460 * Setup the systick timer to generate the tick interrupts at the required
\r
463 void prvSetupTimerInterrupt( void )
\r
465 /* Calculate the constants required to configure the tick interrupt. */
\r
466 ulTimerReloadValueForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;
\r
467 #if configUSE_TICKLESS_IDLE == 1
\r
468 xMaximumPossibleSuppressedTicks = 0xffffffUL / ( ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL );
\r
469 #endif /* configUSE_TICKLESS_IDLE */
\r
471 /* Configure SysTick to interrupt at the requested rate. */
\r
472 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;
\r
473 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
475 /*-----------------------------------------------------------*/
\r