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