]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/CCS/ARM_CM4F/port.c
Update version number in preparation for maintenance release.
[freertos] / FreeRTOS / Source / portable / CCS / ARM_CM4F / 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 /* Scheduler includes. */\r
75 #include "FreeRTOS.h"\r
76 #include "task.h"\r
77 \r
78 #ifndef __TI_VFP_SUPPORT__\r
79         #error This port can only be used when the project options are configured to enable hardware floating point support.\r
80 #endif\r
81 \r
82 #if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0\r
83         #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.  See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html\r
84 #endif\r
85 \r
86 #ifndef configSYSTICK_CLOCK_HZ\r
87         #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ\r
88         /* Ensure the SysTick is clocked at the same frequency as the core. */\r
89         #define portNVIC_SYSTICK_CLK_BIT        ( 1UL << 2UL )\r
90 #else\r
91         /* The way the SysTick is clocked is not modified in case it is not the same\r
92         as the core. */\r
93         #define portNVIC_SYSTICK_CLK_BIT        ( 0 )\r
94 #endif\r
95 \r
96 /* Constants required to manipulate the core.  Registers first... */\r
97 #define portNVIC_SYSTICK_CTRL_REG                       ( * ( ( volatile uint32_t * ) 0xe000e010 ) )\r
98 #define portNVIC_SYSTICK_LOAD_REG                       ( * ( ( volatile uint32_t * ) 0xe000e014 ) )\r
99 #define portNVIC_SYSTICK_CURRENT_VALUE_REG      ( * ( ( volatile uint32_t * ) 0xe000e018 ) )\r
100 #define portNVIC_SYSPRI2_REG                            ( * ( ( volatile uint32_t * ) 0xe000ed20 ) )\r
101 /* ...then bits in the registers. */\r
102 #define portNVIC_SYSTICK_INT_BIT                        ( 1UL << 1UL )\r
103 #define portNVIC_SYSTICK_ENABLE_BIT                     ( 1UL << 0UL )\r
104 #define portNVIC_SYSTICK_COUNT_FLAG_BIT         ( 1UL << 16UL )\r
105 #define portNVIC_PENDSVCLEAR_BIT                        ( 1UL << 27UL )\r
106 #define portNVIC_PEND_SYSTICK_CLEAR_BIT         ( 1UL << 25UL )\r
107 \r
108 #define portNVIC_PENDSV_PRI                                     ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 16UL )\r
109 #define portNVIC_SYSTICK_PRI                            ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )\r
110 \r
111 /* Constants required to check the validity of an interrupt priority. */\r
112 #define portFIRST_USER_INTERRUPT_NUMBER         ( 16 )\r
113 #define portNVIC_IP_REGISTERS_OFFSET_16         ( 0xE000E3F0 )\r
114 #define portAIRCR_REG                                           ( * ( ( volatile uint32_t * ) 0xE000ED0C ) )\r
115 #define portMAX_8_BIT_VALUE                                     ( ( uint8_t ) 0xff )\r
116 #define portTOP_BIT_OF_BYTE                                     ( ( uint8_t ) 0x80 )\r
117 #define portMAX_PRIGROUP_BITS                           ( ( uint8_t ) 7 )\r
118 #define portPRIORITY_GROUP_MASK                         ( 0x07UL << 8UL )\r
119 #define portPRIGROUP_SHIFT                                      ( 8UL )\r
120 \r
121 /* Masks off all bits but the VECTACTIVE bits in the ICSR register. */\r
122 #define portVECTACTIVE_MASK                                     ( 0xFFUL )\r
123 \r
124 /* Constants required to manipulate the VFP. */\r
125 #define portFPCCR                                                       ( ( volatile uint32_t * ) 0xe000ef34 ) /* Floating point context control register. */\r
126 #define portASPEN_AND_LSPEN_BITS                        ( 0x3UL << 30UL )\r
127 \r
128 /* Constants required to set up the initial stack. */\r
129 #define portINITIAL_XPSR                                        ( 0x01000000 )\r
130 #define portINITIAL_EXEC_RETURN                         ( 0xfffffffd )\r
131 \r
132 /* The systick is a 24-bit counter. */\r
133 #define portMAX_24_BIT_NUMBER                           ( 0xffffffUL )\r
134 \r
135 /* A fiddle factor to estimate the number of SysTick counts that would have\r
136 occurred while the SysTick counter is stopped during tickless idle\r
137 calculations. */\r
138 #define portMISSED_COUNTS_FACTOR                        ( 45UL )\r
139 \r
140 /* For strict compliance with the Cortex-M spec the task start address should\r
141 have bit-0 clear, as it is loaded into the PC on exit from an ISR. */\r
142 #define portSTART_ADDRESS_MASK          ( ( StackType_t ) 0xfffffffeUL )\r
143 \r
144 /* Required to allow portasm.asm access the configMAX_SYSCALL_INTERRUPT_PRIORITY\r
145 setting. */\r
146 const uint32_t ulMaxSyscallInterruptPriority = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
147 \r
148 /* Each task maintains its own interrupt status in the critical nesting\r
149 variable. */\r
150 static UBaseType_t uxCriticalNesting = 0xaaaaaaaa;\r
151 \r
152 /*\r
153  * Setup the timer to generate the tick interrupts.  The implementation in this\r
154  * file is weak to allow application writers to change the timer used to\r
155  * generate the tick interrupt.\r
156  */\r
157 void vPortSetupTimerInterrupt( void );\r
158 \r
159 /*\r
160  * Exception handlers.\r
161  */\r
162 void xPortSysTickHandler( void );\r
163 \r
164 /*\r
165  * Start first task is a separate function so it can be tested in isolation.\r
166  */\r
167 extern void vPortStartFirstTask( void );\r
168 \r
169 /*\r
170  * Turn the VFP on.\r
171  */\r
172 extern void vPortEnableVFP( void );\r
173 \r
174 /*\r
175  * Used to catch tasks that attempt to return from their implementing function.\r
176  */\r
177 static void prvTaskExitError( void );\r
178 \r
179 /*-----------------------------------------------------------*/\r
180 \r
181 /*\r
182  * The number of SysTick increments that make up one tick period.\r
183  */\r
184 #if configUSE_TICKLESS_IDLE == 1\r
185         static uint32_t ulTimerCountsForOneTick = 0;\r
186 #endif /* configUSE_TICKLESS_IDLE */\r
187 \r
188 /*\r
189  * The maximum number of tick periods that can be suppressed is limited by the\r
190  * 24 bit resolution of the SysTick timer.\r
191  */\r
192 #if configUSE_TICKLESS_IDLE == 1\r
193         static uint32_t xMaximumPossibleSuppressedTicks = 0;\r
194 #endif /* configUSE_TICKLESS_IDLE */\r
195 \r
196 /*\r
197  * Compensate for the CPU cycles that pass while the SysTick is stopped (low\r
198  * power functionality only.\r
199  */\r
200 #if configUSE_TICKLESS_IDLE == 1\r
201         static uint32_t ulStoppedTimerCompensation = 0;\r
202 #endif /* configUSE_TICKLESS_IDLE */\r
203 \r
204 /*\r
205  * Used by the portASSERT_IF_INTERRUPT_PRIORITY_INVALID() macro to ensure\r
206  * FreeRTOS API functions are not called from interrupts that have been assigned\r
207  * a priority above configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
208  */\r
209 #if ( configASSERT_DEFINED == 1 )\r
210          static uint8_t ucMaxSysCallPriority = 0;\r
211          static uint32_t ulMaxPRIGROUPValue = 0;\r
212          static const volatile uint8_t * const pcInterruptPriorityRegisters = ( uint8_t * ) portNVIC_IP_REGISTERS_OFFSET_16;\r
213 #endif /* configASSERT_DEFINED */\r
214 \r
215 /*-----------------------------------------------------------*/\r
216 \r
217 /*\r
218  * See header file for description.\r
219  */\r
220 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )\r
221 {\r
222         /* Simulate the stack frame as it would be created by a context switch\r
223         interrupt. */\r
224 \r
225         /* Offset added to account for the way the MCU uses the stack on entry/exit\r
226         of interrupts, and to ensure alignment. */\r
227         pxTopOfStack--;\r
228 \r
229         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
230         pxTopOfStack--;\r
231         *pxTopOfStack = ( ( StackType_t ) pxCode ) & portSTART_ADDRESS_MASK;    /* PC */\r
232         pxTopOfStack--;\r
233         *pxTopOfStack = ( StackType_t ) prvTaskExitError;       /* LR */\r
234 \r
235         /* Save code space by skipping register initialisation. */\r
236         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
237         *pxTopOfStack = ( StackType_t ) pvParameters;   /* R0 */\r
238 \r
239         /* A save method is being used that requires each task to maintain its\r
240         own exec return value. */\r
241         pxTopOfStack--;\r
242         *pxTopOfStack = portINITIAL_EXEC_RETURN;\r
243 \r
244         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
245 \r
246         return pxTopOfStack;\r
247 }\r
248 /*-----------------------------------------------------------*/\r
249 \r
250 static void prvTaskExitError( void )\r
251 {\r
252         /* A function that implements a task must not exit or attempt to return to\r
253         its caller as there is nothing to return to.  If a task wants to exit it\r
254         should instead call vTaskDelete( NULL ).\r
255 \r
256         Artificially force an assert() to be triggered if configASSERT() is\r
257         defined, then stop here so application writers can catch the error. */\r
258         configASSERT( uxCriticalNesting == ~0UL );\r
259         portDISABLE_INTERRUPTS();\r
260         for( ;; );\r
261 }\r
262 /*-----------------------------------------------------------*/\r
263 \r
264 /*\r
265  * See header file for description.\r
266  */\r
267 BaseType_t xPortStartScheduler( void )\r
268 {\r
269         #if( configASSERT_DEFINED == 1 )\r
270         {\r
271                 volatile uint32_t ulOriginalPriority;\r
272                 volatile uint8_t * const pucFirstUserPriorityRegister = ( uint8_t * ) ( portNVIC_IP_REGISTERS_OFFSET_16 + portFIRST_USER_INTERRUPT_NUMBER );\r
273                 volatile uint8_t ucMaxPriorityValue;\r
274 \r
275                 /* Determine the maximum priority from which ISR safe FreeRTOS API\r
276                 functions can be called.  ISR safe functions are those that end in\r
277                 "FromISR".  FreeRTOS maintains separate thread and ISR API functions to\r
278                 ensure interrupt entry is as fast and simple as possible.\r
279 \r
280                 Save the interrupt priority value that is about to be clobbered. */\r
281                 ulOriginalPriority = *pucFirstUserPriorityRegister;\r
282 \r
283                 /* Determine the number of priority bits available.  First write to all\r
284                 possible bits. */\r
285                 *pucFirstUserPriorityRegister = portMAX_8_BIT_VALUE;\r
286 \r
287                 /* Read the value back to see how many bits stuck. */\r
288                 ucMaxPriorityValue = *pucFirstUserPriorityRegister;\r
289 \r
290                 /* Use the same mask on the maximum system call priority. */\r
291                 ucMaxSysCallPriority = configMAX_SYSCALL_INTERRUPT_PRIORITY & ucMaxPriorityValue;\r
292 \r
293                 /* Calculate the maximum acceptable priority group value for the number\r
294                 of bits read back. */\r
295                 ulMaxPRIGROUPValue = portMAX_PRIGROUP_BITS;\r
296                 while( ( ucMaxPriorityValue & portTOP_BIT_OF_BYTE ) == portTOP_BIT_OF_BYTE )\r
297                 {\r
298                         ulMaxPRIGROUPValue--;\r
299                         ucMaxPriorityValue <<= ( uint8_t ) 0x01;\r
300                 }\r
301 \r
302                 #ifdef __NVIC_PRIO_BITS\r
303                 {\r
304                         /* Check the CMSIS configuration that defines the number of\r
305                         priority bits matches the number of priority bits actually queried\r
306                         from the hardware. */\r
307                         configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == __NVIC_PRIO_BITS );\r
308                 }\r
309                 #endif\r
310                 \r
311                 #ifdef configPRIO_BITS\r
312                 {\r
313                         /* Check the FreeRTOS configuration that defines the number of\r
314                         priority bits matches the number of priority bits actually queried\r
315                         from the hardware. */\r
316                         configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == configPRIO_BITS );\r
317                 }\r
318                 #endif\r
319 \r
320                 /* Shift the priority group value back to its position within the AIRCR\r
321                 register. */\r
322                 ulMaxPRIGROUPValue <<= portPRIGROUP_SHIFT;\r
323                 ulMaxPRIGROUPValue &= portPRIORITY_GROUP_MASK;\r
324 \r
325                 /* Restore the clobbered interrupt priority register to its original\r
326                 value. */\r
327                 *pucFirstUserPriorityRegister = ulOriginalPriority;\r
328         }\r
329         #endif /* conifgASSERT_DEFINED */\r
330 \r
331         /* Make PendSV and SysTick the lowest priority interrupts. */\r
332         portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;\r
333         portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;\r
334 \r
335         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
336         here already. */\r
337         vPortSetupTimerInterrupt();\r
338 \r
339         /* Initialise the critical nesting count ready for the first task. */\r
340         uxCriticalNesting = 0;\r
341 \r
342         /* Ensure the VFP is enabled - it should be anyway. */\r
343         vPortEnableVFP();\r
344 \r
345         /* Lazy save always. */\r
346         *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;\r
347 \r
348         /* Start the first task. */\r
349         vPortStartFirstTask();\r
350 \r
351         /* Should not get here! */\r
352         return 0;\r
353 }\r
354 /*-----------------------------------------------------------*/\r
355 \r
356 void vPortEndScheduler( void )\r
357 {\r
358         /* Not implemented in ports where there is nothing to return to.\r
359         Artificially force an assert. */\r
360         configASSERT( uxCriticalNesting == 1000UL );\r
361 }\r
362 /*-----------------------------------------------------------*/\r
363 \r
364 void vPortEnterCritical( void )\r
365 {\r
366         portDISABLE_INTERRUPTS();\r
367         uxCriticalNesting++;\r
368 \r
369         /* This is not the interrupt safe version of the enter critical function so\r
370         assert() if it is being called from an interrupt context.  Only API\r
371         functions that end in "FromISR" can be used in an interrupt.  Only assert if\r
372         the critical nesting count is 1 to protect against recursive calls if the\r
373         assert function also uses a critical section. */\r
374         if( uxCriticalNesting == 1 )\r
375         {\r
376                 configASSERT( ( portNVIC_INT_CTRL_REG & portVECTACTIVE_MASK ) == 0 );\r
377         }\r
378 }\r
379 /*-----------------------------------------------------------*/\r
380 \r
381 void vPortExitCritical( void )\r
382 {\r
383         configASSERT( uxCriticalNesting );\r
384         uxCriticalNesting--;\r
385         if( uxCriticalNesting == 0 )\r
386         {\r
387                 portENABLE_INTERRUPTS();\r
388         }\r
389 }\r
390 /*-----------------------------------------------------------*/\r
391 \r
392 void xPortSysTickHandler( void )\r
393 {\r
394         /* The SysTick runs at the lowest interrupt priority, so when this interrupt\r
395         executes all interrupts must be unmasked.  There is therefore no need to\r
396         save and then restore the interrupt mask value as its value is already\r
397         known. */\r
398         ( void ) portSET_INTERRUPT_MASK_FROM_ISR();\r
399         {\r
400                 /* Increment the RTOS tick. */\r
401                 if( xTaskIncrementTick() != pdFALSE )\r
402                 {\r
403                         /* A context switch is required.  Context switching is performed in\r
404                         the PendSV interrupt.  Pend the PendSV interrupt. */\r
405                         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
406                 }\r
407         }\r
408         portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );\r
409 }\r
410 /*-----------------------------------------------------------*/\r
411 \r
412 #if configUSE_TICKLESS_IDLE == 1\r
413 \r
414         #pragma WEAK( vPortSuppressTicksAndSleep )\r
415         void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime )\r
416         {\r
417         uint32_t ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements, ulSysTickCTRL;\r
418         TickType_t xModifiableIdleTime;\r
419 \r
420                 /* Make sure the SysTick reload value does not overflow the counter. */\r
421                 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )\r
422                 {\r
423                         xExpectedIdleTime = xMaximumPossibleSuppressedTicks;\r
424                 }\r
425 \r
426                 /* Stop the SysTick momentarily.  The time the SysTick is stopped for\r
427                 is accounted for as best it can be, but using the tickless mode will\r
428                 inevitably result in some tiny drift of the time maintained by the\r
429                 kernel with respect to calendar time. */\r
430                 portNVIC_SYSTICK_CTRL_REG &= ~portNVIC_SYSTICK_ENABLE_BIT;\r
431 \r
432                 /* Calculate the reload value required to wait xExpectedIdleTime\r
433                 tick periods.  -1 is used because this code will execute part way\r
434                 through one of the tick periods. */\r
435                 ulReloadValue = portNVIC_SYSTICK_CURRENT_VALUE_REG + ( ulTimerCountsForOneTick * ( xExpectedIdleTime - 1UL ) );\r
436                 if( ulReloadValue > ulStoppedTimerCompensation )\r
437                 {\r
438                         ulReloadValue -= ulStoppedTimerCompensation;\r
439                 }\r
440 \r
441                 /* Enter a critical section but don't use the taskENTER_CRITICAL()\r
442                 method as that will mask interrupts that should exit sleep mode. */\r
443                 __asm( "        cpsid i" );\r
444                 __asm( "        dsb" );\r
445                 __asm( "        isb" );\r
446 \r
447 \r
448                 /* If a context switch is pending or a task is waiting for the scheduler\r
449                 to be unsuspended then abandon the low power entry. */\r
450                 if( eTaskConfirmSleepModeStatus() == eAbortSleep )\r
451                 {\r
452                         /* Restart from whatever is left in the count register to complete\r
453                         this tick period. */\r
454                         portNVIC_SYSTICK_LOAD_REG = portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
455 \r
456                         /* Restart SysTick. */\r
457                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
458 \r
459                         /* Reset the reload register to the value required for normal tick\r
460                         periods. */\r
461                         portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
462 \r
463                         /* Re-enable interrupts - see comments above __disable_interrupt()\r
464                         call above. */\r
465                         __asm( "        cpsie i" );\r
466                 }\r
467                 else\r
468                 {\r
469                         /* Set the new reload value. */\r
470                         portNVIC_SYSTICK_LOAD_REG = ulReloadValue;\r
471 \r
472                         /* Clear the SysTick count flag and set the count value back to\r
473                         zero. */\r
474                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
475 \r
476                         /* Restart SysTick. */\r
477                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
478 \r
479                         /* Sleep until something happens.  configPRE_SLEEP_PROCESSING() can\r
480                         set its parameter to 0 to indicate that its implementation contains\r
481                         its own wait for interrupt or wait for event instruction, and so wfi\r
482                         should not be executed again.  However, the original expected idle\r
483                         time variable must remain unmodified, so a copy is taken. */\r
484                         xModifiableIdleTime = xExpectedIdleTime;\r
485                         configPRE_SLEEP_PROCESSING( xModifiableIdleTime );\r
486                         if( xModifiableIdleTime > 0 )\r
487                         {\r
488                                 __asm( "        dsb" );\r
489                                 __asm( "        wfi" );\r
490                                 __asm( "        isb" );\r
491                         }\r
492                         configPOST_SLEEP_PROCESSING( xExpectedIdleTime );\r
493 \r
494                         /* Stop SysTick.  Again, the time the SysTick is stopped for is\r
495                         accounted for as best it can be, but using the tickless mode will\r
496                         inevitably result in some tiny drift of the time maintained by the\r
497                         kernel with respect to calendar time. */\r
498                         ulSysTickCTRL = portNVIC_SYSTICK_CTRL_REG;\r
499                         portNVIC_SYSTICK_CTRL_REG = ( ulSysTickCTRL & ~portNVIC_SYSTICK_ENABLE_BIT );\r
500 \r
501                         /* Re-enable interrupts - see comments above __disable_interrupt()\r
502                         call above. */\r
503                         __asm( "        cpsie i" );\r
504 \r
505                         if( ( ulSysTickCTRL & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
506                         {\r
507                                 uint32_t ulCalculatedLoadValue;\r
508 \r
509                                 /* The tick interrupt has already executed, and the SysTick\r
510                                 count reloaded with ulReloadValue.  Reset the\r
511                                 portNVIC_SYSTICK_LOAD_REG with whatever remains of this tick\r
512                                 period. */\r
513                                 ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL ) - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
514 \r
515                                 /* Don't allow a tiny value, or values that have somehow\r
516                                 underflowed because the post sleep hook did something\r
517                                 that took too long. */\r
518                                 if( ( ulCalculatedLoadValue < ulStoppedTimerCompensation ) || ( ulCalculatedLoadValue > ulTimerCountsForOneTick ) )\r
519                                 {\r
520                                         ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL );\r
521                                 }\r
522 \r
523                                 portNVIC_SYSTICK_LOAD_REG = ulCalculatedLoadValue;\r
524 \r
525                                 /* The tick interrupt handler will already have pended the tick\r
526                                 processing in the kernel.  As the pending tick will be\r
527                                 processed as soon as this function exits, the tick value\r
528                                 maintained by the tick is stepped forward by one less than the\r
529                                 time spent waiting. */\r
530                                 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
531                         }\r
532                         else\r
533                         {\r
534                                 /* Something other than the tick interrupt ended the sleep.\r
535                                 Work out how long the sleep lasted rounded to complete tick\r
536                                 periods (not the ulReload value which accounted for part\r
537                                 ticks). */\r
538                                 ulCompletedSysTickDecrements = ( xExpectedIdleTime * ulTimerCountsForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
539 \r
540                                 /* How many complete tick periods passed while the processor\r
541                                 was waiting? */\r
542                                 ulCompleteTickPeriods = ulCompletedSysTickDecrements / ulTimerCountsForOneTick;\r
543 \r
544                                 /* The reload value is set to whatever fraction of a single tick\r
545                                 period remains. */\r
546                                 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1UL ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;\r
547                         }\r
548 \r
549                         /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG\r
550                         again, then set portNVIC_SYSTICK_LOAD_REG back to its standard\r
551                         value.  The critical section is used to ensure the tick interrupt\r
552                         can only execute once in the case that the reload register is near\r
553                         zero. */\r
554                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
555                         portENTER_CRITICAL();\r
556                         {\r
557                                 portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
558                                 vTaskStepTick( ulCompleteTickPeriods );\r
559                                 portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
560                         }\r
561                         portEXIT_CRITICAL();\r
562                 }\r
563         }\r
564 \r
565 #endif /* #if configUSE_TICKLESS_IDLE */\r
566 /*-----------------------------------------------------------*/\r
567 \r
568 /*\r
569  * Setup the systick timer to generate the tick interrupts at the required\r
570  * frequency.\r
571  */\r
572 #pragma WEAK( vPortSetupTimerInterrupt )\r
573 void vPortSetupTimerInterrupt( void )\r
574 {\r
575         /* Calculate the constants required to configure the tick interrupt. */\r
576         #if configUSE_TICKLESS_IDLE == 1\r
577         {\r
578                 ulTimerCountsForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );\r
579                 xMaximumPossibleSuppressedTicks = portMAX_24_BIT_NUMBER / ulTimerCountsForOneTick;\r
580                 ulStoppedTimerCompensation = portMISSED_COUNTS_FACTOR / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
581         }\r
582         #endif /* configUSE_TICKLESS_IDLE */\r
583 \r
584         /* Stop and clear the SysTick. */\r
585         portNVIC_SYSTICK_CTRL_REG = 0UL;\r
586         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
587 \r
588         /* Configure SysTick to interrupt at the requested rate. */\r
589         portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
590         portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT );\r
591 }\r
592 /*-----------------------------------------------------------*/\r
593 \r
594 #if( configASSERT_DEFINED == 1 )\r
595 \r
596         void vPortValidateInterruptPriority( void )\r
597         {\r
598         extern uint32_t ulPortGetIPSR( void );\r
599         uint32_t ulCurrentInterrupt;\r
600         uint8_t ucCurrentPriority;\r
601 \r
602                 ulCurrentInterrupt = ulPortGetIPSR();\r
603 \r
604                 /* Is the interrupt number a user defined interrupt? */\r
605                 if( ulCurrentInterrupt >= portFIRST_USER_INTERRUPT_NUMBER )\r
606                 {\r
607                         /* Look up the interrupt's priority. */\r
608                         ucCurrentPriority = pcInterruptPriorityRegisters[ ulCurrentInterrupt ];\r
609 \r
610                         /* The following assertion will fail if a service routine (ISR) for\r
611                         an interrupt that has been assigned a priority above\r
612                         configMAX_SYSCALL_INTERRUPT_PRIORITY calls an ISR safe FreeRTOS API\r
613                         function.  ISR safe FreeRTOS API functions must *only* be called\r
614                         from interrupts that have been assigned a priority at or below\r
615                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
616 \r
617                         Numerically low interrupt priority numbers represent logically high\r
618                         interrupt priorities, therefore the priority of the interrupt must\r
619                         be set to a value equal to or numerically *higher* than\r
620                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
621 \r
622                         Interrupts that use the FreeRTOS API must not be left at their\r
623                         default priority of     zero as that is the highest possible priority,\r
624                         which is guaranteed to be above configMAX_SYSCALL_INTERRUPT_PRIORITY,\r
625                         and     therefore also guaranteed to be invalid.\r
626 \r
627                         FreeRTOS maintains separate thread and ISR API functions to ensure\r
628                         interrupt entry is as fast and simple as possible.\r
629 \r
630                         The following links provide detailed information:\r
631                         http://www.freertos.org/RTOS-Cortex-M3-M4.html\r
632                         http://www.freertos.org/FAQHelp.html */\r
633                         configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );\r
634                 }\r
635 \r
636                 /* Priority grouping:  The interrupt controller (NVIC) allows the bits\r
637                 that define each interrupt's priority to be split between bits that\r
638                 define the interrupt's pre-emption priority bits and bits that define\r
639                 the interrupt's sub-priority.  For simplicity all bits must be defined\r
640                 to be pre-emption priority bits.  The following assertion will fail if\r
641                 this is not the case (if some bits represent a sub-priority).\r
642 \r
643                 If the application only uses CMSIS libraries for interrupt\r
644                 configuration then the correct setting can be achieved on all Cortex-M\r
645                 devices by calling NVIC_SetPriorityGrouping( 0 ); before starting the\r
646                 scheduler.  Note however that some vendor specific peripheral libraries\r
647                 assume a non-zero priority group setting, in which cases using a value\r
648                 of zero will result in unpredicable behaviour. */\r
649                 configASSERT( ( portAIRCR_REG & portPRIORITY_GROUP_MASK ) <= ulMaxPRIGROUPValue );\r
650         }\r
651 \r
652 #endif /* configASSERT_DEFINED */\r
653 \r
654 \r
655 \r
656 \r
657 \r
658 \r
659 \r
660 \r
661 \r
662 \r
663 \r
664 \r
665 \r
666 \r
667 \r
668 \r
669 \r
670 \r
671 \r
672 \r
673 \r