1 /* SPDX-License-Identifier: BSD-3-Clause */ 2 /* 3 * Copyright (c) 2020, Linaro Limited 4 * Copyright (c) 2018-2023, Arm Limited. All rights reserved. 5 */ 6 7 #ifndef __FFA_H 8 #define __FFA_H 9 10 /* This is based on the FF-A 1.0 EAC specification */ 11 12 #include <smccc.h> 13 #include <stdint.h> 14 #include <util.h> 15 16 /* Error codes */ 17 #define FFA_OK 0 18 #define FFA_NOT_SUPPORTED -1 19 #define FFA_INVALID_PARAMETERS -2 20 #define FFA_NO_MEMORY -3 21 #define FFA_BUSY -4 22 #define FFA_INTERRUPTED -5 23 #define FFA_DENIED -6 24 #define FFA_RETRY -7 25 #define FFA_ABORTED -8 26 27 /* FFA_VERSION helpers */ 28 #define FFA_VERSION_MAJOR U(1) 29 #define FFA_VERSION_MAJOR_SHIFT U(16) 30 #define FFA_VERSION_MAJOR_MASK U(0x7FFF) 31 #define FFA_VERSION_MINOR U(1) 32 #define FFA_VERSION_MINOR_SHIFT U(0) 33 #define FFA_VERSION_MINOR_MASK U(0xFFFF) 34 #define MAKE_FFA_VERSION(major, minor) \ 35 ((((major) & FFA_VERSION_MAJOR_MASK) << FFA_VERSION_MAJOR_SHIFT) | \ 36 ((minor) & FFA_VERSION_MINOR_MASK)) 37 38 #define FFA_VERSION_1_0 MAKE_FFA_VERSION(1, 0) 39 #define FFA_VERSION_1_1 MAKE_FFA_VERSION(1, 1) 40 41 /* Function IDs */ 42 #define FFA_ERROR U(0x84000060) 43 #define FFA_SUCCESS_32 U(0x84000061) 44 #define FFA_SUCCESS_64 U(0xC4000061) 45 #define FFA_INTERRUPT U(0x84000062) 46 #define FFA_VERSION U(0x84000063) 47 #define FFA_FEATURES U(0x84000064) 48 #define FFA_RX_RELEASE U(0x84000065) 49 #define FFA_RXTX_MAP_32 U(0x84000066) 50 #define FFA_RXTX_MAP_64 U(0xC4000066) 51 #define FFA_RXTX_UNMAP U(0x84000067) 52 #define FFA_PARTITION_INFO_GET U(0x84000068) 53 #define FFA_ID_GET U(0x84000069) 54 #define FFA_SPM_ID_GET U(0x84000085) 55 #define FFA_MSG_WAIT U(0x8400006B) 56 #define FFA_MSG_YIELD U(0x8400006C) 57 #define FFA_RUN U(0x8400006D) 58 #define FFA_MSG_SEND2 U(0x84000086) 59 #define FFA_MSG_SEND U(0x8400006E) 60 #define FFA_MSG_SEND_DIRECT_REQ_32 U(0x8400006F) 61 #define FFA_MSG_SEND_DIRECT_REQ_64 U(0xC400006F) 62 #define FFA_MSG_SEND_DIRECT_RESP_32 U(0x84000070) 63 #define FFA_MSG_SEND_DIRECT_RESP_64 U(0xC4000070) 64 #define FFA_MSG_POLL U(0x8400006A) 65 #define FFA_MEM_DONATE_32 U(0x84000071) 66 #define FFA_MEM_DONATE_64 U(0xC4000071) 67 #define FFA_MEM_LEND_32 U(0x84000072) 68 #define FFA_MEM_LEND_64 U(0xC4000072) 69 #define FFA_MEM_SHARE_32 U(0x84000073) 70 #define FFA_MEM_SHARE_64 U(0xC4000073) 71 #define FFA_MEM_RETRIEVE_REQ_32 U(0x84000074) 72 #define FFA_MEM_RETRIEVE_REQ_64 U(0xC4000074) 73 #define FFA_MEM_RETRIEVE_RESP U(0x84000075) 74 #define FFA_MEM_RELINQUISH U(0x84000076) 75 #define FFA_MEM_RECLAIM U(0x84000077) 76 #define FFA_MEM_FRAG_RX U(0x8400007A) 77 #define FFA_MEM_FRAG_TX U(0x8400007B) 78 #define FFA_NORMAL_WORLD_RESUME U(0x8400007C) 79 #define FFA_NOTIFICATION_BITMAP_CREATE U(0x8400007D) 80 #define FFA_NOTIFICATION_BITMAP_DESTROY U(0x8400007E) 81 #define FFA_NOTIFICATION_BIND U(0x8400007F) 82 #define FFA_NOTIFICATION_UNBIND U(0x84000080) 83 #define FFA_NOTIFICATION_SET U(0x84000081) 84 #define FFA_NOTIFICATION_GET U(0x84000082) 85 #define FFA_NOTIFICATION_INFO_GET_32 U(0x84000083) 86 #define FFA_NOTIFICATION_INFO_GET_64 U(0xC4000083) 87 #define FFA_SECONDARY_EP_REGISTER_64 U(0xC4000087) 88 #define FFA_MEM_PERM_GET_32 U(0x84000088) 89 #define FFA_MEM_PERM_GET_64 U(0xC4000088) 90 #define FFA_MEM_PERM_SET_32 U(0x84000089) 91 #define FFA_MEM_PERM_SET_64 U(0xC4000089) 92 #define FFA_CONSOLE_LOG_32 U(0x8400008A) 93 #define FFA_CONSOLE_LOG_64 U(0xC400008A) 94 95 #define FFA_FEATURE_NOTIF_PEND_INTR U(0x1) 96 #define FFA_FEATURE_SCHEDULE_RECV_INTR U(0x2) 97 #define FFA_FEATURE_MANAGED_EXIT_INTR U(0x3) 98 99 /* Special value for traffic targeted to the Hypervisor or SPM */ 100 #define FFA_TARGET_INFO_MBZ U(0x0) 101 102 #define FFA_MSG_FLAG_FRAMEWORK BIT(31) 103 #define FFA_MSG_TYPE_MASK GENMASK_32(7, 0) 104 #define FFA_MSG_PSCI U(0x0) 105 #define FFA_MSG_SEND_VM_CREATED U(0x4) 106 #define FFA_MSG_RESP_VM_CREATED U(0x5) 107 #define FFA_MSG_SEND_VM_DESTROYED U(0x6) 108 #define FFA_MSG_RESP_VM_DESTROYED U(0x7) 109 #define FFA_MSG_VERSION_REQ U(0x8) 110 #define FFA_MSG_VERSION_RESP U(0x9) 111 112 /* 113 * Flag used as parameter to FFA_PARTITION_INFO_GET to return partition 114 * count only. 115 */ 116 #define FFA_PARTITION_INFO_GET_COUNT_FLAG BIT(0) 117 118 /* Memory attributes: Normal memory, Write-Back cacheable, Inner shareable */ 119 #define FFA_NORMAL_MEM_REG_ATTR U(0x2f) 120 121 /* Memory access permissions: Read-write */ 122 #define FFA_MEM_ACC_RW BIT(1) 123 124 /* Memory access permissions: executable */ 125 #define FFA_MEM_ACC_EXE BIT(3) 126 127 /* Memory access permissions mask */ 128 #define FFA_MEM_ACC_MASK 0xf 129 130 /* Clear memory before mapping in receiver */ 131 #define FFA_MEMORY_REGION_FLAG_CLEAR BIT(0) 132 /* Relayer may time slice this operation */ 133 #define FFA_MEMORY_REGION_FLAG_TIME_SLICE BIT(1) 134 /* Clear memory after receiver relinquishes it */ 135 #define FFA_MEMORY_REGION_FLAG_CLEAR_RELINQUISH BIT(2) 136 137 /* Share memory transaction */ 138 #define FFA_MEMORY_REGION_TRANSACTION_TYPE_SHARE SHIFT_U32(1, 3) 139 /* Relayer must choose the alignment boundary */ 140 #define FFA_MEMORY_REGION_FLAG_ANY_ALIGNMENT 0 141 142 #define FFA_MEM_PERM_DATA_PERM GENMASK_32(1, 0) 143 #define FFA_MEM_PERM_RW U(0x1) 144 #define FFA_MEM_PERM_RO U(0x3) 145 146 #define FFA_MEM_PERM_INSTRUCTION_PERM BIT(2) 147 #define FFA_MEM_PERM_NX BIT(2) 148 #define FFA_MEM_PERM_X U(0) 149 150 #define FFA_MEM_PERM_RESERVED GENMASK_32(31, 3) 151 152 /* Special value for MBZ parameters */ 153 #define FFA_PARAM_MBZ U(0x0) 154 155 /* 156 * The W1 register in FFA_INTERRUPT and FFA_RUN interfaces contains the target 157 * information. This value has two parts, the SP ID and vCPU ID. The SP ID 158 * identifies the SP to resume and the vCPU ID identifies the vCPU or execution 159 * context to resume (FF-A v1.1 section 4.8). 160 */ 161 #define FFA_TARGET_INFO_SET(sp_id, vcpu_id) (((sp_id) << 16) | (vcpu_id)) 162 #define FFA_TARGET_INFO_GET_SP_ID(info) (((info) >> 16) & 0xffff) 163 #define FFA_TARGET_INFO_GET_VCPU_ID(info) ((info) & 0xffff) 164 165 /* 166 * Flags used for the FFA_PARTITION_INFO_GET return message: 167 * BIT(0): Supports receipt of direct requests 168 * BIT(1): Can send direct requests 169 * BIT(2): Can send and receive indirect messages 170 * BIT(3): Supports receipt of notifications 171 * BIT(4-5): Partition ID is a PE endpoint ID 172 */ 173 #define FFA_PART_PROP_DIRECT_REQ_RECV BIT(0) 174 #define FFA_PART_PROP_DIRECT_REQ_SEND BIT(1) 175 #define FFA_PART_PROP_INDIRECT_MSGS BIT(2) 176 #define FFA_PART_PROP_RECV_NOTIF BIT(3) 177 #define FFA_PART_PROP_IS_PE_ID SHIFT_U32(0, 4) 178 #define FFA_PART_PROP_IS_SEPID_INDEP SHIFT_U32(1, 4) 179 #define FFA_PART_PROP_IS_SEPID_DEP SHIFT_U32(2, 4) 180 #define FFA_PART_PROP_IS_AUX_ID SHIFT_U32(3, 4) 181 #define FFA_PART_PROP_NOTIF_CREATED BIT(6) 182 #define FFA_PART_PROP_NOTIF_DESTROYED BIT(7) 183 #define FFA_PART_PROP_AARCH64_STATE BIT(8) 184 185 #define FFA_MEMORY_HANDLE_HYPERVISOR_BIT BIT64(63) 186 #define FFA_MEMORY_HANDLE_SECURE_BIT BIT64(45) 187 #define FFA_MEMORY_HANDLE_NON_SECURE_BIT BIT64(44) 188 /* 189 * Codes the OP-TEE partition/guest ID into a cookie in order to know which 190 * partition to activate when reclaiming the shared memory. This field is 0 191 * unless CFG_NS_VIRTUALIZATION is enabled. 192 */ 193 #define FFA_MEMORY_HANDLE_PRTN_SHIFT 16 194 #define FFA_MEMORY_HANDLE_PRTN_MASK GENMASK_32(16, 0) 195 196 197 #define FFA_BOOT_INFO_NAME_LEN U(16) 198 199 /* Boot Info descriptors type */ 200 #define FFA_BOOT_INFO_TYPE_IMDEF BIT(7) 201 #define FFA_BOOT_INFO_TYPE_ID_MASK GENMASK_32(6, 0) 202 #define FFA_BOOT_INFO_TYPE_ID_FDT U(0) 203 #define FFA_BOOT_INFO_TYPE_ID_HOB U(1) 204 205 /* Boot Info descriptors flags */ 206 #define FFA_BOOT_INFO_FLAG_NAME_FORMAT_MASK GENMASK_32(1, 0) 207 #define FFA_BOOT_INFO_FLAG_NAME_FORMAT_STRING U(0) 208 #define FFA_BOOT_INFO_FLAG_NAME_FORMAT_UUID U(1) 209 210 /** Bits [3:2] encode the format of the content field in ffa_boot_info_desc. */ 211 #define FFA_BOOT_INFO_FLAG_CONTENT_FORMAT_SHIFT U(2) 212 #define FFA_BOOT_INFO_FLAG_CONTENT_FORMAT_MASK GENMASK_32(3, 2) 213 #define FFA_BOOT_INFO_FLAG_CONTENT_FORMAT_VALUE U(1) 214 #define FFA_BOOT_INFO_FLAG_CONTENT_FORMAT_ADDR U(0) 215 216 #define FFA_BOOT_INFO_SIGNATURE U(0xFFA) 217 #define FFA_BOOT_INFO_VERSION U(0x10001) 218 219 #define FFA_CONSOLE_LOG_CHAR_COUNT_MASK GENMASK_32(7, 0) 220 #define FFA_CONSOLE_LOG_32_MAX_MSG_LEN U(24) 221 #define FFA_CONSOLE_LOG_64_MAX_MSG_LEN U(48) 222 223 #ifndef __ASSEMBLER__ 224 /* Constituent memory region descriptor */ 225 struct ffa_address_range { 226 uint64_t address; 227 uint32_t page_count; 228 uint32_t reserved; 229 }; 230 231 /* Composite memory region descriptor */ 232 struct ffa_mem_region { 233 uint32_t total_page_count; 234 uint32_t address_range_count; 235 uint64_t reserved; 236 struct ffa_address_range address_range_array[]; 237 }; 238 239 /* Memory access permissions descriptor */ 240 struct ffa_mem_access_perm { 241 uint16_t endpoint_id; 242 uint8_t perm; 243 uint8_t flags; 244 }; 245 246 /* Endpoint memory access descriptor */ 247 struct ffa_mem_access { 248 struct ffa_mem_access_perm access_perm; 249 uint32_t region_offs; 250 uint64_t reserved; 251 }; 252 253 /* Lend, donate or share memory transaction descriptor */ 254 struct ffa_mem_transaction_1_0 { 255 uint16_t sender_id; 256 uint8_t mem_reg_attr; 257 uint8_t reserved0; 258 uint32_t flags; 259 uint64_t global_handle; 260 uint64_t tag; 261 uint32_t reserved1; 262 uint32_t mem_access_count; 263 struct ffa_mem_access mem_access_array[]; 264 }; 265 266 struct ffa_mem_transaction_1_1 { 267 uint16_t sender_id; 268 uint16_t mem_reg_attr; 269 uint32_t flags; 270 uint64_t global_handle; 271 uint64_t tag; 272 uint32_t mem_access_size; 273 uint32_t mem_access_count; 274 uint32_t mem_access_offs; 275 uint8_t reserved[12]; 276 }; 277 278 /* 279 * The parts needed from struct ffa_mem_transaction_1_0 or struct 280 * ffa_mem_transaction_1_1, used to provide an abstraction of difference in 281 * data structures between version 1.0 and 1.1. This is just an internal 282 * interface and can be changed without changing any ABI. 283 */ 284 struct ffa_mem_transaction_x { 285 uint16_t sender_id; 286 uint8_t mem_reg_attr; 287 uint8_t flags; 288 uint8_t mem_access_size; 289 uint8_t mem_access_count; 290 uint16_t mem_access_offs; 291 uint64_t global_handle; 292 uint64_t tag; 293 }; 294 295 #define FFA_UUID_SIZE 16 296 297 /* Partition information descriptor */ 298 struct ffa_partition_info_x { 299 uint16_t id; 300 uint16_t execution_context; 301 uint32_t partition_properties; 302 /* 303 * The uuid field is absent in FF-A 1.0, and an array of 16 304 * (FFA_UUID_SIZE) from FF-A 1.1 305 */ 306 uint8_t uuid[]; 307 }; 308 309 /* Descriptor to relinquish a memory region (FFA_MEM_RELINQUISH) */ 310 struct ffa_mem_relinquish { 311 uint64_t handle; 312 uint32_t flags; 313 uint32_t endpoint_count; 314 uint16_t endpoint_id_array[]; 315 }; 316 317 /* FF-A v1.0 boot information name-value pairs */ 318 struct ffa_boot_info_nvp_1_0 { 319 uint32_t name[4]; 320 uint64_t value; 321 uint64_t size; 322 }; 323 324 /* FF-A v1.0 boot information descriptor */ 325 struct ffa_boot_info_1_0 { 326 uint32_t magic; 327 uint32_t count; 328 struct ffa_boot_info_nvp_1_0 nvp[]; 329 }; 330 331 /* FF-A v1.1 boot information descriptor */ 332 struct ffa_boot_info_1_1 { 333 char name[FFA_BOOT_INFO_NAME_LEN]; 334 uint8_t type; 335 uint8_t reserved; 336 uint16_t flags; 337 uint32_t size; 338 uint64_t contents; 339 }; 340 341 /* FF-A v1.1 boot information header */ 342 struct ffa_boot_info_header_1_1 { 343 uint32_t signature; 344 uint32_t version; 345 uint32_t blob_size; 346 uint32_t desc_size; 347 uint32_t desc_count; 348 uint32_t desc_offset; 349 uint64_t reserved; 350 }; 351 352 #endif /*__ASSEMBLER__*/ 353 #endif /* __FFA_H */ 354