include/linux/arm_ffa.h

   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 /* FFA Bus/Device/Driver related */
  98 struct ffa_device {
  99         u32 id;
 100         int vm_id;
 101         bool mode_32bit;
 102         uuid_t uuid;
 103         struct device dev;
 104         const struct ffa_ops *ops;
 105 };
 106
 107 #define to_ffa_dev(d) container_of(d, struct ffa_device, dev)
 108
 109 struct ffa_device_id {
 110         uuid_t uuid;
 111 };
 112
 113 struct ffa_driver {
 114         const char *name;
 115         int (*probe)(struct ffa_device *sdev);
 116         void (*remove)(struct ffa_device *sdev);
 117         const struct ffa_device_id *id_table;
 118
 119         struct device_driver driver;
 120 };
 121
 122 #define to_ffa_driver(d) container_of(d, struct ffa_driver, driver)
 123
 124 static inline void ffa_dev_set_drvdata(struct ffa_device *fdev, void *data)
 125 {
 126         dev_set_drvdata(&fdev->dev, data);
 127 }
 128
 129 static inline void *ffa_dev_get_drvdata(struct ffa_device *fdev)
 130 {
 131         return dev_get_drvdata(&fdev->dev);
 132 }
 133
 134 #if IS_REACHABLE(CONFIG_ARM_FFA_TRANSPORT)
 135 struct ffa_device *ffa_device_register(const uuid_t *uuid, int vm_id,
 136                                        const struct ffa_ops *ops);
 137 void ffa_device_unregister(struct ffa_device *ffa_dev);
 138 int ffa_driver_register(struct ffa_driver *driver, struct module *owner,
 139                         const char *mod_name);
 140 void ffa_driver_unregister(struct ffa_driver *driver);
 141 bool ffa_device_is_valid(struct ffa_device *ffa_dev);
 142
 143 #else
 144 static inline
 145 struct ffa_device *ffa_device_register(const uuid_t *uuid, int vm_id,
 146                                        const struct ffa_ops *ops)
 147 {
 148         return NULL;
 149 }
 150
 151 static inline void ffa_device_unregister(struct ffa_device *dev) {}
 152
 153 static inline int
 154 ffa_driver_register(struct ffa_driver *driver, struct module *owner,
 155                     const char *mod_name)
 156 {
 157         return -EINVAL;
 158 }
 159
 160 static inline void ffa_driver_unregister(struct ffa_driver *driver) {}
 161
 162 static inline
 163 bool ffa_device_is_valid(struct ffa_device *ffa_dev) { return false; }
 164
 165 #endif /* CONFIG_ARM_FFA_TRANSPORT */
 166
 167 #define ffa_register(driver) \
 168         ffa_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
 169 #define ffa_unregister(driver) \
 170         ffa_driver_unregister(driver)
 171
 172 /**
 173  * module_ffa_driver() - Helper macro for registering a psa_ffa driver
 174  * @__ffa_driver: ffa_driver structure
 175  *
 176  * Helper macro for psa_ffa drivers to set up proper module init / exit
 177  * functions.  Replaces module_init() and module_exit() and keeps people from
 178  * printing pointless things to the kernel log when their driver is loaded.
 179  */
 180 #define module_ffa_driver(__ffa_driver) \
 181         module_driver(__ffa_driver, ffa_register, ffa_unregister)
 182
 183 /* FFA transport related */
 184 struct ffa_partition_info {
 185         u16 id;
 186         u16 exec_ctxt;
 187 /* partition supports receipt of direct requests */
 188 #define FFA_PARTITION_DIRECT_RECV       BIT(0)
 189 /* partition can send direct requests. */
 190 #define FFA_PARTITION_DIRECT_SEND       BIT(1)
 191 /* partition can send and receive indirect messages. */
 192 #define FFA_PARTITION_INDIRECT_MSG      BIT(2)
 193 /* partition runs in the AArch64 execution state. */
 194 #define FFA_PARTITION_AARCH64_EXEC      BIT(8)
 195         u32 properties;
 196         u32 uuid[4];
 197 };
 198
 199 /* For use with FFA_MSG_SEND_DIRECT_{REQ,RESP} which pass data via registers */
 200 struct ffa_send_direct_data {
 201         unsigned long data0; /* w3/x3 */
 202         unsigned long data1; /* w4/x4 */
 203         unsigned long data2; /* w5/x5 */
 204         unsigned long data3; /* w6/x6 */
 205         unsigned long data4; /* w7/x7 */
 206 };
 207
 208 struct ffa_mem_region_addr_range {
 209         /* The base IPA of the constituent memory region, aligned to 4 kiB */
 210         u64 address;
 211         /* The number of 4 kiB pages in the constituent memory region. */
 212         u32 pg_cnt;
 213         u32 reserved;
 214 };
 215
 216 struct ffa_composite_mem_region {
 217         /*
 218          * The total number of 4 kiB pages included in this memory region. This
 219          * must be equal to the sum of page counts specified in each
 220          * `struct ffa_mem_region_addr_range`.
 221          */
 222         u32 total_pg_cnt;
 223         /* The number of constituents included in this memory region range */
 224         u32 addr_range_cnt;
 225         u64 reserved;
 226         /** An array of `addr_range_cnt` memory region constituents. */
 227         struct ffa_mem_region_addr_range constituents[];
 228 };
 229
 230 struct ffa_mem_region_attributes {
 231         /* The ID of the VM to which the memory is being given or shared. */
 232         u16 receiver;
 233         /*
 234          * The permissions with which the memory region should be mapped in the
 235          * receiver's page table.
 236          */
 237 #define FFA_MEM_EXEC            BIT(3)
 238 #define FFA_MEM_NO_EXEC         BIT(2)
 239 #define FFA_MEM_RW              BIT(1)
 240 #define FFA_MEM_RO              BIT(0)
 241         u8 attrs;
 242         /*
 243          * Flags used during FFA_MEM_RETRIEVE_REQ and FFA_MEM_RETRIEVE_RESP
 244          * for memory regions with multiple borrowers.
 245          */
 246 #define FFA_MEM_RETRIEVE_SELF_BORROWER  BIT(0)
 247         u8 flag;
 248         /*
 249          * Offset in bytes from the start of the outer `ffa_memory_region` to
 250          * an `struct ffa_mem_region_addr_range`.
 251          */
 252         u32 composite_off;
 253         u64 reserved;
 254 };
 255
 256 struct ffa_mem_region {
 257         /* The ID of the VM/owner which originally sent the memory region */
 258         u16 sender_id;
 259 #define FFA_MEM_NORMAL          BIT(5)
 260 #define FFA_MEM_DEVICE          BIT(4)
 261
 262 #define FFA_MEM_WRITE_BACK      (3 << 2)
 263 #define FFA_MEM_NON_CACHEABLE   (1 << 2)
 264
 265 #define FFA_DEV_nGnRnE          (0 << 2)
 266 #define FFA_DEV_nGnRE           (1 << 2)
 267 #define FFA_DEV_nGRE            (2 << 2)
 268 #define FFA_DEV_GRE             (3 << 2)
 269
 270 #define FFA_MEM_NON_SHAREABLE   (0)
 271 #define FFA_MEM_OUTER_SHAREABLE (2)
 272 #define FFA_MEM_INNER_SHAREABLE (3)
 273         u8 attributes;
 274         u8 reserved_0;
 275 /*
 276  * Clear memory region contents after unmapping it from the sender and
 277  * before mapping it for any receiver.
 278  */
 279 #define FFA_MEM_CLEAR                   BIT(0)
 280 /*
 281  * Whether the hypervisor may time slice the memory sharing or retrieval
 282  * operation.
 283  */
 284 #define FFA_TIME_SLICE_ENABLE           BIT(1)
 285
 286 #define FFA_MEM_RETRIEVE_TYPE_IN_RESP   (0 << 3)
 287 #define FFA_MEM_RETRIEVE_TYPE_SHARE     (1 << 3)
 288 #define FFA_MEM_RETRIEVE_TYPE_LEND      (2 << 3)
 289 #define FFA_MEM_RETRIEVE_TYPE_DONATE    (3 << 3)
 290
 291 #define FFA_MEM_RETRIEVE_ADDR_ALIGN_HINT        BIT(9)
 292 #define FFA_MEM_RETRIEVE_ADDR_ALIGN(x)          ((x) << 5)
 293         /* Flags to control behaviour of the transaction. */
 294         u32 flags;
 295 #define HANDLE_LOW_MASK         GENMASK_ULL(31, 0)
 296 #define HANDLE_HIGH_MASK        GENMASK_ULL(63, 32)
 297 #define HANDLE_LOW(x)           ((u32)(FIELD_GET(HANDLE_LOW_MASK, (x))))
 298 #define HANDLE_HIGH(x)          ((u32)(FIELD_GET(HANDLE_HIGH_MASK, (x))))
 299
 300 #define PACK_HANDLE(l, h)               \
 301         (FIELD_PREP(HANDLE_LOW_MASK, (l)) | FIELD_PREP(HANDLE_HIGH_MASK, (h)))
 302         /*
 303          * A globally-unique ID assigned by the hypervisor for a region
 304          * of memory being sent between VMs.
 305          */
 306         u64 handle;
 307         /*
 308          * An implementation defined value associated with the receiver and the
 309          * memory region.
 310          */
 311         u64 tag;
 312         u32 reserved_1;
 313         /*
 314          * The number of `ffa_mem_region_attributes` entries included in this
 315          * transaction.
 316          */
 317         u32 ep_count;
 318         /*
 319          * An array of endpoint memory access descriptors.
 320          * Each one specifies a memory region offset, an endpoint and the
 321          * attributes with which this memory region should be mapped in that
 322          * endpoint's page table.
 323          */
 324         struct ffa_mem_region_attributes ep_mem_access[];
 325 };
 326
 327 #define COMPOSITE_OFFSET(x)     \
 328         (offsetof(struct ffa_mem_region, ep_mem_access[x]))
 329 #define CONSTITUENTS_OFFSET(x)  \
 330         (offsetof(struct ffa_composite_mem_region, constituents[x]))
 331 #define COMPOSITE_CONSTITUENTS_OFFSET(x, y)     \
 332         (COMPOSITE_OFFSET(x) + CONSTITUENTS_OFFSET(y))
 333
 334 struct ffa_mem_ops_args {
 335         bool use_txbuf;
 336         u32 nattrs;
 337         u32 flags;
 338         u64 tag;
 339         u64 g_handle;
 340         struct scatterlist *sg;
 341         struct ffa_mem_region_attributes *attrs;
 342 };
 343
 344 struct ffa_info_ops {
 345         u32 (*api_version_get)(void);
 346         int (*partition_info_get)(const char *uuid_str,
 347                                   struct ffa_partition_info *buffer);
 348 };
 349
 350 struct ffa_msg_ops {
 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 };
 355
 356 struct ffa_mem_ops {
 357         int (*memory_reclaim)(u64 g_handle, u32 flags);
 358         int (*memory_share)(struct ffa_mem_ops_args *args);
 359         int (*memory_lend)(struct ffa_mem_ops_args *args);
 360 };
 361
 362 struct ffa_ops {
 363         const struct ffa_info_ops *info_ops;
 364         const struct ffa_msg_ops *msg_ops;
 365         const struct ffa_mem_ops *mem_ops;
 366 };
 367
 368 #endif /* _LINUX_ARM_FFA_H */