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