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 */
103 unsigned int sched_recv_irq;
104 unsigned int cpuhp_state;
105 struct ffa_pcpu_irq __percpu *irq_pcpu;
106 struct workqueue_struct *notif_pcpu_wq;
107 struct work_struct notif_pcpu_work;
108 struct work_struct irq_work;
109 struct xarray partition_info;
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;
115 static void ffa_partitions_cleanup(void);
118 * The driver must be able to support all the versions from the earliest
119 * supported FFA_MIN_VERSION to the latest supported FFA_DRIVER_VERSION.
120 * The specification states that if firmware supports a FFA implementation
121 * that is incompatible with and at a greater version number than specified
122 * by the caller(FFA_DRIVER_VERSION passed as parameter to FFA_VERSION),
123 * it must return the NOT_SUPPORTED error code.
125 static u32 ffa_compatible_version_find(u32 version)
127 u16 major = FFA_MAJOR_VERSION(version), minor = FFA_MINOR_VERSION(version);
128 u16 drv_major = FFA_MAJOR_VERSION(FFA_DRIVER_VERSION);
129 u16 drv_minor = FFA_MINOR_VERSION(FFA_DRIVER_VERSION);
131 if ((major < drv_major) || (major == drv_major && minor <= drv_minor))
134 pr_info("Firmware version higher than driver version, downgrading\n");
135 return FFA_DRIVER_VERSION;
138 static int ffa_version_check(u32 *version)
142 invoke_ffa_fn((ffa_value_t){
143 .a0 = FFA_VERSION, .a1 = FFA_DRIVER_VERSION,
146 if (ver.a0 == FFA_RET_NOT_SUPPORTED) {
147 pr_info("FFA_VERSION returned not supported\n");
151 if (ver.a0 < FFA_MIN_VERSION) {
152 pr_err("Incompatible v%d.%d! Earliest supported v%d.%d\n",
153 FFA_MAJOR_VERSION(ver.a0), FFA_MINOR_VERSION(ver.a0),
154 FFA_MAJOR_VERSION(FFA_MIN_VERSION),
155 FFA_MINOR_VERSION(FFA_MIN_VERSION));
159 pr_info("Driver version %d.%d\n", FFA_MAJOR_VERSION(FFA_DRIVER_VERSION),
160 FFA_MINOR_VERSION(FFA_DRIVER_VERSION));
161 pr_info("Firmware version %d.%d found\n", FFA_MAJOR_VERSION(ver.a0),
162 FFA_MINOR_VERSION(ver.a0));
163 *version = ffa_compatible_version_find(ver.a0);
168 static int ffa_rx_release(void)
172 invoke_ffa_fn((ffa_value_t){
173 .a0 = FFA_RX_RELEASE,
176 if (ret.a0 == FFA_ERROR)
177 return ffa_to_linux_errno((int)ret.a2);
179 /* check for ret.a0 == FFA_RX_RELEASE ? */
184 static int ffa_rxtx_map(phys_addr_t tx_buf, phys_addr_t rx_buf, u32 pg_cnt)
188 invoke_ffa_fn((ffa_value_t){
189 .a0 = FFA_FN_NATIVE(RXTX_MAP),
190 .a1 = tx_buf, .a2 = rx_buf, .a3 = pg_cnt,
193 if (ret.a0 == FFA_ERROR)
194 return ffa_to_linux_errno((int)ret.a2);
199 static int ffa_rxtx_unmap(u16 vm_id)
203 invoke_ffa_fn((ffa_value_t){
204 .a0 = FFA_RXTX_UNMAP, .a1 = PACK_TARGET_INFO(vm_id, 0),
207 if (ret.a0 == FFA_ERROR)
208 return ffa_to_linux_errno((int)ret.a2);
213 #define PARTITION_INFO_GET_RETURN_COUNT_ONLY BIT(0)
215 /* buffer must be sizeof(struct ffa_partition_info) * num_partitions */
217 __ffa_partition_info_get(u32 uuid0, u32 uuid1, u32 uuid2, u32 uuid3,
218 struct ffa_partition_info *buffer, int num_partitions)
220 int idx, count, flags = 0, sz, buf_sz;
221 ffa_value_t partition_info;
223 if (drv_info->version > FFA_VERSION_1_0 &&
224 (!buffer || !num_partitions)) /* Just get the count for now */
225 flags = PARTITION_INFO_GET_RETURN_COUNT_ONLY;
227 mutex_lock(&drv_info->rx_lock);
228 invoke_ffa_fn((ffa_value_t){
229 .a0 = FFA_PARTITION_INFO_GET,
230 .a1 = uuid0, .a2 = uuid1, .a3 = uuid2, .a4 = uuid3,
234 if (partition_info.a0 == FFA_ERROR) {
235 mutex_unlock(&drv_info->rx_lock);
236 return ffa_to_linux_errno((int)partition_info.a2);
239 count = partition_info.a2;
241 if (drv_info->version > FFA_VERSION_1_0) {
242 buf_sz = sz = partition_info.a3;
243 if (sz > sizeof(*buffer))
244 buf_sz = sizeof(*buffer);
246 /* FFA_VERSION_1_0 lacks size in the response */
250 if (buffer && count <= num_partitions)
251 for (idx = 0; idx < count; idx++)
252 memcpy(buffer + idx, drv_info->rx_buffer + idx * sz,
257 mutex_unlock(&drv_info->rx_lock);
262 /* buffer is allocated and caller must free the same if returned count > 0 */
264 ffa_partition_probe(const uuid_t *uuid, struct ffa_partition_info **buffer)
268 struct ffa_partition_info *pbuf;
270 export_uuid((u8 *)uuid0_4, uuid);
271 count = __ffa_partition_info_get(uuid0_4[0], uuid0_4[1], uuid0_4[2],
272 uuid0_4[3], NULL, 0);
276 pbuf = kcalloc(count, sizeof(*pbuf), GFP_KERNEL);
280 count = __ffa_partition_info_get(uuid0_4[0], uuid0_4[1], uuid0_4[2],
281 uuid0_4[3], pbuf, count);
290 #define VM_ID_MASK GENMASK(15, 0)
291 static int ffa_id_get(u16 *vm_id)
295 invoke_ffa_fn((ffa_value_t){
299 if (id.a0 == FFA_ERROR)
300 return ffa_to_linux_errno((int)id.a2);
302 *vm_id = FIELD_GET(VM_ID_MASK, (id.a2));
307 static int ffa_msg_send_direct_req(u16 src_id, u16 dst_id, bool mode_32bit,
308 struct ffa_send_direct_data *data)
310 u32 req_id, resp_id, src_dst_ids = PACK_TARGET_INFO(src_id, dst_id);
314 req_id = FFA_MSG_SEND_DIRECT_REQ;
315 resp_id = FFA_MSG_SEND_DIRECT_RESP;
317 req_id = FFA_FN_NATIVE(MSG_SEND_DIRECT_REQ);
318 resp_id = FFA_FN_NATIVE(MSG_SEND_DIRECT_RESP);
321 invoke_ffa_fn((ffa_value_t){
322 .a0 = req_id, .a1 = src_dst_ids, .a2 = 0,
323 .a3 = data->data0, .a4 = data->data1, .a5 = data->data2,
324 .a6 = data->data3, .a7 = data->data4,
327 while (ret.a0 == FFA_INTERRUPT)
328 invoke_ffa_fn((ffa_value_t){
329 .a0 = FFA_RUN, .a1 = ret.a1,
332 if (ret.a0 == FFA_ERROR)
333 return ffa_to_linux_errno((int)ret.a2);
335 if (ret.a0 == resp_id) {
336 data->data0 = ret.a3;
337 data->data1 = ret.a4;
338 data->data2 = ret.a5;
339 data->data3 = ret.a6;
340 data->data4 = ret.a7;
347 static int ffa_mem_first_frag(u32 func_id, phys_addr_t buf, u32 buf_sz,
348 u32 frag_len, u32 len, u64 *handle)
352 invoke_ffa_fn((ffa_value_t){
353 .a0 = func_id, .a1 = len, .a2 = frag_len,
354 .a3 = buf, .a4 = buf_sz,
357 while (ret.a0 == FFA_MEM_OP_PAUSE)
358 invoke_ffa_fn((ffa_value_t){
359 .a0 = FFA_MEM_OP_RESUME,
360 .a1 = ret.a1, .a2 = ret.a2,
363 if (ret.a0 == FFA_ERROR)
364 return ffa_to_linux_errno((int)ret.a2);
366 if (ret.a0 == FFA_SUCCESS) {
368 *handle = PACK_HANDLE(ret.a2, ret.a3);
369 } else if (ret.a0 == FFA_MEM_FRAG_RX) {
371 *handle = PACK_HANDLE(ret.a1, ret.a2);
379 static int ffa_mem_next_frag(u64 handle, u32 frag_len)
383 invoke_ffa_fn((ffa_value_t){
384 .a0 = FFA_MEM_FRAG_TX,
385 .a1 = HANDLE_LOW(handle), .a2 = HANDLE_HIGH(handle),
389 while (ret.a0 == FFA_MEM_OP_PAUSE)
390 invoke_ffa_fn((ffa_value_t){
391 .a0 = FFA_MEM_OP_RESUME,
392 .a1 = ret.a1, .a2 = ret.a2,
395 if (ret.a0 == FFA_ERROR)
396 return ffa_to_linux_errno((int)ret.a2);
398 if (ret.a0 == FFA_MEM_FRAG_RX)
400 else if (ret.a0 == FFA_SUCCESS)
407 ffa_transmit_fragment(u32 func_id, phys_addr_t buf, u32 buf_sz, u32 frag_len,
408 u32 len, u64 *handle, bool first)
411 return ffa_mem_next_frag(*handle, frag_len);
413 return ffa_mem_first_frag(func_id, buf, buf_sz, frag_len, len, handle);
416 static u32 ffa_get_num_pages_sg(struct scatterlist *sg)
421 num_pages += sg->length / FFA_PAGE_SIZE;
422 } while ((sg = sg_next(sg)));
427 static u16 ffa_memory_attributes_get(u32 func_id)
430 * For the memory lend or donate operation, if the receiver is a PE or
431 * a proxy endpoint, the owner/sender must not specify the attributes
433 if (func_id == FFA_FN_NATIVE(MEM_LEND) ||
434 func_id == FFA_MEM_LEND)
437 return FFA_MEM_NORMAL | FFA_MEM_WRITE_BACK | FFA_MEM_INNER_SHAREABLE;
441 ffa_setup_and_transmit(u32 func_id, void *buffer, u32 max_fragsize,
442 struct ffa_mem_ops_args *args)
446 u32 composite_offset;
447 phys_addr_t addr = 0;
448 struct ffa_mem_region *mem_region = buffer;
449 struct ffa_composite_mem_region *composite;
450 struct ffa_mem_region_addr_range *constituents;
451 struct ffa_mem_region_attributes *ep_mem_access;
452 u32 idx, frag_len, length, buf_sz = 0, num_entries = sg_nents(args->sg);
454 mem_region->tag = args->tag;
455 mem_region->flags = args->flags;
456 mem_region->sender_id = drv_info->vm_id;
457 mem_region->attributes = ffa_memory_attributes_get(func_id);
458 ep_mem_access = buffer +
459 ffa_mem_desc_offset(buffer, 0, drv_info->version);
460 composite_offset = ffa_mem_desc_offset(buffer, args->nattrs,
463 for (idx = 0; idx < args->nattrs; idx++, ep_mem_access++) {
464 ep_mem_access->receiver = args->attrs[idx].receiver;
465 ep_mem_access->attrs = args->attrs[idx].attrs;
466 ep_mem_access->composite_off = composite_offset;
467 ep_mem_access->flag = 0;
468 ep_mem_access->reserved = 0;
470 mem_region->handle = 0;
471 mem_region->ep_count = args->nattrs;
472 if (drv_info->version <= FFA_VERSION_1_0) {
473 mem_region->ep_mem_size = 0;
475 mem_region->ep_mem_size = sizeof(*ep_mem_access);
476 mem_region->ep_mem_offset = sizeof(*mem_region);
477 memset(mem_region->reserved, 0, 12);
480 composite = buffer + composite_offset;
481 composite->total_pg_cnt = ffa_get_num_pages_sg(args->sg);
482 composite->addr_range_cnt = num_entries;
483 composite->reserved = 0;
485 length = composite_offset + CONSTITUENTS_OFFSET(num_entries);
486 frag_len = composite_offset + CONSTITUENTS_OFFSET(0);
487 if (frag_len > max_fragsize)
490 if (!args->use_txbuf) {
491 addr = virt_to_phys(buffer);
492 buf_sz = max_fragsize / FFA_PAGE_SIZE;
495 constituents = buffer + frag_len;
498 if (frag_len == max_fragsize) {
499 rc = ffa_transmit_fragment(func_id, addr, buf_sz,
501 &args->g_handle, first);
508 constituents = buffer;
511 if ((void *)constituents - buffer > max_fragsize) {
512 pr_err("Memory Region Fragment > Tx Buffer size\n");
516 constituents->address = sg_phys(args->sg);
517 constituents->pg_cnt = args->sg->length / FFA_PAGE_SIZE;
518 constituents->reserved = 0;
520 frag_len += sizeof(struct ffa_mem_region_addr_range);
521 } while ((args->sg = sg_next(args->sg)));
523 return ffa_transmit_fragment(func_id, addr, buf_sz, frag_len,
524 length, &args->g_handle, first);
527 static int ffa_memory_ops(u32 func_id, struct ffa_mem_ops_args *args)
532 if (!args->use_txbuf) {
533 buffer = alloc_pages_exact(RXTX_BUFFER_SIZE, GFP_KERNEL);
537 buffer = drv_info->tx_buffer;
538 mutex_lock(&drv_info->tx_lock);
541 ret = ffa_setup_and_transmit(func_id, buffer, RXTX_BUFFER_SIZE, args);
544 mutex_unlock(&drv_info->tx_lock);
546 free_pages_exact(buffer, RXTX_BUFFER_SIZE);
548 return ret < 0 ? ret : 0;
551 static int ffa_memory_reclaim(u64 g_handle, u32 flags)
555 invoke_ffa_fn((ffa_value_t){
556 .a0 = FFA_MEM_RECLAIM,
557 .a1 = HANDLE_LOW(g_handle), .a2 = HANDLE_HIGH(g_handle),
561 if (ret.a0 == FFA_ERROR)
562 return ffa_to_linux_errno((int)ret.a2);
567 static int ffa_features(u32 func_feat_id, u32 input_props,
568 u32 *if_props_1, u32 *if_props_2)
572 if (!ARM_SMCCC_IS_FAST_CALL(func_feat_id) && input_props) {
573 pr_err("%s: Invalid Parameters: %x, %x", __func__,
574 func_feat_id, input_props);
575 return ffa_to_linux_errno(FFA_RET_INVALID_PARAMETERS);
578 invoke_ffa_fn((ffa_value_t){
579 .a0 = FFA_FEATURES, .a1 = func_feat_id, .a2 = input_props,
582 if (id.a0 == FFA_ERROR)
583 return ffa_to_linux_errno((int)id.a2);
593 static int ffa_notification_bitmap_create(void)
596 u16 vcpu_count = nr_cpu_ids;
598 invoke_ffa_fn((ffa_value_t){
599 .a0 = FFA_NOTIFICATION_BITMAP_CREATE,
600 .a1 = drv_info->vm_id, .a2 = vcpu_count,
603 if (ret.a0 == FFA_ERROR)
604 return ffa_to_linux_errno((int)ret.a2);
609 static int ffa_notification_bitmap_destroy(void)
613 invoke_ffa_fn((ffa_value_t){
614 .a0 = FFA_NOTIFICATION_BITMAP_DESTROY,
615 .a1 = drv_info->vm_id,
618 if (ret.a0 == FFA_ERROR)
619 return ffa_to_linux_errno((int)ret.a2);
624 #define NOTIFICATION_LOW_MASK GENMASK(31, 0)
625 #define NOTIFICATION_HIGH_MASK GENMASK(63, 32)
626 #define NOTIFICATION_BITMAP_HIGH(x) \
627 ((u32)(FIELD_GET(NOTIFICATION_HIGH_MASK, (x))))
628 #define NOTIFICATION_BITMAP_LOW(x) \
629 ((u32)(FIELD_GET(NOTIFICATION_LOW_MASK, (x))))
630 #define PACK_NOTIFICATION_BITMAP(low, high) \
631 (FIELD_PREP(NOTIFICATION_LOW_MASK, (low)) | \
632 FIELD_PREP(NOTIFICATION_HIGH_MASK, (high)))
634 #define RECEIVER_VCPU_MASK GENMASK(31, 16)
635 #define PACK_NOTIFICATION_GET_RECEIVER_INFO(vcpu_r, r) \
636 (FIELD_PREP(RECEIVER_VCPU_MASK, (vcpu_r)) | \
637 FIELD_PREP(RECEIVER_ID_MASK, (r)))
639 #define NOTIFICATION_INFO_GET_MORE_PEND_MASK BIT(0)
640 #define NOTIFICATION_INFO_GET_ID_COUNT GENMASK(11, 7)
641 #define ID_LIST_MASK_64 GENMASK(51, 12)
642 #define ID_LIST_MASK_32 GENMASK(31, 12)
643 #define MAX_IDS_64 20
644 #define MAX_IDS_32 10
646 #define PER_VCPU_NOTIFICATION_FLAG BIT(0)
647 #define SECURE_PARTITION_BITMAP BIT(0)
648 #define NON_SECURE_VM_BITMAP BIT(1)
649 #define SPM_FRAMEWORK_BITMAP BIT(2)
650 #define NS_HYP_FRAMEWORK_BITMAP BIT(3)
652 static int ffa_notification_bind_common(u16 dst_id, u64 bitmap,
653 u32 flags, bool is_bind)
656 u32 func, src_dst_ids = PACK_TARGET_INFO(dst_id, drv_info->vm_id);
658 func = is_bind ? FFA_NOTIFICATION_BIND : FFA_NOTIFICATION_UNBIND;
660 invoke_ffa_fn((ffa_value_t){
661 .a0 = func, .a1 = src_dst_ids, .a2 = flags,
662 .a3 = NOTIFICATION_BITMAP_LOW(bitmap),
663 .a4 = NOTIFICATION_BITMAP_HIGH(bitmap),
666 if (ret.a0 == FFA_ERROR)
667 return ffa_to_linux_errno((int)ret.a2);
668 else if (ret.a0 != FFA_SUCCESS)
675 int ffa_notification_set(u16 src_id, u16 dst_id, u32 flags, u64 bitmap)
678 u32 src_dst_ids = PACK_TARGET_INFO(dst_id, src_id);
680 invoke_ffa_fn((ffa_value_t) {
681 .a0 = FFA_NOTIFICATION_SET, .a1 = src_dst_ids, .a2 = flags,
682 .a3 = NOTIFICATION_BITMAP_LOW(bitmap),
683 .a4 = NOTIFICATION_BITMAP_HIGH(bitmap),
686 if (ret.a0 == FFA_ERROR)
687 return ffa_to_linux_errno((int)ret.a2);
688 else if (ret.a0 != FFA_SUCCESS)
694 struct ffa_notify_bitmaps {
700 static int ffa_notification_get(u32 flags, struct ffa_notify_bitmaps *notify)
703 u16 src_id = drv_info->vm_id;
704 u16 cpu_id = smp_processor_id();
705 u32 rec_vcpu_ids = PACK_NOTIFICATION_GET_RECEIVER_INFO(cpu_id, src_id);
707 invoke_ffa_fn((ffa_value_t){
708 .a0 = FFA_NOTIFICATION_GET, .a1 = rec_vcpu_ids, .a2 = flags,
711 if (ret.a0 == FFA_ERROR)
712 return ffa_to_linux_errno((int)ret.a2);
713 else if (ret.a0 != FFA_SUCCESS)
714 return -EINVAL; /* Something else went wrong. */
716 notify->sp_map = PACK_NOTIFICATION_BITMAP(ret.a2, ret.a3);
717 notify->vm_map = PACK_NOTIFICATION_BITMAP(ret.a4, ret.a5);
718 notify->arch_map = PACK_NOTIFICATION_BITMAP(ret.a6, ret.a7);
723 struct ffa_dev_part_info {
724 ffa_sched_recv_cb callback;
729 static void __do_sched_recv_cb(u16 part_id, u16 vcpu, bool is_per_vcpu)
731 struct ffa_dev_part_info *partition;
732 ffa_sched_recv_cb callback;
735 partition = xa_load(&drv_info->partition_info, part_id);
737 pr_err("%s: Invalid partition ID 0x%x\n", __func__, part_id);
741 read_lock(&partition->rw_lock);
742 callback = partition->callback;
743 cb_data = partition->cb_data;
744 read_unlock(&partition->rw_lock);
747 callback(vcpu, is_per_vcpu, cb_data);
750 static void ffa_notification_info_get(void)
752 int idx, list, max_ids, lists_cnt, ids_processed, ids_count[MAX_IDS_64];
758 invoke_ffa_fn((ffa_value_t){
759 .a0 = FFA_FN_NATIVE(NOTIFICATION_INFO_GET),
762 if (ret.a0 != FFA_FN_NATIVE(SUCCESS) && ret.a0 != FFA_SUCCESS) {
763 if (ret.a2 != FFA_RET_NO_DATA)
764 pr_err("Notification Info fetch failed: 0x%lx (0x%lx)",
769 is_64b_resp = (ret.a0 == FFA_FN64_SUCCESS);
772 lists_cnt = FIELD_GET(NOTIFICATION_INFO_GET_ID_COUNT, ret.a2);
774 max_ids = MAX_IDS_64;
775 id_list = FIELD_GET(ID_LIST_MASK_64, ret.a2);
777 max_ids = MAX_IDS_32;
778 id_list = FIELD_GET(ID_LIST_MASK_32, ret.a2);
781 for (idx = 0; idx < lists_cnt; idx++, id_list >>= 2)
782 ids_count[idx] = (id_list & 0x3) + 1;
785 for (list = 0; list < lists_cnt; list++) {
786 u16 vcpu_id, part_id, *packed_id_list = (u16 *)&ret.a3;
788 if (ids_processed >= max_ids - 1)
791 part_id = packed_id_list[ids_processed++];
793 if (ids_count[list] == 1) { /* Global Notification */
794 __do_sched_recv_cb(part_id, 0, false);
798 /* Per vCPU Notification */
799 for (idx = 0; idx < ids_count[list]; idx++) {
800 if (ids_processed >= max_ids - 1)
803 vcpu_id = packed_id_list[ids_processed++];
805 __do_sched_recv_cb(part_id, vcpu_id, true);
808 } while (ret.a2 & NOTIFICATION_INFO_GET_MORE_PEND_MASK);
811 static int ffa_run(struct ffa_device *dev, u16 vcpu)
814 u32 target = dev->vm_id << 16 | vcpu;
816 invoke_ffa_fn((ffa_value_t){ .a0 = FFA_RUN, .a1 = target, }, &ret);
818 while (ret.a0 == FFA_INTERRUPT)
819 invoke_ffa_fn((ffa_value_t){ .a0 = FFA_RUN, .a1 = ret.a1, },
822 if (ret.a0 == FFA_ERROR)
823 return ffa_to_linux_errno((int)ret.a2);
828 static void ffa_set_up_mem_ops_native_flag(void)
830 if (!ffa_features(FFA_FN_NATIVE(MEM_LEND), 0, NULL, NULL) ||
831 !ffa_features(FFA_FN_NATIVE(MEM_SHARE), 0, NULL, NULL))
832 drv_info->mem_ops_native = true;
835 static u32 ffa_api_version_get(void)
837 return drv_info->version;
840 static int ffa_partition_info_get(const char *uuid_str,
841 struct ffa_partition_info *buffer)
845 struct ffa_partition_info *pbuf;
847 if (uuid_parse(uuid_str, &uuid)) {
848 pr_err("invalid uuid (%s)\n", uuid_str);
852 count = ffa_partition_probe(&uuid, &pbuf);
856 memcpy(buffer, pbuf, sizeof(*pbuf) * count);
861 static void ffa_mode_32bit_set(struct ffa_device *dev)
863 dev->mode_32bit = true;
866 static int ffa_sync_send_receive(struct ffa_device *dev,
867 struct ffa_send_direct_data *data)
869 return ffa_msg_send_direct_req(drv_info->vm_id, dev->vm_id,
870 dev->mode_32bit, data);
873 static int ffa_memory_share(struct ffa_mem_ops_args *args)
875 if (drv_info->mem_ops_native)
876 return ffa_memory_ops(FFA_FN_NATIVE(MEM_SHARE), args);
878 return ffa_memory_ops(FFA_MEM_SHARE, args);
881 static int ffa_memory_lend(struct ffa_mem_ops_args *args)
883 /* Note that upon a successful MEM_LEND request the caller
884 * must ensure that the memory region specified is not accessed
885 * until a successful MEM_RECALIM call has been made.
886 * On systems with a hypervisor present this will been enforced,
887 * however on systems without a hypervisor the responsibility
888 * falls to the calling kernel driver to prevent access.
890 if (drv_info->mem_ops_native)
891 return ffa_memory_ops(FFA_FN_NATIVE(MEM_LEND), args);
893 return ffa_memory_ops(FFA_MEM_LEND, args);
896 #define FFA_SECURE_PARTITION_ID_FLAG BIT(15)
898 #define ffa_notifications_disabled() (!drv_info->notif_enabled)
906 struct notifier_cb_info {
907 struct hlist_node hnode;
910 enum notify_type type;
913 static int ffa_sched_recv_cb_update(u16 part_id, ffa_sched_recv_cb callback,
914 void *cb_data, bool is_registration)
916 struct ffa_dev_part_info *partition;
919 if (ffa_notifications_disabled())
922 partition = xa_load(&drv_info->partition_info, part_id);
924 pr_err("%s: Invalid partition ID 0x%x\n", __func__, part_id);
928 write_lock(&partition->rw_lock);
930 cb_valid = !!partition->callback;
931 if (!(is_registration ^ cb_valid)) {
932 write_unlock(&partition->rw_lock);
936 partition->callback = callback;
937 partition->cb_data = cb_data;
939 write_unlock(&partition->rw_lock);
943 static int ffa_sched_recv_cb_register(struct ffa_device *dev,
944 ffa_sched_recv_cb cb, void *cb_data)
946 return ffa_sched_recv_cb_update(dev->vm_id, cb, cb_data, true);
949 static int ffa_sched_recv_cb_unregister(struct ffa_device *dev)
951 return ffa_sched_recv_cb_update(dev->vm_id, NULL, NULL, false);
954 static int ffa_notification_bind(u16 dst_id, u64 bitmap, u32 flags)
956 return ffa_notification_bind_common(dst_id, bitmap, flags, true);
959 static int ffa_notification_unbind(u16 dst_id, u64 bitmap)
961 return ffa_notification_bind_common(dst_id, bitmap, 0, false);
964 /* Should be called while the notify_lock is taken */
965 static struct notifier_cb_info *
966 notifier_hash_node_get(u16 notify_id, enum notify_type type)
968 struct notifier_cb_info *node;
970 hash_for_each_possible(drv_info->notifier_hash, node, hnode, notify_id)
971 if (type == node->type)
978 update_notifier_cb(int notify_id, enum notify_type type, ffa_notifier_cb cb,
979 void *cb_data, bool is_registration)
981 struct notifier_cb_info *cb_info = NULL;
984 cb_info = notifier_hash_node_get(notify_id, type);
985 cb_found = !!cb_info;
987 if (!(is_registration ^ cb_found))
990 if (is_registration) {
991 cb_info = kzalloc(sizeof(*cb_info), GFP_KERNEL);
995 cb_info->type = type;
997 cb_info->cb_data = cb_data;
999 hash_add(drv_info->notifier_hash, &cb_info->hnode, notify_id);
1001 hash_del(&cb_info->hnode);
1007 static enum notify_type ffa_notify_type_get(u16 vm_id)
1009 if (vm_id & FFA_SECURE_PARTITION_ID_FLAG)
1010 return SECURE_PARTITION;
1012 return NON_SECURE_VM;
1015 static int ffa_notify_relinquish(struct ffa_device *dev, int notify_id)
1018 enum notify_type type = ffa_notify_type_get(dev->vm_id);
1020 if (ffa_notifications_disabled())
1023 if (notify_id >= FFA_MAX_NOTIFICATIONS)
1026 mutex_lock(&drv_info->notify_lock);
1028 rc = update_notifier_cb(notify_id, type, NULL, NULL, false);
1030 pr_err("Could not unregister notification callback\n");
1031 mutex_unlock(&drv_info->notify_lock);
1035 rc = ffa_notification_unbind(dev->vm_id, BIT(notify_id));
1037 mutex_unlock(&drv_info->notify_lock);
1042 static int ffa_notify_request(struct ffa_device *dev, bool is_per_vcpu,
1043 ffa_notifier_cb cb, void *cb_data, int notify_id)
1047 enum notify_type type = ffa_notify_type_get(dev->vm_id);
1049 if (ffa_notifications_disabled())
1052 if (notify_id >= FFA_MAX_NOTIFICATIONS)
1055 mutex_lock(&drv_info->notify_lock);
1058 flags = PER_VCPU_NOTIFICATION_FLAG;
1060 rc = ffa_notification_bind(dev->vm_id, BIT(notify_id), flags);
1062 mutex_unlock(&drv_info->notify_lock);
1066 rc = update_notifier_cb(notify_id, type, cb, cb_data, true);
1068 pr_err("Failed to register callback for %d - %d\n",
1070 ffa_notification_unbind(dev->vm_id, BIT(notify_id));
1072 mutex_unlock(&drv_info->notify_lock);
1077 static int ffa_notify_send(struct ffa_device *dev, int notify_id,
1078 bool is_per_vcpu, u16 vcpu)
1082 if (ffa_notifications_disabled())
1086 flags |= (PER_VCPU_NOTIFICATION_FLAG | vcpu << 16);
1088 return ffa_notification_set(dev->vm_id, drv_info->vm_id, flags,
1092 static void handle_notif_callbacks(u64 bitmap, enum notify_type type)
1095 struct notifier_cb_info *cb_info = NULL;
1097 for (notify_id = 0; notify_id <= FFA_MAX_NOTIFICATIONS && bitmap;
1098 notify_id++, bitmap >>= 1) {
1102 mutex_lock(&drv_info->notify_lock);
1103 cb_info = notifier_hash_node_get(notify_id, type);
1104 mutex_unlock(&drv_info->notify_lock);
1106 if (cb_info && cb_info->cb)
1107 cb_info->cb(notify_id, cb_info->cb_data);
1111 static void notif_pcpu_irq_work_fn(struct work_struct *work)
1114 struct ffa_notify_bitmaps bitmaps;
1116 rc = ffa_notification_get(SECURE_PARTITION_BITMAP |
1117 SPM_FRAMEWORK_BITMAP, &bitmaps);
1119 pr_err("Failed to retrieve notifications with %d!\n", rc);
1123 handle_notif_callbacks(bitmaps.vm_map, NON_SECURE_VM);
1124 handle_notif_callbacks(bitmaps.sp_map, SECURE_PARTITION);
1125 handle_notif_callbacks(bitmaps.arch_map, FRAMEWORK);
1129 ffa_self_notif_handle(u16 vcpu, bool is_per_vcpu, void *cb_data)
1131 struct ffa_drv_info *info = cb_data;
1134 notif_pcpu_irq_work_fn(&info->notif_pcpu_work);
1136 queue_work_on(vcpu, info->notif_pcpu_wq,
1137 &info->notif_pcpu_work);
1140 static const struct ffa_info_ops ffa_drv_info_ops = {
1141 .api_version_get = ffa_api_version_get,
1142 .partition_info_get = ffa_partition_info_get,
1145 static const struct ffa_msg_ops ffa_drv_msg_ops = {
1146 .mode_32bit_set = ffa_mode_32bit_set,
1147 .sync_send_receive = ffa_sync_send_receive,
1150 static const struct ffa_mem_ops ffa_drv_mem_ops = {
1151 .memory_reclaim = ffa_memory_reclaim,
1152 .memory_share = ffa_memory_share,
1153 .memory_lend = ffa_memory_lend,
1156 static const struct ffa_cpu_ops ffa_drv_cpu_ops = {
1160 static const struct ffa_notifier_ops ffa_drv_notifier_ops = {
1161 .sched_recv_cb_register = ffa_sched_recv_cb_register,
1162 .sched_recv_cb_unregister = ffa_sched_recv_cb_unregister,
1163 .notify_request = ffa_notify_request,
1164 .notify_relinquish = ffa_notify_relinquish,
1165 .notify_send = ffa_notify_send,
1168 static const struct ffa_ops ffa_drv_ops = {
1169 .info_ops = &ffa_drv_info_ops,
1170 .msg_ops = &ffa_drv_msg_ops,
1171 .mem_ops = &ffa_drv_mem_ops,
1172 .cpu_ops = &ffa_drv_cpu_ops,
1173 .notifier_ops = &ffa_drv_notifier_ops,
1176 void ffa_device_match_uuid(struct ffa_device *ffa_dev, const uuid_t *uuid)
1179 struct ffa_partition_info *pbuf, *tpbuf;
1182 * FF-A v1.1 provides UUID for each partition as part of the discovery
1183 * API, the discovered UUID must be populated in the device's UUID and
1184 * there is no need to copy the same from the driver table.
1186 if (drv_info->version > FFA_VERSION_1_0)
1189 count = ffa_partition_probe(uuid, &pbuf);
1193 for (idx = 0, tpbuf = pbuf; idx < count; idx++, tpbuf++)
1194 if (tpbuf->id == ffa_dev->vm_id)
1195 uuid_copy(&ffa_dev->uuid, uuid);
1199 static int ffa_setup_partitions(void)
1201 int count, idx, ret;
1203 struct ffa_device *ffa_dev;
1204 struct ffa_dev_part_info *info;
1205 struct ffa_partition_info *pbuf, *tpbuf;
1207 count = ffa_partition_probe(&uuid_null, &pbuf);
1209 pr_info("%s: No partitions found, error %d\n", __func__, count);
1213 xa_init(&drv_info->partition_info);
1214 for (idx = 0, tpbuf = pbuf; idx < count; idx++, tpbuf++) {
1215 import_uuid(&uuid, (u8 *)tpbuf->uuid);
1217 /* Note that if the UUID will be uuid_null, that will require
1218 * ffa_device_match() to find the UUID of this partition id
1219 * with help of ffa_device_match_uuid(). FF-A v1.1 and above
1220 * provides UUID here for each partition as part of the
1221 * discovery API and the same is passed.
1223 ffa_dev = ffa_device_register(&uuid, tpbuf->id, &ffa_drv_ops);
1225 pr_err("%s: failed to register partition ID 0x%x\n",
1226 __func__, tpbuf->id);
1230 if (drv_info->version > FFA_VERSION_1_0 &&
1231 !(tpbuf->properties & FFA_PARTITION_AARCH64_EXEC))
1232 ffa_mode_32bit_set(ffa_dev);
1234 info = kzalloc(sizeof(*info), GFP_KERNEL);
1236 ffa_device_unregister(ffa_dev);
1239 rwlock_init(&info->rw_lock);
1240 ret = xa_insert(&drv_info->partition_info, tpbuf->id,
1243 pr_err("%s: failed to save partition ID 0x%x - ret:%d\n",
1244 __func__, tpbuf->id, ret);
1245 ffa_device_unregister(ffa_dev);
1252 /* Allocate for the host */
1253 info = kzalloc(sizeof(*info), GFP_KERNEL);
1255 pr_err("%s: failed to alloc Host partition ID 0x%x. Abort.\n",
1256 __func__, drv_info->vm_id);
1257 /* Already registered devices are freed on bus_exit */
1258 ffa_partitions_cleanup();
1262 rwlock_init(&info->rw_lock);
1263 ret = xa_insert(&drv_info->partition_info, drv_info->vm_id,
1266 pr_err("%s: failed to save Host partition ID 0x%x - ret:%d. Abort.\n",
1267 __func__, drv_info->vm_id, ret);
1269 /* Already registered devices are freed on bus_exit */
1270 ffa_partitions_cleanup();
1276 static void ffa_partitions_cleanup(void)
1278 struct ffa_dev_part_info *info;
1281 xa_for_each(&drv_info->partition_info, idx, info) {
1282 xa_erase(&drv_info->partition_info, idx);
1286 xa_destroy(&drv_info->partition_info);
1289 /* FFA FEATURE IDs */
1290 #define FFA_FEAT_NOTIFICATION_PENDING_INT (1)
1291 #define FFA_FEAT_SCHEDULE_RECEIVER_INT (2)
1292 #define FFA_FEAT_MANAGED_EXIT_INT (3)
1294 static irqreturn_t irq_handler(int irq, void *irq_data)
1296 struct ffa_pcpu_irq *pcpu = irq_data;
1297 struct ffa_drv_info *info = pcpu->info;
1299 queue_work(info->notif_pcpu_wq, &info->irq_work);
1304 static void ffa_sched_recv_irq_work_fn(struct work_struct *work)
1306 ffa_notification_info_get();
1309 static int ffa_sched_recv_irq_map(void)
1311 int ret, irq, sr_intid;
1313 /* The returned sr_intid is assumed to be SGI donated to NS world */
1314 ret = ffa_features(FFA_FEAT_SCHEDULE_RECEIVER_INT, 0, &sr_intid, NULL);
1316 if (ret != -EOPNOTSUPP)
1317 pr_err("Failed to retrieve scheduler Rx interrupt\n");
1321 if (acpi_disabled) {
1322 struct of_phandle_args oirq = {};
1323 struct device_node *gic;
1325 /* Only GICv3 supported currently with the device tree */
1326 gic = of_find_compatible_node(NULL, NULL, "arm,gic-v3");
1331 oirq.args_count = 1;
1332 oirq.args[0] = sr_intid;
1333 irq = irq_create_of_mapping(&oirq);
1337 irq = acpi_register_gsi(NULL, sr_intid, ACPI_EDGE_SENSITIVE,
1343 pr_err("Failed to create IRQ mapping!\n");
1350 static void ffa_sched_recv_irq_unmap(void)
1352 if (drv_info->sched_recv_irq) {
1353 irq_dispose_mapping(drv_info->sched_recv_irq);
1354 drv_info->sched_recv_irq = 0;
1358 static int ffa_cpuhp_pcpu_irq_enable(unsigned int cpu)
1360 enable_percpu_irq(drv_info->sched_recv_irq, IRQ_TYPE_NONE);
1364 static int ffa_cpuhp_pcpu_irq_disable(unsigned int cpu)
1366 disable_percpu_irq(drv_info->sched_recv_irq);
1370 static void ffa_uninit_pcpu_irq(void)
1372 if (drv_info->cpuhp_state) {
1373 cpuhp_remove_state(drv_info->cpuhp_state);
1374 drv_info->cpuhp_state = 0;
1377 if (drv_info->notif_pcpu_wq) {
1378 destroy_workqueue(drv_info->notif_pcpu_wq);
1379 drv_info->notif_pcpu_wq = NULL;
1382 if (drv_info->sched_recv_irq)
1383 free_percpu_irq(drv_info->sched_recv_irq, drv_info->irq_pcpu);
1385 if (drv_info->irq_pcpu) {
1386 free_percpu(drv_info->irq_pcpu);
1387 drv_info->irq_pcpu = NULL;
1391 static int ffa_init_pcpu_irq(unsigned int irq)
1393 struct ffa_pcpu_irq __percpu *irq_pcpu;
1396 irq_pcpu = alloc_percpu(struct ffa_pcpu_irq);
1400 for_each_present_cpu(cpu)
1401 per_cpu_ptr(irq_pcpu, cpu)->info = drv_info;
1403 drv_info->irq_pcpu = irq_pcpu;
1405 ret = request_percpu_irq(irq, irq_handler, "ARM-FFA", irq_pcpu);
1407 pr_err("Error registering notification IRQ %d: %d\n", irq, ret);
1411 INIT_WORK(&drv_info->irq_work, ffa_sched_recv_irq_work_fn);
1412 INIT_WORK(&drv_info->notif_pcpu_work, notif_pcpu_irq_work_fn);
1413 drv_info->notif_pcpu_wq = create_workqueue("ffa_pcpu_irq_notification");
1414 if (!drv_info->notif_pcpu_wq)
1417 ret = cpuhp_setup_state(CPUHP_AP_ONLINE_DYN, "ffa/pcpu-irq:starting",
1418 ffa_cpuhp_pcpu_irq_enable,
1419 ffa_cpuhp_pcpu_irq_disable);
1424 drv_info->cpuhp_state = ret;
1428 static void ffa_notifications_cleanup(void)
1430 ffa_uninit_pcpu_irq();
1431 ffa_sched_recv_irq_unmap();
1433 if (drv_info->bitmap_created) {
1434 ffa_notification_bitmap_destroy();
1435 drv_info->bitmap_created = false;
1437 drv_info->notif_enabled = false;
1440 static void ffa_notifications_setup(void)
1444 ret = ffa_features(FFA_NOTIFICATION_BITMAP_CREATE, 0, NULL, NULL);
1446 pr_info("Notifications not supported, continuing with it ..\n");
1450 ret = ffa_notification_bitmap_create();
1452 pr_info("Notification bitmap create error %d\n", ret);
1455 drv_info->bitmap_created = true;
1457 irq = ffa_sched_recv_irq_map();
1463 drv_info->sched_recv_irq = irq;
1465 ret = ffa_init_pcpu_irq(irq);
1469 hash_init(drv_info->notifier_hash);
1470 mutex_init(&drv_info->notify_lock);
1472 drv_info->notif_enabled = true;
1475 pr_info("Notification setup failed %d, not enabled\n", ret);
1476 ffa_notifications_cleanup();
1479 static int __init ffa_init(void)
1483 ret = ffa_transport_init(&invoke_ffa_fn);
1487 ret = arm_ffa_bus_init();
1491 drv_info = kzalloc(sizeof(*drv_info), GFP_KERNEL);
1497 ret = ffa_version_check(&drv_info->version);
1501 if (ffa_id_get(&drv_info->vm_id)) {
1502 pr_err("failed to obtain VM id for self\n");
1507 drv_info->rx_buffer = alloc_pages_exact(RXTX_BUFFER_SIZE, GFP_KERNEL);
1508 if (!drv_info->rx_buffer) {
1513 drv_info->tx_buffer = alloc_pages_exact(RXTX_BUFFER_SIZE, GFP_KERNEL);
1514 if (!drv_info->tx_buffer) {
1519 ret = ffa_rxtx_map(virt_to_phys(drv_info->tx_buffer),
1520 virt_to_phys(drv_info->rx_buffer),
1521 RXTX_BUFFER_SIZE / FFA_PAGE_SIZE);
1523 pr_err("failed to register FFA RxTx buffers\n");
1527 mutex_init(&drv_info->rx_lock);
1528 mutex_init(&drv_info->tx_lock);
1530 ffa_set_up_mem_ops_native_flag();
1532 ffa_notifications_setup();
1534 ret = ffa_setup_partitions();
1536 pr_err("failed to setup partitions\n");
1537 goto cleanup_notifs;
1540 ret = ffa_sched_recv_cb_update(drv_info->vm_id, ffa_self_notif_handle,
1543 pr_info("Failed to register driver sched callback %d\n", ret);
1548 ffa_notifications_cleanup();
1550 if (drv_info->tx_buffer)
1551 free_pages_exact(drv_info->tx_buffer, RXTX_BUFFER_SIZE);
1552 free_pages_exact(drv_info->rx_buffer, RXTX_BUFFER_SIZE);
1559 subsys_initcall(ffa_init);
1561 static void __exit ffa_exit(void)
1563 ffa_notifications_cleanup();
1564 ffa_partitions_cleanup();
1565 ffa_rxtx_unmap(drv_info->vm_id);
1566 free_pages_exact(drv_info->tx_buffer, RXTX_BUFFER_SIZE);
1567 free_pages_exact(drv_info->rx_buffer, RXTX_BUFFER_SIZE);
1571 module_exit(ffa_exit);
1573 MODULE_ALIAS("arm-ffa");
1574 MODULE_AUTHOR("Sudeep Holla <sudeep.holla@arm.com>");
1575 MODULE_DESCRIPTION("Arm FF-A interface driver");
1576 MODULE_LICENSE("GPL v2");