/* ChibiOS - Copyright (C) 2006,2007,2008,2009,2010,2011,2012,2013,2014, 2015,2016,2017,2018,2019,2020,2021 Giovanni Di Sirio. This file is part of ChibiOS. ChibiOS is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation version 3 of the License. ChibiOS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ /** * @file ARMv8-M-ML/chcore.h * @brief ARMv8-M mainline port macros and structures. * * @addtogroup ARMV8M_ML_CORE * @{ */ #ifndef CHCORE_H #define CHCORE_H /*===========================================================================*/ /* Module constants. */ /*===========================================================================*/ /** * @name Architecture and Compiler * @{ */ /** * @brief Macro defining a generic ARM architecture. */ #define PORT_ARCHITECTURE_ARM /** * @brief Macro defining the specific ARM architecture. */ #define PORT_ARCHITECTURE_ARM_V8M_MAINLINE /** * @brief Name of the implemented architecture. */ #define PORT_ARCHITECTURE_NAME "ARMv8-M Mainline" /* The following code is not processed when the file is included from an asm module because those intrinsic macros are not necessarily defined by the assembler too.*/ #if !defined(_FROM_ASM_) #if defined(__GNUC__) || defined(__DOXYGEN__) #define PORT_COMPILER_NAME "GCC " __VERSION__ #elif defined(__ICCARM__) #define PORT_COMPILER_NAME "IAR" #elif defined(__CC_ARM) #define PORT_COMPILER_NAME "RVCT" #else #error "unsupported compiler" #endif #endif /* !defined(_FROM_ASM_) */ /** @} */ /** * @name Port Capabilities and Constants * @{ */ /** * @brief This port supports a realtime counter. */ #define PORT_SUPPORTS_RT TRUE /** * @brief Natural alignment constant. * @note It is the minimum alignment for pointer-size variables. */ #define PORT_NATURAL_ALIGN sizeof (void *) /** * @brief Stack alignment constant. * @note It is the alignment required for the stack pointer. */ #define PORT_STACK_ALIGN 32U /** * @brief Working Areas alignment constant. * @note It is the alignment to be enforced for thread working areas. */ #define PORT_WORKING_AREA_ALIGN 32U /** @} */ /* Inclusion of the Cortex-Mx implementation specific parameters.*/ #include "cmparams.h" /** * @name Kernel modes * @{ */ /** * @brief Standard mode. * @details The RTOS is running in secure state with no switch in non-secure * state ever performed. This is also used on devices with no * TrustZone support at all. */ #define PORT_KERNEL_MODE_NORMAL 0U /** * @brief Kernel running in secure state. * @details The RTOS is running in secure state with support for one thread * running in non-secure state. */ #define PORT_KERNEL_MODE_HOST 1U /** * @brief Kernel running in non-secure state. * @details The RTOS is running in non-secure state with no access to secure * resources. */ #define PORT_KERNEL_MODE_GUEST 2U /** @} */ /** * @name Priority boundaries * @{ */ /** * @brief Total priority levels. */ #define CORTEX_PRIORITY_LEVELS (1 << CORTEX_PRIORITY_BITS) /** * @brief Maximum priority level. * @details The maximum allowed priority level is always zero. */ #define CORTEX_MAXIMUM_PRIORITY 0 /** * @brief Minimum priority level. * @details This minimum priority level is calculated from the number of * priority bits supported by the specific Cortex-Mx implementation. */ #define CORTEX_MINIMUM_PRIORITY (CORTEX_PRIORITY_LEVELS - 1) /** @} */ /*===========================================================================*/ /* Module pre-compile time settings. */ /*===========================================================================*/ /** * @brief Kernel mode selection. */ #if !defined(PORT_KERNEL_MODE) || defined(__DOXYGEN__) #define PORT_KERNEL_MODE PORT_KERNEL_MODE_NORMAL #endif /** * @brief Number of MPU regions to be saved/restored during context switch. * @note The first region is always region zero. * @note The use of this option has an overhead of 8 bytes for each * region for each thread. * @note Allowed values are 0..4, zero means none. */ #if !defined(PORT_SWITCHED_REGIONS_NUMBER) || defined(__DOXYGEN__) #define PORT_SWITCHED_REGIONS_NUMBER 0 #endif /** * @brief Enables an alternative timer implementation. * @details Usually the port uses a timer interface defined in the file * @p chcore_timer.h, if this option is enabled then the file * @p chcore_timer_alt.h is included instead. */ #if !defined(PORT_USE_ALT_TIMER) #define PORT_USE_ALT_TIMER FALSE #endif /** * @brief Stack size for the system idle thread. * @details This size depends on the idle thread implementation, usually * the idle thread should take no more space than those reserved * by @p PORT_INT_REQUIRED_STACK. * @note In this port it is set to 16 because the idle thread does have * a stack frame when compiling without optimizations. You may * reduce this value to zero when compiling with optimizations. */ #if !defined(PORT_IDLE_THREAD_STACK_SIZE) || defined(__DOXYGEN__) #define PORT_IDLE_THREAD_STACK_SIZE 64 #endif /** * @brief Per-thread stack overhead for interrupts servicing. * @details This constant is used in the calculation of the correct working * area size. * @note This port requires no extra stack space for interrupt handling. */ #if !defined(PORT_INT_REQUIRED_STACK) #define PORT_INT_REQUIRED_STACK 0 #endif /** * @brief Enables the use of the WFI instruction in the idle thread loop. */ #if !defined(CORTEX_ENABLE_WFI_IDLE) #define CORTEX_ENABLE_WFI_IDLE FALSE #endif /** * @brief Number of upper priority levels reserved as fast interrupts. * @note The default reserves no priority levels for fast interrupts. */ #if !defined(CORTEX_FAST_PRIORITIES) #define CORTEX_FAST_PRIORITIES 0 #endif /** * @brief FPU support in context switch. * @details Activating this option activates the FPU support in the kernel. */ #if !defined(CORTEX_USE_FPU) #define CORTEX_USE_FPU CORTEX_HAS_FPU #elif (CORTEX_USE_FPU == TRUE) && (CORTEX_HAS_FPU == FALSE) /* This setting requires an FPU presence check in case it is externally redefined.*/ #error "the selected core does not have an FPU" #endif /** * @brief NVIC PRIGROUP initialization expression. * @details The default assigns all available priority bits as preemption * priority with no sub-priority. * @note Changing this value is not recommended. */ #if !defined(CORTEX_PRIGROUP_INIT) || defined(__DOXYGEN__) #define CORTEX_PRIGROUP_INIT (7 - CORTEX_PRIORITY_BITS) #endif /*===========================================================================*/ /* Derived constants and error checks. */ /*===========================================================================*/ #if (CORTEX_FAST_PRIORITIES < 0) || \ (CORTEX_FAST_PRIORITIES > (CORTEX_PRIORITY_LEVELS / 8)) #error "invalid CORTEX_FAST_PRIORITIES value specified" #endif #if PORT_KERNEL_MODE == PORT_KERNEL_MODE_NORMAL /** * @brief EXC_RETURN to be used when starting a thread. */ #define PORT_EXC_RETURN 0xFFFFFFFD /** * @brief Context save area for each thread. */ #define PORT_CONTEXT_RESERVED_SIZE (sizeof (struct port_intctx)) /** * @brief Port-specific information string. */ #define PORT_INFO "Normal mode" /** * @brief SVCALL handler priority. */ #define CORTEX_PRIORITY_SVCALL (CORTEX_MAXIMUM_PRIORITY + \ CORTEX_FAST_PRIORITIES) /** * @brief PENDSV handler priority. */ #define CORTEX_PRIORITY_PENDSV (CORTEX_MINIMUM_PRIORITY) /** * @brief Maximum usable priority for normal ISRs. * @note Must be lower than @p CORTEX_PRIORITY_SVCALL. */ #define CORTEX_MAX_KERNEL_PRIORITY (CORTEX_PRIORITY_SVCALL + 1) #elif PORT_KERNEL_MODE == PORT_KERNEL_MODE_HOST #define PORT_EXC_RETURN 0xFFFFFFFD #if CORTEX_USE_FPU == TRUE /* Extended secure context size with FPU.*/ #define PORT_CONTEXT_RESERVED_SIZE 0xD0 #else /* Extended secure context size without FPU.*/ #define PORT_CONTEXT_RESERVED_SIZE 0x48 #endif #define PORT_INFO "Secure host mode" #define CORTEX_PRIORITY_SVCALL (CORTEX_MAXIMUM_PRIORITY + \ CORTEX_FAST_PRIORITIES) #define CORTEX_PRIORITY_PENDSV (CORTEX_MINIMUM_PRIORITY / 2) #define CORTEX_MAX_KERNEL_PRIORITY (CORTEX_PRIORITY_SVCALL + 1) #elif PORT_KERNEL_MODE == PORT_KERNEL_MODE_GUEST #define PORT_EXC_RETURN 0xFFFFFFBC #define PORT_CONTEXT_RESERVED_SIZE (sizeof (struct port_intctx)) #define PORT_INFO "Non-secure guest mode" #define CORTEX_PRIORITY_SVCALL (CORTEX_MAXIMUM_PRIORITY + \ CORTEX_FAST_PRIORITIES) #define CORTEX_PRIORITY_PENDSV (CORTEX_MINIMUM_PRIORITY & 0xFFFFFFFE) #define CORTEX_MAX_KERNEL_PRIORITY ((CORTEX_PRIORITY_SVCALL | 1) + 1) #else #error "invalid kernel security mode" #endif /** * @brief Disabled value for BASEPRI register. */ #define CORTEX_BASEPRI_DISABLED CORTEX_PRIO_MASK(0) /** * @brief BASEPRI level within kernel lock. */ #define CORTEX_BASEPRI_KERNEL CORTEX_PRIO_MASK(CORTEX_MAX_KERNEL_PRIORITY) /** * @name Port information * @{ */ #if (CORTEX_MODEL == 33) || defined(__DOXYGEN__) #if !defined(CH_CUSTOMER_LIC_PORT_CM33) #error "CH_CUSTOMER_LIC_PORT_CM33 not defined" #endif #if CH_CUSTOMER_LIC_PORT_CM33 == FALSE #error "ChibiOS Cortex-M33 port not licensed" #endif /** * @brief Name of the architecture variant. */ #if CORTEX_USE_FPU || defined(__DOXYGEN__) #define PORT_CORE_VARIANT_NAME "Cortex-M33 with FPU" #else #define PORT_CORE_VARIANT_NAME "Cortex-M33" #endif #elif (CORTEX_MODEL == 55) || defined(__DOXYGEN__) #if !defined(CH_CUSTOMER_LIC_PORT_CM55) #error "CH_CUSTOMER_LIC_PORT_CM55 not defined" #endif #if CH_CUSTOMER_LIC_PORT_CM55 == FALSE #error "ChibiOS Cortex-M55 port not licensed" #endif /** * @brief Name of the architecture variant. */ #if CORTEX_USE_FPU || defined(__DOXYGEN__) #define PORT_CORE_VARIANT_NAME "Cortex-M55 with FPU" #else #define PORT_CORE_VARIANT_NAME "Cortex-M55" #endif #else #error "unknown ARMv8-M core variant" #endif /*===========================================================================*/ /* Module data structures and types. */ /*===========================================================================*/ /* The following code is not processed when the file is included from an asm module.*/ #if !defined(_FROM_ASM_) /** * @brief Type of stack and memory alignment enforcement. * @note In this architecture the stack alignment is enforced to 64 bits, * 32 bits alignment is supported by hardware but deprecated by ARM, * the implementation choice is to not offer the option. */ typedef uint64_t stkalign_t; /** * @brief Interrupt saved context. * @details This structure represents the stack frame saved during a * preemption-capable interrupt handler. * @note This structure is empty in this port. */ struct port_extctx {}; /** * @brief System saved context. * @details This structure represents the inner stack frame during a context * switch. */ struct port_intctx { uint32_t r0; uint32_t r1; uint32_t r2; uint32_t r3; uint32_t r12; uint32_t lr_thd; uint32_t pc; uint32_t xpsr; #if (CORTEX_USE_FPU == TRUE) || defined(__DOXYGEN__) uint32_t s0; uint32_t s1; uint32_t s2; uint32_t s3; uint32_t s4; uint32_t s5; uint32_t s6; uint32_t s7; uint32_t s8; uint32_t s9; uint32_t s10; uint32_t s11; uint32_t s12; uint32_t s13; uint32_t s14; uint32_t s15; uint32_t fpscr; uint32_t reserved; #endif /* CORTEX_USE_FPU == TRUE */ }; /** * @brief Platform dependent part of the @p thread_t structure. * @details In this port the structure just holds a pointer to the * @p port_intctx structure representing the stack pointer * at context switch time. */ struct port_context { #if (PORT_KERNEL_MODE == PORT_KERNEL_MODE_HOST) || defined(__DOXYGEN__) uint32_t basepri_ns; #endif struct port_intctx *sp; uint32_t basepri; uint32_t r4; uint32_t r5; uint32_t r6; uint32_t r7; uint32_t r8; uint32_t r9; uint32_t r10; uint32_t r11; #if (CH_DBG_ENABLE_STACK_CHECK == TRUE) || defined(__DOXYGEN__) uint32_t splim; #endif uint32_t lr_exc; #if (CORTEX_USE_FPU == TRUE) || defined(__DOXYGEN__) uint32_t s16; uint32_t s17; uint32_t s18; uint32_t s19; uint32_t s20; uint32_t s21; uint32_t s22; uint32_t s23; uint32_t s24; uint32_t s25; uint32_t s26; uint32_t s27; uint32_t s28; uint32_t s29; uint32_t s30; uint32_t s31; #endif /* CORTEX_USE_FPU == TRUE */ }; #endif /* !defined(_FROM_ASM_) */ /*===========================================================================*/ /* Module macros. */ /*===========================================================================*/ /** * @brief Priority level to priority mask conversion macro. */ #define CORTEX_PRIO_MASK(n) ((n) << (8 - CORTEX_PRIORITY_BITS)) /** * @brief Priority level verification macro. */ #define PORT_IRQ_IS_VALID_PRIORITY(n) \ (((n) >= 0) && ((n) < CORTEX_PRIORITY_LEVELS)) /** * @brief Priority level verification macro. */ #define PORT_IRQ_IS_VALID_KERNEL_PRIORITY(n) \ (((n) >= CORTEX_MAX_KERNEL_PRIORITY) && ((n) <= CORTEX_PRIORITY_PENDSV)) /** * @brief Initialization of stack check part of thread context. */ #if (CH_DBG_ENABLE_STACK_CHECK == TRUE) || defined(__DOXYGEN__) #define PORT_SETUP_CONTEXT_SPLIM(tp, wbase) \ (tp)->ctx.splim = (uint32_t)(wbase) #else #define PORT_SETUP_CONTEXT_SPLIM(tp, wbase) #endif /** * @brief Initialization of FPU part of thread context. */ #if (CORTEX_USE_FPU == TRUE) || defined(__DOXYGEN__) #define PORT_SETUP_CONTEXT_FPU(tp) \ (tp)->ctx.sp->fpscr = (uint32_t)0 #else #define PORT_SETUP_CONTEXT_FPU(tp) #endif /** * @brief Initialization of MPU part of thread context. */ #if (PORT_SWITCHED_REGIONS_NUMBER == 0) || defined(__DOXYGEN__) #define PORT_SETUP_CONTEXT_MPU(tp) #else #define PORT_SETUP_CONTEXT_MPU(tp) #endif /** * @brief Initialization of BASEPRI_NS part of thread context. * @note All secure threads have BASEPRI_NS set to mask PendSV, this * way a guest RTOS cannot reschedule while a secure thread * is running, reschedule is delayed to when the non-secure * thread running the guest is activated again. */ #if (PORT_KERNEL_MODE == PORT_KERNEL_MODE_HOST) || defined(__DOXYGEN__) #define PORT_SETUP_CONTEXT_BASEPRI_NS(tp) \ (tp)->ctx.basepri_ns = (uint32_t)CORTEX_PRIO_MASK(CORTEX_MINIMUM_PRIORITY) #else #define PORT_SETUP_CONTEXT_BASEPRI_NS(tp) #endif /** * @brief Platform dependent part of the @p chThdCreateI() API. * @details This code usually setup the context switching frame represented * by an @p port_intctx structure. */ #define PORT_SETUP_CONTEXT(tp, wbase, wtop, pf, arg) do { \ PORT_SETUP_CONTEXT_BASEPRI_NS(tp); \ (tp)->ctx.sp = (struct port_intctx *)((uint8_t *)(wtop) - \ sizeof (struct port_intctx)); \ (tp)->ctx.basepri = CORTEX_BASEPRI_KERNEL; \ (tp)->ctx.r5 = (uint32_t)(arg); \ (tp)->ctx.r4 = (uint32_t)(pf); \ PORT_SETUP_CONTEXT_SPLIM(tp, wbase); \ (tp)->ctx.lr_exc = (uint32_t)PORT_EXC_RETURN; \ (tp)->ctx.sp->pc = (uint32_t)__port_thread_start; \ (tp)->ctx.sp->xpsr = (uint32_t)0x01000000; \ PORT_SETUP_CONTEXT_FPU(tp); \ PORT_SETUP_CONTEXT_MPU(tp); \ } while (false) /** * @brief Computes the thread working area global size. * @note There is no need to perform alignments in this macro. */ #define PORT_WA_SIZE(n) (PORT_CONTEXT_RESERVED_SIZE + \ (size_t)(n) + \ (size_t)PORT_INT_REQUIRED_STACK) /** * @brief Static working area allocation. * @details This macro is used to allocate a static thread working area * aligned as both position and size. * * @param[in] s the name to be assigned to the stack array * @param[in] n the stack size to be assigned to the thread */ #define PORT_WORKING_AREA(s, n) \ ALIGNED_VAR(32) stkalign_t s[THD_WORKING_AREA_SIZE(n) / sizeof (stkalign_t)] /** * @brief IRQ prologue code. * @details This macro must be inserted at the start of all IRQ handlers * enabled to invoke system APIs. */ #define PORT_IRQ_PROLOGUE() /** * @brief IRQ epilogue code. * @details This macro must be inserted at the end of all IRQ handlers * enabled to invoke system APIs. */ #define PORT_IRQ_EPILOGUE() do { \ port_lock_from_isr(); \ if (chSchIsPreemptionRequired()) { \ SCB->ICSR = SCB_ICSR_PENDSVSET_Msk; \ } \ port_unlock_from_isr(); \ } while (false) /** * @brief IRQ handler function declaration. * @note @p id can be a function name or a vector number depending on the * port implementation. */ #ifdef __cplusplus #define PORT_IRQ_HANDLER(id) extern "C" void id(void) #else #define PORT_IRQ_HANDLER(id) void id(void) #endif /** * @brief Fast IRQ handler function declaration. * @note @p id can be a function name or a vector number depending on the * port implementation. */ #ifdef __cplusplus #define PORT_FAST_IRQ_HANDLER(id) extern "C" void id(void) #else #define PORT_FAST_IRQ_HANDLER(id) void id(void) #endif /** * @brief Performs a context switch between two threads. * @details This is the most critical code in any port, this function * is responsible for the context switch between 2 threads. * @note The implementation of this code affects directly the context * switch performance so optimize here as much as you can. * * @param[in] ntp the thread to be switched in * @param[in] otp the thread to be switched out */ #define port_switch(ntp, otp) do { \ __dbg_check_lock(); \ register thread_t *_ntp asm ("r0") = (ntp); \ register thread_t *_otp asm ("r1") = (otp); \ asm volatile ("svc #0" : : "r" (_otp), "r" (_ntp) : "memory"); \ __dbg_check_unlock(); \ } while (false) /*===========================================================================*/ /* External declarations. */ /*===========================================================================*/ #if !defined(_FROM_ASM_) #ifdef __cplusplus extern "C" { #endif void port_init(os_instance_t *oip); void __port_thread_start(void); #if PORT_KERNEL_MODE == PORT_KERNEL_MODE_HOST void __port_ns_boot(void *vtor); #endif #ifdef __cplusplus } #endif /*===========================================================================*/ /* Module inline functions. */ /*===========================================================================*/ /** * @brief Returns a word encoding the current interrupts status. * * @return The interrupts status. */ __STATIC_FORCEINLINE syssts_t port_get_irq_status(void) { syssts_t sts; sts = (syssts_t)__get_BASEPRI(); return sts; } /** * @brief Checks the interrupt status. * * @param[in] sts the interrupt status word * * @return The interrupt status. * @retval false the word specified a disabled interrupts status. * @retval true the word specified an enabled interrupts status. */ __STATIC_FORCEINLINE bool port_irq_enabled(syssts_t sts) { return sts == (syssts_t)CORTEX_BASEPRI_DISABLED; } /** * @brief Determines the current execution context. * * @return The execution context. * @retval false not running in ISR mode. * @retval true running in ISR mode. */ __STATIC_FORCEINLINE bool port_is_isr_context(void) { return (bool)((__get_IPSR() & 0x1FFU) != 0U); } /** * @brief Kernel-lock action. * @details In this port this function raises the base priority to kernel * level. */ __STATIC_FORCEINLINE void port_lock(void) { __set_BASEPRI(CORTEX_BASEPRI_KERNEL); } /** * @brief Kernel-unlock action. * @details In this port this function lowers the base priority to user * level. */ __STATIC_FORCEINLINE void port_unlock(void) { __set_BASEPRI(CORTEX_BASEPRI_DISABLED); } /** * @brief Kernel-lock action from an interrupt handler. * @details In this port this function raises the base priority to kernel * level. * @note Same as @p port_lock() in this port. */ __STATIC_FORCEINLINE void port_lock_from_isr(void) { port_lock(); } /** * @brief Kernel-unlock action from an interrupt handler. * @details In this port this function lowers the base priority to user * level. * @note Same as @p port_unlock() in this port. */ __STATIC_FORCEINLINE void port_unlock_from_isr(void) { port_unlock(); } /** * @brief Disables all the interrupt sources. * @note In this port it disables all the interrupt sources by raising * the priority mask to level 0. */ __STATIC_FORCEINLINE void port_disable(void) { __disable_irq(); } /** * @brief Disables the interrupt sources below kernel-level priority. * @note Interrupt sources above kernel level remains enabled. * @note In this port it raises/lowers the base priority to kernel level. */ __STATIC_FORCEINLINE void port_suspend(void) { __set_BASEPRI(CORTEX_BASEPRI_KERNEL); __enable_irq(); } /** * @brief Enables all the interrupt sources. * @note In this port it lowers the base priority to user level. */ __STATIC_FORCEINLINE void port_enable(void) { __set_BASEPRI(CORTEX_BASEPRI_DISABLED); __enable_irq(); } /** * @brief Enters an architecture-dependent IRQ-waiting mode. * @details The function is meant to return when an interrupt becomes pending. * The simplest implementation is an empty function or macro but this * would not take advantage of architecture-specific power saving * modes. * @note Implemented as an inlined @p WFI instruction. */ __STATIC_FORCEINLINE void port_wait_for_interrupt(void) { #if CORTEX_ENABLE_WFI_IDLE == TRUE __WFI(); #endif } /** * @brief Returns the current value of the realtime counter. * * @return The realtime counter value. */ __STATIC_FORCEINLINE rtcnt_t port_rt_get_counter_value(void) { return DWT->CYCCNT; } #if CH_CFG_ST_TIMEDELTA > 0 #if PORT_USE_ALT_TIMER == FALSE #include "chcore_timer.h" #else /* PORT_USE_ALT_TIMER != FALSE */ #include "chcore_timer_alt.h" #endif /* PORT_USE_ALT_TIMER != FALSE */ #endif /* CH_CFG_ST_TIMEDELTA > 0 */ #endif /* !defined(_FROM_ASM_) */ #endif /* CHCORE_H */ /** @} */