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 ) << 16UL )
\r
118 #define portNVIC_SYSTICK_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )
\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 /* The systick is a 24-bit counter. */
\r
132 #define portMAX_24_BIT_NUMBER ( 0xffffffUL )
\r
134 /* A fiddle factor to estimate the number of SysTick counts that would have
\r
135 occurred while the SysTick counter is stopped during tickless idle
\r
137 #define portMISSED_COUNTS_FACTOR ( 45UL )
\r
139 /* Each task maintains its own interrupt status in the critical nesting
\r
141 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;
\r
144 * Setup the timer to generate the tick interrupts. The implementation in this
\r
145 * file is weak to allow application writers to change the timer used to
\r
146 * generate the tick interrupt.
\r
148 void vPortSetupTimerInterrupt( void );
\r
151 * Exception handlers.
\r
153 void xPortPendSVHandler( void );
\r
154 void xPortSysTickHandler( void );
\r
155 void vPortSVCHandler( void );
\r
158 * Start first task is a separate function so it can be tested in isolation.
\r
160 static void prvStartFirstTask( void );
\r
163 * Functions defined in portasm.s to enable the VFP.
\r
165 static void prvEnableVFP( void );
\r
166 /*-----------------------------------------------------------*/
\r
169 * The number of SysTick increments that make up one tick period.
\r
171 #if configUSE_TICKLESS_IDLE == 1
\r
172 static unsigned long ulTimerCountsForOneTick = 0;
\r
173 #endif /* configUSE_TICKLESS_IDLE */
\r
176 * The maximum number of tick periods that can be suppressed is limited by the
\r
177 * 24 bit resolution of the SysTick timer.
\r
179 #if configUSE_TICKLESS_IDLE == 1
\r
180 static unsigned long xMaximumPossibleSuppressedTicks = 0;
\r
181 #endif /* configUSE_TICKLESS_IDLE */
\r
184 * Compensate for the CPU cycles that pass while the SysTick is stopped (low
\r
185 * power functionality only.
\r
187 #if configUSE_TICKLESS_IDLE == 1
\r
188 static unsigned long ulStoppedTimerCompensation = 0;
\r
189 #endif /* configUSE_TICKLESS_IDLE */
\r
191 /*-----------------------------------------------------------*/
\r
194 * See header file for description.
\r
196 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )
\r
198 /* Simulate the stack frame as it would be created by a context switch
\r
201 /* Offset added to account for the way the MCU uses the stack on entry/exit
\r
202 of interrupts, and to ensure alignment. */
\r
205 *pxTopOfStack = portINITIAL_XPSR; /* xPSR */
\r
207 *pxTopOfStack = ( portSTACK_TYPE ) pxCode; /* PC */
\r
209 *pxTopOfStack = 0; /* LR */
\r
211 /* Save code space by skipping register initialisation. */
\r
212 pxTopOfStack -= 5; /* R12, R3, R2 and R1. */
\r
213 *pxTopOfStack = ( portSTACK_TYPE ) pvParameters; /* R0 */
\r
215 /* A save method is being used that requires each task to maintain its
\r
216 own exec return value. */
\r
218 *pxTopOfStack = portINITIAL_EXEC_RETURN;
\r
220 pxTopOfStack -= 8; /* R11, R10, R9, R8, R7, R6, R5 and R4. */
\r
222 return pxTopOfStack;
\r
224 /*-----------------------------------------------------------*/
\r
226 __asm void vPortSVCHandler( void )
\r
230 /* Get the location of the current TCB. */
\r
231 ldr r3, =pxCurrentTCB
\r
234 /* Pop the core registers. */
\r
235 ldmia r0!, {r4-r11, r14}
\r
241 /*-----------------------------------------------------------*/
\r
243 __asm void prvStartFirstTask( void )
\r
247 /* Use the NVIC offset register to locate the stack. */
\r
248 ldr r0, =0xE000ED08
\r
251 /* Set the msp back to the start of the stack. */
\r
253 /* Globally enable interrupts. */
\r
255 /* Call SVC to start the first task. */
\r
259 /*-----------------------------------------------------------*/
\r
261 __asm void prvEnableVFP( void )
\r
265 /* The FPU enable bits are in the CPACR. */
\r
266 ldr.w r0, =0xE000ED88
\r
269 /* Enable CP10 and CP11 coprocessors, then save back. */
\r
270 orr r1, r1, #( 0xf << 20 )
\r
275 /*-----------------------------------------------------------*/
\r
278 * See header file for description.
\r
280 portBASE_TYPE xPortStartScheduler( void )
\r
282 /* Make PendSV and SysTick the lowest priority interrupts. */
\r
283 portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;
\r
284 portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;
\r
286 /* Start the timer that generates the tick ISR. Interrupts are disabled
\r
288 vPortSetupTimerInterrupt();
\r
290 /* Initialise the critical nesting count ready for the first task. */
\r
291 uxCriticalNesting = 0;
\r
293 /* Ensure the VFP is enabled - it should be anyway. */
\r
296 /* Lazy save always. */
\r
297 *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;
\r
299 /* Start the first task. */
\r
300 prvStartFirstTask();
\r
302 /* Should not get here! */
\r
305 /*-----------------------------------------------------------*/
\r
307 void vPortEndScheduler( void )
\r
309 /* It is unlikely that the CM4F port will require this function as there
\r
310 is nothing to return to. */
\r
312 /*-----------------------------------------------------------*/
\r
314 void vPortYield( void )
\r
316 /* Set a PendSV to request a context switch. */
\r
317 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
319 /* Barriers are normally not required but do ensure the code is completely
\r
320 within the specified behaviour for the architecture. */
\r
321 __dsb( portSY_FULL_READ_WRITE );
\r
322 __isb( portSY_FULL_READ_WRITE );
\r
324 /*-----------------------------------------------------------*/
\r
326 void vPortEnterCritical( void )
\r
328 portDISABLE_INTERRUPTS();
\r
329 uxCriticalNesting++;
\r
330 __dsb( portSY_FULL_READ_WRITE );
\r
331 __isb( portSY_FULL_READ_WRITE );
\r
333 /*-----------------------------------------------------------*/
\r
335 void vPortExitCritical( void )
\r
337 uxCriticalNesting--;
\r
338 if( uxCriticalNesting == 0 )
\r
340 portENABLE_INTERRUPTS();
\r
343 /*-----------------------------------------------------------*/
\r
345 __asm void xPortPendSVHandler( void )
\r
347 extern uxCriticalNesting;
\r
348 extern pxCurrentTCB;
\r
349 extern vTaskSwitchContext;
\r
355 /* Get the location of the current TCB. */
\r
356 ldr r3, =pxCurrentTCB
\r
359 /* Is the task using the FPU context? If so, push high vfp registers. */
\r
362 vstmdbeq r0!, {s16-s31}
\r
364 /* Save the core registers. */
\r
365 stmdb r0!, {r4-r11, r14}
\r
367 /* Save the new top of stack into the first member of the TCB. */
\r
370 stmdb sp!, {r3, r14}
\r
371 mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY
\r
373 bl vTaskSwitchContext
\r
376 ldmia sp!, {r3, r14}
\r
378 /* The first item in pxCurrentTCB is the task top of stack. */
\r
382 /* Pop the core registers. */
\r
383 ldmia r0!, {r4-r11, r14}
\r
385 /* Is the task using the FPU context? If so, pop the high vfp registers
\r
389 vldmiaeq r0!, {s16-s31}
\r
395 /*-----------------------------------------------------------*/
\r
397 void xPortSysTickHandler( void )
\r
399 /* The SysTick runs at the lowest interrupt priority, so when this interrupt
\r
400 executes all interrupts must be unmasked. There is therefore no need to
\r
401 save and then restore the interrupt mask value as its value is already
\r
403 ( void ) portSET_INTERRUPT_MASK_FROM_ISR();
\r
405 /* Increment the RTOS tick. */
\r
406 if( xTaskIncrementTick() != pdFALSE )
\r
408 /* A context switch is required. Context switching is performed in
\r
409 the PendSV interrupt. Pend the PendSV interrupt. */
\r
410 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
413 portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );
\r
415 /*-----------------------------------------------------------*/
\r
417 #if configUSE_TICKLESS_IDLE == 1
\r
419 __weak void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )
\r
421 unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements;
\r
422 portTickType xModifiableIdleTime;
\r
424 /* Make sure the SysTick reload value does not overflow the counter. */
\r
425 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )
\r
427 xExpectedIdleTime = xMaximumPossibleSuppressedTicks;
\r
430 /* Stop the SysTick momentarily. The time the SysTick is stopped for
\r
431 is accounted for as best it can be, but using the tickless mode will
\r
432 inevitably result in some tiny drift of the time maintained by the
\r
433 kernel with respect to calendar time. */
\r
434 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
436 /* Calculate the reload value required to wait xExpectedIdleTime
\r
437 tick periods. -1 is used because this code will execute part way
\r
438 through one of the tick periods. */
\r
439 ulReloadValue = portNVIC_SYSTICK_CURRENT_VALUE_REG + ( ulTimerCountsForOneTick * ( xExpectedIdleTime - 1UL ) );
\r
440 if( ulReloadValue > ulStoppedTimerCompensation )
\r
442 ulReloadValue -= ulStoppedTimerCompensation;
\r
445 /* Enter a critical section but don't use the taskENTER_CRITICAL()
\r
446 method as that will mask interrupts that should exit sleep mode. */
\r
449 /* If a context switch is pending or a task is waiting for the scheduler
\r
450 to be unsuspended then abandon the low power entry. */
\r
451 if( eTaskConfirmSleepModeStatus() == eAbortSleep )
\r
453 /* Restart SysTick. */
\r
454 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
456 /* Re-enable interrupts - see comments above __disable_irq() call
\r
462 /* Set the new reload value. */
\r
463 portNVIC_SYSTICK_LOAD_REG = ulReloadValue;
\r
465 /* Clear the SysTick count flag and set the count value back to
\r
467 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
469 /* Restart SysTick. */
\r
470 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
472 /* Sleep until something happens. configPRE_SLEEP_PROCESSING() can
\r
473 set its parameter to 0 to indicate that its implementation contains
\r
474 its own wait for interrupt or wait for event instruction, and so wfi
\r
475 should not be executed again. However, the original expected idle
\r
476 time variable must remain unmodified, so a copy is taken. */
\r
477 xModifiableIdleTime = xExpectedIdleTime;
\r
478 configPRE_SLEEP_PROCESSING( xModifiableIdleTime );
\r
479 if( xModifiableIdleTime > 0 )
\r
481 __dsb( portSY_FULL_READ_WRITE );
\r
483 __isb( portSY_FULL_READ_WRITE );
\r
485 configPOST_SLEEP_PROCESSING( xExpectedIdleTime );
\r
487 /* Stop SysTick. Again, the time the SysTick is stopped for is
\r
488 accounted for as best it can be, but using the tickless mode will
\r
489 inevitably result in some tiny drift of the time maintained by the
\r
490 kernel with respect to calendar time. */
\r
491 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
493 /* Re-enable interrupts - see comments above __disable_irq() call
\r
497 if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )
\r
499 /* The tick interrupt has already executed, and the SysTick
\r
500 count reloaded with ulReloadValue. Reset the
\r
501 portNVIC_SYSTICK_LOAD_REG with whatever remains of this tick
\r
503 portNVIC_SYSTICK_LOAD_REG = ( ulTimerCountsForOneTick - 1UL ) - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );
\r
505 /* The tick interrupt handler will already have pended the tick
\r
506 processing in the kernel. As the pending tick will be
\r
507 processed as soon as this function exits, the tick value
\r
508 maintained by the tick is stepped forward by one less than the
\r
509 time spent waiting. */
\r
510 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;
\r
514 /* Something other than the tick interrupt ended the sleep.
\r
515 Work out how long the sleep lasted rounded to complete tick
\r
516 periods (not the ulReload value which accounted for part
\r
518 ulCompletedSysTickDecrements = ( xExpectedIdleTime * ulTimerCountsForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;
\r
520 /* How many complete tick periods passed while the processor
\r
522 ulCompleteTickPeriods = ulCompletedSysTickDecrements / ulTimerCountsForOneTick;
\r
524 /* The reload value is set to whatever fraction of a single tick
\r
526 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;
\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
537 /* The counter must start by the time the reload value is reset. */
\r
538 configASSERT( portNVIC_SYSTICK_CURRENT_VALUE_REG );
\r
539 portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;
\r
543 #endif /* #if configUSE_TICKLESS_IDLE */
\r
545 /*-----------------------------------------------------------*/
\r
548 * Setup the SysTick timer to generate the tick interrupts at the required
\r
551 #if configOVERRIDE_DEFAULT_TICK_CONFIGURATION == 0
\r
553 void vPortSetupTimerInterrupt( void )
\r
555 /* Calculate the constants required to configure the tick interrupt. */
\r
556 #if configUSE_TICKLESS_IDLE == 1
\r
558 ulTimerCountsForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );
\r
559 xMaximumPossibleSuppressedTicks = portMAX_24_BIT_NUMBER / ulTimerCountsForOneTick;
\r
560 ulStoppedTimerCompensation = portMISSED_COUNTS_FACTOR / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );
\r
562 #endif /* configUSE_TICKLESS_IDLE */
\r
564 /* Configure SysTick to interrupt at the requested rate. */
\r
565 portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;;
\r
566 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
569 #endif /* configOVERRIDE_DEFAULT_TICK_CONFIGURATION */
\r
570 /*-----------------------------------------------------------*/
\r
572 __asm unsigned long ulPortSetInterruptMask( void )
\r
577 mov r1, #configMAX_SYSCALL_INTERRUPT_PRIORITY
\r
581 /*-----------------------------------------------------------*/
\r
583 __asm void vPortClearInterruptMask( unsigned long ulNewMask )
\r