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/arm_ffa.h>
26 #include <linux/bitfield.h>
27 #include <linux/device.h>
29 #include <linux/kernel.h>
30 #include <linux/module.h>
32 #include <linux/scatterlist.h>
33 #include <linux/slab.h>
34 #include <linux/uuid.h>
38 #define FFA_DRIVER_VERSION FFA_VERSION_1_0
40 #define FFA_SMC(calling_convention, func_num) \
41 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, (calling_convention), \
42 ARM_SMCCC_OWNER_STANDARD, (func_num))
44 #define FFA_SMC_32(func_num) FFA_SMC(ARM_SMCCC_SMC_32, (func_num))
45 #define FFA_SMC_64(func_num) FFA_SMC(ARM_SMCCC_SMC_64, (func_num))
47 #define FFA_ERROR FFA_SMC_32(0x60)
48 #define FFA_SUCCESS FFA_SMC_32(0x61)
49 #define FFA_INTERRUPT FFA_SMC_32(0x62)
50 #define FFA_VERSION FFA_SMC_32(0x63)
51 #define FFA_FEATURES FFA_SMC_32(0x64)
52 #define FFA_RX_RELEASE FFA_SMC_32(0x65)
53 #define FFA_RXTX_MAP FFA_SMC_32(0x66)
54 #define FFA_FN64_RXTX_MAP FFA_SMC_64(0x66)
55 #define FFA_RXTX_UNMAP FFA_SMC_32(0x67)
56 #define FFA_PARTITION_INFO_GET FFA_SMC_32(0x68)
57 #define FFA_ID_GET FFA_SMC_32(0x69)
58 #define FFA_MSG_POLL FFA_SMC_32(0x6A)
59 #define FFA_MSG_WAIT FFA_SMC_32(0x6B)
60 #define FFA_YIELD FFA_SMC_32(0x6C)
61 #define FFA_RUN FFA_SMC_32(0x6D)
62 #define FFA_MSG_SEND FFA_SMC_32(0x6E)
63 #define FFA_MSG_SEND_DIRECT_REQ FFA_SMC_32(0x6F)
64 #define FFA_FN64_MSG_SEND_DIRECT_REQ FFA_SMC_64(0x6F)
65 #define FFA_MSG_SEND_DIRECT_RESP FFA_SMC_32(0x70)
66 #define FFA_FN64_MSG_SEND_DIRECT_RESP FFA_SMC_64(0x70)
67 #define FFA_MEM_DONATE FFA_SMC_32(0x71)
68 #define FFA_FN64_MEM_DONATE FFA_SMC_64(0x71)
69 #define FFA_MEM_LEND FFA_SMC_32(0x72)
70 #define FFA_FN64_MEM_LEND FFA_SMC_64(0x72)
71 #define FFA_MEM_SHARE FFA_SMC_32(0x73)
72 #define FFA_FN64_MEM_SHARE FFA_SMC_64(0x73)
73 #define FFA_MEM_RETRIEVE_REQ FFA_SMC_32(0x74)
74 #define FFA_FN64_MEM_RETRIEVE_REQ FFA_SMC_64(0x74)
75 #define FFA_MEM_RETRIEVE_RESP FFA_SMC_32(0x75)
76 #define FFA_MEM_RELINQUISH FFA_SMC_32(0x76)
77 #define FFA_MEM_RECLAIM FFA_SMC_32(0x77)
78 #define FFA_MEM_OP_PAUSE FFA_SMC_32(0x78)
79 #define FFA_MEM_OP_RESUME FFA_SMC_32(0x79)
80 #define FFA_MEM_FRAG_RX FFA_SMC_32(0x7A)
81 #define FFA_MEM_FRAG_TX FFA_SMC_32(0x7B)
82 #define FFA_NORMAL_WORLD_RESUME FFA_SMC_32(0x7C)
85 * For some calls it is necessary to use SMC64 to pass or return 64-bit values.
86 * For such calls FFA_FN_NATIVE(name) will choose the appropriate
87 * (native-width) function ID.
90 #define FFA_FN_NATIVE(name) FFA_FN64_##name
92 #define FFA_FN_NATIVE(name) FFA_##name
95 /* FFA error codes. */
96 #define FFA_RET_SUCCESS (0)
97 #define FFA_RET_NOT_SUPPORTED (-1)
98 #define FFA_RET_INVALID_PARAMETERS (-2)
99 #define FFA_RET_NO_MEMORY (-3)
100 #define FFA_RET_BUSY (-4)
101 #define FFA_RET_INTERRUPTED (-5)
102 #define FFA_RET_DENIED (-6)
103 #define FFA_RET_RETRY (-7)
104 #define FFA_RET_ABORTED (-8)
106 #define MAJOR_VERSION_MASK GENMASK(30, 16)
107 #define MINOR_VERSION_MASK GENMASK(15, 0)
108 #define MAJOR_VERSION(x) ((u16)(FIELD_GET(MAJOR_VERSION_MASK, (x))))
109 #define MINOR_VERSION(x) ((u16)(FIELD_GET(MINOR_VERSION_MASK, (x))))
110 #define PACK_VERSION_INFO(major, minor) \
111 (FIELD_PREP(MAJOR_VERSION_MASK, (major)) | \
112 FIELD_PREP(MINOR_VERSION_MASK, (minor)))
113 #define FFA_VERSION_1_0 PACK_VERSION_INFO(1, 0)
114 #define FFA_MIN_VERSION FFA_VERSION_1_0
116 #define SENDER_ID_MASK GENMASK(31, 16)
117 #define RECEIVER_ID_MASK GENMASK(15, 0)
118 #define SENDER_ID(x) ((u16)(FIELD_GET(SENDER_ID_MASK, (x))))
119 #define RECEIVER_ID(x) ((u16)(FIELD_GET(RECEIVER_ID_MASK, (x))))
120 #define PACK_TARGET_INFO(s, r) \
121 (FIELD_PREP(SENDER_ID_MASK, (s)) | FIELD_PREP(RECEIVER_ID_MASK, (r)))
124 * FF-A specification mentions explicitly about '4K pages'. This should
125 * not be confused with the kernel PAGE_SIZE, which is the translation
126 * granule kernel is configured and may be one among 4K, 16K and 64K.
128 #define FFA_PAGE_SIZE SZ_4K
130 * Keeping RX TX buffer size as 4K for now
131 * 64K may be preferred to keep it min a page in 64K PAGE_SIZE config
133 #define RXTX_BUFFER_SIZE SZ_4K
135 static ffa_fn *invoke_ffa_fn;
137 static const int ffa_linux_errmap[] = {
138 /* better than switch case as long as return value is continuous */
139 0, /* FFA_RET_SUCCESS */
140 -EOPNOTSUPP, /* FFA_RET_NOT_SUPPORTED */
141 -EINVAL, /* FFA_RET_INVALID_PARAMETERS */
142 -ENOMEM, /* FFA_RET_NO_MEMORY */
143 -EBUSY, /* FFA_RET_BUSY */
144 -EINTR, /* FFA_RET_INTERRUPTED */
145 -EACCES, /* FFA_RET_DENIED */
146 -EAGAIN, /* FFA_RET_RETRY */
147 -ECANCELED, /* FFA_RET_ABORTED */
150 static inline int ffa_to_linux_errno(int errno)
152 int err_idx = -errno;
154 if (err_idx >= 0 && err_idx < ARRAY_SIZE(ffa_linux_errmap))
155 return ffa_linux_errmap[err_idx];
159 struct ffa_drv_info {
162 struct mutex rx_lock; /* lock to protect Rx buffer */
163 struct mutex tx_lock; /* lock to protect Tx buffer */
168 static struct ffa_drv_info *drv_info;
170 static int ffa_version_check(u32 *version)
174 invoke_ffa_fn((ffa_value_t){
175 .a0 = FFA_VERSION, .a1 = FFA_DRIVER_VERSION,
178 if (ver.a0 == FFA_RET_NOT_SUPPORTED) {
179 pr_info("FFA_VERSION returned not supported\n");
183 if (ver.a0 < FFA_MIN_VERSION || ver.a0 > FFA_DRIVER_VERSION) {
184 pr_err("Incompatible version %d.%d found\n",
185 MAJOR_VERSION(ver.a0), MINOR_VERSION(ver.a0));
190 pr_info("Version %d.%d found\n", MAJOR_VERSION(ver.a0),
191 MINOR_VERSION(ver.a0));
195 static int ffa_rx_release(void)
199 invoke_ffa_fn((ffa_value_t){
200 .a0 = FFA_RX_RELEASE,
203 if (ret.a0 == FFA_ERROR)
204 return ffa_to_linux_errno((int)ret.a2);
206 /* check for ret.a0 == FFA_RX_RELEASE ? */
211 static int ffa_rxtx_map(phys_addr_t tx_buf, phys_addr_t rx_buf, u32 pg_cnt)
215 invoke_ffa_fn((ffa_value_t){
216 .a0 = FFA_FN_NATIVE(RXTX_MAP),
217 .a1 = tx_buf, .a2 = rx_buf, .a3 = pg_cnt,
220 if (ret.a0 == FFA_ERROR)
221 return ffa_to_linux_errno((int)ret.a2);
226 static int ffa_rxtx_unmap(u16 vm_id)
230 invoke_ffa_fn((ffa_value_t){
231 .a0 = FFA_RXTX_UNMAP, .a1 = PACK_TARGET_INFO(vm_id, 0),
234 if (ret.a0 == FFA_ERROR)
235 return ffa_to_linux_errno((int)ret.a2);
240 /* buffer must be sizeof(struct ffa_partition_info) * num_partitions */
242 __ffa_partition_info_get(u32 uuid0, u32 uuid1, u32 uuid2, u32 uuid3,
243 struct ffa_partition_info *buffer, int num_partitions)
246 ffa_value_t partition_info;
248 mutex_lock(&drv_info->rx_lock);
249 invoke_ffa_fn((ffa_value_t){
250 .a0 = FFA_PARTITION_INFO_GET,
251 .a1 = uuid0, .a2 = uuid1, .a3 = uuid2, .a4 = uuid3,
254 if (partition_info.a0 == FFA_ERROR) {
255 mutex_unlock(&drv_info->rx_lock);
256 return ffa_to_linux_errno((int)partition_info.a2);
259 count = partition_info.a2;
261 if (buffer && count <= num_partitions)
262 memcpy(buffer, drv_info->rx_buffer, sizeof(*buffer) * count);
266 mutex_unlock(&drv_info->rx_lock);
271 /* buffer is allocated and caller must free the same if returned count > 0 */
273 ffa_partition_probe(const uuid_t *uuid, struct ffa_partition_info **buffer)
277 struct ffa_partition_info *pbuf;
279 export_uuid((u8 *)uuid0_4, uuid);
280 count = __ffa_partition_info_get(uuid0_4[0], uuid0_4[1], uuid0_4[2],
281 uuid0_4[3], NULL, 0);
285 pbuf = kcalloc(count, sizeof(*pbuf), GFP_KERNEL);
289 count = __ffa_partition_info_get(uuid0_4[0], uuid0_4[1], uuid0_4[2],
290 uuid0_4[3], pbuf, count);
299 #define VM_ID_MASK GENMASK(15, 0)
300 static int ffa_id_get(u16 *vm_id)
304 invoke_ffa_fn((ffa_value_t){
308 if (id.a0 == FFA_ERROR)
309 return ffa_to_linux_errno((int)id.a2);
311 *vm_id = FIELD_GET(VM_ID_MASK, (id.a2));
316 static int ffa_msg_send_direct_req(u16 src_id, u16 dst_id, bool mode_32bit,
317 struct ffa_send_direct_data *data)
319 u32 req_id, resp_id, src_dst_ids = PACK_TARGET_INFO(src_id, dst_id);
323 req_id = FFA_MSG_SEND_DIRECT_REQ;
324 resp_id = FFA_MSG_SEND_DIRECT_RESP;
326 req_id = FFA_FN_NATIVE(MSG_SEND_DIRECT_REQ);
327 resp_id = FFA_FN_NATIVE(MSG_SEND_DIRECT_RESP);
330 invoke_ffa_fn((ffa_value_t){
331 .a0 = req_id, .a1 = src_dst_ids, .a2 = 0,
332 .a3 = data->data0, .a4 = data->data1, .a5 = data->data2,
333 .a6 = data->data3, .a7 = data->data4,
336 while (ret.a0 == FFA_INTERRUPT)
337 invoke_ffa_fn((ffa_value_t){
338 .a0 = FFA_RUN, .a1 = ret.a1,
341 if (ret.a0 == FFA_ERROR)
342 return ffa_to_linux_errno((int)ret.a2);
344 if (ret.a0 == resp_id) {
345 data->data0 = ret.a3;
346 data->data1 = ret.a4;
347 data->data2 = ret.a5;
348 data->data3 = ret.a6;
349 data->data4 = ret.a7;
356 static int ffa_mem_first_frag(u32 func_id, phys_addr_t buf, u32 buf_sz,
357 u32 frag_len, u32 len, u64 *handle)
361 invoke_ffa_fn((ffa_value_t){
362 .a0 = func_id, .a1 = len, .a2 = frag_len,
363 .a3 = buf, .a4 = buf_sz,
366 while (ret.a0 == FFA_MEM_OP_PAUSE)
367 invoke_ffa_fn((ffa_value_t){
368 .a0 = FFA_MEM_OP_RESUME,
369 .a1 = ret.a1, .a2 = ret.a2,
372 if (ret.a0 == FFA_ERROR)
373 return ffa_to_linux_errno((int)ret.a2);
375 if (ret.a0 != FFA_SUCCESS)
379 *handle = PACK_HANDLE(ret.a2, ret.a3);
384 static int ffa_mem_next_frag(u64 handle, u32 frag_len)
388 invoke_ffa_fn((ffa_value_t){
389 .a0 = FFA_MEM_FRAG_TX,
390 .a1 = HANDLE_LOW(handle), .a2 = HANDLE_HIGH(handle),
394 while (ret.a0 == FFA_MEM_OP_PAUSE)
395 invoke_ffa_fn((ffa_value_t){
396 .a0 = FFA_MEM_OP_RESUME,
397 .a1 = ret.a1, .a2 = ret.a2,
400 if (ret.a0 == FFA_ERROR)
401 return ffa_to_linux_errno((int)ret.a2);
403 if (ret.a0 != FFA_MEM_FRAG_RX)
410 ffa_transmit_fragment(u32 func_id, phys_addr_t buf, u32 buf_sz, u32 frag_len,
411 u32 len, u64 *handle, bool first)
414 return ffa_mem_next_frag(*handle, frag_len);
416 return ffa_mem_first_frag(func_id, buf, buf_sz, frag_len, len, handle);
419 static u32 ffa_get_num_pages_sg(struct scatterlist *sg)
424 num_pages += sg->length / FFA_PAGE_SIZE;
425 } while ((sg = sg_next(sg)));
431 ffa_setup_and_transmit(u32 func_id, void *buffer, u32 max_fragsize,
432 struct ffa_mem_ops_args *args)
436 phys_addr_t addr = 0;
437 struct ffa_composite_mem_region *composite;
438 struct ffa_mem_region_addr_range *constituents;
439 struct ffa_mem_region_attributes *ep_mem_access;
440 struct ffa_mem_region *mem_region = buffer;
441 u32 idx, frag_len, length, buf_sz = 0, num_entries = sg_nents(args->sg);
443 mem_region->tag = args->tag;
444 mem_region->flags = args->flags;
445 mem_region->sender_id = drv_info->vm_id;
446 mem_region->attributes = FFA_MEM_NORMAL | FFA_MEM_WRITE_BACK |
447 FFA_MEM_INNER_SHAREABLE;
448 ep_mem_access = &mem_region->ep_mem_access[0];
450 for (idx = 0; idx < args->nattrs; idx++, ep_mem_access++) {
451 ep_mem_access->receiver = args->attrs[idx].receiver;
452 ep_mem_access->attrs = args->attrs[idx].attrs;
453 ep_mem_access->composite_off = COMPOSITE_OFFSET(args->nattrs);
455 mem_region->ep_count = args->nattrs;
457 composite = buffer + COMPOSITE_OFFSET(args->nattrs);
458 composite->total_pg_cnt = ffa_get_num_pages_sg(args->sg);
459 composite->addr_range_cnt = num_entries;
461 length = COMPOSITE_CONSTITUENTS_OFFSET(args->nattrs, num_entries);
462 frag_len = COMPOSITE_CONSTITUENTS_OFFSET(args->nattrs, 0);
463 if (frag_len > max_fragsize)
466 if (!args->use_txbuf) {
467 addr = virt_to_phys(buffer);
468 buf_sz = max_fragsize / FFA_PAGE_SIZE;
471 constituents = buffer + frag_len;
474 if (frag_len == max_fragsize) {
475 rc = ffa_transmit_fragment(func_id, addr, buf_sz,
477 &args->g_handle, first);
484 constituents = buffer;
487 if ((void *)constituents - buffer > max_fragsize) {
488 pr_err("Memory Region Fragment > Tx Buffer size\n");
492 constituents->address = sg_phys(args->sg);
493 constituents->pg_cnt = args->sg->length / FFA_PAGE_SIZE;
495 frag_len += sizeof(struct ffa_mem_region_addr_range);
496 } while ((args->sg = sg_next(args->sg)));
498 return ffa_transmit_fragment(func_id, addr, buf_sz, frag_len,
499 length, &args->g_handle, first);
502 static int ffa_memory_ops(u32 func_id, struct ffa_mem_ops_args *args)
507 if (!args->use_txbuf) {
508 buffer = alloc_pages_exact(RXTX_BUFFER_SIZE, GFP_KERNEL);
512 buffer = drv_info->tx_buffer;
513 mutex_lock(&drv_info->tx_lock);
516 ret = ffa_setup_and_transmit(func_id, buffer, RXTX_BUFFER_SIZE, args);
519 mutex_unlock(&drv_info->tx_lock);
521 free_pages_exact(buffer, RXTX_BUFFER_SIZE);
523 return ret < 0 ? ret : 0;
526 static int ffa_memory_reclaim(u64 g_handle, u32 flags)
530 invoke_ffa_fn((ffa_value_t){
531 .a0 = FFA_MEM_RECLAIM,
532 .a1 = HANDLE_LOW(g_handle), .a2 = HANDLE_HIGH(g_handle),
536 if (ret.a0 == FFA_ERROR)
537 return ffa_to_linux_errno((int)ret.a2);
542 static u32 ffa_api_version_get(void)
544 return drv_info->version;
547 static int ffa_partition_info_get(const char *uuid_str,
548 struct ffa_partition_info *buffer)
552 struct ffa_partition_info *pbuf;
554 if (uuid_parse(uuid_str, &uuid)) {
555 pr_err("invalid uuid (%s)\n", uuid_str);
559 count = ffa_partition_probe(&uuid_null, &pbuf);
563 memcpy(buffer, pbuf, sizeof(*pbuf) * count);
568 static void ffa_mode_32bit_set(struct ffa_device *dev)
570 dev->mode_32bit = true;
573 static int ffa_sync_send_receive(struct ffa_device *dev,
574 struct ffa_send_direct_data *data)
576 return ffa_msg_send_direct_req(drv_info->vm_id, dev->vm_id,
577 dev->mode_32bit, data);
581 ffa_memory_share(struct ffa_device *dev, struct ffa_mem_ops_args *args)
584 return ffa_memory_ops(FFA_MEM_SHARE, args);
586 return ffa_memory_ops(FFA_FN_NATIVE(MEM_SHARE), args);
589 static const struct ffa_dev_ops ffa_ops = {
590 .api_version_get = ffa_api_version_get,
591 .partition_info_get = ffa_partition_info_get,
592 .mode_32bit_set = ffa_mode_32bit_set,
593 .sync_send_receive = ffa_sync_send_receive,
594 .memory_reclaim = ffa_memory_reclaim,
595 .memory_share = ffa_memory_share,
598 const struct ffa_dev_ops *ffa_dev_ops_get(struct ffa_device *dev)
600 if (ffa_device_is_valid(dev))
605 EXPORT_SYMBOL_GPL(ffa_dev_ops_get);
607 void ffa_device_match_uuid(struct ffa_device *ffa_dev, const uuid_t *uuid)
610 struct ffa_partition_info *pbuf, *tpbuf;
612 count = ffa_partition_probe(uuid, &pbuf);
616 for (idx = 0, tpbuf = pbuf; idx < count; idx++, tpbuf++)
617 if (tpbuf->id == ffa_dev->vm_id)
618 uuid_copy(&ffa_dev->uuid, uuid);
622 static void ffa_setup_partitions(void)
625 struct ffa_device *ffa_dev;
626 struct ffa_partition_info *pbuf, *tpbuf;
628 count = ffa_partition_probe(&uuid_null, &pbuf);
630 pr_info("%s: No partitions found, error %d\n", __func__, count);
634 for (idx = 0, tpbuf = pbuf; idx < count; idx++, tpbuf++) {
635 /* Note that the &uuid_null parameter will require
636 * ffa_device_match() to find the UUID of this partition id
637 * with help of ffa_device_match_uuid(). Once the FF-A spec
638 * is updated to provide correct UUID here for each partition
639 * as part of the discovery API, we need to pass the
640 * discovered UUID here instead.
642 ffa_dev = ffa_device_register(&uuid_null, tpbuf->id);
644 pr_err("%s: failed to register partition ID 0x%x\n",
645 __func__, tpbuf->id);
649 ffa_dev_set_drvdata(ffa_dev, drv_info);
654 static int __init ffa_init(void)
658 ret = ffa_transport_init(&invoke_ffa_fn);
662 ret = arm_ffa_bus_init();
666 drv_info = kzalloc(sizeof(*drv_info), GFP_KERNEL);
672 ret = ffa_version_check(&drv_info->version);
676 if (ffa_id_get(&drv_info->vm_id)) {
677 pr_err("failed to obtain VM id for self\n");
682 drv_info->rx_buffer = alloc_pages_exact(RXTX_BUFFER_SIZE, GFP_KERNEL);
683 if (!drv_info->rx_buffer) {
688 drv_info->tx_buffer = alloc_pages_exact(RXTX_BUFFER_SIZE, GFP_KERNEL);
689 if (!drv_info->tx_buffer) {
694 ret = ffa_rxtx_map(virt_to_phys(drv_info->tx_buffer),
695 virt_to_phys(drv_info->rx_buffer),
696 RXTX_BUFFER_SIZE / FFA_PAGE_SIZE);
698 pr_err("failed to register FFA RxTx buffers\n");
702 mutex_init(&drv_info->rx_lock);
703 mutex_init(&drv_info->tx_lock);
705 ffa_setup_partitions();
709 if (drv_info->tx_buffer)
710 free_pages_exact(drv_info->tx_buffer, RXTX_BUFFER_SIZE);
711 free_pages_exact(drv_info->rx_buffer, RXTX_BUFFER_SIZE);
718 subsys_initcall(ffa_init);
720 static void __exit ffa_exit(void)
722 ffa_rxtx_unmap(drv_info->vm_id);
723 free_pages_exact(drv_info->tx_buffer, RXTX_BUFFER_SIZE);
724 free_pages_exact(drv_info->rx_buffer, RXTX_BUFFER_SIZE);
728 module_exit(ffa_exit);
730 MODULE_ALIAS("arm-ffa");
731 MODULE_AUTHOR("Sudeep Holla <sudeep.holla@arm.com>");
732 MODULE_DESCRIPTION("Arm FF-A interface driver");
733 MODULE_LICENSE("GPL v2");