]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/IAR/ARM_CM3/port.c
Multiple tidy up, documentation corrections and typo corrections highlighted by Tamas...
[freertos] / FreeRTOS / Source / portable / IAR / 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 /* IAR includes. */\r
71 #include <intrinsics.h>\r
72 \r
73 /* Scheduler includes. */\r
74 #include "FreeRTOS.h"\r
75 #include "task.h"\r
76 \r
77 #if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0\r
78         #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.  See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html\r
79 #endif\r
80 \r
81 #ifndef configSYSTICK_CLOCK_HZ\r
82         #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ\r
83 #endif\r
84 \r
85 /* Constants required to manipulate the core.  Registers first... */\r
86 #define portNVIC_SYSTICK_CTRL_REG                       ( * ( ( volatile unsigned long * ) 0xe000e010 ) )\r
87 #define portNVIC_SYSTICK_LOAD_REG                       ( * ( ( volatile unsigned long * ) 0xe000e014 ) )\r
88 #define portNVIC_SYSTICK_CURRENT_VALUE_REG      ( * ( ( volatile unsigned long * ) 0xe000e018 ) )\r
89 #define portNVIC_SYSPRI2_REG                            ( * ( ( volatile unsigned long * ) 0xe000ed20 ) )\r
90 /* ...then bits in the registers. */\r
91 #define portNVIC_SYSTICK_CLK_BIT                        ( 1UL << 2UL )\r
92 #define portNVIC_SYSTICK_INT_BIT                        ( 1UL << 1UL )\r
93 #define portNVIC_SYSTICK_ENABLE_BIT                     ( 1UL << 0UL )\r
94 #define portNVIC_SYSTICK_COUNT_FLAG_BIT         ( 1UL << 16UL )\r
95 #define portNVIC_PENDSVCLEAR_BIT                        ( 1UL << 27UL )\r
96 #define portNVIC_PEND_SYSTICK_CLEAR_BIT         ( 1UL << 25UL )\r
97 \r
98 #define portNVIC_PENDSV_PRI                                     ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16UL )\r
99 #define portNVIC_SYSTICK_PRI                            ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )\r
100 \r
101 /* Constants required to check the validity of an interrupt priority. */\r
102 #define portFIRST_USER_INTERRUPT_NUMBER         ( 16 )\r
103 #define portNVIC_IP_REGISTERS_OFFSET_16         ( 0xE000E3F0 )\r
104 #define portAIRCR_REG                                           ( * ( ( volatile unsigned long * ) 0xE000ED0C ) )\r
105 #define portMAX_8_BIT_VALUE                                     ( ( unsigned char ) 0xff )\r
106 #define portTOP_BIT_OF_BYTE                                     ( ( unsigned char ) 0x80 )\r
107 #define portMAX_PRIGROUP_BITS                           ( ( unsigned char ) 7 )\r
108 #define portPRIORITY_GROUP_MASK                         ( 0x07UL << 8UL )\r
109 #define portPRIGROUP_SHIFT                                      ( 8UL )\r
110 \r
111 /* Constants required to set up the initial stack. */\r
112 #define portINITIAL_XPSR                                        ( 0x01000000 )\r
113 \r
114 /* The systick is a 24-bit counter. */\r
115 #define portMAX_24_BIT_NUMBER                           ( 0xffffffUL )\r
116 \r
117 /* A fiddle factor to estimate the number of SysTick counts that would have\r
118 occurred while the SysTick counter is stopped during tickless idle\r
119 calculations. */\r
120 #define portMISSED_COUNTS_FACTOR                        ( 45UL )\r
121 \r
122 /* For backward compatibility, ensure configKERNEL_INTERRUPT_PRIORITY is\r
123 defined.  The value 255 should also ensure backward compatibility.\r
124 FreeRTOS.org versions prior to V4.3.0 did not include this definition. */\r
125 #ifndef configKERNEL_INTERRUPT_PRIORITY\r
126         #define configKERNEL_INTERRUPT_PRIORITY 255\r
127 #endif\r
128 \r
129 /* Each task maintains its own interrupt status in the critical nesting\r
130 variable. */\r
131 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;\r
132 \r
133 /*\r
134  * Setup the timer to generate the tick interrupts.  The implementation in this\r
135  * file is weak to allow application writers to change the timer used to\r
136  * generate the tick interrupt.\r
137  */\r
138 void vPortSetupTimerInterrupt( void );\r
139 \r
140 /*\r
141  * Exception handlers.\r
142  */\r
143 void xPortSysTickHandler( void );\r
144 \r
145 /*\r
146  * Start first task is a separate function so it can be tested in isolation.\r
147  */\r
148 extern void vPortStartFirstTask( void );\r
149 \r
150 /*\r
151  * Used to catch tasks that attempt to return from their implementing function.\r
152  */\r
153 static void prvTaskExitError( void );\r
154 \r
155 /*-----------------------------------------------------------*/\r
156 \r
157 /*\r
158  * The number of SysTick increments that make up one tick period.\r
159  */\r
160 #if configUSE_TICKLESS_IDLE == 1\r
161         static unsigned long ulTimerCountsForOneTick = 0;\r
162 #endif /* configUSE_TICKLESS_IDLE */\r
163 \r
164 /*\r
165  * The maximum number of tick periods that can be suppressed is limited by the\r
166  * 24 bit resolution of the SysTick timer.\r
167  */\r
168 #if configUSE_TICKLESS_IDLE == 1\r
169         static unsigned long xMaximumPossibleSuppressedTicks = 0;\r
170 #endif /* configUSE_TICKLESS_IDLE */\r
171 \r
172 /*\r
173  * Compensate for the CPU cycles that pass while the SysTick is stopped (low\r
174  * power functionality only.\r
175  */\r
176 #if configUSE_TICKLESS_IDLE == 1\r
177         static unsigned long ulStoppedTimerCompensation = 0;\r
178 #endif /* configUSE_TICKLESS_IDLE */\r
179 \r
180 /*\r
181  * Used by the portASSERT_IF_INTERRUPT_PRIORITY_INVALID() macro to ensure\r
182  * FreeRTOS API functions are not called from interrupts that have been assigned\r
183  * a priority above configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
184  */\r
185 #if ( configASSERT_DEFINED == 1 )\r
186          static unsigned char ucMaxSysCallPriority = 0;\r
187          static unsigned long ulMaxPRIGROUPValue = 0;\r
188          static const volatile unsigned char * const pcInterruptPriorityRegisters = ( const volatile unsigned char * const ) portNVIC_IP_REGISTERS_OFFSET_16;\r
189 #endif /* configASSERT_DEFINED */\r
190 \r
191 /*-----------------------------------------------------------*/\r
192 \r
193 /*\r
194  * See header file for description.\r
195  */\r
196 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
197 {\r
198         /* Simulate the stack frame as it would be created by a context switch\r
199         interrupt. */\r
200         pxTopOfStack--; /* Offset added to account for the way the MCU uses the stack on entry/exit of interrupts. */\r
201         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
202         pxTopOfStack--;\r
203         *pxTopOfStack = ( portSTACK_TYPE ) pxCode;      /* PC */\r
204         pxTopOfStack--;\r
205         *pxTopOfStack = ( portSTACK_TYPE ) prvTaskExitError;    /* LR */\r
206         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
207         *pxTopOfStack = ( portSTACK_TYPE ) pvParameters;        /* R0 */\r
208         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
209 \r
210         return pxTopOfStack;\r
211 }\r
212 /*-----------------------------------------------------------*/\r
213 \r
214 static void prvTaskExitError( void )\r
215 {\r
216         /* A function that implements a task must not exit or attempt to return to\r
217         its caller as there is nothing to return to.  If a task wants to exit it\r
218         should instead call vTaskDelete( NULL ).\r
219 \r
220         Artificially force an assert() to be triggered if configASSERT() is\r
221         defined, then stop here so application writers can catch the error. */\r
222         configASSERT( uxCriticalNesting == ~0UL );\r
223         portDISABLE_INTERRUPTS();\r
224         for( ;; );\r
225 }\r
226 /*-----------------------------------------------------------*/\r
227 \r
228 /*\r
229  * See header file for description.\r
230  */\r
231 portBASE_TYPE xPortStartScheduler( void )\r
232 {\r
233         #if( configASSERT_DEFINED == 1 )\r
234         {\r
235                 volatile unsigned long ulOriginalPriority;\r
236                 volatile char * const pcFirstUserPriorityRegister = ( volatile char * const ) ( portNVIC_IP_REGISTERS_OFFSET_16 + portFIRST_USER_INTERRUPT_NUMBER );\r
237                 volatile unsigned char ucMaxPriorityValue;\r
238 \r
239                 /* Determine the maximum priority from which ISR safe FreeRTOS API\r
240                 functions can be called.  ISR safe functions are those that end in\r
241                 "FromISR".  FreeRTOS maintains separate thread and ISR API functions to\r
242                 ensure interrupt entry is as fast and simple as possible.\r
243 \r
244                 Save the interrupt priority value that is about to be clobbered. */\r
245                 ulOriginalPriority = *pcFirstUserPriorityRegister;\r
246 \r
247                 /* Determine the number of priority bits available.  First write to all\r
248                 possible bits. */\r
249                 *pcFirstUserPriorityRegister = portMAX_8_BIT_VALUE;\r
250 \r
251                 /* Read the value back to see how many bits stuck. */\r
252                 ucMaxPriorityValue = *pcFirstUserPriorityRegister;\r
253 \r
254                 /* Use the same mask on the maximum system call priority. */\r
255                 ucMaxSysCallPriority = configMAX_SYSCALL_INTERRUPT_PRIORITY & ucMaxPriorityValue;\r
256 \r
257                 /* Calculate the maximum acceptable priority group value for the number\r
258                 of bits read back. */\r
259                 ulMaxPRIGROUPValue = portMAX_PRIGROUP_BITS;\r
260                 while( ( ucMaxPriorityValue & portTOP_BIT_OF_BYTE ) == portTOP_BIT_OF_BYTE )\r
261                 {\r
262                         ulMaxPRIGROUPValue--;\r
263                         ucMaxPriorityValue <<= ( unsigned char ) 0x01;\r
264                 }\r
265 \r
266                 /* Shift the priority group value back to its position within the AIRCR\r
267                 register. */\r
268                 ulMaxPRIGROUPValue <<= portPRIGROUP_SHIFT;\r
269                 ulMaxPRIGROUPValue &= portPRIORITY_GROUP_MASK;\r
270 \r
271                 /* Restore the clobbered interrupt priority register to its original\r
272                 value. */\r
273                 *pcFirstUserPriorityRegister = ulOriginalPriority;\r
274         }\r
275         #endif /* conifgASSERT_DEFINED */\r
276 \r
277         /* Make PendSV and SysTick the lowest priority interrupts. */\r
278         portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;\r
279         portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;\r
280 \r
281         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
282         here already. */\r
283         vPortSetupTimerInterrupt();\r
284 \r
285         /* Initialise the critical nesting count ready for the first task. */\r
286         uxCriticalNesting = 0;\r
287 \r
288         /* Start the first task. */\r
289         vPortStartFirstTask();\r
290 \r
291         /* Should not get here! */\r
292         return 0;\r
293 }\r
294 /*-----------------------------------------------------------*/\r
295 \r
296 void vPortEndScheduler( void )\r
297 {\r
298         /* Not implemented in ports where there is nothing to return to.\r
299         Artificially force an assert. */\r
300         configASSERT( uxCriticalNesting == 1000UL );\r
301 }\r
302 /*-----------------------------------------------------------*/\r
303 \r
304 void vPortYield( void )\r
305 {\r
306         /* Set a PendSV to request a context switch. */\r
307         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
308 \r
309         /* Barriers are normally not required but do ensure the code is completely\r
310         within the specified behaviour for the architecture. */\r
311         __DSB();\r
312         __ISB();\r
313 }\r
314 /*-----------------------------------------------------------*/\r
315 \r
316 void vPortEnterCritical( void )\r
317 {\r
318         portDISABLE_INTERRUPTS();\r
319         uxCriticalNesting++;\r
320         __DSB();\r
321         __ISB();\r
322 }\r
323 /*-----------------------------------------------------------*/\r
324 \r
325 void vPortExitCritical( void )\r
326 {\r
327         configASSERT( uxCriticalNesting );\r
328         uxCriticalNesting--;\r
329         if( uxCriticalNesting == 0 )\r
330         {\r
331                 portENABLE_INTERRUPTS();\r
332         }\r
333 }\r
334 /*-----------------------------------------------------------*/\r
335 \r
336 void xPortSysTickHandler( void )\r
337 {\r
338         /* The SysTick runs at the lowest interrupt priority, so when this interrupt\r
339         executes all interrupts must be unmasked.  There is therefore no need to\r
340         save and then restore the interrupt mask value as its value is already\r
341         known. */\r
342         ( void ) portSET_INTERRUPT_MASK_FROM_ISR();\r
343         {\r
344                 /* Increment the RTOS tick. */\r
345                 if( xTaskIncrementTick() != pdFALSE )\r
346                 {\r
347                         /* A context switch is required.  Context switching is performed in\r
348                         the PendSV interrupt.  Pend the PendSV interrupt. */\r
349                         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
350                 }\r
351         }\r
352         portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );\r
353 }\r
354 /*-----------------------------------------------------------*/\r
355 \r
356 #if configUSE_TICKLESS_IDLE == 1\r
357 \r
358         __weak void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )\r
359         {\r
360         unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements;\r
361         portTickType xModifiableIdleTime;\r
362 \r
363                 /* Make sure the SysTick reload value does not overflow the counter. */\r
364                 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )\r
365                 {\r
366                         xExpectedIdleTime = xMaximumPossibleSuppressedTicks;\r
367                 }\r
368 \r
369                 /* Stop the SysTick momentarily.  The time the SysTick is stopped for\r
370                 is accounted for as best it can be, but using the tickless mode will\r
371                 inevitably result in some tiny drift of the time maintained by the\r
372                 kernel with respect to calendar time. */\r
373                 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;\r
374 \r
375                 /* Calculate the reload value required to wait xExpectedIdleTime\r
376                 tick periods.  -1 is used because this code will execute part way\r
377                 through one of the tick periods. */\r
378                 ulReloadValue = portNVIC_SYSTICK_CURRENT_VALUE_REG + ( ulTimerCountsForOneTick * ( xExpectedIdleTime - 1UL ) );\r
379                 if( ulReloadValue > ulStoppedTimerCompensation )\r
380                 {\r
381                         ulReloadValue -= ulStoppedTimerCompensation;\r
382                 }\r
383 \r
384                 /* Enter a critical section but don't use the taskENTER_CRITICAL()\r
385                 method as that will mask interrupts that should exit sleep mode. */\r
386                 __disable_interrupt();\r
387 \r
388                 /* If a context switch is pending or a task is waiting for the scheduler\r
389                 to be unsuspended then abandon the low power entry. */\r
390                 if( eTaskConfirmSleepModeStatus() == eAbortSleep )\r
391                 {\r
392                         /* Restart from whatever is left in the count register to complete\r
393                         this tick period. */\r
394                         portNVIC_SYSTICK_LOAD_REG = portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
395 \r
396                         /* Restart SysTick. */\r
397                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
398 \r
399                         /* Reset the reload register to the value required for normal tick\r
400                         periods. */\r
401                         portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
402 \r
403                         /* Re-enable interrupts - see comments above __disable_interrupt()\r
404                         call above. */\r
405                         __enable_interrupt();\r
406                 }\r
407                 else\r
408                 {\r
409                         /* Set the new reload value. */\r
410                         portNVIC_SYSTICK_LOAD_REG = ulReloadValue;\r
411 \r
412                         /* Clear the SysTick count flag and set the count value back to\r
413                         zero. */\r
414                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
415 \r
416                         /* Restart SysTick. */\r
417                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
418 \r
419                         /* Sleep until something happens.  configPRE_SLEEP_PROCESSING() can\r
420                         set its parameter to 0 to indicate that its implementation contains\r
421                         its own wait for interrupt or wait for event instruction, and so wfi\r
422                         should not be executed again.  However, the original expected idle\r
423                         time variable must remain unmodified, so a copy is taken. */\r
424                         xModifiableIdleTime = xExpectedIdleTime;\r
425                         configPRE_SLEEP_PROCESSING( xModifiableIdleTime );\r
426                         if( xModifiableIdleTime > 0 )\r
427                         {\r
428                                 __DSB();\r
429                                 __WFI();\r
430                                 __ISB();\r
431                         }\r
432                         configPOST_SLEEP_PROCESSING( xExpectedIdleTime );\r
433 \r
434                         /* Stop SysTick.  Again, the time the SysTick is stopped for is\r
435                         accounted for as best it can be, but using the tickless mode will\r
436                         inevitably result in some tiny drift of the time maintained by the\r
437                         kernel with respect to calendar time. */\r
438                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;\r
439 \r
440                         /* Re-enable interrupts - see comments above __disable_interrupt()\r
441                         call above. */\r
442                         __enable_interrupt();\r
443 \r
444                         if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
445                         {\r
446                                 unsigned long ulCalculatedLoadValue;\r
447 \r
448                                 /* The tick interrupt has already executed, and the SysTick\r
449                                 count reloaded with ulReloadValue.  Reset the\r
450                                 portNVIC_SYSTICK_LOAD_REG with whatever remains of this tick\r
451                                 period. */\r
452                                 ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL ) - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
453 \r
454                                 /* Don't allow a tiny value, or values that have somehow\r
455                                 underflowed because the post sleep hook did something\r
456                                 that took too long. */\r
457                                 if( ( ulCalculatedLoadValue < ulStoppedTimerCompensation ) || ( ulCalculatedLoadValue > ulTimerCountsForOneTick ) )\r
458                                 {\r
459                                         ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL );\r
460                                 }\r
461 \r
462                                 portNVIC_SYSTICK_LOAD_REG = ulCalculatedLoadValue;\r
463 \r
464                                 /* The tick interrupt handler will already have pended the tick\r
465                                 processing in the kernel.  As the pending tick will be\r
466                                 processed as soon as this function exits, the tick value\r
467                                 maintained by the tick is stepped forward by one less than the\r
468                                 time spent waiting. */\r
469                                 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
470                         }\r
471                         else\r
472                         {\r
473                                 /* Something other than the tick interrupt ended the sleep.\r
474                                 Work out how long the sleep lasted rounded to complete tick\r
475                                 periods (not the ulReload value which accounted for part\r
476                                 ticks). */\r
477                                 ulCompletedSysTickDecrements = ( xExpectedIdleTime * ulTimerCountsForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
478 \r
479                                 /* How many complete tick periods passed while the processor\r
480                                 was waiting? */\r
481                                 ulCompleteTickPeriods = ulCompletedSysTickDecrements / ulTimerCountsForOneTick;\r
482 \r
483                                 /* The reload value is set to whatever fraction of a single tick\r
484                                 period remains. */\r
485                                 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;\r
486                         }\r
487 \r
488                         /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG\r
489                         again, then set portNVIC_SYSTICK_LOAD_REG back to its standard\r
490                         value.  The critical section is used to ensure the tick interrupt\r
491                         can only execute once in the case that the reload register is near\r
492                         zero. */\r
493                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
494                         portENTER_CRITICAL();\r
495                         {\r
496                                 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
497                                 vTaskStepTick( ulCompleteTickPeriods );\r
498                                 portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
499                         }\r
500                         portEXIT_CRITICAL();\r
501                 }\r
502         }\r
503 \r
504 #endif /* #if configUSE_TICKLESS_IDLE */\r
505 /*-----------------------------------------------------------*/\r
506 \r
507 /*\r
508  * Setup the systick timer to generate the tick interrupts at the required\r
509  * frequency.\r
510  */\r
511 __weak void vPortSetupTimerInterrupt( void )\r
512 {\r
513         /* Calculate the constants required to configure the tick interrupt. */\r
514         #if configUSE_TICKLESS_IDLE == 1\r
515         {\r
516                 ulTimerCountsForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );\r
517                 xMaximumPossibleSuppressedTicks = portMAX_24_BIT_NUMBER / ulTimerCountsForOneTick;\r
518                 ulStoppedTimerCompensation = portMISSED_COUNTS_FACTOR / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
519         }\r
520         #endif /* configUSE_TICKLESS_IDLE */\r
521 \r
522         /* Configure SysTick to interrupt at the requested rate. */\r
523         portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;;\r
524         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
525 }\r
526 /*-----------------------------------------------------------*/\r
527 \r
528 #if( configASSERT_DEFINED == 1 )\r
529 \r
530         void vPortValidateInterruptPriority( void )\r
531         {\r
532         unsigned long ulCurrentInterrupt;\r
533         unsigned char ucCurrentPriority;\r
534 \r
535                 /* Obtain the number of the currently executing interrupt. */\r
536                 __asm volatile( "mrs %0, ipsr" : "=r"( ulCurrentInterrupt ) );\r
537 \r
538                 /* Is the interrupt number a user defined interrupt? */\r
539                 if( ulCurrentInterrupt >= portFIRST_USER_INTERRUPT_NUMBER )\r
540                 {\r
541                         /* Look up the interrupt's priority. */\r
542                         ucCurrentPriority = pcInterruptPriorityRegisters[ ulCurrentInterrupt ];\r
543 \r
544                         /* The following assertion will fail if a service routine (ISR) for\r
545                         an interrupt that has been assigned a priority above\r
546                         configMAX_SYSCALL_INTERRUPT_PRIORITY calls an ISR safe FreeRTOS API\r
547                         function.  ISR safe FreeRTOS API functions must *only* be called\r
548                         from interrupts that have been assigned a priority at or below\r
549                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
550 \r
551                         Numerically low interrupt priority numbers represent logically high\r
552                         interrupt priorities, therefore the priority of the interrupt must\r
553                         be set to a value equal to or numerically *higher* than\r
554                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
555 \r
556                         Interrupts that use the FreeRTOS API must not be left at their\r
557                         default priority of     zero as that is the highest possible priority,\r
558                         which is guaranteed to be above configMAX_SYSCALL_INTERRUPT_PRIORITY,\r
559                         and     therefore also guaranteed to be invalid.\r
560 \r
561                         FreeRTOS maintains separate thread and ISR API functions to ensure\r
562                         interrupt entry is as fast and simple as possible.\r
563 \r
564                         The following links provide detailed information:\r
565                         http://www.freertos.org/RTOS-Cortex-M3-M4.html\r
566                         http://www.freertos.org/FAQHelp.html */\r
567                         configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );\r
568                 }\r
569 \r
570                 /* Priority grouping:  The interrupt controller (NVIC) allows the bits\r
571                 that define each interrupt's priority to be split between bits that\r
572                 define the interrupt's pre-emption priority bits and bits that define\r
573                 the interrupt's sub-priority.  For simplicity all bits must be defined\r
574                 to be pre-emption priority bits.  The following assertion will fail if\r
575                 this is not the case (if some bits represent a sub-priority).\r
576 \r
577                 If the application only uses CMSIS libraries for interrupt\r
578                 configuration then the correct setting can be achieved on all Cortex-M\r
579                 devices by calling NVIC_SetPriorityGrouping( 0 ); before starting the\r
580                 scheduler.  Note however that some vendor specific peripheral libraries\r
581                 assume a non-zero priority group setting, in which cases using a value\r
582                 of zero will result in unpredicable behaviour. */\r
583                 configASSERT( ( portAIRCR_REG & portPRIORITY_GROUP_MASK ) <= ulMaxPRIGROUPValue );\r
584         }\r
585 \r
586 #endif /* configASSERT_DEFINED */\r
587 \r
588 \r
589 \r
590 \r
591 \r
592 \r
593 \r
594 \r
595 \r
596 \r
597 \r
598 \r
599 \r
600 \r
601 \r
602 \r
603 \r
604 \r
605 \r
606 \r
607 \r