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 CM4F port.
\r
77 *----------------------------------------------------------*/
\r
79 /* Scheduler includes. */
\r
80 #include "FreeRTOS.h"
\r
83 #ifndef __TARGET_FPU_VFP
\r
84 #error This port can only be used when the project options are configured to enable hardware floating point support.
\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_INT_CTRL_REG ( * ( ( volatile unsigned long * ) 0xe000ed04 ) )
\r
109 #define portNVIC_SYSPRI2_REG ( * ( ( volatile unsigned long * ) 0xe000ed20 ) )
\r
110 /* ...then bits in the registers. */
\r
111 #define portNVIC_SYSTICK_CLK_BIT ( 1UL << 2UL )
\r
112 #define portNVIC_SYSTICK_INT_BIT ( 1UL << 1UL )
\r
113 #define portNVIC_SYSTICK_ENABLE_BIT ( 1UL << 0UL )
\r
114 #define portNVIC_SYSTICK_COUNT_FLAG_BIT ( 1UL << 16UL )
\r
115 #define portNVIC_PENDSVSET_BIT ( 1UL << 28UL )
\r
116 #define portNVIC_PENDSVCLEAR_BIT ( 1UL << 27UL )
\r
117 #define portNVIC_PEND_SYSTICK_CLEAR_BIT ( 1UL << 25UL )
\r
119 #define portNVIC_PENDSV_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16 )
\r
120 #define portNVIC_SYSTICK_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24 )
\r
122 /* Constants required to manipulate the VFP. */
\r
123 #define portFPCCR ( ( volatile unsigned long * ) 0xe000ef34 ) /* Floating point context control register. */
\r
124 #define portASPEN_AND_LSPEN_BITS ( 0x3UL << 30UL )
\r
126 /* Constants required to set up the initial stack. */
\r
127 #define portINITIAL_XPSR ( 0x01000000 )
\r
128 #define portINITIAL_EXEC_RETURN ( 0xfffffffd )
\r
130 /* Each task maintains its own interrupt status in the critical nesting
\r
132 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;
\r
135 * Setup the timer to generate the tick interrupts. The implementation in this
\r
136 * file is weak to allow application writers to change the timer used to
\r
137 * generate the tick interrupt.
\r
139 void vPortSetupTimerInterrupt( void );
\r
142 * Exception handlers.
\r
144 void xPortPendSVHandler( void );
\r
145 void xPortSysTickHandler( void );
\r
146 void vPortSVCHandler( void );
\r
149 * Start first task is a separate function so it can be tested in isolation.
\r
151 static void prvStartFirstTask( void );
\r
154 * Functions defined in portasm.s to enable the VFP.
\r
156 static void prvEnableVFP( void );
\r
157 /*-----------------------------------------------------------*/
\r
160 * The number of SysTick increments that make up one tick period.
\r
162 #if configUSE_TICKLESS_IDLE == 1
\r
163 static unsigned long ulTimerReloadValueForOneTick = 0;
\r
167 * The maximum number of tick periods that can be suppressed is limited by the
\r
168 * 24 bit resolution of the SysTick timer.
\r
170 #if configUSE_TICKLESS_IDLE == 1
\r
171 static unsigned long xMaximumPossibleSuppressedTicks = 0;
\r
172 #endif /* configUSE_TICKLESS_IDLE */
\r
175 * Compensate for the CPU cycles that pass while the SysTick is stopped (low
\r
176 * power functionality only.
\r
178 #if configUSE_TICKLESS_IDLE == 1
\r
179 static unsigned long ulStoppedTimerCompensation = 0;
\r
180 #endif /* configUSE_TICKLESS_IDLE */
\r
182 /*-----------------------------------------------------------*/
\r
185 * See header file for description.
\r
187 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )
\r
189 /* Simulate the stack frame as it would be created by a context switch
\r
192 /* Offset added to account for the way the MCU uses the stack on entry/exit
\r
193 of interrupts, and to ensure alignment. */
\r
196 *pxTopOfStack = portINITIAL_XPSR; /* xPSR */
\r
198 *pxTopOfStack = ( portSTACK_TYPE ) pxCode; /* PC */
\r
200 *pxTopOfStack = 0; /* LR */
\r
202 /* Save code space by skipping register initialisation. */
\r
203 pxTopOfStack -= 5; /* R12, R3, R2 and R1. */
\r
204 *pxTopOfStack = ( portSTACK_TYPE ) pvParameters; /* R0 */
\r
206 /* A save method is being used that requires each task to maintain its
\r
207 own exec return value. */
\r
209 *pxTopOfStack = portINITIAL_EXEC_RETURN;
\r
211 pxTopOfStack -= 8; /* R11, R10, R9, R8, R7, R6, R5 and R4. */
\r
213 return pxTopOfStack;
\r
215 /*-----------------------------------------------------------*/
\r
217 __asm void vPortSVCHandler( void )
\r
221 /* Get the location of the current TCB. */
\r
222 ldr r3, =pxCurrentTCB
\r
225 /* Pop the core registers. */
\r
226 ldmia r0!, {r4-r11, r14}
\r
232 /*-----------------------------------------------------------*/
\r
234 __asm void prvStartFirstTask( void )
\r
238 /* Use the NVIC offset register to locate the stack. */
\r
239 ldr r0, =0xE000ED08
\r
242 /* Set the msp back to the start of the stack. */
\r
244 /* Globally enable interrupts. */
\r
246 /* Call SVC to start the first task. */
\r
250 /*-----------------------------------------------------------*/
\r
252 __asm void prvEnableVFP( void )
\r
256 /* The FPU enable bits are in the CPACR. */
\r
257 ldr.w r0, =0xE000ED88
\r
260 /* Enable CP10 and CP11 coprocessors, then save back. */
\r
261 orr r1, r1, #( 0xf << 20 )
\r
266 /*-----------------------------------------------------------*/
\r
269 * See header file for description.
\r
271 portBASE_TYPE xPortStartScheduler( void )
\r
273 /* Make PendSV, CallSV and SysTick the same priroity as the kernel. */
\r
274 portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;
\r
275 portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;
\r
277 /* Start the timer that generates the tick ISR. Interrupts are disabled
\r
279 vPortSetupTimerInterrupt();
\r
281 /* Initialise the critical nesting count ready for the first task. */
\r
282 uxCriticalNesting = 0;
\r
284 /* Ensure the VFP is enabled - it should be anyway. */
\r
287 /* Lazy save always. */
\r
288 *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;
\r
290 /* Start the first task. */
\r
291 prvStartFirstTask();
\r
293 /* Should not get here! */
\r
296 /*-----------------------------------------------------------*/
\r
298 void vPortEndScheduler( void )
\r
300 /* It is unlikely that the CM4F port will require this function as there
\r
301 is nothing to return to. */
\r
303 /*-----------------------------------------------------------*/
\r
305 void vPortYieldFromISR( void )
\r
307 /* Set a PendSV to request a context switch. */
\r
308 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
310 /*-----------------------------------------------------------*/
\r
312 void vPortEnterCritical( void )
\r
314 portDISABLE_INTERRUPTS();
\r
315 uxCriticalNesting++;
\r
317 /*-----------------------------------------------------------*/
\r
319 void vPortExitCritical( void )
\r
321 uxCriticalNesting--;
\r
322 if( uxCriticalNesting == 0 )
\r
324 portENABLE_INTERRUPTS();
\r
327 /*-----------------------------------------------------------*/
\r
329 __asm void xPortPendSVHandler( void )
\r
331 extern uxCriticalNesting;
\r
332 extern pxCurrentTCB;
\r
333 extern vTaskSwitchContext;
\r
339 /* Get the location of the current TCB. */
\r
340 ldr r3, =pxCurrentTCB
\r
343 /* Is the task using the FPU context? If so, push high vfp registers. */
\r
346 vstmdbeq r0!, {s16-s31}
\r
348 /* Save the core registers. */
\r
349 stmdb r0!, {r4-r11, r14}
\r
351 /* Save the new top of stack into the first member of the TCB. */
\r
354 stmdb sp!, {r3, r14}
\r
355 mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY
\r
357 bl vTaskSwitchContext
\r
360 ldmia sp!, {r3, r14}
\r
362 /* The first item in pxCurrentTCB is the task top of stack. */
\r
366 /* Pop the core registers. */
\r
367 ldmia r0!, {r4-r11, r14}
\r
369 /* Is the task using the FPU context? If so, pop the high vfp registers
\r
373 vldmiaeq r0!, {s16-s31}
\r
379 /*-----------------------------------------------------------*/
\r
381 void xPortSysTickHandler( void )
\r
383 #if configUSE_PREEMPTION == 1
\r
385 /* If using preemption, also force a context switch. */
\r
386 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
390 /* Only reset the systick load register if configUSE_TICKLESS_IDLE is set to
\r
391 1. If it is set to 0 tickless idle is not being used. If it is set to a
\r
392 value other than 0 or 1 then a timer other than the SysTick is being used
\r
393 to generate the tick interrupt. */
\r
394 #if configUSE_TICKLESS_IDLE == 1
\r
395 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;
\r
398 ( void ) portSET_INTERRUPT_MASK_FROM_ISR();
\r
400 vTaskIncrementTick();
\r
402 portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );
\r
404 /*-----------------------------------------------------------*/
\r
406 #if configUSE_TICKLESS_IDLE == 1
\r
408 __weak void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )
\r
410 unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickIncrements;
\r
411 portTickType xModifiableIdleTime;
\r
413 /* Make sure the SysTick reload value does not overflow the counter. */
\r
414 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )
\r
416 xExpectedIdleTime = xMaximumPossibleSuppressedTicks;
\r
419 /* Calculate the reload value required to wait xExpectedIdleTime
\r
420 tick periods. -1 is used because this code will execute part way
\r
421 through one of the tick periods, and the fraction of a tick period is
\r
422 accounted for later. */
\r
423 ulReloadValue = ( ulTimerReloadValueForOneTick * ( xExpectedIdleTime - 1UL ) );
\r
424 if( ulReloadValue > ulStoppedTimerCompensation )
\r
426 ulReloadValue -= ulStoppedTimerCompensation;
\r
429 /* Stop the SysTick momentarily. The time the SysTick is stopped for
\r
430 is accounted for as best it can be, but using the tickless mode will
\r
431 inevitably result in some tiny drift of the time maintained by the
\r
432 kernel with respect to calendar time. */
\r
433 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
435 /* Adjust the reload value to take into account that the current
\r
436 time slice is already partially complete. */
\r
437 ulReloadValue += ( portNVIC_SYSTICK_LOAD_REG - ( portNVIC_SYSTICK_LOAD_REG - portNVIC_SYSTICK_CURRENT_VALUE_REG ) );
\r
439 /* Enter a critical section but don't use the taskENTER_CRITICAL()
\r
440 method as that will mask interrupts that should exit sleep mode. */
\r
443 /* If a context switch is pending or a task is waiting for the scheduler
\r
444 to be unsuspended then abandon the low power entry. */
\r
445 if( eTaskConfirmSleepModeStatus() == eAbortSleep )
\r
447 /* Restart SysTick. */
\r
448 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
450 /* Re-enable interrupts - see comments above __disable_irq() call
\r
456 /* Set the new reload value. */
\r
457 portNVIC_SYSTICK_LOAD_REG = ulReloadValue;
\r
459 /* Clear the SysTick count flag and set the count value back to
\r
461 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
463 /* Restart SysTick. */
\r
464 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
466 /* Sleep until something happens. configPRE_SLEEP_PROCESSING() can
\r
467 set its parameter to 0 to indicate that its implementation contains
\r
468 its own wait for interrupt or wait for event instruction, and so wfi
\r
469 should not be executed again. However, the original expected idle
\r
470 time variable must remain unmodified, so a copy is taken. */
\r
471 xModifiableIdleTime = xExpectedIdleTime;
\r
472 configPRE_SLEEP_PROCESSING( xModifiableIdleTime );
\r
473 if( xModifiableIdleTime > 0 )
\r
477 configPOST_SLEEP_PROCESSING( xExpectedIdleTime );
\r
479 /* Stop SysTick. Again, the time the SysTick is stopped for is
\r
480 accounted for as best it can be, but using the tickless mode will
\r
481 inevitably result in some tiny drift of the time maintained by the
\r
482 kernel with respect to calendar time. */
\r
483 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
485 /* Re-enable interrupts - see comments above __disable_irq() call
\r
489 if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )
\r
491 /* The tick interrupt has already executed, and the SysTick
\r
492 count reloaded with the portNVIC_SYSTICK_LOAD_REG value.
\r
493 Reset the portNVIC_SYSTICK_LOAD_REG with whatever remains of
\r
494 this tick period. */
\r
495 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );
\r
497 /* The tick interrupt handler will already have pended the tick
\r
498 processing in the kernel. As the pending tick will be
\r
499 processed as soon as this function exits, the tick value
\r
500 maintained by the tick is stepped forward by one less than the
\r
501 time spent waiting. */
\r
502 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;
\r
506 /* Something other than the tick interrupt ended the sleep.
\r
507 Work out how long the sleep lasted. */
\r
508 ulCompletedSysTickIncrements = ( xExpectedIdleTime * ulTimerReloadValueForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;
\r
510 /* How many complete tick periods passed while the processor
\r
512 ulCompleteTickPeriods = ulCompletedSysTickIncrements / ulTimerReloadValueForOneTick;
\r
514 /* The reload value is set to whatever fraction of a single tick
\r
516 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerReloadValueForOneTick ) - ulCompletedSysTickIncrements;
\r
519 /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG
\r
520 again, then set portNVIC_SYSTICK_LOAD_REG back to its standard
\r
522 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
523 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
525 vTaskStepTick( ulCompleteTickPeriods );
\r
529 #endif /* #if configUSE_TICKLESS_IDLE */
\r
531 /*-----------------------------------------------------------*/
\r
534 * Setup the SysTick timer to generate the tick interrupts at the required
\r
537 #if configOVERRIDE_DEFAULT_TICK_CONFIGURATION == 0
\r
539 void vPortSetupTimerInterrupt( void )
\r
541 /* Calculate the constants required to configure the tick interrupt. */
\r
542 #if configUSE_TICKLESS_IDLE == 1
\r
544 ulTimerReloadValueForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;
\r
545 xMaximumPossibleSuppressedTicks = 0xffffffUL / ( ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL );
\r
546 ulStoppedTimerCompensation = 45UL / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );
\r
548 #endif /* configUSE_TICKLESS_IDLE */
\r
550 /* Configure SysTick to interrupt at the requested rate. */
\r
551 portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;;
\r
552 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
555 #endif /* configOVERRIDE_DEFAULT_TICK_CONFIGURATION */
\r
556 /*-----------------------------------------------------------*/
\r
558 __asm unsigned long ulPortSetInterruptMask( void )
\r
563 mov r1, #configMAX_SYSCALL_INTERRUPT_PRIORITY
\r
567 /*-----------------------------------------------------------*/
\r
569 __asm void vPortClearInterruptMask( unsigned long ulNewMask )
\r