1 /* 2 * Copyright (c) 2019-2026, Arm Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef SPMD_PRIVATE_H 8 #define SPMD_PRIVATE_H 9 10 #include <common/bl_common.h> 11 #include <context.h> 12 13 /******************************************************************************* 14 * Constants that allow assembler code to preserve callee-saved registers of the 15 * C runtime context while performing a security state switch. 16 ******************************************************************************/ 17 #define SPMD_C_RT_CTX_X19 0x0 18 #define SPMD_C_RT_CTX_X20 0x8 19 #define SPMD_C_RT_CTX_X21 0x10 20 #define SPMD_C_RT_CTX_X22 0x18 21 #define SPMD_C_RT_CTX_X23 0x20 22 #define SPMD_C_RT_CTX_X24 0x28 23 #define SPMD_C_RT_CTX_X25 0x30 24 #define SPMD_C_RT_CTX_X26 0x38 25 #define SPMD_C_RT_CTX_X27 0x40 26 #define SPMD_C_RT_CTX_X28 0x48 27 #define SPMD_C_RT_CTX_X29 0x50 28 #define SPMD_C_RT_CTX_X30 0x58 29 30 #define SPMD_C_RT_CTX_SIZE 0x60 31 #define SPMD_C_RT_CTX_ENTRIES (SPMD_C_RT_CTX_SIZE >> DWORD_SHIFT) 32 33 #ifndef __ASSEMBLER__ 34 #include <stdint.h> 35 #include <lib/psci/psci_lib.h> 36 #include <plat/common/platform.h> 37 #include <services/ffa_svc.h> 38 39 typedef enum spmc_state { 40 SPMC_STATE_RESET = 0, 41 SPMC_STATE_OFF, 42 SPMC_STATE_ON_PENDING, 43 SPMC_STATE_ON 44 } spmc_state_t; 45 46 /* 47 * Data structure used by the SPM dispatcher (SPMD) in EL3 to track context of 48 * the SPM core (SPMC) at the next lower EL. 49 */ 50 typedef struct spmd_spm_core_context { 51 uint64_t c_rt_ctx; 52 cpu_context_t cpu_ctx; 53 spmc_state_t state; 54 bool secure_interrupt_ongoing; 55 bool psci_operation_ongoing; 56 #if ENABLE_SPMD_LP 57 uint8_t spmd_lp_sync_req_ongoing; 58 #endif 59 } spmd_spm_core_context_t; 60 61 /* Flags to indicate ongoing requests for SPMD EL3 logical partitions */ 62 #define SPMD_LP_FFA_DIR_REQ_ONGOING U(0x1) 63 #define SPMD_LP_FFA_INFO_GET_REG_ONGOING U(0x2) 64 65 /* 66 * Reserve ID for NS physical FFA Endpoint. 67 */ 68 #define FFA_NS_ENDPOINT_ID U(0) 69 70 /* Define SPMD target function IDs for framework messages to the SPMC */ 71 #define SPMD_FWK_MSG_FFA_VERSION_REQ U(0x8) 72 #define SPMD_FWK_MSG_FFA_VERSION_RESP U(0x9) 73 74 /* Define LSP framework message for SP live activation flow. */ 75 #define LSP_FWK_MSG_START_LIVE_ACTIVATION_REQ U(0xC) 76 #define LSP_FWK_MSG_START_LIVE_ACTIVATION_RESP U(0xD) 77 #define LSP_FWK_MSG_FINISH_LIVE_ACTIVATION_REQ U(0xE) 78 #define LSP_FWK_MSG_FINISH_LIVE_ACTIVATION_RESP U(0xF) 79 80 /* Function to build SPMD to SPMC message */ 81 void spmd_build_spmc_message(gp_regs_t *gpregs, uint8_t target, 82 unsigned long long message); 83 84 /* Functions used to enter/exit SPMC synchronously */ 85 uint64_t spmd_spm_core_sync_entry(spmd_spm_core_context_t *ctx); 86 __dead2 void spmd_spm_core_sync_exit(uint64_t rc); 87 void spmd_setup_context(unsigned int core_id); 88 89 bool is_spmd_logical_sp_dir_req_in_progress(const spmd_spm_core_context_t *ctx); 90 91 bool is_spmd_logical_sp_info_regs_req_in_progress( 92 const spmd_spm_core_context_t *ctx); 93 94 /* Assembly helpers */ 95 uint64_t spmd_spm_core_enter(uint64_t *c_rt_ctx); 96 void __dead2 spmd_spm_core_exit(uint64_t c_rt_ctx, uint64_t ret); 97 98 /* SPMD SPD power management handlers */ 99 extern const spd_pm_ops_t spmd_pm; 100 101 /* SPMC entry point information helper */ 102 entry_point_info_t *spmd_spmc_ep_info_get(void); 103 104 /* SPMC ID getter */ 105 uint16_t spmd_spmc_id_get(void); 106 107 /* SPMC context on CPU based on mpidr */ 108 spmd_spm_core_context_t *spmd_get_context_by_mpidr(uint64_t mpidr); 109 110 /* SPMC context on current CPU get helper */ 111 spmd_spm_core_context_t *spmd_get_context(void); 112 113 int spmd_pm_secondary_ep_register(uintptr_t entry_point); 114 bool spmd_check_address_in_binary_image(uint64_t address); 115 116 /* 117 * Platform hook in EL3 firmware to handle for Group0 secure interrupt. 118 * Return values: 119 * 0 = success 120 * otherwise it returns a negative value 121 */ 122 int plat_spmd_handle_group0_interrupt(uint32_t id); 123 124 uint64_t spmd_ffa_error_return(void *handle, int error_code); 125 126 #endif /* __ASSEMBLER__ */ 127 128 #endif /* SPMD_PRIVATE_H */ 129