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