2 * FreeRTOS SMP Kernel V202110.00
3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9 * the Software, and to permit persons to whom the Software is furnished to do so,
10 * subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 * https://www.FreeRTOS.org
23 * https://github.com/FreeRTOS
28 /* Standard includes. */
31 /* Scheduler includes. */
35 #ifndef configINTERRUPT_CONTROLLER_BASE_ADDRESS
36 #error configINTERRUPT_CONTROLLER_BASE_ADDRESS must be defined. See https://www.FreeRTOS.org/Using-FreeRTOS-on-Cortex-A-Embedded-Processors.html
39 #ifndef configINTERRUPT_CONTROLLER_CPU_INTERFACE_OFFSET
40 #error configINTERRUPT_CONTROLLER_CPU_INTERFACE_OFFSET must be defined. See https://www.FreeRTOS.org/Using-FreeRTOS-on-Cortex-A-Embedded-Processors.html
43 #ifndef configUNIQUE_INTERRUPT_PRIORITIES
44 #error configUNIQUE_INTERRUPT_PRIORITIES must be defined. See https://www.FreeRTOS.org/Using-FreeRTOS-on-Cortex-A-Embedded-Processors.html
47 #ifndef configSETUP_TICK_INTERRUPT
48 #error configSETUP_TICK_INTERRUPT() must be defined. See https://www.FreeRTOS.org/Using-FreeRTOS-on-Cortex-A-Embedded-Processors.html
49 #endif /* configSETUP_TICK_INTERRUPT */
51 #ifndef configMAX_API_CALL_INTERRUPT_PRIORITY
52 #error configMAX_API_CALL_INTERRUPT_PRIORITY must be defined. See https://www.FreeRTOS.org/Using-FreeRTOS-on-Cortex-A-Embedded-Processors.html
55 #if configMAX_API_CALL_INTERRUPT_PRIORITY == 0
56 #error configMAX_API_CALL_INTERRUPT_PRIORITY must not be set to 0
59 #if configMAX_API_CALL_INTERRUPT_PRIORITY > configUNIQUE_INTERRUPT_PRIORITIES
60 #error configMAX_API_CALL_INTERRUPT_PRIORITY must be less than or equal to configUNIQUE_INTERRUPT_PRIORITIES as the lower the numeric priority value the higher the logical interrupt priority
63 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
64 /* Check the configuration. */
65 #if( configMAX_PRIORITIES > 32 )
66 #error configUSE_PORT_OPTIMISED_TASK_SELECTION can only be set to 1 when configMAX_PRIORITIES is less than or equal to 32. It is very rare that a system requires more than 10 to 15 difference priorities as tasks that share a priority will time slice.
68 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
70 /* In case security extensions are implemented. */
71 #if configMAX_API_CALL_INTERRUPT_PRIORITY <= ( configUNIQUE_INTERRUPT_PRIORITIES / 2 )
72 #error configMAX_API_CALL_INTERRUPT_PRIORITY must be greater than ( configUNIQUE_INTERRUPT_PRIORITIES / 2 )
75 /* Some vendor specific files default configCLEAR_TICK_INTERRUPT() in
77 #ifndef configCLEAR_TICK_INTERRUPT
78 #define configCLEAR_TICK_INTERRUPT()
81 /* A critical section is exited when the critical section nesting count reaches
83 #define portNO_CRITICAL_NESTING ( ( size_t ) 0 )
85 /* In all GICs 255 can be written to the priority mask register to unmask all
86 (but the lowest) interrupt priority. */
87 #define portUNMASK_VALUE ( 0xFFUL )
89 /* Tasks are not created with a floating point context, but can be given a
90 floating point context after they have been created. A variable is stored as
91 part of the tasks context that holds portNO_FLOATING_POINT_CONTEXT if the task
92 does not have an FPU context, or any other value if the task does have an FPU
94 #define portNO_FLOATING_POINT_CONTEXT ( ( StackType_t ) 0 )
96 /* Constants required to setup the initial task context. */
97 #define portSP_ELx ( ( StackType_t ) 0x01 )
98 #define portSP_EL0 ( ( StackType_t ) 0x00 )
101 #define portEL1 ( ( StackType_t ) 0x04 )
102 #define portINITIAL_PSTATE ( portEL1 | portSP_EL0 )
104 #define portEL3 ( ( StackType_t ) 0x0c )
105 /* At the time of writing, the BSP only supports EL3. */
106 #define portINITIAL_PSTATE ( portEL3 | portSP_EL0 )
110 /* Used by portASSERT_IF_INTERRUPT_PRIORITY_INVALID() when ensuring the binary
112 #define portBINARY_POINT_BITS ( ( uint8_t ) 0x03 )
114 /* Masks all bits in the APSR other than the mode bits. */
115 #define portAPSR_MODE_BITS_MASK ( 0x0C )
117 /* The I bit in the DAIF bits. */
118 #define portDAIF_I ( 0x80 )
120 /* Macro to unmask all interrupt priorities. */
121 #define portCLEAR_INTERRUPT_MASK() \
123 portDISABLE_INTERRUPTS(); \
124 portICCPMR_PRIORITY_MASK_REGISTER = portUNMASK_VALUE; \
125 __asm volatile ( "DSB SY \n" \
127 portENABLE_INTERRUPTS(); \
130 /* Hardware specifics used when sanity checking the configuration. */
131 #define portINTERRUPT_PRIORITY_REGISTER_OFFSET 0x400UL
132 #define portMAX_8_BIT_VALUE ( ( uint8_t ) 0xff )
133 #define portBIT_0_SET ( ( uint8_t ) 0x01 )
135 /*-----------------------------------------------------------*/
138 * Starts the first task executing. This function is necessarily written in
139 * assembly code so is implemented in portASM.s.
141 extern void vPortRestoreTaskContext( void );
143 /*-----------------------------------------------------------*/
145 /* A variable is used to keep track of the critical section nesting. This
146 variable has to be stored as part of the task context and must be initialised to
147 a non zero value to ensure interrupts don't inadvertently become unmasked before
148 the scheduler starts. As it is stored as part of the task context it will
149 automatically be set to 0 when the first task is started. */
150 volatile uint64_t ullCriticalNesting = 9999ULL;
152 /* Saved as part of the task context. If ullPortTaskHasFPUContext is non-zero
153 then floating point context must be saved and restored for the task. */
154 uint64_t ullPortTaskHasFPUContext = pdFALSE;
156 /* Set to 1 to pend a context switch from an ISR. */
157 uint64_t ullPortYieldRequired = pdFALSE;
159 /* Counts the interrupt nesting depth. A context switch is only performed if
160 if the nesting depth is 0. */
161 uint64_t ullPortInterruptNesting = 0;
163 /* Used in the ASM code. */
164 __attribute__(( used )) const uint64_t ullICCEOIR = portICCEOIR_END_OF_INTERRUPT_REGISTER_ADDRESS;
165 __attribute__(( used )) const uint64_t ullICCIAR = portICCIAR_INTERRUPT_ACKNOWLEDGE_REGISTER_ADDRESS;
166 __attribute__(( used )) const uint64_t ullICCPMR = portICCPMR_PRIORITY_MASK_REGISTER_ADDRESS;
167 __attribute__(( used )) const uint64_t ullMaxAPIPriorityMask = ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT );
169 /*-----------------------------------------------------------*/
172 * See header file for description.
174 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )
176 /* Setup the initial stack of the task. The stack is set exactly as
177 expected by the portRESTORE_CONTEXT() macro. */
179 /* First all the general purpose registers. */
181 *pxTopOfStack = 0x0101010101010101ULL; /* R1 */
183 *pxTopOfStack = ( StackType_t ) pvParameters; /* R0 */
185 *pxTopOfStack = 0x0303030303030303ULL; /* R3 */
187 *pxTopOfStack = 0x0202020202020202ULL; /* R2 */
189 *pxTopOfStack = 0x0505050505050505ULL; /* R5 */
191 *pxTopOfStack = 0x0404040404040404ULL; /* R4 */
193 *pxTopOfStack = 0x0707070707070707ULL; /* R7 */
195 *pxTopOfStack = 0x0606060606060606ULL; /* R6 */
197 *pxTopOfStack = 0x0909090909090909ULL; /* R9 */
199 *pxTopOfStack = 0x0808080808080808ULL; /* R8 */
201 *pxTopOfStack = 0x1111111111111111ULL; /* R11 */
203 *pxTopOfStack = 0x1010101010101010ULL; /* R10 */
205 *pxTopOfStack = 0x1313131313131313ULL; /* R13 */
207 *pxTopOfStack = 0x1212121212121212ULL; /* R12 */
209 *pxTopOfStack = 0x1515151515151515ULL; /* R15 */
211 *pxTopOfStack = 0x1414141414141414ULL; /* R14 */
213 *pxTopOfStack = 0x1717171717171717ULL; /* R17 */
215 *pxTopOfStack = 0x1616161616161616ULL; /* R16 */
217 *pxTopOfStack = 0x1919191919191919ULL; /* R19 */
219 *pxTopOfStack = 0x1818181818181818ULL; /* R18 */
221 *pxTopOfStack = 0x2121212121212121ULL; /* R21 */
223 *pxTopOfStack = 0x2020202020202020ULL; /* R20 */
225 *pxTopOfStack = 0x2323232323232323ULL; /* R23 */
227 *pxTopOfStack = 0x2222222222222222ULL; /* R22 */
229 *pxTopOfStack = 0x2525252525252525ULL; /* R25 */
231 *pxTopOfStack = 0x2424242424242424ULL; /* R24 */
233 *pxTopOfStack = 0x2727272727272727ULL; /* R27 */
235 *pxTopOfStack = 0x2626262626262626ULL; /* R26 */
237 *pxTopOfStack = 0x2929292929292929ULL; /* R29 */
239 *pxTopOfStack = 0x2828282828282828ULL; /* R28 */
241 *pxTopOfStack = ( StackType_t ) 0x00; /* XZR - has no effect, used so there are an even number of registers. */
243 *pxTopOfStack = ( StackType_t ) 0x00; /* R30 - procedure call link register. */
246 *pxTopOfStack = portINITIAL_PSTATE;
249 *pxTopOfStack = ( StackType_t ) pxCode; /* Exception return address. */
252 /* The task will start with a critical nesting count of 0 as interrupts are
254 *pxTopOfStack = portNO_CRITICAL_NESTING;
257 /* The task will start without a floating point context. A task that uses
258 the floating point hardware must call vPortTaskUsesFPU() before executing
259 any floating point instructions. */
260 *pxTopOfStack = portNO_FLOATING_POINT_CONTEXT;
264 /*-----------------------------------------------------------*/
266 BaseType_t xPortStartScheduler( void )
270 #if( configASSERT_DEFINED == 1 )
272 volatile uint32_t ulOriginalPriority;
273 volatile uint8_t * const pucFirstUserPriorityRegister = ( volatile uint8_t * const ) ( configINTERRUPT_CONTROLLER_BASE_ADDRESS + portINTERRUPT_PRIORITY_REGISTER_OFFSET );
274 volatile uint8_t ucMaxPriorityValue;
276 /* Determine how many priority bits are implemented in the GIC.
278 Save the interrupt priority value that is about to be clobbered. */
279 ulOriginalPriority = *pucFirstUserPriorityRegister;
281 /* Determine the number of priority bits available. First write to
282 all possible bits. */
283 *pucFirstUserPriorityRegister = portMAX_8_BIT_VALUE;
285 /* Read the value back to see how many bits stuck. */
286 ucMaxPriorityValue = *pucFirstUserPriorityRegister;
288 /* Shift to the least significant bits. */
289 while( ( ucMaxPriorityValue & portBIT_0_SET ) != portBIT_0_SET )
291 ucMaxPriorityValue >>= ( uint8_t ) 0x01;
294 /* Sanity check configUNIQUE_INTERRUPT_PRIORITIES matches the read
297 configASSERT( ucMaxPriorityValue >= portLOWEST_INTERRUPT_PRIORITY );
300 /* Restore the clobbered interrupt priority register to its original
302 *pucFirstUserPriorityRegister = ulOriginalPriority;
304 #endif /* conifgASSERT_DEFINED */
307 /* At the time of writing, the BSP only supports EL3. */
308 __asm volatile ( "MRS %0, CurrentEL" : "=r" ( ulAPSR ) );
309 ulAPSR &= portAPSR_MODE_BITS_MASK;
312 #warning Building for execution as a guest under XEN. THIS IS NOT A FULLY TESTED PATH.
313 configASSERT( ulAPSR == portEL1 );
314 if( ulAPSR == portEL1 )
316 configASSERT( ulAPSR == portEL3 );
317 if( ulAPSR == portEL3 )
320 /* Only continue if the binary point value is set to its lowest possible
321 setting. See the comments in vPortValidateInterruptPriority() below for
323 configASSERT( ( portICCBPR_BINARY_POINT_REGISTER & portBINARY_POINT_BITS ) <= portMAX_BINARY_POINT_VALUE );
325 if( ( portICCBPR_BINARY_POINT_REGISTER & portBINARY_POINT_BITS ) <= portMAX_BINARY_POINT_VALUE )
327 /* Interrupts are turned off in the CPU itself to ensure a tick does
328 not execute while the scheduler is being started. Interrupts are
329 automatically turned back on in the CPU when the first task starts
331 portDISABLE_INTERRUPTS();
333 /* Start the timer that generates the tick ISR. */
334 configSETUP_TICK_INTERRUPT();
336 /* Start the first task executing. */
337 vPortRestoreTaskContext();
343 /*-----------------------------------------------------------*/
345 void vPortEndScheduler( void )
347 /* Not implemented in ports where there is nothing to return to.
348 Artificially force an assert. */
349 configASSERT( ullCriticalNesting == 1000ULL );
351 /*-----------------------------------------------------------*/
353 void vPortEnterCritical( void )
355 /* Mask interrupts up to the max syscall interrupt priority. */
356 uxPortSetInterruptMask();
358 /* Now interrupts are disabled ullCriticalNesting can be accessed
359 directly. Increment ullCriticalNesting to keep a count of how many times
360 portENTER_CRITICAL() has been called. */
361 ullCriticalNesting++;
363 /* This is not the interrupt safe version of the enter critical function so
364 assert() if it is being called from an interrupt context. Only API
365 functions that end in "FromISR" can be used in an interrupt. Only assert if
366 the critical nesting count is 1 to protect against recursive calls if the
367 assert function also uses a critical section. */
368 if( ullCriticalNesting == 1ULL )
370 configASSERT( ullPortInterruptNesting == 0 );
373 /*-----------------------------------------------------------*/
375 void vPortExitCritical( void )
377 if( ullCriticalNesting > portNO_CRITICAL_NESTING )
379 /* Decrement the nesting count as the critical section is being
381 ullCriticalNesting--;
383 /* If the nesting level has reached zero then all interrupt
384 priorities must be re-enabled. */
385 if( ullCriticalNesting == portNO_CRITICAL_NESTING )
387 /* Critical nesting has reached zero so all interrupt priorities
388 should be unmasked. */
389 portCLEAR_INTERRUPT_MASK();
393 /*-----------------------------------------------------------*/
395 void FreeRTOS_Tick_Handler( void )
397 /* Must be the lowest possible priority. */
400 configASSERT( portICCRPR_RUNNING_PRIORITY_REGISTER == ( uint32_t ) ( portLOWEST_USABLE_INTERRUPT_PRIORITY << portPRIORITY_SHIFT ) );
404 /* Interrupts should not be enabled before this point. */
405 #if( configASSERT_DEFINED == 1 )
409 __asm volatile( "mrs %0, daif" : "=r"( ulMaskBits ) :: "memory" );
410 configASSERT( ( ulMaskBits & portDAIF_I ) != 0 );
412 #endif /* configASSERT_DEFINED */
414 /* Set interrupt mask before altering scheduler structures. The tick
415 handler runs at the lowest priority, so interrupts cannot already be masked,
416 so there is no need to save and restore the current mask value. It is
417 necessary to turn off interrupts in the CPU itself while the ICCPMR is being
419 portICCPMR_PRIORITY_MASK_REGISTER = ( uint32_t ) ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT );
420 __asm volatile ( "dsb sy \n"
421 "isb sy \n" ::: "memory" );
423 /* Ok to enable interrupts after the interrupt source has been cleared. */
424 configCLEAR_TICK_INTERRUPT();
425 portENABLE_INTERRUPTS();
427 /* Increment the RTOS tick. */
428 if( xTaskIncrementTick() != pdFALSE )
430 ullPortYieldRequired = pdTRUE;
433 /* Ensure all interrupt priorities are active again. */
434 portCLEAR_INTERRUPT_MASK();
436 /*-----------------------------------------------------------*/
438 void vPortTaskUsesFPU( void )
440 /* A task is registering the fact that it needs an FPU context. Set the
441 FPU flag (which is saved as part of the task context). */
442 ullPortTaskHasFPUContext = pdTRUE;
444 /* Consider initialising the FPSR here - but probably not necessary in
447 /*-----------------------------------------------------------*/
449 void vPortClearInterruptMask( UBaseType_t uxNewMaskValue )
451 if( uxNewMaskValue == pdFALSE )
453 portCLEAR_INTERRUPT_MASK();
456 /*-----------------------------------------------------------*/
458 UBaseType_t uxPortSetInterruptMask( void )
462 /* Interrupt in the CPU must be turned off while the ICCPMR is being
464 portDISABLE_INTERRUPTS();
465 if( portICCPMR_PRIORITY_MASK_REGISTER == ( uint32_t ) ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT ) )
467 /* Interrupts were already masked. */
473 portICCPMR_PRIORITY_MASK_REGISTER = ( uint32_t ) ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT );
474 __asm volatile ( "dsb sy \n"
475 "isb sy \n" ::: "memory" );
477 portENABLE_INTERRUPTS();
481 /*-----------------------------------------------------------*/
483 #if( configASSERT_DEFINED == 1 )
485 void vPortValidateInterruptPriority( void )
487 /* The following assertion will fail if a service routine (ISR) for
488 an interrupt that has been assigned a priority above
489 configMAX_SYSCALL_INTERRUPT_PRIORITY calls an ISR safe FreeRTOS API
490 function. ISR safe FreeRTOS API functions must *only* be called
491 from interrupts that have been assigned a priority at or below
492 configMAX_SYSCALL_INTERRUPT_PRIORITY.
494 Numerically low interrupt priority numbers represent logically high
495 interrupt priorities, therefore the priority of the interrupt must
496 be set to a value equal to or numerically *higher* than
497 configMAX_SYSCALL_INTERRUPT_PRIORITY.
499 FreeRTOS maintains separate thread and ISR API functions to ensure
500 interrupt entry is as fast and simple as possible. */
501 configASSERT( portICCRPR_RUNNING_PRIORITY_REGISTER >= ( uint32_t ) ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT ) );
503 /* Priority grouping: The interrupt controller (GIC) allows the bits
504 that define each interrupt's priority to be split between bits that
505 define the interrupt's pre-emption priority bits and bits that define
506 the interrupt's sub-priority. For simplicity all bits must be defined
507 to be pre-emption priority bits. The following assertion will fail if
508 this is not the case (if some bits represent a sub-priority).
510 The priority grouping is configured by the GIC's binary point register
511 (ICCBPR). Writting 0 to ICCBPR will ensure it is set to its lowest
512 possible value (which may be above 0). */
513 configASSERT( ( portICCBPR_BINARY_POINT_REGISTER & portBINARY_POINT_BITS ) <= portMAX_BINARY_POINT_VALUE );
516 #endif /* configASSERT_DEFINED */
517 /*-----------------------------------------------------------*/