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