1 /*
2 * Copyright (c) 2020-2023, 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(0x8C)
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(1)
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(31)
61 #define FFA_FWK_MSG_MASK 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_PARTITION_INFO_GET_REGS U(0x8B)
121 #define FFA_FNUM_EL3_INTR_HANDLE U(0x8C)
122
123 /* FFA SMC32 FIDs */
124 #define FFA_ERROR FFA_FID(SMC_32, FFA_FNUM_ERROR)
125 #define FFA_SUCCESS_SMC32 FFA_FID(SMC_32, FFA_FNUM_SUCCESS)
126 #define FFA_INTERRUPT FFA_FID(SMC_32, FFA_FNUM_INTERRUPT)
127 #define FFA_VERSION FFA_FID(SMC_32, FFA_FNUM_VERSION)
128 #define FFA_FEATURES FFA_FID(SMC_32, FFA_FNUM_FEATURES)
129 #define FFA_RX_RELEASE FFA_FID(SMC_32, FFA_FNUM_RX_RELEASE)
130 #define FFA_RX_ACQUIRE FFA_FID(SMC_32, FFA_FNUM_RX_ACQUIRE)
131 #define FFA_RXTX_MAP_SMC32 FFA_FID(SMC_32, FFA_FNUM_RXTX_MAP)
132 #define FFA_RXTX_UNMAP FFA_FID(SMC_32, FFA_FNUM_RXTX_UNMAP)
133 #define FFA_PARTITION_INFO_GET FFA_FID(SMC_32, FFA_FNUM_PARTITION_INFO_GET)
134 #define FFA_ID_GET FFA_FID(SMC_32, FFA_FNUM_ID_GET)
135 #define FFA_MSG_POLL FFA_FID(SMC_32, FFA_FNUM_MSG_POLL)
136 #define FFA_MSG_WAIT FFA_FID(SMC_32, FFA_FNUM_MSG_WAIT)
137 #define FFA_MSG_YIELD FFA_FID(SMC_32, FFA_FNUM_MSG_YIELD)
138 #define FFA_MSG_RUN FFA_FID(SMC_32, FFA_FNUM_MSG_RUN)
139 #define FFA_MSG_SEND FFA_FID(SMC_32, FFA_FNUM_MSG_SEND)
140 #define FFA_MSG_SEND2 FFA_FID(SMC_32, FFA_FNUM_MSG_SEND2)
141 #define FFA_MSG_SEND_DIRECT_REQ_SMC32 \
142 FFA_FID(SMC_32, FFA_FNUM_MSG_SEND_DIRECT_REQ)
143 #define FFA_MSG_SEND_DIRECT_RESP_SMC32 \
144 FFA_FID(SMC_32, FFA_FNUM_MSG_SEND_DIRECT_RESP)
145 #define FFA_MEM_DONATE_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_DONATE)
146 #define FFA_MEM_LEND_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_LEND)
147 #define FFA_MEM_SHARE_SMC32 FFA_FID(SMC_32, FFA_FNUM_MEM_SHARE)
148 #define FFA_MEM_RETRIEVE_REQ_SMC32 \
149 FFA_FID(SMC_32, FFA_FNUM_MEM_RETRIEVE_REQ)
150 #define FFA_MEM_RETRIEVE_RESP FFA_FID(SMC_32, FFA_FNUM_MEM_RETRIEVE_RESP)
151 #define FFA_MEM_RELINQUISH FFA_FID(SMC_32, FFA_FNUM_MEM_RELINQUISH)
152 #define FFA_MEM_RECLAIM FFA_FID(SMC_32, FFA_FNUM_MEM_RECLAIM)
153 #define FFA_NOTIFICATION_BITMAP_CREATE \
154 FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_BITMAP_CREATE)
155 #define FFA_NOTIFICATION_BITMAP_DESTROY \
156 FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_BITMAP_DESTROY)
157 #define FFA_NOTIFICATION_BIND FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_BIND)
158 #define FFA_NOTIFICATION_UNBIND FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_UNBIND)
159 #define FFA_NOTIFICATION_SET FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_SET)
160 #define FFA_NOTIFICATION_GET FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_GET)
161 #define FFA_NOTIFICATION_INFO_GET \
162 FFA_FID(SMC_32, FFA_FNUM_NOTIFICATION_INFO_GET)
163 #define FFA_MEM_FRAG_RX FFA_FID(SMC_32, FFA_FNUM_MEM_FRAG_RX)
164 #define FFA_MEM_FRAG_TX FFA_FID(SMC_32, FFA_FNUM_MEM_FRAG_TX)
165 #define FFA_SPM_ID_GET FFA_FID(SMC_32, FFA_FNUM_SPM_ID_GET)
166 #define FFA_NORMAL_WORLD_RESUME FFA_FID(SMC_32, FFA_FNUM_NORMAL_WORLD_RESUME)
167 #define FFA_EL3_INTR_HANDLE FFA_FID(SMC_32, FFA_FNUM_EL3_INTR_HANDLE)
168
169 /* FFA SMC64 FIDs */
170 #define FFA_ERROR_SMC64 FFA_FID(SMC_64, FFA_FNUM_ERROR)
171 #define FFA_SUCCESS_SMC64 FFA_FID(SMC_64, FFA_FNUM_SUCCESS)
172 #define FFA_RXTX_MAP_SMC64 FFA_FID(SMC_64, FFA_FNUM_RXTX_MAP)
173 #define FFA_MSG_SEND_DIRECT_REQ_SMC64 \
174 FFA_FID(SMC_64, FFA_FNUM_MSG_SEND_DIRECT_REQ)
175 #define FFA_MSG_SEND_DIRECT_RESP_SMC64 \
176 FFA_FID(SMC_64, FFA_FNUM_MSG_SEND_DIRECT_RESP)
177 #define FFA_MEM_DONATE_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_DONATE)
178 #define FFA_MEM_LEND_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_LEND)
179 #define FFA_MEM_SHARE_SMC64 FFA_FID(SMC_64, FFA_FNUM_MEM_SHARE)
180 #define FFA_MEM_RETRIEVE_REQ_SMC64 \
181 FFA_FID(SMC_64, FFA_FNUM_MEM_RETRIEVE_REQ)
182 #define FFA_SECONDARY_EP_REGISTER_SMC64 \
183 FFA_FID(SMC_64, FFA_FNUM_SECONDARY_EP_REGISTER)
184 #define FFA_NOTIFICATION_INFO_GET_SMC64 \
185 FFA_FID(SMC_64, FFA_FNUM_NOTIFICATION_INFO_GET)
186 #define FFA_PARTITION_INFO_GET_REGS_SMC64 \
187 FFA_FID(SMC_64, FFA_FNUM_PARTITION_INFO_GET_REGS)
188
189 /*
190 * FF-A partition properties values.
191 */
192 #define FFA_PARTITION_DIRECT_REQ_RECV U(1 << 0)
193 #define FFA_PARTITION_DIRECT_REQ_SEND U(1 << 1)
194 #define FFA_PARTITION_INDIRECT_MSG U(1 << 2)
195
196 /*
197 * Reserve a special value for traffic targeted to the Hypervisor or SPM.
198 */
199 #define FFA_TARGET_INFO_MBZ U(0x0)
200
201 /*
202 * Reserve a special value for MBZ parameters.
203 */
204 #define FFA_PARAM_MBZ U(0x0)
205
206 /*
207 * Maximum FF-A endpoint id value
208 */
209 #define FFA_ENDPOINT_ID_MAX U(1 << 16)
210
211 /*
212 * Reserve endpoint id for the SPMD.
213 */
214 #define SPMD_DIRECT_MSG_ENDPOINT_ID U(FFA_ENDPOINT_ID_MAX - 1)
215
216 /* Mask and shift to check valid secure FF-A Endpoint ID. */
217 #define SPMC_SECURE_ID_MASK U(1)
218 #define SPMC_SECURE_ID_SHIFT U(15)
219
220 /*
221 * Partition Count Flag in FFA_PARTITION_INFO_GET.
222 */
223 #define FFA_PARTITION_INFO_GET_COUNT_FLAG_MASK U(1 << 0)
224
225 /*
226 * Mask for source and destination endpoint id in
227 * a direct message request/response.
228 */
229 #define FFA_DIRECT_MSG_ENDPOINT_ID_MASK U(0xffff)
230
231 /*
232 * Bit shift for destination endpoint id in a direct message request/response.
233 */
234 #define FFA_DIRECT_MSG_DESTINATION_SHIFT U(0)
235
236 /*
237 * Bit shift for source endpoint id in a direct message request/response.
238 */
239 #define FFA_DIRECT_MSG_SOURCE_SHIFT U(16)
240
241 /******************************************************************************
242 * ffa_endpoint_destination
243 *****************************************************************************/
ffa_endpoint_destination(unsigned int ep)244 static inline uint16_t ffa_endpoint_destination(unsigned int ep)
245 {
246 return (ep >> FFA_DIRECT_MSG_DESTINATION_SHIFT) &
247 FFA_DIRECT_MSG_ENDPOINT_ID_MASK;
248 }
249
250 /******************************************************************************
251 * ffa_endpoint_source
252 *****************************************************************************/
ffa_endpoint_source(unsigned int ep)253 static inline uint16_t ffa_endpoint_source(unsigned int ep)
254 {
255 return (ep >> FFA_DIRECT_MSG_SOURCE_SHIFT) &
256 FFA_DIRECT_MSG_ENDPOINT_ID_MASK;
257 }
258
259 /******************************************************************************
260 * FF-A helper functions to determine partition ID world.
261 *****************************************************************************/
262
263 /*
264 * Determine if provided ID is in the secure world.
265 */
ffa_is_secure_world_id(uint16_t id)266 static inline bool ffa_is_secure_world_id(uint16_t id)
267 {
268 return ((id >> SPMC_SECURE_ID_SHIFT) & SPMC_SECURE_ID_MASK) == 1;
269 }
270
271 /*
272 * Determine if provided ID is in the normal world.
273 */
ffa_is_normal_world_id(uint16_t id)274 static inline bool ffa_is_normal_world_id(uint16_t id)
275 {
276 return !ffa_is_secure_world_id(id);
277 }
278
279
280 /******************************************************************************
281 * Boot information protocol as per the FF-A v1.1 spec.
282 *****************************************************************************/
283 #define FFA_INIT_DESC_SIGNATURE 0x00000FFA
284
285 /* Boot information type. */
286 #define FFA_BOOT_INFO_TYPE_STD U(0x0)
287 #define FFA_BOOT_INFO_TYPE_IMPL U(0x1)
288
289 #define FFA_BOOT_INFO_TYPE_MASK U(0x1)
290 #define FFA_BOOT_INFO_TYPE_SHIFT U(0x7)
291 #define FFA_BOOT_INFO_TYPE(type) \
292 (((type) & FFA_BOOT_INFO_TYPE_MASK) \
293 << FFA_BOOT_INFO_TYPE_SHIFT)
294
295 /* Boot information identifier. */
296 #define FFA_BOOT_INFO_TYPE_ID_FDT U(0x0)
297 #define FFA_BOOT_INFO_TYPE_ID_HOB U(0x1)
298
299 #define FFA_BOOT_INFO_TYPE_ID_MASK U(0x3F)
300 #define FFA_BOOT_INFO_TYPE_ID_SHIFT U(0x0)
301 #define FFA_BOOT_INFO_TYPE_ID(type) \
302 (((type) & FFA_BOOT_INFO_TYPE_ID_MASK) \
303 << FFA_BOOT_INFO_TYPE_ID_SHIFT)
304
305 /* Format of Flags Name field. */
306 #define FFA_BOOT_INFO_FLAG_NAME_STRING U(0x0)
307 #define FFA_BOOT_INFO_FLAG_NAME_UUID U(0x1)
308
309 #define FFA_BOOT_INFO_FLAG_NAME_MASK U(0x3)
310 #define FFA_BOOT_INFO_FLAG_NAME_SHIFT U(0x0)
311 #define FFA_BOOT_INFO_FLAG_NAME(type) \
312 (((type) & FFA_BOOT_INFO_FLAG_NAME_MASK)\
313 << FFA_BOOT_INFO_FLAG_NAME_SHIFT)
314
315 /* Format of Flags Contents field. */
316 #define FFA_BOOT_INFO_FLAG_CONTENT_ADR U(0x0)
317 #define FFA_BOOT_INFO_FLAG_CONTENT_VAL U(0x1)
318
319 #define FFA_BOOT_INFO_FLAG_CONTENT_MASK U(0x1)
320 #define FFA_BOOT_INFO_FLAG_CONTENT_SHIFT U(0x2)
321 #define FFA_BOOT_INFO_FLAG_CONTENT(content) \
322 (((content) & FFA_BOOT_INFO_FLAG_CONTENT_MASK) \
323 << FFA_BOOT_INFO_FLAG_CONTENT_SHIFT)
324
325 /* Boot information descriptor. */
326 struct ffa_boot_info_desc {
327 uint8_t name[16];
328 uint8_t type;
329 uint8_t reserved;
330 uint16_t flags;
331 uint32_t size_boot_info;
332 uint64_t content;
333 };
334
335 /* Boot information header. */
336 struct ffa_boot_info_header {
337 uint32_t signature; /* 0xFFA */
338 uint32_t version;
339 uint32_t size_boot_info_blob;
340 uint32_t size_boot_info_desc;
341 uint32_t count_boot_info_desc;
342 uint32_t offset_boot_info_desc;
343 uint64_t reserved;
344 };
345
346 /* FF-A Partition Info Get related macros. */
347 #define FFA_PARTITION_INFO_GET_PROPERTIES_V1_0_MASK U(0x7)
348 #define FFA_PARTITION_INFO_GET_EXEC_STATE_SHIFT U(8)
349 #define FFA_PARTITION_INFO_GET_AARCH32_STATE U(0)
350 #define FFA_PARTITION_INFO_GET_AARCH64_STATE U(1)
351
352 /**
353 * Holds information returned for each partition by the FFA_PARTITION_INFO_GET
354 * interface.
355 */
356 struct ffa_partition_info_v1_0 {
357 uint16_t ep_id;
358 uint16_t execution_ctx_count;
359 uint32_t properties;
360 };
361
362 /* Extended structure for FF-A v1.1. */
363 struct ffa_partition_info_v1_1 {
364 uint16_t ep_id;
365 uint16_t execution_ctx_count;
366 uint32_t properties;
367 uint32_t uuid[4];
368 };
369
370 #endif /* FFA_SVC_H */
371
