2 FreeRTOS V7.4.1 - 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 it can 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 #ifndef configKERNEL_INTERRUPT_PRIORITY
\r
84 #define configKERNEL_INTERRUPT_PRIORITY 255
\r
87 #if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0
\r
88 #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0. See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
\r
91 #ifndef configSYSTICK_CLOCK_HZ
\r
92 #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ
\r
95 /* The __weak attribute does not work as you might expect with the Keil tools
\r
96 so the configOVERRIDE_DEFAULT_TICK_CONFIGURATION constant must be set to 1 if
\r
97 the application writer wants to provide their own implementation of
\r
98 vPortSetupTimerInterrupt(). Ensure configOVERRIDE_DEFAULT_TICK_CONFIGURATION
\r
100 #ifndef configOVERRIDE_DEFAULT_TICK_CONFIGURATION
\r
101 #define configOVERRIDE_DEFAULT_TICK_CONFIGURATION 0
\r
104 /* Constants required to manipulate the core. Registers first... */
\r
105 #define portNVIC_SYSTICK_CTRL_REG ( * ( ( volatile unsigned long * ) 0xe000e010 ) )
\r
106 #define portNVIC_SYSTICK_LOAD_REG ( * ( ( volatile unsigned long * ) 0xe000e014 ) )
\r
107 #define portNVIC_SYSTICK_CURRENT_VALUE_REG ( * ( ( volatile unsigned long * ) 0xe000e018 ) )
\r
108 #define portNVIC_SYSPRI2_REG ( * ( ( volatile unsigned long * ) 0xe000ed20 ) )
\r
109 /* ...then bits in the registers. */
\r
110 #define portNVIC_SYSTICK_CLK_BIT ( 1UL << 2UL )
\r
111 #define portNVIC_SYSTICK_INT_BIT ( 1UL << 1UL )
\r
112 #define portNVIC_SYSTICK_ENABLE_BIT ( 1UL << 0UL )
\r
113 #define portNVIC_SYSTICK_COUNT_FLAG_BIT ( 1UL << 16UL )
\r
114 #define portNVIC_PENDSVCLEAR_BIT ( 1UL << 27UL )
\r
115 #define portNVIC_PEND_SYSTICK_CLEAR_BIT ( 1UL << 25UL )
\r
117 #define portNVIC_PENDSV_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16 )
\r
118 #define portNVIC_SYSTICK_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24 )
\r
120 /* Constants required to set up the initial stack. */
\r
121 #define portINITIAL_XPSR ( 0x01000000 )
\r
123 /* Constants used with memory barrier intrinsics. */
\r
124 #define portSY_FULL_READ_WRITE ( 15 )
\r
126 /* Each task maintains its own interrupt status in the critical nesting
\r
128 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;
\r
131 * Setup the timer to generate the tick interrupts. The implementation in this
\r
132 * file is weak to allow application writers to change the timer used to
\r
133 * generate the tick interrupt.
\r
135 void vPortSetupTimerInterrupt( void );
\r
138 * Exception handlers.
\r
140 void xPortPendSVHandler( void );
\r
141 void xPortSysTickHandler( void );
\r
142 void vPortSVCHandler( void );
\r
145 * Start first task is a separate function so it can be tested in isolation.
\r
147 static void prvStartFirstTask( void );
\r
149 /*-----------------------------------------------------------*/
\r
152 * The number of SysTick increments that make up one tick period.
\r
154 #if configUSE_TICKLESS_IDLE == 1
\r
155 static unsigned long ulTimerReloadValueForOneTick = 0;
\r
159 * The maximum number of tick periods that can be suppressed is limited by the
\r
160 * 24 bit resolution of the SysTick timer.
\r
162 #if configUSE_TICKLESS_IDLE == 1
\r
163 static unsigned long xMaximumPossibleSuppressedTicks = 0;
\r
164 #endif /* configUSE_TICKLESS_IDLE */
\r
167 * Compensate for the CPU cycles that pass while the SysTick is stopped (low
\r
168 * power functionality only.
\r
170 #if configUSE_TICKLESS_IDLE == 1
\r
171 static unsigned long ulStoppedTimerCompensation = 0;
\r
172 #endif /* configUSE_TICKLESS_IDLE */
\r
174 /*-----------------------------------------------------------*/
\r
177 * See header file for description.
\r
179 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )
\r
181 /* Simulate the stack frame as it would be created by a context switch
\r
183 pxTopOfStack--; /* Offset added to account for the way the MCU uses the stack on entry/exit of interrupts. */
\r
184 *pxTopOfStack = portINITIAL_XPSR; /* xPSR */
\r
186 *pxTopOfStack = ( portSTACK_TYPE ) pxCode; /* PC */
\r
188 *pxTopOfStack = 0; /* LR */
\r
189 pxTopOfStack -= 5; /* R12, R3, R2 and R1. */
\r
190 *pxTopOfStack = ( portSTACK_TYPE ) pvParameters; /* R0 */
\r
191 pxTopOfStack -= 8; /* R11, R10, R9, R8, R7, R6, R5 and R4. */
\r
193 return pxTopOfStack;
\r
195 /*-----------------------------------------------------------*/
\r
197 __asm void vPortSVCHandler( void )
\r
201 ldr r3, =pxCurrentTCB /* Restore the context. */
\r
202 ldr r1, [r3] /* Use pxCurrentTCBConst to get the pxCurrentTCB address. */
\r
203 ldr r0, [r1] /* The first item in pxCurrentTCB is the task top of stack. */
\r
204 ldmia r0!, {r4-r11} /* Pop the registers that are not automatically saved on exception entry and the critical nesting count. */
\r
205 msr psp, r0 /* Restore the task stack pointer. */
\r
211 /*-----------------------------------------------------------*/
\r
213 __asm void prvStartFirstTask( void )
\r
217 /* Use the NVIC offset register to locate the stack. */
\r
218 ldr r0, =0xE000ED08
\r
221 /* Set the msp back to the start of the stack. */
\r
223 /* Globally enable interrupts. */
\r
225 /* Call SVC to start the first task. */
\r
229 /*-----------------------------------------------------------*/
\r
232 * See header file for description.
\r
234 portBASE_TYPE xPortStartScheduler( void )
\r
236 /* Make PendSV, CallSV and SysTick the same priority as the kernel. */
\r
237 portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;
\r
238 portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;
\r
240 /* Start the timer that generates the tick ISR. Interrupts are disabled
\r
242 vPortSetupTimerInterrupt();
\r
244 /* Initialise the critical nesting count ready for the first task. */
\r
245 uxCriticalNesting = 0;
\r
247 /* Start the first task. */
\r
248 prvStartFirstTask();
\r
250 /* Should not get here! */
\r
253 /*-----------------------------------------------------------*/
\r
255 void vPortEndScheduler( void )
\r
257 /* It is unlikely that the CM3 port will require this function as there
\r
258 is nothing to return to. */
\r
260 /*-----------------------------------------------------------*/
\r
262 void vPortYield( void )
\r
264 /* Set a PendSV to request a context switch. */
\r
265 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
267 /* Barriers are normally not required but do ensure the code is completely
\r
268 within the specified behaviour for the architecture. */
\r
269 __dsb( portSY_FULL_READ_WRITE );
\r
270 __isb( portSY_FULL_READ_WRITE );
\r
272 /*-----------------------------------------------------------*/
\r
274 void vPortEnterCritical( void )
\r
276 portDISABLE_INTERRUPTS();
\r
277 uxCriticalNesting++;
\r
278 __dsb( portSY_FULL_READ_WRITE );
\r
279 __isb( portSY_FULL_READ_WRITE );
\r
281 /*-----------------------------------------------------------*/
\r
283 void vPortExitCritical( void )
\r
285 uxCriticalNesting--;
\r
286 if( uxCriticalNesting == 0 )
\r
288 portENABLE_INTERRUPTS();
\r
291 /*-----------------------------------------------------------*/
\r
293 __asm void xPortPendSVHandler( void )
\r
295 extern uxCriticalNesting;
\r
296 extern pxCurrentTCB;
\r
297 extern vTaskSwitchContext;
\r
303 ldr r3, =pxCurrentTCB /* Get the location of the current TCB. */
\r
306 stmdb r0!, {r4-r11} /* Save the remaining registers. */
\r
307 str r0, [r2] /* Save the new top of stack into the first member of the TCB. */
\r
309 stmdb sp!, {r3, r14}
\r
310 mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY
\r
312 bl vTaskSwitchContext
\r
315 ldmia sp!, {r3, r14}
\r
318 ldr r0, [r1] /* The first item in pxCurrentTCB is the task top of stack. */
\r
319 ldmia r0!, {r4-r11} /* Pop the registers and the critical nesting count. */
\r
324 /*-----------------------------------------------------------*/
\r
326 void xPortSysTickHandler( void )
\r
328 #if configUSE_PREEMPTION == 1
\r
330 /* If using preemption, also force a context switch. */
\r
331 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
335 /* Only reset the systick load register if configUSE_TICKLESS_IDLE is set to
\r
336 1. If it is set to 0 tickless idle is not being used. If it is set to a
\r
337 value other than 0 or 1 then a timer other than the SysTick is being used
\r
338 to generate the tick interrupt. */
\r
339 #if configUSE_TICKLESS_IDLE == 1
\r
340 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;
\r
343 ( void ) portSET_INTERRUPT_MASK_FROM_ISR();
\r
345 vTaskIncrementTick();
\r
347 portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );
\r
349 /*-----------------------------------------------------------*/
\r
351 #if configUSE_TICKLESS_IDLE == 1
\r
353 __weak void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )
\r
355 unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickIncrements;
\r
356 portTickType xModifiableIdleTime;
\r
358 /* Make sure the SysTick reload value does not overflow the counter. */
\r
359 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )
\r
361 xExpectedIdleTime = xMaximumPossibleSuppressedTicks;
\r
364 /* Calculate the reload value required to wait xExpectedIdleTime
\r
365 tick periods. -1 is used because this code will execute part way
\r
366 through one of the tick periods, and the fraction of a tick period is
\r
367 accounted for later. */
\r
368 ulReloadValue = ( ulTimerReloadValueForOneTick * ( xExpectedIdleTime - 1UL ) );
\r
369 if( ulReloadValue > ulStoppedTimerCompensation )
\r
371 ulReloadValue -= ulStoppedTimerCompensation;
\r
374 /* Stop the SysTick momentarily. The time the SysTick is stopped for
\r
375 is accounted for as best it can be, but using the tickless mode will
\r
376 inevitably result in some tiny drift of the time maintained by the
\r
377 kernel with respect to calendar time. */
\r
378 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
380 /* Adjust the reload value to take into account that the current
\r
381 time slice is already partially complete. */
\r
382 ulReloadValue += ( portNVIC_SYSTICK_LOAD_REG - ( portNVIC_SYSTICK_LOAD_REG - portNVIC_SYSTICK_CURRENT_VALUE_REG ) );
\r
384 /* Enter a critical section but don't use the taskENTER_CRITICAL()
\r
385 method as that will mask interrupts that should exit sleep mode. */
\r
388 /* If a context switch is pending or a task is waiting for the scheduler
\r
389 to be unsuspended then abandon the low power entry. */
\r
390 if( eTaskConfirmSleepModeStatus() == eAbortSleep )
\r
392 /* Restart SysTick. */
\r
393 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
395 /* Re-enable interrupts - see comments above __disable_irq() call
\r
401 /* Set the new reload value. */
\r
402 portNVIC_SYSTICK_LOAD_REG = ulReloadValue;
\r
404 /* Clear the SysTick count flag and set the count value back to
\r
406 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
408 /* Restart SysTick. */
\r
409 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
411 /* Sleep until something happens. configPRE_SLEEP_PROCESSING() can
\r
412 set its parameter to 0 to indicate that its implementation contains
\r
413 its own wait for interrupt or wait for event instruction, and so wfi
\r
414 should not be executed again. However, the original expected idle
\r
415 time variable must remain unmodified, so a copy is taken. */
\r
416 xModifiableIdleTime = xExpectedIdleTime;
\r
417 configPRE_SLEEP_PROCESSING( xModifiableIdleTime );
\r
418 if( xModifiableIdleTime > 0 )
\r
421 __dsb( portSY_FULL_READ_WRITE );
\r
422 __isb( portSY_FULL_READ_WRITE );
\r
424 configPOST_SLEEP_PROCESSING( xExpectedIdleTime );
\r
426 /* Stop SysTick. Again, the time the SysTick is stopped for is
\r
427 accounted for as best it can be, but using the tickless mode will
\r
428 inevitably result in some tiny drift of the time maintained by the
\r
429 kernel with respect to calendar time. */
\r
430 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
432 /* Re-enable interrupts - see comments above __disable_irq() call
\r
436 if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )
\r
438 /* The tick interrupt has already executed, and the SysTick
\r
439 count reloaded with the portNVIC_SYSTICK_LOAD_REG value.
\r
440 Reset the portNVIC_SYSTICK_LOAD_REG with whatever remains of
\r
441 this tick period. */
\r
442 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );
\r
444 /* The tick interrupt handler will already have pended the tick
\r
445 processing in the kernel. As the pending tick will be
\r
446 processed as soon as this function exits, the tick value
\r
447 maintained by the tick is stepped forward by one less than the
\r
448 time spent waiting. */
\r
449 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;
\r
453 /* Something other than the tick interrupt ended the sleep.
\r
454 Work out how long the sleep lasted. */
\r
455 ulCompletedSysTickIncrements = ( xExpectedIdleTime * ulTimerReloadValueForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;
\r
457 /* How many complete tick periods passed while the processor
\r
459 ulCompleteTickPeriods = ulCompletedSysTickIncrements / ulTimerReloadValueForOneTick;
\r
461 /* The reload value is set to whatever fraction of a single tick
\r
463 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerReloadValueForOneTick ) - ulCompletedSysTickIncrements;
\r
466 /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG
\r
467 again, then set portNVIC_SYSTICK_LOAD_REG back to its standard
\r
469 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
470 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
472 vTaskStepTick( ulCompleteTickPeriods );
\r
476 #endif /* #if configUSE_TICKLESS_IDLE */
\r
478 /*-----------------------------------------------------------*/
\r
481 * Setup the SysTick timer to generate the tick interrupts at the required
\r
484 #if configOVERRIDE_DEFAULT_TICK_CONFIGURATION == 0
\r
486 void vPortSetupTimerInterrupt( void )
\r
488 /* Calculate the constants required to configure the tick interrupt. */
\r
489 #if configUSE_TICKLESS_IDLE == 1
\r
491 ulTimerReloadValueForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;
\r
492 xMaximumPossibleSuppressedTicks = 0xffffffUL / ( ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL );
\r
493 ulStoppedTimerCompensation = 45UL / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );
\r
495 #endif /* configUSE_TICKLESS_IDLE */
\r
497 /* Configure SysTick to interrupt at the requested rate. */
\r
498 portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;;
\r
499 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
502 #endif /* configOVERRIDE_DEFAULT_TICK_CONFIGURATION */
\r
503 /*-----------------------------------------------------------*/
\r
505 __asm unsigned long ulPortSetInterruptMask( void )
\r
510 mov r1, #configMAX_SYSCALL_INTERRUPT_PRIORITY
\r
514 /*-----------------------------------------------------------*/
\r
516 __asm void vPortClearInterruptMask( unsigned long ulNewMask )
\r