]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/IAR/ARM_CM7/r0p1/port.c
Updates to the Cortex-M tickless idle code to reduce clock slippage.
[freertos] / FreeRTOS / Source / portable / IAR / ARM_CM7 / r0p1 / port.c
1 /*\r
2     FreeRTOS V9.0.1 - Copyright (C) 2017 Real Time Engineers Ltd.\r
3     All rights reserved\r
4 \r
5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
6 \r
7     This file is part of the FreeRTOS distribution.\r
8 \r
9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
10     the terms of the GNU General Public License (version 2) as published by the\r
11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
12 \r
13     ***************************************************************************\r
14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
16     >>!   obliged to provide the source code for proprietary components     !<<\r
17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
18     ***************************************************************************\r
19 \r
20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
23     link: http://www.freertos.org/a00114.html\r
24 \r
25     ***************************************************************************\r
26      *                                                                       *\r
27      *    FreeRTOS provides completely free yet professionally developed,    *\r
28      *    robust, strictly quality controlled, supported, and cross          *\r
29      *    platform software that is more than just the market leader, it     *\r
30      *    is the industry's de facto standard.                               *\r
31      *                                                                       *\r
32      *    Help yourself get started quickly while simultaneously helping     *\r
33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
34      *    tutorial book, reference manual, or both:                          *\r
35      *    http://www.FreeRTOS.org/Documentation                              *\r
36      *                                                                       *\r
37     ***************************************************************************\r
38 \r
39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
41     defined configASSERT()?\r
42 \r
43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
44     embedded software for free we request you assist our global community by\r
45     participating in the support forum.\r
46 \r
47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
48     be as productive as possible as early as possible.  Now you can receive\r
49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
50     Ltd, and the world's leading authority on the world's leading RTOS.\r
51 \r
52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
55 \r
56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
58 \r
59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
61     licenses offer ticketed support, indemnification and commercial middleware.\r
62 \r
63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
64     engineered and independently SIL3 certified version for use in safety and\r
65     mission critical applications that require provable dependability.\r
66 \r
67     1 tab == 4 spaces!\r
68 */\r
69 \r
70 /*-----------------------------------------------------------\r
71  * Implementation of functions defined in portable.h for the ARM CM4F port.\r
72  *----------------------------------------------------------*/\r
73 \r
74 /* IAR includes. */\r
75 #include <intrinsics.h>\r
76 \r
77 /* Scheduler includes. */\r
78 #include "FreeRTOS.h"\r
79 #include "task.h"\r
80 \r
81 #ifndef __ARMVFP__\r
82         #error This port can only be used when the project options are configured to enable hardware floating point support.\r
83 #endif\r
84 \r
85 #if( configMAX_SYSCALL_INTERRUPT_PRIORITY == 0 )\r
86         #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.  See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html\r
87 #endif\r
88 \r
89 #ifndef configSYSTICK_CLOCK_HZ\r
90         #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ\r
91         /* Ensure the SysTick is clocked at the same frequency as the core. */\r
92         #define portNVIC_SYSTICK_CLK_BIT        ( 1UL << 2UL )\r
93 #else\r
94         /* The way the SysTick is clocked is not modified in case it is not the same\r
95         as the core. */\r
96         #define portNVIC_SYSTICK_CLK_BIT        ( 0 )\r
97 #endif\r
98 \r
99 /* Constants required to manipulate the core.  Registers first... */\r
100 #define portNVIC_SYSTICK_CTRL_REG                       ( * ( ( volatile uint32_t * ) 0xe000e010 ) )\r
101 #define portNVIC_SYSTICK_LOAD_REG                       ( * ( ( volatile uint32_t * ) 0xe000e014 ) )\r
102 #define portNVIC_SYSTICK_CURRENT_VALUE_REG      ( * ( ( volatile uint32_t * ) 0xe000e018 ) )\r
103 #define portNVIC_SYSPRI2_REG                            ( * ( ( volatile uint32_t * ) 0xe000ed20 ) )\r
104 /* ...then bits in the registers. */\r
105 #define portNVIC_SYSTICK_INT_BIT                        ( 1UL << 1UL )\r
106 #define portNVIC_SYSTICK_ENABLE_BIT                     ( 1UL << 0UL )\r
107 #define portNVIC_SYSTICK_COUNT_FLAG_BIT         ( 1UL << 16UL )\r
108 #define portNVIC_PENDSVCLEAR_BIT                        ( 1UL << 27UL )\r
109 #define portNVIC_PEND_SYSTICK_CLEAR_BIT         ( 1UL << 25UL )\r
110 \r
111 #define portNVIC_PENDSV_PRI                                     ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 16UL )\r
112 #define portNVIC_SYSTICK_PRI                            ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )\r
113 \r
114 /* Constants required to check the validity of an interrupt priority. */\r
115 #define portFIRST_USER_INTERRUPT_NUMBER         ( 16 )\r
116 #define portNVIC_IP_REGISTERS_OFFSET_16         ( 0xE000E3F0 )\r
117 #define portAIRCR_REG                                           ( * ( ( volatile uint32_t * ) 0xE000ED0C ) )\r
118 #define portMAX_8_BIT_VALUE                                     ( ( uint8_t ) 0xff )\r
119 #define portTOP_BIT_OF_BYTE                                     ( ( uint8_t ) 0x80 )\r
120 #define portMAX_PRIGROUP_BITS                           ( ( uint8_t ) 7 )\r
121 #define portPRIORITY_GROUP_MASK                         ( 0x07UL << 8UL )\r
122 #define portPRIGROUP_SHIFT                                      ( 8UL )\r
123 \r
124 /* Masks off all bits but the VECTACTIVE bits in the ICSR register. */\r
125 #define portVECTACTIVE_MASK                                     ( 0xFFUL )\r
126 \r
127 /* Constants required to manipulate the VFP. */\r
128 #define portFPCCR                                                       ( ( volatile uint32_t * ) 0xe000ef34 ) /* Floating point context control register. */\r
129 #define portASPEN_AND_LSPEN_BITS                        ( 0x3UL << 30UL )\r
130 \r
131 /* Constants required to set up the initial stack. */\r
132 #define portINITIAL_XPSR                                        ( 0x01000000 )\r
133 #define portINITIAL_EXEC_RETURN                         ( 0xfffffffd )\r
134 \r
135 /* The systick is a 24-bit counter. */\r
136 #define portMAX_24_BIT_NUMBER                           ( 0xffffffUL )\r
137 \r
138 /* A fiddle factor to estimate the number of SysTick counts that would have\r
139 occurred while the SysTick counter is stopped during tickless idle\r
140 calculations. */\r
141 #define portMISSED_COUNTS_FACTOR                        ( 45UL )\r
142 \r
143 /* For strict compliance with the Cortex-M spec the task start address should\r
144 have bit-0 clear, as it is loaded into the PC on exit from an ISR. */\r
145 #define portSTART_ADDRESS_MASK                          ( ( StackType_t ) 0xfffffffeUL )\r
146 \r
147 /*\r
148  * Setup the timer to generate the tick interrupts.  The implementation in this\r
149  * file is weak to allow application writers to change the timer used to\r
150  * generate the tick interrupt.\r
151  */\r
152 void vPortSetupTimerInterrupt( void );\r
153 \r
154 /*\r
155  * Exception handlers.\r
156  */\r
157 void xPortSysTickHandler( void );\r
158 \r
159 /*\r
160  * Start first task is a separate function so it can be tested in isolation.\r
161  */\r
162 extern void vPortStartFirstTask( void );\r
163 \r
164 /*\r
165  * Turn the VFP on.\r
166  */\r
167 extern void vPortEnableVFP( void );\r
168 \r
169 /*\r
170  * Used to catch tasks that attempt to return from their implementing function.\r
171  */\r
172 static void prvTaskExitError( void );\r
173 \r
174 /*-----------------------------------------------------------*/\r
175 \r
176 /* Each task maintains its own interrupt status in the critical nesting\r
177 variable. */\r
178 static UBaseType_t uxCriticalNesting = 0xaaaaaaaa;\r
179 \r
180 /*\r
181  * The number of SysTick increments that make up one tick period.\r
182  */\r
183 #if( configUSE_TICKLESS_IDLE == 1 )\r
184         static uint32_t ulTimerCountsForOneTick = 0;\r
185 #endif /* configUSE_TICKLESS_IDLE */\r
186 \r
187 /*\r
188  * The maximum number of tick periods that can be suppressed is limited by the\r
189  * 24 bit resolution of the SysTick timer.\r
190  */\r
191 #if( configUSE_TICKLESS_IDLE == 1 )\r
192         static uint32_t xMaximumPossibleSuppressedTicks = 0;\r
193 #endif /* configUSE_TICKLESS_IDLE */\r
194 \r
195 /*\r
196  * Compensate for the CPU cycles that pass while the SysTick is stopped (low\r
197  * power functionality only.\r
198  */\r
199 #if( configUSE_TICKLESS_IDLE == 1 )\r
200         static uint32_t ulStoppedTimerCompensation = 0;\r
201 #endif /* configUSE_TICKLESS_IDLE */\r
202 \r
203 /*\r
204  * Used by the portASSERT_IF_INTERRUPT_PRIORITY_INVALID() macro to ensure\r
205  * FreeRTOS API functions are not called from interrupts that have been assigned\r
206  * a priority above configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
207  */\r
208 #if( configASSERT_DEFINED == 1 )\r
209          static uint8_t ucMaxSysCallPriority = 0;\r
210          static uint32_t ulMaxPRIGROUPValue = 0;\r
211          static const volatile uint8_t * const pcInterruptPriorityRegisters = ( const volatile uint8_t * const ) portNVIC_IP_REGISTERS_OFFSET_16;\r
212 #endif /* configASSERT_DEFINED */\r
213 \r
214 /*-----------------------------------------------------------*/\r
215 \r
216 /*\r
217  * See header file for description.\r
218  */\r
219 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )\r
220 {\r
221         /* Simulate the stack frame as it would be created by a context switch\r
222         interrupt. */\r
223 \r
224         /* Offset added to account for the way the MCU uses the stack on entry/exit\r
225         of interrupts, and to ensure alignment. */\r
226         pxTopOfStack--;\r
227 \r
228         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
229         pxTopOfStack--;\r
230         *pxTopOfStack = ( ( StackType_t ) pxCode ) & portSTART_ADDRESS_MASK;    /* PC */\r
231         pxTopOfStack--;\r
232         *pxTopOfStack = ( StackType_t ) prvTaskExitError;       /* LR */\r
233 \r
234         /* Save code space by skipping register initialisation. */\r
235         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
236         *pxTopOfStack = ( StackType_t ) pvParameters;   /* R0 */\r
237 \r
238         /* A save method is being used that requires each task to maintain its\r
239         own exec return value. */\r
240         pxTopOfStack--;\r
241         *pxTopOfStack = portINITIAL_EXEC_RETURN;\r
242 \r
243         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
244 \r
245         return pxTopOfStack;\r
246 }\r
247 /*-----------------------------------------------------------*/\r
248 \r
249 static void prvTaskExitError( void )\r
250 {\r
251         /* A function that implements a task must not exit or attempt to return to\r
252         its caller as there is nothing to return to.  If a task wants to exit it\r
253         should instead call vTaskDelete( NULL ).\r
254 \r
255         Artificially force an assert() to be triggered if configASSERT() is\r
256         defined, then stop here so application writers can catch the error. */\r
257         configASSERT( uxCriticalNesting == ~0UL );\r
258         portDISABLE_INTERRUPTS();\r
259         for( ;; );\r
260 }\r
261 /*-----------------------------------------------------------*/\r
262 \r
263 /*\r
264  * See header file for description.\r
265  */\r
266 BaseType_t xPortStartScheduler( void )\r
267 {\r
268         /* configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.\r
269         See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */\r
270         configASSERT( configMAX_SYSCALL_INTERRUPT_PRIORITY );\r
271 \r
272         #if( configASSERT_DEFINED == 1 )\r
273         {\r
274                 volatile uint32_t ulOriginalPriority;\r
275                 volatile uint8_t * const pucFirstUserPriorityRegister = ( volatile uint8_t * const ) ( portNVIC_IP_REGISTERS_OFFSET_16 + portFIRST_USER_INTERRUPT_NUMBER );\r
276                 volatile uint8_t ucMaxPriorityValue;\r
277 \r
278                 /* Determine the maximum priority from which ISR safe FreeRTOS API\r
279                 functions can be called.  ISR safe functions are those that end in\r
280                 "FromISR".  FreeRTOS maintains separate thread and ISR API functions to\r
281                 ensure interrupt entry is as fast and simple as possible.\r
282 \r
283                 Save the interrupt priority value that is about to be clobbered. */\r
284                 ulOriginalPriority = *pucFirstUserPriorityRegister;\r
285 \r
286                 /* Determine the number of priority bits available.  First write to all\r
287                 possible bits. */\r
288                 *pucFirstUserPriorityRegister = portMAX_8_BIT_VALUE;\r
289 \r
290                 /* Read the value back to see how many bits stuck. */\r
291                 ucMaxPriorityValue = *pucFirstUserPriorityRegister;\r
292 \r
293                 /* Use the same mask on the maximum system call priority. */\r
294                 ucMaxSysCallPriority = configMAX_SYSCALL_INTERRUPT_PRIORITY & ucMaxPriorityValue;\r
295 \r
296                 /* Calculate the maximum acceptable priority group value for the number\r
297                 of bits read back. */\r
298                 ulMaxPRIGROUPValue = portMAX_PRIGROUP_BITS;\r
299                 while( ( ucMaxPriorityValue & portTOP_BIT_OF_BYTE ) == portTOP_BIT_OF_BYTE )\r
300                 {\r
301                         ulMaxPRIGROUPValue--;\r
302                         ucMaxPriorityValue <<= ( uint8_t ) 0x01;\r
303                 }\r
304 \r
305                 #ifdef __NVIC_PRIO_BITS\r
306                 {\r
307                         /* Check the CMSIS configuration that defines the number of\r
308                         priority bits matches the number of priority bits actually queried\r
309                         from the hardware. */\r
310                         configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == __NVIC_PRIO_BITS );\r
311                 }\r
312                 #endif\r
313 \r
314                 #ifdef configPRIO_BITS\r
315                 {\r
316                         /* Check the FreeRTOS configuration that defines the number of\r
317                         priority bits matches the number of priority bits actually queried\r
318                         from the hardware. */\r
319                         configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == configPRIO_BITS );\r
320                 }\r
321                 #endif\r
322 \r
323                 /* Shift the priority group value back to its position within the AIRCR\r
324                 register. */\r
325                 ulMaxPRIGROUPValue <<= portPRIGROUP_SHIFT;\r
326                 ulMaxPRIGROUPValue &= portPRIORITY_GROUP_MASK;\r
327 \r
328                 /* Restore the clobbered interrupt priority register to its original\r
329                 value. */\r
330                 *pucFirstUserPriorityRegister = ulOriginalPriority;\r
331         }\r
332         #endif /* conifgASSERT_DEFINED */\r
333 \r
334         /* Make PendSV and SysTick the lowest priority interrupts. */\r
335         portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;\r
336         portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;\r
337 \r
338         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
339         here already. */\r
340         vPortSetupTimerInterrupt();\r
341 \r
342         /* Initialise the critical nesting count ready for the first task. */\r
343         uxCriticalNesting = 0;\r
344 \r
345         /* Ensure the VFP is enabled - it should be anyway. */\r
346         vPortEnableVFP();\r
347 \r
348         /* Lazy save always. */\r
349         *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;\r
350 \r
351         /* Start the first task. */\r
352         vPortStartFirstTask();\r
353 \r
354         /* Should not get here! */\r
355         return 0;\r
356 }\r
357 /*-----------------------------------------------------------*/\r
358 \r
359 void vPortEndScheduler( void )\r
360 {\r
361         /* Not implemented in ports where there is nothing to return to.\r
362         Artificially force an assert. */\r
363         configASSERT( uxCriticalNesting == 1000UL );\r
364 }\r
365 /*-----------------------------------------------------------*/\r
366 \r
367 void vPortEnterCritical( void )\r
368 {\r
369         portDISABLE_INTERRUPTS();\r
370         uxCriticalNesting++;\r
371 \r
372         /* This is not the interrupt safe version of the enter critical function so\r
373         assert() if it is being called from an interrupt context.  Only API\r
374         functions that end in "FromISR" can be used in an interrupt.  Only assert if\r
375         the critical nesting count is 1 to protect against recursive calls if the\r
376         assert function also uses a critical section. */\r
377         if( uxCriticalNesting == 1 )\r
378         {\r
379                 configASSERT( ( portNVIC_INT_CTRL_REG & portVECTACTIVE_MASK ) == 0 );\r
380         }\r
381 }\r
382 /*-----------------------------------------------------------*/\r
383 \r
384 void vPortExitCritical( void )\r
385 {\r
386         configASSERT( uxCriticalNesting );\r
387         uxCriticalNesting--;\r
388         if( uxCriticalNesting == 0 )\r
389         {\r
390                 portENABLE_INTERRUPTS();\r
391         }\r
392 }\r
393 /*-----------------------------------------------------------*/\r
394 \r
395 void xPortSysTickHandler( void )\r
396 {\r
397         /* The SysTick runs at the lowest interrupt priority, so when this interrupt\r
398         executes all interrupts must be unmasked.  There is therefore no need to\r
399         save and then restore the interrupt mask value as its value is already\r
400         known. */\r
401         portDISABLE_INTERRUPTS();\r
402         {\r
403                 /* Increment the RTOS tick. */\r
404                 if( xTaskIncrementTick() != pdFALSE )\r
405                 {\r
406                         /* A context switch is required.  Context switching is performed in\r
407                         the PendSV interrupt.  Pend the PendSV interrupt. */\r
408                         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
409                 }\r
410         }\r
411         portENABLE_INTERRUPTS();\r
412 }\r
413 /*-----------------------------------------------------------*/\r
414 \r
415 #if( configUSE_TICKLESS_IDLE == 1 )\r
416 \r
417         __weak void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime )\r
418         {\r
419         uint32_t ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements;\r
420         TickType_t xModifiableIdleTime;\r
421 \r
422                 /* Make sure the SysTick reload value does not overflow the counter. */\r
423                 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )\r
424                 {\r
425                         xExpectedIdleTime = xMaximumPossibleSuppressedTicks;\r
426                 }\r
427 \r
428                 /* Stop the SysTick momentarily.  The time the SysTick is stopped for\r
429                 is accounted for as best it can be, but using the tickless mode will\r
430                 inevitably result in some tiny drift of the time maintained by the\r
431                 kernel with respect to calendar time. */\r
432                 portNVIC_SYSTICK_CTRL_REG &= ~portNVIC_SYSTICK_ENABLE_BIT;\r
433 \r
434                 /* Calculate the reload value required to wait xExpectedIdleTime\r
435                 tick periods.  -1 is used because this code will execute part way\r
436                 through one of the tick periods. */\r
437                 ulReloadValue = portNVIC_SYSTICK_CURRENT_VALUE_REG + ( ulTimerCountsForOneTick * ( xExpectedIdleTime - 1UL ) );\r
438                 if( ulReloadValue > ulStoppedTimerCompensation )\r
439                 {\r
440                         ulReloadValue -= ulStoppedTimerCompensation;\r
441                 }\r
442 \r
443                 /* Enter a critical section but don't use the taskENTER_CRITICAL()\r
444                 method as that will mask interrupts that should exit sleep mode. */\r
445                 __disable_interrupt();\r
446                 __DSB();\r
447                 __ISB();\r
448 \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
452                 {\r
453                         /* Restart from whatever is left in the count register to complete\r
454                         this tick period. */\r
455                         portNVIC_SYSTICK_LOAD_REG = portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
456 \r
457                         /* Restart SysTick. */\r
458                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
459 \r
460                         /* Reset the reload register to the value required for normal tick\r
461                         periods. */\r
462                         portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
463 \r
464                         /* Re-enable interrupts - see comments above __disable_interrupt()\r
465                         call above. */\r
466                         __enable_interrupt();\r
467                 }\r
468                 else\r
469                 {\r
470                         /* Set the new reload value. */\r
471                         portNVIC_SYSTICK_LOAD_REG = ulReloadValue;\r
472 \r
473                         /* Clear the SysTick count flag and set the count value back to\r
474                         zero. */\r
475                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
476 \r
477                         /* Restart SysTick. */\r
478                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
479 \r
480                         /* Sleep until something happens.  configPRE_SLEEP_PROCESSING() can\r
481                         set its parameter to 0 to indicate that its implementation contains\r
482                         its own wait for interrupt or wait for event instruction, and so wfi\r
483                         should not be executed again.  However, the original expected idle\r
484                         time variable must remain unmodified, so a copy is taken. */\r
485                         xModifiableIdleTime = xExpectedIdleTime;\r
486                         configPRE_SLEEP_PROCESSING( xModifiableIdleTime );\r
487                         if( xModifiableIdleTime > 0 )\r
488                         {\r
489                                 __DSB();\r
490                                 __WFI();\r
491                                 __ISB();\r
492                         }\r
493                         configPOST_SLEEP_PROCESSING( xExpectedIdleTime );\r
494 \r
495                         /* Re-enable interrupts to allow the interrupt that brought the MCU\r
496                         out of sleep mode to execute immediately.  see comments above\r
497                         __disable_interrupt() call above. */\r
498                         __enable_interrupt();\r
499                         __DSB();\r
500                         __ISB();\r
501 \r
502                         /* Disable interrupts again because the clock is about to be stopped\r
503                         and interrupts that execute while the clock is stopped will increase\r
504                         any slippage between the time maintained by the RTOS and calendar\r
505                         time. */\r
506                         __disable_interrupt();\r
507                         __DSB();\r
508                         __ISB();\r
509                         \r
510                         /* Disable the SysTick clock without reading the \r
511                         portNVIC_SYSTICK_CTRL_REG register to ensure the\r
512                         portNVIC_SYSTICK_COUNT_FLAG_BIT is not cleared if it is set.  Again, \r
513                         the time the SysTick is stopped for is accounted for as best it can \r
514                         be, but using the tickless mode will inevitably result in some tiny \r
515                         drift of the time maintained by the kernel with respect to calendar \r
516                         time*/\r
517                         portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT );\r
518 \r
519                         /* Determine if the SysTick clock has already counted to zero and\r
520                         been set back to the current reload value (the reload back being\r
521                         correct for the entire expected idle time) or if the SysTick is yet\r
522                         to count to zero (in which case an interrupt other than the SysTick\r
523                         must have brought the system out of sleep mode). */\r
524                         if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
525                         {\r
526                                 uint32_t ulCalculatedLoadValue;\r
527 \r
528                                 /* The tick interrupt is already pending, and the SysTick count\r
529                                 reloaded with ulReloadValue.  Reset the\r
530                                 portNVIC_SYSTICK_LOAD_REG with whatever remains of this tick\r
531                                 period. */\r
532                                 ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL ) - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
533 \r
534                                 /* Don't allow a tiny value, or values that have somehow\r
535                                 underflowed because the post sleep hook did something\r
536                                 that took too long. */\r
537                                 if( ( ulCalculatedLoadValue < ulStoppedTimerCompensation ) || ( ulCalculatedLoadValue > ulTimerCountsForOneTick ) )\r
538                                 {\r
539                                         ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL );\r
540                                 }\r
541 \r
542                                 portNVIC_SYSTICK_LOAD_REG = ulCalculatedLoadValue;\r
543 \r
544                                 /* As the pending tick will be processed as soon as this\r
545                                 function exits, the tick value maintained by the tick is stepped\r
546                                 forward by one less than the time spent waiting. */\r
547                                 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
548                         }\r
549                         else\r
550                         {\r
551                                 /* Something other than the tick interrupt ended the sleep.\r
552                                 Work out how long the sleep lasted rounded to complete tick\r
553                                 periods (not the ulReload value which accounted for part\r
554                                 ticks). */\r
555                                 ulCompletedSysTickDecrements = ( xExpectedIdleTime * ulTimerCountsForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
556 \r
557                                 /* How many complete tick periods passed while the processor\r
558                                 was waiting? */\r
559                                 ulCompleteTickPeriods = ulCompletedSysTickDecrements / ulTimerCountsForOneTick;\r
560 \r
561                                 /* The reload value is set to whatever fraction of a single tick\r
562                                 period remains. */\r
563                                 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1UL ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;\r
564                         }\r
565 \r
566                         /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG\r
567                         again, then set portNVIC_SYSTICK_LOAD_REG back to its standard\r
568                         value. */\r
569                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
570                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
571                         vTaskStepTick( ulCompleteTickPeriods );\r
572                         portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
573 \r
574                         /* Exit with interrpts enabled. */\r
575                         __enable_interrupt();\r
576                 }\r
577         }\r
578 \r
579 #endif /* configUSE_TICKLESS_IDLE */\r
580 /*-----------------------------------------------------------*/\r
581 \r
582 /*\r
583  * Setup the systick timer to generate the tick interrupts at the required\r
584  * frequency.\r
585  */\r
586 __weak void vPortSetupTimerInterrupt( void )\r
587 {\r
588         /* Calculate the constants required to configure the tick interrupt. */\r
589         #if( configUSE_TICKLESS_IDLE == 1 )\r
590         {\r
591                 ulTimerCountsForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );\r
592                 xMaximumPossibleSuppressedTicks = portMAX_24_BIT_NUMBER / ulTimerCountsForOneTick;\r
593                 ulStoppedTimerCompensation = portMISSED_COUNTS_FACTOR / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
594         }\r
595         #endif /* configUSE_TICKLESS_IDLE */\r
596 \r
597         /* Stop and clear the SysTick. */\r
598         portNVIC_SYSTICK_CTRL_REG = 0UL;\r
599         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
600 \r
601         /* Configure SysTick to interrupt at the requested rate. */\r
602         portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
603         portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT );\r
604 }\r
605 /*-----------------------------------------------------------*/\r
606 \r
607 #if( configASSERT_DEFINED == 1 )\r
608 \r
609         void vPortValidateInterruptPriority( void )\r
610         {\r
611         uint32_t ulCurrentInterrupt;\r
612         uint8_t ucCurrentPriority;\r
613 \r
614                 /* Obtain the number of the currently executing interrupt. */\r
615                 __asm volatile( "mrs %0, ipsr" : "=r"( ulCurrentInterrupt ) :: "memory" );\r
616 \r
617                 /* Is the interrupt number a user defined interrupt? */\r
618                 if( ulCurrentInterrupt >= portFIRST_USER_INTERRUPT_NUMBER )\r
619                 {\r
620                         /* Look up the interrupt's priority. */\r
621                         ucCurrentPriority = pcInterruptPriorityRegisters[ ulCurrentInterrupt ];\r
622 \r
623                         /* The following assertion will fail if a service routine (ISR) for\r
624                         an interrupt that has been assigned a priority above\r
625                         configMAX_SYSCALL_INTERRUPT_PRIORITY calls an ISR safe FreeRTOS API\r
626                         function.  ISR safe FreeRTOS API functions must *only* be called\r
627                         from interrupts that have been assigned a priority at or below\r
628                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
629 \r
630                         Numerically low interrupt priority numbers represent logically high\r
631                         interrupt priorities, therefore the priority of the interrupt must\r
632                         be set to a value equal to or numerically *higher* than\r
633                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
634 \r
635                         Interrupts that use the FreeRTOS API must not be left at their\r
636                         default priority of     zero as that is the highest possible priority,\r
637                         which is guaranteed to be above configMAX_SYSCALL_INTERRUPT_PRIORITY,\r
638                         and     therefore also guaranteed to be invalid.\r
639 \r
640                         FreeRTOS maintains separate thread and ISR API functions to ensure\r
641                         interrupt entry is as fast and simple as possible.\r
642 \r
643                         The following links provide detailed information:\r
644                         http://www.freertos.org/RTOS-Cortex-M3-M4.html\r
645                         http://www.freertos.org/FAQHelp.html */\r
646                         configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );\r
647                 }\r
648 \r
649                 /* Priority grouping:  The interrupt controller (NVIC) allows the bits\r
650                 that define each interrupt's priority to be split between bits that\r
651                 define the interrupt's pre-emption priority bits and bits that define\r
652                 the interrupt's sub-priority.  For simplicity all bits must be defined\r
653                 to be pre-emption priority bits.  The following assertion will fail if\r
654                 this is not the case (if some bits represent a sub-priority).\r
655 \r
656                 If the application only uses CMSIS libraries for interrupt\r
657                 configuration then the correct setting can be achieved on all Cortex-M\r
658                 devices by calling NVIC_SetPriorityGrouping( 0 ); before starting the\r
659                 scheduler.  Note however that some vendor specific peripheral libraries\r
660                 assume a non-zero priority group setting, in which cases using a value\r
661                 of zero will result in unpredictable behaviour. */\r
662                 configASSERT( ( portAIRCR_REG & portPRIORITY_GROUP_MASK ) <= ulMaxPRIGROUPValue );\r
663         }\r
664 \r
665 #endif /* configASSERT_DEFINED */\r
666 \r
667 \r
668 \r
669 \r
670 \r
671 \r
672 \r
673 \r
674 \r
675 \r
676 \r
677 \r
678 \r
679 \r
680 \r
681 \r
682 \r
683 \r
684 \r
685 \r
686 \r