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/device.h>
10 #include <linux/module.h>
11 #include <linux/types.h>
12 #include <linux/uuid.h>
13
14 #define FFA_SMC(calling_convention, func_num) \
15 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, (calling_convention), \
16 ARM_SMCCC_OWNER_STANDARD, (func_num))
17
18 #define FFA_SMC_32(func_num) FFA_SMC(ARM_SMCCC_SMC_32, (func_num))
19 #define FFA_SMC_64(func_num) FFA_SMC(ARM_SMCCC_SMC_64, (func_num))
20
21 #define FFA_ERROR FFA_SMC_32(0x60)
22 #define FFA_SUCCESS FFA_SMC_32(0x61)
23 #define FFA_INTERRUPT FFA_SMC_32(0x62)
24 #define FFA_VERSION FFA_SMC_32(0x63)
25 #define FFA_FEATURES FFA_SMC_32(0x64)
26 #define FFA_RX_RELEASE FFA_SMC_32(0x65)
27 #define FFA_RXTX_MAP FFA_SMC_32(0x66)
28 #define FFA_FN64_RXTX_MAP FFA_SMC_64(0x66)
29 #define FFA_RXTX_UNMAP FFA_SMC_32(0x67)
30 #define FFA_PARTITION_INFO_GET FFA_SMC_32(0x68)
31 #define FFA_ID_GET FFA_SMC_32(0x69)
32 #define FFA_MSG_POLL FFA_SMC_32(0x6A)
33 #define FFA_MSG_WAIT FFA_SMC_32(0x6B)
34 #define FFA_YIELD FFA_SMC_32(0x6C)
35 #define FFA_RUN FFA_SMC_32(0x6D)
36 #define FFA_MSG_SEND FFA_SMC_32(0x6E)
37 #define FFA_MSG_SEND_DIRECT_REQ FFA_SMC_32(0x6F)
38 #define FFA_FN64_MSG_SEND_DIRECT_REQ FFA_SMC_64(0x6F)
39 #define FFA_MSG_SEND_DIRECT_RESP FFA_SMC_32(0x70)
40 #define FFA_FN64_MSG_SEND_DIRECT_RESP FFA_SMC_64(0x70)
41 #define FFA_MEM_DONATE FFA_SMC_32(0x71)
42 #define FFA_FN64_MEM_DONATE FFA_SMC_64(0x71)
43 #define FFA_MEM_LEND FFA_SMC_32(0x72)
44 #define FFA_FN64_MEM_LEND FFA_SMC_64(0x72)
45 #define FFA_MEM_SHARE FFA_SMC_32(0x73)
46 #define FFA_FN64_MEM_SHARE FFA_SMC_64(0x73)
47 #define FFA_MEM_RETRIEVE_REQ FFA_SMC_32(0x74)
48 #define FFA_FN64_MEM_RETRIEVE_REQ FFA_SMC_64(0x74)
49 #define FFA_MEM_RETRIEVE_RESP FFA_SMC_32(0x75)
50 #define FFA_MEM_RELINQUISH FFA_SMC_32(0x76)
51 #define FFA_MEM_RECLAIM FFA_SMC_32(0x77)
52 #define FFA_MEM_OP_PAUSE FFA_SMC_32(0x78)
53 #define FFA_MEM_OP_RESUME FFA_SMC_32(0x79)
54 #define FFA_MEM_FRAG_RX FFA_SMC_32(0x7A)
55 #define FFA_MEM_FRAG_TX FFA_SMC_32(0x7B)
56 #define FFA_NORMAL_WORLD_RESUME FFA_SMC_32(0x7C)
57
58 /*
59 * For some calls it is necessary to use SMC64 to pass or return 64-bit values.
60 * For such calls FFA_FN_NATIVE(name) will choose the appropriate
61 * (native-width) function ID.
62 */
63 #ifdef CONFIG_64BIT
64 #define FFA_FN_NATIVE(name) FFA_FN64_##name
65 #else
66 #define FFA_FN_NATIVE(name) FFA_##name
67 #endif
68
69 /* FFA error codes. */
70 #define FFA_RET_SUCCESS (0)
71 #define FFA_RET_NOT_SUPPORTED (-1)
72 #define FFA_RET_INVALID_PARAMETERS (-2)
73 #define FFA_RET_NO_MEMORY (-3)
74 #define FFA_RET_BUSY (-4)
75 #define FFA_RET_INTERRUPTED (-5)
76 #define FFA_RET_DENIED (-6)
77 #define FFA_RET_RETRY (-7)
78 #define FFA_RET_ABORTED (-8)
79
80 /* FFA version encoding */
81 #define FFA_MAJOR_VERSION_MASK GENMASK(30, 16)
82 #define FFA_MINOR_VERSION_MASK GENMASK(15, 0)
83 #define FFA_MAJOR_VERSION(x) ((u16)(FIELD_GET(FFA_MAJOR_VERSION_MASK, (x))))
84 #define FFA_MINOR_VERSION(x) ((u16)(FIELD_GET(FFA_MINOR_VERSION_MASK, (x))))
85 #define FFA_PACK_VERSION_INFO(major, minor) \
86 (FIELD_PREP(FFA_MAJOR_VERSION_MASK, (major)) | \
87 FIELD_PREP(FFA_MINOR_VERSION_MASK, (minor)))
88 #define FFA_VERSION_1_0 FFA_PACK_VERSION_INFO(1, 0)
89
90 /**
91 * FF-A specification mentions explicitly about '4K pages'. This should
92 * not be confused with the kernel PAGE_SIZE, which is the translation
93 * granule kernel is configured and may be one among 4K, 16K and 64K.
94 */
95 #define FFA_PAGE_SIZE SZ_4K
96
97 /*
98 * Minimum buffer size/alignment encodings returned by an FFA_FEATURES
99 * query for FFA_RXTX_MAP.
100 */
101 #define FFA_FEAT_RXTX_MIN_SZ_4K 0
102 #define FFA_FEAT_RXTX_MIN_SZ_64K 1
103 #define FFA_FEAT_RXTX_MIN_SZ_16K 2
104
105 /* FFA Bus/Device/Driver related */
106 struct ffa_device {
107 u32 id;
108 int vm_id;
109 bool mode_32bit;
110 uuid_t uuid;
111 struct device dev;
112 };
113
114 #define to_ffa_dev(d) container_of(d, struct ffa_device, dev)
115
116 struct ffa_device_id {
117 uuid_t uuid;
118 };
119
120 struct ffa_driver {
121 const char *name;
122 int (*probe)(struct ffa_device *sdev);
123 void (*remove)(struct ffa_device *sdev);
124 const struct ffa_device_id *id_table;
125
126 struct device_driver driver;
127 };
128
129 #define to_ffa_driver(d) container_of(d, struct ffa_driver, driver)
130
ffa_dev_set_drvdata(struct ffa_device * fdev,void * data)131 static inline void ffa_dev_set_drvdata(struct ffa_device *fdev, void *data)
132 {
133 fdev->dev.driver_data = data;
134 }
135
136 #if IS_REACHABLE(CONFIG_ARM_FFA_TRANSPORT)
137 struct ffa_device *ffa_device_register(const uuid_t *uuid, int vm_id);
138 void ffa_device_unregister(struct ffa_device *ffa_dev);
139 int ffa_driver_register(struct ffa_driver *driver, struct module *owner,
140 const char *mod_name);
141 void ffa_driver_unregister(struct ffa_driver *driver);
142 bool ffa_device_is_valid(struct ffa_device *ffa_dev);
143 const struct ffa_dev_ops *ffa_dev_ops_get(struct ffa_device *dev);
144
145 #else
146 static inline
ffa_device_register(const uuid_t * uuid,int vm_id)147 struct ffa_device *ffa_device_register(const uuid_t *uuid, int vm_id)
148 {
149 return NULL;
150 }
151
ffa_device_unregister(struct ffa_device * dev)152 static inline void ffa_device_unregister(struct ffa_device *dev) {}
153
154 static inline int
ffa_driver_register(struct ffa_driver * driver,struct module * owner,const char * mod_name)155 ffa_driver_register(struct ffa_driver *driver, struct module *owner,
156 const char *mod_name)
157 {
158 return -EINVAL;
159 }
160
ffa_driver_unregister(struct ffa_driver * driver)161 static inline void ffa_driver_unregister(struct ffa_driver *driver) {}
162
163 static inline
ffa_device_is_valid(struct ffa_device * ffa_dev)164 bool ffa_device_is_valid(struct ffa_device *ffa_dev) { return false; }
165
166 static inline
ffa_dev_ops_get(struct ffa_device * dev)167 const struct ffa_dev_ops *ffa_dev_ops_get(struct ffa_device *dev)
168 {
169 return NULL;
170 }
171 #endif /* CONFIG_ARM_FFA_TRANSPORT */
172
173 #define ffa_register(driver) \
174 ffa_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
175 #define ffa_unregister(driver) \
176 ffa_driver_unregister(driver)
177
178 /**
179 * module_ffa_driver() - Helper macro for registering a psa_ffa driver
180 * @__ffa_driver: ffa_driver structure
181 *
182 * Helper macro for psa_ffa drivers to set up proper module init / exit
183 * functions. Replaces module_init() and module_exit() and keeps people from
184 * printing pointless things to the kernel log when their driver is loaded.
185 */
186 #define module_ffa_driver(__ffa_driver) \
187 module_driver(__ffa_driver, ffa_register, ffa_unregister)
188
189 /* FFA transport related */
190 struct ffa_partition_info {
191 u16 id;
192 u16 exec_ctxt;
193 /* partition supports receipt of direct requests */
194 #define FFA_PARTITION_DIRECT_RECV BIT(0)
195 /* partition can send direct requests. */
196 #define FFA_PARTITION_DIRECT_SEND BIT(1)
197 /* partition can send and receive indirect messages. */
198 #define FFA_PARTITION_INDIRECT_MSG BIT(2)
199 u32 properties;
200 };
201
202 /* For use with FFA_MSG_SEND_DIRECT_{REQ,RESP} which pass data via registers */
203 struct ffa_send_direct_data {
204 unsigned long data0; /* w3/x3 */
205 unsigned long data1; /* w4/x4 */
206 unsigned long data2; /* w5/x5 */
207 unsigned long data3; /* w6/x6 */
208 unsigned long data4; /* w7/x7 */
209 };
210
211 struct ffa_mem_region_addr_range {
212 /* The base IPA of the constituent memory region, aligned to 4 kiB */
213 u64 address;
214 /* The number of 4 kiB pages in the constituent memory region. */
215 u32 pg_cnt;
216 u32 reserved;
217 };
218
219 struct ffa_composite_mem_region {
220 /*
221 * The total number of 4 kiB pages included in this memory region. This
222 * must be equal to the sum of page counts specified in each
223 * `struct ffa_mem_region_addr_range`.
224 */
225 u32 total_pg_cnt;
226 /* The number of constituents included in this memory region range */
227 u32 addr_range_cnt;
228 u64 reserved;
229 /** An array of `addr_range_cnt` memory region constituents. */
230 struct ffa_mem_region_addr_range constituents[];
231 };
232
233 struct ffa_mem_region_attributes {
234 /* The ID of the VM to which the memory is being given or shared. */
235 u16 receiver;
236 /*
237 * The permissions with which the memory region should be mapped in the
238 * receiver's page table.
239 */
240 #define FFA_MEM_EXEC BIT(3)
241 #define FFA_MEM_NO_EXEC BIT(2)
242 #define FFA_MEM_RW BIT(1)
243 #define FFA_MEM_RO BIT(0)
244 u8 attrs;
245 /*
246 * Flags used during FFA_MEM_RETRIEVE_REQ and FFA_MEM_RETRIEVE_RESP
247 * for memory regions with multiple borrowers.
248 */
249 #define FFA_MEM_RETRIEVE_SELF_BORROWER BIT(0)
250 u8 flag;
251 /*
252 * Offset in bytes from the start of the outer `ffa_memory_region` to
253 * an `struct ffa_mem_region_addr_range`.
254 */
255 u32 composite_off;
256 u64 reserved;
257 };
258
259 struct ffa_mem_region {
260 /* The ID of the VM/owner which originally sent the memory region */
261 u16 sender_id;
262 #define FFA_MEM_NORMAL BIT(5)
263 #define FFA_MEM_DEVICE BIT(4)
264
265 #define FFA_MEM_WRITE_BACK (3 << 2)
266 #define FFA_MEM_NON_CACHEABLE (1 << 2)
267
268 #define FFA_DEV_nGnRnE (0 << 2)
269 #define FFA_DEV_nGnRE (1 << 2)
270 #define FFA_DEV_nGRE (2 << 2)
271 #define FFA_DEV_GRE (3 << 2)
272
273 #define FFA_MEM_NON_SHAREABLE (0)
274 #define FFA_MEM_OUTER_SHAREABLE (2)
275 #define FFA_MEM_INNER_SHAREABLE (3)
276 u8 attributes;
277 u8 reserved_0;
278 /*
279 * Clear memory region contents after unmapping it from the sender and
280 * before mapping it for any receiver.
281 */
282 #define FFA_MEM_CLEAR BIT(0)
283 /*
284 * Whether the hypervisor may time slice the memory sharing or retrieval
285 * operation.
286 */
287 #define FFA_TIME_SLICE_ENABLE BIT(1)
288
289 #define FFA_MEM_RETRIEVE_TYPE_IN_RESP (0 << 3)
290 #define FFA_MEM_RETRIEVE_TYPE_SHARE (1 << 3)
291 #define FFA_MEM_RETRIEVE_TYPE_LEND (2 << 3)
292 #define FFA_MEM_RETRIEVE_TYPE_DONATE (3 << 3)
293
294 #define FFA_MEM_RETRIEVE_ADDR_ALIGN_HINT BIT(9)
295 #define FFA_MEM_RETRIEVE_ADDR_ALIGN(x) ((x) << 5)
296 /* Flags to control behaviour of the transaction. */
297 u32 flags;
298 #define HANDLE_LOW_MASK GENMASK_ULL(31, 0)
299 #define HANDLE_HIGH_MASK GENMASK_ULL(63, 32)
300 #define HANDLE_LOW(x) ((u32)(FIELD_GET(HANDLE_LOW_MASK, (x))))
301 #define HANDLE_HIGH(x) ((u32)(FIELD_GET(HANDLE_HIGH_MASK, (x))))
302
303 #define PACK_HANDLE(l, h) \
304 (FIELD_PREP(HANDLE_LOW_MASK, (l)) | FIELD_PREP(HANDLE_HIGH_MASK, (h)))
305 /*
306 * A globally-unique ID assigned by the hypervisor for a region
307 * of memory being sent between VMs.
308 */
309 u64 handle;
310 /*
311 * An implementation defined value associated with the receiver and the
312 * memory region.
313 */
314 u64 tag;
315 u32 reserved_1;
316 /*
317 * The number of `ffa_mem_region_attributes` entries included in this
318 * transaction.
319 */
320 u32 ep_count;
321 /*
322 * An array of endpoint memory access descriptors.
323 * Each one specifies a memory region offset, an endpoint and the
324 * attributes with which this memory region should be mapped in that
325 * endpoint's page table.
326 */
327 struct ffa_mem_region_attributes ep_mem_access[];
328 };
329
330 #define COMPOSITE_OFFSET(x) \
331 (offsetof(struct ffa_mem_region, ep_mem_access[x]))
332 #define CONSTITUENTS_OFFSET(x) \
333 (offsetof(struct ffa_composite_mem_region, constituents[x]))
334 #define COMPOSITE_CONSTITUENTS_OFFSET(x, y) \
335 (COMPOSITE_OFFSET(x) + CONSTITUENTS_OFFSET(y))
336
337 struct ffa_mem_ops_args {
338 bool use_txbuf;
339 u32 nattrs;
340 u32 flags;
341 u64 tag;
342 u64 g_handle;
343 struct scatterlist *sg;
344 struct ffa_mem_region_attributes *attrs;
345 };
346
347 struct ffa_dev_ops {
348 u32 (*api_version_get)(void);
349 int (*partition_info_get)(const char *uuid_str,
350 struct ffa_partition_info *buffer);
351 void (*mode_32bit_set)(struct ffa_device *dev);
352 int (*sync_send_receive)(struct ffa_device *dev,
353 struct ffa_send_direct_data *data);
354 int (*memory_reclaim)(u64 g_handle, u32 flags);
355 int (*memory_share)(struct ffa_device *dev,
356 struct ffa_mem_ops_args *args);
357 int (*memory_lend)(struct ffa_device *dev,
358 struct ffa_mem_ops_args *args);
359 };
360
361 #endif /* _LINUX_ARM_FFA_H */
362