1 /* 2 * Copyright (c) 2020-2021, 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 <lib/smccc.h> 11 #include <lib/utils_def.h> 12 #include <tools_share/uuid.h> 13 14 /* FFA error codes. */ 15 #define FFA_ERROR_NOT_SUPPORTED -1 16 #define FFA_ERROR_INVALID_PARAMETER -2 17 #define FFA_ERROR_NO_MEMORY -3 18 #define FFA_ERROR_BUSY -4 19 #define FFA_ERROR_INTERRUPTED -5 20 #define FFA_ERROR_DENIED -6 21 #define FFA_ERROR_RETRY -7 22 23 /* The macros below are used to identify FFA calls from the SMC function ID */ 24 #define FFA_FNUM_MIN_VALUE U(0x60) 25 #define FFA_FNUM_MAX_VALUE U(0x87) 26 #define is_ffa_fid(fid) __extension__ ({ \ 27 __typeof__(fid) _fid = (fid); \ 28 ((GET_SMC_NUM(_fid) >= FFA_FNUM_MIN_VALUE) && \ 29 (GET_SMC_NUM(_fid) <= FFA_FNUM_MAX_VALUE)); }) 30 31 /* FFA_VERSION helpers */ 32 #define FFA_VERSION_MAJOR U(1) 33 #define FFA_VERSION_MAJOR_SHIFT 16 34 #define FFA_VERSION_MAJOR_MASK U(0x7FFF) 35 #define FFA_VERSION_MINOR U(1) 36 #define FFA_VERSION_MINOR_SHIFT 0 37 #define FFA_VERSION_MINOR_MASK U(0xFFFF) 38 #define FFA_VERSION_BIT31_MASK U(0x1u << 31) 39 40 41 #define MAKE_FFA_VERSION(major, minor) \ 42 ((((major) & FFA_VERSION_MAJOR_MASK) << FFA_VERSION_MAJOR_SHIFT) | \ 43 (((minor) & FFA_VERSION_MINOR_MASK) << FFA_VERSION_MINOR_SHIFT)) 44 #define FFA_VERSION_COMPILED MAKE_FFA_VERSION(FFA_VERSION_MAJOR, \ 45 FFA_VERSION_MINOR) 46 47 /* FFA_MSG_SEND helpers */ 48 #define FFA_MSG_SEND_ATTRS_BLK_SHIFT U(0) 49 #define FFA_MSG_SEND_ATTRS_BLK_MASK U(0x1) 50 #define FFA_MSG_SEND_ATTRS_BLK U(0) 51 #define FFA_MSG_SEND_ATTRS_BLK_NOT U(1) 52 #define FFA_MSG_SEND_ATTRS(blk) \ 53 (((blk) & FFA_MSG_SEND_ATTRS_BLK_MASK) \ 54 << FFA_MSG_SEND_ATTRS_BLK_SHIFT) 55 56 /* Get FFA fastcall std FID from function number */ 57 #define FFA_FID(smc_cc, func_num) \ 58 ((SMC_TYPE_FAST << FUNCID_TYPE_SHIFT) | \ 59 ((smc_cc) << FUNCID_CC_SHIFT) | \ 60 (OEN_STD_START << FUNCID_OEN_SHIFT) | \ 61 ((func_num) << FUNCID_NUM_SHIFT)) 62 63 /* FFA function numbers */ 64 #define FFA_FNUM_ERROR U(0x60) 65 #define FFA_FNUM_SUCCESS U(0x61) 66 #define FFA_FNUM_INTERRUPT U(0x62) 67 #define FFA_FNUM_VERSION U(0x63) 68 #define FFA_FNUM_FEATURES U(0x64) 69 #define FFA_FNUM_RX_RELEASE U(0x65) 70 #define FFA_FNUM_RXTX_MAP U(0x66) 71 #define FFA_FNUM_RXTX_UNMAP U(0x67) 72 #define FFA_FNUM_PARTITION_INFO_GET U(0x68) 73 #define FFA_FNUM_ID_GET U(0x69) 74 #define FFA_FNUM_MSG_POLL U(0x6A) /* Legacy FF-A v1.0 */ 75 #define FFA_FNUM_MSG_WAIT U(0x6B) 76 #define FFA_FNUM_MSG_YIELD U(0x6C) 77 #define FFA_FNUM_MSG_RUN U(0x6D) 78 #define FFA_FNUM_MSG_SEND U(0x6E) /* Legacy FF-A v1.0 */ 79 #define FFA_FNUM_MSG_SEND_DIRECT_REQ U(0x6F) 80 #define FFA_FNUM_MSG_SEND_DIRECT_RESP U(0x70) 81 #define FFA_FNUM_MEM_DONATE U(0x71) 82 #define FFA_FNUM_MEM_LEND U(0x72) 83 #define FFA_FNUM_MEM_SHARE U(0x73) 84 #define FFA_FNUM_MEM_RETRIEVE_REQ U(0x74) 85 #define FFA_FNUM_MEM_RETRIEVE_RESP U(0x75) 86 #define FFA_FNUM_MEM_RELINQUISH U(0x76) 87 #define FFA_FNUM_MEM_RECLAIM U(0x77) 88 #define FFA_FNUM_NORMAL_WORLD_RESUME U(0x7C) 89 90 /* FF-A v1.1 */ 91 #define FFA_FNUM_NOTIFICATION_BITMAP_CREATE U(0x7D) 92 #define FFA_FNUM_NOTIFICATION_BITMAP_DESTROY U(0x7E) 93 #define FFA_FNUM_NOTIFICATION_BIND U(0x7F) 94 #define FFA_FNUM_NOTIFICATION_UNBIND U(0x80) 95 #define FFA_FNUM_NOTIFICATION_SET U(0x81) 96 #define FFA_FNUM_NOTIFICATION_GET U(0x82) 97 #define FFA_FNUM_NOTIFICATION_INFO_GET U(0x83) 98 #define FFA_FNUM_RX_ACQUIRE U(0x84) 99 #define FFA_FNUM_SPM_ID_GET U(0x85) 100 #define FFA_FNUM_MSG_SEND2 U(0x86) 101 #define FFA_FNUM_SECONDARY_EP_REGISTER U(0x87) 102 103 /* FFA SMC32 FIDs */ 104 #define FFA_ERROR FFA_FID(SMC_32, FFA_FNUM_ERROR) 105 #define FFA_SUCCESS_SMC32 FFA_FID(SMC_32, FFA_FNUM_SUCCESS) 106 #define FFA_INTERRUPT FFA_FID(SMC_32, FFA_FNUM_INTERRUPT) 107 #define FFA_VERSION FFA_FID(SMC_32, FFA_FNUM_VERSION) 108 #define FFA_FEATURES FFA_FID(SMC_32, FFA_FNUM_FEATURES) 109 #define FFA_RX_RELEASE FFA_FID(SMC_32, FFA_FNUM_RX_RELEASE) 110 #define FFA_RXTX_MAP_SMC32 FFA_FID(SMC_32, FFA_FNUM_RXTX_MAP) 111 #define FFA_RXTX_UNMAP FFA_FID(SMC_32, FFA_FNUM_RXTX_UNMAP) 112 #define FFA_PARTITION_INFO_GET FFA_FID(SMC_32, FFA_FNUM_PARTITION_INFO_GET) 113 #define FFA_ID_GET FFA_FID(SMC_32, FFA_FNUM_ID_GET) 114 #define FFA_MSG_POLL FFA_FID(SMC_32, FFA_FNUM_MSG_POLL) 115 #define FFA_MSG_WAIT FFA_FID(SMC_32, FFA_FNUM_MSG_WAIT) 116 #define FFA_MSG_YIELD FFA_FID(SMC_32, FFA_FNUM_MSG_YIELD) 117 #define FFA_MSG_RUN FFA_FID(SMC_32, FFA_FNUM_MSG_RUN) 118 #define FFA_MSG_SEND FFA_FID(SMC_32, FFA_FNUM_MSG_SEND) 119 #define FFA_MSG_SEND_DIRECT_REQ_SMC32 \ 120 FFA_FID(SMC_32, FFA_FNUM_MSG_SEND_DIRECT_REQ) 121 #define FFA_MSG_SEND_DIRECT_RESP_SMC32 \ 122 FFA_FID(SMC_32, FFA_FNUM_MSG_SEND_DIRECT_RESP) 123 #define FFA_MEM_DONATE_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_DONATE) 124 #define FFA_MEM_LEND_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_LEND) 125 #define FFA_MEM_SHARE_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_SHARE) 126 #define FFA_MEM_RETRIEVE_REQ_SMC32 \ 127 FFA_FID(SMC_32, FFA_FNUM_MEM_RETRIEVE_REQ) 128 #define FFA_MEM_RETRIEVE_RESP FFA_FID(SMC_32, FFA_FNUM_MEM_RETRIEVE_RESP) 129 #define FFA_MEM_RELINQUISH FFA_FID(SMC_32, FFA_FNUM_MEM_RELINQUISH) 130 #define FFA_MEM_RECLAIM FFA_FID(SMC_32, FFA_FNUM_MEM_RECLAIM) 131 #define FFA_NOTIFICATION_BITMAP_CREATE \ 132 FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_BITMAP_CREATE) 133 #define FFA_NOTIFICATION_BITMAP_DESTROY \ 134 FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_BITMAP_DESTROY) 135 #define FFA_NOTIFICATION_BIND FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_BIND) 136 #define FFA_NOTIFICATION_UNBIND FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_UNBIND) 137 #define FFA_NOTIFICATION_SET FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_SET) 138 #define FFA_NOTIFICATION_GET FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_GET) 139 #define FFA_NOTIFICATION_INFO_GET \ 140 FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_INFO_GET) 141 #define FFA_SPM_ID_GET FFA_FID(SMC_32, FFA_FNUM_SPM_ID_GET) 142 143 /* FFA SMC64 FIDs */ 144 #define FFA_ERROR_SMC64 FFA_FID(SMC_64, FFA_FNUM_ERROR) 145 #define FFA_SUCCESS_SMC64 FFA_FID(SMC_64, FFA_FNUM_SUCCESS) 146 #define FFA_RXTX_MAP_SMC64 FFA_FID(SMC_64, FFA_FNUM_RXTX_MAP) 147 #define FFA_MSG_SEND_DIRECT_REQ_SMC64 \ 148 FFA_FID(SMC_64, FFA_FNUM_MSG_SEND_DIRECT_REQ) 149 #define FFA_MSG_SEND_DIRECT_RESP_SMC64 \ 150 FFA_FID(SMC_64, FFA_FNUM_MSG_SEND_DIRECT_RESP) 151 #define FFA_MEM_DONATE_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_DONATE) 152 #define FFA_MEM_LEND_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_LEND) 153 #define FFA_MEM_SHARE_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_SHARE) 154 #define FFA_MEM_RETRIEVE_REQ_SMC64 \ 155 FFA_FID(SMC_64, FFA_FNUM_MEM_RETRIEVE_REQ) 156 #define FFA_SECONDARY_EP_REGISTER_SMC64 \ 157 FFA_FID(SMC_64, FFA_FNUM_SECONDARY_EP_REGISTER) 158 #define FFA_NOTIFICATION_INFO_GET_SMC64 \ 159 FFA_FID(SMC_64, FFA_FNUM_NOTIFICATION_INFO_GET) 160 161 /* 162 * Reserve a special value for traffic targeted to the Hypervisor or SPM. 163 */ 164 #define FFA_TARGET_INFO_MBZ U(0x0) 165 166 /* 167 * Reserve a special value for MBZ parameters. 168 */ 169 #define FFA_PARAM_MBZ U(0x0) 170 171 /* 172 * Maximum FF-A endpoint id value 173 */ 174 #define FFA_ENDPOINT_ID_MAX U(1 << 16) 175 176 /* 177 * Mask for source and destination endpoint id in 178 * a direct message request/response. 179 */ 180 #define FFA_DIRECT_MSG_ENDPOINT_ID_MASK U(0xffff) 181 182 /* 183 * Bit shift for destination endpoint id in a direct message request/response. 184 */ 185 #define FFA_DIRECT_MSG_DESTINATION_SHIFT U(0) 186 187 /* 188 * Bit shift for source endpoint id in a direct message request/response. 189 */ 190 #define FFA_DIRECT_MSG_SOURCE_SHIFT U(16) 191 192 /****************************************************************************** 193 * ffa_endpoint_destination 194 *****************************************************************************/ 195 static inline uint16_t ffa_endpoint_destination(unsigned int ep) 196 { 197 return (ep >> FFA_DIRECT_MSG_DESTINATION_SHIFT) & 198 FFA_DIRECT_MSG_ENDPOINT_ID_MASK; 199 } 200 201 /****************************************************************************** 202 * ffa_endpoint_source 203 *****************************************************************************/ 204 static inline uint16_t ffa_endpoint_source(unsigned int ep) 205 { 206 return (ep >> FFA_DIRECT_MSG_SOURCE_SHIFT) & 207 FFA_DIRECT_MSG_ENDPOINT_ID_MASK; 208 } 209 210 #endif /* FFA_SVC_H */ 211