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