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