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