1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Copyright (C) 2021 ARM Ltd.
4 */
5
6 #ifndef _LINUX_ARM_FFA_H
7 #define _LINUX_ARM_FFA_H
8
9 #include <linux/bitfield.h>
10 #include <linux/device.h>
11 #include <linux/module.h>
12 #include <linux/types.h>
13 #include <linux/uuid.h>
14
15 #define FFA_SMC(calling_convention, func_num) \
16 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, (calling_convention), \
17 ARM_SMCCC_OWNER_STANDARD, (func_num))
18
19 #define FFA_SMC_32(func_num) FFA_SMC(ARM_SMCCC_SMC_32, (func_num))
20 #define FFA_SMC_64(func_num) FFA_SMC(ARM_SMCCC_SMC_64, (func_num))
21
22 #define FFA_ERROR FFA_SMC_32(0x60)
23 #define FFA_SUCCESS FFA_SMC_32(0x61)
24 #define FFA_FN64_SUCCESS FFA_SMC_64(0x61)
25 #define FFA_INTERRUPT FFA_SMC_32(0x62)
26 #define FFA_VERSION FFA_SMC_32(0x63)
27 #define FFA_FEATURES FFA_SMC_32(0x64)
28 #define FFA_RX_RELEASE FFA_SMC_32(0x65)
29 #define FFA_RXTX_MAP FFA_SMC_32(0x66)
30 #define FFA_FN64_RXTX_MAP FFA_SMC_64(0x66)
31 #define FFA_RXTX_UNMAP FFA_SMC_32(0x67)
32 #define FFA_PARTITION_INFO_GET FFA_SMC_32(0x68)
33 #define FFA_ID_GET FFA_SMC_32(0x69)
34 #define FFA_MSG_POLL FFA_SMC_32(0x6A)
35 #define FFA_MSG_WAIT FFA_SMC_32(0x6B)
36 #define FFA_YIELD FFA_SMC_32(0x6C)
37 #define FFA_RUN FFA_SMC_32(0x6D)
38 #define FFA_MSG_SEND FFA_SMC_32(0x6E)
39 #define FFA_MSG_SEND_DIRECT_REQ FFA_SMC_32(0x6F)
40 #define FFA_FN64_MSG_SEND_DIRECT_REQ FFA_SMC_64(0x6F)
41 #define FFA_MSG_SEND_DIRECT_RESP FFA_SMC_32(0x70)
42 #define FFA_FN64_MSG_SEND_DIRECT_RESP FFA_SMC_64(0x70)
43 #define FFA_MEM_DONATE FFA_SMC_32(0x71)
44 #define FFA_FN64_MEM_DONATE FFA_SMC_64(0x71)
45 #define FFA_MEM_LEND FFA_SMC_32(0x72)
46 #define FFA_FN64_MEM_LEND FFA_SMC_64(0x72)
47 #define FFA_MEM_SHARE FFA_SMC_32(0x73)
48 #define FFA_FN64_MEM_SHARE FFA_SMC_64(0x73)
49 #define FFA_MEM_RETRIEVE_REQ FFA_SMC_32(0x74)
50 #define FFA_FN64_MEM_RETRIEVE_REQ FFA_SMC_64(0x74)
51 #define FFA_MEM_RETRIEVE_RESP FFA_SMC_32(0x75)
52 #define FFA_MEM_RELINQUISH FFA_SMC_32(0x76)
53 #define FFA_MEM_RECLAIM FFA_SMC_32(0x77)
54 #define FFA_MEM_OP_PAUSE FFA_SMC_32(0x78)
55 #define FFA_MEM_OP_RESUME FFA_SMC_32(0x79)
56 #define FFA_MEM_FRAG_RX FFA_SMC_32(0x7A)
57 #define FFA_MEM_FRAG_TX FFA_SMC_32(0x7B)
58 #define FFA_NORMAL_WORLD_RESUME FFA_SMC_32(0x7C)
59 #define FFA_NOTIFICATION_BITMAP_CREATE FFA_SMC_32(0x7D)
60 #define FFA_NOTIFICATION_BITMAP_DESTROY FFA_SMC_32(0x7E)
61 #define FFA_NOTIFICATION_BIND FFA_SMC_32(0x7F)
62 #define FFA_NOTIFICATION_UNBIND FFA_SMC_32(0x80)
63 #define FFA_NOTIFICATION_SET FFA_SMC_32(0x81)
64 #define FFA_NOTIFICATION_GET FFA_SMC_32(0x82)
65 #define FFA_NOTIFICATION_INFO_GET FFA_SMC_32(0x83)
66 #define FFA_FN64_NOTIFICATION_INFO_GET FFA_SMC_64(0x83)
67 #define FFA_RX_ACQUIRE FFA_SMC_32(0x84)
68 #define FFA_SPM_ID_GET FFA_SMC_32(0x85)
69 #define FFA_MSG_SEND2 FFA_SMC_32(0x86)
70 #define FFA_SECONDARY_EP_REGISTER FFA_SMC_32(0x87)
71 #define FFA_FN64_SECONDARY_EP_REGISTER FFA_SMC_64(0x87)
72 #define FFA_MEM_PERM_GET FFA_SMC_32(0x88)
73 #define FFA_FN64_MEM_PERM_GET FFA_SMC_64(0x88)
74 #define FFA_MEM_PERM_SET FFA_SMC_32(0x89)
75 #define FFA_FN64_MEM_PERM_SET FFA_SMC_64(0x89)
76
77 /*
78 * For some calls it is necessary to use SMC64 to pass or return 64-bit values.
79 * For such calls FFA_FN_NATIVE(name) will choose the appropriate
80 * (native-width) function ID.
81 */
82 #ifdef CONFIG_64BIT
83 #define FFA_FN_NATIVE(name) FFA_FN64_##name
84 #else
85 #define FFA_FN_NATIVE(name) FFA_##name
86 #endif
87
88 /* FFA error codes. */
89 #define FFA_RET_SUCCESS (0)
90 #define FFA_RET_NOT_SUPPORTED (-1)
91 #define FFA_RET_INVALID_PARAMETERS (-2)
92 #define FFA_RET_NO_MEMORY (-3)
93 #define FFA_RET_BUSY (-4)
94 #define FFA_RET_INTERRUPTED (-5)
95 #define FFA_RET_DENIED (-6)
96 #define FFA_RET_RETRY (-7)
97 #define FFA_RET_ABORTED (-8)
98 #define FFA_RET_NO_DATA (-9)
99
100 /* FFA version encoding */
101 #define FFA_MAJOR_VERSION_MASK GENMASK(30, 16)
102 #define FFA_MINOR_VERSION_MASK GENMASK(15, 0)
103 #define FFA_MAJOR_VERSION(x) ((u16)(FIELD_GET(FFA_MAJOR_VERSION_MASK, (x))))
104 #define FFA_MINOR_VERSION(x) ((u16)(FIELD_GET(FFA_MINOR_VERSION_MASK, (x))))
105 #define FFA_PACK_VERSION_INFO(major, minor) \
106 (FIELD_PREP(FFA_MAJOR_VERSION_MASK, (major)) | \
107 FIELD_PREP(FFA_MINOR_VERSION_MASK, (minor)))
108 #define FFA_VERSION_1_0 FFA_PACK_VERSION_INFO(1, 0)
109 #define FFA_VERSION_1_1 FFA_PACK_VERSION_INFO(1, 1)
110
111 /**
112 * FF-A specification mentions explicitly about '4K pages'. This should
113 * not be confused with the kernel PAGE_SIZE, which is the translation
114 * granule kernel is configured and may be one among 4K, 16K and 64K.
115 */
116 #define FFA_PAGE_SIZE SZ_4K
117
118 /*
119 * Minimum buffer size/alignment encodings returned by an FFA_FEATURES
120 * query for FFA_RXTX_MAP.
121 */
122 #define FFA_FEAT_RXTX_MIN_SZ_4K 0
123 #define FFA_FEAT_RXTX_MIN_SZ_64K 1
124 #define FFA_FEAT_RXTX_MIN_SZ_16K 2
125
126 /* FFA Bus/Device/Driver related */
127 struct ffa_device {
128 u32 id;
129 u32 properties;
130 int vm_id;
131 bool mode_32bit;
132 uuid_t uuid;
133 struct device dev;
134 const struct ffa_ops *ops;
135 };
136
137 #define to_ffa_dev(d) container_of(d, struct ffa_device, dev)
138
139 struct ffa_device_id {
140 uuid_t uuid;
141 };
142
143 struct ffa_driver {
144 const char *name;
145 int (*probe)(struct ffa_device *sdev);
146 void (*remove)(struct ffa_device *sdev);
147 const struct ffa_device_id *id_table;
148
149 struct device_driver driver;
150 };
151
152 #define to_ffa_driver(d) container_of_const(d, struct ffa_driver, driver)
153
154 static inline void ffa_dev_set_drvdata(struct ffa_device *fdev, void *data)
155 {
156 dev_set_drvdata(&fdev->dev, data);
157 }
158
159 static inline void *ffa_dev_get_drvdata(struct ffa_device *fdev)
160 {
161 return dev_get_drvdata(&fdev->dev);
162 }
163
164 #if IS_REACHABLE(CONFIG_ARM_FFA_TRANSPORT)
165 struct ffa_device *ffa_device_register(const uuid_t *uuid, int vm_id,
166 const struct ffa_ops *ops);
167 void ffa_device_unregister(struct ffa_device *ffa_dev);
168 int ffa_driver_register(struct ffa_driver *driver, struct module *owner,
169 const char *mod_name);
170 void ffa_driver_unregister(struct ffa_driver *driver);
171 bool ffa_device_is_valid(struct ffa_device *ffa_dev);
172
173 #else
174 static inline
175 struct ffa_device *ffa_device_register(const uuid_t *uuid, int vm_id,
176 const struct ffa_ops *ops)
177 {
178 return NULL;
179 }
180
181 static inline void ffa_device_unregister(struct ffa_device *dev) {}
182
183 static inline int
184 ffa_driver_register(struct ffa_driver *driver, struct module *owner,
185 const char *mod_name)
186 {
187 return -EINVAL;
188 }
189
190 static inline void ffa_driver_unregister(struct ffa_driver *driver) {}
191
192 static inline
193 bool ffa_device_is_valid(struct ffa_device *ffa_dev) { return false; }
194
195 #endif /* CONFIG_ARM_FFA_TRANSPORT */
196
197 #define ffa_register(driver) \
198 ffa_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
199 #define ffa_unregister(driver) \
200 ffa_driver_unregister(driver)
201
202 /**
203 * module_ffa_driver() - Helper macro for registering a psa_ffa driver
204 * @__ffa_driver: ffa_driver structure
205 *
206 * Helper macro for psa_ffa drivers to set up proper module init / exit
207 * functions. Replaces module_init() and module_exit() and keeps people from
208 * printing pointless things to the kernel log when their driver is loaded.
209 */
210 #define module_ffa_driver(__ffa_driver) \
211 module_driver(__ffa_driver, ffa_register, ffa_unregister)
212
213 extern const struct bus_type ffa_bus_type;
214
215 /* The FF-A 1.0 partition structure lacks the uuid[4] */
216 #define FFA_1_0_PARTITON_INFO_SZ (8)
217
218 /* FFA transport related */
219 struct ffa_partition_info {
220 u16 id;
221 u16 exec_ctxt;
222 /* partition supports receipt of direct requests */
223 #define FFA_PARTITION_DIRECT_RECV BIT(0)
224 /* partition can send direct requests. */
225 #define FFA_PARTITION_DIRECT_SEND BIT(1)
226 /* partition can send and receive indirect messages. */
227 #define FFA_PARTITION_INDIRECT_MSG BIT(2)
228 /* partition can receive notifications */
229 #define FFA_PARTITION_NOTIFICATION_RECV BIT(3)
230 /* partition runs in the AArch64 execution state. */
231 #define FFA_PARTITION_AARCH64_EXEC BIT(8)
232 u32 properties;
233 u32 uuid[4];
234 };
235
236 static inline
237 bool ffa_partition_check_property(struct ffa_device *dev, u32 property)
238 {
239 return dev->properties & property;
240 }
241
242 #define ffa_partition_supports_notify_recv(dev) \
243 ffa_partition_check_property(dev, FFA_PARTITION_NOTIFICATION_RECV)
244
245 #define ffa_partition_supports_indirect_msg(dev) \
246 ffa_partition_check_property(dev, FFA_PARTITION_INDIRECT_MSG)
247
248 #define ffa_partition_supports_direct_recv(dev) \
249 ffa_partition_check_property(dev, FFA_PARTITION_DIRECT_RECV)
250
251 /* For use with FFA_MSG_SEND_DIRECT_{REQ,RESP} which pass data via registers */
252 struct ffa_send_direct_data {
253 unsigned long data0; /* w3/x3 */
254 unsigned long data1; /* w4/x4 */
255 unsigned long data2; /* w5/x5 */
256 unsigned long data3; /* w6/x6 */
257 unsigned long data4; /* w7/x7 */
258 };
259
260 struct ffa_indirect_msg_hdr {
261 u32 flags;
262 u32 res0;
263 u32 offset;
264 u32 send_recv_id;
265 u32 size;
266 };
267
268 struct ffa_mem_region_addr_range {
269 /* The base IPA of the constituent memory region, aligned to 4 kiB */
270 u64 address;
271 /* The number of 4 kiB pages in the constituent memory region. */
272 u32 pg_cnt;
273 u32 reserved;
274 };
275
276 struct ffa_composite_mem_region {
277 /*
278 * The total number of 4 kiB pages included in this memory region. This
279 * must be equal to the sum of page counts specified in each
280 * `struct ffa_mem_region_addr_range`.
281 */
282 u32 total_pg_cnt;
283 /* The number of constituents included in this memory region range */
284 u32 addr_range_cnt;
285 u64 reserved;
286 /** An array of `addr_range_cnt` memory region constituents. */
287 struct ffa_mem_region_addr_range constituents[];
288 };
289
290 struct ffa_mem_region_attributes {
291 /* The ID of the VM to which the memory is being given or shared. */
292 u16 receiver;
293 /*
294 * The permissions with which the memory region should be mapped in the
295 * receiver's page table.
296 */
297 #define FFA_MEM_EXEC BIT(3)
298 #define FFA_MEM_NO_EXEC BIT(2)
299 #define FFA_MEM_RW BIT(1)
300 #define FFA_MEM_RO BIT(0)
301 u8 attrs;
302 /*
303 * Flags used during FFA_MEM_RETRIEVE_REQ and FFA_MEM_RETRIEVE_RESP
304 * for memory regions with multiple borrowers.
305 */
306 #define FFA_MEM_RETRIEVE_SELF_BORROWER BIT(0)
307 u8 flag;
308 /*
309 * Offset in bytes from the start of the outer `ffa_memory_region` to
310 * an `struct ffa_mem_region_addr_range`.
311 */
312 u32 composite_off;
313 u64 reserved;
314 };
315
316 struct ffa_mem_region {
317 /* The ID of the VM/owner which originally sent the memory region */
318 u16 sender_id;
319 #define FFA_MEM_NORMAL BIT(5)
320 #define FFA_MEM_DEVICE BIT(4)
321
322 #define FFA_MEM_WRITE_BACK (3 << 2)
323 #define FFA_MEM_NON_CACHEABLE (1 << 2)
324
325 #define FFA_DEV_nGnRnE (0 << 2)
326 #define FFA_DEV_nGnRE (1 << 2)
327 #define FFA_DEV_nGRE (2 << 2)
328 #define FFA_DEV_GRE (3 << 2)
329
330 #define FFA_MEM_NON_SHAREABLE (0)
331 #define FFA_MEM_OUTER_SHAREABLE (2)
332 #define FFA_MEM_INNER_SHAREABLE (3)
333 /* Memory region attributes, upper byte MBZ pre v1.1 */
334 u16 attributes;
335 /*
336 * Clear memory region contents after unmapping it from the sender and
337 * before mapping it for any receiver.
338 */
339 #define FFA_MEM_CLEAR BIT(0)
340 /*
341 * Whether the hypervisor may time slice the memory sharing or retrieval
342 * operation.
343 */
344 #define FFA_TIME_SLICE_ENABLE BIT(1)
345
346 #define FFA_MEM_RETRIEVE_TYPE_IN_RESP (0 << 3)
347 #define FFA_MEM_RETRIEVE_TYPE_SHARE (1 << 3)
348 #define FFA_MEM_RETRIEVE_TYPE_LEND (2 << 3)
349 #define FFA_MEM_RETRIEVE_TYPE_DONATE (3 << 3)
350
351 #define FFA_MEM_RETRIEVE_ADDR_ALIGN_HINT BIT(9)
352 #define FFA_MEM_RETRIEVE_ADDR_ALIGN(x) ((x) << 5)
353 /* Flags to control behaviour of the transaction. */
354 u32 flags;
355 #define HANDLE_LOW_MASK GENMASK_ULL(31, 0)
356 #define HANDLE_HIGH_MASK GENMASK_ULL(63, 32)
357 #define HANDLE_LOW(x) ((u32)(FIELD_GET(HANDLE_LOW_MASK, (x))))
358 #define HANDLE_HIGH(x) ((u32)(FIELD_GET(HANDLE_HIGH_MASK, (x))))
359
360 #define PACK_HANDLE(l, h) \
361 (FIELD_PREP(HANDLE_LOW_MASK, (l)) | FIELD_PREP(HANDLE_HIGH_MASK, (h)))
362 /*
363 * A globally-unique ID assigned by the hypervisor for a region
364 * of memory being sent between VMs.
365 */
366 u64 handle;
367 /*
368 * An implementation defined value associated with the receiver and the
369 * memory region.
370 */
371 u64 tag;
372 /* Size of each endpoint memory access descriptor, MBZ pre v1.1 */
373 u32 ep_mem_size;
374 /*
375 * The number of `ffa_mem_region_attributes` entries included in this
376 * transaction.
377 */
378 u32 ep_count;
379 /*
380 * 16-byte aligned offset from the base address of this descriptor
381 * to the first element of the endpoint memory access descriptor array
382 * Valid only from v1.1
383 */
384 u32 ep_mem_offset;
385 /* MBZ, valid only from v1.1 */
386 u32 reserved[3];
387 };
388
389 #define CONSTITUENTS_OFFSET(x) \
390 (offsetof(struct ffa_composite_mem_region, constituents[x]))
391
392 static inline u32
393 ffa_mem_desc_offset(struct ffa_mem_region *buf, int count, u32 ffa_version)
394 {
395 u32 offset = count * sizeof(struct ffa_mem_region_attributes);
396 /*
397 * Earlier to v1.1, the endpoint memory descriptor array started at
398 * offset 32(i.e. offset of ep_mem_offset in the current structure)
399 */
400 if (ffa_version <= FFA_VERSION_1_0)
401 offset += offsetof(struct ffa_mem_region, ep_mem_offset);
402 else
403 offset += sizeof(struct ffa_mem_region);
404
405 return offset;
406 }
407
408 struct ffa_mem_ops_args {
409 bool use_txbuf;
410 u32 nattrs;
411 u32 flags;
412 u64 tag;
413 u64 g_handle;
414 struct scatterlist *sg;
415 struct ffa_mem_region_attributes *attrs;
416 };
417
418 struct ffa_info_ops {
419 u32 (*api_version_get)(void);
420 int (*partition_info_get)(const char *uuid_str,
421 struct ffa_partition_info *buffer);
422 };
423
424 struct ffa_msg_ops {
425 void (*mode_32bit_set)(struct ffa_device *dev);
426 int (*sync_send_receive)(struct ffa_device *dev,
427 struct ffa_send_direct_data *data);
428 int (*indirect_send)(struct ffa_device *dev, void *buf, size_t sz);
429 };
430
431 struct ffa_mem_ops {
432 int (*memory_reclaim)(u64 g_handle, u32 flags);
433 int (*memory_share)(struct ffa_mem_ops_args *args);
434 int (*memory_lend)(struct ffa_mem_ops_args *args);
435 };
436
437 struct ffa_cpu_ops {
438 int (*run)(struct ffa_device *dev, u16 vcpu);
439 };
440
441 typedef void (*ffa_sched_recv_cb)(u16 vcpu, bool is_per_vcpu, void *cb_data);
442 typedef void (*ffa_notifier_cb)(int notify_id, void *cb_data);
443
444 struct ffa_notifier_ops {
445 int (*sched_recv_cb_register)(struct ffa_device *dev,
446 ffa_sched_recv_cb cb, void *cb_data);
447 int (*sched_recv_cb_unregister)(struct ffa_device *dev);
448 int (*notify_request)(struct ffa_device *dev, bool per_vcpu,
449 ffa_notifier_cb cb, void *cb_data, int notify_id);
450 int (*notify_relinquish)(struct ffa_device *dev, int notify_id);
451 int (*notify_send)(struct ffa_device *dev, int notify_id, bool per_vcpu,
452 u16 vcpu);
453 };
454
455 struct ffa_ops {
456 const struct ffa_info_ops *info_ops;
457 const struct ffa_msg_ops *msg_ops;
458 const struct ffa_mem_ops *mem_ops;
459 const struct ffa_cpu_ops *cpu_ops;
460 const struct ffa_notifier_ops *notifier_ops;
461 };
462
463 #endif /* _LINUX_ARM_FFA_H */
464
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.