xref: /optee_os/core/arch/arm/kernel/thread_spmc.c (revision 997ff82731597ddcf8d6ad0fb3301adca8c0c6a8)
1 // SPDX-License-Identifier: BSD-2-Clause
2 /*
3  * Copyright (c) 2020-2021, Linaro Limited.
4  * Copyright (c) 2019-2021, Arm Limited. All rights reserved.
5  */
6 
7 #include <assert.h>
8 #include <ffa.h>
9 #include <initcall.h>
10 #include <io.h>
11 #include <kernel/interrupt.h>
12 #include <kernel/panic.h>
13 #include <kernel/secure_partition.h>
14 #include <kernel/spinlock.h>
15 #include <kernel/spmc_sp_handler.h>
16 #include <kernel/tee_misc.h>
17 #include <kernel/thread.h>
18 #include <kernel/thread_private.h>
19 #include <kernel/thread_spmc.h>
20 #include <mm/core_mmu.h>
21 #include <mm/mobj.h>
22 #include <optee_ffa.h>
23 #include <optee_msg.h>
24 #include <optee_rpc_cmd.h>
25 #include <string.h>
26 #include <sys/queue.h>
27 #include <tee/entry_std.h>
28 #include <tee/uuid.h>
29 #include <util.h>
30 
31 #if defined(CFG_CORE_SEL1_SPMC)
32 struct mem_share_state {
33 	struct mobj_ffa *mf;
34 	unsigned int page_count;
35 	unsigned int region_count;
36 	unsigned int current_page_idx;
37 };
38 
39 struct mem_frag_state {
40 	struct mem_share_state share;
41 	tee_mm_entry_t *mm;
42 	unsigned int frag_offset;
43 	SLIST_ENTRY(mem_frag_state) link;
44 };
45 #endif
46 
47 /* Initialized in spmc_init() below */
48 static uint16_t my_endpoint_id;
49 
50 /*
51  * If struct ffa_rxtx::size is 0 RX/TX buffers are not mapped or initialized.
52  *
53  * struct ffa_rxtx::spin_lock protects the variables below from concurrent
54  * access this includes the use of content of struct ffa_rxtx::rx and
55  * @frag_state_head.
56  *
57  * struct ffa_rxtx::tx_buf_is_mine is true when we may write to struct
58  * ffa_rxtx::tx and false when it is owned by normal world.
59  *
60  * Note that we can't prevent normal world from updating the content of
61  * these buffers so we must always be careful when reading. while we hold
62  * the lock.
63  */
64 
65 #ifdef CFG_CORE_SEL1_SPMC
66 static struct ffa_rxtx nw_rxtx;
67 
68 static bool is_nw_buf(struct ffa_rxtx *rxtx)
69 {
70 	return rxtx == &nw_rxtx;
71 }
72 
73 static SLIST_HEAD(mem_frag_state_head, mem_frag_state) frag_state_head =
74 	SLIST_HEAD_INITIALIZER(&frag_state_head);
75 #else
76 static uint8_t __rx_buf[SMALL_PAGE_SIZE] __aligned(SMALL_PAGE_SIZE);
77 static uint8_t __tx_buf[SMALL_PAGE_SIZE] __aligned(SMALL_PAGE_SIZE);
78 static struct ffa_rxtx nw_rxtx = { .rx = __rx_buf, .tx = __tx_buf };
79 #endif
80 
81 static uint32_t swap_src_dst(uint32_t src_dst)
82 {
83 	return (src_dst >> 16) | (src_dst << 16);
84 }
85 
86 void spmc_set_args(struct thread_smc_args *args, uint32_t fid, uint32_t src_dst,
87 		   uint32_t w2, uint32_t w3, uint32_t w4, uint32_t w5)
88 {
89 	*args = (struct thread_smc_args){ .a0 = fid,
90 					  .a1 = src_dst,
91 					  .a2 = w2,
92 					  .a3 = w3,
93 					  .a4 = w4,
94 					  .a5 = w5, };
95 }
96 
97 #if defined(CFG_CORE_SEL1_SPMC)
98 void spmc_handle_version(struct thread_smc_args *args)
99 {
100 	/*
101 	 * We currently only support one version, 1.0 so let's keep it
102 	 * simple.
103 	 */
104 	spmc_set_args(args,
105 		      MAKE_FFA_VERSION(FFA_VERSION_MAJOR, FFA_VERSION_MINOR),
106 		      FFA_PARAM_MBZ, FFA_PARAM_MBZ, FFA_PARAM_MBZ,
107 		      FFA_PARAM_MBZ, FFA_PARAM_MBZ);
108 }
109 
110 static void handle_features(struct thread_smc_args *args)
111 {
112 	uint32_t ret_fid = 0;
113 	uint32_t ret_w2 = FFA_PARAM_MBZ;
114 
115 	switch (args->a1) {
116 #ifdef ARM64
117 	case FFA_RXTX_MAP_64:
118 #endif
119 	case FFA_RXTX_MAP_32:
120 		ret_fid = FFA_SUCCESS_32;
121 		ret_w2 = 0; /* 4kB Minimum buffer size and alignment boundary */
122 		break;
123 #ifdef ARM64
124 	case FFA_MEM_SHARE_64:
125 #endif
126 	case FFA_MEM_SHARE_32:
127 		ret_fid = FFA_SUCCESS_32;
128 		/*
129 		 * Partition manager supports transmission of a memory
130 		 * transaction descriptor in a buffer dynamically allocated
131 		 * by the endpoint.
132 		 */
133 		ret_w2 = BIT(0);
134 		break;
135 
136 	case FFA_ERROR:
137 	case FFA_VERSION:
138 	case FFA_SUCCESS_32:
139 #ifdef ARM64
140 	case FFA_SUCCESS_64:
141 #endif
142 	case FFA_MEM_FRAG_TX:
143 	case FFA_MEM_RECLAIM:
144 	case FFA_MSG_SEND_DIRECT_REQ_32:
145 	case FFA_INTERRUPT:
146 	case FFA_PARTITION_INFO_GET:
147 	case FFA_RX_RELEASE:
148 		ret_fid = FFA_SUCCESS_32;
149 		break;
150 	default:
151 		ret_fid = FFA_ERROR;
152 		ret_w2 = FFA_NOT_SUPPORTED;
153 		break;
154 	}
155 
156 	spmc_set_args(args, ret_fid, FFA_PARAM_MBZ, ret_w2, FFA_PARAM_MBZ,
157 		      FFA_PARAM_MBZ, FFA_PARAM_MBZ);
158 }
159 
160 static int map_buf(paddr_t pa, unsigned int sz, void **va_ret)
161 {
162 	tee_mm_entry_t *mm = NULL;
163 
164 	if (!core_pbuf_is(CORE_MEM_NON_SEC, pa, sz))
165 		return FFA_INVALID_PARAMETERS;
166 
167 	mm = tee_mm_alloc(&tee_mm_shm, sz);
168 	if (!mm)
169 		return FFA_NO_MEMORY;
170 
171 	if (core_mmu_map_contiguous_pages(tee_mm_get_smem(mm), pa,
172 					  sz / SMALL_PAGE_SIZE,
173 					  MEM_AREA_NSEC_SHM)) {
174 		tee_mm_free(mm);
175 		return FFA_INVALID_PARAMETERS;
176 	}
177 
178 	*va_ret = (void *)tee_mm_get_smem(mm);
179 	return 0;
180 }
181 
182 static void unmap_buf(void *va, size_t sz)
183 {
184 	tee_mm_entry_t *mm = tee_mm_find(&tee_mm_shm, (vaddr_t)va);
185 
186 	assert(mm);
187 	core_mmu_unmap_pages(tee_mm_get_smem(mm), sz / SMALL_PAGE_SIZE);
188 	tee_mm_free(mm);
189 }
190 
191 void spmc_handle_rxtx_map(struct thread_smc_args *args, struct ffa_rxtx *rxtx)
192 {
193 	int rc = 0;
194 	uint32_t ret_fid = FFA_ERROR;
195 	unsigned int sz = 0;
196 	paddr_t rx_pa = 0;
197 	paddr_t tx_pa = 0;
198 	void *rx = NULL;
199 	void *tx = NULL;
200 
201 	cpu_spin_lock(&rxtx->spinlock);
202 
203 	if (args->a3 & GENMASK_64(63, 6)) {
204 		rc = FFA_INVALID_PARAMETERS;
205 		goto out;
206 	}
207 
208 	sz = args->a3 * SMALL_PAGE_SIZE;
209 	if (!sz) {
210 		rc = FFA_INVALID_PARAMETERS;
211 		goto out;
212 	}
213 	/* TX/RX are swapped compared to the caller */
214 	tx_pa = args->a2;
215 	rx_pa = args->a1;
216 
217 	if (rxtx->size) {
218 		rc = FFA_DENIED;
219 		goto out;
220 	}
221 
222 	/*
223 	 * If the buffer comes from a SP the address is virtual and already
224 	 * mapped.
225 	 */
226 	if (is_nw_buf(rxtx)) {
227 		rc = map_buf(tx_pa, sz, &tx);
228 		if (rc)
229 			goto out;
230 		rc = map_buf(rx_pa, sz, &rx);
231 		if (rc) {
232 			unmap_buf(tx, sz);
233 			goto out;
234 		}
235 		rxtx->tx = tx;
236 		rxtx->rx = rx;
237 	} else {
238 		if ((tx_pa & SMALL_PAGE_MASK) || (rx_pa & SMALL_PAGE_MASK)) {
239 			rc = FFA_INVALID_PARAMETERS;
240 			goto out;
241 		}
242 
243 		if (!virt_to_phys((void *)tx_pa) ||
244 		    !virt_to_phys((void *)rx_pa)) {
245 			rc = FFA_INVALID_PARAMETERS;
246 			goto out;
247 		}
248 
249 		rxtx->tx = (void *)tx_pa;
250 		rxtx->rx = (void *)rx_pa;
251 	}
252 
253 	rxtx->size = sz;
254 	rxtx->tx_is_mine = true;
255 	ret_fid = FFA_SUCCESS_32;
256 	DMSG("Mapped tx %#"PRIxPA" size %#x @ %p", tx_pa, sz, tx);
257 	DMSG("Mapped rx %#"PRIxPA" size %#x @ %p", rx_pa, sz, rx);
258 out:
259 	cpu_spin_unlock(&rxtx->spinlock);
260 	spmc_set_args(args, ret_fid, FFA_PARAM_MBZ, rc, FFA_PARAM_MBZ,
261 		      FFA_PARAM_MBZ, FFA_PARAM_MBZ);
262 }
263 
264 void spmc_handle_rxtx_unmap(struct thread_smc_args *args, struct ffa_rxtx *rxtx)
265 {
266 	uint32_t ret_fid = FFA_ERROR;
267 	int rc = FFA_INVALID_PARAMETERS;
268 
269 	cpu_spin_lock(&rxtx->spinlock);
270 
271 	if (!rxtx->size)
272 		goto out;
273 
274 	/* We don't unmap the SP memory as the SP might still use it */
275 	if (is_nw_buf(rxtx)) {
276 		unmap_buf(rxtx->rx, rxtx->size);
277 		unmap_buf(rxtx->tx, rxtx->size);
278 	}
279 	rxtx->size = 0;
280 	rxtx->rx = NULL;
281 	rxtx->tx = NULL;
282 	ret_fid = FFA_SUCCESS_32;
283 	rc = 0;
284 out:
285 	cpu_spin_unlock(&rxtx->spinlock);
286 	spmc_set_args(args, ret_fid, FFA_PARAM_MBZ, rc, FFA_PARAM_MBZ,
287 		      FFA_PARAM_MBZ, FFA_PARAM_MBZ);
288 }
289 
290 void spmc_handle_rx_release(struct thread_smc_args *args, struct ffa_rxtx *rxtx)
291 {
292 	uint32_t ret_fid = 0;
293 	int rc = 0;
294 
295 	cpu_spin_lock(&rxtx->spinlock);
296 	/* The senders RX is our TX */
297 	if (!rxtx->size || rxtx->tx_is_mine) {
298 		ret_fid = FFA_ERROR;
299 		rc = FFA_DENIED;
300 	} else {
301 		ret_fid = FFA_SUCCESS_32;
302 		rc = 0;
303 		rxtx->tx_is_mine = true;
304 	}
305 	cpu_spin_unlock(&rxtx->spinlock);
306 
307 	spmc_set_args(args, ret_fid, FFA_PARAM_MBZ, rc, FFA_PARAM_MBZ,
308 		      FFA_PARAM_MBZ, FFA_PARAM_MBZ);
309 }
310 
311 static bool is_nil_uuid(uint32_t w0, uint32_t w1, uint32_t w2, uint32_t w3)
312 {
313 	return !w0 && !w1 && !w2 && !w3;
314 }
315 
316 static bool is_my_uuid(uint32_t w0, uint32_t w1, uint32_t w2, uint32_t w3)
317 {
318 	/*
319 	 * This depends on which UUID we have been assigned.
320 	 * TODO add a generic mechanism to obtain our UUID.
321 	 *
322 	 * The test below is for the hard coded UUID
323 	 * 486178e0-e7f8-11e3-bc5e-0002a5d5c51b
324 	 */
325 	return w0 == 0xe0786148 && w1 == 0xe311f8e7 &&
326 	       w2 == 0x02005ebc && w3 == 0x1bc5d5a5;
327 }
328 
329 void spmc_fill_partition_entry(struct ffa_partition_info *fpi,
330 			       uint16_t endpoint_id, uint16_t execution_context)
331 {
332 	fpi->id = endpoint_id;
333 	/* Number of execution contexts implemented by this partition */
334 	fpi->execution_context = execution_context;
335 
336 	fpi->partition_properties = FFA_PARTITION_DIRECT_REQ_RECV_SUPPORT |
337 				    FFA_PARTITION_DIRECT_REQ_SEND_SUPPORT;
338 }
339 
340 static uint32_t handle_partition_info_get_all(size_t *elem_count,
341 					      struct ffa_rxtx *rxtx)
342 {
343 	struct ffa_partition_info *fpi = rxtx->tx;
344 
345 	/* Add OP-TEE SP */
346 	spmc_fill_partition_entry(fpi, my_endpoint_id, CFG_TEE_CORE_NB_CORE);
347 	rxtx->tx_is_mine = false;
348 	*elem_count = 1;
349 	fpi++;
350 
351 	if (IS_ENABLED(CFG_SECURE_PARTITION)) {
352 		size_t count = (rxtx->size / sizeof(*fpi)) - 1;
353 
354 		if (sp_partition_info_get_all(fpi, &count))
355 			return FFA_NO_MEMORY;
356 		*elem_count += count;
357 	}
358 
359 	return FFA_OK;
360 }
361 
362 void spmc_handle_partition_info_get(struct thread_smc_args *args,
363 				    struct ffa_rxtx *rxtx)
364 {
365 	uint32_t ret_fid = FFA_ERROR;
366 	uint32_t rc = 0;
367 	uint32_t endpoint_id = my_endpoint_id;
368 	struct ffa_partition_info *fpi = NULL;
369 
370 	cpu_spin_lock(&rxtx->spinlock);
371 
372 	if (!rxtx->size || !rxtx->tx_is_mine) {
373 		if (rxtx->size)
374 			rc = FFA_BUSY;
375 		else
376 			rc = FFA_DENIED; /* TX buffer not setup yet */
377 		goto out;
378 	}
379 
380 	fpi = rxtx->tx;
381 
382 	if (rxtx->size < sizeof(*fpi)) {
383 		ret_fid = FFA_ERROR;
384 		rc = FFA_NO_MEMORY;
385 		goto out;
386 	}
387 
388 	if (is_nil_uuid(args->a1, args->a2, args->a3, args->a4)) {
389 		size_t elem_count = 0;
390 
391 		ret_fid = handle_partition_info_get_all(&elem_count, rxtx);
392 
393 		if (ret_fid) {
394 			rc = ret_fid;
395 			ret_fid = FFA_ERROR;
396 		} else {
397 			ret_fid = FFA_SUCCESS_32;
398 			rc = elem_count;
399 		}
400 
401 		goto out;
402 	}
403 
404 	if (is_my_uuid(args->a1, args->a2, args->a3, args->a4)) {
405 		spmc_fill_partition_entry(fpi, endpoint_id,
406 					  CFG_TEE_CORE_NB_CORE);
407 	} else if (IS_ENABLED(CFG_SECURE_PARTITION)) {
408 		uint32_t uuid_array[4] = { 0 };
409 		TEE_UUID uuid = { };
410 		TEE_Result res = TEE_SUCCESS;
411 
412 		uuid_array[0] = args->a1;
413 		uuid_array[1] = args->a2;
414 		uuid_array[2] = args->a3;
415 		uuid_array[3] = args->a4;
416 		tee_uuid_from_octets(&uuid, (uint8_t *)uuid_array);
417 
418 		res = sp_find_session_id(&uuid, &endpoint_id);
419 		if (res != TEE_SUCCESS) {
420 			ret_fid = FFA_ERROR;
421 			rc = FFA_INVALID_PARAMETERS;
422 			goto out;
423 		}
424 		spmc_fill_partition_entry(fpi, endpoint_id, 1);
425 	} else {
426 		ret_fid = FFA_ERROR;
427 		rc = FFA_INVALID_PARAMETERS;
428 		goto out;
429 	}
430 
431 	ret_fid = FFA_SUCCESS_32;
432 	rxtx->tx_is_mine = false;
433 	rc = 1;
434 
435 out:
436 	spmc_set_args(args, ret_fid, FFA_PARAM_MBZ, rc, FFA_PARAM_MBZ,
437 		      FFA_PARAM_MBZ, FFA_PARAM_MBZ);
438 	cpu_spin_unlock(&rxtx->spinlock);
439 }
440 #endif /*CFG_CORE_SEL1_SPMC*/
441 
442 static void handle_yielding_call(struct thread_smc_args *args)
443 {
444 	TEE_Result res = 0;
445 
446 	thread_check_canaries();
447 
448 	if (args->a3 == OPTEE_FFA_YIELDING_CALL_RESUME) {
449 		/* Note connection to struct thread_rpc_arg::ret */
450 		thread_resume_from_rpc(args->a7, args->a4, args->a5, args->a6,
451 				       0);
452 		res = TEE_ERROR_BAD_PARAMETERS;
453 	} else {
454 		thread_alloc_and_run(args->a1, args->a3, args->a4, args->a5,
455 				     args->a6, args->a7);
456 		res = TEE_ERROR_BUSY;
457 	}
458 	spmc_set_args(args, FFA_MSG_SEND_DIRECT_RESP_32,
459 		      swap_src_dst(args->a1), 0, res, 0, 0);
460 }
461 
462 static uint32_t handle_unregister_shm(uint32_t a4, uint32_t a5)
463 {
464 	uint64_t cookie = reg_pair_to_64(a5, a4);
465 	uint32_t res = 0;
466 
467 	res = mobj_ffa_unregister_by_cookie(cookie);
468 	switch (res) {
469 	case TEE_SUCCESS:
470 	case TEE_ERROR_ITEM_NOT_FOUND:
471 		return 0;
472 	case TEE_ERROR_BUSY:
473 		EMSG("res %#"PRIx32, res);
474 		return FFA_BUSY;
475 	default:
476 		EMSG("res %#"PRIx32, res);
477 		return FFA_INVALID_PARAMETERS;
478 	}
479 }
480 
481 static void handle_blocking_call(struct thread_smc_args *args)
482 {
483 	switch (args->a3) {
484 	case OPTEE_FFA_GET_API_VERSION:
485 		spmc_set_args(args, FFA_MSG_SEND_DIRECT_RESP_32,
486 			      swap_src_dst(args->a1), 0,
487 			      OPTEE_FFA_VERSION_MAJOR, OPTEE_FFA_VERSION_MINOR,
488 			      0);
489 		break;
490 	case OPTEE_FFA_GET_OS_VERSION:
491 		spmc_set_args(args, FFA_MSG_SEND_DIRECT_RESP_32,
492 			      swap_src_dst(args->a1), 0,
493 			      CFG_OPTEE_REVISION_MAJOR,
494 			      CFG_OPTEE_REVISION_MINOR, TEE_IMPL_GIT_SHA1);
495 		break;
496 	case OPTEE_FFA_EXCHANGE_CAPABILITIES:
497 		spmc_set_args(args, FFA_MSG_SEND_DIRECT_RESP_32,
498 			      swap_src_dst(args->a1), 0, 0,
499 			      THREAD_RPC_MAX_NUM_PARAMS, 0);
500 		break;
501 	case OPTEE_FFA_UNREGISTER_SHM:
502 		spmc_set_args(args, FFA_MSG_SEND_DIRECT_RESP_32,
503 			      swap_src_dst(args->a1), 0,
504 			      handle_unregister_shm(args->a4, args->a5), 0, 0);
505 		break;
506 	default:
507 		EMSG("Unhandled blocking service ID %#"PRIx32,
508 		     (uint32_t)args->a3);
509 		panic();
510 	}
511 }
512 
513 #if defined(CFG_CORE_SEL1_SPMC)
514 static int get_acc_perms(struct ffa_mem_access *mem_acc,
515 			 unsigned int num_mem_accs, uint8_t *acc_perms,
516 			 unsigned int *region_offs)
517 {
518 	unsigned int n = 0;
519 
520 	for (n = 0; n < num_mem_accs; n++) {
521 		struct ffa_mem_access_perm *descr = &mem_acc[n].access_perm;
522 
523 		if (READ_ONCE(descr->endpoint_id) == my_endpoint_id) {
524 			*acc_perms = READ_ONCE(descr->perm);
525 			*region_offs = READ_ONCE(mem_acc[n].region_offs);
526 			return 0;
527 		}
528 	}
529 
530 	return FFA_INVALID_PARAMETERS;
531 }
532 
533 static int mem_share_init(void *buf, size_t blen, unsigned int *page_count,
534 			  unsigned int *region_count, size_t *addr_range_offs)
535 {
536 	const uint8_t exp_mem_reg_attr = FFA_NORMAL_MEM_REG_ATTR;
537 	const uint8_t exp_mem_acc_perm = FFA_MEM_ACC_RW;
538 	struct ffa_mem_region *region_descr = NULL;
539 	struct ffa_mem_transaction *descr = NULL;
540 	unsigned int num_mem_accs = 0;
541 	uint8_t mem_acc_perm = 0;
542 	unsigned int region_descr_offs = 0;
543 	size_t n = 0;
544 
545 	if (!IS_ALIGNED_WITH_TYPE(buf, struct ffa_mem_transaction) ||
546 	    blen < sizeof(struct ffa_mem_transaction))
547 		return FFA_INVALID_PARAMETERS;
548 
549 	descr = buf;
550 
551 	/* Check that the endpoint memory access descriptor array fits */
552 	num_mem_accs = READ_ONCE(descr->mem_access_count);
553 	if (MUL_OVERFLOW(sizeof(struct ffa_mem_access), num_mem_accs, &n) ||
554 	    ADD_OVERFLOW(sizeof(*descr), n, &n) || n > blen)
555 		return FFA_INVALID_PARAMETERS;
556 
557 	if (READ_ONCE(descr->mem_reg_attr) != exp_mem_reg_attr)
558 		return FFA_INVALID_PARAMETERS;
559 
560 	/* Check that the access permissions matches what's expected */
561 	if (get_acc_perms(descr->mem_access_array,
562 			  num_mem_accs, &mem_acc_perm, &region_descr_offs) ||
563 	    mem_acc_perm != exp_mem_acc_perm)
564 		return FFA_INVALID_PARAMETERS;
565 
566 	/* Check that the Composite memory region descriptor fits */
567 	if (ADD_OVERFLOW(region_descr_offs, sizeof(*region_descr), &n) ||
568 	    n > blen)
569 		return FFA_INVALID_PARAMETERS;
570 
571 	if (!IS_ALIGNED_WITH_TYPE((vaddr_t)descr + region_descr_offs,
572 				  struct ffa_mem_region))
573 		return FFA_INVALID_PARAMETERS;
574 
575 	region_descr = (struct ffa_mem_region *)((vaddr_t)descr +
576 						 region_descr_offs);
577 	*page_count = READ_ONCE(region_descr->total_page_count);
578 	*region_count = READ_ONCE(region_descr->address_range_count);
579 	*addr_range_offs = n;
580 	return 0;
581 }
582 
583 static int add_mem_share_helper(struct mem_share_state *s, void *buf,
584 				size_t flen)
585 {
586 	unsigned int region_count = flen / sizeof(struct ffa_address_range);
587 	struct ffa_address_range *arange = NULL;
588 	unsigned int n = 0;
589 
590 	if (region_count > s->region_count)
591 		region_count = s->region_count;
592 
593 	if (!IS_ALIGNED_WITH_TYPE(buf, struct ffa_address_range))
594 		return FFA_INVALID_PARAMETERS;
595 	arange = buf;
596 
597 	for (n = 0; n < region_count; n++) {
598 		unsigned int page_count = READ_ONCE(arange[n].page_count);
599 		uint64_t addr = READ_ONCE(arange[n].address);
600 
601 		if (mobj_ffa_add_pages_at(s->mf, &s->current_page_idx,
602 					  addr, page_count))
603 			return FFA_INVALID_PARAMETERS;
604 	}
605 
606 	s->region_count -= region_count;
607 	if (s->region_count)
608 		return region_count * sizeof(*arange);
609 
610 	if (s->current_page_idx != s->page_count)
611 		return FFA_INVALID_PARAMETERS;
612 
613 	return 0;
614 }
615 
616 static int add_mem_share_frag(struct mem_frag_state *s, void *buf, size_t flen)
617 {
618 	int rc = 0;
619 
620 	rc = add_mem_share_helper(&s->share, buf, flen);
621 	if (rc >= 0) {
622 		if (!ADD_OVERFLOW(s->frag_offset, rc, &s->frag_offset)) {
623 			if (s->share.region_count)
624 				return s->frag_offset;
625 			/* We're done, return the number of consumed bytes */
626 			rc = s->frag_offset;
627 		} else {
628 			rc = FFA_INVALID_PARAMETERS;
629 		}
630 	}
631 
632 	SLIST_REMOVE(&frag_state_head, s, mem_frag_state, link);
633 	if (rc < 0)
634 		mobj_ffa_sel1_spmc_delete(s->share.mf);
635 	else
636 		mobj_ffa_push_to_inactive(s->share.mf);
637 	free(s);
638 
639 	return rc;
640 }
641 
642 static bool is_sp_share(void *buf)
643 {
644 	struct ffa_mem_transaction *input_descr = NULL;
645 	struct ffa_mem_access_perm *perm = NULL;
646 
647 	if (!IS_ENABLED(CFG_SECURE_PARTITION))
648 		return false;
649 
650 	input_descr = buf;
651 	perm = &input_descr->mem_access_array[0].access_perm;
652 
653 	/*
654 	 * perm->endpoint_id is read here only to check if the endpoint is
655 	 * OP-TEE. We do read it later on again, but there are some additional
656 	 * checks there to make sure that the data is correct.
657 	 */
658 	return READ_ONCE(perm->endpoint_id) != my_endpoint_id;
659 }
660 
661 static int add_mem_share(tee_mm_entry_t *mm, void *buf, size_t blen,
662 			 size_t flen, uint64_t *global_handle)
663 {
664 	int rc = 0;
665 	struct mem_share_state share = { };
666 	size_t addr_range_offs = 0;
667 	size_t n = 0;
668 
669 	if (flen > blen)
670 		return FFA_INVALID_PARAMETERS;
671 
672 	rc = mem_share_init(buf, flen, &share.page_count, &share.region_count,
673 			    &addr_range_offs);
674 	if (rc)
675 		return rc;
676 
677 	if (MUL_OVERFLOW(share.region_count,
678 			 sizeof(struct ffa_address_range), &n) ||
679 	    ADD_OVERFLOW(n, addr_range_offs, &n) || n > blen)
680 		return FFA_INVALID_PARAMETERS;
681 
682 	share.mf = mobj_ffa_sel1_spmc_new(share.page_count);
683 	if (!share.mf)
684 		return FFA_NO_MEMORY;
685 
686 	if (flen != blen) {
687 		struct mem_frag_state *s = calloc(sizeof(*s), 1);
688 
689 		if (!s) {
690 			rc = FFA_NO_MEMORY;
691 			goto err;
692 		}
693 		s->share = share;
694 		s->mm = mm;
695 		s->frag_offset = addr_range_offs;
696 
697 		SLIST_INSERT_HEAD(&frag_state_head, s, link);
698 		rc = add_mem_share_frag(s, (char *)buf + addr_range_offs,
699 					flen - addr_range_offs);
700 
701 		if (rc >= 0)
702 			*global_handle = mobj_ffa_get_cookie(share.mf);
703 
704 		return rc;
705 	}
706 
707 	rc = add_mem_share_helper(&share, (char *)buf + addr_range_offs,
708 				  flen - addr_range_offs);
709 	if (rc) {
710 		/*
711 		 * Number of consumed bytes may be returned instead of 0 for
712 		 * done.
713 		 */
714 		rc = FFA_INVALID_PARAMETERS;
715 		goto err;
716 	}
717 
718 	*global_handle = mobj_ffa_push_to_inactive(share.mf);
719 
720 	return 0;
721 err:
722 	mobj_ffa_sel1_spmc_delete(share.mf);
723 	return rc;
724 }
725 
726 static int handle_mem_share_tmem(paddr_t pbuf, size_t blen, size_t flen,
727 				 unsigned int page_count,
728 				 uint64_t *global_handle, struct ffa_rxtx *rxtx)
729 {
730 	int rc = 0;
731 	size_t len = 0;
732 	tee_mm_entry_t *mm = NULL;
733 	vaddr_t offs = pbuf & SMALL_PAGE_MASK;
734 
735 	if (MUL_OVERFLOW(page_count, SMALL_PAGE_SIZE, &len))
736 		return FFA_INVALID_PARAMETERS;
737 	if (!core_pbuf_is(CORE_MEM_NON_SEC, pbuf, len))
738 		return FFA_INVALID_PARAMETERS;
739 
740 	/*
741 	 * Check that the length reported in blen is covered by len even
742 	 * if the offset is taken into account.
743 	 */
744 	if (len < blen || len - offs < blen)
745 		return FFA_INVALID_PARAMETERS;
746 
747 	mm = tee_mm_alloc(&tee_mm_shm, len);
748 	if (!mm)
749 		return FFA_NO_MEMORY;
750 
751 	if (core_mmu_map_contiguous_pages(tee_mm_get_smem(mm), pbuf,
752 					  page_count, MEM_AREA_NSEC_SHM)) {
753 		rc = FFA_INVALID_PARAMETERS;
754 		goto out;
755 	}
756 
757 	cpu_spin_lock(&rxtx->spinlock);
758 	rc = add_mem_share(mm, (void *)(tee_mm_get_smem(mm) + offs), blen, flen,
759 			   global_handle);
760 	cpu_spin_unlock(&rxtx->spinlock);
761 	if (rc > 0)
762 		return rc;
763 
764 	core_mmu_unmap_pages(tee_mm_get_smem(mm), page_count);
765 out:
766 	tee_mm_free(mm);
767 	return rc;
768 }
769 
770 static int handle_mem_share_rxbuf(size_t blen, size_t flen,
771 				  uint64_t *global_handle,
772 				  struct ffa_rxtx *rxtx)
773 {
774 	int rc = FFA_DENIED;
775 
776 	cpu_spin_lock(&rxtx->spinlock);
777 
778 	if (rxtx->rx && flen <= rxtx->size) {
779 		if (is_sp_share(rxtx->rx)) {
780 			rc = spmc_sp_add_share(rxtx, blen,
781 					       global_handle, NULL);
782 		} else {
783 			rc = add_mem_share(NULL, rxtx->rx, blen, flen,
784 					   global_handle);
785 		}
786 	}
787 
788 	cpu_spin_unlock(&rxtx->spinlock);
789 
790 	return rc;
791 }
792 
793 static void handle_mem_share(struct thread_smc_args *args,
794 			     struct ffa_rxtx *rxtx)
795 {
796 	uint32_t ret_w1 = 0;
797 	uint32_t ret_w2 = FFA_INVALID_PARAMETERS;
798 	uint32_t ret_w3 = 0;
799 	uint32_t ret_fid = FFA_ERROR;
800 	uint64_t global_handle = 0;
801 	int rc = 0;
802 
803 	/* Check that the MBZs are indeed 0 */
804 	if (args->a5 || args->a6 || args->a7)
805 		goto out;
806 
807 	if (!args->a3) {
808 		/*
809 		 * The memory transaction descriptor is passed via our rx
810 		 * buffer.
811 		 */
812 		if (args->a4)
813 			goto out;
814 		rc = handle_mem_share_rxbuf(args->a1, args->a2, &global_handle,
815 					    rxtx);
816 	} else {
817 		rc = handle_mem_share_tmem(args->a3, args->a1, args->a2,
818 					   args->a4, &global_handle, rxtx);
819 	}
820 	if (rc < 0) {
821 		ret_w2 = rc;
822 		goto out;
823 	}
824 	if (rc > 0) {
825 		ret_fid = FFA_MEM_FRAG_RX;
826 		ret_w3 = rc;
827 		reg_pair_from_64(global_handle, &ret_w2, &ret_w1);
828 	}
829 	ret_fid = FFA_SUCCESS_32;
830 	reg_pair_from_64(global_handle, &ret_w3, &ret_w2);
831 out:
832 	spmc_set_args(args, ret_fid, ret_w1, ret_w2, ret_w3, 0, 0);
833 }
834 
835 static struct mem_frag_state *get_frag_state(uint64_t global_handle)
836 {
837 	struct mem_frag_state *s = NULL;
838 
839 	SLIST_FOREACH(s, &frag_state_head, link)
840 		if (mobj_ffa_get_cookie(s->share.mf) == global_handle)
841 			return s;
842 
843 	return NULL;
844 }
845 
846 static void handle_mem_frag_tx(struct thread_smc_args *args,
847 			       struct ffa_rxtx *rxtx)
848 {
849 	int rc = 0;
850 	uint64_t global_handle = reg_pair_to_64(READ_ONCE(args->a2),
851 						READ_ONCE(args->a1));
852 	size_t flen = READ_ONCE(args->a3);
853 	struct mem_frag_state *s = NULL;
854 	tee_mm_entry_t *mm = NULL;
855 	unsigned int page_count = 0;
856 	void *buf = NULL;
857 	uint32_t ret_w1 = 0;
858 	uint32_t ret_w2 = 0;
859 	uint32_t ret_w3 = 0;
860 	uint32_t ret_fid = 0;
861 
862 	/*
863 	 * Currently we're only doing this for fragmented FFA_MEM_SHARE_*
864 	 * requests.
865 	 */
866 
867 	cpu_spin_lock(&rxtx->spinlock);
868 
869 	s = get_frag_state(global_handle);
870 	if (!s) {
871 		rc = FFA_INVALID_PARAMETERS;
872 		goto out;
873 	}
874 
875 	mm = s->mm;
876 	if (mm) {
877 		if (flen > tee_mm_get_bytes(mm)) {
878 			rc = FFA_INVALID_PARAMETERS;
879 			goto out;
880 		}
881 		page_count = s->share.page_count;
882 		buf = (void *)tee_mm_get_smem(mm);
883 	} else {
884 		if (flen > rxtx->size) {
885 			rc = FFA_INVALID_PARAMETERS;
886 			goto out;
887 		}
888 		buf = rxtx->rx;
889 	}
890 
891 	rc = add_mem_share_frag(s, buf, flen);
892 out:
893 	cpu_spin_unlock(&rxtx->spinlock);
894 
895 	if (rc <= 0 && mm) {
896 		core_mmu_unmap_pages(tee_mm_get_smem(mm), page_count);
897 		tee_mm_free(mm);
898 	}
899 
900 	if (rc < 0) {
901 		ret_fid = FFA_ERROR;
902 		ret_w2 = rc;
903 	} else if (rc > 0) {
904 		ret_fid = FFA_MEM_FRAG_RX;
905 		ret_w3 = rc;
906 		reg_pair_from_64(global_handle, &ret_w2, &ret_w1);
907 	} else {
908 		ret_fid = FFA_SUCCESS_32;
909 		reg_pair_from_64(global_handle, &ret_w3, &ret_w2);
910 	}
911 
912 	spmc_set_args(args, ret_fid, ret_w1, ret_w2, ret_w3, 0, 0);
913 }
914 
915 static void handle_mem_reclaim(struct thread_smc_args *args)
916 {
917 	uint32_t ret_val = FFA_INVALID_PARAMETERS;
918 	uint32_t ret_fid = FFA_ERROR;
919 	uint64_t cookie = 0;
920 
921 	if (args->a3 || args->a4 || args->a5 || args->a6 || args->a7)
922 		goto out;
923 
924 	cookie = reg_pair_to_64(args->a2, args->a1);
925 	switch (mobj_ffa_sel1_spmc_reclaim(cookie)) {
926 	case TEE_SUCCESS:
927 		ret_fid = FFA_SUCCESS_32;
928 		ret_val = 0;
929 		break;
930 	case TEE_ERROR_ITEM_NOT_FOUND:
931 		DMSG("cookie %#"PRIx64" not found", cookie);
932 		ret_val = FFA_INVALID_PARAMETERS;
933 		break;
934 	default:
935 		DMSG("cookie %#"PRIx64" busy", cookie);
936 		ret_val = FFA_DENIED;
937 		break;
938 	}
939 out:
940 	spmc_set_args(args, ret_fid, ret_val, 0, 0, 0, 0);
941 }
942 #endif
943 
944 /* Only called from assembly */
945 void thread_spmc_msg_recv(struct thread_smc_args *args);
946 void thread_spmc_msg_recv(struct thread_smc_args *args)
947 {
948 	assert((thread_get_exceptions() & THREAD_EXCP_ALL) == THREAD_EXCP_ALL);
949 	switch (args->a0) {
950 #if defined(CFG_CORE_SEL1_SPMC)
951 	case FFA_VERSION:
952 		spmc_handle_version(args);
953 		break;
954 	case FFA_FEATURES:
955 		handle_features(args);
956 		break;
957 #ifdef ARM64
958 	case FFA_RXTX_MAP_64:
959 #endif
960 	case FFA_RXTX_MAP_32:
961 		spmc_handle_rxtx_map(args, &nw_rxtx);
962 		break;
963 	case FFA_RXTX_UNMAP:
964 		spmc_handle_rxtx_unmap(args, &nw_rxtx);
965 		break;
966 	case FFA_RX_RELEASE:
967 		spmc_handle_rx_release(args, &nw_rxtx);
968 		break;
969 	case FFA_PARTITION_INFO_GET:
970 		spmc_handle_partition_info_get(args, &nw_rxtx);
971 		break;
972 #endif /*CFG_CORE_SEL1_SPMC*/
973 	case FFA_INTERRUPT:
974 		itr_core_handler();
975 		spmc_set_args(args, FFA_MSG_WAIT, 0, 0, 0, 0, 0);
976 		break;
977 	case FFA_MSG_SEND_DIRECT_REQ_32:
978 		if (IS_ENABLED(CFG_SECURE_PARTITION) &&
979 		    FFA_DST(args->a1) != my_endpoint_id) {
980 			spmc_sp_start_thread(args);
981 			break;
982 		}
983 
984 		if (args->a3 & BIT32(OPTEE_FFA_YIELDING_CALL_BIT))
985 			handle_yielding_call(args);
986 		else
987 			handle_blocking_call(args);
988 		break;
989 #if defined(CFG_CORE_SEL1_SPMC)
990 #ifdef ARM64
991 	case FFA_MEM_SHARE_64:
992 #endif
993 	case FFA_MEM_SHARE_32:
994 		handle_mem_share(args, &nw_rxtx);
995 		break;
996 	case FFA_MEM_RECLAIM:
997 		if (!IS_ENABLED(CFG_SECURE_PARTITION) ||
998 		    !ffa_mem_reclaim(args, NULL))
999 			handle_mem_reclaim(args);
1000 		break;
1001 	case FFA_MEM_FRAG_TX:
1002 		handle_mem_frag_tx(args, &nw_rxtx);
1003 		break;
1004 #endif /*CFG_CORE_SEL1_SPMC*/
1005 	default:
1006 		EMSG("Unhandled FFA function ID %#"PRIx32, (uint32_t)args->a0);
1007 		spmc_set_args(args, FFA_ERROR, FFA_PARAM_MBZ, FFA_NOT_SUPPORTED,
1008 			      FFA_PARAM_MBZ, FFA_PARAM_MBZ, FFA_PARAM_MBZ);
1009 	}
1010 }
1011 
1012 static TEE_Result yielding_call_with_arg(uint64_t cookie, uint32_t offset)
1013 {
1014 	size_t sz_rpc = OPTEE_MSG_GET_ARG_SIZE(THREAD_RPC_MAX_NUM_PARAMS);
1015 	struct thread_ctx *thr = threads + thread_get_id();
1016 	TEE_Result res = TEE_ERROR_BAD_PARAMETERS;
1017 	struct optee_msg_arg *arg = NULL;
1018 	struct mobj *mobj = NULL;
1019 	uint32_t num_params = 0;
1020 	size_t sz = 0;
1021 
1022 	mobj = mobj_ffa_get_by_cookie(cookie, 0);
1023 	if (!mobj) {
1024 		EMSG("Can't find cookie %#"PRIx64, cookie);
1025 		return TEE_ERROR_BAD_PARAMETERS;
1026 	}
1027 
1028 	res = mobj_inc_map(mobj);
1029 	if (res)
1030 		goto out_put_mobj;
1031 
1032 	res = TEE_ERROR_BAD_PARAMETERS;
1033 	arg = mobj_get_va(mobj, offset, sizeof(*arg));
1034 	if (!arg)
1035 		goto out_dec_map;
1036 
1037 	num_params = READ_ONCE(arg->num_params);
1038 	if (num_params > OPTEE_MSG_MAX_NUM_PARAMS)
1039 		goto out_dec_map;
1040 
1041 	sz = OPTEE_MSG_GET_ARG_SIZE(num_params);
1042 
1043 	thr->rpc_arg = mobj_get_va(mobj, offset + sz, sz_rpc);
1044 	if (!thr->rpc_arg)
1045 		goto out_dec_map;
1046 
1047 	res = tee_entry_std(arg, num_params);
1048 
1049 	thread_rpc_shm_cache_clear(&thr->shm_cache);
1050 	thr->rpc_arg = NULL;
1051 
1052 out_dec_map:
1053 	mobj_dec_map(mobj);
1054 out_put_mobj:
1055 	mobj_put(mobj);
1056 	return res;
1057 }
1058 
1059 /*
1060  * Helper routine for the assembly function thread_std_smc_entry()
1061  *
1062  * Note: this function is weak just to make it possible to exclude it from
1063  * the unpaged area.
1064  */
1065 uint32_t __weak __thread_std_smc_entry(uint32_t a0, uint32_t a1,
1066 				       uint32_t a2, uint32_t a3,
1067 				       uint32_t a4, uint32_t a5 __unused)
1068 {
1069 	/*
1070 	 * Arguments are supplied from handle_yielding_call() as:
1071 	 * a0 <- w1
1072 	 * a1 <- w3
1073 	 * a2 <- w4
1074 	 * a3 <- w5
1075 	 * a4 <- w6
1076 	 * a5 <- w7
1077 	 */
1078 	thread_get_tsd()->rpc_target_info = swap_src_dst(a0);
1079 	if (a1 == OPTEE_FFA_YIELDING_CALL_WITH_ARG)
1080 		return yielding_call_with_arg(reg_pair_to_64(a3, a2), a4);
1081 	return FFA_DENIED;
1082 }
1083 
1084 static bool set_fmem(struct optee_msg_param *param, struct thread_param *tpm)
1085 {
1086 	uint64_t offs = tpm->u.memref.offs;
1087 
1088 	param->attr = tpm->attr - THREAD_PARAM_ATTR_MEMREF_IN +
1089 		      OPTEE_MSG_ATTR_TYPE_FMEM_INPUT;
1090 
1091 	param->u.fmem.offs_low = offs;
1092 	param->u.fmem.offs_high = offs >> 32;
1093 	if (param->u.fmem.offs_high != offs >> 32)
1094 		return false;
1095 
1096 	param->u.fmem.size = tpm->u.memref.size;
1097 	if (tpm->u.memref.mobj) {
1098 		uint64_t cookie = mobj_get_cookie(tpm->u.memref.mobj);
1099 
1100 		/* If a mobj is passed it better be one with a valid cookie. */
1101 		if (cookie == OPTEE_MSG_FMEM_INVALID_GLOBAL_ID)
1102 			return false;
1103 		param->u.fmem.global_id = cookie;
1104 	} else {
1105 		param->u.fmem.global_id = OPTEE_MSG_FMEM_INVALID_GLOBAL_ID;
1106 	}
1107 
1108 	return true;
1109 }
1110 
1111 static uint32_t get_rpc_arg(uint32_t cmd, size_t num_params,
1112 			    struct thread_param *params,
1113 			    struct optee_msg_arg **arg_ret)
1114 {
1115 	size_t sz = OPTEE_MSG_GET_ARG_SIZE(THREAD_RPC_MAX_NUM_PARAMS);
1116 	struct thread_ctx *thr = threads + thread_get_id();
1117 	struct optee_msg_arg *arg = thr->rpc_arg;
1118 
1119 	if (num_params > THREAD_RPC_MAX_NUM_PARAMS)
1120 		return TEE_ERROR_BAD_PARAMETERS;
1121 
1122 	if (!arg) {
1123 		EMSG("rpc_arg not set");
1124 		return TEE_ERROR_GENERIC;
1125 	}
1126 
1127 	memset(arg, 0, sz);
1128 	arg->cmd = cmd;
1129 	arg->num_params = num_params;
1130 	arg->ret = TEE_ERROR_GENERIC; /* in case value isn't updated */
1131 
1132 	for (size_t n = 0; n < num_params; n++) {
1133 		switch (params[n].attr) {
1134 		case THREAD_PARAM_ATTR_NONE:
1135 			arg->params[n].attr = OPTEE_MSG_ATTR_TYPE_NONE;
1136 			break;
1137 		case THREAD_PARAM_ATTR_VALUE_IN:
1138 		case THREAD_PARAM_ATTR_VALUE_OUT:
1139 		case THREAD_PARAM_ATTR_VALUE_INOUT:
1140 			arg->params[n].attr = params[n].attr -
1141 					      THREAD_PARAM_ATTR_VALUE_IN +
1142 					      OPTEE_MSG_ATTR_TYPE_VALUE_INPUT;
1143 			arg->params[n].u.value.a = params[n].u.value.a;
1144 			arg->params[n].u.value.b = params[n].u.value.b;
1145 			arg->params[n].u.value.c = params[n].u.value.c;
1146 			break;
1147 		case THREAD_PARAM_ATTR_MEMREF_IN:
1148 		case THREAD_PARAM_ATTR_MEMREF_OUT:
1149 		case THREAD_PARAM_ATTR_MEMREF_INOUT:
1150 			if (!set_fmem(arg->params + n, params + n))
1151 				return TEE_ERROR_BAD_PARAMETERS;
1152 			break;
1153 		default:
1154 			return TEE_ERROR_BAD_PARAMETERS;
1155 		}
1156 	}
1157 
1158 	if (arg_ret)
1159 		*arg_ret = arg;
1160 
1161 	return TEE_SUCCESS;
1162 }
1163 
1164 static uint32_t get_rpc_arg_res(struct optee_msg_arg *arg, size_t num_params,
1165 				struct thread_param *params)
1166 {
1167 	for (size_t n = 0; n < num_params; n++) {
1168 		switch (params[n].attr) {
1169 		case THREAD_PARAM_ATTR_VALUE_OUT:
1170 		case THREAD_PARAM_ATTR_VALUE_INOUT:
1171 			params[n].u.value.a = arg->params[n].u.value.a;
1172 			params[n].u.value.b = arg->params[n].u.value.b;
1173 			params[n].u.value.c = arg->params[n].u.value.c;
1174 			break;
1175 		case THREAD_PARAM_ATTR_MEMREF_OUT:
1176 		case THREAD_PARAM_ATTR_MEMREF_INOUT:
1177 			params[n].u.memref.size = arg->params[n].u.fmem.size;
1178 			break;
1179 		default:
1180 			break;
1181 		}
1182 	}
1183 
1184 	return arg->ret;
1185 }
1186 
1187 uint32_t thread_rpc_cmd(uint32_t cmd, size_t num_params,
1188 			struct thread_param *params)
1189 {
1190 	struct thread_rpc_arg rpc_arg = { .call = {
1191 			.w1 = thread_get_tsd()->rpc_target_info,
1192 			.w4 = OPTEE_FFA_YIELDING_CALL_RETURN_RPC_CMD,
1193 		},
1194 	};
1195 	struct optee_msg_arg *arg = NULL;
1196 	uint32_t ret = 0;
1197 
1198 	ret = get_rpc_arg(cmd, num_params, params, &arg);
1199 	if (ret)
1200 		return ret;
1201 
1202 	thread_rpc(&rpc_arg);
1203 
1204 	return get_rpc_arg_res(arg, num_params, params);
1205 }
1206 
1207 static void thread_rpc_free(unsigned int bt, uint64_t cookie, struct mobj *mobj)
1208 {
1209 	struct thread_rpc_arg rpc_arg = { .call = {
1210 			.w1 = thread_get_tsd()->rpc_target_info,
1211 			.w4 = OPTEE_FFA_YIELDING_CALL_RETURN_RPC_CMD,
1212 		},
1213 	};
1214 	struct thread_param param = THREAD_PARAM_VALUE(IN, bt, cookie, 0);
1215 	uint32_t res2 = 0;
1216 	uint32_t res = 0;
1217 
1218 	DMSG("freeing cookie %#"PRIx64, cookie);
1219 
1220 	res = get_rpc_arg(OPTEE_RPC_CMD_SHM_FREE, 1, &param, NULL);
1221 
1222 	mobj_put(mobj);
1223 	res2 = mobj_ffa_unregister_by_cookie(cookie);
1224 	if (res2)
1225 		DMSG("mobj_ffa_unregister_by_cookie(%#"PRIx64"): %#"PRIx32,
1226 		     cookie, res2);
1227 	if (!res)
1228 		thread_rpc(&rpc_arg);
1229 }
1230 
1231 static struct mobj *thread_rpc_alloc(size_t size, size_t align, unsigned int bt)
1232 {
1233 	struct thread_rpc_arg rpc_arg = { .call = {
1234 			.w1 = thread_get_tsd()->rpc_target_info,
1235 			.w4 = OPTEE_FFA_YIELDING_CALL_RETURN_RPC_CMD,
1236 		},
1237 	};
1238 	struct thread_param param = THREAD_PARAM_VALUE(IN, bt, size, align);
1239 	struct optee_msg_arg *arg = NULL;
1240 	unsigned int internal_offset = 0;
1241 	struct mobj *mobj = NULL;
1242 	uint64_t cookie = 0;
1243 
1244 	if (get_rpc_arg(OPTEE_RPC_CMD_SHM_ALLOC, 1, &param, &arg))
1245 		return NULL;
1246 
1247 	thread_rpc(&rpc_arg);
1248 
1249 	if (arg->num_params != 1 ||
1250 	    arg->params->attr != OPTEE_MSG_ATTR_TYPE_FMEM_OUTPUT)
1251 		return NULL;
1252 
1253 	internal_offset = READ_ONCE(arg->params->u.fmem.internal_offs);
1254 	cookie = READ_ONCE(arg->params->u.fmem.global_id);
1255 	mobj = mobj_ffa_get_by_cookie(cookie, internal_offset);
1256 	if (!mobj) {
1257 		DMSG("mobj_ffa_get_by_cookie(%#"PRIx64", %#x): failed",
1258 		     cookie, internal_offset);
1259 		return NULL;
1260 	}
1261 
1262 	assert(mobj_is_nonsec(mobj));
1263 
1264 	if (mobj->size < size) {
1265 		DMSG("Mobj %#"PRIx64": wrong size", cookie);
1266 		mobj_put(mobj);
1267 		return NULL;
1268 	}
1269 
1270 	if (mobj_inc_map(mobj)) {
1271 		DMSG("mobj_inc_map(%#"PRIx64"): failed", cookie);
1272 		mobj_put(mobj);
1273 		return NULL;
1274 	}
1275 
1276 	return mobj;
1277 }
1278 
1279 struct mobj *thread_rpc_alloc_payload(size_t size)
1280 {
1281 	return thread_rpc_alloc(size, 8, OPTEE_RPC_SHM_TYPE_APPL);
1282 }
1283 
1284 struct mobj *thread_rpc_alloc_kernel_payload(size_t size)
1285 {
1286 	return thread_rpc_alloc(size, 8, OPTEE_RPC_SHM_TYPE_KERNEL);
1287 }
1288 
1289 void thread_rpc_free_kernel_payload(struct mobj *mobj)
1290 {
1291 	thread_rpc_free(OPTEE_RPC_SHM_TYPE_KERNEL, mobj_get_cookie(mobj), mobj);
1292 }
1293 
1294 void thread_rpc_free_payload(struct mobj *mobj)
1295 {
1296 	thread_rpc_free(OPTEE_RPC_SHM_TYPE_APPL, mobj_get_cookie(mobj),
1297 			mobj);
1298 }
1299 
1300 struct mobj *thread_rpc_alloc_global_payload(size_t size)
1301 {
1302 	return thread_rpc_alloc(size, 8, OPTEE_RPC_SHM_TYPE_GLOBAL);
1303 }
1304 
1305 void thread_rpc_free_global_payload(struct mobj *mobj)
1306 {
1307 	thread_rpc_free(OPTEE_RPC_SHM_TYPE_GLOBAL, mobj_get_cookie(mobj),
1308 			mobj);
1309 }
1310 
1311 void thread_spmc_register_secondary_ep(vaddr_t ep)
1312 {
1313 	unsigned long ret = 0;
1314 
1315 	/* Let the SPM know the entry point for secondary CPUs */
1316 	ret = thread_smc(FFA_SECONDARY_EP_REGISTER_64, ep, 0, 0);
1317 
1318 	if (ret != FFA_SUCCESS_32 && ret != FFA_SUCCESS_64)
1319 		EMSG("FFA_SECONDARY_EP_REGISTER_64 ret %#lx", ret);
1320 }
1321 
1322 #if defined(CFG_CORE_SEL1_SPMC)
1323 static TEE_Result spmc_init(void)
1324 {
1325 	my_endpoint_id = SPMC_ENDPOINT_ID;
1326 	DMSG("My endpoint ID %#x", my_endpoint_id);
1327 
1328 	return TEE_SUCCESS;
1329 }
1330 #else /* !defined(CFG_CORE_SEL1_SPMC) */
1331 static bool is_ffa_success(uint32_t fid)
1332 {
1333 #ifdef ARM64
1334 	if (fid == FFA_SUCCESS_64)
1335 		return true;
1336 #endif
1337 	return fid == FFA_SUCCESS_32;
1338 }
1339 
1340 static void spmc_rxtx_map(struct ffa_rxtx *rxtx)
1341 {
1342 	struct thread_smc_args args = {
1343 #ifdef ARM64
1344 		.a0 = FFA_RXTX_MAP_64,
1345 #else
1346 		.a0 = FFA_RXTX_MAP_32,
1347 #endif
1348 		.a1 = virt_to_phys(rxtx->tx),
1349 		.a2 = virt_to_phys(rxtx->rx),
1350 		.a3 = 1,
1351 	};
1352 
1353 	thread_smccc(&args);
1354 	if (!is_ffa_success(args.a0)) {
1355 		if (args.a0 == FFA_ERROR)
1356 			EMSG("rxtx map failed with error %ld", args.a2);
1357 		else
1358 			EMSG("rxtx map failed");
1359 		panic();
1360 	}
1361 }
1362 
1363 static uint16_t spmc_get_id(void)
1364 {
1365 	struct thread_smc_args args = {
1366 		.a0 = FFA_ID_GET,
1367 	};
1368 
1369 	thread_smccc(&args);
1370 	if (!is_ffa_success(args.a0)) {
1371 		if (args.a0 == FFA_ERROR)
1372 			EMSG("Get id failed with error %ld", args.a2);
1373 		else
1374 			EMSG("Get id failed");
1375 		panic();
1376 	}
1377 
1378 	return args.a2;
1379 }
1380 
1381 static struct ffa_mem_transaction *spmc_retrieve_req(uint64_t cookie)
1382 {
1383 	struct ffa_mem_transaction *trans_descr = nw_rxtx.tx;
1384 	struct ffa_mem_access *acc_descr_array = NULL;
1385 	struct ffa_mem_access_perm *perm_descr = NULL;
1386 	size_t size = sizeof(*trans_descr) +
1387 		      1 * sizeof(struct ffa_mem_access);
1388 	struct thread_smc_args args = {
1389 		.a0 = FFA_MEM_RETRIEVE_REQ_32,
1390 		.a1 =   size,	/* Total Length */
1391 		.a2 =	size,	/* Frag Length == Total length */
1392 		.a3 =	0,	/* Address, Using TX -> MBZ */
1393 		.a4 =   0,	/* Using TX -> MBZ */
1394 	};
1395 
1396 	memset(trans_descr, 0, size);
1397 	trans_descr->sender_id = thread_get_tsd()->rpc_target_info;
1398 	trans_descr->mem_reg_attr = FFA_NORMAL_MEM_REG_ATTR;
1399 	trans_descr->global_handle = cookie;
1400 	trans_descr->flags = FFA_MEMORY_REGION_TRANSACTION_TYPE_SHARE |
1401 			     FFA_MEMORY_REGION_FLAG_ANY_ALIGNMENT;
1402 	trans_descr->mem_access_count = 1;
1403 	acc_descr_array = trans_descr->mem_access_array;
1404 	acc_descr_array->region_offs = 0;
1405 	acc_descr_array->reserved = 0;
1406 	perm_descr = &acc_descr_array->access_perm;
1407 	perm_descr->endpoint_id = my_endpoint_id;
1408 	perm_descr->perm = FFA_MEM_ACC_RW;
1409 	perm_descr->flags = 0;
1410 
1411 	thread_smccc(&args);
1412 	if (args.a0 != FFA_MEM_RETRIEVE_RESP) {
1413 		if (args.a0 == FFA_ERROR)
1414 			EMSG("Failed to fetch cookie %#"PRIx64" error code %d",
1415 			     cookie, (int)args.a2);
1416 		else
1417 			EMSG("Failed to fetch cookie %#"PRIx64" a0 %#"PRIx64,
1418 			     cookie, args.a0);
1419 		return NULL;
1420 	}
1421 
1422 	return nw_rxtx.rx;
1423 }
1424 
1425 void thread_spmc_relinquish(uint64_t cookie)
1426 {
1427 	struct ffa_mem_relinquish *relinquish_desc = nw_rxtx.tx;
1428 	struct thread_smc_args args = {
1429 		.a0 = FFA_MEM_RELINQUISH,
1430 	};
1431 
1432 	memset(relinquish_desc, 0, sizeof(*relinquish_desc));
1433 	relinquish_desc->handle = cookie;
1434 	relinquish_desc->flags = 0;
1435 	relinquish_desc->endpoint_count = 1;
1436 	relinquish_desc->endpoint_id_array[0] = my_endpoint_id;
1437 	thread_smccc(&args);
1438 	if (!is_ffa_success(args.a0))
1439 		EMSG("Failed to relinquish cookie %#"PRIx64, cookie);
1440 }
1441 
1442 static int set_pages(struct ffa_address_range *regions,
1443 		     unsigned int num_regions, unsigned int num_pages,
1444 		     struct mobj_ffa *mf)
1445 {
1446 	unsigned int n = 0;
1447 	unsigned int idx = 0;
1448 
1449 	for (n = 0; n < num_regions; n++) {
1450 		unsigned int page_count = READ_ONCE(regions[n].page_count);
1451 		uint64_t addr = READ_ONCE(regions[n].address);
1452 
1453 		if (mobj_ffa_add_pages_at(mf, &idx, addr, page_count))
1454 			return FFA_INVALID_PARAMETERS;
1455 	}
1456 
1457 	if (idx != num_pages)
1458 		return FFA_INVALID_PARAMETERS;
1459 
1460 	return 0;
1461 }
1462 
1463 struct mobj_ffa *thread_spmc_populate_mobj_from_rx(uint64_t cookie)
1464 {
1465 	struct mobj_ffa *ret = NULL;
1466 	struct ffa_mem_transaction *retrieve_desc = NULL;
1467 	struct ffa_mem_access *descr_array = NULL;
1468 	struct ffa_mem_region *descr = NULL;
1469 	struct mobj_ffa *mf = NULL;
1470 	unsigned int num_pages = 0;
1471 	unsigned int offs = 0;
1472 	struct thread_smc_args ffa_rx_release_args = {
1473 		.a0 = FFA_RX_RELEASE
1474 	};
1475 
1476 	/*
1477 	 * OP-TEE is only supporting a single mem_region while the
1478 	 * specification allows for more than one.
1479 	 */
1480 	retrieve_desc = spmc_retrieve_req(cookie);
1481 	if (!retrieve_desc) {
1482 		EMSG("Failed to retrieve cookie from rx buffer %#"PRIx64,
1483 		     cookie);
1484 		return NULL;
1485 	}
1486 
1487 	descr_array = retrieve_desc->mem_access_array;
1488 	offs = READ_ONCE(descr_array->region_offs);
1489 	descr = (struct ffa_mem_region *)((vaddr_t)retrieve_desc + offs);
1490 
1491 	num_pages = READ_ONCE(descr->total_page_count);
1492 	mf = mobj_ffa_spmc_new(cookie, num_pages);
1493 	if (!mf)
1494 		goto out;
1495 
1496 	if (set_pages(descr->address_range_array,
1497 		      READ_ONCE(descr->address_range_count), num_pages, mf)) {
1498 		mobj_ffa_spmc_delete(mf);
1499 		goto out;
1500 	}
1501 
1502 	ret = mf;
1503 
1504 out:
1505 	/* Release RX buffer after the mem retrieve request. */
1506 	thread_smccc(&ffa_rx_release_args);
1507 
1508 	return ret;
1509 }
1510 
1511 static TEE_Result spmc_init(void)
1512 {
1513 	spmc_rxtx_map(&nw_rxtx);
1514 	my_endpoint_id = spmc_get_id();
1515 	DMSG("My endpoint ID %#x", my_endpoint_id);
1516 
1517 	return TEE_SUCCESS;
1518 }
1519 #endif /* !defined(CFG_CORE_SEL1_SPMC) */
1520 
1521 service_init(spmc_init);
1522