drivers/remoteproc/remoteproc_virtio.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Remote processor messaging transport (OMAP platform-specific bits)
   4  *
   5  * Copyright (C) 2011 Texas Instruments, Inc.
   6  * Copyright (C) 2011 Google, Inc.
   7  *
   8  * Ohad Ben-Cohen <ohad@wizery.com>
   9  * Brian Swetland <swetland@google.com>
  10  */
  11
  12 #include <linux/dma-map-ops.h>
  13 #include <linux/export.h>
  14 #include <linux/of_reserved_mem.h>
  15 #include <linux/remoteproc.h>
  16 #include <linux/virtio.h>
  17 #include <linux/virtio_config.h>
  18 #include <linux/virtio_ids.h>
  19 #include <linux/virtio_ring.h>
  20 #include <linux/err.h>
  21 #include <linux/kref.h>
  22 #include <linux/slab.h>
  23
  24 #include "remoteproc_internal.h"
  25
  26 static struct rproc_vdev *vdev_to_rvdev(struct virtio_device *vdev)
  27 {
  28         return container_of(vdev->dev.parent, struct rproc_vdev, dev);
  29 }
  30
  31 static  struct rproc *vdev_to_rproc(struct virtio_device *vdev)
  32 {
  33         struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
  34
  35         return rvdev->rproc;
  36 }
  37
  38 /* kick the remote processor, and let it know which virtqueue to poke at */
  39 static bool rproc_virtio_notify(struct virtqueue *vq)
  40 {
  41         struct rproc_vring *rvring = vq->priv;
  42         struct rproc *rproc = rvring->rvdev->rproc;
  43         int notifyid = rvring->notifyid;
  44
  45         dev_dbg(&rproc->dev, "kicking vq index: %d\n", notifyid);
  46
  47         rproc->ops->kick(rproc, notifyid);
  48         return true;
  49 }
  50
  51 /**
  52  * rproc_vq_interrupt() - tell remoteproc that a virtqueue is interrupted
  53  * @rproc: handle to the remote processor
  54  * @notifyid: index of the signalled virtqueue (unique per this @rproc)
  55  *
  56  * This function should be called by the platform-specific rproc driver,
  57  * when the remote processor signals that a specific virtqueue has pending
  58  * messages available.
  59  *
  60  * Return: IRQ_NONE if no message was found in the @notifyid virtqueue,
  61  * and otherwise returns IRQ_HANDLED.
  62  */
  63 irqreturn_t rproc_vq_interrupt(struct rproc *rproc, int notifyid)
  64 {
  65         struct rproc_vring *rvring;
  66
  67         dev_dbg(&rproc->dev, "vq index %d is interrupted\n", notifyid);
  68
  69         rvring = idr_find(&rproc->notifyids, notifyid);
  70         if (!rvring || !rvring->vq)
  71                 return IRQ_NONE;
  72
  73         return vring_interrupt(0, rvring->vq);
  74 }
  75 EXPORT_SYMBOL(rproc_vq_interrupt);
  76
  77 static struct virtqueue *rp_find_vq(struct virtio_device *vdev,
  78                                     unsigned int id,
  79                                     void (*callback)(struct virtqueue *vq),
  80                                     const char *name, bool ctx)
  81 {
  82         struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
  83         struct rproc *rproc = vdev_to_rproc(vdev);
  84         struct device *dev = &rproc->dev;
  85         struct rproc_mem_entry *mem;
  86         struct rproc_vring *rvring;
  87         struct fw_rsc_vdev *rsc;
  88         struct virtqueue *vq;
  89         void *addr;
  90         int num, size;
  91
  92         /* we're temporarily limited to two virtqueues per rvdev */
  93         if (id >= ARRAY_SIZE(rvdev->vring))
  94                 return ERR_PTR(-EINVAL);
  95
  96         if (!name)
  97                 return NULL;
  98
  99         /* Search allocated memory region by name */
 100         mem = rproc_find_carveout_by_name(rproc, "vdev%dvring%d", rvdev->index,
 101                                           id);
 102         if (!mem || !mem->va)
 103                 return ERR_PTR(-ENOMEM);
 104
 105         rvring = &rvdev->vring[id];
 106         addr = mem->va;
 107         num = rvring->num;
 108
 109         /* zero vring */
 110         size = vring_size(num, rvring->align);
 111         memset(addr, 0, size);
 112
 113         dev_dbg(dev, "vring%d: va %pK qsz %d notifyid %d\n",
 114                 id, addr, num, rvring->notifyid);
 115
 116         /*
 117          * Create the new vq, and tell virtio we're not interested in
 118          * the 'weak' smp barriers, since we're talking with a real device.
 119          */
 120         vq = vring_new_virtqueue(id, num, rvring->align, vdev, false, ctx,
 121                                  addr, rproc_virtio_notify, callback, name);
 122         if (!vq) {
 123                 dev_err(dev, "vring_new_virtqueue %s failed\n", name);
 124                 rproc_free_vring(rvring);
 125                 return ERR_PTR(-ENOMEM);
 126         }
 127
 128         vq->num_max = num;
 129
 130         rvring->vq = vq;
 131         vq->priv = rvring;
 132
 133         /* Update vring in resource table */
 134         rsc = (void *)rproc->table_ptr + rvdev->rsc_offset;
 135         rsc->vring[id].da = mem->da;
 136
 137         return vq;
 138 }
 139
 140 static void __rproc_virtio_del_vqs(struct virtio_device *vdev)
 141 {
 142         struct virtqueue *vq, *n;
 143         struct rproc_vring *rvring;
 144
 145         list_for_each_entry_safe(vq, n, &vdev->vqs, list) {
 146                 rvring = vq->priv;
 147                 rvring->vq = NULL;
 148                 vring_del_virtqueue(vq);
 149         }
 150 }
 151
 152 static void rproc_virtio_del_vqs(struct virtio_device *vdev)
 153 {
 154         __rproc_virtio_del_vqs(vdev);
 155 }
 156
 157 static int rproc_virtio_find_vqs(struct virtio_device *vdev, unsigned int nvqs,
 158                                  struct virtqueue *vqs[],
 159                                  vq_callback_t *callbacks[],
 160                                  const char * const names[],
 161                                  const bool * ctx,
 162                                  struct irq_affinity *desc)
 163 {
 164         int i, ret, queue_idx = 0;
 165
 166         for (i = 0; i < nvqs; ++i) {
 167                 if (!names[i]) {
 168                         vqs[i] = NULL;
 169                         continue;
 170                 }
 171
 172                 vqs[i] = rp_find_vq(vdev, queue_idx++, callbacks[i], names[i],
 173                                     ctx ? ctx[i] : false);
 174                 if (IS_ERR(vqs[i])) {
 175                         ret = PTR_ERR(vqs[i]);
 176                         goto error;
 177                 }
 178         }
 179
 180         return 0;
 181
 182 error:
 183         __rproc_virtio_del_vqs(vdev);
 184         return ret;
 185 }
 186
 187 static u8 rproc_virtio_get_status(struct virtio_device *vdev)
 188 {
 189         struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
 190         struct fw_rsc_vdev *rsc;
 191
 192         rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
 193
 194         return rsc->status;
 195 }
 196
 197 static void rproc_virtio_set_status(struct virtio_device *vdev, u8 status)
 198 {
 199         struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
 200         struct fw_rsc_vdev *rsc;
 201
 202         rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
 203
 204         rsc->status = status;
 205         dev_dbg(&vdev->dev, "status: %d\n", status);
 206 }
 207
 208 static void rproc_virtio_reset(struct virtio_device *vdev)
 209 {
 210         struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
 211         struct fw_rsc_vdev *rsc;
 212
 213         rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
 214
 215         rsc->status = 0;
 216         dev_dbg(&vdev->dev, "reset !\n");
 217 }
 218
 219 /* provide the vdev features as retrieved from the firmware */
 220 static u64 rproc_virtio_get_features(struct virtio_device *vdev)
 221 {
 222         struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
 223         struct fw_rsc_vdev *rsc;
 224
 225         rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
 226
 227         return rsc->dfeatures;
 228 }
 229
 230 static void rproc_transport_features(struct virtio_device *vdev)
 231 {
 232         /*
 233          * Packed ring isn't enabled on remoteproc for now,
 234          * because remoteproc uses vring_new_virtqueue() which
 235          * creates virtio rings on preallocated memory.
 236          */
 237         __virtio_clear_bit(vdev, VIRTIO_F_RING_PACKED);
 238 }
 239
 240 static int rproc_virtio_finalize_features(struct virtio_device *vdev)
 241 {
 242         struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
 243         struct fw_rsc_vdev *rsc;
 244
 245         rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
 246
 247         /* Give virtio_ring a chance to accept features */
 248         vring_transport_features(vdev);
 249
 250         /* Give virtio_rproc a chance to accept features. */
 251         rproc_transport_features(vdev);
 252
 253         /* Make sure we don't have any features > 32 bits! */
 254         BUG_ON((u32)vdev->features != vdev->features);
 255
 256         /*
 257          * Remember the finalized features of our vdev, and provide it
 258          * to the remote processor once it is powered on.
 259          */
 260         rsc->gfeatures = vdev->features;
 261
 262         return 0;
 263 }
 264
 265 static void rproc_virtio_get(struct virtio_device *vdev, unsigned int offset,
 266                              void *buf, unsigned int len)
 267 {
 268         struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
 269         struct fw_rsc_vdev *rsc;
 270         void *cfg;
 271
 272         rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
 273         cfg = &rsc->vring[rsc->num_of_vrings];
 274
 275         if (offset + len > rsc->config_len || offset + len < len) {
 276                 dev_err(&vdev->dev, "rproc_virtio_get: access out of bounds\n");
 277                 return;
 278         }
 279
 280         memcpy(buf, cfg + offset, len);
 281 }
 282
 283 static void rproc_virtio_set(struct virtio_device *vdev, unsigned int offset,
 284                              const void *buf, unsigned int len)
 285 {
 286         struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
 287         struct fw_rsc_vdev *rsc;
 288         void *cfg;
 289
 290         rsc = (void *)rvdev->rproc->table_ptr + rvdev->rsc_offset;
 291         cfg = &rsc->vring[rsc->num_of_vrings];
 292
 293         if (offset + len > rsc->config_len || offset + len < len) {
 294                 dev_err(&vdev->dev, "rproc_virtio_set: access out of bounds\n");
 295                 return;
 296         }
 297
 298         memcpy(cfg + offset, buf, len);
 299 }
 300
 301 static const struct virtio_config_ops rproc_virtio_config_ops = {
 302         .get_features   = rproc_virtio_get_features,
 303         .finalize_features = rproc_virtio_finalize_features,
 304         .find_vqs       = rproc_virtio_find_vqs,
 305         .del_vqs        = rproc_virtio_del_vqs,
 306         .reset          = rproc_virtio_reset,
 307         .set_status     = rproc_virtio_set_status,
 308         .get_status     = rproc_virtio_get_status,
 309         .get            = rproc_virtio_get,
 310         .set            = rproc_virtio_set,
 311 };
 312
 313 /*
 314  * This function is called whenever vdev is released, and is responsible
 315  * to decrement the remote processor's refcount which was taken when vdev was
 316  * added.
 317  *
 318  * Never call this function directly; it will be called by the driver
 319  * core when needed.
 320  */
 321 static void rproc_virtio_dev_release(struct device *dev)
 322 {
 323         struct virtio_device *vdev = dev_to_virtio(dev);
 324         struct rproc_vdev *rvdev = vdev_to_rvdev(vdev);
 325         struct rproc *rproc = vdev_to_rproc(vdev);
 326
 327         kfree(vdev);
 328
 329         kref_put(&rvdev->refcount, rproc_vdev_release);
 330
 331         put_device(&rproc->dev);
 332 }
 333
 334 /**
 335  * rproc_add_virtio_dev() - register an rproc-induced virtio device
 336  * @rvdev: the remote vdev
 337  * @id: the device type identification (used to match it with a driver).
 338  *
 339  * This function registers a virtio device. This vdev's partent is
 340  * the rproc device.
 341  *
 342  * Return: 0 on success or an appropriate error value otherwise
 343  */
 344 int rproc_add_virtio_dev(struct rproc_vdev *rvdev, int id)
 345 {
 346         struct rproc *rproc = rvdev->rproc;
 347         struct device *dev = &rvdev->dev;
 348         struct virtio_device *vdev;
 349         struct rproc_mem_entry *mem;
 350         int ret;
 351
 352         if (rproc->ops->kick == NULL) {
 353                 ret = -EINVAL;
 354                 dev_err(dev, ".kick method not defined for %s\n", rproc->name);
 355                 goto out;
 356         }
 357
 358         /* Try to find dedicated vdev buffer carveout */
 359         mem = rproc_find_carveout_by_name(rproc, "vdev%dbuffer", rvdev->index);
 360         if (mem) {
 361                 phys_addr_t pa;
 362
 363                 if (mem->of_resm_idx != -1) {
 364                         struct device_node *np = rproc->dev.parent->of_node;
 365
 366                         /* Associate reserved memory to vdev device */
 367                         ret = of_reserved_mem_device_init_by_idx(dev, np,
 368                                                                  mem->of_resm_idx);
 369                         if (ret) {
 370                                 dev_err(dev, "Can't associate reserved memory\n");
 371                                 goto out;
 372                         }
 373                 } else {
 374                         if (mem->va) {
 375                                 dev_warn(dev, "vdev %d buffer already mapped\n",
 376                                          rvdev->index);
 377                                 pa = rproc_va_to_pa(mem->va);
 378                         } else {
 379                                 /* Use dma address as carveout no memmapped yet */
 380                                 pa = (phys_addr_t)mem->dma;
 381                         }
 382
 383                         /* Associate vdev buffer memory pool to vdev subdev */
 384                         ret = dma_declare_coherent_memory(dev, pa,
 385                                                            mem->da,
 386                                                            mem->len);
 387                         if (ret < 0) {
 388                                 dev_err(dev, "Failed to associate buffer\n");
 389                                 goto out;
 390                         }
 391                 }
 392         } else {
 393                 struct device_node *np = rproc->dev.parent->of_node;
 394
 395                 /*
 396                  * If we don't have dedicated buffer, just attempt to re-assign
 397                  * the reserved memory from our parent. A default memory-region
 398                  * at index 0 from the parent's memory-regions is assigned for
 399                  * the rvdev dev to allocate from. Failure is non-critical and
 400                  * the allocations will fall back to global pools, so don't
 401                  * check return value either.
 402                  */
 403                 of_reserved_mem_device_init_by_idx(dev, np, 0);
 404         }
 405
 406         /* Allocate virtio device */
 407         vdev = kzalloc(sizeof(*vdev), GFP_KERNEL);
 408         if (!vdev) {
 409                 ret = -ENOMEM;
 410                 goto out;
 411         }
 412         vdev->id.device = id,
 413         vdev->config = &rproc_virtio_config_ops,
 414         vdev->dev.parent = dev;
 415         vdev->dev.release = rproc_virtio_dev_release;
 416
 417         /*
 418          * We're indirectly making a non-temporary copy of the rproc pointer
 419          * here, because drivers probed with this vdev will indirectly
 420          * access the wrapping rproc.
 421          *
 422          * Therefore we must increment the rproc refcount here, and decrement
 423          * it _only_ when the vdev is released.
 424          */
 425         get_device(&rproc->dev);
 426
 427         /* Reference the vdev and vring allocations */
 428         kref_get(&rvdev->refcount);
 429
 430         ret = register_virtio_device(vdev);
 431         if (ret) {
 432                 put_device(&vdev->dev);
 433                 dev_err(dev, "failed to register vdev: %d\n", ret);
 434                 goto out;
 435         }
 436
 437         dev_info(dev, "registered %s (type %d)\n", dev_name(&vdev->dev), id);
 438
 439 out:
 440         return ret;
 441 }
 442
 443 /**
 444  * rproc_remove_virtio_dev() - remove an rproc-induced virtio device
 445  * @dev: the virtio device
 446  * @data: must be null
 447  *
 448  * This function unregisters an existing virtio device.
 449  *
 450  * Return: 0
 451  */
 452 int rproc_remove_virtio_dev(struct device *dev, void *data)
 453 {
 454         struct virtio_device *vdev = dev_to_virtio(dev);
 455
 456         unregister_virtio_device(vdev);
 457         return 0;
 458 }