]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/RVDS/ARM_CM4F/port.c
Added portASSERT_IF_INTERRUPT_PRIORITY_INVALID() implementation to Cortex-M3 and...
[freertos] / FreeRTOS / Source / portable / RVDS / ARM_CM4F / port.c
1 /*\r
2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
3 \r
4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
6 \r
7     ***************************************************************************\r
8      *                                                                       *\r
9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
10      *    Complete, revised, and edited pdf reference manuals are also       *\r
11      *    available.                                                         *\r
12      *                                                                       *\r
13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
14      *    ensuring you get running as quickly as possible and with an        *\r
15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
16      *    the FreeRTOS project to continue with its mission of providing     *\r
17      *    professional grade, cross platform, de facto standard solutions    *\r
18      *    for microcontrollers - completely free of charge!                  *\r
19      *                                                                       *\r
20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
21      *                                                                       *\r
22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
23      *                                                                       *\r
24     ***************************************************************************\r
25 \r
26 \r
27     This file is part of the FreeRTOS distribution.\r
28 \r
29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
30     the terms of the GNU General Public License (version 2) as published by the\r
31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
32 \r
33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
34     distribute a combined work that includes FreeRTOS without being obliged to\r
35     provide the source code for proprietary components outside of the FreeRTOS\r
36     kernel.\r
37 \r
38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
41     details. You should have received a copy of the GNU General Public License\r
42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
44     writing to Real Time Engineers Ltd., contact details for whom are available\r
45     on the FreeRTOS WEB site.\r
46 \r
47     1 tab == 4 spaces!\r
48 \r
49     ***************************************************************************\r
50      *                                                                       *\r
51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
52      *    not run, what could be wrong?"                                     *\r
53      *                                                                       *\r
54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
55      *                                                                       *\r
56     ***************************************************************************\r
57 \r
58 \r
59     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
60     license and Real Time Engineers Ltd. contact details.\r
61 \r
62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
64     fully thread aware and reentrant UDP/IP stack.\r
65 \r
66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
67     Integrity Systems, who sell the code with commercial support,\r
68     indemnification and middleware, under the OpenRTOS brand.\r
69 \r
70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
71     engineered and independently SIL3 certified version for use in safety and\r
72     mission critical applications that require provable dependability.\r
73 */\r
74 \r
75 /*-----------------------------------------------------------\r
76  * Implementation of functions defined in portable.h for the ARM CM4F port.\r
77  *----------------------------------------------------------*/\r
78 \r
79 /* Scheduler includes. */\r
80 #include "FreeRTOS.h"\r
81 #include "task.h"\r
82 \r
83 #ifndef __TARGET_FPU_VFP\r
84         #error This port can only be used when the project options are configured to enable hardware floating point support.\r
85 #endif\r
86 \r
87 #if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0\r
88         #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.  See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html\r
89 #endif\r
90 \r
91 #ifndef configSYSTICK_CLOCK_HZ\r
92         #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ\r
93 #endif\r
94 \r
95 /* The __weak attribute does not work as you might expect with the Keil tools\r
96 so the configOVERRIDE_DEFAULT_TICK_CONFIGURATION constant must be set to 1 if\r
97 the application writer wants to provide their own implementation of\r
98 vPortSetupTimerInterrupt().  Ensure configOVERRIDE_DEFAULT_TICK_CONFIGURATION\r
99 is defined. */\r
100 #ifndef configOVERRIDE_DEFAULT_TICK_CONFIGURATION\r
101         #define configOVERRIDE_DEFAULT_TICK_CONFIGURATION 0\r
102 #endif\r
103 \r
104 /* Constants required to manipulate the core.  Registers first... */\r
105 #define portNVIC_SYSTICK_CTRL_REG                       ( * ( ( volatile unsigned long * ) 0xe000e010 ) )\r
106 #define portNVIC_SYSTICK_LOAD_REG                       ( * ( ( volatile unsigned long * ) 0xe000e014 ) )\r
107 #define portNVIC_SYSTICK_CURRENT_VALUE_REG      ( * ( ( volatile unsigned long * ) 0xe000e018 ) )\r
108 #define portNVIC_SYSPRI2_REG                            ( * ( ( volatile unsigned long * ) 0xe000ed20 ) )\r
109 /* ...then bits in the registers. */\r
110 #define portNVIC_SYSTICK_CLK_BIT                        ( 1UL << 2UL )\r
111 #define portNVIC_SYSTICK_INT_BIT                        ( 1UL << 1UL )\r
112 #define portNVIC_SYSTICK_ENABLE_BIT                     ( 1UL << 0UL )\r
113 #define portNVIC_SYSTICK_COUNT_FLAG_BIT         ( 1UL << 16UL )\r
114 #define portNVIC_PENDSVCLEAR_BIT                        ( 1UL << 27UL )\r
115 #define portNVIC_PEND_SYSTICK_CLEAR_BIT         ( 1UL << 25UL )\r
116 \r
117 #define portNVIC_PENDSV_PRI                                     ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16UL )\r
118 #define portNVIC_SYSTICK_PRI                            ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )\r
119 \r
120 /* Constants required to check the validity of an interrupt prority. */\r
121 #define portFIRST_USER_INTERRUPT_NUMBER         ( 16 )\r
122 #define portNVIC_IP_REGISTERS_OFFSET_16         ( 0xE000E3F0 )\r
123 #define portAIRCR_REG                                           ( * ( ( volatile unsigned long * ) 0xE000ED0C ) )\r
124 #define portPRIORITY_GROUP_MASK                         ( 0x07UL << 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 /*\r
175  * The number of SysTick increments that make up one tick period.\r
176  */\r
177 #if configUSE_TICKLESS_IDLE == 1\r
178         static unsigned long ulTimerCountsForOneTick = 0;\r
179 #endif /* configUSE_TICKLESS_IDLE */\r
180 \r
181 /*\r
182  * The maximum number of tick periods that can be suppressed is limited by the\r
183  * 24 bit resolution of the SysTick timer.\r
184  */\r
185 #if configUSE_TICKLESS_IDLE == 1\r
186         static unsigned long xMaximumPossibleSuppressedTicks = 0;\r
187 #endif /* configUSE_TICKLESS_IDLE */\r
188 \r
189 /*\r
190  * Compensate for the CPU cycles that pass while the SysTick is stopped (low\r
191  * power functionality only.\r
192  */\r
193 #if configUSE_TICKLESS_IDLE == 1\r
194         static unsigned long ulStoppedTimerCompensation = 0;\r
195 #endif /* configUSE_TICKLESS_IDLE */\r
196 \r
197 /*\r
198  * Used by the portASSERT_IF_INTERRUPT_PRIORITY_INVALID() macro to ensure \r
199  * FreeRTOS API functions are not called from interrupts that have been assigned\r
200  * a priority above configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
201  */\r
202 #if ( configASSERT_DEFINED == 1 )\r
203          static unsigned char ucMaxSysCallPriority = 0;\r
204          static const volatile unsigned char * const pcInterruptPriorityRegisters = ( unsigned char * ) portNVIC_IP_REGISTERS_OFFSET_16;\r
205 #endif /* configASSERT_DEFINED */\r
206 \r
207 /*-----------------------------------------------------------*/\r
208 \r
209 /*\r
210  * See header file for description.\r
211  */\r
212 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
213 {\r
214         /* Simulate the stack frame as it would be created by a context switch\r
215         interrupt. */\r
216 \r
217         /* Offset added to account for the way the MCU uses the stack on entry/exit\r
218         of interrupts, and to ensure alignment. */\r
219         pxTopOfStack--;\r
220 \r
221         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
222         pxTopOfStack--;\r
223         *pxTopOfStack = ( portSTACK_TYPE ) pxCode;      /* PC */\r
224         pxTopOfStack--;\r
225         *pxTopOfStack = 0;      /* LR */\r
226 \r
227         /* Save code space by skipping register initialisation. */\r
228         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
229         *pxTopOfStack = ( portSTACK_TYPE ) pvParameters;        /* R0 */\r
230 \r
231         /* A save method is being used that requires each task to maintain its\r
232         own exec return value. */\r
233         pxTopOfStack--;\r
234         *pxTopOfStack = portINITIAL_EXEC_RETURN;\r
235 \r
236         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
237 \r
238         return pxTopOfStack;\r
239 }\r
240 /*-----------------------------------------------------------*/\r
241 \r
242 __asm void vPortSVCHandler( void )\r
243 {\r
244         PRESERVE8\r
245 \r
246         /* Get the location of the current TCB. */\r
247         ldr     r3, =pxCurrentTCB\r
248         ldr r1, [r3]\r
249         ldr r0, [r1]\r
250         /* Pop the core registers. */\r
251         ldmia r0!, {r4-r11, r14}\r
252         msr psp, r0\r
253         mov r0, #0\r
254         msr     basepri, r0\r
255         bx r14\r
256 }\r
257 /*-----------------------------------------------------------*/\r
258 \r
259 __asm void prvStartFirstTask( void )\r
260 {\r
261         PRESERVE8\r
262 \r
263         /* Use the NVIC offset register to locate the stack. */\r
264         ldr r0, =0xE000ED08\r
265         ldr r0, [r0]\r
266         ldr r0, [r0]\r
267         /* Set the msp back to the start of the stack. */\r
268         msr msp, r0\r
269         /* Globally enable interrupts. */\r
270         cpsie i\r
271         /* Call SVC to start the first task. */\r
272         svc 0\r
273         nop\r
274 }\r
275 /*-----------------------------------------------------------*/\r
276 \r
277 __asm void prvEnableVFP( void )\r
278 {\r
279         PRESERVE8\r
280 \r
281         /* The FPU enable bits are in the CPACR. */\r
282         ldr.w r0, =0xE000ED88\r
283         ldr     r1, [r0]\r
284 \r
285         /* Enable CP10 and CP11 coprocessors, then save back. */\r
286         orr     r1, r1, #( 0xf << 20 )\r
287         str r1, [r0]\r
288         bx      r14\r
289         nop\r
290 }\r
291 /*-----------------------------------------------------------*/\r
292 \r
293 /*\r
294  * See header file for description.\r
295  */\r
296 portBASE_TYPE xPortStartScheduler( void )\r
297 {\r
298         #if( configASSERT_DEFINED == 1 )\r
299         {\r
300                 volatile unsigned long ulOriginalPriority;\r
301                 volatile char * const pcFirstUserPriorityRegister = ( char * ) ( portNVIC_IP_REGISTERS_OFFSET_16 + portFIRST_USER_INTERRUPT_NUMBER );\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 = *pcFirstUserPriorityRegister;\r
310 \r
311                 /* Write the configMAX_SYSCALL_INTERRUPT_PRIORITY value to an interrupt\r
312                 priority register. */\r
313                 *pcFirstUserPriorityRegister = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
314 \r
315                 /* Read back the written priority to obtain its value as seen by the\r
316                 hardware, which will only implement a subset of the priority bits. */\r
317                 ucMaxSysCallPriority = *pcFirstUserPriorityRegister;\r
318 \r
319                 /* Restore the clobbered interrupt priority register to its original\r
320                 value. */\r
321                 *pcFirstUserPriorityRegister = ulOriginalPriority;\r
322         }\r
323         #endif /* conifgASSERT_DEFINED */\r
324 \r
325         /* Make PendSV and SysTick the lowest priority interrupts. */\r
326         portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;\r
327         portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;\r
328 \r
329         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
330         here already. */\r
331         vPortSetupTimerInterrupt();\r
332 \r
333         /* Initialise the critical nesting count ready for the first task. */\r
334         uxCriticalNesting = 0;\r
335 \r
336         /* Ensure the VFP is enabled - it should be anyway. */\r
337         prvEnableVFP();\r
338 \r
339         /* Lazy save always. */\r
340         *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;\r
341 \r
342         /* Start the first task. */\r
343         prvStartFirstTask();\r
344 \r
345         /* Should not get here! */\r
346         return 0;\r
347 }\r
348 /*-----------------------------------------------------------*/\r
349 \r
350 void vPortEndScheduler( void )\r
351 {\r
352         /* It is unlikely that the CM4F port will require this function as there\r
353         is nothing to return to.  */\r
354 }\r
355 /*-----------------------------------------------------------*/\r
356 \r
357 void vPortYield( void )\r
358 {\r
359         /* Set a PendSV to request a context switch. */\r
360         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
361 \r
362         /* Barriers are normally not required but do ensure the code is completely\r
363         within the specified behaviour for the architecture. */\r
364         __dsb( portSY_FULL_READ_WRITE );\r
365         __isb( portSY_FULL_READ_WRITE );\r
366 }\r
367 /*-----------------------------------------------------------*/\r
368 \r
369 void vPortEnterCritical( void )\r
370 {\r
371         portDISABLE_INTERRUPTS();\r
372         uxCriticalNesting++;\r
373         __dsb( portSY_FULL_READ_WRITE );\r
374         __isb( portSY_FULL_READ_WRITE );\r
375 }\r
376 /*-----------------------------------------------------------*/\r
377 \r
378 void vPortExitCritical( void )\r
379 {\r
380         uxCriticalNesting--;\r
381         if( uxCriticalNesting == 0 )\r
382         {\r
383                 portENABLE_INTERRUPTS();\r
384         }\r
385 }\r
386 /*-----------------------------------------------------------*/\r
387 \r
388 __asm void xPortPendSVHandler( void )\r
389 {\r
390         extern uxCriticalNesting;\r
391         extern pxCurrentTCB;\r
392         extern vTaskSwitchContext;\r
393 \r
394         PRESERVE8\r
395 \r
396         mrs r0, psp\r
397 \r
398         /* Get the location of the current TCB. */\r
399         ldr     r3, =pxCurrentTCB\r
400         ldr     r2, [r3]\r
401 \r
402         /* Is the task using the FPU context?  If so, push high vfp registers. */\r
403         tst r14, #0x10\r
404         it eq\r
405         vstmdbeq r0!, {s16-s31}\r
406 \r
407         /* Save the core registers. */\r
408         stmdb r0!, {r4-r11, r14}\r
409 \r
410         /* Save the new top of stack into the first member of the TCB. */\r
411         str r0, [r2]\r
412 \r
413         stmdb sp!, {r3, r14}\r
414         mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY\r
415         msr basepri, r0\r
416         bl vTaskSwitchContext\r
417         mov r0, #0\r
418         msr basepri, r0\r
419         ldmia sp!, {r3, r14}\r
420 \r
421         /* The first item in pxCurrentTCB is the task top of stack. */\r
422         ldr r1, [r3]\r
423         ldr r0, [r1]\r
424 \r
425         /* Pop the core registers. */\r
426         ldmia r0!, {r4-r11, r14}\r
427 \r
428         /* Is the task using the FPU context?  If so, pop the high vfp registers\r
429         too. */\r
430         tst r14, #0x10\r
431         it eq\r
432         vldmiaeq r0!, {s16-s31}\r
433 \r
434         msr psp, r0\r
435         bx r14\r
436         nop\r
437 }\r
438 /*-----------------------------------------------------------*/\r
439 \r
440 void xPortSysTickHandler( void )\r
441 {\r
442         /* The SysTick runs at the lowest interrupt priority, so when this interrupt\r
443         executes all interrupts must be unmasked.  There is therefore no need to\r
444         save and then restore the interrupt mask value as its value is already\r
445         known. */\r
446         ( void ) portSET_INTERRUPT_MASK_FROM_ISR();\r
447         {\r
448                 /* Increment the RTOS tick. */\r
449                 if( xTaskIncrementTick() != pdFALSE )\r
450                 {\r
451                         /* A context switch is required.  Context switching is performed in\r
452                         the PendSV interrupt.  Pend the PendSV interrupt. */\r
453                         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
454                 }\r
455         }\r
456         portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );\r
457 }\r
458 /*-----------------------------------------------------------*/\r
459 \r
460 #if configUSE_TICKLESS_IDLE == 1\r
461 \r
462         __weak void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )\r
463         {\r
464         unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements;\r
465         portTickType xModifiableIdleTime;\r
466 \r
467                 /* Make sure the SysTick reload value does not overflow the counter. */\r
468                 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )\r
469                 {\r
470                         xExpectedIdleTime = xMaximumPossibleSuppressedTicks;\r
471                 }\r
472 \r
473                 /* Stop the SysTick momentarily.  The time the SysTick is stopped for\r
474                 is accounted for as best it can be, but using the tickless mode will\r
475                 inevitably result in some tiny drift of the time maintained by the\r
476                 kernel with respect to calendar time. */\r
477                 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;\r
478 \r
479                 /* Calculate the reload value required to wait xExpectedIdleTime\r
480                 tick periods.  -1 is used because this code will execute part way\r
481                 through one of the tick periods. */\r
482                 ulReloadValue = portNVIC_SYSTICK_CURRENT_VALUE_REG + ( ulTimerCountsForOneTick * ( xExpectedIdleTime - 1UL ) );\r
483                 if( ulReloadValue > ulStoppedTimerCompensation )\r
484                 {\r
485                         ulReloadValue -= ulStoppedTimerCompensation;\r
486                 }\r
487 \r
488                 /* Enter a critical section but don't use the taskENTER_CRITICAL()\r
489                 method as that will mask interrupts that should exit sleep mode. */\r
490                 __disable_irq();\r
491 \r
492                 /* If a context switch is pending or a task is waiting for the scheduler\r
493                 to be unsuspended then abandon the low power entry. */\r
494                 if( eTaskConfirmSleepModeStatus() == eAbortSleep )\r
495                 {\r
496                         /* Restart SysTick. */\r
497                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
498 \r
499                         /* Re-enable interrupts - see comments above __disable_irq() call\r
500                         above. */\r
501                         __enable_irq();\r
502                 }\r
503                 else\r
504                 {\r
505                         /* Set the new reload value. */\r
506                         portNVIC_SYSTICK_LOAD_REG = ulReloadValue;\r
507 \r
508                         /* Clear the SysTick count flag and set the count value back to\r
509                         zero. */\r
510                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
511 \r
512                         /* Restart SysTick. */\r
513                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
514 \r
515                         /* Sleep until something happens.  configPRE_SLEEP_PROCESSING() can\r
516                         set its parameter to 0 to indicate that its implementation contains\r
517                         its own wait for interrupt or wait for event instruction, and so wfi\r
518                         should not be executed again.  However, the original expected idle\r
519                         time variable must remain unmodified, so a copy is taken. */\r
520                         xModifiableIdleTime = xExpectedIdleTime;\r
521                         configPRE_SLEEP_PROCESSING( xModifiableIdleTime );\r
522                         if( xModifiableIdleTime > 0 )\r
523                         {\r
524                                 __dsb( portSY_FULL_READ_WRITE );\r
525                                 __wfi();\r
526                                 __isb( portSY_FULL_READ_WRITE );\r
527                         }\r
528                         configPOST_SLEEP_PROCESSING( xExpectedIdleTime );\r
529 \r
530                         /* Stop SysTick.  Again, the time the SysTick is stopped for is\r
531                         accounted for as best it can be, but using the tickless mode will\r
532                         inevitably result in some tiny drift of the time maintained by the\r
533                         kernel with respect to calendar time. */\r
534                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;\r
535 \r
536                         /* Re-enable interrupts - see comments above __disable_irq() call\r
537                         above. */\r
538                         __enable_irq();\r
539 \r
540                         if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
541                         {\r
542                                 /* The tick interrupt has already executed, and the SysTick\r
543                                 count reloaded with ulReloadValue.  Reset the\r
544                                 portNVIC_SYSTICK_LOAD_REG with whatever remains of this tick\r
545                                 period. */\r
546                                 portNVIC_SYSTICK_LOAD_REG = ( ulTimerCountsForOneTick - 1UL ) - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
547 \r
548                                 /* The tick interrupt handler will already have pended the tick\r
549                                 processing in the kernel.  As the pending tick will be\r
550                                 processed as soon as this function exits, the tick value\r
551                                 maintained by the tick is stepped forward by one less than the\r
552                                 time spent waiting. */\r
553                                 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
554                         }\r
555                         else\r
556                         {\r
557                                 /* Something other than the tick interrupt ended the sleep.\r
558                                 Work out how long the sleep lasted rounded to complete tick\r
559                                 periods (not the ulReload value which accounted for part\r
560                                 ticks). */\r
561                                 ulCompletedSysTickDecrements = ( xExpectedIdleTime * ulTimerCountsForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
562 \r
563                                 /* How many complete tick periods passed while the processor\r
564                                 was waiting? */\r
565                                 ulCompleteTickPeriods = ulCompletedSysTickDecrements / ulTimerCountsForOneTick;\r
566 \r
567                                 /* The reload value is set to whatever fraction of a single tick\r
568                                 period remains. */\r
569                                 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;\r
570                         }\r
571 \r
572                         /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG\r
573                         again, then set portNVIC_SYSTICK_LOAD_REG back to its standard\r
574                         value. */\r
575                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
576                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
577 \r
578                         vTaskStepTick( ulCompleteTickPeriods );\r
579 \r
580                         /* The counter must start by the time the reload value is reset. */\r
581                         configASSERT( portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
582                         portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
583                 }\r
584         }\r
585 \r
586 #endif /* #if configUSE_TICKLESS_IDLE */\r
587 \r
588 /*-----------------------------------------------------------*/\r
589 \r
590 /*\r
591  * Setup the SysTick timer to generate the tick interrupts at the required\r
592  * frequency.\r
593  */\r
594 #if configOVERRIDE_DEFAULT_TICK_CONFIGURATION == 0\r
595 \r
596         void vPortSetupTimerInterrupt( void )\r
597         {\r
598                 /* Calculate the constants required to configure the tick interrupt. */\r
599                 #if configUSE_TICKLESS_IDLE == 1\r
600                 {\r
601                         ulTimerCountsForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );\r
602                         xMaximumPossibleSuppressedTicks = portMAX_24_BIT_NUMBER / ulTimerCountsForOneTick;\r
603                         ulStoppedTimerCompensation = portMISSED_COUNTS_FACTOR / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
604                 }\r
605                 #endif /* configUSE_TICKLESS_IDLE */\r
606 \r
607                 /* Configure SysTick to interrupt at the requested rate. */\r
608                 portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;;\r
609                 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
610         }\r
611 \r
612 #endif /* configOVERRIDE_DEFAULT_TICK_CONFIGURATION */\r
613 /*-----------------------------------------------------------*/\r
614 \r
615 __asm unsigned long ulPortSetInterruptMask( void )\r
616 {\r
617         PRESERVE8\r
618 \r
619         mrs r0, basepri\r
620         mov r1, #configMAX_SYSCALL_INTERRUPT_PRIORITY\r
621         msr basepri, r1\r
622         bx r14\r
623 }\r
624 /*-----------------------------------------------------------*/\r
625 \r
626 __asm void vPortClearInterruptMask( unsigned long ulNewMask )\r
627 {\r
628         PRESERVE8\r
629 \r
630         msr basepri, r0\r
631         bx r14\r
632 }\r
633 /*-----------------------------------------------------------*/\r
634 \r
635 __asm unsigned long vPortGetIPSR( void )\r
636 {\r
637         PRESERVE8\r
638         \r
639         mrs r0, ipsr\r
640         bx r14\r
641 }\r
642 /*-----------------------------------------------------------*/\r
643 \r
644 #if( configASSERT_DEFINED == 1 )\r
645 \r
646         void vPortValidateInterruptPriority( void )\r
647         {\r
648         unsigned long ulCurrentInterrupt;\r
649         unsigned char ucCurrentPriority;\r
650 \r
651                 /* Obtain the number of the currently executing interrupt. */\r
652                 ulCurrentInterrupt = vPortGetIPSR();\r
653 \r
654                 /* Is the interrupt number a user defined interrupt? */\r
655                 if( ulCurrentInterrupt >= portFIRST_USER_INTERRUPT_NUMBER )\r
656                 {\r
657                         /* Look up the interrupt's priority. */\r
658                         ucCurrentPriority = pcInterruptPriorityRegisters[ ulCurrentInterrupt ];\r
659 \r
660                         /* The following assertion will fail if a service routine (ISR) for \r
661                         an interrupt that has been assigned a priority above\r
662                         configMAX_SYSCALL_INTERRUPT_PRIORITY calls an ISR safe FreeRTOS API\r
663                         function.  ISR safe FreeRTOS API functions must *only* be called \r
664                         from interrupts that have been assigned a priority at or below\r
665                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
666                         \r
667                         Numerically low interrupt priority numbers represent logically high\r
668                         interrupt priorities, therefore the priority of the interrupt must \r
669                         be set to a value equal to or numerically *higher* than \r
670                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
671                         \r
672                         Interrupts that use the FreeRTOS API must not be left at their\r
673                         default priority of     zero as that is the highest possible priority,\r
674                         which is guaranteed to be above configMAX_SYSCALL_INTERRUPT_PRIORITY, \r
675                         and     therefore also guaranteed to be invalid.  \r
676                         \r
677                         FreeRTOS maintains separate thread and ISR API functions to ensure \r
678                         interrupt entry is as fast and simple as possible.\r
679                         \r
680                         The following links provide detailed information:\r
681                         http://www.freertos.org/RTOS-Cortex-M3-M4.html\r
682                         http://www.freertos.org/FAQHelp.html */\r
683                         configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );\r
684                 }\r
685 \r
686                 /* Priority grouping:  The interrupt controller (NVIC) allows the bits \r
687                 that define each interrupt's priority to be split between bits that \r
688                 define the interrupt's pre-emption priority bits and bits that define\r
689                 the interrupt's sub-priority.  For simplicity all bits must be defined \r
690                 to be pre-emption priority bits.  The following assertion will fail if\r
691                 this is not the case (if some bits represent a sub-priority).  \r
692                 \r
693                 If CMSIS libraries are being used then the correct setting can be \r
694                 achieved by calling     NVIC_SetPriorityGrouping( 0 ); before starting the \r
695                 scheduler. */\r
696                 configASSERT( ( portAIRCR_REG & portPRIORITY_GROUP_MASK ) == 0 );\r
697         }\r
698         \r
699 #endif /* configASSERT_DEFINED */\r
700 \r
701 \r