2 FreeRTOS V7.4.2 - 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 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_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 manipulate the VFP. */
\r
121 #define portFPCCR ( ( volatile unsigned long * ) 0xe000ef34 ) /* Floating point context control register. */
\r
122 #define portASPEN_AND_LSPEN_BITS ( 0x3UL << 30UL )
\r
124 /* Constants required to set up the initial stack. */
\r
125 #define portINITIAL_XPSR ( 0x01000000 )
\r
126 #define portINITIAL_EXEC_RETURN ( 0xfffffffd )
\r
128 /* Constants used with memory barrier intrinsics. */
\r
129 #define portSY_FULL_READ_WRITE ( 15 )
\r
131 /* Each task maintains its own interrupt status in the critical nesting
\r
133 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;
\r
136 * Setup the timer to generate the tick interrupts. The implementation in this
\r
137 * file is weak to allow application writers to change the timer used to
\r
138 * generate the tick interrupt.
\r
140 void vPortSetupTimerInterrupt( void );
\r
143 * Exception handlers.
\r
145 void xPortPendSVHandler( void );
\r
146 void xPortSysTickHandler( void );
\r
147 void vPortSVCHandler( void );
\r
150 * Start first task is a separate function so it can be tested in isolation.
\r
152 static void prvStartFirstTask( void );
\r
155 * Functions defined in portasm.s to enable the VFP.
\r
157 static void prvEnableVFP( void );
\r
158 /*-----------------------------------------------------------*/
\r
161 * The number of SysTick increments that make up one tick period.
\r
163 #if configUSE_TICKLESS_IDLE == 1
\r
164 static unsigned long ulTimerReloadValueForOneTick = 0;
\r
168 * The maximum number of tick periods that can be suppressed is limited by the
\r
169 * 24 bit resolution of the SysTick timer.
\r
171 #if configUSE_TICKLESS_IDLE == 1
\r
172 static unsigned long xMaximumPossibleSuppressedTicks = 0;
\r
173 #endif /* configUSE_TICKLESS_IDLE */
\r
176 * Compensate for the CPU cycles that pass while the SysTick is stopped (low
\r
177 * power functionality only.
\r
179 #if configUSE_TICKLESS_IDLE == 1
\r
180 static unsigned long ulStoppedTimerCompensation = 0;
\r
181 #endif /* configUSE_TICKLESS_IDLE */
\r
183 /*-----------------------------------------------------------*/
\r
186 * See header file for description.
\r
188 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )
\r
190 /* Simulate the stack frame as it would be created by a context switch
\r
193 /* Offset added to account for the way the MCU uses the stack on entry/exit
\r
194 of interrupts, and to ensure alignment. */
\r
197 *pxTopOfStack = portINITIAL_XPSR; /* xPSR */
\r
199 *pxTopOfStack = ( portSTACK_TYPE ) pxCode; /* PC */
\r
201 *pxTopOfStack = 0; /* LR */
\r
203 /* Save code space by skipping register initialisation. */
\r
204 pxTopOfStack -= 5; /* R12, R3, R2 and R1. */
\r
205 *pxTopOfStack = ( portSTACK_TYPE ) pvParameters; /* R0 */
\r
207 /* A save method is being used that requires each task to maintain its
\r
208 own exec return value. */
\r
210 *pxTopOfStack = portINITIAL_EXEC_RETURN;
\r
212 pxTopOfStack -= 8; /* R11, R10, R9, R8, R7, R6, R5 and R4. */
\r
214 return pxTopOfStack;
\r
216 /*-----------------------------------------------------------*/
\r
218 __asm void vPortSVCHandler( void )
\r
222 /* Get the location of the current TCB. */
\r
223 ldr r3, =pxCurrentTCB
\r
226 /* Pop the core registers. */
\r
227 ldmia r0!, {r4-r11, r14}
\r
233 /*-----------------------------------------------------------*/
\r
235 __asm void prvStartFirstTask( void )
\r
239 /* Use the NVIC offset register to locate the stack. */
\r
240 ldr r0, =0xE000ED08
\r
243 /* Set the msp back to the start of the stack. */
\r
245 /* Globally enable interrupts. */
\r
247 /* Call SVC to start the first task. */
\r
251 /*-----------------------------------------------------------*/
\r
253 __asm void prvEnableVFP( void )
\r
257 /* The FPU enable bits are in the CPACR. */
\r
258 ldr.w r0, =0xE000ED88
\r
261 /* Enable CP10 and CP11 coprocessors, then save back. */
\r
262 orr r1, r1, #( 0xf << 20 )
\r
267 /*-----------------------------------------------------------*/
\r
270 * See header file for description.
\r
272 portBASE_TYPE xPortStartScheduler( void )
\r
274 /* Make PendSV, CallSV and SysTick the same priroity as the kernel. */
\r
275 portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;
\r
276 portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;
\r
278 /* Start the timer that generates the tick ISR. Interrupts are disabled
\r
280 vPortSetupTimerInterrupt();
\r
282 /* Initialise the critical nesting count ready for the first task. */
\r
283 uxCriticalNesting = 0;
\r
285 /* Ensure the VFP is enabled - it should be anyway. */
\r
288 /* Lazy save always. */
\r
289 *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;
\r
291 /* Start the first task. */
\r
292 prvStartFirstTask();
\r
294 /* Should not get here! */
\r
297 /*-----------------------------------------------------------*/
\r
299 void vPortEndScheduler( void )
\r
301 /* It is unlikely that the CM4F port will require this function as there
\r
302 is nothing to return to. */
\r
304 /*-----------------------------------------------------------*/
\r
306 void vPortYield( void )
\r
308 /* Set a PendSV to request a context switch. */
\r
309 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
311 /* Barriers are normally not required but do ensure the code is completely
\r
312 within the specified behaviour for the architecture. */
\r
313 __dsb( portSY_FULL_READ_WRITE );
\r
314 __isb( portSY_FULL_READ_WRITE );
\r
316 /*-----------------------------------------------------------*/
\r
318 void vPortEnterCritical( void )
\r
320 portDISABLE_INTERRUPTS();
\r
321 uxCriticalNesting++;
\r
322 __dsb( portSY_FULL_READ_WRITE );
\r
323 __isb( portSY_FULL_READ_WRITE );
\r
325 /*-----------------------------------------------------------*/
\r
327 void vPortExitCritical( void )
\r
329 uxCriticalNesting--;
\r
330 if( uxCriticalNesting == 0 )
\r
332 portENABLE_INTERRUPTS();
\r
335 /*-----------------------------------------------------------*/
\r
337 __asm void xPortPendSVHandler( void )
\r
339 extern uxCriticalNesting;
\r
340 extern pxCurrentTCB;
\r
341 extern vTaskSwitchContext;
\r
347 /* Get the location of the current TCB. */
\r
348 ldr r3, =pxCurrentTCB
\r
351 /* Is the task using the FPU context? If so, push high vfp registers. */
\r
354 vstmdbeq r0!, {s16-s31}
\r
356 /* Save the core registers. */
\r
357 stmdb r0!, {r4-r11, r14}
\r
359 /* Save the new top of stack into the first member of the TCB. */
\r
362 stmdb sp!, {r3, r14}
\r
363 mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY
\r
365 bl vTaskSwitchContext
\r
368 ldmia sp!, {r3, r14}
\r
370 /* The first item in pxCurrentTCB is the task top of stack. */
\r
374 /* Pop the core registers. */
\r
375 ldmia r0!, {r4-r11, r14}
\r
377 /* Is the task using the FPU context? If so, pop the high vfp registers
\r
381 vldmiaeq r0!, {s16-s31}
\r
387 /*-----------------------------------------------------------*/
\r
389 void xPortSysTickHandler( void )
\r
391 #if configUSE_PREEMPTION == 1
\r
393 /* If using preemption, also force a context switch. */
\r
394 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
398 /* Only reset the systick load register if configUSE_TICKLESS_IDLE is set to
\r
399 1. If it is set to 0 tickless idle is not being used. If it is set to a
\r
400 value other than 0 or 1 then a timer other than the SysTick is being used
\r
401 to generate the tick interrupt. */
\r
402 #if configUSE_TICKLESS_IDLE == 1
\r
403 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;
\r
406 ( void ) portSET_INTERRUPT_MASK_FROM_ISR();
\r
408 vTaskIncrementTick();
\r
410 portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );
\r
412 /*-----------------------------------------------------------*/
\r
414 #if configUSE_TICKLESS_IDLE == 1
\r
416 __weak void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )
\r
418 unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickIncrements;
\r
419 portTickType xModifiableIdleTime;
\r
421 /* Make sure the SysTick reload value does not overflow the counter. */
\r
422 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )
\r
424 xExpectedIdleTime = xMaximumPossibleSuppressedTicks;
\r
427 /* Calculate the reload value required to wait xExpectedIdleTime
\r
428 tick periods. -1 is used because this code will execute part way
\r
429 through one of the tick periods, and the fraction of a tick period is
\r
430 accounted for later. */
\r
431 ulReloadValue = ( ulTimerReloadValueForOneTick * ( xExpectedIdleTime - 1UL ) );
\r
432 if( ulReloadValue > ulStoppedTimerCompensation )
\r
434 ulReloadValue -= ulStoppedTimerCompensation;
\r
437 /* Stop the SysTick momentarily. The time the SysTick is stopped for
\r
438 is accounted for as best it can be, but using the tickless mode will
\r
439 inevitably result in some tiny drift of the time maintained by the
\r
440 kernel with respect to calendar time. */
\r
441 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
443 /* Adjust the reload value to take into account that the current
\r
444 time slice is already partially complete. */
\r
445 ulReloadValue += ( portNVIC_SYSTICK_LOAD_REG - ( portNVIC_SYSTICK_LOAD_REG - portNVIC_SYSTICK_CURRENT_VALUE_REG ) );
\r
447 /* Enter a critical section but don't use the taskENTER_CRITICAL()
\r
448 method as that will mask interrupts that should exit sleep mode. */
\r
451 /* If a context switch is pending or a task is waiting for the scheduler
\r
452 to be unsuspended then abandon the low power entry. */
\r
453 if( eTaskConfirmSleepModeStatus() == eAbortSleep )
\r
455 /* Restart SysTick. */
\r
456 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
458 /* Re-enable interrupts - see comments above __disable_irq() call
\r
464 /* Set the new reload value. */
\r
465 portNVIC_SYSTICK_LOAD_REG = ulReloadValue;
\r
467 /* Clear the SysTick count flag and set the count value back to
\r
469 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
471 /* Restart SysTick. */
\r
472 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
474 /* Sleep until something happens. configPRE_SLEEP_PROCESSING() can
\r
475 set its parameter to 0 to indicate that its implementation contains
\r
476 its own wait for interrupt or wait for event instruction, and so wfi
\r
477 should not be executed again. However, the original expected idle
\r
478 time variable must remain unmodified, so a copy is taken. */
\r
479 xModifiableIdleTime = xExpectedIdleTime;
\r
480 configPRE_SLEEP_PROCESSING( xModifiableIdleTime );
\r
481 if( xModifiableIdleTime > 0 )
\r
483 __dsb( portSY_FULL_READ_WRITE );
\r
485 __isb( portSY_FULL_READ_WRITE );
\r
487 configPOST_SLEEP_PROCESSING( xExpectedIdleTime );
\r
489 /* Stop SysTick. Again, the time the SysTick is stopped for is
\r
490 accounted for as best it can be, but using the tickless mode will
\r
491 inevitably result in some tiny drift of the time maintained by the
\r
492 kernel with respect to calendar time. */
\r
493 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
495 /* Re-enable interrupts - see comments above __disable_irq() call
\r
499 if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )
\r
501 /* The tick interrupt has already executed, and the SysTick
\r
502 count reloaded with the portNVIC_SYSTICK_LOAD_REG value.
\r
503 Reset the portNVIC_SYSTICK_LOAD_REG with whatever remains of
\r
504 this tick period. */
\r
505 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );
\r
507 /* The tick interrupt handler will already have pended the tick
\r
508 processing in the kernel. As the pending tick will be
\r
509 processed as soon as this function exits, the tick value
\r
510 maintained by the tick is stepped forward by one less than the
\r
511 time spent waiting. */
\r
512 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;
\r
516 /* Something other than the tick interrupt ended the sleep.
\r
517 Work out how long the sleep lasted. */
\r
518 ulCompletedSysTickIncrements = ( xExpectedIdleTime * ulTimerReloadValueForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;
\r
520 /* How many complete tick periods passed while the processor
\r
522 ulCompleteTickPeriods = ulCompletedSysTickIncrements / ulTimerReloadValueForOneTick;
\r
524 /* The reload value is set to whatever fraction of a single tick
\r
526 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerReloadValueForOneTick ) - ulCompletedSysTickIncrements;
\r
529 /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG
\r
530 again, then set portNVIC_SYSTICK_LOAD_REG back to its standard
\r
532 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
533 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
535 vTaskStepTick( ulCompleteTickPeriods );
\r
539 #endif /* #if configUSE_TICKLESS_IDLE */
\r
541 /*-----------------------------------------------------------*/
\r
544 * Setup the SysTick timer to generate the tick interrupts at the required
\r
547 #if configOVERRIDE_DEFAULT_TICK_CONFIGURATION == 0
\r
549 void vPortSetupTimerInterrupt( void )
\r
551 /* Calculate the constants required to configure the tick interrupt. */
\r
552 #if configUSE_TICKLESS_IDLE == 1
\r
554 ulTimerReloadValueForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;
\r
555 xMaximumPossibleSuppressedTicks = 0xffffffUL / ( ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL );
\r
556 ulStoppedTimerCompensation = 45UL / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );
\r
558 #endif /* configUSE_TICKLESS_IDLE */
\r
560 /* Configure SysTick to interrupt at the requested rate. */
\r
561 portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;;
\r
562 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
565 #endif /* configOVERRIDE_DEFAULT_TICK_CONFIGURATION */
\r
566 /*-----------------------------------------------------------*/
\r
568 __asm unsigned long ulPortSetInterruptMask( void )
\r
573 mov r1, #configMAX_SYSCALL_INTERRUPT_PRIORITY
\r
577 /*-----------------------------------------------------------*/
\r
579 __asm void vPortClearInterruptMask( unsigned long ulNewMask )
\r