1 /* 2 * Copyright (c) 2020-2025, Arm Limited. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef FFA_SVC_H 8 #define FFA_SVC_H 9 10 #include <stdbool.h> 11 12 #include <lib/smccc.h> 13 #include <lib/utils_def.h> 14 #include <tools_share/uuid.h> 15 16 /* FFA error codes. */ 17 #define FFA_ERROR_NOT_SUPPORTED -1 18 #define FFA_ERROR_INVALID_PARAMETER -2 19 #define FFA_ERROR_NO_MEMORY -3 20 #define FFA_ERROR_BUSY -4 21 #define FFA_ERROR_INTERRUPTED -5 22 #define FFA_ERROR_DENIED -6 23 #define FFA_ERROR_RETRY -7 24 25 /* The macros below are used to identify FFA calls from the SMC function ID */ 26 #define FFA_FNUM_MIN_VALUE U(0x60) 27 #define FFA_FNUM_MAX_VALUE U(0x8E) 28 #define is_ffa_fid(fid) __extension__ ({ \ 29 __typeof__(fid) _fid = (fid); \ 30 ((GET_SMC_NUM(_fid) >= FFA_FNUM_MIN_VALUE) && \ 31 (GET_SMC_NUM(_fid) <= FFA_FNUM_MAX_VALUE)); }) 32 33 /* FFA_VERSION helpers */ 34 #define FFA_VERSION_MAJOR U(1) 35 #define FFA_VERSION_MAJOR_SHIFT 16 36 #define FFA_VERSION_MAJOR_MASK U(0x7FFF) 37 #define FFA_VERSION_MINOR U(2) 38 #define FFA_VERSION_MINOR_SHIFT 0 39 #define FFA_VERSION_MINOR_MASK U(0xFFFF) 40 #define FFA_VERSION_BIT31_MASK U(0x1u << 31) 41 #define FFA_VERSION_MASK U(0xFFFFFFFF) 42 43 44 #define MAKE_FFA_VERSION(major, minor) \ 45 ((((major) & FFA_VERSION_MAJOR_MASK) << FFA_VERSION_MAJOR_SHIFT) | \ 46 (((minor) & FFA_VERSION_MINOR_MASK) << FFA_VERSION_MINOR_SHIFT)) 47 #define FFA_VERSION_COMPILED MAKE_FFA_VERSION(FFA_VERSION_MAJOR, \ 48 FFA_VERSION_MINOR) 49 50 /* FFA_MSG_SEND helpers */ 51 #define FFA_MSG_SEND_ATTRS_BLK_SHIFT U(0) 52 #define FFA_MSG_SEND_ATTRS_BLK_MASK U(0x1) 53 #define FFA_MSG_SEND_ATTRS_BLK U(0) 54 #define FFA_MSG_SEND_ATTRS_BLK_NOT U(1) 55 #define FFA_MSG_SEND_ATTRS(blk) \ 56 (((blk) & FFA_MSG_SEND_ATTRS_BLK_MASK) \ 57 << FFA_MSG_SEND_ATTRS_BLK_SHIFT) 58 59 /* Defines for FF-A framework messages exchanged using direct messages. */ 60 #define FFA_FWK_MSG_BIT BIT_32(31) 61 #define FFA_FWK_MSG_MASK U(0xFF) 62 #define FFA_FWK_MSG_PSCI U(0x0) 63 64 /* Defines for FF-A power management messages framework messages. */ 65 #define FFA_PM_MSG_WB_REQ U(0x1) /* Warm boot request. */ 66 #define FFA_PM_MSG_PM_RESP U(0x2) /* Response to PSCI or warmboot req. */ 67 68 /* FF-A warm boot types. */ 69 #define FFA_WB_TYPE_S2RAM 0x0 70 #define FFA_WB_TYPE_NOTS2RAM 0x1 71 72 /* Get FFA fastcall std FID from function number */ 73 #define FFA_FID(smc_cc, func_num) \ 74 ((SMC_TYPE_FAST << FUNCID_TYPE_SHIFT) | \ 75 ((smc_cc) << FUNCID_CC_SHIFT) | \ 76 (OEN_STD_START << FUNCID_OEN_SHIFT) | \ 77 ((func_num) << FUNCID_NUM_SHIFT)) 78 79 /* FFA function numbers */ 80 #define FFA_FNUM_ERROR U(0x60) 81 #define FFA_FNUM_SUCCESS U(0x61) 82 #define FFA_FNUM_INTERRUPT U(0x62) 83 #define FFA_FNUM_VERSION U(0x63) 84 #define FFA_FNUM_FEATURES U(0x64) 85 #define FFA_FNUM_RX_RELEASE U(0x65) 86 #define FFA_FNUM_RXTX_MAP U(0x66) 87 #define FFA_FNUM_RXTX_UNMAP U(0x67) 88 #define FFA_FNUM_PARTITION_INFO_GET U(0x68) 89 #define FFA_FNUM_ID_GET U(0x69) 90 #define FFA_FNUM_MSG_POLL U(0x6A) /* Legacy FF-A v1.0 */ 91 #define FFA_FNUM_MSG_WAIT U(0x6B) 92 #define FFA_FNUM_MSG_YIELD U(0x6C) 93 #define FFA_FNUM_MSG_RUN U(0x6D) 94 #define FFA_FNUM_MSG_SEND U(0x6E) /* Legacy FF-A v1.0 */ 95 #define FFA_FNUM_MSG_SEND_DIRECT_REQ U(0x6F) 96 #define FFA_FNUM_MSG_SEND_DIRECT_RESP U(0x70) 97 #define FFA_FNUM_MEM_DONATE U(0x71) 98 #define FFA_FNUM_MEM_LEND U(0x72) 99 #define FFA_FNUM_MEM_SHARE U(0x73) 100 #define FFA_FNUM_MEM_RETRIEVE_REQ U(0x74) 101 #define FFA_FNUM_MEM_RETRIEVE_RESP U(0x75) 102 #define FFA_FNUM_MEM_RELINQUISH U(0x76) 103 #define FFA_FNUM_MEM_RECLAIM U(0x77) 104 #define FFA_FNUM_MEM_FRAG_RX U(0x7A) 105 #define FFA_FNUM_MEM_FRAG_TX U(0x7B) 106 #define FFA_FNUM_NORMAL_WORLD_RESUME U(0x7C) 107 108 /* FF-A v1.1 */ 109 #define FFA_FNUM_NOTIFICATION_BITMAP_CREATE U(0x7D) 110 #define FFA_FNUM_NOTIFICATION_BITMAP_DESTROY U(0x7E) 111 #define FFA_FNUM_NOTIFICATION_BIND U(0x7F) 112 #define FFA_FNUM_NOTIFICATION_UNBIND U(0x80) 113 #define FFA_FNUM_NOTIFICATION_SET U(0x81) 114 #define FFA_FNUM_NOTIFICATION_GET U(0x82) 115 #define FFA_FNUM_NOTIFICATION_INFO_GET U(0x83) 116 #define FFA_FNUM_RX_ACQUIRE U(0x84) 117 #define FFA_FNUM_SPM_ID_GET U(0x85) 118 #define FFA_FNUM_MSG_SEND2 U(0x86) 119 #define FFA_FNUM_SECONDARY_EP_REGISTER U(0x87) 120 #define FFA_FNUM_MEM_PERM_GET U(0x88) 121 #define FFA_FNUM_MEM_PERM_SET U(0x89) 122 123 /* FF-A v1.2 */ 124 #define FFA_FNUM_PARTITION_INFO_GET_REGS U(0x8B) 125 #define FFA_FNUM_EL3_INTR_HANDLE U(0x8C) 126 #define FFA_FNUM_MSG_SEND_DIRECT_REQ2 U(0x8D) 127 #define FFA_FNUM_MSG_SEND_DIRECT_RESP2 U(0x8E) 128 129 #define FFA_FNUM_CONSOLE_LOG U(0x8A) 130 131 /* FFA SMC32 FIDs */ 132 #define FFA_ERROR FFA_FID(SMC_32, FFA_FNUM_ERROR) 133 #define FFA_SUCCESS_SMC32 FFA_FID(SMC_32, FFA_FNUM_SUCCESS) 134 #define FFA_INTERRUPT FFA_FID(SMC_32, FFA_FNUM_INTERRUPT) 135 #define FFA_VERSION FFA_FID(SMC_32, FFA_FNUM_VERSION) 136 #define FFA_FEATURES FFA_FID(SMC_32, FFA_FNUM_FEATURES) 137 #define FFA_RX_RELEASE FFA_FID(SMC_32, FFA_FNUM_RX_RELEASE) 138 #define FFA_RX_ACQUIRE FFA_FID(SMC_32, FFA_FNUM_RX_ACQUIRE) 139 #define FFA_RXTX_MAP_SMC32 FFA_FID(SMC_32, FFA_FNUM_RXTX_MAP) 140 #define FFA_RXTX_UNMAP FFA_FID(SMC_32, FFA_FNUM_RXTX_UNMAP) 141 #define FFA_PARTITION_INFO_GET FFA_FID(SMC_32, FFA_FNUM_PARTITION_INFO_GET) 142 #define FFA_ID_GET FFA_FID(SMC_32, FFA_FNUM_ID_GET) 143 #define FFA_MSG_POLL FFA_FID(SMC_32, FFA_FNUM_MSG_POLL) 144 #define FFA_MSG_WAIT FFA_FID(SMC_32, FFA_FNUM_MSG_WAIT) 145 #define FFA_MSG_YIELD FFA_FID(SMC_32, FFA_FNUM_MSG_YIELD) 146 #define FFA_MSG_RUN FFA_FID(SMC_32, FFA_FNUM_MSG_RUN) 147 #define FFA_MSG_SEND FFA_FID(SMC_32, FFA_FNUM_MSG_SEND) 148 #define FFA_MSG_SEND2 FFA_FID(SMC_32, FFA_FNUM_MSG_SEND2) 149 #define FFA_MSG_SEND_DIRECT_REQ_SMC32 \ 150 FFA_FID(SMC_32, FFA_FNUM_MSG_SEND_DIRECT_REQ) 151 #define FFA_MSG_SEND_DIRECT_RESP_SMC32 \ 152 FFA_FID(SMC_32, FFA_FNUM_MSG_SEND_DIRECT_RESP) 153 #define FFA_MEM_DONATE_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_DONATE) 154 #define FFA_MEM_LEND_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_LEND) 155 #define FFA_MEM_SHARE_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_SHARE) 156 #define FFA_MEM_RETRIEVE_REQ_SMC32 \ 157 FFA_FID(SMC_32, FFA_FNUM_MEM_RETRIEVE_REQ) 158 #define FFA_MEM_RETRIEVE_RESP FFA_FID(SMC_32, FFA_FNUM_MEM_RETRIEVE_RESP) 159 #define FFA_MEM_RELINQUISH FFA_FID(SMC_32, FFA_FNUM_MEM_RELINQUISH) 160 #define FFA_MEM_RECLAIM FFA_FID(SMC_32, FFA_FNUM_MEM_RECLAIM) 161 #define FFA_NOTIFICATION_BITMAP_CREATE \ 162 FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_BITMAP_CREATE) 163 #define FFA_NOTIFICATION_BITMAP_DESTROY \ 164 FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_BITMAP_DESTROY) 165 #define FFA_NOTIFICATION_BIND FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_BIND) 166 #define FFA_NOTIFICATION_UNBIND FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_UNBIND) 167 #define FFA_NOTIFICATION_SET FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_SET) 168 #define FFA_NOTIFICATION_GET FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_GET) 169 #define FFA_NOTIFICATION_INFO_GET \ 170 FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_INFO_GET) 171 #define FFA_MEM_FRAG_RX FFA_FID(SMC_32, FFA_FNUM_MEM_FRAG_RX) 172 #define FFA_MEM_FRAG_TX FFA_FID(SMC_32, FFA_FNUM_MEM_FRAG_TX) 173 #define FFA_SPM_ID_GET FFA_FID(SMC_32, FFA_FNUM_SPM_ID_GET) 174 #define FFA_NORMAL_WORLD_RESUME FFA_FID(SMC_32, FFA_FNUM_NORMAL_WORLD_RESUME) 175 #define FFA_EL3_INTR_HANDLE FFA_FID(SMC_32, FFA_FNUM_EL3_INTR_HANDLE) 176 #define FFA_MEM_PERM_GET_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_PERM_GET) 177 #define FFA_MEM_PERM_SET_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_PERM_SET) 178 #define FFA_CONSOLE_LOG_SMC32 FFA_FID(SMC_32, FFA_FNUM_CONSOLE_LOG) 179 180 /* FFA SMC64 FIDs */ 181 #define FFA_ERROR_SMC64 FFA_FID(SMC_64, FFA_FNUM_ERROR) 182 #define FFA_SUCCESS_SMC64 FFA_FID(SMC_64, FFA_FNUM_SUCCESS) 183 #define FFA_RXTX_MAP_SMC64 FFA_FID(SMC_64, FFA_FNUM_RXTX_MAP) 184 #define FFA_MSG_SEND_DIRECT_REQ_SMC64 \ 185 FFA_FID(SMC_64, FFA_FNUM_MSG_SEND_DIRECT_REQ) 186 #define FFA_MSG_SEND_DIRECT_RESP_SMC64 \ 187 FFA_FID(SMC_64, FFA_FNUM_MSG_SEND_DIRECT_RESP) 188 #define FFA_MEM_DONATE_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_DONATE) 189 #define FFA_MEM_LEND_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_LEND) 190 #define FFA_MEM_SHARE_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_SHARE) 191 #define FFA_MEM_RETRIEVE_REQ_SMC64 \ 192 FFA_FID(SMC_64, FFA_FNUM_MEM_RETRIEVE_REQ) 193 #define FFA_SECONDARY_EP_REGISTER_SMC64 \ 194 FFA_FID(SMC_64, FFA_FNUM_SECONDARY_EP_REGISTER) 195 #define FFA_NOTIFICATION_INFO_GET_SMC64 \ 196 FFA_FID(SMC_64, FFA_FNUM_NOTIFICATION_INFO_GET) 197 #define FFA_PARTITION_INFO_GET_REGS_SMC64 \ 198 FFA_FID(SMC_64, FFA_FNUM_PARTITION_INFO_GET_REGS) 199 #define FFA_CONSOLE_LOG_SMC64 FFA_FID(SMC_64, FFA_FNUM_CONSOLE_LOG) 200 #define FFA_MSG_SEND_DIRECT_REQ2_SMC64 \ 201 FFA_FID(SMC_64, FFA_FNUM_MSG_SEND_DIRECT_REQ2) 202 #define FFA_MSG_SEND_DIRECT_RESP2_SMC64 \ 203 FFA_FID(SMC_64, FFA_FNUM_MSG_SEND_DIRECT_RESP2) 204 #define FFA_MEM_PERM_GET_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_PERM_GET) 205 #define FFA_MEM_PERM_SET_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_PERM_SET) 206 207 /* 208 * FF-A partition properties values. 209 */ 210 #define FFA_PARTITION_DIRECT_REQ_RECV U(1 << 0) 211 #define FFA_PARTITION_DIRECT_REQ_SEND U(1 << 1) 212 #define FFA_PARTITION_INDIRECT_MSG U(1 << 2) 213 #define FFA_PARTITION_DIRECT_REQ2_RECV U(1 << 9) 214 #define FFA_PARTITION_DIRECT_REQ2_SEND U(1 << 10) 215 216 /* 217 * Reserve a special value for traffic targeted to the Hypervisor or SPM. 218 */ 219 #define FFA_TARGET_INFO_MBZ U(0x0) 220 221 /* 222 * Reserve a special value for MBZ parameters. 223 */ 224 #define FFA_PARAM_MBZ U(0x0) 225 226 /* 227 * Maximum FF-A endpoint id value 228 */ 229 #define FFA_ENDPOINT_ID_MAX U(1 << 16) 230 231 /* 232 * Reserve endpoint id for the SPMD. 233 */ 234 #define SPMD_DIRECT_MSG_ENDPOINT_ID U(FFA_ENDPOINT_ID_MAX - 1) 235 236 /* Mask and shift to check valid secure FF-A Endpoint ID. */ 237 #define SPMC_SECURE_ID_MASK U(1) 238 #define SPMC_SECURE_ID_SHIFT U(15) 239 240 /* 241 * Partition Count Flag in FFA_PARTITION_INFO_GET. 242 */ 243 #define FFA_PARTITION_INFO_GET_COUNT_FLAG_MASK U(1 << 0) 244 245 /* 246 * Mask for source and destination endpoint id in 247 * a direct message request/response. 248 */ 249 #define FFA_DIRECT_MSG_ENDPOINT_ID_MASK U(0xffff) 250 251 /* 252 * Bit shift for destination endpoint id in a direct message request/response. 253 */ 254 #define FFA_DIRECT_MSG_DESTINATION_SHIFT U(0) 255 256 /* 257 * Bit shift for source endpoint id in a direct message request/response. 258 */ 259 #define FFA_DIRECT_MSG_SOURCE_SHIFT U(16) 260 261 /****************************************************************************** 262 * ffa_endpoint_destination 263 *****************************************************************************/ 264 static inline uint16_t ffa_endpoint_destination(unsigned int ep) 265 { 266 return (ep >> FFA_DIRECT_MSG_DESTINATION_SHIFT) & 267 FFA_DIRECT_MSG_ENDPOINT_ID_MASK; 268 } 269 270 /****************************************************************************** 271 * ffa_endpoint_source 272 *****************************************************************************/ 273 static inline uint16_t ffa_endpoint_source(unsigned int ep) 274 { 275 return (ep >> FFA_DIRECT_MSG_SOURCE_SHIFT) & 276 FFA_DIRECT_MSG_ENDPOINT_ID_MASK; 277 } 278 279 /****************************************************************************** 280 * FF-A helper functions to determine partition ID world. 281 *****************************************************************************/ 282 283 /* 284 * Determine if provided ID is in the secure world. 285 */ 286 static inline bool ffa_is_secure_world_id(uint16_t id) 287 { 288 return ((id >> SPMC_SECURE_ID_SHIFT) & SPMC_SECURE_ID_MASK) == 1; 289 } 290 291 /* 292 * Determine if provided ID is in the normal world. 293 */ 294 static inline bool ffa_is_normal_world_id(uint16_t id) 295 { 296 return !ffa_is_secure_world_id(id); 297 } 298 299 300 /****************************************************************************** 301 * Boot information protocol as per the FF-A v1.1 spec. 302 *****************************************************************************/ 303 #define FFA_INIT_DESC_SIGNATURE 0x00000FFA 304 305 /* Boot information type. */ 306 #define FFA_BOOT_INFO_TYPE_STD U(0x0) 307 #define FFA_BOOT_INFO_TYPE_IMPL U(0x1) 308 309 #define FFA_BOOT_INFO_TYPE_MASK U(0x1) 310 #define FFA_BOOT_INFO_TYPE_SHIFT U(0x7) 311 #define FFA_BOOT_INFO_TYPE(type) \ 312 (((type) & FFA_BOOT_INFO_TYPE_MASK) \ 313 << FFA_BOOT_INFO_TYPE_SHIFT) 314 315 /* Boot information identifier. */ 316 #define FFA_BOOT_INFO_TYPE_ID_FDT U(0x0) 317 #define FFA_BOOT_INFO_TYPE_ID_HOB U(0x1) 318 319 #define FFA_BOOT_INFO_TYPE_ID_MASK U(0x3F) 320 #define FFA_BOOT_INFO_TYPE_ID_SHIFT U(0x0) 321 #define FFA_BOOT_INFO_TYPE_ID(type) \ 322 (((type) & FFA_BOOT_INFO_TYPE_ID_MASK) \ 323 << FFA_BOOT_INFO_TYPE_ID_SHIFT) 324 325 /* Format of Flags Name field. */ 326 #define FFA_BOOT_INFO_FLAG_NAME_STRING U(0x0) 327 #define FFA_BOOT_INFO_FLAG_NAME_UUID U(0x1) 328 329 #define FFA_BOOT_INFO_FLAG_NAME_MASK U(0x3) 330 #define FFA_BOOT_INFO_FLAG_NAME_SHIFT U(0x0) 331 #define FFA_BOOT_INFO_FLAG_NAME(type) \ 332 (((type) & FFA_BOOT_INFO_FLAG_NAME_MASK)\ 333 << FFA_BOOT_INFO_FLAG_NAME_SHIFT) 334 335 /* Format of Flags Contents field. */ 336 #define FFA_BOOT_INFO_FLAG_CONTENT_ADR U(0x0) 337 #define FFA_BOOT_INFO_FLAG_CONTENT_VAL U(0x1) 338 339 #define FFA_BOOT_INFO_FLAG_CONTENT_MASK U(0x1) 340 #define FFA_BOOT_INFO_FLAG_CONTENT_SHIFT U(0x2) 341 #define FFA_BOOT_INFO_FLAG_CONTENT(content) \ 342 (((content) & FFA_BOOT_INFO_FLAG_CONTENT_MASK) \ 343 << FFA_BOOT_INFO_FLAG_CONTENT_SHIFT) 344 345 /* Boot information descriptor. */ 346 struct ffa_boot_info_desc { 347 uint8_t name[16]; 348 uint8_t type; 349 uint8_t reserved; 350 uint16_t flags; 351 uint32_t size_boot_info; 352 uint64_t content; 353 }; 354 355 /* Boot information header. */ 356 struct ffa_boot_info_header { 357 uint32_t signature; /* 0xFFA */ 358 uint32_t version; 359 uint32_t size_boot_info_blob; 360 uint32_t size_boot_info_desc; 361 uint32_t count_boot_info_desc; 362 uint32_t offset_boot_info_desc; 363 uint64_t reserved; 364 }; 365 366 /* FF-A Partition Info Get related macros. */ 367 #define FFA_PARTITION_INFO_GET_PROPERTIES_V1_0_MASK U(0x7) 368 #define FFA_PARTITION_INFO_GET_EXEC_STATE_SHIFT U(8) 369 #define FFA_PARTITION_INFO_GET_AARCH32_STATE U(0) 370 #define FFA_PARTITION_INFO_GET_AARCH64_STATE U(1) 371 372 /** 373 * Holds information returned for each partition by the FFA_PARTITION_INFO_GET 374 * interface. 375 */ 376 struct ffa_partition_info_v1_0 { 377 uint16_t ep_id; 378 uint16_t execution_ctx_count; 379 uint32_t properties; 380 }; 381 382 /* Extended structure for FF-A v1.1. */ 383 struct ffa_partition_info_v1_1 { 384 uint16_t ep_id; 385 uint16_t execution_ctx_count; 386 uint32_t properties; 387 uint32_t uuid[4]; 388 }; 389 390 #endif /* FFA_SVC_H */ 391