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