2 * FreeRTOS Kernel V10.3.1
\r
3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
\r
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
\r
6 * this software and associated documentation files (the "Software"), to deal in
\r
7 * the Software without restriction, including without limitation the rights to
\r
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
\r
9 * the Software, and to permit persons to whom the Software is furnished to do so,
\r
10 * subject to the following conditions:
\r
12 * The above copyright notice and this permission notice shall be included in all
\r
13 * copies or substantial portions of the Software.
\r
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
\r
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
\r
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
\r
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
\r
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
\r
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\r
22 * https://www.FreeRTOS.org
\r
23 * https://github.com/FreeRTOS
\r
27 /*-----------------------------------------------------------
\r
28 * Implementation of functions defined in portable.h for the ARM CM4F port.
\r
29 *----------------------------------------------------------*/
\r
31 /* Scheduler includes. */
\r
32 #include "FreeRTOS.h"
\r
35 #ifndef __TARGET_FPU_VFP
\r
36 #error This port can only be used when the project options are configured to enable hardware floating point support.
\r
39 #if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0
\r
40 #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0. See http: /*www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
\r
43 #ifndef configSYSTICK_CLOCK_HZ
\r
44 #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ
\r
45 /* Ensure the SysTick is clocked at the same frequency as the core. */
\r
46 #define portNVIC_SYSTICK_CLK_BIT ( 1UL << 2UL )
\r
49 /* The way the SysTick is clocked is not modified in case it is not the same
\r
51 #define portNVIC_SYSTICK_CLK_BIT ( 0 )
\r
54 /* Legacy macro for backward compatibility only. This macro used to be used to
\r
55 * replace the function that configures the clock used to generate the tick
\r
56 * interrupt (prvSetupTimerInterrupt()), but now the function is declared weak so
\r
57 * the application writer can override it by simply defining a function of the
\r
58 * same name (vApplicationSetupTickInterrupt()). */
\r
59 #ifndef configOVERRIDE_DEFAULT_TICK_CONFIGURATION
\r
60 #define configOVERRIDE_DEFAULT_TICK_CONFIGURATION 0
\r
63 /* Constants required to manipulate the core. Registers first... */
\r
64 #define portNVIC_SYSTICK_CTRL_REG ( *( ( volatile uint32_t * ) 0xe000e010 ) )
\r
65 #define portNVIC_SYSTICK_LOAD_REG ( *( ( volatile uint32_t * ) 0xe000e014 ) )
\r
66 #define portNVIC_SYSTICK_CURRENT_VALUE_REG ( *( ( volatile uint32_t * ) 0xe000e018 ) )
\r
67 #define portNVIC_SHPR3_REG ( *( ( volatile uint32_t * ) 0xe000ed20 ) )
\r
68 /* ...then bits in the registers. */
\r
69 #define portNVIC_SYSTICK_INT_BIT ( 1UL << 1UL )
\r
70 #define portNVIC_SYSTICK_ENABLE_BIT ( 1UL << 0UL )
\r
71 #define portNVIC_SYSTICK_COUNT_FLAG_BIT ( 1UL << 16UL )
\r
72 #define portNVIC_PENDSVCLEAR_BIT ( 1UL << 27UL )
\r
73 #define portNVIC_PEND_SYSTICK_CLEAR_BIT ( 1UL << 25UL )
\r
75 /* Constants used to detect a Cortex-M7 r0p1 core, which should use the ARM_CM7
\r
77 #define portCPUID ( *( ( volatile uint32_t * ) 0xE000ed00 ) )
\r
78 #define portCORTEX_M7_r0p1_ID ( 0x410FC271UL )
\r
79 #define portCORTEX_M7_r0p0_ID ( 0x410FC270UL )
\r
81 #define portNVIC_PENDSV_PRI ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 16UL )
\r
82 #define portNVIC_SYSTICK_PRI ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )
\r
84 /* Constants required to check the validity of an interrupt priority. */
\r
85 #define portFIRST_USER_INTERRUPT_NUMBER ( 16 )
\r
86 #define portNVIC_IP_REGISTERS_OFFSET_16 ( 0xE000E3F0 )
\r
87 #define portAIRCR_REG ( *( ( volatile uint32_t * ) 0xE000ED0C ) )
\r
88 #define portMAX_8_BIT_VALUE ( ( uint8_t ) 0xff )
\r
89 #define portTOP_BIT_OF_BYTE ( ( uint8_t ) 0x80 )
\r
90 #define portMAX_PRIGROUP_BITS ( ( uint8_t ) 7 )
\r
91 #define portPRIORITY_GROUP_MASK ( 0x07UL << 8UL )
\r
92 #define portPRIGROUP_SHIFT ( 8UL )
\r
94 /* Masks off all bits but the VECTACTIVE bits in the ICSR register. */
\r
95 #define portVECTACTIVE_MASK ( 0xFFUL )
\r
97 /* Constants required to manipulate the VFP. */
\r
98 #define portFPCCR ( ( volatile uint32_t * ) 0xe000ef34 ) /* Floating point context control register. */
\r
99 #define portASPEN_AND_LSPEN_BITS ( 0x3UL << 30UL )
\r
101 /* Constants required to set up the initial stack. */
\r
102 #define portINITIAL_XPSR ( 0x01000000 )
\r
103 #define portINITIAL_EXC_RETURN ( 0xfffffffd )
\r
105 /* The systick is a 24-bit counter. */
\r
106 #define portMAX_24_BIT_NUMBER ( 0xffffffUL )
\r
108 /* A fiddle factor to estimate the number of SysTick counts that would have
\r
109 * occurred while the SysTick counter is stopped during tickless idle
\r
111 #define portMISSED_COUNTS_FACTOR ( 45UL )
\r
113 /* For strict compliance with the Cortex-M spec the task start address should
\r
114 * have bit-0 clear, as it is loaded into the PC on exit from an ISR. */
\r
115 #define portSTART_ADDRESS_MASK ( ( StackType_t ) 0xfffffffeUL )
\r
118 * Setup the timer to generate the tick interrupts. The implementation in this
\r
119 * file is weak to allow application writers to change the timer used to
\r
120 * generate the tick interrupt.
\r
122 void vPortSetupTimerInterrupt( void );
\r
125 * Exception handlers.
\r
127 void xPortPendSVHandler( void );
\r
128 void xPortSysTickHandler( void );
\r
129 void vPortSVCHandler( void );
\r
132 * Start first task is a separate function so it can be tested in isolation.
\r
134 static void prvStartFirstTask( void );
\r
137 * Functions defined in portasm.s to enable the VFP.
\r
139 static void prvEnableVFP( void );
\r
142 * Used to catch tasks that attempt to return from their implementing function.
\r
144 static void prvTaskExitError( void );
\r
146 /*-----------------------------------------------------------*/
\r
148 /* Each task maintains its own interrupt status in the critical nesting
\r
150 static UBaseType_t uxCriticalNesting = 0xaaaaaaaa;
\r
153 * The number of SysTick increments that make up one tick period.
\r
155 #if ( configUSE_TICKLESS_IDLE == 1 )
\r
156 static uint32_t ulTimerCountsForOneTick = 0;
\r
157 #endif /* configUSE_TICKLESS_IDLE */
\r
160 * The maximum number of tick periods that can be suppressed is limited by the
\r
161 * 24 bit resolution of the SysTick timer.
\r
163 #if ( configUSE_TICKLESS_IDLE == 1 )
\r
164 static uint32_t xMaximumPossibleSuppressedTicks = 0;
\r
165 #endif /* configUSE_TICKLESS_IDLE */
\r
168 * Compensate for the CPU cycles that pass while the SysTick is stopped (low
\r
169 * power functionality only.
\r
171 #if ( configUSE_TICKLESS_IDLE == 1 )
\r
172 static uint32_t ulStoppedTimerCompensation = 0;
\r
173 #endif /* configUSE_TICKLESS_IDLE */
\r
176 * Used by the portASSERT_IF_INTERRUPT_PRIORITY_INVALID() macro to ensure
\r
177 * FreeRTOS API functions are not called from interrupts that have been assigned
\r
178 * a priority above configMAX_SYSCALL_INTERRUPT_PRIORITY.
\r
180 #if ( configASSERT_DEFINED == 1 )
\r
181 static uint8_t ucMaxSysCallPriority = 0;
\r
182 static uint32_t ulMaxPRIGROUPValue = 0;
\r
183 static const volatile uint8_t * const pcInterruptPriorityRegisters = ( uint8_t * ) portNVIC_IP_REGISTERS_OFFSET_16;
\r
184 #endif /* configASSERT_DEFINED */
\r
186 /*-----------------------------------------------------------*/
\r
189 * See header file for description.
\r
191 StackType_t * pxPortInitialiseStack( StackType_t * pxTopOfStack,
\r
192 TaskFunction_t pxCode,
\r
193 void * pvParameters )
\r
195 /* Simulate the stack frame as it would be created by a context switch
\r
198 /* Offset added to account for the way the MCU uses the stack on entry/exit
\r
199 * of interrupts, and to ensure alignment. */
\r
202 *pxTopOfStack = portINITIAL_XPSR; /* xPSR */
\r
204 *pxTopOfStack = ( ( StackType_t ) pxCode ) & portSTART_ADDRESS_MASK; /* PC */
\r
206 *pxTopOfStack = ( StackType_t ) prvTaskExitError; /* LR */
\r
208 /* Save code space by skipping register initialisation. */
\r
209 pxTopOfStack -= 5; /* R12, R3, R2 and R1. */
\r
210 *pxTopOfStack = ( StackType_t ) pvParameters; /* R0 */
\r
212 /* A save method is being used that requires each task to maintain its
\r
213 * own exec return value. */
\r
215 *pxTopOfStack = portINITIAL_EXC_RETURN;
\r
217 pxTopOfStack -= 8; /* R11, R10, R9, R8, R7, R6, R5 and R4. */
\r
219 return pxTopOfStack;
\r
221 /*-----------------------------------------------------------*/
\r
223 static void prvTaskExitError( void )
\r
225 /* A function that implements a task must not exit or attempt to return to
\r
226 * its caller as there is nothing to return to. If a task wants to exit it
\r
227 * should instead call vTaskDelete( NULL ).
\r
229 * Artificially force an assert() to be triggered if configASSERT() is
\r
230 * defined, then stop here so application writers can catch the error. */
\r
231 configASSERT( uxCriticalNesting == ~0UL );
\r
232 portDISABLE_INTERRUPTS();
\r
238 /*-----------------------------------------------------------*/
\r
240 __asm void vPortSVCHandler( void )
\r
245 /* Get the location of the current TCB. */
\r
246 ldr r3, = pxCurrentTCB
\r
249 /* Pop the core registers. */
\r
260 /*-----------------------------------------------------------*/
\r
262 __asm void prvStartFirstTask( void )
\r
267 /* Use the NVIC offset register to locate the stack. */
\r
268 ldr r0, =0xE000ED08
\r
271 /* Set the msp back to the start of the stack. */
\r
274 /* Clear the bit that indicates the FPU is in use in case the FPU was used
\r
275 * before the scheduler was started - which would otherwise result in the
\r
276 * unnecessary leaving of space in the SVC stack for lazy saving of FPU
\r
280 /* Globally enable interrupts. */
\r
285 /* Call SVC to start the first task. */
\r
291 /*-----------------------------------------------------------*/
\r
293 __asm void prvEnableVFP( void )
\r
298 /* The FPU enable bits are in the CPACR. */
\r
299 ldr.w r0, =0xE000ED88
\r
302 /* Enable CP10 and CP11 coprocessors, then save back. */
\r
303 orr r1, r1, # ( 0xf << 20 )
\r
309 /*-----------------------------------------------------------*/
\r
312 * See header file for description.
\r
314 BaseType_t xPortStartScheduler( void )
\r
316 /* configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.
\r
317 * See https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
\r
318 configASSERT( configMAX_SYSCALL_INTERRUPT_PRIORITY );
\r
320 /* This port can be used on all revisions of the Cortex-M7 core other than
\r
321 * the r0p1 parts. r0p1 parts should use the port from the
\r
322 * /source/portable/GCC/ARM_CM7/r0p1 directory. */
\r
323 configASSERT( portCPUID != portCORTEX_M7_r0p1_ID );
\r
324 configASSERT( portCPUID != portCORTEX_M7_r0p0_ID );
\r
326 #if ( configASSERT_DEFINED == 1 )
\r
328 volatile uint32_t ulOriginalPriority;
\r
329 volatile uint8_t * const pucFirstUserPriorityRegister = ( uint8_t * ) ( portNVIC_IP_REGISTERS_OFFSET_16 + portFIRST_USER_INTERRUPT_NUMBER );
\r
330 volatile uint8_t ucMaxPriorityValue;
\r
332 /* Determine the maximum priority from which ISR safe FreeRTOS API
\r
333 * functions can be called. ISR safe functions are those that end in
\r
334 * "FromISR". FreeRTOS maintains separate thread and ISR API functions to
\r
335 * ensure interrupt entry is as fast and simple as possible.
\r
337 * Save the interrupt priority value that is about to be clobbered. */
\r
338 ulOriginalPriority = *pucFirstUserPriorityRegister;
\r
340 /* Determine the number of priority bits available. First write to all
\r
341 * possible bits. */
\r
342 *pucFirstUserPriorityRegister = portMAX_8_BIT_VALUE;
\r
344 /* Read the value back to see how many bits stuck. */
\r
345 ucMaxPriorityValue = *pucFirstUserPriorityRegister;
\r
347 /* The kernel interrupt priority should be set to the lowest
\r
349 configASSERT( ucMaxPriorityValue == ( configKERNEL_INTERRUPT_PRIORITY & ucMaxPriorityValue ) );
\r
351 /* Use the same mask on the maximum system call priority. */
\r
352 ucMaxSysCallPriority = configMAX_SYSCALL_INTERRUPT_PRIORITY & ucMaxPriorityValue;
\r
354 /* Calculate the maximum acceptable priority group value for the number
\r
355 * of bits read back. */
\r
356 ulMaxPRIGROUPValue = portMAX_PRIGROUP_BITS;
\r
358 while( ( ucMaxPriorityValue & portTOP_BIT_OF_BYTE ) == portTOP_BIT_OF_BYTE )
\r
360 ulMaxPRIGROUPValue--;
\r
361 ucMaxPriorityValue <<= ( uint8_t ) 0x01;
\r
364 #ifdef __NVIC_PRIO_BITS
\r
366 /* Check the CMSIS configuration that defines the number of
\r
367 * priority bits matches the number of priority bits actually queried
\r
368 * from the hardware. */
\r
369 configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == __NVIC_PRIO_BITS );
\r
373 #ifdef configPRIO_BITS
\r
375 /* Check the FreeRTOS configuration that defines the number of
\r
376 * priority bits matches the number of priority bits actually queried
\r
377 * from the hardware. */
\r
378 configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == configPRIO_BITS );
\r
382 /* Shift the priority group value back to its position within the AIRCR
\r
384 ulMaxPRIGROUPValue <<= portPRIGROUP_SHIFT;
\r
385 ulMaxPRIGROUPValue &= portPRIORITY_GROUP_MASK;
\r
387 /* Restore the clobbered interrupt priority register to its original
\r
389 *pucFirstUserPriorityRegister = ulOriginalPriority;
\r
391 #endif /* conifgASSERT_DEFINED */
\r
393 /* Make PendSV and SysTick the lowest priority interrupts. */
\r
394 portNVIC_SHPR3_REG |= portNVIC_PENDSV_PRI;
\r
395 portNVIC_SHPR3_REG |= portNVIC_SYSTICK_PRI;
\r
397 /* Start the timer that generates the tick ISR. Interrupts are disabled
\r
399 vPortSetupTimerInterrupt();
\r
401 /* Initialise the critical nesting count ready for the first task. */
\r
402 uxCriticalNesting = 0;
\r
404 /* Ensure the VFP is enabled - it should be anyway. */
\r
407 /* Lazy save always. */
\r
408 *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;
\r
410 /* Start the first task. */
\r
411 prvStartFirstTask();
\r
413 /* Should not get here! */
\r
416 /*-----------------------------------------------------------*/
\r
418 void vPortEndScheduler( void )
\r
420 /* Not implemented in ports where there is nothing to return to.
\r
421 * Artificially force an assert. */
\r
422 configASSERT( uxCriticalNesting == 1000UL );
\r
424 /*-----------------------------------------------------------*/
\r
426 void vPortEnterCritical( void )
\r
428 portDISABLE_INTERRUPTS();
\r
429 uxCriticalNesting++;
\r
431 /* This is not the interrupt safe version of the enter critical function so
\r
432 * assert() if it is being called from an interrupt context. Only API
\r
433 * functions that end in "FromISR" can be used in an interrupt. Only assert if
\r
434 * the critical nesting count is 1 to protect against recursive calls if the
\r
435 * assert function also uses a critical section. */
\r
436 if( uxCriticalNesting == 1 )
\r
438 configASSERT( ( portNVIC_INT_CTRL_REG & portVECTACTIVE_MASK ) == 0 );
\r
441 /*-----------------------------------------------------------*/
\r
443 void vPortExitCritical( void )
\r
445 configASSERT( uxCriticalNesting );
\r
446 uxCriticalNesting--;
\r
448 if( uxCriticalNesting == 0 )
\r
450 portENABLE_INTERRUPTS();
\r
453 /*-----------------------------------------------------------*/
\r
455 __asm void xPortPendSVHandler( void )
\r
457 extern uxCriticalNesting;
\r
458 extern pxCurrentTCB;
\r
459 extern vTaskSwitchContext;
\r
466 /* Get the location of the current TCB. */
\r
467 ldr r3, =pxCurrentTCB
\r
470 /* Is the task using the FPU context? If so, push high vfp registers. */
\r
477 /* Save the core registers. */
\r
482 /* Save the new top of stack into the first member of the TCB. */
\r
488 mov r0, # configMAX_SYSCALL_INTERRUPT_PRIORITY
\r
492 bl vTaskSwitchContext
\r
499 /* The first item in pxCurrentTCB is the task top of stack. */
\r
503 /* Pop the core registers. */
\r
508 /* Is the task using the FPU context? If so, pop the high vfp registers
\r
518 #ifdef WORKAROUND_PMU_CM001 /* XMC4000 specific errata */
\r
519 #if WORKAROUND_PMU_CM001 == 1
\r
533 /*-----------------------------------------------------------*/
\r
535 void xPortSysTickHandler( void )
\r
537 /* The SysTick runs at the lowest interrupt priority, so when this interrupt
\r
538 * executes all interrupts must be unmasked. There is therefore no need to
\r
539 * save and then restore the interrupt mask value as its value is already
\r
540 * known - therefore the slightly faster vPortRaiseBASEPRI() function is used
\r
541 * in place of portSET_INTERRUPT_MASK_FROM_ISR(). */
\r
542 vPortRaiseBASEPRI();
\r
544 /* Increment the RTOS tick. */
\r
545 if( xTaskIncrementTick() != pdFALSE )
\r
547 /* A context switch is required. Context switching is performed in
\r
548 * the PendSV interrupt. Pend the PendSV interrupt. */
\r
549 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;
\r
553 vPortClearBASEPRIFromISR();
\r
555 /*-----------------------------------------------------------*/
\r
557 #if ( configUSE_TICKLESS_IDLE == 1 )
\r
559 __weak void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime )
\r
561 uint32_t ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements;
\r
562 TickType_t xModifiableIdleTime;
\r
564 /* Make sure the SysTick reload value does not overflow the counter. */
\r
565 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )
\r
567 xExpectedIdleTime = xMaximumPossibleSuppressedTicks;
\r
570 /* Stop the SysTick momentarily. The time the SysTick is stopped for
\r
571 * is accounted for as best it can be, but using the tickless mode will
\r
572 * inevitably result in some tiny drift of the time maintained by the
\r
573 * kernel with respect to calendar time. */
\r
574 portNVIC_SYSTICK_CTRL_REG &= ~portNVIC_SYSTICK_ENABLE_BIT;
\r
576 /* Calculate the reload value required to wait xExpectedIdleTime
\r
577 * tick periods. -1 is used because this code will execute part way
\r
578 * through one of the tick periods. */
\r
579 ulReloadValue = portNVIC_SYSTICK_CURRENT_VALUE_REG + ( ulTimerCountsForOneTick * ( xExpectedIdleTime - 1UL ) );
\r
581 if( ulReloadValue > ulStoppedTimerCompensation )
\r
583 ulReloadValue -= ulStoppedTimerCompensation;
\r
586 /* Enter a critical section but don't use the taskENTER_CRITICAL()
\r
587 * method as that will mask interrupts that should exit sleep mode. */
\r
589 __dsb( portSY_FULL_READ_WRITE );
\r
590 __isb( portSY_FULL_READ_WRITE );
\r
592 /* If a context switch is pending or a task is waiting for the scheduler
\r
593 * to be unsuspended then abandon the low power entry. */
\r
594 if( eTaskConfirmSleepModeStatus() == eAbortSleep )
\r
596 /* Restart from whatever is left in the count register to complete
\r
597 * this tick period. */
\r
598 portNVIC_SYSTICK_LOAD_REG = portNVIC_SYSTICK_CURRENT_VALUE_REG;
\r
600 /* Restart SysTick. */
\r
601 portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;
\r
603 /* Reset the reload register to the value required for normal tick
\r
605 portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;
\r
607 /* Re-enable interrupts - see comments above __disable_irq() call
\r
613 /* Set the new reload value. */
\r
614 portNVIC_SYSTICK_LOAD_REG = ulReloadValue;
\r
616 /* Clear the SysTick count flag and set the count value back to
\r
618 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
620 /* Restart SysTick. */
\r
621 portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;
\r
623 /* Sleep until something happens. configPRE_SLEEP_PROCESSING() can
\r
624 * set its parameter to 0 to indicate that its implementation contains
\r
625 * its own wait for interrupt or wait for event instruction, and so wfi
\r
626 * should not be executed again. However, the original expected idle
\r
627 * time variable must remain unmodified, so a copy is taken. */
\r
628 xModifiableIdleTime = xExpectedIdleTime;
\r
629 configPRE_SLEEP_PROCESSING( xModifiableIdleTime );
\r
631 if( xModifiableIdleTime > 0 )
\r
633 __dsb( portSY_FULL_READ_WRITE );
\r
635 __isb( portSY_FULL_READ_WRITE );
\r
638 configPOST_SLEEP_PROCESSING( xExpectedIdleTime );
\r
640 /* Re-enable interrupts to allow the interrupt that brought the MCU
\r
641 * out of sleep mode to execute immediately. see comments above
\r
642 * __disable_interrupt() call above. */
\r
644 __dsb( portSY_FULL_READ_WRITE );
\r
645 __isb( portSY_FULL_READ_WRITE );
\r
647 /* Disable interrupts again because the clock is about to be stopped
\r
648 * and interrupts that execute while the clock is stopped will increase
\r
649 * any slippage between the time maintained by the RTOS and calendar
\r
652 __dsb( portSY_FULL_READ_WRITE );
\r
653 __isb( portSY_FULL_READ_WRITE );
\r
655 /* Disable the SysTick clock without reading the
\r
656 * portNVIC_SYSTICK_CTRL_REG register to ensure the
\r
657 * portNVIC_SYSTICK_COUNT_FLAG_BIT is not cleared if it is set. Again,
\r
658 * the time the SysTick is stopped for is accounted for as best it can
\r
659 * be, but using the tickless mode will inevitably result in some tiny
\r
660 * drift of the time maintained by the kernel with respect to calendar
\r
662 portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT );
\r
664 /* Determine if the SysTick clock has already counted to zero and
\r
665 * been set back to the current reload value (the reload back being
\r
666 * correct for the entire expected idle time) or if the SysTick is yet
\r
667 * to count to zero (in which case an interrupt other than the SysTick
\r
668 * must have brought the system out of sleep mode). */
\r
669 if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )
\r
671 uint32_t ulCalculatedLoadValue;
\r
673 /* The tick interrupt is already pending, and the SysTick count
\r
674 * reloaded with ulReloadValue. Reset the
\r
675 * portNVIC_SYSTICK_LOAD_REG with whatever remains of this tick
\r
677 ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL ) - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );
\r
679 /* Don't allow a tiny value, or values that have somehow
\r
680 * underflowed because the post sleep hook did something
\r
681 * that took too long. */
\r
682 if( ( ulCalculatedLoadValue < ulStoppedTimerCompensation ) || ( ulCalculatedLoadValue > ulTimerCountsForOneTick ) )
\r
684 ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL );
\r
687 portNVIC_SYSTICK_LOAD_REG = ulCalculatedLoadValue;
\r
689 /* As the pending tick will be processed as soon as this
\r
690 * function exits, the tick value maintained by the tick is stepped
\r
691 * forward by one less than the time spent waiting. */
\r
692 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;
\r
696 /* Something other than the tick interrupt ended the sleep.
\r
697 * Work out how long the sleep lasted rounded to complete tick
\r
698 * periods (not the ulReload value which accounted for part
\r
700 ulCompletedSysTickDecrements = ( xExpectedIdleTime * ulTimerCountsForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;
\r
702 /* How many complete tick periods passed while the processor
\r
704 ulCompleteTickPeriods = ulCompletedSysTickDecrements / ulTimerCountsForOneTick;
\r
706 /* The reload value is set to whatever fraction of a single tick
\r
707 * period remains. */
\r
708 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1UL ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;
\r
711 /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG
\r
712 * again, then set portNVIC_SYSTICK_LOAD_REG back to its standard
\r
714 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
715 portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;
\r
716 vTaskStepTick( ulCompleteTickPeriods );
\r
717 portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;
\r
719 /* Exit with interrupts enabled. */
\r
724 #endif /* #if configUSE_TICKLESS_IDLE */
\r
726 /*-----------------------------------------------------------*/
\r
729 * Setup the SysTick timer to generate the tick interrupts at the required
\r
732 #if ( configOVERRIDE_DEFAULT_TICK_CONFIGURATION == 0 )
\r
734 __weak void vPortSetupTimerInterrupt( void )
\r
736 /* Calculate the constants required to configure the tick interrupt. */
\r
737 #if ( configUSE_TICKLESS_IDLE == 1 )
\r
739 ulTimerCountsForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );
\r
740 xMaximumPossibleSuppressedTicks = portMAX_24_BIT_NUMBER / ulTimerCountsForOneTick;
\r
741 ulStoppedTimerCompensation = portMISSED_COUNTS_FACTOR / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );
\r
743 #endif /* configUSE_TICKLESS_IDLE */
\r
745 /* Stop and clear the SysTick. */
\r
746 portNVIC_SYSTICK_CTRL_REG = 0UL;
\r
747 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;
\r
749 /* Configure SysTick to interrupt at the requested rate. */
\r
750 portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;
\r
751 portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT );
\r
754 #endif /* configOVERRIDE_DEFAULT_TICK_CONFIGURATION */
\r
755 /*-----------------------------------------------------------*/
\r
757 __asm uint32_t vPortGetIPSR( void )
\r
766 /*-----------------------------------------------------------*/
\r
768 #if ( configASSERT_DEFINED == 1 )
\r
770 void vPortValidateInterruptPriority( void )
\r
772 uint32_t ulCurrentInterrupt;
\r
773 uint8_t ucCurrentPriority;
\r
775 /* Obtain the number of the currently executing interrupt. */
\r
776 ulCurrentInterrupt = vPortGetIPSR();
\r
778 /* Is the interrupt number a user defined interrupt? */
\r
779 if( ulCurrentInterrupt >= portFIRST_USER_INTERRUPT_NUMBER )
\r
781 /* Look up the interrupt's priority. */
\r
782 ucCurrentPriority = pcInterruptPriorityRegisters[ ulCurrentInterrupt ];
\r
784 /* The following assertion will fail if a service routine (ISR) for
\r
785 * an interrupt that has been assigned a priority above
\r
786 * configMAX_SYSCALL_INTERRUPT_PRIORITY calls an ISR safe FreeRTOS API
\r
787 * function. ISR safe FreeRTOS API functions must *only* be called
\r
788 * from interrupts that have been assigned a priority at or below
\r
789 * configMAX_SYSCALL_INTERRUPT_PRIORITY.
\r
791 * Numerically low interrupt priority numbers represent logically high
\r
792 * interrupt priorities, therefore the priority of the interrupt must
\r
793 * be set to a value equal to or numerically *higher* than
\r
794 * configMAX_SYSCALL_INTERRUPT_PRIORITY.
\r
796 * Interrupts that use the FreeRTOS API must not be left at their
\r
797 * default priority of zero as that is the highest possible priority,
\r
798 * which is guaranteed to be above configMAX_SYSCALL_INTERRUPT_PRIORITY,
\r
799 * and therefore also guaranteed to be invalid.
\r
801 * FreeRTOS maintains separate thread and ISR API functions to ensure
\r
802 * interrupt entry is as fast and simple as possible.
\r
804 * The following links provide detailed information:
\r
805 * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html
\r
806 * https://www.FreeRTOS.org/FAQHelp.html */
\r
807 configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );
\r
810 /* Priority grouping: The interrupt controller (NVIC) allows the bits
\r
811 * that define each interrupt's priority to be split between bits that
\r
812 * define the interrupt's pre-emption priority bits and bits that define
\r
813 * the interrupt's sub-priority. For simplicity all bits must be defined
\r
814 * to be pre-emption priority bits. The following assertion will fail if
\r
815 * this is not the case (if some bits represent a sub-priority).
\r
817 * If the application only uses CMSIS libraries for interrupt
\r
818 * configuration then the correct setting can be achieved on all Cortex-M
\r
819 * devices by calling NVIC_SetPriorityGrouping( 0 ); before starting the
\r
820 * scheduler. Note however that some vendor specific peripheral libraries
\r
821 * assume a non-zero priority group setting, in which cases using a value
\r
822 * of zero will result in unpredictable behaviour. */
\r
823 configASSERT( ( portAIRCR_REG & portPRIORITY_GROUP_MASK ) <= ulMaxPRIGROUPValue );
\r
826 #endif /* configASSERT_DEFINED */
\r