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 warm boot types. */ 37 #define FFA_WB_TYPE_S2RAM 0 38 #define FFA_WB_TYPE_NOTS2RAM 1 39 40 /* 41 * Runtime states of an execution context as per the FF-A v1.1 specification. 42 */ 43 enum sp_runtime_states { 44 RT_STATE_WAITING, 45 RT_STATE_RUNNING, 46 RT_STATE_PREEMPTED, 47 RT_STATE_BLOCKED 48 }; 49 50 /* 51 * Runtime model of an execution context as per the FF-A v1.1 specification. Its 52 * value is valid only if the execution context is not in the waiting state. 53 */ 54 enum sp_runtime_model { 55 RT_MODEL_DIR_REQ, 56 RT_MODEL_RUN, 57 RT_MODEL_INIT, 58 RT_MODEL_INTR 59 }; 60 61 enum sp_runtime_el { 62 EL1 = 0, 63 S_EL0, 64 S_EL1 65 }; 66 67 enum sp_execution_state { 68 SP_STATE_AARCH64 = 0, 69 SP_STATE_AARCH32 70 }; 71 72 enum mailbox_state { 73 /* There is no message in the mailbox. */ 74 MAILBOX_STATE_EMPTY, 75 76 /* There is a message that has been populated in the mailbox. */ 77 MAILBOX_STATE_FULL, 78 }; 79 80 struct mailbox { 81 enum mailbox_state state; 82 83 /* RX/TX Buffers. */ 84 void *rx_buffer; 85 const void *tx_buffer; 86 87 /* Size of RX/TX Buffer. */ 88 uint32_t rxtx_page_count; 89 90 /* Lock access to mailbox. */ 91 spinlock_t lock; 92 }; 93 94 /* 95 * Execution context members for an SP. This is a bit like struct 96 * vcpu in a hypervisor. 97 */ 98 struct sp_exec_ctx { 99 /* 100 * Store the stack address to restore C runtime context from after 101 * returning from a synchronous entry into the SP. 102 */ 103 uint64_t c_rt_ctx; 104 105 /* Space to maintain the architectural state of an SP. */ 106 cpu_context_t cpu_ctx; 107 108 /* Track the current runtime state of the SP. */ 109 enum sp_runtime_states rt_state; 110 111 /* Track the current runtime model of the SP. */ 112 enum sp_runtime_model rt_model; 113 }; 114 115 /* 116 * Structure to describe the cumulative properties of an SP. 117 */ 118 struct secure_partition_desc { 119 /* 120 * Execution contexts allocated to this endpoint. Ideally, 121 * we need as many contexts as there are physical cpus only 122 * for a S-EL1 SP which is MP-pinned. 123 */ 124 struct sp_exec_ctx ec[PLATFORM_CORE_COUNT]; 125 126 /* ID of the Secure Partition. */ 127 uint16_t sp_id; 128 129 /* Runtime EL. */ 130 enum sp_runtime_el runtime_el; 131 132 /* Partition UUID. */ 133 uint32_t uuid[4]; 134 135 /* Partition Properties. */ 136 uint32_t properties; 137 138 /* Supported FF-A Version. */ 139 uint32_t ffa_version; 140 141 /* Execution State. */ 142 enum sp_execution_state execution_state; 143 144 /* Mailbox tracking. */ 145 struct mailbox mailbox; 146 147 /* Secondary entrypoint. Only valid for a S-EL1 SP. */ 148 uintptr_t secondary_ep; 149 }; 150 151 /* 152 * This define identifies the only SP that will be initialised and participate 153 * in FF-A communication. The implementation leaves the door open for more SPs 154 * to be managed in future but for now it is reasonable to assume that either a 155 * single S-EL0 or a single S-EL1 SP will be supported. This define will be used 156 * to identify which SP descriptor to initialise and manage during SP runtime. 157 */ 158 #define ACTIVE_SP_DESC_INDEX 0 159 160 /* 161 * Structure to describe the cumulative properties of the Hypervisor and 162 * NS-Endpoints. 163 */ 164 struct ns_endpoint_desc { 165 /* 166 * ID of the NS-Endpoint or Hypervisor. 167 */ 168 uint16_t ns_ep_id; 169 170 /* 171 * Mailbox tracking. 172 */ 173 struct mailbox mailbox; 174 175 /* 176 * Supported FF-A Version 177 */ 178 uint32_t ffa_version; 179 }; 180 181 /* Setup Function for different SP types. */ 182 void spmc_sp_common_setup(struct secure_partition_desc *sp, 183 entry_point_info_t *ep_info); 184 void spmc_el1_sp_setup(struct secure_partition_desc *sp, 185 entry_point_info_t *ep_info); 186 void spmc_sp_common_ep_commit(struct secure_partition_desc *sp, 187 entry_point_info_t *ep_info); 188 189 /* 190 * Helper function to perform a synchronous entry into a SP. 191 */ 192 uint64_t spmc_sp_synchronous_entry(struct sp_exec_ctx *ec); 193 194 /* 195 * Helper function to obtain the descriptor of the current SP on a physical cpu. 196 */ 197 struct secure_partition_desc *spmc_get_current_sp_ctx(void); 198 199 /* 200 * Helper function to obtain the execution context of an SP on a 201 * physical cpu. 202 */ 203 struct sp_exec_ctx *spmc_get_sp_ec(struct secure_partition_desc *sp); 204 205 /* 206 * Helper function to obtain the index of the execution context of an SP on a 207 * physical cpu. 208 */ 209 unsigned int get_ec_index(struct secure_partition_desc *sp); 210 211 uint64_t spmc_ffa_error_return(void *handle, int error_code); 212 213 /* 214 * Ensure a partition ID does not clash and follows the secure world convention. 215 */ 216 bool is_ffa_secure_id_valid(uint16_t partition_id); 217 218 /* 219 * Helper function to obtain the array storing the EL3 220 * Logical Partition descriptors. 221 */ 222 struct el3_lp_desc *get_el3_lp_array(void); 223 224 /* 225 * Helper function to obtain the RX/TX buffer pair descriptor of the Hypervisor 226 * or OS kernel in the normal world or the last SP that was run. 227 */ 228 struct mailbox *spmc_get_mbox_desc(bool secure_origin); 229 230 #endif /* SPMC_H */ 231