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