arm_ffa.h 11 KB

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