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