2 * FreeRTOS Kernel V10.3.1
\r
3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
\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
12 * The above copyright notice and this permission notice shall be included in all
\r
13 * copies or substantial portions of the Software.
\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
22 * http://www.FreeRTOS.org
\r
23 * http://aws.amazon.com/freertos
\r
27 /* Standard includes. */
\r
30 /* Scheduler includes. */
\r
31 #include "FreeRTOS.h"
\r
34 #ifndef configINTERRUPT_CONTROLLER_BASE_ADDRESS
\r
35 #error configINTERRUPT_CONTROLLER_BASE_ADDRESS must be defined. See http: /*www.freertos.org/Using-FreeRTOS-on-Cortex-A-Embedded-Processors.html */
\r
38 #ifndef configINTERRUPT_CONTROLLER_CPU_INTERFACE_OFFSET
\r
39 #error configINTERRUPT_CONTROLLER_CPU_INTERFACE_OFFSET must be defined. See http: /*www.freertos.org/Using-FreeRTOS-on-Cortex-A-Embedded-Processors.html */
\r
42 #ifndef configUNIQUE_INTERRUPT_PRIORITIES
\r
43 #error configUNIQUE_INTERRUPT_PRIORITIES must be defined. See http: /*www.freertos.org/Using-FreeRTOS-on-Cortex-A-Embedded-Processors.html */
\r
46 #ifndef configSETUP_TICK_INTERRUPT
\r
47 #error configSETUP_TICK_INTERRUPT() must be defined. See http: /*www.freertos.org/Using-FreeRTOS-on-Cortex-A-Embedded-Processors.html */
\r
48 #endif /* configSETUP_TICK_INTERRUPT */
\r
50 #ifndef configMAX_API_CALL_INTERRUPT_PRIORITY
\r
51 #error configMAX_API_CALL_INTERRUPT_PRIORITY must be defined. See http: /*www.freertos.org/Using-FreeRTOS-on-Cortex-A-Embedded-Processors.html */
\r
54 #if configMAX_API_CALL_INTERRUPT_PRIORITY == 0
\r
55 #error configMAX_API_CALL_INTERRUPT_PRIORITY must not be set to 0
\r
58 #if configMAX_API_CALL_INTERRUPT_PRIORITY > configUNIQUE_INTERRUPT_PRIORITIES
\r
59 #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
\r
62 #if configUSE_PORT_OPTIMISED_TASK_SELECTION == 1
\r
63 /* Check the configuration. */
\r
64 #if ( configMAX_PRIORITIES > 32 )
\r
65 #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.
\r
67 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
\r
69 /* In case security extensions are implemented. */
\r
70 #if configMAX_API_CALL_INTERRUPT_PRIORITY <= ( configUNIQUE_INTERRUPT_PRIORITIES / 2 )
\r
71 #error configMAX_API_CALL_INTERRUPT_PRIORITY must be greater than ( configUNIQUE_INTERRUPT_PRIORITIES / 2 )
\r
74 #ifndef configCLEAR_TICK_INTERRUPT
\r
75 #define configCLEAR_TICK_INTERRUPT()
\r
78 /* The number of bits to shift for an interrupt priority is dependent on the
\r
79 * number of bits implemented by the interrupt controller. */
\r
80 #if configUNIQUE_INTERRUPT_PRIORITIES == 16
\r
81 #define portPRIORITY_SHIFT 4
\r
82 #define portMAX_BINARY_POINT_VALUE 3
\r
83 #elif configUNIQUE_INTERRUPT_PRIORITIES == 32
\r
84 #define portPRIORITY_SHIFT 3
\r
85 #define portMAX_BINARY_POINT_VALUE 2
\r
86 #elif configUNIQUE_INTERRUPT_PRIORITIES == 64
\r
87 #define portPRIORITY_SHIFT 2
\r
88 #define portMAX_BINARY_POINT_VALUE 1
\r
89 #elif configUNIQUE_INTERRUPT_PRIORITIES == 128
\r
90 #define portPRIORITY_SHIFT 1
\r
91 #define portMAX_BINARY_POINT_VALUE 0
\r
92 #elif configUNIQUE_INTERRUPT_PRIORITIES == 256
\r
93 #define portPRIORITY_SHIFT 0
\r
94 #define portMAX_BINARY_POINT_VALUE 0
\r
95 #else /* if configUNIQUE_INTERRUPT_PRIORITIES == 16 */
\r
96 #error Invalid configUNIQUE_INTERRUPT_PRIORITIES setting. configUNIQUE_INTERRUPT_PRIORITIES must be set to the number of unique priorities implemented by the target hardware
\r
97 #endif /* if configUNIQUE_INTERRUPT_PRIORITIES == 16 */
\r
99 /* A critical section is exited when the critical section nesting count reaches
\r
101 #define portNO_CRITICAL_NESTING ( ( uint32_t ) 0 )
\r
103 /* In all GICs 255 can be written to the priority mask register to unmask all
\r
104 * (but the lowest) interrupt priority. */
\r
105 #define portUNMASK_VALUE ( 0xFFUL )
\r
107 /* Tasks are not created with a floating point context, but can be given a
\r
108 * floating point context after they have been created. A variable is stored as
\r
109 * part of the tasks context that holds portNO_FLOATING_POINT_CONTEXT if the task
\r
110 * does not have an FPU context, or any other value if the task does have an FPU
\r
112 #define portNO_FLOATING_POINT_CONTEXT ( ( StackType_t ) 0 )
\r
114 /* Interrupt controller access addresses. */
\r
115 #define portICCPMR_PRIORITY_MASK_OFFSET ( 0x04 )
\r
116 #define portICCIAR_INTERRUPT_ACKNOWLEDGE_OFFSET ( 0x0C )
\r
117 #define portICCEOIR_END_OF_INTERRUPT_OFFSET ( 0x10 )
\r
118 #define portICCBPR_BINARY_POINT_OFFSET ( 0x08 )
\r
119 #define portICCRPR_RUNNING_PRIORITY_OFFSET ( 0x14 )
\r
120 #define portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS ( configINTERRUPT_CONTROLLER_BASE_ADDRESS + configINTERRUPT_CONTROLLER_CPU_INTERFACE_OFFSET )
\r
121 #define portICCPMR_PRIORITY_MASK_REGISTER ( *( ( volatile uint32_t * ) ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCPMR_PRIORITY_MASK_OFFSET ) ) )
\r
122 #define portICCIAR_INTERRUPT_ACKNOWLEDGE_REGISTER_ADDRESS ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCIAR_INTERRUPT_ACKNOWLEDGE_OFFSET )
\r
123 #define portICCEOIR_END_OF_INTERRUPT_REGISTER_ADDRESS ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCEOIR_END_OF_INTERRUPT_OFFSET )
\r
124 #define portICCPMR_PRIORITY_MASK_REGISTER_ADDRESS ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCPMR_PRIORITY_MASK_OFFSET )
\r
125 #define portICCBPR_BINARY_POINT_REGISTER ( *( ( const volatile uint32_t * ) ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCBPR_BINARY_POINT_OFFSET ) ) )
\r
126 #define portICCRPR_RUNNING_PRIORITY_REGISTER ( *( ( const volatile uint32_t * ) ( portINTERRUPT_CONTROLLER_CPU_INTERFACE_ADDRESS + portICCRPR_RUNNING_PRIORITY_OFFSET ) ) )
\r
128 /* Used by portASSERT_IF_INTERRUPT_PRIORITY_INVALID() when ensuring the binary
\r
129 * point is zero. */
\r
130 #define portBINARY_POINT_BITS ( ( uint8_t ) 0x03 )
\r
132 /* Constants required to setup the initial task context. */
\r
133 #define portINITIAL_SPSR ( ( StackType_t ) 0x1f ) /* System mode, ARM mode, interrupts enabled. */
\r
134 #define portTHUMB_MODE_BIT ( ( StackType_t ) 0x20 )
\r
135 #define portTHUMB_MODE_ADDRESS ( 0x01UL )
\r
137 /* Masks all bits in the APSR other than the mode bits. */
\r
138 #define portAPSR_MODE_BITS_MASK ( 0x1F )
\r
140 /* The value of the mode bits in the APSR when the CPU is executing in user
\r
142 #define portAPSR_USER_MODE ( 0x10 )
\r
144 /* Macro to unmask all interrupt priorities. */
\r
145 #define portCLEAR_INTERRUPT_MASK() \
\r
148 portICCPMR_PRIORITY_MASK_REGISTER = portUNMASK_VALUE; \
\r
154 /*-----------------------------------------------------------*/
\r
157 * Starts the first task executing. This function is necessarily written in
\r
158 * assembly code so is implemented in portASM.s.
\r
160 extern void vPortRestoreTaskContext( void );
\r
163 * Used to catch tasks that attempt to return from their implementing function.
\r
165 static void prvTaskExitError( void );
\r
167 /*-----------------------------------------------------------*/
\r
169 /* A variable is used to keep track of the critical section nesting. This
\r
170 * variable has to be stored as part of the task context and must be initialised to
\r
171 * a non zero value to ensure interrupts don't inadvertently become unmasked before
\r
172 * the scheduler starts. As it is stored as part of the task context it will
\r
173 * automatically be set to 0 when the first task is started. */
\r
174 volatile uint32_t ulCriticalNesting = 9999UL;
\r
176 /* Used to pass constants into the ASM code. The address at which variables are
\r
177 * placed is the constant value so indirect loads in the asm code are not
\r
179 uint32_t ulICCIAR __attribute__( ( at( portICCIAR_INTERRUPT_ACKNOWLEDGE_REGISTER_ADDRESS ) ) );
\r
180 uint32_t ulICCEOIR __attribute__( ( at( portICCEOIR_END_OF_INTERRUPT_REGISTER_ADDRESS ) ) );
\r
181 uint32_t ulICCPMR __attribute__( ( at( portICCPMR_PRIORITY_MASK_REGISTER_ADDRESS ) ) );
\r
182 uint32_t ulAsmAPIPriorityMask __attribute__( ( at( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT ) ) );
\r
184 /* Saved as part of the task context. If ulPortTaskHasFPUContext is non-zero then
\r
185 * a floating point context must be saved and restored for the task. */
\r
186 uint32_t ulPortTaskHasFPUContext = pdFALSE;
\r
188 /* Set to 1 to pend a context switch from an ISR. */
\r
189 uint32_t ulPortYieldRequired = pdFALSE;
\r
191 /* Counts the interrupt nesting depth. A context switch is only performed if
\r
192 * if the nesting depth is 0. */
\r
193 uint32_t ulPortInterruptNesting = 0UL;
\r
195 /*-----------------------------------------------------------*/
\r
198 * See header file for description.
\r
200 StackType_t * pxPortInitialiseStack( StackType_t * pxTopOfStack,
\r
201 TaskFunction_t pxCode,
\r
202 void * pvParameters )
\r
204 /* Setup the initial stack of the task. The stack is set exactly as
\r
205 * expected by the portRESTORE_CONTEXT() macro.
\r
207 * The fist real value on the stack is the status register, which is set for
\r
208 * system mode, with interrupts enabled. A few NULLs are added first to ensure
\r
209 * GDB does not try decoding a non-existent return address. */
\r
210 *pxTopOfStack = NULL;
\r
212 *pxTopOfStack = NULL;
\r
214 *pxTopOfStack = NULL;
\r
216 *pxTopOfStack = ( StackType_t ) portINITIAL_SPSR;
\r
218 if( ( ( uint32_t ) pxCode & portTHUMB_MODE_ADDRESS ) != 0x00UL )
\r
220 /* The task will start in THUMB mode. */
\r
221 *pxTopOfStack |= portTHUMB_MODE_BIT;
\r
226 /* Next the return address, which in this case is the start of the task. */
\r
227 *pxTopOfStack = ( StackType_t ) pxCode;
\r
230 /* Next all the registers other than the stack pointer. */
\r
231 *pxTopOfStack = ( StackType_t ) prvTaskExitError; /* R14 */
\r
233 *pxTopOfStack = ( StackType_t ) 0x12121212; /* R12 */
\r
235 *pxTopOfStack = ( StackType_t ) 0x11111111; /* R11 */
\r
237 *pxTopOfStack = ( StackType_t ) 0x10101010; /* R10 */
\r
239 *pxTopOfStack = ( StackType_t ) 0x09090909; /* R9 */
\r
241 *pxTopOfStack = ( StackType_t ) 0x08080808; /* R8 */
\r
243 *pxTopOfStack = ( StackType_t ) 0x07070707; /* R7 */
\r
245 *pxTopOfStack = ( StackType_t ) 0x06060606; /* R6 */
\r
247 *pxTopOfStack = ( StackType_t ) 0x05050505; /* R5 */
\r
249 *pxTopOfStack = ( StackType_t ) 0x04040404; /* R4 */
\r
251 *pxTopOfStack = ( StackType_t ) 0x03030303; /* R3 */
\r
253 *pxTopOfStack = ( StackType_t ) 0x02020202; /* R2 */
\r
255 *pxTopOfStack = ( StackType_t ) 0x01010101; /* R1 */
\r
257 *pxTopOfStack = ( StackType_t ) pvParameters; /* R0 */
\r
260 /* The task will start with a critical nesting count of 0 as interrupts are
\r
262 *pxTopOfStack = portNO_CRITICAL_NESTING;
\r
265 /* The task will start without a floating point context. A task that uses
\r
266 * the floating point hardware must call vPortTaskUsesFPU() before executing
\r
267 * any floating point instructions. */
\r
268 *pxTopOfStack = portNO_FLOATING_POINT_CONTEXT;
\r
270 return pxTopOfStack;
\r
272 /*-----------------------------------------------------------*/
\r
274 static void prvTaskExitError( void )
\r
276 /* A function that implements a task must not exit or attempt to return to
\r
277 * its caller as there is nothing to return to. If a task wants to exit it
\r
278 * should instead call vTaskDelete( NULL ).
\r
280 * Artificially force an assert() to be triggered if configASSERT() is
\r
281 * defined, then stop here so application writers can catch the error. */
\r
282 configASSERT( ulPortInterruptNesting == ~0UL );
\r
283 portDISABLE_INTERRUPTS();
\r
289 /*-----------------------------------------------------------*/
\r
291 BaseType_t xPortStartScheduler( void )
\r
295 /* Only continue if the CPU is not in User mode. The CPU must be in a
\r
296 * Privileged mode for the scheduler to start. */
\r
297 __asm( "MRS ulAPSR, APSR" );
\r
298 ulAPSR &= portAPSR_MODE_BITS_MASK;
\r
299 configASSERT( ulAPSR != portAPSR_USER_MODE );
\r
301 if( ulAPSR != portAPSR_USER_MODE )
\r
303 /* Only continue if the binary point value is set to its lowest possible
\r
304 * setting. See the comments in vPortValidateInterruptPriority() below for
\r
305 * more information. */
\r
306 configASSERT( ( portICCBPR_BINARY_POINT_REGISTER & portBINARY_POINT_BITS ) <= portMAX_BINARY_POINT_VALUE );
\r
308 if( ( portICCBPR_BINARY_POINT_REGISTER & portBINARY_POINT_BITS ) <= portMAX_BINARY_POINT_VALUE )
\r
310 /* Start the timer that generates the tick ISR. */
\r
311 configSETUP_TICK_INTERRUPT();
\r
314 vPortRestoreTaskContext();
\r
318 /* Will only get here if vTaskStartScheduler() was called with the CPU in
\r
319 * a non-privileged mode or the binary point register was not set to its lowest
\r
320 * possible value. */
\r
323 /*-----------------------------------------------------------*/
\r
325 void vPortEndScheduler( void )
\r
327 /* Not implemented in ports where there is nothing to return to.
\r
328 * Artificially force an assert. */
\r
329 configASSERT( ulCriticalNesting == 1000UL );
\r
331 /*-----------------------------------------------------------*/
\r
333 void vPortEnterCritical( void )
\r
335 /* Disable interrupts as per portDISABLE_INTERRUPTS(); */
\r
336 ulPortSetInterruptMask();
\r
338 /* Now interrupts are disabled ulCriticalNesting can be accessed
\r
339 * directly. Increment ulCriticalNesting to keep a count of how many times
\r
340 * portENTER_CRITICAL() has been called. */
\r
341 ulCriticalNesting++;
\r
343 /* This is not the interrupt safe version of the enter critical function so
\r
344 * assert() if it is being called from an interrupt context. Only API
\r
345 * functions that end in "FromISR" can be used in an interrupt. Only assert if
\r
346 * the critical nesting count is 1 to protect against recursive calls if the
\r
347 * assert function also uses a critical section. */
\r
348 if( ulCriticalNesting == 1 )
\r
350 configASSERT( ulPortInterruptNesting == 0 );
\r
353 /*-----------------------------------------------------------*/
\r
355 void vPortExitCritical( void )
\r
357 if( ulCriticalNesting > portNO_CRITICAL_NESTING )
\r
359 /* Decrement the nesting count as the critical section is being
\r
361 ulCriticalNesting--;
\r
363 /* If the nesting level has reached zero then all interrupt
\r
364 * priorities must be re-enabled. */
\r
365 if( ulCriticalNesting == portNO_CRITICAL_NESTING )
\r
367 /* Critical nesting has reached zero so all interrupt priorities
\r
368 * should be unmasked. */
\r
369 portCLEAR_INTERRUPT_MASK();
\r
373 /*-----------------------------------------------------------*/
\r
375 void FreeRTOS_Tick_Handler( void )
\r
377 /* Set interrupt mask before altering scheduler structures. The tick
\r
378 * handler runs at the lowest priority, so interrupts cannot already be masked,
\r
379 * so there is no need to save and restore the current mask value. */
\r
381 portICCPMR_PRIORITY_MASK_REGISTER = ( uint32_t ) ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT );
\r
386 /* Increment the RTOS tick. */
\r
387 if( xTaskIncrementTick() != pdFALSE )
\r
389 ulPortYieldRequired = pdTRUE;
\r
392 /* Ensure all interrupt priorities are active again. */
\r
393 portCLEAR_INTERRUPT_MASK();
\r
394 configCLEAR_TICK_INTERRUPT();
\r
396 /*-----------------------------------------------------------*/
\r
398 void vPortTaskUsesFPU( void )
\r
400 uint32_t ulInitialFPSCR = 0;
\r
402 /* A task is registering the fact that it needs an FPU context. Set the
\r
403 * FPU flag (which is saved as part of the task context). */
\r
404 ulPortTaskHasFPUContext = pdTRUE;
\r
406 /* Initialise the floating point status register. */
\r
407 __asm( "FMXR FPSCR, ulInitialFPSCR");
\r
409 /*-----------------------------------------------------------*/
\r
411 void vPortClearInterruptMask( uint32_t ulNewMaskValue )
\r
413 if( ulNewMaskValue == pdFALSE )
\r
415 portCLEAR_INTERRUPT_MASK();
\r
418 /*-----------------------------------------------------------*/
\r
420 uint32_t ulPortSetInterruptMask( void )
\r
426 if( portICCPMR_PRIORITY_MASK_REGISTER == ( uint32_t ) ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT ) )
\r
428 /* Interrupts were already masked. */
\r
433 ulReturn = pdFALSE;
\r
434 portICCPMR_PRIORITY_MASK_REGISTER = ( uint32_t ) ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT );
\r
443 /*-----------------------------------------------------------*/
\r
445 #if ( configASSERT_DEFINED == 1 )
\r
447 void vPortValidateInterruptPriority( void )
\r
449 /* The following assertion will fail if a service routine (ISR) for
\r
450 * an interrupt that has been assigned a priority above
\r
451 * configMAX_SYSCALL_INTERRUPT_PRIORITY calls an ISR safe FreeRTOS API
\r
452 * function. ISR safe FreeRTOS API functions must *only* be called
\r
453 * from interrupts that have been assigned a priority at or below
\r
454 * configMAX_SYSCALL_INTERRUPT_PRIORITY.
\r
456 * Numerically low interrupt priority numbers represent logically high
\r
457 * interrupt priorities, therefore the priority of the interrupt must
\r
458 * be set to a value equal to or numerically *higher* than
\r
459 * configMAX_SYSCALL_INTERRUPT_PRIORITY.
\r
461 * FreeRTOS maintains separate thread and ISR API functions to ensure
\r
462 * interrupt entry is as fast and simple as possible.
\r
464 * The following links provide detailed information:
\r
465 * http://www.freertos.org/RTOS-Cortex-M3-M4.html
\r
466 * http://www.freertos.org/FAQHelp.html */
\r
467 configASSERT( portICCRPR_RUNNING_PRIORITY_REGISTER >= ( configMAX_API_CALL_INTERRUPT_PRIORITY << portPRIORITY_SHIFT ) );
\r
469 /* Priority grouping: The interrupt controller (GIC) allows the bits
\r
470 * that define each interrupt's priority to be split between bits that
\r
471 * define the interrupt's pre-emption priority bits and bits that define
\r
472 * the interrupt's sub-priority. For simplicity all bits must be defined
\r
473 * to be pre-emption priority bits. The following assertion will fail if
\r
474 * this is not the case (if some bits represent a sub-priority).
\r
476 * The priority grouping is configured by the GIC's binary point register
\r
477 * (ICCBPR). Writting 0 to ICCBPR will ensure it is set to its lowest
\r
478 * possible value (which may be above 0). */
\r
479 configASSERT( portICCBPR_BINARY_POINT_REGISTER <= portMAX_BINARY_POINT_VALUE );
\r
482 #endif /* configASSERT_DEFINED */
\r