1 // SPDX-License-Identifier: GPL-2.0-only
3 * Arm Firmware Framework for ARMv8-A(FFA) interface driver
5 * The Arm FFA specification[1] describes a software architecture to
6 * leverages the virtualization extension to isolate software images
7 * provided by an ecosystem of vendors from each other and describes
8 * interfaces that standardize communication between the various software
9 * images including communication between images in the Secure world and
10 * Normal world. Any Hypervisor could use the FFA interfaces to enable
11 * communication between VMs it manages.
13 * The Hypervisor a.k.a Partition managers in FFA terminology can assign
14 * system resources(Memory regions, Devices, CPU cycles) to the partitions
15 * and manage isolation amongst them.
17 * [1] https://developer.arm.com/docs/den0077/latest
19 * Copyright (C) 2021 ARM Ltd.
22 #define DRIVER_NAME "ARM FF-A"
23 #define pr_fmt(fmt) DRIVER_NAME ": " fmt
25 #include <linux/acpi.h>
26 #include <linux/arm_ffa.h>
27 #include <linux/bitfield.h>
28 #include <linux/cpuhotplug.h>
29 #include <linux/device.h>
30 #include <linux/hashtable.h>
31 #include <linux/interrupt.h>
33 #include <linux/kernel.h>
34 #include <linux/module.h>
36 #include <linux/mutex.h>
37 #include <linux/of_irq.h>
38 #include <linux/scatterlist.h>
39 #include <linux/slab.h>
40 #include <linux/smp.h>
41 #include <linux/uuid.h>
42 #include <linux/xarray.h>
46 #define FFA_DRIVER_VERSION FFA_VERSION_1_1
47 #define FFA_MIN_VERSION FFA_VERSION_1_0
49 #define SENDER_ID_MASK GENMASK(31, 16)
50 #define RECEIVER_ID_MASK GENMASK(15, 0)
51 #define SENDER_ID(x) ((u16)(FIELD_GET(SENDER_ID_MASK, (x))))
52 #define RECEIVER_ID(x) ((u16)(FIELD_GET(RECEIVER_ID_MASK, (x))))
53 #define PACK_TARGET_INFO(s, r) \
54 (FIELD_PREP(SENDER_ID_MASK, (s)) | FIELD_PREP(RECEIVER_ID_MASK, (r)))
57 * Keeping RX TX buffer size as 4K for now
58 * 64K may be preferred to keep it min a page in 64K PAGE_SIZE config
60 #define RXTX_BUFFER_SIZE SZ_4K
62 #define FFA_MAX_NOTIFICATIONS 64
64 static ffa_fn *invoke_ffa_fn;
66 static const int ffa_linux_errmap[] = {
67 /* better than switch case as long as return value is continuous */
68 0, /* FFA_RET_SUCCESS */
69 -EOPNOTSUPP, /* FFA_RET_NOT_SUPPORTED */
70 -EINVAL, /* FFA_RET_INVALID_PARAMETERS */
71 -ENOMEM, /* FFA_RET_NO_MEMORY */
72 -EBUSY, /* FFA_RET_BUSY */
73 -EINTR, /* FFA_RET_INTERRUPTED */
74 -EACCES, /* FFA_RET_DENIED */
75 -EAGAIN, /* FFA_RET_RETRY */
76 -ECANCELED, /* FFA_RET_ABORTED */
77 -ENODATA, /* FFA_RET_NO_DATA */
80 static inline int ffa_to_linux_errno(int errno)
84 if (err_idx >= 0 && err_idx < ARRAY_SIZE(ffa_linux_errmap))
85 return ffa_linux_errmap[err_idx];
90 struct ffa_drv_info *info;
96 struct mutex rx_lock; /* lock to protect Rx buffer */
97 struct mutex tx_lock; /* lock to protect Tx buffer */
102 unsigned int sched_recv_irq;
103 unsigned int cpuhp_state;
104 struct ffa_pcpu_irq __percpu *irq_pcpu;
105 struct workqueue_struct *notif_pcpu_wq;
106 struct work_struct notif_pcpu_work;
107 struct work_struct irq_work;
108 struct xarray partition_info;
109 unsigned int partition_count;
110 DECLARE_HASHTABLE(notifier_hash, ilog2(FFA_MAX_NOTIFICATIONS));
111 struct mutex notify_lock; /* lock to protect notifier hashtable */
114 static struct ffa_drv_info *drv_info;
117 * The driver must be able to support all the versions from the earliest
118 * supported FFA_MIN_VERSION to the latest supported FFA_DRIVER_VERSION.
119 * The specification states that if firmware supports a FFA implementation
120 * that is incompatible with and at a greater version number than specified
121 * by the caller(FFA_DRIVER_VERSION passed as parameter to FFA_VERSION),
122 * it must return the NOT_SUPPORTED error code.
124 static u32 ffa_compatible_version_find(u32 version)
126 u16 major = FFA_MAJOR_VERSION(version), minor = FFA_MINOR_VERSION(version);
127 u16 drv_major = FFA_MAJOR_VERSION(FFA_DRIVER_VERSION);
128 u16 drv_minor = FFA_MINOR_VERSION(FFA_DRIVER_VERSION);
130 if ((major < drv_major) || (major == drv_major && minor <= drv_minor))
133 pr_info("Firmware version higher than driver version, downgrading\n");
134 return FFA_DRIVER_VERSION;
137 static int ffa_version_check(u32 *version)
141 invoke_ffa_fn((ffa_value_t){
142 .a0 = FFA_VERSION, .a1 = FFA_DRIVER_VERSION,
145 if (ver.a0 == FFA_RET_NOT_SUPPORTED) {
146 pr_info("FFA_VERSION returned not supported\n");
150 if (ver.a0 < FFA_MIN_VERSION) {
151 pr_err("Incompatible v%d.%d! Earliest supported v%d.%d\n",
152 FFA_MAJOR_VERSION(ver.a0), FFA_MINOR_VERSION(ver.a0),
153 FFA_MAJOR_VERSION(FFA_MIN_VERSION),
154 FFA_MINOR_VERSION(FFA_MIN_VERSION));
158 pr_info("Driver version %d.%d\n", FFA_MAJOR_VERSION(FFA_DRIVER_VERSION),
159 FFA_MINOR_VERSION(FFA_DRIVER_VERSION));
160 pr_info("Firmware version %d.%d found\n", FFA_MAJOR_VERSION(ver.a0),
161 FFA_MINOR_VERSION(ver.a0));
162 *version = ffa_compatible_version_find(ver.a0);
167 static int ffa_rx_release(void)
171 invoke_ffa_fn((ffa_value_t){
172 .a0 = FFA_RX_RELEASE,
175 if (ret.a0 == FFA_ERROR)
176 return ffa_to_linux_errno((int)ret.a2);
178 /* check for ret.a0 == FFA_RX_RELEASE ? */
183 static int ffa_rxtx_map(phys_addr_t tx_buf, phys_addr_t rx_buf, u32 pg_cnt)
187 invoke_ffa_fn((ffa_value_t){
188 .a0 = FFA_FN_NATIVE(RXTX_MAP),
189 .a1 = tx_buf, .a2 = rx_buf, .a3 = pg_cnt,
192 if (ret.a0 == FFA_ERROR)
193 return ffa_to_linux_errno((int)ret.a2);
198 static int ffa_rxtx_unmap(u16 vm_id)
202 invoke_ffa_fn((ffa_value_t){
203 .a0 = FFA_RXTX_UNMAP, .a1 = PACK_TARGET_INFO(vm_id, 0),
206 if (ret.a0 == FFA_ERROR)
207 return ffa_to_linux_errno((int)ret.a2);
212 #define PARTITION_INFO_GET_RETURN_COUNT_ONLY BIT(0)
214 /* buffer must be sizeof(struct ffa_partition_info) * num_partitions */
216 __ffa_partition_info_get(u32 uuid0, u32 uuid1, u32 uuid2, u32 uuid3,
217 struct ffa_partition_info *buffer, int num_partitions)
219 int idx, count, flags = 0, sz, buf_sz;
220 ffa_value_t partition_info;
222 if (drv_info->version > FFA_VERSION_1_0 &&
223 (!buffer || !num_partitions)) /* Just get the count for now */
224 flags = PARTITION_INFO_GET_RETURN_COUNT_ONLY;
226 mutex_lock(&drv_info->rx_lock);
227 invoke_ffa_fn((ffa_value_t){
228 .a0 = FFA_PARTITION_INFO_GET,
229 .a1 = uuid0, .a2 = uuid1, .a3 = uuid2, .a4 = uuid3,
233 if (partition_info.a0 == FFA_ERROR) {
234 mutex_unlock(&drv_info->rx_lock);
235 return ffa_to_linux_errno((int)partition_info.a2);
238 count = partition_info.a2;
240 if (drv_info->version > FFA_VERSION_1_0) {
241 buf_sz = sz = partition_info.a3;
242 if (sz > sizeof(*buffer))
243 buf_sz = sizeof(*buffer);
245 /* FFA_VERSION_1_0 lacks size in the response */
249 if (buffer && count <= num_partitions)
250 for (idx = 0; idx < count; idx++)
251 memcpy(buffer + idx, drv_info->rx_buffer + idx * sz,
256 mutex_unlock(&drv_info->rx_lock);
261 /* buffer is allocated and caller must free the same if returned count > 0 */
263 ffa_partition_probe(const uuid_t *uuid, struct ffa_partition_info **buffer)
267 struct ffa_partition_info *pbuf;
269 export_uuid((u8 *)uuid0_4, uuid);
270 count = __ffa_partition_info_get(uuid0_4[0], uuid0_4[1], uuid0_4[2],
271 uuid0_4[3], NULL, 0);
275 pbuf = kcalloc(count, sizeof(*pbuf), GFP_KERNEL);
279 count = __ffa_partition_info_get(uuid0_4[0], uuid0_4[1], uuid0_4[2],
280 uuid0_4[3], pbuf, count);
289 #define VM_ID_MASK GENMASK(15, 0)
290 static int ffa_id_get(u16 *vm_id)
294 invoke_ffa_fn((ffa_value_t){
298 if (id.a0 == FFA_ERROR)
299 return ffa_to_linux_errno((int)id.a2);
301 *vm_id = FIELD_GET(VM_ID_MASK, (id.a2));
306 static int ffa_msg_send_direct_req(u16 src_id, u16 dst_id, bool mode_32bit,
307 struct ffa_send_direct_data *data)
309 u32 req_id, resp_id, src_dst_ids = PACK_TARGET_INFO(src_id, dst_id);
313 req_id = FFA_MSG_SEND_DIRECT_REQ;
314 resp_id = FFA_MSG_SEND_DIRECT_RESP;
316 req_id = FFA_FN_NATIVE(MSG_SEND_DIRECT_REQ);
317 resp_id = FFA_FN_NATIVE(MSG_SEND_DIRECT_RESP);
320 invoke_ffa_fn((ffa_value_t){
321 .a0 = req_id, .a1 = src_dst_ids, .a2 = 0,
322 .a3 = data->data0, .a4 = data->data1, .a5 = data->data2,
323 .a6 = data->data3, .a7 = data->data4,
326 while (ret.a0 == FFA_INTERRUPT)
327 invoke_ffa_fn((ffa_value_t){
328 .a0 = FFA_RUN, .a1 = ret.a1,
331 if (ret.a0 == FFA_ERROR)
332 return ffa_to_linux_errno((int)ret.a2);
334 if (ret.a0 == resp_id) {
335 data->data0 = ret.a3;
336 data->data1 = ret.a4;
337 data->data2 = ret.a5;
338 data->data3 = ret.a6;
339 data->data4 = ret.a7;
346 static int ffa_mem_first_frag(u32 func_id, phys_addr_t buf, u32 buf_sz,
347 u32 frag_len, u32 len, u64 *handle)
351 invoke_ffa_fn((ffa_value_t){
352 .a0 = func_id, .a1 = len, .a2 = frag_len,
353 .a3 = buf, .a4 = buf_sz,
356 while (ret.a0 == FFA_MEM_OP_PAUSE)
357 invoke_ffa_fn((ffa_value_t){
358 .a0 = FFA_MEM_OP_RESUME,
359 .a1 = ret.a1, .a2 = ret.a2,
362 if (ret.a0 == FFA_ERROR)
363 return ffa_to_linux_errno((int)ret.a2);
365 if (ret.a0 == FFA_SUCCESS) {
367 *handle = PACK_HANDLE(ret.a2, ret.a3);
368 } else if (ret.a0 == FFA_MEM_FRAG_RX) {
370 *handle = PACK_HANDLE(ret.a1, ret.a2);
378 static int ffa_mem_next_frag(u64 handle, u32 frag_len)
382 invoke_ffa_fn((ffa_value_t){
383 .a0 = FFA_MEM_FRAG_TX,
384 .a1 = HANDLE_LOW(handle), .a2 = HANDLE_HIGH(handle),
388 while (ret.a0 == FFA_MEM_OP_PAUSE)
389 invoke_ffa_fn((ffa_value_t){
390 .a0 = FFA_MEM_OP_RESUME,
391 .a1 = ret.a1, .a2 = ret.a2,
394 if (ret.a0 == FFA_ERROR)
395 return ffa_to_linux_errno((int)ret.a2);
397 if (ret.a0 == FFA_MEM_FRAG_RX)
399 else if (ret.a0 == FFA_SUCCESS)
406 ffa_transmit_fragment(u32 func_id, phys_addr_t buf, u32 buf_sz, u32 frag_len,
407 u32 len, u64 *handle, bool first)
410 return ffa_mem_next_frag(*handle, frag_len);
412 return ffa_mem_first_frag(func_id, buf, buf_sz, frag_len, len, handle);
415 static u32 ffa_get_num_pages_sg(struct scatterlist *sg)
420 num_pages += sg->length / FFA_PAGE_SIZE;
421 } while ((sg = sg_next(sg)));
426 static u16 ffa_memory_attributes_get(u32 func_id)
429 * For the memory lend or donate operation, if the receiver is a PE or
430 * a proxy endpoint, the owner/sender must not specify the attributes
432 if (func_id == FFA_FN_NATIVE(MEM_LEND) ||
433 func_id == FFA_MEM_LEND)
436 return FFA_MEM_NORMAL | FFA_MEM_WRITE_BACK | FFA_MEM_INNER_SHAREABLE;
440 ffa_setup_and_transmit(u32 func_id, void *buffer, u32 max_fragsize,
441 struct ffa_mem_ops_args *args)
445 u32 composite_offset;
446 phys_addr_t addr = 0;
447 struct ffa_mem_region *mem_region = buffer;
448 struct ffa_composite_mem_region *composite;
449 struct ffa_mem_region_addr_range *constituents;
450 struct ffa_mem_region_attributes *ep_mem_access;
451 u32 idx, frag_len, length, buf_sz = 0, num_entries = sg_nents(args->sg);
453 mem_region->tag = args->tag;
454 mem_region->flags = args->flags;
455 mem_region->sender_id = drv_info->vm_id;
456 mem_region->attributes = ffa_memory_attributes_get(func_id);
457 ep_mem_access = buffer +
458 ffa_mem_desc_offset(buffer, 0, drv_info->version);
459 composite_offset = ffa_mem_desc_offset(buffer, args->nattrs,
462 for (idx = 0; idx < args->nattrs; idx++, ep_mem_access++) {
463 ep_mem_access->receiver = args->attrs[idx].receiver;
464 ep_mem_access->attrs = args->attrs[idx].attrs;
465 ep_mem_access->composite_off = composite_offset;
466 ep_mem_access->flag = 0;
467 ep_mem_access->reserved = 0;
469 mem_region->handle = 0;
470 mem_region->ep_count = args->nattrs;
471 if (drv_info->version <= FFA_VERSION_1_0) {
472 mem_region->ep_mem_size = 0;
474 mem_region->ep_mem_size = sizeof(*ep_mem_access);
475 mem_region->ep_mem_offset = sizeof(*mem_region);
476 memset(mem_region->reserved, 0, 12);
479 composite = buffer + composite_offset;
480 composite->total_pg_cnt = ffa_get_num_pages_sg(args->sg);
481 composite->addr_range_cnt = num_entries;
482 composite->reserved = 0;
484 length = composite_offset + CONSTITUENTS_OFFSET(num_entries);
485 frag_len = composite_offset + CONSTITUENTS_OFFSET(0);
486 if (frag_len > max_fragsize)
489 if (!args->use_txbuf) {
490 addr = virt_to_phys(buffer);
491 buf_sz = max_fragsize / FFA_PAGE_SIZE;
494 constituents = buffer + frag_len;
497 if (frag_len == max_fragsize) {
498 rc = ffa_transmit_fragment(func_id, addr, buf_sz,
500 &args->g_handle, first);
507 constituents = buffer;
510 if ((void *)constituents - buffer > max_fragsize) {
511 pr_err("Memory Region Fragment > Tx Buffer size\n");
515 constituents->address = sg_phys(args->sg);
516 constituents->pg_cnt = args->sg->length / FFA_PAGE_SIZE;
517 constituents->reserved = 0;
519 frag_len += sizeof(struct ffa_mem_region_addr_range);
520 } while ((args->sg = sg_next(args->sg)));
522 return ffa_transmit_fragment(func_id, addr, buf_sz, frag_len,
523 length, &args->g_handle, first);
526 static int ffa_memory_ops(u32 func_id, struct ffa_mem_ops_args *args)
531 if (!args->use_txbuf) {
532 buffer = alloc_pages_exact(RXTX_BUFFER_SIZE, GFP_KERNEL);
536 buffer = drv_info->tx_buffer;
537 mutex_lock(&drv_info->tx_lock);
540 ret = ffa_setup_and_transmit(func_id, buffer, RXTX_BUFFER_SIZE, args);
543 mutex_unlock(&drv_info->tx_lock);
545 free_pages_exact(buffer, RXTX_BUFFER_SIZE);
547 return ret < 0 ? ret : 0;
550 static int ffa_memory_reclaim(u64 g_handle, u32 flags)
554 invoke_ffa_fn((ffa_value_t){
555 .a0 = FFA_MEM_RECLAIM,
556 .a1 = HANDLE_LOW(g_handle), .a2 = HANDLE_HIGH(g_handle),
560 if (ret.a0 == FFA_ERROR)
561 return ffa_to_linux_errno((int)ret.a2);
566 static int ffa_features(u32 func_feat_id, u32 input_props,
567 u32 *if_props_1, u32 *if_props_2)
571 if (!ARM_SMCCC_IS_FAST_CALL(func_feat_id) && input_props) {
572 pr_err("%s: Invalid Parameters: %x, %x", __func__,
573 func_feat_id, input_props);
574 return ffa_to_linux_errno(FFA_RET_INVALID_PARAMETERS);
577 invoke_ffa_fn((ffa_value_t){
578 .a0 = FFA_FEATURES, .a1 = func_feat_id, .a2 = input_props,
581 if (id.a0 == FFA_ERROR)
582 return ffa_to_linux_errno((int)id.a2);
592 static int ffa_notification_bitmap_create(void)
595 u16 vcpu_count = nr_cpu_ids;
597 invoke_ffa_fn((ffa_value_t){
598 .a0 = FFA_NOTIFICATION_BITMAP_CREATE,
599 .a1 = drv_info->vm_id, .a2 = vcpu_count,
602 if (ret.a0 == FFA_ERROR)
603 return ffa_to_linux_errno((int)ret.a2);
608 static int ffa_notification_bitmap_destroy(void)
612 invoke_ffa_fn((ffa_value_t){
613 .a0 = FFA_NOTIFICATION_BITMAP_DESTROY,
614 .a1 = drv_info->vm_id,
617 if (ret.a0 == FFA_ERROR)
618 return ffa_to_linux_errno((int)ret.a2);
623 #define NOTIFICATION_LOW_MASK GENMASK(31, 0)
624 #define NOTIFICATION_HIGH_MASK GENMASK(63, 32)
625 #define NOTIFICATION_BITMAP_HIGH(x) \
626 ((u32)(FIELD_GET(NOTIFICATION_HIGH_MASK, (x))))
627 #define NOTIFICATION_BITMAP_LOW(x) \
628 ((u32)(FIELD_GET(NOTIFICATION_LOW_MASK, (x))))
629 #define PACK_NOTIFICATION_BITMAP(low, high) \
630 (FIELD_PREP(NOTIFICATION_LOW_MASK, (low)) | \
631 FIELD_PREP(NOTIFICATION_HIGH_MASK, (high)))
633 #define RECEIVER_VCPU_MASK GENMASK(31, 16)
634 #define PACK_NOTIFICATION_GET_RECEIVER_INFO(vcpu_r, r) \
635 (FIELD_PREP(RECEIVER_VCPU_MASK, (vcpu_r)) | \
636 FIELD_PREP(RECEIVER_ID_MASK, (r)))
638 #define NOTIFICATION_INFO_GET_MORE_PEND_MASK BIT(0)
639 #define NOTIFICATION_INFO_GET_ID_COUNT GENMASK(11, 7)
640 #define ID_LIST_MASK_64 GENMASK(51, 12)
641 #define ID_LIST_MASK_32 GENMASK(31, 12)
642 #define MAX_IDS_64 20
643 #define MAX_IDS_32 10
645 #define PER_VCPU_NOTIFICATION_FLAG BIT(0)
646 #define SECURE_PARTITION_BITMAP BIT(0)
647 #define NON_SECURE_VM_BITMAP BIT(1)
648 #define SPM_FRAMEWORK_BITMAP BIT(2)
649 #define NS_HYP_FRAMEWORK_BITMAP BIT(3)
651 static int ffa_notification_bind_common(u16 dst_id, u64 bitmap,
652 u32 flags, bool is_bind)
655 u32 func, src_dst_ids = PACK_TARGET_INFO(dst_id, drv_info->vm_id);
657 func = is_bind ? FFA_NOTIFICATION_BIND : FFA_NOTIFICATION_UNBIND;
659 invoke_ffa_fn((ffa_value_t){
660 .a0 = func, .a1 = src_dst_ids, .a2 = flags,
661 .a3 = NOTIFICATION_BITMAP_LOW(bitmap),
662 .a4 = NOTIFICATION_BITMAP_HIGH(bitmap),
665 if (ret.a0 == FFA_ERROR)
666 return ffa_to_linux_errno((int)ret.a2);
667 else if (ret.a0 != FFA_SUCCESS)
674 int ffa_notification_set(u16 src_id, u16 dst_id, u32 flags, u64 bitmap)
677 u32 src_dst_ids = PACK_TARGET_INFO(dst_id, src_id);
679 invoke_ffa_fn((ffa_value_t) {
680 .a0 = FFA_NOTIFICATION_SET, .a1 = src_dst_ids, .a2 = flags,
681 .a3 = NOTIFICATION_BITMAP_LOW(bitmap),
682 .a4 = NOTIFICATION_BITMAP_HIGH(bitmap),
685 if (ret.a0 == FFA_ERROR)
686 return ffa_to_linux_errno((int)ret.a2);
687 else if (ret.a0 != FFA_SUCCESS)
693 struct ffa_notify_bitmaps {
699 static int ffa_notification_get(u32 flags, struct ffa_notify_bitmaps *notify)
702 u16 src_id = drv_info->vm_id;
703 u16 cpu_id = smp_processor_id();
704 u32 rec_vcpu_ids = PACK_NOTIFICATION_GET_RECEIVER_INFO(cpu_id, src_id);
706 invoke_ffa_fn((ffa_value_t){
707 .a0 = FFA_NOTIFICATION_GET, .a1 = rec_vcpu_ids, .a2 = flags,
710 if (ret.a0 == FFA_ERROR)
711 return ffa_to_linux_errno((int)ret.a2);
712 else if (ret.a0 != FFA_SUCCESS)
713 return -EINVAL; /* Something else went wrong. */
715 notify->sp_map = PACK_NOTIFICATION_BITMAP(ret.a2, ret.a3);
716 notify->vm_map = PACK_NOTIFICATION_BITMAP(ret.a4, ret.a5);
717 notify->arch_map = PACK_NOTIFICATION_BITMAP(ret.a6, ret.a7);
722 struct ffa_dev_part_info {
723 ffa_sched_recv_cb callback;
728 static void __do_sched_recv_cb(u16 part_id, u16 vcpu, bool is_per_vcpu)
730 struct ffa_dev_part_info *partition;
731 ffa_sched_recv_cb callback;
734 partition = xa_load(&drv_info->partition_info, part_id);
735 read_lock(&partition->rw_lock);
736 callback = partition->callback;
737 cb_data = partition->cb_data;
738 read_unlock(&partition->rw_lock);
741 callback(vcpu, is_per_vcpu, cb_data);
744 static void ffa_notification_info_get(void)
746 int idx, list, max_ids, lists_cnt, ids_processed, ids_count[MAX_IDS_64];
752 invoke_ffa_fn((ffa_value_t){
753 .a0 = FFA_FN_NATIVE(NOTIFICATION_INFO_GET),
756 if (ret.a0 != FFA_FN_NATIVE(SUCCESS) && ret.a0 != FFA_SUCCESS) {
757 if (ret.a2 != FFA_RET_NO_DATA)
758 pr_err("Notification Info fetch failed: 0x%lx (0x%lx)",
763 is_64b_resp = (ret.a0 == FFA_FN64_SUCCESS);
766 lists_cnt = FIELD_GET(NOTIFICATION_INFO_GET_ID_COUNT, ret.a2);
768 max_ids = MAX_IDS_64;
769 id_list = FIELD_GET(ID_LIST_MASK_64, ret.a2);
771 max_ids = MAX_IDS_32;
772 id_list = FIELD_GET(ID_LIST_MASK_32, ret.a2);
775 for (idx = 0; idx < lists_cnt; idx++, id_list >>= 2)
776 ids_count[idx] = (id_list & 0x3) + 1;
779 for (list = 0; list < lists_cnt; list++) {
780 u16 vcpu_id, part_id, *packed_id_list = (u16 *)&ret.a3;
782 if (ids_processed >= max_ids - 1)
785 part_id = packed_id_list[++ids_processed];
787 if (!ids_count[list]) { /* Global Notification */
788 __do_sched_recv_cb(part_id, 0, false);
792 /* Per vCPU Notification */
793 for (idx = 0; idx < ids_count[list]; idx++) {
794 if (ids_processed >= max_ids - 1)
797 vcpu_id = packed_id_list[++ids_processed];
799 __do_sched_recv_cb(part_id, vcpu_id, true);
802 } while (ret.a2 & NOTIFICATION_INFO_GET_MORE_PEND_MASK);
805 static int ffa_run(struct ffa_device *dev, u16 vcpu)
808 u32 target = dev->vm_id << 16 | vcpu;
810 invoke_ffa_fn((ffa_value_t){ .a0 = FFA_RUN, .a1 = target, }, &ret);
812 while (ret.a0 == FFA_INTERRUPT)
813 invoke_ffa_fn((ffa_value_t){ .a0 = FFA_RUN, .a1 = ret.a1, },
816 if (ret.a0 == FFA_ERROR)
817 return ffa_to_linux_errno((int)ret.a2);
822 static void ffa_set_up_mem_ops_native_flag(void)
824 if (!ffa_features(FFA_FN_NATIVE(MEM_LEND), 0, NULL, NULL) ||
825 !ffa_features(FFA_FN_NATIVE(MEM_SHARE), 0, NULL, NULL))
826 drv_info->mem_ops_native = true;
829 static u32 ffa_api_version_get(void)
831 return drv_info->version;
834 static int ffa_partition_info_get(const char *uuid_str,
835 struct ffa_partition_info *buffer)
839 struct ffa_partition_info *pbuf;
841 if (uuid_parse(uuid_str, &uuid)) {
842 pr_err("invalid uuid (%s)\n", uuid_str);
846 count = ffa_partition_probe(&uuid, &pbuf);
850 memcpy(buffer, pbuf, sizeof(*pbuf) * count);
855 static void ffa_mode_32bit_set(struct ffa_device *dev)
857 dev->mode_32bit = true;
860 static int ffa_sync_send_receive(struct ffa_device *dev,
861 struct ffa_send_direct_data *data)
863 return ffa_msg_send_direct_req(drv_info->vm_id, dev->vm_id,
864 dev->mode_32bit, data);
867 static int ffa_memory_share(struct ffa_mem_ops_args *args)
869 if (drv_info->mem_ops_native)
870 return ffa_memory_ops(FFA_FN_NATIVE(MEM_SHARE), args);
872 return ffa_memory_ops(FFA_MEM_SHARE, args);
875 static int ffa_memory_lend(struct ffa_mem_ops_args *args)
877 /* Note that upon a successful MEM_LEND request the caller
878 * must ensure that the memory region specified is not accessed
879 * until a successful MEM_RECALIM call has been made.
880 * On systems with a hypervisor present this will been enforced,
881 * however on systems without a hypervisor the responsibility
882 * falls to the calling kernel driver to prevent access.
884 if (drv_info->mem_ops_native)
885 return ffa_memory_ops(FFA_FN_NATIVE(MEM_LEND), args);
887 return ffa_memory_ops(FFA_MEM_LEND, args);
890 #define FFA_SECURE_PARTITION_ID_FLAG BIT(15)
898 struct notifier_cb_info {
899 struct hlist_node hnode;
902 enum notify_type type;
905 static int ffa_sched_recv_cb_update(u16 part_id, ffa_sched_recv_cb callback,
906 void *cb_data, bool is_registration)
908 struct ffa_dev_part_info *partition;
911 partition = xa_load(&drv_info->partition_info, part_id);
912 write_lock(&partition->rw_lock);
914 cb_valid = !!partition->callback;
915 if (!(is_registration ^ cb_valid)) {
916 write_unlock(&partition->rw_lock);
920 partition->callback = callback;
921 partition->cb_data = cb_data;
923 write_unlock(&partition->rw_lock);
927 static int ffa_sched_recv_cb_register(struct ffa_device *dev,
928 ffa_sched_recv_cb cb, void *cb_data)
930 return ffa_sched_recv_cb_update(dev->vm_id, cb, cb_data, true);
933 static int ffa_sched_recv_cb_unregister(struct ffa_device *dev)
935 return ffa_sched_recv_cb_update(dev->vm_id, NULL, NULL, false);
938 static int ffa_notification_bind(u16 dst_id, u64 bitmap, u32 flags)
940 return ffa_notification_bind_common(dst_id, bitmap, flags, true);
943 static int ffa_notification_unbind(u16 dst_id, u64 bitmap)
945 return ffa_notification_bind_common(dst_id, bitmap, 0, false);
948 /* Should be called while the notify_lock is taken */
949 static struct notifier_cb_info *
950 notifier_hash_node_get(u16 notify_id, enum notify_type type)
952 struct notifier_cb_info *node;
954 hash_for_each_possible(drv_info->notifier_hash, node, hnode, notify_id)
955 if (type == node->type)
962 update_notifier_cb(int notify_id, enum notify_type type, ffa_notifier_cb cb,
963 void *cb_data, bool is_registration)
965 struct notifier_cb_info *cb_info = NULL;
968 cb_info = notifier_hash_node_get(notify_id, type);
969 cb_found = !!cb_info;
971 if (!(is_registration ^ cb_found))
974 if (is_registration) {
975 cb_info = kzalloc(sizeof(*cb_info), GFP_KERNEL);
979 cb_info->type = type;
981 cb_info->cb_data = cb_data;
983 hash_add(drv_info->notifier_hash, &cb_info->hnode, notify_id);
985 hash_del(&cb_info->hnode);
991 static enum notify_type ffa_notify_type_get(u16 vm_id)
993 if (vm_id & FFA_SECURE_PARTITION_ID_FLAG)
994 return SECURE_PARTITION;
996 return NON_SECURE_VM;
999 static int ffa_notify_relinquish(struct ffa_device *dev, int notify_id)
1002 enum notify_type type = ffa_notify_type_get(dev->vm_id);
1004 if (notify_id >= FFA_MAX_NOTIFICATIONS)
1007 mutex_lock(&drv_info->notify_lock);
1009 rc = update_notifier_cb(notify_id, type, NULL, NULL, false);
1011 pr_err("Could not unregister notification callback\n");
1012 mutex_unlock(&drv_info->notify_lock);
1016 rc = ffa_notification_unbind(dev->vm_id, BIT(notify_id));
1018 mutex_unlock(&drv_info->notify_lock);
1023 static int ffa_notify_request(struct ffa_device *dev, bool is_per_vcpu,
1024 ffa_notifier_cb cb, void *cb_data, int notify_id)
1028 enum notify_type type = ffa_notify_type_get(dev->vm_id);
1030 if (notify_id >= FFA_MAX_NOTIFICATIONS)
1033 mutex_lock(&drv_info->notify_lock);
1036 flags = PER_VCPU_NOTIFICATION_FLAG;
1038 rc = ffa_notification_bind(dev->vm_id, BIT(notify_id), flags);
1040 mutex_unlock(&drv_info->notify_lock);
1044 rc = update_notifier_cb(notify_id, type, cb, cb_data, true);
1046 pr_err("Failed to register callback for %d - %d\n",
1048 ffa_notification_unbind(dev->vm_id, BIT(notify_id));
1050 mutex_unlock(&drv_info->notify_lock);
1055 static int ffa_notify_send(struct ffa_device *dev, int notify_id,
1056 bool is_per_vcpu, u16 vcpu)
1061 flags |= (PER_VCPU_NOTIFICATION_FLAG | vcpu << 16);
1063 return ffa_notification_set(dev->vm_id, drv_info->vm_id, flags,
1067 static void handle_notif_callbacks(u64 bitmap, enum notify_type type)
1070 struct notifier_cb_info *cb_info = NULL;
1072 for (notify_id = 0; notify_id <= FFA_MAX_NOTIFICATIONS && bitmap;
1073 notify_id++, bitmap >>= 1) {
1077 mutex_lock(&drv_info->notify_lock);
1078 cb_info = notifier_hash_node_get(notify_id, type);
1079 mutex_unlock(&drv_info->notify_lock);
1081 if (cb_info && cb_info->cb)
1082 cb_info->cb(notify_id, cb_info->cb_data);
1086 static void notif_pcpu_irq_work_fn(struct work_struct *work)
1089 struct ffa_notify_bitmaps bitmaps;
1091 rc = ffa_notification_get(SECURE_PARTITION_BITMAP |
1092 SPM_FRAMEWORK_BITMAP, &bitmaps);
1094 pr_err("Failed to retrieve notifications with %d!\n", rc);
1098 handle_notif_callbacks(bitmaps.vm_map, NON_SECURE_VM);
1099 handle_notif_callbacks(bitmaps.sp_map, SECURE_PARTITION);
1100 handle_notif_callbacks(bitmaps.arch_map, FRAMEWORK);
1104 ffa_self_notif_handle(u16 vcpu, bool is_per_vcpu, void *cb_data)
1106 struct ffa_drv_info *info = cb_data;
1109 notif_pcpu_irq_work_fn(&info->notif_pcpu_work);
1111 queue_work_on(vcpu, info->notif_pcpu_wq,
1112 &info->notif_pcpu_work);
1115 static const struct ffa_info_ops ffa_drv_info_ops = {
1116 .api_version_get = ffa_api_version_get,
1117 .partition_info_get = ffa_partition_info_get,
1120 static const struct ffa_msg_ops ffa_drv_msg_ops = {
1121 .mode_32bit_set = ffa_mode_32bit_set,
1122 .sync_send_receive = ffa_sync_send_receive,
1125 static const struct ffa_mem_ops ffa_drv_mem_ops = {
1126 .memory_reclaim = ffa_memory_reclaim,
1127 .memory_share = ffa_memory_share,
1128 .memory_lend = ffa_memory_lend,
1131 static const struct ffa_cpu_ops ffa_drv_cpu_ops = {
1135 static const struct ffa_notifier_ops ffa_drv_notifier_ops = {
1136 .sched_recv_cb_register = ffa_sched_recv_cb_register,
1137 .sched_recv_cb_unregister = ffa_sched_recv_cb_unregister,
1138 .notify_request = ffa_notify_request,
1139 .notify_relinquish = ffa_notify_relinquish,
1140 .notify_send = ffa_notify_send,
1143 static const struct ffa_ops ffa_drv_ops = {
1144 .info_ops = &ffa_drv_info_ops,
1145 .msg_ops = &ffa_drv_msg_ops,
1146 .mem_ops = &ffa_drv_mem_ops,
1147 .cpu_ops = &ffa_drv_cpu_ops,
1148 .notifier_ops = &ffa_drv_notifier_ops,
1151 void ffa_device_match_uuid(struct ffa_device *ffa_dev, const uuid_t *uuid)
1154 struct ffa_partition_info *pbuf, *tpbuf;
1157 * FF-A v1.1 provides UUID for each partition as part of the discovery
1158 * API, the discovered UUID must be populated in the device's UUID and
1159 * there is no need to copy the same from the driver table.
1161 if (drv_info->version > FFA_VERSION_1_0)
1164 count = ffa_partition_probe(uuid, &pbuf);
1168 for (idx = 0, tpbuf = pbuf; idx < count; idx++, tpbuf++)
1169 if (tpbuf->id == ffa_dev->vm_id)
1170 uuid_copy(&ffa_dev->uuid, uuid);
1174 static void ffa_setup_partitions(void)
1178 struct ffa_device *ffa_dev;
1179 struct ffa_dev_part_info *info;
1180 struct ffa_partition_info *pbuf, *tpbuf;
1182 count = ffa_partition_probe(&uuid_null, &pbuf);
1184 pr_info("%s: No partitions found, error %d\n", __func__, count);
1188 xa_init(&drv_info->partition_info);
1189 for (idx = 0, tpbuf = pbuf; idx < count; idx++, tpbuf++) {
1190 import_uuid(&uuid, (u8 *)tpbuf->uuid);
1192 /* Note that if the UUID will be uuid_null, that will require
1193 * ffa_device_match() to find the UUID of this partition id
1194 * with help of ffa_device_match_uuid(). FF-A v1.1 and above
1195 * provides UUID here for each partition as part of the
1196 * discovery API and the same is passed.
1198 ffa_dev = ffa_device_register(&uuid, tpbuf->id, &ffa_drv_ops);
1200 pr_err("%s: failed to register partition ID 0x%x\n",
1201 __func__, tpbuf->id);
1205 if (drv_info->version > FFA_VERSION_1_0 &&
1206 !(tpbuf->properties & FFA_PARTITION_AARCH64_EXEC))
1207 ffa_mode_32bit_set(ffa_dev);
1209 info = kzalloc(sizeof(*info), GFP_KERNEL);
1211 ffa_device_unregister(ffa_dev);
1214 xa_store(&drv_info->partition_info, tpbuf->id, info, GFP_KERNEL);
1216 drv_info->partition_count = count;
1220 /* Allocate for the host */
1221 info = kzalloc(sizeof(*info), GFP_KERNEL);
1224 xa_store(&drv_info->partition_info, drv_info->vm_id, info, GFP_KERNEL);
1225 drv_info->partition_count++;
1228 static void ffa_partitions_cleanup(void)
1230 struct ffa_dev_part_info **info;
1231 int idx, count = drv_info->partition_count;
1236 info = kcalloc(count, sizeof(**info), GFP_KERNEL);
1240 xa_extract(&drv_info->partition_info, (void **)info, 0, VM_ID_MASK,
1243 for (idx = 0; idx < count; idx++)
1247 drv_info->partition_count = 0;
1248 xa_destroy(&drv_info->partition_info);
1251 /* FFA FEATURE IDs */
1252 #define FFA_FEAT_NOTIFICATION_PENDING_INT (1)
1253 #define FFA_FEAT_SCHEDULE_RECEIVER_INT (2)
1254 #define FFA_FEAT_MANAGED_EXIT_INT (3)
1256 static irqreturn_t irq_handler(int irq, void *irq_data)
1258 struct ffa_pcpu_irq *pcpu = irq_data;
1259 struct ffa_drv_info *info = pcpu->info;
1261 queue_work(info->notif_pcpu_wq, &info->irq_work);
1266 static void ffa_sched_recv_irq_work_fn(struct work_struct *work)
1268 ffa_notification_info_get();
1271 static int ffa_sched_recv_irq_map(void)
1273 int ret, irq, sr_intid;
1275 /* The returned sr_intid is assumed to be SGI donated to NS world */
1276 ret = ffa_features(FFA_FEAT_SCHEDULE_RECEIVER_INT, 0, &sr_intid, NULL);
1278 if (ret != -EOPNOTSUPP)
1279 pr_err("Failed to retrieve scheduler Rx interrupt\n");
1283 if (acpi_disabled) {
1284 struct of_phandle_args oirq = {};
1285 struct device_node *gic;
1287 /* Only GICv3 supported currently with the device tree */
1288 gic = of_find_compatible_node(NULL, NULL, "arm,gic-v3");
1293 oirq.args_count = 1;
1294 oirq.args[0] = sr_intid;
1295 irq = irq_create_of_mapping(&oirq);
1299 irq = acpi_register_gsi(NULL, sr_intid, ACPI_EDGE_SENSITIVE,
1305 pr_err("Failed to create IRQ mapping!\n");
1312 static void ffa_sched_recv_irq_unmap(void)
1314 if (drv_info->sched_recv_irq)
1315 irq_dispose_mapping(drv_info->sched_recv_irq);
1318 static int ffa_cpuhp_pcpu_irq_enable(unsigned int cpu)
1320 enable_percpu_irq(drv_info->sched_recv_irq, IRQ_TYPE_NONE);
1324 static int ffa_cpuhp_pcpu_irq_disable(unsigned int cpu)
1326 disable_percpu_irq(drv_info->sched_recv_irq);
1330 static void ffa_uninit_pcpu_irq(void)
1332 if (drv_info->cpuhp_state)
1333 cpuhp_remove_state(drv_info->cpuhp_state);
1335 if (drv_info->notif_pcpu_wq)
1336 destroy_workqueue(drv_info->notif_pcpu_wq);
1338 if (drv_info->sched_recv_irq)
1339 free_percpu_irq(drv_info->sched_recv_irq, drv_info->irq_pcpu);
1341 if (drv_info->irq_pcpu)
1342 free_percpu(drv_info->irq_pcpu);
1345 static int ffa_init_pcpu_irq(unsigned int irq)
1347 struct ffa_pcpu_irq __percpu *irq_pcpu;
1350 irq_pcpu = alloc_percpu(struct ffa_pcpu_irq);
1354 for_each_present_cpu(cpu)
1355 per_cpu_ptr(irq_pcpu, cpu)->info = drv_info;
1357 drv_info->irq_pcpu = irq_pcpu;
1359 ret = request_percpu_irq(irq, irq_handler, "ARM-FFA", irq_pcpu);
1361 pr_err("Error registering notification IRQ %d: %d\n", irq, ret);
1365 INIT_WORK(&drv_info->irq_work, ffa_sched_recv_irq_work_fn);
1366 INIT_WORK(&drv_info->notif_pcpu_work, notif_pcpu_irq_work_fn);
1367 drv_info->notif_pcpu_wq = create_workqueue("ffa_pcpu_irq_notification");
1368 if (!drv_info->notif_pcpu_wq)
1371 ret = cpuhp_setup_state(CPUHP_AP_ONLINE_DYN, "ffa/pcpu-irq:starting",
1372 ffa_cpuhp_pcpu_irq_enable,
1373 ffa_cpuhp_pcpu_irq_disable);
1378 drv_info->cpuhp_state = ret;
1382 static void ffa_notifications_cleanup(void)
1384 ffa_uninit_pcpu_irq();
1385 ffa_sched_recv_irq_unmap();
1387 if (drv_info->bitmap_created) {
1388 ffa_notification_bitmap_destroy();
1389 drv_info->bitmap_created = false;
1393 static int ffa_notifications_setup(void)
1397 ret = ffa_features(FFA_NOTIFICATION_BITMAP_CREATE, 0, NULL, NULL);
1399 pr_err("Notifications not supported, continuing with it ..\n");
1403 ret = ffa_notification_bitmap_create();
1405 pr_err("notification_bitmap_create error %d\n", ret);
1408 drv_info->bitmap_created = true;
1410 irq = ffa_sched_recv_irq_map();
1416 drv_info->sched_recv_irq = irq;
1418 ret = ffa_init_pcpu_irq(irq);
1422 hash_init(drv_info->notifier_hash);
1423 mutex_init(&drv_info->notify_lock);
1425 /* Register internal scheduling callback */
1426 ret = ffa_sched_recv_cb_update(drv_info->vm_id, ffa_self_notif_handle,
1431 ffa_notifications_cleanup();
1435 static int __init ffa_init(void)
1439 ret = ffa_transport_init(&invoke_ffa_fn);
1443 ret = arm_ffa_bus_init();
1447 drv_info = kzalloc(sizeof(*drv_info), GFP_KERNEL);
1453 ret = ffa_version_check(&drv_info->version);
1457 if (ffa_id_get(&drv_info->vm_id)) {
1458 pr_err("failed to obtain VM id for self\n");
1463 drv_info->rx_buffer = alloc_pages_exact(RXTX_BUFFER_SIZE, GFP_KERNEL);
1464 if (!drv_info->rx_buffer) {
1469 drv_info->tx_buffer = alloc_pages_exact(RXTX_BUFFER_SIZE, GFP_KERNEL);
1470 if (!drv_info->tx_buffer) {
1475 ret = ffa_rxtx_map(virt_to_phys(drv_info->tx_buffer),
1476 virt_to_phys(drv_info->rx_buffer),
1477 RXTX_BUFFER_SIZE / FFA_PAGE_SIZE);
1479 pr_err("failed to register FFA RxTx buffers\n");
1483 mutex_init(&drv_info->rx_lock);
1484 mutex_init(&drv_info->tx_lock);
1486 ffa_setup_partitions();
1488 ffa_set_up_mem_ops_native_flag();
1490 ret = ffa_notifications_setup();
1492 goto partitions_cleanup;
1496 ffa_partitions_cleanup();
1498 if (drv_info->tx_buffer)
1499 free_pages_exact(drv_info->tx_buffer, RXTX_BUFFER_SIZE);
1500 free_pages_exact(drv_info->rx_buffer, RXTX_BUFFER_SIZE);
1507 subsys_initcall(ffa_init);
1509 static void __exit ffa_exit(void)
1511 ffa_notifications_cleanup();
1512 ffa_partitions_cleanup();
1513 ffa_rxtx_unmap(drv_info->vm_id);
1514 free_pages_exact(drv_info->tx_buffer, RXTX_BUFFER_SIZE);
1515 free_pages_exact(drv_info->rx_buffer, RXTX_BUFFER_SIZE);
1516 xa_destroy(&drv_info->partition_info);
1520 module_exit(ffa_exit);
1522 MODULE_ALIAS("arm-ffa");
1524 MODULE_DESCRIPTION("Arm FF-A interface driver");
1525 MODULE_LICENSE("GPL v2");