46#include <pico/runtime.h>
47#include <pico/stdio.h>
48#include <pico/unique_id.h>
53#include <arch/arm/cortex-m/stk_arch_arm-tz.h>
57#if (__ARM_FEATURE_CMSE & 1) == 0
58#error "Need ARMv8-M security extensions"
59#elif (__ARM_FEATURE_CMSE & 2) == 0
60#error "Compile with --mcmse"
63#if !STK_MPU || !STK_MPU_STACK_GUARD
64#error "This example requires STK_MPU=1 and STK_MPU_STACK_GUARD=1 in stk_config.h"
76#define TASK_NS_COUNT (4U)
77#define TASK_S_COUNT (1U)
78#define TASK_COUNT (TASK_NS_COUNT + TASK_S_COUNT)
81#define KERNEL_TYPE KERNEL_STATIC
127 if (cmse_check_address_range(key, size, CMSE_NONSECURE | CMSE_MPU_READWRITE) !=
nullptr)
177 extern char __stk_mpu_shared_data_start[];
178 extern char __stk_mpu_shared_data_end[];
179 extern char __stk_mpu_shared_data_source__[];
180 extern char __stk_mpu_shared_bss_start[];
181 extern char __stk_mpu_shared_bss_end[];
184 const size_t data_size = __stk_mpu_shared_data_end - __stk_mpu_shared_data_start;
187 STK_MEMCPY(__stk_mpu_shared_data_start, __stk_mpu_shared_data_source__, data_size);
191 const size_t bss_size = __stk_mpu_shared_bss_end - __stk_mpu_shared_bss_start;
194 STK_MEMSET(__stk_mpu_shared_bss_start, 0, bss_size);
201 extern char __secure_data_start[];
202 extern char __secure_data_end[];
203 extern char __secure_data_source__[];
206 const size_t data_size = __secure_data_end - __secure_data_start;
209 STK_MEMCPY(__secure_data_start, __secure_data_source__, data_size);
216 extern char __nsc_start[];
217 extern char __nsc_end[];
218 extern char __ns_ram_start[];
220 extern char __ns_flash_start[];
221 extern char __ns_flash_end[];
222 extern char __ns_scratch_start[];
223 extern char __ns_scratch_end[];
230 SAU->RBAR = (uintptr_t)__nsc_start;
231 SAU->RLAR = (((uintptr_t)__nsc_end - 1U) & ~0x1FU) | 2U | 1U;
235 SAU->RBAR = (uintptr_t)__ns_flash_start;
236 SAU->RLAR = (((uintptr_t)__ns_flash_end - 1U) & ~0x1FU) | 0U | 1U;
240 SAU->RBAR = (uintptr_t)__ns_ram_start;
241 SAU->RLAR = (((uintptr_t)__ns_scratch_start - 1U) & ~0x1FU) | 0U | 1U;
245 SAU->RBAR = (uintptr_t)__ns_scratch_start;
246 SAU->RLAR = (((uintptr_t)__ns_scratch_end - 1U) & ~0x1FU) | 0U | 1U;
249 for (uint32_t i = 4U; i < 8U; ++i)
266 SCB->SHCSR |= SCB_SHCSR_SECUREFAULTENA_Msk |
267 SCB_SHCSR_BUSFAULTENA_Msk |
268 SCB_SHCSR_USGFAULTENA_Msk |
269 SCB_SHCSR_MEMFAULTENA_Msk;
281 extern char __ns_flash_start[];
289 uint32_t *ns_vector_table =
reinterpret_cast<uint32_t *
>(__ns_flash_start);
290 uint32_t initial_msp_ns = ns_vector_table[0];
291 __TZ_set_MSP_NS(initial_msp_ns);
294 SCB_NS->VTOR =
reinterpret_cast<uintptr_t
>(__ns_flash_start);
299 uint32_t reset_handler_address = ns_vector_table[1];
303 NSFuncT ResetHandler_ns =
reinterpret_cast<NSFuncT
>(reset_handler_address & ~1UL);
327template <stk::EAccessMode _AccessMode>
362 enum EMemPartition : uint32_t
366 BOOTROM_BASE_ADDR = 0x00000000UL,
367 BOOTROM_SIZE = 32 * 1024,
369 FLASH_BASE_ADDR = 0x10000000UL,
370 FLASH_SIZE_BYTES = 4 * 1024 * 1024,
372 SRAM_BASE_ADDR = 0x20000000UL,
373 SRAM_SIZE_BYTES = 512 * 1024,
376 extern char __stk_mpu_shared_code_start[];
377 extern char __stk_mpu_shared_code_end[];
378 extern char __stk_mpu_shared_data_start[];
379 extern char __stk_mpu_shared_data_end[];
380 extern char __stk_mpu_shared_bss_start[];
381 extern char __stk_mpu_shared_bss_end[];
386 extern char __stk_mpu_ram_text_start[];
387 extern char __stk_mpu_ram_text_end[];
392 const Word flash_end = FLASH_BASE_ADDR + FLASH_SIZE_BYTES;
396 const size_t ram_text_size =
stk::Align<size_t>(
static_cast<size_t>(ram_text_end - ram_text_start), 32U);
400 static const stk::MpuRegionConfig mpu_table[] =
403 .addr = FLASH_BASE_ADDR,
404 .size = shared_code_start - FLASH_BASE_ADDR,
405 .access_perm = hw::mpu::ACCESS_PRIV_RO_USER_RO,
406 .mem_type = hw::mpu::TYPE_NORMAL_CACHEABLE,
407 .share = hw::mpu::SHARE_NON,
408 .exec = hw::mpu::EXEC_ALLOWED
411 .addr = shared_code_end,
412 .size = flash_end - shared_code_end,
413 .access_perm = hw::mpu::ACCESS_PRIV_RO_USER_RO,
414 .mem_type = hw::mpu::TYPE_NORMAL_CACHEABLE,
415 .share = hw::mpu::SHARE_NON,
416 .exec = hw::mpu::EXEC_ALLOWED
419 .addr = shared_code_start,
420 .size = shared_code_end - shared_code_start,
421 .access_perm = hw::mpu::ACCESS_PRIV_RO_USER_RO,
422 .mem_type = hw::mpu::TYPE_NORMAL_CACHEABLE,
423 .share = hw::mpu::SHARE_NON,
424 .exec = hw::mpu::EXEC_ALLOWED
429 .access_perm = hw::mpu::ACCESS_FULL,
430 .mem_type = hw::mpu::TYPE_NORMAL_CACHEABLE,
431 .share = hw::mpu::SHARE_NON,
432 .exec = hw::mpu::EXEC_NEVER
435 .addr = ram_text_start,
436 .size = ram_text_size,
437 .access_perm = hw::mpu::ACCESS_PRIV_RO_USER_RO,
438 .mem_type = hw::mpu::TYPE_NORMAL_CACHEABLE,
439 .share = hw::mpu::SHARE_NON,
440 .exec = hw::mpu::EXEC_ALLOWED
452 static const stk::MpuConfig mpu_config
455 (hw::mpu::MPU_CFG_PRIVILEGED_BG_MEM |
456 hw::mpu::MPU_CFG_CLEAR_ON_INIT)
465 printf(
"--- %s MPU Status & Config ---\r\n", label);
466 printf(
"CTRL: 0x%08X\r\n", (
unsigned int)mpu.
CTRL);
468 printf(
"MAIR0: 0x%08X MAIR1: 0x%08X\r\n", (
unsigned int)mpu.MAIR0, (
unsigned int)mpu.MAIR1);
471 printf(
"--- %s MPU Regions Configuration ---\r\n", label);
474 printf(
" Region %u -> RBAR: 0x%08X R%s: 0x%08X\r\n",
492 printf(
"\r\n================ MEMMANAGE FAULT DETECTED ================\r\n");
493 printf(
"(Sandbox Violation: a task's Run() reached outside the MPU\r\n");
494 printf(
" regions granted to it - see region dump below for what\r\n");
495 printf(
" WAS active for this task at fault time)\r\n");
499 printf(
"\r\n================== HARD FAULT DETECTED ===================\r\n");
502 printf(
"ITask *: 0x%08X:\r\n", (
unsigned int)tid);
504 printf(
"EXC_RETURN: 0x%08X\r\n\r\n", (
unsigned int)ctx->
EXC_RETURN);
506 printf(
"--- Stacked CPU Registers ---\r\n");
507 printf(
"R0: 0x%08X R1: 0x%08X R2: 0x%08X\r\n", (
unsigned int)ctx->
frame.
R0, (
unsigned int)ctx->
frame.
R1, (
unsigned int)ctx->
frame.
R2);
508 printf(
"R3: 0x%08X R12: 0x%08X LR: 0x%08X\r\n", (
unsigned int)ctx->
frame.
R3, (
unsigned int)ctx->
frame.
R12, (
unsigned int)ctx->
frame.
LR);
509 printf(
"PC: 0x%08X xPSR: 0x%08X\r\n\r\n", (
unsigned int)ctx->
frame.
PC, (
unsigned int)ctx->
frame.
xPSR);
511 printf(
"--- System Control Registers ---\r\n");
512 printf(
"CFSR: 0x%08X HFSR: 0x%08X AFSR: 0x%08X\r\n", (
unsigned int)ctx->
CFSR, (
unsigned int)ctx->
HFSR, (
unsigned int)ctx->
AFSR);
513 printf(
"MMFAR: 0x%08X (%s)\r\n", (
unsigned int)ctx->
MMFAR, ctx->
mmfar_valid ?
"VALID" :
"INVALID");
514 printf(
"BFAR: 0x%08X (%s)\r\n\r\n", (
unsigned int)ctx->
BFAR, ctx->
bfar_valid ?
"VALID" :
"INVALID");
515 printf(
"CONTROL: 0x%08X (nPRIV=%u)\r\n", (
unsigned int)ctx->
CONTROL, (
unsigned int)(ctx->
CONTROL & 1U));
520 #if STK_ARCH_ARMV8_M && STK_TZ_SECURE
522 PrintMpuConfig(
"Non-Secure", ctx->mpu_ns);
526 printf(
"=====================================================\r\n");
553 tz::sec::SetKernel(0, &kernel);
585 #if (KERNEL_TYPE == KERNEL_STATIC)
#define __stk_tz_ns_call
ARM TrustZone: attribute for calling Non-Secure functions from Secure state.
#define __stk_tz_nsc_entry
ARM TrustZone: attribute for Non-Secure callable gateway functions.
#define STK_ARCH_ARMV8_M
ARMv8-M platform (Cortex-M23, Cortex-M33, Cortex-M55, Cortex-M85).
Top-level STK include. Provides the Kernel class template and all built-in task-switching strategies.
#define STK_MPU_SHARED_DATA_SECTION
#define STK_UNUSED(X)
Explicitly marks a variable as unused to suppress compiler warnings.
#define __stk_aligned(x)
Specifies minimum alignment in bytes for the decorated variable or struct member (data instance prefi...
#define STK_TZ_SECURE
ARM TrustZone: Defines Secure (1) build.
#define STK_ASSERT(e)
Runtime assertion. Halts execution if the expression e evaluates to false.
static void __stk_debug_break()
#define STK_STATIC_ARRAY_SIZE(ARRAY)
Get size of the static array.
Collection of synchronization primitives (stk::sync namespace).
Collection of time-related primitives (stk::time namespace).
Namespace of STK package.
uintptr_t Word
Native processor word type.
void STK_MEMCPY(void *const dest, const void *const src, size_t size)
Implementation of STK_MEMCPY.
void STK_MEMSET(void *const dest, uint8_t value, size_t size)
Implementation of STK_MEMSET.
constexpr T Align(T v, T align) noexcept
Aligns a value towards the next larger size multiple.
EHwException
Hardware exception id (see IPlatform::IEventOverrider::OnException).
@ HW_EXCEPT_MEMACCESS
MemManage on ARM / Page Fault or PMP violation on RISC-V.
Word TId
Task (thread) id.
@ KERNEL_TICKLESS
Tickless mode. To use this mode STK_TICKLESS_IDLE must be defined to 1 in stk_config....
@ KERNEL_SYNC
Synchronization support (see Event).
bool IsPrivilegedContext()
Check if caller context is Privileged.
static Word PtrToWord(T *const ptr) noexcept
Cast a pointer to a CPU register-width integer.
Word BFAR
BusFault Address Register (BFAR).
Word AFSR
Auxiliary Fault Status Register (AFSR).
Word HFSR
HardFault Status Register (HFSR).
hw::ExceptionFrame frame
Saved hardware exception stack frame.
Word MMFAR
Memory Management Fault Address Register (MMFAR).
Word CFSR
Configurable Fault Status Register (CFSR: MemManage, BusFault, UsageFault).
Word CONTROL
Core CONTROL register state snapshot.
bool mmfar_valid
Flag indicating validity of MMFAR address value (derived from CFSR.MMARVALID).
Word EXC_RETURN
Exception return magic value (EXC_RETURN).
bool bfar_valid
Flag indicating validity of BFAR address value (derived from CFSR.BFARVALID).
Hardware Memory Protection Unit (MPU) status register snapshot.
Region regions[(8U)]
Active hardware MPU region register state table.
Word CTRL
MPU Control Register (MPU_CTRL).
Word ATTR
Region Attribute and Size Register (RASR / RLAR / MPU_RLAR).
Word RBAR
Region Base Address Register (RBAR).
Concrete implementation of IKernel.
EAddResult AddTask(ITask *user_task) override
Register task for a soft real-time (SRT) scheduling.
IPlatform * GetPlatform() override
Get platform driver instance owned by this kernel.
void Initialize(uint32_t resolution_us=PERIODICITY_DEFAULT) override
Initialize kernel.
virtual void SetEventOverrider(IEventOverrider *overrider, bool non_secure=false)=0
Set platform event overrider.
Interface for a platform event overrider.
Partial implementation of the user task.
Thread-safe, type-safe FIFO communication pipe with internal storage.
void Run() override
Entry point of the user task.
bool OnException(stk::EHwException exc_id, stk::TId tid, const struct stk::FaultContext *const ctx) override
const stk::MpuConfig * OnConfigureMpu() const override
static void InitAll(bool init_state)
static void SwitchOnExclusive(Id led)
void pico_get_unique_board_id(pico_unique_board_id_t *id_out)
static jmp_buf s_NsExitEnv
static sync::PipeT< HwCommand, 4 > s_HwCmdQueue
static void InitMpuSharedData()
static void InitMpuSharedData()
__stk_tz_nsc_entry uint32_t NSC_GetKey(uint8_t key[], uint32_t size)
PICO_RUNTIME_INIT_FUNC(InitMpuSharedData, "00100")
static void CreateKernel()
__stk_tz_nsc_entry void NSC_GetBoardUID(pico_unique_board_id_t *id_out)
static void InvokeNonSecureState()
static void Configure_SAU(void)
__stk_tz_nsc_entry void NSC_OnExitNs(void)
__attribute__((section(".secure_data"))) uint32_t s_Counter=0U
static void InitSecureData()
static void ConfigureSecureState()
__stk_tz_nsc_entry void NSC_bsp_Led_SwitchOnExclusive(bsp::Led::Id led)
static STK_MPU_SHARED_DATA_SECTION stk::sync::PipeT< HwCommand, 4 > s_HwCmdQueue