1 /* 2 * Copyright (c) 2022, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef SPMC_H 8 #define SPMC_H 9 10 #include <stdint.h> 11 12 #include <lib/psci/psci.h> 13 #include <lib/spinlock.h> 14 #include <services/el3_spmc_logical_sp.h> 15 #include "spm_common.h" 16 17 /* 18 * Ranges of FF-A IDs for Normal world and Secure world components. The 19 * convention matches that used by other SPMCs i.e. Hafnium and OP-TEE. 20 */ 21 #define FFA_NWD_ID_BASE 0x0 22 #define FFA_NWD_ID_LIMIT 0x7FFF 23 #define FFA_SWD_ID_BASE 0x8000 24 #define FFA_SWD_ID_LIMIT SPMD_DIRECT_MSG_ENDPOINT_ID - 1 25 #define FFA_SWD_ID_MASK 0x8000 26 27 /* ID 0 is reserved for the normal world entity, (Hypervisor or OS Kernel). */ 28 #define FFA_NWD_ID U(0) 29 /* First ID is reserved for the SPMC */ 30 #define FFA_SPMC_ID U(FFA_SWD_ID_BASE) 31 /* SP IDs are allocated after the SPMC ID */ 32 #define FFA_SP_ID_BASE (FFA_SPMC_ID + 1) 33 /* Align with Hafnium implementation */ 34 #define INV_SP_ID 0x7FFF 35 36 /* FF-A Related helper macros. */ 37 #define FFA_ID_MASK U(0xFFFF) 38 #define FFA_PARTITION_ID_SHIFT U(16) 39 #define FFA_FEATURES_BIT31_MASK U(0x1u << 31) 40 41 #define FFA_RUN_EP_ID(ep_vcpu_ids) \ 42 ((ep_vcpu_ids >> FFA_PARTITION_ID_SHIFT) & FFA_ID_MASK) 43 #define FFA_RUN_VCPU_ID(ep_vcpu_ids) \ 44 (ep_vcpu_ids & FFA_ID_MASK) 45 46 #define FFA_PAGE_SIZE (4096) 47 #define FFA_RXTX_PAGE_COUNT_MASK 0x1F 48 49 /* Ensure that the page size used by TF-A is 4k aligned. */ 50 CASSERT((PAGE_SIZE % FFA_PAGE_SIZE) == 0, assert_aligned_page_size); 51 52 /* 53 * Defines to allow an SP to subscribe for power management messages 54 */ 55 #define FFA_PM_MSG_SUB_CPU_OFF U(1 << 0) 56 #define FFA_PM_MSG_SUB_CPU_SUSPEND U(1 << 1) 57 #define FFA_PM_MSG_SUB_CPU_SUSPEND_RESUME U(1 << 2) 58 59 /* 60 * Runtime states of an execution context as per the FF-A v1.1 specification. 61 */ 62 enum sp_runtime_states { 63 RT_STATE_WAITING, 64 RT_STATE_RUNNING, 65 RT_STATE_PREEMPTED, 66 RT_STATE_BLOCKED 67 }; 68 69 /* 70 * Runtime model of an execution context as per the FF-A v1.1 specification. Its 71 * value is valid only if the execution context is not in the waiting state. 72 */ 73 enum sp_runtime_model { 74 RT_MODEL_DIR_REQ, 75 RT_MODEL_RUN, 76 RT_MODEL_INIT, 77 RT_MODEL_INTR 78 }; 79 80 enum sp_runtime_el { 81 EL1 = 0, 82 S_EL0, 83 S_EL1 84 }; 85 86 enum sp_execution_state { 87 SP_STATE_AARCH64 = 0, 88 SP_STATE_AARCH32 89 }; 90 91 enum mailbox_state { 92 /* There is no message in the mailbox. */ 93 MAILBOX_STATE_EMPTY, 94 95 /* There is a message that has been populated in the mailbox. */ 96 MAILBOX_STATE_FULL, 97 }; 98 99 struct mailbox { 100 enum mailbox_state state; 101 102 /* RX/TX Buffers. */ 103 void *rx_buffer; 104 const void *tx_buffer; 105 106 /* Size of RX/TX Buffer. */ 107 uint32_t rxtx_page_count; 108 109 /* Lock access to mailbox. */ 110 spinlock_t lock; 111 }; 112 113 /* 114 * Execution context members for an SP. This is a bit like struct 115 * vcpu in a hypervisor. 116 */ 117 struct sp_exec_ctx { 118 /* 119 * Store the stack address to restore C runtime context from after 120 * returning from a synchronous entry into the SP. 121 */ 122 uint64_t c_rt_ctx; 123 124 /* Space to maintain the architectural state of an SP. */ 125 cpu_context_t cpu_ctx; 126 127 /* Track the current runtime state of the SP. */ 128 enum sp_runtime_states rt_state; 129 130 /* Track the current runtime model of the SP. */ 131 enum sp_runtime_model rt_model; 132 }; 133 134 /* 135 * Structure to describe the cumulative properties of an SP. 136 */ 137 struct secure_partition_desc { 138 /* 139 * Execution contexts allocated to this endpoint. Ideally, 140 * we need as many contexts as there are physical cpus only 141 * for a S-EL1 SP which is MP-pinned. 142 */ 143 struct sp_exec_ctx ec[PLATFORM_CORE_COUNT]; 144 145 /* ID of the Secure Partition. */ 146 uint16_t sp_id; 147 148 /* Runtime EL. */ 149 enum sp_runtime_el runtime_el; 150 151 /* Partition UUID. */ 152 uint32_t uuid[4]; 153 154 /* Partition Properties. */ 155 uint32_t properties; 156 157 /* Supported FF-A Version. */ 158 uint32_t ffa_version; 159 160 /* Execution State. */ 161 enum sp_execution_state execution_state; 162 163 /* Mailbox tracking. */ 164 struct mailbox mailbox; 165 166 /* Secondary entrypoint. Only valid for a S-EL1 SP. */ 167 uintptr_t secondary_ep; 168 169 /* 170 * Store whether the SP has subscribed to any power management messages. 171 */ 172 uint16_t pwr_mgmt_msgs; 173 }; 174 175 /* 176 * This define identifies the only SP that will be initialised and participate 177 * in FF-A communication. The implementation leaves the door open for more SPs 178 * to be managed in future but for now it is reasonable to assume that either a 179 * single S-EL0 or a single S-EL1 SP will be supported. This define will be used 180 * to identify which SP descriptor to initialise and manage during SP runtime. 181 */ 182 #define ACTIVE_SP_DESC_INDEX 0 183 184 /* 185 * Structure to describe the cumulative properties of the Hypervisor and 186 * NS-Endpoints. 187 */ 188 struct ns_endpoint_desc { 189 /* 190 * ID of the NS-Endpoint or Hypervisor. 191 */ 192 uint16_t ns_ep_id; 193 194 /* 195 * Mailbox tracking. 196 */ 197 struct mailbox mailbox; 198 199 /* 200 * Supported FF-A Version 201 */ 202 uint32_t ffa_version; 203 }; 204 205 /** 206 * Holds information returned for each partition by the FFA_PARTITION_INFO_GET 207 * interface. 208 */ 209 struct ffa_partition_info_v1_0 { 210 uint16_t ep_id; 211 uint16_t execution_ctx_count; 212 uint32_t properties; 213 }; 214 215 /* Extended structure for v1.1. */ 216 struct ffa_partition_info_v1_1 { 217 uint16_t ep_id; 218 uint16_t execution_ctx_count; 219 uint32_t properties; 220 uint32_t uuid[4]; 221 }; 222 223 /* Reference to power management hooks */ 224 extern const spd_pm_ops_t spmc_pm; 225 226 /* Setup Function for different SP types. */ 227 void spmc_sp_common_setup(struct secure_partition_desc *sp, 228 entry_point_info_t *ep_info); 229 void spmc_el1_sp_setup(struct secure_partition_desc *sp, 230 entry_point_info_t *ep_info); 231 void spmc_sp_common_ep_commit(struct secure_partition_desc *sp, 232 entry_point_info_t *ep_info); 233 234 /* 235 * Helper function to perform a synchronous entry into a SP. 236 */ 237 uint64_t spmc_sp_synchronous_entry(struct sp_exec_ctx *ec); 238 239 /* 240 * Helper function to obtain the descriptor of the current SP on a physical cpu. 241 */ 242 struct secure_partition_desc *spmc_get_current_sp_ctx(void); 243 244 /* 245 * Helper function to obtain the execution context of an SP on a 246 * physical cpu. 247 */ 248 struct sp_exec_ctx *spmc_get_sp_ec(struct secure_partition_desc *sp); 249 250 /* 251 * Helper function to obtain the index of the execution context of an SP on a 252 * physical cpu. 253 */ 254 unsigned int get_ec_index(struct secure_partition_desc *sp); 255 256 uint64_t spmc_ffa_error_return(void *handle, int error_code); 257 258 /* 259 * Ensure a partition ID does not clash and follows the secure world convention. 260 */ 261 bool is_ffa_secure_id_valid(uint16_t partition_id); 262 263 /* 264 * Helper function to obtain the array storing the EL3 265 * Logical Partition descriptors. 266 */ 267 struct el3_lp_desc *get_el3_lp_array(void); 268 269 /* 270 * Helper function to obtain the RX/TX buffer pair descriptor of the Hypervisor 271 * or OS kernel in the normal world or the last SP that was run. 272 */ 273 struct mailbox *spmc_get_mbox_desc(bool secure_origin); 274 275 #endif /* SPMC_H */ 276