2 * FreeRTOS Kernel V10.3.1
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 * http://www.FreeRTOS.org
23 * http://aws.amazon.com/freertos
28 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining
29 * all the API functions to use the MPU wrappers. That should only be done when
30 * task.h is included from an application file. */
31 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE
33 /* Scheduler includes. */
37 /* MPU wrappers includes. */
38 #include "mpu_wrappers.h"
40 /* Portasm includes. */
43 #if( configENABLE_TRUSTZONE == 1 )
44 /* Secure components includes. */
45 #include "secure_context.h"
46 #include "secure_init.h"
47 #endif /* configENABLE_TRUSTZONE */
49 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE
52 * The FreeRTOS Cortex M33 port can be configured to run on the Secure Side only
53 * i.e. the processor boots as secure and never jumps to the non-secure side.
54 * The Trust Zone support in the port must be disabled in order to run FreeRTOS
55 * on the secure side. The following are the valid configuration seetings:
57 * 1. Run FreeRTOS on the Secure Side:
58 * configRUN_FREERTOS_SECURE_ONLY = 1 and configENABLE_TRUSTZONE = 0
60 * 2. Run FreeRTOS on the Non-Secure Side with Secure Side function call support:
61 * configRUN_FREERTOS_SECURE_ONLY = 0 and configENABLE_TRUSTZONE = 1
63 * 3. Run FreeRTOS on the Non-Secure Side only i.e. no Secure Side function call support:
64 * configRUN_FREERTOS_SECURE_ONLY = 0 and configENABLE_TRUSTZONE = 0
66 #if( ( configRUN_FREERTOS_SECURE_ONLY == 1 ) && ( configENABLE_TRUSTZONE == 1 ) )
67 #error TrustZone needs to be disabled in order to run FreeRTOS on the Secure Side.
69 /*-----------------------------------------------------------*/
72 * @brief Constants required to manipulate the NVIC.
74 #define portNVIC_SYSTICK_CTRL ( ( volatile uint32_t * ) 0xe000e010 )
75 #define portNVIC_SYSTICK_LOAD ( ( volatile uint32_t * ) 0xe000e014 )
76 #define portNVIC_SYSTICK_CURRENT_VALUE ( ( volatile uint32_t * ) 0xe000e018 )
77 #define portNVIC_INT_CTRL ( ( volatile uint32_t * ) 0xe000ed04 )
78 #define portNVIC_SYSPRI2 ( ( volatile uint32_t * ) 0xe000ed20 )
79 #define portNVIC_SYSTICK_CLK ( 0x00000004 )
80 #define portNVIC_SYSTICK_INT ( 0x00000002 )
81 #define portNVIC_SYSTICK_ENABLE ( 0x00000001 )
82 #define portNVIC_PENDSVSET ( 0x10000000 )
83 #define portMIN_INTERRUPT_PRIORITY ( 255UL )
84 #define portNVIC_PENDSV_PRI ( portMIN_INTERRUPT_PRIORITY << 16UL )
85 #define portNVIC_SYSTICK_PRI ( portMIN_INTERRUPT_PRIORITY << 24UL )
86 /*-----------------------------------------------------------*/
89 * @brief Constants required to manipulate the SCB.
91 #define portSCB_SYS_HANDLER_CTRL_STATE_REG ( * ( volatile uint32_t * ) 0xe000ed24 )
92 #define portSCB_MEM_FAULT_ENABLE ( 1UL << 16UL )
93 /*-----------------------------------------------------------*/
96 * @brief Constants required to manipulate the FPU.
98 #define portCPACR ( ( volatile uint32_t * ) 0xe000ed88 ) /* Coprocessor Access Control Register. */
99 #define portCPACR_CP10_VALUE ( 3UL )
100 #define portCPACR_CP11_VALUE portCPACR_CP10_VALUE
101 #define portCPACR_CP10_POS ( 20UL )
102 #define portCPACR_CP11_POS ( 22UL )
104 #define portFPCCR ( ( volatile uint32_t * ) 0xe000ef34 ) /* Floating Point Context Control Register. */
105 #define portFPCCR_ASPEN_POS ( 31UL )
106 #define portFPCCR_ASPEN_MASK ( 1UL << portFPCCR_ASPEN_POS )
107 #define portFPCCR_LSPEN_POS ( 30UL )
108 #define portFPCCR_LSPEN_MASK ( 1UL << portFPCCR_LSPEN_POS )
109 /*-----------------------------------------------------------*/
112 * @brief Constants required to manipulate the MPU.
114 #define portMPU_TYPE_REG ( * ( ( volatile uint32_t * ) 0xe000ed90 ) )
115 #define portMPU_CTRL_REG ( * ( ( volatile uint32_t * ) 0xe000ed94 ) )
116 #define portMPU_RNR_REG ( * ( ( volatile uint32_t * ) 0xe000ed98 ) )
118 #define portMPU_RBAR_REG ( * ( ( volatile uint32_t * ) 0xe000ed9c ) )
119 #define portMPU_RLAR_REG ( * ( ( volatile uint32_t * ) 0xe000eda0 ) )
121 #define portMPU_RBAR_A1_REG ( * ( ( volatile uint32_t * ) 0xe000eda4 ) )
122 #define portMPU_RLAR_A1_REG ( * ( ( volatile uint32_t * ) 0xe000eda8 ) )
124 #define portMPU_RBAR_A2_REG ( * ( ( volatile uint32_t * ) 0xe000edac ) )
125 #define portMPU_RLAR_A2_REG ( * ( ( volatile uint32_t * ) 0xe000edb0 ) )
127 #define portMPU_RBAR_A3_REG ( * ( ( volatile uint32_t * ) 0xe000edb4 ) )
128 #define portMPU_RLAR_A3_REG ( * ( ( volatile uint32_t * ) 0xe000edb8 ) )
130 #define portMPU_MAIR0_REG ( * ( ( volatile uint32_t * ) 0xe000edc0 ) )
131 #define portMPU_MAIR1_REG ( * ( ( volatile uint32_t * ) 0xe000edc4 ) )
133 #define portMPU_RBAR_ADDRESS_MASK ( 0xffffffe0 ) /* Must be 32-byte aligned. */
134 #define portMPU_RLAR_ADDRESS_MASK ( 0xffffffe0 ) /* Must be 32-byte aligned. */
136 #define portMPU_MAIR_ATTR0_POS ( 0UL )
137 #define portMPU_MAIR_ATTR0_MASK ( 0x000000ff )
139 #define portMPU_MAIR_ATTR1_POS ( 8UL )
140 #define portMPU_MAIR_ATTR1_MASK ( 0x0000ff00 )
142 #define portMPU_MAIR_ATTR2_POS ( 16UL )
143 #define portMPU_MAIR_ATTR2_MASK ( 0x00ff0000 )
145 #define portMPU_MAIR_ATTR3_POS ( 24UL )
146 #define portMPU_MAIR_ATTR3_MASK ( 0xff000000 )
148 #define portMPU_MAIR_ATTR4_POS ( 0UL )
149 #define portMPU_MAIR_ATTR4_MASK ( 0x000000ff )
151 #define portMPU_MAIR_ATTR5_POS ( 8UL )
152 #define portMPU_MAIR_ATTR5_MASK ( 0x0000ff00 )
154 #define portMPU_MAIR_ATTR6_POS ( 16UL )
155 #define portMPU_MAIR_ATTR6_MASK ( 0x00ff0000 )
157 #define portMPU_MAIR_ATTR7_POS ( 24UL )
158 #define portMPU_MAIR_ATTR7_MASK ( 0xff000000 )
160 #define portMPU_RLAR_ATTR_INDEX0 ( 0UL << 1UL )
161 #define portMPU_RLAR_ATTR_INDEX1 ( 1UL << 1UL )
162 #define portMPU_RLAR_ATTR_INDEX2 ( 2UL << 1UL )
163 #define portMPU_RLAR_ATTR_INDEX3 ( 3UL << 1UL )
164 #define portMPU_RLAR_ATTR_INDEX4 ( 4UL << 1UL )
165 #define portMPU_RLAR_ATTR_INDEX5 ( 5UL << 1UL )
166 #define portMPU_RLAR_ATTR_INDEX6 ( 6UL << 1UL )
167 #define portMPU_RLAR_ATTR_INDEX7 ( 7UL << 1UL )
169 #define portMPU_RLAR_REGION_ENABLE ( 1UL )
171 /* Enable privileged access to unmapped region. */
172 #define portMPU_PRIV_BACKGROUND_ENABLE ( 1UL << 2UL )
175 #define portMPU_ENABLE ( 1UL << 0UL )
177 /* Expected value of the portMPU_TYPE register. */
178 #define portEXPECTED_MPU_TYPE_VALUE ( 8UL << 8UL ) /* 8 regions, unified. */
179 /*-----------------------------------------------------------*/
182 * @brief Constants required to set up the initial stack.
184 #define portINITIAL_XPSR ( 0x01000000 )
186 #if( configRUN_FREERTOS_SECURE_ONLY == 1 )
188 * @brief Initial EXC_RETURN value.
191 * 1111 1111 1111 1111 1111 1111 1111 1101
193 * Bit[6] - 1 --> The exception was taken from the Secure state.
194 * Bit[5] - 1 --> Do not skip stacking of additional state context.
195 * Bit[4] - 1 --> The PE did not allocate space on the stack for FP context.
196 * Bit[3] - 1 --> Return to the Thread mode.
197 * Bit[2] - 1 --> Restore registers from the process stack.
198 * Bit[1] - 0 --> Reserved, 0.
199 * Bit[0] - 1 --> The exception was taken to the Secure state.
201 #define portINITIAL_EXC_RETURN ( 0xfffffffd )
204 * @brief Initial EXC_RETURN value.
207 * 1111 1111 1111 1111 1111 1111 1011 1100
209 * Bit[6] - 0 --> The exception was taken from the Non-Secure state.
210 * Bit[5] - 1 --> Do not skip stacking of additional state context.
211 * Bit[4] - 1 --> The PE did not allocate space on the stack for FP context.
212 * Bit[3] - 1 --> Return to the Thread mode.
213 * Bit[2] - 1 --> Restore registers from the process stack.
214 * Bit[1] - 0 --> Reserved, 0.
215 * Bit[0] - 0 --> The exception was taken to the Non-Secure state.
217 #define portINITIAL_EXC_RETURN ( 0xffffffbc )
218 #endif /* configRUN_FREERTOS_SECURE_ONLY */
221 * @brief CONTROL register privileged bit mask.
223 * Bit[0] in CONTROL register tells the privilege:
224 * Bit[0] = 0 ==> The task is privileged.
225 * Bit[0] = 1 ==> The task is not privileged.
227 #define portCONTROL_PRIVILEGED_MASK ( 1UL << 0UL )
230 * @brief Initial CONTROL register values.
232 #define portINITIAL_CONTROL_UNPRIVILEGED ( 0x3 )
233 #define portINITIAL_CONTROL_PRIVILEGED ( 0x2 )
236 * @brief Let the user override the pre-loading of the initial LR with the
237 * address of prvTaskExitError() in case it messes up unwinding of the stack
240 #ifdef configTASK_RETURN_ADDRESS
241 #define portTASK_RETURN_ADDRESS configTASK_RETURN_ADDRESS
243 #define portTASK_RETURN_ADDRESS prvTaskExitError
247 * @brief If portPRELOAD_REGISTERS then registers will be given an initial value
248 * when a task is created. This helps in debugging at the cost of code size.
250 #define portPRELOAD_REGISTERS 1
253 * @brief A task is created without a secure context, and must call
254 * portALLOCATE_SECURE_CONTEXT() to give itself a secure context before it makes
257 #define portNO_SECURE_CONTEXT 0
258 /*-----------------------------------------------------------*/
261 * @brief Used to catch tasks that attempt to return from their implementing
264 static void prvTaskExitError( void );
266 #if( configENABLE_MPU == 1 )
268 * @brief Setup the Memory Protection Unit (MPU).
270 static void prvSetupMPU( void ) PRIVILEGED_FUNCTION;
271 #endif /* configENABLE_MPU */
273 #if( configENABLE_FPU == 1 )
275 * @brief Setup the Floating Point Unit (FPU).
277 static void prvSetupFPU( void ) PRIVILEGED_FUNCTION;
278 #endif /* configENABLE_FPU */
281 * @brief Setup the timer to generate the tick interrupts.
283 * The implementation in this file is weak to allow application writers to
284 * change the timer used to generate the tick interrupt.
286 void vPortSetupTimerInterrupt( void ) PRIVILEGED_FUNCTION;
289 * @brief Checks whether the current execution context is interrupt.
291 * @return pdTRUE if the current execution context is interrupt, pdFALSE
294 BaseType_t xPortIsInsideInterrupt( void );
297 * @brief Yield the processor.
299 void vPortYield( void ) PRIVILEGED_FUNCTION;
302 * @brief Enter critical section.
304 void vPortEnterCritical( void ) PRIVILEGED_FUNCTION;
307 * @brief Exit from critical section.
309 void vPortExitCritical( void ) PRIVILEGED_FUNCTION;
312 * @brief SysTick handler.
314 void SysTick_Handler( void ) PRIVILEGED_FUNCTION;
317 * @brief C part of SVC handler.
319 portDONT_DISCARD void vPortSVCHandler_C( uint32_t *pulCallerStackAddress ) PRIVILEGED_FUNCTION;
320 /*-----------------------------------------------------------*/
323 * @brief Each task maintains its own interrupt status in the critical nesting
326 static volatile uint32_t ulCriticalNesting = 0xaaaaaaaaUL;
328 #if( configENABLE_TRUSTZONE == 1 )
330 * @brief Saved as part of the task context to indicate which context the
331 * task is using on the secure side.
333 portDONT_DISCARD volatile SecureContextHandle_t xSecureContext = portNO_SECURE_CONTEXT;
334 #endif /* configENABLE_TRUSTZONE */
335 /*-----------------------------------------------------------*/
337 __attribute__(( weak )) void vPortSetupTimerInterrupt( void ) /* PRIVILEGED_FUNCTION */
339 /* Stop and reset the SysTick. */
340 *( portNVIC_SYSTICK_CTRL ) = 0UL;
341 *( portNVIC_SYSTICK_CURRENT_VALUE ) = 0UL;
343 /* Configure SysTick to interrupt at the requested rate. */
344 *( portNVIC_SYSTICK_LOAD ) = ( configCPU_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;
345 *( portNVIC_SYSTICK_CTRL ) = portNVIC_SYSTICK_CLK | portNVIC_SYSTICK_INT | portNVIC_SYSTICK_ENABLE;
347 /*-----------------------------------------------------------*/
349 static void prvTaskExitError( void )
351 volatile uint32_t ulDummy = 0UL;
353 /* A function that implements a task must not exit or attempt to return to
354 * its caller as there is nothing to return to. If a task wants to exit it
355 * should instead call vTaskDelete( NULL ). Artificially force an assert()
356 * to be triggered if configASSERT() is defined, then stop here so
357 * application writers can catch the error. */
358 configASSERT( ulCriticalNesting == ~0UL );
359 portDISABLE_INTERRUPTS();
361 while( ulDummy == 0 )
363 /* This file calls prvTaskExitError() after the scheduler has been
364 * started to remove a compiler warning about the function being
365 * defined but never called. ulDummy is used purely to quieten other
366 * warnings about code appearing after this function is called - making
367 * ulDummy volatile makes the compiler think the function could return
368 * and therefore not output an 'unreachable code' warning for code that
369 * appears after it. */
372 /*-----------------------------------------------------------*/
374 #if( configENABLE_MPU == 1 )
375 static void prvSetupMPU( void ) /* PRIVILEGED_FUNCTION */
377 #if defined( __ARMCC_VERSION )
378 /* Declaration when these variable are defined in code instead of being
379 * exported from linker scripts. */
380 extern uint32_t * __privileged_functions_start__;
381 extern uint32_t * __privileged_functions_end__;
382 extern uint32_t * __syscalls_flash_start__;
383 extern uint32_t * __syscalls_flash_end__;
384 extern uint32_t * __unprivileged_flash_start__;
385 extern uint32_t * __unprivileged_flash_end__;
386 extern uint32_t * __privileged_sram_start__;
387 extern uint32_t * __privileged_sram_end__;
389 /* Declaration when these variable are exported from linker scripts. */
390 extern uint32_t __privileged_functions_start__[];
391 extern uint32_t __privileged_functions_end__[];
392 extern uint32_t __syscalls_flash_start__[];
393 extern uint32_t __syscalls_flash_end__[];
394 extern uint32_t __unprivileged_flash_start__[];
395 extern uint32_t __unprivileged_flash_end__[];
396 extern uint32_t __privileged_sram_start__[];
397 extern uint32_t __privileged_sram_end__[];
398 #endif /* defined( __ARMCC_VERSION ) */
400 /* Check that the MPU is present. */
401 if( portMPU_TYPE_REG == portEXPECTED_MPU_TYPE_VALUE )
403 /* MAIR0 - Index 0. */
404 portMPU_MAIR0_REG |= ( ( portMPU_NORMAL_MEMORY_BUFFERABLE_CACHEABLE << portMPU_MAIR_ATTR0_POS ) & portMPU_MAIR_ATTR0_MASK );
405 /* MAIR0 - Index 1. */
406 portMPU_MAIR0_REG |= ( ( portMPU_DEVICE_MEMORY_nGnRE << portMPU_MAIR_ATTR1_POS ) & portMPU_MAIR_ATTR1_MASK );
408 /* Setup privileged flash as Read Only so that privileged tasks can
409 * read it but not modify. */
410 portMPU_RNR_REG = portPRIVILEGED_FLASH_REGION;
411 portMPU_RBAR_REG = ( ( ( uint32_t ) __privileged_functions_start__ ) & portMPU_RBAR_ADDRESS_MASK ) |
412 ( portMPU_REGION_NON_SHAREABLE ) |
413 ( portMPU_REGION_PRIVILEGED_READ_ONLY );
414 portMPU_RLAR_REG = ( ( ( uint32_t ) __privileged_functions_end__ ) & portMPU_RLAR_ADDRESS_MASK ) |
415 ( portMPU_RLAR_ATTR_INDEX0 ) |
416 ( portMPU_RLAR_REGION_ENABLE );
418 /* Setup unprivileged flash as Read Only by both privileged and
419 * unprivileged tasks. All tasks can read it but no-one can modify. */
420 portMPU_RNR_REG = portUNPRIVILEGED_FLASH_REGION;
421 portMPU_RBAR_REG = ( ( ( uint32_t ) __unprivileged_flash_start__ ) & portMPU_RBAR_ADDRESS_MASK ) |
422 ( portMPU_REGION_NON_SHAREABLE ) |
423 ( portMPU_REGION_READ_ONLY );
424 portMPU_RLAR_REG = ( ( ( uint32_t ) __unprivileged_flash_end__ ) & portMPU_RLAR_ADDRESS_MASK ) |
425 ( portMPU_RLAR_ATTR_INDEX0 ) |
426 ( portMPU_RLAR_REGION_ENABLE );
428 /* Setup unprivileged syscalls flash as Read Only by both privileged
429 * and unprivileged tasks. All tasks can read it but no-one can modify. */
430 portMPU_RNR_REG = portUNPRIVILEGED_SYSCALLS_REGION;
431 portMPU_RBAR_REG = ( ( ( uint32_t ) __syscalls_flash_start__ ) & portMPU_RBAR_ADDRESS_MASK ) |
432 ( portMPU_REGION_NON_SHAREABLE ) |
433 ( portMPU_REGION_READ_ONLY );
434 portMPU_RLAR_REG = ( ( ( uint32_t ) __syscalls_flash_end__ ) & portMPU_RLAR_ADDRESS_MASK ) |
435 ( portMPU_RLAR_ATTR_INDEX0 ) |
436 ( portMPU_RLAR_REGION_ENABLE );
438 /* Setup RAM containing kernel data for privileged access only. */
439 portMPU_RNR_REG = portPRIVILEGED_RAM_REGION;
440 portMPU_RBAR_REG = ( ( ( uint32_t ) __privileged_sram_start__ ) & portMPU_RBAR_ADDRESS_MASK ) |
441 ( portMPU_REGION_NON_SHAREABLE ) |
442 ( portMPU_REGION_PRIVILEGED_READ_WRITE ) |
443 ( portMPU_REGION_EXECUTE_NEVER );
444 portMPU_RLAR_REG = ( ( ( uint32_t ) __privileged_sram_end__ ) & portMPU_RLAR_ADDRESS_MASK ) |
445 ( portMPU_RLAR_ATTR_INDEX0 ) |
446 ( portMPU_RLAR_REGION_ENABLE );
448 /* Enable mem fault. */
449 portSCB_SYS_HANDLER_CTRL_STATE_REG |= portSCB_MEM_FAULT_ENABLE;
451 /* Enable MPU with privileged background access i.e. unmapped
452 * regions have privileged access. */
453 portMPU_CTRL_REG |= ( portMPU_PRIV_BACKGROUND_ENABLE | portMPU_ENABLE );
456 #endif /* configENABLE_MPU */
457 /*-----------------------------------------------------------*/
459 #if( configENABLE_FPU == 1 )
460 static void prvSetupFPU( void ) /* PRIVILEGED_FUNCTION */
462 #if( configENABLE_TRUSTZONE == 1 )
464 /* Enable non-secure access to the FPU. */
465 SecureInit_EnableNSFPUAccess();
467 #endif /* configENABLE_TRUSTZONE */
469 /* CP10 = 11 ==> Full access to FPU i.e. both privileged and
470 * unprivileged code should be able to access FPU. CP11 should be
471 * programmed to the same value as CP10. */
472 *( portCPACR ) |= ( ( portCPACR_CP10_VALUE << portCPACR_CP10_POS ) |
473 ( portCPACR_CP11_VALUE << portCPACR_CP11_POS )
476 /* ASPEN = 1 ==> Hardware should automatically preserve floating point
477 * context on exception entry and restore on exception return.
478 * LSPEN = 1 ==> Enable lazy context save of FP state. */
479 *( portFPCCR ) |= ( portFPCCR_ASPEN_MASK | portFPCCR_LSPEN_MASK );
481 #endif /* configENABLE_FPU */
482 /*-----------------------------------------------------------*/
484 void vPortYield( void ) /* PRIVILEGED_FUNCTION */
486 /* Set a PendSV to request a context switch. */
487 *( portNVIC_INT_CTRL ) = portNVIC_PENDSVSET;
489 /* Barriers are normally not required but do ensure the code is
490 * completely within the specified behaviour for the architecture. */
491 __asm volatile( "dsb" ::: "memory" );
492 __asm volatile( "isb" );
494 /*-----------------------------------------------------------*/
496 void vPortEnterCritical( void ) /* PRIVILEGED_FUNCTION */
498 portDISABLE_INTERRUPTS();
501 /* Barriers are normally not required but do ensure the code is
502 * completely within the specified behaviour for the architecture. */
503 __asm volatile( "dsb" ::: "memory" );
504 __asm volatile( "isb" );
506 /*-----------------------------------------------------------*/
508 void vPortExitCritical( void ) /* PRIVILEGED_FUNCTION */
510 configASSERT( ulCriticalNesting );
513 if( ulCriticalNesting == 0 )
515 portENABLE_INTERRUPTS();
518 /*-----------------------------------------------------------*/
520 void SysTick_Handler( void ) /* PRIVILEGED_FUNCTION */
522 uint32_t ulPreviousMask;
524 ulPreviousMask = portSET_INTERRUPT_MASK_FROM_ISR();
526 /* Increment the RTOS tick. */
527 if( xTaskIncrementTick() != pdFALSE )
529 /* Pend a context switch. */
530 *( portNVIC_INT_CTRL ) = portNVIC_PENDSVSET;
533 portCLEAR_INTERRUPT_MASK_FROM_ISR( ulPreviousMask );
535 /*-----------------------------------------------------------*/
537 void vPortSVCHandler_C( uint32_t *pulCallerStackAddress ) /* PRIVILEGED_FUNCTION portDONT_DISCARD */
539 #if( configENABLE_MPU == 1 )
540 #if defined( __ARMCC_VERSION )
541 /* Declaration when these variable are defined in code instead of being
542 * exported from linker scripts. */
543 extern uint32_t * __syscalls_flash_start__;
544 extern uint32_t * __syscalls_flash_end__;
546 /* Declaration when these variable are exported from linker scripts. */
547 extern uint32_t __syscalls_flash_start__[];
548 extern uint32_t __syscalls_flash_end__[];
549 #endif /* defined( __ARMCC_VERSION ) */
550 #endif /* configENABLE_MPU */
554 #if( configENABLE_TRUSTZONE == 1 )
556 #if( configENABLE_MPU == 1 )
557 uint32_t ulControl, ulIsTaskPrivileged;
558 #endif /* configENABLE_MPU */
559 #endif /* configENABLE_TRUSTZONE */
562 /* Register are stored on the stack in the following order - R0, R1, R2, R3,
563 * R12, LR, PC, xPSR. */
564 ulPC = pulCallerStackAddress[ 6 ];
565 ucSVCNumber = ( ( uint8_t *) ulPC )[ -2 ];
567 switch( ucSVCNumber )
569 #if( configENABLE_TRUSTZONE == 1 )
570 case portSVC_ALLOCATE_SECURE_CONTEXT:
572 /* R0 contains the stack size passed as parameter to the
573 * vPortAllocateSecureContext function. */
574 ulR0 = pulCallerStackAddress[ 0 ];
576 #if( configENABLE_MPU == 1 )
578 /* Read the CONTROL register value. */
579 __asm volatile ( "mrs %0, control" : "=r" ( ulControl ) );
581 /* The task that raised the SVC is privileged if Bit[0]
582 * in the CONTROL register is 0. */
583 ulIsTaskPrivileged = ( ( ulControl & portCONTROL_PRIVILEGED_MASK ) == 0 );
585 /* Allocate and load a context for the secure task. */
586 xSecureContext = SecureContext_AllocateContext( ulR0, ulIsTaskPrivileged );
590 /* Allocate and load a context for the secure task. */
591 xSecureContext = SecureContext_AllocateContext( ulR0 );
593 #endif /* configENABLE_MPU */
595 configASSERT( xSecureContext != NULL );
596 SecureContext_LoadContext( xSecureContext );
600 case portSVC_FREE_SECURE_CONTEXT:
602 /* R0 contains the secure context handle to be freed. */
603 ulR0 = pulCallerStackAddress[ 0 ];
605 /* Free the secure context. */
606 SecureContext_FreeContext( ( SecureContextHandle_t ) ulR0 );
609 #endif /* configENABLE_TRUSTZONE */
611 case portSVC_START_SCHEDULER:
613 #if( configENABLE_TRUSTZONE == 1 )
615 /* De-prioritize the non-secure exceptions so that the
616 * non-secure pendSV runs at the lowest priority. */
617 SecureInit_DePrioritizeNSExceptions();
619 /* Initialize the secure context management system. */
620 SecureContext_Init();
622 #endif /* configENABLE_TRUSTZONE */
624 #if( configENABLE_FPU == 1 )
626 /* Setup the Floating Point Unit (FPU). */
629 #endif /* configENABLE_FPU */
631 /* Setup the context of the first task so that the first task starts
633 vRestoreContextOfFirstTask();
637 #if( configENABLE_MPU == 1 )
638 case portSVC_RAISE_PRIVILEGE:
640 /* Only raise the privilege, if the svc was raised from any of
641 * the system calls. */
642 if( ulPC >= ( uint32_t ) __syscalls_flash_start__ &&
643 ulPC <= ( uint32_t ) __syscalls_flash_end__ )
649 #endif /* configENABLE_MPU */
653 /* Incorrect SVC call. */
654 configASSERT( pdFALSE );
658 /*-----------------------------------------------------------*/
660 #if( configENABLE_MPU == 1 )
661 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, StackType_t *pxEndOfStack, TaskFunction_t pxCode, void *pvParameters, BaseType_t xRunPrivileged ) /* PRIVILEGED_FUNCTION */
663 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, StackType_t *pxEndOfStack, TaskFunction_t pxCode, void *pvParameters ) /* PRIVILEGED_FUNCTION */
664 #endif /* configENABLE_MPU */
666 /* Simulate the stack frame as it would be created by a context switch
668 #if( portPRELOAD_REGISTERS == 0 )
670 pxTopOfStack--; /* Offset added to account for the way the MCU uses the stack on entry/exit of interrupts. */
671 *pxTopOfStack = portINITIAL_XPSR; /* xPSR */
673 *pxTopOfStack = ( StackType_t ) pxCode; /* PC */
675 *pxTopOfStack = ( StackType_t ) portTASK_RETURN_ADDRESS; /* LR */
676 pxTopOfStack -= 5; /* R12, R3, R2 and R1. */
677 *pxTopOfStack = ( StackType_t ) pvParameters; /* R0 */
678 pxTopOfStack -= 9; /* R11..R4, EXC_RETURN. */
679 *pxTopOfStack = portINITIAL_EXC_RETURN;
681 #if( configENABLE_MPU == 1 )
684 if( xRunPrivileged == pdTRUE )
686 *pxTopOfStack = portINITIAL_CONTROL_PRIVILEGED; /* Slot used to hold this task's CONTROL value. */
690 *pxTopOfStack = portINITIAL_CONTROL_UNPRIVILEGED; /* Slot used to hold this task's CONTROL value. */
693 #endif /* configENABLE_MPU */
696 *pxTopOfStack = ( StackType_t ) pxEndOfStack; /* Slot used to hold this task's PSPLIM value. */
698 #if( configENABLE_TRUSTZONE == 1 )
701 *pxTopOfStack = portNO_SECURE_CONTEXT; /* Slot used to hold this task's xSecureContext value. */
703 #endif /* configENABLE_TRUSTZONE */
705 #else /* portPRELOAD_REGISTERS */
707 pxTopOfStack--; /* Offset added to account for the way the MCU uses the stack on entry/exit of interrupts. */
708 *pxTopOfStack = portINITIAL_XPSR; /* xPSR */
710 *pxTopOfStack = ( StackType_t ) pxCode; /* PC */
712 *pxTopOfStack = ( StackType_t ) portTASK_RETURN_ADDRESS; /* LR */
714 *pxTopOfStack = ( StackType_t ) 0x12121212UL; /* R12 */
716 *pxTopOfStack = ( StackType_t ) 0x03030303UL; /* R3 */
718 *pxTopOfStack = ( StackType_t ) 0x02020202UL; /* R2 */
720 *pxTopOfStack = ( StackType_t ) 0x01010101UL; /* R1 */
722 *pxTopOfStack = ( StackType_t ) pvParameters; /* R0 */
724 *pxTopOfStack = ( StackType_t ) 0x11111111UL; /* R11 */
726 *pxTopOfStack = ( StackType_t ) 0x10101010UL; /* R10 */
728 *pxTopOfStack = ( StackType_t ) 0x09090909UL; /* R09 */
730 *pxTopOfStack = ( StackType_t ) 0x08080808UL; /* R08 */
732 *pxTopOfStack = ( StackType_t ) 0x07070707UL; /* R07 */
734 *pxTopOfStack = ( StackType_t ) 0x06060606UL; /* R06 */
736 *pxTopOfStack = ( StackType_t ) 0x05050505UL; /* R05 */
738 *pxTopOfStack = ( StackType_t ) 0x04040404UL; /* R04 */
740 *pxTopOfStack = portINITIAL_EXC_RETURN; /* EXC_RETURN */
742 #if( configENABLE_MPU == 1 )
745 if( xRunPrivileged == pdTRUE )
747 *pxTopOfStack = portINITIAL_CONTROL_PRIVILEGED; /* Slot used to hold this task's CONTROL value. */
751 *pxTopOfStack = portINITIAL_CONTROL_UNPRIVILEGED; /* Slot used to hold this task's CONTROL value. */
754 #endif /* configENABLE_MPU */
757 *pxTopOfStack = ( StackType_t ) pxEndOfStack; /* Slot used to hold this task's PSPLIM value. */
759 #if( configENABLE_TRUSTZONE == 1 )
762 *pxTopOfStack = portNO_SECURE_CONTEXT; /* Slot used to hold this task's xSecureContext value. */
764 #endif /* configENABLE_TRUSTZONE */
766 #endif /* portPRELOAD_REGISTERS */
770 /*-----------------------------------------------------------*/
772 BaseType_t xPortStartScheduler( void ) /* PRIVILEGED_FUNCTION */
774 /* Make PendSV, CallSV and SysTick the same priority as the kernel. */
775 *( portNVIC_SYSPRI2 ) |= portNVIC_PENDSV_PRI;
776 *( portNVIC_SYSPRI2 ) |= portNVIC_SYSTICK_PRI;
778 #if( configENABLE_MPU == 1 )
780 /* Setup the Memory Protection Unit (MPU). */
783 #endif /* configENABLE_MPU */
785 /* Start the timer that generates the tick ISR. Interrupts are disabled
787 vPortSetupTimerInterrupt();
789 /* Initialize the critical nesting count ready for the first task. */
790 ulCriticalNesting = 0;
792 /* Start the first task. */
795 /* Should never get here as the tasks will now be executing. Call the task
796 * exit error function to prevent compiler warnings about a static function
797 * not being called in the case that the application writer overrides this
798 * functionality by defining configTASK_RETURN_ADDRESS. Call
799 * vTaskSwitchContext() so link time optimization does not remove the
801 vTaskSwitchContext();
804 /* Should not get here. */
807 /*-----------------------------------------------------------*/
809 void vPortEndScheduler( void ) /* PRIVILEGED_FUNCTION */
811 /* Not implemented in ports where there is nothing to return to.
812 * Artificially force an assert. */
813 configASSERT( ulCriticalNesting == 1000UL );
815 /*-----------------------------------------------------------*/
817 #if( configENABLE_MPU == 1 )
818 void vPortStoreTaskMPUSettings( xMPU_SETTINGS *xMPUSettings, const struct xMEMORY_REGION * const xRegions, StackType_t *pxBottomOfStack, uint32_t ulStackDepth )
820 uint32_t ulRegionStartAddress, ulRegionEndAddress, ulRegionNumber;
824 xMPUSettings->ulMAIR0 = ( ( portMPU_NORMAL_MEMORY_BUFFERABLE_CACHEABLE << portMPU_MAIR_ATTR0_POS ) & portMPU_MAIR_ATTR0_MASK );
825 xMPUSettings->ulMAIR0 |= ( ( portMPU_DEVICE_MEMORY_nGnRE << portMPU_MAIR_ATTR1_POS ) & portMPU_MAIR_ATTR1_MASK );
827 /* This function is called automatically when the task is created - in
828 * which case the stack region parameters will be valid. At all other
829 * times the stack parameters will not be valid and it is assumed that
830 * the stack region has already been configured. */
831 if( ulStackDepth > 0 )
833 /* Define the region that allows access to the stack. */
834 ulRegionStartAddress = ( ( uint32_t ) pxBottomOfStack ) & portMPU_RBAR_ADDRESS_MASK;
835 ulRegionEndAddress = ( uint32_t ) pxBottomOfStack + ( ulStackDepth * ( uint32_t ) sizeof( StackType_t ) ) - 1;
836 ulRegionEndAddress &= portMPU_RLAR_ADDRESS_MASK;
838 xMPUSettings->xRegionsSettings[ 0 ].ulRBAR = ( ulRegionStartAddress ) |
839 ( portMPU_REGION_NON_SHAREABLE ) |
840 ( portMPU_REGION_READ_WRITE ) |
841 ( portMPU_REGION_EXECUTE_NEVER );
843 xMPUSettings->xRegionsSettings[ 0 ].ulRLAR = ( ulRegionEndAddress ) |
844 ( portMPU_RLAR_ATTR_INDEX0 ) |
845 ( portMPU_RLAR_REGION_ENABLE );
848 /* User supplied configurable regions. */
849 for( ulRegionNumber = 1; ulRegionNumber <= portNUM_CONFIGURABLE_REGIONS; ulRegionNumber++ )
851 /* If xRegions is NULL i.e. the task has not specified any MPU
852 * region, the else part ensures that all the configurable MPU
853 * regions are invalidated. */
854 if( ( xRegions != NULL ) && ( xRegions[ lIndex ].ulLengthInBytes > 0UL ) )
856 /* Translate the generic region definition contained in xRegions
857 * into the ARMv8 specific MPU settings that are then stored in
859 ulRegionStartAddress = ( ( uint32_t ) xRegions[ lIndex ].pvBaseAddress ) & portMPU_RBAR_ADDRESS_MASK;
860 ulRegionEndAddress = ( uint32_t ) xRegions[ lIndex ].pvBaseAddress + xRegions[ lIndex ].ulLengthInBytes - 1;
861 ulRegionEndAddress &= portMPU_RLAR_ADDRESS_MASK;
864 xMPUSettings->xRegionsSettings[ ulRegionNumber ].ulRBAR = ( ulRegionStartAddress ) |
865 ( portMPU_REGION_NON_SHAREABLE );
868 if( ( xRegions[ lIndex ].ulParameters & tskMPU_REGION_READ_ONLY ) != 0 )
870 xMPUSettings->xRegionsSettings[ ulRegionNumber ].ulRBAR |= ( portMPU_REGION_READ_ONLY );
874 xMPUSettings->xRegionsSettings[ ulRegionNumber ].ulRBAR |= ( portMPU_REGION_READ_WRITE );
878 if( ( xRegions[ lIndex ].ulParameters & tskMPU_REGION_EXECUTE_NEVER ) != 0 )
880 xMPUSettings->xRegionsSettings[ ulRegionNumber ].ulRBAR |= ( portMPU_REGION_EXECUTE_NEVER );
884 xMPUSettings->xRegionsSettings[ ulRegionNumber ].ulRLAR = ( ulRegionEndAddress ) |
885 ( portMPU_RLAR_REGION_ENABLE );
887 /* Normal memory/ Device memory. */
888 if( ( xRegions[ lIndex ].ulParameters & tskMPU_REGION_DEVICE_MEMORY ) != 0 )
890 /* Attr1 in MAIR0 is configured as device memory. */
891 xMPUSettings->xRegionsSettings[ ulRegionNumber ].ulRLAR |= portMPU_RLAR_ATTR_INDEX1;
895 /* Attr1 in MAIR0 is configured as normal memory. */
896 xMPUSettings->xRegionsSettings[ ulRegionNumber ].ulRLAR |= portMPU_RLAR_ATTR_INDEX0;
901 /* Invalidate the region. */
902 xMPUSettings->xRegionsSettings[ ulRegionNumber ].ulRBAR = 0UL;
903 xMPUSettings->xRegionsSettings[ ulRegionNumber ].ulRLAR = 0UL;
909 #endif /* configENABLE_MPU */
910 /*-----------------------------------------------------------*/
912 BaseType_t xPortIsInsideInterrupt( void )
914 uint32_t ulCurrentInterrupt;
917 /* Obtain the number of the currently executing interrupt. Interrupt Program
918 * Status Register (IPSR) holds the exception number of the currently-executing
919 * exception or zero for Thread mode.*/
920 __asm volatile( "mrs %0, ipsr" : "=r"( ulCurrentInterrupt ) :: "memory" );
922 if( ulCurrentInterrupt == 0 )
933 /*-----------------------------------------------------------*/