2 FreeRTOS V7.5.0 - Copyright (C) 2013 Real Time Engineers Ltd.
\r
4 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
6 ***************************************************************************
\r
8 * FreeRTOS provides completely free yet professionally developed, *
\r
9 * robust, strictly quality controlled, supported, and cross *
\r
10 * platform software that has become a de facto standard. *
\r
12 * Help yourself get started quickly and support the FreeRTOS *
\r
13 * project by purchasing a FreeRTOS tutorial book, reference *
\r
14 * manual, or both from: http://www.FreeRTOS.org/Documentation *
\r
18 ***************************************************************************
\r
20 This file is part of the FreeRTOS distribution.
\r
22 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
23 the terms of the GNU General Public License (version 2) as published by the
\r
24 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
26 >>! NOTE: The modification to the GPL is included to allow you to distribute
\r
27 >>! a combined work that includes FreeRTOS without being obliged to provide
\r
28 >>! the source code for proprietary components outside of the FreeRTOS
\r
31 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
32 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
33 FOR A PARTICULAR PURPOSE. Full license text is available from the following
\r
34 link: http://www.freertos.org/a00114.html
\r
38 ***************************************************************************
\r
40 * Having a problem? Start by reading the FAQ "My application does *
\r
41 * not run, what could be wrong?" *
\r
43 * http://www.FreeRTOS.org/FAQHelp.html *
\r
45 ***************************************************************************
\r
47 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
48 license and Real Time Engineers Ltd. contact details.
\r
50 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
51 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
52 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
54 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
55 Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
56 licenses offer ticketed support, indemnification and middleware.
\r
58 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
59 engineered and independently SIL3 certified version for use in safety and
\r
60 mission critical applications that require provable dependability.
\r
65 /*-----------------------------------------------------------
\r
66 * Implementation of functions defined in portable.h for the ARM CM3 port.
\r
67 *----------------------------------------------------------*/
\r
70 #include <intrinsics.h>
\r
72 /* Scheduler includes. */
\r
73 #include "FreeRTOS.h"
\r
76 #if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0
\r
77 #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0. See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
\r
80 #ifndef configSYSTICK_CLOCK_HZ
\r
81 #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ
\r
84 /* Constants required to manipulate the core. Registers first... */
\r
85 #define portNVIC_SYSTICK_CTRL_REG ( * ( ( volatile unsigned long * ) 0xe000e010 ) )
\r
86 #define portNVIC_SYSTICK_LOAD_REG ( * ( ( volatile unsigned long * ) 0xe000e014 ) )
\r
87 #define portNVIC_SYSTICK_CURRENT_VALUE_REG ( * ( ( volatile unsigned long * ) 0xe000e018 ) )
\r
88 #define portNVIC_SYSPRI2_REG ( * ( ( volatile unsigned long * ) 0xe000ed20 ) )
\r
89 /* ...then bits in the registers. */
\r
90 #define portNVIC_SYSTICK_CLK_BIT ( 1UL << 2UL )
\r
91 #define portNVIC_SYSTICK_INT_BIT ( 1UL << 1UL )
\r
92 #define portNVIC_SYSTICK_ENABLE_BIT ( 1UL << 0UL )
\r
93 #define portNVIC_SYSTICK_COUNT_FLAG_BIT ( 1UL << 16UL )
\r
94 #define portNVIC_PENDSVCLEAR_BIT ( 1UL << 27UL )
\r
95 #define portNVIC_PEND_SYSTICK_CLEAR_BIT ( 1UL << 25UL )
\r
97 #define portNVIC_PENDSV_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16UL )
\r
98 #define portNVIC_SYSTICK_PRI ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )
\r
100 /* Constants required to check the validity of an interrupt prority. */
\r
101 #define portFIRST_USER_INTERRUPT_NUMBER ( 16 )
\r
102 #define portNVIC_IP_REGISTERS_OFFSET_16 ( 0xE000E3F0 )
\r
103 #define portAIRCR_REG ( * ( ( volatile unsigned long * ) 0xE000ED0C ) )
\r
104 #define portPRIORITY_GROUP_MASK ( 0x07UL << 8UL )
\r
106 /* Constants required to set up the initial stack. */
\r
107 #define portINITIAL_XPSR ( 0x01000000 )
\r
109 /* The systick is a 24-bit counter. */
\r
110 #define portMAX_24_BIT_NUMBER ( 0xffffffUL )
\r
112 /* A fiddle factor to estimate the number of SysTick counts that would have
\r
113 occurred while the SysTick counter is stopped during tickless idle
\r
115 #define portMISSED_COUNTS_FACTOR ( 45UL )
\r
117 /* For backward compatibility, ensure configKERNEL_INTERRUPT_PRIORITY is
\r
118 defined. The value 255 should also ensure backward compatibility.
\r
119 FreeRTOS.org versions prior to V4.3.0 did not include this definition. */
\r
120 #ifndef configKERNEL_INTERRUPT_PRIORITY
\r
121 #define configKERNEL_INTERRUPT_PRIORITY 255
\r
124 /* Each task maintains its own interrupt status in the critical nesting
\r
126 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;
\r
129 * Setup the timer to generate the tick interrupts. The implementation in this
\r
130 * file is weak to allow application writers to change the timer used to
\r
131 * generate the tick interrupt.
\r
133 void vPortSetupTimerInterrupt( void );
\r
136 * Exception handlers.
\r
138 void xPortSysTickHandler( void );
\r
141 * Start first task is a separate function so it can be tested in isolation.
\r
143 extern void vPortStartFirstTask( void );
\r
145 /*-----------------------------------------------------------*/
\r
148 * The number of SysTick increments that make up one tick period.
\r
150 #if configUSE_TICKLESS_IDLE == 1
\r
151 static unsigned long ulTimerCountsForOneTick = 0;
\r
152 #endif /* configUSE_TICKLESS_IDLE */
\r
155 * The maximum number of tick periods that can be suppressed is limited by the
\r
156 * 24 bit resolution of the SysTick timer.
\r
158 #if configUSE_TICKLESS_IDLE == 1
\r
159 static unsigned long xMaximumPossibleSuppressedTicks = 0;
\r
160 #endif /* configUSE_TICKLESS_IDLE */
\r
163 * Compensate for the CPU cycles that pass while the SysTick is stopped (low
\r
164 * power functionality only.
\r
166 #if configUSE_TICKLESS_IDLE == 1
\r
167 static unsigned long ulStoppedTimerCompensation = 0;
\r
168 #endif /* configUSE_TICKLESS_IDLE */
\r
171 * Used by the portASSERT_IF_INTERRUPT_PRIORITY_INVALID() macro to ensure
\r
172 * FreeRTOS API functions are not called from interrupts that have been assigned
\r
173 * a priority above configMAX_SYSCALL_INTERRUPT_PRIORITY.
\r
175 #if ( configASSERT_DEFINED == 1 )
\r
176 static unsigned char ucMaxSysCallPriority = 0;
\r
177 static const volatile unsigned char * const pcInterruptPriorityRegisters = ( const volatile unsigned char * const ) portNVIC_IP_REGISTERS_OFFSET_16;
\r
178 #endif /* configASSERT_DEFINED */
\r
180 /*-----------------------------------------------------------*/
\r
183 * See header file for description.
\r
185 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )
\r
187 /* Simulate the stack frame as it would be created by a context switch
\r
189 pxTopOfStack--; /* Offset added to account for the way the MCU uses the stack on entry/exit of interrupts. */
\r
190 *pxTopOfStack = portINITIAL_XPSR; /* xPSR */
\r
192 *pxTopOfStack = ( portSTACK_TYPE ) pxCode; /* PC */
\r
194 *pxTopOfStack = 0; /* LR */
\r
195 pxTopOfStack -= 5; /* R12, R3, R2 and R1. */
\r
196 *pxTopOfStack = ( portSTACK_TYPE ) pvParameters; /* R0 */
\r
197 pxTopOfStack -= 8; /* R11, R10, R9, R8, R7, R6, R5 and R4. */
\r
199 return pxTopOfStack;
\r
201 /*-----------------------------------------------------------*/
\r
204 * See header file for description.
\r
206 portBASE_TYPE xPortStartScheduler( void )
\r
208 #if( configASSERT_DEFINED == 1 )
\r
210 volatile unsigned long ulOriginalPriority;
\r
211 volatile char * const pcFirstUserPriorityRegister = ( volatile char * const ) ( portNVIC_IP_REGISTERS_OFFSET_16 + portFIRST_USER_INTERRUPT_NUMBER );
\r
213 /* Determine the maximum priority from which ISR safe FreeRTOS API
\r
214 functions can be called. ISR safe functions are those that end in
\r
215 "FromISR". FreeRTOS maintains separate thread and ISR API functions to
\r
216 ensure interrupt entry is as fast and simple as possible.
\r
218 Save the interrupt priority value that is about to be clobbered. */
\r
219 ulOriginalPriority = *pcFirstUserPriorityRegister;
\r
221 /* Write the configMAX_SYSCALL_INTERRUPT_PRIORITY value to an interrupt
\r
222 priority register. */
\r
223 *pcFirstUserPriorityRegister = configMAX_SYSCALL_INTERRUPT_PRIORITY;
\r
225 /* Read back the written priority to obtain its value as seen by the
\r
226 hardware, which will only implement a subset of the priority bits. */
\r
227 ucMaxSysCallPriority = *pcFirstUserPriorityRegister;
\r
229 /* Restore the clobbered interrupt priority register to its original
\r
231 *pcFirstUserPriorityRegister = ulOriginalPriority;
\r
233 #endif /* conifgASSERT_DEFINED */
\r
235 /* Make PendSV and SysTick the lowest priority interrupts. */
\r
236 portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;
\r
237 portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;
\r
239 /* Start the timer that generates the tick ISR. Interrupts are disabled
\r
241 vPortSetupTimerInterrupt();
\r
243 /* Initialise the critical nesting count ready for the first task. */
\r
244 uxCriticalNesting = 0;
\r
246 /* Start the first task. */
\r
247 vPortStartFirstTask();
\r
249 /* Should not get here! */
\r
252 /*-----------------------------------------------------------*/
\r
254 void vPortEndScheduler( void )
\r
256 /* It is unlikely that the CM3 port will require this function as there
\r
257 is nothing to return to. */
\r
259 /*-----------------------------------------------------------*/
\r
261 void vPortYield( void )
\r
263 /* Set a PendSV to request a context switch. */
\r
264 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
266 /* Barriers are normally not required but do ensure the code is completely
\r
267 within the specified behaviour for the architecture. */
\r
271 /*-----------------------------------------------------------*/
\r
273 void vPortEnterCritical( void )
\r
275 portDISABLE_INTERRUPTS();
\r
276 uxCriticalNesting++;
\r
280 /*-----------------------------------------------------------*/
\r
282 void vPortExitCritical( void )
\r
284 uxCriticalNesting--;
\r
285 if( uxCriticalNesting == 0 )
\r
287 portENABLE_INTERRUPTS();
\r
290 /*-----------------------------------------------------------*/
\r
292 void xPortSysTickHandler( void )
\r
294 /* The SysTick runs at the lowest interrupt priority, so when this interrupt
\r
295 executes all interrupts must be unmasked. There is therefore no need to
\r
296 save and then restore the interrupt mask value as its value is already
\r
298 ( void ) portSET_INTERRUPT_MASK_FROM_ISR();
\r
300 /* Increment the RTOS tick. */
\r
301 if( xTaskIncrementTick() != pdFALSE )
\r
303 /* A context switch is required. Context switching is performed in
\r
304 the PendSV interrupt. Pend the PendSV interrupt. */
\r
305 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
308 portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );
\r
310 /*-----------------------------------------------------------*/
\r
312 #if configUSE_TICKLESS_IDLE == 1
\r
314 __weak void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )
\r
316 unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements;
\r
317 portTickType xModifiableIdleTime;
\r
319 /* Make sure the SysTick reload value does not overflow the counter. */
\r
320 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )
\r
322 xExpectedIdleTime = xMaximumPossibleSuppressedTicks;
\r
325 /* Stop the SysTick momentarily. The time the SysTick is stopped for
\r
326 is accounted for as best it can be, but using the tickless mode will
\r
327 inevitably result in some tiny drift of the time maintained by the
\r
328 kernel with respect to calendar time. */
\r
329 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
331 /* Calculate the reload value required to wait xExpectedIdleTime
\r
332 tick periods. -1 is used because this code will execute part way
\r
333 through one of the tick periods. */
\r
334 ulReloadValue = portNVIC_SYSTICK_CURRENT_VALUE_REG + ( ulTimerCountsForOneTick * ( xExpectedIdleTime - 1UL ) );
\r
335 if( ulReloadValue > ulStoppedTimerCompensation )
\r
337 ulReloadValue -= ulStoppedTimerCompensation;
\r
340 /* Enter a critical section but don't use the taskENTER_CRITICAL()
\r
341 method as that will mask interrupts that should exit sleep mode. */
\r
342 __disable_interrupt();
\r
344 /* If a context switch is pending or a task is waiting for the scheduler
\r
345 to be unsuspended then abandon the low power entry. */
\r
346 if( eTaskConfirmSleepModeStatus() == eAbortSleep )
\r
348 /* Restart SysTick. */
\r
349 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
351 /* Re-enable interrupts - see comments above __disable_interrupt()
\r
353 __enable_interrupt();
\r
357 /* Set the new reload value. */
\r
358 portNVIC_SYSTICK_LOAD_REG = ulReloadValue;
\r
360 /* Clear the SysTick count flag and set the count value back to
\r
362 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
364 /* Restart SysTick. */
\r
365 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
367 /* Sleep until something happens. configPRE_SLEEP_PROCESSING() can
\r
368 set its parameter to 0 to indicate that its implementation contains
\r
369 its own wait for interrupt or wait for event instruction, and so wfi
\r
370 should not be executed again. However, the original expected idle
\r
371 time variable must remain unmodified, so a copy is taken. */
\r
372 xModifiableIdleTime = xExpectedIdleTime;
\r
373 configPRE_SLEEP_PROCESSING( xModifiableIdleTime );
\r
374 if( xModifiableIdleTime > 0 )
\r
380 configPOST_SLEEP_PROCESSING( xExpectedIdleTime );
\r
382 /* Stop SysTick. Again, the time the SysTick is stopped for is
\r
383 accounted for as best it can be, but using the tickless mode will
\r
384 inevitably result in some tiny drift of the time maintained by the
\r
385 kernel with respect to calendar time. */
\r
386 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;
\r
388 /* Re-enable interrupts - see comments above __disable_interrupt()
\r
390 __enable_interrupt();
\r
392 if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )
\r
394 /* The tick interrupt has already executed, and the SysTick
\r
395 count reloaded with ulReloadValue. Reset the
\r
396 portNVIC_SYSTICK_LOAD_REG with whatever remains of this tick
\r
398 portNVIC_SYSTICK_LOAD_REG = ( ulTimerCountsForOneTick - 1UL ) - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );
\r
400 /* The tick interrupt handler will already have pended the tick
\r
401 processing in the kernel. As the pending tick will be
\r
402 processed as soon as this function exits, the tick value
\r
403 maintained by the tick is stepped forward by one less than the
\r
404 time spent waiting. */
\r
405 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;
\r
409 /* Something other than the tick interrupt ended the sleep.
\r
410 Work out how long the sleep lasted rounded to complete tick
\r
411 periods (not the ulReload value which accounted for part
\r
413 ulCompletedSysTickDecrements = ( xExpectedIdleTime * ulTimerCountsForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;
\r
415 /* How many complete tick periods passed while the processor
\r
417 ulCompleteTickPeriods = ulCompletedSysTickDecrements / ulTimerCountsForOneTick;
\r
419 /* The reload value is set to whatever fraction of a single tick
\r
421 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;
\r
424 /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG
\r
425 again, then set portNVIC_SYSTICK_LOAD_REG back to its standard
\r
427 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
428 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
430 vTaskStepTick( ulCompleteTickPeriods );
\r
432 /* The counter must start by the time the reload value is reset. */
\r
433 configASSERT( portNVIC_SYSTICK_CURRENT_VALUE_REG );
\r
434 portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;
\r
438 #endif /* #if configUSE_TICKLESS_IDLE */
\r
439 /*-----------------------------------------------------------*/
\r
442 * Setup the systick timer to generate the tick interrupts at the required
\r
445 __weak void vPortSetupTimerInterrupt( void )
\r
447 /* Calculate the constants required to configure the tick interrupt. */
\r
448 #if configUSE_TICKLESS_IDLE == 1
\r
450 ulTimerCountsForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );
\r
451 xMaximumPossibleSuppressedTicks = portMAX_24_BIT_NUMBER / ulTimerCountsForOneTick;
\r
452 ulStoppedTimerCompensation = portMISSED_COUNTS_FACTOR / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );
\r
454 #endif /* configUSE_TICKLESS_IDLE */
\r
456 /* Configure SysTick to interrupt at the requested rate. */
\r
457 portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;;
\r
458 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;
\r
460 /*-----------------------------------------------------------*/
\r
462 #if( configASSERT_DEFINED == 1 )
\r
464 void vPortValidateInterruptPriority( void )
\r
466 unsigned long ulCurrentInterrupt;
\r
467 unsigned char ucCurrentPriority;
\r
469 /* Obtain the number of the currently executing interrupt. */
\r
470 __asm volatile( "mrs %0, ipsr" : "=r"( ulCurrentInterrupt ) );
\r
472 /* Is the interrupt number a user defined interrupt? */
\r
473 if( ulCurrentInterrupt >= portFIRST_USER_INTERRUPT_NUMBER )
\r
475 /* Look up the interrupt's priority. */
\r
476 ucCurrentPriority = pcInterruptPriorityRegisters[ ulCurrentInterrupt ];
\r
478 /* The following assertion will fail if a service routine (ISR) for
\r
479 an interrupt that has been assigned a priority above
\r
480 configMAX_SYSCALL_INTERRUPT_PRIORITY calls an ISR safe FreeRTOS API
\r
481 function. ISR safe FreeRTOS API functions must *only* be called
\r
482 from interrupts that have been assigned a priority at or below
\r
483 configMAX_SYSCALL_INTERRUPT_PRIORITY.
\r
485 Numerically low interrupt priority numbers represent logically high
\r
486 interrupt priorities, therefore the priority of the interrupt must
\r
487 be set to a value equal to or numerically *higher* than
\r
488 configMAX_SYSCALL_INTERRUPT_PRIORITY.
\r
490 Interrupts that use the FreeRTOS API must not be left at their
\r
491 default priority of zero as that is the highest possible priority,
\r
492 which is guaranteed to be above configMAX_SYSCALL_INTERRUPT_PRIORITY,
\r
493 and therefore also guaranteed to be invalid.
\r
495 FreeRTOS maintains separate thread and ISR API functions to ensure
\r
496 interrupt entry is as fast and simple as possible.
\r
498 The following links provide detailed information:
\r
499 http://www.freertos.org/RTOS-Cortex-M3-M4.html
\r
500 http://www.freertos.org/FAQHelp.html */
\r
501 configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
\r
504 /* Priority grouping: The interrupt controller (NVIC) allows the bits
\r
505 that define each interrupt's priority to be split between bits that
\r
506 define the interrupt's pre-emption priority bits and bits that define
\r
507 the interrupt's sub-priority. For simplicity all bits must be defined
\r
508 to be pre-emption priority bits. The following assertion will fail if
\r
509 this is not the case (if some bits represent a sub-priority).
\r
511 If CMSIS libraries are being used then the correct setting can be
\r
512 achieved by calling NVIC_SetPriorityGrouping( 0 ); before starting the
\r
514 configASSERT( ( portAIRCR_REG & portPRIORITY_GROUP_MASK ) == 0 );
\r
517 #endif /* configASSERT_DEFINED */
\r