]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/RVDS/ARM_CM7/r0p1/port.c
Update license information text files for the CLI, TCP and UDP products to be correct...
[freertos] / FreeRTOS / Source / portable / RVDS / ARM_CM7 / r0p1 / port.c
1 /*\r
2  * FreeRTOS Kernel V10.0.0\r
3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
4  *\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
11  *\r
12  * The above copyright notice and this permission notice shall be included in all\r
13  * copies or substantial portions of the Software. If you wish to use our Amazon\r
14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
15  *\r
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
22  *\r
23  * http://www.FreeRTOS.org\r
24  * http://aws.amazon.com/freertos\r
25  *\r
26  * 1 tab == 4 spaces!\r
27  */\r
28 \r
29 /*-----------------------------------------------------------\r
30  * Implementation of functions defined in portable.h for the ARM CM4F port.\r
31  *----------------------------------------------------------*/\r
32 \r
33 /* Scheduler includes. */\r
34 #include "FreeRTOS.h"\r
35 #include "task.h"\r
36 \r
37 #ifndef __TARGET_FPU_VFP\r
38         #error This port can only be used when the project options are configured to enable hardware floating point support.\r
39 #endif\r
40 \r
41 #if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0\r
42         #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.  See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html\r
43 #endif\r
44 \r
45 #ifndef configSYSTICK_CLOCK_HZ\r
46         #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ\r
47         /* Ensure the SysTick is clocked at the same frequency as the core. */\r
48         #define portNVIC_SYSTICK_CLK_BIT        ( 1UL << 2UL )\r
49 #else\r
50         /* The way the SysTick is clocked is not modified in case it is not the same\r
51         as the core. */\r
52         #define portNVIC_SYSTICK_CLK_BIT        ( 0 )\r
53 #endif\r
54 \r
55 /* The __weak attribute does not work as you might expect with the Keil tools\r
56 so the configOVERRIDE_DEFAULT_TICK_CONFIGURATION constant must be set to 1 if\r
57 the application writer wants to provide their own implementation of\r
58 vPortSetupTimerInterrupt().  Ensure configOVERRIDE_DEFAULT_TICK_CONFIGURATION\r
59 is defined. */\r
60 #ifndef configOVERRIDE_DEFAULT_TICK_CONFIGURATION\r
61         #define configOVERRIDE_DEFAULT_TICK_CONFIGURATION 0\r
62 #endif\r
63 \r
64 /* Constants required to manipulate the core.  Registers first... */\r
65 #define portNVIC_SYSTICK_CTRL_REG                       ( * ( ( volatile uint32_t * ) 0xe000e010 ) )\r
66 #define portNVIC_SYSTICK_LOAD_REG                       ( * ( ( volatile uint32_t * ) 0xe000e014 ) )\r
67 #define portNVIC_SYSTICK_CURRENT_VALUE_REG      ( * ( ( volatile uint32_t * ) 0xe000e018 ) )\r
68 #define portNVIC_SYSPRI2_REG                            ( * ( ( volatile uint32_t * ) 0xe000ed20 ) )\r
69 /* ...then bits in the registers. */\r
70 #define portNVIC_SYSTICK_INT_BIT                        ( 1UL << 1UL )\r
71 #define portNVIC_SYSTICK_ENABLE_BIT                     ( 1UL << 0UL )\r
72 #define portNVIC_SYSTICK_COUNT_FLAG_BIT         ( 1UL << 16UL )\r
73 #define portNVIC_PENDSVCLEAR_BIT                        ( 1UL << 27UL )\r
74 #define portNVIC_PEND_SYSTICK_CLEAR_BIT         ( 1UL << 25UL )\r
75 \r
76 #define portNVIC_PENDSV_PRI                                     ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 16UL )\r
77 #define portNVIC_SYSTICK_PRI                            ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )\r
78 \r
79 /* Constants required to check the validity of an interrupt priority. */\r
80 #define portFIRST_USER_INTERRUPT_NUMBER         ( 16 )\r
81 #define portNVIC_IP_REGISTERS_OFFSET_16         ( 0xE000E3F0 )\r
82 #define portAIRCR_REG                                           ( * ( ( volatile uint32_t * ) 0xE000ED0C ) )\r
83 #define portMAX_8_BIT_VALUE                                     ( ( uint8_t ) 0xff )\r
84 #define portTOP_BIT_OF_BYTE                                     ( ( uint8_t ) 0x80 )\r
85 #define portMAX_PRIGROUP_BITS                           ( ( uint8_t ) 7 )\r
86 #define portPRIORITY_GROUP_MASK                         ( 0x07UL << 8UL )\r
87 #define portPRIGROUP_SHIFT                                      ( 8UL )\r
88 \r
89 /* Masks off all bits but the VECTACTIVE bits in the ICSR register. */\r
90 #define portVECTACTIVE_MASK                                     ( 0xFFUL )\r
91 \r
92 /* Constants required to manipulate the VFP. */\r
93 #define portFPCCR                                       ( ( volatile uint32_t * ) 0xe000ef34 ) /* Floating point context control register. */\r
94 #define portASPEN_AND_LSPEN_BITS        ( 0x3UL << 30UL )\r
95 \r
96 /* Constants required to set up the initial stack. */\r
97 #define portINITIAL_XPSR                        ( 0x01000000 )\r
98 #define portINITIAL_EXC_RETURN          ( 0xfffffffd )\r
99 \r
100 /* The systick is a 24-bit counter. */\r
101 #define portMAX_24_BIT_NUMBER           ( 0xffffffUL )\r
102 \r
103 /* A fiddle factor to estimate the number of SysTick counts that would have\r
104 occurred while the SysTick counter is stopped during tickless idle\r
105 calculations. */\r
106 #define portMISSED_COUNTS_FACTOR        ( 45UL )\r
107 \r
108 /* For strict compliance with the Cortex-M spec the task start address should\r
109 have bit-0 clear, as it is loaded into the PC on exit from an ISR. */\r
110 #define portSTART_ADDRESS_MASK          ( ( StackType_t ) 0xfffffffeUL )\r
111 \r
112 /*\r
113  * Setup the timer to generate the tick interrupts.  The implementation in this\r
114  * file is weak to allow application writers to change the timer used to\r
115  * generate the tick interrupt.\r
116  */\r
117 void vPortSetupTimerInterrupt( void );\r
118 \r
119 /*\r
120  * Exception handlers.\r
121  */\r
122 void xPortPendSVHandler( void );\r
123 void xPortSysTickHandler( void );\r
124 void vPortSVCHandler( void );\r
125 \r
126 /*\r
127  * Start first task is a separate function so it can be tested in isolation.\r
128  */\r
129 static void prvStartFirstTask( void );\r
130 \r
131 /*\r
132  * Functions defined in portasm.s to enable the VFP.\r
133  */\r
134 static void prvEnableVFP( void );\r
135 \r
136 /*\r
137  * Used to catch tasks that attempt to return from their implementing function.\r
138  */\r
139 static void prvTaskExitError( void );\r
140 \r
141 /*-----------------------------------------------------------*/\r
142 \r
143 /* Each task maintains its own interrupt status in the critical nesting\r
144 variable. */\r
145 static UBaseType_t uxCriticalNesting = 0xaaaaaaaa;\r
146 \r
147 /*\r
148  * The number of SysTick increments that make up one tick period.\r
149  */\r
150 #if( configUSE_TICKLESS_IDLE == 1 )\r
151         static uint32_t ulTimerCountsForOneTick = 0;\r
152 #endif /* configUSE_TICKLESS_IDLE */\r
153 \r
154 /*\r
155  * The maximum number of tick periods that can be suppressed is limited by the\r
156  * 24 bit resolution of the SysTick timer.\r
157  */\r
158 #if( configUSE_TICKLESS_IDLE == 1 )\r
159         static uint32_t xMaximumPossibleSuppressedTicks = 0;\r
160 #endif /* configUSE_TICKLESS_IDLE */\r
161 \r
162 /*\r
163  * Compensate for the CPU cycles that pass while the SysTick is stopped (low\r
164  * power functionality only.\r
165  */\r
166 #if( configUSE_TICKLESS_IDLE == 1 )\r
167         static uint32_t ulStoppedTimerCompensation = 0;\r
168 #endif /* configUSE_TICKLESS_IDLE */\r
169 \r
170 /*\r
171  * Used by the portASSERT_IF_INTERRUPT_PRIORITY_INVALID() macro to ensure\r
172  * FreeRTOS API functions are not called from interrupts that have been assigned\r
173  * a priority above configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
174  */\r
175 #if ( configASSERT_DEFINED == 1 )\r
176          static uint8_t ucMaxSysCallPriority = 0;\r
177          static uint32_t ulMaxPRIGROUPValue = 0;\r
178          static const volatile uint8_t * const pcInterruptPriorityRegisters = ( uint8_t * ) portNVIC_IP_REGISTERS_OFFSET_16;\r
179 #endif /* configASSERT_DEFINED */\r
180 \r
181 /*-----------------------------------------------------------*/\r
182 \r
183 /*\r
184  * See header file for description.\r
185  */\r
186 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )\r
187 {\r
188         /* Simulate the stack frame as it would be created by a context switch\r
189         interrupt. */\r
190 \r
191         /* Offset added to account for the way the MCU uses the stack on entry/exit\r
192         of interrupts, and to ensure alignment. */\r
193         pxTopOfStack--;\r
194 \r
195         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
196         pxTopOfStack--;\r
197         *pxTopOfStack = ( ( StackType_t ) pxCode ) & portSTART_ADDRESS_MASK;    /* PC */\r
198         pxTopOfStack--;\r
199         *pxTopOfStack = ( StackType_t ) prvTaskExitError;       /* LR */\r
200 \r
201         /* Save code space by skipping register initialisation. */\r
202         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
203         *pxTopOfStack = ( StackType_t ) pvParameters;   /* R0 */\r
204 \r
205         /* A save method is being used that requires each task to maintain its\r
206         own exec return value. */\r
207         pxTopOfStack--;\r
208         *pxTopOfStack = portINITIAL_EXC_RETURN;\r
209 \r
210         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
211 \r
212         return pxTopOfStack;\r
213 }\r
214 /*-----------------------------------------------------------*/\r
215 \r
216 static void prvTaskExitError( void )\r
217 {\r
218         /* A function that implements a task must not exit or attempt to return to\r
219         its caller as there is nothing to return to.  If a task wants to exit it\r
220         should instead call vTaskDelete( NULL ).\r
221 \r
222         Artificially force an assert() to be triggered if configASSERT() is\r
223         defined, then stop here so application writers can catch the error. */\r
224         configASSERT( uxCriticalNesting == ~0UL );\r
225         portDISABLE_INTERRUPTS();\r
226         for( ;; );\r
227 }\r
228 /*-----------------------------------------------------------*/\r
229 \r
230 __asm void vPortSVCHandler( void )\r
231 {\r
232         PRESERVE8\r
233 \r
234         /* Get the location of the current TCB. */\r
235         ldr     r3, =pxCurrentTCB\r
236         ldr r1, [r3]\r
237         ldr r0, [r1]\r
238         /* Pop the core registers. */\r
239         ldmia r0!, {r4-r11, r14}\r
240         msr psp, r0\r
241         isb\r
242         mov r0, #0\r
243         msr     basepri, r0\r
244         bx r14\r
245 }\r
246 /*-----------------------------------------------------------*/\r
247 \r
248 __asm void prvStartFirstTask( void )\r
249 {\r
250         PRESERVE8\r
251 \r
252         /* Use the NVIC offset register to locate the stack. */\r
253         ldr r0, =0xE000ED08\r
254         ldr r0, [r0]\r
255         ldr r0, [r0]\r
256         /* Set the msp back to the start of the stack. */\r
257         msr msp, r0\r
258         /* Clear the bit that indicates the FPU is in use in case the FPU was used\r
259         before the scheduler was started - which would otherwise result in the\r
260         unnecessary leaving of space in the SVC stack for lazy saving of FPU\r
261         registers. */\r
262         mov r0, #0\r
263         msr control, r0\r
264         /* Globally enable interrupts. */\r
265         cpsie i\r
266         cpsie f\r
267         dsb\r
268         isb\r
269         /* Call SVC to start the first task. */\r
270         svc 0\r
271         nop\r
272         nop\r
273 }\r
274 /*-----------------------------------------------------------*/\r
275 \r
276 __asm void prvEnableVFP( void )\r
277 {\r
278         PRESERVE8\r
279 \r
280         /* The FPU enable bits are in the CPACR. */\r
281         ldr.w r0, =0xE000ED88\r
282         ldr     r1, [r0]\r
283 \r
284         /* Enable CP10 and CP11 coprocessors, then save back. */\r
285         orr     r1, r1, #( 0xf << 20 )\r
286         str r1, [r0]\r
287         bx      r14\r
288         nop\r
289 }\r
290 /*-----------------------------------------------------------*/\r
291 \r
292 /*\r
293  * See header file for description.\r
294  */\r
295 BaseType_t xPortStartScheduler( void )\r
296 {\r
297         #if( configASSERT_DEFINED == 1 )\r
298         {\r
299                 volatile uint32_t ulOriginalPriority;\r
300                 volatile uint8_t * const pucFirstUserPriorityRegister = ( uint8_t * ) ( portNVIC_IP_REGISTERS_OFFSET_16 + portFIRST_USER_INTERRUPT_NUMBER );\r
301                 volatile uint8_t ucMaxPriorityValue;\r
302 \r
303                 /* Determine the maximum priority from which ISR safe FreeRTOS API\r
304                 functions can be called.  ISR safe functions are those that end in\r
305                 "FromISR".  FreeRTOS maintains separate thread and ISR API functions to\r
306                 ensure interrupt entry is as fast and simple as possible.\r
307 \r
308                 Save the interrupt priority value that is about to be clobbered. */\r
309                 ulOriginalPriority = *pucFirstUserPriorityRegister;\r
310 \r
311                 /* Determine the number of priority bits available.  First write to all\r
312                 possible bits. */\r
313                 *pucFirstUserPriorityRegister = portMAX_8_BIT_VALUE;\r
314 \r
315                 /* Read the value back to see how many bits stuck. */\r
316                 ucMaxPriorityValue = *pucFirstUserPriorityRegister;\r
317 \r
318                 /* The kernel interrupt priority should be set to the lowest\r
319                 priority. */\r
320                 configASSERT( ucMaxPriorityValue == ( configKERNEL_INTERRUPT_PRIORITY & ucMaxPriorityValue ) );\r
321 \r
322                 /* Use the same mask on the maximum system call priority. */\r
323                 ucMaxSysCallPriority = configMAX_SYSCALL_INTERRUPT_PRIORITY & ucMaxPriorityValue;\r
324 \r
325                 /* Calculate the maximum acceptable priority group value for the number\r
326                 of bits read back. */\r
327                 ulMaxPRIGROUPValue = portMAX_PRIGROUP_BITS;\r
328                 while( ( ucMaxPriorityValue & portTOP_BIT_OF_BYTE ) == portTOP_BIT_OF_BYTE )\r
329                 {\r
330                         ulMaxPRIGROUPValue--;\r
331                         ucMaxPriorityValue <<= ( uint8_t ) 0x01;\r
332                 }\r
333 \r
334                 #ifdef __NVIC_PRIO_BITS\r
335                 {\r
336                         /* Check the CMSIS configuration that defines the number of\r
337                         priority bits matches the number of priority bits actually queried\r
338                         from the hardware. */\r
339                         configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == __NVIC_PRIO_BITS );\r
340                 }\r
341                 #endif\r
342 \r
343                 #ifdef configPRIO_BITS\r
344                 {\r
345                         /* Check the FreeRTOS configuration that defines the number of\r
346                         priority bits matches the number of priority bits actually queried\r
347                         from the hardware. */\r
348                         configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == configPRIO_BITS );\r
349                 }\r
350                 #endif\r
351 \r
352                 /* Shift the priority group value back to its position within the AIRCR\r
353                 register. */\r
354                 ulMaxPRIGROUPValue <<= portPRIGROUP_SHIFT;\r
355                 ulMaxPRIGROUPValue &= portPRIORITY_GROUP_MASK;\r
356 \r
357                 /* Restore the clobbered interrupt priority register to its original\r
358                 value. */\r
359                 *pucFirstUserPriorityRegister = ulOriginalPriority;\r
360         }\r
361         #endif /* conifgASSERT_DEFINED */\r
362 \r
363         /* Make PendSV and SysTick the lowest priority interrupts. */\r
364         portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;\r
365         portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;\r
366 \r
367         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
368         here already. */\r
369         vPortSetupTimerInterrupt();\r
370 \r
371         /* Initialise the critical nesting count ready for the first task. */\r
372         uxCriticalNesting = 0;\r
373 \r
374         /* Ensure the VFP is enabled - it should be anyway. */\r
375         prvEnableVFP();\r
376 \r
377         /* Lazy save always. */\r
378         *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;\r
379 \r
380         /* Start the first task. */\r
381         prvStartFirstTask();\r
382 \r
383         /* Should not get here! */\r
384         return 0;\r
385 }\r
386 /*-----------------------------------------------------------*/\r
387 \r
388 void vPortEndScheduler( void )\r
389 {\r
390         /* Not implemented in ports where there is nothing to return to.\r
391         Artificially force an assert. */\r
392         configASSERT( uxCriticalNesting == 1000UL );\r
393 }\r
394 /*-----------------------------------------------------------*/\r
395 \r
396 void vPortEnterCritical( void )\r
397 {\r
398         portDISABLE_INTERRUPTS();\r
399         uxCriticalNesting++;\r
400 \r
401         /* This is not the interrupt safe version of the enter critical function so\r
402         assert() if it is being called from an interrupt context.  Only API\r
403         functions that end in "FromISR" can be used in an interrupt.  Only assert if\r
404         the critical nesting count is 1 to protect against recursive calls if the\r
405         assert function also uses a critical section. */\r
406         if( uxCriticalNesting == 1 )\r
407         {\r
408                 configASSERT( ( portNVIC_INT_CTRL_REG & portVECTACTIVE_MASK ) == 0 );\r
409         }\r
410 }\r
411 /*-----------------------------------------------------------*/\r
412 \r
413 void vPortExitCritical( void )\r
414 {\r
415         configASSERT( uxCriticalNesting );\r
416         uxCriticalNesting--;\r
417         if( uxCriticalNesting == 0 )\r
418         {\r
419                 portENABLE_INTERRUPTS();\r
420         }\r
421 }\r
422 /*-----------------------------------------------------------*/\r
423 \r
424 __asm void xPortPendSVHandler( void )\r
425 {\r
426         extern uxCriticalNesting;\r
427         extern pxCurrentTCB;\r
428         extern vTaskSwitchContext;\r
429 \r
430         PRESERVE8\r
431 \r
432         mrs r0, psp\r
433         isb\r
434         /* Get the location of the current TCB. */\r
435         ldr     r3, =pxCurrentTCB\r
436         ldr     r2, [r3]\r
437 \r
438         /* Is the task using the FPU context?  If so, push high vfp registers. */\r
439         tst r14, #0x10\r
440         it eq\r
441         vstmdbeq r0!, {s16-s31}\r
442 \r
443         /* Save the core registers. */\r
444         stmdb r0!, {r4-r11, r14}\r
445 \r
446         /* Save the new top of stack into the first member of the TCB. */\r
447         str r0, [r2]\r
448 \r
449         stmdb sp!, {r0, r3}\r
450         mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY\r
451         cpsid i\r
452         msr basepri, r0\r
453         dsb\r
454         isb\r
455         cpsie i\r
456         bl vTaskSwitchContext\r
457         mov r0, #0\r
458         msr basepri, r0\r
459         ldmia sp!, {r0, r3}\r
460 \r
461         /* The first item in pxCurrentTCB is the task top of stack. */\r
462         ldr r1, [r3]\r
463         ldr r0, [r1]\r
464 \r
465         /* Pop the core registers. */\r
466         ldmia r0!, {r4-r11, r14}\r
467 \r
468         /* Is the task using the FPU context?  If so, pop the high vfp registers\r
469         too. */\r
470         tst r14, #0x10\r
471         it eq\r
472         vldmiaeq r0!, {s16-s31}\r
473 \r
474         msr psp, r0\r
475         isb\r
476         #ifdef WORKAROUND_PMU_CM001 /* XMC4000 specific errata */\r
477                 #if WORKAROUND_PMU_CM001 == 1\r
478                         push { r14 }\r
479                         pop { pc }\r
480                         nop\r
481                 #endif\r
482         #endif\r
483 \r
484         bx r14\r
485 }\r
486 /*-----------------------------------------------------------*/\r
487 \r
488 void xPortSysTickHandler( void )\r
489 {\r
490         /* The SysTick runs at the lowest interrupt priority, so when this interrupt\r
491         executes all interrupts must be unmasked.  There is therefore no need to\r
492         save and then restore the interrupt mask value as its value is already\r
493         known - therefore the slightly faster vPortRaiseBASEPRI() function is used\r
494         in place of portSET_INTERRUPT_MASK_FROM_ISR(). */\r
495         vPortRaiseBASEPRI();\r
496         {\r
497                 /* Increment the RTOS tick. */\r
498                 if( xTaskIncrementTick() != pdFALSE )\r
499                 {\r
500                         /* A context switch is required.  Context switching is performed in\r
501                         the PendSV interrupt.  Pend the PendSV interrupt. */\r
502                         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
503                 }\r
504         }\r
505         vPortClearBASEPRIFromISR();\r
506 }\r
507 /*-----------------------------------------------------------*/\r
508 \r
509 #if( configUSE_TICKLESS_IDLE == 1 )\r
510 \r
511         __weak void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime )\r
512         {\r
513         uint32_t ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements;\r
514         TickType_t xModifiableIdleTime;\r
515 \r
516                 /* Make sure the SysTick reload value does not overflow the counter. */\r
517                 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )\r
518                 {\r
519                         xExpectedIdleTime = xMaximumPossibleSuppressedTicks;\r
520                 }\r
521 \r
522                 /* Stop the SysTick momentarily.  The time the SysTick is stopped for\r
523                 is accounted for as best it can be, but using the tickless mode will\r
524                 inevitably result in some tiny drift of the time maintained by the\r
525                 kernel with respect to calendar time. */\r
526                 portNVIC_SYSTICK_CTRL_REG &= ~portNVIC_SYSTICK_ENABLE_BIT;\r
527 \r
528                 /* Calculate the reload value required to wait xExpectedIdleTime\r
529                 tick periods.  -1 is used because this code will execute part way\r
530                 through one of the tick periods. */\r
531                 ulReloadValue = portNVIC_SYSTICK_CURRENT_VALUE_REG + ( ulTimerCountsForOneTick * ( xExpectedIdleTime - 1UL ) );\r
532                 if( ulReloadValue > ulStoppedTimerCompensation )\r
533                 {\r
534                         ulReloadValue -= ulStoppedTimerCompensation;\r
535                 }\r
536 \r
537                 /* Enter a critical section but don't use the taskENTER_CRITICAL()\r
538                 method as that will mask interrupts that should exit sleep mode. */\r
539                 __disable_irq();\r
540                 __dsb( portSY_FULL_READ_WRITE );\r
541                 __isb( portSY_FULL_READ_WRITE );\r
542 \r
543                 /* If a context switch is pending or a task is waiting for the scheduler\r
544                 to be unsuspended then abandon the low power entry. */\r
545                 if( eTaskConfirmSleepModeStatus() == eAbortSleep )\r
546                 {\r
547                         /* Restart from whatever is left in the count register to complete\r
548                         this tick period. */\r
549                         portNVIC_SYSTICK_LOAD_REG = portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
550 \r
551                         /* Restart SysTick. */\r
552                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
553 \r
554                         /* Reset the reload register to the value required for normal tick\r
555                         periods. */\r
556                         portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
557 \r
558                         /* Re-enable interrupts - see comments above __disable_irq() call\r
559                         above. */\r
560                         __enable_irq();\r
561                 }\r
562                 else\r
563                 {\r
564                         /* Set the new reload value. */\r
565                         portNVIC_SYSTICK_LOAD_REG = ulReloadValue;\r
566 \r
567                         /* Clear the SysTick count flag and set the count value back to\r
568                         zero. */\r
569                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
570 \r
571                         /* Restart SysTick. */\r
572                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
573 \r
574                         /* Sleep until something happens.  configPRE_SLEEP_PROCESSING() can\r
575                         set its parameter to 0 to indicate that its implementation contains\r
576                         its own wait for interrupt or wait for event instruction, and so wfi\r
577                         should not be executed again.  However, the original expected idle\r
578                         time variable must remain unmodified, so a copy is taken. */\r
579                         xModifiableIdleTime = xExpectedIdleTime;\r
580                         configPRE_SLEEP_PROCESSING( xModifiableIdleTime );\r
581                         if( xModifiableIdleTime > 0 )\r
582                         {\r
583                                 __dsb( portSY_FULL_READ_WRITE );\r
584                                 __wfi();\r
585                                 __isb( portSY_FULL_READ_WRITE );\r
586                         }\r
587                         configPOST_SLEEP_PROCESSING( xExpectedIdleTime );\r
588 \r
589                         /* Re-enable interrupts to allow the interrupt that brought the MCU\r
590                         out of sleep mode to execute immediately.  see comments above\r
591                         __disable_interrupt() call above. */\r
592                         __enable_irq();\r
593                         __dsb( portSY_FULL_READ_WRITE );\r
594                         __isb( portSY_FULL_READ_WRITE );\r
595 \r
596                         /* Disable interrupts again because the clock is about to be stopped\r
597                         and interrupts that execute while the clock is stopped will increase\r
598                         any slippage between the time maintained by the RTOS and calendar\r
599                         time. */\r
600                         __disable_irq();\r
601                         __dsb( portSY_FULL_READ_WRITE );\r
602                         __isb( portSY_FULL_READ_WRITE );\r
603 \r
604                         /* Disable the SysTick clock without reading the\r
605                         portNVIC_SYSTICK_CTRL_REG register to ensure the\r
606                         portNVIC_SYSTICK_COUNT_FLAG_BIT is not cleared if it is set.  Again,\r
607                         the time the SysTick is stopped for is accounted for as best it can\r
608                         be, but using the tickless mode will inevitably result in some tiny\r
609                         drift of the time maintained by the kernel with respect to calendar\r
610                         time*/\r
611                         portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT );\r
612 \r
613                         /* Determine if the SysTick clock has already counted to zero and\r
614                         been set back to the current reload value (the reload back being\r
615                         correct for the entire expected idle time) or if the SysTick is yet\r
616                         to count to zero (in which case an interrupt other than the SysTick\r
617                         must have brought the system out of sleep mode). */\r
618                         if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
619                         {\r
620                                 uint32_t ulCalculatedLoadValue;\r
621 \r
622                                 /* The tick interrupt is already pending, and the SysTick count\r
623                                 reloaded with ulReloadValue.  Reset the\r
624                                 portNVIC_SYSTICK_LOAD_REG with whatever remains of this tick\r
625                                 period. */\r
626                                 ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL ) - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
627 \r
628                                 /* Don't allow a tiny value, or values that have somehow\r
629                                 underflowed because the post sleep hook did something\r
630                                 that took too long. */\r
631                                 if( ( ulCalculatedLoadValue < ulStoppedTimerCompensation ) || ( ulCalculatedLoadValue > ulTimerCountsForOneTick ) )\r
632                                 {\r
633                                         ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL );\r
634                                 }\r
635 \r
636                                 portNVIC_SYSTICK_LOAD_REG = ulCalculatedLoadValue;\r
637 \r
638                                 /* As the pending tick will be processed as soon as this\r
639                                 function exits, the tick value maintained by the tick is stepped\r
640                                 forward by one less than the time spent waiting. */\r
641                                 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
642                         }\r
643                         else\r
644                         {\r
645                                 /* Something other than the tick interrupt ended the sleep.\r
646                                 Work out how long the sleep lasted rounded to complete tick\r
647                                 periods (not the ulReload value which accounted for part\r
648                                 ticks). */\r
649                                 ulCompletedSysTickDecrements = ( xExpectedIdleTime * ulTimerCountsForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
650 \r
651                                 /* How many complete tick periods passed while the processor\r
652                                 was waiting? */\r
653                                 ulCompleteTickPeriods = ulCompletedSysTickDecrements / ulTimerCountsForOneTick;\r
654 \r
655                                 /* The reload value is set to whatever fraction of a single tick\r
656                                 period remains. */\r
657                                 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1UL ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;\r
658                         }\r
659 \r
660                         /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG\r
661                         again, then set portNVIC_SYSTICK_LOAD_REG back to its standard\r
662                         value. */\r
663                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
664                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
665                         vTaskStepTick( ulCompleteTickPeriods );\r
666                         portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
667 \r
668                         /* Exit with interrpts enabled. */\r
669                         __enable_irq();\r
670                 }\r
671         }\r
672 \r
673 #endif /* #if configUSE_TICKLESS_IDLE */\r
674 \r
675 /*-----------------------------------------------------------*/\r
676 \r
677 /*\r
678  * Setup the SysTick timer to generate the tick interrupts at the required\r
679  * frequency.\r
680  */\r
681 #if( configOVERRIDE_DEFAULT_TICK_CONFIGURATION == 0 )\r
682 \r
683         void vPortSetupTimerInterrupt( void )\r
684         {\r
685                 /* Calculate the constants required to configure the tick interrupt. */\r
686                 #if( configUSE_TICKLESS_IDLE == 1 )\r
687                 {\r
688                         ulTimerCountsForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );\r
689                         xMaximumPossibleSuppressedTicks = portMAX_24_BIT_NUMBER / ulTimerCountsForOneTick;\r
690                         ulStoppedTimerCompensation = portMISSED_COUNTS_FACTOR / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
691                 }\r
692                 #endif /* configUSE_TICKLESS_IDLE */\r
693 \r
694                 /* Stop and clear the SysTick. */\r
695                 portNVIC_SYSTICK_CTRL_REG = 0UL;\r
696                 portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
697 \r
698                 /* Configure SysTick to interrupt at the requested rate. */\r
699                 portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
700                 portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT );\r
701         }\r
702 \r
703 #endif /* configOVERRIDE_DEFAULT_TICK_CONFIGURATION */\r
704 /*-----------------------------------------------------------*/\r
705 \r
706 __asm uint32_t vPortGetIPSR( void )\r
707 {\r
708         PRESERVE8\r
709 \r
710         mrs r0, ipsr\r
711         bx r14\r
712 }\r
713 /*-----------------------------------------------------------*/\r
714 \r
715 #if( configASSERT_DEFINED == 1 )\r
716 \r
717         void vPortValidateInterruptPriority( void )\r
718         {\r
719         uint32_t ulCurrentInterrupt;\r
720         uint8_t ucCurrentPriority;\r
721 \r
722                 /* Obtain the number of the currently executing interrupt. */\r
723                 ulCurrentInterrupt = vPortGetIPSR();\r
724 \r
725                 /* Is the interrupt number a user defined interrupt? */\r
726                 if( ulCurrentInterrupt >= portFIRST_USER_INTERRUPT_NUMBER )\r
727                 {\r
728                         /* Look up the interrupt's priority. */\r
729                         ucCurrentPriority = pcInterruptPriorityRegisters[ ulCurrentInterrupt ];\r
730 \r
731                         /* The following assertion will fail if a service routine (ISR) for\r
732                         an interrupt that has been assigned a priority above\r
733                         configMAX_SYSCALL_INTERRUPT_PRIORITY calls an ISR safe FreeRTOS API\r
734                         function.  ISR safe FreeRTOS API functions must *only* be called\r
735                         from interrupts that have been assigned a priority at or below\r
736                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
737 \r
738                         Numerically low interrupt priority numbers represent logically high\r
739                         interrupt priorities, therefore the priority of the interrupt must\r
740                         be set to a value equal to or numerically *higher* than\r
741                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
742 \r
743                         Interrupts that use the FreeRTOS API must not be left at their\r
744                         default priority of     zero as that is the highest possible priority,\r
745                         which is guaranteed to be above configMAX_SYSCALL_INTERRUPT_PRIORITY,\r
746                         and     therefore also guaranteed to be invalid.\r
747 \r
748                         FreeRTOS maintains separate thread and ISR API functions to ensure\r
749                         interrupt entry is as fast and simple as possible.\r
750 \r
751                         The following links provide detailed information:\r
752                         http://www.freertos.org/RTOS-Cortex-M3-M4.html\r
753                         http://www.freertos.org/FAQHelp.html */\r
754                         configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );\r
755                 }\r
756 \r
757                 /* Priority grouping:  The interrupt controller (NVIC) allows the bits\r
758                 that define each interrupt's priority to be split between bits that\r
759                 define the interrupt's pre-emption priority bits and bits that define\r
760                 the interrupt's sub-priority.  For simplicity all bits must be defined\r
761                 to be pre-emption priority bits.  The following assertion will fail if\r
762                 this is not the case (if some bits represent a sub-priority).\r
763 \r
764                 If the application only uses CMSIS libraries for interrupt\r
765                 configuration then the correct setting can be achieved on all Cortex-M\r
766                 devices by calling NVIC_SetPriorityGrouping( 0 ); before starting the\r
767                 scheduler.  Note however that some vendor specific peripheral libraries\r
768                 assume a non-zero priority group setting, in which cases using a value\r
769                 of zero will result in unpredictable behaviour. */\r
770                 configASSERT( ( portAIRCR_REG & portPRIORITY_GROUP_MASK ) <= ulMaxPRIGROUPValue );\r
771         }\r
772 \r
773 #endif /* configASSERT_DEFINED */\r
774 \r
775 \r