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