2 FreeRTOS V7.4.0 - Copyright (C) 2013 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
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
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
49 ***************************************************************************
\r
51 * Having a problem? Start by reading the FAQ "My application does *
\r
52 * not run, what could be wrong?" *
\r
54 * http://www.FreeRTOS.org/FAQHelp.html *
\r
56 ***************************************************************************
\r
59 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
60 license and Real Time Engineers Ltd. contact details.
\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
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
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
75 /*-----------------------------------------------------------
\r
76 * Implementation of functions defined in portable.h for the ARM CM3 port.
\r
77 *----------------------------------------------------------*/
\r
79 /* Scheduler includes. */
\r
80 #include "FreeRTOS.h"
\r
83 /* For backward compatibility, ensure configKERNEL_INTERRUPT_PRIORITY is
\r
84 defined. The value should also ensure backward compatibility.
\r
85 FreeRTOS.org versions prior to V4.4.0 did not include this definition. */
\r
86 #ifndef configKERNEL_INTERRUPT_PRIORITY
\r
87 #define configKERNEL_INTERRUPT_PRIORITY 255
\r
90 #ifndef configSYSTICK_CLOCK_HZ
\r
91 #define configSYSTICK_CLOCK_HZ configCPU_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. 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 ) __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 #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 void vPortSVCHandler( void )
\r
193 " ldr r3, pxCurrentTCBConst2 \n" /* Restore the context. */
\r
194 " ldr r1, [r3] \n" /* Use pxCurrentTCBConst to get the pxCurrentTCB address. */
\r
195 " ldr r0, [r1] \n" /* The first item in pxCurrentTCB is the task top of stack. */
\r
196 " ldmia r0!, {r4-r11} \n" /* Pop the registers that are not automatically saved on exception entry and the critical nesting count. */
\r
197 " msr psp, r0 \n" /* Restore the task stack pointer. */
\r
199 " msr basepri, r0 \n"
\r
200 " orr r14, #0xd \n"
\r
204 "pxCurrentTCBConst2: .word pxCurrentTCB \n"
\r
207 /*-----------------------------------------------------------*/
\r
209 static void prvPortStartFirstTask( void )
\r
212 " ldr r0, =0xE000ED08 \n" /* Use the NVIC offset register to locate the stack. */
\r
215 " msr msp, r0 \n" /* Set the msp back to the start of the stack. */
\r
216 " cpsie i \n" /* Globally enable interrupts. */
\r
217 " svc 0 \n" /* System call to start first task. */
\r
221 /*-----------------------------------------------------------*/
\r
224 * See header file for description.
\r
226 portBASE_TYPE xPortStartScheduler( void )
\r
228 /* configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.
\r
229 See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
\r
230 configASSERT( configMAX_SYSCALL_INTERRUPT_PRIORITY );
\r
232 /* Make PendSV, CallSV and SysTick the same priroity as the kernel. */
\r
233 portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;
\r
234 portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;
\r
236 /* Start the timer that generates the tick ISR. Interrupts are disabled
\r
238 vPortSetupTimerInterrupt();
\r
240 /* Initialise the critical nesting count ready for the first task. */
\r
241 uxCriticalNesting = 0;
\r
243 /* Start the first task. */
\r
244 prvPortStartFirstTask();
\r
246 /* Should not get here! */
\r
249 /*-----------------------------------------------------------*/
\r
251 void vPortEndScheduler( void )
\r
253 /* It is unlikely that the CM3 port will require this function as there
\r
254 is nothing to return to. */
\r
256 /*-----------------------------------------------------------*/
\r
258 void vPortYield( void )
\r
260 /* Set a PendSV to request a context switch. */
\r
261 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
263 /* Barriers are normally not required but do ensure the code is completely
\r
264 within the specified behaviour for the architecture. */
\r
265 __asm volatile( "dsb" );
\r
266 __asm volatile( "isb" );
\r
268 /*-----------------------------------------------------------*/
\r
270 void vPortEnterCritical( void )
\r
272 portDISABLE_INTERRUPTS();
\r
273 uxCriticalNesting++;
\r
274 __asm volatile( "dsb" );
\r
275 __asm volatile( "isb" );
\r
277 /*-----------------------------------------------------------*/
\r
279 void vPortExitCritical( void )
\r
281 uxCriticalNesting--;
\r
282 if( uxCriticalNesting == 0 )
\r
284 portENABLE_INTERRUPTS();
\r
287 /*-----------------------------------------------------------*/
\r
289 __attribute__(( naked )) unsigned long ulPortSetInterruptMask( void )
\r
293 " mrs r0, basepri \n" \
\r
295 " msr basepri, r1 \n" \
\r
297 :: "i" ( configMAX_SYSCALL_INTERRUPT_PRIORITY ) : "r0", "r1" \
\r
300 /* This return will not be reached but is necessary to prevent compiler
\r
304 /*-----------------------------------------------------------*/
\r
306 __attribute__(( naked )) void vPortClearInterruptMask( unsigned long ulNewMaskValue )
\r
310 " msr basepri, r0 \n" \
\r
315 /* Just to avoid compiler warnings. */
\r
316 ( void ) ulNewMaskValue;
\r
318 /*-----------------------------------------------------------*/
\r
320 void xPortPendSVHandler( void )
\r
322 /* This is a naked function. */
\r
328 " ldr r3, pxCurrentTCBConst \n" /* Get the location of the current TCB. */
\r
331 " stmdb r0!, {r4-r11} \n" /* Save the remaining registers. */
\r
332 " str r0, [r2] \n" /* Save the new top of stack into the first member of the TCB. */
\r
334 " stmdb sp!, {r3, r14} \n"
\r
336 " msr basepri, r0 \n"
\r
337 " bl vTaskSwitchContext \n"
\r
339 " msr basepri, r0 \n"
\r
340 " ldmia sp!, {r3, r14} \n"
\r
341 " \n" /* Restore the context, including the critical nesting count. */
\r
343 " ldr r0, [r1] \n" /* The first item in pxCurrentTCB is the task top of stack. */
\r
344 " ldmia r0!, {r4-r11} \n" /* Pop the registers. */
\r
349 "pxCurrentTCBConst: .word pxCurrentTCB \n"
\r
350 ::"i"(configMAX_SYSCALL_INTERRUPT_PRIORITY)
\r
353 /*-----------------------------------------------------------*/
\r
355 void xPortSysTickHandler( void )
\r
357 /* If using preemption, also force a context switch. */
\r
358 #if configUSE_PREEMPTION == 1
\r
359 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
362 /* Only reset the systick load register if configUSE_TICKLESS_IDLE is set to
\r
363 1. If it is set to 0 tickless idle is not being used. If it is set to a
\r
364 value other than 0 or 1 then a timer other than the SysTick is being used
\r
365 to generate the tick interrupt. */
\r
366 #if configUSE_TICKLESS_IDLE == 1
\r
367 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;
\r
370 ( void ) portSET_INTERRUPT_MASK_FROM_ISR();
\r
372 vTaskIncrementTick();
\r
374 portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );
\r
376 /*-----------------------------------------------------------*/
\r
378 #if configUSE_TICKLESS_IDLE == 1
\r
380 __attribute__((weak)) void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )
\r
382 unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickIncrements;
\r
383 portTickType xModifiableIdleTime;
\r
385 /* Make sure the SysTick reload value does not overflow the counter. */
\r
386 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )
\r
388 xExpectedIdleTime = xMaximumPossibleSuppressedTicks;
\r
391 /* Calculate the reload value required to wait xExpectedIdleTime
\r
392 tick periods. -1 is used because this code will execute part way
\r
393 through one of the tick periods, and the fraction of a tick period is
\r
394 accounted for later. */
\r
395 ulReloadValue = ( ulTimerReloadValueForOneTick * ( xExpectedIdleTime - 1UL ) );
\r
396 if( ulReloadValue > ulStoppedTimerCompensation )
\r
398 ulReloadValue -= ulStoppedTimerCompensation;
\r
401 /* Stop the SysTick momentarily. The time the SysTick is stopped for
\r
402 is 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 /* Adjust the reload value to take into account that the current time
\r
408 slice is already partially complete. */
\r
409 ulReloadValue += ( portNVIC_SYSTICK_LOAD_REG - ( portNVIC_SYSTICK_LOAD_REG - portNVIC_SYSTICK_CURRENT_VALUE_REG ) );
\r
411 /* Enter a critical section but don't use the taskENTER_CRITICAL()
\r
412 method as that will mask interrupts that should exit sleep mode. */
\r
413 __asm volatile( "cpsid i" );
\r
415 /* If a context switch is pending or a task is waiting for the scheduler
\r
416 to be unsuspended then abandon the low power entry. */
\r
417 if( eTaskConfirmSleepModeStatus() == eAbortSleep )
\r
419 /* Restart SysTick. */
\r
420 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
422 /* Re-enable interrupts - see comments above the cpsid instruction()
\r
424 __asm volatile( "cpsie i" );
\r
428 /* Set the new reload value. */
\r
429 portNVIC_SYSTICK_LOAD_REG = ulReloadValue;
\r
431 /* Clear the SysTick count flag and set the count value back to
\r
433 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
435 /* Restart SysTick. */
\r
436 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
438 /* Sleep until something happens. configPRE_SLEEP_PROCESSING() can
\r
439 set its parameter to 0 to indicate that its implementation contains
\r
440 its own wait for interrupt or wait for event instruction, and so wfi
\r
441 should not be executed again. However, the original expected idle
\r
442 time variable must remain unmodified, so a copy is taken. */
\r
443 xModifiableIdleTime = xExpectedIdleTime;
\r
444 configPRE_SLEEP_PROCESSING( xModifiableIdleTime );
\r
445 if( xModifiableIdleTime > 0 )
\r
447 __asm volatile( "wfi" );
\r
448 __asm volatile( "dsb" );
\r
449 __asm volatile( "isb" );
\r
451 configPOST_SLEEP_PROCESSING( xExpectedIdleTime );
\r
453 /* Stop SysTick. Again, the time the SysTick is stopped for is
\r
454 accounted for as best it can be, but using the tickless mode will
\r
455 inevitably result in some tiny drift of the time maintained by the
\r
456 kernel with respect to calendar time. */
\r
457 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
459 /* Re-enable interrupts - see comments above the cpsid instruction()
\r
461 __asm volatile( "cpsie i" );
\r
463 if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )
\r
465 /* The tick interrupt has already executed, and the SysTick
\r
466 count reloaded with the portNVIC_SYSTICK_LOAD_REG value.
\r
467 Reset the portNVIC_SYSTICK_LOAD_REG with whatever remains of
\r
468 this tick period. */
\r
469 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );
\r
471 /* The tick interrupt handler will already have pended the tick
\r
472 processing in the kernel. As the pending tick will be
\r
473 processed as soon as this function exits, the tick value
\r
474 maintained by the tick is stepped forward by one less than the
\r
475 time spent waiting. */
\r
476 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;
\r
480 /* Something other than the tick interrupt ended the sleep.
\r
481 Work out how long the sleep lasted. */
\r
482 ulCompletedSysTickIncrements = ( xExpectedIdleTime * ulTimerReloadValueForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;
\r
484 /* How many complete tick periods passed while the processor
\r
486 ulCompleteTickPeriods = ulCompletedSysTickIncrements / ulTimerReloadValueForOneTick;
\r
488 /* The reload value is set to whatever fraction of a single tick
\r
490 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerReloadValueForOneTick ) - ulCompletedSysTickIncrements;
\r
493 /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG
\r
494 again, then set portNVIC_SYSTICK_LOAD_REG back to its standard
\r
496 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
497 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
499 vTaskStepTick( ulCompleteTickPeriods );
\r
503 #endif /* #if configUSE_TICKLESS_IDLE */
\r
504 /*-----------------------------------------------------------*/
\r
507 * Setup the systick timer to generate the tick interrupts at the required
\r
510 __attribute__(( weak )) void vPortSetupTimerInterrupt( void )
\r
512 /* Calculate the constants required to configure the tick interrupt. */
\r
513 #if configUSE_TICKLESS_IDLE == 1
\r
515 ulTimerReloadValueForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;
\r
516 xMaximumPossibleSuppressedTicks = 0xffffffUL / ( ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL );
\r
517 ulStoppedTimerCompensation = 45UL / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );
\r
519 #endif /* configUSE_TICKLESS_IDLE */
\r
521 /* Configure SysTick to interrupt at the requested rate. */
\r
522 portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;;
\r
523 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
525 /*-----------------------------------------------------------*/
\r