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