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 /* FFA Bus/Device/Driver related */
  15 struct ffa_device {
  16         int vm_id;
  17         bool mode_32bit;
  18         uuid_t uuid;
  19         struct device dev;
  20 };
  21
  22 #define to_ffa_dev(d) container_of(d, struct ffa_device, dev)
  23
  24 struct ffa_device_id {
  25         uuid_t uuid;
  26 };
  27
  28 struct ffa_driver {
  29         const char *name;
  30         int (*probe)(struct ffa_device *sdev);
  31         void (*remove)(struct ffa_device *sdev);
  32         const struct ffa_device_id *id_table;
  33
  34         struct device_driver driver;
  35 };
  36
  37 #define to_ffa_driver(d) container_of(d, struct ffa_driver, driver)
  38
  39 static inline void ffa_dev_set_drvdata(struct ffa_device *fdev, void *data)
  40 {
  41         fdev->dev.driver_data = data;
  42 }
  43
  44 #if IS_REACHABLE(CONFIG_ARM_FFA_TRANSPORT)
  45 struct ffa_device *ffa_device_register(const uuid_t *uuid, int vm_id);
  46 void ffa_device_unregister(struct ffa_device *ffa_dev);
  47 int ffa_driver_register(struct ffa_driver *driver, struct module *owner,
  48                         const char *mod_name);
  49 void ffa_driver_unregister(struct ffa_driver *driver);
  50 bool ffa_device_is_valid(struct ffa_device *ffa_dev);
  51 const struct ffa_dev_ops *ffa_dev_ops_get(struct ffa_device *dev);
  52
  53 #else
  54 static inline
  55 struct ffa_device *ffa_device_register(const uuid_t *uuid, int vm_id)
  56 {
  57         return NULL;
  58 }
  59
  60 static inline void ffa_device_unregister(struct ffa_device *dev) {}
  61
  62 static inline int
  63 ffa_driver_register(struct ffa_driver *driver, struct module *owner,
  64                     const char *mod_name)
  65 {
  66         return -EINVAL;
  67 }
  68
  69 static inline void ffa_driver_unregister(struct ffa_driver *driver) {}
  70
  71 static inline
  72 bool ffa_device_is_valid(struct ffa_device *ffa_dev) { return false; }
  73
  74 static inline
  75 const struct ffa_dev_ops *ffa_dev_ops_get(struct ffa_device *dev)
  76 {
  77         return NULL;
  78 }
  79 #endif /* CONFIG_ARM_FFA_TRANSPORT */
  80
  81 #define ffa_register(driver) \
  82         ffa_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
  83 #define ffa_unregister(driver) \
  84         ffa_driver_unregister(driver)
  85
  86 /**
  87  * module_ffa_driver() - Helper macro for registering a psa_ffa driver
  88  * @__ffa_driver: ffa_driver structure
  89  *
  90  * Helper macro for psa_ffa drivers to set up proper module init / exit
  91  * functions.  Replaces module_init() and module_exit() and keeps people from
  92  * printing pointless things to the kernel log when their driver is loaded.
  93  */
  94 #define module_ffa_driver(__ffa_driver) \
  95         module_driver(__ffa_driver, ffa_register, ffa_unregister)
  96
  97 /* FFA transport related */
  98 struct ffa_partition_info {
  99         u16 id;
 100         u16 exec_ctxt;
 101 /* partition supports receipt of direct requests */
 102 #define FFA_PARTITION_DIRECT_RECV       BIT(0)
 103 /* partition can send direct requests. */
 104 #define FFA_PARTITION_DIRECT_SEND       BIT(1)
 105 /* partition can send and receive indirect messages. */
 106 #define FFA_PARTITION_INDIRECT_MSG      BIT(2)
 107         u32 properties;
 108 };
 109
 110 /* For use with FFA_MSG_SEND_DIRECT_{REQ,RESP} which pass data via registers */
 111 struct ffa_send_direct_data {
 112         unsigned long data0; /* w3/x3 */
 113         unsigned long data1; /* w4/x4 */
 114         unsigned long data2; /* w5/x5 */
 115         unsigned long data3; /* w6/x6 */
 116         unsigned long data4; /* w7/x7 */
 117 };
 118
 119 struct ffa_mem_region_addr_range {
 120         /* The base IPA of the constituent memory region, aligned to 4 kiB */
 121         u64 address;
 122         /* The number of 4 kiB pages in the constituent memory region. */
 123         u32 pg_cnt;
 124         u32 reserved;
 125 };
 126
 127 struct ffa_composite_mem_region {
 128         /*
 129          * The total number of 4 kiB pages included in this memory region. This
 130          * must be equal to the sum of page counts specified in each
 131          * `struct ffa_mem_region_addr_range`.
 132          */
 133         u32 total_pg_cnt;
 134         /* The number of constituents included in this memory region range */
 135         u32 addr_range_cnt;
 136         u64 reserved;
 137         /** An array of `addr_range_cnt` memory region constituents. */
 138         struct ffa_mem_region_addr_range constituents[];
 139 };
 140
 141 struct ffa_mem_region_attributes {
 142         /* The ID of the VM to which the memory is being given or shared. */
 143         u16 receiver;
 144         /*
 145          * The permissions with which the memory region should be mapped in the
 146          * receiver's page table.
 147          */
 148 #define FFA_MEM_EXEC            BIT(3)
 149 #define FFA_MEM_NO_EXEC         BIT(2)
 150 #define FFA_MEM_RW              BIT(1)
 151 #define FFA_MEM_RO              BIT(0)
 152         u8 attrs;
 153         /*
 154          * Flags used during FFA_MEM_RETRIEVE_REQ and FFA_MEM_RETRIEVE_RESP
 155          * for memory regions with multiple borrowers.
 156          */
 157 #define FFA_MEM_RETRIEVE_SELF_BORROWER  BIT(0)
 158         u8 flag;
 159         u32 composite_off;
 160         /*
 161          * Offset in bytes from the start of the outer `ffa_memory_region` to
 162          * an `struct ffa_mem_region_addr_range`.
 163          */
 164         u64 reserved;
 165 };
 166
 167 struct ffa_mem_region {
 168         /* The ID of the VM/owner which originally sent the memory region */
 169         u16 sender_id;
 170 #define FFA_MEM_NORMAL          BIT(5)
 171 #define FFA_MEM_DEVICE          BIT(4)
 172
 173 #define FFA_MEM_WRITE_BACK      (3 << 2)
 174 #define FFA_MEM_NON_CACHEABLE   (1 << 2)
 175
 176 #define FFA_DEV_nGnRnE          (0 << 2)
 177 #define FFA_DEV_nGnRE           (1 << 2)
 178 #define FFA_DEV_nGRE            (2 << 2)
 179 #define FFA_DEV_GRE             (3 << 2)
 180
 181 #define FFA_MEM_NON_SHAREABLE   (0)
 182 #define FFA_MEM_OUTER_SHAREABLE (2)
 183 #define FFA_MEM_INNER_SHAREABLE (3)
 184         u8 attributes;
 185         u8 reserved_0;
 186 /*
 187  * Clear memory region contents after unmapping it from the sender and
 188  * before mapping it for any receiver.
 189  */
 190 #define FFA_MEM_CLEAR                   BIT(0)
 191 /*
 192  * Whether the hypervisor may time slice the memory sharing or retrieval
 193  * operation.
 194  */
 195 #define FFA_TIME_SLICE_ENABLE           BIT(1)
 196
 197 #define FFA_MEM_RETRIEVE_TYPE_IN_RESP   (0 << 3)
 198 #define FFA_MEM_RETRIEVE_TYPE_SHARE     (1 << 3)
 199 #define FFA_MEM_RETRIEVE_TYPE_LEND      (2 << 3)
 200 #define FFA_MEM_RETRIEVE_TYPE_DONATE    (3 << 3)
 201
 202 #define FFA_MEM_RETRIEVE_ADDR_ALIGN_HINT        BIT(9)
 203 #define FFA_MEM_RETRIEVE_ADDR_ALIGN(x)          ((x) << 5)
 204         /* Flags to control behaviour of the transaction. */
 205         u32 flags;
 206 #define HANDLE_LOW_MASK         GENMASK_ULL(31, 0)
 207 #define HANDLE_HIGH_MASK        GENMASK_ULL(63, 32)
 208 #define HANDLE_LOW(x)           ((u32)(FIELD_GET(HANDLE_LOW_MASK, (x))))
 209 #define HANDLE_HIGH(x)          ((u32)(FIELD_GET(HANDLE_HIGH_MASK, (x))))
 210
 211 #define PACK_HANDLE(l, h)               \
 212         (FIELD_PREP(HANDLE_LOW_MASK, (l)) | FIELD_PREP(HANDLE_HIGH_MASK, (h)))
 213         /*
 214          * A globally-unique ID assigned by the hypervisor for a region
 215          * of memory being sent between VMs.
 216          */
 217         u64 handle;
 218         /*
 219          * An implementation defined value associated with the receiver and the
 220          * memory region.
 221          */
 222         u64 tag;
 223         u32 reserved_1;
 224         /*
 225          * The number of `ffa_mem_region_attributes` entries included in this
 226          * transaction.
 227          */
 228         u32 ep_count;
 229         /*
 230          * An array of endpoint memory access descriptors.
 231          * Each one specifies a memory region offset, an endpoint and the
 232          * attributes with which this memory region should be mapped in that
 233          * endpoint's page table.
 234          */
 235         struct ffa_mem_region_attributes ep_mem_access[];
 236 };
 237
 238 #define COMPOSITE_OFFSET(x)     \
 239         (offsetof(struct ffa_mem_region, ep_mem_access[x]))
 240 #define CONSTITUENTS_OFFSET(x)  \
 241         (offsetof(struct ffa_composite_mem_region, constituents[x]))
 242 #define COMPOSITE_CONSTITUENTS_OFFSET(x, y)     \
 243         (COMPOSITE_OFFSET(x) + CONSTITUENTS_OFFSET(y))
 244
 245 struct ffa_mem_ops_args {
 246         bool use_txbuf;
 247         u32 nattrs;
 248         u32 flags;
 249         u64 tag;
 250         u64 g_handle;
 251         struct scatterlist *sg;
 252         struct ffa_mem_region_attributes *attrs;
 253 };
 254
 255 struct ffa_dev_ops {
 256         u32 (*api_version_get)(void);
 257         int (*partition_info_get)(const char *uuid_str,
 258                                   struct ffa_partition_info *buffer);
 259         void (*mode_32bit_set)(struct ffa_device *dev);
 260         int (*sync_send_receive)(struct ffa_device *dev,
 261                                  struct ffa_send_direct_data *data);
 262         int (*memory_reclaim)(u64 g_handle, u32 flags);
 263         int (*memory_share)(struct ffa_device *dev,
 264                             struct ffa_mem_ops_args *args);
 265 };
 266
 267 #endif /* _LINUX_ARM_FFA_H */