]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/RVDS/ARM_CM3/port.c
Multiple tidy up, documentation corrections and typo corrections highlighted by Tamas...
[freertos] / FreeRTOS / Source / portable / RVDS / ARM_CM3 / port.c
1 /*\r
2     FreeRTOS V7.6.0 - Copyright (C) 2013 Real Time Engineers Ltd.\r
3     All rights reserved\r
4 \r
5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
6 \r
7     ***************************************************************************\r
8      *                                                                       *\r
9      *    FreeRTOS provides completely free yet professionally developed,    *\r
10      *    robust, strictly quality controlled, supported, and cross          *\r
11      *    platform software that has become a de facto standard.             *\r
12      *                                                                       *\r
13      *    Help yourself get started quickly and support the FreeRTOS         *\r
14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
16      *                                                                       *\r
17      *    Thank you!                                                         *\r
18      *                                                                       *\r
19     ***************************************************************************\r
20 \r
21     This file is part of the FreeRTOS distribution.\r
22 \r
23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
24     the terms of the GNU General Public License (version 2) as published by the\r
25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
26 \r
27     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
29     >>! the source code for proprietary components outside of the FreeRTOS\r
30     >>! kernel.\r
31 \r
32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
35     link: http://www.freertos.org/a00114.html\r
36 \r
37     1 tab == 4 spaces!\r
38 \r
39     ***************************************************************************\r
40      *                                                                       *\r
41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
42      *    not run, what could be wrong?"                                     *\r
43      *                                                                       *\r
44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
45      *                                                                       *\r
46     ***************************************************************************\r
47 \r
48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
49     license and Real Time Engineers Ltd. contact details.\r
50 \r
51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
54 \r
55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
57     licenses offer ticketed support, indemnification and middleware.\r
58 \r
59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
60     engineered and independently SIL3 certified version for use in safety and\r
61     mission critical applications that require provable dependability.\r
62 \r
63     1 tab == 4 spaces!\r
64 */\r
65 \r
66 /*-----------------------------------------------------------\r
67  * Implementation of functions defined in portable.h for the ARM CM3 port.\r
68  *----------------------------------------------------------*/\r
69 \r
70 /* Scheduler includes. */\r
71 #include "FreeRTOS.h"\r
72 #include "task.h"\r
73 \r
74 #ifndef configKERNEL_INTERRUPT_PRIORITY\r
75         #define configKERNEL_INTERRUPT_PRIORITY 255\r
76 #endif\r
77 \r
78 #if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0\r
79         #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.  See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html\r
80 #endif\r
81 \r
82 #ifndef configSYSTICK_CLOCK_HZ\r
83         #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ\r
84 #endif\r
85 \r
86 /* The __weak attribute does not work as you might expect with the Keil tools\r
87 so the configOVERRIDE_DEFAULT_TICK_CONFIGURATION constant must be set to 1 if\r
88 the application writer wants to provide their own implementation of\r
89 vPortSetupTimerInterrupt().  Ensure configOVERRIDE_DEFAULT_TICK_CONFIGURATION\r
90 is defined. */\r
91 #ifndef configOVERRIDE_DEFAULT_TICK_CONFIGURATION\r
92         #define configOVERRIDE_DEFAULT_TICK_CONFIGURATION 0\r
93 #endif\r
94 \r
95 /* Constants required to manipulate the core.  Registers first... */\r
96 #define portNVIC_SYSTICK_CTRL_REG                       ( * ( ( volatile unsigned long * ) 0xe000e010 ) )\r
97 #define portNVIC_SYSTICK_LOAD_REG                       ( * ( ( volatile unsigned long * ) 0xe000e014 ) )\r
98 #define portNVIC_SYSTICK_CURRENT_VALUE_REG      ( * ( ( volatile unsigned long * ) 0xe000e018 ) )\r
99 #define portNVIC_SYSPRI2_REG                            ( * ( ( volatile unsigned long * ) 0xe000ed20 ) )\r
100 /* ...then bits in the registers. */\r
101 #define portNVIC_SYSTICK_CLK_BIT                        ( 1UL << 2UL )\r
102 #define portNVIC_SYSTICK_INT_BIT                        ( 1UL << 1UL )\r
103 #define portNVIC_SYSTICK_ENABLE_BIT                     ( 1UL << 0UL )\r
104 #define portNVIC_SYSTICK_COUNT_FLAG_BIT         ( 1UL << 16UL )\r
105 #define portNVIC_PENDSVCLEAR_BIT                        ( 1UL << 27UL )\r
106 #define portNVIC_PEND_SYSTICK_CLEAR_BIT         ( 1UL << 25UL )\r
107 \r
108 #define portNVIC_PENDSV_PRI                                     ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16UL )\r
109 #define portNVIC_SYSTICK_PRI                            ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )\r
110 \r
111 /* Constants required to check the validity of an interrupt priority. */\r
112 #define portFIRST_USER_INTERRUPT_NUMBER         ( 16 )\r
113 #define portNVIC_IP_REGISTERS_OFFSET_16         ( 0xE000E3F0 )\r
114 #define portAIRCR_REG                                           ( * ( ( volatile unsigned long * ) 0xE000ED0C ) )\r
115 #define portMAX_8_BIT_VALUE                                     ( ( unsigned char ) 0xff )\r
116 #define portTOP_BIT_OF_BYTE                                     ( ( unsigned char ) 0x80 )\r
117 #define portMAX_PRIGROUP_BITS                           ( ( unsigned char ) 7 )\r
118 #define portPRIORITY_GROUP_MASK                         ( 0x07UL << 8UL )\r
119 #define portPRIGROUP_SHIFT                                      ( 8UL )\r
120 \r
121 /* Constants required to set up the initial stack. */\r
122 #define portINITIAL_XPSR                        ( 0x01000000 )\r
123 \r
124 /* Constants used with memory barrier intrinsics. */\r
125 #define portSY_FULL_READ_WRITE          ( 15 )\r
126 \r
127 /* The systick is a 24-bit counter. */\r
128 #define portMAX_24_BIT_NUMBER                           ( 0xffffffUL )\r
129 \r
130 /* A fiddle factor to estimate the number of SysTick counts that would have\r
131 occurred while the SysTick counter is stopped during tickless idle\r
132 calculations. */\r
133 #define portMISSED_COUNTS_FACTOR                        ( 45UL )\r
134 \r
135 /* Each task maintains its own interrupt status in the critical nesting\r
136 variable. */\r
137 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;\r
138 \r
139 /*\r
140  * Setup the timer to generate the tick interrupts.  The implementation in this\r
141  * file is weak to allow application writers to change the timer used to\r
142  * generate the tick interrupt.\r
143  */\r
144 void vPortSetupTimerInterrupt( void );\r
145 \r
146 /*\r
147  * Exception handlers.\r
148  */\r
149 void xPortPendSVHandler( void );\r
150 void xPortSysTickHandler( void );\r
151 void vPortSVCHandler( void );\r
152 \r
153 /*\r
154  * Start first task is a separate function so it can be tested in isolation.\r
155  */\r
156 static void prvStartFirstTask( void );\r
157 \r
158 /*\r
159  * Used to catch tasks that attempt to return from their implementing function.\r
160  */\r
161 static void prvTaskExitError( void );\r
162 \r
163 /*-----------------------------------------------------------*/\r
164 \r
165 /*\r
166  * The number of SysTick increments that make up one tick period.\r
167  */\r
168 #if configUSE_TICKLESS_IDLE == 1\r
169         static unsigned long ulTimerCountsForOneTick = 0;\r
170 #endif /* configUSE_TICKLESS_IDLE */\r
171 \r
172 /*\r
173  * The maximum number of tick periods that can be suppressed is limited by the\r
174  * 24 bit resolution of the SysTick timer.\r
175  */\r
176 #if configUSE_TICKLESS_IDLE == 1\r
177         static unsigned long xMaximumPossibleSuppressedTicks = 0;\r
178 #endif /* configUSE_TICKLESS_IDLE */\r
179 \r
180 /*\r
181  * Compensate for the CPU cycles that pass while the SysTick is stopped (low\r
182  * power functionality only.\r
183  */\r
184 #if configUSE_TICKLESS_IDLE == 1\r
185         static unsigned long ulStoppedTimerCompensation = 0;\r
186 #endif /* configUSE_TICKLESS_IDLE */\r
187 \r
188 /*\r
189  * Used by the portASSERT_IF_INTERRUPT_PRIORITY_INVALID() macro to ensure\r
190  * FreeRTOS API functions are not called from interrupts that have been assigned\r
191  * a priority above configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
192  */\r
193 #if ( configASSERT_DEFINED == 1 )\r
194          static unsigned char ucMaxSysCallPriority = 0;\r
195          static unsigned long ulMaxPRIGROUPValue = 0;\r
196          static const volatile unsigned char * const pcInterruptPriorityRegisters = ( unsigned char * ) portNVIC_IP_REGISTERS_OFFSET_16;\r
197 #endif /* configASSERT_DEFINED */\r
198 \r
199 /*-----------------------------------------------------------*/\r
200 \r
201 /*\r
202  * See header file for description.\r
203  */\r
204 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
205 {\r
206         /* Simulate the stack frame as it would be created by a context switch\r
207         interrupt. */\r
208         pxTopOfStack--; /* Offset added to account for the way the MCU uses the stack on entry/exit of interrupts. */\r
209         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
210         pxTopOfStack--;\r
211         *pxTopOfStack = ( portSTACK_TYPE ) pxCode;      /* PC */\r
212         pxTopOfStack--;\r
213         *pxTopOfStack = ( portSTACK_TYPE ) prvTaskExitError;    /* LR */\r
214 \r
215         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
216         *pxTopOfStack = ( portSTACK_TYPE ) pvParameters;        /* R0 */\r
217         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
218 \r
219         return pxTopOfStack;\r
220 }\r
221 /*-----------------------------------------------------------*/\r
222 \r
223 static void prvTaskExitError( void )\r
224 {\r
225         /* A function that implements a task must not exit or attempt to return to\r
226         its caller as there is nothing to return to.  If a task wants to exit it\r
227         should instead call vTaskDelete( NULL ).\r
228 \r
229         Artificially force an assert() to be triggered if configASSERT() is\r
230         defined, then stop here so application writers can catch the error. */\r
231         configASSERT( uxCriticalNesting == ~0UL );\r
232         portDISABLE_INTERRUPTS();\r
233         for( ;; );\r
234 }\r
235 /*-----------------------------------------------------------*/\r
236 \r
237 __asm void vPortSVCHandler( void )\r
238 {\r
239         PRESERVE8\r
240 \r
241         ldr     r3, =pxCurrentTCB       /* Restore the context. */\r
242         ldr r1, [r3]                    /* Use pxCurrentTCBConst to get the pxCurrentTCB address. */\r
243         ldr r0, [r1]                    /* The first item in pxCurrentTCB is the task top of stack. */\r
244         ldmia r0!, {r4-r11}             /* Pop the registers that are not automatically saved on exception entry and the critical nesting count. */\r
245         msr psp, r0                             /* Restore the task stack pointer. */\r
246         mov r0, #0\r
247         msr     basepri, r0\r
248         orr r14, #0xd\r
249         bx r14\r
250 }\r
251 /*-----------------------------------------------------------*/\r
252 \r
253 __asm void prvStartFirstTask( void )\r
254 {\r
255         PRESERVE8\r
256 \r
257         /* Use the NVIC offset register to locate the stack. */\r
258         ldr r0, =0xE000ED08\r
259         ldr r0, [r0]\r
260         ldr r0, [r0]\r
261         /* Set the msp back to the start of the stack. */\r
262         msr msp, r0\r
263         /* Globally enable interrupts. */\r
264         cpsie i\r
265         /* Call SVC to start the first task. */\r
266         svc 0\r
267         nop\r
268 }\r
269 /*-----------------------------------------------------------*/\r
270 \r
271 /*\r
272  * See header file for description.\r
273  */\r
274 portBASE_TYPE xPortStartScheduler( void )\r
275 {\r
276         #if( configASSERT_DEFINED == 1 )\r
277         {\r
278                 volatile unsigned long ulOriginalPriority;\r
279                 volatile char * const pcFirstUserPriorityRegister = ( char * ) ( portNVIC_IP_REGISTERS_OFFSET_16 + portFIRST_USER_INTERRUPT_NUMBER );\r
280                 volatile unsigned char ucMaxPriorityValue;\r
281 \r
282                 /* Determine the maximum priority from which ISR safe FreeRTOS API\r
283                 functions can be called.  ISR safe functions are those that end in\r
284                 "FromISR".  FreeRTOS maintains separate thread and ISR API functions to\r
285                 ensure interrupt entry is as fast and simple as possible.\r
286 \r
287                 Save the interrupt priority value that is about to be clobbered. */\r
288                 ulOriginalPriority = *pcFirstUserPriorityRegister;\r
289 \r
290                 /* Determine the number of priority bits available.  First write to all\r
291                 possible bits. */\r
292                 *pcFirstUserPriorityRegister = portMAX_8_BIT_VALUE;\r
293 \r
294                 /* Read the value back to see how many bits stuck. */\r
295                 ucMaxPriorityValue = *pcFirstUserPriorityRegister;\r
296 \r
297                 /* Use the same mask on the maximum system call priority. */\r
298                 ucMaxSysCallPriority = configMAX_SYSCALL_INTERRUPT_PRIORITY & ucMaxPriorityValue;\r
299 \r
300                 /* Calculate the maximum acceptable priority group value for the number\r
301                 of bits read back. */\r
302                 ulMaxPRIGROUPValue = portMAX_PRIGROUP_BITS;\r
303                 while( ( ucMaxPriorityValue & portTOP_BIT_OF_BYTE ) == portTOP_BIT_OF_BYTE )\r
304                 {\r
305                         ulMaxPRIGROUPValue--;\r
306                         ucMaxPriorityValue <<= ( unsigned char ) 0x01;\r
307                 }\r
308 \r
309                 /* Shift the priority group value back to its position within the AIRCR\r
310                 register. */\r
311                 ulMaxPRIGROUPValue <<= portPRIGROUP_SHIFT;\r
312                 ulMaxPRIGROUPValue &= portPRIORITY_GROUP_MASK;\r
313 \r
314                 /* Restore the clobbered interrupt priority register to its original\r
315                 value. */\r
316                 *pcFirstUserPriorityRegister = ulOriginalPriority;\r
317         }\r
318         #endif /* conifgASSERT_DEFINED */\r
319 \r
320         /* Make PendSV and SysTick the lowest priority interrupts. */\r
321         portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;\r
322         portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;\r
323 \r
324         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
325         here already. */\r
326         vPortSetupTimerInterrupt();\r
327 \r
328         /* Initialise the critical nesting count ready for the first task. */\r
329         uxCriticalNesting = 0;\r
330 \r
331         /* Start the first task. */\r
332         prvStartFirstTask();\r
333 \r
334         /* Should not get here! */\r
335         return 0;\r
336 }\r
337 /*-----------------------------------------------------------*/\r
338 \r
339 void vPortEndScheduler( void )\r
340 {\r
341         /* Not implemented in ports where there is nothing to return to.\r
342         Artificially force an assert. */\r
343         configASSERT( uxCriticalNesting == 1000UL );\r
344 }\r
345 /*-----------------------------------------------------------*/\r
346 \r
347 void vPortYield( void )\r
348 {\r
349         /* Set a PendSV to request a context switch. */\r
350         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
351 \r
352         /* Barriers are normally not required but do ensure the code is completely\r
353         within the specified behaviour for the architecture. */\r
354         __dsb( portSY_FULL_READ_WRITE );\r
355         __isb( portSY_FULL_READ_WRITE );\r
356 }\r
357 /*-----------------------------------------------------------*/\r
358 \r
359 void vPortEnterCritical( void )\r
360 {\r
361         portDISABLE_INTERRUPTS();\r
362         uxCriticalNesting++;\r
363         __dsb( portSY_FULL_READ_WRITE );\r
364         __isb( portSY_FULL_READ_WRITE );\r
365 }\r
366 /*-----------------------------------------------------------*/\r
367 \r
368 void vPortExitCritical( void )\r
369 {\r
370         configASSERT( uxCriticalNesting );\r
371         uxCriticalNesting--;\r
372         if( uxCriticalNesting == 0 )\r
373         {\r
374                 portENABLE_INTERRUPTS();\r
375         }\r
376 }\r
377 /*-----------------------------------------------------------*/\r
378 \r
379 __asm void xPortPendSVHandler( void )\r
380 {\r
381         extern uxCriticalNesting;\r
382         extern pxCurrentTCB;\r
383         extern vTaskSwitchContext;\r
384 \r
385         PRESERVE8\r
386 \r
387         mrs r0, psp\r
388 \r
389         ldr     r3, =pxCurrentTCB               /* Get the location of the current TCB. */\r
390         ldr     r2, [r3]\r
391 \r
392         stmdb r0!, {r4-r11}                     /* Save the remaining registers. */\r
393         str r0, [r2]                            /* Save the new top of stack into the first member of the TCB. */\r
394 \r
395         stmdb sp!, {r3, r14}\r
396         mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY\r
397         msr basepri, r0\r
398         bl vTaskSwitchContext\r
399         mov r0, #0\r
400         msr basepri, r0\r
401         ldmia sp!, {r3, r14}\r
402 \r
403         ldr r1, [r3]\r
404         ldr r0, [r1]                            /* The first item in pxCurrentTCB is the task top of stack. */\r
405         ldmia r0!, {r4-r11}                     /* Pop the registers and the critical nesting count. */\r
406         msr psp, r0\r
407         bx r14\r
408         nop\r
409 }\r
410 /*-----------------------------------------------------------*/\r
411 \r
412 void xPortSysTickHandler( void )\r
413 {\r
414         /* The SysTick runs at the lowest interrupt priority, so when this interrupt\r
415         executes all interrupts must be unmasked.  There is therefore no need to\r
416         save and then restore the interrupt mask value as its value is already\r
417         known. */\r
418         ( void ) portSET_INTERRUPT_MASK_FROM_ISR();\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         portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );\r
429 }\r
430 /*-----------------------------------------------------------*/\r
431 \r
432 #if configUSE_TICKLESS_IDLE == 1\r
433 \r
434         __weak void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )\r
435         {\r
436         unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements;\r
437         portTickType 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_CLK_BIT | portNVIC_SYSTICK_INT_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 \r
464                 /* If a context switch is pending or a task is waiting for the scheduler\r
465                 to be unsuspended then abandon the low power entry. */\r
466                 if( eTaskConfirmSleepModeStatus() == eAbortSleep )\r
467                 {\r
468                         /* Restart from whatever is left in the count register to complete\r
469                         this tick period. */\r
470                         portNVIC_SYSTICK_LOAD_REG = portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
471 \r
472                         /* Restart SysTick. */\r
473                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
474 \r
475                         /* Reset the reload register to the value required for normal tick\r
476                         periods. */\r
477                         portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
478 \r
479                         /* Re-enable interrupts - see comments above __disable_irq() call\r
480                         above. */\r
481                         __enable_irq();\r
482                 }\r
483                 else\r
484                 {\r
485                         /* Set the new reload value. */\r
486                         portNVIC_SYSTICK_LOAD_REG = ulReloadValue;\r
487 \r
488                         /* Clear the SysTick count flag and set the count value back to\r
489                         zero. */\r
490                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
491 \r
492                         /* Restart SysTick. */\r
493                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
494 \r
495                         /* Sleep until something happens.  configPRE_SLEEP_PROCESSING() can\r
496                         set its parameter to 0 to indicate that its implementation contains\r
497                         its own wait for interrupt or wait for event instruction, and so wfi\r
498                         should not be executed again.  However, the original expected idle\r
499                         time variable must remain unmodified, so a copy is taken. */\r
500                         xModifiableIdleTime = xExpectedIdleTime;\r
501                         configPRE_SLEEP_PROCESSING( xModifiableIdleTime );\r
502                         if( xModifiableIdleTime > 0 )\r
503                         {\r
504                                 __dsb( portSY_FULL_READ_WRITE );\r
505                                 __wfi();\r
506                                 __isb( portSY_FULL_READ_WRITE );\r
507                         }\r
508                         configPOST_SLEEP_PROCESSING( xExpectedIdleTime );\r
509 \r
510                         /* Stop SysTick.  Again, the time the SysTick is stopped for is\r
511                         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_CLK_BIT | portNVIC_SYSTICK_INT_BIT;\r
515 \r
516                         /* Re-enable interrupts - see comments above __disable_irq() call\r
517                         above. */\r
518                         __enable_irq();\r
519 \r
520                         if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
521                         {\r
522                                 unsigned long ulCalculatedLoadValue;\r
523 \r
524                                 /* The tick interrupt has already executed, and the SysTick\r
525                                 count reloaded with ulReloadValue.  Reset the\r
526                                 portNVIC_SYSTICK_LOAD_REG with whatever remains of this tick\r
527                                 period. */\r
528                                 ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL ) - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
529 \r
530                                 /* Don't allow a tiny value, or values that have somehow\r
531                                 underflowed because the post sleep hook did something\r
532                                 that took too long. */\r
533                                 if( ( ulCalculatedLoadValue < ulStoppedTimerCompensation ) || ( ulCalculatedLoadValue > ulTimerCountsForOneTick ) )\r
534                                 {\r
535                                         ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL );\r
536                                 }\r
537 \r
538                                 portNVIC_SYSTICK_LOAD_REG = ulCalculatedLoadValue;\r
539 \r
540                                 /* The tick interrupt handler will already have pended the tick\r
541                                 processing in the kernel.  As the pending tick will be\r
542                                 processed as soon as this function exits, the tick value\r
543                                 maintained by the tick is stepped forward by one less than the\r
544                                 time spent waiting. */\r
545                                 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
546                         }\r
547                         else\r
548                         {\r
549                                 /* Something other than the tick interrupt ended the sleep.\r
550                                 Work out how long the sleep lasted rounded to complete tick\r
551                                 periods (not the ulReload value which accounted for part\r
552                                 ticks). */\r
553                                 ulCompletedSysTickDecrements = ( xExpectedIdleTime * ulTimerCountsForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
554 \r
555                                 /* How many complete tick periods passed while the processor\r
556                                 was waiting? */\r
557                                 ulCompleteTickPeriods = ulCompletedSysTickDecrements / ulTimerCountsForOneTick;\r
558 \r
559                                 /* The reload value is set to whatever fraction of a single tick\r
560                                 period remains. */\r
561                                 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;\r
562                         }\r
563 \r
564                         /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG\r
565                         again, then set portNVIC_SYSTICK_LOAD_REG back to its standard\r
566                         value.  The critical section is used to ensure the tick interrupt\r
567                         can only execute once in the case that the reload register is near\r
568                         zero. */\r
569                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
570                         portENTER_CRITICAL();\r
571                         {\r
572                                 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
573                                 vTaskStepTick( ulCompleteTickPeriods );\r
574                                 portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
575                         }\r
576                         portEXIT_CRITICAL();\r
577                 }\r
578         }\r
579 \r
580 #endif /* #if configUSE_TICKLESS_IDLE */\r
581 \r
582 /*-----------------------------------------------------------*/\r
583 \r
584 /*\r
585  * Setup the SysTick timer to generate the tick interrupts at the required\r
586  * frequency.\r
587  */\r
588 #if configOVERRIDE_DEFAULT_TICK_CONFIGURATION == 0\r
589 \r
590         void vPortSetupTimerInterrupt( void )\r
591         {\r
592                 /* Calculate the constants required to configure the tick interrupt. */\r
593                 #if configUSE_TICKLESS_IDLE == 1\r
594                 {\r
595                         ulTimerCountsForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );\r
596                         xMaximumPossibleSuppressedTicks = portMAX_24_BIT_NUMBER / ulTimerCountsForOneTick;\r
597                         ulStoppedTimerCompensation = portMISSED_COUNTS_FACTOR / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
598                 }\r
599                 #endif /* configUSE_TICKLESS_IDLE */\r
600 \r
601                 /* Configure SysTick to interrupt at the requested rate. */\r
602                 portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;;\r
603                 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
604         }\r
605 \r
606 #endif /* configOVERRIDE_DEFAULT_TICK_CONFIGURATION */\r
607 /*-----------------------------------------------------------*/\r
608 \r
609 __asm unsigned long ulPortSetInterruptMask( void )\r
610 {\r
611         PRESERVE8\r
612 \r
613         mrs r0, basepri\r
614         mov r1, #configMAX_SYSCALL_INTERRUPT_PRIORITY\r
615         msr basepri, r1\r
616         bx r14\r
617 }\r
618 /*-----------------------------------------------------------*/\r
619 \r
620 __asm void vPortClearInterruptMask( unsigned long ulNewMask )\r
621 {\r
622         PRESERVE8\r
623 \r
624         msr basepri, r0\r
625         bx r14\r
626 }\r
627 /*-----------------------------------------------------------*/\r
628 \r
629 __asm unsigned long 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         unsigned long ulCurrentInterrupt;\r
643         unsigned char 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 unpredicable behaviour. */\r
693                 configASSERT( ( portAIRCR_REG & portPRIORITY_GROUP_MASK ) <= ulMaxPRIGROUPValue );\r
694         }\r
695 \r
696 #endif /* configASSERT_DEFINED */\r
697 \r
698 \r